dodopayments 2.8.1 → 2.9.1

data/rbi/dodopayments/models/digital_product_delivery_file.rbi

@@ -11,25 +11,68 @@ module Dodopayments
           )
         end
 
+      # Short-lived presigned URL for downloading the file.
       sig { returns(String) }
-      attr_accessor :file_id
+      attr_accessor :download_url
+
+      # Seconds until `download_url` expires.
+      sig { returns(Integer) }
+      attr_accessor :expires_in
 
+      # Identifier of the attached file.
       sig { returns(String) }
-      attr_accessor :file_name
+      attr_accessor :file_id
 
+      # Original filename of the attached file.
       sig { returns(String) }
-      attr_accessor :url
+      attr_accessor :filename
+
+      # 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 digital-product delivery payload.
       sig do
-        params(file_id: String, file_name: String, url: String).returns(
-          T.attached_class
-        )
+        params(
+          download_url: String,
+          expires_in: Integer,
+          file_id: String,
+          filename: String,
+          content_type: T.nilable(String),
+          file_size: T.nilable(Integer)
+        ).returns(T.attached_class)
       end
-      def self.new(file_id:, file_name:, url:)
+      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:,
+        # Optional content-type declared at upload.
+        content_type: nil,
+        # Optional size of the file in bytes.
+        file_size: nil
+      )
       end
 
       sig do
-        override.returns({ file_id: String, file_name: String, url: String })
+        override.returns(
+          {
+            download_url: String,
+            expires_in: Integer,
+            file_id: String,
+            filename: String,
+            content_type: T.nilable(String),
+            file_size: T.nilable(Integer)
+          }
+        )
       end
       def to_hash
       end

data/rbi/dodopayments/models/entitlement.rbi

@@ -0,0 +1,127 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class Entitlement < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Dodopayments::Entitlement, Dodopayments::Internal::AnyHash)
+        end
+
+      # Unique identifier of the entitlement.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Identifier of the business that owns this entitlement.
+      sig { returns(String) }
+      attr_accessor :business_id
+
+      # Timestamp when the entitlement was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # Integration-specific configuration. For `digital_files` entitlements this
+      # includes presigned download URLs for each attached file.
+      sig { returns(Dodopayments::IntegrationConfigResponse::Variants) }
+      attr_accessor :integration_config
+
+      # Platform integration this entitlement uses.
+      sig { returns(Dodopayments::EntitlementIntegrationType::TaggedSymbol) }
+      attr_accessor :integration_type
+
+      # Always `true` for entitlements returned by the public API; soft-deleted
+      # entitlements are not returned.
+      sig { returns(T::Boolean) }
+      attr_accessor :is_active
+
+      # Arbitrary key-value metadata supplied at creation or via PATCH.
+      sig { returns(T::Hash[Symbol, String]) }
+      attr_accessor :metadata
+
+      # Display name supplied at creation.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Timestamp when the entitlement was last modified.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # Optional description supplied at creation.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # Detailed view of a single entitlement: identity, integration type,
+      # integration-specific configuration, and metadata.
+      sig do
+        params(
+          id: String,
+          business_id: String,
+          created_at: Time,
+          integration_config:
+            T.any(
+              Dodopayments::IntegrationConfigResponse::GitHubConfig::OrHash,
+              Dodopayments::IntegrationConfigResponse::DiscordConfig::OrHash,
+              Dodopayments::IntegrationConfigResponse::TelegramConfig::OrHash,
+              Dodopayments::IntegrationConfigResponse::FigmaConfig::OrHash,
+              Dodopayments::IntegrationConfigResponse::FramerConfig::OrHash,
+              Dodopayments::IntegrationConfigResponse::NotionConfig::OrHash,
+              Dodopayments::IntegrationConfigResponse::DigitalFilesConfig::OrHash,
+              Dodopayments::IntegrationConfigResponse::LicenseKeyConfig::OrHash
+            ),
+          integration_type: Dodopayments::EntitlementIntegrationType::OrSymbol,
+          is_active: T::Boolean,
+          metadata: T::Hash[Symbol, String],
+          name: String,
+          updated_at: Time,
+          description: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier of the entitlement.
+        id:,
+        # Identifier of the business that owns this entitlement.
+        business_id:,
+        # Timestamp when the entitlement was created.
+        created_at:,
+        # Integration-specific configuration. For `digital_files` entitlements this
+        # includes presigned download URLs for each attached file.
+        integration_config:,
+        # Platform integration this entitlement uses.
+        integration_type:,
+        # Always `true` for entitlements returned by the public API; soft-deleted
+        # entitlements are not returned.
+        is_active:,
+        # Arbitrary key-value metadata supplied at creation or via PATCH.
+        metadata:,
+        # Display name supplied at creation.
+        name:,
+        # Timestamp when the entitlement was last modified.
+        updated_at:,
+        # Optional description supplied at creation.
+        description: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            business_id: String,
+            created_at: Time,
+            integration_config:
+              Dodopayments::IntegrationConfigResponse::Variants,
+            integration_type:
+              Dodopayments::EntitlementIntegrationType::TaggedSymbol,
+            is_active: T::Boolean,
+            metadata: T::Hash[Symbol, String],
+            name: String,
+            updated_at: Time,
+            description: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/entitlement_create_params.rbi

@@ -0,0 +1,115 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class EntitlementCreateParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::EntitlementCreateParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # Platform-specific configuration (validated per integration_type)
+      sig do
+        returns(
+          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
+      attr_accessor :integration_config
+
+      # Which platform integration this entitlement uses
+      sig { returns(Dodopayments::EntitlementIntegrationType::OrSymbol) }
+      attr_accessor :integration_type
+
+      # Display name for this entitlement
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Optional description
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # Additional metadata for the entitlement
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
+      sig do
+        params(
+          integration_config:
+            T.any(
+              Dodopayments::IntegrationConfig::GitHubConfig::OrHash,
+              Dodopayments::IntegrationConfig::DiscordConfig::OrHash,
+              Dodopayments::IntegrationConfig::TelegramConfig::OrHash,
+              Dodopayments::IntegrationConfig::FigmaConfig::OrHash,
+              Dodopayments::IntegrationConfig::FramerConfig::OrHash,
+              Dodopayments::IntegrationConfig::NotionConfig::OrHash,
+              Dodopayments::IntegrationConfig::DigitalFilesConfig::OrHash,
+              Dodopayments::IntegrationConfig::LicenseKeyConfig::OrHash
+            ),
+          integration_type: Dodopayments::EntitlementIntegrationType::OrSymbol,
+          name: String,
+          description: T.nilable(String),
+          metadata: T::Hash[Symbol, String],
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Platform-specific configuration (validated per integration_type)
+        integration_config:,
+        # Which platform integration this entitlement uses
+        integration_type:,
+        # Display name for this entitlement
+        name:,
+        # Optional description
+        description: nil,
+        # Additional metadata for the entitlement
+        metadata: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            integration_config:
+              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
+              ),
+            integration_type:
+              Dodopayments::EntitlementIntegrationType::OrSymbol,
+            name: String,
+            description: T.nilable(String),
+            metadata: T::Hash[Symbol, String],
+            request_options: Dodopayments::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/entitlement_delete_params.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class EntitlementDeleteParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::EntitlementDeleteParams,
+            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

data/rbi/dodopayments/models/entitlement_grant_created_webhook_event.rbi

@@ -0,0 +1,107 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class EntitlementGrantCreatedWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::EntitlementGrantCreatedWebhookEvent,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # The business identifier
+      sig { returns(String) }
+      attr_accessor :business_id
+
+      # Detailed view of a single entitlement grant: who it's for, its lifecycle state,
+      # and any integration-specific delivery payload.
+      sig { returns(Dodopayments::Entitlements::EntitlementGrant) }
+      attr_reader :data
+
+      sig do
+        params(data: Dodopayments::Entitlements::EntitlementGrant::OrHash).void
+      end
+      attr_writer :data
+
+      # The timestamp of when the event occurred
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The event type
+      sig do
+        returns(
+          Dodopayments::EntitlementGrantCreatedWebhookEvent::Type::TaggedSymbol
+        )
+      end
+      attr_accessor :type
+
+      sig do
+        params(
+          business_id: String,
+          data: Dodopayments::Entitlements::EntitlementGrant::OrHash,
+          timestamp: Time,
+          type:
+            Dodopayments::EntitlementGrantCreatedWebhookEvent::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The business identifier
+        business_id:,
+        # Detailed view of a single entitlement grant: who it's for, its lifecycle state,
+        # and any integration-specific delivery payload.
+        data:,
+        # The timestamp of when the event occurred
+        timestamp:,
+        # The event type
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            business_id: String,
+            data: Dodopayments::Entitlements::EntitlementGrant,
+            timestamp: Time,
+            type:
+              Dodopayments::EntitlementGrantCreatedWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The event type
+      module Type
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Dodopayments::EntitlementGrantCreatedWebhookEvent::Type
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ENTITLEMENT_GRANT_CREATED =
+          T.let(
+            :"entitlement_grant.created",
+            Dodopayments::EntitlementGrantCreatedWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::EntitlementGrantCreatedWebhookEvent::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/entitlement_grant_delivered_webhook_event.rbi

@@ -0,0 +1,107 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class EntitlementGrantDeliveredWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::EntitlementGrantDeliveredWebhookEvent,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # The business identifier
+      sig { returns(String) }
+      attr_accessor :business_id
+
+      # Detailed view of a single entitlement grant: who it's for, its lifecycle state,
+      # and any integration-specific delivery payload.
+      sig { returns(Dodopayments::Entitlements::EntitlementGrant) }
+      attr_reader :data
+
+      sig do
+        params(data: Dodopayments::Entitlements::EntitlementGrant::OrHash).void
+      end
+      attr_writer :data
+
+      # The timestamp of when the event occurred
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The event type
+      sig do
+        returns(
+          Dodopayments::EntitlementGrantDeliveredWebhookEvent::Type::TaggedSymbol
+        )
+      end
+      attr_accessor :type
+
+      sig do
+        params(
+          business_id: String,
+          data: Dodopayments::Entitlements::EntitlementGrant::OrHash,
+          timestamp: Time,
+          type:
+            Dodopayments::EntitlementGrantDeliveredWebhookEvent::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The business identifier
+        business_id:,
+        # Detailed view of a single entitlement grant: who it's for, its lifecycle state,
+        # and any integration-specific delivery payload.
+        data:,
+        # The timestamp of when the event occurred
+        timestamp:,
+        # The event type
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            business_id: String,
+            data: Dodopayments::Entitlements::EntitlementGrant,
+            timestamp: Time,
+            type:
+              Dodopayments::EntitlementGrantDeliveredWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The event type
+      module Type
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Dodopayments::EntitlementGrantDeliveredWebhookEvent::Type
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ENTITLEMENT_GRANT_DELIVERED =
+          T.let(
+            :"entitlement_grant.delivered",
+            Dodopayments::EntitlementGrantDeliveredWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::EntitlementGrantDeliveredWebhookEvent::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/entitlement_grant_failed_webhook_event.rbi

@@ -0,0 +1,106 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class EntitlementGrantFailedWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::EntitlementGrantFailedWebhookEvent,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # The business identifier
+      sig { returns(String) }
+      attr_accessor :business_id
+
+      # Detailed view of a single entitlement grant: who it's for, its lifecycle state,
+      # and any integration-specific delivery payload.
+      sig { returns(Dodopayments::Entitlements::EntitlementGrant) }
+      attr_reader :data
+
+      sig do
+        params(data: Dodopayments::Entitlements::EntitlementGrant::OrHash).void
+      end
+      attr_writer :data
+
+      # The timestamp of when the event occurred
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The event type
+      sig do
+        returns(
+          Dodopayments::EntitlementGrantFailedWebhookEvent::Type::TaggedSymbol
+        )
+      end
+      attr_accessor :type
+
+      sig do
+        params(
+          business_id: String,
+          data: Dodopayments::Entitlements::EntitlementGrant::OrHash,
+          timestamp: Time,
+          type: Dodopayments::EntitlementGrantFailedWebhookEvent::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The business identifier
+        business_id:,
+        # Detailed view of a single entitlement grant: who it's for, its lifecycle state,
+        # and any integration-specific delivery payload.
+        data:,
+        # The timestamp of when the event occurred
+        timestamp:,
+        # The event type
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            business_id: String,
+            data: Dodopayments::Entitlements::EntitlementGrant,
+            timestamp: Time,
+            type:
+              Dodopayments::EntitlementGrantFailedWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The event type
+      module Type
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Dodopayments::EntitlementGrantFailedWebhookEvent::Type
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ENTITLEMENT_GRANT_FAILED =
+          T.let(
+            :"entitlement_grant.failed",
+            Dodopayments::EntitlementGrantFailedWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::EntitlementGrantFailedWebhookEvent::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end