Tentacat v0.7.2 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
Specs
conceal(binary, binary, Tentacat.Client.t) :: 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
Specs
list(binary, Tentacat.Client.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 "github", client
More info at: http://developer.github.com/v3/orgs/members/#members-list
Specs
member?(binary, binary, Tentacat.Client.t) :: 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? "github", "mojombo", client
More info at: http://developer.github.com/v3/orgs/members/#check-membership
Specs
public_list(binary, Tentacat.Client.t) :: Tentacat.response
List of publicized members of an organization
Example
Tentacat.Organizations.Members.public_list "github"
Tentacat.Organizations.Members.public_list "github", client
More info at: http://developer.github.com/v3/orgs/members/#public-members-list
Specs
public_member?(binary, binary, Tentacat.Client.t) :: 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? "github", "mojombo", client
More info at: http://developer.github.com/v3/orgs/members/#public-members-list
Specs
publicize(binary, binary, Tentacat.Client.t) :: 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
Specs
remove(binary, binary, Tentacat.Client.t) :: Tentacat.response
Remove a member user
from an organization
Example
Tentacat.Organizations.Members.remove "github", "mojombo", client
More info at: http://developer.github.com/v3/orgs/members/#remove-a-member