spotify-api-sdk 1.0.0

data/lib/spotify_web_api/models/episode_object.rb

@@ -0,0 +1,246 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # EpisodeObject Model.
+  class EpisodeObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A URL to a 30 second preview (MP3 format) of the episode. `null` if not
+    # available.
+    # @return [String]
+    attr_accessor :audio_preview_url
+
+    # A description of the episode. 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 episode. This field may contain HTML tags.
+    # @return [String]
+    attr_accessor :html_description
+
+    # The episode length in milliseconds.
+    # @return [Integer]
+    attr_accessor :duration_ms
+
+    # Whether or not the episode has explicit content (true = yes it does; false
+    # = no it does not OR unknown).
+    # @return [TrueClass | FalseClass]
+    attr_accessor :explicit
+
+    # External URLs for this episode.
+    # @return [ExternalUrlObject]
+    attr_accessor :external_urls
+
+    # A link to the Web API endpoint providing full details of the episode.
+    # @return [String]
+    attr_accessor :href
+
+    # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+    # episode.
+    # @return [String]
+    attr_accessor :id
+
+    # The cover art for the episode in various sizes, widest first.
+    # @return [Array[ImageObject]]
+    attr_accessor :images
+
+    # True if the episode is hosted outside of Spotify's CDN.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_externally_hosted
+
+    # True if the episode is playable in the given market. Otherwise false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_playable
+
+    # The language used in the episode, identified by a [ISO
+    # 639](https://en.wikipedia.org/wiki/ISO_639) code. This field is deprecated
+    # and might be removed in the future. Please use the `languages` field
+    # instead.
+    # @return [String]
+    attr_accessor :language
+
+    # A list of the languages used in the episode, identified by their [ISO
+    # 639-1](https://en.wikipedia.org/wiki/ISO_639) code.
+    # @return [Array[String]]
+    attr_accessor :languages
+
+    # The name of the episode.
+    # @return [String]
+    attr_accessor :name
+
+    # The date the episode was first released, for example `"1981-12-15"`.
+    # Depending on the precision, it might be shown as `"1981"` or `"1981-12"`.
+    # @return [String]
+    attr_accessor :release_date
+
+    # The precision with which `release_date` value is known.
+    # @return [ReleaseDatePrecisionEnum]
+    attr_accessor :release_date_precision
+
+    # The user's most recent position in the episode. Set if the supplied access
+    # token is a user token and has the scope 'user-read-playback-position'.
+    # @return [ResumePointObject]
+    attr_accessor :resume_point
+
+    # The object type.
+    # @return [Type8Enum]
+    attr_accessor :type
+
+    # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for
+    # the episode.
+    # @return [String]
+    attr_accessor :uri
+
+    # Included in the response when a content restriction is applied.
+    # @return [EpisodeRestrictionObject]
+    attr_accessor :restrictions
+
+    # The show on which the episode belongs.
+    # @return [ShowBase]
+    attr_accessor :show
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['audio_preview_url'] = 'audio_preview_url'
+      @_hash['description'] = 'description'
+      @_hash['html_description'] = 'html_description'
+      @_hash['duration_ms'] = 'duration_ms'
+      @_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['is_playable'] = 'is_playable'
+      @_hash['language'] = 'language'
+      @_hash['languages'] = 'languages'
+      @_hash['name'] = 'name'
+      @_hash['release_date'] = 'release_date'
+      @_hash['release_date_precision'] = 'release_date_precision'
+      @_hash['resume_point'] = 'resume_point'
+      @_hash['type'] = 'type'
+      @_hash['uri'] = 'uri'
+      @_hash['restrictions'] = 'restrictions'
+      @_hash['show'] = 'show'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        language
+        resume_point
+        restrictions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        audio_preview_url
+      ]
+    end
+
+    def initialize(audio_preview_url = nil, description = nil,
+                   html_description = nil, duration_ms = nil, explicit = nil,
+                   external_urls = nil, href = nil, id = nil, images = nil,
+                   is_externally_hosted = nil, is_playable = nil,
+                   languages = nil, name = nil, release_date = nil,
+                   release_date_precision = nil, type = nil, uri = nil,
+                   show = nil, language = SKIP, resume_point = SKIP,
+                   restrictions = SKIP)
+      @audio_preview_url = audio_preview_url
+      @description = description
+      @html_description = html_description
+      @duration_ms = duration_ms
+      @explicit = explicit
+      @external_urls = external_urls
+      @href = href
+      @id = id
+      @images = images
+      @is_externally_hosted = is_externally_hosted
+      @is_playable = is_playable
+      @language = language unless language == SKIP
+      @languages = languages
+      @name = name
+      @release_date = release_date
+      @release_date_precision = release_date_precision
+      @resume_point = resume_point unless resume_point == SKIP
+      @type = type
+      @uri = uri
+      @restrictions = restrictions unless restrictions == SKIP
+      @show = show
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      audio_preview_url =
+        hash.key?('audio_preview_url') ? hash['audio_preview_url'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      html_description =
+        hash.key?('html_description') ? hash['html_description'] : nil
+      duration_ms = hash.key?('duration_ms') ? hash['duration_ms'] : 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
+      is_playable = hash.key?('is_playable') ? hash['is_playable'] : nil
+      languages = hash.key?('languages') ? hash['languages'] : nil
+      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
+      show = ShowBase.from_hash(hash['show']) if hash['show']
+      language = hash.key?('language') ? hash['language'] : SKIP
+      resume_point = ResumePointObject.from_hash(hash['resume_point']) if hash['resume_point']
+      restrictions = EpisodeRestrictionObject.from_hash(hash['restrictions']) if
+        hash['restrictions']
+
+      # Create object from extracted values.
+      EpisodeObject.new(audio_preview_url,
+                        description,
+                        html_description,
+                        duration_ms,
+                        explicit,
+                        external_urls,
+                        href,
+                        id,
+                        images,
+                        is_externally_hosted,
+                        is_playable,
+                        languages,
+                        name,
+                        release_date,
+                        release_date_precision,
+                        type,
+                        uri,
+                        show,
+                        language,
+                        resume_point,
+                        restrictions)
+    end
+  end
+end

data/lib/spotify_web_api/models/episode_restriction_object.rb

@@ -0,0 +1,58 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # EpisodeRestrictionObject Model.
+  class EpisodeRestrictionObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The reason for the restriction. Supported values:
+    # - `market` - The content item is not available in the given market.
+    # - `product` - The content item is not available for the user's
+    # subscription type.
+    # - `explicit` - The content item is explicit and the user's account is set
+    # to not play explicit content.
+    # Additional reasons may be added in the future.
+    # **Note**: If you use this field, make sure that your application safely
+    # handles unknown values.
+    # @return [String]
+    attr_accessor :reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reason'] = 'reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reason = SKIP)
+      @reason = reason unless reason == 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.
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+
+      # Create object from extracted values.
+      EpisodeRestrictionObject.new(reason)
+    end
+  end
+end

data/lib/spotify_web_api/models/error_object.rb

@@ -0,0 +1,59 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # ErrorObject Model.
+  class ErrorObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The HTTP status code (also returned in the response header; see [Response
+    # Status
+    # Codes](/documentation/web-api/concepts/api-calls#response-status-codes)
+    # for more information).
+    # @return [Integer]
+    attr_accessor :status
+
+    # A short description of the cause of the error.
+    # @return [String]
+    attr_accessor :message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['message'] = 'message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status = nil, message = nil)
+      @status = status
+      @message = message
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      status = hash.key?('status') ? hash['status'] : nil
+      message = hash.key?('message') ? hash['message'] : nil
+
+      # Create object from extracted values.
+      ErrorObject.new(status,
+                      message)
+    end
+  end
+end

data/lib/spotify_web_api/models/explicit_content_settings_object.rb

@@ -0,0 +1,61 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # ExplicitContentSettingsObject Model.
+  class ExplicitContentSettingsObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When `true`, indicates that explicit content should not be played.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :filter_enabled
+
+    # When `true`, indicates that the explicit content setting is locked and
+    # can't be changed by the user.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :filter_locked
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['filter_enabled'] = 'filter_enabled'
+      @_hash['filter_locked'] = 'filter_locked'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        filter_enabled
+        filter_locked
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(filter_enabled = SKIP, filter_locked = SKIP)
+      @filter_enabled = filter_enabled unless filter_enabled == SKIP
+      @filter_locked = filter_locked unless filter_locked == 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.
+      filter_enabled =
+        hash.key?('filter_enabled') ? hash['filter_enabled'] : SKIP
+      filter_locked = hash.key?('filter_locked') ? hash['filter_locked'] : SKIP
+
+      # Create object from extracted values.
+      ExplicitContentSettingsObject.new(filter_enabled,
+                                        filter_locked)
+    end
+  end
+end

data/lib/spotify_web_api/models/external_id_object.rb

@@ -0,0 +1,72 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # ExternalIdObject Model.
+  class ExternalIdObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # [International Standard Recording
+    # Code](http://en.wikipedia.org/wiki/International_Standard_Recording_Code)
+    # @return [String]
+    attr_accessor :isrc
+
+    # [International Article
+    # Number](http://en.wikipedia.org/wiki/International_Article_Number_%28EAN%2
+    # 9)
+    # @return [String]
+    attr_accessor :ean
+
+    # [Universal Product
+    # Code](http://en.wikipedia.org/wiki/Universal_Product_Code)
+    # @return [String]
+    attr_accessor :upc
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['isrc'] = 'isrc'
+      @_hash['ean'] = 'ean'
+      @_hash['upc'] = 'upc'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        isrc
+        ean
+        upc
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(isrc = SKIP, ean = SKIP, upc = SKIP)
+      @isrc = isrc unless isrc == SKIP
+      @ean = ean unless ean == SKIP
+      @upc = upc unless upc == 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.
+      isrc = hash.key?('isrc') ? hash['isrc'] : SKIP
+      ean = hash.key?('ean') ? hash['ean'] : SKIP
+      upc = hash.key?('upc') ? hash['upc'] : SKIP
+
+      # Create object from extracted values.
+      ExternalIdObject.new(isrc,
+                           ean,
+                           upc)
+    end
+  end
+end

data/lib/spotify_web_api/models/external_url_object.rb

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

data/lib/spotify_web_api/models/followers_object.rb

@@ -0,0 +1,62 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # FollowersObject Model.
+  class FollowersObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This will always be set to null, as the Web API does not support it at the
+    # moment.
+    # @return [String]
+    attr_accessor :href
+
+    # The total number of followers.
+    # @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
+      %w[
+        href
+      ]
+    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.
+      FollowersObject.new(href,
+                          total)
+    end
+  end
+end

data/lib/spotify_web_api/models/image_object.rb

@@ -0,0 +1,67 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # ImageObject Model.
+  class ImageObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The source URL of the image.
+    # @return [String]
+    attr_accessor :url
+
+    # The image height in pixels.
+    # @return [Integer]
+    attr_accessor :height
+
+    # The image width in pixels.
+    # @return [Integer]
+    attr_accessor :width
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['url'] = 'url'
+      @_hash['height'] = 'height'
+      @_hash['width'] = 'width'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        height
+        width
+      ]
+    end
+
+    def initialize(url = nil, height = nil, width = nil)
+      @url = url
+      @height = height
+      @width = width
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      url = hash.key?('url') ? hash['url'] : nil
+      height = hash.key?('height') ? hash['height'] : nil
+      width = hash.key?('width') ? hash['width'] : nil
+
+      # Create object from extracted values.
+      ImageObject.new(url,
+                      height,
+                      width)
+    end
+  end
+end

data/lib/spotify_web_api/models/include_external_enum.rb

@@ -0,0 +1,23 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # If `include_external=audio` is specified it signals that the client can play
+  # externally hosted audio content, and marks the content as playable in the
+  # response. By default externally hosted audio content is marked as unplayable
+  # in the response.
+  class IncludeExternalEnum
+    INCLUDE_EXTERNAL_ENUM = [
+      # TODO: Write general description for AUDIO
+      AUDIO = 'audio'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INCLUDE_EXTERNAL_ENUM.include?(value)
+    end
+  end
+end