dodopayments 2.8.0 → 2.9.0

data/rbi/dodopayments/models/entitlement_grant_revoked_webhook_event.rbi

@@ -0,0 +1,103 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class EntitlementGrantRevokedWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::EntitlementGrantRevokedWebhookEvent,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # The business identifier
+      sig { returns(String) }
+      attr_accessor :business_id
+
+      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::EntitlementGrantRevokedWebhookEvent::Type::TaggedSymbol
+        )
+      end
+      attr_accessor :type
+
+      sig do
+        params(
+          business_id: String,
+          data: Dodopayments::Entitlements::EntitlementGrant::OrHash,
+          timestamp: Time,
+          type:
+            Dodopayments::EntitlementGrantRevokedWebhookEvent::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The business identifier
+        business_id:,
+        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::EntitlementGrantRevokedWebhookEvent::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::EntitlementGrantRevokedWebhookEvent::Type
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ENTITLEMENT_GRANT_REVOKED =
+          T.let(
+            :"entitlement_grant.revoked",
+            Dodopayments::EntitlementGrantRevokedWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::EntitlementGrantRevokedWebhookEvent::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/entitlement_integration_type.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module EntitlementIntegrationType
+      extend Dodopayments::Internal::Type::Enum
+
+      TaggedSymbol =
+        T.type_alias { T.all(Symbol, Dodopayments::EntitlementIntegrationType) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      DISCORD =
+        T.let(:discord, Dodopayments::EntitlementIntegrationType::TaggedSymbol)
+      TELEGRAM =
+        T.let(:telegram, Dodopayments::EntitlementIntegrationType::TaggedSymbol)
+      GITHUB =
+        T.let(:github, Dodopayments::EntitlementIntegrationType::TaggedSymbol)
+      FIGMA =
+        T.let(:figma, Dodopayments::EntitlementIntegrationType::TaggedSymbol)
+      FRAMER =
+        T.let(:framer, Dodopayments::EntitlementIntegrationType::TaggedSymbol)
+      NOTION =
+        T.let(:notion, Dodopayments::EntitlementIntegrationType::TaggedSymbol)
+      DIGITAL_FILES =
+        T.let(
+          :digital_files,
+          Dodopayments::EntitlementIntegrationType::TaggedSymbol
+        )
+      LICENSE_KEY =
+        T.let(
+          :license_key,
+          Dodopayments::EntitlementIntegrationType::TaggedSymbol
+        )
+
+      sig do
+        override.returns(
+          T::Array[Dodopayments::EntitlementIntegrationType::TaggedSymbol]
+        )
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/entitlement_list_params.rbi

@@ -0,0 +1,146 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class EntitlementListParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::EntitlementListParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # Filter by integration type
+      sig do
+        returns(
+          T.nilable(
+            Dodopayments::EntitlementListParams::IntegrationType::OrSymbol
+          )
+        )
+      end
+      attr_reader :integration_type
+
+      sig do
+        params(
+          integration_type:
+            Dodopayments::EntitlementListParams::IntegrationType::OrSymbol
+        ).void
+      end
+      attr_writer :integration_type
+
+      # 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
+
+      sig do
+        params(
+          integration_type:
+            Dodopayments::EntitlementListParams::IntegrationType::OrSymbol,
+          page_number: Integer,
+          page_size: Integer,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Filter by integration type
+        integration_type: nil,
+        # Page number (default 0)
+        page_number: nil,
+        # Page size (default 10, max 100)
+        page_size: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            integration_type:
+              Dodopayments::EntitlementListParams::IntegrationType::OrSymbol,
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Dodopayments::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Filter by integration type
+      module IntegrationType
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Dodopayments::EntitlementListParams::IntegrationType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DISCORD =
+          T.let(
+            :discord,
+            Dodopayments::EntitlementListParams::IntegrationType::TaggedSymbol
+          )
+        TELEGRAM =
+          T.let(
+            :telegram,
+            Dodopayments::EntitlementListParams::IntegrationType::TaggedSymbol
+          )
+        GITHUB =
+          T.let(
+            :github,
+            Dodopayments::EntitlementListParams::IntegrationType::TaggedSymbol
+          )
+        FIGMA =
+          T.let(
+            :figma,
+            Dodopayments::EntitlementListParams::IntegrationType::TaggedSymbol
+          )
+        FRAMER =
+          T.let(
+            :framer,
+            Dodopayments::EntitlementListParams::IntegrationType::TaggedSymbol
+          )
+        NOTION =
+          T.let(
+            :notion,
+            Dodopayments::EntitlementListParams::IntegrationType::TaggedSymbol
+          )
+        DIGITAL_FILES =
+          T.let(
+            :digital_files,
+            Dodopayments::EntitlementListParams::IntegrationType::TaggedSymbol
+          )
+        LICENSE_KEY =
+          T.let(
+            :license_key,
+            Dodopayments::EntitlementListParams::IntegrationType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::EntitlementListParams::IntegrationType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/entitlement_retrieve_params.rbi

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

@@ -0,0 +1,111 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class EntitlementUpdateParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::EntitlementUpdateParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # Platform-specific configuration for an entitlement. Each variant uses unique
+      # field names so `#[serde(untagged)]` can disambiguate correctly.
+      sig do
+        returns(
+          T.nilable(
+            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
+
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_accessor :metadata
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      sig do
+        params(
+          id: String,
+          description: T.nilable(String),
+          integration_config:
+            T.nilable(
+              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
+              )
+            ),
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          name: T.nilable(String),
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        description: nil,
+        # Platform-specific configuration for an entitlement. Each variant uses unique
+        # field names so `#[serde(untagged)]` can disambiguate correctly.
+        integration_config: nil,
+        metadata: nil,
+        name: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            description: T.nilable(String),
+            integration_config:
+              T.nilable(
+                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
+                )
+              ),
+            metadata: T.nilable(T::Hash[Symbol, String]),
+            name: T.nilable(String),
+            request_options: Dodopayments::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/entitlements/entitlement_grant.rbi

@@ -0,0 +1,235 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    EntitlementGrant = Entitlements::EntitlementGrant
+
+    module Entitlements
+      class EntitlementGrant < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Entitlements::EntitlementGrant,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :business_id
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        sig { returns(String) }
+        attr_accessor :entitlement_id
+
+        sig { returns(String) }
+        attr_accessor :external_id
+
+        sig do
+          returns(
+            Dodopayments::Entitlements::EntitlementGrant::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        sig { returns(Time) }
+        attr_accessor :updated_at
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :delivered_at
+
+        # Present only when the entitlement integration_type is `digital_files`. Populated
+        # eagerly on every list and single-record endpoint.
+        sig { returns(T.nilable(Dodopayments::DigitalProductDelivery)) }
+        attr_reader :digital_product_delivery
+
+        sig do
+          params(
+            digital_product_delivery:
+              T.nilable(Dodopayments::DigitalProductDelivery::OrHash)
+          ).void
+        end
+        attr_writer :digital_product_delivery
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :error_code
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :error_message
+
+        # Present only when the entitlement integration_type is `license_key`.
+        sig { returns(T.nilable(Dodopayments::Entitlements::LicenseKeyGrant)) }
+        attr_reader :license_key
+
+        sig do
+          params(
+            license_key:
+              T.nilable(Dodopayments::Entitlements::LicenseKeyGrant::OrHash)
+          ).void
+        end
+        attr_writer :license_key
+
+        sig { returns(T.nilable(T.anything)) }
+        attr_reader :metadata
+
+        sig { params(metadata: T.anything).void }
+        attr_writer :metadata
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :oauth_expires_at
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :oauth_url
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_id
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :revocation_reason
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :revoked_at
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :subscription_id
+
+        sig do
+          params(
+            id: String,
+            business_id: String,
+            created_at: Time,
+            customer_id: String,
+            entitlement_id: String,
+            external_id: String,
+            status:
+              Dodopayments::Entitlements::EntitlementGrant::Status::OrSymbol,
+            updated_at: Time,
+            delivered_at: T.nilable(Time),
+            digital_product_delivery:
+              T.nilable(Dodopayments::DigitalProductDelivery::OrHash),
+            error_code: T.nilable(String),
+            error_message: T.nilable(String),
+            license_key:
+              T.nilable(Dodopayments::Entitlements::LicenseKeyGrant::OrHash),
+            metadata: T.anything,
+            oauth_expires_at: T.nilable(Time),
+            oauth_url: T.nilable(String),
+            payment_id: T.nilable(String),
+            revocation_reason: T.nilable(String),
+            revoked_at: T.nilable(Time),
+            subscription_id: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          business_id:,
+          created_at:,
+          customer_id:,
+          entitlement_id:,
+          external_id:,
+          status:,
+          updated_at:,
+          delivered_at: nil,
+          # Present only when the entitlement integration_type is `digital_files`. Populated
+          # eagerly on every list and single-record endpoint.
+          digital_product_delivery: nil,
+          error_code: nil,
+          error_message: nil,
+          # Present only when the entitlement integration_type is `license_key`.
+          license_key: nil,
+          metadata: nil,
+          oauth_expires_at: nil,
+          oauth_url: nil,
+          payment_id: nil,
+          revocation_reason: nil,
+          revoked_at: nil,
+          subscription_id: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              business_id: String,
+              created_at: Time,
+              customer_id: String,
+              entitlement_id: String,
+              external_id: String,
+              status:
+                Dodopayments::Entitlements::EntitlementGrant::Status::TaggedSymbol,
+              updated_at: Time,
+              delivered_at: T.nilable(Time),
+              digital_product_delivery:
+                T.nilable(Dodopayments::DigitalProductDelivery),
+              error_code: T.nilable(String),
+              error_message: T.nilable(String),
+              license_key:
+                T.nilable(Dodopayments::Entitlements::LicenseKeyGrant),
+              metadata: T.anything,
+              oauth_expires_at: T.nilable(Time),
+              oauth_url: T.nilable(String),
+              payment_id: T.nilable(String),
+              revocation_reason: T.nilable(String),
+              revoked_at: T.nilable(Time),
+              subscription_id: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Status
+          extend Dodopayments::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Dodopayments::Entitlements::EntitlementGrant::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PENDING =
+            T.let(
+              :Pending,
+              Dodopayments::Entitlements::EntitlementGrant::Status::TaggedSymbol
+            )
+          DELIVERED =
+            T.let(
+              :Delivered,
+              Dodopayments::Entitlements::EntitlementGrant::Status::TaggedSymbol
+            )
+          FAILED =
+            T.let(
+              :Failed,
+              Dodopayments::Entitlements::EntitlementGrant::Status::TaggedSymbol
+            )
+          REVOKED =
+            T.let(
+              :Revoked,
+              Dodopayments::Entitlements::EntitlementGrant::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Dodopayments::Entitlements::EntitlementGrant::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end