DEVORTEX-5439 Added endpoints for events

dnetrebenko-smartling · dnetrebenko-smartling · commit fdc725ab7270 · 2025-07-25T16:30:17.000+03:00
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-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/webhook-event-type.dto.ts b/api/webhooks/dto/webhook-event-type.dto.ts
@@ -1,7 +1,7 @@
 class WebhookEventTypeDto {
     eventType: string;
     description: string;
-    schema: Record<string, any>;
+    schema: Record<string, unknown>;
 }
 
 export { WebhookEventTypeDto };
diff --git a/api/webhooks/index.ts b/api/webhooks/index.ts
@@ -1,4 +1,11 @@
 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";
diff --git a/api/webhooks/params/create-subscription-parameters.ts b/api/webhooks/params/create-subscription-parameters.ts
@@ -1,7 +1,7 @@
 import { CreateUpdateSubscriptionParameters } from "./create-update-subscription-parameters";
 
 export class CreateSubscriptionParameters extends CreateUpdateSubscriptionParameters {
-    setPayloadSecret(payloadSecret: string) {
+    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
@@ -42,7 +42,7 @@ export abstract class CreateUpdateSubscriptionParameters extends BaseParameters
         return this;
     }
 
-    setRequestHeaders(requestHeaders: SubscriptionRequestHeader[]) {
+    setRequestHeaders(requestHeaders: SubscriptionRequestHeader[]): this {
         if (!requestHeaders.length) {
             throw new SmartlingException("At least one subscription header is required.");
         }
@@ -55,7 +55,7 @@ export abstract class CreateUpdateSubscriptionParameters extends BaseParameters
         return this;
     }
 
-    setProjectUids(projectUids: string[]) {
+    setProjectUids(projectUids: string[]): this {
         if (!projectUids.length) {
             throw new SmartlingException("At least one project uid is required.");
         }
diff --git a/api/webhooks/params/get-subscription-events-parameters.ts b/api/webhooks/params/get-subscription-events-parameters.ts
@@ -1,11 +1,38 @@
 import { BaseParameters } from "../../parameters";
+import { SubscriptionEventAttemptStatus } from "../dto/subscription-event-attempt-status";
 
 export class GetSubscriptionEventsParameters extends BaseParameters {
-    setLimit(limit: number) {
-        if (limit > 0) {
-            this.set("limit", limit);
-        }
+    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/smartling-webhooks-api.ts b/api/webhooks/smartling-webhooks-api.ts
@@ -9,6 +9,11 @@ import { WebhookEventTypeDto } from "./dto/webhook-event-type.dto";
 import { CreateSubscriptionParameters } from "./params/create-subscription-parameters";
 import { UpdateSubscriptionParameters } from "./params/update-subscription-parameters";
 import { UpdateSubscriptionSecretParameters } from "./params/update-subscription-secret-parameters";
+import { ScrollableResponse } from "./dto/scrollable-response";
+import { SubscriptionAttemptedEventDto } from "./dto/subscription-attempted-event-dto";
+import { SubscriptionEventDto } from "./dto/subscription-event-dto";
+import { SubscriptionEventAttemptDto } from "./dto/subscription-event-attempt-dto";
+import { GetSubscriptionEventsParameters } from "./params/get-subscription-events-parameters";
 
 export class SmartlingWebhooksApi extends SmartlingBaseApi {
     constructor(smartlingApiBaseUrl: string, authApi: SmartlingAuthApi, logger: Logger) {
@@ -131,13 +136,50 @@ export class SmartlingWebhooksApi extends SmartlingBaseApi {
         );
     }
 
-    // getSubscriptionEvents() {}
+    getSubscriptionEvents(
+        accountUid: string,
+        subscriptionUid: string,
+        params?: GetSubscriptionEventsParameters
+    ): Promise<ScrollableResponse<SubscriptionAttemptedEventDto>> {
+        return this.makeRequest(
+            "get",
+            `${this.entrypoint}/accounts/${accountUid}/subscriptions/${subscriptionUid}/events`,
+            params ? params.export() : undefined
+        );
+    }
 
-    // getSubscriptionEvent() {}
+    getSubscriptionEvent(
+        accountUid: string,
+        subscriptionUid: string,
+        eventId: string
+    ): Promise<SubscriptionEventDto> {
+        return this.makeRequest(
+            "get",
+            `${this.entrypoint}/accounts/${accountUid}/subscriptions/${subscriptionUid}/events/${eventId}`
+        );
+    }
 
-    // sendSubscriptionEvent() {}
+    getSubscriptionEventAttempts(
+        accountUid: string,
+        subscriptionUid: string,
+        eventId: string
+    ): Promise<SmartlingListResponse<SubscriptionEventAttemptDto>> {
+        return this.makeRequest(
+            "get",
+            `${this.entrypoint}/accounts/${accountUid}/subscriptions/${subscriptionUid}/events/${eventId}/attempts`
+        );
+    }
 
-    // getSubscriptionEventAttempts() {}
+    sendSubscriptionEvent(
+        accountUid: string,
+        subscriptionUid: string,
+        eventId: string
+    ): Promise<void> {
+        return this.makeRequest(
+            "post",
+            `${this.entrypoint}/accounts/${accountUid}/subscriptions/${subscriptionUid}/events/${eventId}/send`
+        );
+    }
 
     getAvailableEventTypes(accountUid: string): Promise<WebhookEventTypeDto[]> {
         return this.makeRequest(
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -36,7 +36,6 @@
     "merge-deep": "^3.0.3",
     "querystring": "^0.2.1",
     "string-to-file-stream": "^2.0.0",
-    "typescript": "^4.3.5",
     "semver": "^5.7.2"
   },
   "devDependencies": {
@@ -57,7 +56,7 @@
     "nyc": "^17.1.0",
     "sinon": "^11.1.2",
     "ts-mocha": "^10.0.0",
-    "typescript": "^4.9.5"
+    "typescript": "^4.9.5",
     "braces": "^3.0.3",
     "json5": "^1.0.2"
   },
diff --git a/test/webhooks.spec.ts b/test/webhooks.spec.ts

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`class WebhookEventTypeDto {`
`2`	`2`	`eventType: string;`
`3`	`3`	`description: string;`
`4`		`- schema: Record<string, any>;`
	`4`	`+ schema: Record<string, unknown>;`
`5`	`5`	`}`
`6`	`6`
`7`	`7`	`export { WebhookEventTypeDto };`