modern_treasury 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.17

data/lib/modern_treasury/models/virtual_account_create_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class VirtualAccountCreateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::VirtualAccounts#create
+    class VirtualAccountCreateParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute internal_account_id
       #   The ID of the internal account that this virtual account is associated with.
@@ -24,7 +25,7 @@ module ModernTreasury
       #
       #   @return [Array<ModernTreasury::Models::VirtualAccountCreateParams::AccountDetail>, nil]
       optional :account_details,
-               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::VirtualAccountCreateParams::AccountDetail] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::VirtualAccountCreateParams::AccountDetail] }
 
       # @!parse
       #   # @return [Array<ModernTreasury::Models::VirtualAccountCreateParams::AccountDetail>]
@@ -42,8 +43,8 @@ module ModernTreasury
 
       # @!attribute [r] credit_ledger_account_id
       #   The ID of a credit normal ledger account. When money leaves the virtual account,
-      #     this ledger account will be credited. Must be accompanied by a
-      #     debit_ledger_account_id if present.
+      #   this ledger account will be credited. Must be accompanied by a
+      #   debit_ledger_account_id if present.
       #
       #   @return [String, nil]
       optional :credit_ledger_account_id, String
@@ -54,8 +55,8 @@ module ModernTreasury
 
       # @!attribute [r] debit_ledger_account_id
       #   The ID of a debit normal ledger account. When money enters the virtual account,
-      #     this ledger account will be debited. Must be accompanied by a
-      #     credit_ledger_account_id if present.
+      #   this ledger account will be debited. Must be accompanied by a
+      #   credit_ledger_account_id if present.
       #
       #   @return [String, nil]
       optional :debit_ledger_account_id, String
@@ -76,8 +77,8 @@ module ModernTreasury
 
       # @!attribute [r] ledger_account
       #   Specifies a ledger account object that will be created with the virtual account.
-      #     The resulting ledger account is linked to the virtual account for auto-ledgering
-      #     IPDs.
+      #   The resulting ledger account is linked to the virtual account for auto-ledgering
+      #   IPDs.
       #
       #   @return [ModernTreasury::Models::VirtualAccountCreateParams::LedgerAccount, nil]
       optional :ledger_account, -> { ModernTreasury::Models::VirtualAccountCreateParams::LedgerAccount }
@@ -88,10 +89,10 @@ module ModernTreasury
 
       # @!attribute [r] metadata
       #   Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
+      #   strings.
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :metadata, ModernTreasury::HashOf[String]
+      optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!parse
       #   # @return [Hash{Symbol=>String}]
@@ -102,7 +103,7 @@ module ModernTreasury
       #
       #   @return [Array<ModernTreasury::Models::VirtualAccountCreateParams::RoutingDetail>, nil]
       optional :routing_details,
-               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::VirtualAccountCreateParams::RoutingDetail] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::VirtualAccountCreateParams::RoutingDetail] }
 
       # @!parse
       #   # @return [Array<ModernTreasury::Models::VirtualAccountCreateParams::RoutingDetail>]
@@ -138,9 +139,9 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      class AccountDetail < ModernTreasury::BaseModel
+      class AccountDetail < ModernTreasury::Internal::Type::BaseModel
         # @!attribute account_number
         #   The account number for the bank account.
         #
@@ -149,7 +150,7 @@ module ModernTreasury
 
         # @!attribute [r] account_number_type
         #   One of `iban`, `clabe`, `wallet_address`, or `other`. Use `other` if the bank
-        #     account number is in a generic format.
+        #   account number is in a generic format.
         #
         #   @return [Symbol, ModernTreasury::Models::VirtualAccountCreateParams::AccountDetail::AccountNumberType, nil]
         optional :account_number_type,
@@ -165,12 +166,14 @@ module ModernTreasury
         #   #
         #   def initialize(account_number:, account_number_type: nil, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
         # One of `iban`, `clabe`, `wallet_address`, or `other`. Use `other` if the bank
-        #   account number is in a generic format.
+        # account number is in a generic format.
+        #
+        # @see ModernTreasury::Models::VirtualAccountCreateParams::AccountDetail#account_number_type
         module AccountNumberType
-          extend ModernTreasury::Enum
+          extend ModernTreasury::Internal::Type::Enum
 
           AU_NUMBER = :au_number
           CLABE = :clabe
@@ -191,7 +194,7 @@ module ModernTreasury
         end
       end
 
-      class LedgerAccount < ModernTreasury::BaseModel
+      class LedgerAccount < ModernTreasury::Internal::Type::BaseModel
         # @!attribute currency
         #   The currency of the ledger account.
         #
@@ -230,10 +233,10 @@ module ModernTreasury
 
         # @!attribute [r] ledger_account_category_ids
         #   The array of ledger account category ids that this ledger account should be a
-        #     child of.
+        #   child of.
         #
         #   @return [Array<String>, nil]
-        optional :ledger_account_category_ids, ModernTreasury::ArrayOf[String]
+        optional :ledger_account_category_ids, ModernTreasury::Internal::Type::ArrayOf[String]
 
         # @!parse
         #   # @return [Array<String>]
@@ -241,7 +244,7 @@ module ModernTreasury
 
         # @!attribute [r] ledgerable_id
         #   If the ledger account links to another object in Modern Treasury, the id will be
-        #     populated here, otherwise null.
+        #   populated here, otherwise null.
         #
         #   @return [String, nil]
         optional :ledgerable_id, String
@@ -252,8 +255,8 @@ module ModernTreasury
 
         # @!attribute [r] ledgerable_type
         #   If the ledger account links to another object in Modern Treasury, the type will
-        #     be populated here, otherwise null. The value is one of internal_account or
-        #     external_account.
+        #   be populated here, otherwise null. The value is one of internal_account or
+        #   external_account.
         #
         #   @return [Symbol, ModernTreasury::Models::VirtualAccountCreateParams::LedgerAccount::LedgerableType, nil]
         optional :ledgerable_type,
@@ -265,10 +268,10 @@ module ModernTreasury
 
         # @!attribute [r] metadata
         #   Additional data represented as key-value pairs. Both the key and value must be
-        #     strings.
+        #   strings.
         #
         #   @return [Hash{Symbol=>String}, nil]
-        optional :metadata, ModernTreasury::HashOf[String]
+        optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
         # @!parse
         #   # @return [Hash{Symbol=>String}]
@@ -276,8 +279,8 @@ module ModernTreasury
 
         # @!parse
         #   # Specifies a ledger account object that will be created with the virtual account.
-        #   #   The resulting ledger account is linked to the virtual account for auto-ledgering
-        #   #   IPDs.
+        #   # The resulting ledger account is linked to the virtual account for auto-ledgering
+        #   # IPDs.
         #   #
         #   # @param currency [String]
         #   # @param ledger_id [String]
@@ -306,13 +309,15 @@ module ModernTreasury
         #     super
         #   end
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
         # If the ledger account links to another object in Modern Treasury, the type will
-        #   be populated here, otherwise null. The value is one of internal_account or
-        #   external_account.
+        # be populated here, otherwise null. The value is one of internal_account or
+        # external_account.
+        #
+        # @see ModernTreasury::Models::VirtualAccountCreateParams::LedgerAccount#ledgerable_type
         module LedgerableType
-          extend ModernTreasury::Enum
+          extend ModernTreasury::Internal::Type::Enum
 
           COUNTERPARTY = :counterparty
           EXTERNAL_ACCOUNT = :external_account
@@ -327,7 +332,7 @@ module ModernTreasury
         end
       end
 
-      class RoutingDetail < ModernTreasury::BaseModel
+      class RoutingDetail < ModernTreasury::Internal::Type::BaseModel
         # @!attribute routing_number
         #   The routing number of the bank.
         #
@@ -336,8 +341,8 @@ module ModernTreasury
 
         # @!attribute routing_number_type
         #   The type of routing number. See
-        #     https://docs.moderntreasury.com/platform/reference/routing-detail-object for
-        #     more details.
+        #   https://docs.moderntreasury.com/platform/reference/routing-detail-object for
+        #   more details.
         #
         #   @return [Symbol, ModernTreasury::Models::VirtualAccountCreateParams::RoutingDetail::RoutingNumberType]
         required :routing_number_type,
@@ -345,7 +350,7 @@ module ModernTreasury
 
         # @!attribute payment_type
         #   If the routing detail is to be used for a specific payment type this field will
-        #     be populated, otherwise null.
+        #   be populated, otherwise null.
         #
         #   @return [Symbol, ModernTreasury::Models::VirtualAccountCreateParams::RoutingDetail::PaymentType, nil]
         optional :payment_type,
@@ -359,13 +364,15 @@ module ModernTreasury
         #   #
         #   def initialize(routing_number:, routing_number_type:, payment_type: nil, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
         # The type of routing number. See
-        #   https://docs.moderntreasury.com/platform/reference/routing-detail-object for
-        #   more details.
+        # https://docs.moderntreasury.com/platform/reference/routing-detail-object for
+        # more details.
+        #
+        # @see ModernTreasury::Models::VirtualAccountCreateParams::RoutingDetail#routing_number_type
         module RoutingNumberType
-          extend ModernTreasury::Enum
+          extend ModernTreasury::Internal::Type::Enum
 
           ABA = :aba
           AU_BSB = :au_bsb
@@ -397,9 +404,11 @@ module ModernTreasury
         end
 
         # If the routing detail is to be used for a specific payment type this field will
-        #   be populated, otherwise null.
+        # be populated, otherwise null.
+        #
+        # @see ModernTreasury::Models::VirtualAccountCreateParams::RoutingDetail#payment_type
         module PaymentType
-          extend ModernTreasury::Enum
+          extend ModernTreasury::Internal::Type::Enum
 
           ACH = :ach
           AU_BECS = :au_becs

data/lib/modern_treasury/models/virtual_account_delete_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class VirtualAccountDeleteParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::VirtualAccounts#delete
+    class VirtualAccountDeleteParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!parse
       #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
       #   #
       #   def initialize(request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/virtual_account_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class VirtualAccountListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::VirtualAccounts#list
+    class VirtualAccountListParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute after_cursor
       #
@@ -32,11 +33,11 @@ module ModernTreasury
 
       # @!attribute [r] metadata
       #   For example, if you want to query for records with metadata key `Type` and value
-      #     `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
-      #     parameters.
+      #   `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
+      #   parameters.
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :metadata, ModernTreasury::HashOf[String]
+      optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!parse
       #   # @return [Hash{Symbol=>String}]
@@ -71,7 +72,7 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/virtual_account_retrieve_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class VirtualAccountRetrieveParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::VirtualAccounts#retrieve
+    class VirtualAccountRetrieveParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!parse
       #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
       #   #
       #   def initialize(request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/virtual_account_update_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class VirtualAccountUpdateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::VirtualAccounts#update
+    class VirtualAccountUpdateParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute [r] counterparty_id
       #
@@ -29,7 +30,7 @@ module ModernTreasury
       # @!attribute [r] metadata
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :metadata, ModernTreasury::HashOf[String]
+      optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!parse
       #   # @return [Hash{Symbol=>String}]
@@ -49,7 +50,7 @@ module ModernTreasury
       #   #
       #   def initialize(counterparty_id: nil, ledger_account_id: nil, metadata: nil, name: nil, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

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,11 +161,13 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
       # The employment status of the individual.
+      #
+      # @see ModernTreasury::Models::WealthAndEmploymentDetails#employment_status
       module EmploymentStatus
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         EMPLOYED = :employed
         RETIRED = :retired
@@ -181,8 +183,10 @@ module ModernTreasury
       end
 
       # The source of the individual's income.
+      #
+      # @see ModernTreasury::Models::WealthAndEmploymentDetails#income_source
       module IncomeSource
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         FAMILY_SUPPORT = :family_support
         GOVERNMENT_BENEFITS = :government_benefits
@@ -201,8 +205,10 @@ module ModernTreasury
       end
 
       # The industry of the individual.
+      #
+      # @see ModernTreasury::Models::WealthAndEmploymentDetails#industry
       module Industry
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         ACCOUNTING = :accounting
         AGRICULTURE = :agriculture
@@ -246,8 +252,10 @@ module ModernTreasury
       end
 
       # The occupation of the individual.
+      #
+      # @see ModernTreasury::Models::WealthAndEmploymentDetails#occupation
       module Occupation
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         CONSULTING = :consulting
         EXECUTIVE = :executive
@@ -270,8 +278,10 @@ module ModernTreasury
       end
 
       # The source of the individual's funds.
+      #
+      # @see ModernTreasury::Models::WealthAndEmploymentDetails#source_of_funds
       module SourceOfFunds
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         ALIMONY = :alimony
         ANNUITY = :annuity
@@ -299,8 +309,10 @@ module ModernTreasury
       end
 
       # The source of the individual's wealth.
+      #
+      # @see ModernTreasury::Models::WealthAndEmploymentDetails#wealth_source
       module WealthSource
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         BUSINESS_SALE = :business_sale
         FAMILY_SUPPORT = :family_support

data/lib/modern_treasury/request_options.rb

@@ -1,45 +1,12 @@
 # frozen_string_literal: true
 
 module ModernTreasury
-  # @api private
-  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
-
-    # @api private
-    module Converter
-      # @api 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
+  # 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}]
@@ -60,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 [Object, nil]
-    optional :extra_body, ModernTreasury::HashOf[ModernTreasury::Unknown]
+    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.