Teams
extends CloudApiBase
in
implements
CloudApiInterface
Class Teams
Table of Contents
| $client | ClientInterface | |
|---|---|---|
| create() | Create a new team. | OperationResponse |
| getAll() | Show all teams. | TeamsResponse |
| rename() | Rename an existing team. | OperationResponse |
| delete() | Delete a team. | OperationResponse |
| addApplication() | Add an application to a team. | OperationResponse |
| invite() | Invites a user to join a team. | OperationResponse |
| getApplications() | Show all applications associated with a team. | ApplicationsResponse |
| __construct() | Client constructor. | mixed |
Properties
$client
protected
ClientInterface
$client
Methods
create()
Create a new team.
public
create(
$organizationUuid :
string
, $name :
string
)
: OperationResponse
Parameters
- $organizationUuid : string
- $name : string
Return values
OperationResponsegetAll()
Show all teams.
public
getAll(
)
: TeamsResponse
Return values
TeamsResponserename()
Rename an existing team.
public
rename(
$teamUuid :
string
, $name :
string
)
: OperationResponse
Parameters
- $teamUuid : string
- $name : string
Return values
OperationResponsedelete()
Delete a team.
public
delete(
$teamUuid :
string
)
: OperationResponse
Parameters
- $teamUuid : string
Return values
OperationResponseaddApplication()
Add an application to a team.
public
addApplication(
$teamUuid :
string
, $applicationUuid :
string
)
: OperationResponse
Parameters
- $teamUuid : string
- $applicationUuid : string
Return values
OperationResponseinvite()
Invites a user to join a team.
public
invite(
$teamUuid :
string
, $email :
string
, $roles :
array
)
: OperationResponse
Parameters
- $teamUuid : string
- $email : string
- $roles : array
Return values
OperationResponsegetApplications()
Show all applications associated with a team.
public
getApplications(
$teamUuid :
string
)
: ApplicationsResponse
Parameters
- $teamUuid : string
Return values
ApplicationsResponse__construct()
Client constructor.
public
__construct(
$client :
ClientInterface
)
: mixed
Parameters
- $client : ClientInterface