Class: MethodRuby::Models::EntityListParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/method_ruby/models/entity_list_params.rb

Overview

See Also:

• Resources::Entities#list

Defined Under Namespace

Modules: Expand, MethodVersion, Status, Type

Instance Attribute Summary

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

  Expand related entity resources inline.

• #from_date ⇒ Date^?

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

• #method_version ⇒ Symbol, MethodRuby::Models::EntityListParams::MethodVersion
• #name ⇒ String^?

  Filter entities by their name.

• #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 entities by status.

• #to_date ⇒ Date^?

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

• #type ⇒ Symbol, ...

  Filter entities 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

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

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

Returns:

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

# File 'lib/method_ruby/models/entity_list_params.rb', line 20

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

#from_date ⇒ Date^?

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

Returns:

• (Date, nil)

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

optional :from_date, Date

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

Returns:

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

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

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

#name ⇒ String^?

Filter entities by their name.

Returns:

• (String, nil)

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

optional :name, String

#page ⇒ Integer^?

Page number for pagination (1-indexed).

Returns:

• (Integer, nil)

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

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/entity_list_params.rb', line 45

optional :page_cursor, String

#page_limit ⇒ Integer^?

Number of items per page.

Returns:

• (Integer, nil)

# File 'lib/method_ruby/models/entity_list_params.rb', line 51

optional :page_limit, Integer

#status ⇒ Symbol, ...

Filter entities by status.

Returns:

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

# File 'lib/method_ruby/models/entity_list_params.rb', line 57

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

#to_date ⇒ Date^?

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

Returns:

• (Date, nil)

# File 'lib/method_ruby/models/entity_list_params.rb', line 63

optional :to_date, Date

#type ⇒ Symbol, ...

Filter entities by type.

Returns:

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

# File 'lib/method_ruby/models/entity_list_params.rb', line 69

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/method_ruby/models/entity_list_params.rb', line 102