Module crowdin_api.api_resources.teams.resource

Classes

class TeamsResource (requester: APIRequester, project_id: Optional[int] = None, page_size=25)

Resource for Teams.

Organization teams.

Use API to create, modify, and delete specific teams and members.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/Teams

Ancestors

• BaseResource

Methods

def add_team(self, name: str)

Add Team.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.teams.post

def add_team_members(self, teamId: int, userIds: Iterable[int])

Add Team Members.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.teams.members.post

def add_team_to_project(self, teamId: int, projectId: Optional[int] = None, accessToAllWorkflowSteps: Optional[bool] = None, managerAccess: Optional[bool] = None, permissions: Optional[Permissions] = None, roles: Optional[Iterable[TeamByProjectRole]] = None, developerAccess: Optional[bool] = None)

Add Team To Project.

managerAccess, developerAccess, accessToAllWorkflowSteps, permissions and roles are mutually exclusive. accessToAllWorkflowSteps and permissions are deprecated by the API, use roles instead. Omitted values fall back to the API defaults (accessToAllWorkflowSteps - true, managerAccess - false).

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.teams.post

def delete_all_team_members(self, teamId: int)

Delete All Team Members.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.teams.members.deleteMany

def delete_team(self, teamId: int)

Delete Team.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.teams.delete

def delete_team_member(self, teamId: int, memberId: int)

Delete Team Member.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.teams.members.delete

def edit_team(self, teamId: int, data: Iterable[TeamPatchRequest])

Edit Team.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.teams.patch

def edit_team_project_permissions(self, teamId: int, data: Iterable[TeamProjectPermissionsPatchRequest])

Edit Team Project Permissions.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.teams.projects.permissions.patch

def get_group_team(self, group_id: int, team_id: int)

Get Group Team

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#tag/Teams/operation/api.groups.teams.get

def get_group_teams_path(self, group_id: int, team_id: Optional[int] = None)

def get_members_path(self, teamId: int, memberId: Optional[int] = None)

def get_team(self, teamId: int)

Get Team.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.teams.get

def get_teams_path(self, teamId: Optional[int] = None)

def list_group_teams(self, group_id: int, order_by: Optional[Sorting] = None, offset: Optional[int] = None, limit: Optional[int] = None)

List Group Teams

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#tag/Teams/operation/api.groups.teams.getMany

def list_team_project_permissions(self, teamId: int, offset: Optional[int] = None, limit: Optional[int] = None)

List Team Project Permissions.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.teams.projects.permissions.getMany

def list_teams(self, order_by: Optional[Sorting] = None, offset: Optional[int] = None, limit: Optional[int] = None, search: Optional[str] = None, project_ids: Optional[Iterable[int]] = None, project_roles: Optional[Iterable[ProjectRole]] = None, language_ids: Optional[Iterable[str]] = None, group_ids: Optional[Iterable[int]] = None)

List Teams.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.teams.getMany

def teams_member_list(self, teamId: int, offset: Optional[int] = None, limit: Optional[int] = None)

Team Members List.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.teams.members.getMany

def update_group_teams(self, group_id: int, request_data: Iterable[GroupTeamPatchRequest])

Update Group Teams

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#tag/Teams/operation/api.groups.teams.patch