Class: Spotted::Models::ShowBase

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

Direct Known Subclasses

ShowRetrieveResponse

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

Instance Method Summary collapse

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(id: , available_markets: , copyrights: , description: , explicit: , external_urls: , href: , html_description: , images: , is_externally_hosted: , languages: , media_type: , name: , publisher: , total_episodes: , type: , uri: ) ⇒ Object

Some parameter documentations has been truncated, see Spotted::Models::ShowBase for more details.

Parameters:

  • id (String) (defaults to: ) —

    The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the show.

  • available_markets (Array<String>) (defaults to: ) —

    A list of the countries in which the show can be played, identified by their [IS

  • copyrights (Array<Spotted::Models::CopyrightObject>) (defaults to: ) —

    The copyright statements of the show.

  • description (String) (defaults to: ) —

    A description of the show. HTML tags are stripped away from this field, use ‘htm

  • explicit (Boolean) (defaults to: ) —

    Whether or not the show has explicit content (true = yes it does; false = no it

  • external_urls (Spotted::Models::ExternalURLObject) (defaults to: ) —

    External URLs for this show.

  • href (String) (defaults to: ) —

    A link to the Web API endpoint providing full details of the show.

  • html_description (String) (defaults to: ) —

    A description of the show. This field may contain HTML tags.

  • images (Array<Spotted::Models::ImageObject>) (defaults to: ) —

    The cover art for the show in various sizes, widest first.

  • is_externally_hosted (Boolean) (defaults to: ) —

    True if all of the shows episodes are hosted outside of Spotify’s CDN. This fiel

  • languages (Array<String>) (defaults to: ) —

    A list of the languages used in the show, identified by their [ISO 639](https://

  • media_type (String) (defaults to: ) —

    The media type of the show.

  • name (String) (defaults to: ) —

    The name of the episode.

  • publisher (String) (defaults to: ) —

    The publisher of the show.

  • total_episodes (Integer) (defaults to: ) —

    The total number of episodes in the show.

  • type (Symbol, Spotted::Models::ShowBase::Type) (defaults to: ) —

    The object type.

  • uri (String) (defaults to: ) —

    The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the show




# File 'lib/spotted/models/show_base.rb', line 114

Instance Attribute Details

#available_markets ⇒ Array<String>

A list of the countries in which the show can be played, identified by their [ISO 3166-1 alpha-2](en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code.

Returns:

  • (Array<String>) 


17
 
# File 'lib/spotted/models/show_base.rb', line 17

required :available_markets, Spotted::Internal::Type::ArrayOf[String]

#copyrights ⇒ Array<Spotted::Models::CopyrightObject>

The copyright statements of the show.

Returns:



23
 
# File 'lib/spotted/models/show_base.rb', line 23

required :copyrights, -> { Spotted::Internal::Type::ArrayOf[Spotted::CopyrightObject] }

#description ⇒ String

A description of the show. HTML tags are stripped away from this field, use ‘html_description` field in case HTML tags are needed.

Returns:

  • (String) 


30
 
# File 'lib/spotted/models/show_base.rb', line 30

required :description, String

#explicit ⇒ Boolean

Whether or not the show has explicit content (true = yes it does; false = no it does not OR unknown).

Returns:

  • (Boolean) 


37
 
# File 'lib/spotted/models/show_base.rb', line 37

required :explicit, Spotted::Internal::Type::Boolean

#external_urls ⇒ Spotted::Models::ExternalURLObject

External URLs for this show.

Returns:



43
 
# File 'lib/spotted/models/show_base.rb', line 43

required :external_urls, -> { Spotted::ExternalURLObject }

#href ⇒ String

A link to the Web API endpoint providing full details of the show.

Returns:

  • (String) 


49
 
# File 'lib/spotted/models/show_base.rb', line 49

required :href, String

#html_description ⇒ String

A description of the show. This field may contain HTML tags.

Returns:

  • (String) 


55
 
# File 'lib/spotted/models/show_base.rb', line 55

required :html_description, String

#id ⇒ String

The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the show.

Returns:

  • (String) 


10
 
# File 'lib/spotted/models/show_base.rb', line 10

required :id, String

#images ⇒ Array<Spotted::Models::ImageObject>

The cover art for the show in various sizes, widest first.

Returns:



61
 
# File 'lib/spotted/models/show_base.rb', line 61

required :images, -> { Spotted::Internal::Type::ArrayOf[Spotted::ImageObject] }

#is_externally_hosted ⇒ Boolean

True if all of the shows episodes are hosted outside of Spotify’s CDN. This field might be ‘null` in some cases.

Returns:

  • (Boolean) 


68
 
# File 'lib/spotted/models/show_base.rb', line 68

required :is_externally_hosted, Spotted::Internal::Type::Boolean

#languages ⇒ Array<String>

A list of the languages used in the show, identified by their [ISO 639](en.wikipedia.org/wiki/ISO_639) code.

Returns:

  • (Array<String>) 


75
 
# File 'lib/spotted/models/show_base.rb', line 75

required :languages, Spotted::Internal::Type::ArrayOf[String]

#media_type ⇒ String

The media type of the show.

Returns:

  • (String) 


81
 
# File 'lib/spotted/models/show_base.rb', line 81

required :media_type, String

#name ⇒ String

The name of the episode.

Returns:

  • (String) 


87
 
# File 'lib/spotted/models/show_base.rb', line 87

required :name, String

#publisher ⇒ String

The publisher of the show.

Returns:

  • (String) 


93
 
# File 'lib/spotted/models/show_base.rb', line 93

required :publisher, String

#total_episodes ⇒ Integer

The total number of episodes in the show.

Returns:

  • (Integer) 


99
 
# File 'lib/spotted/models/show_base.rb', line 99

required :total_episodes, Integer

#type ⇒ Symbol, Spotted::Models::ShowBase::Type

The object type.

Returns:



105
 
# File 'lib/spotted/models/show_base.rb', line 105

required :type, enum: -> { Spotted::ShowBase::Type }

#uri ⇒ String

The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the show.

Returns:

  • (String) 


112
 
# File 'lib/spotted/models/show_base.rb', line 112

required :uri, String