spotted-ts 0.1.0

package/src/resources/shows.ts

@@ -0,0 +1,171 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as Shared from './shared';
+import { SimplifiedEpisodeObjectsCursorURLPage } 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';
+
+export class Shows extends APIResource {
+  /**
+   * Get Spotify catalog information for a single show identified by its unique
+   * Spotify ID.
+   */
+  retrieve(
+    id: string,
+    query: ShowRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ShowRetrieveResponse> {
+    return this._client.get(path`/shows/${id}`, { query, ...options });
+  }
+
+  /**
+   * Get Spotify catalog information for several shows based on their Spotify IDs.
+   */
+  list(query: ShowListParams, options?: RequestOptions): APIPromise<ShowListResponse> {
+    return this._client.get('/shows', { query, ...options });
+  }
+
+  /**
+   * Get Spotify catalog information about an show’s episodes. Optional parameters
+   * can be used to limit the number of episodes returned.
+   */
+  listEpisodes(
+    id: string,
+    query: ShowListEpisodesParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SimplifiedEpisodeObjectsCursorURLPage, Shared.SimplifiedEpisodeObject> {
+    return this._client.getAPIList(
+      path`/shows/${id}/episodes`,
+      CursorURLPage<Shared.SimplifiedEpisodeObject>,
+      { query, ...options },
+    );
+  }
+}
+
+export interface ShowRetrieveResponse extends Shared.ShowBase {
+  /**
+   * The episodes of the show.
+   */
+  episodes: ShowRetrieveResponse.Episodes;
+}
+
+export namespace ShowRetrieveResponse {
+  /**
+   * The episodes of the show.
+   */
+  export interface Episodes {
+    /**
+     * A link to the Web API endpoint returning the full result of the request
+     */
+    href: string;
+
+    items: Array<Shared.SimplifiedEpisodeObject>;
+
+    /**
+     * 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 ShowListResponse {
+  shows: Array<Shared.ShowBase>;
+}
+
+export interface ShowRetrieveParams {
+  /**
+   * 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 ShowListParams {
+  /**
+   * A comma-separated list of the
+   * [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids) for the shows.
+   * Maximum: 50 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 ShowListEpisodesParams {
+  /**
+   * 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 Shows {
+  export {
+    type ShowRetrieveResponse as ShowRetrieveResponse,
+    type ShowListResponse as ShowListResponse,
+    type ShowRetrieveParams as ShowRetrieveParams,
+    type ShowListParams as ShowListParams,
+    type ShowListEpisodesParams as ShowListEpisodesParams,
+  };
+}
+
+export { type SimplifiedEpisodeObjectsCursorURLPage };

package/src/resources/tracks.ts

@@ -0,0 +1,77 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Tracks extends APIResource {
+  /**
+   * Get Spotify catalog information for a single track identified by its unique
+   * Spotify ID.
+   */
+  retrieve(
+    id: string,
+    query: TrackRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Shared.TrackObject> {
+    return this._client.get(path`/tracks/${id}`, { query, ...options });
+  }
+
+  /**
+   * Get Spotify catalog information for multiple tracks based on their Spotify IDs.
+   */
+  list(query: TrackListParams, options?: RequestOptions): APIPromise<TrackListResponse> {
+    return this._client.get('/tracks', { query, ...options });
+  }
+}
+
+export interface TrackListResponse {
+  tracks: Array<Shared.TrackObject>;
+}
+
+export interface TrackRetrieveParams {
+  /**
+   * 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 TrackListParams {
+  /**
+   * A comma-separated list of the
+   * [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+   * `ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M`. Maximum: 50 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 declare namespace Tracks {
+  export {
+    type TrackListResponse as TrackListResponse,
+    type TrackRetrieveParams as TrackRetrieveParams,
+    type TrackListParams as TrackListParams,
+  };
+}

package/src/resources/users/index.ts

@@ -0,0 +1,9 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Playlists,
+  type PlaylistCreateResponse,
+  type PlaylistCreateParams,
+  type PlaylistListParams,
+} from './playlists';
+export { Users, type UserRetrieveProfileResponse } from './users';

package/src/resources/users/playlists.ts

@@ -0,0 +1,249 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import { SimplifiedPlaylistObjectsCursorURLPage } 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';
+
+export class Playlists extends APIResource {
+  /**
+   * Create a playlist for a Spotify user. (The playlist will be empty until you
+   * [add tracks](/documentation/web-api/reference/add-tracks-to-playlist).) Each
+   * user is generally limited to a maximum of 11000 playlists.
+   *
+   * @example
+   * ```ts
+   * const playlist = await client.users.playlists.create(
+   *   'smedjan',
+   *   { name: 'New Playlist' },
+   * );
+   * ```
+   */
+  create(
+    userID: string,
+    body: PlaylistCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<PlaylistCreateResponse> {
+    return this._client.post(path`/users/${userID}/playlists`, { body, ...options });
+  }
+
+  /**
+   * Get a list of the playlists owned or followed by a Spotify user.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const simplifiedPlaylistObject of client.users.playlists.list(
+   *   'smedjan',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    userID: string,
+    query: PlaylistListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SimplifiedPlaylistObjectsCursorURLPage, Shared.SimplifiedPlaylistObject> {
+    return this._client.getAPIList(
+      path`/users/${userID}/playlists`,
+      CursorURLPage<Shared.SimplifiedPlaylistObject>,
+      { query, ...options },
+    );
+  }
+}
+
+export interface PlaylistCreateResponse {
+  /**
+   * The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+   * playlist.
+   */
+  id?: string;
+
+  /**
+   * `true` if the owner allows other users to modify the playlist.
+   */
+  collaborative?: boolean;
+
+  /**
+   * The playlist description. _Only returned for modified, verified playlists,
+   * otherwise_ `null`.
+   */
+  description?: string | null;
+
+  /**
+   * Known external URLs for this playlist.
+   */
+  external_urls?: Shared.ExternalURLObject;
+
+  /**
+   * Information about the followers of the playlist.
+   */
+  followers?: Shared.FollowersObject;
+
+  /**
+   * A link to the Web API endpoint providing full details of the playlist.
+   */
+  href?: string;
+
+  /**
+   * Images for the playlist. The array may be empty or contain up to three images.
+   * The images are returned by size in descending order. See
+   * [Working with Playlists](/documentation/web-api/concepts/playlists). _**Note**:
+   * If returned, the source URL for the image (`url`) is temporary and will expire
+   * in less than a day._
+   */
+  images?: Array<Shared.ImageObject>;
+
+  /**
+   * The name of the playlist.
+   */
+  name?: string;
+
+  /**
+   * The user who owns the playlist
+   */
+  owner?: PlaylistCreateResponse.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
+   * [Working with Playlists](/documentation/web-api/concepts/playlists)
+   */
+  public?: boolean;
+
+  /**
+   * The version identifier for the current playlist. Can be supplied in other
+   * requests to target a specific playlist version
+   */
+  snapshot_id?: string;
+
+  /**
+   * The tracks of the playlist.
+   */
+  tracks?: PlaylistCreateResponse.Tracks;
+
+  /**
+   * The object type: "playlist"
+   */
+  type?: string;
+
+  /**
+   * The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+   * playlist.
+   */
+  uri?: string;
+}
+
+export namespace PlaylistCreateResponse {
+  /**
+   * The user who owns the playlist
+   */
+  export interface Owner extends Shared.PlaylistUserObject {
+    /**
+     * The name displayed on the user's profile. `null` if not available.
+     */
+    display_name?: string | null;
+  }
+
+  /**
+   * The tracks of the playlist.
+   */
+  export interface Tracks {
+    /**
+     * A link to the Web API endpoint returning the full result of the request
+     */
+    href: string;
+
+    items: Array<Shared.PlaylistTrackObject>;
+
+    /**
+     * 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 PlaylistCreateParams {
+  /**
+   * The name for the new playlist, for example `"Your Coolest Playlist"`. This name
+   * does not need to be unique; a user may have several playlists with the same
+   * name.
+   */
+  name: string;
+
+  /**
+   * Defaults to `false`. If `true` the playlist will be collaborative. _**Note**: to
+   * create a collaborative playlist you must also set `public` to `false`. To create
+   * collaborative playlists you must have granted `playlist-modify-private` and
+   * `playlist-modify-public`
+   * [scopes](/documentation/web-api/concepts/scopes/#list-of-scopes)._
+   */
+  collaborative?: boolean;
+
+  /**
+   * value for playlist description as displayed in Spotify Clients and in the Web
+   * API.
+   */
+  description?: string;
+
+  /**
+   * Defaults to `true`. 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. To be able to create private playlists, the user must
+   * have granted the `playlist-modify-private`
+   * [scope](/documentation/web-api/concepts/scopes/#list-of-scopes). For more about
+   * public/private status, see
+   * [Working with Playlists](/documentation/web-api/concepts/playlists)
+   */
+  public?: boolean;
+
+  [k: string]: unknown;
+}
+
+export interface PlaylistListParams {
+  /**
+   * The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+   */
+  limit?: number;
+
+  /**
+   * The index of the first playlist to return. Default: 0 (the first object).
+   * Maximum offset: 100.000\. Use with `limit` to get the next set of playlists.
+   */
+  offset?: number;
+}
+
+export declare namespace Playlists {
+  export {
+    type PlaylistCreateResponse as PlaylistCreateResponse,
+    type PlaylistCreateParams as PlaylistCreateParams,
+    type PlaylistListParams as PlaylistListParams,
+  };
+}
+
+export { type SimplifiedPlaylistObjectsCursorURLPage };

package/src/resources/users/users.ts

@@ -0,0 +1,84 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import * as PlaylistsAPI from './playlists';
+import { PlaylistCreateParams, PlaylistCreateResponse, PlaylistListParams, Playlists } from './playlists';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Users extends APIResource {
+  playlists: PlaylistsAPI.Playlists = new PlaylistsAPI.Playlists(this._client);
+
+  /**
+   * Get public profile information about a Spotify user.
+   *
+   * @example
+   * ```ts
+   * const response = await client.users.retrieveProfile(
+   *   'smedjan',
+   * );
+   * ```
+   */
+  retrieveProfile(userID: string, options?: RequestOptions): APIPromise<UserRetrieveProfileResponse> {
+    return this._client.get(path`/users/${userID}`, options);
+  }
+}
+
+export interface UserRetrieveProfileResponse {
+  /**
+   * The [Spotify user ID](/documentation/web-api/concepts/spotify-uris-ids) for this
+   * user.
+   */
+  id?: string;
+
+  /**
+   * The name displayed on the user's profile. `null` if not available.
+   */
+  display_name?: string | null;
+
+  /**
+   * Known public external URLs for this user.
+   */
+  external_urls?: Shared.ExternalURLObject;
+
+  /**
+   * Information about the followers of this user.
+   */
+  followers?: Shared.FollowersObject;
+
+  /**
+   * A link to the Web API endpoint for this user.
+   */
+  href?: string;
+
+  /**
+   * The user's profile image.
+   */
+  images?: Array<Shared.ImageObject>;
+
+  /**
+   * The object type.
+   */
+  type?: 'user';
+
+  /**
+   * The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for this
+   * user.
+   */
+  uri?: string;
+}
+
+Users.Playlists = Playlists;
+
+export declare namespace Users {
+  export { type UserRetrieveProfileResponse as UserRetrieveProfileResponse };
+
+  export {
+    Playlists as Playlists,
+    type PlaylistCreateResponse as PlaylistCreateResponse,
+    type PlaylistCreateParams as PlaylistCreateParams,
+    type PlaylistListParams as PlaylistListParams,
+  };
+}

package/src/resources/users.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './users/index';

package/src/resources.ts

@@ -0,0 +1 @@
+export * from './resources/index';

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
+    "moduleResolution": "node"
+  }
+}

package/src/uploads.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/uploads instead */
+export * from './core/uploads';

package/src/version.ts

@@ -0,0 +1 @@
+export const VERSION = '0.1.0'; // x-release-please-version

package/uploads.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.d.mts.map

package/uploads.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.d.ts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.js";
+//# sourceMappingURL=uploads.d.ts.map

package/uploads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/uploads instead */
+tslib_1.__exportStar(require("./core/uploads.js"), exports);
+//# sourceMappingURL=uploads.js.map

package/uploads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.js","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":";;;AAAA,qDAAqD;AACrD,4DAA+B"}

package/uploads.mjs

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.mjs.map

package/uploads.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/version.d.mts

@@ -0,0 +1,2 @@
+export declare const VERSION = "0.1.0";
+//# sourceMappingURL=version.d.mts.map

package/version.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION = "0.1.0";
+//# sourceMappingURL=version.d.ts.map

package/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERSION = void 0;
+exports.VERSION = '0.1.0'; // x-release-please-version
+//# sourceMappingURL=version.js.map

package/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}

package/version.mjs

@@ -0,0 +1,2 @@
+export const VERSION = '0.1.0'; // x-release-please-version
+//# sourceMappingURL=version.mjs.map