dodopayments 2.8.1 → 2.9.0

data/lib/dodopayments/models/entitlement_grant_created_webhook_event.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class EntitlementGrantCreatedWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      # @!attribute business_id
+      #   The business identifier
+      #
+      #   @return [String]
+      required :business_id, String
+
+      # @!attribute data
+      #
+      #   @return [Dodopayments::Models::Entitlements::EntitlementGrant]
+      required :data, -> { Dodopayments::Entitlements::EntitlementGrant }
+
+      # @!attribute timestamp
+      #   The timestamp of when the event occurred
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The event type
+      #
+      #   @return [Symbol, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent::Type]
+      required :type, enum: -> { Dodopayments::EntitlementGrantCreatedWebhookEvent::Type }
+
+      # @!method initialize(business_id:, data:, timestamp:, type:)
+      #   @param business_id [String] The business identifier
+      #
+      #   @param data [Dodopayments::Models::Entitlements::EntitlementGrant]
+      #
+      #   @param timestamp [Time] The timestamp of when the event occurred
+      #
+      #   @param type [Symbol, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent::Type] The event type
+
+      # The event type
+      #
+      # @see Dodopayments::Models::EntitlementGrantCreatedWebhookEvent#type
+      module Type
+        extend Dodopayments::Internal::Type::Enum
+
+        ENTITLEMENT_GRANT_CREATED = :"entitlement_grant.created"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/entitlement_grant_delivered_webhook_event.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class EntitlementGrantDeliveredWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      # @!attribute business_id
+      #   The business identifier
+      #
+      #   @return [String]
+      required :business_id, String
+
+      # @!attribute data
+      #
+      #   @return [Dodopayments::Models::Entitlements::EntitlementGrant]
+      required :data, -> { Dodopayments::Entitlements::EntitlementGrant }
+
+      # @!attribute timestamp
+      #   The timestamp of when the event occurred
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The event type
+      #
+      #   @return [Symbol, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent::Type]
+      required :type, enum: -> { Dodopayments::EntitlementGrantDeliveredWebhookEvent::Type }
+
+      # @!method initialize(business_id:, data:, timestamp:, type:)
+      #   @param business_id [String] The business identifier
+      #
+      #   @param data [Dodopayments::Models::Entitlements::EntitlementGrant]
+      #
+      #   @param timestamp [Time] The timestamp of when the event occurred
+      #
+      #   @param type [Symbol, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent::Type] The event type
+
+      # The event type
+      #
+      # @see Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent#type
+      module Type
+        extend Dodopayments::Internal::Type::Enum
+
+        ENTITLEMENT_GRANT_DELIVERED = :"entitlement_grant.delivered"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/entitlement_grant_failed_webhook_event.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class EntitlementGrantFailedWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      # @!attribute business_id
+      #   The business identifier
+      #
+      #   @return [String]
+      required :business_id, String
+
+      # @!attribute data
+      #
+      #   @return [Dodopayments::Models::Entitlements::EntitlementGrant]
+      required :data, -> { Dodopayments::Entitlements::EntitlementGrant }
+
+      # @!attribute timestamp
+      #   The timestamp of when the event occurred
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The event type
+      #
+      #   @return [Symbol, Dodopayments::Models::EntitlementGrantFailedWebhookEvent::Type]
+      required :type, enum: -> { Dodopayments::EntitlementGrantFailedWebhookEvent::Type }
+
+      # @!method initialize(business_id:, data:, timestamp:, type:)
+      #   @param business_id [String] The business identifier
+      #
+      #   @param data [Dodopayments::Models::Entitlements::EntitlementGrant]
+      #
+      #   @param timestamp [Time] The timestamp of when the event occurred
+      #
+      #   @param type [Symbol, Dodopayments::Models::EntitlementGrantFailedWebhookEvent::Type] The event type
+
+      # The event type
+      #
+      # @see Dodopayments::Models::EntitlementGrantFailedWebhookEvent#type
+      module Type
+        extend Dodopayments::Internal::Type::Enum
+
+        ENTITLEMENT_GRANT_FAILED = :"entitlement_grant.failed"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/entitlement_grant_revoked_webhook_event.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class EntitlementGrantRevokedWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      # @!attribute business_id
+      #   The business identifier
+      #
+      #   @return [String]
+      required :business_id, String
+
+      # @!attribute data
+      #
+      #   @return [Dodopayments::Models::Entitlements::EntitlementGrant]
+      required :data, -> { Dodopayments::Entitlements::EntitlementGrant }
+
+      # @!attribute timestamp
+      #   The timestamp of when the event occurred
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The event type
+      #
+      #   @return [Symbol, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent::Type]
+      required :type, enum: -> { Dodopayments::EntitlementGrantRevokedWebhookEvent::Type }
+
+      # @!method initialize(business_id:, data:, timestamp:, type:)
+      #   @param business_id [String] The business identifier
+      #
+      #   @param data [Dodopayments::Models::Entitlements::EntitlementGrant]
+      #
+      #   @param timestamp [Time] The timestamp of when the event occurred
+      #
+      #   @param type [Symbol, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent::Type] The event type
+
+      # The event type
+      #
+      # @see Dodopayments::Models::EntitlementGrantRevokedWebhookEvent#type
+      module Type
+        extend Dodopayments::Internal::Type::Enum
+
+        ENTITLEMENT_GRANT_REVOKED = :"entitlement_grant.revoked"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/entitlement_integration_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module EntitlementIntegrationType
+      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
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/dodopayments/models/entitlement_list_params.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Entitlements#list
+    class EntitlementListParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute integration_type
+      #   Filter by integration type
+      #
+      #   @return [Symbol, Dodopayments::Models::EntitlementListParams::IntegrationType, nil]
+      optional :integration_type, enum: -> { Dodopayments::EntitlementListParams::IntegrationType }
+
+      # @!attribute page_number
+      #   Page number (default 0)
+      #
+      #   @return [Integer, nil]
+      optional :page_number, Integer
+
+      # @!attribute page_size
+      #   Page size (default 10, max 100)
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!method initialize(integration_type: nil, page_number: nil, page_size: nil, request_options: {})
+      #   @param integration_type [Symbol, Dodopayments::Models::EntitlementListParams::IntegrationType] Filter by integration type
+      #
+      #   @param page_number [Integer] Page number (default 0)
+      #
+      #   @param page_size [Integer] Page size (default 10, max 100)
+      #
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+
+      # Filter by integration type
+      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
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/entitlement_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Entitlements#retrieve
+    class EntitlementRetrieveParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/entitlement_update_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Entitlements#update
+    class EntitlementUpdateParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute integration_config
+      #   Platform-specific configuration for an entitlement. Each variant uses unique
+      #   field names so `#[serde(untagged)]` can disambiguate correctly.
+      #
+      #   @return [Dodopayments::Models::IntegrationConfig::GitHubConfig, Dodopayments::Models::IntegrationConfig::DiscordConfig, Dodopayments::Models::IntegrationConfig::TelegramConfig, Dodopayments::Models::IntegrationConfig::FigmaConfig, Dodopayments::Models::IntegrationConfig::FramerConfig, Dodopayments::Models::IntegrationConfig::NotionConfig, Dodopayments::Models::IntegrationConfig::DigitalFilesConfig, Dodopayments::Models::IntegrationConfig::LicenseKeyConfig, nil]
+      optional :integration_config, union: -> { Dodopayments::IntegrationConfig }, nil?: true
+
+      # @!attribute metadata
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, Dodopayments::Internal::Type::HashOf[String], nil?: true
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!method initialize(id:, description: nil, integration_config: nil, metadata: nil, name: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::EntitlementUpdateParams} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param description [String, nil]
+      #
+      #   @param integration_config [Dodopayments::Models::IntegrationConfig::GitHubConfig, Dodopayments::Models::IntegrationConfig::DiscordConfig, Dodopayments::Models::IntegrationConfig::TelegramConfig, Dodopayments::Models::IntegrationConfig::FigmaConfig, Dodopayments::Models::IntegrationConfig::FramerConfig, Dodopayments::Models::IntegrationConfig::NotionConfig, Dodopayments::Models::IntegrationConfig::DigitalFilesConfig, Dodopayments::Models::IntegrationConfig::LicenseKeyConfig, nil] Platform-specific configuration for an entitlement.
+      #
+      #   @param metadata [Hash{Symbol=>String}, nil]
+      #
+      #   @param name [String, nil]
+      #
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/entitlements/entitlement_grant.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Entitlements
+      # @see Dodopayments::Resources::Entitlements::Grants#list
+      class EntitlementGrant < Dodopayments::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute business_id
+        #
+        #   @return [String]
+        required :business_id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute entitlement_id
+        #
+        #   @return [String]
+        required :entitlement_id, String
+
+        # @!attribute external_id
+        #
+        #   @return [String]
+        required :external_id, String
+
+        # @!attribute status
+        #
+        #   @return [Symbol, Dodopayments::Models::Entitlements::EntitlementGrant::Status]
+        required :status, enum: -> { Dodopayments::Entitlements::EntitlementGrant::Status }
+
+        # @!attribute updated_at
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!attribute delivered_at
+        #
+        #   @return [Time, nil]
+        optional :delivered_at, Time, nil?: true
+
+        # @!attribute digital_product_delivery
+        #   Present only when the entitlement integration_type is `digital_files`. Populated
+        #   eagerly on every list and single-record endpoint.
+        #
+        #   @return [Dodopayments::Models::DigitalProductDelivery, nil]
+        optional :digital_product_delivery, -> { Dodopayments::DigitalProductDelivery }, nil?: true
+
+        # @!attribute error_code
+        #
+        #   @return [String, nil]
+        optional :error_code, String, nil?: true
+
+        # @!attribute error_message
+        #
+        #   @return [String, nil]
+        optional :error_message, String, nil?: true
+
+        # @!attribute license_key
+        #   Present only when the entitlement integration_type is `license_key`.
+        #
+        #   @return [Dodopayments::Models::Entitlements::LicenseKeyGrant, nil]
+        optional :license_key, -> { Dodopayments::Entitlements::LicenseKeyGrant }, nil?: true
+
+        # @!attribute metadata
+        #
+        #   @return [Object, nil]
+        optional :metadata, Dodopayments::Internal::Type::Unknown
+
+        # @!attribute oauth_expires_at
+        #
+        #   @return [Time, nil]
+        optional :oauth_expires_at, Time, nil?: true
+
+        # @!attribute oauth_url
+        #
+        #   @return [String, nil]
+        optional :oauth_url, String, nil?: true
+
+        # @!attribute payment_id
+        #
+        #   @return [String, nil]
+        optional :payment_id, String, nil?: true
+
+        # @!attribute revocation_reason
+        #
+        #   @return [String, nil]
+        optional :revocation_reason, String, nil?: true
+
+        # @!attribute revoked_at
+        #
+        #   @return [Time, nil]
+        optional :revoked_at, Time, nil?: true
+
+        # @!attribute subscription_id
+        #
+        #   @return [String, nil]
+        optional :subscription_id, String, nil?: true
+
+        # @!method initialize(id:, business_id:, created_at:, customer_id:, entitlement_id:, external_id:, status:, updated_at:, delivered_at: nil, digital_product_delivery: nil, error_code: nil, error_message: nil, license_key: nil, metadata: nil, oauth_expires_at: nil, oauth_url: nil, payment_id: nil, revocation_reason: nil, revoked_at: nil, subscription_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Entitlements::EntitlementGrant} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param business_id [String]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param customer_id [String]
+        #
+        #   @param entitlement_id [String]
+        #
+        #   @param external_id [String]
+        #
+        #   @param status [Symbol, Dodopayments::Models::Entitlements::EntitlementGrant::Status]
+        #
+        #   @param updated_at [Time]
+        #
+        #   @param delivered_at [Time, nil]
+        #
+        #   @param digital_product_delivery [Dodopayments::Models::DigitalProductDelivery, nil] Present only when the entitlement integration_type is `digital_files`.
+        #
+        #   @param error_code [String, nil]
+        #
+        #   @param error_message [String, nil]
+        #
+        #   @param license_key [Dodopayments::Models::Entitlements::LicenseKeyGrant, nil] Present only when the entitlement integration_type is `license_key`.
+        #
+        #   @param metadata [Object]
+        #
+        #   @param oauth_expires_at [Time, nil]
+        #
+        #   @param oauth_url [String, nil]
+        #
+        #   @param payment_id [String, nil]
+        #
+        #   @param revocation_reason [String, nil]
+        #
+        #   @param revoked_at [Time, nil]
+        #
+        #   @param subscription_id [String, nil]
+
+        # @see Dodopayments::Models::Entitlements::EntitlementGrant#status
+        module Status
+          extend Dodopayments::Internal::Type::Enum
+
+          PENDING = :Pending
+          DELIVERED = :Delivered
+          FAILED = :Failed
+          REVOKED = :Revoked
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    EntitlementGrant = Entitlements::EntitlementGrant
+  end
+end

data/lib/dodopayments/models/entitlements/file_delete_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Entitlements
+      # @see Dodopayments::Resources::Entitlements::Files#delete
+      class FileDeleteParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute file_id
+        #
+        #   @return [String]
+        required :file_id, String
+
+        # @!method initialize(id:, file_id:, request_options: {})
+        #   @param id [String]
+        #   @param file_id [String]
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/entitlements/file_upload_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Entitlements
+      # @see Dodopayments::Resources::Entitlements::Files#upload
+      class FileUploadParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:, request_options: {})
+        #   @param id [String]
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/entitlements/file_upload_response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Entitlements
+      # @see Dodopayments::Resources::Entitlements::Files#upload
+      class FileUploadResponse < Dodopayments::Internal::Type::BaseModel
+        # @!attribute file_id
+        #   EE-issued digital file id; appended to
+        #   `entitlements.integration_config.digital_file_ids`.
+        #
+        #   @return [String]
+        required :file_id, String
+
+        # @!method initialize(file_id:)
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::Entitlements::FileUploadResponse} for more details.
+        #
+        #   @param file_id [String] EE-issued digital file id; appended to
+      end
+    end
+  end
+end

data/lib/dodopayments/models/entitlements/grant_list_params.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Entitlements
+      # @see Dodopayments::Resources::Entitlements::Grants#list
+      class GrantListParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute customer_id
+        #   Filter by customer ID
+        #
+        #   @return [String, nil]
+        optional :customer_id, String
+
+        # @!attribute page_number
+        #   Page number (default 0)
+        #
+        #   @return [Integer, nil]
+        optional :page_number, Integer
+
+        # @!attribute page_size
+        #   Page size (default 10, max 100)
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!attribute status
+        #   Filter by grant status
+        #
+        #   @return [Symbol, Dodopayments::Models::Entitlements::GrantListParams::Status, nil]
+        optional :status, enum: -> { Dodopayments::Entitlements::GrantListParams::Status }
+
+        # @!method initialize(id:, customer_id: nil, page_number: nil, page_size: nil, status: nil, request_options: {})
+        #   @param id [String]
+        #
+        #   @param customer_id [String] Filter by customer ID
+        #
+        #   @param page_number [Integer] Page number (default 0)
+        #
+        #   @param page_size [Integer] Page size (default 10, max 100)
+        #
+        #   @param status [Symbol, Dodopayments::Models::Entitlements::GrantListParams::Status] Filter by grant status
+        #
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+
+        # Filter by grant status
+        module Status
+          extend Dodopayments::Internal::Type::Enum
+
+          PENDING = :Pending
+          DELIVERED = :Delivered
+          FAILED = :Failed
+          REVOKED = :Revoked
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end