dodopayments 2.32.1 → 2.33.0

package/src/resources/license-key-instances.ts

@@ -11,6 +11,26 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class LicenseKeyInstances extends APIResource {
+  /**
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const licenseKeyInstance of client.licenseKeyInstances.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: LicenseKeyInstanceListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<LicenseKeyInstancesDefaultPageNumberPagination, LicenseKeyInstance> {
+    return this._client.getAPIList(
+      '/license_key_instances',
+      DefaultPageNumberPagination<LicenseKeyInstance>,
+      { query, ...options },
+    );
+  }
+
   /**
    * @example
    * ```ts
@@ -38,26 +58,6 @@ export class LicenseKeyInstances extends APIResource {
   ): APIPromise<LicenseKeyInstance> {
     return this._client.patch(path`/license_key_instances/${id}`, { body, ...options });
   }
-
-  /**
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const licenseKeyInstance of client.licenseKeyInstances.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: LicenseKeyInstanceListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<LicenseKeyInstancesDefaultPageNumberPagination, LicenseKeyInstance> {
-    return this._client.getAPIList(
-      '/license_key_instances',
-      DefaultPageNumberPagination<LicenseKeyInstance>,
-      { query, ...options },
-    );
-  }
 }
 
 export type LicenseKeyInstancesDefaultPageNumberPagination = DefaultPageNumberPagination<LicenseKeyInstance>;
@@ -74,10 +74,6 @@ export interface LicenseKeyInstance {
   name: string;
 }
 
-export interface LicenseKeyInstanceUpdateParams {
-  name: string;
-}
-
 export interface LicenseKeyInstanceListParams extends DefaultPageNumberPaginationParams {
   /**
    * Filter instances by entitlement grant ID
@@ -90,11 +86,15 @@ export interface LicenseKeyInstanceListParams extends DefaultPageNumberPaginatio
   license_key_id?: string | null;
 }
 
+export interface LicenseKeyInstanceUpdateParams {
+  name: string;
+}
+
 export declare namespace LicenseKeyInstances {
   export {
     type LicenseKeyInstance as LicenseKeyInstance,
     type LicenseKeyInstancesDefaultPageNumberPagination as LicenseKeyInstancesDefaultPageNumberPagination,
-    type LicenseKeyInstanceUpdateParams as LicenseKeyInstanceUpdateParams,
     type LicenseKeyInstanceListParams as LicenseKeyInstanceListParams,
+    type LicenseKeyInstanceUpdateParams as LicenseKeyInstanceUpdateParams,
   };
 }

package/src/resources/license-keys.ts

@@ -12,17 +12,16 @@ import { path } from '../internal/utils/path';
 
 export class LicenseKeys extends APIResource {
   /**
-   * @example
-   * ```ts
-   * const licenseKey = await client.licenseKeys.create({
-   *   customer_id: 'customer_id',
-   *   key: 'key',
-   *   product_id: 'product_id',
-   * });
-   * ```
+   * @deprecated
    */
-  create(body: LicenseKeyCreateParams, options?: RequestOptions): APIPromise<LicenseKey> {
-    return this._client.post('/license_keys', { body, ...options });
+  list(
+    query: LicenseKeyListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<LicenseKeysDefaultPageNumberPagination, LicenseKey> {
+    return this._client.getAPIList('/license_keys', DefaultPageNumberPagination<LicenseKey>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -40,16 +39,17 @@ export class LicenseKeys extends APIResource {
   }
 
   /**
-   * @deprecated
+   * @example
+   * ```ts
+   * const licenseKey = await client.licenseKeys.create({
+   *   customer_id: 'customer_id',
+   *   key: 'key',
+   *   product_id: 'product_id',
+   * });
+   * ```
    */
-  list(
-    query: LicenseKeyListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<LicenseKeysDefaultPageNumberPagination, LicenseKey> {
-    return this._client.getAPIList('/license_keys', DefaultPageNumberPagination<LicenseKey>, {
-      query,
-      ...options,
-    });
+  create(body: LicenseKeyCreateParams, options?: RequestOptions): APIPromise<LicenseKey> {
+    return this._client.post('/license_keys', { body, ...options });
   }
 }
 
@@ -126,31 +126,36 @@ export interface LicenseKey {
 
 export type LicenseKeyStatus = 'active' | 'expired' | 'disabled';
 
-export interface LicenseKeyCreateParams {
+export interface LicenseKeyListParams extends DefaultPageNumberPaginationParams {
   /**
-   * The customer this license key belongs to.
+   * Filter license keys created on or after this timestamp
    */
-  customer_id: string;
+  created_at_gte?: string;
 
   /**
-   * The license key string to import.
+   * Filter license keys created on or before this timestamp
    */
-  key: string;
+  created_at_lte?: string;
 
   /**
-   * The product this license key is for.
+   * Filter by customer ID
    */
-  product_id: string;
+  customer_id?: string;
 
   /**
-   * Maximum number of activations allowed. Null means unlimited.
+   * Filter by product ID
    */
-  activations_limit?: number | null;
+  product_id?: string;
 
   /**
-   * Expiration timestamp. Null means the key never expires.
+   * Filter by license key source
    */
-  expires_at?: string | null;
+  source?: 'auto' | 'import';
+
+  /**
+   * Filter by license key status
+   */
+  status?: 'active' | 'expired' | 'disabled';
 }
 
 export interface LicenseKeyUpdateParams {
@@ -173,36 +178,31 @@ export interface LicenseKeyUpdateParams {
   expires_at?: string | null;
 }
 
-export interface LicenseKeyListParams extends DefaultPageNumberPaginationParams {
-  /**
-   * Filter license keys created on or after this timestamp
-   */
-  created_at_gte?: string;
-
+export interface LicenseKeyCreateParams {
   /**
-   * Filter license keys created on or before this timestamp
+   * The customer this license key belongs to.
    */
-  created_at_lte?: string;
+  customer_id: string;
 
   /**
-   * Filter by customer ID
+   * The license key string to import.
    */
-  customer_id?: string;
+  key: string;
 
   /**
-   * Filter by product ID
+   * The product this license key is for.
    */
-  product_id?: string;
+  product_id: string;
 
   /**
-   * Filter by license key source
+   * Maximum number of activations allowed. Null means unlimited.
    */
-  source?: 'auto' | 'import';
+  activations_limit?: number | null;
 
   /**
-   * Filter by license key status
+   * Expiration timestamp. Null means the key never expires.
    */
-  status?: 'active' | 'expired' | 'disabled';
+  expires_at?: string | null;
 }
 
 export declare namespace LicenseKeys {
@@ -210,8 +210,8 @@ export declare namespace LicenseKeys {
     type LicenseKey as LicenseKey,
     type LicenseKeyStatus as LicenseKeyStatus,
     type LicenseKeysDefaultPageNumberPagination as LicenseKeysDefaultPageNumberPagination,
-    type LicenseKeyCreateParams as LicenseKeyCreateParams,
-    type LicenseKeyUpdateParams as LicenseKeyUpdateParams,
     type LicenseKeyListParams as LicenseKeyListParams,
+    type LicenseKeyUpdateParams as LicenseKeyUpdateParams,
+    type LicenseKeyCreateParams as LicenseKeyCreateParams,
   };
 }

package/src/resources/meters.ts

@@ -13,6 +13,13 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class Meters extends APIResource {
+  list(
+    query: MeterListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<MetersDefaultPageNumberPagination, Meter> {
+    return this._client.getAPIList('/meters', DefaultPageNumberPagination<Meter>, { query, ...options });
+  }
+
   create(body: MeterCreateParams, options?: RequestOptions): APIPromise<Meter> {
     return this._client.post('/meters', { body, ...options });
   }
@@ -21,13 +28,6 @@ export class Meters extends APIResource {
     return this._client.get(path`/meters/${id}`, options);
   }
 
-  list(
-    query: MeterListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<MetersDefaultPageNumberPagination, Meter> {
-    return this._client.getAPIList('/meters', DefaultPageNumberPagination<Meter>, { query, ...options });
-  }
-
   archive(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/meters/${id}`, {
       ...options,
@@ -146,6 +146,13 @@ export interface MeterFilter {
   conjunction: Conjunction;
 }
 
+export interface MeterListParams extends DefaultPageNumberPaginationParams {
+  /**
+   * List archived meters
+   */
+  archived?: boolean;
+}
+
 export interface MeterCreateParams {
   /**
    * Aggregation configuration for the meter
@@ -178,13 +185,6 @@ export interface MeterCreateParams {
   filter?: MeterFilter | null;
 }
 
-export interface MeterListParams extends DefaultPageNumberPaginationParams {
-  /**
-   * List archived meters
-   */
-  archived?: boolean;
-}
-
 export declare namespace Meters {
   export {
     type Conjunction as Conjunction,
@@ -194,7 +194,7 @@ export declare namespace Meters {
     type MeterAggregation as MeterAggregation,
     type MeterFilter as MeterFilter,
     type MetersDefaultPageNumberPagination as MetersDefaultPageNumberPagination,
-    type MeterCreateParams as MeterCreateParams,
     type MeterListParams as MeterListParams,
+    type MeterCreateParams as MeterCreateParams,
   };
 }

package/src/resources/payments.ts

@@ -15,6 +15,16 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class Payments extends APIResource {
+  list(
+    query: PaymentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PaymentListResponsesDefaultPageNumberPagination, PaymentListResponse> {
+    return this._client.getAPIList('/payments', DefaultPageNumberPagination<PaymentListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * @deprecated
    */
@@ -26,16 +36,6 @@ export class Payments extends APIResource {
     return this._client.get(path`/payments/${paymentID}`, options);
   }
 
-  list(
-    query: PaymentListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<PaymentListResponsesDefaultPageNumberPagination, PaymentListResponse> {
-    return this._client.getAPIList('/payments', DefaultPageNumberPagination<PaymentListResponse>, {
-      query,
-      ...options,
-    });
-  }
-
   retrieveLineItems(
     paymentID: string,
     options?: RequestOptions,
@@ -237,6 +237,13 @@ export interface Payment {
    */
   refunds: Array<RefundListItem>;
 
+  /**
+   * Retry attempt number for subscription renewal payments. `0` for the original
+   * payment, `1`+ for each scheduled off-session retry after a failed renewal.
+   * Always `0` for non-subscription payments.
+   */
+  retry_attempt: number;
+
   /**
    * The amount that will be credited to your Dodo balance after currency conversion
    * and processing. Especially relevant for adaptive pricing where the customer's
@@ -670,6 +677,54 @@ export namespace PaymentRetrieveLineItemsResponse {
   }
 }
 
+export interface PaymentListParams 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?:
+    | 'succeeded'
+    | 'failed'
+    | 'cancelled'
+    | 'processing'
+    | 'requires_customer_action'
+    | 'requires_merchant_action'
+    | 'requires_payment_method'
+    | 'requires_confirmation'
+    | 'requires_capture'
+    | 'partially_captured'
+    | 'partially_captured_and_capturable';
+
+  /**
+   * Filter by subscription id
+   */
+  subscription_id?: string;
+}
+
 export interface PaymentCreateParams {
   /**
    * Billing address details for the payment
@@ -785,54 +840,6 @@ export interface PaymentCreateParams {
   tax_id?: string | null;
 }
 
-export interface PaymentListParams 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?:
-    | 'succeeded'
-    | 'failed'
-    | 'cancelled'
-    | 'processing'
-    | 'requires_customer_action'
-    | 'requires_merchant_action'
-    | 'requires_payment_method'
-    | 'requires_confirmation'
-    | 'requires_capture'
-    | 'partially_captured'
-    | 'partially_captured_and_capturable';
-
-  /**
-   * Filter by subscription id
-   */
-  subscription_id?: string;
-}
-
 export declare namespace Payments {
   export {
     type AttachExistingCustomer as AttachExistingCustomer,
@@ -852,7 +859,7 @@ export declare namespace Payments {
     type PaymentListResponse as PaymentListResponse,
     type PaymentRetrieveLineItemsResponse as PaymentRetrieveLineItemsResponse,
     type PaymentListResponsesDefaultPageNumberPagination as PaymentListResponsesDefaultPageNumberPagination,
-    type PaymentCreateParams as PaymentCreateParams,
     type PaymentListParams as PaymentListParams,
+    type PaymentCreateParams as PaymentCreateParams,
   };
 }

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

@@ -26,18 +26,18 @@ export class Groups extends APIResource {
     return this._client.post(path`/product-collections/${id}/groups`, { body, ...options });
   }
 
-  update(groupID: string, params: GroupUpdateParams, options?: RequestOptions): APIPromise<void> {
-    const { id, ...body } = params;
-    return this._client.patch(path`/product-collections/${id}/groups/${groupID}`, {
-      body,
+  delete(groupID: string, params: GroupDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { id } = params;
+    return this._client.delete(path`/product-collections/${id}/groups/${groupID}`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
-  delete(groupID: string, params: GroupDeleteParams, options?: RequestOptions): APIPromise<void> {
-    const { id } = params;
-    return this._client.delete(path`/product-collections/${id}/groups/${groupID}`, {
+  update(groupID: string, params: GroupUpdateParams, options?: RequestOptions): APIPromise<void> {
+    const { id, ...body } = params;
+    return this._client.patch(path`/product-collections/${id}/groups/${groupID}`, {
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -102,6 +102,13 @@ export interface GroupCreateParams {
   status?: boolean | null;
 }
 
+export interface GroupDeleteParams {
+  /**
+   * Product Collection Id
+   */
+  id: string;
+}
+
 export interface GroupUpdateParams {
   /**
    * Path param: Product Collection Id
@@ -126,13 +133,6 @@ export interface GroupUpdateParams {
   status?: boolean | null;
 }
 
-export interface GroupDeleteParams {
-  /**
-   * Product Collection Id
-   */
-  id: string;
-}
-
 Groups.Items = Items;
 
 export declare namespace Groups {
@@ -141,8 +141,8 @@ export declare namespace Groups {
     type ProductCollectionGroupDetails as ProductCollectionGroupDetails,
     type ProductCollectionGroupResponse as ProductCollectionGroupResponse,
     type GroupCreateParams as GroupCreateParams,
-    type GroupUpdateParams as GroupUpdateParams,
     type GroupDeleteParams as GroupDeleteParams,
+    type GroupUpdateParams as GroupUpdateParams,
   };
 
   export {
@@ -150,7 +150,7 @@ export declare namespace Groups {
     type ProductCollectionProduct as ProductCollectionProduct,
     type ItemCreateResponse as ItemCreateResponse,
     type ItemCreateParams as ItemCreateParams,
-    type ItemUpdateParams as ItemUpdateParams,
     type ItemDeleteParams as ItemDeleteParams,
+    type ItemUpdateParams as ItemUpdateParams,
   };
 }

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

@@ -6,14 +6,14 @@ export {
   type ProductCollectionGroupDetails,
   type ProductCollectionGroupResponse,
   type GroupCreateParams,
-  type GroupUpdateParams,
   type GroupDeleteParams,
+  type GroupUpdateParams,
 } from './groups';
 export {
   Items,
   type ProductCollectionProduct,
   type ItemCreateResponse,
   type ItemCreateParams,
-  type ItemUpdateParams,
   type ItemDeleteParams,
+  type ItemUpdateParams,
 } from './items';

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

@@ -19,18 +19,18 @@ export class Items extends APIResource {
     return this._client.post(path`/product-collections/${id}/groups/${groupID}/items`, { body, ...options });
   }
 
-  update(itemID: string, params: ItemUpdateParams, options?: RequestOptions): APIPromise<void> {
-    const { id, group_id, ...body } = params;
-    return this._client.patch(path`/product-collections/${id}/groups/${group_id}/items/${itemID}`, {
-      body,
+  delete(itemID: string, params: ItemDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { id, group_id } = params;
+    return this._client.delete(path`/product-collections/${id}/groups/${group_id}/items/${itemID}`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
-  delete(itemID: string, params: ItemDeleteParams, options?: RequestOptions): APIPromise<void> {
-    const { id, group_id } = params;
-    return this._client.delete(path`/product-collections/${id}/groups/${group_id}/items/${itemID}`, {
+  update(itemID: string, params: ItemUpdateParams, options?: RequestOptions): APIPromise<void> {
+    const { id, group_id, ...body } = params;
+    return this._client.patch(path`/product-collections/${id}/groups/${group_id}/items/${itemID}`, {
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -95,33 +95,33 @@ export interface ItemCreateParams {
   products: Array<GroupsAPI.GroupProduct>;
 }
 
-export interface ItemUpdateParams {
+export interface ItemDeleteParams {
   /**
-   * Path param: Product Collection Id
+   * Product Collection Id
    */
   id: string;
 
   /**
-   * Path param: Product Collection Group Id
+   * Product Collection Group Id
    */
   group_id: string;
-
-  /**
-   * Body param: Status of the product in the group
-   */
-  status: boolean;
 }
 
-export interface ItemDeleteParams {
+export interface ItemUpdateParams {
   /**
-   * Product Collection Id
+   * Path param: Product Collection Id
    */
   id: string;
 
   /**
-   * Product Collection Group Id
+   * Path param: Product Collection Group Id
    */
   group_id: string;
+
+  /**
+   * Body param: Status of the product in the group
+   */
+  status: boolean;
 }
 
 export declare namespace Items {
@@ -129,7 +129,7 @@ export declare namespace Items {
     type ProductCollectionProduct as ProductCollectionProduct,
     type ItemCreateResponse as ItemCreateResponse,
     type ItemCreateParams as ItemCreateParams,
-    type ItemUpdateParams as ItemUpdateParams,
     type ItemDeleteParams as ItemDeleteParams,
+    type ItemUpdateParams as ItemUpdateParams,
   };
 }

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

@@ -6,8 +6,8 @@ export {
   type ProductCollectionGroupDetails,
   type ProductCollectionGroupResponse,
   type GroupCreateParams,
-  type GroupUpdateParams,
   type GroupDeleteParams,
+  type GroupUpdateParams,
 } from './groups/index';
 export {
   ProductCollections,
@@ -15,9 +15,9 @@ export {
   type ProductCollectionListResponse,
   type ProductCollectionUnarchiveResponse,
   type ProductCollectionUpdateImagesResponse,
+  type ProductCollectionListParams,
   type ProductCollectionCreateParams,
   type ProductCollectionUpdateParams,
-  type ProductCollectionListParams,
   type ProductCollectionUpdateImagesParams,
   type ProductCollectionListResponsesDefaultPageNumberPagination,
 } from './product-collections';