@paddle/paddle-node-sdk 0.2.0 → 0.2.2

package/CHANGELOG.md

@@ -8,6 +8,28 @@ 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.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
+
+- Added helper function to archive supported entities
+- Added `pricingPreview.preview()` to [preview calculations for one or more prices](https://developer.paddle.com/api-reference/pricing-preview/preview-prices?utm_source=dx&utm_medium=paddle-node-sdk) 
+
+### Changed
+
+- **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

@@ -63,6 +63,13 @@ Keep in mind that API keys are separate for your sandbox and live accounts, so y
 
 This SDK comes with TypeScript definitions for the Paddle API. We recommend that you update frequently to keep the TypeScript definitions up-to-date with the API. Use `// @ts-ignore` to prevent any type error if you don't want to update.
 
+## Naming conventions
+
+Properties in the Paddle API use `snake_case`. To follow JavaScript conventions, properties in this SDK use `camelCase`. This means:
+
+* Convert `snake_case` field names in the API docs to `camelCase` when creating or updating entities using the SDK.
+* Responses match the API docs, but field names are `camelCase` rather than `snake_case`.
+
 ## Examples
 
 ### List entities
@@ -74,16 +81,16 @@ import { Paddle } from '@paddle/paddle-node-sdk'
 
 const paddle = new Paddle('API_KEY')
 
-async function getProducts() {
+function getProducts() {
     // creates an iterator instance
-    const productCollection = await paddle.products.list()
+    const productCollection = paddle.products.list()
     return productCollection
 }
 
 try {
     // Creates an iterator to loop through paginated data. 
     // At this point, It does not hold any data.
-    const productCollection = await getProducts()
+    const productCollection = getProducts()
     
     // Call `next()` to retrieve first page of the dataset
     const firstPage = await productCollection.next()
@@ -117,7 +124,7 @@ async function createProduct(requestBody: CreateProductRequestBody) {
     }
 }
 
-const product = await createProduct({ name: 'ChatApp Education', tax_category: 'standard' })
+const product = await createProduct({ name: 'ChatApp Education', taxCategory: 'standard' })
 console.log("Product", product)
 ```
 
@@ -164,7 +171,7 @@ async function getProduct(productId: string) {
     try {
         // Pass the product id get
         const product = await paddle.products.get(productId)
-        // Returns an updated product entity
+        // Returns a product entity
         return product
     } catch (e) {
         // Handle Network/API errors
@@ -175,6 +182,39 @@ const product = await getProduct('id')
 console.log('Product', product)
 ```
 
+### Archive an entity
+
+You can archive an entity with the `archive` function in the resource. It accepts the `id` of the entity to archive. The entity is returned.
+ 
+#### Entities that support archival
+
+- Products
+- Prices
+- Discounts
+- Customers
+- Addresses
+- Businesses
+
+``` typescript
+import { Paddle } from '@paddle/paddle-node-sdk'
+
+const paddle = new Paddle('API_KEY')
+
+async function archiveProduct(productId: string) {
+    try {
+        // Pass the product id archive
+        const product = await paddle.products.archive(productId)
+        // Returns an archived product entity
+        return product
+    } catch (e) {
+        // Handle Network/API errors
+    }
+}
+
+const product = await archiveProduct('id')
+console.log('Product', product)
+```
+
 ## Resources
 
 ### Webhook signature verification 
@@ -182,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 
@@ -249,12 +328,12 @@ This table shows which operations are available as of the latest release.
 | **Adjustments**                              | **Full** |
 | List adjustments                             |    ✅     |
 | Create an adjustment                         |    ✅     |
-| **Pricing preview**                          | **None** |
-| Preview prices                               |    ❌     |
+| **Pricing preview**                          | **Full** |
+| Preview prices                               |    ✅     |
 | **Event types**                              | **None** |
 | List event types                             |    ❌     |
-| **Events**                                   | **None** |
-| List events                                  |    ❌     |
+| **Events**                                   | **Full** |
+| List events                                  |    ✅     |
 | **Notification settings**                    | **None** |
 | List notification settings                   |    ❌     |
 | Create a notification setting                |    ❌     |

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/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> {
+    fromJson(data: IEvents): EventEntity;
+}

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,6 @@ export * from './business';
 export * from './subscription';
 export * from './address';
 export * from './discount';
+export * from './events';
+export * from './payout';
 export type CustomData = object;

package/dist/entities/index.js

@@ -24,3 +24,5 @@ __exportStar(require("./business"), exports);
 __exportStar(require("./subscription"), exports);
 __exportStar(require("./address"), exports);
 __exportStar(require("./discount"), exports);
+__exportStar(require("./events"), exports);
+__exportStar(require("./payout"), exports);

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/pricing-preview/index.d.ts

@@ -0,0 +1,4 @@
+export * from './pricing-preview-discounts';
+export * from './pricing-preview-line-item';
+export * from './pricing-preview-details';
+export * from './pricing-preview';

package/dist/entities/pricing-preview/index.js

@@ -0,0 +1,20 @@
+"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("./pricing-preview-discounts"), exports);
+__exportStar(require("./pricing-preview-line-item"), exports);
+__exportStar(require("./pricing-preview-details"), exports);
+__exportStar(require("./pricing-preview"), exports);

package/dist/entities/pricing-preview/pricing-preview-details.d.ts

@@ -0,0 +1,6 @@
+import { PricingPreviewLineItem } from './pricing-preview-line-item';
+import { type IPricingPreviewDetailsResponse } from '../../types';
+export declare class PricingPreviewDetails {
+    readonly lineItems: PricingPreviewLineItem[];
+    constructor(details: IPricingPreviewDetailsResponse);
+}

package/dist/entities/pricing-preview/pricing-preview-details.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PricingPreviewDetails = void 0;
+const pricing_preview_line_item_1 = require("./pricing-preview-line-item");
+class PricingPreviewDetails {
+    constructor(details) {
+        this.lineItems = details.line_items.map((line_item) => new pricing_preview_line_item_1.PricingPreviewLineItem(line_item));
+    }
+}
+exports.PricingPreviewDetails = PricingPreviewDetails;

package/dist/entities/pricing-preview/pricing-preview-discounts.d.ts

@@ -0,0 +1,8 @@
+import { type IPricingPreviewDiscountsResponse } from '../../types';
+import { Discount } from '../index';
+export declare class PricingPreviewDiscounts {
+    readonly discount: Discount;
+    readonly total: string;
+    readonly formattedTotal: string;
+    constructor(previewDiscount: IPricingPreviewDiscountsResponse);
+}

package/dist/entities/pricing-preview/pricing-preview-discounts.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PricingPreviewDiscounts = void 0;
+const index_1 = require("../index");
+class PricingPreviewDiscounts {
+    constructor(previewDiscount) {
+        this.discount = new index_1.Discount(previewDiscount.discount);
+        this.total = previewDiscount.total;
+        this.formattedTotal = previewDiscount.formatted_total;
+    }
+}
+exports.PricingPreviewDiscounts = PricingPreviewDiscounts;

package/dist/entities/pricing-preview/pricing-preview-line-item.d.ts

@@ -0,0 +1,17 @@
+import { Price } from '../price';
+import { Totals } from '../shared';
+import { Product } from '../product';
+import { PricingPreviewDiscounts } from './pricing-preview-discounts';
+import { type IPricingPreviewLineItemResponse } from '../../types';
+export declare class PricingPreviewLineItem {
+    readonly price: Price;
+    readonly quantity: number;
+    readonly taxRate: string;
+    readonly unitTotals: Totals;
+    readonly formattedUnitTotals: Totals;
+    readonly totals: Totals;
+    readonly formattedTotals: Totals;
+    readonly product: Product;
+    readonly discounts: PricingPreviewDiscounts[];
+    constructor(lineItem: IPricingPreviewLineItemResponse);
+}

package/dist/entities/pricing-preview/pricing-preview-line-item.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PricingPreviewLineItem = void 0;
+const price_1 = require("../price");
+const shared_1 = require("../shared");
+const product_1 = require("../product");
+const pricing_preview_discounts_1 = require("./pricing-preview-discounts");
+class PricingPreviewLineItem {
+    constructor(lineItem) {
+        this.price = new price_1.Price(lineItem.price);
+        this.quantity = lineItem.quantity;
+        this.taxRate = lineItem.tax_rate;
+        this.unitTotals = new shared_1.Totals(lineItem.unit_totals);
+        this.formattedUnitTotals = new shared_1.Totals(lineItem.formatted_unit_totals);
+        this.totals = new shared_1.Totals(lineItem.totals);
+        this.formattedTotals = new shared_1.Totals(lineItem.formatted_totals);
+        this.product = new product_1.Product(lineItem.product);
+        this.discounts = lineItem.discounts.map((discount) => new pricing_preview_discounts_1.PricingPreviewDiscounts(discount));
+    }
+}
+exports.PricingPreviewLineItem = PricingPreviewLineItem;

package/dist/entities/pricing-preview/pricing-preview.d.ts

@@ -0,0 +1,15 @@
+import { type CurrencyCode } from '../../enums';
+import { type IPricingPreviewResponse } from '../../types';
+import { AddressPreview } from '../transaction';
+import { PricingPreviewDetails } from './pricing-preview-details';
+export declare class PricingPreview {
+    readonly customerId: string | null;
+    readonly addressId: string | null;
+    readonly businessId: string | null;
+    readonly currencyCode: CurrencyCode | null;
+    readonly discountId: string | null;
+    readonly address: AddressPreview | null;
+    readonly customerIpAddress: string | null;
+    readonly details: PricingPreviewDetails | null;
+    constructor(pricePreview: IPricingPreviewResponse);
+}

package/dist/entities/pricing-preview/pricing-preview.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PricingPreview = void 0;
+const transaction_1 = require("../transaction");
+const pricing_preview_details_1 = require("./pricing-preview-details");
+class PricingPreview {
+    constructor(pricePreview) {
+        var _a, _b, _c, _d, _e, _f;
+        this.customerId = (_a = pricePreview.customer_id) !== null && _a !== void 0 ? _a : null;
+        this.addressId = (_b = pricePreview.address_id) !== null && _b !== void 0 ? _b : null;
+        this.businessId = (_c = pricePreview.business_id) !== null && _c !== void 0 ? _c : null;
+        this.currencyCode = (_d = pricePreview.currency_code) !== null && _d !== void 0 ? _d : null;
+        this.discountId = (_e = pricePreview.discount_id) !== null && _e !== void 0 ? _e : null;
+        this.address = pricePreview.address ? new transaction_1.AddressPreview(pricePreview.address) : null;
+        this.customerIpAddress = (_f = pricePreview.customer_ip_address) !== null && _f !== void 0 ? _f : null;
+        this.details = pricePreview.details ? new pricing_preview_details_1.PricingPreviewDetails(pricePreview.details) : null;
+    }
+}
+exports.PricingPreview = PricingPreview;

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);
+}

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

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionNotification = void 0;
+const index_1 = require("../index");
+class SubscriptionNotification {
+    constructor(subscription) {
+        this.id = subscription.id;
+        this.status = subscription.status;
+        this.transactionId = subscription.transaction_id ? subscription.transaction_id : null;
+        this.customerId = subscription.customer_id;
+        this.addressId = subscription.address_id;
+        this.businessId = subscription.business_id ? subscription.business_id : null;
+        this.currencyCode = subscription.currency_code;
+        this.createdAt = subscription.created_at;
+        this.updatedAt = subscription.updated_at;
+        this.startedAt = subscription.started_at ? subscription.started_at : null;
+        this.firstBilledAt = subscription.first_billed_at ? subscription.first_billed_at : null;
+        this.nextBilledAt = subscription.next_billed_at ? subscription.next_billed_at : null;
+        this.pausedAt = subscription.paused_at ? subscription.paused_at : null;
+        this.canceledAt = subscription.canceled_at ? subscription.canceled_at : null;
+        this.discount = subscription.discount ? new index_1.SubscriptionDiscount(subscription.discount) : null;
+        this.collectionMode = subscription.collection_mode;
+        this.billingDetails = subscription.billing_details ? new index_1.BillingDetails(subscription.billing_details) : null;
+        this.currentBillingPeriod = subscription.current_billing_period
+            ? new index_1.SubscriptionTimePeriod(subscription.current_billing_period)
+            : null;
+        this.billingCycle = new index_1.TimePeriod(subscription.billing_cycle);
+        this.scheduledChange = subscription.scheduled_change
+            ? new index_1.SubscriptionScheduledChange(subscription.scheduled_change)
+            : null;
+        this.items = subscription.items.map((item) => new index_1.SubscriptionItem(item));
+        this.customData = subscription.custom_data ? subscription.custom_data : null;
+    }
+}
+exports.SubscriptionNotification = SubscriptionNotification;

package/dist/enums/index.d.ts

@@ -3,3 +3,4 @@ export * from './subscription';
 export * from './discount';
 export * from './adjustment';
 export * from './transaction';
+export * from './payout';

package/dist/enums/index.js

@@ -19,3 +19,4 @@ __exportStar(require("./subscription"), exports);
 __exportStar(require("./discount"), exports);
 __exportStar(require("./adjustment"), exports);
 __exportStar(require("./transaction"), exports);
+__exportStar(require("./payout"), exports);

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

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

package/dist/enums/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-status"), exports);

package/dist/enums/payout/payout-status.d.ts

@@ -0,0 +1 @@
+export type PayoutStatus = 'paid' | 'unpaid';

package/dist/enums/payout/payout-status.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/notifications/events/address/address-created-event.d.ts

@@ -0,0 +1,9 @@
+import { Address } from '../../../entities';
+import { type IAddressResponse, type IEventsResponse } from '../../../types';
+import { EventName } from '../../helpers';
+import { Event } from '../../../entities/events/event';
+export declare class AddressCreatedEvent extends Event {
+    readonly eventType = EventName.AddressCreated;
+    readonly data: Address;
+    constructor(response: IEventsResponse<IAddressResponse>);
+}

package/dist/notifications/events/address/address-created-event.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddressCreatedEvent = void 0;
+const entities_1 = require("../../../entities");
+const helpers_1 = require("../../helpers");
+const event_1 = require("../../../entities/events/event");
+class AddressCreatedEvent extends event_1.Event {
+    constructor(response) {
+        super(response);
+        this.eventType = helpers_1.EventName.AddressCreated;
+        this.data = new entities_1.Address(response.data);
+    }
+}
+exports.AddressCreatedEvent = AddressCreatedEvent;