dodopayments 2.29.0 → 2.30.0

package/src/resources/payments.ts

@@ -171,6 +171,13 @@ export interface OneTimeProductCartItem {
   product_id: string;
 
   quantity: number;
+
+  /**
+   * Amount the customer pays if pay_what_you_want is enabled. If disabled then
+   * amount will be ignored Represented in the lowest denomination of the currency
+   * (e.g., cents for USD). For example, to charge $1.00, pass `100`.
+   */
+  amount?: number | null;
 }
 
 export interface Payment {
@@ -328,7 +335,7 @@ export interface Payment {
   /**
    * List of products purchased in a one-time payment
    */
-  product_cart?: Array<OneTimeProductCartItem> | null;
+  product_cart?: Array<Payment.ProductCart> | null;
 
   /**
    * Summary of the refund status for this payment. None if no succeeded refunds
@@ -364,6 +371,14 @@ export interface Payment {
   updated_at?: string | null;
 }
 
+export namespace Payment {
+  export interface ProductCart {
+    product_id: string;
+
+    quantity: number;
+  }
+}
+
 /**
  * All supported payment method types (from Hyperswitch).
  *
@@ -569,22 +584,7 @@ export interface PaymentCreateResponse {
   /**
    * Optional list of products included in the payment
    */
-  product_cart?: Array<PaymentCreateResponse.ProductCart> | null;
-}
-
-export namespace PaymentCreateResponse {
-  export interface ProductCart {
-    product_id: string;
-
-    quantity: number;
-
-    /**
-     * Amount the customer pays if pay_what_you_want is enabled. If disabled then
-     * amount will be ignored Represented in the lowest denomination of the currency
-     * (e.g., cents for USD). For example, to charge $1.00, pass `100`.
-     */
-    amount?: number | null;
-  }
+  product_cart?: Array<OneTimeProductCartItem> | null;
 }
 
 export interface PaymentListResponse {
@@ -672,7 +672,13 @@ export interface PaymentCreateParams {
   /**
    * List of products in the cart. Must contain at least 1 and at most 100 items.
    */
-  product_cart: Array<PaymentCreateParams.ProductCart>;
+  product_cart: Array<OneTimeProductCartItem>;
+
+  /**
+   * Whether adaptive currency fees should be included in the price (true) or added
+   * on top (false). If not specified, defaults to the business-level setting.
+   */
+  adaptive_currency_fees_inclusive?: boolean | null;
 
   /**
    * List of payment methods allowed during checkout.
@@ -724,6 +730,13 @@ export interface PaymentCreateParams {
    */
   redirect_immediately?: boolean;
 
+  /**
+   * If true, the customer's phone number is required to create this payment.
+   * Typically set alongside `payment_link=true` so merchants can enforce phone
+   * collection on the hosted payment page. Defaults to false.
+   */
+  require_phone_number?: boolean;
+
   /**
    * Optional URL to redirect the customer after payment. Must be a valid URL if
    * provided.
@@ -747,21 +760,6 @@ export interface PaymentCreateParams {
   tax_id?: string | null;
 }
 
-export namespace PaymentCreateParams {
-  export interface ProductCart {
-    product_id: string;
-
-    quantity: number;
-
-    /**
-     * Amount the customer pays if pay_what_you_want is enabled. If disabled then
-     * amount will be ignored Represented in the lowest denomination of the currency
-     * (e.g., cents for USD). For example, to charge $1.00, pass `100`.
-     */
-    amount?: number | null;
-  }
-}
-
 export interface PaymentListParams extends DefaultPageNumberPaginationParams {
   /**
    * filter by Brand id

package/src/resources/products/index.ts

@@ -5,6 +5,7 @@ export {
   Products,
   type AddMeterToPrice,
   type AttachCreditEntitlement,
+  type AttachProductEntitlement,
   type CbbProrationBehavior,
   type CreditEntitlementMappingResponse,
   type DigitalProductDelivery,
@@ -12,6 +13,7 @@ export {
   type LicenseKeyDuration,
   type Price,
   type Product,
+  type ProductEntitlementSummary,
   type ProductListResponse,
   type ProductUpdateFilesResponse,
   type ProductCreateParams,

package/src/resources/products/products.ts

@@ -5,6 +5,7 @@ import * as ProductsAPI from './products';
 import * as MiscAPI from '../misc';
 import * as SubscriptionsAPI from '../subscriptions';
 import * as CreditEntitlementsAPI from '../credit-entitlements/credit-entitlements';
+import * as EntitlementsAPI from '../entitlements/entitlements';
 import * as ImagesAPI from './images';
 import { ImageUpdateParams, ImageUpdateResponse, Images } from './images';
 import * as ShortLinksAPI from './short-links';
@@ -210,6 +211,20 @@ export interface AttachCreditEntitlement {
   trial_credits_expire_after_trial?: boolean | null;
 }
 
+/**
+ * Request struct for attaching an entitlement to a product.
+ *
+ * Mirrors the `credit_entitlements` attach shape — every "attach something to a
+ * product" array takes objects, not bare IDs. Uniform shape leaves room for
+ * per-attachment settings later without another API break.
+ */
+export interface AttachProductEntitlement {
+  /**
+   * ID of the entitlement to attach to the product
+   */
+  entitlement_id: string;
+}
+
 export type CbbProrationBehavior = 'prorate' | 'no_prorate';
 
 /**
@@ -317,29 +332,35 @@ export interface CreditEntitlementMappingResponse {
   trial_credits?: string | null;
 }
 
+/**
+ * Digital-product-delivery payload for a grant. Populated for grants whose
+ * entitlement has `integration_type = 'digital_files'`. `files` carries presigned
+ * download URLs; the source (EE service or legacy in-process S3 presigning) is
+ * opaque to the caller.
+ */
 export interface DigitalProductDelivery {
-  /**
-   * External URL to digital product
-   */
-  external_url?: string | null;
+  files: Array<DigitalProductDeliveryFile>;
 
-  /**
-   * Uploaded files ids of digital product
-   */
-  files?: Array<DigitalProductDeliveryFile> | null;
+  external_url?: string | null;
 
-  /**
-   * Instructions to download and use the digital product
-   */
   instructions?: string | null;
 }
 
 export interface DigitalProductDeliveryFile {
+  download_url: string;
+
+  /**
+   * Seconds until `download_url` expires.
+   */
+  expires_in: number;
+
   file_id: string;
 
-  file_name: string;
+  filename: string;
 
-  url: string;
+  content_type?: string | null;
+
+  file_size?: number | null;
 }
 
 export interface LicenseKeyDuration {
@@ -545,7 +566,7 @@ export interface Product {
   /**
    * Attached entitlements (integration-based access grants)
    */
-  entitlements: Array<Product.Entitlement>;
+  entitlements: Array<ProductEntitlementSummary>;
 
   /**
    * Indicates if the product is recurring (e.g., subscriptions).
@@ -592,6 +613,12 @@ export interface Product {
    */
   description?: string | null;
 
+  /**
+   * Digital-product-delivery payload for a grant. Populated for grants whose
+   * entitlement has `integration_type = 'digital_files'`. `files` carries presigned
+   * download URLs; the source (EE service or legacy in-process S3 presigning) is
+   * opaque to the caller.
+   */
   digital_product_delivery?: DigitalProductDelivery | null;
 
   /**
@@ -625,92 +652,30 @@ export interface Product {
   product_collection_id?: string | null;
 }
 
-export namespace Product {
+/**
+ * Summary of an entitlement attached to a product.
+ *
+ * `integration_config` uses [`IntegrationConfigResponse`] (NOT the persisted
+ * [`IntegrationConfig`]) so digital_files entitlements embed the resolved
+ * `digital_files` object — matching what `GET /entitlements/{id}` returns. All
+ * other variants pass through unchanged via `#[serde(untagged)]`.
+ */
+export interface ProductEntitlementSummary {
+  id: string;
+
   /**
-   * Summary of an entitlement attached to a product
+   * Public-facing variant of [`IntegrationConfig`]. Mirrors every variant shape on
+   * the wire EXCEPT `DigitalFiles`, which is replaced with a hydrated
+   * `digital_files` object (resolved download URLs etc.). The persisted JSONB stays
+   * ID-only via [`IntegrationConfig`]; this enum is response-only.
    */
-  export interface Entitlement {
-    id: string;
-
-    /**
-     * Platform-specific configuration for an entitlement. Each variant uses unique
-     * field names so `#[serde(untagged)]` can disambiguate correctly.
-     */
-    integration_config:
-      | Entitlement.GitHubConfig
-      | Entitlement.DiscordConfig
-      | Entitlement.TelegramConfig
-      | Entitlement.FigmaConfig
-      | Entitlement.FramerConfig
-      | Entitlement.NotionConfig
-      | Entitlement.DigitalFilesConfig
-      | Entitlement.LicenseKeyConfig;
-
-    integration_type:
-      | 'discord'
-      | 'telegram'
-      | 'github'
-      | 'figma'
-      | 'framer'
-      | 'notion'
-      | 'digital_files'
-      | 'license_key';
-
-    name: string;
-
-    description?: string | null;
-  }
-
-  export namespace Entitlement {
-    export interface GitHubConfig {
-      /**
-       * One of: pull, push, admin, maintain, triage
-       */
-      permission: string;
-
-      target_id: string;
-    }
-
-    export interface DiscordConfig {
-      guild_id: string;
-
-      role_id?: string | null;
-    }
-
-    export interface TelegramConfig {
-      chat_id: string;
-    }
-
-    export interface FigmaConfig {
-      figma_file_id: string;
-    }
-
-    export interface FramerConfig {
-      framer_template_id: string;
-    }
-
-    export interface NotionConfig {
-      notion_template_id: string;
-    }
-
-    export interface DigitalFilesConfig {
-      digital_file_ids: Array<string>;
+  integration_config: EntitlementsAPI.IntegrationConfigResponse;
 
-      external_url?: string | null;
+  integration_type: EntitlementsAPI.EntitlementIntegrationType;
 
-      instructions?: string | null;
-    }
-
-    export interface LicenseKeyConfig {
-      activation_message?: string | null;
-
-      activations_limit?: number | null;
-
-      duration_count?: number | null;
+  name: string;
 
-      duration_interval?: string | null;
-    }
-  }
+  description?: string | null;
 }
 
 export interface ProductListResponse {
@@ -727,7 +692,7 @@ export interface ProductListResponse {
   /**
    * Entitlements linked to this product
    */
-  entitlements: Array<ProductListResponse.Entitlement>;
+  entitlements: Array<ProductEntitlementSummary>;
 
   /**
    * Indicates if the product is recurring (e.g., subscriptions).
@@ -799,94 +764,6 @@ export interface ProductListResponse {
   tax_inclusive?: boolean | null;
 }
 
-export namespace ProductListResponse {
-  /**
-   * Summary of an entitlement attached to a product
-   */
-  export interface Entitlement {
-    id: string;
-
-    /**
-     * Platform-specific configuration for an entitlement. Each variant uses unique
-     * field names so `#[serde(untagged)]` can disambiguate correctly.
-     */
-    integration_config:
-      | Entitlement.GitHubConfig
-      | Entitlement.DiscordConfig
-      | Entitlement.TelegramConfig
-      | Entitlement.FigmaConfig
-      | Entitlement.FramerConfig
-      | Entitlement.NotionConfig
-      | Entitlement.DigitalFilesConfig
-      | Entitlement.LicenseKeyConfig;
-
-    integration_type:
-      | 'discord'
-      | 'telegram'
-      | 'github'
-      | 'figma'
-      | 'framer'
-      | 'notion'
-      | 'digital_files'
-      | 'license_key';
-
-    name: string;
-
-    description?: string | null;
-  }
-
-  export namespace Entitlement {
-    export interface GitHubConfig {
-      /**
-       * One of: pull, push, admin, maintain, triage
-       */
-      permission: string;
-
-      target_id: string;
-    }
-
-    export interface DiscordConfig {
-      guild_id: string;
-
-      role_id?: string | null;
-    }
-
-    export interface TelegramConfig {
-      chat_id: string;
-    }
-
-    export interface FigmaConfig {
-      figma_file_id: string;
-    }
-
-    export interface FramerConfig {
-      framer_template_id: string;
-    }
-
-    export interface NotionConfig {
-      notion_template_id: string;
-    }
-
-    export interface DigitalFilesConfig {
-      digital_file_ids: Array<string>;
-
-      external_url?: string | null;
-
-      instructions?: string | null;
-    }
-
-    export interface LicenseKeyConfig {
-      activation_message?: string | null;
-
-      activations_limit?: number | null;
-
-      duration_count?: number | null;
-
-      duration_interval?: string | null;
-    }
-  }
-}
-
 export interface ProductUpdateFilesResponse {
   file_id: string;
 
@@ -931,22 +808,30 @@ export interface ProductCreateParams {
 
   /**
    * Choose how you would like you digital product delivered
+   *
+   * deprecated: use entitlements instead
    */
   digital_product_delivery?: ProductCreateParams.DigitalProductDelivery | null;
 
   /**
-   * Optional entitlement IDs to attach to this product (max 20)
+   * Optional entitlements to attach to this product (max 20)
    */
-  entitlement_ids?: Array<string> | null;
+  entitlements?: Array<AttachProductEntitlement> | null;
 
   /**
    * @deprecated Optional message displayed during license key activation
+   *
+   * deprecated: use entitlements instead. Ignored when a `license_key` entitlement
+   * is attached via the `entitlements` field.
    */
   license_key_activation_message?: string | null;
 
   /**
    * @deprecated The number of times the license key can be activated. Must be 0 or
    * greater
+   *
+   * deprecated: use entitlements instead. Ignored when a `license_key` entitlement
+   * is attached via the `entitlements` field.
    */
   license_key_activations_limit?: number | null;
 
@@ -954,12 +839,19 @@ export interface ProductCreateParams {
    * Duration configuration for the license key. Set to null if you don't want the
    * license key to expire. For subscriptions, the lifetime of the license key is
    * tied to the subscription period
+   *
+   * deprecated: use entitlements instead. Ignored when a `license_key` entitlement
+   * is attached via the `entitlements` field.
    */
   license_key_duration?: LicenseKeyDuration | null;
 
   /**
    * @deprecated When true, generates and sends a license key to your customer.
    * Defaults to false
+   *
+   * deprecated: use entitlements instead. If a `license_key` entitlement is also
+   * attached via the `entitlements` field, the `license_key_*` config fields below
+   * are ignored — the attached entitlement's config is the source of truth.
    */
   license_key_enabled?: boolean | null;
 
@@ -972,6 +864,8 @@ export interface ProductCreateParams {
 export namespace ProductCreateParams {
   /**
    * Choose how you would like you digital product delivered
+   *
+   * deprecated: use entitlements instead
    */
   export interface DigitalProductDelivery {
     /**
@@ -1007,14 +901,16 @@ export interface ProductUpdateParams {
 
   /**
    * Choose how you would like you digital product delivered
+   *
+   * deprecated: use entitlements instead
    */
   digital_product_delivery?: ProductUpdateParams.DigitalProductDelivery | null;
 
   /**
-   * Entitlement IDs to attach (replaces all existing when present) Send empty array
-   * to remove all, omit field to leave unchanged
+   * Entitlements to attach (replaces all existing when present) Send empty array to
+   * remove all, omit field to leave unchanged
    */
-  entitlement_ids?: Array<string> | null;
+  entitlements?: Array<AttachProductEntitlement> | null;
 
   /**
    * Product image id after its uploaded to S3
@@ -1026,6 +922,8 @@ export interface ProductUpdateParams {
    *
    * Only applicable if `license_key_enabled` is `true`. This message contains
    * instructions for activating the license key.
+   *
+   * deprecated: use entitlements instead
    */
   license_key_activation_message?: string | null;
 
@@ -1034,6 +932,8 @@ export interface ProductUpdateParams {
    *
    * Only applicable if `license_key_enabled` is `true`. Represents the maximum
    * number of times the license key can be activated.
+   *
+   * deprecated: use entitlements instead
    */
   license_key_activations_limit?: number | null;
 
@@ -1042,6 +942,8 @@ export interface ProductUpdateParams {
    *
    * Only applicable if `license_key_enabled` is `true`. Represents the duration in
    * days for which the license key is valid.
+   *
+   * deprecated: use entitlements instead
    */
   license_key_duration?: LicenseKeyDuration | null;
 
@@ -1050,6 +952,8 @@ export interface ProductUpdateParams {
    *
    * If `true`, additional fields related to license key (duration, activations
    * limit, activation message) become applicable.
+   *
+   * deprecated: use entitlements instead
    */
   license_key_enabled?: boolean | null;
 
@@ -1077,6 +981,8 @@ export interface ProductUpdateParams {
 export namespace ProductUpdateParams {
   /**
    * Choose how you would like you digital product delivered
+   *
+   * deprecated: use entitlements instead
    */
   export interface DigitalProductDelivery {
     /**
@@ -1128,6 +1034,7 @@ export declare namespace Products {
   export {
     type AddMeterToPrice as AddMeterToPrice,
     type AttachCreditEntitlement as AttachCreditEntitlement,
+    type AttachProductEntitlement as AttachProductEntitlement,
     type CbbProrationBehavior as CbbProrationBehavior,
     type CreditEntitlementMappingResponse as CreditEntitlementMappingResponse,
     type DigitalProductDelivery as DigitalProductDelivery,
@@ -1135,6 +1042,7 @@ export declare namespace Products {
     type LicenseKeyDuration as LicenseKeyDuration,
     type Price as Price,
     type Product as Product,
+    type ProductEntitlementSummary as ProductEntitlementSummary,
     type ProductListResponse as ProductListResponse,
     type ProductUpdateFilesResponse as ProductUpdateFilesResponse,
     type ProductListResponsesDefaultPageNumberPagination as ProductListResponsesDefaultPageNumberPagination,