dodopayments 2.8.1 → 2.9.1

data/rbi/dodopayments/models/payment_create_params.rbi

@@ -30,9 +30,14 @@ module Dodopayments
       attr_accessor :customer
 
       # List of products in the cart. Must contain at least 1 and at most 100 items.
-      sig { returns(T::Array[Dodopayments::PaymentCreateParams::ProductCart]) }
+      sig { returns(T::Array[Dodopayments::OneTimeProductCartItem]) }
       attr_accessor :product_cart
 
+      # 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.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :adaptive_currency_fees_inclusive
+
       # List of payment methods allowed during checkout.
       #
       # Customers will **never** see payment methods that are **not** in this list.
@@ -83,6 +88,15 @@ module Dodopayments
       sig { params(redirect_immediately: T::Boolean).void }
       attr_writer :redirect_immediately
 
+      # 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.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :require_phone_number
+
+      sig { params(require_phone_number: T::Boolean).void }
+      attr_writer :require_phone_number
+
       # Optional URL to redirect the customer after payment. Must be a valid URL if
       # provided.
       sig { returns(T.nilable(String)) }
@@ -112,8 +126,8 @@ module Dodopayments
               Dodopayments::AttachExistingCustomer::OrHash,
               Dodopayments::NewCustomer::OrHash
             ),
-          product_cart:
-            T::Array[Dodopayments::PaymentCreateParams::ProductCart::OrHash],
+          product_cart: T::Array[Dodopayments::OneTimeProductCartItem::OrHash],
+          adaptive_currency_fees_inclusive: T.nilable(T::Boolean),
           allowed_payment_method_types:
             T.nilable(T::Array[Dodopayments::PaymentMethodTypes::OrSymbol]),
           billing_currency: T.nilable(Dodopayments::Currency::OrSymbol),
@@ -123,6 +137,7 @@ module Dodopayments
           payment_link: T.nilable(T::Boolean),
           payment_method_id: T.nilable(String),
           redirect_immediately: T::Boolean,
+          require_phone_number: T::Boolean,
           return_url: T.nilable(String),
           short_link: T.nilable(T::Boolean),
           show_saved_payment_methods: T::Boolean,
@@ -137,6 +152,9 @@ module Dodopayments
         customer:,
         # List of products in the cart. Must contain at least 1 and at most 100 items.
         product_cart:,
+        # 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: nil,
         # List of payment methods allowed during checkout.
         #
         # Customers will **never** see payment methods that are **not** in this list.
@@ -163,6 +181,10 @@ module Dodopayments
         # If true, redirects the customer immediately after payment completion False by
         # default
         redirect_immediately: nil,
+        # 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: nil,
         # Optional URL to redirect the customer after payment. Must be a valid URL if
         # provided.
         return_url: nil,
@@ -186,8 +208,8 @@ module Dodopayments
                 Dodopayments::AttachExistingCustomer,
                 Dodopayments::NewCustomer
               ),
-            product_cart:
-              T::Array[Dodopayments::PaymentCreateParams::ProductCart],
+            product_cart: T::Array[Dodopayments::OneTimeProductCartItem],
+            adaptive_currency_fees_inclusive: T.nilable(T::Boolean),
             allowed_payment_method_types:
               T.nilable(T::Array[Dodopayments::PaymentMethodTypes::OrSymbol]),
             billing_currency: T.nilable(Dodopayments::Currency::OrSymbol),
@@ -197,6 +219,7 @@ module Dodopayments
             payment_link: T.nilable(T::Boolean),
             payment_method_id: T.nilable(String),
             redirect_immediately: T::Boolean,
+            require_phone_number: T::Boolean,
             return_url: T.nilable(String),
             short_link: T.nilable(T::Boolean),
             show_saved_payment_methods: T::Boolean,
@@ -207,57 +230,6 @@ module Dodopayments
       end
       def to_hash
       end
-
-      class ProductCart < Dodopayments::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Dodopayments::PaymentCreateParams::ProductCart,
-              Dodopayments::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :product_id
-
-        sig { returns(Integer) }
-        attr_accessor :quantity
-
-        # 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`.
-        sig { returns(T.nilable(Integer)) }
-        attr_accessor :amount
-
-        sig do
-          params(
-            product_id: String,
-            quantity: Integer,
-            amount: T.nilable(Integer)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          product_id:,
-          quantity:,
-          # 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: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              product_id: String,
-              quantity: Integer,
-              amount: T.nilable(Integer)
-            }
-          )
-        end
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/dodopayments/models/payment_create_response.rbi

@@ -50,13 +50,7 @@ module Dodopayments
       attr_accessor :payment_link
 
       # Optional list of products included in the payment
-      sig do
-        returns(
-          T.nilable(
-            T::Array[Dodopayments::Models::PaymentCreateResponse::ProductCart]
-          )
-        )
-      end
+      sig { returns(T.nilable(T::Array[Dodopayments::OneTimeProductCartItem])) }
       attr_accessor :product_cart
 
       sig do
@@ -70,11 +64,7 @@ module Dodopayments
           expires_on: T.nilable(Time),
           payment_link: T.nilable(String),
           product_cart:
-            T.nilable(
-              T::Array[
-                Dodopayments::Models::PaymentCreateResponse::ProductCart::OrHash
-              ]
-            )
+            T.nilable(T::Array[Dodopayments::OneTimeProductCartItem::OrHash])
         ).returns(T.attached_class)
       end
       def self.new(
@@ -112,67 +102,12 @@ module Dodopayments
             expires_on: T.nilable(Time),
             payment_link: T.nilable(String),
             product_cart:
-              T.nilable(
-                T::Array[
-                  Dodopayments::Models::PaymentCreateResponse::ProductCart
-                ]
-              )
+              T.nilable(T::Array[Dodopayments::OneTimeProductCartItem])
           }
         )
       end
       def to_hash
       end
-
-      class ProductCart < Dodopayments::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Dodopayments::Models::PaymentCreateResponse::ProductCart,
-              Dodopayments::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :product_id
-
-        sig { returns(Integer) }
-        attr_accessor :quantity
-
-        # 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`.
-        sig { returns(T.nilable(Integer)) }
-        attr_accessor :amount
-
-        sig do
-          params(
-            product_id: String,
-            quantity: Integer,
-            amount: T.nilable(Integer)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          product_id:,
-          quantity:,
-          # 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: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              product_id: String,
-              quantity: Integer,
-              amount: T.nilable(Integer)
-            }
-          )
-        end
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/dodopayments/models/product.rbi

@@ -24,7 +24,7 @@ module Dodopayments
       attr_accessor :credit_entitlements
 
       # Attached entitlements (integration-based access grants)
-      sig { returns(T::Array[Dodopayments::Product::Entitlement]) }
+      sig { returns(T::Array[Dodopayments::ProductEntitlementSummary]) }
       attr_accessor :entitlements
 
       # Indicates if the product is recurring (e.g., subscriptions).
@@ -63,6 +63,8 @@ module Dodopayments
       sig { returns(T.nilable(String)) }
       attr_accessor :description
 
+      # Digital-product-delivery payload, present on grants for `digital_files`
+      # entitlements. Each file carries a short-lived presigned download URL.
       sig { returns(T.nilable(Dodopayments::DigitalProductDelivery)) }
       attr_reader :digital_product_delivery
 
@@ -113,7 +115,8 @@ module Dodopayments
           created_at: Time,
           credit_entitlements:
             T::Array[Dodopayments::CreditEntitlementMappingResponse::OrHash],
-          entitlements: T::Array[Dodopayments::Product::Entitlement::OrHash],
+          entitlements:
+            T::Array[Dodopayments::ProductEntitlementSummary::OrHash],
           is_recurring: T::Boolean,
           license_key_enabled: T::Boolean,
           metadata: T::Hash[Symbol, String],
@@ -167,6 +170,8 @@ module Dodopayments
         addons: nil,
         # Description of the product, optional.
         description: nil,
+        # Digital-product-delivery payload, present on grants for `digital_files`
+        # entitlements. Each file carries a short-lived presigned download URL.
         digital_product_delivery: nil,
         # URL of the product image, optional.
         image: nil,
@@ -191,7 +196,7 @@ module Dodopayments
             created_at: Time,
             credit_entitlements:
               T::Array[Dodopayments::CreditEntitlementMappingResponse],
-            entitlements: T::Array[Dodopayments::Product::Entitlement],
+            entitlements: T::Array[Dodopayments::ProductEntitlementSummary],
             is_recurring: T::Boolean,
             license_key_enabled: T::Boolean,
             metadata: T::Hash[Symbol, String],
@@ -214,423 +219,6 @@ module Dodopayments
       end
       def to_hash
       end
-
-      class Entitlement < Dodopayments::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Dodopayments::Product::Entitlement,
-              Dodopayments::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :id
-
-        # Platform-specific configuration for an entitlement. Each variant uses unique
-        # field names so `#[serde(untagged)]` can disambiguate correctly.
-        sig do
-          returns(
-            Dodopayments::Product::Entitlement::IntegrationConfig::Variants
-          )
-        end
-        attr_accessor :integration_config
-
-        sig do
-          returns(
-            Dodopayments::Product::Entitlement::IntegrationType::TaggedSymbol
-          )
-        end
-        attr_accessor :integration_type
-
-        sig { returns(String) }
-        attr_accessor :name
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :description
-
-        # Summary of an entitlement attached to a product
-        sig do
-          params(
-            id: String,
-            integration_config:
-              T.any(
-                Dodopayments::Product::Entitlement::IntegrationConfig::GitHubConfig::OrHash,
-                Dodopayments::Product::Entitlement::IntegrationConfig::DiscordConfig::OrHash,
-                Dodopayments::Product::Entitlement::IntegrationConfig::TelegramConfig::OrHash,
-                Dodopayments::Product::Entitlement::IntegrationConfig::FigmaConfig::OrHash,
-                Dodopayments::Product::Entitlement::IntegrationConfig::FramerConfig::OrHash,
-                Dodopayments::Product::Entitlement::IntegrationConfig::NotionConfig::OrHash,
-                Dodopayments::Product::Entitlement::IntegrationConfig::DigitalFilesConfig::OrHash,
-                Dodopayments::Product::Entitlement::IntegrationConfig::LicenseKeyConfig::OrHash
-              ),
-            integration_type:
-              Dodopayments::Product::Entitlement::IntegrationType::OrSymbol,
-            name: String,
-            description: T.nilable(String)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          id:,
-          # Platform-specific configuration for an entitlement. Each variant uses unique
-          # field names so `#[serde(untagged)]` can disambiguate correctly.
-          integration_config:,
-          integration_type:,
-          name:,
-          description: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              id: String,
-              integration_config:
-                Dodopayments::Product::Entitlement::IntegrationConfig::Variants,
-              integration_type:
-                Dodopayments::Product::Entitlement::IntegrationType::TaggedSymbol,
-              name: String,
-              description: T.nilable(String)
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # Platform-specific configuration for an entitlement. Each variant uses unique
-        # field names so `#[serde(untagged)]` can disambiguate correctly.
-        module IntegrationConfig
-          extend Dodopayments::Internal::Type::Union
-
-          Variants =
-            T.type_alias do
-              T.any(
-                Dodopayments::Product::Entitlement::IntegrationConfig::GitHubConfig,
-                Dodopayments::Product::Entitlement::IntegrationConfig::DiscordConfig,
-                Dodopayments::Product::Entitlement::IntegrationConfig::TelegramConfig,
-                Dodopayments::Product::Entitlement::IntegrationConfig::FigmaConfig,
-                Dodopayments::Product::Entitlement::IntegrationConfig::FramerConfig,
-                Dodopayments::Product::Entitlement::IntegrationConfig::NotionConfig,
-                Dodopayments::Product::Entitlement::IntegrationConfig::DigitalFilesConfig,
-                Dodopayments::Product::Entitlement::IntegrationConfig::LicenseKeyConfig
-              )
-            end
-
-          class GitHubConfig < Dodopayments::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Dodopayments::Product::Entitlement::IntegrationConfig::GitHubConfig,
-                  Dodopayments::Internal::AnyHash
-                )
-              end
-
-            # One of: pull, push, admin, maintain, triage
-            sig { returns(String) }
-            attr_accessor :permission
-
-            sig { returns(String) }
-            attr_accessor :target_id
-
-            sig do
-              params(permission: String, target_id: String).returns(
-                T.attached_class
-              )
-            end
-            def self.new(
-              # One of: pull, push, admin, maintain, triage
-              permission:,
-              target_id:
-            )
-            end
-
-            sig { override.returns({ permission: String, target_id: String }) }
-            def to_hash
-            end
-          end
-
-          class DiscordConfig < Dodopayments::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Dodopayments::Product::Entitlement::IntegrationConfig::DiscordConfig,
-                  Dodopayments::Internal::AnyHash
-                )
-              end
-
-            sig { returns(String) }
-            attr_accessor :guild_id
-
-            sig { returns(T.nilable(String)) }
-            attr_accessor :role_id
-
-            sig do
-              params(guild_id: String, role_id: T.nilable(String)).returns(
-                T.attached_class
-              )
-            end
-            def self.new(guild_id:, role_id: nil)
-            end
-
-            sig do
-              override.returns({ guild_id: String, role_id: T.nilable(String) })
-            end
-            def to_hash
-            end
-          end
-
-          class TelegramConfig < Dodopayments::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Dodopayments::Product::Entitlement::IntegrationConfig::TelegramConfig,
-                  Dodopayments::Internal::AnyHash
-                )
-              end
-
-            sig { returns(String) }
-            attr_accessor :chat_id
-
-            sig { params(chat_id: String).returns(T.attached_class) }
-            def self.new(chat_id:)
-            end
-
-            sig { override.returns({ chat_id: String }) }
-            def to_hash
-            end
-          end
-
-          class FigmaConfig < Dodopayments::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Dodopayments::Product::Entitlement::IntegrationConfig::FigmaConfig,
-                  Dodopayments::Internal::AnyHash
-                )
-              end
-
-            sig { returns(String) }
-            attr_accessor :figma_file_id
-
-            sig { params(figma_file_id: String).returns(T.attached_class) }
-            def self.new(figma_file_id:)
-            end
-
-            sig { override.returns({ figma_file_id: String }) }
-            def to_hash
-            end
-          end
-
-          class FramerConfig < Dodopayments::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Dodopayments::Product::Entitlement::IntegrationConfig::FramerConfig,
-                  Dodopayments::Internal::AnyHash
-                )
-              end
-
-            sig { returns(String) }
-            attr_accessor :framer_template_id
-
-            sig { params(framer_template_id: String).returns(T.attached_class) }
-            def self.new(framer_template_id:)
-            end
-
-            sig { override.returns({ framer_template_id: String }) }
-            def to_hash
-            end
-          end
-
-          class NotionConfig < Dodopayments::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Dodopayments::Product::Entitlement::IntegrationConfig::NotionConfig,
-                  Dodopayments::Internal::AnyHash
-                )
-              end
-
-            sig { returns(String) }
-            attr_accessor :notion_template_id
-
-            sig { params(notion_template_id: String).returns(T.attached_class) }
-            def self.new(notion_template_id:)
-            end
-
-            sig { override.returns({ notion_template_id: String }) }
-            def to_hash
-            end
-          end
-
-          class DigitalFilesConfig < Dodopayments::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Dodopayments::Product::Entitlement::IntegrationConfig::DigitalFilesConfig,
-                  Dodopayments::Internal::AnyHash
-                )
-              end
-
-            sig { returns(T::Array[String]) }
-            attr_accessor :digital_file_ids
-
-            sig { returns(T.nilable(String)) }
-            attr_accessor :external_url
-
-            sig { returns(T.nilable(String)) }
-            attr_accessor :instructions
-
-            sig do
-              params(
-                digital_file_ids: T::Array[String],
-                external_url: T.nilable(String),
-                instructions: T.nilable(String)
-              ).returns(T.attached_class)
-            end
-            def self.new(
-              digital_file_ids:,
-              external_url: nil,
-              instructions: nil
-            )
-            end
-
-            sig do
-              override.returns(
-                {
-                  digital_file_ids: T::Array[String],
-                  external_url: T.nilable(String),
-                  instructions: T.nilable(String)
-                }
-              )
-            end
-            def to_hash
-            end
-          end
-
-          class LicenseKeyConfig < Dodopayments::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Dodopayments::Product::Entitlement::IntegrationConfig::LicenseKeyConfig,
-                  Dodopayments::Internal::AnyHash
-                )
-              end
-
-            sig { returns(T.nilable(String)) }
-            attr_accessor :activation_message
-
-            sig { returns(T.nilable(Integer)) }
-            attr_accessor :activations_limit
-
-            sig { returns(T.nilable(Integer)) }
-            attr_accessor :duration_count
-
-            sig { returns(T.nilable(String)) }
-            attr_accessor :duration_interval
-
-            sig do
-              params(
-                activation_message: T.nilable(String),
-                activations_limit: T.nilable(Integer),
-                duration_count: T.nilable(Integer),
-                duration_interval: T.nilable(String)
-              ).returns(T.attached_class)
-            end
-            def self.new(
-              activation_message: nil,
-              activations_limit: nil,
-              duration_count: nil,
-              duration_interval: nil
-            )
-            end
-
-            sig do
-              override.returns(
-                {
-                  activation_message: T.nilable(String),
-                  activations_limit: T.nilable(Integer),
-                  duration_count: T.nilable(Integer),
-                  duration_interval: T.nilable(String)
-                }
-              )
-            end
-            def to_hash
-            end
-          end
-
-          sig do
-            override.returns(
-              T::Array[
-                Dodopayments::Product::Entitlement::IntegrationConfig::Variants
-              ]
-            )
-          end
-          def self.variants
-          end
-        end
-
-        module IntegrationType
-          extend Dodopayments::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(Symbol, Dodopayments::Product::Entitlement::IntegrationType)
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          DISCORD =
-            T.let(
-              :discord,
-              Dodopayments::Product::Entitlement::IntegrationType::TaggedSymbol
-            )
-          TELEGRAM =
-            T.let(
-              :telegram,
-              Dodopayments::Product::Entitlement::IntegrationType::TaggedSymbol
-            )
-          GITHUB =
-            T.let(
-              :github,
-              Dodopayments::Product::Entitlement::IntegrationType::TaggedSymbol
-            )
-          FIGMA =
-            T.let(
-              :figma,
-              Dodopayments::Product::Entitlement::IntegrationType::TaggedSymbol
-            )
-          FRAMER =
-            T.let(
-              :framer,
-              Dodopayments::Product::Entitlement::IntegrationType::TaggedSymbol
-            )
-          NOTION =
-            T.let(
-              :notion,
-              Dodopayments::Product::Entitlement::IntegrationType::TaggedSymbol
-            )
-          DIGITAL_FILES =
-            T.let(
-              :digital_files,
-              Dodopayments::Product::Entitlement::IntegrationType::TaggedSymbol
-            )
-          LICENSE_KEY =
-            T.let(
-              :license_key,
-              Dodopayments::Product::Entitlement::IntegrationType::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Dodopayments::Product::Entitlement::IntegrationType::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
     end
   end
 end