spotted 0.1.0

data/lib/spotted/models/audiobook_list_response.rb

@@ -0,0 +1,266 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Audiobooks#list
+    class AudiobookListResponse < Spotted::Internal::Type::BaseModel
+      # @!attribute audiobooks
+      #
+      #   @return [Array<Spotted::Models::AudiobookListResponse::Audiobook>]
+      required :audiobooks,
+               -> { Spotted::Internal::Type::ArrayOf[Spotted::Models::AudiobookListResponse::Audiobook] }
+
+      # @!method initialize(audiobooks:)
+      #   @param audiobooks [Array<Spotted::Models::AudiobookListResponse::Audiobook>]
+
+      class Audiobook < Spotted::Internal::Type::BaseModel
+        # @!attribute id
+        #   The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+        #   audiobook.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute authors
+        #   The author(s) for the audiobook.
+        #
+        #   @return [Array<Spotted::Models::AuthorObject>]
+        required :authors, -> { Spotted::Internal::Type::ArrayOf[Spotted::AuthorObject] }
+
+        # @!attribute available_markets
+        #   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>]
+        required :available_markets, Spotted::Internal::Type::ArrayOf[String]
+
+        # @!attribute chapters
+        #   The chapters of the audiobook.
+        #
+        #   @return [Spotted::Models::AudiobookListResponse::Audiobook::Chapters]
+        required :chapters, -> { Spotted::Models::AudiobookListResponse::Audiobook::Chapters }
+
+        # @!attribute copyrights
+        #   The copyright statements of the audiobook.
+        #
+        #   @return [Array<Spotted::Models::CopyrightObject>]
+        required :copyrights, -> { Spotted::Internal::Type::ArrayOf[Spotted::CopyrightObject] }
+
+        # @!attribute description
+        #   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]
+        required :description, String
+
+        # @!attribute explicit
+        #   Whether or not the audiobook has explicit content (true = yes it does; false =
+        #   no it does not OR unknown).
+        #
+        #   @return [Boolean]
+        required :explicit, Spotted::Internal::Type::Boolean
+
+        # @!attribute external_urls
+        #   External URLs for this audiobook.
+        #
+        #   @return [Spotted::Models::ExternalURLObject]
+        required :external_urls, -> { Spotted::ExternalURLObject }
+
+        # @!attribute href
+        #   A link to the Web API endpoint providing full details of the audiobook.
+        #
+        #   @return [String]
+        required :href, String
+
+        # @!attribute html_description
+        #   A description of the audiobook. This field may contain HTML tags.
+        #
+        #   @return [String]
+        required :html_description, String
+
+        # @!attribute images
+        #   The cover art for the audiobook in various sizes, widest first.
+        #
+        #   @return [Array<Spotted::Models::ImageObject>]
+        required :images, -> { Spotted::Internal::Type::ArrayOf[Spotted::ImageObject] }
+
+        # @!attribute languages
+        #   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>]
+        required :languages, Spotted::Internal::Type::ArrayOf[String]
+
+        # @!attribute media_type
+        #   The media type of the audiobook.
+        #
+        #   @return [String]
+        required :media_type, String
+
+        # @!attribute name
+        #   The name of the audiobook.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute narrators
+        #   The narrator(s) for the audiobook.
+        #
+        #   @return [Array<Spotted::Models::NarratorObject>]
+        required :narrators, -> { Spotted::Internal::Type::ArrayOf[Spotted::NarratorObject] }
+
+        # @!attribute publisher
+        #   The publisher of the audiobook.
+        #
+        #   @return [String]
+        required :publisher, String
+
+        # @!attribute total_chapters
+        #   The number of chapters in this audiobook.
+        #
+        #   @return [Integer]
+        required :total_chapters, Integer
+
+        # @!attribute type
+        #   The object type.
+        #
+        #   @return [Symbol, Spotted::Models::AudiobookListResponse::Audiobook::Type]
+        required :type, enum: -> { Spotted::Models::AudiobookListResponse::Audiobook::Type }
+
+        # @!attribute uri
+        #   The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+        #   audiobook.
+        #
+        #   @return [String]
+        required :uri, String
+
+        # @!attribute edition
+        #   The edition of the audiobook.
+        #
+        #   @return [String, nil]
+        optional :edition, String
+
+        # @!method initialize(id:, authors:, available_markets:, chapters:, copyrights:, description:, explicit:, external_urls:, href:, html_description:, images:, languages:, media_type:, name:, narrators:, publisher:, total_chapters:, type:, uri:, edition: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::AudiobookListResponse::Audiobook} for more details.
+        #
+        #   @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the audio
+        #
+        #   @param authors [Array<Spotted::Models::AuthorObject>] The author(s) for the audiobook.
+        #
+        #   @param available_markets [Array<String>] A list of the countries in which the audiobook can be played, identified by thei
+        #
+        #   @param chapters [Spotted::Models::AudiobookListResponse::Audiobook::Chapters] The chapters of the audiobook.
+        #
+        #   @param copyrights [Array<Spotted::Models::CopyrightObject>] The copyright statements of the audiobook.
+        #
+        #   @param description [String] A description of the audiobook. HTML tags are stripped away from this field, use
+        #
+        #   @param explicit [Boolean] Whether or not the audiobook has explicit content (true = yes it does; false = n
+        #
+        #   @param external_urls [Spotted::Models::ExternalURLObject] External URLs for this audiobook.
+        #
+        #   @param href [String] A link to the Web API endpoint providing full details of the audiobook.
+        #
+        #   @param html_description [String] A description of the audiobook. This field may contain HTML tags.
+        #
+        #   @param images [Array<Spotted::Models::ImageObject>] The cover art for the audiobook in various sizes, widest first.
+        #
+        #   @param languages [Array<String>] A list of the languages used in the audiobook, identified by their [ISO 639](htt
+        #
+        #   @param media_type [String] The media type of the audiobook.
+        #
+        #   @param name [String] The name of the audiobook.
+        #
+        #   @param narrators [Array<Spotted::Models::NarratorObject>] The narrator(s) for the audiobook.
+        #
+        #   @param publisher [String] The publisher of the audiobook.
+        #
+        #   @param total_chapters [Integer] The number of chapters in this audiobook.
+        #
+        #   @param type [Symbol, Spotted::Models::AudiobookListResponse::Audiobook::Type] The object type.
+        #
+        #   @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the audi
+        #
+        #   @param edition [String] The edition of the audiobook.
+
+        # @see Spotted::Models::AudiobookListResponse::Audiobook#chapters
+        class Chapters < 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::SimplifiedChapterObject>]
+          required :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::SimplifiedChapterObject] }
+
+          # @!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::AudiobookListResponse::Audiobook::Chapters} for more details.
+          #
+          #   The chapters of the audiobook.
+          #
+          #   @param href [String] A link to the Web API endpoint returning the full result of the request
+          #
+          #   @param items [Array<Spotted::Models::SimplifiedChapterObject>]
+          #
+          #   @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.
+        end
+
+        # The object type.
+        #
+        # @see Spotted::Models::AudiobookListResponse::Audiobook#type
+        module Type
+          extend Spotted::Internal::Type::Enum
+
+          AUDIOBOOK = :audiobook
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/spotted/models/audiobook_retrieve_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Audiobooks#retrieve
+    class AudiobookRetrieveParams < Spotted::Internal::Type::BaseModel
+      extend Spotted::Internal::Type::RequestParameters::Converter
+      include Spotted::Internal::Type::RequestParameters
+
+      # @!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(market: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::AudiobookRetrieveParams} for more details.
+      #
+      #   @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

data/lib/spotted/models/audiobook_retrieve_response.rb

@@ -0,0 +1,255 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Audiobooks#retrieve
+    class AudiobookRetrieveResponse < Spotted::Internal::Type::BaseModel
+      # @!attribute id
+      #   The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+      #   audiobook.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute authors
+      #   The author(s) for the audiobook.
+      #
+      #   @return [Array<Spotted::Models::AuthorObject>]
+      required :authors, -> { Spotted::Internal::Type::ArrayOf[Spotted::AuthorObject] }
+
+      # @!attribute available_markets
+      #   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>]
+      required :available_markets, Spotted::Internal::Type::ArrayOf[String]
+
+      # @!attribute chapters
+      #   The chapters of the audiobook.
+      #
+      #   @return [Spotted::Models::AudiobookRetrieveResponse::Chapters]
+      required :chapters, -> { Spotted::Models::AudiobookRetrieveResponse::Chapters }
+
+      # @!attribute copyrights
+      #   The copyright statements of the audiobook.
+      #
+      #   @return [Array<Spotted::Models::CopyrightObject>]
+      required :copyrights, -> { Spotted::Internal::Type::ArrayOf[Spotted::CopyrightObject] }
+
+      # @!attribute description
+      #   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]
+      required :description, String
+
+      # @!attribute explicit
+      #   Whether or not the audiobook has explicit content (true = yes it does; false =
+      #   no it does not OR unknown).
+      #
+      #   @return [Boolean]
+      required :explicit, Spotted::Internal::Type::Boolean
+
+      # @!attribute external_urls
+      #   External URLs for this audiobook.
+      #
+      #   @return [Spotted::Models::ExternalURLObject]
+      required :external_urls, -> { Spotted::ExternalURLObject }
+
+      # @!attribute href
+      #   A link to the Web API endpoint providing full details of the audiobook.
+      #
+      #   @return [String]
+      required :href, String
+
+      # @!attribute html_description
+      #   A description of the audiobook. This field may contain HTML tags.
+      #
+      #   @return [String]
+      required :html_description, String
+
+      # @!attribute images
+      #   The cover art for the audiobook in various sizes, widest first.
+      #
+      #   @return [Array<Spotted::Models::ImageObject>]
+      required :images, -> { Spotted::Internal::Type::ArrayOf[Spotted::ImageObject] }
+
+      # @!attribute languages
+      #   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>]
+      required :languages, Spotted::Internal::Type::ArrayOf[String]
+
+      # @!attribute media_type
+      #   The media type of the audiobook.
+      #
+      #   @return [String]
+      required :media_type, String
+
+      # @!attribute name
+      #   The name of the audiobook.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute narrators
+      #   The narrator(s) for the audiobook.
+      #
+      #   @return [Array<Spotted::Models::NarratorObject>]
+      required :narrators, -> { Spotted::Internal::Type::ArrayOf[Spotted::NarratorObject] }
+
+      # @!attribute publisher
+      #   The publisher of the audiobook.
+      #
+      #   @return [String]
+      required :publisher, String
+
+      # @!attribute total_chapters
+      #   The number of chapters in this audiobook.
+      #
+      #   @return [Integer]
+      required :total_chapters, Integer
+
+      # @!attribute type
+      #   The object type.
+      #
+      #   @return [Symbol, Spotted::Models::AudiobookRetrieveResponse::Type]
+      required :type, enum: -> { Spotted::Models::AudiobookRetrieveResponse::Type }
+
+      # @!attribute uri
+      #   The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+      #   audiobook.
+      #
+      #   @return [String]
+      required :uri, String
+
+      # @!attribute edition
+      #   The edition of the audiobook.
+      #
+      #   @return [String, nil]
+      optional :edition, String
+
+      # @!method initialize(id:, authors:, available_markets:, chapters:, copyrights:, description:, explicit:, external_urls:, href:, html_description:, images:, languages:, media_type:, name:, narrators:, publisher:, total_chapters:, type:, uri:, edition: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::AudiobookRetrieveResponse} for more details.
+      #
+      #   @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the audio
+      #
+      #   @param authors [Array<Spotted::Models::AuthorObject>] The author(s) for the audiobook.
+      #
+      #   @param available_markets [Array<String>] A list of the countries in which the audiobook can be played, identified by thei
+      #
+      #   @param chapters [Spotted::Models::AudiobookRetrieveResponse::Chapters] The chapters of the audiobook.
+      #
+      #   @param copyrights [Array<Spotted::Models::CopyrightObject>] The copyright statements of the audiobook.
+      #
+      #   @param description [String] A description of the audiobook. HTML tags are stripped away from this field, use
+      #
+      #   @param explicit [Boolean] Whether or not the audiobook has explicit content (true = yes it does; false = n
+      #
+      #   @param external_urls [Spotted::Models::ExternalURLObject] External URLs for this audiobook.
+      #
+      #   @param href [String] A link to the Web API endpoint providing full details of the audiobook.
+      #
+      #   @param html_description [String] A description of the audiobook. This field may contain HTML tags.
+      #
+      #   @param images [Array<Spotted::Models::ImageObject>] The cover art for the audiobook in various sizes, widest first.
+      #
+      #   @param languages [Array<String>] A list of the languages used in the audiobook, identified by their [ISO 639](htt
+      #
+      #   @param media_type [String] The media type of the audiobook.
+      #
+      #   @param name [String] The name of the audiobook.
+      #
+      #   @param narrators [Array<Spotted::Models::NarratorObject>] The narrator(s) for the audiobook.
+      #
+      #   @param publisher [String] The publisher of the audiobook.
+      #
+      #   @param total_chapters [Integer] The number of chapters in this audiobook.
+      #
+      #   @param type [Symbol, Spotted::Models::AudiobookRetrieveResponse::Type] The object type.
+      #
+      #   @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the audi
+      #
+      #   @param edition [String] The edition of the audiobook.
+
+      # @see Spotted::Models::AudiobookRetrieveResponse#chapters
+      class Chapters < 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::SimplifiedChapterObject>]
+        required :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::SimplifiedChapterObject] }
+
+        # @!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::AudiobookRetrieveResponse::Chapters} for more details.
+        #
+        #   The chapters of the audiobook.
+        #
+        #   @param href [String] A link to the Web API endpoint returning the full result of the request
+        #
+        #   @param items [Array<Spotted::Models::SimplifiedChapterObject>]
+        #
+        #   @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.
+      end
+
+      # The object type.
+      #
+      # @see Spotted::Models::AudiobookRetrieveResponse#type
+      module Type
+        extend Spotted::Internal::Type::Enum
+
+        AUDIOBOOK = :audiobook
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/spotted/models/author_object.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    class AuthorObject < Spotted::Internal::Type::BaseModel
+      # @!attribute name
+      #   The name of the author.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!method initialize(name: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::AuthorObject} for more details.
+      #
+      #   @param name [String] The name of the author.
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    module Browse
+      # @see Spotted::Resources::Browse::Categories#get_playlists
+      class CategoryGetPlaylistsParams < 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::Browse::CategoryGetPlaylistsParams} 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
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    module Browse
+      # @see Spotted::Resources::Browse::Categories#get_playlists
+      class CategoryGetPlaylistsResponse < 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::Browse::CategoryGetPlaylistsResponse} for more details.
+        #
+        #   @param message [String] The localized message of a playlist.
+        #
+        #   @param playlists [Spotted::Models::PagingPlaylistObject]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    module Browse
+      # @see Spotted::Resources::Browse::Categories#list
+      class CategoryListParams < 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::Browse::CategoryListParams} 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
+end