@paddle/paddle-node-sdk 0.3.0 → 0.4.0

package/CHANGELOG.md

@@ -8,6 +8,28 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 Check our main [developer changelog](https://developer.paddle.com/?utm_source=dx&utm_medium=paddle-node-sdk) for information about changes to the Paddle Billing platform, the Paddle API, and other developer tools.
 
+## 0.4.0 - 2024-02-14
+
+### Added
+
+- Added `availablePaymentMethods` as an `include` Parameter to all transaction operations.
+- Added `importMeta` to Subscription webhooks.
+
+### Changed
+
+- Filter customers by email address in `customers.list()` operation, see [related changelog](https://developer.paddle.com/changelog/2024/filter-customers-email?utm_source=dx&utm_medium=paddle-node-sdk).
+- New payment method ID field for transaction payments, see [related changelog](https://developer.paddle.com/changelog/2024/payment-method-paddle-id?utm_source=dx&utm_medium=paddle-node-sdk).
+
+### Fixed
+
+- Fixed `effective_from` enum in Resume subscription operations.
+
+### Deprecated
+
+- Deprecated `storedPaymentMethodId` from transaction payments in favour of `paymentMethodId` field.
+
+---
+
 ## 0.3.0 - 2024-01-11
 
 ### Changed

package/dist/entities/shared/transaction-payment-attempt.d.ts

@@ -3,6 +3,7 @@ import { PaymentMethodDetails } from '../index';
 import { type PaymentAttemptStatus, type ErrorCode } from '../../enums';
 export declare class TransactionPaymentAttempt {
     readonly paymentAttemptId: string;
+    readonly paymentMethodId: string;
     readonly storedPaymentMethodId: string;
     readonly amount: string;
     readonly status: PaymentAttemptStatus;

package/dist/entities/shared/transaction-payment-attempt.js

@@ -5,6 +5,7 @@ const index_1 = require("../index");
 class TransactionPaymentAttempt {
     constructor(transactionPaymentAttempt) {
         this.paymentAttemptId = transactionPaymentAttempt.payment_attempt_id;
+        this.paymentMethodId = transactionPaymentAttempt.payment_method_id;
         this.storedPaymentMethodId = transactionPaymentAttempt.stored_payment_method_id;
         this.amount = transactionPaymentAttempt.amount;
         this.status = transactionPaymentAttempt.status;

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

@@ -1,4 +1,4 @@
-import { BillingDetails, type CustomData, SubscriptionDiscount, SubscriptionItem, SubscriptionScheduledChange, SubscriptionTimePeriod, TimePeriod } from '../index';
+import { BillingDetails, type CustomData, ImportMeta, SubscriptionDiscount, SubscriptionItem, SubscriptionScheduledChange, SubscriptionTimePeriod, TimePeriod } from '../index';
 import { type CollectionMode, type CurrencyCode, type SubscriptionStatus } from '../../enums';
 import { type ISubscriptionNotificationResponse } from '../../types';
 export declare class SubscriptionNotification {
@@ -24,5 +24,6 @@ export declare class SubscriptionNotification {
     readonly scheduledChange: SubscriptionScheduledChange | null;
     readonly items: SubscriptionItem[];
     readonly customData: CustomData | null;
+    readonly importMeta: ImportMeta | null;
     constructor(subscription: ISubscriptionNotificationResponse);
 }

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

@@ -30,6 +30,7 @@ class SubscriptionNotification {
             : null;
         this.items = subscription.items.map((item) => new index_1.SubscriptionItem(item));
         this.customData = subscription.custom_data ? subscription.custom_data : null;
+        this.importMeta = subscription.import_meta ? new index_1.ImportMeta(subscription.import_meta) : null;
     }
 }
 exports.SubscriptionNotification = SubscriptionNotification;

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

@@ -1,6 +1,7 @@
 import { type ITransactionResponse } from '../../types';
 import { Address, TransactionAdjustment, AdjustmentTotals, BillingDetails, Business, TransactionCheckout, type CustomData, Customer, TransactionDetails, Discount, TransactionItem, TransactionPaymentAttempt, TransactionsTimePeriod } from '../index';
 import { type CollectionMode, type CurrencyCode, type TransactionStatus, type TransactionOrigin } from '../../enums';
+import { type AvailablePaymentMethod } from '../../enums/shared/available-payment-methods';
 export declare class TransactionIncludes {
     readonly id: string;
     readonly status: TransactionStatus;
@@ -30,5 +31,6 @@ export declare class TransactionIncludes {
     readonly business: Business | null;
     readonly customer: Customer | null;
     readonly discount: Discount | null;
+    readonly availablePaymentMethods: AvailablePaymentMethod[] | null;
     constructor(transaction: ITransactionResponse);
 }

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

@@ -37,6 +37,7 @@ class TransactionIncludes {
         this.business = transaction.business ? new index_1.Business(transaction.business) : null;
         this.customer = transaction.customer ? new index_1.Customer(transaction.customer) : null;
         this.discount = transaction.discount ? new index_1.Discount(transaction.discount) : null;
+        this.availablePaymentMethods = transaction.available_payment_methods ? transaction.available_payment_methods : null;
     }
 }
 exports.TransactionIncludes = TransactionIncludes;

package/dist/resources/customers/operations/list-customer-query-parameters.d.ts

@@ -6,4 +6,5 @@ export interface ListCustomerQueryParameters {
     perPage?: number;
     search?: string;
     status?: Status[];
+    email?: string[];
 }

package/dist/resources/subscriptions/operations/resume-subscription-request-object.d.ts

@@ -1,4 +1,3 @@
-import { type SubscriptionEffectiveFrom } from '../../../enums';
 export interface ResumeSubscription {
-    effectiveFrom: SubscriptionEffectiveFrom | string;
+    effectiveFrom: 'immediately' | string;
 }

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

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

package/dist/resources/transactions/index.js

@@ -48,14 +48,15 @@ class TransactionsResource extends base_1.BaseResource {
             return new entities_1.TransactionIncludes(data);
         });
     }
-    update(transactionId, updateTransaction) {
+    update(transactionId, updateTransaction, queryParams) {
         return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = new base_1.QueryParameters(queryParams);
             const urlWithPathParams = new base_1.PathParameters(TransactionPaths.update, {
                 transaction_id: transactionId,
             }).deriveUrl();
-            const response = yield this.client.patch(urlWithPathParams, updateTransaction);
+            const response = yield this.client.patch(urlWithPathParams + queryParameters.toQueryString(), updateTransaction);
             const data = this.handleResponse(response);
-            return new entities_1.Transaction(data);
+            return new entities_1.TransactionIncludes(data);
         });
     }
     get(transactionId, queryParams) {

package/dist/resources/transactions/operations/create-transaction-query-parameters.d.ts

@@ -1,3 +1,3 @@
 export interface CreateTransactionQueryParameters {
-    include?: Array<'address' | 'adjustment' | 'adjustments_totals' | 'business' | 'customer' | 'discount'>;
+    include?: Array<'address' | 'adjustment' | 'adjustments_totals' | 'available_payment_methods' | 'business' | 'customer' | 'discount'>;
 }

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

@@ -1,5 +1,6 @@
 export * from './list-transaction-query-parameters';
 export * from './create-transaction-query-parameters';
+export * from './update-transaction-query-parameters';
 export * from './create-transaction-request-body';
 export * from './get-transaction-query-parameters';
 export * from './update-transaction-request-body';

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

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./list-transaction-query-parameters"), exports);
 __exportStar(require("./create-transaction-query-parameters"), exports);
+__exportStar(require("./update-transaction-query-parameters"), exports);
 __exportStar(require("./create-transaction-request-body"), exports);
 __exportStar(require("./get-transaction-query-parameters"), exports);
 __exportStar(require("./update-transaction-request-body"), exports);

package/dist/resources/transactions/operations/update-transaction-query-parameters.d.ts

@@ -0,0 +1,3 @@
+export interface UpdateTransactionQueryParameters {
+    include?: Array<'address' | 'adjustment' | 'adjustments_totals' | 'available_payment_methods' | 'business' | 'customer' | 'discount'>;
+}

package/dist/resources/transactions/operations/update-transaction-query-parameters.js

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

package/dist/types/shared/transaction-payment-attempt-response.d.ts

@@ -3,6 +3,7 @@ import { type PaymentAttemptStatus, type ErrorCode } from '../../enums';
 export interface ITransactionPaymentAttemptResponse {
     payment_attempt_id: string;
     stored_payment_method_id: string;
+    payment_method_id: string;
     amount: string;
     status: PaymentAttemptStatus;
     error_code?: ErrorCode | null;

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

@@ -1,4 +1,4 @@
-import { type IBillingDetailsResponse, type ICustomData, type INextTransactionResponse, type ISubscriptionDiscountResponse, type ISubscriptionItemResponse, type ISubscriptionScheduledChangeResponse, type ISubscriptionTimePeriodResponse, type ITimePeriod, type ITransactionDetailsPreviewResponse } from '../index';
+import { type IBillingDetailsResponse, type ICustomData, type IImportMetaResponse, type INextTransactionResponse, type ISubscriptionDiscountResponse, type ISubscriptionItemResponse, type ISubscriptionScheduledChangeResponse, type ISubscriptionTimePeriodResponse, type ITimePeriod, type ITransactionDetailsPreviewResponse } from '../index';
 import { type CollectionMode, type CurrencyCode, type SubscriptionStatus } from '../../enums';
 export interface ISubscriptionNotificationResponse {
     id: string;
@@ -23,6 +23,7 @@ export interface ISubscriptionNotificationResponse {
     scheduled_change?: ISubscriptionScheduledChangeResponse | null;
     items: ISubscriptionItemResponse[];
     custom_data?: ICustomData | null;
+    import_meta?: IImportMetaResponse | null;
     next_transaction?: INextTransactionResponse | null;
     recurring_transaction_details?: ITransactionDetailsPreviewResponse | null;
 }

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

@@ -1,5 +1,6 @@
 import { type ICustomData, type IBillingDetailsResponse, type ITransactionsTimePeriodResponse, type ITransactionItemResponse, type ITransactionDetailsResponse, type ITransactionPaymentAttemptResponse, type ITransactionCheckout, type IAddressResponse, type ITransactionAdjustmentResponse, type IAdjustmentTotalsResponse, type IBusinessResponse, type ICustomerResponse, type IDiscountResponse } from '../index';
 import { type TransactionStatus, type CurrencyCode, type TransactionOrigin, type CollectionMode } from '../../enums';
+import { type AvailablePaymentMethod } from '../../enums/shared/available-payment-methods';
 export interface ITransactionResponse {
     id: string;
     status: TransactionStatus;
@@ -29,4 +30,5 @@ export interface ITransactionResponse {
     business?: IBusinessResponse | null;
     customer?: ICustomerResponse | null;
     discount?: IDiscountResponse | null;
+    available_payment_methods?: AvailablePaymentMethod[] | null;
 }

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.3.0";
+export declare const SDK_VERSION = "0.4.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 = '0.3.0';
+exports.SDK_VERSION = '0.4.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paddle/paddle-node-sdk",
-  "version": "0.3.0",
+  "version": "0.4.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",