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

data/lib/modern_treasury/resources/payment_orders.rb

@@ -6,58 +6,97 @@ module ModernTreasury
       # @return [ModernTreasury::Resources::PaymentOrders::Reversals]
       attr_reader :reversals
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::PaymentOrderCreateParams} for more details.
+      #
       # Create a new Payment Order
       #
       # @overload create(amount:, direction:, originating_account_id:, type:, accounting: nil, accounting_category_id: nil, accounting_ledger_class_id: nil, charge_bearer: nil, currency: nil, description: nil, documents: nil, effective_date: nil, expires_at: nil, fallback_type: nil, foreign_exchange_contract: nil, foreign_exchange_indicator: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, nsf_protected: nil, originating_party_name: nil, priority: nil, process_after: nil, purpose: nil, receiving_account: nil, receiving_account_id: nil, remittance_information: nil, send_remittance_advice: nil, statement_descriptor: nil, subtype: nil, transaction_monitoring_enabled: nil, ultimate_originating_party_identifier: nil, ultimate_originating_party_name: nil, ultimate_receiving_party_identifier: nil, ultimate_receiving_party_name: nil, request_options: {})
       #
-      # @param amount [Integer]
-      # @param direction [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::Direction]
-      # @param originating_account_id [String]
-      # @param type [Symbol, ModernTreasury::Models::PaymentOrderType]
+      # @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
+      #
+      # @param direction [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::Direction] One of `credit`, `debit`. Describes the direction money is flowing in the transa
+      #
+      # @param originating_account_id [String] The ID of one of your organization's internal accounts.
+      #
+      # @param type [Symbol, ModernTreasury::Models::PaymentOrderType] One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sep
+      #
       # @param accounting [ModernTreasury::Models::PaymentOrderCreateParams::Accounting]
-      # @param accounting_category_id [String, nil]
-      # @param accounting_ledger_class_id [String, nil]
-      # @param charge_bearer [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ChargeBearer, nil]
-      # @param currency [Symbol, ModernTreasury::Models::Currency]
-      # @param description [String, nil]
-      # @param documents [Array<ModernTreasury::Models::PaymentOrderCreateParams::Document>]
-      # @param effective_date [Date]
-      # @param expires_at [Time, nil]
-      # @param fallback_type [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::FallbackType]
-      # @param foreign_exchange_contract [String, nil]
-      # @param foreign_exchange_indicator [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ForeignExchangeIndicator, nil]
-      # @param ledger_transaction [ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction]
-      # @param ledger_transaction_id [String]
-      # @param line_items [Array<ModernTreasury::Models::PaymentOrderCreateParams::LineItem>]
-      # @param metadata [Hash{Symbol=>String}]
-      # @param nsf_protected [Boolean]
-      # @param originating_party_name [String, nil]
-      # @param priority [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::Priority]
-      # @param process_after [Time, nil]
-      # @param purpose [String, nil]
-      # @param receiving_account [ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount]
-      # @param receiving_account_id [String]
-      # @param remittance_information [String, nil]
-      # @param send_remittance_advice [Boolean, nil]
-      # @param statement_descriptor [String, nil]
-      # @param subtype [Symbol, ModernTreasury::Models::PaymentOrderSubtype, nil]
-      # @param transaction_monitoring_enabled [Boolean]
-      # @param ultimate_originating_party_identifier [String, nil]
-      # @param ultimate_originating_party_name [String, nil]
-      # @param ultimate_receiving_party_identifier [String, nil]
-      # @param ultimate_receiving_party_name [String, nil]
+      #
+      # @param accounting_category_id [String, nil] The ID of one of your accounting categories. Note that these will only be access
+      #
+      # @param accounting_ledger_class_id [String, nil] The ID of one of your accounting ledger classes. Note that these will only be ac
+      #
+      # @param charge_bearer [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ChargeBearer, nil] The party that will pay the fees for the payment order. Only applies to wire pay
+      #
+      # @param currency [Symbol, ModernTreasury::Models::Currency] Defaults to the currency of the originating account.
+      #
+      # @param description [String, nil] An optional description for internal use.
+      #
+      # @param documents [Array<ModernTreasury::Models::PaymentOrderCreateParams::Document>] An array of documents to be attached to the payment order. Note that if you atta
+      #
+      # @param effective_date [Date] Date transactions are to be posted to the participants' account. Defaults to the
+      #
+      # @param expires_at [Time, nil] RFP payments require an expires_at. This value must be past the effective_date.
+      #
+      # @param fallback_type [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::FallbackType] A payment type to fallback to if the original type is not valid for the receivin
+      #
+      # @param foreign_exchange_contract [String, nil] If present, indicates a specific foreign exchange contract number that has been
+      #
+      # @param foreign_exchange_indicator [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::ForeignExchangeIndicator, nil] Indicates the type of FX transfer to initiate, can be either `variable_to_fixed`
+      #
+      # @param ledger_transaction [ModernTreasury::Models::PaymentOrderCreateParams::LedgerTransaction] Specifies a ledger transaction object that will be created with the payment orde
+      #
+      # @param ledger_transaction_id [String] Either ledger_transaction or ledger_transaction_id can be provided. Only a pendi
+      #
+      # @param line_items [Array<ModernTreasury::Models::PaymentOrderCreateParams::LineItem>] An array of line items that must sum up to the amount of the payment order.
+      #
+      # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+      #
+      # @param nsf_protected [Boolean] A boolean to determine if NSF Protection is enabled for this payment order. Note
+      #
+      # @param originating_party_name [String, nil] If present, this will replace your default company name on receiver's bank state
+      #
+      # @param priority [Symbol, ModernTreasury::Models::PaymentOrderCreateParams::Priority] Either `normal` or `high`. For ACH and EFT payments, `high` represents a same-da
+      #
+      # @param process_after [Time, nil] If present, Modern Treasury will not process the payment until after this time.
+      #
+      # @param purpose [String, nil] For `wire`, this is usually the purpose which is transmitted via the "InstrForDb
+      #
+      # @param receiving_account [ModernTreasury::Models::PaymentOrderCreateParams::ReceivingAccount] Either `receiving_account` or `receiving_account_id` must be present. When using
+      #
+      # @param receiving_account_id [String] Either `receiving_account` or `receiving_account_id` must be present. When using
+      #
+      # @param remittance_information [String, nil] For `ach`, this field will be passed through on an addenda record. For `wire` pa
+      #
+      # @param send_remittance_advice [Boolean, nil] Send an email to the counterparty when the payment order is sent to the bank. If
+      #
+      # @param statement_descriptor [String, nil] An optional descriptor which will appear in the receiver's statement. For `check
+      #
+      # @param subtype [Symbol, ModernTreasury::Models::PaymentOrderSubtype, nil] An additional layer of classification for the type of payment order you are doin
+      #
+      # @param transaction_monitoring_enabled [Boolean] A flag that determines whether a payment order should go through transaction mon
+      #
+      # @param ultimate_originating_party_identifier [String, nil] Identifier of the ultimate originator of the payment order.
+      #
+      # @param ultimate_originating_party_name [String, nil] Name of the ultimate originator of the payment order.
+      #
+      # @param ultimate_receiving_party_identifier [String, nil] Identifier of the ultimate funds recipient.
+      #
+      # @param ultimate_receiving_party_name [String, nil] Name of the ultimate funds recipient.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::PaymentOrder]
       #
       # @see ModernTreasury::Models::PaymentOrderCreateParams
       def create(params)
-        parsed, options = ModernTreasury::Models::PaymentOrderCreateParams.dump_request(params)
+        parsed, options = ModernTreasury::PaymentOrderCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "api/payment_orders",
           body: parsed,
-          model: ModernTreasury::Models::PaymentOrder,
+          model: ModernTreasury::PaymentOrder,
           options: options
         )
       end
@@ -76,155 +115,251 @@ module ModernTreasury
         @client.request(
           method: :get,
           path: ["api/payment_orders/%1$s", id],
-          model: ModernTreasury::Models::PaymentOrder,
+          model: ModernTreasury::PaymentOrder,
           options: params[:request_options]
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::PaymentOrderUpdateParams} for more details.
+      #
       # Update a payment order
       #
       # @overload update(id, accounting: nil, accounting_category_id: nil, accounting_ledger_class_id: nil, amount: nil, charge_bearer: nil, counterparty_id: nil, currency: nil, description: nil, direction: nil, effective_date: nil, expires_at: nil, fallback_type: nil, foreign_exchange_contract: nil, foreign_exchange_indicator: nil, line_items: nil, metadata: nil, nsf_protected: nil, originating_account_id: nil, originating_party_name: nil, priority: nil, process_after: nil, purpose: nil, receiving_account: nil, receiving_account_id: nil, remittance_information: nil, send_remittance_advice: nil, statement_descriptor: nil, status: nil, subtype: nil, type: nil, ultimate_originating_party_identifier: nil, ultimate_originating_party_name: nil, ultimate_receiving_party_identifier: nil, ultimate_receiving_party_name: nil, request_options: {})
       #
       # @param id [String]
+      #
       # @param accounting [ModernTreasury::Models::PaymentOrderUpdateParams::Accounting]
-      # @param accounting_category_id [String, nil]
-      # @param accounting_ledger_class_id [String, nil]
-      # @param amount [Integer]
-      # @param charge_bearer [Symbol, ModernTreasury::Models::PaymentOrderUpdateParams::ChargeBearer, nil]
-      # @param counterparty_id [String, nil]
-      # @param currency [Symbol, ModernTreasury::Models::Currency]
-      # @param description [String, nil]
-      # @param direction [Symbol, ModernTreasury::Models::PaymentOrderUpdateParams::Direction]
-      # @param effective_date [Date]
-      # @param expires_at [Time, nil]
-      # @param fallback_type [Symbol, ModernTreasury::Models::PaymentOrderUpdateParams::FallbackType]
-      # @param foreign_exchange_contract [String, nil]
-      # @param foreign_exchange_indicator [Symbol, ModernTreasury::Models::PaymentOrderUpdateParams::ForeignExchangeIndicator, nil]
-      # @param line_items [Array<ModernTreasury::Models::PaymentOrderUpdateParams::LineItem>]
-      # @param metadata [Hash{Symbol=>String}]
-      # @param nsf_protected [Boolean]
-      # @param originating_account_id [String]
-      # @param originating_party_name [String, nil]
-      # @param priority [Symbol, ModernTreasury::Models::PaymentOrderUpdateParams::Priority]
-      # @param process_after [Time, nil]
-      # @param purpose [String, nil]
-      # @param receiving_account [ModernTreasury::Models::PaymentOrderUpdateParams::ReceivingAccount]
-      # @param receiving_account_id [String]
-      # @param remittance_information [String, nil]
-      # @param send_remittance_advice [Boolean, nil]
-      # @param statement_descriptor [String, nil]
-      # @param status [Symbol, ModernTreasury::Models::PaymentOrderUpdateParams::Status]
-      # @param subtype [Symbol, ModernTreasury::Models::PaymentOrderSubtype, nil]
-      # @param type [Symbol, ModernTreasury::Models::PaymentOrderType]
-      # @param ultimate_originating_party_identifier [String, nil]
-      # @param ultimate_originating_party_name [String, nil]
-      # @param ultimate_receiving_party_identifier [String, nil]
-      # @param ultimate_receiving_party_name [String, nil]
+      #
+      # @param accounting_category_id [String, nil] The ID of one of your accounting categories. Note that these will only be access
+      #
+      # @param accounting_ledger_class_id [String, nil] The ID of one of your accounting ledger classes. Note that these will only be ac
+      #
+      # @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
+      #
+      # @param charge_bearer [Symbol, ModernTreasury::Models::PaymentOrderUpdateParams::ChargeBearer, nil] The party that will pay the fees for the payment order. Only applies to wire pay
+      #
+      # @param counterparty_id [String, nil] Required when receiving_account_id is passed the ID of an external account.
+      #
+      # @param currency [Symbol, ModernTreasury::Models::Currency] Defaults to the currency of the originating account.
+      #
+      # @param description [String, nil] An optional description for internal use.
+      #
+      # @param direction [Symbol, ModernTreasury::Models::PaymentOrderUpdateParams::Direction] One of `credit`, `debit`. Describes the direction money is flowing in the transa
+      #
+      # @param effective_date [Date] Date transactions are to be posted to the participants' account. Defaults to the
+      #
+      # @param expires_at [Time, nil] RFP payments require an expires_at. This value must be past the effective_date.
+      #
+      # @param fallback_type [Symbol, ModernTreasury::Models::PaymentOrderUpdateParams::FallbackType] A payment type to fallback to if the original type is not valid for the receivin
+      #
+      # @param foreign_exchange_contract [String, nil] If present, indicates a specific foreign exchange contract number that has been
+      #
+      # @param foreign_exchange_indicator [Symbol, ModernTreasury::Models::PaymentOrderUpdateParams::ForeignExchangeIndicator, nil] Indicates the type of FX transfer to initiate, can be either `variable_to_fixed`
+      #
+      # @param line_items [Array<ModernTreasury::Models::PaymentOrderUpdateParams::LineItem>] An array of line items that must sum up to the amount of the payment order.
+      #
+      # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+      #
+      # @param nsf_protected [Boolean] A boolean to determine if NSF Protection is enabled for this payment order. Note
+      #
+      # @param originating_account_id [String] The ID of one of your organization's internal accounts.
+      #
+      # @param originating_party_name [String, nil] If present, this will replace your default company name on receiver's bank state
+      #
+      # @param priority [Symbol, ModernTreasury::Models::PaymentOrderUpdateParams::Priority] Either `normal` or `high`. For ACH and EFT payments, `high` represents a same-da
+      #
+      # @param process_after [Time, nil] If present, Modern Treasury will not process the payment until after this time.
+      #
+      # @param purpose [String, nil] For `wire`, this is usually the purpose which is transmitted via the "InstrForDb
+      #
+      # @param receiving_account [ModernTreasury::Models::PaymentOrderUpdateParams::ReceivingAccount] Either `receiving_account` or `receiving_account_id` must be present. When using
+      #
+      # @param receiving_account_id [String] Either `receiving_account` or `receiving_account_id` must be present. When using
+      #
+      # @param remittance_information [String, nil] For `ach`, this field will be passed through on an addenda record. For `wire` pa
+      #
+      # @param send_remittance_advice [Boolean, nil] Send an email to the counterparty when the payment order is sent to the bank. If
+      #
+      # @param statement_descriptor [String, nil] An optional descriptor which will appear in the receiver's statement. For `check
+      #
+      # @param status [Symbol, ModernTreasury::Models::PaymentOrderUpdateParams::Status] To cancel a payment order, use `cancelled`. To redraft a returned payment order,
+      #
+      # @param subtype [Symbol, ModernTreasury::Models::PaymentOrderSubtype, nil] An additional layer of classification for the type of payment order you are doin
+      #
+      # @param type [Symbol, ModernTreasury::Models::PaymentOrderType] One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sep
+      #
+      # @param ultimate_originating_party_identifier [String, nil] This represents the identifier by which the person is known to the receiver when
+      #
+      # @param ultimate_originating_party_name [String, nil] This represents the name of the person that the payment is on behalf of when usi
+      #
+      # @param ultimate_receiving_party_identifier [String, nil] This represents the name of the merchant that the payment is being sent to when
+      #
+      # @param ultimate_receiving_party_name [String, nil] This represents the identifier by which the merchant is known to the person init
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::PaymentOrder]
       #
       # @see ModernTreasury::Models::PaymentOrderUpdateParams
       def update(id, params = {})
-        parsed, options = ModernTreasury::Models::PaymentOrderUpdateParams.dump_request(params)
+        parsed, options = ModernTreasury::PaymentOrderUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
           path: ["api/payment_orders/%1$s", id],
           body: parsed,
-          model: ModernTreasury::Models::PaymentOrder,
+          model: ModernTreasury::PaymentOrder,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::PaymentOrderListParams} for more details.
+      #
       # Get a list of all payment orders
       #
       # @overload list(after_cursor: nil, counterparty_id: nil, created_at_end: nil, created_at_start: nil, direction: nil, effective_date_end: nil, effective_date_start: nil, metadata: nil, originating_account_id: nil, per_page: nil, priority: nil, process_after_end: nil, process_after_start: nil, reference_number: nil, status: nil, transaction_id: nil, type: nil, request_options: {})
       #
       # @param after_cursor [String, nil]
+      #
       # @param counterparty_id [String]
-      # @param created_at_end [Date]
-      # @param created_at_start [Date]
+      #
+      # @param created_at_end [Date] An inclusive upper bound for searching created_at
+      #
+      # @param created_at_start [Date] An inclusive lower bound for searching created_at
+      #
       # @param direction [Symbol, ModernTreasury::Models::TransactionDirection]
-      # @param effective_date_end [Date]
-      # @param effective_date_start [Date]
-      # @param metadata [Hash{Symbol=>String}]
+      #
+      # @param effective_date_end [Date] An inclusive upper bound for searching effective_date
+      #
+      # @param effective_date_start [Date] An inclusive lower bound for searching effective_date
+      #
+      # @param metadata [Hash{Symbol=>String}] For example, if you want to query for records with metadata key `Type` and value
+      #
       # @param originating_account_id [String]
+      #
       # @param per_page [Integer]
-      # @param priority [Symbol, ModernTreasury::Models::PaymentOrderListParams::Priority]
-      # @param process_after_end [Time]
-      # @param process_after_start [Time]
-      # @param reference_number [String]
+      #
+      # @param priority [Symbol, ModernTreasury::Models::PaymentOrderListParams::Priority] Either `normal` or `high`. For ACH and EFT payments, `high` represents a same-da
+      #
+      # @param process_after_end [Time] An inclusive upper bound for searching process_after
+      #
+      # @param process_after_start [Time] An inclusive lower bound for searching process_after
+      #
+      # @param reference_number [String] Query for records with the provided reference number
+      #
       # @param status [Symbol, ModernTreasury::Models::PaymentOrderListParams::Status]
-      # @param transaction_id [String]
+      #
+      # @param transaction_id [String] The ID of a transaction that the payment order has been reconciled to.
+      #
       # @param type [Symbol, ModernTreasury::Models::PaymentOrderListParams::Type]
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::PaymentOrder>]
       #
       # @see ModernTreasury::Models::PaymentOrderListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::PaymentOrderListParams.dump_request(params)
+        parsed, options = ModernTreasury::PaymentOrderListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/payment_orders",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::PaymentOrder,
+          model: ModernTreasury::PaymentOrder,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::PaymentOrderCreateAsyncParams} for more details.
+      #
       # Create a new payment order asynchronously
       #
       # @overload create_async(amount:, direction:, originating_account_id:, type:, accounting: nil, accounting_category_id: nil, accounting_ledger_class_id: nil, charge_bearer: nil, currency: nil, description: nil, effective_date: nil, expires_at: nil, fallback_type: nil, foreign_exchange_contract: nil, foreign_exchange_indicator: nil, ledger_transaction: nil, ledger_transaction_id: nil, line_items: nil, metadata: nil, nsf_protected: nil, originating_party_name: nil, priority: nil, process_after: nil, purpose: nil, receiving_account: nil, receiving_account_id: nil, remittance_information: nil, send_remittance_advice: nil, statement_descriptor: nil, subtype: nil, transaction_monitoring_enabled: nil, ultimate_originating_party_identifier: nil, ultimate_originating_party_name: nil, ultimate_receiving_party_identifier: nil, ultimate_receiving_party_name: nil, request_options: {})
       #
-      # @param amount [Integer]
-      # @param direction [Symbol, ModernTreasury::Models::PaymentOrderCreateAsyncParams::Direction]
-      # @param originating_account_id [String]
-      # @param type [Symbol, ModernTreasury::Models::PaymentOrderType]
+      # @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
+      #
+      # @param direction [Symbol, ModernTreasury::Models::PaymentOrderCreateAsyncParams::Direction] One of `credit`, `debit`. Describes the direction money is flowing in the transa
+      #
+      # @param originating_account_id [String] The ID of one of your organization's internal accounts.
+      #
+      # @param type [Symbol, ModernTreasury::Models::PaymentOrderType] One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`, `sep
+      #
       # @param accounting [ModernTreasury::Models::PaymentOrderCreateAsyncParams::Accounting]
-      # @param accounting_category_id [String, nil]
-      # @param accounting_ledger_class_id [String, nil]
-      # @param charge_bearer [Symbol, ModernTreasury::Models::PaymentOrderCreateAsyncParams::ChargeBearer, nil]
-      # @param currency [Symbol, ModernTreasury::Models::Currency]
-      # @param description [String, nil]
-      # @param effective_date [Date]
-      # @param expires_at [Time, nil]
-      # @param fallback_type [Symbol, ModernTreasury::Models::PaymentOrderCreateAsyncParams::FallbackType]
-      # @param foreign_exchange_contract [String, nil]
-      # @param foreign_exchange_indicator [Symbol, ModernTreasury::Models::PaymentOrderCreateAsyncParams::ForeignExchangeIndicator, nil]
-      # @param ledger_transaction [ModernTreasury::Models::PaymentOrderCreateAsyncParams::LedgerTransaction]
-      # @param ledger_transaction_id [String]
-      # @param line_items [Array<ModernTreasury::Models::PaymentOrderCreateAsyncParams::LineItem>]
-      # @param metadata [Hash{Symbol=>String}]
-      # @param nsf_protected [Boolean]
-      # @param originating_party_name [String, nil]
-      # @param priority [Symbol, ModernTreasury::Models::PaymentOrderCreateAsyncParams::Priority]
-      # @param process_after [Time, nil]
-      # @param purpose [String, nil]
-      # @param receiving_account [ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount]
-      # @param receiving_account_id [String]
-      # @param remittance_information [String, nil]
-      # @param send_remittance_advice [Boolean, nil]
-      # @param statement_descriptor [String, nil]
-      # @param subtype [Symbol, ModernTreasury::Models::PaymentOrderSubtype, nil]
-      # @param transaction_monitoring_enabled [Boolean]
-      # @param ultimate_originating_party_identifier [String, nil]
-      # @param ultimate_originating_party_name [String, nil]
-      # @param ultimate_receiving_party_identifier [String, nil]
-      # @param ultimate_receiving_party_name [String, nil]
+      #
+      # @param accounting_category_id [String, nil] The ID of one of your accounting categories. Note that these will only be access
+      #
+      # @param accounting_ledger_class_id [String, nil] The ID of one of your accounting ledger classes. Note that these will only be ac
+      #
+      # @param charge_bearer [Symbol, ModernTreasury::Models::PaymentOrderCreateAsyncParams::ChargeBearer, nil] The party that will pay the fees for the payment order. Only applies to wire pay
+      #
+      # @param currency [Symbol, ModernTreasury::Models::Currency] Defaults to the currency of the originating account.
+      #
+      # @param description [String, nil] An optional description for internal use.
+      #
+      # @param effective_date [Date] Date transactions are to be posted to the participants' account. Defaults to the
+      #
+      # @param expires_at [Time, nil] RFP payments require an expires_at. This value must be past the effective_date.
+      #
+      # @param fallback_type [Symbol, ModernTreasury::Models::PaymentOrderCreateAsyncParams::FallbackType] A payment type to fallback to if the original type is not valid for the receivin
+      #
+      # @param foreign_exchange_contract [String, nil] If present, indicates a specific foreign exchange contract number that has been
+      #
+      # @param foreign_exchange_indicator [Symbol, ModernTreasury::Models::PaymentOrderCreateAsyncParams::ForeignExchangeIndicator, nil] Indicates the type of FX transfer to initiate, can be either `variable_to_fixed`
+      #
+      # @param ledger_transaction [ModernTreasury::Models::PaymentOrderCreateAsyncParams::LedgerTransaction] Specifies a ledger transaction object that will be created with the payment orde
+      #
+      # @param ledger_transaction_id [String] Either ledger_transaction or ledger_transaction_id can be provided. Only a pendi
+      #
+      # @param line_items [Array<ModernTreasury::Models::PaymentOrderCreateAsyncParams::LineItem>] An array of line items that must sum up to the amount of the payment order.
+      #
+      # @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+      #
+      # @param nsf_protected [Boolean] A boolean to determine if NSF Protection is enabled for this payment order. Note
+      #
+      # @param originating_party_name [String, nil] If present, this will replace your default company name on receiver's bank state
+      #
+      # @param priority [Symbol, ModernTreasury::Models::PaymentOrderCreateAsyncParams::Priority] Either `normal` or `high`. For ACH and EFT payments, `high` represents a same-da
+      #
+      # @param process_after [Time, nil] If present, Modern Treasury will not process the payment until after this time.
+      #
+      # @param purpose [String, nil] For `wire`, this is usually the purpose which is transmitted via the "InstrForDb
+      #
+      # @param receiving_account [ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount] Either `receiving_account` or `receiving_account_id` must be present. When using
+      #
+      # @param receiving_account_id [String] Either `receiving_account` or `receiving_account_id` must be present. When using
+      #
+      # @param remittance_information [String, nil] For `ach`, this field will be passed through on an addenda record. For `wire` pa
+      #
+      # @param send_remittance_advice [Boolean, nil] Send an email to the counterparty when the payment order is sent to the bank. If
+      #
+      # @param statement_descriptor [String, nil] An optional descriptor which will appear in the receiver's statement. For `check
+      #
+      # @param subtype [Symbol, ModernTreasury::Models::PaymentOrderSubtype, nil] An additional layer of classification for the type of payment order you are doin
+      #
+      # @param transaction_monitoring_enabled [Boolean] A flag that determines whether a payment order should go through transaction mon
+      #
+      # @param ultimate_originating_party_identifier [String, nil] Identifier of the ultimate originator of the payment order.
+      #
+      # @param ultimate_originating_party_name [String, nil] Name of the ultimate originator of the payment order.
+      #
+      # @param ultimate_receiving_party_identifier [String, nil] Identifier of the ultimate funds recipient.
+      #
+      # @param ultimate_receiving_party_name [String, nil] Name of the ultimate funds recipient.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::AsyncResponse]
       #
       # @see ModernTreasury::Models::PaymentOrderCreateAsyncParams
       def create_async(params)
-        parsed, options = ModernTreasury::Models::PaymentOrderCreateAsyncParams.dump_request(params)
+        parsed, options = ModernTreasury::PaymentOrderCreateAsyncParams.dump_request(params)
         @client.request(
           method: :post,
           path: "api/payment_orders/create_async",
           body: parsed,
-          model: ModernTreasury::Models::AsyncResponse,
+          model: ModernTreasury::AsyncResponse,
           options: options
         )
       end

data/lib/modern_treasury/resources/payment_references.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::PaymentReference]
@@ -17,33 +18,41 @@ module ModernTreasury
         @client.request(
           method: :get,
           path: ["api/payment_references/%1$s", id],
-          model: ModernTreasury::Models::PaymentReference,
+          model: ModernTreasury::PaymentReference,
           options: params[:request_options]
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::PaymentReferenceListParams} for more details.
+      #
       # list payment_references
       #
       # @overload list(after_cursor: nil, per_page: nil, reference_number: nil, referenceable_id: nil, referenceable_type: nil, request_options: {})
       #
       # @param after_cursor [String, nil]
+      #
       # @param per_page [Integer]
-      # @param reference_number [String]
-      # @param referenceable_id [String]
-      # @param referenceable_type [Symbol, ModernTreasury::Models::PaymentReferenceListParams::ReferenceableType]
+      #
+      # @param reference_number [String] The actual reference number assigned by the bank.
+      #
+      # @param referenceable_id [String] The id of the referenceable to search for. Must be accompanied by the referencea
+      #
+      # @param referenceable_type [Symbol, ModernTreasury::Models::PaymentReferenceListParams::ReferenceableType] One of the referenceable types. This must be accompanied by the id of the refere
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::PaymentReference>]
       #
       # @see ModernTreasury::Models::PaymentReferenceListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::PaymentReferenceListParams.dump_request(params)
+        parsed, options = ModernTreasury::PaymentReferenceListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/payment_references",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::PaymentReference,
+          model: ModernTreasury::PaymentReference,
           options: options
         )
       end

data/lib/modern_treasury/resources/returns.rb

@@ -3,29 +3,39 @@
 module ModernTreasury
   module Resources
     class Returns
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::ReturnCreateParams} for more details.
+      #
       # Create a return.
       #
       # @overload create(returnable_id:, returnable_type:, additional_information: nil, code: nil, data: nil, date_of_death: nil, reason: nil, request_options: {})
       #
-      # @param returnable_id [String, nil]
-      # @param returnable_type [Symbol, ModernTreasury::Models::ReturnCreateParams::ReturnableType]
-      # @param additional_information [String, nil]
-      # @param code [Symbol, ModernTreasury::Models::ReturnCreateParams::Code, nil]
-      # @param data [Object, nil]
-      # @param date_of_death [Date, nil]
-      # @param reason [String, nil]
+      # @param returnable_id [String, nil] The ID of the object being returned or `null`.
+      #
+      # @param returnable_type [Symbol, ModernTreasury::Models::ReturnCreateParams::ReturnableType] The type of object being returned. Currently, this may only be incoming*payment*
+      #
+      # @param additional_information [String, nil] Some returns may include additional information from the bank. In these cases, t
+      #
+      # @param code [Symbol, ModernTreasury::Models::ReturnCreateParams::Code, nil] The return code. For ACH returns, this is the required ACH return code.
+      #
+      # @param data [Object, nil] The raw data from the return file that we get from the bank.
+      #
+      # @param date_of_death [Date, nil] If the return code is `R14` or `R15` this is the date the deceased counterparty
+      #
+      # @param reason [String, nil] An optional description of the reason for the return. This is for internal usage
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::ReturnObject]
       #
       # @see ModernTreasury::Models::ReturnCreateParams
       def create(params)
-        parsed, options = ModernTreasury::Models::ReturnCreateParams.dump_request(params)
+        parsed, options = ModernTreasury::ReturnCreateParams.dump_request(params)
         @client.request(
           method: :post,
           path: "api/returns",
           body: parsed,
-          model: ModernTreasury::Models::ReturnObject,
+          model: ModernTreasury::ReturnObject,
           options: options
         )
       end
@@ -34,7 +44,8 @@ module ModernTreasury
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of an existing return.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Models::ReturnObject]
@@ -44,34 +55,43 @@ module ModernTreasury
         @client.request(
           method: :get,
           path: ["api/returns/%1$s", id],
-          model: ModernTreasury::Models::ReturnObject,
+          model: ModernTreasury::ReturnObject,
           options: params[:request_options]
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ModernTreasury::Models::ReturnListParams} for more details.
+      #
       # Get a list of returns.
       #
       # @overload list(after_cursor: nil, counterparty_id: nil, internal_account_id: nil, per_page: nil, returnable_id: nil, returnable_type: nil, request_options: {})
       #
       # @param after_cursor [String, nil]
-      # @param counterparty_id [String]
-      # @param internal_account_id [String]
+      #
+      # @param counterparty_id [String] Specify `counterparty_id` if you wish to see returns that occurred with a specif
+      #
+      # @param internal_account_id [String] Specify `internal_account_id` if you wish to see returns to/from a specific acco
+      #
       # @param per_page [Integer]
-      # @param returnable_id [String]
-      # @param returnable_type [Symbol, ModernTreasury::Models::ReturnListParams::ReturnableType]
+      #
+      # @param returnable_id [String] The ID of a valid returnable. Must be accompanied by `returnable_type`.
+      #
+      # @param returnable_type [Symbol, ModernTreasury::Models::ReturnListParams::ReturnableType] One of `payment_order`, `paper_item`, `reversal`, or `incoming_payment_detail`.
+      #
       # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::ReturnObject>]
       #
       # @see ModernTreasury::Models::ReturnListParams
       def list(params = {})
-        parsed, options = ModernTreasury::Models::ReturnListParams.dump_request(params)
+        parsed, options = ModernTreasury::ReturnListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "api/returns",
           query: parsed,
           page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::Models::ReturnObject,
+          model: ModernTreasury::ReturnObject,
           options: options
         )
       end