Class: Orb::Models::ItemListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Orb::Models::ItemListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/orb/models/item_list_params.rb

Overview

See Also:

• Resources::Items#list

Instance Attribute Summary

• #cursor ⇒ String^?

  Cursor for pagination.

• #limit ⇒ Integer^?

  The number of items to fetch.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(cursor: nil, limit: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see ItemListParams 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(cursor: nil, limit: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::ItemListParams for more details.

Parameters:

• cursor (String, nil) (defaults to: nil) —

  Cursor for pagination. This can be populated by the ‘next_cursor` value returned

• limit (Integer) (defaults to: nil) —

  The number of items to fetch. Defaults to 20.

• request_options (Orb::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/orb/models/item_list_params.rb', line 23

Instance Attribute Details

#cursor ⇒ String^?

Cursor for pagination. This can be populated by the ‘next_cursor` value returned from the initial request.

Returns:

• (String, nil)

# File 'lib/orb/models/item_list_params.rb', line 15

optional :cursor, String, nil?: true

#limit ⇒ Integer^?

The number of items to fetch. Defaults to 20.

Returns:

• (Integer, nil)

# File 'lib/orb/models/item_list_params.rb', line 21

optional :limit, Integer