dodopayments 1.22.0 → 1.47.0

data/lib/dodopayments/models/subscription_update_params.rb

@@ -10,14 +10,17 @@ module Dodopayments
       # @!attribute billing
       #
       #   @return [Dodopayments::Models::BillingAddress, nil]
-      optional :billing, -> { Dodopayments::Models::BillingAddress }, nil?: true
+      optional :billing, -> { Dodopayments::BillingAddress }, nil?: true
+
+      # @!attribute cancel_at_next_billing_date
+      #
+      #   @return [Boolean, nil]
+      optional :cancel_at_next_billing_date, Dodopayments::Internal::Type::Boolean, nil?: true
 
       # @!attribute disable_on_demand
       #
       #   @return [Dodopayments::Models::SubscriptionUpdateParams::DisableOnDemand, nil]
-      optional :disable_on_demand,
-               -> { Dodopayments::Models::SubscriptionUpdateParams::DisableOnDemand },
-               nil?: true
+      optional :disable_on_demand, -> { Dodopayments::SubscriptionUpdateParams::DisableOnDemand }, nil?: true
 
       # @!attribute metadata
       #
@@ -27,15 +30,16 @@ module Dodopayments
       # @!attribute status
       #
       #   @return [Symbol, Dodopayments::Models::SubscriptionStatus, nil]
-      optional :status, enum: -> { Dodopayments::Models::SubscriptionStatus }, nil?: true
+      optional :status, enum: -> { Dodopayments::SubscriptionStatus }, nil?: true
 
       # @!attribute tax_id
       #
       #   @return [String, nil]
       optional :tax_id, String, nil?: true
 
-      # @!method initialize(billing: nil, disable_on_demand: nil, metadata: nil, status: nil, tax_id: nil, request_options: {})
+      # @!method initialize(billing: nil, cancel_at_next_billing_date: nil, disable_on_demand: nil, metadata: nil, status: nil, tax_id: nil, request_options: {})
       #   @param billing [Dodopayments::Models::BillingAddress, nil]
+      #   @param cancel_at_next_billing_date [Boolean, nil]
       #   @param disable_on_demand [Dodopayments::Models::SubscriptionUpdateParams::DisableOnDemand, nil]
       #   @param metadata [Hash{Symbol=>String}, nil]
       #   @param status [Symbol, Dodopayments::Models::SubscriptionStatus, nil]

data/lib/dodopayments/models/webhook_create_params.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Webhooks#create
+    class WebhookCreateParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute url
+      #   Url of the webhook
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute description
+      #   Filter events to the webhook.
+      #
+      #   Webhook event will only be sent for events in the list.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute disabled
+      #   Create the webhook in a disabled state.
+      #
+      #   Default is false
+      #
+      #   @return [Boolean, nil]
+      optional :disabled, Dodopayments::Internal::Type::Boolean, nil?: true
+
+      # @!attribute filter_types
+      #
+      #   @return [Array<Symbol, Dodopayments::Models::WebhookEventType>, nil]
+      optional :filter_types,
+               -> {
+                 Dodopayments::Internal::Type::ArrayOf[enum: Dodopayments::WebhookEventType]
+               }
+
+      # @!attribute headers
+      #   Custom headers to be passed
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :headers, Dodopayments::Internal::Type::HashOf[String], nil?: true
+
+      # @!attribute idempotency_key
+      #   The request's idempotency key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String, nil?: true
+
+      # @!attribute metadata
+      #   Metadata to be passed to the webhook Defaut is {}
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, Dodopayments::Internal::Type::HashOf[String], nil?: true
+
+      # @!attribute rate_limit
+      #
+      #   @return [Integer, nil]
+      optional :rate_limit, Integer, nil?: true
+
+      # @!method initialize(url:, description: nil, disabled: nil, filter_types: nil, headers: nil, idempotency_key: nil, metadata: nil, rate_limit: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::WebhookCreateParams} for more details.
+      #
+      #   @param url [String] Url of the webhook
+      #
+      #   @param description [String, nil] Filter events to the webhook.
+      #
+      #   @param disabled [Boolean, nil] Create the webhook in a disabled state.
+      #
+      #   @param filter_types [Array<Symbol, Dodopayments::Models::WebhookEventType>]
+      #
+      #   @param headers [Hash{Symbol=>String}, nil] Custom headers to be passed
+      #
+      #   @param idempotency_key [String, nil] The request's idempotency key
+      #
+      #   @param metadata [Hash{Symbol=>String}, nil] Metadata to be passed to the webhook
+      #
+      #   @param rate_limit [Integer, nil]
+      #
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/webhook_create_response.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Webhooks#create
+    class WebhookCreateResponse < 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::WebhookCreateResponse} 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_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Webhooks#delete
+    class WebhookDeleteParams < 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_event_type.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # Event types for Dodo events
+    module WebhookEventType
+      extend Dodopayments::Internal::Type::Enum
+
+      PAYMENT_SUCCEEDED = :"payment.succeeded"
+      PAYMENT_FAILED = :"payment.failed"
+      PAYMENT_PROCESSING = :"payment.processing"
+      PAYMENT_CANCELLED = :"payment.cancelled"
+      REFUND_SUCCEEDED = :"refund.succeeded"
+      REFUND_FAILED = :"refund.failed"
+      DISPUTE_OPENED = :"dispute.opened"
+      DISPUTE_EXPIRED = :"dispute.expired"
+      DISPUTE_ACCEPTED = :"dispute.accepted"
+      DISPUTE_CANCELLED = :"dispute.cancelled"
+      DISPUTE_CHALLENGED = :"dispute.challenged"
+      DISPUTE_WON = :"dispute.won"
+      DISPUTE_LOST = :"dispute.lost"
+      SUBSCRIPTION_ACTIVE = :"subscription.active"
+      SUBSCRIPTION_RENEWED = :"subscription.renewed"
+      SUBSCRIPTION_ON_HOLD = :"subscription.on_hold"
+      SUBSCRIPTION_CANCELLED = :"subscription.cancelled"
+      SUBSCRIPTION_FAILED = :"subscription.failed"
+      SUBSCRIPTION_EXPIRED = :"subscription.expired"
+      SUBSCRIPTION_PLAN_CHANGED = :"subscription.plan_changed"
+      LICENSE_KEY_CREATED = :"license_key.created"
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/dodopayments/models/webhook_list_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Webhooks#list
+    class WebhookListParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute iterator
+      #   The iterator returned from a prior invocation
+      #
+      #   @return [String, nil]
+      optional :iterator, String, nil?: true
+
+      # @!attribute limit
+      #   Limit the number of returned items
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer, nil?: true
+
+      # @!method initialize(iterator: nil, limit: nil, request_options: {})
+      #   @param iterator [String, nil] The iterator returned from a prior invocation
+      #
+      #   @param limit [Integer, nil] Limit the number of returned items
+      #
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

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