spotify-api-sdk 1.0.0

data/lib/spotify_web_api/models/section_object.rb

@@ -0,0 +1,180 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # SectionObject Model.
+  class SectionObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The starting point (in seconds) of the section.
+    # @return [Float]
+    attr_accessor :start
+
+    # The duration (in seconds) of the section.
+    # @return [Float]
+    attr_accessor :duration
+
+    # The confidence, from 0.0 to 1.0, of the reliability of the section's
+    # "designation".
+    # @return [Float]
+    attr_accessor :confidence
+
+    # The overall loudness of the section in decibels (dB). Loudness values are
+    # useful for comparing relative loudness of sections within tracks.
+    # @return [Float]
+    attr_accessor :loudness
+
+    # The overall estimated tempo of the section in beats per minute (BPM). In
+    # musical terminology, tempo is the speed or pace of a given piece and
+    # derives directly from the average beat duration.
+    # @return [Float]
+    attr_accessor :tempo
+
+    # The confidence, from 0.0 to 1.0, of the reliability of the tempo. Some
+    # tracks contain tempo changes or sounds which don't contain tempo (like
+    # pure speech) which would correspond to a low value in this field.
+    # @return [Float]
+    attr_accessor :tempo_confidence
+
+    # The estimated overall key of the section. The values in this field ranging
+    # from 0 to 11 mapping to pitches using standard Pitch Class notation (E.g.
+    # 0 = C, 1 = C♯/D♭, 2 = D, and so on). If no key was detected, the value is
+    # -1.
+    # @return [Integer]
+    attr_accessor :key
+
+    # The confidence, from 0.0 to 1.0, of the reliability of the key. Songs with
+    # many key changes may correspond to low values in this field.
+    # @return [Float]
+    attr_accessor :key_confidence
+
+    # 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.
+    # @return [ModeEnum]
+    attr_accessor :mode
+
+    # The confidence, from 0.0 to 1.0, of the reliability of the `mode`.
+    # @return [Float]
+    attr_accessor :mode_confidence
+
+    # An estimated time signature. The time signature (meter) is a notational
+    # convention to specify how many beats are in each bar (or measure). The
+    # time signature ranges from 3 to 7 indicating time signatures of "3/4", to
+    # "7/4".
+    # @return [Integer]
+    attr_accessor :time_signature
+
+    # The confidence, from 0.0 to 1.0, of the reliability of the
+    # `time_signature`. Sections with time signature changes may correspond to
+    # low values in this field.
+    # @return [Float]
+    attr_accessor :time_signature_confidence
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['start'] = 'start'
+      @_hash['duration'] = 'duration'
+      @_hash['confidence'] = 'confidence'
+      @_hash['loudness'] = 'loudness'
+      @_hash['tempo'] = 'tempo'
+      @_hash['tempo_confidence'] = 'tempo_confidence'
+      @_hash['key'] = 'key'
+      @_hash['key_confidence'] = 'key_confidence'
+      @_hash['mode'] = 'mode'
+      @_hash['mode_confidence'] = 'mode_confidence'
+      @_hash['time_signature'] = 'time_signature'
+      @_hash['time_signature_confidence'] = 'time_signature_confidence'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        start
+        duration
+        confidence
+        loudness
+        tempo
+        tempo_confidence
+        key
+        key_confidence
+        mode
+        mode_confidence
+        time_signature
+        time_signature_confidence
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(start = SKIP, duration = SKIP, confidence = SKIP,
+                   loudness = SKIP, tempo = SKIP, tempo_confidence = SKIP,
+                   key = SKIP, key_confidence = SKIP, mode = SKIP,
+                   mode_confidence = SKIP, time_signature = SKIP,
+                   time_signature_confidence = SKIP)
+      @start = start unless start == SKIP
+      @duration = duration unless duration == SKIP
+      @confidence = confidence unless confidence == SKIP
+      @loudness = loudness unless loudness == SKIP
+      @tempo = tempo unless tempo == SKIP
+      @tempo_confidence = tempo_confidence unless tempo_confidence == SKIP
+      @key = key unless key == SKIP
+      @key_confidence = key_confidence unless key_confidence == SKIP
+      @mode = mode unless mode == SKIP
+      @mode_confidence = mode_confidence unless mode_confidence == SKIP
+      @time_signature = time_signature unless time_signature == SKIP
+      unless time_signature_confidence == SKIP
+        @time_signature_confidence =
+          time_signature_confidence
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      start = hash.key?('start') ? hash['start'] : SKIP
+      duration = hash.key?('duration') ? hash['duration'] : SKIP
+      confidence = hash.key?('confidence') ? hash['confidence'] : SKIP
+      loudness = hash.key?('loudness') ? hash['loudness'] : SKIP
+      tempo = hash.key?('tempo') ? hash['tempo'] : SKIP
+      tempo_confidence =
+        hash.key?('tempo_confidence') ? hash['tempo_confidence'] : SKIP
+      key = hash.key?('key') ? hash['key'] : SKIP
+      key_confidence =
+        hash.key?('key_confidence') ? hash['key_confidence'] : SKIP
+      mode = hash.key?('mode') ? hash['mode'] : SKIP
+      mode_confidence =
+        hash.key?('mode_confidence') ? hash['mode_confidence'] : SKIP
+      time_signature =
+        hash.key?('time_signature') ? hash['time_signature'] : SKIP
+      time_signature_confidence =
+        hash.key?('time_signature_confidence') ? hash['time_signature_confidence'] : SKIP
+
+      # Create object from extracted values.
+      SectionObject.new(start,
+                        duration,
+                        confidence,
+                        loudness,
+                        tempo,
+                        tempo_confidence,
+                        key,
+                        key_confidence,
+                        mode,
+                        mode_confidence,
+                        time_signature,
+                        time_signature_confidence)
+    end
+  end
+end

data/lib/spotify_web_api/models/segment_object.rb

@@ -0,0 +1,166 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # SegmentObject Model.
+  class SegmentObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The starting point (in seconds) of the segment.
+    # @return [Float]
+    attr_accessor :start
+
+    # The duration (in seconds) of the segment.
+    # @return [Float]
+    attr_accessor :duration
+
+    # The confidence, from 0.0 to 1.0, of the reliability of the segmentation.
+    # Segments of the song which are difficult to logically segment (e.g: noise)
+    # may correspond to low values in this field.
+    # @return [Float]
+    attr_accessor :confidence
+
+    # The onset loudness of the segment in decibels (dB). Combined with
+    # `loudness_max` and `loudness_max_time`, these components can be used to
+    # describe the "attack" of the segment.
+    # @return [Float]
+    attr_accessor :loudness_start
+
+    # The peak loudness of the segment in decibels (dB). Combined with
+    # `loudness_start` and `loudness_max_time`, these components can be used to
+    # describe the "attack" of the segment.
+    # @return [Float]
+    attr_accessor :loudness_max
+
+    # The segment-relative offset of the segment peak loudness in seconds.
+    # Combined with `loudness_start` and `loudness_max`, these components can be
+    # used to desctibe the "attack" of the segment.
+    # @return [Float]
+    attr_accessor :loudness_max_time
+
+    # The offset loudness of the segment in decibels (dB). This value should be
+    # equivalent to the loudness_start of the following segment.
+    # @return [Float]
+    attr_accessor :loudness_end
+
+    # Pitch content is given by a “chroma” vector, corresponding to the 12 pitch
+    # classes C, C#, D to B, with values ranging from 0 to 1 that describe the
+    # relative dominance of every pitch in the chromatic scale. For example a C
+    # Major chord would likely be represented by large values of C, E and G
+    # (i.e. classes 0, 4, and 7).
+    # Vectors are normalized to 1 by their strongest dimension, therefore noisy
+    # sounds are likely represented by values that are all close to 1, while
+    # pure tones are described by one value at 1 (the pitch) and others near 0.
+    # As can be seen below, the 12 vector indices are a combination of low-power
+    # spectrum values at their respective pitch frequencies.
+    # ![pitch
+    # vector](https://developer.spotify.com/assets/audio/Pitch_vector.png)
+    # @return [Array[Float]]
+    attr_accessor :pitches
+
+    # Timbre is the quality of a musical note or sound that distinguishes
+    # different types of musical instruments, or voices. It is a complex notion
+    # also referred to as sound color, texture, or tone quality, and is derived
+    # from the shape of a segment’s spectro-temporal surface, independently of
+    # pitch and loudness. The timbre feature is a vector that includes 12
+    # unbounded values roughly centered around 0. Those values are high level
+    # abstractions of the spectral surface, ordered by degree of importance.
+    # For completeness however, the first dimension represents the average
+    # loudness of the segment; second emphasizes brightness; third is more
+    # closely correlated to the flatness of a sound; fourth to sounds with a
+    # stronger attack; etc. See an image below representing the 12 basis
+    # functions (i.e. template segments).
+    # ![timbre basis
+    # functions](https://developer.spotify.com/assets/audio/Timbre_basis_functio
+    # ns.png)
+    # The actual timbre of the segment is best described as a linear combination
+    # of these 12 basis functions weighted by the coefficient values: timbre =
+    # c1 x b1 + c2 x b2 + ... + c12 x b12, where c1 to c12 represent the 12
+    # coefficients and b1 to b12 the 12 basis functions as displayed below.
+    # Timbre vectors are best used in comparison with each other.
+    # @return [Array[Float]]
+    attr_accessor :timbre
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['start'] = 'start'
+      @_hash['duration'] = 'duration'
+      @_hash['confidence'] = 'confidence'
+      @_hash['loudness_start'] = 'loudness_start'
+      @_hash['loudness_max'] = 'loudness_max'
+      @_hash['loudness_max_time'] = 'loudness_max_time'
+      @_hash['loudness_end'] = 'loudness_end'
+      @_hash['pitches'] = 'pitches'
+      @_hash['timbre'] = 'timbre'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        start
+        duration
+        confidence
+        loudness_start
+        loudness_max
+        loudness_max_time
+        loudness_end
+        pitches
+        timbre
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(start = SKIP, duration = SKIP, confidence = SKIP,
+                   loudness_start = SKIP, loudness_max = SKIP,
+                   loudness_max_time = SKIP, loudness_end = SKIP,
+                   pitches = SKIP, timbre = SKIP)
+      @start = start unless start == SKIP
+      @duration = duration unless duration == SKIP
+      @confidence = confidence unless confidence == SKIP
+      @loudness_start = loudness_start unless loudness_start == SKIP
+      @loudness_max = loudness_max unless loudness_max == SKIP
+      @loudness_max_time = loudness_max_time unless loudness_max_time == SKIP
+      @loudness_end = loudness_end unless loudness_end == SKIP
+      @pitches = pitches unless pitches == SKIP
+      @timbre = timbre unless timbre == 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.
+      start = hash.key?('start') ? hash['start'] : SKIP
+      duration = hash.key?('duration') ? hash['duration'] : SKIP
+      confidence = hash.key?('confidence') ? hash['confidence'] : SKIP
+      loudness_start =
+        hash.key?('loudness_start') ? hash['loudness_start'] : SKIP
+      loudness_max = hash.key?('loudness_max') ? hash['loudness_max'] : SKIP
+      loudness_max_time =
+        hash.key?('loudness_max_time') ? hash['loudness_max_time'] : SKIP
+      loudness_end = hash.key?('loudness_end') ? hash['loudness_end'] : SKIP
+      pitches = hash.key?('pitches') ? hash['pitches'] : SKIP
+      timbre = hash.key?('timbre') ? hash['timbre'] : SKIP
+
+      # Create object from extracted values.
+      SegmentObject.new(start,
+                        duration,
+                        confidence,
+                        loudness_start,
+                        loudness_max,
+                        loudness_max_time,
+                        loudness_end,
+                        pitches,
+                        timbre)
+    end
+  end
+end

data/lib/spotify_web_api/models/show_base.rb

@@ -0,0 +1,211 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # ShowBase Model.
+  class ShowBase < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of the countries in which the show can be played, identified by
+    # their [ISO 3166-1
+    # alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code.
+    # @return [Array[String]]
+    attr_accessor :available_markets
+
+    # The copyright statements of the show.
+    # @return [Array[CopyrightObject]]
+    attr_accessor :copyrights
+
+    # A description of the show. 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 show. This field may contain HTML tags.
+    # @return [String]
+    attr_accessor :html_description
+
+    # Whether or not the show has explicit content (true = yes it does; false =
+    # no it does not OR unknown).
+    # @return [TrueClass | FalseClass]
+    attr_accessor :explicit
+
+    # External URLs for this show.
+    # @return [ExternalUrlObject]
+    attr_accessor :external_urls
+
+    # A link to the Web API endpoint providing full details of the show.
+    # @return [String]
+    attr_accessor :href
+
+    # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+    # show.
+    # @return [String]
+    attr_accessor :id
+
+    # The cover art for the show in various sizes, widest first.
+    # @return [Array[ImageObject]]
+    attr_accessor :images
+
+    # True if all of the shows episodes are hosted outside of Spotify's CDN.
+    # This field might be `null` in some cases.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_externally_hosted
+
+    # A list of the languages used in the show, identified by their [ISO
+    # 639](https://en.wikipedia.org/wiki/ISO_639) code.
+    # @return [Array[String]]
+    attr_accessor :languages
+
+    # The media type of the show.
+    # @return [String]
+    attr_accessor :media_type
+
+    # The name of the episode.
+    # @return [String]
+    attr_accessor :name
+
+    # The publisher of the show.
+    # @return [String]
+    attr_accessor :publisher
+
+    # The object type.
+    # @return [Type7Enum]
+    attr_accessor :type
+
+    # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for
+    # the show.
+    # @return [String]
+    attr_accessor :uri
+
+    # The total number of episodes in the show.
+    # @return [Integer]
+    attr_accessor :total_episodes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['available_markets'] = 'available_markets'
+      @_hash['copyrights'] = 'copyrights'
+      @_hash['description'] = 'description'
+      @_hash['html_description'] = 'html_description'
+      @_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['languages'] = 'languages'
+      @_hash['media_type'] = 'media_type'
+      @_hash['name'] = 'name'
+      @_hash['publisher'] = 'publisher'
+      @_hash['type'] = 'type'
+      @_hash['uri'] = 'uri'
+      @_hash['total_episodes'] = 'total_episodes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(available_markets = nil, copyrights = nil, description = nil,
+                   html_description = nil, explicit = nil, external_urls = nil,
+                   href = nil, id = nil, images = nil,
+                   is_externally_hosted = nil, languages = nil,
+                   media_type = nil, name = nil, publisher = nil, type = nil,
+                   uri = nil, total_episodes = nil)
+      @available_markets = available_markets
+      @copyrights = copyrights
+      @description = description
+      @html_description = html_description
+      @explicit = explicit
+      @external_urls = external_urls
+      @href = href
+      @id = id
+      @images = images
+      @is_externally_hosted = is_externally_hosted
+      @languages = languages
+      @media_type = media_type
+      @name = name
+      @publisher = publisher
+      @type = type
+      @uri = uri
+      @total_episodes = total_episodes
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      available_markets =
+        hash.key?('available_markets') ? hash['available_markets'] : nil
+      # Parameter is an array, so we need to iterate through it
+      copyrights = nil
+      unless hash['copyrights'].nil?
+        copyrights = []
+        hash['copyrights'].each do |structure|
+          copyrights << (CopyrightObject.from_hash(structure) if structure)
+        end
+      end
+
+      copyrights = nil unless hash.key?('copyrights')
+      description = hash.key?('description') ? hash['description'] : nil
+      html_description =
+        hash.key?('html_description') ? hash['html_description'] : 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
+      languages = hash.key?('languages') ? hash['languages'] : nil
+      media_type = hash.key?('media_type') ? hash['media_type'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      publisher = hash.key?('publisher') ? hash['publisher'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      uri = hash.key?('uri') ? hash['uri'] : nil
+      total_episodes =
+        hash.key?('total_episodes') ? hash['total_episodes'] : nil
+
+      # Create object from extracted values.
+      ShowBase.new(available_markets,
+                   copyrights,
+                   description,
+                   html_description,
+                   explicit,
+                   external_urls,
+                   href,
+                   id,
+                   images,
+                   is_externally_hosted,
+                   languages,
+                   media_type,
+                   name,
+                   publisher,
+                   type,
+                   uri,
+                   total_episodes)
+    end
+  end
+end