dodopayments 2.9.0 → 2.10.0

data/rbi/dodopayments/models/integration_config_response.rbi

@@ -2,10 +2,10 @@
 
 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.
+    # Integration-specific configuration on an entitlement read response.
+    #
+    # For `digital_files` entitlements the response includes presigned download URLs
+    # for each attached file; other integrations match the shape supplied at creation.
     module IntegrationConfigResponse
       extend Dodopayments::Internal::Type::Union
 
@@ -32,23 +32,94 @@ module Dodopayments
             )
           end
 
-        sig { returns(String) }
+        # Permission to grant on the repository.
+        sig do
+          returns(
+            Dodopayments::IntegrationConfigResponse::GitHubConfig::Permission::TaggedSymbol
+          )
+        end
         attr_accessor :permission
 
+        # Repository or organisation slug to grant access to.
         sig { returns(String) }
         attr_accessor :target_id
 
         sig do
-          params(permission: String, target_id: String).returns(
-            T.attached_class
-          )
+          params(
+            permission:
+              Dodopayments::IntegrationConfigResponse::GitHubConfig::Permission::OrSymbol,
+            target_id: String
+          ).returns(T.attached_class)
         end
-        def self.new(permission:, target_id:)
+        def self.new(
+          # Permission to grant on the repository.
+          permission:,
+          # Repository or organisation slug to grant access to.
+          target_id:
+        )
         end
 
-        sig { override.returns({ permission: String, target_id: String }) }
+        sig do
+          override.returns(
+            {
+              permission:
+                Dodopayments::IntegrationConfigResponse::GitHubConfig::Permission::TaggedSymbol,
+              target_id: String
+            }
+          )
+        end
         def to_hash
         end
+
+        # Permission to grant on the repository.
+        module Permission
+          extend Dodopayments::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Dodopayments::IntegrationConfigResponse::GitHubConfig::Permission
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PULL =
+            T.let(
+              :pull,
+              Dodopayments::IntegrationConfigResponse::GitHubConfig::Permission::TaggedSymbol
+            )
+          PUSH =
+            T.let(
+              :push,
+              Dodopayments::IntegrationConfigResponse::GitHubConfig::Permission::TaggedSymbol
+            )
+          ADMIN =
+            T.let(
+              :admin,
+              Dodopayments::IntegrationConfigResponse::GitHubConfig::Permission::TaggedSymbol
+            )
+          MAINTAIN =
+            T.let(
+              :maintain,
+              Dodopayments::IntegrationConfigResponse::GitHubConfig::Permission::TaggedSymbol
+            )
+          TRIAGE =
+            T.let(
+              :triage,
+              Dodopayments::IntegrationConfigResponse::GitHubConfig::Permission::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Dodopayments::IntegrationConfigResponse::GitHubConfig::Permission::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
 
       class DiscordConfig < Dodopayments::Internal::Type::BaseModel
@@ -60,9 +131,11 @@ module Dodopayments
             )
           end
 
+        # Discord guild (server) ID.
         sig { returns(String) }
         attr_accessor :guild_id
 
+        # Optional Discord role to assign within the guild.
         sig { returns(T.nilable(String)) }
         attr_accessor :role_id
 
@@ -71,7 +144,12 @@ module Dodopayments
             T.attached_class
           )
         end
-        def self.new(guild_id:, role_id: nil)
+        def self.new(
+          # Discord guild (server) ID.
+          guild_id:,
+          # Optional Discord role to assign within the guild.
+          role_id: nil
+        )
         end
 
         sig do
@@ -90,11 +168,15 @@ module Dodopayments
             )
           end
 
+        # Telegram chat ID. For groups this is typically a negative integer.
         sig { returns(String) }
         attr_accessor :chat_id
 
         sig { params(chat_id: String).returns(T.attached_class) }
-        def self.new(chat_id:)
+        def self.new(
+          # Telegram chat ID. For groups this is typically a negative integer.
+          chat_id:
+        )
         end
 
         sig { override.returns({ chat_id: String }) }
@@ -111,11 +193,15 @@ module Dodopayments
             )
           end
 
+        # Figma file identifier to grant access to.
         sig { returns(String) }
         attr_accessor :figma_file_id
 
         sig { params(figma_file_id: String).returns(T.attached_class) }
-        def self.new(figma_file_id:)
+        def self.new(
+          # Figma file identifier to grant access to.
+          figma_file_id:
+        )
         end
 
         sig { override.returns({ figma_file_id: String }) }
@@ -132,11 +218,15 @@ module Dodopayments
             )
           end
 
+        # Framer template identifier to grant access to.
         sig { returns(String) }
         attr_accessor :framer_template_id
 
         sig { params(framer_template_id: String).returns(T.attached_class) }
-        def self.new(framer_template_id:)
+        def self.new(
+          # Framer template identifier to grant access to.
+          framer_template_id:
+        )
         end
 
         sig { override.returns({ framer_template_id: String }) }
@@ -153,11 +243,15 @@ module Dodopayments
             )
           end
 
+        # Notion template identifier to grant access to.
         sig { returns(String) }
         attr_accessor :notion_template_id
 
         sig { params(notion_template_id: String).returns(T.attached_class) }
-        def self.new(notion_template_id:)
+        def self.new(
+          # Notion template identifier to grant access to.
+          notion_template_id:
+        )
         end
 
         sig { override.returns({ notion_template_id: String }) }
@@ -174,10 +268,8 @@ module Dodopayments
             )
           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`).
+        # Populated digital-files payload with each file's metadata and a short-lived
+        # presigned download URL.
         sig do
           returns(
             Dodopayments::IntegrationConfigResponse::DigitalFilesConfig::DigitalFiles
@@ -200,10 +292,8 @@ module Dodopayments
           ).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`).
+          # Populated digital-files payload with each file's metadata and a short-lived
+          # presigned download URL.
           digital_files:
         )
         end
@@ -228,6 +318,7 @@ module Dodopayments
               )
             end
 
+          # One entry per attached file.
           sig do
             returns(
               T::Array[
@@ -237,16 +328,17 @@ module Dodopayments
           end
           attr_accessor :files
 
+          # Optional external URL, passed through from the entitlement configuration.
           sig { returns(T.nilable(String)) }
           attr_accessor :external_url
 
+          # Optional human-readable delivery instructions, passed through from the
+          # entitlement configuration.
           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`).
+          # Populated digital-files payload with each file's metadata and a short-lived
+          # presigned download URL.
           sig do
             params(
               files:
@@ -257,7 +349,15 @@ module Dodopayments
               instructions: T.nilable(String)
             ).returns(T.attached_class)
           end
-          def self.new(files:, external_url: nil, instructions: nil)
+          def self.new(
+            # One entry per attached file.
+            files:,
+            # Optional external URL, passed through from the entitlement configuration.
+            external_url: nil,
+            # Optional human-readable delivery instructions, passed through from the
+            # entitlement configuration.
+            instructions: nil
+          )
           end
 
           sig do
@@ -284,6 +384,7 @@ module Dodopayments
                 )
               end
 
+            # Short-lived presigned URL for downloading the file.
             sig { returns(String) }
             attr_accessor :download_url
 
@@ -291,44 +392,45 @@ module Dodopayments
             sig { returns(Integer) }
             attr_accessor :expires_in
 
+            # Identifier of the attached file.
             sig { returns(String) }
             attr_accessor :file_id
 
+            # Original filename of the attached file.
             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
-
+            # Optional content-type declared at upload.
             sig { returns(T.nilable(String)) }
             attr_accessor :content_type
 
+            # Optional size of the file in bytes.
             sig { returns(T.nilable(Integer)) }
             attr_accessor :file_size
 
+            # One file in a resolved digital-files payload.
             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(
+              # Short-lived presigned URL for downloading the file.
               download_url:,
               # Seconds until `download_url` expires.
               expires_in:,
+              # Identifier of the attached file.
               file_id:,
+              # Original filename of the attached file.
               filename:,
-              # `"legacy"` for files in `product_files`, `"ee"` for files managed by the
-              # Entitlements Engine.
-              source:,
+              # Optional content-type declared at upload.
               content_type: nil,
+              # Optional size of the file in bytes.
               file_size: nil
             )
             end
@@ -340,7 +442,6 @@ module Dodopayments
                   expires_in: Integer,
                   file_id: String,
                   filename: String,
-                  source: String,
                   content_type: T.nilable(String),
                   file_size: T.nilable(Integer)
                 }
@@ -361,15 +462,22 @@ module Dodopayments
             )
           end
 
+        # Optional message displayed when a customer activates the license key (≤ 2500
+        # characters).
         sig { returns(T.nilable(String)) }
         attr_accessor :activation_message
 
+        # Maximum activations allowed per issued license key. Omit for unlimited.
         sig { returns(T.nilable(Integer)) }
         attr_accessor :activations_limit
 
+        # Validity duration of issued license keys. Provide both `duration_count` and
+        # `duration_interval` together for a fixed duration; omit both for non-expiring
+        # keys.
         sig { returns(T.nilable(Integer)) }
         attr_accessor :duration_count
 
+        # Unit of `duration_count`.
         sig { returns(T.nilable(Dodopayments::TimeInterval::TaggedSymbol)) }
         attr_accessor :duration_interval
 
@@ -382,9 +490,16 @@ module Dodopayments
           ).returns(T.attached_class)
         end
         def self.new(
+          # Optional message displayed when a customer activates the license key (≤ 2500
+          # characters).
           activation_message: nil,
+          # Maximum activations allowed per issued license key. Omit for unlimited.
           activations_limit: nil,
+          # Validity duration of issued license keys. Provide both `duration_count` and
+          # `duration_interval` together for a fixed duration; omit both for non-expiring
+          # keys.
           duration_count: nil,
+          # Unit of `duration_count`.
           duration_interval: nil
         )
         end

data/rbi/dodopayments/models/license_key_created_webhook_event.rbi

@@ -26,9 +26,7 @@ module Dodopayments
       attr_accessor :timestamp
 
       # The event type
-      sig do
-        returns(Dodopayments::LicenseKeyCreatedWebhookEvent::Type::TaggedSymbol)
-      end
+      sig { returns(Symbol) }
       attr_accessor :type
 
       sig do
@@ -36,7 +34,7 @@ module Dodopayments
           business_id: String,
           data: Dodopayments::LicenseKey::OrHash,
           timestamp: Time,
-          type: Dodopayments::LicenseKeyCreatedWebhookEvent::Type::OrSymbol
+          type: Symbol
         ).returns(T.attached_class)
       end
       def self.new(
@@ -46,7 +44,7 @@ module Dodopayments
         # The timestamp of when the event occurred
         timestamp:,
         # The event type
-        type:
+        type: :"license_key.created"
       )
       end
 
@@ -56,40 +54,12 @@ module Dodopayments
             business_id: String,
             data: Dodopayments::LicenseKey,
             timestamp: Time,
-            type:
-              Dodopayments::LicenseKeyCreatedWebhookEvent::Type::TaggedSymbol
+            type: Symbol
           }
         )
       end
       def to_hash
       end
-
-      # The event type
-      module Type
-        extend Dodopayments::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, Dodopayments::LicenseKeyCreatedWebhookEvent::Type)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        LICENSE_KEY_CREATED =
-          T.let(
-            :"license_key.created",
-            Dodopayments::LicenseKeyCreatedWebhookEvent::Type::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              Dodopayments::LicenseKeyCreatedWebhookEvent::Type::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
     end
   end
 end

data/rbi/dodopayments/models/payment.rbi

@@ -106,10 +106,14 @@ module Dodopayments
       sig { returns(T.nilable(T::Array[Dodopayments::CustomFieldResponse])) }
       attr_accessor :custom_field_responses
 
-      # The discount id if discount is applied
+      # DEPRECATED: Use discounts instead. Returns the first discount's ID if present.
       sig { returns(T.nilable(String)) }
       attr_accessor :discount_id
 
+      # All stacked discounts applied, ordered by position
+      sig { returns(T.nilable(T::Array[Dodopayments::Payment::Discount])) }
+      attr_accessor :discounts
+
       # An error code if the payment failed
       sig { returns(T.nilable(String)) }
       attr_accessor :error_code
@@ -196,6 +200,8 @@ module Dodopayments
           custom_field_responses:
             T.nilable(T::Array[Dodopayments::CustomFieldResponse::OrHash]),
           discount_id: T.nilable(String),
+          discounts:
+            T.nilable(T::Array[Dodopayments::Payment::Discount::OrHash]),
           error_code: T.nilable(String),
           error_message: T.nilable(String),
           invoice_id: T.nilable(String),
@@ -262,8 +268,10 @@ module Dodopayments
         checkout_session_id: nil,
         # Customer's responses to custom fields collected during checkout
         custom_field_responses: nil,
-        # The discount id if discount is applied
+        # DEPRECATED: Use discounts instead. Returns the first discount's ID if present.
         discount_id: nil,
+        # All stacked discounts applied, ordered by position
+        discounts: nil,
         # An error code if the payment failed
         error_code: nil,
         # An error message if the payment failed
@@ -325,6 +333,7 @@ module Dodopayments
             custom_field_responses:
               T.nilable(T::Array[Dodopayments::CustomFieldResponse]),
             discount_id: T.nilable(String),
+            discounts: T.nilable(T::Array[Dodopayments::Payment::Discount]),
             error_code: T.nilable(String),
             error_message: T.nilable(String),
             invoice_id: T.nilable(String),
@@ -347,6 +356,165 @@ module Dodopayments
       def to_hash
       end
 
+      class Discount < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Payment::Discount,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # The discount amount (basis points for percentage, USD cents for flat)
+        sig { returns(Integer) }
+        attr_accessor :amount
+
+        # The business this discount belongs to
+        sig { returns(String) }
+        attr_accessor :business_id
+
+        # The discount code
+        sig { returns(String) }
+        attr_accessor :code
+
+        # Timestamp when the discount was created
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # The unique discount ID
+        sig { returns(String) }
+        attr_accessor :discount_id
+
+        # Additional metadata
+        sig { returns(T::Hash[Symbol, String]) }
+        attr_accessor :metadata
+
+        # Position of this discount in the stack (0-based)
+        sig { returns(Integer) }
+        attr_accessor :position
+
+        # Whether this discount should be preserved when a subscription changes plans
+        sig { returns(T::Boolean) }
+        attr_accessor :preserve_on_plan_change
+
+        # List of product IDs to which this discount is restricted
+        sig { returns(T::Array[String]) }
+        attr_accessor :restricted_to
+
+        # How many times this discount has been used
+        sig { returns(Integer) }
+        attr_accessor :times_used
+
+        # The type of discount
+        sig { returns(Dodopayments::DiscountType::TaggedSymbol) }
+        attr_accessor :type
+
+        # Remaining billing cycles for this discount on this subscription (None for
+        # one-time payments)
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :cycles_remaining
+
+        # Optional date/time after which discount is expired
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :expires_at
+
+        # Name for the Discount
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # Number of subscription billing cycles this discount is valid for
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :subscription_cycles
+
+        # Usage limit for this discount, if any
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :usage_limit
+
+        # Response struct for a discount with its position in a stack and optional
+        # cycle-tracking information (for subscriptions).
+        sig do
+          params(
+            amount: Integer,
+            business_id: String,
+            code: String,
+            created_at: Time,
+            discount_id: String,
+            metadata: T::Hash[Symbol, String],
+            position: Integer,
+            preserve_on_plan_change: T::Boolean,
+            restricted_to: T::Array[String],
+            times_used: Integer,
+            type: Dodopayments::DiscountType::OrSymbol,
+            cycles_remaining: T.nilable(Integer),
+            expires_at: T.nilable(Time),
+            name: T.nilable(String),
+            subscription_cycles: T.nilable(Integer),
+            usage_limit: T.nilable(Integer)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The discount amount (basis points for percentage, USD cents for flat)
+          amount:,
+          # The business this discount belongs to
+          business_id:,
+          # The discount code
+          code:,
+          # Timestamp when the discount was created
+          created_at:,
+          # The unique discount ID
+          discount_id:,
+          # Additional metadata
+          metadata:,
+          # Position of this discount in the stack (0-based)
+          position:,
+          # Whether this discount should be preserved when a subscription changes plans
+          preserve_on_plan_change:,
+          # List of product IDs to which this discount is restricted
+          restricted_to:,
+          # How many times this discount has been used
+          times_used:,
+          # The type of discount
+          type:,
+          # Remaining billing cycles for this discount on this subscription (None for
+          # one-time payments)
+          cycles_remaining: nil,
+          # Optional date/time after which discount is expired
+          expires_at: nil,
+          # Name for the Discount
+          name: nil,
+          # Number of subscription billing cycles this discount is valid for
+          subscription_cycles: nil,
+          # Usage limit for this discount, if any
+          usage_limit: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              amount: Integer,
+              business_id: String,
+              code: String,
+              created_at: Time,
+              discount_id: String,
+              metadata: T::Hash[Symbol, String],
+              position: Integer,
+              preserve_on_plan_change: T::Boolean,
+              restricted_to: T::Array[String],
+              times_used: Integer,
+              type: Dodopayments::DiscountType::TaggedSymbol,
+              cycles_remaining: T.nilable(Integer),
+              expires_at: T.nilable(Time),
+              name: T.nilable(String),
+              subscription_cycles: T.nilable(Integer),
+              usage_limit: T.nilable(Integer)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
       class ProductCart < Dodopayments::Internal::Type::BaseModel
         OrHash =
           T.type_alias do