@paddle/paddle-node-sdk 0.2.1 → 0.2.3

package/CHANGELOG.md

@@ -8,6 +8,37 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 Check our main [developer changelog](https://developer.paddle.com/?utm_source=dx&utm_medium=paddle-node-sdk) for information about changes to the Paddle Billing platform, the Paddle API, and other developer tools.
 
+## 0.2.3 - 2023-12-12
+
+### Added
+
+- Added `eventTypes.list()` to [list all event types](https://developer.paddle.com/api-reference/event-types/list-event-types?utm_source=dx&utm_medium=paddle-node-sdk)
+- Added `notificationSettings.list()` to [list all notification settings](https://developer.paddle.com/api-reference/notification-settings/list-notification-settings?utm_source=dx&utm_medium=paddle-node-sdk)
+- Added `notificationSettings.create()` to [create a notification settings](https://developer.paddle.com/api-reference/notification-settings/create-notification-setting?utm_source=dx&utm_medium=paddle-node-sdk)
+- Added `notificationSettings.get()` to [get a notification settings](https://developer.paddle.com/api-reference/notification-settings/get-notification-setting?utm_source=dx&utm_medium=paddle-node-sdk)
+- Added `notificationSettings.update()` to [update a notification settings](https://developer.paddle.com/api-reference/notification-settings/update-notification-setting?utm_source=dx&utm_medium=paddle-node-sdk)
+- Added `notificationSettings.delete()` to [delete a notification settings](https://developer.paddle.com/api-reference/notification-settings/delete-notification-setting?utm_source=dx&utm_medium=paddle-node-sdk)
+- Added `notifications.list()` to [list all notifications](https://developer.paddle.com/api-reference/notifications/list-notifications?utm_source=dx&utm_medium=paddle-node-sdk) 
+- Added `notifications.get()` to [get a notification](https://developer.paddle.com/api-reference/notifications/get-notification?utm_source=dx&utm_medium=paddle-node-sdk)
+- Added `notifications.replay()` to [replay a notification](https://developer.paddle.com/api-reference/notifications/replay-notification?utm_source=dx&utm_medium=paddle-node-sdk)
+- Added `notifications.getLogs()` to [get all logs for a notification](https://developer.paddle.com/api-reference/notification-logs/list-notification-logs?utm_source=dx&utm_medium=paddle-node-sdk)
+
+
+### Fixed
+
+- Fixed incorrect type of `action` in `subscriptions.scheduled_change`
+
+---
+
+## 0.2.2 - 2023-12-01
+
+### Added
+
+- Added `events.list()` to [list all events](https://developer.paddle.com/api-reference/events/list-events?utm_source=dx&utm_medium=paddle-node-sdk)
+- Added helper function `paddle.webhooks.unmarshal` to [validate](https://developer.paddle.com/webhooks/signature-verification?utm_source=dx&utm_medium=paddle-node-sdk) and parse webhook events
+
+---
+
 ## 0.2.1 - 2023-11-29
 
 ### Added
@@ -19,6 +50,8 @@ Check our main [developer changelog](https://developer.paddle.com/?utm_source=dx
 
 - **Breaking change:** Converted all `list` operations to be synchronous. They did not have any async operation within them, and it was incorrectly typed to return a `Promise`.
 
+---
+
 ## 0.2.0 - 2023-11-28
 
 > **Breaking changes:** This version includes major improvements that introduce breaking changes. These are called out below.

package/README.md

@@ -222,10 +222,49 @@ console.log('Product', product)
 The SDK includes a helper function to verify webhook signatures sent by Notifications from Paddle.
 
 ```typescript
-import { NotificationsValidator } from '@paddle/paddle-node-sdk'
+import { Paddle, EventName } from '@paddle/paddle-node-sdk'
+import express, { Request, Response } from 'express'
 
+const paddle = new Paddle('API_KEY')
+const app = express()
+
+// Create a `POST` endpoint to accept webhooks sent by Paddle.
+// We need `raw` request body to validate the integrity. Use express raw middleware to ensure express doesn't convert the request body to JSON.
+app.post('/webhooks', express.raw({ type: 'application/json' }), (req: Request, res: Response) => {
+  const signature = (req.headers['paddle-signature'] as string) || '';
+  // req.body should be of type `buffer`, convert to string before passing it to `unmarshal`. 
+  // If express returned a JSON, remove any other middleware that might have processed raw request to object
+  const rawRequestBody = req.body.toString();
+  // Replace with `PRIVATE_KEY` from vendor dashboard
+  const privateKey = process.env['PRIVATE_KEY'] || '';
+
+  try {
+    if (signature && rawRequestBody) {
+      // The `unmarshal` function will validate the integrity of the webhook and return an entity
+      const eventData = paddle.webhooks.unmarshal(rawRequestBody, privateKey, signature);
+      switch (eventData.eventType) {
+        case EventName.ProductUpdated:
+          console.log(`Product ${eventData.data.id} was updated`);
+          break;
+        case EventName.SubscriptionUpdated:
+          console.log(`Subscription ${eventData.data.id} was updated`);
+          break;
+        default:
+          console.log(eventData.eventType);
+      }
+    } else {
+      console.log('Signature missing in header');
+    }
+  } catch (e) {
+    // Handle signature mismatch or other runtime errors
+    console.log(e);
+  }
+  // Return a response to acknowledge
+  res.send('Processed webhook event');
+});
+
+app.listen(3000)
 
-const isValid = new NotificationsValidator().isValidSignature('RAW_UNFORMATTED_REQUEST_BODY', 'PRIVATE_KEY_FROM_DASHBOARD', 'SIGNATURE_FROM_RESPONSE_HEADER')
 ```
 
 ## Feature parity 
@@ -291,22 +330,22 @@ This table shows which operations are available as of the latest release.
 | Create an adjustment                         |    ✅     |
 | **Pricing preview**                          | **Full** |
 | Preview prices                               |    ✅     |
-| **Event types**                              | **None** |
-| List event types                             |    ❌     |
-| **Events**                                   | **None** |
-| List events                                  |    ❌     |
-| **Notification settings**                    | **None** |
-| List notification settings                   |    ❌     |
-| Create a notification setting                |    ❌     |
-| Get a notification setting                   |    ❌     |
-| Update a notification setting                |    ❌     |
-| Delete a notification setting                |    ❌     |
-| **Notifications**                            | **None** |
-| List notifications                           |    ❌     |
-| Get a notification                           |    ❌     |
-| Replay a notification                        |    ❌     |
-| **Notification logs**                        | **None** |
-| List logs for a notification                 |    ❌     |
+| **Event types**                              | **Full** |
+| List event types                             |    ✅     |
+| **Events**                                   | **Full** |
+| List events                                  |    ✅     |
+| **Notification settings**                    | **Full** |
+| List notification settings                   |    ✅     |
+| Create a notification setting                |    ✅     |
+| Get a notification setting                   |    ✅     |
+| Update a notification setting                |    ✅     |
+| Delete a notification setting                |    ✅     |
+| **Notifications**                            | **Full** |
+| List notifications                           |    ✅     |
+| Get a notification                           |    ✅     |
+| Replay a notification                        |    ✅     |
+| **Notification logs**                        | **Full** |
+| List logs for a notification                 |    ✅     |
 
 ## Learn more
 

package/dist/entities/discount/discount.d.ts

@@ -16,7 +16,7 @@ export declare class Discount {
     readonly restrictTo: string[] | null;
     readonly expiresAt: string | null;
     readonly customData: CustomData | null;
-    readonly timesUsed: number;
+    readonly timesUsed: number | null;
     readonly createdAt: string;
     readonly updatedAt: string;
     constructor(discount: IDiscountResponse);

package/dist/entities/discount/discount.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Discount = void 0;
 class Discount {
     constructor(discount) {
+        var _a;
         this.id = discount.id;
         this.status = discount.status;
         this.description = discount.description;
@@ -17,7 +18,7 @@ class Discount {
         this.restrictTo = discount.restrict_to ? discount.restrict_to : null;
         this.expiresAt = discount.expires_at ? discount.expires_at : null;
         this.customData = discount.custom_data ? discount.custom_data : null;
-        this.timesUsed = discount.times_used;
+        this.timesUsed = (_a = discount.times_used) !== null && _a !== void 0 ? _a : null;
         this.createdAt = discount.created_at;
         this.updatedAt = discount.updated_at;
     }

package/dist/entities/event-types/event-type.d.ts

@@ -0,0 +1,9 @@
+import { type IEventTypeResponse } from '../../types';
+import { type IEventName } from '../../notifications';
+export declare class EventType {
+    readonly name: IEventName;
+    readonly description: string;
+    readonly group: string;
+    readonly availableVersions: number[];
+    constructor(eventType: IEventTypeResponse);
+}

package/dist/entities/event-types/event-type.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventType = void 0;
+class EventType {
+    constructor(eventType) {
+        this.name = eventType.name;
+        this.description = eventType.description;
+        this.group = eventType.group;
+        this.availableVersions = eventType.available_versions;
+    }
+}
+exports.EventType = EventType;

package/dist/entities/event-types/index.d.ts

@@ -0,0 +1 @@
+export * from './event-type';

package/dist/entities/event-types/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./event-type"), exports);

package/dist/entities/events/event-collection.d.ts

@@ -0,0 +1,6 @@
+import { Collection } from '../../internal/base';
+import { type IEvents, type IEventsResponse } from '../../types';
+import { type EventEntity } from '../../notifications';
+export declare class EventCollection extends Collection<IEventsResponse, EventEntity | null> {
+    fromJson(data: IEvents): EventEntity | null;
+}

package/dist/entities/events/event-collection.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventCollection = void 0;
+const base_1 = require("../../internal/base");
+const notifications_1 = require("../../notifications");
+class EventCollection extends base_1.Collection {
+    fromJson(data) {
+        return notifications_1.Webhooks.fromJson(data);
+    }
+}
+exports.EventCollection = EventCollection;

package/dist/entities/events/event.d.ts

@@ -0,0 +1,9 @@
+import { type IEventsResponse } from '../../types';
+export declare class Event {
+    eventId: string;
+    notificationId: string | null;
+    eventType: string;
+    occurredAt: string;
+    data: object;
+    constructor(eventData: IEventsResponse);
+}

package/dist/entities/events/event.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Event = void 0;
+class Event {
+    constructor(eventData) {
+        var _a;
+        this.eventId = eventData.event_id;
+        this.notificationId = (_a = eventData.notification_id) !== null && _a !== void 0 ? _a : null;
+        this.eventType = eventData.event_type;
+        this.occurredAt = eventData.occurred_at;
+        this.data = eventData.data;
+    }
+}
+exports.Event = Event;

package/dist/entities/events/index.d.ts

@@ -0,0 +1 @@
+export * from './event-collection';

package/dist/entities/events/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./event-collection"), exports);

package/dist/entities/index.d.ts

@@ -8,4 +8,9 @@ export * from './business';
 export * from './subscription';
 export * from './address';
 export * from './discount';
+export * from './events';
+export * from './payout';
+export * from './event-types';
+export * from './notification-settings';
+export * from './notifications';
 export type CustomData = object;

package/dist/entities/index.js

@@ -24,3 +24,8 @@ __exportStar(require("./business"), exports);
 __exportStar(require("./subscription"), exports);
 __exportStar(require("./address"), exports);
 __exportStar(require("./discount"), exports);
+__exportStar(require("./events"), exports);
+__exportStar(require("./payout"), exports);
+__exportStar(require("./event-types"), exports);
+__exportStar(require("./notification-settings"), exports);
+__exportStar(require("./notifications"), exports);

package/dist/entities/notification-settings/index.d.ts

@@ -0,0 +1 @@
+export * from './notification-settings';

package/dist/entities/notification-settings/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./notification-settings"), exports);

package/dist/entities/notification-settings/notification-settings.d.ts

@@ -0,0 +1,15 @@
+import { type NotificationSettingsType } from '../../enums';
+import { EventType } from '../event-types';
+import { type INotificationSettingsResponse } from '../../types/notification-settings';
+export declare class NotificationSettings {
+    readonly id: string;
+    readonly description: string;
+    readonly type: NotificationSettingsType;
+    readonly destination: string;
+    readonly active: boolean;
+    readonly apiVersion: number;
+    readonly includeSensitiveFields: boolean;
+    readonly subscribedEvents: EventType[];
+    readonly endpointSecretKey: string;
+    constructor(notificationSettings: INotificationSettingsResponse);
+}

package/dist/entities/notification-settings/notification-settings.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationSettings = void 0;
+const event_types_1 = require("../event-types");
+class NotificationSettings {
+    constructor(notificationSettings) {
+        this.id = notificationSettings.id;
+        this.description = notificationSettings.description;
+        this.type = notificationSettings.type;
+        this.destination = notificationSettings.destination;
+        this.active = notificationSettings.active;
+        this.apiVersion = notificationSettings.api_version;
+        this.includeSensitiveFields = notificationSettings.include_sensitive_fields;
+        this.subscribedEvents = notificationSettings.subscribed_events.map((subscribed_event) => new event_types_1.EventType(subscribed_event));
+        this.endpointSecretKey = notificationSettings.endpoint_secret_key;
+    }
+}
+exports.NotificationSettings = NotificationSettings;

package/dist/entities/notifications/index.d.ts

@@ -0,0 +1,5 @@
+export * from './notification';
+export * from './notification-log';
+export * from './notification-collection';
+export * from './replay-notification';
+export * from './notification-log-collection';

package/dist/entities/notifications/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./notification"), exports);
+__exportStar(require("./notification-log"), exports);
+__exportStar(require("./notification-collection"), exports);
+__exportStar(require("./replay-notification"), exports);
+__exportStar(require("./notification-log-collection"), exports);

package/dist/entities/notifications/notification-collection.d.ts

@@ -0,0 +1,6 @@
+import { Collection } from '../../internal/base';
+import { Notification } from './notification';
+import { type INotificationResponse } from '../../types/notifications';
+export declare class NotificationCollection extends Collection<INotificationResponse, Notification> {
+    fromJson(data: INotificationResponse): Notification;
+}

package/dist/entities/notifications/notification-collection.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationCollection = void 0;
+const base_1 = require("../../internal/base");
+const notification_1 = require("./notification");
+class NotificationCollection extends base_1.Collection {
+    fromJson(data) {
+        return new notification_1.Notification(data);
+    }
+}
+exports.NotificationCollection = NotificationCollection;

package/dist/entities/notifications/notification-log-collection.d.ts

@@ -0,0 +1,6 @@
+import { Collection } from '../../internal/base';
+import { type INotificationLogResponse } from '../../types';
+import { NotificationLog } from './notification-log';
+export declare class NotificationLogCollection extends Collection<INotificationLogResponse, NotificationLog> {
+    fromJson(data: INotificationLogResponse): NotificationLog;
+}

package/dist/entities/notifications/notification-log-collection.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationLogCollection = void 0;
+const base_1 = require("../../internal/base");
+const notification_log_1 = require("./notification-log");
+class NotificationLogCollection extends base_1.Collection {
+    fromJson(data) {
+        return new notification_log_1.NotificationLog(data);
+    }
+}
+exports.NotificationLogCollection = NotificationLogCollection;

package/dist/entities/notifications/notification-log.d.ts

@@ -0,0 +1,8 @@
+export declare class NotificationLog {
+    readonly id: string;
+    readonly responseCode: number;
+    readonly responseContentType: string | null;
+    readonly responseBody: string;
+    readonly attemptedAt: string;
+    constructor(notificationLogResponse: any);
+}

package/dist/entities/notifications/notification-log.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationLog = void 0;
+class NotificationLog {
+    constructor(notificationLogResponse) {
+        var _a;
+        this.id = notificationLogResponse.id;
+        this.responseCode = notificationLogResponse.response_code;
+        this.responseContentType = (_a = notificationLogResponse.response_content_type) !== null && _a !== void 0 ? _a : null;
+        this.responseBody = notificationLogResponse.response_body;
+        this.attemptedAt = notificationLogResponse.attempted_at;
+    }
+}
+exports.NotificationLog = NotificationLog;

package/dist/entities/notifications/notification.d.ts

@@ -0,0 +1,18 @@
+import { type NotificationStatus, type Origin } from '../../enums';
+import { type EventEntity, type IEventName } from '../../notifications';
+import { type INotificationResponse } from '../../types';
+export declare class Notification {
+    readonly id: string;
+    readonly type: IEventName;
+    readonly status: NotificationStatus;
+    readonly payload: EventEntity | null;
+    readonly occurredAt: string;
+    readonly deliveredAt: null | string;
+    readonly replayedAt: null | string;
+    readonly origin: Origin;
+    readonly lastAttemptAt: null | string;
+    readonly retryAt: null | string;
+    readonly timesAttempted: number;
+    readonly notificationSettingId: string;
+    constructor(notificationResponse: INotificationResponse);
+}

package/dist/entities/notifications/notification.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Notification = void 0;
+const notifications_1 = require("../../notifications");
+class Notification {
+    constructor(notificationResponse) {
+        var _a, _b, _c, _d;
+        this.id = notificationResponse.id;
+        this.type = notificationResponse.type;
+        this.status = notificationResponse.status;
+        this.payload = notifications_1.Webhooks.fromJson(notificationResponse.payload);
+        this.occurredAt = notificationResponse.occurred_at;
+        this.deliveredAt = (_a = notificationResponse.delivered_at) !== null && _a !== void 0 ? _a : null;
+        this.replayedAt = (_b = notificationResponse.replayed_at) !== null && _b !== void 0 ? _b : null;
+        this.origin = notificationResponse.origin;
+        this.lastAttemptAt = (_c = notificationResponse.last_attempt_at) !== null && _c !== void 0 ? _c : null;
+        this.retryAt = (_d = notificationResponse.retry_at) !== null && _d !== void 0 ? _d : null;
+        this.timesAttempted = notificationResponse.times_attempted;
+        this.notificationSettingId = notificationResponse.notification_setting_id;
+    }
+}
+exports.Notification = Notification;

package/dist/entities/notifications/replay-notification.d.ts

@@ -0,0 +1,5 @@
+import { type IReplayNotificationResponse } from '../../types/notifications';
+export declare class ReplayNotification {
+    readonly notificationId: string;
+    constructor(notificationResponse: IReplayNotificationResponse);
+}

package/dist/entities/notifications/replay-notification.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReplayNotification = void 0;
+class ReplayNotification {
+    constructor(notificationResponse) {
+        this.notificationId = notificationResponse.notification_id;
+    }
+}
+exports.ReplayNotification = ReplayNotification;

package/dist/entities/payout/index.d.ts

@@ -0,0 +1 @@
+export * from './payout';

package/dist/entities/payout/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./payout"), exports);

package/dist/entities/payout/payout.d.ts

@@ -0,0 +1,9 @@
+import { type IPayoutResponse } from '../../types';
+import { type CurrencyCode, type PayoutStatus } from '../../enums';
+export declare class Payout {
+    readonly id: string;
+    readonly status: PayoutStatus;
+    readonly amount: string;
+    readonly currencyCode: CurrencyCode;
+    constructor(payout: IPayoutResponse);
+}

package/dist/entities/payout/payout.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Payout = void 0;
+class Payout {
+    constructor(payout) {
+        this.id = payout.id;
+        this.status = payout.status;
+        this.amount = payout.amount;
+        this.currencyCode = payout.currency_code;
+    }
+}
+exports.Payout = Payout;

package/dist/entities/subscription/index.d.ts

@@ -15,3 +15,4 @@ export * from './subscription-preview-update-summary';
 export * from './subscription-preview-summary-result';
 export * from './next-transaction-adjustment-preview';
 export * from './next-transaction-adjustment-item';
+export * from './subscription-notification';

package/dist/entities/subscription/index.js

@@ -31,3 +31,4 @@ __exportStar(require("./subscription-preview-update-summary"), exports);
 __exportStar(require("./subscription-preview-summary-result"), exports);
 __exportStar(require("./next-transaction-adjustment-preview"), exports);
 __exportStar(require("./next-transaction-adjustment-item"), exports);
+__exportStar(require("./subscription-notification"), exports);

package/dist/entities/subscription/subscription-notification.d.ts

@@ -0,0 +1,28 @@
+import { BillingDetails, type CustomData, SubscriptionDiscount, SubscriptionItem, SubscriptionScheduledChange, SubscriptionTimePeriod, TimePeriod } from '../index';
+import { type CollectionMode, type CurrencyCode, type SubscriptionStatus } from '../../enums';
+import { type ISubscriptionNotificationResponse } from '../../types';
+export declare class SubscriptionNotification {
+    readonly id: string;
+    readonly status: SubscriptionStatus;
+    readonly transactionId: string | null;
+    readonly customerId: string;
+    readonly addressId: string;
+    readonly businessId: string | null;
+    readonly currencyCode: CurrencyCode;
+    readonly createdAt: string;
+    readonly updatedAt: string;
+    readonly startedAt: string | null;
+    readonly firstBilledAt: string | null;
+    readonly nextBilledAt: string | null;
+    readonly pausedAt: string | null;
+    readonly canceledAt: string | null;
+    readonly discount: SubscriptionDiscount | null;
+    readonly collectionMode: CollectionMode;
+    readonly billingDetails: BillingDetails | null;
+    readonly currentBillingPeriod: SubscriptionTimePeriod | null;
+    readonly billingCycle: TimePeriod;
+    readonly scheduledChange: SubscriptionScheduledChange | null;
+    readonly items: SubscriptionItem[];
+    readonly customData: CustomData | null;
+    constructor(subscription: ISubscriptionNotificationResponse);
+}