@paddle/paddle-node-sdk 3.6.1 → 3.8.0

package/dist/types/paddle.d.ts

@@ -1,5 +1,5 @@
 import { type PaddleOptions } from './internal/index.js';
-import { AddressesResource, AdjustmentsResource, BusinessesResource, CustomerPortalSessionsResource, CustomersResource, DiscountGroupsResource, DiscountsResource, EventTypesResource, NotificationSettingsResource, NotificationsResource, PaymentMethodsResource, PricesResource, PricingPreviewResource, ProductsResource, ReportsResource, SimulationRunEventsResource, SimulationRunsResource, SimulationsResource, SimulationTypesResource, SubscriptionsResource, TransactionsResource, ClientTokensResource } from './resources/index.js';
+import { AddressesResource, AdjustmentsResource, BusinessesResource, CustomerPortalSessionsResource, CustomersResource, DiscountGroupsResource, DiscountsResource, EventTypesResource, NotificationSettingsResource, NotificationsResource, PaymentMethodsResource, PricesResource, PricingPreviewResource, ProductsResource, ReportsResource, SimulationRunEventsResource, SimulationRunsResource, SimulationsResource, SimulationTypesResource, SubscriptionsResource, TransactionsResource, ClientTokensResource, MetricsResource } from './resources/index.js';
 import { EventsResource } from './resources/events/index.js';
 import { Webhooks } from './notifications/index.js';
 export declare class Paddle {
@@ -29,5 +29,6 @@ export declare class Paddle {
     simulationRuns: SimulationRunsResource;
     simulationRunEvents: SimulationRunEventsResource;
     clientTokens: ClientTokensResource;
+    metrics: MetricsResource;
     constructor(apiKey: string, options?: PaddleOptions);
 }

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

@@ -20,3 +20,4 @@ export * from './simulations/index.js';
 export * from './simulation-runs/index.js';
 export * from './simulation-run-events/index.js';
 export * from './client-tokens/index.js';
+export * from './metrics/index.js';

package/dist/types/resources/metrics/index.d.ts

@@ -0,0 +1,13 @@
+import { BaseResource } from '../../internal/base/index.js';
+import { type GetActiveSubscribersQueryParameters, type GetChargebacksQueryParameters, type GetCheckoutConversionQueryParameters, type GetMonthlyRecurringRevenueChangeQueryParameters, type GetMonthlyRecurringRevenueQueryParameters, type GetRefundsQueryParameters, type GetRevenueQueryParameters } from './operations/index.js';
+import { MetricsTimeseriesActiveSubscribers, MetricsTimeseriesChargebacks, MetricsTimeseriesCheckoutConversion, MetricsTimeseriesMonthlyRecurringRevenue, MetricsTimeseriesMonthlyRecurringRevenueChange, MetricsTimeseriesRefunds, MetricsTimeseriesRevenue } from '../../entities/index.js';
+export * from './operations/index.js';
+export declare class MetricsResource extends BaseResource {
+    getActiveSubscribers(queryParams: GetActiveSubscribersQueryParameters): Promise<MetricsTimeseriesActiveSubscribers>;
+    getMonthlyRecurringRevenue(queryParams: GetMonthlyRecurringRevenueQueryParameters): Promise<MetricsTimeseriesMonthlyRecurringRevenue>;
+    getMonthlyRecurringRevenueChange(queryParams: GetMonthlyRecurringRevenueChangeQueryParameters): Promise<MetricsTimeseriesMonthlyRecurringRevenueChange>;
+    getRevenue(queryParams: GetRevenueQueryParameters): Promise<MetricsTimeseriesRevenue>;
+    getRefunds(queryParams: GetRefundsQueryParameters): Promise<MetricsTimeseriesRefunds>;
+    getChargebacks(queryParams: GetChargebacksQueryParameters): Promise<MetricsTimeseriesChargebacks>;
+    getCheckoutConversion(queryParams: GetCheckoutConversionQueryParameters): Promise<MetricsTimeseriesCheckoutConversion>;
+}

package/dist/types/resources/metrics/operations/get-active-subscribers-query-parameters.d.ts

@@ -0,0 +1,4 @@
+export interface GetActiveSubscribersQueryParameters {
+    from: string;
+    to: string;
+}

package/dist/types/resources/metrics/operations/get-chargebacks-query-parameters.d.ts

@@ -0,0 +1,4 @@
+export interface GetChargebacksQueryParameters {
+    from: string;
+    to: string;
+}

package/dist/types/resources/metrics/operations/get-checkout-conversion-query-parameters.d.ts

@@ -0,0 +1,4 @@
+export interface GetCheckoutConversionQueryParameters {
+    from: string;
+    to: string;
+}

package/dist/types/resources/metrics/operations/get-monthly-recurring-revenue-change-query-parameters.d.ts

@@ -0,0 +1,4 @@
+export interface GetMonthlyRecurringRevenueChangeQueryParameters {
+    from: string;
+    to: string;
+}

package/dist/types/resources/metrics/operations/get-monthly-recurring-revenue-query-parameters.d.ts

@@ -0,0 +1,4 @@
+export interface GetMonthlyRecurringRevenueQueryParameters {
+    from: string;
+    to: string;
+}

package/dist/types/resources/metrics/operations/get-refunds-query-parameters.d.ts

@@ -0,0 +1,4 @@
+export interface GetRefundsQueryParameters {
+    from: string;
+    to: string;
+}

package/dist/types/resources/metrics/operations/get-revenue-query-parameters.d.ts

@@ -0,0 +1,4 @@
+export interface GetRevenueQueryParameters {
+    from: string;
+    to: string;
+}

package/dist/types/resources/metrics/operations/index.d.ts

@@ -0,0 +1,7 @@
+export * from './get-active-subscribers-query-parameters.js';
+export * from './get-monthly-recurring-revenue-query-parameters.js';
+export * from './get-monthly-recurring-revenue-change-query-parameters.js';
+export * from './get-revenue-query-parameters.js';
+export * from './get-refunds-query-parameters.js';
+export * from './get-chargebacks-query-parameters.js';
+export * from './get-checkout-conversion-query-parameters.js';

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

@@ -23,3 +23,4 @@ export * from './simulation/index.js';
 export * from './simulation-run/index.js';
 export * from './simulation-run-event/index.js';
 export * from './client-token/index.js';
+export * from './metrics/index.js';

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

@@ -0,0 +1,13 @@
+export * from './metrics-timeseries-active-subscribers-datapoint.js';
+export * from './metrics-timeseries-active-subscribers-response.js';
+export * from './metrics-timeseries-monthly-recurring-revenue-datapoint.js';
+export * from './metrics-timeseries-monthly-recurring-revenue-response.js';
+export * from './metrics-timeseries-monthly-recurring-revenue-change-response.js';
+export * from './metrics-timeseries-revenue-datapoint.js';
+export * from './metrics-timeseries-revenue-response.js';
+export * from './metrics-timeseries-refunds-datapoint.js';
+export * from './metrics-timeseries-refunds-response.js';
+export * from './metrics-timeseries-chargebacks-datapoint.js';
+export * from './metrics-timeseries-chargebacks-response.js';
+export * from './metrics-timeseries-checkout-conversion-datapoint.js';
+export * from './metrics-timeseries-checkout-conversion-response.js';

package/dist/types/types/metrics/metrics-timeseries-active-subscribers-datapoint.d.ts

@@ -0,0 +1,4 @@
+export interface IMetricsTimeseriesActiveSubscribersDatapoint {
+    count: number;
+    timestamp: string;
+}

package/dist/types/types/metrics/metrics-timeseries-active-subscribers-response.d.ts

@@ -0,0 +1,9 @@
+import { type MetricsTimeseriesInterval } from '../../enums/index.js';
+import { type IMetricsTimeseriesActiveSubscribersDatapoint } from './metrics-timeseries-active-subscribers-datapoint.js';
+export interface IMetricsTimeseriesActiveSubscribersResponse {
+    ends_at: string;
+    interval: MetricsTimeseriesInterval;
+    starts_at: string;
+    timeseries: IMetricsTimeseriesActiveSubscribersDatapoint[];
+    updated_at: string;
+}

package/dist/types/types/metrics/metrics-timeseries-chargebacks-datapoint.d.ts

@@ -0,0 +1,4 @@
+export interface IMetricsTimeseriesChargebacksDatapoint {
+    count: number;
+    timestamp: string;
+}

package/dist/types/types/metrics/metrics-timeseries-chargebacks-response.d.ts

@@ -0,0 +1,9 @@
+import { type MetricsTimeseriesInterval } from '../../enums/index.js';
+import { type IMetricsTimeseriesChargebacksDatapoint } from './metrics-timeseries-chargebacks-datapoint.js';
+export interface IMetricsTimeseriesChargebacksResponse {
+    ends_at: string;
+    interval: MetricsTimeseriesInterval;
+    starts_at: string;
+    timeseries: IMetricsTimeseriesChargebacksDatapoint[];
+    updated_at: string;
+}

package/dist/types/types/metrics/metrics-timeseries-checkout-conversion-datapoint.d.ts

@@ -0,0 +1,6 @@
+export interface IMetricsTimeseriesCheckoutConversionDatapoint {
+    completed_count: number;
+    count: number;
+    rate: string;
+    timestamp: string;
+}

package/dist/types/types/metrics/metrics-timeseries-checkout-conversion-response.d.ts

@@ -0,0 +1,9 @@
+import { type MetricsTimeseriesInterval } from '../../enums/index.js';
+import { type IMetricsTimeseriesCheckoutConversionDatapoint } from './metrics-timeseries-checkout-conversion-datapoint.js';
+export interface IMetricsTimeseriesCheckoutConversionResponse {
+    ends_at: string;
+    interval: MetricsTimeseriesInterval;
+    starts_at: string;
+    timeseries: IMetricsTimeseriesCheckoutConversionDatapoint[];
+    updated_at: string;
+}

package/dist/types/types/metrics/metrics-timeseries-monthly-recurring-revenue-change-response.d.ts

@@ -0,0 +1,2 @@
+import { type IMetricsTimeseriesMonthlyRecurringRevenueResponse } from './metrics-timeseries-monthly-recurring-revenue-response.js';
+export type IMetricsTimeseriesMonthlyRecurringRevenueChangeResponse = IMetricsTimeseriesMonthlyRecurringRevenueResponse;

package/dist/types/types/metrics/metrics-timeseries-monthly-recurring-revenue-datapoint.d.ts

@@ -0,0 +1,4 @@
+export interface IMetricsTimeseriesMonthlyRecurringRevenueDatapoint {
+    amount: string;
+    timestamp: string;
+}

package/dist/types/types/metrics/metrics-timeseries-monthly-recurring-revenue-response.d.ts

@@ -0,0 +1,10 @@
+import { type CurrencyCode, type MetricsTimeseriesInterval } from '../../enums/index.js';
+import { type IMetricsTimeseriesMonthlyRecurringRevenueDatapoint } from './metrics-timeseries-monthly-recurring-revenue-datapoint.js';
+export interface IMetricsTimeseriesMonthlyRecurringRevenueResponse {
+    currency_code: CurrencyCode;
+    ends_at: string;
+    interval: MetricsTimeseriesInterval;
+    starts_at: string;
+    timeseries: IMetricsTimeseriesMonthlyRecurringRevenueDatapoint[];
+    updated_at: string;
+}

package/dist/types/types/metrics/metrics-timeseries-refunds-datapoint.d.ts

@@ -0,0 +1,4 @@
+export interface IMetricsTimeseriesRefundsDatapoint {
+    amount: string;
+    timestamp: string;
+}

package/dist/types/types/metrics/metrics-timeseries-refunds-response.d.ts

@@ -0,0 +1,10 @@
+import { type CurrencyCode, type MetricsTimeseriesInterval } from '../../enums/index.js';
+import { type IMetricsTimeseriesRefundsDatapoint } from './metrics-timeseries-refunds-datapoint.js';
+export interface IMetricsTimeseriesRefundsResponse {
+    currency_code: CurrencyCode;
+    ends_at: string;
+    interval: MetricsTimeseriesInterval;
+    starts_at: string;
+    timeseries: IMetricsTimeseriesRefundsDatapoint[];
+    updated_at: string;
+}

package/dist/types/types/metrics/metrics-timeseries-revenue-datapoint.d.ts

@@ -0,0 +1,5 @@
+export interface IMetricsTimeseriesRevenueDatapoint {
+    amount: string;
+    count: number;
+    timestamp: string;
+}

package/dist/types/types/metrics/metrics-timeseries-revenue-response.d.ts

@@ -0,0 +1,10 @@
+import { type CurrencyCode, type MetricsTimeseriesInterval } from '../../enums/index.js';
+import { type IMetricsTimeseriesRevenueDatapoint } from './metrics-timeseries-revenue-datapoint.js';
+export interface IMetricsTimeseriesRevenueResponse {
+    currency_code: CurrencyCode;
+    ends_at: string;
+    interval: MetricsTimeseriesInterval;
+    starts_at: string;
+    timeseries: IMetricsTimeseriesRevenueDatapoint[];
+    updated_at: string;
+}

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

@@ -17,6 +17,7 @@ export * from './chargeback-fee.js';
 export * from './transaction-payout-totals-adjusted-response.js';
 export * from './unit-totals.js';
 export * from './paypal.js';
+export * from './transaction-paypal-response.js';
 export * from './payment-card-response.js';
 export * from './payment-method-details.js';
 export * from './transaction-payment-attempt-response.js';

package/dist/types/types/shared/payment-method-details.d.ts

@@ -2,9 +2,11 @@ import { type PaymentType } from '../../enums/index.js';
 import { type IPaymentCardResponse } from './payment-card-response.js';
 import { IPaymentMethodUnderlyingDetails } from './payment-method-underlying-details.js';
 import { type ISouthKoreaLocalCardResponse } from './south-korea-local-card-response.js';
+import { type ITransactionPayPalResponse } from './transaction-paypal-response.js';
 export interface IPaymentMethodDetails {
     type: PaymentType;
     card: IPaymentCardResponse | null;
+    paypal: ITransactionPayPalResponse | null;
     south_korea_local_card: ISouthKoreaLocalCardResponse | null;
     underlying_details: IPaymentMethodUnderlyingDetails | null;
 }

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

@@ -0,0 +1,4 @@
+export interface ITransactionPayPalResponse {
+    email: string;
+    reference: string | null;
+}

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "3.6.1";
+export declare const SDK_VERSION = "3.8.0";

package/package.json

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