modern_treasury 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.19

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 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 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 name [String, nil] A human friendly name for this counterparty.
+      #
+      # @param accounting [ModernTreasury::CounterpartyCreateParams::Accounting]
+      #
+      # @param accounts [Array<ModernTreasury::CounterpartyCreateParams::Account>] The accounts for this counterparty.
+      #
+      # @param email [String, nil] The counterparty's email.
+      #
+      # @param ledger_type [Symbol, ModernTreasury::CounterpartyCreateParams::LedgerType] An optional type to auto-sync the counterparty to your ledger. Either `customer`
+      #
+      # @param legal_entity [ModernTreasury::CounterpartyCreateParams::LegalEntity]
+      #
+      # @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::CounterpartyCreateParams::VerificationStatus] The verification status of the counterparty.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::Counterparty]
+      # @return [ModernTreasury::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,73 +52,95 @@ 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]
+      # @return [ModernTreasury::Counterparty]
       #
       # @see ModernTreasury::Models::CounterpartyRetrieveParams
       def retrieve(id, params = {})
         @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]
+      # @return [ModernTreasury::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>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::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::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::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]
+      # @return [ModernTreasury::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

data/lib/modern_treasury/resources/documents.rb

@@ -7,23 +7,27 @@ module ModernTreasury
       #
       # @overload create(documentable_id:, documentable_type:, file:, document_type: nil, request_options: {})
       #
-      # @param documentable_id [String]
-      # @param documentable_type [Symbol, ModernTreasury::Models::DocumentCreateParams::DocumentableType]
-      # @param file [Pathname, StringIO]
-      # @param document_type [String]
+      # @param documentable_id [String] The unique identifier for the associated object.
+      #
+      # @param documentable_type [Symbol, ModernTreasury::DocumentCreateParams::DocumentableType]
+      #
+      # @param file [Pathname, StringIO, IO, ModernTreasury::FilePart]
+      #
+      # @param document_type [String] A category given to the document, can be `null`.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::Document]
+      # @return [ModernTreasury::Document]
       #
       # @see ModernTreasury::Models::DocumentCreateParams
       def create(params)
-        parsed, options = ModernTreasury::Models::DocumentCreateParams.dump_request(params)
+        parsed, options = ModernTreasury::DocumentCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "api/documents",
           headers: {"content-type" => "multipart/form-data"},
           body: parsed,
-          model: ModernTreasury::Models::Document,
+          model: ModernTreasury::Document,
           options: options
         )
       end
@@ -32,42 +36,50 @@ module ModernTreasury
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the document.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::Document]
+      # @return [ModernTreasury::Document]
       #
       # @see ModernTreasury::Models::DocumentRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
           path: ["api/documents/%1$s", id],
-          model: ModernTreasury::Models::Document,
+          model: ModernTreasury::Document,
           options: params[:request_options]
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::DocumentListParams} for more details.
+      #
       # Get a list of documents.
       #
       # @overload list(after_cursor: nil, documentable_id: nil, documentable_type: nil, per_page: nil, request_options: {})
       #
       # @param after_cursor [String, nil]
-      # @param documentable_id [String]
-      # @param documentable_type [Symbol, ModernTreasury::Models::DocumentListParams::DocumentableType]
+      #
+      # @param documentable_id [String] The unique identifier for the associated object.
+      #
+      # @param documentable_type [Symbol, ModernTreasury::DocumentListParams::DocumentableType] The type of the associated object. Currently can be one of `payment_order`, `tra
+      #
       # @param per_page [Integer]
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::Document>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Document>]
       #
       # @see ModernTreasury::Models::DocumentListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::DocumentListParams.dump_request(params)
+        parsed, options = ModernTreasury::DocumentListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/documents",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::Document,
+          model: ModernTreasury::Document,
           options: options
         )
       end

data/lib/modern_treasury/resources/events.rb

@@ -7,17 +7,18 @@ module ModernTreasury
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] event id
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::Event]
+      # @return [ModernTreasury::Event]
       #
       # @see ModernTreasury::Models::EventRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
           path: ["api/events/%1$s", id],
-          model: ModernTreasury::Models::Event,
+          model: ModernTreasury::Event,
           options: params[:request_options]
         )
       end
@@ -27,25 +28,32 @@ module ModernTreasury
       # @overload list(after_cursor: nil, entity_id: nil, event_name: nil, event_time_end: nil, event_time_start: nil, per_page: nil, resource: nil, request_options: {})
       #
       # @param after_cursor [String, nil]
+      #
       # @param entity_id [String]
+      #
       # @param event_name [String]
-      # @param event_time_end [Time]
-      # @param event_time_start [Time]
+      #
+      # @param event_time_end [Time] An inclusive upper bound for when the event occurred
+      #
+      # @param event_time_start [Time] An inclusive lower bound for when the event occurred
+      #
       # @param per_page [Integer]
+      #
       # @param resource [String]
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::Event>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::Event>]
       #
       # @see ModernTreasury::Models::EventListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::EventListParams.dump_request(params)
+        parsed, options = ModernTreasury::EventListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/events",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::Event,
+          model: ModernTreasury::Event,
           options: options
         )
       end

data/lib/modern_treasury/resources/expected_payments.rb

@@ -3,41 +3,63 @@
 module ModernTreasury
   module Resources
     class ExpectedPayments
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::ExpectedPaymentCreateParams} for more details.
+      #
       # create expected payment
       #
       # @overload create(amount_lower_bound: nil, amount_upper_bound: nil, counterparty_id: nil, currency: nil, date_lower_bound: nil, date_upper_bound: nil, description: nil, direction: nil, internal_account_id: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, reconciliation_filters: nil, reconciliation_groups: nil, reconciliation_rule_variables: nil, remittance_information: nil, statement_descriptor: nil, type: nil, request_options: {})
       #
-      # @param amount_lower_bound [Integer, nil]
-      # @param amount_upper_bound [Integer, nil]
-      # @param counterparty_id [String, nil]
-      # @param currency [Symbol, ModernTreasury::Models::Currency, nil]
-      # @param date_lower_bound [Date, nil]
-      # @param date_upper_bound [Date, nil]
-      # @param description [String, nil]
-      # @param direction [Symbol, ModernTreasury::Models::ExpectedPaymentCreateParams::Direction, nil]
-      # @param internal_account_id [String, nil]
-      # @param ledger_transaction [ModernTreasury::Models::ExpectedPaymentCreateParams::LedgerTransaction]
-      # @param ledger_transaction_id [String]
-      # @param line_items [Array<ModernTreasury::Models::ExpectedPaymentCreateParams::LineItem>]
-      # @param metadata [Hash{Symbol=>String}]
-      # @param reconciliation_filters [Object, nil]
-      # @param reconciliation_groups [Object, nil]
-      # @param reconciliation_rule_variables [Array<ModernTreasury::Models::ReconciliationRule>, nil]
-      # @param remittance_information [String, nil]
-      # @param statement_descriptor [String, nil]
-      # @param type [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil]
+      # @param amount_lower_bound [Integer, nil] The lowest amount this expected payment may be equal to. Value in specified curr
+      #
+      # @param amount_upper_bound [Integer, nil] The highest amount this expected payment may be equal to. Value in specified cur
+      #
+      # @param counterparty_id [String, nil] The ID of the counterparty you expect for this payment.
+      #
+      # @param currency [Symbol, ModernTreasury::Currency, nil] Must conform to ISO 4217. Defaults to the currency of the internal account.
+      #
+      # @param date_lower_bound [Date, nil] The earliest date the payment may come in. Format: yyyy-mm-dd
+      #
+      # @param date_upper_bound [Date, nil] The latest date the payment may come in. Format: yyyy-mm-dd
+      #
+      # @param description [String, nil] An optional description for internal use.
+      #
+      # @param direction [Symbol, ModernTreasury::ExpectedPaymentCreateParams::Direction, nil] One of credit or debit. When you are receiving money, use credit. When you are b
+      #
+      # @param internal_account_id [String, nil] The ID of the Internal Account for the expected payment.
+      #
+      # @param ledger_transaction [ModernTreasury::ExpectedPaymentCreateParams::LedgerTransaction] Specifies a ledger transaction object that will be created with the expected pay
+      #
+      # @param ledger_transaction_id [String] Either ledger_transaction or ledger_transaction_id can be provided. Only a pendi
+      #
+      # @param line_items [Array<ModernTreasury::ExpectedPaymentCreateParams::LineItem>]
+      #
+      # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+      #
+      # @param reconciliation_filters [Object, nil] The reconciliation filters you have for this payment.
+      #
+      # @param reconciliation_groups [Object, nil] The reconciliation groups you have for this payment.
+      #
+      # @param reconciliation_rule_variables [Array<ModernTreasury::ReconciliationRule>, nil] An array of reconciliation rule variables for this payment.
+      #
+      # @param remittance_information [String, nil] For `ach`, this field will be passed through on an addenda record. For `wire` pa
+      #
+      # @param statement_descriptor [String, nil] The statement description you expect to see on the transaction. For ACH payments
+      #
+      # @param type [Symbol, ModernTreasury::ExpectedPaymentType, nil] One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen, se
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::ExpectedPayment]
+      # @return [ModernTreasury::ExpectedPayment]
       #
       # @see ModernTreasury::Models::ExpectedPaymentCreateParams
       def create(params = {})
-        parsed, options = ModernTreasury::Models::ExpectedPaymentCreateParams.dump_request(params)
+        parsed, options = ModernTreasury::ExpectedPaymentCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "api/expected_payments",
           body: parsed,
-          model: ModernTreasury::Models::ExpectedPayment,
+          model: ModernTreasury::ExpectedPayment,
           options: options
         )
       end
@@ -46,86 +68,121 @@ 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::ExpectedPayment]
+      # @return [ModernTreasury::ExpectedPayment]
       #
       # @see ModernTreasury::Models::ExpectedPaymentRetrieveParams
       def retrieve(id, params = {})
         @client.request(
           method: :get,
           path: ["api/expected_payments/%1$s", id],
-          model: ModernTreasury::Models::ExpectedPayment,
+          model: ModernTreasury::ExpectedPayment,
           options: params[:request_options]
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::ExpectedPaymentUpdateParams} for more details.
+      #
       # update expected payment
       #
       # @overload update(id, amount_lower_bound: nil, amount_upper_bound: nil, counterparty_id: nil, currency: nil, date_lower_bound: nil, date_upper_bound: nil, description: nil, direction: nil, internal_account_id: nil, metadata: nil, reconciliation_filters: nil, reconciliation_groups: nil, reconciliation_rule_variables: nil, remittance_information: nil, statement_descriptor: nil, status: nil, type: nil, request_options: {})
       #
-      # @param id [String]
-      # @param amount_lower_bound [Integer, nil]
-      # @param amount_upper_bound [Integer, nil]
-      # @param counterparty_id [String, nil]
-      # @param currency [Symbol, ModernTreasury::Models::Currency, nil]
-      # @param date_lower_bound [Date, nil]
-      # @param date_upper_bound [Date, nil]
-      # @param description [String, nil]
-      # @param direction [Symbol, ModernTreasury::Models::ExpectedPaymentUpdateParams::Direction, nil]
-      # @param internal_account_id [String, nil]
-      # @param metadata [Hash{Symbol=>String}]
-      # @param reconciliation_filters [Object, nil]
-      # @param reconciliation_groups [Object, nil]
-      # @param reconciliation_rule_variables [Array<ModernTreasury::Models::ReconciliationRule>, nil]
-      # @param remittance_information [String, nil]
-      # @param statement_descriptor [String, nil]
-      # @param status [Symbol, ModernTreasury::Models::ExpectedPaymentUpdateParams::Status, nil]
-      # @param type [Symbol, ModernTreasury::Models::ExpectedPaymentType, nil]
+      # @param id [String] id
+      #
+      # @param amount_lower_bound [Integer, nil] The lowest amount this expected payment may be equal to. Value in specified curr
+      #
+      # @param amount_upper_bound [Integer, nil] The highest amount this expected payment may be equal to. Value in specified cur
+      #
+      # @param counterparty_id [String, nil] The ID of the counterparty you expect for this payment.
+      #
+      # @param currency [Symbol, ModernTreasury::Currency, nil] Must conform to ISO 4217. Defaults to the currency of the internal account.
+      #
+      # @param date_lower_bound [Date, nil] The earliest date the payment may come in. Format: yyyy-mm-dd
+      #
+      # @param date_upper_bound [Date, nil] The latest date the payment may come in. Format: yyyy-mm-dd
+      #
+      # @param description [String, nil] An optional description for internal use.
+      #
+      # @param direction [Symbol, ModernTreasury::ExpectedPaymentUpdateParams::Direction, nil] One of credit or debit. When you are receiving money, use credit. When you are b
+      #
+      # @param internal_account_id [String, nil] The ID of the Internal Account for the expected payment.
+      #
+      # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+      #
+      # @param reconciliation_filters [Object, nil] The reconciliation filters you have for this payment.
+      #
+      # @param reconciliation_groups [Object, nil] The reconciliation groups you have for this payment.
+      #
+      # @param reconciliation_rule_variables [Array<ModernTreasury::ReconciliationRule>, nil] An array of reconciliation rule variables for this payment.
+      #
+      # @param remittance_information [String, nil] For `ach`, this field will be passed through on an addenda record. For `wire` pa
+      #
+      # @param statement_descriptor [String, nil] The statement description you expect to see on the transaction. For ACH payments
+      #
+      # @param status [Symbol, ModernTreasury::ExpectedPaymentUpdateParams::Status, nil] The Expected Payment's status can be updated from partially_reconciled to reconc
+      #
+      # @param type [Symbol, ModernTreasury::ExpectedPaymentType, nil] One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen, se
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::ExpectedPayment]
+      # @return [ModernTreasury::ExpectedPayment]
       #
       # @see ModernTreasury::Models::ExpectedPaymentUpdateParams
       def update(id, params = {})
-        parsed, options = ModernTreasury::Models::ExpectedPaymentUpdateParams.dump_request(params)
+        parsed, options = ModernTreasury::ExpectedPaymentUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
           path: ["api/expected_payments/%1$s", id],
           body: parsed,
-          model: ModernTreasury::Models::ExpectedPayment,
+          model: ModernTreasury::ExpectedPayment,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::ExpectedPaymentListParams} for more details.
+      #
       # list expected_payments
       #
       # @overload list(after_cursor: nil, counterparty_id: nil, created_at_lower_bound: nil, created_at_upper_bound: nil, direction: nil, internal_account_id: nil, metadata: nil, per_page: nil, status: nil, type: nil, request_options: {})
       #
       # @param after_cursor [String, nil]
-      # @param counterparty_id [String]
-      # @param created_at_lower_bound [Time]
-      # @param created_at_upper_bound [Time]
-      # @param direction [Symbol, ModernTreasury::Models::TransactionDirection]
-      # @param internal_account_id [String]
-      # @param metadata [Hash{Symbol=>String}]
+      #
+      # @param counterparty_id [String] Specify counterparty_id to see expected_payments for a specific account.
+      #
+      # @param created_at_lower_bound [Time] Used to return expected payments created after some datetime
+      #
+      # @param created_at_upper_bound [Time] Used to return expected payments created before some datetime
+      #
+      # @param direction [Symbol, ModernTreasury::TransactionDirection] One of credit, debit
+      #
+      # @param internal_account_id [String] Specify internal_account_id to see expected_payments for a specific account.
+      #
+      # @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 status [Symbol, ModernTreasury::Models::ExpectedPaymentListParams::Status]
-      # @param type [Symbol, ModernTreasury::Models::ExpectedPaymentListParams::Type]
+      #
+      # @param status [Symbol, ModernTreasury::ExpectedPaymentListParams::Status] One of unreconciled, reconciled, or archived.
+      #
+      # @param type [Symbol, ModernTreasury::ExpectedPaymentListParams::Type] One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp,sen, sep
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::ExpectedPayment>]
+      # @return [ModernTreasury::Internal::Page<ModernTreasury::ExpectedPayment>]
       #
       # @see ModernTreasury::Models::ExpectedPaymentListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::ExpectedPaymentListParams.dump_request(params)
+        parsed, options = ModernTreasury::ExpectedPaymentListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/expected_payments",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::ExpectedPayment,
+          model: ModernTreasury::ExpectedPayment,
           options: options
         )
       end
@@ -134,17 +191,18 @@ module ModernTreasury
       #
       # @overload delete(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] id
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [ModernTreasury::Models::ExpectedPayment]
+      # @return [ModernTreasury::ExpectedPayment]
       #
       # @see ModernTreasury::Models::ExpectedPaymentDeleteParams
       def delete(id, params = {})
         @client.request(
           method: :delete,
           path: ["api/expected_payments/%1$s", id],
-          model: ModernTreasury::Models::ExpectedPayment,
+          model: ModernTreasury::ExpectedPayment,
           options: params[:request_options]
         )
       end