spotted 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91530c48ebb30c600d7d752cd7bd8af576c61ecbf7fc96e75e711bdd6c0140ae
-  data.tar.gz: 490542cb593197ae9b549cf1d90aa86f92a7dde031f98674d7cf0e8e729115e3
+  metadata.gz: ce3e4a67c02e0a7307440bd85d8f3c618311738750ed8b68cfe8c315574e1260
+  data.tar.gz: 36f98cdb895bdff0c933f59cc76ac1079b9cd83456ef03c605c7454594fcdc9f
 SHA512:
-  metadata.gz: 5a6b5967c6a30d9087ef75f03a3bf79fe668e6499488c23ef43d508ea179882025b71e9b442d98fdea7fb3c22e8ca97d2cce542f5a5fe2236c6ac81c65f7334a
-  data.tar.gz: 8fcfd021416b668b3de6b3311a7ad456ce0279d4f696cd391450702959003fcb95a9f27ba2d804eb6c3f7aa13937a12ad056db410dd87e3f172b880a63323d1f
+  metadata.gz: 1bbb428c95e6f329c9d65dc57947b9690d69a0e09f9f8b9ec5a78181a0656d6170a31fa9ad1dc3a8ee2b7920ea68a59c53f706c059602ff58c7d053e3e306c96
+  data.tar.gz: f8f97640a05e5d8a20c506c951606b73357c0759eccf6197e0608954b29fd82e870886a793f6eb8a38b53b8f54ad2ba582785985b633bf04aca4125683451ca6

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.3.0 (2025-11-04)
+
+Full Changelog: [v0.2.0...v0.3.0](https://github.com/cjavdev/spotted/compare/v0.2.0...v0.3.0)
+
+### Features
+
+* **api:** manual updates ([74dd654](https://github.com/cjavdev/spotted/commit/74dd654b38aae172e84db3392e0b8dbfe5842ae8))
+
+
+### Chores
+
+* bump dependency version and update sorbet types ([b5dbafb](https://github.com/cjavdev/spotted/commit/b5dbafb956916c8e1488a2861d5877533b015e0b))
+
 ## 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)

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.2.0"
+gem "spotted", "~> 0.3.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/spotted/client.rb

@@ -66,6 +66,9 @@ module Spotted
     # @return [Spotted::Resources::Recommendations]
     attr_reader :recommendations
 
+    # @return [Spotted::Resources::Webhooks]
+    attr_reader :webhooks
+
     # @return [Spotted::Resources::Markets]
     attr_reader :markets
 
@@ -163,6 +166,7 @@ module Spotted
       @audio_features = Spotted::Resources::AudioFeatures.new(client: self)
       @audio_analysis = Spotted::Resources::AudioAnalysis.new(client: self)
       @recommendations = Spotted::Resources::Recommendations.new(client: self)
+      @webhooks = Spotted::Resources::Webhooks.new(client: self)
       @markets = Spotted::Resources::Markets.new(client: self)
     end
   end

data/lib/spotted/internal/transport/base_client.rb

@@ -201,7 +201,8 @@ module Spotted
             self.class::PLATFORM_HEADERS,
             {
               "accept" => "application/json",
-              "content-type" => "application/json"
+              "content-type" => "application/json",
+              "user-agent" => user_agent
             },
             headers
           )
@@ -219,6 +220,11 @@ module Spotted
         # @return [Hash{String=>String}]
         private def auth_headers = {}
 
+        # @api private
+        #
+        # @return [String]
+        private def user_agent = "#{self.class.name}/Ruby #{Spotted::VERSION}"
+
         # @api private
         #
         # @return [String]

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

@@ -166,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.2.0"
+  VERSION = "0.3.0"
 end

data/lib/spotted.rb

@@ -220,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"
@@ -257,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

data/rbi/spotted/models/unwrap_webhook_event.rbi

@@ -0,0 +1,7 @@
+# typed: strong
+
+module Spotted
+  module Models
+    UnwrapWebhookEvent = T.let(T.anything, Spotted::Internal::Type::Converter)
+  end
+end

data/rbi/spotted/models/webhook_unwrap_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Spotted
+  module Models
+    class WebhookUnwrapParams < Spotted::Internal::Type::BaseModel
+      extend Spotted::Internal::Type::RequestParameters::Converter
+      include Spotted::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Spotted::WebhookUnwrapParams, Spotted::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: Spotted::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Spotted::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/spotted/models.rbi

@@ -130,7 +130,15 @@ module Spotted
 
   TrackRetrieveParams = Spotted::Models::TrackRetrieveParams
 
+  UnwrapWebhookEvent =
+    T.let(
+      Spotted::Models::UnwrapWebhookEvent,
+      Spotted::Internal::Type::Converter
+    )
+
   UserRetrieveProfileParams = Spotted::Models::UserRetrieveProfileParams
 
   Users = Spotted::Models::Users
+
+  WebhookUnwrapParams = Spotted::Models::WebhookUnwrapParams
 end

data/rbi/spotted/resources/webhooks.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module Spotted
+  module Resources
+    class Webhooks
+      sig { params(payload: String).returns(T.anything) }
+      def unwrap(
+        # The raw webhook payload as a string
+        payload
+      )
+      end
+
+      # @api private
+      sig { params(client: Spotted::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/spotted/client.rbs

@@ -42,6 +42,8 @@ module Spotted
 
     attr_reader recommendations: Spotted::Resources::Recommendations
 
+    attr_reader webhooks: Spotted::Resources::Webhooks
+
     attr_reader markets: Spotted::Resources::Markets
 
     # @api private

data/sig/spotted/internal/transport/base_client.rbs

@@ -87,6 +87,8 @@ module Spotted
 
         private def auth_headers: -> ::Hash[String, String]
 
+        private def user_agent: -> String
+
         private def generate_idempotency_key: -> String
 
         private def build_request: (

data/sig/spotted/models/unwrap_webhook_event.rbs

@@ -0,0 +1,5 @@
+module Spotted
+  module Models
+    UnwrapWebhookEvent: Spotted::Internal::Type::Converter
+  end
+end

data/sig/spotted/models/webhook_unwrap_params.rbs

@@ -0,0 +1,15 @@
+module Spotted
+  module Models
+    type webhook_unwrap_params =
+      {  } & Spotted::Internal::Type::request_parameters
+
+    class WebhookUnwrapParams < Spotted::Internal::Type::BaseModel
+      extend Spotted::Internal::Type::RequestParameters::Converter
+      include Spotted::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Spotted::request_opts) -> void
+
+      def to_hash: -> { request_options: Spotted::RequestOptions }
+    end
+  end
+end

data/sig/spotted/models.rbs

@@ -125,7 +125,11 @@ module Spotted
 
   class TrackRetrieveParams = Spotted::Models::TrackRetrieveParams
 
+  UnwrapWebhookEvent: Spotted::Internal::Type::Converter
+
   class UserRetrieveProfileParams = Spotted::Models::UserRetrieveProfileParams
 
   module Users = Spotted::Models::Users
+
+  class WebhookUnwrapParams = Spotted::Models::WebhookUnwrapParams
 end

data/sig/spotted/resources/webhooks.rbs

@@ -0,0 +1,9 @@
+module Spotted
+  module Resources
+    class Webhooks
+      def unwrap: (String payload) -> top
+
+      def initialize: (client: Spotted::Client) -> void
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spotted
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Spotted
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-24 00:00:00.000000000 Z
+date: 2025-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -223,11 +223,13 @@ files:
 - lib/spotted/models/track_object.rb
 - lib/spotted/models/track_restriction_object.rb
 - lib/spotted/models/track_retrieve_params.rb
+- lib/spotted/models/unwrap_webhook_event.rb
 - lib/spotted/models/user_retrieve_profile_params.rb
 - lib/spotted/models/user_retrieve_profile_response.rb
 - lib/spotted/models/users/playlist_create_params.rb
 - lib/spotted/models/users/playlist_create_response.rb
 - lib/spotted/models/users/playlist_list_params.rb
+- lib/spotted/models/webhook_unwrap_params.rb
 - lib/spotted/request_options.rb
 - lib/spotted/resources/albums.rb
 - lib/spotted/resources/artists.rb
@@ -260,6 +262,7 @@ files:
 - lib/spotted/resources/tracks.rb
 - lib/spotted/resources/users.rb
 - lib/spotted/resources/users/playlists.rb
+- lib/spotted/resources/webhooks.rb
 - lib/spotted/version.rb
 - manifest.yaml
 - rbi/spotted/client.rbi
@@ -449,11 +452,13 @@ files:
 - rbi/spotted/models/track_object.rbi
 - rbi/spotted/models/track_restriction_object.rbi
 - rbi/spotted/models/track_retrieve_params.rbi
+- rbi/spotted/models/unwrap_webhook_event.rbi
 - rbi/spotted/models/user_retrieve_profile_params.rbi
 - rbi/spotted/models/user_retrieve_profile_response.rbi
 - rbi/spotted/models/users/playlist_create_params.rbi
 - rbi/spotted/models/users/playlist_create_response.rbi
 - rbi/spotted/models/users/playlist_list_params.rbi
+- rbi/spotted/models/webhook_unwrap_params.rbi
 - rbi/spotted/request_options.rbi
 - rbi/spotted/resources/albums.rbi
 - rbi/spotted/resources/artists.rbi
@@ -486,6 +491,7 @@ files:
 - rbi/spotted/resources/tracks.rbi
 - rbi/spotted/resources/users.rbi
 - rbi/spotted/resources/users/playlists.rbi
+- rbi/spotted/resources/webhooks.rbi
 - rbi/spotted/version.rbi
 - sig/spotted/client.rbs
 - sig/spotted/errors.rbs
@@ -674,11 +680,13 @@ files:
 - sig/spotted/models/track_object.rbs
 - sig/spotted/models/track_restriction_object.rbs
 - sig/spotted/models/track_retrieve_params.rbs
+- sig/spotted/models/unwrap_webhook_event.rbs
 - sig/spotted/models/user_retrieve_profile_params.rbs
 - sig/spotted/models/user_retrieve_profile_response.rbs
 - sig/spotted/models/users/playlist_create_params.rbs
 - sig/spotted/models/users/playlist_create_response.rbs
 - sig/spotted/models/users/playlist_list_params.rbs
+- sig/spotted/models/webhook_unwrap_params.rbs
 - sig/spotted/request_options.rbs
 - sig/spotted/resources/albums.rbs
 - sig/spotted/resources/artists.rbs
@@ -711,6 +719,7 @@ files:
 - sig/spotted/resources/tracks.rbs
 - sig/spotted/resources/users.rbs
 - sig/spotted/resources/users/playlists.rbs
+- sig/spotted/resources/webhooks.rbs
 - sig/spotted/version.rbs
 homepage: https://gemdocs.org/gems/spotted
 licenses: []