@paddle/paddle-node-sdk 0.1.8 → 0.2.0

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

@@ -0,0 +1,32 @@
+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';
+export interface ITransactionResponse {
+    id: string;
+    status: TransactionStatus;
+    customer_id?: string | null;
+    address_id?: string | null;
+    business_id?: string | null;
+    custom_data?: ICustomData | null;
+    currency_code: CurrencyCode;
+    origin: TransactionOrigin;
+    subscription_id?: string | null;
+    invoice_id?: string | null;
+    invoice_number?: string | null;
+    collection_mode: CollectionMode;
+    discount_id?: string | null;
+    billing_details?: IBillingDetailsResponse | null;
+    billing_period?: ITransactionsTimePeriodResponse | null;
+    items: ITransactionItemResponse[];
+    details?: ITransactionDetailsResponse | null;
+    payments: ITransactionPaymentAttemptResponse[];
+    checkout?: ITransactionCheckout | null;
+    created_at: string;
+    updated_at: string;
+    billed_at?: string | null;
+    address?: IAddressResponse | null;
+    adjustments?: ITransactionAdjustmentResponse[] | null;
+    adjustments_totals?: IAdjustmentTotalsResponse | null;
+    business?: IBusinessResponse | null;
+    customer?: ICustomerResponse | null;
+    discount?: IDiscountResponse | null;
+}

package/dist/types/transaction/transactions-time-period-response.d.ts

@@ -0,0 +1,4 @@
+export interface ITransactionsTimePeriodResponse {
+    starts_at: string;
+    ends_at: string;
+}

package/dist/types/transaction/transactions-time-period.d.ts

@@ -1,4 +1,4 @@
 export interface ITransactionsTimePeriod {
-    starts_at: string;
-    ends_at: string;
+    startsAt: string;
+    endsAt: string;
 }

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.1.8";
+export declare const SDK_VERSION = "0.2.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.1.8';
+exports.SDK_VERSION = '0.2.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paddle/paddle-node-sdk",
-  "version": "0.1.8",
+  "version": "0.2.0",
   "description": "A NodeJS SDK for Paddle Billing API",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -29,6 +29,7 @@
     "@babel/preset-env": "^7.22.20",
     "@babel/preset-typescript": "^7.23.0",
     "@types/jest": "^29.5.6",
+    "@types/lodash": "^4.14.202",
     "@types/node": "^20.6.0",
     "@types/node-fetch": "^2.6.6",
     "@typescript-eslint/eslint-plugin": "^6.4.0",
@@ -44,6 +45,7 @@
     "typescript": "^5.2.2"
   },
   "dependencies": {
+    "lodash": "^4.17.21",
     "node-fetch": "^2.7.0"
   }
 }

package/dist/resources/addresses/operations/create-address-path-parameters.d.ts

@@ -1,3 +0,0 @@
-export interface CreateAddressPathParameters {
-    customer_id: string;
-}

package/dist/resources/addresses/operations/get-address-path-parameters.d.ts

@@ -1,4 +0,0 @@
-export interface GetAddressPathParameters {
-    customer_id: string;
-    address_id: string;
-}

package/dist/resources/addresses/operations/list-address-path-parameters.d.ts

@@ -1,3 +0,0 @@
-export interface ListAddressPathParameters {
-    customer_id: string;
-}

package/dist/resources/addresses/operations/update-address-path-parameters.d.ts

@@ -1,4 +0,0 @@
-export interface UpdateAddressPathParameters {
-    customer_id: string;
-    address_id: string;
-}

package/dist/resources/businesses/operations/create-business-path-parameters.d.ts

@@ -1,3 +0,0 @@
-export interface CreateBusinessPathParameters {
-    customer_id: string;
-}

package/dist/resources/businesses/operations/get-business-path-parameters.d.ts

@@ -1,4 +0,0 @@
-export interface GetBusinessPathParameters {
-    customer_id: string;
-    business_id: string;
-}

package/dist/resources/businesses/operations/list-business-path-parameters.d.ts

@@ -1,3 +0,0 @@
-export interface ListBusinessPathParameters {
-    customer_id: string;
-}

package/dist/resources/businesses/operations/update-business-path-parameters.d.ts

@@ -1,4 +0,0 @@
-export interface UpdateBusinessPathParameters {
-    customer_id: string;
-    business_id: string;
-}

package/dist/resources/customers/operations/get-credit-balance-path-parameters.d.ts

@@ -1,3 +0,0 @@
-export interface GetCreditBalancePathParameters {
-    customer_id: string;
-}

package/dist/resources/customers/operations/get-customer-path-parameters.d.ts

@@ -1,3 +0,0 @@
-export interface GetCustomerPathParameters {
-    customer_id: string;
-}

package/dist/resources/customers/operations/update-customer-path-parameters.d.ts

@@ -1,3 +0,0 @@
-export interface UpdateCustomerPathParameters {
-    customer_id: string;
-}

package/dist/resources/discounts/operations/get-discount-path-parameters.d.ts

@@ -1,3 +0,0 @@
-export interface GetDiscountPathParameters {
-    discount_id: string;
-}

package/dist/resources/discounts/operations/update-discount-path-parameters.d.ts

@@ -1,3 +0,0 @@
-export interface UpdateDiscountPathParameters {
-    discount_id: string;
-}

package/dist/resources/prices/operations/get-price-path-parameters.d.ts

@@ -1,3 +0,0 @@
-export interface GetPricePathParameters {
-    price_id: string;
-}

package/dist/resources/prices/operations/update-price-path-parameters.d.ts

@@ -1,3 +0,0 @@
-export interface UpdatePricePathParameters {
-    price_id: string;
-}

package/dist/resources/products/operations/get-product-path-parameters.d.ts

@@ -1,3 +0,0 @@
-export interface GetProductPathParameters {
-    product_id: string;
-}

package/dist/resources/products/operations/update-product-path-parameters.d.ts

@@ -1,3 +0,0 @@
-export interface UpdateProductPathParameters {
-    product_id: string;
-}

package/dist/resources/subscriptions/operations/get-subscription-path-parameters.d.ts

@@ -1,3 +0,0 @@
-export interface GetSubscriptionPathParameters {
-    subscription_id: string;
-}

package/dist/resources/subscriptions/operations/update-subscription-path-parameters.d.ts

@@ -1,3 +0,0 @@
-export interface UpdateSubscriptionPathParameters {
-    subscription_id: string;
-}

package/dist/resources/transactions/operations/get-transaction-path-parameters.d.ts

@@ -1,3 +0,0 @@
-export interface GetTransactionPathParameters {
-    transaction_id: string;
-}

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

@@ -1,3 +0,0 @@
-export interface UpdateTransactionPathParameters {
-    transaction_id: string;
-}

package/dist/types/address/address.d.ts

@@ -1,16 +0,0 @@
-import { type ICustomData } from '../index';
-import { type CountryCode, type Status } from '../../enums';
-export interface IAddress {
-    id: string;
-    description?: string | undefined | null;
-    first_line?: string | undefined | null;
-    second_line?: string | undefined | null;
-    city?: string | undefined | null;
-    postal_code?: string | undefined | null;
-    region?: string | undefined | null;
-    country_code: CountryCode;
-    custom_data?: ICustomData | undefined | null;
-    status: Status;
-    created_at: string;
-    updated_at: string;
-}

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

@@ -1,10 +0,0 @@
-import { type IAdjustmentItemTotals, type IAdjustmentsProration } from '../index';
-import { type AdjustmentType } from '../../enums';
-export interface IAdjustmentItem {
-    id: string;
-    item_id: string;
-    type: AdjustmentType;
-    amount?: string | undefined | null;
-    proration?: IAdjustmentsProration | undefined | null;
-    totals?: IAdjustmentItemTotals | undefined;
-}

package/dist/types/adjustment/adjustments-proration.d.ts

@@ -1,5 +0,0 @@
-import { type IAdjustmentsTimePeriod } from '../index';
-export interface IAdjustmentsProration {
-    rate: string;
-    billing_period?: IAdjustmentsTimePeriod | undefined;
-}

package/dist/types/adjustment/adjustments-time-period.d.ts

@@ -1,4 +0,0 @@
-export interface IAdjustmentsTimePeriod {
-    starts_at: string;
-    ends_at: string;
-}

package/dist/types/customer/credit-balance.d.ts

@@ -1,7 +0,0 @@
-import { type ICustomerBalance } from '../index';
-import { type CurrencyCode } from '../../enums';
-export interface ICreditBalance {
-    customer_id?: string | null | undefined;
-    currency_code?: CurrencyCode | null | undefined;
-    balance?: ICustomerBalance | null | undefined;
-}

package/dist/types/discount/discount.d.ts

@@ -1,19 +0,0 @@
-import { type CurrencyCode, type DiscountStatus, type DiscountType } from '../../enums';
-export interface IDiscount {
-    id: string;
-    status: DiscountStatus;
-    description: string;
-    enabled_for_checkout: boolean;
-    code?: string | undefined | null;
-    type: DiscountType;
-    amount: string;
-    currency_code?: CurrencyCode | undefined | null;
-    recur: boolean;
-    maximum_recurring_intervals?: number | undefined | null;
-    usage_limit?: number | undefined | null;
-    restrict_to?: string[] | undefined | null;
-    expires_at?: string | undefined | null;
-    times_used: number;
-    created_at: string;
-    updated_at: string;
-}

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

@@ -1,16 +0,0 @@
-import { type ITimePeriod, type IMoney, type IUnitPriceOverride, type IPriceQuantity, type ICustomData, type ISharedProduct } from '../index';
-import { type TaxMode, type Status } from '../../enums';
-export interface IPrice {
-    id: string;
-    product_id: string;
-    description: string;
-    billing_cycle?: ITimePeriod | undefined | null;
-    trial_period?: ITimePeriod | undefined | null;
-    tax_mode: TaxMode;
-    unit_price: IMoney;
-    unit_price_overrides: IUnitPriceOverride[];
-    quantity: IPriceQuantity;
-    status: Status;
-    custom_data?: ICustomData | undefined | null;
-    product?: ISharedProduct | undefined | null;
-}

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

@@ -1,13 +0,0 @@
-import { type ICustomData, type ISharedPrice } from '../index';
-import { type TaxCategory, type Status } from '../../enums';
-export interface IProduct {
-    id: string;
-    name: string;
-    description?: string | undefined;
-    tax_category: TaxCategory;
-    image_url?: undefined | string;
-    custom_data?: ICustomData | undefined;
-    status: Status;
-    created_at: string;
-    prices?: ISharedPrice[] | undefined;
-}

package/dist/types/shared/billing-details.d.ts

@@ -1,7 +0,0 @@
-import { type ITimePeriod } from '../index';
-export interface IBillingDetails {
-    enable_checkout?: boolean | undefined | null;
-    purchase_order_number?: string | undefined | null;
-    additional_information?: string | undefined | null;
-    payment_terms: ITimePeriod;
-}

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

@@ -1,15 +0,0 @@
-import { type ITimePeriod, type IMoney, type IUnitPriceOverride, type IPriceQuantity, type ICustomData } from '../index';
-import { type TaxMode, type Status } from '../../enums';
-export interface ISharedPrice {
-    id: string;
-    product_id: string;
-    description: string;
-    billing_cycle?: ITimePeriod | undefined | null;
-    trial_period?: ITimePeriod | undefined | null;
-    tax_mode: TaxMode;
-    unit_price?: IMoney | undefined | null;
-    unit_price_overrides: IUnitPriceOverride[];
-    quantity?: IPriceQuantity | undefined | null;
-    status: Status;
-    custom_data?: ICustomData | undefined | null;
-}

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

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

package/dist/types/shared/tax-rates-used.d.ts

@@ -1,5 +0,0 @@
-import { type ITotals } from '../index';
-export interface ITaxRatesUsed {
-    tax_rate: string;
-    totals?: ITotals | undefined;
-}

package/dist/types/shared/transaction-details-preview.d.ts

@@ -1,6 +0,0 @@
-import { type ITaxRatesUsed, type ITransactionTotals, type ITransactionLineItemPreview } from '../index';
-export interface ITransactionDetailsPreview {
-    tax_rates_used: ITaxRatesUsed[];
-    totals: ITransactionTotals;
-    line_items: ITransactionLineItemPreview[];
-}

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

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

package/dist/types/subscription/next-transaction.d.ts

@@ -1,6 +0,0 @@
-import { type ISubscriptionTimePeriod, type ITransactionDetailsPreview } from '../index';
-export interface INextTransaction {
-    billing_period: ISubscriptionTimePeriod;
-    details: ITransactionDetailsPreview;
-    adjustments: any[];
-}

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

@@ -1,13 +0,0 @@
-import { type ISubscriptionPrice, type ISubscriptionTimePeriod } from '../index';
-import { type SubscriptionItemStatus } from '../../enums';
-export interface ISubscriptionItem {
-    status: SubscriptionItemStatus;
-    quantity: number;
-    recurring: boolean;
-    created_at: string;
-    updated_at: string;
-    previously_billed_at?: string | undefined;
-    next_billed_at?: string | undefined;
-    trial_dates?: ISubscriptionTimePeriod | undefined;
-    price?: ISubscriptionPrice | undefined;
-}

package/dist/types/subscription/subscription-item.js

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

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

@@ -1,4 +0,0 @@
-export interface ISubscriptionManagement {
-    update_payment_method?: string | undefined | null;
-    cancel: string;
-}

package/dist/types/subscription/subscription-management.js

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

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

@@ -1,29 +0,0 @@
-import { type ISubscriptionDiscount, type IBillingDetails, type ITimePeriod, type ISubscriptionScheduledChange, type ISubscriptionItem, type ICustomData, type INextTransaction, type ITransactionDetailsPreview, type ISubscriptionTimePeriod, type ISubscriptionManagement, type ISubscriptionPreviewUpdateSummary } from '../index';
-import { type CurrencyCode, type CollectionMode, type SubscriptionStatus } from '../../enums';
-export interface ISubscriptionPreview {
-    status: SubscriptionStatus;
-    customer_id: string;
-    address_id: string;
-    business_id?: string | undefined | null;
-    currency_code: CurrencyCode;
-    created_at: string;
-    updated_at: string;
-    started_at?: string | undefined | null;
-    first_billed_at?: string | undefined | null;
-    next_billed_at?: string | undefined | null;
-    paused_at?: string | undefined | null;
-    canceled_at?: string | undefined | null;
-    discount?: ISubscriptionDiscount | undefined | null;
-    collection_mode: CollectionMode;
-    billing_details?: IBillingDetails | undefined | null;
-    current_billing_period?: ISubscriptionTimePeriod | undefined | null;
-    billing_cycle?: ITimePeriod | undefined | null;
-    scheduled_change?: ISubscriptionScheduledChange | undefined | null;
-    management_urls?: ISubscriptionManagement | undefined | null;
-    items: ISubscriptionItem[];
-    custom_data?: ICustomData | undefined | null;
-    immediate_transaction?: INextTransaction | undefined | null;
-    next_transaction?: INextTransaction | undefined | null;
-    recurring_transaction_details?: ITransactionDetailsPreview | undefined | null;
-    update_summary?: ISubscriptionPreviewUpdateSummary | undefined | null;
-}

package/dist/types/subscription/subscription-preview.js

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

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

@@ -1,11 +0,0 @@
-import { type ITimePeriod, type IMoney } from '../index';
-import { type TaxMode } from '../../enums';
-export interface ISubscriptionPrice {
-    id: string;
-    description: string;
-    product_id: string;
-    billing_cycle?: ITimePeriod | undefined | null;
-    trial_period?: ITimePeriod | undefined | null;
-    tax_mode: TaxMode;
-    unit_price?: IMoney | undefined | null;
-}

package/dist/types/subscription/subscription-price.js

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

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

@@ -1,4 +0,0 @@
-import { type IMoney } from '../shared';
-export interface ISubscriptionResult extends IMoney {
-    action: 'credit' | 'charge';
-}

package/dist/types/subscription/subscription-result.js

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

package/dist/types/subscription/subscription-scheduled-change.js

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

package/dist/types/subscription/subscription-time-period.d.ts

@@ -1,4 +0,0 @@
-export interface ISubscriptionTimePeriod {
-    starts_at: string;
-    ends_at: string;
-}

package/dist/types/subscription/subscription-time-period.js

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

package/dist/types/transaction/adjustment-totals.js

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

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

@@ -1,10 +0,0 @@
-import { type ITransactionProration, type IAdjustmentItemTotals } from '../index';
-import { type PaymentType } from '../../enums';
-export interface ITransactionAdjustmentItem {
-    id?: string | undefined;
-    item_id: string;
-    type: PaymentType;
-    amount?: string | undefined;
-    proration?: ITransactionProration | undefined;
-    totals?: IAdjustmentItemTotals | undefined;
-}

package/dist/types/transaction/transaction-adjustment-item.js

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

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

@@ -1,18 +0,0 @@
-import { type ITransactionAdjustmentItem, type ITotalAdjustments, type IPayoutTotalsAdjustment } from '../index';
-import { type AdjustmentAction, type CurrencyCode, type AdjustmentStatus } from '../../enums';
-export interface ITransactionAdjustment {
-    id: string;
-    action: AdjustmentAction;
-    transaction_id: string;
-    subscription_id?: string | undefined | null;
-    customer_id: string;
-    reason: string;
-    credit_applied_to_balance: boolean;
-    currency_code: CurrencyCode;
-    status: AdjustmentStatus;
-    items: ITransactionAdjustmentItem[];
-    totals?: ITotalAdjustments | undefined | null;
-    payout_totals?: IPayoutTotalsAdjustment | undefined | null;
-    created_at: string;
-    updated_at: string;
-}

package/dist/types/transaction/transaction-adjustment.js

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

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

@@ -1,9 +0,0 @@
-import { type ITaxRatesUsed, type ITransactionTotals, type ITransactionTotalsAdjusted, type ITransactionPayoutTotals, type ITransactionPayoutTotalsAdjusted, type ITransactionLineItem } from '../index';
-export interface ITransactionDetails {
-    tax_rates_used: ITaxRatesUsed[];
-    totals?: ITransactionTotals | undefined | null;
-    adjusted_totals?: ITransactionTotalsAdjusted | undefined | null;
-    payout_totals?: ITransactionPayoutTotals | undefined | null;
-    adjusted_payout_totals?: ITransactionPayoutTotalsAdjusted | undefined | null;
-    line_items: ITransactionLineItem[];
-}

package/dist/types/transaction/transaction-details.js

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

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

@@ -1,11 +0,0 @@
-import { type ITransactionProration, type IUnitTotals, type ITotals, type ISharedProduct } from '../index';
-export interface ITransactionLineItem {
-    id: string;
-    price_id: string;
-    quantity: number;
-    proration?: ITransactionProration | undefined | null;
-    tax_rate: string;
-    unit_totals?: IUnitTotals | undefined | null;
-    totals?: ITotals | undefined | null;
-    product?: ISharedProduct | undefined | null;
-}

package/dist/types/transaction/transaction-line-item.js

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

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

@@ -1,27 +0,0 @@
-import { type CurrencyCode } from '../../enums';
-import { type IAddressPreview } from '../../resources';
-import { type ITransactionDetailsPreview } from '../shared';
-import { type IPrice } from '../price';
-import { type ITransactionsTimePeriod } from './transactions-time-period';
-export interface IProration {
-    rate: string;
-    billing_period: ITransactionsTimePeriod;
-}
-export interface ITransactionItemPreviewResponse {
-    price?: IPrice | null | undefined;
-    quantity: number;
-    include_in_totals?: boolean | null | undefined;
-    proration?: IProration | null | undefined;
-}
-export interface ITransactionPreview {
-    customer_id?: string | null | undefined;
-    address_id?: string | null | undefined;
-    business_id?: string | null | undefined;
-    currency_code: CurrencyCode;
-    discount_id?: string | null | undefined;
-    customer_ip_address?: string | null | undefined;
-    address?: IAddressPreview | null | undefined;
-    ignore_trials?: boolean | null | undefined;
-    items: ITransactionItemPreviewResponse[];
-    details: ITransactionDetailsPreview;
-}

package/dist/types/transaction/transaction-preview.js

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

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

@@ -1,5 +0,0 @@
-import { type ITransactionsTimePeriod } from '../index';
-export interface ITransactionProration {
-    rate: string;
-    billing_period?: ITransactionsTimePeriod | undefined;
-}

package/dist/types/transaction/transaction-proration.js

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