Module crowdin_api.api_resources.projects.resource

Classes

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

Resource for Storages.

Using projects, you can keep your source files sorted. Use API to manage projects, change their settings, or remove them if required.

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

Ancestors

Methods

def add_file_based_project(self, name: str, sourceLanguageId: str, type: Optional[ProjectType] = None, normalizePlaceholder: Optional[bool] = None, saveMetaInfoInSource: Optional[bool] = None, notificationSettings: Optional[NotificationSettings] = None, identifier: Optional[str] = None, targetLanguageIds: Optional[Iterable[str]] = None, visibility: Optional[ProjectVisibility] = None, languageAccessPolicy: Optional[ProjectLanguageAccessPolicy] = None, cname: Optional[str] = None, description: Optional[str] = None, translateDuplicates: Optional[ProjectTranslateDuplicates] = None, isMtAllowed: Optional[bool] = None, autoSubstitution: Optional[bool] = None, autoTranslateDialects: Optional[bool] = None, skipUntranslatedStrings: Optional[bool] = None, skipUntranslatedFiles: Optional[bool] = None, exportApprovedOnly: Optional[bool] = None, defaultTmId: Optional[int] = None, defaultGlossaryId: Optional[int] = None, tmApprovedSuggestionsOnly: Optional[bool] = None, tagsDetection: Optional[ProjectTagsDetection] = None, taskBasedAccessControl: Optional[bool] = None, publicDownloads: Optional[bool] = None, hiddenStringsProofreadersAccess: Optional[bool] = None, useGlobalTm: Optional[bool] = None, showTmSuggestionsDialects: Optional[bool] = None, qaCheckIsActive: Optional[bool] = None, qaCheckCategories: Optional[QACheckCategories] = None, qaChecksIgnorableCategories: Optional[QAChecksIgnorableCategories] = None, languageMapping: Optional[Dict[~KT, ~VT]] = None, glossaryAccess: Optional[bool] = None, glossaryAccessOption: Optional[ProjectGlossaryAccessOption] = None, tmPreTranslate: Optional[TmPreTranslate] = None, mtPreTranslate: Optional[MtPreTranslate] = None, aiPreTranslate: Optional[AiPreTranslate] = None, preTranslationAiPromptId: Optional[int] = None, editorSuggestionAiPromptId: Optional[int] = None, qaCheckActionAiPromptId: Optional[int] = None, contextReviewAiPromptId: Optional[int] = None, savingsReportSettingsTemplateId: Optional[int] = None, assignedStyleGuides: Optional[Iterable[int]] = None, inContext: Optional[bool] = None, inContextProcessHiddenStrings: Optional[bool] = None, inContextPseudoLanguageId: Optional[str] = None, tmContextType: Optional[ProjectTmContextType] = None, groupId: Optional[int] = None, templateId: Optional[int] = None, steps: Optional[Iterable[WorkflowStepSettings]] = None, vendorId: Optional[int] = None, mtEngineId: Optional[int] = None, taskReviewerIds: Optional[Iterable[int]] = None, delayedWorkflowStart: Optional[bool] = None, exportWithMinApprovalsCount: Optional[int] = None, exportStringsThatPassedWorkflow: Optional[bool] = None, qaApprovalsCount: Optional[int] = None, customQaCheckIds: Optional[Iterable[int]] = None, externalQaCheckIds: Optional[Iterable[int]] = None, fields: Optional[Dict[str, Any]] = None, alignmentActionAiPromptId: Optional[int] = None)

Add Project(Files Based Project Form).

Crowdin only: identifier, visibility, languageAccessPolicy, cname, exportApprovedOnly, useGlobalTm, tmPreTranslate, mtPreTranslate, aiPreTranslate.

Crowdin Enterprise only: groupId, templateId, steps, vendorId, mtEngineId, taskReviewerIds, delayedWorkflowStart, exportWithMinApprovalsCount, exportStringsThatPassedWorkflow, qaApprovalsCount, customQaCheckIds, externalQaCheckIds, fields, alignmentActionAiPromptId.

Deprecated: glossaryAccess (use glossaryAccessOption instead) and preTranslationAiPromptId (use aiPreTranslate instead).

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

def add_project(self, request_data: Dict[~KT, ~VT])

Add Project.

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

def add_project_file_format_settings(self, format: str, settings: Union[PropertyFileFormatSettings, XmlFileFormatSettings, SpecificFileFormatSettings, DocxFileFormatSettings, MediaWikiFileFormatSettings, TxtFileFormatSettings, OtherFileFormatSettings, MdFileFormatSettings, MdxFileFormatSettings, JsonFileFormatSettings, JavaScriptFileFormatSettings, StringCatalogFileFormatSettings, VdfFileFormatSettings, Dict[str, Any]], projectId: Optional[int] = None)

Add Project File Format Settings.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.file-format-settings.post

def add_project_strings_exporter_settings(self, format: str, settings: Union[AndroidStringsExporterSettings, MacOSXStringsExporterSettings, XliffStringsExporterSettings], projectId: Optional[int] = None)

Add Project Strings Exporter Settings.

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

def add_strings_based_project(self, name: str, sourceLanguageId: str, identifier: Optional[str] = None, type: Optional[ProjectType] = None, targetLanguageIds: Optional[Iterable[str]] = None, visibility: Optional[ProjectVisibility] = None, languageAccessPolicy: Optional[ProjectLanguageAccessPolicy] = None, cname: Optional[str] = None, description: Optional[str] = None, translateDuplicates: Optional[ProjectTranslateDuplicates] = None, isMtAllowed: Optional[bool] = None, autoSubstitution: Optional[bool] = None, autoTranslateDialects: Optional[bool] = None, publicDownloads: Optional[bool] = None, hiddenStringsProofreadersAccess: Optional[bool] = None, useGlobalTm: Optional[bool] = None, skipUntranslatedStrings: Optional[bool] = None, skipUntranslatedFiles: Optional[bool] = None, exportApprovedOnly: Optional[bool] = None, inContextProcessHiddenStrings: Optional[bool] = None, inContextPseudoLanguageId: Optional[str] = None, qaCheckIsActive: Optional[bool] = None, qaCheckCategories: Optional[QACheckCategories] = None, qaChecksIgnorableCategories: Optional[QAChecksIgnorableCategories] = None, languageMapping: Optional[Dict[~KT, ~VT]] = None, glossaryAccess: Optional[bool] = None, notificationSettings: Optional[NotificationSettings] = None, defaultTmId: Optional[int] = None, defaultGlossaryId: Optional[int] = None, tmApprovedSuggestionsOnly: Optional[bool] = None, tagsDetection: Optional[ProjectTagsDetection] = None, taskBasedAccessControl: Optional[bool] = None, showTmSuggestionsDialects: Optional[bool] = None, normalizePlaceholder: Optional[bool] = None, glossaryAccessOption: Optional[ProjectGlossaryAccessOption] = None, tmPreTranslate: Optional[TmPreTranslate] = None, mtPreTranslate: Optional[MtPreTranslate] = None, aiPreTranslate: Optional[AiPreTranslate] = None, preTranslationAiPromptId: Optional[int] = None, editorSuggestionAiPromptId: Optional[int] = None, qaCheckActionAiPromptId: Optional[int] = None, contextReviewAiPromptId: Optional[int] = None, savingsReportSettingsTemplateId: Optional[int] = None, assignedStyleGuides: Optional[Iterable[int]] = None, inContext: Optional[bool] = None, groupId: Optional[int] = None, templateId: Optional[int] = None, steps: Optional[Iterable[WorkflowStepSettings]] = None, vendorId: Optional[int] = None, mtEngineId: Optional[int] = None, taskReviewerIds: Optional[Iterable[int]] = None, delayedWorkflowStart: Optional[bool] = None, exportWithMinApprovalsCount: Optional[int] = None, exportStringsThatPassedWorkflow: Optional[bool] = None, qaApprovalsCount: Optional[int] = None, customQaCheckIds: Optional[Iterable[int]] = None, externalQaCheckIds: Optional[Iterable[int]] = None, fields: Optional[Dict[str, Any]] = None, alignmentActionAiPromptId: Optional[int] = None)

Add Project(Strings Based Project Form).

Crowdin only: identifier, visibility, languageAccessPolicy, cname, exportApprovedOnly, useGlobalTm, tmPreTranslate, mtPreTranslate, aiPreTranslate.

Crowdin Enterprise only: groupId, templateId, steps, vendorId, mtEngineId, taskReviewerIds, delayedWorkflowStart, exportWithMinApprovalsCount, exportStringsThatPassedWorkflow, qaApprovalsCount, customQaCheckIds, externalQaCheckIds, fields, alignmentActionAiPromptId.

Deprecated: glossaryAccess (use glossaryAccessOption instead) and preTranslationAiPromptId (use aiPreTranslate instead).

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

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

Delete Project.

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

def delete_project_file_format_settings(self, fileFormatSettingsId: int, projectId: Optional[int] = None)

Delete Project File Format Settings.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.file-format-settings.delete

def delete_project_strings_exporter_settings(self, systemStringExporterSettingsId: int, projectId: Optional[int] = None)

Delete Project Strings Exporter Settings.

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

def download_project_file_custom_segmentation(self, fileFormatSettingsId: int, projectId: Optional[int] = None)

Download Project File Format Settings Custom Segmentation.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.file-format-settings.custom-segmentations.get

def edit_project(self, data: Iterable[ProjectPatchRequest], projectId: Optional[int] = None)

Edit Project.

See ProjectPatchPath for the available paths, including the Crowdin Enterprise only and file-based only ones.

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

def edit_project_file_format_settings(self, fileFormatSettingsId: int, data: Iterable[ProjectFilePatchRequest], projectId: Optional[int] = None)

Edit Project File Format Settings.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.file-format-settings.patch

def edit_project_strings_exporter_settings(self, systemStringExporterSettingsId: int, format: Optional[str] = None, settings: Union[AndroidStringsExporterSettings, MacOSXStringsExporterSettings, XliffStringsExporterSettings, None] = None, projectId: Optional[int] = None, data: Optional[Iterable[StringsExporterSettingsPatchRequest]] = None)

Edit Project Strings Exporter Settings.

The API expects a JSON Patch document. Pass it via data, or pass format and/or settings and they will be sent as replace operations on /format and /settings.

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

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

Get Project.

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

def get_project_file_format_settings(self, fileFormatSettingsId: int, projectId: Optional[int] = None)

Get Project File Format Settings.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.file-format-settings.get

def get_project_file_format_settings_path(self, projectId: int, fileFormatSettingsId: Optional[int] = None)
def get_project_strings_exporter_settings(self, systemStringExporterSettingsId: int, projectId: Optional[int] = None)

Get Project Strings Exporter Settings

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

def get_projects_path(self, projectId: Optional[int] = None)
def get_strings_exporter_path(self, projectId: int, systemStringExporterSettingsId: Optional[int] = None)
def list_project_file_format_settings(self, projectId: Optional[int] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None)

List Project File Format Settings.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.file-format-settings.getMany

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

List Project Strings Exporter Settings.

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

def list_projects(self, orderBy: Optional[Sorting] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None, groupId: Optional[int] = None, userId: Union[int, str, None] = None, hasManagerAccess: Optional[HasManagerAccess] = None, type: Optional[ProjectType] = None, filter: Optional[str] = None)

List Projects.

Note: groupId is supported by Crowdin Enterprise only, userId and type by Crowdin only. filter filters projects by name.

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

def reset_project_file_custom_segmentation(self, fileFormatSettingsId: int, projectId: Optional[int] = None)

Reset Project File Format Settings Custom Segmentation.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.file-format-settings.custom-segmentations.delete