dodopayments 2.8.0 → 2.9.0

data/rbi/dodopayments/models/entitlements/file_delete_params.rbi

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

data/rbi/dodopayments/models/entitlements/file_upload_params.rbi

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

data/rbi/dodopayments/models/entitlements/file_upload_response.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Entitlements
+      class FileUploadResponse < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Models::Entitlements::FileUploadResponse,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # EE-issued digital file id; appended to
+        # `entitlements.integration_config.digital_file_ids`.
+        sig { returns(String) }
+        attr_accessor :file_id
+
+        sig { params(file_id: String).returns(T.attached_class) }
+        def self.new(
+          # EE-issued digital file id; appended to
+          # `entitlements.integration_config.digital_file_ids`.
+          file_id:
+        )
+        end
+
+        sig { override.returns({ file_id: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/entitlements/grant_list_params.rbi

@@ -0,0 +1,145 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Entitlements
+      class GrantListParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Entitlements::GrantListParams,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Filter by customer ID
+        sig { returns(T.nilable(String)) }
+        attr_reader :customer_id
+
+        sig { params(customer_id: String).void }
+        attr_writer :customer_id
+
+        # Page number (default 0)
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_number
+
+        sig { params(page_number: Integer).void }
+        attr_writer :page_number
+
+        # Page size (default 10, max 100)
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_size
+
+        sig { params(page_size: Integer).void }
+        attr_writer :page_size
+
+        # Filter by grant status
+        sig do
+          returns(
+            T.nilable(
+              Dodopayments::Entitlements::GrantListParams::Status::OrSymbol
+            )
+          )
+        end
+        attr_reader :status
+
+        sig do
+          params(
+            status:
+              Dodopayments::Entitlements::GrantListParams::Status::OrSymbol
+          ).void
+        end
+        attr_writer :status
+
+        sig do
+          params(
+            id: String,
+            customer_id: String,
+            page_number: Integer,
+            page_size: Integer,
+            status:
+              Dodopayments::Entitlements::GrantListParams::Status::OrSymbol,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # Filter by customer ID
+          customer_id: nil,
+          # Page number (default 0)
+          page_number: nil,
+          # Page size (default 10, max 100)
+          page_size: nil,
+          # Filter by grant status
+          status: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              customer_id: String,
+              page_number: Integer,
+              page_size: Integer,
+              status:
+                Dodopayments::Entitlements::GrantListParams::Status::OrSymbol,
+              request_options: Dodopayments::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Filter by grant status
+        module Status
+          extend Dodopayments::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Dodopayments::Entitlements::GrantListParams::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PENDING =
+            T.let(
+              :Pending,
+              Dodopayments::Entitlements::GrantListParams::Status::TaggedSymbol
+            )
+          DELIVERED =
+            T.let(
+              :Delivered,
+              Dodopayments::Entitlements::GrantListParams::Status::TaggedSymbol
+            )
+          FAILED =
+            T.let(
+              :Failed,
+              Dodopayments::Entitlements::GrantListParams::Status::TaggedSymbol
+            )
+          REVOKED =
+            T.let(
+              :Revoked,
+              Dodopayments::Entitlements::GrantListParams::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Dodopayments::Entitlements::GrantListParams::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/entitlements/grant_revoke_params.rbi

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

data/rbi/dodopayments/models/entitlements/license_key_grant.rbi

@@ -0,0 +1,62 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Entitlements
+      class LicenseKeyGrant < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Entitlements::LicenseKeyGrant,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Integer) }
+        attr_accessor :activations_used
+
+        sig { returns(String) }
+        attr_accessor :key
+
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :activations_limit
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :expires_at
+
+        # Nested representation of license-key grant fields. Present only when the grant's
+        # entitlement has `integration_type = 'license_key'` and a row exists in
+        # `license_keys`. The grant's top-level `status` is the source of truth for the
+        # grant's lifecycle — no per-license-key status is exposed here.
+        sig do
+          params(
+            activations_used: Integer,
+            key: String,
+            activations_limit: T.nilable(Integer),
+            expires_at: T.nilable(Time)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          activations_used:,
+          key:,
+          activations_limit: nil,
+          expires_at: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              activations_used: Integer,
+              key: String,
+              activations_limit: T.nilable(Integer),
+              expires_at: T.nilable(Time)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/integration_config.rbi

@@ -0,0 +1,296 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    # 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::IntegrationConfig::GitHubConfig,
+            Dodopayments::IntegrationConfig::DiscordConfig,
+            Dodopayments::IntegrationConfig::TelegramConfig,
+            Dodopayments::IntegrationConfig::FigmaConfig,
+            Dodopayments::IntegrationConfig::FramerConfig,
+            Dodopayments::IntegrationConfig::NotionConfig,
+            Dodopayments::IntegrationConfig::DigitalFilesConfig,
+            Dodopayments::IntegrationConfig::LicenseKeyConfig
+          )
+        end
+
+      class GitHubConfig < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::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::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::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::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::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::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::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
+
+        # Three-way patchable field (mirrors the credit_entitlements pattern):
+        #
+        # - omitted → preserve persisted (`None`)
+        # - `null` → clear (`Some(None)`)
+        # - `[...]` → replace (`Some(Some(...))`)
+        #
+        # On Create / storage we collapse "clear" and empty-array to `None` so the
+        # persisted JSONB never carries a `null` legacy_file_ids key.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :legacy_file_ids
+
+        sig do
+          params(
+            digital_file_ids: T::Array[String],
+            external_url: T.nilable(String),
+            instructions: T.nilable(String),
+            legacy_file_ids: T.nilable(T::Array[String])
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          digital_file_ids:,
+          external_url: nil,
+          instructions: nil,
+          # Three-way patchable field (mirrors the credit_entitlements pattern):
+          #
+          # - omitted → preserve persisted (`None`)
+          # - `null` → clear (`Some(None)`)
+          # - `[...]` → replace (`Some(Some(...))`)
+          #
+          # On Create / storage we collapse "clear" and empty-array to `None` so the
+          # persisted JSONB never carries a `null` legacy_file_ids key.
+          legacy_file_ids: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              digital_file_ids: T::Array[String],
+              external_url: T.nilable(String),
+              instructions: T.nilable(String),
+              legacy_file_ids: T.nilable(T::Array[String])
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class LicenseKeyConfig < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::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(Dodopayments::TimeInterval::OrSymbol)) }
+        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::OrSymbol)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      sig do
+        override.returns(T::Array[Dodopayments::IntegrationConfig::Variants])
+      end
+      def self.variants
+      end
+    end
+  end
+end