spotted-ts 0.1.0

package/resources/search.d.mts

@@ -0,0 +1,309 @@
+import { APIResource } from "../core/resource.mjs";
+import * as Shared from "./shared.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Search extends APIResource {
+    /**
+     * Get Spotify catalog information about albums, artists, playlists, tracks, shows,
+     * episodes or audiobooks that match a keyword string. Audiobooks are only
+     * available within the US, UK, Canada, Ireland, New Zealand and Australia markets.
+     */
+    retrieve(query: SearchRetrieveParams, options?: RequestOptions): APIPromise<SearchRetrieveResponse>;
+}
+export interface SearchRetrieveResponse {
+    albums?: SearchRetrieveResponse.Albums;
+    artists?: SearchRetrieveResponse.Artists;
+    audiobooks?: SearchRetrieveResponse.Audiobooks;
+    episodes?: SearchRetrieveResponse.Episodes;
+    playlists?: Shared.PagingPlaylistObject;
+    shows?: SearchRetrieveResponse.Shows;
+    tracks?: SearchRetrieveResponse.Tracks;
+}
+export declare namespace SearchRetrieveResponse {
+    interface Albums {
+        /**
+         * A link to the Web API endpoint returning the full result of the request
+         */
+        href: string;
+        items: Array<Albums.Item>;
+        /**
+         * The maximum number of items in the response (as set in the query or by default).
+         */
+        limit: number;
+        /**
+         * URL to the next page of items. ( `null` if none)
+         */
+        next: string | null;
+        /**
+         * The offset of the items returned (as set in the query or by default)
+         */
+        offset: number;
+        /**
+         * URL to the previous page of items. ( `null` if none)
+         */
+        previous: string | null;
+        /**
+         * The total number of items available to return.
+         */
+        total: number;
+    }
+    namespace Albums {
+        interface Item {
+            /**
+             * The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+             * album.
+             */
+            id: string;
+            /**
+             * The type of the album.
+             */
+            album_type: 'album' | 'single' | 'compilation';
+            /**
+             * The artists of the album. Each artist object includes a link in `href` to more
+             * detailed information about the artist.
+             */
+            artists: Array<Shared.SimplifiedArtistObject>;
+            /**
+             * The markets in which the album is available:
+             * [ISO 3166-1 alpha-2 country codes](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
+             * _**NOTE**: an album is considered available in a market when at least 1 of its
+             * tracks is available in that market._
+             */
+            available_markets: Array<string>;
+            /**
+             * Known external URLs for this album.
+             */
+            external_urls: Shared.ExternalURLObject;
+            /**
+             * A link to the Web API endpoint providing full details of the album.
+             */
+            href: string;
+            /**
+             * The cover art for the album in various sizes, widest first.
+             */
+            images: Array<Shared.ImageObject>;
+            /**
+             * The name of the album. In case of an album takedown, the value may be an empty
+             * string.
+             */
+            name: string;
+            /**
+             * The date the album was first released.
+             */
+            release_date: string;
+            /**
+             * The precision with which `release_date` value is known.
+             */
+            release_date_precision: 'year' | 'month' | 'day';
+            /**
+             * The number of tracks in the album.
+             */
+            total_tracks: number;
+            /**
+             * The object type.
+             */
+            type: 'album';
+            /**
+             * The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+             * album.
+             */
+            uri: string;
+            /**
+             * Included in the response when a content restriction is applied.
+             */
+            restrictions?: Shared.AlbumRestrictionObject;
+        }
+    }
+    interface Artists {
+        /**
+         * A link to the Web API endpoint returning the full result of the request
+         */
+        href: string;
+        items: Array<Shared.ArtistObject>;
+        /**
+         * The maximum number of items in the response (as set in the query or by default).
+         */
+        limit: number;
+        /**
+         * URL to the next page of items. ( `null` if none)
+         */
+        next: string | null;
+        /**
+         * The offset of the items returned (as set in the query or by default)
+         */
+        offset: number;
+        /**
+         * URL to the previous page of items. ( `null` if none)
+         */
+        previous: string | null;
+        /**
+         * The total number of items available to return.
+         */
+        total: number;
+    }
+    interface Audiobooks {
+        /**
+         * A link to the Web API endpoint returning the full result of the request
+         */
+        href: string;
+        items: Array<Shared.AudiobookBase>;
+        /**
+         * The maximum number of items in the response (as set in the query or by default).
+         */
+        limit: number;
+        /**
+         * URL to the next page of items. ( `null` if none)
+         */
+        next: string | null;
+        /**
+         * The offset of the items returned (as set in the query or by default)
+         */
+        offset: number;
+        /**
+         * URL to the previous page of items. ( `null` if none)
+         */
+        previous: string | null;
+        /**
+         * The total number of items available to return.
+         */
+        total: number;
+    }
+    interface Episodes {
+        /**
+         * A link to the Web API endpoint returning the full result of the request
+         */
+        href: string;
+        items: Array<Shared.SimplifiedEpisodeObject>;
+        /**
+         * The maximum number of items in the response (as set in the query or by default).
+         */
+        limit: number;
+        /**
+         * URL to the next page of items. ( `null` if none)
+         */
+        next: string | null;
+        /**
+         * The offset of the items returned (as set in the query or by default)
+         */
+        offset: number;
+        /**
+         * URL to the previous page of items. ( `null` if none)
+         */
+        previous: string | null;
+        /**
+         * The total number of items available to return.
+         */
+        total: number;
+    }
+    interface Shows {
+        /**
+         * A link to the Web API endpoint returning the full result of the request
+         */
+        href: string;
+        items: Array<Shared.ShowBase>;
+        /**
+         * The maximum number of items in the response (as set in the query or by default).
+         */
+        limit: number;
+        /**
+         * URL to the next page of items. ( `null` if none)
+         */
+        next: string | null;
+        /**
+         * The offset of the items returned (as set in the query or by default)
+         */
+        offset: number;
+        /**
+         * URL to the previous page of items. ( `null` if none)
+         */
+        previous: string | null;
+        /**
+         * The total number of items available to return.
+         */
+        total: number;
+    }
+    interface Tracks {
+        /**
+         * A link to the Web API endpoint returning the full result of the request
+         */
+        href: string;
+        items: Array<Shared.TrackObject>;
+        /**
+         * The maximum number of items in the response (as set in the query or by default).
+         */
+        limit: number;
+        /**
+         * URL to the next page of items. ( `null` if none)
+         */
+        next: string | null;
+        /**
+         * The offset of the items returned (as set in the query or by default)
+         */
+        offset: number;
+        /**
+         * URL to the previous page of items. ( `null` if none)
+         */
+        previous: string | null;
+        /**
+         * The total number of items available to return.
+         */
+        total: number;
+    }
+}
+export interface SearchRetrieveParams {
+    /**
+     * Your search query.
+     *
+     * You can narrow down your search using field filters. The available filters are
+     * `album`, `artist`, `track`, `year`, `upc`, `tag:hipster`, `tag:new`, `isrc`, and
+     * `genre`. Each field filter only applies to certain result types.
+     *
+     * The `artist` and `year` filters can be used while searching albums, artists and
+     * tracks. You can filter on a single `year` or a range (e.g. 1955-1960).<br /> The
+     * `album` filter can be used while searching albums and tracks.<br /> The `genre`
+     * filter can be used while searching artists and tracks.<br /> The `isrc` and
+     * `track` filters can be used while searching tracks.<br /> The `upc`, `tag:new`
+     * and `tag:hipster` filters can only be used while searching albums. The `tag:new`
+     * filter will return albums released in the past two weeks and `tag:hipster` can
+     * be used to return only albums with the lowest 10% popularity.<br />
+     */
+    q: string;
+    /**
+     * A comma-separated list of item types to search across. Search results include
+     * hits from all the specified item types. For example: `q=abacab&type=album,track`
+     * returns both albums and tracks matching "abacab".
+     */
+    type: Array<'album' | 'artist' | 'playlist' | 'track' | 'show' | 'episode' | 'audiobook'>;
+    /**
+     * If `include_external=audio` is specified it signals that the client can play
+     * externally hosted audio content, and marks the content as playable in the
+     * response. By default externally hosted audio content is marked as unplayable in
+     * the response.
+     */
+    include_external?: 'audio';
+    /**
+     * The maximum number of results to return in each item type.
+     */
+    limit?: number;
+    /**
+     * 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?: string;
+    /**
+     * The index of the first result to return. Use with limit to get the next page of
+     * search results.
+     */
+    offset?: number;
+}
+export declare namespace Search {
+    export { type SearchRetrieveResponse as SearchRetrieveResponse, type SearchRetrieveParams as SearchRetrieveParams, };
+}
+//# sourceMappingURL=search.d.mts.map

package/resources/search.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.d.mts","sourceRoot":"","sources":["../src/resources/search.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGpG;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,CAAC,EAAE,sBAAsB,CAAC,MAAM,CAAC;IAEvC,OAAO,CAAC,EAAE,sBAAsB,CAAC,OAAO,CAAC;IAEzC,UAAU,CAAC,EAAE,sBAAsB,CAAC,UAAU,CAAC;IAE/C,QAAQ,CAAC,EAAE,sBAAsB,CAAC,QAAQ,CAAC;IAE3C,SAAS,CAAC,EAAE,MAAM,CAAC,oBAAoB,CAAC;IAExC,KAAK,CAAC,EAAE,sBAAsB,CAAC,KAAK,CAAC;IAErC,MAAM,CAAC,EAAE,sBAAsB,CAAC,MAAM,CAAC;CACxC;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,MAAM;QACrB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAE1B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,MAAM,CAAC;QACtB,UAAiB,IAAI;YACnB;;;eAGG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,UAAU,EAAE,OAAO,GAAG,QAAQ,GAAG,aAAa,CAAC;YAE/C;;;eAGG;YACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;YAE9C;;;;;eAKG;YACH,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEjC;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC,iBAAiB,CAAC;YAExC;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAElC;;;eAGG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,sBAAsB,EAAE,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC;YAEjD;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,IAAI,EAAE,OAAO,CAAC;YAEd;;;eAGG;YACH,GAAG,EAAE,MAAM,CAAC;YAEZ;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC,sBAAsB,CAAC;SAC9C;KACF;IAED,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAElC;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAEnC;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,QAAQ;QACvB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAC;QAE7C;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAE9B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,MAAM;QACrB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAEjC;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;;;;;;;;;;;OAeG;IACH,CAAC,EAAE,MAAM,CAAC;IAEV;;;;OAIG;IACH,IAAI,EAAE,KAAK,CAAC,OAAO,GAAG,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,WAAW,CAAC,CAAC;IAE1F;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/search.d.ts

@@ -0,0 +1,309 @@
+import { APIResource } from "../core/resource.js";
+import * as Shared from "./shared.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Search extends APIResource {
+    /**
+     * Get Spotify catalog information about albums, artists, playlists, tracks, shows,
+     * episodes or audiobooks that match a keyword string. Audiobooks are only
+     * available within the US, UK, Canada, Ireland, New Zealand and Australia markets.
+     */
+    retrieve(query: SearchRetrieveParams, options?: RequestOptions): APIPromise<SearchRetrieveResponse>;
+}
+export interface SearchRetrieveResponse {
+    albums?: SearchRetrieveResponse.Albums;
+    artists?: SearchRetrieveResponse.Artists;
+    audiobooks?: SearchRetrieveResponse.Audiobooks;
+    episodes?: SearchRetrieveResponse.Episodes;
+    playlists?: Shared.PagingPlaylistObject;
+    shows?: SearchRetrieveResponse.Shows;
+    tracks?: SearchRetrieveResponse.Tracks;
+}
+export declare namespace SearchRetrieveResponse {
+    interface Albums {
+        /**
+         * A link to the Web API endpoint returning the full result of the request
+         */
+        href: string;
+        items: Array<Albums.Item>;
+        /**
+         * The maximum number of items in the response (as set in the query or by default).
+         */
+        limit: number;
+        /**
+         * URL to the next page of items. ( `null` if none)
+         */
+        next: string | null;
+        /**
+         * The offset of the items returned (as set in the query or by default)
+         */
+        offset: number;
+        /**
+         * URL to the previous page of items. ( `null` if none)
+         */
+        previous: string | null;
+        /**
+         * The total number of items available to return.
+         */
+        total: number;
+    }
+    namespace Albums {
+        interface Item {
+            /**
+             * The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+             * album.
+             */
+            id: string;
+            /**
+             * The type of the album.
+             */
+            album_type: 'album' | 'single' | 'compilation';
+            /**
+             * The artists of the album. Each artist object includes a link in `href` to more
+             * detailed information about the artist.
+             */
+            artists: Array<Shared.SimplifiedArtistObject>;
+            /**
+             * The markets in which the album is available:
+             * [ISO 3166-1 alpha-2 country codes](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
+             * _**NOTE**: an album is considered available in a market when at least 1 of its
+             * tracks is available in that market._
+             */
+            available_markets: Array<string>;
+            /**
+             * Known external URLs for this album.
+             */
+            external_urls: Shared.ExternalURLObject;
+            /**
+             * A link to the Web API endpoint providing full details of the album.
+             */
+            href: string;
+            /**
+             * The cover art for the album in various sizes, widest first.
+             */
+            images: Array<Shared.ImageObject>;
+            /**
+             * The name of the album. In case of an album takedown, the value may be an empty
+             * string.
+             */
+            name: string;
+            /**
+             * The date the album was first released.
+             */
+            release_date: string;
+            /**
+             * The precision with which `release_date` value is known.
+             */
+            release_date_precision: 'year' | 'month' | 'day';
+            /**
+             * The number of tracks in the album.
+             */
+            total_tracks: number;
+            /**
+             * The object type.
+             */
+            type: 'album';
+            /**
+             * The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+             * album.
+             */
+            uri: string;
+            /**
+             * Included in the response when a content restriction is applied.
+             */
+            restrictions?: Shared.AlbumRestrictionObject;
+        }
+    }
+    interface Artists {
+        /**
+         * A link to the Web API endpoint returning the full result of the request
+         */
+        href: string;
+        items: Array<Shared.ArtistObject>;
+        /**
+         * The maximum number of items in the response (as set in the query or by default).
+         */
+        limit: number;
+        /**
+         * URL to the next page of items. ( `null` if none)
+         */
+        next: string | null;
+        /**
+         * The offset of the items returned (as set in the query or by default)
+         */
+        offset: number;
+        /**
+         * URL to the previous page of items. ( `null` if none)
+         */
+        previous: string | null;
+        /**
+         * The total number of items available to return.
+         */
+        total: number;
+    }
+    interface Audiobooks {
+        /**
+         * A link to the Web API endpoint returning the full result of the request
+         */
+        href: string;
+        items: Array<Shared.AudiobookBase>;
+        /**
+         * The maximum number of items in the response (as set in the query or by default).
+         */
+        limit: number;
+        /**
+         * URL to the next page of items. ( `null` if none)
+         */
+        next: string | null;
+        /**
+         * The offset of the items returned (as set in the query or by default)
+         */
+        offset: number;
+        /**
+         * URL to the previous page of items. ( `null` if none)
+         */
+        previous: string | null;
+        /**
+         * The total number of items available to return.
+         */
+        total: number;
+    }
+    interface Episodes {
+        /**
+         * A link to the Web API endpoint returning the full result of the request
+         */
+        href: string;
+        items: Array<Shared.SimplifiedEpisodeObject>;
+        /**
+         * The maximum number of items in the response (as set in the query or by default).
+         */
+        limit: number;
+        /**
+         * URL to the next page of items. ( `null` if none)
+         */
+        next: string | null;
+        /**
+         * The offset of the items returned (as set in the query or by default)
+         */
+        offset: number;
+        /**
+         * URL to the previous page of items. ( `null` if none)
+         */
+        previous: string | null;
+        /**
+         * The total number of items available to return.
+         */
+        total: number;
+    }
+    interface Shows {
+        /**
+         * A link to the Web API endpoint returning the full result of the request
+         */
+        href: string;
+        items: Array<Shared.ShowBase>;
+        /**
+         * The maximum number of items in the response (as set in the query or by default).
+         */
+        limit: number;
+        /**
+         * URL to the next page of items. ( `null` if none)
+         */
+        next: string | null;
+        /**
+         * The offset of the items returned (as set in the query or by default)
+         */
+        offset: number;
+        /**
+         * URL to the previous page of items. ( `null` if none)
+         */
+        previous: string | null;
+        /**
+         * The total number of items available to return.
+         */
+        total: number;
+    }
+    interface Tracks {
+        /**
+         * A link to the Web API endpoint returning the full result of the request
+         */
+        href: string;
+        items: Array<Shared.TrackObject>;
+        /**
+         * The maximum number of items in the response (as set in the query or by default).
+         */
+        limit: number;
+        /**
+         * URL to the next page of items. ( `null` if none)
+         */
+        next: string | null;
+        /**
+         * The offset of the items returned (as set in the query or by default)
+         */
+        offset: number;
+        /**
+         * URL to the previous page of items. ( `null` if none)
+         */
+        previous: string | null;
+        /**
+         * The total number of items available to return.
+         */
+        total: number;
+    }
+}
+export interface SearchRetrieveParams {
+    /**
+     * Your search query.
+     *
+     * You can narrow down your search using field filters. The available filters are
+     * `album`, `artist`, `track`, `year`, `upc`, `tag:hipster`, `tag:new`, `isrc`, and
+     * `genre`. Each field filter only applies to certain result types.
+     *
+     * The `artist` and `year` filters can be used while searching albums, artists and
+     * tracks. You can filter on a single `year` or a range (e.g. 1955-1960).<br /> The
+     * `album` filter can be used while searching albums and tracks.<br /> The `genre`
+     * filter can be used while searching artists and tracks.<br /> The `isrc` and
+     * `track` filters can be used while searching tracks.<br /> The `upc`, `tag:new`
+     * and `tag:hipster` filters can only be used while searching albums. The `tag:new`
+     * filter will return albums released in the past two weeks and `tag:hipster` can
+     * be used to return only albums with the lowest 10% popularity.<br />
+     */
+    q: string;
+    /**
+     * A comma-separated list of item types to search across. Search results include
+     * hits from all the specified item types. For example: `q=abacab&type=album,track`
+     * returns both albums and tracks matching "abacab".
+     */
+    type: Array<'album' | 'artist' | 'playlist' | 'track' | 'show' | 'episode' | 'audiobook'>;
+    /**
+     * If `include_external=audio` is specified it signals that the client can play
+     * externally hosted audio content, and marks the content as playable in the
+     * response. By default externally hosted audio content is marked as unplayable in
+     * the response.
+     */
+    include_external?: 'audio';
+    /**
+     * The maximum number of results to return in each item type.
+     */
+    limit?: number;
+    /**
+     * 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?: string;
+    /**
+     * The index of the first result to return. Use with limit to get the next page of
+     * search results.
+     */
+    offset?: number;
+}
+export declare namespace Search {
+    export { type SearchRetrieveResponse as SearchRetrieveResponse, type SearchRetrieveParams as SearchRetrieveParams, };
+}
+//# sourceMappingURL=search.d.ts.map

package/resources/search.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../src/resources/search.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGpG;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,CAAC,EAAE,sBAAsB,CAAC,MAAM,CAAC;IAEvC,OAAO,CAAC,EAAE,sBAAsB,CAAC,OAAO,CAAC;IAEzC,UAAU,CAAC,EAAE,sBAAsB,CAAC,UAAU,CAAC;IAE/C,QAAQ,CAAC,EAAE,sBAAsB,CAAC,QAAQ,CAAC;IAE3C,SAAS,CAAC,EAAE,MAAM,CAAC,oBAAoB,CAAC;IAExC,KAAK,CAAC,EAAE,sBAAsB,CAAC,KAAK,CAAC;IAErC,MAAM,CAAC,EAAE,sBAAsB,CAAC,MAAM,CAAC;CACxC;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,MAAM;QACrB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAE1B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,MAAM,CAAC;QACtB,UAAiB,IAAI;YACnB;;;eAGG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,UAAU,EAAE,OAAO,GAAG,QAAQ,GAAG,aAAa,CAAC;YAE/C;;;eAGG;YACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;YAE9C;;;;;eAKG;YACH,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEjC;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC,iBAAiB,CAAC;YAExC;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YAElC;;;eAGG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,sBAAsB,EAAE,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC;YAEjD;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,IAAI,EAAE,OAAO,CAAC;YAEd;;;eAGG;YACH,GAAG,EAAE,MAAM,CAAC;YAEZ;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC,sBAAsB,CAAC;SAC9C;KACF;IAED,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAElC;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAEnC;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,QAAQ;QACvB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAC;QAE7C;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAE9B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,MAAM;QACrB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAEjC;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;;;;;;;;;;;OAeG;IACH,CAAC,EAAE,MAAM,CAAC;IAEV;;;;OAIG;IACH,IAAI,EAAE,KAAK,CAAC,OAAO,GAAG,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,WAAW,CAAC,CAAC;IAE1F;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/search.js

@@ -0,0 +1,17 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Search = void 0;
+const resource_1 = require("../core/resource.js");
+class Search extends resource_1.APIResource {
+    /**
+     * Get Spotify catalog information about albums, artists, playlists, tracks, shows,
+     * episodes or audiobooks that match a keyword string. Audiobooks are only
+     * available within the US, UK, Canada, Ireland, New Zealand and Australia markets.
+     */
+    retrieve(query, options) {
+        return this._client.get('/search', { query, ...options });
+    }
+}
+exports.Search = Search;
+//# sourceMappingURL=search.js.map

package/resources/search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.js","sourceRoot":"","sources":["../src/resources/search.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAK/C,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;OAIG;IACH,QAAQ,CAAC,KAA2B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;CACF;AATD,wBASC"}

package/resources/search.mjs

@@ -0,0 +1,13 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+export class Search extends APIResource {
+    /**
+     * Get Spotify catalog information about albums, artists, playlists, tracks, shows,
+     * episodes or audiobooks that match a keyword string. Audiobooks are only
+     * available within the US, UK, Canada, Ireland, New Zealand and Australia markets.
+     */
+    retrieve(query, options) {
+        return this._client.get('/search', { query, ...options });
+    }
+}
+//# sourceMappingURL=search.mjs.map

package/resources/search.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.mjs","sourceRoot":"","sources":["../src/resources/search.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;OAIG;IACH,QAAQ,CAAC,KAA2B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;CACF"}