Class: Moonbase::Models::Collections::ItemListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/moonbase/models/collections/item_list_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(collection_id:, after: nil, before: nil, limit: nil, sort: nil, request_options: {}) ⇒ Object

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

Parameters:

  • collection_id (String)
  • after (String) (defaults to: nil) —

    When specified, returns results starting immediately after the item identified b

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

    When specified, returns results starting immediately before the item identified

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

    Maximum number of items to return per page. Must be between 1 and 100. Defaults

  • sort (Array<String>) (defaults to: nil) —

    Sort items by the specified field ids or keys. Prefix a field with a hyphen/minu

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



# File 'lib/moonbase/models/collections/item_list_params.rb', line 46

Instance Attribute Details

#after ⇒ String?

When specified, returns results starting immediately after the item identified by this cursor. Use the cursor value from the previous response’s metadata to fetch the next page of results.

Returns:

  • (String, nil) 


22
 
# File 'lib/moonbase/models/collections/item_list_params.rb', line 22

optional :after, String

#before ⇒ String?

When specified, returns results starting immediately before the item identified by this cursor. Use the cursor value from the response’s metadata to fetch the previous page of results.

Returns:

  • (String, nil) 


30
 
# File 'lib/moonbase/models/collections/item_list_params.rb', line 30

optional :before, String

#collection_id ⇒ String

Returns:

  • (String) 


14
 
# File 'lib/moonbase/models/collections/item_list_params.rb', line 14

required :collection_id, String

#limit ⇒ Integer?

Maximum number of items to return per page. Must be between 1 and 100. Defaults to 20 if not specified.

Returns:

  • (Integer, nil) 


37
 
# File 'lib/moonbase/models/collections/item_list_params.rb', line 37

optional :limit, Integer

#sort ⇒ Array<String>?

Sort items by the specified field ids or keys. Prefix a field with a hyphen/minus (‘-`) to sort in descending order by that field.

Returns:

  • (Array<String>, nil) 


44
 
# File 'lib/moonbase/models/collections/item_list_params.rb', line 44

optional :sort, Moonbase::Internal::Type::ArrayOf[String]