spotted-ts 0.1.0 → 0.13.0

package/src/resources/albums.ts

@@ -146,6 +146,15 @@ export interface AlbumRetrieveResponse {
    */
   popularity?: number;
 
+  /**
+   * The playlist's public/private status (if it should be added to the user's
+   * profile or not): `true` the playlist will be public, `false` the playlist will
+   * be private, `null` the playlist status is not relevant. For more about
+   * public/private status, see
+   * [Working with Playlists](/documentation/web-api/concepts/playlists)
+   */
+  published?: boolean;
+
   /**
    * Included in the response when a content restriction is applied.
    */
@@ -167,8 +176,6 @@ export namespace AlbumRetrieveResponse {
      */
     href: string;
 
-    items: Array<Shared.SimplifiedTrackObject>;
-
     /**
      * The maximum number of items in the response (as set in the query or by default).
      */
@@ -193,6 +200,17 @@ export namespace AlbumRetrieveResponse {
      * The total number of items available to return.
      */
     total: number;
+
+    items?: Array<Shared.SimplifiedTrackObject>;
+
+    /**
+     * The playlist's public/private status (if it should be added to the user's
+     * profile or not): `true` the playlist will be public, `false` the playlist will
+     * be private, `null` the playlist status is not relevant. For more about
+     * public/private status, see
+     * [Working with Playlists](/documentation/web-api/concepts/playlists)
+     */
+    published?: boolean;
   }
 }
 
@@ -300,6 +318,15 @@ export namespace AlbumBulkRetrieveResponse {
      */
     popularity?: number;
 
+    /**
+     * The playlist's public/private status (if it should be added to the user's
+     * profile or not): `true` the playlist will be public, `false` the playlist will
+     * be private, `null` the playlist status is not relevant. For more about
+     * public/private status, see
+     * [Working with Playlists](/documentation/web-api/concepts/playlists)
+     */
+    published?: boolean;
+
     /**
      * Included in the response when a content restriction is applied.
      */
@@ -321,8 +348,6 @@ export namespace AlbumBulkRetrieveResponse {
        */
       href: string;
 
-      items: Array<Shared.SimplifiedTrackObject>;
-
       /**
        * The maximum number of items in the response (as set in the query or by default).
        */
@@ -347,6 +372,17 @@ export namespace AlbumBulkRetrieveResponse {
        * The total number of items available to return.
        */
       total: number;
+
+      items?: Array<Shared.SimplifiedTrackObject>;
+
+      /**
+       * The playlist's public/private status (if it should be added to the user's
+       * profile or not): `true` the playlist will be public, `false` the playlist will
+       * be private, `null` the playlist status is not relevant. For more about
+       * public/private status, see
+       * [Working with Playlists](/documentation/web-api/concepts/playlists)
+       */
+      published?: boolean;
     }
   }
 }

package/src/resources/artists.ts

@@ -19,7 +19,10 @@ export class Artists extends APIResource {
   /**
    * Get Spotify catalog information for several artists based on their Spotify IDs.
    */
-  list(query: ArtistListParams, options?: RequestOptions): APIPromise<ArtistListResponse> {
+  bulkRetrieve(
+    query: ArtistBulkRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<ArtistBulkRetrieveResponse> {
     return this._client.get('/artists', { query, ...options });
   }
 
@@ -50,18 +53,18 @@ export class Artists extends APIResource {
   /**
    * Get Spotify catalog information about an artist's top tracks by country.
    */
-  listTopTracks(
+  topTracks(
     id: string,
-    query: ArtistListTopTracksParams | null | undefined = {},
+    query: ArtistTopTracksParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<ArtistListTopTracksResponse> {
+  ): APIPromise<ArtistTopTracksResponse> {
     return this._client.get(path`/artists/${id}/top-tracks`, { query, ...options });
   }
 }
 
 export type ArtistListAlbumsResponsesCursorURLPage = CursorURLPage<ArtistListAlbumsResponse>;
 
-export interface ArtistListResponse {
+export interface ArtistBulkRetrieveResponse {
   artists: Array<Shared.ArtistObject>;
 }
 
@@ -143,6 +146,15 @@ export interface ArtistListAlbumsResponse {
    */
   uri: string;
 
+  /**
+   * The playlist's public/private status (if it should be added to the user's
+   * profile or not): `true` the playlist will be public, `false` the playlist will
+   * be private, `null` the playlist status is not relevant. For more about
+   * public/private status, see
+   * [Working with Playlists](/documentation/web-api/concepts/playlists)
+   */
+  published?: boolean;
+
   /**
    * Included in the response when a content restriction is applied.
    */
@@ -153,11 +165,11 @@ export interface ArtistListRelatedArtistsResponse {
   artists: Array<Shared.ArtistObject>;
 }
 
-export interface ArtistListTopTracksResponse {
+export interface ArtistTopTracksResponse {
   tracks: Array<Shared.TrackObject>;
 }
 
-export interface ArtistListParams {
+export interface ArtistBulkRetrieveParams {
   /**
    * A comma-separated list of the
    * [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids) for the artists.
@@ -200,7 +212,7 @@ export interface ArtistListAlbumsParams {
   offset?: number;
 }
 
-export interface ArtistListTopTracksParams {
+export interface ArtistTopTracksParams {
   /**
    * An
    * [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
@@ -217,13 +229,13 @@ export interface ArtistListTopTracksParams {
 
 export declare namespace Artists {
   export {
-    type ArtistListResponse as ArtistListResponse,
+    type ArtistBulkRetrieveResponse as ArtistBulkRetrieveResponse,
     type ArtistListAlbumsResponse as ArtistListAlbumsResponse,
     type ArtistListRelatedArtistsResponse as ArtistListRelatedArtistsResponse,
-    type ArtistListTopTracksResponse as ArtistListTopTracksResponse,
+    type ArtistTopTracksResponse as ArtistTopTracksResponse,
     type ArtistListAlbumsResponsesCursorURLPage as ArtistListAlbumsResponsesCursorURLPage,
-    type ArtistListParams as ArtistListParams,
+    type ArtistBulkRetrieveParams as ArtistBulkRetrieveParams,
     type ArtistListAlbumsParams as ArtistListAlbumsParams,
-    type ArtistListTopTracksParams as ArtistListTopTracksParams,
+    type ArtistTopTracksParams as ArtistTopTracksParams,
   };
 }

package/src/resources/audio-analysis.ts

@@ -29,6 +29,15 @@ export interface TimeIntervalObject {
    */
   duration?: number;
 
+  /**
+   * The playlist's public/private status (if it should be added to the user's
+   * profile or not): `true` the playlist will be public, `false` the playlist will
+   * be private, `null` the playlist status is not relevant. For more about
+   * public/private status, see
+   * [Working with Playlists](/documentation/web-api/concepts/playlists)
+   */
+  published?: boolean;
+
   /**
    * The starting point (in seconds) of the time interval.
    */
@@ -51,6 +60,15 @@ export interface AudioAnalysisRetrieveResponse {
 
   meta?: AudioAnalysisRetrieveResponse.Meta;
 
+  /**
+   * The playlist's public/private status (if it should be added to the user's
+   * profile or not): `true` the playlist will be public, `false` the playlist will
+   * be private, `null` the playlist status is not relevant. For more about
+   * public/private status, see
+   * [Working with Playlists](/documentation/web-api/concepts/playlists)
+   */
+  published?: boolean;
+
   /**
    * Sections are defined by large variations in rhythm or timbre, e.g. chorus,
    * verse, bridge, guitar solo, etc. Each section contains its own descriptions of
@@ -157,6 +175,15 @@ export namespace AudioAnalysisRetrieveResponse {
      */
     mode_confidence?: number;
 
+    /**
+     * The playlist's public/private status (if it should be added to the user's
+     * profile or not): `true` the playlist will be public, `false` the playlist will
+     * be private, `null` the playlist status is not relevant. For more about
+     * public/private status, see
+     * [Working with Playlists](/documentation/web-api/concepts/playlists)
+     */
+    published?: boolean;
+
     /**
      * The starting point (in seconds) of the section.
      */
@@ -245,6 +272,15 @@ export namespace AudioAnalysisRetrieveResponse {
      */
     pitches?: Array<number>;
 
+    /**
+     * The playlist's public/private status (if it should be added to the user's
+     * profile or not): `true` the playlist will be public, `false` the playlist will
+     * be private, `null` the playlist status is not relevant. For more about
+     * public/private status, see
+     * [Working with Playlists](/documentation/web-api/concepts/playlists)
+     */
+    published?: boolean;
+
     /**
      * The starting point (in seconds) of the segment.
      */

package/src/resources/audio-features.ts

@@ -21,7 +21,10 @@ export class AudioFeatures extends APIResource {
    *
    * @deprecated
    */
-  list(query: AudioFeatureListParams, options?: RequestOptions): APIPromise<AudioFeatureListResponse> {
+  bulkRetrieve(
+    query: AudioFeatureBulkRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<AudioFeatureBulkRetrieveResponse> {
     return this._client.get('/audio-features', { query, ...options });
   }
 }
@@ -104,6 +107,15 @@ export interface AudioFeatureRetrieveResponse {
    */
   mode?: number;
 
+  /**
+   * The playlist's public/private status (if it should be added to the user's
+   * profile or not): `true` the playlist will be public, `false` the playlist will
+   * be private, `null` the playlist status is not relevant. For more about
+   * public/private status, see
+   * [Working with Playlists](/documentation/web-api/concepts/playlists)
+   */
+  published?: boolean;
+
   /**
    * Speechiness detects the presence of spoken words in a track. The more
    * exclusively speech-like the recording (e.g. talk show, audio book, poetry), the
@@ -153,11 +165,11 @@ export interface AudioFeatureRetrieveResponse {
   valence?: number;
 }
 
-export interface AudioFeatureListResponse {
-  audio_features: Array<AudioFeatureListResponse.AudioFeature>;
+export interface AudioFeatureBulkRetrieveResponse {
+  audio_features: Array<AudioFeatureBulkRetrieveResponse.AudioFeature>;
 }
 
-export namespace AudioFeatureListResponse {
+export namespace AudioFeatureBulkRetrieveResponse {
   export interface AudioFeature {
     /**
      * The Spotify ID for the track.
@@ -236,6 +248,15 @@ export namespace AudioFeatureListResponse {
      */
     mode?: number;
 
+    /**
+     * The playlist's public/private status (if it should be added to the user's
+     * profile or not): `true` the playlist will be public, `false` the playlist will
+     * be private, `null` the playlist status is not relevant. For more about
+     * public/private status, see
+     * [Working with Playlists](/documentation/web-api/concepts/playlists)
+     */
+    published?: boolean;
+
     /**
      * Speechiness detects the presence of spoken words in a track. The more
      * exclusively speech-like the recording (e.g. talk show, audio book, poetry), the
@@ -286,7 +307,7 @@ export namespace AudioFeatureListResponse {
   }
 }
 
-export interface AudioFeatureListParams {
+export interface AudioFeatureBulkRetrieveParams {
   /**
    * A comma-separated list of the
    * [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids) for the tracks.
@@ -298,7 +319,7 @@ export interface AudioFeatureListParams {
 export declare namespace AudioFeatures {
   export {
     type AudioFeatureRetrieveResponse as AudioFeatureRetrieveResponse,
-    type AudioFeatureListResponse as AudioFeatureListResponse,
-    type AudioFeatureListParams as AudioFeatureListParams,
+    type AudioFeatureBulkRetrieveResponse as AudioFeatureBulkRetrieveResponse,
+    type AudioFeatureBulkRetrieveParams as AudioFeatureBulkRetrieveParams,
   };
 }

package/src/resources/audiobooks.ts

@@ -26,7 +26,10 @@ export class Audiobooks extends APIResource {
    * Spotify IDs. Audiobooks are only available within the US, UK, Canada, Ireland,
    * New Zealand and Australia markets.
    */
-  list(query: AudiobookListParams, options?: RequestOptions): APIPromise<AudiobookListResponse> {
+  bulkRetrieve(
+    query: AudiobookBulkRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<AudiobookBulkRetrieveResponse> {
     return this._client.get('/audiobooks', { query, ...options });
   }
 
@@ -148,6 +151,15 @@ export interface SimplifiedChapterObject {
    */
   available_markets?: Array<string>;
 
+  /**
+   * The playlist's public/private status (if it should be added to the user's
+   * profile or not): `true` the playlist will be public, `false` the playlist will
+   * be private, `null` the playlist status is not relevant. For more about
+   * public/private status, see
+   * [Working with Playlists](/documentation/web-api/concepts/playlists)
+   */
+  published?: boolean;
+
   /**
    * Included in the response when a content restriction is applied.
    */
@@ -177,8 +189,6 @@ export namespace AudiobookRetrieveResponse {
      */
     href: string;
 
-    items: Array<AudiobooksAPI.SimplifiedChapterObject>;
-
     /**
      * The maximum number of items in the response (as set in the query or by default).
      */
@@ -203,14 +213,25 @@ export namespace AudiobookRetrieveResponse {
      * The total number of items available to return.
      */
     total: number;
+
+    items?: Array<AudiobooksAPI.SimplifiedChapterObject>;
+
+    /**
+     * The playlist's public/private status (if it should be added to the user's
+     * profile or not): `true` the playlist will be public, `false` the playlist will
+     * be private, `null` the playlist status is not relevant. For more about
+     * public/private status, see
+     * [Working with Playlists](/documentation/web-api/concepts/playlists)
+     */
+    published?: boolean;
   }
 }
 
-export interface AudiobookListResponse {
-  audiobooks: Array<AudiobookListResponse.Audiobook>;
+export interface AudiobookBulkRetrieveResponse {
+  audiobooks: Array<AudiobookBulkRetrieveResponse.Audiobook>;
 }
 
-export namespace AudiobookListResponse {
+export namespace AudiobookBulkRetrieveResponse {
   export interface Audiobook extends Shared.AudiobookBase {
     /**
      * The chapters of the audiobook.
@@ -228,8 +249,6 @@ export namespace AudiobookListResponse {
        */
       href: string;
 
-      items: Array<AudiobooksAPI.SimplifiedChapterObject>;
-
       /**
        * The maximum number of items in the response (as set in the query or by default).
        */
@@ -254,6 +273,17 @@ export namespace AudiobookListResponse {
        * The total number of items available to return.
        */
       total: number;
+
+      items?: Array<AudiobooksAPI.SimplifiedChapterObject>;
+
+      /**
+       * The playlist's public/private status (if it should be added to the user's
+       * profile or not): `true` the playlist will be public, `false` the playlist will
+       * be private, `null` the playlist status is not relevant. For more about
+       * public/private status, see
+       * [Working with Playlists](/documentation/web-api/concepts/playlists)
+       */
+      published?: boolean;
     }
   }
 }
@@ -273,7 +303,7 @@ export interface AudiobookRetrieveParams {
   market?: string;
 }
 
-export interface AudiobookListParams {
+export interface AudiobookBulkRetrieveParams {
   /**
    * A comma-separated list of the
    * [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
@@ -325,10 +355,10 @@ export declare namespace Audiobooks {
   export {
     type SimplifiedChapterObject as SimplifiedChapterObject,
     type AudiobookRetrieveResponse as AudiobookRetrieveResponse,
-    type AudiobookListResponse as AudiobookListResponse,
+    type AudiobookBulkRetrieveResponse as AudiobookBulkRetrieveResponse,
     type SimplifiedChapterObjectsCursorURLPage as SimplifiedChapterObjectsCursorURLPage,
     type AudiobookRetrieveParams as AudiobookRetrieveParams,
-    type AudiobookListParams as AudiobookListParams,
+    type AudiobookBulkRetrieveParams as AudiobookBulkRetrieveParams,
     type AudiobookListChaptersParams as AudiobookListChaptersParams,
   };
 }

package/src/resources/browse/browse.ts

@@ -9,6 +9,7 @@ import {
   CategoryGetPlaylistsResponse,
   CategoryListParams,
   CategoryListResponse,
+  CategoryListResponsesCursorURLPage,
   CategoryRetrieveParams,
   CategoryRetrieveResponse,
 } from './categories';
@@ -50,6 +51,15 @@ export interface BrowseGetFeaturedPlaylistsResponse {
   message?: string;
 
   playlists?: Shared.PagingPlaylistObject;
+
+  /**
+   * The playlist's public/private status (if it should be added to the user's
+   * profile or not): `true` the playlist will be public, `false` the playlist will
+   * be private, `null` the playlist status is not relevant. For more about
+   * public/private status, see
+   * [Working with Playlists](/documentation/web-api/concepts/playlists)
+   */
+  published?: boolean;
 }
 
 export interface BrowseGetNewReleasesResponse {
@@ -63,8 +73,6 @@ export namespace BrowseGetNewReleasesResponse {
      */
     href: string;
 
-    items: Array<Albums.Item>;
-
     /**
      * The maximum number of items in the response (as set in the query or by default).
      */
@@ -89,6 +97,17 @@ export namespace BrowseGetNewReleasesResponse {
      * The total number of items available to return.
      */
     total: number;
+
+    items?: Array<Albums.Item>;
+
+    /**
+     * The playlist's public/private status (if it should be added to the user's
+     * profile or not): `true` the playlist will be public, `false` the playlist will
+     * be private, `null` the playlist status is not relevant. For more about
+     * public/private status, see
+     * [Working with Playlists](/documentation/web-api/concepts/playlists)
+     */
+    published?: boolean;
   }
 
   export namespace Albums {
@@ -165,6 +184,15 @@ export namespace BrowseGetNewReleasesResponse {
        */
       uri: string;
 
+      /**
+       * The playlist's public/private status (if it should be added to the user's
+       * profile or not): `true` the playlist will be public, `false` the playlist will
+       * be private, `null` the playlist status is not relevant. For more about
+       * public/private status, see
+       * [Working with Playlists](/documentation/web-api/concepts/playlists)
+       */
+      published?: boolean;
+
       /**
        * Included in the response when a content restriction is applied.
        */
@@ -226,6 +254,7 @@ export declare namespace Browse {
     type CategoryRetrieveResponse as CategoryRetrieveResponse,
     type CategoryListResponse as CategoryListResponse,
     type CategoryGetPlaylistsResponse as CategoryGetPlaylistsResponse,
+    type CategoryListResponsesCursorURLPage as CategoryListResponsesCursorURLPage,
     type CategoryRetrieveParams as CategoryRetrieveParams,
     type CategoryListParams as CategoryListParams,
     type CategoryGetPlaylistsParams as CategoryGetPlaylistsParams,

package/src/resources/browse/categories.ts

@@ -3,6 +3,7 @@
 import { APIResource } from '../../core/resource';
 import * as Shared from '../shared';
 import { APIPromise } from '../../core/api-promise';
+import { CursorURLPage, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
@@ -26,8 +27,11 @@ export class Categories extends APIResource {
   list(
     query: CategoryListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CategoryListResponse> {
-    return this._client.get('/browse/categories', { query, ...options });
+  ): PagePromise<CategoryListResponsesCursorURLPage, CategoryListResponse> {
+    return this._client.getAPIList('/browse/categories', CursorURLPage<CategoryListResponse>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -44,6 +48,8 @@ export class Categories extends APIResource {
   }
 }
 
+export type CategoryListResponsesCursorURLPage = CursorURLPage<CategoryListResponse>;
+
 export interface CategoryRetrieveResponse {
   /**
    * The [Spotify category ID](/documentation/web-api/concepts/spotify-uris-ids) of
@@ -65,71 +71,47 @@ export interface CategoryRetrieveResponse {
    * The name of the category.
    */
   name: string;
+
+  /**
+   * The playlist's public/private status (if it should be added to the user's
+   * profile or not): `true` the playlist will be public, `false` the playlist will
+   * be private, `null` the playlist status is not relevant. For more about
+   * public/private status, see
+   * [Working with Playlists](/documentation/web-api/concepts/playlists)
+   */
+  published?: boolean;
 }
 
 export interface CategoryListResponse {
-  categories: CategoryListResponse.Categories;
-}
+  /**
+   * The [Spotify category ID](/documentation/web-api/concepts/spotify-uris-ids) of
+   * the category.
+   */
+  id: string;
 
-export namespace CategoryListResponse {
-  export interface Categories {
-    /**
-     * A link to the Web API endpoint returning the full result of the request
-     */
-    href: string;
-
-    items: Array<Categories.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;
-  }
+  /**
+   * A link to the Web API endpoint returning full details of the category.
+   */
+  href: string;
 
-  export namespace Categories {
-    export interface Item {
-      /**
-       * The [Spotify category ID](/documentation/web-api/concepts/spotify-uris-ids) of
-       * the category.
-       */
-      id: string;
-
-      /**
-       * A link to the Web API endpoint returning full details of the category.
-       */
-      href: string;
-
-      /**
-       * The category icon, in various sizes.
-       */
-      icons: Array<Shared.ImageObject>;
-
-      /**
-       * The name of the category.
-       */
-      name: string;
-    }
-  }
+  /**
+   * The category icon, in various sizes.
+   */
+  icons: Array<Shared.ImageObject>;
+
+  /**
+   * The name of the category.
+   */
+  name: string;
+
+  /**
+   * The playlist's public/private status (if it should be added to the user's
+   * profile or not): `true` the playlist will be public, `false` the playlist will
+   * be private, `null` the playlist status is not relevant. For more about
+   * public/private status, see
+   * [Working with Playlists](/documentation/web-api/concepts/playlists)
+   */
+  published?: boolean;
 }
 
 export interface CategoryGetPlaylistsResponse {
@@ -139,6 +121,15 @@ export interface CategoryGetPlaylistsResponse {
   message?: string;
 
   playlists?: Shared.PagingPlaylistObject;
+
+  /**
+   * The playlist's public/private status (if it should be added to the user's
+   * profile or not): `true` the playlist will be public, `false` the playlist will
+   * be private, `null` the playlist status is not relevant. For more about
+   * public/private status, see
+   * [Working with Playlists](/documentation/web-api/concepts/playlists)
+   */
+  published?: boolean;
 }
 
 export interface CategoryRetrieveParams {
@@ -198,6 +189,7 @@ export declare namespace Categories {
     type CategoryRetrieveResponse as CategoryRetrieveResponse,
     type CategoryListResponse as CategoryListResponse,
     type CategoryGetPlaylistsResponse as CategoryGetPlaylistsResponse,
+    type CategoryListResponsesCursorURLPage as CategoryListResponsesCursorURLPage,
     type CategoryRetrieveParams as CategoryRetrieveParams,
     type CategoryListParams as CategoryListParams,
     type CategoryGetPlaylistsParams as CategoryGetPlaylistsParams,

package/src/resources/browse/index.ts

@@ -15,4 +15,5 @@ export {
   type CategoryRetrieveParams,
   type CategoryListParams,
   type CategoryGetPlaylistsParams,
+  type CategoryListResponsesCursorURLPage,
 } from './categories';