Class: ModernTreasury::Models::PaymentOrderListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModernTreasury::Models::PaymentOrderListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/modern_treasury/models/payment_order_list_params.rb

Overview

See Also:

• Resources::PaymentOrders#list

Defined Under Namespace

Modules: Priority, Status, Type

Instance Attribute Summary

• #after_cursor ⇒ String^?
• #counterparty_id ⇒ String^?
• #created_at_end ⇒ Date^?

  An inclusive upper bound for searching created_at.

• #created_at_start ⇒ Date^?

  An inclusive lower bound for searching created_at.

• #direction ⇒ Symbol, ...
• #effective_date_end ⇒ Date^?

  An inclusive upper bound for searching effective_date.

• #effective_date_start ⇒ Date^?

  An inclusive lower bound for searching effective_date.

• #external_id ⇒ String^?
• #metadata ⇒ Hash{Symbol=>String}^?

  For example, if you want to query for records with metadata key ‘Type` and value `Loan`, the query would be `metadata%5BType%5D=Loan`.

• #originating_account_id ⇒ String^?
• #per_page ⇒ Integer^?
• #priority ⇒ Symbol, ...

  Either ‘normal` or `high`.

• #process_after_end ⇒ Time^?

  An inclusive upper bound for searching process_after.

• #process_after_start ⇒ Time^?

  An inclusive lower bound for searching process_after.

• #reference_number ⇒ String^?

  Query for records with the provided reference number.

• #status ⇒ Symbol, ...
• #transaction_id ⇒ String^?

  The ID of a transaction that the payment order has been reconciled to.

• #type ⇒ Symbol, ...

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(after_cursor: nil, counterparty_id: nil, created_at_end: nil, created_at_start: nil, direction: nil, effective_date_end: nil, effective_date_start: nil, external_id: 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: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see PaymentOrderListParams for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(after_cursor: nil, counterparty_id: nil, created_at_end: nil, created_at_start: nil, direction: nil, effective_date_end: nil, effective_date_start: nil, external_id: 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: {}) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::PaymentOrderListParams for more details.

Parameters:

• after_cursor (String, nil) (defaults to: nil)
• counterparty_id (String) (defaults to: nil)
• created_at_end (Date) (defaults to: nil) —

  An inclusive upper bound for searching created_at

• created_at_start (Date) (defaults to: nil) —

  An inclusive lower bound for searching created_at

• direction (Symbol, ModernTreasury::Models::TransactionDirection) (defaults to: nil)
• effective_date_end (Date) (defaults to: nil) —

  An inclusive upper bound for searching effective_date

• effective_date_start (Date) (defaults to: nil) —

  An inclusive lower bound for searching effective_date

• external_id (String) (defaults to: nil)
• metadata (Hash{Symbol=>String}) (defaults to: nil) —

  For example, if you want to query for records with metadata key ‘Type` and value

• originating_account_id (String) (defaults to: nil)
• per_page (Integer) (defaults to: nil)
• priority (Symbol, ModernTreasury::Models::PaymentOrderListParams::Priority) (defaults to: nil) —

  Either ‘normal` or `high`. For ACH and EFT payments, `high` represents a same-da

• process_after_end (Time) (defaults to: nil) —

  An inclusive upper bound for searching process_after

• process_after_start (Time) (defaults to: nil) —

  An inclusive lower bound for searching process_after

• reference_number (String) (defaults to: nil) —

  Query for records with the provided reference number

• status (Symbol, ModernTreasury::Models::PaymentOrderListParams::Status) (defaults to: nil)
• transaction_id (String) (defaults to: nil) —

  The ID of a transaction that the payment order has been reconciled to.

• type (Symbol, ModernTreasury::Models::PaymentOrderListParams::Type) (defaults to: nil)
• request_options (ModernTreasury::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/modern_treasury/models/payment_order_list_params.rb', line 114

Instance Attribute Details

#after_cursor ⇒ String^?

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/payment_order_list_params.rb', line 13

optional :after_cursor, String, nil?: true

#counterparty_id ⇒ String^?

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/payment_order_list_params.rb', line 18

optional :counterparty_id, String

#created_at_end ⇒ Date^?

An inclusive upper bound for searching created_at

Returns:

• (Date, nil)

# File 'lib/modern_treasury/models/payment_order_list_params.rb', line 24

optional :created_at_end, Date

#created_at_start ⇒ Date^?

An inclusive lower bound for searching created_at

Returns:

• (Date, nil)

# File 'lib/modern_treasury/models/payment_order_list_params.rb', line 30

optional :created_at_start, Date

#direction ⇒ Symbol, ...

Returns:

• (Symbol, ModernTreasury::Models::TransactionDirection, nil)

# File 'lib/modern_treasury/models/payment_order_list_params.rb', line 35

optional :direction, enum: -> { ModernTreasury::TransactionDirection }

#effective_date_end ⇒ Date^?

An inclusive upper bound for searching effective_date

Returns:

• (Date, nil)

# File 'lib/modern_treasury/models/payment_order_list_params.rb', line 41

optional :effective_date_end, Date

#effective_date_start ⇒ Date^?

An inclusive lower bound for searching effective_date

Returns:

• (Date, nil)

# File 'lib/modern_treasury/models/payment_order_list_params.rb', line 47

optional :effective_date_start, Date

#external_id ⇒ String^?

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/payment_order_list_params.rb', line 52

optional :external_id, String

#metadata ⇒ Hash{Symbol=>String}^?

For example, if you want to query for records with metadata key ‘Type` and value `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query parameters.

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/modern_treasury/models/payment_order_list_params.rb', line 60

optional :metadata, ModernTreasury::Internal::Type::HashOf[String]

#originating_account_id ⇒ String^?

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/payment_order_list_params.rb', line 65

optional :originating_account_id, String

#per_page ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/modern_treasury/models/payment_order_list_params.rb', line 70

optional :per_page, Integer

#priority ⇒ Symbol, ...

Either ‘normal` or `high`. For ACH and EFT payments, `high` represents a same-day ACH or EFT transfer, respectively. For check payments, `high` can mean an overnight check rather than standard mail.

Returns:

• (Symbol, ModernTreasury::Models::PaymentOrderListParams::Priority, nil)

# File 'lib/modern_treasury/models/payment_order_list_params.rb', line 78

optional :priority, enum: -> { ModernTreasury::PaymentOrderListParams::Priority }

#process_after_end ⇒ Time^?

An inclusive upper bound for searching process_after

Returns:

• (Time, nil)

# File 'lib/modern_treasury/models/payment_order_list_params.rb', line 84

optional :process_after_end, Time

#process_after_start ⇒ Time^?

An inclusive lower bound for searching process_after

Returns:

• (Time, nil)

# File 'lib/modern_treasury/models/payment_order_list_params.rb', line 90

optional :process_after_start, Time

#reference_number ⇒ String^?

Query for records with the provided reference number

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/payment_order_list_params.rb', line 96

optional :reference_number, String

#status ⇒ Symbol, ...

Returns:

• (Symbol, ModernTreasury::Models::PaymentOrderListParams::Status, nil)

# File 'lib/modern_treasury/models/payment_order_list_params.rb', line 101

optional :status, enum: -> { ModernTreasury::PaymentOrderListParams::Status }

#transaction_id ⇒ String^?

The ID of a transaction that the payment order has been reconciled to.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/payment_order_list_params.rb', line 107

optional :transaction_id, String

#type ⇒ Symbol, ...

Returns:

• (Symbol, ModernTreasury::Models::PaymentOrderListParams::Type, nil)

# File 'lib/modern_treasury/models/payment_order_list_params.rb', line 112

optional :type, enum: -> { ModernTreasury::PaymentOrderListParams::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/modern_treasury/models/payment_order_list_params.rb', line 165