modern_treasury 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.18

data/lib/modern_treasury/internal.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  # @api private
+  module Internal
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{ModernTreasury::Internal}::OMIT>" }
+      end
+        .freeze
+  end
+end

data/lib/modern_treasury/models/account_collection_flow.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class AccountCollectionFlow < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::AccountCollectionFlows#create
+    class AccountCollectionFlow < ModernTreasury::Internal::Type::BaseModel
       # @!attribute counterparty_id
       #   The ID of a counterparty. An external account created with this flow will be
-      #     associated with this counterparty.
+      #   associated with this counterparty.
       #
       #   @return [String]
       required :counterparty_id, String
@@ -14,7 +15,7 @@ module ModernTreasury
       #
       #   @return [Array<Symbol, ModernTreasury::Models::AccountCollectionFlow::PaymentType>]
       required :payment_types,
-               -> { ModernTreasury::ArrayOf[enum: ModernTreasury::Models::AccountCollectionFlow::PaymentType] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::Models::AccountCollectionFlow::PaymentType] }
 
       # @!attribute [r] id
       #
@@ -27,7 +28,7 @@ module ModernTreasury
 
       # @!attribute [r] client_token
       #   The client token of the account collection flow. This token can be used to embed
-      #     account collection in your client-side application.
+      #   account collection in your client-side application.
       #
       #   @return [String, nil]
       optional :client_token, String
@@ -53,10 +54,10 @@ module ModernTreasury
 
       # @!attribute [r] 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, nil]
-      optional :live_mode, ModernTreasury::BooleanModel
+      optional :live_mode, ModernTreasury::Internal::Type::Boolean
 
       # @!parse
       #   # @return [Boolean]
@@ -75,7 +76,7 @@ module ModernTreasury
       #
       #   @return [Array<Symbol, ModernTreasury::Models::AccountCollectionFlow::ReceivingCountry>, nil]
       optional :receiving_countries,
-               -> { ModernTreasury::ArrayOf[enum: ModernTreasury::Models::AccountCollectionFlow::ReceivingCountry] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::Models::AccountCollectionFlow::ReceivingCountry] }
 
       # @!parse
       #   # @return [Array<Symbol, ModernTreasury::Models::AccountCollectionFlow::ReceivingCountry>]
@@ -83,7 +84,7 @@ module ModernTreasury
 
       # @!attribute [r] status
       #   The current status of the account collection flow. One of `pending`,
-      #     `completed`, `expired`, or `cancelled`.
+      #   `completed`, `expired`, or `cancelled`.
       #
       #   @return [Symbol, ModernTreasury::Models::AccountCollectionFlow::Status, nil]
       optional :status, enum: -> { ModernTreasury::Models::AccountCollectionFlow::Status }
@@ -131,11 +132,11 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
       # An account created with this flow will support payments of one of these types.
       module PaymentType
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         ACH = :ach
         WIRE = :wire
@@ -148,9 +149,9 @@ module ModernTreasury
       end
 
       # An account created with this flow will support wires from the US to these
-      #   countries.
+      # countries.
       module ReceivingCountry
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         USA = :USA
         AUS = :AUS
@@ -179,9 +180,11 @@ module ModernTreasury
       end
 
       # The current status of the account collection flow. One of `pending`,
-      #   `completed`, `expired`, or `cancelled`.
+      # `completed`, `expired`, or `cancelled`.
+      #
+      # @see ModernTreasury::Models::AccountCollectionFlow#status
       module Status
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         CANCELLED = :cancelled
         COMPLETED = :completed

data/lib/modern_treasury/models/account_collection_flow_create_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class AccountCollectionFlowCreateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::AccountCollectionFlows#create
+    class AccountCollectionFlowCreateParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute counterparty_id
       #   Required.
@@ -16,13 +17,13 @@ module ModernTreasury
       # @!attribute payment_types
       #
       #   @return [Array<String>]
-      required :payment_types, ModernTreasury::ArrayOf[String]
+      required :payment_types, ModernTreasury::Internal::Type::ArrayOf[String]
 
       # @!attribute [r] receiving_countries
       #
       #   @return [Array<Symbol, ModernTreasury::Models::AccountCollectionFlowCreateParams::ReceivingCountry>, nil]
       optional :receiving_countries,
-               -> { ModernTreasury::ArrayOf[enum: ModernTreasury::Models::AccountCollectionFlowCreateParams::ReceivingCountry] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::Models::AccountCollectionFlowCreateParams::ReceivingCountry] }
 
       # @!parse
       #   # @return [Array<Symbol, ModernTreasury::Models::AccountCollectionFlowCreateParams::ReceivingCountry>]
@@ -36,11 +37,11 @@ module ModernTreasury
       #   #
       #   def initialize(counterparty_id:, payment_types:, receiving_countries: nil, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
       # Optional. Array of 3-digit ISO country codes.
       module ReceivingCountry
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         USA = :USA
         AUS = :AUS

data/lib/modern_treasury/models/account_collection_flow_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class AccountCollectionFlowListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::AccountCollectionFlows#list
+    class AccountCollectionFlowListParams < 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
       #
@@ -79,7 +80,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/account_collection_flow_retrieve_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class AccountCollectionFlowRetrieveParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::AccountCollectionFlows#retrieve
+    class AccountCollectionFlowRetrieveParams < 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/account_collection_flow_update_params.rb

@@ -2,14 +2,15 @@
 
 module ModernTreasury
   module Models
-    class AccountCollectionFlowUpdateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::AccountCollectionFlows#update
+    class AccountCollectionFlowUpdateParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute status
       #   Required. The updated status of the account collection flow. Can only be used to
-      #     mark a flow as `cancelled`.
+      #   mark a flow as `cancelled`.
       #
       #   @return [Symbol, ModernTreasury::Models::AccountCollectionFlowUpdateParams::Status]
       required :status, enum: -> { ModernTreasury::Models::AccountCollectionFlowUpdateParams::Status }
@@ -20,12 +21,12 @@ module ModernTreasury
       #   #
       #   def initialize(status:, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
       # Required. The updated status of the account collection flow. Can only be used to
-      #   mark a flow as `cancelled`.
+      # mark a flow as `cancelled`.
       module Status
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         CANCELLED = :cancelled
 

data/lib/modern_treasury/models/account_detail.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class AccountDetail < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::AccountDetails#create
+    class AccountDetail < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -16,7 +17,7 @@ module ModernTreasury
 
       # @!attribute 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::AccountDetail::AccountNumberType]
       required :account_number_type, enum: -> { ModernTreasury::Models::AccountDetail::AccountNumberType }
@@ -33,10 +34,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
       #
@@ -84,12 +85,14 @@ module ModernTreasury
       #     super
       #   end
 
-      # 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::AccountDetail#account_number_type
       module AccountNumberType
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         AU_NUMBER = :au_number
         CLABE = :clabe

data/lib/modern_treasury/models/account_detail_create_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class AccountDetailCreateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::AccountDetails#create
+    class AccountDetailCreateParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute accounts_type
       #
@@ -20,7 +21,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::AccountDetailCreateParams::AccountNumberType, nil]
       optional :account_number_type,
@@ -38,10 +39,10 @@ module ModernTreasury
       #   #
       #   def initialize(accounts_type:, account_number:, account_number_type: nil, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
       module AccountsType
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         EXTERNAL_ACCOUNTS = :external_accounts
 
@@ -53,9 +54,9 @@ module ModernTreasury
       end
 
       # 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.
       module AccountNumberType
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         AU_NUMBER = :au_number
         CLABE = :clabe

data/lib/modern_treasury/models/account_detail_delete_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class AccountDetailDeleteParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::AccountDetails#delete
+    class AccountDetailDeleteParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute accounts_type
       #
@@ -24,10 +25,10 @@ module ModernTreasury
       #   #
       #   def initialize(accounts_type:, account_id:, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
       module AccountsType
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         EXTERNAL_ACCOUNTS = :external_accounts
 

data/lib/modern_treasury/models/account_detail_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class AccountDetailListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::AccountDetails#list
+    class AccountDetailListParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute accounts_type
       #
@@ -34,7 +35,7 @@ module ModernTreasury
       #   #
       #   def initialize(accounts_type:, after_cursor: nil, per_page: 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/account_detail_retrieve_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class AccountDetailRetrieveParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::AccountDetails#retrieve
+    class AccountDetailRetrieveParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute accounts_type
       #
@@ -24,7 +25,7 @@ module ModernTreasury
       #   #
       #   def initialize(accounts_type:, account_id:, 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/accounts_type.rb

@@ -3,7 +3,7 @@
 module ModernTreasury
   module Models
     module AccountsType
-      extend ModernTreasury::Enum
+      extend ModernTreasury::Internal::Type::Enum
 
       EXTERNAL_ACCOUNTS = :external_accounts
       INTERNAL_ACCOUNTS = :internal_accounts

data/lib/modern_treasury/models/async_response.rb

@@ -2,7 +2,7 @@
 
 module ModernTreasury
   module Models
-    class AsyncResponse < ModernTreasury::BaseModel
+    class AsyncResponse < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -19,7 +19,7 @@ module ModernTreasury
       #   #
       #   def initialize(id:, object:, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/bank_settings.rb

@@ -2,7 +2,7 @@
 
 module ModernTreasury
   module Models
-    class BankSettings < ModernTreasury::BaseModel
+    class BankSettings < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -26,17 +26,17 @@ module ModernTreasury
 
       # @!attribute enable_backup_withholding
       #   Whether backup withholding is enabled. See more here -
-      #     https://www.irs.gov/businesses/small-businesses-self-employed/backup-withholding.
+      #   https://www.irs.gov/businesses/small-businesses-self-employed/backup-withholding.
       #
       #   @return [Boolean, nil]
-      required :enable_backup_withholding, ModernTreasury::BooleanModel, nil?: true
+      required :enable_backup_withholding, ModernTreasury::Internal::Type::Boolean, nil?: true
 
       # @!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
       #
@@ -47,16 +47,16 @@ module ModernTreasury
       #   Cross River Bank specific setting to opt out of privacy policy.
       #
       #   @return [Boolean, nil]
-      required :privacy_opt_out, ModernTreasury::BooleanModel, nil?: true
+      required :privacy_opt_out, ModernTreasury::Internal::Type::Boolean, nil?: true
 
       # @!attribute regulation_o
       #   It covers, among other types of insider loans, extensions of credit by a member
-      #     bank to an executive officer, director, or principal shareholder of the member
-      #     bank; a bank holding company of which the member bank is a subsidiary; and any
-      #     other subsidiary of that bank holding company.
+      #   bank to an executive officer, director, or principal shareholder of the member
+      #   bank; a bank holding company of which the member bank is a subsidiary; and any
+      #   other subsidiary of that bank holding company.
       #
       #   @return [Boolean, nil]
-      required :regulation_o, ModernTreasury::BooleanModel, nil?: true
+      required :regulation_o, ModernTreasury::Internal::Type::Boolean, nil?: true
 
       # @!attribute updated_at
       #
@@ -91,7 +91,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/bulk_request.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class BulkRequest < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::BulkRequests#create
+    class BulkRequest < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -27,17 +28,17 @@ 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 metadata
       #   Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
+      #   strings.
       #
       #   @return [Hash{Symbol=>String}]
-      required :metadata, ModernTreasury::HashOf[String]
+      required :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!attribute object
       #
@@ -64,8 +65,8 @@ module ModernTreasury
 
       # @!attribute total_resource_count
       #   Total number of items in the `resources` array. Once a bulk request is
-      #     completed, `success_result_count` + `failed_result_count` will be equal to
-      #     `total_result_count`.
+      #   completed, `success_result_count` + `failed_result_count` will be equal to
+      #   `total_result_count`.
       #
       #   @return [Integer]
       required :total_resource_count, Integer
@@ -107,11 +108,13 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
       # One of create, or update.
+      #
+      # @see ModernTreasury::Models::BulkRequest#action_type
       module ActionType
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         CREATE = :create
         UPDATE = :update
@@ -125,13 +128,17 @@ module ModernTreasury
       end
 
       # One of payment_order, expected_payment, or ledger_transaction.
+      #
+      # @see ModernTreasury::Models::BulkRequest#resource_type
       module ResourceType
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         PAYMENT_ORDER = :payment_order
+        LEDGER_ACCOUNT = :ledger_account
         LEDGER_TRANSACTION = :ledger_transaction
-        TRANSACTION = :transaction
         EXPECTED_PAYMENT = :expected_payment
+        TRANSACTION = :transaction
+        ENTITY_LINK = :entity_link
 
         finalize!
 
@@ -141,8 +148,10 @@ module ModernTreasury
       end
 
       # One of pending, processing, or completed.
+      #
+      # @see ModernTreasury::Models::BulkRequest#status
       module Status
-        extend ModernTreasury::Enum
+        extend ModernTreasury::Internal::Type::Enum
 
         PENDING = :pending
         PROCESSING = :processing