dodopayments 1.22.0 → 1.47.0

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

data/lib/dodopayments/models.rb

@@ -1,6 +1,44 @@
 # frozen_string_literal: true
 
 module Dodopayments
+  [Dodopayments::Internal::Type::BaseModel, *Dodopayments::Internal::Type::BaseModel.subclasses].each do |cls|
+    cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, Dodopayments::Internal::AnyHash) } }
+  end
+
+  Dodopayments::Internal::Util.walk_namespaces(Dodopayments::Models).each do |mod|
+    case mod
+    in Dodopayments::Internal::Type::Enum | Dodopayments::Internal::Type::Union
+      mod.constants.each do |name|
+        case mod.const_get(name)
+        in true | false
+          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
+          mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+        in Integer
+          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
+          mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+        in Float
+          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
+          mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+        in Symbol
+          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
+          mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+        else
+        end
+      end
+    else
+    end
+  end
+
+  Dodopayments::Internal::Util.walk_namespaces(Dodopayments::Models)
+                              .lazy
+                              .grep(Dodopayments::Internal::Type::Union)
+                              .each do |mod|
+    const = :Variants
+    next if mod.sorbet_constant_defined?(const)
+
+    mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
+  end
+
   AddonCartResponseItem = Dodopayments::Models::AddonCartResponseItem
 
   AddonCreateParams = Dodopayments::Models::AddonCreateParams
@@ -15,10 +53,24 @@ module Dodopayments
 
   AddonUpdateParams = Dodopayments::Models::AddonUpdateParams
 
+  AttachAddon = Dodopayments::Models::AttachAddon
+
   AttachExistingCustomer = Dodopayments::Models::AttachExistingCustomer
 
   BillingAddress = Dodopayments::Models::BillingAddress
 
+  Brand = Dodopayments::Models::Brand
+
+  BrandCreateParams = Dodopayments::Models::BrandCreateParams
+
+  BrandListParams = Dodopayments::Models::BrandListParams
+
+  BrandRetrieveParams = Dodopayments::Models::BrandRetrieveParams
+
+  BrandUpdateImagesParams = Dodopayments::Models::BrandUpdateImagesParams
+
+  BrandUpdateParams = Dodopayments::Models::BrandUpdateParams
+
   CountryCode = Dodopayments::Models::CountryCode
 
   CreateNewCustomer = Dodopayments::Models::CreateNewCustomer
@@ -67,6 +119,8 @@ module Dodopayments
 
   DisputeStatus = Dodopayments::Models::DisputeStatus
 
+  GetDispute = Dodopayments::Models::GetDispute
+
   IntentStatus = Dodopayments::Models::IntentStatus
 
   Invoices = Dodopayments::Models::Invoices
@@ -99,6 +153,8 @@ module Dodopayments
 
   MiscListSupportedCountriesParams = Dodopayments::Models::MiscListSupportedCountriesParams
 
+  NewCustomer = Dodopayments::Models::NewCustomer
+
   OneTimeProductCartItem = Dodopayments::Models::OneTimeProductCartItem
 
   Payment = Dodopayments::Models::Payment
@@ -107,6 +163,10 @@ module Dodopayments
 
   PaymentListParams = Dodopayments::Models::PaymentListParams
 
+  PaymentMethodTypes = Dodopayments::Models::PaymentMethodTypes
+
+  PaymentRetrieveLineItemsParams = Dodopayments::Models::PaymentRetrieveLineItemsParams
+
   PaymentRetrieveParams = Dodopayments::Models::PaymentRetrieveParams
 
   PayoutListParams = Dodopayments::Models::PayoutListParams
@@ -127,6 +187,8 @@ module Dodopayments
 
   ProductUnarchiveParams = Dodopayments::Models::ProductUnarchiveParams
 
+  ProductUpdateFilesParams = Dodopayments::Models::ProductUpdateFilesParams
+
   ProductUpdateParams = Dodopayments::Models::ProductUpdateParams
 
   Refund = Dodopayments::Models::Refund
@@ -159,9 +221,21 @@ module Dodopayments
 
   TimeInterval = Dodopayments::Models::TimeInterval
 
-  WebhookEvent = Dodopayments::Models::WebhookEvent
+  WebhookCreateParams = Dodopayments::Models::WebhookCreateParams
+
+  WebhookDeleteParams = Dodopayments::Models::WebhookDeleteParams
+
+  WebhookEventType = Dodopayments::Models::WebhookEventType
+
+  WebhookListParams = Dodopayments::Models::WebhookListParams
+
+  WebhookPayload = Dodopayments::Models::WebhookPayload
+
+  WebhookRetrieveParams = Dodopayments::Models::WebhookRetrieveParams
+
+  Webhooks = Dodopayments::Models::Webhooks
 
-  WebhookEventListParams = Dodopayments::Models::WebhookEventListParams
+  WebhookUpdateParams = Dodopayments::Models::WebhookUpdateParams
 
-  WebhookEventRetrieveParams = Dodopayments::Models::WebhookEventRetrieveParams
+  YourWebhookURLCreateParams = Dodopayments::Models::YourWebhookURLCreateParams
 end

data/lib/dodopayments/request_options.rb

@@ -69,5 +69,9 @@ module Dodopayments
     #   Returns a new instance of RequestOptions.
     #
     #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(Dodopayments::RequestOptions, Dodopayments::Internal::AnyHash) }
+    end
   end
 end

data/lib/dodopayments/resources/addons.rb

@@ -3,19 +3,15 @@
 module Dodopayments
   module Resources
     class Addons
-      # Some parameter documentations has been truncated, see
-      # {Dodopayments::Models::AddonCreateParams} for more details.
-      #
       # @overload create(currency:, name:, price:, tax_category:, description: nil, request_options: {})
       #
-      # @param currency [Symbol, Dodopayments::Models::Currency]
+      # @param currency [Symbol, Dodopayments::Models::Currency] The currency of the Addon
       #
       # @param name [String] Name of the Addon
       #
       # @param price [Integer] Amount of the addon
       #
-      # @param tax_category [Symbol, Dodopayments::Models::TaxCategory] Represents the different categories of taxation applicable to various products a
-      # ...
+      # @param tax_category [Symbol, Dodopayments::Models::TaxCategory] Tax category applied to this Addon
       #
       # @param description [String, nil] Optional description of the Addon
       #
@@ -25,12 +21,12 @@ module Dodopayments
       #
       # @see Dodopayments::Models::AddonCreateParams
       def create(params)
-        parsed, options = Dodopayments::Models::AddonCreateParams.dump_request(params)
+        parsed, options = Dodopayments::AddonCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "addons",
           body: parsed,
-          model: Dodopayments::Models::AddonResponse,
+          model: Dodopayments::AddonResponse,
           options: options
         )
       end
@@ -48,19 +44,16 @@ module Dodopayments
         @client.request(
           method: :get,
           path: ["addons/%1$s", id],
-          model: Dodopayments::Models::AddonResponse,
+          model: Dodopayments::AddonResponse,
           options: params[:request_options]
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {Dodopayments::Models::AddonUpdateParams} for more details.
-      #
       # @overload update(id, currency: nil, description: nil, image_id: nil, name: nil, price: nil, tax_category: nil, request_options: {})
       #
       # @param id [String] Addon Id
       #
-      # @param currency [Symbol, Dodopayments::Models::Currency, nil]
+      # @param currency [Symbol, Dodopayments::Models::Currency, nil] The currency of the Addon
       #
       # @param description [String, nil] Description of the Addon, optional and must be at most 1000 characters.
       #
@@ -70,8 +63,7 @@ module Dodopayments
       #
       # @param price [Integer, nil] Amount of the addon
       #
-      # @param tax_category [Symbol, Dodopayments::Models::TaxCategory, nil] Represents the different categories of taxation applicable to various products a
-      # ...
+      # @param tax_category [Symbol, Dodopayments::Models::TaxCategory, nil] Tax category of the Addon.
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -79,21 +71,21 @@ module Dodopayments
       #
       # @see Dodopayments::Models::AddonUpdateParams
       def update(id, params = {})
-        parsed, options = Dodopayments::Models::AddonUpdateParams.dump_request(params)
+        parsed, options = Dodopayments::AddonUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
           path: ["addons/%1$s", id],
           body: parsed,
-          model: Dodopayments::Models::AddonResponse,
+          model: Dodopayments::AddonResponse,
           options: options
         )
       end
 
       # @overload list(page_number: nil, page_size: nil, request_options: {})
       #
-      # @param page_number [Integer, nil] Page number default is 0
+      # @param page_number [Integer] Page number default is 0
       #
-      # @param page_size [Integer, nil] Page size default is 10 max is 100
+      # @param page_size [Integer] Page size default is 10 max is 100
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -101,13 +93,13 @@ module Dodopayments
       #
       # @see Dodopayments::Models::AddonListParams
       def list(params = {})
-        parsed, options = Dodopayments::Models::AddonListParams.dump_request(params)
+        parsed, options = Dodopayments::AddonListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "addons",
           query: parsed,
           page: Dodopayments::Internal::DefaultPageNumberPagination,
-          model: Dodopayments::Models::AddonResponse,
+          model: Dodopayments::AddonResponse,
           options: options
         )
       end

data/lib/dodopayments/resources/brands.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class Brands
+      # @overload create(description: nil, name: nil, statement_descriptor: nil, support_email: nil, url: nil, request_options: {})
+      #
+      # @param description [String, nil]
+      # @param name [String, nil]
+      # @param statement_descriptor [String, nil]
+      # @param support_email [String, nil]
+      # @param url [String, nil]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::Brand]
+      #
+      # @see Dodopayments::Models::BrandCreateParams
+      def create(params = {})
+        parsed, options = Dodopayments::BrandCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "brands",
+          body: parsed,
+          model: Dodopayments::Brand,
+          options: options
+        )
+      end
+
+      # Thin handler just calls `get_brand` and wraps in `Json(...)`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] Brand Id
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::Brand]
+      #
+      # @see Dodopayments::Models::BrandRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["brands/%1$s", id],
+          model: Dodopayments::Brand,
+          options: params[:request_options]
+        )
+      end
+
+      # @overload update(id, image_id: nil, name: nil, statement_descriptor: nil, support_email: nil, request_options: {})
+      #
+      # @param id [String] Brand Id
+      #
+      # @param image_id [String, nil] The UUID you got back from the presigned‐upload call
+      #
+      # @param name [String, nil]
+      #
+      # @param statement_descriptor [String, nil]
+      #
+      # @param support_email [String, nil]
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::Brand]
+      #
+      # @see Dodopayments::Models::BrandUpdateParams
+      def update(id, params = {})
+        parsed, options = Dodopayments::BrandUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["brands/%1$s", id],
+          body: parsed,
+          model: Dodopayments::Brand,
+          options: options
+        )
+      end
+
+      # @overload list(request_options: {})
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::BrandListResponse]
+      #
+      # @see Dodopayments::Models::BrandListParams
+      def list(params = {})
+        @client.request(
+          method: :get,
+          path: "brands",
+          model: Dodopayments::Models::BrandListResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @overload update_images(id, request_options: {})
+      #
+      # @param id [String] Brand Id
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::BrandUpdateImagesResponse]
+      #
+      # @see Dodopayments::Models::BrandUpdateImagesParams
+      def update_images(id, params = {})
+        @client.request(
+          method: :put,
+          path: ["brands/%1$s/images", id],
+          model: Dodopayments::Models::BrandUpdateImagesResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Dodopayments::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/dodopayments/resources/customers/customer_portal.rb

@@ -8,7 +8,7 @@ module Dodopayments
         #
         # @param customer_id [String] Customer Id
         #
-        # @param send_email [Boolean, nil] If true, will send link to user.
+        # @param send_email [Boolean] If true, will send link to user.
         #
         # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -16,12 +16,12 @@ module Dodopayments
         #
         # @see Dodopayments::Models::Customers::CustomerPortalCreateParams
         def create(customer_id, params = {})
-          parsed, options = Dodopayments::Models::Customers::CustomerPortalCreateParams.dump_request(params)
+          parsed, options = Dodopayments::Customers::CustomerPortalCreateParams.dump_request(params)
           @client.request(
             method: :post,
             path: ["customers/%1$s/customer-portal/session", customer_id],
             query: parsed,
-            model: Dodopayments::Models::CustomerPortalSession,
+            model: Dodopayments::CustomerPortalSession,
             options: options
           )
         end