Support api key exposure event (#209)

* feat: Add ApiKeyExposure enums and notification handling

* Introduced new enums for ApiKeyExposure including action taken, risk level, and source.
* Added ApiKeyExposureNotification class to handle notifications related to API key exposure.
* Implemented ApiKeyExposureCreatedEvent for event handling.
* Updated relevant index files to export new types and classes.
* Enhanced event handling to include ApiKeyExposureCreated events.

* test: Add mock for ApiKeyExposureCreated notification

* Introduced ApiKeyExposureCreatedMock and ApiKeyExposureCreatedMockExpectation for testing.
* Updated notifications-parser tests to include the new ApiKeyExposureCreated mock data.

* chore: Update CHANGELOG to include support for `api_key_exposure.created` event

* Update CHANGELOG.md

Co-authored-by: davidgrayston-paddle <david.grayston@paddle.com>

---------

Co-authored-by: davidgrayston-paddle <david.grayston@paddle.com>

Author: willme-paddle

CHANGELOG.md

@@ -25,6 +25,7 @@ adding additional type guards.
 ### Added
 
 - Added support for `wechat_pay` payment method.
+- Added support for `api_key_exposure.created` event. See [related changelog](https://developer.paddle.com/api-reference/about/api-keys?utm_source=dx&utm_medium=paddle-node-sdk#secret-scanning).
 
 ---
 

src/__tests__/mocks/notifications/api-key-exposure-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 { type IEventsResponse } from '../../../types/index.js';
+import { IApiKeyExposureNotificationResponse } from '../../../notifications/index.js';
+
+export const ApiKeyExposureCreatedMock: IEventsResponse<IApiKeyExposureNotificationResponse> = {
+  event_id: 'evt_01jkdr0rc527wcjdg1txsdxhtg',
+  event_type: 'api_key_exposure.created',
+  occurred_at: '2025-06-24T12:58:38.746382Z',
+  notification_id: 'ntf_01jkdr1mgbe62eqkh3p0fq8b0w',
+  data: {
+    id: 'apikeyexp_01jkdpbhazdpn3wpcya45as9tg',
+    api_key_id: 'apikey_01jkdpbhazdpn3wpcya45as9tg',
+    risk_level: 'high',
+    action_taken: 'revoked',
+    source: 'github',
+    reference: 'https://github.com/example/repo/blob/main/config.js',
+    description: 'API key found exposed in public GitHub repository.',
+    created_at: '2025-06-24T12:58:38.746382Z',
+  },
+};
+
+export const ApiKeyExposureCreatedMockExpectation = {
+  eventId: 'evt_01jkdr0rc527wcjdg1txsdxhtg',
+  eventType: 'api_key_exposure.created',
+  occurredAt: '2025-06-24T12:58:38.746382Z',
+  notificationId: 'ntf_01jkdr1mgbe62eqkh3p0fq8b0w',
+  data: {
+    id: 'apikeyexp_01jkdpbhazdpn3wpcya45as9tg',
+    apiKeyId: 'apikey_01jkdpbhazdpn3wpcya45as9tg',
+    riskLevel: 'high',
+    actionTaken: 'revoked',
+    source: 'github',
+    reference: 'https://github.com/example/repo/blob/main/config.js',
+    description: 'API key found exposed in public GitHub repository.',
+    createdAt: '2025-06-24T12:58:38.746382Z',
+  },
+};

src/__tests__/notifications/notifications-parser.test.ts

@@ -14,6 +14,10 @@ import { ApiKeyExpiredMock, ApiKeyExpiredMockExpectation } from '../mocks/notifi
 import { ApiKeyRevokedMock, ApiKeyRevokedMockExpectation } from '../mocks/notifications/api-key-revoked.mock.js';
 import { ApiKeyExpiringMock, ApiKeyExpiringMockExpectation } from '../mocks/notifications/api-key-expiring.mock.js';
 import { ApiKeyUpdatedMock, ApiKeyUpdatedMockExpectation } from '../mocks/notifications/api-key-updated.mock.js';
+import {
+  ApiKeyExposureCreatedMock,
+  ApiKeyExposureCreatedMockExpectation,
+} from '../mocks/notifications/api-key-exposure-created.mock.js';
 import { BusinessCreatedMock, BusinessCreatedMockExpectation } from '../mocks/notifications/business-created.mock.js';
 import { BusinessUpdatedMock, BusinessUpdatedMockExpectation } from '../mocks/notifications/business-updated.mock.js';
 import {
@@ -159,6 +163,7 @@ describe('Notifications Parser', () => {
     [ApiKeyExpiringMock.event_type, ApiKeyExpiringMock, ApiKeyExpiringMockExpectation],
     [ApiKeyRevokedMock.event_type, ApiKeyRevokedMock, ApiKeyRevokedMockExpectation],
     [ApiKeyUpdatedMock.event_type, ApiKeyUpdatedMock, ApiKeyUpdatedMockExpectation],
+    [ApiKeyExposureCreatedMock.event_type, ApiKeyExposureCreatedMock, ApiKeyExposureCreatedMockExpectation],
     [BusinessCreatedMock.event_type, BusinessCreatedMock, BusinessCreatedMockExpectation],
     [BusinessUpdatedMock.event_type, BusinessUpdatedMock, BusinessUpdatedMockExpectation],
     [BusinessImportedMock.event_type, BusinessImportedMock, BusinessImportedMockExpectation],

src/enums/api-key-exposure/action-taken.ts

@@ -0,0 +1,7 @@
+/**
+ *  ! Autogenerated code !
+ *  Do not make changes to this file.
+ *  Changes may be overwritten as part of auto-generation.
+ */
+
+export type ApiKeyExposureActionTaken = 'revoked' | 'none';

src/enums/api-key-exposure/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 './risk-level.js';
+export * from './action-taken.js';
+export * from './source.js';

src/enums/api-key-exposure/risk-level.ts

@@ -0,0 +1,7 @@
+/**
+ *  ! Autogenerated code !
+ *  Do not make changes to this file.
+ *  Changes may be overwritten as part of auto-generation.
+ */
+
+export type ApiKeyExposureRiskLevel = 'high' | 'low';

src/enums/api-key-exposure/source.ts

@@ -0,0 +1,7 @@
+/**
+ *  ! Autogenerated code !
+ *  Do not make changes to this file.
+ *  Changes may be overwritten as part of auto-generation.
+ */
+
+export type ApiKeyExposureSource = 'github';

src/enums/index.ts

@@ -19,4 +19,5 @@ export * from './simulation/index.js';
 export * from './simulation-run/index.js';
 export * from './simulation-run-event/index.js';
 export * from './api-key/index.js';
+export * from './api-key-exposure/index.js';
 export * from './client-tokens/index.js';

src/notifications/entities/api-key-exposure/api-key-exposure-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 { IApiKeyExposureNotificationResponse } from '../../types/index.js';
+import { ApiKeyExposureRiskLevel, ApiKeyExposureActionTaken, ApiKeyExposureSource } from '../../../enums/index.js';
+
+export class ApiKeyExposureNotification {
+  public readonly id: string;
+  public readonly apiKeyId: string;
+  public readonly riskLevel: ApiKeyExposureRiskLevel;
+  public readonly actionTaken: ApiKeyExposureActionTaken;
+  public readonly source: ApiKeyExposureSource;
+  public readonly reference: string;
+  public readonly description: string | null;
+  public readonly createdAt: string;
+
+  constructor(apiKeyExposure: IApiKeyExposureNotificationResponse) {
+    this.id = apiKeyExposure.id;
+    this.apiKeyId = apiKeyExposure.api_key_id;
+    this.riskLevel = apiKeyExposure.risk_level;
+    this.actionTaken = apiKeyExposure.action_taken;
+    this.source = apiKeyExposure.source;
+    this.reference = apiKeyExposure.reference;
+    this.description = apiKeyExposure.description ?? null;
+    this.createdAt = apiKeyExposure.created_at;
+  }
+}

src/notifications/entities/api-key-exposure/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 './api-key-exposure-notification.js';