Tentacat v1.2.0 Tentacat.Organizations.Members

Summary

Functions

Conceal a user’s membership on an organization

List members of a organization. The response will differ if the authenticated user is also owner of the organization

Check if a user is, publicly or privately, a member of the organization

List of publicized members of an organization

Check if a user is a public member of the organization

Publicize a user’s membership on an organization

Remove a member user from an organization

Functions

conceal(client, organization, user)

Specs

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

Conceal a user’s membership on an organization

Example

Tentacat.Organizations.Members.conceal "github", "mojombo"

More info at: http://developer.github.com/v3/orgs/members/#conceal-a-users-membership

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

Specs

List members of a organization. The response will differ if the authenticated user is also owner of the organization

Example

Tentacat.Organizations.Members.list "github"
Tentacat.Organizations.Members.list client, "github"

More info at: http://developer.github.com/v3/orgs/members/#members-list

member?(client \\ %Client{}, organization, user)

Specs

member?(Tentacat.Client.t, binary, binary) :: Tentacat.response

Check if a user is, publicly or privately, a member of the organization.

Possible responses: 204, 404 or 302

Example

Tentacat.Organizations.Members.member? "github", "mojombo"
Tentacat.Organizations.Members.member? client, "github", "mojombo"

More info at: http://developer.github.com/v3/orgs/members/#check-membership

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

Specs

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

List of publicized members of an organization

Example

Tentacat.Organizations.Members.public_list "github"
Tentacat.Organizations.Members.public_list client, "github"

More info at: http://developer.github.com/v3/orgs/members/#public-members-list

public_member?(client \\ %Client{}, organization, user)

Specs

public_member?(Tentacat.Client.t, binary, binary) :: Tentacat.response

Check if a user is a public member of the organization.

Possible responses: 204 or 404

Example

Tentacat.Organizations.Members.public_member? "github", "mojombo"
Tentacat.Organizations.Members.public_member? client, "github", "mojombo"

More info at: http://developer.github.com/v3/orgs/members/#public-members-list

publicize(client, organization, user)

Specs

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

Publicize a user’s membership on an organization

Example

Tentacat.Organizations.Members.publicize "github", "mojombo"

More info at: http://developer.github.com/v3/orgs/members/#publicize-a-users-membership

remove(client, organization, user)

Specs

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

Remove a member user from an organization

Example

Tentacat.Organizations.Members.remove client, "github", "mojombo"

More info at: http://developer.github.com/v3/orgs/members/#remove-organization-membership