Class: MethodRuby::Models::AccountListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MethodRuby::Models::AccountListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/method_ruby/models/account_list_params.rb

Overview

See Also:

• Resources::Accounts#list

Defined Under Namespace

Modules: ConsentStatus, Expand, MethodVersion, Status, Type Classes: Liability

Instance Attribute Summary

• #consent_status ⇒ Symbol, ...

  Filter accounts by consent status.

• #expand ⇒ Array<Symbol, MethodRuby::Models::AccountListParams::Expand>^?

  Expand related account resources inline.

• #from_date ⇒ Date^?

  Filter results from this date (inclusive, YYYY-MM-DD format).

• #holder_id ⇒ String^?

  Filter accounts by the entity ID that owns them.

• #holder_ids ⇒ Array<String>^?

  Filter accounts by one or more entity IDs.

• #include_pending_consent ⇒ Boolean^?

  Include accounts that are still pending consent.

• #liability ⇒ MethodRuby::Models::AccountListParams::Liability^?
• #method_version ⇒ Symbol, MethodRuby::Models::AccountListParams::MethodVersion
• #page ⇒ Integer^?

  Page number for pagination (1-indexed).

• #page_cursor ⇒ String^?

  Cursor for cursor-based pagination.

• #page_limit ⇒ Integer^?

  Number of items per page.

• #status ⇒ Symbol, ...

  Filter accounts by status.

• #to_date ⇒ Date^?

  Filter results to this date (inclusive, YYYY-MM-DD format).

• #type ⇒ Symbol, ...

  Filter accounts by type.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

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, #initialize, 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

This class inherits a constructor from MethodRuby::Internal::Type::BaseModel

Instance Attribute Details

#consent_status ⇒ Symbol, ...

Filter accounts by consent status.

Returns:

• (Symbol, MethodRuby::Models::AccountListParams::ConsentStatus, nil)

# File 'lib/method_ruby/models/account_list_params.rb', line 19

optional :consent_status, enum: -> { MethodRuby::AccountListParams::ConsentStatus }

#expand ⇒ Array<Symbol, MethodRuby::Models::AccountListParams::Expand>^?

Expand related account resources inline. Supports the account expandable fields documented by the API validator for account list and retrieve operations.

Returns:

• (Array<Symbol, MethodRuby::Models::AccountListParams::Expand>, nil)

# File 'lib/method_ruby/models/account_list_params.rb', line 26

optional :expand, -> { MethodRuby::Internal::Type::ArrayOf[enum: MethodRuby::AccountListParams::Expand] }

#from_date ⇒ Date^?

Filter results from this date (inclusive, YYYY-MM-DD format).

Returns:

• (Date, nil)

# File 'lib/method_ruby/models/account_list_params.rb', line 32

optional :from_date, Date

#holder_id ⇒ String^?

Filter accounts by the entity ID that owns them.

Returns:

• (String, nil)

# File 'lib/method_ruby/models/account_list_params.rb', line 38

optional :holder_id, String

#holder_ids ⇒ Array<String>^?

Filter accounts by one or more entity IDs.

Returns:

• (Array<String>, nil)

# File 'lib/method_ruby/models/account_list_params.rb', line 44

optional :holder_ids, MethodRuby::Internal::Type::ArrayOf[String]

#include_pending_consent ⇒ Boolean^?

Include accounts that are still pending consent.

Returns:

• (Boolean, nil)

# File 'lib/method_ruby/models/account_list_params.rb', line 50

optional :include_pending_consent, MethodRuby::Internal::Type::Boolean

#liability ⇒ MethodRuby::Models::AccountListParams::Liability^?

Returns:

• (MethodRuby::Models::AccountListParams::Liability, nil)

# File 'lib/method_ruby/models/account_list_params.rb', line 55

optional :liability, -> { MethodRuby::AccountListParams::Liability }

#method_version ⇒ Symbol, MethodRuby::Models::AccountListParams::MethodVersion

Returns:

• (Symbol, MethodRuby::Models::AccountListParams::MethodVersion)

# File 'lib/method_ruby/models/account_list_params.rb', line 13

required :method_version, enum: -> { MethodRuby::AccountListParams::MethodVersion }

#page ⇒ Integer^?

Page number for pagination (1-indexed).

Returns:

• (Integer, nil)

# File 'lib/method_ruby/models/account_list_params.rb', line 61

optional :page, Integer

#page_cursor ⇒ String^?

Cursor for cursor-based pagination. Use the value from ‘Pagination-Page-Cursor-Next` or `Pagination-Page-Cursor-Prev` response headers.

Returns:

• (String, nil)

# File 'lib/method_ruby/models/account_list_params.rb', line 68

optional :page_cursor, String

#page_limit ⇒ Integer^?

Number of items per page.

Returns:

• (Integer, nil)

# File 'lib/method_ruby/models/account_list_params.rb', line 74

optional :page_limit, Integer

#status ⇒ Symbol, ...

Filter accounts by status.

Returns:

• (Symbol, MethodRuby::Models::AccountListParams::Status, nil)

# File 'lib/method_ruby/models/account_list_params.rb', line 80

optional :status, enum: -> { MethodRuby::AccountListParams::Status }

#to_date ⇒ Date^?

Filter results to this date (inclusive, YYYY-MM-DD format).

Returns:

• (Date, nil)

# File 'lib/method_ruby/models/account_list_params.rb', line 86

optional :to_date, Date

#type ⇒ Symbol, ...

Filter accounts by type.

Returns:

• (Symbol, MethodRuby::Models::AccountListParams::Type, nil)

# File 'lib/method_ruby/models/account_list_params.rb', line 92

optional :type, enum: -> { MethodRuby::AccountListParams::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/method_ruby/models/account_list_params.rb', line 133