feat: add client token notification events and related mocks (#172)

vijayasingam-paddle · web-flow · commit 6a305c80b294 · 2025-08-01T10:58:35.000+01:00
diff --git a/src/__tests__/mocks/notifications/client-token-created.mock.ts b/src/__tests__/mocks/notifications/client-token-created.mock.ts
@@ -0,0 +1,42 @@
+/**
+ *  ! Autogenerated code !
+ *  Do not make changes to this file.
+ *  Changes may be overwritten as part of auto-generation.
+ */
+
+import { IClientTokenNotificationResponse } from '../../../notifications/index.js';
+import { IEventsResponse } from '../../../types/index.js';
+
+export const ClientTokenCreatedMock: IEventsResponse<IClientTokenNotificationResponse> = {
+  event_id: 'evt_01jkdr0rc527wcjdg1txsdxhtf',
+  event_type: 'client_token.created',
+  occurred_at: '2025-06-26T14:36:14.695521Z',
+  notification_id: 'ntf_01jkdr1mgbe62eqkh3p0fq8b0h',
+  data: {
+    id: 'ctkn_01ghbkd0frb9k95cnhwd1bxpvk',
+    token: 'live_7d279f61a3499fed520f7cd8c08',
+    name: 'Pricing page integration',
+    description: 'Used to display prices and open checkout within our pricing page on our marketing domain.',
+    status: 'active',
+    created_at: '2025-06-26T14:36:14.695521Z',
+    updated_at: '2025-06-26T14:36:14.695521Z',
+    revoked_at: null,
+  },
+};
+
+export const ClientTokenCreatedMockExpectation = {
+  data: {
+    id: 'ctkn_01ghbkd0frb9k95cnhwd1bxpvk',
+    token: 'live_7d279f61a3499fed520f7cd8c08',
+    name: 'Pricing page integration',
+    description: 'Used to display prices and open checkout within our pricing page on our marketing domain.',
+    status: 'active',
+    createdAt: '2025-06-26T14:36:14.695521Z',
+    updatedAt: '2025-06-26T14:36:14.695521Z',
+    revokedAt: null,
+  },
+  eventId: 'evt_01jkdr0rc527wcjdg1txsdxhtf',
+  eventType: 'client_token.created',
+  occurredAt: '2025-06-26T14:36:14.695521Z',
+  notificationId: 'ntf_01jkdr1mgbe62eqkh3p0fq8b0h',
+};
diff --git a/src/__tests__/mocks/notifications/client-token-revoked.mock.ts b/src/__tests__/mocks/notifications/client-token-revoked.mock.ts
@@ -0,0 +1,42 @@
+/**
+ *  ! Autogenerated code !
+ *  Do not make changes to this file.
+ *  Changes may be overwritten as part of auto-generation.
+ */
+
+import { IClientTokenNotificationResponse } from '../../../notifications/index.js';
+import { IEventsResponse } from '../../../types/index.js';
+
+export const ClientTokenRevokedMock: IEventsResponse<IClientTokenNotificationResponse> = {
+  event_id: 'evt_01jkdr0rc527wcjdg1txsdxhtf',
+  event_type: 'client_token.revoked',
+  occurred_at: '2025-06-27T11:26:10.253482Z',
+  notification_id: 'ntf_01jkb92mpl7v4rfg8x3q5wz7bn',
+  data: {
+    id: 'ctkn_01ghbkd0frb9k95cnhwd1bxpvk',
+    token: 'live_7d279f61a3499fed520f7cd8c08',
+    name: 'Pricing page integration',
+    description: 'Used to display prices and open checkout within our pricing page on our marketing domain.',
+    status: 'revoked',
+    created_at: '2025-06-26T14:36:14.695521Z',
+    updated_at: '2025-06-27T11:26:10.253482Z',
+    revoked_at: '2025-06-27T11:26:10.253482Z',
+  },
+};
+
+export const ClientTokenRevokedMockExpectation = {
+  data: {
+    id: 'ctkn_01ghbkd0frb9k95cnhwd1bxpvk',
+    token: 'live_7d279f61a3499fed520f7cd8c08',
+    name: 'Pricing page integration',
+    description: 'Used to display prices and open checkout within our pricing page on our marketing domain.',
+    status: 'revoked',
+    createdAt: '2025-06-26T14:36:14.695521Z',
+    updatedAt: '2025-06-27T11:26:10.253482Z',
+    revokedAt: '2025-06-27T11:26:10.253482Z',
+  },
+  eventId: 'evt_01jkdr0rc527wcjdg1txsdxhtf',
+  eventType: 'client_token.revoked',
+  occurredAt: '2025-06-27T11:26:10.253482Z',
+  notificationId: 'ntf_01jkb92mpl7v4rfg8x3q5wz7bn',
+};
diff --git a/src/__tests__/mocks/notifications/client-token-updated.mock.ts b/src/__tests__/mocks/notifications/client-token-updated.mock.ts
@@ -0,0 +1,42 @@
+/**
+ *  ! Autogenerated code !
+ *  Do not make changes to this file.
+ *  Changes may be overwritten as part of auto-generation.
+ */
+
+import { IClientTokenNotificationResponse } from '../../../notifications/index.js';
+import { IEventsResponse } from '../../../types/index.js';
+
+export const ClientTokenUpdatedMock: IEventsResponse<IClientTokenNotificationResponse> = {
+  event_id: 'evt_01jkdr0rc527wcjdg1txsdxhtf',
+  event_type: 'client_token.updated',
+  occurred_at: '2025-06-27T11:26:10.253482Z',
+  notification_id: 'ntf_01jkr4d5s6f7g8h9j1k2l3q4rs',
+  data: {
+    id: 'ctkn_01ghbkd0frb9k95cnhwd1bxpvk',
+    token: 'live_7d279f61a3499fed520f7cd8c08',
+    name: 'Pricing page integration',
+    description: 'Used to display prices and open checkout within our pricing page on our marketing domain.',
+    status: 'revoked',
+    created_at: '2025-06-26T14:36:14.695521Z',
+    updated_at: '2025-06-27T11:26:10.253482Z',
+    revoked_at: '2025-06-27T11:26:10.253482Z',
+  },
+};
+
+export const ClientTokenUpdatedMockExpectation = {
+  data: {
+    id: 'ctkn_01ghbkd0frb9k95cnhwd1bxpvk',
+    token: 'live_7d279f61a3499fed520f7cd8c08',
+    name: 'Pricing page integration',
+    description: 'Used to display prices and open checkout within our pricing page on our marketing domain.',
+    status: 'revoked',
+    createdAt: '2025-06-26T14:36:14.695521Z',
+    updatedAt: '2025-06-27T11:26:10.253482Z',
+    revokedAt: '2025-06-27T11:26:10.253482Z',
+  },
+  eventId: 'evt_01jkdr0rc527wcjdg1txsdxhtf',
+  eventType: 'client_token.updated',
+  occurredAt: '2025-06-27T11:26:10.253482Z',
+  notificationId: 'ntf_01jkr4d5s6f7g8h9j1k2l3q4rs',
+};
diff --git a/src/__tests__/notifications/notifications-parser.test.ts b/src/__tests__/notifications/notifications-parser.test.ts
@@ -134,6 +134,18 @@ import {
   DiscountGroupUpdatedMock,
   DiscountGroupUpdatedMockExpectation,
 } from '../mocks/notifications/discount-group-updated.mock.js';
+import {
+  ClientTokenCreatedMock,
+  ClientTokenCreatedMockExpectation,
+} from '../mocks/notifications/client-token-created.mock.js';
+import {
+  ClientTokenUpdatedMock,
+  ClientTokenUpdatedMockExpectation,
+} from '../mocks/notifications/client-token-updated.mock.js';
+import {
+  ClientTokenRevokedMock,
+  ClientTokenRevokedMockExpectation,
+} from '../mocks/notifications/client-token-revoked.mock.js';
 
 describe('Notifications Parser', () => {
   test.each([
@@ -150,6 +162,9 @@ describe('Notifications Parser', () => {
     [BusinessCreatedMock.event_type, BusinessCreatedMock, BusinessCreatedMockExpectation],
     [BusinessUpdatedMock.event_type, BusinessUpdatedMock, BusinessUpdatedMockExpectation],
     [BusinessImportedMock.event_type, BusinessImportedMock, BusinessImportedMockExpectation],
+    [ClientTokenCreatedMock.event_type, ClientTokenCreatedMock, ClientTokenCreatedMockExpectation],
+    [ClientTokenUpdatedMock.event_type, ClientTokenUpdatedMock, ClientTokenUpdatedMockExpectation],
+    [ClientTokenRevokedMock.event_type, ClientTokenRevokedMock, ClientTokenRevokedMockExpectation],
     [CustomerCreatedMock.event_type, CustomerCreatedMock, CustomerCreatedMockExpectation],
     [CustomerUpdatedMock.event_type, CustomerUpdatedMock, CustomerUpdatedMockExpectation],
     [CustomerImportedMock.event_type, CustomerImportedMock, CustomerImportedMockExpectation],
diff --git a/src/notifications/entities/client-token/client-token-notification.ts b/src/notifications/entities/client-token/client-token-notification.ts
@@ -0,0 +1,29 @@
+/**
+ *  ! Autogenerated code !
+ *  Do not make changes to this file.
+ *  Changes may be overwritten as part of auto-generation.
+ */
+import { ClientTokenStatus } from '../../../enums/index.js';
+import { IClientTokenNotificationResponse } from '../../types/index.js';
+
+export class ClientTokenNotification {
+  public readonly id: string;
+  public readonly token: string;
+  public readonly name: string;
+  public readonly description: string | null;
+  public readonly status: ClientTokenStatus;
+  public readonly createdAt: string;
+  public readonly updatedAt: string;
+  public readonly revokedAt: string | null;
+
+  constructor(clientToken: IClientTokenNotificationResponse) {
+    this.id = clientToken.id;
+    this.token = clientToken.token;
+    this.name = clientToken.name;
+    this.description = clientToken.description ?? null;
+    this.status = clientToken.status;
+    this.createdAt = clientToken.created_at;
+    this.updatedAt = clientToken.updated_at;
+    this.revokedAt = clientToken.revoked_at ?? null;
+  }
+}
diff --git a/src/notifications/entities/client-token/index.ts b/src/notifications/entities/client-token/index.ts
@@ -0,0 +1,7 @@
+/**
+ *  ! Autogenerated code !
+ *  Do not make changes to this file.
+ *  Changes may be overwritten as part of auto-generation.
+ */
+
+export * from './client-token-notification.js';
diff --git a/src/notifications/entities/index.ts b/src/notifications/entities/index.ts
@@ -19,3 +19,4 @@ export * from './payout/index.js';
 export * from './report/index.js';
 export * from './shared/index.js';
 export * from './api-key/index.js';
+export * from './client-token/index.js';
diff --git a/src/notifications/events/client-token/client-token-created-event.ts b/src/notifications/events/client-token/client-token-created-event.ts
@@ -0,0 +1,21 @@
+/**
+ *  ! Autogenerated code !
+ *  Do not make changes to this file.
+ *  Changes may be overwritten as part of auto-generation.
+ */
+
+import { Event } from '../../../entities/events/event.js';
+import { EventName } from '../../helpers/index.js';
+import { ClientTokenNotification } from '../../entities/index.js';
+import { type IEventsResponse } from '../../../types/index.js';
+import { IClientTokenNotificationResponse } from '../../types/index.js';
+
+export class ClientTokenCreatedEvent extends Event {
+  public override readonly eventType = EventName.ClientTokenCreated;
+  public override readonly data: ClientTokenNotification;
+
+  constructor(response: IEventsResponse<IClientTokenNotificationResponse>) {
+    super(response);
+    this.data = new ClientTokenNotification(response.data);
+  }
+}
diff --git a/src/notifications/events/client-token/client-token-revoked-event.ts b/src/notifications/events/client-token/client-token-revoked-event.ts
@@ -0,0 +1,21 @@
+/**
+ *  ! Autogenerated code !
+ *  Do not make changes to this file.
+ *  Changes may be overwritten as part of auto-generation.
+ */
+
+import { Event } from '../../../entities/events/event.js';
+import { EventName } from '../../helpers/index.js';
+import { ClientTokenNotification } from '../../entities/index.js';
+import { type IEventsResponse } from '../../../types/index.js';
+import { IClientTokenNotificationResponse } from '../../types/index.js';
+
+export class ClientTokenRevokedEvent extends Event {
+  public override readonly eventType = EventName.ClientTokenRevoked;
+  public override readonly data: ClientTokenNotification;
+
+  constructor(response: IEventsResponse<IClientTokenNotificationResponse>) {
+    super(response);
+    this.data = new ClientTokenNotification(response.data);
+  }
+}
diff --git a/src/notifications/events/client-token/client-token-updated-event.ts b/src/notifications/events/client-token/client-token-updated-event.ts
@@ -0,0 +1,21 @@
+/**
+ *  ! Autogenerated code !
+ *  Do not make changes to this file.
+ *  Changes may be overwritten as part of auto-generation.
+ */
+
+import { Event } from '../../../entities/events/event.js';
+import { EventName } from '../../helpers/index.js';
+import { ClientTokenNotification } from '../../entities/index.js';
+import { type IEventsResponse } from '../../../types/index.js';
+import { IClientTokenNotificationResponse } from '../../types/index.js';
+
+export class ClientTokenUpdatedEvent extends Event {
+  public override readonly eventType = EventName.ClientTokenUpdated;
+  public override readonly data: ClientTokenNotification;
+
+  constructor(response: IEventsResponse<IClientTokenNotificationResponse>) {
+    super(response);
+    this.data = new ClientTokenNotification(response.data);
+  }
+}
diff --git a/src/notifications/events/client-token/index.ts b/src/notifications/events/client-token/index.ts
@@ -0,0 +1,9 @@
+/**
+ *  ! Autogenerated code !
+ *  Do not make changes to this file.
+ *  Changes may be overwritten as part of auto-generation.
+ */
+
+export * from './client-token-created-event.js';
+export * from './client-token-updated-event.js';
+export * from './client-token-revoked-event.js';
diff --git a/src/notifications/events/index.ts b/src/notifications/events/index.ts
@@ -19,3 +19,4 @@ export * from './subscription/index.js';
 export * from './transaction/index.js';
 export * from './report/index.js';
 export * from './api-key/index.js';
+export * from './client-token/index.js';
diff --git a/src/notifications/helpers/types.ts b/src/notifications/helpers/types.ts
@@ -12,6 +12,9 @@ import {
   type BusinessCreatedEvent,
   type BusinessImportedEvent,
   type BusinessUpdatedEvent,
+  type ClientTokenCreatedEvent,
+  type ClientTokenRevokedEvent,
+  type ClientTokenUpdatedEvent,
   type CustomerCreatedEvent,
   type CustomerImportedEvent,
   type CustomerUpdatedEvent,
@@ -67,6 +70,9 @@ export type EventEntity =
   | BusinessCreatedEvent
   | BusinessUpdatedEvent
   | BusinessImportedEvent
+  | ClientTokenCreatedEvent
+  | ClientTokenUpdatedEvent
+  | ClientTokenRevokedEvent
   | CustomerCreatedEvent
   | CustomerUpdatedEvent
   | CustomerImportedEvent
@@ -121,6 +127,9 @@ export enum EventName {
   BusinessCreated = 'business.created',
   BusinessImported = 'business.imported',
   BusinessUpdated = 'business.updated',
+  ClientTokenCreated = 'client_token.created',
+  ClientTokenUpdated = 'client_token.updated',
+  ClientTokenRevoked = 'client_token.revoked',
   CustomerCreated = 'customer.created',
   CustomerUpdated = 'customer.updated',
   CustomerImported = 'customer.imported',
diff --git a/src/notifications/helpers/webhooks.ts b/src/notifications/helpers/webhooks.ts
@@ -15,6 +15,9 @@ import {
   BusinessCreatedEvent,
   BusinessImportedEvent,
   BusinessUpdatedEvent,
+  ClientTokenCreatedEvent,
+  ClientTokenRevokedEvent,
+  ClientTokenUpdatedEvent,
   CustomerCreatedEvent,
   CustomerImportedEvent,
   CustomerUpdatedEvent,
@@ -102,6 +105,12 @@ export class Webhooks {
         return new BusinessUpdatedEvent(data);
       case EventName.BusinessImported:
         return new BusinessImportedEvent(data);
+      case EventName.ClientTokenCreated:
+        return new ClientTokenCreatedEvent(data);
+      case EventName.ClientTokenUpdated:
+        return new ClientTokenUpdatedEvent(data);
+      case EventName.ClientTokenRevoked:
+        return new ClientTokenRevokedEvent(data);
       case EventName.CustomerCreated:
         return new CustomerCreatedEvent(data);
       case EventName.CustomerUpdated:
diff --git a/src/notifications/types/client-token/client-token-notification-response.ts b/src/notifications/types/client-token/client-token-notification-response.ts
@@ -0,0 +1,17 @@
+/**
+ *  ! Autogenerated code !
+ *  Do not make changes to this file.
+ *  Changes may be overwritten as part of auto-generation.
+ */
+import { ClientTokenStatus } from '../../../enums/index.js';
+
+export interface IClientTokenNotificationResponse {
+  id: string;
+  token: string;
+  name: string;
+  description: string | null;
+  status: ClientTokenStatus;
+  created_at: string;
+  updated_at: string;
+  revoked_at: string | null;
+}
diff --git a/src/notifications/types/client-token/index.ts b/src/notifications/types/client-token/index.ts
@@ -0,0 +1,7 @@
+/**
+ *  ! Autogenerated code !
+ *  Do not make changes to this file.
+ *  Changes may be overwritten as part of auto-generation.
+ */
+
+export * from './client-token-notification-response.js';
diff --git a/src/notifications/types/index.ts b/src/notifications/types/index.ts
@@ -19,3 +19,4 @@ export * from './payout/index.js';
 export * from './report/index.js';
 export * from './shared/index.js';
 export * from './api-key/index.js';
+export * from './client-token/index.js';
diff --git a/src/resources/client-tokens/index.ts b/src/resources/client-tokens/index.ts
@@ -29,11 +29,11 @@ export class ClientTokensResource extends BaseResource {
     return new ClientTokenCollection(this.client, ClientTokenPaths.list + queryParameters.toQueryString());
   }
 
-  public async create(createCustomerParameters: CreateClientTokenRequestBody): Promise<ClientToken> {
+  public async create(createClientTokenRequestBody: CreateClientTokenRequestBody): Promise<ClientToken> {
     const response = await this.client.post<
       CreateClientTokenRequestBody,
       Response<IClientTokenResponse> | ErrorResponse
-    >(ClientTokenPaths.create, createCustomerParameters);
+    >(ClientTokenPaths.create, createClientTokenRequestBody);
 
     const data = this.handleResponse<IClientTokenResponse>(response);
 
diff --git a/src/types/events/events-response.ts b/src/types/events/events-response.ts
