Class: SpotifyWebApi::MeShowsRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/spotify_web_api/models/me_shows_request.rb

Overview

MeShowsRequest Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(ids = SKIP) ⇒ MeShowsRequest

Returns a new instance of MeShowsRequest.



40
41
42
# File 'lib/spotify_web_api/models/me_shows_request.rb', line 40

def initialize(ids = SKIP)
  @ids = ids unless ids == SKIP
end

Instance Attribute Details

#idsArray[String]

A JSON array of the [Spotify IDs](developer.spotify.com/documentation/web-api/#spotify-uris-and -ids).

A maximum of 50 items can be specified in one request. *Note: if the ‘ids` parameter is present in the query string, any IDs listed here in the body will be ignored.*

Returns:

  • (Array[String])


19
20
21
# File 'lib/spotify_web_api/models/me_shows_request.rb', line 19

def ids
  @ids
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



45
46
47
48
49
50
51
52
53
# File 'lib/spotify_web_api/models/me_shows_request.rb', line 45

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  ids = hash.key?('ids') ? hash['ids'] : SKIP

  # Create object from extracted values.

  MeShowsRequest.new(ids)
end

.namesObject

A mapping from model property names to API property names.



22
23
24
25
26
# File 'lib/spotify_web_api/models/me_shows_request.rb', line 22

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['ids'] = 'ids'
  @_hash
end

.nullablesObject

An array for nullable fields



36
37
38
# File 'lib/spotify_web_api/models/me_shows_request.rb', line 36

def self.nullables
  []
end

.optionalsObject

An array for optional fields



29
30
31
32
33
# File 'lib/spotify_web_api/models/me_shows_request.rb', line 29

def self.optionals
  %w[
    ids
  ]
end