api updates (#75)

* api updates * version increment
crowdin · Aug 3, 2020 · 48a1296 · 48a1296
1 parent c3b5a7c
commit 48a1296
Show file tree

Hide file tree

Showing 16 changed files with 139 additions and 26 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@crowdin/crowdin-api-client",
-    "version": "1.8.12",
+    "version": "1.8.13",
     "description": "JavaScript library for Crowdin API v2.",
     "main": "out/index.js",
     "types": "out/index.d.ts",

diff --git a/src/glossaries/index.ts b/src/glossaries/index.ts
@@ -207,17 +207,12 @@ export namespace GlossariesModel {
 
     export interface GlossaryExportStatusAttribute {
         format: string;
-        organizationId: number;
-        glossaryId: number;
     }
 
     export interface GlossaryImportStatusAttribute {
         storageId: number;
         scheme: any;
         firstLineContainsHeader: boolean;
-        organizationId: number;
-        userId: number;
-        glossaryId: number;
     }
 
     export interface GlossaryFile {

diff --git a/src/issues/index.ts b/src/issues/index.ts
@@ -52,9 +52,28 @@ export namespace IssuesModel {
         text: string;
         userId: number;
         stringId: number;
+        user: User;
+        string: string;
         languageId: string;
         type: Type;
         status: Status;
         createdAt: string;
     }
+
+    export interface User {
+        id: number;
+        username: string;
+        fullName: string;
+        avatarUrl: string;
+    }
+
+    export interface String {
+        id: number;
+        text: string;
+        type: string;
+        hasPlurals: boolean;
+        isIcu: boolean;
+        context: string;
+        fileId: number;
+    }
 }
diff --git a/src/reports/index.ts b/src/reports/index.ts
@@ -1,4 +1,4 @@
-import { CrowdinApi, ResponseObject, DownloadLink, Status } from '../core';
+import { CrowdinApi, DownloadLink, ResponseObject, Status } from '../core';
 
 export class Reports extends CrowdinApi {
     /**
@@ -42,8 +42,6 @@ export namespace ReportsModel {
     }
 
     export interface ReportStatusAttributes {
-        organizationId: number;
-        projectId: number;
         format: Format;
         reportName: string;
         schema: any;

diff --git a/src/sourceFiles/index.ts b/src/sourceFiles/index.ts
@@ -384,6 +384,7 @@ export namespace SourceFilesModel {
         revisionId: number;
         status: string;
         priority: Priority;
+        path: string;
         importOptions: SpreadsheetImportOptions | XmlImportOptions | OtherImportOptions;
         exportOptions: GeneralExportOptions | PropertyExportOptions;
         createdAt: string;

diff --git a/src/stringTranslations/index.ts b/src/stringTranslations/index.ts
@@ -8,6 +8,7 @@ export class StringTranslations extends CrowdinApi {
      * @param translationId translation identifier
      * @param limit maximum number of items to retrieve (default 25)
      * @param offset starting offset in the collection (default 0)
+     * @param fileId file identifier
      */
     listTranslationApprovals(
         projectId: number,
@@ -16,11 +17,13 @@ export class StringTranslations extends CrowdinApi {
         translationId?: number,
         limit?: number,
         offset?: number,
+        fileId?: number,
     ): Promise<ResponseList<StringTranslationsModel.Approval>> {
         let url = `${this.url}/projects/${projectId}/approvals`;
         url = this.addQueryParam(url, 'stringId', stringId);
         url = this.addQueryParam(url, 'languageId', languageId);
         url = this.addQueryParam(url, 'translationId', translationId);
+        url = this.addQueryParam(url, 'fileId', fileId);
         return this.getList(url, limit, offset);
     }
 
@@ -154,7 +157,7 @@ export class StringTranslations extends CrowdinApi {
         translationId: number,
     ): Promise<ResponseObject<StringTranslationsModel.StringTranslation>> {
         const url = `${this.url}/projects/${projectId}/translations/${translationId}/restore`;
-        return this.post(url, undefined, this.defaultConfig());
+        return this.put(url, undefined, this.defaultConfig());
     }
 
     /**

diff --git a/src/tasks/index.ts b/src/tasks/index.ts
@@ -1,4 +1,4 @@
-import { BooleanInt, CrowdinApi, PatchRequest, ResponseList, ResponseObject } from '../core';
+import { BooleanInt, CrowdinApi, DownloadLink, PatchRequest, ResponseList, ResponseObject } from '../core';
 
 export class Tasks extends CrowdinApi {
     /**
@@ -27,6 +27,11 @@ export class Tasks extends CrowdinApi {
         return this.post(url, request, this.defaultConfig());
     }
 
+    exportTaskStrings(projectId: number, taskId: number): Promise<ResponseObject<DownloadLink>> {
+        const url = `${this.url}/projects/${projectId}/tasks/${taskId}/exports`;
+        return this.post(url, undefined, this.defaultConfig());
+    }
+
     /**
      * @param projectId project identifier
      * @param taskId task identifier
@@ -120,7 +125,7 @@ export namespace TasksModel {
     }
 
     export interface CreateTaskRequest {
-        workflowStepId: number;
+        workflowStepId?: number;
         status?: Status;
         title: string;
         description?: string;

diff --git a/src/translationMemory/index.ts b/src/translationMemory/index.ts
@@ -51,6 +51,14 @@ export class TranslationMemory extends CrowdinApi {
         return this.patch(url, request, this.defaultConfig());
     }
 
+    /**
+     * @param tmId tm identifier
+     */
+    clearTm(tmId: number): Promise<void> {
+        const url = `${this.url}/tms/${tmId}/segments`;
+        return this.delete(url, this.defaultConfig());
+    }
+
     /**
      * @param tmId tm identifier
      * @param exportId export identifier
@@ -143,17 +151,13 @@ export namespace TranslationMemoryModel {
         sourceLanguageId: string;
         targetLanguageId: string;
         format: string;
-        tmId: number;
-        userId: number;
     }
 
     export interface ImportTranslationMemoryAttribute {
         tmId: number;
         storageId: number;
         firstLineContainsHeader: number;
         scheme: Scheme;
-        organizationId: number;
-        userId: number;
     }
 
     export enum Format {

diff --git a/src/translationStatus/index.ts b/src/translationStatus/index.ts
@@ -98,7 +98,7 @@ export class TranslationStatus extends CrowdinApi {
         validation?: TranslationStatusModel.Validation,
         languageIds?: string,
     ): Promise<ResponseList<TranslationStatusModel.QaCheck>> {
-        let url = `${this.url}/projects/${projectId}/qa-check`;
+        let url = `${this.url}/projects/${projectId}/qa-checks`;
         url = this.addQueryParam(url, 'category', category);
         url = this.addQueryParam(url, 'validation', validation);
         url = this.addQueryParam(url, 'languageIds', languageIds);

diff --git a/src/translations/index.ts b/src/translations/index.ts
@@ -104,10 +104,22 @@ export class Translations extends CrowdinApi {
         projectId: number,
         languageId: string,
         request: TranslationsModel.UploadTranslationRequest,
-    ): Promise<void> {
+    ): Promise<ResponseObject<TranslationsModel.UploadTranslationResponse>> {
         const url = `${this.url}/projects/${projectId}/translations/${languageId}`;
         return this.post(url, request, this.defaultConfig());
     }
+
+    /**
+     * @param projectId project identifier
+     * @param request request body
+     */
+    exportProjectTranslation(
+        projectId: number,
+        request: TranslationsModel.ExportProjectTranslationRequest,
+    ): Promise<ResponseObject<DownloadLink>> {
+        const url = `${this.url}/projects/${projectId}/translations/exports`;
+        return this.post(url, request, this.defaultConfig());
+    }
 }
 
 export namespace TranslationsModel {
@@ -140,9 +152,6 @@ export namespace TranslationsModel {
         duplicateTranslations: boolean;
         translateUntranslatedOnly: boolean;
         translateWithPerfectMatchOnly: boolean;
-        organizationId: number;
-        projectId: number;
-        userId: number;
     }
 
     export enum Method {
@@ -204,4 +213,22 @@ export namespace TranslationsModel {
         autoApproveImported?: boolean;
         markAddedTranslationsAsDone?: boolean;
     }
+
+    export interface UploadTranslationResponse {
+        projectId: number;
+        storageId: number;
+        languageId: string;
+        fileId: number;
+    }
+
+    export interface ExportProjectTranslationRequest {
+        targetLanguageId: string;
+        format?: string;
+        branchIds?: number[];
+        directoryIds?: number[];
+        fileIds?: number[];
+        skipUntranslatedStrings?: boolean;
+        skipUntranslatedFiles?: boolean;
+        exportWithMinApprovalsCount?: number;
+    }
 }
diff --git a/tests/stringTranslations/api.test.ts b/tests/stringTranslations/api.test.ts
@@ -155,7 +155,7 @@ describe('String Translations API', () => {
                 },
             })
             .reply(200)
-            .post(`/projects/${projectId}/translations/${translationId}/restore`, undefined, {
+            .put(`/projects/${projectId}/translations/${translationId}/restore`, undefined, {
                 reqheaders: {
                     Authorization: `Bearer ${api.token}`,
                 },

diff --git a/tests/tasks/api.test.ts b/tests/tasks/api.test.ts
@@ -15,6 +15,8 @@ describe('Tasks API', () => {
     const workflowStepId = 40;
     const type = TasksModel.Type.TRANSLATE;
 
+    const link = 'test.com';
+
     const limit = 25;
 
     beforeAll(() => {
@@ -57,6 +59,16 @@ describe('Tasks API', () => {
                     id: taskId,
                 },
             })
+            .post(`/projects/${projectId}/tasks/${taskId}/exports`, undefined, {
+                reqheaders: {
+                    Authorization: `Bearer ${api.token}`,
+                },
+            })
+            .reply(200, {
+                data: {
+                    url: link,
+                },
+            })
             .get(`/projects/${projectId}/tasks/${taskId}`, undefined, {
                 reqheaders: {
                     Authorization: `Bearer ${api.token}`,
@@ -157,6 +169,11 @@ describe('Tasks API', () => {
         expect(task.data.id).toBe(taskId);
     });
 
+    it('Export task strings', async () => {
+        const res = await api.exportTaskStrings(projectId, taskId);
+        expect(res.data.url).toBe(link);
+    });
+
     it('Get task', async () => {
         const task = await api.getTask(projectId, taskId);
         expect(task.data.id).toBe(taskId);

diff --git a/tests/translationMemory/api.test.ts b/tests/translationMemory/api.test.ts
@@ -95,6 +95,12 @@ describe('Translation Memory API', () => {
                     name: name,
                 },
             })
+            .delete(`/tms/${tmId}/segments`, undefined, {
+                reqheaders: {
+                    Authorization: `Bearer ${api.token}`,
+                },
+            })
+            .reply(200)
             .get(`/tms/${tmId}/exports/${exportId}/download`, undefined, {
                 reqheaders: {
                     Authorization: `Bearer ${api.token}`,
@@ -197,6 +203,10 @@ describe('Translation Memory API', () => {
         expect(tm.data.name).toBe(name);
     });
 
+    it('Clear TM', async () => {
+        await api.clearTm(tmId);
+    });
+
     it('Download TM', async () => {
         const link = await api.downloadTm(tmId, exportId);
         expect(link.data.url).toBe(url);

diff --git a/tests/translationStatus/api.test.ts b/tests/translationStatus/api.test.ts
@@ -119,7 +119,7 @@ describe('Translation Status API', () => {
                     limit: limit,
                 },
             })
-            .get(`/projects/${projectId}/qa-check`, undefined, {
+            .get(`/projects/${projectId}/qa-checks`, undefined, {
                 reqheaders: {
                     Authorization: `Bearer ${api.token}`,
                 },

diff --git a/tests/translations/api.test.ts b/tests/translations/api.test.ts
@@ -134,7 +134,30 @@ describe('Translations API', () => {
                     },
                 },
             )
-            .reply(200);
+            .reply(200, {
+                data: {
+                    fileId,
+                    storageId,
+                    languageId,
+                    projectId,
+                },
+            })
+            .post(
+                `/projects/${projectId}/translations/exports`,
+                {
+                    targetLanguageId: languageId,
+                },
+                {
+                    reqheaders: {
+                        Authorization: `Bearer ${api.token}`,
+                    },
+                },
+            )
+            .reply(200, {
+                data: {
+                    url: url,
+                },
+            });
     });
 
     afterAll(() => {
@@ -188,9 +211,20 @@ describe('Translations API', () => {
     });
 
     it('Upload Translation', async () => {
-        await api.uploadTranslation(projectId, languageId, {
+        const res = await api.uploadTranslation(projectId, languageId, {
             storageId: storageId,
             fileId: fileId,
         });
+        expect(res.data.fileId).toBe(fileId);
+        expect(res.data.languageId).toBe(languageId);
+        expect(res.data.projectId).toBe(projectId);
+        expect(res.data.storageId).toBe(storageId);
+    });
+
+    it('Export Project Translation', async () => {
+        const res = await api.exportProjectTranslation(projectId, {
+            targetLanguageId: languageId,
+        });
+        expect(res.data.url).toBe(url);
     });
 });