Each API can be used independent of other API's. However, proxy methods can be used

to access related API's such as `Emails` for a `User`. The `User` API provides the following

proxies.

// Access email API

$user->emails();

// Access keys API

$user->keys();

// Access repos API

$user->repos();

// Access gists API

$user->gists();

Perform operations on authenticated users emails.

GitHub API Documentation - [User Email API](http://developer.github.com/v3/users/emails/).

The email API can be used independently of the other API's as follows:

$email = new Email();

$response = $email->all();

However, as emails are related to the user you can also access the email API via the

user as follows:

$user = new User();

$response = $user->emails()->all();

There are a number of benefits to this approach including increased readability, and

authentication being carried across from each independent API, i.e. you don't

have to authenticated the user and the email API.

List all email addresses for authenticated user.

$response = $user->emails()->all();

Adds single or multiple address(es) for the authenticated user. On success returns

list of all email address for user. On failure returns `FALSE`. This operation

can fail if email addresses already exist for the user.

// Add single

$response = $user->emails()->create('dsyph3r@gmail.com');

// Add multiple

$response = $user->emails()->create(array('dsyph3r@gmail.com', 'octocat@github.com'));

Deletes single or multiple address(es) for the authenticated user. On success returns

`TRUE`.

// Delete single

$response = $user->emails()->delete('dsyph3r@gmail.com');

// Delete multiple

$response = $user->emails()->delete(array('dsyph3r@gmail.com', 'octocat@github.com'));

Perform operations on authenticated users keys.

GitHub API Documentation - [User Keys API](http://developer.github.com/v3/users/keys/).

The keys API can be used independently of the other API's as follows:

$key = new Keys();

$response = $key->all();

However, as keys are related to the user you can also access the keys API via the

user as follows:

$user = new User();

$response = $user->keys()->all();

List all keys for authenticated user.

$response = $user->keys()->all();

Get a key for authenticated user by key ID.

$response = $user->keys()->get(1);

Adds a key for authenticated user. On success returns the created key.

On failure returns `FALSE`. This operation can fail if the key is invalid.

$response = $user->keys()->create('desktop@dsyph3r', 'ssh-rsa ABCDEF');

Update a key for authenticated user by key ID. On success returns the updated key.

On failure returns `FALSE`. This operation can fail if the key is invalid.

$response = $user->keys()->update(1, 'desktop@dsyph3r', 'ssh-rsa FEDCBA');

Delete a key for authenticated user by ID. On success returns `TRUE`.

$response = $user->keys()->delete(1);

Perform operations on gists.

GitHub API Documentation - [Gists API](http://developer.github.com/v3/gists/).

The gists API can be used independently of the other API's as follows:

$gist = new Gist();

$response = $gist->all();

List all public gists. No authentication required.

$response = $gist->all();

List all public gists for a user

$response = $gist->all('dsph3r');

List all public gists for authenticated user.

$gist->login();

$response = $gist->all();

List all starred gists for authenticated user.

$gist->login();

$response = $gist->all(null, Api::GIST_TYPE_STARRED);

All above operations return paginated results. Accessing paginated results is as follows.

$response = $gist->all('dsyph3r', Api::GIST_TYPE_PUBLIC, 2, 50); // Get page 2, 50 results per page

Get a gist. Authentication maybe required depending on the gist permissions, ie. Private gist

$response = $gist->get(1);

Creates a gist for authenticated user. On success returns the created gist.

On failure returns `FALSE`.

Gists contain files and should be passed in as an array.

$files = array(

'file1.txt' => array(

'content' => 'File 1 contents',

),

'file2.txt' => array(

'content' => 'File 2 contents',

),

);

$response = $gist->create($files, true, "Gist description");

Updates a gist for authenticated user. On success returns the updated gist.

On failure returns `FALSE`.

Gists contain files and should be passed in as an array. Setting a filename

key value to null will removed the file from the gist. Leaving filename keys

out will cause no update to the gist file.

$files = array(

'file1.txt' => array(

// Update the contents of this file

'content' => 'File 1 contents update',

),

// This file will be removed from gist

'file2.txt' => null,

);

$response = $gist->update(1, $files, "Gist description update");

Star a gist for the authenticated user. Returns `TRUE` if gist was starred.

$response = $gist->star(1);

Unstar a gist for the authenticated user. Returns `TRUE` if gist was unstarred.

$response = $gist->unstar(1);

Check if gist is starred for the authenticated user. Returns `TRUE` if gist is starred.

$response = $gist->isStarred(1);

Fork a gist for the authenticated user. Returns `TRUE` if gist was forked.

$response = $gist->fork(1);

Delete a gist for the authenticated user. Returns `TRUE` if gist was deleted.

$response = $gist->delete(1);

Each API can be used independent of other API's. However, proxy methods can be used

to access related API's such as `Comments` for a `Gist`. The `Gist` API provides the following

proxies.

// Access gist comments API

$gist->comments();

Perform operations on gist comments.

GitHub API Documentation - [Gists Comments API](http://developer.github.com/v3/gists/comments/).

The gists comments API can be used independently of the other API's as follows:

$comment = new GistComment();

$response = $comment->all();

However, as comments are related to the gists you can also access the comments API via the

gist as follows:

$gist = new Gist();

$response = $gist->comments()->all();

Gist comments use [custom mime types](http://developer.github.com/v3/gists/comments/#custom-mime-types)

to return formatted results. Custom mime types can be passed in as an argument to most functions.

Available formats are:

Api::FORMAT_RAW; // Default

Api::FORMAT_TEXT;

Api::FORMAT_HTML;

Api::FORMAT_FULL;

List all comments for gist. Authentication maybe required depending on the gist permissions, ie. Private gist

$response = $gist->comments()->all(1);

Get the results in `HTML` format

$response = $gist->comments()->all(1, Api::FORMAT_HTML);

Get a gist comment. Authentication maybe required depending on the gist permissions, ie. Private gist

$response = $gist->comments()->get(1);

Creates a gist comment for authenticated user. On success returns the created comment.

On failure returns `FALSE`.

$response = $gist->comments()->create(1, "Comment Body");

Updates a gist comment for authenticated user. On success returns the updated comment.

On failure returns `FALSE`.

$response = $gist->comments()->update(1, "Comment body update");

Delete a gist comment for the authenticated user. Returns `TRUE` if gist comment was deleted.

$response = $gist->comments()->delete(1);