/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ export interface paths { "/acceptedTerms": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple acceptedTerms. * @description Retrieves multiple acceptedTerms by available filters, or without if applicable. */ get: { parameters: { query: { /** @description User id. Use `me` for the authenticated user */ "filter[owners.id]": string[]; /** @description One of: DEVELOPER, UPLOAD_MARKETPLACE, MERCH_GUIDELINES (e.g. `DEVELOPER`) */ "filter[terms.termsType]": ("DEVELOPER" | "UPLOAD_MARKETPLACE" | "MERCH_GUIDELINES")[]; /** * @description Allows the client to customize which related resources should be returned. Available options: owners, terms * @example owners */ include?: string[]; /** @description Filter by terms.isLatestVersion */ "filter[terms.isLatestVersion]"?: string[]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["AcceptedTerms_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Create single acceptedTerm. * @description Creates a new acceptedTerm. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["AcceptedTermsCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["AcceptedTerms_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/acceptedTerms/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 Accepted terms id * @example a468bee88def */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["AcceptedTerms_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/acceptedTerms/{id}/relationships/terms": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get terms relationship ("to-one"). * @description Retrieves terms relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: terms * @example terms */ include?: string[]; }; header?: never; path: { /** * @description Accepted terms id * @example a468bee88def */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["AcceptedTerms_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/albumStatistics/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single albumStatistic. * @description Retrieves single albumStatistic by id. */ get: { 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: owners * @example owners */ include?: string[]; }; header?: never; path: { /** * @description Album statistic id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["AlbumStatistics_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/albumStatistics/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { 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: owners * @example owners */ 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 Album statistic id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["AlbumStatistics_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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 Retrieves multiple albums by available filters, or without if applicable. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */ sort?: ("createdAt" | "-createdAt" | "title" | "-title")[]; /** * @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: albumStatistics, artists, coverArt, genres, items, owners, priceConfig, providers, replacement, shares, similarAlbums, suggestedCoverArts, usageRules * @example artists.albums */ include?: string[]; /** @description List of barcode IDs (EAN-13 or UPC-A). NOTE: Supplying more than one barcode ID will currently only return one album per barcode ID. (e.g. `196589525444`) */ "filter[barcodeId]"?: string[]; /** @description List of album IDs (e.g. `251380836`) */ "filter[id]"?: string[]; /** @description User id. Use `me` for the authenticated user */ "filter[owners.id]"?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: artists.albums * @example artists.albums */ replaceMedia?: string; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Albums_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Create single album. * @description Creates a new album. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["AlbumsCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Albums_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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 Retrieves single album by id. */ get: { 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: albumStatistics, artists, coverArt, genres, items, owners, priceConfig, providers, replacement, shares, similarAlbums, suggestedCoverArts, usageRules * @example artists.albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: artists.albums * @example artists.albums */ replaceMedia?: string; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Album id * @example 251380836 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Albums_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; /** * Delete single album. * @description Deletes existing album. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Album id * @example 251380836 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; /** * Update single album. * @description Updates existing album. */ patch: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Album id * @example 251380836 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["AlbumsUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/albums/{id}/relationships/albumStatistics": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get albumStatistics relationship ("to-one"). * @description Retrieves albumStatistics relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: albumStatistics * @example albumStatistics */ include?: string[]; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Album id * @example 251380836 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Albums_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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; }; /** * Get artists relationship ("to-many"). * @description Retrieves artists relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @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.albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: artists.albums * @example artists.albums */ replaceMedia?: string; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Album id * @example 251380836 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Albums_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/albums/{id}/relationships/coverArt": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get coverArt relationship ("to-many"). * @description Retrieves coverArt relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @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: coverArt * @example coverArt */ include?: string[]; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Album id * @example 251380836 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Albums_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Update coverArt relationship ("to-many"). * @description Updates coverArt relationship. */ patch: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Album id * @example 251380836 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["AlbumsCoverArtRelationshipUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/albums/{id}/relationships/genres": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get genres relationship ("to-many"). * @description Retrieves genres relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @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: genres * @example genres */ include?: string[]; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Album id * @example 251380836 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Albums_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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; }; /** * Get items relationship ("to-many"). * @description Retrieves items relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @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 Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items * @example items */ replaceMedia?: string; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Album id * @example 251380836 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Albums_Items_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Update items relationship ("to-many"). * @description Updates items relationship. */ patch: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Album id * @example 251380836 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["AlbumsItemsRelationshipUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/albums/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { 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: owners * @example owners */ include?: string[]; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Album id * @example 251380836 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Albums_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/albums/{id}/relationships/priceConfig": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get priceConfig relationship ("to-one"). * @description Retrieves priceConfig relationship. */ get: { 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: priceConfig * @example priceConfig */ include?: string[]; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Album id * @example 251380836 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Albums_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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; }; /** * Get providers relationship ("to-many"). * @description Retrieves providers relationship. */ get: { 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; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Album id * @example 251380836 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Albums_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/albums/{id}/relationships/replacement": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get replacement relationship ("to-one"). * @description Retrieves replacement relationship. */ get: { 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: replacement * @example replacement */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: replacement * @example replacement */ replaceMedia?: string; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Album id * @example 251380836 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Albums_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/albums/{id}/relationships/shares": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get shares relationship ("to-many"). * @description Retrieves shares relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: shares * @example shares.sharedResources */ include?: string[]; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: shares.sharedResources * @example shares.sharedResources */ replaceMedia?: string; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Album id * @example 251380836 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Albums_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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; }; /** * Get similarAlbums relationship ("to-many"). * @description Retrieves similarAlbums relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @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 Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: similarAlbums * @example similarAlbums */ replaceMedia?: string; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Album id * @example 251380836 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Albums_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/albums/{id}/relationships/suggestedCoverArts": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get suggestedCoverArts relationship ("to-many"). * @description Retrieves suggestedCoverArts relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: suggestedCoverArts * @example suggestedCoverArts */ include?: string[]; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Album id * @example 251380836 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Albums_SuggestedCoverArts_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/albums/{id}/relationships/usageRules": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get usageRules relationship ("to-one"). * @description Retrieves usageRules relationship. */ get: { 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: usageRules * @example usageRules */ include?: string[]; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Album id * @example 251380836 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Albums_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/appreciations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create single appreciation. * @description Creates a new appreciation. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["AppreciationsCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Appreciations_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/artistBiographies/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single artistBiographie. * @description Retrieves single artistBiographie by id. */ get: { 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: owners * @example owners */ include?: string[]; }; header?: never; path: { /** * @description Artist biography id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ArtistBiographies_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Update single artistBiographie. * @description Updates existing artistBiographie. */ patch: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Artist biography id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["ArtistBiographiesUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/artistBiographies/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 Artist biography id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ArtistBiographies_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/artistClaimStatuses": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple artistClaimStatuses. * @description Retrieves multiple artistClaimStatuses by available filters, or without if applicable. */ get: { parameters: { query: { /** @description List of artist claim status IDs (e.g. `QVJUSVNUUzoxNTY2`) */ "filter[id]": string[]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ArtistClaimStatuses_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/artistClaims": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple artistClaims. * @description Retrieves multiple artistClaims by available filters, or without if applicable. */ get: { parameters: { query: { /** @description User id. Use `me` for the authenticated user */ "filter[owners.id]": string[]; /** * @description Allows the client to customize which related resources should be returned. Available options: acceptedArtists, owners, recommendedArtists * @example acceptedArtists.albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: acceptedArtists.albums * @example acceptedArtists.albums */ replaceMedia?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ArtistClaims_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Create single artistClaim. * @description Creates a new artistClaim. */ post: { parameters: { query?: { /** * @description ISO 3166-1 alpha-2 country code * @example US */ countryCode?: string; }; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["ArtistClaimsCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ArtistClaims_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/artistClaims/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single artistClaim. * @description Retrieves single artistClaim by id. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: acceptedArtists, owners, recommendedArtists * @example acceptedArtists.albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: acceptedArtists.albums * @example acceptedArtists.albums */ replaceMedia?: string; }; header?: never; path: { /** * @description Artist claim id * @example f47ac10b-58cc-4372-a567-0e02b2c3d479 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ArtistClaims_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; /** * Delete single artistClaim. * @description Deletes existing artistClaim. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Artist claim id * @example f47ac10b-58cc-4372-a567-0e02b2c3d479 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; /** * Update single artistClaim. * @description Updates existing artistClaim. */ patch: { parameters: { query?: { /** * @description ISO 3166-1 alpha-2 country code * @example US */ countryCode?: string; }; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Artist claim id * @example f47ac10b-58cc-4372-a567-0e02b2c3d479 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["ArtistClaimsUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/artistClaims/{id}/relationships/acceptedArtists": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get acceptedArtists relationship ("to-many"). * @description Retrieves acceptedArtists relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: acceptedArtists * @example acceptedArtists.albums */ include?: string[]; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: acceptedArtists.albums * @example acceptedArtists.albums */ replaceMedia?: string; }; header?: never; path: { /** * @description Artist claim id * @example f47ac10b-58cc-4372-a567-0e02b2c3d479 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ArtistClaims_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Update acceptedArtists relationship ("to-many"). * @description Updates acceptedArtists relationship. */ patch: { parameters: { query?: { /** * @description ISO 3166-1 alpha-2 country code * @example US */ countryCode?: string; }; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Artist claim id * @example f47ac10b-58cc-4372-a567-0e02b2c3d479 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["ArtistClaimsAcceptedArtistsRelationshipUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/artistClaims/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 Artist claim id * @example f47ac10b-58cc-4372-a567-0e02b2c3d479 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ArtistClaims_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/artistClaims/{id}/relationships/recommendedArtists": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get recommendedArtists relationship ("to-many"). * @description Retrieves recommendedArtists relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: recommendedArtists * @example recommendedArtists.albums */ include?: string[]; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: recommendedArtists.albums * @example recommendedArtists.albums */ replaceMedia?: string; }; header?: never; path: { /** * @description Artist claim id * @example f47ac10b-58cc-4372-a567-0e02b2c3d479 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ArtistClaims_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/artistRoles/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single artistRole. * @description Retrieves single artistRole by id. */ get: { parameters: { query?: never; header?: never; path: { /** * @description Artist role id * @example 1 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ArtistRoles_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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 Retrieves multiple artists by available filters, or without if applicable. */ get: { 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, biography, claimStatus, followers, following, owners, profileArt, radio, roles, similarArtists, trackProviders, tracks, videos * @example albums */ include?: string[]; /** @description Artist handle (e.g. `jayz`) */ "filter[handle]"?: string[]; /** @description List of artist IDs (e.g. `1566`) */ "filter[id]"?: string[]; /** @description User id. Use `me` for the authenticated user */ "filter[owners.id]"?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: albums * @example albums */ replaceMedia?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Artists_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Create single artist. * @description Creates a new artist. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["ArtistsCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Artists_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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 Retrieves single artist by id. */ get: { 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, biography, claimStatus, followers, following, owners, profileArt, radio, roles, similarArtists, trackProviders, tracks, videos * @example albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: albums * @example albums */ replaceMedia?: string; }; header?: never; path: { /** * @description Artist id * @example 1566 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Artists_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Update single artist. * @description Updates existing artist. */ patch: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Artist id * @example 1566 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["ArtistsUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/artists/{id}/relationships/albums": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get albums relationship ("to-many"). * @description Retrieves albums relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @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 Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: albums * @example albums */ replaceMedia?: string; }; header?: never; path: { /** * @description Artist id * @example 1566 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Artists_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/artists/{id}/relationships/biography": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get biography relationship ("to-one"). * @description Retrieves biography relationship. */ get: { 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: biography * @example biography */ include?: string[]; }; header?: never; path: { /** * @description Artist id * @example 1566 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Artists_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/artists/{id}/relationships/claimStatus": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get claimStatus relationship ("to-one"). * @description Retrieves claimStatus relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: claimStatus * @example claimStatus */ include?: string[]; }; header?: never; path: { /** * @description Artist id * @example 1566 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Artists_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/artists/{id}/relationships/followers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get followers relationship ("to-many"). * @description Retrieves followers relationship. */ get: { parameters: { query?: { viewerContext?: string; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: followers * @example followers.albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: followers.albums * @example followers.albums */ replaceMedia?: string; }; header?: never; path: { /** * @description Artist id * @example 1566 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Artists_Followers_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/artists/{id}/relationships/following": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get following relationship ("to-many"). * @description Retrieves following relationship. */ get: { parameters: { query?: { viewerContext?: string; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: following * @example following.albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: following.albums * @example following.albums */ replaceMedia?: string; }; header?: never; path: { /** * @description Artist id * @example 1566 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Artists_Following_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Add to following relationship ("to-many"). * @description Adds item(s) to following relationship. */ post: { parameters: { query?: { /** * @description ISO 3166-1 alpha-2 country code * @example US */ countryCode?: string; }; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Artist id * @example 1566 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["ArtistsFollowingRelationshipAddOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; /** * Delete from following relationship ("to-many"). * @description Deletes item(s) from following relationship. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Artist id * @example 1566 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["ArtistsFollowingRelationshipRemoveOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; patch?: never; trace?: never; }; "/artists/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 Artist id * @example 1566 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Artists_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/artists/{id}/relationships/profileArt": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get profileArt relationship ("to-many"). * @description Retrieves profileArt relationship. */ get: { 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: profileArt * @example profileArt */ 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 Artist id * @example 1566 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Artists_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Update profileArt relationship ("to-many"). * @description Updates profileArt relationship. */ patch: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Artist id * @example 1566 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["ArtistsProfileArtRelationshipUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/artists/{id}/relationships/radio": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get radio relationship ("to-many"). * @description Retrieves radio relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @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.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: radio.items * @example radio.items */ replaceMedia?: string; }; header?: never; path: { /** * @description Artist id * @example 1566 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Artists_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/artists/{id}/relationships/roles": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get roles relationship ("to-many"). * @description Retrieves roles relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: roles * @example roles */ 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 Artist id * @example 1566 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Artists_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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; }; /** * Get similarArtists relationship ("to-many"). * @description Retrieves similarArtists relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @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.albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: similarArtists.albums * @example similarArtists.albums */ replaceMedia?: string; }; header?: never; path: { /** * @description Artist id * @example 1566 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Artists_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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; }; /** * Get trackProviders relationship ("to-many"). * @description Retrieves trackProviders relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: trackProviders * @example trackProviders */ include?: string[]; }; header?: never; path: { /** * @description Artist id * @example 1566 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Artists_TrackProviders_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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; }; /** * Get tracks relationship ("to-many"). * @description Retrieves tracks relationship. */ get: { parameters: { query: { /** * @description Collapse by options for getting artist tracks. Available options: FINGERPRINT, ID. FINGERPRINT option might collapse similar tracks based entry fingerprints while collapsing by ID always returns all available items. * @example FINGERPRINT */ collapseBy: "FINGERPRINT" | "NONE"; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @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 Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: tracks * @example tracks */ replaceMedia?: string; }; header?: never; path: { /** * @description Artist id * @example 1566 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Artists_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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; }; /** * Get videos relationship ("to-many"). * @description Retrieves videos relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @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 Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: videos * @example videos */ replaceMedia?: string; }; header?: never; path: { /** * @description Artist id * @example 1566 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Artists_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/artworks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple artworks. * @description Retrieves multiple artworks by available filters, or without if applicable. */ get: { parameters: { query: { /** @description Artwork id (e.g. `a468bee88def`) */ "filter[id]": string[]; /** * @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: owners * @example owners */ include?: string[]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Artworks_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Create single artwork. * @description Creates a new artwork. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["ArtworksCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Artworks_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/artworks/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single artwork. * @description Retrieves single artwork by id. */ get: { 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: owners * @example owners */ include?: string[]; }; header?: never; path: { /** * @description Artwork id * @example a468bee88def */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Artworks_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/artworks/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 Artwork id * @example a468bee88def */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Artworks_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/clients": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple clients. * @description Retrieves multiple clients by available filters, or without if applicable. */ get: { parameters: { query: { /** @description User id. Use `me` for the authenticated user */ "filter[owners.id]": string[]; /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ include?: string[]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Clients_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Create single client. * @description Creates a new client. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["ClientsCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Clients_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/clients/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single client. * @description Retrieves single client by id. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ include?: string[]; }; header?: never; path: { /** * @description OAuth client identifier * @example a468bee88def */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Clients_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; /** * Delete single client. * @description Deletes existing client. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description OAuth client identifier * @example a468bee88def */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; /** * Update single client. * @description Updates existing client. */ patch: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description OAuth client identifier * @example a468bee88def */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["ClientsUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Clients_Update_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/clients/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 OAuth client identifier * @example a468bee88def */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Clients_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/collaborationInviteRedemptions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create single collaborationInviteRedemption. * @description Creates a new collaborationInviteRedemption. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["CollaborationInviteRedemptionsCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["CollaborationInviteRedemptions_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/collaborationInvites": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple collaborationInvites. * @description Retrieves multiple collaborationInvites by available filters, or without if applicable. */ get: { parameters: { query: { /** @description Invite code */ "filter[code]": string[]; /** * @description Allows the client to customize which related resources should be returned. Available options: owners, subject * @example subject.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: subject.items * @example subject.items */ replaceMedia?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["CollaborationInvites_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Create single collaborationInvite. * @description Creates a new collaborationInvite. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["CollaborationInvitesCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["CollaborationInvites_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/collaborationInvites/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single collaborationInvite. * @description Retrieves single collaborationInvite by id. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners, subject * @example subject.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: subject.items * @example subject.items */ replaceMedia?: string; }; header?: never; path: { /** * @description Collaboration invite id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["CollaborationInvites_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; /** * Delete single collaborationInvite. * @description Deletes existing collaborationInvite. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Collaboration invite id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; patch?: never; trace?: never; }; "/collaborationInvites/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 Collaboration invite id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["CollaborationInvites_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/collaborationInvites/{id}/relationships/subject": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get subject relationship ("to-one"). * @description Retrieves subject relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: subject * @example subject.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: subject.items * @example subject.items */ replaceMedia?: string; }; header?: never; path: { /** * @description Collaboration invite id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["CollaborationInvites_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/comments": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple comments. * @description Retrieves multiple comments by available filters, or without if applicable. */ get: { parameters: { query: { /** @description Filter by subject resource ID (e.g. `12345`) */ "filter[subject.id]": string[]; /** @description Filter by subject resource type (e.g. `albums`) */ "filter[subject.type]": ("albums" | "tracks")[]; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */ sort?: ("createdAt" | "-createdAt" | "likeCount" | "-likeCount" | "replyCount" | "-replyCount" | "startTime" | "-startTime")[]; /** * @description Allows the client to customize which related resources should be returned. Available options: ownerProfiles, owners, parentComment * @example ownerProfiles */ include?: string[]; /** @description Filter by parent comment ID to get replies (e.g. `550e8400-e29b-41d4-a716-446655440000`) */ "filter[parentComment.id]"?: string[]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Comments_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Create single comment. * @description Creates a new comment. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["CommentsCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Comments_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/comments/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single comment. * @description Retrieves single comment by id. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: ownerProfiles, owners, parentComment * @example ownerProfiles */ include?: string[]; }; header?: never; path: { /** * @description Comment Id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Comments_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; /** * Delete single comment. * @description Deletes existing comment. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Comment Id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; /** * Update single comment. * @description Updates existing comment. */ patch: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Comment Id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["CommentsUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/comments/{id}/relationships/ownerProfiles": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get ownerProfiles relationship ("to-many"). * @description Retrieves ownerProfiles relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: ownerProfiles * @example ownerProfiles */ 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 Comment Id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Comments_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/comments/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 Comment Id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Comments_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/comments/{id}/relationships/parentComment": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get parentComment relationship ("to-one"). * @description Retrieves parentComment relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: parentComment * @example parentComment */ include?: string[]; }; header?: never; path: { /** * @description Comment Id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Comments_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/contentClaims": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple contentClaims. * @description Retrieves multiple contentClaims by available filters, or without if applicable. */ get: { parameters: { query: { /** @description User id. Use `me` for the authenticated user */ "filter[owners.id]": string[]; /** * @description Allows the client to customize which related resources should be returned. Available options: claimedResource, claimingArtist, owners * @example claimedResource */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: claimedResource * @example claimedResource */ replaceMedia?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ContentClaims_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Create single contentClaim. * @description Creates a new contentClaim. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["ContentClaimsCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ContentClaims_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/contentClaims/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single contentClaim. * @description Retrieves single contentClaim by id. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: claimedResource, claimingArtist, owners * @example claimedResource */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: claimedResource * @example claimedResource */ replaceMedia?: string; }; header?: never; path: { /** * @description Content claim id * @example f47ac10b-58cc-4372-a567-0e02b2c3d479 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ContentClaims_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/contentClaims/{id}/relationships/claimedResource": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get claimedResource relationship ("to-one"). * @description Retrieves claimedResource relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: claimedResource * @example claimedResource */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: claimedResource * @example claimedResource */ replaceMedia?: string; }; header?: never; path: { /** * @description Content claim id * @example f47ac10b-58cc-4372-a567-0e02b2c3d479 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ContentClaims_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/contentClaims/{id}/relationships/claimingArtist": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get claimingArtist relationship ("to-one"). * @description Retrieves claimingArtist relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: claimingArtist * @example claimingArtist.albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: claimingArtist.albums * @example claimingArtist.albums */ replaceMedia?: string; }; header?: never; path: { /** * @description Content claim id * @example f47ac10b-58cc-4372-a567-0e02b2c3d479 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ContentClaims_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/contentClaims/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 Content claim id * @example f47ac10b-58cc-4372-a567-0e02b2c3d479 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ContentClaims_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/credits/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single credit. * @description Retrieves single credit by id. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: artist, category * @example artist.albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: artist.albums * @example artist.albums */ replaceMedia?: string; }; header?: never; path: { /** * @description Credit id * @example 3fG7kLmN2pQrStUv */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Credits_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/credits/{id}/relationships/artist": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get artist relationship ("to-one"). * @description Retrieves artist relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: artist * @example artist.albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: artist.albums * @example artist.albums */ replaceMedia?: string; }; header?: never; path: { /** * @description Credit id * @example 3fG7kLmN2pQrStUv */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Credits_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/credits/{id}/relationships/category": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get category relationship ("to-one"). * @description Retrieves category relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: category * @example category */ include?: string[]; }; header?: never; path: { /** * @description Credit id * @example 3fG7kLmN2pQrStUv */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Credits_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/downloads": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple downloads. * @description Retrieves multiple downloads by available filters, or without if applicable. */ get: { parameters: { query: { /** @description Download id (e.g. `VFJBQ0tTOjEyMzQ1`) */ "filter[id]": string[]; /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ include?: string[]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Downloads_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/downloads/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single download. * @description Retrieves single download by id. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ include?: string[]; }; header?: never; path: { /** * @description Download id * @example VFJBQ0tTOjEyMzQ1 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Downloads_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/downloads/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 Download id * @example VFJBQ0tTOjEyMzQ1 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Downloads_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dspSharingLinks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple dspSharingLinks. * @description Retrieves multiple dspSharingLinks by available filters, or without if applicable. */ get: { parameters: { query: { /** @description The id of the subject resource */ "filter[subject.id]": string[]; /** @description The type of the subject resource (e.g., albums, tracks, artists) (e.g. `tracks`) */ "filter[subject.type]": ("tracks" | "albums" | "artists")[]; /** * @description Allows the client to customize which related resources should be returned. Available options: subject * @example subject */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: subject * @example subject */ replaceMedia?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["DspSharingLinks_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dspSharingLinks/{id}/relationships/subject": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get subject relationship ("to-one"). * @description Retrieves subject relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: subject * @example subject */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: subject * @example subject */ replaceMedia?: string; }; header?: never; path: { /** * @description DspSharingLinks Id * @example QUxCVU1TOjEyMzQ1 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["DspSharingLinks_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dynamicModules": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple dynamicModules. * @description Retrieves multiple dynamicModules by available filters, or without if applicable. */ get: { parameters: { query: { /** * @description The type of device making the request * @example PHONE */ deviceType: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV"; /** * @description The system type of the device making the request * @example IOS */ systemType: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB"; /** * @description Client version number * @example 2026.0.1 */ clientVersion: string; /** @description DynamicModules Id (e.g. `nejMcAhh5N8S3EQ4LaqysVdI0cZZ`) */ "filter[id]": string[]; /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */ refreshSeed?: string; /** * @description ISO 3166-1 alpha-2 country code * @example US */ countryCode?: string; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: items, seedItem * @example items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items * @example items */ replaceMedia?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["DynamicModules_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dynamicModules/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single dynamicModule. * @description Retrieves single dynamicModule by id. */ get: { parameters: { query: { /** * @description The type of device making the request * @example PHONE */ deviceType: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV"; /** * @description The system type of the device making the request * @example IOS */ systemType: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB"; /** * @description Client version number * @example 2026.0.1 */ clientVersion: string; /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */ refreshSeed?: string; /** * @description ISO 3166-1 alpha-2 country code * @example US */ countryCode?: string; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: items, seedItem * @example items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items * @example items */ replaceMedia?: string; }; header?: never; path: { /** * @description DynamicModules Id * @example nejMcAhh5N8S3EQ4LaqysVdI0cZZ */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["DynamicModules_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dynamicModules/{id}/relationships/items": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get items relationship ("to-many"). * @description The module's items, in order — one stable collection per module, consistent for a given refreshSeed. Reads without a cursor return the first page (the slice a page shelf renders, sized for the module's previewLayout and device) with a continuation cursor; passing the cursor returns subsequent pages. */ get: { parameters: { query: { /** * @description The type of device making the request * @example PHONE */ deviceType: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV"; /** * @description The system type of the device making the request * @example IOS */ systemType: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB"; /** * @description Client version number * @example 2026.0.1 */ clientVersion: string; /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */ refreshSeed?: string; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description ISO 3166-1 alpha-2 country code * @example US */ countryCode?: string; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: items * @example items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items * @example items */ replaceMedia?: string; }; header?: never; path: { /** * @description DynamicModules Id * @example nejMcAhh5N8S3EQ4LaqysVdI0cZZ */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["DynamicModules_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dynamicModules/{id}/relationships/seedItem": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get seedItem relationship ("to-one"). * @description The item whose listen or add event seeded this module's collection (e.g. the album a BECAUSE_YOU_* module is based on); null for modules that are not seeded by an item. */ get: { parameters: { query: { /** * @description The type of device making the request * @example PHONE */ deviceType: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV"; /** * @description The system type of the device making the request * @example IOS */ systemType: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB"; /** * @description Client version number * @example 2026.0.1 */ clientVersion: string; /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */ refreshSeed?: string; /** * @description ISO 3166-1 alpha-2 country code * @example US */ countryCode?: string; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: seedItem * @example seedItem */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: seedItem * @example seedItem */ replaceMedia?: string; }; header?: never; path: { /** * @description DynamicModules Id * @example nejMcAhh5N8S3EQ4LaqysVdI0cZZ */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["DynamicModules_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dynamicPages": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple dynamicPages. * @description Retrieves multiple dynamicPages by available filters, or without if applicable. */ get: { parameters: { query: { /** * @description The type of device making the request * @example PHONE */ deviceType: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV"; /** * @description The system type of the device making the request * @example IOS */ systemType: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB"; /** * @description Client version number * @example 2026.0.1 */ clientVersion: string; /** @description type of the page (e.g. `ARTIST`) */ "filter[pageType]": string[]; /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */ refreshSeed?: string; /** * @description ISO 3166-1 alpha-2 country code * @example US */ countryCode?: string; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: modules, subject * @example modules.items */ include?: string[]; /** @description The subject resource ID. Required except for HOME_FREE, where it must be omitted. (e.g. `67890`) */ "filter[subject.id]"?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: modules.items * @example modules.items */ replaceMedia?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["DynamicPages_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dynamicPages/{id}/relationships/modules": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get modules relationship ("to-many"). * @description Retrieves modules relationship. */ get: { parameters: { query: { /** * @description The type of device making the request * @example PHONE */ deviceType: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV"; /** * @description The system type of the device making the request * @example IOS */ systemType: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB"; /** * @description Client version number * @example 2026.0.1 */ clientVersion: string; /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */ refreshSeed?: string; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description ISO 3166-1 alpha-2 country code * @example US */ countryCode?: string; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: modules * @example modules.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: modules.items * @example modules.items */ replaceMedia?: string; }; header?: never; path: { /** * @description DynamicPages Id * @example nejMcAhh5N8S3EQ4LaqysVdI0cZZ */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["DynamicPages_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dynamicPages/{id}/relationships/subject": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get subject relationship ("to-one"). * @description Retrieves subject relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: subject * @example subject */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: subject * @example subject */ replaceMedia?: string; }; header?: never; path: { /** * @description DynamicPages Id * @example nejMcAhh5N8S3EQ4LaqysVdI0cZZ */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["DynamicPages_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/genres": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple genres. * @description Retrieves multiple genres by available filters, or without if applicable. */ get: { parameters: { query: { /** @description Allows filtering by genre id(s). USER_SELECTABLE is special value used to return specific genres which users can select from (e.g. `'1,2,3' or 'USER_SELECTABLE'`) */ "filter[id]": string[]; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Genres_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/genres/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single genre. * @description Retrieves single genre by id. */ get: { parameters: { query?: { /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; }; header?: never; path: { /** * @description Genre id * @example 123 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Genres_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/installations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple installations. * @description Retrieves multiple installations by available filters, or without if applicable. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: offlineInventory, owners * @example offlineInventory */ include?: string[]; /** @description Client-provided installation identifier to filter by (e.g. `a468bee88def`) */ "filter[clientProvidedInstallationId]"?: string[]; /** @description User ID to filter by. Use `me` for the authenticated user */ "filter[owners.id]"?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: offlineInventory * @example offlineInventory */ replaceMedia?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Installations_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Create single installation. * @description Creates a new installation. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["InstallationsCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Installations_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/installations/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single installation. * @description Retrieves single installation by id. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: offlineInventory, owners * @example offlineInventory */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: offlineInventory * @example offlineInventory */ replaceMedia?: string; }; header?: never; path: { /** * @description Installation id * @example a468bee88def */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Installations_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/installations/{id}/relationships/offlineInventory": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get offlineInventory relationship ("to-many"). * @description Retrieves offlineInventory relationship. */ get: { parameters: { query: { /** @description One of: tracks, videos, albums, playlists, userCollectionTracks (e.g. `tracks`) */ "filter[type]": ("tracks" | "videos" | "albums" | "playlists" | "userCollectionTracks")[]; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: offlineInventory * @example offlineInventory */ include?: string[]; /** @description Offline item id (e.g. `1234`) */ "filter[id]"?: string[]; /** @description One of: PENDING, STORED, FAILED (e.g. `PENDING`) */ "filter[state]"?: ("PENDING" | "STORED" | "FAILED")[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: offlineInventory * @example offlineInventory */ replaceMedia?: string; }; header?: never; path: { /** * @description Installation id * @example a468bee88def */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Installations_OfflineInventory_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Add to offlineInventory relationship ("to-many"). * @description Adds item(s) to offlineInventory relationship. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Installation id * @example a468bee88def */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["InstallationsOfflineInventoryRelationshipAddOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; /** * Delete from offlineInventory relationship ("to-many"). * @description Deletes item(s) from offlineInventory relationship. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Installation id * @example a468bee88def */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["InstallationsOfflineInventoryRelationshipRemoveOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; patch?: never; trace?: never; }; "/installations/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 Installation id * @example a468bee88def */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Installations_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/lyrics": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create single lyric. * @description Creates a new lyric. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["LyricsCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Lyrics_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/lyrics/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single lyric. * @description Retrieves single lyric by id. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners, track * @example track */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: track * @example track */ replaceMedia?: string; }; header?: never; path: { /** * @description Lyrics Id * @example nejMcAhh5N8S3EQ4LaqysVdI0cZZ */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Lyrics_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; /** * Delete single lyric. * @description Deletes existing lyric. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Lyrics Id * @example nejMcAhh5N8S3EQ4LaqysVdI0cZZ */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; /** * Update single lyric. * @description Updates existing lyric. */ patch: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Lyrics Id * @example nejMcAhh5N8S3EQ4LaqysVdI0cZZ */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["LyricsUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/lyrics/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { 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: owners * @example owners */ 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 Lyrics Id * @example nejMcAhh5N8S3EQ4LaqysVdI0cZZ */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Lyrics_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/lyrics/{id}/relationships/track": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get track relationship ("to-one"). * @description Retrieves track relationship. */ get: { 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: track * @example track */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: track * @example track */ replaceMedia?: string; }; header?: never; path: { /** * @description Lyrics Id * @example nejMcAhh5N8S3EQ4LaqysVdI0cZZ */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Lyrics_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/manualArtistClaims": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create single manualArtistClaim. * @description Creates a new manualArtistClaim. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["ManualArtistClaimsCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ManualArtistClaims_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/offlineTasks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple offlineTasks. * @description Retrieves multiple offlineTasks by available filters, or without if applicable. */ get: { parameters: { query: { /** @description List of offline task IDs (e.g. `a468bee88def`) */ "filter[installation.id]": string[]; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: collection, item, owners * @example collection */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: collection * @example collection */ replaceMedia?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["OfflineTasks_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/offlineTasks/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single offlineTask. * @description Retrieves single offlineTask by id. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: collection, item, owners * @example collection */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: collection * @example collection */ replaceMedia?: string; }; header?: never; path: { /** * @description Offline task id * @example a468bee8-8def-4a1b-8c1e-123456789abc */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["OfflineTasks_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Update single offlineTask. * @description Updates existing offlineTask. */ patch: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Offline task id * @example a468bee8-8def-4a1b-8c1e-123456789abc */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["OfflineTasksUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/offlineTasks/{id}/relationships/collection": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get collection relationship ("to-one"). * @description Retrieves collection relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: collection * @example collection */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: collection * @example collection */ replaceMedia?: string; }; header?: never; path: { /** * @description Offline task id * @example a468bee8-8def-4a1b-8c1e-123456789abc */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["OfflineTasks_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/offlineTasks/{id}/relationships/item": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get item relationship ("to-one"). * @description Retrieves item relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: item * @example item */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: item * @example item */ replaceMedia?: string; }; header?: never; path: { /** * @description Offline task id * @example a468bee8-8def-4a1b-8c1e-123456789abc */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["OfflineTasks_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/offlineTasks/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 Offline task id * @example a468bee8-8def-4a1b-8c1e-123456789abc */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["OfflineTasks_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/playQueues": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple playQueues. * @description Retrieves multiple playQueues by available filters, or without if applicable. */ get: { parameters: { query: { /** @description User id. Use `me` for the authenticated user */ "filter[owners.id]": string[]; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: current, future, owners, past * @example current */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: current * @example current */ replaceMedia?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["PlayQueues_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Create single playQueue. * @description Creates a new playQueue. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["PlayQueuesCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["PlayQueues_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/playQueues/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single playQueue. * @description Retrieves single playQueue by id. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: current, future, owners, past * @example current */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: current * @example current */ replaceMedia?: string; }; header?: never; path: { /** * @description Play queue id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["PlayQueues_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; /** * Delete single playQueue. * @description Deletes existing playQueue. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Play queue id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; /** * Update single playQueue. * @description Updates existing playQueue. */ patch: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Play queue id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["PlayQueuesUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/playQueues/{id}/relationships/current": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get current relationship ("to-one"). * @description Retrieves current relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: current * @example current */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: current * @example current */ replaceMedia?: string; }; header?: never; path: { /** * @description Play queue id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["PlayQueues_Current_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Update current relationship ("to-one"). * @description Updates current relationship. */ patch: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Play queue id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["PlayQueuesCurrentRelationshipUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/playQueues/{id}/relationships/future": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get future relationship ("to-many"). * @description Retrieves future relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: future * @example future */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: future * @example future */ replaceMedia?: string; }; header?: never; path: { /** * @description Play queue id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["PlayQueues_Future_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Add to future relationship ("to-many"). * @description Adds item(s) to future relationship. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Play queue id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["PlayQueuesFutureRelationshipAddOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; /** * Delete from future relationship ("to-many"). * @description Deletes item(s) from future relationship. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Play queue id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["PlayQueuesFutureRelationshipRemoveOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; /** * Update future relationship ("to-many"). * @description Updates future relationship. */ patch: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Play queue id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["PlayQueuesFutureRelationshipUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/playQueues/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 Play queue id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["PlayQueues_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/playQueues/{id}/relationships/past": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get past relationship ("to-many"). * @description Retrieves past relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: past * @example past */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: past * @example past */ replaceMedia?: string; }; header?: never; path: { /** * @description Play queue id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["PlayQueues_Past_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/playlists": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple playlists. * @description Retrieves multiple playlists by available filters, or without if applicable. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */ sort?: ("createdAt" | "-createdAt" | "lastModifiedAt" | "-lastModifiedAt" | "name" | "-name")[]; /** * @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: collaboratorProfiles, collaborators, coverArt, items, ownerProfiles, owners, suggestedCoverArts * @example items */ include?: string[]; /** @description User id. Use `me` for the authenticated user */ "filter[collaborators.id]"?: string[]; /** @description List of playlist IDs (e.g. `550e8400-e29b-41d4-a716-446655440000`) */ "filter[id]"?: string[]; /** @description User id. Use `me` for the authenticated user */ "filter[owners.id]"?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items * @example items */ replaceMedia?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Playlists_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Create single playlist. * @description Creates a new playlist. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["PlaylistsCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Playlists_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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 Retrieves single playlist by id. */ get: { 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: collaboratorProfiles, collaborators, coverArt, items, ownerProfiles, owners, suggestedCoverArts * @example items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items * @example items */ replaceMedia?: string; }; header?: never; path: { /** * @description Playlist id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Playlists_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; /** * Delete single playlist. * @description Deletes existing playlist. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Playlist id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; /** * Update single playlist. * @description Updates existing playlist. */ patch: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Playlist id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["PlaylistsUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Playlists_Update_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/playlists/{id}/relationships/collaboratorProfiles": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get collaboratorProfiles relationship ("to-many"). * @description Retrieves collaboratorProfiles relationship. */ get: { 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: collaboratorProfiles * @example collaboratorProfiles */ 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 Playlist id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Playlists_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Add to collaboratorProfiles relationship ("to-many"). * @description Adds item(s) to collaboratorProfiles relationship. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Playlist id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["PlaylistsCollaboratorProfilesRelationshipAddOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; /** * Delete from collaboratorProfiles relationship ("to-many"). * @description Deletes item(s) from collaboratorProfiles relationship. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Playlist id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["PlaylistsCollaboratorProfilesRelationshipRemoveOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; patch?: never; trace?: never; }; "/playlists/{id}/relationships/collaborators": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get collaborators relationship ("to-many"). * @description Retrieves collaborators relationship. */ get: { 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: collaborators * @example collaborators */ 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 Playlist id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Playlists_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/playlists/{id}/relationships/coverArt": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get coverArt relationship ("to-many"). * @description Retrieves coverArt relationship. */ get: { 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: coverArt * @example coverArt */ 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 Playlist id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Playlists_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Update coverArt relationship ("to-many"). * @description Updates coverArt relationship. */ patch: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Playlist id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["PlaylistsCoverArtRelationshipUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/playlists/{id}/relationships/items": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get items relationship ("to-many"). * @description Retrieves items relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */ sort?: ("addedAt" | "-addedAt" | "albums.title" | "-albums.title" | "artists.name" | "-artists.name" | "duration" | "-duration" | "itemIndex" | "-itemIndex" | "title" | "-title")[]; /** * @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 Filter playlist items by a free-text query (e.g. `halo`) */ "filter[query]"?: string; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items * @example items */ replaceMedia?: string; }; header?: never; path: { /** * @description Playlist id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Playlists_Items_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Add to items relationship ("to-many"). * @description Adds item(s) to items relationship. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Playlist id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["PlaylistsItemsRelationshipAddOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Playlists_Items_Add_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; /** * Delete from items relationship ("to-many"). * @description Deletes item(s) from items relationship. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Playlist id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["PlaylistsItemsRelationshipRemoveOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; /** * Update items relationship ("to-many"). * @description Updates items relationship. */ patch: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Playlist id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["PlaylistsItemsRelationshipUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/playlists/{id}/relationships/ownerProfiles": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get ownerProfiles relationship ("to-many"). * @description Retrieves ownerProfiles relationship. */ get: { 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: ownerProfiles * @example ownerProfiles */ 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 Playlist id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Playlists_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { 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: owners * @example owners */ 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 Playlist id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Playlists_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/playlists/{id}/relationships/suggestedCoverArts": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get suggestedCoverArts relationship ("to-many"). * @description Retrieves suggestedCoverArts relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: suggestedCoverArts * @example suggestedCoverArts */ 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 Playlist id * @example 550e8400-e29b-41d4-a716-446655440000 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Playlists_SuggestedCoverArts_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/priceConfigurations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple priceConfigurations. * @description Retrieves multiple priceConfigurations by available filters, or without if applicable. */ get: { parameters: { query: { /** @description List of price configurations IDs (e.g. `cHJpY2UtY29uZmlnLTEyMzpVUw`) */ "filter[id]": string[]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["PriceConfigurations_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Create single priceConfiguration. * @description Creates a new priceConfiguration. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["PriceConfigurationsCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["PriceConfigurations_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/priceConfigurations/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single priceConfiguration. * @description Retrieves single priceConfiguration by id. */ get: { parameters: { query?: never; header?: never; path: { /** * @description Price configuration id * @example cHJpY2UtY29uZmlnLTEyMzpVUw */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["PriceConfigurations_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/providerOwners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple providerOwners. * @description Retrieves multiple providerOwners by available filters, or without if applicable. */ get: { parameters: { query: { /** @description User id. Use `me` for the authenticated user */ "filter[owners.id]": string[]; /** * @description Allows the client to customize which related resources should be returned. Available options: owners, provider * @example owners */ include?: string[]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ProviderOwners_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/providerOwners/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 Provider owner id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ProviderOwners_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/providerOwners/{id}/relationships/provider": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get provider relationship ("to-one"). * @description Retrieves provider relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: provider * @example provider */ include?: string[]; }; header?: never; path: { /** @description Provider owner id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ProviderOwners_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/providerProductInfos": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple providerProductInfos. * @description Retrieves multiple providerProductInfos by available filters, or without if applicable. */ get: { parameters: { query: { /** @description Content provider ID (e.g. `50`) */ "filter[provider.id]": string[]; /** * @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: provider, subject * @example subject */ include?: string[]; /** @description List of barcode IDs (EAN-13 or UPC-A) (e.g. `00602527336510`) */ "filter[barcodeId]"?: string[]; /** @description List of GRIDs (Global Release Identifier, ISO 7064) (e.g. `A10302B0013941653J`) */ "filter[grid]"?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: subject * @example subject */ replaceMedia?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ProviderProductInfos_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/providerProductInfos/{id}/relationships/provider": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get provider relationship ("to-one"). * @description Retrieves provider relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: provider * @example provider */ include?: string[]; }; header?: never; path: { /** @description Provider product info id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ProviderProductInfos_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/providerProductInfos/{id}/relationships/subject": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get subject relationship ("to-one"). * @description Retrieves subject relationship. */ get: { 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: subject * @example subject */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: subject * @example subject */ replaceMedia?: string; }; header?: never; path: { /** @description Provider product info id */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["ProviderProductInfos_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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 Retrieves single provider by id. */ get: { parameters: { query?: never; header?: never; path: { /** * @description Provider ID * @example 12345 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Providers_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/purchases": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple purchases. * @description Retrieves multiple purchases by available filters, or without if applicable. */ get: { parameters: { query: { /** @description User id. Use `me` for the authenticated user */ "filter[owners.id]": string[]; /** @description The type of purchased content (e.g. `albums`) */ "filter[subject.type]": ("albums" | "tracks")[]; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: owners, subject * @example subject */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: subject * @example subject */ replaceMedia?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Purchases_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/purchases/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 Purchase id * @example 3fG7kLmN2pQrStUv */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Purchases_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/purchases/{id}/relationships/subject": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get subject relationship ("to-one"). * @description Retrieves subject relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: subject * @example subject */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: subject * @example subject */ replaceMedia?: string; }; header?: never; path: { /** * @description Purchase id * @example 3fG7kLmN2pQrStUv */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Purchases_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/reactions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple reactions. * @description Retrieves multiple reactions by available filters, or without if applicable. */ get: { parameters: { query: { /** @description Filter by subject resource ID (e.g. `12345`) */ "filter[subject.id]": string[]; /** @description Filter by subject resource type (e.g. `albums`) */ "filter[subject.type]": ("albums" | "tracks" | "artists" | "videos" | "playlists" | "comments")[]; stats?: "ALL" | "COUNTS_BY_TYPE" | "TOTAL_COUNT"; statsOnly?: boolean; viewerContext?: string; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: ownerProfiles, owners * @example ownerProfiles */ include?: string[]; /** @description Filter by emoji (e.g. `👍`) */ "filter[emoji]"?: string[]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Reactions_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Create single reaction. * @description Creates a new reaction. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["ReactionsCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Reactions_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/reactions/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Delete single reaction. * @description Deletes existing reaction. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Reaction Id * @example nejMcAhh5N8S3EQ4LaqysVdI0cZZ */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; patch?: never; trace?: never; }; "/reactions/{id}/relationships/ownerProfiles": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get ownerProfiles relationship ("to-many"). * @description Retrieves ownerProfiles relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: ownerProfiles * @example ownerProfiles */ 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 Reaction Id * @example nejMcAhh5N8S3EQ4LaqysVdI0cZZ */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Reactions_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/reactions/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 Reaction Id * @example nejMcAhh5N8S3EQ4LaqysVdI0cZZ */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Reactions_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/savedShares": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create single savedShare. * @description Creates a new savedShare. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["SavedSharesCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SavedShares_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/scopes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple scopes. * @description Retrieves multiple scopes by available filters, or without if applicable. */ get: { parameters: { query: { /** @description Filters scopes by their `requiredAccessTier`. (e.g. `THIRD_PARTY`) */ "filter[requiredAccessTier]": ("THIRD_PARTY" | "THIRD_PARTY_PROD" | "PARTNER" | "INTERNAL")[]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Scopes_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/searchHistoryEntries/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Delete single searchHistoryEntrie. * @description Deletes existing searchHistoryEntrie. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Canonical opaque identifier for a user's exact saved history query. * @example 24HkRueBIeyGHPttoaQetVx4SwUxlzp3da06bqbwjF1t4dNXV */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; patch?: never; trace?: never; }; "/searchResults": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get search results by query. * @description Searches for a query and returns a collection containing exactly one search results resource. */ get: { parameters: { query: { /** @description Search query (e.g. `hello`) */ "filter[query]": string; /** * @description Explicit filter. Valid values: INCLUDE or EXCLUDE * @example INCLUDE */ explicitFilter?: "INCLUDE" | "EXCLUDE"; /** * @description ISO 3166-1 alpha-2 country code * @example US */ countryCode?: string; /** * @description The type of device making the request * @example PHONE */ deviceType?: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV"; /** * @description The system type of the device making the request * @example IOS */ systemType?: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB"; /** * @description Client version number * @example 2026.0.1 */ clientVersion?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: albums, artists, playlists, topHits, tracks, videos * @example albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: albums * @example albums */ replaceMedia?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SearchResults_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/searchResults/{id}/relationships/albums": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get albums relationship ("to-many"). * @description Retrieves albums relationship. */ get: { parameters: { query?: { /** * @description Explicit filter. Valid values: INCLUDE or EXCLUDE * @example INCLUDE */ explicitFilter?: "INCLUDE" | "EXCLUDE"; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description ISO 3166-1 alpha-2 country code * @example US */ countryCode?: string; /** * @description The type of device making the request * @example PHONE */ deviceType?: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV"; /** * @description The system type of the device making the request * @example IOS */ systemType?: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB"; /** * @description Client version number * @example 2026.0.1 */ clientVersion?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: albums * @example albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: albums * @example albums */ replaceMedia?: string; }; header?: never; path: { /** @description An opaque search results identifier */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SearchResults_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/searchResults/{id}/relationships/artists": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get artists relationship ("to-many"). * @description Retrieves artists relationship. */ get: { parameters: { query?: { /** * @description Explicit filter. Valid values: INCLUDE or EXCLUDE * @example INCLUDE */ explicitFilter?: "INCLUDE" | "EXCLUDE"; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description ISO 3166-1 alpha-2 country code * @example US */ countryCode?: string; /** * @description The type of device making the request * @example PHONE */ deviceType?: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV"; /** * @description The system type of the device making the request * @example IOS */ systemType?: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB"; /** * @description Client version number * @example 2026.0.1 */ clientVersion?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: artists * @example artists */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: artists * @example artists */ replaceMedia?: string; }; header?: never; path: { /** @description An opaque search results identifier */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SearchResults_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/searchResults/{id}/relationships/playlists": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get playlists relationship ("to-many"). * @description Retrieves playlists relationship. */ get: { parameters: { query?: { /** * @description Explicit filter. Valid values: INCLUDE or EXCLUDE * @example INCLUDE */ explicitFilter?: "INCLUDE" | "EXCLUDE"; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description ISO 3166-1 alpha-2 country code * @example US */ countryCode?: string; /** * @description The type of device making the request * @example PHONE */ deviceType?: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV"; /** * @description The system type of the device making the request * @example IOS */ systemType?: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB"; /** * @description Client version number * @example 2026.0.1 */ clientVersion?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: playlists * @example playlists */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: playlists * @example playlists */ replaceMedia?: string; }; header?: never; path: { /** @description An opaque search results identifier */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SearchResults_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/searchResults/{id}/relationships/topHits": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get topHits relationship ("to-many"). * @description Retrieves topHits relationship. */ get: { parameters: { query?: { /** * @description Explicit filter. Valid values: INCLUDE or EXCLUDE * @example INCLUDE */ explicitFilter?: "INCLUDE" | "EXCLUDE"; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description ISO 3166-1 alpha-2 country code * @example US */ countryCode?: string; /** * @description The type of device making the request * @example PHONE */ deviceType?: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV"; /** * @description The system type of the device making the request * @example IOS */ systemType?: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB"; /** * @description Client version number * @example 2026.0.1 */ clientVersion?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: topHits * @example topHits */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: topHits * @example topHits */ replaceMedia?: string; }; header?: never; path: { /** @description An opaque search results identifier */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SearchResults_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/searchResults/{id}/relationships/tracks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get tracks relationship ("to-many"). * @description Retrieves tracks relationship. */ get: { parameters: { query?: { /** * @description Explicit filter. Valid values: INCLUDE or EXCLUDE * @example INCLUDE */ explicitFilter?: "INCLUDE" | "EXCLUDE"; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description ISO 3166-1 alpha-2 country code * @example US */ countryCode?: string; /** * @description The type of device making the request * @example PHONE */ deviceType?: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV"; /** * @description The system type of the device making the request * @example IOS */ systemType?: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB"; /** * @description Client version number * @example 2026.0.1 */ clientVersion?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: tracks * @example tracks */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: tracks * @example tracks */ replaceMedia?: string; }; header?: never; path: { /** @description An opaque search results identifier */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SearchResults_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/searchResults/{id}/relationships/videos": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get videos relationship ("to-many"). * @description Retrieves videos relationship. */ get: { parameters: { query?: { /** * @description Explicit filter. Valid values: INCLUDE or EXCLUDE * @example INCLUDE */ explicitFilter?: "INCLUDE" | "EXCLUDE"; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description ISO 3166-1 alpha-2 country code * @example US */ countryCode?: string; /** * @description The type of device making the request * @example PHONE */ deviceType?: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV"; /** * @description The system type of the device making the request * @example IOS */ systemType?: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB"; /** * @description Client version number * @example 2026.0.1 */ clientVersion?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: videos * @example videos */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: videos * @example videos */ replaceMedia?: string; }; header?: never; path: { /** @description An opaque search results identifier */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SearchResults_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/searchSuggestions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get search suggestions by query. * @description Searches for a query and returns a collection containing exactly one search suggestions resource. */ get: { parameters: { query: { /** @description Search query (e.g. `hello`) */ "filter[query]": string; /** * @description Explicit filter. Valid values: INCLUDE or EXCLUDE * @example INCLUDE */ explicitFilter?: "INCLUDE" | "EXCLUDE"; /** * @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: directHits, history * @example directHits */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: directHits * @example directHits */ replaceMedia?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SearchSuggestions_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/searchSuggestions/{id}/relationships/directHits": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get directHits relationship ("to-many"). * @description Retrieves directHits relationship. */ get: { parameters: { query?: { /** * @description Explicit filter. Valid values: INCLUDE or EXCLUDE * @example INCLUDE */ explicitFilter?: "INCLUDE" | "EXCLUDE"; /** * @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: directHits * @example directHits */ include?: string[]; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: directHits * @example directHits */ replaceMedia?: string; }; header?: never; path: { /** @description An opaque search suggestions identifier */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SearchSuggestions_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/searchSuggestions/{id}/relationships/history": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get history relationship ("to-many"). * @description Retrieves history relationship. */ get: { parameters: { query?: { /** * @description Explicit filter. Valid values: INCLUDE or EXCLUDE * @example INCLUDE */ explicitFilter?: "INCLUDE" | "EXCLUDE"; /** * @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: history * @example history */ 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 An opaque search suggestions identifier */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SearchSuggestions_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/shares": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple shares. * @description Retrieves multiple shares by available filters, or without if applicable. */ get: { parameters: { query: { /** @description A share code (e.g. `xyz`) */ "filter[code]": string[]; /** * @description Allows the client to customize which related resources should be returned. Available options: owners, sharedResources * @example sharedResources */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: sharedResources * @example sharedResources */ replaceMedia?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Shares_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Create single share. * @description Creates a new share. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["SharesCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Shares_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/shares/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single share. * @description Retrieves single share by id. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners, sharedResources * @example sharedResources */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: sharedResources * @example sharedResources */ replaceMedia?: string; }; header?: never; path: { /** * @description User share id * @example a468bee88def */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Shares_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/shares/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 share id * @example a468bee88def */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Shares_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/shares/{id}/relationships/sharedResources": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get sharedResources relationship ("to-many"). * @description Retrieves sharedResources relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: sharedResources * @example sharedResources */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: sharedResources * @example sharedResources */ replaceMedia?: string; }; header?: never; path: { /** * @description User share id * @example a468bee88def */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Shares_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/squareConnections": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create single squareConnection. * @description Creates a new squareConnection. */ post: { parameters: { query?: { /** * @deprecated * @description ISO 3166-1 alpha-2 country code * @example US */ countryCode?: string; }; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["SquareConnectionsCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SquareConnections_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/squareConnections/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single squareConnection. * @description Retrieves single squareConnection by id. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: selectedSite, sites * @example selectedSite */ include?: string[]; }; header?: never; path: { /** * @description Square connection id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SquareConnections_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 403: components["responses"]["SquareConnectionsReadById403Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/squareConnections/{id}/relationships/selectedSite": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get selectedSite relationship ("to-one"). * @description Retrieves selectedSite relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: selectedSite * @example selectedSite */ include?: string[]; }; header?: never; path: { /** * @description Square connection id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SquareConnections_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 403: components["responses"]["SquareConnectionsReadSingleDataRelationship403Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Update selectedSite relationship ("to-one"). * @description Updates selectedSite relationship. */ patch: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Square connection id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["SquareConnectionsSelectedSiteRelationshipUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SquareConnections_SelectedSite_Update_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 403: components["responses"]["SquareConnectionsUpdateSingleDataRelationship403Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["SquareConnectionsUpdateSingleDataRelationship409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/squareConnections/{id}/relationships/sites": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get sites relationship ("to-many"). * @description Retrieves sites relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: sites * @example sites */ 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 Square connection id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SquareConnections_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 403: components["responses"]["SquareConnectionsReadMultiDataRelationship403Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/stripeConnections": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple stripeConnections. * @description Retrieves multiple stripeConnections by available filters, or without if applicable. */ get: { parameters: { query: { /** @description User id. Use `me` for the authenticated user */ "filter[owners.id]": string[]; /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ include?: string[]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["StripeConnections_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Create single stripeConnection. * @description Creates a new stripeConnection. */ post: { parameters: { query?: { /** * @description ISO 3166-1 alpha-2 country code * @example US */ countryCode?: string; }; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["StripeConnectionsCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["StripeConnections_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/stripeConnections/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 Stripe connection id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["StripeConnections_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/stripeDashboardLinks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple stripeDashboardLinks. * @description Retrieves multiple stripeDashboardLinks by available filters, or without if applicable. */ get: { parameters: { query: { /** @description User id. Use `me` for the authenticated user */ "filter[owners.id]": string[]; /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ include?: string[]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["StripeDashboardLinks_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/stripeDashboardLinks/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 Stripe dashboard link id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["StripeDashboardLinks_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/subscriptionPriceChangeDecisions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple subscriptionPriceChangeDecisions. * @description Retrieves multiple subscriptionPriceChangeDecisions by available filters, or without if applicable. */ get: { parameters: { query: { /** @description User id. Use `me` for the authenticated user */ "filter[owners.id]": string[]; /** * @description Allows the client to customize which related resources should be returned. Available options: priceChange * @example priceChange */ include?: string[]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisions_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Create single subscriptionPriceChangeDecision. * @description Creates a new subscriptionPriceChangeDecision. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisionsCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisions_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/subscriptionPriceChangeDecisions/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Update single subscriptionPriceChangeDecision. * @description Updates existing subscriptionPriceChangeDecision. */ patch: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Price change decision id * @example 1AC1yHZWFAFVjnFOn8XoXA */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisionsUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisions_Update_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/subscriptionPriceChangeDecisions/{id}/relationships/priceChange": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get priceChange relationship ("to-one"). * @description Retrieves priceChange relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: priceChange * @example priceChange */ include?: string[]; }; header?: never; path: { /** * @description Price change decision id * @example 1AC1yHZWFAFVjnFOn8XoXA */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisions_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/temporaryUserTokens": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create single temporaryUserToken. * @description Creates a new temporaryUserToken. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["TemporaryUserTokensCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["TemporaryUserTokens_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/temporaryUserTokens/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single temporaryUserToken. * @description Retrieves single temporaryUserToken by id. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ include?: string[]; }; header?: never; path: { /** * @description Temporary user token id * @example abc123 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["TemporaryUserTokens_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/temporaryUserTokens/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 Temporary user token id * @example abc123 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["TemporaryUserTokens_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/terms": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple terms. * @description Retrieves multiple terms by available filters, or without if applicable. */ get: { parameters: { query: { /** @description One of: DEVELOPER, UPLOAD_MARKETPLACE, MERCH_GUIDELINES (e.g. `DEVELOPER`) */ "filter[termsType]": ("DEVELOPER" | "UPLOAD_MARKETPLACE" | "MERCH_GUIDELINES")[]; /** @description Filter by countryCode */ "filter[countryCode]"?: string[]; /** @description Filter by isLatestVersion */ "filter[isLatestVersion]"?: string[]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Terms_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/terms/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single term. * @description Retrieves single term by id. */ get: { parameters: { query?: never; header?: never; path: { /** * @description Terms id * @example a468bee88def */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Terms_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/trackFiles/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single trackFile. * @description Retrieves single trackFile by id. */ get: { parameters: { query: { formats: ("HEAACV1" | "AACLC" | "FLAC" | "FLAC_HIRES" | "EAC3_JOC")[]; usage: "PLAYBACK" | "DOWNLOAD"; }; header?: never; path: { /** * @description Track file id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["TrackFiles_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 403: components["responses"]["TrackFilesReadById403Response"]; 404: components["responses"]["TrackFilesReadById404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/trackManifests/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single trackManifest. * @description Retrieves single trackManifest by id. */ get: { parameters: { query: { manifestType: "HLS" | "MPEG_DASH"; formats: ("HEAACV1" | "AACLC" | "FLAC" | "FLAC_HIRES" | "EAC3_JOC")[]; uriScheme: "HTTPS" | "DATA"; usage: "PLAYBACK" | "DOWNLOAD"; adaptive: boolean; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Track manifest id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["TrackManifests_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 403: components["responses"]["TrackManifestsReadById403Response"]; 404: components["responses"]["TrackManifestsReadById404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/trackSourceFiles": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create single trackSourceFile. * @description Create a track source file.

* The response contains a upload link that must be used to upload the actual content.

* The headers in the upload link response must be sent doing the actual upload. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["TrackSourceFilesCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["TrackSourceFiles_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/trackSourceFiles/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single trackSourceFile. * @description Retrieves single trackSourceFile by id. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ include?: string[]; }; header?: never; path: { /** * @description Track source file id * @example a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["TrackSourceFiles_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/trackSourceFiles/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 Track source file id * @example a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["TrackSourceFiles_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/trackStatistics/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single trackStatistic. * @description Retrieves single trackStatistic by id. */ get: { 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: owners * @example owners */ include?: string[]; }; header?: never; path: { /** * @description Track statistic id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["TrackStatistics_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/trackStatistics/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { 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: owners * @example owners */ 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 Track statistic id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["TrackStatistics_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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 Retrieves multiple tracks by available filters, or without if applicable. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */ sort?: ("createdAt" | "-createdAt" | "title" | "-title")[]; /** * @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, artists, credits, download, genres, lyrics, metadataStatus, owners, priceConfig, providers, radio, replacement, shares, similarTracks, sourceFile, suggestedTracks, trackStatistics, usageRules * @example albums */ include?: string[]; /** @description List of track IDs (e.g. `75413016`) */ "filter[id]"?: string[]; /** @description List of ISRCs. When a single ISRC is provided, pagination is supported and multiple tracks may be returned. When multiple ISRCs are provided, one track per ISRC is returned without pagination. (e.g. `QMJMT1701237`) */ "filter[isrc]"?: string[]; /** @description User id. Use `me` for the authenticated user */ "filter[owners.id]"?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: albums * @example albums */ replaceMedia?: string; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Tracks_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Create single track. * @description Creates a new track. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["TracksCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Tracks_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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 Retrieves single track by id. */ get: { 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, artists, credits, download, genres, lyrics, metadataStatus, owners, priceConfig, providers, radio, replacement, shares, similarTracks, sourceFile, suggestedTracks, trackStatistics, usageRules * @example albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: albums * @example albums */ replaceMedia?: string; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Track id * @example 75413016 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Tracks_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; /** * Delete single track. * @description Deletes existing track. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Track id * @example 75413016 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; /** * Update single track. * @description Updates existing track. */ patch: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Track id * @example 75413016 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["TracksUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/tracks/{id}/relationships/albums": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get albums relationship ("to-many"). * @description Retrieves albums relationship. */ get: { 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; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: albums * @example albums */ replaceMedia?: string; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Track id * @example 75413016 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Tracks_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Update albums relationship ("to-many"). * @description Updates albums relationship. */ patch: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Track id * @example 75413016 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["TracksAlbumsRelationshipUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/tracks/{id}/relationships/artists": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get artists relationship ("to-many"). * @description Retrieves artists relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @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.albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: artists.albums * @example artists.albums */ replaceMedia?: string; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Track id * @example 75413016 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Tracks_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tracks/{id}/relationships/credits": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get credits relationship ("to-many"). * @description Retrieves credits relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: credits * @example credits.artist.albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: credits.artist.albums * @example credits.artist.albums */ replaceMedia?: string; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Track id * @example 75413016 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Tracks_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tracks/{id}/relationships/download": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get download relationship ("to-one"). * @description Retrieves download relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: download * @example download */ include?: string[]; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Track id * @example 75413016 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Tracks_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tracks/{id}/relationships/genres": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get genres relationship ("to-many"). * @description Retrieves genres relationship. */ get: { 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: genres * @example genres */ include?: string[]; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Track id * @example 75413016 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Tracks_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tracks/{id}/relationships/lyrics": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get lyrics relationship ("to-many"). * @description Retrieves lyrics relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: lyrics * @example lyrics.track */ include?: string[]; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: lyrics.track * @example lyrics.track */ replaceMedia?: string; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Track id * @example 75413016 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Tracks_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tracks/{id}/relationships/metadataStatus": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get metadataStatus relationship ("to-one"). * @description Retrieves metadataStatus relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: metadataStatus * @example metadataStatus */ include?: string[]; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Track id * @example 75413016 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Tracks_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tracks/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { 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: owners * @example owners */ include?: string[]; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Track id * @example 75413016 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Tracks_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tracks/{id}/relationships/priceConfig": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get priceConfig relationship ("to-one"). * @description Retrieves priceConfig relationship. */ get: { 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: priceConfig * @example priceConfig */ include?: string[]; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Track id * @example 75413016 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Tracks_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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; }; /** * Get providers relationship ("to-many"). * @description Retrieves providers relationship. */ get: { 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; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Track id * @example 75413016 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Tracks_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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; }; /** * Get radio relationship ("to-many"). * @description Retrieves radio relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: radio * @example radio.items */ include?: string[]; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: radio.items * @example radio.items */ replaceMedia?: string; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Track id * @example 75413016 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Tracks_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tracks/{id}/relationships/replacement": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get replacement relationship ("to-one"). * @description Retrieves replacement relationship. */ get: { 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: replacement * @example replacement */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: replacement * @example replacement */ replaceMedia?: string; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Track id * @example 75413016 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Tracks_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tracks/{id}/relationships/shares": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get shares relationship ("to-many"). * @description Retrieves shares relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: shares * @example shares.sharedResources */ include?: string[]; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: shares.sharedResources * @example shares.sharedResources */ replaceMedia?: string; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Track id * @example 75413016 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Tracks_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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; }; /** * Get similarTracks relationship ("to-many"). * @description Retrieves similarTracks relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @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 Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: similarTracks * @example similarTracks */ replaceMedia?: string; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Track id * @example 75413016 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Tracks_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tracks/{id}/relationships/sourceFile": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get sourceFile relationship ("to-one"). * @description Retrieves sourceFile relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: sourceFile * @example sourceFile */ include?: string[]; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Track id * @example 75413016 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Tracks_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tracks/{id}/relationships/suggestedTracks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get suggestedTracks relationship ("to-many"). * @description Retrieves suggestedTracks relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @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: suggestedTracks * @example suggestedTracks */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: suggestedTracks * @example suggestedTracks */ replaceMedia?: string; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Track id * @example 75413016 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Tracks_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tracks/{id}/relationships/trackStatistics": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get trackStatistics relationship ("to-one"). * @description Retrieves trackStatistics relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: trackStatistics * @example trackStatistics */ include?: string[]; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Track id * @example 75413016 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Tracks_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tracks/{id}/relationships/usageRules": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get usageRules relationship ("to-one"). * @description Retrieves usageRules relationship. */ get: { 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: usageRules * @example usageRules */ include?: string[]; /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */ shareCode?: string; }; header?: never; path: { /** * @description Track id * @example 75413016 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Tracks_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tracksMetadataStatus/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single tracksMetadataStatu. * @description Retrieves single tracksMetadataStatu by id. */ get: { parameters: { query?: never; header?: never; path: { /** * @description Tracks metadata status id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["TracksMetadataStatus_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/usageRules": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create single usageRule. * @description Creates a new usageRule. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UsageRulesCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UsageRules_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/usageRules/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single usageRule. * @description Retrieves single usageRule by id. */ get: { parameters: { query?: never; header?: never; path: { /** * @description Usage rules id * @example VFJBQ0tTOjEyMzpOTw */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UsageRules_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollectionAlbums/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single userCollectionAlbum. * @description Retrieves single userCollectionAlbum by id. */ get: { parameters: { query?: { /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: items, owners * @example items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items * @example items */ replaceMedia?: string; }; header?: never; path: { /** * @description User collection albums id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionAlbums_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollectionAlbums/{id}/relationships/items": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get items relationship ("to-many"). * @description Retrieves items relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */ sort?: ("addedAt" | "-addedAt" | "artists.name" | "-artists.name" | "releaseDate" | "-releaseDate" | "title" | "-title")[]; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: items * @example items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items * @example items */ replaceMedia?: string; }; header?: never; path: { /** * @description User collection albums id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionAlbums_Items_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Add to items relationship ("to-many"). * @description Adds item(s) to items relationship. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User collection albums id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionAlbumsItemsRelationshipAddOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionAlbums_Items_Add_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["UserCollectionAlbumsAddMultiDataRelationshipWithResponse409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; /** * Delete from items relationship ("to-many"). * @description Deletes item(s) from items relationship. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User collection albums id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionAlbumsItemsRelationshipRemoveOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollectionAlbums/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 collection albums id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionAlbums_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollectionArtists/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single userCollectionArtist. * @description Retrieves single userCollectionArtist by id. */ get: { parameters: { query?: { /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: items, owners * @example items.albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items.albums * @example items.albums */ replaceMedia?: string; }; header?: never; path: { /** * @description User collection artists id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionArtists_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollectionArtists/{id}/relationships/items": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get items relationship ("to-many"). * @description Retrieves items relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */ sort?: ("addedAt" | "-addedAt" | "name" | "-name")[]; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: items * @example items.albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items.albums * @example items.albums */ replaceMedia?: string; }; header?: never; path: { /** * @description User collection artists id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionArtists_Items_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Add to items relationship ("to-many"). * @description Adds item(s) to items relationship. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User collection artists id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionArtistsItemsRelationshipAddOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionArtists_Items_Add_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["UserCollectionArtistsAddMultiDataRelationshipWithResponse409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; /** * Delete from items relationship ("to-many"). * @description Deletes item(s) from items relationship. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User collection artists id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionArtistsItemsRelationshipRemoveOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollectionArtists/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 collection artists id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionArtists_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollectionFolders": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple userCollectionFolders. * @description Retrieves multiple userCollectionFolders by available filters, or without if applicable. */ get: { parameters: { query: { /** @description Folder Id (e.g. `CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX`) */ "filter[id]": string[]; /** * @description Allows the client to customize which related resources should be returned. Available options: items, owners, userCollection * @example items.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items.items * @example items.items */ replaceMedia?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionFolders_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Create single userCollectionFolder. * @description Creates a new userCollectionFolder. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionFoldersCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionFolders_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollectionFolders/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single userCollectionFolder. * @description Retrieves single userCollectionFolder by id. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: items, owners, userCollection * @example items.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items.items * @example items.items */ replaceMedia?: string; }; header?: never; path: { /** * @description Folder Id * @example CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionFolders_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; /** * Delete single userCollectionFolder. * @description Deletes existing userCollectionFolder. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Folder Id * @example CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["UserCollectionFoldersDeleteResource400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; /** * Update single userCollectionFolder. * @description Updates existing userCollectionFolder. */ patch: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Folder Id * @example CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionFoldersUpdateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; trace?: never; }; "/userCollectionFolders/{id}/relationships/items": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get items relationship ("to-many"). * @description Retrieves items relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */ sort?: ("addedAt" | "-addedAt" | "lastModifiedAt" | "-lastModifiedAt" | "name" | "-name")[]; /** * @description Allows the client to customize which related resources should be returned. Available options: items * @example items.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items.items * @example items.items */ replaceMedia?: string; }; header?: never; path: { /** * @description Folder Id * @example CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionFolders_Items_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Add to items relationship ("to-many"). * @description Adds item(s) to items relationship. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Folder Id * @example CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionFoldersItemsRelationshipAddOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; /** * Delete from items relationship ("to-many"). * @description Deletes item(s) from items relationship. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description Folder Id * @example CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionFoldersItemsRelationshipRemoveOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollectionFolders/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 Folder Id * @example CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionFolders_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollectionFolders/{id}/relationships/userCollection": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get userCollection relationship ("to-one"). * @description Retrieves userCollection relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: userCollection * @example userCollection.items.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: userCollection.items.items * @example userCollection.items.items */ replaceMedia?: string; }; header?: never; path: { /** * @description Folder Id * @example CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionFolders_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollectionPlaylists/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single userCollectionPlaylist. * @description Retrieves single userCollectionPlaylist by id. */ get: { parameters: { query?: { /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: items, owners * @example items.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items.items * @example items.items */ replaceMedia?: string; }; header?: never; path: { /** * @description User collection playlists id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionPlaylists_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollectionPlaylists/{id}/relationships/items": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get items relationship ("to-many"). * @description Retrieves items relationship. */ get: { parameters: { query?: { collectionView?: "FLAT" | "FOLDERS"; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */ sort?: ("addedAt" | "-addedAt" | "lastModifiedAt" | "-lastModifiedAt" | "name" | "-name")[]; /** * @description Allows the client to customize which related resources should be returned. Available options: items * @example items.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items.items * @example items.items */ replaceMedia?: string; }; header?: never; path: { /** * @description User collection playlists id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionPlaylists_Items_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Add to items relationship ("to-many"). * @description Adds item(s) to items relationship. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User collection playlists id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionPlaylistsItemsRelationshipAddOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionPlaylists_Items_Add_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["UserCollectionPlaylistsAddMultiDataRelationshipWithResponse409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; /** * Delete from items relationship ("to-many"). * @description Deletes item(s) from items relationship. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User collection playlists id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionPlaylistsItemsRelationshipRemoveOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollectionPlaylists/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 collection playlists id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionPlaylists_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollectionSaveForLaters/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single userCollectionSaveForLater. * @description Retrieves single userCollectionSaveForLater by id. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: items, owners * @example items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items * @example items */ replaceMedia?: string; }; header?: never; path: { /** * @description User collection save for later id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionSaveForLaters_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollectionSaveForLaters/{id}/relationships/items": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get items relationship ("to-many"). * @description Retrieves items relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: items * @example items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items * @example items */ replaceMedia?: string; }; header?: never; path: { /** * @description User collection save for later id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionSaveForLaters_Items_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Add to items relationship ("to-many"). * @description Adds item(s) to items relationship. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User collection save for later id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionSaveForLatersItemsRelationshipAddOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionSaveForLaters_Items_Add_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["UserCollectionSaveForLatersAddMultiDataRelationshipWithResponse409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; /** * Delete from items relationship ("to-many"). * @description Deletes item(s) from items relationship. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User collection save for later id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionSaveForLatersItemsRelationshipRemoveOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollectionSaveForLaters/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 collection save for later id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionSaveForLaters_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollectionTracks/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single userCollectionTrack. * @description Retrieves single userCollectionTrack by id. */ get: { parameters: { query?: { /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: items, owners * @example items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items * @example items */ replaceMedia?: string; }; header?: never; path: { /** * @description User collection tracks id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionTracks_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollectionTracks/{id}/relationships/items": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get items relationship ("to-many"). * @description Retrieves items relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */ sort?: ("addedAt" | "-addedAt" | "albums.title" | "-albums.title" | "artists.name" | "-artists.name" | "duration" | "-duration" | "title" | "-title")[]; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: items * @example items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items * @example items */ replaceMedia?: string; }; header?: never; path: { /** * @description User collection tracks id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionTracks_Items_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Add to items relationship ("to-many"). * @description Adds item(s) to items relationship. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User collection tracks id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionTracksItemsRelationshipAddOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionTracks_Items_Add_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["UserCollectionTracksAddMultiDataRelationshipWithResponse409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; /** * Delete from items relationship ("to-many"). * @description Deletes item(s) from items relationship. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User collection tracks id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionTracksItemsRelationshipRemoveOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollectionTracks/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 collection tracks id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionTracks_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollectionVideos/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single userCollectionVideo. * @description Retrieves single userCollectionVideo by id. */ get: { parameters: { query?: { /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: items, owners * @example items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items * @example items */ replaceMedia?: string; }; header?: never; path: { /** * @description User collection videos id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionVideos_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollectionVideos/{id}/relationships/items": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get items relationship ("to-many"). * @description Retrieves items relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */ sort?: ("addedAt" | "-addedAt" | "artists.name" | "-artists.name" | "duration" | "-duration" | "title" | "-title")[]; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: items * @example items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items * @example items */ replaceMedia?: string; }; header?: never; path: { /** * @description User collection videos id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionVideos_Items_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Add to items relationship ("to-many"). * @description Adds item(s) to items relationship. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User collection videos id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionVideosItemsRelationshipAddOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionVideos_Items_Add_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["UserCollectionVideosAddMultiDataRelationshipWithResponse409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; /** * Delete from items relationship ("to-many"). * @description Deletes item(s) from items relationship. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User collection videos id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionVideosItemsRelationshipRemoveOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollectionVideos/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 collection videos id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionVideos_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollections/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single userCollection. * @deprecated * @description Deprecated. Use the dedicated collection resources instead: userCollectionAlbums, userCollectionArtists, userCollectionTracks, userCollectionVideos, or userCollectionPlaylists. */ get: { parameters: { query?: { /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: albums, artists, owners, playlists, tracks, videos * @example albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: albums * @example albums */ replaceMedia?: string; }; header?: never; path: { /** * @description User collection id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollections_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollections/{id}/relationships/albums": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get albums relationship ("to-many"). * @deprecated * @description Deprecated. Use the userCollectionAlbums resource and its items relationship instead. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */ sort?: ("albums.addedAt" | "-albums.addedAt" | "albums.artists.name" | "-albums.artists.name" | "albums.releaseDate" | "-albums.releaseDate" | "albums.title" | "-albums.title")[]; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: albums * @example albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: albums * @example albums */ replaceMedia?: string; }; header?: never; path: { /** * @description User collection id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollections_Albums_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Add to albums relationship ("to-many"). * @deprecated * @description Deprecated. Use the userCollectionAlbums resource and its items relationship instead. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User collection id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionsAlbumsRelationshipAddOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["UserCollectionsAddMultiDataRelationship409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; /** * Delete from albums relationship ("to-many"). * @deprecated * @description Deprecated. Use the userCollectionAlbums resource and its items relationship instead. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User collection id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionsAlbumsRelationshipRemoveOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollections/{id}/relationships/artists": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get artists relationship ("to-many"). * @deprecated * @description Deprecated. Use the userCollectionArtists resource and its items relationship instead. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */ sort?: ("artists.addedAt" | "-artists.addedAt" | "artists.name" | "-artists.name")[]; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: artists * @example artists.albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: artists.albums * @example artists.albums */ replaceMedia?: string; }; header?: never; path: { /** * @description User collection id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollections_Artists_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Add to artists relationship ("to-many"). * @deprecated * @description Deprecated. Use the userCollectionArtists resource and its items relationship instead. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User collection id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionsArtistsRelationshipAddOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["UserCollectionsAddMultiDataRelationship409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; /** * Delete from artists relationship ("to-many"). * @deprecated * @description Deprecated. Use the userCollectionArtists resource and its items relationship instead. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User collection id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionsArtistsRelationshipRemoveOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollections/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @deprecated * @description Deprecated. Use the owners relationship on the dedicated collection resources instead: userCollectionAlbums, userCollectionArtists, userCollectionTracks, userCollectionVideos, or userCollectionPlaylists. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 collection id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollections_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollections/{id}/relationships/playlists": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get playlists relationship ("to-many"). * @deprecated * @description Deprecated. Use the userCollectionPlaylists resource and its items relationship instead. */ get: { parameters: { query?: { collectionView?: "FOLDERS"; /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */ sort?: ("playlists.addedAt" | "-playlists.addedAt" | "playlists.lastUpdatedAt" | "-playlists.lastUpdatedAt" | "playlists.name" | "-playlists.name")[]; /** * @description Allows the client to customize which related resources should be returned. Available options: playlists * @example playlists.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: playlists.items * @example playlists.items */ replaceMedia?: string; }; header?: never; path: { /** * @description User collection id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollections_Playlists_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Add to playlists relationship ("to-many"). * @deprecated * @description Deprecated. Use the userCollectionPlaylists resource and its items relationship instead. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User collection id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionsPlaylistsRelationshipAddOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["UserCollectionsAddMultiDataRelationship409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; /** * Delete from playlists relationship ("to-many"). * @deprecated * @description Deprecated. Use the userCollectionPlaylists resource and its items relationship instead. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User collection id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionsPlaylistsRelationshipRemoveOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollections/{id}/relationships/tracks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get tracks relationship ("to-many"). * @deprecated * @description Deprecated. Use the userCollectionTracks resource and its items relationship instead. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */ sort?: ("tracks.addedAt" | "-tracks.addedAt" | "tracks.albums.title" | "-tracks.albums.title" | "tracks.artists.name" | "-tracks.artists.name" | "tracks.duration" | "-tracks.duration" | "tracks.title" | "-tracks.title")[]; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: tracks * @example tracks */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: tracks * @example tracks */ replaceMedia?: string; }; header?: never; path: { /** * @description User collection id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollections_Tracks_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Add to tracks relationship ("to-many"). * @deprecated * @description Deprecated. Use the userCollectionTracks resource and its items relationship instead. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User collection id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionsTracksRelationshipAddOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["UserCollectionsAddMultiDataRelationship409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; /** * Delete from tracks relationship ("to-many"). * @deprecated * @description Deprecated. Use the userCollectionTracks resource and its items relationship instead. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User collection id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionsTracksRelationshipRemoveOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; patch?: never; trace?: never; }; "/userCollections/{id}/relationships/videos": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get videos relationship ("to-many"). * @deprecated * @description Deprecated. Use the userCollectionVideos resource and its items relationship instead. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */ sort?: ("videos.addedAt" | "-videos.addedAt" | "videos.artists.name" | "-videos.artists.name" | "videos.duration" | "-videos.duration" | "videos.title" | "-videos.title")[]; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: videos * @example videos */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: videos * @example videos */ replaceMedia?: string; }; header?: never; path: { /** * @description User collection id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollections_Videos_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Add to videos relationship ("to-many"). * @deprecated * @description Deprecated. Use the userCollectionVideos resource and its items relationship instead. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User collection id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionsVideosRelationshipAddOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["UserCollectionsAddMultiDataRelationship409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; /** * Delete from videos relationship ("to-many"). * @deprecated * @description Deprecated. Use the userCollectionVideos resource and its items relationship instead. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User collection id * @example 123456 */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserCollectionsVideosRelationshipRemoveOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; patch?: never; trace?: never; }; "/userDailyMixes/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single userDailyMixe. * @description Retrieves single userDailyMixe by id. */ get: { parameters: { query?: { /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: items * @example items.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items.items * @example items.items */ replaceMedia?: string; }; header?: never; path: { /** * @description User daily mixes id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserDailyMixes_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userDailyMixes/{id}/relationships/items": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get items relationship ("to-many"). * @description Retrieves items relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: items * @example items.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items.items * @example items.items */ replaceMedia?: string; }; header?: never; path: { /** * @description User daily mixes id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserDailyMixes_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userDataExportRequests": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create single userDataExportRequest. * @description Creates a new userDataExportRequest. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserDataExportRequestsCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserDataExportRequests_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userDiscoveryMixes/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single userDiscoveryMixe. * @description Retrieves single userDiscoveryMixe by id. */ get: { parameters: { query?: { /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: items * @example items.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items.items * @example items.items */ replaceMedia?: string; }; header?: never; path: { /** * @description User discovery mixes id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserDiscoveryMixes_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userDiscoveryMixes/{id}/relationships/items": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get items relationship ("to-many"). * @description Retrieves items relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: items * @example items.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items.items * @example items.items */ replaceMedia?: string; }; header?: never; path: { /** * @description User discovery mixes id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserDiscoveryMixes_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userNewReleaseMixes/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single userNewReleaseMixe. * @description Retrieves single userNewReleaseMixe by id. */ get: { parameters: { query?: { /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: items * @example items.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items.items * @example items.items */ replaceMedia?: string; }; header?: never; path: { /** * @description User new release mixes id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserNewReleaseMixes_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userNewReleaseMixes/{id}/relationships/items": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get items relationship ("to-many"). * @description Retrieves items relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: items * @example items.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items.items * @example items.items */ replaceMedia?: string; }; header?: never; path: { /** * @description User new release mixes id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserNewReleaseMixes_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userOfflineMixes/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single userOfflineMixe. * @description Retrieves single userOfflineMixe by id. */ get: { parameters: { query?: { /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: items * @example items.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items.items * @example items.items */ replaceMedia?: string; }; header?: never; path: { /** * @description User offline mixes id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserOfflineMixes_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userOfflineMixes/{id}/relationships/items": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get items relationship ("to-many"). * @description Retrieves items relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: items * @example items.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items.items * @example items.items */ replaceMedia?: string; }; header?: never; path: { /** * @description User offline mixes id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserOfflineMixes_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userRecommendationBlocks/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single userRecommendationBlock. * @description Retrieves single userRecommendationBlock by id. */ get: { parameters: { query?: { /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: artists, owners, tracks, videos * @example artists.albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: artists.albums * @example artists.albums */ replaceMedia?: string; }; header?: never; path: { /** * @description User recommendation blocks id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserRecommendationBlocks_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userRecommendationBlocks/{id}/relationships/artists": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get artists relationship ("to-many"). * @description Retrieves artists relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: artists * @example artists.albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: artists.albums * @example artists.albums */ replaceMedia?: string; }; header?: never; path: { /** * @description User recommendation blocks id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserRecommendationBlocks_Artists_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Add to artists relationship ("to-many"). * @description Adds item(s) to artists relationship. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User recommendation blocks id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserRecommendationBlocksArtistsRelationshipAddOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserRecommendationBlocks_Artists_Add_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["UserRecommendationBlocksAddMultiDataRelationshipWithResponse409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; /** * Delete from artists relationship ("to-many"). * @description Deletes item(s) from artists relationship. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User recommendation blocks id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserRecommendationBlocksArtistsRelationshipRemoveOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; patch?: never; trace?: never; }; "/userRecommendationBlocks/{id}/relationships/owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get owners relationship ("to-many"). * @description Retrieves owners relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: owners * @example owners */ 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 recommendation blocks id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserRecommendationBlocks_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userRecommendationBlocks/{id}/relationships/tracks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get tracks relationship ("to-many"). * @description Retrieves tracks relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: tracks * @example tracks */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: tracks * @example tracks */ replaceMedia?: string; }; header?: never; path: { /** * @description User recommendation blocks id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserRecommendationBlocks_Tracks_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Add to tracks relationship ("to-many"). * @description Adds item(s) to tracks relationship. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User recommendation blocks id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserRecommendationBlocksTracksRelationshipAddOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserRecommendationBlocks_Tracks_Add_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["UserRecommendationBlocksAddMultiDataRelationshipWithResponse409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; /** * Delete from tracks relationship ("to-many"). * @description Deletes item(s) from tracks relationship. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User recommendation blocks id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserRecommendationBlocksTracksRelationshipRemoveOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; patch?: never; trace?: never; }; "/userRecommendationBlocks/{id}/relationships/videos": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get videos relationship ("to-many"). * @description Retrieves videos relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: videos * @example videos */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: videos * @example videos */ replaceMedia?: string; }; header?: never; path: { /** * @description User recommendation blocks id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserRecommendationBlocks_Videos_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; /** * Add to videos relationship ("to-many"). * @description Adds item(s) to videos relationship. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User recommendation blocks id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserRecommendationBlocksVideosRelationshipAddOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserRecommendationBlocks_Videos_Add_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["UserRecommendationBlocksAddMultiDataRelationshipWithResponse409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; /** * Delete from videos relationship ("to-many"). * @description Deletes item(s) from videos relationship. */ delete: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path: { /** * @description User recommendation blocks id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserRecommendationBlocksVideosRelationshipRemoveOperation_Payload"]; }; }; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Mutation_Response_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; options?: never; head?: never; patch?: never; trace?: never; }; "/userRecommendations/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single userRecommendation. * @deprecated * @description Deprecated. Use the dedicated mix resources instead: userDiscoveryMixes, userDailyMixes, userNewReleaseMixes, or userOfflineMixes. */ get: { parameters: { query?: { /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: discoveryMixes, myMixes, newArrivalMixes, offlineMixes * @example discoveryMixes.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: discoveryMixes.items * @example discoveryMixes.items */ replaceMedia?: string; }; header?: never; path: { /** * @description User recommendations id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserRecommendations_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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; }; /** * Get discoveryMixes relationship ("to-many"). * @deprecated * @description Deprecated. Use the userDiscoveryMixes resource and its items relationship instead. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: discoveryMixes * @example discoveryMixes.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: discoveryMixes.items * @example discoveryMixes.items */ replaceMedia?: string; }; header?: never; path: { /** * @description User recommendations id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserRecommendations_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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; }; /** * Get myMixes relationship ("to-many"). * @deprecated * @description Deprecated. Use the userDailyMixes resource and its items relationship instead. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: myMixes * @example myMixes.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: myMixes.items * @example myMixes.items */ replaceMedia?: string; }; header?: never; path: { /** * @description User recommendations id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserRecommendations_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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; }; /** * Get newArrivalMixes relationship ("to-many"). * @deprecated * @description Deprecated. Use the userNewReleaseMixes resource and its items relationship instead. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: newArrivalMixes * @example newArrivalMixes.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: newArrivalMixes.items * @example newArrivalMixes.items */ replaceMedia?: string; }; header?: never; path: { /** * @description User recommendations id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserRecommendations_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userRecommendations/{id}/relationships/offlineMixes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get offlineMixes relationship ("to-many"). * @deprecated * @description Deprecated. Use the userOfflineMixes resource and its items relationship instead. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported. * @example en-US */ locale?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: offlineMixes * @example offlineMixes.items */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: offlineMixes.items * @example offlineMixes.items */ replaceMedia?: string; }; header?: never; path: { /** * @description User recommendations id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserRecommendations_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userReports": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create single userReport. * @description Creates a new userReport. */ post: { parameters: { query?: never; header?: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"]; }; path?: never; cookie?: never; }; requestBody?: { content: { "application/vnd.api+json": components["schemas"]["UserReportsCreateOperation_Payload"]; }; }; responses: { /** @description Successful response */ 201: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserReports_Create_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 409: components["responses"]["Idempotency409Response"]; 415: components["responses"]["Default415Response"]; 422: components["responses"]["Idempotency422Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userSubscriptionPriceChanges": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple userSubscriptionPriceChanges. * @description Retrieves multiple userSubscriptionPriceChanges by available filters, or without if applicable. */ get: { parameters: { query: { /** @description User id. Use `me` for the authenticated user */ "filter[owners.id]": string[]; /** * @description Allows the client to customize which related resources should be returned. Available options: decision * @example decision */ include?: string[]; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserSubscriptionPriceChanges_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/userSubscriptionPriceChanges/{id}/relationships/decision": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get decision relationship ("to-one"). * @description Retrieves decision relationship. */ get: { parameters: { query?: { /** * @description Allows the client to customize which related resources should be returned. Available options: decision * @example decision */ include?: string[]; }; header?: never; path: { /** * @description Price change id * @example 1AC1yHZWFAFVjnFOn8XoXA */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserSubscriptionPriceChanges_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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 single user. * @description Retrieves single user by id. */ get: { parameters: { query?: never; header?: never; path: { /** * @description User id. Use `me` for the authenticated user's resource * @example me */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Users_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/videoManifests/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get single videoManifest. * @description Retrieves single videoManifest by id. */ get: { parameters: { query: { uriScheme: "HTTPS" | "DATA"; usage: "PLAYBACK" | "DOWNLOAD"; }; header?: never; path: { /** * @description Video manifest id * @example 75623239 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["VideoManifests_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 403: components["responses"]["VideoManifestsReadById403Response"]; 404: components["responses"]["VideoManifestsReadById404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/videos": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get multiple videos. * @description Retrieves multiple videos by available filters, or without if applicable. */ get: { 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, artists, credits, providers, replacement, similarVideos, suggestedVideos, thumbnailArt, usageRules * @example albums */ include?: string[]; /** @description List of video IDs (e.g. `75623239`) */ "filter[id]"?: string[]; /** @description List of ISRCs (e.g. `QMJMT1701237`) */ "filter[isrc]"?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: albums * @example albums */ replaceMedia?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Videos_Multi_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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 Retrieves single video by id. */ get: { 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, artists, credits, providers, replacement, similarVideos, suggestedVideos, thumbnailArt, usageRules * @example albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: albums * @example albums */ replaceMedia?: string; }; header?: never; path: { /** * @description Video id * @example 75623239 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Videos_Single_Resource_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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; }; /** * Get albums relationship ("to-many"). * @description Retrieves albums relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @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 Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: albums * @example albums */ replaceMedia?: string; }; header?: never; path: { /** * @description Video id * @example 75623239 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Videos_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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; }; /** * Get artists relationship ("to-many"). * @description Retrieves artists relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @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.albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: artists.albums * @example artists.albums */ replaceMedia?: string; }; header?: never; path: { /** * @description Video id * @example 75623239 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Videos_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/videos/{id}/relationships/credits": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get credits relationship ("to-many"). * @description Retrieves credits relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @description Allows the client to customize which related resources should be returned. Available options: credits * @example credits.artist.albums */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: credits.artist.albums * @example credits.artist.albums */ replaceMedia?: string; }; header?: never; path: { /** * @description Video id * @example 75623239 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Videos_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; 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; }; /** * Get providers relationship ("to-many"). * @description Retrieves providers relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @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[]; }; header?: never; path: { /** * @description Video id * @example 75623239 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Videos_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/videos/{id}/relationships/replacement": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get replacement relationship ("to-one"). * @description Retrieves replacement relationship. */ get: { 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: replacement * @example replacement */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: replacement * @example replacement */ replaceMedia?: string; }; header?: never; path: { /** * @description Video id * @example 75623239 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Videos_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/videos/{id}/relationships/similarVideos": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get similarVideos relationship ("to-many"). * @description Retrieves similarVideos relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @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: similarVideos * @example similarVideos */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: similarVideos * @example similarVideos */ replaceMedia?: string; }; header?: never; path: { /** * @description Video id * @example 75623239 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Videos_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/videos/{id}/relationships/suggestedVideos": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get suggestedVideos relationship ("to-many"). * @description Retrieves suggestedVideos relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @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: suggestedVideos * @example suggestedVideos */ include?: string[]; /** * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: suggestedVideos * @example suggestedVideos */ replaceMedia?: string; }; header?: never; path: { /** * @description Video id * @example 75623239 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Videos_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/videos/{id}/relationships/thumbnailArt": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get thumbnailArt relationship ("to-many"). * @description Retrieves thumbnailArt relationship. */ get: { parameters: { query?: { /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */ "page[cursor]"?: string; /** * @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: thumbnailArt * @example thumbnailArt */ include?: string[]; }; header?: never; path: { /** * @description Video id * @example 75623239 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Videos_Multi_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/videos/{id}/relationships/usageRules": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get usageRules relationship ("to-one"). * @description Retrieves usageRules relationship. */ get: { 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: usageRules * @example usageRules */ include?: string[]; }; header?: never; path: { /** * @description Video id * @example 75623239 */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Videos_Single_Relationship_Data_Document"]; }; }; 400: components["responses"]["Default400Response"]; 404: components["responses"]["Default404Response"]; 405: components["responses"]["Default405Response"]; 406: components["responses"]["Default406Response"]; 415: components["responses"]["Default415Response"]; 429: components["responses"]["Default429Response"]; 500: components["responses"]["Default500Response"]; 503: components["responses"]["Default503Response"]; }; }; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; } export type webhooks = Record; export interface components { schemas: { AcceptedTermsCreateOperation_Payload: { data: components["schemas"]["AcceptedTermsCreateOperation_Payload_Data"]; }; AcceptedTermsCreateOperation_Payload_Data: { relationships: components["schemas"]["AcceptedTermsCreateOperation_Payload_Data_Relationships"]; /** @enum {string} */ type: "acceptedTerms"; }; AcceptedTermsCreateOperation_Payload_Data_Relationships: { terms: components["schemas"]["AcceptedTermsCreateOperation_Payload_Data_Relationships_Terms"]; }; AcceptedTermsCreateOperation_Payload_Data_Relationships_Terms: { data: components["schemas"]["AcceptedTermsCreateOperation_Payload_Data_Relationships_Terms_Data"]; }; AcceptedTermsCreateOperation_Payload_Data_Relationships_Terms_Data: { id: string; /** @enum {string} */ type: "terms"; }; AcceptedTerms_Attributes: { /** Format: date-time */ createdAt: string; }; AcceptedTerms_Create_Single_Resource_Data_Document: { data: components["schemas"]["AcceptedTerms_Resource_Object"]; links: components["schemas"]["Links"]; }; AcceptedTerms_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; AcceptedTerms_Multi_Resource_Data_Document: { data: components["schemas"]["AcceptedTerms_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; AcceptedTerms_Relationships: { owners?: components["schemas"]["Multi_Relationship_Data_Document"]; terms?: components["schemas"]["Single_Relationship_Data_Document"]; }; AcceptedTerms_Resource_Object: { attributes?: components["schemas"]["AcceptedTerms_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["AcceptedTerms_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "acceptedTerms"; }; AcceptedTerms_Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; AlbumStatistics_Attributes: { /** * Format: int32 * @description Number of sales */ numSales?: number; /** * Format: int32 * @description Total playbacks */ totalPlaybacks: number; /** * Format: int32 * @description Unique listeners */ uniqueListeners: number; }; AlbumStatistics_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; AlbumStatistics_Relationships: { owners?: components["schemas"]["Multi_Relationship_Data_Document"]; }; AlbumStatistics_Resource_Object: { attributes?: components["schemas"]["AlbumStatistics_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["AlbumStatistics_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "albumStatistics"; }; AlbumStatistics_Single_Resource_Data_Document: { data: components["schemas"]["AlbumStatistics_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; AlbumsCoverArtRelationshipUpdateOperation_Payload: { data: components["schemas"]["AlbumsCoverArtRelationshipUpdateOperation_Payload_Data"][]; }; AlbumsCoverArtRelationshipUpdateOperation_Payload_Data: { id: string; /** @enum {string} */ type: "artworks"; }; AlbumsCreateOperation_Payload: { data: components["schemas"]["AlbumsCreateOperation_Payload_Data"]; }; AlbumsCreateOperation_Payload_Data: { attributes: components["schemas"]["AlbumsCreateOperation_Payload_Data_Attributes"]; relationships: components["schemas"]["AlbumsCreateOperation_Payload_Data_Relationships"]; /** @enum {string} */ type: "albums"; }; AlbumsCreateOperation_Payload_Data_Attributes: { /** @enum {string} */ albumType?: "ALBUM" | "EP" | "SINGLE"; copyright?: components["schemas"]["Copyright"]; /** @description Explicit content */ explicit?: boolean; /** * @deprecated * @description Explicit content. Deprecated: use 'explicit' instead. This field will be removed in a future version. */ explicitLyrics?: boolean; /** Format: date */ releaseDate?: string; title: string; version?: string; }; AlbumsCreateOperation_Payload_Data_Relationships: { artists: components["schemas"]["AlbumsCreateOperation_Payload_Data_Relationships_Artists"]; genres?: components["schemas"]["AlbumsCreateOperation_Payload_Data_Relationships_Genres"]; }; AlbumsCreateOperation_Payload_Data_Relationships_Artists: { data: components["schemas"]["AlbumsCreateOperation_Payload_Data_Relationships_Artists_Data"][]; }; AlbumsCreateOperation_Payload_Data_Relationships_Artists_Data: { id: string; /** @enum {string} */ type: "artists"; }; AlbumsCreateOperation_Payload_Data_Relationships_Genres: { data: components["schemas"]["AlbumsCreateOperation_Payload_Data_Relationships_Genres_Data"][]; }; AlbumsCreateOperation_Payload_Data_Relationships_Genres_Data: { id: string; /** @enum {string} */ type: "genres"; }; AlbumsItemsRelationshipUpdateOperation_Payload: { data: components["schemas"]["AlbumsItemsRelationshipUpdateOperation_Payload_Data"][]; meta: components["schemas"]["AlbumsItemsRelationshipUpdateOperation_Payload_Meta"]; }; AlbumsItemsRelationshipUpdateOperation_Payload_Data: { id: string; /** @enum {string} */ type: "tracks" | "videos"; }; AlbumsItemsRelationshipUpdateOperation_Payload_Meta: { /** * Format: int32 * @description 1-based index */ positionIndex: number; }; AlbumsUpdateOperation_Payload: { data: components["schemas"]["AlbumsUpdateOperation_Payload_Data"]; }; AlbumsUpdateOperation_Payload_Data: { attributes?: components["schemas"]["AlbumsUpdateOperation_Payload_Data_Attributes"]; id: string; relationships?: components["schemas"]["AlbumsUpdateOperation_Payload_Data_Relationships"]; /** @enum {string} */ type: "albums"; }; AlbumsUpdateOperation_Payload_Data_Attributes: { /** * @description Access type * @example PRIVATE * @enum {string} */ accessType?: "PUBLIC" | "UNLISTED" | "PRIVATE"; /** @enum {string} */ albumType?: "ALBUM" | "EP" | "SINGLE"; copyright?: components["schemas"]["Copyright"]; /** @description Explicit content */ explicit?: boolean; /** * @deprecated * @description Explicit content. Deprecated: use 'explicit' instead. This field will be removed in a future version. */ explicitLyrics?: boolean; /** Format: date */ releaseDate?: string; title?: string; version?: string; }; AlbumsUpdateOperation_Payload_Data_Relationships: { genres?: components["schemas"]["AlbumsUpdateOperation_Payload_Data_Relationships_Genres"]; }; AlbumsUpdateOperation_Payload_Data_Relationships_Genres: { data: components["schemas"]["AlbumsUpdateOperation_Payload_Data_Relationships_Genres_Data"][]; }; AlbumsUpdateOperation_Payload_Data_Relationships_Genres_Data: { id: string; /** @enum {string} */ type: "genres"; }; Albums_Attributes: { /** * @description Access type * @example PRIVATE * @enum {string} */ accessType?: "PUBLIC" | "UNLISTED" | "PRIVATE"; /** * @description Whether the album is AI-generated * @example false */ ai?: boolean; /** * @description Album type * @enum {string} */ albumType: "ALBUM" | "EP" | "SINGLE"; /** * @deprecated * @description Available usage for this album. Deprecated: use 'usageRules' instead. This field will be removed in a future version. */ availability?: ("STREAM" | "DJ" | "STEM")[]; barcodeId: string; copyright?: components["schemas"]["Copyright"]; /** * Format: date-time * @description Datetime of album creation (ISO 8601) */ createdAt?: string; /** * @description Duration (ISO 8601) * @example PT46M17S */ duration: string; /** * @description Explicit content * @example true */ explicit: boolean; /** @description Album links external to TIDAL API */ externalLinks?: components["schemas"]["External_Link"][]; mediaTags: string[]; /** * Format: int32 * @description Number of items in album * @example 13 */ numberOfItems: number; /** * Format: int32 * @description Number of volumes * @example 1 */ numberOfVolumes: number; /** * Format: double * @description Popularity (0.0 - 1.0) * @example 0.56 */ popularity: number; /** * Format: date * @description Release date (ISO-8601) * @example 2017-06-30 */ releaseDate?: string; /** * @description Album title * @example 4:44 */ title: string; /** * @deprecated * @description Album type. Deprecated: use 'albumType' instead. This field will be removed in a future version. * @enum {string} */ type?: "ALBUM" | "EP" | "SINGLE"; /** * @description Album version * @example remix */ version?: string; }; Albums_Create_Single_Resource_Data_Document: { data: components["schemas"]["Albums_Resource_Object"]; links: components["schemas"]["Links"]; }; Albums_Items_Multi_Relationship_Data_Document: { data?: components["schemas"]["Albums_Items_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Albums_Items_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Albums_Items_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Albums_Items_Resource_Identifier_Meta: { itemCursor?: string; replacement?: components["schemas"]["Replacement_Provenance"]; /** * Format: int32 * @description track number * @example 4 */ trackNumber: number; /** * Format: int32 * @description volume number * @example 1 */ volumeNumber: number; }; Albums_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Albums_Multi_Resource_Data_Document: { data: components["schemas"]["Albums_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Albums_Relationships: { albumStatistics?: components["schemas"]["Single_Relationship_Data_Document"]; artists?: components["schemas"]["Multi_Relationship_Data_Document"]; coverArt?: components["schemas"]["Multi_Relationship_Data_Document"]; genres?: components["schemas"]["Multi_Relationship_Data_Document"]; items?: components["schemas"]["Albums_Items_Multi_Relationship_Data_Document"]; owners?: components["schemas"]["Multi_Relationship_Data_Document"]; priceConfig?: components["schemas"]["Single_Relationship_Data_Document"]; providers?: components["schemas"]["Multi_Relationship_Data_Document"]; replacement?: components["schemas"]["Albums_Replacement_Single_Relationship_Data_Document"]; shares?: components["schemas"]["Multi_Relationship_Data_Document"]; similarAlbums?: components["schemas"]["Albums_SimilarAlbums_Multi_Relationship_Data_Document"]; suggestedCoverArts?: components["schemas"]["Albums_SuggestedCoverArts_Multi_Relationship_Data_Document"]; usageRules?: components["schemas"]["Single_Relationship_Data_Document"]; }; Albums_Replacement_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Albums_Replacement_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Albums_Replacement_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; Albums_Replacement_Single_Relationship_Data_Document: { data?: components["schemas"]["Albums_Replacement_Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Albums_Resource_Object: { attributes?: components["schemas"]["Albums_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["Albums_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "albums"; }; Albums_SimilarAlbums_Multi_Relationship_Data_Document: { data?: components["schemas"]["Albums_SimilarAlbums_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Albums_SimilarAlbums_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Albums_SimilarAlbums_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Albums_SimilarAlbums_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; Albums_Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Albums_Single_Resource_Data_Document: { data: components["schemas"]["Albums_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Albums_SuggestedCoverArts_Multi_Relationship_Data_Document: { data?: components["schemas"]["Albums_SuggestedCoverArts_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; meta?: components["schemas"]["Albums_SuggestedCoverArts_Multi_Relationship_Data_Document_Meta"]; }; Albums_SuggestedCoverArts_Multi_Relationship_Data_Document_Meta: { /** @enum {string} */ status?: "PENDING" | "PROCESSING" | "ERROR" | "OK"; }; Albums_SuggestedCoverArts_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Albums_SuggestedCoverArts_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Albums_SuggestedCoverArts_Resource_Identifier_Meta: { /** @description Background color for the suggested artwork */ backgroundColor: string; /** @description Foreground color for the suggested artwork */ foregroundColor: string; }; AppreciationsCreateOperation_Payload: { data: components["schemas"]["AppreciationsCreateOperation_Payload_Data"]; meta?: components["schemas"]["AppreciationsCreateOperation_Payload_Meta"]; }; AppreciationsCreateOperation_Payload_Data: { relationships: components["schemas"]["AppreciationsCreateOperation_Payload_Data_Relationships"]; /** @enum {string} */ type: "appreciations"; }; AppreciationsCreateOperation_Payload_Data_Relationships: { appreciatedItems: components["schemas"]["AppreciationsCreateOperation_Payload_Data_Relationships_AppreciatedItem"]; }; AppreciationsCreateOperation_Payload_Data_Relationships_AppreciatedItem: { data: components["schemas"]["AppreciationsCreateOperation_Payload_Data_Relationships_AppreciatedItem_Data"][]; }; AppreciationsCreateOperation_Payload_Data_Relationships_AppreciatedItem_Data: { id: string; /** @enum {string} */ type: "artists"; }; AppreciationsCreateOperation_Payload_Meta: { dryRun?: boolean; }; Appreciations_Attributes: { /** * Format: date-time * @description Time when the appreciation was created * @example 2025-09-09T13:07:35.734Z */ createdAt: string; }; Appreciations_Create_Single_Resource_Data_Document: { data: components["schemas"]["Appreciations_Resource_Object"]; links: components["schemas"]["Links"]; }; Appreciations_Resource_Object: { attributes?: components["schemas"]["Appreciations_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "appreciations"; }; ArtistBiographiesUpdateOperation_Payload: { data: components["schemas"]["ArtistBiographiesUpdateOperation_Payload_Data"]; }; ArtistBiographiesUpdateOperation_Payload_Data: { attributes: components["schemas"]["ArtistBiographiesUpdateOperation_Payload_Data_Attributes"]; id: string; /** @enum {string} */ type: "artistBiographies"; }; ArtistBiographiesUpdateOperation_Payload_Data_Attributes: { text?: string; }; ArtistBiographies_Attributes: { /** * @description Boolean to indicate if the biography is editable (source = tidal or artist) * @example true */ editable: boolean; /** * @description Source the biography is coming from * @example ARTIST * @enum {string} */ source?: "TIDAL" | "TiVo" | "MusicBrainz" | "Avex" | "Artist" | "UNKNOWN"; /** * @description Artist biography * @example Once upon a time an artist is born */ text: string; }; ArtistBiographies_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; ArtistBiographies_Relationships: { owners?: components["schemas"]["Multi_Relationship_Data_Document"]; }; ArtistBiographies_Resource_Object: { attributes?: components["schemas"]["ArtistBiographies_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["ArtistBiographies_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "artistBiographies"; }; ArtistBiographies_Single_Resource_Data_Document: { data: components["schemas"]["ArtistBiographies_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; ArtistClaimStatuses_Attributes: { /** @description Claim sources contributing to the current status. Empty when there is no active claim. */ claimSources: ("ARTIST_CLAIMS" | "MANUAL_ARTIST_CLAIMS")[]; /** * @description Whether the artist profile currently has an active claim * @enum {string} */ status: "CLAIM_IN_PROGRESS" | "NO_ACTIVE_CLAIM"; }; ArtistClaimStatuses_Multi_Resource_Data_Document: { data: components["schemas"]["ArtistClaimStatuses_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; ArtistClaimStatuses_Resource_Object: { attributes?: components["schemas"]["ArtistClaimStatuses_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "artistClaimStatuses"; }; ArtistClaimsAcceptedArtistsRelationshipUpdateOperation_Payload: { data: components["schemas"]["ArtistClaimsAcceptedArtistsRelationshipUpdateOperation_Payload_Data"][]; }; ArtistClaimsAcceptedArtistsRelationshipUpdateOperation_Payload_Data: { id: string; /** @enum {string} */ type: "artists"; }; ArtistClaimsCreateOperation_Payload: { data: components["schemas"]["ArtistClaimsCreateOperation_Payload_Data"]; meta: components["schemas"]["ArtistClaimsCreateOperation_Payload_Meta"]; }; ArtistClaimsCreateOperation_Payload_Data: { attributes: components["schemas"]["ArtistClaimsCreateOperation_Payload_Data_Attributes"]; /** @enum {string} */ type: "artistClaims"; }; ArtistClaimsCreateOperation_Payload_Data_Attributes: { artistId: string; /** @enum {string} */ provider: "DISTROKID" | "CDBABY" | "TUNECORE"; }; ArtistClaimsCreateOperation_Payload_Meta: { nonce?: string; redirectUrl: string; }; ArtistClaimsUpdateOperation_Payload: { data?: components["schemas"]["ArtistClaimsUpdateOperation_Payload_Data"]; meta: components["schemas"]["ArtistClaimsUpdateOperation_Payload_Meta"]; }; ArtistClaimsUpdateOperation_Payload_Data: { attributes?: components["schemas"]["ArtistClaimsUpdateOperation_Payload_Data_Attributes"]; id?: string; /** @enum {string} */ type: "artistClaims"; }; ArtistClaimsUpdateOperation_Payload_Data_Attributes: Record; ArtistClaimsUpdateOperation_Payload_Meta: { authorizationCode: string; redirectUri: string; }; ArtistClaims_Attributes: { /** @description The artist id which is being claimed */ artistId: string; /** @description Artist claim links external to TIDAL API */ externalLinks?: components["schemas"]["External_Link"][]; /** * @description The DSP used for authentication * @enum {string} */ provider: "DISTROKID" | "CDBABY" | "TUNECORE"; /** * @description The recommended claim resolution * @enum {string} */ recommendation?: "CLAIM_PROFILE" | "CLAIM_CONTENT"; /** @description List of UPCs retrieved from the DSP */ retrievedUpcs?: components["schemas"]["LegacyBarcodeId"][]; /** * @description Current status of this claim * @enum {string} */ status: "AWAITING_OAUTH" | "FETCHING_CONTENT" | "VERIFIED" | "NO_MATCHES" | "AUTHENTICATION_FAILED" | "PROCESSING" | "COMPLETED" | "FAILED" | "CANCELLED" | "NAME_MISMATCH" | "CLAIMED_ARTIST_MISMATCH"; }; ArtistClaims_Create_Single_Resource_Data_Document: { data: components["schemas"]["ArtistClaims_Resource_Object"]; links: components["schemas"]["Links"]; }; ArtistClaims_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; ArtistClaims_Multi_Resource_Data_Document: { data: components["schemas"]["ArtistClaims_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; ArtistClaims_Relationships: { acceptedArtists?: components["schemas"]["Multi_Relationship_Data_Document"]; owners?: components["schemas"]["Multi_Relationship_Data_Document"]; recommendedArtists?: components["schemas"]["Multi_Relationship_Data_Document"]; }; ArtistClaims_Resource_Object: { attributes?: components["schemas"]["ArtistClaims_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["ArtistClaims_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "artistClaims"; }; ArtistClaims_Single_Resource_Data_Document: { data: components["schemas"]["ArtistClaims_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; ArtistRoles_Attributes: { /** @description Name of the artist role */ name: string; }; ArtistRoles_Resource_Object: { attributes?: components["schemas"]["ArtistRoles_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "artistRoles"; }; ArtistRoles_Single_Resource_Data_Document: { data: components["schemas"]["ArtistRoles_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; ArtistsCreateOperation_Payload: { data: components["schemas"]["ArtistsCreateOperation_Payload_Data"]; meta?: components["schemas"]["ArtistsCreateOperation_Payload_Meta"]; }; ArtistsCreateOperation_Payload_Data: { attributes: components["schemas"]["ArtistsCreateOperation_Payload_Data_Attributes"]; /** @enum {string} */ type: "artists"; }; ArtistsCreateOperation_Payload_Data_Attributes: { handle?: string; name: string; }; ArtistsCreateOperation_Payload_Meta: { dryRun?: boolean; }; ArtistsFollowingRelationshipAddOperation_Payload: { data: components["schemas"]["ArtistsFollowingRelationshipAddOperation_Payload_Data"][]; }; ArtistsFollowingRelationshipAddOperation_Payload_Data: { id: string; /** @enum {string} */ type: "artists"; }; ArtistsFollowingRelationshipRemoveOperation_Payload: { data: components["schemas"]["ArtistsFollowingRelationshipRemoveOperation_Payload_Data"][]; }; ArtistsFollowingRelationshipRemoveOperation_Payload_Data: { id: string; /** @enum {string} */ type: "artists"; }; ArtistsProfileArtRelationshipUpdateOperation_Payload: { data: components["schemas"]["ArtistsProfileArtRelationshipUpdateOperation_Payload_Data"][]; }; ArtistsProfileArtRelationshipUpdateOperation_Payload_Data: { id: string; /** @enum {string} */ type: "artworks"; }; ArtistsUpdateOperation_Payload: { data: components["schemas"]["ArtistsUpdateOperation_Payload_Data"]; meta?: components["schemas"]["ArtistsUpdateOperation_Payload_Meta"]; }; ArtistsUpdateOperation_Payload_Data: { attributes: components["schemas"]["ArtistsUpdateOperation_Payload_Data_Attributes"]; id: string; /** @enum {string} */ type: "artists"; }; ArtistsUpdateOperation_Payload_Data_Attributes: { contributionsEnabled?: boolean; contributionsSalesPitch?: string; externalLinks?: components["schemas"]["External_Link_Payload"][]; handle?: string | (never | null); name?: string; }; ArtistsUpdateOperation_Payload_Meta: { dryRun?: boolean; }; Artists_Albums_Multi_Relationship_Data_Document: { data?: components["schemas"]["Artists_Albums_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Artists_Albums_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Artists_Albums_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Artists_Albums_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; Artists_Attributes: { /** * @description Is the artist enabled for contributions? * @example true */ contributionsEnabled?: boolean; /** * @description Contributions sales pitch * @example Help me be a full time artist */ contributionsSalesPitch?: string; /** @description Artist links external to TIDAL API */ externalLinks?: components["schemas"]["External_Link"][]; /** * @description Artist handle * @example jayz */ handle?: string; /** * @description Artist name * @example JAY Z */ name: string; /** * @description Ownership type of the artist profile. LABEL: label-managed profile, USER: user-created profile, MIXED: claimed profile with both label and user content. May be null during rollout/backfill. * @enum {string} */ ownerType?: "LABEL" | "USER" | "MIXED"; /** * Format: double * @description Artist popularity (0.0 - 1.0) * @example 0.56 */ popularity: number; /** * @description Is the artist spotlighted? * @example true */ spotlighted?: boolean; }; Artists_Create_Single_Resource_Data_Document: { data: components["schemas"]["Artists_Resource_Object"]; links: components["schemas"]["Links"]; }; Artists_Followers_Multi_Relationship_Data_Document: { data?: components["schemas"]["Artists_Followers_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Artists_Followers_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Artists_Followers_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Artists_Followers_Resource_Identifier_Meta: { viewer?: components["schemas"]["Artists_Followers_Resource_Meta_ViewerContext"]; }; /** @description Optional context about the relationship */ Artists_Followers_Resource_Meta_ViewerContext: { /** * @description Boolean to indicate if the artist is following my artist * @default false */ followsMyArtist: boolean; /** * @description Boolean to indicate if my artist is following the artist * @default false */ myArtistFollows: boolean; }; Artists_Following_Multi_Relationship_Data_Document: { data?: components["schemas"]["Artists_Following_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Artists_Following_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Artists_Following_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Artists_Following_Resource_Identifier_Meta: { viewer?: components["schemas"]["Artists_Followers_Resource_Meta_ViewerContext"]; }; Artists_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Artists_Multi_Resource_Data_Document: { data: components["schemas"]["Artists_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Artists_Relationships: { albums?: components["schemas"]["Artists_Albums_Multi_Relationship_Data_Document"]; biography?: components["schemas"]["Single_Relationship_Data_Document"]; claimStatus?: components["schemas"]["Single_Relationship_Data_Document"]; followers?: components["schemas"]["Artists_Followers_Multi_Relationship_Data_Document"]; following?: components["schemas"]["Artists_Following_Multi_Relationship_Data_Document"]; owners?: components["schemas"]["Multi_Relationship_Data_Document"]; profileArt?: components["schemas"]["Multi_Relationship_Data_Document"]; radio?: components["schemas"]["Multi_Relationship_Data_Document"]; roles?: components["schemas"]["Multi_Relationship_Data_Document"]; similarArtists?: components["schemas"]["Multi_Relationship_Data_Document"]; trackProviders?: components["schemas"]["Artists_TrackProviders_Multi_Relationship_Data_Document"]; tracks?: components["schemas"]["Artists_Tracks_Multi_Relationship_Data_Document"]; videos?: components["schemas"]["Artists_Videos_Multi_Relationship_Data_Document"]; }; Artists_Resource_Object: { attributes?: components["schemas"]["Artists_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["Artists_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "artists"; }; Artists_Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Artists_Single_Resource_Data_Document: { data: components["schemas"]["Artists_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Artists_TrackProviders_Multi_Relationship_Data_Document: { data?: components["schemas"]["Artists_TrackProviders_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Artists_TrackProviders_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Artists_TrackProviders_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Artists_TrackProviders_Resource_Identifier_Meta: { /** * Format: int64 * @description Total number of tracks released together with the provider * @example 14 */ numberOfTracks: number; }; Artists_Tracks_Multi_Relationship_Data_Document: { data?: components["schemas"]["Artists_Tracks_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Artists_Tracks_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Artists_Tracks_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Artists_Tracks_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; Artists_Videos_Multi_Relationship_Data_Document: { data?: components["schemas"]["Artists_Videos_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Artists_Videos_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Artists_Videos_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Artists_Videos_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; /** @description Artwork files */ Artwork_File: { /** @description Artwork file href */ href: string; meta: components["schemas"]["Artwork_File_Meta"]; }; /** @description Metadata about an artwork file */ Artwork_File_Meta: { /** * Format: int32 * @description Height (in pixels) * @example 80 */ height: number; /** * Format: int32 * @description Width (in pixels) * @example 80 */ width: number; }; /** @description Artwork source file */ Artwork_SourceFile: { /** @description MD5 hash of file to be uploaded */ md5Hash: string; /** * Format: int64 * @description File size of the artwork in bytes */ size: number; status: components["schemas"]["File_Status"]; uploadLink: components["schemas"]["File_Upload_Link"]; }; /** @description Color information extracted from artwork */ Artwork_VisualMetadata: { /** @description BlurHash representation of the artwork for placeholder display */ blurHash?: string; /** @description Selected color from the extracted artwork palette */ selectedPaletteColor?: string; /** * @description Status of visual metadata extraction * @enum {string} */ status?: "NONE" | "PROCESSING" | "OK"; }; ArtworksCreateOperation_Payload: { data: components["schemas"]["ArtworksCreateOperation_Payload_Data"]; }; ArtworksCreateOperation_Payload_Data: { attributes: components["schemas"]["ArtworksCreateOperation_Payload_Data_Attributes"]; /** @enum {string} */ type: "artworks"; }; ArtworksCreateOperation_Payload_Data_Attributes: { /** @enum {string} */ mediaType: "IMAGE" | "VIDEO"; sourceFile: components["schemas"]["ArtworksCreateOperation_Payload_Data_Attributes_SourceFile"]; }; ArtworksCreateOperation_Payload_Data_Attributes_SourceFile: { md5Hash: string; /** Format: int64 */ size: number; }; Artworks_Attributes: { /** @description Artwork files */ files: components["schemas"]["Artwork_File"][]; /** * @description Media type of artwork files * @enum {string} */ mediaType: "IMAGE" | "VIDEO"; sourceFile?: components["schemas"]["Artwork_SourceFile"]; visualMetadata?: components["schemas"]["Artwork_VisualMetadata"]; }; Artworks_Create_Single_Resource_Data_Document: { data: components["schemas"]["Artworks_Resource_Object"]; links: components["schemas"]["Links"]; }; Artworks_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Artworks_Multi_Resource_Data_Document: { data: components["schemas"]["Artworks_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Artworks_Relationships: { owners?: components["schemas"]["Multi_Relationship_Data_Document"]; }; Artworks_Resource_Object: { attributes?: components["schemas"]["Artworks_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["Artworks_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "artworks"; }; Artworks_Single_Resource_Data_Document: { data: components["schemas"]["Artworks_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; /** @description Track normalization data */ AudioNormalizationData: { /** Format: float */ peakAmplitude?: number; /** Format: float */ replayGain?: number; }; ClientsCreateOperation_Payload: { data: components["schemas"]["ClientsCreateOperation_Payload_Data"]; }; ClientsCreateOperation_Payload_Data: { attributes: components["schemas"]["ClientsCreateOperation_Payload_Data_Attributes"]; /** @enum {string} */ type: "clients"; }; ClientsCreateOperation_Payload_Data_Attributes: { description?: string; name: string; }; ClientsUpdateOperation_Payload: { data: components["schemas"]["ClientsUpdateOperation_Payload_Data"]; }; ClientsUpdateOperation_Payload_Data: { attributes: components["schemas"]["ClientsUpdateOperation_Payload_Data_Attributes"]; id: string; /** @enum {string} */ type: "clients"; }; ClientsUpdateOperation_Payload_Data_Attributes: { description?: string; name?: string; redirectUris?: string[]; scopes?: string[]; }; Clients_Attributes: { /** @enum {string} */ accessTier: "THIRD_PARTY" | "THIRD_PARTY_PROD" | "PARTNER" | "INTERNAL"; clientSecret?: string; /** Format: date-time */ createdAt?: string; description?: string; name: string; redirectUris?: string[]; scopes?: string[]; }; Clients_Create_Single_Resource_Data_Document: { data: components["schemas"]["Clients_Resource_Object"]; links: components["schemas"]["Links"]; }; Clients_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Clients_Multi_Resource_Data_Document: { data: components["schemas"]["Clients_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Clients_Relationships: { owners?: components["schemas"]["Multi_Relationship_Data_Document"]; }; Clients_Resource_Object: { attributes?: components["schemas"]["Clients_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["Clients_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "clients"; }; Clients_Single_Resource_Data_Document: { data: components["schemas"]["Clients_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Clients_Update_Single_Resource_Data_Document: { data: components["schemas"]["Clients_Resource_Object"]; links: components["schemas"]["Links"]; }; CollaborationInviteRedemptionsCreateOperation_Payload: { data: components["schemas"]["CollaborationInviteRedemptionsCreateOperation_Payload_Data"]; }; CollaborationInviteRedemptionsCreateOperation_Payload_Data: { relationships: components["schemas"]["CollaborationInviteRedemptionsCreateOperation_Payload_Data_Relationships"]; /** @enum {string} */ type: "collaborationInviteRedemptions"; }; CollaborationInviteRedemptionsCreateOperation_Payload_Data_Relationships: { invite: components["schemas"]["CollaborationInviteRedemptionsCreateOperation_Payload_Data_Relationships_Invite"]; }; CollaborationInviteRedemptionsCreateOperation_Payload_Data_Relationships_Invite: { data: components["schemas"]["CollaborationInviteRedemptionsCreateOperation_Payload_Data_Relationships_Invite_Data"]; }; CollaborationInviteRedemptionsCreateOperation_Payload_Data_Relationships_Invite_Data: { id: string; /** @enum {string} */ type: "collaborationInvites"; }; CollaborationInviteRedemptions_Attributes: { /** * Format: date-time * @description Datetime the invite was redeemed (ISO 8601) */ redeemedAt: string; }; CollaborationInviteRedemptions_Create_Single_Resource_Data_Document: { data: components["schemas"]["CollaborationInviteRedemptions_Resource_Object"]; links: components["schemas"]["Links"]; }; CollaborationInviteRedemptions_Resource_Object: { attributes?: components["schemas"]["CollaborationInviteRedemptions_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "collaborationInviteRedemptions"; }; CollaborationInvitesCreateOperation_Payload: { data: components["schemas"]["CollaborationInvitesCreateOperation_Payload_Data"]; }; CollaborationInvitesCreateOperation_Payload_Data: { relationships: components["schemas"]["CollaborationInvitesCreateOperation_Payload_Data_Relationships"]; /** @enum {string} */ type: "collaborationInvites"; }; CollaborationInvitesCreateOperation_Payload_Data_Relationships: { subject: components["schemas"]["CollaborationInvitesCreateOperation_Payload_Data_Relationships_Subject"]; }; CollaborationInvitesCreateOperation_Payload_Data_Relationships_Subject: { data: components["schemas"]["CollaborationInvitesCreateOperation_Payload_Data_Relationships_Subject_Data"]; }; CollaborationInvitesCreateOperation_Payload_Data_Relationships_Subject_Data: { id: string; /** @enum {string} */ type: "playlists"; }; CollaborationInvites_Attributes: { /** @description Opaque invite code embedded in the share link */ code: string; /** * Format: date-time * @description Datetime the invite was created (ISO 8601) */ createdAt: string; /** * Format: date-time * @description Datetime the invite expires (ISO 8601) */ expiresAt: string; /** @description Whether the invite has been revoked by the subject's owner */ revoked: boolean; }; CollaborationInvites_Create_Single_Resource_Data_Document: { data: components["schemas"]["CollaborationInvites_Resource_Object"]; links: components["schemas"]["Links"]; }; CollaborationInvites_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; CollaborationInvites_Multi_Resource_Data_Document: { data: components["schemas"]["CollaborationInvites_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; CollaborationInvites_Relationships: { owners?: components["schemas"]["Multi_Relationship_Data_Document"]; subject?: components["schemas"]["Single_Relationship_Data_Document"]; }; CollaborationInvites_Resource_Object: { attributes?: components["schemas"]["CollaborationInvites_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["CollaborationInvites_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "collaborationInvites"; }; CollaborationInvites_Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; CollaborationInvites_Single_Resource_Data_Document: { data: components["schemas"]["CollaborationInvites_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; CommentsCreateOperation_Payload: { data: components["schemas"]["CommentsCreateOperation_Payload_Data"]; }; CommentsCreateOperation_Payload_Data: { attributes: components["schemas"]["CommentsCreateOperation_Payload_Data_Attributes"]; relationships: components["schemas"]["CommentsCreateOperation_Payload_Data_Relationships"]; /** @enum {string} */ type: "comments"; }; CommentsCreateOperation_Payload_Data_Attributes: { endTime?: string; message: string; startTime?: string; }; CommentsCreateOperation_Payload_Data_Relationships: { parentComment?: components["schemas"]["CommentsCreateOperation_Payload_Data_Relationships_ParentComment"]; subject: components["schemas"]["CommentsCreateOperation_Payload_Data_Relationships_Subject"]; }; CommentsCreateOperation_Payload_Data_Relationships_ParentComment: { data: components["schemas"]["CommentsCreateOperation_Payload_Data_Relationships_ParentComment_Data"] | (never | null); }; CommentsCreateOperation_Payload_Data_Relationships_ParentComment_Data: { id: string; /** @enum {string} */ type: "comments"; }; CommentsCreateOperation_Payload_Data_Relationships_Subject: { data: components["schemas"]["CommentsCreateOperation_Payload_Data_Relationships_Subject_Data"]; }; CommentsCreateOperation_Payload_Data_Relationships_Subject_Data: { id: string; /** @enum {string} */ type: "albums" | "tracks"; }; CommentsUpdateOperation_Payload: { data: components["schemas"]["CommentsUpdateOperation_Payload_Data"]; }; CommentsUpdateOperation_Payload_Data: { attributes: components["schemas"]["CommentsUpdateOperation_Payload_Data_Attributes"]; id: string; /** @enum {string} */ type: "comments"; }; CommentsUpdateOperation_Payload_Data_Attributes: { endTime?: string; message?: string; startTime?: string; }; Comments_Attributes: { /** * Format: date-time * @description Datetime when the comment was created (ISO 8601) * @example 2025-11-17T12:54:48.606Z */ createdAt: string; /** * @description End time offset for timestamped comments (ISO 8601 duration) * @example PT2M */ endTime?: string; /** * Format: date-time * @description Datetime when the comment was last modified (ISO 8601) * @example 2025-11-17T12:54:48.606Z */ lastModifiedAt: string; /** * Format: int32 * @description Number of likes on this comment */ likeCount: number; /** @description The comment message content */ message: string; /** * @description Moderation status of the comment * @enum {string} */ moderationStatus: "NOT_MODERATED" | "FLAGGED" | "TAKEN_DOWN" | "OK" | "ERROR"; /** * Format: int32 * @description Number of replies to this comment */ replyCount: number; /** * @description Start time offset for timestamped comments (ISO 8601 duration) * @example PT1M30S */ startTime?: string; }; Comments_Create_Single_Resource_Data_Document: { data: components["schemas"]["Comments_Resource_Object"]; links: components["schemas"]["Links"]; }; Comments_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Comments_Multi_Resource_Data_Document: { data: components["schemas"]["Comments_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Comments_Relationships: { ownerProfiles?: components["schemas"]["Multi_Relationship_Data_Document"]; owners?: components["schemas"]["Multi_Relationship_Data_Document"]; parentComment?: components["schemas"]["Single_Relationship_Data_Document"]; }; Comments_Resource_Object: { attributes?: components["schemas"]["Comments_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["Comments_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "comments"; }; Comments_Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Comments_Single_Resource_Data_Document: { data: components["schemas"]["Comments_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; ContentClaimsCreateOperation_Payload: { data: components["schemas"]["ContentClaimsCreateOperation_Payload_Data"]; }; ContentClaimsCreateOperation_Payload_Data: { attributes: components["schemas"]["ContentClaimsCreateOperation_Payload_Data_Attributes"]; relationships: components["schemas"]["ContentClaimsCreateOperation_Payload_Data_Relationships"]; /** @enum {string} */ type: "contentClaims"; }; ContentClaimsCreateOperation_Payload_Data_Attributes: { /** @enum {string} */ assertion: "CLAIM" | "DISCLAIM"; }; ContentClaimsCreateOperation_Payload_Data_Relationships: { claimedResource: components["schemas"]["ContentClaimsCreateOperation_Payload_Data_Relationships_ClaimedResource"]; claimingArtist: components["schemas"]["ContentClaimsCreateOperation_Payload_Data_Relationships_ClaimingArtist"]; }; ContentClaimsCreateOperation_Payload_Data_Relationships_ClaimedResource: { data: components["schemas"]["ContentClaimsCreateOperation_Payload_Data_Relationships_ClaimedResource_Data"]; }; ContentClaimsCreateOperation_Payload_Data_Relationships_ClaimedResource_Data: { id: string; /** @enum {string} */ type: "tracks" | "albums" | "videos"; }; ContentClaimsCreateOperation_Payload_Data_Relationships_ClaimingArtist: { data: components["schemas"]["ContentClaimsCreateOperation_Payload_Data_Relationships_ClaimingArtist_Data"]; }; ContentClaimsCreateOperation_Payload_Data_Relationships_ClaimingArtist_Data: { id: string; /** @enum {string} */ type: "artists"; }; ContentClaims_Attributes: { /** * @description The claim assertion type * @enum {string} */ assertion: "CLAIM" | "DISCLAIM"; /** * Format: date-time * @description Timestamp when the claim was created */ createdAt: string; /** * Format: date-time * @description Timestamp when the claim was last modified */ lastModifiedAt: string; /** * @description Current status of this claim * @enum {string} */ status: "OPEN" | "IN_PROGRESS" | "RESOLVED" | "REJECTED"; }; ContentClaims_ClaimedResource_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["ContentClaims_ClaimedResource_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; ContentClaims_ClaimedResource_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; ContentClaims_ClaimedResource_Single_Relationship_Data_Document: { data?: components["schemas"]["ContentClaims_ClaimedResource_Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; ContentClaims_Create_Single_Resource_Data_Document: { data: components["schemas"]["ContentClaims_Resource_Object"]; links: components["schemas"]["Links"]; }; ContentClaims_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; ContentClaims_Multi_Resource_Data_Document: { data: components["schemas"]["ContentClaims_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; ContentClaims_Relationships: { claimedResource?: components["schemas"]["ContentClaims_ClaimedResource_Single_Relationship_Data_Document"]; claimingArtist?: components["schemas"]["Single_Relationship_Data_Document"]; owners?: components["schemas"]["Multi_Relationship_Data_Document"]; }; ContentClaims_Resource_Object: { attributes?: components["schemas"]["ContentClaims_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["ContentClaims_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "contentClaims"; }; ContentClaims_Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; ContentClaims_Single_Resource_Data_Document: { data: components["schemas"]["ContentClaims_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; /** @description Copyright information */ Copyright: { text: string; }; Credits_Attributes: { /** * @description Credit name * @example John Lennon */ name: string; /** * @description Credit role * @example Vocals */ role: string; }; Credits_Relationships: { artist?: components["schemas"]["Single_Relationship_Data_Document"]; category?: components["schemas"]["Single_Relationship_Data_Document"]; }; Credits_Resource_Object: { attributes?: components["schemas"]["Credits_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["Credits_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "credits"; }; Credits_Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Credits_Single_Resource_Data_Document: { data: components["schemas"]["Credits_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; /** @description Current user's reaction */ CurrentUserReaction: { /** * Format: date-time * @description When the reaction was created */ createdAt?: string; /** @description User's emoji reaction */ emoji?: string; /** @description Reaction ID */ id?: string; }; Default400ResponseBody: { errors: { /** @example Invalid request */ detail?: string; /** @example 400 */ status: string; }[]; }; Default404ResponseBody: { errors: { /** @example Resource not found */ detail?: string; /** @example 404 */ status: string; }[]; }; Default405ResponseBody: { errors: { /** @example HTTP method not allowed */ detail?: string; /** @example 405 */ status: string; }[]; }; Default406ResponseBody: { errors: { /** @example No acceptable response media type */ detail?: string; /** @example 406 */ status: string; }[]; }; Default415ResponseBody: { errors: { /** @example Unsupported request media type or encoding */ detail?: string; /** @example 415 */ status: string; }[]; }; Default429ResponseBody: { errors: { /** @example Rate limit exceeded */ detail?: string; /** @example 429 */ status: string; }[]; }; Default500ResponseBody: { errors: { /** @example Internal server error */ detail?: string; /** @example 500 */ status: string; }[]; }; Default503ResponseBody: { errors: { /** @example Service temporarily unavailable */ detail?: string; /** @example 503 */ status: string; }[]; }; Download_Link: { /** @description URL to download the content from */ href: string; meta: components["schemas"]["Download_Link_Meta"]; }; /** @description Metadata for download link */ Download_Link_Meta: { /** @description HTTP headers required when requesting the download URL */ requiredHeaders?: string[]; }; Downloads_Attributes: { downloadLinks?: components["schemas"]["Download_Link"][]; }; Downloads_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Downloads_Multi_Resource_Data_Document: { data: components["schemas"]["Downloads_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Downloads_Relationships: { owners?: components["schemas"]["Multi_Relationship_Data_Document"]; }; Downloads_Resource_Object: { attributes?: components["schemas"]["Downloads_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["Downloads_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "downloads"; }; Downloads_Single_Resource_Data_Document: { data: components["schemas"]["Downloads_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; /** @description DRM data. Absence implies no DRM. */ DrmData: { certificateUrl?: string; /** @enum {string} */ drmSystem?: "FAIRPLAY" | "WIDEVINE"; initData?: string[]; licenseUrl?: string; }; DspSharingLinks_Attributes: { amazonMusic?: components["schemas"]["Link_Object"]; appleMusic?: components["schemas"]["Link_Object"]; spotify?: components["schemas"]["Link_Object"]; youTubeMusic?: components["schemas"]["Link_Object"]; }; DspSharingLinks_Multi_Resource_Data_Document: { data: components["schemas"]["DspSharingLinks_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; DspSharingLinks_Relationships: { subject?: components["schemas"]["DspSharingLinks_Subject_Single_Relationship_Data_Document"]; }; DspSharingLinks_Resource_Object: { attributes?: components["schemas"]["DspSharingLinks_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["DspSharingLinks_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "dspSharingLinks"; }; DspSharingLinks_Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; DspSharingLinks_Subject_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["DspSharingLinks_Subject_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; DspSharingLinks_Subject_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; DspSharingLinks_Subject_Single_Relationship_Data_Document: { data?: components["schemas"]["DspSharingLinks_Subject_Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; DynamicModules_Attributes: { /** * @description Semantic icons the module should show. SPOTLIGHT_INFO identifies modules whose content was selected by TIDAL's editorial team. * @example SPOTLIGHT_INFO */ icons: ("SPOTLIGHT_INFO" | "UNKNOWN")[]; /** * @description Rendering layout for a dynamic module. previewLayout controls the module on a dynamic page. viewAllLayout controls its view-all screen; when omitted, the module has no view-all screen. GRID means artwork-forward tiles; the client owns scroll axis and column count. LIST means detailed text-forward rows in a single column and may be a table on wide screens. COMPACT means dense rows the client may pack into multiple columns; clients should treat it as LIST in a full view. UNKNOWN is the forward-compatible default; clients should skip the module or use a safe default. * @example GRID * @enum {string} */ previewLayout: "GRID" | "LIST" | "COMPACT" | "UNKNOWN"; /** * @description Subtitle of the module * @example Short description of this module */ subtitle?: string; /** * @description Title of the module * @example Shortcuts */ title?: string; /** * @description Rendering layout for a dynamic module. previewLayout controls the module on a dynamic page. viewAllLayout controls its view-all screen; when omitted, the module has no view-all screen. GRID means artwork-forward tiles; the client owns scroll axis and column count. LIST means detailed text-forward rows in a single column and may be a table on wide screens. COMPACT means dense rows the client may pack into multiple columns; clients should treat it as LIST in a full view. UNKNOWN is the forward-compatible default; clients should skip the module or use a safe default. * @example LIST * @enum {string} */ viewAllLayout?: "GRID" | "LIST" | "COMPACT" | "UNKNOWN"; }; DynamicModules_Items_Multi_Relationship_Data_Document: { data?: components["schemas"]["DynamicModules_Items_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; DynamicModules_Items_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["DynamicModules_Items_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; DynamicModules_Items_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; DynamicModules_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; DynamicModules_Multi_Resource_Data_Document: { data: components["schemas"]["DynamicModules_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; DynamicModules_Relationships: { items?: components["schemas"]["DynamicModules_Items_Multi_Relationship_Data_Document"]; seedItem?: components["schemas"]["DynamicModules_SeedItem_Single_Relationship_Data_Document"]; }; DynamicModules_Resource_Object: { attributes?: components["schemas"]["DynamicModules_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["DynamicModules_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "dynamicModules"; }; DynamicModules_SeedItem_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["DynamicModules_SeedItem_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; DynamicModules_SeedItem_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; DynamicModules_SeedItem_Single_Relationship_Data_Document: { data?: components["schemas"]["DynamicModules_SeedItem_Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; DynamicModules_Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; DynamicModules_Single_Resource_Data_Document: { data: components["schemas"]["DynamicModules_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; DynamicPages_Attributes: { /** * @description Type of the page eg. home, artist * @example HOME_STATIC * @enum {string} */ pageType: "HOME_STATIC" | "HOME_UPLOADS" | "HOME_EDITORIAL" | "HOME_FREE" | "ARTIST" | "ALBUM" | "PLAYLIST" | "TRACK" | "VIDEO"; /** * Format: uuid * @description Id used for reporting user events * @example 83c92ac0-b8e3-4e28-9e27-07909dcde1e5 */ reportingId: string; }; DynamicPages_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; DynamicPages_Multi_Resource_Data_Document: { data: components["schemas"]["DynamicPages_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; DynamicPages_Relationships: { modules?: components["schemas"]["Multi_Relationship_Data_Document"]; subject?: components["schemas"]["DynamicPages_Subject_Single_Relationship_Data_Document"]; }; DynamicPages_Resource_Object: { attributes?: components["schemas"]["DynamicPages_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["DynamicPages_Resource_Object_Meta"]; relationships?: components["schemas"]["DynamicPages_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "dynamicPages"; }; DynamicPages_Resource_Object_Meta: { /** * @description Reason why data has been redacted on this page * @enum {string} */ redactionReason?: "NO_BIRTHDAY" | "MINOR"; }; DynamicPages_Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; DynamicPages_Subject_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["DynamicPages_Subject_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; DynamicPages_Subject_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; DynamicPages_Subject_Single_Relationship_Data_Document: { data?: components["schemas"]["DynamicPages_Subject_Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Error_Object: { /** @description application-specific error code */ code?: string; /** @description human-readable explanation specific to this occurrence of the problem */ detail?: string; /** @description unique identifier for this particular occurrence of the problem */ id?: string; source?: components["schemas"]["Error_Object_Source"]; /** @description HTTP status code applicable to this problem */ status?: string; }; Error_Object_Source: { /** * @description string indicating the name of a single request header which caused the error * @example X-some-custom-header */ header?: string; /** * @description string indicating which URI query parameter caused the error. * @example countryCode */ parameter?: string; /** * @description a JSON Pointer [RFC6901] to the value in the request document that caused the error * @example /data/attributes/title */ pointer?: string; }; Errors_Document: { /** @description Array of error objects */ errors?: components["schemas"]["Error_Object"][]; links?: components["schemas"]["Links"]; }; External_Link: { href: string; meta: components["schemas"]["External_Link_Meta"]; }; /** @description metadata about an external link */ External_Link_Meta: { /** @enum {string} */ type: "TIDAL_SHARING" | "TIDAL_USER_SHARING" | "TIDAL_AUTOPLAY_ANDROID" | "TIDAL_AUTOPLAY_IOS" | "TIDAL_AUTOPLAY_WEB" | "TWITTER" | "FACEBOOK" | "INSTAGRAM" | "TIKTOK" | "SNAPCHAT" | "OFFICIAL_HOMEPAGE" | "CASHAPP_CONTRIBUTIONS" | "ARTIST_CLAIM_PROVIDER_REDIRECT" | "STRIPE_AUTHORIZATION_REDIRECT" | "SQUARE_AUTHORIZATION_REDIRECT"; }; External_Link_Payload: { href?: string; meta: components["schemas"]["External_Link_Meta"]; }; /** @description File status */ File_Status: { /** * @description Status of scanning the file for being AI-generated. Only present for file types that support AI scanning (e.g. track source files) and when a scanning status is available for the file; absent otherwise. * @enum {string} */ aiScanningFileStatus?: "NOT_SCANNED" | "SCANNING" | "IS_AI" | "NOT_AI" | "ERROR"; /** * @description Moderation status for file * @enum {string} */ moderationFileStatus: "NOT_MODERATED" | "SCANNING" | "FLAGGED" | "TAKEN_DOWN" | "OK" | "ERROR"; /** * @description Technical status for file * @enum {string} */ technicalFileStatus: "UPLOAD_REQUESTED" | "PROCESSING" | "OK" | "ERROR" | "DELETED"; }; /** @description Upload link */ File_Upload_Link: { /** @description Href to upload actual file to */ href: string; meta: components["schemas"]["File_Upload_Link_Meta"]; }; /** @description metadata for upload link */ File_Upload_Link_Meta: { /** @description HTTP headers that must be added to the operation */ headers?: { [key: string]: string; }; /** @description HTTP method */ method: string; }; Genres_Attributes: { /** * @description Genre name * @example pop */ genreName: string; }; Genres_Multi_Resource_Data_Document: { data: components["schemas"]["Genres_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Genres_Resource_Object: { attributes?: components["schemas"]["Genres_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "genres"; }; Genres_Single_Resource_Data_Document: { data: components["schemas"]["Genres_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Idempotency409ResponseBody: { errors: { /** * @example IDEMPOTENT_REQUEST_IN_PROGRESS * @enum {string} */ code: "IDEMPOTENT_REQUEST_IN_PROGRESS"; /** @example Request already in progress for this idempotency key */ detail?: string; /** @example 409 */ status: string; }[]; }; Idempotency422ResponseBody: { errors: { /** * @example IDEMPOTENT_REQUEST_PAYLOAD_MISMATCH * @enum {string} */ code: "IDEMPOTENT_REQUEST_PAYLOAD_MISMATCH"; /** @example Idempotency key reused with a different payload */ detail?: string; /** @example 422 */ status: string; }[]; }; Included: (components["schemas"]["AcceptedTerms_Resource_Object"] | components["schemas"]["AlbumStatistics_Resource_Object"] | components["schemas"]["Albums_Resource_Object"] | components["schemas"]["Appreciations_Resource_Object"] | components["schemas"]["ArtistBiographies_Resource_Object"] | components["schemas"]["ArtistClaimStatuses_Resource_Object"] | components["schemas"]["ArtistClaims_Resource_Object"] | components["schemas"]["ArtistRoles_Resource_Object"] | components["schemas"]["Artists_Resource_Object"] | components["schemas"]["Artworks_Resource_Object"] | components["schemas"]["Clients_Resource_Object"] | components["schemas"]["CollaborationInviteRedemptions_Resource_Object"] | components["schemas"]["CollaborationInvites_Resource_Object"] | components["schemas"]["Comments_Resource_Object"] | components["schemas"]["ContentClaims_Resource_Object"] | components["schemas"]["Credits_Resource_Object"] | components["schemas"]["Downloads_Resource_Object"] | components["schemas"]["DspSharingLinks_Resource_Object"] | components["schemas"]["DynamicModules_Resource_Object"] | components["schemas"]["DynamicPages_Resource_Object"] | components["schemas"]["Genres_Resource_Object"] | components["schemas"]["Installations_Resource_Object"] | components["schemas"]["Lyrics_Resource_Object"] | components["schemas"]["ManualArtistClaims_Resource_Object"] | components["schemas"]["OfflineTasks_Resource_Object"] | components["schemas"]["PlayQueues_Resource_Object"] | components["schemas"]["Playlists_Resource_Object"] | components["schemas"]["PriceConfigurations_Resource_Object"] | components["schemas"]["ProviderOwners_Resource_Object"] | components["schemas"]["ProviderProductInfos_Resource_Object"] | components["schemas"]["Providers_Resource_Object"] | components["schemas"]["Purchases_Resource_Object"] | components["schemas"]["Reactions_Resource_Object"] | components["schemas"]["SavedShares_Resource_Object"] | components["schemas"]["Scopes_Resource_Object"] | components["schemas"]["SearchHistoryEntries_Resource_Object"] | components["schemas"]["SearchResults_Resource_Object"] | components["schemas"]["SearchSuggestions_Resource_Object"] | components["schemas"]["Shares_Resource_Object"] | components["schemas"]["SquareConnections_Resource_Object"] | components["schemas"]["SquareSites_Resource_Object"] | components["schemas"]["StripeConnections_Resource_Object"] | components["schemas"]["StripeDashboardLinks_Resource_Object"] | components["schemas"]["SubscriptionPriceChangeDecisions_Resource_Object"] | components["schemas"]["TemporaryUserTokens_Resource_Object"] | components["schemas"]["Terms_Resource_Object"] | components["schemas"]["TrackFiles_Resource_Object"] | components["schemas"]["TrackManifests_Resource_Object"] | components["schemas"]["TrackSourceFiles_Resource_Object"] | components["schemas"]["TrackStatistics_Resource_Object"] | components["schemas"]["Tracks_Resource_Object"] | components["schemas"]["TracksMetadataStatus_Resource_Object"] | components["schemas"]["UsageRules_Resource_Object"] | components["schemas"]["UserCollectionAlbums_Resource_Object"] | components["schemas"]["UserCollectionArtists_Resource_Object"] | components["schemas"]["UserCollectionFolders_Resource_Object"] | components["schemas"]["UserCollectionPlaylists_Resource_Object"] | components["schemas"]["UserCollectionSaveForLaters_Resource_Object"] | components["schemas"]["UserCollectionTracks_Resource_Object"] | components["schemas"]["UserCollectionVideos_Resource_Object"] | components["schemas"]["UserCollections_Resource_Object"] | components["schemas"]["UserDailyMixes_Resource_Object"] | components["schemas"]["UserDataExportRequests_Resource_Object"] | components["schemas"]["UserDiscoveryMixes_Resource_Object"] | components["schemas"]["UserNewReleaseMixes_Resource_Object"] | components["schemas"]["UserOfflineMixes_Resource_Object"] | components["schemas"]["UserRecommendationBlocks_Resource_Object"] | components["schemas"]["UserRecommendations_Resource_Object"] | components["schemas"]["UserReports_Resource_Object"] | components["schemas"]["UserSubscriptionPriceChanges_Resource_Object"] | components["schemas"]["Users_Resource_Object"] | components["schemas"]["VideoManifests_Resource_Object"] | components["schemas"]["Videos_Resource_Object"])[]; InstallationsCreateOperation_Payload: { data: components["schemas"]["InstallationsCreateOperation_Payload_Data"]; }; InstallationsCreateOperation_Payload_Data: { attributes: components["schemas"]["InstallationsCreateOperation_Payload_Data_Attributes"]; /** @enum {string} */ type: "installations"; }; InstallationsCreateOperation_Payload_Data_Attributes: { /** @description Client provided installation identifier */ clientProvidedInstallationId: string; /** * @description Human-readable name * @example My iPhone */ name: string; }; InstallationsOfflineInventoryRelationshipAddOperation_Payload: { data: components["schemas"]["InstallationsOfflineInventory_ItemIdentifier"][]; }; InstallationsOfflineInventoryRelationshipRemoveOperation_Payload: { data: components["schemas"]["InstallationsOfflineInventory_ItemIdentifier"][]; }; InstallationsOfflineInventory_ItemIdentifier: { /** @description The item id. Use "me" when the type is userCollectionTracks to resolve to the authenticated user's collection. */ id: string; /** @enum {string} */ type: "tracks" | "videos" | "albums" | "playlists" | "userCollectionTracks"; }; Installations_Attributes: { /** @description Client provided installation identifier */ clientProvidedInstallationId: string; /** * @description Human-readable name for the installation * @example My iPhone */ name: string; }; Installations_Create_Single_Resource_Data_Document: { data: components["schemas"]["Installations_Resource_Object"]; links: components["schemas"]["Links"]; }; Installations_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Installations_Multi_Resource_Data_Document: { data: components["schemas"]["Installations_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Installations_OfflineInventory_Multi_Relationship_Data_Document: { data?: components["schemas"]["Installations_OfflineInventory_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Installations_OfflineInventory_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Installations_OfflineInventory_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Installations_OfflineInventory_Resource_Identifier_Meta: { /** Format: date-time */ addedAt: string; replacement?: components["schemas"]["Replacement_Provenance"]; }; Installations_Relationships: { offlineInventory?: components["schemas"]["Installations_OfflineInventory_Multi_Relationship_Data_Document"]; owners?: components["schemas"]["Multi_Relationship_Data_Document"]; }; Installations_Resource_Object: { attributes?: components["schemas"]["Installations_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["Installations_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "installations"; }; Installations_Single_Resource_Data_Document: { data: components["schemas"]["Installations_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; /** @description List of UPCs retrieved from the DSP */ LegacyBarcodeId: { value?: string; }; LegacySource: { id: string; type: string; }; /** @description A JSON:API link object */ Link_Object: { href?: string; }; Links: { meta?: components["schemas"]["Links_Meta"]; /** * @description Link to next page * @example /artists/xyz/relationships/tracks?page[cursor]=zyx */ next?: string; /** * @description Link to self * @example /artists/xyz/relationships/tracks */ self: string; }; /** @description Non-standard meta information for links */ Links_Meta: { /** * @description Only cursor part of next link * @example zyx */ nextCursor: string; }; LyricsCreateOperation_Payload: { data: components["schemas"]["LyricsCreateOperation_Payload_Data"]; meta?: components["schemas"]["LyricsCreateOperation_Payload_Meta"]; }; LyricsCreateOperation_Payload_Data: { attributes?: components["schemas"]["LyricsCreateOperation_Payload_Data_Attributes"]; relationships: components["schemas"]["LyricsCreateOperation_Payload_Data_Relationships"]; /** @enum {string} */ type: "lyrics"; }; LyricsCreateOperation_Payload_Data_Attributes: { text?: string; }; LyricsCreateOperation_Payload_Data_Relationships: { track: components["schemas"]["LyricsCreateOperation_Payload_Data_Relationships_Track"]; }; LyricsCreateOperation_Payload_Data_Relationships_Track: { data?: components["schemas"]["LyricsCreateOperation_Payload_Data_Relationships_Track_Data"]; /** @deprecated */ id?: string; /** * @deprecated * @enum {string} */ type?: "tracks"; }; LyricsCreateOperation_Payload_Data_Relationships_Track_Data: { id: string; /** @enum {string} */ type: "tracks"; }; LyricsCreateOperation_Payload_Meta: { generate?: boolean; }; LyricsProvider: { name?: string; /** @enum {string} */ source?: "TIDAL" | "THIRD_PARTY"; }; LyricsUpdateOperation_Payload: { data: components["schemas"]["LyricsUpdateOperation_Payload_Data"]; }; LyricsUpdateOperation_Payload_Data: { attributes: components["schemas"]["LyricsUpdateOperation_Payload_Data_Attributes"]; id: string; /** @enum {string} */ type: "lyrics"; }; LyricsUpdateOperation_Payload_Data_Attributes: { lrcText?: string; text?: string; }; Lyrics_Attributes: { /** @enum {string} */ direction?: "LEFT_TO_RIGHT" | "RIGHT_TO_LEFT"; lrcText?: string; provider?: components["schemas"]["ThirdPartyLyricsProvider"] | components["schemas"]["TidalLyricsProvider"]; /** @enum {string} */ technicalStatus: "PENDING" | "PROCESSING" | "ERROR" | "OK"; text?: string; }; Lyrics_Create_Single_Resource_Data_Document: { data: components["schemas"]["Lyrics_Resource_Object"]; links: components["schemas"]["Links"]; }; Lyrics_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Lyrics_Relationships: { owners?: components["schemas"]["Multi_Relationship_Data_Document"]; track?: components["schemas"]["Lyrics_Track_Single_Relationship_Data_Document"]; }; Lyrics_Resource_Object: { attributes?: components["schemas"]["Lyrics_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["Lyrics_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "lyrics"; }; Lyrics_Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Lyrics_Single_Resource_Data_Document: { data: components["schemas"]["Lyrics_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Lyrics_Track_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Lyrics_Track_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Lyrics_Track_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; Lyrics_Track_Single_Relationship_Data_Document: { data?: components["schemas"]["Lyrics_Track_Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; ManualArtistClaimsCreateOperation_Payload: { data: components["schemas"]["ManualArtistClaimsCreateOperation_Payload_Data"]; }; ManualArtistClaimsCreateOperation_Payload_Data: { attributes: components["schemas"]["ManualArtistClaimsCreateOperation_Payload_Data_Attributes"]; /** @enum {string} */ type: "manualArtistClaims"; }; ManualArtistClaimsCreateOperation_Payload_Data_Attributes: { acceptedTerms?: boolean; artistId: string; distributorName?: string; errorReason?: string; labelContactEmail?: string; labelContactName?: string; labelName?: string; legalFirstName: string; legalLastName: string; managerEmail?: string; managerName?: string; role?: string; selectedAlbums?: string[]; selectedSingles?: string[]; socialLink?: components["schemas"]["Link_Object"]; upcs?: string[]; websiteOrSocialLink: components["schemas"]["Link_Object"]; }; ManualArtistClaims_Attributes: { /** @description Accepted terms and conditions */ acceptedTerms?: boolean; /** @description Artist ID being claimed */ artistId: string; /** * Format: date-time * @description Timestamp when the claim was created */ createdAt?: string; /** @description Distributor name */ distributorName?: string; /** @description Enrollment type */ enrollmentType?: string; /** @description Error reason if claim failed */ errorReason?: string; /** @description Label contact email */ labelContactEmail?: string; /** @description Label contact name */ labelContactName?: string; /** @description Label name */ labelName?: string; /** * Format: date-time * @description Timestamp when the claim was last modified */ lastModifiedAt?: string; /** @description Legal first name */ legalFirstName: string; /** @description Legal last name */ legalLastName: string; /** @description Manager email */ managerEmail?: string; /** @description Manager name */ managerName?: string; /** @description Role */ role?: string; /** @description Album IDs selected by user */ selectedAlbums?: string[]; /** @description Single IDs selected by user */ selectedSingles?: string[]; socialLink?: components["schemas"]["Link_Object"]; /** * @description Claim status * @enum {string} */ status?: "SUBMITTED" | "PENDING" | "APPROVED" | "REJECTED"; /** @description UPCs associated with the claim */ upcs?: string[]; websiteOrSocialLink: components["schemas"]["Link_Object"]; }; ManualArtistClaims_Create_Single_Resource_Data_Document: { data: components["schemas"]["ManualArtistClaims_Resource_Object"]; links: components["schemas"]["Links"]; }; ManualArtistClaims_Resource_Object: { attributes?: components["schemas"]["ManualArtistClaims_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "manualArtistClaims"; }; Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; links: components["schemas"]["Links"]; }; Mutation_Response_Document: { links: components["schemas"]["Links"]; /** @description Non-standard meta information */ meta?: { [key: string]: unknown; }; }; OfflineTasksUpdateOperation_Payload: { data: components["schemas"]["OfflineTasksUpdateOperation_Payload_Data"]; }; OfflineTasksUpdateOperation_Payload_Data: { attributes: components["schemas"]["OfflineTasksUpdateOperation_Payload_Data_Attributes"]; id: string; /** @enum {string} */ type: "offlineTasks"; }; OfflineTasksUpdateOperation_Payload_Data_Attributes: { /** * @description New state for the offline task * @enum {string} */ state: "PENDING" | "IN_PROGRESS" | "FAILED" | "COMPLETED"; }; OfflineTasks_Attributes: { /** * @description Action to perform * @enum {string} */ action: "STORE" | "REMOVE"; /** * Format: int32 * @description Collection position of item */ position: number; /** * @description Task state * @enum {string} */ state: "PENDING" | "IN_PROGRESS" | "FAILED" | "COMPLETED"; /** * Format: int32 * @description Collection volume of item */ volume: number; }; OfflineTasks_Collection_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["OfflineTasks_Collection_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; OfflineTasks_Collection_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; OfflineTasks_Collection_Single_Relationship_Data_Document: { data?: components["schemas"]["OfflineTasks_Collection_Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; OfflineTasks_Item_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["OfflineTasks_Item_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; OfflineTasks_Item_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; OfflineTasks_Item_Single_Relationship_Data_Document: { data?: components["schemas"]["OfflineTasks_Item_Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; OfflineTasks_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; OfflineTasks_Multi_Resource_Data_Document: { data: components["schemas"]["OfflineTasks_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; OfflineTasks_Relationships: { collection?: components["schemas"]["OfflineTasks_Collection_Single_Relationship_Data_Document"]; item?: components["schemas"]["OfflineTasks_Item_Single_Relationship_Data_Document"]; owners?: components["schemas"]["Multi_Relationship_Data_Document"]; }; OfflineTasks_Resource_Object: { attributes?: components["schemas"]["OfflineTasks_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["OfflineTasks_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "offlineTasks"; }; OfflineTasks_Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; OfflineTasks_Single_Resource_Data_Document: { data: components["schemas"]["OfflineTasks_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; PlayQueuesCreateOperation_Payload: { data: components["schemas"]["PlayQueuesCreateOperation_Payload_Data"]; }; PlayQueuesCreateOperation_Payload_Data: { /** @enum {string} */ type: "playQueues"; }; PlayQueuesCurrentRelationshipUpdateOperation_Payload: { data: components["schemas"]["PlayQueuesCurrentRelationshipUpdateOperation_Payload_Data"]; }; PlayQueuesCurrentRelationshipUpdateOperation_Payload_Data: { id: string; meta: components["schemas"]["PlayQueuesCurrentRelationshipUpdateOperation_Payload_Data_Meta"]; /** @enum {string} */ type: "tracks" | "videos"; }; PlayQueuesCurrentRelationshipUpdateOperation_Payload_Data_Meta: { itemId: string; }; PlayQueuesFutureRelationshipAddOperation_Payload: { data: components["schemas"]["PlayQueuesFutureRelationshipAddOperation_Payload_Data"][]; meta?: components["schemas"]["PlayQueuesFutureRelationshipAddOperation_Payload_Meta"]; }; PlayQueuesFutureRelationshipAddOperation_Payload_Data: { id: string; meta?: components["schemas"]["PlayQueuesFutureRelationshipAddOperation_Payload_Data_Meta"]; /** @enum {string} */ type: "tracks" | "videos" | "albums" | "playlists"; }; PlayQueuesFutureRelationshipAddOperation_Payload_Data_Meta: { itemCursor?: string; }; PlayQueuesFutureRelationshipAddOperation_Payload_Meta: { /** Format: uuid */ batchId?: string; legacySource?: components["schemas"]["LegacySource"]; /** @enum {string} */ mode: "ADD_TO_FRONT" | "ADD_TO_BACK" | "ADD_BEFORE" | "REPLACE_ALL" | "REPLACE_ALL_AND_CURRENT" | "ADD_TO_FRONT_REPLACE_CURRENT"; positionBefore?: string; }; PlayQueuesFutureRelationshipRemoveOperation_Payload: { data: components["schemas"]["PlayQueuesFutureRelationshipRemoveOperation_Payload_Data"][]; }; PlayQueuesFutureRelationshipRemoveOperation_Payload_Data: { id: string; meta: components["schemas"]["PlayQueuesFutureRelationshipRemoveOperation_Payload_Data_Meta"]; /** @enum {string} */ type: "tracks" | "videos"; }; PlayQueuesFutureRelationshipRemoveOperation_Payload_Data_Meta: { itemId: string; }; PlayQueuesFutureRelationshipUpdateOperation_Payload: { data: components["schemas"]["PlayQueuesFutureRelationshipUpdateOperation_Payload_Data"][]; meta: components["schemas"]["PlayQueuesFutureRelationshipUpdateOperation_Payload_Meta"]; }; PlayQueuesFutureRelationshipUpdateOperation_Payload_Data: { id: string; meta: components["schemas"]["PlayQueuesFutureRelationshipUpdateOperation_Payload_Data_Meta"]; /** @enum {string} */ type: "tracks" | "videos"; }; PlayQueuesFutureRelationshipUpdateOperation_Payload_Data_Meta: { itemId: string; }; PlayQueuesFutureRelationshipUpdateOperation_Payload_Meta: { positionBefore: string; }; PlayQueuesUpdateOperation_Payload: { data: components["schemas"]["PlayQueuesUpdateOperation_Payload_Data"]; }; PlayQueuesUpdateOperation_Payload_Data: { attributes: components["schemas"]["PlayQueuesUpdateOperation_Payload_Data_Attributes"]; id: string; /** @enum {string} */ type: "playQueues"; }; PlayQueuesUpdateOperation_Payload_Data_Attributes: { /** @enum {string} */ repeat?: "NONE" | "ONE" | "BATCH"; /** @enum {string} */ shuffle?: "OFF" | "BATCH" | "ALL"; shuffled?: boolean; }; PlayQueues_Attributes: { /** * Format: date-time * @description ISO 8601 creation timestamp */ createdAt: string; /** * Format: date-time * @description ISO 8601 last modified timestamp */ lastModifiedAt: string; /** * @description Queue's repeat mode * @enum {string} */ repeat: "NONE" | "ONE" | "BATCH"; /** * @description Queue's shuffle mode * @enum {string} */ shuffle: "OFF" | "BATCH" | "ALL"; /** @description Queue is shuffled or not */ shuffled: boolean; }; PlayQueues_Create_Single_Resource_Data_Document: { data: components["schemas"]["PlayQueues_Resource_Object"]; links: components["schemas"]["Links"]; }; PlayQueues_Current_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["PlayQueues_Current_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; PlayQueues_Current_Resource_Identifier_Meta: { /** Format: uuid */ batchId: string; itemId: string; legacySource?: components["schemas"]["LegacySource"]; replacement?: components["schemas"]["Replacement_Provenance"]; }; PlayQueues_Current_Single_Relationship_Data_Document: { data?: components["schemas"]["PlayQueues_Current_Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; PlayQueues_Future_Multi_Relationship_Data_Document: { data?: components["schemas"]["PlayQueues_Future_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; PlayQueues_Future_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["PlayQueues_Future_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; PlayQueues_Future_Resource_Identifier_Meta: { /** Format: uuid */ batchId: string; itemId: string; legacySource?: components["schemas"]["LegacySource"]; replacement?: components["schemas"]["Replacement_Provenance"]; }; PlayQueues_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; PlayQueues_Multi_Resource_Data_Document: { data: components["schemas"]["PlayQueues_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; PlayQueues_Past_Multi_Relationship_Data_Document: { data?: components["schemas"]["PlayQueues_Past_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; PlayQueues_Past_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["PlayQueues_Past_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; PlayQueues_Past_Resource_Identifier_Meta: { /** Format: uuid */ batchId: string; itemId: string; legacySource?: components["schemas"]["LegacySource"]; replacement?: components["schemas"]["Replacement_Provenance"]; }; PlayQueues_Relationships: { current?: components["schemas"]["PlayQueues_Current_Single_Relationship_Data_Document"]; future?: components["schemas"]["PlayQueues_Future_Multi_Relationship_Data_Document"]; owners?: components["schemas"]["Multi_Relationship_Data_Document"]; past?: components["schemas"]["PlayQueues_Past_Multi_Relationship_Data_Document"]; }; PlayQueues_Resource_Object: { attributes?: components["schemas"]["PlayQueues_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["PlayQueues_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "playQueues"; }; PlayQueues_Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; PlayQueues_Single_Resource_Data_Document: { data: components["schemas"]["PlayQueues_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; PlaylistsCollaboratorProfilesRelationshipAddOperation_Payload: { data: components["schemas"]["PlaylistsCollaboratorProfilesRelationshipAddOperation_Payload_Data"][]; }; PlaylistsCollaboratorProfilesRelationshipAddOperation_Payload_Data: { id: string; /** @enum {string} */ type: "artists"; }; PlaylistsCollaboratorProfilesRelationshipRemoveOperation_Payload: { data: components["schemas"]["PlaylistsCollaboratorProfilesRelationshipRemoveOperation_Payload_Data"][]; }; PlaylistsCollaboratorProfilesRelationshipRemoveOperation_Payload_Data: { id: string; /** @enum {string} */ type: "artists"; }; PlaylistsCoverArtRelationshipUpdateOperation_Payload: { data: components["schemas"]["PlaylistsCoverArtRelationshipUpdateOperation_Payload_Data"][]; }; PlaylistsCoverArtRelationshipUpdateOperation_Payload_Data: { id: string; /** @enum {string} */ type: "artworks"; }; PlaylistsCreateOperation_Payload: { data: components["schemas"]["PlaylistsCreateOperation_Payload_Data"]; }; PlaylistsCreateOperation_Payload_Data: { attributes: components["schemas"]["PlaylistsCreateOperation_Payload_Data_Attributes"]; /** @enum {string} */ type: "playlists"; }; PlaylistsCreateOperation_Payload_Data_Attributes: { /** * @description User-selectable playlist visibility. * @example PUBLIC * @enum {string} */ accessType?: "PUBLIC" | "UNLISTED"; /** Format: date-time */ createdAt?: string; description?: string; name: string; }; PlaylistsItemsRelationshipAddOperation_Payload: { data: components["schemas"]["PlaylistsItemsRelationshipAddOperation_Payload_Data"][]; meta?: components["schemas"]["PlaylistsItemsRelationshipAddOperation_Payload_Meta"]; }; PlaylistsItemsRelationshipAddOperation_Payload_Data: { id: string; meta?: components["schemas"]["PlaylistsItemsRelationshipAddOperation_Payload_Data_Meta"]; /** @enum {string} */ type: "tracks" | "videos"; }; PlaylistsItemsRelationshipAddOperation_Payload_Data_Meta: { /** Format: date-time */ addedAt?: string; }; PlaylistsItemsRelationshipAddOperation_Payload_Meta: { positionBefore: string; }; PlaylistsItemsRelationshipAddOperation_Response_Meta_SkippedItem: { id: string; /** @enum {string} */ reason: "NOT_FOUND"; /** @enum {string} */ type: "tracks" | "videos"; }; PlaylistsItemsRelationshipRemoveOperation_Payload: { data: components["schemas"]["PlaylistsItemsRelationshipRemoveOperation_Payload_Data"][]; }; PlaylistsItemsRelationshipRemoveOperation_Payload_Data: { id: string; meta: components["schemas"]["PlaylistsItemsRelationshipRemoveOperation_Payload_Data_Meta"]; /** @enum {string} */ type: "tracks" | "videos"; }; PlaylistsItemsRelationshipRemoveOperation_Payload_Data_Meta: { itemId: string; }; PlaylistsItemsRelationshipUpdateOperation_Payload: { data: components["schemas"]["PlaylistsItemsRelationshipUpdateOperation_Payload_Data"][]; meta?: components["schemas"]["PlaylistsItemsRelationshipUpdateOperation_Payload_Meta"]; }; PlaylistsItemsRelationshipUpdateOperation_Payload_Data: { id: string; meta: components["schemas"]["PlaylistsItemsRelationshipUpdateOperation_Payload_Data_Meta"]; /** @enum {string} */ type: "tracks" | "videos"; }; PlaylistsItemsRelationshipUpdateOperation_Payload_Data_Meta: { itemId: string; }; PlaylistsItemsRelationshipUpdateOperation_Payload_Meta: { positionBefore: string; }; PlaylistsUpdateOperation_Payload: { data: components["schemas"]["PlaylistsUpdateOperation_Payload_Data"]; }; PlaylistsUpdateOperation_Payload_Data: { attributes: components["schemas"]["PlaylistsUpdateOperation_Payload_Data_Attributes"]; id: string; /** @enum {string} */ type: "playlists"; }; PlaylistsUpdateOperation_Payload_Data_Attributes: { /** * @description User-selectable playlist visibility. * @example PUBLIC * @enum {string} */ accessType?: "PUBLIC" | "UNLISTED"; description?: string; name?: string; }; Playlists_Attributes: { /** * @description Access type * @example PRIVATE * @enum {string} */ accessType: "PUBLIC" | "UNLISTED" | "PRIVATE"; /** @description Indicates if the playlist has a duration and set number of tracks */ bounded: boolean; /** * Format: date-time * @description Datetime of playlist creation (ISO 8601) */ createdAt: string; /** @description Playlist description */ description?: string; /** * @description Duration of playlist (ISO 8601) * @example P30M5S */ duration?: string; externalLinks: components["schemas"]["External_Link"][]; /** * Format: date-time * @description Datetime of last modification of the playlist (ISO 8601) */ lastModifiedAt: string; /** @description Playlist name */ name: string; /** * Format: int32 * @description The amount of followers of the playlist */ numberOfFollowers: number; /** * Format: int32 * @description Number of items in the items relationship */ numberOfItems?: number; /** * Format: int32 * @description Number of track items in the items relationship */ numberOfTrackItems?: number; /** * Format: int32 * @description Number of video items in the items relationship */ numberOfVideoItems?: number; /** * @description The type of the playlist * @enum {string} */ playlistType: "EDITORIAL" | "USER" | "MIX" | "ARTIST"; }; Playlists_Create_Single_Resource_Data_Document: { data: components["schemas"]["Playlists_Resource_Object"]; links: components["schemas"]["Links"]; }; Playlists_Items_Add_Multi_Relationship_Data_Document: { data: components["schemas"]["Playlists_Items_Add_Resource_Identifier"][]; links: components["schemas"]["Links"]; meta?: components["schemas"]["Playlists_Items_Add_Multi_Relationship_Data_Document_Meta"]; }; Playlists_Items_Add_Multi_Relationship_Data_Document_Meta: { skipped: components["schemas"]["PlaylistsItemsRelationshipAddOperation_Response_Meta_SkippedItem"][]; }; Playlists_Items_Add_Resource_Identifier: { id: string; meta?: components["schemas"]["Playlists_Items_Add_Resource_Identifier_Meta"]; /** @enum {string} */ type: "tracks" | "videos"; }; Playlists_Items_Add_Resource_Identifier_Meta: { /** Format: date-time */ addedAt: string; itemId: string; }; Playlists_Items_Multi_Relationship_Data_Document: { data?: components["schemas"]["Playlists_Items_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Playlists_Items_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Playlists_Items_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Playlists_Items_Resource_Identifier_Meta: { /** Format: date-time */ addedAt?: string; itemCursor?: string; itemId?: string; replacement?: components["schemas"]["Replacement_Provenance"]; }; Playlists_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Playlists_Multi_Resource_Data_Document: { data: components["schemas"]["Playlists_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Playlists_Relationships: { collaboratorProfiles?: components["schemas"]["Multi_Relationship_Data_Document"]; collaborators?: components["schemas"]["Multi_Relationship_Data_Document"]; coverArt?: components["schemas"]["Multi_Relationship_Data_Document"]; items?: components["schemas"]["Playlists_Items_Multi_Relationship_Data_Document"]; ownerProfiles?: components["schemas"]["Multi_Relationship_Data_Document"]; owners?: components["schemas"]["Multi_Relationship_Data_Document"]; suggestedCoverArts?: components["schemas"]["Playlists_SuggestedCoverArts_Multi_Relationship_Data_Document"]; }; Playlists_Resource_Object: { attributes?: components["schemas"]["Playlists_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["Playlists_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "playlists"; }; Playlists_Single_Resource_Data_Document: { data: components["schemas"]["Playlists_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Playlists_SuggestedCoverArts_Multi_Relationship_Data_Document: { data?: components["schemas"]["Playlists_SuggestedCoverArts_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Playlists_SuggestedCoverArts_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Playlists_SuggestedCoverArts_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Playlists_SuggestedCoverArts_Resource_Identifier_Meta: { /** @description Background color for the suggested artwork */ backgroundColor: string; /** @description Foreground color for the suggested artwork */ foregroundColor: string; }; Playlists_Update_Single_Resource_Data_Document: { data: components["schemas"]["Playlists_Resource_Object"]; links: components["schemas"]["Links"]; }; PriceConfigurationsCreateOperation_Payload: { data: components["schemas"]["PriceConfigurationsCreateOperation_Payload_Data"]; }; PriceConfigurationsCreateOperation_Payload_Data: { attributes: components["schemas"]["PriceConfigurationsCreateOperation_Payload_Data_Attributes"]; relationships: components["schemas"]["PriceConfigurationsCreateOperation_Payload_Data_Relationships"]; /** @enum {string} */ type: "priceConfigurations"; }; PriceConfigurationsCreateOperation_Payload_Data_Attributes: { /** * @description Currency code (ISO 4217) * @enum {string} */ currency: "USD"; /** * @description Price amount with max 2 decimal places * @example 9.99 */ price: string; }; PriceConfigurationsCreateOperation_Payload_Data_Relationships: { subjects: components["schemas"]["PriceConfigurationsCreateOperation_Payload_Data_Relationships_Subjects"]; }; PriceConfigurationsCreateOperation_Payload_Data_Relationships_Subjects: { data: components["schemas"]["PriceConfigurationsCreateOperation_Payload_Subjects"][]; }; PriceConfigurationsCreateOperation_Payload_Subjects: { id: string; /** @enum {string} */ type: "tracks" | "albums"; }; PriceConfigurations_Attributes: { /** * @description Currency code (ISO 4217) * @enum {string} */ currency: "USD"; /** * @description Price amount with max 2 decimal places * @example 9.99 */ price: string; }; PriceConfigurations_Create_Single_Resource_Data_Document: { data: components["schemas"]["PriceConfigurations_Resource_Object"]; links: components["schemas"]["Links"]; }; PriceConfigurations_Multi_Resource_Data_Document: { data: components["schemas"]["PriceConfigurations_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; PriceConfigurations_Resource_Object: { attributes?: components["schemas"]["PriceConfigurations_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "priceConfigurations"; }; PriceConfigurations_Single_Resource_Data_Document: { data: components["schemas"]["PriceConfigurations_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; ProviderOwners_Attributes: { /** Format: date-time */ createdAt: string; }; ProviderOwners_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; ProviderOwners_Multi_Resource_Data_Document: { data: components["schemas"]["ProviderOwners_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; ProviderOwners_Relationships: { owners?: components["schemas"]["Multi_Relationship_Data_Document"]; provider?: components["schemas"]["Single_Relationship_Data_Document"]; }; ProviderOwners_Resource_Object: { attributes?: components["schemas"]["ProviderOwners_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["ProviderOwners_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "providerOwners"; }; ProviderOwners_Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; ProviderProductInfos_Attributes: { barcodeId?: string; broken?: boolean; /** Format: int32 */ brokenCode?: number; grid?: string; tracks?: components["schemas"]["TrackInfo"][]; }; ProviderProductInfos_Multi_Resource_Data_Document: { data: components["schemas"]["ProviderProductInfos_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; ProviderProductInfos_Relationships: { provider?: components["schemas"]["Single_Relationship_Data_Document"]; subject?: components["schemas"]["ProviderProductInfos_Subject_Single_Relationship_Data_Document"]; }; ProviderProductInfos_Resource_Object: { attributes?: components["schemas"]["ProviderProductInfos_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["ProviderProductInfos_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "providerProductInfos"; }; ProviderProductInfos_Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; ProviderProductInfos_Subject_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["ProviderProductInfos_Subject_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; ProviderProductInfos_Subject_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; ProviderProductInfos_Subject_Single_Relationship_Data_Document: { data?: components["schemas"]["ProviderProductInfos_Subject_Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Providers_Attributes: { /** * @description Provider name * @example Columbia/Legacy */ name: string; }; Providers_Resource_Object: { attributes?: components["schemas"]["Providers_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "providers"; }; Providers_Single_Resource_Data_Document: { data: components["schemas"]["Providers_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Purchases_Attributes: { /** * Format: date-time * @description Datetime of purchase (ISO 8601) */ createdAt: string; /** * @description Current status of the purchase * @enum {string} */ status: "ACTIVE"; }; Purchases_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Purchases_Multi_Resource_Data_Document: { data: components["schemas"]["Purchases_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Purchases_Relationships: { owners?: components["schemas"]["Multi_Relationship_Data_Document"]; subject?: components["schemas"]["Purchases_Subject_Single_Relationship_Data_Document"]; }; Purchases_Resource_Object: { attributes?: components["schemas"]["Purchases_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["Purchases_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "purchases"; }; Purchases_Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Purchases_Subject_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Purchases_Subject_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Purchases_Subject_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; Purchases_Subject_Single_Relationship_Data_Document: { data?: components["schemas"]["Purchases_Subject_Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; /** @description Reaction statistics */ ReactionStats: { /** @description Count of reactions by type */ countsByType?: { [key: string]: number; }; /** * Format: int32 * @description Total number of reactions */ totalCount?: number; }; ReactionsCreateOperation_Payload: { data: components["schemas"]["ReactionsCreateOperation_Payload_Data"]; }; ReactionsCreateOperation_Payload_Data: { attributes: components["schemas"]["ReactionsCreateOperation_Payload_Data_Attributes"]; relationships: components["schemas"]["ReactionsCreateOperation_Payload_Data_Relationships"]; /** @enum {string} */ type: "reactions"; }; ReactionsCreateOperation_Payload_Data_Attributes: { emoji: string; }; ReactionsCreateOperation_Payload_Data_Relationships: { subject: components["schemas"]["ReactionsCreateOperation_Payload_Data_Relationships_Subject"]; }; ReactionsCreateOperation_Payload_Data_Relationships_Subject: { data: components["schemas"]["ReactionsCreateOperation_Payload_Data_Relationships_Subject_Data"]; }; ReactionsCreateOperation_Payload_Data_Relationships_Subject_Data: { id: string; /** @enum {string} */ type: "albums" | "tracks" | "artists" | "videos" | "playlists" | "comments"; }; Reactions_Attributes: { /** * Format: date-time * @description Datetime of the reaction creation (ISO 8601) * @example 2025-11-17T12:54:48.60606Z */ createdAt: string; /** @description The type of reaction representing an emoji */ emoji: string; }; Reactions_Create_Single_Resource_Data_Document: { data: components["schemas"]["Reactions_Resource_Object"]; links: components["schemas"]["Links"]; }; Reactions_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Reactions_Multi_Resource_Data_Document: { data: components["schemas"]["Reactions_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; meta?: components["schemas"]["Reactions_Multi_Resource_Data_Document_Meta"]; }; /** @description Reaction response metadata with stats and current user reaction */ Reactions_Multi_Resource_Data_Document_Meta: { currentUserReaction?: components["schemas"]["CurrentUserReaction"]; stats?: components["schemas"]["ReactionStats"]; }; Reactions_Relationships: { ownerProfiles?: components["schemas"]["Multi_Relationship_Data_Document"]; owners?: components["schemas"]["Multi_Relationship_Data_Document"]; }; Reactions_Resource_Object: { attributes?: components["schemas"]["Reactions_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["Reactions_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "reactions"; }; /** @description Relationship identifier before contextual replacement projection. */ Replacement_Original_Identifier: { /** @example 12345 */ id: string; /** @example tracks */ type: string; }; /** @description Relationship replacement projection provenance. ORIGINAL retains the requested identifier as the applicable resource, REPLACED projects another identifier, and NOT_REPLACED retains the requested identifier because no applicable replacement exists. */ Replacement_Provenance: { original?: components["schemas"]["Replacement_Original_Identifier"]; /** @enum {string} */ status: "ORIGINAL" | "REPLACED" | "NOT_REPLACED"; }; Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; /** * @description Resource type * @example tracks */ type: string; }; Resource_ObjectObjectObject: { attributes?: Record; /** * @description Resource id * @example 12345 */ id: string; relationships?: Record; /** * @description Resource type * @example tracks */ type: string; }; SavedSharesCreateOperation_Payload: { data: components["schemas"]["SavedSharesCreateOperation_Payload_Data"]; }; SavedSharesCreateOperation_Payload_Data: { relationships: components["schemas"]["SavedSharesCreateOperation_Payload_Data_Relationships"]; /** @enum {string} */ type: "savedShares"; }; SavedSharesCreateOperation_Payload_Data_Relationships: { share: components["schemas"]["SavedSharesCreateOperation_Payload_Data_Relationships_Share"]; }; SavedSharesCreateOperation_Payload_Data_Relationships_Share: { data: components["schemas"]["SavedSharesCreateOperation_Payload_Data_Relationships_Share_Data"]; }; SavedSharesCreateOperation_Payload_Data_Relationships_Share_Data: { id: string; /** @enum {string} */ type: "shares"; }; SavedShares_Attributes: { /** * Format: date-time * @description Datetime of saved share creation (ISO 8601) */ createdAt: string; }; SavedShares_Create_Single_Resource_Data_Document: { data: components["schemas"]["SavedShares_Resource_Object"]; links: components["schemas"]["Links"]; }; SavedShares_Resource_Object: { attributes?: components["schemas"]["SavedShares_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "savedShares"; }; Scopes_Attributes: { /** * @description Text shown to the end user on the OAuth consent screen when this scope is requested. * @example List all playlists created by you. */ consentText?: string; /** * @description Technical description of the scope. * @example Required to list playlists created by a user. */ description: string; /** * @description Wire-format scope name as used in OAuth requests. * @example playlists.read */ name: string; /** * @description Client access tier required to request this scope. A client whose access tier is at least this value can include the scope when initiating an OAuth flow. * @example THIRD_PARTY * @enum {string} */ requiredAccessTier: "THIRD_PARTY" | "THIRD_PARTY_PROD" | "PARTNER" | "INTERNAL"; }; Scopes_Multi_Resource_Data_Document: { data: components["schemas"]["Scopes_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Scopes_Resource_Object: { attributes?: components["schemas"]["Scopes_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "scopes"; }; SearchHistoryEntries_Attributes: { query: string; }; SearchHistoryEntries_Resource_Object: { attributes?: components["schemas"]["SearchHistoryEntries_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "searchHistoryEntries"; }; SearchResults_Albums_Multi_Relationship_Data_Document: { data?: components["schemas"]["SearchResults_Albums_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; SearchResults_Albums_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["SearchResults_Albums_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; SearchResults_Albums_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; SearchResults_Artists_Multi_Relationship_Data_Document: { data?: components["schemas"]["SearchResults_Artists_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; SearchResults_Artists_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["SearchResults_Artists_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; SearchResults_Artists_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; SearchResults_Attributes: { /** * @description 'did you mean' prompt * @example beatles */ didYouMean?: string; /** * @description The search query represented by this resource * @example hello */ query: string; /** * @description search request unique tracking number * @example 5896e37d-e847-4ca6-9629-ef8001719f7f */ trackingId: string; }; SearchResults_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; SearchResults_Multi_Resource_Data_Document: { data: components["schemas"]["SearchResults_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; SearchResults_Playlists_Multi_Relationship_Data_Document: { data?: components["schemas"]["SearchResults_Playlists_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; SearchResults_Playlists_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["SearchResults_Playlists_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; SearchResults_Playlists_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; SearchResults_Relationships: { albums?: components["schemas"]["SearchResults_Albums_Multi_Relationship_Data_Document"]; artists?: components["schemas"]["SearchResults_Artists_Multi_Relationship_Data_Document"]; playlists?: components["schemas"]["SearchResults_Playlists_Multi_Relationship_Data_Document"]; topHits?: components["schemas"]["SearchResults_TopHits_Multi_Relationship_Data_Document"]; tracks?: components["schemas"]["SearchResults_Tracks_Multi_Relationship_Data_Document"]; videos?: components["schemas"]["SearchResults_Videos_Multi_Relationship_Data_Document"]; }; SearchResults_Resource_Object: { attributes?: components["schemas"]["SearchResults_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["SearchResults_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "searchResults"; }; SearchResults_TopHits_Multi_Relationship_Data_Document: { data?: components["schemas"]["SearchResults_TopHits_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; SearchResults_TopHits_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["SearchResults_TopHits_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; SearchResults_TopHits_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; SearchResults_Tracks_Multi_Relationship_Data_Document: { data?: components["schemas"]["SearchResults_Tracks_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; SearchResults_Tracks_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["SearchResults_Tracks_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; SearchResults_Tracks_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; SearchResults_Videos_Multi_Relationship_Data_Document: { data?: components["schemas"]["SearchResults_Videos_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; SearchResults_Videos_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["SearchResults_Videos_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; SearchResults_Videos_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; SearchSuggestions_Attributes: { /** * @description The search query represented by this resource * @example hello */ query: string; /** @description Suggested search queries */ suggestions?: components["schemas"]["SearchSuggestions_Suggestions"][]; /** @description Unique tracking id */ trackingId: string; }; SearchSuggestions_DirectHits_Multi_Relationship_Data_Document: { data?: components["schemas"]["SearchSuggestions_DirectHits_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; SearchSuggestions_DirectHits_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["SearchSuggestions_DirectHits_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; SearchSuggestions_DirectHits_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; SearchSuggestions_Highlights: { /** Format: int32 */ length: number; /** Format: int32 */ start: number; }; SearchSuggestions_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; SearchSuggestions_Multi_Resource_Data_Document: { data: components["schemas"]["SearchSuggestions_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; SearchSuggestions_Relationships: { directHits?: components["schemas"]["SearchSuggestions_DirectHits_Multi_Relationship_Data_Document"]; history?: components["schemas"]["Multi_Relationship_Data_Document"]; }; SearchSuggestions_Resource_Object: { attributes?: components["schemas"]["SearchSuggestions_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["SearchSuggestions_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "searchSuggestions"; }; /** @description Suggested search queries */ SearchSuggestions_Suggestions: { highlights?: components["schemas"]["SearchSuggestions_Highlights"][]; query: string; }; SharesCreateOperation_Payload: { data: components["schemas"]["SharesCreateOperation_Payload_Data"]; }; SharesCreateOperation_Payload_Data: { relationships: components["schemas"]["SharesCreateOperation_Payload_Data_Relationships"]; /** @enum {string} */ type: "shares"; }; SharesCreateOperation_Payload_Data_Relationships: { sharedResources: components["schemas"]["SharesCreateOperation_Payload_Data_Relationships_SharedResources"]; }; SharesCreateOperation_Payload_Data_Relationships_SharedResources: { data: components["schemas"]["SharesCreateOperation_Payload_Data_Relationships_SharedResources_Data"][]; }; SharesCreateOperation_Payload_Data_Relationships_SharedResources_Data: { id: string; /** @enum {string} */ type: "tracks" | "albums"; }; Shares_Attributes: { /** @description Share code */ code: string; /** * Format: date-time * @description Datetime of share creation (ISO 8601) */ createdAt: string; /** @description Links external to TIDAL API */ externalLinks?: components["schemas"]["External_Link"][]; }; Shares_Create_Single_Resource_Data_Document: { data: components["schemas"]["Shares_Resource_Object"]; links: components["schemas"]["Links"]; }; Shares_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Shares_Multi_Resource_Data_Document: { data: components["schemas"]["Shares_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Shares_Relationships: { owners?: components["schemas"]["Multi_Relationship_Data_Document"]; sharedResources?: components["schemas"]["Shares_SharedResources_Multi_Relationship_Data_Document"]; }; Shares_Resource_Object: { attributes?: components["schemas"]["Shares_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["Shares_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "shares"; }; Shares_SharedResources_Multi_Relationship_Data_Document: { data?: components["schemas"]["Shares_SharedResources_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Shares_SharedResources_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Shares_SharedResources_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Shares_SharedResources_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; Shares_Single_Resource_Data_Document: { data: components["schemas"]["Shares_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); links: components["schemas"]["Links"]; }; SquareConnectionsCreateOperation_Payload: { data: components["schemas"]["SquareConnectionsCreateOperation_Payload_Data"]; meta: components["schemas"]["SquareConnectionsCreateOperation_Payload_Meta"]; }; SquareConnectionsCreateOperation_Payload_Data: { /** @enum {string} */ type: "squareConnections"; }; SquareConnectionsCreateOperation_Payload_Meta: { /** * @description Client platform initiating Square onboarding. * @enum {string} */ platform: "WEB" | "ANDROID" | "IOS"; /** * @description Optional post-finalize redirect URL. Otherwise uses platform default. * @example tidal://square-auth/return?flow=onboarding&ref=abc */ redirectUrl?: string; }; SquareConnectionsReadById403ResponseBody: { errors: { /** * @example REQUIRED_TERMS_NOT_ACCEPTED * @enum {string} */ code: "REQUIRED_TERMS_NOT_ACCEPTED"; /** @example Latest terms and conditions must be accepted */ detail?: string; /** @example 403 */ status: string; }[]; }; SquareConnectionsReadMultiDataRelationship403ResponseBody: { errors: { /** * @example REQUIRED_TERMS_NOT_ACCEPTED * @enum {string} */ code: "REQUIRED_TERMS_NOT_ACCEPTED"; /** @example Latest terms and conditions must be accepted */ detail?: string; /** @example 403 */ status: string; }[]; }; SquareConnectionsReadSingleDataRelationship403ResponseBody: { errors: { /** * @example REQUIRED_TERMS_NOT_ACCEPTED * @enum {string} */ code: "REQUIRED_TERMS_NOT_ACCEPTED"; /** @example Latest terms and conditions must be accepted */ detail?: string; /** @example 403 */ status: string; }[]; }; SquareConnectionsSelectedSiteRelationshipUpdateOperation_Payload: { data: components["schemas"]["SquareConnectionsSelectedSiteRelationshipUpdateOperation_Payload_Data"] | (never | null); }; /** @description The site to select; null clears the selection. */ SquareConnectionsSelectedSiteRelationshipUpdateOperation_Payload_Data: { id: string; /** @enum {string} */ type: "squareSites"; }; SquareConnectionsUpdateSingleDataRelationship403ResponseBody: { errors: { /** * @example REQUIRED_TERMS_NOT_ACCEPTED * @enum {string} */ code: "REQUIRED_TERMS_NOT_ACCEPTED"; /** @example Latest terms and conditions must be accepted */ detail?: string; /** @example 403 */ status: string; }[]; }; SquareConnectionsUpdateSingleDataRelationship409ResponseBody: { errors: { /** * @example IDEMPOTENT_REQUEST_IN_PROGRESS * @enum {string} */ code: "IDEMPOTENT_REQUEST_IN_PROGRESS" | "MISSING_SITES_SCOPE"; /** @example Square credential lacks required site scopes; run Square onboarding again */ detail?: string; /** @example 409 */ status: string; }[]; }; SquareConnections_Attributes: { /** @description Per-feature capability statuses for this Square connection. Every capability the connection offers is listed with a status carrying more than mere presence: SITES is GRANTED when the Square Online sites scopes are granted, or REQUIRES_REAUTH when the connection exists but its credential lacks them (the seller must reconnect Square via POST /squareConnections). Because a connection always offers the sites feature, SITES is always present here. Extensible — only SITES is defined today. Absent only when the connection has no sites state (e.g. no approved Square credential). Client rule: if SITES != GRANTED prompt reconnect; else if selectedSite.data is null show the site picker; else the selected site is shown to buyers. */ capabilities?: components["schemas"]["SquareConnections_Capability"][]; /** * Format: date-time * @description Timestamp when the connection was created */ createdAt?: string; /** @description External links for Square connection */ externalLinks?: components["schemas"]["External_Link"][]; /** * Format: date-time * @description Timestamp when the connection was last modified */ lastModifiedAt?: string; /** * @description Current status of this Square connection * @enum {string} */ status: "DRAFT" | "PENDING_REQUIREMENTS" | "KYC_PENDING" | "ACCEPTED" | "REJECTED" | "SUSPENDED"; }; SquareConnections_Capability: { /** * @description The capability name * @enum {string} */ name: "SITES"; /** * @description The capability's current status * @enum {string} */ status: "GRANTED" | "REQUIRES_REAUTH"; }; SquareConnections_Create_Single_Resource_Data_Document: { data: components["schemas"]["SquareConnections_Resource_Object"]; links: components["schemas"]["Links"]; }; SquareConnections_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; SquareConnections_Relationships: { selectedSite?: components["schemas"]["Single_Relationship_Data_Document"]; sites?: components["schemas"]["Multi_Relationship_Data_Document"]; }; SquareConnections_Resource_Object: { attributes?: components["schemas"]["SquareConnections_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["SquareConnections_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "squareConnections"; }; SquareConnections_SelectedSite_Update_Resource_Identifier: { id: string; /** @enum {string} */ type: "squareSites"; }; SquareConnections_SelectedSite_Update_Single_Relationship_Data_Document: { data: components["schemas"]["SquareConnections_SelectedSite_Update_Resource_Identifier"] | (never | null); links: components["schemas"]["Links"]; }; SquareConnections_Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; SquareConnections_Single_Resource_Data_Document: { data: components["schemas"]["SquareConnections_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; SquareSites_Attributes: { /** @description The site's domain, if one is configured */ domain?: string; /** @description Whether the site is published on Square Online */ published?: boolean; /** @description The site's title as set by the seller in Square */ siteTitle?: string; }; SquareSites_Resource_Object: { attributes?: components["schemas"]["SquareSites_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "squareSites"; }; StripeConnectionsCreateOperation_Payload: { data: components["schemas"]["StripeConnectionsCreateOperation_Payload_Data"]; meta?: components["schemas"]["StripeConnectionsCreateOperation_Payload_Meta"]; }; StripeConnectionsCreateOperation_Payload_Data: { attributes?: components["schemas"]["StripeConnectionsCreateOperation_Payload_Data_Attributes"]; /** @enum {string} */ type: "stripeConnections"; }; StripeConnectionsCreateOperation_Payload_Data_Attributes: { /** * @deprecated * @description Deprecated: use meta.integrationType instead. * @default REDIRECT * @example REDIRECT * @enum {string} */ integrationType: "REDIRECT" | "EMBEDDED"; /** * @deprecated * @description Deprecated: use meta.refreshUrl instead. * @example https://www.tidal.com/artist/upload/onboarding */ refreshUrl?: string; /** * @deprecated * @description Deprecated: use meta.returnUrl instead. * @example https://www.tidal.com/artist/124 */ returnUrl?: string; }; StripeConnectionsCreateOperation_Payload_Meta: { /** * @description Integration type for Stripe onboarding * @default REDIRECT * @example REDIRECT * @enum {string} */ integrationType: "REDIRECT" | "EMBEDDED"; /** * @description REDIRECT only: URL to redirect to if seller drops from onboarding * @example https://www.tidal.com/artist/upload/onboarding */ refreshUrl?: string; /** * @description REDIRECT only: URL to redirect to after completed onboarding * @example https://www.tidal.com/artist/124 */ returnUrl?: string; }; StripeConnections_Attributes: { /** * Format: date-time * @description Timestamp when the connection was created */ createdAt?: string; /** @description External links for Stripe connection */ externalLinks?: components["schemas"]["External_Link"][]; /** * Format: date-time * @description Timestamp when the connection was last modified */ lastModifiedAt?: string; /** * @description Current status of this Stripe connection * @enum {string} */ status: "PENDING_REQUIREMENTS" | "UNDER_REVIEW" | "ACCEPTED" | "REJECTED" | "SUSPENDED"; }; StripeConnections_Create_Single_Resource_Data_Document: { data: components["schemas"]["StripeConnections_Resource_Object"]; links: components["schemas"]["Links"]; }; StripeConnections_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; StripeConnections_Multi_Resource_Data_Document: { data: components["schemas"]["StripeConnections_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; StripeConnections_Relationships: { owners?: components["schemas"]["Multi_Relationship_Data_Document"]; }; StripeConnections_Resource_Object: { attributes?: components["schemas"]["StripeConnections_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["StripeConnections_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "stripeConnections"; }; StripeDashboardLinks_Attributes: { dashboardLink?: components["schemas"]["Link_Object"]; }; StripeDashboardLinks_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; StripeDashboardLinks_Multi_Resource_Data_Document: { data: components["schemas"]["StripeDashboardLinks_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; StripeDashboardLinks_Relationships: { owners?: components["schemas"]["Multi_Relationship_Data_Document"]; }; StripeDashboardLinks_Resource_Object: { attributes?: components["schemas"]["StripeDashboardLinks_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["StripeDashboardLinks_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "stripeDashboardLinks"; }; SubscriptionPriceChangeDecisionsCreateOperation_Payload: { data: components["schemas"]["SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data"]; }; SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data: { attributes: components["schemas"]["SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Attributes"]; relationships: components["schemas"]["SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships"]; /** @enum {string} */ type: "subscriptionPriceChangeDecisions"; }; SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Attributes: { /** * @description The decision to record. A decision may only be created once — changing a rejection to an acceptance is a PATCH. * @enum {string} */ status: "ACCEPTED" | "REJECTED"; }; SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships: { priceChange: components["schemas"]["SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships_PriceChange"]; }; SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships_PriceChange: { data: components["schemas"]["SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships_PriceChange_Data"]; }; SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships_PriceChange_Data: { id: string; /** @enum {string} */ type: "userSubscriptionPriceChanges"; }; SubscriptionPriceChangeDecisionsUpdateOperation_Payload: { data: components["schemas"]["SubscriptionPriceChangeDecisionsUpdateOperation_Payload_Data"]; }; SubscriptionPriceChangeDecisionsUpdateOperation_Payload_Data: { attributes: components["schemas"]["SubscriptionPriceChangeDecisionsUpdateOperation_Payload_Data_Attributes"]; id: string; /** @enum {string} */ type: "subscriptionPriceChangeDecisions"; }; SubscriptionPriceChangeDecisionsUpdateOperation_Payload_Data_Attributes: { /** * @description The decision to record. The only allowed transition is REJECTED -> ACCEPTED; acceptance is permanent. * @enum {string} */ status: "ACCEPTED" | "REJECTED"; }; SubscriptionPriceChangeDecisions_Attributes: { /** * Format: date-time * @description When the user decided. Absent when the consent was implicit (derived from the subscription start). */ decidedAt?: string; /** * @description The user's decision. ACCEPTED is permanent; REJECTED can still be flipped to ACCEPTED before the renewal. * @enum {string} */ status: "ACCEPTED" | "REJECTED"; }; SubscriptionPriceChangeDecisions_Create_Single_Resource_Data_Document: { data: components["schemas"]["SubscriptionPriceChangeDecisions_Resource_Object"]; links: components["schemas"]["Links"]; }; SubscriptionPriceChangeDecisions_Multi_Resource_Data_Document: { data: components["schemas"]["SubscriptionPriceChangeDecisions_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; SubscriptionPriceChangeDecisions_Relationships: { priceChange?: components["schemas"]["Single_Relationship_Data_Document"]; }; SubscriptionPriceChangeDecisions_Resource_Object: { attributes?: components["schemas"]["SubscriptionPriceChangeDecisions_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["SubscriptionPriceChangeDecisions_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "subscriptionPriceChangeDecisions"; }; SubscriptionPriceChangeDecisions_Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; SubscriptionPriceChangeDecisions_Update_Single_Resource_Data_Document: { data: components["schemas"]["SubscriptionPriceChangeDecisions_Resource_Object"]; links: components["schemas"]["Links"]; }; TemporaryUserTokensCreateOperation_Payload: { data: components["schemas"]["TemporaryUserTokensCreateOperation_Payload_Data"]; }; TemporaryUserTokensCreateOperation_Payload_Data: { /** @enum {string} */ type: "temporaryUserTokens"; }; TemporaryUserTokens_Attributes: Record; TemporaryUserTokens_Create_Single_Resource_Data_Document: { data: components["schemas"]["TemporaryUserTokens_Resource_Object"]; links: components["schemas"]["Links"]; }; TemporaryUserTokens_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; TemporaryUserTokens_Relationships: { owners?: components["schemas"]["Multi_Relationship_Data_Document"]; }; TemporaryUserTokens_Resource_Object: { attributes?: components["schemas"]["TemporaryUserTokens_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["TemporaryUserTokens_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "temporaryUserTokens"; }; TemporaryUserTokens_Single_Resource_Data_Document: { data: components["schemas"]["TemporaryUserTokens_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Terms_Attributes: { contentLink: components["schemas"]["Link_Object"]; countryCode: string; /** Format: date-time */ effectiveAt: string; /** @enum {string} */ termsType: "DEVELOPER" | "UPLOAD_MARKETPLACE" | "MERCH_GUIDELINES"; }; Terms_Multi_Resource_Data_Document: { data: components["schemas"]["Terms_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Terms_Resource_Object: { attributes?: components["schemas"]["Terms_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Terms_Resource_Object_Meta"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "terms"; }; Terms_Resource_Object_Meta: { isLatestVersion: boolean; }; Terms_Single_Resource_Data_Document: { data: components["schemas"]["Terms_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; ThirdPartyLyricsProvider: Omit, "source"> & { commonTrackId: string; lyricsId: string; } & { /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ source: "THIRD_PARTY"; }; TidalLyricsProvider: Omit & { /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ source: "TIDAL"; }; TrackFilesReadById403ResponseBody: { errors: { /** * @example CLIENT_NOT_ENTITLED * @enum {string} */ code: "CLIENT_NOT_ENTITLED" | "CONCURRENT_PLAYBACK" | "GEO_RESTRICTED" | "PREREQUISITE_MISSING" | "PURCHASE_REQUIRED"; /** @example Required playback prerequisites are missing */ detail?: string; /** @example 403 */ status: string; }[]; }; TrackFilesReadById404ResponseBody: { errors: { /** * @example CONTENT_NOT_FOUND * @enum {string} */ code: "CONTENT_NOT_FOUND"; /** @example Content does not exist or is no longer available */ detail?: string; /** @example 404 */ status: string; }[]; }; TrackFiles_Attributes: { albumAudioNormalizationData?: components["schemas"]["AudioNormalizationData"]; /** * @description File's audio format * @enum {string} */ format?: "HEAACV1" | "AACLC" | "FLAC" | "FLAC_HIRES" | "EAC3_JOC"; trackAudioNormalizationData?: components["schemas"]["AudioNormalizationData"]; /** * @description Track presentation * @enum {string} */ trackPresentation?: "FULL" | "PREVIEW"; /** @description File URL */ url?: string; }; TrackFiles_Resource_Object: { attributes?: components["schemas"]["TrackFiles_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "trackFiles"; }; TrackFiles_Single_Resource_Data_Document: { data: components["schemas"]["TrackFiles_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; TrackInfo: { broken?: boolean; /** Format: int32 */ brokenCode?: number; trackId: string; }; TrackManifestsReadById403ResponseBody: { errors: { /** * @example CLIENT_NOT_ENTITLED * @enum {string} */ code: "CLIENT_NOT_ENTITLED" | "CONCURRENT_PLAYBACK" | "GEO_RESTRICTED" | "PREREQUISITE_MISSING" | "PURCHASE_REQUIRED"; /** @example Required playback prerequisites are missing */ detail?: string; /** @example 403 */ status: string; }[]; }; TrackManifestsReadById404ResponseBody: { errors: { /** * @example CONTENT_NOT_FOUND * @enum {string} */ code: "CONTENT_NOT_FOUND"; /** @example Content does not exist or is no longer available */ detail?: string; /** @example 404 */ status: string; }[]; }; TrackManifests_Attributes: { albumAudioNormalizationData?: components["schemas"]["AudioNormalizationData"]; drmData?: components["schemas"]["DrmData"]; /** @description Formats present in manifest */ formats?: ("HEAACV1" | "AACLC" | "FLAC" | "FLAC_HIRES" | "EAC3_JOC")[]; /** @description Unique manifest hash */ hash?: string; /** * @description Why a preview is served instead of the full track * @enum {string} */ previewReason?: "FULL_REQUIRES_SUBSCRIPTION" | "FULL_REQUIRES_PURCHASE" | "FULL_REQUIRES_HIGHER_ACCESS_TIER"; trackAudioNormalizationData?: components["schemas"]["AudioNormalizationData"]; /** * @description Track presentation * @enum {string} */ trackPresentation?: "FULL" | "PREVIEW"; /** @description Manifest URI */ uri?: string; }; TrackManifests_Resource_Object: { attributes?: components["schemas"]["TrackManifests_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "trackManifests"; }; TrackManifests_Single_Resource_Data_Document: { data: components["schemas"]["TrackManifests_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; TrackSourceFilesCreateOperation_Payload: { data: components["schemas"]["TrackSourceFilesCreateOperation_Payload_Data"]; }; TrackSourceFilesCreateOperation_Payload_Data: { attributes: components["schemas"]["TrackSourceFilesCreateOperation_Payload_Data_Attributes"]; relationships: components["schemas"]["TrackSourceFilesCreateOperation_Payload_Data_Relationships"]; /** @enum {string} */ type: "trackSourceFiles"; }; TrackSourceFilesCreateOperation_Payload_Data_Attributes: { md5Hash: string; /** Format: int64 */ size: number; }; TrackSourceFilesCreateOperation_Payload_Data_Relationships: { track: components["schemas"]["TrackSourceFilesCreateOperation_Payload_Data_Relationships_Track"]; }; TrackSourceFilesCreateOperation_Payload_Data_Relationships_Track: { data?: components["schemas"]["TrackSourceFilesCreateOperation_Payload_Data_Relationships_Track_Data"]; /** @deprecated */ id?: string; /** * @deprecated * @enum {string} */ type?: "tracks"; }; TrackSourceFilesCreateOperation_Payload_Data_Relationships_Track_Data: { id: string; /** @enum {string} */ type: "tracks"; }; TrackSourceFiles_Attributes: { /** @description MD5 hash of file to be uploaded */ md5Hash: string; /** * Format: int64 * @description File size of the track in bytes */ size: number; status: components["schemas"]["File_Status"]; uploadLink: components["schemas"]["File_Upload_Link"]; }; TrackSourceFiles_Create_Single_Resource_Data_Document: { data: components["schemas"]["TrackSourceFiles_Resource_Object"]; links: components["schemas"]["Links"]; }; TrackSourceFiles_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; TrackSourceFiles_Relationships: { owners?: components["schemas"]["Multi_Relationship_Data_Document"]; }; TrackSourceFiles_Resource_Object: { attributes?: components["schemas"]["TrackSourceFiles_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["TrackSourceFiles_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "trackSourceFiles"; }; TrackSourceFiles_Single_Resource_Data_Document: { data: components["schemas"]["TrackSourceFiles_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; TrackStatistics_Attributes: { /** * Format: int32 * @description Total playbacks */ totalPlaybacks: number; /** * Format: int32 * @description Unique listeners */ uniqueListeners: number; }; TrackStatistics_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; TrackStatistics_Relationships: { owners?: components["schemas"]["Multi_Relationship_Data_Document"]; }; TrackStatistics_Resource_Object: { attributes?: components["schemas"]["TrackStatistics_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["TrackStatistics_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "trackStatistics"; }; TrackStatistics_Single_Resource_Data_Document: { data: components["schemas"]["TrackStatistics_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; TracksAlbumsRelationshipUpdateOperation_Payload: { data: components["schemas"]["TracksAlbumsRelationshipUpdateOperation_Payload_Data"][]; }; TracksAlbumsRelationshipUpdateOperation_Payload_Data: { id: string; /** @enum {string} */ type: "albums"; }; TracksCreateOperation_Payload: { data: components["schemas"]["TracksCreateOperation_Payload_Data"]; }; TracksCreateOperation_Payload_Data: { attributes: components["schemas"]["TracksCreateOperation_Payload_Data_Attributes"]; relationships: components["schemas"]["TracksCreateOperation_Payload_Data_Relationships"]; /** @enum {string} */ type: "tracks"; }; TracksCreateOperation_Payload_Data_Attributes: { /** * @description Access type * @example PRIVATE * @enum {string} */ accessType: "PUBLIC" | "UNLISTED" | "PRIVATE"; /** * @description Explicit content * @example false */ explicit?: boolean; title: string; }; TracksCreateOperation_Payload_Data_Relationships: { albums: components["schemas"]["TracksCreateOperation_Payload_Data_Relationships_Albums"]; artists: components["schemas"]["TracksCreateOperation_Payload_Data_Relationships_Artists"]; genres?: components["schemas"]["TracksCreateOperation_Payload_Data_Relationships_Genres"]; }; TracksCreateOperation_Payload_Data_Relationships_Albums: { data: components["schemas"]["TracksCreateOperation_Payload_Data_Relationships_Albums_Data"][]; }; TracksCreateOperation_Payload_Data_Relationships_Albums_Data: { id: string; /** @enum {string} */ type: "albums"; }; TracksCreateOperation_Payload_Data_Relationships_Artists: { data: components["schemas"]["TracksCreateOperation_Payload_Data_Relationships_Artists_Data"][]; }; TracksCreateOperation_Payload_Data_Relationships_Artists_Data: { id: string; /** @enum {string} */ type: "artists"; }; TracksCreateOperation_Payload_Data_Relationships_Genres: { data: components["schemas"]["TracksCreateOperation_Payload_Data_Relationships_Genres_Data"][]; }; TracksCreateOperation_Payload_Data_Relationships_Genres_Data: { id: string; /** @enum {string} */ type: "genres"; }; TracksMetadataStatus_Attributes: { /** * @description Status of the metadata detection job * @enum {string} */ status: "PENDING" | "PROCESSING" | "ERROR" | "OK"; }; TracksMetadataStatus_Resource_Object: { attributes?: components["schemas"]["TracksMetadataStatus_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "tracksMetadataStatus"; }; TracksMetadataStatus_Single_Resource_Data_Document: { data: components["schemas"]["TracksMetadataStatus_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; TracksUpdateOperation_Payload: { data: components["schemas"]["TracksUpdateOperation_Payload_Data"]; }; TracksUpdateOperation_Payload_Data: { attributes?: components["schemas"]["TracksUpdateOperation_Payload_Data_Attributes"]; id: string; relationships?: components["schemas"]["TracksUpdateOperation_Payload_Data_Relationships"]; /** @enum {string} */ type: "tracks"; }; TracksUpdateOperation_Payload_Data_Attributes: { /** * @description Access type * @example PRIVATE * @enum {string} */ accessType?: "PUBLIC" | "UNLISTED" | "PRIVATE"; /** Format: float */ bpm?: number; /** * @description Explicit content * @example false */ explicit?: boolean; /** @enum {string} */ key?: "UNKNOWN" | "C" | "CSharp" | "D" | "Eb" | "E" | "F" | "FSharp" | "G" | "Ab" | "A" | "Bb" | "B"; /** @enum {string} */ keyScale?: "UNKNOWN" | "MAJOR" | "MINOR" | "AEOLIAN" | "BLUES" | "DORIAN" | "HARMONIC_MINOR" | "LOCRIAN" | "LYDIAN" | "MIXOLYDIAN" | "PENTATONIC_MAJOR" | "PHRYGIAN" | "MELODIC_MINOR" | "PENTATONIC_MINOR"; title?: string; toneTags?: string[]; }; TracksUpdateOperation_Payload_Data_Relationships: { genres?: components["schemas"]["TracksUpdateOperation_Payload_Data_Relationships_Genres"]; }; TracksUpdateOperation_Payload_Data_Relationships_Genres: { data: components["schemas"]["TracksUpdateOperation_Payload_Data_Relationships_Genres_Data"][]; }; TracksUpdateOperation_Payload_Data_Relationships_Genres_Data: { id: string; /** @enum {string} */ type: "genres"; }; Tracks_Albums_Multi_Relationship_Data_Document: { data?: components["schemas"]["Tracks_Albums_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Tracks_Albums_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Tracks_Albums_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Tracks_Albums_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; Tracks_Attributes: { /** * @description Access type * @example PRIVATE * @enum {string} */ accessType?: "PUBLIC" | "UNLISTED" | "PRIVATE"; /** * @description Whether the track is AI-generated * @example false */ ai?: boolean; /** * @deprecated * @description Available usage for this track. Deprecated: use 'usageRules' instead. This field will be removed in a future version. */ availability?: ("STREAM" | "DJ" | "STEM")[]; /** * Format: float * @description Beats per minute * @example 60 */ bpm?: number; copyright?: components["schemas"]["Copyright"]; /** * Format: date-time * @description Datetime of track creation (ISO 8601) */ createdAt?: string; /** * @description Duration (ISO 8601) * @example PT2M58S */ duration: string; /** * @description Explicit content * @example false */ explicit: boolean; /** @description Track links external to TIDAL API */ externalLinks?: components["schemas"]["External_Link"][]; /** * @description International Standard Recording Code (ISRC) * @example QMJMT1701229 */ isrc: string; /** * @description Key * @enum {string} */ key: "UNKNOWN" | "C" | "CSharp" | "D" | "Eb" | "E" | "F" | "FSharp" | "G" | "Ab" | "A" | "Bb" | "B"; /** * @description The scale of the key * @enum {string} */ keyScale: "UNKNOWN" | "MAJOR" | "MINOR" | "AEOLIAN" | "BLUES" | "DORIAN" | "HARMONIC_MINOR" | "LOCRIAN" | "LYDIAN" | "MIXOLYDIAN" | "PENTATONIC_MAJOR" | "PHRYGIAN" | "MELODIC_MINOR" | "PENTATONIC_MINOR"; mediaTags: string[]; /** * Format: double * @description Popularity (0.0 - 1.0) * @example 0.56 */ popularity: number; /** * @description Is the track spotlighted? * @example true */ spotlighted?: boolean; /** * @description Track title * @example Kill Jay Z */ title: string; toneTags?: string[]; /** * @description Track version, complements title * @example original, mix etc */ version?: string; }; Tracks_Create_Single_Resource_Data_Document: { data: components["schemas"]["Tracks_Resource_Object"]; links: components["schemas"]["Links"]; }; Tracks_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Tracks_Multi_Resource_Data_Document: { data: components["schemas"]["Tracks_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Tracks_Relationships: { albums?: components["schemas"]["Tracks_Albums_Multi_Relationship_Data_Document"]; artists?: components["schemas"]["Multi_Relationship_Data_Document"]; credits?: components["schemas"]["Multi_Relationship_Data_Document"]; download?: components["schemas"]["Single_Relationship_Data_Document"]; genres?: components["schemas"]["Multi_Relationship_Data_Document"]; lyrics?: components["schemas"]["Multi_Relationship_Data_Document"]; metadataStatus?: components["schemas"]["Single_Relationship_Data_Document"]; owners?: components["schemas"]["Multi_Relationship_Data_Document"]; priceConfig?: components["schemas"]["Single_Relationship_Data_Document"]; providers?: components["schemas"]["Multi_Relationship_Data_Document"]; radio?: components["schemas"]["Multi_Relationship_Data_Document"]; replacement?: components["schemas"]["Tracks_Replacement_Single_Relationship_Data_Document"]; shares?: components["schemas"]["Multi_Relationship_Data_Document"]; similarTracks?: components["schemas"]["Tracks_SimilarTracks_Multi_Relationship_Data_Document"]; sourceFile?: components["schemas"]["Single_Relationship_Data_Document"]; suggestedTracks?: components["schemas"]["Tracks_SuggestedTracks_Multi_Relationship_Data_Document"]; trackStatistics?: components["schemas"]["Single_Relationship_Data_Document"]; usageRules?: components["schemas"]["Single_Relationship_Data_Document"]; }; Tracks_Replacement_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Tracks_Replacement_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Tracks_Replacement_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; Tracks_Replacement_Single_Relationship_Data_Document: { data?: components["schemas"]["Tracks_Replacement_Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Tracks_Resource_Object: { attributes?: components["schemas"]["Tracks_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["Tracks_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "tracks"; }; Tracks_SimilarTracks_Multi_Relationship_Data_Document: { data?: components["schemas"]["Tracks_SimilarTracks_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Tracks_SimilarTracks_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Tracks_SimilarTracks_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Tracks_SimilarTracks_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; Tracks_Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Tracks_Single_Resource_Data_Document: { data: components["schemas"]["Tracks_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Tracks_SuggestedTracks_Multi_Relationship_Data_Document: { data?: components["schemas"]["Tracks_SuggestedTracks_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Tracks_SuggestedTracks_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Tracks_SuggestedTracks_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Tracks_SuggestedTracks_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; UsageRulesCreateOperation_Payload: { data: components["schemas"]["UsageRulesCreateOperation_Payload_Data"]; }; UsageRulesCreateOperation_Payload_Data: { attributes: components["schemas"]["UsageRulesCreateOperation_Payload_Data_Attributes"]; relationships: components["schemas"]["UsageRulesCreateOperation_Payload_Data_Relationships"]; /** @enum {string} */ type: "usageRules"; }; UsageRulesCreateOperation_Payload_Data_Attributes: { countryCode?: string; free?: ("STREAM" | "DJ" | "STEM" | "DOWNLOAD")[]; /** @description Tracks only. Set to true (with empty paid/subscription/free) to clear an explicit track-level override and inherit usage rules from the album. Must be omitted or false when providing explicit usage values. */ inherited?: boolean; paid?: ("STREAM" | "DJ" | "STEM" | "DOWNLOAD")[]; subscription?: ("STREAM" | "DJ" | "STEM" | "DOWNLOAD")[]; /** * Format: date-time * @description Datetime from which these usage rules are valid (ISO 8601) */ validFrom?: string; }; UsageRulesCreateOperation_Payload_Data_Relationships: { subject: components["schemas"]["UsageRulesCreateOperation_Payload_Data_Relationships_Subject"]; }; UsageRulesCreateOperation_Payload_Data_Relationships_Subject: { data: components["schemas"]["UsageRulesCreateOperation_Payload_Subject"]; }; UsageRulesCreateOperation_Payload_Subject: { id: string; /** @enum {string} */ type: "tracks" | "albums" | "videos"; }; UsageRules_Attributes: { /** @description Country code (ISO 3166-1 alpha-2) */ countryCode: string; /** @description Usage types allowed for free/ad-supported model */ free?: ("STREAM" | "DJ" | "STEM" | "DOWNLOAD")[]; /** @description Whether these usage rules are inherited from a parent (e.g. a track inheriting from its album). Tri-state: true means the rules are inherited, false means an explicit per-track override, null means the value is unknown or not applicable (albums, videos, and legacy data). */ inherited?: boolean; /** @description Usage types allowed for paid/purchase model */ paid?: ("STREAM" | "DJ" | "STEM" | "DOWNLOAD")[]; /** @description Usage types allowed for subscription model */ subscription?: ("STREAM" | "DJ" | "STEM" | "DOWNLOAD")[]; /** * Format: date-time * @description Datetime from which these usage rules are valid (ISO 8601) */ validFrom?: string; }; UsageRules_Create_Single_Resource_Data_Document: { data: components["schemas"]["UsageRules_Resource_Object"]; links: components["schemas"]["Links"]; }; UsageRules_Resource_Object: { attributes?: components["schemas"]["UsageRules_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "usageRules"; }; UsageRules_Single_Resource_Data_Document: { data: components["schemas"]["UsageRules_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollection: { id: string; /** @enum {string} */ type: "userCollectionPlaylists"; }; UserCollectionAlbumsAddMultiDataRelationshipWithResponse409ResponseBody: { errors: { /** * @example DUPLICATE_ITEMS_IN_COLLECTION * @enum {string} */ code: "DUPLICATE_ITEMS_IN_COLLECTION" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_COLLECTION"; /** @example Collection item limit reached */ detail?: string; /** @example 409 */ status: string; }[]; }; UserCollectionAlbumsItemsRelationshipAddOperation_Payload: { data: components["schemas"]["UserCollectionAlbumsItemsRelationshipAddOperation_Payload_Data"][]; }; UserCollectionAlbumsItemsRelationshipAddOperation_Payload_Data: { id: string; meta?: components["schemas"]["UserCollectionAlbumsItemsRelationshipAddOperation_Payload_Data_Meta"]; /** @enum {string} */ type: "albums"; }; UserCollectionAlbumsItemsRelationshipAddOperation_Payload_Data_Meta: { /** Format: date-time */ addedAt?: string; }; UserCollectionAlbumsItemsRelationshipAddOperation_Response_Meta_SkippedItem: { id: string; /** @enum {string} */ reason: "NOT_FOUND" | "ALREADY_PRESENT"; /** @enum {string} */ type: "albums"; }; UserCollectionAlbumsItemsRelationshipRemoveOperation_Payload: { data: components["schemas"]["UserCollectionAlbumsItemsRelationshipRemoveOperation_Payload_Data"][]; }; UserCollectionAlbumsItemsRelationshipRemoveOperation_Payload_Data: { id: string; /** @enum {string} */ type: "albums"; }; UserCollectionAlbums_Attributes: { /** * Format: date-time * @description When the collection was last modified */ lastModifiedAt?: string; /** * Format: int32 * @description Number of items in the collection */ numberOfItems: number; }; UserCollectionAlbums_Items_Add_Multi_Relationship_Data_Document: { data: components["schemas"]["UserCollectionAlbums_Items_Add_Resource_Identifier"][]; links: components["schemas"]["Links"]; meta?: components["schemas"]["UserCollectionAlbums_Items_Add_Multi_Relationship_Data_Document_Meta"]; }; UserCollectionAlbums_Items_Add_Multi_Relationship_Data_Document_Meta: { skipped: components["schemas"]["UserCollectionAlbumsItemsRelationshipAddOperation_Response_Meta_SkippedItem"][]; }; UserCollectionAlbums_Items_Add_Resource_Identifier: { id: string; meta?: components["schemas"]["UserCollectionAlbums_Items_Add_Resource_Identifier_Meta"]; /** @enum {string} */ type: "albums"; }; UserCollectionAlbums_Items_Add_Resource_Identifier_Meta: { /** Format: date-time */ addedAt: string; }; UserCollectionAlbums_Items_Multi_Relationship_Data_Document: { data?: components["schemas"]["UserCollectionAlbums_Items_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionAlbums_Items_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["UserCollectionAlbums_Items_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; UserCollectionAlbums_Items_Resource_Identifier_Meta: { /** Format: date-time */ addedAt: string; replacement?: components["schemas"]["Replacement_Provenance"]; }; UserCollectionAlbums_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionAlbums_Relationships: { items?: components["schemas"]["UserCollectionAlbums_Items_Multi_Relationship_Data_Document"]; owners?: components["schemas"]["Multi_Relationship_Data_Document"]; }; UserCollectionAlbums_Resource_Object: { attributes?: components["schemas"]["UserCollectionAlbums_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["UserCollectionAlbums_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "userCollectionAlbums"; }; UserCollectionAlbums_Single_Resource_Data_Document: { data: components["schemas"]["UserCollectionAlbums_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionArtistsAddMultiDataRelationshipWithResponse409ResponseBody: { errors: { /** * @example DUPLICATE_ITEMS_IN_COLLECTION * @enum {string} */ code: "DUPLICATE_ITEMS_IN_COLLECTION" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_COLLECTION"; /** @example Collection item limit reached */ detail?: string; /** @example 409 */ status: string; }[]; }; UserCollectionArtistsItemsRelationshipAddOperation_Payload: { data: components["schemas"]["UserCollectionArtistsItemsRelationshipAddOperation_Payload_Data"][]; }; UserCollectionArtistsItemsRelationshipAddOperation_Payload_Data: { id: string; meta?: components["schemas"]["UserCollectionArtistsItemsRelationshipAddOperation_Payload_Data_Meta"]; /** @enum {string} */ type: "artists"; }; UserCollectionArtistsItemsRelationshipAddOperation_Payload_Data_Meta: { /** Format: date-time */ addedAt?: string; }; UserCollectionArtistsItemsRelationshipAddOperation_Response_Meta_SkippedItem: { id: string; /** @enum {string} */ reason: "NOT_FOUND" | "ALREADY_PRESENT"; /** @enum {string} */ type: "artists"; }; UserCollectionArtistsItemsRelationshipRemoveOperation_Payload: { data: components["schemas"]["UserCollectionArtistsItemsRelationshipRemoveOperation_Payload_Data"][]; }; UserCollectionArtistsItemsRelationshipRemoveOperation_Payload_Data: { id: string; /** @enum {string} */ type: "artists"; }; UserCollectionArtists_Attributes: { /** * Format: date-time * @description When the collection was last modified */ lastModifiedAt?: string; /** * Format: int32 * @description Number of items in the collection */ numberOfItems: number; }; UserCollectionArtists_Items_Add_Multi_Relationship_Data_Document: { data: components["schemas"]["UserCollectionArtists_Items_Add_Resource_Identifier"][]; links: components["schemas"]["Links"]; meta?: components["schemas"]["UserCollectionArtists_Items_Add_Multi_Relationship_Data_Document_Meta"]; }; UserCollectionArtists_Items_Add_Multi_Relationship_Data_Document_Meta: { skipped: components["schemas"]["UserCollectionArtistsItemsRelationshipAddOperation_Response_Meta_SkippedItem"][]; }; UserCollectionArtists_Items_Add_Resource_Identifier: { id: string; meta?: components["schemas"]["UserCollectionArtists_Items_Add_Resource_Identifier_Meta"]; /** @enum {string} */ type: "artists"; }; UserCollectionArtists_Items_Add_Resource_Identifier_Meta: { /** Format: date-time */ addedAt: string; }; UserCollectionArtists_Items_Multi_Relationship_Data_Document: { data?: components["schemas"]["UserCollectionArtists_Items_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionArtists_Items_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["UserCollectionArtists_Items_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; UserCollectionArtists_Items_Resource_Identifier_Meta: { /** Format: date-time */ addedAt: string; }; UserCollectionArtists_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionArtists_Relationships: { items?: components["schemas"]["UserCollectionArtists_Items_Multi_Relationship_Data_Document"]; owners?: components["schemas"]["Multi_Relationship_Data_Document"]; }; UserCollectionArtists_Resource_Object: { attributes?: components["schemas"]["UserCollectionArtists_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["UserCollectionArtists_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "userCollectionArtists"; }; UserCollectionArtists_Single_Resource_Data_Document: { data: components["schemas"]["UserCollectionArtists_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionFoldersCreateOperation_Payload: { data: components["schemas"]["UserCollectionFoldersCreateOperation_Payload_Data"]; }; UserCollectionFoldersCreateOperation_Payload_Data: { attributes: components["schemas"]["UserCollectionFoldersCreateOperation_Payload_Data_Attributes"]; relationships: components["schemas"]["UserCollectionFoldersCreateOperation_Payload_Data_Relationships"]; /** @enum {string} */ type: "userCollectionFolders"; }; UserCollectionFoldersCreateOperation_Payload_Data_Attributes: { name: string; }; UserCollectionFoldersCreateOperation_Payload_Data_Relationships: { userCollection: components["schemas"]["UserCollectionFoldersCreateOperation_Payload_Data_Relationships_UserCollection"]; }; UserCollectionFoldersCreateOperation_Payload_Data_Relationships_UserCollection: { data: components["schemas"]["UserCollection"]; }; UserCollectionFoldersDeleteResource400ResponseBody: { errors: { /** * @example FOLDER_NOT_EMPTY * @enum {string} */ code: "FOLDER_NOT_EMPTY"; /** @example Folder must be empty and owned by you */ detail?: string; /** @example 400 */ status: string; }[]; }; UserCollectionFoldersItemsRelationshipAddOperation_Payload: { data?: components["schemas"]["UserCollectionFoldersItemsRelationshipAddOperation_Payload_Data"][]; }; UserCollectionFoldersItemsRelationshipAddOperation_Payload_Data: { id: string; /** @enum {string} */ type: "playlists"; }; UserCollectionFoldersItemsRelationshipRemoveOperation_Payload: { data?: components["schemas"]["UserCollectionFoldersItemsRelationshipRemoveOperation_Payload_Data"][]; }; UserCollectionFoldersItemsRelationshipRemoveOperation_Payload_Data: { id: string; /** @enum {string} */ type: "playlists"; }; UserCollectionFoldersUpdateOperation_Payload: { data: components["schemas"]["UserCollectionFoldersUpdateOperation_Payload_Data"]; }; UserCollectionFoldersUpdateOperation_Payload_Data: { attributes: components["schemas"]["UserCollectionFoldersUpdateOperation_Payload_Data_Attributes"]; id: string; /** @enum {string} */ type: "userCollectionFolders"; }; UserCollectionFoldersUpdateOperation_Payload_Data_Attributes: { name?: string; }; UserCollectionFolders_Attributes: { /** Format: date-time */ createdAt: string; /** Format: date-time */ lastModifiedAt: string; name: string; /** Format: int32 */ numberOfItems?: number; }; UserCollectionFolders_Create_Single_Resource_Data_Document: { data: components["schemas"]["UserCollectionFolders_Resource_Object"]; links: components["schemas"]["Links"]; }; UserCollectionFolders_Items_Multi_Relationship_Data_Document: { data?: components["schemas"]["UserCollectionFolders_Items_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionFolders_Items_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["UserCollectionFolders_Items_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; UserCollectionFolders_Items_Resource_Identifier_Meta: { /** Format: date-time */ addedAt: string; }; UserCollectionFolders_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionFolders_Multi_Resource_Data_Document: { data: components["schemas"]["UserCollectionFolders_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionFolders_Relationships: { items?: components["schemas"]["UserCollectionFolders_Items_Multi_Relationship_Data_Document"]; owners?: components["schemas"]["Multi_Relationship_Data_Document"]; userCollection?: components["schemas"]["Single_Relationship_Data_Document"]; }; UserCollectionFolders_Resource_Object: { attributes?: components["schemas"]["UserCollectionFolders_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["UserCollectionFolders_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "userCollectionFolders"; }; UserCollectionFolders_Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionFolders_Single_Resource_Data_Document: { data: components["schemas"]["UserCollectionFolders_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionPlaylistsAddMultiDataRelationshipWithResponse409ResponseBody: { errors: { /** * @example DUPLICATE_ITEMS_IN_COLLECTION * @enum {string} */ code: "DUPLICATE_ITEMS_IN_COLLECTION" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_COLLECTION"; /** @example Collection item limit reached */ detail?: string; /** @example 409 */ status: string; }[]; }; UserCollectionPlaylistsItemsRelationshipAddOperation_Payload: { data: components["schemas"]["UserCollectionPlaylistsItemsRelationshipAddOperation_Payload_Data"][]; }; UserCollectionPlaylistsItemsRelationshipAddOperation_Payload_Data: { id: string; meta?: components["schemas"]["UserCollectionPlaylistsItemsRelationshipAddOperation_Payload_Data_Meta"]; /** @enum {string} */ type: "playlists"; }; UserCollectionPlaylistsItemsRelationshipAddOperation_Payload_Data_Meta: { /** Format: date-time */ addedAt?: string; }; UserCollectionPlaylistsItemsRelationshipAddOperation_Response_Meta_SkippedItem: { id: string; /** @enum {string} */ reason: "NOT_FOUND" | "ALREADY_PRESENT"; /** @enum {string} */ type: "playlists"; }; UserCollectionPlaylistsItemsRelationshipRemoveOperation_Payload: { data: components["schemas"]["UserCollectionPlaylistsItemsRelationshipRemoveOperation_Payload_Data"][]; }; UserCollectionPlaylistsItemsRelationshipRemoveOperation_Payload_Data: { id: string; /** @enum {string} */ type: "playlists"; }; UserCollectionPlaylists_Attributes: { /** * Format: date-time * @description When the collection was last modified */ lastModifiedAt?: string; /** * Format: int32 * @description Number of items in the collection */ numberOfItems: number; }; UserCollectionPlaylists_Items_Add_Multi_Relationship_Data_Document: { data: components["schemas"]["UserCollectionPlaylists_Items_Add_Resource_Identifier"][]; links: components["schemas"]["Links"]; meta?: components["schemas"]["UserCollectionPlaylists_Items_Add_Multi_Relationship_Data_Document_Meta"]; }; UserCollectionPlaylists_Items_Add_Multi_Relationship_Data_Document_Meta: { skipped: components["schemas"]["UserCollectionPlaylistsItemsRelationshipAddOperation_Response_Meta_SkippedItem"][]; }; UserCollectionPlaylists_Items_Add_Resource_Identifier: { id: string; meta?: components["schemas"]["UserCollectionPlaylists_Items_Add_Resource_Identifier_Meta"]; /** @enum {string} */ type: "playlists"; }; UserCollectionPlaylists_Items_Add_Resource_Identifier_Meta: { /** Format: date-time */ addedAt: string; }; UserCollectionPlaylists_Items_Multi_Relationship_Data_Document: { data?: components["schemas"]["UserCollectionPlaylists_Items_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionPlaylists_Items_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["UserCollectionPlaylists_Items_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; UserCollectionPlaylists_Items_Resource_Identifier_Meta: { /** Format: date-time */ addedAt: string; }; UserCollectionPlaylists_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionPlaylists_Relationships: { items?: components["schemas"]["UserCollectionPlaylists_Items_Multi_Relationship_Data_Document"]; owners?: components["schemas"]["Multi_Relationship_Data_Document"]; }; UserCollectionPlaylists_Resource_Object: { attributes?: components["schemas"]["UserCollectionPlaylists_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["UserCollectionPlaylists_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "userCollectionPlaylists"; }; UserCollectionPlaylists_Single_Resource_Data_Document: { data: components["schemas"]["UserCollectionPlaylists_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionSaveForLatersAddMultiDataRelationshipWithResponse409ResponseBody: { errors: { /** * @example DUPLICATE_ITEMS_IN_COLLECTION * @enum {string} */ code: "DUPLICATE_ITEMS_IN_COLLECTION" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_COLLECTION"; /** @example Collection item limit reached */ detail?: string; /** @example 409 */ status: string; }[]; }; UserCollectionSaveForLatersItemsRelationshipAddOperation_Payload: { data: components["schemas"]["UserCollectionSaveForLatersItemsRelationshipAddOperation_Payload_Data"][]; }; UserCollectionSaveForLatersItemsRelationshipAddOperation_Payload_Data: { id: string; /** @enum {string} */ type: "tracks" | "albums" | "artists" | "playlists" | "videos"; }; UserCollectionSaveForLatersItemsRelationshipAddOperation_Response_Meta_SkippedItem: { id: string; /** @enum {string} */ reason: "NOT_FOUND" | "ALREADY_PRESENT"; /** @enum {string} */ type: "tracks" | "albums" | "artists" | "playlists" | "videos"; }; UserCollectionSaveForLatersItemsRelationshipRemoveOperation_Payload: { data: components["schemas"]["UserCollectionSaveForLatersItemsRelationshipRemoveOperation_Payload_Data"][]; }; UserCollectionSaveForLatersItemsRelationshipRemoveOperation_Payload_Data: { id: string; /** @enum {string} */ type: "tracks" | "albums" | "artists" | "playlists" | "videos"; }; UserCollectionSaveForLaters_Attributes: { /** * Format: date-time * @description When the collection was last modified */ lastModifiedAt?: string; /** * Format: int32 * @description Number of items in the collection */ numberOfItems: number; }; UserCollectionSaveForLaters_Items_Add_Multi_Relationship_Data_Document: { data: components["schemas"]["UserCollectionSaveForLaters_Items_Add_Resource_Identifier"][]; links: components["schemas"]["Links"]; meta?: components["schemas"]["UserCollectionSaveForLaters_Items_Add_Multi_Relationship_Data_Document_Meta"]; }; UserCollectionSaveForLaters_Items_Add_Multi_Relationship_Data_Document_Meta: { skipped: components["schemas"]["UserCollectionSaveForLatersItemsRelationshipAddOperation_Response_Meta_SkippedItem"][]; }; UserCollectionSaveForLaters_Items_Add_Resource_Identifier: { id: string; meta?: components["schemas"]["UserCollectionSaveForLaters_Items_Add_Resource_Identifier_Meta"]; /** @enum {string} */ type: "tracks" | "albums" | "artists" | "playlists" | "videos"; }; UserCollectionSaveForLaters_Items_Add_Resource_Identifier_Meta: { /** Format: date-time */ addedAt: string; }; UserCollectionSaveForLaters_Items_Multi_Relationship_Data_Document: { data?: components["schemas"]["UserCollectionSaveForLaters_Items_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionSaveForLaters_Items_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["UserCollectionSaveForLaters_Items_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; UserCollectionSaveForLaters_Items_Resource_Identifier_Meta: { /** Format: date-time */ addedAt: string; replacement?: components["schemas"]["Replacement_Provenance"]; }; UserCollectionSaveForLaters_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionSaveForLaters_Relationships: { items?: components["schemas"]["UserCollectionSaveForLaters_Items_Multi_Relationship_Data_Document"]; owners?: components["schemas"]["Multi_Relationship_Data_Document"]; }; UserCollectionSaveForLaters_Resource_Object: { attributes?: components["schemas"]["UserCollectionSaveForLaters_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["UserCollectionSaveForLaters_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "userCollectionSaveForLaters"; }; UserCollectionSaveForLaters_Single_Resource_Data_Document: { data: components["schemas"]["UserCollectionSaveForLaters_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionTracksAddMultiDataRelationshipWithResponse409ResponseBody: { errors: { /** * @example DUPLICATE_ITEMS_IN_COLLECTION * @enum {string} */ code: "DUPLICATE_ITEMS_IN_COLLECTION" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_COLLECTION"; /** @example Collection item limit reached */ detail?: string; /** @example 409 */ status: string; }[]; }; UserCollectionTracksItemsRelationshipAddOperation_Payload: { data: components["schemas"]["UserCollectionTracksItemsRelationshipAddOperation_Payload_Data"][]; }; UserCollectionTracksItemsRelationshipAddOperation_Payload_Data: { id: string; meta?: components["schemas"]["UserCollectionTracksItemsRelationshipAddOperation_Payload_Data_Meta"]; /** @enum {string} */ type: "tracks"; }; UserCollectionTracksItemsRelationshipAddOperation_Payload_Data_Meta: { /** Format: date-time */ addedAt?: string; }; UserCollectionTracksItemsRelationshipAddOperation_Response_Meta_SkippedItem: { id: string; /** @enum {string} */ reason: "NOT_FOUND" | "ALREADY_PRESENT"; /** @enum {string} */ type: "tracks"; }; UserCollectionTracksItemsRelationshipRemoveOperation_Payload: { data: components["schemas"]["UserCollectionTracksItemsRelationshipRemoveOperation_Payload_Data"][]; }; UserCollectionTracksItemsRelationshipRemoveOperation_Payload_Data: { id: string; /** @enum {string} */ type: "tracks"; }; UserCollectionTracks_Attributes: { /** * Format: date-time * @description When the collection was last modified */ lastModifiedAt?: string; /** * Format: int32 * @description Number of items in the collection */ numberOfItems: number; }; UserCollectionTracks_Items_Add_Multi_Relationship_Data_Document: { data: components["schemas"]["UserCollectionTracks_Items_Add_Resource_Identifier"][]; links: components["schemas"]["Links"]; meta?: components["schemas"]["UserCollectionTracks_Items_Add_Multi_Relationship_Data_Document_Meta"]; }; UserCollectionTracks_Items_Add_Multi_Relationship_Data_Document_Meta: { skipped: components["schemas"]["UserCollectionTracksItemsRelationshipAddOperation_Response_Meta_SkippedItem"][]; }; UserCollectionTracks_Items_Add_Resource_Identifier: { id: string; meta?: components["schemas"]["UserCollectionTracks_Items_Add_Resource_Identifier_Meta"]; /** @enum {string} */ type: "tracks"; }; UserCollectionTracks_Items_Add_Resource_Identifier_Meta: { /** Format: date-time */ addedAt: string; }; UserCollectionTracks_Items_Multi_Relationship_Data_Document: { data?: components["schemas"]["UserCollectionTracks_Items_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionTracks_Items_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["UserCollectionTracks_Items_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; UserCollectionTracks_Items_Resource_Identifier_Meta: { /** Format: date-time */ addedAt: string; replacement?: components["schemas"]["Replacement_Provenance"]; }; UserCollectionTracks_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionTracks_Relationships: { items?: components["schemas"]["UserCollectionTracks_Items_Multi_Relationship_Data_Document"]; owners?: components["schemas"]["Multi_Relationship_Data_Document"]; }; UserCollectionTracks_Resource_Object: { attributes?: components["schemas"]["UserCollectionTracks_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["UserCollectionTracks_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "userCollectionTracks"; }; UserCollectionTracks_Single_Resource_Data_Document: { data: components["schemas"]["UserCollectionTracks_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionVideosAddMultiDataRelationshipWithResponse409ResponseBody: { errors: { /** * @example DUPLICATE_ITEMS_IN_COLLECTION * @enum {string} */ code: "DUPLICATE_ITEMS_IN_COLLECTION" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_COLLECTION"; /** @example Collection item limit reached */ detail?: string; /** @example 409 */ status: string; }[]; }; UserCollectionVideosItemsRelationshipAddOperation_Payload: { data: components["schemas"]["UserCollectionVideosItemsRelationshipAddOperation_Payload_Data"][]; }; UserCollectionVideosItemsRelationshipAddOperation_Payload_Data: { id: string; meta?: components["schemas"]["UserCollectionVideosItemsRelationshipAddOperation_Payload_Data_Meta"]; /** @enum {string} */ type: "videos"; }; UserCollectionVideosItemsRelationshipAddOperation_Payload_Data_Meta: { /** Format: date-time */ addedAt?: string; }; UserCollectionVideosItemsRelationshipAddOperation_Response_Meta_SkippedItem: { id: string; /** @enum {string} */ reason: "NOT_FOUND" | "ALREADY_PRESENT"; /** @enum {string} */ type: "videos"; }; UserCollectionVideosItemsRelationshipRemoveOperation_Payload: { data: components["schemas"]["UserCollectionVideosItemsRelationshipRemoveOperation_Payload_Data"][]; }; UserCollectionVideosItemsRelationshipRemoveOperation_Payload_Data: { id: string; /** @enum {string} */ type: "videos"; }; UserCollectionVideos_Attributes: { /** * Format: date-time * @description When the collection was last modified */ lastModifiedAt?: string; /** * Format: int32 * @description Number of items in the collection */ numberOfItems: number; }; UserCollectionVideos_Items_Add_Multi_Relationship_Data_Document: { data: components["schemas"]["UserCollectionVideos_Items_Add_Resource_Identifier"][]; links: components["schemas"]["Links"]; meta?: components["schemas"]["UserCollectionVideos_Items_Add_Multi_Relationship_Data_Document_Meta"]; }; UserCollectionVideos_Items_Add_Multi_Relationship_Data_Document_Meta: { skipped: components["schemas"]["UserCollectionVideosItemsRelationshipAddOperation_Response_Meta_SkippedItem"][]; }; UserCollectionVideos_Items_Add_Resource_Identifier: { id: string; meta?: components["schemas"]["UserCollectionVideos_Items_Add_Resource_Identifier_Meta"]; /** @enum {string} */ type: "videos"; }; UserCollectionVideos_Items_Add_Resource_Identifier_Meta: { /** Format: date-time */ addedAt: string; }; UserCollectionVideos_Items_Multi_Relationship_Data_Document: { data?: components["schemas"]["UserCollectionVideos_Items_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionVideos_Items_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["UserCollectionVideos_Items_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; UserCollectionVideos_Items_Resource_Identifier_Meta: { /** Format: date-time */ addedAt: string; replacement?: components["schemas"]["Replacement_Provenance"]; }; UserCollectionVideos_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionVideos_Relationships: { items?: components["schemas"]["UserCollectionVideos_Items_Multi_Relationship_Data_Document"]; owners?: components["schemas"]["Multi_Relationship_Data_Document"]; }; UserCollectionVideos_Resource_Object: { attributes?: components["schemas"]["UserCollectionVideos_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["UserCollectionVideos_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "userCollectionVideos"; }; UserCollectionVideos_Single_Resource_Data_Document: { data: components["schemas"]["UserCollectionVideos_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollectionsAddMultiDataRelationship409ResponseBody: { errors: { /** * @example DUPLICATE_ITEMS_IN_COLLECTION * @enum {string} */ code: "DUPLICATE_ITEMS_IN_COLLECTION" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_COLLECTION"; /** @example Collection item limit reached */ detail?: string; /** @example 409 */ status: string; }[]; }; UserCollectionsAlbumsRelationshipAddOperation_Payload: { data: components["schemas"]["UserCollectionsAlbumsRelationshipAddOperation_Payload_Data"][]; }; UserCollectionsAlbumsRelationshipAddOperation_Payload_Data: { id: string; meta?: components["schemas"]["UserCollectionsAlbumsRelationshipAddOperation_Payload_Data_Meta"]; /** @enum {string} */ type: "albums"; }; UserCollectionsAlbumsRelationshipAddOperation_Payload_Data_Meta: { /** Format: date-time */ addedAt?: string; }; UserCollectionsAlbumsRelationshipRemoveOperation_Payload: { data: components["schemas"]["UserCollectionsAlbumsRelationshipRemoveOperation_Payload_Data"][]; }; UserCollectionsAlbumsRelationshipRemoveOperation_Payload_Data: { id: string; /** @enum {string} */ type: "albums"; }; UserCollectionsArtistsRelationshipAddOperation_Payload: { data: components["schemas"]["UserCollectionsArtistsRelationshipAddOperation_Payload_Data"][]; }; UserCollectionsArtistsRelationshipAddOperation_Payload_Data: { id: string; meta?: components["schemas"]["UserCollectionsArtistsRelationshipAddOperation_Payload_Data_Meta"]; /** @enum {string} */ type: "artists"; }; UserCollectionsArtistsRelationshipAddOperation_Payload_Data_Meta: { /** Format: date-time */ addedAt?: string; }; UserCollectionsArtistsRelationshipRemoveOperation_Payload: { data: components["schemas"]["UserCollectionsArtistsRelationshipRemoveOperation_Payload_Data"][]; }; UserCollectionsArtistsRelationshipRemoveOperation_Payload_Data: { id: string; /** @enum {string} */ type: "artists"; }; UserCollectionsPlaylistsRelationshipAddOperation_Payload: { data: components["schemas"]["UserCollectionsPlaylistsRelationshipAddOperation_Payload_Data"][]; }; UserCollectionsPlaylistsRelationshipAddOperation_Payload_Data: { id: string; /** @enum {string} */ type: "playlists"; }; UserCollectionsPlaylistsRelationshipRemoveOperation_Payload: { data: components["schemas"]["UserCollectionsPlaylistsRelationshipRemoveOperation_Payload_Data"][]; }; UserCollectionsPlaylistsRelationshipRemoveOperation_Payload_Data: { id: string; /** @enum {string} */ type: "playlists"; }; UserCollectionsTracksRelationshipAddOperation_Payload: { data: components["schemas"]["UserCollectionsTracksRelationshipAddOperation_Payload_Data"][]; }; UserCollectionsTracksRelationshipAddOperation_Payload_Data: { id: string; meta?: components["schemas"]["UserCollectionsTracksRelationshipAddOperation_Payload_Data_Meta"]; /** @enum {string} */ type: "tracks"; }; UserCollectionsTracksRelationshipAddOperation_Payload_Data_Meta: { /** Format: date-time */ addedAt?: string; }; UserCollectionsTracksRelationshipRemoveOperation_Payload: { data: components["schemas"]["UserCollectionsTracksRelationshipRemoveOperation_Payload_Data"][]; }; UserCollectionsTracksRelationshipRemoveOperation_Payload_Data: { id: string; /** @enum {string} */ type: "tracks"; }; UserCollectionsVideosRelationshipAddOperation_Payload: { data: components["schemas"]["UserCollectionsVideosRelationshipAddOperation_Payload_Data"][]; }; UserCollectionsVideosRelationshipAddOperation_Payload_Data: { id: string; /** @enum {string} */ type: "videos"; }; UserCollectionsVideosRelationshipRemoveOperation_Payload: { data: components["schemas"]["UserCollectionsVideosRelationshipRemoveOperation_Payload_Data"][]; }; UserCollectionsVideosRelationshipRemoveOperation_Payload_Data: { id: string; /** @enum {string} */ type: "videos"; }; UserCollections_Albums_Multi_Relationship_Data_Document: { data?: components["schemas"]["UserCollections_Albums_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollections_Albums_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["UserCollections_Albums_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; UserCollections_Albums_Resource_Identifier_Meta: { /** Format: date-time */ addedAt: string; replacement?: components["schemas"]["Replacement_Provenance"]; }; UserCollections_Artists_Multi_Relationship_Data_Document: { data?: components["schemas"]["UserCollections_Artists_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollections_Artists_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["UserCollections_Artists_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; UserCollections_Artists_Resource_Identifier_Meta: { /** Format: date-time */ addedAt: string; }; UserCollections_Attributes: Record; UserCollections_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollections_Playlists_Multi_Relationship_Data_Document: { data?: components["schemas"]["UserCollections_Playlists_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollections_Playlists_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["UserCollections_Playlists_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; UserCollections_Playlists_Resource_Identifier_Meta: { /** Format: date-time */ addedAt: string; }; UserCollections_Relationships: { albums?: components["schemas"]["UserCollections_Albums_Multi_Relationship_Data_Document"]; artists?: components["schemas"]["UserCollections_Artists_Multi_Relationship_Data_Document"]; owners?: components["schemas"]["Multi_Relationship_Data_Document"]; playlists?: components["schemas"]["UserCollections_Playlists_Multi_Relationship_Data_Document"]; tracks?: components["schemas"]["UserCollections_Tracks_Multi_Relationship_Data_Document"]; videos?: components["schemas"]["UserCollections_Videos_Multi_Relationship_Data_Document"]; }; UserCollections_Resource_Object: { attributes?: components["schemas"]["UserCollections_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["UserCollections_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "userCollections"; }; UserCollections_Single_Resource_Data_Document: { data: components["schemas"]["UserCollections_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollections_Tracks_Multi_Relationship_Data_Document: { data?: components["schemas"]["UserCollections_Tracks_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollections_Tracks_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["UserCollections_Tracks_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; UserCollections_Tracks_Resource_Identifier_Meta: { /** Format: date-time */ addedAt: string; replacement?: components["schemas"]["Replacement_Provenance"]; }; UserCollections_Videos_Multi_Relationship_Data_Document: { data?: components["schemas"]["UserCollections_Videos_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserCollections_Videos_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["UserCollections_Videos_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; UserCollections_Videos_Resource_Identifier_Meta: { /** Format: date-time */ addedAt: string; replacement?: components["schemas"]["Replacement_Provenance"]; }; UserDailyMixes_Attributes: Record; UserDailyMixes_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserDailyMixes_Relationships: { items?: components["schemas"]["Multi_Relationship_Data_Document"]; }; UserDailyMixes_Resource_Object: { attributes?: components["schemas"]["UserDailyMixes_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["UserDailyMixes_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "userDailyMixes"; }; UserDailyMixes_Single_Resource_Data_Document: { data: components["schemas"]["UserDailyMixes_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserDataExportRequestsCreateOperation_Payload: { data: components["schemas"]["UserDataExportRequestsCreateOperation_Payload_Data"]; }; UserDataExportRequestsCreateOperation_Payload_Data: { attributes: components["schemas"]["UserDataExportRequestsCreateOperation_Payload_Data_Attributes"]; /** @enum {string} */ type: "userDataExportRequests"; }; UserDataExportRequestsCreateOperation_Payload_Data_Attributes: { /** @enum {string} */ flowType: "GDPR" | "CCPA" | "COPPA" | "ANZ_PA" | "US_PRIVACY_REGULATION" | "APPI" | "RETENTION_POLICY"; }; UserDataExportRequests_Attributes: { /** * @description The type of data export flow * @enum {string} */ flowType: "GDPR" | "CCPA" | "COPPA" | "ANZ_PA" | "US_PRIVACY_REGULATION" | "APPI" | "RETENTION_POLICY"; }; UserDataExportRequests_Create_Single_Resource_Data_Document: { data: components["schemas"]["UserDataExportRequests_Resource_Object"]; links: components["schemas"]["Links"]; }; UserDataExportRequests_Resource_Object: { attributes?: components["schemas"]["UserDataExportRequests_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "userDataExportRequests"; }; UserDiscoveryMixes_Attributes: Record; UserDiscoveryMixes_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserDiscoveryMixes_Relationships: { items?: components["schemas"]["Multi_Relationship_Data_Document"]; }; UserDiscoveryMixes_Resource_Object: { attributes?: components["schemas"]["UserDiscoveryMixes_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["UserDiscoveryMixes_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "userDiscoveryMixes"; }; UserDiscoveryMixes_Single_Resource_Data_Document: { data: components["schemas"]["UserDiscoveryMixes_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserNewReleaseMixes_Attributes: Record; UserNewReleaseMixes_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserNewReleaseMixes_Relationships: { items?: components["schemas"]["Multi_Relationship_Data_Document"]; }; UserNewReleaseMixes_Resource_Object: { attributes?: components["schemas"]["UserNewReleaseMixes_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["UserNewReleaseMixes_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "userNewReleaseMixes"; }; UserNewReleaseMixes_Single_Resource_Data_Document: { data: components["schemas"]["UserNewReleaseMixes_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserOfflineMixes_Attributes: Record; UserOfflineMixes_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserOfflineMixes_Relationships: { items?: components["schemas"]["Multi_Relationship_Data_Document"]; }; UserOfflineMixes_Resource_Object: { attributes?: components["schemas"]["UserOfflineMixes_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["UserOfflineMixes_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "userOfflineMixes"; }; UserOfflineMixes_Single_Resource_Data_Document: { data: components["schemas"]["UserOfflineMixes_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserRecommendationBlocksAddMultiDataRelationshipWithResponse409ResponseBody: { errors: { /** * @example IDEMPOTENT_REQUEST_IN_PROGRESS * @enum {string} */ code: "IDEMPOTENT_REQUEST_IN_PROGRESS" | "MAXIMUM_NUMBER_OF_BLOCKS_EXCEEDED"; /** @example Recommendation block limit reached */ detail?: string; /** @example 409 */ status: string; }[]; }; UserRecommendationBlocksArtistsRelationshipAddOperation_Payload: { data: components["schemas"]["UserRecommendationBlocksArtistsRelationshipAddOperation_Payload_Data"][]; }; UserRecommendationBlocksArtistsRelationshipAddOperation_Payload_Data: { id: string; /** @enum {string} */ type: "artists"; }; UserRecommendationBlocksArtistsRelationshipRemoveOperation_Payload: { data: components["schemas"]["UserRecommendationBlocksArtistsRelationshipRemoveOperation_Payload_Data"][]; }; UserRecommendationBlocksArtistsRelationshipRemoveOperation_Payload_Data: { id: string; /** @enum {string} */ type: "artists"; }; UserRecommendationBlocksTracksRelationshipAddOperation_Payload: { data: components["schemas"]["UserRecommendationBlocksTracksRelationshipAddOperation_Payload_Data"][]; }; UserRecommendationBlocksTracksRelationshipAddOperation_Payload_Data: { id: string; /** @enum {string} */ type: "tracks"; }; UserRecommendationBlocksTracksRelationshipRemoveOperation_Payload: { data: components["schemas"]["UserRecommendationBlocksTracksRelationshipRemoveOperation_Payload_Data"][]; }; UserRecommendationBlocksTracksRelationshipRemoveOperation_Payload_Data: { id: string; /** @enum {string} */ type: "tracks"; }; UserRecommendationBlocksVideosRelationshipAddOperation_Payload: { data: components["schemas"]["UserRecommendationBlocksVideosRelationshipAddOperation_Payload_Data"][]; }; UserRecommendationBlocksVideosRelationshipAddOperation_Payload_Data: { id: string; /** @enum {string} */ type: "videos"; }; UserRecommendationBlocksVideosRelationshipRemoveOperation_Payload: { data: components["schemas"]["UserRecommendationBlocksVideosRelationshipRemoveOperation_Payload_Data"][]; }; UserRecommendationBlocksVideosRelationshipRemoveOperation_Payload_Data: { id: string; /** @enum {string} */ type: "videos"; }; UserRecommendationBlocks_Artists_Add_Multi_Relationship_Data_Document: { data: components["schemas"]["UserRecommendationBlocks_Artists_Add_Resource_Identifier"][]; links: components["schemas"]["Links"]; }; UserRecommendationBlocks_Artists_Add_Resource_Identifier: { id: string; /** @enum {string} */ type: "artists"; }; UserRecommendationBlocks_Artists_Multi_Relationship_Data_Document: { data?: components["schemas"]["UserRecommendationBlocks_Artists_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserRecommendationBlocks_Artists_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["UserRecommendationBlocks_Artists_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; UserRecommendationBlocks_Artists_Resource_Identifier_Meta: { /** * Format: date-time * @description When the item was blocked */ createdAt: string; }; UserRecommendationBlocks_Attributes: Record; UserRecommendationBlocks_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserRecommendationBlocks_Relationships: { artists?: components["schemas"]["UserRecommendationBlocks_Artists_Multi_Relationship_Data_Document"]; owners?: components["schemas"]["Multi_Relationship_Data_Document"]; tracks?: components["schemas"]["UserRecommendationBlocks_Tracks_Multi_Relationship_Data_Document"]; videos?: components["schemas"]["UserRecommendationBlocks_Videos_Multi_Relationship_Data_Document"]; }; UserRecommendationBlocks_Resource_Object: { attributes?: components["schemas"]["UserRecommendationBlocks_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["UserRecommendationBlocks_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "userRecommendationBlocks"; }; UserRecommendationBlocks_Single_Resource_Data_Document: { data: components["schemas"]["UserRecommendationBlocks_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserRecommendationBlocks_Tracks_Add_Multi_Relationship_Data_Document: { data: components["schemas"]["UserRecommendationBlocks_Tracks_Add_Resource_Identifier"][]; links: components["schemas"]["Links"]; }; UserRecommendationBlocks_Tracks_Add_Resource_Identifier: { id: string; /** @enum {string} */ type: "tracks"; }; UserRecommendationBlocks_Tracks_Multi_Relationship_Data_Document: { data?: components["schemas"]["UserRecommendationBlocks_Tracks_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserRecommendationBlocks_Tracks_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["UserRecommendationBlocks_Tracks_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; UserRecommendationBlocks_Tracks_Resource_Identifier_Meta: { /** * Format: date-time * @description When the item was blocked */ createdAt: string; replacement?: components["schemas"]["Replacement_Provenance"]; }; UserRecommendationBlocks_Videos_Add_Multi_Relationship_Data_Document: { data: components["schemas"]["UserRecommendationBlocks_Videos_Add_Resource_Identifier"][]; links: components["schemas"]["Links"]; }; UserRecommendationBlocks_Videos_Add_Resource_Identifier: { id: string; /** @enum {string} */ type: "videos"; }; UserRecommendationBlocks_Videos_Multi_Relationship_Data_Document: { data?: components["schemas"]["UserRecommendationBlocks_Videos_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserRecommendationBlocks_Videos_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["UserRecommendationBlocks_Videos_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; UserRecommendationBlocks_Videos_Resource_Identifier_Meta: { /** * Format: date-time * @description When the item was blocked */ createdAt: string; replacement?: components["schemas"]["Replacement_Provenance"]; }; UserRecommendations_Attributes: Record; UserRecommendations_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserRecommendations_Relationships: { discoveryMixes?: components["schemas"]["Multi_Relationship_Data_Document"]; myMixes?: components["schemas"]["Multi_Relationship_Data_Document"]; newArrivalMixes?: components["schemas"]["Multi_Relationship_Data_Document"]; offlineMixes?: components["schemas"]["Multi_Relationship_Data_Document"]; }; UserRecommendations_Resource_Object: { attributes?: components["schemas"]["UserRecommendations_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["UserRecommendations_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "userRecommendations"; }; UserRecommendations_Single_Resource_Data_Document: { data: components["schemas"]["UserRecommendations_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserReportsCreateOperation_Payload: { data: components["schemas"]["UserReportsCreateOperation_Payload_Data"]; }; UserReportsCreateOperation_Payload_Data: { attributes: components["schemas"]["UserReportsCreateOperation_Payload_Data_Attributes"]; relationships: components["schemas"]["UserReportsCreateOperation_Payload_Data_Relationships"]; /** @enum {string} */ type: "userReports"; }; UserReportsCreateOperation_Payload_Data_Attributes: { description: string; /** @enum {string} */ reason: "SEXUAL_CONTENT_OR_NUDITY" | "VIOLENT_OR_DANGEROUS_CONTENT" | "HATEFUL_OR_ABUSIVE_CONTENT" | "HARASSMENT" | "PRIVACY_VIOLATION" | "SCAMS_OR_FRAUD" | "SPAM" | "COPYRIGHT_INFRINGEMENT" | "APPEAL" | "UNKNOWN"; }; UserReportsCreateOperation_Payload_Data_Relationships: { reportedResources: components["schemas"]["UserReportsCreateOperation_Payload_Data_Relationships_ReportedResources"]; }; UserReportsCreateOperation_Payload_Data_Relationships_ReportedResources: { data: components["schemas"]["UserReportsCreateOperation_Payload_Data_Relationships_ReportedResources_Data"][]; }; UserReportsCreateOperation_Payload_Data_Relationships_ReportedResources_Data: { id: string; /** @enum {string} */ type: "tracks" | "artists" | "playlists"; }; UserReports_Attributes: { /** @description Description */ description: string; /** * @description Reason * @enum {string} */ reason: "SEXUAL_CONTENT_OR_NUDITY" | "VIOLENT_OR_DANGEROUS_CONTENT" | "HATEFUL_OR_ABUSIVE_CONTENT" | "HARASSMENT" | "PRIVACY_VIOLATION" | "SCAMS_OR_FRAUD" | "SPAM" | "COPYRIGHT_INFRINGEMENT" | "APPEAL" | "UNKNOWN"; }; UserReports_Create_Single_Resource_Data_Document: { data: components["schemas"]["UserReports_Resource_Object"]; links: components["schemas"]["Links"]; }; UserReports_Resource_Object: { attributes?: components["schemas"]["UserReports_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "userReports"; }; UserSubscriptionPriceChanges_Attributes: { /** * @description ISO 4217 currency code * @example EUR */ currency: string; /** * @description Price amount with max 2 decimal places * @example 9.99 */ currentPrice: string; /** * Format: date * @description The date the new price takes effect */ effectiveDate: string; /** * @description Price amount with max 2 decimal places * @example 9.99 */ newPrice: string; }; UserSubscriptionPriceChanges_Multi_Resource_Data_Document: { data: components["schemas"]["UserSubscriptionPriceChanges_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; UserSubscriptionPriceChanges_Relationships: { decision?: components["schemas"]["Single_Relationship_Data_Document"]; }; UserSubscriptionPriceChanges_Resource_Object: { attributes?: components["schemas"]["UserSubscriptionPriceChanges_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["UserSubscriptionPriceChanges_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "userSubscriptionPriceChanges"; }; UserSubscriptionPriceChanges_Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Users_Attributes: { /** * @description ISO 3166-1 alpha-2 country code * @example US */ country: string; /** * @description Developer access tier for this user. * @example THIRD_PARTY * @enum {string} */ developerAccessTier: "THIRD_PARTY" | "THIRD_PARTY_PROD" | "PARTNER" | "INTERNAL"; /** * @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 Users nostr public key * @example e3fc3965800f9c729b483a2a7291f30e569fbf5ab91a6eef332f9e28a5e923dd */ nostrPublicKey?: string; /** * @description user name * @example username */ username: string; }; Users_Resource_Object: { attributes?: components["schemas"]["Users_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "users"; }; Users_Single_Resource_Data_Document: { data: components["schemas"]["Users_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; VideoManifestsReadById403ResponseBody: { errors: { /** * @example CLIENT_NOT_ENTITLED * @enum {string} */ code: "CLIENT_NOT_ENTITLED" | "CONCURRENT_PLAYBACK" | "GEO_RESTRICTED" | "PREREQUISITE_MISSING" | "PURCHASE_REQUIRED"; /** @example Required playback prerequisites are missing */ detail?: string; /** @example 403 */ status: string; }[]; }; VideoManifestsReadById404ResponseBody: { errors: { /** * @example CONTENT_NOT_FOUND * @enum {string} */ code: "CONTENT_NOT_FOUND"; /** @example Content does not exist or is no longer available */ detail?: string; /** @example 404 */ status: string; }[]; }; VideoManifests_Attributes: { drmData?: components["schemas"]["DrmData"]; link?: components["schemas"]["Link_Object"]; /** * @description Why a preview is served instead of the full video * @enum {string} */ previewReason?: "FULL_REQUIRES_SUBSCRIPTION" | "FULL_REQUIRES_PURCHASE" | "FULL_REQUIRES_HIGHER_ACCESS_TIER"; /** * @description Video presentation * @enum {string} */ videoPresentation?: "FULL" | "PREVIEW"; }; VideoManifests_Resource_Object: { attributes?: components["schemas"]["VideoManifests_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "videoManifests"; }; VideoManifests_Single_Resource_Data_Document: { data: components["schemas"]["VideoManifests_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Videos_Albums_Multi_Relationship_Data_Document: { data?: components["schemas"]["Videos_Albums_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Videos_Albums_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Videos_Albums_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Videos_Albums_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; Videos_Attributes: { /** * @deprecated * @description Available usage for this video. Deprecated: use 'usageRules' instead. This field will be removed in a future version. */ availability?: ("STREAM" | "DJ" | "STEM")[]; copyright?: components["schemas"]["Copyright"]; /** * @description Duration (ISO 8601) * @example PT2M58S */ duration: string; /** * @description Explicit content * @example false */ explicit: boolean; /** @description Video links external to TIDAL API */ externalLinks?: components["schemas"]["External_Link"][]; /** * @description International Standard Recording Code (ISRC) * @example TIDAL2274 */ isrc: string; /** * Format: double * @description Popularity (0.0 - 1.0) * @example 0.56 */ popularity: number; /** * Format: date * @description Release date (ISO-8601) * @example 2017-06-27 */ releaseDate?: string; /** * @description Video title * @example Kill Jay Z */ title: string; /** * @description Video version, complements title * @example original, mix etc */ version?: string; }; Videos_Multi_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Videos_Multi_Resource_Data_Document: { data: components["schemas"]["Videos_Resource_Object"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Videos_Relationships: { albums?: components["schemas"]["Videos_Albums_Multi_Relationship_Data_Document"]; artists?: components["schemas"]["Multi_Relationship_Data_Document"]; credits?: components["schemas"]["Multi_Relationship_Data_Document"]; providers?: components["schemas"]["Multi_Relationship_Data_Document"]; replacement?: components["schemas"]["Videos_Replacement_Single_Relationship_Data_Document"]; similarVideos?: components["schemas"]["Videos_SimilarVideos_Multi_Relationship_Data_Document"]; suggestedVideos?: components["schemas"]["Videos_SuggestedVideos_Multi_Relationship_Data_Document"]; thumbnailArt?: components["schemas"]["Multi_Relationship_Data_Document"]; usageRules?: components["schemas"]["Single_Relationship_Data_Document"]; }; Videos_Replacement_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Videos_Replacement_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Videos_Replacement_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; Videos_Replacement_Single_Relationship_Data_Document: { data?: components["schemas"]["Videos_Replacement_Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Videos_Resource_Object: { attributes?: components["schemas"]["Videos_Attributes"]; /** * @description Resource id * @example 12345 */ id: string; relationships?: components["schemas"]["Videos_Relationships"]; /** * @description Resource type (enum property replaced by openapi-typescript) * @enum {string} */ type: "videos"; }; Videos_SimilarVideos_Multi_Relationship_Data_Document: { data?: components["schemas"]["Videos_SimilarVideos_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Videos_SimilarVideos_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Videos_SimilarVideos_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Videos_SimilarVideos_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; Videos_Single_Relationship_Data_Document: { data?: components["schemas"]["Resource_Identifier"] | (never | null); included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Videos_Single_Resource_Data_Document: { data: components["schemas"]["Videos_Resource_Object"]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Videos_SuggestedVideos_Multi_Relationship_Data_Document: { data?: components["schemas"]["Videos_SuggestedVideos_Resource_Identifier"][]; included?: components["schemas"]["Included"]; links: components["schemas"]["Links"]; }; Videos_SuggestedVideos_Resource_Identifier: { /** * @description Resource id * @example 12345 */ id: string; meta?: components["schemas"]["Videos_SuggestedVideos_Resource_Identifier_Meta"]; /** * @description Resource type * @example tracks */ type: string; }; Videos_SuggestedVideos_Resource_Identifier_Meta: { replacement?: components["schemas"]["Replacement_Provenance"]; }; }; responses: { /** @description Invalid request */ Default400Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Default400ResponseBody"]; }; }; /** @description Resource not found */ Default404Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Default404ResponseBody"]; }; }; /** @description HTTP method not allowed */ Default405Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Default405ResponseBody"]; }; }; /** @description No acceptable response media type */ Default406Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Default406ResponseBody"]; }; }; /** @description Unsupported request media type or encoding */ Default415Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Default415ResponseBody"]; }; }; /** @description Rate limit exceeded */ Default429Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Default429ResponseBody"]; }; }; /** @description Internal server error */ Default500Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Default500ResponseBody"]; }; }; /** @description Service temporarily unavailable */ Default503Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Default503ResponseBody"]; }; }; /** @description Request already in progress for this idempotency key */ Idempotency409Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Idempotency409ResponseBody"]; }; }; /** @description Idempotency key reused with a different payload */ Idempotency422Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["Idempotency422ResponseBody"]; }; }; /** @description Latest terms and conditions must be accepted */ SquareConnectionsReadById403Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SquareConnectionsReadById403ResponseBody"]; }; }; /** @description Latest terms and conditions must be accepted */ SquareConnectionsReadMultiDataRelationship403Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SquareConnectionsReadMultiDataRelationship403ResponseBody"]; }; }; /** @description Latest terms and conditions must be accepted */ SquareConnectionsReadSingleDataRelationship403Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SquareConnectionsReadSingleDataRelationship403ResponseBody"]; }; }; /** @description Latest terms and conditions must be accepted */ SquareConnectionsUpdateSingleDataRelationship403Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SquareConnectionsUpdateSingleDataRelationship403ResponseBody"]; }; }; /** @description Square credential lacks required site scopes; run Square onboarding again; Request already in progress for this idempotency key */ SquareConnectionsUpdateSingleDataRelationship409Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["SquareConnectionsUpdateSingleDataRelationship409ResponseBody"]; }; }; /** @description Required playback prerequisites are missing; Content is unavailable in your location; Content must be purchased before playback; Client cannot access this content; Account is playing on another app or device */ TrackFilesReadById403Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["TrackFilesReadById403ResponseBody"]; }; }; /** @description Content does not exist or is no longer available */ TrackFilesReadById404Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["TrackFilesReadById404ResponseBody"]; }; }; /** @description Required playback prerequisites are missing; Content is unavailable in your location; Content must be purchased before playback; Client cannot access this content; Account is playing on another app or device */ TrackManifestsReadById403Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["TrackManifestsReadById403ResponseBody"]; }; }; /** @description Content does not exist or is no longer available */ TrackManifestsReadById404Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["TrackManifestsReadById404ResponseBody"]; }; }; /** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */ UserCollectionAlbumsAddMultiDataRelationshipWithResponse409Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionAlbumsAddMultiDataRelationshipWithResponse409ResponseBody"]; }; }; /** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */ UserCollectionArtistsAddMultiDataRelationshipWithResponse409Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionArtistsAddMultiDataRelationshipWithResponse409ResponseBody"]; }; }; /** @description Folder must be empty and owned by you */ UserCollectionFoldersDeleteResource400Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionFoldersDeleteResource400ResponseBody"]; }; }; /** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */ UserCollectionPlaylistsAddMultiDataRelationshipWithResponse409Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionPlaylistsAddMultiDataRelationshipWithResponse409ResponseBody"]; }; }; /** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */ UserCollectionSaveForLatersAddMultiDataRelationshipWithResponse409Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionSaveForLatersAddMultiDataRelationshipWithResponse409ResponseBody"]; }; }; /** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */ UserCollectionTracksAddMultiDataRelationshipWithResponse409Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionTracksAddMultiDataRelationshipWithResponse409ResponseBody"]; }; }; /** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */ UserCollectionVideosAddMultiDataRelationshipWithResponse409Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionVideosAddMultiDataRelationshipWithResponse409ResponseBody"]; }; }; /** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */ UserCollectionsAddMultiDataRelationship409Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserCollectionsAddMultiDataRelationship409ResponseBody"]; }; }; /** @description Recommendation block limit reached; Request already in progress for this idempotency key */ UserRecommendationBlocksAddMultiDataRelationshipWithResponse409Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["UserRecommendationBlocksAddMultiDataRelationshipWithResponse409ResponseBody"]; }; }; /** @description Required playback prerequisites are missing; Content is unavailable in your location; Content must be purchased before playback; Client cannot access this content; Account is playing on another app or device */ VideoManifestsReadById403Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["VideoManifestsReadById403ResponseBody"]; }; }; /** @description Content does not exist or is no longer available */ VideoManifestsReadById404Response: { headers: { [name: string]: unknown; }; content: { "application/vnd.api+json": components["schemas"]["VideoManifestsReadById404ResponseBody"]; }; }; }; parameters: { /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */ IdempotencyKey: string; }; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; type WithRequired = T & { [P in K]-?: T[P]; }; export type operations = Record; export {};