Module crowdin_api.api_resources.source_strings.resource

Classes

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

Resource for Source Strings.

Source strings are the text units for translation. Instead of modifying source files, you can manage source strings one by one.

Use API to add, edit, or delete some specific strings in the source-based and files-based projects (available only for the following file formats: CSV, RESX, JSON, Android XML, iOS strings, PROPERTIES, XLIFF).

Link to documentation: https://developer.crowdin.com/api/v2/#tag/Source-Strings

Ancestors

• BaseResource

Methods

def add_string(self, text: str, projectId: Optional[int] = None, identifier: Optional[str] = None, fileId: Optional[int] = None, context: Optional[str] = None, isHidden: Optional[bool] = None, maxLength: Optional[int] = None, labelIds: Optional[Iterable[int]] = None, branchId: Optional[int] = None)

Add String.

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

def delete_string(self, stringId: int, projectId: Optional[int] = None)

Delete String.

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

def edit_string(self, stringId: int, data: Iterable[SourceStringsPatchRequest], projectId: Optional[int] = None)

Edit String.

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

def get_source_strings_path(self, projectId: int, stringId: Optional[int] = None)

def get_string(self, stringId: int, projectId: Optional[int] = None)

Get String.

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

def list_strings(self, projectId: Optional[int] = None, orderBy: Optional[Sorting] = None, fileId: Optional[int] = None, branchId: Optional[int] = None, denormalizePlaceholders: Optional[DenormalizePlaceholders] = None, labelIds: Optional[Iterable[int]] = None, taskId: Optional[int] = None, croql: Optional[str] = None, filter: Optional[str] = None, scope: Optional[ScopeFilter] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None)

List Strings.

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.projects.strings.getMany

def string_batch_operation(self, data: Iterable[StringBatchOperationPatchRequest], projectId: Optional[int] = None)

String Batch Operations.

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.projects.strings.batchPatch