Module `crowdin_api.api_resources.string_comments.resource`

Classes

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

Resource for String Comments.

Use API to add or remove strings translations, approvals, and votes.

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/String-Comments

Ancestors

BaseResource

Methods

def add_string_comment(self, text: str, stringId: Optional[int] = None, targetLanguageId: Optional[str] = None, type: Optional[StringCommentType] = None, projectId: Optional[int] = None, issueType: Optional[StringCommentIssueType] = None, attachments: Optional[Iterable[Union[int, Dict[str, int]]]] = None, fileId: Optional[int] = None, isShared: Optional[bool] = None): Add String Comment.

:param stringId: String Identifier. Required unless fileId is used. :param type: Comment type (comment or issue). Required by the API. :param attachments: Storage Identifiers (or {"id": storageId} objects) of attachments. :param fileId: Asset File Identifier, used instead of stringId to comment an asset (file-based projects only). :param isShared: Defines shared comment or issue (Crowdin Enterprise only).

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.comments.post
def delete_string_comment(self, stringCommentId: int, projectId: Optional[int] = None): Delete String Comment.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.comments.delete
def delete_string_comment_attachment(self, stringCommentId: int, attachmentId: int, projectId: Optional[int] = None): Delete String Comment Attachment.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.comments.attachments.delete
def edit_string_comment(self, stringCommentId: int, data: Iterable[StringCommentPatchRequest], projectId: Optional[int] = None): Edit String Comment.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.comments.patch
def get_string_comment(self, stringCommentId: int, projectId: Optional[int] = None): Get String Comment.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.comments.get
def get_string_comments_path(self, projectId: int, stringCommentId: Optional[int] = None)
def list_string_comments(self, projectId: Optional[int] = None, orderBy: Optional[Sorting] = None, stringId: Optional[int] = None, type: Optional[StringCommentType] = None, issueType: Optional[Iterable[StringCommentIssueType]] = None, issueStatus: Optional[StringCommentIssueStatus] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None, fileId: Optional[int] = None): List String Comments.

:param stringId: Filter comments by string. Can't be used together with fileId. :param fileId: Filter comments by asset file (file-based projects only). Can't be used together with stringId.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.comments.getMany
def string_comment_batch_operations(self, project_id: int, data: Iterable[StringCommentBatchOpPatchRequest]): String Comment Batch Operations.

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/String-Comments/operation/api.projects.comments.batchPatch

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#tag/String-Comments/operation/api.projects.comments.batchPatch