spotted-ts 0.1.0

package/resources/albums.d.mts

@@ -0,0 +1,333 @@
+import { APIResource } from "../core/resource.mjs";
+import * as Shared from "./shared.mjs";
+import { SimplifiedTrackObjectsCursorURLPage } from "./shared.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Albums extends APIResource {
+    /**
+     * Get Spotify catalog information for a single album.
+     */
+    retrieve(id: string, query?: AlbumRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<AlbumRetrieveResponse>;
+    /**
+     * Get Spotify catalog information for multiple albums identified by their Spotify
+     * IDs.
+     */
+    bulkRetrieve(query: AlbumBulkRetrieveParams, options?: RequestOptions): APIPromise<AlbumBulkRetrieveResponse>;
+    /**
+     * Get Spotify catalog information about an album’s tracks. Optional parameters can
+     * be used to limit the number of tracks returned.
+     */
+    listTracks(id: string, query?: AlbumListTracksParams | null | undefined, options?: RequestOptions): PagePromise<SimplifiedTrackObjectsCursorURLPage, Shared.SimplifiedTrackObject>;
+}
+export interface AlbumRetrieveResponse {
+    /**
+     * 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 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;
+    /**
+     * 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 copyright statements of the album.
+     */
+    copyrights?: Array<Shared.CopyrightObject>;
+    /**
+     * Known external IDs for the album.
+     */
+    external_ids?: Shared.ExternalIDObject;
+    /**
+     * @deprecated **Deprecated** The array is always empty.
+     */
+    genres?: Array<string>;
+    /**
+     * The label associated with the album.
+     */
+    label?: string;
+    /**
+     * The popularity of the album. The value will be between 0 and 100, with 100 being
+     * the most popular.
+     */
+    popularity?: number;
+    /**
+     * Included in the response when a content restriction is applied.
+     */
+    restrictions?: Shared.AlbumRestrictionObject;
+    /**
+     * The tracks of the album.
+     */
+    tracks?: AlbumRetrieveResponse.Tracks;
+}
+export declare namespace AlbumRetrieveResponse {
+    /**
+     * The tracks of the album.
+     */
+    interface Tracks {
+        /**
+         * A link to the Web API endpoint returning the full result of the request
+         */
+        href: string;
+        items: Array<Shared.SimplifiedTrackObject>;
+        /**
+         * 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 AlbumBulkRetrieveResponse {
+    albums: Array<AlbumBulkRetrieveResponse.Album>;
+}
+export declare namespace AlbumBulkRetrieveResponse {
+    interface Album {
+        /**
+         * 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 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;
+        /**
+         * 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 copyright statements of the album.
+         */
+        copyrights?: Array<Shared.CopyrightObject>;
+        /**
+         * Known external IDs for the album.
+         */
+        external_ids?: Shared.ExternalIDObject;
+        /**
+         * @deprecated **Deprecated** The array is always empty.
+         */
+        genres?: Array<string>;
+        /**
+         * The label associated with the album.
+         */
+        label?: string;
+        /**
+         * The popularity of the album. The value will be between 0 and 100, with 100 being
+         * the most popular.
+         */
+        popularity?: number;
+        /**
+         * Included in the response when a content restriction is applied.
+         */
+        restrictions?: Shared.AlbumRestrictionObject;
+        /**
+         * The tracks of the album.
+         */
+        tracks?: Album.Tracks;
+    }
+    namespace Album {
+        /**
+         * The tracks of the album.
+         */
+        interface Tracks {
+            /**
+             * A link to the Web API endpoint returning the full result of the request
+             */
+            href: string;
+            items: Array<Shared.SimplifiedTrackObject>;
+            /**
+             * 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 AlbumRetrieveParams {
+    /**
+     * 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;
+}
+export interface AlbumBulkRetrieveParams {
+    /**
+     * A comma-separated list of the
+     * [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids) for the albums.
+     * Maximum: 20 IDs.
+     */
+    ids: string;
+    /**
+     * 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;
+}
+export interface AlbumListTracksParams {
+    /**
+     * The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+     */
+    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 item to return. Default: 0 (the first item). Use with
+     * limit to get the next set of items.
+     */
+    offset?: number;
+}
+export declare namespace Albums {
+    export { type AlbumRetrieveResponse as AlbumRetrieveResponse, type AlbumBulkRetrieveResponse as AlbumBulkRetrieveResponse, type AlbumRetrieveParams as AlbumRetrieveParams, type AlbumBulkRetrieveParams as AlbumBulkRetrieveParams, type AlbumListTracksParams as AlbumListTracksParams, };
+}
+export { type SimplifiedTrackObjectsCursorURLPage };
+//# sourceMappingURL=albums.d.mts.map

package/resources/albums.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"albums.d.mts","sourceRoot":"","sources":["../src/resources/albums.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,mCAAmC,EAAE;OACvC,EAAE,UAAU,EAAE;OACd,EAAiB,WAAW,EAAE;OAC9B,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;;OAGG;IACH,YAAY,CACV,KAAK,EAAE,uBAAuB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;OAGG;IACH,UAAU,CACR,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,MAAM,CAAC,qBAAqB,CAAC;CAMlF;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,OAAO,GAAG,QAAQ,GAAG,aAAa,CAAC;IAE/C;;;;;OAKG;IACH,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEjC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC,iBAAiB,CAAC;IAExC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAElC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,sBAAsB,EAAE,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC;IAEjD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;IAE/C;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IAE3C;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,gBAAgB,CAAC;IAEvC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,sBAAsB,CAAC;IAE7C;;OAEG;IACH,MAAM,CAAC,EAAE,qBAAqB,CAAC,MAAM,CAAC;CACvC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;QAE3C;;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,yBAAyB;IACxC,MAAM,EAAE,KAAK,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC;CAChD;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,KAAK;QACpB;;;WAGG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,OAAO,GAAG,QAAQ,GAAG,aAAa,CAAC;QAE/C;;;;;WAKG;QACH,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEjC;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC,iBAAiB,CAAC;QAExC;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAElC;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,sBAAsB,EAAE,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC;QAEjD;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,OAAO,CAAC;QAEd;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;;WAGG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;QAE/C;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QAE3C;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC,gBAAgB,CAAC;QAEvC;;WAEG;QACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEvB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC,sBAAsB,CAAC;QAE7C;;WAEG;QACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC;KACvB;IAED,UAAiB,KAAK,CAAC;QACrB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;YAE3C;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;YAEpB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC;;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,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH;AAED,OAAO,EAAE,KAAK,mCAAmC,EAAE,CAAC"}

package/resources/albums.d.ts

@@ -0,0 +1,333 @@
+import { APIResource } from "../core/resource.js";
+import * as Shared from "./shared.js";
+import { SimplifiedTrackObjectsCursorURLPage } from "./shared.js";
+import { APIPromise } from "../core/api-promise.js";
+import { PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Albums extends APIResource {
+    /**
+     * Get Spotify catalog information for a single album.
+     */
+    retrieve(id: string, query?: AlbumRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<AlbumRetrieveResponse>;
+    /**
+     * Get Spotify catalog information for multiple albums identified by their Spotify
+     * IDs.
+     */
+    bulkRetrieve(query: AlbumBulkRetrieveParams, options?: RequestOptions): APIPromise<AlbumBulkRetrieveResponse>;
+    /**
+     * Get Spotify catalog information about an album’s tracks. Optional parameters can
+     * be used to limit the number of tracks returned.
+     */
+    listTracks(id: string, query?: AlbumListTracksParams | null | undefined, options?: RequestOptions): PagePromise<SimplifiedTrackObjectsCursorURLPage, Shared.SimplifiedTrackObject>;
+}
+export interface AlbumRetrieveResponse {
+    /**
+     * 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 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;
+    /**
+     * 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 copyright statements of the album.
+     */
+    copyrights?: Array<Shared.CopyrightObject>;
+    /**
+     * Known external IDs for the album.
+     */
+    external_ids?: Shared.ExternalIDObject;
+    /**
+     * @deprecated **Deprecated** The array is always empty.
+     */
+    genres?: Array<string>;
+    /**
+     * The label associated with the album.
+     */
+    label?: string;
+    /**
+     * The popularity of the album. The value will be between 0 and 100, with 100 being
+     * the most popular.
+     */
+    popularity?: number;
+    /**
+     * Included in the response when a content restriction is applied.
+     */
+    restrictions?: Shared.AlbumRestrictionObject;
+    /**
+     * The tracks of the album.
+     */
+    tracks?: AlbumRetrieveResponse.Tracks;
+}
+export declare namespace AlbumRetrieveResponse {
+    /**
+     * The tracks of the album.
+     */
+    interface Tracks {
+        /**
+         * A link to the Web API endpoint returning the full result of the request
+         */
+        href: string;
+        items: Array<Shared.SimplifiedTrackObject>;
+        /**
+         * 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 AlbumBulkRetrieveResponse {
+    albums: Array<AlbumBulkRetrieveResponse.Album>;
+}
+export declare namespace AlbumBulkRetrieveResponse {
+    interface Album {
+        /**
+         * 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 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;
+        /**
+         * 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 copyright statements of the album.
+         */
+        copyrights?: Array<Shared.CopyrightObject>;
+        /**
+         * Known external IDs for the album.
+         */
+        external_ids?: Shared.ExternalIDObject;
+        /**
+         * @deprecated **Deprecated** The array is always empty.
+         */
+        genres?: Array<string>;
+        /**
+         * The label associated with the album.
+         */
+        label?: string;
+        /**
+         * The popularity of the album. The value will be between 0 and 100, with 100 being
+         * the most popular.
+         */
+        popularity?: number;
+        /**
+         * Included in the response when a content restriction is applied.
+         */
+        restrictions?: Shared.AlbumRestrictionObject;
+        /**
+         * The tracks of the album.
+         */
+        tracks?: Album.Tracks;
+    }
+    namespace Album {
+        /**
+         * The tracks of the album.
+         */
+        interface Tracks {
+            /**
+             * A link to the Web API endpoint returning the full result of the request
+             */
+            href: string;
+            items: Array<Shared.SimplifiedTrackObject>;
+            /**
+             * 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 AlbumRetrieveParams {
+    /**
+     * 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;
+}
+export interface AlbumBulkRetrieveParams {
+    /**
+     * A comma-separated list of the
+     * [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids) for the albums.
+     * Maximum: 20 IDs.
+     */
+    ids: string;
+    /**
+     * 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;
+}
+export interface AlbumListTracksParams {
+    /**
+     * The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+     */
+    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 item to return. Default: 0 (the first item). Use with
+     * limit to get the next set of items.
+     */
+    offset?: number;
+}
+export declare namespace Albums {
+    export { type AlbumRetrieveResponse as AlbumRetrieveResponse, type AlbumBulkRetrieveResponse as AlbumBulkRetrieveResponse, type AlbumRetrieveParams as AlbumRetrieveParams, type AlbumBulkRetrieveParams as AlbumBulkRetrieveParams, type AlbumListTracksParams as AlbumListTracksParams, };
+}
+export { type SimplifiedTrackObjectsCursorURLPage };
+//# sourceMappingURL=albums.d.ts.map

package/resources/albums.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"albums.d.ts","sourceRoot":"","sources":["../src/resources/albums.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,mCAAmC,EAAE;OACvC,EAAE,UAAU,EAAE;OACd,EAAiB,WAAW,EAAE;OAC9B,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;;OAGG;IACH,YAAY,CACV,KAAK,EAAE,uBAAuB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;OAGG;IACH,UAAU,CACR,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,MAAM,CAAC,qBAAqB,CAAC;CAMlF;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,OAAO,GAAG,QAAQ,GAAG,aAAa,CAAC;IAE/C;;;;;OAKG;IACH,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEjC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC,iBAAiB,CAAC;IAExC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAElC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,sBAAsB,EAAE,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC;IAEjD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;IAE/C;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IAE3C;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,gBAAgB,CAAC;IAEvC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,sBAAsB,CAAC;IAE7C;;OAEG;IACH,MAAM,CAAC,EAAE,qBAAqB,CAAC,MAAM,CAAC;CACvC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;QAE3C;;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,yBAAyB;IACxC,MAAM,EAAE,KAAK,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC;CAChD;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,KAAK;QACpB;;;WAGG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,OAAO,GAAG,QAAQ,GAAG,aAAa,CAAC;QAE/C;;;;;WAKG;QACH,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEjC;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC,iBAAiB,CAAC;QAExC;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAElC;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,sBAAsB,EAAE,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC;QAEjD;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,OAAO,CAAC;QAEd;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;;WAGG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;QAE/C;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QAE3C;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC,gBAAgB,CAAC;QAEvC;;WAEG;QACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEvB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC,sBAAsB,CAAC;QAE7C;;WAEG;QACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC;KACvB;IAED,UAAiB,KAAK,CAAC;QACrB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;YAE3C;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;YAEpB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC;;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,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH;AAED,OAAO,EAAE,KAAK,mCAAmC,EAAE,CAAC"}