@paddle/paddle-node-sdk 1.0.2 → 1.1.0

package/CHANGELOG.md

@@ -6,6 +6,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.
 
+### Versioning
+
+When we make [non-breaking changes](https://developer.paddle.com/api-reference/about/versioning?utm_source=dx&utm_medium=paddle-node-sdk#non-breaking-change) to the Paddle API, we'll only release a new major version of the Node.js SDK when it causes problems at runtime. We won't release a new version of the SDK when we weaken TypeScript types in a way that doesn't cause existing implementations to break or malfunction. For example, if we add a new field to a request or an allowed value for a field in a response, this weakens the Typescript type but does not cause existing usages to stop working.
+
+This means when upgrading minor versions of the SDK, you may notice type errors. You can safely ignore these or fix by adding additional type guards.
+
+
+## 1.1.0 - 2024-03-13
+
+### Added
+
+- Added `createdAt` and `updatedAt` to product and price entities, see [related changelog](https://developer.paddle.com/changelog/2024/product-price-dates?utm_source=dx&utm_medium=paddle-node-sdk).
+
+### Changed
+
+- Updated [report API](https://developer.paddle.com/api-reference/reports/create-report?utm_source=dx&utm_medium=paddle-node-sdk) to support `discounts` and `product_prices` report, see [related changelog](https://developer.paddle.com/changelog/2024/product-prices-discounts-reports?utm_source=dx&utm_medium=paddle-node-sdk).
+
+### Removed
+
+- Removed `ISharedProductResponse` and `ISharedPriceResponse` interfaces as they were redundant. Please use `IProductResponse` and `IPriceResponse` instead.
+
+---
 
 ## 1.0.2 - 2024-03-12
 

package/README.md

@@ -54,6 +54,12 @@ 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.
 
+### Versioning
+
+When we make [non-breaking changes](https://developer.paddle.com/api-reference/about/versioning?utm_source=dx&utm_medium=paddle-node-sdk#non-breaking-change) to the Paddle API, we'll only release a new major version of the Node.js SDK when it causes problems at runtime. We won't release a new version of the SDK when we weaken TypeScript types in a way that doesn't cause existing implementations to break or malfunction. For example, if we add a new field to a request or an allowed value for a field in a response, this weakens the Typescript type but does not cause existing usages to stop working.
+
+This means when upgrading minor versions of the SDK, you may notice type errors. You can safely ignore these or fix by adding additional type guards.
+
 ## Naming conventions
 
 Properties in the Paddle API use `snake_case`. To follow JavaScript conventions, properties in this SDK use `camelCase`. This means:

package/dist/entities/price/price.d.ts

@@ -14,6 +14,8 @@ export declare class Price {
     readonly unitPriceOverrides: UnitPriceOverride[];
     readonly quantity: PriceQuantity;
     readonly status: Status;
+    readonly createdAt: string;
+    readonly updatedAt: string;
     readonly customData: ICustomData | null;
     readonly importMeta: ImportMeta | null;
     readonly product: Product | null;

package/dist/entities/price/price.js

@@ -16,6 +16,8 @@ class Price {
         this.unitPriceOverrides = price.unit_price_overrides.map((unit_price_override) => new index_1.UnitPriceOverride(unit_price_override));
         this.quantity = new index_1.PriceQuantity(price.quantity);
         this.status = price.status;
+        this.createdAt = price.created_at;
+        this.updatedAt = price.updated_at;
         this.customData = price.custom_data ? price.custom_data : null;
         this.importMeta = price.import_meta ? new index_1.ImportMeta(price.import_meta) : null;
         this.product = price.product ? new index_1.Product(price.product) : null;

package/dist/entities/product/product.d.ts

@@ -11,6 +11,7 @@ export declare class Product {
     readonly customData: CustomData | null;
     readonly status: Status;
     readonly createdAt: string;
+    readonly updatedAt: string;
     readonly importMeta: ImportMeta | null;
     readonly prices: Price[] | null;
     constructor(product: IProductResponse);

package/dist/entities/product/product.js

@@ -14,6 +14,7 @@ class Product {
         this.customData = product.custom_data ? product.custom_data : null;
         this.status = product.status;
         this.createdAt = product.created_at;
+        this.updatedAt = product.updated_at;
         this.importMeta = product.import_meta ? new index_1.ImportMeta(product.import_meta) : null;
         this.prices = product.prices ? product.prices.map((price) => new index_1.Price(price)) : null;
     }

package/dist/enums/report/report-filter-name.d.ts

@@ -1 +1 @@
-export type ReportFilterName = 'action' | 'collection_mode' | 'currency_code' | 'origin' | 'status' | 'updated_at';
+export type ReportFilterName = 'action' | 'collection_mode' | 'currency_code' | 'origin' | 'status' | 'updated_at' | 'type' | 'product_status' | 'price_status' | 'product_type' | 'price_type' | 'product_updated_at' | 'price_updated_at';

package/dist/enums/report/report-type.d.ts

@@ -1 +1 @@
-export type ReportType = 'adjustments' | 'adjustment_line_items' | 'transactions' | 'transaction_line_items';
+export type ReportType = 'adjustments' | 'adjustment_line_items' | 'transactions' | 'transaction_line_items' | 'discounts' | 'products_prices';

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

@@ -15,6 +15,8 @@ export declare class PriceNotification {
     readonly unitPriceOverrides: UnitPriceOverrideNotification[];
     readonly quantity: PriceQuantityNotification;
     readonly status: Status;
+    readonly createdAt: string | null;
+    readonly updatedAt: string | null;
     readonly customData: ICustomData | null;
     readonly importMeta: ImportMetaNotification | null;
     constructor(price: IPriceNotificationResponse);

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

@@ -4,6 +4,7 @@ exports.PriceNotification = void 0;
 const index_1 = require("../index");
 class PriceNotification {
     constructor(price) {
+        var _a, _b;
         this.id = price.id;
         this.productId = price.product_id;
         this.description = price.description;
@@ -16,6 +17,8 @@ class PriceNotification {
         this.unitPriceOverrides = price.unit_price_overrides.map((unit_price_override) => new index_1.UnitPriceOverrideNotification(unit_price_override));
         this.quantity = new index_1.PriceQuantityNotification(price.quantity);
         this.status = price.status;
+        this.createdAt = (_a = price.created_at) !== null && _a !== void 0 ? _a : null;
+        this.updatedAt = (_b = price.updated_at) !== null && _b !== void 0 ? _b : null;
         this.customData = price.custom_data ? price.custom_data : null;
         this.importMeta = price.import_meta ? new index_1.ImportMetaNotification(price.import_meta) : null;
     }

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

@@ -12,6 +12,7 @@ export declare class ProductNotification {
     readonly customData: CustomData | null;
     readonly status: Status;
     readonly createdAt: string;
+    readonly updatedAt: string | null;
     readonly importMeta: ImportMetaNotification | null;
     constructor(product: ISharedProductNotificationResponse);
 }

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

@@ -4,7 +4,7 @@ exports.ProductNotification = void 0;
 const index_1 = require("../index");
 class ProductNotification {
     constructor(product) {
-        var _a;
+        var _a, _b;
         this.id = product.id;
         this.name = product.name;
         this.type = (_a = product.type) !== null && _a !== void 0 ? _a : null;
@@ -14,6 +14,7 @@ class ProductNotification {
         this.customData = product.custom_data ? product.custom_data : null;
         this.status = product.status;
         this.createdAt = product.created_at;
+        this.updatedAt = (_b = product.updated_at) !== null && _b !== void 0 ? _b : null;
         this.importMeta = product.import_meta ? new index_1.ImportMetaNotification(product.import_meta) : null;
     }
 }

package/dist/notifications/types/price/price-notification-response.d.ts

@@ -14,6 +14,8 @@ export interface IPriceNotificationResponse {
     unit_price_overrides: IUnitPriceOverrideNotificationResponse[];
     quantity: IPriceQuantityNotification;
     status: Status;
+    created_at?: string | null;
+    updated_at?: string | null;
     custom_data?: ICustomData | null;
     import_meta?: IImportMetaNotificationResponse | null;
     product?: ISharedProductNotificationResponse | null;

package/dist/notifications/types/shared/shared-product-notification-response.d.ts

@@ -11,5 +11,6 @@ export interface ISharedProductNotificationResponse {
     custom_data?: ICustomData | null;
     status: Status;
     created_at: string;
+    updated_at?: string | null;
     import_meta?: IImportMetaNotificationResponse | null;
 }

package/dist/types/price/price-response.d.ts

@@ -1,5 +1,5 @@
-import { type ITimePeriod, type IMoneyResponse, type IUnitPriceOverrideResponse, type IPriceQuantity, type ICustomData, type ISharedProductResponse, type IImportMetaResponse } from '../index';
-import { type TaxMode, type Status, type CatalogType } from '../../enums';
+import { type ICustomData, type IImportMetaResponse, type IMoneyResponse, type IPriceQuantity, type IProductResponse, type ITimePeriod, type IUnitPriceOverrideResponse } from '../index';
+import { type CatalogType, type Status, type TaxMode } from '../../enums';
 export interface IPriceResponse {
     id: string;
     product_id: string;
@@ -13,7 +13,9 @@ export interface IPriceResponse {
     unit_price_overrides: IUnitPriceOverrideResponse[];
     quantity: IPriceQuantity;
     status: Status;
+    created_at: string;
+    updated_at: string;
     custom_data?: ICustomData | null;
     import_meta?: IImportMetaResponse | null;
-    product?: ISharedProductResponse | null;
+    product?: IProductResponse | null;
 }

package/dist/types/product/product-response.d.ts

@@ -1,5 +1,5 @@
-import { type ICustomData, type IImportMetaResponse, type ISharedPriceResponse } from '../index';
-import { type TaxCategory, type Status, type CatalogType } from '../../enums';
+import { type ICustomData, type IImportMetaResponse, type IPriceResponse } from '../index';
+import { type CatalogType, type Status, type TaxCategory } from '../../enums';
 export interface IProductResponse {
     id: string;
     name: string;
@@ -10,6 +10,7 @@ export interface IProductResponse {
     custom_data?: ICustomData | null;
     status: Status;
     created_at: string;
+    updated_at: string;
     import_meta?: IImportMetaResponse | null;
-    prices?: ISharedPriceResponse[] | null;
+    prices?: IPriceResponse[] | null;
 }

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

@@ -4,8 +4,6 @@ export * from './money-response';
 export * from './unit-price-override';
 export * from './unit-price-override-response';
 export * from './price-quantity';
-export * from './shared-price-response';
-export * from './shared-product-response';
 export * from './billing-details-response';
 export * from './totals';
 export * from './tax-rates-used-response';

package/dist/types/shared/index.js

@@ -20,8 +20,6 @@ __exportStar(require("./money-response"), exports);
 __exportStar(require("./unit-price-override"), exports);
 __exportStar(require("./unit-price-override-response"), exports);
 __exportStar(require("./price-quantity"), exports);
-__exportStar(require("./shared-price-response"), exports);
-__exportStar(require("./shared-product-response"), exports);
 __exportStar(require("./billing-details-response"), exports);
 __exportStar(require("./totals"), exports);
 __exportStar(require("./tax-rates-used-response"), exports);

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

@@ -1,9 +1,9 @@
-import { type IUnitTotals, type ITotals, type ISharedProductResponse } from '../index';
+import { type IProductResponse, type ITotals, type IUnitTotals } from '../index';
 export interface ITransactionLineItemPreviewResponse {
     price_id: string;
     quantity: number;
     tax_rate: string;
     unit_totals: IUnitTotals;
     totals: ITotals;
-    product: ISharedProductResponse;
+    product: IProductResponse;
 }

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

@@ -1,7 +1,7 @@
-import { type ISharedPriceResponse, type ITransactionProrationResponse } from '../index';
+import { type IPriceResponse, type ITransactionProrationResponse } from '../index';
 export interface ITransactionItemResponse {
     price_id?: string | null;
-    price?: ISharedPriceResponse | null;
+    price?: IPriceResponse | null;
     quantity: number;
     proration?: ITransactionProrationResponse | null;
 }

package/dist/types/transaction/transaction-line-item-response.d.ts

@@ -1,4 +1,4 @@
-import { type ITransactionProrationResponse, type IUnitTotals, type ITotals, type ISharedProductResponse } from '../index';
+import { type IProductResponse, type ITotals, type ITransactionProrationResponse, type IUnitTotals } from '../index';
 export interface ITransactionLineItemResponse {
     id: string;
     price_id: string;
@@ -7,5 +7,5 @@ export interface ITransactionLineItemResponse {
     tax_rate: string;
     unit_totals?: IUnitTotals | null;
     totals?: ITotals | null;
-    product?: ISharedProductResponse | null;
+    product?: IProductResponse | null;
 }

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.0.2";
+export declare const SDK_VERSION = "1.1.0";

package/dist/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paddle/paddle-node-sdk",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "A Node.js SDK that you can use to integrate Paddle Billing with applications written in server-side JavaScript.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

package/dist/types/shared/shared-price-response.d.ts

@@ -1,18 +0,0 @@
-import { type ITimePeriod, type IMoneyResponse, type IUnitPriceOverrideResponse, type IPriceQuantity, type ICustomData, type IImportMetaResponse } from '../index';
-import { type TaxMode, type Status, type CatalogType } from '../../enums';
-export interface ISharedPriceResponse {
-    id: string;
-    product_id: string;
-    description: string;
-    type: CatalogType;
-    name?: string | null;
-    billing_cycle?: ITimePeriod | null;
-    trial_period?: ITimePeriod | null;
-    tax_mode: TaxMode;
-    unit_price: IMoneyResponse;
-    unit_price_overrides: IUnitPriceOverrideResponse[];
-    quantity: IPriceQuantity;
-    status: Status;
-    custom_data?: ICustomData | null;
-    import_meta?: IImportMetaResponse | null;
-}

package/dist/types/shared/shared-price-response.js

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

package/dist/types/shared/shared-product-response.d.ts

@@ -1,14 +0,0 @@
-import { type ICustomData, type IImportMetaResponse } from '../index';
-import { type TaxCategory, type Status, type CatalogType } from '../../enums';
-export interface ISharedProductResponse {
-    id: string;
-    name: string;
-    type?: CatalogType | null;
-    description?: string | null;
-    tax_category: TaxCategory;
-    image_url?: string | null;
-    custom_data?: ICustomData | null;
-    status: Status;
-    created_at: string;
-    import_meta?: IImportMetaResponse | null;
-}

package/dist/types/shared/shared-product-response.js

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