@paddle/paddle-node-sdk 0.1.4 → 0.1.6

package/README.md

@@ -11,11 +11,11 @@ For working with Paddle in your frontend, use [Paddle.js](https://developer.padd
 
 ## Before you begin
 
-This SDK is in early access, which means that we're actively developing it based on feedback from our developer community. **We don't recommend that you use it in production.** 
+This SDK is in early access, which means that we're actively developing it based on feedback from our developer community.
 
 If you've used this SDK, we'd love to hear how you found it! Email us at [team-dx@paddle.com](mailto:team-dx@paddle.com) with any thoughts.
 
-While in early access, we may introduce breaking changes. Where we can, we'll tag breaking changes and communicate ahead of time.
+While in early access, we may introduce breaking changes. Where we can, we'll tag breaking changes and communicate ahead of time. Please pin the version of the SDK in your `package.json` to avoid downloading newer versions with potential breaking changes.
 
 ## Installation
 
@@ -51,8 +51,12 @@ const paddle = new Paddle('API_KEY')
 ...
 
 async function getProducts() {
-    const products = await paddle.products.list()
-    return products.next()
+    try {
+        const productCollection = await paddle.products.list()
+        return productCollection.next()
+    } catch (e) {
+        // Handle Network/API errors
+    }
 }
 
 const products = await getProducts()
@@ -87,19 +91,23 @@ const paddle = new Paddle('API_KEY')
 
 async function getProducts() {
     // creates an iterator instance
-    const products = await paddle.products.list();
-    return products;
+    const productCollection = await paddle.products.list();
+    return productCollection;
 }
 
-// Creates an iterator to loop through paginated data. 
-// At this point, It does not hold any data.
-const products = await getProducts();
-
-// Call `next()` to retrieve first page of the dataset
-const firstPage = await products.next()
-
-// Calling `next()` again will retrieve subsequent pages.
-const secondPage = await products.next()
+try {
+    // Creates an iterator to loop through paginated data. 
+    // At this point, It does not hold any data.
+    const productCollection = await getProducts();
+    
+    // Call `next()` to retrieve first page of the dataset
+    const firstPage = await productCollection.next()
+    
+    // Calling `next()` again will retrieve subsequent pages.
+    const secondPage = await productCollection.next()
+} catch (e) {
+    // Handle Network/API errors
+}
 ```
 
 ### Create an entity
@@ -114,10 +122,14 @@ const paddle = new Paddle('API_KEY')
 ...
 
 async function createProduct(requestBody: CreateProductRequestBody) {
-    // Pass the request body with the attributes required to create
-    const product = await paddle.products.create(requestBody)
-    // Returns a product entity
-    return product
+    try {
+        // Pass the request body with the attributes required to create
+        const product = await paddle.products.create(requestBody)
+        // Returns a product entity
+        return product
+    } catch (e) {
+        // Handle Network/API errors
+    }
 }
 
 const product = await createProduct({... object with required attributes})
@@ -135,10 +147,14 @@ const paddle = new Paddle('API_KEY')
 ...
 
 async function updateProduct(productId: string, requestBody: UpdateProductRequestBody) {
-    // Pass the product id and request body with the attributes to update
-    const product = await paddle.products.update(productId, requestBody)
-    // Returns an updated product entity
-    return product
+    try {
+        // Pass the product id and request body with the attributes to update
+        const product = await paddle.products.update(productId, requestBody)
+        // Returns an updated product entity
+        return product
+    } catch (e) {
+        // Handle Network/API errors
+    }
 }
 
 const product = await updateProduct('id', {... object with attributes to be updated})
@@ -162,10 +178,14 @@ const paddle = new Paddle('API_KEY')
 ...
 
 async function getProduct(productId: string) {
-    // Pass the product id get
-    const product = await paddle.products.get(productId)
-    // Returns an updated product entity
-    return product
+    try {
+        // Pass the product id get
+        const product = await paddle.products.get(productId)
+        // Returns an updated product entity
+        return product
+    } catch (e) {
+        // Handle Network/API errors
+    }
 }
 
 const product = await getProduct('id')
@@ -229,7 +249,7 @@ This table shows which operations are available as of the latest release.
 | Get a transaction                            |      ✅      |
 | Update a transaction                         |      ✅      |
 | Preview a transaction                        |      ❌      |
-| Get a PDF invoice for a transaction          |      ❌      |
+| Get a PDF invoice for a transaction          |      ✅      |
 | **Subscriptions**                            |  **Full**   |
 | List subscriptions                           |      ✅      |
 | Get a subscription                           |      ✅      |

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

@@ -21,7 +21,7 @@ export declare class SubscriptionIncludes {
     readonly current_billing_period?: SubscriptionTimePeriod | null | undefined;
     readonly billing_cycle: TimePeriod;
     readonly scheduled_change?: SubscriptionScheduledChange | null | undefined;
-    readonly management_urls: SubscriptionManagement;
+    readonly management_urls?: SubscriptionManagement | null | undefined;
     readonly items: SubscriptionItem[];
     readonly custom_data?: CustomData | null | undefined;
     readonly next_transaction?: NextTransaction | null | undefined;

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

@@ -27,7 +27,9 @@ class SubscriptionIncludes {
         this.scheduled_change = subscription.scheduled_change
             ? new index_1.SubscriptionScheduledChange(subscription.scheduled_change)
             : null;
-        this.management_urls = new index_1.SubscriptionManagement(subscription.management_urls);
+        this.management_urls = subscription.management_urls
+            ? new index_1.SubscriptionManagement(subscription.management_urls)
+            : null;
         this.items = subscription.items.map((item) => new index_1.SubscriptionItem(item));
         this.custom_data = subscription.custom_data;
         this.next_transaction = subscription.next_transaction ? new index_1.NextTransaction(subscription.next_transaction) : null;

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

@@ -21,7 +21,7 @@ export declare class Subscription {
     readonly current_billing_period?: SubscriptionTimePeriod | undefined | null;
     readonly billing_cycle: TimePeriod;
     readonly scheduled_change?: SubscriptionScheduledChange | undefined | null;
-    readonly management_urls: SubscriptionManagement;
+    readonly management_urls?: SubscriptionManagement | undefined | null;
     readonly items: SubscriptionItem[];
     readonly custom_data?: CustomData | undefined | null;
     constructor(subscription: ISubscription);

package/dist/entities/subscription/subscription.js

@@ -27,7 +27,9 @@ class Subscription {
         this.scheduled_change = subscription.scheduled_change
             ? new index_1.SubscriptionScheduledChange(subscription.scheduled_change)
             : undefined;
-        this.management_urls = new index_1.SubscriptionManagement(subscription.management_urls);
+        this.management_urls = subscription.management_urls
+            ? new index_1.SubscriptionManagement(subscription.management_urls)
+            : undefined;
         this.items = subscription.items.map((item) => new index_1.SubscriptionItem(item));
         this.custom_data = subscription.custom_data;
     }

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

@@ -10,3 +10,4 @@ export * from './adjustment-totals';
 export * from './transaction-includes';
 export * from './transaction';
 export * from './transaction-collection';
+export * from './transaction-invoice-pdf';

package/dist/entities/transaction/index.js

@@ -26,3 +26,4 @@ __exportStar(require("./adjustment-totals"), exports);
 __exportStar(require("./transaction-includes"), exports);
 __exportStar(require("./transaction"), exports);
 __exportStar(require("./transaction-collection"), exports);
+__exportStar(require("./transaction-invoice-pdf"), exports);

package/dist/entities/transaction/transaction-invoice-pdf.d.ts

@@ -0,0 +1,6 @@
+import { type ITransactionInvoicePDF } from '../../types';
+export declare class TransactionInvoicePDF {
+    readonly url: string;
+    constructor(transaction: ITransactionInvoicePDF);
+    toJson(): ITransactionInvoicePDF;
+}

package/dist/entities/transaction/transaction-invoice-pdf.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionInvoicePDF = void 0;
+class TransactionInvoicePDF {
+    constructor(transaction) {
+        this.url = transaction.url;
+    }
+    toJson() {
+        return {
+            url: this.url,
+        };
+    }
+}
+exports.TransactionInvoicePDF = TransactionInvoicePDF;

package/dist/internal/api/client.js

@@ -17,6 +17,8 @@ const constants_1 = require("./constants");
 const node_fetch_1 = __importDefault(require("node-fetch"));
 const version_1 = require("../../version");
 const environment_1 = require("./environment");
+const crypto_1 = require("crypto");
+const logger_1 = require("../base/logger");
 class Client {
     constructor(apiKey, options) {
         this.apiKey = apiKey;
@@ -28,9 +30,11 @@ class Client {
         return urlBasedOnEnv || '';
     }
     getHeaders() {
+        const uuid = (0, crypto_1.randomUUID)();
         return {
             Authorization: `bearer ${this.apiKey}`,
             'user-agent': `PaddleSDK/node ${version_1.SDK_VERSION}`,
+            'X-Transaction-ID': uuid,
         };
     }
     get(url, queryParams) {
@@ -39,29 +43,41 @@ class Client {
             if (!finalUrl.includes('?') && queryParams) {
                 finalUrl += queryParams.toQueryString();
             }
+            const logUrl = url.split('?')[0];
+            const headers = this.getHeaders();
+            logger_1.Logger.logRequest('GET', logUrl, headers);
             const rawResponse = yield (0, node_fetch_1.default)(finalUrl, {
-                headers: this.getHeaders(),
+                headers,
             });
+            logger_1.Logger.logResponse('GET', logUrl, headers, rawResponse);
             return rawResponse.json();
         });
     }
     post(url, requestBody) {
         return __awaiter(this, void 0, void 0, function* () {
+            const logUrl = url.split('?')[0];
+            const headers = this.getHeaders();
+            logger_1.Logger.logRequest('POST', logUrl, headers);
             const rawResponse = yield (0, node_fetch_1.default)(`${this.baseUrl}${url}`, {
                 method: 'POST',
                 body: JSON.stringify(requestBody),
-                headers: this.getHeaders(),
+                headers,
             });
+            logger_1.Logger.logResponse('POST', logUrl, headers, rawResponse);
             return rawResponse.json();
         });
     }
     patch(url, requestBody) {
         return __awaiter(this, void 0, void 0, function* () {
+            const logUrl = url.split('?')[0];
+            const headers = this.getHeaders();
+            logger_1.Logger.logRequest('PATCH', logUrl, headers);
             const rawResponse = yield (0, node_fetch_1.default)(`${this.baseUrl}${url}`, {
                 method: 'PATCH',
                 body: JSON.stringify(requestBody),
-                headers: this.getHeaders(),
+                headers,
             });
+            logger_1.Logger.logResponse('PATCH', logUrl, headers, rawResponse);
             return rawResponse.json();
         });
     }

package/dist/internal/base/logger.d.ts

@@ -0,0 +1,10 @@
+import { type Response } from 'node-fetch';
+type LogInputProps = Array<string | undefined | null>;
+export declare class Logger {
+    static log(...args: LogInputProps): void;
+    static warn(...args: LogInputProps): void;
+    static error(...args: LogInputProps): void;
+    static logRequest(method: string, url: string | undefined, headers: Record<string, string>): void;
+    static logResponse(method: string, url: string | undefined, headers: Record<string, string>, promise: Response): void;
+}
+export {};

package/dist/internal/base/logger.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Logger = void 0;
+class Logger {
+    static log(...args) {
+        console.log('[Paddle] [LOG]', ...args);
+    }
+    static warn(...args) {
+        console.warn('[Paddle] [WARN]', ...args);
+    }
+    static error(...args) {
+        console.error('[Paddle] [ERROR]', ...args);
+    }
+    static logRequest(method, url, headers) {
+        Logger.log('[Request]', method, url, 'Transaction ID:', headers['X-Transaction-ID']);
+    }
+    static logResponse(method, url, headers, promise) {
+        Logger.log('[Response]', method, url, promise.status.toString(), 'Transaction ID:', headers['X-Transaction-ID'], 'Request ID:', promise.headers.get('Request-Id'));
+    }
+}
+exports.Logger = Logger;

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

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

package/dist/resources/transactions/index.js

@@ -31,6 +31,7 @@ const TransactionPaths = {
     create: '/transactions',
     get: '/transactions/{transaction_id}',
     update: '/transactions/{transaction_id}',
+    getInvoicePDF: '/transactions/{transaction_id}/invoice',
 };
 __exportStar(require("./operations"), exports);
 class TransactionsResource extends base_1.BaseResource {
@@ -69,5 +70,15 @@ class TransactionsResource extends base_1.BaseResource {
             return new entities_1.TransactionIncludes(data);
         });
     }
+    getInvoicePDF(transactionId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const urlWithPathParams = new base_1.PathParameters(TransactionPaths.getInvoicePDF, {
+                transaction_id: transactionId,
+            }).deriveUrl();
+            const response = yield this.client.get(urlWithPathParams);
+            const data = this.handleResponse(response);
+            return new entities_1.TransactionInvoicePDF(data);
+        });
+    }
 }
 exports.TransactionsResource = TransactionsResource;

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

@@ -20,7 +20,7 @@ export interface ISubscription {
     current_billing_period?: ISubscriptionTimePeriod | undefined | null;
     billing_cycle: ITimePeriod;
     scheduled_change?: ISubscriptionScheduledChange | undefined | null;
-    management_urls: ISubscriptionManagement;
+    management_urls: ISubscriptionManagement | undefined | null;
     items: ISubscriptionItem[];
     custom_data?: ICustomData | undefined | null;
     next_transaction?: INextTransaction | undefined | null;

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

@@ -8,3 +8,4 @@ export * from './transaction-adjustment';
 export * from './adjustment-totals-breakdown';
 export * from './adjustment-totals';
 export * from './transaction';
+export * from './transaction-invoice-pdf';

package/dist/types/transaction/index.js

@@ -24,3 +24,4 @@ __exportStar(require("./transaction-adjustment"), exports);
 __exportStar(require("./adjustment-totals-breakdown"), exports);
 __exportStar(require("./adjustment-totals"), exports);
 __exportStar(require("./transaction"), exports);
+__exportStar(require("./transaction-invoice-pdf"), exports);

package/dist/types/transaction/transaction-invoice-pdf.d.ts

@@ -0,0 +1,3 @@
+export interface ITransactionInvoicePDF {
+    url: string;
+}

package/dist/types/transaction/transaction-invoice-pdf.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.4";
+export declare const SDK_VERSION = "0.1.6";

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.4';
+exports.SDK_VERSION = '0.1.6';

package/package.json

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