Class: MethodRuby::Models::Entities::IdentityListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MethodRuby::Models::Entities::IdentityListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/method_ruby/models/entities/identity_list_params.rb

Overview

See Also:

• Resources::Entities::Identities#list

Defined Under Namespace

Modules: MethodVersion

Instance Attribute Summary

• #entity_id ⇒ String
• #from_date ⇒ Date^?

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

• #method_version ⇒ Symbol, MethodRuby::Models::Entities::IdentityListParams::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.

• #to_date ⇒ Date^?

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

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

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

#entity_id ⇒ String

Returns:

• (String)

# File 'lib/method_ruby/models/entities/identity_list_params.rb', line 14

required :entity_id, String

#from_date ⇒ Date^?

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

Returns:

• (Date, nil)

# File 'lib/method_ruby/models/entities/identity_list_params.rb', line 25

optional :from_date, Date

#method_version ⇒ Symbol, MethodRuby::Models::Entities::IdentityListParams::MethodVersion

Returns:

• (Symbol, MethodRuby::Models::Entities::IdentityListParams::MethodVersion)

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

required :method_version, enum: -> { MethodRuby::Entities::IdentityListParams::MethodVersion }

#page ⇒ Integer^?

Page number for pagination (1-indexed).

Returns:

• (Integer, nil)

# File 'lib/method_ruby/models/entities/identity_list_params.rb', line 31

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/entities/identity_list_params.rb', line 38

optional :page_cursor, String

#page_limit ⇒ Integer^?

Number of items per page.

Returns:

• (Integer, nil)

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

optional :page_limit, Integer

#to_date ⇒ Date^?

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

Returns:

• (Date, nil)

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

optional :to_date, Date