jaybizzle/deploybot-api

A simple PHP wrapper for the DeployBot API

v2.1.0 2019-07-06 08:01 UTC

This package is auto-updated.

Last update: 2020-08-09 10:11:29 UTC


README

Build Status StyleCI Total Downloads

Installation

Add "jaybizzle/deploybot-api": "2.*" to your composer.json.

Older Versions

If you need to use this with older versions of PHP or Guzzle, then see the 1.0 branch

Usage

You can read the official DeployBot API documention here - http://deploybot.com/api/

All the DeployBot API endpoints can be called by prefixing the name with get e.g

use Jaybizzle\DeployBot;

$db = new DeployBot('YOUR_API_KEY', 'YOUR_ACCOUNT_NAME');

// get all users
$users = $db->getUsers();

// get a specific user
$user = $db->getUsers(324);

Some DeployBot API endpoints can accept query string parameters, such as limit to limit the number of results returned. Taking the above users example, we can simply do this...

$users = $db->limit(10)->getUsers();

These can also be chained...

$users = $db->limit(10)->after(324)->getUsers();

Some more examples...

//  list deployments for environment and limit results
$deployments = $db->environmentId(3452)->limit(10)->getDeployments();

// list repositories and limit results
$repositories = $db->limit(20)->getRepositories();

NOTE: Query parameters are listed in the DeployBot API docs as snake_case but we access them using camelCase methods so all method calls have a consistent naming convention