spotify-api-sdk 1.0.0

data/lib/spotify_web_api/models/recommendations_object.rb

@@ -0,0 +1,74 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # RecommendationsObject Model.
+  class RecommendationsObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of recommendation seed objects.
+    # @return [Array[RecommendationSeedObject]]
+    attr_accessor :seeds
+
+    # An array of track objects ordered according to the parameters supplied.
+    # @return [Array[TrackObject]]
+    attr_accessor :tracks
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['seeds'] = 'seeds'
+      @_hash['tracks'] = 'tracks'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(seeds = nil, tracks = nil)
+      @seeds = seeds
+      @tracks = tracks
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      seeds = nil
+      unless hash['seeds'].nil?
+        seeds = []
+        hash['seeds'].each do |structure|
+          seeds << (RecommendationSeedObject.from_hash(structure) if structure)
+        end
+      end
+
+      seeds = nil unless hash.key?('seeds')
+      # Parameter is an array, so we need to iterate through it
+      tracks = nil
+      unless hash['tracks'].nil?
+        tracks = []
+        hash['tracks'].each do |structure|
+          tracks << (TrackObject.from_hash(structure) if structure)
+        end
+      end
+
+      tracks = nil unless hash.key?('tracks')
+
+      # Create object from extracted values.
+      RecommendationsObject.new(seeds,
+                                tracks)
+    end
+  end
+end

data/lib/spotify_web_api/models/release_date_precision_enum.rb

@@ -0,0 +1,26 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # The precision with which `release_date` value is known.
+  class ReleaseDatePrecisionEnum
+    RELEASE_DATE_PRECISION_ENUM = [
+      # TODO: Write general description for YEAR
+      YEAR = 'year'.freeze,
+
+      # TODO: Write general description for MONTH
+      MONTH = 'month'.freeze,
+
+      # TODO: Write general description for DAY
+      DAY = 'day'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RELEASE_DATE_PRECISION_ENUM.include?(value)
+    end
+  end
+end

data/lib/spotify_web_api/models/resume_point_object.rb

@@ -0,0 +1,60 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # ResumePointObject Model.
+  class ResumePointObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Whether or not the episode has been fully played by the user.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :fully_played
+
+    # The user's most recent position in the episode in milliseconds.
+    # @return [Integer]
+    attr_accessor :resume_position_ms
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fully_played'] = 'fully_played'
+      @_hash['resume_position_ms'] = 'resume_position_ms'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fully_played
+        resume_position_ms
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fully_played = SKIP, resume_position_ms = SKIP)
+      @fully_played = fully_played unless fully_played == SKIP
+      @resume_position_ms = resume_position_ms unless resume_position_ms == 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.
+      fully_played = hash.key?('fully_played') ? hash['fully_played'] : SKIP
+      resume_position_ms =
+        hash.key?('resume_position_ms') ? hash['resume_position_ms'] : SKIP
+
+      # Create object from extracted values.
+      ResumePointObject.new(fully_played,
+                            resume_position_ms)
+    end
+  end
+end

data/lib/spotify_web_api/models/saved_album_object.rb

@@ -0,0 +1,73 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module SpotifyWebApi
+  # SavedAlbumObject Model.
+  class SavedAlbumObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The date and time the album was saved
+    # Timestamps are returned in ISO 8601 format as Coordinated Universal Time
+    # (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ.
+    # If the time is imprecise (for example, the date/time of an album release),
+    # an additional field indicates the precision; see for example, release_date
+    # in an album object.
+    # @return [DateTime]
+    attr_accessor :added_at
+
+    # Information about the album.
+    # @return [AlbumObject]
+    attr_accessor :album
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['added_at'] = 'added_at'
+      @_hash['album'] = 'album'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        added_at
+        album
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(added_at = SKIP, album = SKIP)
+      @added_at = added_at unless added_at == SKIP
+      @album = album unless album == 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
+      album = AlbumObject.from_hash(hash['album']) if hash['album']
+
+      # Create object from extracted values.
+      SavedAlbumObject.new(added_at,
+                           album)
+    end
+
+    def to_custom_added_at
+      DateTimeHelper.to_rfc3339(added_at)
+    end
+  end
+end

data/lib/spotify_web_api/models/saved_audiobook_object.rb

@@ -0,0 +1,73 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module SpotifyWebApi
+  # SavedAudiobookObject Model.
+  class SavedAudiobookObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The date and time the audiobook was saved
+    # Timestamps are returned in ISO 8601 format as Coordinated Universal Time
+    # (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ.
+    # If the time is imprecise (for example, the date/time of an album release),
+    # an additional field indicates the precision; see for example, release_date
+    # in an album object.
+    # @return [DateTime]
+    attr_accessor :added_at
+
+    # Information about the audiobook.
+    # @return [AudiobookObject]
+    attr_accessor :audiobook
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['added_at'] = 'added_at'
+      @_hash['audiobook'] = 'audiobook'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        added_at
+        audiobook
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(added_at = SKIP, audiobook = SKIP)
+      @added_at = added_at unless added_at == SKIP
+      @audiobook = audiobook unless audiobook == 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
+      audiobook = AudiobookObject.from_hash(hash['audiobook']) if hash['audiobook']
+
+      # Create object from extracted values.
+      SavedAudiobookObject.new(added_at,
+                               audiobook)
+    end
+
+    def to_custom_added_at
+      DateTimeHelper.to_rfc3339(added_at)
+    end
+  end
+end

data/lib/spotify_web_api/models/saved_episode_object.rb

@@ -0,0 +1,70 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module SpotifyWebApi
+  # SavedEpisodeObject Model.
+  class SavedEpisodeObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The date and time the episode was saved.
+    # Timestamps are returned in ISO 8601 format as Coordinated Universal Time
+    # (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ.
+    # @return [DateTime]
+    attr_accessor :added_at
+
+    # Information about the episode.
+    # @return [EpisodeObject]
+    attr_accessor :episode
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['added_at'] = 'added_at'
+      @_hash['episode'] = 'episode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        added_at
+        episode
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(added_at = SKIP, episode = SKIP)
+      @added_at = added_at unless added_at == SKIP
+      @episode = episode unless episode == 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
+      episode = EpisodeObject.from_hash(hash['episode']) if hash['episode']
+
+      # Create object from extracted values.
+      SavedEpisodeObject.new(added_at,
+                             episode)
+    end
+
+    def to_custom_added_at
+      DateTimeHelper.to_rfc3339(added_at)
+    end
+  end
+end

data/lib/spotify_web_api/models/saved_show_object.rb

@@ -0,0 +1,73 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module SpotifyWebApi
+  # SavedShowObject Model.
+  class SavedShowObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The date and time the show was saved.
+    # Timestamps are returned in ISO 8601 format as Coordinated Universal Time
+    # (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ.
+    # If the time is imprecise (for example, the date/time of an album release),
+    # an additional field indicates the precision; see for example, release_date
+    # in an album object.
+    # @return [DateTime]
+    attr_accessor :added_at
+
+    # Information about the show.
+    # @return [ShowBase]
+    attr_accessor :show
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['added_at'] = 'added_at'
+      @_hash['show'] = 'show'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        added_at
+        show
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(added_at = SKIP, show = SKIP)
+      @added_at = added_at unless added_at == SKIP
+      @show = show unless show == 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
+      show = ShowBase.from_hash(hash['show']) if hash['show']
+
+      # Create object from extracted values.
+      SavedShowObject.new(added_at,
+                          show)
+    end
+
+    def to_custom_added_at
+      DateTimeHelper.to_rfc3339(added_at)
+    end
+  end
+end

data/lib/spotify_web_api/models/saved_track_object.rb

@@ -0,0 +1,73 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module SpotifyWebApi
+  # SavedTrackObject Model.
+  class SavedTrackObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The date and time the track was saved.
+    # Timestamps are returned in ISO 8601 format as Coordinated Universal Time
+    # (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ.
+    # If the time is imprecise (for example, the date/time of an album release),
+    # an additional field indicates the precision; see for example, release_date
+    # in an album object.
+    # @return [DateTime]
+    attr_accessor :added_at
+
+    # Information about the track.
+    # @return [TrackObject]
+    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['track'] = 'track'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        added_at
+        track
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(added_at = SKIP, track = SKIP)
+      @added_at = added_at unless added_at == 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
+      track = TrackObject.from_hash(hash['track']) if hash['track']
+
+      # Create object from extracted values.
+      SavedTrackObject.new(added_at,
+                           track)
+    end
+
+    def to_custom_added_at
+      DateTimeHelper.to_rfc3339(added_at)
+    end
+  end
+end

data/lib/spotify_web_api/models/search_items.rb

@@ -0,0 +1,107 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # SearchItems Model.
+  class SearchItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [PagingTrackObject]
+    attr_accessor :tracks
+
+    # TODO: Write general description for this method
+    # @return [PagingArtistObject]
+    attr_accessor :artists
+
+    # TODO: Write general description for this method
+    # @return [PagingSimplifiedAlbumObject]
+    attr_accessor :albums
+
+    # TODO: Write general description for this method
+    # @return [PagingPlaylistObject]
+    attr_accessor :playlists
+
+    # TODO: Write general description for this method
+    # @return [PagingSimplifiedShowObject]
+    attr_accessor :shows
+
+    # TODO: Write general description for this method
+    # @return [PagingSimplifiedEpisodeObject]
+    attr_accessor :episodes
+
+    # TODO: Write general description for this method
+    # @return [PagingSimplifiedAudiobookObject]
+    attr_accessor :audiobooks
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tracks'] = 'tracks'
+      @_hash['artists'] = 'artists'
+      @_hash['albums'] = 'albums'
+      @_hash['playlists'] = 'playlists'
+      @_hash['shows'] = 'shows'
+      @_hash['episodes'] = 'episodes'
+      @_hash['audiobooks'] = 'audiobooks'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tracks
+        artists
+        albums
+        playlists
+        shows
+        episodes
+        audiobooks
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tracks = SKIP, artists = SKIP, albums = SKIP,
+                   playlists = SKIP, shows = SKIP, episodes = SKIP,
+                   audiobooks = SKIP)
+      @tracks = tracks unless tracks == SKIP
+      @artists = artists unless artists == SKIP
+      @albums = albums unless albums == SKIP
+      @playlists = playlists unless playlists == SKIP
+      @shows = shows unless shows == SKIP
+      @episodes = episodes unless episodes == SKIP
+      @audiobooks = audiobooks unless audiobooks == 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.
+      tracks = PagingTrackObject.from_hash(hash['tracks']) if hash['tracks']
+      artists = PagingArtistObject.from_hash(hash['artists']) if hash['artists']
+      albums = PagingSimplifiedAlbumObject.from_hash(hash['albums']) if hash['albums']
+      playlists = PagingPlaylistObject.from_hash(hash['playlists']) if hash['playlists']
+      shows = PagingSimplifiedShowObject.from_hash(hash['shows']) if hash['shows']
+      episodes = PagingSimplifiedEpisodeObject.from_hash(hash['episodes']) if hash['episodes']
+      audiobooks = PagingSimplifiedAudiobookObject.from_hash(hash['audiobooks']) if
+        hash['audiobooks']
+
+      # Create object from extracted values.
+      SearchItems.new(tracks,
+                      artists,
+                      albums,
+                      playlists,
+                      shows,
+                      episodes,
+                      audiobooks)
+    end
+  end
+end