Class: Moonbase::Models::Collections::ItemSearchParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Moonbase::Models::Collections::ItemSearchParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/moonbase/models/collections/item_search_params.rb

Overview

See Also:

• Resources::Collections::Items#search

Instance Attribute Summary

• #after ⇒ String^?

  When specified, returns results starting immediately after the item identified by this cursor.

• #before ⇒ String^?

  When specified, returns results starting immediately before the item identified by this cursor.

• #collection_id ⇒ String
• #filter ⇒ Moonbase::Models::ItemsFilterValueMatches, ...

  Return only items that match the filter conditions.

• #include ⇒ Array<String>^?

  Include only specific fields in the returned items.

• #limit ⇒ Integer^?

  Maximum number of items to return per page.

• #sort ⇒ Array<String>^?

  Sort items by the specified field ids or keys.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(collection_id:, after: nil, before: nil, limit: nil, filter: nil, include: nil, sort: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see ItemSearchParams 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(collection_id:, after: nil, before: nil, limit: nil, filter: nil, include: nil, sort: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Moonbase::Models::Collections::ItemSearchParams 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

• filter (Moonbase::Models::ItemsFilterValueMatches, Moonbase::Models::ItemsFilterValueExists, Moonbase::Models::ItemsFilterAndGroup, Moonbase::Models::ItemsFilterOrGroup, Moonbase::Models::ItemsFilterNotGroup) (defaults to: nil) —

  Return only items that match the filter conditions. Complex filters can be creat

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

  Include only specific fields in the returned items. Specify fields by id or key.

• 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_search_params.rb', line 59

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)

# File 'lib/moonbase/models/collections/item_search_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)

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

optional :before, String

#collection_id ⇒ String

Returns:

• (String)

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

required :collection_id, String

#filter ⇒ Moonbase::Models::ItemsFilterValueMatches, ...

Return only items that match the filter conditions. Complex filters can be created by nesting filters inside of ‘AND`, `OR`, and `NOT` filters.

Returns:

• (Moonbase::Models::ItemsFilterValueMatches, Moonbase::Models::ItemsFilterValueExists, Moonbase::Models::ItemsFilterAndGroup, Moonbase::Models::ItemsFilterOrGroup, Moonbase::Models::ItemsFilterNotGroup, nil)

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

optional :filter, union: -> { Moonbase::ItemsFilter }

#include ⇒ Array<String>^?

Include only specific fields in the returned items. Specify fields by id or key.

Returns:

• (Array<String>, nil)

# File 'lib/moonbase/models/collections/item_search_params.rb', line 50

optional :include, Moonbase::Internal::Type::ArrayOf[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)

# File 'lib/moonbase/models/collections/item_search_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)

# File 'lib/moonbase/models/collections/item_search_params.rb', line 57

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