Module `crowdin_api.api_resources.bundles.resource`

Classes

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

Resource for Bundles.

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

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

Ancestors

BaseResource

Methods

def add_bundle(self, name: str, format: str, sourcePatterns: Iterable[str], exportPattern: str, projectId: Optional[int] = None, ignorePatterns: Optional[Iterable[str]] = None, isMultilingual: Optional[bool] = None, includeProjectSourceLanguage: Optional[bool] = None, labelIds: Optional[Iterable[int]] = None, excludeLabelIds: Optional[Iterable[int]] = None): Add Bundles.

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

Link to documentation for enterprise: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.bundles.post
def check_bundle_export_status(self, bundleId: int, exportId: str, projectId: Optional[int] = None): Check Bundle Export Status.

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

Link to documentation for enterprise: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.bundles.exports.get
def delete_bundle(self, bundleId: int, projectId: Optional[int] = None): Delete Bundle.

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

Link to documentation for enterprise: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.bundles.delete
def download_bundle(self, bundleId: int, exportId: str, projectId: Optional[int] = None): Download bundle.

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

Link to documentation for enterprise: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.bundles.exports.download.get
def edit_bundle(self, bundleId: int, data: Iterable[BundlePatchRequest], projectId: Optional[int] = None): Edit Bundle.

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

Link to documentation for enterprise: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.bundles.patch
def export_bundle(self, bundleId: int, projectId: Optional[int] = None): Export bundle.

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

Link to documentation for enterprise: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.bundles.exports.post
def get_bundle(self, bundleId: int, projectId: Optional[int] = None): Get Bundle.

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

Link to documentation for enterprise: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.bundles.get
def get_bundle_list_files(self, bundleId: int, projectId: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None): Get Bundle List Files.

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

Link to documentation for enterprise: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.bundles.files.getMany
def get_bundles_exports_path(self, projectId: int, bundleId: int, exportId: Optional[str] = None)
def get_bundles_path(self, projectId: int, bundleId: Optional[int] = None)
def list_bundles(self, projectId: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None): List Bundles.

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

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