dodopayments 2.27.0 → 2.28.0

package/src/resources/products/products.ts

@@ -542,13 +542,18 @@ export interface Product {
    */
   credit_entitlements: Array<CreditEntitlementMappingResponse>;
 
+  /**
+   * Attached entitlements (integration-based access grants)
+   */
+  entitlements: Array<Product.Entitlement>;
+
   /**
    * Indicates if the product is recurring (e.g., subscriptions).
    */
   is_recurring: boolean;
 
   /**
-   * Indicates whether the product requires a license key.
+   * @deprecated Indicates whether the product requires a license key.
    */
   license_key_enabled: boolean;
 
@@ -595,12 +600,12 @@ export interface Product {
   image?: string | null;
 
   /**
-   * Message sent upon license key activation, if applicable.
+   * @deprecated Message sent upon license key activation, if applicable.
    */
   license_key_activation_message?: string | null;
 
   /**
-   * Limit on the number of activations for the license key, if enabled.
+   * @deprecated Limit on the number of activations for the license key, if enabled.
    */
   license_key_activations_limit?: number | null;
 
@@ -620,6 +625,94 @@ export interface Product {
   product_collection_id?: string | null;
 }
 
+export namespace Product {
+  /**
+   * 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 ProductListResponse {
   /**
    * Unique identifier for the business to which the product belongs.
@@ -631,6 +724,11 @@ export interface ProductListResponse {
    */
   created_at: string;
 
+  /**
+   * Entitlements linked to this product
+   */
+  entitlements: Array<ProductListResponse.Entitlement>;
+
   /**
    * Indicates if the product is recurring (e.g., subscriptions).
    */
@@ -701,6 +799,94 @@ 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;
 
@@ -749,12 +935,18 @@ export interface ProductCreateParams {
   digital_product_delivery?: ProductCreateParams.DigitalProductDelivery | null;
 
   /**
-   * Optional message displayed during license key activation
+   * Optional entitlement IDs to attach to this product (max 20)
+   */
+  entitlement_ids?: Array<string> | null;
+
+  /**
+   * @deprecated Optional message displayed during license key activation
    */
   license_key_activation_message?: string | null;
 
   /**
-   * The number of times the license key can be activated. Must be 0 or greater
+   * @deprecated The number of times the license key can be activated. Must be 0 or
+   * greater
    */
   license_key_activations_limit?: number | null;
 
@@ -766,7 +958,8 @@ export interface ProductCreateParams {
   license_key_duration?: LicenseKeyDuration | null;
 
   /**
-   * When true, generates and sends a license key to your customer. Defaults to false
+   * @deprecated When true, generates and sends a license key to your customer.
+   * Defaults to false
    */
   license_key_enabled?: boolean | null;
 
@@ -817,13 +1010,19 @@ export interface ProductUpdateParams {
    */
   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
+   */
+  entitlement_ids?: Array<string> | null;
+
   /**
    * Product image id after its uploaded to S3
    */
   image_id?: string | null;
 
   /**
-   * Message sent to the customer upon license key activation.
+   * @deprecated Message sent to the customer upon license key activation.
    *
    * Only applicable if `license_key_enabled` is `true`. This message contains
    * instructions for activating the license key.
@@ -831,7 +1030,7 @@ export interface ProductUpdateParams {
   license_key_activation_message?: string | null;
 
   /**
-   * Limit for the number of activations for the license key.
+   * @deprecated Limit for the number of activations for the license key.
    *
    * Only applicable if `license_key_enabled` is `true`. Represents the maximum
    * number of times the license key can be activated.
@@ -847,7 +1046,7 @@ export interface ProductUpdateParams {
   license_key_duration?: LicenseKeyDuration | null;
 
   /**
-   * Whether the product requires a license key.
+   * @deprecated Whether the product requires a license key.
    *
    * If `true`, additional fields related to license key (duration, activations
    * limit, activation message) become applicable.

package/src/resources/webhook-events.ts

@@ -54,7 +54,11 @@ export type WebhookEventType =
   | 'dunning.started'
   | 'dunning.recovered'
   | 'acr.email'
-  | 'dunning.email';
+  | 'dunning.email'
+  | 'entitlement_grant.created'
+  | 'entitlement_grant.delivered'
+  | 'entitlement_grant.failed'
+  | 'entitlement_grant.revoked';
 
 export interface WebhookPayload {
   business_id: string;
@@ -71,7 +75,8 @@ export interface WebhookPayload {
     | WebhookPayload.CreditLedgerEntry
     | WebhookPayload.CreditBalanceLow
     | WebhookPayload.AbandonedCheckout
-    | WebhookPayload.DunningAttempt;
+    | WebhookPayload.DunningAttempt
+    | WebhookPayload.EntitlementGrant;
 
   /**
    * The timestamp of when the event occurred (not necessarily the same of when it
@@ -167,6 +172,56 @@ export namespace WebhookPayload {
 
     payment_id?: string | null;
   }
+
+  export interface EntitlementGrant {
+    id: string;
+
+    business_id: string;
+
+    created_at: string;
+
+    customer_id: string;
+
+    entitlement_id: string;
+
+    external_id: string;
+
+    payload_type: 'EntitlementGrant';
+
+    status: 'Pending' | 'Delivered' | 'Failed' | 'Revoked';
+
+    updated_at: string;
+
+    delivered_at?: string | null;
+
+    error_code?: string | null;
+
+    error_message?: string | null;
+
+    license_key?: string | null;
+
+    license_key_activations_limit?: number | null;
+
+    license_key_activations_used?: number | null;
+
+    license_key_expires_at?: string | null;
+
+    license_key_status?: string | null;
+
+    metadata?: unknown;
+
+    oauth_expires_at?: string | null;
+
+    oauth_url?: string | null;
+
+    payment_id?: string | null;
+
+    revocation_reason?: string | null;
+
+    revoked_at?: string | null;
+
+    subscription_id?: string | null;
+  }
 }
 
 export declare namespace WebhookEvents {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.27.0'; // x-release-please-version
+export const VERSION = '2.28.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.27.0";
+export declare const VERSION = "2.28.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.27.0'; // x-release-please-version
+exports.VERSION = '2.28.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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