spotted 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67ece5e6ee4843b9441e3846cbbaf8e60ef18d5e02b554df581393cebdbccf97
-  data.tar.gz: f392bfcd4da1fbf4bcf8dc54ced78c85538177d817fd784ef717774f9e7d5245
+  metadata.gz: 91530c48ebb30c600d7d752cd7bd8af576c61ecbf7fc96e75e711bdd6c0140ae
+  data.tar.gz: 490542cb593197ae9b549cf1d90aa86f92a7dde031f98674d7cf0e8e729115e3
 SHA512:
-  metadata.gz: 4d55e8a6eb42dbcc2f0adcbc5eb80c3c4046fd396bf33fa5a919f7d7c16f242ee1e8037acaa3d20f6dc7b4dfe66cab143f2acc6addf70edf160566c6bd612d5d
-  data.tar.gz: c6cf2a63e8298aec44d8eefa75d064b86578d890341d69e479a0ebef3f9dad15f92a4d18304c5a0bf26f13e3c2e03a3e92eb475db7236a0c8f378544f0ceff62
+  metadata.gz: 5a6b5967c6a30d9087ef75f03a3bf79fe668e6499488c23ef43d508ea179882025b71e9b442d98fdea7fb3c22e8ca97d2cce542f5a5fe2236c6ac81c65f7334a
+  data.tar.gz: 8fcfd021416b668b3de6b3311a7ad456ce0279d4f696cd391450702959003fcb95a9f27ba2d804eb6c3f7aa13937a12ad056db410dd87e3f172b880a63323d1f

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.2.0 (2025-10-24)
+
+Full Changelog: [v0.1.0...v0.2.0](https://github.com/cjavdev/spotted/compare/v0.1.0...v0.2.0)
+
+### Features
+
+* **api:** manual updates ([1dd209e](https://github.com/cjavdev/spotted/commit/1dd209e8c3d1f609d7d3cee090e0663a3c790a02))
+
 ## 0.1.0 (2025-10-24)
 
 Full Changelog: [v0.0.1...v0.1.0](https://github.com/cjavdev/spotted/compare/v0.0.1...v0.1.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "spotted", "~> 0.1.0"
+gem "spotted", "~> 0.2.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/spotted/models/audiobook_base.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    class AudiobookBase < 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 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::AudiobookBase::Type]
+      required :type, enum: -> { Spotted::AudiobookBase::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:, 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::AudiobookBase} 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 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::AudiobookBase::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.
+
+      # The object type.
+      #
+      # @see Spotted::Models::AudiobookBase#type
+      module Type
+        extend Spotted::Internal::Type::Enum
+
+        AUDIOBOOK = :audiobook
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/spotted/models/audiobook_list_response.rb

@@ -13,179 +13,19 @@ module Spotted
       # @!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]
-
+      class Audiobook < Spotted::Models::AudiobookBase
         # @!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)
+        # @!method initialize(chapters:)
         #   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
@@ -248,18 +88,6 @@ module Spotted
           #
           #   @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

data/lib/spotted/models/audiobook_retrieve_response.rb

@@ -3,179 +3,19 @@
 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]
-
+    class AudiobookRetrieveResponse < Spotted::Models::AudiobookBase
       # @!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)
+      # @!method initialize(chapters:)
       #   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
@@ -238,18 +78,6 @@ module Spotted
         #
         #   @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