spotify-apimatic-sdk 1.0.0

data/lib/spotify_web_api/models/currently_playing_object.rb

@@ -0,0 +1,138 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SpotifyWebApi
+  # CurrentlyPlayingObject Model.
+  class CurrentlyPlayingObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A Context Object. Can be `null`.
+    # @return [ContextObject]
+    attr_accessor :context
+
+    # Unix Millisecond Timestamp when data was fetched
+    # @return [Integer]
+    attr_accessor :timestamp
+
+    # Progress into the currently playing track or episode. Can be `null`.
+    # @return [Integer]
+    attr_accessor :progress_ms
+
+    # If something is currently playing, return `true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_playing
+
+    # The currently playing track or episode. Can be `null`.
+    # @return [Object]
+    attr_accessor :item
+
+    # The object type of the currently playing item. Can be one of `track`,
+    # `episode`, `ad` or `unknown`.
+    # @return [String]
+    attr_accessor :currently_playing_type
+
+    # Allows to update the user interface based on which playback actions are
+    # available within the current context.
+    # @return [DisallowsObject]
+    attr_accessor :actions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['context'] = 'context'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['progress_ms'] = 'progress_ms'
+      @_hash['is_playing'] = 'is_playing'
+      @_hash['item'] = 'item'
+      @_hash['currently_playing_type'] = 'currently_playing_type'
+      @_hash['actions'] = 'actions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        context
+        timestamp
+        progress_ms
+        is_playing
+        item
+        currently_playing_type
+        actions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(context = SKIP, timestamp = SKIP, progress_ms = SKIP,
+                   is_playing = SKIP, item = SKIP,
+                   currently_playing_type = SKIP, actions = SKIP)
+      @context = context unless context == SKIP
+      @timestamp = timestamp unless timestamp == SKIP
+      @progress_ms = progress_ms unless progress_ms == SKIP
+      @is_playing = is_playing unless is_playing == SKIP
+      @item = item unless item == SKIP
+      @currently_playing_type = currently_playing_type unless currently_playing_type == SKIP
+      @actions = actions unless actions == 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.
+      context = ContextObject.from_hash(hash['context']) if hash['context']
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
+      progress_ms = hash.key?('progress_ms') ? hash['progress_ms'] : SKIP
+      is_playing = hash.key?('is_playing') ? hash['is_playing'] : SKIP
+      item = hash.key?('item') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CurrentlyPlayingObjectItem), hash['item']
+      ) : SKIP
+      currently_playing_type =
+        hash.key?('currently_playing_type') ? hash['currently_playing_type'] : SKIP
+      actions = DisallowsObject.from_hash(hash['actions']) if hash['actions']
+
+      # Create object from extracted values.
+      CurrentlyPlayingObject.new(context,
+                                 timestamp,
+                                 progress_ms,
+                                 is_playing,
+                                 item,
+                                 currently_playing_type,
+                                 actions)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CurrentlyPlayingObject | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} context: #{@context}, timestamp: #{@timestamp}, progress_ms:"\
+      " #{@progress_ms}, is_playing: #{@is_playing}, item: #{@item}, currently_playing_type:"\
+      " #{@currently_playing_type}, actions: #{@actions}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} context: #{@context.inspect}, timestamp: #{@timestamp.inspect},"\
+      " progress_ms: #{@progress_ms.inspect}, is_playing: #{@is_playing.inspect}, item:"\
+      " #{@item.inspect}, currently_playing_type: #{@currently_playing_type.inspect}, actions:"\
+      " #{@actions.inspect}>"
+    end
+  end
+end

data/lib/spotify_web_api/models/cursor_object.rb

@@ -0,0 +1,71 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SpotifyWebApi
+  # CursorObject Model.
+  class CursorObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The cursor to use as key to find the next page of items.
+    # @return [String]
+    attr_accessor :after
+
+    # The cursor to use as key to find the previous page of items.
+    # @return [String]
+    attr_accessor :before
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['after'] = 'after'
+      @_hash['before'] = 'before'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        after
+        before
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(after = SKIP, before = SKIP)
+      @after = after unless after == SKIP
+      @before = before unless before == 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.
+      after = hash.key?('after') ? hash['after'] : SKIP
+      before = hash.key?('before') ? hash['before'] : SKIP
+
+      # Create object from extracted values.
+      CursorObject.new(after,
+                       before)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} after: #{@after}, before: #{@before}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} after: #{@after.inspect}, before: #{@before.inspect}>"
+    end
+  end
+end

data/lib/spotify_web_api/models/cursor_paged_artists.rb

@@ -0,0 +1,60 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SpotifyWebApi
+  # CursorPagedArtists Model.
+  class CursorPagedArtists < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CursorPagingSimplifiedArtistObject]
+    attr_accessor :artists
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['artists'] = 'artists'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(artists = nil)
+      @artists = artists
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      artists = CursorPagingSimplifiedArtistObject.from_hash(hash['artists']) if hash['artists']
+
+      # Create object from extracted values.
+      CursorPagedArtists.new(artists)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} artists: #{@artists}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} artists: #{@artists.inspect}>"
+    end
+  end
+end

data/lib/spotify_web_api/models/cursor_paging_object.rb

@@ -0,0 +1,102 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SpotifyWebApi
+  # CursorPagingObject Model.
+  class CursorPagingObject < 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 cursors used to find the next set of items.
+    # @return [CursorObject]
+    attr_accessor :cursors
+
+    # The total number of items available to return.
+    # @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['limit'] = 'limit'
+      @_hash['mnext'] = 'next'
+      @_hash['cursors'] = 'cursors'
+      @_hash['total'] = 'total'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        href
+        limit
+        mnext
+        cursors
+        total
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(href = SKIP, limit = SKIP, mnext = SKIP, cursors = SKIP,
+                   total = SKIP)
+      @href = href unless href == SKIP
+      @limit = limit unless limit == SKIP
+      @mnext = mnext unless mnext == SKIP
+      @cursors = cursors unless cursors == 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
+      limit = hash.key?('limit') ? hash['limit'] : SKIP
+      mnext = hash.key?('next') ? hash['next'] : SKIP
+      cursors = CursorObject.from_hash(hash['cursors']) if hash['cursors']
+      total = hash.key?('total') ? hash['total'] : SKIP
+
+      # Create object from extracted values.
+      CursorPagingObject.new(href,
+                             limit,
+                             mnext,
+                             cursors,
+                             total)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href}, limit: #{@limit}, mnext: #{@mnext}, cursors: #{@cursors},"\
+      " total: #{@total}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href.inspect}, limit: #{@limit.inspect}, mnext: #{@mnext.inspect},"\
+      " cursors: #{@cursors.inspect}, total: #{@total.inspect}>"
+    end
+  end
+end

data/lib/spotify_web_api/models/cursor_paging_play_history_object.rb

@@ -0,0 +1,120 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SpotifyWebApi
+  # CursorPagingPlayHistoryObject Model.
+  class CursorPagingPlayHistoryObject < 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 cursors used to find the next set of items.
+    # @return [CursorObject]
+    attr_accessor :cursors
+
+    # The total number of items available to return.
+    # @return [Integer]
+    attr_accessor :total
+
+    # The total number of items available to return.
+    # @return [Array[PlayHistoryObject]]
+    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['cursors'] = 'cursors'
+      @_hash['total'] = 'total'
+      @_hash['items'] = 'items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        href
+        limit
+        mnext
+        cursors
+        total
+        items
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(href = SKIP, limit = SKIP, mnext = SKIP, cursors = SKIP,
+                   total = SKIP, items = SKIP)
+      @href = href unless href == SKIP
+      @limit = limit unless limit == SKIP
+      @mnext = mnext unless mnext == SKIP
+      @cursors = cursors unless cursors == SKIP
+      @total = total unless total == SKIP
+      @items = items unless items == 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
+      limit = hash.key?('limit') ? hash['limit'] : SKIP
+      mnext = hash.key?('next') ? hash['next'] : SKIP
+      cursors = CursorObject.from_hash(hash['cursors']) if hash['cursors']
+      total = hash.key?('total') ? hash['total'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (PlayHistoryObject.from_hash(structure) if structure)
+        end
+      end
+
+      items = SKIP unless hash.key?('items')
+
+      # Create object from extracted values.
+      CursorPagingPlayHistoryObject.new(href,
+                                        limit,
+                                        mnext,
+                                        cursors,
+                                        total,
+                                        items)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href}, limit: #{@limit}, mnext: #{@mnext}, cursors: #{@cursors},"\
+      " total: #{@total}, items: #{@items}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href.inspect}, limit: #{@limit.inspect}, mnext: #{@mnext.inspect},"\
+      " cursors: #{@cursors.inspect}, total: #{@total.inspect}, items: #{@items.inspect}>"
+    end
+  end
+end

data/lib/spotify_web_api/models/cursor_paging_simplified_artist_object.rb

@@ -0,0 +1,120 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SpotifyWebApi
+  # CursorPagingSimplifiedArtistObject Model.
+  class CursorPagingSimplifiedArtistObject < 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 cursors used to find the next set of items.
+    # @return [CursorObject]
+    attr_accessor :cursors
+
+    # The total number of items available to return.
+    # @return [Integer]
+    attr_accessor :total
+
+    # The total number of items available to return.
+    # @return [Array[ArtistObject]]
+    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['cursors'] = 'cursors'
+      @_hash['total'] = 'total'
+      @_hash['items'] = 'items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        href
+        limit
+        mnext
+        cursors
+        total
+        items
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(href = SKIP, limit = SKIP, mnext = SKIP, cursors = SKIP,
+                   total = SKIP, items = SKIP)
+      @href = href unless href == SKIP
+      @limit = limit unless limit == SKIP
+      @mnext = mnext unless mnext == SKIP
+      @cursors = cursors unless cursors == SKIP
+      @total = total unless total == SKIP
+      @items = items unless items == 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
+      limit = hash.key?('limit') ? hash['limit'] : SKIP
+      mnext = hash.key?('next') ? hash['next'] : SKIP
+      cursors = CursorObject.from_hash(hash['cursors']) if hash['cursors']
+      total = hash.key?('total') ? hash['total'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (ArtistObject.from_hash(structure) if structure)
+        end
+      end
+
+      items = SKIP unless hash.key?('items')
+
+      # Create object from extracted values.
+      CursorPagingSimplifiedArtistObject.new(href,
+                                             limit,
+                                             mnext,
+                                             cursors,
+                                             total,
+                                             items)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href}, limit: #{@limit}, mnext: #{@mnext}, cursors: #{@cursors},"\
+      " total: #{@total}, items: #{@items}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href.inspect}, limit: #{@limit.inspect}, mnext: #{@mnext.inspect},"\
+      " cursors: #{@cursors.inspect}, total: #{@total.inspect}, items: #{@items.inspect}>"
+    end
+  end
+end