spotted 0.1.0

data/rbi/spotted/models.rbi

@@ -0,0 +1,132 @@
+# typed: strong
+
+module Spotted
+  AlbumListParams = Spotted::Models::AlbumListParams
+
+  AlbumListTracksParams = Spotted::Models::AlbumListTracksParams
+
+  AlbumRestrictionObject = Spotted::Models::AlbumRestrictionObject
+
+  AlbumRetrieveParams = Spotted::Models::AlbumRetrieveParams
+
+  ArtistListAlbumsParams = Spotted::Models::ArtistListAlbumsParams
+
+  ArtistListParams = Spotted::Models::ArtistListParams
+
+  ArtistListRelatedArtistsParams =
+    Spotted::Models::ArtistListRelatedArtistsParams
+
+  ArtistListTopTracksParams = Spotted::Models::ArtistListTopTracksParams
+
+  ArtistObject = Spotted::Models::ArtistObject
+
+  ArtistRetrieveParams = Spotted::Models::ArtistRetrieveParams
+
+  AudioAnalysisRetrieveParams = Spotted::Models::AudioAnalysisRetrieveParams
+
+  AudiobookListChaptersParams = Spotted::Models::AudiobookListChaptersParams
+
+  AudiobookListParams = Spotted::Models::AudiobookListParams
+
+  AudiobookRetrieveParams = Spotted::Models::AudiobookRetrieveParams
+
+  AudioFeatureListParams = Spotted::Models::AudioFeatureListParams
+
+  AudioFeatureRetrieveParams = Spotted::Models::AudioFeatureRetrieveParams
+
+  AuthorObject = Spotted::Models::AuthorObject
+
+  Browse = Spotted::Models::Browse
+
+  BrowseGetFeaturedPlaylistsParams =
+    Spotted::Models::BrowseGetFeaturedPlaylistsParams
+
+  BrowseGetNewReleasesParams = Spotted::Models::BrowseGetNewReleasesParams
+
+  ChapterListParams = Spotted::Models::ChapterListParams
+
+  ChapterRestrictionObject = Spotted::Models::ChapterRestrictionObject
+
+  ChapterRetrieveParams = Spotted::Models::ChapterRetrieveParams
+
+  CopyrightObject = Spotted::Models::CopyrightObject
+
+  EpisodeListParams = Spotted::Models::EpisodeListParams
+
+  EpisodeObject = Spotted::Models::EpisodeObject
+
+  EpisodeRestrictionObject = Spotted::Models::EpisodeRestrictionObject
+
+  EpisodeRetrieveParams = Spotted::Models::EpisodeRetrieveParams
+
+  ExternalIDObject = Spotted::Models::ExternalIDObject
+
+  ExternalURLObject = Spotted::Models::ExternalURLObject
+
+  FollowersObject = Spotted::Models::FollowersObject
+
+  ImageObject = Spotted::Models::ImageObject
+
+  LinkedTrackObject = Spotted::Models::LinkedTrackObject
+
+  MarketListParams = Spotted::Models::MarketListParams
+
+  Me = Spotted::Models::Me
+
+  MeRetrieveParams = Spotted::Models::MeRetrieveParams
+
+  NarratorObject = Spotted::Models::NarratorObject
+
+  PagingPlaylistObject = Spotted::Models::PagingPlaylistObject
+
+  PlaylistRetrieveParams = Spotted::Models::PlaylistRetrieveParams
+
+  Playlists = Spotted::Models::Playlists
+
+  PlaylistTrackObject = Spotted::Models::PlaylistTrackObject
+
+  PlaylistTracksRefObject = Spotted::Models::PlaylistTracksRefObject
+
+  PlaylistUpdateParams = Spotted::Models::PlaylistUpdateParams
+
+  PlaylistUserObject = Spotted::Models::PlaylistUserObject
+
+  RecommendationGetParams = Spotted::Models::RecommendationGetParams
+
+  RecommendationListAvailableGenreSeedsParams =
+    Spotted::Models::RecommendationListAvailableGenreSeedsParams
+
+  ResumePointObject = Spotted::Models::ResumePointObject
+
+  SearchRetrieveParams = Spotted::Models::SearchRetrieveParams
+
+  ShowListEpisodesParams = Spotted::Models::ShowListEpisodesParams
+
+  ShowListParams = Spotted::Models::ShowListParams
+
+  ShowRetrieveParams = Spotted::Models::ShowRetrieveParams
+
+  SimplifiedArtistObject = Spotted::Models::SimplifiedArtistObject
+
+  SimplifiedChapterObject = Spotted::Models::SimplifiedChapterObject
+
+  SimplifiedEpisodeObject = Spotted::Models::SimplifiedEpisodeObject
+
+  SimplifiedPlaylistObject = Spotted::Models::SimplifiedPlaylistObject
+
+  SimplifiedTrackObject = Spotted::Models::SimplifiedTrackObject
+
+  TimeIntervalObject = Spotted::Models::TimeIntervalObject
+
+  TrackListParams = Spotted::Models::TrackListParams
+
+  TrackObject = Spotted::Models::TrackObject
+
+  TrackRestrictionObject = Spotted::Models::TrackRestrictionObject
+
+  TrackRetrieveParams = Spotted::Models::TrackRetrieveParams
+
+  UserRetrieveProfileParams = Spotted::Models::UserRetrieveProfileParams
+
+  Users = Spotted::Models::Users
+end

data/rbi/spotted/request_options.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module Spotted
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < Spotted::Internal::Type::BaseModel
+    OrHash =
+      T.type_alias do
+        T.any(Spotted::RequestOptions, Spotted::Internal::AnyHash)
+      end
+
+    # @api private
+    sig { params(opts: Spotted::RequestOptions::OrHash).void }
+    def self.validate!(opts)
+    end
+
+    # Idempotency key to send with request and all associated retries. Will only be
+    # sent for write requests.
+    sig { returns(T.nilable(String)) }
+    attr_accessor :idempotency_key
+
+    # Extra query params to send with the request. These are `.merge`’d into any
+    # `query` given at the client level.
+    sig do
+      returns(
+        T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])
+      )
+    end
+    attr_accessor :extra_query
+
+    # Extra headers to send with the request. These are `.merged`’d into any
+    # `extra_headers` given at the client level.
+    sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
+    attr_accessor :extra_headers
+
+    # Extra data to send with the request. These are deep merged into any data
+    # generated as part of the normal request.
+    sig { returns(T.nilable(T.anything)) }
+    attr_accessor :extra_body
+
+    # Maximum number of retries to attempt after a failed initial request.
+    sig { returns(T.nilable(Integer)) }
+    attr_accessor :max_retries
+
+    # Request timeout in seconds.
+    sig { returns(T.nilable(Float)) }
+    attr_accessor :timeout
+
+    # Returns a new instance of RequestOptions.
+    sig { params(values: Spotted::Internal::AnyHash).returns(T.attached_class) }
+    def self.new(values = {})
+    end
+  end
+end

data/rbi/spotted/resources/albums.rbi

@@ -0,0 +1,100 @@
+# typed: strong
+
+module Spotted
+  module Resources
+    class Albums
+      # Get Spotify catalog information for a single album.
+      sig do
+        params(
+          id: String,
+          market: String,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(Spotted::Models::AlbumRetrieveResponse)
+      end
+      def retrieve(
+        # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the album.
+        id,
+        # 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/).
+        market: nil,
+        request_options: {}
+      )
+      end
+
+      # Get Spotify catalog information for multiple albums identified by their Spotify
+      # IDs.
+      sig do
+        params(
+          ids: String,
+          market: String,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(Spotted::Models::AlbumListResponse)
+      end
+      def list(
+        # A comma-separated list of the
+        # [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids) for the albums.
+        # Maximum: 20 IDs.
+        ids:,
+        # 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/).
+        market: nil,
+        request_options: {}
+      )
+      end
+
+      # Get Spotify catalog information about an album’s tracks. Optional parameters can
+      # be used to limit the number of tracks returned.
+      sig do
+        params(
+          id: String,
+          limit: Integer,
+          market: String,
+          offset: Integer,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(
+          Spotted::Internal::CursorURLPage[Spotted::SimplifiedTrackObject]
+        )
+      end
+      def list_tracks(
+        # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the album.
+        id,
+        # The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+        limit: nil,
+        # 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/).
+        market: nil,
+        # The index of the first item to return. Default: 0 (the first item). Use with
+        # limit to get the next set of items.
+        offset: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Spotted::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/spotted/resources/artists.rbi

@@ -0,0 +1,129 @@
+# typed: strong
+
+module Spotted
+  module Resources
+    class Artists
+      # Get Spotify catalog information for a single artist identified by their unique
+      # Spotify ID.
+      sig do
+        params(
+          id: String,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(Spotted::ArtistObject)
+      end
+      def retrieve(
+        # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the
+        # artist.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Get Spotify catalog information for several artists based on their Spotify IDs.
+      sig do
+        params(
+          ids: String,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(Spotted::Models::ArtistListResponse)
+      end
+      def list(
+        # A comma-separated list of the
+        # [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids) for the artists.
+        # Maximum: 50 IDs.
+        ids:,
+        request_options: {}
+      )
+      end
+
+      # Get Spotify catalog information about an artist's albums.
+      sig do
+        params(
+          id: String,
+          include_groups: String,
+          limit: Integer,
+          market: String,
+          offset: Integer,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(
+          Spotted::Internal::CursorURLPage[
+            Spotted::Models::ArtistListAlbumsResponse
+          ]
+        )
+      end
+      def list_albums(
+        # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the
+        # artist.
+        id,
+        # A comma-separated list of keywords that will be used to filter the response. If
+        # not supplied, all album types will be returned. <br/> Valid values are:<br/>-
+        # `album`<br/>- `single`<br/>- `appears_on`<br/>- `compilation`<br/>For example:
+        # `include_groups=album,single`.
+        include_groups: nil,
+        # The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+        limit: nil,
+        # 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/).
+        market: nil,
+        # The index of the first item to return. Default: 0 (the first item). Use with
+        # limit to get the next set of items.
+        offset: nil,
+        request_options: {}
+      )
+      end
+
+      # Get Spotify catalog information about artists similar to a given artist.
+      # Similarity is based on analysis of the Spotify community's listening history.
+      sig do
+        params(
+          id: String,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(Spotted::Models::ArtistListRelatedArtistsResponse)
+      end
+      def list_related_artists(
+        # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the
+        # artist.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Get Spotify catalog information about an artist's top tracks by country.
+      sig do
+        params(
+          id: String,
+          market: String,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(Spotted::Models::ArtistListTopTracksResponse)
+      end
+      def list_top_tracks(
+        # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the
+        # artist.
+        id,
+        # 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/).
+        market: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Spotted::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/spotted/resources/audio_analysis.rbi

@@ -0,0 +1,29 @@
+# typed: strong
+
+module Spotted
+  module Resources
+    class AudioAnalysis
+      # Get a low-level audio analysis for a track in the Spotify catalog. The audio
+      # analysis describes the track’s structure and musical content, including rhythm,
+      # pitch, and timbre.
+      sig do
+        params(
+          id: String,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(Spotted::Models::AudioAnalysisRetrieveResponse)
+      end
+      def retrieve(
+        # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+        # track.
+        id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Spotted::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/spotted/resources/audio_features.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module Spotted
+  module Resources
+    class AudioFeatures
+      # Get audio feature information for a single track identified by its unique
+      # Spotify ID.
+      sig do
+        params(
+          id: String,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(Spotted::Models::AudioFeatureRetrieveResponse)
+      end
+      def retrieve(
+        # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+        # track.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Get audio features for multiple tracks based on their Spotify IDs.
+      sig do
+        params(
+          ids: String,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(Spotted::Models::AudioFeatureListResponse)
+      end
+      def list(
+        # A comma-separated list of the
+        # [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids) for the tracks.
+        # Maximum: 100 IDs.
+        ids:,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Spotted::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/spotted/resources/audiobooks.rbi

@@ -0,0 +1,105 @@
+# typed: strong
+
+module Spotted
+  module Resources
+    class Audiobooks
+      # Get Spotify catalog information for a single audiobook. Audiobooks are only
+      # available within the US, UK, Canada, Ireland, New Zealand and Australia markets.
+      sig do
+        params(
+          id: String,
+          market: String,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(Spotted::Models::AudiobookRetrieveResponse)
+      end
+      def retrieve(
+        # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+        # audiobook.
+        id,
+        # 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/).
+        market: nil,
+        request_options: {}
+      )
+      end
+
+      # Get Spotify catalog information for several audiobooks identified by their
+      # Spotify IDs. Audiobooks are only available within the US, UK, Canada, Ireland,
+      # New Zealand and Australia markets.
+      sig do
+        params(
+          ids: String,
+          market: String,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(Spotted::Models::AudiobookListResponse)
+      end
+      def list(
+        # A comma-separated list of the
+        # [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+        # `ids=18yVqkdbdRvS24c0Ilj2ci,1HGw3J3NxZO1TP1BTtVhpZ`. Maximum: 50 IDs.
+        ids:,
+        # 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/).
+        market: nil,
+        request_options: {}
+      )
+      end
+
+      # Get Spotify catalog information about an audiobook's chapters. Audiobooks are
+      # only available within the US, UK, Canada, Ireland, New Zealand and Australia
+      # markets.
+      sig do
+        params(
+          id: String,
+          limit: Integer,
+          market: String,
+          offset: Integer,
+          request_options: Spotted::RequestOptions::OrHash
+        ).returns(
+          Spotted::Internal::CursorURLPage[Spotted::SimplifiedChapterObject]
+        )
+      end
+      def list_chapters(
+        # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+        # audiobook.
+        id,
+        # The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+        limit: nil,
+        # 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/).
+        market: nil,
+        # The index of the first item to return. Default: 0 (the first item). Use with
+        # limit to get the next set of items.
+        offset: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Spotted::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/spotted/resources/browse/categories.rbi

@@ -0,0 +1,91 @@
+# typed: strong
+
+module Spotted
+  module Resources
+    class Browse
+      class Categories
+        # Get a single category used to tag items in Spotify (on, for example, the Spotify
+        # player’s “Browse” tab).
+        sig do
+          params(
+            category_id: String,
+            locale: String,
+            request_options: Spotted::RequestOptions::OrHash
+          ).returns(Spotted::Models::Browse::CategoryRetrieveResponse)
+        end
+        def retrieve(
+          # The [Spotify category ID](/documentation/web-api/concepts/spotify-uris-ids) for
+          # the category.
+          category_id,
+          # 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 "Spanish
+          # (Mexico)". 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)._
+          locale: nil,
+          request_options: {}
+        )
+        end
+
+        # Get a list of categories used to tag items in Spotify (on, for example, the
+        # Spotify player’s “Browse” tab).
+        sig do
+          params(
+            limit: Integer,
+            locale: String,
+            offset: Integer,
+            request_options: Spotted::RequestOptions::OrHash
+          ).returns(Spotted::Models::Browse::CategoryListResponse)
+        end
+        def list(
+          # The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+          limit: nil,
+          # 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)._
+          locale: nil,
+          # The index of the first item to return. Default: 0 (the first item). Use with
+          # limit to get the next set of items.
+          offset: nil,
+          request_options: {}
+        )
+        end
+
+        # Get a list of Spotify playlists tagged with a particular category.
+        sig do
+          params(
+            category_id: String,
+            limit: Integer,
+            offset: Integer,
+            request_options: Spotted::RequestOptions::OrHash
+          ).returns(Spotted::Models::Browse::CategoryGetPlaylistsResponse)
+        end
+        def get_playlists(
+          # The [Spotify category ID](/documentation/web-api/concepts/spotify-uris-ids) for
+          # the category.
+          category_id,
+          # The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+          limit: nil,
+          # The index of the first item to return. Default: 0 (the first item). Use with
+          # limit to get the next set of items.
+          offset: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Spotted::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end