spotify-api-sdk 1.0.0

data/lib/spotify_web_api/models/audiobook_object.rb

@@ -0,0 +1,253 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # AudiobookObject Model.
+  class AudiobookObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The author(s) for the audiobook.
+    # @return [Array[AuthorObject]]
+    attr_accessor :authors
+
+    # A list of the countries in which the audiobook 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 audiobook.
+    # @return [Array[CopyrightObject]]
+    attr_accessor :copyrights
+
+    # A description of the audiobook. 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 audiobook. This field may contain HTML tags.
+    # @return [String]
+    attr_accessor :html_description
+
+    # The edition of the audiobook.
+    # @return [String]
+    attr_accessor :edition
+
+    # Whether or not the audiobook has explicit content (true = yes it does;
+    # false = no it does not OR unknown).
+    # @return [TrueClass | FalseClass]
+    attr_accessor :explicit
+
+    # External URLs for this audiobook.
+    # @return [ExternalUrlObject]
+    attr_accessor :external_urls
+
+    # A link to the Web API endpoint providing full details of the audiobook.
+    # @return [String]
+    attr_accessor :href
+
+    # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+    # audiobook.
+    # @return [String]
+    attr_accessor :id
+
+    # The cover art for the audiobook in various sizes, widest first.
+    # @return [Array[ImageObject]]
+    attr_accessor :images
+
+    # A list of the languages used in the audiobook, identified by their [ISO
+    # 639](https://en.wikipedia.org/wiki/ISO_639) code.
+    # @return [Array[String]]
+    attr_accessor :languages
+
+    # The media type of the audiobook.
+    # @return [String]
+    attr_accessor :media_type
+
+    # The name of the audiobook.
+    # @return [String]
+    attr_accessor :name
+
+    # The narrator(s) for the audiobook.
+    # @return [Array[NarratorObject]]
+    attr_accessor :narrators
+
+    # The publisher of the audiobook.
+    # @return [String]
+    attr_accessor :publisher
+
+    # The object type.
+    # @return [Type9Enum]
+    attr_accessor :type
+
+    # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for
+    # the audiobook.
+    # @return [String]
+    attr_accessor :uri
+
+    # The number of chapters in this audiobook.
+    # @return [Integer]
+    attr_accessor :total_chapters
+
+    # The chapters of the audiobook.
+    # @return [PagingSimplifiedChapterObject]
+    attr_accessor :chapters
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['authors'] = 'authors'
+      @_hash['available_markets'] = 'available_markets'
+      @_hash['copyrights'] = 'copyrights'
+      @_hash['description'] = 'description'
+      @_hash['html_description'] = 'html_description'
+      @_hash['edition'] = 'edition'
+      @_hash['explicit'] = 'explicit'
+      @_hash['external_urls'] = 'external_urls'
+      @_hash['href'] = 'href'
+      @_hash['id'] = 'id'
+      @_hash['images'] = 'images'
+      @_hash['languages'] = 'languages'
+      @_hash['media_type'] = 'media_type'
+      @_hash['name'] = 'name'
+      @_hash['narrators'] = 'narrators'
+      @_hash['publisher'] = 'publisher'
+      @_hash['type'] = 'type'
+      @_hash['uri'] = 'uri'
+      @_hash['total_chapters'] = 'total_chapters'
+      @_hash['chapters'] = 'chapters'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        edition
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(authors = nil, available_markets = nil, copyrights = nil,
+                   description = nil, html_description = nil, explicit = nil,
+                   external_urls = nil, href = nil, id = nil, images = nil,
+                   languages = nil, media_type = nil, name = nil,
+                   narrators = nil, publisher = nil, type = nil, uri = nil,
+                   total_chapters = nil, chapters = nil, edition = SKIP)
+      @authors = authors
+      @available_markets = available_markets
+      @copyrights = copyrights
+      @description = description
+      @html_description = html_description
+      @edition = edition unless edition == SKIP
+      @explicit = explicit
+      @external_urls = external_urls
+      @href = href
+      @id = id
+      @images = images
+      @languages = languages
+      @media_type = media_type
+      @name = name
+      @narrators = narrators
+      @publisher = publisher
+      @type = type
+      @uri = uri
+      @total_chapters = total_chapters
+      @chapters = chapters
+    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
+      authors = nil
+      unless hash['authors'].nil?
+        authors = []
+        hash['authors'].each do |structure|
+          authors << (AuthorObject.from_hash(structure) if structure)
+        end
+      end
+
+      authors = nil unless hash.key?('authors')
+      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')
+      languages = hash.key?('languages') ? hash['languages'] : nil
+      media_type = hash.key?('media_type') ? hash['media_type'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      # Parameter is an array, so we need to iterate through it
+      narrators = nil
+      unless hash['narrators'].nil?
+        narrators = []
+        hash['narrators'].each do |structure|
+          narrators << (NarratorObject.from_hash(structure) if structure)
+        end
+      end
+
+      narrators = nil unless hash.key?('narrators')
+      publisher = hash.key?('publisher') ? hash['publisher'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      uri = hash.key?('uri') ? hash['uri'] : nil
+      total_chapters =
+        hash.key?('total_chapters') ? hash['total_chapters'] : nil
+      chapters = PagingSimplifiedChapterObject.from_hash(hash['chapters']) if hash['chapters']
+      edition = hash.key?('edition') ? hash['edition'] : SKIP
+
+      # Create object from extracted values.
+      AudiobookObject.new(authors,
+                          available_markets,
+                          copyrights,
+                          description,
+                          html_description,
+                          explicit,
+                          external_urls,
+                          href,
+                          id,
+                          images,
+                          languages,
+                          media_type,
+                          name,
+                          narrators,
+                          publisher,
+                          type,
+                          uri,
+                          total_chapters,
+                          chapters,
+                          edition)
+    end
+  end
+end

data/lib/spotify_web_api/models/author_object.rb

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

data/lib/spotify_web_api/models/base_model.rb

@@ -0,0 +1,62 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # Base model.
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        key = self.class.names.key?(name) ? self.class.names[name] : name
+        optional_fields = self.class.optionals
+        nullable_fields = self.class.nullables
+        if value.nil?
+          next unless nullable_fields.include?(name)
+
+          if !optional_fields.include?(name) && !nullable_fields.include?(name)
+            raise ArgumentError,
+                  "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+          end
+        end
+
+        hash[key] = nil
+        unless value.nil?
+          if respond_to?("to_custom_#{name}")
+            if (value.instance_of? Array) || (value.instance_of? Hash)
+              params = [hash, key]
+              hash[key] = send("to_custom_#{name}", *params)
+            else
+              hash[key] = send("to_custom_#{name}")
+            end
+          elsif respond_to?("to_union_type_#{name}")
+            hash[key] = send("to_union_type_#{name}")
+          elsif value.instance_of? Array
+            hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+          elsif value.instance_of? Hash
+            hash[key] = {}
+            value.each do |k, v|
+              hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+            end
+          else
+            hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+          end
+        end
+      end
+      hash
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+end

data/lib/spotify_web_api/models/categories.rb

@@ -0,0 +1,110 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # Categories Model.
+  class Categories < 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 offset of the items returned (as set in the query or by default)
+    # @return [Integer]
+    attr_accessor :offset
+
+    # URL to the previous page of items. ( `null` if none)
+    # @return [String]
+    attr_accessor :previous
+
+    # The total number of items available to return.
+    # @return [Integer]
+    attr_accessor :total
+
+    # The total number of items available to return.
+    # @return [Array[CategoryObject]]
+    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['offset'] = 'offset'
+      @_hash['previous'] = 'previous'
+      @_hash['total'] = 'total'
+      @_hash['items'] = 'items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        mnext
+        previous
+      ]
+    end
+
+    def initialize(href = nil, limit = nil, mnext = nil, offset = nil,
+                   previous = nil, total = nil, items = nil)
+      @href = href
+      @limit = limit
+      @mnext = mnext
+      @offset = offset
+      @previous = previous
+      @total = total
+      @items = items
+    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'] : nil
+      limit = hash.key?('limit') ? hash['limit'] : nil
+      mnext = hash.key?('next') ? hash['next'] : nil
+      offset = hash.key?('offset') ? hash['offset'] : nil
+      previous = hash.key?('previous') ? hash['previous'] : nil
+      total = hash.key?('total') ? hash['total'] : nil
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (CategoryObject.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('items')
+
+      # Create object from extracted values.
+      Categories.new(href,
+                     limit,
+                     mnext,
+                     offset,
+                     previous,
+                     total,
+                     items)
+    end
+  end
+end

data/lib/spotify_web_api/models/category_object.rb

@@ -0,0 +1,82 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # CategoryObject Model.
+  class CategoryObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A link to the Web API endpoint returning full details of the category.
+    # @return [String]
+    attr_accessor :href
+
+    # The category icon, in various sizes.
+    # @return [Array[ImageObject]]
+    attr_accessor :icons
+
+    # The [Spotify category
+    # ID](/documentation/web-api/concepts/spotify-uris-ids) of the category.
+    # @return [String]
+    attr_accessor :id
+
+    # The name of the category.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash['icons'] = 'icons'
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(href = nil, icons = nil, id = nil, name = nil)
+      @href = href
+      @icons = icons
+      @id = id
+      @name = name
+    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'] : nil
+      # Parameter is an array, so we need to iterate through it
+      icons = nil
+      unless hash['icons'].nil?
+        icons = []
+        hash['icons'].each do |structure|
+          icons << (ImageObject.from_hash(structure) if structure)
+        end
+      end
+
+      icons = nil unless hash.key?('icons')
+      id = hash.key?('id') ? hash['id'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+
+      # Create object from extracted values.
+      CategoryObject.new(href,
+                         icons,
+                         id,
+                         name)
+    end
+  end
+end