dodopayments 2.8.0 → 2.9.0

data/rbi/dodopayments/models/integration_config_response.rbi

@@ -0,0 +1,416 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    # Public-facing variant of [`IntegrationConfig`]. Mirrors every variant shape on
+    # the wire EXCEPT `DigitalFiles`, which is replaced with a hydrated
+    # `digital_files` object (resolved download URLs etc.). The persisted JSONB stays
+    # ID-only via [`IntegrationConfig`]; this enum is response-only.
+    module IntegrationConfigResponse
+      extend Dodopayments::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            Dodopayments::IntegrationConfigResponse::GitHubConfig,
+            Dodopayments::IntegrationConfigResponse::DiscordConfig,
+            Dodopayments::IntegrationConfigResponse::TelegramConfig,
+            Dodopayments::IntegrationConfigResponse::FigmaConfig,
+            Dodopayments::IntegrationConfigResponse::FramerConfig,
+            Dodopayments::IntegrationConfigResponse::NotionConfig,
+            Dodopayments::IntegrationConfigResponse::DigitalFilesConfig,
+            Dodopayments::IntegrationConfigResponse::LicenseKeyConfig
+          )
+        end
+
+      class GitHubConfig < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::IntegrationConfigResponse::GitHubConfig,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        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(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::IntegrationConfigResponse::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::IntegrationConfigResponse::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::IntegrationConfigResponse::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::IntegrationConfigResponse::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::IntegrationConfigResponse::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::IntegrationConfigResponse::DigitalFilesConfig,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # Populated digital-files payload for entitlement read surfaces. Mirrors
+        # `DigitalProductDelivery` but is sourced from an entitlement's
+        # `integration_config` (not a grant) and tags each file with its origin (`legacy`
+        # vs `ee`).
+        sig do
+          returns(
+            Dodopayments::IntegrationConfigResponse::DigitalFilesConfig::DigitalFiles
+          )
+        end
+        attr_reader :digital_files
+
+        sig do
+          params(
+            digital_files:
+              Dodopayments::IntegrationConfigResponse::DigitalFilesConfig::DigitalFiles::OrHash
+          ).void
+        end
+        attr_writer :digital_files
+
+        sig do
+          params(
+            digital_files:
+              Dodopayments::IntegrationConfigResponse::DigitalFilesConfig::DigitalFiles::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Populated digital-files payload for entitlement read surfaces. Mirrors
+          # `DigitalProductDelivery` but is sourced from an entitlement's
+          # `integration_config` (not a grant) and tags each file with its origin (`legacy`
+          # vs `ee`).
+          digital_files:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              digital_files:
+                Dodopayments::IntegrationConfigResponse::DigitalFilesConfig::DigitalFiles
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class DigitalFiles < Dodopayments::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Dodopayments::IntegrationConfigResponse::DigitalFilesConfig::DigitalFiles,
+                Dodopayments::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              T::Array[
+                Dodopayments::IntegrationConfigResponse::DigitalFilesConfig::DigitalFiles::File
+              ]
+            )
+          end
+          attr_accessor :files
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :external_url
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :instructions
+
+          # Populated digital-files payload for entitlement read surfaces. Mirrors
+          # `DigitalProductDelivery` but is sourced from an entitlement's
+          # `integration_config` (not a grant) and tags each file with its origin (`legacy`
+          # vs `ee`).
+          sig do
+            params(
+              files:
+                T::Array[
+                  Dodopayments::IntegrationConfigResponse::DigitalFilesConfig::DigitalFiles::File::OrHash
+                ],
+              external_url: T.nilable(String),
+              instructions: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(files:, external_url: nil, instructions: nil)
+          end
+
+          sig do
+            override.returns(
+              {
+                files:
+                  T::Array[
+                    Dodopayments::IntegrationConfigResponse::DigitalFilesConfig::DigitalFiles::File
+                  ],
+                external_url: T.nilable(String),
+                instructions: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class File < Dodopayments::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Dodopayments::IntegrationConfigResponse::DigitalFilesConfig::DigitalFiles::File,
+                  Dodopayments::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :download_url
+
+            # Seconds until `download_url` expires.
+            sig { returns(Integer) }
+            attr_accessor :expires_in
+
+            sig { returns(String) }
+            attr_accessor :file_id
+
+            sig { returns(String) }
+            attr_accessor :filename
+
+            # `"legacy"` for files in `product_files`, `"ee"` for files managed by the
+            # Entitlements Engine.
+            sig { returns(String) }
+            attr_accessor :source
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :content_type
+
+            sig { returns(T.nilable(Integer)) }
+            attr_accessor :file_size
+
+            sig do
+              params(
+                download_url: String,
+                expires_in: Integer,
+                file_id: String,
+                filename: String,
+                source: String,
+                content_type: T.nilable(String),
+                file_size: T.nilable(Integer)
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              download_url:,
+              # Seconds until `download_url` expires.
+              expires_in:,
+              file_id:,
+              filename:,
+              # `"legacy"` for files in `product_files`, `"ee"` for files managed by the
+              # Entitlements Engine.
+              source:,
+              content_type: nil,
+              file_size: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  download_url: String,
+                  expires_in: Integer,
+                  file_id: String,
+                  filename: String,
+                  source: String,
+                  content_type: T.nilable(String),
+                  file_size: T.nilable(Integer)
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+
+      class LicenseKeyConfig < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::IntegrationConfigResponse::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(Dodopayments::TimeInterval::TaggedSymbol)) }
+        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(Dodopayments::TimeInterval::OrSymbol)
+          ).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(Dodopayments::TimeInterval::TaggedSymbol)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      sig do
+        override.returns(
+          T::Array[Dodopayments::IntegrationConfigResponse::Variants]
+        )
+      end
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/license_key_instance_list_params.rbi

@@ -14,6 +14,10 @@ module Dodopayments
           )
         end
 
+      # Filter instances by entitlement grant ID
+      sig { returns(T.nilable(String)) }
+      attr_accessor :grant_id
+
       # Filter by license key ID
       sig { returns(T.nilable(String)) }
       attr_accessor :license_key_id
@@ -28,6 +32,7 @@ module Dodopayments
 
       sig do
         params(
+          grant_id: T.nilable(String),
           license_key_id: T.nilable(String),
           page_number: T.nilable(Integer),
           page_size: T.nilable(Integer),
@@ -35,6 +40,8 @@ module Dodopayments
         ).returns(T.attached_class)
       end
       def self.new(
+        # Filter instances by entitlement grant ID
+        grant_id: nil,
         # Filter by license key ID
         license_key_id: nil,
         # Page number default is 0
@@ -48,6 +55,7 @@ module Dodopayments
       sig do
         override.returns(
           {
+            grant_id: T.nilable(String),
             license_key_id: T.nilable(String),
             page_number: T.nilable(Integer),
             page_size: T.nilable(Integer),

data/rbi/dodopayments/models/one_time_product_cart_item.rbi

@@ -17,13 +17,34 @@ module Dodopayments
       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).returns(T.attached_class)
+        params(
+          product_id: String,
+          quantity: Integer,
+          amount: T.nilable(Integer)
+        ).returns(T.attached_class)
       end
-      def self.new(product_id:, quantity:)
+      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 { override.returns({ product_id: String, quantity: Integer }) }
+      sig do
+        override.returns(
+          { product_id: String, quantity: Integer, amount: T.nilable(Integer) }
+        )
+      end
       def to_hash
       end
     end

data/rbi/dodopayments/models/payment.rbi

@@ -139,7 +139,7 @@ module Dodopayments
       attr_accessor :payment_method_type
 
       # List of products purchased in a one-time payment
-      sig { returns(T.nilable(T::Array[Dodopayments::OneTimeProductCartItem])) }
+      sig { returns(T.nilable(T::Array[Dodopayments::Payment::ProductCart])) }
       attr_accessor :product_cart
 
       # Summary of the refund status for this payment. None if no succeeded refunds
@@ -204,7 +204,7 @@ module Dodopayments
           payment_method: T.nilable(String),
           payment_method_type: T.nilable(String),
           product_cart:
-            T.nilable(T::Array[Dodopayments::OneTimeProductCartItem::OrHash]),
+            T.nilable(T::Array[Dodopayments::Payment::ProductCart::OrHash]),
           refund_status: T.nilable(Dodopayments::PaymentRefundStatus::OrSymbol),
           settlement_tax: T.nilable(Integer),
           status: T.nilable(Dodopayments::IntentStatus::OrSymbol),
@@ -333,7 +333,7 @@ module Dodopayments
             payment_method: T.nilable(String),
             payment_method_type: T.nilable(String),
             product_cart:
-              T.nilable(T::Array[Dodopayments::OneTimeProductCartItem]),
+              T.nilable(T::Array[Dodopayments::Payment::ProductCart]),
             refund_status:
               T.nilable(Dodopayments::PaymentRefundStatus::TaggedSymbol),
             settlement_tax: T.nilable(Integer),
@@ -346,6 +346,34 @@ module Dodopayments
       end
       def to_hash
       end
+
+      class ProductCart < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Payment::ProductCart,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :product_id
+
+        sig { returns(Integer) }
+        attr_accessor :quantity
+
+        sig do
+          params(product_id: String, quantity: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(product_id:, quantity:)
+        end
+
+        sig { override.returns({ product_id: String, quantity: Integer }) }
+        def to_hash
+        end
+      end
     end
   end
 end

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