/** * 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