spotted-ts 0.1.0

package/src/resources/me/following.ts

@@ -0,0 +1,199 @@
+// 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 { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+
+export class Following extends APIResource {
+  /**
+   * Get the current user's followed artists.
+   *
+   * @example
+   * ```ts
+   * const followings = await client.me.following.list({
+   *   type: 'artist',
+   * });
+   * ```
+   */
+  list(query: FollowingListParams, options?: RequestOptions): APIPromise<FollowingListResponse> {
+    return this._client.get('/me/following', { query, ...options });
+  }
+
+  /**
+   * Check to see if the current user is following one or more artists or other
+   * Spotify users.
+   *
+   * @example
+   * ```ts
+   * const response = await client.me.following.check({
+   *   ids: '2CIMQHirSU0MQqyYHq0eOx,57dN52uHvrHOxijzpIgu3E,1vCWHaC5f2uS3yhpwWbIA6',
+   *   type: 'artist',
+   * });
+   * ```
+   */
+  check(query: FollowingCheckParams, options?: RequestOptions): APIPromise<FollowingCheckResponse> {
+    return this._client.get('/me/following/contains', { query, ...options });
+  }
+
+  /**
+   * Add the current user as a follower of one or more artists or other Spotify
+   * users.
+   *
+   * @example
+   * ```ts
+   * await client.me.following.follow({ ids: ['string'] });
+   * ```
+   */
+  follow(body: FollowingFollowParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.put('/me/following', {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Remove the current user as a follower of one or more artists or other Spotify
+   * users.
+   *
+   * @example
+   * ```ts
+   * await client.me.following.unfollow();
+   * ```
+   */
+  unfollow(
+    body: FollowingUnfollowParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    return this._client.delete('/me/following', {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface FollowingListResponse {
+  artists: FollowingListResponse.Artists;
+}
+
+export namespace FollowingListResponse {
+  export interface Artists {
+    /**
+     * The cursors used to find the next set of items.
+     */
+    cursors?: Artists.Cursors;
+
+    /**
+     * A link to the Web API endpoint returning the full result of the request.
+     */
+    href?: string;
+
+    items?: Array<Shared.ArtistObject>;
+
+    /**
+     * 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;
+
+    /**
+     * The total number of items available to return.
+     */
+    total?: number;
+  }
+
+  export namespace Artists {
+    /**
+     * The cursors used to find the next set of items.
+     */
+    export interface Cursors {
+      /**
+       * The cursor to use as key to find the next page of items.
+       */
+      after?: string;
+
+      /**
+       * The cursor to use as key to find the previous page of items.
+       */
+      before?: string;
+    }
+  }
+}
+
+export type FollowingCheckResponse = Array<boolean>;
+
+export interface FollowingListParams {
+  /**
+   * The ID type: currently only `artist` is supported.
+   */
+  type: 'artist';
+
+  /**
+   * The last artist ID retrieved from the previous request.
+   */
+  after?: string;
+
+  /**
+   * The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+   */
+  limit?: number;
+}
+
+export interface FollowingCheckParams {
+  /**
+   * A comma-separated list of the artist or the user
+   * [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids) to check. For
+   * example: `ids=74ASZWbe4lXaubB36ztrGX,08td7MxkoHQkXnWAYD8d6Q`. A maximum of 50
+   * IDs can be sent in one request.
+   */
+  ids: string;
+
+  /**
+   * The ID type: either `artist` or `user`.
+   */
+  type: 'artist' | 'user';
+}
+
+export interface FollowingFollowParams {
+  /**
+   * A JSON array of the artist or user
+   * [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+   * `{ids:["74ASZWbe4lXaubB36ztrGX", "08td7MxkoHQkXnWAYD8d6Q"]}`. A maximum of 50
+   * IDs can be sent in one request. _**Note**: if the `ids` parameter is present in
+   * the query string, any IDs listed here in the body will be ignored._
+   */
+  ids: Array<string>;
+
+  [k: string]: unknown;
+}
+
+export interface FollowingUnfollowParams {
+  /**
+   * A JSON array of the artist or user
+   * [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+   * `{ids:["74ASZWbe4lXaubB36ztrGX", "08td7MxkoHQkXnWAYD8d6Q"]}`. A maximum of 50
+   * IDs can be sent in one request. _**Note**: if the `ids` parameter is present in
+   * the query string, any IDs listed here in the body will be ignored._
+   */
+  ids?: Array<string>;
+
+  [k: string]: unknown;
+}
+
+export declare namespace Following {
+  export {
+    type FollowingListResponse as FollowingListResponse,
+    type FollowingCheckResponse as FollowingCheckResponse,
+    type FollowingListParams as FollowingListParams,
+    type FollowingCheckParams as FollowingCheckParams,
+    type FollowingFollowParams as FollowingFollowParams,
+    type FollowingUnfollowParams as FollowingUnfollowParams,
+  };
+}

package/src/resources/me/index.ts

@@ -0,0 +1,86 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Albums,
+  type AlbumListResponse,
+  type AlbumCheckResponse,
+  type AlbumListParams,
+  type AlbumCheckParams,
+  type AlbumRemoveParams,
+  type AlbumSaveParams,
+  type AlbumListResponsesCursorURLPage,
+} from './albums';
+export {
+  Audiobooks,
+  type AudiobookListResponse,
+  type AudiobookCheckResponse,
+  type AudiobookListParams,
+  type AudiobookCheckParams,
+  type AudiobookRemoveParams,
+  type AudiobookSaveParams,
+  type AudiobookListResponsesCursorURLPage,
+} from './audiobooks';
+export {
+  Episodes,
+  type EpisodeListResponse,
+  type EpisodeCheckResponse,
+  type EpisodeListParams,
+  type EpisodeCheckParams,
+  type EpisodeRemoveParams,
+  type EpisodeSaveParams,
+  type EpisodeListResponsesCursorURLPage,
+} from './episodes';
+export {
+  Following,
+  type FollowingListResponse,
+  type FollowingCheckResponse,
+  type FollowingListParams,
+  type FollowingCheckParams,
+  type FollowingFollowParams,
+  type FollowingUnfollowParams,
+} from './following';
+export { Me, type MeRetrieveResponse } from './me';
+export {
+  Player,
+  type ContextObject,
+  type DeviceObject,
+  type PlayerGetCurrentlyPlayingResponse,
+  type PlayerGetDevicesResponse,
+  type PlayerGetStateResponse,
+  type PlayerListRecentlyPlayedResponse,
+  type PlayerGetCurrentlyPlayingParams,
+  type PlayerGetStateParams,
+  type PlayerListRecentlyPlayedParams,
+  type PlayerPausePlaybackParams,
+  type PlayerSeekToPositionParams,
+  type PlayerSetRepeatModeParams,
+  type PlayerSetVolumeParams,
+  type PlayerSkipNextParams,
+  type PlayerSkipPreviousParams,
+  type PlayerStartPlaybackParams,
+  type PlayerToggleShuffleParams,
+  type PlayerTransferParams,
+  type PlayerListRecentlyPlayedResponsesCursorURLPage,
+} from './player/index';
+export { Playlists, type PlaylistListParams } from './playlists';
+export {
+  Shows,
+  type ShowListResponse,
+  type ShowCheckResponse,
+  type ShowListParams,
+  type ShowCheckParams,
+  type ShowRemoveParams,
+  type ShowSaveParams,
+  type ShowListResponsesCursorURLPage,
+} from './shows';
+export { Top, type TopListTopArtistsParams, type TopListTopTracksParams } from './top';
+export {
+  Tracks,
+  type TrackListResponse,
+  type TrackCheckResponse,
+  type TrackListParams,
+  type TrackCheckParams,
+  type TrackRemoveParams,
+  type TrackSaveParams,
+  type TrackListResponsesCursorURLPage,
+} from './tracks';

package/src/resources/me/me.ts

@@ -0,0 +1,334 @@
+// 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 AlbumsAPI from './albums';
+import {
+  AlbumCheckParams,
+  AlbumCheckResponse,
+  AlbumListParams,
+  AlbumListResponse,
+  AlbumListResponsesCursorURLPage,
+  AlbumRemoveParams,
+  AlbumSaveParams,
+  Albums,
+} from './albums';
+import * as AudiobooksAPI from './audiobooks';
+import {
+  AudiobookCheckParams,
+  AudiobookCheckResponse,
+  AudiobookListParams,
+  AudiobookListResponse,
+  AudiobookListResponsesCursorURLPage,
+  AudiobookRemoveParams,
+  AudiobookSaveParams,
+  Audiobooks,
+} from './audiobooks';
+import * as EpisodesAPI from './episodes';
+import {
+  EpisodeCheckParams,
+  EpisodeCheckResponse,
+  EpisodeListParams,
+  EpisodeListResponse,
+  EpisodeListResponsesCursorURLPage,
+  EpisodeRemoveParams,
+  EpisodeSaveParams,
+  Episodes,
+} from './episodes';
+import * as FollowingAPI from './following';
+import {
+  Following,
+  FollowingCheckParams,
+  FollowingCheckResponse,
+  FollowingFollowParams,
+  FollowingListParams,
+  FollowingListResponse,
+  FollowingUnfollowParams,
+} from './following';
+import * as PlaylistsAPI from './playlists';
+import { PlaylistListParams, Playlists } from './playlists';
+import * as ShowsAPI from './shows';
+import {
+  ShowCheckParams,
+  ShowCheckResponse,
+  ShowListParams,
+  ShowListResponse,
+  ShowListResponsesCursorURLPage,
+  ShowRemoveParams,
+  ShowSaveParams,
+  Shows,
+} from './shows';
+import * as TopAPI from './top';
+import { Top, TopListTopArtistsParams, TopListTopTracksParams } from './top';
+import * as TracksAPI from './tracks';
+import {
+  TrackCheckParams,
+  TrackCheckResponse,
+  TrackListParams,
+  TrackListResponse,
+  TrackListResponsesCursorURLPage,
+  TrackRemoveParams,
+  TrackSaveParams,
+  Tracks,
+} from './tracks';
+import * as PlayerAPI from './player/player';
+import {
+  ContextObject,
+  DeviceObject,
+  Player,
+  PlayerGetCurrentlyPlayingParams,
+  PlayerGetCurrentlyPlayingResponse,
+  PlayerGetDevicesResponse,
+  PlayerGetStateParams,
+  PlayerGetStateResponse,
+  PlayerListRecentlyPlayedParams,
+  PlayerListRecentlyPlayedResponse,
+  PlayerListRecentlyPlayedResponsesCursorURLPage,
+  PlayerPausePlaybackParams,
+  PlayerSeekToPositionParams,
+  PlayerSetRepeatModeParams,
+  PlayerSetVolumeParams,
+  PlayerSkipNextParams,
+  PlayerSkipPreviousParams,
+  PlayerStartPlaybackParams,
+  PlayerToggleShuffleParams,
+  PlayerTransferParams,
+} from './player/player';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+export class Me extends APIResource {
+  audiobooks: AudiobooksAPI.Audiobooks = new AudiobooksAPI.Audiobooks(this._client);
+  playlists: PlaylistsAPI.Playlists = new PlaylistsAPI.Playlists(this._client);
+  top: TopAPI.Top = new TopAPI.Top(this._client);
+  albums: AlbumsAPI.Albums = new AlbumsAPI.Albums(this._client);
+  tracks: TracksAPI.Tracks = new TracksAPI.Tracks(this._client);
+  episodes: EpisodesAPI.Episodes = new EpisodesAPI.Episodes(this._client);
+  shows: ShowsAPI.Shows = new ShowsAPI.Shows(this._client);
+  following: FollowingAPI.Following = new FollowingAPI.Following(this._client);
+  player: PlayerAPI.Player = new PlayerAPI.Player(this._client);
+
+  /**
+   * Get detailed profile information about the current user (including the current
+   * user's username).
+   *
+   * @example
+   * ```ts
+   * const me = await client.me.retrieve();
+   * ```
+   */
+  retrieve(options?: RequestOptions): APIPromise<MeRetrieveResponse> {
+    return this._client.get('/me', options);
+  }
+}
+
+export interface MeRetrieveResponse {
+  /**
+   * The [Spotify user ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+   * user.
+   */
+  id?: string;
+
+  /**
+   * The country of the user, as set in the user's account profile. An
+   * [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
+   * _This field is only available when the current user has granted access to the
+   * [user-read-private](/documentation/web-api/concepts/scopes/#list-of-scopes)
+   * scope._
+   */
+  country?: string;
+
+  /**
+   * The name displayed on the user's profile. `null` if not available.
+   */
+  display_name?: string;
+
+  /**
+   * The user's email address, as entered by the user when creating their account.
+   * _**Important!** This email address is unverified; there is no proof that it
+   * actually belongs to the user._ _This field is only available when the current
+   * user has granted access to the
+   * [user-read-email](/documentation/web-api/concepts/scopes/#list-of-scopes)
+   * scope._
+   */
+  email?: string;
+
+  /**
+   * The user's explicit content settings. _This field is only available when the
+   * current user has granted access to the
+   * [user-read-private](/documentation/web-api/concepts/scopes/#list-of-scopes)
+   * scope._
+   */
+  explicit_content?: MeRetrieveResponse.ExplicitContent;
+
+  /**
+   * Known external URLs for this user.
+   */
+  external_urls?: Shared.ExternalURLObject;
+
+  /**
+   * Information about the followers of the 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 user's Spotify subscription level: "premium", "free", etc. (The subscription
+   * level "open" can be considered the same as "free".) _This field is only
+   * available when the current user has granted access to the
+   * [user-read-private](/documentation/web-api/concepts/scopes/#list-of-scopes)
+   * scope._
+   */
+  product?: string;
+
+  /**
+   * The object type: "user"
+   */
+  type?: string;
+
+  /**
+   * The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+   * user.
+   */
+  uri?: string;
+}
+
+export namespace MeRetrieveResponse {
+  /**
+   * The user's explicit content settings. _This field is only available when the
+   * current user has granted access to the
+   * [user-read-private](/documentation/web-api/concepts/scopes/#list-of-scopes)
+   * scope._
+   */
+  export interface ExplicitContent {
+    /**
+     * When `true`, indicates that explicit content should not be played.
+     */
+    filter_enabled?: boolean;
+
+    /**
+     * When `true`, indicates that the explicit content setting is locked and can't be
+     * changed by the user.
+     */
+    filter_locked?: boolean;
+  }
+}
+
+Me.Audiobooks = Audiobooks;
+Me.Playlists = Playlists;
+Me.Top = Top;
+Me.Albums = Albums;
+Me.Tracks = Tracks;
+Me.Episodes = Episodes;
+Me.Shows = Shows;
+Me.Following = Following;
+Me.Player = Player;
+
+export declare namespace Me {
+  export { type MeRetrieveResponse as MeRetrieveResponse };
+
+  export {
+    Audiobooks as Audiobooks,
+    type AudiobookListResponse as AudiobookListResponse,
+    type AudiobookCheckResponse as AudiobookCheckResponse,
+    type AudiobookListResponsesCursorURLPage as AudiobookListResponsesCursorURLPage,
+    type AudiobookListParams as AudiobookListParams,
+    type AudiobookCheckParams as AudiobookCheckParams,
+    type AudiobookRemoveParams as AudiobookRemoveParams,
+    type AudiobookSaveParams as AudiobookSaveParams,
+  };
+
+  export { Playlists as Playlists, type PlaylistListParams as PlaylistListParams };
+
+  export {
+    Top as Top,
+    type TopListTopArtistsParams as TopListTopArtistsParams,
+    type TopListTopTracksParams as TopListTopTracksParams,
+  };
+
+  export {
+    Albums as Albums,
+    type AlbumListResponse as AlbumListResponse,
+    type AlbumCheckResponse as AlbumCheckResponse,
+    type AlbumListResponsesCursorURLPage as AlbumListResponsesCursorURLPage,
+    type AlbumListParams as AlbumListParams,
+    type AlbumCheckParams as AlbumCheckParams,
+    type AlbumRemoveParams as AlbumRemoveParams,
+    type AlbumSaveParams as AlbumSaveParams,
+  };
+
+  export {
+    Tracks as Tracks,
+    type TrackListResponse as TrackListResponse,
+    type TrackCheckResponse as TrackCheckResponse,
+    type TrackListResponsesCursorURLPage as TrackListResponsesCursorURLPage,
+    type TrackListParams as TrackListParams,
+    type TrackCheckParams as TrackCheckParams,
+    type TrackRemoveParams as TrackRemoveParams,
+    type TrackSaveParams as TrackSaveParams,
+  };
+
+  export {
+    Episodes as Episodes,
+    type EpisodeListResponse as EpisodeListResponse,
+    type EpisodeCheckResponse as EpisodeCheckResponse,
+    type EpisodeListResponsesCursorURLPage as EpisodeListResponsesCursorURLPage,
+    type EpisodeListParams as EpisodeListParams,
+    type EpisodeCheckParams as EpisodeCheckParams,
+    type EpisodeRemoveParams as EpisodeRemoveParams,
+    type EpisodeSaveParams as EpisodeSaveParams,
+  };
+
+  export {
+    Shows as Shows,
+    type ShowListResponse as ShowListResponse,
+    type ShowCheckResponse as ShowCheckResponse,
+    type ShowListResponsesCursorURLPage as ShowListResponsesCursorURLPage,
+    type ShowListParams as ShowListParams,
+    type ShowCheckParams as ShowCheckParams,
+    type ShowRemoveParams as ShowRemoveParams,
+    type ShowSaveParams as ShowSaveParams,
+  };
+
+  export {
+    Following as Following,
+    type FollowingListResponse as FollowingListResponse,
+    type FollowingCheckResponse as FollowingCheckResponse,
+    type FollowingListParams as FollowingListParams,
+    type FollowingCheckParams as FollowingCheckParams,
+    type FollowingFollowParams as FollowingFollowParams,
+    type FollowingUnfollowParams as FollowingUnfollowParams,
+  };
+
+  export {
+    Player as Player,
+    type ContextObject as ContextObject,
+    type DeviceObject as DeviceObject,
+    type PlayerGetCurrentlyPlayingResponse as PlayerGetCurrentlyPlayingResponse,
+    type PlayerGetDevicesResponse as PlayerGetDevicesResponse,
+    type PlayerGetStateResponse as PlayerGetStateResponse,
+    type PlayerListRecentlyPlayedResponse as PlayerListRecentlyPlayedResponse,
+    type PlayerListRecentlyPlayedResponsesCursorURLPage as PlayerListRecentlyPlayedResponsesCursorURLPage,
+    type PlayerGetCurrentlyPlayingParams as PlayerGetCurrentlyPlayingParams,
+    type PlayerGetStateParams as PlayerGetStateParams,
+    type PlayerListRecentlyPlayedParams as PlayerListRecentlyPlayedParams,
+    type PlayerPausePlaybackParams as PlayerPausePlaybackParams,
+    type PlayerSeekToPositionParams as PlayerSeekToPositionParams,
+    type PlayerSetRepeatModeParams as PlayerSetRepeatModeParams,
+    type PlayerSetVolumeParams as PlayerSetVolumeParams,
+    type PlayerSkipNextParams as PlayerSkipNextParams,
+    type PlayerSkipPreviousParams as PlayerSkipPreviousParams,
+    type PlayerStartPlaybackParams as PlayerStartPlaybackParams,
+    type PlayerToggleShuffleParams as PlayerToggleShuffleParams,
+    type PlayerTransferParams as PlayerTransferParams,
+  };
+}

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

@@ -0,0 +1,25 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Player,
+  type ContextObject,
+  type DeviceObject,
+  type PlayerGetCurrentlyPlayingResponse,
+  type PlayerGetDevicesResponse,
+  type PlayerGetStateResponse,
+  type PlayerListRecentlyPlayedResponse,
+  type PlayerGetCurrentlyPlayingParams,
+  type PlayerGetStateParams,
+  type PlayerListRecentlyPlayedParams,
+  type PlayerPausePlaybackParams,
+  type PlayerSeekToPositionParams,
+  type PlayerSetRepeatModeParams,
+  type PlayerSetVolumeParams,
+  type PlayerSkipNextParams,
+  type PlayerSkipPreviousParams,
+  type PlayerStartPlaybackParams,
+  type PlayerToggleShuffleParams,
+  type PlayerTransferParams,
+  type PlayerListRecentlyPlayedResponsesCursorURLPage,
+} from './player';
+export { Queue, type QueueGetResponse, type QueueAddParams } from './queue';