straddle 0.4.0 → 1.0.0

data/lib/straddle/internal/util.rb

@@ -15,14 +15,17 @@ module Straddle
       #
       # @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
-            []
+        ns
+          .constants(false)
+          .lazy
+          .flat_map do
+            case (c = ns.const_get(_1, false))
+            in Module | Class
+              walk_namespaces(c)
+            else
+              []
+            end
           end
-        end
           .chain([ns])
       end
 
@@ -157,7 +160,7 @@ module Straddle
           in Hash | nil => coerced
             coerced
           else
-            message = "Expected a #{Hash} or #{Straddle::Internal::Type::BaseModel}, got #{data.inspect}"
+            message = "Expected a #{Hash} or #{Straddle::Internal::Type::BaseModel}, got #{input.inspect}"
             raise ArgumentError.new(message)
           end
         end
@@ -197,9 +200,7 @@ module Straddle
         def deep_merge(*values, sentinel: nil, concat: false)
           case values
           in [value, *values]
-            values.reduce(value) do |acc, val|
-              deep_merge_lr(acc, val, concat: concat)
-            end
+            values.reduce(value) { |acc, val| deep_merge_lr(acc, val, concat: concat) }
           else
             sentinel
           end
@@ -237,6 +238,11 @@ module Straddle
         end
       end
 
+      # @type [Regexp]
+      #
+      # https://www.rfc-editor.org/rfc/rfc3986.html#section-3.3
+      RFC_3986_NOT_PCHARS = /[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/
+
       class << self
         # @api private
         #
@@ -247,6 +253,15 @@ module Straddle
           "#{uri.scheme}://#{uri.host}#{":#{uri.port}" unless uri.port == uri.default_port}"
         end
 
+        # @api private
+        #
+        # @param path [String, Integer]
+        #
+        # @return [String]
+        def encode_path(path)
+          path.to_s.gsub(Straddle::Internal::Util::RFC_3986_NOT_PCHARS) { ERB::Util.url_encode(_1) }
+        end
+
         # @api private
         #
         # @param path [String, Array<String>]
@@ -259,7 +274,7 @@ module Straddle
           in []
             ""
           in [String => p, *interpolations]
-            encoded = interpolations.map { ERB::Util.url_encode(_1) }
+            encoded = interpolations.map { encode_path(_1) }
             format(p, *encoded)
           end
         end
@@ -351,12 +366,13 @@ module Straddle
           override = URI::Generic.build(**merged.slice(:scheme, :host, :port), path: parsed_path)
 
           joined = URI.join(URI::Generic.build(lhs.except(:path, :query)), slashed, override)
-          query = deep_merge(
-            joined.path == base_path ? base_query : {},
-            parsed_query,
-            rhs[:query].to_h,
-            concat: true
-          )
+          query =
+            deep_merge(
+              joined.path == base_path ? base_query : {},
+              parsed_query,
+              rhs[:query].to_h,
+              concat: true
+            )
 
           joined.query = encode_query(query)
           joined
@@ -370,16 +386,17 @@ module Straddle
         #
         # @return [Hash{String=>String}]
         def normalized_headers(*headers)
-          {}.merge(*headers.compact).to_h do |key, val|
-            value =
-              case val
-              in Array
-                val.filter_map { _1&.to_s&.strip }.join(", ")
-              else
-                val&.to_s&.strip
-              end
-            [key.downcase, value]
-          end
+          {}.merge(*headers.compact)
+            .to_h do |key, val|
+              value =
+                case val
+                in Array
+                  val.filter_map { _1&.to_s&.strip }.join(", ")
+                else
+                  val&.to_s&.strip
+                end
+              [key.downcase, value]
+            end
         end
       end
 
@@ -441,8 +458,7 @@ module Straddle
             in nil
               read
             end
-          end
-            .tap(&@blk)
+          end.tap(&@blk)
         end
 
         # @api private
@@ -511,9 +527,7 @@ module Straddle
         private def write_query_param_element!(collection, key, element)
           case element
           in Hash
-            element.each do |name, value|
-              write_query_param_element!(collection, "#{key}[#{name}]", value)
-            end
+            element.each { |name, value| write_query_param_element!(collection, "#{key}[#{name}]", value) }
           in Array
             collection[key] = element.map(&:to_s).join(",")
           else
@@ -532,11 +546,8 @@ module Straddle
 
           case val
           in Straddle::FilePart
-            return write_multipart_content(
-              y,
-              val: val.content,
-              closing: closing,
-              content_type: val.content_type
+            return (
+              write_multipart_content(y, val: val.content, closing: closing, content_type: val.content_type)
             )
           in Pathname
             y << format(content_line, content_type || "application/octet-stream")
@@ -570,17 +581,14 @@ module Straddle
           y << "--#{boundary}\r\n"
           y << "Content-Disposition: form-data"
 
-          unless key.nil?
-            name = ERB::Util.url_encode(key.to_s)
-            y << "; name=\"#{name}\""
-          end
+          y << "; name=\"#{key}\"" unless key.nil?
 
           case val
           in Straddle::FilePart unless val.filename.nil?
-            filename = ERB::Util.url_encode(val.filename)
+            filename = encode_path(val.filename)
             y << "; filename=\"#{filename}\""
           in Pathname | IO
-            filename = ERB::Util.url_encode(::File.basename(val.to_path))
+            filename = encode_path(::File.basename(val.to_path))
             y << "; filename=\"#{filename}\""
           else
           end
@@ -597,31 +605,34 @@ module Straddle
         #
         # @return [Array(String, Enumerable<String>)]
         private def encode_multipart_streaming(body)
+          # rubocop:disable Style/CaseEquality
           # RFC 1521 Section 7.2.1 says we should have 70 char maximum for boundary length
           boundary = SecureRandom.urlsafe_base64(46)
 
           closing = []
-          strio = writable_enum do |y|
-            case body
-            in Hash
-              body.each do |key, val|
-                case val
-                in Array if val.all? { primitive?(_1) }
-                  val.each do |v|
-                    write_multipart_chunk(y, boundary: boundary, key: key, val: v, closing: closing)
+          strio =
+            writable_enum do |y|
+              case body
+              in Hash
+                body.each do |key, val|
+                  case val
+                  in Array if val.all? { primitive?(_1) || Straddle::Internal::Type::FileInput === _1 }
+                    val.each do |v|
+                      write_multipart_chunk(y, boundary: boundary, key: key, val: v, closing: closing)
+                    end
+                  else
+                    write_multipart_chunk(y, boundary: boundary, key: key, val: val, closing: closing)
                   end
-                else
-                  write_multipart_chunk(y, boundary: boundary, key: key, val: val, closing: closing)
                 end
+              else
+                write_multipart_chunk(y, boundary: boundary, key: nil, val: body, closing: closing)
               end
-            else
-              write_multipart_chunk(y, boundary: boundary, key: nil, val: body, closing: closing)
+              y << "--#{boundary}--\r\n"
             end
-            y << "--#{boundary}--\r\n"
-          end
 
           fused_io = fused_enum(strio) { closing.each(&:call) }
           [boundary, fused_io]
+          # rubocop:enable Style/CaseEquality
         end
 
         # @api private
@@ -632,12 +643,14 @@ module Straddle
         # @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 [Straddle::Internal::Util::JSON_CONTENT, Hash | Array | -> { primitive?(_1) }]
             [headers, JSON.generate(body)]
-          in [Straddle::Internal::Util::JSONL_CONTENT, Enumerable] unless Straddle::Internal::Type::FileInput === body
+          in [
+               Straddle::Internal::Util::JSONL_CONTENT,
+               Enumerable
+             ] unless Straddle::Internal::Type::FileInput === body
             [headers, body.lazy.map { JSON.generate(_1) }]
           in [%r{^multipart/form-data}, Hash | Straddle::Internal::Type::FileInput]
             boundary, strio = encode_multipart_streaming(body)
@@ -652,7 +665,6 @@ module Straddle
           else
             [headers, body]
           end
-          # rubocop:enable Layout/LineLength
           # rubocop:enable Style/CaseEquality
         end
 
@@ -728,19 +740,16 @@ module Straddle
         # @return [Enumerable<Object>]
         def fused_enum(enum, external: false, &close)
           fused = false
-          iter = Enumerator.new do |y|
-            next if fused
-
-            fused = true
-            if external
-              loop { y << enum.next }
-            else
-              enum.each(&y)
+          iter =
+            Enumerator.new do |y|
+              next if fused
+
+              fused = true
+              external ? loop { y << enum.next } : enum.each(&y)
+            ensure
+              close&.call
+              close = nil
             end
-          ensure
-            close&.call
-            close = nil
-          end
 
           iter.define_singleton_method(:rewind) do
             fused = true

data/lib/straddle/internal.rb

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

data/lib/straddle/models/account.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class Account < Straddle::Internal::Type::BaseModel
+      # @!attribute id
+      #   Straddle's unique ID for the account.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute access_level
+      #   The account access level. `standard` provides normal account access, including
+      #   access to the Straddle dashboard. `managed` means the platform manages the
+      #   account and account users cannot access the Straddle dashboard.
+      #
+      #   @return [Symbol, Straddle::Models::Account::AccessLevel]
+      required :access_level, enum: -> { Straddle::Account::AccessLevel }
+
+      # @!attribute organization_id
+      #   ID of the organization that owns the account.
+      #
+      #   @return [String]
+      required :organization_id, String
+
+      # @!attribute status
+      #   The current lifecycle status of the account.
+      #
+      #   @return [Symbol, Straddle::Models::Account::Status]
+      required :status, enum: -> { Straddle::Account::Status }
+
+      # @!attribute status_detail
+      #
+      #   @return [Straddle::Models::AccountStatusDetail]
+      required :status_detail, -> { Straddle::AccountStatusDetail }
+
+      # @!attribute type
+      #   The account type. Only `business` is supported.
+      #
+      #   @return [Symbol, Straddle::Models::Account::Type]
+      required :type, enum: -> { Straddle::Account::Type }
+
+      # @!attribute business_profile
+      #
+      #   @return [Straddle::Models::AccountBusinessProfile, nil]
+      optional :business_profile, -> { Straddle::AccountBusinessProfile }
+
+      # @!attribute capabilities
+      #
+      #   @return [Straddle::Models::AccountCapabilities, nil]
+      optional :capabilities, -> { Straddle::AccountCapabilities }
+
+      # @!attribute created_at
+      #   Date and time when Straddle created the account.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time, nil?: true
+
+      # @!attribute external_id
+      #   Your unique ID for the account.
+      #
+      #   @return [String, nil]
+      optional :external_id, String, nil?: true
+
+      # @!attribute metadata
+      #   Up to 20 user-defined key-value pairs.
+      #
+      #   @return [Hash{Symbol=>String, nil}, nil]
+      optional :metadata, Straddle::Internal::Type::HashOf[String, nil?: true], nil?: true
+
+      # @!attribute settings
+      #
+      #   @return [Straddle::Models::AccountPaymentSettings, nil]
+      optional :settings, -> { Straddle::AccountPaymentSettings }
+
+      # @!attribute terms_of_service
+      #
+      #   @return [Straddle::Models::TermsOfService, nil]
+      optional :terms_of_service, -> { Straddle::TermsOfService }
+
+      # @!attribute updated_at
+      #   Date and time of the most recent account update.
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, nil?: true
+
+      # @!method initialize(id:, access_level:, organization_id:, status:, status_detail:, type:, business_profile: nil, capabilities: nil, created_at: nil, external_id: nil, metadata: nil, settings: nil, terms_of_service: nil, updated_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::Account} for more details.
+      #
+      #   @param id [String] Straddle's unique ID for the account.
+      #
+      #   @param access_level [Symbol, Straddle::Models::Account::AccessLevel] The account access level. `standard` provides normal account access, including a
+      #
+      #   @param organization_id [String] ID of the organization that owns the account.
+      #
+      #   @param status [Symbol, Straddle::Models::Account::Status] The current lifecycle status of the account.
+      #
+      #   @param status_detail [Straddle::Models::AccountStatusDetail]
+      #
+      #   @param type [Symbol, Straddle::Models::Account::Type] The account type. Only `business` is supported.
+      #
+      #   @param business_profile [Straddle::Models::AccountBusinessProfile]
+      #
+      #   @param capabilities [Straddle::Models::AccountCapabilities]
+      #
+      #   @param created_at [Time, nil] Date and time when Straddle created the account.
+      #
+      #   @param external_id [String, nil] Your unique ID for the account.
+      #
+      #   @param metadata [Hash{Symbol=>String, nil}, nil] Up to 20 user-defined key-value pairs.
+      #
+      #   @param settings [Straddle::Models::AccountPaymentSettings]
+      #
+      #   @param terms_of_service [Straddle::Models::TermsOfService]
+      #
+      #   @param updated_at [Time, nil] Date and time of the most recent account update.
+
+      # The account access level. `standard` provides normal account access, including
+      # access to the Straddle dashboard. `managed` means the platform manages the
+      # account and account users cannot access the Straddle dashboard.
+      #
+      # @see Straddle::Models::Account#access_level
+      module AccessLevel
+        extend Straddle::Internal::Type::Enum
+
+        STANDARD = :standard
+        MANAGED = :managed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The current lifecycle status of the account.
+      #
+      # @see Straddle::Models::Account#status
+      module Status
+        extend Straddle::Internal::Type::Enum
+
+        CREATED = :created
+        ONBOARDING = :onboarding
+        ACTIVE = :active
+        REJECTED = :rejected
+        INACTIVE = :inactive
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The account type. Only `business` is supported.
+      #
+      # @see Straddle::Models::Account#type
+      module Type
+        extend Straddle::Internal::Type::Enum
+
+        BUSINESS = :business
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/account_address.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class AccountAddress < Straddle::Internal::Type::BaseModel
+      # @!attribute city
+      #   City, district, suburb, town, or village.
+      #
+      #   @return [String, nil]
+      required :city, String, nil?: true
+
+      # @!attribute line1
+      #   Primary address line, such as a street address or PO Box.
+      #
+      #   @return [String, nil]
+      required :line1, String, nil?: true
+
+      # @!attribute postal_code
+      #   Postal or ZIP code.
+      #
+      #   @return [String, nil]
+      required :postal_code, String, nil?: true
+
+      # @!attribute state
+      #   Two-letter state code.
+      #
+      #   @return [String, nil]
+      required :state, String, nil?: true
+
+      # @!attribute country
+      #   Two-letter ISO 3166-1 country code. If omitted, Straddle applies US address
+      #   validation.
+      #
+      #   @return [String, nil]
+      optional :country, String, nil?: true
+
+      # @!attribute line2
+      #   Secondary address line, such as an apartment, suite, unit, or building.
+      #
+      #   @return [String, nil]
+      optional :line2, String, nil?: true
+
+      # @!method initialize(city:, line1:, postal_code:, state:, country: nil, line2: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::AccountAddress} for more details.
+      #
+      #   Optional business address. If provided, `line1`, `city`, `state`, and
+      #   `postal_code` are required.
+      #
+      #   @param city [String, nil] City, district, suburb, town, or village.
+      #
+      #   @param line1 [String, nil] Primary address line, such as a street address or PO Box.
+      #
+      #   @param postal_code [String, nil] Postal or ZIP code.
+      #
+      #   @param state [String, nil] Two-letter state code.
+      #
+      #   @param country [String, nil] Two-letter ISO 3166-1 country code. If omitted, Straddle applies US address vali
+      #
+      #   @param line2 [String, nil] Secondary address line, such as an apartment, suite, unit, or building.
+    end
+  end
+end

data/lib/straddle/models/account_business_profile.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class AccountBusinessProfile < Straddle::Internal::Type::BaseModel
+      # @!attribute name
+      #   The operating or trade name of the business.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute website
+      #   URL of the business's primary website.
+      #
+      #   @return [String]
+      required :website, String
+
+      # @!attribute address
+      #   Optional business address. If provided, `line1`, `city`, `state`, and
+      #   `postal_code` are required.
+      #
+      #   @return [Straddle::Models::AccountAddress, nil]
+      optional :address, -> { Straddle::AccountAddress }, nil?: true
+
+      # @!attribute description
+      #   Description of the business and its products or services.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute industry
+      #
+      #   @return [Straddle::Models::AccountIndustry, nil]
+      optional :industry, -> { Straddle::AccountIndustry }
+
+      # @!attribute legal_name
+      #   The official registered name of the business.
+      #
+      #   @return [String, nil]
+      optional :legal_name, String, nil?: true
+
+      # @!attribute phone
+      #   Primary business phone number in E.164 format.
+      #
+      #   @return [String, nil]
+      optional :phone, String, nil?: true
+
+      # @!attribute support_channels
+      #
+      #   @return [Straddle::Models::AccountSupportChannels, nil]
+      optional :support_channels, -> { Straddle::AccountSupportChannels }
+
+      # @!attribute tax_id
+      #   Business tax identification number, such as a US Employer Identification Number
+      #   (EIN).
+      #
+      #   @return [String, nil]
+      optional :tax_id, String, nil?: true
+
+      # @!attribute use_case
+      #   How the business plans to use Straddle.
+      #
+      #   @return [String, nil]
+      optional :use_case, String, nil?: true
+
+      # @!method initialize(name:, website:, address: nil, description: nil, industry: nil, legal_name: nil, phone: nil, support_channels: nil, tax_id: nil, use_case: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::AccountBusinessProfile} for more details.
+      #
+      #   @param name [String] The operating or trade name of the business.
+      #
+      #   @param website [String] URL of the business's primary website.
+      #
+      #   @param address [Straddle::Models::AccountAddress, nil] Optional business address. If provided, `line1`, `city`, `state`, and `postal_co
+      #
+      #   @param description [String, nil] Description of the business and its products or services.
+      #
+      #   @param industry [Straddle::Models::AccountIndustry]
+      #
+      #   @param legal_name [String, nil] The official registered name of the business.
+      #
+      #   @param phone [String, nil] Primary business phone number in E.164 format.
+      #
+      #   @param support_channels [Straddle::Models::AccountSupportChannels]
+      #
+      #   @param tax_id [String, nil] Business tax identification number, such as a US Employer Identification Number
+      #
+      #   @param use_case [String, nil] How the business plans to use Straddle.
+    end
+  end
+end

data/lib/straddle/models/account_capabilities.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class AccountCapabilities < Straddle::Internal::Type::BaseModel
+      # @!attribute consent_types
+      #
+      #   @return [Straddle::Models::AccountConsentCapabilities]
+      required :consent_types, -> { Straddle::AccountConsentCapabilities }
+
+      # @!attribute customer_types
+      #
+      #   @return [Straddle::Models::AccountCustomerCapabilities]
+      required :customer_types, -> { Straddle::AccountCustomerCapabilities }
+
+      # @!attribute payment_types
+      #
+      #   @return [Straddle::Models::AccountPaymentCapabilities]
+      required :payment_types, -> { Straddle::AccountPaymentCapabilities }
+
+      # @!method initialize(consent_types:, customer_types:, payment_types:)
+      #   @param consent_types [Straddle::Models::AccountConsentCapabilities]
+      #   @param customer_types [Straddle::Models::AccountCustomerCapabilities]
+      #   @param payment_types [Straddle::Models::AccountPaymentCapabilities]
+    end
+  end
+end

data/lib/straddle/models/account_capability.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class AccountCapability < Straddle::Internal::Type::BaseModel
+      # @!attribute capability_status
+      #   Status of the capability for the account.
+      #
+      #   @return [Symbol, Straddle::Models::AccountCapability::CapabilityStatus]
+      required :capability_status, enum: -> { Straddle::AccountCapability::CapabilityStatus }
+
+      # @!method initialize(capability_status:)
+      #   @param capability_status [Symbol, Straddle::Models::AccountCapability::CapabilityStatus] Status of the capability for the account.
+
+      # Status of the capability for the account.
+      #
+      # @see Straddle::Models::AccountCapability#capability_status
+      module CapabilityStatus
+        extend Straddle::Internal::Type::Enum
+
+        ACTIVE = :active
+        INACTIVE = :inactive
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end