Merge pull request #125 from Smartling/DEVORTEX-5439

PavelLoparev · web-flow · commit e7c3ea342bb1 · 2025-07-28T12:34:38.000+03:00
DEVORTEX-5439 add webhooks api
diff --git a/.npmrc b/.npmrc
diff --git a/api/base/index.ts b/api/base/index.ts
@@ -162,7 +162,8 @@ export class SmartlingBaseApi {
                     "dueDate",
                     "actionTime",
                     "publishDate",
-                    "lastModified"
+                    "lastModified",
+                    "attemptDate"
                 ];
 
                 if (dateProperties.includes(key) && value) {
diff --git a/api/webhooks/dto/scrollable-response.ts b/api/webhooks/dto/scrollable-response.ts
@@ -0,0 +1,7 @@
+interface ScrollableResponse<T> {
+    items: Array<T>;
+    hasMore: boolean;
+    scrollId: string | null;
+}
+
+export { ScrollableResponse };
diff --git a/api/webhooks/dto/subscription-attempted-event-dto.ts b/api/webhooks/dto/subscription-attempted-event-dto.ts
@@ -0,0 +1,10 @@
+import { SubscriptionEventAttemptStatus } from "./subscription-event-attempt-status";
+
+interface SubscriptionAttemptedEventDto {
+    eventId: string;
+    eventType: string;
+    createdDate: Date;
+    lastAttemptStatus: SubscriptionEventAttemptStatus
+}
+
+export { SubscriptionAttemptedEventDto };
diff --git a/api/webhooks/dto/subscription-dto.ts b/api/webhooks/dto/subscription-dto.ts
@@ -0,0 +1,18 @@
+import { SubscriptionEvent } from "../params/subscription-event";
+import { SubscriptionRequestHeader } from "../params/subscription-request-header";
+
+interface SubscriptionDto {
+    subscriptionUid: string;
+    subscriptionName: string;
+    subscriptionUrl: string;
+    accountUid: string;
+    enabled: boolean;
+    userUid: string;
+    description: string | null;
+    createdDate: string;
+    requestHeaders: SubscriptionRequestHeader[];
+    events: SubscriptionEvent[];
+    projectUids: string[];
+}
+
+export { SubscriptionDto };
diff --git a/api/webhooks/dto/subscription-event-attempt-dto.ts b/api/webhooks/dto/subscription-event-attempt-dto.ts
@@ -0,0 +1,16 @@
+import { SubscriptionEventAttemptStatus } from "./subscription-event-attempt-status";
+import { SubscriptionEventTriggerType } from "./subscription-event-trigger-type";
+
+interface SubscriptionEventAttemptDto {
+    attemptId: string;
+    eventId: string;
+    response: string | null;
+    responseDurationMs: number;
+    responseStatusCode: number;
+    attemptStatus: SubscriptionEventAttemptStatus;
+    attemptDate: Date;
+    url: string;
+    triggerType: SubscriptionEventTriggerType;
+}
+
+export { SubscriptionEventAttemptDto };
diff --git a/api/webhooks/dto/subscription-event-attempt-status.ts b/api/webhooks/dto/subscription-event-attempt-status.ts
@@ -0,0 +1,8 @@
+enum SubscriptionEventAttemptStatus {
+    SUCCESS = "SUCCESS",
+    PENDING = "PENDING",
+    FAIL = "FAIL",
+    SENDING = "SENDING"
+}
+
+export { SubscriptionEventAttemptStatus };
diff --git a/api/webhooks/dto/subscription-event-dto.ts b/api/webhooks/dto/subscription-event-dto.ts
@@ -0,0 +1,8 @@
+interface SubscriptionEventDto {
+    eventId: string;
+    eventType: string;
+    createdDate: Date;
+    payload: Record<string, unknown>;
+}
+
+export { SubscriptionEventDto };
diff --git a/api/webhooks/dto/subscription-event-trigger-type.ts b/api/webhooks/dto/subscription-event-trigger-type.ts
@@ -0,0 +1,6 @@
+enum SubscriptionEventTriggerType {
+    SCHEDULED = "SCHEDULED",
+    MANUAL = "MANUAL"
+}
+
+export { SubscriptionEventTriggerType };
diff --git a/api/webhooks/dto/subscription-secret-dto.ts b/api/webhooks/dto/subscription-secret-dto.ts
@@ -0,0 +1,5 @@
+interface SubscriptionSecretDto {
+    payloadSecret: string;
+}
+
+export { SubscriptionSecretDto };
diff --git a/api/webhooks/dto/subscription-statistics-dto.ts b/api/webhooks/dto/subscription-statistics-dto.ts
@@ -0,0 +1,8 @@
+interface SubscriptionStatisticsDto {
+    failEvents: number;
+    pendingEvents: number;
+    sendingEvents: number;
+    successEvents: number;
+}
+
+export { SubscriptionStatisticsDto };
diff --git a/api/webhooks/dto/webhook-event-type.dto.ts b/api/webhooks/dto/webhook-event-type.dto.ts
@@ -0,0 +1,7 @@
+class WebhookEventTypeDto {
+    eventType: string;
+    description: string;
+    schema: Record<string, unknown>;
+}
+
+export { WebhookEventTypeDto };
diff --git a/api/webhooks/index.ts b/api/webhooks/index.ts
@@ -0,0 +1,17 @@
+export { SmartlingWebhooksApi } from "./smartling-webhooks-api";
+export { ScrollableResponse } from "./dto/scrollable-response";
+export { SubscriptionAttemptedEventDto } from "./dto/subscription-attempted-event-dto";
+export { SubscriptionEventDto } from "./dto/subscription-event-dto";
+export { SubscriptionEventAttemptDto } from "./dto/subscription-event-attempt-dto";
+export { SubscriptionEventAttemptStatus } from "./dto/subscription-event-attempt-status";
+export { SubscriptionEventTriggerType } from "./dto/subscription-event-trigger-type";
+export { SubscriptionStatisticsDto } from "./dto/subscription-statistics-dto";
+export { SubscriptionDto } from "./dto/subscription-dto";
+export { SubscriptionSecretDto } from "./dto/subscription-secret-dto";
+export { WebhookEventTypeDto } from "./dto/webhook-event-type.dto";
+export { SubscriptionEvent } from "./params/subscription-event";
+export { CreateSubscriptionParameters } from "./params/create-subscription-parameters";
+export { UpdateSubscriptionParameters } from "./params/update-subscription-parameters";
+export { SubscriptionRequestHeader } from "./params/subscription-request-header";
+export { UpdateSubscriptionSecretParameters } from "./params/update-subscription-secret-parameters";
+export { GetSubscriptionEventsParameters } from "./params/get-subscription-events-parameters";
diff --git a/api/webhooks/params/create-subscription-parameters.ts b/api/webhooks/params/create-subscription-parameters.ts
@@ -0,0 +1,9 @@
+import { CreateUpdateSubscriptionParameters } from "./create-update-subscription-parameters";
+
+export class CreateSubscriptionParameters extends CreateUpdateSubscriptionParameters {
+    setPayloadSecret(payloadSecret: string): this {
+        this.set("payloadSecret", payloadSecret);
+
+        return this;
+    }
+}
diff --git a/api/webhooks/params/create-update-subscription-parameters.ts b/api/webhooks/params/create-update-subscription-parameters.ts
@@ -0,0 +1,70 @@
+import { BaseParameters } from "../../parameters";
+import { SmartlingException } from "../../exception";
+import { SubscriptionEvent } from "./subscription-event";
+import { SubscriptionRequestHeader } from "./subscription-request-header";
+
+const MAX_EVENTS_SIZE = 1000;
+const MAX_SUBSCRIPTION_HEADERS_SIZE = 20;
+const MAX_PROJECT_UIDS_SIZE = 10;
+
+export abstract class CreateUpdateSubscriptionParameters extends BaseParameters {
+    constructor(
+        subscriptionName: string,
+        subscriptionUrl: string,
+        events: SubscriptionEvent[]
+    ) {
+        super();
+
+        if (!subscriptionName) {
+            throw new SmartlingException("Subscription name is required.");
+        }
+
+        if (!subscriptionUrl) {
+            throw new SmartlingException("Subscription url is required.");
+        }
+
+        if (!events.length) {
+            throw new SmartlingException("At least one event is required.");
+        }
+
+        if (events.length > MAX_EVENTS_SIZE) {
+            throw new SmartlingException(`The request contains too many events: ${events.length}. Maximum allowed events number is ${MAX_EVENTS_SIZE}.`);
+        }
+
+        this.set("subscriptionName", subscriptionName);
+        this.set("subscriptionUrl", subscriptionUrl);
+        this.set("events", events);
+    }
+
+    setDescription(description: string): this {
+        this.set("description", description);
+
+        return this;
+    }
+
+    setRequestHeaders(requestHeaders: SubscriptionRequestHeader[]): this {
+        if (!requestHeaders.length) {
+            throw new SmartlingException("At least one subscription header is required.");
+        }
+
+        if (requestHeaders.length > MAX_SUBSCRIPTION_HEADERS_SIZE) {
+            throw new SmartlingException(`The request contains too many subscription headers: ${requestHeaders.length}. Maximum allowed subscription headers number is ${MAX_SUBSCRIPTION_HEADERS_SIZE}.`);
+        }
+
+        this.set("requestHeaders", requestHeaders);
+        return this;
+    }
+
+    setProjectUids(projectUids: string[]): this {
+        if (!projectUids.length) {
+            throw new SmartlingException("At least one project uid is required.");
+        }
+
+        if (projectUids.length > MAX_PROJECT_UIDS_SIZE) {
+            throw new SmartlingException(`The request contains too many project uids: ${projectUids.length}. Maximum allowed project uids number is ${MAX_PROJECT_UIDS_SIZE}.`);
+        }
+        this.set("projectUids", projectUids);
+
+        return this;
+    }
+}
diff --git a/api/webhooks/params/get-subscription-events-parameters.ts b/api/webhooks/params/get-subscription-events-parameters.ts
@@ -0,0 +1,38 @@
+import { BaseParameters } from "../../parameters";
+import { SubscriptionEventAttemptStatus } from "../dto/subscription-event-attempt-status";
+
+export class GetSubscriptionEventsParameters extends BaseParameters {
+    setLimit(limit: number): this {
+        this.set("limit", limit);
+        return this;
+    }
+
+    setScrollId(scrollId: string): this {
+        this.set("scrollId", scrollId);
+        return this;
+    }
+
+    setAttemptStatus(attemptStatus: SubscriptionEventAttemptStatus): this {
+        this.set("attemptStatus", attemptStatus);
+        return this;
+    }
+
+    setCreatedDateBefore(createdDateBefore: Date): this {
+        this.set("createdDateBefore", GetSubscriptionEventsParameters.prepareDateParameter(createdDateBefore));
+        return this;
+    }
+
+    setCreatedDateAfter(createdDateAfter: Date): this {
+        this.set("createdDateAfter", GetSubscriptionEventsParameters.prepareDateParameter(createdDateAfter));
+        return this;
+    }
+
+    setEventTypes(eventTypes: string[]): this {
+        this.set("eventTypes", eventTypes);
+        return this;
+    }
+
+    private static prepareDateParameter(date: Date): string {
+        return `${date.toISOString().split(".")[0]}Z`;
+    }
+}
diff --git a/api/webhooks/params/subscription-event.ts b/api/webhooks/params/subscription-event.ts
@@ -0,0 +1,6 @@
+interface SubscriptionEvent {
+    type: string;
+    schemaVersion: string;
+}
+
+export { SubscriptionEvent };
diff --git a/api/webhooks/params/subscription-request-header.ts b/api/webhooks/params/subscription-request-header.ts
@@ -0,0 +1,6 @@
+interface SubscriptionRequestHeader {
+    headerName: string;
+    headerValue: string;
+}
+
+export { SubscriptionRequestHeader };
diff --git a/api/webhooks/params/update-subscription-parameters.ts b/api/webhooks/params/update-subscription-parameters.ts
@@ -0,0 +1,19 @@
+import { CreateUpdateSubscriptionParameters } from "./create-update-subscription-parameters";
+import { SubscriptionEvent } from "./subscription-event";
+
+export class UpdateSubscriptionParameters extends CreateUpdateSubscriptionParameters {
+    constructor(
+        subscriptionName: string,
+        subscriptionUrl: string,
+        events: SubscriptionEvent[],
+        enabled: boolean
+    ) {
+        super(
+            subscriptionName,
+            subscriptionUrl,
+            events
+        );
+
+        this.set("enabled", enabled);
+    }
+}
diff --git a/api/webhooks/params/update-subscription-secret-parameters.ts b/api/webhooks/params/update-subscription-secret-parameters.ts
@@ -0,0 +1,14 @@
+import { BaseParameters } from "../../parameters";
+import { SmartlingException } from "../../exception";
+
+export class UpdateSubscriptionSecretParameters extends BaseParameters {
+    constructor(payloadSecret: string) {
+        super();
+
+        if (!payloadSecret) {
+            throw new SmartlingException("Payload secret is required.");
+        }
+
+        this.set("payloadSecret", payloadSecret);
+    }
+}
diff --git a/api/webhooks/smartling-webhooks-api.ts b/api/webhooks/smartling-webhooks-api.ts
diff --git a/index.ts b/index.ts
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/test/webhooks.spec.ts b/test/webhooks.spec.ts
