dodopayments 2.8.0 → 2.9.0

data/sig/dodopayments/models/entitlement_list_params.rbs

@@ -0,0 +1,69 @@
+module Dodopayments
+  module Models
+    type entitlement_list_params =
+      {
+        integration_type: Dodopayments::Models::EntitlementListParams::integration_type,
+        page_number: Integer,
+        page_size: Integer
+      }
+      & Dodopayments::Internal::Type::request_parameters
+
+    class EntitlementListParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      attr_reader integration_type: Dodopayments::Models::EntitlementListParams::integration_type?
+
+      def integration_type=: (
+        Dodopayments::Models::EntitlementListParams::integration_type
+      ) -> Dodopayments::Models::EntitlementListParams::integration_type
+
+      attr_reader page_number: Integer?
+
+      def page_number=: (Integer) -> Integer
+
+      attr_reader page_size: Integer?
+
+      def page_size=: (Integer) -> Integer
+
+      def initialize: (
+        ?integration_type: Dodopayments::Models::EntitlementListParams::integration_type,
+        ?page_number: Integer,
+        ?page_size: Integer,
+        ?request_options: Dodopayments::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        integration_type: Dodopayments::Models::EntitlementListParams::integration_type,
+        page_number: Integer,
+        page_size: Integer,
+        request_options: Dodopayments::RequestOptions
+      }
+
+      type integration_type =
+        :discord
+        | :telegram
+        | :github
+        | :figma
+        | :framer
+        | :notion
+        | :digital_files
+        | :license_key
+
+      module IntegrationType
+        extend Dodopayments::Internal::Type::Enum
+
+        DISCORD: :discord
+        TELEGRAM: :telegram
+        GITHUB: :github
+        FIGMA: :figma
+        FRAMER: :framer
+        NOTION: :notion
+        DIGITAL_FILES: :digital_files
+        LICENSE_KEY: :license_key
+
+        def self?.values: -> ::Array[Dodopayments::Models::EntitlementListParams::integration_type]
+      end
+    end
+  end
+end

data/sig/dodopayments/models/entitlement_retrieve_params.rbs

@@ -0,0 +1,23 @@
+module Dodopayments
+  module Models
+    type entitlement_retrieve_params =
+      { id: String } & Dodopayments::Internal::Type::request_parameters
+
+    class EntitlementRetrieveParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      def initialize: (
+        id: String,
+        ?request_options: Dodopayments::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        request_options: Dodopayments::RequestOptions
+      }
+    end
+  end
+end

data/sig/dodopayments/models/entitlement_update_params.rbs

@@ -0,0 +1,46 @@
+module Dodopayments
+  module Models
+    type entitlement_update_params =
+      {
+        id: String,
+        description: String?,
+        integration_config: Dodopayments::Models::integration_config?,
+        metadata: ::Hash[Symbol, String]?,
+        name: String?
+      }
+      & Dodopayments::Internal::Type::request_parameters
+
+    class EntitlementUpdateParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      attr_accessor description: String?
+
+      attr_accessor integration_config: Dodopayments::Models::integration_config?
+
+      attr_accessor metadata: ::Hash[Symbol, String]?
+
+      attr_accessor name: String?
+
+      def initialize: (
+        id: String,
+        ?description: String?,
+        ?integration_config: Dodopayments::Models::integration_config?,
+        ?metadata: ::Hash[Symbol, String]?,
+        ?name: String?,
+        ?request_options: Dodopayments::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        description: String?,
+        integration_config: Dodopayments::Models::integration_config?,
+        metadata: ::Hash[Symbol, String]?,
+        name: String?,
+        request_options: Dodopayments::RequestOptions
+      }
+    end
+  end
+end

data/sig/dodopayments/models/entitlements/entitlement_grant.rbs

@@ -0,0 +1,134 @@
+module Dodopayments
+  module Models
+    class EntitlementGrant = Entitlements::EntitlementGrant
+
+    module Entitlements
+      type entitlement_grant =
+        {
+          id: String,
+          business_id: String,
+          created_at: Time,
+          customer_id: String,
+          entitlement_id: String,
+          external_id: String,
+          status: Dodopayments::Models::Entitlements::EntitlementGrant::status,
+          updated_at: Time,
+          delivered_at: Time?,
+          digital_product_delivery: Dodopayments::DigitalProductDelivery?,
+          error_code: String?,
+          error_message: String?,
+          license_key: Dodopayments::Entitlements::LicenseKeyGrant?,
+          metadata: top,
+          oauth_expires_at: Time?,
+          oauth_url: String?,
+          payment_id: String?,
+          revocation_reason: String?,
+          revoked_at: Time?,
+          subscription_id: String?
+        }
+
+      class EntitlementGrant < Dodopayments::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor business_id: String
+
+        attr_accessor created_at: Time
+
+        attr_accessor customer_id: String
+
+        attr_accessor entitlement_id: String
+
+        attr_accessor external_id: String
+
+        attr_accessor status: Dodopayments::Models::Entitlements::EntitlementGrant::status
+
+        attr_accessor updated_at: Time
+
+        attr_accessor delivered_at: Time?
+
+        attr_accessor digital_product_delivery: Dodopayments::DigitalProductDelivery?
+
+        attr_accessor error_code: String?
+
+        attr_accessor error_message: String?
+
+        attr_accessor license_key: Dodopayments::Entitlements::LicenseKeyGrant?
+
+        attr_reader metadata: top?
+
+        def metadata=: (top) -> top
+
+        attr_accessor oauth_expires_at: Time?
+
+        attr_accessor oauth_url: String?
+
+        attr_accessor payment_id: String?
+
+        attr_accessor revocation_reason: String?
+
+        attr_accessor revoked_at: Time?
+
+        attr_accessor subscription_id: String?
+
+        def initialize: (
+          id: String,
+          business_id: String,
+          created_at: Time,
+          customer_id: String,
+          entitlement_id: String,
+          external_id: String,
+          status: Dodopayments::Models::Entitlements::EntitlementGrant::status,
+          updated_at: Time,
+          ?delivered_at: Time?,
+          ?digital_product_delivery: Dodopayments::DigitalProductDelivery?,
+          ?error_code: String?,
+          ?error_message: String?,
+          ?license_key: Dodopayments::Entitlements::LicenseKeyGrant?,
+          ?metadata: top,
+          ?oauth_expires_at: Time?,
+          ?oauth_url: String?,
+          ?payment_id: String?,
+          ?revocation_reason: String?,
+          ?revoked_at: Time?,
+          ?subscription_id: String?
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          business_id: String,
+          created_at: Time,
+          customer_id: String,
+          entitlement_id: String,
+          external_id: String,
+          status: Dodopayments::Models::Entitlements::EntitlementGrant::status,
+          updated_at: Time,
+          delivered_at: Time?,
+          digital_product_delivery: Dodopayments::DigitalProductDelivery?,
+          error_code: String?,
+          error_message: String?,
+          license_key: Dodopayments::Entitlements::LicenseKeyGrant?,
+          metadata: top,
+          oauth_expires_at: Time?,
+          oauth_url: String?,
+          payment_id: String?,
+          revocation_reason: String?,
+          revoked_at: Time?,
+          subscription_id: String?
+        }
+
+        type status = :Pending | :Delivered | :Failed | :Revoked
+
+        module Status
+          extend Dodopayments::Internal::Type::Enum
+
+          PENDING: :Pending
+          DELIVERED: :Delivered
+          FAILED: :Failed
+          REVOKED: :Revoked
+
+          def self?.values: -> ::Array[Dodopayments::Models::Entitlements::EntitlementGrant::status]
+        end
+      end
+    end
+  end
+end

data/sig/dodopayments/models/entitlements/file_delete_params.rbs

@@ -0,0 +1,30 @@
+module Dodopayments
+  module Models
+    module Entitlements
+      type file_delete_params =
+        { id: String, file_id: String }
+        & Dodopayments::Internal::Type::request_parameters
+
+      class FileDeleteParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_accessor file_id: String
+
+        def initialize: (
+          id: String,
+          file_id: String,
+          ?request_options: Dodopayments::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          file_id: String,
+          request_options: Dodopayments::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/dodopayments/models/entitlements/file_upload_params.rbs

@@ -0,0 +1,25 @@
+module Dodopayments
+  module Models
+    module Entitlements
+      type file_upload_params =
+        { id: String } & Dodopayments::Internal::Type::request_parameters
+
+      class FileUploadParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        def initialize: (
+          id: String,
+          ?request_options: Dodopayments::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          request_options: Dodopayments::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/dodopayments/models/entitlements/file_upload_response.rbs

@@ -0,0 +1,15 @@
+module Dodopayments
+  module Models
+    module Entitlements
+      type file_upload_response = { file_id: String }
+
+      class FileUploadResponse < Dodopayments::Internal::Type::BaseModel
+        attr_accessor file_id: String
+
+        def initialize: (file_id: String) -> void
+
+        def to_hash: -> { file_id: String }
+      end
+    end
+  end
+end

data/sig/dodopayments/models/entitlements/grant_list_params.rbs

@@ -0,0 +1,71 @@
+module Dodopayments
+  module Models
+    module Entitlements
+      type grant_list_params =
+        {
+          id: String,
+          customer_id: String,
+          page_number: Integer,
+          page_size: Integer,
+          status: Dodopayments::Models::Entitlements::GrantListParams::status
+        }
+        & Dodopayments::Internal::Type::request_parameters
+
+      class GrantListParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_reader customer_id: String?
+
+        def customer_id=: (String) -> String
+
+        attr_reader page_number: Integer?
+
+        def page_number=: (Integer) -> Integer
+
+        attr_reader page_size: Integer?
+
+        def page_size=: (Integer) -> Integer
+
+        attr_reader status: Dodopayments::Models::Entitlements::GrantListParams::status?
+
+        def status=: (
+          Dodopayments::Models::Entitlements::GrantListParams::status
+        ) -> Dodopayments::Models::Entitlements::GrantListParams::status
+
+        def initialize: (
+          id: String,
+          ?customer_id: String,
+          ?page_number: Integer,
+          ?page_size: Integer,
+          ?status: Dodopayments::Models::Entitlements::GrantListParams::status,
+          ?request_options: Dodopayments::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          customer_id: String,
+          page_number: Integer,
+          page_size: Integer,
+          status: Dodopayments::Models::Entitlements::GrantListParams::status,
+          request_options: Dodopayments::RequestOptions
+        }
+
+        type status = :Pending | :Delivered | :Failed | :Revoked
+
+        module Status
+          extend Dodopayments::Internal::Type::Enum
+
+          PENDING: :Pending
+          DELIVERED: :Delivered
+          FAILED: :Failed
+          REVOKED: :Revoked
+
+          def self?.values: -> ::Array[Dodopayments::Models::Entitlements::GrantListParams::status]
+        end
+      end
+    end
+  end
+end

data/sig/dodopayments/models/entitlements/grant_revoke_params.rbs

@@ -0,0 +1,30 @@
+module Dodopayments
+  module Models
+    module Entitlements
+      type grant_revoke_params =
+        { id: String, grant_id: String }
+        & Dodopayments::Internal::Type::request_parameters
+
+      class GrantRevokeParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_accessor grant_id: String
+
+        def initialize: (
+          id: String,
+          grant_id: String,
+          ?request_options: Dodopayments::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          grant_id: String,
+          request_options: Dodopayments::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/dodopayments/models/entitlements/license_key_grant.rbs

@@ -0,0 +1,37 @@
+module Dodopayments
+  module Models
+    module Entitlements
+      type license_key_grant =
+        {
+          activations_used: Integer,
+          key: String,
+          activations_limit: Integer?,
+          expires_at: Time?
+        }
+
+      class LicenseKeyGrant < Dodopayments::Internal::Type::BaseModel
+        attr_accessor activations_used: Integer
+
+        attr_accessor key: String
+
+        attr_accessor activations_limit: Integer?
+
+        attr_accessor expires_at: Time?
+
+        def initialize: (
+          activations_used: Integer,
+          key: String,
+          ?activations_limit: Integer?,
+          ?expires_at: Time?
+        ) -> void
+
+        def to_hash: -> {
+          activations_used: Integer,
+          key: String,
+          activations_limit: Integer?,
+          expires_at: Time?
+        }
+      end
+    end
+  end
+end

data/sig/dodopayments/models/integration_config.rbs

@@ -0,0 +1,147 @@
+module Dodopayments
+  module Models
+    type integration_config =
+      Dodopayments::IntegrationConfig::GitHubConfig
+      | Dodopayments::IntegrationConfig::DiscordConfig
+      | Dodopayments::IntegrationConfig::TelegramConfig
+      | Dodopayments::IntegrationConfig::FigmaConfig
+      | Dodopayments::IntegrationConfig::FramerConfig
+      | Dodopayments::IntegrationConfig::NotionConfig
+      | Dodopayments::IntegrationConfig::DigitalFilesConfig
+      | Dodopayments::IntegrationConfig::LicenseKeyConfig
+
+    module IntegrationConfig
+      extend Dodopayments::Internal::Type::Union
+
+      type github_config = { permission: String, target_id: String }
+
+      class GitHubConfig < Dodopayments::Internal::Type::BaseModel
+        attr_accessor permission: String
+
+        attr_accessor target_id: String
+
+        def initialize: (permission: String, target_id: String) -> void
+
+        def to_hash: -> { permission: String, target_id: String }
+      end
+
+      type discord_config = { guild_id: String, role_id: String? }
+
+      class DiscordConfig < Dodopayments::Internal::Type::BaseModel
+        attr_accessor guild_id: String
+
+        attr_accessor role_id: String?
+
+        def initialize: (guild_id: String, ?role_id: String?) -> void
+
+        def to_hash: -> { guild_id: String, role_id: String? }
+      end
+
+      type telegram_config = { chat_id: String }
+
+      class TelegramConfig < Dodopayments::Internal::Type::BaseModel
+        attr_accessor chat_id: String
+
+        def initialize: (chat_id: String) -> void
+
+        def to_hash: -> { chat_id: String }
+      end
+
+      type figma_config = { figma_file_id: String }
+
+      class FigmaConfig < Dodopayments::Internal::Type::BaseModel
+        attr_accessor figma_file_id: String
+
+        def initialize: (figma_file_id: String) -> void
+
+        def to_hash: -> { figma_file_id: String }
+      end
+
+      type framer_config = { framer_template_id: String }
+
+      class FramerConfig < Dodopayments::Internal::Type::BaseModel
+        attr_accessor framer_template_id: String
+
+        def initialize: (framer_template_id: String) -> void
+
+        def to_hash: -> { framer_template_id: String }
+      end
+
+      type notion_config = { notion_template_id: String }
+
+      class NotionConfig < Dodopayments::Internal::Type::BaseModel
+        attr_accessor notion_template_id: String
+
+        def initialize: (notion_template_id: String) -> void
+
+        def to_hash: -> { notion_template_id: String }
+      end
+
+      type digital_files_config =
+        {
+          digital_file_ids: ::Array[String],
+          external_url: String?,
+          instructions: String?,
+          legacy_file_ids: ::Array[String]?
+        }
+
+      class DigitalFilesConfig < Dodopayments::Internal::Type::BaseModel
+        attr_accessor digital_file_ids: ::Array[String]
+
+        attr_accessor external_url: String?
+
+        attr_accessor instructions: String?
+
+        attr_accessor legacy_file_ids: ::Array[String]?
+
+        def initialize: (
+          digital_file_ids: ::Array[String],
+          ?external_url: String?,
+          ?instructions: String?,
+          ?legacy_file_ids: ::Array[String]?
+        ) -> void
+
+        def to_hash: -> {
+          digital_file_ids: ::Array[String],
+          external_url: String?,
+          instructions: String?,
+          legacy_file_ids: ::Array[String]?
+        }
+      end
+
+      type license_key_config =
+        {
+          activation_message: String?,
+          activations_limit: Integer?,
+          duration_count: Integer?,
+          duration_interval: Dodopayments::Models::time_interval?
+        }
+
+      class LicenseKeyConfig < Dodopayments::Internal::Type::BaseModel
+        attr_accessor activation_message: String?
+
+        attr_accessor activations_limit: Integer?
+
+        attr_accessor duration_count: Integer?
+
+        attr_accessor duration_interval: Dodopayments::Models::time_interval?
+
+        def initialize: (
+          ?activation_message: String?,
+          ?activations_limit: Integer?,
+          ?duration_count: Integer?,
+          ?duration_interval: Dodopayments::Models::time_interval?
+        ) -> void
+
+        def to_hash: -> {
+          activation_message: String?,
+          activations_limit: Integer?,
+          duration_count: Integer?,
+          duration_interval: Dodopayments::Models::time_interval?
+        }
+      end
+
+      def self?.variants: -> ::Array[Dodopayments::Models::integration_config]
+    end
+  end
+end