View Source Tentacat.Organizations.Members (Tentacat v2.5.0)
Summary
Functions
Conceal a user
's membership on an organization
.
List members of a 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
@spec 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
@spec list(Tentacat.Client.t(), binary(), Keyword.t()) :: Tentacat.response()
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"
Tentacat.Organizations.Members.list client, "github", %{page: 2}
More info at: http://developer.github.com/v3/orgs/members/#members-list
@spec 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
@spec 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
@spec 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
@spec 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
@spec 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