View Source Tentacat.Organizations (Tentacat v2.4.0)
Summary
Functions
Get an organization.
List all public organizations for a user.
List public and private organizations for the authenticated user.
Update an organization.
Functions
@spec find(Tentacat.Client.t(), binary()) :: Tentacat.response()
Get an organization.
Example
Tentacat.Orgnizations.find "Codeminer42"
Tentacat.Orgnizations.find client, "Codeminer42"
More info at: http://developer.github.com/v3/orgs/#get-an-organization
@spec list(Tentacat.Client.t(), binary()) :: Tentacat.response()
List all public organizations for a user.
Example
Tentacat.Organizations.list "edgurgel"
Tentacat.Organizations.list client, "edgurgel"
More info at: http://developer.github.com/v3/orgs/#list-user-organizations
@spec list_mine(Tentacat.Client.t()) :: Tentacat.response()
List public and private organizations for the authenticated user.
Example
Tentacat.Organizations.list_mine client
More info at: http://developer.github.com/v3/orgs/#list-user-organizations
@spec update(Tentacat.Client.t(), binary(), list()) :: Tentacat.response()
Update an organization.
Possible values for options
:
- [billing_email: "billing email"]
- [company: "Company42"]
- [email: "public email"]
- [location: "Brazil"]
- [name: "company42"]
Example
Tentacat.Organizations.update(client, "codeminer42", [email: "public@codeminer42.com", location: "São Paulo"])
More info at: http://developer.github.com/v3/orgs/#edit-an-organization