modern_treasury 0.1.0.pre.alpha.15 → 0.1.0.pre.alpha.17

data/lib/modern_treasury/models/wealth_and_employment_details.rb

@@ -2,7 +2,7 @@
 
 module ModernTreasury
   module Models
-    class WealthAndEmploymentDetails < ModernTreasury::BaseModel
+    class WealthAndEmploymentDetails < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -78,10 +78,10 @@ module ModernTreasury
 
       # @!attribute live_mode
       #   This field will be true if this object exists in the live environment or false
-      #     if it exists in the test environment.
+      #   if it exists in the test environment.
       #
       #   @return [Boolean]
-      required :live_mode, ModernTreasury::BooleanModel
+      required :live_mode, ModernTreasury::Internal::Type::Boolean
 
       # @!attribute object
       #
@@ -161,28 +161,14 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # The employment status of the individual.
       #
-      # @example
-      # ```ruby
-      # case employment_status
-      # in :employed
-      #   # ...
-      # in :retired
-      #   # ...
-      # in :self_employed
-      #   # ...
-      # in :student
-      #   # ...
-      # in :unemployed
-      #   # ...
-      # end
-      # ```
-      class EmploymentStatus < ModernTreasury::Enum
+      # @see ModernTreasury::Models::WealthAndEmploymentDetails#employment_status
+      module EmploymentStatus
+        extend ModernTreasury::Internal::Type::Enum
+
         EMPLOYED = :employed
         RETIRED = :retired
         SELF_EMPLOYED = :self_employed
@@ -193,32 +179,15 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The source of the individual's income.
       #
-      # @example
-      # ```ruby
-      # case income_source
-      # in :family_support
-      #   # ...
-      # in :government_benefits
-      #   # ...
-      # in :inheritance
-      #   # ...
-      # in :investments
-      #   # ...
-      # in :rental_income
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class IncomeSource < ModernTreasury::Enum
+      # @see ModernTreasury::Models::WealthAndEmploymentDetails#income_source
+      module IncomeSource
+        extend ModernTreasury::Internal::Type::Enum
+
         FAMILY_SUPPORT = :family_support
         GOVERNMENT_BENEFITS = :government_benefits
         INHERITANCE = :inheritance
@@ -232,32 +201,15 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The industry of the individual.
       #
-      # @example
-      # ```ruby
-      # case industry
-      # in :accounting
-      #   # ...
-      # in :agriculture
-      #   # ...
-      # in :automotive
-      #   # ...
-      # in :chemical_manufacturing
-      #   # ...
-      # in :construction
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class Industry < ModernTreasury::Enum
+      # @see ModernTreasury::Models::WealthAndEmploymentDetails#industry
+      module Industry
+        extend ModernTreasury::Internal::Type::Enum
+
         ACCOUNTING = :accounting
         AGRICULTURE = :agriculture
         AUTOMOTIVE = :automotive
@@ -296,32 +248,15 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The occupation of the individual.
       #
-      # @example
-      # ```ruby
-      # case occupation
-      # in :consulting
-      #   # ...
-      # in :executive
-      #   # ...
-      # in :finance_accounting
-      #   # ...
-      # in :food_services
-      #   # ...
-      # in :government
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class Occupation < ModernTreasury::Enum
+      # @see ModernTreasury::Models::WealthAndEmploymentDetails#occupation
+      module Occupation
+        extend ModernTreasury::Internal::Type::Enum
+
         CONSULTING = :consulting
         EXECUTIVE = :executive
         FINANCE_ACCOUNTING = :finance_accounting
@@ -339,32 +274,15 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The source of the individual's funds.
       #
-      # @example
-      # ```ruby
-      # case source_of_funds
-      # in :alimony
-      #   # ...
-      # in :annuity
-      #   # ...
-      # in :business_owner
-      #   # ...
-      # in :general_employee
-      #   # ...
-      # in :government_benefits
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class SourceOfFunds < ModernTreasury::Enum
+      # @see ModernTreasury::Models::WealthAndEmploymentDetails#source_of_funds
+      module SourceOfFunds
+        extend ModernTreasury::Internal::Type::Enum
+
         ALIMONY = :alimony
         ANNUITY = :annuity
         BUSINESS_OWNER = :business_owner
@@ -387,32 +305,15 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The source of the individual's wealth.
       #
-      # @example
-      # ```ruby
-      # case wealth_source
-      # in :business_sale
-      #   # ...
-      # in :family_support
-      #   # ...
-      # in :government_benefits
-      #   # ...
-      # in :inheritance
-      #   # ...
-      # in :investments
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class WealthSource < ModernTreasury::Enum
+      # @see ModernTreasury::Models::WealthAndEmploymentDetails#wealth_source
+      module WealthSource
+        extend ModernTreasury::Internal::Type::Enum
+
         BUSINESS_SALE = :business_sale
         FAMILY_SUPPORT = :family_support
         GOVERNMENT_BENEFITS = :government_benefits
@@ -428,7 +329,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/request_options.rb

@@ -1,57 +1,17 @@
 # frozen_string_literal: true
 
 module ModernTreasury
-  # @private
-  #
-  # @abstract
-  #
-  module RequestParameters
-    # @!parse
-    #   # Options to specify HTTP behaviour for this request.
-    #   # @return [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-    #   attr_accessor :request_options
-
-    # @param mod [Module]
-    #
-    def self.included(mod)
-      return unless mod <= ModernTreasury::BaseModel
-
-      mod.extend(ModernTreasury::RequestParameters::Converter)
-      mod.optional(:request_options, ModernTreasury::RequestOptions)
-    end
-
-    # @private
-    #
-    module Converter
-      # @private
-      #
-      # @param params [Object]
-      #
-      # @return [Array(Object, Hash{Symbol=>Object})]
-      #
-      def dump_request(params)
-        case (dumped = dump(params))
-        in Hash
-          [dumped.except(:request_options), dumped[:request_options]]
-        else
-          [dumped, nil]
-        end
-      end
-    end
-  end
-
   # Specify HTTP behaviour to use for a specific request. These options supplement
-  #   or override those provided at the client level.
+  # or override those provided at the client level.
   #
-  #   When making a request, you can pass an actual {RequestOptions} instance, or
-  #   simply pass a Hash with symbol keys matching the attributes on this class.
-  class RequestOptions < ModernTreasury::BaseModel
-    # @private
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < ModernTreasury::Internal::Type::BaseModel
+    # @api private
     #
     # @param opts [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
     #
     # @raise [ArgumentError]
-    #
     def self.validate!(opts)
       case opts
       in ModernTreasury::RequestOptions | Hash
@@ -67,31 +27,32 @@ module ModernTreasury
 
     # @!attribute idempotency_key
     #   Idempotency key to send with request and all associated retries. Will only be
-    #     sent for write requests.
+    #   sent for write requests.
     #
     #   @return [String, nil]
     optional :idempotency_key, String
 
     # @!attribute extra_query
     #   Extra query params to send with the request. These are `.merge`’d into any
-    #     `query` given at the client level.
+    #   `query` given at the client level.
     #
     #   @return [Hash{String=>Array<String>, String, nil}, nil]
-    optional :extra_query, ModernTreasury::HashOf[ModernTreasury::ArrayOf[String]]
+    optional :extra_query,
+             ModernTreasury::Internal::Type::HashOf[ModernTreasury::Internal::Type::ArrayOf[String]]
 
     # @!attribute extra_headers
     #   Extra headers to send with the request. These are `.merged`’d into any
-    #     `extra_headers` given at the client level.
+    #   `extra_headers` given at the client level.
     #
     #   @return [Hash{String=>String, nil}, nil]
-    optional :extra_headers, ModernTreasury::HashOf[String, nil?: true]
+    optional :extra_headers, ModernTreasury::Internal::Type::HashOf[String, nil?: true]
 
     # @!attribute extra_body
     #   Extra data to send with the request. These are deep merged into any data
-    #     generated as part of the normal request.
+    #   generated as part of the normal request.
     #
-    #   @return [Hash{Symbol=>Object}, nil]
-    optional :extra_body, ModernTreasury::HashOf[ModernTreasury::Unknown]
+    #   @return [Object, nil]
+    optional :extra_body, ModernTreasury::Internal::Type::HashOf[ModernTreasury::Internal::Type::Unknown]
 
     # @!attribute max_retries
     #   Maximum number of retries to attempt after a failed initial request.

data/lib/modern_treasury/resources/account_collection_flows.rb

@@ -5,18 +5,16 @@ module ModernTreasury
     class AccountCollectionFlows
       # create account_collection_flow
       #
-      # @param params [ModernTreasury::Models::AccountCollectionFlowCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(counterparty_id:, payment_types:, receiving_countries: nil, request_options: {})
       #
-      #   @option params [String] :counterparty_id Required.
-      #
-      #   @option params [Array<String>] :payment_types
-      #
-      #   @option params [Array<Symbol, ModernTreasury::Models::AccountCollectionFlowCreateParams::ReceivingCountry>] :receiving_countries
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param counterparty_id [String]
+      # @param payment_types [Array<String>]
+      # @param receiving_countries [Array<Symbol, ModernTreasury::Models::AccountCollectionFlowCreateParams::ReceivingCountry>]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::AccountCollectionFlow]
       #
+      # @see ModernTreasury::Models::AccountCollectionFlowCreateParams
       def create(params)
         parsed, options = ModernTreasury::Models::AccountCollectionFlowCreateParams.dump_request(params)
         @client.request(
@@ -30,18 +28,18 @@ module ModernTreasury
 
       # get account_collection_flow
       #
-      # @param id [String] id
-      #
-      # @param params [ModernTreasury::Models::AccountCollectionFlowRetrieveParams, Hash{Symbol=>Object}] .
+      # @overload retrieve(id, request_options: {})
       #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::AccountCollectionFlow]
       #
+      # @see ModernTreasury::Models::AccountCollectionFlowRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
-          path: ["api/account_collection_flows/%0s", id],
+          path: ["api/account_collection_flows/%1$s", id],
           model: ModernTreasury::Models::AccountCollectionFlow,
           options: params[:request_options]
         )
@@ -49,22 +47,20 @@ module ModernTreasury
 
       # update account_collection_flow
       #
-      # @param id [String] id
+      # @overload update(id, status:, request_options: {})
       #
-      # @param params [ModernTreasury::Models::AccountCollectionFlowUpdateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Symbol, ModernTreasury::Models::AccountCollectionFlowUpdateParams::Status] :status Required. The updated status of the account collection flow. Can only be used to
-      #     mark a flow as `cancelled`.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param status [Symbol, ModernTreasury::Models::AccountCollectionFlowUpdateParams::Status]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::AccountCollectionFlow]
       #
+      # @see ModernTreasury::Models::AccountCollectionFlowUpdateParams
       def update(id, params)
         parsed, options = ModernTreasury::Models::AccountCollectionFlowUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["api/account_collection_flows/%0s", id],
+          path: ["api/account_collection_flows/%1$s", id],
           body: parsed,
           model: ModernTreasury::Models::AccountCollectionFlow,
           options: options
@@ -73,38 +69,34 @@ module ModernTreasury
 
       # list account_collection_flows
       #
-      # @param params [ModernTreasury::Models::AccountCollectionFlowListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String, nil] :after_cursor
+      # @overload list(after_cursor: nil, client_token: nil, counterparty_id: nil, external_account_id: nil, per_page: nil, status: nil, request_options: {})
       #
-      #   @option params [String] :client_token
+      # @param after_cursor [String, nil]
+      # @param client_token [String]
+      # @param counterparty_id [String]
+      # @param external_account_id [String]
+      # @param per_page [Integer]
+      # @param status [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [String] :counterparty_id
-      #
-      #   @option params [String] :external_account_id
-      #
-      #   @option params [Integer] :per_page
-      #
-      #   @option params [String] :status
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::AccountCollectionFlow>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::AccountCollectionFlow>]
       #
+      # @see ModernTreasury::Models::AccountCollectionFlowListParams
       def list(params = {})
         parsed, options = ModernTreasury::Models::AccountCollectionFlowListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/account_collection_flows",
           query: parsed,
-          page: ModernTreasury::Page,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::AccountCollectionFlow,
           options: options
         )
       end
 
-      # @param client [ModernTreasury::Client]
+      # @api private
       #
+      # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client
       end

data/lib/modern_treasury/resources/account_details.rb

@@ -5,30 +5,27 @@ module ModernTreasury
     class AccountDetails
       # Create an account detail for an external account.
       #
-      # @param account_id [String] Path param: The ID of the account.
+      # @overload create(account_id, accounts_type:, account_number:, account_number_type: nil, request_options: {})
       #
-      # @param params [ModernTreasury::Models::AccountDetailCreateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Symbol, ModernTreasury::Models::AccountDetailCreateParams::AccountsType] :accounts_type Path param:
-      #
-      #   @option params [String] :account_number Body param: The account number for the bank account.
-      #
-      #   @option params [Symbol, ModernTreasury::Models::AccountDetailCreateParams::AccountNumberType] :account_number_type Body param: One of `iban`, `clabe`, `wallet_address`, or `other`. Use `other` if
-      #     the bank account number is in a generic format.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param account_id [String]
+      # @param accounts_type [Symbol, ModernTreasury::Models::AccountDetailCreateParams::AccountsType]
+      # @param account_number [String]
+      # @param account_number_type [Symbol, ModernTreasury::Models::AccountDetailCreateParams::AccountNumberType]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::AccountDetail]
       #
+      # @see ModernTreasury::Models::AccountDetailCreateParams
       def create(account_id, params)
         parsed, options = ModernTreasury::Models::AccountDetailCreateParams.dump_request(params)
-        accounts_type = parsed.fetch(:accounts_type) do
-          raise ArgumentError.new("missing required path argument #{_1}")
-        end
+        accounts_type =
+          parsed.delete(:accounts_type) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
         @client.request(
           method: :post,
-          path: ["api/%0s/%1s/account_details", accounts_type, account_id],
-          body: parsed.except(:accounts_type),
+          path: ["api/%1$s/%2$s/account_details", accounts_type, account_id],
+          body: parsed,
           model: ModernTreasury::Models::AccountDetail,
           options: options
         )
@@ -36,29 +33,29 @@ module ModernTreasury
 
       # Get a single account detail for a single internal or external account.
       #
-      # @param id [String] The ID of the account detail.
+      # @overload retrieve(id, accounts_type:, account_id:, request_options: {})
       #
-      # @param params [ModernTreasury::Models::AccountDetailRetrieveParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Symbol, ModernTreasury::Models::AccountsType] :accounts_type
-      #
-      #   @option params [String] :account_id The ID of the account.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param accounts_type [Symbol, ModernTreasury::Models::AccountsType]
+      # @param account_id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::AccountDetail]
       #
+      # @see ModernTreasury::Models::AccountDetailRetrieveParams
       def retrieve(id, params)
         parsed, options = ModernTreasury::Models::AccountDetailRetrieveParams.dump_request(params)
-        accounts_type = parsed.fetch(:accounts_type) do
-          raise ArgumentError.new("missing required path argument #{_1}")
-        end
-        account_id = parsed.fetch(:account_id) do
-          raise ArgumentError.new("missing required path argument #{_1}")
-        end
+        accounts_type =
+          parsed.delete(:accounts_type) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        account_id =
+          parsed.delete(:account_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
         @client.request(
           method: :get,
-          path: ["api/%0s/%1s/account_details/%2s", accounts_type, account_id, id],
+          path: ["api/%1$s/%2$s/account_details/%3$s", accounts_type, account_id, id],
           model: ModernTreasury::Models::AccountDetail,
           options: options
         )
@@ -66,30 +63,28 @@ module ModernTreasury
 
       # Get a list of account details for a single internal or external account.
       #
-      # @param account_id [String] Path param: The ID of the account.
-      #
-      # @param params [ModernTreasury::Models::AccountDetailListParams, Hash{Symbol=>Object}] .
+      # @overload list(account_id, accounts_type:, after_cursor: nil, per_page: nil, request_options: {})
       #
-      #   @option params [Symbol, ModernTreasury::Models::AccountsType] :accounts_type Path param:
+      # @param account_id [String]
+      # @param accounts_type [Symbol, ModernTreasury::Models::AccountsType]
+      # @param after_cursor [String, nil]
+      # @param per_page [Integer]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [String, nil] :after_cursor Query param:
-      #
-      #   @option params [Integer] :per_page Query param:
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [ModernTreasury::Page<ModernTreasury::Models::AccountDetail>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::AccountDetail>]
       #
+      # @see ModernTreasury::Models::AccountDetailListParams
       def list(account_id, params)
         parsed, options = ModernTreasury::Models::AccountDetailListParams.dump_request(params)
-        accounts_type = parsed.fetch(:accounts_type) do
-          raise ArgumentError.new("missing required path argument #{_1}")
-        end
+        accounts_type =
+          parsed.delete(:accounts_type) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
         @client.request(
           method: :get,
-          path: ["api/%0s/%1s/account_details", accounts_type, account_id],
-          query: parsed.except(:accounts_type),
-          page: ModernTreasury::Page,
+          path: ["api/%1$s/%2$s/account_details", accounts_type, account_id],
+          query: parsed,
+          page: ModernTreasury::Internal::Page,
           model: ModernTreasury::Models::AccountDetail,
           options: options
         )
@@ -97,36 +92,37 @@ module ModernTreasury
 
       # Delete a single account detail for an external account.
       #
-      # @param id [String] The ID of the account detail.
-      #
-      # @param params [ModernTreasury::Models::AccountDetailDeleteParams, Hash{Symbol=>Object}] .
+      # @overload delete(id, accounts_type:, account_id:, request_options: {})
       #
-      #   @option params [Symbol, ModernTreasury::Models::AccountDetailDeleteParams::AccountsType] :accounts_type
-      #
-      #   @option params [String] :account_id The ID of the account.
-      #
-      #   @option params [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param id [String]
+      # @param accounts_type [Symbol, ModernTreasury::Models::AccountDetailDeleteParams::AccountsType]
+      # @param account_id [String]
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
       #
+      # @see ModernTreasury::Models::AccountDetailDeleteParams
       def delete(id, params)
         parsed, options = ModernTreasury::Models::AccountDetailDeleteParams.dump_request(params)
-        accounts_type = parsed.fetch(:accounts_type) do
-          raise ArgumentError.new("missing required path argument #{_1}")
-        end
-        account_id = parsed.fetch(:account_id) do
-          raise ArgumentError.new("missing required path argument #{_1}")
-        end
+        accounts_type =
+          parsed.delete(:accounts_type) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        account_id =
+          parsed.delete(:account_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
         @client.request(
           method: :delete,
-          path: ["api/%0s/%1s/account_details/%2s", accounts_type, account_id, id],
+          path: ["api/%1$s/%2$s/account_details/%3$s", accounts_type, account_id, id],
           model: NilClass,
           options: options
         )
       end
 
-      # @param client [ModernTreasury::Client]
+      # @api private
       #
+      # @param client [ModernTreasury::Client]
       def initialize(client:)
         @client = client
       end