diff --git a/src/assets/api/crowdin/file-based.yml b/src/assets/api/crowdin/file-based.yml index d8f13c6e..a501455b 100644 --- a/src/assets/api/crowdin/file-based.yml +++ b/src/assets/api/crowdin/file-based.yml @@ -1352,7 +1352,6 @@ paths: type: string enum: - pre_translate - - assist - qa_check - $ref: '#/components/parameters/PaginationLimit' @@ -3730,7 +3729,7 @@ paths: '/projects/{projectId}/bundles': get: tags: - - Bundles + - Translations summary: 'List Bundles' description: '**Required scopes:** `project.translation` (Read only).' operationId: api.projects.bundles.getMany @@ -3780,7 +3779,7 @@ paths: $ref: '#/components/schemas/MethodNotAllowedExceptionResource' post: tags: - - Bundles + - Translations summary: 'Add Bundle' description: '**Required scopes:** `project.source.file` (Read and Write).' operationId: api.projects.bundles.post @@ -3832,7 +3831,7 @@ paths: '/projects/{projectId}/bundles/{bundleId}': get: tags: - - Bundles + - Translations summary: 'Get Bundle' description: '**Required scopes:** `project.source.file` (Read only).' operationId: api.projects.bundles.get @@ -3874,7 +3873,7 @@ paths: $ref: '#/components/schemas/MethodNotAllowedExceptionResource' delete: tags: - - Bundles + - Translations summary: 'Delete Bundle' description: '**Required scopes:** `project.source.file` (Read and Write).' operationId: api.projects.bundles.delete @@ -3912,7 +3911,7 @@ paths: $ref: '#/components/schemas/MethodNotAllowedExceptionResource' patch: tags: - - Bundles + - Translations summary: 'Edit Bundle' description: '**Required scopes:** `project.source.file` (Read and Write).' operationId: api.projects.bundles.patch @@ -3967,7 +3966,7 @@ paths: '/projects/{projectId}/bundles/{bundleId}/exports/{exportId}/download': get: tags: - - Bundles + - Translations summary: 'Download Bundle' description: '**Required scopes:** `project.translation` (Read only).' operationId: api.projects.bundles.exports.download.get @@ -4012,7 +4011,7 @@ paths: '/projects/{projectId}/bundles/{bundleId}/exports': post: tags: - - Bundles + - Translations summary: 'Export Bundle' description: '**Required scopes:** `project.translation` (Read only).' operationId: api.projects.bundles.exports.post @@ -4021,13 +4020,18 @@ paths: $ref: '#/components/parameters/ProjectId' - $ref: '#/components/parameters/BundleId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CrowdinBundleExportForm' responses: '202': description: 'Bundle export was successfully started' content: application/json: schema: - $ref: '#/components/schemas/BundleExportResource' + $ref: '#/components/schemas/CrowdinBundleExportResource' '400': description: 'Invalid Request Parameters' content: @@ -4067,7 +4071,7 @@ paths: '/projects/{projectId}/bundles/{bundleId}/exports/{exportId}': get: tags: - - Bundles + - Translations summary: 'Check Bundle Export Status' description: '**Required scopes:** `project.translation` (Read only).' operationId: api.projects.bundles.exports.get @@ -4084,7 +4088,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BundleExportResource' + $ref: '#/components/schemas/CrowdinBundleExportResource' '401': description: Unauthorized content: @@ -5149,7 +5153,7 @@ paths: '/projects/{projectId}/bundles/{bundleId}/files': get: tags: - - Bundles + - Translations summary: 'Bundle List Files' description: '**Required scopes:** `project.source.file` (Read only).' operationId: api.projects.bundles.files.getMany @@ -14791,6 +14795,13 @@ paths: $ref: '#/components/parameters/CrowdinTaskStatus' - $ref: '#/components/parameters/AssigneeId' + - + name: batchId + in: query + description: 'Filter by task batch. Get `batchId` via [List Tasks](#operation/api.projects.tasks.getMany)' + required: false + schema: + type: integer responses: '200': description: 'Tasks list' @@ -14840,18 +14851,10 @@ paths: oneOf: - $ref: '#/components/schemas/CrowdinTaskCreateForm' - - - $ref: '#/components/schemas/CrowdinLanguageServiceTaskCreateForm' - - - $ref: '#/components/schemas/CrowdinVendorOhtTaskCreateForm' - - - $ref: '#/components/schemas/CrowdinVendorGengoTaskCreateForm' - - - $ref: '#/components/schemas/CrowdinVendorManualTaskCreateForm' - $ref: '#/components/schemas/CrowdinPendingTaskCreateForm' - - $ref: '#/components/schemas/CrowdinVendorManualPendingTaskCreateForm' + $ref: '#/components/schemas/CrowdinVendorTaskCreateForm' responses: '201': description: 'Task was successfully created' @@ -18920,8 +18923,6 @@ components: oneOf: - $ref: '#/components/schemas/ai.prompt.completion.resources.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.completion.resources.assist' - $ref: '#/components/schemas/ai.prompt.completion.resources.qa_check' - @@ -18940,8 +18941,6 @@ components: oneOf: - $ref: '#/components/schemas/ai.prompt.completion.resources.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.completion.resources.assist' - $ref: '#/components/schemas/ai.prompt.completion.resources.alignment' - @@ -18997,21 +18996,6 @@ components: example: N/A additionalProperties: type: string - ai.prompt.completion.resources.overridePromptValues.assist: - type: object - allOf: - - - $ref: '#/components/schemas/ai.prompt.completion.resources.overridePromptValues.common' - - - properties: - pluralForms: - type: string - example: 'one,few,many,other' - filteredStrings: - type: string - example: N/A - additionalProperties: - type: string ai.prompt.completion.resources.overridePromptValues.alignment: properties: sourceLanguage: @@ -19099,33 +19083,6 @@ components: overridePromptValues: $ref: '#/components/schemas/ai.prompt.completion.resources.overridePromptValues.pre_translate' type: object - ai.prompt.completion.resources.assist: - title: 'Resources for prompt with assist action' - required: - - projectId - properties: - projectId: - type: integer - sourceLanguageId: - description: '__Note__: If not specified, the source language of the project will be used' - type: string - targetLanguageId: - type: string - stringIds: - description: '__Note:__ Must be used together with `targetLanguageId`. You can assign up to 500 strings at a time.' - type: array - items: - type: integer - example: 78253 - filteredStringIds: - description: '__Note:__ You can assign up to 500 strings at a time.' - type: array - items: - type: integer - example: 78254 - overridePromptValues: - $ref: '#/components/schemas/ai.prompt.completion.resources.overridePromptValues.assist' - type: object ai.prompt.completion.resources.alignment: title: 'Resources for prompt with alignment action' required: @@ -19198,11 +19155,9 @@ components: type: string example: 'Pre-translate prompt' action: - description: 'AI prompt action. __Note:__ `assist` is deprecated' type: string enum: - pre_translate - - assist - qa_check aiProviderId: description: 'AI Provider identifier. Get via [List AI Providers](#operation/api.ai.providers.getMany)' @@ -19235,19 +19190,15 @@ components: - properties: action: - description: 'AI prompt action. __Note:__ `assist` is deprecated' type: string enum: - pre_translate - - assist - qa_check config: description: 'AI prompt configuration' oneOf: - $ref: '#/components/schemas/ai.prompt.config.basic_mode.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.config.basic_mode.assist' - $ref: '#/components/schemas/ai.prompt.config.basic_mode.qa_check' - @@ -19266,11 +19217,9 @@ components: - properties: action: - description: 'AI prompt action. __Note:__ `assist` is deprecated' type: string enum: - pre_translate - - assist - alignment - qa_check config: @@ -19278,8 +19227,6 @@ components: oneOf: - $ref: '#/components/schemas/ai.prompt.config.basic_mode.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.config.basic_mode.assist' - $ref: '#/components/schemas/ai.prompt.config.basic_mode.alignment' - @@ -19355,72 +19302,6 @@ components: retryOnQaIssues: type: boolean type: object - ai.prompt.config.basic_mode.assist: - title: 'Basic mode (assist action)' - required: - - mode - properties: - mode: - type: string - enum: - - basic - companyDescription: - description: 'Use field `snippets` instead' - type: string - deprecated: true - projectDescription: - description: 'Use field `snippets` instead' - type: string - deprecated: true - audienceDescription: - description: 'Use field `snippets` instead' - type: string - deprecated: true - customPlaceholders: - description: 'Use field `snippets` instead' - type: array - items: - type: string - example: '%custom:companyDescription%' - deprecated: true - snippets: - description: 'Array of snippets. Get via [List AI Snippets](#operation/api.ai.snippets.getMany)' - type: array - items: - type: string - example: '%custom:companyDescription%' - otherLanguageTranslations: - properties: - isEnabled: - type: boolean - default: true - languageIds: - description: 'Array of language ids. Get via [List Supported Languages](#operation/api.languages.getMany)' - type: array - items: - type: string - example: uk - type: object - glossaryTerms: - type: boolean - tmSuggestions: - type: boolean - fileContext: - type: boolean - generateFileSummary: - type: boolean - screenshots: - type: boolean - fileContent: - type: boolean - publicProjectDescription: - type: boolean - siblingsStrings: - type: boolean - filteredStrings: - type: boolean - type: object - deprecated: true ai.prompt.config.basic_mode.alignment: title: 'Basic mode (alignment action)' required: @@ -19516,10 +19397,6 @@ components: type: boolean prompt: type: string - fileContent: - description: '__Note:__ Available only for Assist action' - type: boolean - default: 'false' otherLanguageTranslations: properties: isEnabled: @@ -19713,7 +19590,6 @@ components: type: string example: 'Pre-translate prompt' action: - description: '__Note:__ `assist` is deprecated' type: string example: pre_translate aiProviderId: @@ -19784,8 +19660,6 @@ components: oneOf: - $ref: '#/components/schemas/ai.prompt.config.basic_mode.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.config.basic_mode.assist' - $ref: '#/components/schemas/ai.prompt.config.basic_mode.alignment' - @@ -19807,8 +19681,6 @@ components: oneOf: - $ref: '#/components/schemas/ai.prompt.config.basic_mode.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.config.basic_mode.assist' - $ref: '#/components/schemas/ai.prompt.config.basic_mode.qa_check' - @@ -20000,11 +19872,9 @@ components: - properties: action: - description: '__Note:__ `assist` is deprecated' type: string enum: - pre_translate - - assist - alignment - qa_check ai.provider.crowdin_configuration.actionRule: @@ -20016,11 +19886,9 @@ components: - properties: action: - description: '__Note:__ `assist` is deprecated' type: string enum: - pre_translate - - assist - qa_check ai.provider.credentials.open_ai: title: OpenAI @@ -20609,9 +20477,8 @@ components: format: json-pointer enum: - /preTranslationAiPromptId - - /assistActionAiPromptId - /editorSuggestionAiPromptId - - /shortcuts + - /qaCheckActionAiPromptId type: object discriminator: propertyName: op @@ -20662,10 +20529,6 @@ components: preTranslationAiPromptId: type: integer example: 2 - assistActionAiPromptId: - type: integer - example: 2 - deprecated: true editorSuggestionAiPromptId: type: integer example: 5 @@ -20673,27 +20536,6 @@ components: type: integer example: 8 nullable: true - shortcuts: - type: array - items: - type: object - oneOf: - - - $ref: '#/components/schemas/AiSettingsShortcuts' - type: object - AiSettingsShortcuts: - properties: - name: - description: 'Shortcut name' - type: string - example: 'My first shortcut' - prompt: - description: 'Shortcut prompt' - type: string - example: 'Make translation shorter' - enabled: - type: boolean - deprecated: true type: object AiTranslateForm: required: @@ -21274,36 +21116,6 @@ components: type: object iframe: type: object - AiToolCallWidgetsModule: - title: 'AI Tool Call Widgets Module' - type: object - allOf: - - - $ref: '#/components/schemas/AiToolCallsModule' - - - properties: - iframe: - type: object - AiToolCallsModule: - title: 'AI Provider Module' - type: object - allOf: - - - $ref: '#/components/schemas/Module' - - - properties: - identifier: - type: string - example: example-application - url: - type: string - example: /ai-tools - toolType: - type: string - enum: - - function - function: - type: object ApplicationInstallationResponseModel: title: 'Application Installation' description: 'Application Installation Response Model' @@ -23324,6 +23136,30 @@ components: - fr nullable: true type: object + CrowdinBundleExportForm: + properties: + targetLanguageIds: + description: "Specify target languages for export. Get via [List Supported Languages](#operation/api.languages.getMany)\n\n * Leave this field empty to export all target languages" + type: array + items: + type: string + example: uk + skipUntranslatedStrings: + description: "Defines whether to export only translated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedFiles=true` in same request" + type: boolean + example: false + skipUntranslatedFiles: + description: "Defines whether to export only translated files\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=true` in same request" + type: boolean + example: false + exportApprovedOnly: + description: "Defines whether to export only approved strings\n\n[More info](https://support.crowdin.com/project-settings/export/)" + type: boolean + default: false + example: false + type: object + x-doc-sections: + - file-based BundleCollectionResource: description: 'Bundle Collection Resource' type: object @@ -23340,8 +23176,8 @@ components: $ref: '#/components/schemas/BundleResource' pagination: $ref: '#/components/schemas/Pagination' - BundleExportResource: - description: 'Bundle Export Resource' + BundleResource: + description: 'Bundle Resource' type: object allOf: - @@ -23349,9 +23185,9 @@ components: - properties: data: - $ref: '#/components/schemas/BundleExport' - BundleResource: - description: 'Bundle Resource' + $ref: '#/components/schemas/Bundle' + CrowdinBundleExportResource: + description: 'Bundle Export Resource' type: object allOf: - @@ -23359,46 +23195,7 @@ components: - properties: data: - $ref: '#/components/schemas/Bundle' - BundleExport: - properties: - identifier: - type: string - example: 50fb3506-4127-4ba8-8296-f97dc7e3e0c3 - status: - type: string - example: finished - progress: - description: 'in percentages' - type: integer - example: 100 - attributes: - properties: - bundleId: - type: integer - example: 38 - type: object - createdAt: - type: string - format: date-time - example: '2019-09-23T11:26:54+00:00' - updatedAt: - type: string - format: date-time - example: '2019-09-23T11:26:54+00:00' - startedAt: - type: string - format: date-time - example: '2019-09-23T11:26:54+00:00' - finishedAt: - type: string - format: date-time - example: '2019-09-23T11:26:54+00:00' - eta: - type: string - example: '1 second' - deprecated: true - type: object + $ref: '#/components/schemas/BundleExport' Bundle: title: Bundle properties: @@ -23487,6 +23284,63 @@ components: format: date-time example: '2019-09-20T12:22:20+00:00' type: object + BundleExport: + properties: + identifier: + type: string + example: 50fb3506-4127-4ba8-8296-f97dc7e3e0c3 + status: + type: string + example: finished + progress: + description: 'in percentages' + type: integer + example: 100 + attributes: + properties: + bundleId: + type: integer + example: 38 + targetLanguageIds: + type: array + items: + type: string + example: uk + skipUntranslatedStrings: + type: boolean + example: false + skipUntranslatedFiles: + type: boolean + example: false + x-doc-sections: + - file-based + exportApprovedOnly: + type: boolean + example: false + type: object + createdAt: + type: string + format: date-time + example: '2019-09-23T11:26:54+00:00' + updatedAt: + type: string + format: date-time + example: '2019-09-23T11:26:54+00:00' + startedAt: + type: string + format: date-time + example: '2019-09-23T11:26:54+00:00' + nullable: true + finishedAt: + type: string + format: date-time + example: '2019-09-23T11:26:54+00:00' + nullable: true + eta: + type: string + example: '1 second' + deprecated: true + type: object ClientCollectionResource: description: 'Clients Collection' type: object @@ -25597,7 +25451,7 @@ components: - type: integer ProjectFileType: - description: "Values available:\n- empty value or 'auto' — Try to detect file type by extension or MIME type\n- 'android' — Android (*.xml)\n- 'macosx' — Mac OS X / iOS (*.strings)\n- 'resx' — .NET, Windows Phone (*.resx)\n- 'properties' — Java (*.properties)\n- 'gettext' — GNU GetText (*.po, *.pot)\n- 'yaml' — Ruby On Rails (*.yaml, *.yml)\n- 'php' — Hypertext Preprocessor (*.php)\n- 'json' — Generic JSON (*.json)\n- 'xml' — Generic XML (*.xml)\n- 'ini' — Generic INI (*.ini)\n- 'rc' — Windows Resources (*.rc)\n- 'resw' — Windows 8 Metro (*.resw)\n- 'resjson' — Windows 8 Metro (*.resjson)\n- 'qtts' — Nokia Qt (*.ts)\n- 'joomla' — Joomla localizable resources (*.ini)\n- 'chrome' — Google Chrome Extension (*.json)\n- 'dtd' — Mozilla DTD (*.dtd)\n- 'dklang' — Delphi DKLang (*.dklang)\n- 'flex' — Flex (*.properties)\n- 'nsh' — NSIS Installer Resources (*.nsh)\n- 'wxl' — WiX Installer (*.wxl)\n- 'xliff' — XLIFF (*.xliff, *.xlf)\n- 'xliff_two' — XLIFF 2.0 (*.xliff, *.xlf)\n- 'html' — HTML (*.html, *.htm, *.xhtml, *.xhtm, *.xht, *.hbs, *.liquid)\n- 'haml' — Haml (*.haml)\n- 'txt' — Plain Text (*.txt)\n- 'csv' — Comma Separated Values (*.csv)\n- 'md' — Markdown (*.md, *.text, *.markdown...)\n- 'flsnp' — MadCap Flare (*.flnsp, .flpgpl .fltoc)\n- 'fm_html' — Jekyll HTML (*.html)\n- 'fm_md' — Jekyll Markdown (*.md)\n- 'mediawiki' — MediaWiki (*.wiki, *.wikitext, *.mediawiki)\n- 'docx' — Microsoft Office, OpenOffice.org Documents, Adobe InDesign, Adobe FrameMaker(*.docx, *.dotx, *.docm, *.dotm, *.xlsx, *.xltx, *.xlsm, *.xltm, *.pptx, *.potx, *.ppsx, *.pptm, *.potm, *.ppsm, *.odt, *.ods, *.odg, *.odp, *.imdl, *.mif)\n- 'xlsx' — Microsoft Excel (*.xlsx)\n- 'sbv' — Youtube .sbv (*.sbv)\n- 'properties_play' — Play Framework\n- 'properties_xml' — Java Application (*.xml)\n- 'maxthon' — Maxthon Browser (*.ini)\n- 'go_json' — Go (*.gotext.json)\n- 'dita' — DITA Document (*.dita, *.ditamap)\n- 'mif' — Adobe FrameMaker (*.mif)\n- 'idml' — Adobe InDesign (*.idml)\n- 'stringsdict' — iOS (*.stringsdict)\n- 'plist' — Mac OS property list (*.plist)\n- 'vtt' — Video Subtitling and WebVTT (*.vtt)\n- 'vdf' — Steamworks Localization Valve Data File (*.vdf)\n- 'srt' — SubRip .srt (*.srt)\n- 'stf' — Salesforce (*.stf)\n- 'toml' — Toml (*.toml)\n- 'contentful_rt' — Contentful (*.json)\n- 'svg' — SVG (*.svg)\n- 'js' — JavaScript (*.js)\n- 'coffee' — CoffeeScript (*.coffee)\n- 'nestjs_i18n' - NestJS i18n\n- 'loc' — LOC (*.loc)\n\n__Note__: Use `docx` type to import each cell as a separate source string for XLSX file" + description: "Values available:\n- empty value or 'auto' — Try to detect file type by extension or MIME type\n- 'android' — Android (*.xml)\n- 'macosx' — Mac OS X / iOS (*.strings)\n- 'resx' — .NET, Windows Phone (*.resx)\n- 'properties' — Java (*.properties)\n- 'gettext' — GNU GetText (*.po, *.pot)\n- 'yaml' — Ruby On Rails (*.yaml, *.yml)\n- 'php' — Hypertext Preprocessor (*.php)\n- 'json' — Generic JSON (*.json)\n- 'xml' — Generic XML (*.xml)\n- 'ini' — Generic INI (*.ini)\n- 'rc' — Windows Resources (*.rc)\n- 'resw' — Windows 8 Metro (*.resw)\n- 'resjson' — Windows 8 Metro (*.resjson)\n- 'qtts' — Nokia Qt (*.ts)\n- 'joomla' — Joomla localizable resources (*.ini)\n- 'chrome' — Google Chrome Extension (*.json)\n- 'dtd' — Mozilla DTD (*.dtd)\n- 'dklang' — Delphi DKLang (*.dklang)\n- 'flex' — Flex (*.properties)\n- 'nsh' — NSIS Installer Resources (*.nsh)\n- 'wxl' — WiX Installer (*.wxl)\n- 'xliff' — XLIFF (*.xliff, *.xlf)\n- 'xliff_two' — XLIFF 2.0 (*.xliff, *.xlf)\n- 'html' — HTML (*.html, *.htm, *.xhtml, *.xhtm, *.xht, *.hbs, *.liquid)\n- 'haml' — Haml (*.haml)\n- 'txt' — Plain Text (*.txt)\n- 'csv' — Comma Separated Values (*.csv)\n- 'md' — Markdown (*.md, *.text, *.markdown...)\n- 'flsnp' — MadCap Flare (*.flnsp, .flpgpl .fltoc)\n- 'fm_html' — Jekyll HTML (*.html)\n- 'fm_md' — Jekyll Markdown (*.md)\n- 'mediawiki' — MediaWiki (*.wiki, *.wikitext, *.mediawiki)\n- 'docx' — Microsoft Office, OpenOffice.org Documents, Adobe InDesign, Adobe FrameMaker(*.docx, *.dotx, *.docm, *.dotm, *.xlsx, *.xltx, *.xlsm, *.xltm, *.pptx, *.potx, *.ppsx, *.pptm, *.potm, *.ppsm, *.odt, *.ods, *.odg, *.odp, *.imdl, *.mif)\n- 'vsdx' — Microsoft Visio (*.vsdx, *.vsdm)\n- 'xlsx' — Microsoft Excel (*.xlsx)\n- 'sbv' — Youtube .sbv (*.sbv)\n- 'properties_play' — Play Framework\n- 'properties_xml' — Java Application (*.xml)\n- 'maxthon' — Maxthon Browser (*.ini)\n- 'go_json' — Go (*.gotext.json)\n- 'dita' — DITA Document (*.dita, *.ditamap)\n- 'mif' — Adobe FrameMaker (*.mif)\n- 'idml' — Adobe InDesign (*.idml)\n- 'stringsdict' — iOS (*.stringsdict)\n- 'plist' — Mac OS property list (*.plist)\n- 'vtt' — Video Subtitling and WebVTT (*.vtt)\n- 'vdf' — Steamworks Localization Valve Data File (*.vdf)\n- 'srt' — SubRip .srt (*.srt)\n- 'stf' — Salesforce (*.stf)\n- 'toml' — Toml (*.toml)\n- 'contentful_rt' — Contentful (*.json)\n- 'svg' — SVG (*.svg)\n- 'js' — JavaScript (*.js)\n- 'coffee' — CoffeeScript (*.coffee)\n- 'nestjs_i18n' - NestJS i18n\n- 'loc' — LOC (*.loc)\n\n__Note__: Use `docx` type to import each cell as a separate source string for XLSX file" type: string default: auto enum: @@ -25637,6 +25491,7 @@ components: - fm_md - mediawiki - docx + - vsdx - xlsx - sbv - properties_play @@ -25869,6 +25724,28 @@ components: default: null example: 61 type: object + VsdxFileImportOptions: + title: 'Vsdx File Import Options' + properties: + cleanTagsAggressively: + description: 'When checked, strips additional formatting tags related to text spacing.' + type: boolean + default: false + translateHyperlinkUrls: + description: 'When checked, exposes hidden hyperlinks for translation.' + type: boolean + default: false + contentSegmentation: + description: 'Defines whether to split long texts into smaller text segments.' + type: boolean + default: true + srxStorageId: + description: "Storage Identifier. Get via [List Storages](#operation/api.storages.getMany).\n\n Storage identifier of the SRX segmentation rules file. Read more about [Custom Segmentation](https://support.crowdin.com/custom-segmentation/#segmentation-examples)." + type: integer + format: int64 + default: null + example: 61 + type: object HtmlFileImportOptions: title: 'Html File Import Options' properties: @@ -26450,6 +26327,8 @@ components: $ref: '#/components/schemas/WebXmlFileImportOptions' - $ref: '#/components/schemas/DocxFileImportOptions' + - + $ref: '#/components/schemas/VsdxFileImportOptions' - $ref: '#/components/schemas/HtmlFileImportOptions' - @@ -26487,6 +26366,8 @@ components: $ref: '#/components/schemas/WebXmlFileImportOptions' - $ref: '#/components/schemas/DocxFileUpdateOptions' + - + $ref: '#/components/schemas/VsdxFileImportOptions' - $ref: '#/components/schemas/HtmlFileUpdateOptions' - @@ -26815,6 +26696,8 @@ components: $ref: '#/components/schemas/XmlFileImportOptionsResponseModel' - $ref: '#/components/schemas/DocxFileImportOptionsResponseModel' + - + $ref: '#/components/schemas/VsdxFileImportOptionsResponseModel' - $ref: '#/components/schemas/SegmentationImportOptionsResponseModel' - @@ -27148,6 +27031,26 @@ components: type: boolean example: true type: object + VsdxFileImportOptionsResponseModel: + title: 'VSDX File Import Options' + properties: + cleanTagsAggressively: + description: 'When checked, strips additional formatting tags related to text spacing.' + type: boolean + default: false + translateHyperlinkUrls: + description: 'When checked, exposes hidden hyperlinks for translation.' + type: boolean + default: false + contentSegmentation: + description: 'Defines whether to split long texts into smaller text segments.' + type: boolean + default: true + customSegmentation: + description: 'Specifies whether custom segmentation rules are used.' + type: boolean + default: false + type: object WebXmlFileImportOptionsResponseModel: title: 'WebXml File Import Options' properties: @@ -29198,6 +29101,10 @@ components: description: 'Source language identifier. Get via [Project Target Languages](#operation/api.projects.get)' type: string example: en + customInstruction: + description: "Custom instruction for AI pre-translation. This instruction will be appended to the AI prompt text.\n\n__Note:__ Available only for AI pre-translation method" + type: string + maxLength: 10000 type: object CrowdinPreTranslationCollectionResource: description: 'Pre-Translation Collection Resource' @@ -29696,7 +29603,6 @@ components: - /mtPreTranslate - /aiPreTranslate - /preTranslationAiPromptId - - /assistActionAiPromptId - /editorSuggestionAiPromptId - /qaCheckActionAiPromptId - /savingsReportSettingsTemplateId @@ -30230,11 +30136,6 @@ components: type: integer example: 11 deprecated: true - assistActionAiPromptId: - description: 'AI Prompt ID to be used as prompt for AI Assist action in Editor' - type: integer - example: 12 - deprecated: true editorSuggestionAiPromptId: description: 'AI Prompt ID to be used as prompt for AI Suggestion action in Editor' type: integer @@ -31769,11 +31670,6 @@ components: example: 1 nullable: true deprecated: true - assistActionAiPromptId: - type: integer - example: 11 - nullable: true - deprecated: true editorSuggestionAiPromptId: type: integer example: 2 @@ -31949,6 +31845,8 @@ components: $ref: '#/components/schemas/MadcapFlsnpFileFormatSettingsResponse' - $ref: '#/components/schemas/DocxFileFormatSettingsResponse' + - + $ref: '#/components/schemas/VsdxFileFormatSettingsResponse' - $ref: '#/components/schemas/IdmlFileFormatSettingsResponse' - @@ -32659,6 +32557,31 @@ components: default: null nullable: true type: object + VsdxFileFormatSettingsResponse: + title: 'VSDX file format settings' + properties: + cleanTagsAggressively: + description: 'When checked, strips additional formatting tags related to text spacing.' + type: boolean + default: false + translateHyperlinkUrls: + description: 'When checked, exposes hidden hyperlinks for translation.' + type: boolean + default: false + contentSegmentation: + description: "Defines whether to split long texts into smaller text segments.\n\nImportant! This option disables the possibility to upload existing translations for XML files when enabled." + type: boolean + default: true + customSegmentation: + description: 'Specifies whether custom segmentation rules are used.' + type: boolean + default: false + exportPattern: + description: "File format export pattern. Defines file name and path in resulting translations bundle\n\nNote: Can't contain `: * ? \" < > |` symbols" + type: string + default: null + nullable: true + type: object IdmlFileFormatSettingsResponse: title: 'Idml file format settings' properties: @@ -32789,10 +32712,6 @@ components: type: integer example: 2 deprecated: true - assistActionAiPromptId: - type: integer - example: 2 - deprecated: true editorSuggestionAiPromptId: type: integer example: 2 @@ -34573,7 +34492,7 @@ components: type: object TopMembers: title: 'Top Members' - description: 'Generate a list of translators based on a specific period of time to see who contributed the most to your project’s translation.' + description: "Generate a list of translators based on a specific period of time to see who contributed the most to your project's translation." required: - name - schema @@ -35291,7 +35210,7 @@ components: type: integer example: 13 typeTasks: - description: "Task type:\n * 0 - Translate by own translators\n * 1 - Proofread by own proofreaders\n * 2 - Translate by vendor\n * 3 - Proofread by vendor" + description: "Task type:\n * 0 - Translate by own translators\n * 1 - Proofread by own proofreaders\n * 2 - Translate by vendor\n * 3 - Proofread by vendor" type: integer enum: - 0 @@ -35490,7 +35409,7 @@ components: items: $ref: '#/components/schemas/user-post-edit-report-settings-template-form.individual-rate' netRateSchemes: - description: "Net Rate Schemes (Percentage paid of full translation rate)\n *\n * __Note:__ A new translation will be included in the report at the lowest rate if multiple scheme categories can be applied to the translation" + description: "Net Rate Schemes (Percentage paid of full translation rate)\n\n__Note:__ A new translation will be included in the report at the lowest rate if multiple scheme categories can be applied to the translation" type: object allOf: - @@ -36029,7 +35948,7 @@ components: items: $ref: '#/components/schemas/user-post-edit-report-settings-template.individual-rate' netRateSchemes: - description: "Net Rate Schemes (Percentage paid of full translation rate)\n *\n *__Note:__ A new translation will be included in the report at the lowest rate if multiple scheme categories can be applied to the translation" + description: "Net Rate Schemes (Percentage paid of full translation rate)\n\n__Note:__ A new translation will be included in the report at the lowest rate if multiple scheme categories can be applied to the translation" type: object allOf: - @@ -39262,9 +39181,11 @@ components: - /labelMatchRule - /excludeLabelIds - /excludeLabelMatchRule + - /resetScope - /generateCostEstimate - /generateTranslationCost - /reportSettingsTemplateId + - /batchId x-doc-sections: - file-based type: object @@ -39590,6 +39511,7 @@ components: example: true type: object CrowdinTaskCreateForm: + title: 'Task Create' type: object oneOf: - @@ -39597,7 +39519,7 @@ components: - $ref: '#/components/schemas/CrowdinCreateTaskByStringIds' CrowdinCreateTaskBySourceIds: - title: CreateByFileIdsForm + title: 'Create By File Ids Form' type: object allOf: - @@ -39605,7 +39527,6 @@ components: x-doc-sections: - file-based CrowdinCreateTaskBySourceIdsForm: - title: CreateBySourcesForm required: - title - languageId @@ -39744,9 +39665,14 @@ components: type: integer example: 1 nullable: true + batchId: + description: 'Task Batch Identifier. Get via [List Tasks](#operation/api.projects.tasks.getMany). Allows grouping tasks into a batch' + type: integer + example: 1 + nullable: true type: object CrowdinCreateTaskByStringIds: - title: CreateByStringIdsForm + title: 'Create By String Ids Form' required: - title - languageId @@ -39854,235 +39780,74 @@ components: type: integer example: 1 nullable: true - type: object - CrowdinLanguageServiceTaskCreateForm: - type: object - oneOf: - - - $ref: '#/components/schemas/CrowdinLanguageServiceTaskBySourceIds' - - - $ref: '#/components/schemas/CrowdinLanguageServiceTaskByStringIds' - CrowdinLanguageServiceTaskBySourceIds: - title: CreateByFileIdsForm - type: object - allOf: - - - $ref: '#/components/schemas/CrowdinLanguageServiceTaskBySourceIdsForm' - x-doc-sections: - - file-based - CrowdinLanguageServiceTaskBySourceIdsForm: - required: - - title - - languageId - - fileIds - - branchIds - - type - - vendor - properties: - title: - description: 'Task title' - type: string - languageId: - description: 'Task Language Identifier. Get via [Project Target Languages](#operation/api.projects.get)' - type: string - example: es - type: - description: "Task type:\n * 2 - translate by vendor\n * 3 - proofread by vendor" - type: integer - enum: - - 2 - - 3 - vendor: - description: "Task vendor:\n * Crowdin Language Services" - type: string - fileIds: - description: 'Task File Identifiers. Get via [List Files](#operation/api.projects.files.getMany)' - type: array - items: - type: integer - example: '2401' - x-doc-sections: - - file-based - labelIds: - description: 'Label Identifiers. Get via [List Labels](#operation/api.projects.labels.getMany)' - type: array - items: - type: integer - example: 1 - labelMatchRule: - description: "Match rule for labels:\n- \"all\" - all labels must be present in string\n- \"any\" - any of the labels must be present in string\n\n__Note:__ Can only be used when `labelIds` parameter is provided" - type: string - default: all - enum: - - all - - any - nullable: true - excludeLabelIds: - description: 'Label Identifiers. Get via [List Labels](#operation/api.projects.labels.getMany)' - type: array - items: - type: integer - example: 12 - excludeLabelMatchRule: - description: "Match rule for excluded labels:\n- \"all\" - all labels must be present in string\n- \"any\" - any of the labels must be present in string\n\n__Note:__ Can only be used when `excludeLabelIds` parameter is provided" - type: string - default: all - enum: - - all - - any - nullable: true - status: - description: 'Task status' - type: string - default: todo - enum: - - todo - - in_progress - description: - description: 'Task description' - type: string - includePreTranslatedStringsOnly: - description: 'Defines whether to include only pretranslated strings' - type: boolean - default: false - example: true - dateFrom: - description: "Defines start date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-23T07:00:14+00:00' - dateTo: - description: "Defines end date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-27T07:00:14+00:00' - translationsUpdatedDateFrom: - description: "Defines start date for interval when translation were updated (proofread tasks only)\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-23T07:00:14+00:00' - translationsUpdatedDateTo: - description: "Defines end date for interval when translation were updated (proofread tasks only)\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-27T07:00:14+00:00' - generateCostEstimate: - description: 'Generate cost estimate report for the task. Requires `reportSettingsTemplateId`' - type: boolean - default: false - example: false - generateTranslationCost: - description: 'Generate translation cost report for the task. Requires `reportSettingsTemplateId`' - type: boolean - default: false - example: false - reportSettingsTemplateId: - description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany). Required when `generateCostEstimate` or `generateTranslationCost` is `true`' + batchId: + description: 'Task Batch Identifier. Get via [List Tasks](#operation/api.projects.tasks.getMany). Allows grouping tasks into a batch' type: integer example: 1 nullable: true type: object - CrowdinLanguageServiceTaskByStringIds: - title: CreateByStringIdsForm + CrowdinPendingTaskCreateForm: + title: 'Pending Task Create' required: - - title - - languageId - - stringIds + - precedingTaskId - type - - vendor + - title properties: - title: - description: 'Task title' - type: string - languageId: - description: 'Task Language Identifier. Get via [Project Target Languages](#operation/api.projects.get)' - type: string - example: es + precedingTaskId: + description: 'Translate Task Identifier. Get via [List Tasks](#operation/api.projects.tasks.getMany)' + type: integer + example: 1 type: - description: "Task type:\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 1 - proofread\n * 3 - proofread by vendor (requires `vendor` field)" type: integer enum: - - 2 + - 1 - 3 - vendor: - description: "Task vendor:\n * \"crowdin_language_service\" - Crowdin Language Services" - type: string - stringIds: - description: 'Task String Identifiers. Get via [List Strings](#operation/api.projects.strings.getMany)' - type: array - items: - type: integer - example: '2401' - status: - description: 'Task status' + title: + description: 'Task title' type: string - default: todo - enum: - - todo - - in_progress description: description: 'Task description' type: string - includePreTranslatedStringsOnly: - description: 'Defines whether to include only pretranslated strings' - type: boolean - default: false - example: true - dateFrom: - description: "Defines start date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-23T07:00:14+00:00' - dateTo: - description: "Defines end date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-27T07:00:14+00:00' - translationsUpdatedDateFrom: - description: "Defines start date for interval when translation were updated (proofread tasks only)\n\n __Format:__ UTC, ISO 8601" + vendor: + description: 'Vendor identifier. Required when `type` is `3`. Browse available vendors at [Crowdin Store](https://crowdin.com/store/vendors).' type: string - format: date-time - example: '2019-09-23T07:00:14+00:00' - translationsUpdatedDateTo: - description: "Defines end date for interval when translation were updated (proofread tasks only)\n\n __Format:__ UTC, ISO 8601" + nullable: true + assignees: + type: array + items: + $ref: '#/components/schemas/CrowdinTaskAssignee' + deadline: + description: "Defines task deadline date\n\n __Format:__ UTC, ISO 8601" type: string format: date-time example: '2019-09-27T07:00:14+00:00' - generateCostEstimate: - description: 'Generate cost estimate report for the task. Requires `reportSettingsTemplateId`' - type: boolean - default: false - example: false - reportSettingsTemplateId: - description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany). Required when `generateCostEstimate` is `true`' - type: integer - example: 1 - nullable: true type: object - CrowdinVendorOhtTaskCreateForm: + CrowdinVendorTaskCreateForm: + title: 'Vendor Task Create' type: object oneOf: - - $ref: '#/components/schemas/CrowdinVendorOhtTaskBySourceIds' + $ref: '#/components/schemas/CrowdinVendorTaskBySourceIds' - - $ref: '#/components/schemas/CrowdinVendorOhtTaskByStringIds' - CrowdinVendorOhtTaskBySourceIds: - title: CreateByFileIdsForm + $ref: '#/components/schemas/CrowdinVendorTaskByStringIds' + CrowdinVendorTaskBySourceIds: + title: 'Create By File Ids Form' + description: 'Contains common fields shared across all vendors. Additional vendor-specific settings (e.g. expertise, tone, quality) depend on the selected vendor and are available at [Crowdin Store](https://crowdin.com/store/vendors).' type: object allOf: - - $ref: '#/components/schemas/CrowdinVendorOhtTaskBySourceIdsForm' + $ref: '#/components/schemas/CrowdinVendorTaskBySourceIdsForm' x-doc-sections: - file-based - CrowdinVendorOhtTaskBySourceIdsForm: - title: CreateBySourcesForm + CrowdinVendorTaskBySourceIdsForm: required: - title - languageId - - fileIds - - branchIds - type - vendor + - fileIds + - branchIds properties: title: description: 'Task title' @@ -40098,14 +39863,14 @@ components: - 2 - 3 vendor: - description: "Task vendor:\n * \"oht\" - OneHourTranslation" + description: "Vendor identifier. Browse available vendors at [Crowdin Store](https://crowdin.com/store/vendors).\n\n__Note:__ Additional vendor-specific settings (e.g. expertise, tone, quality) are configured per vendor in the store." type: string fileIds: description: 'Task File Identifiers. Get via [List Files](#operation/api.projects.files.getMany)' type: array items: type: integer - example: '2401' + example: 2401 x-doc-sections: - file-based labelIds: @@ -40115,7 +39880,7 @@ components: type: integer example: 1 labelMatchRule: - description: "Match rule for labels:\n- \"all\" - all labels must be present in string\n- \"any\" - any of the labels must be present in string\n\n __Note:__ Can only be used when `labelIds` parameter is provided" + description: "Match rule for labels:\n- \"all\" - all labels must be present in string\n- \"any\" - any of the labels must be present in string\n\n__Note:__ Can only be used when `labelIds` parameter is provided" type: string default: all enum: @@ -40123,13 +39888,13 @@ components: - any nullable: true excludeLabelIds: - description: 'Label Identifiers. Get via [List Labels](#operation/api.projects.labels.getMany)' + description: 'Label Identifiers to exclude. Get via [List Labels](#operation/api.projects.labels.getMany)' type: array items: type: integer example: 12 excludeLabelMatchRule: - description: "Match rule for excluded labels:\n- \"all\" - all labels must be present in string\n- \"any\" - any of the labels must be present in string\n\n __Note:__ Can only be used when `excludeLabelIds` parameter is provided" + description: "Match rule for excluded labels:\n- \"all\" - all labels must be present in string\n- \"any\" - any of the labels must be present in string\n\n__Note:__ Can only be used when `excludeLabelIds` parameter is provided" type: string default: all enum: @@ -40146,54 +39911,38 @@ components: description: description: 'Task description' type: string - expertise: - description: "Task expertise:\n * \"standard\"\n * \"mobile-applications\"\n * \"software-it\"\n * \"gaming-video-games\"\n * \"technical-engineering\"\n * \"marketing-consumer-media\"\n * \"business-finance\"\n * \"legal-certificate\"\n * \"medical\"\n * \"ad-words-banners\"\n * \"automotive-aerospace\"\n * \"scientific\"\n * \"scientific-academic\"\n * \"tourism\"\n * \"training-employee-handbooks\"\n * \"forex-crypto\"" - type: string - default: standard - enum: - - standard - - mobile-applications - - software-it - - gaming-video-games - - technical-engineering - - marketing-consumer-media - - business-finance - - legal-certificate - - medical - - ad-words-banners - - automotive-aerospace - - scientific - - scientific-academic - - tourism - - training-employee-handbooks - - forex-crypto - editService: - description: 'Enables Edit stage for all jobs' - type: boolean - default: false - example: 'true' includePreTranslatedStringsOnly: description: 'Defines whether to include only pretranslated strings' type: boolean default: false example: true + skipAssignedStrings: + description: "Skip strings already included in other tasks.\n\n__Note:__ Not supported by all vendors. Verify with your vendor." + type: boolean + default: false + example: true + deadline: + description: "Defines task deadline date.\n\n__Format:__ UTC, ISO 8601\n\n__Note:__ Not supported by all vendors. Verify with your vendor." + type: string + format: date-time + example: '2019-09-27T07:00:14+00:00' dateFrom: - description: "Defines start date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601" + description: "Defines start date for interval when strings were modified\n\n__Format:__ UTC, ISO 8601" type: string format: date-time example: '2019-09-23T07:00:14+00:00' dateTo: - description: "Defines end date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601" + description: "Defines end date for interval when strings were modified\n\n__Format:__ UTC, ISO 8601" type: string format: date-time example: '2019-09-27T07:00:14+00:00' translationsUpdatedDateFrom: - description: "Defines start date for interval when translation were updated (proofread tasks only)\n\n __Format:__ UTC, ISO 8601" + description: "Defines start date for interval when translations were updated. For proofread tasks only.\n\n__Format:__ UTC, ISO 8601" type: string format: date-time example: '2019-09-23T07:00:14+00:00' translationsUpdatedDateTo: - description: "Defines end date for interval when translation were updated (proofread tasks only)\n\n __Format:__ UTC, ISO 8601" + description: "Defines end date for interval when translations were updated. For proofread tasks only.\n\n__Format:__ UTC, ISO 8601" type: string format: date-time example: '2019-09-27T07:00:14+00:00' @@ -40213,14 +39962,15 @@ components: example: 1 nullable: true type: object - CrowdinVendorOhtTaskByStringIds: - title: CreateByStringIdsForm + CrowdinVendorTaskByStringIds: + title: 'Create By String Ids Form' + description: 'Contains common fields shared across all vendors. Additional vendor-specific settings (e.g. expertise, tone, quality) depend on the selected vendor and are available at [Crowdin Store](https://crowdin.com/store/vendors).' required: - title - languageId - - stringIds - type - vendor + - stringIds properties: title: description: 'Task title' @@ -40236,230 +39986,14 @@ components: - 2 - 3 vendor: - description: "Task vendor:\n * \"oht\" - OneHourTranslation" - type: string - stringIds: - description: 'Task String Identifiers. Get via [List Strings](#operation/api.projects.strings.getMany)' - type: array - items: - type: integer - example: '2401' - status: - description: 'Task status' - type: string - default: todo - enum: - - todo - - in_progress - description: - description: 'Task description' - type: string - expertise: - description: "Task expertise:\n * \"standard\"\n * \"mobile-applications\"\n * \"software-it\"\n * \"gaming-video-games\"\n * \"technical-engineering\"\n * \"marketing-consumer-media\"\n * \"business-finance\"\n * \"legal-certificate\"\n * \"medical\"\n * \"ad-words-banners\"\n * \"automotive-aerospace\"\n * \"scientific\"\n * \"scientific-academic\"\n * \"tourism\"\n * \"training-employee-handbooks\"\n * \"forex-crypto\"" - type: string - default: standard - enum: - - standard - - mobile-applications - - software-it - - gaming-video-games - - technical-engineering - - marketing-consumer-media - - business-finance - - legal-certificate - - medical - - ad-words-banners - - automotive-aerospace - - scientific - - scientific-academic - - tourism - - training-employee-handbooks - - forex-crypto - editService: - description: 'Enables Edit stage for all jobs' - type: boolean - default: false - example: 'true' - includePreTranslatedStringsOnly: - description: 'Defines whether to include only pretranslated strings' - type: boolean - default: false - example: true - dateFrom: - description: "Defines start date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-23T07:00:14+00:00' - dateTo: - description: "Defines end date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-27T07:00:14+00:00' - generateCostEstimate: - description: 'Generate cost estimate report for the task. Requires `reportSettingsTemplateId`' - type: boolean - default: false - example: false - generateTranslationCost: - description: 'Generate translation cost report for the task. Requires `reportSettingsTemplateId`' - type: boolean - default: false - example: false - reportSettingsTemplateId: - description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany). Required when `generateCostEstimate` or `generateTranslationCost` is `true`' - type: integer - example: 1 - nullable: true - type: object - CrowdinVendorGengoTaskCreateForm: - type: object - oneOf: - - - $ref: '#/components/schemas/CrowdinVendorGengoTaskBySourceIds' - - - $ref: '#/components/schemas/CrowdinVendorGengoTaskByStringIds' - CrowdinVendorGengoTaskBySourceIds: - title: CreateByFileIdsForm - type: object - allOf: - - - $ref: '#/components/schemas/CrowdinVendorGengoTaskBySourceIdsForm' - x-doc-sections: - - file-based - CrowdinVendorGengoTaskByStringIds: - title: CreateByStringIdsForm - required: - - title - - languageId - - stringIds - - type - - vendor - properties: - title: - description: 'Task title' - type: string - languageId: - description: 'Task Language Identifier. Get via [Project Target Languages](#operation/api.projects.get)' - type: string - example: es - type: - description: "Task type:\n * 2 - translate by vendor" - type: integer - vendor: - description: "Task vendor:\n * \"gengo\" - Gengo" + description: "Vendor identifier. Browse available vendors at [Crowdin Store](https://crowdin.com/store/vendors).\n\n__Note:__ Additional vendor-specific settings (e.g. expertise, tone, quality) are configured per vendor in the store." type: string stringIds: description: 'Task String Identifiers. Get via [List Strings](#operation/api.projects.strings.getMany)' type: array items: type: integer - example: '2401' - status: - description: 'Task status' - type: string - default: todo - enum: - - todo - - in_progress - description: - description: 'Task description' - type: string - expertise: - description: "Task expertise:\n * \"standard\"\n * \"pro\"" - type: string - default: standard - enum: - - standard - - pro - tone: - description: "Task tone:\n * \"\"\n * \"Informal\"\n * \"Friendly\"\n * \"Business\"\n * \"Formal\"\n * \"other\"" - type: string - default: '' - enum: - - '' - - Informal - - Friendly - - Business - - Formal - - other - purpose: - description: "Task purpose:\n * \"Personal use\"\n * \"Business\"\n * \"Online content\"\n * \"App/Web localization\"\n * \"Media content\"\n * \"Semi-technical\"\n * \"other\"" - type: string - default: standard - enum: - - 'Personal use' - - Business - - 'Online content' - - 'App/Web localization' - - 'Media content' - - Semi-technical - - other - customerMessage: - description: 'Instructions for translators' - type: string - usePreferred: - description: 'Use preferred translators' - type: boolean - default: false - example: 'true' - editService: - description: 'Enables Edit stage for all jobs' - type: boolean - default: false - example: 'true' - dateFrom: - description: "Defines start date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-23T07:00:14+00:00' - dateTo: - description: "Defines end date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-27T07:00:14+00:00' - generateCostEstimate: - description: 'Generate cost estimate report for the task. Requires `reportSettingsTemplateId`' - type: boolean - default: false - example: false - reportSettingsTemplateId: - description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany). Required when `generateCostEstimate` is `true`' - type: integer - example: 1 - nullable: true - type: object - CrowdinVendorGengoTaskBySourceIdsForm: - title: CreateBySourcesForm - required: - - title - - languageId - - fileIds - - branchIds - - stringIds - - type - - vendor - properties: - title: - description: 'Task title' - type: string - languageId: - description: 'Task Language Identifier. Get via [Project Target Languages](#operation/api.projects.get)' - type: string - example: es - type: - description: "Task type:\n * 2 - translate by vendor" - type: integer - vendor: - description: "Task vendor:\n * \"gengo\" - Gengo" - type: string - fileIds: - description: 'Task File Identifiers. Get via [List Files](#operation/api.projects.files.getMany)' - type: array - items: - type: integer - example: '2401' - x-doc-sections: - - file-based + example: 2401 labelIds: description: 'Label Identifiers. Get via [List Labels](#operation/api.projects.labels.getMany)' type: array @@ -40475,7 +40009,7 @@ components: - any nullable: true excludeLabelIds: - description: 'Label Identifiers. Get via [List Labels](#operation/api.projects.labels.getMany)' + description: 'Label Identifiers to exclude. Get via [List Labels](#operation/api.projects.labels.getMany)' type: array items: type: integer @@ -40498,183 +40032,18 @@ components: description: description: 'Task description' type: string - expertise: - description: "Task expertise:\n * \"standard\"\n * \"pro\"" - type: string - default: standard - enum: - - standard - - pro - tone: - description: "Task tone:\n * \"\"\n * \"Informal\"\n * \"Friendly\"\n * \"Business\"\n * \"Formal\"\n * \"other\"" - type: string - default: '' - enum: - - '' - - Informal - - Friendly - - Business - - Formal - - other - purpose: - description: "Task purpose:\n * \"Personal use\"\n * \"Business\"\n * \"Online content\"\n * \"App/Web localization\"\n * \"Media content\"\n * \"Semi-technical\"\n * \"other\"" - type: string - default: standard - enum: - - 'Personal use' - - Business - - 'Online content' - - 'App/Web localization' - - 'Media content' - - Semi-technical - - other - customerMessage: - description: 'Instructions for translators' - type: string - usePreferred: - description: 'Use preferred translators' - type: boolean - default: false - example: 'true' - editService: - description: 'Enables Edit stage for all jobs' - type: boolean - default: false - example: 'true' - dateFrom: - description: "Defines start date for interval when strings were modified\n\n__Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-23T07:00:14+00:00' - dateTo: - description: "Defines end date for interval when strings were modified\n\n__Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-27T07:00:14+00:00' - generateCostEstimate: - description: 'Generate cost estimate report for the task. Requires `reportSettingsTemplateId`' - type: boolean - default: false - example: false - generateTranslationCost: - description: 'Generate translation cost report for the task. Requires `reportSettingsTemplateId`' - type: boolean - default: false - example: false - reportSettingsTemplateId: - description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany). Required when `generateCostEstimate` or `generateTranslationCost` is `true`' - type: integer - example: 1 - nullable: true - type: object - CrowdinVendorManualTaskCreateForm: - type: object - oneOf: - - - $ref: '#/components/schemas/CrowdinVendorManualTaskBySourceIds' - - - $ref: '#/components/schemas/CrowdinVendorManualTaskByStringIds' - CrowdinVendorManualTaskBySourceIds: - title: CreateByFileIdsForm - type: object - allOf: - - - $ref: '#/components/schemas/CrowdinVendorManualTaskBySourceIdsForm' - x-doc-sections: - - file-based - CrowdinVendorManualTaskBySourceIdsForm: - title: CreateBySourcesForm - required: - - title - - languageId - - fileIds - - branchIds - - stringIds - - type - - vendor - properties: - title: - description: 'Task title' - type: string - languageId: - description: 'Task Language Identifier. Get via [List Supported Languages](#operation/api.languages.getMany)' - type: string - example: es - type: - description: "Task type: \n * 2 - translate by vendor\n * 3 - proofread by vendor" - type: integer - enum: - - 2 - - 3 - vendor: - $ref: '#/components/schemas/CrowdinManualVendor' - fileIds: - description: 'Task File Identifiers. Get via [List Files](#operation/api.projects.files.getMany)' - type: array - items: - type: integer - example: '2401' - x-doc-sections: - - file-based - labelIds: - description: 'Label Identifiers. Get via [List Labels](#operation/api.projects.labels.getMany)' - type: array - items: - type: integer - example: 1 - labelMatchRule: - description: "Match rule for labels:\n- \"all\" - all labels must be present in string\n- \"any\" - any of the labels must be present in string\n\n__Note:__ Can only be used when `labelIds` parameter is provided" - type: string - default: all - enum: - - all - - any - nullable: true - excludeLabelIds: - description: 'Label Identifiers. Get via [List Labels](#operation/api.projects.labels.getMany)' - type: array - items: - type: integer - example: 12 - excludeLabelMatchRule: - description: "Match rule for excluded labels:\n- \"all\" - all labels must be present in string\n- \"any\" - any of the labels must be present in string\n__Note:__ Can only be used when `excludeLabelIds` parameter is provided" - type: string - default: all - enum: - - all - - any - nullable: true - status: - description: 'Task status' - type: string - default: todo - enum: - - todo - - in_progress - description: - description: 'Task description' - type: string - skipAssignedStrings: - description: 'Skip strings already included in other tasks' + includePreTranslatedStringsOnly: + description: 'Defines whether to include only pretranslated strings' type: boolean default: false example: true - includePreTranslatedStringsOnly: - description: "Defines whether to export only pretranslated strings\n\n__Note:__ `true` value can't be used with `type=0` or `type=2` in same request" + skipAssignedStrings: + description: "Skip strings already included in other tasks.\n\n__Note:__ Not supported by all vendors. Verify with your vendor." type: boolean default: false example: true - assignees: - type: array - items: - $ref: '#/components/schemas/CrowdinTaskAssignee' deadline: - description: "Defines task deadline date\n\n__Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-27T07:00:14+00:00' - startedAt: - description: "Defines task started date\n\n__Format:__ UTC, ISO 8601" + description: "Defines task deadline date.\n\n__Format:__ UTC, ISO 8601\n\n__Note:__ Not supported by all vendors. Verify with your vendor." type: string format: date-time example: '2019-09-27T07:00:14+00:00' @@ -40688,95 +40057,13 @@ components: type: string format: date-time example: '2019-09-27T07:00:14+00:00' - generateCostEstimate: - description: 'Generate cost estimate report for the task. Requires `reportSettingsTemplateId`' - type: boolean - default: false - example: false - generateTranslationCost: - description: 'Generate translation cost report for the task. Requires `reportSettingsTemplateId`' - type: boolean - default: false - example: false - reportSettingsTemplateId: - description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany). Required when `generateCostEstimate` or `generateTranslationCost` is `true`' - type: integer - example: 1 - nullable: true - type: object - CrowdinVendorManualTaskByStringIds: - title: CreateByStringIdsForm - required: - - title - - languageId - - fileIds - - branchIds - - stringIds - - type - - vendor - properties: - title: - description: 'Task title' - type: string - languageId: - description: 'Task Language Identifier. Get via [List Supported Languages](#operation/api.languages.getMany)' - type: string - example: es - type: - description: "Task type:\n * 2 - translate by vendor\n * 3 - proofread by vendor" - type: integer - enum: - - 2 - - 3 - vendor: - $ref: '#/components/schemas/CrowdinManualVendor' - stringIds: - description: 'Task String Identifiers. Get via [List Strings](#operation/api.projects.strings.getMany)' - type: array - items: - type: integer - example: '2401' - status: - description: 'Task status' - type: string - default: todo - enum: - - todo - - in_progress - description: - description: 'Task description' - type: string - skipAssignedStrings: - description: 'Skip strings already included in other tasks' - type: boolean - default: false - example: true - includePreTranslatedStringsOnly: - description: "Defines whether to export only pretranslated strings\n\n__Note:__ `true` value can't be used with `type=0` or `type=2` in same request" - type: boolean - default: false - example: true - assignees: - type: array - items: - $ref: '#/components/schemas/CrowdinTaskAssignee' - deadline: - description: "Defines task deadline date\n\n__Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-27T07:00:14+00:00' - startedAt: - description: "Defines task started date\n\n__Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-27T07:00:14+00:00' - dateFrom: - description: "Defines start date for interval when strings were modified\n\n__Format:__ UTC, ISO 8601" + translationsUpdatedDateFrom: + description: "Defines start date for interval when translations were updated. For proofread tasks only.\n\n__Format:__ UTC, ISO 8601" type: string format: date-time example: '2019-09-23T07:00:14+00:00' - dateTo: - description: "Defines end date for interval when strings were modified\n\n__Format:__ UTC, ISO 8601" + translationsUpdatedDateTo: + description: "Defines end date for interval when translations were updated. For proofread tasks only.\n\n__Format:__ UTC, ISO 8601" type: string format: date-time example: '2019-09-27T07:00:14+00:00' @@ -40796,71 +40083,6 @@ components: example: 1 nullable: true type: object - CrowdinPendingTaskCreateForm: - required: - - precedingTaskId - - type - - title - properties: - precedingTaskId: - description: 'Translate Task Identifier. Get via [List Tasks](#operation/api.projects.tasks.getMany)' - type: integer - example: 1 - type: - description: "Task type:\n * 1 - proofread" - type: integer - enum: - - 1 - title: - description: 'Task title' - type: string - description: - description: 'Task description' - type: string - assignees: - type: array - items: - $ref: '#/components/schemas/CrowdinTaskAssignee' - deadline: - description: "Defines task deadline date\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-27T07:00:14+00:00' - type: object - CrowdinVendorManualPendingTaskCreateForm: - required: - - precedingTaskId - - type - - title - - vendor - properties: - precedingTaskId: - description: 'Translate Task Identifier. Get via [List Tasks](#operation/api.projects.tasks.getMany)' - type: integer - example: 1 - type: - description: "Task type:\n * 3 - proofread by vendor" - type: integer - enum: - - 3 - vendor: - $ref: '#/components/schemas/CrowdinManualVendor' - title: - description: 'Task title' - type: string - description: - description: 'Task description' - type: string - assignees: - type: array - items: - $ref: '#/components/schemas/CrowdinTaskAssignee' - deadline: - description: "Defines task deadline date\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-27T07:00:14+00:00' - type: object CrowdinOrganizationTaskCollectionForm: description: 'Query parameters for listing organization tasks (Crowdin)' properties: diff --git a/src/assets/api/crowdin/string-based.yml b/src/assets/api/crowdin/string-based.yml index e512a7a4..55f71aeb 100644 --- a/src/assets/api/crowdin/string-based.yml +++ b/src/assets/api/crowdin/string-based.yml @@ -1352,7 +1352,6 @@ paths: type: string enum: - pre_translate - - assist - qa_check - $ref: '#/components/parameters/PaginationLimit' @@ -3638,7 +3637,7 @@ paths: '/projects/{projectId}/bundles/{bundleId}/branches': get: tags: - - Bundles + - Translations summary: 'Bundle List Branches' description: '**Required scopes:** `project.source.file` (Read only).' operationId: api.projects.bundles.branches.getMany @@ -3699,7 +3698,7 @@ paths: '/projects/{projectId}/bundles': get: tags: - - Bundles + - Translations summary: 'List Bundles' description: '**Required scopes:** `project.translation` (Read only).' operationId: api.projects.bundles.getMany @@ -3749,7 +3748,7 @@ paths: $ref: '#/components/schemas/MethodNotAllowedExceptionResource' post: tags: - - Bundles + - Translations summary: 'Add Bundle' description: '**Required scopes:** `project.source.file` (Read and Write).' operationId: api.projects.bundles.post @@ -3801,7 +3800,7 @@ paths: '/projects/{projectId}/bundles/{bundleId}': get: tags: - - Bundles + - Translations summary: 'Get Bundle' description: '**Required scopes:** `project.source.file` (Read only).' operationId: api.projects.bundles.get @@ -3843,7 +3842,7 @@ paths: $ref: '#/components/schemas/MethodNotAllowedExceptionResource' delete: tags: - - Bundles + - Translations summary: 'Delete Bundle' description: '**Required scopes:** `project.source.file` (Read and Write).' operationId: api.projects.bundles.delete @@ -3881,7 +3880,7 @@ paths: $ref: '#/components/schemas/MethodNotAllowedExceptionResource' patch: tags: - - Bundles + - Translations summary: 'Edit Bundle' description: '**Required scopes:** `project.source.file` (Read and Write).' operationId: api.projects.bundles.patch @@ -3936,7 +3935,7 @@ paths: '/projects/{projectId}/bundles/{bundleId}/exports/{exportId}/download': get: tags: - - Bundles + - Translations summary: 'Download Bundle' description: '**Required scopes:** `project.translation` (Read only).' operationId: api.projects.bundles.exports.download.get @@ -3981,7 +3980,7 @@ paths: '/projects/{projectId}/bundles/{bundleId}/exports': post: tags: - - Bundles + - Translations summary: 'Export Bundle' description: '**Required scopes:** `project.translation` (Read only).' operationId: api.projects.bundles.exports.post @@ -3990,13 +3989,18 @@ paths: $ref: '#/components/parameters/ProjectId' - $ref: '#/components/parameters/BundleId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CrowdinBundleExportForm' responses: '202': description: 'Bundle export was successfully started' content: application/json: schema: - $ref: '#/components/schemas/BundleExportResource' + $ref: '#/components/schemas/CrowdinBundleExportResource' '400': description: 'Invalid Request Parameters' content: @@ -4036,7 +4040,7 @@ paths: '/projects/{projectId}/bundles/{bundleId}/exports/{exportId}': get: tags: - - Bundles + - Translations summary: 'Check Bundle Export Status' description: '**Required scopes:** `project.translation` (Read only).' operationId: api.projects.bundles.exports.get @@ -4053,7 +4057,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BundleExportResource' + $ref: '#/components/schemas/CrowdinBundleExportResource' '401': description: Unauthorized content: @@ -13476,6 +13480,13 @@ paths: $ref: '#/components/parameters/CrowdinTaskStatus' - $ref: '#/components/parameters/AssigneeId' + - + name: batchId + in: query + description: 'Filter by task batch. Get `batchId` via [List Tasks](#operation/api.projects.tasks.getMany)' + required: false + schema: + type: integer responses: '200': description: 'Tasks list' @@ -13525,18 +13536,10 @@ paths: oneOf: - $ref: '#/components/schemas/CrowdinTaskCreateForm' - - - $ref: '#/components/schemas/CrowdinLanguageServiceTaskCreateForm' - - - $ref: '#/components/schemas/CrowdinVendorOhtTaskCreateForm' - - - $ref: '#/components/schemas/CrowdinVendorGengoTaskCreateForm' - - - $ref: '#/components/schemas/CrowdinVendorManualTaskCreateForm' - $ref: '#/components/schemas/CrowdinPendingTaskCreateForm' - - $ref: '#/components/schemas/CrowdinVendorManualPendingTaskCreateForm' + $ref: '#/components/schemas/CrowdinVendorTaskCreateForm' responses: '201': description: 'Task was successfully created' @@ -17140,8 +17143,6 @@ components: oneOf: - $ref: '#/components/schemas/ai.prompt.completion.resources.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.completion.resources.assist' - $ref: '#/components/schemas/ai.prompt.completion.resources.qa_check' - @@ -17160,8 +17161,6 @@ components: oneOf: - $ref: '#/components/schemas/ai.prompt.completion.resources.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.completion.resources.assist' - $ref: '#/components/schemas/ai.prompt.completion.resources.alignment' - @@ -17217,21 +17216,6 @@ components: example: N/A additionalProperties: type: string - ai.prompt.completion.resources.overridePromptValues.assist: - type: object - allOf: - - - $ref: '#/components/schemas/ai.prompt.completion.resources.overridePromptValues.common' - - - properties: - pluralForms: - type: string - example: 'one,few,many,other' - filteredStrings: - type: string - example: N/A - additionalProperties: - type: string ai.prompt.completion.resources.overridePromptValues.alignment: properties: sourceLanguage: @@ -17319,33 +17303,6 @@ components: overridePromptValues: $ref: '#/components/schemas/ai.prompt.completion.resources.overridePromptValues.pre_translate' type: object - ai.prompt.completion.resources.assist: - title: 'Resources for prompt with assist action' - required: - - projectId - properties: - projectId: - type: integer - sourceLanguageId: - description: '__Note__: If not specified, the source language of the project will be used' - type: string - targetLanguageId: - type: string - stringIds: - description: '__Note:__ Must be used together with `targetLanguageId`. You can assign up to 500 strings at a time.' - type: array - items: - type: integer - example: 78253 - filteredStringIds: - description: '__Note:__ You can assign up to 500 strings at a time.' - type: array - items: - type: integer - example: 78254 - overridePromptValues: - $ref: '#/components/schemas/ai.prompt.completion.resources.overridePromptValues.assist' - type: object ai.prompt.completion.resources.alignment: title: 'Resources for prompt with alignment action' required: @@ -17418,11 +17375,9 @@ components: type: string example: 'Pre-translate prompt' action: - description: 'AI prompt action. __Note:__ `assist` is deprecated' type: string enum: - pre_translate - - assist - qa_check aiProviderId: description: 'AI Provider identifier. Get via [List AI Providers](#operation/api.ai.providers.getMany)' @@ -17455,19 +17410,15 @@ components: - properties: action: - description: 'AI prompt action. __Note:__ `assist` is deprecated' type: string enum: - pre_translate - - assist - qa_check config: description: 'AI prompt configuration' oneOf: - $ref: '#/components/schemas/ai.prompt.config.basic_mode.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.config.basic_mode.assist' - $ref: '#/components/schemas/ai.prompt.config.basic_mode.qa_check' - @@ -17486,11 +17437,9 @@ components: - properties: action: - description: 'AI prompt action. __Note:__ `assist` is deprecated' type: string enum: - pre_translate - - assist - alignment - qa_check config: @@ -17498,8 +17447,6 @@ components: oneOf: - $ref: '#/components/schemas/ai.prompt.config.basic_mode.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.config.basic_mode.assist' - $ref: '#/components/schemas/ai.prompt.config.basic_mode.alignment' - @@ -17575,72 +17522,6 @@ components: retryOnQaIssues: type: boolean type: object - ai.prompt.config.basic_mode.assist: - title: 'Basic mode (assist action)' - required: - - mode - properties: - mode: - type: string - enum: - - basic - companyDescription: - description: 'Use field `snippets` instead' - type: string - deprecated: true - projectDescription: - description: 'Use field `snippets` instead' - type: string - deprecated: true - audienceDescription: - description: 'Use field `snippets` instead' - type: string - deprecated: true - customPlaceholders: - description: 'Use field `snippets` instead' - type: array - items: - type: string - example: '%custom:companyDescription%' - deprecated: true - snippets: - description: 'Array of snippets. Get via [List AI Snippets](#operation/api.ai.snippets.getMany)' - type: array - items: - type: string - example: '%custom:companyDescription%' - otherLanguageTranslations: - properties: - isEnabled: - type: boolean - default: true - languageIds: - description: 'Array of language ids. Get via [List Supported Languages](#operation/api.languages.getMany)' - type: array - items: - type: string - example: uk - type: object - glossaryTerms: - type: boolean - tmSuggestions: - type: boolean - fileContext: - type: boolean - generateFileSummary: - type: boolean - screenshots: - type: boolean - fileContent: - type: boolean - publicProjectDescription: - type: boolean - siblingsStrings: - type: boolean - filteredStrings: - type: boolean - type: object - deprecated: true ai.prompt.config.basic_mode.alignment: title: 'Basic mode (alignment action)' required: @@ -17736,10 +17617,6 @@ components: type: boolean prompt: type: string - fileContent: - description: '__Note:__ Available only for Assist action' - type: boolean - default: 'false' otherLanguageTranslations: properties: isEnabled: @@ -17933,7 +17810,6 @@ components: type: string example: 'Pre-translate prompt' action: - description: '__Note:__ `assist` is deprecated' type: string example: pre_translate aiProviderId: @@ -18004,8 +17880,6 @@ components: oneOf: - $ref: '#/components/schemas/ai.prompt.config.basic_mode.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.config.basic_mode.assist' - $ref: '#/components/schemas/ai.prompt.config.basic_mode.alignment' - @@ -18027,8 +17901,6 @@ components: oneOf: - $ref: '#/components/schemas/ai.prompt.config.basic_mode.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.config.basic_mode.assist' - $ref: '#/components/schemas/ai.prompt.config.basic_mode.qa_check' - @@ -18220,11 +18092,9 @@ components: - properties: action: - description: '__Note:__ `assist` is deprecated' type: string enum: - pre_translate - - assist - alignment - qa_check ai.provider.crowdin_configuration.actionRule: @@ -18236,11 +18106,9 @@ components: - properties: action: - description: '__Note:__ `assist` is deprecated' type: string enum: - pre_translate - - assist - qa_check ai.provider.credentials.open_ai: title: OpenAI @@ -18829,9 +18697,8 @@ components: format: json-pointer enum: - /preTranslationAiPromptId - - /assistActionAiPromptId - /editorSuggestionAiPromptId - - /shortcuts + - /qaCheckActionAiPromptId type: object discriminator: propertyName: op @@ -18882,10 +18749,6 @@ components: preTranslationAiPromptId: type: integer example: 2 - assistActionAiPromptId: - type: integer - example: 2 - deprecated: true editorSuggestionAiPromptId: type: integer example: 5 @@ -18893,27 +18756,6 @@ components: type: integer example: 8 nullable: true - shortcuts: - type: array - items: - type: object - oneOf: - - - $ref: '#/components/schemas/AiSettingsShortcuts' - type: object - AiSettingsShortcuts: - properties: - name: - description: 'Shortcut name' - type: string - example: 'My first shortcut' - prompt: - description: 'Shortcut prompt' - type: string - example: 'Make translation shorter' - enabled: - type: boolean - deprecated: true type: object AiTranslateForm: required: @@ -19171,36 +19013,6 @@ components: type: object iframe: type: object - AiToolCallWidgetsModule: - title: 'AI Tool Call Widgets Module' - type: object - allOf: - - - $ref: '#/components/schemas/AiToolCallsModule' - - - properties: - iframe: - type: object - AiToolCallsModule: - title: 'AI Provider Module' - type: object - allOf: - - - $ref: '#/components/schemas/Module' - - - properties: - identifier: - type: string - example: example-application - url: - type: string - example: /ai-tools - toolType: - type: string - enum: - - function - function: - type: object ApplicationInstallationResponseModel: title: 'Application Installation' description: 'Application Installation Response Model' @@ -21211,6 +21023,26 @@ components: - fr nullable: true type: object + CrowdinBundleExportForm: + properties: + targetLanguageIds: + description: "Specify target languages for export. Get via [List Supported Languages](#operation/api.languages.getMany)\n\n * Leave this field empty to export all target languages" + type: array + items: + type: string + example: uk + skipUntranslatedStrings: + description: 'Defines whether to export only translated strings' + type: boolean + example: false + exportApprovedOnly: + description: "Defines whether to export only approved strings\n\n[More info](https://support.crowdin.com/project-settings/export/)" + type: boolean + default: false + example: false + type: object + x-doc-sections: + - string-based BundleCollectionResource: description: 'Bundle Collection Resource' type: object @@ -21227,8 +21059,8 @@ components: $ref: '#/components/schemas/BundleResource' pagination: $ref: '#/components/schemas/Pagination' - BundleExportResource: - description: 'Bundle Export Resource' + BundleResource: + description: 'Bundle Resource' type: object allOf: - @@ -21236,9 +21068,9 @@ components: - properties: data: - $ref: '#/components/schemas/BundleExport' - BundleResource: - description: 'Bundle Resource' + $ref: '#/components/schemas/Bundle' + CrowdinBundleExportResource: + description: 'Bundle Export Resource' type: object allOf: - @@ -21246,46 +21078,7 @@ components: - properties: data: - $ref: '#/components/schemas/Bundle' - BundleExport: - properties: - identifier: - type: string - example: 50fb3506-4127-4ba8-8296-f97dc7e3e0c3 - status: - type: string - example: finished - progress: - description: 'in percentages' - type: integer - example: 100 - attributes: - properties: - bundleId: - type: integer - example: 38 - type: object - createdAt: - type: string - format: date-time - example: '2019-09-23T11:26:54+00:00' - updatedAt: - type: string - format: date-time - example: '2019-09-23T11:26:54+00:00' - startedAt: - type: string - format: date-time - example: '2019-09-23T11:26:54+00:00' - finishedAt: - type: string - format: date-time - example: '2019-09-23T11:26:54+00:00' - eta: - type: string - example: '1 second' - deprecated: true - type: object + $ref: '#/components/schemas/BundleExport' Bundle: title: Bundle properties: @@ -21374,6 +21167,58 @@ components: format: date-time example: '2019-09-20T12:22:20+00:00' type: object + BundleExport: + properties: + identifier: + type: string + example: 50fb3506-4127-4ba8-8296-f97dc7e3e0c3 + status: + type: string + example: finished + progress: + description: 'in percentages' + type: integer + example: 100 + attributes: + properties: + bundleId: + type: integer + example: 38 + targetLanguageIds: + type: array + items: + type: string + example: uk + skipUntranslatedStrings: + type: boolean + example: false + exportApprovedOnly: + type: boolean + example: false + type: object + createdAt: + type: string + format: date-time + example: '2019-09-23T11:26:54+00:00' + updatedAt: + type: string + format: date-time + example: '2019-09-23T11:26:54+00:00' + startedAt: + type: string + format: date-time + example: '2019-09-23T11:26:54+00:00' + nullable: true + finishedAt: + type: string + format: date-time + example: '2019-09-23T11:26:54+00:00' + nullable: true + eta: + type: string + example: '1 second' + deprecated: true + type: object ClientCollectionResource: description: 'Clients Collection' type: object @@ -23465,7 +23310,7 @@ components: - type: integer ProjectFileType: - description: "Values available:\n- empty value or 'auto' — Try to detect file type by extension or MIME type\n- 'android' — Android (*.xml)\n- 'macosx' — Mac OS X / iOS (*.strings)\n- 'resx' — .NET, Windows Phone (*.resx)\n- 'properties' — Java (*.properties)\n- 'gettext' — GNU GetText (*.po, *.pot)\n- 'yaml' — Ruby On Rails (*.yaml, *.yml)\n- 'php' — Hypertext Preprocessor (*.php)\n- 'json' — Generic JSON (*.json)\n- 'xml' — Generic XML (*.xml)\n- 'ini' — Generic INI (*.ini)\n- 'rc' — Windows Resources (*.rc)\n- 'resw' — Windows 8 Metro (*.resw)\n- 'resjson' — Windows 8 Metro (*.resjson)\n- 'qtts' — Nokia Qt (*.ts)\n- 'joomla' — Joomla localizable resources (*.ini)\n- 'chrome' — Google Chrome Extension (*.json)\n- 'dtd' — Mozilla DTD (*.dtd)\n- 'dklang' — Delphi DKLang (*.dklang)\n- 'flex' — Flex (*.properties)\n- 'nsh' — NSIS Installer Resources (*.nsh)\n- 'wxl' — WiX Installer (*.wxl)\n- 'xliff' — XLIFF (*.xliff, *.xlf)\n- 'xliff_two' — XLIFF 2.0 (*.xliff, *.xlf)\n- 'html' — HTML (*.html, *.htm, *.xhtml, *.xhtm, *.xht, *.hbs, *.liquid)\n- 'haml' — Haml (*.haml)\n- 'txt' — Plain Text (*.txt)\n- 'csv' — Comma Separated Values (*.csv)\n- 'md' — Markdown (*.md, *.text, *.markdown...)\n- 'flsnp' — MadCap Flare (*.flnsp, .flpgpl .fltoc)\n- 'fm_html' — Jekyll HTML (*.html)\n- 'fm_md' — Jekyll Markdown (*.md)\n- 'mediawiki' — MediaWiki (*.wiki, *.wikitext, *.mediawiki)\n- 'docx' — Microsoft Office, OpenOffice.org Documents, Adobe InDesign, Adobe FrameMaker(*.docx, *.dotx, *.docm, *.dotm, *.xlsx, *.xltx, *.xlsm, *.xltm, *.pptx, *.potx, *.ppsx, *.pptm, *.potm, *.ppsm, *.odt, *.ods, *.odg, *.odp, *.imdl, *.mif)\n- 'xlsx' — Microsoft Excel (*.xlsx)\n- 'sbv' — Youtube .sbv (*.sbv)\n- 'properties_play' — Play Framework\n- 'properties_xml' — Java Application (*.xml)\n- 'maxthon' — Maxthon Browser (*.ini)\n- 'go_json' — Go (*.gotext.json)\n- 'dita' — DITA Document (*.dita, *.ditamap)\n- 'mif' — Adobe FrameMaker (*.mif)\n- 'idml' — Adobe InDesign (*.idml)\n- 'stringsdict' — iOS (*.stringsdict)\n- 'plist' — Mac OS property list (*.plist)\n- 'vtt' — Video Subtitling and WebVTT (*.vtt)\n- 'vdf' — Steamworks Localization Valve Data File (*.vdf)\n- 'srt' — SubRip .srt (*.srt)\n- 'stf' — Salesforce (*.stf)\n- 'toml' — Toml (*.toml)\n- 'contentful_rt' — Contentful (*.json)\n- 'svg' — SVG (*.svg)\n- 'js' — JavaScript (*.js)\n- 'coffee' — CoffeeScript (*.coffee)\n- 'nestjs_i18n' - NestJS i18n\n- 'loc' — LOC (*.loc)\n\n__Note__: Use `docx` type to import each cell as a separate source string for XLSX file" + description: "Values available:\n- empty value or 'auto' — Try to detect file type by extension or MIME type\n- 'android' — Android (*.xml)\n- 'macosx' — Mac OS X / iOS (*.strings)\n- 'resx' — .NET, Windows Phone (*.resx)\n- 'properties' — Java (*.properties)\n- 'gettext' — GNU GetText (*.po, *.pot)\n- 'yaml' — Ruby On Rails (*.yaml, *.yml)\n- 'php' — Hypertext Preprocessor (*.php)\n- 'json' — Generic JSON (*.json)\n- 'xml' — Generic XML (*.xml)\n- 'ini' — Generic INI (*.ini)\n- 'rc' — Windows Resources (*.rc)\n- 'resw' — Windows 8 Metro (*.resw)\n- 'resjson' — Windows 8 Metro (*.resjson)\n- 'qtts' — Nokia Qt (*.ts)\n- 'joomla' — Joomla localizable resources (*.ini)\n- 'chrome' — Google Chrome Extension (*.json)\n- 'dtd' — Mozilla DTD (*.dtd)\n- 'dklang' — Delphi DKLang (*.dklang)\n- 'flex' — Flex (*.properties)\n- 'nsh' — NSIS Installer Resources (*.nsh)\n- 'wxl' — WiX Installer (*.wxl)\n- 'xliff' — XLIFF (*.xliff, *.xlf)\n- 'xliff_two' — XLIFF 2.0 (*.xliff, *.xlf)\n- 'html' — HTML (*.html, *.htm, *.xhtml, *.xhtm, *.xht, *.hbs, *.liquid)\n- 'haml' — Haml (*.haml)\n- 'txt' — Plain Text (*.txt)\n- 'csv' — Comma Separated Values (*.csv)\n- 'md' — Markdown (*.md, *.text, *.markdown...)\n- 'flsnp' — MadCap Flare (*.flnsp, .flpgpl .fltoc)\n- 'fm_html' — Jekyll HTML (*.html)\n- 'fm_md' — Jekyll Markdown (*.md)\n- 'mediawiki' — MediaWiki (*.wiki, *.wikitext, *.mediawiki)\n- 'docx' — Microsoft Office, OpenOffice.org Documents, Adobe InDesign, Adobe FrameMaker(*.docx, *.dotx, *.docm, *.dotm, *.xlsx, *.xltx, *.xlsm, *.xltm, *.pptx, *.potx, *.ppsx, *.pptm, *.potm, *.ppsm, *.odt, *.ods, *.odg, *.odp, *.imdl, *.mif)\n- 'vsdx' — Microsoft Visio (*.vsdx, *.vsdm)\n- 'xlsx' — Microsoft Excel (*.xlsx)\n- 'sbv' — Youtube .sbv (*.sbv)\n- 'properties_play' — Play Framework\n- 'properties_xml' — Java Application (*.xml)\n- 'maxthon' — Maxthon Browser (*.ini)\n- 'go_json' — Go (*.gotext.json)\n- 'dita' — DITA Document (*.dita, *.ditamap)\n- 'mif' — Adobe FrameMaker (*.mif)\n- 'idml' — Adobe InDesign (*.idml)\n- 'stringsdict' — iOS (*.stringsdict)\n- 'plist' — Mac OS property list (*.plist)\n- 'vtt' — Video Subtitling and WebVTT (*.vtt)\n- 'vdf' — Steamworks Localization Valve Data File (*.vdf)\n- 'srt' — SubRip .srt (*.srt)\n- 'stf' — Salesforce (*.stf)\n- 'toml' — Toml (*.toml)\n- 'contentful_rt' — Contentful (*.json)\n- 'svg' — SVG (*.svg)\n- 'js' — JavaScript (*.js)\n- 'coffee' — CoffeeScript (*.coffee)\n- 'nestjs_i18n' - NestJS i18n\n- 'loc' — LOC (*.loc)\n\n__Note__: Use `docx` type to import each cell as a separate source string for XLSX file" type: string default: auto enum: @@ -23505,6 +23350,7 @@ components: - fm_md - mediawiki - docx + - vsdx - xlsx - sbv - properties_play @@ -23737,6 +23583,28 @@ components: default: null example: 61 type: object + VsdxFileImportOptions: + title: 'Vsdx File Import Options' + properties: + cleanTagsAggressively: + description: 'When checked, strips additional formatting tags related to text spacing.' + type: boolean + default: false + translateHyperlinkUrls: + description: 'When checked, exposes hidden hyperlinks for translation.' + type: boolean + default: false + contentSegmentation: + description: 'Defines whether to split long texts into smaller text segments.' + type: boolean + default: true + srxStorageId: + description: "Storage Identifier. Get via [List Storages](#operation/api.storages.getMany).\n\n Storage identifier of the SRX segmentation rules file. Read more about [Custom Segmentation](https://support.crowdin.com/custom-segmentation/#segmentation-examples)." + type: integer + format: int64 + default: null + example: 61 + type: object HtmlFileImportOptions: title: 'Html File Import Options' properties: @@ -24318,6 +24186,8 @@ components: $ref: '#/components/schemas/WebXmlFileImportOptions' - $ref: '#/components/schemas/DocxFileImportOptions' + - + $ref: '#/components/schemas/VsdxFileImportOptions' - $ref: '#/components/schemas/HtmlFileImportOptions' - @@ -24355,6 +24225,8 @@ components: $ref: '#/components/schemas/WebXmlFileImportOptions' - $ref: '#/components/schemas/DocxFileUpdateOptions' + - + $ref: '#/components/schemas/VsdxFileImportOptions' - $ref: '#/components/schemas/HtmlFileUpdateOptions' - @@ -24683,6 +24555,8 @@ components: $ref: '#/components/schemas/XmlFileImportOptionsResponseModel' - $ref: '#/components/schemas/DocxFileImportOptionsResponseModel' + - + $ref: '#/components/schemas/VsdxFileImportOptionsResponseModel' - $ref: '#/components/schemas/SegmentationImportOptionsResponseModel' - @@ -25016,6 +24890,26 @@ components: type: boolean example: true type: object + VsdxFileImportOptionsResponseModel: + title: 'VSDX File Import Options' + properties: + cleanTagsAggressively: + description: 'When checked, strips additional formatting tags related to text spacing.' + type: boolean + default: false + translateHyperlinkUrls: + description: 'When checked, exposes hidden hyperlinks for translation.' + type: boolean + default: false + contentSegmentation: + description: 'Defines whether to split long texts into smaller text segments.' + type: boolean + default: true + customSegmentation: + description: 'Specifies whether custom segmentation rules are used.' + type: boolean + default: false + type: object WebXmlFileImportOptionsResponseModel: title: 'WebXml File Import Options' properties: @@ -27066,6 +26960,10 @@ components: description: 'Source language identifier. Get via [Project Target Languages](#operation/api.projects.get)' type: string example: en + customInstruction: + description: "Custom instruction for AI pre-translation. This instruction will be appended to the AI prompt text.\n\n__Note:__ Available only for AI pre-translation method" + type: string + maxLength: 10000 type: object CrowdinPreTranslationCollectionResource: description: 'Pre-Translation Collection Resource' @@ -27560,7 +27458,6 @@ components: - /mtPreTranslate - /aiPreTranslate - /preTranslationAiPromptId - - /assistActionAiPromptId - /editorSuggestionAiPromptId - /qaCheckActionAiPromptId - /savingsReportSettingsTemplateId @@ -28077,11 +27974,6 @@ components: type: integer example: 11 deprecated: true - assistActionAiPromptId: - description: 'AI Prompt ID to be used as prompt for AI Assist action in Editor' - type: integer - example: 12 - deprecated: true editorSuggestionAiPromptId: description: 'AI Prompt ID to be used as prompt for AI Suggestion action in Editor' type: integer @@ -29514,11 +29406,6 @@ components: example: 1 nullable: true deprecated: true - assistActionAiPromptId: - type: integer - example: 11 - nullable: true - deprecated: true editorSuggestionAiPromptId: type: integer example: 2 @@ -30304,6 +30191,31 @@ components: default: null nullable: true type: object + VsdxFileFormatSettingsResponse: + title: 'VSDX file format settings' + properties: + cleanTagsAggressively: + description: 'When checked, strips additional formatting tags related to text spacing.' + type: boolean + default: false + translateHyperlinkUrls: + description: 'When checked, exposes hidden hyperlinks for translation.' + type: boolean + default: false + contentSegmentation: + description: "Defines whether to split long texts into smaller text segments.\n\nImportant! This option disables the possibility to upload existing translations for XML files when enabled." + type: boolean + default: true + customSegmentation: + description: 'Specifies whether custom segmentation rules are used.' + type: boolean + default: false + exportPattern: + description: "File format export pattern. Defines file name and path in resulting translations bundle\n\nNote: Can't contain `: * ? \" < > |` symbols" + type: string + default: null + nullable: true + type: object IdmlFileFormatSettingsResponse: title: 'Idml file format settings' properties: @@ -30434,10 +30346,6 @@ components: type: integer example: 2 deprecated: true - assistActionAiPromptId: - type: integer - example: 2 - deprecated: true editorSuggestionAiPromptId: type: integer example: 2 @@ -32154,7 +32062,7 @@ components: type: object TopMembers: title: 'Top Members' - description: 'Generate a list of translators based on a specific period of time to see who contributed the most to your project’s translation.' + description: "Generate a list of translators based on a specific period of time to see who contributed the most to your project's translation." required: - name - schema @@ -32840,7 +32748,7 @@ components: type: integer example: 13 typeTasks: - description: "Task type:\n * 0 - Translate by own translators\n * 1 - Proofread by own proofreaders\n * 2 - Translate by vendor\n * 3 - Proofread by vendor" + description: "Task type:\n * 0 - Translate by own translators\n * 1 - Proofread by own proofreaders\n * 2 - Translate by vendor\n * 3 - Proofread by vendor" type: integer enum: - 0 @@ -33039,7 +32947,7 @@ components: items: $ref: '#/components/schemas/user-post-edit-report-settings-template-form.individual-rate' netRateSchemes: - description: "Net Rate Schemes (Percentage paid of full translation rate)\n *\n * __Note:__ A new translation will be included in the report at the lowest rate if multiple scheme categories can be applied to the translation" + description: "Net Rate Schemes (Percentage paid of full translation rate)\n\n__Note:__ A new translation will be included in the report at the lowest rate if multiple scheme categories can be applied to the translation" type: object allOf: - @@ -33578,7 +33486,7 @@ components: items: $ref: '#/components/schemas/user-post-edit-report-settings-template.individual-rate' netRateSchemes: - description: "Net Rate Schemes (Percentage paid of full translation rate)\n *\n *__Note:__ A new translation will be included in the report at the lowest rate if multiple scheme categories can be applied to the translation" + description: "Net Rate Schemes (Percentage paid of full translation rate)\n\n__Note:__ A new translation will be included in the report at the lowest rate if multiple scheme categories can be applied to the translation" type: object allOf: - @@ -36786,9 +36694,11 @@ components: - /labelMatchRule - /excludeLabelIds - /excludeLabelMatchRule + - /resetScope - /generateCostEstimate - /generateTranslationCost - /reportSettingsTemplateId + - /batchId x-doc-sections: - string-based type: object @@ -37114,6 +37024,7 @@ components: example: true type: object CrowdinTaskCreateForm: + title: 'Task Create' type: object oneOf: - @@ -37121,7 +37032,7 @@ components: - $ref: '#/components/schemas/CrowdinCreateTaskByStringIds' CrowdinCreateTaskBySourceIds: - title: CreateByBranchIdsForm + title: 'Create By Branch Ids Form' type: object allOf: - @@ -37129,7 +37040,6 @@ components: x-doc-sections: - string-based CrowdinCreateTaskBySourceIdsForm: - title: CreateBySourcesForm required: - title - languageId @@ -37260,9 +37170,14 @@ components: type: integer example: 1 nullable: true + batchId: + description: 'Task Batch Identifier. Get via [List Tasks](#operation/api.projects.tasks.getMany). Allows grouping tasks into a batch' + type: integer + example: 1 + nullable: true type: object CrowdinCreateTaskByStringIds: - title: CreateByStringIdsForm + title: 'Create By String Ids Form' required: - title - languageId @@ -37362,235 +37277,74 @@ components: type: integer example: 1 nullable: true - type: object - CrowdinLanguageServiceTaskCreateForm: - type: object - oneOf: - - - $ref: '#/components/schemas/CrowdinLanguageServiceTaskBySourceIds' - - - $ref: '#/components/schemas/CrowdinLanguageServiceTaskByStringIds' - CrowdinLanguageServiceTaskBySourceIds: - title: CreateByBranchIdsForm - type: object - allOf: - - - $ref: '#/components/schemas/CrowdinLanguageServiceTaskBySourceIdsForm' - x-doc-sections: - - string-based - CrowdinLanguageServiceTaskBySourceIdsForm: - required: - - title - - languageId - - fileIds - - branchIds - - type - - vendor - properties: - title: - description: 'Task title' - type: string - languageId: - description: 'Task Language Identifier. Get via [Project Target Languages](#operation/api.projects.get)' - type: string - example: es - type: - description: "Task type:\n * 2 - translate by vendor\n * 3 - proofread by vendor" - type: integer - enum: - - 2 - - 3 - vendor: - description: "Task vendor:\n * Crowdin Language Services" - type: string - branchIds: - description: 'Array of branch ids. Get via [List Branches](#operation/api.projects.branches.getMany)' - type: array - items: - type: integer - example: '2401' - x-doc-sections: - - string-based - labelIds: - description: 'Label Identifiers. Get via [List Labels](#operation/api.projects.labels.getMany)' - type: array - items: - type: integer - example: 1 - labelMatchRule: - description: "Match rule for labels:\n- \"all\" - all labels must be present in string\n- \"any\" - any of the labels must be present in string\n\n__Note:__ Can only be used when `labelIds` parameter is provided" - type: string - default: all - enum: - - all - - any - nullable: true - excludeLabelIds: - description: 'Label Identifiers. Get via [List Labels](#operation/api.projects.labels.getMany)' - type: array - items: - type: integer - example: 12 - excludeLabelMatchRule: - description: "Match rule for excluded labels:\n- \"all\" - all labels must be present in string\n- \"any\" - any of the labels must be present in string\n\n__Note:__ Can only be used when `excludeLabelIds` parameter is provided" - type: string - default: all - enum: - - all - - any - nullable: true - status: - description: 'Task status' - type: string - default: todo - enum: - - todo - - in_progress - description: - description: 'Task description' - type: string - includePreTranslatedStringsOnly: - description: 'Defines whether to include only pretranslated strings' - type: boolean - default: false - example: true - dateFrom: - description: "Defines start date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-23T07:00:14+00:00' - dateTo: - description: "Defines end date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-27T07:00:14+00:00' - translationsUpdatedDateFrom: - description: "Defines start date for interval when translation were updated (proofread tasks only)\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-23T07:00:14+00:00' - translationsUpdatedDateTo: - description: "Defines end date for interval when translation were updated (proofread tasks only)\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-27T07:00:14+00:00' - generateCostEstimate: - description: 'Generate cost estimate report for the task. Requires `reportSettingsTemplateId`' - type: boolean - default: false - example: false - generateTranslationCost: - description: 'Generate translation cost report for the task. Requires `reportSettingsTemplateId`' - type: boolean - default: false - example: false - reportSettingsTemplateId: - description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany). Required when `generateCostEstimate` or `generateTranslationCost` is `true`' + batchId: + description: 'Task Batch Identifier. Get via [List Tasks](#operation/api.projects.tasks.getMany). Allows grouping tasks into a batch' type: integer example: 1 nullable: true type: object - CrowdinLanguageServiceTaskByStringIds: - title: CreateByStringIdsForm + CrowdinPendingTaskCreateForm: + title: 'Pending Task Create' required: - - title - - languageId - - stringIds + - precedingTaskId - type - - vendor + - title properties: - title: - description: 'Task title' - type: string - languageId: - description: 'Task Language Identifier. Get via [Project Target Languages](#operation/api.projects.get)' - type: string - example: es + precedingTaskId: + description: 'Translate Task Identifier. Get via [List Tasks](#operation/api.projects.tasks.getMany)' + type: integer + example: 1 type: - description: "Task type:\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 1 - proofread\n * 3 - proofread by vendor (requires `vendor` field)" type: integer enum: - - 2 + - 1 - 3 - vendor: - description: "Task vendor:\n * \"crowdin_language_service\" - Crowdin Language Services" - type: string - stringIds: - description: 'Task String Identifiers. Get via [List Strings](#operation/api.projects.strings.getMany)' - type: array - items: - type: integer - example: '2401' - status: - description: 'Task status' + title: + description: 'Task title' type: string - default: todo - enum: - - todo - - in_progress description: description: 'Task description' type: string - includePreTranslatedStringsOnly: - description: 'Defines whether to include only pretranslated strings' - type: boolean - default: false - example: true - dateFrom: - description: "Defines start date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-23T07:00:14+00:00' - dateTo: - description: "Defines end date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-27T07:00:14+00:00' - translationsUpdatedDateFrom: - description: "Defines start date for interval when translation were updated (proofread tasks only)\n\n __Format:__ UTC, ISO 8601" + vendor: + description: 'Vendor identifier. Required when `type` is `3`. Browse available vendors at [Crowdin Store](https://crowdin.com/store/vendors).' type: string - format: date-time - example: '2019-09-23T07:00:14+00:00' - translationsUpdatedDateTo: - description: "Defines end date for interval when translation were updated (proofread tasks only)\n\n __Format:__ UTC, ISO 8601" + nullable: true + assignees: + type: array + items: + $ref: '#/components/schemas/CrowdinTaskAssignee' + deadline: + description: "Defines task deadline date\n\n __Format:__ UTC, ISO 8601" type: string format: date-time example: '2019-09-27T07:00:14+00:00' - generateCostEstimate: - description: 'Generate cost estimate report for the task. Requires `reportSettingsTemplateId`' - type: boolean - default: false - example: false - reportSettingsTemplateId: - description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany). Required when `generateCostEstimate` is `true`' - type: integer - example: 1 - nullable: true type: object - CrowdinVendorOhtTaskCreateForm: + CrowdinVendorTaskCreateForm: + title: 'Vendor Task Create' type: object oneOf: - - $ref: '#/components/schemas/CrowdinVendorOhtTaskBySourceIds' + $ref: '#/components/schemas/CrowdinVendorTaskBySourceIds' - - $ref: '#/components/schemas/CrowdinVendorOhtTaskByStringIds' - CrowdinVendorOhtTaskBySourceIds: - title: CreateByBranchIdsForm + $ref: '#/components/schemas/CrowdinVendorTaskByStringIds' + CrowdinVendorTaskBySourceIds: + title: 'Create By Branch Ids Form' + description: 'Contains common fields shared across all vendors. Additional vendor-specific settings (e.g. expertise, tone, quality) depend on the selected vendor and are available at [Crowdin Store](https://crowdin.com/store/vendors).' type: object allOf: - - $ref: '#/components/schemas/CrowdinVendorOhtTaskBySourceIdsForm' + $ref: '#/components/schemas/CrowdinVendorTaskBySourceIdsForm' x-doc-sections: - string-based - CrowdinVendorOhtTaskBySourceIdsForm: - title: CreateBySourcesForm + CrowdinVendorTaskBySourceIdsForm: required: - title - languageId - - fileIds - - branchIds - type - vendor + - fileIds + - branchIds properties: title: description: 'Task title' @@ -37606,14 +37360,14 @@ components: - 2 - 3 vendor: - description: "Task vendor:\n * \"oht\" - OneHourTranslation" + description: "Vendor identifier. Browse available vendors at [Crowdin Store](https://crowdin.com/store/vendors).\n\n__Note:__ Additional vendor-specific settings (e.g. expertise, tone, quality) are configured per vendor in the store." type: string branchIds: - description: 'Array of branch ids. Get via [List Branches](#operation/api.projects.branches.getMany)' + description: 'Array of branch identifiers. Get via [List Branches](#operation/api.projects.branches.getMany)' type: array items: type: integer - example: '2401' + example: 2401 x-doc-sections: - string-based labelIds: @@ -37623,7 +37377,7 @@ components: type: integer example: 1 labelMatchRule: - description: "Match rule for labels:\n- \"all\" - all labels must be present in string\n- \"any\" - any of the labels must be present in string\n\n __Note:__ Can only be used when `labelIds` parameter is provided" + description: "Match rule for labels:\n- \"all\" - all labels must be present in string\n- \"any\" - any of the labels must be present in string\n\n__Note:__ Can only be used when `labelIds` parameter is provided" type: string default: all enum: @@ -37631,13 +37385,13 @@ components: - any nullable: true excludeLabelIds: - description: 'Label Identifiers. Get via [List Labels](#operation/api.projects.labels.getMany)' + description: 'Label Identifiers to exclude. Get via [List Labels](#operation/api.projects.labels.getMany)' type: array items: type: integer example: 12 excludeLabelMatchRule: - description: "Match rule for excluded labels:\n- \"all\" - all labels must be present in string\n- \"any\" - any of the labels must be present in string\n\n __Note:__ Can only be used when `excludeLabelIds` parameter is provided" + description: "Match rule for excluded labels:\n- \"all\" - all labels must be present in string\n- \"any\" - any of the labels must be present in string\n\n__Note:__ Can only be used when `excludeLabelIds` parameter is provided" type: string default: all enum: @@ -37654,54 +37408,38 @@ components: description: description: 'Task description' type: string - expertise: - description: "Task expertise:\n * \"standard\"\n * \"mobile-applications\"\n * \"software-it\"\n * \"gaming-video-games\"\n * \"technical-engineering\"\n * \"marketing-consumer-media\"\n * \"business-finance\"\n * \"legal-certificate\"\n * \"medical\"\n * \"ad-words-banners\"\n * \"automotive-aerospace\"\n * \"scientific\"\n * \"scientific-academic\"\n * \"tourism\"\n * \"training-employee-handbooks\"\n * \"forex-crypto\"" - type: string - default: standard - enum: - - standard - - mobile-applications - - software-it - - gaming-video-games - - technical-engineering - - marketing-consumer-media - - business-finance - - legal-certificate - - medical - - ad-words-banners - - automotive-aerospace - - scientific - - scientific-academic - - tourism - - training-employee-handbooks - - forex-crypto - editService: - description: 'Enables Edit stage for all jobs' - type: boolean - default: false - example: 'true' includePreTranslatedStringsOnly: description: 'Defines whether to include only pretranslated strings' type: boolean default: false example: true + skipAssignedStrings: + description: "Skip strings already included in other tasks.\n\n__Note:__ Not supported by all vendors. Verify with your vendor." + type: boolean + default: false + example: true + deadline: + description: "Defines task deadline date.\n\n__Format:__ UTC, ISO 8601\n\n__Note:__ Not supported by all vendors. Verify with your vendor." + type: string + format: date-time + example: '2019-09-27T07:00:14+00:00' dateFrom: - description: "Defines start date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601" + description: "Defines start date for interval when strings were modified\n\n__Format:__ UTC, ISO 8601" type: string format: date-time example: '2019-09-23T07:00:14+00:00' dateTo: - description: "Defines end date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601" + description: "Defines end date for interval when strings were modified\n\n__Format:__ UTC, ISO 8601" type: string format: date-time example: '2019-09-27T07:00:14+00:00' translationsUpdatedDateFrom: - description: "Defines start date for interval when translation were updated (proofread tasks only)\n\n __Format:__ UTC, ISO 8601" + description: "Defines start date for interval when translations were updated. For proofread tasks only.\n\n__Format:__ UTC, ISO 8601" type: string format: date-time example: '2019-09-23T07:00:14+00:00' translationsUpdatedDateTo: - description: "Defines end date for interval when translation were updated (proofread tasks only)\n\n __Format:__ UTC, ISO 8601" + description: "Defines end date for interval when translations were updated. For proofread tasks only.\n\n__Format:__ UTC, ISO 8601" type: string format: date-time example: '2019-09-27T07:00:14+00:00' @@ -37721,14 +37459,15 @@ components: example: 1 nullable: true type: object - CrowdinVendorOhtTaskByStringIds: - title: CreateByStringIdsForm + CrowdinVendorTaskByStringIds: + title: 'Create By String Ids Form' + description: 'Contains common fields shared across all vendors. Additional vendor-specific settings (e.g. expertise, tone, quality) depend on the selected vendor and are available at [Crowdin Store](https://crowdin.com/store/vendors).' required: - title - languageId - - stringIds - type - vendor + - stringIds properties: title: description: 'Task title' @@ -37744,230 +37483,14 @@ components: - 2 - 3 vendor: - description: "Task vendor:\n * \"oht\" - OneHourTranslation" + description: "Vendor identifier. Browse available vendors at [Crowdin Store](https://crowdin.com/store/vendors).\n\n__Note:__ Additional vendor-specific settings (e.g. expertise, tone, quality) are configured per vendor in the store." type: string stringIds: description: 'Task String Identifiers. Get via [List Strings](#operation/api.projects.strings.getMany)' type: array items: type: integer - example: '2401' - status: - description: 'Task status' - type: string - default: todo - enum: - - todo - - in_progress - description: - description: 'Task description' - type: string - expertise: - description: "Task expertise:\n * \"standard\"\n * \"mobile-applications\"\n * \"software-it\"\n * \"gaming-video-games\"\n * \"technical-engineering\"\n * \"marketing-consumer-media\"\n * \"business-finance\"\n * \"legal-certificate\"\n * \"medical\"\n * \"ad-words-banners\"\n * \"automotive-aerospace\"\n * \"scientific\"\n * \"scientific-academic\"\n * \"tourism\"\n * \"training-employee-handbooks\"\n * \"forex-crypto\"" - type: string - default: standard - enum: - - standard - - mobile-applications - - software-it - - gaming-video-games - - technical-engineering - - marketing-consumer-media - - business-finance - - legal-certificate - - medical - - ad-words-banners - - automotive-aerospace - - scientific - - scientific-academic - - tourism - - training-employee-handbooks - - forex-crypto - editService: - description: 'Enables Edit stage for all jobs' - type: boolean - default: false - example: 'true' - includePreTranslatedStringsOnly: - description: 'Defines whether to include only pretranslated strings' - type: boolean - default: false - example: true - dateFrom: - description: "Defines start date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-23T07:00:14+00:00' - dateTo: - description: "Defines end date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-27T07:00:14+00:00' - generateCostEstimate: - description: 'Generate cost estimate report for the task. Requires `reportSettingsTemplateId`' - type: boolean - default: false - example: false - generateTranslationCost: - description: 'Generate translation cost report for the task. Requires `reportSettingsTemplateId`' - type: boolean - default: false - example: false - reportSettingsTemplateId: - description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany). Required when `generateCostEstimate` or `generateTranslationCost` is `true`' - type: integer - example: 1 - nullable: true - type: object - CrowdinVendorGengoTaskCreateForm: - type: object - oneOf: - - - $ref: '#/components/schemas/CrowdinVendorGengoTaskBySourceIds' - - - $ref: '#/components/schemas/CrowdinVendorGengoTaskByStringIds' - CrowdinVendorGengoTaskBySourceIds: - title: CreateByBranchIdsForm - type: object - allOf: - - - $ref: '#/components/schemas/CrowdinVendorGengoTaskBySourceIdsForm' - x-doc-sections: - - string-based - CrowdinVendorGengoTaskByStringIds: - title: CreateByStringIdsForm - required: - - title - - languageId - - stringIds - - type - - vendor - properties: - title: - description: 'Task title' - type: string - languageId: - description: 'Task Language Identifier. Get via [Project Target Languages](#operation/api.projects.get)' - type: string - example: es - type: - description: "Task type:\n * 2 - translate by vendor" - type: integer - vendor: - description: "Task vendor:\n * \"gengo\" - Gengo" - type: string - stringIds: - description: 'Task String Identifiers. Get via [List Strings](#operation/api.projects.strings.getMany)' - type: array - items: - type: integer - example: '2401' - status: - description: 'Task status' - type: string - default: todo - enum: - - todo - - in_progress - description: - description: 'Task description' - type: string - expertise: - description: "Task expertise:\n * \"standard\"\n * \"pro\"" - type: string - default: standard - enum: - - standard - - pro - tone: - description: "Task tone:\n * \"\"\n * \"Informal\"\n * \"Friendly\"\n * \"Business\"\n * \"Formal\"\n * \"other\"" - type: string - default: '' - enum: - - '' - - Informal - - Friendly - - Business - - Formal - - other - purpose: - description: "Task purpose:\n * \"Personal use\"\n * \"Business\"\n * \"Online content\"\n * \"App/Web localization\"\n * \"Media content\"\n * \"Semi-technical\"\n * \"other\"" - type: string - default: standard - enum: - - 'Personal use' - - Business - - 'Online content' - - 'App/Web localization' - - 'Media content' - - Semi-technical - - other - customerMessage: - description: 'Instructions for translators' - type: string - usePreferred: - description: 'Use preferred translators' - type: boolean - default: false - example: 'true' - editService: - description: 'Enables Edit stage for all jobs' - type: boolean - default: false - example: 'true' - dateFrom: - description: "Defines start date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-23T07:00:14+00:00' - dateTo: - description: "Defines end date for interval when strings were modified\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-27T07:00:14+00:00' - generateCostEstimate: - description: 'Generate cost estimate report for the task. Requires `reportSettingsTemplateId`' - type: boolean - default: false - example: false - reportSettingsTemplateId: - description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany). Required when `generateCostEstimate` is `true`' - type: integer - example: 1 - nullable: true - type: object - CrowdinVendorGengoTaskBySourceIdsForm: - title: CreateBySourcesForm - required: - - title - - languageId - - fileIds - - branchIds - - stringIds - - type - - vendor - properties: - title: - description: 'Task title' - type: string - languageId: - description: 'Task Language Identifier. Get via [Project Target Languages](#operation/api.projects.get)' - type: string - example: es - type: - description: "Task type:\n * 2 - translate by vendor" - type: integer - vendor: - description: "Task vendor:\n * \"gengo\" - Gengo" - type: string - branchIds: - description: 'Array of branch ids. Get via [List Branches](#operation/api.projects.branches.getMany)' - type: array - items: - type: integer - example: '2401' - x-doc-sections: - - string-based + example: 2401 labelIds: description: 'Label Identifiers. Get via [List Labels](#operation/api.projects.labels.getMany)' type: array @@ -37983,7 +37506,7 @@ components: - any nullable: true excludeLabelIds: - description: 'Label Identifiers. Get via [List Labels](#operation/api.projects.labels.getMany)' + description: 'Label Identifiers to exclude. Get via [List Labels](#operation/api.projects.labels.getMany)' type: array items: type: integer @@ -38006,183 +37529,18 @@ components: description: description: 'Task description' type: string - expertise: - description: "Task expertise:\n * \"standard\"\n * \"pro\"" - type: string - default: standard - enum: - - standard - - pro - tone: - description: "Task tone:\n * \"\"\n * \"Informal\"\n * \"Friendly\"\n * \"Business\"\n * \"Formal\"\n * \"other\"" - type: string - default: '' - enum: - - '' - - Informal - - Friendly - - Business - - Formal - - other - purpose: - description: "Task purpose:\n * \"Personal use\"\n * \"Business\"\n * \"Online content\"\n * \"App/Web localization\"\n * \"Media content\"\n * \"Semi-technical\"\n * \"other\"" - type: string - default: standard - enum: - - 'Personal use' - - Business - - 'Online content' - - 'App/Web localization' - - 'Media content' - - Semi-technical - - other - customerMessage: - description: 'Instructions for translators' - type: string - usePreferred: - description: 'Use preferred translators' - type: boolean - default: false - example: 'true' - editService: - description: 'Enables Edit stage for all jobs' - type: boolean - default: false - example: 'true' - dateFrom: - description: "Defines start date for interval when strings were modified\n\n__Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-23T07:00:14+00:00' - dateTo: - description: "Defines end date for interval when strings were modified\n\n__Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-27T07:00:14+00:00' - generateCostEstimate: - description: 'Generate cost estimate report for the task. Requires `reportSettingsTemplateId`' - type: boolean - default: false - example: false - generateTranslationCost: - description: 'Generate translation cost report for the task. Requires `reportSettingsTemplateId`' - type: boolean - default: false - example: false - reportSettingsTemplateId: - description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany). Required when `generateCostEstimate` or `generateTranslationCost` is `true`' - type: integer - example: 1 - nullable: true - type: object - CrowdinVendorManualTaskCreateForm: - type: object - oneOf: - - - $ref: '#/components/schemas/CrowdinVendorManualTaskBySourceIds' - - - $ref: '#/components/schemas/CrowdinVendorManualTaskByStringIds' - CrowdinVendorManualTaskBySourceIds: - title: CreateByBranchIdsForm - type: object - allOf: - - - $ref: '#/components/schemas/CrowdinVendorManualTaskBySourceIdsForm' - x-doc-sections: - - string-based - CrowdinVendorManualTaskBySourceIdsForm: - title: CreateBySourcesForm - required: - - title - - languageId - - fileIds - - branchIds - - stringIds - - type - - vendor - properties: - title: - description: 'Task title' - type: string - languageId: - description: 'Task Language Identifier. Get via [List Supported Languages](#operation/api.languages.getMany)' - type: string - example: es - type: - description: "Task type: \n * 2 - translate by vendor\n * 3 - proofread by vendor" - type: integer - enum: - - 2 - - 3 - vendor: - $ref: '#/components/schemas/CrowdinManualVendor' - branchIds: - description: 'Array of branch ids. Get via [List Branches](#operation/api.projects.branches.getMany)' - type: array - items: - type: integer - example: '2401' - x-doc-sections: - - string-based - labelIds: - description: 'Label Identifiers. Get via [List Labels](#operation/api.projects.labels.getMany)' - type: array - items: - type: integer - example: 1 - labelMatchRule: - description: "Match rule for labels:\n- \"all\" - all labels must be present in string\n- \"any\" - any of the labels must be present in string\n\n__Note:__ Can only be used when `labelIds` parameter is provided" - type: string - default: all - enum: - - all - - any - nullable: true - excludeLabelIds: - description: 'Label Identifiers. Get via [List Labels](#operation/api.projects.labels.getMany)' - type: array - items: - type: integer - example: 12 - excludeLabelMatchRule: - description: "Match rule for excluded labels:\n- \"all\" - all labels must be present in string\n- \"any\" - any of the labels must be present in string\n__Note:__ Can only be used when `excludeLabelIds` parameter is provided" - type: string - default: all - enum: - - all - - any - nullable: true - status: - description: 'Task status' - type: string - default: todo - enum: - - todo - - in_progress - description: - description: 'Task description' - type: string - skipAssignedStrings: - description: 'Skip strings already included in other tasks' + includePreTranslatedStringsOnly: + description: 'Defines whether to include only pretranslated strings' type: boolean default: false example: true - includePreTranslatedStringsOnly: - description: "Defines whether to export only pretranslated strings\n\n__Note:__ `true` value can't be used with `type=0` or `type=2` in same request" + skipAssignedStrings: + description: "Skip strings already included in other tasks.\n\n__Note:__ Not supported by all vendors. Verify with your vendor." type: boolean default: false example: true - assignees: - type: array - items: - $ref: '#/components/schemas/CrowdinTaskAssignee' deadline: - description: "Defines task deadline date\n\n__Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-27T07:00:14+00:00' - startedAt: - description: "Defines task started date\n\n__Format:__ UTC, ISO 8601" + description: "Defines task deadline date.\n\n__Format:__ UTC, ISO 8601\n\n__Note:__ Not supported by all vendors. Verify with your vendor." type: string format: date-time example: '2019-09-27T07:00:14+00:00' @@ -38196,95 +37554,13 @@ components: type: string format: date-time example: '2019-09-27T07:00:14+00:00' - generateCostEstimate: - description: 'Generate cost estimate report for the task. Requires `reportSettingsTemplateId`' - type: boolean - default: false - example: false - generateTranslationCost: - description: 'Generate translation cost report for the task. Requires `reportSettingsTemplateId`' - type: boolean - default: false - example: false - reportSettingsTemplateId: - description: 'Report Settings Templates Identifier. Get via [List Report Settings Templates](#operation/api.projects.reports.settings-templates.getMany). Required when `generateCostEstimate` or `generateTranslationCost` is `true`' - type: integer - example: 1 - nullable: true - type: object - CrowdinVendorManualTaskByStringIds: - title: CreateByStringIdsForm - required: - - title - - languageId - - fileIds - - branchIds - - stringIds - - type - - vendor - properties: - title: - description: 'Task title' - type: string - languageId: - description: 'Task Language Identifier. Get via [List Supported Languages](#operation/api.languages.getMany)' - type: string - example: es - type: - description: "Task type:\n * 2 - translate by vendor\n * 3 - proofread by vendor" - type: integer - enum: - - 2 - - 3 - vendor: - $ref: '#/components/schemas/CrowdinManualVendor' - stringIds: - description: 'Task String Identifiers. Get via [List Strings](#operation/api.projects.strings.getMany)' - type: array - items: - type: integer - example: '2401' - status: - description: 'Task status' - type: string - default: todo - enum: - - todo - - in_progress - description: - description: 'Task description' - type: string - skipAssignedStrings: - description: 'Skip strings already included in other tasks' - type: boolean - default: false - example: true - includePreTranslatedStringsOnly: - description: "Defines whether to export only pretranslated strings\n\n__Note:__ `true` value can't be used with `type=0` or `type=2` in same request" - type: boolean - default: false - example: true - assignees: - type: array - items: - $ref: '#/components/schemas/CrowdinTaskAssignee' - deadline: - description: "Defines task deadline date\n\n__Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-27T07:00:14+00:00' - startedAt: - description: "Defines task started date\n\n__Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-27T07:00:14+00:00' - dateFrom: - description: "Defines start date for interval when strings were modified\n\n__Format:__ UTC, ISO 8601" + translationsUpdatedDateFrom: + description: "Defines start date for interval when translations were updated. For proofread tasks only.\n\n__Format:__ UTC, ISO 8601" type: string format: date-time example: '2019-09-23T07:00:14+00:00' - dateTo: - description: "Defines end date for interval when strings were modified\n\n__Format:__ UTC, ISO 8601" + translationsUpdatedDateTo: + description: "Defines end date for interval when translations were updated. For proofread tasks only.\n\n__Format:__ UTC, ISO 8601" type: string format: date-time example: '2019-09-27T07:00:14+00:00' @@ -38304,71 +37580,6 @@ components: example: 1 nullable: true type: object - CrowdinPendingTaskCreateForm: - required: - - precedingTaskId - - type - - title - properties: - precedingTaskId: - description: 'Translate Task Identifier. Get via [List Tasks](#operation/api.projects.tasks.getMany)' - type: integer - example: 1 - type: - description: "Task type:\n * 1 - proofread" - type: integer - enum: - - 1 - title: - description: 'Task title' - type: string - description: - description: 'Task description' - type: string - assignees: - type: array - items: - $ref: '#/components/schemas/CrowdinTaskAssignee' - deadline: - description: "Defines task deadline date\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-27T07:00:14+00:00' - type: object - CrowdinVendorManualPendingTaskCreateForm: - required: - - precedingTaskId - - type - - title - - vendor - properties: - precedingTaskId: - description: 'Translate Task Identifier. Get via [List Tasks](#operation/api.projects.tasks.getMany)' - type: integer - example: 1 - type: - description: "Task type:\n * 3 - proofread by vendor" - type: integer - enum: - - 3 - vendor: - $ref: '#/components/schemas/CrowdinManualVendor' - title: - description: 'Task title' - type: string - description: - description: 'Task description' - type: string - assignees: - type: array - items: - $ref: '#/components/schemas/CrowdinTaskAssignee' - deadline: - description: "Defines task deadline date\n\n __Format:__ UTC, ISO 8601" - type: string - format: date-time - example: '2019-09-27T07:00:14+00:00' - type: object CrowdinOrganizationTaskCollectionForm: description: 'Query parameters for listing organization tasks (Crowdin)' properties: diff --git a/src/assets/api/enterprise/file-based.yml b/src/assets/api/enterprise/file-based.yml index b87c6013..46f2d259 100644 --- a/src/assets/api/enterprise/file-based.yml +++ b/src/assets/api/enterprise/file-based.yml @@ -1271,7 +1271,6 @@ paths: type: string enum: - pre_translate - - assist - alignment - qa_check - @@ -3563,7 +3562,7 @@ paths: '/projects/{projectId}/bundles': get: tags: - - Bundles + - Translations summary: 'List Bundles' description: '**Required scopes:** `project.translation` (Read only).' operationId: api.projects.bundles.getMany @@ -3613,7 +3612,7 @@ paths: $ref: '#/components/schemas/MethodNotAllowedExceptionResource' post: tags: - - Bundles + - Translations summary: 'Add Bundle' description: '**Required scopes:** `project.source.file` (Read and Write).' operationId: api.projects.bundles.post @@ -3665,7 +3664,7 @@ paths: '/projects/{projectId}/bundles/{bundleId}': get: tags: - - Bundles + - Translations summary: 'Get Bundle' description: '**Required scopes:** `project.source.file` (Read only).' operationId: api.projects.bundles.get @@ -3707,7 +3706,7 @@ paths: $ref: '#/components/schemas/MethodNotAllowedExceptionResource' delete: tags: - - Bundles + - Translations summary: 'Delete Bundle' description: '**Required scopes:** `project.source.file` (Read and Write).' operationId: api.projects.bundles.delete @@ -3745,7 +3744,7 @@ paths: $ref: '#/components/schemas/MethodNotAllowedExceptionResource' patch: tags: - - Bundles + - Translations summary: 'Edit Bundle' description: '**Required scopes:** `project.source.file` (Read and Write).' operationId: api.projects.bundles.patch @@ -3800,7 +3799,7 @@ paths: '/projects/{projectId}/bundles/{bundleId}/exports/{exportId}/download': get: tags: - - Bundles + - Translations summary: 'Download Bundle' description: '**Required scopes:** `project.translation` (Read only).' operationId: api.projects.bundles.exports.download.get @@ -3845,7 +3844,7 @@ paths: '/projects/{projectId}/bundles/{bundleId}/exports': post: tags: - - Bundles + - Translations summary: 'Export Bundle' description: '**Required scopes:** `project.translation` (Read only).' operationId: api.projects.bundles.exports.post @@ -3854,13 +3853,18 @@ paths: $ref: '#/components/parameters/ProjectId' - $ref: '#/components/parameters/BundleId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnterpriseBundleExportForm' responses: '202': description: 'Bundle export was successfully started' content: application/json: schema: - $ref: '#/components/schemas/BundleExportResource' + $ref: '#/components/schemas/EnterpriseBundleExportResource' '400': description: 'Invalid Request Parameters' content: @@ -3900,7 +3904,7 @@ paths: '/projects/{projectId}/bundles/{bundleId}/exports/{exportId}': get: tags: - - Bundles + - Translations summary: 'Check Bundle Export Status' description: '**Required scopes:** `project.translation` (Read only).' operationId: api.projects.bundles.exports.get @@ -3917,7 +3921,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BundleExportResource' + $ref: '#/components/schemas/EnterpriseBundleExportResource' '401': description: Unauthorized content: @@ -5476,7 +5480,7 @@ paths: '/projects/{projectId}/bundles/{bundleId}/files': get: tags: - - Bundles + - Translations summary: 'Bundle List Files' description: '**Required scopes:** `project.source.file` (Read only).' operationId: api.projects.bundles.files.getMany @@ -16833,6 +16837,13 @@ paths: $ref: '#/components/parameters/PaginationOffset' - $ref: '#/components/parameters/EnterpriseTaskStatus' + - + name: batchId + in: query + description: 'Filter by task batch. Get `batchId` via [List Tasks](#operation/api.projects.tasks.getMany)' + required: false + schema: + type: integer responses: '200': description: 'Tasks list' @@ -22359,8 +22370,6 @@ components: oneOf: - $ref: '#/components/schemas/ai.prompt.completion.resources.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.completion.resources.assist' - $ref: '#/components/schemas/ai.prompt.completion.resources.qa_check' - @@ -22379,8 +22388,6 @@ components: oneOf: - $ref: '#/components/schemas/ai.prompt.completion.resources.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.completion.resources.assist' - $ref: '#/components/schemas/ai.prompt.completion.resources.alignment' - @@ -22436,21 +22443,6 @@ components: example: N/A additionalProperties: type: string - ai.prompt.completion.resources.overridePromptValues.assist: - type: object - allOf: - - - $ref: '#/components/schemas/ai.prompt.completion.resources.overridePromptValues.common' - - - properties: - pluralForms: - type: string - example: 'one,few,many,other' - filteredStrings: - type: string - example: N/A - additionalProperties: - type: string ai.prompt.completion.resources.overridePromptValues.alignment: properties: sourceLanguage: @@ -22538,33 +22530,6 @@ components: overridePromptValues: $ref: '#/components/schemas/ai.prompt.completion.resources.overridePromptValues.pre_translate' type: object - ai.prompt.completion.resources.assist: - title: 'Resources for prompt with assist action' - required: - - projectId - properties: - projectId: - type: integer - sourceLanguageId: - description: '__Note__: If not specified, the source language of the project will be used' - type: string - targetLanguageId: - type: string - stringIds: - description: '__Note:__ Must be used together with `targetLanguageId`. You can assign up to 500 strings at a time.' - type: array - items: - type: integer - example: 78253 - filteredStringIds: - description: '__Note:__ You can assign up to 500 strings at a time.' - type: array - items: - type: integer - example: 78254 - overridePromptValues: - $ref: '#/components/schemas/ai.prompt.completion.resources.overridePromptValues.assist' - type: object ai.prompt.completion.resources.alignment: title: 'Resources for prompt with alignment action' required: @@ -22637,11 +22602,9 @@ components: type: string example: 'Pre-translate prompt' action: - description: 'AI prompt action. __Note:__ `assist` is deprecated' type: string enum: - pre_translate - - assist - qa_check aiProviderId: description: 'AI Provider identifier. Get via [List AI Providers](#operation/api.ai.providers.getMany)' @@ -22674,19 +22637,15 @@ components: - properties: action: - description: 'AI prompt action. __Note:__ `assist` is deprecated' type: string enum: - pre_translate - - assist - qa_check config: description: 'AI prompt configuration' oneOf: - $ref: '#/components/schemas/ai.prompt.config.basic_mode.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.config.basic_mode.assist' - $ref: '#/components/schemas/ai.prompt.config.basic_mode.qa_check' - @@ -22705,11 +22664,9 @@ components: - properties: action: - description: 'AI prompt action. __Note:__ `assist` is deprecated' type: string enum: - pre_translate - - assist - alignment - qa_check config: @@ -22717,8 +22674,6 @@ components: oneOf: - $ref: '#/components/schemas/ai.prompt.config.basic_mode.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.config.basic_mode.assist' - $ref: '#/components/schemas/ai.prompt.config.basic_mode.alignment' - @@ -22794,72 +22749,6 @@ components: retryOnQaIssues: type: boolean type: object - ai.prompt.config.basic_mode.assist: - title: 'Basic mode (assist action)' - required: - - mode - properties: - mode: - type: string - enum: - - basic - companyDescription: - description: 'Use field `snippets` instead' - type: string - deprecated: true - projectDescription: - description: 'Use field `snippets` instead' - type: string - deprecated: true - audienceDescription: - description: 'Use field `snippets` instead' - type: string - deprecated: true - customPlaceholders: - description: 'Use field `snippets` instead' - type: array - items: - type: string - example: '%custom:companyDescription%' - deprecated: true - snippets: - description: 'Array of snippets. Get via [List AI Snippets](#operation/api.ai.snippets.getMany)' - type: array - items: - type: string - example: '%custom:companyDescription%' - otherLanguageTranslations: - properties: - isEnabled: - type: boolean - default: true - languageIds: - description: 'Array of language ids. Get via [List Supported Languages](#operation/api.languages.getMany)' - type: array - items: - type: string - example: uk - type: object - glossaryTerms: - type: boolean - tmSuggestions: - type: boolean - fileContext: - type: boolean - generateFileSummary: - type: boolean - screenshots: - type: boolean - fileContent: - type: boolean - publicProjectDescription: - type: boolean - siblingsStrings: - type: boolean - filteredStrings: - type: boolean - type: object - deprecated: true ai.prompt.config.basic_mode.alignment: title: 'Basic mode (alignment action)' required: @@ -22955,10 +22844,6 @@ components: type: boolean prompt: type: string - fileContent: - description: '__Note:__ Available only for Assist action' - type: boolean - default: 'false' otherLanguageTranslations: properties: isEnabled: @@ -23152,7 +23037,6 @@ components: type: string example: 'Pre-translate prompt' action: - description: '__Note:__ `assist` is deprecated' type: string example: pre_translate aiProviderId: @@ -23223,8 +23107,6 @@ components: oneOf: - $ref: '#/components/schemas/ai.prompt.config.basic_mode.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.config.basic_mode.assist' - $ref: '#/components/schemas/ai.prompt.config.basic_mode.alignment' - @@ -23246,8 +23128,6 @@ components: oneOf: - $ref: '#/components/schemas/ai.prompt.config.basic_mode.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.config.basic_mode.assist' - $ref: '#/components/schemas/ai.prompt.config.basic_mode.qa_check' - @@ -23439,11 +23319,9 @@ components: - properties: action: - description: '__Note:__ `assist` is deprecated' type: string enum: - pre_translate - - assist - alignment - qa_check ai.provider.crowdin_configuration.actionRule: @@ -23455,11 +23333,9 @@ components: - properties: action: - description: '__Note:__ `assist` is deprecated' type: string enum: - pre_translate - - assist - qa_check ai.provider.credentials.open_ai: title: OpenAI @@ -24048,9 +23924,9 @@ components: format: json-pointer enum: - /preTranslationAiPromptId - - /assistActionAiPromptId - /editorSuggestionAiPromptId - - /shortcuts + - /alignmentActionAiPromptId + - /qaCheckActionAiPromptId type: object discriminator: propertyName: op @@ -24101,10 +23977,6 @@ components: preTranslationAiPromptId: type: integer example: 2 - assistActionAiPromptId: - type: integer - example: 2 - deprecated: true editorSuggestionAiPromptId: type: integer example: 5 @@ -24116,27 +23988,6 @@ components: type: integer example: 8 nullable: true - shortcuts: - type: array - items: - type: object - oneOf: - - - $ref: '#/components/schemas/AiSettingsShortcuts' - type: object - AiSettingsShortcuts: - properties: - name: - description: 'Shortcut name' - type: string - example: 'My first shortcut' - prompt: - description: 'Shortcut prompt' - type: string - example: 'Make translation shorter' - enabled: - type: boolean - deprecated: true type: object AiTranslateForm: required: @@ -24717,36 +24568,6 @@ components: type: object iframe: type: object - AiToolCallWidgetsModule: - title: 'AI Tool Call Widgets Module' - type: object - allOf: - - - $ref: '#/components/schemas/AiToolCallsModule' - - - properties: - iframe: - type: object - AiToolCallsModule: - title: 'AI Provider Module' - type: object - allOf: - - - $ref: '#/components/schemas/Module' - - - properties: - identifier: - type: string - example: example-application - url: - type: string - example: /ai-tools - toolType: - type: string - enum: - - function - function: - type: object ApplicationInstallationResponseModel: title: 'Application Installation' description: 'Application Installation Response Model' @@ -26767,6 +26588,33 @@ components: - fr nullable: true type: object + EnterpriseBundleExportForm: + properties: + targetLanguageIds: + description: "Specify target languages for export. Get via [List Supported Languages](#operation/api.languages.getMany)\n\n * Leave this field empty to export all target languages" + type: array + items: + type: string + example: uk + skipUntranslatedStrings: + description: "Defines whether to export only translated strings\n\n__Note:__ `true` value can't be used with `skipUntranslatedFiles=true` in same request" + type: boolean + example: false + skipUntranslatedFiles: + description: "Defines whether to export only translated files\n\n__Note:__ `true` value can't be used with `skipUntranslatedStrings=true` in same request" + type: boolean + example: false + exportWithMinApprovalsCount: + description: "Defines whether to export only strings with a minimum number of approvals\n\n__Note:__ value greater than `0` can't be used with `exportStringsThatPassedWorkflow=true` in same request" + type: integer + example: 0 + exportStringsThatPassedWorkflow: + description: "Defines whether to export only strings that passed workflow\n\n__Note:__ `true` value can't be used with `exportWithMinApprovalsCount > 0` in same request or in projects without an assigned workflow" + type: boolean + example: true + type: object + x-doc-sections: + - file-based BundleCollectionResource: description: 'Bundle Collection Resource' type: object @@ -26783,8 +26631,8 @@ components: $ref: '#/components/schemas/BundleResource' pagination: $ref: '#/components/schemas/Pagination' - BundleExportResource: - description: 'Bundle Export Resource' + BundleResource: + description: 'Bundle Resource' type: object allOf: - @@ -26792,9 +26640,9 @@ components: - properties: data: - $ref: '#/components/schemas/BundleExport' - BundleResource: - description: 'Bundle Resource' + $ref: '#/components/schemas/Bundle' + EnterpriseBundleExportResource: + description: 'Bundle Export Resource' type: object allOf: - @@ -26802,46 +26650,7 @@ components: - properties: data: - $ref: '#/components/schemas/Bundle' - BundleExport: - properties: - identifier: - type: string - example: 50fb3506-4127-4ba8-8296-f97dc7e3e0c3 - status: - type: string - example: finished - progress: - description: 'in percentages' - type: integer - example: 100 - attributes: - properties: - bundleId: - type: integer - example: 38 - type: object - createdAt: - type: string - format: date-time - example: '2019-09-23T11:26:54+00:00' - updatedAt: - type: string - format: date-time - example: '2019-09-23T11:26:54+00:00' - startedAt: - type: string - format: date-time - example: '2019-09-23T11:26:54+00:00' - finishedAt: - type: string - format: date-time - example: '2019-09-23T11:26:54+00:00' - eta: - type: string - example: '1 second' - deprecated: true - type: object + $ref: '#/components/schemas/BundleExport' Bundle: title: Bundle properties: @@ -26930,6 +26739,66 @@ components: format: date-time example: '2019-09-20T12:22:20+00:00' type: object + BundleExport: + properties: + identifier: + type: string + example: 50fb3506-4127-4ba8-8296-f97dc7e3e0c3 + status: + type: string + example: finished + progress: + description: 'in percentages' + type: integer + example: 100 + attributes: + properties: + bundleId: + type: integer + example: 38 + targetLanguageIds: + type: array + items: + type: string + example: uk + skipUntranslatedStrings: + type: boolean + example: false + skipUntranslatedFiles: + type: boolean + example: false + x-doc-sections: + - file-based + exportWithMinApprovalsCount: + type: integer + example: 0 + exportStringsThatPassedWorkflow: + type: boolean + example: true + type: object + createdAt: + type: string + format: date-time + example: '2019-09-23T11:26:54+00:00' + updatedAt: + type: string + format: date-time + example: '2019-09-23T11:26:54+00:00' + startedAt: + type: string + format: date-time + example: '2019-09-23T11:26:54+00:00' + nullable: true + finishedAt: + type: string + format: date-time + example: '2019-09-23T11:26:54+00:00' + nullable: true + eta: + type: string + example: '1 second' + deprecated: true + type: object ClientCollectionResource: description: 'Clients Collection' type: object @@ -29104,7 +28973,7 @@ components: nullable: true type: object ProjectFileType: - description: "Values available:\n- empty value or 'auto' — Try to detect file type by extension or MIME type\n- 'android' — Android (*.xml)\n- 'macosx' — Mac OS X / iOS (*.strings)\n- 'resx' — .NET, Windows Phone (*.resx)\n- 'properties' — Java (*.properties)\n- 'gettext' — GNU GetText (*.po, *.pot)\n- 'yaml' — Ruby On Rails (*.yaml, *.yml)\n- 'php' — Hypertext Preprocessor (*.php)\n- 'json' — Generic JSON (*.json)\n- 'xml' — Generic XML (*.xml)\n- 'ini' — Generic INI (*.ini)\n- 'rc' — Windows Resources (*.rc)\n- 'resw' — Windows 8 Metro (*.resw)\n- 'resjson' — Windows 8 Metro (*.resjson)\n- 'qtts' — Nokia Qt (*.ts)\n- 'joomla' — Joomla localizable resources (*.ini)\n- 'chrome' — Google Chrome Extension (*.json)\n- 'dtd' — Mozilla DTD (*.dtd)\n- 'dklang' — Delphi DKLang (*.dklang)\n- 'flex' — Flex (*.properties)\n- 'nsh' — NSIS Installer Resources (*.nsh)\n- 'wxl' — WiX Installer (*.wxl)\n- 'xliff' — XLIFF (*.xliff, *.xlf)\n- 'xliff_two' — XLIFF 2.0 (*.xliff, *.xlf)\n- 'html' — HTML (*.html, *.htm, *.xhtml, *.xhtm, *.xht, *.hbs, *.liquid)\n- 'haml' — Haml (*.haml)\n- 'txt' — Plain Text (*.txt)\n- 'csv' — Comma Separated Values (*.csv)\n- 'md' — Markdown (*.md, *.text, *.markdown...)\n- 'flsnp' — MadCap Flare (*.flnsp, .flpgpl .fltoc)\n- 'fm_html' — Jekyll HTML (*.html)\n- 'fm_md' — Jekyll Markdown (*.md)\n- 'mediawiki' — MediaWiki (*.wiki, *.wikitext, *.mediawiki)\n- 'docx' — Microsoft Office, OpenOffice.org Documents, Adobe InDesign, Adobe FrameMaker(*.docx, *.dotx, *.docm, *.dotm, *.xlsx, *.xltx, *.xlsm, *.xltm, *.pptx, *.potx, *.ppsx, *.pptm, *.potm, *.ppsm, *.odt, *.ods, *.odg, *.odp, *.imdl, *.mif)\n- 'xlsx' — Microsoft Excel (*.xlsx)\n- 'sbv' — Youtube .sbv (*.sbv)\n- 'properties_play' — Play Framework\n- 'properties_xml' — Java Application (*.xml)\n- 'maxthon' — Maxthon Browser (*.ini)\n- 'go_json' — Go (*.gotext.json)\n- 'dita' — DITA Document (*.dita, *.ditamap)\n- 'mif' — Adobe FrameMaker (*.mif)\n- 'idml' — Adobe InDesign (*.idml)\n- 'stringsdict' — iOS (*.stringsdict)\n- 'plist' — Mac OS property list (*.plist)\n- 'vtt' — Video Subtitling and WebVTT (*.vtt)\n- 'vdf' — Steamworks Localization Valve Data File (*.vdf)\n- 'srt' — SubRip .srt (*.srt)\n- 'stf' — Salesforce (*.stf)\n- 'toml' — Toml (*.toml)\n- 'contentful_rt' — Contentful (*.json)\n- 'svg' — SVG (*.svg)\n- 'js' — JavaScript (*.js)\n- 'coffee' — CoffeeScript (*.coffee)\n- 'nestjs_i18n' - NestJS i18n\n- 'loc' — LOC (*.loc)\n\n__Note__: Use `docx` type to import each cell as a separate source string for XLSX file" + description: "Values available:\n- empty value or 'auto' — Try to detect file type by extension or MIME type\n- 'android' — Android (*.xml)\n- 'macosx' — Mac OS X / iOS (*.strings)\n- 'resx' — .NET, Windows Phone (*.resx)\n- 'properties' — Java (*.properties)\n- 'gettext' — GNU GetText (*.po, *.pot)\n- 'yaml' — Ruby On Rails (*.yaml, *.yml)\n- 'php' — Hypertext Preprocessor (*.php)\n- 'json' — Generic JSON (*.json)\n- 'xml' — Generic XML (*.xml)\n- 'ini' — Generic INI (*.ini)\n- 'rc' — Windows Resources (*.rc)\n- 'resw' — Windows 8 Metro (*.resw)\n- 'resjson' — Windows 8 Metro (*.resjson)\n- 'qtts' — Nokia Qt (*.ts)\n- 'joomla' — Joomla localizable resources (*.ini)\n- 'chrome' — Google Chrome Extension (*.json)\n- 'dtd' — Mozilla DTD (*.dtd)\n- 'dklang' — Delphi DKLang (*.dklang)\n- 'flex' — Flex (*.properties)\n- 'nsh' — NSIS Installer Resources (*.nsh)\n- 'wxl' — WiX Installer (*.wxl)\n- 'xliff' — XLIFF (*.xliff, *.xlf)\n- 'xliff_two' — XLIFF 2.0 (*.xliff, *.xlf)\n- 'html' — HTML (*.html, *.htm, *.xhtml, *.xhtm, *.xht, *.hbs, *.liquid)\n- 'haml' — Haml (*.haml)\n- 'txt' — Plain Text (*.txt)\n- 'csv' — Comma Separated Values (*.csv)\n- 'md' — Markdown (*.md, *.text, *.markdown...)\n- 'flsnp' — MadCap Flare (*.flnsp, .flpgpl .fltoc)\n- 'fm_html' — Jekyll HTML (*.html)\n- 'fm_md' — Jekyll Markdown (*.md)\n- 'mediawiki' — MediaWiki (*.wiki, *.wikitext, *.mediawiki)\n- 'docx' — Microsoft Office, OpenOffice.org Documents, Adobe InDesign, Adobe FrameMaker(*.docx, *.dotx, *.docm, *.dotm, *.xlsx, *.xltx, *.xlsm, *.xltm, *.pptx, *.potx, *.ppsx, *.pptm, *.potm, *.ppsm, *.odt, *.ods, *.odg, *.odp, *.imdl, *.mif)\n- 'vsdx' — Microsoft Visio (*.vsdx, *.vsdm)\n- 'xlsx' — Microsoft Excel (*.xlsx)\n- 'sbv' — Youtube .sbv (*.sbv)\n- 'properties_play' — Play Framework\n- 'properties_xml' — Java Application (*.xml)\n- 'maxthon' — Maxthon Browser (*.ini)\n- 'go_json' — Go (*.gotext.json)\n- 'dita' — DITA Document (*.dita, *.ditamap)\n- 'mif' — Adobe FrameMaker (*.mif)\n- 'idml' — Adobe InDesign (*.idml)\n- 'stringsdict' — iOS (*.stringsdict)\n- 'plist' — Mac OS property list (*.plist)\n- 'vtt' — Video Subtitling and WebVTT (*.vtt)\n- 'vdf' — Steamworks Localization Valve Data File (*.vdf)\n- 'srt' — SubRip .srt (*.srt)\n- 'stf' — Salesforce (*.stf)\n- 'toml' — Toml (*.toml)\n- 'contentful_rt' — Contentful (*.json)\n- 'svg' — SVG (*.svg)\n- 'js' — JavaScript (*.js)\n- 'coffee' — CoffeeScript (*.coffee)\n- 'nestjs_i18n' - NestJS i18n\n- 'loc' — LOC (*.loc)\n\n__Note__: Use `docx` type to import each cell as a separate source string for XLSX file" type: string default: auto enum: @@ -29144,6 +29013,7 @@ components: - fm_md - mediawiki - docx + - vsdx - xlsx - sbv - properties_play @@ -29376,6 +29246,28 @@ components: default: null example: 61 type: object + VsdxFileImportOptions: + title: 'Vsdx File Import Options' + properties: + cleanTagsAggressively: + description: 'When checked, strips additional formatting tags related to text spacing.' + type: boolean + default: false + translateHyperlinkUrls: + description: 'When checked, exposes hidden hyperlinks for translation.' + type: boolean + default: false + contentSegmentation: + description: 'Defines whether to split long texts into smaller text segments.' + type: boolean + default: true + srxStorageId: + description: "Storage Identifier. Get via [List Storages](#operation/api.storages.getMany).\n\n Storage identifier of the SRX segmentation rules file. Read more about [Custom Segmentation](https://support.crowdin.com/custom-segmentation/#segmentation-examples)." + type: integer + format: int64 + default: null + example: 61 + type: object HtmlFileImportOptions: title: 'Html File Import Options' properties: @@ -29957,6 +29849,8 @@ components: $ref: '#/components/schemas/WebXmlFileImportOptions' - $ref: '#/components/schemas/DocxFileImportOptions' + - + $ref: '#/components/schemas/VsdxFileImportOptions' - $ref: '#/components/schemas/HtmlFileImportOptions' - @@ -29994,6 +29888,8 @@ components: $ref: '#/components/schemas/WebXmlFileImportOptions' - $ref: '#/components/schemas/DocxFileUpdateOptions' + - + $ref: '#/components/schemas/VsdxFileImportOptions' - $ref: '#/components/schemas/HtmlFileUpdateOptions' - @@ -30349,6 +30245,8 @@ components: $ref: '#/components/schemas/XmlFileImportOptionsResponseModel' - $ref: '#/components/schemas/DocxFileImportOptionsResponseModel' + - + $ref: '#/components/schemas/VsdxFileImportOptionsResponseModel' - $ref: '#/components/schemas/SegmentationImportOptionsResponseModel' - @@ -30682,6 +30580,26 @@ components: type: boolean example: true type: object + VsdxFileImportOptionsResponseModel: + title: 'VSDX File Import Options' + properties: + cleanTagsAggressively: + description: 'When checked, strips additional formatting tags related to text spacing.' + type: boolean + default: false + translateHyperlinkUrls: + description: 'When checked, exposes hidden hyperlinks for translation.' + type: boolean + default: false + contentSegmentation: + description: 'Defines whether to split long texts into smaller text segments.' + type: boolean + default: true + customSegmentation: + description: 'Specifies whether custom segmentation rules are used.' + type: boolean + default: false + type: object WebXmlFileImportOptionsResponseModel: title: 'WebXml File Import Options' properties: @@ -33484,6 +33402,10 @@ components: type: array items: type: integer + customInstruction: + description: "Custom instruction for AI pre-translation. This instruction will be appended to the AI prompt text.\n\n__Note:__ Available only for AI pre-translation method" + type: string + maxLength: 10000 type: object FallbackLanguagesScheme: title: 'Fallback Languages' @@ -33577,6 +33499,10 @@ components: description: 'Source language identifier. Get via [Project Target Languages](#operation/api.projects.get)' type: string example: en + customInstruction: + description: "Custom instruction for AI pre-translation. This instruction will be appended to the AI prompt text.\n\n__Note:__ Available only for AI pre-translation method" + type: string + maxLength: 10000 type: object CrowdinPreTranslationCollectionResource: description: 'Pre-Translation Collection Resource' @@ -34077,7 +34003,6 @@ components: - '/fields/{fieldSlug}' - /tm - /preTranslationAiPromptId - - /assistActionAiPromptId - /editorSuggestionAiPromptId - /alignmentActionAiPromptId - /qaCheckActionAiPromptId @@ -34781,11 +34706,6 @@ components: type: integer example: 11 deprecated: true - assistActionAiPromptId: - description: 'AI Prompt ID to be used as prompt for AI Assist action in Editor' - type: integer - example: 12 - deprecated: true editorSuggestionAiPromptId: description: 'AI Prompt ID to be used as prompt for AI Suggestion action in Editor' type: integer @@ -36375,11 +36295,6 @@ components: example: 2 nullable: true deprecated: true - assistActionAiPromptId: - type: integer - example: 11 - nullable: true - deprecated: true editorSuggestionAiPromptId: type: integer example: 3 @@ -36488,6 +36403,8 @@ components: $ref: '#/components/schemas/MadcapFlsnpFileFormatSettingsResponse' - $ref: '#/components/schemas/DocxFileFormatSettingsResponse' + - + $ref: '#/components/schemas/VsdxFileFormatSettingsResponse' - $ref: '#/components/schemas/IdmlFileFormatSettingsResponse' - @@ -37198,6 +37115,31 @@ components: default: null nullable: true type: object + VsdxFileFormatSettingsResponse: + title: 'VSDX file format settings' + properties: + cleanTagsAggressively: + description: 'When checked, strips additional formatting tags related to text spacing.' + type: boolean + default: false + translateHyperlinkUrls: + description: 'When checked, exposes hidden hyperlinks for translation.' + type: boolean + default: false + contentSegmentation: + description: "Defines whether to split long texts into smaller text segments.\n\nImportant! This option disables the possibility to upload existing translations for XML files when enabled." + type: boolean + default: true + customSegmentation: + description: 'Specifies whether custom segmentation rules are used.' + type: boolean + default: false + exportPattern: + description: "File format export pattern. Defines file name and path in resulting translations bundle\n\nNote: Can't contain `: * ? \" < > |` symbols" + type: string + default: null + nullable: true + type: object IdmlFileFormatSettingsResponse: title: 'Idml file format settings' properties: @@ -37328,10 +37270,6 @@ components: type: integer example: 2 deprecated: true - assistActionAiPromptId: - type: integer - example: 2 - deprecated: true editorSuggestionAiPromptId: type: integer example: 2 @@ -37847,7 +37785,7 @@ components: items: { type: string } GroupTopMembers: title: 'Group Top Members' - description: 'Generate a list of translators based on a specific period of time to see who contributed the most to your project’s translation.' + description: "Generate a list of translators based on a specific period of time to see who contributed the most to your project's translation." required: - name - schema @@ -38352,7 +38290,7 @@ components: - project example: user typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -38418,7 +38356,7 @@ components: - project example: user typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -38480,7 +38418,7 @@ components: - project example: user typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -38546,7 +38484,7 @@ components: - project example: user typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -38618,7 +38556,7 @@ components: - project example: user typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -38937,7 +38875,7 @@ components: type: integer example: 13 typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -39571,7 +39509,7 @@ components: type: object TopMembers: title: 'Top Members' - description: 'Generate a list of translators based on a specific period of time to see who contributed the most to your project’s translation.' + description: "Generate a list of translators based on a specific period of time to see who contributed the most to your project's translation." required: - name - schema @@ -40316,7 +40254,7 @@ components: - type example: user typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -40375,7 +40313,7 @@ components: - type example: user typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -40430,7 +40368,7 @@ components: - type example: user typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -40489,7 +40427,7 @@ components: - type example: user typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -40554,7 +40492,7 @@ components: - type example: user typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -40854,7 +40792,7 @@ components: type: integer example: 13 typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -41516,7 +41454,7 @@ components: items: $ref: '#/components/schemas/user-post-edit-report-settings-template-form.individual-rate' netRateSchemes: - description: "Net Rate Schemes (Percentage paid of full translation rate)\n *\n * __Note:__ A new translation will be included in the report at the lowest rate if multiple scheme categories can be applied to the translation" + description: "Net Rate Schemes (Percentage paid of full translation rate)\n\n__Note:__ A new translation will be included in the report at the lowest rate if multiple scheme categories can be applied to the translation" type: object allOf: - @@ -41758,7 +41696,7 @@ components: items: $ref: '#/components/schemas/post-edit-report-settings-template.individual-rate' netRateSchemes: - description: "Net Rate Schemes (Percentage paid of full translation rate)\n *\n * __Note:__ A new translation will be included in the report at the lowest rate if multiple scheme categories can be applied to the translation" + description: "Net Rate Schemes (Percentage paid of full translation rate)\n\n__Note:__ A new translation will be included in the report at the lowest rate if multiple scheme categories can be applied to the translation" type: object allOf: - @@ -41910,6 +41848,7 @@ components: description: 'Generate Group Report Response Model' properties: identifier: + description: 'Class GroupReportResponseModel' type: string example: 50fb3506-4127-4ba8-8296-f97dc7e3e0c3 status: @@ -42113,7 +42052,7 @@ components: items: $ref: '#/components/schemas/user-post-edit-report-settings-template.individual-rate' netRateSchemes: - description: "Net Rate Schemes (Percentage paid of full translation rate)\n *\n *__Note:__ A new translation will be included in the report at the lowest rate if multiple scheme categories can be applied to the translation" + description: "Net Rate Schemes (Percentage paid of full translation rate)\n\n__Note:__ A new translation will be included in the report at the lowest rate if multiple scheme categories can be applied to the translation" type: object allOf: - @@ -46145,9 +46084,11 @@ components: - /excludeLabelMatchRule - /fields - '/fields/{fieldSlug}' + - /resetScope - /generateCostEstimate - /generateTranslationCost - /reportSettingsTemplateId + - /batchId x-doc-sections: - file-based type: object @@ -46496,6 +46437,7 @@ components: example: true type: object EnterpriseTaskCreateForm: + title: 'Task Create Form' type: object oneOf: - @@ -46503,7 +46445,7 @@ components: - $ref: '#/components/schemas/EnterpriseTaskByStringIds' EnterpriseTaskBySourceIds: - title: CreateByFileIdsForm + title: 'Create By File Ids Form' type: object allOf: - @@ -46511,7 +46453,6 @@ components: x-doc-sections: - file-based EnterpriseTaskBySourceIdsForm: - title: CreateBySourcesForm required: - title - languageId @@ -46664,9 +46605,14 @@ components: - $ref: '#/components/schemas/EnterpriseAdditionalFields' nullable: true + batchId: + description: 'Task Batch Identifier. Get via [List Tasks](#operation/api.projects.tasks.getMany). Allows grouping tasks into a batch' + type: integer + example: 1 + nullable: true type: object EnterpriseTaskByStringIds: - title: CreateByStringIdsForm + title: 'Create By String Ids Form' required: - title - languageId @@ -46789,8 +46735,14 @@ components: - $ref: '#/components/schemas/EnterpriseAdditionalFields' nullable: true + batchId: + description: 'Task Batch Identifier. Get via [List Tasks](#operation/api.projects.tasks.getMany). Allows grouping tasks into a batch' + type: integer + example: 1 + nullable: true type: object EnterpriseVendorTaskCreateForm: + title: 'Vendor Task Create Form' type: object oneOf: - @@ -46798,7 +46750,7 @@ components: - $ref: '#/components/schemas/EnterpriseVendorTaskByStringIds' EnterpriseVendorTaskBySourceIds: - title: CreateByFileIdsForm + title: 'Create By File Ids Form' type: object allOf: - @@ -46806,7 +46758,6 @@ components: x-doc-sections: - file-based EnterpriseVendorTaskBySourceIdsForm: - title: CreateBySourcesForm required: - workflowStepId - title @@ -46923,7 +46874,7 @@ components: nullable: true type: object EnterpriseVendorTaskByStringIds: - title: CreateByStringIdsForm + title: 'Create By String Ids Form' required: - workflowStepId - title @@ -47024,6 +46975,7 @@ components: nullable: true type: object EnterprisePendingTaskCreateForm: + title: 'Pending Task Create Form' required: - precedingTaskId - title @@ -47033,10 +46985,11 @@ components: type: integer example: '1' type: - description: "Task type:\n * 1 - proofread\n\n__Note:__ One of fields `type` or `workflowStepId` is required. Both cannot be provided simultaneously" + description: "Task type:\n * 1 - proofread\n * 3 - proofread by vendor (requires `vendor` field)\n\n__Note:__ One of fields `type` or `workflowStepId` is required. Both cannot be provided simultaneously" type: integer enum: - 1 + - 3 workflowStepId: description: "Task workflow step id\n\n__Note:__ One of fields `type` or `workflowStepId` is required. Both cannot be provided simultaneously" type: integer @@ -47046,6 +46999,10 @@ components: description: description: 'Task description' type: string + vendor: + description: 'Vendor identifier. Required when `type` is `3`. Get via [List Vendors](#operation/api.projects.vendors.getMany)' + type: string + nullable: true assignees: description: 'Task assigned users' type: array diff --git a/src/assets/api/enterprise/string-based.yml b/src/assets/api/enterprise/string-based.yml index 78dd03d1..7a3ecece 100644 --- a/src/assets/api/enterprise/string-based.yml +++ b/src/assets/api/enterprise/string-based.yml @@ -1271,7 +1271,6 @@ paths: type: string enum: - pre_translate - - assist - alignment - qa_check - @@ -3471,7 +3470,7 @@ paths: '/projects/{projectId}/bundles/{bundleId}/branches': get: tags: - - Bundles + - Translations summary: 'Bundle List Branches' description: '**Required scopes:** `project.source.file` (Read only).' operationId: api.projects.bundles.branches.getMany @@ -3532,7 +3531,7 @@ paths: '/projects/{projectId}/bundles': get: tags: - - Bundles + - Translations summary: 'List Bundles' description: '**Required scopes:** `project.translation` (Read only).' operationId: api.projects.bundles.getMany @@ -3582,7 +3581,7 @@ paths: $ref: '#/components/schemas/MethodNotAllowedExceptionResource' post: tags: - - Bundles + - Translations summary: 'Add Bundle' description: '**Required scopes:** `project.source.file` (Read and Write).' operationId: api.projects.bundles.post @@ -3634,7 +3633,7 @@ paths: '/projects/{projectId}/bundles/{bundleId}': get: tags: - - Bundles + - Translations summary: 'Get Bundle' description: '**Required scopes:** `project.source.file` (Read only).' operationId: api.projects.bundles.get @@ -3676,7 +3675,7 @@ paths: $ref: '#/components/schemas/MethodNotAllowedExceptionResource' delete: tags: - - Bundles + - Translations summary: 'Delete Bundle' description: '**Required scopes:** `project.source.file` (Read and Write).' operationId: api.projects.bundles.delete @@ -3714,7 +3713,7 @@ paths: $ref: '#/components/schemas/MethodNotAllowedExceptionResource' patch: tags: - - Bundles + - Translations summary: 'Edit Bundle' description: '**Required scopes:** `project.source.file` (Read and Write).' operationId: api.projects.bundles.patch @@ -3769,7 +3768,7 @@ paths: '/projects/{projectId}/bundles/{bundleId}/exports/{exportId}/download': get: tags: - - Bundles + - Translations summary: 'Download Bundle' description: '**Required scopes:** `project.translation` (Read only).' operationId: api.projects.bundles.exports.download.get @@ -3814,7 +3813,7 @@ paths: '/projects/{projectId}/bundles/{bundleId}/exports': post: tags: - - Bundles + - Translations summary: 'Export Bundle' description: '**Required scopes:** `project.translation` (Read only).' operationId: api.projects.bundles.exports.post @@ -3823,13 +3822,18 @@ paths: $ref: '#/components/parameters/ProjectId' - $ref: '#/components/parameters/BundleId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnterpriseBundleExportForm' responses: '202': description: 'Bundle export was successfully started' content: application/json: schema: - $ref: '#/components/schemas/BundleExportResource' + $ref: '#/components/schemas/EnterpriseBundleExportResource' '400': description: 'Invalid Request Parameters' content: @@ -3869,7 +3873,7 @@ paths: '/projects/{projectId}/bundles/{bundleId}/exports/{exportId}': get: tags: - - Bundles + - Translations summary: 'Check Bundle Export Status' description: '**Required scopes:** `project.translation` (Read only).' operationId: api.projects.bundles.exports.get @@ -3886,7 +3890,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BundleExportResource' + $ref: '#/components/schemas/EnterpriseBundleExportResource' '401': description: Unauthorized content: @@ -15292,6 +15296,13 @@ paths: $ref: '#/components/parameters/PaginationOffset' - $ref: '#/components/parameters/EnterpriseTaskStatus' + - + name: batchId + in: query + description: 'Filter by task batch. Get `batchId` via [List Tasks](#operation/api.projects.tasks.getMany)' + required: false + schema: + type: integer responses: '200': description: 'Tasks list' @@ -20353,8 +20364,6 @@ components: oneOf: - $ref: '#/components/schemas/ai.prompt.completion.resources.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.completion.resources.assist' - $ref: '#/components/schemas/ai.prompt.completion.resources.qa_check' - @@ -20373,8 +20382,6 @@ components: oneOf: - $ref: '#/components/schemas/ai.prompt.completion.resources.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.completion.resources.assist' - $ref: '#/components/schemas/ai.prompt.completion.resources.alignment' - @@ -20430,21 +20437,6 @@ components: example: N/A additionalProperties: type: string - ai.prompt.completion.resources.overridePromptValues.assist: - type: object - allOf: - - - $ref: '#/components/schemas/ai.prompt.completion.resources.overridePromptValues.common' - - - properties: - pluralForms: - type: string - example: 'one,few,many,other' - filteredStrings: - type: string - example: N/A - additionalProperties: - type: string ai.prompt.completion.resources.overridePromptValues.alignment: properties: sourceLanguage: @@ -20532,33 +20524,6 @@ components: overridePromptValues: $ref: '#/components/schemas/ai.prompt.completion.resources.overridePromptValues.pre_translate' type: object - ai.prompt.completion.resources.assist: - title: 'Resources for prompt with assist action' - required: - - projectId - properties: - projectId: - type: integer - sourceLanguageId: - description: '__Note__: If not specified, the source language of the project will be used' - type: string - targetLanguageId: - type: string - stringIds: - description: '__Note:__ Must be used together with `targetLanguageId`. You can assign up to 500 strings at a time.' - type: array - items: - type: integer - example: 78253 - filteredStringIds: - description: '__Note:__ You can assign up to 500 strings at a time.' - type: array - items: - type: integer - example: 78254 - overridePromptValues: - $ref: '#/components/schemas/ai.prompt.completion.resources.overridePromptValues.assist' - type: object ai.prompt.completion.resources.alignment: title: 'Resources for prompt with alignment action' required: @@ -20631,11 +20596,9 @@ components: type: string example: 'Pre-translate prompt' action: - description: 'AI prompt action. __Note:__ `assist` is deprecated' type: string enum: - pre_translate - - assist - qa_check aiProviderId: description: 'AI Provider identifier. Get via [List AI Providers](#operation/api.ai.providers.getMany)' @@ -20668,19 +20631,15 @@ components: - properties: action: - description: 'AI prompt action. __Note:__ `assist` is deprecated' type: string enum: - pre_translate - - assist - qa_check config: description: 'AI prompt configuration' oneOf: - $ref: '#/components/schemas/ai.prompt.config.basic_mode.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.config.basic_mode.assist' - $ref: '#/components/schemas/ai.prompt.config.basic_mode.qa_check' - @@ -20699,11 +20658,9 @@ components: - properties: action: - description: 'AI prompt action. __Note:__ `assist` is deprecated' type: string enum: - pre_translate - - assist - alignment - qa_check config: @@ -20711,8 +20668,6 @@ components: oneOf: - $ref: '#/components/schemas/ai.prompt.config.basic_mode.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.config.basic_mode.assist' - $ref: '#/components/schemas/ai.prompt.config.basic_mode.alignment' - @@ -20788,72 +20743,6 @@ components: retryOnQaIssues: type: boolean type: object - ai.prompt.config.basic_mode.assist: - title: 'Basic mode (assist action)' - required: - - mode - properties: - mode: - type: string - enum: - - basic - companyDescription: - description: 'Use field `snippets` instead' - type: string - deprecated: true - projectDescription: - description: 'Use field `snippets` instead' - type: string - deprecated: true - audienceDescription: - description: 'Use field `snippets` instead' - type: string - deprecated: true - customPlaceholders: - description: 'Use field `snippets` instead' - type: array - items: - type: string - example: '%custom:companyDescription%' - deprecated: true - snippets: - description: 'Array of snippets. Get via [List AI Snippets](#operation/api.ai.snippets.getMany)' - type: array - items: - type: string - example: '%custom:companyDescription%' - otherLanguageTranslations: - properties: - isEnabled: - type: boolean - default: true - languageIds: - description: 'Array of language ids. Get via [List Supported Languages](#operation/api.languages.getMany)' - type: array - items: - type: string - example: uk - type: object - glossaryTerms: - type: boolean - tmSuggestions: - type: boolean - fileContext: - type: boolean - generateFileSummary: - type: boolean - screenshots: - type: boolean - fileContent: - type: boolean - publicProjectDescription: - type: boolean - siblingsStrings: - type: boolean - filteredStrings: - type: boolean - type: object - deprecated: true ai.prompt.config.basic_mode.alignment: title: 'Basic mode (alignment action)' required: @@ -20949,10 +20838,6 @@ components: type: boolean prompt: type: string - fileContent: - description: '__Note:__ Available only for Assist action' - type: boolean - default: 'false' otherLanguageTranslations: properties: isEnabled: @@ -21146,7 +21031,6 @@ components: type: string example: 'Pre-translate prompt' action: - description: '__Note:__ `assist` is deprecated' type: string example: pre_translate aiProviderId: @@ -21217,8 +21101,6 @@ components: oneOf: - $ref: '#/components/schemas/ai.prompt.config.basic_mode.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.config.basic_mode.assist' - $ref: '#/components/schemas/ai.prompt.config.basic_mode.alignment' - @@ -21240,8 +21122,6 @@ components: oneOf: - $ref: '#/components/schemas/ai.prompt.config.basic_mode.pre_translate' - - - $ref: '#/components/schemas/ai.prompt.config.basic_mode.assist' - $ref: '#/components/schemas/ai.prompt.config.basic_mode.qa_check' - @@ -21433,11 +21313,9 @@ components: - properties: action: - description: '__Note:__ `assist` is deprecated' type: string enum: - pre_translate - - assist - alignment - qa_check ai.provider.crowdin_configuration.actionRule: @@ -21449,11 +21327,9 @@ components: - properties: action: - description: '__Note:__ `assist` is deprecated' type: string enum: - pre_translate - - assist - qa_check ai.provider.credentials.open_ai: title: OpenAI @@ -22042,9 +21918,9 @@ components: format: json-pointer enum: - /preTranslationAiPromptId - - /assistActionAiPromptId - /editorSuggestionAiPromptId - - /shortcuts + - /alignmentActionAiPromptId + - /qaCheckActionAiPromptId type: object discriminator: propertyName: op @@ -22095,10 +21971,6 @@ components: preTranslationAiPromptId: type: integer example: 2 - assistActionAiPromptId: - type: integer - example: 2 - deprecated: true editorSuggestionAiPromptId: type: integer example: 5 @@ -22110,27 +21982,6 @@ components: type: integer example: 8 nullable: true - shortcuts: - type: array - items: - type: object - oneOf: - - - $ref: '#/components/schemas/AiSettingsShortcuts' - type: object - AiSettingsShortcuts: - properties: - name: - description: 'Shortcut name' - type: string - example: 'My first shortcut' - prompt: - description: 'Shortcut prompt' - type: string - example: 'Make translation shorter' - enabled: - type: boolean - deprecated: true type: object AiTranslateForm: required: @@ -22388,36 +22239,6 @@ components: type: object iframe: type: object - AiToolCallWidgetsModule: - title: 'AI Tool Call Widgets Module' - type: object - allOf: - - - $ref: '#/components/schemas/AiToolCallsModule' - - - properties: - iframe: - type: object - AiToolCallsModule: - title: 'AI Provider Module' - type: object - allOf: - - - $ref: '#/components/schemas/Module' - - - properties: - identifier: - type: string - example: example-application - url: - type: string - example: /ai-tools - toolType: - type: string - enum: - - function - function: - type: object ApplicationInstallationResponseModel: title: 'Application Installation' description: 'Application Installation Response Model' @@ -24428,6 +24249,29 @@ components: - fr nullable: true type: object + EnterpriseBundleExportForm: + properties: + targetLanguageIds: + description: "Specify target languages for export. Get via [List Supported Languages](#operation/api.languages.getMany)\n\n * Leave this field empty to export all target languages" + type: array + items: + type: string + example: uk + skipUntranslatedStrings: + description: 'Defines whether to export only translated strings' + type: boolean + example: false + exportWithMinApprovalsCount: + description: "Defines whether to export only strings with a minimum number of approvals\n\n__Note:__ value greater than `0` can't be used with `exportStringsThatPassedWorkflow=true` in same request" + type: integer + example: 0 + exportStringsThatPassedWorkflow: + description: "Defines whether to export only strings that passed workflow\n\n__Note:__ `true` value can't be used with `exportWithMinApprovalsCount > 0` in same request or in projects without an assigned workflow" + type: boolean + example: true + type: object + x-doc-sections: + - string-based BundleCollectionResource: description: 'Bundle Collection Resource' type: object @@ -24444,8 +24288,8 @@ components: $ref: '#/components/schemas/BundleResource' pagination: $ref: '#/components/schemas/Pagination' - BundleExportResource: - description: 'Bundle Export Resource' + BundleResource: + description: 'Bundle Resource' type: object allOf: - @@ -24453,9 +24297,9 @@ components: - properties: data: - $ref: '#/components/schemas/BundleExport' - BundleResource: - description: 'Bundle Resource' + $ref: '#/components/schemas/Bundle' + EnterpriseBundleExportResource: + description: 'Bundle Export Resource' type: object allOf: - @@ -24463,46 +24307,7 @@ components: - properties: data: - $ref: '#/components/schemas/Bundle' - BundleExport: - properties: - identifier: - type: string - example: 50fb3506-4127-4ba8-8296-f97dc7e3e0c3 - status: - type: string - example: finished - progress: - description: 'in percentages' - type: integer - example: 100 - attributes: - properties: - bundleId: - type: integer - example: 38 - type: object - createdAt: - type: string - format: date-time - example: '2019-09-23T11:26:54+00:00' - updatedAt: - type: string - format: date-time - example: '2019-09-23T11:26:54+00:00' - startedAt: - type: string - format: date-time - example: '2019-09-23T11:26:54+00:00' - finishedAt: - type: string - format: date-time - example: '2019-09-23T11:26:54+00:00' - eta: - type: string - example: '1 second' - deprecated: true - type: object + $ref: '#/components/schemas/BundleExport' Bundle: title: Bundle properties: @@ -24591,6 +24396,61 @@ components: format: date-time example: '2019-09-20T12:22:20+00:00' type: object + BundleExport: + properties: + identifier: + type: string + example: 50fb3506-4127-4ba8-8296-f97dc7e3e0c3 + status: + type: string + example: finished + progress: + description: 'in percentages' + type: integer + example: 100 + attributes: + properties: + bundleId: + type: integer + example: 38 + targetLanguageIds: + type: array + items: + type: string + example: uk + skipUntranslatedStrings: + type: boolean + example: false + exportWithMinApprovalsCount: + type: integer + example: 0 + exportStringsThatPassedWorkflow: + type: boolean + example: true + type: object + createdAt: + type: string + format: date-time + example: '2019-09-23T11:26:54+00:00' + updatedAt: + type: string + format: date-time + example: '2019-09-23T11:26:54+00:00' + startedAt: + type: string + format: date-time + example: '2019-09-23T11:26:54+00:00' + nullable: true + finishedAt: + type: string + format: date-time + example: '2019-09-23T11:26:54+00:00' + nullable: true + eta: + type: string + example: '1 second' + deprecated: true + type: object ClientCollectionResource: description: 'Clients Collection' type: object @@ -26746,7 +26606,7 @@ components: nullable: true type: object ProjectFileType: - description: "Values available:\n- empty value or 'auto' — Try to detect file type by extension or MIME type\n- 'android' — Android (*.xml)\n- 'macosx' — Mac OS X / iOS (*.strings)\n- 'resx' — .NET, Windows Phone (*.resx)\n- 'properties' — Java (*.properties)\n- 'gettext' — GNU GetText (*.po, *.pot)\n- 'yaml' — Ruby On Rails (*.yaml, *.yml)\n- 'php' — Hypertext Preprocessor (*.php)\n- 'json' — Generic JSON (*.json)\n- 'xml' — Generic XML (*.xml)\n- 'ini' — Generic INI (*.ini)\n- 'rc' — Windows Resources (*.rc)\n- 'resw' — Windows 8 Metro (*.resw)\n- 'resjson' — Windows 8 Metro (*.resjson)\n- 'qtts' — Nokia Qt (*.ts)\n- 'joomla' — Joomla localizable resources (*.ini)\n- 'chrome' — Google Chrome Extension (*.json)\n- 'dtd' — Mozilla DTD (*.dtd)\n- 'dklang' — Delphi DKLang (*.dklang)\n- 'flex' — Flex (*.properties)\n- 'nsh' — NSIS Installer Resources (*.nsh)\n- 'wxl' — WiX Installer (*.wxl)\n- 'xliff' — XLIFF (*.xliff, *.xlf)\n- 'xliff_two' — XLIFF 2.0 (*.xliff, *.xlf)\n- 'html' — HTML (*.html, *.htm, *.xhtml, *.xhtm, *.xht, *.hbs, *.liquid)\n- 'haml' — Haml (*.haml)\n- 'txt' — Plain Text (*.txt)\n- 'csv' — Comma Separated Values (*.csv)\n- 'md' — Markdown (*.md, *.text, *.markdown...)\n- 'flsnp' — MadCap Flare (*.flnsp, .flpgpl .fltoc)\n- 'fm_html' — Jekyll HTML (*.html)\n- 'fm_md' — Jekyll Markdown (*.md)\n- 'mediawiki' — MediaWiki (*.wiki, *.wikitext, *.mediawiki)\n- 'docx' — Microsoft Office, OpenOffice.org Documents, Adobe InDesign, Adobe FrameMaker(*.docx, *.dotx, *.docm, *.dotm, *.xlsx, *.xltx, *.xlsm, *.xltm, *.pptx, *.potx, *.ppsx, *.pptm, *.potm, *.ppsm, *.odt, *.ods, *.odg, *.odp, *.imdl, *.mif)\n- 'xlsx' — Microsoft Excel (*.xlsx)\n- 'sbv' — Youtube .sbv (*.sbv)\n- 'properties_play' — Play Framework\n- 'properties_xml' — Java Application (*.xml)\n- 'maxthon' — Maxthon Browser (*.ini)\n- 'go_json' — Go (*.gotext.json)\n- 'dita' — DITA Document (*.dita, *.ditamap)\n- 'mif' — Adobe FrameMaker (*.mif)\n- 'idml' — Adobe InDesign (*.idml)\n- 'stringsdict' — iOS (*.stringsdict)\n- 'plist' — Mac OS property list (*.plist)\n- 'vtt' — Video Subtitling and WebVTT (*.vtt)\n- 'vdf' — Steamworks Localization Valve Data File (*.vdf)\n- 'srt' — SubRip .srt (*.srt)\n- 'stf' — Salesforce (*.stf)\n- 'toml' — Toml (*.toml)\n- 'contentful_rt' — Contentful (*.json)\n- 'svg' — SVG (*.svg)\n- 'js' — JavaScript (*.js)\n- 'coffee' — CoffeeScript (*.coffee)\n- 'nestjs_i18n' - NestJS i18n\n- 'loc' — LOC (*.loc)\n\n__Note__: Use `docx` type to import each cell as a separate source string for XLSX file" + description: "Values available:\n- empty value or 'auto' — Try to detect file type by extension or MIME type\n- 'android' — Android (*.xml)\n- 'macosx' — Mac OS X / iOS (*.strings)\n- 'resx' — .NET, Windows Phone (*.resx)\n- 'properties' — Java (*.properties)\n- 'gettext' — GNU GetText (*.po, *.pot)\n- 'yaml' — Ruby On Rails (*.yaml, *.yml)\n- 'php' — Hypertext Preprocessor (*.php)\n- 'json' — Generic JSON (*.json)\n- 'xml' — Generic XML (*.xml)\n- 'ini' — Generic INI (*.ini)\n- 'rc' — Windows Resources (*.rc)\n- 'resw' — Windows 8 Metro (*.resw)\n- 'resjson' — Windows 8 Metro (*.resjson)\n- 'qtts' — Nokia Qt (*.ts)\n- 'joomla' — Joomla localizable resources (*.ini)\n- 'chrome' — Google Chrome Extension (*.json)\n- 'dtd' — Mozilla DTD (*.dtd)\n- 'dklang' — Delphi DKLang (*.dklang)\n- 'flex' — Flex (*.properties)\n- 'nsh' — NSIS Installer Resources (*.nsh)\n- 'wxl' — WiX Installer (*.wxl)\n- 'xliff' — XLIFF (*.xliff, *.xlf)\n- 'xliff_two' — XLIFF 2.0 (*.xliff, *.xlf)\n- 'html' — HTML (*.html, *.htm, *.xhtml, *.xhtm, *.xht, *.hbs, *.liquid)\n- 'haml' — Haml (*.haml)\n- 'txt' — Plain Text (*.txt)\n- 'csv' — Comma Separated Values (*.csv)\n- 'md' — Markdown (*.md, *.text, *.markdown...)\n- 'flsnp' — MadCap Flare (*.flnsp, .flpgpl .fltoc)\n- 'fm_html' — Jekyll HTML (*.html)\n- 'fm_md' — Jekyll Markdown (*.md)\n- 'mediawiki' — MediaWiki (*.wiki, *.wikitext, *.mediawiki)\n- 'docx' — Microsoft Office, OpenOffice.org Documents, Adobe InDesign, Adobe FrameMaker(*.docx, *.dotx, *.docm, *.dotm, *.xlsx, *.xltx, *.xlsm, *.xltm, *.pptx, *.potx, *.ppsx, *.pptm, *.potm, *.ppsm, *.odt, *.ods, *.odg, *.odp, *.imdl, *.mif)\n- 'vsdx' — Microsoft Visio (*.vsdx, *.vsdm)\n- 'xlsx' — Microsoft Excel (*.xlsx)\n- 'sbv' — Youtube .sbv (*.sbv)\n- 'properties_play' — Play Framework\n- 'properties_xml' — Java Application (*.xml)\n- 'maxthon' — Maxthon Browser (*.ini)\n- 'go_json' — Go (*.gotext.json)\n- 'dita' — DITA Document (*.dita, *.ditamap)\n- 'mif' — Adobe FrameMaker (*.mif)\n- 'idml' — Adobe InDesign (*.idml)\n- 'stringsdict' — iOS (*.stringsdict)\n- 'plist' — Mac OS property list (*.plist)\n- 'vtt' — Video Subtitling and WebVTT (*.vtt)\n- 'vdf' — Steamworks Localization Valve Data File (*.vdf)\n- 'srt' — SubRip .srt (*.srt)\n- 'stf' — Salesforce (*.stf)\n- 'toml' — Toml (*.toml)\n- 'contentful_rt' — Contentful (*.json)\n- 'svg' — SVG (*.svg)\n- 'js' — JavaScript (*.js)\n- 'coffee' — CoffeeScript (*.coffee)\n- 'nestjs_i18n' - NestJS i18n\n- 'loc' — LOC (*.loc)\n\n__Note__: Use `docx` type to import each cell as a separate source string for XLSX file" type: string default: auto enum: @@ -26786,6 +26646,7 @@ components: - fm_md - mediawiki - docx + - vsdx - xlsx - sbv - properties_play @@ -27018,6 +26879,28 @@ components: default: null example: 61 type: object + VsdxFileImportOptions: + title: 'Vsdx File Import Options' + properties: + cleanTagsAggressively: + description: 'When checked, strips additional formatting tags related to text spacing.' + type: boolean + default: false + translateHyperlinkUrls: + description: 'When checked, exposes hidden hyperlinks for translation.' + type: boolean + default: false + contentSegmentation: + description: 'Defines whether to split long texts into smaller text segments.' + type: boolean + default: true + srxStorageId: + description: "Storage Identifier. Get via [List Storages](#operation/api.storages.getMany).\n\n Storage identifier of the SRX segmentation rules file. Read more about [Custom Segmentation](https://support.crowdin.com/custom-segmentation/#segmentation-examples)." + type: integer + format: int64 + default: null + example: 61 + type: object HtmlFileImportOptions: title: 'Html File Import Options' properties: @@ -27599,6 +27482,8 @@ components: $ref: '#/components/schemas/WebXmlFileImportOptions' - $ref: '#/components/schemas/DocxFileImportOptions' + - + $ref: '#/components/schemas/VsdxFileImportOptions' - $ref: '#/components/schemas/HtmlFileImportOptions' - @@ -27636,6 +27521,8 @@ components: $ref: '#/components/schemas/WebXmlFileImportOptions' - $ref: '#/components/schemas/DocxFileUpdateOptions' + - + $ref: '#/components/schemas/VsdxFileImportOptions' - $ref: '#/components/schemas/HtmlFileUpdateOptions' - @@ -27991,6 +27878,8 @@ components: $ref: '#/components/schemas/XmlFileImportOptionsResponseModel' - $ref: '#/components/schemas/DocxFileImportOptionsResponseModel' + - + $ref: '#/components/schemas/VsdxFileImportOptionsResponseModel' - $ref: '#/components/schemas/SegmentationImportOptionsResponseModel' - @@ -28324,6 +28213,26 @@ components: type: boolean example: true type: object + VsdxFileImportOptionsResponseModel: + title: 'VSDX File Import Options' + properties: + cleanTagsAggressively: + description: 'When checked, strips additional formatting tags related to text spacing.' + type: boolean + default: false + translateHyperlinkUrls: + description: 'When checked, exposes hidden hyperlinks for translation.' + type: boolean + default: false + contentSegmentation: + description: 'Defines whether to split long texts into smaller text segments.' + type: boolean + default: true + customSegmentation: + description: 'Specifies whether custom segmentation rules are used.' + type: boolean + default: false + type: object WebXmlFileImportOptionsResponseModel: title: 'WebXml File Import Options' properties: @@ -31126,6 +31035,10 @@ components: type: array items: type: integer + customInstruction: + description: "Custom instruction for AI pre-translation. This instruction will be appended to the AI prompt text.\n\n__Note:__ Available only for AI pre-translation method" + type: string + maxLength: 10000 type: object FallbackLanguagesScheme: title: 'Fallback Languages' @@ -31219,6 +31132,10 @@ components: description: 'Source language identifier. Get via [Project Target Languages](#operation/api.projects.get)' type: string example: en + customInstruction: + description: "Custom instruction for AI pre-translation. This instruction will be appended to the AI prompt text.\n\n__Note:__ Available only for AI pre-translation method" + type: string + maxLength: 10000 type: object CrowdinPreTranslationCollectionResource: description: 'Pre-Translation Collection Resource' @@ -31713,7 +31630,6 @@ components: - '/fields/{fieldSlug}' - /tm - /preTranslationAiPromptId - - /assistActionAiPromptId - /editorSuggestionAiPromptId - /alignmentActionAiPromptId - /qaCheckActionAiPromptId @@ -32400,11 +32316,6 @@ components: type: integer example: 11 deprecated: true - assistActionAiPromptId: - description: 'AI Prompt ID to be used as prompt for AI Assist action in Editor' - type: integer - example: 12 - deprecated: true editorSuggestionAiPromptId: description: 'AI Prompt ID to be used as prompt for AI Suggestion action in Editor' type: integer @@ -33892,11 +33803,6 @@ components: example: 2 nullable: true deprecated: true - assistActionAiPromptId: - type: integer - example: 11 - nullable: true - deprecated: true editorSuggestionAiPromptId: type: integer example: 3 @@ -34615,6 +34521,31 @@ components: default: null nullable: true type: object + VsdxFileFormatSettingsResponse: + title: 'VSDX file format settings' + properties: + cleanTagsAggressively: + description: 'When checked, strips additional formatting tags related to text spacing.' + type: boolean + default: false + translateHyperlinkUrls: + description: 'When checked, exposes hidden hyperlinks for translation.' + type: boolean + default: false + contentSegmentation: + description: "Defines whether to split long texts into smaller text segments.\n\nImportant! This option disables the possibility to upload existing translations for XML files when enabled." + type: boolean + default: true + customSegmentation: + description: 'Specifies whether custom segmentation rules are used.' + type: boolean + default: false + exportPattern: + description: "File format export pattern. Defines file name and path in resulting translations bundle\n\nNote: Can't contain `: * ? \" < > |` symbols" + type: string + default: null + nullable: true + type: object IdmlFileFormatSettingsResponse: title: 'Idml file format settings' properties: @@ -34745,10 +34676,6 @@ components: type: integer example: 2 deprecated: true - assistActionAiPromptId: - type: integer - example: 2 - deprecated: true editorSuggestionAiPromptId: type: integer example: 2 @@ -35264,7 +35191,7 @@ components: items: { type: string } GroupTopMembers: title: 'Group Top Members' - description: 'Generate a list of translators based on a specific period of time to see who contributed the most to your project’s translation.' + description: "Generate a list of translators based on a specific period of time to see who contributed the most to your project's translation." required: - name - schema @@ -35769,7 +35696,7 @@ components: - project example: user typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -35835,7 +35762,7 @@ components: - project example: user typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -35897,7 +35824,7 @@ components: - project example: user typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -35963,7 +35890,7 @@ components: - project example: user typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -36035,7 +35962,7 @@ components: - project example: user typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -36354,7 +36281,7 @@ components: type: integer example: 13 typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -36940,7 +36867,7 @@ components: type: object TopMembers: title: 'Top Members' - description: 'Generate a list of translators based on a specific period of time to see who contributed the most to your project’s translation.' + description: "Generate a list of translators based on a specific period of time to see who contributed the most to your project's translation." required: - name - schema @@ -37652,7 +37579,7 @@ components: - type example: user typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -37711,7 +37638,7 @@ components: - type example: user typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -37766,7 +37693,7 @@ components: - type example: user typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -37825,7 +37752,7 @@ components: - type example: user typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -37890,7 +37817,7 @@ components: - type example: user typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -38190,7 +38117,7 @@ components: type: integer example: 13 typeTasks: - description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" + description: "Task type:\n * 0 - translate\n * 1 - proofread\n * 2 - translate by vendor\n * 3 - proofread by vendor" type: integer enum: - 0 @@ -38836,7 +38763,7 @@ components: items: $ref: '#/components/schemas/user-post-edit-report-settings-template-form.individual-rate' netRateSchemes: - description: "Net Rate Schemes (Percentage paid of full translation rate)\n *\n * __Note:__ A new translation will be included in the report at the lowest rate if multiple scheme categories can be applied to the translation" + description: "Net Rate Schemes (Percentage paid of full translation rate)\n\n__Note:__ A new translation will be included in the report at the lowest rate if multiple scheme categories can be applied to the translation" type: object allOf: - @@ -39078,7 +39005,7 @@ components: items: $ref: '#/components/schemas/post-edit-report-settings-template.individual-rate' netRateSchemes: - description: "Net Rate Schemes (Percentage paid of full translation rate)\n *\n * __Note:__ A new translation will be included in the report at the lowest rate if multiple scheme categories can be applied to the translation" + description: "Net Rate Schemes (Percentage paid of full translation rate)\n\n__Note:__ A new translation will be included in the report at the lowest rate if multiple scheme categories can be applied to the translation" type: object allOf: - @@ -39230,6 +39157,7 @@ components: description: 'Generate Group Report Response Model' properties: identifier: + description: 'Class GroupReportResponseModel' type: string example: 50fb3506-4127-4ba8-8296-f97dc7e3e0c3 status: @@ -39433,7 +39361,7 @@ components: items: $ref: '#/components/schemas/user-post-edit-report-settings-template.individual-rate' netRateSchemes: - description: "Net Rate Schemes (Percentage paid of full translation rate)\n *\n *__Note:__ A new translation will be included in the report at the lowest rate if multiple scheme categories can be applied to the translation" + description: "Net Rate Schemes (Percentage paid of full translation rate)\n\n__Note:__ A new translation will be included in the report at the lowest rate if multiple scheme categories can be applied to the translation" type: object allOf: - @@ -43440,9 +43368,11 @@ components: - /excludeLabelMatchRule - /fields - '/fields/{fieldSlug}' + - /resetScope - /generateCostEstimate - /generateTranslationCost - /reportSettingsTemplateId + - /batchId x-doc-sections: - string-based type: object @@ -43790,6 +43720,7 @@ components: example: true type: object EnterpriseTaskCreateForm: + title: 'Task Create Form' type: object oneOf: - @@ -43797,7 +43728,7 @@ components: - $ref: '#/components/schemas/EnterpriseTaskByStringIds' EnterpriseTaskBySourceIds: - title: CreateByBranchIdsForm + title: 'Create By Branch Ids Form' type: object allOf: - @@ -43805,7 +43736,6 @@ components: x-doc-sections: - string-based EnterpriseTaskBySourceIdsForm: - title: CreateBySourcesForm required: - title - languageId @@ -43950,9 +43880,14 @@ components: - $ref: '#/components/schemas/EnterpriseAdditionalFields' nullable: true + batchId: + description: 'Task Batch Identifier. Get via [List Tasks](#operation/api.projects.tasks.getMany). Allows grouping tasks into a batch' + type: integer + example: 1 + nullable: true type: object EnterpriseTaskByStringIds: - title: CreateByStringIdsForm + title: 'Create By String Ids Form' required: - title - languageId @@ -44067,8 +44002,14 @@ components: - $ref: '#/components/schemas/EnterpriseAdditionalFields' nullable: true + batchId: + description: 'Task Batch Identifier. Get via [List Tasks](#operation/api.projects.tasks.getMany). Allows grouping tasks into a batch' + type: integer + example: 1 + nullable: true type: object EnterpriseVendorTaskCreateForm: + title: 'Vendor Task Create Form' type: object oneOf: - @@ -44076,7 +44017,7 @@ components: - $ref: '#/components/schemas/EnterpriseVendorTaskByStringIds' EnterpriseVendorTaskBySourceIds: - title: CreateByBranchIdsForm + title: 'Create By Branch Ids Form' type: object allOf: - @@ -44084,7 +44025,6 @@ components: x-doc-sections: - string-based EnterpriseVendorTaskBySourceIdsForm: - title: CreateBySourcesForm required: - workflowStepId - title @@ -44201,7 +44141,7 @@ components: nullable: true type: object EnterpriseVendorTaskByStringIds: - title: CreateByStringIdsForm + title: 'Create By String Ids Form' required: - workflowStepId - title @@ -44302,6 +44242,7 @@ components: nullable: true type: object EnterprisePendingTaskCreateForm: + title: 'Pending Task Create Form' required: - precedingTaskId - title @@ -44311,10 +44252,11 @@ components: type: integer example: '1' type: - description: "Task type:\n * 1 - proofread\n\n__Note:__ One of fields `type` or `workflowStepId` is required. Both cannot be provided simultaneously" + description: "Task type:\n * 1 - proofread\n * 3 - proofread by vendor (requires `vendor` field)\n\n__Note:__ One of fields `type` or `workflowStepId` is required. Both cannot be provided simultaneously" type: integer enum: - 1 + - 3 workflowStepId: description: "Task workflow step id\n\n__Note:__ One of fields `type` or `workflowStepId` is required. Both cannot be provided simultaneously" type: integer @@ -44324,6 +44266,10 @@ components: description: description: 'Task description' type: string + vendor: + description: 'Vendor identifier. Required when `type` is `3`. Get via [List Vendors](#operation/api.projects.vendors.getMany)' + type: string + nullable: true assignees: description: 'Task assigned users' type: array