spotted 0.1.0

data/lib/spotted/models/browse/category_list_response.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    module Browse
+      # @see Spotted::Resources::Browse::Categories#list
+      class CategoryListResponse < Spotted::Internal::Type::BaseModel
+        # @!attribute categories
+        #
+        #   @return [Spotted::Models::Browse::CategoryListResponse::Categories]
+        required :categories, -> { Spotted::Models::Browse::CategoryListResponse::Categories }
+
+        # @!method initialize(categories:)
+        #   @param categories [Spotted::Models::Browse::CategoryListResponse::Categories]
+
+        # @see Spotted::Models::Browse::CategoryListResponse#categories
+        class Categories < Spotted::Internal::Type::BaseModel
+          # @!attribute href
+          #   A link to the Web API endpoint returning the full result of the request
+          #
+          #   @return [String]
+          required :href, String
+
+          # @!attribute items
+          #
+          #   @return [Array<Spotted::Models::Browse::CategoryListResponse::Categories::Item>]
+          required :items,
+                   -> { Spotted::Internal::Type::ArrayOf[Spotted::Models::Browse::CategoryListResponse::Categories::Item] }
+
+          # @!attribute limit
+          #   The maximum number of items in the response (as set in the query or by default).
+          #
+          #   @return [Integer]
+          required :limit, Integer
+
+          # @!attribute next_
+          #   URL to the next page of items. ( `null` if none)
+          #
+          #   @return [String, nil]
+          required :next_, String, api_name: :next, nil?: true
+
+          # @!attribute offset
+          #   The offset of the items returned (as set in the query or by default)
+          #
+          #   @return [Integer]
+          required :offset, Integer
+
+          # @!attribute previous
+          #   URL to the previous page of items. ( `null` if none)
+          #
+          #   @return [String, nil]
+          required :previous, String, nil?: true
+
+          # @!attribute total
+          #   The total number of items available to return.
+          #
+          #   @return [Integer]
+          required :total, Integer
+
+          # @!method initialize(href:, items:, limit:, next_:, offset:, previous:, total:)
+          #   Some parameter documentations has been truncated, see
+          #   {Spotted::Models::Browse::CategoryListResponse::Categories} for more details.
+          #
+          #   @param href [String] A link to the Web API endpoint returning the full result of the request
+          #
+          #   @param items [Array<Spotted::Models::Browse::CategoryListResponse::Categories::Item>]
+          #
+          #   @param limit [Integer] The maximum number of items in the response (as set in the query or by default).
+          #
+          #   @param next_ [String, nil] URL to the next page of items. ( `null` if none)
+          #
+          #   @param offset [Integer] The offset of the items returned (as set in the query or by default)
+          #
+          #   @param previous [String, nil] URL to the previous page of items. ( `null` if none)
+          #
+          #   @param total [Integer] The total number of items available to return.
+
+          class Item < Spotted::Internal::Type::BaseModel
+            # @!attribute id
+            #   The [Spotify category ID](/documentation/web-api/concepts/spotify-uris-ids) of
+            #   the category.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute href
+            #   A link to the Web API endpoint returning full details of the category.
+            #
+            #   @return [String]
+            required :href, String
+
+            # @!attribute icons
+            #   The category icon, in various sizes.
+            #
+            #   @return [Array<Spotted::Models::ImageObject>]
+            required :icons, -> { Spotted::Internal::Type::ArrayOf[Spotted::ImageObject] }
+
+            # @!attribute name
+            #   The name of the category.
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!method initialize(id:, href:, icons:, name:)
+            #   Some parameter documentations has been truncated, see
+            #   {Spotted::Models::Browse::CategoryListResponse::Categories::Item} for more
+            #   details.
+            #
+            #   @param id [String] The [Spotify category ID](/documentation/web-api/concepts/spotify-uris-ids) of t
+            #
+            #   @param href [String] A link to the Web API endpoint returning full details of the category.
+            #
+            #   @param icons [Array<Spotted::Models::ImageObject>] The category icon, in various sizes.
+            #
+            #   @param name [String] The name of the category.
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spotted/models/browse/category_retrieve_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    module Browse
+      # @see Spotted::Resources::Browse::Categories#retrieve
+      class CategoryRetrieveParams < Spotted::Internal::Type::BaseModel
+        extend Spotted::Internal::Type::RequestParameters::Converter
+        include Spotted::Internal::Type::RequestParameters
+
+        # @!attribute locale
+        #   The desired language, consisting of an
+        #   [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code and an
+        #   [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2),
+        #   joined by an underscore. For example: `es_MX`, meaning &quot;Spanish
+        #   (Mexico)&quot;. Provide this parameter if you want the category strings returned
+        #   in a particular language.<br/> _**Note**: if `locale` is not supplied, or if the
+        #   specified language is not available, the category strings returned will be in
+        #   the Spotify default language (American English)._
+        #
+        #   @return [String, nil]
+        optional :locale, String
+
+        # @!method initialize(locale: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::Browse::CategoryRetrieveParams} for more details.
+        #
+        #   @param locale [String] The desired language, consisting of an [ISO 639-1](http://en.wikipedia.org/wiki/
+        #
+        #   @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/spotted/models/browse/category_retrieve_response.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    module Browse
+      # @see Spotted::Resources::Browse::Categories#retrieve
+      class CategoryRetrieveResponse < Spotted::Internal::Type::BaseModel
+        # @!attribute id
+        #   The [Spotify category ID](/documentation/web-api/concepts/spotify-uris-ids) of
+        #   the category.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute href
+        #   A link to the Web API endpoint returning full details of the category.
+        #
+        #   @return [String]
+        required :href, String
+
+        # @!attribute icons
+        #   The category icon, in various sizes.
+        #
+        #   @return [Array<Spotted::Models::ImageObject>]
+        required :icons, -> { Spotted::Internal::Type::ArrayOf[Spotted::ImageObject] }
+
+        # @!attribute name
+        #   The name of the category.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!method initialize(id:, href:, icons:, name:)
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::Browse::CategoryRetrieveResponse} for more details.
+        #
+        #   @param id [String] The [Spotify category ID](/documentation/web-api/concepts/spotify-uris-ids) of t
+        #
+        #   @param href [String] A link to the Web API endpoint returning full details of the category.
+        #
+        #   @param icons [Array<Spotted::Models::ImageObject>] The category icon, in various sizes.
+        #
+        #   @param name [String] The name of the category.
+      end
+    end
+  end
+end

data/lib/spotted/models/browse_get_featured_playlists_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Browse#get_featured_playlists
+    class BrowseGetFeaturedPlaylistsParams < Spotted::Internal::Type::BaseModel
+      extend Spotted::Internal::Type::RequestParameters::Converter
+      include Spotted::Internal::Type::RequestParameters
+
+      # @!attribute limit
+      #   The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute locale
+      #   The desired language, consisting of an
+      #   [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code and an
+      #   [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2),
+      #   joined by an underscore. For example: `es_MX`, meaning &quot;Spanish
+      #   (Mexico)&quot;. Provide this parameter if you want the category strings returned
+      #   in a particular language.<br/> _**Note**: if `locale` is not supplied, or if the
+      #   specified language is not available, the category strings returned will be in
+      #   the Spotify default language (American English)._
+      #
+      #   @return [String, nil]
+      optional :locale, String
+
+      # @!attribute offset
+      #   The index of the first item to return. Default: 0 (the first item). Use with
+      #   limit to get the next set of items.
+      #
+      #   @return [Integer, nil]
+      optional :offset, Integer
+
+      # @!method initialize(limit: nil, locale: nil, offset: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::BrowseGetFeaturedPlaylistsParams} for more details.
+      #
+      #   @param limit [Integer] The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+      #
+      #   @param locale [String] The desired language, consisting of an [ISO 639-1](http://en.wikipedia.org/wiki/
+      #
+      #   @param offset [Integer] The index of the first item to return. Default: 0 (the first item). Use with lim
+      #
+      #   @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/spotted/models/browse_get_featured_playlists_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Browse#get_featured_playlists
+    class BrowseGetFeaturedPlaylistsResponse < Spotted::Internal::Type::BaseModel
+      # @!attribute message
+      #   The localized message of a playlist.
+      #
+      #   @return [String, nil]
+      optional :message, String
+
+      # @!attribute playlists
+      #
+      #   @return [Spotted::Models::PagingPlaylistObject, nil]
+      optional :playlists, -> { Spotted::PagingPlaylistObject }
+
+      # @!method initialize(message: nil, playlists: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::BrowseGetFeaturedPlaylistsResponse} for more details.
+      #
+      #   @param message [String] The localized message of a playlist.
+      #
+      #   @param playlists [Spotted::Models::PagingPlaylistObject]
+    end
+  end
+end

data/lib/spotted/models/browse_get_new_releases_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Browse#get_new_releases
+    class BrowseGetNewReleasesParams < Spotted::Internal::Type::BaseModel
+      extend Spotted::Internal::Type::RequestParameters::Converter
+      include Spotted::Internal::Type::RequestParameters
+
+      # @!attribute limit
+      #   The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute offset
+      #   The index of the first item to return. Default: 0 (the first item). Use with
+      #   limit to get the next set of items.
+      #
+      #   @return [Integer, nil]
+      optional :offset, Integer
+
+      # @!method initialize(limit: nil, offset: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::BrowseGetNewReleasesParams} for more details.
+      #
+      #   @param limit [Integer] The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+      #
+      #   @param offset [Integer] The index of the first item to return. Default: 0 (the first item). Use with lim
+      #
+      #   @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/spotted/models/browse_get_new_releases_response.rb

@@ -0,0 +1,245 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Browse#get_new_releases
+    class BrowseGetNewReleasesResponse < Spotted::Internal::Type::BaseModel
+      # @!attribute albums
+      #
+      #   @return [Spotted::Models::BrowseGetNewReleasesResponse::Albums]
+      required :albums, -> { Spotted::Models::BrowseGetNewReleasesResponse::Albums }
+
+      # @!method initialize(albums:)
+      #   @param albums [Spotted::Models::BrowseGetNewReleasesResponse::Albums]
+
+      # @see Spotted::Models::BrowseGetNewReleasesResponse#albums
+      class Albums < Spotted::Internal::Type::BaseModel
+        # @!attribute href
+        #   A link to the Web API endpoint returning the full result of the request
+        #
+        #   @return [String]
+        required :href, String
+
+        # @!attribute items
+        #
+        #   @return [Array<Spotted::Models::BrowseGetNewReleasesResponse::Albums::Item>]
+        required :items,
+                 -> { Spotted::Internal::Type::ArrayOf[Spotted::Models::BrowseGetNewReleasesResponse::Albums::Item] }
+
+        # @!attribute limit
+        #   The maximum number of items in the response (as set in the query or by default).
+        #
+        #   @return [Integer]
+        required :limit, Integer
+
+        # @!attribute next_
+        #   URL to the next page of items. ( `null` if none)
+        #
+        #   @return [String, nil]
+        required :next_, String, api_name: :next, nil?: true
+
+        # @!attribute offset
+        #   The offset of the items returned (as set in the query or by default)
+        #
+        #   @return [Integer]
+        required :offset, Integer
+
+        # @!attribute previous
+        #   URL to the previous page of items. ( `null` if none)
+        #
+        #   @return [String, nil]
+        required :previous, String, nil?: true
+
+        # @!attribute total
+        #   The total number of items available to return.
+        #
+        #   @return [Integer]
+        required :total, Integer
+
+        # @!method initialize(href:, items:, limit:, next_:, offset:, previous:, total:)
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::BrowseGetNewReleasesResponse::Albums} for more details.
+        #
+        #   @param href [String] A link to the Web API endpoint returning the full result of the request
+        #
+        #   @param items [Array<Spotted::Models::BrowseGetNewReleasesResponse::Albums::Item>]
+        #
+        #   @param limit [Integer] The maximum number of items in the response (as set in the query or by default).
+        #
+        #   @param next_ [String, nil] URL to the next page of items. ( `null` if none)
+        #
+        #   @param offset [Integer] The offset of the items returned (as set in the query or by default)
+        #
+        #   @param previous [String, nil] URL to the previous page of items. ( `null` if none)
+        #
+        #   @param total [Integer] The total number of items available to return.
+
+        class Item < Spotted::Internal::Type::BaseModel
+          # @!attribute id
+          #   The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+          #   album.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute album_type
+          #   The type of the album.
+          #
+          #   @return [Symbol, Spotted::Models::BrowseGetNewReleasesResponse::Albums::Item::AlbumType]
+          required :album_type, enum: -> { Spotted::Models::BrowseGetNewReleasesResponse::Albums::Item::AlbumType }
+
+          # @!attribute artists
+          #   The artists of the album. Each artist object includes a link in `href` to more
+          #   detailed information about the artist.
+          #
+          #   @return [Array<Spotted::Models::SimplifiedArtistObject>]
+          required :artists, -> { Spotted::Internal::Type::ArrayOf[Spotted::SimplifiedArtistObject] }
+
+          # @!attribute available_markets
+          #   The markets in which the album is available:
+          #   [ISO 3166-1 alpha-2 country codes](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
+          #   _**NOTE**: an album is considered available in a market when at least 1 of its
+          #   tracks is available in that market._
+          #
+          #   @return [Array<String>]
+          required :available_markets, Spotted::Internal::Type::ArrayOf[String]
+
+          # @!attribute external_urls
+          #   Known external URLs for this album.
+          #
+          #   @return [Spotted::Models::ExternalURLObject]
+          required :external_urls, -> { Spotted::ExternalURLObject }
+
+          # @!attribute href
+          #   A link to the Web API endpoint providing full details of the album.
+          #
+          #   @return [String]
+          required :href, String
+
+          # @!attribute images
+          #   The cover art for the album in various sizes, widest first.
+          #
+          #   @return [Array<Spotted::Models::ImageObject>]
+          required :images, -> { Spotted::Internal::Type::ArrayOf[Spotted::ImageObject] }
+
+          # @!attribute name
+          #   The name of the album. In case of an album takedown, the value may be an empty
+          #   string.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute release_date
+          #   The date the album was first released.
+          #
+          #   @return [String]
+          required :release_date, String
+
+          # @!attribute release_date_precision
+          #   The precision with which `release_date` value is known.
+          #
+          #   @return [Symbol, Spotted::Models::BrowseGetNewReleasesResponse::Albums::Item::ReleaseDatePrecision]
+          required :release_date_precision,
+                   enum: -> { Spotted::Models::BrowseGetNewReleasesResponse::Albums::Item::ReleaseDatePrecision }
+
+          # @!attribute total_tracks
+          #   The number of tracks in the album.
+          #
+          #   @return [Integer]
+          required :total_tracks, Integer
+
+          # @!attribute type
+          #   The object type.
+          #
+          #   @return [Symbol, Spotted::Models::BrowseGetNewReleasesResponse::Albums::Item::Type]
+          required :type, enum: -> { Spotted::Models::BrowseGetNewReleasesResponse::Albums::Item::Type }
+
+          # @!attribute uri
+          #   The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+          #   album.
+          #
+          #   @return [String]
+          required :uri, String
+
+          # @!attribute restrictions
+          #   Included in the response when a content restriction is applied.
+          #
+          #   @return [Spotted::Models::AlbumRestrictionObject, nil]
+          optional :restrictions, -> { Spotted::AlbumRestrictionObject }
+
+          # @!method initialize(id:, album_type:, artists:, available_markets:, external_urls:, href:, images:, name:, release_date:, release_date_precision:, total_tracks:, type:, uri:, restrictions: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Spotted::Models::BrowseGetNewReleasesResponse::Albums::Item} for more details.
+          #
+          #   @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the album
+          #
+          #   @param album_type [Symbol, Spotted::Models::BrowseGetNewReleasesResponse::Albums::Item::AlbumType] The type of the album.
+          #
+          #   @param artists [Array<Spotted::Models::SimplifiedArtistObject>] The artists of the album. Each artist object includes a link in `href` to more d
+          #
+          #   @param available_markets [Array<String>] The markets in which the album is available: [ISO 3166-1 alpha-2 country codes](
+          #
+          #   @param external_urls [Spotted::Models::ExternalURLObject] Known external URLs for this album.
+          #
+          #   @param href [String] A link to the Web API endpoint providing full details of the album.
+          #
+          #   @param images [Array<Spotted::Models::ImageObject>] The cover art for the album in various sizes, widest first.
+          #
+          #   @param name [String] The name of the album. In case of an album takedown, the value may be an empty s
+          #
+          #   @param release_date [String] The date the album was first released.
+          #
+          #   @param release_date_precision [Symbol, Spotted::Models::BrowseGetNewReleasesResponse::Albums::Item::ReleaseDatePrecision] The precision with which `release_date` value is known.
+          #
+          #   @param total_tracks [Integer] The number of tracks in the album.
+          #
+          #   @param type [Symbol, Spotted::Models::BrowseGetNewReleasesResponse::Albums::Item::Type] The object type.
+          #
+          #   @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the albu
+          #
+          #   @param restrictions [Spotted::Models::AlbumRestrictionObject] Included in the response when a content restriction is applied.
+
+          # The type of the album.
+          #
+          # @see Spotted::Models::BrowseGetNewReleasesResponse::Albums::Item#album_type
+          module AlbumType
+            extend Spotted::Internal::Type::Enum
+
+            ALBUM = :album
+            SINGLE = :single
+            COMPILATION = :compilation
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The precision with which `release_date` value is known.
+          #
+          # @see Spotted::Models::BrowseGetNewReleasesResponse::Albums::Item#release_date_precision
+          module ReleaseDatePrecision
+            extend Spotted::Internal::Type::Enum
+
+            YEAR = :year
+            MONTH = :month
+            DAY = :day
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The object type.
+          #
+          # @see Spotted::Models::BrowseGetNewReleasesResponse::Albums::Item#type
+          module Type
+            extend Spotted::Internal::Type::Enum
+
+            ALBUM = :album
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spotted/models/chapter_list_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Chapters#list
+    class ChapterListParams < Spotted::Internal::Type::BaseModel
+      extend Spotted::Internal::Type::RequestParameters::Converter
+      include Spotted::Internal::Type::RequestParameters
+
+      # @!attribute ids
+      #   A comma-separated list of the
+      #   [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+      #   `ids=0IsXVP0JmcB2adSE338GkK,3ZXb8FKZGU0EHALYX6uCzU`. Maximum: 50 IDs.
+      #
+      #   @return [String]
+      required :ids, String
+
+      # @!attribute market
+      #   An
+      #   [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
+      #   If a country code is specified, only content that is available in that market
+      #   will be returned.<br/> If a valid user access token is specified in the request
+      #   header, the country associated with the user account will take priority over
+      #   this parameter.<br/> _**Note**: If neither market or user country are provided,
+      #   the content is considered unavailable for the client._<br/> Users can view the
+      #   country that is associated with their account in the
+      #   [account settings](https://www.spotify.com/account/overview/).
+      #
+      #   @return [String, nil]
+      optional :market, String
+
+      # @!method initialize(ids:, market: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::ChapterListParams} for more details.
+      #
+      #   @param ids [String] A comma-separated list of the [Spotify IDs](/documentation/web-api/concepts/spot
+      #
+      #   @param market [String] An [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_al
+      #
+      #   @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end