spotify-api-sdk 1.0.0

data/lib/spotify_web_api/models/playlist_owner_object.rb

@@ -0,0 +1,109 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # PlaylistOwnerObject Model.
+  class PlaylistOwnerObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Known public external URLs for this user.
+    # @return [ExternalUrlObject]
+    attr_accessor :external_urls
+
+    # Information about the followers of this user.
+    # @return [FollowersObject]
+    attr_accessor :followers
+
+    # A link to the Web API endpoint for this user.
+    # @return [String]
+    attr_accessor :href
+
+    # The [Spotify user ID](/documentation/web-api/concepts/spotify-uris-ids)
+    # for this user.
+    # @return [String]
+    attr_accessor :id
+
+    # The object type.
+    # @return [Type4Enum]
+    attr_accessor :type
+
+    # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for
+    # this user.
+    # @return [String]
+    attr_accessor :uri
+
+    # The name displayed on the user's profile. `null` if not available.
+    # @return [String]
+    attr_accessor :display_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['external_urls'] = 'external_urls'
+      @_hash['followers'] = 'followers'
+      @_hash['href'] = 'href'
+      @_hash['id'] = 'id'
+      @_hash['type'] = 'type'
+      @_hash['uri'] = 'uri'
+      @_hash['display_name'] = 'display_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        external_urls
+        followers
+        href
+        id
+        type
+        uri
+        display_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        display_name
+      ]
+    end
+
+    def initialize(external_urls = SKIP, followers = SKIP, href = SKIP,
+                   id = SKIP, type = SKIP, uri = SKIP, display_name = SKIP)
+      @external_urls = external_urls unless external_urls == SKIP
+      @followers = followers unless followers == SKIP
+      @href = href unless href == SKIP
+      @id = id unless id == SKIP
+      @type = type unless type == SKIP
+      @uri = uri unless uri == SKIP
+      @display_name = display_name unless display_name == 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']
+      followers = FollowersObject.from_hash(hash['followers']) if hash['followers']
+      href = hash.key?('href') ? hash['href'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      uri = hash.key?('uri') ? hash['uri'] : SKIP
+      display_name = hash.key?('display_name') ? hash['display_name'] : SKIP
+
+      # Create object from extracted values.
+      PlaylistOwnerObject.new(external_urls,
+                              followers,
+                              href,
+                              id,
+                              type,
+                              uri,
+                              display_name)
+    end
+  end
+end

data/lib/spotify_web_api/models/playlist_snapshot_id.rb

@@ -0,0 +1,50 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # PlaylistSnapshotId Model.
+  class PlaylistSnapshotId < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :snapshot_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['snapshot_id'] = 'snapshot_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        snapshot_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(snapshot_id = SKIP)
+      @snapshot_id = snapshot_id unless snapshot_id == 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.
+      snapshot_id = hash.key?('snapshot_id') ? hash['snapshot_id'] : SKIP
+
+      # Create object from extracted values.
+      PlaylistSnapshotId.new(snapshot_id)
+    end
+  end
+end

data/lib/spotify_web_api/models/playlist_track_object.rb

@@ -0,0 +1,90 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module SpotifyWebApi
+  # PlaylistTrackObject Model.
+  class PlaylistTrackObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The date and time the track or episode was added. _**Note**: some very old
+    # playlists may return `null` in this field._
+    # @return [DateTime]
+    attr_accessor :added_at
+
+    # The Spotify user who added the track or episode. _**Note**: some very old
+    # playlists may return `null` in this field._
+    # @return [PlaylistUserObject]
+    attr_accessor :added_by
+
+    # Whether this track or episode is a [local
+    # file](/documentation/web-api/concepts/playlists/#local-files) or not.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_local
+
+    # Information about the track or episode.
+    # @return [Object]
+    attr_accessor :track
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['added_at'] = 'added_at'
+      @_hash['added_by'] = 'added_by'
+      @_hash['is_local'] = 'is_local'
+      @_hash['track'] = 'track'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        added_at
+        added_by
+        is_local
+        track
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(added_at = SKIP, added_by = SKIP, is_local = SKIP,
+                   track = SKIP)
+      @added_at = added_at unless added_at == SKIP
+      @added_by = added_by unless added_by == SKIP
+      @is_local = is_local unless is_local == SKIP
+      @track = track unless track == 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.
+      added_at = if hash.key?('added_at')
+                   (DateTimeHelper.from_rfc3339(hash['added_at']) if hash['added_at'])
+                 else
+                   SKIP
+                 end
+      added_by = PlaylistUserObject.from_hash(hash['added_by']) if hash['added_by']
+      is_local = hash.key?('is_local') ? hash['is_local'] : SKIP
+      track = hash.key?('track') ? hash['track'] : SKIP
+
+      # Create object from extracted values.
+      PlaylistTrackObject.new(added_at,
+                              added_by,
+                              is_local,
+                              track)
+    end
+
+    def to_custom_added_at
+      DateTimeHelper.to_rfc3339(added_at)
+    end
+  end
+end

data/lib/spotify_web_api/models/playlist_tracks_ref_object.rb

@@ -0,0 +1,60 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # PlaylistTracksRefObject Model.
+  class PlaylistTracksRefObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A link to the Web API endpoint where full details of the playlist's tracks
+    # can be retrieved.
+    # @return [String]
+    attr_accessor :href
+
+    # Number of tracks in the playlist.
+    # @return [Integer]
+    attr_accessor :total
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash['total'] = 'total'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        href
+        total
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(href = SKIP, total = SKIP)
+      @href = href unless href == SKIP
+      @total = total unless total == 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.
+      href = hash.key?('href') ? hash['href'] : SKIP
+      total = hash.key?('total') ? hash['total'] : SKIP
+
+      # Create object from extracted values.
+      PlaylistTracksRefObject.new(href,
+                                  total)
+    end
+  end
+end

data/lib/spotify_web_api/models/playlist_user_object.rb

@@ -0,0 +1,98 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # PlaylistUserObject Model.
+  class PlaylistUserObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Known public external URLs for this user.
+    # @return [ExternalUrlObject]
+    attr_accessor :external_urls
+
+    # Information about the followers of this user.
+    # @return [FollowersObject]
+    attr_accessor :followers
+
+    # A link to the Web API endpoint for this user.
+    # @return [String]
+    attr_accessor :href
+
+    # The [Spotify user ID](/documentation/web-api/concepts/spotify-uris-ids)
+    # for this user.
+    # @return [String]
+    attr_accessor :id
+
+    # The object type.
+    # @return [Type4Enum]
+    attr_accessor :type
+
+    # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for
+    # this user.
+    # @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['followers'] = 'followers'
+      @_hash['href'] = 'href'
+      @_hash['id'] = 'id'
+      @_hash['type'] = 'type'
+      @_hash['uri'] = 'uri'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        external_urls
+        followers
+        href
+        id
+        type
+        uri
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(external_urls = SKIP, followers = SKIP, href = SKIP,
+                   id = SKIP, type = SKIP, uri = SKIP)
+      @external_urls = external_urls unless external_urls == SKIP
+      @followers = followers unless followers == SKIP
+      @href = href unless href == SKIP
+      @id = id unless id == 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']
+      followers = FollowersObject.from_hash(hash['followers']) if hash['followers']
+      href = hash.key?('href') ? hash['href'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      uri = hash.key?('uri') ? hash['uri'] : SKIP
+
+      # Create object from extracted values.
+      PlaylistUserObject.new(external_urls,
+                             followers,
+                             href,
+                             id,
+                             type,
+                             uri)
+    end
+  end
+end

data/lib/spotify_web_api/models/playlists_followers_request.rb

@@ -0,0 +1,51 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # PlaylistsFollowersRequest Model.
+  class PlaylistsFollowersRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Defaults to `true`. If `true` the playlist will be included in user's
+    # public playlists, if `false` it will remain private.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :public
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['public'] = 'public'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        public
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(public = SKIP)
+      @public = public unless public == 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.
+      public = hash.key?('public') ? hash['public'] : SKIP
+
+      # Create object from extracted values.
+      PlaylistsFollowersRequest.new(public)
+    end
+  end
+end

data/lib/spotify_web_api/models/playlists_request.rb

@@ -0,0 +1,82 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # PlaylistsRequest Model.
+  class PlaylistsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The new name for the playlist, for example `"My New Playlist Title"`
+    # @return [String]
+    attr_accessor :name
+
+    # If `true` the playlist will be public, if `false` it will be private.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :public
+
+    # If `true`, the playlist will become collaborative and other users will be
+    # able to modify the playlist in their Spotify client. <br/>
+    # _**Note**: You can only set `collaborative` to `true` on non-public
+    # playlists._
+    # @return [TrueClass | FalseClass]
+    attr_accessor :collaborative
+
+    # Value for playlist description as displayed in Spotify Clients and in the
+    # Web API.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['public'] = 'public'
+      @_hash['collaborative'] = 'collaborative'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        public
+        collaborative
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP, public = SKIP, collaborative = SKIP,
+                   description = SKIP)
+      @name = name unless name == SKIP
+      @public = public unless public == SKIP
+      @collaborative = collaborative unless collaborative == SKIP
+      @description = description unless description == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      public = hash.key?('public') ? hash['public'] : SKIP
+      collaborative = hash.key?('collaborative') ? hash['collaborative'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+
+      # Create object from extracted values.
+      PlaylistsRequest.new(name,
+                           public,
+                           collaborative,
+                           description)
+    end
+  end
+end

data/lib/spotify_web_api/models/playlists_tracks_request.rb

@@ -0,0 +1,72 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # PlaylistsTracksRequest Model.
+  class PlaylistsTracksRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A JSON array of the [Spotify
+    # URIs](/documentation/web-api/concepts/spotify-uris-ids) to add. For
+    # example: `{"uris":
+    # ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh","spotify:track:1301WleyT98MSxVHPZC
+    # A6M", "spotify:episode:512ojhOuo1ktJprKbVcKyQ"]}`<br/>A maximum of 100
+    # items can be added in one request. _**Note**: if the `uris` parameter is
+    # present in the query string, any URIs listed here in the body will be
+    # ignored._
+    # @return [Array[String]]
+    attr_accessor :uris
+
+    # The position to insert the items, a zero-based index. For example, to
+    # insert the items in the first position: `position=0` ; to insert the items
+    # in the third position: `position=2`. If omitted, the items will be
+    # appended to the playlist. Items are added in the order they appear in the
+    # uris array. For example: `{"uris":
+    # ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh","spotify:track:1301WleyT98MSxVHPZC
+    # A6M"], "position": 3}`
+    # @return [Integer]
+    attr_accessor :position
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uris'] = 'uris'
+      @_hash['position'] = 'position'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uris
+        position
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uris = SKIP, position = SKIP)
+      @uris = uris unless uris == SKIP
+      @position = position unless position == 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.
+      uris = hash.key?('uris') ? hash['uris'] : SKIP
+      position = hash.key?('position') ? hash['position'] : SKIP
+
+      # Create object from extracted values.
+      PlaylistsTracksRequest.new(uris,
+                                 position)
+    end
+  end
+end