Module crowdin_api.api_resources.labels.resource

Classes

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

Resource for Labels.

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

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

Ancestors

• BaseResource

Methods

def add_label(self, title: str, projectId: Optional[int] = None)

Add Label.

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

def assign_label_to_screenshots(self, label_id: int, screenshot_ids: Union[int, Iterable[int]], project_id: Optional[int] = None)

Assign Label to Screenshots

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

def assign_label_to_strings(self, labelId: int, stringIds: Union[int, Iterable[int]], projectId: Optional[int] = None)

Assign Label to Strings.

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

def delete_label(self, labelId: int, projectId: Optional[int] = None)

Delete Label.

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

def edit_label(self, labelId: int, data: Iterable[LabelsPatchRequest], projectId: Optional[int] = None)

Edit Label.

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

def get_label(self, labelId: int, projectId: Optional[int] = None)

Get Label.

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

def get_labels_path(self, projectId: int, labelId: Optional[int] = None)

def get_screenshots_path(self, project_id: int, label_id: int)

def list_labels(self, projectId: Optional[int] = None, orderBy: Optional[Sorting] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None, isSystem: Union[bool, int, None] = None)

List Labels.

isSystem (filter by system labels) is for string-based projects only.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.labels.getMany https://support.crowdin.com/developer/api/v2/string-based/#operation/api.projects.labels.getMany

def unassign_label_from_screenshots(self, label_id: int, screenshot_ids: Union[int, Iterable[int]], project_id: Optional[int] = None)

Unassign Label from Screenshots

screenshot_ids can be a single screenshot identifier or an iterable of them (up to 500 at a time).

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.labels.screenshots.deleteMany https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.labels.screenshots.deleteMany

def unassign_label_from_strings(self, labelId: int, stringIds: Union[int, Iterable[int]], projectId: Optional[int] = None)

Unassign Label from Strings.

stringIds can be a single string identifier or an iterable of them (up to 500 at a time).

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.labels.strings.deleteMany https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.labels.strings.deleteMany