1. class
  2. PCIT
  3. \
  4. GitHub
  5. \
  6. Service
  7. \
  8. Organizations
  9. \
  10. MembersClient

MembersClient

class MembersClient

Traits

CICommon

Properties

protected $curl from CICommon
protected $api_url from CICommon

Methods

__construct(Curl $curl, string $api_url)

CICommon constructor.

from CICommon
mixed
list(string $org_name, string $filter = 'all', string $role = 'all')

Members list.

bool
checkMembership(string $org_name, string $username)

Check membership.

void
remove(string $org_name, string $username)

Remove a member.

void
listPublic(string $org_name)

Public members list.

bool
checkPublicMembership(string $org_name, string $username)

Check public membership.

void
publicizeUserMembership(string $org_name, string $username)

Publicize a user's membership.

void
concealUserMembership(string $org_name, string $username)

Conceal a user's membership.

mixed
getMembership(string $org_name, string $username)

Get organization membership.

void
updateMembership(string $org_name, string $username, string $role = 'member')

Add or update organization membership.

void
removeMembership(string $org_name, string $username)

Remove organization membership.

mixed
listInvitationTeams(string $org_name, string $invitation_id)

List organization invitation teams.

mixed
listPendingInvitations(string $org_name)

List pending organization invitations.

void
createInvitation(string $org_name, int|null $invitee_id, string|null $email, string $role = 'direct_member', array $team_ids = null)

Create organization invitation.

mixed
listYourMemberships(string $state = null)

List your organization memberships.

void
getYourMembership(string $org_name)

Get your organization membership.

void
editYourMembership(string $org_name)

Edit your organization membership.

void
listOutsideCollaborators(string $org_name, string $filter = 'all')

List outside collaborators.

void
removeOutsideCollaborators(string $org_name, string $username)

Remove outside collaborator.

void
ConvertMemberToOutsideCollaborator(string $org_name, string $username)

Convert member to outside collaborator.

Details

in CICommon at line 18
__construct(Curl $curl, string $api_url)

CICommon constructor.

Parameters

Curl $curl
string $api_url

at line 24
mixed list(string $org_name, string $filter = 'all', string $role = 'all')

Members list.

Parameters

string $org_name org name
string $filter 2fa_disabled or all
string $role admin or member or all

Return Value

mixed

Exceptions

Exception

at line 39
bool checkMembership(string $org_name, string $username)

Check membership.

Parameters

string $org_name
string $username

Return Value

bool

Exceptions

Exception

at line 59
void remove(string $org_name, string $username)

Remove a member.

204

Parameters

string $org_name
string $username

Return Value

void

Exceptions

Exception

at line 69
void listPublic(string $org_name)

Public members list.

Parameters

string $org_name

Return Value

void

Exceptions

Exception

at line 83
bool checkPublicMembership(string $org_name, string $username)

Check public membership.

204

Parameters

string $org_name
string $username

Return Value

bool

Exceptions

Exception

at line 103
void publicizeUserMembership(string $org_name, string $username)

Publicize a user's membership.

204

Parameters

string $org_name
string $username

Return Value

void

Exceptions

Exception

at line 113
void concealUserMembership(string $org_name, string $username)

Conceal a user's membership.

Parameters

string $org_name
string $username

Return Value

void

Exceptions

Exception

at line 125
mixed getMembership(string $org_name, string $username)

Get organization membership.

Parameters

string $org_name
string $username

Return Value

mixed

Exceptions

Exception

at line 138
void updateMembership(string $org_name, string $username, string $role = 'member')

Add or update organization membership.

Parameters

string $org_name
string $username
string $role

Return Value

void

Exceptions

Exception

at line 152
void removeMembership(string $org_name, string $username)

Remove organization membership.

204

Parameters

string $org_name
string $username

Return Value

void

Exceptions

Exception

at line 164
mixed listInvitationTeams(string $org_name, string $invitation_id)

List organization invitation teams.

Parameters

string $org_name
string $invitation_id

Return Value

mixed

Exceptions

Exception

at line 176
mixed listPendingInvitations(string $org_name)

List pending organization invitations.

Parameters

string $org_name

Return Value

mixed

Exceptions

Exception

at line 193
void createInvitation(string $org_name, int|null $invitee_id, string|null $email, string $role = 'direct_member', array $team_ids = null)

Create organization invitation.

201

Parameters

string $org_name
int|null $invitee_id
string|null $email
string $role
array $team_ids

Return Value

void

Exceptions

Exception

at line 218
mixed listYourMemberships(string $state = null)

List your organization memberships.

Parameters

string $state active or pending

Return Value

mixed

Exceptions

Exception

at line 231
void getYourMembership(string $org_name)

Get your organization membership.

Parameters

string $org_name

Return Value

void

Exceptions

Exception

at line 241
void editYourMembership(string $org_name)

Edit your organization membership.

Parameters

string $org_name

Return Value

void

Exceptions

Exception

at line 256
void listOutsideCollaborators(string $org_name, string $filter = 'all')

List outside collaborators.

Parameters

string $org_name org name
string $filter all or 2fa_disabled

Return Value

void

Exceptions

Exception

at line 271
void removeOutsideCollaborators(string $org_name, string $username)

Remove outside collaborator.

204

Parameters

string $org_name
string $username

Return Value

void

Exceptions

Exception

at line 285
void ConvertMemberToOutsideCollaborator(string $org_name, string $username)

Convert member to outside collaborator.

204

Parameters

string $org_name
string $username

Return Value

void

Exceptions

Exception

See also