View Source Tentacat.Organizations.Teams (Tentacat v2.5.0)

Summary

Functions

Link to this function

create(client, organization, body)

View Source
@spec create(Tentacat.Client.t(), binary(), map()) :: Tentacat.response()

Create a team.

Create body example:

%{
  "name" => "my new team",
  "description" => "Team for everyone with commit access",
  "repo_names" => [
    "my_org/secret_repo",
    "my_org/secret_repo2",
  ],
  "privacy" => "closed",
}

Example

Tentacat.Organizations.Teams.create client, "my_org", body

More info at: https://developer.github.com/v3/orgs/teams/#create-team

@spec delete(Tentacat.Client.t(), integer()) :: Tentacat.response()

Delete a team.

Example

Tentacat.Organizations.Teams.delete client, "1485060"

More info at: https://developer.github.com/v3/orgs/teams/#delete-team

Link to this function

find(client \\ %Client{}, team_id)

View Source

Get a team.

Example

Tentacat.Orgnizations.Teams.find "1485060"
Tentacat.Orgnizations.Teams.find client, "1485060"

More info at: https://developer.github.com/v3/orgs/teams/#get-team

Link to this function

list(client \\ %Client{}, organization)

View Source

List all public teams for an organization.

Example

Tentacat.Organizations.Teams.list "my_org"
Tentacat.Organizations.Teams.list client, "my_org"

More info at: https://developer.github.com/v3/orgs/teams/#list-teams

Link to this function

update(client, team_id, options)

View Source
@spec update(Tentacat.Client.t(), integer(), map()) :: Tentacat.response()

Update a team.

Update body example:

%{
  "name": "Super Admins",
  "description": "Team for everyone with commit and admin access",
}

Example

Tentacat.Organizations.Teams.update client, "1485060", body

More info at: https://developer.github.com/v3/orgs/teams/#edit-team