spotted-ts 0.1.0 → 0.14.0

package/src/resources/chapters.ts

@@ -25,7 +25,10 @@ export class Chapters extends APIResource {
    * their Spotify IDs. Chapters are only available within the US, UK, Canada,
    * Ireland, New Zealand and Australia markets.
    */
-  list(query: ChapterListParams, options?: RequestOptions): APIPromise<ChapterListResponse> {
+  bulkRetrieve(
+    query: ChapterBulkRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<ChapterBulkRetrieveResponse> {
     return this._client.get('/chapters', { query, ...options });
   }
 }
@@ -134,6 +137,15 @@ export interface ChapterRetrieveResponse {
    */
   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.
    */
@@ -146,11 +158,11 @@ export interface ChapterRetrieveResponse {
   resume_point?: Shared.ResumePointObject;
 }
 
-export interface ChapterListResponse {
-  chapters: Array<ChapterListResponse.Chapter>;
+export interface ChapterBulkRetrieveResponse {
+  chapters: Array<ChapterBulkRetrieveResponse.Chapter>;
 }
 
-export namespace ChapterListResponse {
+export namespace ChapterBulkRetrieveResponse {
   export interface Chapter {
     /**
      * The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
@@ -255,6 +267,15 @@ export namespace ChapterListResponse {
      */
     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.
      */
@@ -283,7 +304,7 @@ export interface ChapterRetrieveParams {
   market?: string;
 }
 
-export interface ChapterListParams {
+export interface ChapterBulkRetrieveParams {
   /**
    * A comma-separated list of the
    * [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
@@ -308,8 +329,8 @@ export interface ChapterListParams {
 export declare namespace Chapters {
   export {
     type ChapterRetrieveResponse as ChapterRetrieveResponse,
-    type ChapterListResponse as ChapterListResponse,
+    type ChapterBulkRetrieveResponse as ChapterBulkRetrieveResponse,
     type ChapterRetrieveParams as ChapterRetrieveParams,
-    type ChapterListParams as ChapterListParams,
+    type ChapterBulkRetrieveParams as ChapterBulkRetrieveParams,
   };
 }

package/src/resources/episodes.ts

@@ -22,12 +22,15 @@ export class Episodes extends APIResource {
   /**
    * Get Spotify catalog information for several episodes based on their Spotify IDs.
    */
-  list(query: EpisodeListParams, options?: RequestOptions): APIPromise<EpisodeListResponse> {
+  bulkRetrieve(
+    query: EpisodeBulkRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<EpisodeBulkRetrieveResponse> {
     return this._client.get('/episodes', { query, ...options });
   }
 }
 
-export interface EpisodeListResponse {
+export interface EpisodeBulkRetrieveResponse {
   episodes: Array<Shared.EpisodeObject>;
 }
 
@@ -46,7 +49,7 @@ export interface EpisodeRetrieveParams {
   market?: string;
 }
 
-export interface EpisodeListParams {
+export interface EpisodeBulkRetrieveParams {
   /**
    * A comma-separated list of the
    * [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids) for the
@@ -70,8 +73,8 @@ export interface EpisodeListParams {
 
 export declare namespace Episodes {
   export {
-    type EpisodeListResponse as EpisodeListResponse,
+    type EpisodeBulkRetrieveResponse as EpisodeBulkRetrieveResponse,
     type EpisodeRetrieveParams as EpisodeRetrieveParams,
-    type EpisodeListParams as EpisodeListParams,
+    type EpisodeBulkRetrieveParams as EpisodeBulkRetrieveParams,
   };
 }

package/src/resources/index.ts

@@ -11,29 +11,29 @@ export {
 } from './albums';
 export {
   Artists,
-  type ArtistListResponse,
+  type ArtistBulkRetrieveResponse,
   type ArtistListAlbumsResponse,
   type ArtistListRelatedArtistsResponse,
-  type ArtistListTopTracksResponse,
-  type ArtistListParams,
+  type ArtistTopTracksResponse,
+  type ArtistBulkRetrieveParams,
   type ArtistListAlbumsParams,
-  type ArtistListTopTracksParams,
+  type ArtistTopTracksParams,
   type ArtistListAlbumsResponsesCursorURLPage,
 } from './artists';
 export { AudioAnalysis, type TimeIntervalObject, type AudioAnalysisRetrieveResponse } from './audio-analysis';
 export {
   AudioFeatures,
   type AudioFeatureRetrieveResponse,
-  type AudioFeatureListResponse,
-  type AudioFeatureListParams,
+  type AudioFeatureBulkRetrieveResponse,
+  type AudioFeatureBulkRetrieveParams,
 } from './audio-features';
 export {
   Audiobooks,
   type SimplifiedChapterObject,
   type AudiobookRetrieveResponse,
-  type AudiobookListResponse,
+  type AudiobookBulkRetrieveResponse,
   type AudiobookRetrieveParams,
-  type AudiobookListParams,
+  type AudiobookBulkRetrieveParams,
   type AudiobookListChaptersParams,
   type SimplifiedChapterObjectsCursorURLPage,
 } from './audiobooks';
@@ -47,15 +47,15 @@ export {
 export {
   Chapters,
   type ChapterRetrieveResponse,
-  type ChapterListResponse,
+  type ChapterBulkRetrieveResponse,
   type ChapterRetrieveParams,
-  type ChapterListParams,
+  type ChapterBulkRetrieveParams,
 } from './chapters';
 export {
   Episodes,
-  type EpisodeListResponse,
+  type EpisodeBulkRetrieveResponse,
   type EpisodeRetrieveParams,
-  type EpisodeListParams,
+  type EpisodeBulkRetrieveParams,
 } from './episodes';
 export { Markets, type MarketListResponse } from './markets';
 export { Me, type MeRetrieveResponse } from './me/me';
@@ -71,14 +71,19 @@ export {
   type RecommendationListAvailableGenreSeedsResponse,
   type RecommendationGetParams,
 } from './recommendations';
-export { Search, type SearchRetrieveResponse, type SearchRetrieveParams } from './search';
+export { Search, type SearchQueryResponse, type SearchQueryParams } from './search';
 export {
   Shows,
   type ShowRetrieveResponse,
-  type ShowListResponse,
+  type ShowBulkRetrieveResponse,
   type ShowRetrieveParams,
-  type ShowListParams,
+  type ShowBulkRetrieveParams,
   type ShowListEpisodesParams,
 } from './shows';
-export { Tracks, type TrackListResponse, type TrackRetrieveParams, type TrackListParams } from './tracks';
+export {
+  Tracks,
+  type TrackBulkRetrieveResponse,
+  type TrackRetrieveParams,
+  type TrackBulkRetrieveParams,
+} from './tracks';
 export { Users, type UserRetrieveProfileResponse } from './users/users';

package/src/resources/me/albums.ts

@@ -91,6 +91,15 @@ export interface AlbumListResponse {
    * Information about the album.
    */
   album?: AlbumListResponse.Album;
+
+  /**
+   * 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 AlbumListResponse {
@@ -196,6 +205,15 @@ export namespace AlbumListResponse {
      */
     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.
      */
@@ -217,8 +235,6 @@ export namespace AlbumListResponse {
        */
       href: string;
 
-      items: Array<Shared.SimplifiedTrackObject>;
-
       /**
        * The maximum number of items in the response (as set in the query or by default).
        */
@@ -243,6 +259,17 @@ export namespace AlbumListResponse {
        * 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;
     }
   }
 }
@@ -294,6 +321,15 @@ export interface AlbumRemoveParams {
    */
   ids?: 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;
+
   [k: string]: unknown;
 }
 
@@ -307,6 +343,15 @@ export interface AlbumSaveParams {
    */
   ids?: 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;
+
   [k: string]: unknown;
 }
 

package/src/resources/me/audiobooks.ts

@@ -101,6 +101,15 @@ export interface AudiobookListResponse {
    * Information about the audiobook.
    */
   audiobook?: AudiobookListResponse.Audiobook;
+
+  /**
+   * 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 AudiobookListResponse {
@@ -124,8 +133,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).
        */
@@ -150,6 +157,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;
     }
   }
 }

package/src/resources/me/episodes.ts

@@ -100,6 +100,15 @@ export interface EpisodeListResponse {
    * Information about the episode.
    */
   episode?: Shared.EpisodeObject;
+
+  /**
+   * 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 type EpisodeCheckResponse = Array<boolean>;
@@ -149,6 +158,15 @@ export interface EpisodeRemoveParams {
    */
   ids?: 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;
+
   [k: string]: unknown;
 }
 
@@ -162,6 +180,15 @@ export interface EpisodeSaveParams {
    */
   ids: 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;
+
   [k: string]: unknown;
 }
 

package/src/resources/me/following.ts

@@ -12,12 +12,15 @@ export class Following extends APIResource {
    *
    * @example
    * ```ts
-   * const followings = await client.me.following.list({
+   * const response = await client.me.following.bulkRetrieve({
    *   type: 'artist',
    * });
    * ```
    */
-  list(query: FollowingListParams, options?: RequestOptions): APIPromise<FollowingListResponse> {
+  bulkRetrieve(
+    query: FollowingBulkRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<FollowingBulkRetrieveResponse> {
     return this._client.get('/me/following', { query, ...options });
   }
 
@@ -75,11 +78,11 @@ export class Following extends APIResource {
   }
 }
 
-export interface FollowingListResponse {
-  artists: FollowingListResponse.Artists;
+export interface FollowingBulkRetrieveResponse {
+  artists: FollowingBulkRetrieveResponse.Artists;
 }
 
-export namespace FollowingListResponse {
+export namespace FollowingBulkRetrieveResponse {
   export interface Artists {
     /**
      * The cursors used to find the next set of items.
@@ -103,6 +106,15 @@ export namespace FollowingListResponse {
      */
     next?: 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;
+
     /**
      * The total number of items available to return.
      */
@@ -123,13 +135,22 @@ export namespace FollowingListResponse {
        * The cursor to use as key to find the previous page of items.
        */
       before?: 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 type FollowingCheckResponse = Array<boolean>;
 
-export interface FollowingListParams {
+export interface FollowingBulkRetrieveParams {
   /**
    * The ID type: currently only `artist` is supported.
    */
@@ -171,6 +192,15 @@ export interface FollowingFollowParams {
    */
   ids: 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;
+
   [k: string]: unknown;
 }
 
@@ -184,14 +214,23 @@ export interface FollowingUnfollowParams {
    */
   ids?: 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;
+
   [k: string]: unknown;
 }
 
 export declare namespace Following {
   export {
-    type FollowingListResponse as FollowingListResponse,
+    type FollowingBulkRetrieveResponse as FollowingBulkRetrieveResponse,
     type FollowingCheckResponse as FollowingCheckResponse,
-    type FollowingListParams as FollowingListParams,
+    type FollowingBulkRetrieveParams as FollowingBulkRetrieveParams,
     type FollowingCheckParams as FollowingCheckParams,
     type FollowingFollowParams as FollowingFollowParams,
     type FollowingUnfollowParams as FollowingUnfollowParams,

package/src/resources/me/index.ts

@@ -32,9 +32,9 @@ export {
 } from './episodes';
 export {
   Following,
-  type FollowingListResponse,
+  type FollowingBulkRetrieveResponse,
   type FollowingCheckResponse,
-  type FollowingListParams,
+  type FollowingBulkRetrieveParams,
   type FollowingCheckParams,
   type FollowingFollowParams,
   type FollowingUnfollowParams,

package/src/resources/me/me.ts

@@ -38,11 +38,11 @@ import {
 import * as FollowingAPI from './following';
 import {
   Following,
+  FollowingBulkRetrieveParams,
+  FollowingBulkRetrieveResponse,
   FollowingCheckParams,
   FollowingCheckResponse,
   FollowingFollowParams,
-  FollowingListParams,
-  FollowingListResponse,
   FollowingUnfollowParams,
 } from './following';
 import * as PlaylistsAPI from './playlists';
@@ -190,6 +190,15 @@ export interface MeRetrieveResponse {
    */
   product?: 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;
+
   /**
    * The object type: "user"
    */
@@ -220,6 +229,15 @@ export namespace MeRetrieveResponse {
      * changed by the user.
      */
     filter_locked?: boolean;
+
+    /**
+     * 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;
   }
 }
 
@@ -301,9 +319,9 @@ export declare namespace Me {
 
   export {
     Following as Following,
-    type FollowingListResponse as FollowingListResponse,
+    type FollowingBulkRetrieveResponse as FollowingBulkRetrieveResponse,
     type FollowingCheckResponse as FollowingCheckResponse,
-    type FollowingListParams as FollowingListParams,
+    type FollowingBulkRetrieveParams as FollowingBulkRetrieveParams,
     type FollowingCheckParams as FollowingCheckParams,
     type FollowingFollowParams as FollowingFollowParams,
     type FollowingUnfollowParams as FollowingUnfollowParams,