spotify-api-sdk 1.0.0

data/lib/spotify_web_api/models/device_object.rb

@@ -0,0 +1,126 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # DeviceObject Model.
+  class DeviceObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The device ID. This ID is unique and persistent to some extent. However,
+    # this is not guaranteed and any cached `device_id` should periodically be
+    # cleared out and refetched as necessary.
+    # @return [String]
+    attr_accessor :id
+
+    # If this device is the currently active device.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_active
+
+    # If this device is currently in a private session.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_private_session
+
+    # Whether controlling this device is restricted. At present if this is
+    # "true" then no Web API commands will be accepted by this device.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_restricted
+
+    # A human-readable name for the device. Some devices have a name that the
+    # user can configure (e.g. \"Loudest speaker\") and some devices have a
+    # generic name associated with the manufacturer or device model.
+    # @return [String]
+    attr_accessor :name
+
+    # Device type, such as "computer", "smartphone" or "speaker".
+    # @return [String]
+    attr_accessor :type
+
+    # The current volume in percent.
+    # @return [Integer]
+    attr_accessor :volume_percent
+
+    # If this device can be used to set the volume.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :supports_volume
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['is_active'] = 'is_active'
+      @_hash['is_private_session'] = 'is_private_session'
+      @_hash['is_restricted'] = 'is_restricted'
+      @_hash['name'] = 'name'
+      @_hash['type'] = 'type'
+      @_hash['volume_percent'] = 'volume_percent'
+      @_hash['supports_volume'] = 'supports_volume'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        is_active
+        is_private_session
+        is_restricted
+        name
+        type
+        volume_percent
+        supports_volume
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        id
+        volume_percent
+      ]
+    end
+
+    def initialize(id = SKIP, is_active = SKIP, is_private_session = SKIP,
+                   is_restricted = SKIP, name = SKIP, type = SKIP,
+                   volume_percent = SKIP, supports_volume = SKIP)
+      @id = id unless id == SKIP
+      @is_active = is_active unless is_active == SKIP
+      @is_private_session = is_private_session unless is_private_session == SKIP
+      @is_restricted = is_restricted unless is_restricted == SKIP
+      @name = name unless name == SKIP
+      @type = type unless type == SKIP
+      @volume_percent = volume_percent unless volume_percent == SKIP
+      @supports_volume = supports_volume unless supports_volume == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      is_active = hash.key?('is_active') ? hash['is_active'] : SKIP
+      is_private_session =
+        hash.key?('is_private_session') ? hash['is_private_session'] : SKIP
+      is_restricted = hash.key?('is_restricted') ? hash['is_restricted'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      volume_percent =
+        hash.key?('volume_percent') ? hash['volume_percent'] : SKIP
+      supports_volume =
+        hash.key?('supports_volume') ? hash['supports_volume'] : SKIP
+
+      # Create object from extracted values.
+      DeviceObject.new(id,
+                       is_active,
+                       is_private_session,
+                       is_restricted,
+                       name,
+                       type,
+                       volume_percent,
+                       supports_volume)
+    end
+  end
+end

data/lib/spotify_web_api/models/disallows_object.rb

@@ -0,0 +1,140 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # DisallowsObject Model.
+  class DisallowsObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Interrupting playback. Optional field.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :interrupting_playback
+
+    # Pausing. Optional field.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :pausing
+
+    # Resuming. Optional field.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :resuming
+
+    # Seeking playback location. Optional field.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :seeking
+
+    # Skipping to the next context. Optional field.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :skipping_next
+
+    # Skipping to the previous context. Optional field.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :skipping_prev
+
+    # Toggling repeat context flag. Optional field.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :toggling_repeat_context
+
+    # Toggling shuffle flag. Optional field.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :toggling_shuffle
+
+    # Toggling repeat track flag. Optional field.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :toggling_repeat_track
+
+    # Transfering playback between devices. Optional field.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :transferring_playback
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['interrupting_playback'] = 'interrupting_playback'
+      @_hash['pausing'] = 'pausing'
+      @_hash['resuming'] = 'resuming'
+      @_hash['seeking'] = 'seeking'
+      @_hash['skipping_next'] = 'skipping_next'
+      @_hash['skipping_prev'] = 'skipping_prev'
+      @_hash['toggling_repeat_context'] = 'toggling_repeat_context'
+      @_hash['toggling_shuffle'] = 'toggling_shuffle'
+      @_hash['toggling_repeat_track'] = 'toggling_repeat_track'
+      @_hash['transferring_playback'] = 'transferring_playback'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        interrupting_playback
+        pausing
+        resuming
+        seeking
+        skipping_next
+        skipping_prev
+        toggling_repeat_context
+        toggling_shuffle
+        toggling_repeat_track
+        transferring_playback
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(interrupting_playback = SKIP, pausing = SKIP,
+                   resuming = SKIP, seeking = SKIP, skipping_next = SKIP,
+                   skipping_prev = SKIP, toggling_repeat_context = SKIP,
+                   toggling_shuffle = SKIP, toggling_repeat_track = SKIP,
+                   transferring_playback = SKIP)
+      @interrupting_playback = interrupting_playback unless interrupting_playback == SKIP
+      @pausing = pausing unless pausing == SKIP
+      @resuming = resuming unless resuming == SKIP
+      @seeking = seeking unless seeking == SKIP
+      @skipping_next = skipping_next unless skipping_next == SKIP
+      @skipping_prev = skipping_prev unless skipping_prev == SKIP
+      @toggling_repeat_context = toggling_repeat_context unless toggling_repeat_context == SKIP
+      @toggling_shuffle = toggling_shuffle unless toggling_shuffle == SKIP
+      @toggling_repeat_track = toggling_repeat_track unless toggling_repeat_track == SKIP
+      @transferring_playback = transferring_playback unless transferring_playback == 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.
+      interrupting_playback =
+        hash.key?('interrupting_playback') ? hash['interrupting_playback'] : SKIP
+      pausing = hash.key?('pausing') ? hash['pausing'] : SKIP
+      resuming = hash.key?('resuming') ? hash['resuming'] : SKIP
+      seeking = hash.key?('seeking') ? hash['seeking'] : SKIP
+      skipping_next = hash.key?('skipping_next') ? hash['skipping_next'] : SKIP
+      skipping_prev = hash.key?('skipping_prev') ? hash['skipping_prev'] : SKIP
+      toggling_repeat_context =
+        hash.key?('toggling_repeat_context') ? hash['toggling_repeat_context'] : SKIP
+      toggling_shuffle =
+        hash.key?('toggling_shuffle') ? hash['toggling_shuffle'] : SKIP
+      toggling_repeat_track =
+        hash.key?('toggling_repeat_track') ? hash['toggling_repeat_track'] : SKIP
+      transferring_playback =
+        hash.key?('transferring_playback') ? hash['transferring_playback'] : SKIP
+
+      # Create object from extracted values.
+      DisallowsObject.new(interrupting_playback,
+                          pausing,
+                          resuming,
+                          seeking,
+                          skipping_next,
+                          skipping_prev,
+                          toggling_repeat_context,
+                          toggling_shuffle,
+                          toggling_repeat_track,
+                          transferring_playback)
+    end
+  end
+end

data/lib/spotify_web_api/models/episode_base.rb

@@ -0,0 +1,237 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # EpisodeBase Model.
+  class EpisodeBase < 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
+
+    # 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
+    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,
+                   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
+    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
+      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.
+      EpisodeBase.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,
+                      language,
+                      resume_point,
+                      restrictions)
+    end
+  end
+end