smartling-api-sdk-nodejs 2.32.0 → 2.34.0

package/api/base/base-api.ts

@@ -164,7 +164,9 @@ export class SmartlingBaseApi {
                     "actionTime",
                     "publishDate",
                     "lastModified",
-                    "attemptDate"
+                    "attemptDate",
+                    "translationJobWorkflowStepDueDate",
+                    "translationJobOverallDueDate"
                 ];
 
                 if (dateProperties.includes(key) && value) {

package/api/http/smartling-bare-list-response.ts

@@ -0,0 +1,5 @@
+interface SmartlingBareListResponse<T> {
+    items: Array<T>;
+}
+
+export { SmartlingBareListResponse };

package/api/http/smartling-list-response.ts

@@ -1,6 +1,7 @@
-interface SmartlingListResponse<T> {
+import { SmartlingBareListResponse } from "./smartling-bare-list-response";
+
+interface SmartlingListResponse<T> extends SmartlingBareListResponse<T> {
     totalCount: number;
-    items: Array<T>;
 }
 
 export { SmartlingListResponse };

package/api/issues/dto/create-issue-string-dto.ts

@@ -0,0 +1,4 @@
+export interface CreateIssueStringDto {
+    hashcode: string;
+    localeId: string;
+}

package/api/issues/dto/issue-answered-dto.ts

@@ -0,0 +1,3 @@
+export interface IssueAnsweredDto {
+    answered: boolean;
+}

package/api/issues/dto/issue-assignee-dto.ts

@@ -0,0 +1,3 @@
+export interface IssueAssigneeDto {
+    assigneeUserUid: string;
+}

package/api/issues/dto/issue-changed-type-dto.ts

@@ -0,0 +1,8 @@
+import { IssueSubType } from "../enums/issue-sub-type";
+import { IssueType } from "../enums/issue-type";
+
+export interface IssueChangedTypeDto {
+    issueTypeCode: IssueType;
+    issueSubTypeCode: IssueSubType;
+    localeId?: string;
+}

package/api/issues/dto/issue-comment-dto.ts

@@ -0,0 +1,7 @@
+export interface IssueCommentDto {
+    commentText: string;
+    commentTextModifiedDate?: string;
+    createdByUserUid: string;
+    createdDate: string;
+    issueCommentUid: string;
+}

package/api/issues/dto/issue-dto.ts

@@ -0,0 +1,30 @@
+import { IssueSeverityLevel } from "../enums/issue-severity-level";
+import { IssueState } from "../enums/issue-state";
+import { IssueSubType } from "../enums/issue-sub-type";
+import { IssueType } from "../enums/issue-type";
+import { IssueStringDto } from "./issue-string-dto";
+
+export interface IssueDto {
+    answered: boolean;
+    createdDate: string;
+    lastCommentDate?: string;
+    issueSeverityLevelCode: IssueSeverityLevel;
+    issueStateCode: IssueState;
+    issueSubTypeCode: IssueSubType;
+    issueText: string;
+    issueTextModifiedDate?: string;
+    issueTypeCode: IssueType;
+    issueUid: string;
+    projectId: string;
+    accountUid: string;
+    issueNumber: number;
+    reportedByUserUid: string;
+    resolvedByUserUid?: string;
+    assigneeUserUid?: string;
+    resolvedDate?: string;
+    reopened: boolean;
+    reopenedByUserUid?: string;
+    reopenedDate?: string;
+    string: IssueStringDto;
+    issueCommentsCount: number;
+}

package/api/issues/dto/issue-severity-level-dto.ts

@@ -0,0 +1,5 @@
+import { IssueSeverityLevel } from "../enums/issue-severity-level";
+
+export interface IssueSeverityLevelDto {
+    issueSeverityLevelCode: IssueSeverityLevel;
+}

package/api/issues/dto/issue-sort-by-dto.ts

@@ -0,0 +1,5 @@
+import { IssueSortItemDto } from "./issue-sort-item-dto";
+
+export interface IssueSortByDto {
+    items: Array<IssueSortItemDto>;
+}

package/api/issues/dto/issue-sort-item-dto.ts

@@ -0,0 +1,7 @@
+import { Order } from "../../parameters/order";
+import { IssueSortField } from "../enums/issue-sort-field";
+
+export interface IssueSortItemDto {
+    direction: Order;
+    fieldName: IssueSortField;
+}

package/api/issues/dto/issue-state-dto.ts

@@ -0,0 +1,6 @@
+import { IssueState } from "../enums/issue-state";
+
+export interface IssueStateDto {
+    issueStateCode: IssueState;
+    reopened: boolean;
+}

package/api/issues/dto/issue-string-dto.ts

@@ -0,0 +1,4 @@
+export interface IssueStringDto {
+    hashcode: string;
+    localeId?: string;
+}

package/api/issues/dto/issue-text-dto.ts

@@ -0,0 +1,4 @@
+export interface IssueTextDto {
+    issueText: string;
+    issueTextModifiedDate: string;
+}

package/api/issues/dto/issues-count-dto.ts

@@ -0,0 +1,3 @@
+export interface IssuesCountDto {
+    count: number;
+}

package/api/issues/dto/job-filter-dto.ts

@@ -0,0 +1,6 @@
+import { JobFilterPresence } from "../enums/job-filter-presence";
+
+export interface JobFilterDto {
+    jobUids?: Array<string>;
+    presence?: JobFilterPresence;
+}

package/api/issues/dto/string-filter-dto.ts

@@ -0,0 +1,4 @@
+export interface StringFilterDto {
+    hashcodes?: Array<string>;
+    localeIds?: Array<string>;
+}

package/api/issues/enums/issue-severity-level.ts

@@ -0,0 +1,5 @@
+export enum IssueSeverityLevel {
+    LOW = "LOW",
+    MEDIUM = "MEDIUM",
+    HIGH = "HIGH"
+}

package/api/issues/enums/issue-sort-field.ts

@@ -0,0 +1,14 @@
+export enum IssueSortField {
+    ISSUE_TYPE_CODE = "issueTypeCode",
+    ISSUE_SUB_TYPE_CODE = "issueSubTypeCode",
+    ISSUE_STATE_CODE = "issueStateCode",
+    CREATED_DATE = "createdDate",
+    RESOLVED_DATE = "resolvedDate",
+    HASHCODE = "hashcode",
+    ISSUE_TEXT = "issueText",
+    ISSUE_TEXT_MODIFIED_DATE = "issueTextModifiedDate",
+    RESOLVED_BY_USER_UID = "resolvedByUserUid",
+    REPORTED_BY_USER_UID = "reportedByUserUid",
+    ASSIGNEE_USER_UID = "assigneeUserUid",
+    LAST_COMMENT_DATE = "lastCommentDate"
+}

package/api/issues/enums/issue-state.ts

@@ -0,0 +1,4 @@
+export enum IssueState {
+    OPENED = "OPENED",
+    RESOLVED = "RESOLVED"
+}

package/api/issues/enums/issue-sub-type.ts

@@ -0,0 +1,10 @@
+export enum IssueSubType {
+    CLARIFICATION = "CLARIFICATION",
+    MISSPELLING = "MISSPELLING",
+    POOR_TRANSLATION = "POOR_TRANSLATION",
+    DOES_NOT_FIT_SPACE = "DOES_NOT_FIT_SPACE",
+    PLACEHOLDER_ISSUE = "PLACEHOLDER_ISSUE",
+    REVIEW_TRANSLATION = "REVIEW_TRANSLATION",
+    CUSTOM = "CUSTOM",
+    MT_ERROR = "MT_ERROR"
+}

package/api/issues/enums/issue-type.ts

@@ -0,0 +1,4 @@
+export enum IssueType {
+    SOURCE = "SOURCE",
+    TRANSLATION = "TRANSLATION"
+}

package/api/issues/enums/issue-watching-state.ts

@@ -0,0 +1,4 @@
+export enum IssueWatchingState {
+    WATCHING = "WATCHING",
+    NOT_WATCHING = "NOT_WATCHING"
+}

package/api/issues/enums/job-filter-presence.ts

@@ -0,0 +1,4 @@
+export enum JobFilterPresence {
+    HAS_ANY = "HAS_ANY",
+    HAS_NOTHING = "HAS_NOTHING"
+}

package/api/issues/index.ts

@@ -0,0 +1,238 @@
+import { SmartlingBaseApi } from "../base/index";
+import { AccessTokenProvider } from "../auth/access-token-provider";
+import { Logger } from "../logger";
+import { CreateIssueParameters } from "./params/create-issue-parameters";
+import { EditIssueParameters } from "./params/edit-issue-parameters";
+import { UpdateIssueStateParameters } from "./params/update-issue-state-parameters";
+import { UpdateIssueAnsweredParameters } from "./params/update-issue-answered-parameters";
+import { UpdateIssueAssigneeParameters } from "./params/update-issue-assignee-parameters";
+import { UpdateIssueSeverityLevelParameters } from "./params/update-issue-severity-level-parameters";
+import { UpdateIssueTypeParameters } from "./params/update-issue-type-parameters";
+import { CreateIssueCommentParameters } from "./params/create-issue-comment-parameters";
+import { EditIssueCommentParameters } from "./params/edit-issue-comment-parameters";
+import { IssueDto } from "./dto/issue-dto";
+import { IssueTextDto } from "./dto/issue-text-dto";
+import { IssueStateDto } from "./dto/issue-state-dto";
+import { IssueAnsweredDto } from "./dto/issue-answered-dto";
+import { IssueAssigneeDto } from "./dto/issue-assignee-dto";
+import { IssueSeverityLevelDto } from "./dto/issue-severity-level-dto";
+import { IssueChangedTypeDto } from "./dto/issue-changed-type-dto";
+import { IssueCommentDto } from "./dto/issue-comment-dto";
+import { SmartlingListResponse } from "../http/smartling-list-response";
+import { CountProjectIssuesParameters } from "./params/count-project-issues-parameters";
+import { FindProjectIssuesParameters } from "./params/find-project-issues-parameters";
+import { CountAccountIssuesParameters } from "./params/count-account-issues-parameters";
+import { FindAccountIssuesParameters } from "./params/find-account-issues-parameters";
+import { IssuesCountDto } from "./dto/issues-count-dto";
+
+export class SmartlingIssuesApi extends SmartlingBaseApi {
+    constructor(smartlingApiBaseUrl: string, authApi: AccessTokenProvider, logger: Logger) {
+        super(logger);
+        this.authApi = authApi;
+        this.entrypoint = `${smartlingApiBaseUrl}/issues-api/v2`;
+    }
+
+    async createIssue(
+        projectId: string,
+        params: CreateIssueParameters
+    ): Promise<IssueDto> {
+        return await this.makeRequest(
+            "post",
+            `${this.entrypoint}/projects/${projectId}/issues`,
+            JSON.stringify(params.export())
+        );
+    }
+
+    async editIssue(
+        projectId: string,
+        issueUid: string,
+        params: EditIssueParameters
+    ): Promise<IssueTextDto> {
+        return await this.makeRequest(
+            "put",
+            `${this.entrypoint}/projects/${projectId}/issues/${issueUid}/issueText`,
+            JSON.stringify(params.export())
+        );
+    }
+
+    async openOrCloseIssue(
+        projectId: string,
+        issueUid: string,
+        params: UpdateIssueStateParameters
+    ): Promise<IssueStateDto> {
+        return await this.makeRequest(
+            "put",
+            `${this.entrypoint}/projects/${projectId}/issues/${issueUid}/state`,
+            JSON.stringify(params.export())
+        );
+    }
+
+    async getIssueDetails(
+        projectId: string,
+        issueUid: string
+    ): Promise<IssueDto> {
+        return await this.makeRequest(
+            "get",
+            `${this.entrypoint}/projects/${projectId}/issues/${issueUid}`
+        );
+    }
+
+    async updateIssueAnswered(
+        projectId: string,
+        issueUid: string,
+        params: UpdateIssueAnsweredParameters
+    ): Promise<IssueAnsweredDto> {
+        return await this.makeRequest(
+            "put",
+            `${this.entrypoint}/projects/${projectId}/issues/${issueUid}/answered`,
+            JSON.stringify(params.export())
+        );
+    }
+
+    async updateIssueAssignee(
+        projectId: string,
+        issueUid: string,
+        params: UpdateIssueAssigneeParameters
+    ): Promise<IssueAssigneeDto> {
+        return await this.makeRequest(
+            "put",
+            `${this.entrypoint}/projects/${projectId}/issues/${issueUid}/assignee`,
+            JSON.stringify(params.export())
+        );
+    }
+
+    async deleteIssueAssignee(
+        projectId: string,
+        issueUid: string
+    ): Promise<void> {
+        await this.makeRequest(
+            "delete",
+            `${this.entrypoint}/projects/${projectId}/issues/${issueUid}/assignee`
+        );
+    }
+
+    async updateIssueSeverityLevel(
+        projectId: string,
+        issueUid: string,
+        params: UpdateIssueSeverityLevelParameters
+    ): Promise<IssueSeverityLevelDto> {
+        return await this.makeRequest(
+            "put",
+            `${this.entrypoint}/projects/${projectId}/issues/${issueUid}/severity-level`,
+            JSON.stringify(params.export())
+        );
+    }
+
+    async updateIssueType(
+        projectId: string,
+        issueUid: string,
+        params: UpdateIssueTypeParameters
+    ): Promise<IssueChangedTypeDto> {
+        return await this.makeRequest(
+            "put",
+            `${this.entrypoint}/projects/${projectId}/issues/${issueUid}/change-type`,
+            JSON.stringify(params.export())
+        );
+    }
+
+    async getIssueComments(
+        projectId: string,
+        issueUid: string
+    ): Promise<SmartlingListResponse<IssueCommentDto>> {
+        return await this.makeRequest(
+            "get",
+            `${this.entrypoint}/projects/${projectId}/issues/${issueUid}/comments`
+        );
+    }
+
+    async addIssueComment(
+        projectId: string,
+        issueUid: string,
+        params: CreateIssueCommentParameters
+    ): Promise<IssueCommentDto> {
+        return await this.makeRequest(
+            "post",
+            `${this.entrypoint}/projects/${projectId}/issues/${issueUid}/comments`,
+            JSON.stringify(params.export())
+        );
+    }
+
+    async updateIssueComment(
+        projectId: string,
+        issueUid: string,
+        issueCommentUid: string,
+        params: EditIssueCommentParameters
+    ): Promise<IssueCommentDto> {
+        return await this.makeRequest(
+            "put",
+            `${this.entrypoint}/projects/${projectId}/issues/${issueUid}/comments/${issueCommentUid}`,
+            JSON.stringify(params.export())
+        );
+    }
+
+    async getIssueCommentDetails(
+        projectId: string,
+        issueUid: string,
+        issueCommentUid: string
+    ): Promise<IssueCommentDto> {
+        return await this.makeRequest(
+            "get",
+            `${this.entrypoint}/projects/${projectId}/issues/${issueUid}/comments/${issueCommentUid}`
+        );
+    }
+
+    async deleteIssueComment(
+        projectId: string,
+        issueUid: string,
+        issueCommentUid: string
+    ): Promise<void> {
+        await this.makeRequest(
+            "delete",
+            `${this.entrypoint}/projects/${projectId}/issues/${issueUid}/comments/${issueCommentUid}`
+        );
+    }
+
+    async findProjectIssues(
+        projectId: string,
+        params: FindProjectIssuesParameters
+    ): Promise<SmartlingListResponse<IssueDto>> {
+        return await this.makeRequest(
+            "post",
+            `${this.entrypoint}/projects/${projectId}/issues/list`,
+            JSON.stringify(params.export())
+        );
+    }
+
+    async countProjectIssues(
+        projectId: string,
+        params: CountProjectIssuesParameters
+    ): Promise<IssuesCountDto> {
+        return await this.makeRequest(
+            "post",
+            `${this.entrypoint}/projects/${projectId}/issues/count`,
+            JSON.stringify(params.export())
+        );
+    }
+
+    async findAccountIssues(
+        accountUid: string,
+        params: FindAccountIssuesParameters
+    ): Promise<SmartlingListResponse<IssueDto>> {
+        return await this.makeRequest(
+            "post",
+            `${this.entrypoint}/accounts/${accountUid}/issues/list`,
+            JSON.stringify(params.export())
+        );
+    }
+
+    async countAccountIssues(
+        accountUid: string,
+        params: CountAccountIssuesParameters
+    ): Promise<IssuesCountDto> {
+        return await this.makeRequest(
+            "post",
+            `${this.entrypoint}/accounts/${accountUid}/issues/count`,
+            JSON.stringify(params.export())
+        );
+    }
+}

package/api/issues/params/base-issues-filter-parameters.ts

@@ -0,0 +1,102 @@
+import { BaseParameters } from "../../parameters";
+import { SmartlingException } from "../../exception";
+import { IssueSeverityLevel } from "../enums/issue-severity-level";
+import { IssueState } from "../enums/issue-state";
+import { IssueSubType } from "../enums/issue-sub-type";
+import { IssueType } from "../enums/issue-type";
+import { IssueWatchingState } from "../enums/issue-watching-state";
+import { JobFilterDto } from "../dto/job-filter-dto";
+import { StringFilterDto } from "../dto/string-filter-dto";
+
+export abstract class BaseIssuesFilterParameters extends BaseParameters {
+    setCreatedDateBefore(date: string): this {
+        this.set("createdDateBefore", date);
+        return this;
+    }
+
+    setCreatedDateAfter(date: string): this {
+        this.set("createdDateAfter", date);
+        return this;
+    }
+
+    setResolvedDateBefore(date: string): this {
+        this.set("resolvedDateBefore", date);
+        return this;
+    }
+
+    setResolvedDateAfter(date: string): this {
+        this.set("resolvedDateAfter", date);
+        return this;
+    }
+
+    setAnswered(answered: boolean): this {
+        this.set("answered", answered);
+        return this;
+    }
+
+    setReopened(reopened: boolean): this {
+        this.set("reopened", reopened);
+        return this;
+    }
+
+    setHasComments(hasComments: boolean): this {
+        this.set("hasComments", hasComments);
+        return this;
+    }
+
+    setIssueSeverityLevelCodes(codes: Array<IssueSeverityLevel>): this {
+        this.set("issueSeverityLevelCodes", codes);
+        return this;
+    }
+
+    setIssueStateCodes(codes: Array<IssueState>): this {
+        this.set("issueStateCodes", codes);
+        return this;
+    }
+
+    setIssueSubTypeCodes(codes: Array<IssueSubType>): this {
+        this.set("issueSubTypeCodes", codes);
+        return this;
+    }
+
+    setIssueTypeCodes(codes: Array<IssueType>): this {
+        this.set("issueTypeCodes", codes);
+        return this;
+    }
+
+    setIssueWatchingStateCode(code: IssueWatchingState): this {
+        this.set("issueWatchingStateCode", code);
+        return this;
+    }
+
+    setReportedByUserUid(uid: string): this {
+        this.set("reportedByUserUid", uid);
+        return this;
+    }
+
+    setAssigneeUserUid(uid: string): this {
+        this.set("assigneeUserUid", uid);
+        return this;
+    }
+
+    setIssueNumbers(numbers: Array<number>): this {
+        if (numbers && numbers.length > 1000) {
+            throw new SmartlingException("Issue numbers array must not exceed 1000 items");
+        }
+        this.set("issueNumbers", numbers);
+        return this;
+    }
+
+    setJobFilter(jobFilter: JobFilterDto): this {
+        if (jobFilter && jobFilter.jobUids && jobFilter.jobUids.length > 1000) {
+            throw new SmartlingException("Job filter jobUids array must not exceed 1000 items");
+        }
+        this.set("jobFilter", jobFilter);
+        return this;
+    }
+
+    setStringFilter(stringFilter: StringFilterDto): this {
+        this.set("stringFilter", stringFilter);
+        return this;
+    }
+}

package/api/issues/params/count-account-issues-parameters.ts

@@ -0,0 +1,8 @@
+import { BaseIssuesFilterParameters } from "./base-issues-filter-parameters";
+
+export class CountAccountIssuesParameters extends BaseIssuesFilterParameters {
+    setProjectIds(projectIds: Array<string>): this {
+        this.set("projectIds", projectIds);
+        return this;
+    }
+}

package/api/issues/params/count-project-issues-parameters.ts

@@ -0,0 +1,3 @@
+import { BaseIssuesFilterParameters } from "./base-issues-filter-parameters";
+
+export class CountProjectIssuesParameters extends BaseIssuesFilterParameters {}

package/api/issues/params/create-issue-comment-parameters.ts

@@ -0,0 +1,12 @@
+import { BaseParameters } from "../../parameters";
+import { SmartlingException } from "../../exception";
+
+export class CreateIssueCommentParameters extends BaseParameters {
+    setCommentText(commentText: string): CreateIssueCommentParameters {
+        if (commentText && commentText.length > 4000) {
+            throw new SmartlingException("Comment text length must not exceed 4000 characters");
+        }
+        this.set("commentText", commentText);
+        return this;
+    }
+}

package/api/issues/params/create-issue-parameters.ts

@@ -0,0 +1,41 @@
+import { BaseParameters } from "../../parameters";
+import { SmartlingException } from "../../exception";
+import { IssueSeverityLevel } from "../enums/issue-severity-level";
+import { IssueSubType } from "../enums/issue-sub-type";
+import { IssueType } from "../enums/issue-type";
+import { CreateIssueStringDto } from "../dto/create-issue-string-dto";
+
+export class CreateIssueParameters extends BaseParameters {
+    setIssueText(issueText: string): CreateIssueParameters {
+        if (issueText && issueText.length > 4000) {
+            throw new SmartlingException("Issue text length must not exceed 4000 characters");
+        }
+        this.set("issueText", issueText);
+        return this;
+    }
+
+    setIssueType(issueType: IssueType): CreateIssueParameters {
+        this.set("issueTypeCode", issueType);
+        return this;
+    }
+
+    setIssueSubType(issueSubType: IssueSubType): CreateIssueParameters {
+        this.set("issueSubTypeCode", issueSubType);
+        return this;
+    }
+
+    setString(string: CreateIssueStringDto): CreateIssueParameters {
+        this.set("string", string);
+        return this;
+    }
+
+    setAssigneeUserUid(assigneeUserUid: string): CreateIssueParameters {
+        this.set("assigneeUserUid", assigneeUserUid);
+        return this;
+    }
+
+    setIssueSeverityLevel(level: IssueSeverityLevel): CreateIssueParameters {
+        this.set("issueSeverityLevelCode", level);
+        return this;
+    }
+}

package/api/issues/params/edit-issue-comment-parameters.ts

@@ -0,0 +1,12 @@
+import { BaseParameters } from "../../parameters";
+import { SmartlingException } from "../../exception";
+
+export class EditIssueCommentParameters extends BaseParameters {
+    setCommentText(commentText: string): EditIssueCommentParameters {
+        if (commentText && commentText.length > 4000) {
+            throw new SmartlingException("Comment text length must not exceed 4000 characters");
+        }
+        this.set("commentText", commentText);
+        return this;
+    }
+}

package/api/issues/params/edit-issue-parameters.ts

@@ -0,0 +1,12 @@
+import { BaseParameters } from "../../parameters";
+import { SmartlingException } from "../../exception";
+
+export class EditIssueParameters extends BaseParameters {
+    setIssueText(issueText: string): EditIssueParameters {
+        if (issueText && issueText.length > 4000) {
+            throw new SmartlingException("Issue text length must not exceed 4000 characters");
+        }
+        this.set("issueText", issueText);
+        return this;
+    }
+}