Tentacat

v0.7.2

Tentacat v0.7.2 Tentacat.Organizations

Summary

Functions

find(org, client \\ %Tentacat.Client{})

Get an organization

list(user, client \\ %Tentacat.Client{})

List all public organizations for a user

list_mine(client)

List public and private organizations for the authenticated user

update(org, options, client)

Update an organization

Functions

find(org, client \\ %Tentacat.Client{})

Specs

find(binary, Tentacat.Client.t) :: Tentacat.response

Get an organization

Example

Tentacat.Orgnizations.find "Codeminer42"
Tentacat.Orgnizations.find "Codeminer42", client

More info at: http:\developer.github.com/v3/orgs/#get-an-organization

list(user, client \\ %Tentacat.Client{})

Specs

list(binary, Tentacat.Client.t) :: Tentacat.response

List all public organizations for a user

Example

Tentacat.Organizations.list "edgurgel"
Tentacat.Organizations.list "edgurgel", client

More info at: http:\developer.github.com/v3/orgs/#list-user-organizations

list_mine(client)

Specs

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

update(org, options, client)

Specs

update(binary, list, Tentacat.Client.t) :: 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("codeminer42", [email: "public@codeminer42.com", location: "São Paulo"], client)

More info at: http:\developer.github.com/v3/orgs/#edit-an-organization