spotted 0.1.0 → 0.3.0

data/lib/spotted/models/show_list_response.rb

@@ -6,171 +6,11 @@ module Spotted
     class ShowListResponse < Spotted::Internal::Type::BaseModel
       # @!attribute shows
       #
-      #   @return [Array<Spotted::Models::ShowListResponse::Show>]
-      required :shows, -> { Spotted::Internal::Type::ArrayOf[Spotted::Models::ShowListResponse::Show] }
+      #   @return [Array<Spotted::Models::ShowBase>]
+      required :shows, -> { Spotted::Internal::Type::ArrayOf[Spotted::ShowBase] }
 
       # @!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
+      #   @param shows [Array<Spotted::Models::ShowBase>]
     end
   end
 end

data/lib/spotted/models/show_retrieve_response.rb

@@ -3,162 +3,19 @@
 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
-
+    class ShowRetrieveResponse < Spotted::Models::ShowBase
       # @!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:)
+      # @!method initialize(episodes:)
       #   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
@@ -221,18 +78,6 @@ module Spotted
         #
         #   @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/unwrap_webhook_event.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @type [Spotted::Internal::Type::Converter]
+    UnwrapWebhookEvent = Spotted::Internal::Type::Unknown
+  end
+end

data/lib/spotted/models/webhook_unwrap_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Models
+    # @see Spotted::Resources::Webhooks#unwrap
+    class WebhookUnwrapParams < Spotted::Internal::Type::BaseModel
+      extend Spotted::Internal::Type::RequestParameters::Converter
+      include Spotted::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/spotted/models.rb

@@ -61,6 +61,8 @@ module Spotted
 
   AudioAnalysisRetrieveParams = Spotted::Models::AudioAnalysisRetrieveParams
 
+  AudiobookBase = Spotted::Models::AudiobookBase
+
   AudiobookListChaptersParams = Spotted::Models::AudiobookListChaptersParams
 
   AudiobookListParams = Spotted::Models::AudiobookListParams
@@ -136,6 +138,8 @@ module Spotted
 
   SearchRetrieveParams = Spotted::Models::SearchRetrieveParams
 
+  ShowBase = Spotted::Models::ShowBase
+
   ShowListEpisodesParams = Spotted::Models::ShowListEpisodesParams
 
   ShowListParams = Spotted::Models::ShowListParams
@@ -162,7 +166,12 @@ module Spotted
 
   TrackRetrieveParams = Spotted::Models::TrackRetrieveParams
 
+  # @type [Spotted::Internal::Type::Converter]
+  UnwrapWebhookEvent = Spotted::Models::UnwrapWebhookEvent
+
   UserRetrieveProfileParams = Spotted::Models::UserRetrieveProfileParams
 
   Users = Spotted::Models::Users
+
+  WebhookUnwrapParams = Spotted::Models::WebhookUnwrapParams
 end

data/lib/spotted/resources/webhooks.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Resources
+    class Webhooks
+      # @param payload [String] The raw webhook payload as a string
+      #
+      # @return [Object]
+      def unwrap(payload)
+        parsed = JSON.parse(payload, symbolize_names: true)
+        Spotted::Internal::Type::Converter.coerce(Spotted::Models::UnwrapWebhookEvent, parsed)
+      end
+
+      # @api private
+      #
+      # @param client [Spotted::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/spotted/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spotted
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/spotted.rb

@@ -54,7 +54,9 @@ require_relative "spotted/internal/transport/pooled_net_requester"
 require_relative "spotted/client"
 require_relative "spotted/internal/oauth2"
 require_relative "spotted/internal/cursor_url_page"
+require_relative "spotted/models/audiobook_base"
 require_relative "spotted/models/playlist_user_object"
+require_relative "spotted/models/show_base"
 require_relative "spotted/models/album_list_params"
 require_relative "spotted/models/album_list_response"
 require_relative "spotted/models/album_list_tracks_params"
@@ -218,11 +220,13 @@ require_relative "spotted/models/track_list_response"
 require_relative "spotted/models/track_object"
 require_relative "spotted/models/track_restriction_object"
 require_relative "spotted/models/track_retrieve_params"
+require_relative "spotted/models/unwrap_webhook_event"
 require_relative "spotted/models/user_retrieve_profile_params"
 require_relative "spotted/models/user_retrieve_profile_response"
 require_relative "spotted/models/users/playlist_create_params"
 require_relative "spotted/models/users/playlist_create_response"
 require_relative "spotted/models/users/playlist_list_params"
+require_relative "spotted/models/webhook_unwrap_params"
 require_relative "spotted/models"
 require_relative "spotted/resources/albums"
 require_relative "spotted/resources/artists"
@@ -255,3 +259,4 @@ require_relative "spotted/resources/shows"
 require_relative "spotted/resources/tracks"
 require_relative "spotted/resources/users"
 require_relative "spotted/resources/users/playlists"
+require_relative "spotted/resources/webhooks"

data/rbi/spotted/client.rbi

@@ -61,6 +61,9 @@ module Spotted
     sig { returns(Spotted::Resources::Recommendations) }
     attr_reader :recommendations
 
+    sig { returns(Spotted::Resources::Webhooks) }
+    attr_reader :webhooks
+
     sig { returns(Spotted::Resources::Markets) }
     attr_reader :markets
 

data/rbi/spotted/internal/transport/base_client.rbi

@@ -176,6 +176,11 @@ module Spotted
         private def auth_headers
         end
 
+        # @api private
+        sig { returns(String) }
+        private def user_agent
+        end
+
         # @api private
         sig { returns(String) }
         private def generate_idempotency_key

data/rbi/spotted/internal/type/base_model.rbi

@@ -31,7 +31,7 @@ module Spotted
           #
           # Assumes superclass fields are totally defined before fields are accessed /
           # defined on subclasses.
-          sig { params(child: T.self_type).void }
+          sig { params(child: Spotted::Internal::Type::BaseModel).void }
           def inherited(child)
           end
 
@@ -274,9 +274,13 @@ module Spotted
 
         # Create a new instance of a model.
         sig do
-          params(data: T.any(T::Hash[Symbol, T.anything], T.self_type)).returns(
-            T.attached_class
-          )
+          params(
+            data:
+              T.any(
+                T::Hash[Symbol, T.anything],
+                Spotted::Internal::Type::BaseModel
+              )
+          ).returns(T.attached_class)
         end
         def self.new(data = {})
         end