dodopayments 2.32.0 → 2.32.2

package/src/resources/products/index.ts

@@ -16,9 +16,9 @@ export {
   type ProductEntitlementSummary,
   type ProductListResponse,
   type ProductUpdateFilesResponse,
+  type ProductListParams,
   type ProductCreateParams,
   type ProductUpdateParams,
-  type ProductListParams,
   type ProductUpdateFilesParams,
   type ProductListResponsesDefaultPageNumberPagination,
 } from './products';
@@ -26,7 +26,7 @@ export {
   ShortLinks,
   type ShortLinkCreateResponse,
   type ShortLinkListResponse,
-  type ShortLinkCreateParams,
   type ShortLinkListParams,
+  type ShortLinkCreateParams,
   type ShortLinkListResponsesDefaultPageNumberPagination,
 } from './short-links';

package/src/resources/products/products.ts

@@ -31,6 +31,16 @@ export class Products extends APIResource {
   images: ImagesAPI.Images = new ImagesAPI.Images(this._client);
   shortLinks: ShortLinksAPI.ShortLinks = new ShortLinksAPI.ShortLinks(this._client);
 
+  list(
+    query: ProductListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ProductListResponsesDefaultPageNumberPagination, ProductListResponse> {
+    return this._client.getAPIList('/products', DefaultPageNumberPagination<ProductListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
   create(body: ProductCreateParams, options?: RequestOptions): APIPromise<Product> {
     return this._client.post('/products', { body, ...options });
   }
@@ -47,16 +57,6 @@ export class Products extends APIResource {
     });
   }
 
-  list(
-    query: ProductListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<ProductListResponsesDefaultPageNumberPagination, ProductListResponse> {
-    return this._client.getAPIList('/products', DefaultPageNumberPagination<ProductListResponse>, {
-      query,
-      ...options,
-    });
-  }
-
   archive(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/products/${id}`, {
       ...options,
@@ -797,6 +797,27 @@ export interface ProductUpdateFilesResponse {
   url: string;
 }
 
+export interface ProductListParams extends DefaultPageNumberPaginationParams {
+  /**
+   * List archived products
+   */
+  archived?: boolean;
+
+  /**
+   * filter by Brand id
+   */
+  brand_id?: string;
+
+  /**
+   * Filter products by pricing type:
+   *
+   * - `true`: Show only recurring pricing products (e.g. subscriptions)
+   * - `false`: Show only one-time price products
+   * - `null` or absent: Show both types of products
+   */
+  recurring?: boolean;
+}
+
 export interface ProductCreateParams {
   /**
    * Name of the product
@@ -1008,27 +1029,6 @@ export namespace ProductUpdateParams {
   }
 }
 
-export interface ProductListParams extends DefaultPageNumberPaginationParams {
-  /**
-   * List archived products
-   */
-  archived?: boolean;
-
-  /**
-   * filter by Brand id
-   */
-  brand_id?: string;
-
-  /**
-   * Filter products by pricing type:
-   *
-   * - `true`: Show only recurring pricing products (e.g. subscriptions)
-   * - `false`: Show only one-time price products
-   * - `null` or absent: Show both types of products
-   */
-  recurring?: boolean;
-}
-
 export interface ProductUpdateFilesParams {
   file_name: string;
 }
@@ -1052,9 +1052,9 @@ export declare namespace Products {
     type ProductListResponse as ProductListResponse,
     type ProductUpdateFilesResponse as ProductUpdateFilesResponse,
     type ProductListResponsesDefaultPageNumberPagination as ProductListResponsesDefaultPageNumberPagination,
+    type ProductListParams as ProductListParams,
     type ProductCreateParams as ProductCreateParams,
     type ProductUpdateParams as ProductUpdateParams,
-    type ProductListParams as ProductListParams,
     type ProductUpdateFilesParams as ProductUpdateFilesParams,
   };
 
@@ -1069,7 +1069,7 @@ export declare namespace Products {
     type ShortLinkCreateResponse as ShortLinkCreateResponse,
     type ShortLinkListResponse as ShortLinkListResponse,
     type ShortLinkListResponsesDefaultPageNumberPagination as ShortLinkListResponsesDefaultPageNumberPagination,
-    type ShortLinkCreateParams as ShortLinkCreateParams,
     type ShortLinkListParams as ShortLinkListParams,
+    type ShortLinkCreateParams as ShortLinkCreateParams,
   };
 }

package/src/resources/products/short-links.ts

@@ -11,18 +11,6 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 export class ShortLinks extends APIResource {
-  /**
-   * Gives a Short Checkout URL with custom slug for a product. Uses a Static
-   * Checkout URL under the hood.
-   */
-  create(
-    id: string,
-    body: ShortLinkCreateParams,
-    options?: RequestOptions,
-  ): APIPromise<ShortLinkCreateResponse> {
-    return this._client.post(path`/products/${id}/short_links`, { body, ...options });
-  }
-
   /**
    * Lists all short links created by the business.
    */
@@ -36,6 +24,18 @@ export class ShortLinks extends APIResource {
       { query, ...options },
     );
   }
+
+  /**
+   * Gives a Short Checkout URL with custom slug for a product. Uses a Static
+   * Checkout URL under the hood.
+   */
+  create(
+    id: string,
+    body: ShortLinkCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<ShortLinkCreateResponse> {
+    return this._client.post(path`/products/${id}/short_links`, { body, ...options });
+  }
 }
 
 export type ShortLinkListResponsesDefaultPageNumberPagination =
@@ -75,6 +75,13 @@ export interface ShortLinkListResponse {
   short_url: string;
 }
 
+export interface ShortLinkListParams extends DefaultPageNumberPaginationParams {
+  /**
+   * Filter by product ID
+   */
+  product_id?: string;
+}
+
 export interface ShortLinkCreateParams {
   /**
    * Slug for the short link.
@@ -87,19 +94,12 @@ export interface ShortLinkCreateParams {
   static_checkout_params?: { [key: string]: string } | null;
 }
 
-export interface ShortLinkListParams extends DefaultPageNumberPaginationParams {
-  /**
-   * Filter by product ID
-   */
-  product_id?: string;
-}
-
 export declare namespace ShortLinks {
   export {
     type ShortLinkCreateResponse as ShortLinkCreateResponse,
     type ShortLinkListResponse as ShortLinkListResponse,
     type ShortLinkListResponsesDefaultPageNumberPagination as ShortLinkListResponsesDefaultPageNumberPagination,
-    type ShortLinkCreateParams as ShortLinkCreateParams,
     type ShortLinkListParams as ShortLinkListParams,
+    type ShortLinkCreateParams as ShortLinkCreateParams,
   };
 }

package/src/resources/refunds.ts

@@ -14,14 +14,6 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class Refunds extends APIResource {
-  create(body: RefundCreateParams, options?: RequestOptions): APIPromise<Refund> {
-    return this._client.post('/refunds', { body, ...options });
-  }
-
-  retrieve(refundID: string, options?: RequestOptions): APIPromise<Refund> {
-    return this._client.get(path`/refunds/${refundID}`, options);
-  }
-
   list(
     query: RefundListParams | null | undefined = {},
     options?: RequestOptions,
@@ -31,6 +23,14 @@ export class Refunds extends APIResource {
       ...options,
     });
   }
+
+  create(body: RefundCreateParams, options?: RequestOptions): APIPromise<Refund> {
+    return this._client.post('/refunds', { body, ...options });
+  }
+
+  retrieve(refundID: string, options?: RequestOptions): APIPromise<Refund> {
+    return this._client.get(path`/refunds/${refundID}`, options);
+  }
 }
 
 export interface Refund {
@@ -92,6 +92,33 @@ export interface Refund {
 
 export type RefundStatus = 'succeeded' | 'failed' | 'pending' | 'review';
 
+export interface RefundListParams extends DefaultPageNumberPaginationParams {
+  /**
+   * Get events after this created time
+   */
+  created_at_gte?: string;
+
+  /**
+   * Get events created before this time
+   */
+  created_at_lte?: string;
+
+  /**
+   * Filter by customer_id
+   */
+  customer_id?: string;
+
+  /**
+   * Filter by status
+   */
+  status?: 'succeeded' | 'failed' | 'pending' | 'review';
+
+  /**
+   * Filter by subscription id
+   */
+  subscription_id?: string;
+}
+
 export interface RefundCreateParams {
   /**
    * The unique identifier of the payment to be refunded.
@@ -133,39 +160,12 @@ export namespace RefundCreateParams {
   }
 }
 
-export interface RefundListParams extends DefaultPageNumberPaginationParams {
-  /**
-   * Get events after this created time
-   */
-  created_at_gte?: string;
-
-  /**
-   * Get events created before this time
-   */
-  created_at_lte?: string;
-
-  /**
-   * Filter by customer_id
-   */
-  customer_id?: string;
-
-  /**
-   * Filter by status
-   */
-  status?: 'succeeded' | 'failed' | 'pending' | 'review';
-
-  /**
-   * Filter by subscription id
-   */
-  subscription_id?: string;
-}
-
 export declare namespace Refunds {
   export {
     type Refund as Refund,
     type RefundStatus as RefundStatus,
-    type RefundCreateParams as RefundCreateParams,
     type RefundListParams as RefundListParams,
+    type RefundCreateParams as RefundCreateParams,
   };
 }
 

package/src/resources/subscriptions.ts

@@ -17,6 +17,16 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class Subscriptions extends APIResource {
+  list(
+    query: SubscriptionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SubscriptionListResponsesDefaultPageNumberPagination, SubscriptionListResponse> {
+    return this._client.getAPIList('/subscriptions', DefaultPageNumberPagination<SubscriptionListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * @deprecated
    */
@@ -36,35 +46,6 @@ export class Subscriptions extends APIResource {
     return this._client.patch(path`/subscriptions/${subscriptionID}`, { body, ...options });
   }
 
-  list(
-    query: SubscriptionListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<SubscriptionListResponsesDefaultPageNumberPagination, SubscriptionListResponse> {
-    return this._client.getAPIList('/subscriptions', DefaultPageNumberPagination<SubscriptionListResponse>, {
-      query,
-      ...options,
-    });
-  }
-
-  cancelChangePlan(subscriptionID: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/subscriptions/${subscriptionID}/change-plan/scheduled`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-
-  changePlan(
-    subscriptionID: string,
-    body: SubscriptionChangePlanParams,
-    options?: RequestOptions,
-  ): APIPromise<void> {
-    return this._client.post(path`/subscriptions/${subscriptionID}/change-plan`, {
-      body,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-
   charge(
     subscriptionID: string,
     body: SubscriptionChargeParams,
@@ -73,24 +54,18 @@ export class Subscriptions extends APIResource {
     return this._client.post(path`/subscriptions/${subscriptionID}/charge`, { body, ...options });
   }
 
-  previewChangePlan(
+  changePlan(
     subscriptionID: string,
-    body: SubscriptionPreviewChangePlanParams,
+    body: SubscriptionChangePlanParams,
     options?: RequestOptions,
-  ): APIPromise<SubscriptionPreviewChangePlanResponse> {
-    return this._client.post(path`/subscriptions/${subscriptionID}/change-plan/preview`, {
+  ): APIPromise<void> {
+    return this._client.post(path`/subscriptions/${subscriptionID}/change-plan`, {
       body,
       ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
-  retrieveCreditUsage(
-    subscriptionID: string,
-    options?: RequestOptions,
-  ): APIPromise<SubscriptionRetrieveCreditUsageResponse> {
-    return this._client.get(path`/subscriptions/${subscriptionID}/credit-usage`, options);
-  }
-
   /**
    * Get detailed usage history for a subscription that includes usage-based billing
    * (metered components). This endpoint provides insights into customer usage
@@ -161,6 +136,31 @@ export class Subscriptions extends APIResource {
       ...options,
     });
   }
+
+  previewChangePlan(
+    subscriptionID: string,
+    body: SubscriptionPreviewChangePlanParams,
+    options?: RequestOptions,
+  ): APIPromise<SubscriptionPreviewChangePlanResponse> {
+    return this._client.post(path`/subscriptions/${subscriptionID}/change-plan/preview`, {
+      body,
+      ...options,
+    });
+  }
+
+  retrieveCreditUsage(
+    subscriptionID: string,
+    options?: RequestOptions,
+  ): APIPromise<SubscriptionRetrieveCreditUsageResponse> {
+    return this._client.get(path`/subscriptions/${subscriptionID}/credit-usage`, options);
+  }
+
+  cancelChangePlan(subscriptionID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/subscriptions/${subscriptionID}/change-plan/scheduled`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
 }
 
 export type SubscriptionListResponsesDefaultPageNumberPagination =
@@ -1146,6 +1146,38 @@ export interface SubscriptionUpdatePaymentMethodResponse {
   payment_link?: string | null;
 }
 
+export interface SubscriptionListParams extends DefaultPageNumberPaginationParams {
+  /**
+   * filter by Brand id
+   */
+  brand_id?: string;
+
+  /**
+   * Get events after this created time
+   */
+  created_at_gte?: string;
+
+  /**
+   * Get events created before this time
+   */
+  created_at_lte?: string;
+
+  /**
+   * Filter by customer id
+   */
+  customer_id?: string;
+
+  /**
+   * Filter by product id
+   */
+  product_id?: string;
+
+  /**
+   * Filter by status
+   */
+  status?: 'pending' | 'active' | 'on_hold' | 'cancelled' | 'failed' | 'expired';
+}
+
 export interface SubscriptionCreateParams {
   /**
    * Billing address information for the subscription
@@ -1370,36 +1402,59 @@ export namespace SubscriptionUpdateParams {
   }
 }
 
-export interface SubscriptionListParams extends DefaultPageNumberPaginationParams {
+export interface SubscriptionChargeParams {
   /**
-   * filter by Brand id
+   * The product price. Represented in the lowest denomination of the currency (e.g.,
+   * cents for USD). For example, to charge $1.00, pass `100`.
    */
-  brand_id?: string;
+  product_price: number;
 
   /**
-   * Get events after this created time
+   * Whether adaptive currency fees should be included in the product_price (true) or
+   * added on top (false). This field is ignored if adaptive pricing is not enabled
+   * for the business.
    */
-  created_at_gte?: string;
+  adaptive_currency_fees_inclusive?: boolean | null;
 
   /**
-   * Get events created before this time
+   * Specify how customer balance is used for the payment
    */
-  created_at_lte?: string;
+  customer_balance_config?: SubscriptionChargeParams.CustomerBalanceConfig | null;
 
   /**
-   * Filter by customer id
+   * Metadata for the payment. If not passed, the metadata of the subscription will
+   * be taken
    */
-  customer_id?: string;
+  metadata?: { [key: string]: string } | null;
 
   /**
-   * Filter by product id
+   * Optional currency of the product price. If not specified, defaults to the
+   * currency of the product.
    */
-  product_id?: string;
+  product_currency?: MiscAPI.Currency | null;
 
   /**
-   * Filter by status
+   * Optional product description override for billing and line items. If not
+   * specified, the stored description of the product will be used.
    */
-  status?: 'pending' | 'active' | 'on_hold' | 'cancelled' | 'failed' | 'expired';
+  product_description?: string | null;
+}
+
+export namespace SubscriptionChargeParams {
+  /**
+   * Specify how customer balance is used for the payment
+   */
+  export interface CustomerBalanceConfig {
+    /**
+     * Allows Customer Credit to be purchased to settle payments
+     */
+    allow_customer_credits_purchase?: boolean | null;
+
+    /**
+     * Allows Customer Credit Balance to be used to settle payments
+     */
+    allow_customer_credits_usage?: boolean | null;
+  }
 }
 
 export interface SubscriptionChangePlanParams {
@@ -1473,58 +1528,38 @@ export interface SubscriptionChangePlanParams {
   on_payment_failure?: 'prevent_change' | 'apply_change' | null;
 }
 
-export interface SubscriptionChargeParams {
+export interface SubscriptionRetrieveUsageHistoryParams extends DefaultPageNumberPaginationParams {
   /**
-   * The product price. Represented in the lowest denomination of the currency (e.g.,
-   * cents for USD). For example, to charge $1.00, pass `100`.
+   * Filter by end date (inclusive)
    */
-  product_price: number;
+  end_date?: string | null;
 
   /**
-   * Whether adaptive currency fees should be included in the product_price (true) or
-   * added on top (false). This field is ignored if adaptive pricing is not enabled
-   * for the business.
+   * Filter by specific meter ID
    */
-  adaptive_currency_fees_inclusive?: boolean | null;
+  meter_id?: string | null;
 
   /**
-   * Specify how customer balance is used for the payment
+   * Filter by start date (inclusive)
    */
-  customer_balance_config?: SubscriptionChargeParams.CustomerBalanceConfig | null;
+  start_date?: string | null;
+}
 
-  /**
-   * Metadata for the payment. If not passed, the metadata of the subscription will
-   * be taken
-   */
-  metadata?: { [key: string]: string } | null;
+export interface SubscriptionUpdatePaymentMethodParams {
+  payment_method: SubscriptionUpdatePaymentMethodParams.New | SubscriptionUpdatePaymentMethodParams.Existing;
+}
 
-  /**
-   * Optional currency of the product price. If not specified, defaults to the
-   * currency of the product.
-   */
-  product_currency?: MiscAPI.Currency | null;
+export namespace SubscriptionUpdatePaymentMethodParams {
+  export interface New {
+    type: 'new';
 
-  /**
-   * Optional product description override for billing and line items. If not
-   * specified, the stored description of the product will be used.
-   */
-  product_description?: string | null;
-}
+    return_url?: string | null;
+  }
 
-export namespace SubscriptionChargeParams {
-  /**
-   * Specify how customer balance is used for the payment
-   */
-  export interface CustomerBalanceConfig {
-    /**
-     * Allows Customer Credit to be purchased to settle payments
-     */
-    allow_customer_credits_purchase?: boolean | null;
+  export interface Existing {
+    payment_method_id: string;
 
-    /**
-     * Allows Customer Credit Balance to be used to settle payments
-     */
-    allow_customer_credits_usage?: boolean | null;
+    type: 'existing';
   }
 }
 
@@ -1599,41 +1634,6 @@ export interface SubscriptionPreviewChangePlanParams {
   on_payment_failure?: 'prevent_change' | 'apply_change' | null;
 }
 
-export interface SubscriptionRetrieveUsageHistoryParams extends DefaultPageNumberPaginationParams {
-  /**
-   * Filter by end date (inclusive)
-   */
-  end_date?: string | null;
-
-  /**
-   * Filter by specific meter ID
-   */
-  meter_id?: string | null;
-
-  /**
-   * Filter by start date (inclusive)
-   */
-  start_date?: string | null;
-}
-
-export interface SubscriptionUpdatePaymentMethodParams {
-  payment_method: SubscriptionUpdatePaymentMethodParams.New | SubscriptionUpdatePaymentMethodParams.Existing;
-}
-
-export namespace SubscriptionUpdatePaymentMethodParams {
-  export interface New {
-    type: 'new';
-
-    return_url?: string | null;
-  }
-
-  export interface Existing {
-    payment_method_id: string;
-
-    type: 'existing';
-  }
-}
-
 export declare namespace Subscriptions {
   export {
     type AddonCartResponseItem as AddonCartResponseItem,
@@ -1657,13 +1657,13 @@ export declare namespace Subscriptions {
     type SubscriptionUpdatePaymentMethodResponse as SubscriptionUpdatePaymentMethodResponse,
     type SubscriptionListResponsesDefaultPageNumberPagination as SubscriptionListResponsesDefaultPageNumberPagination,
     type SubscriptionRetrieveUsageHistoryResponsesDefaultPageNumberPagination as SubscriptionRetrieveUsageHistoryResponsesDefaultPageNumberPagination,
+    type SubscriptionListParams as SubscriptionListParams,
     type SubscriptionCreateParams as SubscriptionCreateParams,
     type SubscriptionUpdateParams as SubscriptionUpdateParams,
-    type SubscriptionListParams as SubscriptionListParams,
-    type SubscriptionChangePlanParams as SubscriptionChangePlanParams,
     type SubscriptionChargeParams as SubscriptionChargeParams,
-    type SubscriptionPreviewChangePlanParams as SubscriptionPreviewChangePlanParams,
+    type SubscriptionChangePlanParams as SubscriptionChangePlanParams,
     type SubscriptionRetrieveUsageHistoryParams as SubscriptionRetrieveUsageHistoryParams,
     type SubscriptionUpdatePaymentMethodParams as SubscriptionUpdatePaymentMethodParams,
+    type SubscriptionPreviewChangePlanParams as SubscriptionPreviewChangePlanParams,
   };
 }