diff --git a/eslint.config.js b/eslint.config.js index 8938d918..c292f444 100644 --- a/eslint.config.js +++ b/eslint.config.js @@ -18,6 +18,7 @@ export default [ 'node_modules/*', 'packages/*/node_modules/*', 'packages/*/dist/*', + 'packages/**/*.generated.ts', 'coverage', ], }, diff --git a/packages/api/CHANGELOG.md b/packages/api/CHANGELOG.md new file mode 100644 index 00000000..9bb506d0 --- /dev/null +++ b/packages/api/CHANGELOG.md @@ -0,0 +1,13 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + + +## [0.1.0] - 2024-xx-xx + +### Changed + +- Initial release of joined API types and `fetch` wrapper diff --git a/packages/api/README.md b/packages/api/README.md new file mode 100644 index 00000000..651416ff --- /dev/null +++ b/packages/api/README.md @@ -0,0 +1,18 @@ +# TIDAL API v2 Beta + +A thin wrapper around the API domains described at: https://developer.tidal.com/apiref (which is again built on the JSON API spec: https://jsonapi.org/format/) + +The module provides Typescript types and a `fetch` based function for getting data, using: https://openapi-ts.pages.dev/ + +## Usage + +One function is exposed that can be used for creating a function that can then do network calls: `createAPIClient`. Also the API types are exposed and can be used directly. + +### Example +See the `examples/` folder for some ways it can be used. + +To run it do: `pnpm dev` + +## Development + +Run `pnpm generateTypes` to regenerate the types from the API specs. diff --git a/packages/api/examples/example.js b/packages/api/examples/example.js new file mode 100644 index 00000000..14181dd1 --- /dev/null +++ b/packages/api/examples/example.js @@ -0,0 +1,197 @@ +/* eslint-disable no-console */ +import { credentialsProvider, init as initAuth } from '@tidal-music/auth'; + +import { createAPIClient } from '../dist'; + +/** + * Runs the example with a client ID and client secret (from https://developer.tidal.com). + * + * @param {string} clientId The client ID. + * @param {string} clientSecret The client secret. + * @param {string} searchTerm The search term. + */ +async function runExample(clientId, clientSecret, searchTerm) { + await initAuth({ + clientId, + clientSecret, + credentialsStorageKey: 'clientCredentials', + }); + + const apiClient = createAPIClient(credentialsProvider); + const results = document.getElementById('results'); + results.innerHTML = ''; + + /** + * Retrieves an album by its ID. + * + * @param {string} id The ID of the album. + */ + async function getAlbum(id) { + const { data, error } = await apiClient.GET('/albums/{id}', { + params: { + path: { id }, + query: { countryCode: 'NO' }, + }, + }); + + if (error) { + error.errors.forEach( + err => (results.innerHTML += `
  • ${err.detail}
  • `), + ); + } else { + for (const [key, value] of Object.entries(data.data.attributes)) { + results.innerHTML += `
  • ${key}:${JSON.stringify(value)}
  • `; + } + } + } + // Example of an API request + await getAlbum('75413011'); + + /** + * Retrieves an album with the tracks and other relationships. + * + * @param {string} albumId The ID of the album. + */ + async function getAlbumWithTracks(albumId) { + const { data, error } = await apiClient.GET('/albums/{albumId}', { + params: { + path: { albumId }, + query: { countryCode: 'NO', include: 'items,artists,providers' }, + }, + }); + + if (error) { + console.error(error); + } else { + console.log(data); + console.log(JSON.stringify(data)); + } + } + // Example of another API request + await getAlbumWithTracks('75413011'); + + /** + * Retrieves an artist by its ID. + * + * @param {string} id The ID of the artist. + */ + async function getArtist(id) { + const { data, error } = await apiClient.GET('/artists/{id}', { + params: { + path: { id }, + query: { countryCode: 'NO' }, + }, + }); + + if (error) { + console.error(error); + } else { + console.log(data.data.attributes.name); + } + } + // Example failing API request + await getArtist('1'); + + /** + * Retrieves a playlist by its ID. + * + * @param {string} id The ID of the playlist. + */ + async function getPlaylist(id) { + const { data, error } = await apiClient.GET('/playlists/{id}', { + params: { + path: { id }, + query: { countryCode: 'NO' }, + }, + }); + + if (error) { + error.errors.forEach( + err => (results.innerHTML += `
  • ${err.detail}
  • `), + ); + } else { + for (const [key, value] of Object.entries(data.data.attributes)) { + results.innerHTML += `
  • ${key}:${JSON.stringify(value)}
  • `; + } + } + } + // Example of a playlist API request + await getPlaylist('bd878bbc-c0a1-4b81-9a2a-a16dc9926300'); + + /** + * Do a search for a term + * + * @param {string} query The search term. + */ + async function doSearch(query) { + const { data, error } = await apiClient.GET('/searchresults/{query}', { + params: { + path: { query }, + query: { countryCode: 'NO', include: 'topHits' }, + }, + }); + + if (error) { + error.errors.forEach( + err => (results.innerHTML += `
  • ${err.detail}
  • `), + ); + } else { + data.data.relationships.topHits.data.forEach(hit => { + const item = data.included.find(i => i.id === hit.id); + const text = item.attributes.title || item.attributes.name; + results.innerHTML += `
  • ${hit.type}:${text}
  • `; + }); + } + } + // Example of a search API request + await doSearch(searchTerm); + + /** + * Retrieves User Public Profile by their ID. + * + * @param {string} id The ID of the user. + */ + async function getUserPublicProfile(id) { + const { data, error } = await apiClient.GET('/userPublicProfiles/{id}', { + params: { + path: { id }, + query: { countryCode: 'NO' }, + }, + }); + + if (error) { + error.errors.forEach( + err => (results.innerHTML += `
  • ${err.detail}
  • `), + ); + } else { + for (const [key, value] of Object.entries(data.data)) { + results.innerHTML += `
  • ${key}:${JSON.stringify(value)}
  • `; + } + } + } + // Example of a user API request + await getUserPublicProfile('12345'); +} + +const authenticateHandler = async (event, form) => { + event.preventDefault(); + + if (!form) { + return; + } + + const formData = new FormData(form); + const clientId = formData.get('clientId'); + const clientSecret = formData.get('clientSecret'); + const searchTerm = formData.get('searchTerm'); + + await runExample(clientId, clientSecret, searchTerm); +}; + +window.addEventListener('load', () => { + const form = document.getElementById('clientCredentialsForm'); + + form?.addEventListener('submit', event => { + authenticateHandler(event, form).catch(error => console.error(error)); + }); +}); diff --git a/packages/api/index.html b/packages/api/index.html new file mode 100644 index 00000000..fc1b99b3 --- /dev/null +++ b/packages/api/index.html @@ -0,0 +1,30 @@ + + + + + +
    + + + + +
    + + + + + + diff --git a/packages/api/package.json b/packages/api/package.json new file mode 100644 index 00000000..a8fa4599 --- /dev/null +++ b/packages/api/package.json @@ -0,0 +1,50 @@ +{ + "name": "@tidal-music/api", + "version": "0.1.0", + "type": "module", + "files": [ + "dist" + ], + "repository": { + "type": "git", + "url": "ssh://git@github.com:tidal-music/tidal-sdk-web.git" + }, + "license": "Apache-2.0", + "module": "dist/index.js", + "types": "dist/index.d.ts", + "exports": { + "default": "./dist/index.js", + "import": "./dist/index.js" + }, + "scripts": { + "prepare": "vite build", + "build": "vite build", + "build:dev": "vite build -m development", + "clean": "rm -rf coverage dist .eslintcache", + "dev": "vite --debug --cors -c=./vite.config.ts", + "lint": "eslint . --cache --cache-strategy content", + "lint:ci": "eslint . --quiet", + "lint:fix": "pnpm run lint --fix", + "preview": "vite preview", + "generateTypes": "openapi-typescript", + "test": "vitest", + "test:coverage": "pnpm run test --coverage", + "test:ui": "pnpm run test:coverage --ui", + "typecheck": "tsc" + }, + "dependencies": { + "@tidal-music/api": "workspace:*", + "openapi-fetch": "0.12.0" + }, + "devDependencies": { + "@tidal-music/auth": "workspace:^", + "@tidal-music/common": "workspace:^", + "@vitest/coverage-v8": "2.0.4", + "@vitest/ui": "2.0.4", + "openapi-typescript": "7.4.0", + "typescript": "5.6.2", + "vite": "5.4.6", + "vite-plugin-dts": "4.2.1", + "vitest": "2.0.4" + } +} diff --git a/packages/api/redocly.yaml b/packages/api/redocly.yaml new file mode 100644 index 00000000..ce932e28 --- /dev/null +++ b/packages/api/redocly.yaml @@ -0,0 +1,17 @@ +apis: + catalogue: + root: https://developer.tidal.com/apiref/api-specifications/api-public-catalogue-jsonapi/tidal-catalog-v2-openapi-3.0.json + x-openapi-ts: + output: ./src/catalogueAPI.generated.ts + playlist: + root: https://developer.tidal.com/apiref/api-specifications/api-public-user-content/tidal-user-content-openapi-3.0.json + x-openapi-ts: + output: ./src/playlistAPI.generated.ts + search: + root: https://developer.tidal.com/apiref/api-specifications/api-public-search-jsonapi/tidal-search-v2-openapi-3.0.json + x-openapi-ts: + output: ./src/searchAPI.generated.ts + user: + root: https://developer.tidal.com/apiref/api-specifications/api-public-user-jsonapi/tidal-user-v2-openapi-3.0.json + x-openapi-ts: + output: ./src/userAPI.generated.ts diff --git a/packages/api/src/api.test.ts b/packages/api/src/api.test.ts new file mode 100644 index 00000000..057213bf --- /dev/null +++ b/packages/api/src/api.test.ts @@ -0,0 +1,11 @@ +import { createAPIClient } from './api'; + +describe('createAPIClient', () => { + it('creates a TIDAL API client', () => { + const client = createAPIClient({ + bus: vi.fn(), + getCredentials: vi.fn(), + }); + expect(client).toBeDefined(); + }); +}); diff --git a/packages/api/src/api.ts b/packages/api/src/api.ts new file mode 100644 index 00000000..b7765173 --- /dev/null +++ b/packages/api/src/api.ts @@ -0,0 +1,33 @@ +import type { CredentialsProvider } from '@tidal-music/common'; +import createClient, { type Middleware } from 'openapi-fetch'; + +import type { paths as cataloguePaths } from './catalogueAPI.generated'; +import type { paths as playlistPaths } from './playlistAPI.generated'; +import type { paths as searchPaths } from './searchAPI.generated'; +import type { paths as userPaths } from './userAPI.generated'; + +/** + * Create a Catalogue API client with the provided credentials. + * + * @param credentialsProvider The credentials provider, from Auth module. + */ +export function createAPIClient(credentialsProvider: CredentialsProvider) { + const authMiddleware: Middleware = { + async onRequest({ request }) { + const credentials = await credentialsProvider.getCredentials(); + + // Add Authorization header to every request + request.headers.set('Authorization', `Bearer ${credentials.token}`); + return request; + }, + }; + + type AllPaths = cataloguePaths & playlistPaths & searchPaths & userPaths; + + const apiClient = createClient({ + baseUrl: 'https://openapi.tidal.com/v2/', + }); + apiClient.use(authMiddleware); + + return apiClient; +} diff --git a/packages/api/src/catalogueAPI.generated.ts b/packages/api/src/catalogueAPI.generated.ts new file mode 100644 index 00000000..663f59a3 --- /dev/null +++ b/packages/api/src/catalogueAPI.generated.ts @@ -0,0 +1,7809 @@ +/** + * This file was auto-generated by openapi-typescript. + * Do not make direct changes to the file. + */ + +export interface paths { + "/videos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get multiple videos + * @description Retrieve multiple video details. + */ + get: operations["getVideosByFilters"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/videos/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get single video + * @description Retrieve video details by TIDAL video id. + */ + get: operations["getVideoById"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/videos/{id}/relationships/providers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: providers + * @description This endpoint can be used to retrieve a list of video's related providers. + */ + get: operations["getVideoProvidersRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/videos/{id}/relationships/artists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: artists + * @description Retrieve artist details of the related video. + */ + get: operations["getVideoArtistsRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/videos/{id}/relationships/albums": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: albums + * @description Retrieve album details of the related video. + */ + get: operations["getVideoAlbumsRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/tracks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get multiple tracks + * @description Retrieve multiple track details. + */ + get: operations["getTracksByFilters"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/tracks/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get single track + * @description Retrieve track details by TIDAL track id. + */ + get: operations["getTrackById"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/tracks/{id}/relationships/similarTracks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: similar tracks + * @description This endpoint can be used to retrieve a list of tracks similar to the given track. + */ + get: operations["getTrackSimilarTracksRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/tracks/{id}/relationships/radio": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: radio + * @description This endpoint can be used to retrieve a list of radios for the given track. + */ + get: operations["getTrackRadioRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/tracks/{id}/relationships/providers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: providers + * @description This endpoint can be used to retrieve a list of track's related providers. + */ + get: operations["getTrackProvidersRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/tracks/{id}/relationships/artists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: artists + * @description Retrieve artist details of the related track. + */ + get: operations["getTrackArtistsRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/tracks/{id}/relationships/albums": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: albums + * @description Retrieve album details of the related track. + */ + get: operations["getTrackAlbumsRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/providers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get multiple providers + * @description Retrieve multiple provider details. + */ + get: operations["getProvidersByFilters"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/providers/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get single provider + * @description Retrieve provider details by TIDAL provider id. + */ + get: operations["getProviderById"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/artists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get multiple artists + * @description Retrieve multiple artist details. + */ + get: operations["getArtistsByFilters"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/artists/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get single artist + * @description Retrieve artist details by TIDAL artist id. + */ + get: operations["getArtistById"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/artists/{id}/relationships/videos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: videos + * @description Retrieve video details by related artist. + */ + get: operations["getArtistVideosRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/artists/{id}/relationships/tracks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: tracks + * @description Retrieve track details by related artist. + */ + get: operations["getArtistTracksRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/artists/{id}/relationships/trackProviders": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: track providers + * @description Retrieve providers that have released tracks for this artist + */ + get: operations["getArtistTrackProvidersRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/artists/{id}/relationships/similarArtists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: similar artists + * @description This endpoint can be used to retrieve a list of artists similar to the given artist. + */ + get: operations["getArtistSimilarArtistsRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/artists/{id}/relationships/radio": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: radio + * @description This endpoint can be used to retrieve a list of radios for the given artist. + */ + get: operations["getArtistRadioRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/artists/{id}/relationships/albums": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: albums + * @description Retrieve album details of the related artist. + */ + get: operations["getArtistAlbumsRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/albums": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get multiple albums + * @description Retrieve multiple album details. + */ + get: operations["getAlbumsByFilters"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/albums/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get single album + * @description Retrieve album details by TIDAL album id. + */ + get: operations["getAlbumById"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/albums/{id}/relationships/similarAlbums": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: similar albums + * @description This endpoint can be used to retrieve a list of albums similar to the given album. + */ + get: operations["getAlbumSimilarAlbumsRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/albums/{id}/relationships/providers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: providers + * @description This endpoint can be used to retrieve a list of album's related providers. + */ + get: operations["getAlbumProvidersRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/albums/{id}/relationships/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: items + * @description Retrieve album item details. + */ + get: operations["getAlbumItemsRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/albums/{id}/relationships/artists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: artists + * @description Retrieve artist details of the related album. + */ + get: operations["getAlbumArtistsRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; +} +export type webhooks = Record; +export interface components { + schemas: { + Error_Document: { + /** @description array of error objects */ + errors?: components["schemas"]["Error_Object"][]; + links?: components["schemas"]["Links"]; + }; + Error_Object: { + /** @description unique identifier for this particular occurrence of the problem */ + id?: string; + /** @description HTTP status code applicable to this problem */ + status?: string; + /** @description application-specific error code */ + code?: string; + /** @description human-readable explanation specific to this occurrence of the problem */ + detail?: string; + source?: components["schemas"]["Error_Object_Source"]; + }; + /** @description object containing references to the primary source of the error */ + Error_Object_Source: { + /** + * @description a JSON Pointer [RFC6901] to the value in the request document that caused the error + * @example /data/attributes/title + */ + pointer?: string; + /** + * @description string indicating which URI query parameter caused the error. + * @example countryCode + */ + parameter?: string; + /** + * @description string indicating the name of a single request header which caused the error + * @example X-some-custom-header + */ + header?: string; + }; + /** @description links object */ + Links: { + /** + * @description the link that generated the current response document + * @example /artists/xyz/relationships/tracks + */ + self: string; + /** + * @description the next page of data (pagination) + * @example /artists/xyz/relationships/tracks?page[cursor]=zyx + */ + next?: string; + }; + /** @description attributes object representing some of the resource's data */ + Albums_Attributes: { + /** + * @description Original title + * @example 4:44 + */ + title: string; + /** + * @description Barcode id (EAN-13 or UPC-A) + * @example 00854242007552 + */ + barcodeId: string; + /** + * Format: int32 + * @description Number of volumes + * @example 1 + */ + numberOfVolumes: number; + /** + * Format: int32 + * @description Number of album items + * @example 13 + */ + numberOfItems: number; + /** + * @description Duration (ISO-8601) + * @example P41M5S + */ + duration: string; + /** + * @description Indicates whether an album consist of any explicit content + * @example true + */ + explicit: boolean; + /** + * Format: date + * @description Release date (ISO-8601) + * @example 2017-06-30 + */ + releaseDate?: string; + /** + * @description Copyright information + * @example (p)(c) 2017 S. CARTER ENTERPRISES, LLC. MARKETED BY ROC NATION & DISTRIBUTED BY ROC NATION/UMG RECORDINGS INC. + */ + copyright?: string; + /** + * Format: double + * @description Album popularity (ranged in 0.00 ... 1.00). Conditionally visible + * @example 0.56 + */ + popularity: number; + /** @description Defines an album availability e.g. for streaming, DJs, stems */ + availability?: ("STREAM" | "DJ" | "STEM")[]; + mediaTags: string[]; + /** @description Represents available links to, and metadata about, an album cover images */ + imageLinks?: components["schemas"]["Catalogue_Item_Image_Link"][]; + /** @description Represents available links to, and metadata about, an album cover videos */ + videoLinks?: components["schemas"]["Catalogue_Item_Video_Link"][]; + /** @description Represents available links to something that is related to an album resource, but external to the TIDAL API */ + externalLinks?: components["schemas"]["Catalogue_Item_External_Link"][]; + }; + Albums_Item_Resource_Identifier: { + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + meta?: components["schemas"]["Albums_Item_Resource_Identifier_Meta"]; + }; + Albums_Item_Resource_Identifier_Meta: { + /** + * Format: int32 + * @description volume number + * @example 1 + */ + volumeNumber: number; + /** + * Format: int32 + * @description track number + * @example 4 + */ + trackNumber: number; + }; + /** @description Album items (tracks/videos) relationship */ + Albums_Items_Relationship: { + data?: components["schemas"]["Albums_Item_Resource_Identifier"][][]; + links?: components["schemas"]["Links"]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Albums_Relationships: { + artists: components["schemas"]["Multi_Data_Relationship_Doc"]; + items: components["schemas"]["Albums_Items_Relationship"]; + similarAlbums: components["schemas"]["Multi_Data_Relationship_Doc"]; + providers: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + Albums_Resource: { + attributes?: components["schemas"]["Albums_Attributes"]; + relationships?: components["schemas"]["Albums_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description attributes object representing some of the resource's data */ + Artists_Attributes: { + /** + * @description Artist name + * @example JAY Z + */ + name: string; + /** + * Format: double + * @description Artist popularity (ranged in 0.00 ... 1.00). Conditionally visible + * @example 0.56 + */ + popularity: number; + /** @description Represents available links to, and metadata about, an artist images */ + imageLinks?: components["schemas"]["Catalogue_Item_Image_Link"][]; + /** @description Represents available links to something that is related to an artist resource, but external to the TIDAL API */ + externalLinks?: components["schemas"]["Catalogue_Item_External_Link"][]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Artists_Relationships: { + albums: components["schemas"]["Multi_Data_Relationship_Doc"]; + tracks: components["schemas"]["Multi_Data_Relationship_Doc"]; + videos: components["schemas"]["Multi_Data_Relationship_Doc"]; + similarArtists: components["schemas"]["Multi_Data_Relationship_Doc"]; + trackProviders: components["schemas"]["Artists_Track_Providers_Relationship"]; + radio: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + Artists_Resource: { + attributes?: components["schemas"]["Artists_Attributes"]; + relationships?: components["schemas"]["Artists_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description Providers that have released tracks for this artist */ + Artists_Track_Providers_Relationship: { + data?: components["schemas"]["Artists_Track_Providers_Resource_Identifier"][][]; + links?: components["schemas"]["Links"]; + }; + Artists_Track_Providers_Resource_Identifier: { + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + meta?: components["schemas"]["Artists_Track_Providers_Resource_Identifier_Meta"]; + }; + Artists_Track_Providers_Resource_Identifier_Meta: { + /** + * Format: int64 + * @description total number of tracks released together with the provider + * @example 14 + */ + numberOfTracks: number; + }; + Catalogue_Item_External_Link: { + /** + * @description link to something that is related to a resource + * @example https://tidal.com/browse/artist/1566 + */ + href: string; + meta: components["schemas"]["External_Link_Meta"]; + }; + Catalogue_Item_Image_Link: { + /** + * @description link to an image + * @example https://resources.tidal.com/images/717dfdae/beb0/4aea/a553/a70064c30386/80x80.jpg + */ + href: string; + meta: components["schemas"]["Image_Link_Meta"]; + }; + Catalogue_Item_Video_Link: { + /** + * @description link to a video + * @example https://resources.tidal.com/images/717dfdae/beb0/4aea/a553/a70064c30386/80x80.mp4 + */ + href: string; + meta: components["schemas"]["Video_Link_Meta"]; + }; + /** @description metadata about an external link */ + External_Link_Meta: { + /** + * @description external link type + * @example TIDAL_SHARING + * @enum {string} + */ + type: "TIDAL_SHARING" | "TIDAL_AUTOPLAY_ANDROID" | "TIDAL_AUTOPLAY_IOS" | "TIDAL_AUTOPLAY_WEB" | "TWITTER" | "FACEBOOK" | "INSTAGRAM" | "TIKTOK" | "SNAPCHAT" | "HOMEPAGE"; + }; + /** @description metadata about an image */ + Image_Link_Meta: { + /** + * Format: int32 + * @description image width (in pixels) + * @example 80 + */ + width: number; + /** + * Format: int32 + * @description image height (in pixels) + * @example 80 + */ + height: number; + }; + /** @description Playlist owners relationship */ + Multi_Data_Relationship_Doc: { + /** @description array of relationship resource linkages */ + data?: components["schemas"]["Resource_Identifier"][]; + links?: components["schemas"]["Links"]; + }; + /** @description attributes object representing some of the resource's data */ + Playlists_Attributes: { + /** + * @description Playlist name + * @example My Playlist + */ + name: string; + /** + * @description Playlist description + * @example All the good details about what is inside this playlist + */ + description?: string; + /** + * @description Indicates if the playlist has a duration and set number of tracks + * @example true + */ + bounded: boolean; + /** + * @description Duration of the playlist expressed in accordance with ISO 8601 + * @example P30M5S + */ + duration?: string; + /** + * Format: int32 + * @description Number of items in the playlist + * @example 5 + */ + numberOfItems?: number; + /** + * @description Sharing links to the playlist + * @example true + */ + externalLinks: components["schemas"]["Playlists_External_Link"][]; + /** + * Format: date-time + * @description Datetime of playlist creation (ISO 8601) + */ + createdAt: string; + /** + * Format: date-time + * @description Datetime of last modification of the playlist (ISO 8601) + */ + lastModifiedAt: string; + /** + * @description Privacy setting of the playlist + * @example PUBLIC + */ + privacy: string; + /** + * @description The type of the playlist + * @example EDITORIAL + */ + playlistType: string; + /** + * @description Images associated with the playlist + * @example true + */ + imageLinks: components["schemas"]["Playlists_Image_Link"][]; + }; + /** + * @description Sharing links to the playlist + * @example true + */ + Playlists_External_Link: { + /** + * @description link to something that is related to a resource + * @example https://tidal.com/browse/artist/1566 + */ + href: string; + meta: components["schemas"]["External_Link_Meta"]; + }; + /** + * @description Images associated with the playlist + * @example true + */ + Playlists_Image_Link: { + /** + * @description link to an image + * @example https://resources.tidal.com/images/717dfdae/beb0/4aea/a553/a70064c30386/80x80.jpg + */ + href: string; + meta?: components["schemas"]["Image_Link_Meta"]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Playlists_Relationships: { + items: components["schemas"]["Multi_Data_Relationship_Doc"]; + owners: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + Playlists_Resource: { + attributes?: components["schemas"]["Playlists_Attributes"]; + relationships?: components["schemas"]["Playlists_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description attributes object representing some of the resource's data */ + Providers_Attributes: { + /** + * @description Provider name. Conditionally visible. + * @example Columbia/Legacy + */ + name: string; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Providers_Relationships: Record; + Providers_Resource: { + attributes?: components["schemas"]["Providers_Attributes"]; + relationships?: components["schemas"]["Providers_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description array of relationship resource linkages */ + Resource_Identifier: { + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description attributes object representing some of the resource's data */ + Tracks_Attributes: { + /** + * @description Album item's title + * @example Kill Jay Z + */ + title: string; + /** + * @description Version of the album's item; complements title + * @example Kill Jay Z + */ + version?: string; + /** + * @description ISRC code + * @example TIDAL2274 + */ + isrc: string; + /** + * @description Duration expressed in accordance with ISO 8601 + * @example P30M5S + */ + duration: string; + /** + * @description Copyright information + * @example (p)(c) 2017 S. CARTER ENTERPRISES, LLC. MARKETED BY ROC NATION & DISTRIBUTED BY ROC NATION/UMG RECORDINGS INC. + */ + copyright?: string; + /** + * @description Indicates whether a catalog item consist of any explicit content + * @example false + */ + explicit: boolean; + /** + * Format: double + * @description Track or video popularity (ranged in 0.00 ... 1.00). Conditionally visible + * @example 0.56 + */ + popularity: number; + /** @description Defines a catalog item availability e.g. for streaming, DJs, stems */ + availability?: ("STREAM" | "DJ" | "STEM")[]; + mediaTags: string[]; + /** @description Represents available links to something that is related to a catalog item, but external to the TIDAL API */ + externalLinks?: components["schemas"]["Catalogue_Item_External_Link"][]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Tracks_Relationships: { + albums: components["schemas"]["Multi_Data_Relationship_Doc"]; + artists: components["schemas"]["Multi_Data_Relationship_Doc"]; + providers: components["schemas"]["Multi_Data_Relationship_Doc"]; + similarTracks: components["schemas"]["Multi_Data_Relationship_Doc"]; + radio: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + Tracks_Resource: { + attributes?: components["schemas"]["Tracks_Attributes"]; + relationships?: components["schemas"]["Tracks_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description metadata about a video */ + Video_Link_Meta: { + /** + * Format: int32 + * @description video width (in pixels) + * @example 80 + */ + width: number; + /** + * Format: int32 + * @description video height (in pixels) + * @example 80 + */ + height: number; + }; + /** @description attributes object representing some of the resource's data */ + Videos_Attributes: { + /** + * @description Album item's title + * @example Kill Jay Z + */ + title: string; + /** + * @description Version of the album's item; complements title + * @example Kill Jay Z + */ + version?: string; + /** + * @description ISRC code + * @example TIDAL2274 + */ + isrc: string; + /** + * @description Duration expressed in accordance with ISO 8601 + * @example P30M5S + */ + duration: string; + /** + * @description Copyright information + * @example (p)(c) 2017 S. CARTER ENTERPRISES, LLC. MARKETED BY ROC NATION & DISTRIBUTED BY ROC NATION/UMG RECORDINGS INC. + */ + copyright?: string; + /** + * Format: date + * @description Release date (ISO-8601) + * @example 2017-06-27 + */ + releaseDate?: string; + /** + * @description Indicates whether a catalog item consist of any explicit content + * @example false + */ + explicit: boolean; + /** + * Format: double + * @description Track or video popularity (ranged in 0.00 ... 1.00). Conditionally visible + * @example 0.56 + */ + popularity: number; + /** @description Defines a catalog item availability e.g. for streaming, DJs, stems */ + availability?: ("STREAM" | "DJ" | "STEM")[]; + /** @description Represents available links to, and metadata about, an album item images */ + imageLinks?: components["schemas"]["Catalogue_Item_Image_Link"][]; + /** @description Represents available links to something that is related to a catalog item, but external to the TIDAL API */ + externalLinks?: components["schemas"]["Catalogue_Item_External_Link"][]; + }; + Videos_Multi_Data_Document: { + /** @description array of primary resource data */ + data?: components["schemas"]["Videos_Resource"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Providers_Resource"] | components["schemas"]["Tracks_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Playlists_Resource"])[]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Videos_Relationships: { + albums: components["schemas"]["Multi_Data_Relationship_Doc"]; + artists: components["schemas"]["Multi_Data_Relationship_Doc"]; + providers: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + Videos_Resource: { + attributes?: components["schemas"]["Videos_Attributes"]; + relationships?: components["schemas"]["Videos_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + Videos_Single_Data_Document: { + data?: components["schemas"]["Videos_Resource"]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Providers_Resource"] | components["schemas"]["Tracks_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Playlists_Resource"])[]; + }; + Providers_Relationship_Document: { + /** @description array of relationship resource linkages */ + data?: components["schemas"]["Resource_Identifier"][]; + links?: components["schemas"]["Links"]; + included?: components["schemas"]["Providers_Resource"][]; + }; + Artists_Relationship_Document: { + /** @description array of relationship resource linkages */ + data?: components["schemas"]["Resource_Identifier"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Tracks_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Providers_Resource"] | components["schemas"]["Playlists_Resource"])[]; + }; + Albums_Relationship_Document: { + /** @description array of relationship resource linkages */ + data?: components["schemas"]["Resource_Identifier"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Albums_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Providers_Resource"] | components["schemas"]["Tracks_Resource"] | components["schemas"]["Videos_Resource"])[]; + }; + /** @description User recommendations */ + Singleton_Data_Relationship_Doc: { + data?: components["schemas"]["Resource_Identifier"]; + links?: components["schemas"]["Links"]; + }; + Tracks_Multi_Data_Document: { + /** @description array of primary resource data */ + data?: components["schemas"]["Tracks_Resource"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Tracks_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Providers_Resource"] | components["schemas"]["Playlists_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Users_Resource"])[]; + }; + /** @description attributes object representing some of the resource's data */ + Users_Attributes: { + /** + * @description user name + * @example username + */ + username: string; + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + country: string; + /** + * @description email address + * @example test@test.com + */ + email?: string; + /** + * @description Is the email verified + * @example true + */ + emailVerified?: boolean; + /** + * @description Users first name + * @example John + */ + firstName?: string; + /** + * @description Users last name + * @example Rambo + */ + lastName?: string; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Users_Relationships: { + entitlements: components["schemas"]["Singleton_Data_Relationship_Doc"]; + publicProfile: components["schemas"]["Singleton_Data_Relationship_Doc"]; + recommendations: components["schemas"]["Singleton_Data_Relationship_Doc"]; + }; + Users_Resource: { + attributes?: components["schemas"]["Users_Attributes"]; + relationships?: components["schemas"]["Users_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + Tracks_Single_Data_Document: { + data?: components["schemas"]["Tracks_Resource"]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Tracks_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Providers_Resource"] | components["schemas"]["Playlists_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Users_Resource"])[]; + }; + Tracks_Relationships_Document: { + /** @description array of relationship resource linkages */ + data?: components["schemas"]["Resource_Identifier"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Tracks_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Providers_Resource"] | components["schemas"]["Playlists_Resource"])[]; + }; + Providers_Multi_Data_Document: { + /** @description array of primary resource data */ + data?: components["schemas"]["Providers_Resource"][]; + links?: components["schemas"]["Links"]; + }; + Providers_Single_Data_Document: { + data?: components["schemas"]["Providers_Resource"]; + links?: components["schemas"]["Links"]; + }; + Artists_Multi_Data_Document: { + /** @description array of primary resource data */ + data?: components["schemas"]["Artists_Resource"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Tracks_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Playlists_Resource"] | components["schemas"]["Providers_Resource"] | components["schemas"]["Users_Resource"])[]; + }; + Artists_Single_Data_Document: { + data?: components["schemas"]["Artists_Resource"]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Tracks_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Playlists_Resource"] | components["schemas"]["Providers_Resource"] | components["schemas"]["Users_Resource"])[]; + }; + Videos_Relationships_Document: { + /** @description array of relationship resource linkages */ + data?: components["schemas"]["Resource_Identifier"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Videos_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Providers_Resource"])[]; + }; + Artists_Track_Providers_Relationship_Document: { + data?: components["schemas"]["Artists_Track_Providers_Resource_Identifier"][][]; + links?: components["schemas"]["Links"]; + included?: components["schemas"]["Providers_Resource"][]; + }; + Albums_Multi_Data_Document: { + /** @description array of primary resource data */ + data?: components["schemas"]["Albums_Resource"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Tracks_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Providers_Resource"] | components["schemas"]["Playlists_Resource"])[]; + }; + Albums_Single_Data_Document: { + data?: components["schemas"]["Albums_Resource"]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Tracks_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Providers_Resource"] | components["schemas"]["Playlists_Resource"])[]; + }; + Albums_Items_Relationship_Document: { + data?: components["schemas"]["Albums_Item_Resource_Identifier"][][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Tracks_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Providers_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Playlists_Resource"])[]; + }; + }; + responses: never; + parameters: never; + requestBodies: never; + headers: never; + pathItems: never; +} +export type $defs = Record; +export interface operations { + getVideosByFilters: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: artists, albums, providers + * @example artists + */ + include?: string[]; + /** + * @description Allows to filter the collection of resources based on id attribute value + * @example 75623239 + */ + "filter[id]"?: string[]; + /** + * @description Allows to filter the collection of resources based on isrc attribute value + * @example USSM21600755 + */ + "filter[isrc]"?: string[]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Videos_Multi_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getVideoById: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: artists, albums, providers + * @example artists + */ + include?: string[]; + }; + header?: never; + path: { + /** + * @description TIDAL video id + * @example 75623239 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Videos_Single_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getVideoProvidersRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: providers + * @example providers + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description TIDAL id of the video + * @example 75623239 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Providers_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getVideoArtistsRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: artists + * @example artists + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description TIDAL video id + * @example 75623239 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Artists_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getVideoAlbumsRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: albums + * @example albums + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description TIDAL video id + * @example 75623239 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Albums_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getTracksByFilters: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: artists, albums, providers, similarTracks, radio + * @example artists + */ + include?: string[]; + /** + * @description Allows to filter the collection of resources based on id attribute value + * @example 251380837 + */ + "filter[id]"?: string[]; + /** + * @description Allows to filter the collection of resources based on isrc attribute value + * @example USSM12209515 + */ + "filter[isrc]"?: string[]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Tracks_Multi_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getTrackById: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: artists, albums, providers, similarTracks, radio + * @example artists + */ + include?: string[]; + }; + header?: never; + path: { + /** + * @description TIDAL track id + * @example 251380837 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Tracks_Single_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getTrackSimilarTracksRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: similarTracks + * @example similarTracks + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description TIDAL id of the track + * @example 251380837 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Tracks_Relationships_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getTrackRadioRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: radio + * @example radio + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description TIDAL id of the track + * @example 251380837 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Tracks_Relationships_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getTrackProvidersRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: providers + * @example providers + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description TIDAL id of the track + * @example 251380837 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Providers_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getTrackArtistsRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: artists + * @example artists + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description TIDAL track id + * @example 251380837 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Artists_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getTrackAlbumsRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: albums + * @example albums + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description TIDAL track id + * @example 251380837 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Albums_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getProvidersByFilters: { + parameters: { + query?: { + /** @description Allows the client to customize which related resources should be returned */ + include?: string[]; + /** + * @description provider id + * @example 771 + */ + "filter[id]"?: string[]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Providers_Multi_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getProviderById: { + parameters: { + query?: { + /** @description Allows the client to customize which related resources should be returned */ + include?: string[]; + }; + header?: never; + path: { + /** + * @description TIDAL provider id + * @example 771 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Providers_Single_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getArtistsByFilters: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: albums, tracks, videos, similarArtists, trackProviders, radio + * @example albums + */ + include?: string[]; + /** + * @description Allows to filter the collection of resources based on id attribute value + * @example 1566 + */ + "filter[id]"?: string[]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Artists_Multi_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getArtistById: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: albums, tracks, videos, similarArtists, trackProviders, radio + * @example albums + */ + include?: string[]; + }; + header?: never; + path: { + /** + * @description TIDAL artist id + * @example 1566 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Artists_Single_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getArtistVideosRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: videos + * @example videos + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description TIDAL artist id + * @example 1566 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Videos_Relationships_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getArtistTracksRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Collapse by options for getting artist tracks. Available options: FINGERPRINT, ID. FINGERPRINT option might collapse similar tracks based item fingerprints while collapsing by ID always returns all available items. + * @example FINGERPRINT + */ + collapseBy?: "FINGERPRINT" | "NONE"; + /** + * @description Allows the client to customize which related resources should be returned. Available options: tracks + * @example tracks + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description TIDAL artist id + * @example 1566 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Tracks_Relationships_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getArtistTrackProvidersRelationship: { + parameters: { + query?: { + /** + * @description Allows the client to customize which related resources should be returned. Available options: trackProviders + * @example trackProviders + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description TIDAL id of the artist + * @example 1566 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Artists_Track_Providers_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getArtistSimilarArtistsRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: similarArtists + * @example similarArtists + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description TIDAL id of the artist + * @example 1566 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Artists_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getArtistRadioRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: radio + * @example radio + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description TIDAL id of the artist + * @example 1566 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Artists_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getArtistAlbumsRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: albums + * @example albums + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description TIDAL artist id + * @example 1566 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Albums_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getAlbumsByFilters: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: artists, items, providers, similarAlbums + * @example artists + */ + include?: string[]; + /** + * @description Allows to filter the collection of resources based on id attribute value + * @example 251380836 + */ + "filter[id]"?: string[]; + /** + * @description Allows to filter the collection of resources based on barcodeId attribute value + * @example 196589525444 + */ + "filter[barcodeId]"?: string[]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Albums_Multi_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getAlbumById: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: artists, items, providers, similarAlbums + * @example artists + */ + include?: string[]; + }; + header?: never; + path: { + /** + * @description TIDAL album id + * @example 251380836 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Albums_Single_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getAlbumSimilarAlbumsRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: similarAlbums + * @example similarAlbums + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description TIDAL id of the album + * @example 251380836 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Albums_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getAlbumProvidersRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: providers + * @example providers + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description TIDAL id of the album + * @example 251380836 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Providers_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getAlbumItemsRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: items + * @example items + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description TIDAL album id + * @example 251380836 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Albums_Items_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getAlbumArtistsRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: artists + * @example artists + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description TIDAL album id + * @example 251380836 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Artists_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; +} diff --git a/packages/api/src/index.ts b/packages/api/src/index.ts new file mode 100644 index 00000000..5c180991 --- /dev/null +++ b/packages/api/src/index.ts @@ -0,0 +1,12 @@ +export { createAPIClient } from './api'; + +import type { components as catalogueComponents } from './catalogueAPI.generated'; +import type { components as playlistComponents } from './playlistAPI.generated'; +import type { components as searchComponents } from './searchAPI.generated'; +import type { components as userComponents } from './userAPI.generated'; + +// eslint-disable-next-line @typescript-eslint/naming-convention +export type components = catalogueComponents & + playlistComponents & + searchComponents & + userComponents; diff --git a/packages/api/src/playlistAPI.generated.ts b/packages/api/src/playlistAPI.generated.ts new file mode 100644 index 00000000..aaa2706a --- /dev/null +++ b/packages/api/src/playlistAPI.generated.ts @@ -0,0 +1,2049 @@ +/** + * This file was auto-generated by openapi-typescript. + * Do not make direct changes to the file. + */ + +export interface paths { + "/playlists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get multiple playlists + * @description Get user playlists + */ + get: operations["getPlaylistsByFilters"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/playlists/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get single playlist + * @description Get playlist by id + */ + get: operations["getPlaylistById"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/playlists/{id}/relationships/owners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: owner + * @description Get playlist owner + */ + get: operations["getPlaylistOwnersRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/playlists/{id}/relationships/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: items + * @description Get playlist items + */ + get: operations["getPlaylistItemsRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/playlists/me": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get current user's playlists + * @description Get my playlists + */ + get: operations["getMyPlaylists"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; +} +export type webhooks = Record; +export interface components { + schemas: { + Error_Document: { + /** @description array of error objects */ + errors?: components["schemas"]["Error_Object"][]; + links?: components["schemas"]["Links"]; + }; + Error_Object: { + /** @description unique identifier for this particular occurrence of the problem */ + id?: string; + /** @description HTTP status code applicable to this problem */ + status?: string; + /** @description application-specific error code */ + code?: string; + /** @description human-readable explanation specific to this occurrence of the problem */ + detail?: string; + source?: components["schemas"]["Error_Object_Source"]; + }; + /** @description object containing references to the primary source of the error */ + Error_Object_Source: { + /** + * @description a JSON Pointer [RFC6901] to the value in the request document that caused the error + * @example /data/attributes/title + */ + pointer?: string; + /** + * @description string indicating which URI query parameter caused the error. + * @example countryCode + */ + parameter?: string; + /** + * @description string indicating the name of a single request header which caused the error + * @example X-some-custom-header + */ + header?: string; + }; + /** @description links object */ + Links: { + /** + * @description the link that generated the current response document + * @example /artists/xyz/relationships/tracks + */ + self: string; + /** + * @description the next page of data (pagination) + * @example /artists/xyz/relationships/tracks?page[cursor]=zyx + */ + next?: string; + }; + /** @description attributes object representing some of the resource's data */ + Albums_Attributes: { + /** + * @description Original title + * @example 4:44 + */ + title: string; + /** + * @description Barcode id (EAN-13 or UPC-A) + * @example 00854242007552 + */ + barcodeId: string; + /** + * Format: int32 + * @description Number of volumes + * @example 1 + */ + numberOfVolumes: number; + /** + * Format: int32 + * @description Number of album items + * @example 13 + */ + numberOfItems: number; + /** + * @description Duration (ISO-8601) + * @example P41M5S + */ + duration: string; + /** + * @description Indicates whether an album consist of any explicit content + * @example true + */ + explicit: boolean; + /** + * Format: date + * @description Release date (ISO-8601) + * @example 2017-06-30 + */ + releaseDate?: string; + /** + * @description Copyright information + * @example (p)(c) 2017 S. CARTER ENTERPRISES, LLC. MARKETED BY ROC NATION & DISTRIBUTED BY ROC NATION/UMG RECORDINGS INC. + */ + copyright?: string; + /** + * Format: double + * @description Album popularity (ranged in 0.00 ... 1.00). Conditionally visible + * @example 0.56 + */ + popularity: number; + /** @description Defines an album availability e.g. for streaming, DJs, stems */ + availability?: ("STREAM" | "DJ" | "STEM")[]; + mediaTags: string[]; + /** @description Represents available links to, and metadata about, an album cover images */ + imageLinks?: components["schemas"]["Catalogue_Item_Image_Link"][]; + /** @description Represents available links to, and metadata about, an album cover videos */ + videoLinks?: components["schemas"]["Catalogue_Item_Video_Link"][]; + /** @description Represents available links to something that is related to an album resource, but external to the TIDAL API */ + externalLinks?: components["schemas"]["Catalogue_Item_External_Link"][]; + }; + Albums_Item_Resource_Identifier: { + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + meta?: components["schemas"]["Albums_Item_Resource_Identifier_Meta"]; + }; + Albums_Item_Resource_Identifier_Meta: { + /** + * Format: int32 + * @description volume number + * @example 1 + */ + volumeNumber: number; + /** + * Format: int32 + * @description track number + * @example 4 + */ + trackNumber: number; + }; + /** @description Album items (tracks/videos) relationship */ + Albums_Items_Relationship: { + data?: components["schemas"]["Albums_Item_Resource_Identifier"][][]; + links?: components["schemas"]["Links"]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Albums_Relationships: { + artists: components["schemas"]["Multi_Data_Relationship_Doc"]; + items: components["schemas"]["Albums_Items_Relationship"]; + similarAlbums: components["schemas"]["Multi_Data_Relationship_Doc"]; + providers: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + Albums_Resource: { + attributes?: components["schemas"]["Albums_Attributes"]; + relationships?: components["schemas"]["Albums_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description attributes object representing some of the resource's data */ + Artists_Attributes: { + /** + * @description Artist name + * @example JAY Z + */ + name: string; + /** + * Format: double + * @description Artist popularity (ranged in 0.00 ... 1.00). Conditionally visible + * @example 0.56 + */ + popularity: number; + /** @description Represents available links to, and metadata about, an artist images */ + imageLinks?: components["schemas"]["Catalogue_Item_Image_Link"][]; + /** @description Represents available links to something that is related to an artist resource, but external to the TIDAL API */ + externalLinks?: components["schemas"]["Catalogue_Item_External_Link"][]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Artists_Relationships: { + albums: components["schemas"]["Multi_Data_Relationship_Doc"]; + tracks: components["schemas"]["Multi_Data_Relationship_Doc"]; + videos: components["schemas"]["Multi_Data_Relationship_Doc"]; + similarArtists: components["schemas"]["Multi_Data_Relationship_Doc"]; + trackProviders: components["schemas"]["Artists_Track_Providers_Relationship"]; + radio: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + Artists_Resource: { + attributes?: components["schemas"]["Artists_Attributes"]; + relationships?: components["schemas"]["Artists_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description Providers that have released tracks for this artist */ + Artists_Track_Providers_Relationship: { + data?: components["schemas"]["Artists_Track_Providers_Resource_Identifier"][][]; + links?: components["schemas"]["Links"]; + }; + Artists_Track_Providers_Resource_Identifier: { + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + meta?: components["schemas"]["Artists_Track_Providers_Resource_Identifier_Meta"]; + }; + Artists_Track_Providers_Resource_Identifier_Meta: { + /** + * Format: int64 + * @description total number of tracks released together with the provider + * @example 14 + */ + numberOfTracks: number; + }; + Catalogue_Item_External_Link: { + /** + * @description link to something that is related to a resource + * @example https://tidal.com/browse/artist/1566 + */ + href: string; + meta: components["schemas"]["External_Link_Meta"]; + }; + Catalogue_Item_Image_Link: { + /** + * @description link to an image + * @example https://resources.tidal.com/images/717dfdae/beb0/4aea/a553/a70064c30386/80x80.jpg + */ + href: string; + meta: components["schemas"]["Image_Link_Meta"]; + }; + Catalogue_Item_Video_Link: { + /** + * @description link to a video + * @example https://resources.tidal.com/images/717dfdae/beb0/4aea/a553/a70064c30386/80x80.mp4 + */ + href: string; + meta: components["schemas"]["Video_Link_Meta"]; + }; + /** @description metadata about an external link */ + External_Link_Meta: { + /** + * @description external link type + * @example TIDAL_SHARING + * @enum {string} + */ + type: "TIDAL_SHARING" | "TIDAL_AUTOPLAY_ANDROID" | "TIDAL_AUTOPLAY_IOS" | "TIDAL_AUTOPLAY_WEB" | "TWITTER" | "FACEBOOK" | "INSTAGRAM" | "TIKTOK" | "SNAPCHAT" | "HOMEPAGE"; + }; + /** @description metadata about an image */ + Image_Link_Meta: { + /** + * Format: int32 + * @description image width (in pixels) + * @example 80 + */ + width: number; + /** + * Format: int32 + * @description image height (in pixels) + * @example 80 + */ + height: number; + }; + /** @description User profile public picks */ + Multi_Data_Relationship_Doc: { + /** @description array of relationship resource linkages */ + data?: components["schemas"]["Resource_Identifier"][]; + links?: components["schemas"]["Links"]; + }; + /** @description attributes object representing some of the resource's data */ + Playlists_Attributes: { + /** + * @description Playlist name + * @example My Playlist + */ + name: string; + /** + * @description Playlist description + * @example All the good details about what is inside this playlist + */ + description?: string; + /** + * @description Indicates if the playlist has a duration and set number of tracks + * @example true + */ + bounded: boolean; + /** + * @description Duration of the playlist expressed in accordance with ISO 8601 + * @example P30M5S + */ + duration?: string; + /** + * Format: int32 + * @description Number of items in the playlist + * @example 5 + */ + numberOfItems?: number; + /** + * @description Sharing links to the playlist + * @example true + */ + externalLinks: components["schemas"]["Playlists_External_Link"][]; + /** + * Format: date-time + * @description Datetime of playlist creation (ISO 8601) + */ + createdAt: string; + /** + * Format: date-time + * @description Datetime of last modification of the playlist (ISO 8601) + */ + lastModifiedAt: string; + /** + * @description Privacy setting of the playlist + * @example PUBLIC + */ + privacy: string; + /** + * @description The type of the playlist + * @example EDITORIAL + */ + playlistType: string; + /** + * @description Images associated with the playlist + * @example true + */ + imageLinks: components["schemas"]["Playlists_Image_Link"][]; + }; + /** + * @description Sharing links to the playlist + * @example true + */ + Playlists_External_Link: { + /** + * @description link to something that is related to a resource + * @example https://tidal.com/browse/artist/1566 + */ + href: string; + meta: components["schemas"]["External_Link_Meta"]; + }; + /** + * @description Images associated with the playlist + * @example true + */ + Playlists_Image_Link: { + /** + * @description link to an image + * @example https://resources.tidal.com/images/717dfdae/beb0/4aea/a553/a70064c30386/80x80.jpg + */ + href: string; + meta?: components["schemas"]["Image_Link_Meta"]; + }; + Playlists_Multi_Data_Document: { + /** @description array of primary resource data */ + data?: components["schemas"]["Playlists_Resource"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Tracks_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Users_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Providers_Resource"] | components["schemas"]["Playlists_Resource"] | components["schemas"]["User_Recommendations_Resource"] | components["schemas"]["User_Public_Profiles_Resource"] | components["schemas"]["User_Entitlements_Resource"])[]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Playlists_Relationships: { + items: components["schemas"]["Multi_Data_Relationship_Doc"]; + owners: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + Playlists_Resource: { + attributes?: components["schemas"]["Playlists_Attributes"]; + relationships?: components["schemas"]["Playlists_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description attributes object representing some of the resource's data */ + Providers_Attributes: { + /** + * @description Provider name. Conditionally visible. + * @example Columbia/Legacy + */ + name: string; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Providers_Relationships: Record; + Providers_Resource: { + attributes?: components["schemas"]["Providers_Attributes"]; + relationships?: components["schemas"]["Providers_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description relationship resource linkage */ + Resource_Identifier: { + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description User recommendations */ + Singleton_Data_Relationship_Doc: { + data?: components["schemas"]["Resource_Identifier"]; + links?: components["schemas"]["Links"]; + }; + /** @description attributes object representing some of the resource's data */ + Tracks_Attributes: { + /** + * @description Album item's title + * @example Kill Jay Z + */ + title: string; + /** + * @description Version of the album's item; complements title + * @example Kill Jay Z + */ + version?: string; + /** + * @description ISRC code + * @example TIDAL2274 + */ + isrc: string; + /** + * @description Duration expressed in accordance with ISO 8601 + * @example P30M5S + */ + duration: string; + /** + * @description Copyright information + * @example (p)(c) 2017 S. CARTER ENTERPRISES, LLC. MARKETED BY ROC NATION & DISTRIBUTED BY ROC NATION/UMG RECORDINGS INC. + */ + copyright?: string; + /** + * @description Indicates whether a catalog item consist of any explicit content + * @example false + */ + explicit: boolean; + /** + * Format: double + * @description Track or video popularity (ranged in 0.00 ... 1.00). Conditionally visible + * @example 0.56 + */ + popularity: number; + /** @description Defines a catalog item availability e.g. for streaming, DJs, stems */ + availability?: ("STREAM" | "DJ" | "STEM")[]; + mediaTags: string[]; + /** @description Represents available links to something that is related to a catalog item, but external to the TIDAL API */ + externalLinks?: components["schemas"]["Catalogue_Item_External_Link"][]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Tracks_Relationships: { + albums: components["schemas"]["Multi_Data_Relationship_Doc"]; + artists: components["schemas"]["Multi_Data_Relationship_Doc"]; + providers: components["schemas"]["Multi_Data_Relationship_Doc"]; + similarTracks: components["schemas"]["Multi_Data_Relationship_Doc"]; + radio: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + Tracks_Resource: { + attributes?: components["schemas"]["Tracks_Attributes"]; + relationships?: components["schemas"]["Tracks_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description attributes object representing some of the resource's data */ + User_Entitlements_Attributes: { + /** @description entitlements for user */ + entitlements: ("MUSIC" | "DJ")[]; + }; + User_Entitlements_Resource: { + attributes?: components["schemas"]["User_Entitlements_Attributes"]; + /** @description relationships object describing relationships between the resource and other resources */ + relationships?: Record; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description attributes object representing some of the resource's data */ + User_Public_Profiles_Attributes: { + /** + * @description Public Name of the user profile + * @example JohnSmith + */ + profileName?: string; + picture?: components["schemas"]["User_Public_Profiles_Image_Link"]; + color: string[]; + /** @description ExternalLinks for the user's profile */ + externalLinks?: components["schemas"]["User_Public_Profiles_External_Link"][]; + /** + * Format: int32 + * @description Number of followers for the user + * @example 32 + */ + numberOfFollowers?: number; + /** + * Format: int32 + * @description Number of users the user follows + * @example 32 + */ + numberOfFollows?: number; + }; + User_Public_Profiles_External_Link: { + /** + * @description link to something that is related to a resource + * @example https://tidal.com/browse/artist/1566 + */ + href: string; + meta: components["schemas"]["User_Public_Profiles_External_Link_Meta"]; + }; + /** @description metadata about an external link */ + User_Public_Profiles_External_Link_Meta: { + /** + * @description external link type + * @example TIDAL_SHARING + * @enum {string} + */ + type: "TIDAL_SHARING" | "TIDAL_AUTOPLAY_ANDROID" | "TIDAL_AUTOPLAY_IOS" | "TIDAL_AUTOPLAY_WEB" | "TWITTER" | "FACEBOOK" | "INSTAGRAM" | "TIKTOK" | "SNAPCHAT" | "HOMEPAGE"; + /** + * @description external link handle + * @example JohnSmith + */ + handle: string; + }; + /** @description ImageLink to the users image */ + User_Public_Profiles_Image_Link: { + /** + * @description link to an image + * @example https://resources.tidal.com/images/717dfdae/beb0/4aea/a553/a70064c30386/80x80.jpg + */ + href: string; + meta?: components["schemas"]["Image_Link_Meta"]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + User_Public_Profiles_Relationships: { + followers: components["schemas"]["Multi_Data_Relationship_Doc"]; + following: components["schemas"]["Multi_Data_Relationship_Doc"]; + publicPlaylists: components["schemas"]["Multi_Data_Relationship_Doc"]; + publicPicks: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + User_Public_Profiles_Resource: { + attributes?: components["schemas"]["User_Public_Profiles_Attributes"]; + relationships?: components["schemas"]["User_Public_Profiles_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description attributes object representing some of the resource's data */ + User_Recommendations_Attributes: Record; + /** @description relationships object describing relationships between the resource and other resources */ + User_Recommendations_Relationships: { + myMixes: components["schemas"]["Multi_Data_Relationship_Doc"]; + discoveryMixes: components["schemas"]["Multi_Data_Relationship_Doc"]; + newArrivalMixes: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + User_Recommendations_Resource: { + attributes?: components["schemas"]["User_Recommendations_Attributes"]; + relationships?: components["schemas"]["User_Recommendations_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description attributes object representing some of the resource's data */ + Users_Attributes: { + /** + * @description user name + * @example username + */ + username: string; + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + country: string; + /** + * @description email address + * @example test@test.com + */ + email?: string; + /** + * @description Is the email verified + * @example true + */ + emailVerified?: boolean; + /** + * @description Users first name + * @example John + */ + firstName?: string; + /** + * @description Users last name + * @example Rambo + */ + lastName?: string; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Users_Relationships: { + entitlements: components["schemas"]["Singleton_Data_Relationship_Doc"]; + publicProfile: components["schemas"]["Singleton_Data_Relationship_Doc"]; + recommendations: components["schemas"]["Singleton_Data_Relationship_Doc"]; + }; + Users_Resource: { + attributes?: components["schemas"]["Users_Attributes"]; + relationships?: components["schemas"]["Users_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description metadata about a video */ + Video_Link_Meta: { + /** + * Format: int32 + * @description video width (in pixels) + * @example 80 + */ + width: number; + /** + * Format: int32 + * @description video height (in pixels) + * @example 80 + */ + height: number; + }; + /** @description attributes object representing some of the resource's data */ + Videos_Attributes: { + /** + * @description Album item's title + * @example Kill Jay Z + */ + title: string; + /** + * @description Version of the album's item; complements title + * @example Kill Jay Z + */ + version?: string; + /** + * @description ISRC code + * @example TIDAL2274 + */ + isrc: string; + /** + * @description Duration expressed in accordance with ISO 8601 + * @example P30M5S + */ + duration: string; + /** + * @description Copyright information + * @example (p)(c) 2017 S. CARTER ENTERPRISES, LLC. MARKETED BY ROC NATION & DISTRIBUTED BY ROC NATION/UMG RECORDINGS INC. + */ + copyright?: string; + /** + * Format: date + * @description Release date (ISO-8601) + * @example 2017-06-27 + */ + releaseDate?: string; + /** + * @description Indicates whether a catalog item consist of any explicit content + * @example false + */ + explicit: boolean; + /** + * Format: double + * @description Track or video popularity (ranged in 0.00 ... 1.00). Conditionally visible + * @example 0.56 + */ + popularity: number; + /** @description Defines a catalog item availability e.g. for streaming, DJs, stems */ + availability?: ("STREAM" | "DJ" | "STEM")[]; + /** @description Represents available links to, and metadata about, an album item images */ + imageLinks?: components["schemas"]["Catalogue_Item_Image_Link"][]; + /** @description Represents available links to something that is related to a catalog item, but external to the TIDAL API */ + externalLinks?: components["schemas"]["Catalogue_Item_External_Link"][]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Videos_Relationships: { + albums: components["schemas"]["Multi_Data_Relationship_Doc"]; + artists: components["schemas"]["Multi_Data_Relationship_Doc"]; + providers: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + Videos_Resource: { + attributes?: components["schemas"]["Videos_Attributes"]; + relationships?: components["schemas"]["Videos_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + Playlists_Single_Data_Document: { + data?: components["schemas"]["Playlists_Resource"]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Tracks_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Users_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Providers_Resource"] | components["schemas"]["Playlists_Resource"] | components["schemas"]["User_Recommendations_Resource"] | components["schemas"]["User_Public_Profiles_Resource"] | components["schemas"]["User_Entitlements_Resource"])[]; + }; + Playlists_Owners_Relationship_Document: { + /** @description array of relationship resource linkages */ + data?: components["schemas"]["Resource_Identifier"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Users_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["User_Entitlements_Resource"] | components["schemas"]["User_Public_Profiles_Resource"] | components["schemas"]["User_Recommendations_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Tracks_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Playlists_Resource"] | components["schemas"]["Providers_Resource"])[]; + }; + Playlists_Items_Relationship_Document: { + /** @description array of relationship resource linkages */ + data?: components["schemas"]["Resource_Identifier"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Tracks_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Providers_Resource"] | components["schemas"]["Playlists_Resource"])[]; + }; + }; + responses: never; + parameters: never; + requestBodies: never; + headers: never; + pathItems: never; +} +export type $defs = Record; +export interface operations { + getPlaylistsByFilters: { + parameters: { + query: { + /** + * @description Country code (ISO 3166-1 alpha-2) + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: items, owners + * @example items + */ + include?: string[]; + /** + * @description public.usercontent.getPlaylists.ids.descr + * @example 123456 + */ + "filter[id]"?: string[]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Playlists retrieved successfully */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "*/*": components["schemas"]["Playlists_Multi_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getPlaylistById: { + parameters: { + query: { + /** + * @description Country code (ISO 3166-1 alpha-2) + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: items, owners + * @example items + */ + include?: string[]; + }; + header?: never; + path: { + /** + * @description TIDAL playlist id + * @example 12345678 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Playlist retrieved successfully */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Playlists_Single_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getPlaylistOwnersRelationship: { + parameters: { + query: { + /** + * @description Country code (ISO 3166-1 alpha-2) + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: owners + * @example owners + */ + include?: string[]; + }; + header?: never; + path: { + /** + * @description TIDAL playlist id + * @example 12345678 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Playlist owner retrieved successfully */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Playlists_Owners_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getPlaylistItemsRelationship: { + parameters: { + query: { + /** + * @description Country code (ISO 3166-1 alpha-2) + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: items + * @example items + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description TIDAL playlist id + * @example 12345678 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Playlist items retrieved successfully */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Playlists_Items_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getMyPlaylists: { + parameters: { + query?: { + /** + * @description Allows the client to customize which related resources should be returned. Available options: items, owners + * @example items + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Playlists retrieved successfully */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Playlists_Multi_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; +} diff --git a/packages/api/src/searchAPI.generated.ts b/packages/api/src/searchAPI.generated.ts new file mode 100644 index 00000000..0f5d7df7 --- /dev/null +++ b/packages/api/src/searchAPI.generated.ts @@ -0,0 +1,2506 @@ +/** + * This file was auto-generated by openapi-typescript. + * Do not make direct changes to the file. + */ + +export interface paths { + "/searchresults/{query}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Search for music metadata by a query + * @description Search for music: albums, artists, tracks, etc. + */ + get: operations["getSearchResultsByQuery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/searchresults/{query}/relationships/videos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: videos + * @description Search for videos by a query. + */ + get: operations["getSearchResultsVideosRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/searchresults/{query}/relationships/tracks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: tracks + * @description Search for tracks by a query. + */ + get: operations["getSearchResultsTracksRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/searchresults/{query}/relationships/topHits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: topHits + * @description Search for top hits by a query: artists, albums, tracks, videos. + */ + get: operations["getSearchResultsTopHitsRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/searchresults/{query}/relationships/playlists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: playlists + * @description Search for playlists by a query. + */ + get: operations["getSearchResultsPlaylistsRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/searchresults/{query}/relationships/artists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: artists + * @description Search for artists by a query. + */ + get: operations["getSearchResultsArtistsRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/searchresults/{query}/relationships/albums": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: albums + * @description Search for albums by a query. + */ + get: operations["getSearchResultsAlbumsRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; +} +export type webhooks = Record; +export interface components { + schemas: { + Error_Document: { + /** @description array of error objects */ + errors?: components["schemas"]["Error_Object"][]; + links?: components["schemas"]["Links"]; + }; + Error_Object: { + /** @description unique identifier for this particular occurrence of the problem */ + id?: string; + /** @description HTTP status code applicable to this problem */ + status?: string; + /** @description application-specific error code */ + code?: string; + /** @description human-readable explanation specific to this occurrence of the problem */ + detail?: string; + source?: components["schemas"]["Error_Object_Source"]; + }; + /** @description object containing references to the primary source of the error */ + Error_Object_Source: { + /** + * @description a JSON Pointer [RFC6901] to the value in the request document that caused the error + * @example /data/attributes/title + */ + pointer?: string; + /** + * @description string indicating which URI query parameter caused the error. + * @example countryCode + */ + parameter?: string; + /** + * @description string indicating the name of a single request header which caused the error + * @example X-some-custom-header + */ + header?: string; + }; + /** @description links object */ + Links: { + /** + * @description the link that generated the current response document + * @example /artists/xyz/relationships/tracks + */ + self: string; + /** + * @description the next page of data (pagination) + * @example /artists/xyz/relationships/tracks?page[cursor]=zyx + */ + next?: string; + }; + /** @description attributes object representing some of the resource's data */ + Albums_Attributes: { + /** + * @description Original title + * @example 4:44 + */ + title: string; + /** + * @description Barcode id (EAN-13 or UPC-A) + * @example 00854242007552 + */ + barcodeId: string; + /** + * Format: int32 + * @description Number of volumes + * @example 1 + */ + numberOfVolumes: number; + /** + * Format: int32 + * @description Number of album items + * @example 13 + */ + numberOfItems: number; + /** + * @description Duration (ISO-8601) + * @example P41M5S + */ + duration: string; + /** + * @description Indicates whether an album consist of any explicit content + * @example true + */ + explicit: boolean; + /** + * Format: date + * @description Release date (ISO-8601) + * @example 2017-06-30 + */ + releaseDate?: string; + /** + * @description Copyright information + * @example (p)(c) 2017 S. CARTER ENTERPRISES, LLC. MARKETED BY ROC NATION & DISTRIBUTED BY ROC NATION/UMG RECORDINGS INC. + */ + copyright?: string; + /** + * Format: double + * @description Album popularity (ranged in 0.00 ... 1.00). Conditionally visible + * @example 0.56 + */ + popularity: number; + /** @description Defines an album availability e.g. for streaming, DJs, stems */ + availability?: ("STREAM" | "DJ" | "STEM")[]; + mediaTags: string[]; + /** @description Represents available links to, and metadata about, an album cover images */ + imageLinks?: components["schemas"]["Catalogue_Item_Image_Link"][]; + /** @description Represents available links to, and metadata about, an album cover videos */ + videoLinks?: components["schemas"]["Catalogue_Item_Video_Link"][]; + /** @description Represents available links to something that is related to an album resource, but external to the TIDAL API */ + externalLinks?: components["schemas"]["Catalogue_Item_External_Link"][]; + }; + Albums_Item_Resource_Identifier: { + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + meta?: components["schemas"]["Albums_Item_Resource_Identifier_Meta"]; + }; + Albums_Item_Resource_Identifier_Meta: { + /** + * Format: int32 + * @description volume number + * @example 1 + */ + volumeNumber: number; + /** + * Format: int32 + * @description track number + * @example 4 + */ + trackNumber: number; + }; + /** @description Album items (tracks/videos) relationship */ + Albums_Items_Relationship: { + data?: components["schemas"]["Albums_Item_Resource_Identifier"][][]; + links?: components["schemas"]["Links"]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Albums_Relationships: { + artists: components["schemas"]["Multi_Data_Relationship_Doc"]; + items: components["schemas"]["Albums_Items_Relationship"]; + similarAlbums: components["schemas"]["Multi_Data_Relationship_Doc"]; + providers: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + Albums_Resource: { + attributes?: components["schemas"]["Albums_Attributes"]; + relationships?: components["schemas"]["Albums_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description attributes object representing some of the resource's data */ + Artists_Attributes: { + /** + * @description Artist name + * @example JAY Z + */ + name: string; + /** + * Format: double + * @description Artist popularity (ranged in 0.00 ... 1.00). Conditionally visible + * @example 0.56 + */ + popularity: number; + /** @description Represents available links to, and metadata about, an artist images */ + imageLinks?: components["schemas"]["Catalogue_Item_Image_Link"][]; + /** @description Represents available links to something that is related to an artist resource, but external to the TIDAL API */ + externalLinks?: components["schemas"]["Catalogue_Item_External_Link"][]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Artists_Relationships: { + albums: components["schemas"]["Multi_Data_Relationship_Doc"]; + tracks: components["schemas"]["Multi_Data_Relationship_Doc"]; + videos: components["schemas"]["Multi_Data_Relationship_Doc"]; + similarArtists: components["schemas"]["Multi_Data_Relationship_Doc"]; + trackProviders: components["schemas"]["Artists_Track_Providers_Relationship"]; + radio: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + Artists_Resource: { + attributes?: components["schemas"]["Artists_Attributes"]; + relationships?: components["schemas"]["Artists_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description Providers that have released tracks for this artist */ + Artists_Track_Providers_Relationship: { + data?: components["schemas"]["Artists_Track_Providers_Resource_Identifier"][][]; + links?: components["schemas"]["Links"]; + }; + Artists_Track_Providers_Resource_Identifier: { + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + meta?: components["schemas"]["Artists_Track_Providers_Resource_Identifier_Meta"]; + }; + Artists_Track_Providers_Resource_Identifier_Meta: { + /** + * Format: int64 + * @description total number of tracks released together with the provider + * @example 14 + */ + numberOfTracks: number; + }; + Catalogue_Item_External_Link: { + /** + * @description link to something that is related to a resource + * @example https://tidal.com/browse/artist/1566 + */ + href: string; + meta: components["schemas"]["External_Link_Meta"]; + }; + Catalogue_Item_Image_Link: { + /** + * @description link to an image + * @example https://resources.tidal.com/images/717dfdae/beb0/4aea/a553/a70064c30386/80x80.jpg + */ + href: string; + meta: components["schemas"]["Image_Link_Meta"]; + }; + Catalogue_Item_Video_Link: { + /** + * @description link to a video + * @example https://resources.tidal.com/images/717dfdae/beb0/4aea/a553/a70064c30386/80x80.mp4 + */ + href: string; + meta: components["schemas"]["Video_Link_Meta"]; + }; + /** @description metadata about an external link */ + External_Link_Meta: { + /** + * @description external link type + * @example TIDAL_SHARING + * @enum {string} + */ + type: "TIDAL_SHARING" | "TIDAL_AUTOPLAY_ANDROID" | "TIDAL_AUTOPLAY_IOS" | "TIDAL_AUTOPLAY_WEB" | "TWITTER" | "FACEBOOK" | "INSTAGRAM" | "TIKTOK" | "SNAPCHAT" | "HOMEPAGE"; + }; + /** @description metadata about an image */ + Image_Link_Meta: { + /** + * Format: int32 + * @description image width (in pixels) + * @example 80 + */ + width: number; + /** + * Format: int32 + * @description image height (in pixels) + * @example 80 + */ + height: number; + }; + /** @description Playlist owners relationship */ + Multi_Data_Relationship_Doc: { + /** @description array of relationship resource linkages */ + data?: components["schemas"]["Resource_Identifier"][]; + links?: components["schemas"]["Links"]; + }; + /** @description attributes object representing some of the resource's data */ + Playlists_Attributes: { + /** + * @description Playlist name + * @example My Playlist + */ + name: string; + /** + * @description Playlist description + * @example All the good details about what is inside this playlist + */ + description?: string; + /** + * @description Indicates if the playlist has a duration and set number of tracks + * @example true + */ + bounded: boolean; + /** + * @description Duration of the playlist expressed in accordance with ISO 8601 + * @example P30M5S + */ + duration?: string; + /** + * Format: int32 + * @description Number of items in the playlist + * @example 5 + */ + numberOfItems?: number; + /** + * @description Sharing links to the playlist + * @example true + */ + externalLinks: components["schemas"]["Playlists_External_Link"][]; + /** + * Format: date-time + * @description Datetime of playlist creation (ISO 8601) + */ + createdAt: string; + /** + * Format: date-time + * @description Datetime of last modification of the playlist (ISO 8601) + */ + lastModifiedAt: string; + /** + * @description Privacy setting of the playlist + * @example PUBLIC + */ + privacy: string; + /** + * @description The type of the playlist + * @example EDITORIAL + */ + playlistType: string; + /** + * @description Images associated with the playlist + * @example true + */ + imageLinks: components["schemas"]["Playlists_Image_Link"][]; + }; + /** + * @description Sharing links to the playlist + * @example true + */ + Playlists_External_Link: { + /** + * @description link to something that is related to a resource + * @example https://tidal.com/browse/artist/1566 + */ + href: string; + meta: components["schemas"]["External_Link_Meta"]; + }; + /** + * @description Images associated with the playlist + * @example true + */ + Playlists_Image_Link: { + /** + * @description link to an image + * @example https://resources.tidal.com/images/717dfdae/beb0/4aea/a553/a70064c30386/80x80.jpg + */ + href: string; + meta?: components["schemas"]["Image_Link_Meta"]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Playlists_Relationships: { + items: components["schemas"]["Multi_Data_Relationship_Doc"]; + owners: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + Playlists_Resource: { + attributes?: components["schemas"]["Playlists_Attributes"]; + relationships?: components["schemas"]["Playlists_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description attributes object representing some of the resource's data */ + Providers_Attributes: { + /** + * @description Provider name. Conditionally visible. + * @example Columbia/Legacy + */ + name: string; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Providers_Relationships: Record; + Providers_Resource: { + attributes?: components["schemas"]["Providers_Attributes"]; + relationships?: components["schemas"]["Providers_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description relationship resource linkage */ + Resource_Identifier: { + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description attributes object representing some of the resource's data */ + Search_Results_Attributes: { + /** + * @description search request unique tracking number + * @example 5896e37d-e847-4ca6-9629-ef8001719f7f + */ + trackingId: string; + /** + * @description 'did you mean' prompt + * @example beatles + */ + didYouMean?: string; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Search_Results_Relationships: { + albums: components["schemas"]["Multi_Data_Relationship_Doc"]; + artists: components["schemas"]["Multi_Data_Relationship_Doc"]; + tracks: components["schemas"]["Multi_Data_Relationship_Doc"]; + videos: components["schemas"]["Multi_Data_Relationship_Doc"]; + playlists: components["schemas"]["Multi_Data_Relationship_Doc"]; + topHits: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + /** @description primary resource data */ + Search_Results_Resource: { + attributes?: components["schemas"]["Search_Results_Attributes"]; + relationships?: components["schemas"]["Search_Results_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + Search_Results_Single_Data_Document: { + data?: components["schemas"]["Search_Results_Resource"]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Tracks_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Playlists_Resource"] | components["schemas"]["Providers_Resource"] | components["schemas"]["Users_Resource"])[]; + }; + /** @description User recommendations */ + Singleton_Data_Relationship_Doc: { + data?: components["schemas"]["Resource_Identifier"]; + links?: components["schemas"]["Links"]; + }; + /** @description attributes object representing some of the resource's data */ + Tracks_Attributes: { + /** + * @description Album item's title + * @example Kill Jay Z + */ + title: string; + /** + * @description Version of the album's item; complements title + * @example Kill Jay Z + */ + version?: string; + /** + * @description ISRC code + * @example TIDAL2274 + */ + isrc: string; + /** + * @description Duration expressed in accordance with ISO 8601 + * @example P30M5S + */ + duration: string; + /** + * @description Copyright information + * @example (p)(c) 2017 S. CARTER ENTERPRISES, LLC. MARKETED BY ROC NATION & DISTRIBUTED BY ROC NATION/UMG RECORDINGS INC. + */ + copyright?: string; + /** + * @description Indicates whether a catalog item consist of any explicit content + * @example false + */ + explicit: boolean; + /** + * Format: double + * @description Track or video popularity (ranged in 0.00 ... 1.00). Conditionally visible + * @example 0.56 + */ + popularity: number; + /** @description Defines a catalog item availability e.g. for streaming, DJs, stems */ + availability?: ("STREAM" | "DJ" | "STEM")[]; + mediaTags: string[]; + /** @description Represents available links to something that is related to a catalog item, but external to the TIDAL API */ + externalLinks?: components["schemas"]["Catalogue_Item_External_Link"][]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Tracks_Relationships: { + albums: components["schemas"]["Multi_Data_Relationship_Doc"]; + artists: components["schemas"]["Multi_Data_Relationship_Doc"]; + providers: components["schemas"]["Multi_Data_Relationship_Doc"]; + similarTracks: components["schemas"]["Multi_Data_Relationship_Doc"]; + radio: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + Tracks_Resource: { + attributes?: components["schemas"]["Tracks_Attributes"]; + relationships?: components["schemas"]["Tracks_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description attributes object representing some of the resource's data */ + Users_Attributes: { + /** + * @description user name + * @example username + */ + username: string; + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + country: string; + /** + * @description email address + * @example test@test.com + */ + email?: string; + /** + * @description Is the email verified + * @example true + */ + emailVerified?: boolean; + /** + * @description Users first name + * @example John + */ + firstName?: string; + /** + * @description Users last name + * @example Rambo + */ + lastName?: string; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Users_Relationships: { + entitlements: components["schemas"]["Singleton_Data_Relationship_Doc"]; + publicProfile: components["schemas"]["Singleton_Data_Relationship_Doc"]; + recommendations: components["schemas"]["Singleton_Data_Relationship_Doc"]; + }; + Users_Resource: { + attributes?: components["schemas"]["Users_Attributes"]; + relationships?: components["schemas"]["Users_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description metadata about a video */ + Video_Link_Meta: { + /** + * Format: int32 + * @description video width (in pixels) + * @example 80 + */ + width: number; + /** + * Format: int32 + * @description video height (in pixels) + * @example 80 + */ + height: number; + }; + /** @description attributes object representing some of the resource's data */ + Videos_Attributes: { + /** + * @description Album item's title + * @example Kill Jay Z + */ + title: string; + /** + * @description Version of the album's item; complements title + * @example Kill Jay Z + */ + version?: string; + /** + * @description ISRC code + * @example TIDAL2274 + */ + isrc: string; + /** + * @description Duration expressed in accordance with ISO 8601 + * @example P30M5S + */ + duration: string; + /** + * @description Copyright information + * @example (p)(c) 2017 S. CARTER ENTERPRISES, LLC. MARKETED BY ROC NATION & DISTRIBUTED BY ROC NATION/UMG RECORDINGS INC. + */ + copyright?: string; + /** + * Format: date + * @description Release date (ISO-8601) + * @example 2017-06-27 + */ + releaseDate?: string; + /** + * @description Indicates whether a catalog item consist of any explicit content + * @example false + */ + explicit: boolean; + /** + * Format: double + * @description Track or video popularity (ranged in 0.00 ... 1.00). Conditionally visible + * @example 0.56 + */ + popularity: number; + /** @description Defines a catalog item availability e.g. for streaming, DJs, stems */ + availability?: ("STREAM" | "DJ" | "STEM")[]; + /** @description Represents available links to, and metadata about, an album item images */ + imageLinks?: components["schemas"]["Catalogue_Item_Image_Link"][]; + /** @description Represents available links to something that is related to a catalog item, but external to the TIDAL API */ + externalLinks?: components["schemas"]["Catalogue_Item_External_Link"][]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Videos_Relationships: { + albums: components["schemas"]["Multi_Data_Relationship_Doc"]; + artists: components["schemas"]["Multi_Data_Relationship_Doc"]; + providers: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + Videos_Resource: { + attributes?: components["schemas"]["Videos_Attributes"]; + relationships?: components["schemas"]["Videos_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + Videos_Relationships_Document: { + /** @description array of relationship resource linkages */ + data?: components["schemas"]["Resource_Identifier"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Videos_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Providers_Resource"])[]; + }; + Tracks_Relationships_Document: { + /** @description array of relationship resource linkages */ + data?: components["schemas"]["Resource_Identifier"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Tracks_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Providers_Resource"] | components["schemas"]["Playlists_Resource"])[]; + }; + Search_Results_Top_Hits_Relationship_Document: { + /** @description array of relationship resource linkages */ + data?: components["schemas"]["Resource_Identifier"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Tracks_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Playlists_Resource"] | components["schemas"]["Users_Resource"])[]; + }; + Playlists_Relationship_Document: { + /** @description array of relationship resource linkages */ + data?: components["schemas"]["Resource_Identifier"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Playlists_Resource"] | components["schemas"]["Tracks_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Users_Resource"])[]; + }; + Artists_Relationship_Document: { + /** @description array of relationship resource linkages */ + data?: components["schemas"]["Resource_Identifier"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Tracks_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Providers_Resource"] | components["schemas"]["Playlists_Resource"])[]; + }; + Albums_Relationship_Document: { + /** @description array of relationship resource linkages */ + data?: components["schemas"]["Resource_Identifier"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Albums_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Providers_Resource"] | components["schemas"]["Tracks_Resource"] | components["schemas"]["Videos_Resource"])[]; + }; + }; + responses: never; + parameters: never; + requestBodies: never; + headers: never; + pathItems: never; +} +export type $defs = Record; +export interface operations { + getSearchResultsByQuery: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: artists, albums, tracks, videos, playlists, topHits + * @example artists + */ + include?: string[]; + }; + header?: never; + path: { + /** + * @description Search query + * @example moon + */ + query: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Search_Results_Single_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getSearchResultsVideosRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: videos + * @example videos + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description Search query + * @example moon + */ + query: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Videos_Relationships_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getSearchResultsTracksRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: tracks + * @example tracks + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description Search query + * @example moon + */ + query: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Tracks_Relationships_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getSearchResultsTopHitsRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: topHits + * @example topHits + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description Search query + * @example moon + */ + query: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Search_Results_Top_Hits_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getSearchResultsPlaylistsRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: playlists + * @example playlists + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description Searh query + * @example moon + */ + query: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Playlists_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getSearchResultsArtistsRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: artists + * @example artists + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description Search query + * @example moon + */ + query: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Artists_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getSearchResultsAlbumsRelationship: { + parameters: { + query: { + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + countryCode: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: albums + * @example albums + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description Search query + * @example moon + */ + query: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Albums_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; +} diff --git a/packages/api/src/userAPI.generated.ts b/packages/api/src/userAPI.generated.ts new file mode 100644 index 00000000..155d0373 --- /dev/null +++ b/packages/api/src/userAPI.generated.ts @@ -0,0 +1,7319 @@ +/** + * This file was auto-generated by openapi-typescript. + * Do not make direct changes to the file. + */ + +export interface paths { + "/userPublicProfilePicks/{id}/relationships/item": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: item (read) + * @description Retrieves a picks item relationship + */ + get: operations["getUserPublicProfilePickItemRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Relationship: item (update) + * @description Updates a picks item relationship, e.g. sets a 'track', 'album' or 'artist' reference. + */ + patch: operations["setUserPublicProfilePickItemRelationship"]; + trace?: never; + }; + "/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get multiple users by id + * @description Get multiple users by id + */ + get: operations["getUsersByFilters"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a single user by id + * @description Get a single user by id + */ + get: operations["getUserById"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{id}/relationships/recommendations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: user recommendations + * @description Get user recommendations + */ + get: operations["getUserRecommendationsRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{id}/relationships/publicProfile": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: public profile + * @description Get user public profile + */ + get: operations["getUserPublicProfileRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{id}/relationships/entitlements": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: entitlements + * @description Get user entitlements relationship + */ + get: operations["getUserEntitlementsRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/me": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get the current user + * @description Get the current user + */ + get: operations["getMyUser"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/userRecommendations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get recommendations for users in batch + * @description Get recommendations for users in batch + */ + get: operations["getUserRecommendationsByFilters"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/userRecommendations/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get user recommendations for user + * @description Get user recommendations for user + */ + get: operations["getUserRecommendationsById"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/userRecommendations/{id}/relationships/newArrivalMixes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: new arrivals mixes + * @description Get new arrival mixes relationship + */ + get: operations["getUserRecommendationsNewArrivalMixesRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/userRecommendations/{id}/relationships/myMixes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: my mixes + * @description Get my mixes relationship + */ + get: operations["getUserRecommendationsMyMixesRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/userRecommendations/{id}/relationships/discoveryMixes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: discovery mixes + * @description Get discovery mixes relationship + */ + get: operations["getUserRecommendationsDiscoveryMixesRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/userRecommendations/me": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get the current users recommendations + * @description Get the current users recommendations + */ + get: operations["getMyUserRecommendations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/userPublicProfiles": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get user public profiles + * @description Reads user public profile details by TIDAL user ids. + */ + get: operations["getUserPublicProfilesByFilters"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/userPublicProfiles/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get user public profile by id + * @description Retrieve user public profile details by TIDAL user id. + */ + get: operations["getUserPublicProfileById"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/userPublicProfiles/{id}/relationships/publicPlaylists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: playlists + * @description Retrieves user's public playlists. + */ + get: operations["getUserPublicProfilePublicPlaylistsRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/userPublicProfiles/{id}/relationships/publicPicks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: picks + * @description Retrieve user's public picks. + */ + get: operations["getUserPublicProfilePublicPicksRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/userPublicProfiles/{id}/relationships/following": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: following + * @description Retrieve user's public followings + */ + get: operations["getUserPublicProfileFollowingRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/userPublicProfiles/{id}/relationships/followers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: followers + * @description Retrieve user's public followers + */ + get: operations["getUserPublicProfileFollowersRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/userPublicProfiles/me": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get my user profile + * @description Retrieve the logged-in user's public profile details. + */ + get: operations["getMyUserPublicProfile"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/userPublicProfilePicks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get picks + * @description Retrieves a filtered collection of user's public picks. + */ + get: operations["getUserPublicProfilePicksByFilters"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/userPublicProfilePicks/{id}/relationships/userPublicProfile": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Relationship: user public profile + * @description Retrieves a picks owner public profile + */ + get: operations["getUserPublicProfilePickUserPublicProfileRelationship"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/userPublicProfilePicks/me": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get my picks + * @description Retrieves picks for the logged-in user. + */ + get: operations["getMyUserPublicProfilePicks"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/userEntitlements/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get user entitlements for user + * @description Get user entitlements for user + */ + get: operations["getUserEntitlementsById"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/userEntitlements/me": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get the current users entitlements + * @description Get the current users entitlements + */ + get: operations["getMyUserEntitlements"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; +} +export type webhooks = Record; +export interface components { + schemas: { + Error_Document: { + /** @description array of error objects */ + errors?: components["schemas"]["Error_Object"][]; + links?: components["schemas"]["Links"]; + }; + Error_Object: { + /** @description unique identifier for this particular occurrence of the problem */ + id?: string; + /** @description HTTP status code applicable to this problem */ + status?: string; + /** @description application-specific error code */ + code?: string; + /** @description human-readable explanation specific to this occurrence of the problem */ + detail?: string; + source?: components["schemas"]["Error_Object_Source"]; + }; + /** @description object containing references to the primary source of the error */ + Error_Object_Source: { + /** + * @description a JSON Pointer [RFC6901] to the value in the request document that caused the error + * @example /data/attributes/title + */ + pointer?: string; + /** + * @description string indicating which URI query parameter caused the error. + * @example countryCode + */ + parameter?: string; + /** + * @description string indicating the name of a single request header which caused the error + * @example X-some-custom-header + */ + header?: string; + }; + /** @description links object */ + Links: { + /** + * @description the link that generated the current response document + * @example /artists/xyz/relationships/tracks + */ + self: string; + /** + * @description the next page of data (pagination) + * @example /artists/xyz/relationships/tracks?page[cursor]=zyx + */ + next?: string; + }; + Resource_Identifier: { + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + Update_User_Public_Profile_Picks_Relationship_Document: { + data?: components["schemas"]["Resource_Identifier"]; + }; + /** @description metadata about an external link */ + External_Link_Meta: { + /** + * @description external link type + * @example TIDAL_SHARING + * @enum {string} + */ + type: "TIDAL_SHARING" | "TIDAL_AUTOPLAY_ANDROID" | "TIDAL_AUTOPLAY_IOS" | "TIDAL_AUTOPLAY_WEB" | "TWITTER" | "FACEBOOK" | "INSTAGRAM" | "TIKTOK" | "SNAPCHAT" | "HOMEPAGE"; + }; + /** @description metadata about an image */ + Image_Link_Meta: { + /** + * Format: int32 + * @description image width (in pixels) + * @example 80 + */ + width: number; + /** + * Format: int32 + * @description image height (in pixels) + * @example 80 + */ + height: number; + }; + /** @description Playlist owners relationship */ + Multi_Data_Relationship_Doc: { + /** @description array of relationship resource linkages */ + data?: components["schemas"]["Resource_Identifier"][]; + links?: components["schemas"]["Links"]; + }; + /** @description attributes object representing some of the resource's data */ + Playlists_Attributes: { + /** + * @description Playlist name + * @example My Playlist + */ + name: string; + /** + * @description Playlist description + * @example All the good details about what is inside this playlist + */ + description?: string; + /** + * @description Indicates if the playlist has a duration and set number of tracks + * @example true + */ + bounded: boolean; + /** + * @description Duration of the playlist expressed in accordance with ISO 8601 + * @example P30M5S + */ + duration?: string; + /** + * Format: int32 + * @description Number of items in the playlist + * @example 5 + */ + numberOfItems?: number; + /** + * @description Sharing links to the playlist + * @example true + */ + externalLinks: components["schemas"]["Playlists_External_Link"][]; + /** + * Format: date-time + * @description Datetime of playlist creation (ISO 8601) + */ + createdAt: string; + /** + * Format: date-time + * @description Datetime of last modification of the playlist (ISO 8601) + */ + lastModifiedAt: string; + /** + * @description Privacy setting of the playlist + * @example PUBLIC + */ + privacy: string; + /** + * @description The type of the playlist + * @example EDITORIAL + */ + playlistType: string; + /** + * @description Images associated with the playlist + * @example true + */ + imageLinks: components["schemas"]["Playlists_Image_Link"][]; + }; + /** + * @description Sharing links to the playlist + * @example true + */ + Playlists_External_Link: { + /** + * @description link to something that is related to a resource + * @example https://tidal.com/browse/artist/1566 + */ + href: string; + meta: components["schemas"]["External_Link_Meta"]; + }; + /** + * @description Images associated with the playlist + * @example true + */ + Playlists_Image_Link: { + /** + * @description link to an image + * @example https://resources.tidal.com/images/717dfdae/beb0/4aea/a553/a70064c30386/80x80.jpg + */ + href: string; + meta?: components["schemas"]["Image_Link_Meta"]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Playlists_Relationships: { + items: components["schemas"]["Multi_Data_Relationship_Doc"]; + owners: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + Playlists_Resource: { + attributes?: components["schemas"]["Playlists_Attributes"]; + relationships?: components["schemas"]["Playlists_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description Primary and Secondary color to visually render the pick */ + Prompt_Colors: { + /** + * @description Primary color to visually render the pick + * @example #FF0000 + */ + primary: string; + /** + * @description Secondary color to visually render the pick + * @example #00FF00 + */ + secondary: string; + }; + /** @description Pick's owning user public profile relationship */ + Singleton_Data_Relationship_Doc: { + data?: components["schemas"]["Resource_Identifier"]; + links?: components["schemas"]["Links"]; + }; + /** @description attributes object representing some of the resource's data */ + User_Entitlements_Attributes: { + /** @description entitlements for user */ + entitlements: ("MUSIC" | "DJ")[]; + }; + User_Entitlements_Resource: { + attributes?: components["schemas"]["User_Entitlements_Attributes"]; + /** @description relationships object describing relationships between the resource and other resources */ + relationships?: Record; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description attributes object representing some of the resource's data */ + User_Public_Profile_Picks_Attributes: { + /** + * @description Pick title + * @example My favorite track on repeat + */ + title: string; + /** + * @description Description of pick + * @example This is the track I listen to when I need to focus + */ + description: string; + /** + * @description CatalogueResourceType for supported item for the pick + * @example TRACK + * @enum {string} + */ + supportedContentType: "TRACKS" | "VIDEOS" | "ALBUMS" | "ARTISTS" | "PROVIDERS"; + colors: components["schemas"]["Prompt_Colors"]; + /** + * Format: date-time + * @description Date of last modification of the pick (ISO 8601) + * @example 2021-08-31T12:00:00Z + */ + lastModifiedAt?: string; + }; + /** @description relationships object describing relationships between the resource and other resources */ + User_Public_Profile_Picks_Relationships: { + item: components["schemas"]["Singleton_Data_Relationship_Doc"]; + userPublicProfile: components["schemas"]["Singleton_Data_Relationship_Doc"]; + }; + User_Public_Profile_Picks_Resource: { + attributes?: components["schemas"]["User_Public_Profile_Picks_Attributes"]; + relationships?: components["schemas"]["User_Public_Profile_Picks_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description attributes object representing some of the resource's data */ + User_Public_Profiles_Attributes: { + /** + * @description Public Name of the user profile + * @example JohnSmith + */ + profileName?: string; + picture?: components["schemas"]["User_Public_Profiles_Image_Link"]; + color: string[]; + /** @description ExternalLinks for the user's profile */ + externalLinks?: components["schemas"]["User_Public_Profiles_External_Link"][]; + /** + * Format: int32 + * @description Number of followers for the user + * @example 32 + */ + numberOfFollowers?: number; + /** + * Format: int32 + * @description Number of users the user follows + * @example 32 + */ + numberOfFollows?: number; + }; + User_Public_Profiles_External_Link: { + /** + * @description link to something that is related to a resource + * @example https://tidal.com/browse/artist/1566 + */ + href: string; + meta: components["schemas"]["User_Public_Profiles_External_Link_Meta"]; + }; + /** @description metadata about an external link */ + User_Public_Profiles_External_Link_Meta: { + /** + * @description external link type + * @example TIDAL_SHARING + * @enum {string} + */ + type: "TIDAL_SHARING" | "TIDAL_AUTOPLAY_ANDROID" | "TIDAL_AUTOPLAY_IOS" | "TIDAL_AUTOPLAY_WEB" | "TWITTER" | "FACEBOOK" | "INSTAGRAM" | "TIKTOK" | "SNAPCHAT" | "HOMEPAGE"; + /** + * @description external link handle + * @example JohnSmith + */ + handle: string; + }; + /** @description ImageLink to the users image */ + User_Public_Profiles_Image_Link: { + /** + * @description link to an image + * @example https://resources.tidal.com/images/717dfdae/beb0/4aea/a553/a70064c30386/80x80.jpg + */ + href: string; + meta?: components["schemas"]["Image_Link_Meta"]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + User_Public_Profiles_Relationships: { + followers: components["schemas"]["Multi_Data_Relationship_Doc"]; + following: components["schemas"]["Multi_Data_Relationship_Doc"]; + publicPlaylists: components["schemas"]["Multi_Data_Relationship_Doc"]; + publicPicks: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + User_Public_Profiles_Resource: { + attributes?: components["schemas"]["User_Public_Profiles_Attributes"]; + relationships?: components["schemas"]["User_Public_Profiles_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description attributes object representing some of the resource's data */ + User_Recommendations_Attributes: Record; + /** @description relationships object describing relationships between the resource and other resources */ + User_Recommendations_Relationships: { + myMixes: components["schemas"]["Multi_Data_Relationship_Doc"]; + discoveryMixes: components["schemas"]["Multi_Data_Relationship_Doc"]; + newArrivalMixes: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + User_Recommendations_Resource: { + attributes?: components["schemas"]["User_Recommendations_Attributes"]; + relationships?: components["schemas"]["User_Recommendations_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description attributes object representing some of the resource's data */ + Users_Attributes: { + /** + * @description user name + * @example username + */ + username: string; + /** + * @description ISO 3166-1 alpha-2 country code + * @example US + */ + country: string; + /** + * @description email address + * @example test@test.com + */ + email?: string; + /** + * @description Is the email verified + * @example true + */ + emailVerified?: boolean; + /** + * @description Users first name + * @example John + */ + firstName?: string; + /** + * @description Users last name + * @example Rambo + */ + lastName?: string; + }; + Users_Multi_Data_Document: { + /** @description array of primary resource data */ + data?: components["schemas"]["Users_Resource"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["User_Entitlements_Resource"] | components["schemas"]["User_Public_Profiles_Resource"] | components["schemas"]["User_Recommendations_Resource"] | components["schemas"]["Playlists_Resource"] | components["schemas"]["User_Public_Profile_Picks_Resource"] | components["schemas"]["Users_Resource"])[]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Users_Relationships: { + entitlements: components["schemas"]["Singleton_Data_Relationship_Doc"]; + publicProfile: components["schemas"]["Singleton_Data_Relationship_Doc"]; + recommendations: components["schemas"]["Singleton_Data_Relationship_Doc"]; + }; + Users_Resource: { + attributes?: components["schemas"]["Users_Attributes"]; + relationships?: components["schemas"]["Users_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + Users_Single_Data_Document: { + data?: components["schemas"]["Users_Resource"]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["User_Entitlements_Resource"] | components["schemas"]["User_Public_Profiles_Resource"] | components["schemas"]["User_Recommendations_Resource"] | components["schemas"]["Playlists_Resource"] | components["schemas"]["User_Public_Profile_Picks_Resource"] | components["schemas"]["Users_Resource"])[]; + }; + Users_Recommendations_Relationship_Document: { + data?: components["schemas"]["Resource_Identifier"]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["User_Recommendations_Resource"] | components["schemas"]["Playlists_Resource"])[]; + }; + User_Public_Profiles_Relationship_Document: { + data?: components["schemas"]["Resource_Identifier"]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["User_Public_Profiles_Resource"] | components["schemas"]["Users_Resource"] | components["schemas"]["Playlists_Resource"] | components["schemas"]["User_Public_Profile_Picks_Resource"])[]; + }; + User_Entitlements_Relationship_Document: { + data?: components["schemas"]["Resource_Identifier"]; + links?: components["schemas"]["Links"]; + included?: components["schemas"]["User_Entitlements_Resource"][]; + }; + Catalogue_Item_External_Link: { + /** + * @description link to something that is related to a resource + * @example https://tidal.com/browse/artist/1566 + */ + href: string; + meta: components["schemas"]["External_Link_Meta"]; + }; + Catalogue_Item_Image_Link: { + /** + * @description link to an image + * @example https://resources.tidal.com/images/717dfdae/beb0/4aea/a553/a70064c30386/80x80.jpg + */ + href: string; + meta: components["schemas"]["Image_Link_Meta"]; + }; + /** @description attributes object representing some of the resource's data */ + Tracks_Attributes: { + /** + * @description Album item's title + * @example Kill Jay Z + */ + title: string; + /** + * @description Version of the album's item; complements title + * @example Kill Jay Z + */ + version?: string; + /** + * @description ISRC code + * @example TIDAL2274 + */ + isrc: string; + /** + * @description Duration expressed in accordance with ISO 8601 + * @example P30M5S + */ + duration: string; + /** + * @description Copyright information + * @example (p)(c) 2017 S. CARTER ENTERPRISES, LLC. MARKETED BY ROC NATION & DISTRIBUTED BY ROC NATION/UMG RECORDINGS INC. + */ + copyright?: string; + /** + * @description Indicates whether a catalog item consist of any explicit content + * @example false + */ + explicit: boolean; + /** + * Format: double + * @description Track or video popularity (ranged in 0.00 ... 1.00). Conditionally visible + * @example 0.56 + */ + popularity: number; + /** @description Defines a catalog item availability e.g. for streaming, DJs, stems */ + availability?: ("STREAM" | "DJ" | "STEM")[]; + mediaTags: string[]; + /** @description Represents available links to something that is related to a catalog item, but external to the TIDAL API */ + externalLinks?: components["schemas"]["Catalogue_Item_External_Link"][]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Tracks_Relationships: { + albums: components["schemas"]["Multi_Data_Relationship_Doc"]; + artists: components["schemas"]["Multi_Data_Relationship_Doc"]; + providers: components["schemas"]["Multi_Data_Relationship_Doc"]; + similarTracks: components["schemas"]["Multi_Data_Relationship_Doc"]; + radio: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + Tracks_Resource: { + attributes?: components["schemas"]["Tracks_Attributes"]; + relationships?: components["schemas"]["Tracks_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + User_Recommendations_Multi_Data_Document: { + /** @description array of primary resource data */ + data?: components["schemas"]["User_Recommendations_Resource"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Playlists_Resource"] | components["schemas"]["Tracks_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Users_Resource"])[]; + }; + /** @description attributes object representing some of the resource's data */ + Videos_Attributes: { + /** + * @description Album item's title + * @example Kill Jay Z + */ + title: string; + /** + * @description Version of the album's item; complements title + * @example Kill Jay Z + */ + version?: string; + /** + * @description ISRC code + * @example TIDAL2274 + */ + isrc: string; + /** + * @description Duration expressed in accordance with ISO 8601 + * @example P30M5S + */ + duration: string; + /** + * @description Copyright information + * @example (p)(c) 2017 S. CARTER ENTERPRISES, LLC. MARKETED BY ROC NATION & DISTRIBUTED BY ROC NATION/UMG RECORDINGS INC. + */ + copyright?: string; + /** + * Format: date + * @description Release date (ISO-8601) + * @example 2017-06-27 + */ + releaseDate?: string; + /** + * @description Indicates whether a catalog item consist of any explicit content + * @example false + */ + explicit: boolean; + /** + * Format: double + * @description Track or video popularity (ranged in 0.00 ... 1.00). Conditionally visible + * @example 0.56 + */ + popularity: number; + /** @description Defines a catalog item availability e.g. for streaming, DJs, stems */ + availability?: ("STREAM" | "DJ" | "STEM")[]; + /** @description Represents available links to, and metadata about, an album item images */ + imageLinks?: components["schemas"]["Catalogue_Item_Image_Link"][]; + /** @description Represents available links to something that is related to a catalog item, but external to the TIDAL API */ + externalLinks?: components["schemas"]["Catalogue_Item_External_Link"][]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Videos_Relationships: { + albums: components["schemas"]["Multi_Data_Relationship_Doc"]; + artists: components["schemas"]["Multi_Data_Relationship_Doc"]; + providers: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + Videos_Resource: { + attributes?: components["schemas"]["Videos_Attributes"]; + relationships?: components["schemas"]["Videos_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + User_Recommendations_Single_Data_Document: { + data?: components["schemas"]["User_Recommendations_Resource"]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Playlists_Resource"] | components["schemas"]["Tracks_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Users_Resource"])[]; + }; + Playlists_Relationship_Document: { + /** @description array of relationship resource linkages */ + data?: components["schemas"]["Resource_Identifier"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Playlists_Resource"] | components["schemas"]["Tracks_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Users_Resource"])[]; + }; + /** @description attributes object representing some of the resource's data */ + Albums_Attributes: { + /** + * @description Original title + * @example 4:44 + */ + title: string; + /** + * @description Barcode id (EAN-13 or UPC-A) + * @example 00854242007552 + */ + barcodeId: string; + /** + * Format: int32 + * @description Number of volumes + * @example 1 + */ + numberOfVolumes: number; + /** + * Format: int32 + * @description Number of album items + * @example 13 + */ + numberOfItems: number; + /** + * @description Duration (ISO-8601) + * @example P41M5S + */ + duration: string; + /** + * @description Indicates whether an album consist of any explicit content + * @example true + */ + explicit: boolean; + /** + * Format: date + * @description Release date (ISO-8601) + * @example 2017-06-30 + */ + releaseDate?: string; + /** + * @description Copyright information + * @example (p)(c) 2017 S. CARTER ENTERPRISES, LLC. MARKETED BY ROC NATION & DISTRIBUTED BY ROC NATION/UMG RECORDINGS INC. + */ + copyright?: string; + /** + * Format: double + * @description Album popularity (ranged in 0.00 ... 1.00). Conditionally visible + * @example 0.56 + */ + popularity: number; + /** @description Defines an album availability e.g. for streaming, DJs, stems */ + availability?: ("STREAM" | "DJ" | "STEM")[]; + mediaTags: string[]; + /** @description Represents available links to, and metadata about, an album cover images */ + imageLinks?: components["schemas"]["Catalogue_Item_Image_Link"][]; + /** @description Represents available links to, and metadata about, an album cover videos */ + videoLinks?: components["schemas"]["Catalogue_Item_Video_Link"][]; + /** @description Represents available links to something that is related to an album resource, but external to the TIDAL API */ + externalLinks?: components["schemas"]["Catalogue_Item_External_Link"][]; + }; + Albums_Item_Resource_Identifier: { + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + meta?: components["schemas"]["Albums_Item_Resource_Identifier_Meta"]; + }; + Albums_Item_Resource_Identifier_Meta: { + /** + * Format: int32 + * @description volume number + * @example 1 + */ + volumeNumber: number; + /** + * Format: int32 + * @description track number + * @example 4 + */ + trackNumber: number; + }; + /** @description Album items (tracks/videos) relationship */ + Albums_Items_Relationship: { + data?: components["schemas"]["Albums_Item_Resource_Identifier"][][]; + links?: components["schemas"]["Links"]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Albums_Relationships: { + artists: components["schemas"]["Multi_Data_Relationship_Doc"]; + items: components["schemas"]["Albums_Items_Relationship"]; + similarAlbums: components["schemas"]["Multi_Data_Relationship_Doc"]; + providers: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + Albums_Resource: { + attributes?: components["schemas"]["Albums_Attributes"]; + relationships?: components["schemas"]["Albums_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description attributes object representing some of the resource's data */ + Artists_Attributes: { + /** + * @description Artist name + * @example JAY Z + */ + name: string; + /** + * Format: double + * @description Artist popularity (ranged in 0.00 ... 1.00). Conditionally visible + * @example 0.56 + */ + popularity: number; + /** @description Represents available links to, and metadata about, an artist images */ + imageLinks?: components["schemas"]["Catalogue_Item_Image_Link"][]; + /** @description Represents available links to something that is related to an artist resource, but external to the TIDAL API */ + externalLinks?: components["schemas"]["Catalogue_Item_External_Link"][]; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Artists_Relationships: { + albums: components["schemas"]["Multi_Data_Relationship_Doc"]; + tracks: components["schemas"]["Multi_Data_Relationship_Doc"]; + videos: components["schemas"]["Multi_Data_Relationship_Doc"]; + similarArtists: components["schemas"]["Multi_Data_Relationship_Doc"]; + trackProviders: components["schemas"]["Artists_Track_Providers_Relationship"]; + radio: components["schemas"]["Multi_Data_Relationship_Doc"]; + }; + Artists_Resource: { + attributes?: components["schemas"]["Artists_Attributes"]; + relationships?: components["schemas"]["Artists_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + /** @description Providers that have released tracks for this artist */ + Artists_Track_Providers_Relationship: { + data?: components["schemas"]["Artists_Track_Providers_Resource_Identifier"][][]; + links?: components["schemas"]["Links"]; + }; + Artists_Track_Providers_Resource_Identifier: { + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + meta?: components["schemas"]["Artists_Track_Providers_Resource_Identifier_Meta"]; + }; + Artists_Track_Providers_Resource_Identifier_Meta: { + /** + * Format: int64 + * @description total number of tracks released together with the provider + * @example 14 + */ + numberOfTracks: number; + }; + Catalogue_Item_Video_Link: { + /** + * @description link to a video + * @example https://resources.tidal.com/images/717dfdae/beb0/4aea/a553/a70064c30386/80x80.mp4 + */ + href: string; + meta: components["schemas"]["Video_Link_Meta"]; + }; + User_Public_Profiles_Multi_Data_Document: { + /** @description array of primary resource data */ + data?: components["schemas"]["User_Public_Profiles_Resource"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Playlists_Resource"] | components["schemas"]["User_Public_Profile_Picks_Resource"] | components["schemas"]["Users_Resource"] | components["schemas"]["User_Public_Profiles_Resource"] | components["schemas"]["Tracks_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["User_Entitlements_Resource"] | components["schemas"]["User_Recommendations_Resource"])[]; + }; + /** @description metadata about a video */ + Video_Link_Meta: { + /** + * Format: int32 + * @description video width (in pixels) + * @example 80 + */ + width: number; + /** + * Format: int32 + * @description video height (in pixels) + * @example 80 + */ + height: number; + }; + User_Public_Profiles_Single_Data_Document: { + data?: components["schemas"]["User_Public_Profiles_Resource"]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Playlists_Resource"] | components["schemas"]["User_Public_Profile_Picks_Resource"] | components["schemas"]["Users_Resource"] | components["schemas"]["User_Public_Profiles_Resource"] | components["schemas"]["Tracks_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["User_Entitlements_Resource"] | components["schemas"]["User_Recommendations_Resource"])[]; + }; + User_Public_Profile_Picks_Relationship_Document: { + /** @description array of relationship resource linkages */ + data?: components["schemas"]["Resource_Identifier"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["User_Public_Profile_Picks_Resource"] | components["schemas"]["Tracks_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["User_Public_Profiles_Resource"])[]; + }; + Users_Relationship_Document: { + /** @description array of relationship resource linkages */ + data?: components["schemas"]["Resource_Identifier"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Users_Resource"] | components["schemas"]["User_Entitlements_Resource"] | components["schemas"]["User_Public_Profiles_Resource"] | components["schemas"]["User_Recommendations_Resource"])[]; + }; + /** @description attributes object representing some of the resource's data */ + Providers_Attributes: { + /** + * @description Provider name. Conditionally visible. + * @example Columbia/Legacy + */ + name: string; + }; + /** @description relationships object describing relationships between the resource and other resources */ + Providers_Relationships: Record; + Providers_Resource: { + attributes?: components["schemas"]["Providers_Attributes"]; + relationships?: components["schemas"]["Providers_Relationships"]; + links?: components["schemas"]["Links"]; + /** + * @description resource unique identifier + * @example 12345 + */ + id: string; + /** + * @description resource unique type + * @example tracks + */ + type: string; + }; + User_Public_Profile_Picks_Multi_Data_Document: { + /** @description array of primary resource data */ + data?: components["schemas"]["User_Public_Profile_Picks_Resource"][]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Tracks_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["User_Public_Profiles_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Providers_Resource"] | components["schemas"]["Playlists_Resource"] | components["schemas"]["User_Public_Profile_Picks_Resource"] | components["schemas"]["Users_Resource"])[]; + }; + User_Public_Profile_Picks_Item_Relationship_Document: { + data?: components["schemas"]["Resource_Identifier"]; + links?: components["schemas"]["Links"]; + included?: (components["schemas"]["Tracks_Resource"] | components["schemas"]["Artists_Resource"] | components["schemas"]["Albums_Resource"] | components["schemas"]["Videos_Resource"] | components["schemas"]["Providers_Resource"] | components["schemas"]["Playlists_Resource"])[]; + }; + User_Entitlements_Single_Data_Document: { + data?: components["schemas"]["User_Entitlements_Resource"]; + links?: components["schemas"]["Links"]; + }; + }; + responses: never; + parameters: never; + requestBodies: never; + headers: never; + pathItems: never; +} +export type $defs = Record; +export interface operations { + getUserPublicProfilePickItemRelationship: { + parameters: { + query: { + /** + * @description Locale language tag (IETF BCP 47 Language Tag) + * @example en-US + */ + locale: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: item + * @example item + */ + include?: string[]; + }; + header?: never; + path: { + /** + * @description TIDAL pick id + * @example b73h3 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["User_Public_Profile_Picks_Item_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + setUserPublicProfilePickItemRelationship: { + parameters: { + query?: { + /** @description Allows the client to customize which related resources should be returned */ + include?: string[]; + }; + header?: never; + path: { + /** + * @description TIDAL pick id + * @example b73h=3 + */ + id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/vnd.api+json": components["schemas"]["Update_User_Public_Profile_Picks_Relationship_Document"]; + }; + }; + responses: { + /** @description Successfully executed request. */ + 202: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "*/*": Record; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getUsersByFilters: { + parameters: { + query?: { + /** + * @description Allows the client to customize which related resources should be returned. Available options: entitlements, publicProfile, recommendations + * @example entitlements + */ + include?: string[]; + /** + * @description Allows to filter the collection of resources based on id attribute value + * @example 251380836 + */ + "filter[id]"?: string[]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Users_Multi_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getUserById: { + parameters: { + query?: { + /** + * @description Allows the client to customize which related resources should be returned. Available options: entitlements, publicProfile, recommendations + * @example entitlements + */ + include?: string[]; + }; + header?: never; + path: { + /** + * @description User Id + * @example 251380836 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Users_Single_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getUserRecommendationsRelationship: { + parameters: { + query?: { + /** + * @description Allows the client to customize which related resources should be returned. Available options: recommendations + * @example recommendations + */ + include?: string[]; + }; + header?: never; + path: { + /** + * @description User Id + * @example 251380836 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Users_Recommendations_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getUserPublicProfileRelationship: { + parameters: { + query: { + /** + * @description Locale language tag (IETF BCP 47 Language Tag) + * @example en-US + */ + locale: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: publicProfile + * @example publicProfile + */ + include?: string[]; + }; + header?: never; + path: { + /** + * @description User Id + * @example 251380836 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["User_Public_Profiles_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getUserEntitlementsRelationship: { + parameters: { + query?: { + /** + * @description Allows the client to customize which related resources should be returned. Available options: entitlements + * @example entitlements + */ + include?: string[]; + }; + header?: never; + path: { + /** + * @description User Id + * @example 251380836 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["User_Entitlements_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getMyUser: { + parameters: { + query?: { + /** + * @description Allows the client to customize which related resources should be returned. Available options: entitlements, publicProfile, recommendations + * @example entitlements + */ + include?: string[]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Users_Single_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getUserRecommendationsByFilters: { + parameters: { + query?: { + /** + * @description Allows the client to customize which related resources should be returned. Available options: myMixes, discoveryMixes, newArrivalMixes + * @example myMixes + */ + include?: string[]; + /** + * @description User recommendations id + * @example 251380836 + */ + "filter[id]"?: string[]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["User_Recommendations_Multi_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getUserRecommendationsById: { + parameters: { + query?: { + /** + * @description Allows the client to customize which related resources should be returned. Available options: myMixes, discoveryMixes, newArrivalMixes + * @example myMixes + */ + include?: string[]; + }; + header?: never; + path: { + /** + * @description User recommendations id + * @example 251380836 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["User_Recommendations_Single_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getUserRecommendationsNewArrivalMixesRelationship: { + parameters: { + query?: { + /** + * @description Allows the client to customize which related resources should be returned. Available options: newArrivalMixes + * @example newArrivalMixes + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description User recommendations id + * @example 251380836 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Playlists_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getUserRecommendationsMyMixesRelationship: { + parameters: { + query?: { + /** + * @description Allows the client to customize which related resources should be returned. Available options: myMixes + * @example myMixes + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description User recommendations id + * @example 251380836 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Playlists_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getUserRecommendationsDiscoveryMixesRelationship: { + parameters: { + query?: { + /** + * @description Allows the client to customize which related resources should be returned. Available options: discoveryMixes + * @example discoveryMixes + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description User recommendations id + * @example 251380836 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Playlists_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getMyUserRecommendations: { + parameters: { + query?: { + /** + * @description Allows the client to customize which related resources should be returned. Available options: myMixes, discoveryMixes, newArrivalMixes + * @example myMixes + */ + include?: string[]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["User_Recommendations_Single_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getUserPublicProfilesByFilters: { + parameters: { + query: { + /** + * @description Locale language tag (IETF BCP 47 Language Tag) + * @example en-US + */ + locale: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: publicPlaylists, publicPicks, followers, following + * @example publicPlaylists + */ + include?: string[]; + /** + * @description TIDAL user id + * @example 1234567890 + */ + "filter[id]"?: string[]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description User profile retrieved successfully */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["User_Public_Profiles_Multi_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getUserPublicProfileById: { + parameters: { + query: { + /** + * @description Locale language tag (IETF BCP 47 Language Tag) + * @example en-US + */ + locale: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: publicPlaylists, publicPicks, followers, following + * @example publicPlaylists + */ + include?: string[]; + }; + header?: never; + path: { + /** + * @description TIDAL user id + * @example 1234567890 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description User profile retrieved successfully */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["User_Public_Profiles_Single_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getUserPublicProfilePublicPlaylistsRelationship: { + parameters: { + query?: { + /** + * @description Allows the client to customize which related resources should be returned. Available options: publicPlaylists + * @example publicPlaylists + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description TIDAL user id + * @example 1234567890 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Public playlists retrieved successfully */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Playlists_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getUserPublicProfilePublicPicksRelationship: { + parameters: { + query: { + /** + * @description Locale language tag (IETF BCP 47 Language Tag) + * @example en-US + */ + locale: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: publicPicks + * @example publicPicks + */ + include?: string[]; + }; + header?: never; + path: { + /** + * @description TIDAL user id + * @example 1234567890 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Public picks retrieved successfully */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["User_Public_Profile_Picks_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getUserPublicProfileFollowingRelationship: { + parameters: { + query?: { + /** + * @description Allows the client to customize which related resources should be returned. Available options: following + * @example following + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description TIDAL user id + * @example 1234567890 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Public following retrieved successfully */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Users_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getUserPublicProfileFollowersRelationship: { + parameters: { + query?: { + /** + * @description Allows the client to customize which related resources should be returned. Available options: followers + * @example followers + */ + include?: string[]; + /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ + "page[cursor]"?: string; + }; + header?: never; + path: { + /** + * @description TIDAL user id + * @example 1234567890 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Public followers retrieved successfully */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Users_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getMyUserPublicProfile: { + parameters: { + query: { + /** + * @description Locale language tag (IETF BCP 47 Language Tag) + * @example en-US + */ + locale: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: publicPlaylists, publicPicks, followers, following + * @example publicPlaylists + */ + include?: string[]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description User profile retrieved successfully */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["User_Public_Profiles_Single_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getUserPublicProfilePicksByFilters: { + parameters: { + query: { + /** + * @description Locale language tag (IETF BCP 47 Language Tag) + * @example en-US + */ + locale: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: item, userPublicProfile + * @example item + */ + include?: string[]; + /** + * @description Allows to filter the collection of resources based on id attribute value + * @example 123123 + */ + "filter[id]"?: string[]; + /** + * @description Allows to filter the collection of resources based on userPublicProfile.id attribute value + * @example 123123 + */ + "filter[userPublicProfile.id]"?: string[]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["User_Public_Profile_Picks_Multi_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getUserPublicProfilePickUserPublicProfileRelationship: { + parameters: { + query?: { + /** + * @description Allows the client to customize which related resources should be returned. Available options: userPublicProfile + * @example userPublicProfile + */ + include?: string[]; + }; + header?: never; + path: { + /** + * @description TIDAL pick id + * @example b73h=3 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["User_Public_Profiles_Relationship_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getMyUserPublicProfilePicks: { + parameters: { + query: { + /** + * @description Locale language tag (IETF BCP 47 Language Tag) + * @example en-US + */ + locale: string; + /** + * @description Allows the client to customize which related resources should be returned. Available options: item, userPublicProfile + * @example item + */ + include?: string[]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["User_Public_Profile_Picks_Multi_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getUserEntitlementsById: { + parameters: { + query?: { + /** @description Allows the client to customize which related resources should be returned */ + include?: string[]; + }; + header?: never; + path: { + /** + * @description User entitlements id + * @example 251380836 + */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["User_Entitlements_Single_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; + getMyUserEntitlements: { + parameters: { + query?: { + /** @description Allows the client to customize which related resources should be returned */ + include?: string[]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully executed request. */ + 200: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["User_Entitlements_Single_Data_Document"]; + }; + }; + /** @description Bad request on client party. Ensure the proper HTTP request is sent (query parameters, request body, etc.). */ + 400: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Resource not found. The requested resource is not found. */ + 404: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Method not supported. Ensure a proper HTTP method for an HTTP request is used. */ + 405: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Not acceptable. The server doesn't support any of the requested by client acceptable content types. */ + 406: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Unsupported Media Type. The API is using content negotiation. Ensure the proper media type is set into Content-Type header. */ + 415: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + /** @description Internal Server Error. Something went wrong on the server party. */ + 500: { + headers: { + /** + * @description Number of tokens currently remaining. Refer to X-RateLimit-Replenish-Rate header for replenishment information. + * @example 5 + */ + "X-RateLimit-Remaining": number; + /** + * @description Initial number of tokens, and max number of tokens that can be replenished. + * @example 20 + */ + "X-RateLimit-Burst-Capacity": number; + /** + * @description Number of tokens replenished per second. + * @example 5 + */ + "X-RateLimit-Replenish-Rate": number; + /** + * @description Request cost in tokens. + * @example 5 + */ + "X-RateLimit-Requested-Tokens": number; + [name: string]: unknown; + }; + content: { + "application/vnd.api+json": components["schemas"]["Error_Document"]; + }; + }; + }; + }; +} diff --git a/packages/api/src/vite-env.d.ts b/packages/api/src/vite-env.d.ts new file mode 100644 index 00000000..11f02fe2 --- /dev/null +++ b/packages/api/src/vite-env.d.ts @@ -0,0 +1 @@ +/// diff --git a/packages/api/tsconfig.build.json b/packages/api/tsconfig.build.json new file mode 100644 index 00000000..7527279c --- /dev/null +++ b/packages/api/tsconfig.build.json @@ -0,0 +1,5 @@ +{ + "extends": "./tsconfig.json", + "include": ["src"], + "exclude": ["node_modules", "test", "src/**/*.test.ts"] +} diff --git a/packages/api/tsconfig.json b/packages/api/tsconfig.json new file mode 100644 index 00000000..f9651533 --- /dev/null +++ b/packages/api/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "../../tsconfig.json", + "compilerOptions": { + "baseUrl": "." + }, + "include": ["."], + "exclude": [ + "node_modules", "dist" + ] +} diff --git a/packages/api/typedoc.json b/packages/api/typedoc.json new file mode 100644 index 00000000..f593f276 --- /dev/null +++ b/packages/api/typedoc.json @@ -0,0 +1,4 @@ +{ + "extends": ["../../typedoc.base.json"], + "entryPoints": ["src/index.ts"] +} diff --git a/packages/api/vite.config.ts b/packages/api/vite.config.ts new file mode 100644 index 00000000..de66bbf2 --- /dev/null +++ b/packages/api/vite.config.ts @@ -0,0 +1,21 @@ +import dts from 'vite-plugin-dts'; +import { defineConfig } from 'vitest/config'; + +export default defineConfig({ + build: { + lib: { + entry: 'src/index.ts', + fileName: 'index', + formats: ['es'], + }, + }, + plugins: [dts({ rollupTypes: true, tsconfigPath: 'tsconfig.build.json' })], + test: { + coverage: { + reporter: process.env.CI ? ['json', 'json-summary'] : ['html'], + }, + globals: true, + restoreMocks: true, + unstubGlobals: true, + }, +}); diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index cfbda0b8..1ca5c8f3 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -32,6 +32,43 @@ importers: specifier: 2.0.4 version: 2.0.4(@types/node@22.5.5)(@vitest/ui@2.0.4)(happy-dom@15.7.4)(terser@5.31.0) + packages/api: + dependencies: + '@tidal-music/api': + specifier: workspace:* + version: 'link:' + openapi-fetch: + specifier: 0.12.0 + version: 0.12.0 + devDependencies: + '@tidal-music/auth': + specifier: workspace:^ + version: link:../auth + '@tidal-music/common': + specifier: workspace:^ + version: link:../common + '@vitest/coverage-v8': + specifier: 2.0.4 + version: 2.0.4(vitest@2.0.4(@types/node@22.5.5)(@vitest/ui@2.0.4)(happy-dom@15.7.4)(terser@5.31.0)) + '@vitest/ui': + specifier: 2.0.4 + version: 2.0.4(vitest@2.0.4) + openapi-typescript: + specifier: 7.4.0 + version: 7.4.0(typescript@5.6.2) + typescript: + specifier: 5.6.2 + version: 5.6.2 + vite: + specifier: 5.4.6 + version: 5.4.6(@types/node@22.5.5)(terser@5.31.0) + vite-plugin-dts: + specifier: 4.2.1 + version: 4.2.1(@types/node@22.5.5)(rollup@4.22.4)(typescript@5.6.2)(vite@5.4.6(@types/node@22.5.5)(terser@5.31.0)) + vitest: + specifier: 2.0.4 + version: 2.0.4(@types/node@22.5.5)(@vitest/ui@2.0.4)(happy-dom@15.7.4)(terser@5.31.0) + packages/auth: dependencies: '@tidal-music/auth': @@ -1739,161 +1776,81 @@ packages: rollup: optional: true - '@rollup/rollup-android-arm-eabi@4.21.3': - resolution: {integrity: sha512-MmKSfaB9GX+zXl6E8z4koOr/xU63AMVleLEa64v7R0QF/ZloMs5vcD1sHgM64GXXS1csaJutG+ddtzcueI/BLg==} - cpu: [arm] - os: [android] - '@rollup/rollup-android-arm-eabi@4.22.4': resolution: {integrity: sha512-Fxamp4aEZnfPOcGA8KSNEohV8hX7zVHOemC8jVBoBUHu5zpJK/Eu3uJwt6BMgy9fkvzxDaurgj96F/NiLukF2w==} cpu: [arm] os: [android] - '@rollup/rollup-android-arm64@4.21.3': - resolution: {integrity: sha512-zrt8ecH07PE3sB4jPOggweBjJMzI1JG5xI2DIsUbkA+7K+Gkjys6eV7i9pOenNSDJH3eOr/jLb/PzqtmdwDq5g==} - cpu: [arm64] - os: [android] - '@rollup/rollup-android-arm64@4.22.4': resolution: {integrity: sha512-VXoK5UMrgECLYaMuGuVTOx5kcuap1Jm8g/M83RnCHBKOqvPPmROFJGQaZhGccnsFtfXQ3XYa4/jMCJvZnbJBdA==} cpu: [arm64] os: [android] - '@rollup/rollup-darwin-arm64@4.21.3': - resolution: {integrity: sha512-P0UxIOrKNBFTQaXTxOH4RxuEBVCgEA5UTNV6Yz7z9QHnUJ7eLX9reOd/NYMO3+XZO2cco19mXTxDMXxit4R/eQ==} - cpu: [arm64] - os: [darwin] - '@rollup/rollup-darwin-arm64@4.22.4': resolution: {integrity: sha512-xMM9ORBqu81jyMKCDP+SZDhnX2QEVQzTcC6G18KlTQEzWK8r/oNZtKuZaCcHhnsa6fEeOBionoyl5JsAbE/36Q==} cpu: [arm64] os: [darwin] - '@rollup/rollup-darwin-x64@4.21.3': - resolution: {integrity: sha512-L1M0vKGO5ASKntqtsFEjTq/fD91vAqnzeaF6sfNAy55aD+Hi2pBI5DKwCO+UNDQHWsDViJLqshxOahXyLSh3EA==} - cpu: [x64] - os: [darwin] - '@rollup/rollup-darwin-x64@4.22.4': resolution: {integrity: sha512-aJJyYKQwbHuhTUrjWjxEvGnNNBCnmpHDvrb8JFDbeSH3m2XdHcxDd3jthAzvmoI8w/kSjd2y0udT+4okADsZIw==} cpu: [x64] os: [darwin] - '@rollup/rollup-linux-arm-gnueabihf@4.21.3': - resolution: {integrity: sha512-btVgIsCjuYFKUjopPoWiDqmoUXQDiW2A4C3Mtmp5vACm7/GnyuprqIDPNczeyR5W8rTXEbkmrJux7cJmD99D2g==} - cpu: [arm] - os: [linux] - '@rollup/rollup-linux-arm-gnueabihf@4.22.4': resolution: {integrity: sha512-j63YtCIRAzbO+gC2L9dWXRh5BFetsv0j0va0Wi9epXDgU/XUi5dJKo4USTttVyK7fGw2nPWK0PbAvyliz50SCQ==} cpu: [arm] os: [linux] - '@rollup/rollup-linux-arm-musleabihf@4.21.3': - resolution: {integrity: sha512-zmjbSphplZlau6ZTkxd3+NMtE4UKVy7U4aVFMmHcgO5CUbw17ZP6QCgyxhzGaU/wFFdTfiojjbLG3/0p9HhAqA==} - cpu: [arm] - os: [linux] - '@rollup/rollup-linux-arm-musleabihf@4.22.4': resolution: {integrity: sha512-dJnWUgwWBX1YBRsuKKMOlXCzh2Wu1mlHzv20TpqEsfdZLb3WoJW2kIEsGwLkroYf24IrPAvOT/ZQ2OYMV6vlrg==} cpu: [arm] os: [linux] - '@rollup/rollup-linux-arm64-gnu@4.21.3': - resolution: {integrity: sha512-nSZfcZtAnQPRZmUkUQwZq2OjQciR6tEoJaZVFvLHsj0MF6QhNMg0fQ6mUOsiCUpTqxTx0/O6gX0V/nYc7LrgPw==} - cpu: [arm64] - os: [linux] - '@rollup/rollup-linux-arm64-gnu@4.22.4': resolution: {integrity: sha512-AdPRoNi3NKVLolCN/Sp4F4N1d98c4SBnHMKoLuiG6RXgoZ4sllseuGioszumnPGmPM2O7qaAX/IJdeDU8f26Aw==} cpu: [arm64] os: [linux] - '@rollup/rollup-linux-arm64-musl@4.21.3': - resolution: {integrity: sha512-MnvSPGO8KJXIMGlQDYfvYS3IosFN2rKsvxRpPO2l2cum+Z3exiExLwVU+GExL96pn8IP+GdH8Tz70EpBhO0sIQ==} - cpu: [arm64] - os: [linux] - '@rollup/rollup-linux-arm64-musl@4.22.4': resolution: {integrity: sha512-Gl0AxBtDg8uoAn5CCqQDMqAx22Wx22pjDOjBdmG0VIWX3qUBHzYmOKh8KXHL4UpogfJ14G4wk16EQogF+v8hmA==} cpu: [arm64] os: [linux] - '@rollup/rollup-linux-powerpc64le-gnu@4.21.3': - resolution: {integrity: sha512-+W+p/9QNDr2vE2AXU0qIy0qQE75E8RTwTwgqS2G5CRQ11vzq0tbnfBd6brWhS9bCRjAjepJe2fvvkvS3dno+iw==} - cpu: [ppc64] - os: [linux] - '@rollup/rollup-linux-powerpc64le-gnu@4.22.4': resolution: {integrity: sha512-3aVCK9xfWW1oGQpTsYJJPF6bfpWfhbRnhdlyhak2ZiyFLDaayz0EP5j9V1RVLAAxlmWKTDfS9wyRyY3hvhPoOg==} cpu: [ppc64] os: [linux] - '@rollup/rollup-linux-riscv64-gnu@4.21.3': - resolution: {integrity: sha512-yXH6K6KfqGXaxHrtr+Uoy+JpNlUlI46BKVyonGiaD74ravdnF9BUNC+vV+SIuB96hUMGShhKV693rF9QDfO6nQ==} - cpu: [riscv64] - os: [linux] - '@rollup/rollup-linux-riscv64-gnu@4.22.4': resolution: {integrity: sha512-ePYIir6VYnhgv2C5Xe9u+ico4t8sZWXschR6fMgoPUK31yQu7hTEJb7bCqivHECwIClJfKgE7zYsh1qTP3WHUA==} cpu: [riscv64] os: [linux] - '@rollup/rollup-linux-s390x-gnu@4.21.3': - resolution: {integrity: sha512-R8cwY9wcnApN/KDYWTH4gV/ypvy9yZUHlbJvfaiXSB48JO3KpwSpjOGqO4jnGkLDSk1hgjYkTbTt6Q7uvPf8eg==} - cpu: [s390x] - os: [linux] - '@rollup/rollup-linux-s390x-gnu@4.22.4': resolution: {integrity: sha512-GqFJ9wLlbB9daxhVlrTe61vJtEY99/xB3C8e4ULVsVfflcpmR6c8UZXjtkMA6FhNONhj2eA5Tk9uAVw5orEs4Q==} cpu: [s390x] os: [linux] - '@rollup/rollup-linux-x64-gnu@4.21.3': - resolution: {integrity: sha512-kZPbX/NOPh0vhS5sI+dR8L1bU2cSO9FgxwM8r7wHzGydzfSjLRCFAT87GR5U9scj2rhzN3JPYVC7NoBbl4FZ0g==} - cpu: [x64] - os: [linux] - '@rollup/rollup-linux-x64-gnu@4.22.4': resolution: {integrity: sha512-87v0ol2sH9GE3cLQLNEy0K/R0pz1nvg76o8M5nhMR0+Q+BBGLnb35P0fVz4CQxHYXaAOhE8HhlkaZfsdUOlHwg==} cpu: [x64] os: [linux] - '@rollup/rollup-linux-x64-musl@4.21.3': - resolution: {integrity: sha512-S0Yq+xA1VEH66uiMNhijsWAafffydd2X5b77eLHfRmfLsRSpbiAWiRHV6DEpz6aOToPsgid7TI9rGd6zB1rhbg==} - cpu: [x64] - os: [linux] - '@rollup/rollup-linux-x64-musl@4.22.4': resolution: {integrity: sha512-UV6FZMUgePDZrFjrNGIWzDo/vABebuXBhJEqrHxrGiU6HikPy0Z3LfdtciIttEUQfuDdCn8fqh7wiFJjCNwO+g==} cpu: [x64] os: [linux] - '@rollup/rollup-win32-arm64-msvc@4.21.3': - resolution: {integrity: sha512-9isNzeL34yquCPyerog+IMCNxKR8XYmGd0tHSV+OVx0TmE0aJOo9uw4fZfUuk2qxobP5sug6vNdZR6u7Mw7Q+Q==} - cpu: [arm64] - os: [win32] - '@rollup/rollup-win32-arm64-msvc@4.22.4': resolution: {integrity: sha512-BjI+NVVEGAXjGWYHz/vv0pBqfGoUH0IGZ0cICTn7kB9PyjrATSkX+8WkguNjWoj2qSr1im/+tTGRaY+4/PdcQw==} cpu: [arm64] os: [win32] - '@rollup/rollup-win32-ia32-msvc@4.21.3': - resolution: {integrity: sha512-nMIdKnfZfzn1Vsk+RuOvl43ONTZXoAPUUxgcU0tXooqg4YrAqzfKzVenqqk2g5efWh46/D28cKFrOzDSW28gTA==} - cpu: [ia32] - os: [win32] - '@rollup/rollup-win32-ia32-msvc@4.22.4': resolution: {integrity: sha512-SiWG/1TuUdPvYmzmYnmd3IEifzR61Tragkbx9D3+R8mzQqDBz8v+BvZNDlkiTtI9T15KYZhP0ehn3Dld4n9J5g==} cpu: [ia32] os: [win32] - '@rollup/rollup-win32-x64-msvc@4.21.3': - resolution: {integrity: sha512-fOvu7PCQjAj4eWDEuD8Xz5gpzFqXzGlxHZozHP4b9Jxv9APtdxL6STqztDzMLuRXEc4UpXGGhx029Xgm91QBeA==} - cpu: [x64] - os: [win32] - '@rollup/rollup-win32-x64-msvc@4.22.4': resolution: {integrity: sha512-j8pPKp53/lq9lMXN57S8cFz0MynJk8OWNuUnXct/9KCpKU7DgU3bYMJhwWmcqC0UU29p8Lr0/7KEVcaM6bf47Q==} cpu: [x64] @@ -4784,11 +4741,6 @@ packages: deprecated: Rimraf versions prior to v4 are no longer supported hasBin: true - rollup@4.21.3: - resolution: {integrity: sha512-7sqRtBNnEbcBtMeRVc6VRsJMmpI+JU1z9VTvW8D4gXIYQFz0aLcsE6rRkyghZkLfEgUZgVvOG7A5CVz/VW5GIA==} - engines: {node: '>=18.0.0', npm: '>=8.0.0'} - hasBin: true - rollup@4.22.4: resolution: {integrity: sha512-vD8HJ5raRcWOyymsR6Z3o6+RzfEPCnVLMFJ6vRslO1jt4LO6dUo5Qnpg7y4RkZFM2DMe3WUirkI5c16onjrc6A==} engines: {node: '>=18.0.0', npm: '>=8.0.0'} @@ -5675,7 +5627,7 @@ snapshots: '@babel/traverse': 7.25.6 '@babel/types': 7.25.6 convert-source-map: 2.0.0 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) gensync: 1.0.0-beta.2 json5: 2.2.3 semver: 6.3.1 @@ -5733,7 +5685,7 @@ snapshots: '@babel/core': 7.24.5 '@babel/helper-compilation-targets': 7.25.2 '@babel/helper-plugin-utils': 7.24.8 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) lodash.debounce: 4.0.8 resolve: 1.22.8 transitivePeerDependencies: @@ -6436,7 +6388,7 @@ snapshots: '@babel/parser': 7.25.6 '@babel/template': 7.25.0 '@babel/types': 7.25.6 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) globals: 11.12.0 transitivePeerDependencies: - supports-color @@ -6711,7 +6663,7 @@ snapshots: '@eslint/eslintrc@2.1.4': dependencies: ajv: 6.12.6 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) espree: 9.6.1 globals: 13.24.0 ignore: 5.3.2 @@ -6729,7 +6681,7 @@ snapshots: '@humanwhocodes/config-array@0.11.14': dependencies: '@humanwhocodes/object-schema': 2.0.3 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) minimatch: 3.1.2 transitivePeerDependencies: - supports-color @@ -6737,7 +6689,7 @@ snapshots: '@humanwhocodes/config-array@0.13.0': dependencies: '@humanwhocodes/object-schema': 2.0.3 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) minimatch: 3.1.2 transitivePeerDependencies: - supports-color @@ -6843,8 +6795,8 @@ snapshots: '@puppeteer/browsers@2.4.0': dependencies: - debug: 4.3.7(supports-color@9.4.0) - extract-zip: 2.0.1 + debug: 4.3.7(supports-color@8.1.1) + extract-zip: 2.0.1(supports-color@8.1.1) progress: 2.0.3 proxy-agent: 6.4.0 semver: 7.6.3 @@ -6973,99 +6925,51 @@ snapshots: optionalDependencies: rollup: 4.22.4 - '@rollup/rollup-android-arm-eabi@4.21.3': - optional: true - '@rollup/rollup-android-arm-eabi@4.22.4': optional: true - '@rollup/rollup-android-arm64@4.21.3': - optional: true - '@rollup/rollup-android-arm64@4.22.4': optional: true - '@rollup/rollup-darwin-arm64@4.21.3': - optional: true - '@rollup/rollup-darwin-arm64@4.22.4': optional: true - '@rollup/rollup-darwin-x64@4.21.3': - optional: true - '@rollup/rollup-darwin-x64@4.22.4': optional: true - '@rollup/rollup-linux-arm-gnueabihf@4.21.3': - optional: true - '@rollup/rollup-linux-arm-gnueabihf@4.22.4': optional: true - '@rollup/rollup-linux-arm-musleabihf@4.21.3': - optional: true - '@rollup/rollup-linux-arm-musleabihf@4.22.4': optional: true - '@rollup/rollup-linux-arm64-gnu@4.21.3': - optional: true - '@rollup/rollup-linux-arm64-gnu@4.22.4': optional: true - '@rollup/rollup-linux-arm64-musl@4.21.3': - optional: true - '@rollup/rollup-linux-arm64-musl@4.22.4': optional: true - '@rollup/rollup-linux-powerpc64le-gnu@4.21.3': - optional: true - '@rollup/rollup-linux-powerpc64le-gnu@4.22.4': optional: true - '@rollup/rollup-linux-riscv64-gnu@4.21.3': - optional: true - '@rollup/rollup-linux-riscv64-gnu@4.22.4': optional: true - '@rollup/rollup-linux-s390x-gnu@4.21.3': - optional: true - '@rollup/rollup-linux-s390x-gnu@4.22.4': optional: true - '@rollup/rollup-linux-x64-gnu@4.21.3': - optional: true - '@rollup/rollup-linux-x64-gnu@4.22.4': optional: true - '@rollup/rollup-linux-x64-musl@4.21.3': - optional: true - '@rollup/rollup-linux-x64-musl@4.22.4': optional: true - '@rollup/rollup-win32-arm64-msvc@4.21.3': - optional: true - '@rollup/rollup-win32-arm64-msvc@4.22.4': optional: true - '@rollup/rollup-win32-ia32-msvc@4.21.3': - optional: true - '@rollup/rollup-win32-ia32-msvc@4.22.4': optional: true - '@rollup/rollup-win32-x64-msvc@4.21.3': - optional: true - '@rollup/rollup-win32-x64-msvc@4.22.4': optional: true @@ -7371,7 +7275,7 @@ snapshots: '@typescript-eslint/type-utils': 6.15.0(eslint@8.56.0)(typescript@5.3.3) '@typescript-eslint/utils': 6.15.0(eslint@8.56.0)(typescript@5.3.3) '@typescript-eslint/visitor-keys': 6.15.0 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) eslint: 8.56.0 graphemer: 1.4.0 ignore: 5.3.2 @@ -7389,7 +7293,7 @@ snapshots: '@typescript-eslint/types': 6.15.0 '@typescript-eslint/typescript-estree': 6.15.0(typescript@5.3.3) '@typescript-eslint/visitor-keys': 6.15.0 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) eslint: 8.56.0 optionalDependencies: typescript: 5.3.3 @@ -7415,7 +7319,7 @@ snapshots: dependencies: '@typescript-eslint/typescript-estree': 6.15.0(typescript@5.3.3) '@typescript-eslint/utils': 6.15.0(eslint@8.56.0)(typescript@5.3.3) - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) eslint: 8.56.0 ts-api-utils: 1.3.0(typescript@5.3.3) optionalDependencies: @@ -7433,7 +7337,7 @@ snapshots: dependencies: '@typescript-eslint/types': 5.62.0 '@typescript-eslint/visitor-keys': 5.62.0 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) globby: 11.1.0 is-glob: 4.0.3 semver: 7.6.3 @@ -7447,7 +7351,7 @@ snapshots: dependencies: '@typescript-eslint/types': 6.15.0 '@typescript-eslint/visitor-keys': 6.15.0 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) globby: 11.1.0 is-glob: 4.0.3 semver: 7.6.3 @@ -7461,7 +7365,7 @@ snapshots: dependencies: '@typescript-eslint/types': 6.21.0 '@typescript-eslint/visitor-keys': 6.21.0 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) globby: 11.1.0 is-glob: 4.0.3 minimatch: 9.0.3 @@ -7536,7 +7440,7 @@ snapshots: dependencies: '@ampproject/remapping': 2.3.0 '@bcoe/v8-coverage': 0.2.3 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) istanbul-lib-coverage: 3.2.2 istanbul-lib-report: 3.0.1 istanbul-lib-source-maps: 5.0.6 @@ -7628,7 +7532,7 @@ snapshots: '@vitest/web-worker@2.0.4(vitest@2.0.4(@types/node@22.5.5)(@vitest/ui@2.0.4)(happy-dom@15.7.4)(terser@5.31.0))': dependencies: - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) vitest: 2.0.4(@types/node@22.5.5)(@vitest/ui@2.0.4)(happy-dom@15.7.4)(terser@5.31.0) transitivePeerDependencies: - supports-color @@ -7873,6 +7777,12 @@ snapshots: acorn@8.12.1: {} + agent-base@7.1.1: + dependencies: + debug: 4.3.7(supports-color@8.1.1) + transitivePeerDependencies: + - supports-color + agent-base@7.1.1(supports-color@9.4.0): dependencies: debug: 4.3.7(supports-color@9.4.0) @@ -8810,14 +8720,14 @@ snapshots: eslint: 8.56.0 eslint-config-prettier: 9.1.0(eslint@8.56.0) eslint-config-xo: 0.43.1(eslint@8.56.0) - eslint-config-xo-react: 0.27.0(eslint-plugin-react-hooks@4.6.0(eslint@8.57.1))(eslint-plugin-react@7.33.2(eslint@8.56.0))(eslint@8.56.0) - eslint-import-resolver-typescript: 3.6.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-plugin-import@2.29.1)(eslint@8.56.0) + eslint-config-xo-react: 0.27.0(eslint-plugin-react-hooks@4.6.0(eslint@8.56.0))(eslint-plugin-react@7.33.2(eslint@8.56.0))(eslint@8.56.0) + eslint-import-resolver-typescript: 3.6.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-plugin-import@2.29.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint@8.57.1))(eslint@8.56.0) eslint-plugin-cypress: 2.15.1(eslint@8.56.0) - eslint-plugin-import: 2.29.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint@8.57.1) + eslint-plugin-import: 2.29.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-import-resolver-typescript@3.6.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-plugin-import@2.29.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint@8.57.1))(eslint@8.56.0))(eslint@8.56.0) eslint-plugin-jsx-a11y: 6.8.0(eslint@8.56.0) eslint-plugin-no-only-tests: 3.1.0 eslint-plugin-perfectionist: 2.5.0(eslint@8.56.0)(typescript@5.3.3) - eslint-plugin-prettier: 5.1.0(@types/eslint@8.56.10)(eslint-config-prettier@9.1.0(eslint@8.57.1))(eslint@8.56.0)(prettier@3.1.1) + eslint-plugin-prettier: 5.1.0(@types/eslint@8.56.10)(eslint-config-prettier@9.1.0(eslint@8.56.0))(eslint@8.56.0)(prettier@3.1.1) eslint-plugin-react: 7.33.2(eslint@8.56.0) eslint-plugin-react-hooks: 4.6.0(eslint@8.56.0) eslint-plugin-storybook: 0.6.15(eslint@8.56.0)(typescript@5.3.3) @@ -8851,7 +8761,7 @@ snapshots: - terser - vue-eslint-parser - eslint-config-xo-react@0.27.0(eslint-plugin-react-hooks@4.6.0(eslint@8.57.1))(eslint-plugin-react@7.33.2(eslint@8.56.0))(eslint@8.56.0): + eslint-config-xo-react@0.27.0(eslint-plugin-react-hooks@4.6.0(eslint@8.56.0))(eslint-plugin-react@7.33.2(eslint@8.56.0))(eslint@8.56.0): dependencies: eslint: 8.56.0 eslint-plugin-react: 7.33.2(eslint@8.56.0) @@ -8870,13 +8780,13 @@ snapshots: transitivePeerDependencies: - supports-color - eslint-import-resolver-typescript@3.6.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-plugin-import@2.29.1)(eslint@8.56.0): + eslint-import-resolver-typescript@3.6.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-plugin-import@2.29.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint@8.57.1))(eslint@8.56.0): dependencies: - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) enhanced-resolve: 5.17.1 eslint: 8.56.0 - eslint-module-utils: 2.11.0(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-import-resolver-node@0.3.9)(eslint-import-resolver-typescript@3.6.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-plugin-import@2.29.1)(eslint@8.56.0))(eslint@8.56.0) - eslint-plugin-import: 2.29.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint@8.57.1) + eslint-module-utils: 2.11.0(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-import-resolver-node@0.3.9)(eslint-import-resolver-typescript@3.6.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-plugin-import@2.29.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint@8.57.1))(eslint@8.56.0))(eslint@8.56.0) + eslint-plugin-import: 2.29.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-import-resolver-typescript@3.6.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-plugin-import@2.29.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint@8.57.1))(eslint@8.56.0))(eslint@8.56.0) fast-glob: 3.3.2 get-tsconfig: 4.8.1 is-core-module: 2.15.1 @@ -8887,14 +8797,14 @@ snapshots: - eslint-import-resolver-webpack - supports-color - eslint-module-utils@2.11.0(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-import-resolver-node@0.3.9)(eslint-import-resolver-typescript@3.6.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-plugin-import@2.29.1)(eslint@8.56.0))(eslint@8.56.0): + eslint-module-utils@2.11.0(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-import-resolver-node@0.3.9)(eslint-import-resolver-typescript@3.6.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-plugin-import@2.29.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint@8.57.1))(eslint@8.56.0))(eslint@8.56.0): dependencies: debug: 3.2.7(supports-color@8.1.1) optionalDependencies: '@typescript-eslint/parser': 6.15.0(eslint@8.56.0)(typescript@5.3.3) eslint: 8.56.0 eslint-import-resolver-node: 0.3.9 - eslint-import-resolver-typescript: 3.6.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-plugin-import@2.29.1)(eslint@8.56.0) + eslint-import-resolver-typescript: 3.6.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-plugin-import@2.29.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint@8.57.1))(eslint@8.56.0) transitivePeerDependencies: - supports-color @@ -8910,7 +8820,7 @@ snapshots: eslint-rule-composer: 0.3.0 lodash: 4.17.21 - eslint-plugin-import@2.29.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint@8.57.1): + eslint-plugin-import@2.29.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-import-resolver-typescript@3.6.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-plugin-import@2.29.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint@8.57.1))(eslint@8.56.0))(eslint@8.56.0): dependencies: array-includes: 3.1.8 array.prototype.findlastindex: 1.2.5 @@ -8918,9 +8828,9 @@ snapshots: array.prototype.flatmap: 1.3.2 debug: 3.2.7(supports-color@8.1.1) doctrine: 2.1.0 - eslint: 8.57.1 + eslint: 8.56.0 eslint-import-resolver-node: 0.3.9 - eslint-module-utils: 2.11.0(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-import-resolver-node@0.3.9)(eslint-import-resolver-typescript@3.6.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-plugin-import@2.29.1)(eslint@8.56.0))(eslint@8.56.0) + eslint-module-utils: 2.11.0(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-import-resolver-node@0.3.9)(eslint-import-resolver-typescript@3.6.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint-plugin-import@2.29.1(@typescript-eslint/parser@6.15.0(eslint@8.57.1)(typescript@5.3.3))(eslint@8.57.1))(eslint@8.56.0))(eslint@8.56.0) hasown: 2.0.2 is-core-module: 2.15.1 is-glob: 4.0.3 @@ -8942,7 +8852,7 @@ snapshots: '@es-joy/jsdoccomment': 0.48.0 are-docs-informative: 0.0.2 comment-parser: 1.4.1 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) escape-string-regexp: 4.0.0 eslint: 8.57.1 espree: 10.1.0 @@ -8986,7 +8896,7 @@ snapshots: - supports-color - typescript - eslint-plugin-prettier@5.1.0(@types/eslint@8.56.10)(eslint-config-prettier@9.1.0(eslint@8.57.1))(eslint@8.56.0)(prettier@3.1.1): + eslint-plugin-prettier@5.1.0(@types/eslint@8.56.10)(eslint-config-prettier@9.1.0(eslint@8.56.0))(eslint@8.56.0)(prettier@3.1.1): dependencies: eslint: 8.56.0 prettier: 3.1.1 @@ -9071,7 +8981,7 @@ snapshots: ajv: 6.12.6 chalk: 4.1.2 cross-spawn: 7.0.3 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) doctrine: 3.0.0 escape-string-regexp: 4.0.0 eslint-scope: 7.2.2 @@ -9114,7 +9024,7 @@ snapshots: ajv: 6.12.6 chalk: 4.1.2 cross-spawn: 7.0.3 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) doctrine: 3.0.0 escape-string-regexp: 4.0.0 eslint-scope: 7.2.2 @@ -9212,16 +9122,6 @@ snapshots: extend@3.0.2: {} - extract-zip@2.0.1: - dependencies: - debug: 4.3.7(supports-color@9.4.0) - get-stream: 5.2.0 - yauzl: 2.10.0 - optionalDependencies: - '@types/yauzl': 2.10.3 - transitivePeerDependencies: - - supports-color - extract-zip@2.0.1(supports-color@8.1.1): dependencies: debug: 4.3.7(supports-color@8.1.1) @@ -9381,7 +9281,7 @@ snapshots: dependencies: basic-ftp: 5.0.5 data-uri-to-buffer: 6.0.2 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) fs-extra: 11.2.0 transitivePeerDependencies: - supports-color @@ -9533,8 +9433,8 @@ snapshots: http-proxy-agent@7.0.2: dependencies: - agent-base: 7.1.1(supports-color@9.4.0) - debug: 4.3.7(supports-color@9.4.0) + agent-base: 7.1.1 + debug: 4.3.7(supports-color@8.1.1) transitivePeerDependencies: - supports-color @@ -9544,6 +9444,13 @@ snapshots: jsprim: 2.0.2 sshpk: 1.18.0 + https-proxy-agent@7.0.4: + dependencies: + agent-base: 7.1.1 + debug: 4.3.7(supports-color@8.1.1) + transitivePeerDependencies: + - supports-color + https-proxy-agent@7.0.4(supports-color@9.4.0): dependencies: agent-base: 7.1.1(supports-color@9.4.0) @@ -9757,7 +9664,7 @@ snapshots: istanbul-lib-source-maps@5.0.6: dependencies: '@jridgewell/trace-mapping': 0.3.25 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) istanbul-lib-coverage: 3.2.2 transitivePeerDependencies: - supports-color @@ -9869,7 +9776,7 @@ snapshots: koa-send@5.0.1: dependencies: - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) http-errors: 1.8.1 resolve-path: 1.4.0 transitivePeerDependencies: @@ -9889,7 +9796,7 @@ snapshots: content-disposition: 0.5.4 content-type: 1.0.5 cookies: 0.9.1 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) delegates: 1.0.0 depd: 2.0.0 destroy: 1.2.0 @@ -10307,11 +10214,11 @@ snapshots: pac-proxy-agent@7.0.1: dependencies: '@tootallnate/quickjs-emscripten': 0.23.0 - agent-base: 7.1.1(supports-color@9.4.0) - debug: 4.3.7(supports-color@9.4.0) + agent-base: 7.1.1 + debug: 4.3.7(supports-color@8.1.1) get-uri: 6.0.3 http-proxy-agent: 7.0.2 - https-proxy-agent: 7.0.4(supports-color@9.4.0) + https-proxy-agent: 7.0.4 pac-resolver: 7.0.1 socks-proxy-agent: 8.0.3 transitivePeerDependencies: @@ -10440,10 +10347,10 @@ snapshots: proxy-agent@6.4.0: dependencies: - agent-base: 7.1.1(supports-color@9.4.0) - debug: 4.3.7(supports-color@9.4.0) + agent-base: 7.1.1 + debug: 4.3.7(supports-color@8.1.1) http-proxy-agent: 7.0.2 - https-proxy-agent: 7.0.4(supports-color@9.4.0) + https-proxy-agent: 7.0.4 lru-cache: 7.18.3 pac-proxy-agent: 7.0.1 proxy-from-env: 1.1.0 @@ -10470,7 +10377,7 @@ snapshots: dependencies: '@puppeteer/browsers': 2.4.0 chromium-bidi: 0.6.5(devtools-protocol@0.0.1330662) - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) devtools-protocol: 0.0.1330662 typed-query-selector: 2.12.0 ws: 8.18.0 @@ -10606,28 +10513,6 @@ snapshots: dependencies: glob: 7.2.3 - rollup@4.21.3: - dependencies: - '@types/estree': 1.0.5 - optionalDependencies: - '@rollup/rollup-android-arm-eabi': 4.21.3 - '@rollup/rollup-android-arm64': 4.21.3 - '@rollup/rollup-darwin-arm64': 4.21.3 - '@rollup/rollup-darwin-x64': 4.21.3 - '@rollup/rollup-linux-arm-gnueabihf': 4.21.3 - '@rollup/rollup-linux-arm-musleabihf': 4.21.3 - '@rollup/rollup-linux-arm64-gnu': 4.21.3 - '@rollup/rollup-linux-arm64-musl': 4.21.3 - '@rollup/rollup-linux-powerpc64le-gnu': 4.21.3 - '@rollup/rollup-linux-riscv64-gnu': 4.21.3 - '@rollup/rollup-linux-s390x-gnu': 4.21.3 - '@rollup/rollup-linux-x64-gnu': 4.21.3 - '@rollup/rollup-linux-x64-musl': 4.21.3 - '@rollup/rollup-win32-arm64-msvc': 4.21.3 - '@rollup/rollup-win32-ia32-msvc': 4.21.3 - '@rollup/rollup-win32-x64-msvc': 4.21.3 - fsevents: 2.3.3 - rollup@4.22.4: dependencies: '@types/estree': 1.0.5 @@ -10778,8 +10663,8 @@ snapshots: socks-proxy-agent@8.0.3: dependencies: - agent-base: 7.1.1(supports-color@9.4.0) - debug: 4.3.7(supports-color@9.4.0) + agent-base: 7.1.1 + debug: 4.3.7(supports-color@8.1.1) socks: 2.8.3 transitivePeerDependencies: - supports-color @@ -11260,7 +11145,7 @@ snapshots: vite-node@1.1.0(@types/node@22.5.5)(terser@5.31.0): dependencies: cac: 6.7.14 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) pathe: 1.1.2 picocolors: 1.1.0 vite: 5.4.6(@types/node@22.5.5)(terser@5.31.0) @@ -11278,7 +11163,7 @@ snapshots: vite-node@2.0.4(@types/node@22.5.5)(terser@5.31.0): dependencies: cac: 6.7.14 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) pathe: 1.1.2 tinyrainbow: 1.2.0 vite: 5.4.6(@types/node@22.5.5)(terser@5.31.0) @@ -11300,7 +11185,7 @@ snapshots: '@volar/typescript': 2.4.5 '@vue/language-core': 2.1.6(typescript@5.6.2) compare-versions: 6.1.1 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) kolorist: 1.8.0 local-pkg: 0.5.0 magic-string: 0.30.11 @@ -11330,7 +11215,7 @@ snapshots: dependencies: esbuild: 0.21.4 postcss: 8.4.47 - rollup: 4.21.3 + rollup: 4.22.4 optionalDependencies: '@types/node': 22.5.5 fsevents: 2.3.3 @@ -11346,7 +11231,7 @@ snapshots: acorn-walk: 8.3.4 cac: 6.7.14 chai: 4.5.0 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) execa: 8.0.1 local-pkg: 0.5.0 magic-string: 0.30.11 @@ -11382,7 +11267,7 @@ snapshots: '@vitest/spy': 2.0.4 '@vitest/utils': 2.0.4 chai: 5.1.1 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.3.7(supports-color@8.1.1) execa: 8.0.1 magic-string: 0.30.11 pathe: 1.1.2