spotify-api-sdk 1.0.0

data/lib/spotify_web_api/models/meta.rb

@@ -0,0 +1,110 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # Meta Model.
+  class Meta < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The version of the Analyzer used to analyze this track.
+    # @return [String]
+    attr_accessor :analyzer_version
+
+    # The platform used to read the track's audio data.
+    # @return [String]
+    attr_accessor :platform
+
+    # A detailed status code for this track. If analysis data is missing, this
+    # code may explain why.
+    # @return [String]
+    attr_accessor :detailed_status
+
+    # The return code of the analyzer process. 0 if successful, 1 if any errors
+    # occurred.
+    # @return [Integer]
+    attr_accessor :status_code
+
+    # The Unix timestamp (in seconds) at which this track was analyzed.
+    # @return [Integer]
+    attr_accessor :timestamp
+
+    # The amount of time taken to analyze this track.
+    # @return [Float]
+    attr_accessor :analysis_time
+
+    # The method used to read the track's audio data.
+    # @return [String]
+    attr_accessor :input_process
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['analyzer_version'] = 'analyzer_version'
+      @_hash['platform'] = 'platform'
+      @_hash['detailed_status'] = 'detailed_status'
+      @_hash['status_code'] = 'status_code'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['analysis_time'] = 'analysis_time'
+      @_hash['input_process'] = 'input_process'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        analyzer_version
+        platform
+        detailed_status
+        status_code
+        timestamp
+        analysis_time
+        input_process
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(analyzer_version = SKIP, platform = SKIP,
+                   detailed_status = SKIP, status_code = SKIP, timestamp = SKIP,
+                   analysis_time = SKIP, input_process = SKIP)
+      @analyzer_version = analyzer_version unless analyzer_version == SKIP
+      @platform = platform unless platform == SKIP
+      @detailed_status = detailed_status unless detailed_status == SKIP
+      @status_code = status_code unless status_code == SKIP
+      @timestamp = timestamp unless timestamp == SKIP
+      @analysis_time = analysis_time unless analysis_time == SKIP
+      @input_process = input_process unless input_process == 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.
+      analyzer_version =
+        hash.key?('analyzer_version') ? hash['analyzer_version'] : SKIP
+      platform = hash.key?('platform') ? hash['platform'] : SKIP
+      detailed_status =
+        hash.key?('detailed_status') ? hash['detailed_status'] : SKIP
+      status_code = hash.key?('status_code') ? hash['status_code'] : SKIP
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
+      analysis_time = hash.key?('analysis_time') ? hash['analysis_time'] : SKIP
+      input_process = hash.key?('input_process') ? hash['input_process'] : SKIP
+
+      # Create object from extracted values.
+      Meta.new(analyzer_version,
+               platform,
+               detailed_status,
+               status_code,
+               timestamp,
+               analysis_time,
+               input_process)
+    end
+  end
+end

data/lib/spotify_web_api/models/mode_enum.rb

@@ -0,0 +1,30 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # Indicates the modality (major or minor) of a section, the type of scale from
+  # which its melodic content is derived. This field will contain a 0 for
+  # "minor", a 1 for "major", or a -1 for no result. Note that the major key
+  # (e.g. C major) could more likely be confused with the minor key at 3
+  # semitones lower (e.g. A minor) as both keys carry the same pitches.
+  class ModeEnum
+    MODE_ENUM = [
+      # TODO: Write general description for ENUM_MINUS1
+      ENUM_MINUS1 = -1,
+
+      # TODO: Write general description for ENUM_0
+      ENUM_0 = 0,
+
+      # TODO: Write general description for ENUM_1
+      ENUM_1 = 1
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MODE_ENUM.include?(value)
+    end
+  end
+end

data/lib/spotify_web_api/models/narrator_object.rb

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

data/lib/spotify_web_api/models/o_auth_provider_error_enum.rb

@@ -0,0 +1,45 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # OAuth 2 Authorization error codes
+  class OAuthProviderErrorEnum
+    O_AUTH_PROVIDER_ERROR_ENUM = [
+      # The request is missing a required parameter, includes an unsupported
+      # parameter value (other than grant type), repeats a parameter, includes
+      # multiple credentials, utilizes more than one mechanism for
+      # authenticating the client, or is otherwise malformed.
+      INVALID_REQUEST = 'invalid_request'.freeze,
+
+      # Client authentication failed (e.g., unknown client, no client
+      # authentication included, or unsupported authentication method).
+      INVALID_CLIENT = 'invalid_client'.freeze,
+
+      # The provided authorization grant (e.g., authorization code, resource
+      # owner credentials) or refresh token is invalid, expired, revoked, does
+      # not match the redirection URI used in the authorization request, or was
+      # issued to another client.
+      INVALID_GRANT = 'invalid_grant'.freeze,
+
+      # The authenticated client is not authorized to use this authorization
+      # grant type.
+      UNAUTHORIZED_CLIENT = 'unauthorized_client'.freeze,
+
+      # The authorization grant type is not supported by the authorization
+      # server.
+      UNSUPPORTED_GRANT_TYPE = 'unsupported_grant_type'.freeze,
+
+      # The requested scope is invalid, unknown, malformed, or exceeds the scope
+      # granted by the resource owner.
+      INVALID_SCOPE = 'invalid_scope'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      O_AUTH_PROVIDER_ERROR_ENUM.include?(value)
+    end
+  end
+end

data/lib/spotify_web_api/models/o_auth_scope_enum.rb

@@ -0,0 +1,94 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # OAuth 2 scopes supported by the API
+  class OAuthScopeEnum
+    O_AUTH_SCOPE_ENUM = [
+      # Communicate with the Spotify app on your device.
+
+      APP_REMOTE_CONTROL = 'app-remote-control'.freeze,
+
+      # Access your private playlists.
+
+      PLAYLIST_READ_PRIVATE = 'playlist-read-private'.freeze,
+
+      # Access your collaborative playlists.
+
+      PLAYLIST_READ_COLLABORATIVE = 'playlist-read-collaborative'.freeze,
+
+      # Manage your public playlists.
+
+      PLAYLIST_MODIFY_PUBLIC = 'playlist-modify-public'.freeze,
+
+      # Manage your private playlists.
+
+      PLAYLIST_MODIFY_PRIVATE = 'playlist-modify-private'.freeze,
+
+      # Access your saved content.
+
+      USER_LIBRARY_READ = 'user-library-read'.freeze,
+
+      # Manage your saved content.
+
+      USER_LIBRARY_MODIFY = 'user-library-modify'.freeze,
+
+      # Access your subscription details.
+
+      USER_READ_PRIVATE = 'user-read-private'.freeze,
+
+      # Get your real email address.
+
+      USER_READ_EMAIL = 'user-read-email'.freeze,
+
+      # Access your followers and who you are following.
+
+      USER_FOLLOW_READ = 'user-follow-read'.freeze,
+
+      # Manage your saved content.
+
+      USER_FOLLOW_MODIFY = 'user-follow-modify'.freeze,
+
+      # Read your top artists and content.
+
+      USER_TOP_READ = 'user-top-read'.freeze,
+
+      # Read your position in content you have played.
+
+      USER_READ_PLAYBACK_POSITION = 'user-read-playback-position'.freeze,
+
+      # Read your currently playing content and Spotify Connect devices
+      # information.
+
+      USER_READ_PLAYBACK_STATE = 'user-read-playback-state'.freeze,
+
+      # Access your recently played items.
+
+      USER_READ_RECENTLY_PLAYED = 'user-read-recently-played'.freeze,
+
+      # Read your currently playing content.
+
+      USER_READ_CURRENTLY_PLAYING = 'user-read-currently-playing'.freeze,
+
+      # Control playback on your Spotify clients and Spotify Connect devices.
+
+      USER_MODIFY_PLAYBACK_STATE = 'user-modify-playback-state'.freeze,
+
+      # Upload images to Spotify on your behalf.
+
+      UGC_IMAGE_UPLOAD = 'ugc-image-upload'.freeze,
+
+      # Play content and control playback on your other devices.
+
+      STREAMING = 'streaming'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      O_AUTH_SCOPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/spotify_web_api/models/o_auth_token.rb

@@ -0,0 +1,96 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # OAuth 2 Authorization endpoint response
+  class OAuthToken < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Access token
+    # @return [String]
+    attr_accessor :access_token
+
+    # Type of access token
+    # @return [String]
+    attr_accessor :token_type
+
+    # Time in seconds before the access token expires
+    # @return [Integer]
+    attr_accessor :expires_in
+
+    # List of scopes granted
+    # This is a space-delimited list of strings.
+    # @return [String]
+    attr_accessor :scope
+
+    # Time of token expiry as unix timestamp (UTC)
+    # @return [Integer]
+    attr_accessor :expiry
+
+    # Refresh token
+    # Used to get a new access token when it expires.
+    # @return [String]
+    attr_accessor :refresh_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['access_token'] = 'access_token'
+      @_hash['token_type'] = 'token_type'
+      @_hash['expires_in'] = 'expires_in'
+      @_hash['scope'] = 'scope'
+      @_hash['expiry'] = 'expiry'
+      @_hash['refresh_token'] = 'refresh_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        expires_in
+        scope
+        expiry
+        refresh_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token = nil, token_type = nil, expires_in = SKIP,
+                   scope = SKIP, expiry = SKIP, refresh_token = SKIP)
+      @access_token = access_token
+      @token_type = token_type
+      @expires_in = expires_in unless expires_in == SKIP
+      @scope = scope unless scope == SKIP
+      @expiry = expiry unless expiry == SKIP
+      @refresh_token = refresh_token unless refresh_token == 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.
+      access_token = hash.key?('access_token') ? hash['access_token'] : nil
+      token_type = hash.key?('token_type') ? hash['token_type'] : nil
+      expires_in = hash.key?('expires_in') ? hash['expires_in'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : SKIP
+      expiry = hash.key?('expiry') ? hash['expiry'] : SKIP
+      refresh_token = hash.key?('refresh_token') ? hash['refresh_token'] : SKIP
+
+      # Create object from extracted values.
+      OAuthToken.new(access_token,
+                     token_type,
+                     expires_in,
+                     scope,
+                     expiry,
+                     refresh_token)
+    end
+  end
+end

data/lib/spotify_web_api/models/paged_albums.rb

@@ -0,0 +1,48 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # PagedAlbums Model.
+  class PagedAlbums < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [PagingSimplifiedAlbumObject]
+    attr_accessor :albums
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['albums'] = 'albums'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(albums = nil)
+      @albums = albums
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      albums = PagingSimplifiedAlbumObject.from_hash(hash['albums']) if hash['albums']
+
+      # Create object from extracted values.
+      PagedAlbums.new(albums)
+    end
+  end
+end

data/lib/spotify_web_api/models/paged_categories.rb

@@ -0,0 +1,48 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # PagedCategories Model.
+  class PagedCategories < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Categories]
+    attr_accessor :categories
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['categories'] = 'categories'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(categories = nil)
+      @categories = categories
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      categories = Categories.from_hash(hash['categories']) if hash['categories']
+
+      # Create object from extracted values.
+      PagedCategories.new(categories)
+    end
+  end
+end

data/lib/spotify_web_api/models/paging_artist_discography_album_object.rb

@@ -0,0 +1,110 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # PagingArtistDiscographyAlbumObject Model.
+  class PagingArtistDiscographyAlbumObject < 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[ArtistDiscographyAlbumObject]]
+    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 << (ArtistDiscographyAlbumObject.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('items')
+
+      # Create object from extracted values.
+      PagingArtistDiscographyAlbumObject.new(href,
+                                             limit,
+                                             mnext,
+                                             offset,
+                                             previous,
+                                             total,
+                                             items)
+    end
+  end
+end