@paddle/paddle-node-sdk 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -8,6 +8,17 @@ 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.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 
@@ -249,8 +289,8 @@ 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** |

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/paddle.d.ts

@@ -1,4 +1,4 @@
-import { AddressesResource, AdjustmentsResource, BusinessesResource, CustomersResource, DiscountsResource, PricesResource, ProductsResource, SubscriptionsResource, TransactionsResource } from './resources';
+import { AddressesResource, AdjustmentsResource, BusinessesResource, CustomersResource, DiscountsResource, PricesResource, PricingPreviewResource, ProductsResource, SubscriptionsResource, TransactionsResource } from './resources';
 import { type PaddleOptions } from './internal';
 export declare class Paddle {
     private readonly client;
@@ -12,5 +12,6 @@ export declare class Paddle {
     businesses: BusinessesResource;
     discounts: DiscountsResource;
     subscriptions: SubscriptionsResource;
+    pricingPreview: PricingPreviewResource;
     constructor(apiKey: string, options: PaddleOptions);
 }

package/dist/paddle.js

@@ -19,6 +19,7 @@ class Paddle {
         this.businesses = new resources_1.BusinessesResource(this.client);
         this.discounts = new resources_1.DiscountsResource(this.client);
         this.subscriptions = new resources_1.SubscriptionsResource(this.client);
+        this.pricingPreview = new resources_1.PricingPreviewResource(this.client);
     }
 }
 exports.Paddle = Paddle;

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

@@ -3,8 +3,9 @@ import { BaseResource } from '../../internal/base';
 import { type ListAddressQueryParameters, type CreateAddressRequestBody, type UpdateAddressRequestBody } from './operations';
 export * from './operations';
 export declare class AddressesResource extends BaseResource {
-    list(customerId: string, queryParams?: ListAddressQueryParameters): Promise<AddressCollection>;
+    list(customerId: string, queryParams?: ListAddressQueryParameters): AddressCollection;
     create(customerId: string, createAddressParameters: CreateAddressRequestBody): Promise<Address>;
     get(customerId: string, addressId: string): Promise<Address>;
     update(customerId: string, addressId: string, updateAddress: UpdateAddressRequestBody): Promise<Address>;
+    archive(customerId: string, addressId: string): Promise<Address>;
 }

package/dist/resources/addresses/index.js

@@ -35,13 +35,11 @@ const AddressPaths = {
 __exportStar(require("./operations"), exports);
 class AddressesResource extends base_1.BaseResource {
     list(customerId, queryParams) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const queryParameters = new base_1.QueryParameters(queryParams);
-            const urlWithPathParams = new base_1.PathParameters(AddressPaths.list, {
-                customer_id: customerId,
-            }).deriveUrl();
-            return new entities_1.AddressCollection(this.client, urlWithPathParams + queryParameters.toQueryString());
-        });
+        const queryParameters = new base_1.QueryParameters(queryParams);
+        const urlWithPathParams = new base_1.PathParameters(AddressPaths.list, {
+            customer_id: customerId,
+        }).deriveUrl();
+        return new entities_1.AddressCollection(this.client, urlWithPathParams + queryParameters.toQueryString());
     }
     create(customerId, createAddressParameters) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -75,5 +73,10 @@ class AddressesResource extends base_1.BaseResource {
             return new entities_1.Address(data);
         });
     }
+    archive(customerId, addressId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.update(customerId, addressId, { status: 'archived' });
+        });
+    }
 }
 exports.AddressesResource = AddressesResource;

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

@@ -3,6 +3,6 @@ import { BaseResource } from '../../internal/base';
 import { type CreateAdjustmentRequestBody, type ListAdjustmentQueryParameters } from './operations';
 export * from './operations';
 export declare class AdjustmentsResource extends BaseResource {
-    list(queryParams?: ListAdjustmentQueryParameters): Promise<AdjustmentCollection>;
+    list(queryParams?: ListAdjustmentQueryParameters): AdjustmentCollection;
     create(createAdjustmentParameters: CreateAdjustmentRequestBody): Promise<Adjustment>;
 }

package/dist/resources/adjustments/index.js

@@ -33,10 +33,8 @@ const AdjustmentPaths = {
 __exportStar(require("./operations"), exports);
 class AdjustmentsResource extends base_1.BaseResource {
     list(queryParams) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const queryParameters = new base_1.QueryParameters(queryParams);
-            return new entities_1.AdjustmentCollection(this.client, AdjustmentPaths.list + queryParameters.toQueryString());
-        });
+        const queryParameters = new base_1.QueryParameters(queryParams);
+        return new entities_1.AdjustmentCollection(this.client, AdjustmentPaths.list + queryParameters.toQueryString());
     }
     create(createAdjustmentParameters) {
         return __awaiter(this, void 0, void 0, function* () {

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

@@ -3,8 +3,9 @@ import { BaseResource } from '../../internal/base';
 import { type CreateBusinessRequestBody, type ListBusinessQueryParameters, type UpdateBusinessRequestBody } from './operations';
 export * from './operations';
 export declare class BusinessesResource extends BaseResource {
-    list(customerId: string, queryParams?: ListBusinessQueryParameters): Promise<BusinessCollection>;
+    list(customerId: string, queryParams?: ListBusinessQueryParameters): BusinessCollection;
     create(customerId: string, createBusinessParameters: CreateBusinessRequestBody): Promise<Business>;
     get(customerId: string, businessId: string): Promise<Business>;
     update(customerId: string, businessId: string, updateBusiness: UpdateBusinessRequestBody): Promise<Business>;
+    archive(customerId: string, addressId: string): Promise<Business>;
 }

package/dist/resources/businesses/index.js

@@ -35,13 +35,11 @@ const BusinessPaths = {
 __exportStar(require("./operations"), exports);
 class BusinessesResource extends base_1.BaseResource {
     list(customerId, queryParams) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const queryParameters = new base_1.QueryParameters(queryParams);
-            const urlWithPathParams = new base_1.PathParameters(BusinessPaths.list, {
-                customer_id: customerId,
-            }).deriveUrl();
-            return new entities_1.BusinessCollection(this.client, urlWithPathParams + queryParameters.toQueryString());
-        });
+        const queryParameters = new base_1.QueryParameters(queryParams);
+        const urlWithPathParams = new base_1.PathParameters(BusinessPaths.list, {
+            customer_id: customerId,
+        }).deriveUrl();
+        return new entities_1.BusinessCollection(this.client, urlWithPathParams + queryParameters.toQueryString());
     }
     create(customerId, createBusinessParameters) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -75,5 +73,10 @@ class BusinessesResource extends base_1.BaseResource {
             return new entities_1.Business(data);
         });
     }
+    archive(customerId, addressId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.update(customerId, addressId, { status: 'archived' });
+        });
+    }
 }
 exports.BusinessesResource = BusinessesResource;

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

@@ -3,9 +3,10 @@ import { BaseResource } from '../../internal/base';
 import { type CreateCustomerRequestBody, type GetCreditBalanceQueryParameters, type ListCustomerQueryParameters, type UpdateCustomerRequestBody } from './operations';
 export * from './operations';
 export declare class CustomersResource extends BaseResource {
-    list(queryParams?: ListCustomerQueryParameters): Promise<CustomerCollection>;
+    list(queryParams?: ListCustomerQueryParameters): CustomerCollection;
     create(createCustomerParameters: CreateCustomerRequestBody): Promise<Customer>;
     get(customerId: string): Promise<Customer>;
     update(customerId: string, updateCustomer: UpdateCustomerRequestBody): Promise<Customer>;
     getCreditBalance(customerId: string, queryParams?: GetCreditBalanceQueryParameters): Promise<CreditBalance[]>;
+    archive(customerId: string): Promise<Customer>;
 }

package/dist/resources/customers/index.js

@@ -36,10 +36,8 @@ const CustomerPaths = {
 __exportStar(require("./operations"), exports);
 class CustomersResource extends base_1.BaseResource {
     list(queryParams) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const queryParameters = new base_1.QueryParameters(queryParams);
-            return new entities_1.CustomerCollection(this.client, CustomerPaths.list + queryParameters.toQueryString());
-        });
+        const queryParameters = new base_1.QueryParameters(queryParams);
+        return new entities_1.CustomerCollection(this.client, CustomerPaths.list + queryParameters.toQueryString());
     }
     create(createCustomerParameters) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -79,5 +77,10 @@ class CustomersResource extends base_1.BaseResource {
             return data.map((balance) => new entities_1.CreditBalance(balance));
         });
     }
+    archive(customerId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.update(customerId, { status: 'archived' });
+        });
+    }
 }
 exports.CustomersResource = CustomersResource;

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

@@ -3,8 +3,9 @@ import { BaseResource } from '../../internal/base';
 import { type CreateDiscountRequestBody, type ListDiscountQueryParameters, type UpdateDiscountRequestBody } from './operations';
 export * from './operations';
 export declare class DiscountsResource extends BaseResource {
-    list(queryParams?: ListDiscountQueryParameters): Promise<DiscountCollection>;
+    list(queryParams?: ListDiscountQueryParameters): DiscountCollection;
     create(createDiscountParameters: CreateDiscountRequestBody): Promise<Discount>;
     get(discountId: string): Promise<Discount>;
     update(discountId: string, updateDiscount: UpdateDiscountRequestBody): Promise<Discount>;
+    archive(discountId: string): Promise<Discount>;
 }

package/dist/resources/discounts/index.js

@@ -35,10 +35,8 @@ const DiscountPaths = {
 __exportStar(require("./operations"), exports);
 class DiscountsResource extends base_1.BaseResource {
     list(queryParams) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const queryParameters = new base_1.QueryParameters(queryParams);
-            return new entities_1.DiscountCollection(this.client, DiscountPaths.list + queryParameters.toQueryString());
-        });
+        const queryParameters = new base_1.QueryParameters(queryParams);
+        return new entities_1.DiscountCollection(this.client, DiscountPaths.list + queryParameters.toQueryString());
     }
     create(createDiscountParameters) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -67,5 +65,10 @@ class DiscountsResource extends base_1.BaseResource {
             return new entities_1.Discount(data);
         });
     }
+    archive(discountId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.update(discountId, { status: 'archived' });
+        });
+    }
 }
 exports.DiscountsResource = DiscountsResource;

package/dist/resources/index.d.ts

@@ -7,3 +7,4 @@ export * from './prices';
 export * from './products';
 export * from './subscriptions';
 export * from './transactions';
+export * from './pricing-preview';

package/dist/resources/index.js

@@ -23,3 +23,4 @@ __exportStar(require("./prices"), exports);
 __exportStar(require("./products"), exports);
 __exportStar(require("./subscriptions"), exports);
 __exportStar(require("./transactions"), exports);
+__exportStar(require("./pricing-preview"), exports);

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

@@ -3,8 +3,9 @@ import { BaseResource } from '../../internal/base';
 import { type CreatePriceRequestBody, type GetPriceQueryParameters, type ListPriceQueryParameters, type UpdatePriceRequestBody } from './operations';
 export * from './operations';
 export declare class PricesResource extends BaseResource {
-    list(queryParams?: ListPriceQueryParameters): Promise<PriceCollection>;
+    list(queryParams?: ListPriceQueryParameters): PriceCollection;
     create(createPriceParameters: CreatePriceRequestBody): Promise<Price>;
     get(priceId: string, queryParams?: GetPriceQueryParameters): Promise<PriceWithIncludes>;
     update(priceId: string, updatePrice: UpdatePriceRequestBody): Promise<Price>;
+    archive(priceId: string): Promise<Price>;
 }

package/dist/resources/prices/index.js

@@ -35,10 +35,8 @@ const PricePaths = {
 __exportStar(require("./operations"), exports);
 class PricesResource extends base_1.BaseResource {
     list(queryParams) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const queryParameters = new base_1.QueryParameters(queryParams);
-            return new entities_1.PriceCollection(this.client, PricePaths.list + queryParameters.toQueryString());
-        });
+        const queryParameters = new base_1.QueryParameters(queryParams);
+        return new entities_1.PriceCollection(this.client, PricePaths.list + queryParameters.toQueryString());
     }
     create(createPriceParameters) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -68,5 +66,10 @@ class PricesResource extends base_1.BaseResource {
             return new entities_1.Price(data);
         });
     }
+    archive(priceId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.update(priceId, { status: 'archived' });
+        });
+    }
 }
 exports.PricesResource = PricesResource;

package/dist/resources/pricing-preview/index.d.ts

@@ -0,0 +1,7 @@
+import { BaseResource } from '../../internal/base';
+import { type PricingPreviewRequestBody } from './operations';
+import { PricingPreview } from '../../entities/pricing-preview';
+export * from './operations';
+export declare class PricingPreviewResource extends BaseResource {
+    preview(pricePreviewParameter: PricingPreviewRequestBody): Promise<PricingPreview>;
+}

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

@@ -0,0 +1,42 @@
+"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);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PricingPreviewResource = void 0;
+const base_1 = require("../../internal/base");
+const pricing_preview_1 = require("../../entities/pricing-preview");
+const PricingPreviewPaths = {
+    preview: '/pricing-preview',
+};
+__exportStar(require("./operations"), exports);
+class PricingPreviewResource extends base_1.BaseResource {
+    preview(pricePreviewParameter) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.client.post(PricingPreviewPaths.preview, pricePreviewParameter);
+            const data = this.handleResponse(response);
+            return new pricing_preview_1.PricingPreview(data);
+        });
+    }
+}
+exports.PricingPreviewResource = PricingPreviewResource;

package/dist/resources/pricing-preview/operations/index.d.ts

@@ -0,0 +1 @@
+export * from './pricing-preview-request-body';

package/dist/resources/pricing-preview/operations/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("./pricing-preview-request-body"), exports);

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

@@ -0,0 +1,17 @@
+import { type CurrencyCode } from '../../../enums';
+import { type IAddressPreview } from '../../transactions';
+interface IPricePreviewItem {
+    priceId: string;
+    quantity: number;
+}
+export interface PricingPreviewRequestBody {
+    items: IPricePreviewItem[];
+    customerId?: string | null;
+    addressId?: string | null;
+    businessId?: string | null;
+    currencyCode?: CurrencyCode;
+    discountId?: string | null;
+    address?: IAddressPreview | null;
+    customerIpAddress?: string | null;
+}
+export {};

package/dist/resources/pricing-preview/operations/pricing-preview-request-body.js

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

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

@@ -3,8 +3,9 @@ import { BaseResource } from '../../internal/base';
 import { type CreateProductRequestBody, type GetProductQueryParameters, type ListProductQueryParameters, type UpdateProductRequestBody } from './operations';
 export * from './operations';
 export declare class ProductsResource extends BaseResource {
-    list(queryParams?: ListProductQueryParameters): Promise<ProductCollection>;
+    list(queryParams?: ListProductQueryParameters): ProductCollection;
     create(createProductParameters: CreateProductRequestBody): Promise<Product>;
     get(productId: string, queryParams?: GetProductQueryParameters): Promise<ProductWithIncludes>;
     update(productId: string, updateProduct: UpdateProductRequestBody): Promise<Product>;
+    archive(productId: string): Promise<Product>;
 }

package/dist/resources/products/index.js

@@ -35,10 +35,8 @@ const ProductPaths = {
 __exportStar(require("./operations"), exports);
 class ProductsResource extends base_1.BaseResource {
     list(queryParams) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const queryParameters = new base_1.QueryParameters(queryParams);
-            return new entities_1.ProductCollection(this.client, ProductPaths.list + queryParameters.toQueryString());
-        });
+        const queryParameters = new base_1.QueryParameters(queryParams);
+        return new entities_1.ProductCollection(this.client, ProductPaths.list + queryParameters.toQueryString());
     }
     create(createProductParameters) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -68,5 +66,10 @@ class ProductsResource extends base_1.BaseResource {
             return new entities_1.Product(data);
         });
     }
+    archive(productId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.update(productId, { status: 'archived' });
+        });
+    }
 }
 exports.ProductsResource = ProductsResource;

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

@@ -5,7 +5,7 @@ export * from './operations';
 export declare class SubscriptionsResource extends BaseResource {
     previewUpdate(subscriptionId: string, updateSubscription: UpdateSubscriptionRequestBody): Promise<SubscriptionPreview>;
     update(subscriptionId: string, updateSubscription: UpdateSubscriptionRequestBody): Promise<Subscription>;
-    list(queryParams?: ListSubscriptionQueryParameters): Promise<SubscriptionCollection>;
+    list(queryParams?: ListSubscriptionQueryParameters): SubscriptionCollection;
     get(subscriptionId: string, queryParams?: GetSubscriptionQueryParameters): Promise<SubscriptionIncludes>;
     activate(subscriptionId: string): Promise<Subscription>;
     pause(subscriptionId: string, requestBody: PauseSubscription): Promise<Subscription>;

package/dist/resources/subscriptions/index.js

@@ -62,10 +62,8 @@ class SubscriptionsResource extends base_1.BaseResource {
         });
     }
     list(queryParams) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const queryParameters = new base_1.QueryParameters(queryParams);
-            return new entities_1.SubscriptionCollection(this.client, SubscriptionPaths.list + queryParameters.toQueryString());
-        });
+        const queryParameters = new base_1.QueryParameters(queryParams);
+        return new entities_1.SubscriptionCollection(this.client, SubscriptionPaths.list + queryParameters.toQueryString());
     }
     get(subscriptionId, queryParams) {
         return __awaiter(this, void 0, void 0, function* () {

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

@@ -3,7 +3,7 @@ import { BaseResource } from '../../internal/base';
 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>;
+    list(queryParams?: ListTransactionQueryParameters): TransactionCollection;
     create(createTransactionParameters: CreateTransactionRequestBody, queryParams?: CreateTransactionQueryParameters): Promise<TransactionIncludes>;
     update(transactionId: string, updateTransaction: UpdateTransactionRequestBody): Promise<Transaction>;
     get(transactionId: string, queryParams?: GetTransactionQueryParameters): Promise<TransactionIncludes>;

package/dist/resources/transactions/index.js

@@ -37,10 +37,8 @@ const TransactionPaths = {
 __exportStar(require("./operations"), exports);
 class TransactionsResource extends base_1.BaseResource {
     list(queryParams) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const queryParameters = new base_1.QueryParameters(queryParams);
-            return new entities_1.TransactionCollection(this.client, TransactionPaths.list + queryParameters.toQueryString());
-        });
+        const queryParameters = new base_1.QueryParameters(queryParams);
+        return new entities_1.TransactionCollection(this.client, TransactionPaths.list + queryParameters.toQueryString());
     }
     create(createTransactionParameters, queryParams) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/types/index.d.ts

@@ -8,3 +8,4 @@ export * from './business';
 export * from './subscription';
 export * from './address';
 export * from './discount';
+export * from './pricing-preview';

package/dist/types/index.js

@@ -24,3 +24,4 @@ __exportStar(require("./business"), exports);
 __exportStar(require("./subscription"), exports);
 __exportStar(require("./address"), exports);
 __exportStar(require("./discount"), exports);
+__exportStar(require("./pricing-preview"), exports);

package/dist/types/pricing-preview/index.d.ts

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

package/dist/types/pricing-preview/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("./pricing-preview-response"), exports);
+__exportStar(require("./pricing-preview-details-response"), exports);
+__exportStar(require("./pricing-preview-discounts-response"), exports);
+__exportStar(require("./pricing-preview-item-response"), exports);
+__exportStar(require("./pricing-preview-line-item-response"), exports);

package/dist/types/pricing-preview/pricing-preview-details-response.d.ts

@@ -0,0 +1,4 @@
+import { type IPricingPreviewLineItemResponse } from './pricing-preview-line-item-response';
+export interface IPricingPreviewDetailsResponse {
+    line_items: IPricingPreviewLineItemResponse[];
+}

package/dist/types/pricing-preview/pricing-preview-details-response.js

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

package/dist/types/pricing-preview/pricing-preview-discounts-response.d.ts

@@ -0,0 +1,6 @@
+import { type IDiscountResponse } from '../discount';
+export interface IPricingPreviewDiscountsResponse {
+    discount: IDiscountResponse;
+    total: string;
+    formatted_total: string;
+}

package/dist/types/pricing-preview/pricing-preview-discounts-response.js

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

package/dist/types/pricing-preview/pricing-preview-item-response.d.ts

@@ -0,0 +1,4 @@
+export interface IPricingPreviewItemResponse {
+    price_id?: string | null;
+    quantity: number;
+}

package/dist/types/pricing-preview/pricing-preview-item-response.js

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

package/dist/types/pricing-preview/pricing-preview-line-item-response.d.ts

@@ -0,0 +1,15 @@
+import { type IPriceResponse } from '../price';
+import { type ITotals, type IUnitTotals } from '../shared';
+import { type IProductResponse } from '../product';
+import { type IPricingPreviewDiscountsResponse } from './pricing-preview-discounts-response';
+export interface IPricingPreviewLineItemResponse {
+    price: IPriceResponse;
+    quantity: number;
+    tax_rate: string;
+    unit_totals: IUnitTotals;
+    formatted_unit_totals: IUnitTotals;
+    totals: ITotals;
+    formatted_totals: ITotals;
+    product: IProductResponse;
+    discounts: IPricingPreviewDiscountsResponse[];
+}

package/dist/types/pricing-preview/pricing-preview-line-item-response.js

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

package/dist/types/pricing-preview/pricing-preview-response.d.ts

@@ -0,0 +1,15 @@
+import { type CurrencyCode } from '../../enums';
+import { type IAddressPreviewResponse } from '../../resources';
+import { type IPricingPreviewItemResponse } from './pricing-preview-item-response';
+import { type IPricingPreviewDetailsResponse } from './pricing-preview-details-response';
+export interface IPricingPreviewResponse {
+    customer_id?: string | null;
+    address_id?: string | null;
+    business_id?: string | null;
+    currency_code?: CurrencyCode | null;
+    discount_id?: string | null;
+    address?: IAddressPreviewResponse | null;
+    customer_ip_address?: string | null;
+    items: IPricingPreviewItemResponse[];
+    details?: IPricingPreviewDetailsResponse | null;
+}

package/dist/types/pricing-preview/pricing-preview-response.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.2.0";
+export declare const SDK_VERSION = "0.2.1";

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.2.0';
+exports.SDK_VERSION = '0.2.1';

package/package.json

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