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://developer.crowdin.com/api/v2/#tag/String-Comments

Ancestors

• BaseResource

Methods

def add_string_comment(self, text: str, stringId: int, targetLanguageId: str, type: StringCommentType, projectId: Optional[int] = None, issueType: Optional[StringCommentIssueType] = None)

Add String Comment.

Link to documentation: https://developer.crowdin.com/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://developer.crowdin.com/api/v2/#operation/api.projects.comments.delete

def edit_string_comment(self, stringCommentId: int, data: Iterable[StringCommentPatchRequest], projectId: Optional[int] = None)

Edit String Comment.

Link to documentation: https://developer.crowdin.com/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://developer.crowdin.com/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)

List String Comments.

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