@paddle/paddle-node-sdk 0.1.6 → 0.1.8

package/CHANGELOG.md

@@ -0,0 +1,88 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+> **Important:** While in early access(version 0.X.Y) we may introduce breaking changes. Where we can, we'll tag breaking changes in this changelog and communicate ahead of time.
+
+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.1.8 - 2023-11-24
+
+### Added
+
+- Added `transactions.preview()` to [preview a transaction](https://developer.paddle.com/api-reference/transactions/preview-transaction?utm_source=dx&utm_medium=paddle-node-sdk) operation.
+
+---
+
+## 0.1.7 - 2023-11-23
+
+### Added
+
+- Added changelog.
+
+--- 
+
+## 0.1.6 - 2023-11-22
+
+### Fixed
+
+- Fixed optional management URL object in subscription entities.
+
+--- 
+
+## 0.1.5 - 2023-11-14
+
+### Added
+
+- Added `transactions.getInvoicePDF()` for the [get a PDF invoice for a transaction](https://developer.paddle.com/api-reference/transactions/get-invoice-pdf?utm_source=dx&utm_medium=paddle-node-sdk) operation.
+- Enabled request and response logging.
+
+---
+
+## 0.1.4 - 2023-11-09
+
+### Removed
+
+- Removed unused dependency `lodash`.
+
+---
+
+## 0.1.3 - 2023-11-08
+
+### Fixed
+
+- Added missing query parameters for the [list transactions](https://developer.paddle.com/api-reference/transactions/list-transactions?utm_source=dx&utm_medium=paddle-node-sdk) operation.
+
+---
+
+## 0.1.2 - 2023-11-06
+
+### Fixed
+
+- Fixed incorrect update subscription request body TypeScript definition.
+
+---
+
+## 0.1.1 - 2023-11-06
+
+### Added
+
+- Added `customers.getCreditBalance()` for the [list credit balances for a customer](https://developer.paddle.com/api-reference/customers/list-credit-balances?utm_source=dx&utm_medium=paddle-node-sdk) operation.
+- Added `subscriptions.previewUpdate()` for the [preview an update to a subscription](https://developer.paddle.com/api-reference/subscriptions/preview-subscription?utm_source=dx&utm_medium=paddle-node-sdk) operation.
+- Added `subscriptions.activate()` for the [activate a trialing subscription](https://developer.paddle.com/api-reference/subscriptions/activate-subscription?utm_source=dx&utm_medium=paddle-node-sdk) operation.
+- Added `subscriptions.pause()` for the [pause a subscription](https://developer.paddle.com/api-reference/subscriptions/pause-subscription?utm_source=dx&utm_medium=paddle-node-sdk) operation.
+- Added `subscriptions.resume()` for the [resume a paused subscription](https://developer.paddle.com/api-reference/subscriptions/resume-subscription?utm_source=dx&utm_medium=paddle-node-sdk) operation.
+- Added `subscriptions.cancel()` for the [cancel a subscription](https://developer.paddle.com/api-reference/subscriptions/cancel-subscription?utm_source=dx&utm_medium=paddle-node-sdk) operation.
+- Added `subscriptions.createOneTimeCharge()` for the [create a one-time charge for a subscription](https://developer.paddle.com/api-reference/subscriptions/create-one-time-charge?utm_source=dx&utm_medium=paddle-node-sdk) operation.
+- Added `subscriptions.previewOneTimeCharge()` for the [preview a one-time charge for a subscription](https://developer.paddle.com/api-reference/subscriptions/preview-subscription-charge?utm_source=dx&utm_medium=paddle-node-sdk) operation.
+- Added `subscriptions.getPaymentMethodChangeTransaction()` for the [get a transaction to update payment method](https://developer.paddle.com/api-reference/subscriptions/update-payment-method?utm_source=dx&utm_medium=paddle-node-sdk) operation.
+
+---
+
+## 0.1.0 - 2023-11-03
+
+### Added
+
+- Initial early access release. Added support for the most frequently used Paddle Billing entities and API operations. Check the [README](./README.md) for more information.

package/README.md

@@ -44,29 +44,16 @@ To authenticate, you'll need an API key. You can create and manage API keys in *
 Pass your API key while initializing a new Paddle client.
 
 ``` typescript
-import { Environment, Paddle } from '@paddle/paddle-node-sdk';
+import { Environment, Paddle } from '@paddle/paddle-node-sdk'
 
-...
 const paddle = new Paddle('API_KEY')
-...
-
-async function getProducts() {
-    try {
-        const productCollection = await paddle.products.list()
-        return productCollection.next()
-    } catch (e) {
-        // Handle Network/API errors
-    }
-}
-
-const products = await getProducts()
 ```
 
 You can also pass an environment to work with the sandbox:
 
 ```typescript
 const paddle = new Paddle('API_KEY', {
-  environment: 'production' | 'sandbox'
+  environment: Environment.production, // or Environment.sandbox for accessing sandbox API
 })
 ```
 
@@ -83,28 +70,28 @@ This SDK comes with TypeScript definitions for the Paddle API. We recommend that
 You can list supported entities with the `list` function in the resource. It returns an iterator to help when working with multiple pages.
 
 ``` typescript
-import { Environment, Paddle } from '@paddle/paddle-node-sdk';
+import { Paddle } from '@paddle/paddle-node-sdk'
 
-...
 const paddle = new Paddle('API_KEY')
-...
 
 async function getProducts() {
     // creates an iterator instance
-    const productCollection = await paddle.products.list();
-    return productCollection;
+    const productCollection = await 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 = await getProducts()
     
     // Call `next()` to retrieve first page of the dataset
     const firstPage = await productCollection.next()
+    console.log("First page data", firstPage)
     
     // Calling `next()` again will retrieve subsequent pages.
     const secondPage = await productCollection.next()
+    console.log("Second page data", secondPage)
 } catch (e) {
     // Handle Network/API errors
 }
@@ -115,11 +102,9 @@ try {
 You can create a supported entity with the `create` function in the resource. It accepts the body to be created. The created entity is returned.
 
 ``` typescript
-import { Environment, Paddle, CreateProductRequestBody } from '@paddle/paddle-node-sdk';
+import { Paddle, CreateProductRequestBody } from '@paddle/paddle-node-sdk'
 
-...
 const paddle = new Paddle('API_KEY')
-...
 
 async function createProduct(requestBody: CreateProductRequestBody) {
     try {
@@ -132,7 +117,8 @@ async function createProduct(requestBody: CreateProductRequestBody) {
     }
 }
 
-const product = await createProduct({... object with required attributes})
+const product = await createProduct({ name: 'ChatApp Education', tax_category: 'standard' })
+console.log("Product", product)
 ```
 
 ### Update an entity
@@ -140,11 +126,9 @@ const product = await createProduct({... object with required attributes})
 You can update a supported entity with the `update` function in the resource. It accepts the `id` of the entity to update and an object with the attributes to be updated. The updated entity is returned.
 
 ``` typescript
-import { Environment, Paddle, UpdateProductRequestBody } from '@paddle/paddle-node-sdk';
+import { Paddle, UpdateProductRequestBody } from '@paddle/paddle-node-sdk'
 
-...
 const paddle = new Paddle('API_KEY')
-...
 
 async function updateProduct(productId: string, requestBody: UpdateProductRequestBody) {
     try {
@@ -157,7 +141,8 @@ async function updateProduct(productId: string, requestBody: UpdateProductReques
     }
 }
 
-const product = await updateProduct('id', {... object with attributes to be updated})
+const product = await updateProduct('id', { name: 'ChatApp for Schools' })
+console.log('Updated product', product)
 ```
 
 Where operations require more than one `id`, the `update` function accepts multiple arguments. For example, to update an address for a customer, pass the `customerId` and the `addressId`:
@@ -171,11 +156,9 @@ const address = await paddle.addresses.update(customerId, addressId, requestBody
 You can get an entity with the `get` function in the resource. It accepts the `id` of the entity to get. The entity is returned.
 
 ``` typescript
-import { Environment, Paddle } from '@paddle/paddle-node-sdk';
+import { Paddle } from '@paddle/paddle-node-sdk'
 
-...
 const paddle = new Paddle('API_KEY')
-...
 
 async function getProduct(productId: string) {
     try {
@@ -189,6 +172,7 @@ async function getProduct(productId: string) {
 }
 
 const product = await getProduct('id')
+console.log('Product', product)
 ```
 
 ## Resources
@@ -198,7 +182,7 @@ const product = await getProduct('id')
 The SDK includes a helper function to verify webhook signatures sent by Notifications from Paddle.
 
 ```typescript
-import { NotificationsValidator } from '@paddle/paddle-node-sdk';
+import { NotificationsValidator } from '@paddle/paddle-node-sdk'
 
 
 const isValid = new NotificationsValidator().isValidSignature('RAW_UNFORMATTED_REQUEST_BODY', 'PRIVATE_KEY_FROM_DASHBOARD', 'SIGNATURE_FROM_RESPONSE_HEADER')
@@ -210,79 +194,79 @@ While in early access, not all operations in the Paddle API are available in our
 
 This table shows which operations are available as of the latest release.
 
-| Paddle API operation                         |   Support   |
-|----------------------------------------------|:-----------:|
-| **Products**                                 |  **Full**   |
-| List products                                |      ✅      |
-| Create a product                             |      ✅      |
-| Get a product                                |      ✅      |
-| Update a product                             |      ✅      |
-| **Prices**                                   |  **Full**   |
-| List prices                                  |      ✅      |
-| Create a price                               |      ✅      |
-| Get a price                                  |      ✅      |
-| Update a price                               |      ✅      |
-| **Discounts**                                |  **Full**   |
-| List discounts                               |      ✅      |
-| Create a discount                            |      ✅      |
-| Get a discount                               |      ✅      |
-| Update a discount                            |      ✅      |
-| **Customers**                                |  **Full**   |
-| List customers                               |      ✅      |
-| Create a customer                            |      ✅      |
-| Get a customer                               |      ✅      |
-| Update a customer                            |      ✅      |
-| List credit balances for a customer          |      ✅      |
-| **Addresses**                                |  **Full**   |
-| List addresses for a customer                |      ✅      |
-| Create an addresses for a customer           |      ✅      |
-| Get an address for a customer                |      ✅      |
-| Update an address for a customer             |      ✅      |
-| **Businesses**                               |      ✅      |
-| List businesses for a customer               |      ✅      |
-| Create a business for a customer             |      ✅      |
-| Get a business for a customer                |      ✅      |
-| Update a business for a customer             |      ✅      |
-| **Transactions**                             | **Partial** |
-| List transactions                            |      ✅      |
-| Create a transaction                         |      ✅      |
-| Get a transaction                            |      ✅      |
-| Update a transaction                         |      ✅      |
-| Preview a transaction                        |      ❌      |
-| Get a PDF invoice for a transaction          |      ✅      |
-| **Subscriptions**                            |  **Full**   |
-| List subscriptions                           |      ✅      |
-| Get a subscription                           |      ✅      |
-| Preview an update to a subscription          |      ✅      |
-| Update a subscription                        |      ✅      |
-| Get a transaction to update payment method   |      ✅      |
-| Preview a one-time charge for a subscription |      ✅      |
-| Create a one-time charge for a subscription  |      ✅      |
-| Activate a trialing subscription             |      ✅      |
-| Pause a subscription                         |      ✅      |
-| Resume a paused subscription                 |      ✅      |
-| Cancel a subscription                        |      ✅      |
-| **Adjustments**                              |  **Full**   |
-| List adjustments                             |      ✅      |
-| Create an adjustment                         |      ✅      |
-| **Pricing preview**                          |  **None**   |
-| 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                 |      ❌      |
+| Paddle API operation                         | Support  |
+|----------------------------------------------|:--------:|
+| **Products**                                 | **Full** |
+| List products                                |    ✅     |
+| Create a product                             |    ✅     |
+| Get a product                                |    ✅     |
+| Update a product                             |    ✅     |
+| **Prices**                                   | **Full** |
+| List prices                                  |    ✅     |
+| Create a price                               |    ✅     |
+| Get a price                                  |    ✅     |
+| Update a price                               |    ✅     |
+| **Discounts**                                | **Full** |
+| List discounts                               |    ✅     |
+| Create a discount                            |    ✅     |
+| Get a discount                               |    ✅     |
+| Update a discount                            |    ✅     |
+| **Customers**                                | **Full** |
+| List customers                               |    ✅     |
+| Create a customer                            |    ✅     |
+| Get a customer                               |    ✅     |
+| Update a customer                            |    ✅     |
+| List credit balances for a customer          |    ✅     |
+| **Addresses**                                | **Full** |
+| List addresses for a customer                |    ✅     |
+| Create an addresses for a customer           |    ✅     |
+| Get an address for a customer                |    ✅     |
+| Update an address for a customer             |    ✅     |
+| **Businesses**                               |    ✅     |
+| List businesses for a customer               |    ✅     |
+| Create a business for a customer             |    ✅     |
+| Get a business for a customer                |    ✅     |
+| Update a business for a customer             |    ✅     |
+| **Transactions**                             | **Full** |
+| List transactions                            |    ✅     |
+| Create a transaction                         |    ✅     |
+| Get a transaction                            |    ✅     |
+| Update a transaction                         |    ✅     |
+| Preview a transaction                        |    ✅     |
+| Get a PDF invoice for a transaction          |    ✅     |
+| **Subscriptions**                            | **Full** |
+| List subscriptions                           |    ✅     |
+| Get a subscription                           |    ✅     |
+| Preview an update to a subscription          |    ✅     |
+| Update a subscription                        |    ✅     |
+| Get a transaction to update payment method   |    ✅     |
+| Preview a one-time charge for a subscription |    ✅     |
+| Create a one-time charge for a subscription  |    ✅     |
+| Activate a trialing subscription             |    ✅     |
+| Pause a subscription                         |    ✅     |
+| Resume a paused subscription                 |    ✅     |
+| Cancel a subscription                        |    ✅     |
+| **Adjustments**                              | **Full** |
+| List adjustments                             |    ✅     |
+| Create an adjustment                         |    ✅     |
+| **Pricing preview**                          | **None** |
+| 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                 |    ❌     |
 
 ## Learn more
 

package/dist/entities/subscription/transaction-line-item-preview.d.ts

@@ -2,7 +2,7 @@ import { type ITransactionLineItemPreview } from '../../types';
 import { UnitTotals, Totals, Product } from '../index';
 export declare class TransactionLineItemPreview {
     readonly price_id: string;
-    readonly quantity: unknown;
+    readonly quantity: number;
     readonly tax_rate: string;
     readonly unit_totals: UnitTotals;
     readonly totals: Totals;

package/dist/entities/transaction/address-preview.d.ts

@@ -0,0 +1,8 @@
+import { type CountryCode } from '../../enums';
+import { type IAddressPreview } from '../../resources';
+export declare class AddressPreview {
+    readonly postal_code?: string | null | undefined;
+    readonly country_code: CountryCode;
+    constructor(address: IAddressPreview);
+    toJson(): IAddressPreview;
+}

package/dist/entities/transaction/address-preview.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddressPreview = void 0;
+class AddressPreview {
+    constructor(address) {
+        this.postal_code = address.postal_code;
+        this.country_code = address.country_code;
+    }
+    toJson() {
+        return {
+            postal_code: this.postal_code,
+            country_code: this.country_code,
+        };
+    }
+}
+exports.AddressPreview = AddressPreview;

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

@@ -11,3 +11,7 @@ export * from './transaction-includes';
 export * from './transaction';
 export * from './transaction-collection';
 export * from './transaction-invoice-pdf';
+export * from './transaction-preview';
+export * from './transaction-item-preview';
+export * from './proration';
+export * from './address-preview';

package/dist/entities/transaction/index.js

@@ -27,3 +27,7 @@ __exportStar(require("./transaction-includes"), exports);
 __exportStar(require("./transaction"), exports);
 __exportStar(require("./transaction-collection"), exports);
 __exportStar(require("./transaction-invoice-pdf"), exports);
+__exportStar(require("./transaction-preview"), exports);
+__exportStar(require("./transaction-item-preview"), exports);
+__exportStar(require("./proration"), exports);
+__exportStar(require("./address-preview"), exports);

package/dist/entities/transaction/proration.d.ts

@@ -0,0 +1,8 @@
+import { TransactionsTimePeriod } from '../index';
+import { type IProration } from '../../types';
+export declare class Proration {
+    readonly rate: string;
+    readonly billing_period: TransactionsTimePeriod;
+    constructor(prorationResponse: IProration);
+    toJson(): IProration;
+}

package/dist/entities/transaction/proration.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Proration = void 0;
+const index_1 = require("../index");
+class Proration {
+    constructor(prorationResponse) {
+        this.rate = prorationResponse.rate;
+        this.billing_period = new index_1.TransactionsTimePeriod(prorationResponse.billing_period);
+    }
+    toJson() {
+        return {
+            rate: this.rate,
+            billing_period: this.billing_period,
+        };
+    }
+}
+exports.Proration = Proration;

package/dist/entities/transaction/transaction-item-preview.d.ts

@@ -0,0 +1,10 @@
+import { PriceWithIncludes, Proration } from '../index';
+import { type ITransactionItemPreviewResponse } from '../../types';
+export declare class TransactionItemPreview {
+    readonly price?: PriceWithIncludes | null | undefined;
+    readonly quantity: number;
+    readonly include_in_totals?: boolean | null | undefined;
+    readonly proration?: Proration | null | undefined;
+    constructor(transactionItem: ITransactionItemPreviewResponse);
+    toJson(): ITransactionItemPreviewResponse;
+}

package/dist/entities/transaction/transaction-item-preview.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionItemPreview = void 0;
+const index_1 = require("../index");
+class TransactionItemPreview {
+    constructor(transactionItem) {
+        this.price = transactionItem.price ? new index_1.PriceWithIncludes(transactionItem.price) : null;
+        this.quantity = transactionItem.quantity;
+        this.include_in_totals = transactionItem.include_in_totals;
+        this.proration = transactionItem.proration ? new index_1.Proration(transactionItem.proration) : null;
+    }
+    toJson() {
+        return {
+            price: this.price,
+            quantity: this.quantity,
+            include_in_totals: this.include_in_totals,
+            proration: this.proration,
+        };
+    }
+}
+exports.TransactionItemPreview = TransactionItemPreview;

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

@@ -0,0 +1,17 @@
+import { type ITransactionPreview } from '../../types';
+import { AddressPreview, TransactionDetailsPreview, TransactionItemPreview } from '../index';
+import { type CurrencyCode } from '../../enums';
+export declare class TransactionPreview {
+    readonly customer_id?: string | null | undefined;
+    readonly address_id?: string | null | undefined;
+    readonly business_id?: string | null | undefined;
+    readonly currency_code: CurrencyCode;
+    readonly discount_id?: string | null | undefined;
+    readonly customer_ip_address?: string | null | undefined;
+    readonly address?: AddressPreview | null | undefined;
+    readonly ignore_trials?: boolean | null | undefined;
+    readonly items: TransactionItemPreview[];
+    readonly details: TransactionDetailsPreview;
+    constructor(transactionPreview: ITransactionPreview);
+    toJson(): ITransactionPreview;
+}

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

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionPreview = void 0;
+const index_1 = require("../index");
+class TransactionPreview {
+    constructor(transactionPreview) {
+        this.customer_id = transactionPreview.customer_id;
+        this.address_id = transactionPreview.address_id;
+        this.business_id = transactionPreview.business_id;
+        this.currency_code = transactionPreview.currency_code;
+        this.discount_id = transactionPreview.discount_id;
+        this.customer_ip_address = transactionPreview.customer_ip_address;
+        this.address = transactionPreview.address ? new index_1.AddressPreview(transactionPreview.address) : null;
+        this.ignore_trials = transactionPreview.ignore_trials;
+        this.items = transactionPreview.items.map((item) => new index_1.TransactionItemPreview(item));
+        this.details = new index_1.TransactionDetailsPreview(transactionPreview.details);
+    }
+    toJson() {
+        return {
+            customer_id: this.customer_id,
+            address_id: this.address_id,
+            business_id: this.business_id,
+            currency_code: this.currency_code,
+            discount_id: this.discount_id,
+            customer_ip_address: this.customer_ip_address,
+            address: this.address,
+            ignore_trials: this.ignore_trials,
+            items: this.items,
+            details: this.details,
+        };
+    }
+}
+exports.TransactionPreview = TransactionPreview;

package/dist/resources/transactions/index.d.ts

@@ -1,6 +1,6 @@
-import { Transaction, TransactionCollection, TransactionIncludes, TransactionInvoicePDF } from '../../entities';
+import { Transaction, TransactionCollection, TransactionIncludes, TransactionInvoicePDF, TransactionPreview } from '../../entities';
 import { BaseResource } from '../../internal/base';
-import { type CreateTransactionQueryParameters, type CreateTransactionRequestBody, type GetTransactionQueryParameters, type ListTransactionQueryParameters, type UpdateTransactionRequestBody } from './operations';
+import { type CreateTransactionQueryParameters, type CreateTransactionRequestBody, type GetTransactionQueryParameters, type ListTransactionQueryParameters, type UpdateTransactionRequestBody, type TransactionPreviewRequestBody } from './operations';
 export * from './operations';
 export declare class TransactionsResource extends BaseResource {
     list(queryParams?: ListTransactionQueryParameters): Promise<TransactionCollection>;
@@ -8,4 +8,5 @@ export declare class TransactionsResource extends BaseResource {
     update(transactionId: string, updateTransaction: UpdateTransactionRequestBody): Promise<Transaction>;
     get(transactionId: string, queryParams?: GetTransactionQueryParameters): Promise<TransactionIncludes>;
     getInvoicePDF(transactionId: string): Promise<TransactionInvoicePDF>;
+    preview(previewTransactionParameters: TransactionPreviewRequestBody): Promise<TransactionPreview>;
 }

package/dist/resources/transactions/index.js

@@ -32,6 +32,7 @@ const TransactionPaths = {
     get: '/transactions/{transaction_id}',
     update: '/transactions/{transaction_id}',
     getInvoicePDF: '/transactions/{transaction_id}/invoice',
+    preview: '/transactions/preview',
 };
 __exportStar(require("./operations"), exports);
 class TransactionsResource extends base_1.BaseResource {
@@ -80,5 +81,12 @@ class TransactionsResource extends base_1.BaseResource {
             return new entities_1.TransactionInvoicePDF(data);
         });
     }
+    preview(previewTransactionParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.client.post(TransactionPaths.preview, previewTransactionParameters);
+            const data = this.handleResponse(response);
+            return new entities_1.TransactionPreview(data);
+        });
+    }
 }
 exports.TransactionsResource = TransactionsResource;

package/dist/resources/transactions/operations/index.d.ts

@@ -5,3 +5,4 @@ export * from './get-transaction-query-parameters';
 export * from './get-transaction-path-parameters';
 export * from './update-transaction-path-parameters';
 export * from './update-transaction-request-body';
+export * from './transaction-preview-request-body';

package/dist/resources/transactions/operations/index.js

@@ -21,3 +21,4 @@ __exportStar(require("./get-transaction-query-parameters"), exports);
 __exportStar(require("./get-transaction-path-parameters"), exports);
 __exportStar(require("./update-transaction-path-parameters"), exports);
 __exportStar(require("./update-transaction-request-body"), exports);
+__exportStar(require("./transaction-preview-request-body"), exports);

package/dist/resources/transactions/operations/transaction-preview-request-body.d.ts

@@ -0,0 +1,17 @@
+import { type CountryCode, type CurrencyCode } from '../../../enums';
+import { type ITransactionItemPreviewRequest } from '../../../types';
+export interface IAddressPreview {
+    postal_code?: string | null | undefined;
+    country_code: CountryCode;
+}
+export interface TransactionPreviewRequestBody {
+    items: ITransactionItemPreviewRequest[];
+    customer_id?: string | null | undefined;
+    address_id?: string | null | undefined;
+    business_id?: string | null | undefined;
+    currency_code?: CurrencyCode | null | undefined;
+    discount_id?: string | null | undefined;
+    customer_ip_address?: string | null | undefined;
+    address?: IAddressPreview | null | undefined;
+    ignore_trials?: boolean | null | undefined;
+}

package/dist/resources/transactions/operations/transaction-preview-request-body.js

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

package/dist/types/shared/transaction-line-item-preview.d.ts

@@ -1,7 +1,7 @@
 import { type IUnitTotals, type ITotals, type ISharedProduct } from '../index';
 export interface ITransactionLineItemPreview {
     price_id: string;
-    quantity: unknown;
+    quantity: number;
     tax_rate: string;
     unit_totals: IUnitTotals;
     totals: ITotals;

package/dist/types/transaction/index.d.ts

@@ -9,3 +9,5 @@ export * from './adjustment-totals-breakdown';
 export * from './adjustment-totals';
 export * from './transaction';
 export * from './transaction-invoice-pdf';
+export * from './transaction-preview-item';
+export * from './transaction-preview';

package/dist/types/transaction/index.js

@@ -25,3 +25,5 @@ __exportStar(require("./adjustment-totals-breakdown"), exports);
 __exportStar(require("./adjustment-totals"), exports);
 __exportStar(require("./transaction"), exports);
 __exportStar(require("./transaction-invoice-pdf"), exports);
+__exportStar(require("./transaction-preview-item"), exports);
+__exportStar(require("./transaction-preview"), exports);

package/dist/types/transaction/transaction-preview-item.d.ts

@@ -0,0 +1,5 @@
+export interface ITransactionItemPreviewRequest {
+    price_id: string;
+    quantity: number;
+    include_in_totals?: boolean | null | undefined;
+}

package/dist/types/transaction/transaction-preview-item.js

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

package/dist/types/transaction/transaction-preview.d.ts

@@ -0,0 +1,27 @@
+import { type CurrencyCode } from '../../enums';
+import { type IAddressPreview } from '../../resources';
+import { type ITransactionDetailsPreview } from '../shared';
+import { type IPrice } from '../price';
+import { type ITransactionsTimePeriod } from './transactions-time-period';
+export interface IProration {
+    rate: string;
+    billing_period: ITransactionsTimePeriod;
+}
+export interface ITransactionItemPreviewResponse {
+    price?: IPrice | null | undefined;
+    quantity: number;
+    include_in_totals?: boolean | null | undefined;
+    proration?: IProration | null | undefined;
+}
+export interface ITransactionPreview {
+    customer_id?: string | null | undefined;
+    address_id?: string | null | undefined;
+    business_id?: string | null | undefined;
+    currency_code: CurrencyCode;
+    discount_id?: string | null | undefined;
+    customer_ip_address?: string | null | undefined;
+    address?: IAddressPreview | null | undefined;
+    ignore_trials?: boolean | null | undefined;
+    items: ITransactionItemPreviewResponse[];
+    details: ITransactionDetailsPreview;
+}

package/dist/types/transaction/transaction-preview.js

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

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.1.6";
+export declare const SDK_VERSION = "0.1.8";

package/dist/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = '0.1.6';
+exports.SDK_VERSION = '0.1.8';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paddle/paddle-node-sdk",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "description": "A NodeJS SDK for Paddle Billing API",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",