spotted-ts 0.1.0 → 0.14.0

package/src/resources/me/player/player.ts

@@ -278,6 +278,15 @@ export interface ContextObject {
    */
   href?: 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, e.g. "artist", "playlist", "album", "show".
    */
@@ -321,6 +330,15 @@ export interface DeviceObject {
    */
   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;
+
   /**
    * If this device can be used to set the volume.
    */
@@ -370,6 +388,15 @@ export interface PlayerGetCurrentlyPlayingResponse {
    */
   progress_ms?: 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;
+
   /**
    * Unix Millisecond Timestamp when data was fetched
    */
@@ -392,6 +419,15 @@ export namespace PlayerGetCurrentlyPlayingResponse {
      */
     pausing?: 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;
+
     /**
      * Resuming. Optional field.
      */
@@ -476,6 +512,15 @@ export interface PlayerGetStateResponse {
    */
   progress_ms?: 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;
+
   /**
    * off, track, context
    */
@@ -509,6 +554,15 @@ export namespace PlayerGetStateResponse {
      */
     pausing?: 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;
+
     /**
      * Resuming. Optional field.
      */
@@ -562,6 +616,15 @@ export interface PlayerListRecentlyPlayedResponse {
    */
   played_at?: 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 track the user listened to.
    */
@@ -735,6 +798,15 @@ export interface PlayerStartPlaybackParams {
    */
   position_ms?: number;
 
+  /**
+   * Body param: 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;
+
   /**
    * Body param: Optional. A JSON array of the Spotify track URIs to play. For
    * example:
@@ -775,6 +847,15 @@ export interface PlayerTransferParams {
    */
   play?: 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;
+
   [k: string]: unknown;
 }
 

package/src/resources/me/player/queue.ts

@@ -47,6 +47,15 @@ export interface QueueGetResponse {
    */
   currently_playing?: Shared.TrackObject | 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;
+
   /**
    * The tracks or episodes in the queue. Can be empty.
    */

package/src/resources/me/shows.ts

@@ -87,6 +87,15 @@ export interface ShowListResponse {
    */
   added_at?: 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;
+
   /**
    * Information about the show.
    */
@@ -126,6 +135,15 @@ export interface ShowRemoveParams {
    * be ignored._
    */
   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;
 }
 
 export interface ShowSaveParams {
@@ -137,6 +155,15 @@ export interface ShowSaveParams {
    * be ignored._
    */
   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;
 }
 
 export declare namespace Shows {

package/src/resources/me/tracks.ts

@@ -87,6 +87,15 @@ export interface TrackListResponse {
    */
   added_at?: 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;
+
   /**
    * Information about the track.
    */
@@ -140,6 +149,15 @@ export interface TrackRemoveParams {
    */
   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;
 }
 
@@ -154,6 +172,15 @@ export interface TrackSaveParams {
    */
   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;
+
   /**
    * A JSON array of objects containing track IDs with their corresponding
    * timestamps. Each object must include a track ID and an `added_at` timestamp.

package/src/resources/playlists/followers.ts

@@ -78,12 +78,13 @@ export interface FollowerCheckParams {
 
 export interface FollowerFollowParams {
   /**
-   * Defaults to `true`. If `true` the playlist will be included in user's public
-   * playlists (added to profile), if `false` it will remain private. For more about
+   * 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)
    */
-  public?: boolean;
+  published?: boolean;
 
   [k: string]: unknown;
 }

package/src/resources/playlists/images.ts

@@ -13,20 +13,28 @@ export class Images extends APIResource {
    *
    * @example
    * ```ts
-   * await client.playlists.images.update(
+   * const image = await client.playlists.images.update(
    *   '3cEYpjA9oz9GiPac4AsH4n',
-   *   {
-   *     body: '/9j/2wCEABoZGSccJz4lJT5CLy8vQkc9Ozs9R0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0cBHCcnMyYzPSYmPUc9Mj1HR0dEREdHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR0dHR//dAAQAAf/uAA5BZG9iZQBkwAAAAAH/wAARCAABAAEDACIAAREBAhEB/8QASwABAQAAAAAAAAAAAAAAAAAAAAYBAQAAAAAAAAAAAAAAAAAAAAAQAQAAAAAAAAAAAAAAAAAAAAARAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwAAARECEQA/AJgAH//Z',
-   *   },
+   *   fs.createReadStream('path/to/file'),
    * );
+   *
+   * const content = await image.blob();
+   * console.log(content);
    * ```
    */
-  update(playlistID: string, params: ImageUpdateParams, options?: RequestOptions): APIPromise<void> {
-    const { body } = params;
+  update(
+    playlistID: string,
+    body: string | ArrayBuffer | ArrayBufferView | Blob | DataView,
+    options?: RequestOptions,
+  ): APIPromise<Response> {
     return this._client.put(path`/playlists/${playlistID}/images`, {
       body: body,
       ...options,
-      headers: buildHeaders([{ 'Content-Type': 'image/jpeg', Accept: '*/*' }, options?.headers]),
+      headers: buildHeaders([
+        { 'Content-Type': 'image/jpeg', Accept: 'application/binary' },
+        options?.headers,
+      ]),
+      __binaryResponse: true,
     });
   }
 
@@ -47,13 +55,6 @@ export class Images extends APIResource {
 
 export type ImageListResponse = Array<Shared.ImageObject>;
 
-export interface ImageUpdateParams {
-  /**
-   * Base64 encoded JPEG image data, maximum payload size is 256 KB.
-   */
-  body: string;
-}
-
 export declare namespace Images {
-  export { type ImageListResponse as ImageListResponse, type ImageUpdateParams as ImageUpdateParams };
+  export { type ImageListResponse as ImageListResponse };
 }

package/src/resources/playlists/index.ts

@@ -6,7 +6,7 @@ export {
   type FollowerCheckParams,
   type FollowerFollowParams,
 } from './followers';
-export { Images, type ImageListResponse, type ImageUpdateParams } from './images';
+export { Images, type ImageListResponse } from './images';
 export {
   Playlists,
   type PlaylistRetrieveResponse,

package/src/resources/playlists/playlists.ts

@@ -5,7 +5,7 @@ import * as Shared from '../shared';
 import * as FollowersAPI from './followers';
 import { FollowerCheckParams, FollowerCheckResponse, FollowerFollowParams, Followers } from './followers';
 import * as ImagesAPI from './images';
-import { ImageListResponse, ImageUpdateParams, Images } from './images';
+import { ImageListResponse, Images } from './images';
 import * as TracksAPI from './tracks';
 import {
   TrackAddParams,
@@ -120,12 +120,13 @@ export interface PlaylistRetrieveResponse {
   owner?: PlaylistRetrieveResponse.Owner;
 
   /**
-   * The playlist's public/private status (if it is added to the user's profile):
-   * `true` the playlist is public, `false` the playlist is private, `null` the
-   * playlist status is not relevant. For more about public/private status, see
+   * 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)
    */
-  public?: boolean;
+  published?: boolean;
 
   /**
    * The version identifier for the current playlist. Can be supplied in other
@@ -170,8 +171,6 @@ export namespace PlaylistRetrieveResponse {
      */
     href: string;
 
-    items: Array<Shared.PlaylistTrackObject>;
-
     /**
      * The maximum number of items in the response (as set in the query or by default).
      */
@@ -196,6 +195,17 @@ export namespace PlaylistRetrieveResponse {
      * The total number of items available to return.
      */
     total: number;
+
+    items?: Array<Shared.PlaylistTrackObject>;
+
+    /**
+     * 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;
   }
 }
 
@@ -264,7 +274,7 @@ export interface PlaylistUpdateParams {
    * public/private status, see
    * [Working with Playlists](/documentation/web-api/concepts/playlists)
    */
-  public?: boolean;
+  published?: boolean;
 
   [k: string]: unknown;
 }
@@ -298,9 +308,5 @@ export declare namespace Playlists {
     type FollowerFollowParams as FollowerFollowParams,
   };
 
-  export {
-    Images as Images,
-    type ImageListResponse as ImageListResponse,
-    type ImageUpdateParams as ImageUpdateParams,
-  };
+  export { Images as Images, type ImageListResponse as ImageListResponse };
 }

package/src/resources/playlists/tracks.ts

@@ -121,6 +121,15 @@ export interface TrackUpdateParams {
    */
   insert_before?: 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 amount of items to be reordered. Defaults to 1 if not set.<br/>The range of
    * items to be reordered begins from the _range_start_ position, and includes the
@@ -205,6 +214,15 @@ export interface TrackAddParams {
    */
   position?: 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;
+
   /**
    * A JSON array of the
    * [Spotify URIs](/documentation/web-api/concepts/spotify-uris-ids) to add. For
@@ -229,6 +247,15 @@ export interface TrackRemoveParams {
    */
   tracks: Array<TrackRemoveParams.Track>;
 
+  /**
+   * 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 playlist's snapshot ID against which you want to make the changes. The API
    * will validate that the specified items exist and in the specified positions and

package/src/resources/recommendations.ts

@@ -47,6 +47,15 @@ export interface RecommendationGetResponse {
    * An array of track objects ordered according to the parameters supplied.
    */
   tracks: Array<Shared.TrackObject>;
+
+  /**
+   * 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 RecommendationGetResponse {
@@ -80,6 +89,15 @@ export namespace RecommendationGetResponse {
      */
     initialPoolSize?: 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 entity type of this seed. One of `artist`, `track` or `genre`.
      */