spotted-ts 0.1.0

package/src/resources/audio-features.ts

@@ -0,0 +1,304 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class AudioFeatures extends APIResource {
+  /**
+   * Get audio feature information for a single track identified by its unique
+   * Spotify ID.
+   *
+   * @deprecated
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<AudioFeatureRetrieveResponse> {
+    return this._client.get(path`/audio-features/${id}`, options);
+  }
+
+  /**
+   * Get audio features for multiple tracks based on their Spotify IDs.
+   *
+   * @deprecated
+   */
+  list(query: AudioFeatureListParams, options?: RequestOptions): APIPromise<AudioFeatureListResponse> {
+    return this._client.get('/audio-features', { query, ...options });
+  }
+}
+
+export interface AudioFeatureRetrieveResponse {
+  /**
+   * The Spotify ID for the track.
+   */
+  id?: string;
+
+  /**
+   * A confidence measure from 0.0 to 1.0 of whether the track is acoustic. 1.0
+   * represents high confidence the track is acoustic.
+   */
+  acousticness?: number;
+
+  /**
+   * A URL to access the full audio analysis of this track. An access token is
+   * required to access this data.
+   */
+  analysis_url?: string;
+
+  /**
+   * Danceability describes how suitable a track is for dancing based on a
+   * combination of musical elements including tempo, rhythm stability, beat
+   * strength, and overall regularity. A value of 0.0 is least danceable and 1.0 is
+   * most danceable.
+   */
+  danceability?: number;
+
+  /**
+   * The duration of the track in milliseconds.
+   */
+  duration_ms?: number;
+
+  /**
+   * Energy is a measure from 0.0 to 1.0 and represents a perceptual measure of
+   * intensity and activity. Typically, energetic tracks feel fast, loud, and noisy.
+   * For example, death metal has high energy, while a Bach prelude scores low on the
+   * scale. Perceptual features contributing to this attribute include dynamic range,
+   * perceived loudness, timbre, onset rate, and general entropy.
+   */
+  energy?: number;
+
+  /**
+   * Predicts whether a track contains no vocals. "Ooh" and "aah" sounds are treated
+   * as instrumental in this context. Rap or spoken word tracks are clearly "vocal".
+   * The closer the instrumentalness value is to 1.0, the greater likelihood the
+   * track contains no vocal content. Values above 0.5 are intended to represent
+   * instrumental tracks, but confidence is higher as the value approaches 1.0.
+   */
+  instrumentalness?: number;
+
+  /**
+   * The key the track is in. Integers map to pitches using standard
+   * [Pitch Class notation](https://en.wikipedia.org/wiki/Pitch_class). E.g. 0 = C, 1
+   * = C♯/D♭, 2 = D, and so on. If no key was detected, the value is -1.
+   */
+  key?: number;
+
+  /**
+   * Detects the presence of an audience in the recording. Higher liveness values
+   * represent an increased probability that the track was performed live. A value
+   * above 0.8 provides strong likelihood that the track is live.
+   */
+  liveness?: number;
+
+  /**
+   * The overall loudness of a track in decibels (dB). Loudness values are averaged
+   * across the entire track and are useful for comparing relative loudness of
+   * tracks. Loudness is the quality of a sound that is the primary psychological
+   * correlate of physical strength (amplitude). Values typically range between -60
+   * and 0 db.
+   */
+  loudness?: number;
+
+  /**
+   * Mode indicates the modality (major or minor) of a track, the type of scale from
+   * which its melodic content is derived. Major is represented by 1 and minor is 0.
+   */
+  mode?: number;
+
+  /**
+   * Speechiness detects the presence of spoken words in a track. The more
+   * exclusively speech-like the recording (e.g. talk show, audio book, poetry), the
+   * closer to 1.0 the attribute value. Values above 0.66 describe tracks that are
+   * probably made entirely of spoken words. Values between 0.33 and 0.66 describe
+   * tracks that may contain both music and speech, either in sections or layered,
+   * including such cases as rap music. Values below 0.33 most likely represent music
+   * and other non-speech-like tracks.
+   */
+  speechiness?: number;
+
+  /**
+   * The overall estimated tempo of a track in beats per minute (BPM). In musical
+   * terminology, tempo is the speed or pace of a given piece and derives directly
+   * from the average beat duration.
+   */
+  tempo?: number;
+
+  /**
+   * An estimated time signature. The time signature (meter) is a notational
+   * convention to specify how many beats are in each bar (or measure). The time
+   * signature ranges from 3 to 7 indicating time signatures of "3/4", to "7/4".
+   */
+  time_signature?: number;
+
+  /**
+   * A link to the Web API endpoint providing full details of the track.
+   */
+  track_href?: string;
+
+  /**
+   * The object type.
+   */
+  type?: 'audio_features';
+
+  /**
+   * The Spotify URI for the track.
+   */
+  uri?: string;
+
+  /**
+   * A measure from 0.0 to 1.0 describing the musical positiveness conveyed by a
+   * track. Tracks with high valence sound more positive (e.g. happy, cheerful,
+   * euphoric), while tracks with low valence sound more negative (e.g. sad,
+   * depressed, angry).
+   */
+  valence?: number;
+}
+
+export interface AudioFeatureListResponse {
+  audio_features: Array<AudioFeatureListResponse.AudioFeature>;
+}
+
+export namespace AudioFeatureListResponse {
+  export interface AudioFeature {
+    /**
+     * The Spotify ID for the track.
+     */
+    id?: string;
+
+    /**
+     * A confidence measure from 0.0 to 1.0 of whether the track is acoustic. 1.0
+     * represents high confidence the track is acoustic.
+     */
+    acousticness?: number;
+
+    /**
+     * A URL to access the full audio analysis of this track. An access token is
+     * required to access this data.
+     */
+    analysis_url?: string;
+
+    /**
+     * Danceability describes how suitable a track is for dancing based on a
+     * combination of musical elements including tempo, rhythm stability, beat
+     * strength, and overall regularity. A value of 0.0 is least danceable and 1.0 is
+     * most danceable.
+     */
+    danceability?: number;
+
+    /**
+     * The duration of the track in milliseconds.
+     */
+    duration_ms?: number;
+
+    /**
+     * Energy is a measure from 0.0 to 1.0 and represents a perceptual measure of
+     * intensity and activity. Typically, energetic tracks feel fast, loud, and noisy.
+     * For example, death metal has high energy, while a Bach prelude scores low on the
+     * scale. Perceptual features contributing to this attribute include dynamic range,
+     * perceived loudness, timbre, onset rate, and general entropy.
+     */
+    energy?: number;
+
+    /**
+     * Predicts whether a track contains no vocals. "Ooh" and "aah" sounds are treated
+     * as instrumental in this context. Rap or spoken word tracks are clearly "vocal".
+     * The closer the instrumentalness value is to 1.0, the greater likelihood the
+     * track contains no vocal content. Values above 0.5 are intended to represent
+     * instrumental tracks, but confidence is higher as the value approaches 1.0.
+     */
+    instrumentalness?: number;
+
+    /**
+     * The key the track is in. Integers map to pitches using standard
+     * [Pitch Class notation](https://en.wikipedia.org/wiki/Pitch_class). E.g. 0 = C, 1
+     * = C♯/D♭, 2 = D, and so on. If no key was detected, the value is -1.
+     */
+    key?: number;
+
+    /**
+     * Detects the presence of an audience in the recording. Higher liveness values
+     * represent an increased probability that the track was performed live. A value
+     * above 0.8 provides strong likelihood that the track is live.
+     */
+    liveness?: number;
+
+    /**
+     * The overall loudness of a track in decibels (dB). Loudness values are averaged
+     * across the entire track and are useful for comparing relative loudness of
+     * tracks. Loudness is the quality of a sound that is the primary psychological
+     * correlate of physical strength (amplitude). Values typically range between -60
+     * and 0 db.
+     */
+    loudness?: number;
+
+    /**
+     * Mode indicates the modality (major or minor) of a track, the type of scale from
+     * which its melodic content is derived. Major is represented by 1 and minor is 0.
+     */
+    mode?: number;
+
+    /**
+     * Speechiness detects the presence of spoken words in a track. The more
+     * exclusively speech-like the recording (e.g. talk show, audio book, poetry), the
+     * closer to 1.0 the attribute value. Values above 0.66 describe tracks that are
+     * probably made entirely of spoken words. Values between 0.33 and 0.66 describe
+     * tracks that may contain both music and speech, either in sections or layered,
+     * including such cases as rap music. Values below 0.33 most likely represent music
+     * and other non-speech-like tracks.
+     */
+    speechiness?: number;
+
+    /**
+     * The overall estimated tempo of a track in beats per minute (BPM). In musical
+     * terminology, tempo is the speed or pace of a given piece and derives directly
+     * from the average beat duration.
+     */
+    tempo?: number;
+
+    /**
+     * An estimated time signature. The time signature (meter) is a notational
+     * convention to specify how many beats are in each bar (or measure). The time
+     * signature ranges from 3 to 7 indicating time signatures of "3/4", to "7/4".
+     */
+    time_signature?: number;
+
+    /**
+     * A link to the Web API endpoint providing full details of the track.
+     */
+    track_href?: string;
+
+    /**
+     * The object type.
+     */
+    type?: 'audio_features';
+
+    /**
+     * The Spotify URI for the track.
+     */
+    uri?: string;
+
+    /**
+     * A measure from 0.0 to 1.0 describing the musical positiveness conveyed by a
+     * track. Tracks with high valence sound more positive (e.g. happy, cheerful,
+     * euphoric), while tracks with low valence sound more negative (e.g. sad,
+     * depressed, angry).
+     */
+    valence?: number;
+  }
+}
+
+export interface AudioFeatureListParams {
+  /**
+   * A comma-separated list of the
+   * [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids) for the tracks.
+   * Maximum: 100 IDs.
+   */
+  ids: string;
+}
+
+export declare namespace AudioFeatures {
+  export {
+    type AudioFeatureRetrieveResponse as AudioFeatureRetrieveResponse,
+    type AudioFeatureListResponse as AudioFeatureListResponse,
+    type AudioFeatureListParams as AudioFeatureListParams,
+  };
+}

package/src/resources/audiobooks.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 AudiobooksAPI from './audiobooks';
+import * as Shared 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 Audiobooks extends APIResource {
+  /**
+   * Get Spotify catalog information for a single audiobook. Audiobooks are only
+   * available within the US, UK, Canada, Ireland, New Zealand and Australia markets.
+   */
+  retrieve(
+    id: string,
+    query: AudiobookRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AudiobookRetrieveResponse> {
+    return this._client.get(path`/audiobooks/${id}`, { query, ...options });
+  }
+
+  /**
+   * Get Spotify catalog information for several audiobooks identified by their
+   * Spotify IDs. Audiobooks are only available within the US, UK, Canada, Ireland,
+   * New Zealand and Australia markets.
+   */
+  list(query: AudiobookListParams, options?: RequestOptions): APIPromise<AudiobookListResponse> {
+    return this._client.get('/audiobooks', { query, ...options });
+  }
+
+  /**
+   * Get Spotify catalog information about an audiobook's chapters. Audiobooks are
+   * only available within the US, UK, Canada, Ireland, New Zealand and Australia
+   * markets.
+   */
+  listChapters(
+    id: string,
+    query: AudiobookListChaptersParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SimplifiedChapterObjectsCursorURLPage, SimplifiedChapterObject> {
+    return this._client.getAPIList(path`/audiobooks/${id}/chapters`, CursorURLPage<SimplifiedChapterObject>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type SimplifiedChapterObjectsCursorURLPage = CursorURLPage<SimplifiedChapterObject>;
+
+export interface SimplifiedChapterObject {
+  /**
+   * The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+   * chapter.
+   */
+  id: string;
+
+  /**
+   * @deprecated A URL to a 30 second preview (MP3 format) of the chapter. `null` if
+   * not available.
+   */
+  audio_preview_url: string | null;
+
+  /**
+   * The number of the chapter
+   */
+  chapter_number: number;
+
+  /**
+   * A description of the chapter. HTML tags are stripped away from this field, use
+   * `html_description` field in case HTML tags are needed.
+   */
+  description: string;
+
+  /**
+   * The chapter length in milliseconds.
+   */
+  duration_ms: number;
+
+  /**
+   * Whether or not the chapter has explicit content (true = yes it does; false = no
+   * it does not OR unknown).
+   */
+  explicit: boolean;
+
+  /**
+   * External URLs for this chapter.
+   */
+  external_urls: Shared.ExternalURLObject;
+
+  /**
+   * A link to the Web API endpoint providing full details of the chapter.
+   */
+  href: string;
+
+  /**
+   * A description of the chapter. This field may contain HTML tags.
+   */
+  html_description: string;
+
+  /**
+   * The cover art for the chapter in various sizes, widest first.
+   */
+  images: Array<Shared.ImageObject>;
+
+  /**
+   * True if the chapter is playable in the given market. Otherwise false.
+   */
+  is_playable: boolean;
+
+  /**
+   * A list of the languages used in the chapter, identified by their
+   * [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639) code.
+   */
+  languages: Array<string>;
+
+  /**
+   * The name of the chapter.
+   */
+  name: string;
+
+  /**
+   * The date the chapter was first released, for example `"1981-12-15"`. Depending
+   * on the precision, it might be shown as `"1981"` or `"1981-12"`.
+   */
+  release_date: string;
+
+  /**
+   * The precision with which `release_date` value is known.
+   */
+  release_date_precision: 'year' | 'month' | 'day';
+
+  /**
+   * The object type.
+   */
+  type: 'episode';
+
+  /**
+   * The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the
+   * chapter.
+   */
+  uri: string;
+
+  /**
+   * A list of the countries in which the chapter can be played, identified by their
+   * [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code.
+   */
+  available_markets?: Array<string>;
+
+  /**
+   * Included in the response when a content restriction is applied.
+   */
+  restrictions?: Shared.ChapterRestrictionObject;
+
+  /**
+   * The user's most recent position in the chapter. Set if the supplied access token
+   * is a user token and has the scope 'user-read-playback-position'.
+   */
+  resume_point?: Shared.ResumePointObject;
+}
+
+export interface AudiobookRetrieveResponse extends Shared.AudiobookBase {
+  /**
+   * The chapters of the audiobook.
+   */
+  chapters: AudiobookRetrieveResponse.Chapters;
+}
+
+export namespace AudiobookRetrieveResponse {
+  /**
+   * The chapters of the audiobook.
+   */
+  export interface Chapters {
+    /**
+     * A link to the Web API endpoint returning the full result of the request
+     */
+    href: string;
+
+    items: Array<AudiobooksAPI.SimplifiedChapterObject>;
+
+    /**
+     * 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 AudiobookListResponse {
+  audiobooks: Array<AudiobookListResponse.Audiobook>;
+}
+
+export namespace AudiobookListResponse {
+  export interface Audiobook extends Shared.AudiobookBase {
+    /**
+     * The chapters of the audiobook.
+     */
+    chapters: Audiobook.Chapters;
+  }
+
+  export namespace Audiobook {
+    /**
+     * The chapters of the audiobook.
+     */
+    export interface Chapters {
+      /**
+       * A link to the Web API endpoint returning the full result of the request
+       */
+      href: string;
+
+      items: Array<AudiobooksAPI.SimplifiedChapterObject>;
+
+      /**
+       * 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 AudiobookRetrieveParams {
+  /**
+   * 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 AudiobookListParams {
+  /**
+   * A comma-separated list of the
+   * [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+   * `ids=18yVqkdbdRvS24c0Ilj2ci,1HGw3J3NxZO1TP1BTtVhpZ`. 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 AudiobookListChaptersParams {
+  /**
+   * 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 Audiobooks {
+  export {
+    type SimplifiedChapterObject as SimplifiedChapterObject,
+    type AudiobookRetrieveResponse as AudiobookRetrieveResponse,
+    type AudiobookListResponse as AudiobookListResponse,
+    type SimplifiedChapterObjectsCursorURLPage as SimplifiedChapterObjectsCursorURLPage,
+    type AudiobookRetrieveParams as AudiobookRetrieveParams,
+    type AudiobookListParams as AudiobookListParams,
+    type AudiobookListChaptersParams as AudiobookListChaptersParams,
+  };
+}