dodopayments 2.8.0 → 2.9.0

data/lib/dodopayments/version.rb

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

data/lib/dodopayments.rb

@@ -57,6 +57,7 @@ require_relative "dodopayments/internal/cursor_page_pagination"
 require_relative "dodopayments/internal/default_page_number_pagination"
 require_relative "dodopayments/models/checkout_session_request"
 require_relative "dodopayments/models/update_subscription_plan_req"
+require_relative "dodopayments/models/entitlements/entitlement_grant"
 require_relative "dodopayments/models/credit_entitlements/credit_ledger_entry"
 require_relative "dodopayments/models/license_key"
 require_relative "dodopayments/models/get_dispute"
@@ -77,6 +78,7 @@ require_relative "dodopayments/models/addon_update_params"
 require_relative "dodopayments/models/attach_addon"
 require_relative "dodopayments/models/attach_credit_entitlement"
 require_relative "dodopayments/models/attach_existing_customer"
+require_relative "dodopayments/models/attach_product_entitlement"
 require_relative "dodopayments/models/balance_ledger_entry"
 require_relative "dodopayments/models/balance_retrieve_ledger_params"
 require_relative "dodopayments/models/billing_address"
@@ -88,6 +90,7 @@ require_relative "dodopayments/models/brand_retrieve_params"
 require_relative "dodopayments/models/brand_update_images_params"
 require_relative "dodopayments/models/brand_update_images_response"
 require_relative "dodopayments/models/brand_update_params"
+require_relative "dodopayments/models/cancellation_feedback"
 require_relative "dodopayments/models/cbb_overage_behavior"
 require_relative "dodopayments/models/cbb_proration_behavior"
 require_relative "dodopayments/models/checkout_session_billing_address"
@@ -126,6 +129,7 @@ require_relative "dodopayments/models/credit_entitlement_update_params"
 require_relative "dodopayments/models/credit_expired_webhook_event"
 require_relative "dodopayments/models/credit_manual_adjustment_webhook_event"
 require_relative "dodopayments/models/credit_overage_charged_webhook_event"
+require_relative "dodopayments/models/credit_overage_reset_webhook_event"
 require_relative "dodopayments/models/credit_rolled_over_webhook_event"
 require_relative "dodopayments/models/credit_rollover_forfeited_webhook_event"
 require_relative "dodopayments/models/currency"
@@ -135,6 +139,8 @@ require_relative "dodopayments/models/customer_delete_payment_method_params"
 require_relative "dodopayments/models/customer_limited_details"
 require_relative "dodopayments/models/customer_list_credit_entitlements_params"
 require_relative "dodopayments/models/customer_list_credit_entitlements_response"
+require_relative "dodopayments/models/customer_list_entitlements_params"
+require_relative "dodopayments/models/customer_list_entitlements_response"
 require_relative "dodopayments/models/customer_list_params"
 require_relative "dodopayments/models/customer_portal_session"
 require_relative "dodopayments/models/customer_request"
@@ -176,9 +182,28 @@ require_relative "dodopayments/models/dispute_status"
 require_relative "dodopayments/models/dispute_won_webhook_event"
 require_relative "dodopayments/models/dunning_recovered_webhook_event"
 require_relative "dodopayments/models/dunning_started_webhook_event"
+require_relative "dodopayments/models/entitlement"
+require_relative "dodopayments/models/entitlement_create_params"
+require_relative "dodopayments/models/entitlement_delete_params"
+require_relative "dodopayments/models/entitlement_grant_created_webhook_event"
+require_relative "dodopayments/models/entitlement_grant_delivered_webhook_event"
+require_relative "dodopayments/models/entitlement_grant_failed_webhook_event"
+require_relative "dodopayments/models/entitlement_grant_revoked_webhook_event"
+require_relative "dodopayments/models/entitlement_integration_type"
+require_relative "dodopayments/models/entitlement_list_params"
+require_relative "dodopayments/models/entitlement_retrieve_params"
+require_relative "dodopayments/models/entitlements/file_delete_params"
+require_relative "dodopayments/models/entitlements/file_upload_params"
+require_relative "dodopayments/models/entitlements/file_upload_response"
+require_relative "dodopayments/models/entitlements/grant_list_params"
+require_relative "dodopayments/models/entitlements/grant_revoke_params"
+require_relative "dodopayments/models/entitlements/license_key_grant"
+require_relative "dodopayments/models/entitlement_update_params"
 require_relative "dodopayments/models/event"
 require_relative "dodopayments/models/event_input"
 require_relative "dodopayments/models/filter_operator"
+require_relative "dodopayments/models/integration_config"
+require_relative "dodopayments/models/integration_config_response"
 require_relative "dodopayments/models/intent_status"
 require_relative "dodopayments/models/invoices/payment_retrieve_params"
 require_relative "dodopayments/models/invoices/payment_retrieve_refund_params"
@@ -237,6 +262,7 @@ require_relative "dodopayments/models/price"
 require_relative "dodopayments/models/product"
 require_relative "dodopayments/models/product_archive_params"
 require_relative "dodopayments/models/product_create_params"
+require_relative "dodopayments/models/product_entitlement_summary"
 require_relative "dodopayments/models/product_item_req"
 require_relative "dodopayments/models/product_list_params"
 require_relative "dodopayments/models/product_list_response"
@@ -258,6 +284,7 @@ require_relative "dodopayments/models/refund_list_params"
 require_relative "dodopayments/models/refund_retrieve_params"
 require_relative "dodopayments/models/refund_status"
 require_relative "dodopayments/models/refund_succeeded_webhook_event"
+require_relative "dodopayments/models/scheduled_plan_change"
 require_relative "dodopayments/models/subscription_active_webhook_event"
 require_relative "dodopayments/models/subscription_cancel_change_plan_params"
 require_relative "dodopayments/models/subscription_cancelled_webhook_event"
@@ -324,6 +351,9 @@ require_relative "dodopayments/resources/customers/wallets"
 require_relative "dodopayments/resources/customers/wallets/ledger_entries"
 require_relative "dodopayments/resources/discounts"
 require_relative "dodopayments/resources/disputes"
+require_relative "dodopayments/resources/entitlements"
+require_relative "dodopayments/resources/entitlements/files"
+require_relative "dodopayments/resources/entitlements/grants"
 require_relative "dodopayments/resources/invoices"
 require_relative "dodopayments/resources/invoices/payments"
 require_relative "dodopayments/resources/license_key_instances"

data/rbi/dodopayments/client.rbi

@@ -92,6 +92,9 @@ module Dodopayments
     sig { returns(Dodopayments::Resources::CreditEntitlements) }
     attr_reader :credit_entitlements
 
+    sig { returns(Dodopayments::Resources::Entitlements) }
+    attr_reader :entitlements
+
     # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers

data/rbi/dodopayments/models/attach_product_entitlement.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class AttachProductEntitlement < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::AttachProductEntitlement,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # ID of the entitlement to attach to the product
+      sig { returns(String) }
+      attr_accessor :entitlement_id
+
+      # 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.
+      sig { params(entitlement_id: String).returns(T.attached_class) }
+      def self.new(
+        # ID of the entitlement to attach to the product
+        entitlement_id:
+      )
+      end
+
+      sig { override.returns({ entitlement_id: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/cancellation_feedback.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module CancellationFeedback
+      extend Dodopayments::Internal::Type::Enum
+
+      TaggedSymbol =
+        T.type_alias { T.all(Symbol, Dodopayments::CancellationFeedback) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      TOO_EXPENSIVE =
+        T.let(:too_expensive, Dodopayments::CancellationFeedback::TaggedSymbol)
+      MISSING_FEATURES =
+        T.let(
+          :missing_features,
+          Dodopayments::CancellationFeedback::TaggedSymbol
+        )
+      SWITCHED_SERVICE =
+        T.let(
+          :switched_service,
+          Dodopayments::CancellationFeedback::TaggedSymbol
+        )
+      UNUSED = T.let(:unused, Dodopayments::CancellationFeedback::TaggedSymbol)
+      CUSTOMER_SERVICE =
+        T.let(
+          :customer_service,
+          Dodopayments::CancellationFeedback::TaggedSymbol
+        )
+      LOW_QUALITY =
+        T.let(:low_quality, Dodopayments::CancellationFeedback::TaggedSymbol)
+      TOO_COMPLEX =
+        T.let(:too_complex, Dodopayments::CancellationFeedback::TaggedSymbol)
+      OTHER = T.let(:other, Dodopayments::CancellationFeedback::TaggedSymbol)
+
+      sig do
+        override.returns(
+          T::Array[Dodopayments::CancellationFeedback::TaggedSymbol]
+        )
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/checkout_session_flags.rbi

@@ -114,6 +114,16 @@ module Dodopayments
       sig { params(redirect_immediately: T::Boolean).void }
       attr_writer :redirect_immediately
 
+      # If true, the customer must provide a phone number to complete checkout. Requires
+      # `allow_phone_number_collection` to also be true.
+      #
+      # Default is false
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :require_phone_number
+
+      sig { params(require_phone_number: T::Boolean).void }
+      attr_writer :require_phone_number
+
       sig do
         params(
           allow_currency_selection: T::Boolean,
@@ -129,7 +139,8 @@ module Dodopayments
           allow_phone_number_collection: T::Boolean,
           allow_tax_id: T::Boolean,
           always_create_new_customer: T::Boolean,
-          redirect_immediately: T::Boolean
+          redirect_immediately: T::Boolean,
+          require_phone_number: T::Boolean
         ).returns(T.attached_class)
       end
       def self.new(
@@ -165,7 +176,12 @@ module Dodopayments
         # If true, redirects the customer immediately after payment completion
         #
         # Default is false
-        redirect_immediately: nil
+        redirect_immediately: nil,
+        # If true, the customer must provide a phone number to complete checkout. Requires
+        # `allow_phone_number_collection` to also be true.
+        #
+        # Default is false
+        require_phone_number: nil
       )
       end
 
@@ -185,7 +201,8 @@ module Dodopayments
             allow_phone_number_collection: T::Boolean,
             allow_tax_id: T::Boolean,
             always_create_new_customer: T::Boolean,
-            redirect_immediately: T::Boolean
+            redirect_immediately: T::Boolean,
+            require_phone_number: T::Boolean
           }
         )
       end

data/rbi/dodopayments/models/checkout_session_request.rbi

@@ -97,6 +97,15 @@ module Dodopayments
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :force_3ds
 
+      # Override the merchant-level mandate floor (in INR paise) for INR e-mandates on
+      # Indian-card recurring payments. The mandate amount sent to the processor is
+      # `max(this_floor, actual_billing_amount)`, so this is effectively the
+      # customer-facing authorization ceiling whenever billing is lower. When unset, the
+      # merchant setting applies; when that's also unset, the system default of ₹15,000
+      # applies.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :mandate_min_amount_inr_paise
+
       # Additional metadata associated with the payment. Defaults to empty if not
       # provided.
       sig { returns(T.nilable(T::Hash[Symbol, String])) }
@@ -174,6 +183,7 @@ module Dodopayments
           discount_code: T.nilable(String),
           feature_flags: Dodopayments::CheckoutSessionFlags::OrHash,
           force_3ds: T.nilable(T::Boolean),
+          mandate_min_amount_inr_paise: T.nilable(Integer),
           metadata: T.nilable(T::Hash[Symbol, String]),
           minimal_address: T::Boolean,
           payment_method_id: T.nilable(String),
@@ -214,6 +224,13 @@ module Dodopayments
         feature_flags: nil,
         # Override merchant default 3DS behaviour for this session
         force_3ds: nil,
+        # Override the merchant-level mandate floor (in INR paise) for INR e-mandates on
+        # Indian-card recurring payments. The mandate amount sent to the processor is
+        # `max(this_floor, actual_billing_amount)`, so this is effectively the
+        # customer-facing authorization ceiling whenever billing is lower. When unset, the
+        # merchant setting applies; when that's also unset, the system default of ₹15,000
+        # applies.
+        mandate_min_amount_inr_paise: nil,
         # Additional metadata associated with the payment. Defaults to empty if not
         # provided.
         metadata: nil,
@@ -261,6 +278,7 @@ module Dodopayments
             discount_code: T.nilable(String),
             feature_flags: Dodopayments::CheckoutSessionFlags,
             force_3ds: T.nilable(T::Boolean),
+            mandate_min_amount_inr_paise: T.nilable(Integer),
             metadata: T.nilable(T::Hash[Symbol, String]),
             minimal_address: T::Boolean,
             payment_method_id: T.nilable(String),

data/rbi/dodopayments/models/credit_entitlements/credit_ledger_entry.rbi

@@ -174,6 +174,11 @@ module Dodopayments
               :overage_charged,
               Dodopayments::CreditEntitlements::CreditLedgerEntry::TransactionType::TaggedSymbol
             )
+          OVERAGE_RESET =
+            T.let(
+              :overage_reset,
+              Dodopayments::CreditEntitlements::CreditLedgerEntry::TransactionType::TaggedSymbol
+            )
           AUTO_TOP_UP =
             T.let(
               :auto_top_up,

data/rbi/dodopayments/models/credit_overage_reset_webhook_event.rbi

@@ -0,0 +1,103 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class CreditOverageResetWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::CreditOverageResetWebhookEvent,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # The business identifier
+      sig { returns(String) }
+      attr_accessor :business_id
+
+      # Response for a ledger entry
+      sig { returns(Dodopayments::CreditEntitlements::CreditLedgerEntry) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: Dodopayments::CreditEntitlements::CreditLedgerEntry::OrHash
+        ).void
+      end
+      attr_writer :data
+
+      # The timestamp of when the event occurred
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The event type
+      sig do
+        returns(
+          Dodopayments::CreditOverageResetWebhookEvent::Type::TaggedSymbol
+        )
+      end
+      attr_accessor :type
+
+      sig do
+        params(
+          business_id: String,
+          data: Dodopayments::CreditEntitlements::CreditLedgerEntry::OrHash,
+          timestamp: Time,
+          type: Dodopayments::CreditOverageResetWebhookEvent::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The business identifier
+        business_id:,
+        # Response for a ledger entry
+        data:,
+        # The timestamp of when the event occurred
+        timestamp:,
+        # The event type
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            business_id: String,
+            data: Dodopayments::CreditEntitlements::CreditLedgerEntry,
+            timestamp: Time,
+            type:
+              Dodopayments::CreditOverageResetWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The event type
+      module Type
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Dodopayments::CreditOverageResetWebhookEvent::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CREDIT_OVERAGE_RESET =
+          T.let(
+            :"credit.overage_reset",
+            Dodopayments::CreditOverageResetWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::CreditOverageResetWebhookEvent::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/customer_list_entitlements_params.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class CustomerListEntitlementsParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::CustomerListEntitlementsParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :customer_id
+
+      sig do
+        params(
+          customer_id: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(customer_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { customer_id: String, request_options: Dodopayments::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/customer_list_entitlements_response.rbi

@@ -0,0 +1,189 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class CustomerListEntitlementsResponse < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::Models::CustomerListEntitlementsResponse,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(
+          T::Array[Dodopayments::Models::CustomerListEntitlementsResponse::Item]
+        )
+      end
+      attr_accessor :items
+
+      sig do
+        params(
+          items:
+            T::Array[
+              Dodopayments::Models::CustomerListEntitlementsResponse::Item::OrHash
+            ]
+        ).returns(T.attached_class)
+      end
+      def self.new(items:)
+      end
+
+      sig do
+        override.returns(
+          {
+            items:
+              T::Array[
+                Dodopayments::Models::CustomerListEntitlementsResponse::Item
+              ]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Item < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Models::CustomerListEntitlementsResponse::Item,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # The entitlement this grant belongs to.
+        sig { returns(String) }
+        attr_accessor :entitlement_id
+
+        sig { returns(String) }
+        attr_accessor :entitlement_name
+
+        # Grant id (the per-customer row in `entitlement_grants`).
+        sig { returns(String) }
+        attr_accessor :grant_id
+
+        sig { returns(Dodopayments::EntitlementIntegrationType::TaggedSymbol) }
+        attr_accessor :integration_type
+
+        sig do
+          returns(
+            Dodopayments::Models::CustomerListEntitlementsResponse::Item::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        sig { returns(Time) }
+        attr_accessor :updated_at
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :delivered_at
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :entitlement_description
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :revoked_at
+
+        sig do
+          params(
+            created_at: Time,
+            entitlement_id: String,
+            entitlement_name: String,
+            grant_id: String,
+            integration_type:
+              Dodopayments::EntitlementIntegrationType::OrSymbol,
+            status:
+              Dodopayments::Models::CustomerListEntitlementsResponse::Item::Status::OrSymbol,
+            updated_at: Time,
+            delivered_at: T.nilable(Time),
+            entitlement_description: T.nilable(String),
+            revoked_at: T.nilable(Time)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          created_at:,
+          # The entitlement this grant belongs to.
+          entitlement_id:,
+          entitlement_name:,
+          # Grant id (the per-customer row in `entitlement_grants`).
+          grant_id:,
+          integration_type:,
+          status:,
+          updated_at:,
+          delivered_at: nil,
+          entitlement_description: nil,
+          revoked_at: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              created_at: Time,
+              entitlement_id: String,
+              entitlement_name: String,
+              grant_id: String,
+              integration_type:
+                Dodopayments::EntitlementIntegrationType::TaggedSymbol,
+              status:
+                Dodopayments::Models::CustomerListEntitlementsResponse::Item::Status::TaggedSymbol,
+              updated_at: Time,
+              delivered_at: T.nilable(Time),
+              entitlement_description: T.nilable(String),
+              revoked_at: T.nilable(Time)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Status
+          extend Dodopayments::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Dodopayments::Models::CustomerListEntitlementsResponse::Item::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PENDING =
+            T.let(
+              :pending,
+              Dodopayments::Models::CustomerListEntitlementsResponse::Item::Status::TaggedSymbol
+            )
+          DELIVERED =
+            T.let(
+              :delivered,
+              Dodopayments::Models::CustomerListEntitlementsResponse::Item::Status::TaggedSymbol
+            )
+          FAILED =
+            T.let(
+              :failed,
+              Dodopayments::Models::CustomerListEntitlementsResponse::Item::Status::TaggedSymbol
+            )
+          REVOKED =
+            T.let(
+              :revoked,
+              Dodopayments::Models::CustomerListEntitlementsResponse::Item::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Dodopayments::Models::CustomerListEntitlementsResponse::Item::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end