ManagerApi
extends AbstractApi
in package
Managers are users you let manage your projects, TMs, glossaries, and style guides. Crowdin only.
Table of Contents
Methods
- create() : Manager|null
- Add Manager
- delete() : mixed
- Delete Manager
- get() : Manager|null
- Get Manager
- list() : ModelCollection
- List Managers
- update() : Manager|null
- Edit Manager
Methods
create()
Add Manager
public
create(array<string|int, mixed> $data) : Manager|null
Parameters
- $data : array<string|int, mixed>
-
string $data[username] Either username or email is required
string $data[email] Either username or email is required. Unknown emails get an invitation
integer[] $data[projectIds]
integer[] $data[tmIds]
integer[] $data[glossaryIds]
integer[] $data[styleGuideIds] At least one of projectIds, tmIds, glossaryIds, styleGuideIds is required
string $data[message] Personal message added to the notification email
Tags
Return values
Manager|nulldelete()
Delete Manager
public
delete(int $managerId) : mixed
Parameters
- $managerId : int
Tags
get()
Get Manager
public
get(int $managerId) : Manager|null
Parameters
- $managerId : int
-
The same as the manager's user ID
Tags
Return values
Manager|nulllist()
List Managers
public
list([array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $params : array<string|int, mixed> = []
-
string $params[status] active, pending or comma-separated list. Default is both
string $params[email] Pending managers only
string $params[search] Username or full name
string $params[projectIds] One ID or comma-separated list
string $params[orderBy]
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionupdate()
Edit Manager
public
update(Manager $manager) : Manager|null
Parameters
- $manager : Manager
-
Only projectIds, tmIds, glossaryIds and styleGuideIds can be changed