modern_treasury 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.20

data/lib/modern_treasury/resources/account_details.rb

@@ -3,21 +3,28 @@
 module ModernTreasury
   module Resources
     class AccountDetails
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::AccountDetailCreateParams} for more details.
+      #
       # Create an account detail for an external account.
       #
       # @overload create(account_id, accounts_type:, account_number:, account_number_type: 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 account_id [String] Path param: The ID of the account.
+      #
+      # @param accounts_type [Symbol, ModernTreasury::Models::AccountDetailCreateParams::AccountsType] Path param:
+      #
+      # @param account_number [String] Body param: The account number for the bank account.
+      #
+      # @param account_number_type [Symbol, ModernTreasury::Models::AccountDetailCreateParams::AccountNumberType] Body param: One of `iban`, `clabe`, `wallet_address`, or `other`. Use `other` if
+      #
       # @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)
+        parsed, options = ModernTreasury::AccountDetailCreateParams.dump_request(params)
         accounts_type =
           parsed.delete(:accounts_type) do
             raise ArgumentError.new("missing required path argument #{_1}")
@@ -26,7 +33,7 @@ module ModernTreasury
           method: :post,
           path: ["api/%1$s/%2$s/account_details", accounts_type, account_id],
           body: parsed,
-          model: ModernTreasury::Models::AccountDetail,
+          model: ModernTreasury::AccountDetail,
           options: options
         )
       end
@@ -35,16 +42,19 @@ module ModernTreasury
       #
       # @overload retrieve(id, accounts_type:, account_id:, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the account detail.
+      #
       # @param accounts_type [Symbol, ModernTreasury::Models::AccountsType]
-      # @param account_id [String]
+      #
+      # @param account_id [String] The ID of the account.
+      #
       # @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)
+        parsed, options = ModernTreasury::AccountDetailRetrieveParams.dump_request(params)
         accounts_type =
           parsed.delete(:accounts_type) do
             raise ArgumentError.new("missing required path argument #{_1}")
@@ -56,7 +66,7 @@ module ModernTreasury
         @client.request(
           method: :get,
           path: ["api/%1$s/%2$s/account_details/%3$s", accounts_type, account_id, id],
-          model: ModernTreasury::Models::AccountDetail,
+          model: ModernTreasury::AccountDetail,
           options: options
         )
       end
@@ -65,17 +75,21 @@ module ModernTreasury
       #
       # @overload list(account_id, accounts_type:, after_cursor: nil, per_page: nil, request_options: {})
       #
-      # @param account_id [String]
-      # @param accounts_type [Symbol, ModernTreasury::Models::AccountsType]
-      # @param after_cursor [String, nil]
-      # @param per_page [Integer]
+      # @param account_id [String] Path param: The ID of the account.
+      #
+      # @param accounts_type [Symbol, ModernTreasury::Models::AccountsType] Path param:
+      #
+      # @param after_cursor [String, nil] Query param:
+      #
+      # @param per_page [Integer] Query param:
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::AccountDetail>]
       #
       # @see ModernTreasury::Models::AccountDetailListParams
       def list(account_id, params)
-        parsed, options = ModernTreasury::Models::AccountDetailListParams.dump_request(params)
+        parsed, options = ModernTreasury::AccountDetailListParams.dump_request(params)
         accounts_type =
           parsed.delete(:accounts_type) do
             raise ArgumentError.new("missing required path argument #{_1}")
@@ -85,7 +99,7 @@ module ModernTreasury
           path: ["api/%1$s/%2$s/account_details", accounts_type, account_id],
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::AccountDetail,
+          model: ModernTreasury::AccountDetail,
           options: options
         )
       end
@@ -94,16 +108,19 @@ module ModernTreasury
       #
       # @overload delete(id, accounts_type:, account_id:, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the account detail.
+      #
       # @param accounts_type [Symbol, ModernTreasury::Models::AccountDetailDeleteParams::AccountsType]
-      # @param account_id [String]
+      #
+      # @param account_id [String] The ID of the account.
+      #
       # @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)
+        parsed, options = ModernTreasury::AccountDetailDeleteParams.dump_request(params)
         accounts_type =
           parsed.delete(:accounts_type) do
             raise ArgumentError.new("missing required path argument #{_1}")

data/lib/modern_treasury/resources/bulk_requests.rb

@@ -3,26 +3,33 @@
 module ModernTreasury
   module Resources
     class BulkRequests
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::BulkRequestCreateParams} for more details.
+      #
       # create bulk_request
       #
       # @overload create(action_type:, resource_type:, resources:, metadata: nil, request_options: {})
       #
-      # @param action_type [Symbol, ModernTreasury::Models::BulkRequestCreateParams::ActionType]
-      # @param resource_type [Symbol, ModernTreasury::Models::BulkRequestCreateParams::ResourceType]
-      # @param resources [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ID, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID>]
-      # @param metadata [Hash{Symbol=>String}]
+      # @param action_type [Symbol, ModernTreasury::Models::BulkRequestCreateParams::ActionType] One of create, or update.
+      #
+      # @param resource_type [Symbol, ModernTreasury::Models::BulkRequestCreateParams::ResourceType] One of payment_order, expected_payment, or ledger_transaction.
+      #
+      # @param resources [Array<ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderAsyncCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionCreateRequest, ModernTreasury::Models::BulkRequestCreateParams::Resource::ID, ModernTreasury::Models::BulkRequestCreateParams::Resource::PaymentOrderUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::TransactionUpdateRequestWithID, ModernTreasury::Models::BulkRequestCreateParams::Resource::LedgerTransactionUpdateRequestWithID>] An array of objects where each object contains the input params for a single `ac
+      #
+      # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::BulkRequest]
       #
       # @see ModernTreasury::Models::BulkRequestCreateParams
       def create(params)
-        parsed, options = ModernTreasury::Models::BulkRequestCreateParams.dump_request(params)
+        parsed, options = ModernTreasury::BulkRequestCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "api/bulk_requests",
           body: parsed,
-          model: ModernTreasury::Models::BulkRequest,
+          model: ModernTreasury::BulkRequest,
           options: options
         )
       end
@@ -31,7 +38,8 @@ module ModernTreasury
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] id
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::BulkRequest]
@@ -41,34 +49,43 @@ module ModernTreasury
         @client.request(
           method: :get,
           path: ["api/bulk_requests/%1$s", id],
-          model: ModernTreasury::Models::BulkRequest,
+          model: ModernTreasury::BulkRequest,
           options: params[:request_options]
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::BulkRequestListParams} for more details.
+      #
       # list bulk_requests
       #
       # @overload list(action_type: nil, after_cursor: nil, metadata: nil, per_page: nil, resource_type: nil, status: nil, request_options: {})
       #
-      # @param action_type [Symbol, ModernTreasury::Models::BulkRequestListParams::ActionType]
+      # @param action_type [Symbol, ModernTreasury::Models::BulkRequestListParams::ActionType] One of create, or update.
+      #
       # @param after_cursor [String, nil]
-      # @param metadata [Hash{Symbol=>String}]
+      #
+      # @param metadata [Hash{Symbol=>String}] For example, if you want to query for records with metadata key `Type` and value
+      #
       # @param per_page [Integer]
-      # @param resource_type [Symbol, ModernTreasury::Models::BulkRequestListParams::ResourceType]
-      # @param status [Symbol, ModernTreasury::Models::BulkRequestListParams::Status]
+      #
+      # @param resource_type [Symbol, ModernTreasury::Models::BulkRequestListParams::ResourceType] One of payment_order, expected_payment, or ledger_transaction.
+      #
+      # @param status [Symbol, ModernTreasury::Models::BulkRequestListParams::Status] One of pending, processing, or completed.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::BulkRequest>]
       #
       # @see ModernTreasury::Models::BulkRequestListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::BulkRequestListParams.dump_request(params)
+        parsed, options = ModernTreasury::BulkRequestListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/bulk_requests",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::BulkRequest,
+          model: ModernTreasury::BulkRequest,
           options: options
         )
       end

data/lib/modern_treasury/resources/bulk_results.rb

@@ -7,7 +7,8 @@ module ModernTreasury
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] id
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::BulkResult]
@@ -17,35 +18,45 @@ module ModernTreasury
         @client.request(
           method: :get,
           path: ["api/bulk_results/%1$s", id],
-          model: ModernTreasury::Models::BulkResult,
+          model: ModernTreasury::BulkResult,
           options: params[:request_options]
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::BulkResultListParams} for more details.
+      #
       # list bulk_results
       #
       # @overload list(after_cursor: nil, entity_id: nil, entity_type: nil, per_page: nil, request_id: nil, request_type: nil, status: nil, request_options: {})
       #
       # @param after_cursor [String, nil]
-      # @param entity_id [String]
-      # @param entity_type [Symbol, ModernTreasury::Models::BulkResultListParams::EntityType]
+      #
+      # @param entity_id [String] Unique identifier for the result entity object.
+      #
+      # @param entity_type [Symbol, ModernTreasury::Models::BulkResultListParams::EntityType] The type of the request that created this result. bulk_request is the only suppo
+      #
       # @param per_page [Integer]
-      # @param request_id [String]
-      # @param request_type [Symbol, ModernTreasury::Models::BulkResultListParams::RequestType]
-      # @param status [Symbol, ModernTreasury::Models::BulkResultListParams::Status]
+      #
+      # @param request_id [String] Unique identifier for the request that created this bulk result. This is the ID
+      #
+      # @param request_type [Symbol, ModernTreasury::Models::BulkResultListParams::RequestType] The type of the request that created this result. bulk_request is the only suppo
+      #
+      # @param status [Symbol, ModernTreasury::Models::BulkResultListParams::Status] One of successful or failed.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::BulkResult>]
       #
       # @see ModernTreasury::Models::BulkResultListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::BulkResultListParams.dump_request(params)
+        parsed, options = ModernTreasury::BulkResultListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/bulk_results",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::BulkResult,
+          model: ModernTreasury::BulkResult,
           options: options
         )
       end

data/lib/modern_treasury/resources/connection_legal_entities.rb

@@ -7,21 +7,24 @@ module ModernTreasury
       #
       # @overload create(connection_id:, legal_entity: nil, legal_entity_id: nil, request_options: {})
       #
-      # @param connection_id [String]
-      # @param legal_entity [ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity]
-      # @param legal_entity_id [String]
+      # @param connection_id [String] The ID of the connection.
+      #
+      # @param legal_entity [ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity] The legal entity.
+      #
+      # @param legal_entity_id [String] The ID of the legal entity.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::ConnectionLegalEntity]
       #
       # @see ModernTreasury::Models::ConnectionLegalEntityCreateParams
       def create(params)
-        parsed, options = ModernTreasury::Models::ConnectionLegalEntityCreateParams.dump_request(params)
+        parsed, options = ModernTreasury::ConnectionLegalEntityCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "api/connection_legal_entities",
           body: parsed,
-          model: ModernTreasury::Models::ConnectionLegalEntity,
+          model: ModernTreasury::ConnectionLegalEntity,
           options: options
         )
       end
@@ -30,7 +33,8 @@ module ModernTreasury
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The id of an existing connection legal entity.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::ConnectionLegalEntity]
@@ -40,7 +44,7 @@ module ModernTreasury
         @client.request(
           method: :get,
           path: ["api/connection_legal_entities/%1$s", id],
-          model: ModernTreasury::Models::ConnectionLegalEntity,
+          model: ModernTreasury::ConnectionLegalEntity,
           options: params[:request_options]
         )
       end
@@ -49,20 +53,22 @@ module ModernTreasury
       #
       # @overload update(id, status: nil, request_options: {})
       #
-      # @param id [String]
-      # @param status [Symbol, ModernTreasury::Models::ConnectionLegalEntityUpdateParams::Status]
+      # @param id [String] The id of an existing connection legal entity.
+      #
+      # @param status [Symbol, ModernTreasury::Models::ConnectionLegalEntityUpdateParams::Status] The status of the connection legal entity.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::ConnectionLegalEntity]
       #
       # @see ModernTreasury::Models::ConnectionLegalEntityUpdateParams
       def update(id, params = {})
-        parsed, options = ModernTreasury::Models::ConnectionLegalEntityUpdateParams.dump_request(params)
+        parsed, options = ModernTreasury::ConnectionLegalEntityUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
           path: ["api/connection_legal_entities/%1$s", id],
           body: parsed,
-          model: ModernTreasury::Models::ConnectionLegalEntity,
+          model: ModernTreasury::ConnectionLegalEntity,
           options: options
         )
       end
@@ -82,13 +88,13 @@ module ModernTreasury
       #
       # @see ModernTreasury::Models::ConnectionLegalEntityListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::ConnectionLegalEntityListParams.dump_request(params)
+        parsed, options = ModernTreasury::ConnectionLegalEntityListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/connection_legal_entities",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::ConnectionLegalEntity,
+          model: ModernTreasury::ConnectionLegalEntity,
           options: options
         )
       end

data/lib/modern_treasury/resources/connections.rb

@@ -8,22 +8,26 @@ module ModernTreasury
       # @overload list(after_cursor: nil, entity: nil, per_page: nil, vendor_customer_id: nil, request_options: {})
       #
       # @param after_cursor [String, nil]
-      # @param entity [String]
+      #
+      # @param entity [String] A string code representing the vendor (i.e. bank).
+      #
       # @param per_page [Integer]
-      # @param vendor_customer_id [String]
+      #
+      # @param vendor_customer_id [String] An identifier assigned by the vendor to your organization.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::Connection>]
       #
       # @see ModernTreasury::Models::ConnectionListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::ConnectionListParams.dump_request(params)
+        parsed, options = ModernTreasury::ConnectionListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/connections",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::Connection,
+          model: ModernTreasury::Connection,
           options: options
         )
       end

data/lib/modern_treasury/resources/counterparties.rb

@@ -3,33 +3,47 @@
 module ModernTreasury
   module Resources
     class Counterparties
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::CounterpartyCreateParams} for more details.
+      #
       # Create a new counterparty.
       #
       # @overload create(name:, accounting: nil, accounts: nil, email: nil, ledger_type: nil, legal_entity: nil, legal_entity_id: nil, metadata: nil, send_remittance_advice: nil, taxpayer_identifier: nil, verification_status: nil, request_options: {})
       #
-      # @param name [String, nil]
+      # @param name [String, nil] A human friendly name for this counterparty.
+      #
       # @param accounting [ModernTreasury::Models::CounterpartyCreateParams::Accounting]
-      # @param accounts [Array<ModernTreasury::Models::CounterpartyCreateParams::Account>]
-      # @param email [String, nil]
-      # @param ledger_type [Symbol, ModernTreasury::Models::CounterpartyCreateParams::LedgerType]
+      #
+      # @param accounts [Array<ModernTreasury::Models::CounterpartyCreateParams::Account>] The accounts for this counterparty.
+      #
+      # @param email [String, nil] The counterparty's email.
+      #
+      # @param ledger_type [Symbol, ModernTreasury::Models::CounterpartyCreateParams::LedgerType] An optional type to auto-sync the counterparty to your ledger. Either `customer`
+      #
       # @param legal_entity [ModernTreasury::Models::CounterpartyCreateParams::LegalEntity]
-      # @param legal_entity_id [String, nil]
-      # @param metadata [Hash{Symbol=>String}]
-      # @param send_remittance_advice [Boolean]
-      # @param taxpayer_identifier [String]
-      # @param verification_status [Symbol, ModernTreasury::Models::CounterpartyCreateParams::VerificationStatus]
+      #
+      # @param legal_entity_id [String, nil] The id of the legal entity.
+      #
+      # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+      #
+      # @param send_remittance_advice [Boolean] Send an email to the counterparty whenever an associated payment order is sent t
+      #
+      # @param taxpayer_identifier [String] Either a valid SSN or EIN.
+      #
+      # @param verification_status [Symbol, ModernTreasury::Models::CounterpartyCreateParams::VerificationStatus] The verification status of the counterparty.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::Counterparty]
       #
       # @see ModernTreasury::Models::CounterpartyCreateParams
       def create(params)
-        parsed, options = ModernTreasury::Models::CounterpartyCreateParams.dump_request(params)
+        parsed, options = ModernTreasury::CounterpartyCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "api/counterparties",
           body: parsed,
-          model: ModernTreasury::Models::Counterparty,
+          model: ModernTreasury::Counterparty,
           options: options
         )
       end
@@ -38,7 +52,8 @@ module ModernTreasury
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The id of an existing counterparty.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::Counterparty]
@@ -48,63 +63,84 @@ module ModernTreasury
         @client.request(
           method: :get,
           path: ["api/counterparties/%1$s", id],
-          model: ModernTreasury::Models::Counterparty,
+          model: ModernTreasury::Counterparty,
           options: params[:request_options]
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::CounterpartyUpdateParams} for more details.
+      #
       # Updates a given counterparty with new information.
       #
       # @overload update(id, email: nil, legal_entity_id: nil, metadata: nil, name: nil, send_remittance_advice: nil, taxpayer_identifier: nil, request_options: {})
       #
-      # @param id [String]
-      # @param email [String]
-      # @param legal_entity_id [String, nil]
-      # @param metadata [Hash{Symbol=>String}]
-      # @param name [String]
-      # @param send_remittance_advice [Boolean]
-      # @param taxpayer_identifier [String]
+      # @param id [String] The id of an existing counterparty.
+      #
+      # @param email [String] A new email for the counterparty.
+      #
+      # @param legal_entity_id [String, nil] The id of the legal entity.
+      #
+      # @param metadata [Hash{Symbol=>String}] Additional data in the form of key-value pairs. Pairs can be removed by passing
+      #
+      # @param name [String] A new name for the counterparty. Will only update if passed.
+      #
+      # @param send_remittance_advice [Boolean] If this is `true`, Modern Treasury will send an email to the counterparty whenev
+      #
+      # @param taxpayer_identifier [String] Either a valid SSN or EIN.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::Counterparty]
       #
       # @see ModernTreasury::Models::CounterpartyUpdateParams
       def update(id, params = {})
-        parsed, options = ModernTreasury::Models::CounterpartyUpdateParams.dump_request(params)
+        parsed, options = ModernTreasury::CounterpartyUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
           path: ["api/counterparties/%1$s", id],
           body: parsed,
-          model: ModernTreasury::Models::Counterparty,
+          model: ModernTreasury::Counterparty,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::CounterpartyListParams} for more details.
+      #
       # Get a paginated list of all counterparties.
       #
       # @overload list(after_cursor: nil, created_at_lower_bound: nil, created_at_upper_bound: nil, email: nil, legal_entity_id: nil, metadata: nil, name: nil, per_page: nil, request_options: {})
       #
       # @param after_cursor [String, nil]
-      # @param created_at_lower_bound [Time]
-      # @param created_at_upper_bound [Time]
-      # @param email [String]
-      # @param legal_entity_id [String]
-      # @param metadata [Hash{Symbol=>String}]
-      # @param name [String]
+      #
+      # @param created_at_lower_bound [Time] Used to return counterparties created after some datetime.
+      #
+      # @param created_at_upper_bound [Time] Used to return counterparties created before some datetime.
+      #
+      # @param email [String] Performs a partial string match of the email field. This is also case insensitiv
+      #
+      # @param legal_entity_id [String] Filters for counterparties with the given legal entity ID.
+      #
+      # @param metadata [Hash{Symbol=>String}] For example, if you want to query for records with metadata key `Type` and value
+      #
+      # @param name [String] Performs a partial string match of the name field. This is also case insensitive
+      #
       # @param per_page [Integer]
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::Counterparty>]
       #
       # @see ModernTreasury::Models::CounterpartyListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::CounterpartyListParams.dump_request(params)
+        parsed, options = ModernTreasury::CounterpartyListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/counterparties",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::Counterparty,
+          model: ModernTreasury::Counterparty,
           options: options
         )
       end
@@ -113,7 +149,8 @@ module ModernTreasury
       #
       # @overload delete(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The id of an existing counterparty.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
@@ -128,27 +165,35 @@ module ModernTreasury
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::CounterpartyCollectAccountParams} for more details.
+      #
       # Send an email requesting account details.
       #
       # @overload collect_account(id, direction:, custom_redirect: nil, fields: nil, send_email: nil, request_options: {})
       #
-      # @param id [String]
-      # @param direction [Symbol, ModernTreasury::Models::TransactionDirection]
-      # @param custom_redirect [String]
-      # @param fields [Array<Symbol, ModernTreasury::Models::CounterpartyCollectAccountParams::Field>]
-      # @param send_email [Boolean]
+      # @param id [String] counterparty id
+      #
+      # @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `credit` or `debit`. Use `credit` when you want to pay a counterparty. Us
+      #
+      # @param custom_redirect [String] The URL you want your customer to visit upon filling out the form. By default, t
+      #
+      # @param fields [Array<Symbol, ModernTreasury::Models::CounterpartyCollectAccountParams::Field>] The list of fields you want on the form. This field is optional and if it is not
+      #
+      # @param send_email [Boolean] By default, Modern Treasury will send an email to your counterparty that include
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::CounterpartyCollectAccountResponse]
       #
       # @see ModernTreasury::Models::CounterpartyCollectAccountParams
       def collect_account(id, params)
-        parsed, options = ModernTreasury::Models::CounterpartyCollectAccountParams.dump_request(params)
+        parsed, options = ModernTreasury::CounterpartyCollectAccountParams.dump_request(params)
         @client.request(
           method: :post,
           path: ["api/counterparties/%1$s/collect_account", id],
           body: parsed,
-          model: ModernTreasury::Models::CounterpartyCollectAccountResponse,
+          model: ModernTreasury::CounterpartyCollectAccountResponse,
           options: options
         )
       end