spotted 0.1.0

data/lib/spotted/models/show_list_episodes_params.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Shows#list_episodes
+    class ShowListEpisodesParams < 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 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
+
+      # @!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, market: nil, offset: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::ShowListEpisodesParams} for more details.
+      #
+      #   @param limit [Integer] The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+      #
+      #   @param market [String] An [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_al
+      #
+      #   @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/show_list_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Shows#list
+    class ShowListParams < 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 the shows.
+      #   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::ShowListParams} 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

data/lib/spotted/models/show_list_response.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Shows#list
+    class ShowListResponse < Spotted::Internal::Type::BaseModel
+      # @!attribute shows
+      #
+      #   @return [Array<Spotted::Models::ShowListResponse::Show>]
+      required :shows, -> { Spotted::Internal::Type::ArrayOf[Spotted::Models::ShowListResponse::Show] }
+
+      # @!method initialize(shows:)
+      #   @param shows [Array<Spotted::Models::ShowListResponse::Show>]
+
+      class Show < Spotted::Internal::Type::BaseModel
+        # @!attribute id
+        #   The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the show.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute available_markets
+        #   A list of the countries in which the show 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 copyrights
+        #   The copyright statements of the show.
+        #
+        #   @return [Array<Spotted::Models::CopyrightObject>]
+        required :copyrights, -> { Spotted::Internal::Type::ArrayOf[Spotted::CopyrightObject] }
+
+        # @!attribute description
+        #   A description of the show. 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 show 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 show.
+        #
+        #   @return [Spotted::Models::ExternalURLObject]
+        required :external_urls, -> { Spotted::ExternalURLObject }
+
+        # @!attribute href
+        #   A link to the Web API endpoint providing full details of the show.
+        #
+        #   @return [String]
+        required :href, String
+
+        # @!attribute html_description
+        #   A description of the show. This field may contain HTML tags.
+        #
+        #   @return [String]
+        required :html_description, String
+
+        # @!attribute images
+        #   The cover art for the show in various sizes, widest first.
+        #
+        #   @return [Array<Spotted::Models::ImageObject>]
+        required :images, -> { Spotted::Internal::Type::ArrayOf[Spotted::ImageObject] }
+
+        # @!attribute is_externally_hosted
+        #   True if all of the shows episodes are hosted outside of Spotify's CDN. This
+        #   field might be `null` in some cases.
+        #
+        #   @return [Boolean]
+        required :is_externally_hosted, Spotted::Internal::Type::Boolean
+
+        # @!attribute languages
+        #   A list of the languages used in the show, 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 show.
+        #
+        #   @return [String]
+        required :media_type, String
+
+        # @!attribute name
+        #   The name of the episode.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute publisher
+        #   The publisher of the show.
+        #
+        #   @return [String]
+        required :publisher, String
+
+        # @!attribute total_episodes
+        #   The total number of episodes in the show.
+        #
+        #   @return [Integer]
+        required :total_episodes, Integer
+
+        # @!attribute type
+        #   The object type.
+        #
+        #   @return [Symbol, Spotted::Models::ShowListResponse::Show::Type]
+        required :type, enum: -> { Spotted::Models::ShowListResponse::Show::Type }
+
+        # @!attribute uri
+        #   The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+        #   show.
+        #
+        #   @return [String]
+        required :uri, String
+
+        # @!method initialize(id:, available_markets:, copyrights:, description:, explicit:, external_urls:, href:, html_description:, images:, is_externally_hosted:, languages:, media_type:, name:, publisher:, total_episodes:, type:, uri:)
+        #   Some parameter documentations has been truncated, see
+        #   {Spotted::Models::ShowListResponse::Show} for more details.
+        #
+        #   @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the show.
+        #
+        #   @param available_markets [Array<String>] A list of the countries in which the show can be played, identified by their [IS
+        #
+        #   @param copyrights [Array<Spotted::Models::CopyrightObject>] The copyright statements of the show.
+        #
+        #   @param description [String] A description of the show. HTML tags are stripped away from this field, use `htm
+        #
+        #   @param explicit [Boolean] Whether or not the show has explicit content (true = yes it does; false = no it
+        #
+        #   @param external_urls [Spotted::Models::ExternalURLObject] External URLs for this show.
+        #
+        #   @param href [String] A link to the Web API endpoint providing full details of the show.
+        #
+        #   @param html_description [String] A description of the show. This field may contain HTML tags.
+        #
+        #   @param images [Array<Spotted::Models::ImageObject>] The cover art for the show in various sizes, widest first.
+        #
+        #   @param is_externally_hosted [Boolean] True if all of the shows episodes are hosted outside of Spotify's CDN. This fiel
+        #
+        #   @param languages [Array<String>] A list of the languages used in the show, identified by their [ISO 639](https://
+        #
+        #   @param media_type [String] The media type of the show.
+        #
+        #   @param name [String] The name of the episode.
+        #
+        #   @param publisher [String] The publisher of the show.
+        #
+        #   @param total_episodes [Integer] The total number of episodes in the show.
+        #
+        #   @param type [Symbol, Spotted::Models::ShowListResponse::Show::Type] The object type.
+        #
+        #   @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the show
+
+        # The object type.
+        #
+        # @see Spotted::Models::ShowListResponse::Show#type
+        module Type
+          extend Spotted::Internal::Type::Enum
+
+          SHOW = :show
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/spotted/models/show_retrieve_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Shows#retrieve
+    class ShowRetrieveParams < 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::ShowRetrieveParams} 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/show_retrieve_response.rb

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Shows#retrieve
+    class ShowRetrieveResponse < Spotted::Internal::Type::BaseModel
+      # @!attribute id
+      #   The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the show.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute available_markets
+      #   A list of the countries in which the show 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 copyrights
+      #   The copyright statements of the show.
+      #
+      #   @return [Array<Spotted::Models::CopyrightObject>]
+      required :copyrights, -> { Spotted::Internal::Type::ArrayOf[Spotted::CopyrightObject] }
+
+      # @!attribute description
+      #   A description of the show. HTML tags are stripped away from this field, use
+      #   `html_description` field in case HTML tags are needed.
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!attribute episodes
+      #   The episodes of the show.
+      #
+      #   @return [Spotted::Models::ShowRetrieveResponse::Episodes]
+      required :episodes, -> { Spotted::Models::ShowRetrieveResponse::Episodes }
+
+      # @!attribute explicit
+      #   Whether or not the show 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 show.
+      #
+      #   @return [Spotted::Models::ExternalURLObject]
+      required :external_urls, -> { Spotted::ExternalURLObject }
+
+      # @!attribute href
+      #   A link to the Web API endpoint providing full details of the show.
+      #
+      #   @return [String]
+      required :href, String
+
+      # @!attribute html_description
+      #   A description of the show. This field may contain HTML tags.
+      #
+      #   @return [String]
+      required :html_description, String
+
+      # @!attribute images
+      #   The cover art for the show in various sizes, widest first.
+      #
+      #   @return [Array<Spotted::Models::ImageObject>]
+      required :images, -> { Spotted::Internal::Type::ArrayOf[Spotted::ImageObject] }
+
+      # @!attribute is_externally_hosted
+      #   True if all of the shows episodes are hosted outside of Spotify's CDN. This
+      #   field might be `null` in some cases.
+      #
+      #   @return [Boolean]
+      required :is_externally_hosted, Spotted::Internal::Type::Boolean
+
+      # @!attribute languages
+      #   A list of the languages used in the show, 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 show.
+      #
+      #   @return [String]
+      required :media_type, String
+
+      # @!attribute name
+      #   The name of the episode.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute publisher
+      #   The publisher of the show.
+      #
+      #   @return [String]
+      required :publisher, String
+
+      # @!attribute total_episodes
+      #   The total number of episodes in the show.
+      #
+      #   @return [Integer]
+      required :total_episodes, Integer
+
+      # @!attribute type
+      #   The object type.
+      #
+      #   @return [Symbol, Spotted::Models::ShowRetrieveResponse::Type]
+      required :type, enum: -> { Spotted::Models::ShowRetrieveResponse::Type }
+
+      # @!attribute uri
+      #   The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+      #   show.
+      #
+      #   @return [String]
+      required :uri, String
+
+      # @!method initialize(id:, available_markets:, copyrights:, description:, episodes:, explicit:, external_urls:, href:, html_description:, images:, is_externally_hosted:, languages:, media_type:, name:, publisher:, total_episodes:, type:, uri:)
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::ShowRetrieveResponse} for more details.
+      #
+      #   @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the show.
+      #
+      #   @param available_markets [Array<String>] A list of the countries in which the show can be played, identified by their [IS
+      #
+      #   @param copyrights [Array<Spotted::Models::CopyrightObject>] The copyright statements of the show.
+      #
+      #   @param description [String] A description of the show. HTML tags are stripped away from this field, use `htm
+      #
+      #   @param episodes [Spotted::Models::ShowRetrieveResponse::Episodes] The episodes of the show.
+      #
+      #   @param explicit [Boolean] Whether or not the show has explicit content (true = yes it does; false = no it
+      #
+      #   @param external_urls [Spotted::Models::ExternalURLObject] External URLs for this show.
+      #
+      #   @param href [String] A link to the Web API endpoint providing full details of the show.
+      #
+      #   @param html_description [String] A description of the show. This field may contain HTML tags.
+      #
+      #   @param images [Array<Spotted::Models::ImageObject>] The cover art for the show in various sizes, widest first.
+      #
+      #   @param is_externally_hosted [Boolean] True if all of the shows episodes are hosted outside of Spotify's CDN. This fiel
+      #
+      #   @param languages [Array<String>] A list of the languages used in the show, identified by their [ISO 639](https://
+      #
+      #   @param media_type [String] The media type of the show.
+      #
+      #   @param name [String] The name of the episode.
+      #
+      #   @param publisher [String] The publisher of the show.
+      #
+      #   @param total_episodes [Integer] The total number of episodes in the show.
+      #
+      #   @param type [Symbol, Spotted::Models::ShowRetrieveResponse::Type] The object type.
+      #
+      #   @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the show
+
+      # @see Spotted::Models::ShowRetrieveResponse#episodes
+      class Episodes < 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::SimplifiedEpisodeObject>]
+        required :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::SimplifiedEpisodeObject] }
+
+        # @!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::ShowRetrieveResponse::Episodes} for more details.
+        #
+        #   The episodes of the show.
+        #
+        #   @param href [String] A link to the Web API endpoint returning the full result of the request
+        #
+        #   @param items [Array<Spotted::Models::SimplifiedEpisodeObject>]
+        #
+        #   @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::ShowRetrieveResponse#type
+      module Type
+        extend Spotted::Internal::Type::Enum
+
+        SHOW = :show
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/spotted/models/simplified_artist_object.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    class SimplifiedArtistObject < Spotted::Internal::Type::BaseModel
+      # @!attribute id
+      #   The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+      #   artist.
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute external_urls
+      #   Known external URLs for this artist.
+      #
+      #   @return [Spotted::Models::ExternalURLObject, nil]
+      optional :external_urls, -> { Spotted::ExternalURLObject }
+
+      # @!attribute href
+      #   A link to the Web API endpoint providing full details of the artist.
+      #
+      #   @return [String, nil]
+      optional :href, String
+
+      # @!attribute name
+      #   The name of the artist.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute type
+      #   The object type.
+      #
+      #   @return [Symbol, Spotted::Models::SimplifiedArtistObject::Type, nil]
+      optional :type, enum: -> { Spotted::SimplifiedArtistObject::Type }
+
+      # @!attribute uri
+      #   The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+      #   artist.
+      #
+      #   @return [String, nil]
+      optional :uri, String
+
+      # @!method initialize(id: nil, external_urls: nil, href: nil, name: nil, type: nil, uri: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Spotted::Models::SimplifiedArtistObject} for more details.
+      #
+      #   @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the artis
+      #
+      #   @param external_urls [Spotted::Models::ExternalURLObject] Known external URLs for this artist.
+      #
+      #   @param href [String] A link to the Web API endpoint providing full details of the artist.
+      #
+      #   @param name [String] The name of the artist.
+      #
+      #   @param type [Symbol, Spotted::Models::SimplifiedArtistObject::Type] The object type.
+      #
+      #   @param uri [String] The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the arti
+
+      # The object type.
+      #
+      # @see Spotted::Models::SimplifiedArtistObject#type
+      module Type
+        extend Spotted::Internal::Type::Enum
+
+        ARTIST = :artist
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end