• • authorization#create(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• scopes (Array): Optional. Optional array - A list of scopes that this authorization is in.
• note (String): Optional. Optional string - A note to remind you what the OAuth token is for.
• note_url (String): Optional. Optional string - A URL to remind you what app the OAuth token is for.

• • authorization#delete(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• id (String): Required.

• • authorization#get(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• id (String): Required.

• • authorization#getAll(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • authorization#update(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• id (String): Required.
• scopes (Array): Optional. Optional array - A list of scopes that this authorization is in.
• add_scopes (Array): Optional. Optional array - A list of scopes to add to this authorization.
• remove_scopes (Array): Optional. Optional array - A list of scopes to remove from this authorization.
• note (String): Optional. Optional string - A note to remind you what the OAuth token is for.
• note_url (String): Optional. Optional string - A URL to remind you what app the OAuth token is for.

• • Client#authenticate(options)
  • • null

• • options
  • • Object

  • Object containing the authentication type and credentials

• • type
  • • String

  • One of the following: basic or oauth

• • username
  • • String

  • Github username

• • password
  • • String

  • Password to your account

• • token
  • • String

  • OAuth2 token

Set an authentication method to have access to protected resources.

Example

// basic
github.authenticate({
    type: "basic",
    username: "mikedeboertest",
    password: "test1324"
});

// or oauth
github.authenticate({
    type: "oauth",
    token: "e5a4a27487c26e571892846366de023349321a73"
});

• • Client#getFirstPage(link, callback)
  • • null

• • link
  • • mixed

  • response of a request or the contents of the Link header

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Get the first page, based on the contents of the Link header

• • Client#getLastPage(link, callback)
  • • null

• • link
  • • mixed

  • response of a request or the contents of the Link header

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Get the last page, based on the contents of the Link header

• • Client#getNextPage(link, callback)
  • • null

• • link
  • • mixed

  • response of a request or the contents of the Link header

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Get the next page, based on the contents of the Link header

• • Client#getPreviousPage(link, callback)
  • • null

• • link
  • • mixed

  • response of a request or the contents of the Link header

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Get the previous page, based on the contents of the Link header

• • Client#hasFirstPage(link)
  • • null

• • link
  • • mixed

  • response of a request or the contents of the Link header

Check if a request result contains a link to the first page

• • Client#hasLastPage(link)
  • • null

• • link
  • • mixed

  • response of a request or the contents of the Link header

Check if a request result contains a link to the last page

• • Client#hasNextPage(link)
  • • null

• • link
  • • mixed

  • response of a request or the contents of the Link header

Check if a request result contains a link to the next page

• • Client#hasPreviousPage(link)
  • • null

• • link
  • • mixed

  • response of a request or the contents of the Link header

Check if a request result contains a link to the previous page

• • Client#httpSend(msg, block, callback)
  • • null

• • msg
  • • Object

  • parameters to send as the request body

• • block
  • • Object

  • parameter definition from the routes.json file that contains validation rules

• • callback
  • • Function

  • function to be called when the request returns. If the the request returns with an error, the error is passed to the callback as its first argument (NodeJS-style).

Send an HTTP request to the server and pass the result to a callback.

• • Client#setupRoutes()
  • • null

Configures the routes as defined in a routes.json file of an API version

Client#setupRoutes is invoked by the constructor, takes the contents of the JSON document that contains the definitions of all the available API routes and iterates over them.

It first recurses through each definition block until it reaches an API endpoint. It knows that an endpoint is found when the url and param definitions are found as a direct member of a definition block. Then the availability of an implementation by the API is checked; if it's not present, this means that a portion of the API as defined in the routes.json file is not implemented properly, thus an exception is thrown. After this check, a method is attached to the Client instance and becomes available for use. Inside this method, the parameter validation and typecasting is done, according to the definition of the parameters in the params block, upon invocation.

This mechanism ensures that the handlers ALWAYS receive normalized data that is of the correct format and type. JSON parameters are parsed, Strings are trimmed, Numbers and Floats are casted and checked for NaN after that.

Note: Query escaping for usage with SQL products is something that can be implemented additionally by adding an additional parameter type.

• • events#get(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • events#getFromOrg(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• org (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • events#getFromRepo(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • events#getFromRepoIssues(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • events#getFromRepoNetwork(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • events#getFromUser(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • events#getFromUserOrg(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• org (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • events#getFromUserPublic(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • events#getReceived(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • events#getReceivedPublic(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • gists#checkStar(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• id (String): Required.

• • gists#create(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• description (String): Optional.
• public (Boolean): Required.
• files (Json): Required. Files that make up this gist. The key of which should be a required string filename and the value another required hash with parameters: 'content'

• • gists#delete(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• id (String): Required.

• • gists#deleteStar(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• id (String): Required.

• • gists#edit(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• id (String): Required.
• description (String): Optional.
• files (Json): Required. Files that make up this gist. The key of which should be a required string filename and the value another required hash with parameters: 'content'

• • gists#fork(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• id (String): Required.

• • gists#get(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• id (String): Required.

• • gists#getAll(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
• since (Date): Optional. Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ

• • gists#getFromUser(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
• since (Date): Optional. Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ

• • gists#public(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• since (Date): Optional. Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ

• • gists#star(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• id (String): Required.

• • gists#starred(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• since (Date): Optional. Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ

• • gitdata#createBlob(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• content (String): Required.
• encoding (String): Required.

• • gitdata#createCommit(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• message (String): Required. String of the commit message
• tree (String): Required. String of the SHA of the tree object this commit points to
• parents (Array): Required. Array of the SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided, for a merge commit, an array of more than one should be provided.
• author (Json): Optional.
• committer (Json): Optional.

• • gitdata#createReference(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• ref (String): Required. String of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected.
• sha (String): Required.

• • gitdata#createTag(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• tag (String): Required. String of the tag
• message (String): Required. String of the tag message
• object (String): Required. String of the SHA of the git object this is tagging
• type (String): Required. String of the type of the object we’re tagging. Normally this is a commit but it can also be a tree or a blob.
• tagger (Json): Required. JSON object that contains the following keys: name - String of the name of the author of the tag, email - String of the email of the author of the tag, date - Timestamp of when this object was tagged

• • gitdata#createTree(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• tree (Json): Required. Array of Hash objects (of path, mode, type and sha) specifying a tree structure
• base_tree (String): Optional. String of the SHA1 of the tree you want to update with new data

• • gitdata#deleteReference(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• ref (String): Required. String of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected.

• • gitdata#getAllReferences(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • gitdata#getBlob(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• sha (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • gitdata#getCommit(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• sha (String): Required.

• • gitdata#getReference(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• ref (String): Required. String of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected.

• • gitdata#getTag(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• sha (String): Required.

• • gitdata#getTree(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• sha (String): Required.
• recursive (Boolean): Optional.

• • gitdata#updateReference(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• ref (String): Required. String of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected.
• sha (String): Required.
• force (Boolean): Required. Boolean indicating whether to force the update or to make sure the update is a fast-forward update. The default is false, so leaving this out or setting it to false will make sure you’re not overwriting work.

• • HttpError#toJSON()
  • • Object

Returns a JSON object representation of the error.

• • HttpError#toString()
  • • String

Returns the stringified version of the error (i.e. the message).

• • issues#create(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• title (String): Required.
• body (String): Optional.
• assignee (String): Optional. Optional string - Login for the user that this issue should be assigned to.
• milestone (Number): Optional. Optional number - Milestone to associate this issue with. Validation rule: ^[0-9]+$.
• labels (Json): Required. Optional array of strings - Labels to associate with this issue.

• • issues#createComment(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• number (Number): Required. Validation rule: ^[0-9]+$.
• body (String): Required.

• • issues#createLabel(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• name (String): Required.
• color (String): Required. Required string - 6 character hex code, without a leading #.

• • issues#createMilestone(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• title (String): Required.
• state (String): Optional. Validation rule: ^(open|closed)$.
• description (String): Optional.
• due_on (Date): Optional. Optional string - ISO 8601 time.

• • issues#deleteComment(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• id (String): Required.

• • issues#deleteLabel(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• name (String): Required.

• • issues#deleteMilestone(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• number (Number): Required. Validation rule: ^[0-9]+$.

• • issues#edit(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• number (Number): Required. Validation rule: ^[0-9]+$.
• title (String): Optional.
• body (String): Optional.
• assignee (String): Optional. Optional string - Login for the user that this issue should be assigned to.
• milestone (Number): Optional. Optional number - Milestone to associate this issue with. Validation rule: ^[0-9]+$.
• labels (Json): Optional. Optional array of strings - Labels to associate with this issue.
• state (String): Optional. open or closed Validation rule: ^(open|closed)$.

• • issues#editComment(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• id (String): Required.
• body (String): Required.

• • issues#getAll(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• filter (String): Optional. Validation rule: ^(all|assigned|created|mentioned|subscribed)$.
• state (String): Optional. Validation rule: ^(open|closed)$.
• labels (String): Optional. String list of comma separated Label names. Example: bug,ui,@high
• sort (String): Optional. Validation rule: ^(created|updated|comments)$.
• direction (String): Optional. Validation rule: ^(asc|desc)$.
• since (Date): Optional. Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • issues#getAllMilestones(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• state (String): Optional. Validation rule: ^(open|closed)$.
• sort (String): Optional. due_date, completeness, default: due_date Validation rule: ^(due_date|completeness)$.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • issues#getComment(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• id (String): Required.

• • issues#getComments(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• number (Number): Required. Validation rule: ^[0-9]+$.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • issues#getEvent(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• id (String): Required.

• • issues#getEvents(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• number (Number): Required. Validation rule: ^[0-9]+$.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • issues#getLabel(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• name (String): Required.

• • issues#getLabels(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.

• • issues#getMilestone(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• number (Number): Required. Validation rule: ^[0-9]+$.

• • issues#getRepoEvents(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • issues#getRepoIssue(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• number (Number): Required. Validation rule: ^[0-9]+$.

• • issues#repoComments(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• sort (String): Optional. Validation rule: ^(created|updated)$.
• direction (String): Optional. Validation rule: ^(asc|desc)$.
• since (Date): Optional. Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • issues#repoIssues(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• milestone (String): Optional. Validation rule: ^([0-9]+|none|\*)$.
• state (String): Optional. open or closed Validation rule: ^(open|closed)$.
• assignee (String): Optional. String User login, none for Issues with no assigned User. * for Issues with any assigned User.
• mentioned (String): Optional. String User login.
• labels (String): Optional. String list of comma separated Label names. Example: bug,ui,@high
• sort (String): Optional. Validation rule: ^(created|updated|comments)$.
• direction (String): Optional. Validation rule: ^(asc|desc)$.
• since (Date): Optional. Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • issues#updateLabel(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• name (String): Required.
• color (String): Required. Required string - 6 character hex code, without a leading #.

• • issues#updateMilestone(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• number (Number): Required. Validation rule: ^[0-9]+$.
• title (String): Required.
• state (String): Optional. Validation rule: ^(open|closed)$.
• description (String): Optional.
• due_on (Date): Optional. Optional string - ISO 8601 time.

• • markdown#render(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• text (String): Required. The Markdown text to render
• mode (String): Optional. The rendering mode, markdown to render a document as plain Markdown, just like README files are rendered. gfm to render a document as user-content, e.g. like user comments or issues are rendered. In GFM mode, hard line breaks are always taken into account, and issue and user mentions are linked accordingly. Validation rule: ^(markdown|gfm)$.
• context (String): Optional. The repository context, only taken into account when rendering as gfm

• • orgs#addTeamMember(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• id (String): Required.
• user (String): Required.

• • orgs#addTeamRepo(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• id (String): Required.
• user (String): Required.
• repo (String): Required.

• • orgs#concealMembership(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• org (String): Required.
• user (String): Required.

• • orgs#createTeam(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• org (String): Required.
• name (String): Required.
• repo_names (Array): Optional. Optional array of strings
• permission (String): Optional. pull - team members can pull, but not push or administer this repositories (Default), push - team members can pull and push, but not administer this repositores, admin - team members can pull, push and administer these repositories. Validation rule: ^(pull|push|admin)$.

• • orgs#deleteTeam(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• id (String): Required.

• • orgs#deleteTeamMember(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• id (String): Required.
• user (String): Required.

• • orgs#deleteTeamRepo(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• id (String): Required.
• user (String): Required.
• repo (String): Required.

• • orgs#get(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• org (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • orgs#getFromUser(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • orgs#getMember(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• org (String): Required.
• user (String): Required.

• • orgs#getMembers(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• org (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • orgs#getPublicMember(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• org (String): Required.
• user (String): Required.

• • orgs#getPublicMembers(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• org (String): Required.

• • orgs#getTeam(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• id (String): Required.

• • orgs#getTeamMember(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• id (String): Required.
• user (String): Required.

• • orgs#getTeamMembers(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• id (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • orgs#getTeamRepo(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• id (String): Required.
• user (String): Required.
• repo (String): Required.

• • orgs#getTeamRepos(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• id (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • orgs#getTeams(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• org (String): Required.

• • orgs#publicizeMembership(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• org (String): Required.
• user (String): Required.

• • orgs#removeMember(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• org (String): Required.
• user (String): Required.

• • orgs#update(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• org (String): Required.
• billing_email (String): Optional. Optional string - Billing email address. This address is not publicized.
• company (String): Optional.
• email (String): Optional. Optional string - Publicly visible email address.
• location (String): Optional.
• name (String): Optional.

• • orgs#updateTeam(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• id (String): Required.
• name (String): Required.
• permission (String): Optional. pull - team members can pull, but not push or administer this repositories (Default), push - team members can pull and push, but not administer this repositores, admin - team members can pull, push and administer these repositories. Validation rule: ^(pull|push|admin)$.

• • pullRequests#create(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• title (String): Required.
• body (String): Optional.
• base (String): Required. Required string - The branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo.
• head (String): Required. Required string - The branch (or git ref) where your changes are implemented.

• • pullRequests#createComment(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• number (Number): Required. Validation rule: ^[0-9]+$.
• body (String): Required.
• commit_id (String): Required. Required string - Sha of the commit to comment on.
• path (String): Required. Required string - Relative path of the file to comment on.
• position (Number): Required. Required number - Column index in the diff to comment on.

• • pullRequests#createCommentReply(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• number (Number): Required. Validation rule: ^[0-9]+$.
• body (String): Required.
• in_reply_to (Number): Required.

• • pullRequests#createFromIssue(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• issue (Number): Required. Validation rule: ^[0-9]+$.
• base (String): Required. Required string - The branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo.
• head (String): Required. Required string - The branch (or git ref) where your changes are implemented.

• • pullRequests#deleteComment(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• number (Number): Required. Validation rule: ^[0-9]+$.

• • pullRequests#get(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• number (Number): Required. Validation rule: ^[0-9]+$.

• • pullRequests#getAll(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• state (String): Optional. Validation rule: ^(open|closed)$.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • pullRequests#getComment(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• number (Number): Required. Validation rule: ^[0-9]+$.

• • pullRequests#getComments(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• number (Number): Required. Validation rule: ^[0-9]+$.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • pullRequests#getCommits(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• number (Number): Required. Validation rule: ^[0-9]+$.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • pullRequests#getFiles(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• number (Number): Required. Validation rule: ^[0-9]+$.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • pullRequests#getMerged(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• number (Number): Required. Validation rule: ^[0-9]+$.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • pullRequests#merge(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• number (Number): Required. Validation rule: ^[0-9]+$.
• commit_message (String): Optional. Optional string - The message that will be used for the merge commit

• • pullRequests#update(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• number (Number): Required. Validation rule: ^[0-9]+$.
• state (String): Optional. Validation rule: ^(open|closed)$.
• title (String): Required.
• body (String): Optional.

• • pullRequests#updateComment(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• number (Number): Required. Validation rule: ^[0-9]+$.
• body (String): Required.

• • repos#addCollaborator(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• collabuser (String): Required.

• • repos#compareCommits(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• base (String): Required. Required string - The branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo.
• head (String): Required. Required string - The branch (or git ref) where your changes are implemented.

• • repos#create(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• name (String): Required.
• description (String): Optional.
• homepage (String): Optional.
• private (Boolean): Optional. Optional boolean - true to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account. Default is false.
• has_issues (Boolean): Optional. Optional boolean - true to enable issues for this repository, false to disable them. Default is true.
• has_wiki (Boolean): Optional. Optional boolean - true to enable the wiki for this repository, false to disable it. Default is true.
• has_downloads (Boolean): Optional. Optional boolean - true to enable downloads for this repository, false to disable them. Default is true.
• auto_init (Boolean): Optional. Optional boolean - true to create an initial commit with empty README. Default is false
• gitignore_template (String): Optional. Optional string - Desired language or platform .gitignore template to apply. Ignored if auto_init parameter is not provided.

• • repos#createCommitComment(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• sha (String): Required.
• body (String): Required.
• commit_id (String): Required. Required string - Sha of the commit to comment on.
• path (String): Optional. Optional string - Relative path of the file to comment on.
• position (Number): Optional. Optional number - Line index in the diff to comment on.
• line (Number): Optional. Optional number - Line number in the file to comment on. Defaults to 1.

• • repos#createFromOrg(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• org (String): Required.
• name (String): Required.
• description (String): Optional.
• homepage (String): Optional.
• private (Boolean): Optional. Optional boolean - true to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account. Default is false.
• has_issues (Boolean): Optional. Optional boolean - true to enable issues for this repository, false to disable them. Default is true.
• has_wiki (Boolean): Optional. Optional boolean - true to enable the wiki for this repository, false to disable it. Default is true.
• has_downloads (Boolean): Optional. Optional boolean - true to enable downloads for this repository, false to disable them. Default is true.
• auto_init (Boolean): Optional. Optional boolean - true to create an initial commit with empty README. Default is false
• gitignore_template (String): Optional. Optional string - Desired language or platform .gitignore template to apply. Ignored if auto_init parameter is not provided.
• team_id (Number): Optional. Optional number - The id of the team that will be granted access to this repository. This is only valid when creating a repo in an organization. Validation rule: ^[0-9]+$.

• • repos#createHook(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• name (String): Required.
• config (Json): Required. Required hash - A Hash containing key/value pairs to provide settings for this hook. These settings vary between the services and are defined in the github-services repo. Booleans are stored internally as 1 for true, and 0 for false. Any JSON true/false values will be converted automatically.
• events (Array): Optional. Optional array - Determines what events the hook is triggered for. Default: ['push'].
• active (Boolean): Optional. Optional boolean - Determines whether the hook is actually triggered on pushes.

• • repos#createKey(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• title (String): Required.
• key (String): Required.

• • repos#delete(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.

• • repos#deleteCommitComment(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• id (String): Required.

• • repos#deleteDownload(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• id (String): Required.

• • repos#deleteHook(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• id (String): Required.

• • repos#deleteKey(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• id (String): Required.

• • repos#fork(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• org (String): Optional. Optional String - Organization login. The repository will be forked into this organization.

• • repos#get(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.

• • repos#getAll(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• type (String): Optional. Possible values: all, owner, public, private, member. Default: all. Validation rule: ^(all|owner|public|private|member)$.
• sort (String): Optional. Possible values: created, updated, pushed, full_name. Default: full_name. Validation rule: ^(created|updated|pushed|full_name)$.
• direction (String): Optional. Validation rule: ^(asc|desc)$.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • repos#getAllCommitComments(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • repos#getArchiveLink(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• ref (String): Required. String of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected.
• archive_format (String): Required. Either tarball or zipball Validation rule: ^(tarball|zipball)$.

• • repos#getBranch(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• branch (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • repos#getBranches(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • repos#getCollaborator(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• collabuser (String): Required.

• • repos#getCollaborators(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • repos#getCommit(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• sha (String): Required.

• • repos#getCommitComment(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• id (String): Required.

• • repos#getCommitComments(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• sha (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • repos#getCommits(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• sha (String): Optional. Optional string - Sha or branch to start listing commits from.
• path (String): Optional. Optional string - Only commits containing this file path will be returned.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.
• since (Date): Optional. Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ

• • repos#getContent(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• path (String): Optional. The content path.
• ref (String): Optional. The String name of the Commit/Branch/Tag. Defaults to master.

• • repos#getContributors(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• anon (Boolean): Optional. Optional flag. Set to 1 or true to include anonymous contributors in results.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • repos#getDownload(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• id (String): Required.

• • repos#getDownloads(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • repos#getForks(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• sort (String): Optional. Possible values: newest, oldest, watchers, default: newest. Validation rule: ^(newest|oldest|watchers)$.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • repos#getFromOrg(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• org (String): Required.
• type (String): Optional. Possible values: all, public, member. Default: all. Validation rule: ^(all|public|member)$.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • repos#getFromUser(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• type (String): Optional. Possible values: all, owner, member. Default: public. Validation rule: ^(all|owner|member)$.
• sort (String): Optional. Possible values: created, updated, pushed, full_name. Default: full_name. Validation rule: ^(created|updated|pushed|full_name)$.
• direction (String): Optional. Validation rule: ^(asc|desc)$.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • repos#getHook(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• id (String): Required.

• • repos#getHooks(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • repos#getKey(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• id (String): Required.

• • repos#getKeys(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • repos#getLanguages(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$.
• per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$.

• • repos#getReadme(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.

Params on the msg object:

• headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'Last-Modified', 'Etag', 'Status', 'Cookie'.
• user (String): Required.
• repo (String): Required.
• ref (String): Optional. The String name of the Commit/Branch/Tag. Defaults to master.

• • repos#getStargazers(msg, callback)
  • • null

• • msg
  • • Object

  • Object that contains the parameters and their values to be sent to the server.

• • callback
  • • Function

  • function to call when the request is finished with an error as first argument and result data as second argument.