@paddle/paddle-node-sdk 2.1.2 → 2.2.0

package/CHANGELOG.md

@@ -12,6 +12,19 @@ When we make [non-breaking changes](https://developer.paddle.com/api-reference/a
 
 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.
 
+## 2.2.0 - 2024-12-12
+
+### Added
+
+- `VND` (Vietnamese dong) as new currency
+- Added `adjustment.type` which is either `partial` which should include `items` or `full` where `items` are not required
+
+## 2.1.3 - 2024-11-29
+
+### Changed
+
+- `paddle.webhooks.unmarshal` will now return an event for unhandled event types instead of `null` this is only possible for legacy/no longer supported events or for new events that have not been added to the sdk yet
+
 ## 2.1.2 - 2024-11-26
 
 ### Fixed

package/dist/cjs/entities/adjustment/adjustment.js

@@ -7,6 +7,7 @@ class Adjustment {
     constructor(adjustment) {
         this.id = adjustment.id;
         this.action = adjustment.action;
+        this.type = adjustment.type;
         this.transactionId = adjustment.transaction_id;
         this.subscriptionId = adjustment.subscription_id ? adjustment.subscription_id : null;
         this.customerId = adjustment.customer_id;

package/dist/cjs/enums/adjustment/adjustment-action-type.js

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

package/dist/cjs/enums/adjustment/index.js

@@ -14,7 +14,8 @@ 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("./adjustment-type.js"), exports);
-__exportStar(require("./adjustment-currency-code.js"), exports);
+__exportStar(require("./adjustment-action-type.js"), exports);
 __exportStar(require("./adjustment-action.js"), exports);
+__exportStar(require("./adjustment-currency-code.js"), exports);
 __exportStar(require("./adjustment-status.js"), exports);
+__exportStar(require("./adjustment-type.js"), exports);

package/dist/cjs/internal/base/index.js

@@ -18,3 +18,4 @@ __exportStar(require("./base-resource.js"), exports);
 __exportStar(require("./query-parameters.js"), exports);
 __exportStar(require("./path-parameters.js"), exports);
 __exportStar(require("./collection.js"), exports);
+__exportStar(require("./transform.js"), exports);

package/dist/cjs/internal/base/transform.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertKeysToCamelCase = void 0;
+function toCamelCase(str) {
+    return str.toLowerCase().replace(/_([a-z])/g, (_, letter) => letter.toUpperCase());
+}
+function convertKeysToCamelCase(obj) {
+    if (obj === null || typeof obj !== 'object') {
+        return obj;
+    }
+    if (Array.isArray(obj)) {
+        return obj.map(convertKeysToCamelCase);
+    }
+    const converted = {};
+    for (const [key, value] of Object.entries(obj)) {
+        const camelCaseKey = toCamelCase(key);
+        converted[camelCaseKey] = convertKeysToCamelCase(value);
+    }
+    return converted;
+}
+exports.convertKeysToCamelCase = convertKeysToCamelCase;

package/dist/cjs/notifications/entities/adjustment/adjustment-notification.js

@@ -7,6 +7,7 @@ class AdjustmentNotification {
     constructor(adjustment) {
         this.id = adjustment.id;
         this.action = adjustment.action;
+        this.type = adjustment.type;
         this.transactionId = adjustment.transaction_id;
         this.subscriptionId = adjustment.subscription_id ? adjustment.subscription_id : null;
         this.customerId = adjustment.customer_id;

package/dist/cjs/notifications/events/generic/generic-event.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenericEvent = void 0;
+const event_js_1 = require("../../../entities/events/event.js");
+const index_js_1 = require("../../../internal/base/index.js");
+class GenericEvent extends event_js_1.Event {
+    constructor(response) {
+        super(response);
+        this.data = (0, index_js_1.convertKeysToCamelCase)(response.data);
+    }
+}
+exports.GenericEvent = GenericEvent;

package/dist/cjs/notifications/events/generic/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("./generic-event.js"), exports);

package/dist/cjs/notifications/events/index.js

@@ -19,6 +19,7 @@ __exportStar(require("./adjustment/index.js"), exports);
 __exportStar(require("./business/index.js"), exports);
 __exportStar(require("./customer/index.js"), exports);
 __exportStar(require("./discount/index.js"), exports);
+__exportStar(require("./generic/index.js"), exports);
 __exportStar(require("./payment-method/index.js"), exports);
 __exportStar(require("./payout/index.js"), exports);
 __exportStar(require("./price/index.js"), exports);

package/dist/cjs/notifications/helpers/webhooks.js

@@ -124,7 +124,7 @@ class Webhooks {
                 return new index_js_1.ReportUpdatedEvent(data);
             default:
                 logger_js_1.Logger.log(`Unknown event_type ${data.event_type}`);
-                return null;
+                return new index_js_1.GenericEvent(data);
         }
     }
 }

package/dist/cjs/version.js

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

package/dist/esm/entities/adjustment/adjustment.js

@@ -4,6 +4,7 @@ export class Adjustment {
     constructor(adjustment) {
         this.id = adjustment.id;
         this.action = adjustment.action;
+        this.type = adjustment.type;
         this.transactionId = adjustment.transaction_id;
         this.subscriptionId = adjustment.subscription_id ? adjustment.subscription_id : null;
         this.customerId = adjustment.customer_id;

package/dist/esm/enums/adjustment/adjustment-action-type.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/enums/adjustment/index.js

@@ -1,4 +1,5 @@
-export * from './adjustment-type.js';
-export * from './adjustment-currency-code.js';
+export * from './adjustment-action-type.js';
 export * from './adjustment-action.js';
+export * from './adjustment-currency-code.js';
 export * from './adjustment-status.js';
+export * from './adjustment-type.js';

package/dist/esm/internal/base/index.js

@@ -2,3 +2,4 @@ export * from './base-resource.js';
 export * from './query-parameters.js';
 export * from './path-parameters.js';
 export * from './collection.js';
+export * from './transform.js';

package/dist/esm/internal/base/transform.js

@@ -0,0 +1,17 @@
+function toCamelCase(str) {
+    return str.toLowerCase().replace(/_([a-z])/g, (_, letter) => letter.toUpperCase());
+}
+export function convertKeysToCamelCase(obj) {
+    if (obj === null || typeof obj !== 'object') {
+        return obj;
+    }
+    if (Array.isArray(obj)) {
+        return obj.map(convertKeysToCamelCase);
+    }
+    const converted = {};
+    for (const [key, value] of Object.entries(obj)) {
+        const camelCaseKey = toCamelCase(key);
+        converted[camelCaseKey] = convertKeysToCamelCase(value);
+    }
+    return converted;
+}

package/dist/esm/notifications/entities/adjustment/adjustment-notification.js

@@ -4,6 +4,7 @@ export class AdjustmentNotification {
     constructor(adjustment) {
         this.id = adjustment.id;
         this.action = adjustment.action;
+        this.type = adjustment.type;
         this.transactionId = adjustment.transaction_id;
         this.subscriptionId = adjustment.subscription_id ? adjustment.subscription_id : null;
         this.customerId = adjustment.customer_id;

package/dist/esm/notifications/events/generic/generic-event.js

@@ -0,0 +1,8 @@
+import { Event } from '../../../entities/events/event.js';
+import { convertKeysToCamelCase } from '../../../internal/base/index.js';
+export class GenericEvent extends Event {
+    constructor(response) {
+        super(response);
+        this.data = convertKeysToCamelCase(response.data);
+    }
+}

package/dist/esm/notifications/events/generic/index.js

@@ -0,0 +1 @@
+export * from './generic-event.js';

package/dist/esm/notifications/events/index.js

@@ -3,6 +3,7 @@ export * from './adjustment/index.js';
 export * from './business/index.js';
 export * from './customer/index.js';
 export * from './discount/index.js';
+export * from './generic/index.js';
 export * from './payment-method/index.js';
 export * from './payout/index.js';
 export * from './price/index.js';

package/dist/esm/notifications/helpers/webhooks.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { WebhooksValidator } from './webhooks-validator.js';
 import { EventName } from './types.js';
-import { AddressCreatedEvent, AddressImportedEvent, AddressUpdatedEvent, AdjustmentCreatedEvent, AdjustmentUpdatedEvent, BusinessCreatedEvent, BusinessImportedEvent, BusinessUpdatedEvent, CustomerCreatedEvent, CustomerImportedEvent, CustomerUpdatedEvent, DiscountCreatedEvent, DiscountImportedEvent, DiscountUpdatedEvent, PaymentMethodDeletedEvent, PaymentMethodSavedEvent, PayoutCreatedEvent, PayoutPaidEvent, PriceCreatedEvent, PriceImportedEvent, PriceUpdatedEvent, ProductCreatedEvent, ProductImportedEvent, ProductUpdatedEvent, ReportCreatedEvent, ReportUpdatedEvent, SubscriptionActivatedEvent, SubscriptionCanceledEvent, SubscriptionCreatedEvent, SubscriptionImportedEvent, SubscriptionPastDueEvent, SubscriptionPausedEvent, SubscriptionResumedEvent, SubscriptionTrialingEvent, SubscriptionUpdatedEvent, TransactionBilledEvent, TransactionCanceledEvent, TransactionCompletedEvent, TransactionCreatedEvent, TransactionPaidEvent, TransactionPastDueEvent, TransactionPaymentFailedEvent, TransactionReadyEvent, TransactionUpdatedEvent, } from '../events/index.js';
+import { AddressCreatedEvent, AddressImportedEvent, AddressUpdatedEvent, AdjustmentCreatedEvent, AdjustmentUpdatedEvent, BusinessCreatedEvent, BusinessImportedEvent, BusinessUpdatedEvent, CustomerCreatedEvent, CustomerImportedEvent, CustomerUpdatedEvent, DiscountCreatedEvent, DiscountImportedEvent, DiscountUpdatedEvent, GenericEvent, PaymentMethodDeletedEvent, PaymentMethodSavedEvent, PayoutCreatedEvent, PayoutPaidEvent, PriceCreatedEvent, PriceImportedEvent, PriceUpdatedEvent, ProductCreatedEvent, ProductImportedEvent, ProductUpdatedEvent, ReportCreatedEvent, ReportUpdatedEvent, SubscriptionActivatedEvent, SubscriptionCanceledEvent, SubscriptionCreatedEvent, SubscriptionImportedEvent, SubscriptionPastDueEvent, SubscriptionPausedEvent, SubscriptionResumedEvent, SubscriptionTrialingEvent, SubscriptionUpdatedEvent, TransactionBilledEvent, TransactionCanceledEvent, TransactionCompletedEvent, TransactionCreatedEvent, TransactionPaidEvent, TransactionPastDueEvent, TransactionPaymentFailedEvent, TransactionReadyEvent, TransactionUpdatedEvent, } from '../events/index.js';
 import { Logger } from '../../internal/base/logger.js';
 export class Webhooks {
     unmarshal(requestBody, secretKey, signature) {
@@ -121,7 +121,7 @@ export class Webhooks {
                 return new ReportUpdatedEvent(data);
             default:
                 Logger.log(`Unknown event_type ${data.event_type}`);
-                return null;
+                return new GenericEvent(data);
         }
     }
 }

package/dist/esm/version.js

@@ -1 +1 @@
-export const SDK_VERSION = '2.1.2';
+export const SDK_VERSION = '2.2.0';

package/dist/types/entities/adjustment/adjustment.d.ts

@@ -1,10 +1,11 @@
-import { type AdjustmentAction, type AdjustmentStatus, type CurrencyCode } from '../../enums/index.js';
+import { type AdjustmentActionType, type AdjustmentAction, type AdjustmentStatus, type CurrencyCode } from '../../enums/index.js';
 import { AdjustmentItem } from './adjustment-item.js';
 import { PayoutTotalsAdjustment, TotalAdjustments } from '../shared/index.js';
 import { type IAdjustmentResponse } from '../../types/index.js';
 export declare class Adjustment {
     readonly id: string;
     readonly action: AdjustmentAction;
+    readonly type: AdjustmentActionType;
     readonly transactionId: string;
     readonly subscriptionId: string | null;
     readonly customerId: string;

package/dist/types/entities/events/event-collection.d.ts

@@ -1,6 +1,6 @@
 import { type IEvents, type IEventsResponse } from '../../types/index.js';
 import { Collection } from '../../internal/base/index.js';
 import { type EventEntity } from '../../notifications/index.js';
-export declare class EventCollection extends Collection<IEventsResponse, EventEntity | null> {
-    fromJson(data: IEvents): EventEntity | null;
+export declare class EventCollection extends Collection<IEventsResponse, EventEntity> {
+    fromJson(data: IEvents): EventEntity;
 }

package/dist/types/entities/notifications/notification.d.ts

@@ -5,7 +5,7 @@ export declare class Notification {
     readonly id: string;
     readonly type: IEventName;
     readonly status: NotificationStatus;
-    readonly payload: EventEntity | null;
+    readonly payload: EventEntity;
     readonly occurredAt: string;
     readonly deliveredAt: null | string;
     readonly replayedAt: null | string;

package/dist/types/enums/adjustment/adjustment-action-type.d.ts

@@ -0,0 +1 @@
+export type AdjustmentActionType = 'full' | 'partial';

package/dist/types/enums/adjustment/index.d.ts

@@ -1,4 +1,5 @@
-export * from './adjustment-type.js';
-export * from './adjustment-currency-code.js';
+export * from './adjustment-action-type.js';
 export * from './adjustment-action.js';
+export * from './adjustment-currency-code.js';
 export * from './adjustment-status.js';
+export * from './adjustment-type.js';

package/dist/types/enums/shared/currency-code.d.ts

@@ -1 +1 @@
-export type CurrencyCode = 'USD' | 'EUR' | 'GBP' | 'JPY' | 'AUD' | 'CAD' | 'CHF' | 'HKD' | 'SGD' | 'SEK' | 'ARS' | 'BRL' | 'CNY' | 'COP' | 'CZK' | 'DKK' | 'HUF' | 'ILS' | 'INR' | 'KRW' | 'MXN' | 'NOK' | 'NZD' | 'PLN' | 'RUB' | 'THB' | 'TRY' | 'TWD' | 'UAH' | 'ZAR';
+export type CurrencyCode = 'USD' | 'EUR' | 'GBP' | 'JPY' | 'AUD' | 'CAD' | 'CHF' | 'HKD' | 'SGD' | 'SEK' | 'ARS' | 'BRL' | 'CNY' | 'COP' | 'CZK' | 'DKK' | 'HUF' | 'ILS' | 'INR' | 'KRW' | 'MXN' | 'NOK' | 'NZD' | 'PLN' | 'RUB' | 'THB' | 'TRY' | 'TWD' | 'UAH' | 'VND' | 'ZAR';

package/dist/types/internal/base/index.d.ts

@@ -2,3 +2,4 @@ export * from './base-resource.js';
 export * from './query-parameters.js';
 export * from './path-parameters.js';
 export * from './collection.js';
+export * from './transform.js';

package/dist/types/internal/base/transform.d.ts

@@ -0,0 +1 @@
+export declare function convertKeysToCamelCase(obj: object): object;

package/dist/types/notifications/entities/adjustment/adjustment-notification.d.ts

@@ -1,10 +1,11 @@
-import { type AdjustmentAction, type AdjustmentStatus, type CurrencyCode } from '../../../enums/index.js';
+import { type AdjustmentActionType, type AdjustmentAction, type AdjustmentStatus, type CurrencyCode } from '../../../enums/index.js';
 import { AdjustmentItemNotification } from './adjustment-item-notification.js';
 import { PayoutTotalsAdjustmentNotification, TotalAdjustmentsNotification } from '../shared/index.js';
 import { type IAdjustmentNotificationResponse } from '../../types/index.js';
 export declare class AdjustmentNotification {
     readonly id: string;
     readonly action: AdjustmentAction;
+    readonly type: AdjustmentActionType;
     readonly transactionId: string;
     readonly subscriptionId: string | null;
     readonly customerId: string;

package/dist/types/notifications/events/generic/generic-event.d.ts

@@ -0,0 +1,6 @@
+import { Event } from '../../../entities/events/event.js';
+import { type IEventsResponse } from '../../../types/index.js';
+export declare class GenericEvent extends Event {
+    readonly data: object;
+    constructor(response: IEventsResponse<object>);
+}

package/dist/types/notifications/events/generic/index.d.ts

@@ -0,0 +1 @@
+export * from './generic-event.js';

package/dist/types/notifications/events/index.d.ts

@@ -3,6 +3,7 @@ export * from './adjustment/index.js';
 export * from './business/index.js';
 export * from './customer/index.js';
 export * from './discount/index.js';
+export * from './generic/index.js';
 export * from './payment-method/index.js';
 export * from './payout/index.js';
 export * from './price/index.js';

package/dist/types/notifications/helpers/webhooks.d.ts

@@ -1,7 +1,7 @@
 import { type IEvents } from '../../types/index.js';
 import { type EventEntity } from './types.js';
 export declare class Webhooks {
-    unmarshal(requestBody: string, secretKey: string, signature: string): Promise<EventEntity | null>;
+    unmarshal(requestBody: string, secretKey: string, signature: string): Promise<EventEntity>;
     isSignatureValid(requestBody: string, secretKey: string, signature: string): Promise<boolean>;
-    static fromJson(data: IEvents): EventEntity | null;
+    static fromJson(data: IEvents): EventEntity;
 }

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

@@ -1,9 +1,10 @@
-import { type AdjustmentAction, type AdjustmentStatus, type CurrencyCode } from '../../../enums/index.js';
+import { type AdjustmentActionType, type AdjustmentAction, type AdjustmentStatus, type CurrencyCode } from '../../../enums/index.js';
 import { type IAdjustmentItemNotificationResponse } from './adjustment-item-notification-response.js';
 import { type IPayoutTotalsAdjustmentNotificationResponse, type ITotalAdjustmentsNotificationResponse } from '../shared/index.js';
 export interface IAdjustmentNotificationResponse {
     id: string;
     action: AdjustmentAction;
+    type: AdjustmentActionType;
     transaction_id: string;
     subscription_id?: string | null;
     customer_id: string;

package/dist/types/resources/adjustments/operations/create-adjustment-request-body.d.ts

@@ -4,9 +4,18 @@ export interface CreateAdjustmentLineItem {
     itemId: string;
     type: AdjustmentType;
 }
-export interface CreateAdjustmentRequestBody {
+interface CreatePartialAdjustmentRequestBody {
     action: AdjustmentAction;
     items: CreateAdjustmentLineItem[];
     reason: string;
     transactionId: string;
+    type?: 'partial';
 }
+interface CreateFullAdjustmentRequestBody {
+    action: AdjustmentAction;
+    reason: string;
+    transactionId: string;
+    type?: 'full';
+}
+export type CreateAdjustmentRequestBody = CreatePartialAdjustmentRequestBody | CreateFullAdjustmentRequestBody;
+export {};

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

@@ -1,9 +1,10 @@
-import { type AdjustmentAction, type AdjustmentStatus, type CurrencyCode } from '../../enums/index.js';
+import { type AdjustmentActionType, type AdjustmentAction, type AdjustmentStatus, type CurrencyCode } from '../../enums/index.js';
 import { type IAdjustmentItemResponse } from './adjustment-item-response.js';
 import { type IPayoutTotalsAdjustmentResponse, type ITotalAdjustmentsResponse } from '../shared/index.js';
 export interface IAdjustmentResponse {
     id: string;
     action: AdjustmentAction;
+    type: AdjustmentActionType;
     transaction_id: string;
     subscription_id?: string | null;
     customer_id: string;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.1.2";
+export declare const SDK_VERSION = "2.2.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paddle/paddle-node-sdk",
-  "version": "2.1.2",
+  "version": "2.2.0",
   "description": "A Node.js SDK that you can use to integrate Paddle Billing with applications written in server-side JavaScript.",
   "main": "dist/cjs/index.cjs.node.js",
   "module": "dist/esm/index.esm.node.js",
@@ -68,5 +68,6 @@
       "import": "./dist/esm/index.esm.node.js",
       "require": "./dist/cjs/index.cjs.node.js"
     }
-  }
+  },
+  "dependencies": {}
 }