spotted-ts 0.1.0 → 0.14.0

package/src/resources/search.ts

@@ -11,36 +11,34 @@ export class Search extends APIResource {
    * episodes or audiobooks that match a keyword string. Audiobooks are only
    * available within the US, UK, Canada, Ireland, New Zealand and Australia markets.
    */
-  retrieve(query: SearchRetrieveParams, options?: RequestOptions): APIPromise<SearchRetrieveResponse> {
+  query(query: SearchQueryParams, options?: RequestOptions): APIPromise<SearchQueryResponse> {
     return this._client.get('/search', { query, ...options });
   }
 }
 
-export interface SearchRetrieveResponse {
-  albums?: SearchRetrieveResponse.Albums;
+export interface SearchQueryResponse {
+  albums?: SearchQueryResponse.Albums;
 
-  artists?: SearchRetrieveResponse.Artists;
+  artists?: SearchQueryResponse.Artists;
 
-  audiobooks?: SearchRetrieveResponse.Audiobooks;
+  audiobooks?: SearchQueryResponse.Audiobooks;
 
-  episodes?: SearchRetrieveResponse.Episodes;
+  episodes?: SearchQueryResponse.Episodes;
 
   playlists?: Shared.PagingPlaylistObject;
 
-  shows?: SearchRetrieveResponse.Shows;
+  shows?: SearchQueryResponse.Shows;
 
-  tracks?: SearchRetrieveResponse.Tracks;
+  tracks?: SearchQueryResponse.Tracks;
 }
 
-export namespace SearchRetrieveResponse {
+export namespace SearchQueryResponse {
   export interface Albums {
     /**
      * A link to the Web API endpoint returning the full result of the request
      */
     href: string;
 
-    items: Array<Albums.Item>;
-
     /**
      * The maximum number of items in the response (as set in the query or by default).
      */
@@ -65,6 +63,17 @@ export namespace SearchRetrieveResponse {
      * 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 {
@@ -141,6 +150,15 @@ export namespace SearchRetrieveResponse {
        */
       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.
        */
@@ -154,8 +172,6 @@ export namespace SearchRetrieveResponse {
      */
     href: string;
 
-    items: Array<Shared.ArtistObject>;
-
     /**
      * The maximum number of items in the response (as set in the query or by default).
      */
@@ -180,6 +196,17 @@ export namespace SearchRetrieveResponse {
      * The total number of items available to return.
      */
     total: number;
+
+    items?: Array<Shared.ArtistObject>;
+
+    /**
+     * 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 Audiobooks {
@@ -188,8 +215,6 @@ export namespace SearchRetrieveResponse {
      */
     href: string;
 
-    items: Array<Shared.AudiobookBase>;
-
     /**
      * The maximum number of items in the response (as set in the query or by default).
      */
@@ -214,6 +239,17 @@ export namespace SearchRetrieveResponse {
      * The total number of items available to return.
      */
     total: number;
+
+    items?: Array<Shared.AudiobookBase>;
+
+    /**
+     * 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 Episodes {
@@ -222,8 +258,6 @@ export namespace SearchRetrieveResponse {
      */
     href: string;
 
-    items: Array<Shared.SimplifiedEpisodeObject>;
-
     /**
      * The maximum number of items in the response (as set in the query or by default).
      */
@@ -248,6 +282,17 @@ export namespace SearchRetrieveResponse {
      * The total number of items available to return.
      */
     total: number;
+
+    items?: Array<Shared.SimplifiedEpisodeObject>;
+
+    /**
+     * 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 Shows {
@@ -256,8 +301,6 @@ export namespace SearchRetrieveResponse {
      */
     href: string;
 
-    items: Array<Shared.ShowBase>;
-
     /**
      * The maximum number of items in the response (as set in the query or by default).
      */
@@ -282,6 +325,17 @@ export namespace SearchRetrieveResponse {
      * The total number of items available to return.
      */
     total: number;
+
+    items?: Array<Shared.ShowBase>;
+
+    /**
+     * 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 Tracks {
@@ -290,8 +344,6 @@ export namespace SearchRetrieveResponse {
      */
     href: string;
 
-    items: Array<Shared.TrackObject>;
-
     /**
      * The maximum number of items in the response (as set in the query or by default).
      */
@@ -316,10 +368,21 @@ export namespace SearchRetrieveResponse {
      * The total number of items available to return.
      */
     total: number;
+
+    items?: 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 interface SearchRetrieveParams {
+export interface SearchQueryParams {
   /**
    * Your search query.
    *
@@ -379,8 +442,5 @@ export interface SearchRetrieveParams {
 }
 
 export declare namespace Search {
-  export {
-    type SearchRetrieveResponse as SearchRetrieveResponse,
-    type SearchRetrieveParams as SearchRetrieveParams,
-  };
+  export { type SearchQueryResponse as SearchQueryResponse, type SearchQueryParams as SearchQueryParams };
 }

package/src/resources/shared.ts

@@ -4,6 +4,15 @@ import * as Shared from './shared';
 import { CursorURLPage } from '../core/pagination';
 
 export interface AlbumRestrictionObject {
+  /**
+   * 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 reason for the restriction. Albums may be restricted if the content is not
    * available in a given market, to the user's subscription type, or when the user's
@@ -58,6 +67,15 @@ export interface ArtistObject {
    */
   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;
+
   /**
    * The object type.
    */
@@ -172,6 +190,15 @@ export interface AudiobookBase {
    * The edition of the audiobook.
    */
   edition?: 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 AuthorObject {
@@ -179,9 +206,27 @@ export interface AuthorObject {
    * The name of the author.
    */
   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 ChapterRestrictionObject {
+  /**
+   * 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 reason for the restriction. Supported values:
    *
@@ -199,6 +244,15 @@ export interface ChapterRestrictionObject {
 }
 
 export interface CopyrightObject {
+  /**
+   * 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 copyright text for this content.
    */
@@ -316,6 +370,15 @@ export interface EpisodeObject {
    */
   language?: 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.
    */
@@ -329,6 +392,15 @@ export interface EpisodeObject {
 }
 
 export interface EpisodeRestrictionObject {
+  /**
+   * 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 reason for the restriction. Supported values:
    *
@@ -355,6 +427,15 @@ export interface ExternalIDObject {
    */
   isrc?: 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;
+
   /**
    * [Universal Product Code](http://en.wikipedia.org/wiki/Universal_Product_Code)
    */
@@ -362,6 +443,15 @@ export interface ExternalIDObject {
 }
 
 export interface ExternalURLObject {
+  /**
+   * 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 [Spotify URL](/documentation/web-api/concepts/spotify-uris-ids) for the
    * object.
@@ -376,6 +466,15 @@ export interface FollowersObject {
    */
   href?: string | null;
 
+  /**
+   * 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 followers.
    */
@@ -397,6 +496,15 @@ export interface ImageObject {
    * The image width in pixels.
    */
   width: number | null;
+
+  /**
+   * 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 LinkedTrackObject {
@@ -416,6 +524,15 @@ export interface LinkedTrackObject {
    */
   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: "track".
    */
@@ -433,6 +550,15 @@ export interface NarratorObject {
    * The name of the Narrator.
    */
   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 PagingPlaylistObject {
@@ -441,8 +567,6 @@ export interface PagingPlaylistObject {
    */
   href: string;
 
-  items: Array<SimplifiedPlaylistObject>;
-
   /**
    * The maximum number of items in the response (as set in the query or by default).
    */
@@ -467,6 +591,17 @@ export interface PagingPlaylistObject {
    * The total number of items available to return.
    */
   total: number;
+
+  items?: Array<SimplifiedPlaylistObject>;
+
+  /**
+   * 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 PlaylistTrackObject {
@@ -488,6 +623,15 @@ export interface PlaylistTrackObject {
    */
   is_local?: 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;
+
   /**
    * Information about the track or episode.
    */
@@ -501,6 +645,15 @@ export interface PlaylistTracksRefObject {
    */
   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;
+
   /**
    * Number of tracks in the playlist.
    */
@@ -524,6 +677,15 @@ export interface PlaylistUserObject {
    */
   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.
    */
@@ -542,6 +704,15 @@ export interface ResumePointObject {
    */
   fully_played?: 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;
+
   /**
    * The user's most recent position in the episode in milliseconds.
    */
@@ -639,6 +810,15 @@ export interface ShowBase {
    * show.
    */
   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;
 }
 
 export interface SimplifiedArtistObject {
@@ -663,6 +843,15 @@ export interface SimplifiedArtistObject {
    */
   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;
+
   /**
    * The object type.
    */
@@ -775,6 +964,15 @@ export interface SimplifiedEpisodeObject {
    */
   language?: 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.
    */
@@ -835,12 +1033,13 @@ export interface SimplifiedPlaylistObject {
   owner?: SimplifiedPlaylistObject.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
@@ -956,6 +1155,15 @@ export interface SimplifiedTrackObject {
    */
   preview_url?: string | null;
 
+  /**
+   * 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.
    */
@@ -1080,6 +1288,15 @@ export interface TrackObject {
    */
   preview_url?: string | null;
 
+  /**
+   * 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.
    */
@@ -1181,6 +1398,15 @@ export namespace TrackObject {
      */
     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.
      */
@@ -1189,6 +1415,15 @@ export namespace TrackObject {
 }
 
 export interface TrackRestrictionObject {
+  /**
+   * 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 reason for the restriction. Supported values:
    *