smartling-api-sdk-nodejs 2.25.0 → 2.27.0

package/.scannerwork/report-task.txt

@@ -2,5 +2,5 @@ projectKey=smartling-api-sdk-nodejs
 serverUrl=https://sonar-next.connectors.stg.smartling.net
 serverVersion=8.6.1.40680
 dashboardUrl=https://sonar-next.connectors.stg.smartling.net/dashboard?id=smartling-api-sdk-nodejs
-ceTaskId=AZnNaTBHjzZQmJO_qatF
-ceTaskUrl=https://sonar-next.connectors.stg.smartling.net/api/ce/task?id=AZnNaTBHjzZQmJO_qatF
+ceTaskId=AZnkDu2E5pumWNxcJ_G-
+ceTaskUrl=https://sonar-next.connectors.stg.smartling.net/api/ce/task?id=AZnkDu2E5pumWNxcJ_G-

package/api/reports/index.ts

@@ -28,4 +28,13 @@ export class SmartlingReportServiceApi extends SmartlingBaseApi {
             params.export()
         );
     }
+
+    async getWordsCountReportCsv(params: WordCountParameters): Promise<string> {
+        return await this.makeRequest(
+            "GET",
+            `${this.entrypoint}/word-count/csv`,
+            params.export(),
+            true
+        );
+    }
 }

package/built/api/reports/index.d.ts

@@ -9,4 +9,5 @@ export declare class SmartlingReportServiceApi extends SmartlingBaseApi {
     constructor(smartlingApiBaseUrl: string, authApi: AccessTokenProvider, logger: Logger);
     getWorkflowStepTypes(): Promise<ReportResponse<StepTypeDto>>;
     getWordsCountReport(params: WordCountParameters): Promise<ReportResponse<WordCountDto>>;
+    getWordsCountReportCsv(params: WordCountParameters): Promise<string>;
 }

package/built/api/reports/index.js

@@ -27,6 +27,11 @@ class SmartlingReportServiceApi extends base_1.SmartlingBaseApi {
             return yield this.makeRequest("GET", `${this.entrypoint}/word-count`, params.export());
         });
     }
+    getWordsCountReportCsv(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.makeRequest("GET", `${this.entrypoint}/word-count/csv`, params.export(), true);
+        });
+    }
 }
 exports.SmartlingReportServiceApi = SmartlingReportServiceApi;
 //# sourceMappingURL=index.js.map

package/built/api/reports/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../api/reports/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAIA,kCAA2C;AAI3C,MAAa,yBAA0B,SAAQ,uBAAgB;IAC3D,YAAY,mBAA2B,EAAE,OAA4B,EAAE,MAAc;QACjF,KAAK,CAAC,MAAM,CAAC,CAAC;QAEd,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,GAAG,mBAAmB,iBAAiB,CAAC;IAC9D,CAAC;IAEK,oBAAoB;;YACtB,OAAO,MAAM,IAAI,CAAC,WAAW,CACzB,KAAK,EACL,GAAG,IAAI,CAAC,UAAU,mCAAmC,CACxD,CAAC;QACN,CAAC;KAAA;IAEK,mBAAmB,CAAC,MAA2B;;YACjD,OAAO,MAAM,IAAI,CAAC,WAAW,CACzB,KAAK,EACL,GAAG,IAAI,CAAC,UAAU,aAAa,EAC/B,MAAM,CAAC,MAAM,EAAE,CAClB,CAAC;QACN,CAAC;KAAA;CACJ;AAtBD,8DAsBC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../api/reports/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAIA,kCAA2C;AAI3C,MAAa,yBAA0B,SAAQ,uBAAgB;IAC3D,YAAY,mBAA2B,EAAE,OAA4B,EAAE,MAAc;QACjF,KAAK,CAAC,MAAM,CAAC,CAAC;QAEd,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,GAAG,mBAAmB,iBAAiB,CAAC;IAC9D,CAAC;IAEK,oBAAoB;;YACtB,OAAO,MAAM,IAAI,CAAC,WAAW,CACzB,KAAK,EACL,GAAG,IAAI,CAAC,UAAU,mCAAmC,CACxD,CAAC;QACN,CAAC;KAAA;IAEK,mBAAmB,CAAC,MAA2B;;YACjD,OAAO,MAAM,IAAI,CAAC,WAAW,CACzB,KAAK,EACL,GAAG,IAAI,CAAC,UAAU,aAAa,EAC/B,MAAM,CAAC,MAAM,EAAE,CAClB,CAAC;QACN,CAAC;KAAA;IAEK,sBAAsB,CAAC,MAA2B;;YACpD,OAAO,MAAM,IAAI,CAAC,WAAW,CACzB,KAAK,EACL,GAAG,IAAI,CAAC,UAAU,iBAAiB,EACnC,MAAM,CAAC,MAAM,EAAE,EACf,IAAI,CACP,CAAC;QACN,CAAC;KAAA;CACJ;AA/BD,8DA+BC"}

package/built/index.d.ts

@@ -161,4 +161,10 @@ export * from "./api/mt/index";
 export * from "./api/mt/params/smartling-mt-parameters";
 export * from "./api/mt/params/source-text-item";
 export * from "./api/mt/dto/translation-text-item-dto";
+export * from "./api/reports/index";
+export * from "./api/reports/dto/report-response";
+export * from "./api/reports/dto/step-types";
+export * from "./api/reports/dto/word-count-dto";
+export * from "./api/reports/params/word-count-parameters";
+export * from "./api/reports/params/date-formatter";
 export * from "./api/webhooks";

package/built/index.js

@@ -177,5 +177,11 @@ __exportStar(require("./api/mt/index"), exports);
 __exportStar(require("./api/mt/params/smartling-mt-parameters"), exports);
 __exportStar(require("./api/mt/params/source-text-item"), exports);
 __exportStar(require("./api/mt/dto/translation-text-item-dto"), exports);
+__exportStar(require("./api/reports/index"), exports);
+__exportStar(require("./api/reports/dto/report-response"), exports);
+__exportStar(require("./api/reports/dto/step-types"), exports);
+__exportStar(require("./api/reports/dto/word-count-dto"), exports);
+__exportStar(require("./api/reports/params/word-count-parameters"), exports);
+__exportStar(require("./api/reports/params/date-formatter"), exports);
 __exportStar(require("./api/webhooks"), exports);
 //# sourceMappingURL=index.js.map

package/built/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,kEAAgD;AAChD,0EAAwD;AACxD,mEAAiD;AACjD,mDAAiC;AACjC,qEAAmD;AACnD,sDAAoC;AACpC,sDAAoC;AACpC,wEAAsD;AACtD,6EAA2D;AAC3D,gEAA8C;AAC9C,4EAA0D;AAC1D,uEAAqD;AACrD,0FAAwE;AACxE,oEAAkD;AAClD,iFAA+D;AAC/D,kFAAgE;AAChE,uEAAqD;AACrD,sEAAoD;AACpD,wDAAsC;AACtC,gEAA8C;AAC9C,wFAAsE;AACtE,qFAAmE;AACnE,4FAA0E;AAC1E,+FAA6E;AAC7E,2FAAyE;AACzE,oEAAkD;AAClD,oFAAkE;AAClE,qFAAmE;AACnE,uFAAqE;AACrE,4FAA0E;AAC1E,2EAAyD;AACzD,uEAAqD;AACrD,8EAA4D;AAC5D,4FAA0E;AAC1E,qFAAmE;AACnE,oDAAkC;AAClC,8EAA4D;AAC5D,6EAA2D;AAC3D,oEAAkD;AAClD,+DAA6C;AAC7C,4EAA0D;AAC1D,kFAAgE;AAChE,kFAAgE;AAChE,+EAA6D;AAC7D,oEAAkD;AAClD,yDAAuC;AACvC,oEAAkD;AAClD,2EAAyD;AACzD,sEAAoD;AACpD,mEAAiD;AACjD,uFAAqE;AACrE,oFAAkE;AAClE,iFAA+D;AAC/D,uEAAqD;AACrD,yEAAuD;AACvD,sEAAoD;AACpD,uEAAqD;AACrD,+DAA6C;AAC7C,0EAAwD;AACxD,qEAAmD;AACnD,uEAAqD;AACrD,sEAAoD;AACpD,oEAAkD;AAClD,wEAAsD;AACtD,oEAAkD;AAClD,qEAAmD;AACnD,qEAAmD;AACnD,0DAAwC;AACxC,kEAAgD;AAChD,uEAAqD;AACrD,yEAAuD;AACvD,yEAAuD;AACvD,4EAA0D;AAC1D,oFAAkE;AAClE,oFAAkE;AAClE,mFAAiE;AACjE,kFAAgE;AAChE,wFAAsE;AACtE,2FAAyE;AACzE,wFAAsE;AACtE,0FAAwE;AACxE,wEAAsD;AACtD,wEAAsD;AACtD,mFAAiE;AACjE,6EAA2D;AAC3D,mDAAiC;AACjC,8DAA4C;AAC5C,kFAAgE;AAChE,kEAAgD;AAChD,mEAAiD;AACjD,sEAAoD;AACpD,iEAA+C;AAC/C,yDAAuC;AACvC,iEAA+C;AAC/C,mFAAiE;AACjE,uFAAqE;AACrE,kEAAgD;AAChD,mEAAiD;AACjD,yEAAuD;AACvD,kEAAgD;AAChD,kFAAgE;AAChE,6EAA2D;AAC3D,oEAAkD;AAClD,0EAAwD;AACxD,6EAA2D;AAC3D,4EAA0D;AAC1D,+DAA6C;AAC7C,8EAA4D;AAC5D,yEAAuD;AACvD,2EAAyD;AACzD,uFAAqE;AACrE,0EAAwD;AACxD,yEAAuD;AACvD,2EAAyD;AACzD,0EAAwD;AACxD,yDAAuC;AACvC,yDAAuC;AACvC,uDAAqC;AACrC,iEAA+C;AAC/C,wFAAsE;AACtE,gEAA8C;AAC9C,iFAA+D;AAC/D,8DAA4C;AAC5C,+EAA6D;AAC7D,mGAAiF;AACjF,sDAAoC;AACpC,sEAAoD;AACpD,0EAAwD;AACxD,gFAA8D;AAC9D,4EAA0D;AAC1D,uEAAqD;AACrD,uEAAqD;AACrD,2EAAyD;AACzD,uFAAqE;AACrE,iFAA+D;AAC/D,8EAA4D;AAC5D,mDAAiC;AACjC,yDAAuC;AACvC,oEAAkD;AAClD,iEAA+C;AAC/C,iFAA+D;AAC/D,iFAA+D;AAC/D,kFAAgE;AAChE,iFAA+D;AAC/D,mFAAiE;AACjE,wFAAsE;AACtE,4FAA0E;AAC1E,+CAA6B;AAC7B,wEAAsD;AACtD,+FAA6E;AAC7E,6EAA2D;AAC3D,gEAA8C;AAC9C,2EAAyD;AACzD,yEAAuD;AACvD,8DAA4C;AAC5C,mEAAiD;AACjD,8EAA4D;AAC5D,sDAAoC;AACpC,iDAA+B;AAC/B,0EAAwD;AACxD,mEAAiD;AACjD,yEAAuD;AACvD,iDAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,kEAAgD;AAChD,0EAAwD;AACxD,mEAAiD;AACjD,mDAAiC;AACjC,qEAAmD;AACnD,sDAAoC;AACpC,sDAAoC;AACpC,wEAAsD;AACtD,6EAA2D;AAC3D,gEAA8C;AAC9C,4EAA0D;AAC1D,uEAAqD;AACrD,0FAAwE;AACxE,oEAAkD;AAClD,iFAA+D;AAC/D,kFAAgE;AAChE,uEAAqD;AACrD,sEAAoD;AACpD,wDAAsC;AACtC,gEAA8C;AAC9C,wFAAsE;AACtE,qFAAmE;AACnE,4FAA0E;AAC1E,+FAA6E;AAC7E,2FAAyE;AACzE,oEAAkD;AAClD,oFAAkE;AAClE,qFAAmE;AACnE,uFAAqE;AACrE,4FAA0E;AAC1E,2EAAyD;AACzD,uEAAqD;AACrD,8EAA4D;AAC5D,4FAA0E;AAC1E,qFAAmE;AACnE,oDAAkC;AAClC,8EAA4D;AAC5D,6EAA2D;AAC3D,oEAAkD;AAClD,+DAA6C;AAC7C,4EAA0D;AAC1D,kFAAgE;AAChE,kFAAgE;AAChE,+EAA6D;AAC7D,oEAAkD;AAClD,yDAAuC;AACvC,oEAAkD;AAClD,2EAAyD;AACzD,sEAAoD;AACpD,mEAAiD;AACjD,uFAAqE;AACrE,oFAAkE;AAClE,iFAA+D;AAC/D,uEAAqD;AACrD,yEAAuD;AACvD,sEAAoD;AACpD,uEAAqD;AACrD,+DAA6C;AAC7C,0EAAwD;AACxD,qEAAmD;AACnD,uEAAqD;AACrD,sEAAoD;AACpD,oEAAkD;AAClD,wEAAsD;AACtD,oEAAkD;AAClD,qEAAmD;AACnD,qEAAmD;AACnD,0DAAwC;AACxC,kEAAgD;AAChD,uEAAqD;AACrD,yEAAuD;AACvD,yEAAuD;AACvD,4EAA0D;AAC1D,oFAAkE;AAClE,oFAAkE;AAClE,mFAAiE;AACjE,kFAAgE;AAChE,wFAAsE;AACtE,2FAAyE;AACzE,wFAAsE;AACtE,0FAAwE;AACxE,wEAAsD;AACtD,wEAAsD;AACtD,mFAAiE;AACjE,6EAA2D;AAC3D,mDAAiC;AACjC,8DAA4C;AAC5C,kFAAgE;AAChE,kEAAgD;AAChD,mEAAiD;AACjD,sEAAoD;AACpD,iEAA+C;AAC/C,yDAAuC;AACvC,iEAA+C;AAC/C,mFAAiE;AACjE,uFAAqE;AACrE,kEAAgD;AAChD,mEAAiD;AACjD,yEAAuD;AACvD,kEAAgD;AAChD,kFAAgE;AAChE,6EAA2D;AAC3D,oEAAkD;AAClD,0EAAwD;AACxD,6EAA2D;AAC3D,4EAA0D;AAC1D,+DAA6C;AAC7C,8EAA4D;AAC5D,yEAAuD;AACvD,2EAAyD;AACzD,uFAAqE;AACrE,0EAAwD;AACxD,yEAAuD;AACvD,2EAAyD;AACzD,0EAAwD;AACxD,yDAAuC;AACvC,yDAAuC;AACvC,uDAAqC;AACrC,iEAA+C;AAC/C,wFAAsE;AACtE,gEAA8C;AAC9C,iFAA+D;AAC/D,8DAA4C;AAC5C,+EAA6D;AAC7D,mGAAiF;AACjF,sDAAoC;AACpC,sEAAoD;AACpD,0EAAwD;AACxD,gFAA8D;AAC9D,4EAA0D;AAC1D,uEAAqD;AACrD,uEAAqD;AACrD,2EAAyD;AACzD,uFAAqE;AACrE,iFAA+D;AAC/D,8EAA4D;AAC5D,mDAAiC;AACjC,yDAAuC;AACvC,oEAAkD;AAClD,iEAA+C;AAC/C,iFAA+D;AAC/D,iFAA+D;AAC/D,kFAAgE;AAChE,iFAA+D;AAC/D,mFAAiE;AACjE,wFAAsE;AACtE,4FAA0E;AAC1E,+CAA6B;AAC7B,wEAAsD;AACtD,+FAA6E;AAC7E,6EAA2D;AAC3D,gEAA8C;AAC9C,2EAAyD;AACzD,yEAAuD;AACvD,8DAA4C;AAC5C,mEAAiD;AACjD,8EAA4D;AAC5D,sDAAoC;AACpC,iDAA+B;AAC/B,0EAAwD;AACxD,mEAAiD;AACjD,yEAAuD;AACvD,sDAAoC;AACpC,oEAAkD;AAClD,+DAA6C;AAC7C,mEAAiD;AACjD,6EAA2D;AAC3D,sEAAoD;AACpD,iDAA+B"}

package/built/package.json

@@ -1,6 +1,6 @@
 {
   "name": "smartling-api-sdk-nodejs",
-  "version": "2.25.0",
+  "version": "2.27.0",
   "description": "Package for Smartling API",
   "main": "built/index.js",
   "engines": {

package/index.ts

@@ -161,4 +161,10 @@ export * from "./api/mt/index";
 export * from "./api/mt/params/smartling-mt-parameters";
 export * from "./api/mt/params/source-text-item";
 export * from "./api/mt/dto/translation-text-item-dto";
+export * from "./api/reports/index";
+export * from "./api/reports/dto/report-response";
+export * from "./api/reports/dto/step-types";
+export * from "./api/reports/dto/word-count-dto";
+export * from "./api/reports/params/word-count-parameters";
+export * from "./api/reports/params/date-formatter";
 export * from "./api/webhooks";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "smartling-api-sdk-nodejs",
-  "version": "2.25.0",
+  "version": "2.27.0",
   "description": "Package for Smartling API",
   "main": "built/index.js",
   "engines": {

package/test/report-api.spec.ts

@@ -143,4 +143,59 @@ describe("SmartlingReportServiceApi class tests.", () => {
             assert.deepStrictEqual(result, payload);
         });
     });
+
+    describe("getWordsCountReportCsv", () => {
+        it("Should call CSV endpoint and return CSV string", async () => {
+            const csvResponse = `projectId,projectName,targetLocaleId,jobUid,jobName,translationResourceName,workflowStepType,wordCount,characterCount
+project123,Test Project,es-ES,job123,Test Job,Test Resource,TRANSLATION,1000,5000
+project123,Test Project,fr-FR,job456,Another Job,Another Resource,REVIEW,500,2500`;
+
+            responseMockTextStub.returns(csvResponse);
+
+            const startDate = new Date("2024-01-01T00:00:00Z");
+            const endDate = new Date("2024-12-31T23:59:59Z");
+
+            const params = new WordCountParameters()
+                .setStartDate(startDate)
+                .setEndDate(endDate)
+                .setAccountUid("account123")
+                .setProjectIds(["project123"])
+                .setUserUids(["user123"])
+                .setAgencyUid("agency123")
+                .setJobUids(["job123"])
+                .setTargetLocaleIds(["fr-FR"])
+                .setWorkflowStepTypes(["TRANSLATION", "REVIEW"])
+                .setFields("projectId,projectName,targetLocaleId,jobUid,jobName,translationResourceName,workflowStepType,wordCount,characterCount")
+                .setLimit(100)
+                .setOffset(0);
+
+            const result = await reportServiceApi.getWordsCountReportCsv(params);
+
+            sinon.assert.calledOnce(reportServiceApiFetchStub);
+            const callArgs = reportServiceApiFetchStub.getCall(0).args;
+
+            assert.strictEqual(callArgs[0], "https://test.com/reports-api/v3/word-count/csv"
+                + "?startDate=2024-01-01"
+                + "&endDate=2024-12-31"
+                + "&accountUid=account123"
+                + "&projectIds=project123"
+                + "&userUids=user123"
+                + "&agencyUid=agency123"
+                + "&jobUids=job123"
+                + "&targetLocaleIds=fr-FR"
+                + "&workflowStepTypes=TRANSLATION"
+                + "&workflowStepTypes=REVIEW"
+                + "&fields=projectId%2CprojectName%2CtargetLocaleId%2CjobUid%2CjobName%2CtranslationResourceName%2CworkflowStepType%2CwordCount%2CcharacterCount"
+                + "&limit=100"
+                + "&offset=0");
+            assert.strictEqual(callArgs[1].method, "GET");
+            assert.deepStrictEqual(callArgs[1].headers, {
+                Authorization: "test_token_type test_access_token",
+                "Content-Type": "application/json",
+                "User-Agent": "test_user_agent"
+            });
+
+            assert.strictEqual(result, csvResponse);
+        });
+    });
 });