@paddle/paddle-node-sdk 0.2.1 → 0.2.2

package/dist/paddle.d.ts

@@ -1,5 +1,7 @@
 import { AddressesResource, AdjustmentsResource, BusinessesResource, CustomersResource, DiscountsResource, PricesResource, PricingPreviewResource, ProductsResource, SubscriptionsResource, TransactionsResource } from './resources';
 import { type PaddleOptions } from './internal';
+import { EventsResource } from './resources/events';
+import { Webhooks } from './notifications';
 export declare class Paddle {
     private readonly client;
     private readonly defaultPaddleOptions;
@@ -13,5 +15,7 @@ export declare class Paddle {
     discounts: DiscountsResource;
     subscriptions: SubscriptionsResource;
     pricingPreview: PricingPreviewResource;
-    constructor(apiKey: string, options: PaddleOptions);
+    events: EventsResource;
+    webhooks: Webhooks;
+    constructor(apiKey: string, options?: PaddleOptions);
 }

package/dist/paddle.js

@@ -4,12 +4,14 @@ exports.Paddle = void 0;
 const client_1 = require("./internal/api/client");
 const resources_1 = require("./resources");
 const internal_1 = require("./internal");
+const events_1 = require("./resources/events");
+const notifications_1 = require("./notifications");
 class Paddle {
     constructor(apiKey, options) {
         this.defaultPaddleOptions = {
             environment: internal_1.Environment.production,
         };
-        this.client = new client_1.Client(apiKey, Object.assign(Object.assign({}, this.defaultPaddleOptions), options));
+        this.client = new client_1.Client(apiKey, options ? Object.assign(Object.assign({}, this.defaultPaddleOptions), options) : Object.assign({}, this.defaultPaddleOptions));
         this.products = new resources_1.ProductsResource(this.client);
         this.prices = new resources_1.PricesResource(this.client);
         this.transactions = new resources_1.TransactionsResource(this.client);
@@ -20,6 +22,8 @@ class Paddle {
         this.discounts = new resources_1.DiscountsResource(this.client);
         this.subscriptions = new resources_1.SubscriptionsResource(this.client);
         this.pricingPreview = new resources_1.PricingPreviewResource(this.client);
+        this.events = new events_1.EventsResource(this.client);
+        this.webhooks = new notifications_1.Webhooks();
     }
 }
 exports.Paddle = Paddle;

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

@@ -0,0 +1,7 @@
+import { BaseResource } from '../../internal/base';
+import { type ListEventsQueryParameters } from './operations';
+import { EventCollection } from '../../entities';
+export * from './operations';
+export declare class EventsResource extends BaseResource {
+    list(queryParams?: ListEventsQueryParameters): EventCollection;
+}

package/dist/resources/events/index.js

@@ -0,0 +1,30 @@
+"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 });
+exports.EventsResource = void 0;
+const base_1 = require("../../internal/base");
+const entities_1 = require("../../entities");
+const EventPaths = {
+    list: '/events',
+};
+__exportStar(require("./operations"), exports);
+class EventsResource extends base_1.BaseResource {
+    list(queryParams) {
+        const queryParameters = new base_1.QueryParameters(queryParams);
+        return new entities_1.EventCollection(this.client, EventPaths.list + queryParameters.toQueryString());
+    }
+}
+exports.EventsResource = EventsResource;

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

@@ -0,0 +1 @@
+export * from './list-events-query-parameters';

package/dist/resources/events/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("./list-events-query-parameters"), exports);

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

@@ -0,0 +1,5 @@
+export interface ListEventsQueryParameters {
+    after?: string;
+    orderBy?: string;
+    perPage?: number;
+}

package/dist/resources/events/operations/list-events-query-parameters.js

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

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

@@ -0,0 +1,125 @@
+import { type IAddressResponse } from '../address';
+import { type IBusinessResponse } from '../business';
+import { type EventName } from '../../notifications';
+import { type IAdjustmentResponse } from '../adjustment';
+import { type ICustomerResponse } from '../customer';
+import { type IDiscountResponse } from '../discount';
+import { type IPriceResponse } from '../price';
+import { type IProductResponse } from '../product';
+import { type ISubscriptionNotificationResponse } from '../subscription';
+import { type ITransactionResponse } from '../transaction';
+import { type IPayoutResponse } from '../payout';
+export interface IEventsResponse<T = object> {
+    event_id: string;
+    notification_id: string;
+    event_type: string;
+    occurred_at: string;
+    data: T;
+}
+interface IAddressCreated extends IEventsResponse<IAddressResponse> {
+    event_type: EventName.AddressCreated;
+}
+interface IAddressUpdated extends IEventsResponse<IAddressResponse> {
+    event_type: EventName.AddressUpdated;
+}
+interface IAdjustmentCreated extends IEventsResponse<IAdjustmentResponse> {
+    event_type: EventName.AdjustmentCreated;
+}
+interface IAdjustmentUpdated extends IEventsResponse<IAdjustmentResponse> {
+    event_type: EventName.AdjustmentUpdated;
+}
+interface IBusinessCreated extends IEventsResponse<IBusinessResponse> {
+    event_type: EventName.BusinessCreated;
+}
+interface IBusinessUpdated extends IEventsResponse<IBusinessResponse> {
+    event_type: EventName.BusinessUpdated;
+}
+interface ICustomerCreated extends IEventsResponse<ICustomerResponse> {
+    event_type: EventName.CustomerCreated;
+}
+interface ICustomerUpdated extends IEventsResponse<ICustomerResponse> {
+    event_type: EventName.CustomerUpdated;
+}
+interface IDiscountCreated extends IEventsResponse<IDiscountResponse> {
+    event_type: EventName.DiscountCreated;
+}
+interface IDiscountUpdated extends IEventsResponse<IDiscountResponse> {
+    event_type: EventName.DiscountUpdated;
+}
+interface IDiscountImported extends IEventsResponse<IDiscountResponse> {
+    event_type: EventName.DiscountImported;
+}
+interface IPayoutCreated extends IEventsResponse<IPayoutResponse> {
+    event_type: EventName.PayoutCreated;
+}
+interface IPayoutPaid extends IEventsResponse<IPayoutResponse> {
+    event_type: EventName.PayoutPaid;
+}
+interface IPriceCreated extends IEventsResponse<IPriceResponse> {
+    event_type: EventName.PriceCreated;
+}
+interface IPriceUpdated extends IEventsResponse<IPriceResponse> {
+    event_type: EventName.PriceUpdated;
+}
+interface IProductCreated extends IEventsResponse<IProductResponse> {
+    event_type: EventName.ProductCreated;
+}
+interface IProductUpdated extends IEventsResponse<IProductResponse> {
+    event_type: EventName.ProductUpdated;
+}
+interface ISubscriptionActivated extends IEventsResponse<ISubscriptionNotificationResponse> {
+    event_type: EventName.SubscriptionActivated;
+}
+interface ISubscriptionCanceled extends IEventsResponse<ISubscriptionNotificationResponse> {
+    event_type: EventName.SubscriptionCanceled;
+}
+interface ISubscriptionCreated extends IEventsResponse<ISubscriptionNotificationResponse> {
+    event_type: EventName.SubscriptionCreated;
+}
+interface ISubscriptionImported extends IEventsResponse<ISubscriptionNotificationResponse> {
+    event_type: EventName.SubscriptionImported;
+}
+interface ISubscriptionPastDue extends IEventsResponse<ISubscriptionNotificationResponse> {
+    event_type: EventName.SubscriptionPastDue;
+}
+interface ISubscriptionPaused extends IEventsResponse<ISubscriptionNotificationResponse> {
+    event_type: EventName.SubscriptionPaused;
+}
+interface ISubscriptionResumed extends IEventsResponse<ISubscriptionNotificationResponse> {
+    event_type: EventName.SubscriptionResumed;
+}
+interface ISubscriptionTrialing extends IEventsResponse<ISubscriptionNotificationResponse> {
+    event_type: EventName.SubscriptionTrialing;
+}
+interface ISubscriptionUpdated extends IEventsResponse<ISubscriptionNotificationResponse> {
+    event_type: EventName.SubscriptionUpdated;
+}
+interface ITransactionBilled extends IEventsResponse<ITransactionResponse> {
+    event_type: EventName.TransactionBilled;
+}
+interface ITransactionCanceled extends IEventsResponse<ITransactionResponse> {
+    event_type: EventName.TransactionCanceled;
+}
+interface ITransactionCompleted extends IEventsResponse<ITransactionResponse> {
+    event_type: EventName.TransactionCompleted;
+}
+interface ITransactionCreated extends IEventsResponse<ITransactionResponse> {
+    event_type: EventName.TransactionCreated;
+}
+interface ITransactionPaid extends IEventsResponse<ITransactionResponse> {
+    event_type: EventName.TransactionPaid;
+}
+interface ITransactionPastDue extends IEventsResponse<ITransactionResponse> {
+    event_type: EventName.TransactionPastDue;
+}
+interface ITransactionPaymentFailed extends IEventsResponse<ITransactionResponse> {
+    event_type: EventName.TransactionPaymentFailed;
+}
+interface ITransactionReady extends IEventsResponse<ITransactionResponse> {
+    event_type: EventName.TransactionReady;
+}
+interface ITransactionUpdated extends IEventsResponse<ITransactionResponse> {
+    event_type: EventName.TransactionUpdated;
+}
+export type IEvents = IAddressCreated | IAddressUpdated | IAdjustmentCreated | IAdjustmentUpdated | IBusinessCreated | IBusinessUpdated | ICustomerCreated | ICustomerUpdated | IDiscountCreated | IDiscountUpdated | IDiscountImported | IPayoutCreated | IPayoutPaid | IPriceCreated | IPriceUpdated | IProductCreated | IProductUpdated | ISubscriptionActivated | ISubscriptionCanceled | ISubscriptionCreated | ISubscriptionImported | ISubscriptionPastDue | ISubscriptionPaused | ISubscriptionResumed | ISubscriptionTrialing | ISubscriptionUpdated | ITransactionBilled | ITransactionCanceled | ITransactionCompleted | ITransactionCreated | ITransactionPaid | ITransactionPastDue | ITransactionPaymentFailed | ITransactionReady | ITransactionUpdated;
+export {};

package/dist/types/events/events-response.js

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

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

@@ -0,0 +1 @@
+export * from './events-response';

package/dist/types/events/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("./events-response"), exports);

package/dist/types/index.d.ts

@@ -9,3 +9,5 @@ export * from './subscription';
 export * from './address';
 export * from './discount';
 export * from './pricing-preview';
+export * from './events';
+export * from './payout';

package/dist/types/index.js

@@ -25,3 +25,5 @@ __exportStar(require("./subscription"), exports);
 __exportStar(require("./address"), exports);
 __exportStar(require("./discount"), exports);
 __exportStar(require("./pricing-preview"), exports);
+__exportStar(require("./events"), exports);
+__exportStar(require("./payout"), exports);

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

@@ -0,0 +1 @@
+export * from './payout-response';

package/dist/types/payout/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("./payout-response"), exports);

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

@@ -0,0 +1,7 @@
+import { type CurrencyCode, type PayoutStatus } from '../../enums';
+export interface IPayoutResponse {
+    id: string;
+    status: PayoutStatus;
+    amount: string;
+    currency_code: CurrencyCode;
+}

package/dist/types/payout/payout-response.js

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

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

@@ -11,3 +11,4 @@ export * from './subscription-response';
 export * from './subscription-preview-response';
 export * from './subscription-preview-update-summary';
 export * from './subscription-result-response';
+export * from './subscription-notification-response';

package/dist/types/subscription/index.js

@@ -27,3 +27,4 @@ __exportStar(require("./subscription-response"), exports);
 __exportStar(require("./subscription-preview-response"), exports);
 __exportStar(require("./subscription-preview-update-summary"), exports);
 __exportStar(require("./subscription-result-response"), exports);
+__exportStar(require("./subscription-notification-response"), exports);

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

@@ -0,0 +1,28 @@
+import { type IBillingDetailsResponse, type ICustomData, 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;
+    status: SubscriptionStatus;
+    transaction_id: string;
+    customer_id: string;
+    address_id: string;
+    business_id?: string | null;
+    currency_code: CurrencyCode;
+    created_at: string;
+    updated_at: string;
+    started_at?: string | null;
+    first_billed_at?: string | null;
+    next_billed_at?: string | null;
+    paused_at?: string | null;
+    canceled_at?: string | null;
+    discount?: ISubscriptionDiscountResponse | null;
+    collection_mode: CollectionMode;
+    billing_details?: IBillingDetailsResponse | null;
+    current_billing_period?: ISubscriptionTimePeriodResponse | null;
+    billing_cycle: ITimePeriod;
+    scheduled_change?: ISubscriptionScheduledChangeResponse | null;
+    items: ISubscriptionItemResponse[];
+    custom_data?: ICustomData | null;
+    next_transaction?: INextTransactionResponse | null;
+    recurring_transaction_details?: ITransactionDetailsPreviewResponse | null;
+}

package/dist/types/subscription/subscription-notification-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.1";
+export declare const SDK_VERSION = "0.2.2";

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.1';
+exports.SDK_VERSION = '0.2.2';

package/package.json

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