spotify-api-sdk 1.0.0

data/lib/spotify_web_api/models/show_object.rb

@@ -0,0 +1,219 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # ShowObject Model.
+  class ShowObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of the countries in which the show can be played, identified by
+    # their [ISO 3166-1
+    # alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code.
+    # @return [Array[String]]
+    attr_accessor :available_markets
+
+    # The copyright statements of the show.
+    # @return [Array[CopyrightObject]]
+    attr_accessor :copyrights
+
+    # A description of the show. HTML tags are stripped away from this field,
+    # use `html_description` field in case HTML tags are needed.
+    # @return [String]
+    attr_accessor :description
+
+    # A description of the show. This field may contain HTML tags.
+    # @return [String]
+    attr_accessor :html_description
+
+    # Whether or not the show has explicit content (true = yes it does; false =
+    # no it does not OR unknown).
+    # @return [TrueClass | FalseClass]
+    attr_accessor :explicit
+
+    # External URLs for this show.
+    # @return [ExternalUrlObject]
+    attr_accessor :external_urls
+
+    # A link to the Web API endpoint providing full details of the show.
+    # @return [String]
+    attr_accessor :href
+
+    # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+    # show.
+    # @return [String]
+    attr_accessor :id
+
+    # The cover art for the show in various sizes, widest first.
+    # @return [Array[ImageObject]]
+    attr_accessor :images
+
+    # True if all of the shows episodes are hosted outside of Spotify's CDN.
+    # This field might be `null` in some cases.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_externally_hosted
+
+    # A list of the languages used in the show, identified by their [ISO
+    # 639](https://en.wikipedia.org/wiki/ISO_639) code.
+    # @return [Array[String]]
+    attr_accessor :languages
+
+    # The media type of the show.
+    # @return [String]
+    attr_accessor :media_type
+
+    # The name of the episode.
+    # @return [String]
+    attr_accessor :name
+
+    # The publisher of the show.
+    # @return [String]
+    attr_accessor :publisher
+
+    # The object type.
+    # @return [Type7Enum]
+    attr_accessor :type
+
+    # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for
+    # the show.
+    # @return [String]
+    attr_accessor :uri
+
+    # The total number of episodes in the show.
+    # @return [Integer]
+    attr_accessor :total_episodes
+
+    # The episodes of the show.
+    # @return [PagingSimplifiedEpisodeObject]
+    attr_accessor :episodes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['available_markets'] = 'available_markets'
+      @_hash['copyrights'] = 'copyrights'
+      @_hash['description'] = 'description'
+      @_hash['html_description'] = 'html_description'
+      @_hash['explicit'] = 'explicit'
+      @_hash['external_urls'] = 'external_urls'
+      @_hash['href'] = 'href'
+      @_hash['id'] = 'id'
+      @_hash['images'] = 'images'
+      @_hash['is_externally_hosted'] = 'is_externally_hosted'
+      @_hash['languages'] = 'languages'
+      @_hash['media_type'] = 'media_type'
+      @_hash['name'] = 'name'
+      @_hash['publisher'] = 'publisher'
+      @_hash['type'] = 'type'
+      @_hash['uri'] = 'uri'
+      @_hash['total_episodes'] = 'total_episodes'
+      @_hash['episodes'] = 'episodes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(available_markets = nil, copyrights = nil, description = nil,
+                   html_description = nil, explicit = nil, external_urls = nil,
+                   href = nil, id = nil, images = nil,
+                   is_externally_hosted = nil, languages = nil,
+                   media_type = nil, name = nil, publisher = nil, type = nil,
+                   uri = nil, total_episodes = nil, episodes = nil)
+      @available_markets = available_markets
+      @copyrights = copyrights
+      @description = description
+      @html_description = html_description
+      @explicit = explicit
+      @external_urls = external_urls
+      @href = href
+      @id = id
+      @images = images
+      @is_externally_hosted = is_externally_hosted
+      @languages = languages
+      @media_type = media_type
+      @name = name
+      @publisher = publisher
+      @type = type
+      @uri = uri
+      @total_episodes = total_episodes
+      @episodes = episodes
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      available_markets =
+        hash.key?('available_markets') ? hash['available_markets'] : nil
+      # Parameter is an array, so we need to iterate through it
+      copyrights = nil
+      unless hash['copyrights'].nil?
+        copyrights = []
+        hash['copyrights'].each do |structure|
+          copyrights << (CopyrightObject.from_hash(structure) if structure)
+        end
+      end
+
+      copyrights = nil unless hash.key?('copyrights')
+      description = hash.key?('description') ? hash['description'] : nil
+      html_description =
+        hash.key?('html_description') ? hash['html_description'] : nil
+      explicit = hash.key?('explicit') ? hash['explicit'] : nil
+      external_urls = ExternalUrlObject.from_hash(hash['external_urls']) if hash['external_urls']
+      href = hash.key?('href') ? hash['href'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      # Parameter is an array, so we need to iterate through it
+      images = nil
+      unless hash['images'].nil?
+        images = []
+        hash['images'].each do |structure|
+          images << (ImageObject.from_hash(structure) if structure)
+        end
+      end
+
+      images = nil unless hash.key?('images')
+      is_externally_hosted =
+        hash.key?('is_externally_hosted') ? hash['is_externally_hosted'] : nil
+      languages = hash.key?('languages') ? hash['languages'] : nil
+      media_type = hash.key?('media_type') ? hash['media_type'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      publisher = hash.key?('publisher') ? hash['publisher'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      uri = hash.key?('uri') ? hash['uri'] : nil
+      total_episodes =
+        hash.key?('total_episodes') ? hash['total_episodes'] : nil
+      episodes = PagingSimplifiedEpisodeObject.from_hash(hash['episodes']) if hash['episodes']
+
+      # Create object from extracted values.
+      ShowObject.new(available_markets,
+                     copyrights,
+                     description,
+                     html_description,
+                     explicit,
+                     external_urls,
+                     href,
+                     id,
+                     images,
+                     is_externally_hosted,
+                     languages,
+                     media_type,
+                     name,
+                     publisher,
+                     type,
+                     uri,
+                     total_episodes,
+                     episodes)
+    end
+  end
+end

data/lib/spotify_web_api/models/simplified_album_object.rb

@@ -0,0 +1,186 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # SimplifiedAlbumObject Model.
+  class SimplifiedAlbumObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of the album.
+    # @return [AlbumTypeEnum]
+    attr_accessor :album_type
+
+    # The number of tracks in the album.
+    # @return [Integer]
+    attr_accessor :total_tracks
+
+    # The markets in which the album is available: [ISO 3166-1 alpha-2 country
+    # codes](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). _**NOTE**: an
+    # album is considered available in a market when at least 1 of its tracks is
+    # available in that market._
+    # @return [Array[String]]
+    attr_accessor :available_markets
+
+    # Known external URLs for this album.
+    # @return [ExternalUrlObject]
+    attr_accessor :external_urls
+
+    # A link to the Web API endpoint providing full details of the album.
+    # @return [String]
+    attr_accessor :href
+
+    # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+    # album.
+    # @return [String]
+    attr_accessor :id
+
+    # The cover art for the album in various sizes, widest first.
+    # @return [Array[ImageObject]]
+    attr_accessor :images
+
+    # The name of the album. In case of an album takedown, the value may be an
+    # empty string.
+    # @return [String]
+    attr_accessor :name
+
+    # The date the album was first released.
+    # @return [String]
+    attr_accessor :release_date
+
+    # The precision with which `release_date` value is known.
+    # @return [ReleaseDatePrecisionEnum]
+    attr_accessor :release_date_precision
+
+    # Included in the response when a content restriction is applied.
+    # @return [AlbumRestrictionObject]
+    attr_accessor :restrictions
+
+    # The object type.
+    # @return [Type2Enum]
+    attr_accessor :type
+
+    # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for
+    # the album.
+    # @return [String]
+    attr_accessor :uri
+
+    # The artists of the album. Each artist object includes a link in `href` to
+    # more detailed information about the artist.
+    # @return [Array[SimplifiedArtistObject]]
+    attr_accessor :artists
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['album_type'] = 'album_type'
+      @_hash['total_tracks'] = 'total_tracks'
+      @_hash['available_markets'] = 'available_markets'
+      @_hash['external_urls'] = 'external_urls'
+      @_hash['href'] = 'href'
+      @_hash['id'] = 'id'
+      @_hash['images'] = 'images'
+      @_hash['name'] = 'name'
+      @_hash['release_date'] = 'release_date'
+      @_hash['release_date_precision'] = 'release_date_precision'
+      @_hash['restrictions'] = 'restrictions'
+      @_hash['type'] = 'type'
+      @_hash['uri'] = 'uri'
+      @_hash['artists'] = 'artists'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        restrictions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(album_type = nil, total_tracks = nil,
+                   available_markets = nil, external_urls = nil, href = nil,
+                   id = nil, images = nil, name = nil, release_date = nil,
+                   release_date_precision = nil, type = nil, uri = nil,
+                   artists = nil, restrictions = SKIP)
+      @album_type = album_type
+      @total_tracks = total_tracks
+      @available_markets = available_markets
+      @external_urls = external_urls
+      @href = href
+      @id = id
+      @images = images
+      @name = name
+      @release_date = release_date
+      @release_date_precision = release_date_precision
+      @restrictions = restrictions unless restrictions == SKIP
+      @type = type
+      @uri = uri
+      @artists = artists
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      album_type = hash.key?('album_type') ? hash['album_type'] : nil
+      total_tracks = hash.key?('total_tracks') ? hash['total_tracks'] : nil
+      available_markets =
+        hash.key?('available_markets') ? hash['available_markets'] : nil
+      external_urls = ExternalUrlObject.from_hash(hash['external_urls']) if hash['external_urls']
+      href = hash.key?('href') ? hash['href'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      # Parameter is an array, so we need to iterate through it
+      images = nil
+      unless hash['images'].nil?
+        images = []
+        hash['images'].each do |structure|
+          images << (ImageObject.from_hash(structure) if structure)
+        end
+      end
+
+      images = nil unless hash.key?('images')
+      name = hash.key?('name') ? hash['name'] : nil
+      release_date = hash.key?('release_date') ? hash['release_date'] : nil
+      release_date_precision =
+        hash.key?('release_date_precision') ? hash['release_date_precision'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      uri = hash.key?('uri') ? hash['uri'] : nil
+      # Parameter is an array, so we need to iterate through it
+      artists = nil
+      unless hash['artists'].nil?
+        artists = []
+        hash['artists'].each do |structure|
+          artists << (SimplifiedArtistObject.from_hash(structure) if structure)
+        end
+      end
+
+      artists = nil unless hash.key?('artists')
+      restrictions = AlbumRestrictionObject.from_hash(hash['restrictions']) if
+        hash['restrictions']
+
+      # Create object from extracted values.
+      SimplifiedAlbumObject.new(album_type,
+                                total_tracks,
+                                available_markets,
+                                external_urls,
+                                href,
+                                id,
+                                images,
+                                name,
+                                release_date,
+                                release_date_precision,
+                                type,
+                                uri,
+                                artists,
+                                restrictions)
+    end
+  end
+end

data/lib/spotify_web_api/models/simplified_artist_object.rb

@@ -0,0 +1,98 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # SimplifiedArtistObject Model.
+  class SimplifiedArtistObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Known external URLs for this artist.
+    # @return [ExternalUrlObject]
+    attr_accessor :external_urls
+
+    # A link to the Web API endpoint providing full details of the artist.
+    # @return [String]
+    attr_accessor :href
+
+    # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+    # artist.
+    # @return [String]
+    attr_accessor :id
+
+    # The name of the artist.
+    # @return [String]
+    attr_accessor :name
+
+    # The object type.
+    # @return [TypeEnum]
+    attr_accessor :type
+
+    # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for
+    # the artist.
+    # @return [String]
+    attr_accessor :uri
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['external_urls'] = 'external_urls'
+      @_hash['href'] = 'href'
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['type'] = 'type'
+      @_hash['uri'] = 'uri'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        external_urls
+        href
+        id
+        name
+        type
+        uri
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(external_urls = SKIP, href = SKIP, id = SKIP, name = SKIP,
+                   type = SKIP, uri = SKIP)
+      @external_urls = external_urls unless external_urls == SKIP
+      @href = href unless href == SKIP
+      @id = id unless id == SKIP
+      @name = name unless name == SKIP
+      @type = type unless type == SKIP
+      @uri = uri unless uri == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      external_urls = ExternalUrlObject.from_hash(hash['external_urls']) if hash['external_urls']
+      href = hash.key?('href') ? hash['href'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      uri = hash.key?('uri') ? hash['uri'] : SKIP
+
+      # Create object from extracted values.
+      SimplifiedArtistObject.new(external_urls,
+                                 href,
+                                 id,
+                                 name,
+                                 type,
+                                 uri)
+    end
+  end
+end

data/lib/spotify_web_api/models/simplified_playlist_object.rb

@@ -0,0 +1,184 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # SimplifiedPlaylistObject Model.
+  class SimplifiedPlaylistObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `true` if the owner allows other users to modify the playlist.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :collaborative
+
+    # The playlist description. _Only returned for modified, verified playlists,
+    # otherwise_ `null`.
+    # @return [String]
+    attr_accessor :description
+
+    # Known external URLs for this playlist.
+    # @return [ExternalUrlObject]
+    attr_accessor :external_urls
+
+    # A link to the Web API endpoint providing full details of the playlist.
+    # @return [String]
+    attr_accessor :href
+
+    # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+    # playlist.
+    # @return [String]
+    attr_accessor :id
+
+    # Images for the playlist. The array may be empty or contain up to three
+    # images. The images are returned by size in descending order. See [Working
+    # with Playlists](/documentation/web-api/concepts/playlists). _**Note**: If
+    # returned, the source URL for the image (`url`) is temporary and will
+    # expire in less than a day._
+    # @return [Array[ImageObject]]
+    attr_accessor :images
+
+    # The name of the playlist.
+    # @return [String]
+    attr_accessor :name
+
+    # The user who owns the playlist
+    # @return [PlaylistOwnerObject]
+    attr_accessor :owner
+
+    # The playlist's public/private status: `true` the playlist is public,
+    # `false` the playlist is private, `null` the playlist status is not
+    # relevant. For more about public/private status, see [Working with
+    # Playlists](/documentation/web-api/concepts/playlists)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :public
+
+    # The version identifier for the current playlist. Can be supplied in other
+    # requests to target a specific playlist version
+    # @return [String]
+    attr_accessor :snapshot_id
+
+    # A collection containing a link ( `href` ) to the Web API endpoint where
+    # full details of the playlist's tracks can be retrieved, along with the
+    # `total` number of tracks in the playlist. Note, a track object may be
+    # `null`. This can happen if a track is no longer available.
+    # @return [PlaylistTracksRefObject]
+    attr_accessor :tracks
+
+    # The object type: "playlist"
+    # @return [String]
+    attr_accessor :type
+
+    # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for
+    # the playlist.
+    # @return [String]
+    attr_accessor :uri
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['collaborative'] = 'collaborative'
+      @_hash['description'] = 'description'
+      @_hash['external_urls'] = 'external_urls'
+      @_hash['href'] = 'href'
+      @_hash['id'] = 'id'
+      @_hash['images'] = 'images'
+      @_hash['name'] = 'name'
+      @_hash['owner'] = 'owner'
+      @_hash['public'] = 'public'
+      @_hash['snapshot_id'] = 'snapshot_id'
+      @_hash['tracks'] = 'tracks'
+      @_hash['type'] = 'type'
+      @_hash['uri'] = 'uri'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        collaborative
+        description
+        external_urls
+        href
+        id
+        images
+        name
+        owner
+        public
+        snapshot_id
+        tracks
+        type
+        uri
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(collaborative = SKIP, description = SKIP,
+                   external_urls = SKIP, href = SKIP, id = SKIP, images = SKIP,
+                   name = SKIP, owner = SKIP, public = SKIP, snapshot_id = SKIP,
+                   tracks = SKIP, type = SKIP, uri = SKIP)
+      @collaborative = collaborative unless collaborative == SKIP
+      @description = description unless description == SKIP
+      @external_urls = external_urls unless external_urls == SKIP
+      @href = href unless href == SKIP
+      @id = id unless id == SKIP
+      @images = images unless images == SKIP
+      @name = name unless name == SKIP
+      @owner = owner unless owner == SKIP
+      @public = public unless public == SKIP
+      @snapshot_id = snapshot_id unless snapshot_id == SKIP
+      @tracks = tracks unless tracks == SKIP
+      @type = type unless type == SKIP
+      @uri = uri unless uri == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      collaborative = hash.key?('collaborative') ? hash['collaborative'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      external_urls = ExternalUrlObject.from_hash(hash['external_urls']) if hash['external_urls']
+      href = hash.key?('href') ? hash['href'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      images = nil
+      unless hash['images'].nil?
+        images = []
+        hash['images'].each do |structure|
+          images << (ImageObject.from_hash(structure) if structure)
+        end
+      end
+
+      images = SKIP unless hash.key?('images')
+      name = hash.key?('name') ? hash['name'] : SKIP
+      owner = PlaylistOwnerObject.from_hash(hash['owner']) if hash['owner']
+      public = hash.key?('public') ? hash['public'] : SKIP
+      snapshot_id = hash.key?('snapshot_id') ? hash['snapshot_id'] : SKIP
+      tracks = PlaylistTracksRefObject.from_hash(hash['tracks']) if hash['tracks']
+      type = hash.key?('type') ? hash['type'] : SKIP
+      uri = hash.key?('uri') ? hash['uri'] : SKIP
+
+      # Create object from extracted values.
+      SimplifiedPlaylistObject.new(collaborative,
+                                   description,
+                                   external_urls,
+                                   href,
+                                   id,
+                                   images,
+                                   name,
+                                   owner,
+                                   public,
+                                   snapshot_id,
+                                   tracks,
+                                   type,
+                                   uri)
+    end
+  end
+end