dodopayments 1.20.0 → 1.47.0

data/lib/dodopayments/models/webhook_list_response.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Webhooks#list
+    class WebhookListResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute id
+      #   The webhook's ID.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   Created at timestamp
+      #
+      #   @return [String]
+      required :created_at, String
+
+      # @!attribute description
+      #   An example webhook name.
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!attribute metadata
+      #   Metadata of the webhook
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :metadata, Dodopayments::Internal::Type::HashOf[String]
+
+      # @!attribute updated_at
+      #   Updated at timestamp
+      #
+      #   @return [String]
+      required :updated_at, String
+
+      # @!attribute url
+      #   Url endpoint of the webhook
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute disabled
+      #   Status of the webhook.
+      #
+      #   If true, events are not sent
+      #
+      #   @return [Boolean, nil]
+      optional :disabled, Dodopayments::Internal::Type::Boolean, nil?: true
+
+      # @!attribute filter_types
+      #   Filter events to the webhook.
+      #
+      #   Webhook event will only be sent for events in the list.
+      #
+      #   @return [Array<String>, nil]
+      optional :filter_types, Dodopayments::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute rate_limit
+      #   Configured rate limit
+      #
+      #   @return [Integer, nil]
+      optional :rate_limit, Integer, nil?: true
+
+      # @!method initialize(id:, created_at:, description:, metadata:, updated_at:, url:, disabled: nil, filter_types: nil, rate_limit: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::WebhookListResponse} for more details.
+      #
+      #   @param id [String] The webhook's ID.
+      #
+      #   @param created_at [String] Created at timestamp
+      #
+      #   @param description [String] An example webhook name.
+      #
+      #   @param metadata [Hash{Symbol=>String}] Metadata of the webhook
+      #
+      #   @param updated_at [String] Updated at timestamp
+      #
+      #   @param url [String] Url endpoint of the webhook
+      #
+      #   @param disabled [Boolean, nil] Status of the webhook.
+      #
+      #   @param filter_types [Array<String>, nil] Filter events to the webhook.
+      #
+      #   @param rate_limit [Integer, nil] Configured rate limit
+    end
+  end
+end

data/lib/dodopayments/models/webhook_payload.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class WebhookPayload < Dodopayments::Internal::Type::BaseModel
+      # @!attribute business_id
+      #
+      #   @return [String]
+      required :business_id, String
+
+      # @!attribute data
+      #   The latest data at the time of delivery attempt
+      #
+      #   @return [Dodopayments::Models::WebhookPayload::Data::Payment, Dodopayments::Models::WebhookPayload::Data::Subscription, Dodopayments::Models::WebhookPayload::Data::Refund, Dodopayments::Models::WebhookPayload::Data::Dispute, Dodopayments::Models::WebhookPayload::Data::LicenseKey]
+      required :data, union: -> { Dodopayments::WebhookPayload::Data }
+
+      # @!attribute timestamp
+      #   The timestamp of when the event occurred (not necessarily the same of when it
+      #   was delivered)
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   Event types for Dodo events
+      #
+      #   @return [Symbol, Dodopayments::Models::WebhookEventType]
+      required :type, enum: -> { Dodopayments::WebhookEventType }
+
+      # @!method initialize(business_id:, data:, timestamp:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::WebhookPayload} for more details.
+      #
+      #   @param business_id [String]
+      #
+      #   @param data [Dodopayments::Models::WebhookPayload::Data::Payment, Dodopayments::Models::WebhookPayload::Data::Subscription, Dodopayments::Models::WebhookPayload::Data::Refund, Dodopayments::Models::WebhookPayload::Data::Dispute, Dodopayments::Models::WebhookPayload::Data::LicenseKey] The latest data at the time of delivery attempt
+      #
+      #   @param timestamp [Time] The timestamp of when the event occurred (not necessarily the same of when it wa
+      #
+      #   @param type [Symbol, Dodopayments::Models::WebhookEventType] Event types for Dodo events
+
+      # The latest data at the time of delivery attempt
+      #
+      # @see Dodopayments::Models::WebhookPayload#data
+      module Data
+        extend Dodopayments::Internal::Type::Union
+
+        variant -> { Dodopayments::WebhookPayload::Data::Payment }
+
+        # Response struct representing subscription details
+        variant -> { Dodopayments::WebhookPayload::Data::Subscription }
+
+        variant -> { Dodopayments::WebhookPayload::Data::Refund }
+
+        variant -> { Dodopayments::WebhookPayload::Data::Dispute }
+
+        variant -> { Dodopayments::WebhookPayload::Data::LicenseKey }
+
+        class Payment < Dodopayments::Models::Payment
+          # @!attribute payload_type
+          #
+          #   @return [Symbol, Dodopayments::Models::WebhookPayload::Data::Payment::PayloadType]
+          required :payload_type, enum: -> { Dodopayments::WebhookPayload::Data::Payment::PayloadType }
+
+          # @!method initialize(payload_type:)
+          #   @param payload_type [Symbol, Dodopayments::Models::WebhookPayload::Data::Payment::PayloadType]
+
+          module PayloadType
+            extend Dodopayments::Internal::Type::Enum
+
+            PAYMENT = :Payment
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class Subscription < Dodopayments::Models::Subscription
+          # @!attribute payload_type
+          #
+          #   @return [Symbol, Dodopayments::Models::WebhookPayload::Data::Subscription::PayloadType]
+          required :payload_type, enum: -> { Dodopayments::WebhookPayload::Data::Subscription::PayloadType }
+
+          # @!method initialize(payload_type:)
+          #   Response struct representing subscription details
+          #
+          #   @param payload_type [Symbol, Dodopayments::Models::WebhookPayload::Data::Subscription::PayloadType]
+
+          module PayloadType
+            extend Dodopayments::Internal::Type::Enum
+
+            SUBSCRIPTION = :Subscription
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class Refund < Dodopayments::Models::Refund
+          # @!attribute payload_type
+          #
+          #   @return [Symbol, Dodopayments::Models::WebhookPayload::Data::Refund::PayloadType]
+          required :payload_type, enum: -> { Dodopayments::WebhookPayload::Data::Refund::PayloadType }
+
+          # @!method initialize(payload_type:)
+          #   @param payload_type [Symbol, Dodopayments::Models::WebhookPayload::Data::Refund::PayloadType]
+
+          module PayloadType
+            extend Dodopayments::Internal::Type::Enum
+
+            REFUND = :Refund
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class Dispute < Dodopayments::Models::GetDispute
+          # @!attribute payload_type
+          #
+          #   @return [Symbol, Dodopayments::Models::WebhookPayload::Data::Dispute::PayloadType]
+          required :payload_type, enum: -> { Dodopayments::WebhookPayload::Data::Dispute::PayloadType }
+
+          # @!method initialize(payload_type:)
+          #   @param payload_type [Symbol, Dodopayments::Models::WebhookPayload::Data::Dispute::PayloadType]
+
+          module PayloadType
+            extend Dodopayments::Internal::Type::Enum
+
+            DISPUTE = :Dispute
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class LicenseKey < Dodopayments::Models::LicenseKey
+          # @!attribute payload_type
+          #
+          #   @return [Symbol, Dodopayments::Models::WebhookPayload::Data::LicenseKey::PayloadType]
+          required :payload_type, enum: -> { Dodopayments::WebhookPayload::Data::LicenseKey::PayloadType }
+
+          # @!method initialize(payload_type:)
+          #   @param payload_type [Symbol, Dodopayments::Models::WebhookPayload::Data::LicenseKey::PayloadType]
+
+          module PayloadType
+            extend Dodopayments::Internal::Type::Enum
+
+            LICENSE_KEY = :LicenseKey
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @!method self.variants
+        #   @return [Array(Dodopayments::Models::WebhookPayload::Data::Payment, Dodopayments::Models::WebhookPayload::Data::Subscription, Dodopayments::Models::WebhookPayload::Data::Refund, Dodopayments::Models::WebhookPayload::Data::Dispute, Dodopayments::Models::WebhookPayload::Data::LicenseKey)]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/webhook_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Webhooks#retrieve
+    class WebhookRetrieveParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/webhook_retrieve_response.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Webhooks#retrieve
+    class WebhookRetrieveResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute id
+      #   The webhook's ID.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   Created at timestamp
+      #
+      #   @return [String]
+      required :created_at, String
+
+      # @!attribute description
+      #   An example webhook name.
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!attribute metadata
+      #   Metadata of the webhook
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :metadata, Dodopayments::Internal::Type::HashOf[String]
+
+      # @!attribute updated_at
+      #   Updated at timestamp
+      #
+      #   @return [String]
+      required :updated_at, String
+
+      # @!attribute url
+      #   Url endpoint of the webhook
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute disabled
+      #   Status of the webhook.
+      #
+      #   If true, events are not sent
+      #
+      #   @return [Boolean, nil]
+      optional :disabled, Dodopayments::Internal::Type::Boolean, nil?: true
+
+      # @!attribute filter_types
+      #   Filter events to the webhook.
+      #
+      #   Webhook event will only be sent for events in the list.
+      #
+      #   @return [Array<String>, nil]
+      optional :filter_types, Dodopayments::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute rate_limit
+      #   Configured rate limit
+      #
+      #   @return [Integer, nil]
+      optional :rate_limit, Integer, nil?: true
+
+      # @!method initialize(id:, created_at:, description:, metadata:, updated_at:, url:, disabled: nil, filter_types: nil, rate_limit: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::WebhookRetrieveResponse} for more details.
+      #
+      #   @param id [String] The webhook's ID.
+      #
+      #   @param created_at [String] Created at timestamp
+      #
+      #   @param description [String] An example webhook name.
+      #
+      #   @param metadata [Hash{Symbol=>String}] Metadata of the webhook
+      #
+      #   @param updated_at [String] Updated at timestamp
+      #
+      #   @param url [String] Url endpoint of the webhook
+      #
+      #   @param disabled [Boolean, nil] Status of the webhook.
+      #
+      #   @param filter_types [Array<String>, nil] Filter events to the webhook.
+      #
+      #   @param rate_limit [Integer, nil] Configured rate limit
+    end
+  end
+end

data/lib/dodopayments/models/webhook_update_params.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Webhooks#update
+    class WebhookUpdateParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute description
+      #   Description of the webhook
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute disabled
+      #   To Disable the endpoint, set it to true.
+      #
+      #   @return [Boolean, nil]
+      optional :disabled, Dodopayments::Internal::Type::Boolean, nil?: true
+
+      # @!attribute filter_types
+      #   Filter events to the endpoint.
+      #
+      #   Webhook event will only be sent for events in the list.
+      #
+      #   @return [Array<Symbol, Dodopayments::Models::WebhookEventType>, nil]
+      optional :filter_types,
+               -> { Dodopayments::Internal::Type::ArrayOf[enum: Dodopayments::WebhookEventType] },
+               nil?: true
+
+      # @!attribute metadata
+      #   Metadata
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, Dodopayments::Internal::Type::HashOf[String], nil?: true
+
+      # @!attribute rate_limit
+      #   Rate limit
+      #
+      #   @return [Integer, nil]
+      optional :rate_limit, Integer, nil?: true
+
+      # @!attribute url
+      #   Url endpoint
+      #
+      #   @return [String, nil]
+      optional :url, String, nil?: true
+
+      # @!method initialize(description: nil, disabled: nil, filter_types: nil, metadata: nil, rate_limit: nil, url: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::WebhookUpdateParams} for more details.
+      #
+      #   @param description [String, nil] Description of the webhook
+      #
+      #   @param disabled [Boolean, nil] To Disable the endpoint, set it to true.
+      #
+      #   @param filter_types [Array<Symbol, Dodopayments::Models::WebhookEventType>, nil] Filter events to the endpoint.
+      #
+      #   @param metadata [Hash{Symbol=>String}, nil] Metadata
+      #
+      #   @param rate_limit [Integer, nil] Rate limit
+      #
+      #   @param url [String, nil] Url endpoint
+      #
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/webhook_update_response.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Webhooks#update
+    class WebhookUpdateResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute id
+      #   The webhook's ID.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   Created at timestamp
+      #
+      #   @return [String]
+      required :created_at, String
+
+      # @!attribute description
+      #   An example webhook name.
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!attribute metadata
+      #   Metadata of the webhook
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :metadata, Dodopayments::Internal::Type::HashOf[String]
+
+      # @!attribute updated_at
+      #   Updated at timestamp
+      #
+      #   @return [String]
+      required :updated_at, String
+
+      # @!attribute url
+      #   Url endpoint of the webhook
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute disabled
+      #   Status of the webhook.
+      #
+      #   If true, events are not sent
+      #
+      #   @return [Boolean, nil]
+      optional :disabled, Dodopayments::Internal::Type::Boolean, nil?: true
+
+      # @!attribute filter_types
+      #   Filter events to the webhook.
+      #
+      #   Webhook event will only be sent for events in the list.
+      #
+      #   @return [Array<String>, nil]
+      optional :filter_types, Dodopayments::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute rate_limit
+      #   Configured rate limit
+      #
+      #   @return [Integer, nil]
+      optional :rate_limit, Integer, nil?: true
+
+      # @!method initialize(id:, created_at:, description:, metadata:, updated_at:, url:, disabled: nil, filter_types: nil, rate_limit: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::WebhookUpdateResponse} for more details.
+      #
+      #   @param id [String] The webhook's ID.
+      #
+      #   @param created_at [String] Created at timestamp
+      #
+      #   @param description [String] An example webhook name.
+      #
+      #   @param metadata [Hash{Symbol=>String}] Metadata of the webhook
+      #
+      #   @param updated_at [String] Updated at timestamp
+      #
+      #   @param url [String] Url endpoint of the webhook
+      #
+      #   @param disabled [Boolean, nil] Status of the webhook.
+      #
+      #   @param filter_types [Array<String>, nil] Filter events to the webhook.
+      #
+      #   @param rate_limit [Integer, nil] Configured rate limit
+    end
+  end
+end

data/lib/dodopayments/models/webhooks/header_retrieve_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Webhooks
+      # @see Dodopayments::Resources::Webhooks::Headers#retrieve
+      class HeaderRetrieveParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/webhooks/header_retrieve_response.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Webhooks
+      # @see Dodopayments::Resources::Webhooks::Headers#retrieve
+      class HeaderRetrieveResponse < Dodopayments::Internal::Type::BaseModel
+        # @!attribute headers
+        #   List of headers configured
+        #
+        #   @return [Hash{Symbol=>String}]
+        required :headers, Dodopayments::Internal::Type::HashOf[String]
+
+        # @!attribute sensitive
+        #   Sensitive headers without the value
+        #
+        #   @return [Array<String>]
+        required :sensitive, Dodopayments::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(headers:, sensitive:)
+        #   The value of the headers is returned in the `headers` field.
+        #
+        #   Sensitive headers that have been redacted are returned in the sensitive field.
+        #
+        #   @param headers [Hash{Symbol=>String}] List of headers configured
+        #
+        #   @param sensitive [Array<String>] Sensitive headers without the value
+      end
+    end
+  end
+end

data/lib/dodopayments/models/webhooks/header_update_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Webhooks
+      # @see Dodopayments::Resources::Webhooks::Headers#update
+      class HeaderUpdateParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute headers
+        #   Object of header-value pair to update or add
+        #
+        #   @return [Hash{Symbol=>String}]
+        required :headers, Dodopayments::Internal::Type::HashOf[String]
+
+        # @!method initialize(headers:, request_options: {})
+        #   @param headers [Hash{Symbol=>String}] Object of header-value pair to update or add
+        #
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/your_webhook_url_create_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::YourWebhookURL#create
+    class YourWebhookURLCreateParams < Dodopayments::Models::WebhookPayload
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute webhook_id
+      #
+      #   @return [String]
+      required :webhook_id, String
+
+      # @!attribute webhook_signature
+      #
+      #   @return [String]
+      required :webhook_signature, String
+
+      # @!attribute webhook_timestamp
+      #
+      #   @return [String]
+      required :webhook_timestamp, String
+
+      # @!method initialize(webhook_id:, webhook_signature:, webhook_timestamp:, request_options: {})
+      #   @param webhook_id [String]
+      #   @param webhook_signature [String]
+      #   @param webhook_timestamp [String]
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end