Module crowdin_api.api_resources.groups.resource

Classes

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

Resource for Groups.

Groups allow you to organize your projects based on specific characteristics. Using projects, you can keep your source files sorted.

Use API to manage projects and groups, change their settings, or remove them from organization if required.

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#tag/Projects-and-Groups

Ancestors

• BaseResource

Methods

def add_group(self, name: str, parentId: Optional[int] = None, description: Optional[str] = None)

Add Group.

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

def delete_group(self, groupId: int)

Delete Group.

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

def edit_group(self, groupId: int, data: Iterable[GroupPatchRequest])

Edit Group.

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

def get_group(self, groupId: int)

Get Group.

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

def get_groups_path(self, groupId: Optional[int] = None)

def list_groups(self, orderBy: Optional[Sorting] = None, parentId: Optional[int] = None, limit: Optional[int] = None, offset: Optional[int] = None)

List Groups.

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