spotify-api-sdk 1.0.0

data/lib/spotify_web_api/models/paging_simplified_episode_object.rb

@@ -0,0 +1,110 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # PagingSimplifiedEpisodeObject Model.
+  class PagingSimplifiedEpisodeObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A link to the Web API endpoint returning the full result of the request
+    # @return [String]
+    attr_accessor :href
+
+    # The maximum number of items in the response (as set in the query or by
+    # default).
+    # @return [Integer]
+    attr_accessor :limit
+
+    # URL to the next page of items. ( `null` if none)
+    # @return [String]
+    attr_accessor :mnext
+
+    # The offset of the items returned (as set in the query or by default)
+    # @return [Integer]
+    attr_accessor :offset
+
+    # URL to the previous page of items. ( `null` if none)
+    # @return [String]
+    attr_accessor :previous
+
+    # The total number of items available to return.
+    # @return [Integer]
+    attr_accessor :total
+
+    # The total number of items available to return.
+    # @return [Array[EpisodeBase]]
+    attr_accessor :items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash['limit'] = 'limit'
+      @_hash['mnext'] = 'next'
+      @_hash['offset'] = 'offset'
+      @_hash['previous'] = 'previous'
+      @_hash['total'] = 'total'
+      @_hash['items'] = 'items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        mnext
+        previous
+      ]
+    end
+
+    def initialize(href = nil, limit = nil, mnext = nil, offset = nil,
+                   previous = nil, total = nil, items = nil)
+      @href = href
+      @limit = limit
+      @mnext = mnext
+      @offset = offset
+      @previous = previous
+      @total = total
+      @items = items
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      href = hash.key?('href') ? hash['href'] : nil
+      limit = hash.key?('limit') ? hash['limit'] : nil
+      mnext = hash.key?('next') ? hash['next'] : nil
+      offset = hash.key?('offset') ? hash['offset'] : nil
+      previous = hash.key?('previous') ? hash['previous'] : nil
+      total = hash.key?('total') ? hash['total'] : nil
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (EpisodeBase.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('items')
+
+      # Create object from extracted values.
+      PagingSimplifiedEpisodeObject.new(href,
+                                        limit,
+                                        mnext,
+                                        offset,
+                                        previous,
+                                        total,
+                                        items)
+    end
+  end
+end

data/lib/spotify_web_api/models/paging_simplified_show_object.rb

@@ -0,0 +1,110 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # PagingSimplifiedShowObject Model.
+  class PagingSimplifiedShowObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A link to the Web API endpoint returning the full result of the request
+    # @return [String]
+    attr_accessor :href
+
+    # The maximum number of items in the response (as set in the query or by
+    # default).
+    # @return [Integer]
+    attr_accessor :limit
+
+    # URL to the next page of items. ( `null` if none)
+    # @return [String]
+    attr_accessor :mnext
+
+    # The offset of the items returned (as set in the query or by default)
+    # @return [Integer]
+    attr_accessor :offset
+
+    # URL to the previous page of items. ( `null` if none)
+    # @return [String]
+    attr_accessor :previous
+
+    # The total number of items available to return.
+    # @return [Integer]
+    attr_accessor :total
+
+    # The total number of items available to return.
+    # @return [Array[ShowBase]]
+    attr_accessor :items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash['limit'] = 'limit'
+      @_hash['mnext'] = 'next'
+      @_hash['offset'] = 'offset'
+      @_hash['previous'] = 'previous'
+      @_hash['total'] = 'total'
+      @_hash['items'] = 'items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        mnext
+        previous
+      ]
+    end
+
+    def initialize(href = nil, limit = nil, mnext = nil, offset = nil,
+                   previous = nil, total = nil, items = nil)
+      @href = href
+      @limit = limit
+      @mnext = mnext
+      @offset = offset
+      @previous = previous
+      @total = total
+      @items = items
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      href = hash.key?('href') ? hash['href'] : nil
+      limit = hash.key?('limit') ? hash['limit'] : nil
+      mnext = hash.key?('next') ? hash['next'] : nil
+      offset = hash.key?('offset') ? hash['offset'] : nil
+      previous = hash.key?('previous') ? hash['previous'] : nil
+      total = hash.key?('total') ? hash['total'] : nil
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (ShowBase.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('items')
+
+      # Create object from extracted values.
+      PagingSimplifiedShowObject.new(href,
+                                     limit,
+                                     mnext,
+                                     offset,
+                                     previous,
+                                     total,
+                                     items)
+    end
+  end
+end

data/lib/spotify_web_api/models/paging_simplified_track_object.rb

@@ -0,0 +1,110 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # PagingSimplifiedTrackObject Model.
+  class PagingSimplifiedTrackObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A link to the Web API endpoint returning the full result of the request
+    # @return [String]
+    attr_accessor :href
+
+    # The maximum number of items in the response (as set in the query or by
+    # default).
+    # @return [Integer]
+    attr_accessor :limit
+
+    # URL to the next page of items. ( `null` if none)
+    # @return [String]
+    attr_accessor :mnext
+
+    # The offset of the items returned (as set in the query or by default)
+    # @return [Integer]
+    attr_accessor :offset
+
+    # URL to the previous page of items. ( `null` if none)
+    # @return [String]
+    attr_accessor :previous
+
+    # The total number of items available to return.
+    # @return [Integer]
+    attr_accessor :total
+
+    # The total number of items available to return.
+    # @return [Array[SimplifiedTrackObject]]
+    attr_accessor :items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash['limit'] = 'limit'
+      @_hash['mnext'] = 'next'
+      @_hash['offset'] = 'offset'
+      @_hash['previous'] = 'previous'
+      @_hash['total'] = 'total'
+      @_hash['items'] = 'items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        mnext
+        previous
+      ]
+    end
+
+    def initialize(href = nil, limit = nil, mnext = nil, offset = nil,
+                   previous = nil, total = nil, items = nil)
+      @href = href
+      @limit = limit
+      @mnext = mnext
+      @offset = offset
+      @previous = previous
+      @total = total
+      @items = items
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      href = hash.key?('href') ? hash['href'] : nil
+      limit = hash.key?('limit') ? hash['limit'] : nil
+      mnext = hash.key?('next') ? hash['next'] : nil
+      offset = hash.key?('offset') ? hash['offset'] : nil
+      previous = hash.key?('previous') ? hash['previous'] : nil
+      total = hash.key?('total') ? hash['total'] : nil
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (SimplifiedTrackObject.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('items')
+
+      # Create object from extracted values.
+      PagingSimplifiedTrackObject.new(href,
+                                      limit,
+                                      mnext,
+                                      offset,
+                                      previous,
+                                      total,
+                                      items)
+    end
+  end
+end

data/lib/spotify_web_api/models/paging_track_object.rb

@@ -0,0 +1,110 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # PagingTrackObject Model.
+  class PagingTrackObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A link to the Web API endpoint returning the full result of the request
+    # @return [String]
+    attr_accessor :href
+
+    # The maximum number of items in the response (as set in the query or by
+    # default).
+    # @return [Integer]
+    attr_accessor :limit
+
+    # URL to the next page of items. ( `null` if none)
+    # @return [String]
+    attr_accessor :mnext
+
+    # The offset of the items returned (as set in the query or by default)
+    # @return [Integer]
+    attr_accessor :offset
+
+    # URL to the previous page of items. ( `null` if none)
+    # @return [String]
+    attr_accessor :previous
+
+    # The total number of items available to return.
+    # @return [Integer]
+    attr_accessor :total
+
+    # The total number of items available to return.
+    # @return [Array[TrackObject]]
+    attr_accessor :items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash['limit'] = 'limit'
+      @_hash['mnext'] = 'next'
+      @_hash['offset'] = 'offset'
+      @_hash['previous'] = 'previous'
+      @_hash['total'] = 'total'
+      @_hash['items'] = 'items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        mnext
+        previous
+      ]
+    end
+
+    def initialize(href = nil, limit = nil, mnext = nil, offset = nil,
+                   previous = nil, total = nil, items = nil)
+      @href = href
+      @limit = limit
+      @mnext = mnext
+      @offset = offset
+      @previous = previous
+      @total = total
+      @items = items
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      href = hash.key?('href') ? hash['href'] : nil
+      limit = hash.key?('limit') ? hash['limit'] : nil
+      mnext = hash.key?('next') ? hash['next'] : nil
+      offset = hash.key?('offset') ? hash['offset'] : nil
+      previous = hash.key?('previous') ? hash['previous'] : nil
+      total = hash.key?('total') ? hash['total'] : nil
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (TrackObject.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('items')
+
+      # Create object from extracted values.
+      PagingTrackObject.new(href,
+                            limit,
+                            mnext,
+                            offset,
+                            previous,
+                            total,
+                            items)
+    end
+  end
+end

data/lib/spotify_web_api/models/play_history_object.rb

@@ -0,0 +1,77 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module SpotifyWebApi
+  # PlayHistoryObject Model.
+  class PlayHistoryObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The track the user listened to.
+    # @return [TrackObject]
+    attr_accessor :track
+
+    # The date and time the track was played.
+    # @return [DateTime]
+    attr_accessor :played_at
+
+    # The context the track was played from.
+    # @return [ContextObject]
+    attr_accessor :context
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['track'] = 'track'
+      @_hash['played_at'] = 'played_at'
+      @_hash['context'] = 'context'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        track
+        played_at
+        context
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(track = SKIP, played_at = SKIP, context = SKIP)
+      @track = track unless track == SKIP
+      @played_at = played_at unless played_at == SKIP
+      @context = context unless context == 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.
+      track = TrackObject.from_hash(hash['track']) if hash['track']
+      played_at = if hash.key?('played_at')
+                    (DateTimeHelper.from_rfc3339(hash['played_at']) if hash['played_at'])
+                  else
+                    SKIP
+                  end
+      context = ContextObject.from_hash(hash['context']) if hash['context']
+
+      # Create object from extracted values.
+      PlayHistoryObject.new(track,
+                            played_at,
+                            context)
+    end
+
+    def to_custom_played_at
+      DateTimeHelper.to_rfc3339(played_at)
+    end
+  end
+end

data/lib/spotify_web_api/models/playlist_object.rb

@@ -0,0 +1,193 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # PlaylistObject Model.
+  class PlaylistObject < 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
+
+    # Information about the followers of the playlist.
+    # @return [FollowersObject]
+    attr_accessor :followers
+
+    # 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
+
+    # The tracks of the playlist.
+    # @return [PagingPlaylistTrackObject]
+    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['followers'] = 'followers'
+      @_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
+        followers
+        href
+        id
+        images
+        name
+        owner
+        public
+        snapshot_id
+        tracks
+        type
+        uri
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+      ]
+    end
+
+    def initialize(collaborative = SKIP, description = SKIP,
+                   external_urls = SKIP, followers = 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
+      @followers = followers unless followers == 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']
+      followers = FollowersObject.from_hash(hash['followers']) if hash['followers']
+      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 = PagingPlaylistTrackObject.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.
+      PlaylistObject.new(collaborative,
+                         description,
+                         external_urls,
+                         followers,
+                         href,
+                         id,
+                         images,
+                         name,
+                         owner,
+                         public,
+                         snapshot_id,
+                         tracks,
+                         type,
+                         uri)
+    end
+  end
+end