dodopayments 2.8.1 → 2.9.1

data/lib/dodopayments/models.rb

@@ -65,6 +65,8 @@ module Dodopayments
 
   AttachExistingCustomer = Dodopayments::Models::AttachExistingCustomer
 
+  AttachProductEntitlement = Dodopayments::Models::AttachProductEntitlement
+
   BalanceLedgerEntry = Dodopayments::Models::BalanceLedgerEntry
 
   BalanceRetrieveLedgerParams = Dodopayments::Models::BalanceRetrieveLedgerParams
@@ -83,6 +85,8 @@ module Dodopayments
 
   BrandUpdateParams = Dodopayments::Models::BrandUpdateParams
 
+  CancellationFeedback = Dodopayments::Models::CancellationFeedback
+
   CbbOverageBehavior = Dodopayments::Models::CbbOverageBehavior
 
   CbbProrationBehavior = Dodopayments::Models::CbbProrationBehavior
@@ -143,6 +147,8 @@ module Dodopayments
 
   CreditOverageChargedWebhookEvent = Dodopayments::Models::CreditOverageChargedWebhookEvent
 
+  CreditOverageResetWebhookEvent = Dodopayments::Models::CreditOverageResetWebhookEvent
+
   CreditRolledOverWebhookEvent = Dodopayments::Models::CreditRolledOverWebhookEvent
 
   CreditRolloverForfeitedWebhookEvent = Dodopayments::Models::CreditRolloverForfeitedWebhookEvent
@@ -159,6 +165,8 @@ module Dodopayments
 
   CustomerListCreditEntitlementsParams = Dodopayments::Models::CustomerListCreditEntitlementsParams
 
+  CustomerListEntitlementsParams = Dodopayments::Models::CustomerListEntitlementsParams
+
   CustomerListParams = Dodopayments::Models::CustomerListParams
 
   CustomerPortalSession = Dodopayments::Models::CustomerPortalSession
@@ -225,6 +233,30 @@ module Dodopayments
 
   DunningStartedWebhookEvent = Dodopayments::Models::DunningStartedWebhookEvent
 
+  Entitlement = Dodopayments::Models::Entitlement
+
+  EntitlementCreateParams = Dodopayments::Models::EntitlementCreateParams
+
+  EntitlementDeleteParams = Dodopayments::Models::EntitlementDeleteParams
+
+  EntitlementGrantCreatedWebhookEvent = Dodopayments::Models::EntitlementGrantCreatedWebhookEvent
+
+  EntitlementGrantDeliveredWebhookEvent = Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent
+
+  EntitlementGrantFailedWebhookEvent = Dodopayments::Models::EntitlementGrantFailedWebhookEvent
+
+  EntitlementGrantRevokedWebhookEvent = Dodopayments::Models::EntitlementGrantRevokedWebhookEvent
+
+  EntitlementIntegrationType = Dodopayments::Models::EntitlementIntegrationType
+
+  EntitlementListParams = Dodopayments::Models::EntitlementListParams
+
+  EntitlementRetrieveParams = Dodopayments::Models::EntitlementRetrieveParams
+
+  Entitlements = Dodopayments::Models::Entitlements
+
+  EntitlementUpdateParams = Dodopayments::Models::EntitlementUpdateParams
+
   Event = Dodopayments::Models::Event
 
   EventInput = Dodopayments::Models::EventInput
@@ -233,6 +265,10 @@ module Dodopayments
 
   GetDispute = Dodopayments::Models::GetDispute
 
+  IntegrationConfig = Dodopayments::Models::IntegrationConfig
+
+  IntegrationConfigResponse = Dodopayments::Models::IntegrationConfigResponse
+
   IntentStatus = Dodopayments::Models::IntentStatus
 
   Invoices = Dodopayments::Models::Invoices
@@ -329,6 +365,8 @@ module Dodopayments
 
   ProductCreateParams = Dodopayments::Models::ProductCreateParams
 
+  ProductEntitlementSummary = Dodopayments::Models::ProductEntitlementSummary
+
   ProductItemReq = Dodopayments::Models::ProductItemReq
 
   ProductListParams = Dodopayments::Models::ProductListParams
@@ -359,6 +397,8 @@ module Dodopayments
 
   RefundSucceededWebhookEvent = Dodopayments::Models::RefundSucceededWebhookEvent
 
+  ScheduledPlanChange = Dodopayments::Models::ScheduledPlanChange
+
   Subscription = Dodopayments::Models::Subscription
 
   SubscriptionActiveWebhookEvent = Dodopayments::Models::SubscriptionActiveWebhookEvent

data/lib/dodopayments/resources/checkout_sessions.rb

@@ -6,7 +6,7 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::CheckoutSessionCreateParams} for more details.
       #
-      # @overload create(product_cart:, allowed_payment_method_types: nil, billing_address: nil, billing_currency: nil, cancel_url: nil, confirm: nil, custom_fields: nil, customer: nil, customization: nil, discount_code: nil, feature_flags: nil, force_3ds: nil, metadata: nil, minimal_address: nil, payment_method_id: nil, product_collection_id: nil, return_url: nil, short_link: nil, show_saved_payment_methods: nil, subscription_data: nil, tax_id: nil, request_options: {})
+      # @overload create(product_cart:, allowed_payment_method_types: nil, billing_address: nil, billing_currency: nil, cancel_url: nil, confirm: nil, custom_fields: nil, customer: nil, customization: nil, discount_code: nil, feature_flags: nil, force_3ds: nil, mandate_min_amount_inr_paise: nil, metadata: nil, minimal_address: nil, payment_method_id: nil, product_collection_id: nil, return_url: nil, short_link: nil, show_saved_payment_methods: nil, subscription_data: nil, tax_id: nil, request_options: {})
       #
       # @param product_cart [Array<Dodopayments::Models::ProductItemReq>]
       #
@@ -32,6 +32,8 @@ module Dodopayments
       #
       # @param force_3ds [Boolean, nil] Override merchant default 3DS behaviour for this session
       #
+      # @param mandate_min_amount_inr_paise [Integer, nil] Override the merchant-level mandate floor (in INR paise) for INR
+      #
       # @param metadata [Hash{Symbol=>String}, nil] Additional metadata associated with the payment. Defaults to empty if not provid
       #
       # @param minimal_address [Boolean] If true, only zipcode is required when confirm is true; other address fields rem
@@ -86,7 +88,7 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::CheckoutSessionPreviewParams} for more details.
       #
-      # @overload preview(product_cart:, allowed_payment_method_types: nil, billing_address: nil, billing_currency: nil, cancel_url: nil, confirm: nil, custom_fields: nil, customer: nil, customization: nil, discount_code: nil, feature_flags: nil, force_3ds: nil, metadata: nil, minimal_address: nil, payment_method_id: nil, product_collection_id: nil, return_url: nil, short_link: nil, show_saved_payment_methods: nil, subscription_data: nil, tax_id: nil, request_options: {})
+      # @overload preview(product_cart:, allowed_payment_method_types: nil, billing_address: nil, billing_currency: nil, cancel_url: nil, confirm: nil, custom_fields: nil, customer: nil, customization: nil, discount_code: nil, feature_flags: nil, force_3ds: nil, mandate_min_amount_inr_paise: nil, metadata: nil, minimal_address: nil, payment_method_id: nil, product_collection_id: nil, return_url: nil, short_link: nil, show_saved_payment_methods: nil, subscription_data: nil, tax_id: nil, request_options: {})
       #
       # @param product_cart [Array<Dodopayments::Models::ProductItemReq>]
       #
@@ -112,6 +114,8 @@ module Dodopayments
       #
       # @param force_3ds [Boolean, nil] Override merchant default 3DS behaviour for this session
       #
+      # @param mandate_min_amount_inr_paise [Integer, nil] Override the merchant-level mandate floor (in INR paise) for INR
+      #
       # @param metadata [Hash{Symbol=>String}, nil] Additional metadata associated with the payment. Defaults to empty if not provid
       #
       # @param minimal_address [Boolean] If true, only zipcode is required when confirm is true; other address fields rem

data/lib/dodopayments/resources/customers.rb

@@ -158,6 +158,26 @@ module Dodopayments
         )
       end
 
+      # List all entitlement grants delivered (or in flight) to a customer.
+      #
+      # @overload list_entitlements(customer_id, request_options: {})
+      #
+      # @param customer_id [String] Customer ID
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::CustomerListEntitlementsResponse]
+      #
+      # @see Dodopayments::Models::CustomerListEntitlementsParams
+      def list_entitlements(customer_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["customers/%1$s/entitlements", customer_id],
+          model: Dodopayments::Models::CustomerListEntitlementsResponse,
+          options: params[:request_options]
+        )
+      end
+
       # @overload retrieve_payment_methods(customer_id, request_options: {})
       #
       # @param customer_id [String] Customer Id

data/lib/dodopayments/resources/entitlements/files.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class Entitlements
+      class Files
+        # Detach a previously-attached file from a `digital_files` entitlement.
+        #
+        # @overload delete(file_id, id:, request_options: {})
+        #
+        # @param file_id [String] Identifier of the attached file
+        #
+        # @param id [String] Entitlement Id
+        #
+        # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Dodopayments::Models::Entitlements::FileDeleteParams
+        def delete(file_id, params)
+          parsed, options = Dodopayments::Entitlements::FileDeleteParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["entitlements/%1$s/files/%2$s", id, file_id],
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # Attach a file to a `digital_files` entitlement. Per-file size cap: 500 MiB.
+        #
+        # @overload upload(id, request_options: {})
+        #
+        # @param id [String] Entitlement Id
+        #
+        # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Dodopayments::Models::Entitlements::FileUploadResponse]
+        #
+        # @see Dodopayments::Models::Entitlements::FileUploadParams
+        def upload(id, params = {})
+          @client.request(
+            method: :post,
+            path: ["entitlements/%1$s/files", id],
+            model: Dodopayments::Models::Entitlements::FileUploadResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Dodopayments::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/dodopayments/resources/entitlements/grants.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class Entitlements
+      class Grants
+        # GET /entitlements/{id}/grants (public API)
+        #
+        # @overload list(id, customer_id: nil, page_number: nil, page_size: nil, status: nil, request_options: {})
+        #
+        # @param id [String] Entitlement ID
+        #
+        # @param customer_id [String] Filter by customer ID
+        #
+        # @param page_number [Integer] Page number (default 0)
+        #
+        # @param page_size [Integer] Page size (default 10, max 100)
+        #
+        # @param status [Symbol, Dodopayments::Models::Entitlements::GrantListParams::Status] Filter by grant status
+        #
+        # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::Entitlements::EntitlementGrant>]
+        #
+        # @see Dodopayments::Models::Entitlements::GrantListParams
+        def list(id, params = {})
+          parsed, options = Dodopayments::Entitlements::GrantListParams.dump_request(params)
+          query = Dodopayments::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["entitlements/%1$s/grants", id],
+            query: query,
+            page: Dodopayments::Internal::DefaultPageNumberPagination,
+            model: Dodopayments::Entitlements::EntitlementGrant,
+            options: options
+          )
+        end
+
+        # Revoke a single grant. Idempotent: re-revoking an already-revoked grant returns
+        # the grant in its current state.
+        #
+        # @overload revoke(grant_id, id:, request_options: {})
+        #
+        # @param grant_id [String] Grant ID
+        #
+        # @param id [String] Entitlement ID
+        #
+        # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Dodopayments::Models::Entitlements::EntitlementGrant]
+        #
+        # @see Dodopayments::Models::Entitlements::GrantRevokeParams
+        def revoke(grant_id, params)
+          parsed, options = Dodopayments::Entitlements::GrantRevokeParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["entitlements/%1$s/grants/%2$s", id, grant_id],
+            model: Dodopayments::Entitlements::EntitlementGrant,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Dodopayments::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/dodopayments/resources/entitlements.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class Entitlements
+      # @return [Dodopayments::Resources::Entitlements::Files]
+      attr_reader :files
+
+      # @return [Dodopayments::Resources::Entitlements::Grants]
+      attr_reader :grants
+
+      # POST /entitlements
+      #
+      # @overload create(integration_config:, integration_type:, name:, description: nil, metadata: nil, request_options: {})
+      #
+      # @param integration_config [Dodopayments::Models::IntegrationConfig::GitHubConfig, Dodopayments::Models::IntegrationConfig::DiscordConfig, Dodopayments::Models::IntegrationConfig::TelegramConfig, Dodopayments::Models::IntegrationConfig::FigmaConfig, Dodopayments::Models::IntegrationConfig::FramerConfig, Dodopayments::Models::IntegrationConfig::NotionConfig, Dodopayments::Models::IntegrationConfig::DigitalFilesConfig, Dodopayments::Models::IntegrationConfig::LicenseKeyConfig] Platform-specific configuration (validated per integration_type)
+      #
+      # @param integration_type [Symbol, Dodopayments::Models::EntitlementIntegrationType] Which platform integration this entitlement uses
+      #
+      # @param name [String] Display name for this entitlement
+      #
+      # @param description [String, nil] Optional description
+      #
+      # @param metadata [Hash{Symbol=>String}] Additional metadata for the entitlement
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::Entitlement]
+      #
+      # @see Dodopayments::Models::EntitlementCreateParams
+      def create(params)
+        parsed, options = Dodopayments::EntitlementCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "entitlements",
+          body: parsed,
+          model: Dodopayments::Entitlement,
+          options: options
+        )
+      end
+
+      # GET /entitlements/{id}
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] Entitlement ID
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::Entitlement]
+      #
+      # @see Dodopayments::Models::EntitlementRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["entitlements/%1$s", id],
+          model: Dodopayments::Entitlement,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::EntitlementUpdateParams} for more details.
+      #
+      # PATCH /entitlements/{id}
+      #
+      # @overload update(id, description: nil, integration_config: nil, metadata: nil, name: nil, request_options: {})
+      #
+      # @param id [String] Entitlement ID
+      #
+      # @param description [String, nil]
+      #
+      # @param integration_config [Dodopayments::Models::IntegrationConfig::GitHubConfig, Dodopayments::Models::IntegrationConfig::DiscordConfig, Dodopayments::Models::IntegrationConfig::TelegramConfig, Dodopayments::Models::IntegrationConfig::FigmaConfig, Dodopayments::Models::IntegrationConfig::FramerConfig, Dodopayments::Models::IntegrationConfig::NotionConfig, Dodopayments::Models::IntegrationConfig::DigitalFilesConfig, Dodopayments::Models::IntegrationConfig::LicenseKeyConfig, nil] Integration-specific configuration supplied when creating or updating
+      #
+      # @param metadata [Hash{Symbol=>String}, nil]
+      #
+      # @param name [String, nil]
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::Entitlement]
+      #
+      # @see Dodopayments::Models::EntitlementUpdateParams
+      def update(id, params = {})
+        parsed, options = Dodopayments::EntitlementUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["entitlements/%1$s", id],
+          body: parsed,
+          model: Dodopayments::Entitlement,
+          options: options
+        )
+      end
+
+      # GET /entitlements
+      #
+      # @overload list(integration_type: nil, page_number: nil, page_size: nil, request_options: {})
+      #
+      # @param integration_type [Symbol, Dodopayments::Models::EntitlementListParams::IntegrationType] Filter by integration type
+      #
+      # @param page_number [Integer] Page number (default 0)
+      #
+      # @param page_size [Integer] Page size (default 10, max 100)
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::Entitlement>]
+      #
+      # @see Dodopayments::Models::EntitlementListParams
+      def list(params = {})
+        parsed, options = Dodopayments::EntitlementListParams.dump_request(params)
+        query = Dodopayments::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "entitlements",
+          query: query,
+          page: Dodopayments::Internal::DefaultPageNumberPagination,
+          model: Dodopayments::Entitlement,
+          options: options
+        )
+      end
+
+      # DELETE /entitlements/{id} (soft-delete)
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] Entitlement ID
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Dodopayments::Models::EntitlementDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["entitlements/%1$s", id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Dodopayments::Client]
+      def initialize(client:)
+        @client = client
+        @files = Dodopayments::Resources::Entitlements::Files.new(client: client)
+        @grants = Dodopayments::Resources::Entitlements::Grants.new(client: client)
+      end
+    end
+  end
+end

data/lib/dodopayments/resources/license_key_instances.rb

@@ -43,7 +43,9 @@ module Dodopayments
         )
       end
 
-      # @overload list(license_key_id: nil, page_number: nil, page_size: nil, request_options: {})
+      # @overload list(grant_id: nil, license_key_id: nil, page_number: nil, page_size: nil, request_options: {})
+      #
+      # @param grant_id [String, nil] Filter instances by entitlement grant ID
       #
       # @param license_key_id [String, nil] Filter by license key ID
       #

data/lib/dodopayments/resources/payments.rb

@@ -8,13 +8,15 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::PaymentCreateParams} for more details.
       #
-      # @overload create(billing:, customer:, product_cart:, allowed_payment_method_types: nil, billing_currency: nil, discount_code: nil, force_3ds: nil, metadata: nil, payment_link: nil, payment_method_id: nil, redirect_immediately: nil, return_url: nil, short_link: nil, show_saved_payment_methods: nil, tax_id: nil, request_options: {})
+      # @overload create(billing:, customer:, product_cart:, adaptive_currency_fees_inclusive: nil, allowed_payment_method_types: nil, billing_currency: nil, discount_code: nil, force_3ds: nil, metadata: nil, payment_link: nil, payment_method_id: nil, redirect_immediately: nil, require_phone_number: nil, return_url: nil, short_link: nil, show_saved_payment_methods: nil, tax_id: nil, request_options: {})
       #
       # @param billing [Dodopayments::Models::BillingAddress] Billing address details for the payment
       #
       # @param customer [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::NewCustomer] Customer information for the payment
       #
-      # @param product_cart [Array<Dodopayments::Models::PaymentCreateParams::ProductCart>] List of products in the cart. Must contain at least 1 and at most 100 items.
+      # @param product_cart [Array<Dodopayments::Models::OneTimeProductCartItem>] List of products in the cart. Must contain at least 1 and at most 100 items.
+      #
+      # @param adaptive_currency_fees_inclusive [Boolean, nil] Whether adaptive currency fees should be included in the price (true) or added o
       #
       # @param allowed_payment_method_types [Array<Symbol, Dodopayments::Models::PaymentMethodTypes>, nil] List of payment methods allowed during checkout.
       #
@@ -32,6 +34,8 @@ module Dodopayments
       #
       # @param redirect_immediately [Boolean] If true, redirects the customer immediately after payment completion
       #
+      # @param require_phone_number [Boolean] If true, the customer's phone number is required to create this payment.
+      #
       # @param return_url [String, nil] Optional URL to redirect the customer after payment.
       #
       # @param short_link [Boolean, nil] If true, returns a shortened payment link.

data/lib/dodopayments/resources/products.rb

@@ -12,7 +12,7 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::ProductCreateParams} for more details.
       #
-      # @overload create(name:, price:, tax_category:, addons: nil, brand_id: nil, credit_entitlements: nil, description: nil, digital_product_delivery: nil, entitlement_ids: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, metadata: nil, request_options: {})
+      # @overload create(name:, price:, tax_category:, addons: nil, brand_id: nil, credit_entitlements: nil, description: nil, digital_product_delivery: nil, entitlements: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, metadata: nil, request_options: {})
       #
       # @param name [String] Name of the product
       #
@@ -30,7 +30,7 @@ module Dodopayments
       #
       # @param digital_product_delivery [Dodopayments::Models::ProductCreateParams::DigitalProductDelivery, nil] Choose how you would like you digital product delivered
       #
-      # @param entitlement_ids [Array<String>, nil] Optional entitlement IDs to attach to this product (max 20)
+      # @param entitlements [Array<Dodopayments::Models::AttachProductEntitlement>, nil] Optional entitlements to attach to this product (max 20)
       #
       # @param license_key_activation_message [String, nil] Optional message displayed during license key activation
       #
@@ -79,7 +79,7 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::ProductUpdateParams} for more details.
       #
-      # @overload update(id, addons: nil, brand_id: nil, credit_entitlements: nil, description: nil, digital_product_delivery: nil, entitlement_ids: nil, image_id: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, metadata: nil, name: nil, price: nil, tax_category: nil, request_options: {})
+      # @overload update(id, addons: nil, brand_id: nil, credit_entitlements: nil, description: nil, digital_product_delivery: nil, entitlements: nil, image_id: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, metadata: nil, name: nil, price: nil, tax_category: nil, request_options: {})
       #
       # @param id [String]
       #
@@ -93,7 +93,7 @@ module Dodopayments
       #
       # @param digital_product_delivery [Dodopayments::Models::ProductUpdateParams::DigitalProductDelivery, nil] Choose how you would like you digital product delivered
       #
-      # @param entitlement_ids [Array<String>, nil] Entitlement IDs to attach (replaces all existing when present)
+      # @param entitlements [Array<Dodopayments::Models::AttachProductEntitlement>, nil] Entitlements to attach (replaces all existing when present)
       #
       # @param image_id [String, nil] Product image id after its uploaded to S3
       #

data/lib/dodopayments/resources/subscriptions.rb

@@ -8,7 +8,7 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::SubscriptionCreateParams} for more details.
       #
-      # @overload create(billing:, customer:, product_id:, quantity:, addons: nil, allowed_payment_method_types: nil, billing_currency: nil, discount_code: nil, force_3ds: nil, metadata: nil, on_demand: nil, one_time_product_cart: nil, payment_link: nil, payment_method_id: nil, redirect_immediately: nil, return_url: nil, short_link: nil, show_saved_payment_methods: nil, tax_id: nil, trial_period_days: nil, request_options: {})
+      # @overload create(billing:, customer:, product_id:, quantity:, addons: nil, allowed_payment_method_types: nil, billing_currency: nil, discount_code: nil, force_3ds: nil, mandate_min_amount_inr_paise: nil, metadata: nil, on_demand: nil, one_time_product_cart: nil, payment_link: nil, payment_method_id: nil, redirect_immediately: nil, require_phone_number: nil, return_url: nil, short_link: nil, show_saved_payment_methods: nil, tax_id: nil, trial_period_days: nil, request_options: {})
       #
       # @param billing [Dodopayments::Models::BillingAddress] Billing address information for the subscription
       #
@@ -28,11 +28,13 @@ module Dodopayments
       #
       # @param force_3ds [Boolean, nil] Override merchant default 3DS behaviour for this subscription
       #
+      # @param mandate_min_amount_inr_paise [Integer, nil] Override the merchant-level mandate floor (in INR paise) for INR
+      #
       # @param metadata [Hash{Symbol=>String}] Additional metadata for the subscription
       #
       # @param on_demand [Dodopayments::Models::OnDemandSubscription, nil]
       #
-      # @param one_time_product_cart [Array<Dodopayments::Models::SubscriptionCreateParams::OneTimeProductCart>, nil] List of one time products that will be bundled with the first payment for this s
+      # @param one_time_product_cart [Array<Dodopayments::Models::OneTimeProductCartItem>, nil] List of one time products that will be bundled with the first payment for this s
       #
       # @param payment_link [Boolean, nil] If true, generates a payment link.
       #
@@ -40,6 +42,8 @@ module Dodopayments
       #
       # @param redirect_immediately [Boolean] If true, redirects the customer immediately after payment completion
       #
+      # @param require_phone_number [Boolean] If true, the customer's phone number is required to create this subscription.
+      #
       # @param return_url [String, nil] Optional URL to redirect after successful subscription creation
       #
       # @param short_link [Boolean, nil] If true, returns a shortened payment link.
@@ -84,7 +88,10 @@ module Dodopayments
         )
       end
 
-      # @overload update(subscription_id, billing: nil, cancel_at_next_billing_date: nil, cancel_reason: nil, credit_entitlement_cart: nil, customer_name: nil, disable_on_demand: nil, metadata: nil, next_billing_date: nil, status: nil, tax_id: nil, request_options: {})
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::SubscriptionUpdateParams} for more details.
+      #
+      # @overload update(subscription_id, billing: nil, cancel_at_next_billing_date: nil, cancel_reason: nil, cancellation_comment: nil, cancellation_feedback: nil, credit_entitlement_cart: nil, customer_name: nil, disable_on_demand: nil, metadata: nil, next_billing_date: nil, status: nil, tax_id: nil, request_options: {})
       #
       # @param subscription_id [String] Subscription Id
       #
@@ -94,6 +101,10 @@ module Dodopayments
       #
       # @param cancel_reason [Symbol, Dodopayments::Models::SubscriptionUpdateParams::CancelReason, nil]
       #
+      # @param cancellation_comment [String, nil] Free-text cancellation comment (only valid when cancelling or scheduling cancell
+      #
+      # @param cancellation_feedback [Symbol, Dodopayments::Models::CancellationFeedback, nil] Customer-supplied churn reason (only valid when cancelling or scheduling cancell
+      #
       # @param credit_entitlement_cart [Array<Dodopayments::Models::SubscriptionUpdateParams::CreditEntitlementCart>, nil] Update credit entitlement cart settings
       #
       # @param customer_name [String, nil]
@@ -181,7 +192,7 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::SubscriptionChangePlanParams} for more details.
       #
-      # @overload change_plan(subscription_id, product_id:, proration_billing_mode:, quantity:, addons: nil, discount_code: nil, effective_at: nil, metadata: nil, on_payment_failure: nil, request_options: {})
+      # @overload change_plan(subscription_id, product_id:, proration_billing_mode:, quantity:, adaptive_currency_fees_inclusive: nil, addons: nil, discount_code: nil, effective_at: nil, metadata: nil, on_payment_failure: nil, request_options: {})
       #
       # @param subscription_id [String] Subscription Id
       #
@@ -191,6 +202,8 @@ module Dodopayments
       #
       # @param quantity [Integer] Number of units to subscribe for. Must be at least 1.
       #
+      # @param adaptive_currency_fees_inclusive [Boolean, nil] Whether adaptive currency fees should be included in the price (true) or added o
+      #
       # @param addons [Array<Dodopayments::Models::AttachAddon>, nil] Addons for the new plan.
       #
       # @param discount_code [String, nil] Optional discount code to apply to the new plan.
@@ -255,7 +268,7 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::SubscriptionPreviewChangePlanParams} for more details.
       #
-      # @overload preview_change_plan(subscription_id, product_id:, proration_billing_mode:, quantity:, addons: nil, discount_code: nil, effective_at: nil, metadata: nil, on_payment_failure: nil, request_options: {})
+      # @overload preview_change_plan(subscription_id, product_id:, proration_billing_mode:, quantity:, adaptive_currency_fees_inclusive: nil, addons: nil, discount_code: nil, effective_at: nil, metadata: nil, on_payment_failure: nil, request_options: {})
       #
       # @param subscription_id [String] Subscription Id
       #
@@ -265,6 +278,8 @@ module Dodopayments
       #
       # @param quantity [Integer] Number of units to subscribe for. Must be at least 1.
       #
+      # @param adaptive_currency_fees_inclusive [Boolean, nil] Whether adaptive currency fees should be included in the price (true) or added o
+      #
       # @param addons [Array<Dodopayments::Models::AttachAddon>, nil] Addons for the new plan.
       #
       # @param discount_code [String, nil] Optional discount code to apply to the new plan.

data/lib/dodopayments/resources/webhooks.rb

@@ -167,7 +167,7 @@ module Dodopayments
 
       # @param payload [String] The raw webhook payload as a string
       #
-      # @return [Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent]
+      # @return [Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent]
       def unsafe_unwrap(payload)
         parsed = JSON.parse(payload, symbolize_names: true)
         Dodopayments::Internal::Type::Converter.coerce(Dodopayments::Models::UnsafeUnwrapWebhookEvent, parsed)
@@ -179,7 +179,7 @@ module Dodopayments
       #
       # @param key [String, nil] The webhook signing key
       #
-      # @return [Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent]
+      # @return [Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent]
       def unwrap(payload, headers:, key: @client.webhook_key)
         if key.nil?
           raise ArgumentError.new("Cannot verify a webhook without a key on either the client's webhook_key or passed in as an argument")

data/lib/dodopayments/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dodopayments
-  VERSION = "2.8.1"
+  VERSION = "2.9.1"
 end