dodopayments 1.22.0 → 1.47.0

data/lib/dodopayments/internal/util.rb

@@ -9,6 +9,23 @@ module Dodopayments
       # @return [Float]
       def self.monotonic_secs = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 
+      # @api private
+      #
+      # @param ns [Module, Class]
+      #
+      # @return [Enumerable<Module, Class>]
+      def self.walk_namespaces(ns)
+        ns.constants(false).lazy.flat_map do
+          case (c = ns.const_get(_1, false))
+          in Module | Class
+            walk_namespaces(c)
+          else
+            []
+          end
+        end
+          .chain([ns])
+      end
+
       class << self
         # @api private
         #
@@ -480,7 +497,7 @@ module Dodopayments
         # @param closing [Array<Proc>]
         # @param content_type [String, nil]
         private def write_multipart_content(y, val:, closing:, content_type: nil)
-          content_type ||= "application/octet-stream"
+          content_line = "Content-Type: %s\r\n\r\n"
 
           case val
           in Dodopayments::FilePart
@@ -491,24 +508,21 @@ module Dodopayments
               content_type: val.content_type
             )
           in Pathname
-            y << "Content-Type: #{content_type}\r\n\r\n"
+            y << format(content_line, content_type || "application/octet-stream")
             io = val.open(binmode: true)
             closing << io.method(:close)
             IO.copy_stream(io, y)
           in IO
-            y << "Content-Type: #{content_type}\r\n\r\n"
+            y << format(content_line, content_type || "application/octet-stream")
             IO.copy_stream(val, y)
           in StringIO
-            y << "Content-Type: #{content_type}\r\n\r\n"
+            y << format(content_line, content_type || "application/octet-stream")
             y << val.string
-          in String
-            y << "Content-Type: #{content_type}\r\n\r\n"
-            y << val.to_s
           in -> { primitive?(_1) }
-            y << "Content-Type: text/plain\r\n\r\n"
+            y << format(content_line, content_type || "text/plain")
             y << val.to_s
           else
-            y << "Content-Type: application/json\r\n\r\n"
+            y << format(content_line, content_type || "application/json")
             y << JSON.generate(val)
           end
           y << "\r\n"
@@ -535,7 +549,7 @@ module Dodopayments
             filename = ERB::Util.url_encode(val.filename)
             y << "; filename=\"#{filename}\""
           in Pathname | IO
-            filename = ERB::Util.url_encode(File.basename(val.to_path))
+            filename = ERB::Util.url_encode(::File.basename(val.to_path))
             y << "; filename=\"#{filename}\""
           else
           end
@@ -546,6 +560,8 @@ module Dodopayments
 
         # @api private
         #
+        # https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#special-considerations-for-multipart-content
+        #
         # @param body [Object]
         #
         # @return [Array(String, Enumerable<String>)]
@@ -583,11 +599,13 @@ module Dodopayments
         #
         # @return [Object]
         def encode_content(headers, body)
+          # rubocop:disable Style/CaseEquality
+          # rubocop:disable Layout/LineLength
           content_type = headers["content-type"]
           case [content_type, body]
           in [Dodopayments::Internal::Util::JSON_CONTENT, Hash | Array | -> { primitive?(_1) }]
             [headers, JSON.generate(body)]
-          in [Dodopayments::Internal::Util::JSONL_CONTENT, Enumerable] unless body.is_a?(Dodopayments::Internal::Type::FileInput)
+          in [Dodopayments::Internal::Util::JSONL_CONTENT, Enumerable] unless Dodopayments::Internal::Type::FileInput === body
             [headers, body.lazy.map { JSON.generate(_1) }]
           in [%r{^multipart/form-data}, Hash | Dodopayments::Internal::Type::FileInput]
             boundary, strio = encode_multipart_streaming(body)
@@ -602,6 +620,8 @@ module Dodopayments
           else
             [headers, body]
           end
+          # rubocop:enable Layout/LineLength
+          # rubocop:enable Style/CaseEquality
         end
 
         # @api private
@@ -801,6 +821,94 @@ module Dodopayments
           end
         end
       end
+
+      # @api private
+      module SorbetRuntimeSupport
+        class MissingSorbetRuntimeError < ::RuntimeError
+        end
+
+        # @api private
+        #
+        # @return [Hash{Symbol=>Object}]
+        private def sorbet_runtime_constants = @sorbet_runtime_constants ||= {}
+
+        # @api private
+        #
+        # @param name [Symbol]
+        def const_missing(name)
+          super unless sorbet_runtime_constants.key?(name)
+
+          unless Object.const_defined?(:T)
+            message = "Trying to access a Sorbet constant #{name.inspect} without `sorbet-runtime`."
+            raise MissingSorbetRuntimeError.new(message)
+          end
+
+          sorbet_runtime_constants.fetch(name).call
+        end
+
+        # @api private
+        #
+        # @param name [Symbol]
+        #
+        # @return [Boolean]
+        def sorbet_constant_defined?(name) = sorbet_runtime_constants.key?(name)
+
+        # @api private
+        #
+        # @param name [Symbol]
+        # @param blk [Proc]
+        def define_sorbet_constant!(name, &blk) = sorbet_runtime_constants.store(name, blk)
+
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type = raise NotImplementedError
+
+        class << self
+          # @api private
+          #
+          # @param type [Dodopayments::Internal::Util::SorbetRuntimeSupport, Object]
+          #
+          # @return [Object]
+          def to_sorbet_type(type)
+            case type
+            in Dodopayments::Internal::Util::SorbetRuntimeSupport
+              type.to_sorbet_type
+            in Class | Module
+              type
+            in true | false
+              T::Boolean
+            else
+              type.class
+            end
+          end
+        end
+      end
+
+      extend Dodopayments::Internal::Util::SorbetRuntimeSupport
+
+      define_sorbet_constant!(:ParsedUri) do
+        T.type_alias do
+          {
+            scheme: T.nilable(String),
+            host: T.nilable(String),
+            port: T.nilable(Integer),
+            path: T.nilable(String),
+            query: T::Hash[String, T::Array[String]]
+          }
+        end
+      end
+
+      define_sorbet_constant!(:ServerSentEvent) do
+        T.type_alias do
+          {
+            event: T.nilable(String),
+            data: T.nilable(String),
+            id: T.nilable(String),
+            retry: T.nilable(Integer)
+          }
+        end
+      end
     end
   end
 end

data/lib/dodopayments/internal.rb

@@ -2,10 +2,19 @@
 
 module Dodopayments
   module Internal
+    extend Dodopayments::Internal::Util::SorbetRuntimeSupport
+
     OMIT =
       Object.new.tap do
         _1.define_singleton_method(:inspect) { "#<#{Dodopayments::Internal}::OMIT>" }
       end
         .freeze
+
+    define_sorbet_constant!(:AnyHash) do
+      T.type_alias { T::Hash[Symbol, T.anything] }
+    end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, Dodopayments::FilePart) }
+    end
   end
 end

data/lib/dodopayments/models/addon_create_params.rb

@@ -8,9 +8,10 @@ module Dodopayments
       include Dodopayments::Internal::Type::RequestParameters
 
       # @!attribute currency
+      #   The currency of the Addon
       #
       #   @return [Symbol, Dodopayments::Models::Currency]
-      required :currency, enum: -> { Dodopayments::Models::Currency }
+      required :currency, enum: -> { Dodopayments::Currency }
 
       # @!attribute name
       #   Name of the Addon
@@ -25,11 +26,10 @@ module Dodopayments
       required :price, Integer
 
       # @!attribute tax_category
-      #   Represents the different categories of taxation applicable to various products
-      #   and services.
+      #   Tax category applied to this Addon
       #
       #   @return [Symbol, Dodopayments::Models::TaxCategory]
-      required :tax_category, enum: -> { Dodopayments::Models::TaxCategory }
+      required :tax_category, enum: -> { Dodopayments::TaxCategory }
 
       # @!attribute description
       #   Optional description of the Addon
@@ -38,17 +38,13 @@ module Dodopayments
       optional :description, String, nil?: true
 
       # @!method initialize(currency:, name:, price:, tax_category:, description: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Dodopayments::Models::AddonCreateParams} for more details.
-      #
-      #   @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
       #

data/lib/dodopayments/models/addon_list_params.rb

@@ -11,18 +11,18 @@ module Dodopayments
       #   Page number default is 0
       #
       #   @return [Integer, nil]
-      optional :page_number, Integer, nil?: true
+      optional :page_number, Integer
 
       # @!attribute page_size
       #   Page size default is 10 max is 100
       #
       #   @return [Integer, nil]
-      optional :page_size, Integer, nil?: true
+      optional :page_size, Integer
 
       # @!method initialize(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}]
     end

data/lib/dodopayments/models/addon_response.rb

@@ -23,9 +23,10 @@ module Dodopayments
       required :created_at, Time
 
       # @!attribute currency
+      #   Currency of the Addon
       #
       #   @return [Symbol, Dodopayments::Models::Currency]
-      required :currency, enum: -> { Dodopayments::Models::Currency }
+      required :currency, enum: -> { Dodopayments::Currency }
 
       # @!attribute name
       #   Name of the Addon
@@ -40,11 +41,10 @@ module Dodopayments
       required :price, Integer
 
       # @!attribute tax_category
-      #   Represents the different categories of taxation applicable to various products
-      #   and services.
+      #   Tax category applied to this Addon
       #
       #   @return [Symbol, Dodopayments::Models::TaxCategory]
-      required :tax_category, enum: -> { Dodopayments::Models::TaxCategory }
+      required :tax_category, enum: -> { Dodopayments::TaxCategory }
 
       # @!attribute updated_at
       #   Updated time
@@ -65,23 +65,19 @@ module Dodopayments
       optional :image, String, nil?: true
 
       # @!method initialize(id:, business_id:, created_at:, currency:, name:, price:, tax_category:, updated_at:, description: nil, image: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Dodopayments::Models::AddonResponse} for more details.
-      #
       #   @param id [String] id of the Addon
       #
       #   @param business_id [String] Unique identifier for the business to which the addon belongs.
       #
       #   @param created_at [Time] Created time
       #
-      #   @param currency [Symbol, Dodopayments::Models::Currency]
+      #   @param currency [Symbol, Dodopayments::Models::Currency] 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 updated_at [Time] Updated time
       #

data/lib/dodopayments/models/addon_update_params.rb

@@ -8,9 +8,10 @@ module Dodopayments
       include Dodopayments::Internal::Type::RequestParameters
 
       # @!attribute currency
+      #   The currency of the Addon
       #
       #   @return [Symbol, Dodopayments::Models::Currency, nil]
-      optional :currency, enum: -> { Dodopayments::Models::Currency }, nil?: true
+      optional :currency, enum: -> { Dodopayments::Currency }, nil?: true
 
       # @!attribute description
       #   Description of the Addon, optional and must be at most 1000 characters.
@@ -37,17 +38,13 @@ module Dodopayments
       optional :price, Integer, nil?: true
 
       # @!attribute tax_category
-      #   Represents the different categories of taxation applicable to various products
-      #   and services.
+      #   Tax category of the Addon.
       #
       #   @return [Symbol, Dodopayments::Models::TaxCategory, nil]
-      optional :tax_category, enum: -> { Dodopayments::Models::TaxCategory }, nil?: true
+      optional :tax_category, enum: -> { Dodopayments::TaxCategory }, nil?: true
 
       # @!method initialize(currency: nil, description: nil, image_id: nil, name: nil, price: nil, tax_category: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Dodopayments::Models::AddonUpdateParams} for more details.
-      #
-      #   @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.
       #
@@ -57,8 +54,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}]
     end

data/lib/dodopayments/models/attach_addon.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class AttachAddon < Dodopayments::Internal::Type::BaseModel
+      # @!attribute addon_id
+      #
+      #   @return [String]
+      required :addon_id, String
+
+      # @!attribute quantity
+      #
+      #   @return [Integer]
+      required :quantity, Integer
+
+      # @!method initialize(addon_id:, quantity:)
+      #   @param addon_id [String]
+      #   @param quantity [Integer]
+    end
+  end
+end

data/lib/dodopayments/models/billing_address.rb

@@ -10,10 +10,10 @@ module Dodopayments
       required :city, String
 
       # @!attribute country
-      #   ISO country code alpha2 variant
+      #   Two-letter ISO country code (ISO 3166-1 alpha-2)
       #
       #   @return [Symbol, Dodopayments::Models::CountryCode]
-      required :country, enum: -> { Dodopayments::Models::CountryCode }
+      required :country, enum: -> { Dodopayments::CountryCode }
 
       # @!attribute state
       #   State or province name
@@ -36,7 +36,7 @@ module Dodopayments
       # @!method initialize(city:, country:, state:, street:, zipcode:)
       #   @param city [String] City name
       #
-      #   @param country [Symbol, Dodopayments::Models::CountryCode] ISO country code alpha2 variant
+      #   @param country [Symbol, Dodopayments::Models::CountryCode] Two-letter ISO country code (ISO 3166-1 alpha-2)
       #
       #   @param state [String] State or province name
       #

data/lib/dodopayments/models/brand.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Brands#create
+    class Brand < Dodopayments::Internal::Type::BaseModel
+      # @!attribute brand_id
+      #
+      #   @return [String]
+      required :brand_id, String
+
+      # @!attribute business_id
+      #
+      #   @return [String]
+      required :business_id, String
+
+      # @!attribute enabled
+      #
+      #   @return [Boolean]
+      required :enabled, Dodopayments::Internal::Type::Boolean
+
+      # @!attribute statement_descriptor
+      #
+      #   @return [String]
+      required :statement_descriptor, String
+
+      # @!attribute verification_enabled
+      #
+      #   @return [Boolean]
+      required :verification_enabled, Dodopayments::Internal::Type::Boolean
+
+      # @!attribute verification_status
+      #
+      #   @return [Symbol, Dodopayments::Models::Brand::VerificationStatus]
+      required :verification_status, enum: -> { Dodopayments::Brand::VerificationStatus }
+
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute image
+      #
+      #   @return [String, nil]
+      optional :image, String, nil?: true
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute reason_for_hold
+      #   Incase the brand verification fails or is put on hold
+      #
+      #   @return [String, nil]
+      optional :reason_for_hold, String, nil?: true
+
+      # @!attribute support_email
+      #
+      #   @return [String, nil]
+      optional :support_email, String, nil?: true
+
+      # @!attribute url
+      #
+      #   @return [String, nil]
+      optional :url, String, nil?: true
+
+      # @!method initialize(brand_id:, business_id:, enabled:, statement_descriptor:, verification_enabled:, verification_status:, description: nil, image: nil, name: nil, reason_for_hold: nil, support_email: nil, url: nil)
+      #   @param brand_id [String]
+      #
+      #   @param business_id [String]
+      #
+      #   @param enabled [Boolean]
+      #
+      #   @param statement_descriptor [String]
+      #
+      #   @param verification_enabled [Boolean]
+      #
+      #   @param verification_status [Symbol, Dodopayments::Models::Brand::VerificationStatus]
+      #
+      #   @param description [String, nil]
+      #
+      #   @param image [String, nil]
+      #
+      #   @param name [String, nil]
+      #
+      #   @param reason_for_hold [String, nil] Incase the brand verification fails or is put on hold
+      #
+      #   @param support_email [String, nil]
+      #
+      #   @param url [String, nil]
+
+      # @see Dodopayments::Models::Brand#verification_status
+      module VerificationStatus
+        extend Dodopayments::Internal::Type::Enum
+
+        SUCCESS = :Success
+        FAIL = :Fail
+        REVIEW = :Review
+        HOLD = :Hold
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/brand_create_params.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Brands#create
+    class BrandCreateParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute statement_descriptor
+      #
+      #   @return [String, nil]
+      optional :statement_descriptor, String, nil?: true
+
+      # @!attribute support_email
+      #
+      #   @return [String, nil]
+      optional :support_email, String, nil?: true
+
+      # @!attribute url
+      #
+      #   @return [String, nil]
+      optional :url, String, nil?: true
+
+      # @!method initialize(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}]
+    end
+  end
+end

data/lib/dodopayments/models/{webhook_event_retrieve_params.rb → brand_list_params.rb}

@@ -2,8 +2,8 @@
 
 module Dodopayments
   module Models
-    # @see Dodopayments::Resources::WebhookEvents#retrieve
-    class WebhookEventRetrieveParams < Dodopayments::Internal::Type::BaseModel
+    # @see Dodopayments::Resources::Brands#list
+    class BrandListParams < Dodopayments::Internal::Type::BaseModel
       extend Dodopayments::Internal::Type::RequestParameters::Converter
       include Dodopayments::Internal::Type::RequestParameters
 

data/lib/dodopayments/models/brand_list_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Brands#list
+    class BrandListResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute items
+      #   List of brands for this business
+      #
+      #   @return [Array<Dodopayments::Models::Brand>]
+      required :items, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Brand] }
+
+      # @!method initialize(items:)
+      #   @param items [Array<Dodopayments::Models::Brand>] List of brands for this business
+    end
+  end
+end

data/lib/dodopayments/models/brand_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Brands#retrieve
+    class BrandRetrieveParams < 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/brand_update_images_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Brands#update_images
+    class BrandUpdateImagesParams < 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/brand_update_images_response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Brands#update_images
+    class BrandUpdateImagesResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute image_id
+      #   UUID that will be used as the image identifier/key suffix
+      #
+      #   @return [String]
+      required :image_id, String
+
+      # @!attribute url
+      #   Presigned URL to upload the image
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!method initialize(image_id:, url:)
+      #   @param image_id [String] UUID that will be used as the image identifier/key suffix
+      #
+      #   @param url [String] Presigned URL to upload the image
+    end
+  end
+end