dodopayments 2.45.1 → 2.47.0

package/src/resources/brands.ts

@@ -12,8 +12,11 @@ export class Brands extends APIResource {
    * const brands = await client.brands.list();
    * ```
    */
-  list(options?: RequestOptions): APIPromise<BrandListResponse> {
-    return this._client.get('/brands', options);
+  list(
+    query: BrandListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<BrandListResponse> {
+    return this._client.get('/brands', { query, ...options });
   }
 
   /**
@@ -63,6 +66,21 @@ export class Brands extends APIResource {
   updateImages(id: string, options?: RequestOptions): APIPromise<BrandUpdateImagesResponse> {
     return this._client.put(path`/brands/${id}/images`, options);
   }
+
+  /**
+   * Archive a brand. Its products, live subscriptions, and product collections move
+   * to the `move_products_to` brand. Archive is permanent.
+   *
+   * @example
+   * ```ts
+   * const response = await client.brands.archive(
+   *   'brnd_8dFiAW42v28JzhlVSocjq',
+   * );
+   * ```
+   */
+  archive(id: string, body: BrandArchiveParams, options?: RequestOptions): APIPromise<BrandArchiveResponse> {
+    return this._client.post(path`/brands/${id}/archive`, { body, ...options });
+  }
 }
 
 export interface Brand {
@@ -78,6 +96,11 @@ export interface Brand {
 
   verification_status: 'Success' | 'Fail' | 'Review' | 'Hold';
 
+  /**
+   * Time the brand was archived. Null for an active brand.
+   */
+  archived_at?: string | null;
+
   description?: string | null;
 
   image?: string | null;
@@ -101,6 +124,38 @@ export interface BrandListResponse {
   items: Array<Brand>;
 }
 
+export interface BrandArchiveResponse {
+  /**
+   * Time the brand was archived.
+   */
+  archived_at: string;
+
+  /**
+   * The archived brand.
+   */
+  brand_id: string;
+
+  /**
+   * Count of product collections moved to the target brand.
+   */
+  collections_moved: number;
+
+  /**
+   * Count of products moved to the target brand.
+   */
+  products_moved: number;
+
+  /**
+   * Count of live subscriptions moved to the target brand.
+   */
+  subscriptions_moved: number;
+
+  /**
+   * Brand that received the moved records. Null when no target was given.
+   */
+  moved_to_brand_id?: string | null;
+}
+
 export interface BrandUpdateImagesResponse {
   /**
    * UUID that will be used as the image identifier/key suffix
@@ -113,6 +168,13 @@ export interface BrandUpdateImagesResponse {
   url: string;
 }
 
+export interface BrandListParams {
+  /**
+   * Set to true to also list archived brands. Default false.
+   */
+  include_archived?: boolean;
+}
+
 export interface BrandCreateParams {
   description?: string | null;
 
@@ -142,12 +204,25 @@ export interface BrandUpdateParams {
   url?: string | null;
 }
 
+export interface BrandArchiveParams {
+  /**
+   * Brand that takes over the products and the live subscriptions of the brand you
+   * archive. It must be a brand of the same business, and it must not be archived.
+   * The primary brand (its brand id is the business id) is a valid target. Omit this
+   * field only when the brand holds no products and no live subscriptions.
+   */
+  move_products_to?: string | null;
+}
+
 export declare namespace Brands {
   export {
     type Brand as Brand,
     type BrandListResponse as BrandListResponse,
+    type BrandArchiveResponse as BrandArchiveResponse,
     type BrandUpdateImagesResponse as BrandUpdateImagesResponse,
+    type BrandListParams as BrandListParams,
     type BrandCreateParams as BrandCreateParams,
     type BrandUpdateParams as BrandUpdateParams,
+    type BrandArchiveParams as BrandArchiveParams,
   };
 }

package/src/resources/checkout-sessions.ts

@@ -199,6 +199,15 @@ export interface CheckoutSessionFlags {
    * Default is false
    */
   require_phone_number?: boolean;
+
+  /**
+   * If true, the session uses the single-page checkout flow: the page initializes
+   * the payment at load time and confirms it in place, with no separate payment
+   * page.
+   *
+   * Default is false
+   */
+  single_page?: boolean;
 }
 
 export interface CheckoutSessionRequest {

package/src/resources/index.ts

@@ -19,9 +19,12 @@ export {
   Brands,
   type Brand,
   type BrandListResponse,
+  type BrandArchiveResponse,
   type BrandUpdateImagesResponse,
+  type BrandListParams,
   type BrandCreateParams,
   type BrandUpdateParams,
+  type BrandArchiveParams,
 } from './brands';
 export {
   CheckoutSessions,
@@ -298,8 +301,10 @@ export {
   type SubscriptionExpiredWebhookEvent,
   type SubscriptionFailedWebhookEvent,
   type SubscriptionOnHoldWebhookEvent,
+  type SubscriptionPausedWebhookEvent,
   type SubscriptionPlanChangedWebhookEvent,
   type SubscriptionRenewedWebhookEvent,
+  type SubscriptionUnpausedWebhookEvent,
   type SubscriptionUpdatePaymentMethodWebhookEvent,
   type SubscriptionUpdatedWebhookEvent,
   type UnsafeUnwrapWebhookEvent,

package/src/resources/subscriptions.ts

@@ -663,6 +663,12 @@ export interface Subscription {
    */
   expires_at?: string | null;
 
+  /**
+   * Timestamp when the subscription was paused, if it currently is (or is `OnHold`
+   * due to an unresolved pause settlement). `null` otherwise.
+   */
+  paused_at?: string | null;
+
   /**
    * Saved payment method id used for recurring charges
    */
@@ -686,7 +692,14 @@ export interface Subscription {
   trial_amount?: number | null;
 }
 
-export type SubscriptionStatus = 'pending' | 'active' | 'on_hold' | 'cancelled' | 'failed' | 'expired';
+export type SubscriptionStatus =
+  | 'pending'
+  | 'active'
+  | 'on_hold'
+  | 'paused'
+  | 'cancelled'
+  | 'failed'
+  | 'expired';
 
 /**
  * Unit of a duration count (e.g. license-key validity period).
@@ -974,6 +987,12 @@ export interface SubscriptionListResponse {
    */
   discount_id?: string | null;
 
+  /**
+   * Timestamp when the subscription was paused, if it currently is (or is `OnHold`
+   * due to an unresolved pause settlement). `null` otherwise.
+   */
+  paused_at?: string | null;
+
   /**
    * Saved payment method id used for recurring charges
    */
@@ -1320,7 +1339,7 @@ export interface SubscriptionListParams extends DefaultPageNumberPaginationParam
   /**
    * Filter by status
    */
-  status?: 'pending' | 'active' | 'on_hold' | 'cancelled' | 'failed' | 'expired';
+  status?: 'pending' | 'active' | 'on_hold' | 'paused' | 'cancelled' | 'failed' | 'expired';
 }
 
 export interface SubscriptionCreateParams {
@@ -1515,6 +1534,12 @@ export interface SubscriptionUpdateParams {
 
   next_billing_date?: string | null;
 
+  /**
+   * `Some(true)` pauses an active subscription; `Some(false)` unpauses a `Paused`
+   * (or abandoned `OnHold`) subscription. Exclusive of every other field.
+   */
+  pause?: boolean | null;
+
   status?: SubscriptionStatus | null;
 
   /**

package/src/resources/webhook-events.ts

@@ -33,6 +33,7 @@ export type WebhookEventType =
   | 'subscription.renewed'
   | 'subscription.on_hold'
   | 'subscription.paused'
+  | 'subscription.unpaused'
   | 'subscription.cancelled'
   | 'subscription.failed'
   | 'subscription.expired'

package/src/resources/webhooks/index.ts

@@ -46,8 +46,10 @@ export {
   type SubscriptionExpiredWebhookEvent,
   type SubscriptionFailedWebhookEvent,
   type SubscriptionOnHoldWebhookEvent,
+  type SubscriptionPausedWebhookEvent,
   type SubscriptionPlanChangedWebhookEvent,
   type SubscriptionRenewedWebhookEvent,
+  type SubscriptionUnpausedWebhookEvent,
   type SubscriptionUpdatePaymentMethodWebhookEvent,
   type SubscriptionUpdatedWebhookEvent,
   type UnsafeUnwrapWebhookEvent,

package/src/resources/webhooks/webhooks.ts

@@ -1573,6 +1573,28 @@ export interface SubscriptionOnHoldWebhookEvent {
   type: 'subscription.on_hold';
 }
 
+export interface SubscriptionPausedWebhookEvent {
+  /**
+   * The business identifier
+   */
+  business_id: string;
+
+  /**
+   * Response struct representing subscription details
+   */
+  data: SubscriptionsAPI.Subscription;
+
+  /**
+   * The timestamp of when the event occurred
+   */
+  timestamp: string;
+
+  /**
+   * The event type
+   */
+  type: 'subscription.paused';
+}
+
 export interface SubscriptionPlanChangedWebhookEvent {
   /**
    * The business identifier
@@ -1617,6 +1639,28 @@ export interface SubscriptionRenewedWebhookEvent {
   type: 'subscription.renewed';
 }
 
+export interface SubscriptionUnpausedWebhookEvent {
+  /**
+   * The business identifier
+   */
+  business_id: string;
+
+  /**
+   * Response struct representing subscription details
+   */
+  data: SubscriptionsAPI.Subscription;
+
+  /**
+   * The timestamp of when the event occurred
+   */
+  timestamp: string;
+
+  /**
+   * The event type
+   */
+  type: 'subscription.unpaused';
+}
+
 export interface SubscriptionUpdatePaymentMethodWebhookEvent {
   /**
    * The business identifier
@@ -3048,6 +3092,28 @@ export interface SubscriptionOnHoldWebhookEvent {
   type: 'subscription.on_hold';
 }
 
+export interface SubscriptionPausedWebhookEvent {
+  /**
+   * The business identifier
+   */
+  business_id: string;
+
+  /**
+   * Response struct representing subscription details
+   */
+  data: SubscriptionsAPI.Subscription;
+
+  /**
+   * The timestamp of when the event occurred
+   */
+  timestamp: string;
+
+  /**
+   * The event type
+   */
+  type: 'subscription.paused';
+}
+
 export interface SubscriptionPlanChangedWebhookEvent {
   /**
    * The business identifier
@@ -3092,6 +3158,28 @@ export interface SubscriptionRenewedWebhookEvent {
   type: 'subscription.renewed';
 }
 
+export interface SubscriptionUnpausedWebhookEvent {
+  /**
+   * The business identifier
+   */
+  business_id: string;
+
+  /**
+   * Response struct representing subscription details
+   */
+  data: SubscriptionsAPI.Subscription;
+
+  /**
+   * The timestamp of when the event occurred
+   */
+  timestamp: string;
+
+  /**
+   * The event type
+   */
+  type: 'subscription.unpaused';
+}
+
 export interface SubscriptionUpdatePaymentMethodWebhookEvent {
   /**
    * The business identifier
@@ -3178,8 +3266,10 @@ export type UnsafeUnwrapWebhookEvent =
   | SubscriptionExpiredWebhookEvent
   | SubscriptionFailedWebhookEvent
   | SubscriptionOnHoldWebhookEvent
+  | SubscriptionPausedWebhookEvent
   | SubscriptionPlanChangedWebhookEvent
   | SubscriptionRenewedWebhookEvent
+  | SubscriptionUnpausedWebhookEvent
   | SubscriptionUpdatePaymentMethodWebhookEvent
   | SubscriptionUpdatedWebhookEvent;
 
@@ -3225,8 +3315,10 @@ export type UnwrapWebhookEvent =
   | SubscriptionExpiredWebhookEvent
   | SubscriptionFailedWebhookEvent
   | SubscriptionOnHoldWebhookEvent
+  | SubscriptionPausedWebhookEvent
   | SubscriptionPlanChangedWebhookEvent
   | SubscriptionRenewedWebhookEvent
+  | SubscriptionUnpausedWebhookEvent
   | SubscriptionUpdatePaymentMethodWebhookEvent
   | SubscriptionUpdatedWebhookEvent;
 
@@ -3353,8 +3445,10 @@ export declare namespace Webhooks {
     type SubscriptionExpiredWebhookEvent as SubscriptionExpiredWebhookEvent,
     type SubscriptionFailedWebhookEvent as SubscriptionFailedWebhookEvent,
     type SubscriptionOnHoldWebhookEvent as SubscriptionOnHoldWebhookEvent,
+    type SubscriptionPausedWebhookEvent as SubscriptionPausedWebhookEvent,
     type SubscriptionPlanChangedWebhookEvent as SubscriptionPlanChangedWebhookEvent,
     type SubscriptionRenewedWebhookEvent as SubscriptionRenewedWebhookEvent,
+    type SubscriptionUnpausedWebhookEvent as SubscriptionUnpausedWebhookEvent,
     type SubscriptionUpdatePaymentMethodWebhookEvent as SubscriptionUpdatePaymentMethodWebhookEvent,
     type SubscriptionUpdatedWebhookEvent as SubscriptionUpdatedWebhookEvent,
     type UnsafeUnwrapWebhookEvent as UnsafeUnwrapWebhookEvent,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.45.1'; // x-release-please-version
+export const VERSION = '2.47.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.45.1";
+export declare const VERSION = "2.47.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.45.1";
+export declare const VERSION = "2.47.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '2.45.1'; // x-release-please-version
+exports.VERSION = '2.47.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '2.45.1'; // x-release-please-version
+export const VERSION = '2.47.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map