dodopayments 2.32.1 → 2.33.0

package/src/resources/product-collections/product-collections.ts

@@ -24,22 +24,6 @@ import { path } from '../../internal/utils/path';
 export class ProductCollections extends APIResource {
   groups: GroupsAPI.Groups = new GroupsAPI.Groups(this._client);
 
-  create(body: ProductCollectionCreateParams, options?: RequestOptions): APIPromise<ProductCollection> {
-    return this._client.post('/product-collections', { body, ...options });
-  }
-
-  retrieve(id: string, options?: RequestOptions): APIPromise<ProductCollection> {
-    return this._client.get(path`/product-collections/${id}`, options);
-  }
-
-  update(id: string, body: ProductCollectionUpdateParams, options?: RequestOptions): APIPromise<void> {
-    return this._client.patch(path`/product-collections/${id}`, {
-      body,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-
   list(
     query: ProductCollectionListParams | null | undefined = {},
     options?: RequestOptions,
@@ -51,6 +35,14 @@ export class ProductCollections extends APIResource {
     );
   }
 
+  create(body: ProductCollectionCreateParams, options?: RequestOptions): APIPromise<ProductCollection> {
+    return this._client.post('/product-collections', { body, ...options });
+  }
+
+  retrieve(id: string, options?: RequestOptions): APIPromise<ProductCollection> {
+    return this._client.get(path`/product-collections/${id}`, options);
+  }
+
   delete(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/product-collections/${id}`, {
       ...options,
@@ -58,8 +50,12 @@ export class ProductCollections extends APIResource {
     });
   }
 
-  unarchive(id: string, options?: RequestOptions): APIPromise<ProductCollectionUnarchiveResponse> {
-    return this._client.post(path`/product-collections/${id}/unarchive`, options);
+  update(id: string, body: ProductCollectionUpdateParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.patch(path`/product-collections/${id}`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
   }
 
   updateImages(
@@ -70,6 +66,10 @@ export class ProductCollections extends APIResource {
     const { force_update } = params ?? {};
     return this._client.put(path`/product-collections/${id}/images`, { query: { force_update }, ...options });
   }
+
+  unarchive(id: string, options?: RequestOptions): APIPromise<ProductCollectionUnarchiveResponse> {
+    return this._client.post(path`/product-collections/${id}/unarchive`, options);
+  }
 }
 
 export type ProductCollectionListResponsesDefaultPageNumberPagination =
@@ -111,10 +111,50 @@ export interface ProductCollection {
    */
   description?: string | null;
 
+  /**
+   * Default effective_at setting for subscription plan downgrades (null = inherit
+   * from business)
+   */
+  effective_at_on_downgrade?: 'immediately' | 'next_billing_date' | null;
+
+  /**
+   * Default effective_at setting for subscription plan upgrades (null = inherit from
+   * business)
+   */
+  effective_at_on_upgrade?: 'immediately' | 'next_billing_date' | null;
+
   /**
    * URL of the collection image
    */
   image?: string | null;
+
+  /**
+   * Default behavior for subscription plan changes on payment failure (null =
+   * inherit from business)
+   */
+  on_payment_failure?: 'prevent_change' | 'apply_change' | null;
+
+  /**
+   * Default proration billing mode for subscription plan downgrades (null = inherit
+   * from business)
+   */
+  proration_billing_mode_on_downgrade?:
+    | 'prorated_immediately'
+    | 'full_immediately'
+    | 'difference_immediately'
+    | 'do_not_bill'
+    | null;
+
+  /**
+   * Default proration billing mode for subscription plan upgrades (null = inherit
+   * from business)
+   */
+  proration_billing_mode_on_upgrade?:
+    | 'prorated_immediately'
+    | 'full_immediately'
+    | 'difference_immediately'
+    | 'do_not_bill'
+    | null;
 }
 
 export interface ProductCollectionListResponse {
@@ -183,6 +223,18 @@ export interface ProductCollectionUpdateImagesResponse {
   image_id?: string | null;
 }
 
+export interface ProductCollectionListParams extends DefaultPageNumberPaginationParams {
+  /**
+   * List archived collections
+   */
+  archived?: boolean;
+
+  /**
+   * Filter by Brand id
+   */
+  brand_id?: string;
+}
+
 export interface ProductCollectionCreateParams {
   /**
    * Groups of products in this collection
@@ -203,6 +255,46 @@ export interface ProductCollectionCreateParams {
    * Optional description of the product collection
    */
   description?: string | null;
+
+  /**
+   * Default effective_at setting for subscription plan downgrades (NULL = inherit
+   * from business)
+   */
+  effective_at_on_downgrade?: 'immediately' | 'next_billing_date' | null;
+
+  /**
+   * Default effective_at setting for subscription plan upgrades (NULL = inherit from
+   * business)
+   */
+  effective_at_on_upgrade?: 'immediately' | 'next_billing_date' | null;
+
+  /**
+   * Default behavior for subscription plan changes on payment failure (NULL =
+   * inherit from business)
+   */
+  on_payment_failure?: 'prevent_change' | 'apply_change' | null;
+
+  /**
+   * Default proration billing mode for subscription plan downgrades (NULL = inherit
+   * from business)
+   */
+  proration_billing_mode_on_downgrade?:
+    | 'prorated_immediately'
+    | 'full_immediately'
+    | 'difference_immediately'
+    | 'do_not_bill'
+    | null;
+
+  /**
+   * Default proration billing mode for subscription plan upgrades (NULL = inherit
+   * from business)
+   */
+  proration_billing_mode_on_upgrade?:
+    | 'prorated_immediately'
+    | 'full_immediately'
+    | 'difference_immediately'
+    | 'do_not_bill'
+    | null;
 }
 
 export interface ProductCollectionUpdateParams {
@@ -216,6 +308,18 @@ export interface ProductCollectionUpdateParams {
    */
   description?: string | null;
 
+  /**
+   * Effective_at setting for downgrades: Some(Some(val)) = set, Some(None) = clear
+   * (inherit), None = no change
+   */
+  effective_at_on_downgrade?: 'immediately' | 'next_billing_date' | null;
+
+  /**
+   * Effective_at setting for upgrades: Some(Some(val)) = set, Some(None) = clear
+   * (inherit), None = no change
+   */
+  effective_at_on_upgrade?: 'immediately' | 'next_billing_date' | null;
+
   /**
    * Optional new order for groups (array of group UUIDs in desired order)
    */
@@ -230,18 +334,34 @@ export interface ProductCollectionUpdateParams {
    * Optional new name for the collection
    */
   name?: string | null;
-}
 
-export interface ProductCollectionListParams extends DefaultPageNumberPaginationParams {
   /**
-   * List archived collections
+   * On payment failure behavior: Some(Some(val)) = set, Some(None) = clear
+   * (inherit), None = no change
    */
-  archived?: boolean;
+  on_payment_failure?: 'prevent_change' | 'apply_change' | null;
 
   /**
-   * Filter by Brand id
+   * Proration billing mode for downgrades: Some(Some(val)) = set, Some(None) = clear
+   * (inherit), None = no change
    */
-  brand_id?: string;
+  proration_billing_mode_on_downgrade?:
+    | 'prorated_immediately'
+    | 'full_immediately'
+    | 'difference_immediately'
+    | 'do_not_bill'
+    | null;
+
+  /**
+   * Proration billing mode for upgrades: Some(Some(val)) = set, Some(None) = clear
+   * (inherit), None = no change
+   */
+  proration_billing_mode_on_upgrade?:
+    | 'prorated_immediately'
+    | 'full_immediately'
+    | 'difference_immediately'
+    | 'do_not_bill'
+    | null;
 }
 
 export interface ProductCollectionUpdateImagesParams {
@@ -260,9 +380,9 @@ export declare namespace ProductCollections {
     type ProductCollectionUnarchiveResponse as ProductCollectionUnarchiveResponse,
     type ProductCollectionUpdateImagesResponse as ProductCollectionUpdateImagesResponse,
     type ProductCollectionListResponsesDefaultPageNumberPagination as ProductCollectionListResponsesDefaultPageNumberPagination,
+    type ProductCollectionListParams as ProductCollectionListParams,
     type ProductCollectionCreateParams as ProductCollectionCreateParams,
     type ProductCollectionUpdateParams as ProductCollectionUpdateParams,
-    type ProductCollectionListParams as ProductCollectionListParams,
     type ProductCollectionUpdateImagesParams as ProductCollectionUpdateImagesParams,
   };
 
@@ -272,7 +392,7 @@ export declare namespace ProductCollections {
     type ProductCollectionGroupDetails as ProductCollectionGroupDetails,
     type ProductCollectionGroupResponse as ProductCollectionGroupResponse,
     type GroupCreateParams as GroupCreateParams,
-    type GroupUpdateParams as GroupUpdateParams,
     type GroupDeleteParams as GroupDeleteParams,
+    type GroupUpdateParams as GroupUpdateParams,
   };
 }

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,
   };
 }