@crowdin/crowdin-api-client - npm Package Compare versions

Comparing version 1.20.0 to 1.20.1

out/projectsGroups/index.d.ts

@@ -1,2 +0,2 @@
-import { BooleanInt, CrowdinApi, PaginationOptions, PatchRequest, ResponseList, ResponseObject } from '../core';
+import { BooleanInt, CrowdinApi, DownloadLink, PaginationOptions, PatchRequest, ResponseList, ResponseObject } from '../core';
 import { LanguagesModel } from '../languages';
@@ -82,2 +82,45 @@ /**
     editProject(projectId: number, request: PatchRequest[]): Promise<ResponseObject<ProjectsGroupsModel.Project | ProjectsGroupsModel.ProjectSettings>>;
+    /**
+     * @param projectId project identifier
+     * @param fileFormatSettingsId file format settings identifier
+     * @see https://developer.crowdin.com/api/v2/#operation/api.projects.file-format-settings.custom-segmentations.get
+     */
+    downloadProjectFileFormatSettingsCustomSegmentation(projectId: number, fileFormatSettingsId: number): Promise<ResponseObject<DownloadLink>>;
+    /**
+     * @param projectId project identifier
+     * @param fileFormatSettingsId file format settings identifier
+     * @see https://developer.crowdin.com/api/v2/#operation/api.projects.file-format-settings.custom-segmentations.delete
+     */
+    resetProjectFileFormatSettingsCustomSegmentation(projectId: number, fileFormatSettingsId: number): Promise<ResponseObject<DownloadLink>>;
+    /**
+     * @param projectId project identifier
+     * @param options optional parameters for the request
+     * @see https://developer.crowdin.com/api/v2/#operation/api.projects.file-format-settings.getMany
+     */
+    listProjectFileFormatSettings(projectId: number, options?: PaginationOptions): Promise<ResponseList<ProjectsGroupsModel.ProjectFileFormatSettings>>;
+    /**
+     * @param projectId project identifier
+     * @param request request body
+     * @see https://developer.crowdin.com/api/v2/#operation/api.projects.file-format-settings.post
+     */
+    addProjectFileFormatSettings(projectId: number, request: ProjectsGroupsModel.AddProjectFileFormatSettingsRequest): Promise<ResponseObject<ProjectsGroupsModel.ProjectFileFormatSettings>>;
+    /**
+     * @param projectId project identifier
+     * @param fileFormatSettingsId file format settings identifier
+     * @see https://developer.crowdin.com/api/v2/#operation/api.projects.file-format-settings.get
+     */
+    getProjectFileFormatSettings(projectId: number, fileFormatSettingsId: number): Promise<ResponseObject<ProjectsGroupsModel.ProjectFileFormatSettings>>;
+    /**
+     * @param projectId project identifier
+     * @param fileFormatSettingsId file format settings identifier
+     * @see https://developer.crowdin.com/api/v2/#operation/api.projects.file-format-settings.delete
+     */
+    deleteProjectFileFormatSettings(projectId: number, fileFormatSettingsId: number): Promise<void>;
+    /**
+     * @param projectId project identifier
+     * @param fileFormatSettingsId file format settings identifier
+     * @param request request body
+     * @see https://developer.crowdin.com/api/v2/#operation/api.projects.file-format-settings.patch
+     */
+    editProjectFileFormatSettings(projectId: number, fileFormatSettingsId: number, request: PatchRequest[]): Promise<ResponseObject<ProjectsGroupsModel.ProjectFileFormatSettings>>;
 }
@@ -300,2 +343,39 @@ export declare namespace ProjectsGroupsModel {
     }
+    type Settings = PropertyFileFormatSettings | CommonFileFormatSettings | XmlFileFormatSettings | DocxFileFormatSettings;
+    interface ProjectFileFormatSettings {
+        id: number;
+        name: string;
+        format: string;
+        extensions: string[];
+        settings: Settings;
+        createdAt: string;
+        updatedAt: string;
+    }
+    interface AddProjectFileFormatSettingsRequest {
+        format: string;
+        settings: Settings;
+    }
+    interface PropertyFileFormatSettings {
+        escapeQuotes?: 0 | 1 | 2 | 3;
+        escapeSpecialCharacters?: 0 | 1;
+        exportPattern?: string;
+    }
+    interface CommonFileFormatSettings {
+        contentSegmentation?: boolean;
+        srxStorageId?: number;
+        exportPattern?: string;
+    }
+    interface XmlFileFormatSettings extends CommonFileFormatSettings {
+        translateContent?: boolean;
+        translateAttributes?: boolean;
+        translatableElements?: string[];
+    }
+    interface DocxFileFormatSettings extends CommonFileFormatSettings {
+        cleanTagsAggressively?: boolean;
+        translateHiddenText?: boolean;
+        translateHyperlinkUrls?: boolean;
+        translateHiddenRowsAndColumns?: boolean;
+        importNotes?: boolean;
+        importHiddenSlides?: boolean;
+    }
 }

out/projectsGroups/index.js

@@ -108,2 +108,66 @@ "use strict";
     }
+    /**
+     * @param projectId project identifier
+     * @param fileFormatSettingsId file format settings identifier
+     * @see https://developer.crowdin.com/api/v2/#operation/api.projects.file-format-settings.custom-segmentations.get
+     */
+    downloadProjectFileFormatSettingsCustomSegmentation(projectId, fileFormatSettingsId) {
+        const url = `${this.url}/projects/${projectId}/file-format-settings/${fileFormatSettingsId}/custom-segmentations`;
+        return this.get(url, this.defaultConfig());
+    }
+    /**
+     * @param projectId project identifier
+     * @param fileFormatSettingsId file format settings identifier
+     * @see https://developer.crowdin.com/api/v2/#operation/api.projects.file-format-settings.custom-segmentations.delete
+     */
+    resetProjectFileFormatSettingsCustomSegmentation(projectId, fileFormatSettingsId) {
+        const url = `${this.url}/projects/${projectId}/file-format-settings/${fileFormatSettingsId}/custom-segmentations`;
+        return this.delete(url, this.defaultConfig());
+    }
+    /**
+     * @param projectId project identifier
+     * @param options optional parameters for the request
+     * @see https://developer.crowdin.com/api/v2/#operation/api.projects.file-format-settings.getMany
+     */
+    listProjectFileFormatSettings(projectId, options) {
+        const url = `${this.url}/projects/${projectId}/file-format-settings`;
+        return this.getList(url, options === null || options === void 0 ? void 0 : options.limit, options === null || options === void 0 ? void 0 : options.offset);
+    }
+    /**
+     * @param projectId project identifier
+     * @param request request body
+     * @see https://developer.crowdin.com/api/v2/#operation/api.projects.file-format-settings.post
+     */
+    addProjectFileFormatSettings(projectId, request) {
+        const url = `${this.url}/projects/${projectId}/file-format-settings`;
+        return this.post(url, request, this.defaultConfig());
+    }
+    /**
+     * @param projectId project identifier
+     * @param fileFormatSettingsId file format settings identifier
+     * @see https://developer.crowdin.com/api/v2/#operation/api.projects.file-format-settings.get
+     */
+    getProjectFileFormatSettings(projectId, fileFormatSettingsId) {
+        const url = `${this.url}/projects/${projectId}/file-format-settings/${fileFormatSettingsId}`;
+        return this.get(url, this.defaultConfig());
+    }
+    /**
+     * @param projectId project identifier
+     * @param fileFormatSettingsId file format settings identifier
+     * @see https://developer.crowdin.com/api/v2/#operation/api.projects.file-format-settings.delete
+     */
+    deleteProjectFileFormatSettings(projectId, fileFormatSettingsId) {
+        const url = `${this.url}/projects/${projectId}/file-format-settings/${fileFormatSettingsId}`;
+        return this.delete(url, this.defaultConfig());
+    }
+    /**
+     * @param projectId project identifier
+     * @param fileFormatSettingsId file format settings identifier
+     * @param request request body
+     * @see https://developer.crowdin.com/api/v2/#operation/api.projects.file-format-settings.patch
+     */
+    editProjectFileFormatSettings(projectId, fileFormatSettingsId, request) {
+        const url = `${this.url}/projects/${projectId}/file-format-settings/${fileFormatSettingsId}`;
+        return this.patch(url, request, this.defaultConfig());
+    }
 }
@@ -110,0 +174,0 @@ exports.ProjectsGroups = ProjectsGroups;

out/sourceFiles/index.d.ts

@@ -267,3 +267,3 @@ import { CrowdinApi, DownloadLink, PaginationOptions, PatchRequest, ResponseList, ResponseObject } from '../core';
         path: string;
-        importOptions: SpreadsheetImportOptions | XmlImportOptions | OtherImportOptions;
+        importOptions: SpreadsheetImportOptions | XmlImportOptions | OtherImportOptions | DocxFileImportOptions;
         exportOptions: GeneralExportOptions | PropertyExportOptions;
@@ -281,3 +281,3 @@ createdAt: string;
         type?: FileType;
-        importOptions?: SpreadsheetImportOptions | XmlImportOptions | OtherImportOptions;
+        importOptions?: SpreadsheetImportOptions | XmlImportOptions | OtherImportOptions | DocxFileImportOptions;
         exportOptions?: GeneralExportOptions | PropertyExportOptions;
@@ -290,3 +290,3 @@ attachLabelIds?: number[];
         updateOption?: UpdateOption;
-        importOptions?: SpreadsheetImportOptions | XmlImportOptions | OtherImportOptions;
+        importOptions?: SpreadsheetImportOptions | XmlImportOptions | OtherImportOptions | DocxFileImportOptions;
         exportOptions?: GeneralExportOptions | PropertyExportOptions;
@@ -334,2 +334,12 @@ attachLabelIds?: number[];
     }
+    interface DocxFileImportOptions {
+        cleanTagsAggressively: boolean;
+        translateHiddenText: boolean;
+        translateHyperlinkUrls: boolean;
+        translateHiddenRowsAndColumns: boolean;
+        importNotes: boolean;
+        importHiddenSlides: boolean;
+        contentSegmentation: boolean;
+        srxStorageId: number;
+    }
     interface OtherImportOptions {
@@ -336,0 +346,0 @@ contentSegmentation: boolean;

package.json

 {
     "name": "@crowdin/crowdin-api-client",
-    "version": "1.20.0",
+    "version": "1.20.1",
     "description": "JavaScript library for Crowdin API v2.",
@@ -5,0 +5,0 @@ "main": "out/index.js",

README.md

@@ -1,2 +0,2 @@
-[<p align='center'><img src='https://support.crowdin.com/assets/logos/crowdin-dark-symbol.png' data-canonical-src='https://support.crowdin.com/assets/logos/crowdin-dark-symbol.png' width='200' height='200' align='center'/></p>](https://crowdin.com)
+[<p align='center'><img src='https://support.crowdin.com/assets/logos/crowdin-dark-symbol.png' data-canonical-src='https://support.crowdin.com/assets/logos/crowdin-dark-symbol.png' width='150' height='150' align='center'/></p>](https://crowdin.com)
 
@@ -3,0 +3,0 @@ # Crowdin JavaScript client [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fcrowdin%2Fcrowdin-api-client-js&text=The%20Crowdin%20JavaScript%20client%20is%20a%20lightweight%20interface%20to%20the%20Crowdin%20API%20that%20works%20in%20any%20JavaScript%20environment)&nbsp;[![GitHub Repo stars](https://img.shields.io/github/stars/crowdin/crowdin-api-client-js?style=social&cacheSeconds=1800)](https://github.com/crowdin/crowdin-api-client-js/stargazers)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

349561

increased by2.27%

Lines of code

7924

increased by1.98%

No dependency changes