Class: Spotted::Models::SearchRetrieveResponse::Shows

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/spotted/models/search_retrieve_response.rb

Overview

See Also:

Instance Attribute Summary collapse

Method Summary

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 Spotted::Internal::Type::BaseModel

Instance Attribute Details

#href ⇒ String

A link to the Web API endpoint returning the full result of the request

Returns:

  • (String) 


472
 
# File 'lib/spotted/models/search_retrieve_response.rb', line 472

required :href, String

#items ⇒ Array<Spotted::Models::ShowBase>

Returns:



477
 
# File 'lib/spotted/models/search_retrieve_response.rb', line 477

required :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::ShowBase] }

#limit ⇒ Integer

The maximum number of items in the response (as set in the query or by default).

Returns:

  • (Integer) 


483
 
# File 'lib/spotted/models/search_retrieve_response.rb', line 483

required :limit, Integer

#next_ ⇒ String?

URL to the next page of items. ( ‘null` if none)

Returns:

  • (String, nil) 


489
 
# File 'lib/spotted/models/search_retrieve_response.rb', line 489

required :next_, String, api_name: :next, nil?: true

#offset ⇒ Integer

The offset of the items returned (as set in the query or by default)

Returns:

  • (Integer) 


495
 
# File 'lib/spotted/models/search_retrieve_response.rb', line 495

required :offset, Integer

#previous ⇒ String?

URL to the previous page of items. ( ‘null` if none)

Returns:

  • (String, nil) 


501
 
# File 'lib/spotted/models/search_retrieve_response.rb', line 501

required :previous, String, nil?: true

#total ⇒ Integer

The total number of items available to return.

Returns:

  • (Integer) 


507
 
# File 'lib/spotted/models/search_retrieve_response.rb', line 507

required :total, Integer