/
/
/
1{
2 "openapi" : "3.0.1",
3 "info" : {
4 "contact" : {
5 "name" : "TIDAL Developer - Discussions",
6 "url" : "https://github.com/orgs/tidal-music/discussions"
7 },
8 "description" : "The TIDAL API is a [JSON:API](https://jsonapi.org/)-compliant web API exposing TIDAL's music catalogue, metadata, and user functionality. Guides, authorization documentation, and API key management live at [developer.tidal.com](https://developer.tidal.com).\n\nAll endpoints exchange `application/vnd.api+json` documents per the [JSON:API specification](https://jsonapi.org/format/): [resource objects](https://jsonapi.org/format/#document-resource-objects) with `attributes` and `relationships`, [compound documents](https://jsonapi.org/format/#document-compound-documents) via `include`, and standard [error objects](https://jsonapi.org/format/#error-objects).\n\n### Authentication and authorization\n\nEvery request requires an OAuth 2.0 access token in the `Authorization: Bearer` header. Tokens are issued at `https://auth.tidal.com/v1/oauth2/token` via the client-credentials flow (server-to-server) or the authorization-code + PKCE flow (user context; authorize at `https://login.tidal.com/authorize`). Each endpoint documents which flows it accepts, the access tier it requires, and the scopes that apply. Scopes protect private user data: fields you are not authorized to read are redacted from the response rather than causing an error, and resources you cannot access at all behave as if they do not exist. See the [authorization guide](https://developer.tidal.com/documentation/api-sdk/api-sdk-authorization) for details.\n\n### Working with responses\n\n- **Enums** â new values can be added to any enum at any time. Treat unknown values as forward-compatible, not as errors.\n- **IDs** are opaque strings. Never parse, construct, or infer meaning from them.\n- **Formats** â dates, times and durations are ISO 8601 (`2024-05-01T12:00:00Z`, `PT3M5S`); countries ISO 3166-1 alpha-2; languages BCP 47; currencies ISO 4217; colors six-digit hex.\n\n### Relationships and includes\n\n[Relationships](https://jsonapi.org/format/#document-resource-object-relationships) are returned only on request: a resource's `relationships` object contains just the relationships named in [`include`](https://jsonapi.org/format/#fetching-includes) â a relationship that was not requested is absent from the response, not empty. The full set of relationships a resource supports is documented in its schema.\n\nRequest related resources in one round trip with `?include=`, a comma-separated list of dot-separated relationship paths â e.g. `include=coverArt,artists.profileArt` on an album. A nested path automatically embeds its intermediate resources: `artists.profileArt` includes the artists as well as their profile art. Include paths are always relative to the request's root resource, also on relationship endpoints. Including a relationship never changes the primary data; the related resources are added to `included`.\n\nInclude paths are validated: a path that cannot be resolved against the resources' documented relationships is rejected with `400`. Include trees are also bounded in path depth (default 3 levels) and in the total number of distinct resources they name (default 10); individual endpoints may apply different limits. A request exceeding either limit is rejected with `400`, with the effective limit stated in the error.\n\n### Filtering, sorting, pagination\n\n- [`filter[<member>]=value`](https://jsonapi.org/format/#fetching-filtering) filters collections; each endpoint documents its available filters, and most collections require at least one.\n- [`sort=<member>`](https://jsonapi.org/format/#fetching-sorting) sorts ascending, `-<member>` descending (`sort=-addedAt`). Filter and sort members are relative to the resources being returned.\n- Parameters an endpoint cannot honor are rejected with `400`: a `filter[...]` parameter the endpoint does not document (the error lists the available filters), or `sort` on an endpoint that documents no sort values.\n- [Pagination](https://jsonapi.org/format/#fetching-pagination) is cursor-based: responses carry `links.self` and, while more pages exist, `links.next` with an opaque `page[cursor]`. Follow `next` until absent â there are no offset or total-page parameters. Collection sizes, when available, appear as `meta.total` and may be approximate.\n\n### Type qualifiers\n\nWhere a relationship can contain several resource types, a path segment may be prefixed with a concrete type to scope which type's member is accessed. A playlist's `items` are `tracks` or `videos`: `GET /playlists/{id}?include=items.tracks:albums` resolves `albums` only for the items that are tracks. Qualifiers scope member access â they never filter which resources appear in a relationship â and can be chained.\n\nThe same syntax applies to `filter` and `sort` member paths on endpoints that support it; where supported, the qualified member is listed among the endpoint's documented filters and sort values. The syntax follows JSON:API proposal [json-api#1695](https://github.com/json-api/json-api/issues/1695).\n\n### Mutations\n\n- [Partial updates](https://jsonapi.org/format/#crud-updating-resource-attributes) distinguish three wire states for nullable attributes: omission leaves the current value unchanged, an explicit `null` clears it, and a concrete value updates it.\n- Every mutation accepts an [`Idempotency-Key`](https://www.ietf.org/archive/id/draft-ietf-httpapi-idempotency-key-header-07.html) header. Once the original request has completed, retrying with the same key and payload within one hour replays its response; a retry while it is still processing is rejected with `409`, and the same key with a different payload with `422`.\n- After a successful write, your own subsequent reads reflect the change; other clients may observe it with a delay.\n\n### Media resource replacements - BETA Internal only\n\nMedia resources (`tracks`, `videos`, and `albums`) can become unavailable in a country when licensing rights change. By default, TIDAL API returns the resource identifiers originally stored in a collection. This keeps ordinary reads predictable and consistent.\n\nIf a stored media resource is unavailable for the effective country, TIDAL may identify a contextually applicable alternative that is available there. Replacement is best effort, so an alternative is not always available. Replacement never changes the stored collection.\n\nTIDAL API provides two ways to work with replacements:\n\n1. **Inspect the `replacement` relationship.** A media resource can expose its applicable alternative through the `replacement` relationship. Include this relationship when a client needs both the original and replacement identifiers or wants to decide whether to use the replacement.\n\n2. **Apply replacements with `replaceMedia`.** Clients can use `replaceMedia` to substitute applicable replacements directly into selected relationship data. The parameter accepts relationship paths using the same syntax as `include`. Projection affects only the response and preserves relationship order and metadata. Each identifier includes `meta.replacement` describing whether it was `ORIGINAL`, `REPLACED`, or `NOT_REPLACED`.\n\nFor example, `GET /playlists/{id}?include=items&replaceMedia=items` applies replacements to media identifiers in the playlist's `items` relationship.\n\n### Compression\n\nResponses are gzip-compressed when the request includes `Accept-Encoding: gzip` (bodies over 2 KB).\n\n### Deprecation\n\nDeprecated endpoints, parameters, and fields are marked `deprecated` in this specification, with the replacement noted in their description. Deprecated functionality keeps working for at least six months after being marked, and is only removed once a replacement is generally available.",
9 "termsOfService" : "https://developer.tidal.com/documentation/guidelines/guidelines-developer-terms",
10 "title" : "TIDAL API",
11 "version" : "1.10.101"
12 },
13 "externalDocs" : {
14 "description" : "TIDAL Developer - Documentation",
15 "url" : "https://developer.tidal.com/documentation"
16 },
17 "servers" : [ {
18 "url" : "https://openapi.tidal.com/v2",
19 "description" : "Production"
20 } ],
21 "tags" : [ {
22 "description" : "A record of a user's acceptance of terms and conditions.",
23 "name" : "acceptedTerms"
24 }, {
25 "description" : "Playback statistics for an album, including total plays, unique listeners, and sales.",
26 "name" : "albumStatistics"
27 }, {
28 "description" : "A music album, consisting of one or more tracks.",
29 "name" : "albums"
30 }, {
31 "description" : "A user's appreciation of a piece of content.",
32 "name" : "appreciations"
33 }, {
34 "description" : "A biography text for an artist.",
35 "name" : "artistBiographies"
36 }, {
37 "description" : "Claim status for an artist profile.",
38 "name" : "artistClaimStatuses"
39 }, {
40 "description" : "A claim by an artist to own an artist profile via DSP authentication.",
41 "name" : "artistClaims"
42 }, {
43 "description" : "A role describing an artist's contribution, such as performer or producer.",
44 "name" : "artistRoles"
45 }, {
46 "description" : "A music artist.",
47 "name" : "artists"
48 }, {
49 "description" : "Artwork images and videos used for albums, artists, tracks, and playlists.",
50 "name" : "artworks"
51 }, {
52 "description" : "An OAuth client.",
53 "name" : "clients"
54 }, {
55 "description" : "Redemption of a collaboration invite. Creating one adds the caller as a collaborator on the invite's subject resource (currently only `playlists`).",
56 "name" : "collaborationInviteRedemptions"
57 }, {
58 "description" : "A single-use, expiring invite link to add a collaborator to a subject resource (currently only `playlists`). Each invite can be redeemed exactly once; subsequent redemptions on the same invite are rejected with COLLABORATION_INVITE_ALREADY_REDEEMED. The polymorphic `subject` relationship follows the TIDAL convention used by `comments`, `reactions`, `purchases`, etc.",
59 "name" : "collaborationInvites"
60 }, {
61 "name" : "comments"
62 }, {
63 "description" : "A claim by an artist asserting ownership of a piece of content.",
64 "name" : "contentClaims"
65 }, {
66 "description" : "A credit entry linking a contributor to a track or album.",
67 "name" : "credits"
68 }, {
69 "description" : "A downloadable content file with its download links.",
70 "name" : "downloads"
71 }, {
72 "description" : "Links to equivalent content on other streaming platforms.",
73 "name" : "dspSharingLinks"
74 }, {
75 "description" : "A module within a dynamic page, containing resources to render. Page composition may vary with client context; module resources do not.",
76 "name" : "dynamicModules"
77 }, {
78 "description" : "A dynamically composed page of modules, such as the home screen.",
79 "name" : "dynamicPages"
80 }, {
81 "description" : "A music genre classification.",
82 "name" : "genres"
83 }, {
84 "description" : "A registered device installation for a user.",
85 "name" : "installations"
86 }, {
87 "description" : "Lyrics for a track, including plain text and time-synced LRC formats.",
88 "name" : "lyrics"
89 }, {
90 "description" : "A manual artist claim submitted with identity verification details.",
91 "name" : "manualArtistClaims"
92 }, {
93 "description" : "A task describing an offline sync action for a user's device.",
94 "name" : "offlineTasks"
95 }, {
96 "description" : "A user's current play queue, including past and upcoming items.",
97 "name" : "playQueues"
98 }, {
99 "description" : "A curated or user-created playlist of tracks and videos.",
100 "name" : "playlists"
101 }, {
102 "description" : "Pricing configuration for purchasable content.",
103 "name" : "priceConfigurations"
104 }, {
105 "description" : "An association between a content provider and an owning user.",
106 "name" : "providerOwners"
107 }, {
108 "description" : "Product information for a content provider's catalogue.",
109 "name" : "providerProductInfos"
110 }, {
111 "description" : "A content provider or label that supplies music to TIDAL.",
112 "name" : "providers"
113 }, {
114 "description" : "A user's purchased content.",
115 "name" : "purchases"
116 }, {
117 "description" : "An emoji reaction by a user on a piece of content.",
118 "name" : "reactions"
119 }, {
120 "description" : "A share saved to a user's collection.",
121 "name" : "savedShares"
122 }, {
123 "description" : "An OAuth scope that a client may request from end users.",
124 "name" : "scopes"
125 }, {
126 "description" : "A user's recent search history entry.",
127 "name" : "searchHistoryEntries"
128 }, {
129 "description" : "Search results for a query across tracks, albums, artists, and other content.",
130 "name" : "searchResults"
131 }, {
132 "description" : "Autocomplete suggestions for a search query.",
133 "name" : "searchSuggestions"
134 }, {
135 "description" : "A shareable link to one or more TIDAL resources.",
136 "name" : "shares"
137 }, {
138 "description" : "A Square seller connection linked to a user for receiving payments.",
139 "name" : "squareConnections"
140 }, {
141 "description" : "A Square Online site belonging to the seller's Square account.",
142 "name" : "squareSites"
143 }, {
144 "description" : "A Stripe Connect account linked to a user for receiving payments.",
145 "name" : "stripeConnections"
146 }, {
147 "description" : "A short-lived login link for the Stripe Express dashboard.",
148 "name" : "stripeDashboardLinks"
149 }, {
150 "description" : "A record of the user's decision on an announced price change.",
151 "name" : "subscriptionPriceChangeDecisions"
152 }, {
153 "description" : "A short-lived temporary token used to transfer user information from an authenticatedsession to another; initially for links between TIDAL web/desktop app and TIDAL'saccount pages",
154 "name" : "temporaryUserTokens"
155 }, {
156 "description" : "A terms and conditions document.",
157 "name" : "terms"
158 }, {
159 "description" : "An individual audio file for a track in a specific format and quality.",
160 "name" : "trackFiles"
161 }, {
162 "description" : "A playback manifest for a track, containing streaming URIs and format details.",
163 "name" : "trackManifests"
164 }, {
165 "description" : "A track source file is the media source file of a track, meaning audio content.\nAfter a track source file is uploaded successfully it will be ingested and transcoded into deliverables and\nstored like any other content we receive from labels.\n",
166 "name" : "trackSourceFiles"
167 }, {
168 "description" : "Playback statistics for a track, including total plays and unique listeners.",
169 "name" : "trackStatistics"
170 }, {
171 "description" : "A music track.",
172 "name" : "tracks"
173 }, {
174 "description" : "Status of metadata detection job for a track.\nTracks the progress of async jobs that detect and pre-fill metadata fields.\n",
175 "name" : "tracksMetadataStatus"
176 }, {
177 "description" : "Usage rules defining how content may be consumed in a given country.",
178 "name" : "usageRules"
179 }, {
180 "description" : "A user's collection of favorited albums.",
181 "name" : "userCollectionAlbums"
182 }, {
183 "description" : "A user's collection of favorited artists.",
184 "name" : "userCollectionArtists"
185 }, {
186 "description" : "Represents a folder for organizing items in a user's collection.",
187 "name" : "userCollectionFolders"
188 }, {
189 "description" : "A user's collection of favorited playlists.",
190 "name" : "userCollectionPlaylists"
191 }, {
192 "description" : "A user's save-for-later collection.",
193 "name" : "userCollectionSaveForLaters"
194 }, {
195 "description" : "A user's collection of favorited tracks.",
196 "name" : "userCollectionTracks"
197 }, {
198 "description" : "A user's collection of favorited videos.",
199 "name" : "userCollectionVideos"
200 }, {
201 "description" : "Deprecated. Use the dedicated collection resources instead: userCollectionAlbums, userCollectionArtists, userCollectionTracks, userCollectionVideos, or userCollectionPlaylists.",
202 "name" : "userCollections"
203 }, {
204 "description" : "A user's daily mixes.",
205 "name" : "userDailyMixes"
206 }, {
207 "description" : "A request to export a user's personal data collected by Tidal.",
208 "name" : "userDataExportRequests"
209 }, {
210 "description" : "A user's discovery mixes.",
211 "name" : "userDiscoveryMixes"
212 }, {
213 "description" : "A user's new release mixes.",
214 "name" : "userNewReleaseMixes"
215 }, {
216 "description" : "A user's offline mixes.",
217 "name" : "userOfflineMixes"
218 }, {
219 "description" : "A user's recommendation blocks for artists, tracks, and videos.",
220 "name" : "userRecommendationBlocks"
221 }, {
222 "description" : "Deprecated. Use the dedicated mix resources instead: userDiscoveryMixes, userDailyMixes, userNewReleaseMixes, or userOfflineMixes.",
223 "name" : "userRecommendations"
224 }, {
225 "description" : "A user-submitted report flagging inappropriate or harmful content.",
226 "name" : "userReports"
227 }, {
228 "description" : "An announced subscription price increase applicable to the user.",
229 "name" : "userSubscriptionPriceChanges"
230 }, {
231 "description" : "A TIDAL user account.",
232 "name" : "users"
233 }, {
234 "description" : "A playback manifest for a video, containing streaming URIs and format details.",
235 "name" : "videoManifests"
236 }, {
237 "description" : "A music video.",
238 "name" : "videos"
239 } ],
240 "paths" : {
241 "/acceptedTerms" : {
242 "get" : {
243 "description" : "Retrieves multiple acceptedTerms by available filters, or without if applicable.",
244 "parameters" : [ {
245 "description" : "User id. Use `me` for the authenticated user",
246 "in" : "query",
247 "name" : "filter[owners.id]",
248 "required" : true,
249 "schema" : {
250 "type" : "array",
251 "items" : {
252 "type" : "string"
253 }
254 }
255 }, {
256 "description" : "One of: DEVELOPER, UPLOAD_MARKETPLACE, MERCH_GUIDELINES (e.g. `DEVELOPER`)",
257 "in" : "query",
258 "name" : "filter[terms.termsType]",
259 "required" : true,
260 "schema" : {
261 "type" : "array",
262 "items" : {
263 "type" : "string",
264 "enum" : [ "DEVELOPER", "UPLOAD_MARKETPLACE", "MERCH_GUIDELINES" ]
265 }
266 }
267 }, {
268 "description" : "Allows the client to customize which related resources should be returned. Available options: owners, terms",
269 "example" : "owners",
270 "in" : "query",
271 "name" : "include",
272 "required" : false,
273 "schema" : {
274 "type" : "array",
275 "items" : {
276 "type" : "string",
277 "example" : "owners"
278 }
279 }
280 }, {
281 "description" : "Filter by terms.isLatestVersion",
282 "in" : "query",
283 "name" : "filter[terms.isLatestVersion]",
284 "required" : false,
285 "schema" : {
286 "type" : "array",
287 "items" : {
288 "type" : "string"
289 }
290 }
291 } ],
292 "responses" : {
293 "200" : {
294 "content" : {
295 "application/vnd.api+json" : {
296 "schema" : {
297 "$ref" : "#/components/schemas/AcceptedTerms_Multi_Resource_Data_Document"
298 }
299 }
300 },
301 "description" : "Successful response"
302 },
303 "400" : {
304 "$ref" : "#/components/responses/Default400Response"
305 },
306 "404" : {
307 "$ref" : "#/components/responses/Default404Response"
308 },
309 "405" : {
310 "$ref" : "#/components/responses/Default405Response"
311 },
312 "406" : {
313 "$ref" : "#/components/responses/Default406Response"
314 },
315 "415" : {
316 "$ref" : "#/components/responses/Default415Response"
317 },
318 "429" : {
319 "$ref" : "#/components/responses/Default429Response"
320 },
321 "500" : {
322 "$ref" : "#/components/responses/Default500Response"
323 },
324 "503" : {
325 "$ref" : "#/components/responses/Default503Response"
326 }
327 },
328 "security" : [ {
329 "Authorization_Code_PKCE" : [ "r_usr" ]
330 } ],
331 "summary" : "Get multiple acceptedTerms.",
332 "tags" : [ "acceptedTerms" ],
333 "x-path-item-properties" : {
334 "required-access-tier" : "INTERNAL"
335 }
336 },
337 "post" : {
338 "description" : "Creates a new acceptedTerm.",
339 "parameters" : [ {
340 "$ref" : "#/components/parameters/IdempotencyKey"
341 } ],
342 "requestBody" : {
343 "content" : {
344 "application/vnd.api+json" : {
345 "schema" : {
346 "$ref" : "#/components/schemas/AcceptedTermsCreateOperation_Payload"
347 }
348 }
349 }
350 },
351 "responses" : {
352 "201" : {
353 "content" : {
354 "application/vnd.api+json" : {
355 "schema" : {
356 "$ref" : "#/components/schemas/AcceptedTerms_Create_Single_Resource_Data_Document"
357 }
358 }
359 },
360 "description" : "Successful response"
361 },
362 "400" : {
363 "$ref" : "#/components/responses/Default400Response"
364 },
365 "404" : {
366 "$ref" : "#/components/responses/Default404Response"
367 },
368 "405" : {
369 "$ref" : "#/components/responses/Default405Response"
370 },
371 "406" : {
372 "$ref" : "#/components/responses/Default406Response"
373 },
374 "409" : {
375 "$ref" : "#/components/responses/Idempotency409Response"
376 },
377 "415" : {
378 "$ref" : "#/components/responses/Default415Response"
379 },
380 "422" : {
381 "$ref" : "#/components/responses/Idempotency422Response"
382 },
383 "429" : {
384 "$ref" : "#/components/responses/Default429Response"
385 },
386 "500" : {
387 "$ref" : "#/components/responses/Default500Response"
388 },
389 "503" : {
390 "$ref" : "#/components/responses/Default503Response"
391 }
392 },
393 "security" : [ {
394 "Authorization_Code_PKCE" : [ "w_usr" ]
395 } ],
396 "summary" : "Create single acceptedTerm.",
397 "tags" : [ "acceptedTerms" ],
398 "x-path-item-properties" : {
399 "required-access-tier" : "INTERNAL"
400 }
401 }
402 },
403 "/acceptedTerms/{id}/relationships/owners" : {
404 "get" : {
405 "description" : "Retrieves owners relationship.",
406 "parameters" : [ {
407 "description" : "Accepted terms id",
408 "example" : "a468bee88def",
409 "in" : "path",
410 "name" : "id",
411 "required" : true,
412 "schema" : {
413 "type" : "string"
414 }
415 }, {
416 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
417 "example" : "owners",
418 "in" : "query",
419 "name" : "include",
420 "required" : false,
421 "schema" : {
422 "type" : "array",
423 "items" : {
424 "type" : "string",
425 "example" : "owners"
426 }
427 }
428 }, {
429 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
430 "in" : "query",
431 "name" : "page[cursor]",
432 "required" : false,
433 "schema" : {
434 "type" : "string"
435 }
436 } ],
437 "responses" : {
438 "200" : {
439 "content" : {
440 "application/vnd.api+json" : {
441 "schema" : {
442 "$ref" : "#/components/schemas/AcceptedTerms_Multi_Relationship_Data_Document"
443 }
444 }
445 },
446 "description" : "Successful response"
447 },
448 "400" : {
449 "$ref" : "#/components/responses/Default400Response"
450 },
451 "404" : {
452 "$ref" : "#/components/responses/Default404Response"
453 },
454 "405" : {
455 "$ref" : "#/components/responses/Default405Response"
456 },
457 "406" : {
458 "$ref" : "#/components/responses/Default406Response"
459 },
460 "415" : {
461 "$ref" : "#/components/responses/Default415Response"
462 },
463 "429" : {
464 "$ref" : "#/components/responses/Default429Response"
465 },
466 "500" : {
467 "$ref" : "#/components/responses/Default500Response"
468 },
469 "503" : {
470 "$ref" : "#/components/responses/Default503Response"
471 }
472 },
473 "security" : [ {
474 "Authorization_Code_PKCE" : [ "r_usr" ]
475 } ],
476 "summary" : "Get owners relationship (\"to-many\").",
477 "tags" : [ "acceptedTerms" ],
478 "x-path-item-properties" : {
479 "required-access-tier" : "INTERNAL"
480 }
481 }
482 },
483 "/acceptedTerms/{id}/relationships/terms" : {
484 "get" : {
485 "description" : "Retrieves terms relationship.",
486 "parameters" : [ {
487 "description" : "Accepted terms id",
488 "example" : "a468bee88def",
489 "in" : "path",
490 "name" : "id",
491 "required" : true,
492 "schema" : {
493 "type" : "string"
494 }
495 }, {
496 "description" : "Allows the client to customize which related resources should be returned. Available options: terms",
497 "example" : "terms",
498 "in" : "query",
499 "name" : "include",
500 "required" : false,
501 "schema" : {
502 "type" : "array",
503 "items" : {
504 "type" : "string",
505 "example" : "terms"
506 }
507 }
508 } ],
509 "responses" : {
510 "200" : {
511 "content" : {
512 "application/vnd.api+json" : {
513 "schema" : {
514 "$ref" : "#/components/schemas/AcceptedTerms_Single_Relationship_Data_Document"
515 }
516 }
517 },
518 "description" : "Successful response"
519 },
520 "400" : {
521 "$ref" : "#/components/responses/Default400Response"
522 },
523 "404" : {
524 "$ref" : "#/components/responses/Default404Response"
525 },
526 "405" : {
527 "$ref" : "#/components/responses/Default405Response"
528 },
529 "406" : {
530 "$ref" : "#/components/responses/Default406Response"
531 },
532 "415" : {
533 "$ref" : "#/components/responses/Default415Response"
534 },
535 "429" : {
536 "$ref" : "#/components/responses/Default429Response"
537 },
538 "500" : {
539 "$ref" : "#/components/responses/Default500Response"
540 },
541 "503" : {
542 "$ref" : "#/components/responses/Default503Response"
543 }
544 },
545 "security" : [ {
546 "Authorization_Code_PKCE" : [ "r_usr" ]
547 } ],
548 "summary" : "Get terms relationship (\"to-one\").",
549 "tags" : [ "acceptedTerms" ],
550 "x-path-item-properties" : {
551 "required-access-tier" : "INTERNAL"
552 }
553 }
554 },
555 "/albumStatistics/{id}" : {
556 "get" : {
557 "description" : "Retrieves single albumStatistic by id.",
558 "parameters" : [ {
559 "description" : "Album statistic id",
560 "example" : "123456",
561 "in" : "path",
562 "name" : "id",
563 "required" : true,
564 "schema" : {
565 "type" : "string"
566 }
567 }, {
568 "description" : "ISO 3166-1 alpha-2 country code",
569 "example" : "US",
570 "in" : "query",
571 "name" : "countryCode",
572 "required" : false,
573 "schema" : {
574 "type" : "string"
575 }
576 }, {
577 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
578 "example" : "owners",
579 "in" : "query",
580 "name" : "include",
581 "required" : false,
582 "schema" : {
583 "type" : "array",
584 "items" : {
585 "type" : "string",
586 "example" : "owners"
587 }
588 }
589 } ],
590 "responses" : {
591 "200" : {
592 "content" : {
593 "application/vnd.api+json" : {
594 "schema" : {
595 "$ref" : "#/components/schemas/AlbumStatistics_Single_Resource_Data_Document"
596 }
597 }
598 },
599 "description" : "Successful response"
600 },
601 "400" : {
602 "$ref" : "#/components/responses/Default400Response"
603 },
604 "404" : {
605 "$ref" : "#/components/responses/Default404Response"
606 },
607 "405" : {
608 "$ref" : "#/components/responses/Default405Response"
609 },
610 "406" : {
611 "$ref" : "#/components/responses/Default406Response"
612 },
613 "415" : {
614 "$ref" : "#/components/responses/Default415Response"
615 },
616 "429" : {
617 "$ref" : "#/components/responses/Default429Response"
618 },
619 "500" : {
620 "$ref" : "#/components/responses/Default500Response"
621 },
622 "503" : {
623 "$ref" : "#/components/responses/Default503Response"
624 }
625 },
626 "security" : [ {
627 "Authorization_Code_PKCE" : [ "r_usr" ]
628 } ],
629 "summary" : "Get single albumStatistic.",
630 "tags" : [ "albumStatistics" ],
631 "x-path-item-properties" : {
632 "required-access-tier" : "INTERNAL"
633 }
634 }
635 },
636 "/albumStatistics/{id}/relationships/owners" : {
637 "get" : {
638 "description" : "Retrieves owners relationship.",
639 "parameters" : [ {
640 "description" : "Album statistic id",
641 "example" : "123456",
642 "in" : "path",
643 "name" : "id",
644 "required" : true,
645 "schema" : {
646 "type" : "string"
647 }
648 }, {
649 "description" : "ISO 3166-1 alpha-2 country code",
650 "example" : "US",
651 "in" : "query",
652 "name" : "countryCode",
653 "required" : false,
654 "schema" : {
655 "type" : "string"
656 }
657 }, {
658 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
659 "example" : "owners",
660 "in" : "query",
661 "name" : "include",
662 "required" : false,
663 "schema" : {
664 "type" : "array",
665 "items" : {
666 "type" : "string",
667 "example" : "owners"
668 }
669 }
670 }, {
671 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
672 "in" : "query",
673 "name" : "page[cursor]",
674 "required" : false,
675 "schema" : {
676 "type" : "string"
677 }
678 } ],
679 "responses" : {
680 "200" : {
681 "content" : {
682 "application/vnd.api+json" : {
683 "schema" : {
684 "$ref" : "#/components/schemas/AlbumStatistics_Multi_Relationship_Data_Document"
685 }
686 }
687 },
688 "description" : "Successful response"
689 },
690 "400" : {
691 "$ref" : "#/components/responses/Default400Response"
692 },
693 "404" : {
694 "$ref" : "#/components/responses/Default404Response"
695 },
696 "405" : {
697 "$ref" : "#/components/responses/Default405Response"
698 },
699 "406" : {
700 "$ref" : "#/components/responses/Default406Response"
701 },
702 "415" : {
703 "$ref" : "#/components/responses/Default415Response"
704 },
705 "429" : {
706 "$ref" : "#/components/responses/Default429Response"
707 },
708 "500" : {
709 "$ref" : "#/components/responses/Default500Response"
710 },
711 "503" : {
712 "$ref" : "#/components/responses/Default503Response"
713 }
714 },
715 "security" : [ {
716 "Authorization_Code_PKCE" : [ "r_usr" ]
717 } ],
718 "summary" : "Get owners relationship (\"to-many\").",
719 "tags" : [ "albumStatistics" ],
720 "x-path-item-properties" : {
721 "required-access-tier" : "INTERNAL"
722 }
723 }
724 },
725 "/albums" : {
726 "get" : {
727 "description" : "Retrieves multiple albums by available filters, or without if applicable.",
728 "parameters" : [ {
729 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
730 "in" : "query",
731 "name" : "page[cursor]",
732 "required" : false,
733 "schema" : {
734 "type" : "string"
735 }
736 }, {
737 "description" : "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
738 "in" : "query",
739 "name" : "sort",
740 "required" : false,
741 "schema" : {
742 "type" : "array",
743 "items" : {
744 "type" : "string",
745 "example" : "createdAt",
746 "default" : "-createdAt",
747 "enum" : [ "createdAt", "-createdAt", "title", "-title" ],
748 "x-enum-varnames" : [ "CreatedAtAsc", "CreatedAtDesc", "TitleAsc", "TitleDesc" ]
749 }
750 }
751 }, {
752 "description" : "ISO 3166-1 alpha-2 country code",
753 "example" : "US",
754 "in" : "query",
755 "name" : "countryCode",
756 "required" : false,
757 "schema" : {
758 "type" : "string"
759 }
760 }, {
761 "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",
762 "example" : "artists.albums",
763 "in" : "query",
764 "name" : "include",
765 "required" : false,
766 "schema" : {
767 "type" : "array",
768 "items" : {
769 "type" : "string",
770 "example" : "artists.albums"
771 }
772 }
773 }, {
774 "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`)",
775 "in" : "query",
776 "name" : "filter[barcodeId]",
777 "required" : false,
778 "schema" : {
779 "type" : "array",
780 "items" : {
781 "type" : "string"
782 }
783 }
784 }, {
785 "description" : "List of album IDs (e.g. `251380836`)",
786 "in" : "query",
787 "name" : "filter[id]",
788 "required" : false,
789 "schema" : {
790 "type" : "array",
791 "items" : {
792 "type" : "string"
793 }
794 }
795 }, {
796 "description" : "User id. Use `me` for the authenticated user",
797 "in" : "query",
798 "name" : "filter[owners.id]",
799 "required" : false,
800 "schema" : {
801 "type" : "array",
802 "items" : {
803 "type" : "string"
804 }
805 }
806 }, {
807 "description" : "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",
808 "example" : "artists.albums",
809 "in" : "query",
810 "name" : "replaceMedia",
811 "required" : false,
812 "schema" : {
813 "type" : "string",
814 "example" : "artists.albums"
815 }
816 }, {
817 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
818 "in" : "query",
819 "name" : "shareCode",
820 "required" : false,
821 "schema" : {
822 "type" : "string",
823 "example" : "xyz"
824 }
825 } ],
826 "responses" : {
827 "200" : {
828 "content" : {
829 "application/vnd.api+json" : {
830 "schema" : {
831 "$ref" : "#/components/schemas/Albums_Multi_Resource_Data_Document"
832 }
833 }
834 },
835 "description" : "Successful response"
836 },
837 "400" : {
838 "$ref" : "#/components/responses/Default400Response"
839 },
840 "404" : {
841 "$ref" : "#/components/responses/Default404Response"
842 },
843 "405" : {
844 "$ref" : "#/components/responses/Default405Response"
845 },
846 "406" : {
847 "$ref" : "#/components/responses/Default406Response"
848 },
849 "415" : {
850 "$ref" : "#/components/responses/Default415Response"
851 },
852 "429" : {
853 "$ref" : "#/components/responses/Default429Response"
854 },
855 "500" : {
856 "$ref" : "#/components/responses/Default500Response"
857 },
858 "503" : {
859 "$ref" : "#/components/responses/Default503Response"
860 }
861 },
862 "security" : [ {
863 "Client_Credentials" : [ ]
864 }, {
865 "Authorization_Code_PKCE" : [ "r_usr" ]
866 } ],
867 "summary" : "Get multiple albums.",
868 "tags" : [ "albums" ],
869 "x-path-item-properties" : {
870 "required-access-tier" : "THIRD_PARTY"
871 }
872 },
873 "post" : {
874 "description" : "Creates a new album.",
875 "parameters" : [ {
876 "$ref" : "#/components/parameters/IdempotencyKey"
877 } ],
878 "requestBody" : {
879 "content" : {
880 "application/vnd.api+json" : {
881 "schema" : {
882 "$ref" : "#/components/schemas/AlbumsCreateOperation_Payload"
883 }
884 }
885 }
886 },
887 "responses" : {
888 "201" : {
889 "content" : {
890 "application/vnd.api+json" : {
891 "schema" : {
892 "$ref" : "#/components/schemas/Albums_Create_Single_Resource_Data_Document"
893 }
894 }
895 },
896 "description" : "Successful response"
897 },
898 "400" : {
899 "$ref" : "#/components/responses/Default400Response"
900 },
901 "404" : {
902 "$ref" : "#/components/responses/Default404Response"
903 },
904 "405" : {
905 "$ref" : "#/components/responses/Default405Response"
906 },
907 "406" : {
908 "$ref" : "#/components/responses/Default406Response"
909 },
910 "409" : {
911 "$ref" : "#/components/responses/Idempotency409Response"
912 },
913 "415" : {
914 "$ref" : "#/components/responses/Default415Response"
915 },
916 "422" : {
917 "$ref" : "#/components/responses/Idempotency422Response"
918 },
919 "429" : {
920 "$ref" : "#/components/responses/Default429Response"
921 },
922 "500" : {
923 "$ref" : "#/components/responses/Default500Response"
924 },
925 "503" : {
926 "$ref" : "#/components/responses/Default503Response"
927 }
928 },
929 "security" : [ {
930 "Authorization_Code_PKCE" : [ "w_usr" ]
931 } ],
932 "summary" : "Create single album.",
933 "tags" : [ "albums" ],
934 "x-path-item-properties" : {
935 "required-access-tier" : "INTERNAL"
936 }
937 }
938 },
939 "/albums/{id}" : {
940 "delete" : {
941 "description" : "Deletes existing album.",
942 "parameters" : [ {
943 "description" : "Album id",
944 "example" : "251380836",
945 "in" : "path",
946 "name" : "id",
947 "required" : true,
948 "schema" : {
949 "type" : "string"
950 }
951 }, {
952 "$ref" : "#/components/parameters/IdempotencyKey"
953 } ],
954 "responses" : {
955 "400" : {
956 "$ref" : "#/components/responses/Default400Response"
957 },
958 "404" : {
959 "$ref" : "#/components/responses/Default404Response"
960 },
961 "405" : {
962 "$ref" : "#/components/responses/Default405Response"
963 },
964 "406" : {
965 "$ref" : "#/components/responses/Default406Response"
966 },
967 "409" : {
968 "$ref" : "#/components/responses/Idempotency409Response"
969 },
970 "415" : {
971 "$ref" : "#/components/responses/Default415Response"
972 },
973 "422" : {
974 "$ref" : "#/components/responses/Idempotency422Response"
975 },
976 "429" : {
977 "$ref" : "#/components/responses/Default429Response"
978 },
979 "500" : {
980 "$ref" : "#/components/responses/Default500Response"
981 },
982 "503" : {
983 "$ref" : "#/components/responses/Default503Response"
984 }
985 },
986 "security" : [ {
987 "Authorization_Code_PKCE" : [ "w_usr" ]
988 } ],
989 "summary" : "Delete single album.",
990 "tags" : [ "albums" ],
991 "x-path-item-properties" : {
992 "required-access-tier" : "INTERNAL"
993 }
994 },
995 "get" : {
996 "description" : "Retrieves single album by id.",
997 "parameters" : [ {
998 "description" : "Album id",
999 "example" : "251380836",
1000 "in" : "path",
1001 "name" : "id",
1002 "required" : true,
1003 "schema" : {
1004 "type" : "string"
1005 }
1006 }, {
1007 "description" : "ISO 3166-1 alpha-2 country code",
1008 "example" : "US",
1009 "in" : "query",
1010 "name" : "countryCode",
1011 "required" : false,
1012 "schema" : {
1013 "type" : "string"
1014 }
1015 }, {
1016 "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",
1017 "example" : "artists.albums",
1018 "in" : "query",
1019 "name" : "include",
1020 "required" : false,
1021 "schema" : {
1022 "type" : "array",
1023 "items" : {
1024 "type" : "string",
1025 "example" : "artists.albums"
1026 }
1027 }
1028 }, {
1029 "description" : "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",
1030 "example" : "artists.albums",
1031 "in" : "query",
1032 "name" : "replaceMedia",
1033 "required" : false,
1034 "schema" : {
1035 "type" : "string",
1036 "example" : "artists.albums"
1037 }
1038 }, {
1039 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
1040 "in" : "query",
1041 "name" : "shareCode",
1042 "required" : false,
1043 "schema" : {
1044 "type" : "string",
1045 "example" : "xyz"
1046 }
1047 } ],
1048 "responses" : {
1049 "200" : {
1050 "content" : {
1051 "application/vnd.api+json" : {
1052 "schema" : {
1053 "$ref" : "#/components/schemas/Albums_Single_Resource_Data_Document"
1054 }
1055 }
1056 },
1057 "description" : "Successful response"
1058 },
1059 "400" : {
1060 "$ref" : "#/components/responses/Default400Response"
1061 },
1062 "404" : {
1063 "$ref" : "#/components/responses/Default404Response"
1064 },
1065 "405" : {
1066 "$ref" : "#/components/responses/Default405Response"
1067 },
1068 "406" : {
1069 "$ref" : "#/components/responses/Default406Response"
1070 },
1071 "415" : {
1072 "$ref" : "#/components/responses/Default415Response"
1073 },
1074 "429" : {
1075 "$ref" : "#/components/responses/Default429Response"
1076 },
1077 "500" : {
1078 "$ref" : "#/components/responses/Default500Response"
1079 },
1080 "503" : {
1081 "$ref" : "#/components/responses/Default503Response"
1082 }
1083 },
1084 "security" : [ {
1085 "Client_Credentials" : [ ]
1086 }, {
1087 "Authorization_Code_PKCE" : [ ]
1088 } ],
1089 "summary" : "Get single album.",
1090 "tags" : [ "albums" ],
1091 "x-path-item-properties" : {
1092 "required-access-tier" : "THIRD_PARTY"
1093 }
1094 },
1095 "patch" : {
1096 "description" : "Updates existing album.",
1097 "parameters" : [ {
1098 "description" : "Album id",
1099 "example" : "251380836",
1100 "in" : "path",
1101 "name" : "id",
1102 "required" : true,
1103 "schema" : {
1104 "type" : "string"
1105 }
1106 }, {
1107 "$ref" : "#/components/parameters/IdempotencyKey"
1108 } ],
1109 "requestBody" : {
1110 "content" : {
1111 "application/vnd.api+json" : {
1112 "schema" : {
1113 "$ref" : "#/components/schemas/AlbumsUpdateOperation_Payload"
1114 }
1115 }
1116 }
1117 },
1118 "responses" : {
1119 "400" : {
1120 "$ref" : "#/components/responses/Default400Response"
1121 },
1122 "404" : {
1123 "$ref" : "#/components/responses/Default404Response"
1124 },
1125 "405" : {
1126 "$ref" : "#/components/responses/Default405Response"
1127 },
1128 "406" : {
1129 "$ref" : "#/components/responses/Default406Response"
1130 },
1131 "409" : {
1132 "$ref" : "#/components/responses/Idempotency409Response"
1133 },
1134 "415" : {
1135 "$ref" : "#/components/responses/Default415Response"
1136 },
1137 "422" : {
1138 "$ref" : "#/components/responses/Idempotency422Response"
1139 },
1140 "429" : {
1141 "$ref" : "#/components/responses/Default429Response"
1142 },
1143 "500" : {
1144 "$ref" : "#/components/responses/Default500Response"
1145 },
1146 "503" : {
1147 "$ref" : "#/components/responses/Default503Response"
1148 }
1149 },
1150 "security" : [ {
1151 "Authorization_Code_PKCE" : [ "w_usr" ]
1152 } ],
1153 "summary" : "Update single album.",
1154 "tags" : [ "albums" ],
1155 "x-path-item-properties" : {
1156 "required-access-tier" : "INTERNAL"
1157 }
1158 }
1159 },
1160 "/albums/{id}/relationships/albumStatistics" : {
1161 "get" : {
1162 "description" : "Retrieves albumStatistics relationship.",
1163 "parameters" : [ {
1164 "description" : "Album id",
1165 "example" : "251380836",
1166 "in" : "path",
1167 "name" : "id",
1168 "required" : true,
1169 "schema" : {
1170 "type" : "string"
1171 }
1172 }, {
1173 "description" : "Allows the client to customize which related resources should be returned. Available options: albumStatistics",
1174 "example" : "albumStatistics",
1175 "in" : "query",
1176 "name" : "include",
1177 "required" : false,
1178 "schema" : {
1179 "type" : "array",
1180 "items" : {
1181 "type" : "string",
1182 "example" : "albumStatistics"
1183 }
1184 }
1185 }, {
1186 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
1187 "in" : "query",
1188 "name" : "shareCode",
1189 "required" : false,
1190 "schema" : {
1191 "type" : "string",
1192 "example" : "xyz"
1193 }
1194 } ],
1195 "responses" : {
1196 "200" : {
1197 "content" : {
1198 "application/vnd.api+json" : {
1199 "schema" : {
1200 "$ref" : "#/components/schemas/Albums_Single_Relationship_Data_Document"
1201 }
1202 }
1203 },
1204 "description" : "Successful response"
1205 },
1206 "400" : {
1207 "$ref" : "#/components/responses/Default400Response"
1208 },
1209 "404" : {
1210 "$ref" : "#/components/responses/Default404Response"
1211 },
1212 "405" : {
1213 "$ref" : "#/components/responses/Default405Response"
1214 },
1215 "406" : {
1216 "$ref" : "#/components/responses/Default406Response"
1217 },
1218 "415" : {
1219 "$ref" : "#/components/responses/Default415Response"
1220 },
1221 "429" : {
1222 "$ref" : "#/components/responses/Default429Response"
1223 },
1224 "500" : {
1225 "$ref" : "#/components/responses/Default500Response"
1226 },
1227 "503" : {
1228 "$ref" : "#/components/responses/Default503Response"
1229 }
1230 },
1231 "security" : [ {
1232 "Authorization_Code_PKCE" : [ "r_usr" ]
1233 } ],
1234 "summary" : "Get albumStatistics relationship (\"to-one\").",
1235 "tags" : [ "albums" ],
1236 "x-path-item-properties" : {
1237 "required-access-tier" : "INTERNAL"
1238 }
1239 }
1240 },
1241 "/albums/{id}/relationships/artists" : {
1242 "get" : {
1243 "description" : "Retrieves artists relationship.",
1244 "parameters" : [ {
1245 "description" : "Album id",
1246 "example" : "251380836",
1247 "in" : "path",
1248 "name" : "id",
1249 "required" : true,
1250 "schema" : {
1251 "type" : "string"
1252 }
1253 }, {
1254 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
1255 "in" : "query",
1256 "name" : "page[cursor]",
1257 "required" : false,
1258 "schema" : {
1259 "type" : "string"
1260 }
1261 }, {
1262 "description" : "ISO 3166-1 alpha-2 country code",
1263 "example" : "US",
1264 "in" : "query",
1265 "name" : "countryCode",
1266 "required" : false,
1267 "schema" : {
1268 "type" : "string"
1269 }
1270 }, {
1271 "description" : "Allows the client to customize which related resources should be returned. Available options: artists",
1272 "example" : "artists.albums",
1273 "in" : "query",
1274 "name" : "include",
1275 "required" : false,
1276 "schema" : {
1277 "type" : "array",
1278 "items" : {
1279 "type" : "string",
1280 "example" : "artists.albums"
1281 }
1282 }
1283 }, {
1284 "description" : "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",
1285 "example" : "artists.albums",
1286 "in" : "query",
1287 "name" : "replaceMedia",
1288 "required" : false,
1289 "schema" : {
1290 "type" : "string",
1291 "example" : "artists.albums"
1292 }
1293 }, {
1294 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
1295 "in" : "query",
1296 "name" : "shareCode",
1297 "required" : false,
1298 "schema" : {
1299 "type" : "string",
1300 "example" : "xyz"
1301 }
1302 } ],
1303 "responses" : {
1304 "200" : {
1305 "content" : {
1306 "application/vnd.api+json" : {
1307 "schema" : {
1308 "$ref" : "#/components/schemas/Albums_Multi_Relationship_Data_Document"
1309 }
1310 }
1311 },
1312 "description" : "Successful response"
1313 },
1314 "400" : {
1315 "$ref" : "#/components/responses/Default400Response"
1316 },
1317 "404" : {
1318 "$ref" : "#/components/responses/Default404Response"
1319 },
1320 "405" : {
1321 "$ref" : "#/components/responses/Default405Response"
1322 },
1323 "406" : {
1324 "$ref" : "#/components/responses/Default406Response"
1325 },
1326 "415" : {
1327 "$ref" : "#/components/responses/Default415Response"
1328 },
1329 "429" : {
1330 "$ref" : "#/components/responses/Default429Response"
1331 },
1332 "500" : {
1333 "$ref" : "#/components/responses/Default500Response"
1334 },
1335 "503" : {
1336 "$ref" : "#/components/responses/Default503Response"
1337 }
1338 },
1339 "security" : [ {
1340 "Client_Credentials" : [ ]
1341 }, {
1342 "Authorization_Code_PKCE" : [ ]
1343 } ],
1344 "summary" : "Get artists relationship (\"to-many\").",
1345 "tags" : [ "albums" ],
1346 "x-path-item-properties" : {
1347 "required-access-tier" : "THIRD_PARTY"
1348 }
1349 }
1350 },
1351 "/albums/{id}/relationships/coverArt" : {
1352 "get" : {
1353 "description" : "Retrieves coverArt relationship.",
1354 "parameters" : [ {
1355 "description" : "Album id",
1356 "example" : "251380836",
1357 "in" : "path",
1358 "name" : "id",
1359 "required" : true,
1360 "schema" : {
1361 "type" : "string"
1362 }
1363 }, {
1364 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
1365 "in" : "query",
1366 "name" : "page[cursor]",
1367 "required" : false,
1368 "schema" : {
1369 "type" : "string"
1370 }
1371 }, {
1372 "description" : "ISO 3166-1 alpha-2 country code",
1373 "example" : "US",
1374 "in" : "query",
1375 "name" : "countryCode",
1376 "required" : false,
1377 "schema" : {
1378 "type" : "string"
1379 }
1380 }, {
1381 "description" : "Allows the client to customize which related resources should be returned. Available options: coverArt",
1382 "example" : "coverArt",
1383 "in" : "query",
1384 "name" : "include",
1385 "required" : false,
1386 "schema" : {
1387 "type" : "array",
1388 "items" : {
1389 "type" : "string",
1390 "example" : "coverArt"
1391 }
1392 }
1393 }, {
1394 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
1395 "in" : "query",
1396 "name" : "shareCode",
1397 "required" : false,
1398 "schema" : {
1399 "type" : "string",
1400 "example" : "xyz"
1401 }
1402 } ],
1403 "responses" : {
1404 "200" : {
1405 "content" : {
1406 "application/vnd.api+json" : {
1407 "schema" : {
1408 "$ref" : "#/components/schemas/Albums_Multi_Relationship_Data_Document"
1409 }
1410 }
1411 },
1412 "description" : "Successful response"
1413 },
1414 "400" : {
1415 "$ref" : "#/components/responses/Default400Response"
1416 },
1417 "404" : {
1418 "$ref" : "#/components/responses/Default404Response"
1419 },
1420 "405" : {
1421 "$ref" : "#/components/responses/Default405Response"
1422 },
1423 "406" : {
1424 "$ref" : "#/components/responses/Default406Response"
1425 },
1426 "415" : {
1427 "$ref" : "#/components/responses/Default415Response"
1428 },
1429 "429" : {
1430 "$ref" : "#/components/responses/Default429Response"
1431 },
1432 "500" : {
1433 "$ref" : "#/components/responses/Default500Response"
1434 },
1435 "503" : {
1436 "$ref" : "#/components/responses/Default503Response"
1437 }
1438 },
1439 "security" : [ {
1440 "Client_Credentials" : [ ]
1441 }, {
1442 "Authorization_Code_PKCE" : [ ]
1443 } ],
1444 "summary" : "Get coverArt relationship (\"to-many\").",
1445 "tags" : [ "albums" ],
1446 "x-path-item-properties" : {
1447 "required-access-tier" : "THIRD_PARTY"
1448 }
1449 },
1450 "patch" : {
1451 "description" : "Updates coverArt relationship.",
1452 "parameters" : [ {
1453 "description" : "Album id",
1454 "example" : "251380836",
1455 "in" : "path",
1456 "name" : "id",
1457 "required" : true,
1458 "schema" : {
1459 "type" : "string"
1460 }
1461 }, {
1462 "$ref" : "#/components/parameters/IdempotencyKey"
1463 } ],
1464 "requestBody" : {
1465 "content" : {
1466 "application/vnd.api+json" : {
1467 "schema" : {
1468 "$ref" : "#/components/schemas/AlbumsCoverArtRelationshipUpdateOperation_Payload"
1469 }
1470 }
1471 }
1472 },
1473 "responses" : {
1474 "400" : {
1475 "$ref" : "#/components/responses/Default400Response"
1476 },
1477 "404" : {
1478 "$ref" : "#/components/responses/Default404Response"
1479 },
1480 "405" : {
1481 "$ref" : "#/components/responses/Default405Response"
1482 },
1483 "406" : {
1484 "$ref" : "#/components/responses/Default406Response"
1485 },
1486 "409" : {
1487 "$ref" : "#/components/responses/Idempotency409Response"
1488 },
1489 "415" : {
1490 "$ref" : "#/components/responses/Default415Response"
1491 },
1492 "422" : {
1493 "$ref" : "#/components/responses/Idempotency422Response"
1494 },
1495 "429" : {
1496 "$ref" : "#/components/responses/Default429Response"
1497 },
1498 "500" : {
1499 "$ref" : "#/components/responses/Default500Response"
1500 },
1501 "503" : {
1502 "$ref" : "#/components/responses/Default503Response"
1503 }
1504 },
1505 "security" : [ {
1506 "Authorization_Code_PKCE" : [ "w_usr" ]
1507 } ],
1508 "summary" : "Update coverArt relationship (\"to-many\").",
1509 "tags" : [ "albums" ],
1510 "x-path-item-properties" : {
1511 "required-access-tier" : "INTERNAL"
1512 }
1513 }
1514 },
1515 "/albums/{id}/relationships/genres" : {
1516 "get" : {
1517 "description" : "Retrieves genres relationship.",
1518 "parameters" : [ {
1519 "description" : "Album id",
1520 "example" : "251380836",
1521 "in" : "path",
1522 "name" : "id",
1523 "required" : true,
1524 "schema" : {
1525 "type" : "string"
1526 }
1527 }, {
1528 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
1529 "in" : "query",
1530 "name" : "page[cursor]",
1531 "required" : false,
1532 "schema" : {
1533 "type" : "string"
1534 }
1535 }, {
1536 "description" : "ISO 3166-1 alpha-2 country code",
1537 "example" : "US",
1538 "in" : "query",
1539 "name" : "countryCode",
1540 "required" : false,
1541 "schema" : {
1542 "type" : "string"
1543 }
1544 }, {
1545 "description" : "Allows the client to customize which related resources should be returned. Available options: genres",
1546 "example" : "genres",
1547 "in" : "query",
1548 "name" : "include",
1549 "required" : false,
1550 "schema" : {
1551 "type" : "array",
1552 "items" : {
1553 "type" : "string",
1554 "example" : "genres"
1555 }
1556 }
1557 }, {
1558 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
1559 "in" : "query",
1560 "name" : "shareCode",
1561 "required" : false,
1562 "schema" : {
1563 "type" : "string",
1564 "example" : "xyz"
1565 }
1566 } ],
1567 "responses" : {
1568 "200" : {
1569 "content" : {
1570 "application/vnd.api+json" : {
1571 "schema" : {
1572 "$ref" : "#/components/schemas/Albums_Multi_Relationship_Data_Document"
1573 }
1574 }
1575 },
1576 "description" : "Successful response"
1577 },
1578 "400" : {
1579 "$ref" : "#/components/responses/Default400Response"
1580 },
1581 "404" : {
1582 "$ref" : "#/components/responses/Default404Response"
1583 },
1584 "405" : {
1585 "$ref" : "#/components/responses/Default405Response"
1586 },
1587 "406" : {
1588 "$ref" : "#/components/responses/Default406Response"
1589 },
1590 "415" : {
1591 "$ref" : "#/components/responses/Default415Response"
1592 },
1593 "429" : {
1594 "$ref" : "#/components/responses/Default429Response"
1595 },
1596 "500" : {
1597 "$ref" : "#/components/responses/Default500Response"
1598 },
1599 "503" : {
1600 "$ref" : "#/components/responses/Default503Response"
1601 }
1602 },
1603 "security" : [ {
1604 "Client_Credentials" : [ ]
1605 }, {
1606 "Authorization_Code_PKCE" : [ ]
1607 } ],
1608 "summary" : "Get genres relationship (\"to-many\").",
1609 "tags" : [ "albums" ],
1610 "x-path-item-properties" : {
1611 "required-access-tier" : "INTERNAL"
1612 }
1613 }
1614 },
1615 "/albums/{id}/relationships/items" : {
1616 "get" : {
1617 "description" : "Retrieves items relationship.",
1618 "parameters" : [ {
1619 "description" : "Album id",
1620 "example" : "251380836",
1621 "in" : "path",
1622 "name" : "id",
1623 "required" : true,
1624 "schema" : {
1625 "type" : "string"
1626 }
1627 }, {
1628 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
1629 "in" : "query",
1630 "name" : "page[cursor]",
1631 "required" : false,
1632 "schema" : {
1633 "type" : "string"
1634 }
1635 }, {
1636 "description" : "ISO 3166-1 alpha-2 country code",
1637 "example" : "US",
1638 "in" : "query",
1639 "name" : "countryCode",
1640 "required" : false,
1641 "schema" : {
1642 "type" : "string"
1643 }
1644 }, {
1645 "description" : "Allows the client to customize which related resources should be returned. Available options: items",
1646 "example" : "items",
1647 "in" : "query",
1648 "name" : "include",
1649 "required" : false,
1650 "schema" : {
1651 "type" : "array",
1652 "items" : {
1653 "type" : "string",
1654 "example" : "items"
1655 }
1656 }
1657 }, {
1658 "description" : "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",
1659 "example" : "items",
1660 "in" : "query",
1661 "name" : "replaceMedia",
1662 "required" : false,
1663 "schema" : {
1664 "type" : "string",
1665 "example" : "items"
1666 }
1667 }, {
1668 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
1669 "in" : "query",
1670 "name" : "shareCode",
1671 "required" : false,
1672 "schema" : {
1673 "type" : "string",
1674 "example" : "xyz"
1675 }
1676 } ],
1677 "responses" : {
1678 "200" : {
1679 "content" : {
1680 "application/vnd.api+json" : {
1681 "schema" : {
1682 "$ref" : "#/components/schemas/Albums_Items_Multi_Relationship_Data_Document"
1683 }
1684 }
1685 },
1686 "description" : "Successful response"
1687 },
1688 "400" : {
1689 "$ref" : "#/components/responses/Default400Response"
1690 },
1691 "404" : {
1692 "$ref" : "#/components/responses/Default404Response"
1693 },
1694 "405" : {
1695 "$ref" : "#/components/responses/Default405Response"
1696 },
1697 "406" : {
1698 "$ref" : "#/components/responses/Default406Response"
1699 },
1700 "415" : {
1701 "$ref" : "#/components/responses/Default415Response"
1702 },
1703 "429" : {
1704 "$ref" : "#/components/responses/Default429Response"
1705 },
1706 "500" : {
1707 "$ref" : "#/components/responses/Default500Response"
1708 },
1709 "503" : {
1710 "$ref" : "#/components/responses/Default503Response"
1711 }
1712 },
1713 "security" : [ {
1714 "Client_Credentials" : [ ]
1715 }, {
1716 "Authorization_Code_PKCE" : [ ]
1717 } ],
1718 "summary" : "Get items relationship (\"to-many\").",
1719 "tags" : [ "albums" ],
1720 "x-path-item-properties" : {
1721 "required-access-tier" : "THIRD_PARTY"
1722 }
1723 },
1724 "patch" : {
1725 "description" : "Updates items relationship.",
1726 "parameters" : [ {
1727 "description" : "Album id",
1728 "example" : "251380836",
1729 "in" : "path",
1730 "name" : "id",
1731 "required" : true,
1732 "schema" : {
1733 "type" : "string"
1734 }
1735 }, {
1736 "$ref" : "#/components/parameters/IdempotencyKey"
1737 } ],
1738 "requestBody" : {
1739 "content" : {
1740 "application/vnd.api+json" : {
1741 "schema" : {
1742 "$ref" : "#/components/schemas/AlbumsItemsRelationshipUpdateOperation_Payload"
1743 }
1744 }
1745 }
1746 },
1747 "responses" : {
1748 "400" : {
1749 "$ref" : "#/components/responses/Default400Response"
1750 },
1751 "404" : {
1752 "$ref" : "#/components/responses/Default404Response"
1753 },
1754 "405" : {
1755 "$ref" : "#/components/responses/Default405Response"
1756 },
1757 "406" : {
1758 "$ref" : "#/components/responses/Default406Response"
1759 },
1760 "409" : {
1761 "$ref" : "#/components/responses/Idempotency409Response"
1762 },
1763 "415" : {
1764 "$ref" : "#/components/responses/Default415Response"
1765 },
1766 "422" : {
1767 "$ref" : "#/components/responses/Idempotency422Response"
1768 },
1769 "429" : {
1770 "$ref" : "#/components/responses/Default429Response"
1771 },
1772 "500" : {
1773 "$ref" : "#/components/responses/Default500Response"
1774 },
1775 "503" : {
1776 "$ref" : "#/components/responses/Default503Response"
1777 }
1778 },
1779 "security" : [ {
1780 "Authorization_Code_PKCE" : [ "w_usr" ]
1781 } ],
1782 "summary" : "Update items relationship (\"to-many\").",
1783 "tags" : [ "albums" ],
1784 "x-path-item-properties" : {
1785 "required-access-tier" : "INTERNAL"
1786 }
1787 }
1788 },
1789 "/albums/{id}/relationships/owners" : {
1790 "get" : {
1791 "description" : "Retrieves owners relationship.",
1792 "parameters" : [ {
1793 "description" : "Album id",
1794 "example" : "251380836",
1795 "in" : "path",
1796 "name" : "id",
1797 "required" : true,
1798 "schema" : {
1799 "type" : "string"
1800 }
1801 }, {
1802 "description" : "ISO 3166-1 alpha-2 country code",
1803 "example" : "US",
1804 "in" : "query",
1805 "name" : "countryCode",
1806 "required" : false,
1807 "schema" : {
1808 "type" : "string"
1809 }
1810 }, {
1811 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
1812 "example" : "owners",
1813 "in" : "query",
1814 "name" : "include",
1815 "required" : false,
1816 "schema" : {
1817 "type" : "array",
1818 "items" : {
1819 "type" : "string",
1820 "example" : "owners"
1821 }
1822 }
1823 }, {
1824 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
1825 "in" : "query",
1826 "name" : "page[cursor]",
1827 "required" : false,
1828 "schema" : {
1829 "type" : "string"
1830 }
1831 }, {
1832 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
1833 "in" : "query",
1834 "name" : "shareCode",
1835 "required" : false,
1836 "schema" : {
1837 "type" : "string",
1838 "example" : "xyz"
1839 }
1840 } ],
1841 "responses" : {
1842 "200" : {
1843 "content" : {
1844 "application/vnd.api+json" : {
1845 "schema" : {
1846 "$ref" : "#/components/schemas/Albums_Multi_Relationship_Data_Document"
1847 }
1848 }
1849 },
1850 "description" : "Successful response"
1851 },
1852 "400" : {
1853 "$ref" : "#/components/responses/Default400Response"
1854 },
1855 "404" : {
1856 "$ref" : "#/components/responses/Default404Response"
1857 },
1858 "405" : {
1859 "$ref" : "#/components/responses/Default405Response"
1860 },
1861 "406" : {
1862 "$ref" : "#/components/responses/Default406Response"
1863 },
1864 "415" : {
1865 "$ref" : "#/components/responses/Default415Response"
1866 },
1867 "429" : {
1868 "$ref" : "#/components/responses/Default429Response"
1869 },
1870 "500" : {
1871 "$ref" : "#/components/responses/Default500Response"
1872 },
1873 "503" : {
1874 "$ref" : "#/components/responses/Default503Response"
1875 }
1876 },
1877 "security" : [ {
1878 "Client_Credentials" : [ ]
1879 }, {
1880 "Authorization_Code_PKCE" : [ ]
1881 } ],
1882 "summary" : "Get owners relationship (\"to-many\").",
1883 "tags" : [ "albums" ],
1884 "x-path-item-properties" : {
1885 "required-access-tier" : "THIRD_PARTY"
1886 }
1887 }
1888 },
1889 "/albums/{id}/relationships/priceConfig" : {
1890 "get" : {
1891 "description" : "Retrieves priceConfig relationship.",
1892 "parameters" : [ {
1893 "description" : "Album id",
1894 "example" : "251380836",
1895 "in" : "path",
1896 "name" : "id",
1897 "required" : true,
1898 "schema" : {
1899 "type" : "string"
1900 }
1901 }, {
1902 "description" : "ISO 3166-1 alpha-2 country code",
1903 "example" : "US",
1904 "in" : "query",
1905 "name" : "countryCode",
1906 "required" : false,
1907 "schema" : {
1908 "type" : "string"
1909 }
1910 }, {
1911 "description" : "Allows the client to customize which related resources should be returned. Available options: priceConfig",
1912 "example" : "priceConfig",
1913 "in" : "query",
1914 "name" : "include",
1915 "required" : false,
1916 "schema" : {
1917 "type" : "array",
1918 "items" : {
1919 "type" : "string",
1920 "example" : "priceConfig"
1921 }
1922 }
1923 }, {
1924 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
1925 "in" : "query",
1926 "name" : "shareCode",
1927 "required" : false,
1928 "schema" : {
1929 "type" : "string",
1930 "example" : "xyz"
1931 }
1932 } ],
1933 "responses" : {
1934 "200" : {
1935 "content" : {
1936 "application/vnd.api+json" : {
1937 "schema" : {
1938 "$ref" : "#/components/schemas/Albums_Single_Relationship_Data_Document"
1939 }
1940 }
1941 },
1942 "description" : "Successful response"
1943 },
1944 "400" : {
1945 "$ref" : "#/components/responses/Default400Response"
1946 },
1947 "404" : {
1948 "$ref" : "#/components/responses/Default404Response"
1949 },
1950 "405" : {
1951 "$ref" : "#/components/responses/Default405Response"
1952 },
1953 "406" : {
1954 "$ref" : "#/components/responses/Default406Response"
1955 },
1956 "415" : {
1957 "$ref" : "#/components/responses/Default415Response"
1958 },
1959 "429" : {
1960 "$ref" : "#/components/responses/Default429Response"
1961 },
1962 "500" : {
1963 "$ref" : "#/components/responses/Default500Response"
1964 },
1965 "503" : {
1966 "$ref" : "#/components/responses/Default503Response"
1967 }
1968 },
1969 "security" : [ {
1970 "Client_Credentials" : [ ]
1971 }, {
1972 "Authorization_Code_PKCE" : [ ]
1973 } ],
1974 "summary" : "Get priceConfig relationship (\"to-one\").",
1975 "tags" : [ "albums" ],
1976 "x-path-item-properties" : {
1977 "required-access-tier" : "INTERNAL"
1978 }
1979 }
1980 },
1981 "/albums/{id}/relationships/providers" : {
1982 "get" : {
1983 "description" : "Retrieves providers relationship.",
1984 "parameters" : [ {
1985 "description" : "Album id",
1986 "example" : "251380836",
1987 "in" : "path",
1988 "name" : "id",
1989 "required" : true,
1990 "schema" : {
1991 "type" : "string"
1992 }
1993 }, {
1994 "description" : "ISO 3166-1 alpha-2 country code",
1995 "example" : "US",
1996 "in" : "query",
1997 "name" : "countryCode",
1998 "required" : false,
1999 "schema" : {
2000 "type" : "string"
2001 }
2002 }, {
2003 "description" : "Allows the client to customize which related resources should be returned. Available options: providers",
2004 "example" : "providers",
2005 "in" : "query",
2006 "name" : "include",
2007 "required" : false,
2008 "schema" : {
2009 "type" : "array",
2010 "items" : {
2011 "type" : "string",
2012 "example" : "providers"
2013 }
2014 }
2015 }, {
2016 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
2017 "in" : "query",
2018 "name" : "page[cursor]",
2019 "required" : false,
2020 "schema" : {
2021 "type" : "string"
2022 }
2023 }, {
2024 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
2025 "in" : "query",
2026 "name" : "shareCode",
2027 "required" : false,
2028 "schema" : {
2029 "type" : "string",
2030 "example" : "xyz"
2031 }
2032 } ],
2033 "responses" : {
2034 "200" : {
2035 "content" : {
2036 "application/vnd.api+json" : {
2037 "schema" : {
2038 "$ref" : "#/components/schemas/Albums_Multi_Relationship_Data_Document"
2039 }
2040 }
2041 },
2042 "description" : "Successful response"
2043 },
2044 "400" : {
2045 "$ref" : "#/components/responses/Default400Response"
2046 },
2047 "404" : {
2048 "$ref" : "#/components/responses/Default404Response"
2049 },
2050 "405" : {
2051 "$ref" : "#/components/responses/Default405Response"
2052 },
2053 "406" : {
2054 "$ref" : "#/components/responses/Default406Response"
2055 },
2056 "415" : {
2057 "$ref" : "#/components/responses/Default415Response"
2058 },
2059 "429" : {
2060 "$ref" : "#/components/responses/Default429Response"
2061 },
2062 "500" : {
2063 "$ref" : "#/components/responses/Default500Response"
2064 },
2065 "503" : {
2066 "$ref" : "#/components/responses/Default503Response"
2067 }
2068 },
2069 "security" : [ {
2070 "Client_Credentials" : [ ]
2071 }, {
2072 "Authorization_Code_PKCE" : [ ]
2073 } ],
2074 "summary" : "Get providers relationship (\"to-many\").",
2075 "tags" : [ "albums" ],
2076 "x-path-item-properties" : {
2077 "required-access-tier" : "THIRD_PARTY"
2078 }
2079 }
2080 },
2081 "/albums/{id}/relationships/replacement" : {
2082 "get" : {
2083 "description" : "Retrieves replacement relationship.",
2084 "parameters" : [ {
2085 "description" : "Album id",
2086 "example" : "251380836",
2087 "in" : "path",
2088 "name" : "id",
2089 "required" : true,
2090 "schema" : {
2091 "type" : "string"
2092 }
2093 }, {
2094 "description" : "ISO 3166-1 alpha-2 country code",
2095 "example" : "US",
2096 "in" : "query",
2097 "name" : "countryCode",
2098 "required" : false,
2099 "schema" : {
2100 "type" : "string"
2101 }
2102 }, {
2103 "description" : "Allows the client to customize which related resources should be returned. Available options: replacement",
2104 "example" : "replacement",
2105 "in" : "query",
2106 "name" : "include",
2107 "required" : false,
2108 "schema" : {
2109 "type" : "array",
2110 "items" : {
2111 "type" : "string",
2112 "example" : "replacement"
2113 }
2114 }
2115 }, {
2116 "description" : "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",
2117 "example" : "replacement",
2118 "in" : "query",
2119 "name" : "replaceMedia",
2120 "required" : false,
2121 "schema" : {
2122 "type" : "string",
2123 "example" : "replacement"
2124 }
2125 }, {
2126 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
2127 "in" : "query",
2128 "name" : "shareCode",
2129 "required" : false,
2130 "schema" : {
2131 "type" : "string",
2132 "example" : "xyz"
2133 }
2134 } ],
2135 "responses" : {
2136 "200" : {
2137 "content" : {
2138 "application/vnd.api+json" : {
2139 "schema" : {
2140 "$ref" : "#/components/schemas/Albums_Single_Relationship_Data_Document"
2141 }
2142 }
2143 },
2144 "description" : "Successful response"
2145 },
2146 "400" : {
2147 "$ref" : "#/components/responses/Default400Response"
2148 },
2149 "404" : {
2150 "$ref" : "#/components/responses/Default404Response"
2151 },
2152 "405" : {
2153 "$ref" : "#/components/responses/Default405Response"
2154 },
2155 "406" : {
2156 "$ref" : "#/components/responses/Default406Response"
2157 },
2158 "415" : {
2159 "$ref" : "#/components/responses/Default415Response"
2160 },
2161 "429" : {
2162 "$ref" : "#/components/responses/Default429Response"
2163 },
2164 "500" : {
2165 "$ref" : "#/components/responses/Default500Response"
2166 },
2167 "503" : {
2168 "$ref" : "#/components/responses/Default503Response"
2169 }
2170 },
2171 "security" : [ {
2172 "Client_Credentials" : [ ]
2173 }, {
2174 "Authorization_Code_PKCE" : [ ]
2175 } ],
2176 "summary" : "Get replacement relationship (\"to-one\").",
2177 "tags" : [ "albums" ],
2178 "x-path-item-properties" : {
2179 "required-access-tier" : "INTERNAL"
2180 }
2181 }
2182 },
2183 "/albums/{id}/relationships/shares" : {
2184 "get" : {
2185 "description" : "Retrieves shares relationship.",
2186 "parameters" : [ {
2187 "description" : "Album id",
2188 "example" : "251380836",
2189 "in" : "path",
2190 "name" : "id",
2191 "required" : true,
2192 "schema" : {
2193 "type" : "string"
2194 }
2195 }, {
2196 "description" : "Allows the client to customize which related resources should be returned. Available options: shares",
2197 "example" : "shares.sharedResources",
2198 "in" : "query",
2199 "name" : "include",
2200 "required" : false,
2201 "schema" : {
2202 "type" : "array",
2203 "items" : {
2204 "type" : "string",
2205 "example" : "shares.sharedResources"
2206 }
2207 }
2208 }, {
2209 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
2210 "in" : "query",
2211 "name" : "page[cursor]",
2212 "required" : false,
2213 "schema" : {
2214 "type" : "string"
2215 }
2216 }, {
2217 "description" : "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",
2218 "example" : "shares.sharedResources",
2219 "in" : "query",
2220 "name" : "replaceMedia",
2221 "required" : false,
2222 "schema" : {
2223 "type" : "string",
2224 "example" : "shares.sharedResources"
2225 }
2226 }, {
2227 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
2228 "in" : "query",
2229 "name" : "shareCode",
2230 "required" : false,
2231 "schema" : {
2232 "type" : "string",
2233 "example" : "xyz"
2234 }
2235 } ],
2236 "responses" : {
2237 "200" : {
2238 "content" : {
2239 "application/vnd.api+json" : {
2240 "schema" : {
2241 "$ref" : "#/components/schemas/Albums_Multi_Relationship_Data_Document"
2242 }
2243 }
2244 },
2245 "description" : "Successful response"
2246 },
2247 "400" : {
2248 "$ref" : "#/components/responses/Default400Response"
2249 },
2250 "404" : {
2251 "$ref" : "#/components/responses/Default404Response"
2252 },
2253 "405" : {
2254 "$ref" : "#/components/responses/Default405Response"
2255 },
2256 "406" : {
2257 "$ref" : "#/components/responses/Default406Response"
2258 },
2259 "415" : {
2260 "$ref" : "#/components/responses/Default415Response"
2261 },
2262 "429" : {
2263 "$ref" : "#/components/responses/Default429Response"
2264 },
2265 "500" : {
2266 "$ref" : "#/components/responses/Default500Response"
2267 },
2268 "503" : {
2269 "$ref" : "#/components/responses/Default503Response"
2270 }
2271 },
2272 "security" : [ {
2273 "Authorization_Code_PKCE" : [ "r_usr" ]
2274 } ],
2275 "summary" : "Get shares relationship (\"to-many\").",
2276 "tags" : [ "albums" ],
2277 "x-path-item-properties" : {
2278 "required-access-tier" : "INTERNAL"
2279 }
2280 }
2281 },
2282 "/albums/{id}/relationships/similarAlbums" : {
2283 "get" : {
2284 "description" : "Retrieves similarAlbums relationship.",
2285 "parameters" : [ {
2286 "description" : "Album id",
2287 "example" : "251380836",
2288 "in" : "path",
2289 "name" : "id",
2290 "required" : true,
2291 "schema" : {
2292 "type" : "string"
2293 }
2294 }, {
2295 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
2296 "in" : "query",
2297 "name" : "page[cursor]",
2298 "required" : false,
2299 "schema" : {
2300 "type" : "string"
2301 }
2302 }, {
2303 "description" : "ISO 3166-1 alpha-2 country code",
2304 "example" : "US",
2305 "in" : "query",
2306 "name" : "countryCode",
2307 "required" : false,
2308 "schema" : {
2309 "type" : "string"
2310 }
2311 }, {
2312 "description" : "Allows the client to customize which related resources should be returned. Available options: similarAlbums",
2313 "example" : "similarAlbums",
2314 "in" : "query",
2315 "name" : "include",
2316 "required" : false,
2317 "schema" : {
2318 "type" : "array",
2319 "items" : {
2320 "type" : "string",
2321 "example" : "similarAlbums"
2322 }
2323 }
2324 }, {
2325 "description" : "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",
2326 "example" : "similarAlbums",
2327 "in" : "query",
2328 "name" : "replaceMedia",
2329 "required" : false,
2330 "schema" : {
2331 "type" : "string",
2332 "example" : "similarAlbums"
2333 }
2334 }, {
2335 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
2336 "in" : "query",
2337 "name" : "shareCode",
2338 "required" : false,
2339 "schema" : {
2340 "type" : "string",
2341 "example" : "xyz"
2342 }
2343 } ],
2344 "responses" : {
2345 "200" : {
2346 "content" : {
2347 "application/vnd.api+json" : {
2348 "schema" : {
2349 "$ref" : "#/components/schemas/Albums_Multi_Relationship_Data_Document"
2350 }
2351 }
2352 },
2353 "description" : "Successful response"
2354 },
2355 "400" : {
2356 "$ref" : "#/components/responses/Default400Response"
2357 },
2358 "404" : {
2359 "$ref" : "#/components/responses/Default404Response"
2360 },
2361 "405" : {
2362 "$ref" : "#/components/responses/Default405Response"
2363 },
2364 "406" : {
2365 "$ref" : "#/components/responses/Default406Response"
2366 },
2367 "415" : {
2368 "$ref" : "#/components/responses/Default415Response"
2369 },
2370 "429" : {
2371 "$ref" : "#/components/responses/Default429Response"
2372 },
2373 "500" : {
2374 "$ref" : "#/components/responses/Default500Response"
2375 },
2376 "503" : {
2377 "$ref" : "#/components/responses/Default503Response"
2378 }
2379 },
2380 "security" : [ {
2381 "Client_Credentials" : [ ]
2382 }, {
2383 "Authorization_Code_PKCE" : [ ]
2384 } ],
2385 "summary" : "Get similarAlbums relationship (\"to-many\").",
2386 "tags" : [ "albums" ],
2387 "x-path-item-properties" : {
2388 "required-access-tier" : "THIRD_PARTY"
2389 }
2390 }
2391 },
2392 "/albums/{id}/relationships/suggestedCoverArts" : {
2393 "get" : {
2394 "description" : "Retrieves suggestedCoverArts relationship.",
2395 "parameters" : [ {
2396 "description" : "Album id",
2397 "example" : "251380836",
2398 "in" : "path",
2399 "name" : "id",
2400 "required" : true,
2401 "schema" : {
2402 "type" : "string"
2403 }
2404 }, {
2405 "description" : "Allows the client to customize which related resources should be returned. Available options: suggestedCoverArts",
2406 "example" : "suggestedCoverArts",
2407 "in" : "query",
2408 "name" : "include",
2409 "required" : false,
2410 "schema" : {
2411 "type" : "array",
2412 "items" : {
2413 "type" : "string",
2414 "example" : "suggestedCoverArts"
2415 }
2416 }
2417 }, {
2418 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
2419 "in" : "query",
2420 "name" : "page[cursor]",
2421 "required" : false,
2422 "schema" : {
2423 "type" : "string"
2424 }
2425 }, {
2426 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
2427 "in" : "query",
2428 "name" : "shareCode",
2429 "required" : false,
2430 "schema" : {
2431 "type" : "string",
2432 "example" : "xyz"
2433 }
2434 } ],
2435 "responses" : {
2436 "200" : {
2437 "content" : {
2438 "application/vnd.api+json" : {
2439 "schema" : {
2440 "$ref" : "#/components/schemas/Albums_SuggestedCoverArts_Multi_Relationship_Data_Document"
2441 }
2442 }
2443 },
2444 "description" : "Successful response"
2445 },
2446 "400" : {
2447 "$ref" : "#/components/responses/Default400Response"
2448 },
2449 "404" : {
2450 "$ref" : "#/components/responses/Default404Response"
2451 },
2452 "405" : {
2453 "$ref" : "#/components/responses/Default405Response"
2454 },
2455 "406" : {
2456 "$ref" : "#/components/responses/Default406Response"
2457 },
2458 "415" : {
2459 "$ref" : "#/components/responses/Default415Response"
2460 },
2461 "429" : {
2462 "$ref" : "#/components/responses/Default429Response"
2463 },
2464 "500" : {
2465 "$ref" : "#/components/responses/Default500Response"
2466 },
2467 "503" : {
2468 "$ref" : "#/components/responses/Default503Response"
2469 }
2470 },
2471 "security" : [ {
2472 "Authorization_Code_PKCE" : [ "r_usr" ]
2473 } ],
2474 "summary" : "Get suggestedCoverArts relationship (\"to-many\").",
2475 "tags" : [ "albums" ],
2476 "x-path-item-properties" : {
2477 "required-access-tier" : "INTERNAL"
2478 }
2479 }
2480 },
2481 "/albums/{id}/relationships/usageRules" : {
2482 "get" : {
2483 "description" : "Retrieves usageRules relationship.",
2484 "parameters" : [ {
2485 "description" : "Album id",
2486 "example" : "251380836",
2487 "in" : "path",
2488 "name" : "id",
2489 "required" : true,
2490 "schema" : {
2491 "type" : "string"
2492 }
2493 }, {
2494 "description" : "ISO 3166-1 alpha-2 country code",
2495 "example" : "US",
2496 "in" : "query",
2497 "name" : "countryCode",
2498 "required" : false,
2499 "schema" : {
2500 "type" : "string"
2501 }
2502 }, {
2503 "description" : "Allows the client to customize which related resources should be returned. Available options: usageRules",
2504 "example" : "usageRules",
2505 "in" : "query",
2506 "name" : "include",
2507 "required" : false,
2508 "schema" : {
2509 "type" : "array",
2510 "items" : {
2511 "type" : "string",
2512 "example" : "usageRules"
2513 }
2514 }
2515 }, {
2516 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
2517 "in" : "query",
2518 "name" : "shareCode",
2519 "required" : false,
2520 "schema" : {
2521 "type" : "string",
2522 "example" : "xyz"
2523 }
2524 } ],
2525 "responses" : {
2526 "200" : {
2527 "content" : {
2528 "application/vnd.api+json" : {
2529 "schema" : {
2530 "$ref" : "#/components/schemas/Albums_Single_Relationship_Data_Document"
2531 }
2532 }
2533 },
2534 "description" : "Successful response"
2535 },
2536 "400" : {
2537 "$ref" : "#/components/responses/Default400Response"
2538 },
2539 "404" : {
2540 "$ref" : "#/components/responses/Default404Response"
2541 },
2542 "405" : {
2543 "$ref" : "#/components/responses/Default405Response"
2544 },
2545 "406" : {
2546 "$ref" : "#/components/responses/Default406Response"
2547 },
2548 "415" : {
2549 "$ref" : "#/components/responses/Default415Response"
2550 },
2551 "429" : {
2552 "$ref" : "#/components/responses/Default429Response"
2553 },
2554 "500" : {
2555 "$ref" : "#/components/responses/Default500Response"
2556 },
2557 "503" : {
2558 "$ref" : "#/components/responses/Default503Response"
2559 }
2560 },
2561 "security" : [ {
2562 "Client_Credentials" : [ ]
2563 }, {
2564 "Authorization_Code_PKCE" : [ ]
2565 } ],
2566 "summary" : "Get usageRules relationship (\"to-one\").",
2567 "tags" : [ "albums" ],
2568 "x-path-item-properties" : {
2569 "required-access-tier" : "THIRD_PARTY"
2570 }
2571 }
2572 },
2573 "/appreciations" : {
2574 "post" : {
2575 "description" : "Creates a new appreciation.",
2576 "parameters" : [ {
2577 "$ref" : "#/components/parameters/IdempotencyKey"
2578 } ],
2579 "requestBody" : {
2580 "content" : {
2581 "application/vnd.api+json" : {
2582 "schema" : {
2583 "$ref" : "#/components/schemas/AppreciationsCreateOperation_Payload"
2584 }
2585 }
2586 }
2587 },
2588 "responses" : {
2589 "201" : {
2590 "content" : {
2591 "application/vnd.api+json" : {
2592 "schema" : {
2593 "$ref" : "#/components/schemas/Appreciations_Create_Single_Resource_Data_Document"
2594 }
2595 }
2596 },
2597 "description" : "Successful response"
2598 },
2599 "400" : {
2600 "$ref" : "#/components/responses/Default400Response"
2601 },
2602 "404" : {
2603 "$ref" : "#/components/responses/Default404Response"
2604 },
2605 "405" : {
2606 "$ref" : "#/components/responses/Default405Response"
2607 },
2608 "406" : {
2609 "$ref" : "#/components/responses/Default406Response"
2610 },
2611 "409" : {
2612 "$ref" : "#/components/responses/Idempotency409Response"
2613 },
2614 "415" : {
2615 "$ref" : "#/components/responses/Default415Response"
2616 },
2617 "422" : {
2618 "$ref" : "#/components/responses/Idempotency422Response"
2619 },
2620 "429" : {
2621 "$ref" : "#/components/responses/Default429Response"
2622 },
2623 "500" : {
2624 "$ref" : "#/components/responses/Default500Response"
2625 },
2626 "503" : {
2627 "$ref" : "#/components/responses/Default503Response"
2628 }
2629 },
2630 "security" : [ {
2631 "Authorization_Code_PKCE" : [ "w_usr" ]
2632 } ],
2633 "summary" : "Create single appreciation.",
2634 "tags" : [ "appreciations" ],
2635 "x-path-item-properties" : {
2636 "required-access-tier" : "INTERNAL"
2637 }
2638 }
2639 },
2640 "/artistBiographies/{id}" : {
2641 "get" : {
2642 "description" : "Retrieves single artistBiographie by id.",
2643 "parameters" : [ {
2644 "description" : "Artist biography id",
2645 "example" : "123456",
2646 "in" : "path",
2647 "name" : "id",
2648 "required" : true,
2649 "schema" : {
2650 "type" : "string"
2651 }
2652 }, {
2653 "description" : "ISO 3166-1 alpha-2 country code",
2654 "example" : "US",
2655 "in" : "query",
2656 "name" : "countryCode",
2657 "required" : false,
2658 "schema" : {
2659 "type" : "string"
2660 }
2661 }, {
2662 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
2663 "example" : "owners",
2664 "in" : "query",
2665 "name" : "include",
2666 "required" : false,
2667 "schema" : {
2668 "type" : "array",
2669 "items" : {
2670 "type" : "string",
2671 "example" : "owners"
2672 }
2673 }
2674 } ],
2675 "responses" : {
2676 "200" : {
2677 "content" : {
2678 "application/vnd.api+json" : {
2679 "schema" : {
2680 "$ref" : "#/components/schemas/ArtistBiographies_Single_Resource_Data_Document"
2681 }
2682 }
2683 },
2684 "description" : "Successful response"
2685 },
2686 "400" : {
2687 "$ref" : "#/components/responses/Default400Response"
2688 },
2689 "404" : {
2690 "$ref" : "#/components/responses/Default404Response"
2691 },
2692 "405" : {
2693 "$ref" : "#/components/responses/Default405Response"
2694 },
2695 "406" : {
2696 "$ref" : "#/components/responses/Default406Response"
2697 },
2698 "415" : {
2699 "$ref" : "#/components/responses/Default415Response"
2700 },
2701 "429" : {
2702 "$ref" : "#/components/responses/Default429Response"
2703 },
2704 "500" : {
2705 "$ref" : "#/components/responses/Default500Response"
2706 },
2707 "503" : {
2708 "$ref" : "#/components/responses/Default503Response"
2709 }
2710 },
2711 "security" : [ {
2712 "Client_Credentials" : [ ]
2713 }, {
2714 "Authorization_Code_PKCE" : [ ]
2715 } ],
2716 "summary" : "Get single artistBiographie.",
2717 "tags" : [ "artistBiographies" ],
2718 "x-path-item-properties" : {
2719 "required-access-tier" : "INTERNAL"
2720 }
2721 },
2722 "patch" : {
2723 "description" : "Updates existing artistBiographie.",
2724 "parameters" : [ {
2725 "description" : "Artist biography id",
2726 "example" : "123456",
2727 "in" : "path",
2728 "name" : "id",
2729 "required" : true,
2730 "schema" : {
2731 "type" : "string"
2732 }
2733 }, {
2734 "$ref" : "#/components/parameters/IdempotencyKey"
2735 } ],
2736 "requestBody" : {
2737 "content" : {
2738 "application/vnd.api+json" : {
2739 "schema" : {
2740 "$ref" : "#/components/schemas/ArtistBiographiesUpdateOperation_Payload"
2741 }
2742 }
2743 }
2744 },
2745 "responses" : {
2746 "400" : {
2747 "$ref" : "#/components/responses/Default400Response"
2748 },
2749 "404" : {
2750 "$ref" : "#/components/responses/Default404Response"
2751 },
2752 "405" : {
2753 "$ref" : "#/components/responses/Default405Response"
2754 },
2755 "406" : {
2756 "$ref" : "#/components/responses/Default406Response"
2757 },
2758 "409" : {
2759 "$ref" : "#/components/responses/Idempotency409Response"
2760 },
2761 "415" : {
2762 "$ref" : "#/components/responses/Default415Response"
2763 },
2764 "422" : {
2765 "$ref" : "#/components/responses/Idempotency422Response"
2766 },
2767 "429" : {
2768 "$ref" : "#/components/responses/Default429Response"
2769 },
2770 "500" : {
2771 "$ref" : "#/components/responses/Default500Response"
2772 },
2773 "503" : {
2774 "$ref" : "#/components/responses/Default503Response"
2775 }
2776 },
2777 "security" : [ {
2778 "Authorization_Code_PKCE" : [ "w_usr" ]
2779 } ],
2780 "summary" : "Update single artistBiographie.",
2781 "tags" : [ "artistBiographies" ],
2782 "x-path-item-properties" : {
2783 "required-access-tier" : "INTERNAL"
2784 }
2785 }
2786 },
2787 "/artistBiographies/{id}/relationships/owners" : {
2788 "get" : {
2789 "description" : "Retrieves owners relationship.",
2790 "parameters" : [ {
2791 "description" : "Artist biography id",
2792 "example" : "123456",
2793 "in" : "path",
2794 "name" : "id",
2795 "required" : true,
2796 "schema" : {
2797 "type" : "string"
2798 }
2799 }, {
2800 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
2801 "example" : "owners",
2802 "in" : "query",
2803 "name" : "include",
2804 "required" : false,
2805 "schema" : {
2806 "type" : "array",
2807 "items" : {
2808 "type" : "string",
2809 "example" : "owners"
2810 }
2811 }
2812 }, {
2813 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
2814 "in" : "query",
2815 "name" : "page[cursor]",
2816 "required" : false,
2817 "schema" : {
2818 "type" : "string"
2819 }
2820 } ],
2821 "responses" : {
2822 "200" : {
2823 "content" : {
2824 "application/vnd.api+json" : {
2825 "schema" : {
2826 "$ref" : "#/components/schemas/ArtistBiographies_Multi_Relationship_Data_Document"
2827 }
2828 }
2829 },
2830 "description" : "Successful response"
2831 },
2832 "400" : {
2833 "$ref" : "#/components/responses/Default400Response"
2834 },
2835 "404" : {
2836 "$ref" : "#/components/responses/Default404Response"
2837 },
2838 "405" : {
2839 "$ref" : "#/components/responses/Default405Response"
2840 },
2841 "406" : {
2842 "$ref" : "#/components/responses/Default406Response"
2843 },
2844 "415" : {
2845 "$ref" : "#/components/responses/Default415Response"
2846 },
2847 "429" : {
2848 "$ref" : "#/components/responses/Default429Response"
2849 },
2850 "500" : {
2851 "$ref" : "#/components/responses/Default500Response"
2852 },
2853 "503" : {
2854 "$ref" : "#/components/responses/Default503Response"
2855 }
2856 },
2857 "security" : [ {
2858 "Client_Credentials" : [ ]
2859 }, {
2860 "Authorization_Code_PKCE" : [ ]
2861 } ],
2862 "summary" : "Get owners relationship (\"to-many\").",
2863 "tags" : [ "artistBiographies" ],
2864 "x-path-item-properties" : {
2865 "required-access-tier" : "INTERNAL"
2866 }
2867 }
2868 },
2869 "/artistClaimStatuses" : {
2870 "get" : {
2871 "description" : "Retrieves multiple artistClaimStatuses by available filters, or without if applicable.",
2872 "parameters" : [ {
2873 "description" : "List of artist claim status IDs (e.g. `QVJUSVNUUzoxNTY2`)",
2874 "in" : "query",
2875 "name" : "filter[id]",
2876 "required" : true,
2877 "schema" : {
2878 "type" : "array",
2879 "items" : {
2880 "type" : "string"
2881 }
2882 }
2883 } ],
2884 "responses" : {
2885 "200" : {
2886 "content" : {
2887 "application/vnd.api+json" : {
2888 "schema" : {
2889 "$ref" : "#/components/schemas/ArtistClaimStatuses_Multi_Resource_Data_Document"
2890 }
2891 }
2892 },
2893 "description" : "Successful response"
2894 },
2895 "400" : {
2896 "$ref" : "#/components/responses/Default400Response"
2897 },
2898 "404" : {
2899 "$ref" : "#/components/responses/Default404Response"
2900 },
2901 "405" : {
2902 "$ref" : "#/components/responses/Default405Response"
2903 },
2904 "406" : {
2905 "$ref" : "#/components/responses/Default406Response"
2906 },
2907 "415" : {
2908 "$ref" : "#/components/responses/Default415Response"
2909 },
2910 "429" : {
2911 "$ref" : "#/components/responses/Default429Response"
2912 },
2913 "500" : {
2914 "$ref" : "#/components/responses/Default500Response"
2915 },
2916 "503" : {
2917 "$ref" : "#/components/responses/Default503Response"
2918 }
2919 },
2920 "security" : [ {
2921 "Authorization_Code_PKCE" : [ ]
2922 } ],
2923 "summary" : "Get multiple artistClaimStatuses.",
2924 "tags" : [ "artistClaimStatuses" ],
2925 "x-path-item-properties" : {
2926 "required-access-tier" : "INTERNAL"
2927 }
2928 }
2929 },
2930 "/artistClaims" : {
2931 "get" : {
2932 "description" : "Retrieves multiple artistClaims by available filters, or without if applicable.",
2933 "parameters" : [ {
2934 "description" : "User id. Use `me` for the authenticated user",
2935 "in" : "query",
2936 "name" : "filter[owners.id]",
2937 "required" : true,
2938 "schema" : {
2939 "type" : "array",
2940 "items" : {
2941 "type" : "string"
2942 }
2943 }
2944 }, {
2945 "description" : "Allows the client to customize which related resources should be returned. Available options: acceptedArtists, owners, recommendedArtists",
2946 "example" : "acceptedArtists.albums",
2947 "in" : "query",
2948 "name" : "include",
2949 "required" : false,
2950 "schema" : {
2951 "type" : "array",
2952 "items" : {
2953 "type" : "string",
2954 "example" : "acceptedArtists.albums"
2955 }
2956 }
2957 }, {
2958 "description" : "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",
2959 "example" : "acceptedArtists.albums",
2960 "in" : "query",
2961 "name" : "replaceMedia",
2962 "required" : false,
2963 "schema" : {
2964 "type" : "string",
2965 "example" : "acceptedArtists.albums"
2966 }
2967 } ],
2968 "responses" : {
2969 "200" : {
2970 "content" : {
2971 "application/vnd.api+json" : {
2972 "schema" : {
2973 "$ref" : "#/components/schemas/ArtistClaims_Multi_Resource_Data_Document"
2974 }
2975 }
2976 },
2977 "description" : "Successful response"
2978 },
2979 "400" : {
2980 "$ref" : "#/components/responses/Default400Response"
2981 },
2982 "404" : {
2983 "$ref" : "#/components/responses/Default404Response"
2984 },
2985 "405" : {
2986 "$ref" : "#/components/responses/Default405Response"
2987 },
2988 "406" : {
2989 "$ref" : "#/components/responses/Default406Response"
2990 },
2991 "415" : {
2992 "$ref" : "#/components/responses/Default415Response"
2993 },
2994 "429" : {
2995 "$ref" : "#/components/responses/Default429Response"
2996 },
2997 "500" : {
2998 "$ref" : "#/components/responses/Default500Response"
2999 },
3000 "503" : {
3001 "$ref" : "#/components/responses/Default503Response"
3002 }
3003 },
3004 "security" : [ {
3005 "Authorization_Code_PKCE" : [ "r_usr" ]
3006 } ],
3007 "summary" : "Get multiple artistClaims.",
3008 "tags" : [ "artistClaims" ],
3009 "x-path-item-properties" : {
3010 "required-access-tier" : "INTERNAL"
3011 }
3012 },
3013 "post" : {
3014 "description" : "Creates a new artistClaim.",
3015 "parameters" : [ {
3016 "description" : "ISO 3166-1 alpha-2 country code",
3017 "example" : "US",
3018 "in" : "query",
3019 "name" : "countryCode",
3020 "required" : false,
3021 "schema" : {
3022 "type" : "string"
3023 }
3024 }, {
3025 "$ref" : "#/components/parameters/IdempotencyKey"
3026 } ],
3027 "requestBody" : {
3028 "content" : {
3029 "application/vnd.api+json" : {
3030 "schema" : {
3031 "$ref" : "#/components/schemas/ArtistClaimsCreateOperation_Payload"
3032 }
3033 }
3034 }
3035 },
3036 "responses" : {
3037 "201" : {
3038 "content" : {
3039 "application/vnd.api+json" : {
3040 "schema" : {
3041 "$ref" : "#/components/schemas/ArtistClaims_Create_Single_Resource_Data_Document"
3042 }
3043 }
3044 },
3045 "description" : "Successful response"
3046 },
3047 "400" : {
3048 "$ref" : "#/components/responses/Default400Response"
3049 },
3050 "404" : {
3051 "$ref" : "#/components/responses/Default404Response"
3052 },
3053 "405" : {
3054 "$ref" : "#/components/responses/Default405Response"
3055 },
3056 "406" : {
3057 "$ref" : "#/components/responses/Default406Response"
3058 },
3059 "409" : {
3060 "$ref" : "#/components/responses/Idempotency409Response"
3061 },
3062 "415" : {
3063 "$ref" : "#/components/responses/Default415Response"
3064 },
3065 "422" : {
3066 "$ref" : "#/components/responses/Idempotency422Response"
3067 },
3068 "429" : {
3069 "$ref" : "#/components/responses/Default429Response"
3070 },
3071 "500" : {
3072 "$ref" : "#/components/responses/Default500Response"
3073 },
3074 "503" : {
3075 "$ref" : "#/components/responses/Default503Response"
3076 }
3077 },
3078 "security" : [ {
3079 "Authorization_Code_PKCE" : [ "w_usr" ]
3080 } ],
3081 "summary" : "Create single artistClaim.",
3082 "tags" : [ "artistClaims" ],
3083 "x-path-item-properties" : {
3084 "required-access-tier" : "INTERNAL"
3085 }
3086 }
3087 },
3088 "/artistClaims/{id}" : {
3089 "delete" : {
3090 "description" : "Deletes existing artistClaim.",
3091 "parameters" : [ {
3092 "description" : "Artist claim id",
3093 "example" : "f47ac10b-58cc-4372-a567-0e02b2c3d479",
3094 "in" : "path",
3095 "name" : "id",
3096 "required" : true,
3097 "schema" : {
3098 "type" : "string"
3099 }
3100 }, {
3101 "$ref" : "#/components/parameters/IdempotencyKey"
3102 } ],
3103 "responses" : {
3104 "400" : {
3105 "$ref" : "#/components/responses/Default400Response"
3106 },
3107 "404" : {
3108 "$ref" : "#/components/responses/Default404Response"
3109 },
3110 "405" : {
3111 "$ref" : "#/components/responses/Default405Response"
3112 },
3113 "406" : {
3114 "$ref" : "#/components/responses/Default406Response"
3115 },
3116 "409" : {
3117 "$ref" : "#/components/responses/Idempotency409Response"
3118 },
3119 "415" : {
3120 "$ref" : "#/components/responses/Default415Response"
3121 },
3122 "422" : {
3123 "$ref" : "#/components/responses/Idempotency422Response"
3124 },
3125 "429" : {
3126 "$ref" : "#/components/responses/Default429Response"
3127 },
3128 "500" : {
3129 "$ref" : "#/components/responses/Default500Response"
3130 },
3131 "503" : {
3132 "$ref" : "#/components/responses/Default503Response"
3133 }
3134 },
3135 "security" : [ {
3136 "Authorization_Code_PKCE" : [ "w_usr" ]
3137 } ],
3138 "summary" : "Delete single artistClaim.",
3139 "tags" : [ "artistClaims" ],
3140 "x-path-item-properties" : {
3141 "required-access-tier" : "INTERNAL"
3142 }
3143 },
3144 "get" : {
3145 "description" : "Retrieves single artistClaim by id.",
3146 "parameters" : [ {
3147 "description" : "Artist claim id",
3148 "example" : "f47ac10b-58cc-4372-a567-0e02b2c3d479",
3149 "in" : "path",
3150 "name" : "id",
3151 "required" : true,
3152 "schema" : {
3153 "type" : "string"
3154 }
3155 }, {
3156 "description" : "Allows the client to customize which related resources should be returned. Available options: acceptedArtists, owners, recommendedArtists",
3157 "example" : "acceptedArtists.albums",
3158 "in" : "query",
3159 "name" : "include",
3160 "required" : false,
3161 "schema" : {
3162 "type" : "array",
3163 "items" : {
3164 "type" : "string",
3165 "example" : "acceptedArtists.albums"
3166 }
3167 }
3168 }, {
3169 "description" : "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",
3170 "example" : "acceptedArtists.albums",
3171 "in" : "query",
3172 "name" : "replaceMedia",
3173 "required" : false,
3174 "schema" : {
3175 "type" : "string",
3176 "example" : "acceptedArtists.albums"
3177 }
3178 } ],
3179 "responses" : {
3180 "200" : {
3181 "content" : {
3182 "application/vnd.api+json" : {
3183 "schema" : {
3184 "$ref" : "#/components/schemas/ArtistClaims_Single_Resource_Data_Document"
3185 }
3186 }
3187 },
3188 "description" : "Successful response"
3189 },
3190 "400" : {
3191 "$ref" : "#/components/responses/Default400Response"
3192 },
3193 "404" : {
3194 "$ref" : "#/components/responses/Default404Response"
3195 },
3196 "405" : {
3197 "$ref" : "#/components/responses/Default405Response"
3198 },
3199 "406" : {
3200 "$ref" : "#/components/responses/Default406Response"
3201 },
3202 "415" : {
3203 "$ref" : "#/components/responses/Default415Response"
3204 },
3205 "429" : {
3206 "$ref" : "#/components/responses/Default429Response"
3207 },
3208 "500" : {
3209 "$ref" : "#/components/responses/Default500Response"
3210 },
3211 "503" : {
3212 "$ref" : "#/components/responses/Default503Response"
3213 }
3214 },
3215 "security" : [ {
3216 "Authorization_Code_PKCE" : [ "r_usr" ]
3217 } ],
3218 "summary" : "Get single artistClaim.",
3219 "tags" : [ "artistClaims" ],
3220 "x-path-item-properties" : {
3221 "required-access-tier" : "INTERNAL"
3222 }
3223 },
3224 "patch" : {
3225 "description" : "Updates existing artistClaim.",
3226 "parameters" : [ {
3227 "description" : "Artist claim id",
3228 "example" : "f47ac10b-58cc-4372-a567-0e02b2c3d479",
3229 "in" : "path",
3230 "name" : "id",
3231 "required" : true,
3232 "schema" : {
3233 "type" : "string"
3234 }
3235 }, {
3236 "description" : "ISO 3166-1 alpha-2 country code",
3237 "example" : "US",
3238 "in" : "query",
3239 "name" : "countryCode",
3240 "required" : false,
3241 "schema" : {
3242 "type" : "string"
3243 }
3244 }, {
3245 "$ref" : "#/components/parameters/IdempotencyKey"
3246 } ],
3247 "requestBody" : {
3248 "content" : {
3249 "application/vnd.api+json" : {
3250 "schema" : {
3251 "$ref" : "#/components/schemas/ArtistClaimsUpdateOperation_Payload"
3252 }
3253 }
3254 }
3255 },
3256 "responses" : {
3257 "400" : {
3258 "$ref" : "#/components/responses/Default400Response"
3259 },
3260 "404" : {
3261 "$ref" : "#/components/responses/Default404Response"
3262 },
3263 "405" : {
3264 "$ref" : "#/components/responses/Default405Response"
3265 },
3266 "406" : {
3267 "$ref" : "#/components/responses/Default406Response"
3268 },
3269 "409" : {
3270 "$ref" : "#/components/responses/Idempotency409Response"
3271 },
3272 "415" : {
3273 "$ref" : "#/components/responses/Default415Response"
3274 },
3275 "422" : {
3276 "$ref" : "#/components/responses/Idempotency422Response"
3277 },
3278 "429" : {
3279 "$ref" : "#/components/responses/Default429Response"
3280 },
3281 "500" : {
3282 "$ref" : "#/components/responses/Default500Response"
3283 },
3284 "503" : {
3285 "$ref" : "#/components/responses/Default503Response"
3286 }
3287 },
3288 "security" : [ {
3289 "Authorization_Code_PKCE" : [ "w_usr" ]
3290 } ],
3291 "summary" : "Update single artistClaim.",
3292 "tags" : [ "artistClaims" ],
3293 "x-path-item-properties" : {
3294 "required-access-tier" : "INTERNAL"
3295 }
3296 }
3297 },
3298 "/artistClaims/{id}/relationships/acceptedArtists" : {
3299 "get" : {
3300 "description" : "Retrieves acceptedArtists relationship.",
3301 "parameters" : [ {
3302 "description" : "Artist claim id",
3303 "example" : "f47ac10b-58cc-4372-a567-0e02b2c3d479",
3304 "in" : "path",
3305 "name" : "id",
3306 "required" : true,
3307 "schema" : {
3308 "type" : "string"
3309 }
3310 }, {
3311 "description" : "Allows the client to customize which related resources should be returned. Available options: acceptedArtists",
3312 "example" : "acceptedArtists.albums",
3313 "in" : "query",
3314 "name" : "include",
3315 "required" : false,
3316 "schema" : {
3317 "type" : "array",
3318 "items" : {
3319 "type" : "string",
3320 "example" : "acceptedArtists.albums"
3321 }
3322 }
3323 }, {
3324 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
3325 "in" : "query",
3326 "name" : "page[cursor]",
3327 "required" : false,
3328 "schema" : {
3329 "type" : "string"
3330 }
3331 }, {
3332 "description" : "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",
3333 "example" : "acceptedArtists.albums",
3334 "in" : "query",
3335 "name" : "replaceMedia",
3336 "required" : false,
3337 "schema" : {
3338 "type" : "string",
3339 "example" : "acceptedArtists.albums"
3340 }
3341 } ],
3342 "responses" : {
3343 "200" : {
3344 "content" : {
3345 "application/vnd.api+json" : {
3346 "schema" : {
3347 "$ref" : "#/components/schemas/ArtistClaims_Multi_Relationship_Data_Document"
3348 }
3349 }
3350 },
3351 "description" : "Successful response"
3352 },
3353 "400" : {
3354 "$ref" : "#/components/responses/Default400Response"
3355 },
3356 "404" : {
3357 "$ref" : "#/components/responses/Default404Response"
3358 },
3359 "405" : {
3360 "$ref" : "#/components/responses/Default405Response"
3361 },
3362 "406" : {
3363 "$ref" : "#/components/responses/Default406Response"
3364 },
3365 "415" : {
3366 "$ref" : "#/components/responses/Default415Response"
3367 },
3368 "429" : {
3369 "$ref" : "#/components/responses/Default429Response"
3370 },
3371 "500" : {
3372 "$ref" : "#/components/responses/Default500Response"
3373 },
3374 "503" : {
3375 "$ref" : "#/components/responses/Default503Response"
3376 }
3377 },
3378 "security" : [ {
3379 "Authorization_Code_PKCE" : [ "r_usr" ]
3380 } ],
3381 "summary" : "Get acceptedArtists relationship (\"to-many\").",
3382 "tags" : [ "artistClaims" ],
3383 "x-path-item-properties" : {
3384 "required-access-tier" : "INTERNAL"
3385 }
3386 },
3387 "patch" : {
3388 "description" : "Updates acceptedArtists relationship.",
3389 "parameters" : [ {
3390 "description" : "Artist claim id",
3391 "example" : "f47ac10b-58cc-4372-a567-0e02b2c3d479",
3392 "in" : "path",
3393 "name" : "id",
3394 "required" : true,
3395 "schema" : {
3396 "type" : "string"
3397 }
3398 }, {
3399 "description" : "ISO 3166-1 alpha-2 country code",
3400 "example" : "US",
3401 "in" : "query",
3402 "name" : "countryCode",
3403 "required" : false,
3404 "schema" : {
3405 "type" : "string"
3406 }
3407 }, {
3408 "$ref" : "#/components/parameters/IdempotencyKey"
3409 } ],
3410 "requestBody" : {
3411 "content" : {
3412 "application/vnd.api+json" : {
3413 "schema" : {
3414 "$ref" : "#/components/schemas/ArtistClaimsAcceptedArtistsRelationshipUpdateOperation_Payload"
3415 }
3416 }
3417 }
3418 },
3419 "responses" : {
3420 "400" : {
3421 "$ref" : "#/components/responses/Default400Response"
3422 },
3423 "404" : {
3424 "$ref" : "#/components/responses/Default404Response"
3425 },
3426 "405" : {
3427 "$ref" : "#/components/responses/Default405Response"
3428 },
3429 "406" : {
3430 "$ref" : "#/components/responses/Default406Response"
3431 },
3432 "409" : {
3433 "$ref" : "#/components/responses/Idempotency409Response"
3434 },
3435 "415" : {
3436 "$ref" : "#/components/responses/Default415Response"
3437 },
3438 "422" : {
3439 "$ref" : "#/components/responses/Idempotency422Response"
3440 },
3441 "429" : {
3442 "$ref" : "#/components/responses/Default429Response"
3443 },
3444 "500" : {
3445 "$ref" : "#/components/responses/Default500Response"
3446 },
3447 "503" : {
3448 "$ref" : "#/components/responses/Default503Response"
3449 }
3450 },
3451 "security" : [ {
3452 "Authorization_Code_PKCE" : [ "w_usr" ]
3453 } ],
3454 "summary" : "Update acceptedArtists relationship (\"to-many\").",
3455 "tags" : [ "artistClaims" ],
3456 "x-path-item-properties" : {
3457 "required-access-tier" : "INTERNAL"
3458 }
3459 }
3460 },
3461 "/artistClaims/{id}/relationships/owners" : {
3462 "get" : {
3463 "description" : "Retrieves owners relationship.",
3464 "parameters" : [ {
3465 "description" : "Artist claim id",
3466 "example" : "f47ac10b-58cc-4372-a567-0e02b2c3d479",
3467 "in" : "path",
3468 "name" : "id",
3469 "required" : true,
3470 "schema" : {
3471 "type" : "string"
3472 }
3473 }, {
3474 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
3475 "example" : "owners",
3476 "in" : "query",
3477 "name" : "include",
3478 "required" : false,
3479 "schema" : {
3480 "type" : "array",
3481 "items" : {
3482 "type" : "string",
3483 "example" : "owners"
3484 }
3485 }
3486 }, {
3487 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
3488 "in" : "query",
3489 "name" : "page[cursor]",
3490 "required" : false,
3491 "schema" : {
3492 "type" : "string"
3493 }
3494 } ],
3495 "responses" : {
3496 "200" : {
3497 "content" : {
3498 "application/vnd.api+json" : {
3499 "schema" : {
3500 "$ref" : "#/components/schemas/ArtistClaims_Multi_Relationship_Data_Document"
3501 }
3502 }
3503 },
3504 "description" : "Successful response"
3505 },
3506 "400" : {
3507 "$ref" : "#/components/responses/Default400Response"
3508 },
3509 "404" : {
3510 "$ref" : "#/components/responses/Default404Response"
3511 },
3512 "405" : {
3513 "$ref" : "#/components/responses/Default405Response"
3514 },
3515 "406" : {
3516 "$ref" : "#/components/responses/Default406Response"
3517 },
3518 "415" : {
3519 "$ref" : "#/components/responses/Default415Response"
3520 },
3521 "429" : {
3522 "$ref" : "#/components/responses/Default429Response"
3523 },
3524 "500" : {
3525 "$ref" : "#/components/responses/Default500Response"
3526 },
3527 "503" : {
3528 "$ref" : "#/components/responses/Default503Response"
3529 }
3530 },
3531 "security" : [ {
3532 "Authorization_Code_PKCE" : [ "r_usr" ]
3533 } ],
3534 "summary" : "Get owners relationship (\"to-many\").",
3535 "tags" : [ "artistClaims" ],
3536 "x-path-item-properties" : {
3537 "required-access-tier" : "INTERNAL"
3538 }
3539 }
3540 },
3541 "/artistClaims/{id}/relationships/recommendedArtists" : {
3542 "get" : {
3543 "description" : "Retrieves recommendedArtists relationship.",
3544 "parameters" : [ {
3545 "description" : "Artist claim id",
3546 "example" : "f47ac10b-58cc-4372-a567-0e02b2c3d479",
3547 "in" : "path",
3548 "name" : "id",
3549 "required" : true,
3550 "schema" : {
3551 "type" : "string"
3552 }
3553 }, {
3554 "description" : "Allows the client to customize which related resources should be returned. Available options: recommendedArtists",
3555 "example" : "recommendedArtists.albums",
3556 "in" : "query",
3557 "name" : "include",
3558 "required" : false,
3559 "schema" : {
3560 "type" : "array",
3561 "items" : {
3562 "type" : "string",
3563 "example" : "recommendedArtists.albums"
3564 }
3565 }
3566 }, {
3567 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
3568 "in" : "query",
3569 "name" : "page[cursor]",
3570 "required" : false,
3571 "schema" : {
3572 "type" : "string"
3573 }
3574 }, {
3575 "description" : "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",
3576 "example" : "recommendedArtists.albums",
3577 "in" : "query",
3578 "name" : "replaceMedia",
3579 "required" : false,
3580 "schema" : {
3581 "type" : "string",
3582 "example" : "recommendedArtists.albums"
3583 }
3584 } ],
3585 "responses" : {
3586 "200" : {
3587 "content" : {
3588 "application/vnd.api+json" : {
3589 "schema" : {
3590 "$ref" : "#/components/schemas/ArtistClaims_Multi_Relationship_Data_Document"
3591 }
3592 }
3593 },
3594 "description" : "Successful response"
3595 },
3596 "400" : {
3597 "$ref" : "#/components/responses/Default400Response"
3598 },
3599 "404" : {
3600 "$ref" : "#/components/responses/Default404Response"
3601 },
3602 "405" : {
3603 "$ref" : "#/components/responses/Default405Response"
3604 },
3605 "406" : {
3606 "$ref" : "#/components/responses/Default406Response"
3607 },
3608 "415" : {
3609 "$ref" : "#/components/responses/Default415Response"
3610 },
3611 "429" : {
3612 "$ref" : "#/components/responses/Default429Response"
3613 },
3614 "500" : {
3615 "$ref" : "#/components/responses/Default500Response"
3616 },
3617 "503" : {
3618 "$ref" : "#/components/responses/Default503Response"
3619 }
3620 },
3621 "security" : [ {
3622 "Authorization_Code_PKCE" : [ "r_usr" ]
3623 } ],
3624 "summary" : "Get recommendedArtists relationship (\"to-many\").",
3625 "tags" : [ "artistClaims" ],
3626 "x-path-item-properties" : {
3627 "required-access-tier" : "INTERNAL"
3628 }
3629 }
3630 },
3631 "/artistRoles/{id}" : {
3632 "get" : {
3633 "description" : "Retrieves single artistRole by id.",
3634 "parameters" : [ {
3635 "description" : "Artist role id",
3636 "example" : "1",
3637 "in" : "path",
3638 "name" : "id",
3639 "required" : true,
3640 "schema" : {
3641 "type" : "string"
3642 }
3643 } ],
3644 "responses" : {
3645 "200" : {
3646 "content" : {
3647 "application/vnd.api+json" : {
3648 "schema" : {
3649 "$ref" : "#/components/schemas/ArtistRoles_Single_Resource_Data_Document"
3650 }
3651 }
3652 },
3653 "description" : "Successful response"
3654 },
3655 "400" : {
3656 "$ref" : "#/components/responses/Default400Response"
3657 },
3658 "404" : {
3659 "$ref" : "#/components/responses/Default404Response"
3660 },
3661 "405" : {
3662 "$ref" : "#/components/responses/Default405Response"
3663 },
3664 "406" : {
3665 "$ref" : "#/components/responses/Default406Response"
3666 },
3667 "415" : {
3668 "$ref" : "#/components/responses/Default415Response"
3669 },
3670 "429" : {
3671 "$ref" : "#/components/responses/Default429Response"
3672 },
3673 "500" : {
3674 "$ref" : "#/components/responses/Default500Response"
3675 },
3676 "503" : {
3677 "$ref" : "#/components/responses/Default503Response"
3678 }
3679 },
3680 "security" : [ {
3681 "Client_Credentials" : [ ]
3682 }, {
3683 "Authorization_Code_PKCE" : [ ]
3684 } ],
3685 "summary" : "Get single artistRole.",
3686 "tags" : [ "artistRoles" ],
3687 "x-path-item-properties" : {
3688 "required-access-tier" : "THIRD_PARTY"
3689 }
3690 }
3691 },
3692 "/artists" : {
3693 "get" : {
3694 "description" : "Retrieves multiple artists by available filters, or without if applicable.",
3695 "parameters" : [ {
3696 "description" : "ISO 3166-1 alpha-2 country code",
3697 "example" : "US",
3698 "in" : "query",
3699 "name" : "countryCode",
3700 "required" : false,
3701 "schema" : {
3702 "type" : "string"
3703 }
3704 }, {
3705 "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",
3706 "example" : "albums",
3707 "in" : "query",
3708 "name" : "include",
3709 "required" : false,
3710 "schema" : {
3711 "type" : "array",
3712 "items" : {
3713 "type" : "string",
3714 "example" : "albums"
3715 }
3716 }
3717 }, {
3718 "description" : "Artist handle (e.g. `jayz`)",
3719 "in" : "query",
3720 "name" : "filter[handle]",
3721 "required" : false,
3722 "schema" : {
3723 "type" : "array",
3724 "items" : {
3725 "type" : "string"
3726 }
3727 }
3728 }, {
3729 "description" : "List of artist IDs (e.g. `1566`)",
3730 "in" : "query",
3731 "name" : "filter[id]",
3732 "required" : false,
3733 "schema" : {
3734 "type" : "array",
3735 "items" : {
3736 "type" : "string"
3737 }
3738 }
3739 }, {
3740 "description" : "User id. Use `me` for the authenticated user",
3741 "in" : "query",
3742 "name" : "filter[owners.id]",
3743 "required" : false,
3744 "schema" : {
3745 "type" : "array",
3746 "items" : {
3747 "type" : "string"
3748 }
3749 }
3750 }, {
3751 "description" : "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",
3752 "example" : "albums",
3753 "in" : "query",
3754 "name" : "replaceMedia",
3755 "required" : false,
3756 "schema" : {
3757 "type" : "string",
3758 "example" : "albums"
3759 }
3760 } ],
3761 "responses" : {
3762 "200" : {
3763 "content" : {
3764 "application/vnd.api+json" : {
3765 "schema" : {
3766 "$ref" : "#/components/schemas/Artists_Multi_Resource_Data_Document"
3767 }
3768 }
3769 },
3770 "description" : "Successful response"
3771 },
3772 "400" : {
3773 "$ref" : "#/components/responses/Default400Response"
3774 },
3775 "404" : {
3776 "$ref" : "#/components/responses/Default404Response"
3777 },
3778 "405" : {
3779 "$ref" : "#/components/responses/Default405Response"
3780 },
3781 "406" : {
3782 "$ref" : "#/components/responses/Default406Response"
3783 },
3784 "415" : {
3785 "$ref" : "#/components/responses/Default415Response"
3786 },
3787 "429" : {
3788 "$ref" : "#/components/responses/Default429Response"
3789 },
3790 "500" : {
3791 "$ref" : "#/components/responses/Default500Response"
3792 },
3793 "503" : {
3794 "$ref" : "#/components/responses/Default503Response"
3795 }
3796 },
3797 "security" : [ {
3798 "Client_Credentials" : [ ]
3799 }, {
3800 "Authorization_Code_PKCE" : [ "r_usr" ]
3801 } ],
3802 "summary" : "Get multiple artists.",
3803 "tags" : [ "artists" ],
3804 "x-path-item-properties" : {
3805 "required-access-tier" : "THIRD_PARTY"
3806 }
3807 },
3808 "post" : {
3809 "description" : "Creates a new artist.",
3810 "parameters" : [ {
3811 "$ref" : "#/components/parameters/IdempotencyKey"
3812 } ],
3813 "requestBody" : {
3814 "content" : {
3815 "application/vnd.api+json" : {
3816 "schema" : {
3817 "$ref" : "#/components/schemas/ArtistsCreateOperation_Payload"
3818 }
3819 }
3820 }
3821 },
3822 "responses" : {
3823 "201" : {
3824 "content" : {
3825 "application/vnd.api+json" : {
3826 "schema" : {
3827 "$ref" : "#/components/schemas/Artists_Create_Single_Resource_Data_Document"
3828 }
3829 }
3830 },
3831 "description" : "Successful response"
3832 },
3833 "400" : {
3834 "$ref" : "#/components/responses/Default400Response"
3835 },
3836 "404" : {
3837 "$ref" : "#/components/responses/Default404Response"
3838 },
3839 "405" : {
3840 "$ref" : "#/components/responses/Default405Response"
3841 },
3842 "406" : {
3843 "$ref" : "#/components/responses/Default406Response"
3844 },
3845 "409" : {
3846 "$ref" : "#/components/responses/Idempotency409Response"
3847 },
3848 "415" : {
3849 "$ref" : "#/components/responses/Default415Response"
3850 },
3851 "422" : {
3852 "$ref" : "#/components/responses/Idempotency422Response"
3853 },
3854 "429" : {
3855 "$ref" : "#/components/responses/Default429Response"
3856 },
3857 "500" : {
3858 "$ref" : "#/components/responses/Default500Response"
3859 },
3860 "503" : {
3861 "$ref" : "#/components/responses/Default503Response"
3862 }
3863 },
3864 "security" : [ {
3865 "Authorization_Code_PKCE" : [ "w_usr" ]
3866 } ],
3867 "summary" : "Create single artist.",
3868 "tags" : [ "artists" ],
3869 "x-path-item-properties" : {
3870 "required-access-tier" : "INTERNAL"
3871 }
3872 }
3873 },
3874 "/artists/{id}" : {
3875 "get" : {
3876 "description" : "Retrieves single artist by id.",
3877 "parameters" : [ {
3878 "description" : "Artist id",
3879 "example" : "1566",
3880 "in" : "path",
3881 "name" : "id",
3882 "required" : true,
3883 "schema" : {
3884 "type" : "string"
3885 }
3886 }, {
3887 "description" : "ISO 3166-1 alpha-2 country code",
3888 "example" : "US",
3889 "in" : "query",
3890 "name" : "countryCode",
3891 "required" : false,
3892 "schema" : {
3893 "type" : "string"
3894 }
3895 }, {
3896 "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",
3897 "example" : "albums",
3898 "in" : "query",
3899 "name" : "include",
3900 "required" : false,
3901 "schema" : {
3902 "type" : "array",
3903 "items" : {
3904 "type" : "string",
3905 "example" : "albums"
3906 }
3907 }
3908 }, {
3909 "description" : "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",
3910 "example" : "albums",
3911 "in" : "query",
3912 "name" : "replaceMedia",
3913 "required" : false,
3914 "schema" : {
3915 "type" : "string",
3916 "example" : "albums"
3917 }
3918 } ],
3919 "responses" : {
3920 "200" : {
3921 "content" : {
3922 "application/vnd.api+json" : {
3923 "schema" : {
3924 "$ref" : "#/components/schemas/Artists_Single_Resource_Data_Document"
3925 }
3926 }
3927 },
3928 "description" : "Successful response"
3929 },
3930 "400" : {
3931 "$ref" : "#/components/responses/Default400Response"
3932 },
3933 "404" : {
3934 "$ref" : "#/components/responses/Default404Response"
3935 },
3936 "405" : {
3937 "$ref" : "#/components/responses/Default405Response"
3938 },
3939 "406" : {
3940 "$ref" : "#/components/responses/Default406Response"
3941 },
3942 "415" : {
3943 "$ref" : "#/components/responses/Default415Response"
3944 },
3945 "429" : {
3946 "$ref" : "#/components/responses/Default429Response"
3947 },
3948 "500" : {
3949 "$ref" : "#/components/responses/Default500Response"
3950 },
3951 "503" : {
3952 "$ref" : "#/components/responses/Default503Response"
3953 }
3954 },
3955 "security" : [ {
3956 "Client_Credentials" : [ ]
3957 }, {
3958 "Authorization_Code_PKCE" : [ ]
3959 } ],
3960 "summary" : "Get single artist.",
3961 "tags" : [ "artists" ],
3962 "x-path-item-properties" : {
3963 "required-access-tier" : "THIRD_PARTY"
3964 }
3965 },
3966 "patch" : {
3967 "description" : "Updates existing artist.",
3968 "parameters" : [ {
3969 "description" : "Artist id",
3970 "example" : "1566",
3971 "in" : "path",
3972 "name" : "id",
3973 "required" : true,
3974 "schema" : {
3975 "type" : "string"
3976 }
3977 }, {
3978 "$ref" : "#/components/parameters/IdempotencyKey"
3979 } ],
3980 "requestBody" : {
3981 "content" : {
3982 "application/vnd.api+json" : {
3983 "schema" : {
3984 "$ref" : "#/components/schemas/ArtistsUpdateOperation_Payload"
3985 }
3986 }
3987 }
3988 },
3989 "responses" : {
3990 "400" : {
3991 "$ref" : "#/components/responses/Default400Response"
3992 },
3993 "404" : {
3994 "$ref" : "#/components/responses/Default404Response"
3995 },
3996 "405" : {
3997 "$ref" : "#/components/responses/Default405Response"
3998 },
3999 "406" : {
4000 "$ref" : "#/components/responses/Default406Response"
4001 },
4002 "409" : {
4003 "$ref" : "#/components/responses/Idempotency409Response"
4004 },
4005 "415" : {
4006 "$ref" : "#/components/responses/Default415Response"
4007 },
4008 "422" : {
4009 "$ref" : "#/components/responses/Idempotency422Response"
4010 },
4011 "429" : {
4012 "$ref" : "#/components/responses/Default429Response"
4013 },
4014 "500" : {
4015 "$ref" : "#/components/responses/Default500Response"
4016 },
4017 "503" : {
4018 "$ref" : "#/components/responses/Default503Response"
4019 }
4020 },
4021 "security" : [ {
4022 "Authorization_Code_PKCE" : [ "w_usr" ]
4023 } ],
4024 "summary" : "Update single artist.",
4025 "tags" : [ "artists" ],
4026 "x-path-item-properties" : {
4027 "required-access-tier" : "INTERNAL"
4028 }
4029 }
4030 },
4031 "/artists/{id}/relationships/albums" : {
4032 "get" : {
4033 "description" : "Retrieves albums relationship.",
4034 "parameters" : [ {
4035 "description" : "Artist id",
4036 "example" : "1566",
4037 "in" : "path",
4038 "name" : "id",
4039 "required" : true,
4040 "schema" : {
4041 "type" : "string"
4042 }
4043 }, {
4044 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
4045 "in" : "query",
4046 "name" : "page[cursor]",
4047 "required" : false,
4048 "schema" : {
4049 "type" : "string"
4050 }
4051 }, {
4052 "description" : "ISO 3166-1 alpha-2 country code",
4053 "example" : "US",
4054 "in" : "query",
4055 "name" : "countryCode",
4056 "required" : false,
4057 "schema" : {
4058 "type" : "string"
4059 }
4060 }, {
4061 "description" : "Allows the client to customize which related resources should be returned. Available options: albums",
4062 "example" : "albums",
4063 "in" : "query",
4064 "name" : "include",
4065 "required" : false,
4066 "schema" : {
4067 "type" : "array",
4068 "items" : {
4069 "type" : "string",
4070 "example" : "albums"
4071 }
4072 }
4073 }, {
4074 "description" : "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",
4075 "example" : "albums",
4076 "in" : "query",
4077 "name" : "replaceMedia",
4078 "required" : false,
4079 "schema" : {
4080 "type" : "string",
4081 "example" : "albums"
4082 }
4083 } ],
4084 "responses" : {
4085 "200" : {
4086 "content" : {
4087 "application/vnd.api+json" : {
4088 "schema" : {
4089 "$ref" : "#/components/schemas/Artists_Multi_Relationship_Data_Document"
4090 }
4091 }
4092 },
4093 "description" : "Successful response"
4094 },
4095 "400" : {
4096 "$ref" : "#/components/responses/Default400Response"
4097 },
4098 "404" : {
4099 "$ref" : "#/components/responses/Default404Response"
4100 },
4101 "405" : {
4102 "$ref" : "#/components/responses/Default405Response"
4103 },
4104 "406" : {
4105 "$ref" : "#/components/responses/Default406Response"
4106 },
4107 "415" : {
4108 "$ref" : "#/components/responses/Default415Response"
4109 },
4110 "429" : {
4111 "$ref" : "#/components/responses/Default429Response"
4112 },
4113 "500" : {
4114 "$ref" : "#/components/responses/Default500Response"
4115 },
4116 "503" : {
4117 "$ref" : "#/components/responses/Default503Response"
4118 }
4119 },
4120 "security" : [ {
4121 "Client_Credentials" : [ ]
4122 }, {
4123 "Authorization_Code_PKCE" : [ ]
4124 } ],
4125 "summary" : "Get albums relationship (\"to-many\").",
4126 "tags" : [ "artists" ],
4127 "x-path-item-properties" : {
4128 "required-access-tier" : "THIRD_PARTY"
4129 }
4130 }
4131 },
4132 "/artists/{id}/relationships/biography" : {
4133 "get" : {
4134 "description" : "Retrieves biography relationship.",
4135 "parameters" : [ {
4136 "description" : "Artist id",
4137 "example" : "1566",
4138 "in" : "path",
4139 "name" : "id",
4140 "required" : true,
4141 "schema" : {
4142 "type" : "string"
4143 }
4144 }, {
4145 "description" : "ISO 3166-1 alpha-2 country code",
4146 "example" : "US",
4147 "in" : "query",
4148 "name" : "countryCode",
4149 "required" : false,
4150 "schema" : {
4151 "type" : "string"
4152 }
4153 }, {
4154 "description" : "Allows the client to customize which related resources should be returned. Available options: biography",
4155 "example" : "biography",
4156 "in" : "query",
4157 "name" : "include",
4158 "required" : false,
4159 "schema" : {
4160 "type" : "array",
4161 "items" : {
4162 "type" : "string",
4163 "example" : "biography"
4164 }
4165 }
4166 } ],
4167 "responses" : {
4168 "200" : {
4169 "content" : {
4170 "application/vnd.api+json" : {
4171 "schema" : {
4172 "$ref" : "#/components/schemas/Artists_Single_Relationship_Data_Document"
4173 }
4174 }
4175 },
4176 "description" : "Successful response"
4177 },
4178 "400" : {
4179 "$ref" : "#/components/responses/Default400Response"
4180 },
4181 "404" : {
4182 "$ref" : "#/components/responses/Default404Response"
4183 },
4184 "405" : {
4185 "$ref" : "#/components/responses/Default405Response"
4186 },
4187 "406" : {
4188 "$ref" : "#/components/responses/Default406Response"
4189 },
4190 "415" : {
4191 "$ref" : "#/components/responses/Default415Response"
4192 },
4193 "429" : {
4194 "$ref" : "#/components/responses/Default429Response"
4195 },
4196 "500" : {
4197 "$ref" : "#/components/responses/Default500Response"
4198 },
4199 "503" : {
4200 "$ref" : "#/components/responses/Default503Response"
4201 }
4202 },
4203 "security" : [ {
4204 "Client_Credentials" : [ ]
4205 }, {
4206 "Authorization_Code_PKCE" : [ ]
4207 } ],
4208 "summary" : "Get biography relationship (\"to-one\").",
4209 "tags" : [ "artists" ],
4210 "x-path-item-properties" : {
4211 "required-access-tier" : "THIRD_PARTY"
4212 }
4213 }
4214 },
4215 "/artists/{id}/relationships/claimStatus" : {
4216 "get" : {
4217 "description" : "Retrieves claimStatus relationship.",
4218 "parameters" : [ {
4219 "description" : "Artist id",
4220 "example" : "1566",
4221 "in" : "path",
4222 "name" : "id",
4223 "required" : true,
4224 "schema" : {
4225 "type" : "string"
4226 }
4227 }, {
4228 "description" : "Allows the client to customize which related resources should be returned. Available options: claimStatus",
4229 "example" : "claimStatus",
4230 "in" : "query",
4231 "name" : "include",
4232 "required" : false,
4233 "schema" : {
4234 "type" : "array",
4235 "items" : {
4236 "type" : "string",
4237 "example" : "claimStatus"
4238 }
4239 }
4240 } ],
4241 "responses" : {
4242 "200" : {
4243 "content" : {
4244 "application/vnd.api+json" : {
4245 "schema" : {
4246 "$ref" : "#/components/schemas/Artists_Single_Relationship_Data_Document"
4247 }
4248 }
4249 },
4250 "description" : "Successful response"
4251 },
4252 "400" : {
4253 "$ref" : "#/components/responses/Default400Response"
4254 },
4255 "404" : {
4256 "$ref" : "#/components/responses/Default404Response"
4257 },
4258 "405" : {
4259 "$ref" : "#/components/responses/Default405Response"
4260 },
4261 "406" : {
4262 "$ref" : "#/components/responses/Default406Response"
4263 },
4264 "415" : {
4265 "$ref" : "#/components/responses/Default415Response"
4266 },
4267 "429" : {
4268 "$ref" : "#/components/responses/Default429Response"
4269 },
4270 "500" : {
4271 "$ref" : "#/components/responses/Default500Response"
4272 },
4273 "503" : {
4274 "$ref" : "#/components/responses/Default503Response"
4275 }
4276 },
4277 "security" : [ {
4278 "Authorization_Code_PKCE" : [ ]
4279 } ],
4280 "summary" : "Get claimStatus relationship (\"to-one\").",
4281 "tags" : [ "artists" ],
4282 "x-path-item-properties" : {
4283 "required-access-tier" : "INTERNAL"
4284 }
4285 }
4286 },
4287 "/artists/{id}/relationships/followers" : {
4288 "get" : {
4289 "description" : "Retrieves followers relationship.",
4290 "parameters" : [ {
4291 "description" : "Artist id",
4292 "example" : "1566",
4293 "in" : "path",
4294 "name" : "id",
4295 "required" : true,
4296 "schema" : {
4297 "type" : "string"
4298 }
4299 }, {
4300 "in" : "query",
4301 "name" : "viewerContext",
4302 "required" : false,
4303 "schema" : {
4304 "type" : "string"
4305 }
4306 }, {
4307 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
4308 "in" : "query",
4309 "name" : "page[cursor]",
4310 "required" : false,
4311 "schema" : {
4312 "type" : "string"
4313 }
4314 }, {
4315 "description" : "Allows the client to customize which related resources should be returned. Available options: followers",
4316 "example" : "followers.albums",
4317 "in" : "query",
4318 "name" : "include",
4319 "required" : false,
4320 "schema" : {
4321 "type" : "array",
4322 "items" : {
4323 "type" : "string",
4324 "example" : "followers.albums"
4325 }
4326 }
4327 }, {
4328 "description" : "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",
4329 "example" : "followers.albums",
4330 "in" : "query",
4331 "name" : "replaceMedia",
4332 "required" : false,
4333 "schema" : {
4334 "type" : "string",
4335 "example" : "followers.albums"
4336 }
4337 } ],
4338 "responses" : {
4339 "200" : {
4340 "content" : {
4341 "application/vnd.api+json" : {
4342 "schema" : {
4343 "$ref" : "#/components/schemas/Artists_Followers_Multi_Relationship_Data_Document"
4344 }
4345 }
4346 },
4347 "description" : "Successful response"
4348 },
4349 "400" : {
4350 "$ref" : "#/components/responses/Default400Response"
4351 },
4352 "404" : {
4353 "$ref" : "#/components/responses/Default404Response"
4354 },
4355 "405" : {
4356 "$ref" : "#/components/responses/Default405Response"
4357 },
4358 "406" : {
4359 "$ref" : "#/components/responses/Default406Response"
4360 },
4361 "415" : {
4362 "$ref" : "#/components/responses/Default415Response"
4363 },
4364 "429" : {
4365 "$ref" : "#/components/responses/Default429Response"
4366 },
4367 "500" : {
4368 "$ref" : "#/components/responses/Default500Response"
4369 },
4370 "503" : {
4371 "$ref" : "#/components/responses/Default503Response"
4372 }
4373 },
4374 "security" : [ {
4375 "Authorization_Code_PKCE" : [ ]
4376 } ],
4377 "summary" : "Get followers relationship (\"to-many\").",
4378 "tags" : [ "artists" ],
4379 "x-path-item-properties" : {
4380 "required-access-tier" : "INTERNAL"
4381 }
4382 }
4383 },
4384 "/artists/{id}/relationships/following" : {
4385 "delete" : {
4386 "description" : "Deletes item(s) from following relationship.",
4387 "parameters" : [ {
4388 "description" : "Artist id",
4389 "example" : "1566",
4390 "in" : "path",
4391 "name" : "id",
4392 "required" : true,
4393 "schema" : {
4394 "type" : "string"
4395 }
4396 }, {
4397 "$ref" : "#/components/parameters/IdempotencyKey"
4398 } ],
4399 "requestBody" : {
4400 "content" : {
4401 "application/vnd.api+json" : {
4402 "schema" : {
4403 "$ref" : "#/components/schemas/ArtistsFollowingRelationshipRemoveOperation_Payload"
4404 }
4405 }
4406 }
4407 },
4408 "responses" : {
4409 "400" : {
4410 "$ref" : "#/components/responses/Default400Response"
4411 },
4412 "404" : {
4413 "$ref" : "#/components/responses/Default404Response"
4414 },
4415 "405" : {
4416 "$ref" : "#/components/responses/Default405Response"
4417 },
4418 "406" : {
4419 "$ref" : "#/components/responses/Default406Response"
4420 },
4421 "409" : {
4422 "$ref" : "#/components/responses/Idempotency409Response"
4423 },
4424 "415" : {
4425 "$ref" : "#/components/responses/Default415Response"
4426 },
4427 "422" : {
4428 "$ref" : "#/components/responses/Idempotency422Response"
4429 },
4430 "429" : {
4431 "$ref" : "#/components/responses/Default429Response"
4432 },
4433 "500" : {
4434 "$ref" : "#/components/responses/Default500Response"
4435 },
4436 "503" : {
4437 "$ref" : "#/components/responses/Default503Response"
4438 }
4439 },
4440 "security" : [ {
4441 "Authorization_Code_PKCE" : [ "w_usr" ]
4442 } ],
4443 "summary" : "Delete from following relationship (\"to-many\").",
4444 "tags" : [ "artists" ],
4445 "x-path-item-properties" : {
4446 "required-access-tier" : "INTERNAL"
4447 }
4448 },
4449 "get" : {
4450 "description" : "Retrieves following relationship.",
4451 "parameters" : [ {
4452 "description" : "Artist id",
4453 "example" : "1566",
4454 "in" : "path",
4455 "name" : "id",
4456 "required" : true,
4457 "schema" : {
4458 "type" : "string"
4459 }
4460 }, {
4461 "in" : "query",
4462 "name" : "viewerContext",
4463 "required" : false,
4464 "schema" : {
4465 "type" : "string"
4466 }
4467 }, {
4468 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
4469 "in" : "query",
4470 "name" : "page[cursor]",
4471 "required" : false,
4472 "schema" : {
4473 "type" : "string"
4474 }
4475 }, {
4476 "description" : "Allows the client to customize which related resources should be returned. Available options: following",
4477 "example" : "following.albums",
4478 "in" : "query",
4479 "name" : "include",
4480 "required" : false,
4481 "schema" : {
4482 "type" : "array",
4483 "items" : {
4484 "type" : "string",
4485 "example" : "following.albums"
4486 }
4487 }
4488 }, {
4489 "description" : "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",
4490 "example" : "following.albums",
4491 "in" : "query",
4492 "name" : "replaceMedia",
4493 "required" : false,
4494 "schema" : {
4495 "type" : "string",
4496 "example" : "following.albums"
4497 }
4498 } ],
4499 "responses" : {
4500 "200" : {
4501 "content" : {
4502 "application/vnd.api+json" : {
4503 "schema" : {
4504 "$ref" : "#/components/schemas/Artists_Following_Multi_Relationship_Data_Document"
4505 }
4506 }
4507 },
4508 "description" : "Successful response"
4509 },
4510 "400" : {
4511 "$ref" : "#/components/responses/Default400Response"
4512 },
4513 "404" : {
4514 "$ref" : "#/components/responses/Default404Response"
4515 },
4516 "405" : {
4517 "$ref" : "#/components/responses/Default405Response"
4518 },
4519 "406" : {
4520 "$ref" : "#/components/responses/Default406Response"
4521 },
4522 "415" : {
4523 "$ref" : "#/components/responses/Default415Response"
4524 },
4525 "429" : {
4526 "$ref" : "#/components/responses/Default429Response"
4527 },
4528 "500" : {
4529 "$ref" : "#/components/responses/Default500Response"
4530 },
4531 "503" : {
4532 "$ref" : "#/components/responses/Default503Response"
4533 }
4534 },
4535 "security" : [ {
4536 "Authorization_Code_PKCE" : [ ]
4537 } ],
4538 "summary" : "Get following relationship (\"to-many\").",
4539 "tags" : [ "artists" ],
4540 "x-path-item-properties" : {
4541 "required-access-tier" : "INTERNAL"
4542 }
4543 },
4544 "post" : {
4545 "description" : "Adds item(s) to following relationship.",
4546 "parameters" : [ {
4547 "description" : "Artist id",
4548 "example" : "1566",
4549 "in" : "path",
4550 "name" : "id",
4551 "required" : true,
4552 "schema" : {
4553 "type" : "string"
4554 }
4555 }, {
4556 "description" : "ISO 3166-1 alpha-2 country code",
4557 "example" : "US",
4558 "in" : "query",
4559 "name" : "countryCode",
4560 "required" : false,
4561 "schema" : {
4562 "type" : "string"
4563 }
4564 }, {
4565 "$ref" : "#/components/parameters/IdempotencyKey"
4566 } ],
4567 "requestBody" : {
4568 "content" : {
4569 "application/vnd.api+json" : {
4570 "schema" : {
4571 "$ref" : "#/components/schemas/ArtistsFollowingRelationshipAddOperation_Payload"
4572 }
4573 }
4574 }
4575 },
4576 "responses" : {
4577 "201" : {
4578 "description" : "Successful response"
4579 },
4580 "400" : {
4581 "$ref" : "#/components/responses/Default400Response"
4582 },
4583 "404" : {
4584 "$ref" : "#/components/responses/Default404Response"
4585 },
4586 "405" : {
4587 "$ref" : "#/components/responses/Default405Response"
4588 },
4589 "406" : {
4590 "$ref" : "#/components/responses/Default406Response"
4591 },
4592 "409" : {
4593 "$ref" : "#/components/responses/Idempotency409Response"
4594 },
4595 "415" : {
4596 "$ref" : "#/components/responses/Default415Response"
4597 },
4598 "422" : {
4599 "$ref" : "#/components/responses/Idempotency422Response"
4600 },
4601 "429" : {
4602 "$ref" : "#/components/responses/Default429Response"
4603 },
4604 "500" : {
4605 "$ref" : "#/components/responses/Default500Response"
4606 },
4607 "503" : {
4608 "$ref" : "#/components/responses/Default503Response"
4609 }
4610 },
4611 "security" : [ {
4612 "Authorization_Code_PKCE" : [ "w_usr" ]
4613 } ],
4614 "summary" : "Add to following relationship (\"to-many\").",
4615 "tags" : [ "artists" ],
4616 "x-path-item-properties" : {
4617 "required-access-tier" : "INTERNAL"
4618 }
4619 }
4620 },
4621 "/artists/{id}/relationships/owners" : {
4622 "get" : {
4623 "description" : "Retrieves owners relationship.",
4624 "parameters" : [ {
4625 "description" : "Artist id",
4626 "example" : "1566",
4627 "in" : "path",
4628 "name" : "id",
4629 "required" : true,
4630 "schema" : {
4631 "type" : "string"
4632 }
4633 }, {
4634 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
4635 "example" : "owners",
4636 "in" : "query",
4637 "name" : "include",
4638 "required" : false,
4639 "schema" : {
4640 "type" : "array",
4641 "items" : {
4642 "type" : "string",
4643 "example" : "owners"
4644 }
4645 }
4646 }, {
4647 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
4648 "in" : "query",
4649 "name" : "page[cursor]",
4650 "required" : false,
4651 "schema" : {
4652 "type" : "string"
4653 }
4654 } ],
4655 "responses" : {
4656 "200" : {
4657 "content" : {
4658 "application/vnd.api+json" : {
4659 "schema" : {
4660 "$ref" : "#/components/schemas/Artists_Multi_Relationship_Data_Document"
4661 }
4662 }
4663 },
4664 "description" : "Successful response"
4665 },
4666 "400" : {
4667 "$ref" : "#/components/responses/Default400Response"
4668 },
4669 "404" : {
4670 "$ref" : "#/components/responses/Default404Response"
4671 },
4672 "405" : {
4673 "$ref" : "#/components/responses/Default405Response"
4674 },
4675 "406" : {
4676 "$ref" : "#/components/responses/Default406Response"
4677 },
4678 "415" : {
4679 "$ref" : "#/components/responses/Default415Response"
4680 },
4681 "429" : {
4682 "$ref" : "#/components/responses/Default429Response"
4683 },
4684 "500" : {
4685 "$ref" : "#/components/responses/Default500Response"
4686 },
4687 "503" : {
4688 "$ref" : "#/components/responses/Default503Response"
4689 }
4690 },
4691 "security" : [ {
4692 "Client_Credentials" : [ ]
4693 }, {
4694 "Authorization_Code_PKCE" : [ ]
4695 } ],
4696 "summary" : "Get owners relationship (\"to-many\").",
4697 "tags" : [ "artists" ],
4698 "x-path-item-properties" : {
4699 "required-access-tier" : "THIRD_PARTY"
4700 }
4701 }
4702 },
4703 "/artists/{id}/relationships/profileArt" : {
4704 "get" : {
4705 "description" : "Retrieves profileArt relationship.",
4706 "parameters" : [ {
4707 "description" : "Artist id",
4708 "example" : "1566",
4709 "in" : "path",
4710 "name" : "id",
4711 "required" : true,
4712 "schema" : {
4713 "type" : "string"
4714 }
4715 }, {
4716 "description" : "ISO 3166-1 alpha-2 country code",
4717 "example" : "US",
4718 "in" : "query",
4719 "name" : "countryCode",
4720 "required" : false,
4721 "schema" : {
4722 "type" : "string"
4723 }
4724 }, {
4725 "description" : "Allows the client to customize which related resources should be returned. Available options: profileArt",
4726 "example" : "profileArt",
4727 "in" : "query",
4728 "name" : "include",
4729 "required" : false,
4730 "schema" : {
4731 "type" : "array",
4732 "items" : {
4733 "type" : "string",
4734 "example" : "profileArt"
4735 }
4736 }
4737 }, {
4738 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
4739 "in" : "query",
4740 "name" : "page[cursor]",
4741 "required" : false,
4742 "schema" : {
4743 "type" : "string"
4744 }
4745 } ],
4746 "responses" : {
4747 "200" : {
4748 "content" : {
4749 "application/vnd.api+json" : {
4750 "schema" : {
4751 "$ref" : "#/components/schemas/Artists_Multi_Relationship_Data_Document"
4752 }
4753 }
4754 },
4755 "description" : "Successful response"
4756 },
4757 "400" : {
4758 "$ref" : "#/components/responses/Default400Response"
4759 },
4760 "404" : {
4761 "$ref" : "#/components/responses/Default404Response"
4762 },
4763 "405" : {
4764 "$ref" : "#/components/responses/Default405Response"
4765 },
4766 "406" : {
4767 "$ref" : "#/components/responses/Default406Response"
4768 },
4769 "415" : {
4770 "$ref" : "#/components/responses/Default415Response"
4771 },
4772 "429" : {
4773 "$ref" : "#/components/responses/Default429Response"
4774 },
4775 "500" : {
4776 "$ref" : "#/components/responses/Default500Response"
4777 },
4778 "503" : {
4779 "$ref" : "#/components/responses/Default503Response"
4780 }
4781 },
4782 "security" : [ {
4783 "Client_Credentials" : [ ]
4784 }, {
4785 "Authorization_Code_PKCE" : [ ]
4786 } ],
4787 "summary" : "Get profileArt relationship (\"to-many\").",
4788 "tags" : [ "artists" ],
4789 "x-path-item-properties" : {
4790 "required-access-tier" : "THIRD_PARTY"
4791 }
4792 },
4793 "patch" : {
4794 "description" : "Updates profileArt relationship.",
4795 "parameters" : [ {
4796 "description" : "Artist id",
4797 "example" : "1566",
4798 "in" : "path",
4799 "name" : "id",
4800 "required" : true,
4801 "schema" : {
4802 "type" : "string"
4803 }
4804 }, {
4805 "$ref" : "#/components/parameters/IdempotencyKey"
4806 } ],
4807 "requestBody" : {
4808 "content" : {
4809 "application/vnd.api+json" : {
4810 "schema" : {
4811 "$ref" : "#/components/schemas/ArtistsProfileArtRelationshipUpdateOperation_Payload"
4812 }
4813 }
4814 }
4815 },
4816 "responses" : {
4817 "400" : {
4818 "$ref" : "#/components/responses/Default400Response"
4819 },
4820 "404" : {
4821 "$ref" : "#/components/responses/Default404Response"
4822 },
4823 "405" : {
4824 "$ref" : "#/components/responses/Default405Response"
4825 },
4826 "406" : {
4827 "$ref" : "#/components/responses/Default406Response"
4828 },
4829 "409" : {
4830 "$ref" : "#/components/responses/Idempotency409Response"
4831 },
4832 "415" : {
4833 "$ref" : "#/components/responses/Default415Response"
4834 },
4835 "422" : {
4836 "$ref" : "#/components/responses/Idempotency422Response"
4837 },
4838 "429" : {
4839 "$ref" : "#/components/responses/Default429Response"
4840 },
4841 "500" : {
4842 "$ref" : "#/components/responses/Default500Response"
4843 },
4844 "503" : {
4845 "$ref" : "#/components/responses/Default503Response"
4846 }
4847 },
4848 "security" : [ {
4849 "Authorization_Code_PKCE" : [ "w_usr" ]
4850 } ],
4851 "summary" : "Update profileArt relationship (\"to-many\").",
4852 "tags" : [ "artists" ],
4853 "x-path-item-properties" : {
4854 "required-access-tier" : "INTERNAL"
4855 }
4856 }
4857 },
4858 "/artists/{id}/relationships/radio" : {
4859 "get" : {
4860 "description" : "Retrieves radio relationship.",
4861 "parameters" : [ {
4862 "description" : "Artist id",
4863 "example" : "1566",
4864 "in" : "path",
4865 "name" : "id",
4866 "required" : true,
4867 "schema" : {
4868 "type" : "string"
4869 }
4870 }, {
4871 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
4872 "in" : "query",
4873 "name" : "page[cursor]",
4874 "required" : false,
4875 "schema" : {
4876 "type" : "string"
4877 }
4878 }, {
4879 "description" : "ISO 3166-1 alpha-2 country code",
4880 "example" : "US",
4881 "in" : "query",
4882 "name" : "countryCode",
4883 "required" : false,
4884 "schema" : {
4885 "type" : "string"
4886 }
4887 }, {
4888 "description" : "Allows the client to customize which related resources should be returned. Available options: radio",
4889 "example" : "radio.items",
4890 "in" : "query",
4891 "name" : "include",
4892 "required" : false,
4893 "schema" : {
4894 "type" : "array",
4895 "items" : {
4896 "type" : "string",
4897 "example" : "radio.items"
4898 }
4899 }
4900 }, {
4901 "description" : "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",
4902 "example" : "radio.items",
4903 "in" : "query",
4904 "name" : "replaceMedia",
4905 "required" : false,
4906 "schema" : {
4907 "type" : "string",
4908 "example" : "radio.items"
4909 }
4910 } ],
4911 "responses" : {
4912 "200" : {
4913 "content" : {
4914 "application/vnd.api+json" : {
4915 "schema" : {
4916 "$ref" : "#/components/schemas/Artists_Multi_Relationship_Data_Document"
4917 }
4918 }
4919 },
4920 "description" : "Successful response"
4921 },
4922 "400" : {
4923 "$ref" : "#/components/responses/Default400Response"
4924 },
4925 "404" : {
4926 "$ref" : "#/components/responses/Default404Response"
4927 },
4928 "405" : {
4929 "$ref" : "#/components/responses/Default405Response"
4930 },
4931 "406" : {
4932 "$ref" : "#/components/responses/Default406Response"
4933 },
4934 "415" : {
4935 "$ref" : "#/components/responses/Default415Response"
4936 },
4937 "429" : {
4938 "$ref" : "#/components/responses/Default429Response"
4939 },
4940 "500" : {
4941 "$ref" : "#/components/responses/Default500Response"
4942 },
4943 "503" : {
4944 "$ref" : "#/components/responses/Default503Response"
4945 }
4946 },
4947 "security" : [ {
4948 "Client_Credentials" : [ ]
4949 }, {
4950 "Authorization_Code_PKCE" : [ ]
4951 } ],
4952 "summary" : "Get radio relationship (\"to-many\").",
4953 "tags" : [ "artists" ],
4954 "x-path-item-properties" : {
4955 "required-access-tier" : "THIRD_PARTY"
4956 }
4957 }
4958 },
4959 "/artists/{id}/relationships/roles" : {
4960 "get" : {
4961 "description" : "Retrieves roles relationship.",
4962 "parameters" : [ {
4963 "description" : "Artist id",
4964 "example" : "1566",
4965 "in" : "path",
4966 "name" : "id",
4967 "required" : true,
4968 "schema" : {
4969 "type" : "string"
4970 }
4971 }, {
4972 "description" : "Allows the client to customize which related resources should be returned. Available options: roles",
4973 "example" : "roles",
4974 "in" : "query",
4975 "name" : "include",
4976 "required" : false,
4977 "schema" : {
4978 "type" : "array",
4979 "items" : {
4980 "type" : "string",
4981 "example" : "roles"
4982 }
4983 }
4984 }, {
4985 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
4986 "in" : "query",
4987 "name" : "page[cursor]",
4988 "required" : false,
4989 "schema" : {
4990 "type" : "string"
4991 }
4992 } ],
4993 "responses" : {
4994 "200" : {
4995 "content" : {
4996 "application/vnd.api+json" : {
4997 "schema" : {
4998 "$ref" : "#/components/schemas/Artists_Multi_Relationship_Data_Document"
4999 }
5000 }
5001 },
5002 "description" : "Successful response"
5003 },
5004 "400" : {
5005 "$ref" : "#/components/responses/Default400Response"
5006 },
5007 "404" : {
5008 "$ref" : "#/components/responses/Default404Response"
5009 },
5010 "405" : {
5011 "$ref" : "#/components/responses/Default405Response"
5012 },
5013 "406" : {
5014 "$ref" : "#/components/responses/Default406Response"
5015 },
5016 "415" : {
5017 "$ref" : "#/components/responses/Default415Response"
5018 },
5019 "429" : {
5020 "$ref" : "#/components/responses/Default429Response"
5021 },
5022 "500" : {
5023 "$ref" : "#/components/responses/Default500Response"
5024 },
5025 "503" : {
5026 "$ref" : "#/components/responses/Default503Response"
5027 }
5028 },
5029 "security" : [ {
5030 "Client_Credentials" : [ ]
5031 }, {
5032 "Authorization_Code_PKCE" : [ ]
5033 } ],
5034 "summary" : "Get roles relationship (\"to-many\").",
5035 "tags" : [ "artists" ],
5036 "x-path-item-properties" : {
5037 "required-access-tier" : "THIRD_PARTY"
5038 }
5039 }
5040 },
5041 "/artists/{id}/relationships/similarArtists" : {
5042 "get" : {
5043 "description" : "Retrieves similarArtists relationship.",
5044 "parameters" : [ {
5045 "description" : "Artist id",
5046 "example" : "1566",
5047 "in" : "path",
5048 "name" : "id",
5049 "required" : true,
5050 "schema" : {
5051 "type" : "string"
5052 }
5053 }, {
5054 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
5055 "in" : "query",
5056 "name" : "page[cursor]",
5057 "required" : false,
5058 "schema" : {
5059 "type" : "string"
5060 }
5061 }, {
5062 "description" : "ISO 3166-1 alpha-2 country code",
5063 "example" : "US",
5064 "in" : "query",
5065 "name" : "countryCode",
5066 "required" : false,
5067 "schema" : {
5068 "type" : "string"
5069 }
5070 }, {
5071 "description" : "Allows the client to customize which related resources should be returned. Available options: similarArtists",
5072 "example" : "similarArtists.albums",
5073 "in" : "query",
5074 "name" : "include",
5075 "required" : false,
5076 "schema" : {
5077 "type" : "array",
5078 "items" : {
5079 "type" : "string",
5080 "example" : "similarArtists.albums"
5081 }
5082 }
5083 }, {
5084 "description" : "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",
5085 "example" : "similarArtists.albums",
5086 "in" : "query",
5087 "name" : "replaceMedia",
5088 "required" : false,
5089 "schema" : {
5090 "type" : "string",
5091 "example" : "similarArtists.albums"
5092 }
5093 } ],
5094 "responses" : {
5095 "200" : {
5096 "content" : {
5097 "application/vnd.api+json" : {
5098 "schema" : {
5099 "$ref" : "#/components/schemas/Artists_Multi_Relationship_Data_Document"
5100 }
5101 }
5102 },
5103 "description" : "Successful response"
5104 },
5105 "400" : {
5106 "$ref" : "#/components/responses/Default400Response"
5107 },
5108 "404" : {
5109 "$ref" : "#/components/responses/Default404Response"
5110 },
5111 "405" : {
5112 "$ref" : "#/components/responses/Default405Response"
5113 },
5114 "406" : {
5115 "$ref" : "#/components/responses/Default406Response"
5116 },
5117 "415" : {
5118 "$ref" : "#/components/responses/Default415Response"
5119 },
5120 "429" : {
5121 "$ref" : "#/components/responses/Default429Response"
5122 },
5123 "500" : {
5124 "$ref" : "#/components/responses/Default500Response"
5125 },
5126 "503" : {
5127 "$ref" : "#/components/responses/Default503Response"
5128 }
5129 },
5130 "security" : [ {
5131 "Client_Credentials" : [ ]
5132 }, {
5133 "Authorization_Code_PKCE" : [ ]
5134 } ],
5135 "summary" : "Get similarArtists relationship (\"to-many\").",
5136 "tags" : [ "artists" ],
5137 "x-path-item-properties" : {
5138 "required-access-tier" : "THIRD_PARTY"
5139 }
5140 }
5141 },
5142 "/artists/{id}/relationships/trackProviders" : {
5143 "get" : {
5144 "description" : "Retrieves trackProviders relationship.",
5145 "parameters" : [ {
5146 "description" : "Artist id",
5147 "example" : "1566",
5148 "in" : "path",
5149 "name" : "id",
5150 "required" : true,
5151 "schema" : {
5152 "type" : "string"
5153 }
5154 }, {
5155 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
5156 "in" : "query",
5157 "name" : "page[cursor]",
5158 "required" : false,
5159 "schema" : {
5160 "type" : "string"
5161 }
5162 }, {
5163 "description" : "Allows the client to customize which related resources should be returned. Available options: trackProviders",
5164 "example" : "trackProviders",
5165 "in" : "query",
5166 "name" : "include",
5167 "required" : false,
5168 "schema" : {
5169 "type" : "array",
5170 "items" : {
5171 "type" : "string",
5172 "example" : "trackProviders"
5173 }
5174 }
5175 } ],
5176 "responses" : {
5177 "200" : {
5178 "content" : {
5179 "application/vnd.api+json" : {
5180 "schema" : {
5181 "$ref" : "#/components/schemas/Artists_TrackProviders_Multi_Relationship_Data_Document"
5182 }
5183 }
5184 },
5185 "description" : "Successful response"
5186 },
5187 "400" : {
5188 "$ref" : "#/components/responses/Default400Response"
5189 },
5190 "404" : {
5191 "$ref" : "#/components/responses/Default404Response"
5192 },
5193 "405" : {
5194 "$ref" : "#/components/responses/Default405Response"
5195 },
5196 "406" : {
5197 "$ref" : "#/components/responses/Default406Response"
5198 },
5199 "415" : {
5200 "$ref" : "#/components/responses/Default415Response"
5201 },
5202 "429" : {
5203 "$ref" : "#/components/responses/Default429Response"
5204 },
5205 "500" : {
5206 "$ref" : "#/components/responses/Default500Response"
5207 },
5208 "503" : {
5209 "$ref" : "#/components/responses/Default503Response"
5210 }
5211 },
5212 "security" : [ {
5213 "Client_Credentials" : [ ]
5214 }, {
5215 "Authorization_Code_PKCE" : [ ]
5216 } ],
5217 "summary" : "Get trackProviders relationship (\"to-many\").",
5218 "tags" : [ "artists" ],
5219 "x-path-item-properties" : {
5220 "required-access-tier" : "THIRD_PARTY"
5221 }
5222 }
5223 },
5224 "/artists/{id}/relationships/tracks" : {
5225 "get" : {
5226 "description" : "Retrieves tracks relationship.",
5227 "parameters" : [ {
5228 "description" : "Artist id",
5229 "example" : "1566",
5230 "in" : "path",
5231 "name" : "id",
5232 "required" : true,
5233 "schema" : {
5234 "type" : "string"
5235 }
5236 }, {
5237 "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.",
5238 "example" : "FINGERPRINT",
5239 "in" : "query",
5240 "name" : "collapseBy",
5241 "required" : true,
5242 "schema" : {
5243 "type" : "string",
5244 "enum" : [ "FINGERPRINT", "NONE" ]
5245 }
5246 }, {
5247 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
5248 "in" : "query",
5249 "name" : "page[cursor]",
5250 "required" : false,
5251 "schema" : {
5252 "type" : "string"
5253 }
5254 }, {
5255 "description" : "ISO 3166-1 alpha-2 country code",
5256 "example" : "US",
5257 "in" : "query",
5258 "name" : "countryCode",
5259 "required" : false,
5260 "schema" : {
5261 "type" : "string"
5262 }
5263 }, {
5264 "description" : "Allows the client to customize which related resources should be returned. Available options: tracks",
5265 "example" : "tracks",
5266 "in" : "query",
5267 "name" : "include",
5268 "required" : false,
5269 "schema" : {
5270 "type" : "array",
5271 "items" : {
5272 "type" : "string",
5273 "example" : "tracks"
5274 }
5275 }
5276 }, {
5277 "description" : "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",
5278 "example" : "tracks",
5279 "in" : "query",
5280 "name" : "replaceMedia",
5281 "required" : false,
5282 "schema" : {
5283 "type" : "string",
5284 "example" : "tracks"
5285 }
5286 } ],
5287 "responses" : {
5288 "200" : {
5289 "content" : {
5290 "application/vnd.api+json" : {
5291 "schema" : {
5292 "$ref" : "#/components/schemas/Artists_Multi_Relationship_Data_Document"
5293 }
5294 }
5295 },
5296 "description" : "Successful response"
5297 },
5298 "400" : {
5299 "$ref" : "#/components/responses/Default400Response"
5300 },
5301 "404" : {
5302 "$ref" : "#/components/responses/Default404Response"
5303 },
5304 "405" : {
5305 "$ref" : "#/components/responses/Default405Response"
5306 },
5307 "406" : {
5308 "$ref" : "#/components/responses/Default406Response"
5309 },
5310 "415" : {
5311 "$ref" : "#/components/responses/Default415Response"
5312 },
5313 "429" : {
5314 "$ref" : "#/components/responses/Default429Response"
5315 },
5316 "500" : {
5317 "$ref" : "#/components/responses/Default500Response"
5318 },
5319 "503" : {
5320 "$ref" : "#/components/responses/Default503Response"
5321 }
5322 },
5323 "security" : [ {
5324 "Client_Credentials" : [ ]
5325 }, {
5326 "Authorization_Code_PKCE" : [ ]
5327 } ],
5328 "summary" : "Get tracks relationship (\"to-many\").",
5329 "tags" : [ "artists" ],
5330 "x-path-item-properties" : {
5331 "required-access-tier" : "THIRD_PARTY"
5332 }
5333 }
5334 },
5335 "/artists/{id}/relationships/videos" : {
5336 "get" : {
5337 "description" : "Retrieves videos relationship.",
5338 "parameters" : [ {
5339 "description" : "Artist id",
5340 "example" : "1566",
5341 "in" : "path",
5342 "name" : "id",
5343 "required" : true,
5344 "schema" : {
5345 "type" : "string"
5346 }
5347 }, {
5348 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
5349 "in" : "query",
5350 "name" : "page[cursor]",
5351 "required" : false,
5352 "schema" : {
5353 "type" : "string"
5354 }
5355 }, {
5356 "description" : "ISO 3166-1 alpha-2 country code",
5357 "example" : "US",
5358 "in" : "query",
5359 "name" : "countryCode",
5360 "required" : false,
5361 "schema" : {
5362 "type" : "string"
5363 }
5364 }, {
5365 "description" : "Allows the client to customize which related resources should be returned. Available options: videos",
5366 "example" : "videos",
5367 "in" : "query",
5368 "name" : "include",
5369 "required" : false,
5370 "schema" : {
5371 "type" : "array",
5372 "items" : {
5373 "type" : "string",
5374 "example" : "videos"
5375 }
5376 }
5377 }, {
5378 "description" : "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",
5379 "example" : "videos",
5380 "in" : "query",
5381 "name" : "replaceMedia",
5382 "required" : false,
5383 "schema" : {
5384 "type" : "string",
5385 "example" : "videos"
5386 }
5387 } ],
5388 "responses" : {
5389 "200" : {
5390 "content" : {
5391 "application/vnd.api+json" : {
5392 "schema" : {
5393 "$ref" : "#/components/schemas/Artists_Multi_Relationship_Data_Document"
5394 }
5395 }
5396 },
5397 "description" : "Successful response"
5398 },
5399 "400" : {
5400 "$ref" : "#/components/responses/Default400Response"
5401 },
5402 "404" : {
5403 "$ref" : "#/components/responses/Default404Response"
5404 },
5405 "405" : {
5406 "$ref" : "#/components/responses/Default405Response"
5407 },
5408 "406" : {
5409 "$ref" : "#/components/responses/Default406Response"
5410 },
5411 "415" : {
5412 "$ref" : "#/components/responses/Default415Response"
5413 },
5414 "429" : {
5415 "$ref" : "#/components/responses/Default429Response"
5416 },
5417 "500" : {
5418 "$ref" : "#/components/responses/Default500Response"
5419 },
5420 "503" : {
5421 "$ref" : "#/components/responses/Default503Response"
5422 }
5423 },
5424 "security" : [ {
5425 "Client_Credentials" : [ ]
5426 }, {
5427 "Authorization_Code_PKCE" : [ ]
5428 } ],
5429 "summary" : "Get videos relationship (\"to-many\").",
5430 "tags" : [ "artists" ],
5431 "x-path-item-properties" : {
5432 "required-access-tier" : "THIRD_PARTY"
5433 }
5434 }
5435 },
5436 "/artworks" : {
5437 "get" : {
5438 "description" : "Retrieves multiple artworks by available filters, or without if applicable.",
5439 "parameters" : [ {
5440 "description" : "Artwork id (e.g. `a468bee88def`)",
5441 "in" : "query",
5442 "name" : "filter[id]",
5443 "required" : true,
5444 "schema" : {
5445 "type" : "array",
5446 "items" : {
5447 "type" : "string"
5448 }
5449 }
5450 }, {
5451 "description" : "ISO 3166-1 alpha-2 country code",
5452 "example" : "US",
5453 "in" : "query",
5454 "name" : "countryCode",
5455 "required" : false,
5456 "schema" : {
5457 "type" : "string"
5458 }
5459 }, {
5460 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
5461 "example" : "owners",
5462 "in" : "query",
5463 "name" : "include",
5464 "required" : false,
5465 "schema" : {
5466 "type" : "array",
5467 "items" : {
5468 "type" : "string",
5469 "example" : "owners"
5470 }
5471 }
5472 } ],
5473 "responses" : {
5474 "200" : {
5475 "content" : {
5476 "application/vnd.api+json" : {
5477 "schema" : {
5478 "$ref" : "#/components/schemas/Artworks_Multi_Resource_Data_Document"
5479 }
5480 }
5481 },
5482 "description" : "Successful response"
5483 },
5484 "400" : {
5485 "$ref" : "#/components/responses/Default400Response"
5486 },
5487 "404" : {
5488 "$ref" : "#/components/responses/Default404Response"
5489 },
5490 "405" : {
5491 "$ref" : "#/components/responses/Default405Response"
5492 },
5493 "406" : {
5494 "$ref" : "#/components/responses/Default406Response"
5495 },
5496 "415" : {
5497 "$ref" : "#/components/responses/Default415Response"
5498 },
5499 "429" : {
5500 "$ref" : "#/components/responses/Default429Response"
5501 },
5502 "500" : {
5503 "$ref" : "#/components/responses/Default500Response"
5504 },
5505 "503" : {
5506 "$ref" : "#/components/responses/Default503Response"
5507 }
5508 },
5509 "security" : [ {
5510 "Client_Credentials" : [ ]
5511 }, {
5512 "Authorization_Code_PKCE" : [ ]
5513 } ],
5514 "summary" : "Get multiple artworks.",
5515 "tags" : [ "artworks" ],
5516 "x-path-item-properties" : {
5517 "required-access-tier" : "THIRD_PARTY"
5518 }
5519 },
5520 "post" : {
5521 "description" : "Creates a new artwork.",
5522 "parameters" : [ {
5523 "$ref" : "#/components/parameters/IdempotencyKey"
5524 } ],
5525 "requestBody" : {
5526 "content" : {
5527 "application/vnd.api+json" : {
5528 "schema" : {
5529 "$ref" : "#/components/schemas/ArtworksCreateOperation_Payload"
5530 }
5531 }
5532 }
5533 },
5534 "responses" : {
5535 "201" : {
5536 "content" : {
5537 "application/vnd.api+json" : {
5538 "schema" : {
5539 "$ref" : "#/components/schemas/Artworks_Create_Single_Resource_Data_Document"
5540 }
5541 }
5542 },
5543 "description" : "Successful response"
5544 },
5545 "400" : {
5546 "$ref" : "#/components/responses/Default400Response"
5547 },
5548 "404" : {
5549 "$ref" : "#/components/responses/Default404Response"
5550 },
5551 "405" : {
5552 "$ref" : "#/components/responses/Default405Response"
5553 },
5554 "406" : {
5555 "$ref" : "#/components/responses/Default406Response"
5556 },
5557 "409" : {
5558 "$ref" : "#/components/responses/Idempotency409Response"
5559 },
5560 "415" : {
5561 "$ref" : "#/components/responses/Default415Response"
5562 },
5563 "422" : {
5564 "$ref" : "#/components/responses/Idempotency422Response"
5565 },
5566 "429" : {
5567 "$ref" : "#/components/responses/Default429Response"
5568 },
5569 "500" : {
5570 "$ref" : "#/components/responses/Default500Response"
5571 },
5572 "503" : {
5573 "$ref" : "#/components/responses/Default503Response"
5574 }
5575 },
5576 "security" : [ {
5577 "Authorization_Code_PKCE" : [ "w_usr" ]
5578 } ],
5579 "summary" : "Create single artwork.",
5580 "tags" : [ "artworks" ],
5581 "x-path-item-properties" : {
5582 "required-access-tier" : "INTERNAL"
5583 }
5584 }
5585 },
5586 "/artworks/{id}" : {
5587 "get" : {
5588 "description" : "Retrieves single artwork by id.",
5589 "parameters" : [ {
5590 "description" : "Artwork id",
5591 "example" : "a468bee88def",
5592 "in" : "path",
5593 "name" : "id",
5594 "required" : true,
5595 "schema" : {
5596 "type" : "string"
5597 }
5598 }, {
5599 "description" : "ISO 3166-1 alpha-2 country code",
5600 "example" : "US",
5601 "in" : "query",
5602 "name" : "countryCode",
5603 "required" : false,
5604 "schema" : {
5605 "type" : "string"
5606 }
5607 }, {
5608 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
5609 "example" : "owners",
5610 "in" : "query",
5611 "name" : "include",
5612 "required" : false,
5613 "schema" : {
5614 "type" : "array",
5615 "items" : {
5616 "type" : "string",
5617 "example" : "owners"
5618 }
5619 }
5620 } ],
5621 "responses" : {
5622 "200" : {
5623 "content" : {
5624 "application/vnd.api+json" : {
5625 "schema" : {
5626 "$ref" : "#/components/schemas/Artworks_Single_Resource_Data_Document"
5627 }
5628 }
5629 },
5630 "description" : "Successful response"
5631 },
5632 "400" : {
5633 "$ref" : "#/components/responses/Default400Response"
5634 },
5635 "404" : {
5636 "$ref" : "#/components/responses/Default404Response"
5637 },
5638 "405" : {
5639 "$ref" : "#/components/responses/Default405Response"
5640 },
5641 "406" : {
5642 "$ref" : "#/components/responses/Default406Response"
5643 },
5644 "415" : {
5645 "$ref" : "#/components/responses/Default415Response"
5646 },
5647 "429" : {
5648 "$ref" : "#/components/responses/Default429Response"
5649 },
5650 "500" : {
5651 "$ref" : "#/components/responses/Default500Response"
5652 },
5653 "503" : {
5654 "$ref" : "#/components/responses/Default503Response"
5655 }
5656 },
5657 "security" : [ {
5658 "Client_Credentials" : [ ]
5659 }, {
5660 "Authorization_Code_PKCE" : [ ]
5661 } ],
5662 "summary" : "Get single artwork.",
5663 "tags" : [ "artworks" ],
5664 "x-path-item-properties" : {
5665 "required-access-tier" : "THIRD_PARTY"
5666 }
5667 }
5668 },
5669 "/artworks/{id}/relationships/owners" : {
5670 "get" : {
5671 "description" : "Retrieves owners relationship.",
5672 "parameters" : [ {
5673 "description" : "Artwork id",
5674 "example" : "a468bee88def",
5675 "in" : "path",
5676 "name" : "id",
5677 "required" : true,
5678 "schema" : {
5679 "type" : "string"
5680 }
5681 }, {
5682 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
5683 "example" : "owners",
5684 "in" : "query",
5685 "name" : "include",
5686 "required" : false,
5687 "schema" : {
5688 "type" : "array",
5689 "items" : {
5690 "type" : "string",
5691 "example" : "owners"
5692 }
5693 }
5694 }, {
5695 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
5696 "in" : "query",
5697 "name" : "page[cursor]",
5698 "required" : false,
5699 "schema" : {
5700 "type" : "string"
5701 }
5702 } ],
5703 "responses" : {
5704 "200" : {
5705 "content" : {
5706 "application/vnd.api+json" : {
5707 "schema" : {
5708 "$ref" : "#/components/schemas/Artworks_Multi_Relationship_Data_Document"
5709 }
5710 }
5711 },
5712 "description" : "Successful response"
5713 },
5714 "400" : {
5715 "$ref" : "#/components/responses/Default400Response"
5716 },
5717 "404" : {
5718 "$ref" : "#/components/responses/Default404Response"
5719 },
5720 "405" : {
5721 "$ref" : "#/components/responses/Default405Response"
5722 },
5723 "406" : {
5724 "$ref" : "#/components/responses/Default406Response"
5725 },
5726 "415" : {
5727 "$ref" : "#/components/responses/Default415Response"
5728 },
5729 "429" : {
5730 "$ref" : "#/components/responses/Default429Response"
5731 },
5732 "500" : {
5733 "$ref" : "#/components/responses/Default500Response"
5734 },
5735 "503" : {
5736 "$ref" : "#/components/responses/Default503Response"
5737 }
5738 },
5739 "security" : [ {
5740 "Client_Credentials" : [ ]
5741 }, {
5742 "Authorization_Code_PKCE" : [ ]
5743 } ],
5744 "summary" : "Get owners relationship (\"to-many\").",
5745 "tags" : [ "artworks" ],
5746 "x-path-item-properties" : {
5747 "required-access-tier" : "THIRD_PARTY"
5748 }
5749 }
5750 },
5751 "/clients" : {
5752 "get" : {
5753 "description" : "Retrieves multiple clients by available filters, or without if applicable.",
5754 "parameters" : [ {
5755 "description" : "User id. Use `me` for the authenticated user",
5756 "in" : "query",
5757 "name" : "filter[owners.id]",
5758 "required" : true,
5759 "schema" : {
5760 "type" : "array",
5761 "items" : {
5762 "type" : "string"
5763 }
5764 }
5765 }, {
5766 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
5767 "example" : "owners",
5768 "in" : "query",
5769 "name" : "include",
5770 "required" : false,
5771 "schema" : {
5772 "type" : "array",
5773 "items" : {
5774 "type" : "string",
5775 "example" : "owners"
5776 }
5777 }
5778 } ],
5779 "responses" : {
5780 "200" : {
5781 "content" : {
5782 "application/vnd.api+json" : {
5783 "schema" : {
5784 "$ref" : "#/components/schemas/Clients_Multi_Resource_Data_Document"
5785 }
5786 }
5787 },
5788 "description" : "Successful response"
5789 },
5790 "400" : {
5791 "$ref" : "#/components/responses/Default400Response"
5792 },
5793 "404" : {
5794 "$ref" : "#/components/responses/Default404Response"
5795 },
5796 "405" : {
5797 "$ref" : "#/components/responses/Default405Response"
5798 },
5799 "406" : {
5800 "$ref" : "#/components/responses/Default406Response"
5801 },
5802 "415" : {
5803 "$ref" : "#/components/responses/Default415Response"
5804 },
5805 "429" : {
5806 "$ref" : "#/components/responses/Default429Response"
5807 },
5808 "500" : {
5809 "$ref" : "#/components/responses/Default500Response"
5810 },
5811 "503" : {
5812 "$ref" : "#/components/responses/Default503Response"
5813 }
5814 },
5815 "security" : [ {
5816 "Authorization_Code_PKCE" : [ "r_usr" ]
5817 } ],
5818 "summary" : "Get multiple clients.",
5819 "tags" : [ "clients" ],
5820 "x-path-item-properties" : {
5821 "required-access-tier" : "INTERNAL"
5822 }
5823 },
5824 "post" : {
5825 "description" : "Creates a new client.",
5826 "parameters" : [ {
5827 "$ref" : "#/components/parameters/IdempotencyKey"
5828 } ],
5829 "requestBody" : {
5830 "content" : {
5831 "application/vnd.api+json" : {
5832 "schema" : {
5833 "$ref" : "#/components/schemas/ClientsCreateOperation_Payload"
5834 }
5835 }
5836 }
5837 },
5838 "responses" : {
5839 "201" : {
5840 "content" : {
5841 "application/vnd.api+json" : {
5842 "schema" : {
5843 "$ref" : "#/components/schemas/Clients_Create_Single_Resource_Data_Document"
5844 }
5845 }
5846 },
5847 "description" : "Successful response"
5848 },
5849 "400" : {
5850 "$ref" : "#/components/responses/Default400Response"
5851 },
5852 "404" : {
5853 "$ref" : "#/components/responses/Default404Response"
5854 },
5855 "405" : {
5856 "$ref" : "#/components/responses/Default405Response"
5857 },
5858 "406" : {
5859 "$ref" : "#/components/responses/Default406Response"
5860 },
5861 "409" : {
5862 "$ref" : "#/components/responses/Idempotency409Response"
5863 },
5864 "415" : {
5865 "$ref" : "#/components/responses/Default415Response"
5866 },
5867 "422" : {
5868 "$ref" : "#/components/responses/Idempotency422Response"
5869 },
5870 "429" : {
5871 "$ref" : "#/components/responses/Default429Response"
5872 },
5873 "500" : {
5874 "$ref" : "#/components/responses/Default500Response"
5875 },
5876 "503" : {
5877 "$ref" : "#/components/responses/Default503Response"
5878 }
5879 },
5880 "security" : [ {
5881 "Authorization_Code_PKCE" : [ "w_usr" ]
5882 } ],
5883 "summary" : "Create single client.",
5884 "tags" : [ "clients" ],
5885 "x-path-item-properties" : {
5886 "required-access-tier" : "INTERNAL"
5887 }
5888 }
5889 },
5890 "/clients/{id}" : {
5891 "delete" : {
5892 "description" : "Deletes existing client.",
5893 "parameters" : [ {
5894 "description" : "OAuth client identifier",
5895 "example" : "a468bee88def",
5896 "in" : "path",
5897 "name" : "id",
5898 "required" : true,
5899 "schema" : {
5900 "type" : "string"
5901 }
5902 }, {
5903 "$ref" : "#/components/parameters/IdempotencyKey"
5904 } ],
5905 "responses" : {
5906 "400" : {
5907 "$ref" : "#/components/responses/Default400Response"
5908 },
5909 "404" : {
5910 "$ref" : "#/components/responses/Default404Response"
5911 },
5912 "405" : {
5913 "$ref" : "#/components/responses/Default405Response"
5914 },
5915 "406" : {
5916 "$ref" : "#/components/responses/Default406Response"
5917 },
5918 "409" : {
5919 "$ref" : "#/components/responses/Idempotency409Response"
5920 },
5921 "415" : {
5922 "$ref" : "#/components/responses/Default415Response"
5923 },
5924 "422" : {
5925 "$ref" : "#/components/responses/Idempotency422Response"
5926 },
5927 "429" : {
5928 "$ref" : "#/components/responses/Default429Response"
5929 },
5930 "500" : {
5931 "$ref" : "#/components/responses/Default500Response"
5932 },
5933 "503" : {
5934 "$ref" : "#/components/responses/Default503Response"
5935 }
5936 },
5937 "security" : [ {
5938 "Authorization_Code_PKCE" : [ "w_usr" ]
5939 } ],
5940 "summary" : "Delete single client.",
5941 "tags" : [ "clients" ],
5942 "x-path-item-properties" : {
5943 "required-access-tier" : "INTERNAL"
5944 }
5945 },
5946 "get" : {
5947 "description" : "Retrieves single client by id.",
5948 "parameters" : [ {
5949 "description" : "OAuth client identifier",
5950 "example" : "a468bee88def",
5951 "in" : "path",
5952 "name" : "id",
5953 "required" : true,
5954 "schema" : {
5955 "type" : "string"
5956 }
5957 }, {
5958 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
5959 "example" : "owners",
5960 "in" : "query",
5961 "name" : "include",
5962 "required" : false,
5963 "schema" : {
5964 "type" : "array",
5965 "items" : {
5966 "type" : "string",
5967 "example" : "owners"
5968 }
5969 }
5970 } ],
5971 "responses" : {
5972 "200" : {
5973 "content" : {
5974 "application/vnd.api+json" : {
5975 "schema" : {
5976 "$ref" : "#/components/schemas/Clients_Single_Resource_Data_Document"
5977 }
5978 }
5979 },
5980 "description" : "Successful response"
5981 },
5982 "400" : {
5983 "$ref" : "#/components/responses/Default400Response"
5984 },
5985 "404" : {
5986 "$ref" : "#/components/responses/Default404Response"
5987 },
5988 "405" : {
5989 "$ref" : "#/components/responses/Default405Response"
5990 },
5991 "406" : {
5992 "$ref" : "#/components/responses/Default406Response"
5993 },
5994 "415" : {
5995 "$ref" : "#/components/responses/Default415Response"
5996 },
5997 "429" : {
5998 "$ref" : "#/components/responses/Default429Response"
5999 },
6000 "500" : {
6001 "$ref" : "#/components/responses/Default500Response"
6002 },
6003 "503" : {
6004 "$ref" : "#/components/responses/Default503Response"
6005 }
6006 },
6007 "security" : [ {
6008 "Authorization_Code_PKCE" : [ "r_usr" ]
6009 } ],
6010 "summary" : "Get single client.",
6011 "tags" : [ "clients" ],
6012 "x-path-item-properties" : {
6013 "required-access-tier" : "INTERNAL"
6014 }
6015 },
6016 "patch" : {
6017 "description" : "Updates existing client.",
6018 "parameters" : [ {
6019 "description" : "OAuth client identifier",
6020 "example" : "a468bee88def",
6021 "in" : "path",
6022 "name" : "id",
6023 "required" : true,
6024 "schema" : {
6025 "type" : "string"
6026 }
6027 }, {
6028 "$ref" : "#/components/parameters/IdempotencyKey"
6029 } ],
6030 "requestBody" : {
6031 "content" : {
6032 "application/vnd.api+json" : {
6033 "schema" : {
6034 "$ref" : "#/components/schemas/ClientsUpdateOperation_Payload"
6035 }
6036 }
6037 }
6038 },
6039 "responses" : {
6040 "200" : {
6041 "content" : {
6042 "application/vnd.api+json" : {
6043 "schema" : {
6044 "$ref" : "#/components/schemas/Clients_Update_Single_Resource_Data_Document"
6045 }
6046 }
6047 },
6048 "description" : "Successful response"
6049 },
6050 "400" : {
6051 "$ref" : "#/components/responses/Default400Response"
6052 },
6053 "404" : {
6054 "$ref" : "#/components/responses/Default404Response"
6055 },
6056 "405" : {
6057 "$ref" : "#/components/responses/Default405Response"
6058 },
6059 "406" : {
6060 "$ref" : "#/components/responses/Default406Response"
6061 },
6062 "409" : {
6063 "$ref" : "#/components/responses/Idempotency409Response"
6064 },
6065 "415" : {
6066 "$ref" : "#/components/responses/Default415Response"
6067 },
6068 "422" : {
6069 "$ref" : "#/components/responses/Idempotency422Response"
6070 },
6071 "429" : {
6072 "$ref" : "#/components/responses/Default429Response"
6073 },
6074 "500" : {
6075 "$ref" : "#/components/responses/Default500Response"
6076 },
6077 "503" : {
6078 "$ref" : "#/components/responses/Default503Response"
6079 }
6080 },
6081 "security" : [ {
6082 "Authorization_Code_PKCE" : [ "w_usr" ]
6083 } ],
6084 "summary" : "Update single client.",
6085 "tags" : [ "clients" ],
6086 "x-path-item-properties" : {
6087 "required-access-tier" : "INTERNAL"
6088 }
6089 }
6090 },
6091 "/clients/{id}/relationships/owners" : {
6092 "get" : {
6093 "description" : "Retrieves owners relationship.",
6094 "parameters" : [ {
6095 "description" : "OAuth client identifier",
6096 "example" : "a468bee88def",
6097 "in" : "path",
6098 "name" : "id",
6099 "required" : true,
6100 "schema" : {
6101 "type" : "string"
6102 }
6103 }, {
6104 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
6105 "example" : "owners",
6106 "in" : "query",
6107 "name" : "include",
6108 "required" : false,
6109 "schema" : {
6110 "type" : "array",
6111 "items" : {
6112 "type" : "string",
6113 "example" : "owners"
6114 }
6115 }
6116 }, {
6117 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
6118 "in" : "query",
6119 "name" : "page[cursor]",
6120 "required" : false,
6121 "schema" : {
6122 "type" : "string"
6123 }
6124 } ],
6125 "responses" : {
6126 "200" : {
6127 "content" : {
6128 "application/vnd.api+json" : {
6129 "schema" : {
6130 "$ref" : "#/components/schemas/Clients_Multi_Relationship_Data_Document"
6131 }
6132 }
6133 },
6134 "description" : "Successful response"
6135 },
6136 "400" : {
6137 "$ref" : "#/components/responses/Default400Response"
6138 },
6139 "404" : {
6140 "$ref" : "#/components/responses/Default404Response"
6141 },
6142 "405" : {
6143 "$ref" : "#/components/responses/Default405Response"
6144 },
6145 "406" : {
6146 "$ref" : "#/components/responses/Default406Response"
6147 },
6148 "415" : {
6149 "$ref" : "#/components/responses/Default415Response"
6150 },
6151 "429" : {
6152 "$ref" : "#/components/responses/Default429Response"
6153 },
6154 "500" : {
6155 "$ref" : "#/components/responses/Default500Response"
6156 },
6157 "503" : {
6158 "$ref" : "#/components/responses/Default503Response"
6159 }
6160 },
6161 "security" : [ {
6162 "Authorization_Code_PKCE" : [ "r_usr" ]
6163 } ],
6164 "summary" : "Get owners relationship (\"to-many\").",
6165 "tags" : [ "clients" ],
6166 "x-path-item-properties" : {
6167 "required-access-tier" : "INTERNAL"
6168 }
6169 }
6170 },
6171 "/collaborationInviteRedemptions" : {
6172 "post" : {
6173 "description" : "Creates a new collaborationInviteRedemption.",
6174 "parameters" : [ {
6175 "$ref" : "#/components/parameters/IdempotencyKey"
6176 } ],
6177 "requestBody" : {
6178 "content" : {
6179 "application/vnd.api+json" : {
6180 "schema" : {
6181 "$ref" : "#/components/schemas/CollaborationInviteRedemptionsCreateOperation_Payload"
6182 }
6183 }
6184 }
6185 },
6186 "responses" : {
6187 "201" : {
6188 "content" : {
6189 "application/vnd.api+json" : {
6190 "schema" : {
6191 "$ref" : "#/components/schemas/CollaborationInviteRedemptions_Create_Single_Resource_Data_Document"
6192 }
6193 }
6194 },
6195 "description" : "Successful response"
6196 },
6197 "400" : {
6198 "$ref" : "#/components/responses/Default400Response"
6199 },
6200 "404" : {
6201 "$ref" : "#/components/responses/Default404Response"
6202 },
6203 "405" : {
6204 "$ref" : "#/components/responses/Default405Response"
6205 },
6206 "406" : {
6207 "$ref" : "#/components/responses/Default406Response"
6208 },
6209 "409" : {
6210 "$ref" : "#/components/responses/Idempotency409Response"
6211 },
6212 "415" : {
6213 "$ref" : "#/components/responses/Default415Response"
6214 },
6215 "422" : {
6216 "$ref" : "#/components/responses/Idempotency422Response"
6217 },
6218 "429" : {
6219 "$ref" : "#/components/responses/Default429Response"
6220 },
6221 "500" : {
6222 "$ref" : "#/components/responses/Default500Response"
6223 },
6224 "503" : {
6225 "$ref" : "#/components/responses/Default503Response"
6226 }
6227 },
6228 "security" : [ {
6229 "Authorization_Code_PKCE" : [ "playlists.write", "w_usr" ]
6230 } ],
6231 "summary" : "Create single collaborationInviteRedemption.",
6232 "tags" : [ "collaborationInviteRedemptions" ],
6233 "x-path-item-properties" : {
6234 "required-access-tier" : "INTERNAL"
6235 }
6236 }
6237 },
6238 "/collaborationInvites" : {
6239 "get" : {
6240 "description" : "Retrieves multiple collaborationInvites by available filters, or without if applicable.",
6241 "parameters" : [ {
6242 "description" : "Invite code",
6243 "in" : "query",
6244 "name" : "filter[code]",
6245 "required" : true,
6246 "schema" : {
6247 "type" : "array",
6248 "items" : {
6249 "type" : "string"
6250 }
6251 }
6252 }, {
6253 "description" : "Allows the client to customize which related resources should be returned. Available options: owners, subject",
6254 "example" : "subject.items",
6255 "in" : "query",
6256 "name" : "include",
6257 "required" : false,
6258 "schema" : {
6259 "type" : "array",
6260 "items" : {
6261 "type" : "string",
6262 "example" : "subject.items"
6263 }
6264 }
6265 }, {
6266 "description" : "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",
6267 "example" : "subject.items",
6268 "in" : "query",
6269 "name" : "replaceMedia",
6270 "required" : false,
6271 "schema" : {
6272 "type" : "string",
6273 "example" : "subject.items"
6274 }
6275 } ],
6276 "responses" : {
6277 "200" : {
6278 "content" : {
6279 "application/vnd.api+json" : {
6280 "schema" : {
6281 "$ref" : "#/components/schemas/CollaborationInvites_Multi_Resource_Data_Document"
6282 }
6283 }
6284 },
6285 "description" : "Successful response"
6286 },
6287 "400" : {
6288 "$ref" : "#/components/responses/Default400Response"
6289 },
6290 "404" : {
6291 "$ref" : "#/components/responses/Default404Response"
6292 },
6293 "405" : {
6294 "$ref" : "#/components/responses/Default405Response"
6295 },
6296 "406" : {
6297 "$ref" : "#/components/responses/Default406Response"
6298 },
6299 "415" : {
6300 "$ref" : "#/components/responses/Default415Response"
6301 },
6302 "429" : {
6303 "$ref" : "#/components/responses/Default429Response"
6304 },
6305 "500" : {
6306 "$ref" : "#/components/responses/Default500Response"
6307 },
6308 "503" : {
6309 "$ref" : "#/components/responses/Default503Response"
6310 }
6311 },
6312 "security" : [ {
6313 "Authorization_Code_PKCE" : [ ]
6314 } ],
6315 "summary" : "Get multiple collaborationInvites.",
6316 "tags" : [ "collaborationInvites" ],
6317 "x-path-item-properties" : {
6318 "required-access-tier" : "INTERNAL"
6319 }
6320 },
6321 "post" : {
6322 "description" : "Creates a new collaborationInvite.",
6323 "parameters" : [ {
6324 "$ref" : "#/components/parameters/IdempotencyKey"
6325 } ],
6326 "requestBody" : {
6327 "content" : {
6328 "application/vnd.api+json" : {
6329 "schema" : {
6330 "$ref" : "#/components/schemas/CollaborationInvitesCreateOperation_Payload"
6331 }
6332 }
6333 }
6334 },
6335 "responses" : {
6336 "201" : {
6337 "content" : {
6338 "application/vnd.api+json" : {
6339 "schema" : {
6340 "$ref" : "#/components/schemas/CollaborationInvites_Create_Single_Resource_Data_Document"
6341 }
6342 }
6343 },
6344 "description" : "Successful response"
6345 },
6346 "400" : {
6347 "$ref" : "#/components/responses/Default400Response"
6348 },
6349 "404" : {
6350 "$ref" : "#/components/responses/Default404Response"
6351 },
6352 "405" : {
6353 "$ref" : "#/components/responses/Default405Response"
6354 },
6355 "406" : {
6356 "$ref" : "#/components/responses/Default406Response"
6357 },
6358 "409" : {
6359 "$ref" : "#/components/responses/Idempotency409Response"
6360 },
6361 "415" : {
6362 "$ref" : "#/components/responses/Default415Response"
6363 },
6364 "422" : {
6365 "$ref" : "#/components/responses/Idempotency422Response"
6366 },
6367 "429" : {
6368 "$ref" : "#/components/responses/Default429Response"
6369 },
6370 "500" : {
6371 "$ref" : "#/components/responses/Default500Response"
6372 },
6373 "503" : {
6374 "$ref" : "#/components/responses/Default503Response"
6375 }
6376 },
6377 "security" : [ {
6378 "Authorization_Code_PKCE" : [ "playlists.write", "w_usr" ]
6379 } ],
6380 "summary" : "Create single collaborationInvite.",
6381 "tags" : [ "collaborationInvites" ],
6382 "x-path-item-properties" : {
6383 "required-access-tier" : "INTERNAL"
6384 }
6385 }
6386 },
6387 "/collaborationInvites/{id}" : {
6388 "delete" : {
6389 "description" : "Deletes existing collaborationInvite.",
6390 "parameters" : [ {
6391 "description" : "Collaboration invite id",
6392 "example" : "550e8400-e29b-41d4-a716-446655440000",
6393 "in" : "path",
6394 "name" : "id",
6395 "required" : true,
6396 "schema" : {
6397 "type" : "string"
6398 }
6399 }, {
6400 "$ref" : "#/components/parameters/IdempotencyKey"
6401 } ],
6402 "responses" : {
6403 "400" : {
6404 "$ref" : "#/components/responses/Default400Response"
6405 },
6406 "404" : {
6407 "$ref" : "#/components/responses/Default404Response"
6408 },
6409 "405" : {
6410 "$ref" : "#/components/responses/Default405Response"
6411 },
6412 "406" : {
6413 "$ref" : "#/components/responses/Default406Response"
6414 },
6415 "409" : {
6416 "$ref" : "#/components/responses/Idempotency409Response"
6417 },
6418 "415" : {
6419 "$ref" : "#/components/responses/Default415Response"
6420 },
6421 "422" : {
6422 "$ref" : "#/components/responses/Idempotency422Response"
6423 },
6424 "429" : {
6425 "$ref" : "#/components/responses/Default429Response"
6426 },
6427 "500" : {
6428 "$ref" : "#/components/responses/Default500Response"
6429 },
6430 "503" : {
6431 "$ref" : "#/components/responses/Default503Response"
6432 }
6433 },
6434 "security" : [ {
6435 "Authorization_Code_PKCE" : [ "playlists.write", "w_usr" ]
6436 } ],
6437 "summary" : "Delete single collaborationInvite.",
6438 "tags" : [ "collaborationInvites" ],
6439 "x-path-item-properties" : {
6440 "required-access-tier" : "INTERNAL"
6441 }
6442 },
6443 "get" : {
6444 "description" : "Retrieves single collaborationInvite by id.",
6445 "parameters" : [ {
6446 "description" : "Collaboration invite id",
6447 "example" : "550e8400-e29b-41d4-a716-446655440000",
6448 "in" : "path",
6449 "name" : "id",
6450 "required" : true,
6451 "schema" : {
6452 "type" : "string"
6453 }
6454 }, {
6455 "description" : "Allows the client to customize which related resources should be returned. Available options: owners, subject",
6456 "example" : "subject.items",
6457 "in" : "query",
6458 "name" : "include",
6459 "required" : false,
6460 "schema" : {
6461 "type" : "array",
6462 "items" : {
6463 "type" : "string",
6464 "example" : "subject.items"
6465 }
6466 }
6467 }, {
6468 "description" : "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",
6469 "example" : "subject.items",
6470 "in" : "query",
6471 "name" : "replaceMedia",
6472 "required" : false,
6473 "schema" : {
6474 "type" : "string",
6475 "example" : "subject.items"
6476 }
6477 } ],
6478 "responses" : {
6479 "200" : {
6480 "content" : {
6481 "application/vnd.api+json" : {
6482 "schema" : {
6483 "$ref" : "#/components/schemas/CollaborationInvites_Single_Resource_Data_Document"
6484 }
6485 }
6486 },
6487 "description" : "Successful response"
6488 },
6489 "400" : {
6490 "$ref" : "#/components/responses/Default400Response"
6491 },
6492 "404" : {
6493 "$ref" : "#/components/responses/Default404Response"
6494 },
6495 "405" : {
6496 "$ref" : "#/components/responses/Default405Response"
6497 },
6498 "406" : {
6499 "$ref" : "#/components/responses/Default406Response"
6500 },
6501 "415" : {
6502 "$ref" : "#/components/responses/Default415Response"
6503 },
6504 "429" : {
6505 "$ref" : "#/components/responses/Default429Response"
6506 },
6507 "500" : {
6508 "$ref" : "#/components/responses/Default500Response"
6509 },
6510 "503" : {
6511 "$ref" : "#/components/responses/Default503Response"
6512 }
6513 },
6514 "security" : [ {
6515 "Authorization_Code_PKCE" : [ ]
6516 } ],
6517 "summary" : "Get single collaborationInvite.",
6518 "tags" : [ "collaborationInvites" ],
6519 "x-path-item-properties" : {
6520 "required-access-tier" : "INTERNAL"
6521 }
6522 }
6523 },
6524 "/collaborationInvites/{id}/relationships/owners" : {
6525 "get" : {
6526 "description" : "Retrieves owners relationship.",
6527 "parameters" : [ {
6528 "description" : "Collaboration invite id",
6529 "example" : "550e8400-e29b-41d4-a716-446655440000",
6530 "in" : "path",
6531 "name" : "id",
6532 "required" : true,
6533 "schema" : {
6534 "type" : "string"
6535 }
6536 }, {
6537 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
6538 "example" : "owners",
6539 "in" : "query",
6540 "name" : "include",
6541 "required" : false,
6542 "schema" : {
6543 "type" : "array",
6544 "items" : {
6545 "type" : "string",
6546 "example" : "owners"
6547 }
6548 }
6549 }, {
6550 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
6551 "in" : "query",
6552 "name" : "page[cursor]",
6553 "required" : false,
6554 "schema" : {
6555 "type" : "string"
6556 }
6557 } ],
6558 "responses" : {
6559 "200" : {
6560 "content" : {
6561 "application/vnd.api+json" : {
6562 "schema" : {
6563 "$ref" : "#/components/schemas/CollaborationInvites_Multi_Relationship_Data_Document"
6564 }
6565 }
6566 },
6567 "description" : "Successful response"
6568 },
6569 "400" : {
6570 "$ref" : "#/components/responses/Default400Response"
6571 },
6572 "404" : {
6573 "$ref" : "#/components/responses/Default404Response"
6574 },
6575 "405" : {
6576 "$ref" : "#/components/responses/Default405Response"
6577 },
6578 "406" : {
6579 "$ref" : "#/components/responses/Default406Response"
6580 },
6581 "415" : {
6582 "$ref" : "#/components/responses/Default415Response"
6583 },
6584 "429" : {
6585 "$ref" : "#/components/responses/Default429Response"
6586 },
6587 "500" : {
6588 "$ref" : "#/components/responses/Default500Response"
6589 },
6590 "503" : {
6591 "$ref" : "#/components/responses/Default503Response"
6592 }
6593 },
6594 "security" : [ {
6595 "Authorization_Code_PKCE" : [ ]
6596 } ],
6597 "summary" : "Get owners relationship (\"to-many\").",
6598 "tags" : [ "collaborationInvites" ],
6599 "x-path-item-properties" : {
6600 "required-access-tier" : "INTERNAL"
6601 }
6602 }
6603 },
6604 "/collaborationInvites/{id}/relationships/subject" : {
6605 "get" : {
6606 "description" : "Retrieves subject relationship.",
6607 "parameters" : [ {
6608 "description" : "Collaboration invite id",
6609 "example" : "550e8400-e29b-41d4-a716-446655440000",
6610 "in" : "path",
6611 "name" : "id",
6612 "required" : true,
6613 "schema" : {
6614 "type" : "string"
6615 }
6616 }, {
6617 "description" : "Allows the client to customize which related resources should be returned. Available options: subject",
6618 "example" : "subject.items",
6619 "in" : "query",
6620 "name" : "include",
6621 "required" : false,
6622 "schema" : {
6623 "type" : "array",
6624 "items" : {
6625 "type" : "string",
6626 "example" : "subject.items"
6627 }
6628 }
6629 }, {
6630 "description" : "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",
6631 "example" : "subject.items",
6632 "in" : "query",
6633 "name" : "replaceMedia",
6634 "required" : false,
6635 "schema" : {
6636 "type" : "string",
6637 "example" : "subject.items"
6638 }
6639 } ],
6640 "responses" : {
6641 "200" : {
6642 "content" : {
6643 "application/vnd.api+json" : {
6644 "schema" : {
6645 "$ref" : "#/components/schemas/CollaborationInvites_Single_Relationship_Data_Document"
6646 }
6647 }
6648 },
6649 "description" : "Successful response"
6650 },
6651 "400" : {
6652 "$ref" : "#/components/responses/Default400Response"
6653 },
6654 "404" : {
6655 "$ref" : "#/components/responses/Default404Response"
6656 },
6657 "405" : {
6658 "$ref" : "#/components/responses/Default405Response"
6659 },
6660 "406" : {
6661 "$ref" : "#/components/responses/Default406Response"
6662 },
6663 "415" : {
6664 "$ref" : "#/components/responses/Default415Response"
6665 },
6666 "429" : {
6667 "$ref" : "#/components/responses/Default429Response"
6668 },
6669 "500" : {
6670 "$ref" : "#/components/responses/Default500Response"
6671 },
6672 "503" : {
6673 "$ref" : "#/components/responses/Default503Response"
6674 }
6675 },
6676 "security" : [ {
6677 "Authorization_Code_PKCE" : [ ]
6678 } ],
6679 "summary" : "Get subject relationship (\"to-one\").",
6680 "tags" : [ "collaborationInvites" ],
6681 "x-path-item-properties" : {
6682 "required-access-tier" : "INTERNAL"
6683 }
6684 }
6685 },
6686 "/comments" : {
6687 "get" : {
6688 "description" : "Retrieves multiple comments by available filters, or without if applicable.",
6689 "parameters" : [ {
6690 "description" : "Filter by subject resource ID (e.g. `12345`)",
6691 "in" : "query",
6692 "name" : "filter[subject.id]",
6693 "required" : true,
6694 "schema" : {
6695 "type" : "array",
6696 "items" : {
6697 "type" : "string"
6698 }
6699 }
6700 }, {
6701 "description" : "Filter by subject resource type (e.g. `albums`)",
6702 "in" : "query",
6703 "name" : "filter[subject.type]",
6704 "required" : true,
6705 "schema" : {
6706 "type" : "array",
6707 "items" : {
6708 "type" : "string",
6709 "enum" : [ "albums", "tracks" ]
6710 }
6711 }
6712 }, {
6713 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
6714 "in" : "query",
6715 "name" : "page[cursor]",
6716 "required" : false,
6717 "schema" : {
6718 "type" : "string"
6719 }
6720 }, {
6721 "description" : "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
6722 "in" : "query",
6723 "name" : "sort",
6724 "required" : false,
6725 "schema" : {
6726 "type" : "array",
6727 "items" : {
6728 "type" : "string",
6729 "example" : "createdAt",
6730 "default" : "-createdAt",
6731 "enum" : [ "createdAt", "-createdAt", "likeCount", "-likeCount", "replyCount", "-replyCount", "startTime", "-startTime" ],
6732 "x-enum-varnames" : [ "CreatedAtAsc", "CreatedAtDesc", "LikeCountAsc", "LikeCountDesc", "ReplyCountAsc", "ReplyCountDesc", "StartTimeAsc", "StartTimeDesc" ]
6733 }
6734 }
6735 }, {
6736 "description" : "Allows the client to customize which related resources should be returned. Available options: ownerProfiles, owners, parentComment",
6737 "example" : "ownerProfiles",
6738 "in" : "query",
6739 "name" : "include",
6740 "required" : false,
6741 "schema" : {
6742 "type" : "array",
6743 "items" : {
6744 "type" : "string",
6745 "example" : "ownerProfiles"
6746 }
6747 }
6748 }, {
6749 "description" : "Filter by parent comment ID to get replies (e.g. `550e8400-e29b-41d4-a716-446655440000`)",
6750 "in" : "query",
6751 "name" : "filter[parentComment.id]",
6752 "required" : false,
6753 "schema" : {
6754 "type" : "array",
6755 "items" : {
6756 "type" : "string"
6757 }
6758 }
6759 } ],
6760 "responses" : {
6761 "200" : {
6762 "content" : {
6763 "application/vnd.api+json" : {
6764 "schema" : {
6765 "$ref" : "#/components/schemas/Comments_Multi_Resource_Data_Document"
6766 }
6767 }
6768 },
6769 "description" : "Successful response"
6770 },
6771 "400" : {
6772 "$ref" : "#/components/responses/Default400Response"
6773 },
6774 "404" : {
6775 "$ref" : "#/components/responses/Default404Response"
6776 },
6777 "405" : {
6778 "$ref" : "#/components/responses/Default405Response"
6779 },
6780 "406" : {
6781 "$ref" : "#/components/responses/Default406Response"
6782 },
6783 "415" : {
6784 "$ref" : "#/components/responses/Default415Response"
6785 },
6786 "429" : {
6787 "$ref" : "#/components/responses/Default429Response"
6788 },
6789 "500" : {
6790 "$ref" : "#/components/responses/Default500Response"
6791 },
6792 "503" : {
6793 "$ref" : "#/components/responses/Default503Response"
6794 }
6795 },
6796 "security" : [ {
6797 "Authorization_Code_PKCE" : [ ]
6798 } ],
6799 "summary" : "Get multiple comments.",
6800 "tags" : [ "comments" ],
6801 "x-path-item-properties" : {
6802 "required-access-tier" : "INTERNAL"
6803 }
6804 },
6805 "post" : {
6806 "description" : "Creates a new comment.",
6807 "parameters" : [ {
6808 "$ref" : "#/components/parameters/IdempotencyKey"
6809 } ],
6810 "requestBody" : {
6811 "content" : {
6812 "application/vnd.api+json" : {
6813 "schema" : {
6814 "$ref" : "#/components/schemas/CommentsCreateOperation_Payload"
6815 }
6816 }
6817 }
6818 },
6819 "responses" : {
6820 "201" : {
6821 "content" : {
6822 "application/vnd.api+json" : {
6823 "schema" : {
6824 "$ref" : "#/components/schemas/Comments_Create_Single_Resource_Data_Document"
6825 }
6826 }
6827 },
6828 "description" : "Successful response"
6829 },
6830 "400" : {
6831 "$ref" : "#/components/responses/Default400Response"
6832 },
6833 "404" : {
6834 "$ref" : "#/components/responses/Default404Response"
6835 },
6836 "405" : {
6837 "$ref" : "#/components/responses/Default405Response"
6838 },
6839 "406" : {
6840 "$ref" : "#/components/responses/Default406Response"
6841 },
6842 "409" : {
6843 "$ref" : "#/components/responses/Idempotency409Response"
6844 },
6845 "415" : {
6846 "$ref" : "#/components/responses/Default415Response"
6847 },
6848 "422" : {
6849 "$ref" : "#/components/responses/Idempotency422Response"
6850 },
6851 "429" : {
6852 "$ref" : "#/components/responses/Default429Response"
6853 },
6854 "500" : {
6855 "$ref" : "#/components/responses/Default500Response"
6856 },
6857 "503" : {
6858 "$ref" : "#/components/responses/Default503Response"
6859 }
6860 },
6861 "security" : [ {
6862 "Authorization_Code_PKCE" : [ "w_usr" ]
6863 } ],
6864 "summary" : "Create single comment.",
6865 "tags" : [ "comments" ],
6866 "x-path-item-properties" : {
6867 "required-access-tier" : "INTERNAL"
6868 }
6869 }
6870 },
6871 "/comments/{id}" : {
6872 "delete" : {
6873 "description" : "Deletes existing comment.",
6874 "parameters" : [ {
6875 "description" : "Comment Id",
6876 "example" : "550e8400-e29b-41d4-a716-446655440000",
6877 "in" : "path",
6878 "name" : "id",
6879 "required" : true,
6880 "schema" : {
6881 "type" : "string"
6882 }
6883 }, {
6884 "$ref" : "#/components/parameters/IdempotencyKey"
6885 } ],
6886 "responses" : {
6887 "400" : {
6888 "$ref" : "#/components/responses/Default400Response"
6889 },
6890 "404" : {
6891 "$ref" : "#/components/responses/Default404Response"
6892 },
6893 "405" : {
6894 "$ref" : "#/components/responses/Default405Response"
6895 },
6896 "406" : {
6897 "$ref" : "#/components/responses/Default406Response"
6898 },
6899 "409" : {
6900 "$ref" : "#/components/responses/Idempotency409Response"
6901 },
6902 "415" : {
6903 "$ref" : "#/components/responses/Default415Response"
6904 },
6905 "422" : {
6906 "$ref" : "#/components/responses/Idempotency422Response"
6907 },
6908 "429" : {
6909 "$ref" : "#/components/responses/Default429Response"
6910 },
6911 "500" : {
6912 "$ref" : "#/components/responses/Default500Response"
6913 },
6914 "503" : {
6915 "$ref" : "#/components/responses/Default503Response"
6916 }
6917 },
6918 "security" : [ {
6919 "Authorization_Code_PKCE" : [ "w_usr" ]
6920 } ],
6921 "summary" : "Delete single comment.",
6922 "tags" : [ "comments" ],
6923 "x-path-item-properties" : {
6924 "required-access-tier" : "INTERNAL"
6925 }
6926 },
6927 "get" : {
6928 "description" : "Retrieves single comment by id.",
6929 "parameters" : [ {
6930 "description" : "Comment Id",
6931 "example" : "550e8400-e29b-41d4-a716-446655440000",
6932 "in" : "path",
6933 "name" : "id",
6934 "required" : true,
6935 "schema" : {
6936 "type" : "string"
6937 }
6938 }, {
6939 "description" : "Allows the client to customize which related resources should be returned. Available options: ownerProfiles, owners, parentComment",
6940 "example" : "ownerProfiles",
6941 "in" : "query",
6942 "name" : "include",
6943 "required" : false,
6944 "schema" : {
6945 "type" : "array",
6946 "items" : {
6947 "type" : "string",
6948 "example" : "ownerProfiles"
6949 }
6950 }
6951 } ],
6952 "responses" : {
6953 "200" : {
6954 "content" : {
6955 "application/vnd.api+json" : {
6956 "schema" : {
6957 "$ref" : "#/components/schemas/Comments_Single_Resource_Data_Document"
6958 }
6959 }
6960 },
6961 "description" : "Successful response"
6962 },
6963 "400" : {
6964 "$ref" : "#/components/responses/Default400Response"
6965 },
6966 "404" : {
6967 "$ref" : "#/components/responses/Default404Response"
6968 },
6969 "405" : {
6970 "$ref" : "#/components/responses/Default405Response"
6971 },
6972 "406" : {
6973 "$ref" : "#/components/responses/Default406Response"
6974 },
6975 "415" : {
6976 "$ref" : "#/components/responses/Default415Response"
6977 },
6978 "429" : {
6979 "$ref" : "#/components/responses/Default429Response"
6980 },
6981 "500" : {
6982 "$ref" : "#/components/responses/Default500Response"
6983 },
6984 "503" : {
6985 "$ref" : "#/components/responses/Default503Response"
6986 }
6987 },
6988 "security" : [ {
6989 "Authorization_Code_PKCE" : [ ]
6990 } ],
6991 "summary" : "Get single comment.",
6992 "tags" : [ "comments" ],
6993 "x-path-item-properties" : {
6994 "required-access-tier" : "INTERNAL"
6995 }
6996 },
6997 "patch" : {
6998 "description" : "Updates existing comment.",
6999 "parameters" : [ {
7000 "description" : "Comment Id",
7001 "example" : "550e8400-e29b-41d4-a716-446655440000",
7002 "in" : "path",
7003 "name" : "id",
7004 "required" : true,
7005 "schema" : {
7006 "type" : "string"
7007 }
7008 }, {
7009 "$ref" : "#/components/parameters/IdempotencyKey"
7010 } ],
7011 "requestBody" : {
7012 "content" : {
7013 "application/vnd.api+json" : {
7014 "schema" : {
7015 "$ref" : "#/components/schemas/CommentsUpdateOperation_Payload"
7016 }
7017 }
7018 }
7019 },
7020 "responses" : {
7021 "400" : {
7022 "$ref" : "#/components/responses/Default400Response"
7023 },
7024 "404" : {
7025 "$ref" : "#/components/responses/Default404Response"
7026 },
7027 "405" : {
7028 "$ref" : "#/components/responses/Default405Response"
7029 },
7030 "406" : {
7031 "$ref" : "#/components/responses/Default406Response"
7032 },
7033 "409" : {
7034 "$ref" : "#/components/responses/Idempotency409Response"
7035 },
7036 "415" : {
7037 "$ref" : "#/components/responses/Default415Response"
7038 },
7039 "422" : {
7040 "$ref" : "#/components/responses/Idempotency422Response"
7041 },
7042 "429" : {
7043 "$ref" : "#/components/responses/Default429Response"
7044 },
7045 "500" : {
7046 "$ref" : "#/components/responses/Default500Response"
7047 },
7048 "503" : {
7049 "$ref" : "#/components/responses/Default503Response"
7050 }
7051 },
7052 "security" : [ {
7053 "Authorization_Code_PKCE" : [ "w_usr" ]
7054 } ],
7055 "summary" : "Update single comment.",
7056 "tags" : [ "comments" ],
7057 "x-path-item-properties" : {
7058 "required-access-tier" : "INTERNAL"
7059 }
7060 }
7061 },
7062 "/comments/{id}/relationships/ownerProfiles" : {
7063 "get" : {
7064 "description" : "Retrieves ownerProfiles relationship.",
7065 "parameters" : [ {
7066 "description" : "Comment Id",
7067 "example" : "550e8400-e29b-41d4-a716-446655440000",
7068 "in" : "path",
7069 "name" : "id",
7070 "required" : true,
7071 "schema" : {
7072 "type" : "string"
7073 }
7074 }, {
7075 "description" : "Allows the client to customize which related resources should be returned. Available options: ownerProfiles",
7076 "example" : "ownerProfiles",
7077 "in" : "query",
7078 "name" : "include",
7079 "required" : false,
7080 "schema" : {
7081 "type" : "array",
7082 "items" : {
7083 "type" : "string",
7084 "example" : "ownerProfiles"
7085 }
7086 }
7087 }, {
7088 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
7089 "in" : "query",
7090 "name" : "page[cursor]",
7091 "required" : false,
7092 "schema" : {
7093 "type" : "string"
7094 }
7095 } ],
7096 "responses" : {
7097 "200" : {
7098 "content" : {
7099 "application/vnd.api+json" : {
7100 "schema" : {
7101 "$ref" : "#/components/schemas/Comments_Multi_Relationship_Data_Document"
7102 }
7103 }
7104 },
7105 "description" : "Successful response"
7106 },
7107 "400" : {
7108 "$ref" : "#/components/responses/Default400Response"
7109 },
7110 "404" : {
7111 "$ref" : "#/components/responses/Default404Response"
7112 },
7113 "405" : {
7114 "$ref" : "#/components/responses/Default405Response"
7115 },
7116 "406" : {
7117 "$ref" : "#/components/responses/Default406Response"
7118 },
7119 "415" : {
7120 "$ref" : "#/components/responses/Default415Response"
7121 },
7122 "429" : {
7123 "$ref" : "#/components/responses/Default429Response"
7124 },
7125 "500" : {
7126 "$ref" : "#/components/responses/Default500Response"
7127 },
7128 "503" : {
7129 "$ref" : "#/components/responses/Default503Response"
7130 }
7131 },
7132 "security" : [ {
7133 "Authorization_Code_PKCE" : [ ]
7134 } ],
7135 "summary" : "Get ownerProfiles relationship (\"to-many\").",
7136 "tags" : [ "comments" ],
7137 "x-path-item-properties" : {
7138 "required-access-tier" : "INTERNAL"
7139 }
7140 }
7141 },
7142 "/comments/{id}/relationships/owners" : {
7143 "get" : {
7144 "description" : "Retrieves owners relationship.",
7145 "parameters" : [ {
7146 "description" : "Comment Id",
7147 "example" : "550e8400-e29b-41d4-a716-446655440000",
7148 "in" : "path",
7149 "name" : "id",
7150 "required" : true,
7151 "schema" : {
7152 "type" : "string"
7153 }
7154 }, {
7155 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
7156 "example" : "owners",
7157 "in" : "query",
7158 "name" : "include",
7159 "required" : false,
7160 "schema" : {
7161 "type" : "array",
7162 "items" : {
7163 "type" : "string",
7164 "example" : "owners"
7165 }
7166 }
7167 }, {
7168 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
7169 "in" : "query",
7170 "name" : "page[cursor]",
7171 "required" : false,
7172 "schema" : {
7173 "type" : "string"
7174 }
7175 } ],
7176 "responses" : {
7177 "200" : {
7178 "content" : {
7179 "application/vnd.api+json" : {
7180 "schema" : {
7181 "$ref" : "#/components/schemas/Comments_Multi_Relationship_Data_Document"
7182 }
7183 }
7184 },
7185 "description" : "Successful response"
7186 },
7187 "400" : {
7188 "$ref" : "#/components/responses/Default400Response"
7189 },
7190 "404" : {
7191 "$ref" : "#/components/responses/Default404Response"
7192 },
7193 "405" : {
7194 "$ref" : "#/components/responses/Default405Response"
7195 },
7196 "406" : {
7197 "$ref" : "#/components/responses/Default406Response"
7198 },
7199 "415" : {
7200 "$ref" : "#/components/responses/Default415Response"
7201 },
7202 "429" : {
7203 "$ref" : "#/components/responses/Default429Response"
7204 },
7205 "500" : {
7206 "$ref" : "#/components/responses/Default500Response"
7207 },
7208 "503" : {
7209 "$ref" : "#/components/responses/Default503Response"
7210 }
7211 },
7212 "security" : [ {
7213 "Authorization_Code_PKCE" : [ ]
7214 } ],
7215 "summary" : "Get owners relationship (\"to-many\").",
7216 "tags" : [ "comments" ],
7217 "x-path-item-properties" : {
7218 "required-access-tier" : "INTERNAL"
7219 }
7220 }
7221 },
7222 "/comments/{id}/relationships/parentComment" : {
7223 "get" : {
7224 "description" : "Retrieves parentComment relationship.",
7225 "parameters" : [ {
7226 "description" : "Comment Id",
7227 "example" : "550e8400-e29b-41d4-a716-446655440000",
7228 "in" : "path",
7229 "name" : "id",
7230 "required" : true,
7231 "schema" : {
7232 "type" : "string"
7233 }
7234 }, {
7235 "description" : "Allows the client to customize which related resources should be returned. Available options: parentComment",
7236 "example" : "parentComment",
7237 "in" : "query",
7238 "name" : "include",
7239 "required" : false,
7240 "schema" : {
7241 "type" : "array",
7242 "items" : {
7243 "type" : "string",
7244 "example" : "parentComment"
7245 }
7246 }
7247 } ],
7248 "responses" : {
7249 "200" : {
7250 "content" : {
7251 "application/vnd.api+json" : {
7252 "schema" : {
7253 "$ref" : "#/components/schemas/Comments_Single_Relationship_Data_Document"
7254 }
7255 }
7256 },
7257 "description" : "Successful response"
7258 },
7259 "400" : {
7260 "$ref" : "#/components/responses/Default400Response"
7261 },
7262 "404" : {
7263 "$ref" : "#/components/responses/Default404Response"
7264 },
7265 "405" : {
7266 "$ref" : "#/components/responses/Default405Response"
7267 },
7268 "406" : {
7269 "$ref" : "#/components/responses/Default406Response"
7270 },
7271 "415" : {
7272 "$ref" : "#/components/responses/Default415Response"
7273 },
7274 "429" : {
7275 "$ref" : "#/components/responses/Default429Response"
7276 },
7277 "500" : {
7278 "$ref" : "#/components/responses/Default500Response"
7279 },
7280 "503" : {
7281 "$ref" : "#/components/responses/Default503Response"
7282 }
7283 },
7284 "security" : [ {
7285 "Authorization_Code_PKCE" : [ ]
7286 } ],
7287 "summary" : "Get parentComment relationship (\"to-one\").",
7288 "tags" : [ "comments" ],
7289 "x-path-item-properties" : {
7290 "required-access-tier" : "INTERNAL"
7291 }
7292 }
7293 },
7294 "/contentClaims" : {
7295 "get" : {
7296 "description" : "Retrieves multiple contentClaims by available filters, or without if applicable.",
7297 "parameters" : [ {
7298 "description" : "User id. Use `me` for the authenticated user",
7299 "in" : "query",
7300 "name" : "filter[owners.id]",
7301 "required" : true,
7302 "schema" : {
7303 "type" : "array",
7304 "items" : {
7305 "type" : "string"
7306 }
7307 }
7308 }, {
7309 "description" : "Allows the client to customize which related resources should be returned. Available options: claimedResource, claimingArtist, owners",
7310 "example" : "claimedResource",
7311 "in" : "query",
7312 "name" : "include",
7313 "required" : false,
7314 "schema" : {
7315 "type" : "array",
7316 "items" : {
7317 "type" : "string",
7318 "example" : "claimedResource"
7319 }
7320 }
7321 }, {
7322 "description" : "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",
7323 "example" : "claimedResource",
7324 "in" : "query",
7325 "name" : "replaceMedia",
7326 "required" : false,
7327 "schema" : {
7328 "type" : "string",
7329 "example" : "claimedResource"
7330 }
7331 } ],
7332 "responses" : {
7333 "200" : {
7334 "content" : {
7335 "application/vnd.api+json" : {
7336 "schema" : {
7337 "$ref" : "#/components/schemas/ContentClaims_Multi_Resource_Data_Document"
7338 }
7339 }
7340 },
7341 "description" : "Successful response"
7342 },
7343 "400" : {
7344 "$ref" : "#/components/responses/Default400Response"
7345 },
7346 "404" : {
7347 "$ref" : "#/components/responses/Default404Response"
7348 },
7349 "405" : {
7350 "$ref" : "#/components/responses/Default405Response"
7351 },
7352 "406" : {
7353 "$ref" : "#/components/responses/Default406Response"
7354 },
7355 "415" : {
7356 "$ref" : "#/components/responses/Default415Response"
7357 },
7358 "429" : {
7359 "$ref" : "#/components/responses/Default429Response"
7360 },
7361 "500" : {
7362 "$ref" : "#/components/responses/Default500Response"
7363 },
7364 "503" : {
7365 "$ref" : "#/components/responses/Default503Response"
7366 }
7367 },
7368 "security" : [ {
7369 "Authorization_Code_PKCE" : [ "r_usr" ]
7370 } ],
7371 "summary" : "Get multiple contentClaims.",
7372 "tags" : [ "contentClaims" ],
7373 "x-path-item-properties" : {
7374 "required-access-tier" : "INTERNAL"
7375 }
7376 },
7377 "post" : {
7378 "description" : "Creates a new contentClaim.",
7379 "parameters" : [ {
7380 "$ref" : "#/components/parameters/IdempotencyKey"
7381 } ],
7382 "requestBody" : {
7383 "content" : {
7384 "application/vnd.api+json" : {
7385 "schema" : {
7386 "$ref" : "#/components/schemas/ContentClaimsCreateOperation_Payload"
7387 }
7388 }
7389 }
7390 },
7391 "responses" : {
7392 "201" : {
7393 "content" : {
7394 "application/vnd.api+json" : {
7395 "schema" : {
7396 "$ref" : "#/components/schemas/ContentClaims_Create_Single_Resource_Data_Document"
7397 }
7398 }
7399 },
7400 "description" : "Successful response"
7401 },
7402 "400" : {
7403 "$ref" : "#/components/responses/Default400Response"
7404 },
7405 "404" : {
7406 "$ref" : "#/components/responses/Default404Response"
7407 },
7408 "405" : {
7409 "$ref" : "#/components/responses/Default405Response"
7410 },
7411 "406" : {
7412 "$ref" : "#/components/responses/Default406Response"
7413 },
7414 "409" : {
7415 "$ref" : "#/components/responses/Idempotency409Response"
7416 },
7417 "415" : {
7418 "$ref" : "#/components/responses/Default415Response"
7419 },
7420 "422" : {
7421 "$ref" : "#/components/responses/Idempotency422Response"
7422 },
7423 "429" : {
7424 "$ref" : "#/components/responses/Default429Response"
7425 },
7426 "500" : {
7427 "$ref" : "#/components/responses/Default500Response"
7428 },
7429 "503" : {
7430 "$ref" : "#/components/responses/Default503Response"
7431 }
7432 },
7433 "security" : [ {
7434 "Authorization_Code_PKCE" : [ "w_usr" ]
7435 } ],
7436 "summary" : "Create single contentClaim.",
7437 "tags" : [ "contentClaims" ],
7438 "x-path-item-properties" : {
7439 "required-access-tier" : "INTERNAL"
7440 }
7441 }
7442 },
7443 "/contentClaims/{id}" : {
7444 "get" : {
7445 "description" : "Retrieves single contentClaim by id.",
7446 "parameters" : [ {
7447 "description" : "Content claim id",
7448 "example" : "f47ac10b-58cc-4372-a567-0e02b2c3d479",
7449 "in" : "path",
7450 "name" : "id",
7451 "required" : true,
7452 "schema" : {
7453 "type" : "string"
7454 }
7455 }, {
7456 "description" : "Allows the client to customize which related resources should be returned. Available options: claimedResource, claimingArtist, owners",
7457 "example" : "claimedResource",
7458 "in" : "query",
7459 "name" : "include",
7460 "required" : false,
7461 "schema" : {
7462 "type" : "array",
7463 "items" : {
7464 "type" : "string",
7465 "example" : "claimedResource"
7466 }
7467 }
7468 }, {
7469 "description" : "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",
7470 "example" : "claimedResource",
7471 "in" : "query",
7472 "name" : "replaceMedia",
7473 "required" : false,
7474 "schema" : {
7475 "type" : "string",
7476 "example" : "claimedResource"
7477 }
7478 } ],
7479 "responses" : {
7480 "200" : {
7481 "content" : {
7482 "application/vnd.api+json" : {
7483 "schema" : {
7484 "$ref" : "#/components/schemas/ContentClaims_Single_Resource_Data_Document"
7485 }
7486 }
7487 },
7488 "description" : "Successful response"
7489 },
7490 "400" : {
7491 "$ref" : "#/components/responses/Default400Response"
7492 },
7493 "404" : {
7494 "$ref" : "#/components/responses/Default404Response"
7495 },
7496 "405" : {
7497 "$ref" : "#/components/responses/Default405Response"
7498 },
7499 "406" : {
7500 "$ref" : "#/components/responses/Default406Response"
7501 },
7502 "415" : {
7503 "$ref" : "#/components/responses/Default415Response"
7504 },
7505 "429" : {
7506 "$ref" : "#/components/responses/Default429Response"
7507 },
7508 "500" : {
7509 "$ref" : "#/components/responses/Default500Response"
7510 },
7511 "503" : {
7512 "$ref" : "#/components/responses/Default503Response"
7513 }
7514 },
7515 "security" : [ {
7516 "Authorization_Code_PKCE" : [ "r_usr" ]
7517 } ],
7518 "summary" : "Get single contentClaim.",
7519 "tags" : [ "contentClaims" ],
7520 "x-path-item-properties" : {
7521 "required-access-tier" : "INTERNAL"
7522 }
7523 }
7524 },
7525 "/contentClaims/{id}/relationships/claimedResource" : {
7526 "get" : {
7527 "description" : "Retrieves claimedResource relationship.",
7528 "parameters" : [ {
7529 "description" : "Content claim id",
7530 "example" : "f47ac10b-58cc-4372-a567-0e02b2c3d479",
7531 "in" : "path",
7532 "name" : "id",
7533 "required" : true,
7534 "schema" : {
7535 "type" : "string"
7536 }
7537 }, {
7538 "description" : "Allows the client to customize which related resources should be returned. Available options: claimedResource",
7539 "example" : "claimedResource",
7540 "in" : "query",
7541 "name" : "include",
7542 "required" : false,
7543 "schema" : {
7544 "type" : "array",
7545 "items" : {
7546 "type" : "string",
7547 "example" : "claimedResource"
7548 }
7549 }
7550 }, {
7551 "description" : "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",
7552 "example" : "claimedResource",
7553 "in" : "query",
7554 "name" : "replaceMedia",
7555 "required" : false,
7556 "schema" : {
7557 "type" : "string",
7558 "example" : "claimedResource"
7559 }
7560 } ],
7561 "responses" : {
7562 "200" : {
7563 "content" : {
7564 "application/vnd.api+json" : {
7565 "schema" : {
7566 "$ref" : "#/components/schemas/ContentClaims_Single_Relationship_Data_Document"
7567 }
7568 }
7569 },
7570 "description" : "Successful response"
7571 },
7572 "400" : {
7573 "$ref" : "#/components/responses/Default400Response"
7574 },
7575 "404" : {
7576 "$ref" : "#/components/responses/Default404Response"
7577 },
7578 "405" : {
7579 "$ref" : "#/components/responses/Default405Response"
7580 },
7581 "406" : {
7582 "$ref" : "#/components/responses/Default406Response"
7583 },
7584 "415" : {
7585 "$ref" : "#/components/responses/Default415Response"
7586 },
7587 "429" : {
7588 "$ref" : "#/components/responses/Default429Response"
7589 },
7590 "500" : {
7591 "$ref" : "#/components/responses/Default500Response"
7592 },
7593 "503" : {
7594 "$ref" : "#/components/responses/Default503Response"
7595 }
7596 },
7597 "security" : [ {
7598 "Authorization_Code_PKCE" : [ "r_usr" ]
7599 } ],
7600 "summary" : "Get claimedResource relationship (\"to-one\").",
7601 "tags" : [ "contentClaims" ],
7602 "x-path-item-properties" : {
7603 "required-access-tier" : "INTERNAL"
7604 }
7605 }
7606 },
7607 "/contentClaims/{id}/relationships/claimingArtist" : {
7608 "get" : {
7609 "description" : "Retrieves claimingArtist relationship.",
7610 "parameters" : [ {
7611 "description" : "Content claim id",
7612 "example" : "f47ac10b-58cc-4372-a567-0e02b2c3d479",
7613 "in" : "path",
7614 "name" : "id",
7615 "required" : true,
7616 "schema" : {
7617 "type" : "string"
7618 }
7619 }, {
7620 "description" : "Allows the client to customize which related resources should be returned. Available options: claimingArtist",
7621 "example" : "claimingArtist.albums",
7622 "in" : "query",
7623 "name" : "include",
7624 "required" : false,
7625 "schema" : {
7626 "type" : "array",
7627 "items" : {
7628 "type" : "string",
7629 "example" : "claimingArtist.albums"
7630 }
7631 }
7632 }, {
7633 "description" : "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",
7634 "example" : "claimingArtist.albums",
7635 "in" : "query",
7636 "name" : "replaceMedia",
7637 "required" : false,
7638 "schema" : {
7639 "type" : "string",
7640 "example" : "claimingArtist.albums"
7641 }
7642 } ],
7643 "responses" : {
7644 "200" : {
7645 "content" : {
7646 "application/vnd.api+json" : {
7647 "schema" : {
7648 "$ref" : "#/components/schemas/ContentClaims_Single_Relationship_Data_Document"
7649 }
7650 }
7651 },
7652 "description" : "Successful response"
7653 },
7654 "400" : {
7655 "$ref" : "#/components/responses/Default400Response"
7656 },
7657 "404" : {
7658 "$ref" : "#/components/responses/Default404Response"
7659 },
7660 "405" : {
7661 "$ref" : "#/components/responses/Default405Response"
7662 },
7663 "406" : {
7664 "$ref" : "#/components/responses/Default406Response"
7665 },
7666 "415" : {
7667 "$ref" : "#/components/responses/Default415Response"
7668 },
7669 "429" : {
7670 "$ref" : "#/components/responses/Default429Response"
7671 },
7672 "500" : {
7673 "$ref" : "#/components/responses/Default500Response"
7674 },
7675 "503" : {
7676 "$ref" : "#/components/responses/Default503Response"
7677 }
7678 },
7679 "security" : [ {
7680 "Authorization_Code_PKCE" : [ "r_usr" ]
7681 } ],
7682 "summary" : "Get claimingArtist relationship (\"to-one\").",
7683 "tags" : [ "contentClaims" ],
7684 "x-path-item-properties" : {
7685 "required-access-tier" : "INTERNAL"
7686 }
7687 }
7688 },
7689 "/contentClaims/{id}/relationships/owners" : {
7690 "get" : {
7691 "description" : "Retrieves owners relationship.",
7692 "parameters" : [ {
7693 "description" : "Content claim id",
7694 "example" : "f47ac10b-58cc-4372-a567-0e02b2c3d479",
7695 "in" : "path",
7696 "name" : "id",
7697 "required" : true,
7698 "schema" : {
7699 "type" : "string"
7700 }
7701 }, {
7702 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
7703 "example" : "owners",
7704 "in" : "query",
7705 "name" : "include",
7706 "required" : false,
7707 "schema" : {
7708 "type" : "array",
7709 "items" : {
7710 "type" : "string",
7711 "example" : "owners"
7712 }
7713 }
7714 }, {
7715 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
7716 "in" : "query",
7717 "name" : "page[cursor]",
7718 "required" : false,
7719 "schema" : {
7720 "type" : "string"
7721 }
7722 } ],
7723 "responses" : {
7724 "200" : {
7725 "content" : {
7726 "application/vnd.api+json" : {
7727 "schema" : {
7728 "$ref" : "#/components/schemas/ContentClaims_Multi_Relationship_Data_Document"
7729 }
7730 }
7731 },
7732 "description" : "Successful response"
7733 },
7734 "400" : {
7735 "$ref" : "#/components/responses/Default400Response"
7736 },
7737 "404" : {
7738 "$ref" : "#/components/responses/Default404Response"
7739 },
7740 "405" : {
7741 "$ref" : "#/components/responses/Default405Response"
7742 },
7743 "406" : {
7744 "$ref" : "#/components/responses/Default406Response"
7745 },
7746 "415" : {
7747 "$ref" : "#/components/responses/Default415Response"
7748 },
7749 "429" : {
7750 "$ref" : "#/components/responses/Default429Response"
7751 },
7752 "500" : {
7753 "$ref" : "#/components/responses/Default500Response"
7754 },
7755 "503" : {
7756 "$ref" : "#/components/responses/Default503Response"
7757 }
7758 },
7759 "security" : [ {
7760 "Authorization_Code_PKCE" : [ "r_usr" ]
7761 } ],
7762 "summary" : "Get owners relationship (\"to-many\").",
7763 "tags" : [ "contentClaims" ],
7764 "x-path-item-properties" : {
7765 "required-access-tier" : "INTERNAL"
7766 }
7767 }
7768 },
7769 "/credits/{id}" : {
7770 "get" : {
7771 "description" : "Retrieves single credit by id.",
7772 "parameters" : [ {
7773 "description" : "Credit id",
7774 "example" : "3fG7kLmN2pQrStUv",
7775 "in" : "path",
7776 "name" : "id",
7777 "required" : true,
7778 "schema" : {
7779 "type" : "string"
7780 }
7781 }, {
7782 "description" : "Allows the client to customize which related resources should be returned. Available options: artist, category",
7783 "example" : "artist.albums",
7784 "in" : "query",
7785 "name" : "include",
7786 "required" : false,
7787 "schema" : {
7788 "type" : "array",
7789 "items" : {
7790 "type" : "string",
7791 "example" : "artist.albums"
7792 }
7793 }
7794 }, {
7795 "description" : "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",
7796 "example" : "artist.albums",
7797 "in" : "query",
7798 "name" : "replaceMedia",
7799 "required" : false,
7800 "schema" : {
7801 "type" : "string",
7802 "example" : "artist.albums"
7803 }
7804 } ],
7805 "responses" : {
7806 "200" : {
7807 "content" : {
7808 "application/vnd.api+json" : {
7809 "schema" : {
7810 "$ref" : "#/components/schemas/Credits_Single_Resource_Data_Document"
7811 }
7812 }
7813 },
7814 "description" : "Successful response"
7815 },
7816 "400" : {
7817 "$ref" : "#/components/responses/Default400Response"
7818 },
7819 "404" : {
7820 "$ref" : "#/components/responses/Default404Response"
7821 },
7822 "405" : {
7823 "$ref" : "#/components/responses/Default405Response"
7824 },
7825 "406" : {
7826 "$ref" : "#/components/responses/Default406Response"
7827 },
7828 "415" : {
7829 "$ref" : "#/components/responses/Default415Response"
7830 },
7831 "429" : {
7832 "$ref" : "#/components/responses/Default429Response"
7833 },
7834 "500" : {
7835 "$ref" : "#/components/responses/Default500Response"
7836 },
7837 "503" : {
7838 "$ref" : "#/components/responses/Default503Response"
7839 }
7840 },
7841 "security" : [ {
7842 "Client_Credentials" : [ ]
7843 }, {
7844 "Authorization_Code_PKCE" : [ ]
7845 } ],
7846 "summary" : "Get single credit.",
7847 "tags" : [ "credits" ],
7848 "x-path-item-properties" : {
7849 "required-access-tier" : "INTERNAL"
7850 }
7851 }
7852 },
7853 "/credits/{id}/relationships/artist" : {
7854 "get" : {
7855 "description" : "Retrieves artist relationship.",
7856 "parameters" : [ {
7857 "description" : "Credit id",
7858 "example" : "3fG7kLmN2pQrStUv",
7859 "in" : "path",
7860 "name" : "id",
7861 "required" : true,
7862 "schema" : {
7863 "type" : "string"
7864 }
7865 }, {
7866 "description" : "Allows the client to customize which related resources should be returned. Available options: artist",
7867 "example" : "artist.albums",
7868 "in" : "query",
7869 "name" : "include",
7870 "required" : false,
7871 "schema" : {
7872 "type" : "array",
7873 "items" : {
7874 "type" : "string",
7875 "example" : "artist.albums"
7876 }
7877 }
7878 }, {
7879 "description" : "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",
7880 "example" : "artist.albums",
7881 "in" : "query",
7882 "name" : "replaceMedia",
7883 "required" : false,
7884 "schema" : {
7885 "type" : "string",
7886 "example" : "artist.albums"
7887 }
7888 } ],
7889 "responses" : {
7890 "200" : {
7891 "content" : {
7892 "application/vnd.api+json" : {
7893 "schema" : {
7894 "$ref" : "#/components/schemas/Credits_Single_Relationship_Data_Document"
7895 }
7896 }
7897 },
7898 "description" : "Successful response"
7899 },
7900 "400" : {
7901 "$ref" : "#/components/responses/Default400Response"
7902 },
7903 "404" : {
7904 "$ref" : "#/components/responses/Default404Response"
7905 },
7906 "405" : {
7907 "$ref" : "#/components/responses/Default405Response"
7908 },
7909 "406" : {
7910 "$ref" : "#/components/responses/Default406Response"
7911 },
7912 "415" : {
7913 "$ref" : "#/components/responses/Default415Response"
7914 },
7915 "429" : {
7916 "$ref" : "#/components/responses/Default429Response"
7917 },
7918 "500" : {
7919 "$ref" : "#/components/responses/Default500Response"
7920 },
7921 "503" : {
7922 "$ref" : "#/components/responses/Default503Response"
7923 }
7924 },
7925 "security" : [ {
7926 "Client_Credentials" : [ ]
7927 }, {
7928 "Authorization_Code_PKCE" : [ ]
7929 } ],
7930 "summary" : "Get artist relationship (\"to-one\").",
7931 "tags" : [ "credits" ],
7932 "x-path-item-properties" : {
7933 "required-access-tier" : "INTERNAL"
7934 }
7935 }
7936 },
7937 "/credits/{id}/relationships/category" : {
7938 "get" : {
7939 "description" : "Retrieves category relationship.",
7940 "parameters" : [ {
7941 "description" : "Credit id",
7942 "example" : "3fG7kLmN2pQrStUv",
7943 "in" : "path",
7944 "name" : "id",
7945 "required" : true,
7946 "schema" : {
7947 "type" : "string"
7948 }
7949 }, {
7950 "description" : "Allows the client to customize which related resources should be returned. Available options: category",
7951 "example" : "category",
7952 "in" : "query",
7953 "name" : "include",
7954 "required" : false,
7955 "schema" : {
7956 "type" : "array",
7957 "items" : {
7958 "type" : "string",
7959 "example" : "category"
7960 }
7961 }
7962 } ],
7963 "responses" : {
7964 "200" : {
7965 "content" : {
7966 "application/vnd.api+json" : {
7967 "schema" : {
7968 "$ref" : "#/components/schemas/Credits_Single_Relationship_Data_Document"
7969 }
7970 }
7971 },
7972 "description" : "Successful response"
7973 },
7974 "400" : {
7975 "$ref" : "#/components/responses/Default400Response"
7976 },
7977 "404" : {
7978 "$ref" : "#/components/responses/Default404Response"
7979 },
7980 "405" : {
7981 "$ref" : "#/components/responses/Default405Response"
7982 },
7983 "406" : {
7984 "$ref" : "#/components/responses/Default406Response"
7985 },
7986 "415" : {
7987 "$ref" : "#/components/responses/Default415Response"
7988 },
7989 "429" : {
7990 "$ref" : "#/components/responses/Default429Response"
7991 },
7992 "500" : {
7993 "$ref" : "#/components/responses/Default500Response"
7994 },
7995 "503" : {
7996 "$ref" : "#/components/responses/Default503Response"
7997 }
7998 },
7999 "security" : [ {
8000 "Client_Credentials" : [ ]
8001 }, {
8002 "Authorization_Code_PKCE" : [ ]
8003 } ],
8004 "summary" : "Get category relationship (\"to-one\").",
8005 "tags" : [ "credits" ],
8006 "x-path-item-properties" : {
8007 "required-access-tier" : "INTERNAL"
8008 }
8009 }
8010 },
8011 "/downloads" : {
8012 "get" : {
8013 "description" : "Retrieves multiple downloads by available filters, or without if applicable.",
8014 "parameters" : [ {
8015 "description" : "Download id (e.g. `VFJBQ0tTOjEyMzQ1`)",
8016 "in" : "query",
8017 "name" : "filter[id]",
8018 "required" : true,
8019 "schema" : {
8020 "type" : "array",
8021 "items" : {
8022 "type" : "string"
8023 }
8024 }
8025 }, {
8026 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
8027 "example" : "owners",
8028 "in" : "query",
8029 "name" : "include",
8030 "required" : false,
8031 "schema" : {
8032 "type" : "array",
8033 "items" : {
8034 "type" : "string",
8035 "example" : "owners"
8036 }
8037 }
8038 } ],
8039 "responses" : {
8040 "200" : {
8041 "content" : {
8042 "application/vnd.api+json" : {
8043 "schema" : {
8044 "$ref" : "#/components/schemas/Downloads_Multi_Resource_Data_Document"
8045 }
8046 }
8047 },
8048 "description" : "Successful response"
8049 },
8050 "400" : {
8051 "$ref" : "#/components/responses/Default400Response"
8052 },
8053 "404" : {
8054 "$ref" : "#/components/responses/Default404Response"
8055 },
8056 "405" : {
8057 "$ref" : "#/components/responses/Default405Response"
8058 },
8059 "406" : {
8060 "$ref" : "#/components/responses/Default406Response"
8061 },
8062 "415" : {
8063 "$ref" : "#/components/responses/Default415Response"
8064 },
8065 "429" : {
8066 "$ref" : "#/components/responses/Default429Response"
8067 },
8068 "500" : {
8069 "$ref" : "#/components/responses/Default500Response"
8070 },
8071 "503" : {
8072 "$ref" : "#/components/responses/Default503Response"
8073 }
8074 },
8075 "security" : [ {
8076 "Authorization_Code_PKCE" : [ "r_usr" ]
8077 } ],
8078 "summary" : "Get multiple downloads.",
8079 "tags" : [ "downloads" ],
8080 "x-path-item-properties" : {
8081 "required-access-tier" : "INTERNAL"
8082 }
8083 }
8084 },
8085 "/downloads/{id}" : {
8086 "get" : {
8087 "description" : "Retrieves single download by id.",
8088 "parameters" : [ {
8089 "description" : "Download id",
8090 "example" : "VFJBQ0tTOjEyMzQ1",
8091 "in" : "path",
8092 "name" : "id",
8093 "required" : true,
8094 "schema" : {
8095 "type" : "string"
8096 }
8097 }, {
8098 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
8099 "example" : "owners",
8100 "in" : "query",
8101 "name" : "include",
8102 "required" : false,
8103 "schema" : {
8104 "type" : "array",
8105 "items" : {
8106 "type" : "string",
8107 "example" : "owners"
8108 }
8109 }
8110 } ],
8111 "responses" : {
8112 "200" : {
8113 "content" : {
8114 "application/vnd.api+json" : {
8115 "schema" : {
8116 "$ref" : "#/components/schemas/Downloads_Single_Resource_Data_Document"
8117 }
8118 }
8119 },
8120 "description" : "Successful response"
8121 },
8122 "400" : {
8123 "$ref" : "#/components/responses/Default400Response"
8124 },
8125 "404" : {
8126 "$ref" : "#/components/responses/Default404Response"
8127 },
8128 "405" : {
8129 "$ref" : "#/components/responses/Default405Response"
8130 },
8131 "406" : {
8132 "$ref" : "#/components/responses/Default406Response"
8133 },
8134 "415" : {
8135 "$ref" : "#/components/responses/Default415Response"
8136 },
8137 "429" : {
8138 "$ref" : "#/components/responses/Default429Response"
8139 },
8140 "500" : {
8141 "$ref" : "#/components/responses/Default500Response"
8142 },
8143 "503" : {
8144 "$ref" : "#/components/responses/Default503Response"
8145 }
8146 },
8147 "security" : [ {
8148 "Authorization_Code_PKCE" : [ "r_usr" ]
8149 } ],
8150 "summary" : "Get single download.",
8151 "tags" : [ "downloads" ],
8152 "x-path-item-properties" : {
8153 "required-access-tier" : "INTERNAL"
8154 }
8155 }
8156 },
8157 "/downloads/{id}/relationships/owners" : {
8158 "get" : {
8159 "description" : "Retrieves owners relationship.",
8160 "parameters" : [ {
8161 "description" : "Download id",
8162 "example" : "VFJBQ0tTOjEyMzQ1",
8163 "in" : "path",
8164 "name" : "id",
8165 "required" : true,
8166 "schema" : {
8167 "type" : "string"
8168 }
8169 }, {
8170 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
8171 "example" : "owners",
8172 "in" : "query",
8173 "name" : "include",
8174 "required" : false,
8175 "schema" : {
8176 "type" : "array",
8177 "items" : {
8178 "type" : "string",
8179 "example" : "owners"
8180 }
8181 }
8182 }, {
8183 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
8184 "in" : "query",
8185 "name" : "page[cursor]",
8186 "required" : false,
8187 "schema" : {
8188 "type" : "string"
8189 }
8190 } ],
8191 "responses" : {
8192 "200" : {
8193 "content" : {
8194 "application/vnd.api+json" : {
8195 "schema" : {
8196 "$ref" : "#/components/schemas/Downloads_Multi_Relationship_Data_Document"
8197 }
8198 }
8199 },
8200 "description" : "Successful response"
8201 },
8202 "400" : {
8203 "$ref" : "#/components/responses/Default400Response"
8204 },
8205 "404" : {
8206 "$ref" : "#/components/responses/Default404Response"
8207 },
8208 "405" : {
8209 "$ref" : "#/components/responses/Default405Response"
8210 },
8211 "406" : {
8212 "$ref" : "#/components/responses/Default406Response"
8213 },
8214 "415" : {
8215 "$ref" : "#/components/responses/Default415Response"
8216 },
8217 "429" : {
8218 "$ref" : "#/components/responses/Default429Response"
8219 },
8220 "500" : {
8221 "$ref" : "#/components/responses/Default500Response"
8222 },
8223 "503" : {
8224 "$ref" : "#/components/responses/Default503Response"
8225 }
8226 },
8227 "security" : [ {
8228 "Authorization_Code_PKCE" : [ "r_usr" ]
8229 } ],
8230 "summary" : "Get owners relationship (\"to-many\").",
8231 "tags" : [ "downloads" ],
8232 "x-path-item-properties" : {
8233 "required-access-tier" : "INTERNAL"
8234 }
8235 }
8236 },
8237 "/dspSharingLinks" : {
8238 "get" : {
8239 "description" : "Retrieves multiple dspSharingLinks by available filters, or without if applicable.",
8240 "parameters" : [ {
8241 "description" : "The id of the subject resource",
8242 "in" : "query",
8243 "name" : "filter[subject.id]",
8244 "required" : true,
8245 "schema" : {
8246 "type" : "array",
8247 "items" : {
8248 "type" : "string"
8249 }
8250 }
8251 }, {
8252 "description" : "The type of the subject resource (e.g., albums, tracks, artists) (e.g. `tracks`)",
8253 "in" : "query",
8254 "name" : "filter[subject.type]",
8255 "required" : true,
8256 "schema" : {
8257 "type" : "array",
8258 "items" : {
8259 "type" : "string",
8260 "enum" : [ "tracks", "albums", "artists" ]
8261 }
8262 }
8263 }, {
8264 "description" : "Allows the client to customize which related resources should be returned. Available options: subject",
8265 "example" : "subject",
8266 "in" : "query",
8267 "name" : "include",
8268 "required" : false,
8269 "schema" : {
8270 "type" : "array",
8271 "items" : {
8272 "type" : "string",
8273 "example" : "subject"
8274 }
8275 }
8276 }, {
8277 "description" : "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",
8278 "example" : "subject",
8279 "in" : "query",
8280 "name" : "replaceMedia",
8281 "required" : false,
8282 "schema" : {
8283 "type" : "string",
8284 "example" : "subject"
8285 }
8286 } ],
8287 "responses" : {
8288 "200" : {
8289 "content" : {
8290 "application/vnd.api+json" : {
8291 "schema" : {
8292 "$ref" : "#/components/schemas/DspSharingLinks_Multi_Resource_Data_Document"
8293 }
8294 }
8295 },
8296 "description" : "Successful response"
8297 },
8298 "400" : {
8299 "$ref" : "#/components/responses/Default400Response"
8300 },
8301 "404" : {
8302 "$ref" : "#/components/responses/Default404Response"
8303 },
8304 "405" : {
8305 "$ref" : "#/components/responses/Default405Response"
8306 },
8307 "406" : {
8308 "$ref" : "#/components/responses/Default406Response"
8309 },
8310 "415" : {
8311 "$ref" : "#/components/responses/Default415Response"
8312 },
8313 "429" : {
8314 "$ref" : "#/components/responses/Default429Response"
8315 },
8316 "500" : {
8317 "$ref" : "#/components/responses/Default500Response"
8318 },
8319 "503" : {
8320 "$ref" : "#/components/responses/Default503Response"
8321 }
8322 },
8323 "security" : [ {
8324 "Client_Credentials" : [ ]
8325 }, {
8326 "Authorization_Code_PKCE" : [ ]
8327 } ],
8328 "summary" : "Get multiple dspSharingLinks.",
8329 "tags" : [ "dspSharingLinks" ],
8330 "x-path-item-properties" : {
8331 "required-access-tier" : "INTERNAL"
8332 }
8333 }
8334 },
8335 "/dspSharingLinks/{id}/relationships/subject" : {
8336 "get" : {
8337 "description" : "Retrieves subject relationship.",
8338 "parameters" : [ {
8339 "description" : "DspSharingLinks Id",
8340 "example" : "QUxCVU1TOjEyMzQ1",
8341 "in" : "path",
8342 "name" : "id",
8343 "required" : true,
8344 "schema" : {
8345 "type" : "string"
8346 }
8347 }, {
8348 "description" : "Allows the client to customize which related resources should be returned. Available options: subject",
8349 "example" : "subject",
8350 "in" : "query",
8351 "name" : "include",
8352 "required" : false,
8353 "schema" : {
8354 "type" : "array",
8355 "items" : {
8356 "type" : "string",
8357 "example" : "subject"
8358 }
8359 }
8360 }, {
8361 "description" : "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",
8362 "example" : "subject",
8363 "in" : "query",
8364 "name" : "replaceMedia",
8365 "required" : false,
8366 "schema" : {
8367 "type" : "string",
8368 "example" : "subject"
8369 }
8370 } ],
8371 "responses" : {
8372 "200" : {
8373 "content" : {
8374 "application/vnd.api+json" : {
8375 "schema" : {
8376 "$ref" : "#/components/schemas/DspSharingLinks_Single_Relationship_Data_Document"
8377 }
8378 }
8379 },
8380 "description" : "Successful response"
8381 },
8382 "400" : {
8383 "$ref" : "#/components/responses/Default400Response"
8384 },
8385 "404" : {
8386 "$ref" : "#/components/responses/Default404Response"
8387 },
8388 "405" : {
8389 "$ref" : "#/components/responses/Default405Response"
8390 },
8391 "406" : {
8392 "$ref" : "#/components/responses/Default406Response"
8393 },
8394 "415" : {
8395 "$ref" : "#/components/responses/Default415Response"
8396 },
8397 "429" : {
8398 "$ref" : "#/components/responses/Default429Response"
8399 },
8400 "500" : {
8401 "$ref" : "#/components/responses/Default500Response"
8402 },
8403 "503" : {
8404 "$ref" : "#/components/responses/Default503Response"
8405 }
8406 },
8407 "security" : [ {
8408 "Client_Credentials" : [ ]
8409 }, {
8410 "Authorization_Code_PKCE" : [ ]
8411 } ],
8412 "summary" : "Get subject relationship (\"to-one\").",
8413 "tags" : [ "dspSharingLinks" ],
8414 "x-path-item-properties" : {
8415 "required-access-tier" : "INTERNAL"
8416 }
8417 }
8418 },
8419 "/dynamicModules" : {
8420 "get" : {
8421 "description" : "Retrieves multiple dynamicModules by available filters, or without if applicable.",
8422 "parameters" : [ {
8423 "description" : "The type of device making the request",
8424 "example" : "PHONE",
8425 "in" : "query",
8426 "name" : "deviceType",
8427 "required" : true,
8428 "schema" : {
8429 "type" : "string",
8430 "enum" : [ "BROWSER", "CAR", "DESKTOP", "PHONE", "TABLET", "TV" ]
8431 }
8432 }, {
8433 "description" : "The system type of the device making the request",
8434 "example" : "IOS",
8435 "in" : "query",
8436 "name" : "systemType",
8437 "required" : true,
8438 "schema" : {
8439 "type" : "string",
8440 "enum" : [ "ANDROID", "DESKTOP", "TESLA", "IOS", "WEB" ]
8441 }
8442 }, {
8443 "description" : "Client version number",
8444 "example" : "2026.0.1",
8445 "in" : "query",
8446 "name" : "clientVersion",
8447 "required" : true,
8448 "schema" : {
8449 "type" : "string"
8450 }
8451 }, {
8452 "description" : "DynamicModules Id (e.g. `nejMcAhh5N8S3EQ4LaqysVdI0cZZ`)",
8453 "in" : "query",
8454 "name" : "filter[id]",
8455 "required" : true,
8456 "schema" : {
8457 "type" : "array",
8458 "items" : {
8459 "type" : "string"
8460 }
8461 }
8462 }, {
8463 "description" : "Stable seed used to keep dynamic page and module results consistent across a client session.",
8464 "in" : "query",
8465 "name" : "refreshSeed",
8466 "required" : false,
8467 "schema" : {
8468 "type" : "string"
8469 }
8470 }, {
8471 "description" : "ISO 3166-1 alpha-2 country code",
8472 "example" : "US",
8473 "in" : "query",
8474 "name" : "countryCode",
8475 "required" : false,
8476 "schema" : {
8477 "type" : "string"
8478 }
8479 }, {
8480 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
8481 "example" : "en-US",
8482 "in" : "query",
8483 "name" : "locale",
8484 "required" : false,
8485 "schema" : {
8486 "type" : "string",
8487 "default" : "en-US"
8488 }
8489 }, {
8490 "description" : "Allows the client to customize which related resources should be returned. Available options: items, seedItem",
8491 "example" : "items",
8492 "in" : "query",
8493 "name" : "include",
8494 "required" : false,
8495 "schema" : {
8496 "type" : "array",
8497 "items" : {
8498 "type" : "string",
8499 "example" : "items"
8500 }
8501 }
8502 }, {
8503 "description" : "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",
8504 "example" : "items",
8505 "in" : "query",
8506 "name" : "replaceMedia",
8507 "required" : false,
8508 "schema" : {
8509 "type" : "string",
8510 "example" : "items"
8511 }
8512 } ],
8513 "responses" : {
8514 "200" : {
8515 "content" : {
8516 "application/vnd.api+json" : {
8517 "schema" : {
8518 "$ref" : "#/components/schemas/DynamicModules_Multi_Resource_Data_Document"
8519 }
8520 }
8521 },
8522 "description" : "Successful response"
8523 },
8524 "400" : {
8525 "$ref" : "#/components/responses/Default400Response"
8526 },
8527 "404" : {
8528 "$ref" : "#/components/responses/Default404Response"
8529 },
8530 "405" : {
8531 "$ref" : "#/components/responses/Default405Response"
8532 },
8533 "406" : {
8534 "$ref" : "#/components/responses/Default406Response"
8535 },
8536 "415" : {
8537 "$ref" : "#/components/responses/Default415Response"
8538 },
8539 "429" : {
8540 "$ref" : "#/components/responses/Default429Response"
8541 },
8542 "500" : {
8543 "$ref" : "#/components/responses/Default500Response"
8544 },
8545 "503" : {
8546 "$ref" : "#/components/responses/Default503Response"
8547 }
8548 },
8549 "security" : [ {
8550 "Client_Credentials" : [ ]
8551 }, {
8552 "Authorization_Code_PKCE" : [ "r_usr" ]
8553 } ],
8554 "summary" : "Get multiple dynamicModules.",
8555 "tags" : [ "dynamicModules" ],
8556 "x-path-item-properties" : {
8557 "required-access-tier" : "INTERNAL"
8558 }
8559 }
8560 },
8561 "/dynamicModules/{id}" : {
8562 "get" : {
8563 "description" : "Retrieves single dynamicModule by id.",
8564 "parameters" : [ {
8565 "description" : "DynamicModules Id",
8566 "example" : "nejMcAhh5N8S3EQ4LaqysVdI0cZZ",
8567 "in" : "path",
8568 "name" : "id",
8569 "required" : true,
8570 "schema" : {
8571 "type" : "string"
8572 }
8573 }, {
8574 "description" : "The type of device making the request",
8575 "example" : "PHONE",
8576 "in" : "query",
8577 "name" : "deviceType",
8578 "required" : true,
8579 "schema" : {
8580 "type" : "string",
8581 "enum" : [ "BROWSER", "CAR", "DESKTOP", "PHONE", "TABLET", "TV" ]
8582 }
8583 }, {
8584 "description" : "The system type of the device making the request",
8585 "example" : "IOS",
8586 "in" : "query",
8587 "name" : "systemType",
8588 "required" : true,
8589 "schema" : {
8590 "type" : "string",
8591 "enum" : [ "ANDROID", "DESKTOP", "TESLA", "IOS", "WEB" ]
8592 }
8593 }, {
8594 "description" : "Client version number",
8595 "example" : "2026.0.1",
8596 "in" : "query",
8597 "name" : "clientVersion",
8598 "required" : true,
8599 "schema" : {
8600 "type" : "string"
8601 }
8602 }, {
8603 "description" : "Stable seed used to keep dynamic page and module results consistent across a client session.",
8604 "in" : "query",
8605 "name" : "refreshSeed",
8606 "required" : false,
8607 "schema" : {
8608 "type" : "string"
8609 }
8610 }, {
8611 "description" : "ISO 3166-1 alpha-2 country code",
8612 "example" : "US",
8613 "in" : "query",
8614 "name" : "countryCode",
8615 "required" : false,
8616 "schema" : {
8617 "type" : "string"
8618 }
8619 }, {
8620 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
8621 "example" : "en-US",
8622 "in" : "query",
8623 "name" : "locale",
8624 "required" : false,
8625 "schema" : {
8626 "type" : "string",
8627 "default" : "en-US"
8628 }
8629 }, {
8630 "description" : "Allows the client to customize which related resources should be returned. Available options: items, seedItem",
8631 "example" : "items",
8632 "in" : "query",
8633 "name" : "include",
8634 "required" : false,
8635 "schema" : {
8636 "type" : "array",
8637 "items" : {
8638 "type" : "string",
8639 "example" : "items"
8640 }
8641 }
8642 }, {
8643 "description" : "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",
8644 "example" : "items",
8645 "in" : "query",
8646 "name" : "replaceMedia",
8647 "required" : false,
8648 "schema" : {
8649 "type" : "string",
8650 "example" : "items"
8651 }
8652 } ],
8653 "responses" : {
8654 "200" : {
8655 "content" : {
8656 "application/vnd.api+json" : {
8657 "schema" : {
8658 "$ref" : "#/components/schemas/DynamicModules_Single_Resource_Data_Document"
8659 }
8660 }
8661 },
8662 "description" : "Successful response"
8663 },
8664 "400" : {
8665 "$ref" : "#/components/responses/Default400Response"
8666 },
8667 "404" : {
8668 "$ref" : "#/components/responses/Default404Response"
8669 },
8670 "405" : {
8671 "$ref" : "#/components/responses/Default405Response"
8672 },
8673 "406" : {
8674 "$ref" : "#/components/responses/Default406Response"
8675 },
8676 "415" : {
8677 "$ref" : "#/components/responses/Default415Response"
8678 },
8679 "429" : {
8680 "$ref" : "#/components/responses/Default429Response"
8681 },
8682 "500" : {
8683 "$ref" : "#/components/responses/Default500Response"
8684 },
8685 "503" : {
8686 "$ref" : "#/components/responses/Default503Response"
8687 }
8688 },
8689 "security" : [ {
8690 "Client_Credentials" : [ ]
8691 }, {
8692 "Authorization_Code_PKCE" : [ "r_usr" ]
8693 } ],
8694 "summary" : "Get single dynamicModule.",
8695 "tags" : [ "dynamicModules" ],
8696 "x-path-item-properties" : {
8697 "required-access-tier" : "INTERNAL"
8698 }
8699 }
8700 },
8701 "/dynamicModules/{id}/relationships/items" : {
8702 "get" : {
8703 "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.",
8704 "parameters" : [ {
8705 "description" : "DynamicModules Id",
8706 "example" : "nejMcAhh5N8S3EQ4LaqysVdI0cZZ",
8707 "in" : "path",
8708 "name" : "id",
8709 "required" : true,
8710 "schema" : {
8711 "type" : "string"
8712 }
8713 }, {
8714 "description" : "The type of device making the request",
8715 "example" : "PHONE",
8716 "in" : "query",
8717 "name" : "deviceType",
8718 "required" : true,
8719 "schema" : {
8720 "type" : "string",
8721 "enum" : [ "BROWSER", "CAR", "DESKTOP", "PHONE", "TABLET", "TV" ]
8722 }
8723 }, {
8724 "description" : "The system type of the device making the request",
8725 "example" : "IOS",
8726 "in" : "query",
8727 "name" : "systemType",
8728 "required" : true,
8729 "schema" : {
8730 "type" : "string",
8731 "enum" : [ "ANDROID", "DESKTOP", "TESLA", "IOS", "WEB" ]
8732 }
8733 }, {
8734 "description" : "Client version number",
8735 "example" : "2026.0.1",
8736 "in" : "query",
8737 "name" : "clientVersion",
8738 "required" : true,
8739 "schema" : {
8740 "type" : "string"
8741 }
8742 }, {
8743 "description" : "Stable seed used to keep dynamic page and module results consistent across a client session.",
8744 "in" : "query",
8745 "name" : "refreshSeed",
8746 "required" : false,
8747 "schema" : {
8748 "type" : "string"
8749 }
8750 }, {
8751 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
8752 "in" : "query",
8753 "name" : "page[cursor]",
8754 "required" : false,
8755 "schema" : {
8756 "type" : "string"
8757 }
8758 }, {
8759 "description" : "ISO 3166-1 alpha-2 country code",
8760 "example" : "US",
8761 "in" : "query",
8762 "name" : "countryCode",
8763 "required" : false,
8764 "schema" : {
8765 "type" : "string"
8766 }
8767 }, {
8768 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
8769 "example" : "en-US",
8770 "in" : "query",
8771 "name" : "locale",
8772 "required" : false,
8773 "schema" : {
8774 "type" : "string",
8775 "default" : "en-US"
8776 }
8777 }, {
8778 "description" : "Allows the client to customize which related resources should be returned. Available options: items",
8779 "example" : "items",
8780 "in" : "query",
8781 "name" : "include",
8782 "required" : false,
8783 "schema" : {
8784 "type" : "array",
8785 "items" : {
8786 "type" : "string",
8787 "example" : "items"
8788 }
8789 }
8790 }, {
8791 "description" : "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",
8792 "example" : "items",
8793 "in" : "query",
8794 "name" : "replaceMedia",
8795 "required" : false,
8796 "schema" : {
8797 "type" : "string",
8798 "example" : "items"
8799 }
8800 } ],
8801 "responses" : {
8802 "200" : {
8803 "content" : {
8804 "application/vnd.api+json" : {
8805 "schema" : {
8806 "$ref" : "#/components/schemas/DynamicModules_Multi_Relationship_Data_Document"
8807 }
8808 }
8809 },
8810 "description" : "Successful response"
8811 },
8812 "400" : {
8813 "$ref" : "#/components/responses/Default400Response"
8814 },
8815 "404" : {
8816 "$ref" : "#/components/responses/Default404Response"
8817 },
8818 "405" : {
8819 "$ref" : "#/components/responses/Default405Response"
8820 },
8821 "406" : {
8822 "$ref" : "#/components/responses/Default406Response"
8823 },
8824 "415" : {
8825 "$ref" : "#/components/responses/Default415Response"
8826 },
8827 "429" : {
8828 "$ref" : "#/components/responses/Default429Response"
8829 },
8830 "500" : {
8831 "$ref" : "#/components/responses/Default500Response"
8832 },
8833 "503" : {
8834 "$ref" : "#/components/responses/Default503Response"
8835 }
8836 },
8837 "security" : [ {
8838 "Client_Credentials" : [ ]
8839 }, {
8840 "Authorization_Code_PKCE" : [ "r_usr" ]
8841 } ],
8842 "summary" : "Get items relationship (\"to-many\").",
8843 "tags" : [ "dynamicModules" ],
8844 "x-path-item-properties" : {
8845 "required-access-tier" : "INTERNAL"
8846 }
8847 }
8848 },
8849 "/dynamicModules/{id}/relationships/seedItem" : {
8850 "get" : {
8851 "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.",
8852 "parameters" : [ {
8853 "description" : "DynamicModules Id",
8854 "example" : "nejMcAhh5N8S3EQ4LaqysVdI0cZZ",
8855 "in" : "path",
8856 "name" : "id",
8857 "required" : true,
8858 "schema" : {
8859 "type" : "string"
8860 }
8861 }, {
8862 "description" : "The type of device making the request",
8863 "example" : "PHONE",
8864 "in" : "query",
8865 "name" : "deviceType",
8866 "required" : true,
8867 "schema" : {
8868 "type" : "string",
8869 "enum" : [ "BROWSER", "CAR", "DESKTOP", "PHONE", "TABLET", "TV" ]
8870 }
8871 }, {
8872 "description" : "The system type of the device making the request",
8873 "example" : "IOS",
8874 "in" : "query",
8875 "name" : "systemType",
8876 "required" : true,
8877 "schema" : {
8878 "type" : "string",
8879 "enum" : [ "ANDROID", "DESKTOP", "TESLA", "IOS", "WEB" ]
8880 }
8881 }, {
8882 "description" : "Client version number",
8883 "example" : "2026.0.1",
8884 "in" : "query",
8885 "name" : "clientVersion",
8886 "required" : true,
8887 "schema" : {
8888 "type" : "string"
8889 }
8890 }, {
8891 "description" : "Stable seed used to keep dynamic page and module results consistent across a client session.",
8892 "in" : "query",
8893 "name" : "refreshSeed",
8894 "required" : false,
8895 "schema" : {
8896 "type" : "string"
8897 }
8898 }, {
8899 "description" : "ISO 3166-1 alpha-2 country code",
8900 "example" : "US",
8901 "in" : "query",
8902 "name" : "countryCode",
8903 "required" : false,
8904 "schema" : {
8905 "type" : "string"
8906 }
8907 }, {
8908 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
8909 "example" : "en-US",
8910 "in" : "query",
8911 "name" : "locale",
8912 "required" : false,
8913 "schema" : {
8914 "type" : "string",
8915 "default" : "en-US"
8916 }
8917 }, {
8918 "description" : "Allows the client to customize which related resources should be returned. Available options: seedItem",
8919 "example" : "seedItem",
8920 "in" : "query",
8921 "name" : "include",
8922 "required" : false,
8923 "schema" : {
8924 "type" : "array",
8925 "items" : {
8926 "type" : "string",
8927 "example" : "seedItem"
8928 }
8929 }
8930 }, {
8931 "description" : "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",
8932 "example" : "seedItem",
8933 "in" : "query",
8934 "name" : "replaceMedia",
8935 "required" : false,
8936 "schema" : {
8937 "type" : "string",
8938 "example" : "seedItem"
8939 }
8940 } ],
8941 "responses" : {
8942 "200" : {
8943 "content" : {
8944 "application/vnd.api+json" : {
8945 "schema" : {
8946 "$ref" : "#/components/schemas/DynamicModules_Single_Relationship_Data_Document"
8947 }
8948 }
8949 },
8950 "description" : "Successful response"
8951 },
8952 "400" : {
8953 "$ref" : "#/components/responses/Default400Response"
8954 },
8955 "404" : {
8956 "$ref" : "#/components/responses/Default404Response"
8957 },
8958 "405" : {
8959 "$ref" : "#/components/responses/Default405Response"
8960 },
8961 "406" : {
8962 "$ref" : "#/components/responses/Default406Response"
8963 },
8964 "415" : {
8965 "$ref" : "#/components/responses/Default415Response"
8966 },
8967 "429" : {
8968 "$ref" : "#/components/responses/Default429Response"
8969 },
8970 "500" : {
8971 "$ref" : "#/components/responses/Default500Response"
8972 },
8973 "503" : {
8974 "$ref" : "#/components/responses/Default503Response"
8975 }
8976 },
8977 "security" : [ {
8978 "Client_Credentials" : [ ]
8979 }, {
8980 "Authorization_Code_PKCE" : [ "r_usr" ]
8981 } ],
8982 "summary" : "Get seedItem relationship (\"to-one\").",
8983 "tags" : [ "dynamicModules" ],
8984 "x-path-item-properties" : {
8985 "required-access-tier" : "INTERNAL"
8986 }
8987 }
8988 },
8989 "/dynamicPages" : {
8990 "get" : {
8991 "description" : "Retrieves multiple dynamicPages by available filters, or without if applicable.",
8992 "parameters" : [ {
8993 "description" : "The type of device making the request",
8994 "example" : "PHONE",
8995 "in" : "query",
8996 "name" : "deviceType",
8997 "required" : true,
8998 "schema" : {
8999 "type" : "string",
9000 "enum" : [ "BROWSER", "CAR", "DESKTOP", "PHONE", "TABLET", "TV" ]
9001 }
9002 }, {
9003 "description" : "The system type of the device making the request",
9004 "example" : "IOS",
9005 "in" : "query",
9006 "name" : "systemType",
9007 "required" : true,
9008 "schema" : {
9009 "type" : "string",
9010 "enum" : [ "ANDROID", "DESKTOP", "TESLA", "IOS", "WEB" ]
9011 }
9012 }, {
9013 "description" : "Client version number",
9014 "example" : "2026.0.1",
9015 "in" : "query",
9016 "name" : "clientVersion",
9017 "required" : true,
9018 "schema" : {
9019 "type" : "string"
9020 }
9021 }, {
9022 "description" : "type of the page (e.g. `ARTIST`)",
9023 "in" : "query",
9024 "name" : "filter[pageType]",
9025 "required" : true,
9026 "schema" : {
9027 "type" : "array",
9028 "items" : {
9029 "type" : "string"
9030 }
9031 }
9032 }, {
9033 "description" : "Stable seed used to keep dynamic page and module results consistent across a client session.",
9034 "in" : "query",
9035 "name" : "refreshSeed",
9036 "required" : false,
9037 "schema" : {
9038 "type" : "string"
9039 }
9040 }, {
9041 "description" : "ISO 3166-1 alpha-2 country code",
9042 "example" : "US",
9043 "in" : "query",
9044 "name" : "countryCode",
9045 "required" : false,
9046 "schema" : {
9047 "type" : "string"
9048 }
9049 }, {
9050 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
9051 "example" : "en-US",
9052 "in" : "query",
9053 "name" : "locale",
9054 "required" : false,
9055 "schema" : {
9056 "type" : "string",
9057 "default" : "en-US"
9058 }
9059 }, {
9060 "description" : "Allows the client to customize which related resources should be returned. Available options: modules, subject",
9061 "example" : "modules.items",
9062 "in" : "query",
9063 "name" : "include",
9064 "required" : false,
9065 "schema" : {
9066 "type" : "array",
9067 "items" : {
9068 "type" : "string",
9069 "example" : "modules.items"
9070 }
9071 }
9072 }, {
9073 "description" : "The subject resource ID. Required except for HOME_FREE, where it must be omitted. (e.g. `67890`)",
9074 "in" : "query",
9075 "name" : "filter[subject.id]",
9076 "required" : false,
9077 "schema" : {
9078 "type" : "array",
9079 "items" : {
9080 "type" : "string"
9081 }
9082 }
9083 }, {
9084 "description" : "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",
9085 "example" : "modules.items",
9086 "in" : "query",
9087 "name" : "replaceMedia",
9088 "required" : false,
9089 "schema" : {
9090 "type" : "string",
9091 "example" : "modules.items"
9092 }
9093 } ],
9094 "responses" : {
9095 "200" : {
9096 "content" : {
9097 "application/vnd.api+json" : {
9098 "schema" : {
9099 "$ref" : "#/components/schemas/DynamicPages_Multi_Resource_Data_Document"
9100 }
9101 }
9102 },
9103 "description" : "Successful response"
9104 },
9105 "400" : {
9106 "$ref" : "#/components/responses/Default400Response"
9107 },
9108 "404" : {
9109 "$ref" : "#/components/responses/Default404Response"
9110 },
9111 "405" : {
9112 "$ref" : "#/components/responses/Default405Response"
9113 },
9114 "406" : {
9115 "$ref" : "#/components/responses/Default406Response"
9116 },
9117 "415" : {
9118 "$ref" : "#/components/responses/Default415Response"
9119 },
9120 "429" : {
9121 "$ref" : "#/components/responses/Default429Response"
9122 },
9123 "500" : {
9124 "$ref" : "#/components/responses/Default500Response"
9125 },
9126 "503" : {
9127 "$ref" : "#/components/responses/Default503Response"
9128 }
9129 },
9130 "security" : [ {
9131 "Client_Credentials" : [ ]
9132 }, {
9133 "Authorization_Code_PKCE" : [ "r_usr" ]
9134 } ],
9135 "summary" : "Get multiple dynamicPages.",
9136 "tags" : [ "dynamicPages" ],
9137 "x-path-item-properties" : {
9138 "required-access-tier" : "INTERNAL"
9139 }
9140 }
9141 },
9142 "/dynamicPages/{id}/relationships/modules" : {
9143 "get" : {
9144 "description" : "Retrieves modules relationship.",
9145 "parameters" : [ {
9146 "description" : "DynamicPages Id",
9147 "example" : "nejMcAhh5N8S3EQ4LaqysVdI0cZZ",
9148 "in" : "path",
9149 "name" : "id",
9150 "required" : true,
9151 "schema" : {
9152 "type" : "string"
9153 }
9154 }, {
9155 "description" : "The type of device making the request",
9156 "example" : "PHONE",
9157 "in" : "query",
9158 "name" : "deviceType",
9159 "required" : true,
9160 "schema" : {
9161 "type" : "string",
9162 "enum" : [ "BROWSER", "CAR", "DESKTOP", "PHONE", "TABLET", "TV" ]
9163 }
9164 }, {
9165 "description" : "The system type of the device making the request",
9166 "example" : "IOS",
9167 "in" : "query",
9168 "name" : "systemType",
9169 "required" : true,
9170 "schema" : {
9171 "type" : "string",
9172 "enum" : [ "ANDROID", "DESKTOP", "TESLA", "IOS", "WEB" ]
9173 }
9174 }, {
9175 "description" : "Client version number",
9176 "example" : "2026.0.1",
9177 "in" : "query",
9178 "name" : "clientVersion",
9179 "required" : true,
9180 "schema" : {
9181 "type" : "string"
9182 }
9183 }, {
9184 "description" : "Stable seed used to keep dynamic page and module results consistent across a client session.",
9185 "in" : "query",
9186 "name" : "refreshSeed",
9187 "required" : false,
9188 "schema" : {
9189 "type" : "string"
9190 }
9191 }, {
9192 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
9193 "in" : "query",
9194 "name" : "page[cursor]",
9195 "required" : false,
9196 "schema" : {
9197 "type" : "string"
9198 }
9199 }, {
9200 "description" : "ISO 3166-1 alpha-2 country code",
9201 "example" : "US",
9202 "in" : "query",
9203 "name" : "countryCode",
9204 "required" : false,
9205 "schema" : {
9206 "type" : "string"
9207 }
9208 }, {
9209 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
9210 "example" : "en-US",
9211 "in" : "query",
9212 "name" : "locale",
9213 "required" : false,
9214 "schema" : {
9215 "type" : "string",
9216 "default" : "en-US"
9217 }
9218 }, {
9219 "description" : "Allows the client to customize which related resources should be returned. Available options: modules",
9220 "example" : "modules.items",
9221 "in" : "query",
9222 "name" : "include",
9223 "required" : false,
9224 "schema" : {
9225 "type" : "array",
9226 "items" : {
9227 "type" : "string",
9228 "example" : "modules.items"
9229 }
9230 }
9231 }, {
9232 "description" : "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",
9233 "example" : "modules.items",
9234 "in" : "query",
9235 "name" : "replaceMedia",
9236 "required" : false,
9237 "schema" : {
9238 "type" : "string",
9239 "example" : "modules.items"
9240 }
9241 } ],
9242 "responses" : {
9243 "200" : {
9244 "content" : {
9245 "application/vnd.api+json" : {
9246 "schema" : {
9247 "$ref" : "#/components/schemas/DynamicPages_Multi_Relationship_Data_Document"
9248 }
9249 }
9250 },
9251 "description" : "Successful response"
9252 },
9253 "400" : {
9254 "$ref" : "#/components/responses/Default400Response"
9255 },
9256 "404" : {
9257 "$ref" : "#/components/responses/Default404Response"
9258 },
9259 "405" : {
9260 "$ref" : "#/components/responses/Default405Response"
9261 },
9262 "406" : {
9263 "$ref" : "#/components/responses/Default406Response"
9264 },
9265 "415" : {
9266 "$ref" : "#/components/responses/Default415Response"
9267 },
9268 "429" : {
9269 "$ref" : "#/components/responses/Default429Response"
9270 },
9271 "500" : {
9272 "$ref" : "#/components/responses/Default500Response"
9273 },
9274 "503" : {
9275 "$ref" : "#/components/responses/Default503Response"
9276 }
9277 },
9278 "security" : [ {
9279 "Client_Credentials" : [ ]
9280 }, {
9281 "Authorization_Code_PKCE" : [ "r_usr" ]
9282 } ],
9283 "summary" : "Get modules relationship (\"to-many\").",
9284 "tags" : [ "dynamicPages" ],
9285 "x-path-item-properties" : {
9286 "required-access-tier" : "INTERNAL"
9287 }
9288 }
9289 },
9290 "/dynamicPages/{id}/relationships/subject" : {
9291 "get" : {
9292 "description" : "Retrieves subject relationship.",
9293 "parameters" : [ {
9294 "description" : "DynamicPages Id",
9295 "example" : "nejMcAhh5N8S3EQ4LaqysVdI0cZZ",
9296 "in" : "path",
9297 "name" : "id",
9298 "required" : true,
9299 "schema" : {
9300 "type" : "string"
9301 }
9302 }, {
9303 "description" : "Allows the client to customize which related resources should be returned. Available options: subject",
9304 "example" : "subject",
9305 "in" : "query",
9306 "name" : "include",
9307 "required" : false,
9308 "schema" : {
9309 "type" : "array",
9310 "items" : {
9311 "type" : "string",
9312 "example" : "subject"
9313 }
9314 }
9315 }, {
9316 "description" : "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",
9317 "example" : "subject",
9318 "in" : "query",
9319 "name" : "replaceMedia",
9320 "required" : false,
9321 "schema" : {
9322 "type" : "string",
9323 "example" : "subject"
9324 }
9325 } ],
9326 "responses" : {
9327 "200" : {
9328 "content" : {
9329 "application/vnd.api+json" : {
9330 "schema" : {
9331 "$ref" : "#/components/schemas/DynamicPages_Single_Relationship_Data_Document"
9332 }
9333 }
9334 },
9335 "description" : "Successful response"
9336 },
9337 "400" : {
9338 "$ref" : "#/components/responses/Default400Response"
9339 },
9340 "404" : {
9341 "$ref" : "#/components/responses/Default404Response"
9342 },
9343 "405" : {
9344 "$ref" : "#/components/responses/Default405Response"
9345 },
9346 "406" : {
9347 "$ref" : "#/components/responses/Default406Response"
9348 },
9349 "415" : {
9350 "$ref" : "#/components/responses/Default415Response"
9351 },
9352 "429" : {
9353 "$ref" : "#/components/responses/Default429Response"
9354 },
9355 "500" : {
9356 "$ref" : "#/components/responses/Default500Response"
9357 },
9358 "503" : {
9359 "$ref" : "#/components/responses/Default503Response"
9360 }
9361 },
9362 "security" : [ {
9363 "Client_Credentials" : [ ]
9364 }, {
9365 "Authorization_Code_PKCE" : [ "r_usr" ]
9366 } ],
9367 "summary" : "Get subject relationship (\"to-one\").",
9368 "tags" : [ "dynamicPages" ],
9369 "x-path-item-properties" : {
9370 "required-access-tier" : "INTERNAL"
9371 }
9372 }
9373 },
9374 "/genres" : {
9375 "get" : {
9376 "description" : "Retrieves multiple genres by available filters, or without if applicable.",
9377 "parameters" : [ {
9378 "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'`)",
9379 "in" : "query",
9380 "name" : "filter[id]",
9381 "required" : true,
9382 "schema" : {
9383 "type" : "array",
9384 "items" : {
9385 "type" : "string"
9386 }
9387 }
9388 }, {
9389 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
9390 "in" : "query",
9391 "name" : "page[cursor]",
9392 "required" : false,
9393 "schema" : {
9394 "type" : "string"
9395 }
9396 }, {
9397 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
9398 "example" : "en-US",
9399 "in" : "query",
9400 "name" : "locale",
9401 "required" : false,
9402 "schema" : {
9403 "type" : "string",
9404 "default" : "en-US"
9405 }
9406 } ],
9407 "responses" : {
9408 "200" : {
9409 "content" : {
9410 "application/vnd.api+json" : {
9411 "schema" : {
9412 "$ref" : "#/components/schemas/Genres_Multi_Resource_Data_Document"
9413 }
9414 }
9415 },
9416 "description" : "Successful response"
9417 },
9418 "400" : {
9419 "$ref" : "#/components/responses/Default400Response"
9420 },
9421 "404" : {
9422 "$ref" : "#/components/responses/Default404Response"
9423 },
9424 "405" : {
9425 "$ref" : "#/components/responses/Default405Response"
9426 },
9427 "406" : {
9428 "$ref" : "#/components/responses/Default406Response"
9429 },
9430 "415" : {
9431 "$ref" : "#/components/responses/Default415Response"
9432 },
9433 "429" : {
9434 "$ref" : "#/components/responses/Default429Response"
9435 },
9436 "500" : {
9437 "$ref" : "#/components/responses/Default500Response"
9438 },
9439 "503" : {
9440 "$ref" : "#/components/responses/Default503Response"
9441 }
9442 },
9443 "security" : [ {
9444 "Client_Credentials" : [ ]
9445 }, {
9446 "Authorization_Code_PKCE" : [ ]
9447 } ],
9448 "summary" : "Get multiple genres.",
9449 "tags" : [ "genres" ],
9450 "x-path-item-properties" : {
9451 "required-access-tier" : "INTERNAL"
9452 }
9453 }
9454 },
9455 "/genres/{id}" : {
9456 "get" : {
9457 "description" : "Retrieves single genre by id.",
9458 "parameters" : [ {
9459 "description" : "Genre id",
9460 "example" : "123",
9461 "in" : "path",
9462 "name" : "id",
9463 "required" : true,
9464 "schema" : {
9465 "type" : "string"
9466 }
9467 }, {
9468 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
9469 "example" : "en-US",
9470 "in" : "query",
9471 "name" : "locale",
9472 "required" : false,
9473 "schema" : {
9474 "type" : "string",
9475 "default" : "en-US"
9476 }
9477 } ],
9478 "responses" : {
9479 "200" : {
9480 "content" : {
9481 "application/vnd.api+json" : {
9482 "schema" : {
9483 "$ref" : "#/components/schemas/Genres_Single_Resource_Data_Document"
9484 }
9485 }
9486 },
9487 "description" : "Successful response"
9488 },
9489 "400" : {
9490 "$ref" : "#/components/responses/Default400Response"
9491 },
9492 "404" : {
9493 "$ref" : "#/components/responses/Default404Response"
9494 },
9495 "405" : {
9496 "$ref" : "#/components/responses/Default405Response"
9497 },
9498 "406" : {
9499 "$ref" : "#/components/responses/Default406Response"
9500 },
9501 "415" : {
9502 "$ref" : "#/components/responses/Default415Response"
9503 },
9504 "429" : {
9505 "$ref" : "#/components/responses/Default429Response"
9506 },
9507 "500" : {
9508 "$ref" : "#/components/responses/Default500Response"
9509 },
9510 "503" : {
9511 "$ref" : "#/components/responses/Default503Response"
9512 }
9513 },
9514 "security" : [ {
9515 "Client_Credentials" : [ ]
9516 }, {
9517 "Authorization_Code_PKCE" : [ ]
9518 } ],
9519 "summary" : "Get single genre.",
9520 "tags" : [ "genres" ],
9521 "x-path-item-properties" : {
9522 "required-access-tier" : "INTERNAL"
9523 }
9524 }
9525 },
9526 "/installations" : {
9527 "get" : {
9528 "description" : "Retrieves multiple installations by available filters, or without if applicable.",
9529 "parameters" : [ {
9530 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
9531 "in" : "query",
9532 "name" : "page[cursor]",
9533 "required" : false,
9534 "schema" : {
9535 "type" : "string"
9536 }
9537 }, {
9538 "description" : "Allows the client to customize which related resources should be returned. Available options: offlineInventory, owners",
9539 "example" : "offlineInventory",
9540 "in" : "query",
9541 "name" : "include",
9542 "required" : false,
9543 "schema" : {
9544 "type" : "array",
9545 "items" : {
9546 "type" : "string",
9547 "example" : "offlineInventory"
9548 }
9549 }
9550 }, {
9551 "description" : "Client-provided installation identifier to filter by (e.g. `a468bee88def`)",
9552 "in" : "query",
9553 "name" : "filter[clientProvidedInstallationId]",
9554 "required" : false,
9555 "schema" : {
9556 "type" : "array",
9557 "items" : {
9558 "type" : "string"
9559 }
9560 }
9561 }, {
9562 "description" : "User ID to filter by. Use `me` for the authenticated user",
9563 "in" : "query",
9564 "name" : "filter[owners.id]",
9565 "required" : false,
9566 "schema" : {
9567 "type" : "array",
9568 "items" : {
9569 "type" : "string"
9570 }
9571 }
9572 }, {
9573 "description" : "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",
9574 "example" : "offlineInventory",
9575 "in" : "query",
9576 "name" : "replaceMedia",
9577 "required" : false,
9578 "schema" : {
9579 "type" : "string",
9580 "example" : "offlineInventory"
9581 }
9582 } ],
9583 "responses" : {
9584 "200" : {
9585 "content" : {
9586 "application/vnd.api+json" : {
9587 "schema" : {
9588 "$ref" : "#/components/schemas/Installations_Multi_Resource_Data_Document"
9589 }
9590 }
9591 },
9592 "description" : "Successful response"
9593 },
9594 "400" : {
9595 "$ref" : "#/components/responses/Default400Response"
9596 },
9597 "404" : {
9598 "$ref" : "#/components/responses/Default404Response"
9599 },
9600 "405" : {
9601 "$ref" : "#/components/responses/Default405Response"
9602 },
9603 "406" : {
9604 "$ref" : "#/components/responses/Default406Response"
9605 },
9606 "415" : {
9607 "$ref" : "#/components/responses/Default415Response"
9608 },
9609 "429" : {
9610 "$ref" : "#/components/responses/Default429Response"
9611 },
9612 "500" : {
9613 "$ref" : "#/components/responses/Default500Response"
9614 },
9615 "503" : {
9616 "$ref" : "#/components/responses/Default503Response"
9617 }
9618 },
9619 "security" : [ {
9620 "Authorization_Code_PKCE" : [ "r_usr" ]
9621 } ],
9622 "summary" : "Get multiple installations.",
9623 "tags" : [ "installations" ],
9624 "x-path-item-properties" : {
9625 "required-access-tier" : "INTERNAL"
9626 }
9627 },
9628 "post" : {
9629 "description" : "Creates a new installation.",
9630 "parameters" : [ {
9631 "$ref" : "#/components/parameters/IdempotencyKey"
9632 } ],
9633 "requestBody" : {
9634 "content" : {
9635 "application/vnd.api+json" : {
9636 "schema" : {
9637 "$ref" : "#/components/schemas/InstallationsCreateOperation_Payload"
9638 }
9639 }
9640 }
9641 },
9642 "responses" : {
9643 "201" : {
9644 "content" : {
9645 "application/vnd.api+json" : {
9646 "schema" : {
9647 "$ref" : "#/components/schemas/Installations_Create_Single_Resource_Data_Document"
9648 }
9649 }
9650 },
9651 "description" : "Successful response"
9652 },
9653 "400" : {
9654 "$ref" : "#/components/responses/Default400Response"
9655 },
9656 "404" : {
9657 "$ref" : "#/components/responses/Default404Response"
9658 },
9659 "405" : {
9660 "$ref" : "#/components/responses/Default405Response"
9661 },
9662 "406" : {
9663 "$ref" : "#/components/responses/Default406Response"
9664 },
9665 "409" : {
9666 "$ref" : "#/components/responses/Idempotency409Response"
9667 },
9668 "415" : {
9669 "$ref" : "#/components/responses/Default415Response"
9670 },
9671 "422" : {
9672 "$ref" : "#/components/responses/Idempotency422Response"
9673 },
9674 "429" : {
9675 "$ref" : "#/components/responses/Default429Response"
9676 },
9677 "500" : {
9678 "$ref" : "#/components/responses/Default500Response"
9679 },
9680 "503" : {
9681 "$ref" : "#/components/responses/Default503Response"
9682 }
9683 },
9684 "security" : [ {
9685 "Authorization_Code_PKCE" : [ "w_usr" ]
9686 } ],
9687 "summary" : "Create single installation.",
9688 "tags" : [ "installations" ],
9689 "x-path-item-properties" : {
9690 "required-access-tier" : "INTERNAL"
9691 }
9692 }
9693 },
9694 "/installations/{id}" : {
9695 "get" : {
9696 "description" : "Retrieves single installation by id.",
9697 "parameters" : [ {
9698 "description" : "Installation id",
9699 "example" : "a468bee88def",
9700 "in" : "path",
9701 "name" : "id",
9702 "required" : true,
9703 "schema" : {
9704 "type" : "string"
9705 }
9706 }, {
9707 "description" : "Allows the client to customize which related resources should be returned. Available options: offlineInventory, owners",
9708 "example" : "offlineInventory",
9709 "in" : "query",
9710 "name" : "include",
9711 "required" : false,
9712 "schema" : {
9713 "type" : "array",
9714 "items" : {
9715 "type" : "string",
9716 "example" : "offlineInventory"
9717 }
9718 }
9719 }, {
9720 "description" : "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",
9721 "example" : "offlineInventory",
9722 "in" : "query",
9723 "name" : "replaceMedia",
9724 "required" : false,
9725 "schema" : {
9726 "type" : "string",
9727 "example" : "offlineInventory"
9728 }
9729 } ],
9730 "responses" : {
9731 "200" : {
9732 "content" : {
9733 "application/vnd.api+json" : {
9734 "schema" : {
9735 "$ref" : "#/components/schemas/Installations_Single_Resource_Data_Document"
9736 }
9737 }
9738 },
9739 "description" : "Successful response"
9740 },
9741 "400" : {
9742 "$ref" : "#/components/responses/Default400Response"
9743 },
9744 "404" : {
9745 "$ref" : "#/components/responses/Default404Response"
9746 },
9747 "405" : {
9748 "$ref" : "#/components/responses/Default405Response"
9749 },
9750 "406" : {
9751 "$ref" : "#/components/responses/Default406Response"
9752 },
9753 "415" : {
9754 "$ref" : "#/components/responses/Default415Response"
9755 },
9756 "429" : {
9757 "$ref" : "#/components/responses/Default429Response"
9758 },
9759 "500" : {
9760 "$ref" : "#/components/responses/Default500Response"
9761 },
9762 "503" : {
9763 "$ref" : "#/components/responses/Default503Response"
9764 }
9765 },
9766 "security" : [ {
9767 "Authorization_Code_PKCE" : [ "r_usr" ]
9768 } ],
9769 "summary" : "Get single installation.",
9770 "tags" : [ "installations" ],
9771 "x-path-item-properties" : {
9772 "required-access-tier" : "INTERNAL"
9773 }
9774 }
9775 },
9776 "/installations/{id}/relationships/offlineInventory" : {
9777 "delete" : {
9778 "description" : "Deletes item(s) from offlineInventory relationship.",
9779 "parameters" : [ {
9780 "description" : "Installation id",
9781 "example" : "a468bee88def",
9782 "in" : "path",
9783 "name" : "id",
9784 "required" : true,
9785 "schema" : {
9786 "type" : "string"
9787 }
9788 }, {
9789 "$ref" : "#/components/parameters/IdempotencyKey"
9790 } ],
9791 "requestBody" : {
9792 "content" : {
9793 "application/vnd.api+json" : {
9794 "schema" : {
9795 "$ref" : "#/components/schemas/InstallationsOfflineInventoryRelationshipRemoveOperation_Payload"
9796 }
9797 }
9798 }
9799 },
9800 "responses" : {
9801 "400" : {
9802 "$ref" : "#/components/responses/Default400Response"
9803 },
9804 "404" : {
9805 "$ref" : "#/components/responses/Default404Response"
9806 },
9807 "405" : {
9808 "$ref" : "#/components/responses/Default405Response"
9809 },
9810 "406" : {
9811 "$ref" : "#/components/responses/Default406Response"
9812 },
9813 "409" : {
9814 "$ref" : "#/components/responses/Idempotency409Response"
9815 },
9816 "415" : {
9817 "$ref" : "#/components/responses/Default415Response"
9818 },
9819 "422" : {
9820 "$ref" : "#/components/responses/Idempotency422Response"
9821 },
9822 "429" : {
9823 "$ref" : "#/components/responses/Default429Response"
9824 },
9825 "500" : {
9826 "$ref" : "#/components/responses/Default500Response"
9827 },
9828 "503" : {
9829 "$ref" : "#/components/responses/Default503Response"
9830 }
9831 },
9832 "security" : [ {
9833 "Authorization_Code_PKCE" : [ "w_usr" ]
9834 } ],
9835 "summary" : "Delete from offlineInventory relationship (\"to-many\").",
9836 "tags" : [ "installations" ],
9837 "x-path-item-properties" : {
9838 "required-access-tier" : "INTERNAL"
9839 }
9840 },
9841 "get" : {
9842 "description" : "Retrieves offlineInventory relationship.",
9843 "parameters" : [ {
9844 "description" : "Installation id",
9845 "example" : "a468bee88def",
9846 "in" : "path",
9847 "name" : "id",
9848 "required" : true,
9849 "schema" : {
9850 "type" : "string"
9851 }
9852 }, {
9853 "description" : "One of: tracks, videos, albums, playlists, userCollectionTracks (e.g. `tracks`)",
9854 "in" : "query",
9855 "name" : "filter[type]",
9856 "required" : true,
9857 "schema" : {
9858 "type" : "array",
9859 "items" : {
9860 "type" : "string",
9861 "enum" : [ "tracks", "videos", "albums", "playlists", "userCollectionTracks" ]
9862 }
9863 }
9864 }, {
9865 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
9866 "in" : "query",
9867 "name" : "page[cursor]",
9868 "required" : false,
9869 "schema" : {
9870 "type" : "string"
9871 }
9872 }, {
9873 "description" : "Allows the client to customize which related resources should be returned. Available options: offlineInventory",
9874 "example" : "offlineInventory",
9875 "in" : "query",
9876 "name" : "include",
9877 "required" : false,
9878 "schema" : {
9879 "type" : "array",
9880 "items" : {
9881 "type" : "string",
9882 "example" : "offlineInventory"
9883 }
9884 }
9885 }, {
9886 "description" : "Offline item id (e.g. `1234`)",
9887 "in" : "query",
9888 "name" : "filter[id]",
9889 "required" : false,
9890 "schema" : {
9891 "type" : "array",
9892 "items" : {
9893 "type" : "string"
9894 }
9895 }
9896 }, {
9897 "description" : "One of: PENDING, STORED, FAILED (e.g. `PENDING`)",
9898 "in" : "query",
9899 "name" : "filter[state]",
9900 "required" : false,
9901 "schema" : {
9902 "type" : "array",
9903 "items" : {
9904 "type" : "string",
9905 "enum" : [ "PENDING", "STORED", "FAILED" ]
9906 }
9907 }
9908 }, {
9909 "description" : "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",
9910 "example" : "offlineInventory",
9911 "in" : "query",
9912 "name" : "replaceMedia",
9913 "required" : false,
9914 "schema" : {
9915 "type" : "string",
9916 "example" : "offlineInventory"
9917 }
9918 } ],
9919 "responses" : {
9920 "200" : {
9921 "content" : {
9922 "application/vnd.api+json" : {
9923 "schema" : {
9924 "$ref" : "#/components/schemas/Installations_OfflineInventory_Multi_Relationship_Data_Document"
9925 }
9926 }
9927 },
9928 "description" : "Successful response"
9929 },
9930 "400" : {
9931 "$ref" : "#/components/responses/Default400Response"
9932 },
9933 "404" : {
9934 "$ref" : "#/components/responses/Default404Response"
9935 },
9936 "405" : {
9937 "$ref" : "#/components/responses/Default405Response"
9938 },
9939 "406" : {
9940 "$ref" : "#/components/responses/Default406Response"
9941 },
9942 "415" : {
9943 "$ref" : "#/components/responses/Default415Response"
9944 },
9945 "429" : {
9946 "$ref" : "#/components/responses/Default429Response"
9947 },
9948 "500" : {
9949 "$ref" : "#/components/responses/Default500Response"
9950 },
9951 "503" : {
9952 "$ref" : "#/components/responses/Default503Response"
9953 }
9954 },
9955 "security" : [ {
9956 "Authorization_Code_PKCE" : [ "r_usr" ]
9957 } ],
9958 "summary" : "Get offlineInventory relationship (\"to-many\").",
9959 "tags" : [ "installations" ],
9960 "x-path-item-properties" : {
9961 "required-access-tier" : "INTERNAL"
9962 }
9963 },
9964 "post" : {
9965 "description" : "Adds item(s) to offlineInventory relationship.",
9966 "parameters" : [ {
9967 "description" : "Installation id",
9968 "example" : "a468bee88def",
9969 "in" : "path",
9970 "name" : "id",
9971 "required" : true,
9972 "schema" : {
9973 "type" : "string"
9974 }
9975 }, {
9976 "$ref" : "#/components/parameters/IdempotencyKey"
9977 } ],
9978 "requestBody" : {
9979 "content" : {
9980 "application/vnd.api+json" : {
9981 "schema" : {
9982 "$ref" : "#/components/schemas/InstallationsOfflineInventoryRelationshipAddOperation_Payload"
9983 }
9984 }
9985 }
9986 },
9987 "responses" : {
9988 "201" : {
9989 "description" : "Successful response"
9990 },
9991 "400" : {
9992 "$ref" : "#/components/responses/Default400Response"
9993 },
9994 "404" : {
9995 "$ref" : "#/components/responses/Default404Response"
9996 },
9997 "405" : {
9998 "$ref" : "#/components/responses/Default405Response"
9999 },
10000 "406" : {
10001 "$ref" : "#/components/responses/Default406Response"
10002 },
10003 "409" : {
10004 "$ref" : "#/components/responses/Idempotency409Response"
10005 },
10006 "415" : {
10007 "$ref" : "#/components/responses/Default415Response"
10008 },
10009 "422" : {
10010 "$ref" : "#/components/responses/Idempotency422Response"
10011 },
10012 "429" : {
10013 "$ref" : "#/components/responses/Default429Response"
10014 },
10015 "500" : {
10016 "$ref" : "#/components/responses/Default500Response"
10017 },
10018 "503" : {
10019 "$ref" : "#/components/responses/Default503Response"
10020 }
10021 },
10022 "security" : [ {
10023 "Authorization_Code_PKCE" : [ "w_usr" ]
10024 } ],
10025 "summary" : "Add to offlineInventory relationship (\"to-many\").",
10026 "tags" : [ "installations" ],
10027 "x-path-item-properties" : {
10028 "required-access-tier" : "INTERNAL"
10029 }
10030 }
10031 },
10032 "/installations/{id}/relationships/owners" : {
10033 "get" : {
10034 "description" : "Retrieves owners relationship.",
10035 "parameters" : [ {
10036 "description" : "Installation id",
10037 "example" : "a468bee88def",
10038 "in" : "path",
10039 "name" : "id",
10040 "required" : true,
10041 "schema" : {
10042 "type" : "string"
10043 }
10044 }, {
10045 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
10046 "example" : "owners",
10047 "in" : "query",
10048 "name" : "include",
10049 "required" : false,
10050 "schema" : {
10051 "type" : "array",
10052 "items" : {
10053 "type" : "string",
10054 "example" : "owners"
10055 }
10056 }
10057 }, {
10058 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
10059 "in" : "query",
10060 "name" : "page[cursor]",
10061 "required" : false,
10062 "schema" : {
10063 "type" : "string"
10064 }
10065 } ],
10066 "responses" : {
10067 "200" : {
10068 "content" : {
10069 "application/vnd.api+json" : {
10070 "schema" : {
10071 "$ref" : "#/components/schemas/Installations_Multi_Relationship_Data_Document"
10072 }
10073 }
10074 },
10075 "description" : "Successful response"
10076 },
10077 "400" : {
10078 "$ref" : "#/components/responses/Default400Response"
10079 },
10080 "404" : {
10081 "$ref" : "#/components/responses/Default404Response"
10082 },
10083 "405" : {
10084 "$ref" : "#/components/responses/Default405Response"
10085 },
10086 "406" : {
10087 "$ref" : "#/components/responses/Default406Response"
10088 },
10089 "415" : {
10090 "$ref" : "#/components/responses/Default415Response"
10091 },
10092 "429" : {
10093 "$ref" : "#/components/responses/Default429Response"
10094 },
10095 "500" : {
10096 "$ref" : "#/components/responses/Default500Response"
10097 },
10098 "503" : {
10099 "$ref" : "#/components/responses/Default503Response"
10100 }
10101 },
10102 "security" : [ {
10103 "Authorization_Code_PKCE" : [ "r_usr" ]
10104 } ],
10105 "summary" : "Get owners relationship (\"to-many\").",
10106 "tags" : [ "installations" ],
10107 "x-path-item-properties" : {
10108 "required-access-tier" : "INTERNAL"
10109 }
10110 }
10111 },
10112 "/lyrics" : {
10113 "post" : {
10114 "description" : "Creates a new lyric.",
10115 "parameters" : [ {
10116 "$ref" : "#/components/parameters/IdempotencyKey"
10117 } ],
10118 "requestBody" : {
10119 "content" : {
10120 "application/vnd.api+json" : {
10121 "schema" : {
10122 "$ref" : "#/components/schemas/LyricsCreateOperation_Payload"
10123 }
10124 }
10125 }
10126 },
10127 "responses" : {
10128 "201" : {
10129 "content" : {
10130 "application/vnd.api+json" : {
10131 "schema" : {
10132 "$ref" : "#/components/schemas/Lyrics_Create_Single_Resource_Data_Document"
10133 }
10134 }
10135 },
10136 "description" : "Successful response"
10137 },
10138 "400" : {
10139 "$ref" : "#/components/responses/Default400Response"
10140 },
10141 "404" : {
10142 "$ref" : "#/components/responses/Default404Response"
10143 },
10144 "405" : {
10145 "$ref" : "#/components/responses/Default405Response"
10146 },
10147 "406" : {
10148 "$ref" : "#/components/responses/Default406Response"
10149 },
10150 "409" : {
10151 "$ref" : "#/components/responses/Idempotency409Response"
10152 },
10153 "415" : {
10154 "$ref" : "#/components/responses/Default415Response"
10155 },
10156 "422" : {
10157 "$ref" : "#/components/responses/Idempotency422Response"
10158 },
10159 "429" : {
10160 "$ref" : "#/components/responses/Default429Response"
10161 },
10162 "500" : {
10163 "$ref" : "#/components/responses/Default500Response"
10164 },
10165 "503" : {
10166 "$ref" : "#/components/responses/Default503Response"
10167 }
10168 },
10169 "security" : [ {
10170 "Authorization_Code_PKCE" : [ "w_usr" ]
10171 } ],
10172 "summary" : "Create single lyric.",
10173 "tags" : [ "lyrics" ],
10174 "x-path-item-properties" : {
10175 "required-access-tier" : "INTERNAL"
10176 }
10177 }
10178 },
10179 "/lyrics/{id}" : {
10180 "delete" : {
10181 "description" : "Deletes existing lyric.",
10182 "parameters" : [ {
10183 "description" : "Lyrics Id",
10184 "example" : "nejMcAhh5N8S3EQ4LaqysVdI0cZZ",
10185 "in" : "path",
10186 "name" : "id",
10187 "required" : true,
10188 "schema" : {
10189 "type" : "string"
10190 }
10191 }, {
10192 "$ref" : "#/components/parameters/IdempotencyKey"
10193 } ],
10194 "responses" : {
10195 "400" : {
10196 "$ref" : "#/components/responses/Default400Response"
10197 },
10198 "404" : {
10199 "$ref" : "#/components/responses/Default404Response"
10200 },
10201 "405" : {
10202 "$ref" : "#/components/responses/Default405Response"
10203 },
10204 "406" : {
10205 "$ref" : "#/components/responses/Default406Response"
10206 },
10207 "409" : {
10208 "$ref" : "#/components/responses/Idempotency409Response"
10209 },
10210 "415" : {
10211 "$ref" : "#/components/responses/Default415Response"
10212 },
10213 "422" : {
10214 "$ref" : "#/components/responses/Idempotency422Response"
10215 },
10216 "429" : {
10217 "$ref" : "#/components/responses/Default429Response"
10218 },
10219 "500" : {
10220 "$ref" : "#/components/responses/Default500Response"
10221 },
10222 "503" : {
10223 "$ref" : "#/components/responses/Default503Response"
10224 }
10225 },
10226 "security" : [ {
10227 "Authorization_Code_PKCE" : [ ]
10228 } ],
10229 "summary" : "Delete single lyric.",
10230 "tags" : [ "lyrics" ],
10231 "x-path-item-properties" : {
10232 "required-access-tier" : "INTERNAL"
10233 }
10234 },
10235 "get" : {
10236 "description" : "Retrieves single lyric by id.",
10237 "parameters" : [ {
10238 "description" : "Lyrics Id",
10239 "example" : "nejMcAhh5N8S3EQ4LaqysVdI0cZZ",
10240 "in" : "path",
10241 "name" : "id",
10242 "required" : true,
10243 "schema" : {
10244 "type" : "string"
10245 }
10246 }, {
10247 "description" : "Allows the client to customize which related resources should be returned. Available options: owners, track",
10248 "example" : "track",
10249 "in" : "query",
10250 "name" : "include",
10251 "required" : false,
10252 "schema" : {
10253 "type" : "array",
10254 "items" : {
10255 "type" : "string",
10256 "example" : "track"
10257 }
10258 }
10259 }, {
10260 "description" : "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",
10261 "example" : "track",
10262 "in" : "query",
10263 "name" : "replaceMedia",
10264 "required" : false,
10265 "schema" : {
10266 "type" : "string",
10267 "example" : "track"
10268 }
10269 } ],
10270 "responses" : {
10271 "200" : {
10272 "content" : {
10273 "application/vnd.api+json" : {
10274 "schema" : {
10275 "$ref" : "#/components/schemas/Lyrics_Single_Resource_Data_Document"
10276 }
10277 }
10278 },
10279 "description" : "Successful response"
10280 },
10281 "400" : {
10282 "$ref" : "#/components/responses/Default400Response"
10283 },
10284 "404" : {
10285 "$ref" : "#/components/responses/Default404Response"
10286 },
10287 "405" : {
10288 "$ref" : "#/components/responses/Default405Response"
10289 },
10290 "406" : {
10291 "$ref" : "#/components/responses/Default406Response"
10292 },
10293 "415" : {
10294 "$ref" : "#/components/responses/Default415Response"
10295 },
10296 "429" : {
10297 "$ref" : "#/components/responses/Default429Response"
10298 },
10299 "500" : {
10300 "$ref" : "#/components/responses/Default500Response"
10301 },
10302 "503" : {
10303 "$ref" : "#/components/responses/Default503Response"
10304 }
10305 },
10306 "security" : [ {
10307 "Client_Credentials" : [ ]
10308 }, {
10309 "Authorization_Code_PKCE" : [ ]
10310 } ],
10311 "summary" : "Get single lyric.",
10312 "tags" : [ "lyrics" ],
10313 "x-path-item-properties" : {
10314 "required-access-tier" : "INTERNAL"
10315 }
10316 },
10317 "patch" : {
10318 "description" : "Updates existing lyric.",
10319 "parameters" : [ {
10320 "description" : "Lyrics Id",
10321 "example" : "nejMcAhh5N8S3EQ4LaqysVdI0cZZ",
10322 "in" : "path",
10323 "name" : "id",
10324 "required" : true,
10325 "schema" : {
10326 "type" : "string"
10327 }
10328 }, {
10329 "$ref" : "#/components/parameters/IdempotencyKey"
10330 } ],
10331 "requestBody" : {
10332 "content" : {
10333 "application/vnd.api+json" : {
10334 "schema" : {
10335 "$ref" : "#/components/schemas/LyricsUpdateOperation_Payload"
10336 }
10337 }
10338 }
10339 },
10340 "responses" : {
10341 "400" : {
10342 "$ref" : "#/components/responses/Default400Response"
10343 },
10344 "404" : {
10345 "$ref" : "#/components/responses/Default404Response"
10346 },
10347 "405" : {
10348 "$ref" : "#/components/responses/Default405Response"
10349 },
10350 "406" : {
10351 "$ref" : "#/components/responses/Default406Response"
10352 },
10353 "409" : {
10354 "$ref" : "#/components/responses/Idempotency409Response"
10355 },
10356 "415" : {
10357 "$ref" : "#/components/responses/Default415Response"
10358 },
10359 "422" : {
10360 "$ref" : "#/components/responses/Idempotency422Response"
10361 },
10362 "429" : {
10363 "$ref" : "#/components/responses/Default429Response"
10364 },
10365 "500" : {
10366 "$ref" : "#/components/responses/Default500Response"
10367 },
10368 "503" : {
10369 "$ref" : "#/components/responses/Default503Response"
10370 }
10371 },
10372 "security" : [ {
10373 "Authorization_Code_PKCE" : [ "w_usr" ]
10374 } ],
10375 "summary" : "Update single lyric.",
10376 "tags" : [ "lyrics" ],
10377 "x-path-item-properties" : {
10378 "required-access-tier" : "INTERNAL"
10379 }
10380 }
10381 },
10382 "/lyrics/{id}/relationships/owners" : {
10383 "get" : {
10384 "description" : "Retrieves owners relationship.",
10385 "parameters" : [ {
10386 "description" : "Lyrics Id",
10387 "example" : "nejMcAhh5N8S3EQ4LaqysVdI0cZZ",
10388 "in" : "path",
10389 "name" : "id",
10390 "required" : true,
10391 "schema" : {
10392 "type" : "string"
10393 }
10394 }, {
10395 "description" : "ISO 3166-1 alpha-2 country code",
10396 "example" : "US",
10397 "in" : "query",
10398 "name" : "countryCode",
10399 "required" : false,
10400 "schema" : {
10401 "type" : "string"
10402 }
10403 }, {
10404 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
10405 "example" : "owners",
10406 "in" : "query",
10407 "name" : "include",
10408 "required" : false,
10409 "schema" : {
10410 "type" : "array",
10411 "items" : {
10412 "type" : "string",
10413 "example" : "owners"
10414 }
10415 }
10416 }, {
10417 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
10418 "in" : "query",
10419 "name" : "page[cursor]",
10420 "required" : false,
10421 "schema" : {
10422 "type" : "string"
10423 }
10424 } ],
10425 "responses" : {
10426 "200" : {
10427 "content" : {
10428 "application/vnd.api+json" : {
10429 "schema" : {
10430 "$ref" : "#/components/schemas/Lyrics_Multi_Relationship_Data_Document"
10431 }
10432 }
10433 },
10434 "description" : "Successful response"
10435 },
10436 "400" : {
10437 "$ref" : "#/components/responses/Default400Response"
10438 },
10439 "404" : {
10440 "$ref" : "#/components/responses/Default404Response"
10441 },
10442 "405" : {
10443 "$ref" : "#/components/responses/Default405Response"
10444 },
10445 "406" : {
10446 "$ref" : "#/components/responses/Default406Response"
10447 },
10448 "415" : {
10449 "$ref" : "#/components/responses/Default415Response"
10450 },
10451 "429" : {
10452 "$ref" : "#/components/responses/Default429Response"
10453 },
10454 "500" : {
10455 "$ref" : "#/components/responses/Default500Response"
10456 },
10457 "503" : {
10458 "$ref" : "#/components/responses/Default503Response"
10459 }
10460 },
10461 "security" : [ {
10462 "Client_Credentials" : [ ]
10463 }, {
10464 "Authorization_Code_PKCE" : [ ]
10465 } ],
10466 "summary" : "Get owners relationship (\"to-many\").",
10467 "tags" : [ "lyrics" ],
10468 "x-path-item-properties" : {
10469 "required-access-tier" : "INTERNAL"
10470 }
10471 }
10472 },
10473 "/lyrics/{id}/relationships/track" : {
10474 "get" : {
10475 "description" : "Retrieves track relationship.",
10476 "parameters" : [ {
10477 "description" : "Lyrics Id",
10478 "example" : "nejMcAhh5N8S3EQ4LaqysVdI0cZZ",
10479 "in" : "path",
10480 "name" : "id",
10481 "required" : true,
10482 "schema" : {
10483 "type" : "string"
10484 }
10485 }, {
10486 "description" : "ISO 3166-1 alpha-2 country code",
10487 "example" : "US",
10488 "in" : "query",
10489 "name" : "countryCode",
10490 "required" : false,
10491 "schema" : {
10492 "type" : "string"
10493 }
10494 }, {
10495 "description" : "Allows the client to customize which related resources should be returned. Available options: track",
10496 "example" : "track",
10497 "in" : "query",
10498 "name" : "include",
10499 "required" : false,
10500 "schema" : {
10501 "type" : "array",
10502 "items" : {
10503 "type" : "string",
10504 "example" : "track"
10505 }
10506 }
10507 }, {
10508 "description" : "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",
10509 "example" : "track",
10510 "in" : "query",
10511 "name" : "replaceMedia",
10512 "required" : false,
10513 "schema" : {
10514 "type" : "string",
10515 "example" : "track"
10516 }
10517 } ],
10518 "responses" : {
10519 "200" : {
10520 "content" : {
10521 "application/vnd.api+json" : {
10522 "schema" : {
10523 "$ref" : "#/components/schemas/Lyrics_Single_Relationship_Data_Document"
10524 }
10525 }
10526 },
10527 "description" : "Successful response"
10528 },
10529 "400" : {
10530 "$ref" : "#/components/responses/Default400Response"
10531 },
10532 "404" : {
10533 "$ref" : "#/components/responses/Default404Response"
10534 },
10535 "405" : {
10536 "$ref" : "#/components/responses/Default405Response"
10537 },
10538 "406" : {
10539 "$ref" : "#/components/responses/Default406Response"
10540 },
10541 "415" : {
10542 "$ref" : "#/components/responses/Default415Response"
10543 },
10544 "429" : {
10545 "$ref" : "#/components/responses/Default429Response"
10546 },
10547 "500" : {
10548 "$ref" : "#/components/responses/Default500Response"
10549 },
10550 "503" : {
10551 "$ref" : "#/components/responses/Default503Response"
10552 }
10553 },
10554 "security" : [ {
10555 "Client_Credentials" : [ ]
10556 }, {
10557 "Authorization_Code_PKCE" : [ ]
10558 } ],
10559 "summary" : "Get track relationship (\"to-one\").",
10560 "tags" : [ "lyrics" ],
10561 "x-path-item-properties" : {
10562 "required-access-tier" : "INTERNAL"
10563 }
10564 }
10565 },
10566 "/manualArtistClaims" : {
10567 "post" : {
10568 "description" : "Creates a new manualArtistClaim.",
10569 "parameters" : [ {
10570 "$ref" : "#/components/parameters/IdempotencyKey"
10571 } ],
10572 "requestBody" : {
10573 "content" : {
10574 "application/vnd.api+json" : {
10575 "schema" : {
10576 "$ref" : "#/components/schemas/ManualArtistClaimsCreateOperation_Payload"
10577 }
10578 }
10579 }
10580 },
10581 "responses" : {
10582 "201" : {
10583 "content" : {
10584 "application/vnd.api+json" : {
10585 "schema" : {
10586 "$ref" : "#/components/schemas/ManualArtistClaims_Create_Single_Resource_Data_Document"
10587 }
10588 }
10589 },
10590 "description" : "Successful response"
10591 },
10592 "400" : {
10593 "$ref" : "#/components/responses/Default400Response"
10594 },
10595 "404" : {
10596 "$ref" : "#/components/responses/Default404Response"
10597 },
10598 "405" : {
10599 "$ref" : "#/components/responses/Default405Response"
10600 },
10601 "406" : {
10602 "$ref" : "#/components/responses/Default406Response"
10603 },
10604 "409" : {
10605 "$ref" : "#/components/responses/Idempotency409Response"
10606 },
10607 "415" : {
10608 "$ref" : "#/components/responses/Default415Response"
10609 },
10610 "422" : {
10611 "$ref" : "#/components/responses/Idempotency422Response"
10612 },
10613 "429" : {
10614 "$ref" : "#/components/responses/Default429Response"
10615 },
10616 "500" : {
10617 "$ref" : "#/components/responses/Default500Response"
10618 },
10619 "503" : {
10620 "$ref" : "#/components/responses/Default503Response"
10621 }
10622 },
10623 "security" : [ {
10624 "Authorization_Code_PKCE" : [ "w_usr" ]
10625 } ],
10626 "summary" : "Create single manualArtistClaim.",
10627 "tags" : [ "manualArtistClaims" ],
10628 "x-path-item-properties" : {
10629 "required-access-tier" : "INTERNAL"
10630 }
10631 }
10632 },
10633 "/offlineTasks" : {
10634 "get" : {
10635 "description" : "Retrieves multiple offlineTasks by available filters, or without if applicable.",
10636 "parameters" : [ {
10637 "description" : "List of offline task IDs (e.g. `a468bee88def`)",
10638 "in" : "query",
10639 "name" : "filter[installation.id]",
10640 "required" : true,
10641 "schema" : {
10642 "type" : "array",
10643 "items" : {
10644 "type" : "string"
10645 }
10646 }
10647 }, {
10648 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
10649 "in" : "query",
10650 "name" : "page[cursor]",
10651 "required" : false,
10652 "schema" : {
10653 "type" : "string"
10654 }
10655 }, {
10656 "description" : "Allows the client to customize which related resources should be returned. Available options: collection, item, owners",
10657 "example" : "collection",
10658 "in" : "query",
10659 "name" : "include",
10660 "required" : false,
10661 "schema" : {
10662 "type" : "array",
10663 "items" : {
10664 "type" : "string",
10665 "example" : "collection"
10666 }
10667 }
10668 }, {
10669 "description" : "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",
10670 "example" : "collection",
10671 "in" : "query",
10672 "name" : "replaceMedia",
10673 "required" : false,
10674 "schema" : {
10675 "type" : "string",
10676 "example" : "collection"
10677 }
10678 } ],
10679 "responses" : {
10680 "200" : {
10681 "content" : {
10682 "application/vnd.api+json" : {
10683 "schema" : {
10684 "$ref" : "#/components/schemas/OfflineTasks_Multi_Resource_Data_Document"
10685 }
10686 }
10687 },
10688 "description" : "Successful response"
10689 },
10690 "400" : {
10691 "$ref" : "#/components/responses/Default400Response"
10692 },
10693 "404" : {
10694 "$ref" : "#/components/responses/Default404Response"
10695 },
10696 "405" : {
10697 "$ref" : "#/components/responses/Default405Response"
10698 },
10699 "406" : {
10700 "$ref" : "#/components/responses/Default406Response"
10701 },
10702 "415" : {
10703 "$ref" : "#/components/responses/Default415Response"
10704 },
10705 "429" : {
10706 "$ref" : "#/components/responses/Default429Response"
10707 },
10708 "500" : {
10709 "$ref" : "#/components/responses/Default500Response"
10710 },
10711 "503" : {
10712 "$ref" : "#/components/responses/Default503Response"
10713 }
10714 },
10715 "security" : [ {
10716 "Authorization_Code_PKCE" : [ "r_usr" ]
10717 } ],
10718 "summary" : "Get multiple offlineTasks.",
10719 "tags" : [ "offlineTasks" ],
10720 "x-path-item-properties" : {
10721 "required-access-tier" : "INTERNAL"
10722 }
10723 }
10724 },
10725 "/offlineTasks/{id}" : {
10726 "get" : {
10727 "description" : "Retrieves single offlineTask by id.",
10728 "parameters" : [ {
10729 "description" : "Offline task id",
10730 "example" : "a468bee8-8def-4a1b-8c1e-123456789abc",
10731 "in" : "path",
10732 "name" : "id",
10733 "required" : true,
10734 "schema" : {
10735 "type" : "string"
10736 }
10737 }, {
10738 "description" : "Allows the client to customize which related resources should be returned. Available options: collection, item, owners",
10739 "example" : "collection",
10740 "in" : "query",
10741 "name" : "include",
10742 "required" : false,
10743 "schema" : {
10744 "type" : "array",
10745 "items" : {
10746 "type" : "string",
10747 "example" : "collection"
10748 }
10749 }
10750 }, {
10751 "description" : "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",
10752 "example" : "collection",
10753 "in" : "query",
10754 "name" : "replaceMedia",
10755 "required" : false,
10756 "schema" : {
10757 "type" : "string",
10758 "example" : "collection"
10759 }
10760 } ],
10761 "responses" : {
10762 "200" : {
10763 "content" : {
10764 "application/vnd.api+json" : {
10765 "schema" : {
10766 "$ref" : "#/components/schemas/OfflineTasks_Single_Resource_Data_Document"
10767 }
10768 }
10769 },
10770 "description" : "Successful response"
10771 },
10772 "400" : {
10773 "$ref" : "#/components/responses/Default400Response"
10774 },
10775 "404" : {
10776 "$ref" : "#/components/responses/Default404Response"
10777 },
10778 "405" : {
10779 "$ref" : "#/components/responses/Default405Response"
10780 },
10781 "406" : {
10782 "$ref" : "#/components/responses/Default406Response"
10783 },
10784 "415" : {
10785 "$ref" : "#/components/responses/Default415Response"
10786 },
10787 "429" : {
10788 "$ref" : "#/components/responses/Default429Response"
10789 },
10790 "500" : {
10791 "$ref" : "#/components/responses/Default500Response"
10792 },
10793 "503" : {
10794 "$ref" : "#/components/responses/Default503Response"
10795 }
10796 },
10797 "security" : [ {
10798 "Authorization_Code_PKCE" : [ "r_usr" ]
10799 } ],
10800 "summary" : "Get single offlineTask.",
10801 "tags" : [ "offlineTasks" ],
10802 "x-path-item-properties" : {
10803 "required-access-tier" : "INTERNAL"
10804 }
10805 },
10806 "patch" : {
10807 "description" : "Updates existing offlineTask.",
10808 "parameters" : [ {
10809 "description" : "Offline task id",
10810 "example" : "a468bee8-8def-4a1b-8c1e-123456789abc",
10811 "in" : "path",
10812 "name" : "id",
10813 "required" : true,
10814 "schema" : {
10815 "type" : "string"
10816 }
10817 }, {
10818 "$ref" : "#/components/parameters/IdempotencyKey"
10819 } ],
10820 "requestBody" : {
10821 "content" : {
10822 "application/vnd.api+json" : {
10823 "schema" : {
10824 "$ref" : "#/components/schemas/OfflineTasksUpdateOperation_Payload"
10825 }
10826 }
10827 }
10828 },
10829 "responses" : {
10830 "400" : {
10831 "$ref" : "#/components/responses/Default400Response"
10832 },
10833 "404" : {
10834 "$ref" : "#/components/responses/Default404Response"
10835 },
10836 "405" : {
10837 "$ref" : "#/components/responses/Default405Response"
10838 },
10839 "406" : {
10840 "$ref" : "#/components/responses/Default406Response"
10841 },
10842 "409" : {
10843 "$ref" : "#/components/responses/Idempotency409Response"
10844 },
10845 "415" : {
10846 "$ref" : "#/components/responses/Default415Response"
10847 },
10848 "422" : {
10849 "$ref" : "#/components/responses/Idempotency422Response"
10850 },
10851 "429" : {
10852 "$ref" : "#/components/responses/Default429Response"
10853 },
10854 "500" : {
10855 "$ref" : "#/components/responses/Default500Response"
10856 },
10857 "503" : {
10858 "$ref" : "#/components/responses/Default503Response"
10859 }
10860 },
10861 "security" : [ {
10862 "Authorization_Code_PKCE" : [ "w_usr" ]
10863 } ],
10864 "summary" : "Update single offlineTask.",
10865 "tags" : [ "offlineTasks" ],
10866 "x-path-item-properties" : {
10867 "required-access-tier" : "INTERNAL"
10868 }
10869 }
10870 },
10871 "/offlineTasks/{id}/relationships/collection" : {
10872 "get" : {
10873 "description" : "Retrieves collection relationship.",
10874 "parameters" : [ {
10875 "description" : "Offline task id",
10876 "example" : "a468bee8-8def-4a1b-8c1e-123456789abc",
10877 "in" : "path",
10878 "name" : "id",
10879 "required" : true,
10880 "schema" : {
10881 "type" : "string"
10882 }
10883 }, {
10884 "description" : "Allows the client to customize which related resources should be returned. Available options: collection",
10885 "example" : "collection",
10886 "in" : "query",
10887 "name" : "include",
10888 "required" : false,
10889 "schema" : {
10890 "type" : "array",
10891 "items" : {
10892 "type" : "string",
10893 "example" : "collection"
10894 }
10895 }
10896 }, {
10897 "description" : "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",
10898 "example" : "collection",
10899 "in" : "query",
10900 "name" : "replaceMedia",
10901 "required" : false,
10902 "schema" : {
10903 "type" : "string",
10904 "example" : "collection"
10905 }
10906 } ],
10907 "responses" : {
10908 "200" : {
10909 "content" : {
10910 "application/vnd.api+json" : {
10911 "schema" : {
10912 "$ref" : "#/components/schemas/OfflineTasks_Single_Relationship_Data_Document"
10913 }
10914 }
10915 },
10916 "description" : "Successful response"
10917 },
10918 "400" : {
10919 "$ref" : "#/components/responses/Default400Response"
10920 },
10921 "404" : {
10922 "$ref" : "#/components/responses/Default404Response"
10923 },
10924 "405" : {
10925 "$ref" : "#/components/responses/Default405Response"
10926 },
10927 "406" : {
10928 "$ref" : "#/components/responses/Default406Response"
10929 },
10930 "415" : {
10931 "$ref" : "#/components/responses/Default415Response"
10932 },
10933 "429" : {
10934 "$ref" : "#/components/responses/Default429Response"
10935 },
10936 "500" : {
10937 "$ref" : "#/components/responses/Default500Response"
10938 },
10939 "503" : {
10940 "$ref" : "#/components/responses/Default503Response"
10941 }
10942 },
10943 "security" : [ {
10944 "Authorization_Code_PKCE" : [ "r_usr" ]
10945 } ],
10946 "summary" : "Get collection relationship (\"to-one\").",
10947 "tags" : [ "offlineTasks" ],
10948 "x-path-item-properties" : {
10949 "required-access-tier" : "INTERNAL"
10950 }
10951 }
10952 },
10953 "/offlineTasks/{id}/relationships/item" : {
10954 "get" : {
10955 "description" : "Retrieves item relationship.",
10956 "parameters" : [ {
10957 "description" : "Offline task id",
10958 "example" : "a468bee8-8def-4a1b-8c1e-123456789abc",
10959 "in" : "path",
10960 "name" : "id",
10961 "required" : true,
10962 "schema" : {
10963 "type" : "string"
10964 }
10965 }, {
10966 "description" : "Allows the client to customize which related resources should be returned. Available options: item",
10967 "example" : "item",
10968 "in" : "query",
10969 "name" : "include",
10970 "required" : false,
10971 "schema" : {
10972 "type" : "array",
10973 "items" : {
10974 "type" : "string",
10975 "example" : "item"
10976 }
10977 }
10978 }, {
10979 "description" : "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",
10980 "example" : "item",
10981 "in" : "query",
10982 "name" : "replaceMedia",
10983 "required" : false,
10984 "schema" : {
10985 "type" : "string",
10986 "example" : "item"
10987 }
10988 } ],
10989 "responses" : {
10990 "200" : {
10991 "content" : {
10992 "application/vnd.api+json" : {
10993 "schema" : {
10994 "$ref" : "#/components/schemas/OfflineTasks_Single_Relationship_Data_Document"
10995 }
10996 }
10997 },
10998 "description" : "Successful response"
10999 },
11000 "400" : {
11001 "$ref" : "#/components/responses/Default400Response"
11002 },
11003 "404" : {
11004 "$ref" : "#/components/responses/Default404Response"
11005 },
11006 "405" : {
11007 "$ref" : "#/components/responses/Default405Response"
11008 },
11009 "406" : {
11010 "$ref" : "#/components/responses/Default406Response"
11011 },
11012 "415" : {
11013 "$ref" : "#/components/responses/Default415Response"
11014 },
11015 "429" : {
11016 "$ref" : "#/components/responses/Default429Response"
11017 },
11018 "500" : {
11019 "$ref" : "#/components/responses/Default500Response"
11020 },
11021 "503" : {
11022 "$ref" : "#/components/responses/Default503Response"
11023 }
11024 },
11025 "security" : [ {
11026 "Authorization_Code_PKCE" : [ "r_usr" ]
11027 } ],
11028 "summary" : "Get item relationship (\"to-one\").",
11029 "tags" : [ "offlineTasks" ],
11030 "x-path-item-properties" : {
11031 "required-access-tier" : "INTERNAL"
11032 }
11033 }
11034 },
11035 "/offlineTasks/{id}/relationships/owners" : {
11036 "get" : {
11037 "description" : "Retrieves owners relationship.",
11038 "parameters" : [ {
11039 "description" : "Offline task id",
11040 "example" : "a468bee8-8def-4a1b-8c1e-123456789abc",
11041 "in" : "path",
11042 "name" : "id",
11043 "required" : true,
11044 "schema" : {
11045 "type" : "string"
11046 }
11047 }, {
11048 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
11049 "example" : "owners",
11050 "in" : "query",
11051 "name" : "include",
11052 "required" : false,
11053 "schema" : {
11054 "type" : "array",
11055 "items" : {
11056 "type" : "string",
11057 "example" : "owners"
11058 }
11059 }
11060 }, {
11061 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
11062 "in" : "query",
11063 "name" : "page[cursor]",
11064 "required" : false,
11065 "schema" : {
11066 "type" : "string"
11067 }
11068 } ],
11069 "responses" : {
11070 "200" : {
11071 "content" : {
11072 "application/vnd.api+json" : {
11073 "schema" : {
11074 "$ref" : "#/components/schemas/OfflineTasks_Multi_Relationship_Data_Document"
11075 }
11076 }
11077 },
11078 "description" : "Successful response"
11079 },
11080 "400" : {
11081 "$ref" : "#/components/responses/Default400Response"
11082 },
11083 "404" : {
11084 "$ref" : "#/components/responses/Default404Response"
11085 },
11086 "405" : {
11087 "$ref" : "#/components/responses/Default405Response"
11088 },
11089 "406" : {
11090 "$ref" : "#/components/responses/Default406Response"
11091 },
11092 "415" : {
11093 "$ref" : "#/components/responses/Default415Response"
11094 },
11095 "429" : {
11096 "$ref" : "#/components/responses/Default429Response"
11097 },
11098 "500" : {
11099 "$ref" : "#/components/responses/Default500Response"
11100 },
11101 "503" : {
11102 "$ref" : "#/components/responses/Default503Response"
11103 }
11104 },
11105 "security" : [ {
11106 "Authorization_Code_PKCE" : [ "r_usr" ]
11107 } ],
11108 "summary" : "Get owners relationship (\"to-many\").",
11109 "tags" : [ "offlineTasks" ],
11110 "x-path-item-properties" : {
11111 "required-access-tier" : "INTERNAL"
11112 }
11113 }
11114 },
11115 "/playQueues" : {
11116 "get" : {
11117 "description" : "Retrieves multiple playQueues by available filters, or without if applicable.",
11118 "parameters" : [ {
11119 "description" : "User id. Use `me` for the authenticated user",
11120 "in" : "query",
11121 "name" : "filter[owners.id]",
11122 "required" : true,
11123 "schema" : {
11124 "type" : "array",
11125 "items" : {
11126 "type" : "string"
11127 }
11128 }
11129 }, {
11130 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
11131 "in" : "query",
11132 "name" : "page[cursor]",
11133 "required" : false,
11134 "schema" : {
11135 "type" : "string"
11136 }
11137 }, {
11138 "description" : "Allows the client to customize which related resources should be returned. Available options: current, future, owners, past",
11139 "example" : "current",
11140 "in" : "query",
11141 "name" : "include",
11142 "required" : false,
11143 "schema" : {
11144 "type" : "array",
11145 "items" : {
11146 "type" : "string",
11147 "example" : "current"
11148 }
11149 }
11150 }, {
11151 "description" : "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",
11152 "example" : "current",
11153 "in" : "query",
11154 "name" : "replaceMedia",
11155 "required" : false,
11156 "schema" : {
11157 "type" : "string",
11158 "example" : "current"
11159 }
11160 } ],
11161 "responses" : {
11162 "200" : {
11163 "content" : {
11164 "application/vnd.api+json" : {
11165 "schema" : {
11166 "$ref" : "#/components/schemas/PlayQueues_Multi_Resource_Data_Document"
11167 }
11168 }
11169 },
11170 "description" : "Successful response"
11171 },
11172 "400" : {
11173 "$ref" : "#/components/responses/Default400Response"
11174 },
11175 "404" : {
11176 "$ref" : "#/components/responses/Default404Response"
11177 },
11178 "405" : {
11179 "$ref" : "#/components/responses/Default405Response"
11180 },
11181 "406" : {
11182 "$ref" : "#/components/responses/Default406Response"
11183 },
11184 "415" : {
11185 "$ref" : "#/components/responses/Default415Response"
11186 },
11187 "429" : {
11188 "$ref" : "#/components/responses/Default429Response"
11189 },
11190 "500" : {
11191 "$ref" : "#/components/responses/Default500Response"
11192 },
11193 "503" : {
11194 "$ref" : "#/components/responses/Default503Response"
11195 }
11196 },
11197 "security" : [ {
11198 "Authorization_Code_PKCE" : [ "r_usr" ]
11199 } ],
11200 "summary" : "Get multiple playQueues.",
11201 "tags" : [ "playQueues" ],
11202 "x-path-item-properties" : {
11203 "required-access-tier" : "INTERNAL"
11204 }
11205 },
11206 "post" : {
11207 "description" : "Creates a new playQueue.",
11208 "parameters" : [ {
11209 "$ref" : "#/components/parameters/IdempotencyKey"
11210 } ],
11211 "requestBody" : {
11212 "content" : {
11213 "application/vnd.api+json" : {
11214 "schema" : {
11215 "$ref" : "#/components/schemas/PlayQueuesCreateOperation_Payload"
11216 }
11217 }
11218 }
11219 },
11220 "responses" : {
11221 "201" : {
11222 "content" : {
11223 "application/vnd.api+json" : {
11224 "schema" : {
11225 "$ref" : "#/components/schemas/PlayQueues_Create_Single_Resource_Data_Document"
11226 }
11227 }
11228 },
11229 "description" : "Successful response"
11230 },
11231 "400" : {
11232 "$ref" : "#/components/responses/Default400Response"
11233 },
11234 "404" : {
11235 "$ref" : "#/components/responses/Default404Response"
11236 },
11237 "405" : {
11238 "$ref" : "#/components/responses/Default405Response"
11239 },
11240 "406" : {
11241 "$ref" : "#/components/responses/Default406Response"
11242 },
11243 "409" : {
11244 "$ref" : "#/components/responses/Idempotency409Response"
11245 },
11246 "415" : {
11247 "$ref" : "#/components/responses/Default415Response"
11248 },
11249 "422" : {
11250 "$ref" : "#/components/responses/Idempotency422Response"
11251 },
11252 "429" : {
11253 "$ref" : "#/components/responses/Default429Response"
11254 },
11255 "500" : {
11256 "$ref" : "#/components/responses/Default500Response"
11257 },
11258 "503" : {
11259 "$ref" : "#/components/responses/Default503Response"
11260 }
11261 },
11262 "security" : [ {
11263 "Authorization_Code_PKCE" : [ "w_usr" ]
11264 } ],
11265 "summary" : "Create single playQueue.",
11266 "tags" : [ "playQueues" ],
11267 "x-path-item-properties" : {
11268 "required-access-tier" : "INTERNAL"
11269 }
11270 }
11271 },
11272 "/playQueues/{id}" : {
11273 "delete" : {
11274 "description" : "Deletes existing playQueue.",
11275 "parameters" : [ {
11276 "description" : "Play queue id",
11277 "example" : "550e8400-e29b-41d4-a716-446655440000",
11278 "in" : "path",
11279 "name" : "id",
11280 "required" : true,
11281 "schema" : {
11282 "type" : "string"
11283 }
11284 }, {
11285 "$ref" : "#/components/parameters/IdempotencyKey"
11286 } ],
11287 "responses" : {
11288 "400" : {
11289 "$ref" : "#/components/responses/Default400Response"
11290 },
11291 "404" : {
11292 "$ref" : "#/components/responses/Default404Response"
11293 },
11294 "405" : {
11295 "$ref" : "#/components/responses/Default405Response"
11296 },
11297 "406" : {
11298 "$ref" : "#/components/responses/Default406Response"
11299 },
11300 "409" : {
11301 "$ref" : "#/components/responses/Idempotency409Response"
11302 },
11303 "415" : {
11304 "$ref" : "#/components/responses/Default415Response"
11305 },
11306 "422" : {
11307 "$ref" : "#/components/responses/Idempotency422Response"
11308 },
11309 "429" : {
11310 "$ref" : "#/components/responses/Default429Response"
11311 },
11312 "500" : {
11313 "$ref" : "#/components/responses/Default500Response"
11314 },
11315 "503" : {
11316 "$ref" : "#/components/responses/Default503Response"
11317 }
11318 },
11319 "security" : [ {
11320 "Authorization_Code_PKCE" : [ "w_usr" ]
11321 } ],
11322 "summary" : "Delete single playQueue.",
11323 "tags" : [ "playQueues" ],
11324 "x-path-item-properties" : {
11325 "required-access-tier" : "INTERNAL"
11326 }
11327 },
11328 "get" : {
11329 "description" : "Retrieves single playQueue by id.",
11330 "parameters" : [ {
11331 "description" : "Play queue id",
11332 "example" : "550e8400-e29b-41d4-a716-446655440000",
11333 "in" : "path",
11334 "name" : "id",
11335 "required" : true,
11336 "schema" : {
11337 "type" : "string"
11338 }
11339 }, {
11340 "description" : "Allows the client to customize which related resources should be returned. Available options: current, future, owners, past",
11341 "example" : "current",
11342 "in" : "query",
11343 "name" : "include",
11344 "required" : false,
11345 "schema" : {
11346 "type" : "array",
11347 "items" : {
11348 "type" : "string",
11349 "example" : "current"
11350 }
11351 }
11352 }, {
11353 "description" : "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",
11354 "example" : "current",
11355 "in" : "query",
11356 "name" : "replaceMedia",
11357 "required" : false,
11358 "schema" : {
11359 "type" : "string",
11360 "example" : "current"
11361 }
11362 } ],
11363 "responses" : {
11364 "200" : {
11365 "content" : {
11366 "application/vnd.api+json" : {
11367 "schema" : {
11368 "$ref" : "#/components/schemas/PlayQueues_Single_Resource_Data_Document"
11369 }
11370 }
11371 },
11372 "description" : "Successful response"
11373 },
11374 "400" : {
11375 "$ref" : "#/components/responses/Default400Response"
11376 },
11377 "404" : {
11378 "$ref" : "#/components/responses/Default404Response"
11379 },
11380 "405" : {
11381 "$ref" : "#/components/responses/Default405Response"
11382 },
11383 "406" : {
11384 "$ref" : "#/components/responses/Default406Response"
11385 },
11386 "415" : {
11387 "$ref" : "#/components/responses/Default415Response"
11388 },
11389 "429" : {
11390 "$ref" : "#/components/responses/Default429Response"
11391 },
11392 "500" : {
11393 "$ref" : "#/components/responses/Default500Response"
11394 },
11395 "503" : {
11396 "$ref" : "#/components/responses/Default503Response"
11397 }
11398 },
11399 "security" : [ {
11400 "Authorization_Code_PKCE" : [ "r_usr" ]
11401 } ],
11402 "summary" : "Get single playQueue.",
11403 "tags" : [ "playQueues" ],
11404 "x-path-item-properties" : {
11405 "required-access-tier" : "INTERNAL"
11406 }
11407 },
11408 "patch" : {
11409 "description" : "Updates existing playQueue.",
11410 "parameters" : [ {
11411 "description" : "Play queue id",
11412 "example" : "550e8400-e29b-41d4-a716-446655440000",
11413 "in" : "path",
11414 "name" : "id",
11415 "required" : true,
11416 "schema" : {
11417 "type" : "string"
11418 }
11419 }, {
11420 "$ref" : "#/components/parameters/IdempotencyKey"
11421 } ],
11422 "requestBody" : {
11423 "content" : {
11424 "application/vnd.api+json" : {
11425 "schema" : {
11426 "$ref" : "#/components/schemas/PlayQueuesUpdateOperation_Payload"
11427 }
11428 }
11429 }
11430 },
11431 "responses" : {
11432 "400" : {
11433 "$ref" : "#/components/responses/Default400Response"
11434 },
11435 "404" : {
11436 "$ref" : "#/components/responses/Default404Response"
11437 },
11438 "405" : {
11439 "$ref" : "#/components/responses/Default405Response"
11440 },
11441 "406" : {
11442 "$ref" : "#/components/responses/Default406Response"
11443 },
11444 "409" : {
11445 "$ref" : "#/components/responses/Idempotency409Response"
11446 },
11447 "415" : {
11448 "$ref" : "#/components/responses/Default415Response"
11449 },
11450 "422" : {
11451 "$ref" : "#/components/responses/Idempotency422Response"
11452 },
11453 "429" : {
11454 "$ref" : "#/components/responses/Default429Response"
11455 },
11456 "500" : {
11457 "$ref" : "#/components/responses/Default500Response"
11458 },
11459 "503" : {
11460 "$ref" : "#/components/responses/Default503Response"
11461 }
11462 },
11463 "security" : [ {
11464 "Authorization_Code_PKCE" : [ "w_usr" ]
11465 } ],
11466 "summary" : "Update single playQueue.",
11467 "tags" : [ "playQueues" ],
11468 "x-path-item-properties" : {
11469 "required-access-tier" : "INTERNAL"
11470 }
11471 }
11472 },
11473 "/playQueues/{id}/relationships/current" : {
11474 "get" : {
11475 "description" : "Retrieves current relationship.",
11476 "parameters" : [ {
11477 "description" : "Play queue id",
11478 "example" : "550e8400-e29b-41d4-a716-446655440000",
11479 "in" : "path",
11480 "name" : "id",
11481 "required" : true,
11482 "schema" : {
11483 "type" : "string"
11484 }
11485 }, {
11486 "description" : "Allows the client to customize which related resources should be returned. Available options: current",
11487 "example" : "current",
11488 "in" : "query",
11489 "name" : "include",
11490 "required" : false,
11491 "schema" : {
11492 "type" : "array",
11493 "items" : {
11494 "type" : "string",
11495 "example" : "current"
11496 }
11497 }
11498 }, {
11499 "description" : "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",
11500 "example" : "current",
11501 "in" : "query",
11502 "name" : "replaceMedia",
11503 "required" : false,
11504 "schema" : {
11505 "type" : "string",
11506 "example" : "current"
11507 }
11508 } ],
11509 "responses" : {
11510 "200" : {
11511 "content" : {
11512 "application/vnd.api+json" : {
11513 "schema" : {
11514 "$ref" : "#/components/schemas/PlayQueues_Current_Single_Relationship_Data_Document"
11515 }
11516 }
11517 },
11518 "description" : "Successful response"
11519 },
11520 "400" : {
11521 "$ref" : "#/components/responses/Default400Response"
11522 },
11523 "404" : {
11524 "$ref" : "#/components/responses/Default404Response"
11525 },
11526 "405" : {
11527 "$ref" : "#/components/responses/Default405Response"
11528 },
11529 "406" : {
11530 "$ref" : "#/components/responses/Default406Response"
11531 },
11532 "415" : {
11533 "$ref" : "#/components/responses/Default415Response"
11534 },
11535 "429" : {
11536 "$ref" : "#/components/responses/Default429Response"
11537 },
11538 "500" : {
11539 "$ref" : "#/components/responses/Default500Response"
11540 },
11541 "503" : {
11542 "$ref" : "#/components/responses/Default503Response"
11543 }
11544 },
11545 "security" : [ {
11546 "Authorization_Code_PKCE" : [ "r_usr" ]
11547 } ],
11548 "summary" : "Get current relationship (\"to-one\").",
11549 "tags" : [ "playQueues" ],
11550 "x-path-item-properties" : {
11551 "required-access-tier" : "INTERNAL"
11552 }
11553 },
11554 "patch" : {
11555 "description" : "Updates current relationship.",
11556 "parameters" : [ {
11557 "description" : "Play queue id",
11558 "example" : "550e8400-e29b-41d4-a716-446655440000",
11559 "in" : "path",
11560 "name" : "id",
11561 "required" : true,
11562 "schema" : {
11563 "type" : "string"
11564 }
11565 }, {
11566 "$ref" : "#/components/parameters/IdempotencyKey"
11567 } ],
11568 "requestBody" : {
11569 "content" : {
11570 "application/vnd.api+json" : {
11571 "schema" : {
11572 "$ref" : "#/components/schemas/PlayQueuesCurrentRelationshipUpdateOperation_Payload"
11573 }
11574 }
11575 }
11576 },
11577 "responses" : {
11578 "400" : {
11579 "$ref" : "#/components/responses/Default400Response"
11580 },
11581 "404" : {
11582 "$ref" : "#/components/responses/Default404Response"
11583 },
11584 "405" : {
11585 "$ref" : "#/components/responses/Default405Response"
11586 },
11587 "406" : {
11588 "$ref" : "#/components/responses/Default406Response"
11589 },
11590 "409" : {
11591 "$ref" : "#/components/responses/Idempotency409Response"
11592 },
11593 "415" : {
11594 "$ref" : "#/components/responses/Default415Response"
11595 },
11596 "422" : {
11597 "$ref" : "#/components/responses/Idempotency422Response"
11598 },
11599 "429" : {
11600 "$ref" : "#/components/responses/Default429Response"
11601 },
11602 "500" : {
11603 "$ref" : "#/components/responses/Default500Response"
11604 },
11605 "503" : {
11606 "$ref" : "#/components/responses/Default503Response"
11607 }
11608 },
11609 "security" : [ {
11610 "Authorization_Code_PKCE" : [ "w_usr" ]
11611 } ],
11612 "summary" : "Update current relationship (\"to-one\").",
11613 "tags" : [ "playQueues" ],
11614 "x-path-item-properties" : {
11615 "required-access-tier" : "INTERNAL"
11616 }
11617 }
11618 },
11619 "/playQueues/{id}/relationships/future" : {
11620 "delete" : {
11621 "description" : "Deletes item(s) from future relationship.",
11622 "parameters" : [ {
11623 "description" : "Play queue id",
11624 "example" : "550e8400-e29b-41d4-a716-446655440000",
11625 "in" : "path",
11626 "name" : "id",
11627 "required" : true,
11628 "schema" : {
11629 "type" : "string"
11630 }
11631 }, {
11632 "$ref" : "#/components/parameters/IdempotencyKey"
11633 } ],
11634 "requestBody" : {
11635 "content" : {
11636 "application/vnd.api+json" : {
11637 "schema" : {
11638 "$ref" : "#/components/schemas/PlayQueuesFutureRelationshipRemoveOperation_Payload"
11639 }
11640 }
11641 }
11642 },
11643 "responses" : {
11644 "400" : {
11645 "$ref" : "#/components/responses/Default400Response"
11646 },
11647 "404" : {
11648 "$ref" : "#/components/responses/Default404Response"
11649 },
11650 "405" : {
11651 "$ref" : "#/components/responses/Default405Response"
11652 },
11653 "406" : {
11654 "$ref" : "#/components/responses/Default406Response"
11655 },
11656 "409" : {
11657 "$ref" : "#/components/responses/Idempotency409Response"
11658 },
11659 "415" : {
11660 "$ref" : "#/components/responses/Default415Response"
11661 },
11662 "422" : {
11663 "$ref" : "#/components/responses/Idempotency422Response"
11664 },
11665 "429" : {
11666 "$ref" : "#/components/responses/Default429Response"
11667 },
11668 "500" : {
11669 "$ref" : "#/components/responses/Default500Response"
11670 },
11671 "503" : {
11672 "$ref" : "#/components/responses/Default503Response"
11673 }
11674 },
11675 "security" : [ {
11676 "Authorization_Code_PKCE" : [ "w_usr" ]
11677 } ],
11678 "summary" : "Delete from future relationship (\"to-many\").",
11679 "tags" : [ "playQueues" ],
11680 "x-path-item-properties" : {
11681 "required-access-tier" : "INTERNAL"
11682 }
11683 },
11684 "get" : {
11685 "description" : "Retrieves future relationship.",
11686 "parameters" : [ {
11687 "description" : "Play queue id",
11688 "example" : "550e8400-e29b-41d4-a716-446655440000",
11689 "in" : "path",
11690 "name" : "id",
11691 "required" : true,
11692 "schema" : {
11693 "type" : "string"
11694 }
11695 }, {
11696 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
11697 "in" : "query",
11698 "name" : "page[cursor]",
11699 "required" : false,
11700 "schema" : {
11701 "type" : "string"
11702 }
11703 }, {
11704 "description" : "Allows the client to customize which related resources should be returned. Available options: future",
11705 "example" : "future",
11706 "in" : "query",
11707 "name" : "include",
11708 "required" : false,
11709 "schema" : {
11710 "type" : "array",
11711 "items" : {
11712 "type" : "string",
11713 "example" : "future"
11714 }
11715 }
11716 }, {
11717 "description" : "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",
11718 "example" : "future",
11719 "in" : "query",
11720 "name" : "replaceMedia",
11721 "required" : false,
11722 "schema" : {
11723 "type" : "string",
11724 "example" : "future"
11725 }
11726 } ],
11727 "responses" : {
11728 "200" : {
11729 "content" : {
11730 "application/vnd.api+json" : {
11731 "schema" : {
11732 "$ref" : "#/components/schemas/PlayQueues_Future_Multi_Relationship_Data_Document"
11733 }
11734 }
11735 },
11736 "description" : "Successful response"
11737 },
11738 "400" : {
11739 "$ref" : "#/components/responses/Default400Response"
11740 },
11741 "404" : {
11742 "$ref" : "#/components/responses/Default404Response"
11743 },
11744 "405" : {
11745 "$ref" : "#/components/responses/Default405Response"
11746 },
11747 "406" : {
11748 "$ref" : "#/components/responses/Default406Response"
11749 },
11750 "415" : {
11751 "$ref" : "#/components/responses/Default415Response"
11752 },
11753 "429" : {
11754 "$ref" : "#/components/responses/Default429Response"
11755 },
11756 "500" : {
11757 "$ref" : "#/components/responses/Default500Response"
11758 },
11759 "503" : {
11760 "$ref" : "#/components/responses/Default503Response"
11761 }
11762 },
11763 "security" : [ {
11764 "Authorization_Code_PKCE" : [ "r_usr" ]
11765 } ],
11766 "summary" : "Get future relationship (\"to-many\").",
11767 "tags" : [ "playQueues" ],
11768 "x-path-item-properties" : {
11769 "required-access-tier" : "INTERNAL"
11770 }
11771 },
11772 "patch" : {
11773 "description" : "Updates future relationship.",
11774 "parameters" : [ {
11775 "description" : "Play queue id",
11776 "example" : "550e8400-e29b-41d4-a716-446655440000",
11777 "in" : "path",
11778 "name" : "id",
11779 "required" : true,
11780 "schema" : {
11781 "type" : "string"
11782 }
11783 }, {
11784 "$ref" : "#/components/parameters/IdempotencyKey"
11785 } ],
11786 "requestBody" : {
11787 "content" : {
11788 "application/vnd.api+json" : {
11789 "schema" : {
11790 "$ref" : "#/components/schemas/PlayQueuesFutureRelationshipUpdateOperation_Payload"
11791 }
11792 }
11793 }
11794 },
11795 "responses" : {
11796 "400" : {
11797 "$ref" : "#/components/responses/Default400Response"
11798 },
11799 "404" : {
11800 "$ref" : "#/components/responses/Default404Response"
11801 },
11802 "405" : {
11803 "$ref" : "#/components/responses/Default405Response"
11804 },
11805 "406" : {
11806 "$ref" : "#/components/responses/Default406Response"
11807 },
11808 "409" : {
11809 "$ref" : "#/components/responses/Idempotency409Response"
11810 },
11811 "415" : {
11812 "$ref" : "#/components/responses/Default415Response"
11813 },
11814 "422" : {
11815 "$ref" : "#/components/responses/Idempotency422Response"
11816 },
11817 "429" : {
11818 "$ref" : "#/components/responses/Default429Response"
11819 },
11820 "500" : {
11821 "$ref" : "#/components/responses/Default500Response"
11822 },
11823 "503" : {
11824 "$ref" : "#/components/responses/Default503Response"
11825 }
11826 },
11827 "security" : [ {
11828 "Authorization_Code_PKCE" : [ "w_usr" ]
11829 } ],
11830 "summary" : "Update future relationship (\"to-many\").",
11831 "tags" : [ "playQueues" ],
11832 "x-path-item-properties" : {
11833 "required-access-tier" : "INTERNAL"
11834 }
11835 },
11836 "post" : {
11837 "description" : "Adds item(s) to future relationship.",
11838 "parameters" : [ {
11839 "description" : "Play queue id",
11840 "example" : "550e8400-e29b-41d4-a716-446655440000",
11841 "in" : "path",
11842 "name" : "id",
11843 "required" : true,
11844 "schema" : {
11845 "type" : "string"
11846 }
11847 }, {
11848 "$ref" : "#/components/parameters/IdempotencyKey"
11849 } ],
11850 "requestBody" : {
11851 "content" : {
11852 "application/vnd.api+json" : {
11853 "schema" : {
11854 "$ref" : "#/components/schemas/PlayQueuesFutureRelationshipAddOperation_Payload"
11855 }
11856 }
11857 }
11858 },
11859 "responses" : {
11860 "201" : {
11861 "description" : "Successful response"
11862 },
11863 "400" : {
11864 "$ref" : "#/components/responses/Default400Response"
11865 },
11866 "404" : {
11867 "$ref" : "#/components/responses/Default404Response"
11868 },
11869 "405" : {
11870 "$ref" : "#/components/responses/Default405Response"
11871 },
11872 "406" : {
11873 "$ref" : "#/components/responses/Default406Response"
11874 },
11875 "409" : {
11876 "$ref" : "#/components/responses/Idempotency409Response"
11877 },
11878 "415" : {
11879 "$ref" : "#/components/responses/Default415Response"
11880 },
11881 "422" : {
11882 "$ref" : "#/components/responses/Idempotency422Response"
11883 },
11884 "429" : {
11885 "$ref" : "#/components/responses/Default429Response"
11886 },
11887 "500" : {
11888 "$ref" : "#/components/responses/Default500Response"
11889 },
11890 "503" : {
11891 "$ref" : "#/components/responses/Default503Response"
11892 }
11893 },
11894 "security" : [ {
11895 "Authorization_Code_PKCE" : [ "w_usr" ]
11896 } ],
11897 "summary" : "Add to future relationship (\"to-many\").",
11898 "tags" : [ "playQueues" ],
11899 "x-path-item-properties" : {
11900 "required-access-tier" : "INTERNAL"
11901 }
11902 }
11903 },
11904 "/playQueues/{id}/relationships/owners" : {
11905 "get" : {
11906 "description" : "Retrieves owners relationship.",
11907 "parameters" : [ {
11908 "description" : "Play queue id",
11909 "example" : "550e8400-e29b-41d4-a716-446655440000",
11910 "in" : "path",
11911 "name" : "id",
11912 "required" : true,
11913 "schema" : {
11914 "type" : "string"
11915 }
11916 }, {
11917 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
11918 "example" : "owners",
11919 "in" : "query",
11920 "name" : "include",
11921 "required" : false,
11922 "schema" : {
11923 "type" : "array",
11924 "items" : {
11925 "type" : "string",
11926 "example" : "owners"
11927 }
11928 }
11929 }, {
11930 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
11931 "in" : "query",
11932 "name" : "page[cursor]",
11933 "required" : false,
11934 "schema" : {
11935 "type" : "string"
11936 }
11937 } ],
11938 "responses" : {
11939 "200" : {
11940 "content" : {
11941 "application/vnd.api+json" : {
11942 "schema" : {
11943 "$ref" : "#/components/schemas/PlayQueues_Multi_Relationship_Data_Document"
11944 }
11945 }
11946 },
11947 "description" : "Successful response"
11948 },
11949 "400" : {
11950 "$ref" : "#/components/responses/Default400Response"
11951 },
11952 "404" : {
11953 "$ref" : "#/components/responses/Default404Response"
11954 },
11955 "405" : {
11956 "$ref" : "#/components/responses/Default405Response"
11957 },
11958 "406" : {
11959 "$ref" : "#/components/responses/Default406Response"
11960 },
11961 "415" : {
11962 "$ref" : "#/components/responses/Default415Response"
11963 },
11964 "429" : {
11965 "$ref" : "#/components/responses/Default429Response"
11966 },
11967 "500" : {
11968 "$ref" : "#/components/responses/Default500Response"
11969 },
11970 "503" : {
11971 "$ref" : "#/components/responses/Default503Response"
11972 }
11973 },
11974 "security" : [ {
11975 "Authorization_Code_PKCE" : [ "r_usr" ]
11976 } ],
11977 "summary" : "Get owners relationship (\"to-many\").",
11978 "tags" : [ "playQueues" ],
11979 "x-path-item-properties" : {
11980 "required-access-tier" : "INTERNAL"
11981 }
11982 }
11983 },
11984 "/playQueues/{id}/relationships/past" : {
11985 "get" : {
11986 "description" : "Retrieves past relationship.",
11987 "parameters" : [ {
11988 "description" : "Play queue id",
11989 "example" : "550e8400-e29b-41d4-a716-446655440000",
11990 "in" : "path",
11991 "name" : "id",
11992 "required" : true,
11993 "schema" : {
11994 "type" : "string"
11995 }
11996 }, {
11997 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
11998 "in" : "query",
11999 "name" : "page[cursor]",
12000 "required" : false,
12001 "schema" : {
12002 "type" : "string"
12003 }
12004 }, {
12005 "description" : "Allows the client to customize which related resources should be returned. Available options: past",
12006 "example" : "past",
12007 "in" : "query",
12008 "name" : "include",
12009 "required" : false,
12010 "schema" : {
12011 "type" : "array",
12012 "items" : {
12013 "type" : "string",
12014 "example" : "past"
12015 }
12016 }
12017 }, {
12018 "description" : "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",
12019 "example" : "past",
12020 "in" : "query",
12021 "name" : "replaceMedia",
12022 "required" : false,
12023 "schema" : {
12024 "type" : "string",
12025 "example" : "past"
12026 }
12027 } ],
12028 "responses" : {
12029 "200" : {
12030 "content" : {
12031 "application/vnd.api+json" : {
12032 "schema" : {
12033 "$ref" : "#/components/schemas/PlayQueues_Past_Multi_Relationship_Data_Document"
12034 }
12035 }
12036 },
12037 "description" : "Successful response"
12038 },
12039 "400" : {
12040 "$ref" : "#/components/responses/Default400Response"
12041 },
12042 "404" : {
12043 "$ref" : "#/components/responses/Default404Response"
12044 },
12045 "405" : {
12046 "$ref" : "#/components/responses/Default405Response"
12047 },
12048 "406" : {
12049 "$ref" : "#/components/responses/Default406Response"
12050 },
12051 "415" : {
12052 "$ref" : "#/components/responses/Default415Response"
12053 },
12054 "429" : {
12055 "$ref" : "#/components/responses/Default429Response"
12056 },
12057 "500" : {
12058 "$ref" : "#/components/responses/Default500Response"
12059 },
12060 "503" : {
12061 "$ref" : "#/components/responses/Default503Response"
12062 }
12063 },
12064 "security" : [ {
12065 "Authorization_Code_PKCE" : [ "r_usr" ]
12066 } ],
12067 "summary" : "Get past relationship (\"to-many\").",
12068 "tags" : [ "playQueues" ],
12069 "x-path-item-properties" : {
12070 "required-access-tier" : "INTERNAL"
12071 }
12072 }
12073 },
12074 "/playlists" : {
12075 "get" : {
12076 "description" : "Retrieves multiple playlists by available filters, or without if applicable.",
12077 "parameters" : [ {
12078 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
12079 "in" : "query",
12080 "name" : "page[cursor]",
12081 "required" : false,
12082 "schema" : {
12083 "type" : "string"
12084 }
12085 }, {
12086 "description" : "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
12087 "in" : "query",
12088 "name" : "sort",
12089 "required" : false,
12090 "schema" : {
12091 "type" : "array",
12092 "items" : {
12093 "type" : "string",
12094 "example" : "createdAt",
12095 "default" : "-createdAt",
12096 "enum" : [ "createdAt", "-createdAt", "lastModifiedAt", "-lastModifiedAt", "name", "-name" ],
12097 "x-enum-varnames" : [ "CreatedAtAsc", "CreatedAtDesc", "LastModifiedAtAsc", "LastModifiedAtDesc", "NameAsc", "NameDesc" ]
12098 }
12099 }
12100 }, {
12101 "description" : "ISO 3166-1 alpha-2 country code",
12102 "example" : "US",
12103 "in" : "query",
12104 "name" : "countryCode",
12105 "required" : false,
12106 "schema" : {
12107 "type" : "string"
12108 }
12109 }, {
12110 "description" : "Allows the client to customize which related resources should be returned. Available options: collaboratorProfiles, collaborators, coverArt, items, ownerProfiles, owners, suggestedCoverArts",
12111 "example" : "items",
12112 "in" : "query",
12113 "name" : "include",
12114 "required" : false,
12115 "schema" : {
12116 "type" : "array",
12117 "items" : {
12118 "type" : "string",
12119 "example" : "items"
12120 }
12121 }
12122 }, {
12123 "description" : "User id. Use `me` for the authenticated user",
12124 "in" : "query",
12125 "name" : "filter[collaborators.id]",
12126 "required" : false,
12127 "schema" : {
12128 "type" : "array",
12129 "items" : {
12130 "type" : "string"
12131 }
12132 }
12133 }, {
12134 "description" : "List of playlist IDs (e.g. `550e8400-e29b-41d4-a716-446655440000`)",
12135 "in" : "query",
12136 "name" : "filter[id]",
12137 "required" : false,
12138 "schema" : {
12139 "type" : "array",
12140 "items" : {
12141 "type" : "string"
12142 }
12143 }
12144 }, {
12145 "description" : "User id. Use `me` for the authenticated user",
12146 "in" : "query",
12147 "name" : "filter[owners.id]",
12148 "required" : false,
12149 "schema" : {
12150 "type" : "array",
12151 "items" : {
12152 "type" : "string"
12153 }
12154 }
12155 }, {
12156 "description" : "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",
12157 "example" : "items",
12158 "in" : "query",
12159 "name" : "replaceMedia",
12160 "required" : false,
12161 "schema" : {
12162 "type" : "string",
12163 "example" : "items"
12164 }
12165 } ],
12166 "responses" : {
12167 "200" : {
12168 "content" : {
12169 "application/vnd.api+json" : {
12170 "schema" : {
12171 "$ref" : "#/components/schemas/Playlists_Multi_Resource_Data_Document"
12172 }
12173 }
12174 },
12175 "description" : "Successful response"
12176 },
12177 "400" : {
12178 "$ref" : "#/components/responses/Default400Response"
12179 },
12180 "404" : {
12181 "$ref" : "#/components/responses/Default404Response"
12182 },
12183 "405" : {
12184 "$ref" : "#/components/responses/Default405Response"
12185 },
12186 "406" : {
12187 "$ref" : "#/components/responses/Default406Response"
12188 },
12189 "415" : {
12190 "$ref" : "#/components/responses/Default415Response"
12191 },
12192 "429" : {
12193 "$ref" : "#/components/responses/Default429Response"
12194 },
12195 "500" : {
12196 "$ref" : "#/components/responses/Default500Response"
12197 },
12198 "503" : {
12199 "$ref" : "#/components/responses/Default503Response"
12200 }
12201 },
12202 "security" : [ {
12203 "Client_Credentials" : [ ]
12204 }, {
12205 "Authorization_Code_PKCE" : [ "playlists.read", "r_usr" ]
12206 } ],
12207 "summary" : "Get multiple playlists.",
12208 "tags" : [ "playlists" ],
12209 "x-path-item-properties" : {
12210 "required-access-tier" : "THIRD_PARTY"
12211 }
12212 },
12213 "post" : {
12214 "description" : "Creates a new playlist.",
12215 "parameters" : [ {
12216 "$ref" : "#/components/parameters/IdempotencyKey"
12217 } ],
12218 "requestBody" : {
12219 "content" : {
12220 "application/vnd.api+json" : {
12221 "schema" : {
12222 "$ref" : "#/components/schemas/PlaylistsCreateOperation_Payload"
12223 }
12224 }
12225 }
12226 },
12227 "responses" : {
12228 "201" : {
12229 "content" : {
12230 "application/vnd.api+json" : {
12231 "schema" : {
12232 "$ref" : "#/components/schemas/Playlists_Create_Single_Resource_Data_Document"
12233 }
12234 }
12235 },
12236 "description" : "Successful response"
12237 },
12238 "400" : {
12239 "$ref" : "#/components/responses/Default400Response"
12240 },
12241 "404" : {
12242 "$ref" : "#/components/responses/Default404Response"
12243 },
12244 "405" : {
12245 "$ref" : "#/components/responses/Default405Response"
12246 },
12247 "406" : {
12248 "$ref" : "#/components/responses/Default406Response"
12249 },
12250 "409" : {
12251 "$ref" : "#/components/responses/Idempotency409Response"
12252 },
12253 "415" : {
12254 "$ref" : "#/components/responses/Default415Response"
12255 },
12256 "422" : {
12257 "$ref" : "#/components/responses/Idempotency422Response"
12258 },
12259 "429" : {
12260 "$ref" : "#/components/responses/Default429Response"
12261 },
12262 "500" : {
12263 "$ref" : "#/components/responses/Default500Response"
12264 },
12265 "503" : {
12266 "$ref" : "#/components/responses/Default503Response"
12267 }
12268 },
12269 "security" : [ {
12270 "Authorization_Code_PKCE" : [ "playlists.write", "w_usr" ]
12271 } ],
12272 "summary" : "Create single playlist.",
12273 "tags" : [ "playlists" ],
12274 "x-path-item-properties" : {
12275 "required-access-tier" : "THIRD_PARTY"
12276 }
12277 }
12278 },
12279 "/playlists/{id}" : {
12280 "delete" : {
12281 "description" : "Deletes existing playlist.",
12282 "parameters" : [ {
12283 "description" : "Playlist id",
12284 "example" : "550e8400-e29b-41d4-a716-446655440000",
12285 "in" : "path",
12286 "name" : "id",
12287 "required" : true,
12288 "schema" : {
12289 "type" : "string"
12290 }
12291 }, {
12292 "$ref" : "#/components/parameters/IdempotencyKey"
12293 } ],
12294 "responses" : {
12295 "400" : {
12296 "$ref" : "#/components/responses/Default400Response"
12297 },
12298 "404" : {
12299 "$ref" : "#/components/responses/Default404Response"
12300 },
12301 "405" : {
12302 "$ref" : "#/components/responses/Default405Response"
12303 },
12304 "406" : {
12305 "$ref" : "#/components/responses/Default406Response"
12306 },
12307 "409" : {
12308 "$ref" : "#/components/responses/Idempotency409Response"
12309 },
12310 "415" : {
12311 "$ref" : "#/components/responses/Default415Response"
12312 },
12313 "422" : {
12314 "$ref" : "#/components/responses/Idempotency422Response"
12315 },
12316 "429" : {
12317 "$ref" : "#/components/responses/Default429Response"
12318 },
12319 "500" : {
12320 "$ref" : "#/components/responses/Default500Response"
12321 },
12322 "503" : {
12323 "$ref" : "#/components/responses/Default503Response"
12324 }
12325 },
12326 "security" : [ {
12327 "Authorization_Code_PKCE" : [ "playlists.write", "w_usr" ]
12328 } ],
12329 "summary" : "Delete single playlist.",
12330 "tags" : [ "playlists" ],
12331 "x-path-item-properties" : {
12332 "required-access-tier" : "THIRD_PARTY"
12333 }
12334 },
12335 "get" : {
12336 "description" : "Retrieves single playlist by id.",
12337 "parameters" : [ {
12338 "description" : "Playlist id",
12339 "example" : "550e8400-e29b-41d4-a716-446655440000",
12340 "in" : "path",
12341 "name" : "id",
12342 "required" : true,
12343 "schema" : {
12344 "type" : "string"
12345 }
12346 }, {
12347 "description" : "ISO 3166-1 alpha-2 country code",
12348 "example" : "US",
12349 "in" : "query",
12350 "name" : "countryCode",
12351 "required" : false,
12352 "schema" : {
12353 "type" : "string"
12354 }
12355 }, {
12356 "description" : "Allows the client to customize which related resources should be returned. Available options: collaboratorProfiles, collaborators, coverArt, items, ownerProfiles, owners, suggestedCoverArts",
12357 "example" : "items",
12358 "in" : "query",
12359 "name" : "include",
12360 "required" : false,
12361 "schema" : {
12362 "type" : "array",
12363 "items" : {
12364 "type" : "string",
12365 "example" : "items"
12366 }
12367 }
12368 }, {
12369 "description" : "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",
12370 "example" : "items",
12371 "in" : "query",
12372 "name" : "replaceMedia",
12373 "required" : false,
12374 "schema" : {
12375 "type" : "string",
12376 "example" : "items"
12377 }
12378 } ],
12379 "responses" : {
12380 "200" : {
12381 "content" : {
12382 "application/vnd.api+json" : {
12383 "schema" : {
12384 "$ref" : "#/components/schemas/Playlists_Single_Resource_Data_Document"
12385 }
12386 }
12387 },
12388 "description" : "Successful response"
12389 },
12390 "400" : {
12391 "$ref" : "#/components/responses/Default400Response"
12392 },
12393 "404" : {
12394 "$ref" : "#/components/responses/Default404Response"
12395 },
12396 "405" : {
12397 "$ref" : "#/components/responses/Default405Response"
12398 },
12399 "406" : {
12400 "$ref" : "#/components/responses/Default406Response"
12401 },
12402 "415" : {
12403 "$ref" : "#/components/responses/Default415Response"
12404 },
12405 "429" : {
12406 "$ref" : "#/components/responses/Default429Response"
12407 },
12408 "500" : {
12409 "$ref" : "#/components/responses/Default500Response"
12410 },
12411 "503" : {
12412 "$ref" : "#/components/responses/Default503Response"
12413 }
12414 },
12415 "security" : [ {
12416 "Client_Credentials" : [ ]
12417 }, {
12418 "Authorization_Code_PKCE" : [ ]
12419 } ],
12420 "summary" : "Get single playlist.",
12421 "tags" : [ "playlists" ],
12422 "x-path-item-properties" : {
12423 "required-access-tier" : "THIRD_PARTY"
12424 }
12425 },
12426 "patch" : {
12427 "description" : "Updates existing playlist.",
12428 "parameters" : [ {
12429 "description" : "Playlist id",
12430 "example" : "550e8400-e29b-41d4-a716-446655440000",
12431 "in" : "path",
12432 "name" : "id",
12433 "required" : true,
12434 "schema" : {
12435 "type" : "string"
12436 }
12437 }, {
12438 "$ref" : "#/components/parameters/IdempotencyKey"
12439 } ],
12440 "requestBody" : {
12441 "content" : {
12442 "application/vnd.api+json" : {
12443 "schema" : {
12444 "$ref" : "#/components/schemas/PlaylistsUpdateOperation_Payload"
12445 }
12446 }
12447 }
12448 },
12449 "responses" : {
12450 "200" : {
12451 "content" : {
12452 "application/vnd.api+json" : {
12453 "schema" : {
12454 "$ref" : "#/components/schemas/Playlists_Update_Single_Resource_Data_Document"
12455 }
12456 }
12457 },
12458 "description" : "Successful response"
12459 },
12460 "400" : {
12461 "$ref" : "#/components/responses/Default400Response"
12462 },
12463 "404" : {
12464 "$ref" : "#/components/responses/Default404Response"
12465 },
12466 "405" : {
12467 "$ref" : "#/components/responses/Default405Response"
12468 },
12469 "406" : {
12470 "$ref" : "#/components/responses/Default406Response"
12471 },
12472 "409" : {
12473 "$ref" : "#/components/responses/Idempotency409Response"
12474 },
12475 "415" : {
12476 "$ref" : "#/components/responses/Default415Response"
12477 },
12478 "422" : {
12479 "$ref" : "#/components/responses/Idempotency422Response"
12480 },
12481 "429" : {
12482 "$ref" : "#/components/responses/Default429Response"
12483 },
12484 "500" : {
12485 "$ref" : "#/components/responses/Default500Response"
12486 },
12487 "503" : {
12488 "$ref" : "#/components/responses/Default503Response"
12489 }
12490 },
12491 "security" : [ {
12492 "Authorization_Code_PKCE" : [ "playlists.write", "w_usr" ]
12493 } ],
12494 "summary" : "Update single playlist.",
12495 "tags" : [ "playlists" ],
12496 "x-path-item-properties" : {
12497 "required-access-tier" : "THIRD_PARTY"
12498 }
12499 }
12500 },
12501 "/playlists/{id}/relationships/collaboratorProfiles" : {
12502 "delete" : {
12503 "description" : "Deletes item(s) from collaboratorProfiles relationship.",
12504 "parameters" : [ {
12505 "description" : "Playlist id",
12506 "example" : "550e8400-e29b-41d4-a716-446655440000",
12507 "in" : "path",
12508 "name" : "id",
12509 "required" : true,
12510 "schema" : {
12511 "type" : "string"
12512 }
12513 }, {
12514 "$ref" : "#/components/parameters/IdempotencyKey"
12515 } ],
12516 "requestBody" : {
12517 "content" : {
12518 "application/vnd.api+json" : {
12519 "schema" : {
12520 "$ref" : "#/components/schemas/PlaylistsCollaboratorProfilesRelationshipRemoveOperation_Payload"
12521 }
12522 }
12523 }
12524 },
12525 "responses" : {
12526 "400" : {
12527 "$ref" : "#/components/responses/Default400Response"
12528 },
12529 "404" : {
12530 "$ref" : "#/components/responses/Default404Response"
12531 },
12532 "405" : {
12533 "$ref" : "#/components/responses/Default405Response"
12534 },
12535 "406" : {
12536 "$ref" : "#/components/responses/Default406Response"
12537 },
12538 "409" : {
12539 "$ref" : "#/components/responses/Idempotency409Response"
12540 },
12541 "415" : {
12542 "$ref" : "#/components/responses/Default415Response"
12543 },
12544 "422" : {
12545 "$ref" : "#/components/responses/Idempotency422Response"
12546 },
12547 "429" : {
12548 "$ref" : "#/components/responses/Default429Response"
12549 },
12550 "500" : {
12551 "$ref" : "#/components/responses/Default500Response"
12552 },
12553 "503" : {
12554 "$ref" : "#/components/responses/Default503Response"
12555 }
12556 },
12557 "security" : [ {
12558 "Authorization_Code_PKCE" : [ "playlists.write", "w_usr" ]
12559 } ],
12560 "summary" : "Delete from collaboratorProfiles relationship (\"to-many\").",
12561 "tags" : [ "playlists" ],
12562 "x-path-item-properties" : {
12563 "required-access-tier" : "INTERNAL"
12564 }
12565 },
12566 "get" : {
12567 "description" : "Retrieves collaboratorProfiles relationship.",
12568 "parameters" : [ {
12569 "description" : "Playlist id",
12570 "example" : "550e8400-e29b-41d4-a716-446655440000",
12571 "in" : "path",
12572 "name" : "id",
12573 "required" : true,
12574 "schema" : {
12575 "type" : "string"
12576 }
12577 }, {
12578 "description" : "ISO 3166-1 alpha-2 country code",
12579 "example" : "US",
12580 "in" : "query",
12581 "name" : "countryCode",
12582 "required" : false,
12583 "schema" : {
12584 "type" : "string"
12585 }
12586 }, {
12587 "description" : "Allows the client to customize which related resources should be returned. Available options: collaboratorProfiles",
12588 "example" : "collaboratorProfiles",
12589 "in" : "query",
12590 "name" : "include",
12591 "required" : false,
12592 "schema" : {
12593 "type" : "array",
12594 "items" : {
12595 "type" : "string",
12596 "example" : "collaboratorProfiles"
12597 }
12598 }
12599 }, {
12600 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
12601 "in" : "query",
12602 "name" : "page[cursor]",
12603 "required" : false,
12604 "schema" : {
12605 "type" : "string"
12606 }
12607 } ],
12608 "responses" : {
12609 "200" : {
12610 "content" : {
12611 "application/vnd.api+json" : {
12612 "schema" : {
12613 "$ref" : "#/components/schemas/Playlists_Multi_Relationship_Data_Document"
12614 }
12615 }
12616 },
12617 "description" : "Successful response"
12618 },
12619 "400" : {
12620 "$ref" : "#/components/responses/Default400Response"
12621 },
12622 "404" : {
12623 "$ref" : "#/components/responses/Default404Response"
12624 },
12625 "405" : {
12626 "$ref" : "#/components/responses/Default405Response"
12627 },
12628 "406" : {
12629 "$ref" : "#/components/responses/Default406Response"
12630 },
12631 "415" : {
12632 "$ref" : "#/components/responses/Default415Response"
12633 },
12634 "429" : {
12635 "$ref" : "#/components/responses/Default429Response"
12636 },
12637 "500" : {
12638 "$ref" : "#/components/responses/Default500Response"
12639 },
12640 "503" : {
12641 "$ref" : "#/components/responses/Default503Response"
12642 }
12643 },
12644 "security" : [ {
12645 "Client_Credentials" : [ ]
12646 }, {
12647 "Authorization_Code_PKCE" : [ ]
12648 } ],
12649 "summary" : "Get collaboratorProfiles relationship (\"to-many\").",
12650 "tags" : [ "playlists" ],
12651 "x-path-item-properties" : {
12652 "required-access-tier" : "THIRD_PARTY"
12653 }
12654 },
12655 "post" : {
12656 "description" : "Adds item(s) to collaboratorProfiles relationship.",
12657 "parameters" : [ {
12658 "description" : "Playlist id",
12659 "example" : "550e8400-e29b-41d4-a716-446655440000",
12660 "in" : "path",
12661 "name" : "id",
12662 "required" : true,
12663 "schema" : {
12664 "type" : "string"
12665 }
12666 }, {
12667 "$ref" : "#/components/parameters/IdempotencyKey"
12668 } ],
12669 "requestBody" : {
12670 "content" : {
12671 "application/vnd.api+json" : {
12672 "schema" : {
12673 "$ref" : "#/components/schemas/PlaylistsCollaboratorProfilesRelationshipAddOperation_Payload"
12674 }
12675 }
12676 }
12677 },
12678 "responses" : {
12679 "201" : {
12680 "description" : "Successful response"
12681 },
12682 "400" : {
12683 "$ref" : "#/components/responses/Default400Response"
12684 },
12685 "404" : {
12686 "$ref" : "#/components/responses/Default404Response"
12687 },
12688 "405" : {
12689 "$ref" : "#/components/responses/Default405Response"
12690 },
12691 "406" : {
12692 "$ref" : "#/components/responses/Default406Response"
12693 },
12694 "409" : {
12695 "$ref" : "#/components/responses/Idempotency409Response"
12696 },
12697 "415" : {
12698 "$ref" : "#/components/responses/Default415Response"
12699 },
12700 "422" : {
12701 "$ref" : "#/components/responses/Idempotency422Response"
12702 },
12703 "429" : {
12704 "$ref" : "#/components/responses/Default429Response"
12705 },
12706 "500" : {
12707 "$ref" : "#/components/responses/Default500Response"
12708 },
12709 "503" : {
12710 "$ref" : "#/components/responses/Default503Response"
12711 }
12712 },
12713 "security" : [ {
12714 "Authorization_Code_PKCE" : [ "playlists.write", "w_usr" ]
12715 } ],
12716 "summary" : "Add to collaboratorProfiles relationship (\"to-many\").",
12717 "tags" : [ "playlists" ],
12718 "x-path-item-properties" : {
12719 "required-access-tier" : "INTERNAL"
12720 }
12721 }
12722 },
12723 "/playlists/{id}/relationships/collaborators" : {
12724 "get" : {
12725 "description" : "Retrieves collaborators relationship.",
12726 "parameters" : [ {
12727 "description" : "Playlist id",
12728 "example" : "550e8400-e29b-41d4-a716-446655440000",
12729 "in" : "path",
12730 "name" : "id",
12731 "required" : true,
12732 "schema" : {
12733 "type" : "string"
12734 }
12735 }, {
12736 "description" : "ISO 3166-1 alpha-2 country code",
12737 "example" : "US",
12738 "in" : "query",
12739 "name" : "countryCode",
12740 "required" : false,
12741 "schema" : {
12742 "type" : "string"
12743 }
12744 }, {
12745 "description" : "Allows the client to customize which related resources should be returned. Available options: collaborators",
12746 "example" : "collaborators",
12747 "in" : "query",
12748 "name" : "include",
12749 "required" : false,
12750 "schema" : {
12751 "type" : "array",
12752 "items" : {
12753 "type" : "string",
12754 "example" : "collaborators"
12755 }
12756 }
12757 }, {
12758 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
12759 "in" : "query",
12760 "name" : "page[cursor]",
12761 "required" : false,
12762 "schema" : {
12763 "type" : "string"
12764 }
12765 } ],
12766 "responses" : {
12767 "200" : {
12768 "content" : {
12769 "application/vnd.api+json" : {
12770 "schema" : {
12771 "$ref" : "#/components/schemas/Playlists_Multi_Relationship_Data_Document"
12772 }
12773 }
12774 },
12775 "description" : "Successful response"
12776 },
12777 "400" : {
12778 "$ref" : "#/components/responses/Default400Response"
12779 },
12780 "404" : {
12781 "$ref" : "#/components/responses/Default404Response"
12782 },
12783 "405" : {
12784 "$ref" : "#/components/responses/Default405Response"
12785 },
12786 "406" : {
12787 "$ref" : "#/components/responses/Default406Response"
12788 },
12789 "415" : {
12790 "$ref" : "#/components/responses/Default415Response"
12791 },
12792 "429" : {
12793 "$ref" : "#/components/responses/Default429Response"
12794 },
12795 "500" : {
12796 "$ref" : "#/components/responses/Default500Response"
12797 },
12798 "503" : {
12799 "$ref" : "#/components/responses/Default503Response"
12800 }
12801 },
12802 "security" : [ {
12803 "Client_Credentials" : [ ]
12804 }, {
12805 "Authorization_Code_PKCE" : [ ]
12806 } ],
12807 "summary" : "Get collaborators relationship (\"to-many\").",
12808 "tags" : [ "playlists" ],
12809 "x-path-item-properties" : {
12810 "required-access-tier" : "THIRD_PARTY"
12811 }
12812 }
12813 },
12814 "/playlists/{id}/relationships/coverArt" : {
12815 "get" : {
12816 "description" : "Retrieves coverArt relationship.",
12817 "parameters" : [ {
12818 "description" : "Playlist id",
12819 "example" : "550e8400-e29b-41d4-a716-446655440000",
12820 "in" : "path",
12821 "name" : "id",
12822 "required" : true,
12823 "schema" : {
12824 "type" : "string"
12825 }
12826 }, {
12827 "description" : "ISO 3166-1 alpha-2 country code",
12828 "example" : "US",
12829 "in" : "query",
12830 "name" : "countryCode",
12831 "required" : false,
12832 "schema" : {
12833 "type" : "string"
12834 }
12835 }, {
12836 "description" : "Allows the client to customize which related resources should be returned. Available options: coverArt",
12837 "example" : "coverArt",
12838 "in" : "query",
12839 "name" : "include",
12840 "required" : false,
12841 "schema" : {
12842 "type" : "array",
12843 "items" : {
12844 "type" : "string",
12845 "example" : "coverArt"
12846 }
12847 }
12848 }, {
12849 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
12850 "in" : "query",
12851 "name" : "page[cursor]",
12852 "required" : false,
12853 "schema" : {
12854 "type" : "string"
12855 }
12856 } ],
12857 "responses" : {
12858 "200" : {
12859 "content" : {
12860 "application/vnd.api+json" : {
12861 "schema" : {
12862 "$ref" : "#/components/schemas/Playlists_Multi_Relationship_Data_Document"
12863 }
12864 }
12865 },
12866 "description" : "Successful response"
12867 },
12868 "400" : {
12869 "$ref" : "#/components/responses/Default400Response"
12870 },
12871 "404" : {
12872 "$ref" : "#/components/responses/Default404Response"
12873 },
12874 "405" : {
12875 "$ref" : "#/components/responses/Default405Response"
12876 },
12877 "406" : {
12878 "$ref" : "#/components/responses/Default406Response"
12879 },
12880 "415" : {
12881 "$ref" : "#/components/responses/Default415Response"
12882 },
12883 "429" : {
12884 "$ref" : "#/components/responses/Default429Response"
12885 },
12886 "500" : {
12887 "$ref" : "#/components/responses/Default500Response"
12888 },
12889 "503" : {
12890 "$ref" : "#/components/responses/Default503Response"
12891 }
12892 },
12893 "security" : [ {
12894 "Client_Credentials" : [ ]
12895 }, {
12896 "Authorization_Code_PKCE" : [ ]
12897 } ],
12898 "summary" : "Get coverArt relationship (\"to-many\").",
12899 "tags" : [ "playlists" ],
12900 "x-path-item-properties" : {
12901 "required-access-tier" : "THIRD_PARTY"
12902 }
12903 },
12904 "patch" : {
12905 "description" : "Updates coverArt relationship.",
12906 "parameters" : [ {
12907 "description" : "Playlist id",
12908 "example" : "550e8400-e29b-41d4-a716-446655440000",
12909 "in" : "path",
12910 "name" : "id",
12911 "required" : true,
12912 "schema" : {
12913 "type" : "string"
12914 }
12915 }, {
12916 "$ref" : "#/components/parameters/IdempotencyKey"
12917 } ],
12918 "requestBody" : {
12919 "content" : {
12920 "application/vnd.api+json" : {
12921 "schema" : {
12922 "$ref" : "#/components/schemas/PlaylistsCoverArtRelationshipUpdateOperation_Payload"
12923 }
12924 }
12925 }
12926 },
12927 "responses" : {
12928 "400" : {
12929 "$ref" : "#/components/responses/Default400Response"
12930 },
12931 "404" : {
12932 "$ref" : "#/components/responses/Default404Response"
12933 },
12934 "405" : {
12935 "$ref" : "#/components/responses/Default405Response"
12936 },
12937 "406" : {
12938 "$ref" : "#/components/responses/Default406Response"
12939 },
12940 "409" : {
12941 "$ref" : "#/components/responses/Idempotency409Response"
12942 },
12943 "415" : {
12944 "$ref" : "#/components/responses/Default415Response"
12945 },
12946 "422" : {
12947 "$ref" : "#/components/responses/Idempotency422Response"
12948 },
12949 "429" : {
12950 "$ref" : "#/components/responses/Default429Response"
12951 },
12952 "500" : {
12953 "$ref" : "#/components/responses/Default500Response"
12954 },
12955 "503" : {
12956 "$ref" : "#/components/responses/Default503Response"
12957 }
12958 },
12959 "security" : [ {
12960 "Authorization_Code_PKCE" : [ "playlists.write", "w_usr" ]
12961 } ],
12962 "summary" : "Update coverArt relationship (\"to-many\").",
12963 "tags" : [ "playlists" ],
12964 "x-path-item-properties" : {
12965 "required-access-tier" : "INTERNAL"
12966 }
12967 }
12968 },
12969 "/playlists/{id}/relationships/items" : {
12970 "delete" : {
12971 "description" : "Deletes item(s) from items relationship.",
12972 "parameters" : [ {
12973 "description" : "Playlist id",
12974 "example" : "550e8400-e29b-41d4-a716-446655440000",
12975 "in" : "path",
12976 "name" : "id",
12977 "required" : true,
12978 "schema" : {
12979 "type" : "string"
12980 }
12981 }, {
12982 "$ref" : "#/components/parameters/IdempotencyKey"
12983 } ],
12984 "requestBody" : {
12985 "content" : {
12986 "application/vnd.api+json" : {
12987 "schema" : {
12988 "$ref" : "#/components/schemas/PlaylistsItemsRelationshipRemoveOperation_Payload"
12989 }
12990 }
12991 }
12992 },
12993 "responses" : {
12994 "400" : {
12995 "$ref" : "#/components/responses/Default400Response"
12996 },
12997 "404" : {
12998 "$ref" : "#/components/responses/Default404Response"
12999 },
13000 "405" : {
13001 "$ref" : "#/components/responses/Default405Response"
13002 },
13003 "406" : {
13004 "$ref" : "#/components/responses/Default406Response"
13005 },
13006 "409" : {
13007 "$ref" : "#/components/responses/Idempotency409Response"
13008 },
13009 "415" : {
13010 "$ref" : "#/components/responses/Default415Response"
13011 },
13012 "422" : {
13013 "$ref" : "#/components/responses/Idempotency422Response"
13014 },
13015 "429" : {
13016 "$ref" : "#/components/responses/Default429Response"
13017 },
13018 "500" : {
13019 "$ref" : "#/components/responses/Default500Response"
13020 },
13021 "503" : {
13022 "$ref" : "#/components/responses/Default503Response"
13023 }
13024 },
13025 "security" : [ {
13026 "Authorization_Code_PKCE" : [ "playlists.write", "w_usr" ]
13027 } ],
13028 "summary" : "Delete from items relationship (\"to-many\").",
13029 "tags" : [ "playlists" ],
13030 "x-path-item-properties" : {
13031 "required-access-tier" : "THIRD_PARTY"
13032 }
13033 },
13034 "get" : {
13035 "description" : "Retrieves items relationship.",
13036 "parameters" : [ {
13037 "description" : "Playlist id",
13038 "example" : "550e8400-e29b-41d4-a716-446655440000",
13039 "in" : "path",
13040 "name" : "id",
13041 "required" : true,
13042 "schema" : {
13043 "type" : "string"
13044 }
13045 }, {
13046 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
13047 "in" : "query",
13048 "name" : "page[cursor]",
13049 "required" : false,
13050 "schema" : {
13051 "type" : "string"
13052 }
13053 }, {
13054 "description" : "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
13055 "in" : "query",
13056 "name" : "sort",
13057 "required" : false,
13058 "schema" : {
13059 "type" : "array",
13060 "items" : {
13061 "type" : "string",
13062 "example" : "addedAt",
13063 "default" : "itemIndex",
13064 "enum" : [ "addedAt", "-addedAt", "albums.title", "-albums.title", "artists.name", "-artists.name", "duration", "-duration", "itemIndex", "-itemIndex", "title", "-title" ],
13065 "x-enum-varnames" : [ "AddedAtAsc", "AddedAtDesc", "AlbumsTitleAsc", "AlbumsTitleDesc", "ArtistsNameAsc", "ArtistsNameDesc", "DurationAsc", "DurationDesc", "ItemIndexAsc", "ItemIndexDesc", "TitleAsc", "TitleDesc" ]
13066 }
13067 }
13068 }, {
13069 "description" : "ISO 3166-1 alpha-2 country code",
13070 "example" : "US",
13071 "in" : "query",
13072 "name" : "countryCode",
13073 "required" : false,
13074 "schema" : {
13075 "type" : "string"
13076 }
13077 }, {
13078 "description" : "Allows the client to customize which related resources should be returned. Available options: items",
13079 "example" : "items",
13080 "in" : "query",
13081 "name" : "include",
13082 "required" : false,
13083 "schema" : {
13084 "type" : "array",
13085 "items" : {
13086 "type" : "string",
13087 "example" : "items"
13088 }
13089 }
13090 }, {
13091 "description" : "Filter playlist items by a free-text query (e.g. `halo`)",
13092 "in" : "query",
13093 "name" : "filter[query]",
13094 "required" : false,
13095 "schema" : {
13096 "maxLength" : 100,
13097 "type" : "string"
13098 }
13099 }, {
13100 "description" : "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",
13101 "example" : "items",
13102 "in" : "query",
13103 "name" : "replaceMedia",
13104 "required" : false,
13105 "schema" : {
13106 "type" : "string",
13107 "example" : "items"
13108 }
13109 } ],
13110 "responses" : {
13111 "200" : {
13112 "content" : {
13113 "application/vnd.api+json" : {
13114 "schema" : {
13115 "$ref" : "#/components/schemas/Playlists_Items_Multi_Relationship_Data_Document"
13116 }
13117 }
13118 },
13119 "description" : "Successful response"
13120 },
13121 "400" : {
13122 "$ref" : "#/components/responses/Default400Response"
13123 },
13124 "404" : {
13125 "$ref" : "#/components/responses/Default404Response"
13126 },
13127 "405" : {
13128 "$ref" : "#/components/responses/Default405Response"
13129 },
13130 "406" : {
13131 "$ref" : "#/components/responses/Default406Response"
13132 },
13133 "415" : {
13134 "$ref" : "#/components/responses/Default415Response"
13135 },
13136 "429" : {
13137 "$ref" : "#/components/responses/Default429Response"
13138 },
13139 "500" : {
13140 "$ref" : "#/components/responses/Default500Response"
13141 },
13142 "503" : {
13143 "$ref" : "#/components/responses/Default503Response"
13144 }
13145 },
13146 "security" : [ {
13147 "Client_Credentials" : [ ]
13148 }, {
13149 "Authorization_Code_PKCE" : [ ]
13150 } ],
13151 "summary" : "Get items relationship (\"to-many\").",
13152 "tags" : [ "playlists" ],
13153 "x-path-item-properties" : {
13154 "required-access-tier" : "THIRD_PARTY"
13155 }
13156 },
13157 "patch" : {
13158 "description" : "Updates items relationship.",
13159 "parameters" : [ {
13160 "description" : "Playlist id",
13161 "example" : "550e8400-e29b-41d4-a716-446655440000",
13162 "in" : "path",
13163 "name" : "id",
13164 "required" : true,
13165 "schema" : {
13166 "type" : "string"
13167 }
13168 }, {
13169 "$ref" : "#/components/parameters/IdempotencyKey"
13170 } ],
13171 "requestBody" : {
13172 "content" : {
13173 "application/vnd.api+json" : {
13174 "schema" : {
13175 "$ref" : "#/components/schemas/PlaylistsItemsRelationshipUpdateOperation_Payload"
13176 }
13177 }
13178 }
13179 },
13180 "responses" : {
13181 "400" : {
13182 "$ref" : "#/components/responses/Default400Response"
13183 },
13184 "404" : {
13185 "$ref" : "#/components/responses/Default404Response"
13186 },
13187 "405" : {
13188 "$ref" : "#/components/responses/Default405Response"
13189 },
13190 "406" : {
13191 "$ref" : "#/components/responses/Default406Response"
13192 },
13193 "409" : {
13194 "$ref" : "#/components/responses/Idempotency409Response"
13195 },
13196 "415" : {
13197 "$ref" : "#/components/responses/Default415Response"
13198 },
13199 "422" : {
13200 "$ref" : "#/components/responses/Idempotency422Response"
13201 },
13202 "429" : {
13203 "$ref" : "#/components/responses/Default429Response"
13204 },
13205 "500" : {
13206 "$ref" : "#/components/responses/Default500Response"
13207 },
13208 "503" : {
13209 "$ref" : "#/components/responses/Default503Response"
13210 }
13211 },
13212 "security" : [ {
13213 "Authorization_Code_PKCE" : [ "playlists.write", "w_usr" ]
13214 } ],
13215 "summary" : "Update items relationship (\"to-many\").",
13216 "tags" : [ "playlists" ],
13217 "x-path-item-properties" : {
13218 "required-access-tier" : "THIRD_PARTY"
13219 }
13220 },
13221 "post" : {
13222 "description" : "Adds item(s) to items relationship.",
13223 "parameters" : [ {
13224 "description" : "Playlist id",
13225 "example" : "550e8400-e29b-41d4-a716-446655440000",
13226 "in" : "path",
13227 "name" : "id",
13228 "required" : true,
13229 "schema" : {
13230 "type" : "string"
13231 }
13232 }, {
13233 "$ref" : "#/components/parameters/IdempotencyKey"
13234 } ],
13235 "requestBody" : {
13236 "content" : {
13237 "application/vnd.api+json" : {
13238 "schema" : {
13239 "$ref" : "#/components/schemas/PlaylistsItemsRelationshipAddOperation_Payload"
13240 }
13241 }
13242 }
13243 },
13244 "responses" : {
13245 "200" : {
13246 "content" : {
13247 "application/vnd.api+json" : {
13248 "schema" : {
13249 "$ref" : "#/components/schemas/Playlists_Items_Add_Multi_Relationship_Data_Document"
13250 }
13251 }
13252 },
13253 "description" : "Successful response"
13254 },
13255 "400" : {
13256 "$ref" : "#/components/responses/Default400Response"
13257 },
13258 "404" : {
13259 "$ref" : "#/components/responses/Default404Response"
13260 },
13261 "405" : {
13262 "$ref" : "#/components/responses/Default405Response"
13263 },
13264 "406" : {
13265 "$ref" : "#/components/responses/Default406Response"
13266 },
13267 "409" : {
13268 "$ref" : "#/components/responses/Idempotency409Response"
13269 },
13270 "415" : {
13271 "$ref" : "#/components/responses/Default415Response"
13272 },
13273 "422" : {
13274 "$ref" : "#/components/responses/Idempotency422Response"
13275 },
13276 "429" : {
13277 "$ref" : "#/components/responses/Default429Response"
13278 },
13279 "500" : {
13280 "$ref" : "#/components/responses/Default500Response"
13281 },
13282 "503" : {
13283 "$ref" : "#/components/responses/Default503Response"
13284 }
13285 },
13286 "security" : [ {
13287 "Authorization_Code_PKCE" : [ "playlists.write", "w_usr" ]
13288 } ],
13289 "summary" : "Add to items relationship (\"to-many\").",
13290 "tags" : [ "playlists" ],
13291 "x-path-item-properties" : {
13292 "required-access-tier" : "THIRD_PARTY"
13293 }
13294 }
13295 },
13296 "/playlists/{id}/relationships/ownerProfiles" : {
13297 "get" : {
13298 "description" : "Retrieves ownerProfiles relationship.",
13299 "parameters" : [ {
13300 "description" : "Playlist id",
13301 "example" : "550e8400-e29b-41d4-a716-446655440000",
13302 "in" : "path",
13303 "name" : "id",
13304 "required" : true,
13305 "schema" : {
13306 "type" : "string"
13307 }
13308 }, {
13309 "description" : "ISO 3166-1 alpha-2 country code",
13310 "example" : "US",
13311 "in" : "query",
13312 "name" : "countryCode",
13313 "required" : false,
13314 "schema" : {
13315 "type" : "string"
13316 }
13317 }, {
13318 "description" : "Allows the client to customize which related resources should be returned. Available options: ownerProfiles",
13319 "example" : "ownerProfiles",
13320 "in" : "query",
13321 "name" : "include",
13322 "required" : false,
13323 "schema" : {
13324 "type" : "array",
13325 "items" : {
13326 "type" : "string",
13327 "example" : "ownerProfiles"
13328 }
13329 }
13330 }, {
13331 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
13332 "in" : "query",
13333 "name" : "page[cursor]",
13334 "required" : false,
13335 "schema" : {
13336 "type" : "string"
13337 }
13338 } ],
13339 "responses" : {
13340 "200" : {
13341 "content" : {
13342 "application/vnd.api+json" : {
13343 "schema" : {
13344 "$ref" : "#/components/schemas/Playlists_Multi_Relationship_Data_Document"
13345 }
13346 }
13347 },
13348 "description" : "Successful response"
13349 },
13350 "400" : {
13351 "$ref" : "#/components/responses/Default400Response"
13352 },
13353 "404" : {
13354 "$ref" : "#/components/responses/Default404Response"
13355 },
13356 "405" : {
13357 "$ref" : "#/components/responses/Default405Response"
13358 },
13359 "406" : {
13360 "$ref" : "#/components/responses/Default406Response"
13361 },
13362 "415" : {
13363 "$ref" : "#/components/responses/Default415Response"
13364 },
13365 "429" : {
13366 "$ref" : "#/components/responses/Default429Response"
13367 },
13368 "500" : {
13369 "$ref" : "#/components/responses/Default500Response"
13370 },
13371 "503" : {
13372 "$ref" : "#/components/responses/Default503Response"
13373 }
13374 },
13375 "security" : [ {
13376 "Client_Credentials" : [ ]
13377 }, {
13378 "Authorization_Code_PKCE" : [ ]
13379 } ],
13380 "summary" : "Get ownerProfiles relationship (\"to-many\").",
13381 "tags" : [ "playlists" ],
13382 "x-path-item-properties" : {
13383 "required-access-tier" : "THIRD_PARTY"
13384 }
13385 }
13386 },
13387 "/playlists/{id}/relationships/owners" : {
13388 "get" : {
13389 "description" : "Retrieves owners relationship.",
13390 "parameters" : [ {
13391 "description" : "Playlist id",
13392 "example" : "550e8400-e29b-41d4-a716-446655440000",
13393 "in" : "path",
13394 "name" : "id",
13395 "required" : true,
13396 "schema" : {
13397 "type" : "string"
13398 }
13399 }, {
13400 "description" : "ISO 3166-1 alpha-2 country code",
13401 "example" : "US",
13402 "in" : "query",
13403 "name" : "countryCode",
13404 "required" : false,
13405 "schema" : {
13406 "type" : "string"
13407 }
13408 }, {
13409 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
13410 "example" : "owners",
13411 "in" : "query",
13412 "name" : "include",
13413 "required" : false,
13414 "schema" : {
13415 "type" : "array",
13416 "items" : {
13417 "type" : "string",
13418 "example" : "owners"
13419 }
13420 }
13421 }, {
13422 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
13423 "in" : "query",
13424 "name" : "page[cursor]",
13425 "required" : false,
13426 "schema" : {
13427 "type" : "string"
13428 }
13429 } ],
13430 "responses" : {
13431 "200" : {
13432 "content" : {
13433 "application/vnd.api+json" : {
13434 "schema" : {
13435 "$ref" : "#/components/schemas/Playlists_Multi_Relationship_Data_Document"
13436 }
13437 }
13438 },
13439 "description" : "Successful response"
13440 },
13441 "400" : {
13442 "$ref" : "#/components/responses/Default400Response"
13443 },
13444 "404" : {
13445 "$ref" : "#/components/responses/Default404Response"
13446 },
13447 "405" : {
13448 "$ref" : "#/components/responses/Default405Response"
13449 },
13450 "406" : {
13451 "$ref" : "#/components/responses/Default406Response"
13452 },
13453 "415" : {
13454 "$ref" : "#/components/responses/Default415Response"
13455 },
13456 "429" : {
13457 "$ref" : "#/components/responses/Default429Response"
13458 },
13459 "500" : {
13460 "$ref" : "#/components/responses/Default500Response"
13461 },
13462 "503" : {
13463 "$ref" : "#/components/responses/Default503Response"
13464 }
13465 },
13466 "security" : [ {
13467 "Client_Credentials" : [ ]
13468 }, {
13469 "Authorization_Code_PKCE" : [ ]
13470 } ],
13471 "summary" : "Get owners relationship (\"to-many\").",
13472 "tags" : [ "playlists" ],
13473 "x-path-item-properties" : {
13474 "required-access-tier" : "THIRD_PARTY"
13475 }
13476 }
13477 },
13478 "/playlists/{id}/relationships/suggestedCoverArts" : {
13479 "get" : {
13480 "description" : "Retrieves suggestedCoverArts relationship.",
13481 "parameters" : [ {
13482 "description" : "Playlist id",
13483 "example" : "550e8400-e29b-41d4-a716-446655440000",
13484 "in" : "path",
13485 "name" : "id",
13486 "required" : true,
13487 "schema" : {
13488 "type" : "string"
13489 }
13490 }, {
13491 "description" : "Allows the client to customize which related resources should be returned. Available options: suggestedCoverArts",
13492 "example" : "suggestedCoverArts",
13493 "in" : "query",
13494 "name" : "include",
13495 "required" : false,
13496 "schema" : {
13497 "type" : "array",
13498 "items" : {
13499 "type" : "string",
13500 "example" : "suggestedCoverArts"
13501 }
13502 }
13503 }, {
13504 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
13505 "in" : "query",
13506 "name" : "page[cursor]",
13507 "required" : false,
13508 "schema" : {
13509 "type" : "string"
13510 }
13511 } ],
13512 "responses" : {
13513 "200" : {
13514 "content" : {
13515 "application/vnd.api+json" : {
13516 "schema" : {
13517 "$ref" : "#/components/schemas/Playlists_SuggestedCoverArts_Multi_Relationship_Data_Document"
13518 }
13519 }
13520 },
13521 "description" : "Successful response"
13522 },
13523 "400" : {
13524 "$ref" : "#/components/responses/Default400Response"
13525 },
13526 "404" : {
13527 "$ref" : "#/components/responses/Default404Response"
13528 },
13529 "405" : {
13530 "$ref" : "#/components/responses/Default405Response"
13531 },
13532 "406" : {
13533 "$ref" : "#/components/responses/Default406Response"
13534 },
13535 "415" : {
13536 "$ref" : "#/components/responses/Default415Response"
13537 },
13538 "429" : {
13539 "$ref" : "#/components/responses/Default429Response"
13540 },
13541 "500" : {
13542 "$ref" : "#/components/responses/Default500Response"
13543 },
13544 "503" : {
13545 "$ref" : "#/components/responses/Default503Response"
13546 }
13547 },
13548 "security" : [ {
13549 "Authorization_Code_PKCE" : [ "r_usr" ]
13550 } ],
13551 "summary" : "Get suggestedCoverArts relationship (\"to-many\").",
13552 "tags" : [ "playlists" ],
13553 "x-path-item-properties" : {
13554 "required-access-tier" : "INTERNAL"
13555 }
13556 }
13557 },
13558 "/priceConfigurations" : {
13559 "get" : {
13560 "description" : "Retrieves multiple priceConfigurations by available filters, or without if applicable.",
13561 "parameters" : [ {
13562 "description" : "List of price configurations IDs (e.g. `cHJpY2UtY29uZmlnLTEyMzpVUw`)",
13563 "in" : "query",
13564 "name" : "filter[id]",
13565 "required" : true,
13566 "schema" : {
13567 "type" : "array",
13568 "items" : {
13569 "type" : "string"
13570 }
13571 }
13572 } ],
13573 "responses" : {
13574 "200" : {
13575 "content" : {
13576 "application/vnd.api+json" : {
13577 "schema" : {
13578 "$ref" : "#/components/schemas/PriceConfigurations_Multi_Resource_Data_Document"
13579 }
13580 }
13581 },
13582 "description" : "Successful response"
13583 },
13584 "400" : {
13585 "$ref" : "#/components/responses/Default400Response"
13586 },
13587 "404" : {
13588 "$ref" : "#/components/responses/Default404Response"
13589 },
13590 "405" : {
13591 "$ref" : "#/components/responses/Default405Response"
13592 },
13593 "406" : {
13594 "$ref" : "#/components/responses/Default406Response"
13595 },
13596 "415" : {
13597 "$ref" : "#/components/responses/Default415Response"
13598 },
13599 "429" : {
13600 "$ref" : "#/components/responses/Default429Response"
13601 },
13602 "500" : {
13603 "$ref" : "#/components/responses/Default500Response"
13604 },
13605 "503" : {
13606 "$ref" : "#/components/responses/Default503Response"
13607 }
13608 },
13609 "security" : [ {
13610 "Client_Credentials" : [ ]
13611 }, {
13612 "Authorization_Code_PKCE" : [ ]
13613 } ],
13614 "summary" : "Get multiple priceConfigurations.",
13615 "tags" : [ "priceConfigurations" ],
13616 "x-path-item-properties" : {
13617 "required-access-tier" : "INTERNAL"
13618 }
13619 },
13620 "post" : {
13621 "description" : "Creates a new priceConfiguration.",
13622 "parameters" : [ {
13623 "$ref" : "#/components/parameters/IdempotencyKey"
13624 } ],
13625 "requestBody" : {
13626 "content" : {
13627 "application/vnd.api+json" : {
13628 "schema" : {
13629 "$ref" : "#/components/schemas/PriceConfigurationsCreateOperation_Payload"
13630 }
13631 }
13632 }
13633 },
13634 "responses" : {
13635 "201" : {
13636 "content" : {
13637 "application/vnd.api+json" : {
13638 "schema" : {
13639 "$ref" : "#/components/schemas/PriceConfigurations_Create_Single_Resource_Data_Document"
13640 }
13641 }
13642 },
13643 "description" : "Successful response"
13644 },
13645 "400" : {
13646 "$ref" : "#/components/responses/Default400Response"
13647 },
13648 "404" : {
13649 "$ref" : "#/components/responses/Default404Response"
13650 },
13651 "405" : {
13652 "$ref" : "#/components/responses/Default405Response"
13653 },
13654 "406" : {
13655 "$ref" : "#/components/responses/Default406Response"
13656 },
13657 "409" : {
13658 "$ref" : "#/components/responses/Idempotency409Response"
13659 },
13660 "415" : {
13661 "$ref" : "#/components/responses/Default415Response"
13662 },
13663 "422" : {
13664 "$ref" : "#/components/responses/Idempotency422Response"
13665 },
13666 "429" : {
13667 "$ref" : "#/components/responses/Default429Response"
13668 },
13669 "500" : {
13670 "$ref" : "#/components/responses/Default500Response"
13671 },
13672 "503" : {
13673 "$ref" : "#/components/responses/Default503Response"
13674 }
13675 },
13676 "security" : [ {
13677 "Authorization_Code_PKCE" : [ "w_usr" ]
13678 } ],
13679 "summary" : "Create single priceConfiguration.",
13680 "tags" : [ "priceConfigurations" ],
13681 "x-path-item-properties" : {
13682 "required-access-tier" : "INTERNAL"
13683 }
13684 }
13685 },
13686 "/priceConfigurations/{id}" : {
13687 "get" : {
13688 "description" : "Retrieves single priceConfiguration by id.",
13689 "parameters" : [ {
13690 "description" : "Price configuration id",
13691 "example" : "cHJpY2UtY29uZmlnLTEyMzpVUw",
13692 "in" : "path",
13693 "name" : "id",
13694 "required" : true,
13695 "schema" : {
13696 "type" : "string"
13697 }
13698 } ],
13699 "responses" : {
13700 "200" : {
13701 "content" : {
13702 "application/vnd.api+json" : {
13703 "schema" : {
13704 "$ref" : "#/components/schemas/PriceConfigurations_Single_Resource_Data_Document"
13705 }
13706 }
13707 },
13708 "description" : "Successful response"
13709 },
13710 "400" : {
13711 "$ref" : "#/components/responses/Default400Response"
13712 },
13713 "404" : {
13714 "$ref" : "#/components/responses/Default404Response"
13715 },
13716 "405" : {
13717 "$ref" : "#/components/responses/Default405Response"
13718 },
13719 "406" : {
13720 "$ref" : "#/components/responses/Default406Response"
13721 },
13722 "415" : {
13723 "$ref" : "#/components/responses/Default415Response"
13724 },
13725 "429" : {
13726 "$ref" : "#/components/responses/Default429Response"
13727 },
13728 "500" : {
13729 "$ref" : "#/components/responses/Default500Response"
13730 },
13731 "503" : {
13732 "$ref" : "#/components/responses/Default503Response"
13733 }
13734 },
13735 "security" : [ {
13736 "Client_Credentials" : [ ]
13737 }, {
13738 "Authorization_Code_PKCE" : [ ]
13739 } ],
13740 "summary" : "Get single priceConfiguration.",
13741 "tags" : [ "priceConfigurations" ],
13742 "x-path-item-properties" : {
13743 "required-access-tier" : "INTERNAL"
13744 }
13745 }
13746 },
13747 "/providerOwners" : {
13748 "get" : {
13749 "description" : "Retrieves multiple providerOwners by available filters, or without if applicable.",
13750 "parameters" : [ {
13751 "description" : "User id. Use `me` for the authenticated user",
13752 "in" : "query",
13753 "name" : "filter[owners.id]",
13754 "required" : true,
13755 "schema" : {
13756 "type" : "array",
13757 "items" : {
13758 "type" : "string"
13759 }
13760 }
13761 }, {
13762 "description" : "Allows the client to customize which related resources should be returned. Available options: owners, provider",
13763 "example" : "owners",
13764 "in" : "query",
13765 "name" : "include",
13766 "required" : false,
13767 "schema" : {
13768 "type" : "array",
13769 "items" : {
13770 "type" : "string",
13771 "example" : "owners"
13772 }
13773 }
13774 } ],
13775 "responses" : {
13776 "200" : {
13777 "content" : {
13778 "application/vnd.api+json" : {
13779 "schema" : {
13780 "$ref" : "#/components/schemas/ProviderOwners_Multi_Resource_Data_Document"
13781 }
13782 }
13783 },
13784 "description" : "Successful response"
13785 },
13786 "400" : {
13787 "$ref" : "#/components/responses/Default400Response"
13788 },
13789 "404" : {
13790 "$ref" : "#/components/responses/Default404Response"
13791 },
13792 "405" : {
13793 "$ref" : "#/components/responses/Default405Response"
13794 },
13795 "406" : {
13796 "$ref" : "#/components/responses/Default406Response"
13797 },
13798 "415" : {
13799 "$ref" : "#/components/responses/Default415Response"
13800 },
13801 "429" : {
13802 "$ref" : "#/components/responses/Default429Response"
13803 },
13804 "500" : {
13805 "$ref" : "#/components/responses/Default500Response"
13806 },
13807 "503" : {
13808 "$ref" : "#/components/responses/Default503Response"
13809 }
13810 },
13811 "security" : [ {
13812 "Authorization_Code_PKCE" : [ "r_usr" ]
13813 } ],
13814 "summary" : "Get multiple providerOwners.",
13815 "tags" : [ "providerOwners" ],
13816 "x-path-item-properties" : {
13817 "required-access-tier" : "INTERNAL"
13818 }
13819 }
13820 },
13821 "/providerOwners/{id}/relationships/owners" : {
13822 "get" : {
13823 "description" : "Retrieves owners relationship.",
13824 "parameters" : [ {
13825 "description" : "Provider owner id",
13826 "in" : "path",
13827 "name" : "id",
13828 "required" : true,
13829 "schema" : {
13830 "type" : "string"
13831 }
13832 }, {
13833 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
13834 "example" : "owners",
13835 "in" : "query",
13836 "name" : "include",
13837 "required" : false,
13838 "schema" : {
13839 "type" : "array",
13840 "items" : {
13841 "type" : "string",
13842 "example" : "owners"
13843 }
13844 }
13845 }, {
13846 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
13847 "in" : "query",
13848 "name" : "page[cursor]",
13849 "required" : false,
13850 "schema" : {
13851 "type" : "string"
13852 }
13853 } ],
13854 "responses" : {
13855 "200" : {
13856 "content" : {
13857 "application/vnd.api+json" : {
13858 "schema" : {
13859 "$ref" : "#/components/schemas/ProviderOwners_Multi_Relationship_Data_Document"
13860 }
13861 }
13862 },
13863 "description" : "Successful response"
13864 },
13865 "400" : {
13866 "$ref" : "#/components/responses/Default400Response"
13867 },
13868 "404" : {
13869 "$ref" : "#/components/responses/Default404Response"
13870 },
13871 "405" : {
13872 "$ref" : "#/components/responses/Default405Response"
13873 },
13874 "406" : {
13875 "$ref" : "#/components/responses/Default406Response"
13876 },
13877 "415" : {
13878 "$ref" : "#/components/responses/Default415Response"
13879 },
13880 "429" : {
13881 "$ref" : "#/components/responses/Default429Response"
13882 },
13883 "500" : {
13884 "$ref" : "#/components/responses/Default500Response"
13885 },
13886 "503" : {
13887 "$ref" : "#/components/responses/Default503Response"
13888 }
13889 },
13890 "security" : [ {
13891 "Authorization_Code_PKCE" : [ "r_usr" ]
13892 } ],
13893 "summary" : "Get owners relationship (\"to-many\").",
13894 "tags" : [ "providerOwners" ],
13895 "x-path-item-properties" : {
13896 "required-access-tier" : "INTERNAL"
13897 }
13898 }
13899 },
13900 "/providerOwners/{id}/relationships/provider" : {
13901 "get" : {
13902 "description" : "Retrieves provider relationship.",
13903 "parameters" : [ {
13904 "description" : "Provider owner id",
13905 "in" : "path",
13906 "name" : "id",
13907 "required" : true,
13908 "schema" : {
13909 "type" : "string"
13910 }
13911 }, {
13912 "description" : "Allows the client to customize which related resources should be returned. Available options: provider",
13913 "example" : "provider",
13914 "in" : "query",
13915 "name" : "include",
13916 "required" : false,
13917 "schema" : {
13918 "type" : "array",
13919 "items" : {
13920 "type" : "string",
13921 "example" : "provider"
13922 }
13923 }
13924 } ],
13925 "responses" : {
13926 "200" : {
13927 "content" : {
13928 "application/vnd.api+json" : {
13929 "schema" : {
13930 "$ref" : "#/components/schemas/ProviderOwners_Single_Relationship_Data_Document"
13931 }
13932 }
13933 },
13934 "description" : "Successful response"
13935 },
13936 "400" : {
13937 "$ref" : "#/components/responses/Default400Response"
13938 },
13939 "404" : {
13940 "$ref" : "#/components/responses/Default404Response"
13941 },
13942 "405" : {
13943 "$ref" : "#/components/responses/Default405Response"
13944 },
13945 "406" : {
13946 "$ref" : "#/components/responses/Default406Response"
13947 },
13948 "415" : {
13949 "$ref" : "#/components/responses/Default415Response"
13950 },
13951 "429" : {
13952 "$ref" : "#/components/responses/Default429Response"
13953 },
13954 "500" : {
13955 "$ref" : "#/components/responses/Default500Response"
13956 },
13957 "503" : {
13958 "$ref" : "#/components/responses/Default503Response"
13959 }
13960 },
13961 "security" : [ {
13962 "Authorization_Code_PKCE" : [ "r_usr" ]
13963 } ],
13964 "summary" : "Get provider relationship (\"to-one\").",
13965 "tags" : [ "providerOwners" ],
13966 "x-path-item-properties" : {
13967 "required-access-tier" : "INTERNAL"
13968 }
13969 }
13970 },
13971 "/providerProductInfos" : {
13972 "get" : {
13973 "description" : "Retrieves multiple providerProductInfos by available filters, or without if applicable.",
13974 "parameters" : [ {
13975 "description" : "Content provider ID (e.g. `50`)",
13976 "in" : "query",
13977 "name" : "filter[provider.id]",
13978 "required" : true,
13979 "schema" : {
13980 "type" : "array",
13981 "items" : {
13982 "type" : "string"
13983 }
13984 }
13985 }, {
13986 "description" : "ISO 3166-1 alpha-2 country code",
13987 "example" : "US",
13988 "in" : "query",
13989 "name" : "countryCode",
13990 "required" : false,
13991 "schema" : {
13992 "type" : "string"
13993 }
13994 }, {
13995 "description" : "Allows the client to customize which related resources should be returned. Available options: provider, subject",
13996 "example" : "subject",
13997 "in" : "query",
13998 "name" : "include",
13999 "required" : false,
14000 "schema" : {
14001 "type" : "array",
14002 "items" : {
14003 "type" : "string",
14004 "example" : "subject"
14005 }
14006 }
14007 }, {
14008 "description" : "List of barcode IDs (EAN-13 or UPC-A) (e.g. `00602527336510`)",
14009 "in" : "query",
14010 "name" : "filter[barcodeId]",
14011 "required" : false,
14012 "schema" : {
14013 "type" : "array",
14014 "items" : {
14015 "type" : "string"
14016 }
14017 }
14018 }, {
14019 "description" : "List of GRIDs (Global Release Identifier, ISO 7064) (e.g. `A10302B0013941653J`)",
14020 "in" : "query",
14021 "name" : "filter[grid]",
14022 "required" : false,
14023 "schema" : {
14024 "type" : "array",
14025 "items" : {
14026 "type" : "string"
14027 }
14028 }
14029 }, {
14030 "description" : "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",
14031 "example" : "subject",
14032 "in" : "query",
14033 "name" : "replaceMedia",
14034 "required" : false,
14035 "schema" : {
14036 "type" : "string",
14037 "example" : "subject"
14038 }
14039 } ],
14040 "responses" : {
14041 "200" : {
14042 "content" : {
14043 "application/vnd.api+json" : {
14044 "schema" : {
14045 "$ref" : "#/components/schemas/ProviderProductInfos_Multi_Resource_Data_Document"
14046 }
14047 }
14048 },
14049 "description" : "Successful response"
14050 },
14051 "400" : {
14052 "$ref" : "#/components/responses/Default400Response"
14053 },
14054 "404" : {
14055 "$ref" : "#/components/responses/Default404Response"
14056 },
14057 "405" : {
14058 "$ref" : "#/components/responses/Default405Response"
14059 },
14060 "406" : {
14061 "$ref" : "#/components/responses/Default406Response"
14062 },
14063 "415" : {
14064 "$ref" : "#/components/responses/Default415Response"
14065 },
14066 "429" : {
14067 "$ref" : "#/components/responses/Default429Response"
14068 },
14069 "500" : {
14070 "$ref" : "#/components/responses/Default500Response"
14071 },
14072 "503" : {
14073 "$ref" : "#/components/responses/Default503Response"
14074 }
14075 },
14076 "security" : [ {
14077 "Authorization_Code_PKCE" : [ "r_usr" ]
14078 } ],
14079 "summary" : "Get multiple providerProductInfos.",
14080 "tags" : [ "providerProductInfos" ],
14081 "x-path-item-properties" : {
14082 "required-access-tier" : "INTERNAL"
14083 }
14084 }
14085 },
14086 "/providerProductInfos/{id}/relationships/provider" : {
14087 "get" : {
14088 "description" : "Retrieves provider relationship.",
14089 "parameters" : [ {
14090 "description" : "Provider product info id",
14091 "in" : "path",
14092 "name" : "id",
14093 "required" : true,
14094 "schema" : {
14095 "type" : "string"
14096 }
14097 }, {
14098 "description" : "Allows the client to customize which related resources should be returned. Available options: provider",
14099 "example" : "provider",
14100 "in" : "query",
14101 "name" : "include",
14102 "required" : false,
14103 "schema" : {
14104 "type" : "array",
14105 "items" : {
14106 "type" : "string",
14107 "example" : "provider"
14108 }
14109 }
14110 } ],
14111 "responses" : {
14112 "200" : {
14113 "content" : {
14114 "application/vnd.api+json" : {
14115 "schema" : {
14116 "$ref" : "#/components/schemas/ProviderProductInfos_Single_Relationship_Data_Document"
14117 }
14118 }
14119 },
14120 "description" : "Successful response"
14121 },
14122 "400" : {
14123 "$ref" : "#/components/responses/Default400Response"
14124 },
14125 "404" : {
14126 "$ref" : "#/components/responses/Default404Response"
14127 },
14128 "405" : {
14129 "$ref" : "#/components/responses/Default405Response"
14130 },
14131 "406" : {
14132 "$ref" : "#/components/responses/Default406Response"
14133 },
14134 "415" : {
14135 "$ref" : "#/components/responses/Default415Response"
14136 },
14137 "429" : {
14138 "$ref" : "#/components/responses/Default429Response"
14139 },
14140 "500" : {
14141 "$ref" : "#/components/responses/Default500Response"
14142 },
14143 "503" : {
14144 "$ref" : "#/components/responses/Default503Response"
14145 }
14146 },
14147 "security" : [ {
14148 "Authorization_Code_PKCE" : [ "r_usr" ]
14149 } ],
14150 "summary" : "Get provider relationship (\"to-one\").",
14151 "tags" : [ "providerProductInfos" ],
14152 "x-path-item-properties" : {
14153 "required-access-tier" : "INTERNAL"
14154 }
14155 }
14156 },
14157 "/providerProductInfos/{id}/relationships/subject" : {
14158 "get" : {
14159 "description" : "Retrieves subject relationship.",
14160 "parameters" : [ {
14161 "description" : "Provider product info id",
14162 "in" : "path",
14163 "name" : "id",
14164 "required" : true,
14165 "schema" : {
14166 "type" : "string"
14167 }
14168 }, {
14169 "description" : "ISO 3166-1 alpha-2 country code",
14170 "example" : "US",
14171 "in" : "query",
14172 "name" : "countryCode",
14173 "required" : false,
14174 "schema" : {
14175 "type" : "string"
14176 }
14177 }, {
14178 "description" : "Allows the client to customize which related resources should be returned. Available options: subject",
14179 "example" : "subject",
14180 "in" : "query",
14181 "name" : "include",
14182 "required" : false,
14183 "schema" : {
14184 "type" : "array",
14185 "items" : {
14186 "type" : "string",
14187 "example" : "subject"
14188 }
14189 }
14190 }, {
14191 "description" : "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",
14192 "example" : "subject",
14193 "in" : "query",
14194 "name" : "replaceMedia",
14195 "required" : false,
14196 "schema" : {
14197 "type" : "string",
14198 "example" : "subject"
14199 }
14200 } ],
14201 "responses" : {
14202 "200" : {
14203 "content" : {
14204 "application/vnd.api+json" : {
14205 "schema" : {
14206 "$ref" : "#/components/schemas/ProviderProductInfos_Single_Relationship_Data_Document"
14207 }
14208 }
14209 },
14210 "description" : "Successful response"
14211 },
14212 "400" : {
14213 "$ref" : "#/components/responses/Default400Response"
14214 },
14215 "404" : {
14216 "$ref" : "#/components/responses/Default404Response"
14217 },
14218 "405" : {
14219 "$ref" : "#/components/responses/Default405Response"
14220 },
14221 "406" : {
14222 "$ref" : "#/components/responses/Default406Response"
14223 },
14224 "415" : {
14225 "$ref" : "#/components/responses/Default415Response"
14226 },
14227 "429" : {
14228 "$ref" : "#/components/responses/Default429Response"
14229 },
14230 "500" : {
14231 "$ref" : "#/components/responses/Default500Response"
14232 },
14233 "503" : {
14234 "$ref" : "#/components/responses/Default503Response"
14235 }
14236 },
14237 "security" : [ {
14238 "Authorization_Code_PKCE" : [ "r_usr" ]
14239 } ],
14240 "summary" : "Get subject relationship (\"to-one\").",
14241 "tags" : [ "providerProductInfos" ],
14242 "x-path-item-properties" : {
14243 "required-access-tier" : "INTERNAL"
14244 }
14245 }
14246 },
14247 "/providers/{id}" : {
14248 "get" : {
14249 "description" : "Retrieves single provider by id.",
14250 "parameters" : [ {
14251 "description" : "Provider ID",
14252 "example" : "12345",
14253 "in" : "path",
14254 "name" : "id",
14255 "required" : true,
14256 "schema" : {
14257 "type" : "string"
14258 }
14259 } ],
14260 "responses" : {
14261 "200" : {
14262 "content" : {
14263 "application/vnd.api+json" : {
14264 "schema" : {
14265 "$ref" : "#/components/schemas/Providers_Single_Resource_Data_Document"
14266 }
14267 }
14268 },
14269 "description" : "Successful response"
14270 },
14271 "400" : {
14272 "$ref" : "#/components/responses/Default400Response"
14273 },
14274 "404" : {
14275 "$ref" : "#/components/responses/Default404Response"
14276 },
14277 "405" : {
14278 "$ref" : "#/components/responses/Default405Response"
14279 },
14280 "406" : {
14281 "$ref" : "#/components/responses/Default406Response"
14282 },
14283 "415" : {
14284 "$ref" : "#/components/responses/Default415Response"
14285 },
14286 "429" : {
14287 "$ref" : "#/components/responses/Default429Response"
14288 },
14289 "500" : {
14290 "$ref" : "#/components/responses/Default500Response"
14291 },
14292 "503" : {
14293 "$ref" : "#/components/responses/Default503Response"
14294 }
14295 },
14296 "security" : [ {
14297 "Client_Credentials" : [ ]
14298 }, {
14299 "Authorization_Code_PKCE" : [ ]
14300 } ],
14301 "summary" : "Get single provider.",
14302 "tags" : [ "providers" ],
14303 "x-path-item-properties" : {
14304 "required-access-tier" : "THIRD_PARTY"
14305 }
14306 }
14307 },
14308 "/purchases" : {
14309 "get" : {
14310 "description" : "Retrieves multiple purchases by available filters, or without if applicable.",
14311 "parameters" : [ {
14312 "description" : "User id. Use `me` for the authenticated user",
14313 "in" : "query",
14314 "name" : "filter[owners.id]",
14315 "required" : true,
14316 "schema" : {
14317 "type" : "array",
14318 "items" : {
14319 "type" : "string"
14320 }
14321 }
14322 }, {
14323 "description" : "The type of purchased content (e.g. `albums`)",
14324 "in" : "query",
14325 "name" : "filter[subject.type]",
14326 "required" : true,
14327 "schema" : {
14328 "type" : "array",
14329 "items" : {
14330 "type" : "string",
14331 "enum" : [ "albums", "tracks" ]
14332 }
14333 }
14334 }, {
14335 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
14336 "in" : "query",
14337 "name" : "page[cursor]",
14338 "required" : false,
14339 "schema" : {
14340 "type" : "string"
14341 }
14342 }, {
14343 "description" : "Allows the client to customize which related resources should be returned. Available options: owners, subject",
14344 "example" : "subject",
14345 "in" : "query",
14346 "name" : "include",
14347 "required" : false,
14348 "schema" : {
14349 "type" : "array",
14350 "items" : {
14351 "type" : "string",
14352 "example" : "subject"
14353 }
14354 }
14355 }, {
14356 "description" : "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",
14357 "example" : "subject",
14358 "in" : "query",
14359 "name" : "replaceMedia",
14360 "required" : false,
14361 "schema" : {
14362 "type" : "string",
14363 "example" : "subject"
14364 }
14365 } ],
14366 "responses" : {
14367 "200" : {
14368 "content" : {
14369 "application/vnd.api+json" : {
14370 "schema" : {
14371 "$ref" : "#/components/schemas/Purchases_Multi_Resource_Data_Document"
14372 }
14373 }
14374 },
14375 "description" : "Successful response"
14376 },
14377 "400" : {
14378 "$ref" : "#/components/responses/Default400Response"
14379 },
14380 "404" : {
14381 "$ref" : "#/components/responses/Default404Response"
14382 },
14383 "405" : {
14384 "$ref" : "#/components/responses/Default405Response"
14385 },
14386 "406" : {
14387 "$ref" : "#/components/responses/Default406Response"
14388 },
14389 "415" : {
14390 "$ref" : "#/components/responses/Default415Response"
14391 },
14392 "429" : {
14393 "$ref" : "#/components/responses/Default429Response"
14394 },
14395 "500" : {
14396 "$ref" : "#/components/responses/Default500Response"
14397 },
14398 "503" : {
14399 "$ref" : "#/components/responses/Default503Response"
14400 }
14401 },
14402 "security" : [ {
14403 "Authorization_Code_PKCE" : [ "r_usr" ]
14404 } ],
14405 "summary" : "Get multiple purchases.",
14406 "tags" : [ "purchases" ],
14407 "x-path-item-properties" : {
14408 "required-access-tier" : "INTERNAL"
14409 }
14410 }
14411 },
14412 "/purchases/{id}/relationships/owners" : {
14413 "get" : {
14414 "description" : "Retrieves owners relationship.",
14415 "parameters" : [ {
14416 "description" : "Purchase id",
14417 "example" : "3fG7kLmN2pQrStUv",
14418 "in" : "path",
14419 "name" : "id",
14420 "required" : true,
14421 "schema" : {
14422 "type" : "string"
14423 }
14424 }, {
14425 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
14426 "example" : "owners",
14427 "in" : "query",
14428 "name" : "include",
14429 "required" : false,
14430 "schema" : {
14431 "type" : "array",
14432 "items" : {
14433 "type" : "string",
14434 "example" : "owners"
14435 }
14436 }
14437 }, {
14438 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
14439 "in" : "query",
14440 "name" : "page[cursor]",
14441 "required" : false,
14442 "schema" : {
14443 "type" : "string"
14444 }
14445 } ],
14446 "responses" : {
14447 "200" : {
14448 "content" : {
14449 "application/vnd.api+json" : {
14450 "schema" : {
14451 "$ref" : "#/components/schemas/Purchases_Multi_Relationship_Data_Document"
14452 }
14453 }
14454 },
14455 "description" : "Successful response"
14456 },
14457 "400" : {
14458 "$ref" : "#/components/responses/Default400Response"
14459 },
14460 "404" : {
14461 "$ref" : "#/components/responses/Default404Response"
14462 },
14463 "405" : {
14464 "$ref" : "#/components/responses/Default405Response"
14465 },
14466 "406" : {
14467 "$ref" : "#/components/responses/Default406Response"
14468 },
14469 "415" : {
14470 "$ref" : "#/components/responses/Default415Response"
14471 },
14472 "429" : {
14473 "$ref" : "#/components/responses/Default429Response"
14474 },
14475 "500" : {
14476 "$ref" : "#/components/responses/Default500Response"
14477 },
14478 "503" : {
14479 "$ref" : "#/components/responses/Default503Response"
14480 }
14481 },
14482 "security" : [ {
14483 "Authorization_Code_PKCE" : [ "r_usr" ]
14484 } ],
14485 "summary" : "Get owners relationship (\"to-many\").",
14486 "tags" : [ "purchases" ],
14487 "x-path-item-properties" : {
14488 "required-access-tier" : "INTERNAL"
14489 }
14490 }
14491 },
14492 "/purchases/{id}/relationships/subject" : {
14493 "get" : {
14494 "description" : "Retrieves subject relationship.",
14495 "parameters" : [ {
14496 "description" : "Purchase id",
14497 "example" : "3fG7kLmN2pQrStUv",
14498 "in" : "path",
14499 "name" : "id",
14500 "required" : true,
14501 "schema" : {
14502 "type" : "string"
14503 }
14504 }, {
14505 "description" : "Allows the client to customize which related resources should be returned. Available options: subject",
14506 "example" : "subject",
14507 "in" : "query",
14508 "name" : "include",
14509 "required" : false,
14510 "schema" : {
14511 "type" : "array",
14512 "items" : {
14513 "type" : "string",
14514 "example" : "subject"
14515 }
14516 }
14517 }, {
14518 "description" : "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",
14519 "example" : "subject",
14520 "in" : "query",
14521 "name" : "replaceMedia",
14522 "required" : false,
14523 "schema" : {
14524 "type" : "string",
14525 "example" : "subject"
14526 }
14527 } ],
14528 "responses" : {
14529 "200" : {
14530 "content" : {
14531 "application/vnd.api+json" : {
14532 "schema" : {
14533 "$ref" : "#/components/schemas/Purchases_Single_Relationship_Data_Document"
14534 }
14535 }
14536 },
14537 "description" : "Successful response"
14538 },
14539 "400" : {
14540 "$ref" : "#/components/responses/Default400Response"
14541 },
14542 "404" : {
14543 "$ref" : "#/components/responses/Default404Response"
14544 },
14545 "405" : {
14546 "$ref" : "#/components/responses/Default405Response"
14547 },
14548 "406" : {
14549 "$ref" : "#/components/responses/Default406Response"
14550 },
14551 "415" : {
14552 "$ref" : "#/components/responses/Default415Response"
14553 },
14554 "429" : {
14555 "$ref" : "#/components/responses/Default429Response"
14556 },
14557 "500" : {
14558 "$ref" : "#/components/responses/Default500Response"
14559 },
14560 "503" : {
14561 "$ref" : "#/components/responses/Default503Response"
14562 }
14563 },
14564 "security" : [ {
14565 "Authorization_Code_PKCE" : [ "r_usr" ]
14566 } ],
14567 "summary" : "Get subject relationship (\"to-one\").",
14568 "tags" : [ "purchases" ],
14569 "x-path-item-properties" : {
14570 "required-access-tier" : "INTERNAL"
14571 }
14572 }
14573 },
14574 "/reactions" : {
14575 "get" : {
14576 "description" : "Retrieves multiple reactions by available filters, or without if applicable.",
14577 "parameters" : [ {
14578 "description" : "Filter by subject resource ID (e.g. `12345`)",
14579 "in" : "query",
14580 "name" : "filter[subject.id]",
14581 "required" : true,
14582 "schema" : {
14583 "type" : "array",
14584 "items" : {
14585 "type" : "string"
14586 }
14587 }
14588 }, {
14589 "description" : "Filter by subject resource type (e.g. `albums`)",
14590 "in" : "query",
14591 "name" : "filter[subject.type]",
14592 "required" : true,
14593 "schema" : {
14594 "type" : "array",
14595 "items" : {
14596 "type" : "string",
14597 "enum" : [ "albums", "tracks", "artists", "videos", "playlists", "comments" ]
14598 }
14599 }
14600 }, {
14601 "in" : "query",
14602 "name" : "stats",
14603 "required" : false,
14604 "schema" : {
14605 "type" : "string",
14606 "enum" : [ "ALL", "COUNTS_BY_TYPE", "TOTAL_COUNT" ]
14607 }
14608 }, {
14609 "in" : "query",
14610 "name" : "statsOnly",
14611 "required" : false,
14612 "schema" : {
14613 "type" : "boolean"
14614 }
14615 }, {
14616 "in" : "query",
14617 "name" : "viewerContext",
14618 "required" : false,
14619 "schema" : {
14620 "type" : "string"
14621 }
14622 }, {
14623 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
14624 "in" : "query",
14625 "name" : "page[cursor]",
14626 "required" : false,
14627 "schema" : {
14628 "type" : "string"
14629 }
14630 }, {
14631 "description" : "Allows the client to customize which related resources should be returned. Available options: ownerProfiles, owners",
14632 "example" : "ownerProfiles",
14633 "in" : "query",
14634 "name" : "include",
14635 "required" : false,
14636 "schema" : {
14637 "type" : "array",
14638 "items" : {
14639 "type" : "string",
14640 "example" : "ownerProfiles"
14641 }
14642 }
14643 }, {
14644 "description" : "Filter by emoji (e.g. `ð`)",
14645 "in" : "query",
14646 "name" : "filter[emoji]",
14647 "required" : false,
14648 "schema" : {
14649 "type" : "array",
14650 "items" : {
14651 "type" : "string"
14652 }
14653 }
14654 } ],
14655 "responses" : {
14656 "200" : {
14657 "content" : {
14658 "application/vnd.api+json" : {
14659 "schema" : {
14660 "$ref" : "#/components/schemas/Reactions_Multi_Resource_Data_Document"
14661 }
14662 }
14663 },
14664 "description" : "Successful response"
14665 },
14666 "400" : {
14667 "$ref" : "#/components/responses/Default400Response"
14668 },
14669 "404" : {
14670 "$ref" : "#/components/responses/Default404Response"
14671 },
14672 "405" : {
14673 "$ref" : "#/components/responses/Default405Response"
14674 },
14675 "406" : {
14676 "$ref" : "#/components/responses/Default406Response"
14677 },
14678 "415" : {
14679 "$ref" : "#/components/responses/Default415Response"
14680 },
14681 "429" : {
14682 "$ref" : "#/components/responses/Default429Response"
14683 },
14684 "500" : {
14685 "$ref" : "#/components/responses/Default500Response"
14686 },
14687 "503" : {
14688 "$ref" : "#/components/responses/Default503Response"
14689 }
14690 },
14691 "security" : [ {
14692 "Authorization_Code_PKCE" : [ ]
14693 } ],
14694 "summary" : "Get multiple reactions.",
14695 "tags" : [ "reactions" ],
14696 "x-path-item-properties" : {
14697 "required-access-tier" : "INTERNAL"
14698 }
14699 },
14700 "post" : {
14701 "description" : "Creates a new reaction.",
14702 "parameters" : [ {
14703 "$ref" : "#/components/parameters/IdempotencyKey"
14704 } ],
14705 "requestBody" : {
14706 "content" : {
14707 "application/vnd.api+json" : {
14708 "schema" : {
14709 "$ref" : "#/components/schemas/ReactionsCreateOperation_Payload"
14710 }
14711 }
14712 }
14713 },
14714 "responses" : {
14715 "201" : {
14716 "content" : {
14717 "application/vnd.api+json" : {
14718 "schema" : {
14719 "$ref" : "#/components/schemas/Reactions_Create_Single_Resource_Data_Document"
14720 }
14721 }
14722 },
14723 "description" : "Successful response"
14724 },
14725 "400" : {
14726 "$ref" : "#/components/responses/Default400Response"
14727 },
14728 "404" : {
14729 "$ref" : "#/components/responses/Default404Response"
14730 },
14731 "405" : {
14732 "$ref" : "#/components/responses/Default405Response"
14733 },
14734 "406" : {
14735 "$ref" : "#/components/responses/Default406Response"
14736 },
14737 "409" : {
14738 "$ref" : "#/components/responses/Idempotency409Response"
14739 },
14740 "415" : {
14741 "$ref" : "#/components/responses/Default415Response"
14742 },
14743 "422" : {
14744 "$ref" : "#/components/responses/Idempotency422Response"
14745 },
14746 "429" : {
14747 "$ref" : "#/components/responses/Default429Response"
14748 },
14749 "500" : {
14750 "$ref" : "#/components/responses/Default500Response"
14751 },
14752 "503" : {
14753 "$ref" : "#/components/responses/Default503Response"
14754 }
14755 },
14756 "security" : [ {
14757 "Authorization_Code_PKCE" : [ "w_usr" ]
14758 } ],
14759 "summary" : "Create single reaction.",
14760 "tags" : [ "reactions" ],
14761 "x-path-item-properties" : {
14762 "required-access-tier" : "INTERNAL"
14763 }
14764 }
14765 },
14766 "/reactions/{id}" : {
14767 "delete" : {
14768 "description" : "Deletes existing reaction.",
14769 "parameters" : [ {
14770 "description" : "Reaction Id",
14771 "example" : "nejMcAhh5N8S3EQ4LaqysVdI0cZZ",
14772 "in" : "path",
14773 "name" : "id",
14774 "required" : true,
14775 "schema" : {
14776 "type" : "string"
14777 }
14778 }, {
14779 "$ref" : "#/components/parameters/IdempotencyKey"
14780 } ],
14781 "responses" : {
14782 "400" : {
14783 "$ref" : "#/components/responses/Default400Response"
14784 },
14785 "404" : {
14786 "$ref" : "#/components/responses/Default404Response"
14787 },
14788 "405" : {
14789 "$ref" : "#/components/responses/Default405Response"
14790 },
14791 "406" : {
14792 "$ref" : "#/components/responses/Default406Response"
14793 },
14794 "409" : {
14795 "$ref" : "#/components/responses/Idempotency409Response"
14796 },
14797 "415" : {
14798 "$ref" : "#/components/responses/Default415Response"
14799 },
14800 "422" : {
14801 "$ref" : "#/components/responses/Idempotency422Response"
14802 },
14803 "429" : {
14804 "$ref" : "#/components/responses/Default429Response"
14805 },
14806 "500" : {
14807 "$ref" : "#/components/responses/Default500Response"
14808 },
14809 "503" : {
14810 "$ref" : "#/components/responses/Default503Response"
14811 }
14812 },
14813 "security" : [ {
14814 "Authorization_Code_PKCE" : [ "w_usr" ]
14815 } ],
14816 "summary" : "Delete single reaction.",
14817 "tags" : [ "reactions" ],
14818 "x-path-item-properties" : {
14819 "required-access-tier" : "INTERNAL"
14820 }
14821 }
14822 },
14823 "/reactions/{id}/relationships/ownerProfiles" : {
14824 "get" : {
14825 "description" : "Retrieves ownerProfiles relationship.",
14826 "parameters" : [ {
14827 "description" : "Reaction Id",
14828 "example" : "nejMcAhh5N8S3EQ4LaqysVdI0cZZ",
14829 "in" : "path",
14830 "name" : "id",
14831 "required" : true,
14832 "schema" : {
14833 "type" : "string"
14834 }
14835 }, {
14836 "description" : "Allows the client to customize which related resources should be returned. Available options: ownerProfiles",
14837 "example" : "ownerProfiles",
14838 "in" : "query",
14839 "name" : "include",
14840 "required" : false,
14841 "schema" : {
14842 "type" : "array",
14843 "items" : {
14844 "type" : "string",
14845 "example" : "ownerProfiles"
14846 }
14847 }
14848 }, {
14849 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
14850 "in" : "query",
14851 "name" : "page[cursor]",
14852 "required" : false,
14853 "schema" : {
14854 "type" : "string"
14855 }
14856 } ],
14857 "responses" : {
14858 "200" : {
14859 "content" : {
14860 "application/vnd.api+json" : {
14861 "schema" : {
14862 "$ref" : "#/components/schemas/Reactions_Multi_Relationship_Data_Document"
14863 }
14864 }
14865 },
14866 "description" : "Successful response"
14867 },
14868 "400" : {
14869 "$ref" : "#/components/responses/Default400Response"
14870 },
14871 "404" : {
14872 "$ref" : "#/components/responses/Default404Response"
14873 },
14874 "405" : {
14875 "$ref" : "#/components/responses/Default405Response"
14876 },
14877 "406" : {
14878 "$ref" : "#/components/responses/Default406Response"
14879 },
14880 "415" : {
14881 "$ref" : "#/components/responses/Default415Response"
14882 },
14883 "429" : {
14884 "$ref" : "#/components/responses/Default429Response"
14885 },
14886 "500" : {
14887 "$ref" : "#/components/responses/Default500Response"
14888 },
14889 "503" : {
14890 "$ref" : "#/components/responses/Default503Response"
14891 }
14892 },
14893 "security" : [ {
14894 "Authorization_Code_PKCE" : [ ]
14895 } ],
14896 "summary" : "Get ownerProfiles relationship (\"to-many\").",
14897 "tags" : [ "reactions" ],
14898 "x-path-item-properties" : {
14899 "required-access-tier" : "INTERNAL"
14900 }
14901 }
14902 },
14903 "/reactions/{id}/relationships/owners" : {
14904 "get" : {
14905 "description" : "Retrieves owners relationship.",
14906 "parameters" : [ {
14907 "description" : "Reaction Id",
14908 "example" : "nejMcAhh5N8S3EQ4LaqysVdI0cZZ",
14909 "in" : "path",
14910 "name" : "id",
14911 "required" : true,
14912 "schema" : {
14913 "type" : "string"
14914 }
14915 }, {
14916 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
14917 "example" : "owners",
14918 "in" : "query",
14919 "name" : "include",
14920 "required" : false,
14921 "schema" : {
14922 "type" : "array",
14923 "items" : {
14924 "type" : "string",
14925 "example" : "owners"
14926 }
14927 }
14928 }, {
14929 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
14930 "in" : "query",
14931 "name" : "page[cursor]",
14932 "required" : false,
14933 "schema" : {
14934 "type" : "string"
14935 }
14936 } ],
14937 "responses" : {
14938 "200" : {
14939 "content" : {
14940 "application/vnd.api+json" : {
14941 "schema" : {
14942 "$ref" : "#/components/schemas/Reactions_Multi_Relationship_Data_Document"
14943 }
14944 }
14945 },
14946 "description" : "Successful response"
14947 },
14948 "400" : {
14949 "$ref" : "#/components/responses/Default400Response"
14950 },
14951 "404" : {
14952 "$ref" : "#/components/responses/Default404Response"
14953 },
14954 "405" : {
14955 "$ref" : "#/components/responses/Default405Response"
14956 },
14957 "406" : {
14958 "$ref" : "#/components/responses/Default406Response"
14959 },
14960 "415" : {
14961 "$ref" : "#/components/responses/Default415Response"
14962 },
14963 "429" : {
14964 "$ref" : "#/components/responses/Default429Response"
14965 },
14966 "500" : {
14967 "$ref" : "#/components/responses/Default500Response"
14968 },
14969 "503" : {
14970 "$ref" : "#/components/responses/Default503Response"
14971 }
14972 },
14973 "security" : [ {
14974 "Authorization_Code_PKCE" : [ ]
14975 } ],
14976 "summary" : "Get owners relationship (\"to-many\").",
14977 "tags" : [ "reactions" ],
14978 "x-path-item-properties" : {
14979 "required-access-tier" : "INTERNAL"
14980 }
14981 }
14982 },
14983 "/savedShares" : {
14984 "post" : {
14985 "description" : "Creates a new savedShare.",
14986 "parameters" : [ {
14987 "$ref" : "#/components/parameters/IdempotencyKey"
14988 } ],
14989 "requestBody" : {
14990 "content" : {
14991 "application/vnd.api+json" : {
14992 "schema" : {
14993 "$ref" : "#/components/schemas/SavedSharesCreateOperation_Payload"
14994 }
14995 }
14996 }
14997 },
14998 "responses" : {
14999 "201" : {
15000 "content" : {
15001 "application/vnd.api+json" : {
15002 "schema" : {
15003 "$ref" : "#/components/schemas/SavedShares_Create_Single_Resource_Data_Document"
15004 }
15005 }
15006 },
15007 "description" : "Successful response"
15008 },
15009 "400" : {
15010 "$ref" : "#/components/responses/Default400Response"
15011 },
15012 "404" : {
15013 "$ref" : "#/components/responses/Default404Response"
15014 },
15015 "405" : {
15016 "$ref" : "#/components/responses/Default405Response"
15017 },
15018 "406" : {
15019 "$ref" : "#/components/responses/Default406Response"
15020 },
15021 "409" : {
15022 "$ref" : "#/components/responses/Idempotency409Response"
15023 },
15024 "415" : {
15025 "$ref" : "#/components/responses/Default415Response"
15026 },
15027 "422" : {
15028 "$ref" : "#/components/responses/Idempotency422Response"
15029 },
15030 "429" : {
15031 "$ref" : "#/components/responses/Default429Response"
15032 },
15033 "500" : {
15034 "$ref" : "#/components/responses/Default500Response"
15035 },
15036 "503" : {
15037 "$ref" : "#/components/responses/Default503Response"
15038 }
15039 },
15040 "security" : [ {
15041 "Authorization_Code_PKCE" : [ "w_usr" ]
15042 } ],
15043 "summary" : "Create single savedShare.",
15044 "tags" : [ "savedShares" ],
15045 "x-path-item-properties" : {
15046 "required-access-tier" : "INTERNAL"
15047 }
15048 }
15049 },
15050 "/scopes" : {
15051 "get" : {
15052 "description" : "Retrieves multiple scopes by available filters, or without if applicable.",
15053 "parameters" : [ {
15054 "description" : "Filters scopes by their `requiredAccessTier`. (e.g. `THIRD_PARTY`)",
15055 "in" : "query",
15056 "name" : "filter[requiredAccessTier]",
15057 "required" : true,
15058 "schema" : {
15059 "type" : "array",
15060 "items" : {
15061 "type" : "string",
15062 "enum" : [ "THIRD_PARTY", "THIRD_PARTY_PROD", "PARTNER", "INTERNAL" ]
15063 }
15064 }
15065 } ],
15066 "responses" : {
15067 "200" : {
15068 "content" : {
15069 "application/vnd.api+json" : {
15070 "schema" : {
15071 "$ref" : "#/components/schemas/Scopes_Multi_Resource_Data_Document"
15072 }
15073 }
15074 },
15075 "description" : "Successful response"
15076 },
15077 "400" : {
15078 "$ref" : "#/components/responses/Default400Response"
15079 },
15080 "404" : {
15081 "$ref" : "#/components/responses/Default404Response"
15082 },
15083 "405" : {
15084 "$ref" : "#/components/responses/Default405Response"
15085 },
15086 "406" : {
15087 "$ref" : "#/components/responses/Default406Response"
15088 },
15089 "415" : {
15090 "$ref" : "#/components/responses/Default415Response"
15091 },
15092 "429" : {
15093 "$ref" : "#/components/responses/Default429Response"
15094 },
15095 "500" : {
15096 "$ref" : "#/components/responses/Default500Response"
15097 },
15098 "503" : {
15099 "$ref" : "#/components/responses/Default503Response"
15100 }
15101 },
15102 "security" : [ {
15103 "Authorization_Code_PKCE" : [ ]
15104 } ],
15105 "summary" : "Get multiple scopes.",
15106 "tags" : [ "scopes" ],
15107 "x-path-item-properties" : {
15108 "required-access-tier" : "INTERNAL"
15109 }
15110 }
15111 },
15112 "/searchHistoryEntries/{id}" : {
15113 "delete" : {
15114 "description" : "Deletes existing searchHistoryEntrie.",
15115 "parameters" : [ {
15116 "description" : "Canonical opaque identifier for a user's exact saved history query.",
15117 "example" : "24HkRueBIeyGHPttoaQetVx4SwUxlzp3da06bqbwjF1t4dNXV",
15118 "in" : "path",
15119 "name" : "id",
15120 "required" : true,
15121 "schema" : {
15122 "type" : "string"
15123 }
15124 }, {
15125 "$ref" : "#/components/parameters/IdempotencyKey"
15126 } ],
15127 "responses" : {
15128 "400" : {
15129 "$ref" : "#/components/responses/Default400Response"
15130 },
15131 "404" : {
15132 "$ref" : "#/components/responses/Default404Response"
15133 },
15134 "405" : {
15135 "$ref" : "#/components/responses/Default405Response"
15136 },
15137 "406" : {
15138 "$ref" : "#/components/responses/Default406Response"
15139 },
15140 "409" : {
15141 "$ref" : "#/components/responses/Idempotency409Response"
15142 },
15143 "415" : {
15144 "$ref" : "#/components/responses/Default415Response"
15145 },
15146 "422" : {
15147 "$ref" : "#/components/responses/Idempotency422Response"
15148 },
15149 "429" : {
15150 "$ref" : "#/components/responses/Default429Response"
15151 },
15152 "500" : {
15153 "$ref" : "#/components/responses/Default500Response"
15154 },
15155 "503" : {
15156 "$ref" : "#/components/responses/Default503Response"
15157 }
15158 },
15159 "security" : [ {
15160 "Authorization_Code_PKCE" : [ "search.write", "w_usr" ]
15161 } ],
15162 "summary" : "Delete single searchHistoryEntrie.",
15163 "tags" : [ "searchHistoryEntries" ],
15164 "x-path-item-properties" : {
15165 "required-access-tier" : "INTERNAL"
15166 }
15167 }
15168 },
15169 "/searchResults" : {
15170 "get" : {
15171 "description" : "Searches for a query and returns a collection containing exactly one search results resource.",
15172 "parameters" : [ {
15173 "description" : "Search query (e.g. `hello`)",
15174 "in" : "query",
15175 "name" : "filter[query]",
15176 "required" : true,
15177 "schema" : {
15178 "maxLength" : 256,
15179 "type" : "string"
15180 }
15181 }, {
15182 "description" : "Explicit filter. Valid values: INCLUDE or EXCLUDE",
15183 "example" : "INCLUDE",
15184 "in" : "query",
15185 "name" : "explicitFilter",
15186 "required" : false,
15187 "schema" : {
15188 "type" : "string",
15189 "default" : "INCLUDE",
15190 "enum" : [ "INCLUDE", "EXCLUDE" ]
15191 }
15192 }, {
15193 "description" : "ISO 3166-1 alpha-2 country code",
15194 "example" : "US",
15195 "in" : "query",
15196 "name" : "countryCode",
15197 "required" : false,
15198 "schema" : {
15199 "type" : "string"
15200 }
15201 }, {
15202 "description" : "The type of device making the request",
15203 "example" : "PHONE",
15204 "in" : "query",
15205 "name" : "deviceType",
15206 "required" : false,
15207 "schema" : {
15208 "type" : "string",
15209 "enum" : [ "BROWSER", "CAR", "DESKTOP", "PHONE", "TABLET", "TV" ]
15210 }
15211 }, {
15212 "description" : "The system type of the device making the request",
15213 "example" : "IOS",
15214 "in" : "query",
15215 "name" : "systemType",
15216 "required" : false,
15217 "schema" : {
15218 "type" : "string",
15219 "enum" : [ "ANDROID", "DESKTOP", "TESLA", "IOS", "WEB" ]
15220 }
15221 }, {
15222 "description" : "Client version number",
15223 "example" : "2026.0.1",
15224 "in" : "query",
15225 "name" : "clientVersion",
15226 "required" : false,
15227 "schema" : {
15228 "type" : "string"
15229 }
15230 }, {
15231 "description" : "Allows the client to customize which related resources should be returned. Available options: albums, artists, playlists, topHits, tracks, videos",
15232 "example" : "albums",
15233 "in" : "query",
15234 "name" : "include",
15235 "required" : false,
15236 "schema" : {
15237 "type" : "array",
15238 "items" : {
15239 "type" : "string",
15240 "example" : "albums"
15241 }
15242 }
15243 }, {
15244 "description" : "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",
15245 "example" : "albums",
15246 "in" : "query",
15247 "name" : "replaceMedia",
15248 "required" : false,
15249 "schema" : {
15250 "type" : "string",
15251 "example" : "albums"
15252 }
15253 } ],
15254 "responses" : {
15255 "200" : {
15256 "content" : {
15257 "application/vnd.api+json" : {
15258 "schema" : {
15259 "$ref" : "#/components/schemas/SearchResults_Multi_Resource_Data_Document"
15260 }
15261 }
15262 },
15263 "description" : "Successful response"
15264 },
15265 "400" : {
15266 "$ref" : "#/components/responses/Default400Response"
15267 },
15268 "404" : {
15269 "$ref" : "#/components/responses/Default404Response"
15270 },
15271 "405" : {
15272 "$ref" : "#/components/responses/Default405Response"
15273 },
15274 "406" : {
15275 "$ref" : "#/components/responses/Default406Response"
15276 },
15277 "415" : {
15278 "$ref" : "#/components/responses/Default415Response"
15279 },
15280 "429" : {
15281 "$ref" : "#/components/responses/Default429Response"
15282 },
15283 "500" : {
15284 "$ref" : "#/components/responses/Default500Response"
15285 },
15286 "503" : {
15287 "$ref" : "#/components/responses/Default503Response"
15288 }
15289 },
15290 "security" : [ {
15291 "Client_Credentials" : [ ]
15292 }, {
15293 "Authorization_Code_PKCE" : [ "r_usr", "search.read" ]
15294 } ],
15295 "summary" : "Get search results by query.",
15296 "tags" : [ "searchResults" ],
15297 "x-path-item-properties" : {
15298 "required-access-tier" : "THIRD_PARTY"
15299 }
15300 }
15301 },
15302 "/searchResults/{id}/relationships/albums" : {
15303 "get" : {
15304 "description" : "Retrieves albums relationship.",
15305 "parameters" : [ {
15306 "description" : "An opaque search results identifier",
15307 "in" : "path",
15308 "name" : "id",
15309 "required" : true,
15310 "schema" : {
15311 "type" : "string"
15312 }
15313 }, {
15314 "description" : "Explicit filter. Valid values: INCLUDE or EXCLUDE",
15315 "example" : "INCLUDE",
15316 "in" : "query",
15317 "name" : "explicitFilter",
15318 "required" : false,
15319 "schema" : {
15320 "type" : "string",
15321 "default" : "INCLUDE",
15322 "enum" : [ "INCLUDE", "EXCLUDE" ]
15323 }
15324 }, {
15325 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
15326 "in" : "query",
15327 "name" : "page[cursor]",
15328 "required" : false,
15329 "schema" : {
15330 "type" : "string"
15331 }
15332 }, {
15333 "description" : "ISO 3166-1 alpha-2 country code",
15334 "example" : "US",
15335 "in" : "query",
15336 "name" : "countryCode",
15337 "required" : false,
15338 "schema" : {
15339 "type" : "string"
15340 }
15341 }, {
15342 "description" : "The type of device making the request",
15343 "example" : "PHONE",
15344 "in" : "query",
15345 "name" : "deviceType",
15346 "required" : false,
15347 "schema" : {
15348 "type" : "string",
15349 "enum" : [ "BROWSER", "CAR", "DESKTOP", "PHONE", "TABLET", "TV" ]
15350 }
15351 }, {
15352 "description" : "The system type of the device making the request",
15353 "example" : "IOS",
15354 "in" : "query",
15355 "name" : "systemType",
15356 "required" : false,
15357 "schema" : {
15358 "type" : "string",
15359 "enum" : [ "ANDROID", "DESKTOP", "TESLA", "IOS", "WEB" ]
15360 }
15361 }, {
15362 "description" : "Client version number",
15363 "example" : "2026.0.1",
15364 "in" : "query",
15365 "name" : "clientVersion",
15366 "required" : false,
15367 "schema" : {
15368 "type" : "string"
15369 }
15370 }, {
15371 "description" : "Allows the client to customize which related resources should be returned. Available options: albums",
15372 "example" : "albums",
15373 "in" : "query",
15374 "name" : "include",
15375 "required" : false,
15376 "schema" : {
15377 "type" : "array",
15378 "items" : {
15379 "type" : "string",
15380 "example" : "albums"
15381 }
15382 }
15383 }, {
15384 "description" : "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",
15385 "example" : "albums",
15386 "in" : "query",
15387 "name" : "replaceMedia",
15388 "required" : false,
15389 "schema" : {
15390 "type" : "string",
15391 "example" : "albums"
15392 }
15393 } ],
15394 "responses" : {
15395 "200" : {
15396 "content" : {
15397 "application/vnd.api+json" : {
15398 "schema" : {
15399 "$ref" : "#/components/schemas/SearchResults_Multi_Relationship_Data_Document"
15400 }
15401 }
15402 },
15403 "description" : "Successful response"
15404 },
15405 "400" : {
15406 "$ref" : "#/components/responses/Default400Response"
15407 },
15408 "404" : {
15409 "$ref" : "#/components/responses/Default404Response"
15410 },
15411 "405" : {
15412 "$ref" : "#/components/responses/Default405Response"
15413 },
15414 "406" : {
15415 "$ref" : "#/components/responses/Default406Response"
15416 },
15417 "415" : {
15418 "$ref" : "#/components/responses/Default415Response"
15419 },
15420 "429" : {
15421 "$ref" : "#/components/responses/Default429Response"
15422 },
15423 "500" : {
15424 "$ref" : "#/components/responses/Default500Response"
15425 },
15426 "503" : {
15427 "$ref" : "#/components/responses/Default503Response"
15428 }
15429 },
15430 "security" : [ {
15431 "Client_Credentials" : [ ]
15432 }, {
15433 "Authorization_Code_PKCE" : [ "r_usr", "search.read" ]
15434 } ],
15435 "summary" : "Get albums relationship (\"to-many\").",
15436 "tags" : [ "searchResults" ],
15437 "x-path-item-properties" : {
15438 "required-access-tier" : "THIRD_PARTY"
15439 }
15440 }
15441 },
15442 "/searchResults/{id}/relationships/artists" : {
15443 "get" : {
15444 "description" : "Retrieves artists relationship.",
15445 "parameters" : [ {
15446 "description" : "An opaque search results identifier",
15447 "in" : "path",
15448 "name" : "id",
15449 "required" : true,
15450 "schema" : {
15451 "type" : "string"
15452 }
15453 }, {
15454 "description" : "Explicit filter. Valid values: INCLUDE or EXCLUDE",
15455 "example" : "INCLUDE",
15456 "in" : "query",
15457 "name" : "explicitFilter",
15458 "required" : false,
15459 "schema" : {
15460 "type" : "string",
15461 "default" : "INCLUDE",
15462 "enum" : [ "INCLUDE", "EXCLUDE" ]
15463 }
15464 }, {
15465 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
15466 "in" : "query",
15467 "name" : "page[cursor]",
15468 "required" : false,
15469 "schema" : {
15470 "type" : "string"
15471 }
15472 }, {
15473 "description" : "ISO 3166-1 alpha-2 country code",
15474 "example" : "US",
15475 "in" : "query",
15476 "name" : "countryCode",
15477 "required" : false,
15478 "schema" : {
15479 "type" : "string"
15480 }
15481 }, {
15482 "description" : "The type of device making the request",
15483 "example" : "PHONE",
15484 "in" : "query",
15485 "name" : "deviceType",
15486 "required" : false,
15487 "schema" : {
15488 "type" : "string",
15489 "enum" : [ "BROWSER", "CAR", "DESKTOP", "PHONE", "TABLET", "TV" ]
15490 }
15491 }, {
15492 "description" : "The system type of the device making the request",
15493 "example" : "IOS",
15494 "in" : "query",
15495 "name" : "systemType",
15496 "required" : false,
15497 "schema" : {
15498 "type" : "string",
15499 "enum" : [ "ANDROID", "DESKTOP", "TESLA", "IOS", "WEB" ]
15500 }
15501 }, {
15502 "description" : "Client version number",
15503 "example" : "2026.0.1",
15504 "in" : "query",
15505 "name" : "clientVersion",
15506 "required" : false,
15507 "schema" : {
15508 "type" : "string"
15509 }
15510 }, {
15511 "description" : "Allows the client to customize which related resources should be returned. Available options: artists",
15512 "example" : "artists",
15513 "in" : "query",
15514 "name" : "include",
15515 "required" : false,
15516 "schema" : {
15517 "type" : "array",
15518 "items" : {
15519 "type" : "string",
15520 "example" : "artists"
15521 }
15522 }
15523 }, {
15524 "description" : "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",
15525 "example" : "artists",
15526 "in" : "query",
15527 "name" : "replaceMedia",
15528 "required" : false,
15529 "schema" : {
15530 "type" : "string",
15531 "example" : "artists"
15532 }
15533 } ],
15534 "responses" : {
15535 "200" : {
15536 "content" : {
15537 "application/vnd.api+json" : {
15538 "schema" : {
15539 "$ref" : "#/components/schemas/SearchResults_Multi_Relationship_Data_Document"
15540 }
15541 }
15542 },
15543 "description" : "Successful response"
15544 },
15545 "400" : {
15546 "$ref" : "#/components/responses/Default400Response"
15547 },
15548 "404" : {
15549 "$ref" : "#/components/responses/Default404Response"
15550 },
15551 "405" : {
15552 "$ref" : "#/components/responses/Default405Response"
15553 },
15554 "406" : {
15555 "$ref" : "#/components/responses/Default406Response"
15556 },
15557 "415" : {
15558 "$ref" : "#/components/responses/Default415Response"
15559 },
15560 "429" : {
15561 "$ref" : "#/components/responses/Default429Response"
15562 },
15563 "500" : {
15564 "$ref" : "#/components/responses/Default500Response"
15565 },
15566 "503" : {
15567 "$ref" : "#/components/responses/Default503Response"
15568 }
15569 },
15570 "security" : [ {
15571 "Client_Credentials" : [ ]
15572 }, {
15573 "Authorization_Code_PKCE" : [ "r_usr", "search.read" ]
15574 } ],
15575 "summary" : "Get artists relationship (\"to-many\").",
15576 "tags" : [ "searchResults" ],
15577 "x-path-item-properties" : {
15578 "required-access-tier" : "THIRD_PARTY"
15579 }
15580 }
15581 },
15582 "/searchResults/{id}/relationships/playlists" : {
15583 "get" : {
15584 "description" : "Retrieves playlists relationship.",
15585 "parameters" : [ {
15586 "description" : "An opaque search results identifier",
15587 "in" : "path",
15588 "name" : "id",
15589 "required" : true,
15590 "schema" : {
15591 "type" : "string"
15592 }
15593 }, {
15594 "description" : "Explicit filter. Valid values: INCLUDE or EXCLUDE",
15595 "example" : "INCLUDE",
15596 "in" : "query",
15597 "name" : "explicitFilter",
15598 "required" : false,
15599 "schema" : {
15600 "type" : "string",
15601 "default" : "INCLUDE",
15602 "enum" : [ "INCLUDE", "EXCLUDE" ]
15603 }
15604 }, {
15605 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
15606 "in" : "query",
15607 "name" : "page[cursor]",
15608 "required" : false,
15609 "schema" : {
15610 "type" : "string"
15611 }
15612 }, {
15613 "description" : "ISO 3166-1 alpha-2 country code",
15614 "example" : "US",
15615 "in" : "query",
15616 "name" : "countryCode",
15617 "required" : false,
15618 "schema" : {
15619 "type" : "string"
15620 }
15621 }, {
15622 "description" : "The type of device making the request",
15623 "example" : "PHONE",
15624 "in" : "query",
15625 "name" : "deviceType",
15626 "required" : false,
15627 "schema" : {
15628 "type" : "string",
15629 "enum" : [ "BROWSER", "CAR", "DESKTOP", "PHONE", "TABLET", "TV" ]
15630 }
15631 }, {
15632 "description" : "The system type of the device making the request",
15633 "example" : "IOS",
15634 "in" : "query",
15635 "name" : "systemType",
15636 "required" : false,
15637 "schema" : {
15638 "type" : "string",
15639 "enum" : [ "ANDROID", "DESKTOP", "TESLA", "IOS", "WEB" ]
15640 }
15641 }, {
15642 "description" : "Client version number",
15643 "example" : "2026.0.1",
15644 "in" : "query",
15645 "name" : "clientVersion",
15646 "required" : false,
15647 "schema" : {
15648 "type" : "string"
15649 }
15650 }, {
15651 "description" : "Allows the client to customize which related resources should be returned. Available options: playlists",
15652 "example" : "playlists",
15653 "in" : "query",
15654 "name" : "include",
15655 "required" : false,
15656 "schema" : {
15657 "type" : "array",
15658 "items" : {
15659 "type" : "string",
15660 "example" : "playlists"
15661 }
15662 }
15663 }, {
15664 "description" : "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",
15665 "example" : "playlists",
15666 "in" : "query",
15667 "name" : "replaceMedia",
15668 "required" : false,
15669 "schema" : {
15670 "type" : "string",
15671 "example" : "playlists"
15672 }
15673 } ],
15674 "responses" : {
15675 "200" : {
15676 "content" : {
15677 "application/vnd.api+json" : {
15678 "schema" : {
15679 "$ref" : "#/components/schemas/SearchResults_Multi_Relationship_Data_Document"
15680 }
15681 }
15682 },
15683 "description" : "Successful response"
15684 },
15685 "400" : {
15686 "$ref" : "#/components/responses/Default400Response"
15687 },
15688 "404" : {
15689 "$ref" : "#/components/responses/Default404Response"
15690 },
15691 "405" : {
15692 "$ref" : "#/components/responses/Default405Response"
15693 },
15694 "406" : {
15695 "$ref" : "#/components/responses/Default406Response"
15696 },
15697 "415" : {
15698 "$ref" : "#/components/responses/Default415Response"
15699 },
15700 "429" : {
15701 "$ref" : "#/components/responses/Default429Response"
15702 },
15703 "500" : {
15704 "$ref" : "#/components/responses/Default500Response"
15705 },
15706 "503" : {
15707 "$ref" : "#/components/responses/Default503Response"
15708 }
15709 },
15710 "security" : [ {
15711 "Client_Credentials" : [ ]
15712 }, {
15713 "Authorization_Code_PKCE" : [ "r_usr", "search.read" ]
15714 } ],
15715 "summary" : "Get playlists relationship (\"to-many\").",
15716 "tags" : [ "searchResults" ],
15717 "x-path-item-properties" : {
15718 "required-access-tier" : "THIRD_PARTY"
15719 }
15720 }
15721 },
15722 "/searchResults/{id}/relationships/topHits" : {
15723 "get" : {
15724 "description" : "Retrieves topHits relationship.",
15725 "parameters" : [ {
15726 "description" : "An opaque search results identifier",
15727 "in" : "path",
15728 "name" : "id",
15729 "required" : true,
15730 "schema" : {
15731 "type" : "string"
15732 }
15733 }, {
15734 "description" : "Explicit filter. Valid values: INCLUDE or EXCLUDE",
15735 "example" : "INCLUDE",
15736 "in" : "query",
15737 "name" : "explicitFilter",
15738 "required" : false,
15739 "schema" : {
15740 "type" : "string",
15741 "default" : "INCLUDE",
15742 "enum" : [ "INCLUDE", "EXCLUDE" ]
15743 }
15744 }, {
15745 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
15746 "in" : "query",
15747 "name" : "page[cursor]",
15748 "required" : false,
15749 "schema" : {
15750 "type" : "string"
15751 }
15752 }, {
15753 "description" : "ISO 3166-1 alpha-2 country code",
15754 "example" : "US",
15755 "in" : "query",
15756 "name" : "countryCode",
15757 "required" : false,
15758 "schema" : {
15759 "type" : "string"
15760 }
15761 }, {
15762 "description" : "The type of device making the request",
15763 "example" : "PHONE",
15764 "in" : "query",
15765 "name" : "deviceType",
15766 "required" : false,
15767 "schema" : {
15768 "type" : "string",
15769 "enum" : [ "BROWSER", "CAR", "DESKTOP", "PHONE", "TABLET", "TV" ]
15770 }
15771 }, {
15772 "description" : "The system type of the device making the request",
15773 "example" : "IOS",
15774 "in" : "query",
15775 "name" : "systemType",
15776 "required" : false,
15777 "schema" : {
15778 "type" : "string",
15779 "enum" : [ "ANDROID", "DESKTOP", "TESLA", "IOS", "WEB" ]
15780 }
15781 }, {
15782 "description" : "Client version number",
15783 "example" : "2026.0.1",
15784 "in" : "query",
15785 "name" : "clientVersion",
15786 "required" : false,
15787 "schema" : {
15788 "type" : "string"
15789 }
15790 }, {
15791 "description" : "Allows the client to customize which related resources should be returned. Available options: topHits",
15792 "example" : "topHits",
15793 "in" : "query",
15794 "name" : "include",
15795 "required" : false,
15796 "schema" : {
15797 "type" : "array",
15798 "items" : {
15799 "type" : "string",
15800 "example" : "topHits"
15801 }
15802 }
15803 }, {
15804 "description" : "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",
15805 "example" : "topHits",
15806 "in" : "query",
15807 "name" : "replaceMedia",
15808 "required" : false,
15809 "schema" : {
15810 "type" : "string",
15811 "example" : "topHits"
15812 }
15813 } ],
15814 "responses" : {
15815 "200" : {
15816 "content" : {
15817 "application/vnd.api+json" : {
15818 "schema" : {
15819 "$ref" : "#/components/schemas/SearchResults_Multi_Relationship_Data_Document"
15820 }
15821 }
15822 },
15823 "description" : "Successful response"
15824 },
15825 "400" : {
15826 "$ref" : "#/components/responses/Default400Response"
15827 },
15828 "404" : {
15829 "$ref" : "#/components/responses/Default404Response"
15830 },
15831 "405" : {
15832 "$ref" : "#/components/responses/Default405Response"
15833 },
15834 "406" : {
15835 "$ref" : "#/components/responses/Default406Response"
15836 },
15837 "415" : {
15838 "$ref" : "#/components/responses/Default415Response"
15839 },
15840 "429" : {
15841 "$ref" : "#/components/responses/Default429Response"
15842 },
15843 "500" : {
15844 "$ref" : "#/components/responses/Default500Response"
15845 },
15846 "503" : {
15847 "$ref" : "#/components/responses/Default503Response"
15848 }
15849 },
15850 "security" : [ {
15851 "Client_Credentials" : [ ]
15852 }, {
15853 "Authorization_Code_PKCE" : [ "r_usr", "search.read" ]
15854 } ],
15855 "summary" : "Get topHits relationship (\"to-many\").",
15856 "tags" : [ "searchResults" ],
15857 "x-path-item-properties" : {
15858 "required-access-tier" : "THIRD_PARTY"
15859 }
15860 }
15861 },
15862 "/searchResults/{id}/relationships/tracks" : {
15863 "get" : {
15864 "description" : "Retrieves tracks relationship.",
15865 "parameters" : [ {
15866 "description" : "An opaque search results identifier",
15867 "in" : "path",
15868 "name" : "id",
15869 "required" : true,
15870 "schema" : {
15871 "type" : "string"
15872 }
15873 }, {
15874 "description" : "Explicit filter. Valid values: INCLUDE or EXCLUDE",
15875 "example" : "INCLUDE",
15876 "in" : "query",
15877 "name" : "explicitFilter",
15878 "required" : false,
15879 "schema" : {
15880 "type" : "string",
15881 "default" : "INCLUDE",
15882 "enum" : [ "INCLUDE", "EXCLUDE" ]
15883 }
15884 }, {
15885 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
15886 "in" : "query",
15887 "name" : "page[cursor]",
15888 "required" : false,
15889 "schema" : {
15890 "type" : "string"
15891 }
15892 }, {
15893 "description" : "ISO 3166-1 alpha-2 country code",
15894 "example" : "US",
15895 "in" : "query",
15896 "name" : "countryCode",
15897 "required" : false,
15898 "schema" : {
15899 "type" : "string"
15900 }
15901 }, {
15902 "description" : "The type of device making the request",
15903 "example" : "PHONE",
15904 "in" : "query",
15905 "name" : "deviceType",
15906 "required" : false,
15907 "schema" : {
15908 "type" : "string",
15909 "enum" : [ "BROWSER", "CAR", "DESKTOP", "PHONE", "TABLET", "TV" ]
15910 }
15911 }, {
15912 "description" : "The system type of the device making the request",
15913 "example" : "IOS",
15914 "in" : "query",
15915 "name" : "systemType",
15916 "required" : false,
15917 "schema" : {
15918 "type" : "string",
15919 "enum" : [ "ANDROID", "DESKTOP", "TESLA", "IOS", "WEB" ]
15920 }
15921 }, {
15922 "description" : "Client version number",
15923 "example" : "2026.0.1",
15924 "in" : "query",
15925 "name" : "clientVersion",
15926 "required" : false,
15927 "schema" : {
15928 "type" : "string"
15929 }
15930 }, {
15931 "description" : "Allows the client to customize which related resources should be returned. Available options: tracks",
15932 "example" : "tracks",
15933 "in" : "query",
15934 "name" : "include",
15935 "required" : false,
15936 "schema" : {
15937 "type" : "array",
15938 "items" : {
15939 "type" : "string",
15940 "example" : "tracks"
15941 }
15942 }
15943 }, {
15944 "description" : "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",
15945 "example" : "tracks",
15946 "in" : "query",
15947 "name" : "replaceMedia",
15948 "required" : false,
15949 "schema" : {
15950 "type" : "string",
15951 "example" : "tracks"
15952 }
15953 } ],
15954 "responses" : {
15955 "200" : {
15956 "content" : {
15957 "application/vnd.api+json" : {
15958 "schema" : {
15959 "$ref" : "#/components/schemas/SearchResults_Multi_Relationship_Data_Document"
15960 }
15961 }
15962 },
15963 "description" : "Successful response"
15964 },
15965 "400" : {
15966 "$ref" : "#/components/responses/Default400Response"
15967 },
15968 "404" : {
15969 "$ref" : "#/components/responses/Default404Response"
15970 },
15971 "405" : {
15972 "$ref" : "#/components/responses/Default405Response"
15973 },
15974 "406" : {
15975 "$ref" : "#/components/responses/Default406Response"
15976 },
15977 "415" : {
15978 "$ref" : "#/components/responses/Default415Response"
15979 },
15980 "429" : {
15981 "$ref" : "#/components/responses/Default429Response"
15982 },
15983 "500" : {
15984 "$ref" : "#/components/responses/Default500Response"
15985 },
15986 "503" : {
15987 "$ref" : "#/components/responses/Default503Response"
15988 }
15989 },
15990 "security" : [ {
15991 "Client_Credentials" : [ ]
15992 }, {
15993 "Authorization_Code_PKCE" : [ "r_usr", "search.read" ]
15994 } ],
15995 "summary" : "Get tracks relationship (\"to-many\").",
15996 "tags" : [ "searchResults" ],
15997 "x-path-item-properties" : {
15998 "required-access-tier" : "THIRD_PARTY"
15999 }
16000 }
16001 },
16002 "/searchResults/{id}/relationships/videos" : {
16003 "get" : {
16004 "description" : "Retrieves videos relationship.",
16005 "parameters" : [ {
16006 "description" : "An opaque search results identifier",
16007 "in" : "path",
16008 "name" : "id",
16009 "required" : true,
16010 "schema" : {
16011 "type" : "string"
16012 }
16013 }, {
16014 "description" : "Explicit filter. Valid values: INCLUDE or EXCLUDE",
16015 "example" : "INCLUDE",
16016 "in" : "query",
16017 "name" : "explicitFilter",
16018 "required" : false,
16019 "schema" : {
16020 "type" : "string",
16021 "default" : "INCLUDE",
16022 "enum" : [ "INCLUDE", "EXCLUDE" ]
16023 }
16024 }, {
16025 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
16026 "in" : "query",
16027 "name" : "page[cursor]",
16028 "required" : false,
16029 "schema" : {
16030 "type" : "string"
16031 }
16032 }, {
16033 "description" : "ISO 3166-1 alpha-2 country code",
16034 "example" : "US",
16035 "in" : "query",
16036 "name" : "countryCode",
16037 "required" : false,
16038 "schema" : {
16039 "type" : "string"
16040 }
16041 }, {
16042 "description" : "The type of device making the request",
16043 "example" : "PHONE",
16044 "in" : "query",
16045 "name" : "deviceType",
16046 "required" : false,
16047 "schema" : {
16048 "type" : "string",
16049 "enum" : [ "BROWSER", "CAR", "DESKTOP", "PHONE", "TABLET", "TV" ]
16050 }
16051 }, {
16052 "description" : "The system type of the device making the request",
16053 "example" : "IOS",
16054 "in" : "query",
16055 "name" : "systemType",
16056 "required" : false,
16057 "schema" : {
16058 "type" : "string",
16059 "enum" : [ "ANDROID", "DESKTOP", "TESLA", "IOS", "WEB" ]
16060 }
16061 }, {
16062 "description" : "Client version number",
16063 "example" : "2026.0.1",
16064 "in" : "query",
16065 "name" : "clientVersion",
16066 "required" : false,
16067 "schema" : {
16068 "type" : "string"
16069 }
16070 }, {
16071 "description" : "Allows the client to customize which related resources should be returned. Available options: videos",
16072 "example" : "videos",
16073 "in" : "query",
16074 "name" : "include",
16075 "required" : false,
16076 "schema" : {
16077 "type" : "array",
16078 "items" : {
16079 "type" : "string",
16080 "example" : "videos"
16081 }
16082 }
16083 }, {
16084 "description" : "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",
16085 "example" : "videos",
16086 "in" : "query",
16087 "name" : "replaceMedia",
16088 "required" : false,
16089 "schema" : {
16090 "type" : "string",
16091 "example" : "videos"
16092 }
16093 } ],
16094 "responses" : {
16095 "200" : {
16096 "content" : {
16097 "application/vnd.api+json" : {
16098 "schema" : {
16099 "$ref" : "#/components/schemas/SearchResults_Multi_Relationship_Data_Document"
16100 }
16101 }
16102 },
16103 "description" : "Successful response"
16104 },
16105 "400" : {
16106 "$ref" : "#/components/responses/Default400Response"
16107 },
16108 "404" : {
16109 "$ref" : "#/components/responses/Default404Response"
16110 },
16111 "405" : {
16112 "$ref" : "#/components/responses/Default405Response"
16113 },
16114 "406" : {
16115 "$ref" : "#/components/responses/Default406Response"
16116 },
16117 "415" : {
16118 "$ref" : "#/components/responses/Default415Response"
16119 },
16120 "429" : {
16121 "$ref" : "#/components/responses/Default429Response"
16122 },
16123 "500" : {
16124 "$ref" : "#/components/responses/Default500Response"
16125 },
16126 "503" : {
16127 "$ref" : "#/components/responses/Default503Response"
16128 }
16129 },
16130 "security" : [ {
16131 "Client_Credentials" : [ ]
16132 }, {
16133 "Authorization_Code_PKCE" : [ "r_usr", "search.read" ]
16134 } ],
16135 "summary" : "Get videos relationship (\"to-many\").",
16136 "tags" : [ "searchResults" ],
16137 "x-path-item-properties" : {
16138 "required-access-tier" : "THIRD_PARTY"
16139 }
16140 }
16141 },
16142 "/searchSuggestions" : {
16143 "get" : {
16144 "description" : "Searches for a query and returns a collection containing exactly one search suggestions resource.",
16145 "parameters" : [ {
16146 "description" : "Search query (e.g. `hello`)",
16147 "in" : "query",
16148 "name" : "filter[query]",
16149 "required" : true,
16150 "schema" : {
16151 "maxLength" : 256,
16152 "type" : "string"
16153 }
16154 }, {
16155 "description" : "Explicit filter. Valid values: INCLUDE or EXCLUDE",
16156 "example" : "INCLUDE",
16157 "in" : "query",
16158 "name" : "explicitFilter",
16159 "required" : false,
16160 "schema" : {
16161 "type" : "string",
16162 "default" : "INCLUDE",
16163 "enum" : [ "INCLUDE", "EXCLUDE" ]
16164 }
16165 }, {
16166 "description" : "ISO 3166-1 alpha-2 country code",
16167 "example" : "US",
16168 "in" : "query",
16169 "name" : "countryCode",
16170 "required" : false,
16171 "schema" : {
16172 "type" : "string"
16173 }
16174 }, {
16175 "description" : "Allows the client to customize which related resources should be returned. Available options: directHits, history",
16176 "example" : "directHits",
16177 "in" : "query",
16178 "name" : "include",
16179 "required" : false,
16180 "schema" : {
16181 "type" : "array",
16182 "items" : {
16183 "type" : "string",
16184 "example" : "directHits"
16185 }
16186 }
16187 }, {
16188 "description" : "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",
16189 "example" : "directHits",
16190 "in" : "query",
16191 "name" : "replaceMedia",
16192 "required" : false,
16193 "schema" : {
16194 "type" : "string",
16195 "example" : "directHits"
16196 }
16197 } ],
16198 "responses" : {
16199 "200" : {
16200 "content" : {
16201 "application/vnd.api+json" : {
16202 "schema" : {
16203 "$ref" : "#/components/schemas/SearchSuggestions_Multi_Resource_Data_Document"
16204 }
16205 }
16206 },
16207 "description" : "Successful response"
16208 },
16209 "400" : {
16210 "$ref" : "#/components/responses/Default400Response"
16211 },
16212 "404" : {
16213 "$ref" : "#/components/responses/Default404Response"
16214 },
16215 "405" : {
16216 "$ref" : "#/components/responses/Default405Response"
16217 },
16218 "406" : {
16219 "$ref" : "#/components/responses/Default406Response"
16220 },
16221 "415" : {
16222 "$ref" : "#/components/responses/Default415Response"
16223 },
16224 "429" : {
16225 "$ref" : "#/components/responses/Default429Response"
16226 },
16227 "500" : {
16228 "$ref" : "#/components/responses/Default500Response"
16229 },
16230 "503" : {
16231 "$ref" : "#/components/responses/Default503Response"
16232 }
16233 },
16234 "security" : [ {
16235 "Client_Credentials" : [ ]
16236 }, {
16237 "Authorization_Code_PKCE" : [ "r_usr", "search.read" ]
16238 } ],
16239 "summary" : "Get search suggestions by query.",
16240 "tags" : [ "searchSuggestions" ],
16241 "x-path-item-properties" : {
16242 "required-access-tier" : "THIRD_PARTY"
16243 }
16244 }
16245 },
16246 "/searchSuggestions/{id}/relationships/directHits" : {
16247 "get" : {
16248 "description" : "Retrieves directHits relationship.",
16249 "parameters" : [ {
16250 "description" : "An opaque search suggestions identifier",
16251 "in" : "path",
16252 "name" : "id",
16253 "required" : true,
16254 "schema" : {
16255 "type" : "string"
16256 }
16257 }, {
16258 "description" : "Explicit filter. Valid values: INCLUDE or EXCLUDE",
16259 "example" : "INCLUDE",
16260 "in" : "query",
16261 "name" : "explicitFilter",
16262 "required" : false,
16263 "schema" : {
16264 "type" : "string",
16265 "default" : "INCLUDE",
16266 "enum" : [ "INCLUDE", "EXCLUDE" ]
16267 }
16268 }, {
16269 "description" : "ISO 3166-1 alpha-2 country code",
16270 "example" : "US",
16271 "in" : "query",
16272 "name" : "countryCode",
16273 "required" : false,
16274 "schema" : {
16275 "type" : "string"
16276 }
16277 }, {
16278 "description" : "Allows the client to customize which related resources should be returned. Available options: directHits",
16279 "example" : "directHits",
16280 "in" : "query",
16281 "name" : "include",
16282 "required" : false,
16283 "schema" : {
16284 "type" : "array",
16285 "items" : {
16286 "type" : "string",
16287 "example" : "directHits"
16288 }
16289 }
16290 }, {
16291 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
16292 "in" : "query",
16293 "name" : "page[cursor]",
16294 "required" : false,
16295 "schema" : {
16296 "type" : "string"
16297 }
16298 }, {
16299 "description" : "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",
16300 "example" : "directHits",
16301 "in" : "query",
16302 "name" : "replaceMedia",
16303 "required" : false,
16304 "schema" : {
16305 "type" : "string",
16306 "example" : "directHits"
16307 }
16308 } ],
16309 "responses" : {
16310 "200" : {
16311 "content" : {
16312 "application/vnd.api+json" : {
16313 "schema" : {
16314 "$ref" : "#/components/schemas/SearchSuggestions_Multi_Relationship_Data_Document"
16315 }
16316 }
16317 },
16318 "description" : "Successful response"
16319 },
16320 "400" : {
16321 "$ref" : "#/components/responses/Default400Response"
16322 },
16323 "404" : {
16324 "$ref" : "#/components/responses/Default404Response"
16325 },
16326 "405" : {
16327 "$ref" : "#/components/responses/Default405Response"
16328 },
16329 "406" : {
16330 "$ref" : "#/components/responses/Default406Response"
16331 },
16332 "415" : {
16333 "$ref" : "#/components/responses/Default415Response"
16334 },
16335 "429" : {
16336 "$ref" : "#/components/responses/Default429Response"
16337 },
16338 "500" : {
16339 "$ref" : "#/components/responses/Default500Response"
16340 },
16341 "503" : {
16342 "$ref" : "#/components/responses/Default503Response"
16343 }
16344 },
16345 "security" : [ {
16346 "Client_Credentials" : [ ]
16347 }, {
16348 "Authorization_Code_PKCE" : [ "r_usr", "search.read" ]
16349 } ],
16350 "summary" : "Get directHits relationship (\"to-many\").",
16351 "tags" : [ "searchSuggestions" ],
16352 "x-path-item-properties" : {
16353 "required-access-tier" : "THIRD_PARTY"
16354 }
16355 }
16356 },
16357 "/searchSuggestions/{id}/relationships/history" : {
16358 "get" : {
16359 "description" : "Retrieves history relationship.",
16360 "parameters" : [ {
16361 "description" : "An opaque search suggestions identifier",
16362 "in" : "path",
16363 "name" : "id",
16364 "required" : true,
16365 "schema" : {
16366 "type" : "string"
16367 }
16368 }, {
16369 "description" : "Explicit filter. Valid values: INCLUDE or EXCLUDE",
16370 "example" : "INCLUDE",
16371 "in" : "query",
16372 "name" : "explicitFilter",
16373 "required" : false,
16374 "schema" : {
16375 "type" : "string",
16376 "default" : "INCLUDE",
16377 "enum" : [ "INCLUDE", "EXCLUDE" ]
16378 }
16379 }, {
16380 "description" : "ISO 3166-1 alpha-2 country code",
16381 "example" : "US",
16382 "in" : "query",
16383 "name" : "countryCode",
16384 "required" : false,
16385 "schema" : {
16386 "type" : "string"
16387 }
16388 }, {
16389 "description" : "Allows the client to customize which related resources should be returned. Available options: history",
16390 "example" : "history",
16391 "in" : "query",
16392 "name" : "include",
16393 "required" : false,
16394 "schema" : {
16395 "type" : "array",
16396 "items" : {
16397 "type" : "string",
16398 "example" : "history"
16399 }
16400 }
16401 }, {
16402 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
16403 "in" : "query",
16404 "name" : "page[cursor]",
16405 "required" : false,
16406 "schema" : {
16407 "type" : "string"
16408 }
16409 } ],
16410 "responses" : {
16411 "200" : {
16412 "content" : {
16413 "application/vnd.api+json" : {
16414 "schema" : {
16415 "$ref" : "#/components/schemas/SearchSuggestions_Multi_Relationship_Data_Document"
16416 }
16417 }
16418 },
16419 "description" : "Successful response"
16420 },
16421 "400" : {
16422 "$ref" : "#/components/responses/Default400Response"
16423 },
16424 "404" : {
16425 "$ref" : "#/components/responses/Default404Response"
16426 },
16427 "405" : {
16428 "$ref" : "#/components/responses/Default405Response"
16429 },
16430 "406" : {
16431 "$ref" : "#/components/responses/Default406Response"
16432 },
16433 "415" : {
16434 "$ref" : "#/components/responses/Default415Response"
16435 },
16436 "429" : {
16437 "$ref" : "#/components/responses/Default429Response"
16438 },
16439 "500" : {
16440 "$ref" : "#/components/responses/Default500Response"
16441 },
16442 "503" : {
16443 "$ref" : "#/components/responses/Default503Response"
16444 }
16445 },
16446 "security" : [ {
16447 "Authorization_Code_PKCE" : [ "r_usr", "search.read" ]
16448 } ],
16449 "summary" : "Get history relationship (\"to-many\").",
16450 "tags" : [ "searchSuggestions" ],
16451 "x-path-item-properties" : {
16452 "required-access-tier" : "INTERNAL"
16453 }
16454 }
16455 },
16456 "/shares" : {
16457 "get" : {
16458 "description" : "Retrieves multiple shares by available filters, or without if applicable.",
16459 "parameters" : [ {
16460 "description" : "A share code (e.g. `xyz`)",
16461 "in" : "query",
16462 "name" : "filter[code]",
16463 "required" : true,
16464 "schema" : {
16465 "type" : "array",
16466 "items" : {
16467 "type" : "string"
16468 }
16469 }
16470 }, {
16471 "description" : "Allows the client to customize which related resources should be returned. Available options: owners, sharedResources",
16472 "example" : "sharedResources",
16473 "in" : "query",
16474 "name" : "include",
16475 "required" : false,
16476 "schema" : {
16477 "type" : "array",
16478 "items" : {
16479 "type" : "string",
16480 "example" : "sharedResources"
16481 }
16482 }
16483 }, {
16484 "description" : "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",
16485 "example" : "sharedResources",
16486 "in" : "query",
16487 "name" : "replaceMedia",
16488 "required" : false,
16489 "schema" : {
16490 "type" : "string",
16491 "example" : "sharedResources"
16492 }
16493 } ],
16494 "responses" : {
16495 "200" : {
16496 "content" : {
16497 "application/vnd.api+json" : {
16498 "schema" : {
16499 "$ref" : "#/components/schemas/Shares_Multi_Resource_Data_Document"
16500 }
16501 }
16502 },
16503 "description" : "Successful response"
16504 },
16505 "400" : {
16506 "$ref" : "#/components/responses/Default400Response"
16507 },
16508 "404" : {
16509 "$ref" : "#/components/responses/Default404Response"
16510 },
16511 "405" : {
16512 "$ref" : "#/components/responses/Default405Response"
16513 },
16514 "406" : {
16515 "$ref" : "#/components/responses/Default406Response"
16516 },
16517 "415" : {
16518 "$ref" : "#/components/responses/Default415Response"
16519 },
16520 "429" : {
16521 "$ref" : "#/components/responses/Default429Response"
16522 },
16523 "500" : {
16524 "$ref" : "#/components/responses/Default500Response"
16525 },
16526 "503" : {
16527 "$ref" : "#/components/responses/Default503Response"
16528 }
16529 },
16530 "security" : [ {
16531 "Client_Credentials" : [ ]
16532 }, {
16533 "Authorization_Code_PKCE" : [ ]
16534 } ],
16535 "summary" : "Get multiple shares.",
16536 "tags" : [ "shares" ],
16537 "x-path-item-properties" : {
16538 "required-access-tier" : "INTERNAL"
16539 }
16540 },
16541 "post" : {
16542 "description" : "Creates a new share.",
16543 "parameters" : [ {
16544 "$ref" : "#/components/parameters/IdempotencyKey"
16545 } ],
16546 "requestBody" : {
16547 "content" : {
16548 "application/vnd.api+json" : {
16549 "schema" : {
16550 "$ref" : "#/components/schemas/SharesCreateOperation_Payload"
16551 }
16552 }
16553 }
16554 },
16555 "responses" : {
16556 "201" : {
16557 "content" : {
16558 "application/vnd.api+json" : {
16559 "schema" : {
16560 "$ref" : "#/components/schemas/Shares_Create_Single_Resource_Data_Document"
16561 }
16562 }
16563 },
16564 "description" : "Successful response"
16565 },
16566 "400" : {
16567 "$ref" : "#/components/responses/Default400Response"
16568 },
16569 "404" : {
16570 "$ref" : "#/components/responses/Default404Response"
16571 },
16572 "405" : {
16573 "$ref" : "#/components/responses/Default405Response"
16574 },
16575 "406" : {
16576 "$ref" : "#/components/responses/Default406Response"
16577 },
16578 "409" : {
16579 "$ref" : "#/components/responses/Idempotency409Response"
16580 },
16581 "415" : {
16582 "$ref" : "#/components/responses/Default415Response"
16583 },
16584 "422" : {
16585 "$ref" : "#/components/responses/Idempotency422Response"
16586 },
16587 "429" : {
16588 "$ref" : "#/components/responses/Default429Response"
16589 },
16590 "500" : {
16591 "$ref" : "#/components/responses/Default500Response"
16592 },
16593 "503" : {
16594 "$ref" : "#/components/responses/Default503Response"
16595 }
16596 },
16597 "security" : [ {
16598 "Authorization_Code_PKCE" : [ "w_usr" ]
16599 } ],
16600 "summary" : "Create single share.",
16601 "tags" : [ "shares" ],
16602 "x-path-item-properties" : {
16603 "required-access-tier" : "INTERNAL"
16604 }
16605 }
16606 },
16607 "/shares/{id}" : {
16608 "get" : {
16609 "description" : "Retrieves single share by id.",
16610 "parameters" : [ {
16611 "description" : "User share id",
16612 "example" : "a468bee88def",
16613 "in" : "path",
16614 "name" : "id",
16615 "required" : true,
16616 "schema" : {
16617 "type" : "string"
16618 }
16619 }, {
16620 "description" : "Allows the client to customize which related resources should be returned. Available options: owners, sharedResources",
16621 "example" : "sharedResources",
16622 "in" : "query",
16623 "name" : "include",
16624 "required" : false,
16625 "schema" : {
16626 "type" : "array",
16627 "items" : {
16628 "type" : "string",
16629 "example" : "sharedResources"
16630 }
16631 }
16632 }, {
16633 "description" : "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",
16634 "example" : "sharedResources",
16635 "in" : "query",
16636 "name" : "replaceMedia",
16637 "required" : false,
16638 "schema" : {
16639 "type" : "string",
16640 "example" : "sharedResources"
16641 }
16642 } ],
16643 "responses" : {
16644 "200" : {
16645 "content" : {
16646 "application/vnd.api+json" : {
16647 "schema" : {
16648 "$ref" : "#/components/schemas/Shares_Single_Resource_Data_Document"
16649 }
16650 }
16651 },
16652 "description" : "Successful response"
16653 },
16654 "400" : {
16655 "$ref" : "#/components/responses/Default400Response"
16656 },
16657 "404" : {
16658 "$ref" : "#/components/responses/Default404Response"
16659 },
16660 "405" : {
16661 "$ref" : "#/components/responses/Default405Response"
16662 },
16663 "406" : {
16664 "$ref" : "#/components/responses/Default406Response"
16665 },
16666 "415" : {
16667 "$ref" : "#/components/responses/Default415Response"
16668 },
16669 "429" : {
16670 "$ref" : "#/components/responses/Default429Response"
16671 },
16672 "500" : {
16673 "$ref" : "#/components/responses/Default500Response"
16674 },
16675 "503" : {
16676 "$ref" : "#/components/responses/Default503Response"
16677 }
16678 },
16679 "security" : [ {
16680 "Client_Credentials" : [ ]
16681 }, {
16682 "Authorization_Code_PKCE" : [ ]
16683 } ],
16684 "summary" : "Get single share.",
16685 "tags" : [ "shares" ],
16686 "x-path-item-properties" : {
16687 "required-access-tier" : "INTERNAL"
16688 }
16689 }
16690 },
16691 "/shares/{id}/relationships/owners" : {
16692 "get" : {
16693 "description" : "Retrieves owners relationship.",
16694 "parameters" : [ {
16695 "description" : "User share id",
16696 "example" : "a468bee88def",
16697 "in" : "path",
16698 "name" : "id",
16699 "required" : true,
16700 "schema" : {
16701 "type" : "string"
16702 }
16703 }, {
16704 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
16705 "example" : "owners",
16706 "in" : "query",
16707 "name" : "include",
16708 "required" : false,
16709 "schema" : {
16710 "type" : "array",
16711 "items" : {
16712 "type" : "string",
16713 "example" : "owners"
16714 }
16715 }
16716 }, {
16717 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
16718 "in" : "query",
16719 "name" : "page[cursor]",
16720 "required" : false,
16721 "schema" : {
16722 "type" : "string"
16723 }
16724 } ],
16725 "responses" : {
16726 "200" : {
16727 "content" : {
16728 "application/vnd.api+json" : {
16729 "schema" : {
16730 "$ref" : "#/components/schemas/Shares_Multi_Relationship_Data_Document"
16731 }
16732 }
16733 },
16734 "description" : "Successful response"
16735 },
16736 "400" : {
16737 "$ref" : "#/components/responses/Default400Response"
16738 },
16739 "404" : {
16740 "$ref" : "#/components/responses/Default404Response"
16741 },
16742 "405" : {
16743 "$ref" : "#/components/responses/Default405Response"
16744 },
16745 "406" : {
16746 "$ref" : "#/components/responses/Default406Response"
16747 },
16748 "415" : {
16749 "$ref" : "#/components/responses/Default415Response"
16750 },
16751 "429" : {
16752 "$ref" : "#/components/responses/Default429Response"
16753 },
16754 "500" : {
16755 "$ref" : "#/components/responses/Default500Response"
16756 },
16757 "503" : {
16758 "$ref" : "#/components/responses/Default503Response"
16759 }
16760 },
16761 "security" : [ {
16762 "Client_Credentials" : [ ]
16763 }, {
16764 "Authorization_Code_PKCE" : [ ]
16765 } ],
16766 "summary" : "Get owners relationship (\"to-many\").",
16767 "tags" : [ "shares" ],
16768 "x-path-item-properties" : {
16769 "required-access-tier" : "INTERNAL"
16770 }
16771 }
16772 },
16773 "/shares/{id}/relationships/sharedResources" : {
16774 "get" : {
16775 "description" : "Retrieves sharedResources relationship.",
16776 "parameters" : [ {
16777 "description" : "User share id",
16778 "example" : "a468bee88def",
16779 "in" : "path",
16780 "name" : "id",
16781 "required" : true,
16782 "schema" : {
16783 "type" : "string"
16784 }
16785 }, {
16786 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
16787 "in" : "query",
16788 "name" : "page[cursor]",
16789 "required" : false,
16790 "schema" : {
16791 "type" : "string"
16792 }
16793 }, {
16794 "description" : "Allows the client to customize which related resources should be returned. Available options: sharedResources",
16795 "example" : "sharedResources",
16796 "in" : "query",
16797 "name" : "include",
16798 "required" : false,
16799 "schema" : {
16800 "type" : "array",
16801 "items" : {
16802 "type" : "string",
16803 "example" : "sharedResources"
16804 }
16805 }
16806 }, {
16807 "description" : "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",
16808 "example" : "sharedResources",
16809 "in" : "query",
16810 "name" : "replaceMedia",
16811 "required" : false,
16812 "schema" : {
16813 "type" : "string",
16814 "example" : "sharedResources"
16815 }
16816 } ],
16817 "responses" : {
16818 "200" : {
16819 "content" : {
16820 "application/vnd.api+json" : {
16821 "schema" : {
16822 "$ref" : "#/components/schemas/Shares_Multi_Relationship_Data_Document"
16823 }
16824 }
16825 },
16826 "description" : "Successful response"
16827 },
16828 "400" : {
16829 "$ref" : "#/components/responses/Default400Response"
16830 },
16831 "404" : {
16832 "$ref" : "#/components/responses/Default404Response"
16833 },
16834 "405" : {
16835 "$ref" : "#/components/responses/Default405Response"
16836 },
16837 "406" : {
16838 "$ref" : "#/components/responses/Default406Response"
16839 },
16840 "415" : {
16841 "$ref" : "#/components/responses/Default415Response"
16842 },
16843 "429" : {
16844 "$ref" : "#/components/responses/Default429Response"
16845 },
16846 "500" : {
16847 "$ref" : "#/components/responses/Default500Response"
16848 },
16849 "503" : {
16850 "$ref" : "#/components/responses/Default503Response"
16851 }
16852 },
16853 "security" : [ {
16854 "Client_Credentials" : [ ]
16855 }, {
16856 "Authorization_Code_PKCE" : [ ]
16857 } ],
16858 "summary" : "Get sharedResources relationship (\"to-many\").",
16859 "tags" : [ "shares" ],
16860 "x-path-item-properties" : {
16861 "required-access-tier" : "INTERNAL"
16862 }
16863 }
16864 },
16865 "/squareConnections" : {
16866 "post" : {
16867 "description" : "Creates a new squareConnection.",
16868 "parameters" : [ {
16869 "deprecated" : true,
16870 "description" : "ISO 3166-1 alpha-2 country code",
16871 "example" : "US",
16872 "in" : "query",
16873 "name" : "countryCode",
16874 "required" : false,
16875 "schema" : {
16876 "type" : "string"
16877 }
16878 }, {
16879 "$ref" : "#/components/parameters/IdempotencyKey"
16880 } ],
16881 "requestBody" : {
16882 "content" : {
16883 "application/vnd.api+json" : {
16884 "schema" : {
16885 "$ref" : "#/components/schemas/SquareConnectionsCreateOperation_Payload"
16886 }
16887 }
16888 }
16889 },
16890 "responses" : {
16891 "201" : {
16892 "content" : {
16893 "application/vnd.api+json" : {
16894 "schema" : {
16895 "$ref" : "#/components/schemas/SquareConnections_Create_Single_Resource_Data_Document"
16896 }
16897 }
16898 },
16899 "description" : "Successful response"
16900 },
16901 "400" : {
16902 "$ref" : "#/components/responses/Default400Response"
16903 },
16904 "404" : {
16905 "$ref" : "#/components/responses/Default404Response"
16906 },
16907 "405" : {
16908 "$ref" : "#/components/responses/Default405Response"
16909 },
16910 "406" : {
16911 "$ref" : "#/components/responses/Default406Response"
16912 },
16913 "409" : {
16914 "$ref" : "#/components/responses/Idempotency409Response"
16915 },
16916 "415" : {
16917 "$ref" : "#/components/responses/Default415Response"
16918 },
16919 "422" : {
16920 "$ref" : "#/components/responses/Idempotency422Response"
16921 },
16922 "429" : {
16923 "$ref" : "#/components/responses/Default429Response"
16924 },
16925 "500" : {
16926 "$ref" : "#/components/responses/Default500Response"
16927 },
16928 "503" : {
16929 "$ref" : "#/components/responses/Default503Response"
16930 }
16931 },
16932 "security" : [ {
16933 "Authorization_Code_PKCE" : [ "w_usr" ]
16934 } ],
16935 "summary" : "Create single squareConnection.",
16936 "tags" : [ "squareConnections" ],
16937 "x-path-item-properties" : {
16938 "required-access-tier" : "INTERNAL"
16939 }
16940 }
16941 },
16942 "/squareConnections/{id}" : {
16943 "get" : {
16944 "description" : "Retrieves single squareConnection by id.",
16945 "parameters" : [ {
16946 "description" : "Square connection id. Use `me` for the authenticated user's resource",
16947 "example" : "me",
16948 "in" : "path",
16949 "name" : "id",
16950 "required" : true,
16951 "schema" : {
16952 "type" : "string"
16953 }
16954 }, {
16955 "description" : "Allows the client to customize which related resources should be returned. Available options: selectedSite, sites",
16956 "example" : "selectedSite",
16957 "in" : "query",
16958 "name" : "include",
16959 "required" : false,
16960 "schema" : {
16961 "type" : "array",
16962 "items" : {
16963 "type" : "string",
16964 "example" : "selectedSite"
16965 }
16966 }
16967 } ],
16968 "responses" : {
16969 "200" : {
16970 "content" : {
16971 "application/vnd.api+json" : {
16972 "schema" : {
16973 "$ref" : "#/components/schemas/SquareConnections_Single_Resource_Data_Document"
16974 }
16975 }
16976 },
16977 "description" : "Successful response"
16978 },
16979 "400" : {
16980 "$ref" : "#/components/responses/Default400Response"
16981 },
16982 "403" : {
16983 "$ref" : "#/components/responses/SquareConnectionsReadById403Response"
16984 },
16985 "404" : {
16986 "$ref" : "#/components/responses/Default404Response"
16987 },
16988 "405" : {
16989 "$ref" : "#/components/responses/Default405Response"
16990 },
16991 "406" : {
16992 "$ref" : "#/components/responses/Default406Response"
16993 },
16994 "415" : {
16995 "$ref" : "#/components/responses/Default415Response"
16996 },
16997 "429" : {
16998 "$ref" : "#/components/responses/Default429Response"
16999 },
17000 "500" : {
17001 "$ref" : "#/components/responses/Default500Response"
17002 },
17003 "503" : {
17004 "$ref" : "#/components/responses/Default503Response"
17005 }
17006 },
17007 "security" : [ {
17008 "Authorization_Code_PKCE" : [ "r_usr" ]
17009 } ],
17010 "summary" : "Get single squareConnection.",
17011 "tags" : [ "squareConnections" ],
17012 "x-path-item-properties" : {
17013 "required-access-tier" : "INTERNAL"
17014 }
17015 }
17016 },
17017 "/squareConnections/{id}/relationships/selectedSite" : {
17018 "get" : {
17019 "description" : "Retrieves selectedSite relationship.",
17020 "parameters" : [ {
17021 "description" : "Square connection id. Use `me` for the authenticated user's resource",
17022 "example" : "me",
17023 "in" : "path",
17024 "name" : "id",
17025 "required" : true,
17026 "schema" : {
17027 "type" : "string"
17028 }
17029 }, {
17030 "description" : "Allows the client to customize which related resources should be returned. Available options: selectedSite",
17031 "example" : "selectedSite",
17032 "in" : "query",
17033 "name" : "include",
17034 "required" : false,
17035 "schema" : {
17036 "type" : "array",
17037 "items" : {
17038 "type" : "string",
17039 "example" : "selectedSite"
17040 }
17041 }
17042 } ],
17043 "responses" : {
17044 "200" : {
17045 "content" : {
17046 "application/vnd.api+json" : {
17047 "schema" : {
17048 "$ref" : "#/components/schemas/SquareConnections_Single_Relationship_Data_Document"
17049 }
17050 }
17051 },
17052 "description" : "Successful response"
17053 },
17054 "400" : {
17055 "$ref" : "#/components/responses/Default400Response"
17056 },
17057 "403" : {
17058 "$ref" : "#/components/responses/SquareConnectionsReadSingleDataRelationship403Response"
17059 },
17060 "404" : {
17061 "$ref" : "#/components/responses/Default404Response"
17062 },
17063 "405" : {
17064 "$ref" : "#/components/responses/Default405Response"
17065 },
17066 "406" : {
17067 "$ref" : "#/components/responses/Default406Response"
17068 },
17069 "415" : {
17070 "$ref" : "#/components/responses/Default415Response"
17071 },
17072 "429" : {
17073 "$ref" : "#/components/responses/Default429Response"
17074 },
17075 "500" : {
17076 "$ref" : "#/components/responses/Default500Response"
17077 },
17078 "503" : {
17079 "$ref" : "#/components/responses/Default503Response"
17080 }
17081 },
17082 "security" : [ {
17083 "Authorization_Code_PKCE" : [ "r_usr" ]
17084 } ],
17085 "summary" : "Get selectedSite relationship (\"to-one\").",
17086 "tags" : [ "squareConnections" ],
17087 "x-path-item-properties" : {
17088 "required-access-tier" : "INTERNAL"
17089 }
17090 },
17091 "patch" : {
17092 "description" : "Updates selectedSite relationship.",
17093 "parameters" : [ {
17094 "description" : "Square connection id. Use `me` for the authenticated user's resource",
17095 "example" : "me",
17096 "in" : "path",
17097 "name" : "id",
17098 "required" : true,
17099 "schema" : {
17100 "type" : "string"
17101 }
17102 }, {
17103 "$ref" : "#/components/parameters/IdempotencyKey"
17104 } ],
17105 "requestBody" : {
17106 "content" : {
17107 "application/vnd.api+json" : {
17108 "schema" : {
17109 "$ref" : "#/components/schemas/SquareConnectionsSelectedSiteRelationshipUpdateOperation_Payload"
17110 }
17111 }
17112 }
17113 },
17114 "responses" : {
17115 "200" : {
17116 "content" : {
17117 "application/vnd.api+json" : {
17118 "schema" : {
17119 "$ref" : "#/components/schemas/SquareConnections_SelectedSite_Update_Single_Relationship_Data_Document"
17120 }
17121 }
17122 },
17123 "description" : "Successful response"
17124 },
17125 "400" : {
17126 "$ref" : "#/components/responses/Default400Response"
17127 },
17128 "403" : {
17129 "$ref" : "#/components/responses/SquareConnectionsUpdateSingleDataRelationship403Response"
17130 },
17131 "404" : {
17132 "$ref" : "#/components/responses/Default404Response"
17133 },
17134 "405" : {
17135 "$ref" : "#/components/responses/Default405Response"
17136 },
17137 "406" : {
17138 "$ref" : "#/components/responses/Default406Response"
17139 },
17140 "409" : {
17141 "$ref" : "#/components/responses/SquareConnectionsUpdateSingleDataRelationship409Response"
17142 },
17143 "415" : {
17144 "$ref" : "#/components/responses/Default415Response"
17145 },
17146 "422" : {
17147 "$ref" : "#/components/responses/Idempotency422Response"
17148 },
17149 "429" : {
17150 "$ref" : "#/components/responses/Default429Response"
17151 },
17152 "500" : {
17153 "$ref" : "#/components/responses/Default500Response"
17154 },
17155 "503" : {
17156 "$ref" : "#/components/responses/Default503Response"
17157 }
17158 },
17159 "security" : [ {
17160 "Authorization_Code_PKCE" : [ "w_usr" ]
17161 } ],
17162 "summary" : "Update selectedSite relationship (\"to-one\").",
17163 "tags" : [ "squareConnections" ],
17164 "x-path-item-properties" : {
17165 "required-access-tier" : "INTERNAL"
17166 }
17167 }
17168 },
17169 "/squareConnections/{id}/relationships/sites" : {
17170 "get" : {
17171 "description" : "Retrieves sites relationship.",
17172 "parameters" : [ {
17173 "description" : "Square connection id. Use `me` for the authenticated user's resource",
17174 "example" : "me",
17175 "in" : "path",
17176 "name" : "id",
17177 "required" : true,
17178 "schema" : {
17179 "type" : "string"
17180 }
17181 }, {
17182 "description" : "Allows the client to customize which related resources should be returned. Available options: sites",
17183 "example" : "sites",
17184 "in" : "query",
17185 "name" : "include",
17186 "required" : false,
17187 "schema" : {
17188 "type" : "array",
17189 "items" : {
17190 "type" : "string",
17191 "example" : "sites"
17192 }
17193 }
17194 }, {
17195 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
17196 "in" : "query",
17197 "name" : "page[cursor]",
17198 "required" : false,
17199 "schema" : {
17200 "type" : "string"
17201 }
17202 } ],
17203 "responses" : {
17204 "200" : {
17205 "content" : {
17206 "application/vnd.api+json" : {
17207 "schema" : {
17208 "$ref" : "#/components/schemas/SquareConnections_Multi_Relationship_Data_Document"
17209 }
17210 }
17211 },
17212 "description" : "Successful response"
17213 },
17214 "400" : {
17215 "$ref" : "#/components/responses/Default400Response"
17216 },
17217 "403" : {
17218 "$ref" : "#/components/responses/SquareConnectionsReadMultiDataRelationship403Response"
17219 },
17220 "404" : {
17221 "$ref" : "#/components/responses/Default404Response"
17222 },
17223 "405" : {
17224 "$ref" : "#/components/responses/Default405Response"
17225 },
17226 "406" : {
17227 "$ref" : "#/components/responses/Default406Response"
17228 },
17229 "415" : {
17230 "$ref" : "#/components/responses/Default415Response"
17231 },
17232 "429" : {
17233 "$ref" : "#/components/responses/Default429Response"
17234 },
17235 "500" : {
17236 "$ref" : "#/components/responses/Default500Response"
17237 },
17238 "503" : {
17239 "$ref" : "#/components/responses/Default503Response"
17240 }
17241 },
17242 "security" : [ {
17243 "Authorization_Code_PKCE" : [ "r_usr" ]
17244 } ],
17245 "summary" : "Get sites relationship (\"to-many\").",
17246 "tags" : [ "squareConnections" ],
17247 "x-path-item-properties" : {
17248 "required-access-tier" : "INTERNAL"
17249 }
17250 }
17251 },
17252 "/stripeConnections" : {
17253 "get" : {
17254 "description" : "Retrieves multiple stripeConnections by available filters, or without if applicable.",
17255 "parameters" : [ {
17256 "description" : "User id. Use `me` for the authenticated user",
17257 "in" : "query",
17258 "name" : "filter[owners.id]",
17259 "required" : true,
17260 "schema" : {
17261 "type" : "array",
17262 "items" : {
17263 "type" : "string"
17264 }
17265 }
17266 }, {
17267 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
17268 "example" : "owners",
17269 "in" : "query",
17270 "name" : "include",
17271 "required" : false,
17272 "schema" : {
17273 "type" : "array",
17274 "items" : {
17275 "type" : "string",
17276 "example" : "owners"
17277 }
17278 }
17279 } ],
17280 "responses" : {
17281 "200" : {
17282 "content" : {
17283 "application/vnd.api+json" : {
17284 "schema" : {
17285 "$ref" : "#/components/schemas/StripeConnections_Multi_Resource_Data_Document"
17286 }
17287 }
17288 },
17289 "description" : "Successful response"
17290 },
17291 "400" : {
17292 "$ref" : "#/components/responses/Default400Response"
17293 },
17294 "404" : {
17295 "$ref" : "#/components/responses/Default404Response"
17296 },
17297 "405" : {
17298 "$ref" : "#/components/responses/Default405Response"
17299 },
17300 "406" : {
17301 "$ref" : "#/components/responses/Default406Response"
17302 },
17303 "415" : {
17304 "$ref" : "#/components/responses/Default415Response"
17305 },
17306 "429" : {
17307 "$ref" : "#/components/responses/Default429Response"
17308 },
17309 "500" : {
17310 "$ref" : "#/components/responses/Default500Response"
17311 },
17312 "503" : {
17313 "$ref" : "#/components/responses/Default503Response"
17314 }
17315 },
17316 "security" : [ {
17317 "Authorization_Code_PKCE" : [ "r_usr" ]
17318 } ],
17319 "summary" : "Get multiple stripeConnections.",
17320 "tags" : [ "stripeConnections" ],
17321 "x-path-item-properties" : {
17322 "required-access-tier" : "INTERNAL"
17323 }
17324 },
17325 "post" : {
17326 "description" : "Creates a new stripeConnection.",
17327 "parameters" : [ {
17328 "description" : "ISO 3166-1 alpha-2 country code",
17329 "example" : "US",
17330 "in" : "query",
17331 "name" : "countryCode",
17332 "required" : false,
17333 "schema" : {
17334 "type" : "string"
17335 }
17336 }, {
17337 "$ref" : "#/components/parameters/IdempotencyKey"
17338 } ],
17339 "requestBody" : {
17340 "content" : {
17341 "application/vnd.api+json" : {
17342 "schema" : {
17343 "$ref" : "#/components/schemas/StripeConnectionsCreateOperation_Payload"
17344 }
17345 }
17346 }
17347 },
17348 "responses" : {
17349 "201" : {
17350 "content" : {
17351 "application/vnd.api+json" : {
17352 "schema" : {
17353 "$ref" : "#/components/schemas/StripeConnections_Create_Single_Resource_Data_Document"
17354 }
17355 }
17356 },
17357 "description" : "Successful response"
17358 },
17359 "400" : {
17360 "$ref" : "#/components/responses/Default400Response"
17361 },
17362 "404" : {
17363 "$ref" : "#/components/responses/Default404Response"
17364 },
17365 "405" : {
17366 "$ref" : "#/components/responses/Default405Response"
17367 },
17368 "406" : {
17369 "$ref" : "#/components/responses/Default406Response"
17370 },
17371 "409" : {
17372 "$ref" : "#/components/responses/Idempotency409Response"
17373 },
17374 "415" : {
17375 "$ref" : "#/components/responses/Default415Response"
17376 },
17377 "422" : {
17378 "$ref" : "#/components/responses/Idempotency422Response"
17379 },
17380 "429" : {
17381 "$ref" : "#/components/responses/Default429Response"
17382 },
17383 "500" : {
17384 "$ref" : "#/components/responses/Default500Response"
17385 },
17386 "503" : {
17387 "$ref" : "#/components/responses/Default503Response"
17388 }
17389 },
17390 "security" : [ {
17391 "Authorization_Code_PKCE" : [ "w_usr" ]
17392 } ],
17393 "summary" : "Create single stripeConnection.",
17394 "tags" : [ "stripeConnections" ],
17395 "x-path-item-properties" : {
17396 "required-access-tier" : "INTERNAL"
17397 }
17398 }
17399 },
17400 "/stripeConnections/{id}/relationships/owners" : {
17401 "get" : {
17402 "description" : "Retrieves owners relationship.",
17403 "parameters" : [ {
17404 "description" : "Stripe connection id. Use `me` for the authenticated user's resource",
17405 "example" : "me",
17406 "in" : "path",
17407 "name" : "id",
17408 "required" : true,
17409 "schema" : {
17410 "type" : "string"
17411 }
17412 }, {
17413 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
17414 "example" : "owners",
17415 "in" : "query",
17416 "name" : "include",
17417 "required" : false,
17418 "schema" : {
17419 "type" : "array",
17420 "items" : {
17421 "type" : "string",
17422 "example" : "owners"
17423 }
17424 }
17425 }, {
17426 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
17427 "in" : "query",
17428 "name" : "page[cursor]",
17429 "required" : false,
17430 "schema" : {
17431 "type" : "string"
17432 }
17433 } ],
17434 "responses" : {
17435 "200" : {
17436 "content" : {
17437 "application/vnd.api+json" : {
17438 "schema" : {
17439 "$ref" : "#/components/schemas/StripeConnections_Multi_Relationship_Data_Document"
17440 }
17441 }
17442 },
17443 "description" : "Successful response"
17444 },
17445 "400" : {
17446 "$ref" : "#/components/responses/Default400Response"
17447 },
17448 "404" : {
17449 "$ref" : "#/components/responses/Default404Response"
17450 },
17451 "405" : {
17452 "$ref" : "#/components/responses/Default405Response"
17453 },
17454 "406" : {
17455 "$ref" : "#/components/responses/Default406Response"
17456 },
17457 "415" : {
17458 "$ref" : "#/components/responses/Default415Response"
17459 },
17460 "429" : {
17461 "$ref" : "#/components/responses/Default429Response"
17462 },
17463 "500" : {
17464 "$ref" : "#/components/responses/Default500Response"
17465 },
17466 "503" : {
17467 "$ref" : "#/components/responses/Default503Response"
17468 }
17469 },
17470 "security" : [ {
17471 "Authorization_Code_PKCE" : [ "r_usr" ]
17472 } ],
17473 "summary" : "Get owners relationship (\"to-many\").",
17474 "tags" : [ "stripeConnections" ],
17475 "x-path-item-properties" : {
17476 "required-access-tier" : "INTERNAL"
17477 }
17478 }
17479 },
17480 "/stripeDashboardLinks" : {
17481 "get" : {
17482 "description" : "Retrieves multiple stripeDashboardLinks by available filters, or without if applicable.",
17483 "parameters" : [ {
17484 "description" : "User id. Use `me` for the authenticated user",
17485 "in" : "query",
17486 "name" : "filter[owners.id]",
17487 "required" : true,
17488 "schema" : {
17489 "type" : "array",
17490 "items" : {
17491 "type" : "string"
17492 }
17493 }
17494 }, {
17495 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
17496 "example" : "owners",
17497 "in" : "query",
17498 "name" : "include",
17499 "required" : false,
17500 "schema" : {
17501 "type" : "array",
17502 "items" : {
17503 "type" : "string",
17504 "example" : "owners"
17505 }
17506 }
17507 } ],
17508 "responses" : {
17509 "200" : {
17510 "content" : {
17511 "application/vnd.api+json" : {
17512 "schema" : {
17513 "$ref" : "#/components/schemas/StripeDashboardLinks_Multi_Resource_Data_Document"
17514 }
17515 }
17516 },
17517 "description" : "Successful response"
17518 },
17519 "400" : {
17520 "$ref" : "#/components/responses/Default400Response"
17521 },
17522 "404" : {
17523 "$ref" : "#/components/responses/Default404Response"
17524 },
17525 "405" : {
17526 "$ref" : "#/components/responses/Default405Response"
17527 },
17528 "406" : {
17529 "$ref" : "#/components/responses/Default406Response"
17530 },
17531 "415" : {
17532 "$ref" : "#/components/responses/Default415Response"
17533 },
17534 "429" : {
17535 "$ref" : "#/components/responses/Default429Response"
17536 },
17537 "500" : {
17538 "$ref" : "#/components/responses/Default500Response"
17539 },
17540 "503" : {
17541 "$ref" : "#/components/responses/Default503Response"
17542 }
17543 },
17544 "security" : [ {
17545 "Authorization_Code_PKCE" : [ "r_usr" ]
17546 } ],
17547 "summary" : "Get multiple stripeDashboardLinks.",
17548 "tags" : [ "stripeDashboardLinks" ],
17549 "x-path-item-properties" : {
17550 "required-access-tier" : "INTERNAL"
17551 }
17552 }
17553 },
17554 "/stripeDashboardLinks/{id}/relationships/owners" : {
17555 "get" : {
17556 "description" : "Retrieves owners relationship.",
17557 "parameters" : [ {
17558 "description" : "Stripe dashboard link id. Use `me` for the authenticated user's resource",
17559 "example" : "me",
17560 "in" : "path",
17561 "name" : "id",
17562 "required" : true,
17563 "schema" : {
17564 "type" : "string"
17565 }
17566 }, {
17567 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
17568 "example" : "owners",
17569 "in" : "query",
17570 "name" : "include",
17571 "required" : false,
17572 "schema" : {
17573 "type" : "array",
17574 "items" : {
17575 "type" : "string",
17576 "example" : "owners"
17577 }
17578 }
17579 }, {
17580 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
17581 "in" : "query",
17582 "name" : "page[cursor]",
17583 "required" : false,
17584 "schema" : {
17585 "type" : "string"
17586 }
17587 } ],
17588 "responses" : {
17589 "200" : {
17590 "content" : {
17591 "application/vnd.api+json" : {
17592 "schema" : {
17593 "$ref" : "#/components/schemas/StripeDashboardLinks_Multi_Relationship_Data_Document"
17594 }
17595 }
17596 },
17597 "description" : "Successful response"
17598 },
17599 "400" : {
17600 "$ref" : "#/components/responses/Default400Response"
17601 },
17602 "404" : {
17603 "$ref" : "#/components/responses/Default404Response"
17604 },
17605 "405" : {
17606 "$ref" : "#/components/responses/Default405Response"
17607 },
17608 "406" : {
17609 "$ref" : "#/components/responses/Default406Response"
17610 },
17611 "415" : {
17612 "$ref" : "#/components/responses/Default415Response"
17613 },
17614 "429" : {
17615 "$ref" : "#/components/responses/Default429Response"
17616 },
17617 "500" : {
17618 "$ref" : "#/components/responses/Default500Response"
17619 },
17620 "503" : {
17621 "$ref" : "#/components/responses/Default503Response"
17622 }
17623 },
17624 "security" : [ {
17625 "Authorization_Code_PKCE" : [ "r_usr" ]
17626 } ],
17627 "summary" : "Get owners relationship (\"to-many\").",
17628 "tags" : [ "stripeDashboardLinks" ],
17629 "x-path-item-properties" : {
17630 "required-access-tier" : "INTERNAL"
17631 }
17632 }
17633 },
17634 "/subscriptionPriceChangeDecisions" : {
17635 "get" : {
17636 "description" : "Retrieves multiple subscriptionPriceChangeDecisions by available filters, or without if applicable.",
17637 "parameters" : [ {
17638 "description" : "User id. Use `me` for the authenticated user",
17639 "in" : "query",
17640 "name" : "filter[owners.id]",
17641 "required" : true,
17642 "schema" : {
17643 "type" : "array",
17644 "items" : {
17645 "type" : "string"
17646 }
17647 }
17648 }, {
17649 "description" : "Allows the client to customize which related resources should be returned. Available options: priceChange",
17650 "example" : "priceChange",
17651 "in" : "query",
17652 "name" : "include",
17653 "required" : false,
17654 "schema" : {
17655 "type" : "array",
17656 "items" : {
17657 "type" : "string",
17658 "example" : "priceChange"
17659 }
17660 }
17661 } ],
17662 "responses" : {
17663 "200" : {
17664 "content" : {
17665 "application/vnd.api+json" : {
17666 "schema" : {
17667 "$ref" : "#/components/schemas/SubscriptionPriceChangeDecisions_Multi_Resource_Data_Document"
17668 }
17669 }
17670 },
17671 "description" : "Successful response"
17672 },
17673 "400" : {
17674 "$ref" : "#/components/responses/Default400Response"
17675 },
17676 "404" : {
17677 "$ref" : "#/components/responses/Default404Response"
17678 },
17679 "405" : {
17680 "$ref" : "#/components/responses/Default405Response"
17681 },
17682 "406" : {
17683 "$ref" : "#/components/responses/Default406Response"
17684 },
17685 "415" : {
17686 "$ref" : "#/components/responses/Default415Response"
17687 },
17688 "429" : {
17689 "$ref" : "#/components/responses/Default429Response"
17690 },
17691 "500" : {
17692 "$ref" : "#/components/responses/Default500Response"
17693 },
17694 "503" : {
17695 "$ref" : "#/components/responses/Default503Response"
17696 }
17697 },
17698 "security" : [ {
17699 "Authorization_Code_PKCE" : [ "r_usr" ]
17700 } ],
17701 "summary" : "Get multiple subscriptionPriceChangeDecisions.",
17702 "tags" : [ "subscriptionPriceChangeDecisions" ],
17703 "x-path-item-properties" : {
17704 "required-access-tier" : "INTERNAL"
17705 }
17706 },
17707 "post" : {
17708 "description" : "Creates a new subscriptionPriceChangeDecision.",
17709 "parameters" : [ {
17710 "$ref" : "#/components/parameters/IdempotencyKey"
17711 } ],
17712 "requestBody" : {
17713 "content" : {
17714 "application/vnd.api+json" : {
17715 "schema" : {
17716 "$ref" : "#/components/schemas/SubscriptionPriceChangeDecisionsCreateOperation_Payload"
17717 }
17718 }
17719 }
17720 },
17721 "responses" : {
17722 "201" : {
17723 "content" : {
17724 "application/vnd.api+json" : {
17725 "schema" : {
17726 "$ref" : "#/components/schemas/SubscriptionPriceChangeDecisions_Create_Single_Resource_Data_Document"
17727 }
17728 }
17729 },
17730 "description" : "Successful response"
17731 },
17732 "400" : {
17733 "$ref" : "#/components/responses/Default400Response"
17734 },
17735 "404" : {
17736 "$ref" : "#/components/responses/Default404Response"
17737 },
17738 "405" : {
17739 "$ref" : "#/components/responses/Default405Response"
17740 },
17741 "406" : {
17742 "$ref" : "#/components/responses/Default406Response"
17743 },
17744 "409" : {
17745 "$ref" : "#/components/responses/Idempotency409Response"
17746 },
17747 "415" : {
17748 "$ref" : "#/components/responses/Default415Response"
17749 },
17750 "422" : {
17751 "$ref" : "#/components/responses/Idempotency422Response"
17752 },
17753 "429" : {
17754 "$ref" : "#/components/responses/Default429Response"
17755 },
17756 "500" : {
17757 "$ref" : "#/components/responses/Default500Response"
17758 },
17759 "503" : {
17760 "$ref" : "#/components/responses/Default503Response"
17761 }
17762 },
17763 "security" : [ {
17764 "Authorization_Code_PKCE" : [ "w_usr" ]
17765 } ],
17766 "summary" : "Create single subscriptionPriceChangeDecision.",
17767 "tags" : [ "subscriptionPriceChangeDecisions" ],
17768 "x-path-item-properties" : {
17769 "required-access-tier" : "INTERNAL"
17770 }
17771 }
17772 },
17773 "/subscriptionPriceChangeDecisions/{id}" : {
17774 "patch" : {
17775 "description" : "Updates existing subscriptionPriceChangeDecision.",
17776 "parameters" : [ {
17777 "description" : "Price change decision id",
17778 "example" : "1AC1yHZWFAFVjnFOn8XoXA",
17779 "in" : "path",
17780 "name" : "id",
17781 "required" : true,
17782 "schema" : {
17783 "type" : "string"
17784 }
17785 }, {
17786 "$ref" : "#/components/parameters/IdempotencyKey"
17787 } ],
17788 "requestBody" : {
17789 "content" : {
17790 "application/vnd.api+json" : {
17791 "schema" : {
17792 "$ref" : "#/components/schemas/SubscriptionPriceChangeDecisionsUpdateOperation_Payload"
17793 }
17794 }
17795 }
17796 },
17797 "responses" : {
17798 "200" : {
17799 "content" : {
17800 "application/vnd.api+json" : {
17801 "schema" : {
17802 "$ref" : "#/components/schemas/SubscriptionPriceChangeDecisions_Update_Single_Resource_Data_Document"
17803 }
17804 }
17805 },
17806 "description" : "Successful response"
17807 },
17808 "400" : {
17809 "$ref" : "#/components/responses/Default400Response"
17810 },
17811 "404" : {
17812 "$ref" : "#/components/responses/Default404Response"
17813 },
17814 "405" : {
17815 "$ref" : "#/components/responses/Default405Response"
17816 },
17817 "406" : {
17818 "$ref" : "#/components/responses/Default406Response"
17819 },
17820 "409" : {
17821 "$ref" : "#/components/responses/Idempotency409Response"
17822 },
17823 "415" : {
17824 "$ref" : "#/components/responses/Default415Response"
17825 },
17826 "422" : {
17827 "$ref" : "#/components/responses/Idempotency422Response"
17828 },
17829 "429" : {
17830 "$ref" : "#/components/responses/Default429Response"
17831 },
17832 "500" : {
17833 "$ref" : "#/components/responses/Default500Response"
17834 },
17835 "503" : {
17836 "$ref" : "#/components/responses/Default503Response"
17837 }
17838 },
17839 "security" : [ {
17840 "Authorization_Code_PKCE" : [ "w_usr" ]
17841 } ],
17842 "summary" : "Update single subscriptionPriceChangeDecision.",
17843 "tags" : [ "subscriptionPriceChangeDecisions" ],
17844 "x-path-item-properties" : {
17845 "required-access-tier" : "INTERNAL"
17846 }
17847 }
17848 },
17849 "/subscriptionPriceChangeDecisions/{id}/relationships/priceChange" : {
17850 "get" : {
17851 "description" : "Retrieves priceChange relationship.",
17852 "parameters" : [ {
17853 "description" : "Price change decision id",
17854 "example" : "1AC1yHZWFAFVjnFOn8XoXA",
17855 "in" : "path",
17856 "name" : "id",
17857 "required" : true,
17858 "schema" : {
17859 "type" : "string"
17860 }
17861 }, {
17862 "description" : "Allows the client to customize which related resources should be returned. Available options: priceChange",
17863 "example" : "priceChange",
17864 "in" : "query",
17865 "name" : "include",
17866 "required" : false,
17867 "schema" : {
17868 "type" : "array",
17869 "items" : {
17870 "type" : "string",
17871 "example" : "priceChange"
17872 }
17873 }
17874 } ],
17875 "responses" : {
17876 "200" : {
17877 "content" : {
17878 "application/vnd.api+json" : {
17879 "schema" : {
17880 "$ref" : "#/components/schemas/SubscriptionPriceChangeDecisions_Single_Relationship_Data_Document"
17881 }
17882 }
17883 },
17884 "description" : "Successful response"
17885 },
17886 "400" : {
17887 "$ref" : "#/components/responses/Default400Response"
17888 },
17889 "404" : {
17890 "$ref" : "#/components/responses/Default404Response"
17891 },
17892 "405" : {
17893 "$ref" : "#/components/responses/Default405Response"
17894 },
17895 "406" : {
17896 "$ref" : "#/components/responses/Default406Response"
17897 },
17898 "415" : {
17899 "$ref" : "#/components/responses/Default415Response"
17900 },
17901 "429" : {
17902 "$ref" : "#/components/responses/Default429Response"
17903 },
17904 "500" : {
17905 "$ref" : "#/components/responses/Default500Response"
17906 },
17907 "503" : {
17908 "$ref" : "#/components/responses/Default503Response"
17909 }
17910 },
17911 "security" : [ {
17912 "Authorization_Code_PKCE" : [ "r_usr" ]
17913 } ],
17914 "summary" : "Get priceChange relationship (\"to-one\").",
17915 "tags" : [ "subscriptionPriceChangeDecisions" ],
17916 "x-path-item-properties" : {
17917 "required-access-tier" : "INTERNAL"
17918 }
17919 }
17920 },
17921 "/temporaryUserTokens" : {
17922 "post" : {
17923 "description" : "Creates a new temporaryUserToken.",
17924 "parameters" : [ {
17925 "$ref" : "#/components/parameters/IdempotencyKey"
17926 } ],
17927 "requestBody" : {
17928 "content" : {
17929 "application/vnd.api+json" : {
17930 "schema" : {
17931 "$ref" : "#/components/schemas/TemporaryUserTokensCreateOperation_Payload"
17932 }
17933 }
17934 }
17935 },
17936 "responses" : {
17937 "201" : {
17938 "content" : {
17939 "application/vnd.api+json" : {
17940 "schema" : {
17941 "$ref" : "#/components/schemas/TemporaryUserTokens_Create_Single_Resource_Data_Document"
17942 }
17943 }
17944 },
17945 "description" : "Successful response"
17946 },
17947 "400" : {
17948 "$ref" : "#/components/responses/Default400Response"
17949 },
17950 "404" : {
17951 "$ref" : "#/components/responses/Default404Response"
17952 },
17953 "405" : {
17954 "$ref" : "#/components/responses/Default405Response"
17955 },
17956 "406" : {
17957 "$ref" : "#/components/responses/Default406Response"
17958 },
17959 "409" : {
17960 "$ref" : "#/components/responses/Idempotency409Response"
17961 },
17962 "415" : {
17963 "$ref" : "#/components/responses/Default415Response"
17964 },
17965 "422" : {
17966 "$ref" : "#/components/responses/Idempotency422Response"
17967 },
17968 "429" : {
17969 "$ref" : "#/components/responses/Default429Response"
17970 },
17971 "500" : {
17972 "$ref" : "#/components/responses/Default500Response"
17973 },
17974 "503" : {
17975 "$ref" : "#/components/responses/Default503Response"
17976 }
17977 },
17978 "security" : [ {
17979 "Authorization_Code_PKCE" : [ "w_usr" ]
17980 } ],
17981 "summary" : "Create single temporaryUserToken.",
17982 "tags" : [ "temporaryUserTokens" ],
17983 "x-path-item-properties" : {
17984 "required-access-tier" : "INTERNAL"
17985 }
17986 }
17987 },
17988 "/temporaryUserTokens/{id}" : {
17989 "get" : {
17990 "description" : "Retrieves single temporaryUserToken by id.",
17991 "parameters" : [ {
17992 "description" : "Temporary user token id",
17993 "example" : "abc123",
17994 "in" : "path",
17995 "name" : "id",
17996 "required" : true,
17997 "schema" : {
17998 "type" : "string"
17999 }
18000 }, {
18001 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
18002 "example" : "owners",
18003 "in" : "query",
18004 "name" : "include",
18005 "required" : false,
18006 "schema" : {
18007 "type" : "array",
18008 "items" : {
18009 "type" : "string",
18010 "example" : "owners"
18011 }
18012 }
18013 } ],
18014 "responses" : {
18015 "200" : {
18016 "content" : {
18017 "application/vnd.api+json" : {
18018 "schema" : {
18019 "$ref" : "#/components/schemas/TemporaryUserTokens_Single_Resource_Data_Document"
18020 }
18021 }
18022 },
18023 "description" : "Successful response"
18024 },
18025 "400" : {
18026 "$ref" : "#/components/responses/Default400Response"
18027 },
18028 "404" : {
18029 "$ref" : "#/components/responses/Default404Response"
18030 },
18031 "405" : {
18032 "$ref" : "#/components/responses/Default405Response"
18033 },
18034 "406" : {
18035 "$ref" : "#/components/responses/Default406Response"
18036 },
18037 "415" : {
18038 "$ref" : "#/components/responses/Default415Response"
18039 },
18040 "429" : {
18041 "$ref" : "#/components/responses/Default429Response"
18042 },
18043 "500" : {
18044 "$ref" : "#/components/responses/Default500Response"
18045 },
18046 "503" : {
18047 "$ref" : "#/components/responses/Default503Response"
18048 }
18049 },
18050 "security" : [ {
18051 "Authorization_Code_PKCE" : [ "r_usr" ]
18052 } ],
18053 "summary" : "Get single temporaryUserToken.",
18054 "tags" : [ "temporaryUserTokens" ],
18055 "x-path-item-properties" : {
18056 "required-access-tier" : "INTERNAL"
18057 }
18058 }
18059 },
18060 "/temporaryUserTokens/{id}/relationships/owners" : {
18061 "get" : {
18062 "description" : "Retrieves owners relationship.",
18063 "parameters" : [ {
18064 "description" : "Temporary user token id",
18065 "example" : "abc123",
18066 "in" : "path",
18067 "name" : "id",
18068 "required" : true,
18069 "schema" : {
18070 "type" : "string"
18071 }
18072 }, {
18073 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
18074 "example" : "owners",
18075 "in" : "query",
18076 "name" : "include",
18077 "required" : false,
18078 "schema" : {
18079 "type" : "array",
18080 "items" : {
18081 "type" : "string",
18082 "example" : "owners"
18083 }
18084 }
18085 }, {
18086 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
18087 "in" : "query",
18088 "name" : "page[cursor]",
18089 "required" : false,
18090 "schema" : {
18091 "type" : "string"
18092 }
18093 } ],
18094 "responses" : {
18095 "200" : {
18096 "content" : {
18097 "application/vnd.api+json" : {
18098 "schema" : {
18099 "$ref" : "#/components/schemas/TemporaryUserTokens_Multi_Relationship_Data_Document"
18100 }
18101 }
18102 },
18103 "description" : "Successful response"
18104 },
18105 "400" : {
18106 "$ref" : "#/components/responses/Default400Response"
18107 },
18108 "404" : {
18109 "$ref" : "#/components/responses/Default404Response"
18110 },
18111 "405" : {
18112 "$ref" : "#/components/responses/Default405Response"
18113 },
18114 "406" : {
18115 "$ref" : "#/components/responses/Default406Response"
18116 },
18117 "415" : {
18118 "$ref" : "#/components/responses/Default415Response"
18119 },
18120 "429" : {
18121 "$ref" : "#/components/responses/Default429Response"
18122 },
18123 "500" : {
18124 "$ref" : "#/components/responses/Default500Response"
18125 },
18126 "503" : {
18127 "$ref" : "#/components/responses/Default503Response"
18128 }
18129 },
18130 "security" : [ {
18131 "Authorization_Code_PKCE" : [ "r_usr" ]
18132 } ],
18133 "summary" : "Get owners relationship (\"to-many\").",
18134 "tags" : [ "temporaryUserTokens" ],
18135 "x-path-item-properties" : {
18136 "required-access-tier" : "INTERNAL"
18137 }
18138 }
18139 },
18140 "/terms" : {
18141 "get" : {
18142 "description" : "Retrieves multiple terms by available filters, or without if applicable.",
18143 "parameters" : [ {
18144 "description" : "One of: DEVELOPER, UPLOAD_MARKETPLACE, MERCH_GUIDELINES (e.g. `DEVELOPER`)",
18145 "in" : "query",
18146 "name" : "filter[termsType]",
18147 "required" : true,
18148 "schema" : {
18149 "type" : "array",
18150 "items" : {
18151 "type" : "string",
18152 "enum" : [ "DEVELOPER", "UPLOAD_MARKETPLACE", "MERCH_GUIDELINES" ]
18153 }
18154 }
18155 }, {
18156 "description" : "Filter by countryCode",
18157 "in" : "query",
18158 "name" : "filter[countryCode]",
18159 "required" : false,
18160 "schema" : {
18161 "type" : "array",
18162 "items" : {
18163 "type" : "string"
18164 }
18165 }
18166 }, {
18167 "description" : "Filter by isLatestVersion",
18168 "in" : "query",
18169 "name" : "filter[isLatestVersion]",
18170 "required" : false,
18171 "schema" : {
18172 "type" : "array",
18173 "items" : {
18174 "type" : "string"
18175 }
18176 }
18177 } ],
18178 "responses" : {
18179 "200" : {
18180 "content" : {
18181 "application/vnd.api+json" : {
18182 "schema" : {
18183 "$ref" : "#/components/schemas/Terms_Multi_Resource_Data_Document"
18184 }
18185 }
18186 },
18187 "description" : "Successful response"
18188 },
18189 "400" : {
18190 "$ref" : "#/components/responses/Default400Response"
18191 },
18192 "404" : {
18193 "$ref" : "#/components/responses/Default404Response"
18194 },
18195 "405" : {
18196 "$ref" : "#/components/responses/Default405Response"
18197 },
18198 "406" : {
18199 "$ref" : "#/components/responses/Default406Response"
18200 },
18201 "415" : {
18202 "$ref" : "#/components/responses/Default415Response"
18203 },
18204 "429" : {
18205 "$ref" : "#/components/responses/Default429Response"
18206 },
18207 "500" : {
18208 "$ref" : "#/components/responses/Default500Response"
18209 },
18210 "503" : {
18211 "$ref" : "#/components/responses/Default503Response"
18212 }
18213 },
18214 "security" : [ {
18215 "Client_Credentials" : [ ]
18216 }, {
18217 "Authorization_Code_PKCE" : [ ]
18218 } ],
18219 "summary" : "Get multiple terms.",
18220 "tags" : [ "terms" ],
18221 "x-path-item-properties" : {
18222 "required-access-tier" : "INTERNAL"
18223 }
18224 }
18225 },
18226 "/terms/{id}" : {
18227 "get" : {
18228 "description" : "Retrieves single term by id.",
18229 "parameters" : [ {
18230 "description" : "Terms id",
18231 "example" : "a468bee88def",
18232 "in" : "path",
18233 "name" : "id",
18234 "required" : true,
18235 "schema" : {
18236 "type" : "string"
18237 }
18238 } ],
18239 "responses" : {
18240 "200" : {
18241 "content" : {
18242 "application/vnd.api+json" : {
18243 "schema" : {
18244 "$ref" : "#/components/schemas/Terms_Single_Resource_Data_Document"
18245 }
18246 }
18247 },
18248 "description" : "Successful response"
18249 },
18250 "400" : {
18251 "$ref" : "#/components/responses/Default400Response"
18252 },
18253 "404" : {
18254 "$ref" : "#/components/responses/Default404Response"
18255 },
18256 "405" : {
18257 "$ref" : "#/components/responses/Default405Response"
18258 },
18259 "406" : {
18260 "$ref" : "#/components/responses/Default406Response"
18261 },
18262 "415" : {
18263 "$ref" : "#/components/responses/Default415Response"
18264 },
18265 "429" : {
18266 "$ref" : "#/components/responses/Default429Response"
18267 },
18268 "500" : {
18269 "$ref" : "#/components/responses/Default500Response"
18270 },
18271 "503" : {
18272 "$ref" : "#/components/responses/Default503Response"
18273 }
18274 },
18275 "security" : [ {
18276 "Client_Credentials" : [ ]
18277 }, {
18278 "Authorization_Code_PKCE" : [ ]
18279 } ],
18280 "summary" : "Get single term.",
18281 "tags" : [ "terms" ],
18282 "x-path-item-properties" : {
18283 "required-access-tier" : "INTERNAL"
18284 }
18285 }
18286 },
18287 "/trackFiles/{id}" : {
18288 "get" : {
18289 "description" : "Retrieves single trackFile by id.",
18290 "parameters" : [ {
18291 "description" : "Track file id",
18292 "example" : "123456",
18293 "in" : "path",
18294 "name" : "id",
18295 "required" : true,
18296 "schema" : {
18297 "type" : "string"
18298 }
18299 }, {
18300 "in" : "query",
18301 "name" : "formats",
18302 "required" : true,
18303 "schema" : {
18304 "type" : "array",
18305 "items" : {
18306 "type" : "string",
18307 "enum" : [ "HEAACV1", "AACLC", "FLAC", "FLAC_HIRES", "EAC3_JOC" ]
18308 }
18309 }
18310 }, {
18311 "in" : "query",
18312 "name" : "usage",
18313 "required" : true,
18314 "schema" : {
18315 "type" : "string",
18316 "enum" : [ "PLAYBACK", "DOWNLOAD" ]
18317 }
18318 } ],
18319 "responses" : {
18320 "200" : {
18321 "content" : {
18322 "application/vnd.api+json" : {
18323 "schema" : {
18324 "$ref" : "#/components/schemas/TrackFiles_Single_Resource_Data_Document"
18325 }
18326 }
18327 },
18328 "description" : "Successful response"
18329 },
18330 "400" : {
18331 "$ref" : "#/components/responses/Default400Response"
18332 },
18333 "403" : {
18334 "$ref" : "#/components/responses/TrackFilesReadById403Response"
18335 },
18336 "404" : {
18337 "$ref" : "#/components/responses/TrackFilesReadById404Response"
18338 },
18339 "405" : {
18340 "$ref" : "#/components/responses/Default405Response"
18341 },
18342 "406" : {
18343 "$ref" : "#/components/responses/Default406Response"
18344 },
18345 "415" : {
18346 "$ref" : "#/components/responses/Default415Response"
18347 },
18348 "429" : {
18349 "$ref" : "#/components/responses/Default429Response"
18350 },
18351 "500" : {
18352 "$ref" : "#/components/responses/Default500Response"
18353 },
18354 "503" : {
18355 "$ref" : "#/components/responses/Default503Response"
18356 }
18357 },
18358 "security" : [ {
18359 "Client_Credentials" : [ ]
18360 }, {
18361 "Authorization_Code_PKCE" : [ "playback", "r_usr" ]
18362 } ],
18363 "summary" : "Get single trackFile.",
18364 "tags" : [ "trackFiles" ],
18365 "x-path-item-properties" : {
18366 "required-access-tier" : "PARTNER"
18367 }
18368 }
18369 },
18370 "/trackManifests/{id}" : {
18371 "get" : {
18372 "description" : "Retrieves single trackManifest by id.",
18373 "parameters" : [ {
18374 "description" : "Track manifest id",
18375 "example" : "123456",
18376 "in" : "path",
18377 "name" : "id",
18378 "required" : true,
18379 "schema" : {
18380 "type" : "string"
18381 }
18382 }, {
18383 "in" : "query",
18384 "name" : "manifestType",
18385 "required" : true,
18386 "schema" : {
18387 "type" : "string",
18388 "enum" : [ "HLS", "MPEG_DASH" ]
18389 }
18390 }, {
18391 "in" : "query",
18392 "name" : "formats",
18393 "required" : true,
18394 "schema" : {
18395 "type" : "array",
18396 "items" : {
18397 "type" : "string",
18398 "enum" : [ "HEAACV1", "AACLC", "FLAC", "FLAC_HIRES", "EAC3_JOC" ]
18399 }
18400 }
18401 }, {
18402 "in" : "query",
18403 "name" : "uriScheme",
18404 "required" : true,
18405 "schema" : {
18406 "type" : "string",
18407 "enum" : [ "HTTPS", "DATA" ]
18408 }
18409 }, {
18410 "in" : "query",
18411 "name" : "usage",
18412 "required" : true,
18413 "schema" : {
18414 "type" : "string",
18415 "enum" : [ "PLAYBACK", "DOWNLOAD" ]
18416 }
18417 }, {
18418 "in" : "query",
18419 "name" : "adaptive",
18420 "required" : true,
18421 "schema" : {
18422 "type" : "boolean"
18423 }
18424 }, {
18425 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
18426 "in" : "query",
18427 "name" : "shareCode",
18428 "required" : false,
18429 "schema" : {
18430 "type" : "string",
18431 "example" : "xyz"
18432 }
18433 } ],
18434 "responses" : {
18435 "200" : {
18436 "content" : {
18437 "application/vnd.api+json" : {
18438 "schema" : {
18439 "$ref" : "#/components/schemas/TrackManifests_Single_Resource_Data_Document"
18440 }
18441 }
18442 },
18443 "description" : "Successful response"
18444 },
18445 "400" : {
18446 "$ref" : "#/components/responses/Default400Response"
18447 },
18448 "403" : {
18449 "$ref" : "#/components/responses/TrackManifestsReadById403Response"
18450 },
18451 "404" : {
18452 "$ref" : "#/components/responses/TrackManifestsReadById404Response"
18453 },
18454 "405" : {
18455 "$ref" : "#/components/responses/Default405Response"
18456 },
18457 "406" : {
18458 "$ref" : "#/components/responses/Default406Response"
18459 },
18460 "415" : {
18461 "$ref" : "#/components/responses/Default415Response"
18462 },
18463 "429" : {
18464 "$ref" : "#/components/responses/Default429Response"
18465 },
18466 "500" : {
18467 "$ref" : "#/components/responses/Default500Response"
18468 },
18469 "503" : {
18470 "$ref" : "#/components/responses/Default503Response"
18471 }
18472 },
18473 "security" : [ {
18474 "Client_Credentials" : [ ]
18475 }, {
18476 "Authorization_Code_PKCE" : [ "playback", "r_usr" ]
18477 } ],
18478 "summary" : "Get single trackManifest.",
18479 "tags" : [ "trackManifests" ],
18480 "x-path-item-properties" : {
18481 "required-access-tier" : "THIRD_PARTY"
18482 }
18483 }
18484 },
18485 "/trackSourceFiles" : {
18486 "post" : {
18487 "description" : "Create a track source file. <p/>\nThe response contains a upload link that must be used to upload the actual content.<p/>\nThe headers in the upload link response must be sent doing the actual upload.\n",
18488 "parameters" : [ {
18489 "$ref" : "#/components/parameters/IdempotencyKey"
18490 } ],
18491 "requestBody" : {
18492 "content" : {
18493 "application/vnd.api+json" : {
18494 "schema" : {
18495 "$ref" : "#/components/schemas/TrackSourceFilesCreateOperation_Payload"
18496 }
18497 }
18498 }
18499 },
18500 "responses" : {
18501 "201" : {
18502 "content" : {
18503 "application/vnd.api+json" : {
18504 "schema" : {
18505 "$ref" : "#/components/schemas/TrackSourceFiles_Create_Single_Resource_Data_Document"
18506 }
18507 }
18508 },
18509 "description" : "Successful response"
18510 },
18511 "400" : {
18512 "$ref" : "#/components/responses/Default400Response"
18513 },
18514 "404" : {
18515 "$ref" : "#/components/responses/Default404Response"
18516 },
18517 "405" : {
18518 "$ref" : "#/components/responses/Default405Response"
18519 },
18520 "406" : {
18521 "$ref" : "#/components/responses/Default406Response"
18522 },
18523 "409" : {
18524 "$ref" : "#/components/responses/Idempotency409Response"
18525 },
18526 "415" : {
18527 "$ref" : "#/components/responses/Default415Response"
18528 },
18529 "422" : {
18530 "$ref" : "#/components/responses/Idempotency422Response"
18531 },
18532 "429" : {
18533 "$ref" : "#/components/responses/Default429Response"
18534 },
18535 "500" : {
18536 "$ref" : "#/components/responses/Default500Response"
18537 },
18538 "503" : {
18539 "$ref" : "#/components/responses/Default503Response"
18540 }
18541 },
18542 "security" : [ {
18543 "Authorization_Code_PKCE" : [ "w_usr" ]
18544 } ],
18545 "summary" : "Create single trackSourceFile.",
18546 "tags" : [ "trackSourceFiles" ],
18547 "x-path-item-properties" : {
18548 "required-access-tier" : "INTERNAL"
18549 }
18550 }
18551 },
18552 "/trackSourceFiles/{id}" : {
18553 "get" : {
18554 "description" : "Retrieves single trackSourceFile by id.",
18555 "parameters" : [ {
18556 "description" : "Track source file id",
18557 "example" : "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
18558 "in" : "path",
18559 "name" : "id",
18560 "required" : true,
18561 "schema" : {
18562 "type" : "string"
18563 }
18564 }, {
18565 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
18566 "example" : "owners",
18567 "in" : "query",
18568 "name" : "include",
18569 "required" : false,
18570 "schema" : {
18571 "type" : "array",
18572 "items" : {
18573 "type" : "string",
18574 "example" : "owners"
18575 }
18576 }
18577 } ],
18578 "responses" : {
18579 "200" : {
18580 "content" : {
18581 "application/vnd.api+json" : {
18582 "schema" : {
18583 "$ref" : "#/components/schemas/TrackSourceFiles_Single_Resource_Data_Document"
18584 }
18585 }
18586 },
18587 "description" : "Successful response"
18588 },
18589 "400" : {
18590 "$ref" : "#/components/responses/Default400Response"
18591 },
18592 "404" : {
18593 "$ref" : "#/components/responses/Default404Response"
18594 },
18595 "405" : {
18596 "$ref" : "#/components/responses/Default405Response"
18597 },
18598 "406" : {
18599 "$ref" : "#/components/responses/Default406Response"
18600 },
18601 "415" : {
18602 "$ref" : "#/components/responses/Default415Response"
18603 },
18604 "429" : {
18605 "$ref" : "#/components/responses/Default429Response"
18606 },
18607 "500" : {
18608 "$ref" : "#/components/responses/Default500Response"
18609 },
18610 "503" : {
18611 "$ref" : "#/components/responses/Default503Response"
18612 }
18613 },
18614 "security" : [ {
18615 "Authorization_Code_PKCE" : [ "r_usr" ]
18616 } ],
18617 "summary" : "Get single trackSourceFile.",
18618 "tags" : [ "trackSourceFiles" ],
18619 "x-path-item-properties" : {
18620 "required-access-tier" : "INTERNAL"
18621 }
18622 }
18623 },
18624 "/trackSourceFiles/{id}/relationships/owners" : {
18625 "get" : {
18626 "description" : "Retrieves owners relationship.",
18627 "parameters" : [ {
18628 "description" : "Track source file id",
18629 "example" : "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
18630 "in" : "path",
18631 "name" : "id",
18632 "required" : true,
18633 "schema" : {
18634 "type" : "string"
18635 }
18636 }, {
18637 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
18638 "example" : "owners",
18639 "in" : "query",
18640 "name" : "include",
18641 "required" : false,
18642 "schema" : {
18643 "type" : "array",
18644 "items" : {
18645 "type" : "string",
18646 "example" : "owners"
18647 }
18648 }
18649 }, {
18650 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
18651 "in" : "query",
18652 "name" : "page[cursor]",
18653 "required" : false,
18654 "schema" : {
18655 "type" : "string"
18656 }
18657 } ],
18658 "responses" : {
18659 "200" : {
18660 "content" : {
18661 "application/vnd.api+json" : {
18662 "schema" : {
18663 "$ref" : "#/components/schemas/TrackSourceFiles_Multi_Relationship_Data_Document"
18664 }
18665 }
18666 },
18667 "description" : "Successful response"
18668 },
18669 "400" : {
18670 "$ref" : "#/components/responses/Default400Response"
18671 },
18672 "404" : {
18673 "$ref" : "#/components/responses/Default404Response"
18674 },
18675 "405" : {
18676 "$ref" : "#/components/responses/Default405Response"
18677 },
18678 "406" : {
18679 "$ref" : "#/components/responses/Default406Response"
18680 },
18681 "415" : {
18682 "$ref" : "#/components/responses/Default415Response"
18683 },
18684 "429" : {
18685 "$ref" : "#/components/responses/Default429Response"
18686 },
18687 "500" : {
18688 "$ref" : "#/components/responses/Default500Response"
18689 },
18690 "503" : {
18691 "$ref" : "#/components/responses/Default503Response"
18692 }
18693 },
18694 "security" : [ {
18695 "Authorization_Code_PKCE" : [ "r_usr" ]
18696 } ],
18697 "summary" : "Get owners relationship (\"to-many\").",
18698 "tags" : [ "trackSourceFiles" ],
18699 "x-path-item-properties" : {
18700 "required-access-tier" : "INTERNAL"
18701 }
18702 }
18703 },
18704 "/trackStatistics/{id}" : {
18705 "get" : {
18706 "description" : "Retrieves single trackStatistic by id.",
18707 "parameters" : [ {
18708 "description" : "Track statistic id",
18709 "example" : "123456",
18710 "in" : "path",
18711 "name" : "id",
18712 "required" : true,
18713 "schema" : {
18714 "type" : "string"
18715 }
18716 }, {
18717 "description" : "ISO 3166-1 alpha-2 country code",
18718 "example" : "US",
18719 "in" : "query",
18720 "name" : "countryCode",
18721 "required" : false,
18722 "schema" : {
18723 "type" : "string"
18724 }
18725 }, {
18726 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
18727 "example" : "owners",
18728 "in" : "query",
18729 "name" : "include",
18730 "required" : false,
18731 "schema" : {
18732 "type" : "array",
18733 "items" : {
18734 "type" : "string",
18735 "example" : "owners"
18736 }
18737 }
18738 } ],
18739 "responses" : {
18740 "200" : {
18741 "content" : {
18742 "application/vnd.api+json" : {
18743 "schema" : {
18744 "$ref" : "#/components/schemas/TrackStatistics_Single_Resource_Data_Document"
18745 }
18746 }
18747 },
18748 "description" : "Successful response"
18749 },
18750 "400" : {
18751 "$ref" : "#/components/responses/Default400Response"
18752 },
18753 "404" : {
18754 "$ref" : "#/components/responses/Default404Response"
18755 },
18756 "405" : {
18757 "$ref" : "#/components/responses/Default405Response"
18758 },
18759 "406" : {
18760 "$ref" : "#/components/responses/Default406Response"
18761 },
18762 "415" : {
18763 "$ref" : "#/components/responses/Default415Response"
18764 },
18765 "429" : {
18766 "$ref" : "#/components/responses/Default429Response"
18767 },
18768 "500" : {
18769 "$ref" : "#/components/responses/Default500Response"
18770 },
18771 "503" : {
18772 "$ref" : "#/components/responses/Default503Response"
18773 }
18774 },
18775 "security" : [ {
18776 "Authorization_Code_PKCE" : [ "r_usr" ]
18777 } ],
18778 "summary" : "Get single trackStatistic.",
18779 "tags" : [ "trackStatistics" ],
18780 "x-path-item-properties" : {
18781 "required-access-tier" : "INTERNAL"
18782 }
18783 }
18784 },
18785 "/trackStatistics/{id}/relationships/owners" : {
18786 "get" : {
18787 "description" : "Retrieves owners relationship.",
18788 "parameters" : [ {
18789 "description" : "Track statistic id",
18790 "example" : "123456",
18791 "in" : "path",
18792 "name" : "id",
18793 "required" : true,
18794 "schema" : {
18795 "type" : "string"
18796 }
18797 }, {
18798 "description" : "ISO 3166-1 alpha-2 country code",
18799 "example" : "US",
18800 "in" : "query",
18801 "name" : "countryCode",
18802 "required" : false,
18803 "schema" : {
18804 "type" : "string"
18805 }
18806 }, {
18807 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
18808 "example" : "owners",
18809 "in" : "query",
18810 "name" : "include",
18811 "required" : false,
18812 "schema" : {
18813 "type" : "array",
18814 "items" : {
18815 "type" : "string",
18816 "example" : "owners"
18817 }
18818 }
18819 }, {
18820 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
18821 "in" : "query",
18822 "name" : "page[cursor]",
18823 "required" : false,
18824 "schema" : {
18825 "type" : "string"
18826 }
18827 } ],
18828 "responses" : {
18829 "200" : {
18830 "content" : {
18831 "application/vnd.api+json" : {
18832 "schema" : {
18833 "$ref" : "#/components/schemas/TrackStatistics_Multi_Relationship_Data_Document"
18834 }
18835 }
18836 },
18837 "description" : "Successful response"
18838 },
18839 "400" : {
18840 "$ref" : "#/components/responses/Default400Response"
18841 },
18842 "404" : {
18843 "$ref" : "#/components/responses/Default404Response"
18844 },
18845 "405" : {
18846 "$ref" : "#/components/responses/Default405Response"
18847 },
18848 "406" : {
18849 "$ref" : "#/components/responses/Default406Response"
18850 },
18851 "415" : {
18852 "$ref" : "#/components/responses/Default415Response"
18853 },
18854 "429" : {
18855 "$ref" : "#/components/responses/Default429Response"
18856 },
18857 "500" : {
18858 "$ref" : "#/components/responses/Default500Response"
18859 },
18860 "503" : {
18861 "$ref" : "#/components/responses/Default503Response"
18862 }
18863 },
18864 "security" : [ {
18865 "Authorization_Code_PKCE" : [ "r_usr" ]
18866 } ],
18867 "summary" : "Get owners relationship (\"to-many\").",
18868 "tags" : [ "trackStatistics" ],
18869 "x-path-item-properties" : {
18870 "required-access-tier" : "INTERNAL"
18871 }
18872 }
18873 },
18874 "/tracks" : {
18875 "get" : {
18876 "description" : "Retrieves multiple tracks by available filters, or without if applicable.",
18877 "parameters" : [ {
18878 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
18879 "in" : "query",
18880 "name" : "page[cursor]",
18881 "required" : false,
18882 "schema" : {
18883 "type" : "string"
18884 }
18885 }, {
18886 "description" : "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
18887 "in" : "query",
18888 "name" : "sort",
18889 "required" : false,
18890 "schema" : {
18891 "type" : "array",
18892 "items" : {
18893 "type" : "string",
18894 "example" : "createdAt",
18895 "default" : "-createdAt",
18896 "enum" : [ "createdAt", "-createdAt", "title", "-title" ],
18897 "x-enum-varnames" : [ "CreatedAtAsc", "CreatedAtDesc", "TitleAsc", "TitleDesc" ]
18898 }
18899 }
18900 }, {
18901 "description" : "ISO 3166-1 alpha-2 country code",
18902 "example" : "US",
18903 "in" : "query",
18904 "name" : "countryCode",
18905 "required" : false,
18906 "schema" : {
18907 "type" : "string"
18908 }
18909 }, {
18910 "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",
18911 "example" : "albums",
18912 "in" : "query",
18913 "name" : "include",
18914 "required" : false,
18915 "schema" : {
18916 "type" : "array",
18917 "items" : {
18918 "type" : "string",
18919 "example" : "albums"
18920 }
18921 }
18922 }, {
18923 "description" : "List of track IDs (e.g. `75413016`)",
18924 "in" : "query",
18925 "name" : "filter[id]",
18926 "required" : false,
18927 "schema" : {
18928 "type" : "array",
18929 "items" : {
18930 "type" : "string"
18931 }
18932 }
18933 }, {
18934 "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`)",
18935 "in" : "query",
18936 "name" : "filter[isrc]",
18937 "required" : false,
18938 "schema" : {
18939 "type" : "array",
18940 "items" : {
18941 "type" : "string"
18942 }
18943 }
18944 }, {
18945 "description" : "User id. Use `me` for the authenticated user",
18946 "in" : "query",
18947 "name" : "filter[owners.id]",
18948 "required" : false,
18949 "schema" : {
18950 "type" : "array",
18951 "items" : {
18952 "type" : "string"
18953 }
18954 }
18955 }, {
18956 "description" : "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",
18957 "example" : "albums",
18958 "in" : "query",
18959 "name" : "replaceMedia",
18960 "required" : false,
18961 "schema" : {
18962 "type" : "string",
18963 "example" : "albums"
18964 }
18965 }, {
18966 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
18967 "in" : "query",
18968 "name" : "shareCode",
18969 "required" : false,
18970 "schema" : {
18971 "type" : "string",
18972 "example" : "xyz"
18973 }
18974 } ],
18975 "responses" : {
18976 "200" : {
18977 "content" : {
18978 "application/vnd.api+json" : {
18979 "schema" : {
18980 "$ref" : "#/components/schemas/Tracks_Multi_Resource_Data_Document"
18981 }
18982 }
18983 },
18984 "description" : "Successful response"
18985 },
18986 "400" : {
18987 "$ref" : "#/components/responses/Default400Response"
18988 },
18989 "404" : {
18990 "$ref" : "#/components/responses/Default404Response"
18991 },
18992 "405" : {
18993 "$ref" : "#/components/responses/Default405Response"
18994 },
18995 "406" : {
18996 "$ref" : "#/components/responses/Default406Response"
18997 },
18998 "415" : {
18999 "$ref" : "#/components/responses/Default415Response"
19000 },
19001 "429" : {
19002 "$ref" : "#/components/responses/Default429Response"
19003 },
19004 "500" : {
19005 "$ref" : "#/components/responses/Default500Response"
19006 },
19007 "503" : {
19008 "$ref" : "#/components/responses/Default503Response"
19009 }
19010 },
19011 "security" : [ {
19012 "Client_Credentials" : [ ]
19013 }, {
19014 "Authorization_Code_PKCE" : [ "r_usr" ]
19015 } ],
19016 "summary" : "Get multiple tracks.",
19017 "tags" : [ "tracks" ],
19018 "x-path-item-properties" : {
19019 "required-access-tier" : "THIRD_PARTY"
19020 }
19021 },
19022 "post" : {
19023 "description" : "Creates a new track.",
19024 "parameters" : [ {
19025 "$ref" : "#/components/parameters/IdempotencyKey"
19026 } ],
19027 "requestBody" : {
19028 "content" : {
19029 "application/vnd.api+json" : {
19030 "schema" : {
19031 "$ref" : "#/components/schemas/TracksCreateOperation_Payload"
19032 }
19033 }
19034 }
19035 },
19036 "responses" : {
19037 "201" : {
19038 "content" : {
19039 "application/vnd.api+json" : {
19040 "schema" : {
19041 "$ref" : "#/components/schemas/Tracks_Create_Single_Resource_Data_Document"
19042 }
19043 }
19044 },
19045 "description" : "Successful response"
19046 },
19047 "400" : {
19048 "$ref" : "#/components/responses/Default400Response"
19049 },
19050 "404" : {
19051 "$ref" : "#/components/responses/Default404Response"
19052 },
19053 "405" : {
19054 "$ref" : "#/components/responses/Default405Response"
19055 },
19056 "406" : {
19057 "$ref" : "#/components/responses/Default406Response"
19058 },
19059 "409" : {
19060 "$ref" : "#/components/responses/Idempotency409Response"
19061 },
19062 "415" : {
19063 "$ref" : "#/components/responses/Default415Response"
19064 },
19065 "422" : {
19066 "$ref" : "#/components/responses/Idempotency422Response"
19067 },
19068 "429" : {
19069 "$ref" : "#/components/responses/Default429Response"
19070 },
19071 "500" : {
19072 "$ref" : "#/components/responses/Default500Response"
19073 },
19074 "503" : {
19075 "$ref" : "#/components/responses/Default503Response"
19076 }
19077 },
19078 "security" : [ {
19079 "Authorization_Code_PKCE" : [ "w_usr" ]
19080 } ],
19081 "summary" : "Create single track.",
19082 "tags" : [ "tracks" ],
19083 "x-path-item-properties" : {
19084 "required-access-tier" : "INTERNAL"
19085 }
19086 }
19087 },
19088 "/tracks/{id}" : {
19089 "delete" : {
19090 "description" : "Deletes existing track.",
19091 "parameters" : [ {
19092 "description" : "Track id",
19093 "example" : "75413016",
19094 "in" : "path",
19095 "name" : "id",
19096 "required" : true,
19097 "schema" : {
19098 "type" : "string"
19099 }
19100 }, {
19101 "$ref" : "#/components/parameters/IdempotencyKey"
19102 } ],
19103 "responses" : {
19104 "400" : {
19105 "$ref" : "#/components/responses/Default400Response"
19106 },
19107 "404" : {
19108 "$ref" : "#/components/responses/Default404Response"
19109 },
19110 "405" : {
19111 "$ref" : "#/components/responses/Default405Response"
19112 },
19113 "406" : {
19114 "$ref" : "#/components/responses/Default406Response"
19115 },
19116 "409" : {
19117 "$ref" : "#/components/responses/Idempotency409Response"
19118 },
19119 "415" : {
19120 "$ref" : "#/components/responses/Default415Response"
19121 },
19122 "422" : {
19123 "$ref" : "#/components/responses/Idempotency422Response"
19124 },
19125 "429" : {
19126 "$ref" : "#/components/responses/Default429Response"
19127 },
19128 "500" : {
19129 "$ref" : "#/components/responses/Default500Response"
19130 },
19131 "503" : {
19132 "$ref" : "#/components/responses/Default503Response"
19133 }
19134 },
19135 "security" : [ {
19136 "Authorization_Code_PKCE" : [ "w_usr" ]
19137 } ],
19138 "summary" : "Delete single track.",
19139 "tags" : [ "tracks" ],
19140 "x-path-item-properties" : {
19141 "required-access-tier" : "INTERNAL"
19142 }
19143 },
19144 "get" : {
19145 "description" : "Retrieves single track by id.",
19146 "parameters" : [ {
19147 "description" : "Track id",
19148 "example" : "75413016",
19149 "in" : "path",
19150 "name" : "id",
19151 "required" : true,
19152 "schema" : {
19153 "type" : "string"
19154 }
19155 }, {
19156 "description" : "ISO 3166-1 alpha-2 country code",
19157 "example" : "US",
19158 "in" : "query",
19159 "name" : "countryCode",
19160 "required" : false,
19161 "schema" : {
19162 "type" : "string"
19163 }
19164 }, {
19165 "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",
19166 "example" : "albums",
19167 "in" : "query",
19168 "name" : "include",
19169 "required" : false,
19170 "schema" : {
19171 "type" : "array",
19172 "items" : {
19173 "type" : "string",
19174 "example" : "albums"
19175 }
19176 }
19177 }, {
19178 "description" : "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",
19179 "example" : "albums",
19180 "in" : "query",
19181 "name" : "replaceMedia",
19182 "required" : false,
19183 "schema" : {
19184 "type" : "string",
19185 "example" : "albums"
19186 }
19187 }, {
19188 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
19189 "in" : "query",
19190 "name" : "shareCode",
19191 "required" : false,
19192 "schema" : {
19193 "type" : "string",
19194 "example" : "xyz"
19195 }
19196 } ],
19197 "responses" : {
19198 "200" : {
19199 "content" : {
19200 "application/vnd.api+json" : {
19201 "schema" : {
19202 "$ref" : "#/components/schemas/Tracks_Single_Resource_Data_Document"
19203 }
19204 }
19205 },
19206 "description" : "Successful response"
19207 },
19208 "400" : {
19209 "$ref" : "#/components/responses/Default400Response"
19210 },
19211 "404" : {
19212 "$ref" : "#/components/responses/Default404Response"
19213 },
19214 "405" : {
19215 "$ref" : "#/components/responses/Default405Response"
19216 },
19217 "406" : {
19218 "$ref" : "#/components/responses/Default406Response"
19219 },
19220 "415" : {
19221 "$ref" : "#/components/responses/Default415Response"
19222 },
19223 "429" : {
19224 "$ref" : "#/components/responses/Default429Response"
19225 },
19226 "500" : {
19227 "$ref" : "#/components/responses/Default500Response"
19228 },
19229 "503" : {
19230 "$ref" : "#/components/responses/Default503Response"
19231 }
19232 },
19233 "security" : [ {
19234 "Client_Credentials" : [ ]
19235 }, {
19236 "Authorization_Code_PKCE" : [ ]
19237 } ],
19238 "summary" : "Get single track.",
19239 "tags" : [ "tracks" ],
19240 "x-path-item-properties" : {
19241 "required-access-tier" : "THIRD_PARTY"
19242 }
19243 },
19244 "patch" : {
19245 "description" : "Updates existing track.",
19246 "parameters" : [ {
19247 "description" : "Track id",
19248 "example" : "75413016",
19249 "in" : "path",
19250 "name" : "id",
19251 "required" : true,
19252 "schema" : {
19253 "type" : "string"
19254 }
19255 }, {
19256 "$ref" : "#/components/parameters/IdempotencyKey"
19257 } ],
19258 "requestBody" : {
19259 "content" : {
19260 "application/vnd.api+json" : {
19261 "schema" : {
19262 "$ref" : "#/components/schemas/TracksUpdateOperation_Payload"
19263 }
19264 }
19265 }
19266 },
19267 "responses" : {
19268 "400" : {
19269 "$ref" : "#/components/responses/Default400Response"
19270 },
19271 "404" : {
19272 "$ref" : "#/components/responses/Default404Response"
19273 },
19274 "405" : {
19275 "$ref" : "#/components/responses/Default405Response"
19276 },
19277 "406" : {
19278 "$ref" : "#/components/responses/Default406Response"
19279 },
19280 "409" : {
19281 "$ref" : "#/components/responses/Idempotency409Response"
19282 },
19283 "415" : {
19284 "$ref" : "#/components/responses/Default415Response"
19285 },
19286 "422" : {
19287 "$ref" : "#/components/responses/Idempotency422Response"
19288 },
19289 "429" : {
19290 "$ref" : "#/components/responses/Default429Response"
19291 },
19292 "500" : {
19293 "$ref" : "#/components/responses/Default500Response"
19294 },
19295 "503" : {
19296 "$ref" : "#/components/responses/Default503Response"
19297 }
19298 },
19299 "security" : [ {
19300 "Authorization_Code_PKCE" : [ "w_usr" ]
19301 } ],
19302 "summary" : "Update single track.",
19303 "tags" : [ "tracks" ],
19304 "x-path-item-properties" : {
19305 "required-access-tier" : "INTERNAL"
19306 }
19307 }
19308 },
19309 "/tracks/{id}/relationships/albums" : {
19310 "get" : {
19311 "description" : "Retrieves albums relationship.",
19312 "parameters" : [ {
19313 "description" : "Track id",
19314 "example" : "75413016",
19315 "in" : "path",
19316 "name" : "id",
19317 "required" : true,
19318 "schema" : {
19319 "type" : "string"
19320 }
19321 }, {
19322 "description" : "ISO 3166-1 alpha-2 country code",
19323 "example" : "US",
19324 "in" : "query",
19325 "name" : "countryCode",
19326 "required" : false,
19327 "schema" : {
19328 "type" : "string"
19329 }
19330 }, {
19331 "description" : "Allows the client to customize which related resources should be returned. Available options: albums",
19332 "example" : "albums",
19333 "in" : "query",
19334 "name" : "include",
19335 "required" : false,
19336 "schema" : {
19337 "type" : "array",
19338 "items" : {
19339 "type" : "string",
19340 "example" : "albums"
19341 }
19342 }
19343 }, {
19344 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
19345 "in" : "query",
19346 "name" : "page[cursor]",
19347 "required" : false,
19348 "schema" : {
19349 "type" : "string"
19350 }
19351 }, {
19352 "description" : "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",
19353 "example" : "albums",
19354 "in" : "query",
19355 "name" : "replaceMedia",
19356 "required" : false,
19357 "schema" : {
19358 "type" : "string",
19359 "example" : "albums"
19360 }
19361 }, {
19362 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
19363 "in" : "query",
19364 "name" : "shareCode",
19365 "required" : false,
19366 "schema" : {
19367 "type" : "string",
19368 "example" : "xyz"
19369 }
19370 } ],
19371 "responses" : {
19372 "200" : {
19373 "content" : {
19374 "application/vnd.api+json" : {
19375 "schema" : {
19376 "$ref" : "#/components/schemas/Tracks_Multi_Relationship_Data_Document"
19377 }
19378 }
19379 },
19380 "description" : "Successful response"
19381 },
19382 "400" : {
19383 "$ref" : "#/components/responses/Default400Response"
19384 },
19385 "404" : {
19386 "$ref" : "#/components/responses/Default404Response"
19387 },
19388 "405" : {
19389 "$ref" : "#/components/responses/Default405Response"
19390 },
19391 "406" : {
19392 "$ref" : "#/components/responses/Default406Response"
19393 },
19394 "415" : {
19395 "$ref" : "#/components/responses/Default415Response"
19396 },
19397 "429" : {
19398 "$ref" : "#/components/responses/Default429Response"
19399 },
19400 "500" : {
19401 "$ref" : "#/components/responses/Default500Response"
19402 },
19403 "503" : {
19404 "$ref" : "#/components/responses/Default503Response"
19405 }
19406 },
19407 "security" : [ {
19408 "Client_Credentials" : [ ]
19409 }, {
19410 "Authorization_Code_PKCE" : [ ]
19411 } ],
19412 "summary" : "Get albums relationship (\"to-many\").",
19413 "tags" : [ "tracks" ],
19414 "x-path-item-properties" : {
19415 "required-access-tier" : "THIRD_PARTY"
19416 }
19417 },
19418 "patch" : {
19419 "description" : "Updates albums relationship.",
19420 "parameters" : [ {
19421 "description" : "Track id",
19422 "example" : "75413016",
19423 "in" : "path",
19424 "name" : "id",
19425 "required" : true,
19426 "schema" : {
19427 "type" : "string"
19428 }
19429 }, {
19430 "$ref" : "#/components/parameters/IdempotencyKey"
19431 } ],
19432 "requestBody" : {
19433 "content" : {
19434 "application/vnd.api+json" : {
19435 "schema" : {
19436 "$ref" : "#/components/schemas/TracksAlbumsRelationshipUpdateOperation_Payload"
19437 }
19438 }
19439 }
19440 },
19441 "responses" : {
19442 "400" : {
19443 "$ref" : "#/components/responses/Default400Response"
19444 },
19445 "404" : {
19446 "$ref" : "#/components/responses/Default404Response"
19447 },
19448 "405" : {
19449 "$ref" : "#/components/responses/Default405Response"
19450 },
19451 "406" : {
19452 "$ref" : "#/components/responses/Default406Response"
19453 },
19454 "409" : {
19455 "$ref" : "#/components/responses/Idempotency409Response"
19456 },
19457 "415" : {
19458 "$ref" : "#/components/responses/Default415Response"
19459 },
19460 "422" : {
19461 "$ref" : "#/components/responses/Idempotency422Response"
19462 },
19463 "429" : {
19464 "$ref" : "#/components/responses/Default429Response"
19465 },
19466 "500" : {
19467 "$ref" : "#/components/responses/Default500Response"
19468 },
19469 "503" : {
19470 "$ref" : "#/components/responses/Default503Response"
19471 }
19472 },
19473 "security" : [ {
19474 "Authorization_Code_PKCE" : [ "w_usr" ]
19475 } ],
19476 "summary" : "Update albums relationship (\"to-many\").",
19477 "tags" : [ "tracks" ],
19478 "x-path-item-properties" : {
19479 "required-access-tier" : "INTERNAL"
19480 }
19481 }
19482 },
19483 "/tracks/{id}/relationships/artists" : {
19484 "get" : {
19485 "description" : "Retrieves artists relationship.",
19486 "parameters" : [ {
19487 "description" : "Track id",
19488 "example" : "75413016",
19489 "in" : "path",
19490 "name" : "id",
19491 "required" : true,
19492 "schema" : {
19493 "type" : "string"
19494 }
19495 }, {
19496 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
19497 "in" : "query",
19498 "name" : "page[cursor]",
19499 "required" : false,
19500 "schema" : {
19501 "type" : "string"
19502 }
19503 }, {
19504 "description" : "ISO 3166-1 alpha-2 country code",
19505 "example" : "US",
19506 "in" : "query",
19507 "name" : "countryCode",
19508 "required" : false,
19509 "schema" : {
19510 "type" : "string"
19511 }
19512 }, {
19513 "description" : "Allows the client to customize which related resources should be returned. Available options: artists",
19514 "example" : "artists.albums",
19515 "in" : "query",
19516 "name" : "include",
19517 "required" : false,
19518 "schema" : {
19519 "type" : "array",
19520 "items" : {
19521 "type" : "string",
19522 "example" : "artists.albums"
19523 }
19524 }
19525 }, {
19526 "description" : "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",
19527 "example" : "artists.albums",
19528 "in" : "query",
19529 "name" : "replaceMedia",
19530 "required" : false,
19531 "schema" : {
19532 "type" : "string",
19533 "example" : "artists.albums"
19534 }
19535 }, {
19536 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
19537 "in" : "query",
19538 "name" : "shareCode",
19539 "required" : false,
19540 "schema" : {
19541 "type" : "string",
19542 "example" : "xyz"
19543 }
19544 } ],
19545 "responses" : {
19546 "200" : {
19547 "content" : {
19548 "application/vnd.api+json" : {
19549 "schema" : {
19550 "$ref" : "#/components/schemas/Tracks_Multi_Relationship_Data_Document"
19551 }
19552 }
19553 },
19554 "description" : "Successful response"
19555 },
19556 "400" : {
19557 "$ref" : "#/components/responses/Default400Response"
19558 },
19559 "404" : {
19560 "$ref" : "#/components/responses/Default404Response"
19561 },
19562 "405" : {
19563 "$ref" : "#/components/responses/Default405Response"
19564 },
19565 "406" : {
19566 "$ref" : "#/components/responses/Default406Response"
19567 },
19568 "415" : {
19569 "$ref" : "#/components/responses/Default415Response"
19570 },
19571 "429" : {
19572 "$ref" : "#/components/responses/Default429Response"
19573 },
19574 "500" : {
19575 "$ref" : "#/components/responses/Default500Response"
19576 },
19577 "503" : {
19578 "$ref" : "#/components/responses/Default503Response"
19579 }
19580 },
19581 "security" : [ {
19582 "Client_Credentials" : [ ]
19583 }, {
19584 "Authorization_Code_PKCE" : [ ]
19585 } ],
19586 "summary" : "Get artists relationship (\"to-many\").",
19587 "tags" : [ "tracks" ],
19588 "x-path-item-properties" : {
19589 "required-access-tier" : "THIRD_PARTY"
19590 }
19591 }
19592 },
19593 "/tracks/{id}/relationships/credits" : {
19594 "get" : {
19595 "description" : "Retrieves credits relationship.",
19596 "parameters" : [ {
19597 "description" : "Track id",
19598 "example" : "75413016",
19599 "in" : "path",
19600 "name" : "id",
19601 "required" : true,
19602 "schema" : {
19603 "type" : "string"
19604 }
19605 }, {
19606 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
19607 "in" : "query",
19608 "name" : "page[cursor]",
19609 "required" : false,
19610 "schema" : {
19611 "type" : "string"
19612 }
19613 }, {
19614 "description" : "Allows the client to customize which related resources should be returned. Available options: credits",
19615 "example" : "credits.artist.albums",
19616 "in" : "query",
19617 "name" : "include",
19618 "required" : false,
19619 "schema" : {
19620 "type" : "array",
19621 "items" : {
19622 "type" : "string",
19623 "example" : "credits.artist.albums"
19624 }
19625 }
19626 }, {
19627 "description" : "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",
19628 "example" : "credits.artist.albums",
19629 "in" : "query",
19630 "name" : "replaceMedia",
19631 "required" : false,
19632 "schema" : {
19633 "type" : "string",
19634 "example" : "credits.artist.albums"
19635 }
19636 }, {
19637 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
19638 "in" : "query",
19639 "name" : "shareCode",
19640 "required" : false,
19641 "schema" : {
19642 "type" : "string",
19643 "example" : "xyz"
19644 }
19645 } ],
19646 "responses" : {
19647 "200" : {
19648 "content" : {
19649 "application/vnd.api+json" : {
19650 "schema" : {
19651 "$ref" : "#/components/schemas/Tracks_Multi_Relationship_Data_Document"
19652 }
19653 }
19654 },
19655 "description" : "Successful response"
19656 },
19657 "400" : {
19658 "$ref" : "#/components/responses/Default400Response"
19659 },
19660 "404" : {
19661 "$ref" : "#/components/responses/Default404Response"
19662 },
19663 "405" : {
19664 "$ref" : "#/components/responses/Default405Response"
19665 },
19666 "406" : {
19667 "$ref" : "#/components/responses/Default406Response"
19668 },
19669 "415" : {
19670 "$ref" : "#/components/responses/Default415Response"
19671 },
19672 "429" : {
19673 "$ref" : "#/components/responses/Default429Response"
19674 },
19675 "500" : {
19676 "$ref" : "#/components/responses/Default500Response"
19677 },
19678 "503" : {
19679 "$ref" : "#/components/responses/Default503Response"
19680 }
19681 },
19682 "security" : [ {
19683 "Client_Credentials" : [ ]
19684 }, {
19685 "Authorization_Code_PKCE" : [ ]
19686 } ],
19687 "summary" : "Get credits relationship (\"to-many\").",
19688 "tags" : [ "tracks" ],
19689 "x-path-item-properties" : {
19690 "required-access-tier" : "INTERNAL"
19691 }
19692 }
19693 },
19694 "/tracks/{id}/relationships/download" : {
19695 "get" : {
19696 "description" : "Retrieves download relationship.",
19697 "parameters" : [ {
19698 "description" : "Track id",
19699 "example" : "75413016",
19700 "in" : "path",
19701 "name" : "id",
19702 "required" : true,
19703 "schema" : {
19704 "type" : "string"
19705 }
19706 }, {
19707 "description" : "Allows the client to customize which related resources should be returned. Available options: download",
19708 "example" : "download",
19709 "in" : "query",
19710 "name" : "include",
19711 "required" : false,
19712 "schema" : {
19713 "type" : "array",
19714 "items" : {
19715 "type" : "string",
19716 "example" : "download"
19717 }
19718 }
19719 }, {
19720 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
19721 "in" : "query",
19722 "name" : "shareCode",
19723 "required" : false,
19724 "schema" : {
19725 "type" : "string",
19726 "example" : "xyz"
19727 }
19728 } ],
19729 "responses" : {
19730 "200" : {
19731 "content" : {
19732 "application/vnd.api+json" : {
19733 "schema" : {
19734 "$ref" : "#/components/schemas/Tracks_Single_Relationship_Data_Document"
19735 }
19736 }
19737 },
19738 "description" : "Successful response"
19739 },
19740 "400" : {
19741 "$ref" : "#/components/responses/Default400Response"
19742 },
19743 "404" : {
19744 "$ref" : "#/components/responses/Default404Response"
19745 },
19746 "405" : {
19747 "$ref" : "#/components/responses/Default405Response"
19748 },
19749 "406" : {
19750 "$ref" : "#/components/responses/Default406Response"
19751 },
19752 "415" : {
19753 "$ref" : "#/components/responses/Default415Response"
19754 },
19755 "429" : {
19756 "$ref" : "#/components/responses/Default429Response"
19757 },
19758 "500" : {
19759 "$ref" : "#/components/responses/Default500Response"
19760 },
19761 "503" : {
19762 "$ref" : "#/components/responses/Default503Response"
19763 }
19764 },
19765 "security" : [ {
19766 "Authorization_Code_PKCE" : [ ]
19767 } ],
19768 "summary" : "Get download relationship (\"to-one\").",
19769 "tags" : [ "tracks" ],
19770 "x-path-item-properties" : {
19771 "required-access-tier" : "INTERNAL"
19772 }
19773 }
19774 },
19775 "/tracks/{id}/relationships/genres" : {
19776 "get" : {
19777 "description" : "Retrieves genres relationship.",
19778 "parameters" : [ {
19779 "description" : "Track id",
19780 "example" : "75413016",
19781 "in" : "path",
19782 "name" : "id",
19783 "required" : true,
19784 "schema" : {
19785 "type" : "string"
19786 }
19787 }, {
19788 "description" : "ISO 3166-1 alpha-2 country code",
19789 "example" : "US",
19790 "in" : "query",
19791 "name" : "countryCode",
19792 "required" : false,
19793 "schema" : {
19794 "type" : "string"
19795 }
19796 }, {
19797 "description" : "Allows the client to customize which related resources should be returned. Available options: genres",
19798 "example" : "genres",
19799 "in" : "query",
19800 "name" : "include",
19801 "required" : false,
19802 "schema" : {
19803 "type" : "array",
19804 "items" : {
19805 "type" : "string",
19806 "example" : "genres"
19807 }
19808 }
19809 }, {
19810 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
19811 "in" : "query",
19812 "name" : "page[cursor]",
19813 "required" : false,
19814 "schema" : {
19815 "type" : "string"
19816 }
19817 }, {
19818 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
19819 "in" : "query",
19820 "name" : "shareCode",
19821 "required" : false,
19822 "schema" : {
19823 "type" : "string",
19824 "example" : "xyz"
19825 }
19826 } ],
19827 "responses" : {
19828 "200" : {
19829 "content" : {
19830 "application/vnd.api+json" : {
19831 "schema" : {
19832 "$ref" : "#/components/schemas/Tracks_Multi_Relationship_Data_Document"
19833 }
19834 }
19835 },
19836 "description" : "Successful response"
19837 },
19838 "400" : {
19839 "$ref" : "#/components/responses/Default400Response"
19840 },
19841 "404" : {
19842 "$ref" : "#/components/responses/Default404Response"
19843 },
19844 "405" : {
19845 "$ref" : "#/components/responses/Default405Response"
19846 },
19847 "406" : {
19848 "$ref" : "#/components/responses/Default406Response"
19849 },
19850 "415" : {
19851 "$ref" : "#/components/responses/Default415Response"
19852 },
19853 "429" : {
19854 "$ref" : "#/components/responses/Default429Response"
19855 },
19856 "500" : {
19857 "$ref" : "#/components/responses/Default500Response"
19858 },
19859 "503" : {
19860 "$ref" : "#/components/responses/Default503Response"
19861 }
19862 },
19863 "security" : [ {
19864 "Client_Credentials" : [ ]
19865 }, {
19866 "Authorization_Code_PKCE" : [ ]
19867 } ],
19868 "summary" : "Get genres relationship (\"to-many\").",
19869 "tags" : [ "tracks" ],
19870 "x-path-item-properties" : {
19871 "required-access-tier" : "INTERNAL"
19872 }
19873 }
19874 },
19875 "/tracks/{id}/relationships/lyrics" : {
19876 "get" : {
19877 "description" : "Retrieves lyrics relationship.",
19878 "parameters" : [ {
19879 "description" : "Track id",
19880 "example" : "75413016",
19881 "in" : "path",
19882 "name" : "id",
19883 "required" : true,
19884 "schema" : {
19885 "type" : "string"
19886 }
19887 }, {
19888 "description" : "Allows the client to customize which related resources should be returned. Available options: lyrics",
19889 "example" : "lyrics.track",
19890 "in" : "query",
19891 "name" : "include",
19892 "required" : false,
19893 "schema" : {
19894 "type" : "array",
19895 "items" : {
19896 "type" : "string",
19897 "example" : "lyrics.track"
19898 }
19899 }
19900 }, {
19901 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
19902 "in" : "query",
19903 "name" : "page[cursor]",
19904 "required" : false,
19905 "schema" : {
19906 "type" : "string"
19907 }
19908 }, {
19909 "description" : "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",
19910 "example" : "lyrics.track",
19911 "in" : "query",
19912 "name" : "replaceMedia",
19913 "required" : false,
19914 "schema" : {
19915 "type" : "string",
19916 "example" : "lyrics.track"
19917 }
19918 }, {
19919 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
19920 "in" : "query",
19921 "name" : "shareCode",
19922 "required" : false,
19923 "schema" : {
19924 "type" : "string",
19925 "example" : "xyz"
19926 }
19927 } ],
19928 "responses" : {
19929 "200" : {
19930 "content" : {
19931 "application/vnd.api+json" : {
19932 "schema" : {
19933 "$ref" : "#/components/schemas/Tracks_Multi_Relationship_Data_Document"
19934 }
19935 }
19936 },
19937 "description" : "Successful response"
19938 },
19939 "400" : {
19940 "$ref" : "#/components/responses/Default400Response"
19941 },
19942 "404" : {
19943 "$ref" : "#/components/responses/Default404Response"
19944 },
19945 "405" : {
19946 "$ref" : "#/components/responses/Default405Response"
19947 },
19948 "406" : {
19949 "$ref" : "#/components/responses/Default406Response"
19950 },
19951 "415" : {
19952 "$ref" : "#/components/responses/Default415Response"
19953 },
19954 "429" : {
19955 "$ref" : "#/components/responses/Default429Response"
19956 },
19957 "500" : {
19958 "$ref" : "#/components/responses/Default500Response"
19959 },
19960 "503" : {
19961 "$ref" : "#/components/responses/Default503Response"
19962 }
19963 },
19964 "security" : [ {
19965 "Client_Credentials" : [ ]
19966 }, {
19967 "Authorization_Code_PKCE" : [ ]
19968 } ],
19969 "summary" : "Get lyrics relationship (\"to-many\").",
19970 "tags" : [ "tracks" ],
19971 "x-path-item-properties" : {
19972 "required-access-tier" : "INTERNAL"
19973 }
19974 }
19975 },
19976 "/tracks/{id}/relationships/metadataStatus" : {
19977 "get" : {
19978 "description" : "Retrieves metadataStatus relationship.",
19979 "parameters" : [ {
19980 "description" : "Track id",
19981 "example" : "75413016",
19982 "in" : "path",
19983 "name" : "id",
19984 "required" : true,
19985 "schema" : {
19986 "type" : "string"
19987 }
19988 }, {
19989 "description" : "Allows the client to customize which related resources should be returned. Available options: metadataStatus",
19990 "example" : "metadataStatus",
19991 "in" : "query",
19992 "name" : "include",
19993 "required" : false,
19994 "schema" : {
19995 "type" : "array",
19996 "items" : {
19997 "type" : "string",
19998 "example" : "metadataStatus"
19999 }
20000 }
20001 }, {
20002 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
20003 "in" : "query",
20004 "name" : "shareCode",
20005 "required" : false,
20006 "schema" : {
20007 "type" : "string",
20008 "example" : "xyz"
20009 }
20010 } ],
20011 "responses" : {
20012 "200" : {
20013 "content" : {
20014 "application/vnd.api+json" : {
20015 "schema" : {
20016 "$ref" : "#/components/schemas/Tracks_Single_Relationship_Data_Document"
20017 }
20018 }
20019 },
20020 "description" : "Successful response"
20021 },
20022 "400" : {
20023 "$ref" : "#/components/responses/Default400Response"
20024 },
20025 "404" : {
20026 "$ref" : "#/components/responses/Default404Response"
20027 },
20028 "405" : {
20029 "$ref" : "#/components/responses/Default405Response"
20030 },
20031 "406" : {
20032 "$ref" : "#/components/responses/Default406Response"
20033 },
20034 "415" : {
20035 "$ref" : "#/components/responses/Default415Response"
20036 },
20037 "429" : {
20038 "$ref" : "#/components/responses/Default429Response"
20039 },
20040 "500" : {
20041 "$ref" : "#/components/responses/Default500Response"
20042 },
20043 "503" : {
20044 "$ref" : "#/components/responses/Default503Response"
20045 }
20046 },
20047 "security" : [ {
20048 "Authorization_Code_PKCE" : [ ]
20049 } ],
20050 "summary" : "Get metadataStatus relationship (\"to-one\").",
20051 "tags" : [ "tracks" ],
20052 "x-path-item-properties" : {
20053 "required-access-tier" : "INTERNAL"
20054 }
20055 }
20056 },
20057 "/tracks/{id}/relationships/owners" : {
20058 "get" : {
20059 "description" : "Retrieves owners relationship.",
20060 "parameters" : [ {
20061 "description" : "Track id",
20062 "example" : "75413016",
20063 "in" : "path",
20064 "name" : "id",
20065 "required" : true,
20066 "schema" : {
20067 "type" : "string"
20068 }
20069 }, {
20070 "description" : "ISO 3166-1 alpha-2 country code",
20071 "example" : "US",
20072 "in" : "query",
20073 "name" : "countryCode",
20074 "required" : false,
20075 "schema" : {
20076 "type" : "string"
20077 }
20078 }, {
20079 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
20080 "example" : "owners",
20081 "in" : "query",
20082 "name" : "include",
20083 "required" : false,
20084 "schema" : {
20085 "type" : "array",
20086 "items" : {
20087 "type" : "string",
20088 "example" : "owners"
20089 }
20090 }
20091 }, {
20092 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
20093 "in" : "query",
20094 "name" : "page[cursor]",
20095 "required" : false,
20096 "schema" : {
20097 "type" : "string"
20098 }
20099 }, {
20100 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
20101 "in" : "query",
20102 "name" : "shareCode",
20103 "required" : false,
20104 "schema" : {
20105 "type" : "string",
20106 "example" : "xyz"
20107 }
20108 } ],
20109 "responses" : {
20110 "200" : {
20111 "content" : {
20112 "application/vnd.api+json" : {
20113 "schema" : {
20114 "$ref" : "#/components/schemas/Tracks_Multi_Relationship_Data_Document"
20115 }
20116 }
20117 },
20118 "description" : "Successful response"
20119 },
20120 "400" : {
20121 "$ref" : "#/components/responses/Default400Response"
20122 },
20123 "404" : {
20124 "$ref" : "#/components/responses/Default404Response"
20125 },
20126 "405" : {
20127 "$ref" : "#/components/responses/Default405Response"
20128 },
20129 "406" : {
20130 "$ref" : "#/components/responses/Default406Response"
20131 },
20132 "415" : {
20133 "$ref" : "#/components/responses/Default415Response"
20134 },
20135 "429" : {
20136 "$ref" : "#/components/responses/Default429Response"
20137 },
20138 "500" : {
20139 "$ref" : "#/components/responses/Default500Response"
20140 },
20141 "503" : {
20142 "$ref" : "#/components/responses/Default503Response"
20143 }
20144 },
20145 "security" : [ {
20146 "Client_Credentials" : [ ]
20147 }, {
20148 "Authorization_Code_PKCE" : [ ]
20149 } ],
20150 "summary" : "Get owners relationship (\"to-many\").",
20151 "tags" : [ "tracks" ],
20152 "x-path-item-properties" : {
20153 "required-access-tier" : "THIRD_PARTY"
20154 }
20155 }
20156 },
20157 "/tracks/{id}/relationships/priceConfig" : {
20158 "get" : {
20159 "description" : "Retrieves priceConfig relationship.",
20160 "parameters" : [ {
20161 "description" : "Track id",
20162 "example" : "75413016",
20163 "in" : "path",
20164 "name" : "id",
20165 "required" : true,
20166 "schema" : {
20167 "type" : "string"
20168 }
20169 }, {
20170 "description" : "ISO 3166-1 alpha-2 country code",
20171 "example" : "US",
20172 "in" : "query",
20173 "name" : "countryCode",
20174 "required" : false,
20175 "schema" : {
20176 "type" : "string"
20177 }
20178 }, {
20179 "description" : "Allows the client to customize which related resources should be returned. Available options: priceConfig",
20180 "example" : "priceConfig",
20181 "in" : "query",
20182 "name" : "include",
20183 "required" : false,
20184 "schema" : {
20185 "type" : "array",
20186 "items" : {
20187 "type" : "string",
20188 "example" : "priceConfig"
20189 }
20190 }
20191 }, {
20192 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
20193 "in" : "query",
20194 "name" : "shareCode",
20195 "required" : false,
20196 "schema" : {
20197 "type" : "string",
20198 "example" : "xyz"
20199 }
20200 } ],
20201 "responses" : {
20202 "200" : {
20203 "content" : {
20204 "application/vnd.api+json" : {
20205 "schema" : {
20206 "$ref" : "#/components/schemas/Tracks_Single_Relationship_Data_Document"
20207 }
20208 }
20209 },
20210 "description" : "Successful response"
20211 },
20212 "400" : {
20213 "$ref" : "#/components/responses/Default400Response"
20214 },
20215 "404" : {
20216 "$ref" : "#/components/responses/Default404Response"
20217 },
20218 "405" : {
20219 "$ref" : "#/components/responses/Default405Response"
20220 },
20221 "406" : {
20222 "$ref" : "#/components/responses/Default406Response"
20223 },
20224 "415" : {
20225 "$ref" : "#/components/responses/Default415Response"
20226 },
20227 "429" : {
20228 "$ref" : "#/components/responses/Default429Response"
20229 },
20230 "500" : {
20231 "$ref" : "#/components/responses/Default500Response"
20232 },
20233 "503" : {
20234 "$ref" : "#/components/responses/Default503Response"
20235 }
20236 },
20237 "security" : [ {
20238 "Client_Credentials" : [ ]
20239 }, {
20240 "Authorization_Code_PKCE" : [ ]
20241 } ],
20242 "summary" : "Get priceConfig relationship (\"to-one\").",
20243 "tags" : [ "tracks" ],
20244 "x-path-item-properties" : {
20245 "required-access-tier" : "INTERNAL"
20246 }
20247 }
20248 },
20249 "/tracks/{id}/relationships/providers" : {
20250 "get" : {
20251 "description" : "Retrieves providers relationship.",
20252 "parameters" : [ {
20253 "description" : "Track id",
20254 "example" : "75413016",
20255 "in" : "path",
20256 "name" : "id",
20257 "required" : true,
20258 "schema" : {
20259 "type" : "string"
20260 }
20261 }, {
20262 "description" : "ISO 3166-1 alpha-2 country code",
20263 "example" : "US",
20264 "in" : "query",
20265 "name" : "countryCode",
20266 "required" : false,
20267 "schema" : {
20268 "type" : "string"
20269 }
20270 }, {
20271 "description" : "Allows the client to customize which related resources should be returned. Available options: providers",
20272 "example" : "providers",
20273 "in" : "query",
20274 "name" : "include",
20275 "required" : false,
20276 "schema" : {
20277 "type" : "array",
20278 "items" : {
20279 "type" : "string",
20280 "example" : "providers"
20281 }
20282 }
20283 }, {
20284 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
20285 "in" : "query",
20286 "name" : "page[cursor]",
20287 "required" : false,
20288 "schema" : {
20289 "type" : "string"
20290 }
20291 }, {
20292 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
20293 "in" : "query",
20294 "name" : "shareCode",
20295 "required" : false,
20296 "schema" : {
20297 "type" : "string",
20298 "example" : "xyz"
20299 }
20300 } ],
20301 "responses" : {
20302 "200" : {
20303 "content" : {
20304 "application/vnd.api+json" : {
20305 "schema" : {
20306 "$ref" : "#/components/schemas/Tracks_Multi_Relationship_Data_Document"
20307 }
20308 }
20309 },
20310 "description" : "Successful response"
20311 },
20312 "400" : {
20313 "$ref" : "#/components/responses/Default400Response"
20314 },
20315 "404" : {
20316 "$ref" : "#/components/responses/Default404Response"
20317 },
20318 "405" : {
20319 "$ref" : "#/components/responses/Default405Response"
20320 },
20321 "406" : {
20322 "$ref" : "#/components/responses/Default406Response"
20323 },
20324 "415" : {
20325 "$ref" : "#/components/responses/Default415Response"
20326 },
20327 "429" : {
20328 "$ref" : "#/components/responses/Default429Response"
20329 },
20330 "500" : {
20331 "$ref" : "#/components/responses/Default500Response"
20332 },
20333 "503" : {
20334 "$ref" : "#/components/responses/Default503Response"
20335 }
20336 },
20337 "security" : [ {
20338 "Client_Credentials" : [ ]
20339 }, {
20340 "Authorization_Code_PKCE" : [ ]
20341 } ],
20342 "summary" : "Get providers relationship (\"to-many\").",
20343 "tags" : [ "tracks" ],
20344 "x-path-item-properties" : {
20345 "required-access-tier" : "THIRD_PARTY"
20346 }
20347 }
20348 },
20349 "/tracks/{id}/relationships/radio" : {
20350 "get" : {
20351 "description" : "Retrieves radio relationship.",
20352 "parameters" : [ {
20353 "description" : "Track id",
20354 "example" : "75413016",
20355 "in" : "path",
20356 "name" : "id",
20357 "required" : true,
20358 "schema" : {
20359 "type" : "string"
20360 }
20361 }, {
20362 "description" : "Allows the client to customize which related resources should be returned. Available options: radio",
20363 "example" : "radio.items",
20364 "in" : "query",
20365 "name" : "include",
20366 "required" : false,
20367 "schema" : {
20368 "type" : "array",
20369 "items" : {
20370 "type" : "string",
20371 "example" : "radio.items"
20372 }
20373 }
20374 }, {
20375 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
20376 "in" : "query",
20377 "name" : "page[cursor]",
20378 "required" : false,
20379 "schema" : {
20380 "type" : "string"
20381 }
20382 }, {
20383 "description" : "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",
20384 "example" : "radio.items",
20385 "in" : "query",
20386 "name" : "replaceMedia",
20387 "required" : false,
20388 "schema" : {
20389 "type" : "string",
20390 "example" : "radio.items"
20391 }
20392 }, {
20393 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
20394 "in" : "query",
20395 "name" : "shareCode",
20396 "required" : false,
20397 "schema" : {
20398 "type" : "string",
20399 "example" : "xyz"
20400 }
20401 } ],
20402 "responses" : {
20403 "200" : {
20404 "content" : {
20405 "application/vnd.api+json" : {
20406 "schema" : {
20407 "$ref" : "#/components/schemas/Tracks_Multi_Relationship_Data_Document"
20408 }
20409 }
20410 },
20411 "description" : "Successful response"
20412 },
20413 "400" : {
20414 "$ref" : "#/components/responses/Default400Response"
20415 },
20416 "404" : {
20417 "$ref" : "#/components/responses/Default404Response"
20418 },
20419 "405" : {
20420 "$ref" : "#/components/responses/Default405Response"
20421 },
20422 "406" : {
20423 "$ref" : "#/components/responses/Default406Response"
20424 },
20425 "415" : {
20426 "$ref" : "#/components/responses/Default415Response"
20427 },
20428 "429" : {
20429 "$ref" : "#/components/responses/Default429Response"
20430 },
20431 "500" : {
20432 "$ref" : "#/components/responses/Default500Response"
20433 },
20434 "503" : {
20435 "$ref" : "#/components/responses/Default503Response"
20436 }
20437 },
20438 "security" : [ {
20439 "Client_Credentials" : [ ]
20440 }, {
20441 "Authorization_Code_PKCE" : [ ]
20442 } ],
20443 "summary" : "Get radio relationship (\"to-many\").",
20444 "tags" : [ "tracks" ],
20445 "x-path-item-properties" : {
20446 "required-access-tier" : "THIRD_PARTY"
20447 }
20448 }
20449 },
20450 "/tracks/{id}/relationships/replacement" : {
20451 "get" : {
20452 "description" : "Retrieves replacement relationship.",
20453 "parameters" : [ {
20454 "description" : "Track id",
20455 "example" : "75413016",
20456 "in" : "path",
20457 "name" : "id",
20458 "required" : true,
20459 "schema" : {
20460 "type" : "string"
20461 }
20462 }, {
20463 "description" : "ISO 3166-1 alpha-2 country code",
20464 "example" : "US",
20465 "in" : "query",
20466 "name" : "countryCode",
20467 "required" : false,
20468 "schema" : {
20469 "type" : "string"
20470 }
20471 }, {
20472 "description" : "Allows the client to customize which related resources should be returned. Available options: replacement",
20473 "example" : "replacement",
20474 "in" : "query",
20475 "name" : "include",
20476 "required" : false,
20477 "schema" : {
20478 "type" : "array",
20479 "items" : {
20480 "type" : "string",
20481 "example" : "replacement"
20482 }
20483 }
20484 }, {
20485 "description" : "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",
20486 "example" : "replacement",
20487 "in" : "query",
20488 "name" : "replaceMedia",
20489 "required" : false,
20490 "schema" : {
20491 "type" : "string",
20492 "example" : "replacement"
20493 }
20494 }, {
20495 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
20496 "in" : "query",
20497 "name" : "shareCode",
20498 "required" : false,
20499 "schema" : {
20500 "type" : "string",
20501 "example" : "xyz"
20502 }
20503 } ],
20504 "responses" : {
20505 "200" : {
20506 "content" : {
20507 "application/vnd.api+json" : {
20508 "schema" : {
20509 "$ref" : "#/components/schemas/Tracks_Single_Relationship_Data_Document"
20510 }
20511 }
20512 },
20513 "description" : "Successful response"
20514 },
20515 "400" : {
20516 "$ref" : "#/components/responses/Default400Response"
20517 },
20518 "404" : {
20519 "$ref" : "#/components/responses/Default404Response"
20520 },
20521 "405" : {
20522 "$ref" : "#/components/responses/Default405Response"
20523 },
20524 "406" : {
20525 "$ref" : "#/components/responses/Default406Response"
20526 },
20527 "415" : {
20528 "$ref" : "#/components/responses/Default415Response"
20529 },
20530 "429" : {
20531 "$ref" : "#/components/responses/Default429Response"
20532 },
20533 "500" : {
20534 "$ref" : "#/components/responses/Default500Response"
20535 },
20536 "503" : {
20537 "$ref" : "#/components/responses/Default503Response"
20538 }
20539 },
20540 "security" : [ {
20541 "Client_Credentials" : [ ]
20542 }, {
20543 "Authorization_Code_PKCE" : [ ]
20544 } ],
20545 "summary" : "Get replacement relationship (\"to-one\").",
20546 "tags" : [ "tracks" ],
20547 "x-path-item-properties" : {
20548 "required-access-tier" : "INTERNAL"
20549 }
20550 }
20551 },
20552 "/tracks/{id}/relationships/shares" : {
20553 "get" : {
20554 "description" : "Retrieves shares relationship.",
20555 "parameters" : [ {
20556 "description" : "Track id",
20557 "example" : "75413016",
20558 "in" : "path",
20559 "name" : "id",
20560 "required" : true,
20561 "schema" : {
20562 "type" : "string"
20563 }
20564 }, {
20565 "description" : "Allows the client to customize which related resources should be returned. Available options: shares",
20566 "example" : "shares.sharedResources",
20567 "in" : "query",
20568 "name" : "include",
20569 "required" : false,
20570 "schema" : {
20571 "type" : "array",
20572 "items" : {
20573 "type" : "string",
20574 "example" : "shares.sharedResources"
20575 }
20576 }
20577 }, {
20578 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
20579 "in" : "query",
20580 "name" : "page[cursor]",
20581 "required" : false,
20582 "schema" : {
20583 "type" : "string"
20584 }
20585 }, {
20586 "description" : "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",
20587 "example" : "shares.sharedResources",
20588 "in" : "query",
20589 "name" : "replaceMedia",
20590 "required" : false,
20591 "schema" : {
20592 "type" : "string",
20593 "example" : "shares.sharedResources"
20594 }
20595 }, {
20596 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
20597 "in" : "query",
20598 "name" : "shareCode",
20599 "required" : false,
20600 "schema" : {
20601 "type" : "string",
20602 "example" : "xyz"
20603 }
20604 } ],
20605 "responses" : {
20606 "200" : {
20607 "content" : {
20608 "application/vnd.api+json" : {
20609 "schema" : {
20610 "$ref" : "#/components/schemas/Tracks_Multi_Relationship_Data_Document"
20611 }
20612 }
20613 },
20614 "description" : "Successful response"
20615 },
20616 "400" : {
20617 "$ref" : "#/components/responses/Default400Response"
20618 },
20619 "404" : {
20620 "$ref" : "#/components/responses/Default404Response"
20621 },
20622 "405" : {
20623 "$ref" : "#/components/responses/Default405Response"
20624 },
20625 "406" : {
20626 "$ref" : "#/components/responses/Default406Response"
20627 },
20628 "415" : {
20629 "$ref" : "#/components/responses/Default415Response"
20630 },
20631 "429" : {
20632 "$ref" : "#/components/responses/Default429Response"
20633 },
20634 "500" : {
20635 "$ref" : "#/components/responses/Default500Response"
20636 },
20637 "503" : {
20638 "$ref" : "#/components/responses/Default503Response"
20639 }
20640 },
20641 "security" : [ {
20642 "Authorization_Code_PKCE" : [ "r_usr" ]
20643 } ],
20644 "summary" : "Get shares relationship (\"to-many\").",
20645 "tags" : [ "tracks" ],
20646 "x-path-item-properties" : {
20647 "required-access-tier" : "INTERNAL"
20648 }
20649 }
20650 },
20651 "/tracks/{id}/relationships/similarTracks" : {
20652 "get" : {
20653 "description" : "Retrieves similarTracks relationship.",
20654 "parameters" : [ {
20655 "description" : "Track id",
20656 "example" : "75413016",
20657 "in" : "path",
20658 "name" : "id",
20659 "required" : true,
20660 "schema" : {
20661 "type" : "string"
20662 }
20663 }, {
20664 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
20665 "in" : "query",
20666 "name" : "page[cursor]",
20667 "required" : false,
20668 "schema" : {
20669 "type" : "string"
20670 }
20671 }, {
20672 "description" : "ISO 3166-1 alpha-2 country code",
20673 "example" : "US",
20674 "in" : "query",
20675 "name" : "countryCode",
20676 "required" : false,
20677 "schema" : {
20678 "type" : "string"
20679 }
20680 }, {
20681 "description" : "Allows the client to customize which related resources should be returned. Available options: similarTracks",
20682 "example" : "similarTracks",
20683 "in" : "query",
20684 "name" : "include",
20685 "required" : false,
20686 "schema" : {
20687 "type" : "array",
20688 "items" : {
20689 "type" : "string",
20690 "example" : "similarTracks"
20691 }
20692 }
20693 }, {
20694 "description" : "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",
20695 "example" : "similarTracks",
20696 "in" : "query",
20697 "name" : "replaceMedia",
20698 "required" : false,
20699 "schema" : {
20700 "type" : "string",
20701 "example" : "similarTracks"
20702 }
20703 }, {
20704 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
20705 "in" : "query",
20706 "name" : "shareCode",
20707 "required" : false,
20708 "schema" : {
20709 "type" : "string",
20710 "example" : "xyz"
20711 }
20712 } ],
20713 "responses" : {
20714 "200" : {
20715 "content" : {
20716 "application/vnd.api+json" : {
20717 "schema" : {
20718 "$ref" : "#/components/schemas/Tracks_Multi_Relationship_Data_Document"
20719 }
20720 }
20721 },
20722 "description" : "Successful response"
20723 },
20724 "400" : {
20725 "$ref" : "#/components/responses/Default400Response"
20726 },
20727 "404" : {
20728 "$ref" : "#/components/responses/Default404Response"
20729 },
20730 "405" : {
20731 "$ref" : "#/components/responses/Default405Response"
20732 },
20733 "406" : {
20734 "$ref" : "#/components/responses/Default406Response"
20735 },
20736 "415" : {
20737 "$ref" : "#/components/responses/Default415Response"
20738 },
20739 "429" : {
20740 "$ref" : "#/components/responses/Default429Response"
20741 },
20742 "500" : {
20743 "$ref" : "#/components/responses/Default500Response"
20744 },
20745 "503" : {
20746 "$ref" : "#/components/responses/Default503Response"
20747 }
20748 },
20749 "security" : [ {
20750 "Client_Credentials" : [ ]
20751 }, {
20752 "Authorization_Code_PKCE" : [ ]
20753 } ],
20754 "summary" : "Get similarTracks relationship (\"to-many\").",
20755 "tags" : [ "tracks" ],
20756 "x-path-item-properties" : {
20757 "required-access-tier" : "THIRD_PARTY"
20758 }
20759 }
20760 },
20761 "/tracks/{id}/relationships/sourceFile" : {
20762 "get" : {
20763 "description" : "Retrieves sourceFile relationship.",
20764 "parameters" : [ {
20765 "description" : "Track id",
20766 "example" : "75413016",
20767 "in" : "path",
20768 "name" : "id",
20769 "required" : true,
20770 "schema" : {
20771 "type" : "string"
20772 }
20773 }, {
20774 "description" : "Allows the client to customize which related resources should be returned. Available options: sourceFile",
20775 "example" : "sourceFile",
20776 "in" : "query",
20777 "name" : "include",
20778 "required" : false,
20779 "schema" : {
20780 "type" : "array",
20781 "items" : {
20782 "type" : "string",
20783 "example" : "sourceFile"
20784 }
20785 }
20786 }, {
20787 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
20788 "in" : "query",
20789 "name" : "shareCode",
20790 "required" : false,
20791 "schema" : {
20792 "type" : "string",
20793 "example" : "xyz"
20794 }
20795 } ],
20796 "responses" : {
20797 "200" : {
20798 "content" : {
20799 "application/vnd.api+json" : {
20800 "schema" : {
20801 "$ref" : "#/components/schemas/Tracks_Single_Relationship_Data_Document"
20802 }
20803 }
20804 },
20805 "description" : "Successful response"
20806 },
20807 "400" : {
20808 "$ref" : "#/components/responses/Default400Response"
20809 },
20810 "404" : {
20811 "$ref" : "#/components/responses/Default404Response"
20812 },
20813 "405" : {
20814 "$ref" : "#/components/responses/Default405Response"
20815 },
20816 "406" : {
20817 "$ref" : "#/components/responses/Default406Response"
20818 },
20819 "415" : {
20820 "$ref" : "#/components/responses/Default415Response"
20821 },
20822 "429" : {
20823 "$ref" : "#/components/responses/Default429Response"
20824 },
20825 "500" : {
20826 "$ref" : "#/components/responses/Default500Response"
20827 },
20828 "503" : {
20829 "$ref" : "#/components/responses/Default503Response"
20830 }
20831 },
20832 "security" : [ {
20833 "Client_Credentials" : [ ]
20834 }, {
20835 "Authorization_Code_PKCE" : [ ]
20836 } ],
20837 "summary" : "Get sourceFile relationship (\"to-one\").",
20838 "tags" : [ "tracks" ],
20839 "x-path-item-properties" : {
20840 "required-access-tier" : "THIRD_PARTY"
20841 }
20842 }
20843 },
20844 "/tracks/{id}/relationships/suggestedTracks" : {
20845 "get" : {
20846 "description" : "Retrieves suggestedTracks relationship.",
20847 "parameters" : [ {
20848 "description" : "Track id",
20849 "example" : "75413016",
20850 "in" : "path",
20851 "name" : "id",
20852 "required" : true,
20853 "schema" : {
20854 "type" : "string"
20855 }
20856 }, {
20857 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
20858 "in" : "query",
20859 "name" : "page[cursor]",
20860 "required" : false,
20861 "schema" : {
20862 "type" : "string"
20863 }
20864 }, {
20865 "description" : "ISO 3166-1 alpha-2 country code",
20866 "example" : "US",
20867 "in" : "query",
20868 "name" : "countryCode",
20869 "required" : false,
20870 "schema" : {
20871 "type" : "string"
20872 }
20873 }, {
20874 "description" : "Allows the client to customize which related resources should be returned. Available options: suggestedTracks",
20875 "example" : "suggestedTracks",
20876 "in" : "query",
20877 "name" : "include",
20878 "required" : false,
20879 "schema" : {
20880 "type" : "array",
20881 "items" : {
20882 "type" : "string",
20883 "example" : "suggestedTracks"
20884 }
20885 }
20886 }, {
20887 "description" : "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",
20888 "example" : "suggestedTracks",
20889 "in" : "query",
20890 "name" : "replaceMedia",
20891 "required" : false,
20892 "schema" : {
20893 "type" : "string",
20894 "example" : "suggestedTracks"
20895 }
20896 }, {
20897 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
20898 "in" : "query",
20899 "name" : "shareCode",
20900 "required" : false,
20901 "schema" : {
20902 "type" : "string",
20903 "example" : "xyz"
20904 }
20905 } ],
20906 "responses" : {
20907 "200" : {
20908 "content" : {
20909 "application/vnd.api+json" : {
20910 "schema" : {
20911 "$ref" : "#/components/schemas/Tracks_Multi_Relationship_Data_Document"
20912 }
20913 }
20914 },
20915 "description" : "Successful response"
20916 },
20917 "400" : {
20918 "$ref" : "#/components/responses/Default400Response"
20919 },
20920 "404" : {
20921 "$ref" : "#/components/responses/Default404Response"
20922 },
20923 "405" : {
20924 "$ref" : "#/components/responses/Default405Response"
20925 },
20926 "406" : {
20927 "$ref" : "#/components/responses/Default406Response"
20928 },
20929 "415" : {
20930 "$ref" : "#/components/responses/Default415Response"
20931 },
20932 "429" : {
20933 "$ref" : "#/components/responses/Default429Response"
20934 },
20935 "500" : {
20936 "$ref" : "#/components/responses/Default500Response"
20937 },
20938 "503" : {
20939 "$ref" : "#/components/responses/Default503Response"
20940 }
20941 },
20942 "security" : [ {
20943 "Client_Credentials" : [ ]
20944 }, {
20945 "Authorization_Code_PKCE" : [ ]
20946 } ],
20947 "summary" : "Get suggestedTracks relationship (\"to-many\").",
20948 "tags" : [ "tracks" ],
20949 "x-path-item-properties" : {
20950 "required-access-tier" : "INTERNAL"
20951 }
20952 }
20953 },
20954 "/tracks/{id}/relationships/trackStatistics" : {
20955 "get" : {
20956 "description" : "Retrieves trackStatistics relationship.",
20957 "parameters" : [ {
20958 "description" : "Track id",
20959 "example" : "75413016",
20960 "in" : "path",
20961 "name" : "id",
20962 "required" : true,
20963 "schema" : {
20964 "type" : "string"
20965 }
20966 }, {
20967 "description" : "Allows the client to customize which related resources should be returned. Available options: trackStatistics",
20968 "example" : "trackStatistics",
20969 "in" : "query",
20970 "name" : "include",
20971 "required" : false,
20972 "schema" : {
20973 "type" : "array",
20974 "items" : {
20975 "type" : "string",
20976 "example" : "trackStatistics"
20977 }
20978 }
20979 }, {
20980 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
20981 "in" : "query",
20982 "name" : "shareCode",
20983 "required" : false,
20984 "schema" : {
20985 "type" : "string",
20986 "example" : "xyz"
20987 }
20988 } ],
20989 "responses" : {
20990 "200" : {
20991 "content" : {
20992 "application/vnd.api+json" : {
20993 "schema" : {
20994 "$ref" : "#/components/schemas/Tracks_Single_Relationship_Data_Document"
20995 }
20996 }
20997 },
20998 "description" : "Successful response"
20999 },
21000 "400" : {
21001 "$ref" : "#/components/responses/Default400Response"
21002 },
21003 "404" : {
21004 "$ref" : "#/components/responses/Default404Response"
21005 },
21006 "405" : {
21007 "$ref" : "#/components/responses/Default405Response"
21008 },
21009 "406" : {
21010 "$ref" : "#/components/responses/Default406Response"
21011 },
21012 "415" : {
21013 "$ref" : "#/components/responses/Default415Response"
21014 },
21015 "429" : {
21016 "$ref" : "#/components/responses/Default429Response"
21017 },
21018 "500" : {
21019 "$ref" : "#/components/responses/Default500Response"
21020 },
21021 "503" : {
21022 "$ref" : "#/components/responses/Default503Response"
21023 }
21024 },
21025 "security" : [ {
21026 "Authorization_Code_PKCE" : [ ]
21027 } ],
21028 "summary" : "Get trackStatistics relationship (\"to-one\").",
21029 "tags" : [ "tracks" ],
21030 "x-path-item-properties" : {
21031 "required-access-tier" : "INTERNAL"
21032 }
21033 }
21034 },
21035 "/tracks/{id}/relationships/usageRules" : {
21036 "get" : {
21037 "description" : "Retrieves usageRules relationship.",
21038 "parameters" : [ {
21039 "description" : "Track id",
21040 "example" : "75413016",
21041 "in" : "path",
21042 "name" : "id",
21043 "required" : true,
21044 "schema" : {
21045 "type" : "string"
21046 }
21047 }, {
21048 "description" : "ISO 3166-1 alpha-2 country code",
21049 "example" : "US",
21050 "in" : "query",
21051 "name" : "countryCode",
21052 "required" : false,
21053 "schema" : {
21054 "type" : "string"
21055 }
21056 }, {
21057 "description" : "Allows the client to customize which related resources should be returned. Available options: usageRules",
21058 "example" : "usageRules",
21059 "in" : "query",
21060 "name" : "include",
21061 "required" : false,
21062 "schema" : {
21063 "type" : "array",
21064 "items" : {
21065 "type" : "string",
21066 "example" : "usageRules"
21067 }
21068 }
21069 }, {
21070 "description" : "Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted.",
21071 "in" : "query",
21072 "name" : "shareCode",
21073 "required" : false,
21074 "schema" : {
21075 "type" : "string",
21076 "example" : "xyz"
21077 }
21078 } ],
21079 "responses" : {
21080 "200" : {
21081 "content" : {
21082 "application/vnd.api+json" : {
21083 "schema" : {
21084 "$ref" : "#/components/schemas/Tracks_Single_Relationship_Data_Document"
21085 }
21086 }
21087 },
21088 "description" : "Successful response"
21089 },
21090 "400" : {
21091 "$ref" : "#/components/responses/Default400Response"
21092 },
21093 "404" : {
21094 "$ref" : "#/components/responses/Default404Response"
21095 },
21096 "405" : {
21097 "$ref" : "#/components/responses/Default405Response"
21098 },
21099 "406" : {
21100 "$ref" : "#/components/responses/Default406Response"
21101 },
21102 "415" : {
21103 "$ref" : "#/components/responses/Default415Response"
21104 },
21105 "429" : {
21106 "$ref" : "#/components/responses/Default429Response"
21107 },
21108 "500" : {
21109 "$ref" : "#/components/responses/Default500Response"
21110 },
21111 "503" : {
21112 "$ref" : "#/components/responses/Default503Response"
21113 }
21114 },
21115 "security" : [ {
21116 "Client_Credentials" : [ ]
21117 }, {
21118 "Authorization_Code_PKCE" : [ ]
21119 } ],
21120 "summary" : "Get usageRules relationship (\"to-one\").",
21121 "tags" : [ "tracks" ],
21122 "x-path-item-properties" : {
21123 "required-access-tier" : "THIRD_PARTY"
21124 }
21125 }
21126 },
21127 "/tracksMetadataStatus/{id}" : {
21128 "get" : {
21129 "description" : "Retrieves single tracksMetadataStatu by id.",
21130 "parameters" : [ {
21131 "description" : "Tracks metadata status id",
21132 "example" : "123456",
21133 "in" : "path",
21134 "name" : "id",
21135 "required" : true,
21136 "schema" : {
21137 "type" : "string"
21138 }
21139 } ],
21140 "responses" : {
21141 "200" : {
21142 "content" : {
21143 "application/vnd.api+json" : {
21144 "schema" : {
21145 "$ref" : "#/components/schemas/TracksMetadataStatus_Single_Resource_Data_Document"
21146 }
21147 }
21148 },
21149 "description" : "Successful response"
21150 },
21151 "400" : {
21152 "$ref" : "#/components/responses/Default400Response"
21153 },
21154 "404" : {
21155 "$ref" : "#/components/responses/Default404Response"
21156 },
21157 "405" : {
21158 "$ref" : "#/components/responses/Default405Response"
21159 },
21160 "406" : {
21161 "$ref" : "#/components/responses/Default406Response"
21162 },
21163 "415" : {
21164 "$ref" : "#/components/responses/Default415Response"
21165 },
21166 "429" : {
21167 "$ref" : "#/components/responses/Default429Response"
21168 },
21169 "500" : {
21170 "$ref" : "#/components/responses/Default500Response"
21171 },
21172 "503" : {
21173 "$ref" : "#/components/responses/Default503Response"
21174 }
21175 },
21176 "security" : [ {
21177 "Authorization_Code_PKCE" : [ ]
21178 } ],
21179 "summary" : "Get single tracksMetadataStatu.",
21180 "tags" : [ "tracksMetadataStatus" ],
21181 "x-path-item-properties" : {
21182 "required-access-tier" : "INTERNAL"
21183 }
21184 }
21185 },
21186 "/usageRules" : {
21187 "post" : {
21188 "description" : "Creates a new usageRule.",
21189 "parameters" : [ {
21190 "$ref" : "#/components/parameters/IdempotencyKey"
21191 } ],
21192 "requestBody" : {
21193 "content" : {
21194 "application/vnd.api+json" : {
21195 "schema" : {
21196 "$ref" : "#/components/schemas/UsageRulesCreateOperation_Payload"
21197 }
21198 }
21199 }
21200 },
21201 "responses" : {
21202 "201" : {
21203 "content" : {
21204 "application/vnd.api+json" : {
21205 "schema" : {
21206 "$ref" : "#/components/schemas/UsageRules_Create_Single_Resource_Data_Document"
21207 }
21208 }
21209 },
21210 "description" : "Successful response"
21211 },
21212 "400" : {
21213 "$ref" : "#/components/responses/Default400Response"
21214 },
21215 "404" : {
21216 "$ref" : "#/components/responses/Default404Response"
21217 },
21218 "405" : {
21219 "$ref" : "#/components/responses/Default405Response"
21220 },
21221 "406" : {
21222 "$ref" : "#/components/responses/Default406Response"
21223 },
21224 "409" : {
21225 "$ref" : "#/components/responses/Idempotency409Response"
21226 },
21227 "415" : {
21228 "$ref" : "#/components/responses/Default415Response"
21229 },
21230 "422" : {
21231 "$ref" : "#/components/responses/Idempotency422Response"
21232 },
21233 "429" : {
21234 "$ref" : "#/components/responses/Default429Response"
21235 },
21236 "500" : {
21237 "$ref" : "#/components/responses/Default500Response"
21238 },
21239 "503" : {
21240 "$ref" : "#/components/responses/Default503Response"
21241 }
21242 },
21243 "security" : [ {
21244 "Authorization_Code_PKCE" : [ "w_usr" ]
21245 } ],
21246 "summary" : "Create single usageRule.",
21247 "tags" : [ "usageRules" ],
21248 "x-path-item-properties" : {
21249 "required-access-tier" : "INTERNAL"
21250 }
21251 }
21252 },
21253 "/usageRules/{id}" : {
21254 "get" : {
21255 "description" : "Retrieves single usageRule by id.",
21256 "parameters" : [ {
21257 "description" : "Usage rules id",
21258 "example" : "VFJBQ0tTOjEyMzpOTw",
21259 "in" : "path",
21260 "name" : "id",
21261 "required" : true,
21262 "schema" : {
21263 "type" : "string"
21264 }
21265 } ],
21266 "responses" : {
21267 "200" : {
21268 "content" : {
21269 "application/vnd.api+json" : {
21270 "schema" : {
21271 "$ref" : "#/components/schemas/UsageRules_Single_Resource_Data_Document"
21272 }
21273 }
21274 },
21275 "description" : "Successful response"
21276 },
21277 "400" : {
21278 "$ref" : "#/components/responses/Default400Response"
21279 },
21280 "404" : {
21281 "$ref" : "#/components/responses/Default404Response"
21282 },
21283 "405" : {
21284 "$ref" : "#/components/responses/Default405Response"
21285 },
21286 "406" : {
21287 "$ref" : "#/components/responses/Default406Response"
21288 },
21289 "415" : {
21290 "$ref" : "#/components/responses/Default415Response"
21291 },
21292 "429" : {
21293 "$ref" : "#/components/responses/Default429Response"
21294 },
21295 "500" : {
21296 "$ref" : "#/components/responses/Default500Response"
21297 },
21298 "503" : {
21299 "$ref" : "#/components/responses/Default503Response"
21300 }
21301 },
21302 "security" : [ {
21303 "Client_Credentials" : [ ]
21304 }, {
21305 "Authorization_Code_PKCE" : [ ]
21306 } ],
21307 "summary" : "Get single usageRule.",
21308 "tags" : [ "usageRules" ],
21309 "x-path-item-properties" : {
21310 "required-access-tier" : "THIRD_PARTY"
21311 }
21312 }
21313 },
21314 "/userCollectionAlbums/{id}" : {
21315 "get" : {
21316 "description" : "Retrieves single userCollectionAlbum by id.",
21317 "parameters" : [ {
21318 "description" : "User collection albums id. Use `me` for the authenticated user's resource",
21319 "example" : "me",
21320 "in" : "path",
21321 "name" : "id",
21322 "required" : true,
21323 "schema" : {
21324 "type" : "string"
21325 }
21326 }, {
21327 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
21328 "example" : "en-US",
21329 "in" : "query",
21330 "name" : "locale",
21331 "required" : false,
21332 "schema" : {
21333 "type" : "string",
21334 "default" : "en-US"
21335 }
21336 }, {
21337 "description" : "Allows the client to customize which related resources should be returned. Available options: items, owners",
21338 "example" : "items",
21339 "in" : "query",
21340 "name" : "include",
21341 "required" : false,
21342 "schema" : {
21343 "type" : "array",
21344 "items" : {
21345 "type" : "string",
21346 "example" : "items"
21347 }
21348 }
21349 }, {
21350 "description" : "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",
21351 "example" : "items",
21352 "in" : "query",
21353 "name" : "replaceMedia",
21354 "required" : false,
21355 "schema" : {
21356 "type" : "string",
21357 "example" : "items"
21358 }
21359 } ],
21360 "responses" : {
21361 "200" : {
21362 "content" : {
21363 "application/vnd.api+json" : {
21364 "schema" : {
21365 "$ref" : "#/components/schemas/UserCollectionAlbums_Single_Resource_Data_Document"
21366 }
21367 }
21368 },
21369 "description" : "Successful response"
21370 },
21371 "400" : {
21372 "$ref" : "#/components/responses/Default400Response"
21373 },
21374 "404" : {
21375 "$ref" : "#/components/responses/Default404Response"
21376 },
21377 "405" : {
21378 "$ref" : "#/components/responses/Default405Response"
21379 },
21380 "406" : {
21381 "$ref" : "#/components/responses/Default406Response"
21382 },
21383 "415" : {
21384 "$ref" : "#/components/responses/Default415Response"
21385 },
21386 "429" : {
21387 "$ref" : "#/components/responses/Default429Response"
21388 },
21389 "500" : {
21390 "$ref" : "#/components/responses/Default500Response"
21391 },
21392 "503" : {
21393 "$ref" : "#/components/responses/Default503Response"
21394 }
21395 },
21396 "security" : [ {
21397 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
21398 } ],
21399 "summary" : "Get single userCollectionAlbum.",
21400 "tags" : [ "userCollectionAlbums" ],
21401 "x-path-item-properties" : {
21402 "required-access-tier" : "THIRD_PARTY"
21403 }
21404 }
21405 },
21406 "/userCollectionAlbums/{id}/relationships/items" : {
21407 "delete" : {
21408 "description" : "Deletes item(s) from items relationship.",
21409 "parameters" : [ {
21410 "description" : "User collection albums id. Use `me` for the authenticated user's resource",
21411 "example" : "me",
21412 "in" : "path",
21413 "name" : "id",
21414 "required" : true,
21415 "schema" : {
21416 "type" : "string"
21417 }
21418 }, {
21419 "$ref" : "#/components/parameters/IdempotencyKey"
21420 } ],
21421 "requestBody" : {
21422 "content" : {
21423 "application/vnd.api+json" : {
21424 "schema" : {
21425 "$ref" : "#/components/schemas/UserCollectionAlbumsItemsRelationshipRemoveOperation_Payload"
21426 }
21427 }
21428 }
21429 },
21430 "responses" : {
21431 "400" : {
21432 "$ref" : "#/components/responses/Default400Response"
21433 },
21434 "404" : {
21435 "$ref" : "#/components/responses/Default404Response"
21436 },
21437 "405" : {
21438 "$ref" : "#/components/responses/Default405Response"
21439 },
21440 "406" : {
21441 "$ref" : "#/components/responses/Default406Response"
21442 },
21443 "409" : {
21444 "$ref" : "#/components/responses/Idempotency409Response"
21445 },
21446 "415" : {
21447 "$ref" : "#/components/responses/Default415Response"
21448 },
21449 "422" : {
21450 "$ref" : "#/components/responses/Idempotency422Response"
21451 },
21452 "429" : {
21453 "$ref" : "#/components/responses/Default429Response"
21454 },
21455 "500" : {
21456 "$ref" : "#/components/responses/Default500Response"
21457 },
21458 "503" : {
21459 "$ref" : "#/components/responses/Default503Response"
21460 }
21461 },
21462 "security" : [ {
21463 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
21464 } ],
21465 "summary" : "Delete from items relationship (\"to-many\").",
21466 "tags" : [ "userCollectionAlbums" ],
21467 "x-path-item-properties" : {
21468 "required-access-tier" : "THIRD_PARTY"
21469 }
21470 },
21471 "get" : {
21472 "description" : "Retrieves items relationship.",
21473 "parameters" : [ {
21474 "description" : "User collection albums id. Use `me` for the authenticated user's resource",
21475 "example" : "me",
21476 "in" : "path",
21477 "name" : "id",
21478 "required" : true,
21479 "schema" : {
21480 "type" : "string"
21481 }
21482 }, {
21483 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
21484 "in" : "query",
21485 "name" : "page[cursor]",
21486 "required" : false,
21487 "schema" : {
21488 "type" : "string"
21489 }
21490 }, {
21491 "description" : "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
21492 "in" : "query",
21493 "name" : "sort",
21494 "required" : false,
21495 "schema" : {
21496 "type" : "array",
21497 "items" : {
21498 "type" : "string",
21499 "example" : "addedAt",
21500 "default" : "-addedAt",
21501 "enum" : [ "addedAt", "-addedAt", "artists.name", "-artists.name", "releaseDate", "-releaseDate", "title", "-title" ],
21502 "x-enum-varnames" : [ "AddedAtAsc", "AddedAtDesc", "ArtistsNameAsc", "ArtistsNameDesc", "ReleaseDateAsc", "ReleaseDateDesc", "TitleAsc", "TitleDesc" ]
21503 }
21504 }
21505 }, {
21506 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
21507 "example" : "en-US",
21508 "in" : "query",
21509 "name" : "locale",
21510 "required" : false,
21511 "schema" : {
21512 "type" : "string",
21513 "default" : "en-US"
21514 }
21515 }, {
21516 "description" : "Allows the client to customize which related resources should be returned. Available options: items",
21517 "example" : "items",
21518 "in" : "query",
21519 "name" : "include",
21520 "required" : false,
21521 "schema" : {
21522 "type" : "array",
21523 "items" : {
21524 "type" : "string",
21525 "example" : "items"
21526 }
21527 }
21528 }, {
21529 "description" : "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",
21530 "example" : "items",
21531 "in" : "query",
21532 "name" : "replaceMedia",
21533 "required" : false,
21534 "schema" : {
21535 "type" : "string",
21536 "example" : "items"
21537 }
21538 } ],
21539 "responses" : {
21540 "200" : {
21541 "content" : {
21542 "application/vnd.api+json" : {
21543 "schema" : {
21544 "$ref" : "#/components/schemas/UserCollectionAlbums_Items_Multi_Relationship_Data_Document"
21545 }
21546 }
21547 },
21548 "description" : "Successful response"
21549 },
21550 "400" : {
21551 "$ref" : "#/components/responses/Default400Response"
21552 },
21553 "404" : {
21554 "$ref" : "#/components/responses/Default404Response"
21555 },
21556 "405" : {
21557 "$ref" : "#/components/responses/Default405Response"
21558 },
21559 "406" : {
21560 "$ref" : "#/components/responses/Default406Response"
21561 },
21562 "415" : {
21563 "$ref" : "#/components/responses/Default415Response"
21564 },
21565 "429" : {
21566 "$ref" : "#/components/responses/Default429Response"
21567 },
21568 "500" : {
21569 "$ref" : "#/components/responses/Default500Response"
21570 },
21571 "503" : {
21572 "$ref" : "#/components/responses/Default503Response"
21573 }
21574 },
21575 "security" : [ {
21576 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
21577 } ],
21578 "summary" : "Get items relationship (\"to-many\").",
21579 "tags" : [ "userCollectionAlbums" ],
21580 "x-path-item-properties" : {
21581 "required-access-tier" : "THIRD_PARTY"
21582 }
21583 },
21584 "post" : {
21585 "description" : "Adds item(s) to items relationship.",
21586 "parameters" : [ {
21587 "description" : "User collection albums id. Use `me` for the authenticated user's resource",
21588 "example" : "me",
21589 "in" : "path",
21590 "name" : "id",
21591 "required" : true,
21592 "schema" : {
21593 "type" : "string"
21594 }
21595 }, {
21596 "$ref" : "#/components/parameters/IdempotencyKey"
21597 } ],
21598 "requestBody" : {
21599 "content" : {
21600 "application/vnd.api+json" : {
21601 "schema" : {
21602 "$ref" : "#/components/schemas/UserCollectionAlbumsItemsRelationshipAddOperation_Payload"
21603 }
21604 }
21605 }
21606 },
21607 "responses" : {
21608 "200" : {
21609 "content" : {
21610 "application/vnd.api+json" : {
21611 "schema" : {
21612 "$ref" : "#/components/schemas/UserCollectionAlbums_Items_Add_Multi_Relationship_Data_Document"
21613 }
21614 }
21615 },
21616 "description" : "Successful response"
21617 },
21618 "400" : {
21619 "$ref" : "#/components/responses/Default400Response"
21620 },
21621 "404" : {
21622 "$ref" : "#/components/responses/Default404Response"
21623 },
21624 "405" : {
21625 "$ref" : "#/components/responses/Default405Response"
21626 },
21627 "406" : {
21628 "$ref" : "#/components/responses/Default406Response"
21629 },
21630 "409" : {
21631 "$ref" : "#/components/responses/UserCollectionAlbumsAddMultiDataRelationshipWithResponse409Response"
21632 },
21633 "415" : {
21634 "$ref" : "#/components/responses/Default415Response"
21635 },
21636 "422" : {
21637 "$ref" : "#/components/responses/Idempotency422Response"
21638 },
21639 "429" : {
21640 "$ref" : "#/components/responses/Default429Response"
21641 },
21642 "500" : {
21643 "$ref" : "#/components/responses/Default500Response"
21644 },
21645 "503" : {
21646 "$ref" : "#/components/responses/Default503Response"
21647 }
21648 },
21649 "security" : [ {
21650 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
21651 } ],
21652 "summary" : "Add to items relationship (\"to-many\").",
21653 "tags" : [ "userCollectionAlbums" ],
21654 "x-path-item-properties" : {
21655 "required-access-tier" : "THIRD_PARTY"
21656 }
21657 }
21658 },
21659 "/userCollectionAlbums/{id}/relationships/owners" : {
21660 "get" : {
21661 "description" : "Retrieves owners relationship.",
21662 "parameters" : [ {
21663 "description" : "User collection albums id. Use `me` for the authenticated user's resource",
21664 "example" : "me",
21665 "in" : "path",
21666 "name" : "id",
21667 "required" : true,
21668 "schema" : {
21669 "type" : "string"
21670 }
21671 }, {
21672 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
21673 "example" : "owners",
21674 "in" : "query",
21675 "name" : "include",
21676 "required" : false,
21677 "schema" : {
21678 "type" : "array",
21679 "items" : {
21680 "type" : "string",
21681 "example" : "owners"
21682 }
21683 }
21684 }, {
21685 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
21686 "in" : "query",
21687 "name" : "page[cursor]",
21688 "required" : false,
21689 "schema" : {
21690 "type" : "string"
21691 }
21692 } ],
21693 "responses" : {
21694 "200" : {
21695 "content" : {
21696 "application/vnd.api+json" : {
21697 "schema" : {
21698 "$ref" : "#/components/schemas/UserCollectionAlbums_Multi_Relationship_Data_Document"
21699 }
21700 }
21701 },
21702 "description" : "Successful response"
21703 },
21704 "400" : {
21705 "$ref" : "#/components/responses/Default400Response"
21706 },
21707 "404" : {
21708 "$ref" : "#/components/responses/Default404Response"
21709 },
21710 "405" : {
21711 "$ref" : "#/components/responses/Default405Response"
21712 },
21713 "406" : {
21714 "$ref" : "#/components/responses/Default406Response"
21715 },
21716 "415" : {
21717 "$ref" : "#/components/responses/Default415Response"
21718 },
21719 "429" : {
21720 "$ref" : "#/components/responses/Default429Response"
21721 },
21722 "500" : {
21723 "$ref" : "#/components/responses/Default500Response"
21724 },
21725 "503" : {
21726 "$ref" : "#/components/responses/Default503Response"
21727 }
21728 },
21729 "security" : [ {
21730 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
21731 } ],
21732 "summary" : "Get owners relationship (\"to-many\").",
21733 "tags" : [ "userCollectionAlbums" ],
21734 "x-path-item-properties" : {
21735 "required-access-tier" : "THIRD_PARTY"
21736 }
21737 }
21738 },
21739 "/userCollectionArtists/{id}" : {
21740 "get" : {
21741 "description" : "Retrieves single userCollectionArtist by id.",
21742 "parameters" : [ {
21743 "description" : "User collection artists id. Use `me` for the authenticated user's resource",
21744 "example" : "me",
21745 "in" : "path",
21746 "name" : "id",
21747 "required" : true,
21748 "schema" : {
21749 "type" : "string"
21750 }
21751 }, {
21752 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
21753 "example" : "en-US",
21754 "in" : "query",
21755 "name" : "locale",
21756 "required" : false,
21757 "schema" : {
21758 "type" : "string",
21759 "default" : "en-US"
21760 }
21761 }, {
21762 "description" : "Allows the client to customize which related resources should be returned. Available options: items, owners",
21763 "example" : "items.albums",
21764 "in" : "query",
21765 "name" : "include",
21766 "required" : false,
21767 "schema" : {
21768 "type" : "array",
21769 "items" : {
21770 "type" : "string",
21771 "example" : "items.albums"
21772 }
21773 }
21774 }, {
21775 "description" : "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",
21776 "example" : "items.albums",
21777 "in" : "query",
21778 "name" : "replaceMedia",
21779 "required" : false,
21780 "schema" : {
21781 "type" : "string",
21782 "example" : "items.albums"
21783 }
21784 } ],
21785 "responses" : {
21786 "200" : {
21787 "content" : {
21788 "application/vnd.api+json" : {
21789 "schema" : {
21790 "$ref" : "#/components/schemas/UserCollectionArtists_Single_Resource_Data_Document"
21791 }
21792 }
21793 },
21794 "description" : "Successful response"
21795 },
21796 "400" : {
21797 "$ref" : "#/components/responses/Default400Response"
21798 },
21799 "404" : {
21800 "$ref" : "#/components/responses/Default404Response"
21801 },
21802 "405" : {
21803 "$ref" : "#/components/responses/Default405Response"
21804 },
21805 "406" : {
21806 "$ref" : "#/components/responses/Default406Response"
21807 },
21808 "415" : {
21809 "$ref" : "#/components/responses/Default415Response"
21810 },
21811 "429" : {
21812 "$ref" : "#/components/responses/Default429Response"
21813 },
21814 "500" : {
21815 "$ref" : "#/components/responses/Default500Response"
21816 },
21817 "503" : {
21818 "$ref" : "#/components/responses/Default503Response"
21819 }
21820 },
21821 "security" : [ {
21822 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
21823 } ],
21824 "summary" : "Get single userCollectionArtist.",
21825 "tags" : [ "userCollectionArtists" ],
21826 "x-path-item-properties" : {
21827 "required-access-tier" : "THIRD_PARTY"
21828 }
21829 }
21830 },
21831 "/userCollectionArtists/{id}/relationships/items" : {
21832 "delete" : {
21833 "description" : "Deletes item(s) from items relationship.",
21834 "parameters" : [ {
21835 "description" : "User collection artists id. Use `me` for the authenticated user's resource",
21836 "example" : "me",
21837 "in" : "path",
21838 "name" : "id",
21839 "required" : true,
21840 "schema" : {
21841 "type" : "string"
21842 }
21843 }, {
21844 "$ref" : "#/components/parameters/IdempotencyKey"
21845 } ],
21846 "requestBody" : {
21847 "content" : {
21848 "application/vnd.api+json" : {
21849 "schema" : {
21850 "$ref" : "#/components/schemas/UserCollectionArtistsItemsRelationshipRemoveOperation_Payload"
21851 }
21852 }
21853 }
21854 },
21855 "responses" : {
21856 "400" : {
21857 "$ref" : "#/components/responses/Default400Response"
21858 },
21859 "404" : {
21860 "$ref" : "#/components/responses/Default404Response"
21861 },
21862 "405" : {
21863 "$ref" : "#/components/responses/Default405Response"
21864 },
21865 "406" : {
21866 "$ref" : "#/components/responses/Default406Response"
21867 },
21868 "409" : {
21869 "$ref" : "#/components/responses/Idempotency409Response"
21870 },
21871 "415" : {
21872 "$ref" : "#/components/responses/Default415Response"
21873 },
21874 "422" : {
21875 "$ref" : "#/components/responses/Idempotency422Response"
21876 },
21877 "429" : {
21878 "$ref" : "#/components/responses/Default429Response"
21879 },
21880 "500" : {
21881 "$ref" : "#/components/responses/Default500Response"
21882 },
21883 "503" : {
21884 "$ref" : "#/components/responses/Default503Response"
21885 }
21886 },
21887 "security" : [ {
21888 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
21889 } ],
21890 "summary" : "Delete from items relationship (\"to-many\").",
21891 "tags" : [ "userCollectionArtists" ],
21892 "x-path-item-properties" : {
21893 "required-access-tier" : "THIRD_PARTY"
21894 }
21895 },
21896 "get" : {
21897 "description" : "Retrieves items relationship.",
21898 "parameters" : [ {
21899 "description" : "User collection artists id. Use `me` for the authenticated user's resource",
21900 "example" : "me",
21901 "in" : "path",
21902 "name" : "id",
21903 "required" : true,
21904 "schema" : {
21905 "type" : "string"
21906 }
21907 }, {
21908 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
21909 "in" : "query",
21910 "name" : "page[cursor]",
21911 "required" : false,
21912 "schema" : {
21913 "type" : "string"
21914 }
21915 }, {
21916 "description" : "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
21917 "in" : "query",
21918 "name" : "sort",
21919 "required" : false,
21920 "schema" : {
21921 "type" : "array",
21922 "items" : {
21923 "type" : "string",
21924 "example" : "addedAt",
21925 "default" : "-addedAt",
21926 "enum" : [ "addedAt", "-addedAt", "name", "-name" ],
21927 "x-enum-varnames" : [ "AddedAtAsc", "AddedAtDesc", "NameAsc", "NameDesc" ]
21928 }
21929 }
21930 }, {
21931 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
21932 "example" : "en-US",
21933 "in" : "query",
21934 "name" : "locale",
21935 "required" : false,
21936 "schema" : {
21937 "type" : "string",
21938 "default" : "en-US"
21939 }
21940 }, {
21941 "description" : "Allows the client to customize which related resources should be returned. Available options: items",
21942 "example" : "items.albums",
21943 "in" : "query",
21944 "name" : "include",
21945 "required" : false,
21946 "schema" : {
21947 "type" : "array",
21948 "items" : {
21949 "type" : "string",
21950 "example" : "items.albums"
21951 }
21952 }
21953 }, {
21954 "description" : "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",
21955 "example" : "items.albums",
21956 "in" : "query",
21957 "name" : "replaceMedia",
21958 "required" : false,
21959 "schema" : {
21960 "type" : "string",
21961 "example" : "items.albums"
21962 }
21963 } ],
21964 "responses" : {
21965 "200" : {
21966 "content" : {
21967 "application/vnd.api+json" : {
21968 "schema" : {
21969 "$ref" : "#/components/schemas/UserCollectionArtists_Items_Multi_Relationship_Data_Document"
21970 }
21971 }
21972 },
21973 "description" : "Successful response"
21974 },
21975 "400" : {
21976 "$ref" : "#/components/responses/Default400Response"
21977 },
21978 "404" : {
21979 "$ref" : "#/components/responses/Default404Response"
21980 },
21981 "405" : {
21982 "$ref" : "#/components/responses/Default405Response"
21983 },
21984 "406" : {
21985 "$ref" : "#/components/responses/Default406Response"
21986 },
21987 "415" : {
21988 "$ref" : "#/components/responses/Default415Response"
21989 },
21990 "429" : {
21991 "$ref" : "#/components/responses/Default429Response"
21992 },
21993 "500" : {
21994 "$ref" : "#/components/responses/Default500Response"
21995 },
21996 "503" : {
21997 "$ref" : "#/components/responses/Default503Response"
21998 }
21999 },
22000 "security" : [ {
22001 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
22002 } ],
22003 "summary" : "Get items relationship (\"to-many\").",
22004 "tags" : [ "userCollectionArtists" ],
22005 "x-path-item-properties" : {
22006 "required-access-tier" : "THIRD_PARTY"
22007 }
22008 },
22009 "post" : {
22010 "description" : "Adds item(s) to items relationship.",
22011 "parameters" : [ {
22012 "description" : "User collection artists id. Use `me` for the authenticated user's resource",
22013 "example" : "me",
22014 "in" : "path",
22015 "name" : "id",
22016 "required" : true,
22017 "schema" : {
22018 "type" : "string"
22019 }
22020 }, {
22021 "$ref" : "#/components/parameters/IdempotencyKey"
22022 } ],
22023 "requestBody" : {
22024 "content" : {
22025 "application/vnd.api+json" : {
22026 "schema" : {
22027 "$ref" : "#/components/schemas/UserCollectionArtistsItemsRelationshipAddOperation_Payload"
22028 }
22029 }
22030 }
22031 },
22032 "responses" : {
22033 "200" : {
22034 "content" : {
22035 "application/vnd.api+json" : {
22036 "schema" : {
22037 "$ref" : "#/components/schemas/UserCollectionArtists_Items_Add_Multi_Relationship_Data_Document"
22038 }
22039 }
22040 },
22041 "description" : "Successful response"
22042 },
22043 "400" : {
22044 "$ref" : "#/components/responses/Default400Response"
22045 },
22046 "404" : {
22047 "$ref" : "#/components/responses/Default404Response"
22048 },
22049 "405" : {
22050 "$ref" : "#/components/responses/Default405Response"
22051 },
22052 "406" : {
22053 "$ref" : "#/components/responses/Default406Response"
22054 },
22055 "409" : {
22056 "$ref" : "#/components/responses/UserCollectionArtistsAddMultiDataRelationshipWithResponse409Response"
22057 },
22058 "415" : {
22059 "$ref" : "#/components/responses/Default415Response"
22060 },
22061 "422" : {
22062 "$ref" : "#/components/responses/Idempotency422Response"
22063 },
22064 "429" : {
22065 "$ref" : "#/components/responses/Default429Response"
22066 },
22067 "500" : {
22068 "$ref" : "#/components/responses/Default500Response"
22069 },
22070 "503" : {
22071 "$ref" : "#/components/responses/Default503Response"
22072 }
22073 },
22074 "security" : [ {
22075 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
22076 } ],
22077 "summary" : "Add to items relationship (\"to-many\").",
22078 "tags" : [ "userCollectionArtists" ],
22079 "x-path-item-properties" : {
22080 "required-access-tier" : "THIRD_PARTY"
22081 }
22082 }
22083 },
22084 "/userCollectionArtists/{id}/relationships/owners" : {
22085 "get" : {
22086 "description" : "Retrieves owners relationship.",
22087 "parameters" : [ {
22088 "description" : "User collection artists id. Use `me` for the authenticated user's resource",
22089 "example" : "me",
22090 "in" : "path",
22091 "name" : "id",
22092 "required" : true,
22093 "schema" : {
22094 "type" : "string"
22095 }
22096 }, {
22097 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
22098 "example" : "owners",
22099 "in" : "query",
22100 "name" : "include",
22101 "required" : false,
22102 "schema" : {
22103 "type" : "array",
22104 "items" : {
22105 "type" : "string",
22106 "example" : "owners"
22107 }
22108 }
22109 }, {
22110 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
22111 "in" : "query",
22112 "name" : "page[cursor]",
22113 "required" : false,
22114 "schema" : {
22115 "type" : "string"
22116 }
22117 } ],
22118 "responses" : {
22119 "200" : {
22120 "content" : {
22121 "application/vnd.api+json" : {
22122 "schema" : {
22123 "$ref" : "#/components/schemas/UserCollectionArtists_Multi_Relationship_Data_Document"
22124 }
22125 }
22126 },
22127 "description" : "Successful response"
22128 },
22129 "400" : {
22130 "$ref" : "#/components/responses/Default400Response"
22131 },
22132 "404" : {
22133 "$ref" : "#/components/responses/Default404Response"
22134 },
22135 "405" : {
22136 "$ref" : "#/components/responses/Default405Response"
22137 },
22138 "406" : {
22139 "$ref" : "#/components/responses/Default406Response"
22140 },
22141 "415" : {
22142 "$ref" : "#/components/responses/Default415Response"
22143 },
22144 "429" : {
22145 "$ref" : "#/components/responses/Default429Response"
22146 },
22147 "500" : {
22148 "$ref" : "#/components/responses/Default500Response"
22149 },
22150 "503" : {
22151 "$ref" : "#/components/responses/Default503Response"
22152 }
22153 },
22154 "security" : [ {
22155 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
22156 } ],
22157 "summary" : "Get owners relationship (\"to-many\").",
22158 "tags" : [ "userCollectionArtists" ],
22159 "x-path-item-properties" : {
22160 "required-access-tier" : "THIRD_PARTY"
22161 }
22162 }
22163 },
22164 "/userCollectionFolders" : {
22165 "get" : {
22166 "description" : "Retrieves multiple userCollectionFolders by available filters, or without if applicable.",
22167 "parameters" : [ {
22168 "description" : "Folder Id (e.g. `CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX`)",
22169 "in" : "query",
22170 "name" : "filter[id]",
22171 "required" : true,
22172 "schema" : {
22173 "type" : "array",
22174 "items" : {
22175 "type" : "string"
22176 }
22177 }
22178 }, {
22179 "description" : "Allows the client to customize which related resources should be returned. Available options: items, owners, userCollection",
22180 "example" : "items.items",
22181 "in" : "query",
22182 "name" : "include",
22183 "required" : false,
22184 "schema" : {
22185 "type" : "array",
22186 "items" : {
22187 "type" : "string",
22188 "example" : "items.items"
22189 }
22190 }
22191 }, {
22192 "description" : "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",
22193 "example" : "items.items",
22194 "in" : "query",
22195 "name" : "replaceMedia",
22196 "required" : false,
22197 "schema" : {
22198 "type" : "string",
22199 "example" : "items.items"
22200 }
22201 } ],
22202 "responses" : {
22203 "200" : {
22204 "content" : {
22205 "application/vnd.api+json" : {
22206 "schema" : {
22207 "$ref" : "#/components/schemas/UserCollectionFolders_Multi_Resource_Data_Document"
22208 }
22209 }
22210 },
22211 "description" : "Successful response"
22212 },
22213 "400" : {
22214 "$ref" : "#/components/responses/Default400Response"
22215 },
22216 "404" : {
22217 "$ref" : "#/components/responses/Default404Response"
22218 },
22219 "405" : {
22220 "$ref" : "#/components/responses/Default405Response"
22221 },
22222 "406" : {
22223 "$ref" : "#/components/responses/Default406Response"
22224 },
22225 "415" : {
22226 "$ref" : "#/components/responses/Default415Response"
22227 },
22228 "429" : {
22229 "$ref" : "#/components/responses/Default429Response"
22230 },
22231 "500" : {
22232 "$ref" : "#/components/responses/Default500Response"
22233 },
22234 "503" : {
22235 "$ref" : "#/components/responses/Default503Response"
22236 }
22237 },
22238 "security" : [ {
22239 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
22240 } ],
22241 "summary" : "Get multiple userCollectionFolders.",
22242 "tags" : [ "userCollectionFolders" ],
22243 "x-path-item-properties" : {
22244 "required-access-tier" : "INTERNAL"
22245 }
22246 },
22247 "post" : {
22248 "description" : "Creates a new userCollectionFolder.",
22249 "parameters" : [ {
22250 "$ref" : "#/components/parameters/IdempotencyKey"
22251 } ],
22252 "requestBody" : {
22253 "content" : {
22254 "application/vnd.api+json" : {
22255 "schema" : {
22256 "$ref" : "#/components/schemas/UserCollectionFoldersCreateOperation_Payload"
22257 }
22258 }
22259 }
22260 },
22261 "responses" : {
22262 "201" : {
22263 "content" : {
22264 "application/vnd.api+json" : {
22265 "schema" : {
22266 "$ref" : "#/components/schemas/UserCollectionFolders_Create_Single_Resource_Data_Document"
22267 }
22268 }
22269 },
22270 "description" : "Successful response"
22271 },
22272 "400" : {
22273 "$ref" : "#/components/responses/Default400Response"
22274 },
22275 "404" : {
22276 "$ref" : "#/components/responses/Default404Response"
22277 },
22278 "405" : {
22279 "$ref" : "#/components/responses/Default405Response"
22280 },
22281 "406" : {
22282 "$ref" : "#/components/responses/Default406Response"
22283 },
22284 "409" : {
22285 "$ref" : "#/components/responses/Idempotency409Response"
22286 },
22287 "415" : {
22288 "$ref" : "#/components/responses/Default415Response"
22289 },
22290 "422" : {
22291 "$ref" : "#/components/responses/Idempotency422Response"
22292 },
22293 "429" : {
22294 "$ref" : "#/components/responses/Default429Response"
22295 },
22296 "500" : {
22297 "$ref" : "#/components/responses/Default500Response"
22298 },
22299 "503" : {
22300 "$ref" : "#/components/responses/Default503Response"
22301 }
22302 },
22303 "security" : [ {
22304 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
22305 } ],
22306 "summary" : "Create single userCollectionFolder.",
22307 "tags" : [ "userCollectionFolders" ],
22308 "x-path-item-properties" : {
22309 "required-access-tier" : "INTERNAL"
22310 }
22311 }
22312 },
22313 "/userCollectionFolders/{id}" : {
22314 "delete" : {
22315 "description" : "Deletes existing userCollectionFolder.",
22316 "parameters" : [ {
22317 "description" : "Folder Id",
22318 "example" : "CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX",
22319 "in" : "path",
22320 "name" : "id",
22321 "required" : true,
22322 "schema" : {
22323 "type" : "string"
22324 }
22325 }, {
22326 "$ref" : "#/components/parameters/IdempotencyKey"
22327 } ],
22328 "responses" : {
22329 "400" : {
22330 "$ref" : "#/components/responses/UserCollectionFoldersDeleteResource400Response"
22331 },
22332 "404" : {
22333 "$ref" : "#/components/responses/Default404Response"
22334 },
22335 "405" : {
22336 "$ref" : "#/components/responses/Default405Response"
22337 },
22338 "406" : {
22339 "$ref" : "#/components/responses/Default406Response"
22340 },
22341 "409" : {
22342 "$ref" : "#/components/responses/Idempotency409Response"
22343 },
22344 "415" : {
22345 "$ref" : "#/components/responses/Default415Response"
22346 },
22347 "422" : {
22348 "$ref" : "#/components/responses/Idempotency422Response"
22349 },
22350 "429" : {
22351 "$ref" : "#/components/responses/Default429Response"
22352 },
22353 "500" : {
22354 "$ref" : "#/components/responses/Default500Response"
22355 },
22356 "503" : {
22357 "$ref" : "#/components/responses/Default503Response"
22358 }
22359 },
22360 "security" : [ {
22361 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
22362 } ],
22363 "summary" : "Delete single userCollectionFolder.",
22364 "tags" : [ "userCollectionFolders" ],
22365 "x-path-item-properties" : {
22366 "required-access-tier" : "INTERNAL"
22367 }
22368 },
22369 "get" : {
22370 "description" : "Retrieves single userCollectionFolder by id.",
22371 "parameters" : [ {
22372 "description" : "Folder Id",
22373 "example" : "CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX",
22374 "in" : "path",
22375 "name" : "id",
22376 "required" : true,
22377 "schema" : {
22378 "type" : "string"
22379 }
22380 }, {
22381 "description" : "Allows the client to customize which related resources should be returned. Available options: items, owners, userCollection",
22382 "example" : "items.items",
22383 "in" : "query",
22384 "name" : "include",
22385 "required" : false,
22386 "schema" : {
22387 "type" : "array",
22388 "items" : {
22389 "type" : "string",
22390 "example" : "items.items"
22391 }
22392 }
22393 }, {
22394 "description" : "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",
22395 "example" : "items.items",
22396 "in" : "query",
22397 "name" : "replaceMedia",
22398 "required" : false,
22399 "schema" : {
22400 "type" : "string",
22401 "example" : "items.items"
22402 }
22403 } ],
22404 "responses" : {
22405 "200" : {
22406 "content" : {
22407 "application/vnd.api+json" : {
22408 "schema" : {
22409 "$ref" : "#/components/schemas/UserCollectionFolders_Single_Resource_Data_Document"
22410 }
22411 }
22412 },
22413 "description" : "Successful response"
22414 },
22415 "400" : {
22416 "$ref" : "#/components/responses/Default400Response"
22417 },
22418 "404" : {
22419 "$ref" : "#/components/responses/Default404Response"
22420 },
22421 "405" : {
22422 "$ref" : "#/components/responses/Default405Response"
22423 },
22424 "406" : {
22425 "$ref" : "#/components/responses/Default406Response"
22426 },
22427 "415" : {
22428 "$ref" : "#/components/responses/Default415Response"
22429 },
22430 "429" : {
22431 "$ref" : "#/components/responses/Default429Response"
22432 },
22433 "500" : {
22434 "$ref" : "#/components/responses/Default500Response"
22435 },
22436 "503" : {
22437 "$ref" : "#/components/responses/Default503Response"
22438 }
22439 },
22440 "security" : [ {
22441 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
22442 } ],
22443 "summary" : "Get single userCollectionFolder.",
22444 "tags" : [ "userCollectionFolders" ],
22445 "x-path-item-properties" : {
22446 "required-access-tier" : "INTERNAL"
22447 }
22448 },
22449 "patch" : {
22450 "description" : "Updates existing userCollectionFolder.",
22451 "parameters" : [ {
22452 "description" : "Folder Id",
22453 "example" : "CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX",
22454 "in" : "path",
22455 "name" : "id",
22456 "required" : true,
22457 "schema" : {
22458 "type" : "string"
22459 }
22460 }, {
22461 "$ref" : "#/components/parameters/IdempotencyKey"
22462 } ],
22463 "requestBody" : {
22464 "content" : {
22465 "application/vnd.api+json" : {
22466 "schema" : {
22467 "$ref" : "#/components/schemas/UserCollectionFoldersUpdateOperation_Payload"
22468 }
22469 }
22470 }
22471 },
22472 "responses" : {
22473 "400" : {
22474 "$ref" : "#/components/responses/Default400Response"
22475 },
22476 "404" : {
22477 "$ref" : "#/components/responses/Default404Response"
22478 },
22479 "405" : {
22480 "$ref" : "#/components/responses/Default405Response"
22481 },
22482 "406" : {
22483 "$ref" : "#/components/responses/Default406Response"
22484 },
22485 "409" : {
22486 "$ref" : "#/components/responses/Idempotency409Response"
22487 },
22488 "415" : {
22489 "$ref" : "#/components/responses/Default415Response"
22490 },
22491 "422" : {
22492 "$ref" : "#/components/responses/Idempotency422Response"
22493 },
22494 "429" : {
22495 "$ref" : "#/components/responses/Default429Response"
22496 },
22497 "500" : {
22498 "$ref" : "#/components/responses/Default500Response"
22499 },
22500 "503" : {
22501 "$ref" : "#/components/responses/Default503Response"
22502 }
22503 },
22504 "security" : [ {
22505 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
22506 } ],
22507 "summary" : "Update single userCollectionFolder.",
22508 "tags" : [ "userCollectionFolders" ],
22509 "x-path-item-properties" : {
22510 "required-access-tier" : "INTERNAL"
22511 }
22512 }
22513 },
22514 "/userCollectionFolders/{id}/relationships/items" : {
22515 "delete" : {
22516 "description" : "Deletes item(s) from items relationship.",
22517 "parameters" : [ {
22518 "description" : "Folder Id",
22519 "example" : "CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX",
22520 "in" : "path",
22521 "name" : "id",
22522 "required" : true,
22523 "schema" : {
22524 "type" : "string"
22525 }
22526 }, {
22527 "$ref" : "#/components/parameters/IdempotencyKey"
22528 } ],
22529 "requestBody" : {
22530 "content" : {
22531 "application/vnd.api+json" : {
22532 "schema" : {
22533 "$ref" : "#/components/schemas/UserCollectionFoldersItemsRelationshipRemoveOperation_Payload"
22534 }
22535 }
22536 }
22537 },
22538 "responses" : {
22539 "400" : {
22540 "$ref" : "#/components/responses/Default400Response"
22541 },
22542 "404" : {
22543 "$ref" : "#/components/responses/Default404Response"
22544 },
22545 "405" : {
22546 "$ref" : "#/components/responses/Default405Response"
22547 },
22548 "406" : {
22549 "$ref" : "#/components/responses/Default406Response"
22550 },
22551 "409" : {
22552 "$ref" : "#/components/responses/Idempotency409Response"
22553 },
22554 "415" : {
22555 "$ref" : "#/components/responses/Default415Response"
22556 },
22557 "422" : {
22558 "$ref" : "#/components/responses/Idempotency422Response"
22559 },
22560 "429" : {
22561 "$ref" : "#/components/responses/Default429Response"
22562 },
22563 "500" : {
22564 "$ref" : "#/components/responses/Default500Response"
22565 },
22566 "503" : {
22567 "$ref" : "#/components/responses/Default503Response"
22568 }
22569 },
22570 "security" : [ {
22571 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
22572 } ],
22573 "summary" : "Delete from items relationship (\"to-many\").",
22574 "tags" : [ "userCollectionFolders" ],
22575 "x-path-item-properties" : {
22576 "required-access-tier" : "INTERNAL"
22577 }
22578 },
22579 "get" : {
22580 "description" : "Retrieves items relationship.",
22581 "parameters" : [ {
22582 "description" : "Folder Id",
22583 "example" : "CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX",
22584 "in" : "path",
22585 "name" : "id",
22586 "required" : true,
22587 "schema" : {
22588 "type" : "string"
22589 }
22590 }, {
22591 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
22592 "in" : "query",
22593 "name" : "page[cursor]",
22594 "required" : false,
22595 "schema" : {
22596 "type" : "string"
22597 }
22598 }, {
22599 "description" : "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
22600 "in" : "query",
22601 "name" : "sort",
22602 "required" : false,
22603 "schema" : {
22604 "type" : "array",
22605 "items" : {
22606 "type" : "string",
22607 "example" : "addedAt",
22608 "default" : "addedAt",
22609 "enum" : [ "addedAt", "-addedAt", "lastModifiedAt", "-lastModifiedAt", "name", "-name" ],
22610 "x-enum-varnames" : [ "AddedAtAsc", "AddedAtDesc", "LastModifiedAtAsc", "LastModifiedAtDesc", "NameAsc", "NameDesc" ]
22611 }
22612 }
22613 }, {
22614 "description" : "Allows the client to customize which related resources should be returned. Available options: items",
22615 "example" : "items.items",
22616 "in" : "query",
22617 "name" : "include",
22618 "required" : false,
22619 "schema" : {
22620 "type" : "array",
22621 "items" : {
22622 "type" : "string",
22623 "example" : "items.items"
22624 }
22625 }
22626 }, {
22627 "description" : "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",
22628 "example" : "items.items",
22629 "in" : "query",
22630 "name" : "replaceMedia",
22631 "required" : false,
22632 "schema" : {
22633 "type" : "string",
22634 "example" : "items.items"
22635 }
22636 } ],
22637 "responses" : {
22638 "200" : {
22639 "content" : {
22640 "application/vnd.api+json" : {
22641 "schema" : {
22642 "$ref" : "#/components/schemas/UserCollectionFolders_Items_Multi_Relationship_Data_Document"
22643 }
22644 }
22645 },
22646 "description" : "Successful response"
22647 },
22648 "400" : {
22649 "$ref" : "#/components/responses/Default400Response"
22650 },
22651 "404" : {
22652 "$ref" : "#/components/responses/Default404Response"
22653 },
22654 "405" : {
22655 "$ref" : "#/components/responses/Default405Response"
22656 },
22657 "406" : {
22658 "$ref" : "#/components/responses/Default406Response"
22659 },
22660 "415" : {
22661 "$ref" : "#/components/responses/Default415Response"
22662 },
22663 "429" : {
22664 "$ref" : "#/components/responses/Default429Response"
22665 },
22666 "500" : {
22667 "$ref" : "#/components/responses/Default500Response"
22668 },
22669 "503" : {
22670 "$ref" : "#/components/responses/Default503Response"
22671 }
22672 },
22673 "security" : [ {
22674 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
22675 } ],
22676 "summary" : "Get items relationship (\"to-many\").",
22677 "tags" : [ "userCollectionFolders" ],
22678 "x-path-item-properties" : {
22679 "required-access-tier" : "INTERNAL"
22680 }
22681 },
22682 "post" : {
22683 "description" : "Adds item(s) to items relationship.",
22684 "parameters" : [ {
22685 "description" : "Folder Id",
22686 "example" : "CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX",
22687 "in" : "path",
22688 "name" : "id",
22689 "required" : true,
22690 "schema" : {
22691 "type" : "string"
22692 }
22693 }, {
22694 "$ref" : "#/components/parameters/IdempotencyKey"
22695 } ],
22696 "requestBody" : {
22697 "content" : {
22698 "application/vnd.api+json" : {
22699 "schema" : {
22700 "$ref" : "#/components/schemas/UserCollectionFoldersItemsRelationshipAddOperation_Payload"
22701 }
22702 }
22703 }
22704 },
22705 "responses" : {
22706 "201" : {
22707 "description" : "Successful response"
22708 },
22709 "400" : {
22710 "$ref" : "#/components/responses/Default400Response"
22711 },
22712 "404" : {
22713 "$ref" : "#/components/responses/Default404Response"
22714 },
22715 "405" : {
22716 "$ref" : "#/components/responses/Default405Response"
22717 },
22718 "406" : {
22719 "$ref" : "#/components/responses/Default406Response"
22720 },
22721 "409" : {
22722 "$ref" : "#/components/responses/Idempotency409Response"
22723 },
22724 "415" : {
22725 "$ref" : "#/components/responses/Default415Response"
22726 },
22727 "422" : {
22728 "$ref" : "#/components/responses/Idempotency422Response"
22729 },
22730 "429" : {
22731 "$ref" : "#/components/responses/Default429Response"
22732 },
22733 "500" : {
22734 "$ref" : "#/components/responses/Default500Response"
22735 },
22736 "503" : {
22737 "$ref" : "#/components/responses/Default503Response"
22738 }
22739 },
22740 "security" : [ {
22741 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
22742 } ],
22743 "summary" : "Add to items relationship (\"to-many\").",
22744 "tags" : [ "userCollectionFolders" ],
22745 "x-path-item-properties" : {
22746 "required-access-tier" : "INTERNAL"
22747 }
22748 }
22749 },
22750 "/userCollectionFolders/{id}/relationships/owners" : {
22751 "get" : {
22752 "description" : "Retrieves owners relationship.",
22753 "parameters" : [ {
22754 "description" : "Folder Id",
22755 "example" : "CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX",
22756 "in" : "path",
22757 "name" : "id",
22758 "required" : true,
22759 "schema" : {
22760 "type" : "string"
22761 }
22762 }, {
22763 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
22764 "example" : "owners",
22765 "in" : "query",
22766 "name" : "include",
22767 "required" : false,
22768 "schema" : {
22769 "type" : "array",
22770 "items" : {
22771 "type" : "string",
22772 "example" : "owners"
22773 }
22774 }
22775 }, {
22776 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
22777 "in" : "query",
22778 "name" : "page[cursor]",
22779 "required" : false,
22780 "schema" : {
22781 "type" : "string"
22782 }
22783 } ],
22784 "responses" : {
22785 "200" : {
22786 "content" : {
22787 "application/vnd.api+json" : {
22788 "schema" : {
22789 "$ref" : "#/components/schemas/UserCollectionFolders_Multi_Relationship_Data_Document"
22790 }
22791 }
22792 },
22793 "description" : "Successful response"
22794 },
22795 "400" : {
22796 "$ref" : "#/components/responses/Default400Response"
22797 },
22798 "404" : {
22799 "$ref" : "#/components/responses/Default404Response"
22800 },
22801 "405" : {
22802 "$ref" : "#/components/responses/Default405Response"
22803 },
22804 "406" : {
22805 "$ref" : "#/components/responses/Default406Response"
22806 },
22807 "415" : {
22808 "$ref" : "#/components/responses/Default415Response"
22809 },
22810 "429" : {
22811 "$ref" : "#/components/responses/Default429Response"
22812 },
22813 "500" : {
22814 "$ref" : "#/components/responses/Default500Response"
22815 },
22816 "503" : {
22817 "$ref" : "#/components/responses/Default503Response"
22818 }
22819 },
22820 "security" : [ {
22821 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
22822 } ],
22823 "summary" : "Get owners relationship (\"to-many\").",
22824 "tags" : [ "userCollectionFolders" ],
22825 "x-path-item-properties" : {
22826 "required-access-tier" : "INTERNAL"
22827 }
22828 }
22829 },
22830 "/userCollectionFolders/{id}/relationships/userCollection" : {
22831 "get" : {
22832 "description" : "Retrieves userCollection relationship.",
22833 "parameters" : [ {
22834 "description" : "Folder Id",
22835 "example" : "CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX",
22836 "in" : "path",
22837 "name" : "id",
22838 "required" : true,
22839 "schema" : {
22840 "type" : "string"
22841 }
22842 }, {
22843 "description" : "Allows the client to customize which related resources should be returned. Available options: userCollection",
22844 "example" : "userCollection.items.items",
22845 "in" : "query",
22846 "name" : "include",
22847 "required" : false,
22848 "schema" : {
22849 "type" : "array",
22850 "items" : {
22851 "type" : "string",
22852 "example" : "userCollection.items.items"
22853 }
22854 }
22855 }, {
22856 "description" : "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",
22857 "example" : "userCollection.items.items",
22858 "in" : "query",
22859 "name" : "replaceMedia",
22860 "required" : false,
22861 "schema" : {
22862 "type" : "string",
22863 "example" : "userCollection.items.items"
22864 }
22865 } ],
22866 "responses" : {
22867 "200" : {
22868 "content" : {
22869 "application/vnd.api+json" : {
22870 "schema" : {
22871 "$ref" : "#/components/schemas/UserCollectionFolders_Single_Relationship_Data_Document"
22872 }
22873 }
22874 },
22875 "description" : "Successful response"
22876 },
22877 "400" : {
22878 "$ref" : "#/components/responses/Default400Response"
22879 },
22880 "404" : {
22881 "$ref" : "#/components/responses/Default404Response"
22882 },
22883 "405" : {
22884 "$ref" : "#/components/responses/Default405Response"
22885 },
22886 "406" : {
22887 "$ref" : "#/components/responses/Default406Response"
22888 },
22889 "415" : {
22890 "$ref" : "#/components/responses/Default415Response"
22891 },
22892 "429" : {
22893 "$ref" : "#/components/responses/Default429Response"
22894 },
22895 "500" : {
22896 "$ref" : "#/components/responses/Default500Response"
22897 },
22898 "503" : {
22899 "$ref" : "#/components/responses/Default503Response"
22900 }
22901 },
22902 "security" : [ {
22903 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
22904 } ],
22905 "summary" : "Get userCollection relationship (\"to-one\").",
22906 "tags" : [ "userCollectionFolders" ],
22907 "x-path-item-properties" : {
22908 "required-access-tier" : "INTERNAL"
22909 }
22910 }
22911 },
22912 "/userCollectionPlaylists/{id}" : {
22913 "get" : {
22914 "description" : "Retrieves single userCollectionPlaylist by id.",
22915 "parameters" : [ {
22916 "description" : "User collection playlists id. Use `me` for the authenticated user's resource",
22917 "example" : "me",
22918 "in" : "path",
22919 "name" : "id",
22920 "required" : true,
22921 "schema" : {
22922 "type" : "string"
22923 }
22924 }, {
22925 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
22926 "example" : "en-US",
22927 "in" : "query",
22928 "name" : "locale",
22929 "required" : false,
22930 "schema" : {
22931 "type" : "string",
22932 "default" : "en-US"
22933 }
22934 }, {
22935 "description" : "Allows the client to customize which related resources should be returned. Available options: items, owners",
22936 "example" : "items.items",
22937 "in" : "query",
22938 "name" : "include",
22939 "required" : false,
22940 "schema" : {
22941 "type" : "array",
22942 "items" : {
22943 "type" : "string",
22944 "example" : "items.items"
22945 }
22946 }
22947 }, {
22948 "description" : "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",
22949 "example" : "items.items",
22950 "in" : "query",
22951 "name" : "replaceMedia",
22952 "required" : false,
22953 "schema" : {
22954 "type" : "string",
22955 "example" : "items.items"
22956 }
22957 } ],
22958 "responses" : {
22959 "200" : {
22960 "content" : {
22961 "application/vnd.api+json" : {
22962 "schema" : {
22963 "$ref" : "#/components/schemas/UserCollectionPlaylists_Single_Resource_Data_Document"
22964 }
22965 }
22966 },
22967 "description" : "Successful response"
22968 },
22969 "400" : {
22970 "$ref" : "#/components/responses/Default400Response"
22971 },
22972 "404" : {
22973 "$ref" : "#/components/responses/Default404Response"
22974 },
22975 "405" : {
22976 "$ref" : "#/components/responses/Default405Response"
22977 },
22978 "406" : {
22979 "$ref" : "#/components/responses/Default406Response"
22980 },
22981 "415" : {
22982 "$ref" : "#/components/responses/Default415Response"
22983 },
22984 "429" : {
22985 "$ref" : "#/components/responses/Default429Response"
22986 },
22987 "500" : {
22988 "$ref" : "#/components/responses/Default500Response"
22989 },
22990 "503" : {
22991 "$ref" : "#/components/responses/Default503Response"
22992 }
22993 },
22994 "security" : [ {
22995 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
22996 } ],
22997 "summary" : "Get single userCollectionPlaylist.",
22998 "tags" : [ "userCollectionPlaylists" ],
22999 "x-path-item-properties" : {
23000 "required-access-tier" : "THIRD_PARTY"
23001 }
23002 }
23003 },
23004 "/userCollectionPlaylists/{id}/relationships/items" : {
23005 "delete" : {
23006 "description" : "Deletes item(s) from items relationship.",
23007 "parameters" : [ {
23008 "description" : "User collection playlists id. Use `me` for the authenticated user's resource",
23009 "example" : "me",
23010 "in" : "path",
23011 "name" : "id",
23012 "required" : true,
23013 "schema" : {
23014 "type" : "string"
23015 }
23016 }, {
23017 "$ref" : "#/components/parameters/IdempotencyKey"
23018 } ],
23019 "requestBody" : {
23020 "content" : {
23021 "application/vnd.api+json" : {
23022 "schema" : {
23023 "$ref" : "#/components/schemas/UserCollectionPlaylistsItemsRelationshipRemoveOperation_Payload"
23024 }
23025 }
23026 }
23027 },
23028 "responses" : {
23029 "400" : {
23030 "$ref" : "#/components/responses/Default400Response"
23031 },
23032 "404" : {
23033 "$ref" : "#/components/responses/Default404Response"
23034 },
23035 "405" : {
23036 "$ref" : "#/components/responses/Default405Response"
23037 },
23038 "406" : {
23039 "$ref" : "#/components/responses/Default406Response"
23040 },
23041 "409" : {
23042 "$ref" : "#/components/responses/Idempotency409Response"
23043 },
23044 "415" : {
23045 "$ref" : "#/components/responses/Default415Response"
23046 },
23047 "422" : {
23048 "$ref" : "#/components/responses/Idempotency422Response"
23049 },
23050 "429" : {
23051 "$ref" : "#/components/responses/Default429Response"
23052 },
23053 "500" : {
23054 "$ref" : "#/components/responses/Default500Response"
23055 },
23056 "503" : {
23057 "$ref" : "#/components/responses/Default503Response"
23058 }
23059 },
23060 "security" : [ {
23061 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
23062 } ],
23063 "summary" : "Delete from items relationship (\"to-many\").",
23064 "tags" : [ "userCollectionPlaylists" ],
23065 "x-path-item-properties" : {
23066 "required-access-tier" : "THIRD_PARTY"
23067 }
23068 },
23069 "get" : {
23070 "description" : "Retrieves items relationship.",
23071 "parameters" : [ {
23072 "description" : "User collection playlists id. Use `me` for the authenticated user's resource",
23073 "example" : "me",
23074 "in" : "path",
23075 "name" : "id",
23076 "required" : true,
23077 "schema" : {
23078 "type" : "string"
23079 }
23080 }, {
23081 "in" : "query",
23082 "name" : "collectionView",
23083 "required" : false,
23084 "schema" : {
23085 "type" : "string",
23086 "enum" : [ "FLAT", "FOLDERS" ]
23087 }
23088 }, {
23089 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
23090 "in" : "query",
23091 "name" : "page[cursor]",
23092 "required" : false,
23093 "schema" : {
23094 "type" : "string"
23095 }
23096 }, {
23097 "description" : "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
23098 "in" : "query",
23099 "name" : "sort",
23100 "required" : false,
23101 "schema" : {
23102 "type" : "array",
23103 "items" : {
23104 "type" : "string",
23105 "example" : "addedAt",
23106 "default" : "-addedAt",
23107 "enum" : [ "addedAt", "-addedAt", "lastModifiedAt", "-lastModifiedAt", "name", "-name" ],
23108 "x-enum-varnames" : [ "AddedAtAsc", "AddedAtDesc", "LastModifiedAtAsc", "LastModifiedAtDesc", "NameAsc", "NameDesc" ]
23109 }
23110 }
23111 }, {
23112 "description" : "Allows the client to customize which related resources should be returned. Available options: items",
23113 "example" : "items.items",
23114 "in" : "query",
23115 "name" : "include",
23116 "required" : false,
23117 "schema" : {
23118 "type" : "array",
23119 "items" : {
23120 "type" : "string",
23121 "example" : "items.items"
23122 }
23123 }
23124 }, {
23125 "description" : "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",
23126 "example" : "items.items",
23127 "in" : "query",
23128 "name" : "replaceMedia",
23129 "required" : false,
23130 "schema" : {
23131 "type" : "string",
23132 "example" : "items.items"
23133 }
23134 } ],
23135 "responses" : {
23136 "200" : {
23137 "content" : {
23138 "application/vnd.api+json" : {
23139 "schema" : {
23140 "$ref" : "#/components/schemas/UserCollectionPlaylists_Items_Multi_Relationship_Data_Document"
23141 }
23142 }
23143 },
23144 "description" : "Successful response"
23145 },
23146 "400" : {
23147 "$ref" : "#/components/responses/Default400Response"
23148 },
23149 "404" : {
23150 "$ref" : "#/components/responses/Default404Response"
23151 },
23152 "405" : {
23153 "$ref" : "#/components/responses/Default405Response"
23154 },
23155 "406" : {
23156 "$ref" : "#/components/responses/Default406Response"
23157 },
23158 "415" : {
23159 "$ref" : "#/components/responses/Default415Response"
23160 },
23161 "429" : {
23162 "$ref" : "#/components/responses/Default429Response"
23163 },
23164 "500" : {
23165 "$ref" : "#/components/responses/Default500Response"
23166 },
23167 "503" : {
23168 "$ref" : "#/components/responses/Default503Response"
23169 }
23170 },
23171 "security" : [ {
23172 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
23173 } ],
23174 "summary" : "Get items relationship (\"to-many\").",
23175 "tags" : [ "userCollectionPlaylists" ],
23176 "x-path-item-properties" : {
23177 "required-access-tier" : "THIRD_PARTY"
23178 }
23179 },
23180 "post" : {
23181 "description" : "Adds item(s) to items relationship.",
23182 "parameters" : [ {
23183 "description" : "User collection playlists id. Use `me` for the authenticated user's resource",
23184 "example" : "me",
23185 "in" : "path",
23186 "name" : "id",
23187 "required" : true,
23188 "schema" : {
23189 "type" : "string"
23190 }
23191 }, {
23192 "$ref" : "#/components/parameters/IdempotencyKey"
23193 } ],
23194 "requestBody" : {
23195 "content" : {
23196 "application/vnd.api+json" : {
23197 "schema" : {
23198 "$ref" : "#/components/schemas/UserCollectionPlaylistsItemsRelationshipAddOperation_Payload"
23199 }
23200 }
23201 }
23202 },
23203 "responses" : {
23204 "200" : {
23205 "content" : {
23206 "application/vnd.api+json" : {
23207 "schema" : {
23208 "$ref" : "#/components/schemas/UserCollectionPlaylists_Items_Add_Multi_Relationship_Data_Document"
23209 }
23210 }
23211 },
23212 "description" : "Successful response"
23213 },
23214 "400" : {
23215 "$ref" : "#/components/responses/Default400Response"
23216 },
23217 "404" : {
23218 "$ref" : "#/components/responses/Default404Response"
23219 },
23220 "405" : {
23221 "$ref" : "#/components/responses/Default405Response"
23222 },
23223 "406" : {
23224 "$ref" : "#/components/responses/Default406Response"
23225 },
23226 "409" : {
23227 "$ref" : "#/components/responses/UserCollectionPlaylistsAddMultiDataRelationshipWithResponse409Response"
23228 },
23229 "415" : {
23230 "$ref" : "#/components/responses/Default415Response"
23231 },
23232 "422" : {
23233 "$ref" : "#/components/responses/Idempotency422Response"
23234 },
23235 "429" : {
23236 "$ref" : "#/components/responses/Default429Response"
23237 },
23238 "500" : {
23239 "$ref" : "#/components/responses/Default500Response"
23240 },
23241 "503" : {
23242 "$ref" : "#/components/responses/Default503Response"
23243 }
23244 },
23245 "security" : [ {
23246 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
23247 } ],
23248 "summary" : "Add to items relationship (\"to-many\").",
23249 "tags" : [ "userCollectionPlaylists" ],
23250 "x-path-item-properties" : {
23251 "required-access-tier" : "THIRD_PARTY"
23252 }
23253 }
23254 },
23255 "/userCollectionPlaylists/{id}/relationships/owners" : {
23256 "get" : {
23257 "description" : "Retrieves owners relationship.",
23258 "parameters" : [ {
23259 "description" : "User collection playlists id. Use `me` for the authenticated user's resource",
23260 "example" : "me",
23261 "in" : "path",
23262 "name" : "id",
23263 "required" : true,
23264 "schema" : {
23265 "type" : "string"
23266 }
23267 }, {
23268 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
23269 "example" : "owners",
23270 "in" : "query",
23271 "name" : "include",
23272 "required" : false,
23273 "schema" : {
23274 "type" : "array",
23275 "items" : {
23276 "type" : "string",
23277 "example" : "owners"
23278 }
23279 }
23280 }, {
23281 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
23282 "in" : "query",
23283 "name" : "page[cursor]",
23284 "required" : false,
23285 "schema" : {
23286 "type" : "string"
23287 }
23288 } ],
23289 "responses" : {
23290 "200" : {
23291 "content" : {
23292 "application/vnd.api+json" : {
23293 "schema" : {
23294 "$ref" : "#/components/schemas/UserCollectionPlaylists_Multi_Relationship_Data_Document"
23295 }
23296 }
23297 },
23298 "description" : "Successful response"
23299 },
23300 "400" : {
23301 "$ref" : "#/components/responses/Default400Response"
23302 },
23303 "404" : {
23304 "$ref" : "#/components/responses/Default404Response"
23305 },
23306 "405" : {
23307 "$ref" : "#/components/responses/Default405Response"
23308 },
23309 "406" : {
23310 "$ref" : "#/components/responses/Default406Response"
23311 },
23312 "415" : {
23313 "$ref" : "#/components/responses/Default415Response"
23314 },
23315 "429" : {
23316 "$ref" : "#/components/responses/Default429Response"
23317 },
23318 "500" : {
23319 "$ref" : "#/components/responses/Default500Response"
23320 },
23321 "503" : {
23322 "$ref" : "#/components/responses/Default503Response"
23323 }
23324 },
23325 "security" : [ {
23326 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
23327 } ],
23328 "summary" : "Get owners relationship (\"to-many\").",
23329 "tags" : [ "userCollectionPlaylists" ],
23330 "x-path-item-properties" : {
23331 "required-access-tier" : "THIRD_PARTY"
23332 }
23333 }
23334 },
23335 "/userCollectionSaveForLaters/{id}" : {
23336 "get" : {
23337 "description" : "Retrieves single userCollectionSaveForLater by id.",
23338 "parameters" : [ {
23339 "description" : "User collection save for later id. Use `me` for the authenticated user's resource",
23340 "example" : "me",
23341 "in" : "path",
23342 "name" : "id",
23343 "required" : true,
23344 "schema" : {
23345 "type" : "string"
23346 }
23347 }, {
23348 "description" : "Allows the client to customize which related resources should be returned. Available options: items, owners",
23349 "example" : "items",
23350 "in" : "query",
23351 "name" : "include",
23352 "required" : false,
23353 "schema" : {
23354 "type" : "array",
23355 "items" : {
23356 "type" : "string",
23357 "example" : "items"
23358 }
23359 }
23360 }, {
23361 "description" : "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",
23362 "example" : "items",
23363 "in" : "query",
23364 "name" : "replaceMedia",
23365 "required" : false,
23366 "schema" : {
23367 "type" : "string",
23368 "example" : "items"
23369 }
23370 } ],
23371 "responses" : {
23372 "200" : {
23373 "content" : {
23374 "application/vnd.api+json" : {
23375 "schema" : {
23376 "$ref" : "#/components/schemas/UserCollectionSaveForLaters_Single_Resource_Data_Document"
23377 }
23378 }
23379 },
23380 "description" : "Successful response"
23381 },
23382 "400" : {
23383 "$ref" : "#/components/responses/Default400Response"
23384 },
23385 "404" : {
23386 "$ref" : "#/components/responses/Default404Response"
23387 },
23388 "405" : {
23389 "$ref" : "#/components/responses/Default405Response"
23390 },
23391 "406" : {
23392 "$ref" : "#/components/responses/Default406Response"
23393 },
23394 "415" : {
23395 "$ref" : "#/components/responses/Default415Response"
23396 },
23397 "429" : {
23398 "$ref" : "#/components/responses/Default429Response"
23399 },
23400 "500" : {
23401 "$ref" : "#/components/responses/Default500Response"
23402 },
23403 "503" : {
23404 "$ref" : "#/components/responses/Default503Response"
23405 }
23406 },
23407 "security" : [ {
23408 "Authorization_Code_PKCE" : [ "r_usr" ]
23409 } ],
23410 "summary" : "Get single userCollectionSaveForLater.",
23411 "tags" : [ "userCollectionSaveForLaters" ],
23412 "x-path-item-properties" : {
23413 "required-access-tier" : "INTERNAL"
23414 }
23415 }
23416 },
23417 "/userCollectionSaveForLaters/{id}/relationships/items" : {
23418 "delete" : {
23419 "description" : "Deletes item(s) from items relationship.",
23420 "parameters" : [ {
23421 "description" : "User collection save for later id. Use `me` for the authenticated user's resource",
23422 "example" : "me",
23423 "in" : "path",
23424 "name" : "id",
23425 "required" : true,
23426 "schema" : {
23427 "type" : "string"
23428 }
23429 }, {
23430 "$ref" : "#/components/parameters/IdempotencyKey"
23431 } ],
23432 "requestBody" : {
23433 "content" : {
23434 "application/vnd.api+json" : {
23435 "schema" : {
23436 "$ref" : "#/components/schemas/UserCollectionSaveForLatersItemsRelationshipRemoveOperation_Payload"
23437 }
23438 }
23439 }
23440 },
23441 "responses" : {
23442 "400" : {
23443 "$ref" : "#/components/responses/Default400Response"
23444 },
23445 "404" : {
23446 "$ref" : "#/components/responses/Default404Response"
23447 },
23448 "405" : {
23449 "$ref" : "#/components/responses/Default405Response"
23450 },
23451 "406" : {
23452 "$ref" : "#/components/responses/Default406Response"
23453 },
23454 "409" : {
23455 "$ref" : "#/components/responses/Idempotency409Response"
23456 },
23457 "415" : {
23458 "$ref" : "#/components/responses/Default415Response"
23459 },
23460 "422" : {
23461 "$ref" : "#/components/responses/Idempotency422Response"
23462 },
23463 "429" : {
23464 "$ref" : "#/components/responses/Default429Response"
23465 },
23466 "500" : {
23467 "$ref" : "#/components/responses/Default500Response"
23468 },
23469 "503" : {
23470 "$ref" : "#/components/responses/Default503Response"
23471 }
23472 },
23473 "security" : [ {
23474 "Authorization_Code_PKCE" : [ "w_usr" ]
23475 } ],
23476 "summary" : "Delete from items relationship (\"to-many\").",
23477 "tags" : [ "userCollectionSaveForLaters" ],
23478 "x-path-item-properties" : {
23479 "required-access-tier" : "INTERNAL"
23480 }
23481 },
23482 "get" : {
23483 "description" : "Retrieves items relationship.",
23484 "parameters" : [ {
23485 "description" : "User collection save for later id. Use `me` for the authenticated user's resource",
23486 "example" : "me",
23487 "in" : "path",
23488 "name" : "id",
23489 "required" : true,
23490 "schema" : {
23491 "type" : "string"
23492 }
23493 }, {
23494 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
23495 "in" : "query",
23496 "name" : "page[cursor]",
23497 "required" : false,
23498 "schema" : {
23499 "type" : "string"
23500 }
23501 }, {
23502 "description" : "Allows the client to customize which related resources should be returned. Available options: items",
23503 "example" : "items",
23504 "in" : "query",
23505 "name" : "include",
23506 "required" : false,
23507 "schema" : {
23508 "type" : "array",
23509 "items" : {
23510 "type" : "string",
23511 "example" : "items"
23512 }
23513 }
23514 }, {
23515 "description" : "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",
23516 "example" : "items",
23517 "in" : "query",
23518 "name" : "replaceMedia",
23519 "required" : false,
23520 "schema" : {
23521 "type" : "string",
23522 "example" : "items"
23523 }
23524 } ],
23525 "responses" : {
23526 "200" : {
23527 "content" : {
23528 "application/vnd.api+json" : {
23529 "schema" : {
23530 "$ref" : "#/components/schemas/UserCollectionSaveForLaters_Items_Multi_Relationship_Data_Document"
23531 }
23532 }
23533 },
23534 "description" : "Successful response"
23535 },
23536 "400" : {
23537 "$ref" : "#/components/responses/Default400Response"
23538 },
23539 "404" : {
23540 "$ref" : "#/components/responses/Default404Response"
23541 },
23542 "405" : {
23543 "$ref" : "#/components/responses/Default405Response"
23544 },
23545 "406" : {
23546 "$ref" : "#/components/responses/Default406Response"
23547 },
23548 "415" : {
23549 "$ref" : "#/components/responses/Default415Response"
23550 },
23551 "429" : {
23552 "$ref" : "#/components/responses/Default429Response"
23553 },
23554 "500" : {
23555 "$ref" : "#/components/responses/Default500Response"
23556 },
23557 "503" : {
23558 "$ref" : "#/components/responses/Default503Response"
23559 }
23560 },
23561 "security" : [ {
23562 "Authorization_Code_PKCE" : [ "r_usr" ]
23563 } ],
23564 "summary" : "Get items relationship (\"to-many\").",
23565 "tags" : [ "userCollectionSaveForLaters" ],
23566 "x-path-item-properties" : {
23567 "required-access-tier" : "INTERNAL"
23568 }
23569 },
23570 "post" : {
23571 "description" : "Adds item(s) to items relationship.",
23572 "parameters" : [ {
23573 "description" : "User collection save for later id. Use `me` for the authenticated user's resource",
23574 "example" : "me",
23575 "in" : "path",
23576 "name" : "id",
23577 "required" : true,
23578 "schema" : {
23579 "type" : "string"
23580 }
23581 }, {
23582 "$ref" : "#/components/parameters/IdempotencyKey"
23583 } ],
23584 "requestBody" : {
23585 "content" : {
23586 "application/vnd.api+json" : {
23587 "schema" : {
23588 "$ref" : "#/components/schemas/UserCollectionSaveForLatersItemsRelationshipAddOperation_Payload"
23589 }
23590 }
23591 }
23592 },
23593 "responses" : {
23594 "200" : {
23595 "content" : {
23596 "application/vnd.api+json" : {
23597 "schema" : {
23598 "$ref" : "#/components/schemas/UserCollectionSaveForLaters_Items_Add_Multi_Relationship_Data_Document"
23599 }
23600 }
23601 },
23602 "description" : "Successful response"
23603 },
23604 "400" : {
23605 "$ref" : "#/components/responses/Default400Response"
23606 },
23607 "404" : {
23608 "$ref" : "#/components/responses/Default404Response"
23609 },
23610 "405" : {
23611 "$ref" : "#/components/responses/Default405Response"
23612 },
23613 "406" : {
23614 "$ref" : "#/components/responses/Default406Response"
23615 },
23616 "409" : {
23617 "$ref" : "#/components/responses/UserCollectionSaveForLatersAddMultiDataRelationshipWithResponse409Response"
23618 },
23619 "415" : {
23620 "$ref" : "#/components/responses/Default415Response"
23621 },
23622 "422" : {
23623 "$ref" : "#/components/responses/Idempotency422Response"
23624 },
23625 "429" : {
23626 "$ref" : "#/components/responses/Default429Response"
23627 },
23628 "500" : {
23629 "$ref" : "#/components/responses/Default500Response"
23630 },
23631 "503" : {
23632 "$ref" : "#/components/responses/Default503Response"
23633 }
23634 },
23635 "security" : [ {
23636 "Authorization_Code_PKCE" : [ "w_usr" ]
23637 } ],
23638 "summary" : "Add to items relationship (\"to-many\").",
23639 "tags" : [ "userCollectionSaveForLaters" ],
23640 "x-path-item-properties" : {
23641 "required-access-tier" : "INTERNAL"
23642 }
23643 }
23644 },
23645 "/userCollectionSaveForLaters/{id}/relationships/owners" : {
23646 "get" : {
23647 "description" : "Retrieves owners relationship.",
23648 "parameters" : [ {
23649 "description" : "User collection save for later id. Use `me` for the authenticated user's resource",
23650 "example" : "me",
23651 "in" : "path",
23652 "name" : "id",
23653 "required" : true,
23654 "schema" : {
23655 "type" : "string"
23656 }
23657 }, {
23658 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
23659 "example" : "owners",
23660 "in" : "query",
23661 "name" : "include",
23662 "required" : false,
23663 "schema" : {
23664 "type" : "array",
23665 "items" : {
23666 "type" : "string",
23667 "example" : "owners"
23668 }
23669 }
23670 }, {
23671 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
23672 "in" : "query",
23673 "name" : "page[cursor]",
23674 "required" : false,
23675 "schema" : {
23676 "type" : "string"
23677 }
23678 } ],
23679 "responses" : {
23680 "200" : {
23681 "content" : {
23682 "application/vnd.api+json" : {
23683 "schema" : {
23684 "$ref" : "#/components/schemas/UserCollectionSaveForLaters_Multi_Relationship_Data_Document"
23685 }
23686 }
23687 },
23688 "description" : "Successful response"
23689 },
23690 "400" : {
23691 "$ref" : "#/components/responses/Default400Response"
23692 },
23693 "404" : {
23694 "$ref" : "#/components/responses/Default404Response"
23695 },
23696 "405" : {
23697 "$ref" : "#/components/responses/Default405Response"
23698 },
23699 "406" : {
23700 "$ref" : "#/components/responses/Default406Response"
23701 },
23702 "415" : {
23703 "$ref" : "#/components/responses/Default415Response"
23704 },
23705 "429" : {
23706 "$ref" : "#/components/responses/Default429Response"
23707 },
23708 "500" : {
23709 "$ref" : "#/components/responses/Default500Response"
23710 },
23711 "503" : {
23712 "$ref" : "#/components/responses/Default503Response"
23713 }
23714 },
23715 "security" : [ {
23716 "Authorization_Code_PKCE" : [ "r_usr" ]
23717 } ],
23718 "summary" : "Get owners relationship (\"to-many\").",
23719 "tags" : [ "userCollectionSaveForLaters" ],
23720 "x-path-item-properties" : {
23721 "required-access-tier" : "INTERNAL"
23722 }
23723 }
23724 },
23725 "/userCollectionTracks/{id}" : {
23726 "get" : {
23727 "description" : "Retrieves single userCollectionTrack by id.",
23728 "parameters" : [ {
23729 "description" : "User collection tracks id. Use `me` for the authenticated user's resource",
23730 "example" : "me",
23731 "in" : "path",
23732 "name" : "id",
23733 "required" : true,
23734 "schema" : {
23735 "type" : "string"
23736 }
23737 }, {
23738 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
23739 "example" : "en-US",
23740 "in" : "query",
23741 "name" : "locale",
23742 "required" : false,
23743 "schema" : {
23744 "type" : "string",
23745 "default" : "en-US"
23746 }
23747 }, {
23748 "description" : "Allows the client to customize which related resources should be returned. Available options: items, owners",
23749 "example" : "items",
23750 "in" : "query",
23751 "name" : "include",
23752 "required" : false,
23753 "schema" : {
23754 "type" : "array",
23755 "items" : {
23756 "type" : "string",
23757 "example" : "items"
23758 }
23759 }
23760 }, {
23761 "description" : "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",
23762 "example" : "items",
23763 "in" : "query",
23764 "name" : "replaceMedia",
23765 "required" : false,
23766 "schema" : {
23767 "type" : "string",
23768 "example" : "items"
23769 }
23770 } ],
23771 "responses" : {
23772 "200" : {
23773 "content" : {
23774 "application/vnd.api+json" : {
23775 "schema" : {
23776 "$ref" : "#/components/schemas/UserCollectionTracks_Single_Resource_Data_Document"
23777 }
23778 }
23779 },
23780 "description" : "Successful response"
23781 },
23782 "400" : {
23783 "$ref" : "#/components/responses/Default400Response"
23784 },
23785 "404" : {
23786 "$ref" : "#/components/responses/Default404Response"
23787 },
23788 "405" : {
23789 "$ref" : "#/components/responses/Default405Response"
23790 },
23791 "406" : {
23792 "$ref" : "#/components/responses/Default406Response"
23793 },
23794 "415" : {
23795 "$ref" : "#/components/responses/Default415Response"
23796 },
23797 "429" : {
23798 "$ref" : "#/components/responses/Default429Response"
23799 },
23800 "500" : {
23801 "$ref" : "#/components/responses/Default500Response"
23802 },
23803 "503" : {
23804 "$ref" : "#/components/responses/Default503Response"
23805 }
23806 },
23807 "security" : [ {
23808 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
23809 } ],
23810 "summary" : "Get single userCollectionTrack.",
23811 "tags" : [ "userCollectionTracks" ],
23812 "x-path-item-properties" : {
23813 "required-access-tier" : "THIRD_PARTY"
23814 }
23815 }
23816 },
23817 "/userCollectionTracks/{id}/relationships/items" : {
23818 "delete" : {
23819 "description" : "Deletes item(s) from items relationship.",
23820 "parameters" : [ {
23821 "description" : "User collection tracks id. Use `me` for the authenticated user's resource",
23822 "example" : "me",
23823 "in" : "path",
23824 "name" : "id",
23825 "required" : true,
23826 "schema" : {
23827 "type" : "string"
23828 }
23829 }, {
23830 "$ref" : "#/components/parameters/IdempotencyKey"
23831 } ],
23832 "requestBody" : {
23833 "content" : {
23834 "application/vnd.api+json" : {
23835 "schema" : {
23836 "$ref" : "#/components/schemas/UserCollectionTracksItemsRelationshipRemoveOperation_Payload"
23837 }
23838 }
23839 }
23840 },
23841 "responses" : {
23842 "400" : {
23843 "$ref" : "#/components/responses/Default400Response"
23844 },
23845 "404" : {
23846 "$ref" : "#/components/responses/Default404Response"
23847 },
23848 "405" : {
23849 "$ref" : "#/components/responses/Default405Response"
23850 },
23851 "406" : {
23852 "$ref" : "#/components/responses/Default406Response"
23853 },
23854 "409" : {
23855 "$ref" : "#/components/responses/Idempotency409Response"
23856 },
23857 "415" : {
23858 "$ref" : "#/components/responses/Default415Response"
23859 },
23860 "422" : {
23861 "$ref" : "#/components/responses/Idempotency422Response"
23862 },
23863 "429" : {
23864 "$ref" : "#/components/responses/Default429Response"
23865 },
23866 "500" : {
23867 "$ref" : "#/components/responses/Default500Response"
23868 },
23869 "503" : {
23870 "$ref" : "#/components/responses/Default503Response"
23871 }
23872 },
23873 "security" : [ {
23874 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
23875 } ],
23876 "summary" : "Delete from items relationship (\"to-many\").",
23877 "tags" : [ "userCollectionTracks" ],
23878 "x-path-item-properties" : {
23879 "required-access-tier" : "THIRD_PARTY"
23880 }
23881 },
23882 "get" : {
23883 "description" : "Retrieves items relationship.",
23884 "parameters" : [ {
23885 "description" : "User collection tracks id. Use `me` for the authenticated user's resource",
23886 "example" : "me",
23887 "in" : "path",
23888 "name" : "id",
23889 "required" : true,
23890 "schema" : {
23891 "type" : "string"
23892 }
23893 }, {
23894 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
23895 "in" : "query",
23896 "name" : "page[cursor]",
23897 "required" : false,
23898 "schema" : {
23899 "type" : "string"
23900 }
23901 }, {
23902 "description" : "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
23903 "in" : "query",
23904 "name" : "sort",
23905 "required" : false,
23906 "schema" : {
23907 "type" : "array",
23908 "items" : {
23909 "type" : "string",
23910 "example" : "addedAt",
23911 "default" : "-addedAt",
23912 "enum" : [ "addedAt", "-addedAt", "albums.title", "-albums.title", "artists.name", "-artists.name", "duration", "-duration", "title", "-title" ],
23913 "x-enum-varnames" : [ "AddedAtAsc", "AddedAtDesc", "AlbumsTitleAsc", "AlbumsTitleDesc", "ArtistsNameAsc", "ArtistsNameDesc", "DurationAsc", "DurationDesc", "TitleAsc", "TitleDesc" ]
23914 }
23915 }
23916 }, {
23917 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
23918 "example" : "en-US",
23919 "in" : "query",
23920 "name" : "locale",
23921 "required" : false,
23922 "schema" : {
23923 "type" : "string",
23924 "default" : "en-US"
23925 }
23926 }, {
23927 "description" : "Allows the client to customize which related resources should be returned. Available options: items",
23928 "example" : "items",
23929 "in" : "query",
23930 "name" : "include",
23931 "required" : false,
23932 "schema" : {
23933 "type" : "array",
23934 "items" : {
23935 "type" : "string",
23936 "example" : "items"
23937 }
23938 }
23939 }, {
23940 "description" : "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",
23941 "example" : "items",
23942 "in" : "query",
23943 "name" : "replaceMedia",
23944 "required" : false,
23945 "schema" : {
23946 "type" : "string",
23947 "example" : "items"
23948 }
23949 } ],
23950 "responses" : {
23951 "200" : {
23952 "content" : {
23953 "application/vnd.api+json" : {
23954 "schema" : {
23955 "$ref" : "#/components/schemas/UserCollectionTracks_Items_Multi_Relationship_Data_Document"
23956 }
23957 }
23958 },
23959 "description" : "Successful response"
23960 },
23961 "400" : {
23962 "$ref" : "#/components/responses/Default400Response"
23963 },
23964 "404" : {
23965 "$ref" : "#/components/responses/Default404Response"
23966 },
23967 "405" : {
23968 "$ref" : "#/components/responses/Default405Response"
23969 },
23970 "406" : {
23971 "$ref" : "#/components/responses/Default406Response"
23972 },
23973 "415" : {
23974 "$ref" : "#/components/responses/Default415Response"
23975 },
23976 "429" : {
23977 "$ref" : "#/components/responses/Default429Response"
23978 },
23979 "500" : {
23980 "$ref" : "#/components/responses/Default500Response"
23981 },
23982 "503" : {
23983 "$ref" : "#/components/responses/Default503Response"
23984 }
23985 },
23986 "security" : [ {
23987 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
23988 } ],
23989 "summary" : "Get items relationship (\"to-many\").",
23990 "tags" : [ "userCollectionTracks" ],
23991 "x-path-item-properties" : {
23992 "required-access-tier" : "THIRD_PARTY"
23993 }
23994 },
23995 "post" : {
23996 "description" : "Adds item(s) to items relationship.",
23997 "parameters" : [ {
23998 "description" : "User collection tracks id. Use `me` for the authenticated user's resource",
23999 "example" : "me",
24000 "in" : "path",
24001 "name" : "id",
24002 "required" : true,
24003 "schema" : {
24004 "type" : "string"
24005 }
24006 }, {
24007 "$ref" : "#/components/parameters/IdempotencyKey"
24008 } ],
24009 "requestBody" : {
24010 "content" : {
24011 "application/vnd.api+json" : {
24012 "schema" : {
24013 "$ref" : "#/components/schemas/UserCollectionTracksItemsRelationshipAddOperation_Payload"
24014 }
24015 }
24016 }
24017 },
24018 "responses" : {
24019 "200" : {
24020 "content" : {
24021 "application/vnd.api+json" : {
24022 "schema" : {
24023 "$ref" : "#/components/schemas/UserCollectionTracks_Items_Add_Multi_Relationship_Data_Document"
24024 }
24025 }
24026 },
24027 "description" : "Successful response"
24028 },
24029 "400" : {
24030 "$ref" : "#/components/responses/Default400Response"
24031 },
24032 "404" : {
24033 "$ref" : "#/components/responses/Default404Response"
24034 },
24035 "405" : {
24036 "$ref" : "#/components/responses/Default405Response"
24037 },
24038 "406" : {
24039 "$ref" : "#/components/responses/Default406Response"
24040 },
24041 "409" : {
24042 "$ref" : "#/components/responses/UserCollectionTracksAddMultiDataRelationshipWithResponse409Response"
24043 },
24044 "415" : {
24045 "$ref" : "#/components/responses/Default415Response"
24046 },
24047 "422" : {
24048 "$ref" : "#/components/responses/Idempotency422Response"
24049 },
24050 "429" : {
24051 "$ref" : "#/components/responses/Default429Response"
24052 },
24053 "500" : {
24054 "$ref" : "#/components/responses/Default500Response"
24055 },
24056 "503" : {
24057 "$ref" : "#/components/responses/Default503Response"
24058 }
24059 },
24060 "security" : [ {
24061 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
24062 } ],
24063 "summary" : "Add to items relationship (\"to-many\").",
24064 "tags" : [ "userCollectionTracks" ],
24065 "x-path-item-properties" : {
24066 "required-access-tier" : "THIRD_PARTY"
24067 }
24068 }
24069 },
24070 "/userCollectionTracks/{id}/relationships/owners" : {
24071 "get" : {
24072 "description" : "Retrieves owners relationship.",
24073 "parameters" : [ {
24074 "description" : "User collection tracks id. Use `me` for the authenticated user's resource",
24075 "example" : "me",
24076 "in" : "path",
24077 "name" : "id",
24078 "required" : true,
24079 "schema" : {
24080 "type" : "string"
24081 }
24082 }, {
24083 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
24084 "example" : "owners",
24085 "in" : "query",
24086 "name" : "include",
24087 "required" : false,
24088 "schema" : {
24089 "type" : "array",
24090 "items" : {
24091 "type" : "string",
24092 "example" : "owners"
24093 }
24094 }
24095 }, {
24096 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
24097 "in" : "query",
24098 "name" : "page[cursor]",
24099 "required" : false,
24100 "schema" : {
24101 "type" : "string"
24102 }
24103 } ],
24104 "responses" : {
24105 "200" : {
24106 "content" : {
24107 "application/vnd.api+json" : {
24108 "schema" : {
24109 "$ref" : "#/components/schemas/UserCollectionTracks_Multi_Relationship_Data_Document"
24110 }
24111 }
24112 },
24113 "description" : "Successful response"
24114 },
24115 "400" : {
24116 "$ref" : "#/components/responses/Default400Response"
24117 },
24118 "404" : {
24119 "$ref" : "#/components/responses/Default404Response"
24120 },
24121 "405" : {
24122 "$ref" : "#/components/responses/Default405Response"
24123 },
24124 "406" : {
24125 "$ref" : "#/components/responses/Default406Response"
24126 },
24127 "415" : {
24128 "$ref" : "#/components/responses/Default415Response"
24129 },
24130 "429" : {
24131 "$ref" : "#/components/responses/Default429Response"
24132 },
24133 "500" : {
24134 "$ref" : "#/components/responses/Default500Response"
24135 },
24136 "503" : {
24137 "$ref" : "#/components/responses/Default503Response"
24138 }
24139 },
24140 "security" : [ {
24141 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
24142 } ],
24143 "summary" : "Get owners relationship (\"to-many\").",
24144 "tags" : [ "userCollectionTracks" ],
24145 "x-path-item-properties" : {
24146 "required-access-tier" : "THIRD_PARTY"
24147 }
24148 }
24149 },
24150 "/userCollectionVideos/{id}" : {
24151 "get" : {
24152 "description" : "Retrieves single userCollectionVideo by id.",
24153 "parameters" : [ {
24154 "description" : "User collection videos id. Use `me` for the authenticated user's resource",
24155 "example" : "me",
24156 "in" : "path",
24157 "name" : "id",
24158 "required" : true,
24159 "schema" : {
24160 "type" : "string"
24161 }
24162 }, {
24163 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
24164 "example" : "en-US",
24165 "in" : "query",
24166 "name" : "locale",
24167 "required" : false,
24168 "schema" : {
24169 "type" : "string",
24170 "default" : "en-US"
24171 }
24172 }, {
24173 "description" : "Allows the client to customize which related resources should be returned. Available options: items, owners",
24174 "example" : "items",
24175 "in" : "query",
24176 "name" : "include",
24177 "required" : false,
24178 "schema" : {
24179 "type" : "array",
24180 "items" : {
24181 "type" : "string",
24182 "example" : "items"
24183 }
24184 }
24185 }, {
24186 "description" : "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",
24187 "example" : "items",
24188 "in" : "query",
24189 "name" : "replaceMedia",
24190 "required" : false,
24191 "schema" : {
24192 "type" : "string",
24193 "example" : "items"
24194 }
24195 } ],
24196 "responses" : {
24197 "200" : {
24198 "content" : {
24199 "application/vnd.api+json" : {
24200 "schema" : {
24201 "$ref" : "#/components/schemas/UserCollectionVideos_Single_Resource_Data_Document"
24202 }
24203 }
24204 },
24205 "description" : "Successful response"
24206 },
24207 "400" : {
24208 "$ref" : "#/components/responses/Default400Response"
24209 },
24210 "404" : {
24211 "$ref" : "#/components/responses/Default404Response"
24212 },
24213 "405" : {
24214 "$ref" : "#/components/responses/Default405Response"
24215 },
24216 "406" : {
24217 "$ref" : "#/components/responses/Default406Response"
24218 },
24219 "415" : {
24220 "$ref" : "#/components/responses/Default415Response"
24221 },
24222 "429" : {
24223 "$ref" : "#/components/responses/Default429Response"
24224 },
24225 "500" : {
24226 "$ref" : "#/components/responses/Default500Response"
24227 },
24228 "503" : {
24229 "$ref" : "#/components/responses/Default503Response"
24230 }
24231 },
24232 "security" : [ {
24233 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
24234 } ],
24235 "summary" : "Get single userCollectionVideo.",
24236 "tags" : [ "userCollectionVideos" ],
24237 "x-path-item-properties" : {
24238 "required-access-tier" : "THIRD_PARTY"
24239 }
24240 }
24241 },
24242 "/userCollectionVideos/{id}/relationships/items" : {
24243 "delete" : {
24244 "description" : "Deletes item(s) from items relationship.",
24245 "parameters" : [ {
24246 "description" : "User collection videos id. Use `me` for the authenticated user's resource",
24247 "example" : "me",
24248 "in" : "path",
24249 "name" : "id",
24250 "required" : true,
24251 "schema" : {
24252 "type" : "string"
24253 }
24254 }, {
24255 "$ref" : "#/components/parameters/IdempotencyKey"
24256 } ],
24257 "requestBody" : {
24258 "content" : {
24259 "application/vnd.api+json" : {
24260 "schema" : {
24261 "$ref" : "#/components/schemas/UserCollectionVideosItemsRelationshipRemoveOperation_Payload"
24262 }
24263 }
24264 }
24265 },
24266 "responses" : {
24267 "400" : {
24268 "$ref" : "#/components/responses/Default400Response"
24269 },
24270 "404" : {
24271 "$ref" : "#/components/responses/Default404Response"
24272 },
24273 "405" : {
24274 "$ref" : "#/components/responses/Default405Response"
24275 },
24276 "406" : {
24277 "$ref" : "#/components/responses/Default406Response"
24278 },
24279 "409" : {
24280 "$ref" : "#/components/responses/Idempotency409Response"
24281 },
24282 "415" : {
24283 "$ref" : "#/components/responses/Default415Response"
24284 },
24285 "422" : {
24286 "$ref" : "#/components/responses/Idempotency422Response"
24287 },
24288 "429" : {
24289 "$ref" : "#/components/responses/Default429Response"
24290 },
24291 "500" : {
24292 "$ref" : "#/components/responses/Default500Response"
24293 },
24294 "503" : {
24295 "$ref" : "#/components/responses/Default503Response"
24296 }
24297 },
24298 "security" : [ {
24299 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
24300 } ],
24301 "summary" : "Delete from items relationship (\"to-many\").",
24302 "tags" : [ "userCollectionVideos" ],
24303 "x-path-item-properties" : {
24304 "required-access-tier" : "THIRD_PARTY"
24305 }
24306 },
24307 "get" : {
24308 "description" : "Retrieves items relationship.",
24309 "parameters" : [ {
24310 "description" : "User collection videos id. Use `me` for the authenticated user's resource",
24311 "example" : "me",
24312 "in" : "path",
24313 "name" : "id",
24314 "required" : true,
24315 "schema" : {
24316 "type" : "string"
24317 }
24318 }, {
24319 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
24320 "in" : "query",
24321 "name" : "page[cursor]",
24322 "required" : false,
24323 "schema" : {
24324 "type" : "string"
24325 }
24326 }, {
24327 "description" : "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
24328 "in" : "query",
24329 "name" : "sort",
24330 "required" : false,
24331 "schema" : {
24332 "type" : "array",
24333 "items" : {
24334 "type" : "string",
24335 "example" : "addedAt",
24336 "default" : "-addedAt",
24337 "enum" : [ "addedAt", "-addedAt", "artists.name", "-artists.name", "duration", "-duration", "title", "-title" ],
24338 "x-enum-varnames" : [ "AddedAtAsc", "AddedAtDesc", "ArtistsNameAsc", "ArtistsNameDesc", "DurationAsc", "DurationDesc", "TitleAsc", "TitleDesc" ]
24339 }
24340 }
24341 }, {
24342 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
24343 "example" : "en-US",
24344 "in" : "query",
24345 "name" : "locale",
24346 "required" : false,
24347 "schema" : {
24348 "type" : "string",
24349 "default" : "en-US"
24350 }
24351 }, {
24352 "description" : "Allows the client to customize which related resources should be returned. Available options: items",
24353 "example" : "items",
24354 "in" : "query",
24355 "name" : "include",
24356 "required" : false,
24357 "schema" : {
24358 "type" : "array",
24359 "items" : {
24360 "type" : "string",
24361 "example" : "items"
24362 }
24363 }
24364 }, {
24365 "description" : "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",
24366 "example" : "items",
24367 "in" : "query",
24368 "name" : "replaceMedia",
24369 "required" : false,
24370 "schema" : {
24371 "type" : "string",
24372 "example" : "items"
24373 }
24374 } ],
24375 "responses" : {
24376 "200" : {
24377 "content" : {
24378 "application/vnd.api+json" : {
24379 "schema" : {
24380 "$ref" : "#/components/schemas/UserCollectionVideos_Items_Multi_Relationship_Data_Document"
24381 }
24382 }
24383 },
24384 "description" : "Successful response"
24385 },
24386 "400" : {
24387 "$ref" : "#/components/responses/Default400Response"
24388 },
24389 "404" : {
24390 "$ref" : "#/components/responses/Default404Response"
24391 },
24392 "405" : {
24393 "$ref" : "#/components/responses/Default405Response"
24394 },
24395 "406" : {
24396 "$ref" : "#/components/responses/Default406Response"
24397 },
24398 "415" : {
24399 "$ref" : "#/components/responses/Default415Response"
24400 },
24401 "429" : {
24402 "$ref" : "#/components/responses/Default429Response"
24403 },
24404 "500" : {
24405 "$ref" : "#/components/responses/Default500Response"
24406 },
24407 "503" : {
24408 "$ref" : "#/components/responses/Default503Response"
24409 }
24410 },
24411 "security" : [ {
24412 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
24413 } ],
24414 "summary" : "Get items relationship (\"to-many\").",
24415 "tags" : [ "userCollectionVideos" ],
24416 "x-path-item-properties" : {
24417 "required-access-tier" : "THIRD_PARTY"
24418 }
24419 },
24420 "post" : {
24421 "description" : "Adds item(s) to items relationship.",
24422 "parameters" : [ {
24423 "description" : "User collection videos id. Use `me` for the authenticated user's resource",
24424 "example" : "me",
24425 "in" : "path",
24426 "name" : "id",
24427 "required" : true,
24428 "schema" : {
24429 "type" : "string"
24430 }
24431 }, {
24432 "$ref" : "#/components/parameters/IdempotencyKey"
24433 } ],
24434 "requestBody" : {
24435 "content" : {
24436 "application/vnd.api+json" : {
24437 "schema" : {
24438 "$ref" : "#/components/schemas/UserCollectionVideosItemsRelationshipAddOperation_Payload"
24439 }
24440 }
24441 }
24442 },
24443 "responses" : {
24444 "200" : {
24445 "content" : {
24446 "application/vnd.api+json" : {
24447 "schema" : {
24448 "$ref" : "#/components/schemas/UserCollectionVideos_Items_Add_Multi_Relationship_Data_Document"
24449 }
24450 }
24451 },
24452 "description" : "Successful response"
24453 },
24454 "400" : {
24455 "$ref" : "#/components/responses/Default400Response"
24456 },
24457 "404" : {
24458 "$ref" : "#/components/responses/Default404Response"
24459 },
24460 "405" : {
24461 "$ref" : "#/components/responses/Default405Response"
24462 },
24463 "406" : {
24464 "$ref" : "#/components/responses/Default406Response"
24465 },
24466 "409" : {
24467 "$ref" : "#/components/responses/UserCollectionVideosAddMultiDataRelationshipWithResponse409Response"
24468 },
24469 "415" : {
24470 "$ref" : "#/components/responses/Default415Response"
24471 },
24472 "422" : {
24473 "$ref" : "#/components/responses/Idempotency422Response"
24474 },
24475 "429" : {
24476 "$ref" : "#/components/responses/Default429Response"
24477 },
24478 "500" : {
24479 "$ref" : "#/components/responses/Default500Response"
24480 },
24481 "503" : {
24482 "$ref" : "#/components/responses/Default503Response"
24483 }
24484 },
24485 "security" : [ {
24486 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
24487 } ],
24488 "summary" : "Add to items relationship (\"to-many\").",
24489 "tags" : [ "userCollectionVideos" ],
24490 "x-path-item-properties" : {
24491 "required-access-tier" : "THIRD_PARTY"
24492 }
24493 }
24494 },
24495 "/userCollectionVideos/{id}/relationships/owners" : {
24496 "get" : {
24497 "description" : "Retrieves owners relationship.",
24498 "parameters" : [ {
24499 "description" : "User collection videos id. Use `me` for the authenticated user's resource",
24500 "example" : "me",
24501 "in" : "path",
24502 "name" : "id",
24503 "required" : true,
24504 "schema" : {
24505 "type" : "string"
24506 }
24507 }, {
24508 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
24509 "example" : "owners",
24510 "in" : "query",
24511 "name" : "include",
24512 "required" : false,
24513 "schema" : {
24514 "type" : "array",
24515 "items" : {
24516 "type" : "string",
24517 "example" : "owners"
24518 }
24519 }
24520 }, {
24521 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
24522 "in" : "query",
24523 "name" : "page[cursor]",
24524 "required" : false,
24525 "schema" : {
24526 "type" : "string"
24527 }
24528 } ],
24529 "responses" : {
24530 "200" : {
24531 "content" : {
24532 "application/vnd.api+json" : {
24533 "schema" : {
24534 "$ref" : "#/components/schemas/UserCollectionVideos_Multi_Relationship_Data_Document"
24535 }
24536 }
24537 },
24538 "description" : "Successful response"
24539 },
24540 "400" : {
24541 "$ref" : "#/components/responses/Default400Response"
24542 },
24543 "404" : {
24544 "$ref" : "#/components/responses/Default404Response"
24545 },
24546 "405" : {
24547 "$ref" : "#/components/responses/Default405Response"
24548 },
24549 "406" : {
24550 "$ref" : "#/components/responses/Default406Response"
24551 },
24552 "415" : {
24553 "$ref" : "#/components/responses/Default415Response"
24554 },
24555 "429" : {
24556 "$ref" : "#/components/responses/Default429Response"
24557 },
24558 "500" : {
24559 "$ref" : "#/components/responses/Default500Response"
24560 },
24561 "503" : {
24562 "$ref" : "#/components/responses/Default503Response"
24563 }
24564 },
24565 "security" : [ {
24566 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
24567 } ],
24568 "summary" : "Get owners relationship (\"to-many\").",
24569 "tags" : [ "userCollectionVideos" ],
24570 "x-path-item-properties" : {
24571 "required-access-tier" : "THIRD_PARTY"
24572 }
24573 }
24574 },
24575 "/userCollections/{id}" : {
24576 "get" : {
24577 "deprecated" : true,
24578 "description" : "Deprecated. Use the dedicated collection resources instead: userCollectionAlbums, userCollectionArtists, userCollectionTracks, userCollectionVideos, or userCollectionPlaylists.",
24579 "parameters" : [ {
24580 "description" : "User collection id",
24581 "example" : "123456",
24582 "in" : "path",
24583 "name" : "id",
24584 "required" : true,
24585 "schema" : {
24586 "type" : "string"
24587 }
24588 }, {
24589 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
24590 "example" : "en-US",
24591 "in" : "query",
24592 "name" : "locale",
24593 "required" : false,
24594 "schema" : {
24595 "type" : "string",
24596 "default" : "en-US"
24597 }
24598 }, {
24599 "description" : "Allows the client to customize which related resources should be returned. Available options: albums, artists, owners, playlists, tracks, videos",
24600 "example" : "albums",
24601 "in" : "query",
24602 "name" : "include",
24603 "required" : false,
24604 "schema" : {
24605 "type" : "array",
24606 "items" : {
24607 "type" : "string",
24608 "example" : "albums"
24609 }
24610 }
24611 }, {
24612 "description" : "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",
24613 "example" : "albums",
24614 "in" : "query",
24615 "name" : "replaceMedia",
24616 "required" : false,
24617 "schema" : {
24618 "type" : "string",
24619 "example" : "albums"
24620 }
24621 } ],
24622 "responses" : {
24623 "200" : {
24624 "content" : {
24625 "application/vnd.api+json" : {
24626 "schema" : {
24627 "$ref" : "#/components/schemas/UserCollections_Single_Resource_Data_Document"
24628 }
24629 }
24630 },
24631 "description" : "Successful response"
24632 },
24633 "400" : {
24634 "$ref" : "#/components/responses/Default400Response"
24635 },
24636 "404" : {
24637 "$ref" : "#/components/responses/Default404Response"
24638 },
24639 "405" : {
24640 "$ref" : "#/components/responses/Default405Response"
24641 },
24642 "406" : {
24643 "$ref" : "#/components/responses/Default406Response"
24644 },
24645 "415" : {
24646 "$ref" : "#/components/responses/Default415Response"
24647 },
24648 "429" : {
24649 "$ref" : "#/components/responses/Default429Response"
24650 },
24651 "500" : {
24652 "$ref" : "#/components/responses/Default500Response"
24653 },
24654 "503" : {
24655 "$ref" : "#/components/responses/Default503Response"
24656 }
24657 },
24658 "security" : [ {
24659 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
24660 } ],
24661 "summary" : "Get single userCollection.",
24662 "tags" : [ "userCollections" ],
24663 "x-path-item-properties" : {
24664 "required-access-tier" : "THIRD_PARTY"
24665 }
24666 }
24667 },
24668 "/userCollections/{id}/relationships/albums" : {
24669 "delete" : {
24670 "deprecated" : true,
24671 "description" : "Deprecated. Use the userCollectionAlbums resource and its items relationship instead.",
24672 "parameters" : [ {
24673 "description" : "User collection id",
24674 "example" : "123456",
24675 "in" : "path",
24676 "name" : "id",
24677 "required" : true,
24678 "schema" : {
24679 "type" : "string"
24680 }
24681 }, {
24682 "$ref" : "#/components/parameters/IdempotencyKey"
24683 } ],
24684 "requestBody" : {
24685 "content" : {
24686 "application/vnd.api+json" : {
24687 "schema" : {
24688 "$ref" : "#/components/schemas/UserCollectionsAlbumsRelationshipRemoveOperation_Payload"
24689 }
24690 }
24691 }
24692 },
24693 "responses" : {
24694 "400" : {
24695 "$ref" : "#/components/responses/Default400Response"
24696 },
24697 "404" : {
24698 "$ref" : "#/components/responses/Default404Response"
24699 },
24700 "405" : {
24701 "$ref" : "#/components/responses/Default405Response"
24702 },
24703 "406" : {
24704 "$ref" : "#/components/responses/Default406Response"
24705 },
24706 "409" : {
24707 "$ref" : "#/components/responses/Idempotency409Response"
24708 },
24709 "415" : {
24710 "$ref" : "#/components/responses/Default415Response"
24711 },
24712 "422" : {
24713 "$ref" : "#/components/responses/Idempotency422Response"
24714 },
24715 "429" : {
24716 "$ref" : "#/components/responses/Default429Response"
24717 },
24718 "500" : {
24719 "$ref" : "#/components/responses/Default500Response"
24720 },
24721 "503" : {
24722 "$ref" : "#/components/responses/Default503Response"
24723 }
24724 },
24725 "security" : [ {
24726 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
24727 } ],
24728 "summary" : "Delete from albums relationship (\"to-many\").",
24729 "tags" : [ "userCollections" ],
24730 "x-path-item-properties" : {
24731 "required-access-tier" : "THIRD_PARTY"
24732 }
24733 },
24734 "get" : {
24735 "deprecated" : true,
24736 "description" : "Deprecated. Use the userCollectionAlbums resource and its items relationship instead.",
24737 "parameters" : [ {
24738 "description" : "User collection id",
24739 "example" : "123456",
24740 "in" : "path",
24741 "name" : "id",
24742 "required" : true,
24743 "schema" : {
24744 "type" : "string"
24745 }
24746 }, {
24747 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
24748 "in" : "query",
24749 "name" : "page[cursor]",
24750 "required" : false,
24751 "schema" : {
24752 "type" : "string"
24753 }
24754 }, {
24755 "description" : "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
24756 "in" : "query",
24757 "name" : "sort",
24758 "required" : false,
24759 "schema" : {
24760 "type" : "array",
24761 "items" : {
24762 "type" : "string",
24763 "example" : "albums.addedAt",
24764 "default" : "-albums.addedAt",
24765 "enum" : [ "albums.addedAt", "-albums.addedAt", "albums.artists.name", "-albums.artists.name", "albums.releaseDate", "-albums.releaseDate", "albums.title", "-albums.title" ],
24766 "x-enum-varnames" : [ "AlbumsAddedAtAsc", "AlbumsAddedAtDesc", "AlbumsArtistsNameAsc", "AlbumsArtistsNameDesc", "AlbumsReleaseDateAsc", "AlbumsReleaseDateDesc", "AlbumsTitleAsc", "AlbumsTitleDesc" ]
24767 }
24768 }
24769 }, {
24770 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
24771 "example" : "en-US",
24772 "in" : "query",
24773 "name" : "locale",
24774 "required" : false,
24775 "schema" : {
24776 "type" : "string",
24777 "default" : "en-US"
24778 }
24779 }, {
24780 "description" : "Allows the client to customize which related resources should be returned. Available options: albums",
24781 "example" : "albums",
24782 "in" : "query",
24783 "name" : "include",
24784 "required" : false,
24785 "schema" : {
24786 "type" : "array",
24787 "items" : {
24788 "type" : "string",
24789 "example" : "albums"
24790 }
24791 }
24792 }, {
24793 "description" : "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",
24794 "example" : "albums",
24795 "in" : "query",
24796 "name" : "replaceMedia",
24797 "required" : false,
24798 "schema" : {
24799 "type" : "string",
24800 "example" : "albums"
24801 }
24802 } ],
24803 "responses" : {
24804 "200" : {
24805 "content" : {
24806 "application/vnd.api+json" : {
24807 "schema" : {
24808 "$ref" : "#/components/schemas/UserCollections_Albums_Multi_Relationship_Data_Document"
24809 }
24810 }
24811 },
24812 "description" : "Successful response"
24813 },
24814 "400" : {
24815 "$ref" : "#/components/responses/Default400Response"
24816 },
24817 "404" : {
24818 "$ref" : "#/components/responses/Default404Response"
24819 },
24820 "405" : {
24821 "$ref" : "#/components/responses/Default405Response"
24822 },
24823 "406" : {
24824 "$ref" : "#/components/responses/Default406Response"
24825 },
24826 "415" : {
24827 "$ref" : "#/components/responses/Default415Response"
24828 },
24829 "429" : {
24830 "$ref" : "#/components/responses/Default429Response"
24831 },
24832 "500" : {
24833 "$ref" : "#/components/responses/Default500Response"
24834 },
24835 "503" : {
24836 "$ref" : "#/components/responses/Default503Response"
24837 }
24838 },
24839 "security" : [ {
24840 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
24841 } ],
24842 "summary" : "Get albums relationship (\"to-many\").",
24843 "tags" : [ "userCollections" ],
24844 "x-path-item-properties" : {
24845 "required-access-tier" : "THIRD_PARTY"
24846 }
24847 },
24848 "post" : {
24849 "deprecated" : true,
24850 "description" : "Deprecated. Use the userCollectionAlbums resource and its items relationship instead.",
24851 "parameters" : [ {
24852 "description" : "User collection id",
24853 "example" : "123456",
24854 "in" : "path",
24855 "name" : "id",
24856 "required" : true,
24857 "schema" : {
24858 "type" : "string"
24859 }
24860 }, {
24861 "$ref" : "#/components/parameters/IdempotencyKey"
24862 } ],
24863 "requestBody" : {
24864 "content" : {
24865 "application/vnd.api+json" : {
24866 "schema" : {
24867 "$ref" : "#/components/schemas/UserCollectionsAlbumsRelationshipAddOperation_Payload"
24868 }
24869 }
24870 }
24871 },
24872 "responses" : {
24873 "201" : {
24874 "description" : "Successful response"
24875 },
24876 "400" : {
24877 "$ref" : "#/components/responses/Default400Response"
24878 },
24879 "404" : {
24880 "$ref" : "#/components/responses/Default404Response"
24881 },
24882 "405" : {
24883 "$ref" : "#/components/responses/Default405Response"
24884 },
24885 "406" : {
24886 "$ref" : "#/components/responses/Default406Response"
24887 },
24888 "409" : {
24889 "$ref" : "#/components/responses/UserCollectionsAddMultiDataRelationship409Response"
24890 },
24891 "415" : {
24892 "$ref" : "#/components/responses/Default415Response"
24893 },
24894 "422" : {
24895 "$ref" : "#/components/responses/Idempotency422Response"
24896 },
24897 "429" : {
24898 "$ref" : "#/components/responses/Default429Response"
24899 },
24900 "500" : {
24901 "$ref" : "#/components/responses/Default500Response"
24902 },
24903 "503" : {
24904 "$ref" : "#/components/responses/Default503Response"
24905 }
24906 },
24907 "security" : [ {
24908 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
24909 } ],
24910 "summary" : "Add to albums relationship (\"to-many\").",
24911 "tags" : [ "userCollections" ],
24912 "x-path-item-properties" : {
24913 "required-access-tier" : "THIRD_PARTY"
24914 }
24915 }
24916 },
24917 "/userCollections/{id}/relationships/artists" : {
24918 "delete" : {
24919 "deprecated" : true,
24920 "description" : "Deprecated. Use the userCollectionArtists resource and its items relationship instead.",
24921 "parameters" : [ {
24922 "description" : "User collection id",
24923 "example" : "123456",
24924 "in" : "path",
24925 "name" : "id",
24926 "required" : true,
24927 "schema" : {
24928 "type" : "string"
24929 }
24930 }, {
24931 "$ref" : "#/components/parameters/IdempotencyKey"
24932 } ],
24933 "requestBody" : {
24934 "content" : {
24935 "application/vnd.api+json" : {
24936 "schema" : {
24937 "$ref" : "#/components/schemas/UserCollectionsArtistsRelationshipRemoveOperation_Payload"
24938 }
24939 }
24940 }
24941 },
24942 "responses" : {
24943 "400" : {
24944 "$ref" : "#/components/responses/Default400Response"
24945 },
24946 "404" : {
24947 "$ref" : "#/components/responses/Default404Response"
24948 },
24949 "405" : {
24950 "$ref" : "#/components/responses/Default405Response"
24951 },
24952 "406" : {
24953 "$ref" : "#/components/responses/Default406Response"
24954 },
24955 "409" : {
24956 "$ref" : "#/components/responses/Idempotency409Response"
24957 },
24958 "415" : {
24959 "$ref" : "#/components/responses/Default415Response"
24960 },
24961 "422" : {
24962 "$ref" : "#/components/responses/Idempotency422Response"
24963 },
24964 "429" : {
24965 "$ref" : "#/components/responses/Default429Response"
24966 },
24967 "500" : {
24968 "$ref" : "#/components/responses/Default500Response"
24969 },
24970 "503" : {
24971 "$ref" : "#/components/responses/Default503Response"
24972 }
24973 },
24974 "security" : [ {
24975 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
24976 } ],
24977 "summary" : "Delete from artists relationship (\"to-many\").",
24978 "tags" : [ "userCollections" ],
24979 "x-path-item-properties" : {
24980 "required-access-tier" : "THIRD_PARTY"
24981 }
24982 },
24983 "get" : {
24984 "deprecated" : true,
24985 "description" : "Deprecated. Use the userCollectionArtists resource and its items relationship instead.",
24986 "parameters" : [ {
24987 "description" : "User collection id",
24988 "example" : "123456",
24989 "in" : "path",
24990 "name" : "id",
24991 "required" : true,
24992 "schema" : {
24993 "type" : "string"
24994 }
24995 }, {
24996 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
24997 "in" : "query",
24998 "name" : "page[cursor]",
24999 "required" : false,
25000 "schema" : {
25001 "type" : "string"
25002 }
25003 }, {
25004 "description" : "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
25005 "in" : "query",
25006 "name" : "sort",
25007 "required" : false,
25008 "schema" : {
25009 "type" : "array",
25010 "items" : {
25011 "type" : "string",
25012 "example" : "artists.addedAt",
25013 "default" : "-artists.addedAt",
25014 "enum" : [ "artists.addedAt", "-artists.addedAt", "artists.name", "-artists.name" ],
25015 "x-enum-varnames" : [ "ArtistsAddedAtAsc", "ArtistsAddedAtDesc", "ArtistsNameAsc", "ArtistsNameDesc" ]
25016 }
25017 }
25018 }, {
25019 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
25020 "example" : "en-US",
25021 "in" : "query",
25022 "name" : "locale",
25023 "required" : false,
25024 "schema" : {
25025 "type" : "string",
25026 "default" : "en-US"
25027 }
25028 }, {
25029 "description" : "Allows the client to customize which related resources should be returned. Available options: artists",
25030 "example" : "artists.albums",
25031 "in" : "query",
25032 "name" : "include",
25033 "required" : false,
25034 "schema" : {
25035 "type" : "array",
25036 "items" : {
25037 "type" : "string",
25038 "example" : "artists.albums"
25039 }
25040 }
25041 }, {
25042 "description" : "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",
25043 "example" : "artists.albums",
25044 "in" : "query",
25045 "name" : "replaceMedia",
25046 "required" : false,
25047 "schema" : {
25048 "type" : "string",
25049 "example" : "artists.albums"
25050 }
25051 } ],
25052 "responses" : {
25053 "200" : {
25054 "content" : {
25055 "application/vnd.api+json" : {
25056 "schema" : {
25057 "$ref" : "#/components/schemas/UserCollections_Artists_Multi_Relationship_Data_Document"
25058 }
25059 }
25060 },
25061 "description" : "Successful response"
25062 },
25063 "400" : {
25064 "$ref" : "#/components/responses/Default400Response"
25065 },
25066 "404" : {
25067 "$ref" : "#/components/responses/Default404Response"
25068 },
25069 "405" : {
25070 "$ref" : "#/components/responses/Default405Response"
25071 },
25072 "406" : {
25073 "$ref" : "#/components/responses/Default406Response"
25074 },
25075 "415" : {
25076 "$ref" : "#/components/responses/Default415Response"
25077 },
25078 "429" : {
25079 "$ref" : "#/components/responses/Default429Response"
25080 },
25081 "500" : {
25082 "$ref" : "#/components/responses/Default500Response"
25083 },
25084 "503" : {
25085 "$ref" : "#/components/responses/Default503Response"
25086 }
25087 },
25088 "security" : [ {
25089 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
25090 } ],
25091 "summary" : "Get artists relationship (\"to-many\").",
25092 "tags" : [ "userCollections" ],
25093 "x-path-item-properties" : {
25094 "required-access-tier" : "THIRD_PARTY"
25095 }
25096 },
25097 "post" : {
25098 "deprecated" : true,
25099 "description" : "Deprecated. Use the userCollectionArtists resource and its items relationship instead.",
25100 "parameters" : [ {
25101 "description" : "User collection id",
25102 "example" : "123456",
25103 "in" : "path",
25104 "name" : "id",
25105 "required" : true,
25106 "schema" : {
25107 "type" : "string"
25108 }
25109 }, {
25110 "$ref" : "#/components/parameters/IdempotencyKey"
25111 } ],
25112 "requestBody" : {
25113 "content" : {
25114 "application/vnd.api+json" : {
25115 "schema" : {
25116 "$ref" : "#/components/schemas/UserCollectionsArtistsRelationshipAddOperation_Payload"
25117 }
25118 }
25119 }
25120 },
25121 "responses" : {
25122 "201" : {
25123 "description" : "Successful response"
25124 },
25125 "400" : {
25126 "$ref" : "#/components/responses/Default400Response"
25127 },
25128 "404" : {
25129 "$ref" : "#/components/responses/Default404Response"
25130 },
25131 "405" : {
25132 "$ref" : "#/components/responses/Default405Response"
25133 },
25134 "406" : {
25135 "$ref" : "#/components/responses/Default406Response"
25136 },
25137 "409" : {
25138 "$ref" : "#/components/responses/UserCollectionsAddMultiDataRelationship409Response"
25139 },
25140 "415" : {
25141 "$ref" : "#/components/responses/Default415Response"
25142 },
25143 "422" : {
25144 "$ref" : "#/components/responses/Idempotency422Response"
25145 },
25146 "429" : {
25147 "$ref" : "#/components/responses/Default429Response"
25148 },
25149 "500" : {
25150 "$ref" : "#/components/responses/Default500Response"
25151 },
25152 "503" : {
25153 "$ref" : "#/components/responses/Default503Response"
25154 }
25155 },
25156 "security" : [ {
25157 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
25158 } ],
25159 "summary" : "Add to artists relationship (\"to-many\").",
25160 "tags" : [ "userCollections" ],
25161 "x-path-item-properties" : {
25162 "required-access-tier" : "THIRD_PARTY"
25163 }
25164 }
25165 },
25166 "/userCollections/{id}/relationships/owners" : {
25167 "get" : {
25168 "deprecated" : true,
25169 "description" : "Deprecated. Use the owners relationship on the dedicated collection resources instead: userCollectionAlbums, userCollectionArtists, userCollectionTracks, userCollectionVideos, or userCollectionPlaylists.",
25170 "parameters" : [ {
25171 "description" : "User collection id",
25172 "example" : "123456",
25173 "in" : "path",
25174 "name" : "id",
25175 "required" : true,
25176 "schema" : {
25177 "type" : "string"
25178 }
25179 }, {
25180 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
25181 "example" : "owners",
25182 "in" : "query",
25183 "name" : "include",
25184 "required" : false,
25185 "schema" : {
25186 "type" : "array",
25187 "items" : {
25188 "type" : "string",
25189 "example" : "owners"
25190 }
25191 }
25192 }, {
25193 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
25194 "in" : "query",
25195 "name" : "page[cursor]",
25196 "required" : false,
25197 "schema" : {
25198 "type" : "string"
25199 }
25200 } ],
25201 "responses" : {
25202 "200" : {
25203 "content" : {
25204 "application/vnd.api+json" : {
25205 "schema" : {
25206 "$ref" : "#/components/schemas/UserCollections_Multi_Relationship_Data_Document"
25207 }
25208 }
25209 },
25210 "description" : "Successful response"
25211 },
25212 "400" : {
25213 "$ref" : "#/components/responses/Default400Response"
25214 },
25215 "404" : {
25216 "$ref" : "#/components/responses/Default404Response"
25217 },
25218 "405" : {
25219 "$ref" : "#/components/responses/Default405Response"
25220 },
25221 "406" : {
25222 "$ref" : "#/components/responses/Default406Response"
25223 },
25224 "415" : {
25225 "$ref" : "#/components/responses/Default415Response"
25226 },
25227 "429" : {
25228 "$ref" : "#/components/responses/Default429Response"
25229 },
25230 "500" : {
25231 "$ref" : "#/components/responses/Default500Response"
25232 },
25233 "503" : {
25234 "$ref" : "#/components/responses/Default503Response"
25235 }
25236 },
25237 "security" : [ {
25238 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
25239 } ],
25240 "summary" : "Get owners relationship (\"to-many\").",
25241 "tags" : [ "userCollections" ],
25242 "x-path-item-properties" : {
25243 "required-access-tier" : "THIRD_PARTY"
25244 }
25245 }
25246 },
25247 "/userCollections/{id}/relationships/playlists" : {
25248 "delete" : {
25249 "deprecated" : true,
25250 "description" : "Deprecated. Use the userCollectionPlaylists resource and its items relationship instead.",
25251 "parameters" : [ {
25252 "description" : "User collection id",
25253 "example" : "123456",
25254 "in" : "path",
25255 "name" : "id",
25256 "required" : true,
25257 "schema" : {
25258 "type" : "string"
25259 }
25260 }, {
25261 "$ref" : "#/components/parameters/IdempotencyKey"
25262 } ],
25263 "requestBody" : {
25264 "content" : {
25265 "application/vnd.api+json" : {
25266 "schema" : {
25267 "$ref" : "#/components/schemas/UserCollectionsPlaylistsRelationshipRemoveOperation_Payload"
25268 }
25269 }
25270 }
25271 },
25272 "responses" : {
25273 "400" : {
25274 "$ref" : "#/components/responses/Default400Response"
25275 },
25276 "404" : {
25277 "$ref" : "#/components/responses/Default404Response"
25278 },
25279 "405" : {
25280 "$ref" : "#/components/responses/Default405Response"
25281 },
25282 "406" : {
25283 "$ref" : "#/components/responses/Default406Response"
25284 },
25285 "409" : {
25286 "$ref" : "#/components/responses/Idempotency409Response"
25287 },
25288 "415" : {
25289 "$ref" : "#/components/responses/Default415Response"
25290 },
25291 "422" : {
25292 "$ref" : "#/components/responses/Idempotency422Response"
25293 },
25294 "429" : {
25295 "$ref" : "#/components/responses/Default429Response"
25296 },
25297 "500" : {
25298 "$ref" : "#/components/responses/Default500Response"
25299 },
25300 "503" : {
25301 "$ref" : "#/components/responses/Default503Response"
25302 }
25303 },
25304 "security" : [ {
25305 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
25306 } ],
25307 "summary" : "Delete from playlists relationship (\"to-many\").",
25308 "tags" : [ "userCollections" ],
25309 "x-path-item-properties" : {
25310 "required-access-tier" : "THIRD_PARTY"
25311 }
25312 },
25313 "get" : {
25314 "deprecated" : true,
25315 "description" : "Deprecated. Use the userCollectionPlaylists resource and its items relationship instead.",
25316 "parameters" : [ {
25317 "description" : "User collection id",
25318 "example" : "123456",
25319 "in" : "path",
25320 "name" : "id",
25321 "required" : true,
25322 "schema" : {
25323 "type" : "string"
25324 }
25325 }, {
25326 "in" : "query",
25327 "name" : "collectionView",
25328 "required" : false,
25329 "schema" : {
25330 "type" : "string",
25331 "enum" : [ "FOLDERS" ]
25332 }
25333 }, {
25334 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
25335 "in" : "query",
25336 "name" : "page[cursor]",
25337 "required" : false,
25338 "schema" : {
25339 "type" : "string"
25340 }
25341 }, {
25342 "description" : "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
25343 "in" : "query",
25344 "name" : "sort",
25345 "required" : false,
25346 "schema" : {
25347 "type" : "array",
25348 "items" : {
25349 "type" : "string",
25350 "example" : "playlists.addedAt",
25351 "default" : "-playlists.addedAt",
25352 "enum" : [ "playlists.addedAt", "-playlists.addedAt", "playlists.lastUpdatedAt", "-playlists.lastUpdatedAt", "playlists.name", "-playlists.name" ],
25353 "x-enum-varnames" : [ "PlaylistsAddedAtAsc", "PlaylistsAddedAtDesc", "PlaylistsLastUpdatedAtAsc", "PlaylistsLastUpdatedAtDesc", "PlaylistsNameAsc", "PlaylistsNameDesc" ]
25354 }
25355 }
25356 }, {
25357 "description" : "Allows the client to customize which related resources should be returned. Available options: playlists",
25358 "example" : "playlists.items",
25359 "in" : "query",
25360 "name" : "include",
25361 "required" : false,
25362 "schema" : {
25363 "type" : "array",
25364 "items" : {
25365 "type" : "string",
25366 "example" : "playlists.items"
25367 }
25368 }
25369 }, {
25370 "description" : "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",
25371 "example" : "playlists.items",
25372 "in" : "query",
25373 "name" : "replaceMedia",
25374 "required" : false,
25375 "schema" : {
25376 "type" : "string",
25377 "example" : "playlists.items"
25378 }
25379 } ],
25380 "responses" : {
25381 "200" : {
25382 "content" : {
25383 "application/vnd.api+json" : {
25384 "schema" : {
25385 "$ref" : "#/components/schemas/UserCollections_Playlists_Multi_Relationship_Data_Document"
25386 }
25387 }
25388 },
25389 "description" : "Successful response"
25390 },
25391 "400" : {
25392 "$ref" : "#/components/responses/Default400Response"
25393 },
25394 "404" : {
25395 "$ref" : "#/components/responses/Default404Response"
25396 },
25397 "405" : {
25398 "$ref" : "#/components/responses/Default405Response"
25399 },
25400 "406" : {
25401 "$ref" : "#/components/responses/Default406Response"
25402 },
25403 "415" : {
25404 "$ref" : "#/components/responses/Default415Response"
25405 },
25406 "429" : {
25407 "$ref" : "#/components/responses/Default429Response"
25408 },
25409 "500" : {
25410 "$ref" : "#/components/responses/Default500Response"
25411 },
25412 "503" : {
25413 "$ref" : "#/components/responses/Default503Response"
25414 }
25415 },
25416 "security" : [ {
25417 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
25418 } ],
25419 "summary" : "Get playlists relationship (\"to-many\").",
25420 "tags" : [ "userCollections" ],
25421 "x-path-item-properties" : {
25422 "required-access-tier" : "THIRD_PARTY"
25423 }
25424 },
25425 "post" : {
25426 "deprecated" : true,
25427 "description" : "Deprecated. Use the userCollectionPlaylists resource and its items relationship instead.",
25428 "parameters" : [ {
25429 "description" : "User collection id",
25430 "example" : "123456",
25431 "in" : "path",
25432 "name" : "id",
25433 "required" : true,
25434 "schema" : {
25435 "type" : "string"
25436 }
25437 }, {
25438 "$ref" : "#/components/parameters/IdempotencyKey"
25439 } ],
25440 "requestBody" : {
25441 "content" : {
25442 "application/vnd.api+json" : {
25443 "schema" : {
25444 "$ref" : "#/components/schemas/UserCollectionsPlaylistsRelationshipAddOperation_Payload"
25445 }
25446 }
25447 }
25448 },
25449 "responses" : {
25450 "201" : {
25451 "description" : "Successful response"
25452 },
25453 "400" : {
25454 "$ref" : "#/components/responses/Default400Response"
25455 },
25456 "404" : {
25457 "$ref" : "#/components/responses/Default404Response"
25458 },
25459 "405" : {
25460 "$ref" : "#/components/responses/Default405Response"
25461 },
25462 "406" : {
25463 "$ref" : "#/components/responses/Default406Response"
25464 },
25465 "409" : {
25466 "$ref" : "#/components/responses/UserCollectionsAddMultiDataRelationship409Response"
25467 },
25468 "415" : {
25469 "$ref" : "#/components/responses/Default415Response"
25470 },
25471 "422" : {
25472 "$ref" : "#/components/responses/Idempotency422Response"
25473 },
25474 "429" : {
25475 "$ref" : "#/components/responses/Default429Response"
25476 },
25477 "500" : {
25478 "$ref" : "#/components/responses/Default500Response"
25479 },
25480 "503" : {
25481 "$ref" : "#/components/responses/Default503Response"
25482 }
25483 },
25484 "security" : [ {
25485 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
25486 } ],
25487 "summary" : "Add to playlists relationship (\"to-many\").",
25488 "tags" : [ "userCollections" ],
25489 "x-path-item-properties" : {
25490 "required-access-tier" : "THIRD_PARTY"
25491 }
25492 }
25493 },
25494 "/userCollections/{id}/relationships/tracks" : {
25495 "delete" : {
25496 "deprecated" : true,
25497 "description" : "Deprecated. Use the userCollectionTracks resource and its items relationship instead.",
25498 "parameters" : [ {
25499 "description" : "User collection id",
25500 "example" : "123456",
25501 "in" : "path",
25502 "name" : "id",
25503 "required" : true,
25504 "schema" : {
25505 "type" : "string"
25506 }
25507 }, {
25508 "$ref" : "#/components/parameters/IdempotencyKey"
25509 } ],
25510 "requestBody" : {
25511 "content" : {
25512 "application/vnd.api+json" : {
25513 "schema" : {
25514 "$ref" : "#/components/schemas/UserCollectionsTracksRelationshipRemoveOperation_Payload"
25515 }
25516 }
25517 }
25518 },
25519 "responses" : {
25520 "400" : {
25521 "$ref" : "#/components/responses/Default400Response"
25522 },
25523 "404" : {
25524 "$ref" : "#/components/responses/Default404Response"
25525 },
25526 "405" : {
25527 "$ref" : "#/components/responses/Default405Response"
25528 },
25529 "406" : {
25530 "$ref" : "#/components/responses/Default406Response"
25531 },
25532 "409" : {
25533 "$ref" : "#/components/responses/Idempotency409Response"
25534 },
25535 "415" : {
25536 "$ref" : "#/components/responses/Default415Response"
25537 },
25538 "422" : {
25539 "$ref" : "#/components/responses/Idempotency422Response"
25540 },
25541 "429" : {
25542 "$ref" : "#/components/responses/Default429Response"
25543 },
25544 "500" : {
25545 "$ref" : "#/components/responses/Default500Response"
25546 },
25547 "503" : {
25548 "$ref" : "#/components/responses/Default503Response"
25549 }
25550 },
25551 "security" : [ {
25552 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
25553 } ],
25554 "summary" : "Delete from tracks relationship (\"to-many\").",
25555 "tags" : [ "userCollections" ],
25556 "x-path-item-properties" : {
25557 "required-access-tier" : "THIRD_PARTY"
25558 }
25559 },
25560 "get" : {
25561 "deprecated" : true,
25562 "description" : "Deprecated. Use the userCollectionTracks resource and its items relationship instead.",
25563 "parameters" : [ {
25564 "description" : "User collection id",
25565 "example" : "123456",
25566 "in" : "path",
25567 "name" : "id",
25568 "required" : true,
25569 "schema" : {
25570 "type" : "string"
25571 }
25572 }, {
25573 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
25574 "in" : "query",
25575 "name" : "page[cursor]",
25576 "required" : false,
25577 "schema" : {
25578 "type" : "string"
25579 }
25580 }, {
25581 "description" : "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
25582 "in" : "query",
25583 "name" : "sort",
25584 "required" : false,
25585 "schema" : {
25586 "type" : "array",
25587 "items" : {
25588 "type" : "string",
25589 "example" : "tracks.addedAt",
25590 "default" : "-tracks.addedAt",
25591 "enum" : [ "tracks.addedAt", "-tracks.addedAt", "tracks.albums.title", "-tracks.albums.title", "tracks.artists.name", "-tracks.artists.name", "tracks.duration", "-tracks.duration", "tracks.title", "-tracks.title" ],
25592 "x-enum-varnames" : [ "TracksAddedAtAsc", "TracksAddedAtDesc", "TracksAlbumsTitleAsc", "TracksAlbumsTitleDesc", "TracksArtistsNameAsc", "TracksArtistsNameDesc", "TracksDurationAsc", "TracksDurationDesc", "TracksTitleAsc", "TracksTitleDesc" ]
25593 }
25594 }
25595 }, {
25596 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
25597 "example" : "en-US",
25598 "in" : "query",
25599 "name" : "locale",
25600 "required" : false,
25601 "schema" : {
25602 "type" : "string",
25603 "default" : "en-US"
25604 }
25605 }, {
25606 "description" : "Allows the client to customize which related resources should be returned. Available options: tracks",
25607 "example" : "tracks",
25608 "in" : "query",
25609 "name" : "include",
25610 "required" : false,
25611 "schema" : {
25612 "type" : "array",
25613 "items" : {
25614 "type" : "string",
25615 "example" : "tracks"
25616 }
25617 }
25618 }, {
25619 "description" : "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",
25620 "example" : "tracks",
25621 "in" : "query",
25622 "name" : "replaceMedia",
25623 "required" : false,
25624 "schema" : {
25625 "type" : "string",
25626 "example" : "tracks"
25627 }
25628 } ],
25629 "responses" : {
25630 "200" : {
25631 "content" : {
25632 "application/vnd.api+json" : {
25633 "schema" : {
25634 "$ref" : "#/components/schemas/UserCollections_Tracks_Multi_Relationship_Data_Document"
25635 }
25636 }
25637 },
25638 "description" : "Successful response"
25639 },
25640 "400" : {
25641 "$ref" : "#/components/responses/Default400Response"
25642 },
25643 "404" : {
25644 "$ref" : "#/components/responses/Default404Response"
25645 },
25646 "405" : {
25647 "$ref" : "#/components/responses/Default405Response"
25648 },
25649 "406" : {
25650 "$ref" : "#/components/responses/Default406Response"
25651 },
25652 "415" : {
25653 "$ref" : "#/components/responses/Default415Response"
25654 },
25655 "429" : {
25656 "$ref" : "#/components/responses/Default429Response"
25657 },
25658 "500" : {
25659 "$ref" : "#/components/responses/Default500Response"
25660 },
25661 "503" : {
25662 "$ref" : "#/components/responses/Default503Response"
25663 }
25664 },
25665 "security" : [ {
25666 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
25667 } ],
25668 "summary" : "Get tracks relationship (\"to-many\").",
25669 "tags" : [ "userCollections" ],
25670 "x-path-item-properties" : {
25671 "required-access-tier" : "THIRD_PARTY"
25672 }
25673 },
25674 "post" : {
25675 "deprecated" : true,
25676 "description" : "Deprecated. Use the userCollectionTracks resource and its items relationship instead.",
25677 "parameters" : [ {
25678 "description" : "User collection id",
25679 "example" : "123456",
25680 "in" : "path",
25681 "name" : "id",
25682 "required" : true,
25683 "schema" : {
25684 "type" : "string"
25685 }
25686 }, {
25687 "$ref" : "#/components/parameters/IdempotencyKey"
25688 } ],
25689 "requestBody" : {
25690 "content" : {
25691 "application/vnd.api+json" : {
25692 "schema" : {
25693 "$ref" : "#/components/schemas/UserCollectionsTracksRelationshipAddOperation_Payload"
25694 }
25695 }
25696 }
25697 },
25698 "responses" : {
25699 "201" : {
25700 "description" : "Successful response"
25701 },
25702 "400" : {
25703 "$ref" : "#/components/responses/Default400Response"
25704 },
25705 "404" : {
25706 "$ref" : "#/components/responses/Default404Response"
25707 },
25708 "405" : {
25709 "$ref" : "#/components/responses/Default405Response"
25710 },
25711 "406" : {
25712 "$ref" : "#/components/responses/Default406Response"
25713 },
25714 "409" : {
25715 "$ref" : "#/components/responses/UserCollectionsAddMultiDataRelationship409Response"
25716 },
25717 "415" : {
25718 "$ref" : "#/components/responses/Default415Response"
25719 },
25720 "422" : {
25721 "$ref" : "#/components/responses/Idempotency422Response"
25722 },
25723 "429" : {
25724 "$ref" : "#/components/responses/Default429Response"
25725 },
25726 "500" : {
25727 "$ref" : "#/components/responses/Default500Response"
25728 },
25729 "503" : {
25730 "$ref" : "#/components/responses/Default503Response"
25731 }
25732 },
25733 "security" : [ {
25734 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
25735 } ],
25736 "summary" : "Add to tracks relationship (\"to-many\").",
25737 "tags" : [ "userCollections" ],
25738 "x-path-item-properties" : {
25739 "required-access-tier" : "THIRD_PARTY"
25740 }
25741 }
25742 },
25743 "/userCollections/{id}/relationships/videos" : {
25744 "delete" : {
25745 "deprecated" : true,
25746 "description" : "Deprecated. Use the userCollectionVideos resource and its items relationship instead.",
25747 "parameters" : [ {
25748 "description" : "User collection id",
25749 "example" : "123456",
25750 "in" : "path",
25751 "name" : "id",
25752 "required" : true,
25753 "schema" : {
25754 "type" : "string"
25755 }
25756 }, {
25757 "$ref" : "#/components/parameters/IdempotencyKey"
25758 } ],
25759 "requestBody" : {
25760 "content" : {
25761 "application/vnd.api+json" : {
25762 "schema" : {
25763 "$ref" : "#/components/schemas/UserCollectionsVideosRelationshipRemoveOperation_Payload"
25764 }
25765 }
25766 }
25767 },
25768 "responses" : {
25769 "400" : {
25770 "$ref" : "#/components/responses/Default400Response"
25771 },
25772 "404" : {
25773 "$ref" : "#/components/responses/Default404Response"
25774 },
25775 "405" : {
25776 "$ref" : "#/components/responses/Default405Response"
25777 },
25778 "406" : {
25779 "$ref" : "#/components/responses/Default406Response"
25780 },
25781 "409" : {
25782 "$ref" : "#/components/responses/Idempotency409Response"
25783 },
25784 "415" : {
25785 "$ref" : "#/components/responses/Default415Response"
25786 },
25787 "422" : {
25788 "$ref" : "#/components/responses/Idempotency422Response"
25789 },
25790 "429" : {
25791 "$ref" : "#/components/responses/Default429Response"
25792 },
25793 "500" : {
25794 "$ref" : "#/components/responses/Default500Response"
25795 },
25796 "503" : {
25797 "$ref" : "#/components/responses/Default503Response"
25798 }
25799 },
25800 "security" : [ {
25801 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
25802 } ],
25803 "summary" : "Delete from videos relationship (\"to-many\").",
25804 "tags" : [ "userCollections" ],
25805 "x-path-item-properties" : {
25806 "required-access-tier" : "THIRD_PARTY"
25807 }
25808 },
25809 "get" : {
25810 "deprecated" : true,
25811 "description" : "Deprecated. Use the userCollectionVideos resource and its items relationship instead.",
25812 "parameters" : [ {
25813 "description" : "User collection id",
25814 "example" : "123456",
25815 "in" : "path",
25816 "name" : "id",
25817 "required" : true,
25818 "schema" : {
25819 "type" : "string"
25820 }
25821 }, {
25822 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
25823 "in" : "query",
25824 "name" : "page[cursor]",
25825 "required" : false,
25826 "schema" : {
25827 "type" : "string"
25828 }
25829 }, {
25830 "description" : "Values prefixed with \"-\" are sorted descending; values without it are sorted ascending.",
25831 "in" : "query",
25832 "name" : "sort",
25833 "required" : false,
25834 "schema" : {
25835 "type" : "array",
25836 "items" : {
25837 "type" : "string",
25838 "example" : "videos.addedAt",
25839 "default" : "-videos.addedAt",
25840 "enum" : [ "videos.addedAt", "-videos.addedAt", "videos.artists.name", "-videos.artists.name", "videos.duration", "-videos.duration", "videos.title", "-videos.title" ],
25841 "x-enum-varnames" : [ "VideosAddedAtAsc", "VideosAddedAtDesc", "VideosArtistsNameAsc", "VideosArtistsNameDesc", "VideosDurationAsc", "VideosDurationDesc", "VideosTitleAsc", "VideosTitleDesc" ]
25842 }
25843 }
25844 }, {
25845 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
25846 "example" : "en-US",
25847 "in" : "query",
25848 "name" : "locale",
25849 "required" : false,
25850 "schema" : {
25851 "type" : "string",
25852 "default" : "en-US"
25853 }
25854 }, {
25855 "description" : "Allows the client to customize which related resources should be returned. Available options: videos",
25856 "example" : "videos",
25857 "in" : "query",
25858 "name" : "include",
25859 "required" : false,
25860 "schema" : {
25861 "type" : "array",
25862 "items" : {
25863 "type" : "string",
25864 "example" : "videos"
25865 }
25866 }
25867 }, {
25868 "description" : "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",
25869 "example" : "videos",
25870 "in" : "query",
25871 "name" : "replaceMedia",
25872 "required" : false,
25873 "schema" : {
25874 "type" : "string",
25875 "example" : "videos"
25876 }
25877 } ],
25878 "responses" : {
25879 "200" : {
25880 "content" : {
25881 "application/vnd.api+json" : {
25882 "schema" : {
25883 "$ref" : "#/components/schemas/UserCollections_Videos_Multi_Relationship_Data_Document"
25884 }
25885 }
25886 },
25887 "description" : "Successful response"
25888 },
25889 "400" : {
25890 "$ref" : "#/components/responses/Default400Response"
25891 },
25892 "404" : {
25893 "$ref" : "#/components/responses/Default404Response"
25894 },
25895 "405" : {
25896 "$ref" : "#/components/responses/Default405Response"
25897 },
25898 "406" : {
25899 "$ref" : "#/components/responses/Default406Response"
25900 },
25901 "415" : {
25902 "$ref" : "#/components/responses/Default415Response"
25903 },
25904 "429" : {
25905 "$ref" : "#/components/responses/Default429Response"
25906 },
25907 "500" : {
25908 "$ref" : "#/components/responses/Default500Response"
25909 },
25910 "503" : {
25911 "$ref" : "#/components/responses/Default503Response"
25912 }
25913 },
25914 "security" : [ {
25915 "Authorization_Code_PKCE" : [ "collection.read", "r_usr" ]
25916 } ],
25917 "summary" : "Get videos relationship (\"to-many\").",
25918 "tags" : [ "userCollections" ],
25919 "x-path-item-properties" : {
25920 "required-access-tier" : "THIRD_PARTY"
25921 }
25922 },
25923 "post" : {
25924 "deprecated" : true,
25925 "description" : "Deprecated. Use the userCollectionVideos resource and its items relationship instead.",
25926 "parameters" : [ {
25927 "description" : "User collection id",
25928 "example" : "123456",
25929 "in" : "path",
25930 "name" : "id",
25931 "required" : true,
25932 "schema" : {
25933 "type" : "string"
25934 }
25935 }, {
25936 "$ref" : "#/components/parameters/IdempotencyKey"
25937 } ],
25938 "requestBody" : {
25939 "content" : {
25940 "application/vnd.api+json" : {
25941 "schema" : {
25942 "$ref" : "#/components/schemas/UserCollectionsVideosRelationshipAddOperation_Payload"
25943 }
25944 }
25945 }
25946 },
25947 "responses" : {
25948 "201" : {
25949 "description" : "Successful response"
25950 },
25951 "400" : {
25952 "$ref" : "#/components/responses/Default400Response"
25953 },
25954 "404" : {
25955 "$ref" : "#/components/responses/Default404Response"
25956 },
25957 "405" : {
25958 "$ref" : "#/components/responses/Default405Response"
25959 },
25960 "406" : {
25961 "$ref" : "#/components/responses/Default406Response"
25962 },
25963 "409" : {
25964 "$ref" : "#/components/responses/UserCollectionsAddMultiDataRelationship409Response"
25965 },
25966 "415" : {
25967 "$ref" : "#/components/responses/Default415Response"
25968 },
25969 "422" : {
25970 "$ref" : "#/components/responses/Idempotency422Response"
25971 },
25972 "429" : {
25973 "$ref" : "#/components/responses/Default429Response"
25974 },
25975 "500" : {
25976 "$ref" : "#/components/responses/Default500Response"
25977 },
25978 "503" : {
25979 "$ref" : "#/components/responses/Default503Response"
25980 }
25981 },
25982 "security" : [ {
25983 "Authorization_Code_PKCE" : [ "collection.write", "w_usr" ]
25984 } ],
25985 "summary" : "Add to videos relationship (\"to-many\").",
25986 "tags" : [ "userCollections" ],
25987 "x-path-item-properties" : {
25988 "required-access-tier" : "THIRD_PARTY"
25989 }
25990 }
25991 },
25992 "/userDailyMixes/{id}" : {
25993 "get" : {
25994 "description" : "Retrieves single userDailyMixe by id.",
25995 "parameters" : [ {
25996 "description" : "User daily mixes id. Use `me` for the authenticated user's resource",
25997 "example" : "me",
25998 "in" : "path",
25999 "name" : "id",
26000 "required" : true,
26001 "schema" : {
26002 "type" : "string"
26003 }
26004 }, {
26005 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
26006 "example" : "en-US",
26007 "in" : "query",
26008 "name" : "locale",
26009 "required" : false,
26010 "schema" : {
26011 "type" : "string",
26012 "default" : "en-US"
26013 }
26014 }, {
26015 "description" : "Allows the client to customize which related resources should be returned. Available options: items",
26016 "example" : "items.items",
26017 "in" : "query",
26018 "name" : "include",
26019 "required" : false,
26020 "schema" : {
26021 "type" : "array",
26022 "items" : {
26023 "type" : "string",
26024 "example" : "items.items"
26025 }
26026 }
26027 }, {
26028 "description" : "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",
26029 "example" : "items.items",
26030 "in" : "query",
26031 "name" : "replaceMedia",
26032 "required" : false,
26033 "schema" : {
26034 "type" : "string",
26035 "example" : "items.items"
26036 }
26037 } ],
26038 "responses" : {
26039 "200" : {
26040 "content" : {
26041 "application/vnd.api+json" : {
26042 "schema" : {
26043 "$ref" : "#/components/schemas/UserDailyMixes_Single_Resource_Data_Document"
26044 }
26045 }
26046 },
26047 "description" : "Successful response"
26048 },
26049 "400" : {
26050 "$ref" : "#/components/responses/Default400Response"
26051 },
26052 "404" : {
26053 "$ref" : "#/components/responses/Default404Response"
26054 },
26055 "405" : {
26056 "$ref" : "#/components/responses/Default405Response"
26057 },
26058 "406" : {
26059 "$ref" : "#/components/responses/Default406Response"
26060 },
26061 "415" : {
26062 "$ref" : "#/components/responses/Default415Response"
26063 },
26064 "429" : {
26065 "$ref" : "#/components/responses/Default429Response"
26066 },
26067 "500" : {
26068 "$ref" : "#/components/responses/Default500Response"
26069 },
26070 "503" : {
26071 "$ref" : "#/components/responses/Default503Response"
26072 }
26073 },
26074 "security" : [ {
26075 "Authorization_Code_PKCE" : [ "r_usr", "recommendations.read" ]
26076 } ],
26077 "summary" : "Get single userDailyMixe.",
26078 "tags" : [ "userDailyMixes" ],
26079 "x-path-item-properties" : {
26080 "required-access-tier" : "THIRD_PARTY"
26081 }
26082 }
26083 },
26084 "/userDailyMixes/{id}/relationships/items" : {
26085 "get" : {
26086 "description" : "Retrieves items relationship.",
26087 "parameters" : [ {
26088 "description" : "User daily mixes id. Use `me` for the authenticated user's resource",
26089 "example" : "me",
26090 "in" : "path",
26091 "name" : "id",
26092 "required" : true,
26093 "schema" : {
26094 "type" : "string"
26095 }
26096 }, {
26097 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
26098 "in" : "query",
26099 "name" : "page[cursor]",
26100 "required" : false,
26101 "schema" : {
26102 "type" : "string"
26103 }
26104 }, {
26105 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
26106 "example" : "en-US",
26107 "in" : "query",
26108 "name" : "locale",
26109 "required" : false,
26110 "schema" : {
26111 "type" : "string",
26112 "default" : "en-US"
26113 }
26114 }, {
26115 "description" : "Allows the client to customize which related resources should be returned. Available options: items",
26116 "example" : "items.items",
26117 "in" : "query",
26118 "name" : "include",
26119 "required" : false,
26120 "schema" : {
26121 "type" : "array",
26122 "items" : {
26123 "type" : "string",
26124 "example" : "items.items"
26125 }
26126 }
26127 }, {
26128 "description" : "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",
26129 "example" : "items.items",
26130 "in" : "query",
26131 "name" : "replaceMedia",
26132 "required" : false,
26133 "schema" : {
26134 "type" : "string",
26135 "example" : "items.items"
26136 }
26137 } ],
26138 "responses" : {
26139 "200" : {
26140 "content" : {
26141 "application/vnd.api+json" : {
26142 "schema" : {
26143 "$ref" : "#/components/schemas/UserDailyMixes_Multi_Relationship_Data_Document"
26144 }
26145 }
26146 },
26147 "description" : "Successful response"
26148 },
26149 "400" : {
26150 "$ref" : "#/components/responses/Default400Response"
26151 },
26152 "404" : {
26153 "$ref" : "#/components/responses/Default404Response"
26154 },
26155 "405" : {
26156 "$ref" : "#/components/responses/Default405Response"
26157 },
26158 "406" : {
26159 "$ref" : "#/components/responses/Default406Response"
26160 },
26161 "415" : {
26162 "$ref" : "#/components/responses/Default415Response"
26163 },
26164 "429" : {
26165 "$ref" : "#/components/responses/Default429Response"
26166 },
26167 "500" : {
26168 "$ref" : "#/components/responses/Default500Response"
26169 },
26170 "503" : {
26171 "$ref" : "#/components/responses/Default503Response"
26172 }
26173 },
26174 "security" : [ {
26175 "Authorization_Code_PKCE" : [ "r_usr", "recommendations.read" ]
26176 } ],
26177 "summary" : "Get items relationship (\"to-many\").",
26178 "tags" : [ "userDailyMixes" ],
26179 "x-path-item-properties" : {
26180 "required-access-tier" : "THIRD_PARTY"
26181 }
26182 }
26183 },
26184 "/userDataExportRequests" : {
26185 "post" : {
26186 "description" : "Creates a new userDataExportRequest.",
26187 "parameters" : [ {
26188 "$ref" : "#/components/parameters/IdempotencyKey"
26189 } ],
26190 "requestBody" : {
26191 "content" : {
26192 "application/vnd.api+json" : {
26193 "schema" : {
26194 "$ref" : "#/components/schemas/UserDataExportRequestsCreateOperation_Payload"
26195 }
26196 }
26197 }
26198 },
26199 "responses" : {
26200 "201" : {
26201 "content" : {
26202 "application/vnd.api+json" : {
26203 "schema" : {
26204 "$ref" : "#/components/schemas/UserDataExportRequests_Create_Single_Resource_Data_Document"
26205 }
26206 }
26207 },
26208 "description" : "Successful response"
26209 },
26210 "400" : {
26211 "$ref" : "#/components/responses/Default400Response"
26212 },
26213 "404" : {
26214 "$ref" : "#/components/responses/Default404Response"
26215 },
26216 "405" : {
26217 "$ref" : "#/components/responses/Default405Response"
26218 },
26219 "406" : {
26220 "$ref" : "#/components/responses/Default406Response"
26221 },
26222 "409" : {
26223 "$ref" : "#/components/responses/Idempotency409Response"
26224 },
26225 "415" : {
26226 "$ref" : "#/components/responses/Default415Response"
26227 },
26228 "422" : {
26229 "$ref" : "#/components/responses/Idempotency422Response"
26230 },
26231 "429" : {
26232 "$ref" : "#/components/responses/Default429Response"
26233 },
26234 "500" : {
26235 "$ref" : "#/components/responses/Default500Response"
26236 },
26237 "503" : {
26238 "$ref" : "#/components/responses/Default503Response"
26239 }
26240 },
26241 "security" : [ {
26242 "Authorization_Code_PKCE" : [ "w_usr" ]
26243 } ],
26244 "summary" : "Create single userDataExportRequest.",
26245 "tags" : [ "userDataExportRequests" ],
26246 "x-path-item-properties" : {
26247 "required-access-tier" : "INTERNAL"
26248 }
26249 }
26250 },
26251 "/userDiscoveryMixes/{id}" : {
26252 "get" : {
26253 "description" : "Retrieves single userDiscoveryMixe by id.",
26254 "parameters" : [ {
26255 "description" : "User discovery mixes id. Use `me` for the authenticated user's resource",
26256 "example" : "me",
26257 "in" : "path",
26258 "name" : "id",
26259 "required" : true,
26260 "schema" : {
26261 "type" : "string"
26262 }
26263 }, {
26264 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
26265 "example" : "en-US",
26266 "in" : "query",
26267 "name" : "locale",
26268 "required" : false,
26269 "schema" : {
26270 "type" : "string",
26271 "default" : "en-US"
26272 }
26273 }, {
26274 "description" : "Allows the client to customize which related resources should be returned. Available options: items",
26275 "example" : "items.items",
26276 "in" : "query",
26277 "name" : "include",
26278 "required" : false,
26279 "schema" : {
26280 "type" : "array",
26281 "items" : {
26282 "type" : "string",
26283 "example" : "items.items"
26284 }
26285 }
26286 }, {
26287 "description" : "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",
26288 "example" : "items.items",
26289 "in" : "query",
26290 "name" : "replaceMedia",
26291 "required" : false,
26292 "schema" : {
26293 "type" : "string",
26294 "example" : "items.items"
26295 }
26296 } ],
26297 "responses" : {
26298 "200" : {
26299 "content" : {
26300 "application/vnd.api+json" : {
26301 "schema" : {
26302 "$ref" : "#/components/schemas/UserDiscoveryMixes_Single_Resource_Data_Document"
26303 }
26304 }
26305 },
26306 "description" : "Successful response"
26307 },
26308 "400" : {
26309 "$ref" : "#/components/responses/Default400Response"
26310 },
26311 "404" : {
26312 "$ref" : "#/components/responses/Default404Response"
26313 },
26314 "405" : {
26315 "$ref" : "#/components/responses/Default405Response"
26316 },
26317 "406" : {
26318 "$ref" : "#/components/responses/Default406Response"
26319 },
26320 "415" : {
26321 "$ref" : "#/components/responses/Default415Response"
26322 },
26323 "429" : {
26324 "$ref" : "#/components/responses/Default429Response"
26325 },
26326 "500" : {
26327 "$ref" : "#/components/responses/Default500Response"
26328 },
26329 "503" : {
26330 "$ref" : "#/components/responses/Default503Response"
26331 }
26332 },
26333 "security" : [ {
26334 "Authorization_Code_PKCE" : [ "r_usr", "recommendations.read" ]
26335 } ],
26336 "summary" : "Get single userDiscoveryMixe.",
26337 "tags" : [ "userDiscoveryMixes" ],
26338 "x-path-item-properties" : {
26339 "required-access-tier" : "THIRD_PARTY"
26340 }
26341 }
26342 },
26343 "/userDiscoveryMixes/{id}/relationships/items" : {
26344 "get" : {
26345 "description" : "Retrieves items relationship.",
26346 "parameters" : [ {
26347 "description" : "User discovery mixes id. Use `me` for the authenticated user's resource",
26348 "example" : "me",
26349 "in" : "path",
26350 "name" : "id",
26351 "required" : true,
26352 "schema" : {
26353 "type" : "string"
26354 }
26355 }, {
26356 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
26357 "in" : "query",
26358 "name" : "page[cursor]",
26359 "required" : false,
26360 "schema" : {
26361 "type" : "string"
26362 }
26363 }, {
26364 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
26365 "example" : "en-US",
26366 "in" : "query",
26367 "name" : "locale",
26368 "required" : false,
26369 "schema" : {
26370 "type" : "string",
26371 "default" : "en-US"
26372 }
26373 }, {
26374 "description" : "Allows the client to customize which related resources should be returned. Available options: items",
26375 "example" : "items.items",
26376 "in" : "query",
26377 "name" : "include",
26378 "required" : false,
26379 "schema" : {
26380 "type" : "array",
26381 "items" : {
26382 "type" : "string",
26383 "example" : "items.items"
26384 }
26385 }
26386 }, {
26387 "description" : "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",
26388 "example" : "items.items",
26389 "in" : "query",
26390 "name" : "replaceMedia",
26391 "required" : false,
26392 "schema" : {
26393 "type" : "string",
26394 "example" : "items.items"
26395 }
26396 } ],
26397 "responses" : {
26398 "200" : {
26399 "content" : {
26400 "application/vnd.api+json" : {
26401 "schema" : {
26402 "$ref" : "#/components/schemas/UserDiscoveryMixes_Multi_Relationship_Data_Document"
26403 }
26404 }
26405 },
26406 "description" : "Successful response"
26407 },
26408 "400" : {
26409 "$ref" : "#/components/responses/Default400Response"
26410 },
26411 "404" : {
26412 "$ref" : "#/components/responses/Default404Response"
26413 },
26414 "405" : {
26415 "$ref" : "#/components/responses/Default405Response"
26416 },
26417 "406" : {
26418 "$ref" : "#/components/responses/Default406Response"
26419 },
26420 "415" : {
26421 "$ref" : "#/components/responses/Default415Response"
26422 },
26423 "429" : {
26424 "$ref" : "#/components/responses/Default429Response"
26425 },
26426 "500" : {
26427 "$ref" : "#/components/responses/Default500Response"
26428 },
26429 "503" : {
26430 "$ref" : "#/components/responses/Default503Response"
26431 }
26432 },
26433 "security" : [ {
26434 "Authorization_Code_PKCE" : [ "r_usr", "recommendations.read" ]
26435 } ],
26436 "summary" : "Get items relationship (\"to-many\").",
26437 "tags" : [ "userDiscoveryMixes" ],
26438 "x-path-item-properties" : {
26439 "required-access-tier" : "THIRD_PARTY"
26440 }
26441 }
26442 },
26443 "/userNewReleaseMixes/{id}" : {
26444 "get" : {
26445 "description" : "Retrieves single userNewReleaseMixe by id.",
26446 "parameters" : [ {
26447 "description" : "User new release mixes id. Use `me` for the authenticated user's resource",
26448 "example" : "me",
26449 "in" : "path",
26450 "name" : "id",
26451 "required" : true,
26452 "schema" : {
26453 "type" : "string"
26454 }
26455 }, {
26456 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
26457 "example" : "en-US",
26458 "in" : "query",
26459 "name" : "locale",
26460 "required" : false,
26461 "schema" : {
26462 "type" : "string",
26463 "default" : "en-US"
26464 }
26465 }, {
26466 "description" : "Allows the client to customize which related resources should be returned. Available options: items",
26467 "example" : "items.items",
26468 "in" : "query",
26469 "name" : "include",
26470 "required" : false,
26471 "schema" : {
26472 "type" : "array",
26473 "items" : {
26474 "type" : "string",
26475 "example" : "items.items"
26476 }
26477 }
26478 }, {
26479 "description" : "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",
26480 "example" : "items.items",
26481 "in" : "query",
26482 "name" : "replaceMedia",
26483 "required" : false,
26484 "schema" : {
26485 "type" : "string",
26486 "example" : "items.items"
26487 }
26488 } ],
26489 "responses" : {
26490 "200" : {
26491 "content" : {
26492 "application/vnd.api+json" : {
26493 "schema" : {
26494 "$ref" : "#/components/schemas/UserNewReleaseMixes_Single_Resource_Data_Document"
26495 }
26496 }
26497 },
26498 "description" : "Successful response"
26499 },
26500 "400" : {
26501 "$ref" : "#/components/responses/Default400Response"
26502 },
26503 "404" : {
26504 "$ref" : "#/components/responses/Default404Response"
26505 },
26506 "405" : {
26507 "$ref" : "#/components/responses/Default405Response"
26508 },
26509 "406" : {
26510 "$ref" : "#/components/responses/Default406Response"
26511 },
26512 "415" : {
26513 "$ref" : "#/components/responses/Default415Response"
26514 },
26515 "429" : {
26516 "$ref" : "#/components/responses/Default429Response"
26517 },
26518 "500" : {
26519 "$ref" : "#/components/responses/Default500Response"
26520 },
26521 "503" : {
26522 "$ref" : "#/components/responses/Default503Response"
26523 }
26524 },
26525 "security" : [ {
26526 "Authorization_Code_PKCE" : [ "r_usr", "recommendations.read" ]
26527 } ],
26528 "summary" : "Get single userNewReleaseMixe.",
26529 "tags" : [ "userNewReleaseMixes" ],
26530 "x-path-item-properties" : {
26531 "required-access-tier" : "THIRD_PARTY"
26532 }
26533 }
26534 },
26535 "/userNewReleaseMixes/{id}/relationships/items" : {
26536 "get" : {
26537 "description" : "Retrieves items relationship.",
26538 "parameters" : [ {
26539 "description" : "User new release mixes id. Use `me` for the authenticated user's resource",
26540 "example" : "me",
26541 "in" : "path",
26542 "name" : "id",
26543 "required" : true,
26544 "schema" : {
26545 "type" : "string"
26546 }
26547 }, {
26548 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
26549 "in" : "query",
26550 "name" : "page[cursor]",
26551 "required" : false,
26552 "schema" : {
26553 "type" : "string"
26554 }
26555 }, {
26556 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
26557 "example" : "en-US",
26558 "in" : "query",
26559 "name" : "locale",
26560 "required" : false,
26561 "schema" : {
26562 "type" : "string",
26563 "default" : "en-US"
26564 }
26565 }, {
26566 "description" : "Allows the client to customize which related resources should be returned. Available options: items",
26567 "example" : "items.items",
26568 "in" : "query",
26569 "name" : "include",
26570 "required" : false,
26571 "schema" : {
26572 "type" : "array",
26573 "items" : {
26574 "type" : "string",
26575 "example" : "items.items"
26576 }
26577 }
26578 }, {
26579 "description" : "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",
26580 "example" : "items.items",
26581 "in" : "query",
26582 "name" : "replaceMedia",
26583 "required" : false,
26584 "schema" : {
26585 "type" : "string",
26586 "example" : "items.items"
26587 }
26588 } ],
26589 "responses" : {
26590 "200" : {
26591 "content" : {
26592 "application/vnd.api+json" : {
26593 "schema" : {
26594 "$ref" : "#/components/schemas/UserNewReleaseMixes_Multi_Relationship_Data_Document"
26595 }
26596 }
26597 },
26598 "description" : "Successful response"
26599 },
26600 "400" : {
26601 "$ref" : "#/components/responses/Default400Response"
26602 },
26603 "404" : {
26604 "$ref" : "#/components/responses/Default404Response"
26605 },
26606 "405" : {
26607 "$ref" : "#/components/responses/Default405Response"
26608 },
26609 "406" : {
26610 "$ref" : "#/components/responses/Default406Response"
26611 },
26612 "415" : {
26613 "$ref" : "#/components/responses/Default415Response"
26614 },
26615 "429" : {
26616 "$ref" : "#/components/responses/Default429Response"
26617 },
26618 "500" : {
26619 "$ref" : "#/components/responses/Default500Response"
26620 },
26621 "503" : {
26622 "$ref" : "#/components/responses/Default503Response"
26623 }
26624 },
26625 "security" : [ {
26626 "Authorization_Code_PKCE" : [ "r_usr", "recommendations.read" ]
26627 } ],
26628 "summary" : "Get items relationship (\"to-many\").",
26629 "tags" : [ "userNewReleaseMixes" ],
26630 "x-path-item-properties" : {
26631 "required-access-tier" : "THIRD_PARTY"
26632 }
26633 }
26634 },
26635 "/userOfflineMixes/{id}" : {
26636 "get" : {
26637 "description" : "Retrieves single userOfflineMixe by id.",
26638 "parameters" : [ {
26639 "description" : "User offline mixes id. Use `me` for the authenticated user's resource",
26640 "example" : "me",
26641 "in" : "path",
26642 "name" : "id",
26643 "required" : true,
26644 "schema" : {
26645 "type" : "string"
26646 }
26647 }, {
26648 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
26649 "example" : "en-US",
26650 "in" : "query",
26651 "name" : "locale",
26652 "required" : false,
26653 "schema" : {
26654 "type" : "string",
26655 "default" : "en-US"
26656 }
26657 }, {
26658 "description" : "Allows the client to customize which related resources should be returned. Available options: items",
26659 "example" : "items.items",
26660 "in" : "query",
26661 "name" : "include",
26662 "required" : false,
26663 "schema" : {
26664 "type" : "array",
26665 "items" : {
26666 "type" : "string",
26667 "example" : "items.items"
26668 }
26669 }
26670 }, {
26671 "description" : "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",
26672 "example" : "items.items",
26673 "in" : "query",
26674 "name" : "replaceMedia",
26675 "required" : false,
26676 "schema" : {
26677 "type" : "string",
26678 "example" : "items.items"
26679 }
26680 } ],
26681 "responses" : {
26682 "200" : {
26683 "content" : {
26684 "application/vnd.api+json" : {
26685 "schema" : {
26686 "$ref" : "#/components/schemas/UserOfflineMixes_Single_Resource_Data_Document"
26687 }
26688 }
26689 },
26690 "description" : "Successful response"
26691 },
26692 "400" : {
26693 "$ref" : "#/components/responses/Default400Response"
26694 },
26695 "404" : {
26696 "$ref" : "#/components/responses/Default404Response"
26697 },
26698 "405" : {
26699 "$ref" : "#/components/responses/Default405Response"
26700 },
26701 "406" : {
26702 "$ref" : "#/components/responses/Default406Response"
26703 },
26704 "415" : {
26705 "$ref" : "#/components/responses/Default415Response"
26706 },
26707 "429" : {
26708 "$ref" : "#/components/responses/Default429Response"
26709 },
26710 "500" : {
26711 "$ref" : "#/components/responses/Default500Response"
26712 },
26713 "503" : {
26714 "$ref" : "#/components/responses/Default503Response"
26715 }
26716 },
26717 "security" : [ {
26718 "Authorization_Code_PKCE" : [ "r_usr", "recommendations.read" ]
26719 } ],
26720 "summary" : "Get single userOfflineMixe.",
26721 "tags" : [ "userOfflineMixes" ],
26722 "x-path-item-properties" : {
26723 "required-access-tier" : "INTERNAL"
26724 }
26725 }
26726 },
26727 "/userOfflineMixes/{id}/relationships/items" : {
26728 "get" : {
26729 "description" : "Retrieves items relationship.",
26730 "parameters" : [ {
26731 "description" : "User offline mixes id. Use `me` for the authenticated user's resource",
26732 "example" : "me",
26733 "in" : "path",
26734 "name" : "id",
26735 "required" : true,
26736 "schema" : {
26737 "type" : "string"
26738 }
26739 }, {
26740 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
26741 "in" : "query",
26742 "name" : "page[cursor]",
26743 "required" : false,
26744 "schema" : {
26745 "type" : "string"
26746 }
26747 }, {
26748 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
26749 "example" : "en-US",
26750 "in" : "query",
26751 "name" : "locale",
26752 "required" : false,
26753 "schema" : {
26754 "type" : "string",
26755 "default" : "en-US"
26756 }
26757 }, {
26758 "description" : "Allows the client to customize which related resources should be returned. Available options: items",
26759 "example" : "items.items",
26760 "in" : "query",
26761 "name" : "include",
26762 "required" : false,
26763 "schema" : {
26764 "type" : "array",
26765 "items" : {
26766 "type" : "string",
26767 "example" : "items.items"
26768 }
26769 }
26770 }, {
26771 "description" : "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",
26772 "example" : "items.items",
26773 "in" : "query",
26774 "name" : "replaceMedia",
26775 "required" : false,
26776 "schema" : {
26777 "type" : "string",
26778 "example" : "items.items"
26779 }
26780 } ],
26781 "responses" : {
26782 "200" : {
26783 "content" : {
26784 "application/vnd.api+json" : {
26785 "schema" : {
26786 "$ref" : "#/components/schemas/UserOfflineMixes_Multi_Relationship_Data_Document"
26787 }
26788 }
26789 },
26790 "description" : "Successful response"
26791 },
26792 "400" : {
26793 "$ref" : "#/components/responses/Default400Response"
26794 },
26795 "404" : {
26796 "$ref" : "#/components/responses/Default404Response"
26797 },
26798 "405" : {
26799 "$ref" : "#/components/responses/Default405Response"
26800 },
26801 "406" : {
26802 "$ref" : "#/components/responses/Default406Response"
26803 },
26804 "415" : {
26805 "$ref" : "#/components/responses/Default415Response"
26806 },
26807 "429" : {
26808 "$ref" : "#/components/responses/Default429Response"
26809 },
26810 "500" : {
26811 "$ref" : "#/components/responses/Default500Response"
26812 },
26813 "503" : {
26814 "$ref" : "#/components/responses/Default503Response"
26815 }
26816 },
26817 "security" : [ {
26818 "Authorization_Code_PKCE" : [ "r_usr", "recommendations.read" ]
26819 } ],
26820 "summary" : "Get items relationship (\"to-many\").",
26821 "tags" : [ "userOfflineMixes" ],
26822 "x-path-item-properties" : {
26823 "required-access-tier" : "INTERNAL"
26824 }
26825 }
26826 },
26827 "/userRecommendationBlocks/{id}" : {
26828 "get" : {
26829 "description" : "Retrieves single userRecommendationBlock by id.",
26830 "parameters" : [ {
26831 "description" : "User recommendation blocks id. Use `me` for the authenticated user's resource",
26832 "example" : "me",
26833 "in" : "path",
26834 "name" : "id",
26835 "required" : true,
26836 "schema" : {
26837 "type" : "string"
26838 }
26839 }, {
26840 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
26841 "example" : "en-US",
26842 "in" : "query",
26843 "name" : "locale",
26844 "required" : false,
26845 "schema" : {
26846 "type" : "string",
26847 "default" : "en-US"
26848 }
26849 }, {
26850 "description" : "Allows the client to customize which related resources should be returned. Available options: artists, owners, tracks, videos",
26851 "example" : "artists.albums",
26852 "in" : "query",
26853 "name" : "include",
26854 "required" : false,
26855 "schema" : {
26856 "type" : "array",
26857 "items" : {
26858 "type" : "string",
26859 "example" : "artists.albums"
26860 }
26861 }
26862 }, {
26863 "description" : "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",
26864 "example" : "artists.albums",
26865 "in" : "query",
26866 "name" : "replaceMedia",
26867 "required" : false,
26868 "schema" : {
26869 "type" : "string",
26870 "example" : "artists.albums"
26871 }
26872 } ],
26873 "responses" : {
26874 "200" : {
26875 "content" : {
26876 "application/vnd.api+json" : {
26877 "schema" : {
26878 "$ref" : "#/components/schemas/UserRecommendationBlocks_Single_Resource_Data_Document"
26879 }
26880 }
26881 },
26882 "description" : "Successful response"
26883 },
26884 "400" : {
26885 "$ref" : "#/components/responses/Default400Response"
26886 },
26887 "404" : {
26888 "$ref" : "#/components/responses/Default404Response"
26889 },
26890 "405" : {
26891 "$ref" : "#/components/responses/Default405Response"
26892 },
26893 "406" : {
26894 "$ref" : "#/components/responses/Default406Response"
26895 },
26896 "415" : {
26897 "$ref" : "#/components/responses/Default415Response"
26898 },
26899 "429" : {
26900 "$ref" : "#/components/responses/Default429Response"
26901 },
26902 "500" : {
26903 "$ref" : "#/components/responses/Default500Response"
26904 },
26905 "503" : {
26906 "$ref" : "#/components/responses/Default503Response"
26907 }
26908 },
26909 "security" : [ {
26910 "Authorization_Code_PKCE" : [ "r_usr", "recommendations.read" ]
26911 } ],
26912 "summary" : "Get single userRecommendationBlock.",
26913 "tags" : [ "userRecommendationBlocks" ],
26914 "x-path-item-properties" : {
26915 "required-access-tier" : "INTERNAL"
26916 }
26917 }
26918 },
26919 "/userRecommendationBlocks/{id}/relationships/artists" : {
26920 "delete" : {
26921 "description" : "Deletes item(s) from artists relationship.",
26922 "parameters" : [ {
26923 "description" : "User recommendation blocks id. Use `me` for the authenticated user's resource",
26924 "example" : "me",
26925 "in" : "path",
26926 "name" : "id",
26927 "required" : true,
26928 "schema" : {
26929 "type" : "string"
26930 }
26931 }, {
26932 "$ref" : "#/components/parameters/IdempotencyKey"
26933 } ],
26934 "requestBody" : {
26935 "content" : {
26936 "application/vnd.api+json" : {
26937 "schema" : {
26938 "$ref" : "#/components/schemas/UserRecommendationBlocksArtistsRelationshipRemoveOperation_Payload"
26939 }
26940 }
26941 }
26942 },
26943 "responses" : {
26944 "400" : {
26945 "$ref" : "#/components/responses/Default400Response"
26946 },
26947 "404" : {
26948 "$ref" : "#/components/responses/Default404Response"
26949 },
26950 "405" : {
26951 "$ref" : "#/components/responses/Default405Response"
26952 },
26953 "406" : {
26954 "$ref" : "#/components/responses/Default406Response"
26955 },
26956 "409" : {
26957 "$ref" : "#/components/responses/Idempotency409Response"
26958 },
26959 "415" : {
26960 "$ref" : "#/components/responses/Default415Response"
26961 },
26962 "422" : {
26963 "$ref" : "#/components/responses/Idempotency422Response"
26964 },
26965 "429" : {
26966 "$ref" : "#/components/responses/Default429Response"
26967 },
26968 "500" : {
26969 "$ref" : "#/components/responses/Default500Response"
26970 },
26971 "503" : {
26972 "$ref" : "#/components/responses/Default503Response"
26973 }
26974 },
26975 "security" : [ {
26976 "Authorization_Code_PKCE" : [ "w_usr" ]
26977 } ],
26978 "summary" : "Delete from artists relationship (\"to-many\").",
26979 "tags" : [ "userRecommendationBlocks" ],
26980 "x-path-item-properties" : {
26981 "required-access-tier" : "INTERNAL"
26982 }
26983 },
26984 "get" : {
26985 "description" : "Retrieves artists relationship.",
26986 "parameters" : [ {
26987 "description" : "User recommendation blocks id. Use `me` for the authenticated user's resource",
26988 "example" : "me",
26989 "in" : "path",
26990 "name" : "id",
26991 "required" : true,
26992 "schema" : {
26993 "type" : "string"
26994 }
26995 }, {
26996 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
26997 "in" : "query",
26998 "name" : "page[cursor]",
26999 "required" : false,
27000 "schema" : {
27001 "type" : "string"
27002 }
27003 }, {
27004 "description" : "Allows the client to customize which related resources should be returned. Available options: artists",
27005 "example" : "artists.albums",
27006 "in" : "query",
27007 "name" : "include",
27008 "required" : false,
27009 "schema" : {
27010 "type" : "array",
27011 "items" : {
27012 "type" : "string",
27013 "example" : "artists.albums"
27014 }
27015 }
27016 }, {
27017 "description" : "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",
27018 "example" : "artists.albums",
27019 "in" : "query",
27020 "name" : "replaceMedia",
27021 "required" : false,
27022 "schema" : {
27023 "type" : "string",
27024 "example" : "artists.albums"
27025 }
27026 } ],
27027 "responses" : {
27028 "200" : {
27029 "content" : {
27030 "application/vnd.api+json" : {
27031 "schema" : {
27032 "$ref" : "#/components/schemas/UserRecommendationBlocks_Artists_Multi_Relationship_Data_Document"
27033 }
27034 }
27035 },
27036 "description" : "Successful response"
27037 },
27038 "400" : {
27039 "$ref" : "#/components/responses/Default400Response"
27040 },
27041 "404" : {
27042 "$ref" : "#/components/responses/Default404Response"
27043 },
27044 "405" : {
27045 "$ref" : "#/components/responses/Default405Response"
27046 },
27047 "406" : {
27048 "$ref" : "#/components/responses/Default406Response"
27049 },
27050 "415" : {
27051 "$ref" : "#/components/responses/Default415Response"
27052 },
27053 "429" : {
27054 "$ref" : "#/components/responses/Default429Response"
27055 },
27056 "500" : {
27057 "$ref" : "#/components/responses/Default500Response"
27058 },
27059 "503" : {
27060 "$ref" : "#/components/responses/Default503Response"
27061 }
27062 },
27063 "security" : [ {
27064 "Authorization_Code_PKCE" : [ "r_usr", "recommendations.read" ]
27065 } ],
27066 "summary" : "Get artists relationship (\"to-many\").",
27067 "tags" : [ "userRecommendationBlocks" ],
27068 "x-path-item-properties" : {
27069 "required-access-tier" : "INTERNAL"
27070 }
27071 },
27072 "post" : {
27073 "description" : "Adds item(s) to artists relationship.",
27074 "parameters" : [ {
27075 "description" : "User recommendation blocks id. Use `me` for the authenticated user's resource",
27076 "example" : "me",
27077 "in" : "path",
27078 "name" : "id",
27079 "required" : true,
27080 "schema" : {
27081 "type" : "string"
27082 }
27083 }, {
27084 "$ref" : "#/components/parameters/IdempotencyKey"
27085 } ],
27086 "requestBody" : {
27087 "content" : {
27088 "application/vnd.api+json" : {
27089 "schema" : {
27090 "$ref" : "#/components/schemas/UserRecommendationBlocksArtistsRelationshipAddOperation_Payload"
27091 }
27092 }
27093 }
27094 },
27095 "responses" : {
27096 "200" : {
27097 "content" : {
27098 "application/vnd.api+json" : {
27099 "schema" : {
27100 "$ref" : "#/components/schemas/UserRecommendationBlocks_Artists_Add_Multi_Relationship_Data_Document"
27101 }
27102 }
27103 },
27104 "description" : "Successful response"
27105 },
27106 "400" : {
27107 "$ref" : "#/components/responses/Default400Response"
27108 },
27109 "404" : {
27110 "$ref" : "#/components/responses/Default404Response"
27111 },
27112 "405" : {
27113 "$ref" : "#/components/responses/Default405Response"
27114 },
27115 "406" : {
27116 "$ref" : "#/components/responses/Default406Response"
27117 },
27118 "409" : {
27119 "$ref" : "#/components/responses/UserRecommendationBlocksAddMultiDataRelationshipWithResponse409Response"
27120 },
27121 "415" : {
27122 "$ref" : "#/components/responses/Default415Response"
27123 },
27124 "422" : {
27125 "$ref" : "#/components/responses/Idempotency422Response"
27126 },
27127 "429" : {
27128 "$ref" : "#/components/responses/Default429Response"
27129 },
27130 "500" : {
27131 "$ref" : "#/components/responses/Default500Response"
27132 },
27133 "503" : {
27134 "$ref" : "#/components/responses/Default503Response"
27135 }
27136 },
27137 "security" : [ {
27138 "Authorization_Code_PKCE" : [ "w_usr" ]
27139 } ],
27140 "summary" : "Add to artists relationship (\"to-many\").",
27141 "tags" : [ "userRecommendationBlocks" ],
27142 "x-path-item-properties" : {
27143 "required-access-tier" : "INTERNAL"
27144 }
27145 }
27146 },
27147 "/userRecommendationBlocks/{id}/relationships/owners" : {
27148 "get" : {
27149 "description" : "Retrieves owners relationship.",
27150 "parameters" : [ {
27151 "description" : "User recommendation blocks id. Use `me` for the authenticated user's resource",
27152 "example" : "me",
27153 "in" : "path",
27154 "name" : "id",
27155 "required" : true,
27156 "schema" : {
27157 "type" : "string"
27158 }
27159 }, {
27160 "description" : "Allows the client to customize which related resources should be returned. Available options: owners",
27161 "example" : "owners",
27162 "in" : "query",
27163 "name" : "include",
27164 "required" : false,
27165 "schema" : {
27166 "type" : "array",
27167 "items" : {
27168 "type" : "string",
27169 "example" : "owners"
27170 }
27171 }
27172 }, {
27173 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
27174 "in" : "query",
27175 "name" : "page[cursor]",
27176 "required" : false,
27177 "schema" : {
27178 "type" : "string"
27179 }
27180 } ],
27181 "responses" : {
27182 "200" : {
27183 "content" : {
27184 "application/vnd.api+json" : {
27185 "schema" : {
27186 "$ref" : "#/components/schemas/UserRecommendationBlocks_Multi_Relationship_Data_Document"
27187 }
27188 }
27189 },
27190 "description" : "Successful response"
27191 },
27192 "400" : {
27193 "$ref" : "#/components/responses/Default400Response"
27194 },
27195 "404" : {
27196 "$ref" : "#/components/responses/Default404Response"
27197 },
27198 "405" : {
27199 "$ref" : "#/components/responses/Default405Response"
27200 },
27201 "406" : {
27202 "$ref" : "#/components/responses/Default406Response"
27203 },
27204 "415" : {
27205 "$ref" : "#/components/responses/Default415Response"
27206 },
27207 "429" : {
27208 "$ref" : "#/components/responses/Default429Response"
27209 },
27210 "500" : {
27211 "$ref" : "#/components/responses/Default500Response"
27212 },
27213 "503" : {
27214 "$ref" : "#/components/responses/Default503Response"
27215 }
27216 },
27217 "security" : [ {
27218 "Authorization_Code_PKCE" : [ "r_usr", "recommendations.read" ]
27219 } ],
27220 "summary" : "Get owners relationship (\"to-many\").",
27221 "tags" : [ "userRecommendationBlocks" ],
27222 "x-path-item-properties" : {
27223 "required-access-tier" : "INTERNAL"
27224 }
27225 }
27226 },
27227 "/userRecommendationBlocks/{id}/relationships/tracks" : {
27228 "delete" : {
27229 "description" : "Deletes item(s) from tracks relationship.",
27230 "parameters" : [ {
27231 "description" : "User recommendation blocks id. Use `me` for the authenticated user's resource",
27232 "example" : "me",
27233 "in" : "path",
27234 "name" : "id",
27235 "required" : true,
27236 "schema" : {
27237 "type" : "string"
27238 }
27239 }, {
27240 "$ref" : "#/components/parameters/IdempotencyKey"
27241 } ],
27242 "requestBody" : {
27243 "content" : {
27244 "application/vnd.api+json" : {
27245 "schema" : {
27246 "$ref" : "#/components/schemas/UserRecommendationBlocksTracksRelationshipRemoveOperation_Payload"
27247 }
27248 }
27249 }
27250 },
27251 "responses" : {
27252 "400" : {
27253 "$ref" : "#/components/responses/Default400Response"
27254 },
27255 "404" : {
27256 "$ref" : "#/components/responses/Default404Response"
27257 },
27258 "405" : {
27259 "$ref" : "#/components/responses/Default405Response"
27260 },
27261 "406" : {
27262 "$ref" : "#/components/responses/Default406Response"
27263 },
27264 "409" : {
27265 "$ref" : "#/components/responses/Idempotency409Response"
27266 },
27267 "415" : {
27268 "$ref" : "#/components/responses/Default415Response"
27269 },
27270 "422" : {
27271 "$ref" : "#/components/responses/Idempotency422Response"
27272 },
27273 "429" : {
27274 "$ref" : "#/components/responses/Default429Response"
27275 },
27276 "500" : {
27277 "$ref" : "#/components/responses/Default500Response"
27278 },
27279 "503" : {
27280 "$ref" : "#/components/responses/Default503Response"
27281 }
27282 },
27283 "security" : [ {
27284 "Authorization_Code_PKCE" : [ "w_usr" ]
27285 } ],
27286 "summary" : "Delete from tracks relationship (\"to-many\").",
27287 "tags" : [ "userRecommendationBlocks" ],
27288 "x-path-item-properties" : {
27289 "required-access-tier" : "INTERNAL"
27290 }
27291 },
27292 "get" : {
27293 "description" : "Retrieves tracks relationship.",
27294 "parameters" : [ {
27295 "description" : "User recommendation blocks id. Use `me` for the authenticated user's resource",
27296 "example" : "me",
27297 "in" : "path",
27298 "name" : "id",
27299 "required" : true,
27300 "schema" : {
27301 "type" : "string"
27302 }
27303 }, {
27304 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
27305 "in" : "query",
27306 "name" : "page[cursor]",
27307 "required" : false,
27308 "schema" : {
27309 "type" : "string"
27310 }
27311 }, {
27312 "description" : "Allows the client to customize which related resources should be returned. Available options: tracks",
27313 "example" : "tracks",
27314 "in" : "query",
27315 "name" : "include",
27316 "required" : false,
27317 "schema" : {
27318 "type" : "array",
27319 "items" : {
27320 "type" : "string",
27321 "example" : "tracks"
27322 }
27323 }
27324 }, {
27325 "description" : "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",
27326 "example" : "tracks",
27327 "in" : "query",
27328 "name" : "replaceMedia",
27329 "required" : false,
27330 "schema" : {
27331 "type" : "string",
27332 "example" : "tracks"
27333 }
27334 } ],
27335 "responses" : {
27336 "200" : {
27337 "content" : {
27338 "application/vnd.api+json" : {
27339 "schema" : {
27340 "$ref" : "#/components/schemas/UserRecommendationBlocks_Tracks_Multi_Relationship_Data_Document"
27341 }
27342 }
27343 },
27344 "description" : "Successful response"
27345 },
27346 "400" : {
27347 "$ref" : "#/components/responses/Default400Response"
27348 },
27349 "404" : {
27350 "$ref" : "#/components/responses/Default404Response"
27351 },
27352 "405" : {
27353 "$ref" : "#/components/responses/Default405Response"
27354 },
27355 "406" : {
27356 "$ref" : "#/components/responses/Default406Response"
27357 },
27358 "415" : {
27359 "$ref" : "#/components/responses/Default415Response"
27360 },
27361 "429" : {
27362 "$ref" : "#/components/responses/Default429Response"
27363 },
27364 "500" : {
27365 "$ref" : "#/components/responses/Default500Response"
27366 },
27367 "503" : {
27368 "$ref" : "#/components/responses/Default503Response"
27369 }
27370 },
27371 "security" : [ {
27372 "Authorization_Code_PKCE" : [ "r_usr", "recommendations.read" ]
27373 } ],
27374 "summary" : "Get tracks relationship (\"to-many\").",
27375 "tags" : [ "userRecommendationBlocks" ],
27376 "x-path-item-properties" : {
27377 "required-access-tier" : "INTERNAL"
27378 }
27379 },
27380 "post" : {
27381 "description" : "Adds item(s) to tracks relationship.",
27382 "parameters" : [ {
27383 "description" : "User recommendation blocks id. Use `me` for the authenticated user's resource",
27384 "example" : "me",
27385 "in" : "path",
27386 "name" : "id",
27387 "required" : true,
27388 "schema" : {
27389 "type" : "string"
27390 }
27391 }, {
27392 "$ref" : "#/components/parameters/IdempotencyKey"
27393 } ],
27394 "requestBody" : {
27395 "content" : {
27396 "application/vnd.api+json" : {
27397 "schema" : {
27398 "$ref" : "#/components/schemas/UserRecommendationBlocksTracksRelationshipAddOperation_Payload"
27399 }
27400 }
27401 }
27402 },
27403 "responses" : {
27404 "200" : {
27405 "content" : {
27406 "application/vnd.api+json" : {
27407 "schema" : {
27408 "$ref" : "#/components/schemas/UserRecommendationBlocks_Tracks_Add_Multi_Relationship_Data_Document"
27409 }
27410 }
27411 },
27412 "description" : "Successful response"
27413 },
27414 "400" : {
27415 "$ref" : "#/components/responses/Default400Response"
27416 },
27417 "404" : {
27418 "$ref" : "#/components/responses/Default404Response"
27419 },
27420 "405" : {
27421 "$ref" : "#/components/responses/Default405Response"
27422 },
27423 "406" : {
27424 "$ref" : "#/components/responses/Default406Response"
27425 },
27426 "409" : {
27427 "$ref" : "#/components/responses/UserRecommendationBlocksAddMultiDataRelationshipWithResponse409Response"
27428 },
27429 "415" : {
27430 "$ref" : "#/components/responses/Default415Response"
27431 },
27432 "422" : {
27433 "$ref" : "#/components/responses/Idempotency422Response"
27434 },
27435 "429" : {
27436 "$ref" : "#/components/responses/Default429Response"
27437 },
27438 "500" : {
27439 "$ref" : "#/components/responses/Default500Response"
27440 },
27441 "503" : {
27442 "$ref" : "#/components/responses/Default503Response"
27443 }
27444 },
27445 "security" : [ {
27446 "Authorization_Code_PKCE" : [ "w_usr" ]
27447 } ],
27448 "summary" : "Add to tracks relationship (\"to-many\").",
27449 "tags" : [ "userRecommendationBlocks" ],
27450 "x-path-item-properties" : {
27451 "required-access-tier" : "INTERNAL"
27452 }
27453 }
27454 },
27455 "/userRecommendationBlocks/{id}/relationships/videos" : {
27456 "delete" : {
27457 "description" : "Deletes item(s) from videos relationship.",
27458 "parameters" : [ {
27459 "description" : "User recommendation blocks id. Use `me` for the authenticated user's resource",
27460 "example" : "me",
27461 "in" : "path",
27462 "name" : "id",
27463 "required" : true,
27464 "schema" : {
27465 "type" : "string"
27466 }
27467 }, {
27468 "$ref" : "#/components/parameters/IdempotencyKey"
27469 } ],
27470 "requestBody" : {
27471 "content" : {
27472 "application/vnd.api+json" : {
27473 "schema" : {
27474 "$ref" : "#/components/schemas/UserRecommendationBlocksVideosRelationshipRemoveOperation_Payload"
27475 }
27476 }
27477 }
27478 },
27479 "responses" : {
27480 "400" : {
27481 "$ref" : "#/components/responses/Default400Response"
27482 },
27483 "404" : {
27484 "$ref" : "#/components/responses/Default404Response"
27485 },
27486 "405" : {
27487 "$ref" : "#/components/responses/Default405Response"
27488 },
27489 "406" : {
27490 "$ref" : "#/components/responses/Default406Response"
27491 },
27492 "409" : {
27493 "$ref" : "#/components/responses/Idempotency409Response"
27494 },
27495 "415" : {
27496 "$ref" : "#/components/responses/Default415Response"
27497 },
27498 "422" : {
27499 "$ref" : "#/components/responses/Idempotency422Response"
27500 },
27501 "429" : {
27502 "$ref" : "#/components/responses/Default429Response"
27503 },
27504 "500" : {
27505 "$ref" : "#/components/responses/Default500Response"
27506 },
27507 "503" : {
27508 "$ref" : "#/components/responses/Default503Response"
27509 }
27510 },
27511 "security" : [ {
27512 "Authorization_Code_PKCE" : [ "w_usr" ]
27513 } ],
27514 "summary" : "Delete from videos relationship (\"to-many\").",
27515 "tags" : [ "userRecommendationBlocks" ],
27516 "x-path-item-properties" : {
27517 "required-access-tier" : "INTERNAL"
27518 }
27519 },
27520 "get" : {
27521 "description" : "Retrieves videos relationship.",
27522 "parameters" : [ {
27523 "description" : "User recommendation blocks id. Use `me` for the authenticated user's resource",
27524 "example" : "me",
27525 "in" : "path",
27526 "name" : "id",
27527 "required" : true,
27528 "schema" : {
27529 "type" : "string"
27530 }
27531 }, {
27532 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
27533 "in" : "query",
27534 "name" : "page[cursor]",
27535 "required" : false,
27536 "schema" : {
27537 "type" : "string"
27538 }
27539 }, {
27540 "description" : "Allows the client to customize which related resources should be returned. Available options: videos",
27541 "example" : "videos",
27542 "in" : "query",
27543 "name" : "include",
27544 "required" : false,
27545 "schema" : {
27546 "type" : "array",
27547 "items" : {
27548 "type" : "string",
27549 "example" : "videos"
27550 }
27551 }
27552 }, {
27553 "description" : "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",
27554 "example" : "videos",
27555 "in" : "query",
27556 "name" : "replaceMedia",
27557 "required" : false,
27558 "schema" : {
27559 "type" : "string",
27560 "example" : "videos"
27561 }
27562 } ],
27563 "responses" : {
27564 "200" : {
27565 "content" : {
27566 "application/vnd.api+json" : {
27567 "schema" : {
27568 "$ref" : "#/components/schemas/UserRecommendationBlocks_Videos_Multi_Relationship_Data_Document"
27569 }
27570 }
27571 },
27572 "description" : "Successful response"
27573 },
27574 "400" : {
27575 "$ref" : "#/components/responses/Default400Response"
27576 },
27577 "404" : {
27578 "$ref" : "#/components/responses/Default404Response"
27579 },
27580 "405" : {
27581 "$ref" : "#/components/responses/Default405Response"
27582 },
27583 "406" : {
27584 "$ref" : "#/components/responses/Default406Response"
27585 },
27586 "415" : {
27587 "$ref" : "#/components/responses/Default415Response"
27588 },
27589 "429" : {
27590 "$ref" : "#/components/responses/Default429Response"
27591 },
27592 "500" : {
27593 "$ref" : "#/components/responses/Default500Response"
27594 },
27595 "503" : {
27596 "$ref" : "#/components/responses/Default503Response"
27597 }
27598 },
27599 "security" : [ {
27600 "Authorization_Code_PKCE" : [ "r_usr", "recommendations.read" ]
27601 } ],
27602 "summary" : "Get videos relationship (\"to-many\").",
27603 "tags" : [ "userRecommendationBlocks" ],
27604 "x-path-item-properties" : {
27605 "required-access-tier" : "INTERNAL"
27606 }
27607 },
27608 "post" : {
27609 "description" : "Adds item(s) to videos relationship.",
27610 "parameters" : [ {
27611 "description" : "User recommendation blocks id. Use `me` for the authenticated user's resource",
27612 "example" : "me",
27613 "in" : "path",
27614 "name" : "id",
27615 "required" : true,
27616 "schema" : {
27617 "type" : "string"
27618 }
27619 }, {
27620 "$ref" : "#/components/parameters/IdempotencyKey"
27621 } ],
27622 "requestBody" : {
27623 "content" : {
27624 "application/vnd.api+json" : {
27625 "schema" : {
27626 "$ref" : "#/components/schemas/UserRecommendationBlocksVideosRelationshipAddOperation_Payload"
27627 }
27628 }
27629 }
27630 },
27631 "responses" : {
27632 "200" : {
27633 "content" : {
27634 "application/vnd.api+json" : {
27635 "schema" : {
27636 "$ref" : "#/components/schemas/UserRecommendationBlocks_Videos_Add_Multi_Relationship_Data_Document"
27637 }
27638 }
27639 },
27640 "description" : "Successful response"
27641 },
27642 "400" : {
27643 "$ref" : "#/components/responses/Default400Response"
27644 },
27645 "404" : {
27646 "$ref" : "#/components/responses/Default404Response"
27647 },
27648 "405" : {
27649 "$ref" : "#/components/responses/Default405Response"
27650 },
27651 "406" : {
27652 "$ref" : "#/components/responses/Default406Response"
27653 },
27654 "409" : {
27655 "$ref" : "#/components/responses/UserRecommendationBlocksAddMultiDataRelationshipWithResponse409Response"
27656 },
27657 "415" : {
27658 "$ref" : "#/components/responses/Default415Response"
27659 },
27660 "422" : {
27661 "$ref" : "#/components/responses/Idempotency422Response"
27662 },
27663 "429" : {
27664 "$ref" : "#/components/responses/Default429Response"
27665 },
27666 "500" : {
27667 "$ref" : "#/components/responses/Default500Response"
27668 },
27669 "503" : {
27670 "$ref" : "#/components/responses/Default503Response"
27671 }
27672 },
27673 "security" : [ {
27674 "Authorization_Code_PKCE" : [ "w_usr" ]
27675 } ],
27676 "summary" : "Add to videos relationship (\"to-many\").",
27677 "tags" : [ "userRecommendationBlocks" ],
27678 "x-path-item-properties" : {
27679 "required-access-tier" : "INTERNAL"
27680 }
27681 }
27682 },
27683 "/userRecommendations/{id}" : {
27684 "get" : {
27685 "deprecated" : true,
27686 "description" : "Deprecated. Use the dedicated mix resources instead: userDiscoveryMixes, userDailyMixes, userNewReleaseMixes, or userOfflineMixes.",
27687 "parameters" : [ {
27688 "description" : "User recommendations id. Use `me` for the authenticated user's resource",
27689 "example" : "me",
27690 "in" : "path",
27691 "name" : "id",
27692 "required" : true,
27693 "schema" : {
27694 "type" : "string"
27695 }
27696 }, {
27697 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
27698 "example" : "en-US",
27699 "in" : "query",
27700 "name" : "locale",
27701 "required" : false,
27702 "schema" : {
27703 "type" : "string",
27704 "default" : "en-US"
27705 }
27706 }, {
27707 "description" : "Allows the client to customize which related resources should be returned. Available options: discoveryMixes, myMixes, newArrivalMixes, offlineMixes",
27708 "example" : "discoveryMixes.items",
27709 "in" : "query",
27710 "name" : "include",
27711 "required" : false,
27712 "schema" : {
27713 "type" : "array",
27714 "items" : {
27715 "type" : "string",
27716 "example" : "discoveryMixes.items"
27717 }
27718 }
27719 }, {
27720 "description" : "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",
27721 "example" : "discoveryMixes.items",
27722 "in" : "query",
27723 "name" : "replaceMedia",
27724 "required" : false,
27725 "schema" : {
27726 "type" : "string",
27727 "example" : "discoveryMixes.items"
27728 }
27729 } ],
27730 "responses" : {
27731 "200" : {
27732 "content" : {
27733 "application/vnd.api+json" : {
27734 "schema" : {
27735 "$ref" : "#/components/schemas/UserRecommendations_Single_Resource_Data_Document"
27736 }
27737 }
27738 },
27739 "description" : "Successful response"
27740 },
27741 "400" : {
27742 "$ref" : "#/components/responses/Default400Response"
27743 },
27744 "404" : {
27745 "$ref" : "#/components/responses/Default404Response"
27746 },
27747 "405" : {
27748 "$ref" : "#/components/responses/Default405Response"
27749 },
27750 "406" : {
27751 "$ref" : "#/components/responses/Default406Response"
27752 },
27753 "415" : {
27754 "$ref" : "#/components/responses/Default415Response"
27755 },
27756 "429" : {
27757 "$ref" : "#/components/responses/Default429Response"
27758 },
27759 "500" : {
27760 "$ref" : "#/components/responses/Default500Response"
27761 },
27762 "503" : {
27763 "$ref" : "#/components/responses/Default503Response"
27764 }
27765 },
27766 "security" : [ {
27767 "Authorization_Code_PKCE" : [ "r_usr", "recommendations.read" ]
27768 } ],
27769 "summary" : "Get single userRecommendation.",
27770 "tags" : [ "userRecommendations" ],
27771 "x-path-item-properties" : {
27772 "required-access-tier" : "THIRD_PARTY"
27773 }
27774 }
27775 },
27776 "/userRecommendations/{id}/relationships/discoveryMixes" : {
27777 "get" : {
27778 "deprecated" : true,
27779 "description" : "Deprecated. Use the userDiscoveryMixes resource and its items relationship instead.",
27780 "parameters" : [ {
27781 "description" : "User recommendations id. Use `me` for the authenticated user's resource",
27782 "example" : "me",
27783 "in" : "path",
27784 "name" : "id",
27785 "required" : true,
27786 "schema" : {
27787 "type" : "string"
27788 }
27789 }, {
27790 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
27791 "in" : "query",
27792 "name" : "page[cursor]",
27793 "required" : false,
27794 "schema" : {
27795 "type" : "string"
27796 }
27797 }, {
27798 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
27799 "example" : "en-US",
27800 "in" : "query",
27801 "name" : "locale",
27802 "required" : false,
27803 "schema" : {
27804 "type" : "string",
27805 "default" : "en-US"
27806 }
27807 }, {
27808 "description" : "Allows the client to customize which related resources should be returned. Available options: discoveryMixes",
27809 "example" : "discoveryMixes.items",
27810 "in" : "query",
27811 "name" : "include",
27812 "required" : false,
27813 "schema" : {
27814 "type" : "array",
27815 "items" : {
27816 "type" : "string",
27817 "example" : "discoveryMixes.items"
27818 }
27819 }
27820 }, {
27821 "description" : "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",
27822 "example" : "discoveryMixes.items",
27823 "in" : "query",
27824 "name" : "replaceMedia",
27825 "required" : false,
27826 "schema" : {
27827 "type" : "string",
27828 "example" : "discoveryMixes.items"
27829 }
27830 } ],
27831 "responses" : {
27832 "200" : {
27833 "content" : {
27834 "application/vnd.api+json" : {
27835 "schema" : {
27836 "$ref" : "#/components/schemas/UserRecommendations_Multi_Relationship_Data_Document"
27837 }
27838 }
27839 },
27840 "description" : "Successful response"
27841 },
27842 "400" : {
27843 "$ref" : "#/components/responses/Default400Response"
27844 },
27845 "404" : {
27846 "$ref" : "#/components/responses/Default404Response"
27847 },
27848 "405" : {
27849 "$ref" : "#/components/responses/Default405Response"
27850 },
27851 "406" : {
27852 "$ref" : "#/components/responses/Default406Response"
27853 },
27854 "415" : {
27855 "$ref" : "#/components/responses/Default415Response"
27856 },
27857 "429" : {
27858 "$ref" : "#/components/responses/Default429Response"
27859 },
27860 "500" : {
27861 "$ref" : "#/components/responses/Default500Response"
27862 },
27863 "503" : {
27864 "$ref" : "#/components/responses/Default503Response"
27865 }
27866 },
27867 "security" : [ {
27868 "Authorization_Code_PKCE" : [ "r_usr", "recommendations.read" ]
27869 } ],
27870 "summary" : "Get discoveryMixes relationship (\"to-many\").",
27871 "tags" : [ "userRecommendations" ],
27872 "x-path-item-properties" : {
27873 "required-access-tier" : "THIRD_PARTY"
27874 }
27875 }
27876 },
27877 "/userRecommendations/{id}/relationships/myMixes" : {
27878 "get" : {
27879 "deprecated" : true,
27880 "description" : "Deprecated. Use the userDailyMixes resource and its items relationship instead.",
27881 "parameters" : [ {
27882 "description" : "User recommendations id. Use `me` for the authenticated user's resource",
27883 "example" : "me",
27884 "in" : "path",
27885 "name" : "id",
27886 "required" : true,
27887 "schema" : {
27888 "type" : "string"
27889 }
27890 }, {
27891 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
27892 "in" : "query",
27893 "name" : "page[cursor]",
27894 "required" : false,
27895 "schema" : {
27896 "type" : "string"
27897 }
27898 }, {
27899 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
27900 "example" : "en-US",
27901 "in" : "query",
27902 "name" : "locale",
27903 "required" : false,
27904 "schema" : {
27905 "type" : "string",
27906 "default" : "en-US"
27907 }
27908 }, {
27909 "description" : "Allows the client to customize which related resources should be returned. Available options: myMixes",
27910 "example" : "myMixes.items",
27911 "in" : "query",
27912 "name" : "include",
27913 "required" : false,
27914 "schema" : {
27915 "type" : "array",
27916 "items" : {
27917 "type" : "string",
27918 "example" : "myMixes.items"
27919 }
27920 }
27921 }, {
27922 "description" : "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",
27923 "example" : "myMixes.items",
27924 "in" : "query",
27925 "name" : "replaceMedia",
27926 "required" : false,
27927 "schema" : {
27928 "type" : "string",
27929 "example" : "myMixes.items"
27930 }
27931 } ],
27932 "responses" : {
27933 "200" : {
27934 "content" : {
27935 "application/vnd.api+json" : {
27936 "schema" : {
27937 "$ref" : "#/components/schemas/UserRecommendations_Multi_Relationship_Data_Document"
27938 }
27939 }
27940 },
27941 "description" : "Successful response"
27942 },
27943 "400" : {
27944 "$ref" : "#/components/responses/Default400Response"
27945 },
27946 "404" : {
27947 "$ref" : "#/components/responses/Default404Response"
27948 },
27949 "405" : {
27950 "$ref" : "#/components/responses/Default405Response"
27951 },
27952 "406" : {
27953 "$ref" : "#/components/responses/Default406Response"
27954 },
27955 "415" : {
27956 "$ref" : "#/components/responses/Default415Response"
27957 },
27958 "429" : {
27959 "$ref" : "#/components/responses/Default429Response"
27960 },
27961 "500" : {
27962 "$ref" : "#/components/responses/Default500Response"
27963 },
27964 "503" : {
27965 "$ref" : "#/components/responses/Default503Response"
27966 }
27967 },
27968 "security" : [ {
27969 "Authorization_Code_PKCE" : [ "r_usr", "recommendations.read" ]
27970 } ],
27971 "summary" : "Get myMixes relationship (\"to-many\").",
27972 "tags" : [ "userRecommendations" ],
27973 "x-path-item-properties" : {
27974 "required-access-tier" : "THIRD_PARTY"
27975 }
27976 }
27977 },
27978 "/userRecommendations/{id}/relationships/newArrivalMixes" : {
27979 "get" : {
27980 "deprecated" : true,
27981 "description" : "Deprecated. Use the userNewReleaseMixes resource and its items relationship instead.",
27982 "parameters" : [ {
27983 "description" : "User recommendations id. Use `me` for the authenticated user's resource",
27984 "example" : "me",
27985 "in" : "path",
27986 "name" : "id",
27987 "required" : true,
27988 "schema" : {
27989 "type" : "string"
27990 }
27991 }, {
27992 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
27993 "in" : "query",
27994 "name" : "page[cursor]",
27995 "required" : false,
27996 "schema" : {
27997 "type" : "string"
27998 }
27999 }, {
28000 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
28001 "example" : "en-US",
28002 "in" : "query",
28003 "name" : "locale",
28004 "required" : false,
28005 "schema" : {
28006 "type" : "string",
28007 "default" : "en-US"
28008 }
28009 }, {
28010 "description" : "Allows the client to customize which related resources should be returned. Available options: newArrivalMixes",
28011 "example" : "newArrivalMixes.items",
28012 "in" : "query",
28013 "name" : "include",
28014 "required" : false,
28015 "schema" : {
28016 "type" : "array",
28017 "items" : {
28018 "type" : "string",
28019 "example" : "newArrivalMixes.items"
28020 }
28021 }
28022 }, {
28023 "description" : "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",
28024 "example" : "newArrivalMixes.items",
28025 "in" : "query",
28026 "name" : "replaceMedia",
28027 "required" : false,
28028 "schema" : {
28029 "type" : "string",
28030 "example" : "newArrivalMixes.items"
28031 }
28032 } ],
28033 "responses" : {
28034 "200" : {
28035 "content" : {
28036 "application/vnd.api+json" : {
28037 "schema" : {
28038 "$ref" : "#/components/schemas/UserRecommendations_Multi_Relationship_Data_Document"
28039 }
28040 }
28041 },
28042 "description" : "Successful response"
28043 },
28044 "400" : {
28045 "$ref" : "#/components/responses/Default400Response"
28046 },
28047 "404" : {
28048 "$ref" : "#/components/responses/Default404Response"
28049 },
28050 "405" : {
28051 "$ref" : "#/components/responses/Default405Response"
28052 },
28053 "406" : {
28054 "$ref" : "#/components/responses/Default406Response"
28055 },
28056 "415" : {
28057 "$ref" : "#/components/responses/Default415Response"
28058 },
28059 "429" : {
28060 "$ref" : "#/components/responses/Default429Response"
28061 },
28062 "500" : {
28063 "$ref" : "#/components/responses/Default500Response"
28064 },
28065 "503" : {
28066 "$ref" : "#/components/responses/Default503Response"
28067 }
28068 },
28069 "security" : [ {
28070 "Authorization_Code_PKCE" : [ "r_usr", "recommendations.read" ]
28071 } ],
28072 "summary" : "Get newArrivalMixes relationship (\"to-many\").",
28073 "tags" : [ "userRecommendations" ],
28074 "x-path-item-properties" : {
28075 "required-access-tier" : "THIRD_PARTY"
28076 }
28077 }
28078 },
28079 "/userRecommendations/{id}/relationships/offlineMixes" : {
28080 "get" : {
28081 "deprecated" : true,
28082 "description" : "Deprecated. Use the userOfflineMixes resource and its items relationship instead.",
28083 "parameters" : [ {
28084 "description" : "User recommendations id. Use `me` for the authenticated user's resource",
28085 "example" : "me",
28086 "in" : "path",
28087 "name" : "id",
28088 "required" : true,
28089 "schema" : {
28090 "type" : "string"
28091 }
28092 }, {
28093 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
28094 "in" : "query",
28095 "name" : "page[cursor]",
28096 "required" : false,
28097 "schema" : {
28098 "type" : "string"
28099 }
28100 }, {
28101 "description" : "BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.",
28102 "example" : "en-US",
28103 "in" : "query",
28104 "name" : "locale",
28105 "required" : false,
28106 "schema" : {
28107 "type" : "string",
28108 "default" : "en-US"
28109 }
28110 }, {
28111 "description" : "Allows the client to customize which related resources should be returned. Available options: offlineMixes",
28112 "example" : "offlineMixes.items",
28113 "in" : "query",
28114 "name" : "include",
28115 "required" : false,
28116 "schema" : {
28117 "type" : "array",
28118 "items" : {
28119 "type" : "string",
28120 "example" : "offlineMixes.items"
28121 }
28122 }
28123 }, {
28124 "description" : "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",
28125 "example" : "offlineMixes.items",
28126 "in" : "query",
28127 "name" : "replaceMedia",
28128 "required" : false,
28129 "schema" : {
28130 "type" : "string",
28131 "example" : "offlineMixes.items"
28132 }
28133 } ],
28134 "responses" : {
28135 "200" : {
28136 "content" : {
28137 "application/vnd.api+json" : {
28138 "schema" : {
28139 "$ref" : "#/components/schemas/UserRecommendations_Multi_Relationship_Data_Document"
28140 }
28141 }
28142 },
28143 "description" : "Successful response"
28144 },
28145 "400" : {
28146 "$ref" : "#/components/responses/Default400Response"
28147 },
28148 "404" : {
28149 "$ref" : "#/components/responses/Default404Response"
28150 },
28151 "405" : {
28152 "$ref" : "#/components/responses/Default405Response"
28153 },
28154 "406" : {
28155 "$ref" : "#/components/responses/Default406Response"
28156 },
28157 "415" : {
28158 "$ref" : "#/components/responses/Default415Response"
28159 },
28160 "429" : {
28161 "$ref" : "#/components/responses/Default429Response"
28162 },
28163 "500" : {
28164 "$ref" : "#/components/responses/Default500Response"
28165 },
28166 "503" : {
28167 "$ref" : "#/components/responses/Default503Response"
28168 }
28169 },
28170 "security" : [ {
28171 "Authorization_Code_PKCE" : [ "r_usr", "recommendations.read" ]
28172 } ],
28173 "summary" : "Get offlineMixes relationship (\"to-many\").",
28174 "tags" : [ "userRecommendations" ],
28175 "x-path-item-properties" : {
28176 "required-access-tier" : "INTERNAL"
28177 }
28178 }
28179 },
28180 "/userReports" : {
28181 "post" : {
28182 "description" : "Creates a new userReport.",
28183 "parameters" : [ {
28184 "$ref" : "#/components/parameters/IdempotencyKey"
28185 } ],
28186 "requestBody" : {
28187 "content" : {
28188 "application/vnd.api+json" : {
28189 "schema" : {
28190 "$ref" : "#/components/schemas/UserReportsCreateOperation_Payload"
28191 }
28192 }
28193 }
28194 },
28195 "responses" : {
28196 "201" : {
28197 "content" : {
28198 "application/vnd.api+json" : {
28199 "schema" : {
28200 "$ref" : "#/components/schemas/UserReports_Create_Single_Resource_Data_Document"
28201 }
28202 }
28203 },
28204 "description" : "Successful response"
28205 },
28206 "400" : {
28207 "$ref" : "#/components/responses/Default400Response"
28208 },
28209 "404" : {
28210 "$ref" : "#/components/responses/Default404Response"
28211 },
28212 "405" : {
28213 "$ref" : "#/components/responses/Default405Response"
28214 },
28215 "406" : {
28216 "$ref" : "#/components/responses/Default406Response"
28217 },
28218 "409" : {
28219 "$ref" : "#/components/responses/Idempotency409Response"
28220 },
28221 "415" : {
28222 "$ref" : "#/components/responses/Default415Response"
28223 },
28224 "422" : {
28225 "$ref" : "#/components/responses/Idempotency422Response"
28226 },
28227 "429" : {
28228 "$ref" : "#/components/responses/Default429Response"
28229 },
28230 "500" : {
28231 "$ref" : "#/components/responses/Default500Response"
28232 },
28233 "503" : {
28234 "$ref" : "#/components/responses/Default503Response"
28235 }
28236 },
28237 "security" : [ {
28238 "Authorization_Code_PKCE" : [ "w_usr" ]
28239 } ],
28240 "summary" : "Create single userReport.",
28241 "tags" : [ "userReports" ],
28242 "x-path-item-properties" : {
28243 "required-access-tier" : "INTERNAL"
28244 }
28245 }
28246 },
28247 "/userSubscriptionPriceChanges" : {
28248 "get" : {
28249 "description" : "Retrieves multiple userSubscriptionPriceChanges by available filters, or without if applicable.",
28250 "parameters" : [ {
28251 "description" : "User id. Use `me` for the authenticated user",
28252 "in" : "query",
28253 "name" : "filter[owners.id]",
28254 "required" : true,
28255 "schema" : {
28256 "type" : "array",
28257 "items" : {
28258 "type" : "string"
28259 }
28260 }
28261 }, {
28262 "description" : "Allows the client to customize which related resources should be returned. Available options: decision",
28263 "example" : "decision",
28264 "in" : "query",
28265 "name" : "include",
28266 "required" : false,
28267 "schema" : {
28268 "type" : "array",
28269 "items" : {
28270 "type" : "string",
28271 "example" : "decision"
28272 }
28273 }
28274 } ],
28275 "responses" : {
28276 "200" : {
28277 "content" : {
28278 "application/vnd.api+json" : {
28279 "schema" : {
28280 "$ref" : "#/components/schemas/UserSubscriptionPriceChanges_Multi_Resource_Data_Document"
28281 }
28282 }
28283 },
28284 "description" : "Successful response"
28285 },
28286 "400" : {
28287 "$ref" : "#/components/responses/Default400Response"
28288 },
28289 "404" : {
28290 "$ref" : "#/components/responses/Default404Response"
28291 },
28292 "405" : {
28293 "$ref" : "#/components/responses/Default405Response"
28294 },
28295 "406" : {
28296 "$ref" : "#/components/responses/Default406Response"
28297 },
28298 "415" : {
28299 "$ref" : "#/components/responses/Default415Response"
28300 },
28301 "429" : {
28302 "$ref" : "#/components/responses/Default429Response"
28303 },
28304 "500" : {
28305 "$ref" : "#/components/responses/Default500Response"
28306 },
28307 "503" : {
28308 "$ref" : "#/components/responses/Default503Response"
28309 }
28310 },
28311 "security" : [ {
28312 "Authorization_Code_PKCE" : [ "r_usr" ]
28313 } ],
28314 "summary" : "Get multiple userSubscriptionPriceChanges.",
28315 "tags" : [ "userSubscriptionPriceChanges" ],
28316 "x-path-item-properties" : {
28317 "required-access-tier" : "INTERNAL"
28318 }
28319 }
28320 },
28321 "/userSubscriptionPriceChanges/{id}/relationships/decision" : {
28322 "get" : {
28323 "description" : "Retrieves decision relationship.",
28324 "parameters" : [ {
28325 "description" : "Price change id",
28326 "example" : "1AC1yHZWFAFVjnFOn8XoXA",
28327 "in" : "path",
28328 "name" : "id",
28329 "required" : true,
28330 "schema" : {
28331 "type" : "string"
28332 }
28333 }, {
28334 "description" : "Allows the client to customize which related resources should be returned. Available options: decision",
28335 "example" : "decision",
28336 "in" : "query",
28337 "name" : "include",
28338 "required" : false,
28339 "schema" : {
28340 "type" : "array",
28341 "items" : {
28342 "type" : "string",
28343 "example" : "decision"
28344 }
28345 }
28346 } ],
28347 "responses" : {
28348 "200" : {
28349 "content" : {
28350 "application/vnd.api+json" : {
28351 "schema" : {
28352 "$ref" : "#/components/schemas/UserSubscriptionPriceChanges_Single_Relationship_Data_Document"
28353 }
28354 }
28355 },
28356 "description" : "Successful response"
28357 },
28358 "400" : {
28359 "$ref" : "#/components/responses/Default400Response"
28360 },
28361 "404" : {
28362 "$ref" : "#/components/responses/Default404Response"
28363 },
28364 "405" : {
28365 "$ref" : "#/components/responses/Default405Response"
28366 },
28367 "406" : {
28368 "$ref" : "#/components/responses/Default406Response"
28369 },
28370 "415" : {
28371 "$ref" : "#/components/responses/Default415Response"
28372 },
28373 "429" : {
28374 "$ref" : "#/components/responses/Default429Response"
28375 },
28376 "500" : {
28377 "$ref" : "#/components/responses/Default500Response"
28378 },
28379 "503" : {
28380 "$ref" : "#/components/responses/Default503Response"
28381 }
28382 },
28383 "security" : [ {
28384 "Authorization_Code_PKCE" : [ "r_usr" ]
28385 } ],
28386 "summary" : "Get decision relationship (\"to-one\").",
28387 "tags" : [ "userSubscriptionPriceChanges" ],
28388 "x-path-item-properties" : {
28389 "required-access-tier" : "INTERNAL"
28390 }
28391 }
28392 },
28393 "/users/{id}" : {
28394 "get" : {
28395 "description" : "Retrieves single user by id.",
28396 "parameters" : [ {
28397 "description" : "User id. Use `me` for the authenticated user's resource",
28398 "example" : "me",
28399 "in" : "path",
28400 "name" : "id",
28401 "required" : true,
28402 "schema" : {
28403 "type" : "string"
28404 }
28405 } ],
28406 "responses" : {
28407 "200" : {
28408 "content" : {
28409 "application/vnd.api+json" : {
28410 "schema" : {
28411 "$ref" : "#/components/schemas/Users_Single_Resource_Data_Document"
28412 }
28413 }
28414 },
28415 "description" : "Successful response"
28416 },
28417 "400" : {
28418 "$ref" : "#/components/responses/Default400Response"
28419 },
28420 "404" : {
28421 "$ref" : "#/components/responses/Default404Response"
28422 },
28423 "405" : {
28424 "$ref" : "#/components/responses/Default405Response"
28425 },
28426 "406" : {
28427 "$ref" : "#/components/responses/Default406Response"
28428 },
28429 "415" : {
28430 "$ref" : "#/components/responses/Default415Response"
28431 },
28432 "429" : {
28433 "$ref" : "#/components/responses/Default429Response"
28434 },
28435 "500" : {
28436 "$ref" : "#/components/responses/Default500Response"
28437 },
28438 "503" : {
28439 "$ref" : "#/components/responses/Default503Response"
28440 }
28441 },
28442 "security" : [ {
28443 "Authorization_Code_PKCE" : [ "r_usr", "user.read" ]
28444 } ],
28445 "summary" : "Get single user.",
28446 "tags" : [ "users" ],
28447 "x-path-item-properties" : {
28448 "required-access-tier" : "THIRD_PARTY"
28449 }
28450 }
28451 },
28452 "/videoManifests/{id}" : {
28453 "get" : {
28454 "description" : "Retrieves single videoManifest by id.",
28455 "parameters" : [ {
28456 "description" : "Video manifest id",
28457 "example" : "75623239",
28458 "in" : "path",
28459 "name" : "id",
28460 "required" : true,
28461 "schema" : {
28462 "type" : "string"
28463 }
28464 }, {
28465 "in" : "query",
28466 "name" : "uriScheme",
28467 "required" : true,
28468 "schema" : {
28469 "type" : "string",
28470 "enum" : [ "HTTPS", "DATA" ]
28471 }
28472 }, {
28473 "in" : "query",
28474 "name" : "usage",
28475 "required" : true,
28476 "schema" : {
28477 "type" : "string",
28478 "enum" : [ "PLAYBACK", "DOWNLOAD" ]
28479 }
28480 } ],
28481 "responses" : {
28482 "200" : {
28483 "content" : {
28484 "application/vnd.api+json" : {
28485 "schema" : {
28486 "$ref" : "#/components/schemas/VideoManifests_Single_Resource_Data_Document"
28487 }
28488 }
28489 },
28490 "description" : "Successful response"
28491 },
28492 "400" : {
28493 "$ref" : "#/components/responses/Default400Response"
28494 },
28495 "403" : {
28496 "$ref" : "#/components/responses/VideoManifestsReadById403Response"
28497 },
28498 "404" : {
28499 "$ref" : "#/components/responses/VideoManifestsReadById404Response"
28500 },
28501 "405" : {
28502 "$ref" : "#/components/responses/Default405Response"
28503 },
28504 "406" : {
28505 "$ref" : "#/components/responses/Default406Response"
28506 },
28507 "415" : {
28508 "$ref" : "#/components/responses/Default415Response"
28509 },
28510 "429" : {
28511 "$ref" : "#/components/responses/Default429Response"
28512 },
28513 "500" : {
28514 "$ref" : "#/components/responses/Default500Response"
28515 },
28516 "503" : {
28517 "$ref" : "#/components/responses/Default503Response"
28518 }
28519 },
28520 "security" : [ {
28521 "Client_Credentials" : [ ]
28522 }, {
28523 "Authorization_Code_PKCE" : [ "playback", "r_usr" ]
28524 } ],
28525 "summary" : "Get single videoManifest.",
28526 "tags" : [ "videoManifests" ],
28527 "x-path-item-properties" : {
28528 "required-access-tier" : "THIRD_PARTY"
28529 }
28530 }
28531 },
28532 "/videos" : {
28533 "get" : {
28534 "description" : "Retrieves multiple videos by available filters, or without if applicable.",
28535 "parameters" : [ {
28536 "description" : "ISO 3166-1 alpha-2 country code",
28537 "example" : "US",
28538 "in" : "query",
28539 "name" : "countryCode",
28540 "required" : false,
28541 "schema" : {
28542 "type" : "string"
28543 }
28544 }, {
28545 "description" : "Allows the client to customize which related resources should be returned. Available options: albums, artists, credits, providers, replacement, similarVideos, suggestedVideos, thumbnailArt, usageRules",
28546 "example" : "albums",
28547 "in" : "query",
28548 "name" : "include",
28549 "required" : false,
28550 "schema" : {
28551 "type" : "array",
28552 "items" : {
28553 "type" : "string",
28554 "example" : "albums"
28555 }
28556 }
28557 }, {
28558 "description" : "List of video IDs (e.g. `75623239`)",
28559 "in" : "query",
28560 "name" : "filter[id]",
28561 "required" : false,
28562 "schema" : {
28563 "type" : "array",
28564 "items" : {
28565 "type" : "string"
28566 }
28567 }
28568 }, {
28569 "description" : "List of ISRCs (e.g. `QMJMT1701237`)",
28570 "in" : "query",
28571 "name" : "filter[isrc]",
28572 "required" : false,
28573 "schema" : {
28574 "type" : "array",
28575 "items" : {
28576 "type" : "string"
28577 }
28578 }
28579 }, {
28580 "description" : "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",
28581 "example" : "albums",
28582 "in" : "query",
28583 "name" : "replaceMedia",
28584 "required" : false,
28585 "schema" : {
28586 "type" : "string",
28587 "example" : "albums"
28588 }
28589 } ],
28590 "responses" : {
28591 "200" : {
28592 "content" : {
28593 "application/vnd.api+json" : {
28594 "schema" : {
28595 "$ref" : "#/components/schemas/Videos_Multi_Resource_Data_Document"
28596 }
28597 }
28598 },
28599 "description" : "Successful response"
28600 },
28601 "400" : {
28602 "$ref" : "#/components/responses/Default400Response"
28603 },
28604 "404" : {
28605 "$ref" : "#/components/responses/Default404Response"
28606 },
28607 "405" : {
28608 "$ref" : "#/components/responses/Default405Response"
28609 },
28610 "406" : {
28611 "$ref" : "#/components/responses/Default406Response"
28612 },
28613 "415" : {
28614 "$ref" : "#/components/responses/Default415Response"
28615 },
28616 "429" : {
28617 "$ref" : "#/components/responses/Default429Response"
28618 },
28619 "500" : {
28620 "$ref" : "#/components/responses/Default500Response"
28621 },
28622 "503" : {
28623 "$ref" : "#/components/responses/Default503Response"
28624 }
28625 },
28626 "security" : [ {
28627 "Client_Credentials" : [ ]
28628 }, {
28629 "Authorization_Code_PKCE" : [ ]
28630 } ],
28631 "summary" : "Get multiple videos.",
28632 "tags" : [ "videos" ],
28633 "x-path-item-properties" : {
28634 "required-access-tier" : "THIRD_PARTY"
28635 }
28636 }
28637 },
28638 "/videos/{id}" : {
28639 "get" : {
28640 "description" : "Retrieves single video by id.",
28641 "parameters" : [ {
28642 "description" : "Video id",
28643 "example" : "75623239",
28644 "in" : "path",
28645 "name" : "id",
28646 "required" : true,
28647 "schema" : {
28648 "type" : "string"
28649 }
28650 }, {
28651 "description" : "ISO 3166-1 alpha-2 country code",
28652 "example" : "US",
28653 "in" : "query",
28654 "name" : "countryCode",
28655 "required" : false,
28656 "schema" : {
28657 "type" : "string"
28658 }
28659 }, {
28660 "description" : "Allows the client to customize which related resources should be returned. Available options: albums, artists, credits, providers, replacement, similarVideos, suggestedVideos, thumbnailArt, usageRules",
28661 "example" : "albums",
28662 "in" : "query",
28663 "name" : "include",
28664 "required" : false,
28665 "schema" : {
28666 "type" : "array",
28667 "items" : {
28668 "type" : "string",
28669 "example" : "albums"
28670 }
28671 }
28672 }, {
28673 "description" : "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",
28674 "example" : "albums",
28675 "in" : "query",
28676 "name" : "replaceMedia",
28677 "required" : false,
28678 "schema" : {
28679 "type" : "string",
28680 "example" : "albums"
28681 }
28682 } ],
28683 "responses" : {
28684 "200" : {
28685 "content" : {
28686 "application/vnd.api+json" : {
28687 "schema" : {
28688 "$ref" : "#/components/schemas/Videos_Single_Resource_Data_Document"
28689 }
28690 }
28691 },
28692 "description" : "Successful response"
28693 },
28694 "400" : {
28695 "$ref" : "#/components/responses/Default400Response"
28696 },
28697 "404" : {
28698 "$ref" : "#/components/responses/Default404Response"
28699 },
28700 "405" : {
28701 "$ref" : "#/components/responses/Default405Response"
28702 },
28703 "406" : {
28704 "$ref" : "#/components/responses/Default406Response"
28705 },
28706 "415" : {
28707 "$ref" : "#/components/responses/Default415Response"
28708 },
28709 "429" : {
28710 "$ref" : "#/components/responses/Default429Response"
28711 },
28712 "500" : {
28713 "$ref" : "#/components/responses/Default500Response"
28714 },
28715 "503" : {
28716 "$ref" : "#/components/responses/Default503Response"
28717 }
28718 },
28719 "security" : [ {
28720 "Client_Credentials" : [ ]
28721 }, {
28722 "Authorization_Code_PKCE" : [ ]
28723 } ],
28724 "summary" : "Get single video.",
28725 "tags" : [ "videos" ],
28726 "x-path-item-properties" : {
28727 "required-access-tier" : "THIRD_PARTY"
28728 }
28729 }
28730 },
28731 "/videos/{id}/relationships/albums" : {
28732 "get" : {
28733 "description" : "Retrieves albums relationship.",
28734 "parameters" : [ {
28735 "description" : "Video id",
28736 "example" : "75623239",
28737 "in" : "path",
28738 "name" : "id",
28739 "required" : true,
28740 "schema" : {
28741 "type" : "string"
28742 }
28743 }, {
28744 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
28745 "in" : "query",
28746 "name" : "page[cursor]",
28747 "required" : false,
28748 "schema" : {
28749 "type" : "string"
28750 }
28751 }, {
28752 "description" : "ISO 3166-1 alpha-2 country code",
28753 "example" : "US",
28754 "in" : "query",
28755 "name" : "countryCode",
28756 "required" : false,
28757 "schema" : {
28758 "type" : "string"
28759 }
28760 }, {
28761 "description" : "Allows the client to customize which related resources should be returned. Available options: albums",
28762 "example" : "albums",
28763 "in" : "query",
28764 "name" : "include",
28765 "required" : false,
28766 "schema" : {
28767 "type" : "array",
28768 "items" : {
28769 "type" : "string",
28770 "example" : "albums"
28771 }
28772 }
28773 }, {
28774 "description" : "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",
28775 "example" : "albums",
28776 "in" : "query",
28777 "name" : "replaceMedia",
28778 "required" : false,
28779 "schema" : {
28780 "type" : "string",
28781 "example" : "albums"
28782 }
28783 } ],
28784 "responses" : {
28785 "200" : {
28786 "content" : {
28787 "application/vnd.api+json" : {
28788 "schema" : {
28789 "$ref" : "#/components/schemas/Videos_Multi_Relationship_Data_Document"
28790 }
28791 }
28792 },
28793 "description" : "Successful response"
28794 },
28795 "400" : {
28796 "$ref" : "#/components/responses/Default400Response"
28797 },
28798 "404" : {
28799 "$ref" : "#/components/responses/Default404Response"
28800 },
28801 "405" : {
28802 "$ref" : "#/components/responses/Default405Response"
28803 },
28804 "406" : {
28805 "$ref" : "#/components/responses/Default406Response"
28806 },
28807 "415" : {
28808 "$ref" : "#/components/responses/Default415Response"
28809 },
28810 "429" : {
28811 "$ref" : "#/components/responses/Default429Response"
28812 },
28813 "500" : {
28814 "$ref" : "#/components/responses/Default500Response"
28815 },
28816 "503" : {
28817 "$ref" : "#/components/responses/Default503Response"
28818 }
28819 },
28820 "security" : [ {
28821 "Client_Credentials" : [ ]
28822 }, {
28823 "Authorization_Code_PKCE" : [ ]
28824 } ],
28825 "summary" : "Get albums relationship (\"to-many\").",
28826 "tags" : [ "videos" ],
28827 "x-path-item-properties" : {
28828 "required-access-tier" : "THIRD_PARTY"
28829 }
28830 }
28831 },
28832 "/videos/{id}/relationships/artists" : {
28833 "get" : {
28834 "description" : "Retrieves artists relationship.",
28835 "parameters" : [ {
28836 "description" : "Video id",
28837 "example" : "75623239",
28838 "in" : "path",
28839 "name" : "id",
28840 "required" : true,
28841 "schema" : {
28842 "type" : "string"
28843 }
28844 }, {
28845 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
28846 "in" : "query",
28847 "name" : "page[cursor]",
28848 "required" : false,
28849 "schema" : {
28850 "type" : "string"
28851 }
28852 }, {
28853 "description" : "ISO 3166-1 alpha-2 country code",
28854 "example" : "US",
28855 "in" : "query",
28856 "name" : "countryCode",
28857 "required" : false,
28858 "schema" : {
28859 "type" : "string"
28860 }
28861 }, {
28862 "description" : "Allows the client to customize which related resources should be returned. Available options: artists",
28863 "example" : "artists.albums",
28864 "in" : "query",
28865 "name" : "include",
28866 "required" : false,
28867 "schema" : {
28868 "type" : "array",
28869 "items" : {
28870 "type" : "string",
28871 "example" : "artists.albums"
28872 }
28873 }
28874 }, {
28875 "description" : "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",
28876 "example" : "artists.albums",
28877 "in" : "query",
28878 "name" : "replaceMedia",
28879 "required" : false,
28880 "schema" : {
28881 "type" : "string",
28882 "example" : "artists.albums"
28883 }
28884 } ],
28885 "responses" : {
28886 "200" : {
28887 "content" : {
28888 "application/vnd.api+json" : {
28889 "schema" : {
28890 "$ref" : "#/components/schemas/Videos_Multi_Relationship_Data_Document"
28891 }
28892 }
28893 },
28894 "description" : "Successful response"
28895 },
28896 "400" : {
28897 "$ref" : "#/components/responses/Default400Response"
28898 },
28899 "404" : {
28900 "$ref" : "#/components/responses/Default404Response"
28901 },
28902 "405" : {
28903 "$ref" : "#/components/responses/Default405Response"
28904 },
28905 "406" : {
28906 "$ref" : "#/components/responses/Default406Response"
28907 },
28908 "415" : {
28909 "$ref" : "#/components/responses/Default415Response"
28910 },
28911 "429" : {
28912 "$ref" : "#/components/responses/Default429Response"
28913 },
28914 "500" : {
28915 "$ref" : "#/components/responses/Default500Response"
28916 },
28917 "503" : {
28918 "$ref" : "#/components/responses/Default503Response"
28919 }
28920 },
28921 "security" : [ {
28922 "Client_Credentials" : [ ]
28923 }, {
28924 "Authorization_Code_PKCE" : [ ]
28925 } ],
28926 "summary" : "Get artists relationship (\"to-many\").",
28927 "tags" : [ "videos" ],
28928 "x-path-item-properties" : {
28929 "required-access-tier" : "THIRD_PARTY"
28930 }
28931 }
28932 },
28933 "/videos/{id}/relationships/credits" : {
28934 "get" : {
28935 "description" : "Retrieves credits relationship.",
28936 "parameters" : [ {
28937 "description" : "Video id",
28938 "example" : "75623239",
28939 "in" : "path",
28940 "name" : "id",
28941 "required" : true,
28942 "schema" : {
28943 "type" : "string"
28944 }
28945 }, {
28946 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
28947 "in" : "query",
28948 "name" : "page[cursor]",
28949 "required" : false,
28950 "schema" : {
28951 "type" : "string"
28952 }
28953 }, {
28954 "description" : "Allows the client to customize which related resources should be returned. Available options: credits",
28955 "example" : "credits.artist.albums",
28956 "in" : "query",
28957 "name" : "include",
28958 "required" : false,
28959 "schema" : {
28960 "type" : "array",
28961 "items" : {
28962 "type" : "string",
28963 "example" : "credits.artist.albums"
28964 }
28965 }
28966 }, {
28967 "description" : "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",
28968 "example" : "credits.artist.albums",
28969 "in" : "query",
28970 "name" : "replaceMedia",
28971 "required" : false,
28972 "schema" : {
28973 "type" : "string",
28974 "example" : "credits.artist.albums"
28975 }
28976 } ],
28977 "responses" : {
28978 "200" : {
28979 "content" : {
28980 "application/vnd.api+json" : {
28981 "schema" : {
28982 "$ref" : "#/components/schemas/Videos_Multi_Relationship_Data_Document"
28983 }
28984 }
28985 },
28986 "description" : "Successful response"
28987 },
28988 "400" : {
28989 "$ref" : "#/components/responses/Default400Response"
28990 },
28991 "404" : {
28992 "$ref" : "#/components/responses/Default404Response"
28993 },
28994 "405" : {
28995 "$ref" : "#/components/responses/Default405Response"
28996 },
28997 "406" : {
28998 "$ref" : "#/components/responses/Default406Response"
28999 },
29000 "415" : {
29001 "$ref" : "#/components/responses/Default415Response"
29002 },
29003 "429" : {
29004 "$ref" : "#/components/responses/Default429Response"
29005 },
29006 "500" : {
29007 "$ref" : "#/components/responses/Default500Response"
29008 },
29009 "503" : {
29010 "$ref" : "#/components/responses/Default503Response"
29011 }
29012 },
29013 "security" : [ {
29014 "Client_Credentials" : [ ]
29015 }, {
29016 "Authorization_Code_PKCE" : [ ]
29017 } ],
29018 "summary" : "Get credits relationship (\"to-many\").",
29019 "tags" : [ "videos" ],
29020 "x-path-item-properties" : {
29021 "required-access-tier" : "INTERNAL"
29022 }
29023 }
29024 },
29025 "/videos/{id}/relationships/providers" : {
29026 "get" : {
29027 "description" : "Retrieves providers relationship.",
29028 "parameters" : [ {
29029 "description" : "Video id",
29030 "example" : "75623239",
29031 "in" : "path",
29032 "name" : "id",
29033 "required" : true,
29034 "schema" : {
29035 "type" : "string"
29036 }
29037 }, {
29038 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
29039 "in" : "query",
29040 "name" : "page[cursor]",
29041 "required" : false,
29042 "schema" : {
29043 "type" : "string"
29044 }
29045 }, {
29046 "description" : "ISO 3166-1 alpha-2 country code",
29047 "example" : "US",
29048 "in" : "query",
29049 "name" : "countryCode",
29050 "required" : false,
29051 "schema" : {
29052 "type" : "string"
29053 }
29054 }, {
29055 "description" : "Allows the client to customize which related resources should be returned. Available options: providers",
29056 "example" : "providers",
29057 "in" : "query",
29058 "name" : "include",
29059 "required" : false,
29060 "schema" : {
29061 "type" : "array",
29062 "items" : {
29063 "type" : "string",
29064 "example" : "providers"
29065 }
29066 }
29067 } ],
29068 "responses" : {
29069 "200" : {
29070 "content" : {
29071 "application/vnd.api+json" : {
29072 "schema" : {
29073 "$ref" : "#/components/schemas/Videos_Multi_Relationship_Data_Document"
29074 }
29075 }
29076 },
29077 "description" : "Successful response"
29078 },
29079 "400" : {
29080 "$ref" : "#/components/responses/Default400Response"
29081 },
29082 "404" : {
29083 "$ref" : "#/components/responses/Default404Response"
29084 },
29085 "405" : {
29086 "$ref" : "#/components/responses/Default405Response"
29087 },
29088 "406" : {
29089 "$ref" : "#/components/responses/Default406Response"
29090 },
29091 "415" : {
29092 "$ref" : "#/components/responses/Default415Response"
29093 },
29094 "429" : {
29095 "$ref" : "#/components/responses/Default429Response"
29096 },
29097 "500" : {
29098 "$ref" : "#/components/responses/Default500Response"
29099 },
29100 "503" : {
29101 "$ref" : "#/components/responses/Default503Response"
29102 }
29103 },
29104 "security" : [ {
29105 "Client_Credentials" : [ ]
29106 }, {
29107 "Authorization_Code_PKCE" : [ ]
29108 } ],
29109 "summary" : "Get providers relationship (\"to-many\").",
29110 "tags" : [ "videos" ],
29111 "x-path-item-properties" : {
29112 "required-access-tier" : "THIRD_PARTY"
29113 }
29114 }
29115 },
29116 "/videos/{id}/relationships/replacement" : {
29117 "get" : {
29118 "description" : "Retrieves replacement relationship.",
29119 "parameters" : [ {
29120 "description" : "Video id",
29121 "example" : "75623239",
29122 "in" : "path",
29123 "name" : "id",
29124 "required" : true,
29125 "schema" : {
29126 "type" : "string"
29127 }
29128 }, {
29129 "description" : "ISO 3166-1 alpha-2 country code",
29130 "example" : "US",
29131 "in" : "query",
29132 "name" : "countryCode",
29133 "required" : false,
29134 "schema" : {
29135 "type" : "string"
29136 }
29137 }, {
29138 "description" : "Allows the client to customize which related resources should be returned. Available options: replacement",
29139 "example" : "replacement",
29140 "in" : "query",
29141 "name" : "include",
29142 "required" : false,
29143 "schema" : {
29144 "type" : "array",
29145 "items" : {
29146 "type" : "string",
29147 "example" : "replacement"
29148 }
29149 }
29150 }, {
29151 "description" : "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",
29152 "example" : "replacement",
29153 "in" : "query",
29154 "name" : "replaceMedia",
29155 "required" : false,
29156 "schema" : {
29157 "type" : "string",
29158 "example" : "replacement"
29159 }
29160 } ],
29161 "responses" : {
29162 "200" : {
29163 "content" : {
29164 "application/vnd.api+json" : {
29165 "schema" : {
29166 "$ref" : "#/components/schemas/Videos_Single_Relationship_Data_Document"
29167 }
29168 }
29169 },
29170 "description" : "Successful response"
29171 },
29172 "400" : {
29173 "$ref" : "#/components/responses/Default400Response"
29174 },
29175 "404" : {
29176 "$ref" : "#/components/responses/Default404Response"
29177 },
29178 "405" : {
29179 "$ref" : "#/components/responses/Default405Response"
29180 },
29181 "406" : {
29182 "$ref" : "#/components/responses/Default406Response"
29183 },
29184 "415" : {
29185 "$ref" : "#/components/responses/Default415Response"
29186 },
29187 "429" : {
29188 "$ref" : "#/components/responses/Default429Response"
29189 },
29190 "500" : {
29191 "$ref" : "#/components/responses/Default500Response"
29192 },
29193 "503" : {
29194 "$ref" : "#/components/responses/Default503Response"
29195 }
29196 },
29197 "security" : [ {
29198 "Client_Credentials" : [ ]
29199 }, {
29200 "Authorization_Code_PKCE" : [ ]
29201 } ],
29202 "summary" : "Get replacement relationship (\"to-one\").",
29203 "tags" : [ "videos" ],
29204 "x-path-item-properties" : {
29205 "required-access-tier" : "INTERNAL"
29206 }
29207 }
29208 },
29209 "/videos/{id}/relationships/similarVideos" : {
29210 "get" : {
29211 "description" : "Retrieves similarVideos relationship.",
29212 "parameters" : [ {
29213 "description" : "Video id",
29214 "example" : "75623239",
29215 "in" : "path",
29216 "name" : "id",
29217 "required" : true,
29218 "schema" : {
29219 "type" : "string"
29220 }
29221 }, {
29222 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
29223 "in" : "query",
29224 "name" : "page[cursor]",
29225 "required" : false,
29226 "schema" : {
29227 "type" : "string"
29228 }
29229 }, {
29230 "description" : "ISO 3166-1 alpha-2 country code",
29231 "example" : "US",
29232 "in" : "query",
29233 "name" : "countryCode",
29234 "required" : false,
29235 "schema" : {
29236 "type" : "string"
29237 }
29238 }, {
29239 "description" : "Allows the client to customize which related resources should be returned. Available options: similarVideos",
29240 "example" : "similarVideos",
29241 "in" : "query",
29242 "name" : "include",
29243 "required" : false,
29244 "schema" : {
29245 "type" : "array",
29246 "items" : {
29247 "type" : "string",
29248 "example" : "similarVideos"
29249 }
29250 }
29251 }, {
29252 "description" : "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",
29253 "example" : "similarVideos",
29254 "in" : "query",
29255 "name" : "replaceMedia",
29256 "required" : false,
29257 "schema" : {
29258 "type" : "string",
29259 "example" : "similarVideos"
29260 }
29261 } ],
29262 "responses" : {
29263 "200" : {
29264 "content" : {
29265 "application/vnd.api+json" : {
29266 "schema" : {
29267 "$ref" : "#/components/schemas/Videos_Multi_Relationship_Data_Document"
29268 }
29269 }
29270 },
29271 "description" : "Successful response"
29272 },
29273 "400" : {
29274 "$ref" : "#/components/responses/Default400Response"
29275 },
29276 "404" : {
29277 "$ref" : "#/components/responses/Default404Response"
29278 },
29279 "405" : {
29280 "$ref" : "#/components/responses/Default405Response"
29281 },
29282 "406" : {
29283 "$ref" : "#/components/responses/Default406Response"
29284 },
29285 "415" : {
29286 "$ref" : "#/components/responses/Default415Response"
29287 },
29288 "429" : {
29289 "$ref" : "#/components/responses/Default429Response"
29290 },
29291 "500" : {
29292 "$ref" : "#/components/responses/Default500Response"
29293 },
29294 "503" : {
29295 "$ref" : "#/components/responses/Default503Response"
29296 }
29297 },
29298 "security" : [ {
29299 "Client_Credentials" : [ ]
29300 }, {
29301 "Authorization_Code_PKCE" : [ ]
29302 } ],
29303 "summary" : "Get similarVideos relationship (\"to-many\").",
29304 "tags" : [ "videos" ],
29305 "x-path-item-properties" : {
29306 "required-access-tier" : "INTERNAL"
29307 }
29308 }
29309 },
29310 "/videos/{id}/relationships/suggestedVideos" : {
29311 "get" : {
29312 "description" : "Retrieves suggestedVideos relationship.",
29313 "parameters" : [ {
29314 "description" : "Video id",
29315 "example" : "75623239",
29316 "in" : "path",
29317 "name" : "id",
29318 "required" : true,
29319 "schema" : {
29320 "type" : "string"
29321 }
29322 }, {
29323 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
29324 "in" : "query",
29325 "name" : "page[cursor]",
29326 "required" : false,
29327 "schema" : {
29328 "type" : "string"
29329 }
29330 }, {
29331 "description" : "ISO 3166-1 alpha-2 country code",
29332 "example" : "US",
29333 "in" : "query",
29334 "name" : "countryCode",
29335 "required" : false,
29336 "schema" : {
29337 "type" : "string"
29338 }
29339 }, {
29340 "description" : "Allows the client to customize which related resources should be returned. Available options: suggestedVideos",
29341 "example" : "suggestedVideos",
29342 "in" : "query",
29343 "name" : "include",
29344 "required" : false,
29345 "schema" : {
29346 "type" : "array",
29347 "items" : {
29348 "type" : "string",
29349 "example" : "suggestedVideos"
29350 }
29351 }
29352 }, {
29353 "description" : "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",
29354 "example" : "suggestedVideos",
29355 "in" : "query",
29356 "name" : "replaceMedia",
29357 "required" : false,
29358 "schema" : {
29359 "type" : "string",
29360 "example" : "suggestedVideos"
29361 }
29362 } ],
29363 "responses" : {
29364 "200" : {
29365 "content" : {
29366 "application/vnd.api+json" : {
29367 "schema" : {
29368 "$ref" : "#/components/schemas/Videos_Multi_Relationship_Data_Document"
29369 }
29370 }
29371 },
29372 "description" : "Successful response"
29373 },
29374 "400" : {
29375 "$ref" : "#/components/responses/Default400Response"
29376 },
29377 "404" : {
29378 "$ref" : "#/components/responses/Default404Response"
29379 },
29380 "405" : {
29381 "$ref" : "#/components/responses/Default405Response"
29382 },
29383 "406" : {
29384 "$ref" : "#/components/responses/Default406Response"
29385 },
29386 "415" : {
29387 "$ref" : "#/components/responses/Default415Response"
29388 },
29389 "429" : {
29390 "$ref" : "#/components/responses/Default429Response"
29391 },
29392 "500" : {
29393 "$ref" : "#/components/responses/Default500Response"
29394 },
29395 "503" : {
29396 "$ref" : "#/components/responses/Default503Response"
29397 }
29398 },
29399 "security" : [ {
29400 "Client_Credentials" : [ ]
29401 }, {
29402 "Authorization_Code_PKCE" : [ ]
29403 } ],
29404 "summary" : "Get suggestedVideos relationship (\"to-many\").",
29405 "tags" : [ "videos" ],
29406 "x-path-item-properties" : {
29407 "required-access-tier" : "INTERNAL"
29408 }
29409 }
29410 },
29411 "/videos/{id}/relationships/thumbnailArt" : {
29412 "get" : {
29413 "description" : "Retrieves thumbnailArt relationship.",
29414 "parameters" : [ {
29415 "description" : "Video id",
29416 "example" : "75623239",
29417 "in" : "path",
29418 "name" : "id",
29419 "required" : true,
29420 "schema" : {
29421 "type" : "string"
29422 }
29423 }, {
29424 "description" : "Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified",
29425 "in" : "query",
29426 "name" : "page[cursor]",
29427 "required" : false,
29428 "schema" : {
29429 "type" : "string"
29430 }
29431 }, {
29432 "description" : "ISO 3166-1 alpha-2 country code",
29433 "example" : "US",
29434 "in" : "query",
29435 "name" : "countryCode",
29436 "required" : false,
29437 "schema" : {
29438 "type" : "string"
29439 }
29440 }, {
29441 "description" : "Allows the client to customize which related resources should be returned. Available options: thumbnailArt",
29442 "example" : "thumbnailArt",
29443 "in" : "query",
29444 "name" : "include",
29445 "required" : false,
29446 "schema" : {
29447 "type" : "array",
29448 "items" : {
29449 "type" : "string",
29450 "example" : "thumbnailArt"
29451 }
29452 }
29453 } ],
29454 "responses" : {
29455 "200" : {
29456 "content" : {
29457 "application/vnd.api+json" : {
29458 "schema" : {
29459 "$ref" : "#/components/schemas/Videos_Multi_Relationship_Data_Document"
29460 }
29461 }
29462 },
29463 "description" : "Successful response"
29464 },
29465 "400" : {
29466 "$ref" : "#/components/responses/Default400Response"
29467 },
29468 "404" : {
29469 "$ref" : "#/components/responses/Default404Response"
29470 },
29471 "405" : {
29472 "$ref" : "#/components/responses/Default405Response"
29473 },
29474 "406" : {
29475 "$ref" : "#/components/responses/Default406Response"
29476 },
29477 "415" : {
29478 "$ref" : "#/components/responses/Default415Response"
29479 },
29480 "429" : {
29481 "$ref" : "#/components/responses/Default429Response"
29482 },
29483 "500" : {
29484 "$ref" : "#/components/responses/Default500Response"
29485 },
29486 "503" : {
29487 "$ref" : "#/components/responses/Default503Response"
29488 }
29489 },
29490 "security" : [ {
29491 "Client_Credentials" : [ ]
29492 }, {
29493 "Authorization_Code_PKCE" : [ ]
29494 } ],
29495 "summary" : "Get thumbnailArt relationship (\"to-many\").",
29496 "tags" : [ "videos" ],
29497 "x-path-item-properties" : {
29498 "required-access-tier" : "THIRD_PARTY"
29499 }
29500 }
29501 },
29502 "/videos/{id}/relationships/usageRules" : {
29503 "get" : {
29504 "description" : "Retrieves usageRules relationship.",
29505 "parameters" : [ {
29506 "description" : "Video id",
29507 "example" : "75623239",
29508 "in" : "path",
29509 "name" : "id",
29510 "required" : true,
29511 "schema" : {
29512 "type" : "string"
29513 }
29514 }, {
29515 "description" : "ISO 3166-1 alpha-2 country code",
29516 "example" : "US",
29517 "in" : "query",
29518 "name" : "countryCode",
29519 "required" : false,
29520 "schema" : {
29521 "type" : "string"
29522 }
29523 }, {
29524 "description" : "Allows the client to customize which related resources should be returned. Available options: usageRules",
29525 "example" : "usageRules",
29526 "in" : "query",
29527 "name" : "include",
29528 "required" : false,
29529 "schema" : {
29530 "type" : "array",
29531 "items" : {
29532 "type" : "string",
29533 "example" : "usageRules"
29534 }
29535 }
29536 } ],
29537 "responses" : {
29538 "200" : {
29539 "content" : {
29540 "application/vnd.api+json" : {
29541 "schema" : {
29542 "$ref" : "#/components/schemas/Videos_Single_Relationship_Data_Document"
29543 }
29544 }
29545 },
29546 "description" : "Successful response"
29547 },
29548 "400" : {
29549 "$ref" : "#/components/responses/Default400Response"
29550 },
29551 "404" : {
29552 "$ref" : "#/components/responses/Default404Response"
29553 },
29554 "405" : {
29555 "$ref" : "#/components/responses/Default405Response"
29556 },
29557 "406" : {
29558 "$ref" : "#/components/responses/Default406Response"
29559 },
29560 "415" : {
29561 "$ref" : "#/components/responses/Default415Response"
29562 },
29563 "429" : {
29564 "$ref" : "#/components/responses/Default429Response"
29565 },
29566 "500" : {
29567 "$ref" : "#/components/responses/Default500Response"
29568 },
29569 "503" : {
29570 "$ref" : "#/components/responses/Default503Response"
29571 }
29572 },
29573 "security" : [ {
29574 "Client_Credentials" : [ ]
29575 }, {
29576 "Authorization_Code_PKCE" : [ ]
29577 } ],
29578 "summary" : "Get usageRules relationship (\"to-one\").",
29579 "tags" : [ "videos" ],
29580 "x-path-item-properties" : {
29581 "required-access-tier" : "THIRD_PARTY"
29582 }
29583 }
29584 }
29585 },
29586 "components" : {
29587 "parameters" : {
29588 "IdempotencyKey" : {
29589 "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.",
29590 "in" : "header",
29591 "name" : "Idempotency-Key",
29592 "required" : false,
29593 "schema" : {
29594 "maxLength" : 128,
29595 "type" : "string",
29596 "example" : "79e1f37e-3e84-4c51-b5e2-7d9e1a2b3c4d"
29597 }
29598 }
29599 },
29600 "responses" : {
29601 "Default400Response" : {
29602 "content" : {
29603 "application/vnd.api+json" : {
29604 "schema" : {
29605 "$ref" : "#/components/schemas/Default400ResponseBody"
29606 }
29607 }
29608 },
29609 "description" : "Invalid request"
29610 },
29611 "Default404Response" : {
29612 "content" : {
29613 "application/vnd.api+json" : {
29614 "schema" : {
29615 "$ref" : "#/components/schemas/Default404ResponseBody"
29616 }
29617 }
29618 },
29619 "description" : "Resource not found"
29620 },
29621 "Default405Response" : {
29622 "content" : {
29623 "application/vnd.api+json" : {
29624 "schema" : {
29625 "$ref" : "#/components/schemas/Default405ResponseBody"
29626 }
29627 }
29628 },
29629 "description" : "HTTP method not allowed"
29630 },
29631 "Default406Response" : {
29632 "content" : {
29633 "application/vnd.api+json" : {
29634 "schema" : {
29635 "$ref" : "#/components/schemas/Default406ResponseBody"
29636 }
29637 }
29638 },
29639 "description" : "No acceptable response media type"
29640 },
29641 "Default415Response" : {
29642 "content" : {
29643 "application/vnd.api+json" : {
29644 "schema" : {
29645 "$ref" : "#/components/schemas/Default415ResponseBody"
29646 }
29647 }
29648 },
29649 "description" : "Unsupported request media type or encoding"
29650 },
29651 "Default429Response" : {
29652 "content" : {
29653 "application/vnd.api+json" : {
29654 "schema" : {
29655 "$ref" : "#/components/schemas/Default429ResponseBody"
29656 }
29657 }
29658 },
29659 "description" : "Rate limit exceeded"
29660 },
29661 "Default500Response" : {
29662 "content" : {
29663 "application/vnd.api+json" : {
29664 "schema" : {
29665 "$ref" : "#/components/schemas/Default500ResponseBody"
29666 }
29667 }
29668 },
29669 "description" : "Internal server error"
29670 },
29671 "Default503Response" : {
29672 "content" : {
29673 "application/vnd.api+json" : {
29674 "schema" : {
29675 "$ref" : "#/components/schemas/Default503ResponseBody"
29676 }
29677 }
29678 },
29679 "description" : "Service temporarily unavailable"
29680 },
29681 "Idempotency409Response" : {
29682 "content" : {
29683 "application/vnd.api+json" : {
29684 "schema" : {
29685 "$ref" : "#/components/schemas/Idempotency409ResponseBody"
29686 }
29687 }
29688 },
29689 "description" : "Request already in progress for this idempotency key"
29690 },
29691 "Idempotency422Response" : {
29692 "content" : {
29693 "application/vnd.api+json" : {
29694 "schema" : {
29695 "$ref" : "#/components/schemas/Idempotency422ResponseBody"
29696 }
29697 }
29698 },
29699 "description" : "Idempotency key reused with a different payload"
29700 },
29701 "SquareConnectionsReadById403Response" : {
29702 "content" : {
29703 "application/vnd.api+json" : {
29704 "schema" : {
29705 "$ref" : "#/components/schemas/SquareConnectionsReadById403ResponseBody"
29706 }
29707 }
29708 },
29709 "description" : "Latest terms and conditions must be accepted"
29710 },
29711 "SquareConnectionsReadMultiDataRelationship403Response" : {
29712 "content" : {
29713 "application/vnd.api+json" : {
29714 "schema" : {
29715 "$ref" : "#/components/schemas/SquareConnectionsReadMultiDataRelationship403ResponseBody"
29716 }
29717 }
29718 },
29719 "description" : "Latest terms and conditions must be accepted"
29720 },
29721 "SquareConnectionsReadSingleDataRelationship403Response" : {
29722 "content" : {
29723 "application/vnd.api+json" : {
29724 "schema" : {
29725 "$ref" : "#/components/schemas/SquareConnectionsReadSingleDataRelationship403ResponseBody"
29726 }
29727 }
29728 },
29729 "description" : "Latest terms and conditions must be accepted"
29730 },
29731 "SquareConnectionsUpdateSingleDataRelationship403Response" : {
29732 "content" : {
29733 "application/vnd.api+json" : {
29734 "schema" : {
29735 "$ref" : "#/components/schemas/SquareConnectionsUpdateSingleDataRelationship403ResponseBody"
29736 }
29737 }
29738 },
29739 "description" : "Latest terms and conditions must be accepted"
29740 },
29741 "SquareConnectionsUpdateSingleDataRelationship409Response" : {
29742 "content" : {
29743 "application/vnd.api+json" : {
29744 "schema" : {
29745 "$ref" : "#/components/schemas/SquareConnectionsUpdateSingleDataRelationship409ResponseBody"
29746 }
29747 }
29748 },
29749 "description" : "Square credential lacks required site scopes; run Square onboarding again; Request already in progress for this idempotency key"
29750 },
29751 "TrackFilesReadById403Response" : {
29752 "content" : {
29753 "application/vnd.api+json" : {
29754 "schema" : {
29755 "$ref" : "#/components/schemas/TrackFilesReadById403ResponseBody"
29756 }
29757 }
29758 },
29759 "description" : "Required playback prerequisites are missing; Content is unavailable in your location; Content must be purchased before playback; Client cannot access this content; Account is playing on another app or device"
29760 },
29761 "TrackFilesReadById404Response" : {
29762 "content" : {
29763 "application/vnd.api+json" : {
29764 "schema" : {
29765 "$ref" : "#/components/schemas/TrackFilesReadById404ResponseBody"
29766 }
29767 }
29768 },
29769 "description" : "Content does not exist or is no longer available"
29770 },
29771 "TrackManifestsReadById403Response" : {
29772 "content" : {
29773 "application/vnd.api+json" : {
29774 "schema" : {
29775 "$ref" : "#/components/schemas/TrackManifestsReadById403ResponseBody"
29776 }
29777 }
29778 },
29779 "description" : "Required playback prerequisites are missing; Content is unavailable in your location; Content must be purchased before playback; Client cannot access this content; Account is playing on another app or device"
29780 },
29781 "TrackManifestsReadById404Response" : {
29782 "content" : {
29783 "application/vnd.api+json" : {
29784 "schema" : {
29785 "$ref" : "#/components/schemas/TrackManifestsReadById404ResponseBody"
29786 }
29787 }
29788 },
29789 "description" : "Content does not exist or is no longer available"
29790 },
29791 "UserCollectionAlbumsAddMultiDataRelationshipWithResponse409Response" : {
29792 "content" : {
29793 "application/vnd.api+json" : {
29794 "schema" : {
29795 "$ref" : "#/components/schemas/UserCollectionAlbumsAddMultiDataRelationshipWithResponse409ResponseBody"
29796 }
29797 }
29798 },
29799 "description" : "Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key"
29800 },
29801 "UserCollectionArtistsAddMultiDataRelationshipWithResponse409Response" : {
29802 "content" : {
29803 "application/vnd.api+json" : {
29804 "schema" : {
29805 "$ref" : "#/components/schemas/UserCollectionArtistsAddMultiDataRelationshipWithResponse409ResponseBody"
29806 }
29807 }
29808 },
29809 "description" : "Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key"
29810 },
29811 "UserCollectionFoldersDeleteResource400Response" : {
29812 "content" : {
29813 "application/vnd.api+json" : {
29814 "schema" : {
29815 "$ref" : "#/components/schemas/UserCollectionFoldersDeleteResource400ResponseBody"
29816 }
29817 }
29818 },
29819 "description" : "Folder must be empty and owned by you"
29820 },
29821 "UserCollectionPlaylistsAddMultiDataRelationshipWithResponse409Response" : {
29822 "content" : {
29823 "application/vnd.api+json" : {
29824 "schema" : {
29825 "$ref" : "#/components/schemas/UserCollectionPlaylistsAddMultiDataRelationshipWithResponse409ResponseBody"
29826 }
29827 }
29828 },
29829 "description" : "Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key"
29830 },
29831 "UserCollectionSaveForLatersAddMultiDataRelationshipWithResponse409Response" : {
29832 "content" : {
29833 "application/vnd.api+json" : {
29834 "schema" : {
29835 "$ref" : "#/components/schemas/UserCollectionSaveForLatersAddMultiDataRelationshipWithResponse409ResponseBody"
29836 }
29837 }
29838 },
29839 "description" : "Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key"
29840 },
29841 "UserCollectionTracksAddMultiDataRelationshipWithResponse409Response" : {
29842 "content" : {
29843 "application/vnd.api+json" : {
29844 "schema" : {
29845 "$ref" : "#/components/schemas/UserCollectionTracksAddMultiDataRelationshipWithResponse409ResponseBody"
29846 }
29847 }
29848 },
29849 "description" : "Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key"
29850 },
29851 "UserCollectionVideosAddMultiDataRelationshipWithResponse409Response" : {
29852 "content" : {
29853 "application/vnd.api+json" : {
29854 "schema" : {
29855 "$ref" : "#/components/schemas/UserCollectionVideosAddMultiDataRelationshipWithResponse409ResponseBody"
29856 }
29857 }
29858 },
29859 "description" : "Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key"
29860 },
29861 "UserCollectionsAddMultiDataRelationship409Response" : {
29862 "content" : {
29863 "application/vnd.api+json" : {
29864 "schema" : {
29865 "$ref" : "#/components/schemas/UserCollectionsAddMultiDataRelationship409ResponseBody"
29866 }
29867 }
29868 },
29869 "description" : "Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key"
29870 },
29871 "UserRecommendationBlocksAddMultiDataRelationshipWithResponse409Response" : {
29872 "content" : {
29873 "application/vnd.api+json" : {
29874 "schema" : {
29875 "$ref" : "#/components/schemas/UserRecommendationBlocksAddMultiDataRelationshipWithResponse409ResponseBody"
29876 }
29877 }
29878 },
29879 "description" : "Recommendation block limit reached; Request already in progress for this idempotency key"
29880 },
29881 "VideoManifestsReadById403Response" : {
29882 "content" : {
29883 "application/vnd.api+json" : {
29884 "schema" : {
29885 "$ref" : "#/components/schemas/VideoManifestsReadById403ResponseBody"
29886 }
29887 }
29888 },
29889 "description" : "Required playback prerequisites are missing; Content is unavailable in your location; Content must be purchased before playback; Client cannot access this content; Account is playing on another app or device"
29890 },
29891 "VideoManifestsReadById404Response" : {
29892 "content" : {
29893 "application/vnd.api+json" : {
29894 "schema" : {
29895 "$ref" : "#/components/schemas/VideoManifestsReadById404ResponseBody"
29896 }
29897 }
29898 },
29899 "description" : "Content does not exist or is no longer available"
29900 }
29901 },
29902 "schemas" : {
29903 "AcceptedTermsCreateOperation_Payload" : {
29904 "required" : [ "data" ],
29905 "type" : "object",
29906 "properties" : {
29907 "data" : {
29908 "$ref" : "#/components/schemas/AcceptedTermsCreateOperation_Payload_Data"
29909 }
29910 }
29911 },
29912 "AcceptedTermsCreateOperation_Payload_Data" : {
29913 "required" : [ "relationships", "type" ],
29914 "type" : "object",
29915 "properties" : {
29916 "relationships" : {
29917 "$ref" : "#/components/schemas/AcceptedTermsCreateOperation_Payload_Data_Relationships"
29918 },
29919 "type" : {
29920 "type" : "string",
29921 "enum" : [ "acceptedTerms" ]
29922 }
29923 }
29924 },
29925 "AcceptedTermsCreateOperation_Payload_Data_Relationships" : {
29926 "required" : [ "terms" ],
29927 "type" : "object",
29928 "properties" : {
29929 "terms" : {
29930 "$ref" : "#/components/schemas/AcceptedTermsCreateOperation_Payload_Data_Relationships_Terms"
29931 }
29932 }
29933 },
29934 "AcceptedTermsCreateOperation_Payload_Data_Relationships_Terms" : {
29935 "required" : [ "data" ],
29936 "type" : "object",
29937 "properties" : {
29938 "data" : {
29939 "$ref" : "#/components/schemas/AcceptedTermsCreateOperation_Payload_Data_Relationships_Terms_Data"
29940 }
29941 }
29942 },
29943 "AcceptedTermsCreateOperation_Payload_Data_Relationships_Terms_Data" : {
29944 "required" : [ "id", "type" ],
29945 "type" : "object",
29946 "properties" : {
29947 "id" : {
29948 "type" : "string"
29949 },
29950 "type" : {
29951 "type" : "string",
29952 "enum" : [ "terms" ]
29953 }
29954 }
29955 },
29956 "AcceptedTerms_Attributes" : {
29957 "required" : [ "createdAt" ],
29958 "type" : "object",
29959 "properties" : {
29960 "createdAt" : {
29961 "type" : "string",
29962 "format" : "date-time"
29963 }
29964 }
29965 },
29966 "AcceptedTerms_Create_Single_Resource_Data_Document" : {
29967 "required" : [ "data", "links" ],
29968 "type" : "object",
29969 "properties" : {
29970 "data" : {
29971 "$ref" : "#/components/schemas/AcceptedTerms_Resource_Object"
29972 },
29973 "links" : {
29974 "$ref" : "#/components/schemas/Links"
29975 }
29976 }
29977 },
29978 "AcceptedTerms_Multi_Relationship_Data_Document" : {
29979 "required" : [ "links" ],
29980 "type" : "object",
29981 "properties" : {
29982 "data" : {
29983 "type" : "array",
29984 "items" : {
29985 "$ref" : "#/components/schemas/Resource_Identifier"
29986 }
29987 },
29988 "included" : {
29989 "$ref" : "#/components/schemas/Included"
29990 },
29991 "links" : {
29992 "$ref" : "#/components/schemas/Links"
29993 }
29994 }
29995 },
29996 "AcceptedTerms_Multi_Resource_Data_Document" : {
29997 "required" : [ "data", "links" ],
29998 "type" : "object",
29999 "properties" : {
30000 "data" : {
30001 "type" : "array",
30002 "items" : {
30003 "$ref" : "#/components/schemas/AcceptedTerms_Resource_Object"
30004 }
30005 },
30006 "included" : {
30007 "$ref" : "#/components/schemas/Included"
30008 },
30009 "links" : {
30010 "$ref" : "#/components/schemas/Links"
30011 }
30012 }
30013 },
30014 "AcceptedTerms_Relationships" : {
30015 "properties" : {
30016 "owners" : {
30017 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
30018 },
30019 "terms" : {
30020 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
30021 }
30022 }
30023 },
30024 "AcceptedTerms_Resource_Object" : {
30025 "required" : [ "id", "type" ],
30026 "type" : "object",
30027 "properties" : {
30028 "attributes" : {
30029 "$ref" : "#/components/schemas/AcceptedTerms_Attributes"
30030 },
30031 "id" : {
30032 "type" : "string",
30033 "description" : "Resource id",
30034 "example" : "12345"
30035 },
30036 "relationships" : {
30037 "$ref" : "#/components/schemas/AcceptedTerms_Relationships"
30038 },
30039 "type" : {
30040 "minLength" : 1,
30041 "type" : "string",
30042 "description" : "Resource type",
30043 "example" : "tracks"
30044 }
30045 }
30046 },
30047 "AcceptedTerms_Single_Relationship_Data_Document" : {
30048 "required" : [ "links" ],
30049 "type" : "object",
30050 "properties" : {
30051 "data" : {
30052 "oneOf" : [ {
30053 "$ref" : "#/components/schemas/Resource_Identifier"
30054 }, {
30055 "type" : "object",
30056 "nullable" : true,
30057 "enum" : [ null ]
30058 } ]
30059 },
30060 "included" : {
30061 "$ref" : "#/components/schemas/Included"
30062 },
30063 "links" : {
30064 "$ref" : "#/components/schemas/Links"
30065 }
30066 }
30067 },
30068 "AlbumStatistics_Attributes" : {
30069 "required" : [ "totalPlaybacks", "uniqueListeners" ],
30070 "type" : "object",
30071 "properties" : {
30072 "numSales" : {
30073 "type" : "integer",
30074 "description" : "Number of sales",
30075 "format" : "int32"
30076 },
30077 "totalPlaybacks" : {
30078 "type" : "integer",
30079 "description" : "Total playbacks",
30080 "format" : "int32"
30081 },
30082 "uniqueListeners" : {
30083 "type" : "integer",
30084 "description" : "Unique listeners",
30085 "format" : "int32"
30086 }
30087 }
30088 },
30089 "AlbumStatistics_Multi_Relationship_Data_Document" : {
30090 "required" : [ "links" ],
30091 "type" : "object",
30092 "properties" : {
30093 "data" : {
30094 "type" : "array",
30095 "items" : {
30096 "$ref" : "#/components/schemas/Resource_Identifier"
30097 }
30098 },
30099 "included" : {
30100 "$ref" : "#/components/schemas/Included"
30101 },
30102 "links" : {
30103 "$ref" : "#/components/schemas/Links"
30104 }
30105 }
30106 },
30107 "AlbumStatistics_Relationships" : {
30108 "properties" : {
30109 "owners" : {
30110 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
30111 }
30112 }
30113 },
30114 "AlbumStatistics_Resource_Object" : {
30115 "required" : [ "id", "type" ],
30116 "type" : "object",
30117 "properties" : {
30118 "attributes" : {
30119 "$ref" : "#/components/schemas/AlbumStatistics_Attributes"
30120 },
30121 "id" : {
30122 "type" : "string",
30123 "description" : "Resource id",
30124 "example" : "12345"
30125 },
30126 "relationships" : {
30127 "$ref" : "#/components/schemas/AlbumStatistics_Relationships"
30128 },
30129 "type" : {
30130 "minLength" : 1,
30131 "type" : "string",
30132 "description" : "Resource type",
30133 "example" : "tracks"
30134 }
30135 }
30136 },
30137 "AlbumStatistics_Single_Resource_Data_Document" : {
30138 "required" : [ "data", "links" ],
30139 "type" : "object",
30140 "properties" : {
30141 "data" : {
30142 "$ref" : "#/components/schemas/AlbumStatistics_Resource_Object"
30143 },
30144 "included" : {
30145 "$ref" : "#/components/schemas/Included"
30146 },
30147 "links" : {
30148 "$ref" : "#/components/schemas/Links"
30149 }
30150 }
30151 },
30152 "AlbumsCoverArtRelationshipUpdateOperation_Payload" : {
30153 "required" : [ "data" ],
30154 "type" : "object",
30155 "properties" : {
30156 "data" : {
30157 "maxItems" : 1,
30158 "minItems" : 0,
30159 "type" : "array",
30160 "items" : {
30161 "$ref" : "#/components/schemas/AlbumsCoverArtRelationshipUpdateOperation_Payload_Data"
30162 }
30163 }
30164 }
30165 },
30166 "AlbumsCoverArtRelationshipUpdateOperation_Payload_Data" : {
30167 "required" : [ "id", "type" ],
30168 "type" : "object",
30169 "properties" : {
30170 "id" : {
30171 "type" : "string"
30172 },
30173 "type" : {
30174 "type" : "string",
30175 "enum" : [ "artworks" ]
30176 }
30177 }
30178 },
30179 "AlbumsCreateOperation_Payload" : {
30180 "required" : [ "data" ],
30181 "type" : "object",
30182 "properties" : {
30183 "data" : {
30184 "$ref" : "#/components/schemas/AlbumsCreateOperation_Payload_Data"
30185 }
30186 }
30187 },
30188 "AlbumsCreateOperation_Payload_Data" : {
30189 "required" : [ "attributes", "relationships", "type" ],
30190 "type" : "object",
30191 "properties" : {
30192 "attributes" : {
30193 "$ref" : "#/components/schemas/AlbumsCreateOperation_Payload_Data_Attributes"
30194 },
30195 "relationships" : {
30196 "$ref" : "#/components/schemas/AlbumsCreateOperation_Payload_Data_Relationships"
30197 },
30198 "type" : {
30199 "type" : "string",
30200 "enum" : [ "albums" ]
30201 }
30202 }
30203 },
30204 "AlbumsCreateOperation_Payload_Data_Attributes" : {
30205 "required" : [ "title" ],
30206 "type" : "object",
30207 "properties" : {
30208 "albumType" : {
30209 "type" : "string",
30210 "enum" : [ "ALBUM", "EP", "SINGLE" ]
30211 },
30212 "copyright" : {
30213 "$ref" : "#/components/schemas/Copyright"
30214 },
30215 "explicit" : {
30216 "type" : "boolean",
30217 "description" : "Explicit content"
30218 },
30219 "explicitLyrics" : {
30220 "type" : "boolean",
30221 "description" : "Explicit content. Deprecated: use 'explicit' instead. This field will be removed in a future version.",
30222 "deprecated" : true
30223 },
30224 "releaseDate" : {
30225 "type" : "string",
30226 "format" : "date"
30227 },
30228 "title" : {
30229 "type" : "string"
30230 },
30231 "version" : {
30232 "type" : "string"
30233 }
30234 }
30235 },
30236 "AlbumsCreateOperation_Payload_Data_Relationships" : {
30237 "required" : [ "artists" ],
30238 "type" : "object",
30239 "properties" : {
30240 "artists" : {
30241 "$ref" : "#/components/schemas/AlbumsCreateOperation_Payload_Data_Relationships_Artists"
30242 },
30243 "genres" : {
30244 "$ref" : "#/components/schemas/AlbumsCreateOperation_Payload_Data_Relationships_Genres"
30245 }
30246 }
30247 },
30248 "AlbumsCreateOperation_Payload_Data_Relationships_Artists" : {
30249 "required" : [ "data" ],
30250 "type" : "object",
30251 "properties" : {
30252 "data" : {
30253 "maxItems" : 1,
30254 "minItems" : 1,
30255 "type" : "array",
30256 "items" : {
30257 "$ref" : "#/components/schemas/AlbumsCreateOperation_Payload_Data_Relationships_Artists_Data"
30258 }
30259 }
30260 }
30261 },
30262 "AlbumsCreateOperation_Payload_Data_Relationships_Artists_Data" : {
30263 "required" : [ "id", "type" ],
30264 "type" : "object",
30265 "properties" : {
30266 "id" : {
30267 "type" : "string"
30268 },
30269 "type" : {
30270 "type" : "string",
30271 "enum" : [ "artists" ]
30272 }
30273 }
30274 },
30275 "AlbumsCreateOperation_Payload_Data_Relationships_Genres" : {
30276 "required" : [ "data" ],
30277 "type" : "object",
30278 "properties" : {
30279 "data" : {
30280 "maxItems" : 3,
30281 "minItems" : 0,
30282 "type" : "array",
30283 "items" : {
30284 "$ref" : "#/components/schemas/AlbumsCreateOperation_Payload_Data_Relationships_Genres_Data"
30285 }
30286 }
30287 }
30288 },
30289 "AlbumsCreateOperation_Payload_Data_Relationships_Genres_Data" : {
30290 "required" : [ "id", "type" ],
30291 "type" : "object",
30292 "properties" : {
30293 "id" : {
30294 "type" : "string"
30295 },
30296 "type" : {
30297 "type" : "string",
30298 "enum" : [ "genres" ]
30299 }
30300 }
30301 },
30302 "AlbumsItemsRelationshipUpdateOperation_Payload" : {
30303 "required" : [ "data", "meta" ],
30304 "type" : "object",
30305 "properties" : {
30306 "data" : {
30307 "maxItems" : 1,
30308 "minItems" : 1,
30309 "type" : "array",
30310 "items" : {
30311 "$ref" : "#/components/schemas/AlbumsItemsRelationshipUpdateOperation_Payload_Data"
30312 }
30313 },
30314 "meta" : {
30315 "$ref" : "#/components/schemas/AlbumsItemsRelationshipUpdateOperation_Payload_Meta"
30316 }
30317 }
30318 },
30319 "AlbumsItemsRelationshipUpdateOperation_Payload_Data" : {
30320 "required" : [ "id", "type" ],
30321 "type" : "object",
30322 "properties" : {
30323 "id" : {
30324 "type" : "string"
30325 },
30326 "type" : {
30327 "type" : "string",
30328 "enum" : [ "tracks", "videos" ]
30329 }
30330 }
30331 },
30332 "AlbumsItemsRelationshipUpdateOperation_Payload_Meta" : {
30333 "required" : [ "positionIndex" ],
30334 "type" : "object",
30335 "properties" : {
30336 "positionIndex" : {
30337 "type" : "integer",
30338 "description" : "1-based index",
30339 "format" : "int32"
30340 }
30341 }
30342 },
30343 "AlbumsUpdateOperation_Payload" : {
30344 "required" : [ "data" ],
30345 "type" : "object",
30346 "properties" : {
30347 "data" : {
30348 "$ref" : "#/components/schemas/AlbumsUpdateOperation_Payload_Data"
30349 }
30350 }
30351 },
30352 "AlbumsUpdateOperation_Payload_Data" : {
30353 "required" : [ "id", "type" ],
30354 "type" : "object",
30355 "properties" : {
30356 "attributes" : {
30357 "$ref" : "#/components/schemas/AlbumsUpdateOperation_Payload_Data_Attributes"
30358 },
30359 "id" : {
30360 "type" : "string"
30361 },
30362 "relationships" : {
30363 "$ref" : "#/components/schemas/AlbumsUpdateOperation_Payload_Data_Relationships"
30364 },
30365 "type" : {
30366 "type" : "string",
30367 "enum" : [ "albums" ]
30368 }
30369 }
30370 },
30371 "AlbumsUpdateOperation_Payload_Data_Attributes" : {
30372 "type" : "object",
30373 "properties" : {
30374 "accessType" : {
30375 "type" : "string",
30376 "description" : "Access type",
30377 "example" : "PRIVATE",
30378 "enum" : [ "PUBLIC", "UNLISTED", "PRIVATE" ]
30379 },
30380 "albumType" : {
30381 "type" : "string",
30382 "enum" : [ "ALBUM", "EP", "SINGLE" ]
30383 },
30384 "copyright" : {
30385 "$ref" : "#/components/schemas/Copyright"
30386 },
30387 "explicit" : {
30388 "type" : "boolean",
30389 "description" : "Explicit content"
30390 },
30391 "explicitLyrics" : {
30392 "type" : "boolean",
30393 "description" : "Explicit content. Deprecated: use 'explicit' instead. This field will be removed in a future version.",
30394 "deprecated" : true
30395 },
30396 "releaseDate" : {
30397 "type" : "string",
30398 "format" : "date"
30399 },
30400 "title" : {
30401 "type" : "string"
30402 },
30403 "version" : {
30404 "type" : "string"
30405 }
30406 }
30407 },
30408 "AlbumsUpdateOperation_Payload_Data_Relationships" : {
30409 "type" : "object",
30410 "properties" : {
30411 "genres" : {
30412 "$ref" : "#/components/schemas/AlbumsUpdateOperation_Payload_Data_Relationships_Genres"
30413 }
30414 }
30415 },
30416 "AlbumsUpdateOperation_Payload_Data_Relationships_Genres" : {
30417 "required" : [ "data" ],
30418 "type" : "object",
30419 "properties" : {
30420 "data" : {
30421 "maxItems" : 3,
30422 "minItems" : 0,
30423 "type" : "array",
30424 "items" : {
30425 "$ref" : "#/components/schemas/AlbumsUpdateOperation_Payload_Data_Relationships_Genres_Data"
30426 }
30427 }
30428 }
30429 },
30430 "AlbumsUpdateOperation_Payload_Data_Relationships_Genres_Data" : {
30431 "required" : [ "id", "type" ],
30432 "type" : "object",
30433 "properties" : {
30434 "id" : {
30435 "type" : "string"
30436 },
30437 "type" : {
30438 "type" : "string",
30439 "enum" : [ "genres" ]
30440 }
30441 }
30442 },
30443 "Albums_Attributes" : {
30444 "required" : [ "albumType", "barcodeId", "duration", "explicit", "mediaTags", "numberOfItems", "numberOfVolumes", "popularity", "title" ],
30445 "type" : "object",
30446 "properties" : {
30447 "accessType" : {
30448 "type" : "string",
30449 "description" : "Access type",
30450 "example" : "PRIVATE",
30451 "enum" : [ "PUBLIC", "UNLISTED", "PRIVATE" ]
30452 },
30453 "ai" : {
30454 "type" : "boolean",
30455 "description" : "Whether the album is AI-generated",
30456 "example" : false
30457 },
30458 "albumType" : {
30459 "type" : "string",
30460 "description" : "Album type",
30461 "enum" : [ "ALBUM", "EP", "SINGLE" ]
30462 },
30463 "availability" : {
30464 "type" : "array",
30465 "description" : "Available usage for this album. Deprecated: use 'usageRules' instead. This field will be removed in a future version.",
30466 "deprecated" : true,
30467 "items" : {
30468 "type" : "string",
30469 "deprecated" : true,
30470 "enum" : [ "STREAM", "DJ", "STEM" ]
30471 }
30472 },
30473 "barcodeId" : {
30474 "type" : "string"
30475 },
30476 "copyright" : {
30477 "$ref" : "#/components/schemas/Copyright"
30478 },
30479 "createdAt" : {
30480 "type" : "string",
30481 "description" : "Datetime of album creation (ISO 8601)",
30482 "format" : "date-time"
30483 },
30484 "duration" : {
30485 "type" : "string",
30486 "description" : "Duration (ISO 8601)",
30487 "example" : "PT46M17S"
30488 },
30489 "explicit" : {
30490 "type" : "boolean",
30491 "description" : "Explicit content",
30492 "example" : true
30493 },
30494 "externalLinks" : {
30495 "type" : "array",
30496 "description" : "Album links external to TIDAL API",
30497 "items" : {
30498 "$ref" : "#/components/schemas/External_Link"
30499 }
30500 },
30501 "mediaTags" : {
30502 "type" : "array",
30503 "items" : {
30504 "type" : "string",
30505 "description" : "Media metadata tags",
30506 "example" : "HIRES_LOSSLESS, LOSSLESS"
30507 }
30508 },
30509 "numberOfItems" : {
30510 "type" : "integer",
30511 "description" : "Number of items in album",
30512 "format" : "int32",
30513 "example" : 13
30514 },
30515 "numberOfVolumes" : {
30516 "type" : "integer",
30517 "description" : "Number of volumes",
30518 "format" : "int32",
30519 "example" : 1
30520 },
30521 "popularity" : {
30522 "type" : "number",
30523 "description" : "Popularity (0.0 - 1.0)",
30524 "format" : "double",
30525 "example" : 0.56
30526 },
30527 "releaseDate" : {
30528 "type" : "string",
30529 "description" : "Release date (ISO-8601)",
30530 "format" : "date",
30531 "example" : "2017-06-30"
30532 },
30533 "title" : {
30534 "type" : "string",
30535 "description" : "Album title",
30536 "example" : "4:44"
30537 },
30538 "type" : {
30539 "type" : "string",
30540 "description" : "Album type. Deprecated: use 'albumType' instead. This field will be removed in a future version.",
30541 "deprecated" : true,
30542 "enum" : [ "ALBUM", "EP", "SINGLE" ]
30543 },
30544 "version" : {
30545 "type" : "string",
30546 "description" : "Album version",
30547 "example" : "remix"
30548 }
30549 }
30550 },
30551 "Albums_Create_Single_Resource_Data_Document" : {
30552 "required" : [ "data", "links" ],
30553 "type" : "object",
30554 "properties" : {
30555 "data" : {
30556 "$ref" : "#/components/schemas/Albums_Resource_Object"
30557 },
30558 "links" : {
30559 "$ref" : "#/components/schemas/Links"
30560 }
30561 }
30562 },
30563 "Albums_Items_Multi_Relationship_Data_Document" : {
30564 "required" : [ "links" ],
30565 "type" : "object",
30566 "properties" : {
30567 "data" : {
30568 "type" : "array",
30569 "items" : {
30570 "$ref" : "#/components/schemas/Albums_Items_Resource_Identifier"
30571 }
30572 },
30573 "included" : {
30574 "$ref" : "#/components/schemas/Included"
30575 },
30576 "links" : {
30577 "$ref" : "#/components/schemas/Links"
30578 }
30579 }
30580 },
30581 "Albums_Items_Resource_Identifier" : {
30582 "required" : [ "id", "type" ],
30583 "type" : "object",
30584 "properties" : {
30585 "id" : {
30586 "type" : "string",
30587 "description" : "Resource id",
30588 "example" : "12345"
30589 },
30590 "meta" : {
30591 "$ref" : "#/components/schemas/Albums_Items_Resource_Identifier_Meta"
30592 },
30593 "type" : {
30594 "type" : "string",
30595 "description" : "Resource type",
30596 "example" : "tracks"
30597 }
30598 }
30599 },
30600 "Albums_Items_Resource_Identifier_Meta" : {
30601 "required" : [ "trackNumber", "volumeNumber" ],
30602 "type" : "object",
30603 "properties" : {
30604 "itemCursor" : {
30605 "type" : "string"
30606 },
30607 "replacement" : {
30608 "$ref" : "#/components/schemas/Replacement_Provenance"
30609 },
30610 "trackNumber" : {
30611 "type" : "integer",
30612 "description" : "track number",
30613 "format" : "int32",
30614 "example" : 4
30615 },
30616 "volumeNumber" : {
30617 "type" : "integer",
30618 "description" : "volume number",
30619 "format" : "int32",
30620 "example" : 1
30621 }
30622 }
30623 },
30624 "Albums_Multi_Relationship_Data_Document" : {
30625 "required" : [ "links" ],
30626 "type" : "object",
30627 "properties" : {
30628 "data" : {
30629 "type" : "array",
30630 "items" : {
30631 "$ref" : "#/components/schemas/Resource_Identifier"
30632 }
30633 },
30634 "included" : {
30635 "$ref" : "#/components/schemas/Included"
30636 },
30637 "links" : {
30638 "$ref" : "#/components/schemas/Links"
30639 }
30640 }
30641 },
30642 "Albums_Multi_Resource_Data_Document" : {
30643 "required" : [ "data", "links" ],
30644 "type" : "object",
30645 "properties" : {
30646 "data" : {
30647 "type" : "array",
30648 "items" : {
30649 "$ref" : "#/components/schemas/Albums_Resource_Object"
30650 }
30651 },
30652 "included" : {
30653 "$ref" : "#/components/schemas/Included"
30654 },
30655 "links" : {
30656 "$ref" : "#/components/schemas/Links"
30657 }
30658 }
30659 },
30660 "Albums_Relationships" : {
30661 "properties" : {
30662 "albumStatistics" : {
30663 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
30664 },
30665 "artists" : {
30666 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
30667 },
30668 "coverArt" : {
30669 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
30670 },
30671 "genres" : {
30672 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
30673 },
30674 "items" : {
30675 "$ref" : "#/components/schemas/Albums_Items_Multi_Relationship_Data_Document"
30676 },
30677 "owners" : {
30678 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
30679 },
30680 "priceConfig" : {
30681 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
30682 },
30683 "providers" : {
30684 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
30685 },
30686 "replacement" : {
30687 "$ref" : "#/components/schemas/Albums_Replacement_Single_Relationship_Data_Document"
30688 },
30689 "shares" : {
30690 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
30691 },
30692 "similarAlbums" : {
30693 "$ref" : "#/components/schemas/Albums_SimilarAlbums_Multi_Relationship_Data_Document"
30694 },
30695 "suggestedCoverArts" : {
30696 "$ref" : "#/components/schemas/Albums_SuggestedCoverArts_Multi_Relationship_Data_Document"
30697 },
30698 "usageRules" : {
30699 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
30700 }
30701 }
30702 },
30703 "Albums_Replacement_Resource_Identifier" : {
30704 "required" : [ "id", "type" ],
30705 "type" : "object",
30706 "properties" : {
30707 "id" : {
30708 "type" : "string",
30709 "description" : "Resource id",
30710 "example" : "12345"
30711 },
30712 "meta" : {
30713 "$ref" : "#/components/schemas/Albums_Replacement_Resource_Identifier_Meta"
30714 },
30715 "type" : {
30716 "type" : "string",
30717 "description" : "Resource type",
30718 "example" : "tracks"
30719 }
30720 }
30721 },
30722 "Albums_Replacement_Resource_Identifier_Meta" : {
30723 "type" : "object",
30724 "properties" : {
30725 "replacement" : {
30726 "$ref" : "#/components/schemas/Replacement_Provenance"
30727 }
30728 }
30729 },
30730 "Albums_Replacement_Single_Relationship_Data_Document" : {
30731 "required" : [ "links" ],
30732 "type" : "object",
30733 "properties" : {
30734 "data" : {
30735 "oneOf" : [ {
30736 "$ref" : "#/components/schemas/Albums_Replacement_Resource_Identifier"
30737 }, {
30738 "type" : "object",
30739 "nullable" : true,
30740 "enum" : [ null ]
30741 } ]
30742 },
30743 "included" : {
30744 "$ref" : "#/components/schemas/Included"
30745 },
30746 "links" : {
30747 "$ref" : "#/components/schemas/Links"
30748 }
30749 }
30750 },
30751 "Albums_Resource_Object" : {
30752 "required" : [ "id", "type" ],
30753 "type" : "object",
30754 "properties" : {
30755 "attributes" : {
30756 "$ref" : "#/components/schemas/Albums_Attributes"
30757 },
30758 "id" : {
30759 "type" : "string",
30760 "description" : "Resource id",
30761 "example" : "12345"
30762 },
30763 "relationships" : {
30764 "$ref" : "#/components/schemas/Albums_Relationships"
30765 },
30766 "type" : {
30767 "minLength" : 1,
30768 "type" : "string",
30769 "description" : "Resource type",
30770 "example" : "tracks"
30771 }
30772 }
30773 },
30774 "Albums_SimilarAlbums_Multi_Relationship_Data_Document" : {
30775 "required" : [ "links" ],
30776 "type" : "object",
30777 "properties" : {
30778 "data" : {
30779 "type" : "array",
30780 "items" : {
30781 "$ref" : "#/components/schemas/Albums_SimilarAlbums_Resource_Identifier"
30782 }
30783 },
30784 "included" : {
30785 "$ref" : "#/components/schemas/Included"
30786 },
30787 "links" : {
30788 "$ref" : "#/components/schemas/Links"
30789 }
30790 }
30791 },
30792 "Albums_SimilarAlbums_Resource_Identifier" : {
30793 "required" : [ "id", "type" ],
30794 "type" : "object",
30795 "properties" : {
30796 "id" : {
30797 "type" : "string",
30798 "description" : "Resource id",
30799 "example" : "12345"
30800 },
30801 "meta" : {
30802 "$ref" : "#/components/schemas/Albums_SimilarAlbums_Resource_Identifier_Meta"
30803 },
30804 "type" : {
30805 "type" : "string",
30806 "description" : "Resource type",
30807 "example" : "tracks"
30808 }
30809 }
30810 },
30811 "Albums_SimilarAlbums_Resource_Identifier_Meta" : {
30812 "type" : "object",
30813 "properties" : {
30814 "replacement" : {
30815 "$ref" : "#/components/schemas/Replacement_Provenance"
30816 }
30817 }
30818 },
30819 "Albums_Single_Relationship_Data_Document" : {
30820 "required" : [ "links" ],
30821 "type" : "object",
30822 "properties" : {
30823 "data" : {
30824 "oneOf" : [ {
30825 "$ref" : "#/components/schemas/Resource_Identifier"
30826 }, {
30827 "type" : "object",
30828 "nullable" : true,
30829 "enum" : [ null ]
30830 } ]
30831 },
30832 "included" : {
30833 "$ref" : "#/components/schemas/Included"
30834 },
30835 "links" : {
30836 "$ref" : "#/components/schemas/Links"
30837 }
30838 }
30839 },
30840 "Albums_Single_Resource_Data_Document" : {
30841 "required" : [ "data", "links" ],
30842 "type" : "object",
30843 "properties" : {
30844 "data" : {
30845 "$ref" : "#/components/schemas/Albums_Resource_Object"
30846 },
30847 "included" : {
30848 "$ref" : "#/components/schemas/Included"
30849 },
30850 "links" : {
30851 "$ref" : "#/components/schemas/Links"
30852 }
30853 }
30854 },
30855 "Albums_SuggestedCoverArts_Multi_Relationship_Data_Document" : {
30856 "required" : [ "links" ],
30857 "type" : "object",
30858 "properties" : {
30859 "data" : {
30860 "type" : "array",
30861 "items" : {
30862 "$ref" : "#/components/schemas/Albums_SuggestedCoverArts_Resource_Identifier"
30863 }
30864 },
30865 "included" : {
30866 "$ref" : "#/components/schemas/Included"
30867 },
30868 "links" : {
30869 "$ref" : "#/components/schemas/Links"
30870 },
30871 "meta" : {
30872 "$ref" : "#/components/schemas/Albums_SuggestedCoverArts_Multi_Relationship_Data_Document_Meta"
30873 }
30874 }
30875 },
30876 "Albums_SuggestedCoverArts_Multi_Relationship_Data_Document_Meta" : {
30877 "type" : "object",
30878 "properties" : {
30879 "status" : {
30880 "type" : "string",
30881 "enum" : [ "PENDING", "PROCESSING", "ERROR", "OK" ]
30882 }
30883 }
30884 },
30885 "Albums_SuggestedCoverArts_Resource_Identifier" : {
30886 "required" : [ "id", "type" ],
30887 "type" : "object",
30888 "properties" : {
30889 "id" : {
30890 "type" : "string",
30891 "description" : "Resource id",
30892 "example" : "12345"
30893 },
30894 "meta" : {
30895 "$ref" : "#/components/schemas/Albums_SuggestedCoverArts_Resource_Identifier_Meta"
30896 },
30897 "type" : {
30898 "type" : "string",
30899 "description" : "Resource type",
30900 "example" : "tracks"
30901 }
30902 }
30903 },
30904 "Albums_SuggestedCoverArts_Resource_Identifier_Meta" : {
30905 "required" : [ "backgroundColor", "foregroundColor" ],
30906 "type" : "object",
30907 "properties" : {
30908 "backgroundColor" : {
30909 "type" : "string",
30910 "description" : "Background color for the suggested artwork"
30911 },
30912 "foregroundColor" : {
30913 "type" : "string",
30914 "description" : "Foreground color for the suggested artwork"
30915 }
30916 }
30917 },
30918 "AppreciationsCreateOperation_Payload" : {
30919 "required" : [ "data" ],
30920 "type" : "object",
30921 "properties" : {
30922 "data" : {
30923 "$ref" : "#/components/schemas/AppreciationsCreateOperation_Payload_Data"
30924 },
30925 "meta" : {
30926 "$ref" : "#/components/schemas/AppreciationsCreateOperation_Payload_Meta"
30927 }
30928 }
30929 },
30930 "AppreciationsCreateOperation_Payload_Data" : {
30931 "required" : [ "relationships", "type" ],
30932 "type" : "object",
30933 "properties" : {
30934 "relationships" : {
30935 "$ref" : "#/components/schemas/AppreciationsCreateOperation_Payload_Data_Relationships"
30936 },
30937 "type" : {
30938 "type" : "string",
30939 "enum" : [ "appreciations" ]
30940 }
30941 }
30942 },
30943 "AppreciationsCreateOperation_Payload_Data_Relationships" : {
30944 "required" : [ "appreciatedItems" ],
30945 "type" : "object",
30946 "properties" : {
30947 "appreciatedItems" : {
30948 "$ref" : "#/components/schemas/AppreciationsCreateOperation_Payload_Data_Relationships_AppreciatedItem"
30949 }
30950 }
30951 },
30952 "AppreciationsCreateOperation_Payload_Data_Relationships_AppreciatedItem" : {
30953 "required" : [ "data" ],
30954 "type" : "object",
30955 "properties" : {
30956 "data" : {
30957 "maxItems" : 1,
30958 "minItems" : 1,
30959 "type" : "array",
30960 "items" : {
30961 "$ref" : "#/components/schemas/AppreciationsCreateOperation_Payload_Data_Relationships_AppreciatedItem_Data"
30962 }
30963 }
30964 }
30965 },
30966 "AppreciationsCreateOperation_Payload_Data_Relationships_AppreciatedItem_Data" : {
30967 "required" : [ "id", "type" ],
30968 "type" : "object",
30969 "properties" : {
30970 "id" : {
30971 "type" : "string"
30972 },
30973 "type" : {
30974 "type" : "string",
30975 "enum" : [ "artists" ]
30976 }
30977 }
30978 },
30979 "AppreciationsCreateOperation_Payload_Meta" : {
30980 "type" : "object",
30981 "properties" : {
30982 "dryRun" : {
30983 "type" : "boolean"
30984 }
30985 }
30986 },
30987 "Appreciations_Attributes" : {
30988 "required" : [ "createdAt" ],
30989 "type" : "object",
30990 "properties" : {
30991 "createdAt" : {
30992 "type" : "string",
30993 "description" : "Time when the appreciation was created",
30994 "format" : "date-time",
30995 "example" : "2025-09-09T13:07:35.734Z"
30996 }
30997 }
30998 },
30999 "Appreciations_Create_Single_Resource_Data_Document" : {
31000 "required" : [ "data", "links" ],
31001 "type" : "object",
31002 "properties" : {
31003 "data" : {
31004 "$ref" : "#/components/schemas/Appreciations_Resource_Object"
31005 },
31006 "links" : {
31007 "$ref" : "#/components/schemas/Links"
31008 }
31009 }
31010 },
31011 "Appreciations_Resource_Object" : {
31012 "required" : [ "id", "type" ],
31013 "type" : "object",
31014 "properties" : {
31015 "attributes" : {
31016 "$ref" : "#/components/schemas/Appreciations_Attributes"
31017 },
31018 "id" : {
31019 "type" : "string",
31020 "description" : "Resource id",
31021 "example" : "12345"
31022 },
31023 "type" : {
31024 "minLength" : 1,
31025 "type" : "string",
31026 "description" : "Resource type",
31027 "example" : "tracks"
31028 }
31029 }
31030 },
31031 "ArtistBiographiesUpdateOperation_Payload" : {
31032 "required" : [ "data" ],
31033 "type" : "object",
31034 "properties" : {
31035 "data" : {
31036 "$ref" : "#/components/schemas/ArtistBiographiesUpdateOperation_Payload_Data"
31037 }
31038 }
31039 },
31040 "ArtistBiographiesUpdateOperation_Payload_Data" : {
31041 "required" : [ "attributes", "id", "type" ],
31042 "type" : "object",
31043 "properties" : {
31044 "attributes" : {
31045 "$ref" : "#/components/schemas/ArtistBiographiesUpdateOperation_Payload_Data_Attributes"
31046 },
31047 "id" : {
31048 "type" : "string"
31049 },
31050 "type" : {
31051 "type" : "string",
31052 "enum" : [ "artistBiographies" ]
31053 }
31054 }
31055 },
31056 "ArtistBiographiesUpdateOperation_Payload_Data_Attributes" : {
31057 "type" : "object",
31058 "properties" : {
31059 "text" : {
31060 "type" : "string"
31061 }
31062 }
31063 },
31064 "ArtistBiographies_Attributes" : {
31065 "required" : [ "editable", "text" ],
31066 "type" : "object",
31067 "properties" : {
31068 "editable" : {
31069 "type" : "boolean",
31070 "description" : "Boolean to indicate if the biography is editable (source = tidal or artist)",
31071 "example" : true
31072 },
31073 "source" : {
31074 "type" : "string",
31075 "description" : "Source the biography is coming from",
31076 "example" : "ARTIST",
31077 "enum" : [ "TIDAL", "TiVo", "MusicBrainz", "Avex", "Artist", "UNKNOWN" ]
31078 },
31079 "text" : {
31080 "type" : "string",
31081 "description" : "Artist biography",
31082 "example" : "Once upon a time an artist is born"
31083 }
31084 }
31085 },
31086 "ArtistBiographies_Multi_Relationship_Data_Document" : {
31087 "required" : [ "links" ],
31088 "type" : "object",
31089 "properties" : {
31090 "data" : {
31091 "type" : "array",
31092 "items" : {
31093 "$ref" : "#/components/schemas/Resource_Identifier"
31094 }
31095 },
31096 "included" : {
31097 "$ref" : "#/components/schemas/Included"
31098 },
31099 "links" : {
31100 "$ref" : "#/components/schemas/Links"
31101 }
31102 }
31103 },
31104 "ArtistBiographies_Relationships" : {
31105 "properties" : {
31106 "owners" : {
31107 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
31108 }
31109 }
31110 },
31111 "ArtistBiographies_Resource_Object" : {
31112 "required" : [ "id", "type" ],
31113 "type" : "object",
31114 "properties" : {
31115 "attributes" : {
31116 "$ref" : "#/components/schemas/ArtistBiographies_Attributes"
31117 },
31118 "id" : {
31119 "type" : "string",
31120 "description" : "Resource id",
31121 "example" : "12345"
31122 },
31123 "relationships" : {
31124 "$ref" : "#/components/schemas/ArtistBiographies_Relationships"
31125 },
31126 "type" : {
31127 "minLength" : 1,
31128 "type" : "string",
31129 "description" : "Resource type",
31130 "example" : "tracks"
31131 }
31132 }
31133 },
31134 "ArtistBiographies_Single_Resource_Data_Document" : {
31135 "required" : [ "data", "links" ],
31136 "type" : "object",
31137 "properties" : {
31138 "data" : {
31139 "$ref" : "#/components/schemas/ArtistBiographies_Resource_Object"
31140 },
31141 "included" : {
31142 "$ref" : "#/components/schemas/Included"
31143 },
31144 "links" : {
31145 "$ref" : "#/components/schemas/Links"
31146 }
31147 }
31148 },
31149 "ArtistClaimStatuses_Attributes" : {
31150 "required" : [ "claimSources", "status" ],
31151 "type" : "object",
31152 "properties" : {
31153 "claimSources" : {
31154 "type" : "array",
31155 "description" : "Claim sources contributing to the current status. Empty when there is no active claim.",
31156 "items" : {
31157 "type" : "string",
31158 "enum" : [ "ARTIST_CLAIMS", "MANUAL_ARTIST_CLAIMS" ]
31159 }
31160 },
31161 "status" : {
31162 "type" : "string",
31163 "description" : "Whether the artist profile currently has an active claim",
31164 "enum" : [ "CLAIM_IN_PROGRESS", "NO_ACTIVE_CLAIM" ]
31165 }
31166 }
31167 },
31168 "ArtistClaimStatuses_Multi_Resource_Data_Document" : {
31169 "required" : [ "data", "links" ],
31170 "type" : "object",
31171 "properties" : {
31172 "data" : {
31173 "type" : "array",
31174 "items" : {
31175 "$ref" : "#/components/schemas/ArtistClaimStatuses_Resource_Object"
31176 }
31177 },
31178 "included" : {
31179 "$ref" : "#/components/schemas/Included"
31180 },
31181 "links" : {
31182 "$ref" : "#/components/schemas/Links"
31183 }
31184 }
31185 },
31186 "ArtistClaimStatuses_Resource_Object" : {
31187 "required" : [ "id", "type" ],
31188 "type" : "object",
31189 "properties" : {
31190 "attributes" : {
31191 "$ref" : "#/components/schemas/ArtistClaimStatuses_Attributes"
31192 },
31193 "id" : {
31194 "type" : "string",
31195 "description" : "Resource id",
31196 "example" : "12345"
31197 },
31198 "type" : {
31199 "minLength" : 1,
31200 "type" : "string",
31201 "description" : "Resource type",
31202 "example" : "tracks"
31203 }
31204 }
31205 },
31206 "ArtistClaimsAcceptedArtistsRelationshipUpdateOperation_Payload" : {
31207 "required" : [ "data" ],
31208 "type" : "object",
31209 "properties" : {
31210 "data" : {
31211 "maxItems" : 1,
31212 "minItems" : 0,
31213 "type" : "array",
31214 "items" : {
31215 "$ref" : "#/components/schemas/ArtistClaimsAcceptedArtistsRelationshipUpdateOperation_Payload_Data"
31216 }
31217 }
31218 }
31219 },
31220 "ArtistClaimsAcceptedArtistsRelationshipUpdateOperation_Payload_Data" : {
31221 "required" : [ "id", "type" ],
31222 "type" : "object",
31223 "properties" : {
31224 "id" : {
31225 "type" : "string"
31226 },
31227 "type" : {
31228 "type" : "string",
31229 "enum" : [ "artists" ]
31230 }
31231 }
31232 },
31233 "ArtistClaimsCreateOperation_Payload" : {
31234 "required" : [ "data", "meta" ],
31235 "type" : "object",
31236 "properties" : {
31237 "data" : {
31238 "$ref" : "#/components/schemas/ArtistClaimsCreateOperation_Payload_Data"
31239 },
31240 "meta" : {
31241 "$ref" : "#/components/schemas/ArtistClaimsCreateOperation_Payload_Meta"
31242 }
31243 }
31244 },
31245 "ArtistClaimsCreateOperation_Payload_Data" : {
31246 "required" : [ "attributes", "type" ],
31247 "type" : "object",
31248 "properties" : {
31249 "attributes" : {
31250 "$ref" : "#/components/schemas/ArtistClaimsCreateOperation_Payload_Data_Attributes"
31251 },
31252 "type" : {
31253 "type" : "string",
31254 "enum" : [ "artistClaims" ]
31255 }
31256 }
31257 },
31258 "ArtistClaimsCreateOperation_Payload_Data_Attributes" : {
31259 "required" : [ "artistId", "provider" ],
31260 "type" : "object",
31261 "properties" : {
31262 "artistId" : {
31263 "type" : "string"
31264 },
31265 "provider" : {
31266 "type" : "string",
31267 "enum" : [ "DISTROKID", "CDBABY", "TUNECORE" ]
31268 }
31269 }
31270 },
31271 "ArtistClaimsCreateOperation_Payload_Meta" : {
31272 "required" : [ "redirectUrl" ],
31273 "type" : "object",
31274 "properties" : {
31275 "nonce" : {
31276 "type" : "string"
31277 },
31278 "redirectUrl" : {
31279 "type" : "string"
31280 }
31281 }
31282 },
31283 "ArtistClaimsUpdateOperation_Payload" : {
31284 "required" : [ "meta" ],
31285 "type" : "object",
31286 "properties" : {
31287 "data" : {
31288 "$ref" : "#/components/schemas/ArtistClaimsUpdateOperation_Payload_Data"
31289 },
31290 "meta" : {
31291 "$ref" : "#/components/schemas/ArtistClaimsUpdateOperation_Payload_Meta"
31292 }
31293 }
31294 },
31295 "ArtistClaimsUpdateOperation_Payload_Data" : {
31296 "required" : [ "type" ],
31297 "type" : "object",
31298 "properties" : {
31299 "attributes" : {
31300 "$ref" : "#/components/schemas/ArtistClaimsUpdateOperation_Payload_Data_Attributes"
31301 },
31302 "id" : {
31303 "type" : "string"
31304 },
31305 "type" : {
31306 "type" : "string",
31307 "enum" : [ "artistClaims" ]
31308 }
31309 }
31310 },
31311 "ArtistClaimsUpdateOperation_Payload_Data_Attributes" : {
31312 "type" : "object"
31313 },
31314 "ArtistClaimsUpdateOperation_Payload_Meta" : {
31315 "required" : [ "authorizationCode", "redirectUri" ],
31316 "type" : "object",
31317 "properties" : {
31318 "authorizationCode" : {
31319 "type" : "string"
31320 },
31321 "redirectUri" : {
31322 "type" : "string"
31323 }
31324 }
31325 },
31326 "ArtistClaims_Attributes" : {
31327 "required" : [ "artistId", "provider", "status" ],
31328 "type" : "object",
31329 "properties" : {
31330 "artistId" : {
31331 "type" : "string",
31332 "description" : "The artist id which is being claimed"
31333 },
31334 "externalLinks" : {
31335 "type" : "array",
31336 "description" : "Artist claim links external to TIDAL API",
31337 "items" : {
31338 "$ref" : "#/components/schemas/External_Link"
31339 }
31340 },
31341 "provider" : {
31342 "minLength" : 1,
31343 "type" : "string",
31344 "description" : "The DSP used for authentication",
31345 "enum" : [ "DISTROKID", "CDBABY", "TUNECORE" ]
31346 },
31347 "recommendation" : {
31348 "type" : "string",
31349 "description" : "The recommended claim resolution",
31350 "enum" : [ "CLAIM_PROFILE", "CLAIM_CONTENT" ]
31351 },
31352 "retrievedUpcs" : {
31353 "type" : "array",
31354 "description" : "List of UPCs retrieved from the DSP",
31355 "items" : {
31356 "$ref" : "#/components/schemas/LegacyBarcodeId"
31357 }
31358 },
31359 "status" : {
31360 "minLength" : 1,
31361 "type" : "string",
31362 "description" : "Current status of this claim",
31363 "enum" : [ "AWAITING_OAUTH", "FETCHING_CONTENT", "VERIFIED", "NO_MATCHES", "AUTHENTICATION_FAILED", "PROCESSING", "COMPLETED", "FAILED", "CANCELLED", "NAME_MISMATCH", "CLAIMED_ARTIST_MISMATCH" ]
31364 }
31365 }
31366 },
31367 "ArtistClaims_Create_Single_Resource_Data_Document" : {
31368 "required" : [ "data", "links" ],
31369 "type" : "object",
31370 "properties" : {
31371 "data" : {
31372 "$ref" : "#/components/schemas/ArtistClaims_Resource_Object"
31373 },
31374 "links" : {
31375 "$ref" : "#/components/schemas/Links"
31376 }
31377 }
31378 },
31379 "ArtistClaims_Multi_Relationship_Data_Document" : {
31380 "required" : [ "links" ],
31381 "type" : "object",
31382 "properties" : {
31383 "data" : {
31384 "type" : "array",
31385 "items" : {
31386 "$ref" : "#/components/schemas/Resource_Identifier"
31387 }
31388 },
31389 "included" : {
31390 "$ref" : "#/components/schemas/Included"
31391 },
31392 "links" : {
31393 "$ref" : "#/components/schemas/Links"
31394 }
31395 }
31396 },
31397 "ArtistClaims_Multi_Resource_Data_Document" : {
31398 "required" : [ "data", "links" ],
31399 "type" : "object",
31400 "properties" : {
31401 "data" : {
31402 "type" : "array",
31403 "items" : {
31404 "$ref" : "#/components/schemas/ArtistClaims_Resource_Object"
31405 }
31406 },
31407 "included" : {
31408 "$ref" : "#/components/schemas/Included"
31409 },
31410 "links" : {
31411 "$ref" : "#/components/schemas/Links"
31412 }
31413 }
31414 },
31415 "ArtistClaims_Relationships" : {
31416 "properties" : {
31417 "acceptedArtists" : {
31418 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
31419 },
31420 "owners" : {
31421 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
31422 },
31423 "recommendedArtists" : {
31424 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
31425 }
31426 }
31427 },
31428 "ArtistClaims_Resource_Object" : {
31429 "required" : [ "id", "type" ],
31430 "type" : "object",
31431 "properties" : {
31432 "attributes" : {
31433 "$ref" : "#/components/schemas/ArtistClaims_Attributes"
31434 },
31435 "id" : {
31436 "type" : "string",
31437 "description" : "Resource id",
31438 "example" : "12345"
31439 },
31440 "relationships" : {
31441 "$ref" : "#/components/schemas/ArtistClaims_Relationships"
31442 },
31443 "type" : {
31444 "minLength" : 1,
31445 "type" : "string",
31446 "description" : "Resource type",
31447 "example" : "tracks"
31448 }
31449 }
31450 },
31451 "ArtistClaims_Single_Resource_Data_Document" : {
31452 "required" : [ "data", "links" ],
31453 "type" : "object",
31454 "properties" : {
31455 "data" : {
31456 "$ref" : "#/components/schemas/ArtistClaims_Resource_Object"
31457 },
31458 "included" : {
31459 "$ref" : "#/components/schemas/Included"
31460 },
31461 "links" : {
31462 "$ref" : "#/components/schemas/Links"
31463 }
31464 }
31465 },
31466 "ArtistRoles_Attributes" : {
31467 "required" : [ "name" ],
31468 "type" : "object",
31469 "properties" : {
31470 "name" : {
31471 "type" : "string",
31472 "description" : "Name of the artist role"
31473 }
31474 }
31475 },
31476 "ArtistRoles_Resource_Object" : {
31477 "required" : [ "id", "type" ],
31478 "type" : "object",
31479 "properties" : {
31480 "attributes" : {
31481 "$ref" : "#/components/schemas/ArtistRoles_Attributes"
31482 },
31483 "id" : {
31484 "type" : "string",
31485 "description" : "Resource id",
31486 "example" : "12345"
31487 },
31488 "type" : {
31489 "minLength" : 1,
31490 "type" : "string",
31491 "description" : "Resource type",
31492 "example" : "tracks"
31493 }
31494 }
31495 },
31496 "ArtistRoles_Single_Resource_Data_Document" : {
31497 "required" : [ "data", "links" ],
31498 "type" : "object",
31499 "properties" : {
31500 "data" : {
31501 "$ref" : "#/components/schemas/ArtistRoles_Resource_Object"
31502 },
31503 "included" : {
31504 "$ref" : "#/components/schemas/Included"
31505 },
31506 "links" : {
31507 "$ref" : "#/components/schemas/Links"
31508 }
31509 }
31510 },
31511 "ArtistsCreateOperation_Payload" : {
31512 "required" : [ "data" ],
31513 "type" : "object",
31514 "properties" : {
31515 "data" : {
31516 "$ref" : "#/components/schemas/ArtistsCreateOperation_Payload_Data"
31517 },
31518 "meta" : {
31519 "$ref" : "#/components/schemas/ArtistsCreateOperation_Payload_Meta"
31520 }
31521 }
31522 },
31523 "ArtistsCreateOperation_Payload_Data" : {
31524 "required" : [ "attributes", "type" ],
31525 "type" : "object",
31526 "properties" : {
31527 "attributes" : {
31528 "$ref" : "#/components/schemas/ArtistsCreateOperation_Payload_Data_Attributes"
31529 },
31530 "type" : {
31531 "type" : "string",
31532 "enum" : [ "artists" ]
31533 }
31534 }
31535 },
31536 "ArtistsCreateOperation_Payload_Data_Attributes" : {
31537 "required" : [ "name" ],
31538 "type" : "object",
31539 "properties" : {
31540 "handle" : {
31541 "type" : "string"
31542 },
31543 "name" : {
31544 "minLength" : 1,
31545 "type" : "string"
31546 }
31547 }
31548 },
31549 "ArtistsCreateOperation_Payload_Meta" : {
31550 "type" : "object",
31551 "properties" : {
31552 "dryRun" : {
31553 "type" : "boolean"
31554 }
31555 }
31556 },
31557 "ArtistsFollowingRelationshipAddOperation_Payload" : {
31558 "required" : [ "data" ],
31559 "type" : "object",
31560 "properties" : {
31561 "data" : {
31562 "maxItems" : 1,
31563 "minItems" : 0,
31564 "type" : "array",
31565 "items" : {
31566 "$ref" : "#/components/schemas/ArtistsFollowingRelationshipAddOperation_Payload_Data"
31567 }
31568 }
31569 }
31570 },
31571 "ArtistsFollowingRelationshipAddOperation_Payload_Data" : {
31572 "required" : [ "id", "type" ],
31573 "type" : "object",
31574 "properties" : {
31575 "id" : {
31576 "type" : "string"
31577 },
31578 "type" : {
31579 "type" : "string",
31580 "enum" : [ "artists" ]
31581 }
31582 }
31583 },
31584 "ArtistsFollowingRelationshipRemoveOperation_Payload" : {
31585 "required" : [ "data" ],
31586 "type" : "object",
31587 "properties" : {
31588 "data" : {
31589 "maxItems" : 1,
31590 "minItems" : 0,
31591 "type" : "array",
31592 "items" : {
31593 "$ref" : "#/components/schemas/ArtistsFollowingRelationshipRemoveOperation_Payload_Data"
31594 }
31595 }
31596 }
31597 },
31598 "ArtistsFollowingRelationshipRemoveOperation_Payload_Data" : {
31599 "required" : [ "id", "type" ],
31600 "type" : "object",
31601 "properties" : {
31602 "id" : {
31603 "type" : "string"
31604 },
31605 "type" : {
31606 "type" : "string",
31607 "enum" : [ "artists" ]
31608 }
31609 }
31610 },
31611 "ArtistsProfileArtRelationshipUpdateOperation_Payload" : {
31612 "required" : [ "data" ],
31613 "type" : "object",
31614 "properties" : {
31615 "data" : {
31616 "maxItems" : 1,
31617 "minItems" : 0,
31618 "type" : "array",
31619 "items" : {
31620 "$ref" : "#/components/schemas/ArtistsProfileArtRelationshipUpdateOperation_Payload_Data"
31621 }
31622 }
31623 }
31624 },
31625 "ArtistsProfileArtRelationshipUpdateOperation_Payload_Data" : {
31626 "required" : [ "id", "type" ],
31627 "type" : "object",
31628 "properties" : {
31629 "id" : {
31630 "type" : "string"
31631 },
31632 "type" : {
31633 "type" : "string",
31634 "enum" : [ "artworks" ]
31635 }
31636 }
31637 },
31638 "ArtistsUpdateOperation_Payload" : {
31639 "required" : [ "data" ],
31640 "type" : "object",
31641 "properties" : {
31642 "data" : {
31643 "$ref" : "#/components/schemas/ArtistsUpdateOperation_Payload_Data"
31644 },
31645 "meta" : {
31646 "$ref" : "#/components/schemas/ArtistsUpdateOperation_Payload_Meta"
31647 }
31648 }
31649 },
31650 "ArtistsUpdateOperation_Payload_Data" : {
31651 "required" : [ "attributes", "id", "type" ],
31652 "type" : "object",
31653 "properties" : {
31654 "attributes" : {
31655 "$ref" : "#/components/schemas/ArtistsUpdateOperation_Payload_Data_Attributes"
31656 },
31657 "id" : {
31658 "type" : "string"
31659 },
31660 "type" : {
31661 "type" : "string",
31662 "enum" : [ "artists" ]
31663 }
31664 }
31665 },
31666 "ArtistsUpdateOperation_Payload_Data_Attributes" : {
31667 "type" : "object",
31668 "properties" : {
31669 "contributionsEnabled" : {
31670 "type" : "boolean"
31671 },
31672 "contributionsSalesPitch" : {
31673 "type" : "string"
31674 },
31675 "externalLinks" : {
31676 "type" : "array",
31677 "items" : {
31678 "$ref" : "#/components/schemas/External_Link_Payload"
31679 }
31680 },
31681 "handle" : {
31682 "oneOf" : [ {
31683 "type" : "string"
31684 }, {
31685 "type" : "object",
31686 "nullable" : true,
31687 "enum" : [ null ]
31688 } ]
31689 },
31690 "name" : {
31691 "minLength" : 1,
31692 "type" : "string"
31693 }
31694 }
31695 },
31696 "ArtistsUpdateOperation_Payload_Meta" : {
31697 "type" : "object",
31698 "properties" : {
31699 "dryRun" : {
31700 "type" : "boolean"
31701 }
31702 }
31703 },
31704 "Artists_Albums_Multi_Relationship_Data_Document" : {
31705 "required" : [ "links" ],
31706 "type" : "object",
31707 "properties" : {
31708 "data" : {
31709 "type" : "array",
31710 "items" : {
31711 "$ref" : "#/components/schemas/Artists_Albums_Resource_Identifier"
31712 }
31713 },
31714 "included" : {
31715 "$ref" : "#/components/schemas/Included"
31716 },
31717 "links" : {
31718 "$ref" : "#/components/schemas/Links"
31719 }
31720 }
31721 },
31722 "Artists_Albums_Resource_Identifier" : {
31723 "required" : [ "id", "type" ],
31724 "type" : "object",
31725 "properties" : {
31726 "id" : {
31727 "type" : "string",
31728 "description" : "Resource id",
31729 "example" : "12345"
31730 },
31731 "meta" : {
31732 "$ref" : "#/components/schemas/Artists_Albums_Resource_Identifier_Meta"
31733 },
31734 "type" : {
31735 "type" : "string",
31736 "description" : "Resource type",
31737 "example" : "tracks"
31738 }
31739 }
31740 },
31741 "Artists_Albums_Resource_Identifier_Meta" : {
31742 "type" : "object",
31743 "properties" : {
31744 "replacement" : {
31745 "$ref" : "#/components/schemas/Replacement_Provenance"
31746 }
31747 }
31748 },
31749 "Artists_Attributes" : {
31750 "required" : [ "name", "popularity" ],
31751 "type" : "object",
31752 "properties" : {
31753 "contributionsEnabled" : {
31754 "type" : "boolean",
31755 "description" : "Is the artist enabled for contributions?",
31756 "example" : true
31757 },
31758 "contributionsSalesPitch" : {
31759 "type" : "string",
31760 "description" : "Contributions sales pitch",
31761 "example" : "Help me be a full time artist"
31762 },
31763 "externalLinks" : {
31764 "type" : "array",
31765 "description" : "Artist links external to TIDAL API",
31766 "items" : {
31767 "$ref" : "#/components/schemas/External_Link"
31768 }
31769 },
31770 "handle" : {
31771 "type" : "string",
31772 "description" : "Artist handle",
31773 "example" : "jayz"
31774 },
31775 "name" : {
31776 "type" : "string",
31777 "description" : "Artist name",
31778 "example" : "JAY Z"
31779 },
31780 "ownerType" : {
31781 "type" : "string",
31782 "description" : "Ownership type of the artist profile. LABEL: label-managed profile, USER: user-created profile, MIXED: claimed profile with both label and user content. May be null during rollout/backfill.",
31783 "enum" : [ "LABEL", "USER", "MIXED" ]
31784 },
31785 "popularity" : {
31786 "type" : "number",
31787 "description" : "Artist popularity (0.0 - 1.0)",
31788 "format" : "double",
31789 "example" : 0.56
31790 },
31791 "spotlighted" : {
31792 "type" : "boolean",
31793 "description" : "Is the artist spotlighted?",
31794 "example" : true
31795 }
31796 }
31797 },
31798 "Artists_Create_Single_Resource_Data_Document" : {
31799 "required" : [ "data", "links" ],
31800 "type" : "object",
31801 "properties" : {
31802 "data" : {
31803 "$ref" : "#/components/schemas/Artists_Resource_Object"
31804 },
31805 "links" : {
31806 "$ref" : "#/components/schemas/Links"
31807 }
31808 }
31809 },
31810 "Artists_Followers_Multi_Relationship_Data_Document" : {
31811 "required" : [ "links" ],
31812 "type" : "object",
31813 "properties" : {
31814 "data" : {
31815 "type" : "array",
31816 "items" : {
31817 "$ref" : "#/components/schemas/Artists_Followers_Resource_Identifier"
31818 }
31819 },
31820 "included" : {
31821 "$ref" : "#/components/schemas/Included"
31822 },
31823 "links" : {
31824 "$ref" : "#/components/schemas/Links"
31825 }
31826 }
31827 },
31828 "Artists_Followers_Resource_Identifier" : {
31829 "required" : [ "id", "type" ],
31830 "type" : "object",
31831 "properties" : {
31832 "id" : {
31833 "type" : "string",
31834 "description" : "Resource id",
31835 "example" : "12345"
31836 },
31837 "meta" : {
31838 "$ref" : "#/components/schemas/Artists_Followers_Resource_Identifier_Meta"
31839 },
31840 "type" : {
31841 "type" : "string",
31842 "description" : "Resource type",
31843 "example" : "tracks"
31844 }
31845 }
31846 },
31847 "Artists_Followers_Resource_Identifier_Meta" : {
31848 "type" : "object",
31849 "properties" : {
31850 "viewer" : {
31851 "$ref" : "#/components/schemas/Artists_Followers_Resource_Meta_ViewerContext"
31852 }
31853 }
31854 },
31855 "Artists_Followers_Resource_Meta_ViewerContext" : {
31856 "type" : "object",
31857 "properties" : {
31858 "followsMyArtist" : {
31859 "type" : "boolean",
31860 "description" : "Boolean to indicate if the artist is following my artist",
31861 "default" : false
31862 },
31863 "myArtistFollows" : {
31864 "type" : "boolean",
31865 "description" : "Boolean to indicate if my artist is following the artist",
31866 "default" : false
31867 }
31868 },
31869 "description" : "Optional context about the relationship"
31870 },
31871 "Artists_Following_Multi_Relationship_Data_Document" : {
31872 "required" : [ "links" ],
31873 "type" : "object",
31874 "properties" : {
31875 "data" : {
31876 "type" : "array",
31877 "items" : {
31878 "$ref" : "#/components/schemas/Artists_Following_Resource_Identifier"
31879 }
31880 },
31881 "included" : {
31882 "$ref" : "#/components/schemas/Included"
31883 },
31884 "links" : {
31885 "$ref" : "#/components/schemas/Links"
31886 }
31887 }
31888 },
31889 "Artists_Following_Resource_Identifier" : {
31890 "required" : [ "id", "type" ],
31891 "type" : "object",
31892 "properties" : {
31893 "id" : {
31894 "type" : "string",
31895 "description" : "Resource id",
31896 "example" : "12345"
31897 },
31898 "meta" : {
31899 "$ref" : "#/components/schemas/Artists_Following_Resource_Identifier_Meta"
31900 },
31901 "type" : {
31902 "type" : "string",
31903 "description" : "Resource type",
31904 "example" : "tracks"
31905 }
31906 }
31907 },
31908 "Artists_Following_Resource_Identifier_Meta" : {
31909 "type" : "object",
31910 "properties" : {
31911 "viewer" : {
31912 "$ref" : "#/components/schemas/Artists_Followers_Resource_Meta_ViewerContext"
31913 }
31914 }
31915 },
31916 "Artists_Multi_Relationship_Data_Document" : {
31917 "required" : [ "links" ],
31918 "type" : "object",
31919 "properties" : {
31920 "data" : {
31921 "type" : "array",
31922 "items" : {
31923 "$ref" : "#/components/schemas/Resource_Identifier"
31924 }
31925 },
31926 "included" : {
31927 "$ref" : "#/components/schemas/Included"
31928 },
31929 "links" : {
31930 "$ref" : "#/components/schemas/Links"
31931 }
31932 }
31933 },
31934 "Artists_Multi_Resource_Data_Document" : {
31935 "required" : [ "data", "links" ],
31936 "type" : "object",
31937 "properties" : {
31938 "data" : {
31939 "type" : "array",
31940 "items" : {
31941 "$ref" : "#/components/schemas/Artists_Resource_Object"
31942 }
31943 },
31944 "included" : {
31945 "$ref" : "#/components/schemas/Included"
31946 },
31947 "links" : {
31948 "$ref" : "#/components/schemas/Links"
31949 }
31950 }
31951 },
31952 "Artists_Relationships" : {
31953 "properties" : {
31954 "albums" : {
31955 "$ref" : "#/components/schemas/Artists_Albums_Multi_Relationship_Data_Document"
31956 },
31957 "biography" : {
31958 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
31959 },
31960 "claimStatus" : {
31961 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
31962 },
31963 "followers" : {
31964 "$ref" : "#/components/schemas/Artists_Followers_Multi_Relationship_Data_Document"
31965 },
31966 "following" : {
31967 "$ref" : "#/components/schemas/Artists_Following_Multi_Relationship_Data_Document"
31968 },
31969 "owners" : {
31970 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
31971 },
31972 "profileArt" : {
31973 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
31974 },
31975 "radio" : {
31976 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
31977 },
31978 "roles" : {
31979 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
31980 },
31981 "similarArtists" : {
31982 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
31983 },
31984 "trackProviders" : {
31985 "$ref" : "#/components/schemas/Artists_TrackProviders_Multi_Relationship_Data_Document"
31986 },
31987 "tracks" : {
31988 "$ref" : "#/components/schemas/Artists_Tracks_Multi_Relationship_Data_Document"
31989 },
31990 "videos" : {
31991 "$ref" : "#/components/schemas/Artists_Videos_Multi_Relationship_Data_Document"
31992 }
31993 }
31994 },
31995 "Artists_Resource_Object" : {
31996 "required" : [ "id", "type" ],
31997 "type" : "object",
31998 "properties" : {
31999 "attributes" : {
32000 "$ref" : "#/components/schemas/Artists_Attributes"
32001 },
32002 "id" : {
32003 "type" : "string",
32004 "description" : "Resource id",
32005 "example" : "12345"
32006 },
32007 "relationships" : {
32008 "$ref" : "#/components/schemas/Artists_Relationships"
32009 },
32010 "type" : {
32011 "minLength" : 1,
32012 "type" : "string",
32013 "description" : "Resource type",
32014 "example" : "tracks"
32015 }
32016 }
32017 },
32018 "Artists_Single_Relationship_Data_Document" : {
32019 "required" : [ "links" ],
32020 "type" : "object",
32021 "properties" : {
32022 "data" : {
32023 "oneOf" : [ {
32024 "$ref" : "#/components/schemas/Resource_Identifier"
32025 }, {
32026 "type" : "object",
32027 "nullable" : true,
32028 "enum" : [ null ]
32029 } ]
32030 },
32031 "included" : {
32032 "$ref" : "#/components/schemas/Included"
32033 },
32034 "links" : {
32035 "$ref" : "#/components/schemas/Links"
32036 }
32037 }
32038 },
32039 "Artists_Single_Resource_Data_Document" : {
32040 "required" : [ "data", "links" ],
32041 "type" : "object",
32042 "properties" : {
32043 "data" : {
32044 "$ref" : "#/components/schemas/Artists_Resource_Object"
32045 },
32046 "included" : {
32047 "$ref" : "#/components/schemas/Included"
32048 },
32049 "links" : {
32050 "$ref" : "#/components/schemas/Links"
32051 }
32052 }
32053 },
32054 "Artists_TrackProviders_Multi_Relationship_Data_Document" : {
32055 "required" : [ "links" ],
32056 "type" : "object",
32057 "properties" : {
32058 "data" : {
32059 "type" : "array",
32060 "items" : {
32061 "$ref" : "#/components/schemas/Artists_TrackProviders_Resource_Identifier"
32062 }
32063 },
32064 "included" : {
32065 "$ref" : "#/components/schemas/Included"
32066 },
32067 "links" : {
32068 "$ref" : "#/components/schemas/Links"
32069 }
32070 }
32071 },
32072 "Artists_TrackProviders_Resource_Identifier" : {
32073 "required" : [ "id", "type" ],
32074 "type" : "object",
32075 "properties" : {
32076 "id" : {
32077 "type" : "string",
32078 "description" : "Resource id",
32079 "example" : "12345"
32080 },
32081 "meta" : {
32082 "$ref" : "#/components/schemas/Artists_TrackProviders_Resource_Identifier_Meta"
32083 },
32084 "type" : {
32085 "type" : "string",
32086 "description" : "Resource type",
32087 "example" : "tracks"
32088 }
32089 }
32090 },
32091 "Artists_TrackProviders_Resource_Identifier_Meta" : {
32092 "required" : [ "numberOfTracks" ],
32093 "type" : "object",
32094 "properties" : {
32095 "numberOfTracks" : {
32096 "type" : "integer",
32097 "description" : "Total number of tracks released together with the provider",
32098 "format" : "int64",
32099 "example" : 14
32100 }
32101 }
32102 },
32103 "Artists_Tracks_Multi_Relationship_Data_Document" : {
32104 "required" : [ "links" ],
32105 "type" : "object",
32106 "properties" : {
32107 "data" : {
32108 "type" : "array",
32109 "items" : {
32110 "$ref" : "#/components/schemas/Artists_Tracks_Resource_Identifier"
32111 }
32112 },
32113 "included" : {
32114 "$ref" : "#/components/schemas/Included"
32115 },
32116 "links" : {
32117 "$ref" : "#/components/schemas/Links"
32118 }
32119 }
32120 },
32121 "Artists_Tracks_Resource_Identifier" : {
32122 "required" : [ "id", "type" ],
32123 "type" : "object",
32124 "properties" : {
32125 "id" : {
32126 "type" : "string",
32127 "description" : "Resource id",
32128 "example" : "12345"
32129 },
32130 "meta" : {
32131 "$ref" : "#/components/schemas/Artists_Tracks_Resource_Identifier_Meta"
32132 },
32133 "type" : {
32134 "type" : "string",
32135 "description" : "Resource type",
32136 "example" : "tracks"
32137 }
32138 }
32139 },
32140 "Artists_Tracks_Resource_Identifier_Meta" : {
32141 "type" : "object",
32142 "properties" : {
32143 "replacement" : {
32144 "$ref" : "#/components/schemas/Replacement_Provenance"
32145 }
32146 }
32147 },
32148 "Artists_Videos_Multi_Relationship_Data_Document" : {
32149 "required" : [ "links" ],
32150 "type" : "object",
32151 "properties" : {
32152 "data" : {
32153 "type" : "array",
32154 "items" : {
32155 "$ref" : "#/components/schemas/Artists_Videos_Resource_Identifier"
32156 }
32157 },
32158 "included" : {
32159 "$ref" : "#/components/schemas/Included"
32160 },
32161 "links" : {
32162 "$ref" : "#/components/schemas/Links"
32163 }
32164 }
32165 },
32166 "Artists_Videos_Resource_Identifier" : {
32167 "required" : [ "id", "type" ],
32168 "type" : "object",
32169 "properties" : {
32170 "id" : {
32171 "type" : "string",
32172 "description" : "Resource id",
32173 "example" : "12345"
32174 },
32175 "meta" : {
32176 "$ref" : "#/components/schemas/Artists_Videos_Resource_Identifier_Meta"
32177 },
32178 "type" : {
32179 "type" : "string",
32180 "description" : "Resource type",
32181 "example" : "tracks"
32182 }
32183 }
32184 },
32185 "Artists_Videos_Resource_Identifier_Meta" : {
32186 "type" : "object",
32187 "properties" : {
32188 "replacement" : {
32189 "$ref" : "#/components/schemas/Replacement_Provenance"
32190 }
32191 }
32192 },
32193 "Artwork_File" : {
32194 "required" : [ "href", "meta" ],
32195 "type" : "object",
32196 "properties" : {
32197 "href" : {
32198 "type" : "string",
32199 "description" : "Artwork file href"
32200 },
32201 "meta" : {
32202 "$ref" : "#/components/schemas/Artwork_File_Meta"
32203 }
32204 },
32205 "description" : "Artwork files"
32206 },
32207 "Artwork_File_Meta" : {
32208 "required" : [ "height", "width" ],
32209 "type" : "object",
32210 "properties" : {
32211 "height" : {
32212 "type" : "integer",
32213 "description" : "Height (in pixels)",
32214 "format" : "int32",
32215 "example" : 80
32216 },
32217 "width" : {
32218 "type" : "integer",
32219 "description" : "Width (in pixels)",
32220 "format" : "int32",
32221 "example" : 80
32222 }
32223 },
32224 "description" : "Metadata about an artwork file"
32225 },
32226 "Artwork_SourceFile" : {
32227 "required" : [ "md5Hash", "size", "status", "uploadLink" ],
32228 "type" : "object",
32229 "properties" : {
32230 "md5Hash" : {
32231 "type" : "string",
32232 "description" : "MD5 hash of file to be uploaded"
32233 },
32234 "size" : {
32235 "type" : "integer",
32236 "description" : "File size of the artwork in bytes",
32237 "format" : "int64"
32238 },
32239 "status" : {
32240 "$ref" : "#/components/schemas/File_Status"
32241 },
32242 "uploadLink" : {
32243 "$ref" : "#/components/schemas/File_Upload_Link"
32244 }
32245 },
32246 "description" : "Artwork source file"
32247 },
32248 "Artwork_VisualMetadata" : {
32249 "type" : "object",
32250 "properties" : {
32251 "blurHash" : {
32252 "type" : "string",
32253 "description" : "BlurHash representation of the artwork for placeholder display"
32254 },
32255 "selectedPaletteColor" : {
32256 "type" : "string",
32257 "description" : "Selected color from the extracted artwork palette"
32258 },
32259 "status" : {
32260 "type" : "string",
32261 "description" : "Status of visual metadata extraction",
32262 "enum" : [ "NONE", "PROCESSING", "OK" ]
32263 }
32264 },
32265 "description" : "Color information extracted from artwork"
32266 },
32267 "ArtworksCreateOperation_Payload" : {
32268 "required" : [ "data" ],
32269 "type" : "object",
32270 "properties" : {
32271 "data" : {
32272 "$ref" : "#/components/schemas/ArtworksCreateOperation_Payload_Data"
32273 }
32274 }
32275 },
32276 "ArtworksCreateOperation_Payload_Data" : {
32277 "required" : [ "attributes", "type" ],
32278 "type" : "object",
32279 "properties" : {
32280 "attributes" : {
32281 "$ref" : "#/components/schemas/ArtworksCreateOperation_Payload_Data_Attributes"
32282 },
32283 "type" : {
32284 "type" : "string",
32285 "enum" : [ "artworks" ]
32286 }
32287 }
32288 },
32289 "ArtworksCreateOperation_Payload_Data_Attributes" : {
32290 "required" : [ "mediaType", "sourceFile" ],
32291 "type" : "object",
32292 "properties" : {
32293 "mediaType" : {
32294 "type" : "string",
32295 "enum" : [ "IMAGE", "VIDEO" ]
32296 },
32297 "sourceFile" : {
32298 "$ref" : "#/components/schemas/ArtworksCreateOperation_Payload_Data_Attributes_SourceFile"
32299 }
32300 }
32301 },
32302 "ArtworksCreateOperation_Payload_Data_Attributes_SourceFile" : {
32303 "required" : [ "md5Hash", "size" ],
32304 "type" : "object",
32305 "properties" : {
32306 "md5Hash" : {
32307 "type" : "string"
32308 },
32309 "size" : {
32310 "type" : "integer",
32311 "format" : "int64"
32312 }
32313 }
32314 },
32315 "Artworks_Attributes" : {
32316 "required" : [ "files", "mediaType" ],
32317 "type" : "object",
32318 "properties" : {
32319 "files" : {
32320 "type" : "array",
32321 "description" : "Artwork files",
32322 "items" : {
32323 "$ref" : "#/components/schemas/Artwork_File"
32324 }
32325 },
32326 "mediaType" : {
32327 "minLength" : 1,
32328 "type" : "string",
32329 "description" : "Media type of artwork files",
32330 "enum" : [ "IMAGE", "VIDEO" ]
32331 },
32332 "sourceFile" : {
32333 "$ref" : "#/components/schemas/Artwork_SourceFile"
32334 },
32335 "visualMetadata" : {
32336 "$ref" : "#/components/schemas/Artwork_VisualMetadata"
32337 }
32338 }
32339 },
32340 "Artworks_Create_Single_Resource_Data_Document" : {
32341 "required" : [ "data", "links" ],
32342 "type" : "object",
32343 "properties" : {
32344 "data" : {
32345 "$ref" : "#/components/schemas/Artworks_Resource_Object"
32346 },
32347 "links" : {
32348 "$ref" : "#/components/schemas/Links"
32349 }
32350 }
32351 },
32352 "Artworks_Multi_Relationship_Data_Document" : {
32353 "required" : [ "links" ],
32354 "type" : "object",
32355 "properties" : {
32356 "data" : {
32357 "type" : "array",
32358 "items" : {
32359 "$ref" : "#/components/schemas/Resource_Identifier"
32360 }
32361 },
32362 "included" : {
32363 "$ref" : "#/components/schemas/Included"
32364 },
32365 "links" : {
32366 "$ref" : "#/components/schemas/Links"
32367 }
32368 }
32369 },
32370 "Artworks_Multi_Resource_Data_Document" : {
32371 "required" : [ "data", "links" ],
32372 "type" : "object",
32373 "properties" : {
32374 "data" : {
32375 "type" : "array",
32376 "items" : {
32377 "$ref" : "#/components/schemas/Artworks_Resource_Object"
32378 }
32379 },
32380 "included" : {
32381 "$ref" : "#/components/schemas/Included"
32382 },
32383 "links" : {
32384 "$ref" : "#/components/schemas/Links"
32385 }
32386 }
32387 },
32388 "Artworks_Relationships" : {
32389 "properties" : {
32390 "owners" : {
32391 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
32392 }
32393 }
32394 },
32395 "Artworks_Resource_Object" : {
32396 "required" : [ "id", "type" ],
32397 "type" : "object",
32398 "properties" : {
32399 "attributes" : {
32400 "$ref" : "#/components/schemas/Artworks_Attributes"
32401 },
32402 "id" : {
32403 "type" : "string",
32404 "description" : "Resource id",
32405 "example" : "12345"
32406 },
32407 "relationships" : {
32408 "$ref" : "#/components/schemas/Artworks_Relationships"
32409 },
32410 "type" : {
32411 "minLength" : 1,
32412 "type" : "string",
32413 "description" : "Resource type",
32414 "example" : "tracks"
32415 }
32416 }
32417 },
32418 "Artworks_Single_Resource_Data_Document" : {
32419 "required" : [ "data", "links" ],
32420 "type" : "object",
32421 "properties" : {
32422 "data" : {
32423 "$ref" : "#/components/schemas/Artworks_Resource_Object"
32424 },
32425 "included" : {
32426 "$ref" : "#/components/schemas/Included"
32427 },
32428 "links" : {
32429 "$ref" : "#/components/schemas/Links"
32430 }
32431 }
32432 },
32433 "AudioNormalizationData" : {
32434 "type" : "object",
32435 "properties" : {
32436 "peakAmplitude" : {
32437 "type" : "number",
32438 "format" : "float"
32439 },
32440 "replayGain" : {
32441 "type" : "number",
32442 "format" : "float"
32443 }
32444 },
32445 "description" : "Track normalization data"
32446 },
32447 "ClientsCreateOperation_Payload" : {
32448 "required" : [ "data" ],
32449 "type" : "object",
32450 "properties" : {
32451 "data" : {
32452 "$ref" : "#/components/schemas/ClientsCreateOperation_Payload_Data"
32453 }
32454 }
32455 },
32456 "ClientsCreateOperation_Payload_Data" : {
32457 "required" : [ "attributes", "type" ],
32458 "type" : "object",
32459 "properties" : {
32460 "attributes" : {
32461 "$ref" : "#/components/schemas/ClientsCreateOperation_Payload_Data_Attributes"
32462 },
32463 "type" : {
32464 "type" : "string",
32465 "enum" : [ "clients" ]
32466 }
32467 }
32468 },
32469 "ClientsCreateOperation_Payload_Data_Attributes" : {
32470 "required" : [ "name" ],
32471 "type" : "object",
32472 "properties" : {
32473 "description" : {
32474 "type" : "string"
32475 },
32476 "name" : {
32477 "type" : "string"
32478 }
32479 }
32480 },
32481 "ClientsUpdateOperation_Payload" : {
32482 "required" : [ "data" ],
32483 "type" : "object",
32484 "properties" : {
32485 "data" : {
32486 "$ref" : "#/components/schemas/ClientsUpdateOperation_Payload_Data"
32487 }
32488 }
32489 },
32490 "ClientsUpdateOperation_Payload_Data" : {
32491 "required" : [ "attributes", "id", "type" ],
32492 "type" : "object",
32493 "properties" : {
32494 "attributes" : {
32495 "$ref" : "#/components/schemas/ClientsUpdateOperation_Payload_Data_Attributes"
32496 },
32497 "id" : {
32498 "type" : "string"
32499 },
32500 "type" : {
32501 "type" : "string",
32502 "enum" : [ "clients" ]
32503 }
32504 }
32505 },
32506 "ClientsUpdateOperation_Payload_Data_Attributes" : {
32507 "type" : "object",
32508 "properties" : {
32509 "description" : {
32510 "type" : "string"
32511 },
32512 "name" : {
32513 "type" : "string"
32514 },
32515 "redirectUris" : {
32516 "type" : "array",
32517 "items" : {
32518 "type" : "string"
32519 }
32520 },
32521 "scopes" : {
32522 "uniqueItems" : true,
32523 "type" : "array",
32524 "items" : {
32525 "type" : "string"
32526 }
32527 }
32528 }
32529 },
32530 "Clients_Attributes" : {
32531 "required" : [ "accessTier", "name" ],
32532 "type" : "object",
32533 "properties" : {
32534 "accessTier" : {
32535 "type" : "string",
32536 "enum" : [ "THIRD_PARTY", "THIRD_PARTY_PROD", "PARTNER", "INTERNAL" ]
32537 },
32538 "clientSecret" : {
32539 "type" : "string"
32540 },
32541 "createdAt" : {
32542 "type" : "string",
32543 "format" : "date-time"
32544 },
32545 "description" : {
32546 "type" : "string"
32547 },
32548 "name" : {
32549 "type" : "string"
32550 },
32551 "redirectUris" : {
32552 "type" : "array",
32553 "items" : {
32554 "type" : "string"
32555 }
32556 },
32557 "scopes" : {
32558 "uniqueItems" : true,
32559 "type" : "array",
32560 "items" : {
32561 "type" : "string"
32562 }
32563 }
32564 }
32565 },
32566 "Clients_Create_Single_Resource_Data_Document" : {
32567 "required" : [ "data", "links" ],
32568 "type" : "object",
32569 "properties" : {
32570 "data" : {
32571 "$ref" : "#/components/schemas/Clients_Resource_Object"
32572 },
32573 "links" : {
32574 "$ref" : "#/components/schemas/Links"
32575 }
32576 }
32577 },
32578 "Clients_Multi_Relationship_Data_Document" : {
32579 "required" : [ "links" ],
32580 "type" : "object",
32581 "properties" : {
32582 "data" : {
32583 "type" : "array",
32584 "items" : {
32585 "$ref" : "#/components/schemas/Resource_Identifier"
32586 }
32587 },
32588 "included" : {
32589 "$ref" : "#/components/schemas/Included"
32590 },
32591 "links" : {
32592 "$ref" : "#/components/schemas/Links"
32593 }
32594 }
32595 },
32596 "Clients_Multi_Resource_Data_Document" : {
32597 "required" : [ "data", "links" ],
32598 "type" : "object",
32599 "properties" : {
32600 "data" : {
32601 "type" : "array",
32602 "items" : {
32603 "$ref" : "#/components/schemas/Clients_Resource_Object"
32604 }
32605 },
32606 "included" : {
32607 "$ref" : "#/components/schemas/Included"
32608 },
32609 "links" : {
32610 "$ref" : "#/components/schemas/Links"
32611 }
32612 }
32613 },
32614 "Clients_Relationships" : {
32615 "properties" : {
32616 "owners" : {
32617 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
32618 }
32619 }
32620 },
32621 "Clients_Resource_Object" : {
32622 "required" : [ "id", "type" ],
32623 "type" : "object",
32624 "properties" : {
32625 "attributes" : {
32626 "$ref" : "#/components/schemas/Clients_Attributes"
32627 },
32628 "id" : {
32629 "type" : "string",
32630 "description" : "Resource id",
32631 "example" : "12345"
32632 },
32633 "relationships" : {
32634 "$ref" : "#/components/schemas/Clients_Relationships"
32635 },
32636 "type" : {
32637 "minLength" : 1,
32638 "type" : "string",
32639 "description" : "Resource type",
32640 "example" : "tracks"
32641 }
32642 }
32643 },
32644 "Clients_Single_Resource_Data_Document" : {
32645 "required" : [ "data", "links" ],
32646 "type" : "object",
32647 "properties" : {
32648 "data" : {
32649 "$ref" : "#/components/schemas/Clients_Resource_Object"
32650 },
32651 "included" : {
32652 "$ref" : "#/components/schemas/Included"
32653 },
32654 "links" : {
32655 "$ref" : "#/components/schemas/Links"
32656 }
32657 }
32658 },
32659 "Clients_Update_Single_Resource_Data_Document" : {
32660 "required" : [ "data", "links" ],
32661 "type" : "object",
32662 "properties" : {
32663 "data" : {
32664 "$ref" : "#/components/schemas/Clients_Resource_Object"
32665 },
32666 "links" : {
32667 "$ref" : "#/components/schemas/Links"
32668 }
32669 }
32670 },
32671 "CollaborationInviteRedemptionsCreateOperation_Payload" : {
32672 "required" : [ "data" ],
32673 "type" : "object",
32674 "properties" : {
32675 "data" : {
32676 "$ref" : "#/components/schemas/CollaborationInviteRedemptionsCreateOperation_Payload_Data"
32677 }
32678 }
32679 },
32680 "CollaborationInviteRedemptionsCreateOperation_Payload_Data" : {
32681 "required" : [ "relationships", "type" ],
32682 "type" : "object",
32683 "properties" : {
32684 "relationships" : {
32685 "$ref" : "#/components/schemas/CollaborationInviteRedemptionsCreateOperation_Payload_Data_Relationships"
32686 },
32687 "type" : {
32688 "type" : "string",
32689 "enum" : [ "collaborationInviteRedemptions" ]
32690 }
32691 }
32692 },
32693 "CollaborationInviteRedemptionsCreateOperation_Payload_Data_Relationships" : {
32694 "required" : [ "invite" ],
32695 "type" : "object",
32696 "properties" : {
32697 "invite" : {
32698 "$ref" : "#/components/schemas/CollaborationInviteRedemptionsCreateOperation_Payload_Data_Relationships_Invite"
32699 }
32700 }
32701 },
32702 "CollaborationInviteRedemptionsCreateOperation_Payload_Data_Relationships_Invite" : {
32703 "required" : [ "data" ],
32704 "type" : "object",
32705 "properties" : {
32706 "data" : {
32707 "$ref" : "#/components/schemas/CollaborationInviteRedemptionsCreateOperation_Payload_Data_Relationships_Invite_Data"
32708 }
32709 }
32710 },
32711 "CollaborationInviteRedemptionsCreateOperation_Payload_Data_Relationships_Invite_Data" : {
32712 "required" : [ "id", "type" ],
32713 "type" : "object",
32714 "properties" : {
32715 "id" : {
32716 "type" : "string"
32717 },
32718 "type" : {
32719 "type" : "string",
32720 "enum" : [ "collaborationInvites" ]
32721 }
32722 }
32723 },
32724 "CollaborationInviteRedemptions_Attributes" : {
32725 "required" : [ "redeemedAt" ],
32726 "type" : "object",
32727 "properties" : {
32728 "redeemedAt" : {
32729 "type" : "string",
32730 "description" : "Datetime the invite was redeemed (ISO 8601)",
32731 "format" : "date-time"
32732 }
32733 }
32734 },
32735 "CollaborationInviteRedemptions_Create_Single_Resource_Data_Document" : {
32736 "required" : [ "data", "links" ],
32737 "type" : "object",
32738 "properties" : {
32739 "data" : {
32740 "$ref" : "#/components/schemas/CollaborationInviteRedemptions_Resource_Object"
32741 },
32742 "links" : {
32743 "$ref" : "#/components/schemas/Links"
32744 }
32745 }
32746 },
32747 "CollaborationInviteRedemptions_Resource_Object" : {
32748 "required" : [ "id", "type" ],
32749 "type" : "object",
32750 "properties" : {
32751 "attributes" : {
32752 "$ref" : "#/components/schemas/CollaborationInviteRedemptions_Attributes"
32753 },
32754 "id" : {
32755 "type" : "string",
32756 "description" : "Resource id",
32757 "example" : "12345"
32758 },
32759 "type" : {
32760 "minLength" : 1,
32761 "type" : "string",
32762 "description" : "Resource type",
32763 "example" : "tracks"
32764 }
32765 }
32766 },
32767 "CollaborationInvitesCreateOperation_Payload" : {
32768 "required" : [ "data" ],
32769 "type" : "object",
32770 "properties" : {
32771 "data" : {
32772 "$ref" : "#/components/schemas/CollaborationInvitesCreateOperation_Payload_Data"
32773 }
32774 }
32775 },
32776 "CollaborationInvitesCreateOperation_Payload_Data" : {
32777 "required" : [ "relationships", "type" ],
32778 "type" : "object",
32779 "properties" : {
32780 "relationships" : {
32781 "$ref" : "#/components/schemas/CollaborationInvitesCreateOperation_Payload_Data_Relationships"
32782 },
32783 "type" : {
32784 "type" : "string",
32785 "enum" : [ "collaborationInvites" ]
32786 }
32787 }
32788 },
32789 "CollaborationInvitesCreateOperation_Payload_Data_Relationships" : {
32790 "required" : [ "subject" ],
32791 "type" : "object",
32792 "properties" : {
32793 "subject" : {
32794 "$ref" : "#/components/schemas/CollaborationInvitesCreateOperation_Payload_Data_Relationships_Subject"
32795 }
32796 }
32797 },
32798 "CollaborationInvitesCreateOperation_Payload_Data_Relationships_Subject" : {
32799 "required" : [ "data" ],
32800 "type" : "object",
32801 "properties" : {
32802 "data" : {
32803 "$ref" : "#/components/schemas/CollaborationInvitesCreateOperation_Payload_Data_Relationships_Subject_Data"
32804 }
32805 }
32806 },
32807 "CollaborationInvitesCreateOperation_Payload_Data_Relationships_Subject_Data" : {
32808 "required" : [ "id", "type" ],
32809 "type" : "object",
32810 "properties" : {
32811 "id" : {
32812 "type" : "string"
32813 },
32814 "type" : {
32815 "type" : "string",
32816 "enum" : [ "playlists" ]
32817 }
32818 }
32819 },
32820 "CollaborationInvites_Attributes" : {
32821 "required" : [ "code", "createdAt", "expiresAt", "revoked" ],
32822 "type" : "object",
32823 "properties" : {
32824 "code" : {
32825 "type" : "string",
32826 "description" : "Opaque invite code embedded in the share link"
32827 },
32828 "createdAt" : {
32829 "type" : "string",
32830 "description" : "Datetime the invite was created (ISO 8601)",
32831 "format" : "date-time"
32832 },
32833 "expiresAt" : {
32834 "type" : "string",
32835 "description" : "Datetime the invite expires (ISO 8601)",
32836 "format" : "date-time"
32837 },
32838 "revoked" : {
32839 "type" : "boolean",
32840 "description" : "Whether the invite has been revoked by the subject's owner"
32841 }
32842 }
32843 },
32844 "CollaborationInvites_Create_Single_Resource_Data_Document" : {
32845 "required" : [ "data", "links" ],
32846 "type" : "object",
32847 "properties" : {
32848 "data" : {
32849 "$ref" : "#/components/schemas/CollaborationInvites_Resource_Object"
32850 },
32851 "links" : {
32852 "$ref" : "#/components/schemas/Links"
32853 }
32854 }
32855 },
32856 "CollaborationInvites_Multi_Relationship_Data_Document" : {
32857 "required" : [ "links" ],
32858 "type" : "object",
32859 "properties" : {
32860 "data" : {
32861 "type" : "array",
32862 "items" : {
32863 "$ref" : "#/components/schemas/Resource_Identifier"
32864 }
32865 },
32866 "included" : {
32867 "$ref" : "#/components/schemas/Included"
32868 },
32869 "links" : {
32870 "$ref" : "#/components/schemas/Links"
32871 }
32872 }
32873 },
32874 "CollaborationInvites_Multi_Resource_Data_Document" : {
32875 "required" : [ "data", "links" ],
32876 "type" : "object",
32877 "properties" : {
32878 "data" : {
32879 "type" : "array",
32880 "items" : {
32881 "$ref" : "#/components/schemas/CollaborationInvites_Resource_Object"
32882 }
32883 },
32884 "included" : {
32885 "$ref" : "#/components/schemas/Included"
32886 },
32887 "links" : {
32888 "$ref" : "#/components/schemas/Links"
32889 }
32890 }
32891 },
32892 "CollaborationInvites_Relationships" : {
32893 "properties" : {
32894 "owners" : {
32895 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
32896 },
32897 "subject" : {
32898 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
32899 }
32900 }
32901 },
32902 "CollaborationInvites_Resource_Object" : {
32903 "required" : [ "id", "type" ],
32904 "type" : "object",
32905 "properties" : {
32906 "attributes" : {
32907 "$ref" : "#/components/schemas/CollaborationInvites_Attributes"
32908 },
32909 "id" : {
32910 "type" : "string",
32911 "description" : "Resource id",
32912 "example" : "12345"
32913 },
32914 "relationships" : {
32915 "$ref" : "#/components/schemas/CollaborationInvites_Relationships"
32916 },
32917 "type" : {
32918 "minLength" : 1,
32919 "type" : "string",
32920 "description" : "Resource type",
32921 "example" : "tracks"
32922 }
32923 }
32924 },
32925 "CollaborationInvites_Single_Relationship_Data_Document" : {
32926 "required" : [ "links" ],
32927 "type" : "object",
32928 "properties" : {
32929 "data" : {
32930 "oneOf" : [ {
32931 "$ref" : "#/components/schemas/Resource_Identifier"
32932 }, {
32933 "type" : "object",
32934 "nullable" : true,
32935 "enum" : [ null ]
32936 } ]
32937 },
32938 "included" : {
32939 "$ref" : "#/components/schemas/Included"
32940 },
32941 "links" : {
32942 "$ref" : "#/components/schemas/Links"
32943 }
32944 }
32945 },
32946 "CollaborationInvites_Single_Resource_Data_Document" : {
32947 "required" : [ "data", "links" ],
32948 "type" : "object",
32949 "properties" : {
32950 "data" : {
32951 "$ref" : "#/components/schemas/CollaborationInvites_Resource_Object"
32952 },
32953 "included" : {
32954 "$ref" : "#/components/schemas/Included"
32955 },
32956 "links" : {
32957 "$ref" : "#/components/schemas/Links"
32958 }
32959 }
32960 },
32961 "CommentsCreateOperation_Payload" : {
32962 "required" : [ "data" ],
32963 "type" : "object",
32964 "properties" : {
32965 "data" : {
32966 "$ref" : "#/components/schemas/CommentsCreateOperation_Payload_Data"
32967 }
32968 }
32969 },
32970 "CommentsCreateOperation_Payload_Data" : {
32971 "required" : [ "attributes", "relationships", "type" ],
32972 "type" : "object",
32973 "properties" : {
32974 "attributes" : {
32975 "$ref" : "#/components/schemas/CommentsCreateOperation_Payload_Data_Attributes"
32976 },
32977 "relationships" : {
32978 "$ref" : "#/components/schemas/CommentsCreateOperation_Payload_Data_Relationships"
32979 },
32980 "type" : {
32981 "type" : "string",
32982 "enum" : [ "comments" ]
32983 }
32984 }
32985 },
32986 "CommentsCreateOperation_Payload_Data_Attributes" : {
32987 "required" : [ "message" ],
32988 "type" : "object",
32989 "properties" : {
32990 "endTime" : {
32991 "type" : "string"
32992 },
32993 "message" : {
32994 "maxLength" : 2000,
32995 "minLength" : 1,
32996 "type" : "string"
32997 },
32998 "startTime" : {
32999 "type" : "string"
33000 }
33001 }
33002 },
33003 "CommentsCreateOperation_Payload_Data_Relationships" : {
33004 "required" : [ "subject" ],
33005 "type" : "object",
33006 "properties" : {
33007 "parentComment" : {
33008 "$ref" : "#/components/schemas/CommentsCreateOperation_Payload_Data_Relationships_ParentComment"
33009 },
33010 "subject" : {
33011 "$ref" : "#/components/schemas/CommentsCreateOperation_Payload_Data_Relationships_Subject"
33012 }
33013 }
33014 },
33015 "CommentsCreateOperation_Payload_Data_Relationships_ParentComment" : {
33016 "required" : [ "data" ],
33017 "type" : "object",
33018 "properties" : {
33019 "data" : {
33020 "oneOf" : [ {
33021 "$ref" : "#/components/schemas/CommentsCreateOperation_Payload_Data_Relationships_ParentComment_Data"
33022 }, {
33023 "type" : "object",
33024 "nullable" : true,
33025 "enum" : [ null ]
33026 } ]
33027 }
33028 }
33029 },
33030 "CommentsCreateOperation_Payload_Data_Relationships_ParentComment_Data" : {
33031 "required" : [ "id", "type" ],
33032 "type" : "object",
33033 "properties" : {
33034 "id" : {
33035 "type" : "string"
33036 },
33037 "type" : {
33038 "type" : "string",
33039 "enum" : [ "comments" ]
33040 }
33041 }
33042 },
33043 "CommentsCreateOperation_Payload_Data_Relationships_Subject" : {
33044 "required" : [ "data" ],
33045 "type" : "object",
33046 "properties" : {
33047 "data" : {
33048 "$ref" : "#/components/schemas/CommentsCreateOperation_Payload_Data_Relationships_Subject_Data"
33049 }
33050 }
33051 },
33052 "CommentsCreateOperation_Payload_Data_Relationships_Subject_Data" : {
33053 "required" : [ "id", "type" ],
33054 "type" : "object",
33055 "properties" : {
33056 "id" : {
33057 "type" : "string"
33058 },
33059 "type" : {
33060 "type" : "string",
33061 "enum" : [ "albums", "tracks" ]
33062 }
33063 }
33064 },
33065 "CommentsUpdateOperation_Payload" : {
33066 "required" : [ "data" ],
33067 "type" : "object",
33068 "properties" : {
33069 "data" : {
33070 "$ref" : "#/components/schemas/CommentsUpdateOperation_Payload_Data"
33071 }
33072 }
33073 },
33074 "CommentsUpdateOperation_Payload_Data" : {
33075 "required" : [ "attributes", "id", "type" ],
33076 "type" : "object",
33077 "properties" : {
33078 "attributes" : {
33079 "$ref" : "#/components/schemas/CommentsUpdateOperation_Payload_Data_Attributes"
33080 },
33081 "id" : {
33082 "type" : "string"
33083 },
33084 "type" : {
33085 "type" : "string",
33086 "enum" : [ "comments" ]
33087 }
33088 }
33089 },
33090 "CommentsUpdateOperation_Payload_Data_Attributes" : {
33091 "type" : "object",
33092 "properties" : {
33093 "endTime" : {
33094 "type" : "string"
33095 },
33096 "message" : {
33097 "maxLength" : 2000,
33098 "minLength" : 1,
33099 "type" : "string"
33100 },
33101 "startTime" : {
33102 "type" : "string"
33103 }
33104 }
33105 },
33106 "Comments_Attributes" : {
33107 "required" : [ "createdAt", "lastModifiedAt", "likeCount", "message", "moderationStatus", "replyCount" ],
33108 "type" : "object",
33109 "properties" : {
33110 "createdAt" : {
33111 "type" : "string",
33112 "description" : "Datetime when the comment was created (ISO 8601)",
33113 "format" : "date-time",
33114 "example" : "2025-11-17T12:54:48.606Z"
33115 },
33116 "endTime" : {
33117 "type" : "string",
33118 "description" : "End time offset for timestamped comments (ISO 8601 duration)",
33119 "example" : "PT2M"
33120 },
33121 "lastModifiedAt" : {
33122 "type" : "string",
33123 "description" : "Datetime when the comment was last modified (ISO 8601)",
33124 "format" : "date-time",
33125 "example" : "2025-11-17T12:54:48.606Z"
33126 },
33127 "likeCount" : {
33128 "type" : "integer",
33129 "description" : "Number of likes on this comment",
33130 "format" : "int32"
33131 },
33132 "message" : {
33133 "maxLength" : 2000,
33134 "minLength" : 1,
33135 "type" : "string",
33136 "description" : "The comment message content"
33137 },
33138 "moderationStatus" : {
33139 "type" : "string",
33140 "description" : "Moderation status of the comment",
33141 "enum" : [ "NOT_MODERATED", "FLAGGED", "TAKEN_DOWN", "OK", "ERROR" ]
33142 },
33143 "replyCount" : {
33144 "type" : "integer",
33145 "description" : "Number of replies to this comment",
33146 "format" : "int32"
33147 },
33148 "startTime" : {
33149 "type" : "string",
33150 "description" : "Start time offset for timestamped comments (ISO 8601 duration)",
33151 "example" : "PT1M30S"
33152 }
33153 }
33154 },
33155 "Comments_Create_Single_Resource_Data_Document" : {
33156 "required" : [ "data", "links" ],
33157 "type" : "object",
33158 "properties" : {
33159 "data" : {
33160 "$ref" : "#/components/schemas/Comments_Resource_Object"
33161 },
33162 "links" : {
33163 "$ref" : "#/components/schemas/Links"
33164 }
33165 }
33166 },
33167 "Comments_Multi_Relationship_Data_Document" : {
33168 "required" : [ "links" ],
33169 "type" : "object",
33170 "properties" : {
33171 "data" : {
33172 "type" : "array",
33173 "items" : {
33174 "$ref" : "#/components/schemas/Resource_Identifier"
33175 }
33176 },
33177 "included" : {
33178 "$ref" : "#/components/schemas/Included"
33179 },
33180 "links" : {
33181 "$ref" : "#/components/schemas/Links"
33182 }
33183 }
33184 },
33185 "Comments_Multi_Resource_Data_Document" : {
33186 "required" : [ "data", "links" ],
33187 "type" : "object",
33188 "properties" : {
33189 "data" : {
33190 "type" : "array",
33191 "items" : {
33192 "$ref" : "#/components/schemas/Comments_Resource_Object"
33193 }
33194 },
33195 "included" : {
33196 "$ref" : "#/components/schemas/Included"
33197 },
33198 "links" : {
33199 "$ref" : "#/components/schemas/Links"
33200 }
33201 }
33202 },
33203 "Comments_Relationships" : {
33204 "properties" : {
33205 "ownerProfiles" : {
33206 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
33207 },
33208 "owners" : {
33209 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
33210 },
33211 "parentComment" : {
33212 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
33213 }
33214 }
33215 },
33216 "Comments_Resource_Object" : {
33217 "required" : [ "id", "type" ],
33218 "type" : "object",
33219 "properties" : {
33220 "attributes" : {
33221 "$ref" : "#/components/schemas/Comments_Attributes"
33222 },
33223 "id" : {
33224 "type" : "string",
33225 "description" : "Resource id",
33226 "example" : "12345"
33227 },
33228 "relationships" : {
33229 "$ref" : "#/components/schemas/Comments_Relationships"
33230 },
33231 "type" : {
33232 "minLength" : 1,
33233 "type" : "string",
33234 "description" : "Resource type",
33235 "example" : "tracks"
33236 }
33237 }
33238 },
33239 "Comments_Single_Relationship_Data_Document" : {
33240 "required" : [ "links" ],
33241 "type" : "object",
33242 "properties" : {
33243 "data" : {
33244 "oneOf" : [ {
33245 "$ref" : "#/components/schemas/Resource_Identifier"
33246 }, {
33247 "type" : "object",
33248 "nullable" : true,
33249 "enum" : [ null ]
33250 } ]
33251 },
33252 "included" : {
33253 "$ref" : "#/components/schemas/Included"
33254 },
33255 "links" : {
33256 "$ref" : "#/components/schemas/Links"
33257 }
33258 }
33259 },
33260 "Comments_Single_Resource_Data_Document" : {
33261 "required" : [ "data", "links" ],
33262 "type" : "object",
33263 "properties" : {
33264 "data" : {
33265 "$ref" : "#/components/schemas/Comments_Resource_Object"
33266 },
33267 "included" : {
33268 "$ref" : "#/components/schemas/Included"
33269 },
33270 "links" : {
33271 "$ref" : "#/components/schemas/Links"
33272 }
33273 }
33274 },
33275 "ContentClaimsCreateOperation_Payload" : {
33276 "required" : [ "data" ],
33277 "type" : "object",
33278 "properties" : {
33279 "data" : {
33280 "$ref" : "#/components/schemas/ContentClaimsCreateOperation_Payload_Data"
33281 }
33282 }
33283 },
33284 "ContentClaimsCreateOperation_Payload_Data" : {
33285 "required" : [ "attributes", "relationships", "type" ],
33286 "type" : "object",
33287 "properties" : {
33288 "attributes" : {
33289 "$ref" : "#/components/schemas/ContentClaimsCreateOperation_Payload_Data_Attributes"
33290 },
33291 "relationships" : {
33292 "$ref" : "#/components/schemas/ContentClaimsCreateOperation_Payload_Data_Relationships"
33293 },
33294 "type" : {
33295 "type" : "string",
33296 "enum" : [ "contentClaims" ]
33297 }
33298 }
33299 },
33300 "ContentClaimsCreateOperation_Payload_Data_Attributes" : {
33301 "required" : [ "assertion" ],
33302 "type" : "object",
33303 "properties" : {
33304 "assertion" : {
33305 "type" : "string",
33306 "enum" : [ "CLAIM", "DISCLAIM" ]
33307 }
33308 }
33309 },
33310 "ContentClaimsCreateOperation_Payload_Data_Relationships" : {
33311 "required" : [ "claimedResource", "claimingArtist" ],
33312 "type" : "object",
33313 "properties" : {
33314 "claimedResource" : {
33315 "$ref" : "#/components/schemas/ContentClaimsCreateOperation_Payload_Data_Relationships_ClaimedResource"
33316 },
33317 "claimingArtist" : {
33318 "$ref" : "#/components/schemas/ContentClaimsCreateOperation_Payload_Data_Relationships_ClaimingArtist"
33319 }
33320 }
33321 },
33322 "ContentClaimsCreateOperation_Payload_Data_Relationships_ClaimedResource" : {
33323 "required" : [ "data" ],
33324 "type" : "object",
33325 "properties" : {
33326 "data" : {
33327 "$ref" : "#/components/schemas/ContentClaimsCreateOperation_Payload_Data_Relationships_ClaimedResource_Data"
33328 }
33329 }
33330 },
33331 "ContentClaimsCreateOperation_Payload_Data_Relationships_ClaimedResource_Data" : {
33332 "required" : [ "id", "type" ],
33333 "type" : "object",
33334 "properties" : {
33335 "id" : {
33336 "type" : "string"
33337 },
33338 "type" : {
33339 "type" : "string",
33340 "enum" : [ "tracks", "albums", "videos" ]
33341 }
33342 }
33343 },
33344 "ContentClaimsCreateOperation_Payload_Data_Relationships_ClaimingArtist" : {
33345 "required" : [ "data" ],
33346 "type" : "object",
33347 "properties" : {
33348 "data" : {
33349 "$ref" : "#/components/schemas/ContentClaimsCreateOperation_Payload_Data_Relationships_ClaimingArtist_Data"
33350 }
33351 }
33352 },
33353 "ContentClaimsCreateOperation_Payload_Data_Relationships_ClaimingArtist_Data" : {
33354 "required" : [ "id", "type" ],
33355 "type" : "object",
33356 "properties" : {
33357 "id" : {
33358 "type" : "string"
33359 },
33360 "type" : {
33361 "type" : "string",
33362 "enum" : [ "artists" ]
33363 }
33364 }
33365 },
33366 "ContentClaims_Attributes" : {
33367 "required" : [ "assertion", "createdAt", "lastModifiedAt", "status" ],
33368 "type" : "object",
33369 "properties" : {
33370 "assertion" : {
33371 "type" : "string",
33372 "description" : "The claim assertion type",
33373 "enum" : [ "CLAIM", "DISCLAIM" ]
33374 },
33375 "createdAt" : {
33376 "type" : "string",
33377 "description" : "Timestamp when the claim was created",
33378 "format" : "date-time"
33379 },
33380 "lastModifiedAt" : {
33381 "type" : "string",
33382 "description" : "Timestamp when the claim was last modified",
33383 "format" : "date-time"
33384 },
33385 "status" : {
33386 "type" : "string",
33387 "description" : "Current status of this claim",
33388 "enum" : [ "OPEN", "IN_PROGRESS", "RESOLVED", "REJECTED" ]
33389 }
33390 }
33391 },
33392 "ContentClaims_ClaimedResource_Resource_Identifier" : {
33393 "required" : [ "id", "type" ],
33394 "type" : "object",
33395 "properties" : {
33396 "id" : {
33397 "type" : "string",
33398 "description" : "Resource id",
33399 "example" : "12345"
33400 },
33401 "meta" : {
33402 "$ref" : "#/components/schemas/ContentClaims_ClaimedResource_Resource_Identifier_Meta"
33403 },
33404 "type" : {
33405 "type" : "string",
33406 "description" : "Resource type",
33407 "example" : "tracks"
33408 }
33409 }
33410 },
33411 "ContentClaims_ClaimedResource_Resource_Identifier_Meta" : {
33412 "type" : "object",
33413 "properties" : {
33414 "replacement" : {
33415 "$ref" : "#/components/schemas/Replacement_Provenance"
33416 }
33417 }
33418 },
33419 "ContentClaims_ClaimedResource_Single_Relationship_Data_Document" : {
33420 "required" : [ "links" ],
33421 "type" : "object",
33422 "properties" : {
33423 "data" : {
33424 "oneOf" : [ {
33425 "$ref" : "#/components/schemas/ContentClaims_ClaimedResource_Resource_Identifier"
33426 }, {
33427 "type" : "object",
33428 "nullable" : true,
33429 "enum" : [ null ]
33430 } ]
33431 },
33432 "included" : {
33433 "$ref" : "#/components/schemas/Included"
33434 },
33435 "links" : {
33436 "$ref" : "#/components/schemas/Links"
33437 }
33438 }
33439 },
33440 "ContentClaims_Create_Single_Resource_Data_Document" : {
33441 "required" : [ "data", "links" ],
33442 "type" : "object",
33443 "properties" : {
33444 "data" : {
33445 "$ref" : "#/components/schemas/ContentClaims_Resource_Object"
33446 },
33447 "links" : {
33448 "$ref" : "#/components/schemas/Links"
33449 }
33450 }
33451 },
33452 "ContentClaims_Multi_Relationship_Data_Document" : {
33453 "required" : [ "links" ],
33454 "type" : "object",
33455 "properties" : {
33456 "data" : {
33457 "type" : "array",
33458 "items" : {
33459 "$ref" : "#/components/schemas/Resource_Identifier"
33460 }
33461 },
33462 "included" : {
33463 "$ref" : "#/components/schemas/Included"
33464 },
33465 "links" : {
33466 "$ref" : "#/components/schemas/Links"
33467 }
33468 }
33469 },
33470 "ContentClaims_Multi_Resource_Data_Document" : {
33471 "required" : [ "data", "links" ],
33472 "type" : "object",
33473 "properties" : {
33474 "data" : {
33475 "type" : "array",
33476 "items" : {
33477 "$ref" : "#/components/schemas/ContentClaims_Resource_Object"
33478 }
33479 },
33480 "included" : {
33481 "$ref" : "#/components/schemas/Included"
33482 },
33483 "links" : {
33484 "$ref" : "#/components/schemas/Links"
33485 }
33486 }
33487 },
33488 "ContentClaims_Relationships" : {
33489 "properties" : {
33490 "claimedResource" : {
33491 "$ref" : "#/components/schemas/ContentClaims_ClaimedResource_Single_Relationship_Data_Document"
33492 },
33493 "claimingArtist" : {
33494 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
33495 },
33496 "owners" : {
33497 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
33498 }
33499 }
33500 },
33501 "ContentClaims_Resource_Object" : {
33502 "required" : [ "id", "type" ],
33503 "type" : "object",
33504 "properties" : {
33505 "attributes" : {
33506 "$ref" : "#/components/schemas/ContentClaims_Attributes"
33507 },
33508 "id" : {
33509 "type" : "string",
33510 "description" : "Resource id",
33511 "example" : "12345"
33512 },
33513 "relationships" : {
33514 "$ref" : "#/components/schemas/ContentClaims_Relationships"
33515 },
33516 "type" : {
33517 "minLength" : 1,
33518 "type" : "string",
33519 "description" : "Resource type",
33520 "example" : "tracks"
33521 }
33522 }
33523 },
33524 "ContentClaims_Single_Relationship_Data_Document" : {
33525 "required" : [ "links" ],
33526 "type" : "object",
33527 "properties" : {
33528 "data" : {
33529 "oneOf" : [ {
33530 "$ref" : "#/components/schemas/Resource_Identifier"
33531 }, {
33532 "type" : "object",
33533 "nullable" : true,
33534 "enum" : [ null ]
33535 } ]
33536 },
33537 "included" : {
33538 "$ref" : "#/components/schemas/Included"
33539 },
33540 "links" : {
33541 "$ref" : "#/components/schemas/Links"
33542 }
33543 }
33544 },
33545 "ContentClaims_Single_Resource_Data_Document" : {
33546 "required" : [ "data", "links" ],
33547 "type" : "object",
33548 "properties" : {
33549 "data" : {
33550 "$ref" : "#/components/schemas/ContentClaims_Resource_Object"
33551 },
33552 "included" : {
33553 "$ref" : "#/components/schemas/Included"
33554 },
33555 "links" : {
33556 "$ref" : "#/components/schemas/Links"
33557 }
33558 }
33559 },
33560 "Copyright" : {
33561 "required" : [ "text" ],
33562 "type" : "object",
33563 "properties" : {
33564 "text" : {
33565 "maxLength" : 1024,
33566 "minLength" : 1,
33567 "type" : "string"
33568 }
33569 },
33570 "description" : "Copyright information"
33571 },
33572 "Credits_Attributes" : {
33573 "required" : [ "name", "role" ],
33574 "type" : "object",
33575 "properties" : {
33576 "name" : {
33577 "type" : "string",
33578 "description" : "Credit name",
33579 "example" : "John Lennon"
33580 },
33581 "role" : {
33582 "type" : "string",
33583 "description" : "Credit role",
33584 "example" : "Vocals"
33585 }
33586 }
33587 },
33588 "Credits_Relationships" : {
33589 "properties" : {
33590 "artist" : {
33591 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
33592 },
33593 "category" : {
33594 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
33595 }
33596 }
33597 },
33598 "Credits_Resource_Object" : {
33599 "required" : [ "id", "type" ],
33600 "type" : "object",
33601 "properties" : {
33602 "attributes" : {
33603 "$ref" : "#/components/schemas/Credits_Attributes"
33604 },
33605 "id" : {
33606 "type" : "string",
33607 "description" : "Resource id",
33608 "example" : "12345"
33609 },
33610 "relationships" : {
33611 "$ref" : "#/components/schemas/Credits_Relationships"
33612 },
33613 "type" : {
33614 "minLength" : 1,
33615 "type" : "string",
33616 "description" : "Resource type",
33617 "example" : "tracks"
33618 }
33619 }
33620 },
33621 "Credits_Single_Relationship_Data_Document" : {
33622 "required" : [ "links" ],
33623 "type" : "object",
33624 "properties" : {
33625 "data" : {
33626 "oneOf" : [ {
33627 "$ref" : "#/components/schemas/Resource_Identifier"
33628 }, {
33629 "type" : "object",
33630 "nullable" : true,
33631 "enum" : [ null ]
33632 } ]
33633 },
33634 "included" : {
33635 "$ref" : "#/components/schemas/Included"
33636 },
33637 "links" : {
33638 "$ref" : "#/components/schemas/Links"
33639 }
33640 }
33641 },
33642 "Credits_Single_Resource_Data_Document" : {
33643 "required" : [ "data", "links" ],
33644 "type" : "object",
33645 "properties" : {
33646 "data" : {
33647 "$ref" : "#/components/schemas/Credits_Resource_Object"
33648 },
33649 "included" : {
33650 "$ref" : "#/components/schemas/Included"
33651 },
33652 "links" : {
33653 "$ref" : "#/components/schemas/Links"
33654 }
33655 }
33656 },
33657 "CurrentUserReaction" : {
33658 "type" : "object",
33659 "properties" : {
33660 "createdAt" : {
33661 "type" : "string",
33662 "description" : "When the reaction was created",
33663 "format" : "date-time"
33664 },
33665 "emoji" : {
33666 "type" : "string",
33667 "description" : "User's emoji reaction"
33668 },
33669 "id" : {
33670 "type" : "string",
33671 "description" : "Reaction ID"
33672 }
33673 },
33674 "description" : "Current user's reaction"
33675 },
33676 "Default400ResponseBody" : {
33677 "required" : [ "errors" ],
33678 "type" : "object",
33679 "properties" : {
33680 "errors" : {
33681 "type" : "array",
33682 "items" : {
33683 "required" : [ "status" ],
33684 "type" : "object",
33685 "properties" : {
33686 "detail" : {
33687 "type" : "string",
33688 "example" : "Invalid request"
33689 },
33690 "status" : {
33691 "type" : "string",
33692 "example" : "400"
33693 }
33694 }
33695 }
33696 }
33697 }
33698 },
33699 "Default404ResponseBody" : {
33700 "required" : [ "errors" ],
33701 "type" : "object",
33702 "properties" : {
33703 "errors" : {
33704 "type" : "array",
33705 "items" : {
33706 "required" : [ "status" ],
33707 "type" : "object",
33708 "properties" : {
33709 "detail" : {
33710 "type" : "string",
33711 "example" : "Resource not found"
33712 },
33713 "status" : {
33714 "type" : "string",
33715 "example" : "404"
33716 }
33717 }
33718 }
33719 }
33720 }
33721 },
33722 "Default405ResponseBody" : {
33723 "required" : [ "errors" ],
33724 "type" : "object",
33725 "properties" : {
33726 "errors" : {
33727 "type" : "array",
33728 "items" : {
33729 "required" : [ "status" ],
33730 "type" : "object",
33731 "properties" : {
33732 "detail" : {
33733 "type" : "string",
33734 "example" : "HTTP method not allowed"
33735 },
33736 "status" : {
33737 "type" : "string",
33738 "example" : "405"
33739 }
33740 }
33741 }
33742 }
33743 }
33744 },
33745 "Default406ResponseBody" : {
33746 "required" : [ "errors" ],
33747 "type" : "object",
33748 "properties" : {
33749 "errors" : {
33750 "type" : "array",
33751 "items" : {
33752 "required" : [ "status" ],
33753 "type" : "object",
33754 "properties" : {
33755 "detail" : {
33756 "type" : "string",
33757 "example" : "No acceptable response media type"
33758 },
33759 "status" : {
33760 "type" : "string",
33761 "example" : "406"
33762 }
33763 }
33764 }
33765 }
33766 }
33767 },
33768 "Default415ResponseBody" : {
33769 "required" : [ "errors" ],
33770 "type" : "object",
33771 "properties" : {
33772 "errors" : {
33773 "type" : "array",
33774 "items" : {
33775 "required" : [ "status" ],
33776 "type" : "object",
33777 "properties" : {
33778 "detail" : {
33779 "type" : "string",
33780 "example" : "Unsupported request media type or encoding"
33781 },
33782 "status" : {
33783 "type" : "string",
33784 "example" : "415"
33785 }
33786 }
33787 }
33788 }
33789 }
33790 },
33791 "Default429ResponseBody" : {
33792 "required" : [ "errors" ],
33793 "type" : "object",
33794 "properties" : {
33795 "errors" : {
33796 "type" : "array",
33797 "items" : {
33798 "required" : [ "status" ],
33799 "type" : "object",
33800 "properties" : {
33801 "detail" : {
33802 "type" : "string",
33803 "example" : "Rate limit exceeded"
33804 },
33805 "status" : {
33806 "type" : "string",
33807 "example" : "429"
33808 }
33809 }
33810 }
33811 }
33812 }
33813 },
33814 "Default500ResponseBody" : {
33815 "required" : [ "errors" ],
33816 "type" : "object",
33817 "properties" : {
33818 "errors" : {
33819 "type" : "array",
33820 "items" : {
33821 "required" : [ "status" ],
33822 "type" : "object",
33823 "properties" : {
33824 "detail" : {
33825 "type" : "string",
33826 "example" : "Internal server error"
33827 },
33828 "status" : {
33829 "type" : "string",
33830 "example" : "500"
33831 }
33832 }
33833 }
33834 }
33835 }
33836 },
33837 "Default503ResponseBody" : {
33838 "required" : [ "errors" ],
33839 "type" : "object",
33840 "properties" : {
33841 "errors" : {
33842 "type" : "array",
33843 "items" : {
33844 "required" : [ "status" ],
33845 "type" : "object",
33846 "properties" : {
33847 "detail" : {
33848 "type" : "string",
33849 "example" : "Service temporarily unavailable"
33850 },
33851 "status" : {
33852 "type" : "string",
33853 "example" : "503"
33854 }
33855 }
33856 }
33857 }
33858 }
33859 },
33860 "Download_Link" : {
33861 "required" : [ "href", "meta" ],
33862 "type" : "object",
33863 "properties" : {
33864 "href" : {
33865 "type" : "string",
33866 "description" : "URL to download the content from"
33867 },
33868 "meta" : {
33869 "$ref" : "#/components/schemas/Download_Link_Meta"
33870 }
33871 }
33872 },
33873 "Download_Link_Meta" : {
33874 "type" : "object",
33875 "properties" : {
33876 "requiredHeaders" : {
33877 "type" : "array",
33878 "description" : "HTTP headers required when requesting the download URL",
33879 "items" : {
33880 "type" : "string",
33881 "description" : "HTTP headers required when requesting the download URL"
33882 }
33883 }
33884 },
33885 "description" : "Metadata for download link"
33886 },
33887 "Downloads_Attributes" : {
33888 "type" : "object",
33889 "properties" : {
33890 "downloadLinks" : {
33891 "type" : "array",
33892 "items" : {
33893 "$ref" : "#/components/schemas/Download_Link"
33894 }
33895 }
33896 }
33897 },
33898 "Downloads_Multi_Relationship_Data_Document" : {
33899 "required" : [ "links" ],
33900 "type" : "object",
33901 "properties" : {
33902 "data" : {
33903 "type" : "array",
33904 "items" : {
33905 "$ref" : "#/components/schemas/Resource_Identifier"
33906 }
33907 },
33908 "included" : {
33909 "$ref" : "#/components/schemas/Included"
33910 },
33911 "links" : {
33912 "$ref" : "#/components/schemas/Links"
33913 }
33914 }
33915 },
33916 "Downloads_Multi_Resource_Data_Document" : {
33917 "required" : [ "data", "links" ],
33918 "type" : "object",
33919 "properties" : {
33920 "data" : {
33921 "type" : "array",
33922 "items" : {
33923 "$ref" : "#/components/schemas/Downloads_Resource_Object"
33924 }
33925 },
33926 "included" : {
33927 "$ref" : "#/components/schemas/Included"
33928 },
33929 "links" : {
33930 "$ref" : "#/components/schemas/Links"
33931 }
33932 }
33933 },
33934 "Downloads_Relationships" : {
33935 "properties" : {
33936 "owners" : {
33937 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
33938 }
33939 }
33940 },
33941 "Downloads_Resource_Object" : {
33942 "required" : [ "id", "type" ],
33943 "type" : "object",
33944 "properties" : {
33945 "attributes" : {
33946 "$ref" : "#/components/schemas/Downloads_Attributes"
33947 },
33948 "id" : {
33949 "type" : "string",
33950 "description" : "Resource id",
33951 "example" : "12345"
33952 },
33953 "relationships" : {
33954 "$ref" : "#/components/schemas/Downloads_Relationships"
33955 },
33956 "type" : {
33957 "minLength" : 1,
33958 "type" : "string",
33959 "description" : "Resource type",
33960 "example" : "tracks"
33961 }
33962 }
33963 },
33964 "Downloads_Single_Resource_Data_Document" : {
33965 "required" : [ "data", "links" ],
33966 "type" : "object",
33967 "properties" : {
33968 "data" : {
33969 "$ref" : "#/components/schemas/Downloads_Resource_Object"
33970 },
33971 "included" : {
33972 "$ref" : "#/components/schemas/Included"
33973 },
33974 "links" : {
33975 "$ref" : "#/components/schemas/Links"
33976 }
33977 }
33978 },
33979 "DrmData" : {
33980 "type" : "object",
33981 "properties" : {
33982 "certificateUrl" : {
33983 "type" : "string"
33984 },
33985 "drmSystem" : {
33986 "type" : "string",
33987 "enum" : [ "FAIRPLAY", "WIDEVINE" ]
33988 },
33989 "initData" : {
33990 "type" : "array",
33991 "items" : {
33992 "type" : "string"
33993 }
33994 },
33995 "licenseUrl" : {
33996 "type" : "string"
33997 }
33998 },
33999 "description" : "DRM data. Absence implies no DRM."
34000 },
34001 "DspSharingLinks_Attributes" : {
34002 "type" : "object",
34003 "properties" : {
34004 "amazonMusic" : {
34005 "$ref" : "#/components/schemas/Link_Object"
34006 },
34007 "appleMusic" : {
34008 "$ref" : "#/components/schemas/Link_Object"
34009 },
34010 "spotify" : {
34011 "$ref" : "#/components/schemas/Link_Object"
34012 },
34013 "youTubeMusic" : {
34014 "$ref" : "#/components/schemas/Link_Object"
34015 }
34016 }
34017 },
34018 "DspSharingLinks_Multi_Resource_Data_Document" : {
34019 "required" : [ "data", "links" ],
34020 "type" : "object",
34021 "properties" : {
34022 "data" : {
34023 "type" : "array",
34024 "items" : {
34025 "$ref" : "#/components/schemas/DspSharingLinks_Resource_Object"
34026 }
34027 },
34028 "included" : {
34029 "$ref" : "#/components/schemas/Included"
34030 },
34031 "links" : {
34032 "$ref" : "#/components/schemas/Links"
34033 }
34034 }
34035 },
34036 "DspSharingLinks_Relationships" : {
34037 "properties" : {
34038 "subject" : {
34039 "$ref" : "#/components/schemas/DspSharingLinks_Subject_Single_Relationship_Data_Document"
34040 }
34041 }
34042 },
34043 "DspSharingLinks_Resource_Object" : {
34044 "required" : [ "id", "type" ],
34045 "type" : "object",
34046 "properties" : {
34047 "attributes" : {
34048 "$ref" : "#/components/schemas/DspSharingLinks_Attributes"
34049 },
34050 "id" : {
34051 "type" : "string",
34052 "description" : "Resource id",
34053 "example" : "12345"
34054 },
34055 "relationships" : {
34056 "$ref" : "#/components/schemas/DspSharingLinks_Relationships"
34057 },
34058 "type" : {
34059 "minLength" : 1,
34060 "type" : "string",
34061 "description" : "Resource type",
34062 "example" : "tracks"
34063 }
34064 }
34065 },
34066 "DspSharingLinks_Single_Relationship_Data_Document" : {
34067 "required" : [ "links" ],
34068 "type" : "object",
34069 "properties" : {
34070 "data" : {
34071 "oneOf" : [ {
34072 "$ref" : "#/components/schemas/Resource_Identifier"
34073 }, {
34074 "type" : "object",
34075 "nullable" : true,
34076 "enum" : [ null ]
34077 } ]
34078 },
34079 "included" : {
34080 "$ref" : "#/components/schemas/Included"
34081 },
34082 "links" : {
34083 "$ref" : "#/components/schemas/Links"
34084 }
34085 }
34086 },
34087 "DspSharingLinks_Subject_Resource_Identifier" : {
34088 "required" : [ "id", "type" ],
34089 "type" : "object",
34090 "properties" : {
34091 "id" : {
34092 "type" : "string",
34093 "description" : "Resource id",
34094 "example" : "12345"
34095 },
34096 "meta" : {
34097 "$ref" : "#/components/schemas/DspSharingLinks_Subject_Resource_Identifier_Meta"
34098 },
34099 "type" : {
34100 "type" : "string",
34101 "description" : "Resource type",
34102 "example" : "tracks"
34103 }
34104 }
34105 },
34106 "DspSharingLinks_Subject_Resource_Identifier_Meta" : {
34107 "type" : "object",
34108 "properties" : {
34109 "replacement" : {
34110 "$ref" : "#/components/schemas/Replacement_Provenance"
34111 }
34112 }
34113 },
34114 "DspSharingLinks_Subject_Single_Relationship_Data_Document" : {
34115 "required" : [ "links" ],
34116 "type" : "object",
34117 "properties" : {
34118 "data" : {
34119 "oneOf" : [ {
34120 "$ref" : "#/components/schemas/DspSharingLinks_Subject_Resource_Identifier"
34121 }, {
34122 "type" : "object",
34123 "nullable" : true,
34124 "enum" : [ null ]
34125 } ]
34126 },
34127 "included" : {
34128 "$ref" : "#/components/schemas/Included"
34129 },
34130 "links" : {
34131 "$ref" : "#/components/schemas/Links"
34132 }
34133 }
34134 },
34135 "DynamicModules_Attributes" : {
34136 "required" : [ "icons", "previewLayout" ],
34137 "type" : "object",
34138 "properties" : {
34139 "icons" : {
34140 "type" : "array",
34141 "description" : "Semantic icons the module should show. SPOTLIGHT_INFO identifies modules whose content was selected by TIDAL's editorial team.",
34142 "example" : "SPOTLIGHT_INFO",
34143 "items" : {
34144 "type" : "string",
34145 "description" : "Semantic icons the module should show. SPOTLIGHT_INFO identifies modules whose content was selected by TIDAL's editorial team.",
34146 "example" : "SPOTLIGHT_INFO",
34147 "enum" : [ "SPOTLIGHT_INFO", "UNKNOWN" ]
34148 }
34149 },
34150 "previewLayout" : {
34151 "type" : "string",
34152 "description" : "Rendering layout for a dynamic module. previewLayout controls the module on a dynamic page. viewAllLayout controls its view-all screen; when omitted, the module has no view-all screen. GRID means artwork-forward tiles; the client owns scroll axis and column count. LIST means detailed text-forward rows in a single column and may be a table on wide screens. COMPACT means dense rows the client may pack into multiple columns; clients should treat it as LIST in a full view. UNKNOWN is the forward-compatible default; clients should skip the module or use a safe default.",
34153 "example" : "GRID",
34154 "enum" : [ "GRID", "LIST", "COMPACT", "UNKNOWN" ]
34155 },
34156 "subtitle" : {
34157 "type" : "string",
34158 "description" : "Subtitle of the module",
34159 "example" : "Short description of this module"
34160 },
34161 "title" : {
34162 "type" : "string",
34163 "description" : "Title of the module",
34164 "example" : "Shortcuts"
34165 },
34166 "viewAllLayout" : {
34167 "type" : "string",
34168 "description" : "Rendering layout for a dynamic module. previewLayout controls the module on a dynamic page. viewAllLayout controls its view-all screen; when omitted, the module has no view-all screen. GRID means artwork-forward tiles; the client owns scroll axis and column count. LIST means detailed text-forward rows in a single column and may be a table on wide screens. COMPACT means dense rows the client may pack into multiple columns; clients should treat it as LIST in a full view. UNKNOWN is the forward-compatible default; clients should skip the module or use a safe default.",
34169 "example" : "LIST",
34170 "enum" : [ "GRID", "LIST", "COMPACT", "UNKNOWN" ]
34171 }
34172 }
34173 },
34174 "DynamicModules_Items_Multi_Relationship_Data_Document" : {
34175 "required" : [ "links" ],
34176 "type" : "object",
34177 "properties" : {
34178 "data" : {
34179 "type" : "array",
34180 "items" : {
34181 "$ref" : "#/components/schemas/DynamicModules_Items_Resource_Identifier"
34182 }
34183 },
34184 "included" : {
34185 "$ref" : "#/components/schemas/Included"
34186 },
34187 "links" : {
34188 "$ref" : "#/components/schemas/Links"
34189 }
34190 }
34191 },
34192 "DynamicModules_Items_Resource_Identifier" : {
34193 "required" : [ "id", "type" ],
34194 "type" : "object",
34195 "properties" : {
34196 "id" : {
34197 "type" : "string",
34198 "description" : "Resource id",
34199 "example" : "12345"
34200 },
34201 "meta" : {
34202 "$ref" : "#/components/schemas/DynamicModules_Items_Resource_Identifier_Meta"
34203 },
34204 "type" : {
34205 "type" : "string",
34206 "description" : "Resource type",
34207 "example" : "tracks"
34208 }
34209 }
34210 },
34211 "DynamicModules_Items_Resource_Identifier_Meta" : {
34212 "type" : "object",
34213 "properties" : {
34214 "replacement" : {
34215 "$ref" : "#/components/schemas/Replacement_Provenance"
34216 }
34217 }
34218 },
34219 "DynamicModules_Multi_Relationship_Data_Document" : {
34220 "required" : [ "links" ],
34221 "type" : "object",
34222 "properties" : {
34223 "data" : {
34224 "type" : "array",
34225 "items" : {
34226 "$ref" : "#/components/schemas/Resource_Identifier"
34227 }
34228 },
34229 "included" : {
34230 "$ref" : "#/components/schemas/Included"
34231 },
34232 "links" : {
34233 "$ref" : "#/components/schemas/Links"
34234 }
34235 }
34236 },
34237 "DynamicModules_Multi_Resource_Data_Document" : {
34238 "required" : [ "data", "links" ],
34239 "type" : "object",
34240 "properties" : {
34241 "data" : {
34242 "type" : "array",
34243 "items" : {
34244 "$ref" : "#/components/schemas/DynamicModules_Resource_Object"
34245 }
34246 },
34247 "included" : {
34248 "$ref" : "#/components/schemas/Included"
34249 },
34250 "links" : {
34251 "$ref" : "#/components/schemas/Links"
34252 }
34253 }
34254 },
34255 "DynamicModules_Relationships" : {
34256 "properties" : {
34257 "items" : {
34258 "$ref" : "#/components/schemas/DynamicModules_Items_Multi_Relationship_Data_Document"
34259 },
34260 "seedItem" : {
34261 "$ref" : "#/components/schemas/DynamicModules_SeedItem_Single_Relationship_Data_Document"
34262 }
34263 }
34264 },
34265 "DynamicModules_Resource_Object" : {
34266 "required" : [ "id", "type" ],
34267 "type" : "object",
34268 "properties" : {
34269 "attributes" : {
34270 "$ref" : "#/components/schemas/DynamicModules_Attributes"
34271 },
34272 "id" : {
34273 "type" : "string",
34274 "description" : "Resource id",
34275 "example" : "12345"
34276 },
34277 "relationships" : {
34278 "$ref" : "#/components/schemas/DynamicModules_Relationships"
34279 },
34280 "type" : {
34281 "minLength" : 1,
34282 "type" : "string",
34283 "description" : "Resource type",
34284 "example" : "tracks"
34285 }
34286 }
34287 },
34288 "DynamicModules_SeedItem_Resource_Identifier" : {
34289 "required" : [ "id", "type" ],
34290 "type" : "object",
34291 "properties" : {
34292 "id" : {
34293 "type" : "string",
34294 "description" : "Resource id",
34295 "example" : "12345"
34296 },
34297 "meta" : {
34298 "$ref" : "#/components/schemas/DynamicModules_SeedItem_Resource_Identifier_Meta"
34299 },
34300 "type" : {
34301 "type" : "string",
34302 "description" : "Resource type",
34303 "example" : "tracks"
34304 }
34305 }
34306 },
34307 "DynamicModules_SeedItem_Resource_Identifier_Meta" : {
34308 "type" : "object",
34309 "properties" : {
34310 "replacement" : {
34311 "$ref" : "#/components/schemas/Replacement_Provenance"
34312 }
34313 }
34314 },
34315 "DynamicModules_SeedItem_Single_Relationship_Data_Document" : {
34316 "required" : [ "links" ],
34317 "type" : "object",
34318 "properties" : {
34319 "data" : {
34320 "oneOf" : [ {
34321 "$ref" : "#/components/schemas/DynamicModules_SeedItem_Resource_Identifier"
34322 }, {
34323 "type" : "object",
34324 "nullable" : true,
34325 "enum" : [ null ]
34326 } ]
34327 },
34328 "included" : {
34329 "$ref" : "#/components/schemas/Included"
34330 },
34331 "links" : {
34332 "$ref" : "#/components/schemas/Links"
34333 }
34334 }
34335 },
34336 "DynamicModules_Single_Relationship_Data_Document" : {
34337 "required" : [ "links" ],
34338 "type" : "object",
34339 "properties" : {
34340 "data" : {
34341 "oneOf" : [ {
34342 "$ref" : "#/components/schemas/Resource_Identifier"
34343 }, {
34344 "type" : "object",
34345 "nullable" : true,
34346 "enum" : [ null ]
34347 } ]
34348 },
34349 "included" : {
34350 "$ref" : "#/components/schemas/Included"
34351 },
34352 "links" : {
34353 "$ref" : "#/components/schemas/Links"
34354 }
34355 }
34356 },
34357 "DynamicModules_Single_Resource_Data_Document" : {
34358 "required" : [ "data", "links" ],
34359 "type" : "object",
34360 "properties" : {
34361 "data" : {
34362 "$ref" : "#/components/schemas/DynamicModules_Resource_Object"
34363 },
34364 "included" : {
34365 "$ref" : "#/components/schemas/Included"
34366 },
34367 "links" : {
34368 "$ref" : "#/components/schemas/Links"
34369 }
34370 }
34371 },
34372 "DynamicPages_Attributes" : {
34373 "required" : [ "pageType", "reportingId" ],
34374 "type" : "object",
34375 "properties" : {
34376 "pageType" : {
34377 "type" : "string",
34378 "description" : "Type of the page eg. home, artist",
34379 "example" : "HOME_STATIC",
34380 "enum" : [ "HOME_STATIC", "HOME_UPLOADS", "HOME_EDITORIAL", "HOME_FREE", "ARTIST", "ALBUM", "PLAYLIST", "TRACK", "VIDEO" ]
34381 },
34382 "reportingId" : {
34383 "type" : "string",
34384 "description" : "Id used for reporting user events",
34385 "format" : "uuid",
34386 "example" : "83c92ac0-b8e3-4e28-9e27-07909dcde1e5"
34387 }
34388 }
34389 },
34390 "DynamicPages_Multi_Relationship_Data_Document" : {
34391 "required" : [ "links" ],
34392 "type" : "object",
34393 "properties" : {
34394 "data" : {
34395 "type" : "array",
34396 "items" : {
34397 "$ref" : "#/components/schemas/Resource_Identifier"
34398 }
34399 },
34400 "included" : {
34401 "$ref" : "#/components/schemas/Included"
34402 },
34403 "links" : {
34404 "$ref" : "#/components/schemas/Links"
34405 }
34406 }
34407 },
34408 "DynamicPages_Multi_Resource_Data_Document" : {
34409 "required" : [ "data", "links" ],
34410 "type" : "object",
34411 "properties" : {
34412 "data" : {
34413 "type" : "array",
34414 "items" : {
34415 "$ref" : "#/components/schemas/DynamicPages_Resource_Object"
34416 }
34417 },
34418 "included" : {
34419 "$ref" : "#/components/schemas/Included"
34420 },
34421 "links" : {
34422 "$ref" : "#/components/schemas/Links"
34423 }
34424 }
34425 },
34426 "DynamicPages_Relationships" : {
34427 "properties" : {
34428 "modules" : {
34429 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
34430 },
34431 "subject" : {
34432 "$ref" : "#/components/schemas/DynamicPages_Subject_Single_Relationship_Data_Document"
34433 }
34434 }
34435 },
34436 "DynamicPages_Resource_Object" : {
34437 "required" : [ "id", "type" ],
34438 "type" : "object",
34439 "properties" : {
34440 "attributes" : {
34441 "$ref" : "#/components/schemas/DynamicPages_Attributes"
34442 },
34443 "id" : {
34444 "type" : "string",
34445 "description" : "Resource id",
34446 "example" : "12345"
34447 },
34448 "meta" : {
34449 "$ref" : "#/components/schemas/DynamicPages_Resource_Object_Meta"
34450 },
34451 "relationships" : {
34452 "$ref" : "#/components/schemas/DynamicPages_Relationships"
34453 },
34454 "type" : {
34455 "minLength" : 1,
34456 "type" : "string",
34457 "description" : "Resource type",
34458 "example" : "tracks"
34459 }
34460 }
34461 },
34462 "DynamicPages_Resource_Object_Meta" : {
34463 "type" : "object",
34464 "properties" : {
34465 "redactionReason" : {
34466 "type" : "string",
34467 "description" : "Reason why data has been redacted on this page",
34468 "enum" : [ "NO_BIRTHDAY", "MINOR" ]
34469 }
34470 }
34471 },
34472 "DynamicPages_Single_Relationship_Data_Document" : {
34473 "required" : [ "links" ],
34474 "type" : "object",
34475 "properties" : {
34476 "data" : {
34477 "oneOf" : [ {
34478 "$ref" : "#/components/schemas/Resource_Identifier"
34479 }, {
34480 "type" : "object",
34481 "nullable" : true,
34482 "enum" : [ null ]
34483 } ]
34484 },
34485 "included" : {
34486 "$ref" : "#/components/schemas/Included"
34487 },
34488 "links" : {
34489 "$ref" : "#/components/schemas/Links"
34490 }
34491 }
34492 },
34493 "DynamicPages_Subject_Resource_Identifier" : {
34494 "required" : [ "id", "type" ],
34495 "type" : "object",
34496 "properties" : {
34497 "id" : {
34498 "type" : "string",
34499 "description" : "Resource id",
34500 "example" : "12345"
34501 },
34502 "meta" : {
34503 "$ref" : "#/components/schemas/DynamicPages_Subject_Resource_Identifier_Meta"
34504 },
34505 "type" : {
34506 "type" : "string",
34507 "description" : "Resource type",
34508 "example" : "tracks"
34509 }
34510 }
34511 },
34512 "DynamicPages_Subject_Resource_Identifier_Meta" : {
34513 "type" : "object",
34514 "properties" : {
34515 "replacement" : {
34516 "$ref" : "#/components/schemas/Replacement_Provenance"
34517 }
34518 }
34519 },
34520 "DynamicPages_Subject_Single_Relationship_Data_Document" : {
34521 "required" : [ "links" ],
34522 "type" : "object",
34523 "properties" : {
34524 "data" : {
34525 "oneOf" : [ {
34526 "$ref" : "#/components/schemas/DynamicPages_Subject_Resource_Identifier"
34527 }, {
34528 "type" : "object",
34529 "nullable" : true,
34530 "enum" : [ null ]
34531 } ]
34532 },
34533 "included" : {
34534 "$ref" : "#/components/schemas/Included"
34535 },
34536 "links" : {
34537 "$ref" : "#/components/schemas/Links"
34538 }
34539 }
34540 },
34541 "Error_Object" : {
34542 "type" : "object",
34543 "properties" : {
34544 "code" : {
34545 "type" : "string",
34546 "description" : "application-specific error code"
34547 },
34548 "detail" : {
34549 "type" : "string",
34550 "description" : "human-readable explanation specific to this occurrence of the problem"
34551 },
34552 "id" : {
34553 "type" : "string",
34554 "description" : "unique identifier for this particular occurrence of the problem"
34555 },
34556 "source" : {
34557 "$ref" : "#/components/schemas/Error_Object_Source"
34558 },
34559 "status" : {
34560 "type" : "string",
34561 "description" : "HTTP status code applicable to this problem"
34562 }
34563 }
34564 },
34565 "Error_Object_Source" : {
34566 "type" : "object",
34567 "properties" : {
34568 "header" : {
34569 "type" : "string",
34570 "description" : "string indicating the name of a single request header which caused the error",
34571 "example" : "X-some-custom-header"
34572 },
34573 "parameter" : {
34574 "type" : "string",
34575 "description" : "string indicating which URI query parameter caused the error.",
34576 "example" : "countryCode"
34577 },
34578 "pointer" : {
34579 "type" : "string",
34580 "description" : "a JSON Pointer [RFC6901] to the value in the request document that caused the error",
34581 "example" : "/data/attributes/title"
34582 }
34583 }
34584 },
34585 "Errors_Document" : {
34586 "type" : "object",
34587 "properties" : {
34588 "errors" : {
34589 "type" : "array",
34590 "description" : "Array of error objects",
34591 "items" : {
34592 "$ref" : "#/components/schemas/Error_Object"
34593 }
34594 },
34595 "links" : {
34596 "$ref" : "#/components/schemas/Links"
34597 }
34598 }
34599 },
34600 "External_Link" : {
34601 "required" : [ "href", "meta" ],
34602 "type" : "object",
34603 "properties" : {
34604 "href" : {
34605 "type" : "string"
34606 },
34607 "meta" : {
34608 "$ref" : "#/components/schemas/External_Link_Meta"
34609 }
34610 }
34611 },
34612 "External_Link_Meta" : {
34613 "required" : [ "type" ],
34614 "type" : "object",
34615 "properties" : {
34616 "type" : {
34617 "type" : "string",
34618 "enum" : [ "TIDAL_SHARING", "TIDAL_USER_SHARING", "TIDAL_AUTOPLAY_ANDROID", "TIDAL_AUTOPLAY_IOS", "TIDAL_AUTOPLAY_WEB", "TWITTER", "FACEBOOK", "INSTAGRAM", "TIKTOK", "SNAPCHAT", "OFFICIAL_HOMEPAGE", "CASHAPP_CONTRIBUTIONS", "ARTIST_CLAIM_PROVIDER_REDIRECT", "STRIPE_AUTHORIZATION_REDIRECT", "SQUARE_AUTHORIZATION_REDIRECT" ]
34619 }
34620 },
34621 "description" : "metadata about an external link"
34622 },
34623 "External_Link_Payload" : {
34624 "required" : [ "meta" ],
34625 "type" : "object",
34626 "properties" : {
34627 "href" : {
34628 "type" : "string"
34629 },
34630 "meta" : {
34631 "$ref" : "#/components/schemas/External_Link_Meta"
34632 }
34633 }
34634 },
34635 "File_Status" : {
34636 "required" : [ "moderationFileStatus", "technicalFileStatus" ],
34637 "type" : "object",
34638 "properties" : {
34639 "aiScanningFileStatus" : {
34640 "type" : "string",
34641 "description" : "Status of scanning the file for being AI-generated. Only present for file types that support AI scanning (e.g. track source files) and when a scanning status is available for the file; absent otherwise.",
34642 "enum" : [ "NOT_SCANNED", "SCANNING", "IS_AI", "NOT_AI", "ERROR" ]
34643 },
34644 "moderationFileStatus" : {
34645 "type" : "string",
34646 "description" : "Moderation status for file",
34647 "enum" : [ "NOT_MODERATED", "SCANNING", "FLAGGED", "TAKEN_DOWN", "OK", "ERROR" ]
34648 },
34649 "technicalFileStatus" : {
34650 "type" : "string",
34651 "description" : "Technical status for file",
34652 "enum" : [ "UPLOAD_REQUESTED", "PROCESSING", "OK", "ERROR", "DELETED" ]
34653 }
34654 },
34655 "description" : "File status"
34656 },
34657 "File_Upload_Link" : {
34658 "required" : [ "href", "meta" ],
34659 "type" : "object",
34660 "properties" : {
34661 "href" : {
34662 "type" : "string",
34663 "description" : "Href to upload actual file to"
34664 },
34665 "meta" : {
34666 "$ref" : "#/components/schemas/File_Upload_Link_Meta"
34667 }
34668 },
34669 "description" : "Upload link"
34670 },
34671 "File_Upload_Link_Meta" : {
34672 "required" : [ "method" ],
34673 "type" : "object",
34674 "properties" : {
34675 "headers" : {
34676 "type" : "object",
34677 "additionalProperties" : {
34678 "type" : "string",
34679 "description" : "HTTP headers that must be added to the operation"
34680 },
34681 "description" : "HTTP headers that must be added to the operation"
34682 },
34683 "method" : {
34684 "type" : "string",
34685 "description" : "HTTP method"
34686 }
34687 },
34688 "description" : "metadata for upload link"
34689 },
34690 "Genres_Attributes" : {
34691 "required" : [ "genreName" ],
34692 "type" : "object",
34693 "properties" : {
34694 "genreName" : {
34695 "type" : "string",
34696 "description" : "Genre name",
34697 "example" : "pop"
34698 }
34699 }
34700 },
34701 "Genres_Multi_Resource_Data_Document" : {
34702 "required" : [ "data", "links" ],
34703 "type" : "object",
34704 "properties" : {
34705 "data" : {
34706 "type" : "array",
34707 "items" : {
34708 "$ref" : "#/components/schemas/Genres_Resource_Object"
34709 }
34710 },
34711 "included" : {
34712 "$ref" : "#/components/schemas/Included"
34713 },
34714 "links" : {
34715 "$ref" : "#/components/schemas/Links"
34716 }
34717 }
34718 },
34719 "Genres_Resource_Object" : {
34720 "required" : [ "id", "type" ],
34721 "type" : "object",
34722 "properties" : {
34723 "attributes" : {
34724 "$ref" : "#/components/schemas/Genres_Attributes"
34725 },
34726 "id" : {
34727 "type" : "string",
34728 "description" : "Resource id",
34729 "example" : "12345"
34730 },
34731 "type" : {
34732 "minLength" : 1,
34733 "type" : "string",
34734 "description" : "Resource type",
34735 "example" : "tracks"
34736 }
34737 }
34738 },
34739 "Genres_Single_Resource_Data_Document" : {
34740 "required" : [ "data", "links" ],
34741 "type" : "object",
34742 "properties" : {
34743 "data" : {
34744 "$ref" : "#/components/schemas/Genres_Resource_Object"
34745 },
34746 "included" : {
34747 "$ref" : "#/components/schemas/Included"
34748 },
34749 "links" : {
34750 "$ref" : "#/components/schemas/Links"
34751 }
34752 }
34753 },
34754 "Idempotency409ResponseBody" : {
34755 "required" : [ "errors" ],
34756 "type" : "object",
34757 "properties" : {
34758 "errors" : {
34759 "type" : "array",
34760 "items" : {
34761 "required" : [ "code", "status" ],
34762 "type" : "object",
34763 "properties" : {
34764 "code" : {
34765 "type" : "string",
34766 "example" : "IDEMPOTENT_REQUEST_IN_PROGRESS",
34767 "enum" : [ "IDEMPOTENT_REQUEST_IN_PROGRESS" ]
34768 },
34769 "detail" : {
34770 "type" : "string",
34771 "example" : "Request already in progress for this idempotency key"
34772 },
34773 "status" : {
34774 "type" : "string",
34775 "example" : "409"
34776 }
34777 }
34778 }
34779 }
34780 }
34781 },
34782 "Idempotency422ResponseBody" : {
34783 "required" : [ "errors" ],
34784 "type" : "object",
34785 "properties" : {
34786 "errors" : {
34787 "type" : "array",
34788 "items" : {
34789 "required" : [ "code", "status" ],
34790 "type" : "object",
34791 "properties" : {
34792 "code" : {
34793 "type" : "string",
34794 "example" : "IDEMPOTENT_REQUEST_PAYLOAD_MISMATCH",
34795 "enum" : [ "IDEMPOTENT_REQUEST_PAYLOAD_MISMATCH" ]
34796 },
34797 "detail" : {
34798 "type" : "string",
34799 "example" : "Idempotency key reused with a different payload"
34800 },
34801 "status" : {
34802 "type" : "string",
34803 "example" : "422"
34804 }
34805 }
34806 }
34807 }
34808 }
34809 },
34810 "Included" : {
34811 "type" : "array",
34812 "items" : {
34813 "discriminator" : {
34814 "mapping" : {
34815 "acceptedTerms" : "#/components/schemas/AcceptedTerms_Resource_Object",
34816 "albumStatistics" : "#/components/schemas/AlbumStatistics_Resource_Object",
34817 "albums" : "#/components/schemas/Albums_Resource_Object",
34818 "appreciations" : "#/components/schemas/Appreciations_Resource_Object",
34819 "artistBiographies" : "#/components/schemas/ArtistBiographies_Resource_Object",
34820 "artistClaimStatuses" : "#/components/schemas/ArtistClaimStatuses_Resource_Object",
34821 "artistClaims" : "#/components/schemas/ArtistClaims_Resource_Object",
34822 "artistRoles" : "#/components/schemas/ArtistRoles_Resource_Object",
34823 "artists" : "#/components/schemas/Artists_Resource_Object",
34824 "artworks" : "#/components/schemas/Artworks_Resource_Object",
34825 "clients" : "#/components/schemas/Clients_Resource_Object",
34826 "collaborationInviteRedemptions" : "#/components/schemas/CollaborationInviteRedemptions_Resource_Object",
34827 "collaborationInvites" : "#/components/schemas/CollaborationInvites_Resource_Object",
34828 "comments" : "#/components/schemas/Comments_Resource_Object",
34829 "contentClaims" : "#/components/schemas/ContentClaims_Resource_Object",
34830 "credits" : "#/components/schemas/Credits_Resource_Object",
34831 "downloads" : "#/components/schemas/Downloads_Resource_Object",
34832 "dspSharingLinks" : "#/components/schemas/DspSharingLinks_Resource_Object",
34833 "dynamicModules" : "#/components/schemas/DynamicModules_Resource_Object",
34834 "dynamicPages" : "#/components/schemas/DynamicPages_Resource_Object",
34835 "genres" : "#/components/schemas/Genres_Resource_Object",
34836 "installations" : "#/components/schemas/Installations_Resource_Object",
34837 "lyrics" : "#/components/schemas/Lyrics_Resource_Object",
34838 "manualArtistClaims" : "#/components/schemas/ManualArtistClaims_Resource_Object",
34839 "offlineTasks" : "#/components/schemas/OfflineTasks_Resource_Object",
34840 "playQueues" : "#/components/schemas/PlayQueues_Resource_Object",
34841 "playlists" : "#/components/schemas/Playlists_Resource_Object",
34842 "priceConfigurations" : "#/components/schemas/PriceConfigurations_Resource_Object",
34843 "providerOwners" : "#/components/schemas/ProviderOwners_Resource_Object",
34844 "providerProductInfos" : "#/components/schemas/ProviderProductInfos_Resource_Object",
34845 "providers" : "#/components/schemas/Providers_Resource_Object",
34846 "purchases" : "#/components/schemas/Purchases_Resource_Object",
34847 "reactions" : "#/components/schemas/Reactions_Resource_Object",
34848 "savedShares" : "#/components/schemas/SavedShares_Resource_Object",
34849 "scopes" : "#/components/schemas/Scopes_Resource_Object",
34850 "searchHistoryEntries" : "#/components/schemas/SearchHistoryEntries_Resource_Object",
34851 "searchResults" : "#/components/schemas/SearchResults_Resource_Object",
34852 "searchSuggestions" : "#/components/schemas/SearchSuggestions_Resource_Object",
34853 "shares" : "#/components/schemas/Shares_Resource_Object",
34854 "squareConnections" : "#/components/schemas/SquareConnections_Resource_Object",
34855 "squareSites" : "#/components/schemas/SquareSites_Resource_Object",
34856 "stripeConnections" : "#/components/schemas/StripeConnections_Resource_Object",
34857 "stripeDashboardLinks" : "#/components/schemas/StripeDashboardLinks_Resource_Object",
34858 "subscriptionPriceChangeDecisions" : "#/components/schemas/SubscriptionPriceChangeDecisions_Resource_Object",
34859 "temporaryUserTokens" : "#/components/schemas/TemporaryUserTokens_Resource_Object",
34860 "terms" : "#/components/schemas/Terms_Resource_Object",
34861 "trackFiles" : "#/components/schemas/TrackFiles_Resource_Object",
34862 "trackManifests" : "#/components/schemas/TrackManifests_Resource_Object",
34863 "trackSourceFiles" : "#/components/schemas/TrackSourceFiles_Resource_Object",
34864 "trackStatistics" : "#/components/schemas/TrackStatistics_Resource_Object",
34865 "tracks" : "#/components/schemas/Tracks_Resource_Object",
34866 "tracksMetadataStatus" : "#/components/schemas/TracksMetadataStatus_Resource_Object",
34867 "usageRules" : "#/components/schemas/UsageRules_Resource_Object",
34868 "userCollectionAlbums" : "#/components/schemas/UserCollectionAlbums_Resource_Object",
34869 "userCollectionArtists" : "#/components/schemas/UserCollectionArtists_Resource_Object",
34870 "userCollectionFolders" : "#/components/schemas/UserCollectionFolders_Resource_Object",
34871 "userCollectionPlaylists" : "#/components/schemas/UserCollectionPlaylists_Resource_Object",
34872 "userCollectionSaveForLaters" : "#/components/schemas/UserCollectionSaveForLaters_Resource_Object",
34873 "userCollectionTracks" : "#/components/schemas/UserCollectionTracks_Resource_Object",
34874 "userCollectionVideos" : "#/components/schemas/UserCollectionVideos_Resource_Object",
34875 "userCollections" : "#/components/schemas/UserCollections_Resource_Object",
34876 "userDailyMixes" : "#/components/schemas/UserDailyMixes_Resource_Object",
34877 "userDataExportRequests" : "#/components/schemas/UserDataExportRequests_Resource_Object",
34878 "userDiscoveryMixes" : "#/components/schemas/UserDiscoveryMixes_Resource_Object",
34879 "userNewReleaseMixes" : "#/components/schemas/UserNewReleaseMixes_Resource_Object",
34880 "userOfflineMixes" : "#/components/schemas/UserOfflineMixes_Resource_Object",
34881 "userRecommendationBlocks" : "#/components/schemas/UserRecommendationBlocks_Resource_Object",
34882 "userRecommendations" : "#/components/schemas/UserRecommendations_Resource_Object",
34883 "userReports" : "#/components/schemas/UserReports_Resource_Object",
34884 "userSubscriptionPriceChanges" : "#/components/schemas/UserSubscriptionPriceChanges_Resource_Object",
34885 "users" : "#/components/schemas/Users_Resource_Object",
34886 "videoManifests" : "#/components/schemas/VideoManifests_Resource_Object",
34887 "videos" : "#/components/schemas/Videos_Resource_Object"
34888 },
34889 "propertyName" : "type"
34890 },
34891 "oneOf" : [ {
34892 "$ref" : "#/components/schemas/AcceptedTerms_Resource_Object"
34893 }, {
34894 "$ref" : "#/components/schemas/AlbumStatistics_Resource_Object"
34895 }, {
34896 "$ref" : "#/components/schemas/Albums_Resource_Object"
34897 }, {
34898 "$ref" : "#/components/schemas/Appreciations_Resource_Object"
34899 }, {
34900 "$ref" : "#/components/schemas/ArtistBiographies_Resource_Object"
34901 }, {
34902 "$ref" : "#/components/schemas/ArtistClaimStatuses_Resource_Object"
34903 }, {
34904 "$ref" : "#/components/schemas/ArtistClaims_Resource_Object"
34905 }, {
34906 "$ref" : "#/components/schemas/ArtistRoles_Resource_Object"
34907 }, {
34908 "$ref" : "#/components/schemas/Artists_Resource_Object"
34909 }, {
34910 "$ref" : "#/components/schemas/Artworks_Resource_Object"
34911 }, {
34912 "$ref" : "#/components/schemas/Clients_Resource_Object"
34913 }, {
34914 "$ref" : "#/components/schemas/CollaborationInviteRedemptions_Resource_Object"
34915 }, {
34916 "$ref" : "#/components/schemas/CollaborationInvites_Resource_Object"
34917 }, {
34918 "$ref" : "#/components/schemas/Comments_Resource_Object"
34919 }, {
34920 "$ref" : "#/components/schemas/ContentClaims_Resource_Object"
34921 }, {
34922 "$ref" : "#/components/schemas/Credits_Resource_Object"
34923 }, {
34924 "$ref" : "#/components/schemas/Downloads_Resource_Object"
34925 }, {
34926 "$ref" : "#/components/schemas/DspSharingLinks_Resource_Object"
34927 }, {
34928 "$ref" : "#/components/schemas/DynamicModules_Resource_Object"
34929 }, {
34930 "$ref" : "#/components/schemas/DynamicPages_Resource_Object"
34931 }, {
34932 "$ref" : "#/components/schemas/Genres_Resource_Object"
34933 }, {
34934 "$ref" : "#/components/schemas/Installations_Resource_Object"
34935 }, {
34936 "$ref" : "#/components/schemas/Lyrics_Resource_Object"
34937 }, {
34938 "$ref" : "#/components/schemas/ManualArtistClaims_Resource_Object"
34939 }, {
34940 "$ref" : "#/components/schemas/OfflineTasks_Resource_Object"
34941 }, {
34942 "$ref" : "#/components/schemas/PlayQueues_Resource_Object"
34943 }, {
34944 "$ref" : "#/components/schemas/Playlists_Resource_Object"
34945 }, {
34946 "$ref" : "#/components/schemas/PriceConfigurations_Resource_Object"
34947 }, {
34948 "$ref" : "#/components/schemas/ProviderOwners_Resource_Object"
34949 }, {
34950 "$ref" : "#/components/schemas/ProviderProductInfos_Resource_Object"
34951 }, {
34952 "$ref" : "#/components/schemas/Providers_Resource_Object"
34953 }, {
34954 "$ref" : "#/components/schemas/Purchases_Resource_Object"
34955 }, {
34956 "$ref" : "#/components/schemas/Reactions_Resource_Object"
34957 }, {
34958 "$ref" : "#/components/schemas/SavedShares_Resource_Object"
34959 }, {
34960 "$ref" : "#/components/schemas/Scopes_Resource_Object"
34961 }, {
34962 "$ref" : "#/components/schemas/SearchHistoryEntries_Resource_Object"
34963 }, {
34964 "$ref" : "#/components/schemas/SearchResults_Resource_Object"
34965 }, {
34966 "$ref" : "#/components/schemas/SearchSuggestions_Resource_Object"
34967 }, {
34968 "$ref" : "#/components/schemas/Shares_Resource_Object"
34969 }, {
34970 "$ref" : "#/components/schemas/SquareConnections_Resource_Object"
34971 }, {
34972 "$ref" : "#/components/schemas/SquareSites_Resource_Object"
34973 }, {
34974 "$ref" : "#/components/schemas/StripeConnections_Resource_Object"
34975 }, {
34976 "$ref" : "#/components/schemas/StripeDashboardLinks_Resource_Object"
34977 }, {
34978 "$ref" : "#/components/schemas/SubscriptionPriceChangeDecisions_Resource_Object"
34979 }, {
34980 "$ref" : "#/components/schemas/TemporaryUserTokens_Resource_Object"
34981 }, {
34982 "$ref" : "#/components/schemas/Terms_Resource_Object"
34983 }, {
34984 "$ref" : "#/components/schemas/TrackFiles_Resource_Object"
34985 }, {
34986 "$ref" : "#/components/schemas/TrackManifests_Resource_Object"
34987 }, {
34988 "$ref" : "#/components/schemas/TrackSourceFiles_Resource_Object"
34989 }, {
34990 "$ref" : "#/components/schemas/TrackStatistics_Resource_Object"
34991 }, {
34992 "$ref" : "#/components/schemas/Tracks_Resource_Object"
34993 }, {
34994 "$ref" : "#/components/schemas/TracksMetadataStatus_Resource_Object"
34995 }, {
34996 "$ref" : "#/components/schemas/UsageRules_Resource_Object"
34997 }, {
34998 "$ref" : "#/components/schemas/UserCollectionAlbums_Resource_Object"
34999 }, {
35000 "$ref" : "#/components/schemas/UserCollectionArtists_Resource_Object"
35001 }, {
35002 "$ref" : "#/components/schemas/UserCollectionFolders_Resource_Object"
35003 }, {
35004 "$ref" : "#/components/schemas/UserCollectionPlaylists_Resource_Object"
35005 }, {
35006 "$ref" : "#/components/schemas/UserCollectionSaveForLaters_Resource_Object"
35007 }, {
35008 "$ref" : "#/components/schemas/UserCollectionTracks_Resource_Object"
35009 }, {
35010 "$ref" : "#/components/schemas/UserCollectionVideos_Resource_Object"
35011 }, {
35012 "$ref" : "#/components/schemas/UserCollections_Resource_Object"
35013 }, {
35014 "$ref" : "#/components/schemas/UserDailyMixes_Resource_Object"
35015 }, {
35016 "$ref" : "#/components/schemas/UserDataExportRequests_Resource_Object"
35017 }, {
35018 "$ref" : "#/components/schemas/UserDiscoveryMixes_Resource_Object"
35019 }, {
35020 "$ref" : "#/components/schemas/UserNewReleaseMixes_Resource_Object"
35021 }, {
35022 "$ref" : "#/components/schemas/UserOfflineMixes_Resource_Object"
35023 }, {
35024 "$ref" : "#/components/schemas/UserRecommendationBlocks_Resource_Object"
35025 }, {
35026 "$ref" : "#/components/schemas/UserRecommendations_Resource_Object"
35027 }, {
35028 "$ref" : "#/components/schemas/UserReports_Resource_Object"
35029 }, {
35030 "$ref" : "#/components/schemas/UserSubscriptionPriceChanges_Resource_Object"
35031 }, {
35032 "$ref" : "#/components/schemas/Users_Resource_Object"
35033 }, {
35034 "$ref" : "#/components/schemas/VideoManifests_Resource_Object"
35035 }, {
35036 "$ref" : "#/components/schemas/Videos_Resource_Object"
35037 } ]
35038 }
35039 },
35040 "InstallationsCreateOperation_Payload" : {
35041 "required" : [ "data" ],
35042 "type" : "object",
35043 "properties" : {
35044 "data" : {
35045 "$ref" : "#/components/schemas/InstallationsCreateOperation_Payload_Data"
35046 }
35047 }
35048 },
35049 "InstallationsCreateOperation_Payload_Data" : {
35050 "required" : [ "attributes", "type" ],
35051 "type" : "object",
35052 "properties" : {
35053 "attributes" : {
35054 "$ref" : "#/components/schemas/InstallationsCreateOperation_Payload_Data_Attributes"
35055 },
35056 "type" : {
35057 "type" : "string",
35058 "enum" : [ "installations" ]
35059 }
35060 }
35061 },
35062 "InstallationsCreateOperation_Payload_Data_Attributes" : {
35063 "required" : [ "clientProvidedInstallationId", "name" ],
35064 "type" : "object",
35065 "properties" : {
35066 "clientProvidedInstallationId" : {
35067 "minLength" : 1,
35068 "type" : "string",
35069 "description" : "Client provided installation identifier"
35070 },
35071 "name" : {
35072 "minLength" : 1,
35073 "type" : "string",
35074 "description" : "Human-readable name",
35075 "example" : "My iPhone"
35076 }
35077 }
35078 },
35079 "InstallationsOfflineInventoryRelationshipAddOperation_Payload" : {
35080 "required" : [ "data" ],
35081 "type" : "object",
35082 "properties" : {
35083 "data" : {
35084 "maxItems" : 1,
35085 "minItems" : 1,
35086 "type" : "array",
35087 "items" : {
35088 "$ref" : "#/components/schemas/InstallationsOfflineInventory_ItemIdentifier"
35089 }
35090 }
35091 }
35092 },
35093 "InstallationsOfflineInventoryRelationshipRemoveOperation_Payload" : {
35094 "required" : [ "data" ],
35095 "type" : "object",
35096 "properties" : {
35097 "data" : {
35098 "maxItems" : 1,
35099 "minItems" : 1,
35100 "type" : "array",
35101 "items" : {
35102 "$ref" : "#/components/schemas/InstallationsOfflineInventory_ItemIdentifier"
35103 }
35104 }
35105 }
35106 },
35107 "InstallationsOfflineInventory_ItemIdentifier" : {
35108 "required" : [ "id", "type" ],
35109 "type" : "object",
35110 "properties" : {
35111 "id" : {
35112 "type" : "string",
35113 "description" : "The item id. Use \"me\" when the type is userCollectionTracks to resolve to the authenticated user's collection."
35114 },
35115 "type" : {
35116 "type" : "string",
35117 "enum" : [ "tracks", "videos", "albums", "playlists", "userCollectionTracks" ]
35118 }
35119 }
35120 },
35121 "Installations_Attributes" : {
35122 "required" : [ "clientProvidedInstallationId", "name" ],
35123 "type" : "object",
35124 "properties" : {
35125 "clientProvidedInstallationId" : {
35126 "type" : "string",
35127 "description" : "Client provided installation identifier"
35128 },
35129 "name" : {
35130 "type" : "string",
35131 "description" : "Human-readable name for the installation",
35132 "example" : "My iPhone"
35133 }
35134 }
35135 },
35136 "Installations_Create_Single_Resource_Data_Document" : {
35137 "required" : [ "data", "links" ],
35138 "type" : "object",
35139 "properties" : {
35140 "data" : {
35141 "$ref" : "#/components/schemas/Installations_Resource_Object"
35142 },
35143 "links" : {
35144 "$ref" : "#/components/schemas/Links"
35145 }
35146 }
35147 },
35148 "Installations_Multi_Relationship_Data_Document" : {
35149 "required" : [ "links" ],
35150 "type" : "object",
35151 "properties" : {
35152 "data" : {
35153 "type" : "array",
35154 "items" : {
35155 "$ref" : "#/components/schemas/Resource_Identifier"
35156 }
35157 },
35158 "included" : {
35159 "$ref" : "#/components/schemas/Included"
35160 },
35161 "links" : {
35162 "$ref" : "#/components/schemas/Links"
35163 }
35164 }
35165 },
35166 "Installations_Multi_Resource_Data_Document" : {
35167 "required" : [ "data", "links" ],
35168 "type" : "object",
35169 "properties" : {
35170 "data" : {
35171 "type" : "array",
35172 "items" : {
35173 "$ref" : "#/components/schemas/Installations_Resource_Object"
35174 }
35175 },
35176 "included" : {
35177 "$ref" : "#/components/schemas/Included"
35178 },
35179 "links" : {
35180 "$ref" : "#/components/schemas/Links"
35181 }
35182 }
35183 },
35184 "Installations_OfflineInventory_Multi_Relationship_Data_Document" : {
35185 "required" : [ "links" ],
35186 "type" : "object",
35187 "properties" : {
35188 "data" : {
35189 "type" : "array",
35190 "items" : {
35191 "$ref" : "#/components/schemas/Installations_OfflineInventory_Resource_Identifier"
35192 }
35193 },
35194 "included" : {
35195 "$ref" : "#/components/schemas/Included"
35196 },
35197 "links" : {
35198 "$ref" : "#/components/schemas/Links"
35199 }
35200 }
35201 },
35202 "Installations_OfflineInventory_Resource_Identifier" : {
35203 "required" : [ "id", "type" ],
35204 "type" : "object",
35205 "properties" : {
35206 "id" : {
35207 "type" : "string",
35208 "description" : "Resource id",
35209 "example" : "12345"
35210 },
35211 "meta" : {
35212 "$ref" : "#/components/schemas/Installations_OfflineInventory_Resource_Identifier_Meta"
35213 },
35214 "type" : {
35215 "type" : "string",
35216 "description" : "Resource type",
35217 "example" : "tracks"
35218 }
35219 }
35220 },
35221 "Installations_OfflineInventory_Resource_Identifier_Meta" : {
35222 "required" : [ "addedAt" ],
35223 "type" : "object",
35224 "properties" : {
35225 "addedAt" : {
35226 "type" : "string",
35227 "format" : "date-time"
35228 },
35229 "replacement" : {
35230 "$ref" : "#/components/schemas/Replacement_Provenance"
35231 }
35232 }
35233 },
35234 "Installations_Relationships" : {
35235 "properties" : {
35236 "offlineInventory" : {
35237 "$ref" : "#/components/schemas/Installations_OfflineInventory_Multi_Relationship_Data_Document"
35238 },
35239 "owners" : {
35240 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
35241 }
35242 }
35243 },
35244 "Installations_Resource_Object" : {
35245 "required" : [ "id", "type" ],
35246 "type" : "object",
35247 "properties" : {
35248 "attributes" : {
35249 "$ref" : "#/components/schemas/Installations_Attributes"
35250 },
35251 "id" : {
35252 "type" : "string",
35253 "description" : "Resource id",
35254 "example" : "12345"
35255 },
35256 "relationships" : {
35257 "$ref" : "#/components/schemas/Installations_Relationships"
35258 },
35259 "type" : {
35260 "minLength" : 1,
35261 "type" : "string",
35262 "description" : "Resource type",
35263 "example" : "tracks"
35264 }
35265 }
35266 },
35267 "Installations_Single_Resource_Data_Document" : {
35268 "required" : [ "data", "links" ],
35269 "type" : "object",
35270 "properties" : {
35271 "data" : {
35272 "$ref" : "#/components/schemas/Installations_Resource_Object"
35273 },
35274 "included" : {
35275 "$ref" : "#/components/schemas/Included"
35276 },
35277 "links" : {
35278 "$ref" : "#/components/schemas/Links"
35279 }
35280 }
35281 },
35282 "LegacyBarcodeId" : {
35283 "type" : "object",
35284 "properties" : {
35285 "value" : {
35286 "type" : "string"
35287 }
35288 },
35289 "description" : "List of UPCs retrieved from the DSP"
35290 },
35291 "LegacySource" : {
35292 "required" : [ "id", "type" ],
35293 "type" : "object",
35294 "properties" : {
35295 "id" : {
35296 "type" : "string"
35297 },
35298 "type" : {
35299 "type" : "string"
35300 }
35301 }
35302 },
35303 "Link_Object" : {
35304 "type" : "object",
35305 "properties" : {
35306 "href" : {
35307 "type" : "string"
35308 }
35309 },
35310 "description" : "A JSON:API link object"
35311 },
35312 "Links" : {
35313 "required" : [ "self" ],
35314 "type" : "object",
35315 "properties" : {
35316 "meta" : {
35317 "$ref" : "#/components/schemas/Links_Meta"
35318 },
35319 "next" : {
35320 "type" : "string",
35321 "description" : "Link to next page",
35322 "example" : "/artists/xyz/relationships/tracks?page[cursor]=zyx"
35323 },
35324 "self" : {
35325 "type" : "string",
35326 "description" : "Link to self",
35327 "example" : "/artists/xyz/relationships/tracks"
35328 }
35329 }
35330 },
35331 "Links_Meta" : {
35332 "required" : [ "nextCursor" ],
35333 "type" : "object",
35334 "properties" : {
35335 "nextCursor" : {
35336 "type" : "string",
35337 "description" : "Only cursor part of next link",
35338 "example" : "zyx"
35339 }
35340 },
35341 "description" : "Non-standard meta information for links"
35342 },
35343 "LyricsCreateOperation_Payload" : {
35344 "required" : [ "data" ],
35345 "type" : "object",
35346 "properties" : {
35347 "data" : {
35348 "$ref" : "#/components/schemas/LyricsCreateOperation_Payload_Data"
35349 },
35350 "meta" : {
35351 "$ref" : "#/components/schemas/LyricsCreateOperation_Payload_Meta"
35352 }
35353 }
35354 },
35355 "LyricsCreateOperation_Payload_Data" : {
35356 "required" : [ "relationships", "type" ],
35357 "type" : "object",
35358 "properties" : {
35359 "attributes" : {
35360 "$ref" : "#/components/schemas/LyricsCreateOperation_Payload_Data_Attributes"
35361 },
35362 "relationships" : {
35363 "$ref" : "#/components/schemas/LyricsCreateOperation_Payload_Data_Relationships"
35364 },
35365 "type" : {
35366 "type" : "string",
35367 "enum" : [ "lyrics" ]
35368 }
35369 }
35370 },
35371 "LyricsCreateOperation_Payload_Data_Attributes" : {
35372 "type" : "object",
35373 "properties" : {
35374 "text" : {
35375 "maxLength" : 10000,
35376 "minLength" : 0,
35377 "type" : "string"
35378 }
35379 }
35380 },
35381 "LyricsCreateOperation_Payload_Data_Relationships" : {
35382 "required" : [ "track" ],
35383 "type" : "object",
35384 "properties" : {
35385 "track" : {
35386 "$ref" : "#/components/schemas/LyricsCreateOperation_Payload_Data_Relationships_Track"
35387 }
35388 }
35389 },
35390 "LyricsCreateOperation_Payload_Data_Relationships_Track" : {
35391 "type" : "object",
35392 "properties" : {
35393 "data" : {
35394 "$ref" : "#/components/schemas/LyricsCreateOperation_Payload_Data_Relationships_Track_Data"
35395 },
35396 "id" : {
35397 "type" : "string",
35398 "deprecated" : true
35399 },
35400 "type" : {
35401 "type" : "string",
35402 "deprecated" : true,
35403 "enum" : [ "tracks" ]
35404 }
35405 }
35406 },
35407 "LyricsCreateOperation_Payload_Data_Relationships_Track_Data" : {
35408 "required" : [ "id", "type" ],
35409 "type" : "object",
35410 "properties" : {
35411 "id" : {
35412 "type" : "string"
35413 },
35414 "type" : {
35415 "type" : "string",
35416 "enum" : [ "tracks" ]
35417 }
35418 }
35419 },
35420 "LyricsCreateOperation_Payload_Meta" : {
35421 "type" : "object",
35422 "properties" : {
35423 "generate" : {
35424 "type" : "boolean"
35425 }
35426 }
35427 },
35428 "LyricsProvider" : {
35429 "type" : "object",
35430 "properties" : {
35431 "name" : {
35432 "type" : "string"
35433 },
35434 "source" : {
35435 "type" : "string",
35436 "enum" : [ "TIDAL", "THIRD_PARTY" ]
35437 }
35438 },
35439 "discriminator" : {
35440 "mapping" : {
35441 "THIRD_PARTY" : "#/components/schemas/ThirdPartyLyricsProvider",
35442 "TIDAL" : "#/components/schemas/TidalLyricsProvider"
35443 },
35444 "propertyName" : "source"
35445 }
35446 },
35447 "LyricsUpdateOperation_Payload" : {
35448 "required" : [ "data" ],
35449 "type" : "object",
35450 "properties" : {
35451 "data" : {
35452 "$ref" : "#/components/schemas/LyricsUpdateOperation_Payload_Data"
35453 }
35454 }
35455 },
35456 "LyricsUpdateOperation_Payload_Data" : {
35457 "required" : [ "attributes", "id", "type" ],
35458 "type" : "object",
35459 "properties" : {
35460 "attributes" : {
35461 "$ref" : "#/components/schemas/LyricsUpdateOperation_Payload_Data_Attributes"
35462 },
35463 "id" : {
35464 "type" : "string"
35465 },
35466 "type" : {
35467 "type" : "string",
35468 "enum" : [ "lyrics" ]
35469 }
35470 }
35471 },
35472 "LyricsUpdateOperation_Payload_Data_Attributes" : {
35473 "type" : "object",
35474 "properties" : {
35475 "lrcText" : {
35476 "type" : "string"
35477 },
35478 "text" : {
35479 "maxLength" : 10000,
35480 "minLength" : 0,
35481 "type" : "string"
35482 }
35483 }
35484 },
35485 "Lyrics_Attributes" : {
35486 "required" : [ "technicalStatus" ],
35487 "type" : "object",
35488 "properties" : {
35489 "direction" : {
35490 "type" : "string",
35491 "enum" : [ "LEFT_TO_RIGHT", "RIGHT_TO_LEFT" ]
35492 },
35493 "lrcText" : {
35494 "type" : "string"
35495 },
35496 "provider" : {
35497 "oneOf" : [ {
35498 "$ref" : "#/components/schemas/ThirdPartyLyricsProvider"
35499 }, {
35500 "$ref" : "#/components/schemas/TidalLyricsProvider"
35501 } ]
35502 },
35503 "technicalStatus" : {
35504 "type" : "string",
35505 "enum" : [ "PENDING", "PROCESSING", "ERROR", "OK" ]
35506 },
35507 "text" : {
35508 "type" : "string"
35509 }
35510 }
35511 },
35512 "Lyrics_Create_Single_Resource_Data_Document" : {
35513 "required" : [ "data", "links" ],
35514 "type" : "object",
35515 "properties" : {
35516 "data" : {
35517 "$ref" : "#/components/schemas/Lyrics_Resource_Object"
35518 },
35519 "links" : {
35520 "$ref" : "#/components/schemas/Links"
35521 }
35522 }
35523 },
35524 "Lyrics_Multi_Relationship_Data_Document" : {
35525 "required" : [ "links" ],
35526 "type" : "object",
35527 "properties" : {
35528 "data" : {
35529 "type" : "array",
35530 "items" : {
35531 "$ref" : "#/components/schemas/Resource_Identifier"
35532 }
35533 },
35534 "included" : {
35535 "$ref" : "#/components/schemas/Included"
35536 },
35537 "links" : {
35538 "$ref" : "#/components/schemas/Links"
35539 }
35540 }
35541 },
35542 "Lyrics_Relationships" : {
35543 "properties" : {
35544 "owners" : {
35545 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
35546 },
35547 "track" : {
35548 "$ref" : "#/components/schemas/Lyrics_Track_Single_Relationship_Data_Document"
35549 }
35550 }
35551 },
35552 "Lyrics_Resource_Object" : {
35553 "required" : [ "id", "type" ],
35554 "type" : "object",
35555 "properties" : {
35556 "attributes" : {
35557 "$ref" : "#/components/schemas/Lyrics_Attributes"
35558 },
35559 "id" : {
35560 "type" : "string",
35561 "description" : "Resource id",
35562 "example" : "12345"
35563 },
35564 "relationships" : {
35565 "$ref" : "#/components/schemas/Lyrics_Relationships"
35566 },
35567 "type" : {
35568 "minLength" : 1,
35569 "type" : "string",
35570 "description" : "Resource type",
35571 "example" : "tracks"
35572 }
35573 }
35574 },
35575 "Lyrics_Single_Relationship_Data_Document" : {
35576 "required" : [ "links" ],
35577 "type" : "object",
35578 "properties" : {
35579 "data" : {
35580 "oneOf" : [ {
35581 "$ref" : "#/components/schemas/Resource_Identifier"
35582 }, {
35583 "type" : "object",
35584 "nullable" : true,
35585 "enum" : [ null ]
35586 } ]
35587 },
35588 "included" : {
35589 "$ref" : "#/components/schemas/Included"
35590 },
35591 "links" : {
35592 "$ref" : "#/components/schemas/Links"
35593 }
35594 }
35595 },
35596 "Lyrics_Single_Resource_Data_Document" : {
35597 "required" : [ "data", "links" ],
35598 "type" : "object",
35599 "properties" : {
35600 "data" : {
35601 "$ref" : "#/components/schemas/Lyrics_Resource_Object"
35602 },
35603 "included" : {
35604 "$ref" : "#/components/schemas/Included"
35605 },
35606 "links" : {
35607 "$ref" : "#/components/schemas/Links"
35608 }
35609 }
35610 },
35611 "Lyrics_Track_Resource_Identifier" : {
35612 "required" : [ "id", "type" ],
35613 "type" : "object",
35614 "properties" : {
35615 "id" : {
35616 "type" : "string",
35617 "description" : "Resource id",
35618 "example" : "12345"
35619 },
35620 "meta" : {
35621 "$ref" : "#/components/schemas/Lyrics_Track_Resource_Identifier_Meta"
35622 },
35623 "type" : {
35624 "type" : "string",
35625 "description" : "Resource type",
35626 "example" : "tracks"
35627 }
35628 }
35629 },
35630 "Lyrics_Track_Resource_Identifier_Meta" : {
35631 "type" : "object",
35632 "properties" : {
35633 "replacement" : {
35634 "$ref" : "#/components/schemas/Replacement_Provenance"
35635 }
35636 }
35637 },
35638 "Lyrics_Track_Single_Relationship_Data_Document" : {
35639 "required" : [ "links" ],
35640 "type" : "object",
35641 "properties" : {
35642 "data" : {
35643 "oneOf" : [ {
35644 "$ref" : "#/components/schemas/Lyrics_Track_Resource_Identifier"
35645 }, {
35646 "type" : "object",
35647 "nullable" : true,
35648 "enum" : [ null ]
35649 } ]
35650 },
35651 "included" : {
35652 "$ref" : "#/components/schemas/Included"
35653 },
35654 "links" : {
35655 "$ref" : "#/components/schemas/Links"
35656 }
35657 }
35658 },
35659 "ManualArtistClaimsCreateOperation_Payload" : {
35660 "required" : [ "data" ],
35661 "type" : "object",
35662 "properties" : {
35663 "data" : {
35664 "$ref" : "#/components/schemas/ManualArtistClaimsCreateOperation_Payload_Data"
35665 }
35666 }
35667 },
35668 "ManualArtistClaimsCreateOperation_Payload_Data" : {
35669 "required" : [ "attributes", "type" ],
35670 "type" : "object",
35671 "properties" : {
35672 "attributes" : {
35673 "$ref" : "#/components/schemas/ManualArtistClaimsCreateOperation_Payload_Data_Attributes"
35674 },
35675 "type" : {
35676 "type" : "string",
35677 "enum" : [ "manualArtistClaims" ]
35678 }
35679 }
35680 },
35681 "ManualArtistClaimsCreateOperation_Payload_Data_Attributes" : {
35682 "required" : [ "artistId", "legalFirstName", "legalLastName", "websiteOrSocialLink" ],
35683 "type" : "object",
35684 "properties" : {
35685 "acceptedTerms" : {
35686 "type" : "boolean"
35687 },
35688 "artistId" : {
35689 "type" : "string"
35690 },
35691 "distributorName" : {
35692 "type" : "string"
35693 },
35694 "errorReason" : {
35695 "type" : "string"
35696 },
35697 "labelContactEmail" : {
35698 "type" : "string"
35699 },
35700 "labelContactName" : {
35701 "type" : "string"
35702 },
35703 "labelName" : {
35704 "type" : "string"
35705 },
35706 "legalFirstName" : {
35707 "minLength" : 1,
35708 "type" : "string"
35709 },
35710 "legalLastName" : {
35711 "minLength" : 1,
35712 "type" : "string"
35713 },
35714 "managerEmail" : {
35715 "type" : "string"
35716 },
35717 "managerName" : {
35718 "type" : "string"
35719 },
35720 "role" : {
35721 "type" : "string"
35722 },
35723 "selectedAlbums" : {
35724 "type" : "array",
35725 "items" : {
35726 "type" : "string"
35727 }
35728 },
35729 "selectedSingles" : {
35730 "type" : "array",
35731 "items" : {
35732 "type" : "string"
35733 }
35734 },
35735 "socialLink" : {
35736 "$ref" : "#/components/schemas/Link_Object"
35737 },
35738 "upcs" : {
35739 "type" : "array",
35740 "items" : {
35741 "type" : "string"
35742 }
35743 },
35744 "websiteOrSocialLink" : {
35745 "$ref" : "#/components/schemas/Link_Object"
35746 }
35747 }
35748 },
35749 "ManualArtistClaims_Attributes" : {
35750 "required" : [ "artistId", "legalFirstName", "legalLastName", "websiteOrSocialLink" ],
35751 "type" : "object",
35752 "properties" : {
35753 "acceptedTerms" : {
35754 "type" : "boolean",
35755 "description" : "Accepted terms and conditions"
35756 },
35757 "artistId" : {
35758 "type" : "string",
35759 "description" : "Artist ID being claimed"
35760 },
35761 "createdAt" : {
35762 "type" : "string",
35763 "description" : "Timestamp when the claim was created",
35764 "format" : "date-time"
35765 },
35766 "distributorName" : {
35767 "type" : "string",
35768 "description" : "Distributor name"
35769 },
35770 "enrollmentType" : {
35771 "type" : "string",
35772 "description" : "Enrollment type"
35773 },
35774 "errorReason" : {
35775 "type" : "string",
35776 "description" : "Error reason if claim failed"
35777 },
35778 "labelContactEmail" : {
35779 "type" : "string",
35780 "description" : "Label contact email"
35781 },
35782 "labelContactName" : {
35783 "type" : "string",
35784 "description" : "Label contact name"
35785 },
35786 "labelName" : {
35787 "type" : "string",
35788 "description" : "Label name"
35789 },
35790 "lastModifiedAt" : {
35791 "type" : "string",
35792 "description" : "Timestamp when the claim was last modified",
35793 "format" : "date-time"
35794 },
35795 "legalFirstName" : {
35796 "minLength" : 1,
35797 "type" : "string",
35798 "description" : "Legal first name"
35799 },
35800 "legalLastName" : {
35801 "minLength" : 1,
35802 "type" : "string",
35803 "description" : "Legal last name"
35804 },
35805 "managerEmail" : {
35806 "type" : "string",
35807 "description" : "Manager email"
35808 },
35809 "managerName" : {
35810 "type" : "string",
35811 "description" : "Manager name"
35812 },
35813 "role" : {
35814 "type" : "string",
35815 "description" : "Role"
35816 },
35817 "selectedAlbums" : {
35818 "type" : "array",
35819 "description" : "Album IDs selected by user",
35820 "items" : {
35821 "type" : "string",
35822 "description" : "Album IDs selected by user"
35823 }
35824 },
35825 "selectedSingles" : {
35826 "type" : "array",
35827 "description" : "Single IDs selected by user",
35828 "items" : {
35829 "type" : "string",
35830 "description" : "Single IDs selected by user"
35831 }
35832 },
35833 "socialLink" : {
35834 "$ref" : "#/components/schemas/Link_Object"
35835 },
35836 "status" : {
35837 "type" : "string",
35838 "description" : "Claim status",
35839 "enum" : [ "SUBMITTED", "PENDING", "APPROVED", "REJECTED" ]
35840 },
35841 "upcs" : {
35842 "type" : "array",
35843 "description" : "UPCs associated with the claim",
35844 "items" : {
35845 "type" : "string",
35846 "description" : "UPCs associated with the claim"
35847 }
35848 },
35849 "websiteOrSocialLink" : {
35850 "$ref" : "#/components/schemas/Link_Object"
35851 }
35852 }
35853 },
35854 "ManualArtistClaims_Create_Single_Resource_Data_Document" : {
35855 "required" : [ "data", "links" ],
35856 "type" : "object",
35857 "properties" : {
35858 "data" : {
35859 "$ref" : "#/components/schemas/ManualArtistClaims_Resource_Object"
35860 },
35861 "links" : {
35862 "$ref" : "#/components/schemas/Links"
35863 }
35864 }
35865 },
35866 "ManualArtistClaims_Resource_Object" : {
35867 "required" : [ "id", "type" ],
35868 "type" : "object",
35869 "properties" : {
35870 "attributes" : {
35871 "$ref" : "#/components/schemas/ManualArtistClaims_Attributes"
35872 },
35873 "id" : {
35874 "type" : "string",
35875 "description" : "Resource id",
35876 "example" : "12345"
35877 },
35878 "type" : {
35879 "minLength" : 1,
35880 "type" : "string",
35881 "description" : "Resource type",
35882 "example" : "tracks"
35883 }
35884 }
35885 },
35886 "Multi_Relationship_Data_Document" : {
35887 "required" : [ "links" ],
35888 "type" : "object",
35889 "properties" : {
35890 "data" : {
35891 "type" : "array",
35892 "items" : {
35893 "$ref" : "#/components/schemas/Resource_Identifier"
35894 }
35895 },
35896 "links" : {
35897 "$ref" : "#/components/schemas/Links"
35898 }
35899 }
35900 },
35901 "OfflineTasksUpdateOperation_Payload" : {
35902 "required" : [ "data" ],
35903 "type" : "object",
35904 "properties" : {
35905 "data" : {
35906 "$ref" : "#/components/schemas/OfflineTasksUpdateOperation_Payload_Data"
35907 }
35908 }
35909 },
35910 "OfflineTasksUpdateOperation_Payload_Data" : {
35911 "required" : [ "attributes", "id", "type" ],
35912 "type" : "object",
35913 "properties" : {
35914 "attributes" : {
35915 "$ref" : "#/components/schemas/OfflineTasksUpdateOperation_Payload_Data_Attributes"
35916 },
35917 "id" : {
35918 "type" : "string"
35919 },
35920 "type" : {
35921 "type" : "string",
35922 "enum" : [ "offlineTasks" ]
35923 }
35924 }
35925 },
35926 "OfflineTasksUpdateOperation_Payload_Data_Attributes" : {
35927 "required" : [ "state" ],
35928 "type" : "object",
35929 "properties" : {
35930 "state" : {
35931 "type" : "string",
35932 "description" : "New state for the offline task",
35933 "enum" : [ "PENDING", "IN_PROGRESS", "FAILED", "COMPLETED" ]
35934 }
35935 }
35936 },
35937 "OfflineTasks_Attributes" : {
35938 "required" : [ "action", "position", "state", "volume" ],
35939 "type" : "object",
35940 "properties" : {
35941 "action" : {
35942 "type" : "string",
35943 "description" : "Action to perform",
35944 "enum" : [ "STORE", "REMOVE" ]
35945 },
35946 "position" : {
35947 "type" : "integer",
35948 "description" : "Collection position of item",
35949 "format" : "int32"
35950 },
35951 "state" : {
35952 "type" : "string",
35953 "description" : "Task state",
35954 "enum" : [ "PENDING", "IN_PROGRESS", "FAILED", "COMPLETED" ]
35955 },
35956 "volume" : {
35957 "type" : "integer",
35958 "description" : "Collection volume of item",
35959 "format" : "int32"
35960 }
35961 }
35962 },
35963 "OfflineTasks_Collection_Resource_Identifier" : {
35964 "required" : [ "id", "type" ],
35965 "type" : "object",
35966 "properties" : {
35967 "id" : {
35968 "type" : "string",
35969 "description" : "Resource id",
35970 "example" : "12345"
35971 },
35972 "meta" : {
35973 "$ref" : "#/components/schemas/OfflineTasks_Collection_Resource_Identifier_Meta"
35974 },
35975 "type" : {
35976 "type" : "string",
35977 "description" : "Resource type",
35978 "example" : "tracks"
35979 }
35980 }
35981 },
35982 "OfflineTasks_Collection_Resource_Identifier_Meta" : {
35983 "type" : "object",
35984 "properties" : {
35985 "replacement" : {
35986 "$ref" : "#/components/schemas/Replacement_Provenance"
35987 }
35988 }
35989 },
35990 "OfflineTasks_Collection_Single_Relationship_Data_Document" : {
35991 "required" : [ "links" ],
35992 "type" : "object",
35993 "properties" : {
35994 "data" : {
35995 "oneOf" : [ {
35996 "$ref" : "#/components/schemas/OfflineTasks_Collection_Resource_Identifier"
35997 }, {
35998 "type" : "object",
35999 "nullable" : true,
36000 "enum" : [ null ]
36001 } ]
36002 },
36003 "included" : {
36004 "$ref" : "#/components/schemas/Included"
36005 },
36006 "links" : {
36007 "$ref" : "#/components/schemas/Links"
36008 }
36009 }
36010 },
36011 "OfflineTasks_Item_Resource_Identifier" : {
36012 "required" : [ "id", "type" ],
36013 "type" : "object",
36014 "properties" : {
36015 "id" : {
36016 "type" : "string",
36017 "description" : "Resource id",
36018 "example" : "12345"
36019 },
36020 "meta" : {
36021 "$ref" : "#/components/schemas/OfflineTasks_Item_Resource_Identifier_Meta"
36022 },
36023 "type" : {
36024 "type" : "string",
36025 "description" : "Resource type",
36026 "example" : "tracks"
36027 }
36028 }
36029 },
36030 "OfflineTasks_Item_Resource_Identifier_Meta" : {
36031 "type" : "object",
36032 "properties" : {
36033 "replacement" : {
36034 "$ref" : "#/components/schemas/Replacement_Provenance"
36035 }
36036 }
36037 },
36038 "OfflineTasks_Item_Single_Relationship_Data_Document" : {
36039 "required" : [ "links" ],
36040 "type" : "object",
36041 "properties" : {
36042 "data" : {
36043 "oneOf" : [ {
36044 "$ref" : "#/components/schemas/OfflineTasks_Item_Resource_Identifier"
36045 }, {
36046 "type" : "object",
36047 "nullable" : true,
36048 "enum" : [ null ]
36049 } ]
36050 },
36051 "included" : {
36052 "$ref" : "#/components/schemas/Included"
36053 },
36054 "links" : {
36055 "$ref" : "#/components/schemas/Links"
36056 }
36057 }
36058 },
36059 "OfflineTasks_Multi_Relationship_Data_Document" : {
36060 "required" : [ "links" ],
36061 "type" : "object",
36062 "properties" : {
36063 "data" : {
36064 "type" : "array",
36065 "items" : {
36066 "$ref" : "#/components/schemas/Resource_Identifier"
36067 }
36068 },
36069 "included" : {
36070 "$ref" : "#/components/schemas/Included"
36071 },
36072 "links" : {
36073 "$ref" : "#/components/schemas/Links"
36074 }
36075 }
36076 },
36077 "OfflineTasks_Multi_Resource_Data_Document" : {
36078 "required" : [ "data", "links" ],
36079 "type" : "object",
36080 "properties" : {
36081 "data" : {
36082 "type" : "array",
36083 "items" : {
36084 "$ref" : "#/components/schemas/OfflineTasks_Resource_Object"
36085 }
36086 },
36087 "included" : {
36088 "$ref" : "#/components/schemas/Included"
36089 },
36090 "links" : {
36091 "$ref" : "#/components/schemas/Links"
36092 }
36093 }
36094 },
36095 "OfflineTasks_Relationships" : {
36096 "properties" : {
36097 "collection" : {
36098 "$ref" : "#/components/schemas/OfflineTasks_Collection_Single_Relationship_Data_Document"
36099 },
36100 "item" : {
36101 "$ref" : "#/components/schemas/OfflineTasks_Item_Single_Relationship_Data_Document"
36102 },
36103 "owners" : {
36104 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
36105 }
36106 }
36107 },
36108 "OfflineTasks_Resource_Object" : {
36109 "required" : [ "id", "type" ],
36110 "type" : "object",
36111 "properties" : {
36112 "attributes" : {
36113 "$ref" : "#/components/schemas/OfflineTasks_Attributes"
36114 },
36115 "id" : {
36116 "type" : "string",
36117 "description" : "Resource id",
36118 "example" : "12345"
36119 },
36120 "relationships" : {
36121 "$ref" : "#/components/schemas/OfflineTasks_Relationships"
36122 },
36123 "type" : {
36124 "minLength" : 1,
36125 "type" : "string",
36126 "description" : "Resource type",
36127 "example" : "tracks"
36128 }
36129 }
36130 },
36131 "OfflineTasks_Single_Relationship_Data_Document" : {
36132 "required" : [ "links" ],
36133 "type" : "object",
36134 "properties" : {
36135 "data" : {
36136 "oneOf" : [ {
36137 "$ref" : "#/components/schemas/Resource_Identifier"
36138 }, {
36139 "type" : "object",
36140 "nullable" : true,
36141 "enum" : [ null ]
36142 } ]
36143 },
36144 "included" : {
36145 "$ref" : "#/components/schemas/Included"
36146 },
36147 "links" : {
36148 "$ref" : "#/components/schemas/Links"
36149 }
36150 }
36151 },
36152 "OfflineTasks_Single_Resource_Data_Document" : {
36153 "required" : [ "data", "links" ],
36154 "type" : "object",
36155 "properties" : {
36156 "data" : {
36157 "$ref" : "#/components/schemas/OfflineTasks_Resource_Object"
36158 },
36159 "included" : {
36160 "$ref" : "#/components/schemas/Included"
36161 },
36162 "links" : {
36163 "$ref" : "#/components/schemas/Links"
36164 }
36165 }
36166 },
36167 "PlayQueuesCreateOperation_Payload" : {
36168 "required" : [ "data" ],
36169 "type" : "object",
36170 "properties" : {
36171 "data" : {
36172 "$ref" : "#/components/schemas/PlayQueuesCreateOperation_Payload_Data"
36173 }
36174 }
36175 },
36176 "PlayQueuesCreateOperation_Payload_Data" : {
36177 "required" : [ "type" ],
36178 "type" : "object",
36179 "properties" : {
36180 "type" : {
36181 "type" : "string",
36182 "enum" : [ "playQueues" ]
36183 }
36184 }
36185 },
36186 "PlayQueuesCurrentRelationshipUpdateOperation_Payload" : {
36187 "required" : [ "data" ],
36188 "type" : "object",
36189 "properties" : {
36190 "data" : {
36191 "$ref" : "#/components/schemas/PlayQueuesCurrentRelationshipUpdateOperation_Payload_Data"
36192 }
36193 }
36194 },
36195 "PlayQueuesCurrentRelationshipUpdateOperation_Payload_Data" : {
36196 "required" : [ "id", "meta", "type" ],
36197 "type" : "object",
36198 "properties" : {
36199 "id" : {
36200 "type" : "string"
36201 },
36202 "meta" : {
36203 "$ref" : "#/components/schemas/PlayQueuesCurrentRelationshipUpdateOperation_Payload_Data_Meta"
36204 },
36205 "type" : {
36206 "type" : "string",
36207 "enum" : [ "tracks", "videos" ]
36208 }
36209 }
36210 },
36211 "PlayQueuesCurrentRelationshipUpdateOperation_Payload_Data_Meta" : {
36212 "required" : [ "itemId" ],
36213 "type" : "object",
36214 "properties" : {
36215 "itemId" : {
36216 "type" : "string"
36217 }
36218 }
36219 },
36220 "PlayQueuesFutureRelationshipAddOperation_Payload" : {
36221 "required" : [ "data" ],
36222 "type" : "object",
36223 "properties" : {
36224 "data" : {
36225 "maxItems" : 20,
36226 "minItems" : 0,
36227 "type" : "array",
36228 "items" : {
36229 "$ref" : "#/components/schemas/PlayQueuesFutureRelationshipAddOperation_Payload_Data"
36230 }
36231 },
36232 "meta" : {
36233 "$ref" : "#/components/schemas/PlayQueuesFutureRelationshipAddOperation_Payload_Meta"
36234 }
36235 }
36236 },
36237 "PlayQueuesFutureRelationshipAddOperation_Payload_Data" : {
36238 "required" : [ "id", "type" ],
36239 "type" : "object",
36240 "properties" : {
36241 "id" : {
36242 "type" : "string"
36243 },
36244 "meta" : {
36245 "$ref" : "#/components/schemas/PlayQueuesFutureRelationshipAddOperation_Payload_Data_Meta"
36246 },
36247 "type" : {
36248 "type" : "string",
36249 "enum" : [ "tracks", "videos", "albums", "playlists" ]
36250 }
36251 }
36252 },
36253 "PlayQueuesFutureRelationshipAddOperation_Payload_Data_Meta" : {
36254 "type" : "object",
36255 "properties" : {
36256 "itemCursor" : {
36257 "type" : "string"
36258 }
36259 }
36260 },
36261 "PlayQueuesFutureRelationshipAddOperation_Payload_Meta" : {
36262 "required" : [ "mode" ],
36263 "type" : "object",
36264 "properties" : {
36265 "batchId" : {
36266 "type" : "string",
36267 "format" : "uuid"
36268 },
36269 "legacySource" : {
36270 "$ref" : "#/components/schemas/LegacySource"
36271 },
36272 "mode" : {
36273 "type" : "string",
36274 "enum" : [ "ADD_TO_FRONT", "ADD_TO_BACK", "ADD_BEFORE", "REPLACE_ALL", "REPLACE_ALL_AND_CURRENT", "ADD_TO_FRONT_REPLACE_CURRENT" ]
36275 },
36276 "positionBefore" : {
36277 "type" : "string"
36278 }
36279 }
36280 },
36281 "PlayQueuesFutureRelationshipRemoveOperation_Payload" : {
36282 "required" : [ "data" ],
36283 "type" : "object",
36284 "properties" : {
36285 "data" : {
36286 "maxItems" : 20,
36287 "minItems" : 1,
36288 "type" : "array",
36289 "items" : {
36290 "$ref" : "#/components/schemas/PlayQueuesFutureRelationshipRemoveOperation_Payload_Data"
36291 }
36292 }
36293 }
36294 },
36295 "PlayQueuesFutureRelationshipRemoveOperation_Payload_Data" : {
36296 "required" : [ "id", "meta", "type" ],
36297 "type" : "object",
36298 "properties" : {
36299 "id" : {
36300 "type" : "string"
36301 },
36302 "meta" : {
36303 "$ref" : "#/components/schemas/PlayQueuesFutureRelationshipRemoveOperation_Payload_Data_Meta"
36304 },
36305 "type" : {
36306 "type" : "string",
36307 "enum" : [ "tracks", "videos" ]
36308 }
36309 }
36310 },
36311 "PlayQueuesFutureRelationshipRemoveOperation_Payload_Data_Meta" : {
36312 "required" : [ "itemId" ],
36313 "type" : "object",
36314 "properties" : {
36315 "itemId" : {
36316 "type" : "string"
36317 }
36318 }
36319 },
36320 "PlayQueuesFutureRelationshipUpdateOperation_Payload" : {
36321 "required" : [ "data", "meta" ],
36322 "type" : "object",
36323 "properties" : {
36324 "data" : {
36325 "maxItems" : 20,
36326 "minItems" : 1,
36327 "type" : "array",
36328 "items" : {
36329 "$ref" : "#/components/schemas/PlayQueuesFutureRelationshipUpdateOperation_Payload_Data"
36330 }
36331 },
36332 "meta" : {
36333 "$ref" : "#/components/schemas/PlayQueuesFutureRelationshipUpdateOperation_Payload_Meta"
36334 }
36335 }
36336 },
36337 "PlayQueuesFutureRelationshipUpdateOperation_Payload_Data" : {
36338 "required" : [ "id", "meta", "type" ],
36339 "type" : "object",
36340 "properties" : {
36341 "id" : {
36342 "type" : "string"
36343 },
36344 "meta" : {
36345 "$ref" : "#/components/schemas/PlayQueuesFutureRelationshipUpdateOperation_Payload_Data_Meta"
36346 },
36347 "type" : {
36348 "type" : "string",
36349 "enum" : [ "tracks", "videos" ]
36350 }
36351 }
36352 },
36353 "PlayQueuesFutureRelationshipUpdateOperation_Payload_Data_Meta" : {
36354 "required" : [ "itemId" ],
36355 "type" : "object",
36356 "properties" : {
36357 "itemId" : {
36358 "type" : "string"
36359 }
36360 }
36361 },
36362 "PlayQueuesFutureRelationshipUpdateOperation_Payload_Meta" : {
36363 "required" : [ "positionBefore" ],
36364 "type" : "object",
36365 "properties" : {
36366 "positionBefore" : {
36367 "type" : "string"
36368 }
36369 }
36370 },
36371 "PlayQueuesUpdateOperation_Payload" : {
36372 "required" : [ "data" ],
36373 "type" : "object",
36374 "properties" : {
36375 "data" : {
36376 "$ref" : "#/components/schemas/PlayQueuesUpdateOperation_Payload_Data"
36377 }
36378 }
36379 },
36380 "PlayQueuesUpdateOperation_Payload_Data" : {
36381 "required" : [ "attributes", "id", "type" ],
36382 "type" : "object",
36383 "properties" : {
36384 "attributes" : {
36385 "$ref" : "#/components/schemas/PlayQueuesUpdateOperation_Payload_Data_Attributes"
36386 },
36387 "id" : {
36388 "type" : "string"
36389 },
36390 "type" : {
36391 "type" : "string",
36392 "enum" : [ "playQueues" ]
36393 }
36394 }
36395 },
36396 "PlayQueuesUpdateOperation_Payload_Data_Attributes" : {
36397 "type" : "object",
36398 "properties" : {
36399 "repeat" : {
36400 "type" : "string",
36401 "enum" : [ "NONE", "ONE", "BATCH" ]
36402 },
36403 "shuffle" : {
36404 "type" : "string",
36405 "enum" : [ "OFF", "BATCH", "ALL" ]
36406 },
36407 "shuffled" : {
36408 "type" : "boolean"
36409 }
36410 }
36411 },
36412 "PlayQueues_Attributes" : {
36413 "required" : [ "createdAt", "lastModifiedAt", "repeat", "shuffle", "shuffled" ],
36414 "type" : "object",
36415 "properties" : {
36416 "createdAt" : {
36417 "type" : "string",
36418 "description" : "ISO 8601 creation timestamp",
36419 "format" : "date-time"
36420 },
36421 "lastModifiedAt" : {
36422 "type" : "string",
36423 "description" : "ISO 8601 last modified timestamp",
36424 "format" : "date-time"
36425 },
36426 "repeat" : {
36427 "type" : "string",
36428 "description" : "Queue's repeat mode",
36429 "enum" : [ "NONE", "ONE", "BATCH" ]
36430 },
36431 "shuffle" : {
36432 "type" : "string",
36433 "description" : "Queue's shuffle mode",
36434 "enum" : [ "OFF", "BATCH", "ALL" ]
36435 },
36436 "shuffled" : {
36437 "type" : "boolean",
36438 "description" : "Queue is shuffled or not"
36439 }
36440 }
36441 },
36442 "PlayQueues_Create_Single_Resource_Data_Document" : {
36443 "required" : [ "data", "links" ],
36444 "type" : "object",
36445 "properties" : {
36446 "data" : {
36447 "$ref" : "#/components/schemas/PlayQueues_Resource_Object"
36448 },
36449 "links" : {
36450 "$ref" : "#/components/schemas/Links"
36451 }
36452 }
36453 },
36454 "PlayQueues_Current_Resource_Identifier" : {
36455 "required" : [ "id", "type" ],
36456 "type" : "object",
36457 "properties" : {
36458 "id" : {
36459 "type" : "string",
36460 "description" : "Resource id",
36461 "example" : "12345"
36462 },
36463 "meta" : {
36464 "$ref" : "#/components/schemas/PlayQueues_Current_Resource_Identifier_Meta"
36465 },
36466 "type" : {
36467 "type" : "string",
36468 "description" : "Resource type",
36469 "example" : "tracks"
36470 }
36471 }
36472 },
36473 "PlayQueues_Current_Resource_Identifier_Meta" : {
36474 "required" : [ "batchId", "itemId" ],
36475 "type" : "object",
36476 "properties" : {
36477 "batchId" : {
36478 "type" : "string",
36479 "format" : "uuid"
36480 },
36481 "itemId" : {
36482 "minLength" : 1,
36483 "type" : "string"
36484 },
36485 "legacySource" : {
36486 "$ref" : "#/components/schemas/LegacySource"
36487 },
36488 "replacement" : {
36489 "$ref" : "#/components/schemas/Replacement_Provenance"
36490 }
36491 }
36492 },
36493 "PlayQueues_Current_Single_Relationship_Data_Document" : {
36494 "required" : [ "links" ],
36495 "type" : "object",
36496 "properties" : {
36497 "data" : {
36498 "oneOf" : [ {
36499 "$ref" : "#/components/schemas/PlayQueues_Current_Resource_Identifier"
36500 }, {
36501 "type" : "object",
36502 "nullable" : true,
36503 "enum" : [ null ]
36504 } ]
36505 },
36506 "included" : {
36507 "$ref" : "#/components/schemas/Included"
36508 },
36509 "links" : {
36510 "$ref" : "#/components/schemas/Links"
36511 }
36512 }
36513 },
36514 "PlayQueues_Future_Multi_Relationship_Data_Document" : {
36515 "required" : [ "links" ],
36516 "type" : "object",
36517 "properties" : {
36518 "data" : {
36519 "type" : "array",
36520 "items" : {
36521 "$ref" : "#/components/schemas/PlayQueues_Future_Resource_Identifier"
36522 }
36523 },
36524 "included" : {
36525 "$ref" : "#/components/schemas/Included"
36526 },
36527 "links" : {
36528 "$ref" : "#/components/schemas/Links"
36529 }
36530 }
36531 },
36532 "PlayQueues_Future_Resource_Identifier" : {
36533 "required" : [ "id", "type" ],
36534 "type" : "object",
36535 "properties" : {
36536 "id" : {
36537 "type" : "string",
36538 "description" : "Resource id",
36539 "example" : "12345"
36540 },
36541 "meta" : {
36542 "$ref" : "#/components/schemas/PlayQueues_Future_Resource_Identifier_Meta"
36543 },
36544 "type" : {
36545 "type" : "string",
36546 "description" : "Resource type",
36547 "example" : "tracks"
36548 }
36549 }
36550 },
36551 "PlayQueues_Future_Resource_Identifier_Meta" : {
36552 "required" : [ "batchId", "itemId" ],
36553 "type" : "object",
36554 "properties" : {
36555 "batchId" : {
36556 "type" : "string",
36557 "format" : "uuid"
36558 },
36559 "itemId" : {
36560 "minLength" : 1,
36561 "type" : "string"
36562 },
36563 "legacySource" : {
36564 "$ref" : "#/components/schemas/LegacySource"
36565 },
36566 "replacement" : {
36567 "$ref" : "#/components/schemas/Replacement_Provenance"
36568 }
36569 }
36570 },
36571 "PlayQueues_Multi_Relationship_Data_Document" : {
36572 "required" : [ "links" ],
36573 "type" : "object",
36574 "properties" : {
36575 "data" : {
36576 "type" : "array",
36577 "items" : {
36578 "$ref" : "#/components/schemas/Resource_Identifier"
36579 }
36580 },
36581 "included" : {
36582 "$ref" : "#/components/schemas/Included"
36583 },
36584 "links" : {
36585 "$ref" : "#/components/schemas/Links"
36586 }
36587 }
36588 },
36589 "PlayQueues_Multi_Resource_Data_Document" : {
36590 "required" : [ "data", "links" ],
36591 "type" : "object",
36592 "properties" : {
36593 "data" : {
36594 "type" : "array",
36595 "items" : {
36596 "$ref" : "#/components/schemas/PlayQueues_Resource_Object"
36597 }
36598 },
36599 "included" : {
36600 "$ref" : "#/components/schemas/Included"
36601 },
36602 "links" : {
36603 "$ref" : "#/components/schemas/Links"
36604 }
36605 }
36606 },
36607 "PlayQueues_Past_Multi_Relationship_Data_Document" : {
36608 "required" : [ "links" ],
36609 "type" : "object",
36610 "properties" : {
36611 "data" : {
36612 "type" : "array",
36613 "items" : {
36614 "$ref" : "#/components/schemas/PlayQueues_Past_Resource_Identifier"
36615 }
36616 },
36617 "included" : {
36618 "$ref" : "#/components/schemas/Included"
36619 },
36620 "links" : {
36621 "$ref" : "#/components/schemas/Links"
36622 }
36623 }
36624 },
36625 "PlayQueues_Past_Resource_Identifier" : {
36626 "required" : [ "id", "type" ],
36627 "type" : "object",
36628 "properties" : {
36629 "id" : {
36630 "type" : "string",
36631 "description" : "Resource id",
36632 "example" : "12345"
36633 },
36634 "meta" : {
36635 "$ref" : "#/components/schemas/PlayQueues_Past_Resource_Identifier_Meta"
36636 },
36637 "type" : {
36638 "type" : "string",
36639 "description" : "Resource type",
36640 "example" : "tracks"
36641 }
36642 }
36643 },
36644 "PlayQueues_Past_Resource_Identifier_Meta" : {
36645 "required" : [ "batchId", "itemId" ],
36646 "type" : "object",
36647 "properties" : {
36648 "batchId" : {
36649 "type" : "string",
36650 "format" : "uuid"
36651 },
36652 "itemId" : {
36653 "minLength" : 1,
36654 "type" : "string"
36655 },
36656 "legacySource" : {
36657 "$ref" : "#/components/schemas/LegacySource"
36658 },
36659 "replacement" : {
36660 "$ref" : "#/components/schemas/Replacement_Provenance"
36661 }
36662 }
36663 },
36664 "PlayQueues_Relationships" : {
36665 "properties" : {
36666 "current" : {
36667 "$ref" : "#/components/schemas/PlayQueues_Current_Single_Relationship_Data_Document"
36668 },
36669 "future" : {
36670 "$ref" : "#/components/schemas/PlayQueues_Future_Multi_Relationship_Data_Document"
36671 },
36672 "owners" : {
36673 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
36674 },
36675 "past" : {
36676 "$ref" : "#/components/schemas/PlayQueues_Past_Multi_Relationship_Data_Document"
36677 }
36678 }
36679 },
36680 "PlayQueues_Resource_Object" : {
36681 "required" : [ "id", "type" ],
36682 "type" : "object",
36683 "properties" : {
36684 "attributes" : {
36685 "$ref" : "#/components/schemas/PlayQueues_Attributes"
36686 },
36687 "id" : {
36688 "type" : "string",
36689 "description" : "Resource id",
36690 "example" : "12345"
36691 },
36692 "relationships" : {
36693 "$ref" : "#/components/schemas/PlayQueues_Relationships"
36694 },
36695 "type" : {
36696 "minLength" : 1,
36697 "type" : "string",
36698 "description" : "Resource type",
36699 "example" : "tracks"
36700 }
36701 }
36702 },
36703 "PlayQueues_Single_Relationship_Data_Document" : {
36704 "required" : [ "links" ],
36705 "type" : "object",
36706 "properties" : {
36707 "data" : {
36708 "oneOf" : [ {
36709 "$ref" : "#/components/schemas/Resource_Identifier"
36710 }, {
36711 "type" : "object",
36712 "nullable" : true,
36713 "enum" : [ null ]
36714 } ]
36715 },
36716 "included" : {
36717 "$ref" : "#/components/schemas/Included"
36718 },
36719 "links" : {
36720 "$ref" : "#/components/schemas/Links"
36721 }
36722 }
36723 },
36724 "PlayQueues_Single_Resource_Data_Document" : {
36725 "required" : [ "data", "links" ],
36726 "type" : "object",
36727 "properties" : {
36728 "data" : {
36729 "$ref" : "#/components/schemas/PlayQueues_Resource_Object"
36730 },
36731 "included" : {
36732 "$ref" : "#/components/schemas/Included"
36733 },
36734 "links" : {
36735 "$ref" : "#/components/schemas/Links"
36736 }
36737 }
36738 },
36739 "PlaylistsCollaboratorProfilesRelationshipAddOperation_Payload" : {
36740 "required" : [ "data" ],
36741 "type" : "object",
36742 "properties" : {
36743 "data" : {
36744 "maxItems" : 20,
36745 "minItems" : 1,
36746 "type" : "array",
36747 "items" : {
36748 "$ref" : "#/components/schemas/PlaylistsCollaboratorProfilesRelationshipAddOperation_Payload_Data"
36749 }
36750 }
36751 }
36752 },
36753 "PlaylistsCollaboratorProfilesRelationshipAddOperation_Payload_Data" : {
36754 "required" : [ "id", "type" ],
36755 "type" : "object",
36756 "properties" : {
36757 "id" : {
36758 "type" : "string"
36759 },
36760 "type" : {
36761 "type" : "string",
36762 "enum" : [ "artists" ]
36763 }
36764 }
36765 },
36766 "PlaylistsCollaboratorProfilesRelationshipRemoveOperation_Payload" : {
36767 "required" : [ "data" ],
36768 "type" : "object",
36769 "properties" : {
36770 "data" : {
36771 "maxItems" : 20,
36772 "minItems" : 1,
36773 "type" : "array",
36774 "items" : {
36775 "$ref" : "#/components/schemas/PlaylistsCollaboratorProfilesRelationshipRemoveOperation_Payload_Data"
36776 }
36777 }
36778 }
36779 },
36780 "PlaylistsCollaboratorProfilesRelationshipRemoveOperation_Payload_Data" : {
36781 "required" : [ "id", "type" ],
36782 "type" : "object",
36783 "properties" : {
36784 "id" : {
36785 "type" : "string"
36786 },
36787 "type" : {
36788 "type" : "string",
36789 "enum" : [ "artists" ]
36790 }
36791 }
36792 },
36793 "PlaylistsCoverArtRelationshipUpdateOperation_Payload" : {
36794 "required" : [ "data" ],
36795 "type" : "object",
36796 "properties" : {
36797 "data" : {
36798 "maxItems" : 1,
36799 "minItems" : 0,
36800 "type" : "array",
36801 "items" : {
36802 "$ref" : "#/components/schemas/PlaylistsCoverArtRelationshipUpdateOperation_Payload_Data"
36803 }
36804 }
36805 }
36806 },
36807 "PlaylistsCoverArtRelationshipUpdateOperation_Payload_Data" : {
36808 "required" : [ "id", "type" ],
36809 "type" : "object",
36810 "properties" : {
36811 "id" : {
36812 "type" : "string"
36813 },
36814 "type" : {
36815 "type" : "string",
36816 "enum" : [ "artworks" ]
36817 }
36818 }
36819 },
36820 "PlaylistsCreateOperation_Payload" : {
36821 "required" : [ "data" ],
36822 "type" : "object",
36823 "properties" : {
36824 "data" : {
36825 "$ref" : "#/components/schemas/PlaylistsCreateOperation_Payload_Data"
36826 }
36827 }
36828 },
36829 "PlaylistsCreateOperation_Payload_Data" : {
36830 "required" : [ "attributes", "type" ],
36831 "type" : "object",
36832 "properties" : {
36833 "attributes" : {
36834 "$ref" : "#/components/schemas/PlaylistsCreateOperation_Payload_Data_Attributes"
36835 },
36836 "type" : {
36837 "type" : "string",
36838 "enum" : [ "playlists" ]
36839 }
36840 }
36841 },
36842 "PlaylistsCreateOperation_Payload_Data_Attributes" : {
36843 "required" : [ "name" ],
36844 "type" : "object",
36845 "properties" : {
36846 "accessType" : {
36847 "type" : "string",
36848 "description" : "User-selectable playlist visibility.",
36849 "example" : "PUBLIC",
36850 "enum" : [ "PUBLIC", "UNLISTED" ]
36851 },
36852 "createdAt" : {
36853 "type" : "string",
36854 "format" : "date-time"
36855 },
36856 "description" : {
36857 "type" : "string"
36858 },
36859 "name" : {
36860 "type" : "string"
36861 }
36862 }
36863 },
36864 "PlaylistsItemsRelationshipAddOperation_Payload" : {
36865 "required" : [ "data" ],
36866 "type" : "object",
36867 "properties" : {
36868 "data" : {
36869 "maxItems" : 50,
36870 "minItems" : 1,
36871 "type" : "array",
36872 "items" : {
36873 "$ref" : "#/components/schemas/PlaylistsItemsRelationshipAddOperation_Payload_Data"
36874 }
36875 },
36876 "meta" : {
36877 "$ref" : "#/components/schemas/PlaylistsItemsRelationshipAddOperation_Payload_Meta"
36878 }
36879 }
36880 },
36881 "PlaylistsItemsRelationshipAddOperation_Payload_Data" : {
36882 "required" : [ "id", "type" ],
36883 "type" : "object",
36884 "properties" : {
36885 "id" : {
36886 "type" : "string"
36887 },
36888 "meta" : {
36889 "$ref" : "#/components/schemas/PlaylistsItemsRelationshipAddOperation_Payload_Data_Meta"
36890 },
36891 "type" : {
36892 "type" : "string",
36893 "enum" : [ "tracks", "videos" ]
36894 }
36895 }
36896 },
36897 "PlaylistsItemsRelationshipAddOperation_Payload_Data_Meta" : {
36898 "type" : "object",
36899 "properties" : {
36900 "addedAt" : {
36901 "type" : "string",
36902 "format" : "date-time"
36903 }
36904 }
36905 },
36906 "PlaylistsItemsRelationshipAddOperation_Payload_Meta" : {
36907 "required" : [ "positionBefore" ],
36908 "type" : "object",
36909 "properties" : {
36910 "positionBefore" : {
36911 "type" : "string"
36912 }
36913 }
36914 },
36915 "PlaylistsItemsRelationshipAddOperation_Response_Meta_SkippedItem" : {
36916 "required" : [ "id", "reason", "type" ],
36917 "type" : "object",
36918 "properties" : {
36919 "id" : {
36920 "type" : "string"
36921 },
36922 "reason" : {
36923 "type" : "string",
36924 "enum" : [ "NOT_FOUND" ]
36925 },
36926 "type" : {
36927 "type" : "string",
36928 "enum" : [ "tracks", "videos" ]
36929 }
36930 }
36931 },
36932 "PlaylistsItemsRelationshipRemoveOperation_Payload" : {
36933 "required" : [ "data" ],
36934 "type" : "object",
36935 "properties" : {
36936 "data" : {
36937 "maxItems" : 50,
36938 "minItems" : 1,
36939 "type" : "array",
36940 "items" : {
36941 "$ref" : "#/components/schemas/PlaylistsItemsRelationshipRemoveOperation_Payload_Data"
36942 }
36943 }
36944 }
36945 },
36946 "PlaylistsItemsRelationshipRemoveOperation_Payload_Data" : {
36947 "required" : [ "id", "meta", "type" ],
36948 "type" : "object",
36949 "properties" : {
36950 "id" : {
36951 "type" : "string"
36952 },
36953 "meta" : {
36954 "$ref" : "#/components/schemas/PlaylistsItemsRelationshipRemoveOperation_Payload_Data_Meta"
36955 },
36956 "type" : {
36957 "type" : "string",
36958 "enum" : [ "tracks", "videos" ]
36959 }
36960 }
36961 },
36962 "PlaylistsItemsRelationshipRemoveOperation_Payload_Data_Meta" : {
36963 "required" : [ "itemId" ],
36964 "type" : "object",
36965 "properties" : {
36966 "itemId" : {
36967 "type" : "string"
36968 }
36969 }
36970 },
36971 "PlaylistsItemsRelationshipUpdateOperation_Payload" : {
36972 "required" : [ "data" ],
36973 "type" : "object",
36974 "properties" : {
36975 "data" : {
36976 "maxItems" : 20,
36977 "minItems" : 1,
36978 "type" : "array",
36979 "items" : {
36980 "$ref" : "#/components/schemas/PlaylistsItemsRelationshipUpdateOperation_Payload_Data"
36981 }
36982 },
36983 "meta" : {
36984 "$ref" : "#/components/schemas/PlaylistsItemsRelationshipUpdateOperation_Payload_Meta"
36985 }
36986 }
36987 },
36988 "PlaylistsItemsRelationshipUpdateOperation_Payload_Data" : {
36989 "required" : [ "id", "meta", "type" ],
36990 "type" : "object",
36991 "properties" : {
36992 "id" : {
36993 "type" : "string"
36994 },
36995 "meta" : {
36996 "$ref" : "#/components/schemas/PlaylistsItemsRelationshipUpdateOperation_Payload_Data_Meta"
36997 },
36998 "type" : {
36999 "type" : "string",
37000 "enum" : [ "tracks", "videos" ]
37001 }
37002 }
37003 },
37004 "PlaylistsItemsRelationshipUpdateOperation_Payload_Data_Meta" : {
37005 "required" : [ "itemId" ],
37006 "type" : "object",
37007 "properties" : {
37008 "itemId" : {
37009 "type" : "string"
37010 }
37011 }
37012 },
37013 "PlaylistsItemsRelationshipUpdateOperation_Payload_Meta" : {
37014 "required" : [ "positionBefore" ],
37015 "type" : "object",
37016 "properties" : {
37017 "positionBefore" : {
37018 "type" : "string"
37019 }
37020 }
37021 },
37022 "PlaylistsUpdateOperation_Payload" : {
37023 "required" : [ "data" ],
37024 "type" : "object",
37025 "properties" : {
37026 "data" : {
37027 "$ref" : "#/components/schemas/PlaylistsUpdateOperation_Payload_Data"
37028 }
37029 }
37030 },
37031 "PlaylistsUpdateOperation_Payload_Data" : {
37032 "required" : [ "attributes", "id", "type" ],
37033 "type" : "object",
37034 "properties" : {
37035 "attributes" : {
37036 "$ref" : "#/components/schemas/PlaylistsUpdateOperation_Payload_Data_Attributes"
37037 },
37038 "id" : {
37039 "type" : "string"
37040 },
37041 "type" : {
37042 "type" : "string",
37043 "enum" : [ "playlists" ]
37044 }
37045 }
37046 },
37047 "PlaylistsUpdateOperation_Payload_Data_Attributes" : {
37048 "type" : "object",
37049 "properties" : {
37050 "accessType" : {
37051 "type" : "string",
37052 "description" : "User-selectable playlist visibility.",
37053 "example" : "PUBLIC",
37054 "enum" : [ "PUBLIC", "UNLISTED" ]
37055 },
37056 "description" : {
37057 "type" : "string"
37058 },
37059 "name" : {
37060 "type" : "string"
37061 }
37062 }
37063 },
37064 "Playlists_Attributes" : {
37065 "required" : [ "accessType", "bounded", "createdAt", "externalLinks", "lastModifiedAt", "name", "numberOfFollowers", "playlistType" ],
37066 "type" : "object",
37067 "properties" : {
37068 "accessType" : {
37069 "type" : "string",
37070 "description" : "Access type",
37071 "example" : "PRIVATE",
37072 "enum" : [ "PUBLIC", "UNLISTED", "PRIVATE" ]
37073 },
37074 "bounded" : {
37075 "type" : "boolean",
37076 "description" : "Indicates if the playlist has a duration and set number of tracks"
37077 },
37078 "createdAt" : {
37079 "type" : "string",
37080 "description" : "Datetime of playlist creation (ISO 8601)",
37081 "format" : "date-time"
37082 },
37083 "description" : {
37084 "type" : "string",
37085 "description" : "Playlist description"
37086 },
37087 "duration" : {
37088 "type" : "string",
37089 "description" : "Duration of playlist (ISO 8601)",
37090 "example" : "P30M5S"
37091 },
37092 "externalLinks" : {
37093 "type" : "array",
37094 "items" : {
37095 "$ref" : "#/components/schemas/External_Link"
37096 }
37097 },
37098 "lastModifiedAt" : {
37099 "type" : "string",
37100 "description" : "Datetime of last modification of the playlist (ISO 8601)",
37101 "format" : "date-time"
37102 },
37103 "name" : {
37104 "minLength" : 1,
37105 "type" : "string",
37106 "description" : "Playlist name"
37107 },
37108 "numberOfFollowers" : {
37109 "type" : "integer",
37110 "description" : "The amount of followers of the playlist",
37111 "format" : "int32"
37112 },
37113 "numberOfItems" : {
37114 "type" : "integer",
37115 "description" : "Number of items in the playlist",
37116 "format" : "int32"
37117 },
37118 "playlistType" : {
37119 "type" : "string",
37120 "description" : "The type of the playlist",
37121 "enum" : [ "EDITORIAL", "USER", "MIX", "ARTIST" ]
37122 }
37123 }
37124 },
37125 "Playlists_Create_Single_Resource_Data_Document" : {
37126 "required" : [ "data", "links" ],
37127 "type" : "object",
37128 "properties" : {
37129 "data" : {
37130 "$ref" : "#/components/schemas/Playlists_Resource_Object"
37131 },
37132 "links" : {
37133 "$ref" : "#/components/schemas/Links"
37134 }
37135 }
37136 },
37137 "Playlists_Items_Add_Multi_Relationship_Data_Document" : {
37138 "required" : [ "data", "links" ],
37139 "type" : "object",
37140 "properties" : {
37141 "data" : {
37142 "type" : "array",
37143 "items" : {
37144 "$ref" : "#/components/schemas/Playlists_Items_Add_Resource_Identifier"
37145 }
37146 },
37147 "links" : {
37148 "$ref" : "#/components/schemas/Links"
37149 },
37150 "meta" : {
37151 "$ref" : "#/components/schemas/Playlists_Items_Add_Multi_Relationship_Data_Document_Meta"
37152 }
37153 }
37154 },
37155 "Playlists_Items_Add_Multi_Relationship_Data_Document_Meta" : {
37156 "required" : [ "skipped" ],
37157 "type" : "object",
37158 "properties" : {
37159 "skipped" : {
37160 "type" : "array",
37161 "items" : {
37162 "$ref" : "#/components/schemas/PlaylistsItemsRelationshipAddOperation_Response_Meta_SkippedItem"
37163 }
37164 }
37165 }
37166 },
37167 "Playlists_Items_Add_Resource_Identifier" : {
37168 "required" : [ "id", "type" ],
37169 "type" : "object",
37170 "properties" : {
37171 "id" : {
37172 "type" : "string"
37173 },
37174 "meta" : {
37175 "$ref" : "#/components/schemas/Playlists_Items_Add_Resource_Identifier_Meta"
37176 },
37177 "type" : {
37178 "type" : "string",
37179 "enum" : [ "tracks", "videos" ]
37180 }
37181 }
37182 },
37183 "Playlists_Items_Add_Resource_Identifier_Meta" : {
37184 "required" : [ "addedAt", "itemId" ],
37185 "type" : "object",
37186 "properties" : {
37187 "addedAt" : {
37188 "type" : "string",
37189 "format" : "date-time"
37190 },
37191 "itemId" : {
37192 "type" : "string"
37193 }
37194 }
37195 },
37196 "Playlists_Items_Multi_Relationship_Data_Document" : {
37197 "required" : [ "links" ],
37198 "type" : "object",
37199 "properties" : {
37200 "data" : {
37201 "type" : "array",
37202 "items" : {
37203 "$ref" : "#/components/schemas/Playlists_Items_Resource_Identifier"
37204 }
37205 },
37206 "included" : {
37207 "$ref" : "#/components/schemas/Included"
37208 },
37209 "links" : {
37210 "$ref" : "#/components/schemas/Links"
37211 }
37212 }
37213 },
37214 "Playlists_Items_Resource_Identifier" : {
37215 "required" : [ "id", "type" ],
37216 "type" : "object",
37217 "properties" : {
37218 "id" : {
37219 "type" : "string",
37220 "description" : "Resource id",
37221 "example" : "12345"
37222 },
37223 "meta" : {
37224 "$ref" : "#/components/schemas/Playlists_Items_Resource_Identifier_Meta"
37225 },
37226 "type" : {
37227 "type" : "string",
37228 "description" : "Resource type",
37229 "example" : "tracks"
37230 }
37231 }
37232 },
37233 "Playlists_Items_Resource_Identifier_Meta" : {
37234 "type" : "object",
37235 "properties" : {
37236 "addedAt" : {
37237 "type" : "string",
37238 "format" : "date-time"
37239 },
37240 "itemCursor" : {
37241 "type" : "string"
37242 },
37243 "itemId" : {
37244 "type" : "string"
37245 },
37246 "replacement" : {
37247 "$ref" : "#/components/schemas/Replacement_Provenance"
37248 }
37249 }
37250 },
37251 "Playlists_Multi_Relationship_Data_Document" : {
37252 "required" : [ "links" ],
37253 "type" : "object",
37254 "properties" : {
37255 "data" : {
37256 "type" : "array",
37257 "items" : {
37258 "$ref" : "#/components/schemas/Resource_Identifier"
37259 }
37260 },
37261 "included" : {
37262 "$ref" : "#/components/schemas/Included"
37263 },
37264 "links" : {
37265 "$ref" : "#/components/schemas/Links"
37266 }
37267 }
37268 },
37269 "Playlists_Multi_Resource_Data_Document" : {
37270 "required" : [ "data", "links" ],
37271 "type" : "object",
37272 "properties" : {
37273 "data" : {
37274 "type" : "array",
37275 "items" : {
37276 "$ref" : "#/components/schemas/Playlists_Resource_Object"
37277 }
37278 },
37279 "included" : {
37280 "$ref" : "#/components/schemas/Included"
37281 },
37282 "links" : {
37283 "$ref" : "#/components/schemas/Links"
37284 }
37285 }
37286 },
37287 "Playlists_Relationships" : {
37288 "properties" : {
37289 "collaboratorProfiles" : {
37290 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
37291 },
37292 "collaborators" : {
37293 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
37294 },
37295 "coverArt" : {
37296 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
37297 },
37298 "items" : {
37299 "$ref" : "#/components/schemas/Playlists_Items_Multi_Relationship_Data_Document"
37300 },
37301 "ownerProfiles" : {
37302 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
37303 },
37304 "owners" : {
37305 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
37306 },
37307 "suggestedCoverArts" : {
37308 "$ref" : "#/components/schemas/Playlists_SuggestedCoverArts_Multi_Relationship_Data_Document"
37309 }
37310 }
37311 },
37312 "Playlists_Resource_Object" : {
37313 "required" : [ "id", "type" ],
37314 "type" : "object",
37315 "properties" : {
37316 "attributes" : {
37317 "$ref" : "#/components/schemas/Playlists_Attributes"
37318 },
37319 "id" : {
37320 "type" : "string",
37321 "description" : "Resource id",
37322 "example" : "12345"
37323 },
37324 "relationships" : {
37325 "$ref" : "#/components/schemas/Playlists_Relationships"
37326 },
37327 "type" : {
37328 "minLength" : 1,
37329 "type" : "string",
37330 "description" : "Resource type",
37331 "example" : "tracks"
37332 }
37333 }
37334 },
37335 "Playlists_Single_Resource_Data_Document" : {
37336 "required" : [ "data", "links" ],
37337 "type" : "object",
37338 "properties" : {
37339 "data" : {
37340 "$ref" : "#/components/schemas/Playlists_Resource_Object"
37341 },
37342 "included" : {
37343 "$ref" : "#/components/schemas/Included"
37344 },
37345 "links" : {
37346 "$ref" : "#/components/schemas/Links"
37347 }
37348 }
37349 },
37350 "Playlists_SuggestedCoverArts_Multi_Relationship_Data_Document" : {
37351 "required" : [ "links" ],
37352 "type" : "object",
37353 "properties" : {
37354 "data" : {
37355 "type" : "array",
37356 "items" : {
37357 "$ref" : "#/components/schemas/Playlists_SuggestedCoverArts_Resource_Identifier"
37358 }
37359 },
37360 "included" : {
37361 "$ref" : "#/components/schemas/Included"
37362 },
37363 "links" : {
37364 "$ref" : "#/components/schemas/Links"
37365 }
37366 }
37367 },
37368 "Playlists_SuggestedCoverArts_Resource_Identifier" : {
37369 "required" : [ "id", "type" ],
37370 "type" : "object",
37371 "properties" : {
37372 "id" : {
37373 "type" : "string",
37374 "description" : "Resource id",
37375 "example" : "12345"
37376 },
37377 "meta" : {
37378 "$ref" : "#/components/schemas/Playlists_SuggestedCoverArts_Resource_Identifier_Meta"
37379 },
37380 "type" : {
37381 "type" : "string",
37382 "description" : "Resource type",
37383 "example" : "tracks"
37384 }
37385 }
37386 },
37387 "Playlists_SuggestedCoverArts_Resource_Identifier_Meta" : {
37388 "required" : [ "backgroundColor", "foregroundColor" ],
37389 "type" : "object",
37390 "properties" : {
37391 "backgroundColor" : {
37392 "type" : "string",
37393 "description" : "Background color for the suggested artwork"
37394 },
37395 "foregroundColor" : {
37396 "type" : "string",
37397 "description" : "Foreground color for the suggested artwork"
37398 }
37399 }
37400 },
37401 "Playlists_Update_Single_Resource_Data_Document" : {
37402 "required" : [ "data", "links" ],
37403 "type" : "object",
37404 "properties" : {
37405 "data" : {
37406 "$ref" : "#/components/schemas/Playlists_Resource_Object"
37407 },
37408 "links" : {
37409 "$ref" : "#/components/schemas/Links"
37410 }
37411 }
37412 },
37413 "PriceConfigurationsCreateOperation_Payload" : {
37414 "required" : [ "data" ],
37415 "type" : "object",
37416 "properties" : {
37417 "data" : {
37418 "$ref" : "#/components/schemas/PriceConfigurationsCreateOperation_Payload_Data"
37419 }
37420 }
37421 },
37422 "PriceConfigurationsCreateOperation_Payload_Data" : {
37423 "required" : [ "attributes", "relationships", "type" ],
37424 "type" : "object",
37425 "properties" : {
37426 "attributes" : {
37427 "$ref" : "#/components/schemas/PriceConfigurationsCreateOperation_Payload_Data_Attributes"
37428 },
37429 "relationships" : {
37430 "$ref" : "#/components/schemas/PriceConfigurationsCreateOperation_Payload_Data_Relationships"
37431 },
37432 "type" : {
37433 "type" : "string",
37434 "enum" : [ "priceConfigurations" ]
37435 }
37436 }
37437 },
37438 "PriceConfigurationsCreateOperation_Payload_Data_Attributes" : {
37439 "required" : [ "currency", "price" ],
37440 "type" : "object",
37441 "properties" : {
37442 "currency" : {
37443 "type" : "string",
37444 "description" : "Currency code (ISO 4217)",
37445 "enum" : [ "USD" ]
37446 },
37447 "price" : {
37448 "type" : "string",
37449 "description" : "Price amount with max 2 decimal places",
37450 "example" : "9.99"
37451 }
37452 }
37453 },
37454 "PriceConfigurationsCreateOperation_Payload_Data_Relationships" : {
37455 "required" : [ "subjects" ],
37456 "type" : "object",
37457 "properties" : {
37458 "subjects" : {
37459 "$ref" : "#/components/schemas/PriceConfigurationsCreateOperation_Payload_Data_Relationships_Subjects"
37460 }
37461 }
37462 },
37463 "PriceConfigurationsCreateOperation_Payload_Data_Relationships_Subjects" : {
37464 "required" : [ "data" ],
37465 "type" : "object",
37466 "properties" : {
37467 "data" : {
37468 "maxItems" : 1,
37469 "minItems" : 1,
37470 "type" : "array",
37471 "items" : {
37472 "$ref" : "#/components/schemas/PriceConfigurationsCreateOperation_Payload_Subjects"
37473 }
37474 }
37475 }
37476 },
37477 "PriceConfigurationsCreateOperation_Payload_Subjects" : {
37478 "required" : [ "id", "type" ],
37479 "type" : "object",
37480 "properties" : {
37481 "id" : {
37482 "type" : "string"
37483 },
37484 "type" : {
37485 "type" : "string",
37486 "enum" : [ "tracks", "albums" ]
37487 }
37488 }
37489 },
37490 "PriceConfigurations_Attributes" : {
37491 "required" : [ "currency", "price" ],
37492 "type" : "object",
37493 "properties" : {
37494 "currency" : {
37495 "type" : "string",
37496 "description" : "Currency code (ISO 4217)",
37497 "enum" : [ "USD" ]
37498 },
37499 "price" : {
37500 "type" : "string",
37501 "description" : "Price amount with max 2 decimal places",
37502 "example" : "9.99"
37503 }
37504 }
37505 },
37506 "PriceConfigurations_Create_Single_Resource_Data_Document" : {
37507 "required" : [ "data", "links" ],
37508 "type" : "object",
37509 "properties" : {
37510 "data" : {
37511 "$ref" : "#/components/schemas/PriceConfigurations_Resource_Object"
37512 },
37513 "links" : {
37514 "$ref" : "#/components/schemas/Links"
37515 }
37516 }
37517 },
37518 "PriceConfigurations_Multi_Resource_Data_Document" : {
37519 "required" : [ "data", "links" ],
37520 "type" : "object",
37521 "properties" : {
37522 "data" : {
37523 "type" : "array",
37524 "items" : {
37525 "$ref" : "#/components/schemas/PriceConfigurations_Resource_Object"
37526 }
37527 },
37528 "included" : {
37529 "$ref" : "#/components/schemas/Included"
37530 },
37531 "links" : {
37532 "$ref" : "#/components/schemas/Links"
37533 }
37534 }
37535 },
37536 "PriceConfigurations_Resource_Object" : {
37537 "required" : [ "id", "type" ],
37538 "type" : "object",
37539 "properties" : {
37540 "attributes" : {
37541 "$ref" : "#/components/schemas/PriceConfigurations_Attributes"
37542 },
37543 "id" : {
37544 "type" : "string",
37545 "description" : "Resource id",
37546 "example" : "12345"
37547 },
37548 "type" : {
37549 "minLength" : 1,
37550 "type" : "string",
37551 "description" : "Resource type",
37552 "example" : "tracks"
37553 }
37554 }
37555 },
37556 "PriceConfigurations_Single_Resource_Data_Document" : {
37557 "required" : [ "data", "links" ],
37558 "type" : "object",
37559 "properties" : {
37560 "data" : {
37561 "$ref" : "#/components/schemas/PriceConfigurations_Resource_Object"
37562 },
37563 "included" : {
37564 "$ref" : "#/components/schemas/Included"
37565 },
37566 "links" : {
37567 "$ref" : "#/components/schemas/Links"
37568 }
37569 }
37570 },
37571 "ProviderOwners_Attributes" : {
37572 "required" : [ "createdAt" ],
37573 "type" : "object",
37574 "properties" : {
37575 "createdAt" : {
37576 "type" : "string",
37577 "format" : "date-time"
37578 }
37579 }
37580 },
37581 "ProviderOwners_Multi_Relationship_Data_Document" : {
37582 "required" : [ "links" ],
37583 "type" : "object",
37584 "properties" : {
37585 "data" : {
37586 "type" : "array",
37587 "items" : {
37588 "$ref" : "#/components/schemas/Resource_Identifier"
37589 }
37590 },
37591 "included" : {
37592 "$ref" : "#/components/schemas/Included"
37593 },
37594 "links" : {
37595 "$ref" : "#/components/schemas/Links"
37596 }
37597 }
37598 },
37599 "ProviderOwners_Multi_Resource_Data_Document" : {
37600 "required" : [ "data", "links" ],
37601 "type" : "object",
37602 "properties" : {
37603 "data" : {
37604 "type" : "array",
37605 "items" : {
37606 "$ref" : "#/components/schemas/ProviderOwners_Resource_Object"
37607 }
37608 },
37609 "included" : {
37610 "$ref" : "#/components/schemas/Included"
37611 },
37612 "links" : {
37613 "$ref" : "#/components/schemas/Links"
37614 }
37615 }
37616 },
37617 "ProviderOwners_Relationships" : {
37618 "properties" : {
37619 "owners" : {
37620 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
37621 },
37622 "provider" : {
37623 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
37624 }
37625 }
37626 },
37627 "ProviderOwners_Resource_Object" : {
37628 "required" : [ "id", "type" ],
37629 "type" : "object",
37630 "properties" : {
37631 "attributes" : {
37632 "$ref" : "#/components/schemas/ProviderOwners_Attributes"
37633 },
37634 "id" : {
37635 "type" : "string",
37636 "description" : "Resource id",
37637 "example" : "12345"
37638 },
37639 "relationships" : {
37640 "$ref" : "#/components/schemas/ProviderOwners_Relationships"
37641 },
37642 "type" : {
37643 "minLength" : 1,
37644 "type" : "string",
37645 "description" : "Resource type",
37646 "example" : "tracks"
37647 }
37648 }
37649 },
37650 "ProviderOwners_Single_Relationship_Data_Document" : {
37651 "required" : [ "links" ],
37652 "type" : "object",
37653 "properties" : {
37654 "data" : {
37655 "oneOf" : [ {
37656 "$ref" : "#/components/schemas/Resource_Identifier"
37657 }, {
37658 "type" : "object",
37659 "nullable" : true,
37660 "enum" : [ null ]
37661 } ]
37662 },
37663 "included" : {
37664 "$ref" : "#/components/schemas/Included"
37665 },
37666 "links" : {
37667 "$ref" : "#/components/schemas/Links"
37668 }
37669 }
37670 },
37671 "ProviderProductInfos_Attributes" : {
37672 "type" : "object",
37673 "properties" : {
37674 "barcodeId" : {
37675 "type" : "string"
37676 },
37677 "broken" : {
37678 "type" : "boolean"
37679 },
37680 "brokenCode" : {
37681 "type" : "integer",
37682 "format" : "int32"
37683 },
37684 "grid" : {
37685 "type" : "string"
37686 },
37687 "tracks" : {
37688 "type" : "array",
37689 "items" : {
37690 "$ref" : "#/components/schemas/TrackInfo"
37691 }
37692 }
37693 }
37694 },
37695 "ProviderProductInfos_Multi_Resource_Data_Document" : {
37696 "required" : [ "data", "links" ],
37697 "type" : "object",
37698 "properties" : {
37699 "data" : {
37700 "type" : "array",
37701 "items" : {
37702 "$ref" : "#/components/schemas/ProviderProductInfos_Resource_Object"
37703 }
37704 },
37705 "included" : {
37706 "$ref" : "#/components/schemas/Included"
37707 },
37708 "links" : {
37709 "$ref" : "#/components/schemas/Links"
37710 }
37711 }
37712 },
37713 "ProviderProductInfos_Relationships" : {
37714 "properties" : {
37715 "provider" : {
37716 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
37717 },
37718 "subject" : {
37719 "$ref" : "#/components/schemas/ProviderProductInfos_Subject_Single_Relationship_Data_Document"
37720 }
37721 }
37722 },
37723 "ProviderProductInfos_Resource_Object" : {
37724 "required" : [ "id", "type" ],
37725 "type" : "object",
37726 "properties" : {
37727 "attributes" : {
37728 "$ref" : "#/components/schemas/ProviderProductInfos_Attributes"
37729 },
37730 "id" : {
37731 "type" : "string",
37732 "description" : "Resource id",
37733 "example" : "12345"
37734 },
37735 "relationships" : {
37736 "$ref" : "#/components/schemas/ProviderProductInfos_Relationships"
37737 },
37738 "type" : {
37739 "minLength" : 1,
37740 "type" : "string",
37741 "description" : "Resource type",
37742 "example" : "tracks"
37743 }
37744 }
37745 },
37746 "ProviderProductInfos_Single_Relationship_Data_Document" : {
37747 "required" : [ "links" ],
37748 "type" : "object",
37749 "properties" : {
37750 "data" : {
37751 "oneOf" : [ {
37752 "$ref" : "#/components/schemas/Resource_Identifier"
37753 }, {
37754 "type" : "object",
37755 "nullable" : true,
37756 "enum" : [ null ]
37757 } ]
37758 },
37759 "included" : {
37760 "$ref" : "#/components/schemas/Included"
37761 },
37762 "links" : {
37763 "$ref" : "#/components/schemas/Links"
37764 }
37765 }
37766 },
37767 "ProviderProductInfos_Subject_Resource_Identifier" : {
37768 "required" : [ "id", "type" ],
37769 "type" : "object",
37770 "properties" : {
37771 "id" : {
37772 "type" : "string",
37773 "description" : "Resource id",
37774 "example" : "12345"
37775 },
37776 "meta" : {
37777 "$ref" : "#/components/schemas/ProviderProductInfos_Subject_Resource_Identifier_Meta"
37778 },
37779 "type" : {
37780 "type" : "string",
37781 "description" : "Resource type",
37782 "example" : "tracks"
37783 }
37784 }
37785 },
37786 "ProviderProductInfos_Subject_Resource_Identifier_Meta" : {
37787 "type" : "object",
37788 "properties" : {
37789 "replacement" : {
37790 "$ref" : "#/components/schemas/Replacement_Provenance"
37791 }
37792 }
37793 },
37794 "ProviderProductInfos_Subject_Single_Relationship_Data_Document" : {
37795 "required" : [ "links" ],
37796 "type" : "object",
37797 "properties" : {
37798 "data" : {
37799 "oneOf" : [ {
37800 "$ref" : "#/components/schemas/ProviderProductInfos_Subject_Resource_Identifier"
37801 }, {
37802 "type" : "object",
37803 "nullable" : true,
37804 "enum" : [ null ]
37805 } ]
37806 },
37807 "included" : {
37808 "$ref" : "#/components/schemas/Included"
37809 },
37810 "links" : {
37811 "$ref" : "#/components/schemas/Links"
37812 }
37813 }
37814 },
37815 "Providers_Attributes" : {
37816 "required" : [ "name" ],
37817 "type" : "object",
37818 "properties" : {
37819 "name" : {
37820 "type" : "string",
37821 "description" : "Provider name",
37822 "example" : "Columbia/Legacy"
37823 }
37824 }
37825 },
37826 "Providers_Resource_Object" : {
37827 "required" : [ "id", "type" ],
37828 "type" : "object",
37829 "properties" : {
37830 "attributes" : {
37831 "$ref" : "#/components/schemas/Providers_Attributes"
37832 },
37833 "id" : {
37834 "type" : "string",
37835 "description" : "Resource id",
37836 "example" : "12345"
37837 },
37838 "type" : {
37839 "minLength" : 1,
37840 "type" : "string",
37841 "description" : "Resource type",
37842 "example" : "tracks"
37843 }
37844 }
37845 },
37846 "Providers_Single_Resource_Data_Document" : {
37847 "required" : [ "data", "links" ],
37848 "type" : "object",
37849 "properties" : {
37850 "data" : {
37851 "$ref" : "#/components/schemas/Providers_Resource_Object"
37852 },
37853 "included" : {
37854 "$ref" : "#/components/schemas/Included"
37855 },
37856 "links" : {
37857 "$ref" : "#/components/schemas/Links"
37858 }
37859 }
37860 },
37861 "Purchases_Attributes" : {
37862 "required" : [ "createdAt", "status" ],
37863 "type" : "object",
37864 "properties" : {
37865 "createdAt" : {
37866 "type" : "string",
37867 "description" : "Datetime of purchase (ISO 8601)",
37868 "format" : "date-time"
37869 },
37870 "status" : {
37871 "type" : "string",
37872 "description" : "Current status of the purchase",
37873 "enum" : [ "ACTIVE" ]
37874 }
37875 }
37876 },
37877 "Purchases_Multi_Relationship_Data_Document" : {
37878 "required" : [ "links" ],
37879 "type" : "object",
37880 "properties" : {
37881 "data" : {
37882 "type" : "array",
37883 "items" : {
37884 "$ref" : "#/components/schemas/Resource_Identifier"
37885 }
37886 },
37887 "included" : {
37888 "$ref" : "#/components/schemas/Included"
37889 },
37890 "links" : {
37891 "$ref" : "#/components/schemas/Links"
37892 }
37893 }
37894 },
37895 "Purchases_Multi_Resource_Data_Document" : {
37896 "required" : [ "data", "links" ],
37897 "type" : "object",
37898 "properties" : {
37899 "data" : {
37900 "type" : "array",
37901 "items" : {
37902 "$ref" : "#/components/schemas/Purchases_Resource_Object"
37903 }
37904 },
37905 "included" : {
37906 "$ref" : "#/components/schemas/Included"
37907 },
37908 "links" : {
37909 "$ref" : "#/components/schemas/Links"
37910 }
37911 }
37912 },
37913 "Purchases_Relationships" : {
37914 "properties" : {
37915 "owners" : {
37916 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
37917 },
37918 "subject" : {
37919 "$ref" : "#/components/schemas/Purchases_Subject_Single_Relationship_Data_Document"
37920 }
37921 }
37922 },
37923 "Purchases_Resource_Object" : {
37924 "required" : [ "id", "type" ],
37925 "type" : "object",
37926 "properties" : {
37927 "attributes" : {
37928 "$ref" : "#/components/schemas/Purchases_Attributes"
37929 },
37930 "id" : {
37931 "type" : "string",
37932 "description" : "Resource id",
37933 "example" : "12345"
37934 },
37935 "relationships" : {
37936 "$ref" : "#/components/schemas/Purchases_Relationships"
37937 },
37938 "type" : {
37939 "minLength" : 1,
37940 "type" : "string",
37941 "description" : "Resource type",
37942 "example" : "tracks"
37943 }
37944 }
37945 },
37946 "Purchases_Single_Relationship_Data_Document" : {
37947 "required" : [ "links" ],
37948 "type" : "object",
37949 "properties" : {
37950 "data" : {
37951 "oneOf" : [ {
37952 "$ref" : "#/components/schemas/Resource_Identifier"
37953 }, {
37954 "type" : "object",
37955 "nullable" : true,
37956 "enum" : [ null ]
37957 } ]
37958 },
37959 "included" : {
37960 "$ref" : "#/components/schemas/Included"
37961 },
37962 "links" : {
37963 "$ref" : "#/components/schemas/Links"
37964 }
37965 }
37966 },
37967 "Purchases_Subject_Resource_Identifier" : {
37968 "required" : [ "id", "type" ],
37969 "type" : "object",
37970 "properties" : {
37971 "id" : {
37972 "type" : "string",
37973 "description" : "Resource id",
37974 "example" : "12345"
37975 },
37976 "meta" : {
37977 "$ref" : "#/components/schemas/Purchases_Subject_Resource_Identifier_Meta"
37978 },
37979 "type" : {
37980 "type" : "string",
37981 "description" : "Resource type",
37982 "example" : "tracks"
37983 }
37984 }
37985 },
37986 "Purchases_Subject_Resource_Identifier_Meta" : {
37987 "type" : "object",
37988 "properties" : {
37989 "replacement" : {
37990 "$ref" : "#/components/schemas/Replacement_Provenance"
37991 }
37992 }
37993 },
37994 "Purchases_Subject_Single_Relationship_Data_Document" : {
37995 "required" : [ "links" ],
37996 "type" : "object",
37997 "properties" : {
37998 "data" : {
37999 "oneOf" : [ {
38000 "$ref" : "#/components/schemas/Purchases_Subject_Resource_Identifier"
38001 }, {
38002 "type" : "object",
38003 "nullable" : true,
38004 "enum" : [ null ]
38005 } ]
38006 },
38007 "included" : {
38008 "$ref" : "#/components/schemas/Included"
38009 },
38010 "links" : {
38011 "$ref" : "#/components/schemas/Links"
38012 }
38013 }
38014 },
38015 "ReactionStats" : {
38016 "type" : "object",
38017 "properties" : {
38018 "countsByType" : {
38019 "type" : "object",
38020 "additionalProperties" : {
38021 "type" : "integer",
38022 "description" : "Count of reactions by type",
38023 "format" : "int32"
38024 },
38025 "description" : "Count of reactions by type"
38026 },
38027 "totalCount" : {
38028 "type" : "integer",
38029 "description" : "Total number of reactions",
38030 "format" : "int32"
38031 }
38032 },
38033 "description" : "Reaction statistics"
38034 },
38035 "ReactionsCreateOperation_Payload" : {
38036 "required" : [ "data" ],
38037 "type" : "object",
38038 "properties" : {
38039 "data" : {
38040 "$ref" : "#/components/schemas/ReactionsCreateOperation_Payload_Data"
38041 }
38042 }
38043 },
38044 "ReactionsCreateOperation_Payload_Data" : {
38045 "required" : [ "attributes", "relationships", "type" ],
38046 "type" : "object",
38047 "properties" : {
38048 "attributes" : {
38049 "$ref" : "#/components/schemas/ReactionsCreateOperation_Payload_Data_Attributes"
38050 },
38051 "relationships" : {
38052 "$ref" : "#/components/schemas/ReactionsCreateOperation_Payload_Data_Relationships"
38053 },
38054 "type" : {
38055 "type" : "string",
38056 "enum" : [ "reactions" ]
38057 }
38058 }
38059 },
38060 "ReactionsCreateOperation_Payload_Data_Attributes" : {
38061 "required" : [ "emoji" ],
38062 "type" : "object",
38063 "properties" : {
38064 "emoji" : {
38065 "type" : "string"
38066 }
38067 }
38068 },
38069 "ReactionsCreateOperation_Payload_Data_Relationships" : {
38070 "required" : [ "subject" ],
38071 "type" : "object",
38072 "properties" : {
38073 "subject" : {
38074 "$ref" : "#/components/schemas/ReactionsCreateOperation_Payload_Data_Relationships_Subject"
38075 }
38076 }
38077 },
38078 "ReactionsCreateOperation_Payload_Data_Relationships_Subject" : {
38079 "required" : [ "data" ],
38080 "type" : "object",
38081 "properties" : {
38082 "data" : {
38083 "$ref" : "#/components/schemas/ReactionsCreateOperation_Payload_Data_Relationships_Subject_Data"
38084 }
38085 }
38086 },
38087 "ReactionsCreateOperation_Payload_Data_Relationships_Subject_Data" : {
38088 "required" : [ "id", "type" ],
38089 "type" : "object",
38090 "properties" : {
38091 "id" : {
38092 "type" : "string"
38093 },
38094 "type" : {
38095 "type" : "string",
38096 "enum" : [ "albums", "tracks", "artists", "videos", "playlists", "comments" ]
38097 }
38098 }
38099 },
38100 "Reactions_Attributes" : {
38101 "required" : [ "createdAt", "emoji" ],
38102 "type" : "object",
38103 "properties" : {
38104 "createdAt" : {
38105 "type" : "string",
38106 "description" : "Datetime of the reaction creation (ISO 8601)",
38107 "format" : "date-time",
38108 "example" : "2025-11-17T12:54:48.60606Z"
38109 },
38110 "emoji" : {
38111 "type" : "string",
38112 "description" : "The type of reaction representing an emoji"
38113 }
38114 }
38115 },
38116 "Reactions_Create_Single_Resource_Data_Document" : {
38117 "required" : [ "data", "links" ],
38118 "type" : "object",
38119 "properties" : {
38120 "data" : {
38121 "$ref" : "#/components/schemas/Reactions_Resource_Object"
38122 },
38123 "links" : {
38124 "$ref" : "#/components/schemas/Links"
38125 }
38126 }
38127 },
38128 "Reactions_Multi_Relationship_Data_Document" : {
38129 "required" : [ "links" ],
38130 "type" : "object",
38131 "properties" : {
38132 "data" : {
38133 "type" : "array",
38134 "items" : {
38135 "$ref" : "#/components/schemas/Resource_Identifier"
38136 }
38137 },
38138 "included" : {
38139 "$ref" : "#/components/schemas/Included"
38140 },
38141 "links" : {
38142 "$ref" : "#/components/schemas/Links"
38143 }
38144 }
38145 },
38146 "Reactions_Multi_Resource_Data_Document" : {
38147 "required" : [ "data", "links" ],
38148 "type" : "object",
38149 "properties" : {
38150 "data" : {
38151 "type" : "array",
38152 "items" : {
38153 "$ref" : "#/components/schemas/Reactions_Resource_Object"
38154 }
38155 },
38156 "included" : {
38157 "$ref" : "#/components/schemas/Included"
38158 },
38159 "links" : {
38160 "$ref" : "#/components/schemas/Links"
38161 },
38162 "meta" : {
38163 "$ref" : "#/components/schemas/Reactions_Multi_Resource_Data_Document_Meta"
38164 }
38165 }
38166 },
38167 "Reactions_Multi_Resource_Data_Document_Meta" : {
38168 "type" : "object",
38169 "properties" : {
38170 "currentUserReaction" : {
38171 "$ref" : "#/components/schemas/CurrentUserReaction"
38172 },
38173 "stats" : {
38174 "$ref" : "#/components/schemas/ReactionStats"
38175 }
38176 },
38177 "description" : "Reaction response metadata with stats and current user reaction"
38178 },
38179 "Reactions_Relationships" : {
38180 "properties" : {
38181 "ownerProfiles" : {
38182 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
38183 },
38184 "owners" : {
38185 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
38186 }
38187 }
38188 },
38189 "Reactions_Resource_Object" : {
38190 "required" : [ "id", "type" ],
38191 "type" : "object",
38192 "properties" : {
38193 "attributes" : {
38194 "$ref" : "#/components/schemas/Reactions_Attributes"
38195 },
38196 "id" : {
38197 "type" : "string",
38198 "description" : "Resource id",
38199 "example" : "12345"
38200 },
38201 "relationships" : {
38202 "$ref" : "#/components/schemas/Reactions_Relationships"
38203 },
38204 "type" : {
38205 "minLength" : 1,
38206 "type" : "string",
38207 "description" : "Resource type",
38208 "example" : "tracks"
38209 }
38210 }
38211 },
38212 "Replacement_Original_Identifier" : {
38213 "required" : [ "id", "type" ],
38214 "type" : "object",
38215 "properties" : {
38216 "id" : {
38217 "type" : "string",
38218 "example" : "12345"
38219 },
38220 "type" : {
38221 "type" : "string",
38222 "example" : "tracks"
38223 }
38224 },
38225 "description" : "Relationship identifier before contextual replacement projection."
38226 },
38227 "Replacement_Provenance" : {
38228 "required" : [ "status" ],
38229 "type" : "object",
38230 "properties" : {
38231 "original" : {
38232 "$ref" : "#/components/schemas/Replacement_Original_Identifier"
38233 },
38234 "status" : {
38235 "type" : "string",
38236 "enum" : [ "ORIGINAL", "REPLACED", "NOT_REPLACED" ]
38237 }
38238 },
38239 "description" : "Relationship replacement projection provenance. ORIGINAL retains the requested identifier as the applicable resource, REPLACED projects another identifier, and NOT_REPLACED retains the requested identifier because no applicable replacement exists."
38240 },
38241 "Resource_Identifier" : {
38242 "required" : [ "id", "type" ],
38243 "type" : "object",
38244 "properties" : {
38245 "id" : {
38246 "type" : "string",
38247 "description" : "Resource id",
38248 "example" : "12345"
38249 },
38250 "type" : {
38251 "type" : "string",
38252 "description" : "Resource type",
38253 "example" : "tracks"
38254 }
38255 }
38256 },
38257 "Resource_ObjectObjectObject" : {
38258 "required" : [ "id", "type" ],
38259 "type" : "object",
38260 "properties" : {
38261 "attributes" : {
38262 "type" : "object"
38263 },
38264 "id" : {
38265 "type" : "string",
38266 "description" : "Resource id",
38267 "example" : "12345"
38268 },
38269 "relationships" : {
38270 "type" : "object"
38271 },
38272 "type" : {
38273 "minLength" : 1,
38274 "type" : "string",
38275 "description" : "Resource type",
38276 "example" : "tracks"
38277 }
38278 }
38279 },
38280 "SavedSharesCreateOperation_Payload" : {
38281 "required" : [ "data" ],
38282 "type" : "object",
38283 "properties" : {
38284 "data" : {
38285 "$ref" : "#/components/schemas/SavedSharesCreateOperation_Payload_Data"
38286 }
38287 }
38288 },
38289 "SavedSharesCreateOperation_Payload_Data" : {
38290 "required" : [ "relationships", "type" ],
38291 "type" : "object",
38292 "properties" : {
38293 "relationships" : {
38294 "$ref" : "#/components/schemas/SavedSharesCreateOperation_Payload_Data_Relationships"
38295 },
38296 "type" : {
38297 "type" : "string",
38298 "enum" : [ "savedShares" ]
38299 }
38300 }
38301 },
38302 "SavedSharesCreateOperation_Payload_Data_Relationships" : {
38303 "required" : [ "share" ],
38304 "type" : "object",
38305 "properties" : {
38306 "share" : {
38307 "$ref" : "#/components/schemas/SavedSharesCreateOperation_Payload_Data_Relationships_Share"
38308 }
38309 }
38310 },
38311 "SavedSharesCreateOperation_Payload_Data_Relationships_Share" : {
38312 "required" : [ "data" ],
38313 "type" : "object",
38314 "properties" : {
38315 "data" : {
38316 "$ref" : "#/components/schemas/SavedSharesCreateOperation_Payload_Data_Relationships_Share_Data"
38317 }
38318 }
38319 },
38320 "SavedSharesCreateOperation_Payload_Data_Relationships_Share_Data" : {
38321 "required" : [ "id", "type" ],
38322 "type" : "object",
38323 "properties" : {
38324 "id" : {
38325 "type" : "string"
38326 },
38327 "type" : {
38328 "type" : "string",
38329 "enum" : [ "shares" ]
38330 }
38331 }
38332 },
38333 "SavedShares_Attributes" : {
38334 "required" : [ "createdAt" ],
38335 "type" : "object",
38336 "properties" : {
38337 "createdAt" : {
38338 "type" : "string",
38339 "description" : "Datetime of saved share creation (ISO 8601)",
38340 "format" : "date-time"
38341 }
38342 }
38343 },
38344 "SavedShares_Create_Single_Resource_Data_Document" : {
38345 "required" : [ "data", "links" ],
38346 "type" : "object",
38347 "properties" : {
38348 "data" : {
38349 "$ref" : "#/components/schemas/SavedShares_Resource_Object"
38350 },
38351 "links" : {
38352 "$ref" : "#/components/schemas/Links"
38353 }
38354 }
38355 },
38356 "SavedShares_Resource_Object" : {
38357 "required" : [ "id", "type" ],
38358 "type" : "object",
38359 "properties" : {
38360 "attributes" : {
38361 "$ref" : "#/components/schemas/SavedShares_Attributes"
38362 },
38363 "id" : {
38364 "type" : "string",
38365 "description" : "Resource id",
38366 "example" : "12345"
38367 },
38368 "type" : {
38369 "minLength" : 1,
38370 "type" : "string",
38371 "description" : "Resource type",
38372 "example" : "tracks"
38373 }
38374 }
38375 },
38376 "Scopes_Attributes" : {
38377 "required" : [ "description", "name", "requiredAccessTier" ],
38378 "type" : "object",
38379 "properties" : {
38380 "consentText" : {
38381 "type" : "string",
38382 "description" : "Text shown to the end user on the OAuth consent screen when this scope is requested.",
38383 "example" : "List all playlists created by you."
38384 },
38385 "description" : {
38386 "type" : "string",
38387 "description" : "Technical description of the scope.",
38388 "example" : "Required to list playlists created by a user."
38389 },
38390 "name" : {
38391 "type" : "string",
38392 "description" : "Wire-format scope name as used in OAuth requests.",
38393 "example" : "playlists.read"
38394 },
38395 "requiredAccessTier" : {
38396 "type" : "string",
38397 "description" : "Client access tier required to request this scope. A client whose access tier is at least this value can include the scope when initiating an OAuth flow.",
38398 "example" : "THIRD_PARTY",
38399 "enum" : [ "THIRD_PARTY", "THIRD_PARTY_PROD", "PARTNER", "INTERNAL" ]
38400 }
38401 }
38402 },
38403 "Scopes_Multi_Resource_Data_Document" : {
38404 "required" : [ "data", "links" ],
38405 "type" : "object",
38406 "properties" : {
38407 "data" : {
38408 "type" : "array",
38409 "items" : {
38410 "$ref" : "#/components/schemas/Scopes_Resource_Object"
38411 }
38412 },
38413 "included" : {
38414 "$ref" : "#/components/schemas/Included"
38415 },
38416 "links" : {
38417 "$ref" : "#/components/schemas/Links"
38418 }
38419 }
38420 },
38421 "Scopes_Resource_Object" : {
38422 "required" : [ "id", "type" ],
38423 "type" : "object",
38424 "properties" : {
38425 "attributes" : {
38426 "$ref" : "#/components/schemas/Scopes_Attributes"
38427 },
38428 "id" : {
38429 "type" : "string",
38430 "description" : "Resource id",
38431 "example" : "12345"
38432 },
38433 "type" : {
38434 "minLength" : 1,
38435 "type" : "string",
38436 "description" : "Resource type",
38437 "example" : "tracks"
38438 }
38439 }
38440 },
38441 "SearchHistoryEntries_Attributes" : {
38442 "required" : [ "query" ],
38443 "type" : "object",
38444 "properties" : {
38445 "query" : {
38446 "minLength" : 1,
38447 "type" : "string"
38448 }
38449 }
38450 },
38451 "SearchHistoryEntries_Resource_Object" : {
38452 "required" : [ "id", "type" ],
38453 "type" : "object",
38454 "properties" : {
38455 "attributes" : {
38456 "$ref" : "#/components/schemas/SearchHistoryEntries_Attributes"
38457 },
38458 "id" : {
38459 "type" : "string",
38460 "description" : "Resource id",
38461 "example" : "12345"
38462 },
38463 "type" : {
38464 "minLength" : 1,
38465 "type" : "string",
38466 "description" : "Resource type",
38467 "example" : "tracks"
38468 }
38469 }
38470 },
38471 "SearchResults_Albums_Multi_Relationship_Data_Document" : {
38472 "required" : [ "links" ],
38473 "type" : "object",
38474 "properties" : {
38475 "data" : {
38476 "type" : "array",
38477 "items" : {
38478 "$ref" : "#/components/schemas/SearchResults_Albums_Resource_Identifier"
38479 }
38480 },
38481 "included" : {
38482 "$ref" : "#/components/schemas/Included"
38483 },
38484 "links" : {
38485 "$ref" : "#/components/schemas/Links"
38486 }
38487 }
38488 },
38489 "SearchResults_Albums_Resource_Identifier" : {
38490 "required" : [ "id", "type" ],
38491 "type" : "object",
38492 "properties" : {
38493 "id" : {
38494 "type" : "string",
38495 "description" : "Resource id",
38496 "example" : "12345"
38497 },
38498 "meta" : {
38499 "$ref" : "#/components/schemas/SearchResults_Albums_Resource_Identifier_Meta"
38500 },
38501 "type" : {
38502 "type" : "string",
38503 "description" : "Resource type",
38504 "example" : "tracks"
38505 }
38506 }
38507 },
38508 "SearchResults_Albums_Resource_Identifier_Meta" : {
38509 "type" : "object",
38510 "properties" : {
38511 "replacement" : {
38512 "$ref" : "#/components/schemas/Replacement_Provenance"
38513 }
38514 }
38515 },
38516 "SearchResults_Artists_Multi_Relationship_Data_Document" : {
38517 "required" : [ "links" ],
38518 "type" : "object",
38519 "properties" : {
38520 "data" : {
38521 "type" : "array",
38522 "items" : {
38523 "$ref" : "#/components/schemas/SearchResults_Artists_Resource_Identifier"
38524 }
38525 },
38526 "included" : {
38527 "$ref" : "#/components/schemas/Included"
38528 },
38529 "links" : {
38530 "$ref" : "#/components/schemas/Links"
38531 }
38532 }
38533 },
38534 "SearchResults_Artists_Resource_Identifier" : {
38535 "required" : [ "id", "type" ],
38536 "type" : "object",
38537 "properties" : {
38538 "id" : {
38539 "type" : "string",
38540 "description" : "Resource id",
38541 "example" : "12345"
38542 },
38543 "meta" : {
38544 "$ref" : "#/components/schemas/SearchResults_Artists_Resource_Identifier_Meta"
38545 },
38546 "type" : {
38547 "type" : "string",
38548 "description" : "Resource type",
38549 "example" : "tracks"
38550 }
38551 }
38552 },
38553 "SearchResults_Artists_Resource_Identifier_Meta" : {
38554 "type" : "object",
38555 "properties" : {
38556 "replacement" : {
38557 "$ref" : "#/components/schemas/Replacement_Provenance"
38558 }
38559 }
38560 },
38561 "SearchResults_Attributes" : {
38562 "required" : [ "query", "trackingId" ],
38563 "type" : "object",
38564 "properties" : {
38565 "didYouMean" : {
38566 "type" : "string",
38567 "description" : "'did you mean' prompt",
38568 "example" : "beatles"
38569 },
38570 "query" : {
38571 "type" : "string",
38572 "description" : "The search query represented by this resource",
38573 "example" : "hello"
38574 },
38575 "trackingId" : {
38576 "type" : "string",
38577 "description" : "search request unique tracking number",
38578 "example" : "5896e37d-e847-4ca6-9629-ef8001719f7f"
38579 }
38580 }
38581 },
38582 "SearchResults_Multi_Relationship_Data_Document" : {
38583 "required" : [ "links" ],
38584 "type" : "object",
38585 "properties" : {
38586 "data" : {
38587 "type" : "array",
38588 "items" : {
38589 "$ref" : "#/components/schemas/Resource_Identifier"
38590 }
38591 },
38592 "included" : {
38593 "$ref" : "#/components/schemas/Included"
38594 },
38595 "links" : {
38596 "$ref" : "#/components/schemas/Links"
38597 }
38598 }
38599 },
38600 "SearchResults_Multi_Resource_Data_Document" : {
38601 "required" : [ "data", "links" ],
38602 "type" : "object",
38603 "properties" : {
38604 "data" : {
38605 "type" : "array",
38606 "items" : {
38607 "$ref" : "#/components/schemas/SearchResults_Resource_Object"
38608 }
38609 },
38610 "included" : {
38611 "$ref" : "#/components/schemas/Included"
38612 },
38613 "links" : {
38614 "$ref" : "#/components/schemas/Links"
38615 }
38616 }
38617 },
38618 "SearchResults_Playlists_Multi_Relationship_Data_Document" : {
38619 "required" : [ "links" ],
38620 "type" : "object",
38621 "properties" : {
38622 "data" : {
38623 "type" : "array",
38624 "items" : {
38625 "$ref" : "#/components/schemas/SearchResults_Playlists_Resource_Identifier"
38626 }
38627 },
38628 "included" : {
38629 "$ref" : "#/components/schemas/Included"
38630 },
38631 "links" : {
38632 "$ref" : "#/components/schemas/Links"
38633 }
38634 }
38635 },
38636 "SearchResults_Playlists_Resource_Identifier" : {
38637 "required" : [ "id", "type" ],
38638 "type" : "object",
38639 "properties" : {
38640 "id" : {
38641 "type" : "string",
38642 "description" : "Resource id",
38643 "example" : "12345"
38644 },
38645 "meta" : {
38646 "$ref" : "#/components/schemas/SearchResults_Playlists_Resource_Identifier_Meta"
38647 },
38648 "type" : {
38649 "type" : "string",
38650 "description" : "Resource type",
38651 "example" : "tracks"
38652 }
38653 }
38654 },
38655 "SearchResults_Playlists_Resource_Identifier_Meta" : {
38656 "type" : "object",
38657 "properties" : {
38658 "replacement" : {
38659 "$ref" : "#/components/schemas/Replacement_Provenance"
38660 }
38661 }
38662 },
38663 "SearchResults_Relationships" : {
38664 "properties" : {
38665 "albums" : {
38666 "$ref" : "#/components/schemas/SearchResults_Albums_Multi_Relationship_Data_Document"
38667 },
38668 "artists" : {
38669 "$ref" : "#/components/schemas/SearchResults_Artists_Multi_Relationship_Data_Document"
38670 },
38671 "playlists" : {
38672 "$ref" : "#/components/schemas/SearchResults_Playlists_Multi_Relationship_Data_Document"
38673 },
38674 "topHits" : {
38675 "$ref" : "#/components/schemas/SearchResults_TopHits_Multi_Relationship_Data_Document"
38676 },
38677 "tracks" : {
38678 "$ref" : "#/components/schemas/SearchResults_Tracks_Multi_Relationship_Data_Document"
38679 },
38680 "videos" : {
38681 "$ref" : "#/components/schemas/SearchResults_Videos_Multi_Relationship_Data_Document"
38682 }
38683 }
38684 },
38685 "SearchResults_Resource_Object" : {
38686 "required" : [ "id", "type" ],
38687 "type" : "object",
38688 "properties" : {
38689 "attributes" : {
38690 "$ref" : "#/components/schemas/SearchResults_Attributes"
38691 },
38692 "id" : {
38693 "type" : "string",
38694 "description" : "Resource id",
38695 "example" : "12345"
38696 },
38697 "relationships" : {
38698 "$ref" : "#/components/schemas/SearchResults_Relationships"
38699 },
38700 "type" : {
38701 "minLength" : 1,
38702 "type" : "string",
38703 "description" : "Resource type",
38704 "example" : "tracks"
38705 }
38706 }
38707 },
38708 "SearchResults_TopHits_Multi_Relationship_Data_Document" : {
38709 "required" : [ "links" ],
38710 "type" : "object",
38711 "properties" : {
38712 "data" : {
38713 "type" : "array",
38714 "items" : {
38715 "$ref" : "#/components/schemas/SearchResults_TopHits_Resource_Identifier"
38716 }
38717 },
38718 "included" : {
38719 "$ref" : "#/components/schemas/Included"
38720 },
38721 "links" : {
38722 "$ref" : "#/components/schemas/Links"
38723 }
38724 }
38725 },
38726 "SearchResults_TopHits_Resource_Identifier" : {
38727 "required" : [ "id", "type" ],
38728 "type" : "object",
38729 "properties" : {
38730 "id" : {
38731 "type" : "string",
38732 "description" : "Resource id",
38733 "example" : "12345"
38734 },
38735 "meta" : {
38736 "$ref" : "#/components/schemas/SearchResults_TopHits_Resource_Identifier_Meta"
38737 },
38738 "type" : {
38739 "type" : "string",
38740 "description" : "Resource type",
38741 "example" : "tracks"
38742 }
38743 }
38744 },
38745 "SearchResults_TopHits_Resource_Identifier_Meta" : {
38746 "type" : "object",
38747 "properties" : {
38748 "replacement" : {
38749 "$ref" : "#/components/schemas/Replacement_Provenance"
38750 }
38751 }
38752 },
38753 "SearchResults_Tracks_Multi_Relationship_Data_Document" : {
38754 "required" : [ "links" ],
38755 "type" : "object",
38756 "properties" : {
38757 "data" : {
38758 "type" : "array",
38759 "items" : {
38760 "$ref" : "#/components/schemas/SearchResults_Tracks_Resource_Identifier"
38761 }
38762 },
38763 "included" : {
38764 "$ref" : "#/components/schemas/Included"
38765 },
38766 "links" : {
38767 "$ref" : "#/components/schemas/Links"
38768 }
38769 }
38770 },
38771 "SearchResults_Tracks_Resource_Identifier" : {
38772 "required" : [ "id", "type" ],
38773 "type" : "object",
38774 "properties" : {
38775 "id" : {
38776 "type" : "string",
38777 "description" : "Resource id",
38778 "example" : "12345"
38779 },
38780 "meta" : {
38781 "$ref" : "#/components/schemas/SearchResults_Tracks_Resource_Identifier_Meta"
38782 },
38783 "type" : {
38784 "type" : "string",
38785 "description" : "Resource type",
38786 "example" : "tracks"
38787 }
38788 }
38789 },
38790 "SearchResults_Tracks_Resource_Identifier_Meta" : {
38791 "type" : "object",
38792 "properties" : {
38793 "replacement" : {
38794 "$ref" : "#/components/schemas/Replacement_Provenance"
38795 }
38796 }
38797 },
38798 "SearchResults_Videos_Multi_Relationship_Data_Document" : {
38799 "required" : [ "links" ],
38800 "type" : "object",
38801 "properties" : {
38802 "data" : {
38803 "type" : "array",
38804 "items" : {
38805 "$ref" : "#/components/schemas/SearchResults_Videos_Resource_Identifier"
38806 }
38807 },
38808 "included" : {
38809 "$ref" : "#/components/schemas/Included"
38810 },
38811 "links" : {
38812 "$ref" : "#/components/schemas/Links"
38813 }
38814 }
38815 },
38816 "SearchResults_Videos_Resource_Identifier" : {
38817 "required" : [ "id", "type" ],
38818 "type" : "object",
38819 "properties" : {
38820 "id" : {
38821 "type" : "string",
38822 "description" : "Resource id",
38823 "example" : "12345"
38824 },
38825 "meta" : {
38826 "$ref" : "#/components/schemas/SearchResults_Videos_Resource_Identifier_Meta"
38827 },
38828 "type" : {
38829 "type" : "string",
38830 "description" : "Resource type",
38831 "example" : "tracks"
38832 }
38833 }
38834 },
38835 "SearchResults_Videos_Resource_Identifier_Meta" : {
38836 "type" : "object",
38837 "properties" : {
38838 "replacement" : {
38839 "$ref" : "#/components/schemas/Replacement_Provenance"
38840 }
38841 }
38842 },
38843 "SearchSuggestions_Attributes" : {
38844 "required" : [ "query", "trackingId" ],
38845 "type" : "object",
38846 "properties" : {
38847 "query" : {
38848 "type" : "string",
38849 "description" : "The search query represented by this resource",
38850 "example" : "hello"
38851 },
38852 "suggestions" : {
38853 "type" : "array",
38854 "description" : "Suggested search queries",
38855 "items" : {
38856 "$ref" : "#/components/schemas/SearchSuggestions_Suggestions"
38857 }
38858 },
38859 "trackingId" : {
38860 "minLength" : 1,
38861 "type" : "string",
38862 "description" : "Unique tracking id"
38863 }
38864 }
38865 },
38866 "SearchSuggestions_DirectHits_Multi_Relationship_Data_Document" : {
38867 "required" : [ "links" ],
38868 "type" : "object",
38869 "properties" : {
38870 "data" : {
38871 "type" : "array",
38872 "items" : {
38873 "$ref" : "#/components/schemas/SearchSuggestions_DirectHits_Resource_Identifier"
38874 }
38875 },
38876 "included" : {
38877 "$ref" : "#/components/schemas/Included"
38878 },
38879 "links" : {
38880 "$ref" : "#/components/schemas/Links"
38881 }
38882 }
38883 },
38884 "SearchSuggestions_DirectHits_Resource_Identifier" : {
38885 "required" : [ "id", "type" ],
38886 "type" : "object",
38887 "properties" : {
38888 "id" : {
38889 "type" : "string",
38890 "description" : "Resource id",
38891 "example" : "12345"
38892 },
38893 "meta" : {
38894 "$ref" : "#/components/schemas/SearchSuggestions_DirectHits_Resource_Identifier_Meta"
38895 },
38896 "type" : {
38897 "type" : "string",
38898 "description" : "Resource type",
38899 "example" : "tracks"
38900 }
38901 }
38902 },
38903 "SearchSuggestions_DirectHits_Resource_Identifier_Meta" : {
38904 "type" : "object",
38905 "properties" : {
38906 "replacement" : {
38907 "$ref" : "#/components/schemas/Replacement_Provenance"
38908 }
38909 }
38910 },
38911 "SearchSuggestions_Highlights" : {
38912 "required" : [ "length", "start" ],
38913 "type" : "object",
38914 "properties" : {
38915 "length" : {
38916 "type" : "integer",
38917 "format" : "int32"
38918 },
38919 "start" : {
38920 "type" : "integer",
38921 "format" : "int32"
38922 }
38923 }
38924 },
38925 "SearchSuggestions_Multi_Relationship_Data_Document" : {
38926 "required" : [ "links" ],
38927 "type" : "object",
38928 "properties" : {
38929 "data" : {
38930 "type" : "array",
38931 "items" : {
38932 "$ref" : "#/components/schemas/Resource_Identifier"
38933 }
38934 },
38935 "included" : {
38936 "$ref" : "#/components/schemas/Included"
38937 },
38938 "links" : {
38939 "$ref" : "#/components/schemas/Links"
38940 }
38941 }
38942 },
38943 "SearchSuggestions_Multi_Resource_Data_Document" : {
38944 "required" : [ "data", "links" ],
38945 "type" : "object",
38946 "properties" : {
38947 "data" : {
38948 "type" : "array",
38949 "items" : {
38950 "$ref" : "#/components/schemas/SearchSuggestions_Resource_Object"
38951 }
38952 },
38953 "included" : {
38954 "$ref" : "#/components/schemas/Included"
38955 },
38956 "links" : {
38957 "$ref" : "#/components/schemas/Links"
38958 }
38959 }
38960 },
38961 "SearchSuggestions_Relationships" : {
38962 "properties" : {
38963 "directHits" : {
38964 "$ref" : "#/components/schemas/SearchSuggestions_DirectHits_Multi_Relationship_Data_Document"
38965 },
38966 "history" : {
38967 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
38968 }
38969 }
38970 },
38971 "SearchSuggestions_Resource_Object" : {
38972 "required" : [ "id", "type" ],
38973 "type" : "object",
38974 "properties" : {
38975 "attributes" : {
38976 "$ref" : "#/components/schemas/SearchSuggestions_Attributes"
38977 },
38978 "id" : {
38979 "type" : "string",
38980 "description" : "Resource id",
38981 "example" : "12345"
38982 },
38983 "relationships" : {
38984 "$ref" : "#/components/schemas/SearchSuggestions_Relationships"
38985 },
38986 "type" : {
38987 "minLength" : 1,
38988 "type" : "string",
38989 "description" : "Resource type",
38990 "example" : "tracks"
38991 }
38992 }
38993 },
38994 "SearchSuggestions_Suggestions" : {
38995 "required" : [ "query" ],
38996 "type" : "object",
38997 "properties" : {
38998 "highlights" : {
38999 "type" : "array",
39000 "items" : {
39001 "$ref" : "#/components/schemas/SearchSuggestions_Highlights"
39002 }
39003 },
39004 "query" : {
39005 "minLength" : 1,
39006 "type" : "string"
39007 }
39008 },
39009 "description" : "Suggested search queries"
39010 },
39011 "SharesCreateOperation_Payload" : {
39012 "required" : [ "data" ],
39013 "type" : "object",
39014 "properties" : {
39015 "data" : {
39016 "$ref" : "#/components/schemas/SharesCreateOperation_Payload_Data"
39017 }
39018 }
39019 },
39020 "SharesCreateOperation_Payload_Data" : {
39021 "required" : [ "relationships", "type" ],
39022 "type" : "object",
39023 "properties" : {
39024 "relationships" : {
39025 "$ref" : "#/components/schemas/SharesCreateOperation_Payload_Data_Relationships"
39026 },
39027 "type" : {
39028 "type" : "string",
39029 "enum" : [ "shares" ]
39030 }
39031 }
39032 },
39033 "SharesCreateOperation_Payload_Data_Relationships" : {
39034 "required" : [ "sharedResources" ],
39035 "type" : "object",
39036 "properties" : {
39037 "sharedResources" : {
39038 "$ref" : "#/components/schemas/SharesCreateOperation_Payload_Data_Relationships_SharedResources"
39039 }
39040 }
39041 },
39042 "SharesCreateOperation_Payload_Data_Relationships_SharedResources" : {
39043 "required" : [ "data" ],
39044 "type" : "object",
39045 "properties" : {
39046 "data" : {
39047 "maxItems" : 1,
39048 "minItems" : 1,
39049 "type" : "array",
39050 "items" : {
39051 "$ref" : "#/components/schemas/SharesCreateOperation_Payload_Data_Relationships_SharedResources_Data"
39052 }
39053 }
39054 }
39055 },
39056 "SharesCreateOperation_Payload_Data_Relationships_SharedResources_Data" : {
39057 "required" : [ "id", "type" ],
39058 "type" : "object",
39059 "properties" : {
39060 "id" : {
39061 "type" : "string"
39062 },
39063 "type" : {
39064 "type" : "string",
39065 "enum" : [ "tracks", "albums" ]
39066 }
39067 }
39068 },
39069 "Shares_Attributes" : {
39070 "required" : [ "code", "createdAt" ],
39071 "type" : "object",
39072 "properties" : {
39073 "code" : {
39074 "type" : "string",
39075 "description" : "Share code"
39076 },
39077 "createdAt" : {
39078 "type" : "string",
39079 "description" : "Datetime of share creation (ISO 8601)",
39080 "format" : "date-time"
39081 },
39082 "externalLinks" : {
39083 "type" : "array",
39084 "description" : "Links external to TIDAL API",
39085 "items" : {
39086 "$ref" : "#/components/schemas/External_Link"
39087 }
39088 }
39089 }
39090 },
39091 "Shares_Create_Single_Resource_Data_Document" : {
39092 "required" : [ "data", "links" ],
39093 "type" : "object",
39094 "properties" : {
39095 "data" : {
39096 "$ref" : "#/components/schemas/Shares_Resource_Object"
39097 },
39098 "links" : {
39099 "$ref" : "#/components/schemas/Links"
39100 }
39101 }
39102 },
39103 "Shares_Multi_Relationship_Data_Document" : {
39104 "required" : [ "links" ],
39105 "type" : "object",
39106 "properties" : {
39107 "data" : {
39108 "type" : "array",
39109 "items" : {
39110 "$ref" : "#/components/schemas/Resource_Identifier"
39111 }
39112 },
39113 "included" : {
39114 "$ref" : "#/components/schemas/Included"
39115 },
39116 "links" : {
39117 "$ref" : "#/components/schemas/Links"
39118 }
39119 }
39120 },
39121 "Shares_Multi_Resource_Data_Document" : {
39122 "required" : [ "data", "links" ],
39123 "type" : "object",
39124 "properties" : {
39125 "data" : {
39126 "type" : "array",
39127 "items" : {
39128 "$ref" : "#/components/schemas/Shares_Resource_Object"
39129 }
39130 },
39131 "included" : {
39132 "$ref" : "#/components/schemas/Included"
39133 },
39134 "links" : {
39135 "$ref" : "#/components/schemas/Links"
39136 }
39137 }
39138 },
39139 "Shares_Relationships" : {
39140 "properties" : {
39141 "owners" : {
39142 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
39143 },
39144 "sharedResources" : {
39145 "$ref" : "#/components/schemas/Shares_SharedResources_Multi_Relationship_Data_Document"
39146 }
39147 }
39148 },
39149 "Shares_Resource_Object" : {
39150 "required" : [ "id", "type" ],
39151 "type" : "object",
39152 "properties" : {
39153 "attributes" : {
39154 "$ref" : "#/components/schemas/Shares_Attributes"
39155 },
39156 "id" : {
39157 "type" : "string",
39158 "description" : "Resource id",
39159 "example" : "12345"
39160 },
39161 "relationships" : {
39162 "$ref" : "#/components/schemas/Shares_Relationships"
39163 },
39164 "type" : {
39165 "minLength" : 1,
39166 "type" : "string",
39167 "description" : "Resource type",
39168 "example" : "tracks"
39169 }
39170 }
39171 },
39172 "Shares_SharedResources_Multi_Relationship_Data_Document" : {
39173 "required" : [ "links" ],
39174 "type" : "object",
39175 "properties" : {
39176 "data" : {
39177 "type" : "array",
39178 "items" : {
39179 "$ref" : "#/components/schemas/Shares_SharedResources_Resource_Identifier"
39180 }
39181 },
39182 "included" : {
39183 "$ref" : "#/components/schemas/Included"
39184 },
39185 "links" : {
39186 "$ref" : "#/components/schemas/Links"
39187 }
39188 }
39189 },
39190 "Shares_SharedResources_Resource_Identifier" : {
39191 "required" : [ "id", "type" ],
39192 "type" : "object",
39193 "properties" : {
39194 "id" : {
39195 "type" : "string",
39196 "description" : "Resource id",
39197 "example" : "12345"
39198 },
39199 "meta" : {
39200 "$ref" : "#/components/schemas/Shares_SharedResources_Resource_Identifier_Meta"
39201 },
39202 "type" : {
39203 "type" : "string",
39204 "description" : "Resource type",
39205 "example" : "tracks"
39206 }
39207 }
39208 },
39209 "Shares_SharedResources_Resource_Identifier_Meta" : {
39210 "type" : "object",
39211 "properties" : {
39212 "replacement" : {
39213 "$ref" : "#/components/schemas/Replacement_Provenance"
39214 }
39215 }
39216 },
39217 "Shares_Single_Resource_Data_Document" : {
39218 "required" : [ "data", "links" ],
39219 "type" : "object",
39220 "properties" : {
39221 "data" : {
39222 "$ref" : "#/components/schemas/Shares_Resource_Object"
39223 },
39224 "included" : {
39225 "$ref" : "#/components/schemas/Included"
39226 },
39227 "links" : {
39228 "$ref" : "#/components/schemas/Links"
39229 }
39230 }
39231 },
39232 "Single_Relationship_Data_Document" : {
39233 "required" : [ "links" ],
39234 "type" : "object",
39235 "properties" : {
39236 "data" : {
39237 "oneOf" : [ {
39238 "$ref" : "#/components/schemas/Resource_Identifier"
39239 }, {
39240 "type" : "object",
39241 "nullable" : true,
39242 "enum" : [ null ]
39243 } ]
39244 },
39245 "links" : {
39246 "$ref" : "#/components/schemas/Links"
39247 }
39248 }
39249 },
39250 "SquareConnectionsCreateOperation_Payload" : {
39251 "required" : [ "data", "meta" ],
39252 "type" : "object",
39253 "properties" : {
39254 "data" : {
39255 "$ref" : "#/components/schemas/SquareConnectionsCreateOperation_Payload_Data"
39256 },
39257 "meta" : {
39258 "$ref" : "#/components/schemas/SquareConnectionsCreateOperation_Payload_Meta"
39259 }
39260 }
39261 },
39262 "SquareConnectionsCreateOperation_Payload_Data" : {
39263 "required" : [ "type" ],
39264 "type" : "object",
39265 "properties" : {
39266 "type" : {
39267 "type" : "string",
39268 "enum" : [ "squareConnections" ]
39269 }
39270 }
39271 },
39272 "SquareConnectionsCreateOperation_Payload_Meta" : {
39273 "required" : [ "platform" ],
39274 "type" : "object",
39275 "properties" : {
39276 "platform" : {
39277 "type" : "string",
39278 "description" : "Client platform initiating Square onboarding.",
39279 "enum" : [ "WEB", "ANDROID", "IOS" ]
39280 },
39281 "redirectUrl" : {
39282 "type" : "string",
39283 "description" : "Optional post-finalize redirect URL. Otherwise uses platform default.",
39284 "example" : "tidal://square-auth/return?flow=onboarding&ref=abc"
39285 }
39286 }
39287 },
39288 "SquareConnectionsReadById403ResponseBody" : {
39289 "required" : [ "errors" ],
39290 "type" : "object",
39291 "properties" : {
39292 "errors" : {
39293 "type" : "array",
39294 "items" : {
39295 "required" : [ "code", "status" ],
39296 "type" : "object",
39297 "properties" : {
39298 "code" : {
39299 "type" : "string",
39300 "example" : "REQUIRED_TERMS_NOT_ACCEPTED",
39301 "enum" : [ "REQUIRED_TERMS_NOT_ACCEPTED" ]
39302 },
39303 "detail" : {
39304 "type" : "string",
39305 "example" : "Latest terms and conditions must be accepted"
39306 },
39307 "status" : {
39308 "type" : "string",
39309 "example" : "403"
39310 }
39311 }
39312 }
39313 }
39314 }
39315 },
39316 "SquareConnectionsReadMultiDataRelationship403ResponseBody" : {
39317 "required" : [ "errors" ],
39318 "type" : "object",
39319 "properties" : {
39320 "errors" : {
39321 "type" : "array",
39322 "items" : {
39323 "required" : [ "code", "status" ],
39324 "type" : "object",
39325 "properties" : {
39326 "code" : {
39327 "type" : "string",
39328 "example" : "REQUIRED_TERMS_NOT_ACCEPTED",
39329 "enum" : [ "REQUIRED_TERMS_NOT_ACCEPTED" ]
39330 },
39331 "detail" : {
39332 "type" : "string",
39333 "example" : "Latest terms and conditions must be accepted"
39334 },
39335 "status" : {
39336 "type" : "string",
39337 "example" : "403"
39338 }
39339 }
39340 }
39341 }
39342 }
39343 },
39344 "SquareConnectionsReadSingleDataRelationship403ResponseBody" : {
39345 "required" : [ "errors" ],
39346 "type" : "object",
39347 "properties" : {
39348 "errors" : {
39349 "type" : "array",
39350 "items" : {
39351 "required" : [ "code", "status" ],
39352 "type" : "object",
39353 "properties" : {
39354 "code" : {
39355 "type" : "string",
39356 "example" : "REQUIRED_TERMS_NOT_ACCEPTED",
39357 "enum" : [ "REQUIRED_TERMS_NOT_ACCEPTED" ]
39358 },
39359 "detail" : {
39360 "type" : "string",
39361 "example" : "Latest terms and conditions must be accepted"
39362 },
39363 "status" : {
39364 "type" : "string",
39365 "example" : "403"
39366 }
39367 }
39368 }
39369 }
39370 }
39371 },
39372 "SquareConnectionsSelectedSiteRelationshipUpdateOperation_Payload" : {
39373 "required" : [ "data" ],
39374 "type" : "object",
39375 "properties" : {
39376 "data" : {
39377 "oneOf" : [ {
39378 "$ref" : "#/components/schemas/SquareConnectionsSelectedSiteRelationshipUpdateOperation_Payload_Data"
39379 }, {
39380 "type" : "object",
39381 "nullable" : true,
39382 "enum" : [ null ]
39383 } ]
39384 }
39385 }
39386 },
39387 "SquareConnectionsSelectedSiteRelationshipUpdateOperation_Payload_Data" : {
39388 "required" : [ "id", "type" ],
39389 "type" : "object",
39390 "properties" : {
39391 "id" : {
39392 "type" : "string"
39393 },
39394 "type" : {
39395 "type" : "string",
39396 "enum" : [ "squareSites" ]
39397 }
39398 },
39399 "description" : "The site to select; null clears the selection."
39400 },
39401 "SquareConnectionsUpdateSingleDataRelationship403ResponseBody" : {
39402 "required" : [ "errors" ],
39403 "type" : "object",
39404 "properties" : {
39405 "errors" : {
39406 "type" : "array",
39407 "items" : {
39408 "required" : [ "code", "status" ],
39409 "type" : "object",
39410 "properties" : {
39411 "code" : {
39412 "type" : "string",
39413 "example" : "REQUIRED_TERMS_NOT_ACCEPTED",
39414 "enum" : [ "REQUIRED_TERMS_NOT_ACCEPTED" ]
39415 },
39416 "detail" : {
39417 "type" : "string",
39418 "example" : "Latest terms and conditions must be accepted"
39419 },
39420 "status" : {
39421 "type" : "string",
39422 "example" : "403"
39423 }
39424 }
39425 }
39426 }
39427 }
39428 },
39429 "SquareConnectionsUpdateSingleDataRelationship409ResponseBody" : {
39430 "required" : [ "errors" ],
39431 "type" : "object",
39432 "properties" : {
39433 "errors" : {
39434 "type" : "array",
39435 "items" : {
39436 "required" : [ "code", "status" ],
39437 "type" : "object",
39438 "properties" : {
39439 "code" : {
39440 "type" : "string",
39441 "example" : "IDEMPOTENT_REQUEST_IN_PROGRESS",
39442 "enum" : [ "IDEMPOTENT_REQUEST_IN_PROGRESS", "MISSING_SITES_SCOPE" ]
39443 },
39444 "detail" : {
39445 "type" : "string",
39446 "example" : "Square credential lacks required site scopes; run Square onboarding again"
39447 },
39448 "status" : {
39449 "type" : "string",
39450 "example" : "409"
39451 }
39452 }
39453 }
39454 }
39455 }
39456 },
39457 "SquareConnections_Attributes" : {
39458 "required" : [ "status" ],
39459 "type" : "object",
39460 "properties" : {
39461 "capabilities" : {
39462 "type" : "array",
39463 "description" : "Per-feature capability statuses for this Square connection. Every capability the connection offers is listed with a status carrying more than mere presence: SITES is GRANTED when the Square Online sites scopes are granted, or REQUIRES_REAUTH when the connection exists but its credential lacks them (the seller must reconnect Square via POST /squareConnections). Because a connection always offers the sites feature, SITES is always present here. Extensible â only SITES is defined today. Absent only when the connection has no sites state (e.g. no approved Square credential). Client rule: if SITES != GRANTED prompt reconnect; else if selectedSite.data is null show the site picker; else the selected site is shown to buyers.",
39464 "items" : {
39465 "$ref" : "#/components/schemas/SquareConnections_Capability"
39466 }
39467 },
39468 "createdAt" : {
39469 "type" : "string",
39470 "description" : "Timestamp when the connection was created",
39471 "format" : "date-time"
39472 },
39473 "externalLinks" : {
39474 "type" : "array",
39475 "description" : "External links for Square connection",
39476 "items" : {
39477 "$ref" : "#/components/schemas/External_Link"
39478 }
39479 },
39480 "lastModifiedAt" : {
39481 "type" : "string",
39482 "description" : "Timestamp when the connection was last modified",
39483 "format" : "date-time"
39484 },
39485 "status" : {
39486 "minLength" : 1,
39487 "type" : "string",
39488 "description" : "Current status of this Square connection",
39489 "enum" : [ "DRAFT", "PENDING_REQUIREMENTS", "KYC_PENDING", "ACCEPTED", "REJECTED", "SUSPENDED" ]
39490 }
39491 }
39492 },
39493 "SquareConnections_Capability" : {
39494 "required" : [ "name", "status" ],
39495 "type" : "object",
39496 "properties" : {
39497 "name" : {
39498 "type" : "string",
39499 "description" : "The capability name",
39500 "enum" : [ "SITES" ]
39501 },
39502 "status" : {
39503 "type" : "string",
39504 "description" : "The capability's current status",
39505 "enum" : [ "GRANTED", "REQUIRES_REAUTH" ]
39506 }
39507 }
39508 },
39509 "SquareConnections_Create_Single_Resource_Data_Document" : {
39510 "required" : [ "data", "links" ],
39511 "type" : "object",
39512 "properties" : {
39513 "data" : {
39514 "$ref" : "#/components/schemas/SquareConnections_Resource_Object"
39515 },
39516 "links" : {
39517 "$ref" : "#/components/schemas/Links"
39518 }
39519 }
39520 },
39521 "SquareConnections_Multi_Relationship_Data_Document" : {
39522 "required" : [ "links" ],
39523 "type" : "object",
39524 "properties" : {
39525 "data" : {
39526 "type" : "array",
39527 "items" : {
39528 "$ref" : "#/components/schemas/Resource_Identifier"
39529 }
39530 },
39531 "included" : {
39532 "$ref" : "#/components/schemas/Included"
39533 },
39534 "links" : {
39535 "$ref" : "#/components/schemas/Links"
39536 }
39537 }
39538 },
39539 "SquareConnections_Relationships" : {
39540 "properties" : {
39541 "selectedSite" : {
39542 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
39543 },
39544 "sites" : {
39545 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
39546 }
39547 }
39548 },
39549 "SquareConnections_Resource_Object" : {
39550 "required" : [ "id", "type" ],
39551 "type" : "object",
39552 "properties" : {
39553 "attributes" : {
39554 "$ref" : "#/components/schemas/SquareConnections_Attributes"
39555 },
39556 "id" : {
39557 "type" : "string",
39558 "description" : "Resource id",
39559 "example" : "12345"
39560 },
39561 "relationships" : {
39562 "$ref" : "#/components/schemas/SquareConnections_Relationships"
39563 },
39564 "type" : {
39565 "minLength" : 1,
39566 "type" : "string",
39567 "description" : "Resource type",
39568 "example" : "tracks"
39569 }
39570 }
39571 },
39572 "SquareConnections_SelectedSite_Update_Resource_Identifier" : {
39573 "required" : [ "id", "type" ],
39574 "type" : "object",
39575 "properties" : {
39576 "id" : {
39577 "type" : "string"
39578 },
39579 "type" : {
39580 "type" : "string",
39581 "enum" : [ "squareSites" ]
39582 }
39583 }
39584 },
39585 "SquareConnections_SelectedSite_Update_Single_Relationship_Data_Document" : {
39586 "required" : [ "data", "links" ],
39587 "type" : "object",
39588 "properties" : {
39589 "data" : {
39590 "oneOf" : [ {
39591 "$ref" : "#/components/schemas/SquareConnections_SelectedSite_Update_Resource_Identifier"
39592 }, {
39593 "type" : "object",
39594 "nullable" : true,
39595 "enum" : [ null ]
39596 } ]
39597 },
39598 "links" : {
39599 "$ref" : "#/components/schemas/Links"
39600 }
39601 }
39602 },
39603 "SquareConnections_Single_Relationship_Data_Document" : {
39604 "required" : [ "links" ],
39605 "type" : "object",
39606 "properties" : {
39607 "data" : {
39608 "oneOf" : [ {
39609 "$ref" : "#/components/schemas/Resource_Identifier"
39610 }, {
39611 "type" : "object",
39612 "nullable" : true,
39613 "enum" : [ null ]
39614 } ]
39615 },
39616 "included" : {
39617 "$ref" : "#/components/schemas/Included"
39618 },
39619 "links" : {
39620 "$ref" : "#/components/schemas/Links"
39621 }
39622 }
39623 },
39624 "SquareConnections_Single_Resource_Data_Document" : {
39625 "required" : [ "data", "links" ],
39626 "type" : "object",
39627 "properties" : {
39628 "data" : {
39629 "$ref" : "#/components/schemas/SquareConnections_Resource_Object"
39630 },
39631 "included" : {
39632 "$ref" : "#/components/schemas/Included"
39633 },
39634 "links" : {
39635 "$ref" : "#/components/schemas/Links"
39636 }
39637 }
39638 },
39639 "SquareSites_Attributes" : {
39640 "type" : "object",
39641 "properties" : {
39642 "domain" : {
39643 "type" : "string",
39644 "description" : "The site's domain, if one is configured"
39645 },
39646 "published" : {
39647 "type" : "boolean",
39648 "description" : "Whether the site is published on Square Online"
39649 },
39650 "siteTitle" : {
39651 "type" : "string",
39652 "description" : "The site's title as set by the seller in Square"
39653 }
39654 }
39655 },
39656 "SquareSites_Resource_Object" : {
39657 "required" : [ "id", "type" ],
39658 "type" : "object",
39659 "properties" : {
39660 "attributes" : {
39661 "$ref" : "#/components/schemas/SquareSites_Attributes"
39662 },
39663 "id" : {
39664 "type" : "string",
39665 "description" : "Resource id",
39666 "example" : "12345"
39667 },
39668 "type" : {
39669 "minLength" : 1,
39670 "type" : "string",
39671 "description" : "Resource type",
39672 "example" : "tracks"
39673 }
39674 }
39675 },
39676 "StripeConnectionsCreateOperation_Payload" : {
39677 "required" : [ "data" ],
39678 "type" : "object",
39679 "properties" : {
39680 "data" : {
39681 "$ref" : "#/components/schemas/StripeConnectionsCreateOperation_Payload_Data"
39682 },
39683 "meta" : {
39684 "$ref" : "#/components/schemas/StripeConnectionsCreateOperation_Payload_Meta"
39685 }
39686 }
39687 },
39688 "StripeConnectionsCreateOperation_Payload_Data" : {
39689 "required" : [ "type" ],
39690 "type" : "object",
39691 "properties" : {
39692 "attributes" : {
39693 "$ref" : "#/components/schemas/StripeConnectionsCreateOperation_Payload_Data_Attributes"
39694 },
39695 "type" : {
39696 "type" : "string",
39697 "enum" : [ "stripeConnections" ]
39698 }
39699 }
39700 },
39701 "StripeConnectionsCreateOperation_Payload_Data_Attributes" : {
39702 "type" : "object",
39703 "properties" : {
39704 "integrationType" : {
39705 "type" : "string",
39706 "description" : "Deprecated: use meta.integrationType instead.",
39707 "example" : "REDIRECT",
39708 "deprecated" : true,
39709 "default" : "REDIRECT",
39710 "enum" : [ "REDIRECT", "EMBEDDED" ]
39711 },
39712 "refreshUrl" : {
39713 "type" : "string",
39714 "description" : "Deprecated: use meta.refreshUrl instead.",
39715 "example" : "https://www.tidal.com/artist/upload/onboarding",
39716 "deprecated" : true
39717 },
39718 "returnUrl" : {
39719 "type" : "string",
39720 "description" : "Deprecated: use meta.returnUrl instead.",
39721 "example" : "https://www.tidal.com/artist/124",
39722 "deprecated" : true
39723 }
39724 }
39725 },
39726 "StripeConnectionsCreateOperation_Payload_Meta" : {
39727 "required" : [ "integrationType" ],
39728 "type" : "object",
39729 "properties" : {
39730 "integrationType" : {
39731 "type" : "string",
39732 "description" : "Integration type for Stripe onboarding",
39733 "example" : "REDIRECT",
39734 "default" : "REDIRECT",
39735 "enum" : [ "REDIRECT", "EMBEDDED" ]
39736 },
39737 "refreshUrl" : {
39738 "type" : "string",
39739 "description" : "REDIRECT only: URL to redirect to if seller drops from onboarding",
39740 "example" : "https://www.tidal.com/artist/upload/onboarding"
39741 },
39742 "returnUrl" : {
39743 "type" : "string",
39744 "description" : "REDIRECT only: URL to redirect to after completed onboarding",
39745 "example" : "https://www.tidal.com/artist/124"
39746 }
39747 }
39748 },
39749 "StripeConnections_Attributes" : {
39750 "required" : [ "status" ],
39751 "type" : "object",
39752 "properties" : {
39753 "createdAt" : {
39754 "type" : "string",
39755 "description" : "Timestamp when the connection was created",
39756 "format" : "date-time"
39757 },
39758 "externalLinks" : {
39759 "type" : "array",
39760 "description" : "External links for Stripe connection",
39761 "items" : {
39762 "$ref" : "#/components/schemas/External_Link"
39763 }
39764 },
39765 "lastModifiedAt" : {
39766 "type" : "string",
39767 "description" : "Timestamp when the connection was last modified",
39768 "format" : "date-time"
39769 },
39770 "status" : {
39771 "minLength" : 1,
39772 "type" : "string",
39773 "description" : "Current status of this Stripe connection",
39774 "enum" : [ "PENDING_REQUIREMENTS", "UNDER_REVIEW", "ACCEPTED", "REJECTED", "SUSPENDED" ]
39775 }
39776 }
39777 },
39778 "StripeConnections_Create_Single_Resource_Data_Document" : {
39779 "required" : [ "data", "links" ],
39780 "type" : "object",
39781 "properties" : {
39782 "data" : {
39783 "$ref" : "#/components/schemas/StripeConnections_Resource_Object"
39784 },
39785 "links" : {
39786 "$ref" : "#/components/schemas/Links"
39787 }
39788 }
39789 },
39790 "StripeConnections_Multi_Relationship_Data_Document" : {
39791 "required" : [ "links" ],
39792 "type" : "object",
39793 "properties" : {
39794 "data" : {
39795 "type" : "array",
39796 "items" : {
39797 "$ref" : "#/components/schemas/Resource_Identifier"
39798 }
39799 },
39800 "included" : {
39801 "$ref" : "#/components/schemas/Included"
39802 },
39803 "links" : {
39804 "$ref" : "#/components/schemas/Links"
39805 }
39806 }
39807 },
39808 "StripeConnections_Multi_Resource_Data_Document" : {
39809 "required" : [ "data", "links" ],
39810 "type" : "object",
39811 "properties" : {
39812 "data" : {
39813 "type" : "array",
39814 "items" : {
39815 "$ref" : "#/components/schemas/StripeConnections_Resource_Object"
39816 }
39817 },
39818 "included" : {
39819 "$ref" : "#/components/schemas/Included"
39820 },
39821 "links" : {
39822 "$ref" : "#/components/schemas/Links"
39823 }
39824 }
39825 },
39826 "StripeConnections_Relationships" : {
39827 "properties" : {
39828 "owners" : {
39829 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
39830 }
39831 }
39832 },
39833 "StripeConnections_Resource_Object" : {
39834 "required" : [ "id", "type" ],
39835 "type" : "object",
39836 "properties" : {
39837 "attributes" : {
39838 "$ref" : "#/components/schemas/StripeConnections_Attributes"
39839 },
39840 "id" : {
39841 "type" : "string",
39842 "description" : "Resource id",
39843 "example" : "12345"
39844 },
39845 "relationships" : {
39846 "$ref" : "#/components/schemas/StripeConnections_Relationships"
39847 },
39848 "type" : {
39849 "minLength" : 1,
39850 "type" : "string",
39851 "description" : "Resource type",
39852 "example" : "tracks"
39853 }
39854 }
39855 },
39856 "StripeDashboardLinks_Attributes" : {
39857 "type" : "object",
39858 "properties" : {
39859 "dashboardLink" : {
39860 "$ref" : "#/components/schemas/Link_Object"
39861 }
39862 }
39863 },
39864 "StripeDashboardLinks_Multi_Relationship_Data_Document" : {
39865 "required" : [ "links" ],
39866 "type" : "object",
39867 "properties" : {
39868 "data" : {
39869 "type" : "array",
39870 "items" : {
39871 "$ref" : "#/components/schemas/Resource_Identifier"
39872 }
39873 },
39874 "included" : {
39875 "$ref" : "#/components/schemas/Included"
39876 },
39877 "links" : {
39878 "$ref" : "#/components/schemas/Links"
39879 }
39880 }
39881 },
39882 "StripeDashboardLinks_Multi_Resource_Data_Document" : {
39883 "required" : [ "data", "links" ],
39884 "type" : "object",
39885 "properties" : {
39886 "data" : {
39887 "type" : "array",
39888 "items" : {
39889 "$ref" : "#/components/schemas/StripeDashboardLinks_Resource_Object"
39890 }
39891 },
39892 "included" : {
39893 "$ref" : "#/components/schemas/Included"
39894 },
39895 "links" : {
39896 "$ref" : "#/components/schemas/Links"
39897 }
39898 }
39899 },
39900 "StripeDashboardLinks_Relationships" : {
39901 "properties" : {
39902 "owners" : {
39903 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
39904 }
39905 }
39906 },
39907 "StripeDashboardLinks_Resource_Object" : {
39908 "required" : [ "id", "type" ],
39909 "type" : "object",
39910 "properties" : {
39911 "attributes" : {
39912 "$ref" : "#/components/schemas/StripeDashboardLinks_Attributes"
39913 },
39914 "id" : {
39915 "type" : "string",
39916 "description" : "Resource id",
39917 "example" : "12345"
39918 },
39919 "relationships" : {
39920 "$ref" : "#/components/schemas/StripeDashboardLinks_Relationships"
39921 },
39922 "type" : {
39923 "minLength" : 1,
39924 "type" : "string",
39925 "description" : "Resource type",
39926 "example" : "tracks"
39927 }
39928 }
39929 },
39930 "SubscriptionPriceChangeDecisionsCreateOperation_Payload" : {
39931 "required" : [ "data" ],
39932 "type" : "object",
39933 "properties" : {
39934 "data" : {
39935 "$ref" : "#/components/schemas/SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data"
39936 }
39937 }
39938 },
39939 "SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data" : {
39940 "required" : [ "attributes", "relationships", "type" ],
39941 "type" : "object",
39942 "properties" : {
39943 "attributes" : {
39944 "$ref" : "#/components/schemas/SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Attributes"
39945 },
39946 "relationships" : {
39947 "$ref" : "#/components/schemas/SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships"
39948 },
39949 "type" : {
39950 "type" : "string",
39951 "enum" : [ "subscriptionPriceChangeDecisions" ]
39952 }
39953 }
39954 },
39955 "SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Attributes" : {
39956 "required" : [ "status" ],
39957 "type" : "object",
39958 "properties" : {
39959 "status" : {
39960 "type" : "string",
39961 "description" : "The decision to record. A decision may only be created once â changing a rejection to an acceptance is a PATCH.",
39962 "enum" : [ "ACCEPTED", "REJECTED" ]
39963 }
39964 }
39965 },
39966 "SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships" : {
39967 "required" : [ "priceChange" ],
39968 "type" : "object",
39969 "properties" : {
39970 "priceChange" : {
39971 "$ref" : "#/components/schemas/SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships_PriceChange"
39972 }
39973 }
39974 },
39975 "SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships_PriceChange" : {
39976 "required" : [ "data" ],
39977 "type" : "object",
39978 "properties" : {
39979 "data" : {
39980 "$ref" : "#/components/schemas/SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships_PriceChange_Data"
39981 }
39982 }
39983 },
39984 "SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships_PriceChange_Data" : {
39985 "required" : [ "id", "type" ],
39986 "type" : "object",
39987 "properties" : {
39988 "id" : {
39989 "type" : "string"
39990 },
39991 "type" : {
39992 "type" : "string",
39993 "enum" : [ "userSubscriptionPriceChanges" ]
39994 }
39995 }
39996 },
39997 "SubscriptionPriceChangeDecisionsUpdateOperation_Payload" : {
39998 "required" : [ "data" ],
39999 "type" : "object",
40000 "properties" : {
40001 "data" : {
40002 "$ref" : "#/components/schemas/SubscriptionPriceChangeDecisionsUpdateOperation_Payload_Data"
40003 }
40004 }
40005 },
40006 "SubscriptionPriceChangeDecisionsUpdateOperation_Payload_Data" : {
40007 "required" : [ "attributes", "id", "type" ],
40008 "type" : "object",
40009 "properties" : {
40010 "attributes" : {
40011 "$ref" : "#/components/schemas/SubscriptionPriceChangeDecisionsUpdateOperation_Payload_Data_Attributes"
40012 },
40013 "id" : {
40014 "type" : "string"
40015 },
40016 "type" : {
40017 "type" : "string",
40018 "enum" : [ "subscriptionPriceChangeDecisions" ]
40019 }
40020 }
40021 },
40022 "SubscriptionPriceChangeDecisionsUpdateOperation_Payload_Data_Attributes" : {
40023 "required" : [ "status" ],
40024 "type" : "object",
40025 "properties" : {
40026 "status" : {
40027 "type" : "string",
40028 "description" : "The decision to record. The only allowed transition is REJECTED -> ACCEPTED; acceptance is permanent.",
40029 "enum" : [ "ACCEPTED", "REJECTED" ]
40030 }
40031 }
40032 },
40033 "SubscriptionPriceChangeDecisions_Attributes" : {
40034 "required" : [ "status" ],
40035 "type" : "object",
40036 "properties" : {
40037 "decidedAt" : {
40038 "type" : "string",
40039 "description" : "When the user decided. Absent when the consent was implicit (derived from the subscription start).",
40040 "format" : "date-time"
40041 },
40042 "status" : {
40043 "type" : "string",
40044 "description" : "The user's decision. ACCEPTED is permanent; REJECTED can still be flipped to ACCEPTED before the renewal.",
40045 "enum" : [ "ACCEPTED", "REJECTED" ]
40046 }
40047 }
40048 },
40049 "SubscriptionPriceChangeDecisions_Create_Single_Resource_Data_Document" : {
40050 "required" : [ "data", "links" ],
40051 "type" : "object",
40052 "properties" : {
40053 "data" : {
40054 "$ref" : "#/components/schemas/SubscriptionPriceChangeDecisions_Resource_Object"
40055 },
40056 "links" : {
40057 "$ref" : "#/components/schemas/Links"
40058 }
40059 }
40060 },
40061 "SubscriptionPriceChangeDecisions_Multi_Resource_Data_Document" : {
40062 "required" : [ "data", "links" ],
40063 "type" : "object",
40064 "properties" : {
40065 "data" : {
40066 "type" : "array",
40067 "items" : {
40068 "$ref" : "#/components/schemas/SubscriptionPriceChangeDecisions_Resource_Object"
40069 }
40070 },
40071 "included" : {
40072 "$ref" : "#/components/schemas/Included"
40073 },
40074 "links" : {
40075 "$ref" : "#/components/schemas/Links"
40076 }
40077 }
40078 },
40079 "SubscriptionPriceChangeDecisions_Relationships" : {
40080 "properties" : {
40081 "priceChange" : {
40082 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
40083 }
40084 }
40085 },
40086 "SubscriptionPriceChangeDecisions_Resource_Object" : {
40087 "required" : [ "id", "type" ],
40088 "type" : "object",
40089 "properties" : {
40090 "attributes" : {
40091 "$ref" : "#/components/schemas/SubscriptionPriceChangeDecisions_Attributes"
40092 },
40093 "id" : {
40094 "type" : "string",
40095 "description" : "Resource id",
40096 "example" : "12345"
40097 },
40098 "relationships" : {
40099 "$ref" : "#/components/schemas/SubscriptionPriceChangeDecisions_Relationships"
40100 },
40101 "type" : {
40102 "minLength" : 1,
40103 "type" : "string",
40104 "description" : "Resource type",
40105 "example" : "tracks"
40106 }
40107 }
40108 },
40109 "SubscriptionPriceChangeDecisions_Single_Relationship_Data_Document" : {
40110 "required" : [ "links" ],
40111 "type" : "object",
40112 "properties" : {
40113 "data" : {
40114 "oneOf" : [ {
40115 "$ref" : "#/components/schemas/Resource_Identifier"
40116 }, {
40117 "type" : "object",
40118 "nullable" : true,
40119 "enum" : [ null ]
40120 } ]
40121 },
40122 "included" : {
40123 "$ref" : "#/components/schemas/Included"
40124 },
40125 "links" : {
40126 "$ref" : "#/components/schemas/Links"
40127 }
40128 }
40129 },
40130 "SubscriptionPriceChangeDecisions_Update_Single_Resource_Data_Document" : {
40131 "required" : [ "data", "links" ],
40132 "type" : "object",
40133 "properties" : {
40134 "data" : {
40135 "$ref" : "#/components/schemas/SubscriptionPriceChangeDecisions_Resource_Object"
40136 },
40137 "links" : {
40138 "$ref" : "#/components/schemas/Links"
40139 }
40140 }
40141 },
40142 "TemporaryUserTokensCreateOperation_Payload" : {
40143 "required" : [ "data" ],
40144 "type" : "object",
40145 "properties" : {
40146 "data" : {
40147 "$ref" : "#/components/schemas/TemporaryUserTokensCreateOperation_Payload_Data"
40148 }
40149 }
40150 },
40151 "TemporaryUserTokensCreateOperation_Payload_Data" : {
40152 "required" : [ "type" ],
40153 "type" : "object",
40154 "properties" : {
40155 "type" : {
40156 "type" : "string",
40157 "enum" : [ "temporaryUserTokens" ]
40158 }
40159 }
40160 },
40161 "TemporaryUserTokens_Attributes" : {
40162 "type" : "object"
40163 },
40164 "TemporaryUserTokens_Create_Single_Resource_Data_Document" : {
40165 "required" : [ "data", "links" ],
40166 "type" : "object",
40167 "properties" : {
40168 "data" : {
40169 "$ref" : "#/components/schemas/TemporaryUserTokens_Resource_Object"
40170 },
40171 "links" : {
40172 "$ref" : "#/components/schemas/Links"
40173 }
40174 }
40175 },
40176 "TemporaryUserTokens_Multi_Relationship_Data_Document" : {
40177 "required" : [ "links" ],
40178 "type" : "object",
40179 "properties" : {
40180 "data" : {
40181 "type" : "array",
40182 "items" : {
40183 "$ref" : "#/components/schemas/Resource_Identifier"
40184 }
40185 },
40186 "included" : {
40187 "$ref" : "#/components/schemas/Included"
40188 },
40189 "links" : {
40190 "$ref" : "#/components/schemas/Links"
40191 }
40192 }
40193 },
40194 "TemporaryUserTokens_Relationships" : {
40195 "properties" : {
40196 "owners" : {
40197 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
40198 }
40199 }
40200 },
40201 "TemporaryUserTokens_Resource_Object" : {
40202 "required" : [ "id", "type" ],
40203 "type" : "object",
40204 "properties" : {
40205 "attributes" : {
40206 "$ref" : "#/components/schemas/TemporaryUserTokens_Attributes"
40207 },
40208 "id" : {
40209 "type" : "string",
40210 "description" : "Resource id",
40211 "example" : "12345"
40212 },
40213 "relationships" : {
40214 "$ref" : "#/components/schemas/TemporaryUserTokens_Relationships"
40215 },
40216 "type" : {
40217 "minLength" : 1,
40218 "type" : "string",
40219 "description" : "Resource type",
40220 "example" : "tracks"
40221 }
40222 }
40223 },
40224 "TemporaryUserTokens_Single_Resource_Data_Document" : {
40225 "required" : [ "data", "links" ],
40226 "type" : "object",
40227 "properties" : {
40228 "data" : {
40229 "$ref" : "#/components/schemas/TemporaryUserTokens_Resource_Object"
40230 },
40231 "included" : {
40232 "$ref" : "#/components/schemas/Included"
40233 },
40234 "links" : {
40235 "$ref" : "#/components/schemas/Links"
40236 }
40237 }
40238 },
40239 "Terms_Attributes" : {
40240 "required" : [ "contentLink", "countryCode", "effectiveAt", "termsType" ],
40241 "type" : "object",
40242 "properties" : {
40243 "contentLink" : {
40244 "$ref" : "#/components/schemas/Link_Object"
40245 },
40246 "countryCode" : {
40247 "type" : "string"
40248 },
40249 "effectiveAt" : {
40250 "type" : "string",
40251 "format" : "date-time"
40252 },
40253 "termsType" : {
40254 "type" : "string",
40255 "enum" : [ "DEVELOPER", "UPLOAD_MARKETPLACE", "MERCH_GUIDELINES" ]
40256 }
40257 }
40258 },
40259 "Terms_Multi_Resource_Data_Document" : {
40260 "required" : [ "data", "links" ],
40261 "type" : "object",
40262 "properties" : {
40263 "data" : {
40264 "type" : "array",
40265 "items" : {
40266 "$ref" : "#/components/schemas/Terms_Resource_Object"
40267 }
40268 },
40269 "included" : {
40270 "$ref" : "#/components/schemas/Included"
40271 },
40272 "links" : {
40273 "$ref" : "#/components/schemas/Links"
40274 }
40275 }
40276 },
40277 "Terms_Resource_Object" : {
40278 "required" : [ "id", "type" ],
40279 "type" : "object",
40280 "properties" : {
40281 "attributes" : {
40282 "$ref" : "#/components/schemas/Terms_Attributes"
40283 },
40284 "id" : {
40285 "type" : "string",
40286 "description" : "Resource id",
40287 "example" : "12345"
40288 },
40289 "meta" : {
40290 "$ref" : "#/components/schemas/Terms_Resource_Object_Meta"
40291 },
40292 "type" : {
40293 "minLength" : 1,
40294 "type" : "string",
40295 "description" : "Resource type",
40296 "example" : "tracks"
40297 }
40298 }
40299 },
40300 "Terms_Resource_Object_Meta" : {
40301 "required" : [ "isLatestVersion" ],
40302 "type" : "object",
40303 "properties" : {
40304 "isLatestVersion" : {
40305 "type" : "boolean"
40306 }
40307 }
40308 },
40309 "Terms_Single_Resource_Data_Document" : {
40310 "required" : [ "data", "links" ],
40311 "type" : "object",
40312 "properties" : {
40313 "data" : {
40314 "$ref" : "#/components/schemas/Terms_Resource_Object"
40315 },
40316 "included" : {
40317 "$ref" : "#/components/schemas/Included"
40318 },
40319 "links" : {
40320 "$ref" : "#/components/schemas/Links"
40321 }
40322 }
40323 },
40324 "ThirdPartyLyricsProvider" : {
40325 "required" : [ "commonTrackId", "lyricsId", "name" ],
40326 "type" : "object",
40327 "allOf" : [ {
40328 "$ref" : "#/components/schemas/LyricsProvider"
40329 }, {
40330 "type" : "object",
40331 "properties" : {
40332 "commonTrackId" : {
40333 "type" : "string"
40334 },
40335 "lyricsId" : {
40336 "type" : "string"
40337 }
40338 }
40339 } ]
40340 },
40341 "TidalLyricsProvider" : {
40342 "type" : "object",
40343 "allOf" : [ {
40344 "$ref" : "#/components/schemas/LyricsProvider"
40345 } ]
40346 },
40347 "TrackFilesReadById403ResponseBody" : {
40348 "required" : [ "errors" ],
40349 "type" : "object",
40350 "properties" : {
40351 "errors" : {
40352 "type" : "array",
40353 "items" : {
40354 "required" : [ "code", "status" ],
40355 "type" : "object",
40356 "properties" : {
40357 "code" : {
40358 "type" : "string",
40359 "example" : "CLIENT_NOT_ENTITLED",
40360 "enum" : [ "CLIENT_NOT_ENTITLED", "CONCURRENT_PLAYBACK", "GEO_RESTRICTED", "PREREQUISITE_MISSING", "PURCHASE_REQUIRED" ]
40361 },
40362 "detail" : {
40363 "type" : "string",
40364 "example" : "Required playback prerequisites are missing"
40365 },
40366 "status" : {
40367 "type" : "string",
40368 "example" : "403"
40369 }
40370 }
40371 }
40372 }
40373 }
40374 },
40375 "TrackFilesReadById404ResponseBody" : {
40376 "required" : [ "errors" ],
40377 "type" : "object",
40378 "properties" : {
40379 "errors" : {
40380 "type" : "array",
40381 "items" : {
40382 "required" : [ "code", "status" ],
40383 "type" : "object",
40384 "properties" : {
40385 "code" : {
40386 "type" : "string",
40387 "example" : "CONTENT_NOT_FOUND",
40388 "enum" : [ "CONTENT_NOT_FOUND" ]
40389 },
40390 "detail" : {
40391 "type" : "string",
40392 "example" : "Content does not exist or is no longer available"
40393 },
40394 "status" : {
40395 "type" : "string",
40396 "example" : "404"
40397 }
40398 }
40399 }
40400 }
40401 }
40402 },
40403 "TrackFiles_Attributes" : {
40404 "type" : "object",
40405 "properties" : {
40406 "albumAudioNormalizationData" : {
40407 "$ref" : "#/components/schemas/AudioNormalizationData"
40408 },
40409 "format" : {
40410 "type" : "string",
40411 "description" : "File's audio format",
40412 "enum" : [ "HEAACV1", "AACLC", "FLAC", "FLAC_HIRES", "EAC3_JOC" ]
40413 },
40414 "trackAudioNormalizationData" : {
40415 "$ref" : "#/components/schemas/AudioNormalizationData"
40416 },
40417 "trackPresentation" : {
40418 "type" : "string",
40419 "description" : "Track presentation",
40420 "enum" : [ "FULL", "PREVIEW" ]
40421 },
40422 "url" : {
40423 "type" : "string",
40424 "description" : "File URL"
40425 }
40426 }
40427 },
40428 "TrackFiles_Resource_Object" : {
40429 "required" : [ "id", "type" ],
40430 "type" : "object",
40431 "properties" : {
40432 "attributes" : {
40433 "$ref" : "#/components/schemas/TrackFiles_Attributes"
40434 },
40435 "id" : {
40436 "type" : "string",
40437 "description" : "Resource id",
40438 "example" : "12345"
40439 },
40440 "type" : {
40441 "minLength" : 1,
40442 "type" : "string",
40443 "description" : "Resource type",
40444 "example" : "tracks"
40445 }
40446 }
40447 },
40448 "TrackFiles_Single_Resource_Data_Document" : {
40449 "required" : [ "data", "links" ],
40450 "type" : "object",
40451 "properties" : {
40452 "data" : {
40453 "$ref" : "#/components/schemas/TrackFiles_Resource_Object"
40454 },
40455 "included" : {
40456 "$ref" : "#/components/schemas/Included"
40457 },
40458 "links" : {
40459 "$ref" : "#/components/schemas/Links"
40460 }
40461 }
40462 },
40463 "TrackInfo" : {
40464 "required" : [ "trackId" ],
40465 "type" : "object",
40466 "properties" : {
40467 "broken" : {
40468 "type" : "boolean"
40469 },
40470 "brokenCode" : {
40471 "type" : "integer",
40472 "format" : "int32"
40473 },
40474 "trackId" : {
40475 "type" : "string"
40476 }
40477 }
40478 },
40479 "TrackManifestsReadById403ResponseBody" : {
40480 "required" : [ "errors" ],
40481 "type" : "object",
40482 "properties" : {
40483 "errors" : {
40484 "type" : "array",
40485 "items" : {
40486 "required" : [ "code", "status" ],
40487 "type" : "object",
40488 "properties" : {
40489 "code" : {
40490 "type" : "string",
40491 "example" : "CLIENT_NOT_ENTITLED",
40492 "enum" : [ "CLIENT_NOT_ENTITLED", "CONCURRENT_PLAYBACK", "GEO_RESTRICTED", "PREREQUISITE_MISSING", "PURCHASE_REQUIRED" ]
40493 },
40494 "detail" : {
40495 "type" : "string",
40496 "example" : "Required playback prerequisites are missing"
40497 },
40498 "status" : {
40499 "type" : "string",
40500 "example" : "403"
40501 }
40502 }
40503 }
40504 }
40505 }
40506 },
40507 "TrackManifestsReadById404ResponseBody" : {
40508 "required" : [ "errors" ],
40509 "type" : "object",
40510 "properties" : {
40511 "errors" : {
40512 "type" : "array",
40513 "items" : {
40514 "required" : [ "code", "status" ],
40515 "type" : "object",
40516 "properties" : {
40517 "code" : {
40518 "type" : "string",
40519 "example" : "CONTENT_NOT_FOUND",
40520 "enum" : [ "CONTENT_NOT_FOUND" ]
40521 },
40522 "detail" : {
40523 "type" : "string",
40524 "example" : "Content does not exist or is no longer available"
40525 },
40526 "status" : {
40527 "type" : "string",
40528 "example" : "404"
40529 }
40530 }
40531 }
40532 }
40533 }
40534 },
40535 "TrackManifests_Attributes" : {
40536 "type" : "object",
40537 "properties" : {
40538 "albumAudioNormalizationData" : {
40539 "$ref" : "#/components/schemas/AudioNormalizationData"
40540 },
40541 "drmData" : {
40542 "$ref" : "#/components/schemas/DrmData"
40543 },
40544 "formats" : {
40545 "type" : "array",
40546 "description" : "Formats present in manifest",
40547 "items" : {
40548 "type" : "string",
40549 "description" : "Formats present in manifest",
40550 "enum" : [ "HEAACV1", "AACLC", "FLAC", "FLAC_HIRES", "EAC3_JOC" ]
40551 }
40552 },
40553 "hash" : {
40554 "type" : "string",
40555 "description" : "Unique manifest hash"
40556 },
40557 "previewReason" : {
40558 "type" : "string",
40559 "description" : "Why a preview is served instead of the full track",
40560 "enum" : [ "FULL_REQUIRES_SUBSCRIPTION", "FULL_REQUIRES_PURCHASE", "FULL_REQUIRES_HIGHER_ACCESS_TIER" ]
40561 },
40562 "trackAudioNormalizationData" : {
40563 "$ref" : "#/components/schemas/AudioNormalizationData"
40564 },
40565 "trackPresentation" : {
40566 "type" : "string",
40567 "description" : "Track presentation",
40568 "enum" : [ "FULL", "PREVIEW" ]
40569 },
40570 "uri" : {
40571 "type" : "string",
40572 "description" : "Manifest URI"
40573 }
40574 }
40575 },
40576 "TrackManifests_Resource_Object" : {
40577 "required" : [ "id", "type" ],
40578 "type" : "object",
40579 "properties" : {
40580 "attributes" : {
40581 "$ref" : "#/components/schemas/TrackManifests_Attributes"
40582 },
40583 "id" : {
40584 "type" : "string",
40585 "description" : "Resource id",
40586 "example" : "12345"
40587 },
40588 "type" : {
40589 "minLength" : 1,
40590 "type" : "string",
40591 "description" : "Resource type",
40592 "example" : "tracks"
40593 }
40594 }
40595 },
40596 "TrackManifests_Single_Resource_Data_Document" : {
40597 "required" : [ "data", "links" ],
40598 "type" : "object",
40599 "properties" : {
40600 "data" : {
40601 "$ref" : "#/components/schemas/TrackManifests_Resource_Object"
40602 },
40603 "included" : {
40604 "$ref" : "#/components/schemas/Included"
40605 },
40606 "links" : {
40607 "$ref" : "#/components/schemas/Links"
40608 }
40609 }
40610 },
40611 "TrackSourceFilesCreateOperation_Payload" : {
40612 "required" : [ "data" ],
40613 "type" : "object",
40614 "properties" : {
40615 "data" : {
40616 "$ref" : "#/components/schemas/TrackSourceFilesCreateOperation_Payload_Data"
40617 }
40618 }
40619 },
40620 "TrackSourceFilesCreateOperation_Payload_Data" : {
40621 "required" : [ "attributes", "relationships", "type" ],
40622 "type" : "object",
40623 "properties" : {
40624 "attributes" : {
40625 "$ref" : "#/components/schemas/TrackSourceFilesCreateOperation_Payload_Data_Attributes"
40626 },
40627 "relationships" : {
40628 "$ref" : "#/components/schemas/TrackSourceFilesCreateOperation_Payload_Data_Relationships"
40629 },
40630 "type" : {
40631 "type" : "string",
40632 "enum" : [ "trackSourceFiles" ]
40633 }
40634 }
40635 },
40636 "TrackSourceFilesCreateOperation_Payload_Data_Attributes" : {
40637 "required" : [ "md5Hash", "size" ],
40638 "type" : "object",
40639 "properties" : {
40640 "md5Hash" : {
40641 "type" : "string"
40642 },
40643 "size" : {
40644 "type" : "integer",
40645 "format" : "int64"
40646 }
40647 }
40648 },
40649 "TrackSourceFilesCreateOperation_Payload_Data_Relationships" : {
40650 "required" : [ "track" ],
40651 "type" : "object",
40652 "properties" : {
40653 "track" : {
40654 "$ref" : "#/components/schemas/TrackSourceFilesCreateOperation_Payload_Data_Relationships_Track"
40655 }
40656 }
40657 },
40658 "TrackSourceFilesCreateOperation_Payload_Data_Relationships_Track" : {
40659 "type" : "object",
40660 "properties" : {
40661 "data" : {
40662 "$ref" : "#/components/schemas/TrackSourceFilesCreateOperation_Payload_Data_Relationships_Track_Data"
40663 },
40664 "id" : {
40665 "type" : "string",
40666 "deprecated" : true
40667 },
40668 "type" : {
40669 "type" : "string",
40670 "deprecated" : true,
40671 "enum" : [ "tracks" ]
40672 }
40673 }
40674 },
40675 "TrackSourceFilesCreateOperation_Payload_Data_Relationships_Track_Data" : {
40676 "required" : [ "id", "type" ],
40677 "type" : "object",
40678 "properties" : {
40679 "id" : {
40680 "type" : "string"
40681 },
40682 "type" : {
40683 "type" : "string",
40684 "enum" : [ "tracks" ]
40685 }
40686 }
40687 },
40688 "TrackSourceFiles_Attributes" : {
40689 "required" : [ "md5Hash", "size", "status", "uploadLink" ],
40690 "type" : "object",
40691 "properties" : {
40692 "md5Hash" : {
40693 "type" : "string",
40694 "description" : "MD5 hash of file to be uploaded"
40695 },
40696 "size" : {
40697 "type" : "integer",
40698 "description" : "File size of the track in bytes",
40699 "format" : "int64"
40700 },
40701 "status" : {
40702 "$ref" : "#/components/schemas/File_Status"
40703 },
40704 "uploadLink" : {
40705 "$ref" : "#/components/schemas/File_Upload_Link"
40706 }
40707 }
40708 },
40709 "TrackSourceFiles_Create_Single_Resource_Data_Document" : {
40710 "required" : [ "data", "links" ],
40711 "type" : "object",
40712 "properties" : {
40713 "data" : {
40714 "$ref" : "#/components/schemas/TrackSourceFiles_Resource_Object"
40715 },
40716 "links" : {
40717 "$ref" : "#/components/schemas/Links"
40718 }
40719 }
40720 },
40721 "TrackSourceFiles_Multi_Relationship_Data_Document" : {
40722 "required" : [ "links" ],
40723 "type" : "object",
40724 "properties" : {
40725 "data" : {
40726 "type" : "array",
40727 "items" : {
40728 "$ref" : "#/components/schemas/Resource_Identifier"
40729 }
40730 },
40731 "included" : {
40732 "$ref" : "#/components/schemas/Included"
40733 },
40734 "links" : {
40735 "$ref" : "#/components/schemas/Links"
40736 }
40737 }
40738 },
40739 "TrackSourceFiles_Relationships" : {
40740 "properties" : {
40741 "owners" : {
40742 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
40743 }
40744 }
40745 },
40746 "TrackSourceFiles_Resource_Object" : {
40747 "required" : [ "id", "type" ],
40748 "type" : "object",
40749 "properties" : {
40750 "attributes" : {
40751 "$ref" : "#/components/schemas/TrackSourceFiles_Attributes"
40752 },
40753 "id" : {
40754 "type" : "string",
40755 "description" : "Resource id",
40756 "example" : "12345"
40757 },
40758 "relationships" : {
40759 "$ref" : "#/components/schemas/TrackSourceFiles_Relationships"
40760 },
40761 "type" : {
40762 "minLength" : 1,
40763 "type" : "string",
40764 "description" : "Resource type",
40765 "example" : "tracks"
40766 }
40767 }
40768 },
40769 "TrackSourceFiles_Single_Resource_Data_Document" : {
40770 "required" : [ "data", "links" ],
40771 "type" : "object",
40772 "properties" : {
40773 "data" : {
40774 "$ref" : "#/components/schemas/TrackSourceFiles_Resource_Object"
40775 },
40776 "included" : {
40777 "$ref" : "#/components/schemas/Included"
40778 },
40779 "links" : {
40780 "$ref" : "#/components/schemas/Links"
40781 }
40782 }
40783 },
40784 "TrackStatistics_Attributes" : {
40785 "required" : [ "totalPlaybacks", "uniqueListeners" ],
40786 "type" : "object",
40787 "properties" : {
40788 "totalPlaybacks" : {
40789 "type" : "integer",
40790 "description" : "Total playbacks",
40791 "format" : "int32"
40792 },
40793 "uniqueListeners" : {
40794 "type" : "integer",
40795 "description" : "Unique listeners",
40796 "format" : "int32"
40797 }
40798 }
40799 },
40800 "TrackStatistics_Multi_Relationship_Data_Document" : {
40801 "required" : [ "links" ],
40802 "type" : "object",
40803 "properties" : {
40804 "data" : {
40805 "type" : "array",
40806 "items" : {
40807 "$ref" : "#/components/schemas/Resource_Identifier"
40808 }
40809 },
40810 "included" : {
40811 "$ref" : "#/components/schemas/Included"
40812 },
40813 "links" : {
40814 "$ref" : "#/components/schemas/Links"
40815 }
40816 }
40817 },
40818 "TrackStatistics_Relationships" : {
40819 "properties" : {
40820 "owners" : {
40821 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
40822 }
40823 }
40824 },
40825 "TrackStatistics_Resource_Object" : {
40826 "required" : [ "id", "type" ],
40827 "type" : "object",
40828 "properties" : {
40829 "attributes" : {
40830 "$ref" : "#/components/schemas/TrackStatistics_Attributes"
40831 },
40832 "id" : {
40833 "type" : "string",
40834 "description" : "Resource id",
40835 "example" : "12345"
40836 },
40837 "relationships" : {
40838 "$ref" : "#/components/schemas/TrackStatistics_Relationships"
40839 },
40840 "type" : {
40841 "minLength" : 1,
40842 "type" : "string",
40843 "description" : "Resource type",
40844 "example" : "tracks"
40845 }
40846 }
40847 },
40848 "TrackStatistics_Single_Resource_Data_Document" : {
40849 "required" : [ "data", "links" ],
40850 "type" : "object",
40851 "properties" : {
40852 "data" : {
40853 "$ref" : "#/components/schemas/TrackStatistics_Resource_Object"
40854 },
40855 "included" : {
40856 "$ref" : "#/components/schemas/Included"
40857 },
40858 "links" : {
40859 "$ref" : "#/components/schemas/Links"
40860 }
40861 }
40862 },
40863 "TracksAlbumsRelationshipUpdateOperation_Payload" : {
40864 "required" : [ "data" ],
40865 "type" : "object",
40866 "properties" : {
40867 "data" : {
40868 "maxItems" : 1,
40869 "minItems" : 1,
40870 "type" : "array",
40871 "items" : {
40872 "$ref" : "#/components/schemas/TracksAlbumsRelationshipUpdateOperation_Payload_Data"
40873 }
40874 }
40875 }
40876 },
40877 "TracksAlbumsRelationshipUpdateOperation_Payload_Data" : {
40878 "required" : [ "id", "type" ],
40879 "type" : "object",
40880 "properties" : {
40881 "id" : {
40882 "type" : "string"
40883 },
40884 "type" : {
40885 "type" : "string",
40886 "enum" : [ "albums" ]
40887 }
40888 }
40889 },
40890 "TracksCreateOperation_Payload" : {
40891 "required" : [ "data" ],
40892 "type" : "object",
40893 "properties" : {
40894 "data" : {
40895 "$ref" : "#/components/schemas/TracksCreateOperation_Payload_Data"
40896 }
40897 }
40898 },
40899 "TracksCreateOperation_Payload_Data" : {
40900 "required" : [ "attributes", "relationships", "type" ],
40901 "type" : "object",
40902 "properties" : {
40903 "attributes" : {
40904 "$ref" : "#/components/schemas/TracksCreateOperation_Payload_Data_Attributes"
40905 },
40906 "relationships" : {
40907 "$ref" : "#/components/schemas/TracksCreateOperation_Payload_Data_Relationships"
40908 },
40909 "type" : {
40910 "type" : "string",
40911 "enum" : [ "tracks" ]
40912 }
40913 }
40914 },
40915 "TracksCreateOperation_Payload_Data_Attributes" : {
40916 "required" : [ "accessType", "title" ],
40917 "type" : "object",
40918 "properties" : {
40919 "accessType" : {
40920 "type" : "string",
40921 "description" : "Access type",
40922 "example" : "PRIVATE",
40923 "enum" : [ "PUBLIC", "UNLISTED", "PRIVATE" ]
40924 },
40925 "explicit" : {
40926 "type" : "boolean",
40927 "description" : "Explicit content",
40928 "example" : false
40929 },
40930 "title" : {
40931 "type" : "string"
40932 }
40933 }
40934 },
40935 "TracksCreateOperation_Payload_Data_Relationships" : {
40936 "required" : [ "albums", "artists" ],
40937 "type" : "object",
40938 "properties" : {
40939 "albums" : {
40940 "$ref" : "#/components/schemas/TracksCreateOperation_Payload_Data_Relationships_Albums"
40941 },
40942 "artists" : {
40943 "$ref" : "#/components/schemas/TracksCreateOperation_Payload_Data_Relationships_Artists"
40944 },
40945 "genres" : {
40946 "$ref" : "#/components/schemas/TracksCreateOperation_Payload_Data_Relationships_Genres"
40947 }
40948 }
40949 },
40950 "TracksCreateOperation_Payload_Data_Relationships_Albums" : {
40951 "required" : [ "data" ],
40952 "type" : "object",
40953 "properties" : {
40954 "data" : {
40955 "maxItems" : 1,
40956 "minItems" : 1,
40957 "type" : "array",
40958 "items" : {
40959 "$ref" : "#/components/schemas/TracksCreateOperation_Payload_Data_Relationships_Albums_Data"
40960 }
40961 }
40962 }
40963 },
40964 "TracksCreateOperation_Payload_Data_Relationships_Albums_Data" : {
40965 "required" : [ "id", "type" ],
40966 "type" : "object",
40967 "properties" : {
40968 "id" : {
40969 "type" : "string"
40970 },
40971 "type" : {
40972 "type" : "string",
40973 "enum" : [ "albums" ]
40974 }
40975 }
40976 },
40977 "TracksCreateOperation_Payload_Data_Relationships_Artists" : {
40978 "required" : [ "data" ],
40979 "type" : "object",
40980 "properties" : {
40981 "data" : {
40982 "maxItems" : 1,
40983 "minItems" : 1,
40984 "type" : "array",
40985 "items" : {
40986 "$ref" : "#/components/schemas/TracksCreateOperation_Payload_Data_Relationships_Artists_Data"
40987 }
40988 }
40989 }
40990 },
40991 "TracksCreateOperation_Payload_Data_Relationships_Artists_Data" : {
40992 "required" : [ "id", "type" ],
40993 "type" : "object",
40994 "properties" : {
40995 "id" : {
40996 "type" : "string"
40997 },
40998 "type" : {
40999 "type" : "string",
41000 "enum" : [ "artists" ]
41001 }
41002 }
41003 },
41004 "TracksCreateOperation_Payload_Data_Relationships_Genres" : {
41005 "required" : [ "data" ],
41006 "type" : "object",
41007 "properties" : {
41008 "data" : {
41009 "maxItems" : 3,
41010 "minItems" : 0,
41011 "type" : "array",
41012 "items" : {
41013 "$ref" : "#/components/schemas/TracksCreateOperation_Payload_Data_Relationships_Genres_Data"
41014 }
41015 }
41016 }
41017 },
41018 "TracksCreateOperation_Payload_Data_Relationships_Genres_Data" : {
41019 "required" : [ "id", "type" ],
41020 "type" : "object",
41021 "properties" : {
41022 "id" : {
41023 "type" : "string"
41024 },
41025 "type" : {
41026 "type" : "string",
41027 "enum" : [ "genres" ]
41028 }
41029 }
41030 },
41031 "TracksMetadataStatus_Attributes" : {
41032 "required" : [ "status" ],
41033 "type" : "object",
41034 "properties" : {
41035 "status" : {
41036 "type" : "string",
41037 "description" : "Status of the metadata detection job",
41038 "enum" : [ "PENDING", "PROCESSING", "ERROR", "OK" ]
41039 }
41040 }
41041 },
41042 "TracksMetadataStatus_Resource_Object" : {
41043 "required" : [ "id", "type" ],
41044 "type" : "object",
41045 "properties" : {
41046 "attributes" : {
41047 "$ref" : "#/components/schemas/TracksMetadataStatus_Attributes"
41048 },
41049 "id" : {
41050 "type" : "string",
41051 "description" : "Resource id",
41052 "example" : "12345"
41053 },
41054 "type" : {
41055 "minLength" : 1,
41056 "type" : "string",
41057 "description" : "Resource type",
41058 "example" : "tracks"
41059 }
41060 }
41061 },
41062 "TracksMetadataStatus_Single_Resource_Data_Document" : {
41063 "required" : [ "data", "links" ],
41064 "type" : "object",
41065 "properties" : {
41066 "data" : {
41067 "$ref" : "#/components/schemas/TracksMetadataStatus_Resource_Object"
41068 },
41069 "included" : {
41070 "$ref" : "#/components/schemas/Included"
41071 },
41072 "links" : {
41073 "$ref" : "#/components/schemas/Links"
41074 }
41075 }
41076 },
41077 "TracksUpdateOperation_Payload" : {
41078 "required" : [ "data" ],
41079 "type" : "object",
41080 "properties" : {
41081 "data" : {
41082 "$ref" : "#/components/schemas/TracksUpdateOperation_Payload_Data"
41083 }
41084 }
41085 },
41086 "TracksUpdateOperation_Payload_Data" : {
41087 "required" : [ "id", "type" ],
41088 "type" : "object",
41089 "properties" : {
41090 "attributes" : {
41091 "$ref" : "#/components/schemas/TracksUpdateOperation_Payload_Data_Attributes"
41092 },
41093 "id" : {
41094 "type" : "string"
41095 },
41096 "relationships" : {
41097 "$ref" : "#/components/schemas/TracksUpdateOperation_Payload_Data_Relationships"
41098 },
41099 "type" : {
41100 "type" : "string",
41101 "enum" : [ "tracks" ]
41102 }
41103 }
41104 },
41105 "TracksUpdateOperation_Payload_Data_Attributes" : {
41106 "type" : "object",
41107 "properties" : {
41108 "accessType" : {
41109 "type" : "string",
41110 "description" : "Access type",
41111 "example" : "PRIVATE",
41112 "enum" : [ "PUBLIC", "UNLISTED", "PRIVATE" ]
41113 },
41114 "bpm" : {
41115 "type" : "number",
41116 "format" : "float"
41117 },
41118 "explicit" : {
41119 "type" : "boolean",
41120 "description" : "Explicit content",
41121 "example" : false
41122 },
41123 "key" : {
41124 "type" : "string",
41125 "enum" : [ "UNKNOWN", "C", "CSharp", "D", "Eb", "E", "F", "FSharp", "G", "Ab", "A", "Bb", "B" ]
41126 },
41127 "keyScale" : {
41128 "type" : "string",
41129 "enum" : [ "UNKNOWN", "MAJOR", "MINOR", "AEOLIAN", "BLUES", "DORIAN", "HARMONIC_MINOR", "LOCRIAN", "LYDIAN", "MIXOLYDIAN", "PENTATONIC_MAJOR", "PHRYGIAN", "MELODIC_MINOR", "PENTATONIC_MINOR" ]
41130 },
41131 "title" : {
41132 "type" : "string"
41133 },
41134 "toneTags" : {
41135 "maxItems" : 5,
41136 "minItems" : 0,
41137 "type" : "array",
41138 "items" : {
41139 "maxLength" : 20,
41140 "minLength" : 1,
41141 "type" : "string",
41142 "description" : "Tone tags",
41143 "example" : "happy"
41144 }
41145 }
41146 }
41147 },
41148 "TracksUpdateOperation_Payload_Data_Relationships" : {
41149 "type" : "object",
41150 "properties" : {
41151 "genres" : {
41152 "$ref" : "#/components/schemas/TracksUpdateOperation_Payload_Data_Relationships_Genres"
41153 }
41154 }
41155 },
41156 "TracksUpdateOperation_Payload_Data_Relationships_Genres" : {
41157 "required" : [ "data" ],
41158 "type" : "object",
41159 "properties" : {
41160 "data" : {
41161 "maxItems" : 3,
41162 "minItems" : 0,
41163 "type" : "array",
41164 "items" : {
41165 "$ref" : "#/components/schemas/TracksUpdateOperation_Payload_Data_Relationships_Genres_Data"
41166 }
41167 }
41168 }
41169 },
41170 "TracksUpdateOperation_Payload_Data_Relationships_Genres_Data" : {
41171 "required" : [ "id", "type" ],
41172 "type" : "object",
41173 "properties" : {
41174 "id" : {
41175 "type" : "string"
41176 },
41177 "type" : {
41178 "type" : "string",
41179 "enum" : [ "genres" ]
41180 }
41181 }
41182 },
41183 "Tracks_Albums_Multi_Relationship_Data_Document" : {
41184 "required" : [ "links" ],
41185 "type" : "object",
41186 "properties" : {
41187 "data" : {
41188 "type" : "array",
41189 "items" : {
41190 "$ref" : "#/components/schemas/Tracks_Albums_Resource_Identifier"
41191 }
41192 },
41193 "included" : {
41194 "$ref" : "#/components/schemas/Included"
41195 },
41196 "links" : {
41197 "$ref" : "#/components/schemas/Links"
41198 }
41199 }
41200 },
41201 "Tracks_Albums_Resource_Identifier" : {
41202 "required" : [ "id", "type" ],
41203 "type" : "object",
41204 "properties" : {
41205 "id" : {
41206 "type" : "string",
41207 "description" : "Resource id",
41208 "example" : "12345"
41209 },
41210 "meta" : {
41211 "$ref" : "#/components/schemas/Tracks_Albums_Resource_Identifier_Meta"
41212 },
41213 "type" : {
41214 "type" : "string",
41215 "description" : "Resource type",
41216 "example" : "tracks"
41217 }
41218 }
41219 },
41220 "Tracks_Albums_Resource_Identifier_Meta" : {
41221 "type" : "object",
41222 "properties" : {
41223 "replacement" : {
41224 "$ref" : "#/components/schemas/Replacement_Provenance"
41225 }
41226 }
41227 },
41228 "Tracks_Attributes" : {
41229 "required" : [ "duration", "explicit", "isrc", "key", "keyScale", "mediaTags", "popularity", "title" ],
41230 "type" : "object",
41231 "properties" : {
41232 "accessType" : {
41233 "type" : "string",
41234 "description" : "Access type",
41235 "example" : "PRIVATE",
41236 "enum" : [ "PUBLIC", "UNLISTED", "PRIVATE" ]
41237 },
41238 "ai" : {
41239 "type" : "boolean",
41240 "description" : "Whether the track is AI-generated",
41241 "example" : false
41242 },
41243 "availability" : {
41244 "type" : "array",
41245 "description" : "Available usage for this track. Deprecated: use 'usageRules' instead. This field will be removed in a future version.",
41246 "deprecated" : true,
41247 "items" : {
41248 "type" : "string",
41249 "deprecated" : true,
41250 "enum" : [ "STREAM", "DJ", "STEM" ]
41251 }
41252 },
41253 "bpm" : {
41254 "type" : "number",
41255 "description" : "Beats per minute",
41256 "format" : "float",
41257 "example" : 60.0
41258 },
41259 "copyright" : {
41260 "$ref" : "#/components/schemas/Copyright"
41261 },
41262 "createdAt" : {
41263 "type" : "string",
41264 "description" : "Datetime of track creation (ISO 8601)",
41265 "format" : "date-time"
41266 },
41267 "duration" : {
41268 "type" : "string",
41269 "description" : "Duration (ISO 8601)",
41270 "example" : "PT2M58S"
41271 },
41272 "explicit" : {
41273 "type" : "boolean",
41274 "description" : "Explicit content",
41275 "example" : false
41276 },
41277 "externalLinks" : {
41278 "type" : "array",
41279 "description" : "Track links external to TIDAL API",
41280 "items" : {
41281 "$ref" : "#/components/schemas/External_Link"
41282 }
41283 },
41284 "isrc" : {
41285 "type" : "string",
41286 "description" : "International Standard Recording Code (ISRC)",
41287 "example" : "QMJMT1701229"
41288 },
41289 "key" : {
41290 "type" : "string",
41291 "description" : "Key",
41292 "enum" : [ "UNKNOWN", "C", "CSharp", "D", "Eb", "E", "F", "FSharp", "G", "Ab", "A", "Bb", "B" ]
41293 },
41294 "keyScale" : {
41295 "type" : "string",
41296 "description" : "The scale of the key",
41297 "enum" : [ "UNKNOWN", "MAJOR", "MINOR", "AEOLIAN", "BLUES", "DORIAN", "HARMONIC_MINOR", "LOCRIAN", "LYDIAN", "MIXOLYDIAN", "PENTATONIC_MAJOR", "PHRYGIAN", "MELODIC_MINOR", "PENTATONIC_MINOR" ]
41298 },
41299 "mediaTags" : {
41300 "type" : "array",
41301 "items" : {
41302 "type" : "string",
41303 "description" : "Media metadata tags",
41304 "example" : "HIRES_LOSSLESS"
41305 }
41306 },
41307 "popularity" : {
41308 "type" : "number",
41309 "description" : "Popularity (0.0 - 1.0)",
41310 "format" : "double",
41311 "example" : 0.56
41312 },
41313 "spotlighted" : {
41314 "type" : "boolean",
41315 "description" : "Is the track spotlighted?",
41316 "example" : true
41317 },
41318 "title" : {
41319 "type" : "string",
41320 "description" : "Track title",
41321 "example" : "Kill Jay Z"
41322 },
41323 "toneTags" : {
41324 "type" : "array",
41325 "items" : {
41326 "type" : "string",
41327 "description" : "Tone tags",
41328 "example" : "Happy"
41329 }
41330 },
41331 "version" : {
41332 "type" : "string",
41333 "description" : "Track version, complements title",
41334 "example" : "original, mix etc"
41335 }
41336 }
41337 },
41338 "Tracks_Create_Single_Resource_Data_Document" : {
41339 "required" : [ "data", "links" ],
41340 "type" : "object",
41341 "properties" : {
41342 "data" : {
41343 "$ref" : "#/components/schemas/Tracks_Resource_Object"
41344 },
41345 "links" : {
41346 "$ref" : "#/components/schemas/Links"
41347 }
41348 }
41349 },
41350 "Tracks_Multi_Relationship_Data_Document" : {
41351 "required" : [ "links" ],
41352 "type" : "object",
41353 "properties" : {
41354 "data" : {
41355 "type" : "array",
41356 "items" : {
41357 "$ref" : "#/components/schemas/Resource_Identifier"
41358 }
41359 },
41360 "included" : {
41361 "$ref" : "#/components/schemas/Included"
41362 },
41363 "links" : {
41364 "$ref" : "#/components/schemas/Links"
41365 }
41366 }
41367 },
41368 "Tracks_Multi_Resource_Data_Document" : {
41369 "required" : [ "data", "links" ],
41370 "type" : "object",
41371 "properties" : {
41372 "data" : {
41373 "type" : "array",
41374 "items" : {
41375 "$ref" : "#/components/schemas/Tracks_Resource_Object"
41376 }
41377 },
41378 "included" : {
41379 "$ref" : "#/components/schemas/Included"
41380 },
41381 "links" : {
41382 "$ref" : "#/components/schemas/Links"
41383 }
41384 }
41385 },
41386 "Tracks_Relationships" : {
41387 "properties" : {
41388 "albums" : {
41389 "$ref" : "#/components/schemas/Tracks_Albums_Multi_Relationship_Data_Document"
41390 },
41391 "artists" : {
41392 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
41393 },
41394 "credits" : {
41395 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
41396 },
41397 "download" : {
41398 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
41399 },
41400 "genres" : {
41401 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
41402 },
41403 "lyrics" : {
41404 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
41405 },
41406 "metadataStatus" : {
41407 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
41408 },
41409 "owners" : {
41410 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
41411 },
41412 "priceConfig" : {
41413 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
41414 },
41415 "providers" : {
41416 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
41417 },
41418 "radio" : {
41419 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
41420 },
41421 "replacement" : {
41422 "$ref" : "#/components/schemas/Tracks_Replacement_Single_Relationship_Data_Document"
41423 },
41424 "shares" : {
41425 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
41426 },
41427 "similarTracks" : {
41428 "$ref" : "#/components/schemas/Tracks_SimilarTracks_Multi_Relationship_Data_Document"
41429 },
41430 "sourceFile" : {
41431 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
41432 },
41433 "suggestedTracks" : {
41434 "$ref" : "#/components/schemas/Tracks_SuggestedTracks_Multi_Relationship_Data_Document"
41435 },
41436 "trackStatistics" : {
41437 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
41438 },
41439 "usageRules" : {
41440 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
41441 }
41442 }
41443 },
41444 "Tracks_Replacement_Resource_Identifier" : {
41445 "required" : [ "id", "type" ],
41446 "type" : "object",
41447 "properties" : {
41448 "id" : {
41449 "type" : "string",
41450 "description" : "Resource id",
41451 "example" : "12345"
41452 },
41453 "meta" : {
41454 "$ref" : "#/components/schemas/Tracks_Replacement_Resource_Identifier_Meta"
41455 },
41456 "type" : {
41457 "type" : "string",
41458 "description" : "Resource type",
41459 "example" : "tracks"
41460 }
41461 }
41462 },
41463 "Tracks_Replacement_Resource_Identifier_Meta" : {
41464 "type" : "object",
41465 "properties" : {
41466 "replacement" : {
41467 "$ref" : "#/components/schemas/Replacement_Provenance"
41468 }
41469 }
41470 },
41471 "Tracks_Replacement_Single_Relationship_Data_Document" : {
41472 "required" : [ "links" ],
41473 "type" : "object",
41474 "properties" : {
41475 "data" : {
41476 "oneOf" : [ {
41477 "$ref" : "#/components/schemas/Tracks_Replacement_Resource_Identifier"
41478 }, {
41479 "type" : "object",
41480 "nullable" : true,
41481 "enum" : [ null ]
41482 } ]
41483 },
41484 "included" : {
41485 "$ref" : "#/components/schemas/Included"
41486 },
41487 "links" : {
41488 "$ref" : "#/components/schemas/Links"
41489 }
41490 }
41491 },
41492 "Tracks_Resource_Object" : {
41493 "required" : [ "id", "type" ],
41494 "type" : "object",
41495 "properties" : {
41496 "attributes" : {
41497 "$ref" : "#/components/schemas/Tracks_Attributes"
41498 },
41499 "id" : {
41500 "type" : "string",
41501 "description" : "Resource id",
41502 "example" : "12345"
41503 },
41504 "relationships" : {
41505 "$ref" : "#/components/schemas/Tracks_Relationships"
41506 },
41507 "type" : {
41508 "minLength" : 1,
41509 "type" : "string",
41510 "description" : "Resource type",
41511 "example" : "tracks"
41512 }
41513 }
41514 },
41515 "Tracks_SimilarTracks_Multi_Relationship_Data_Document" : {
41516 "required" : [ "links" ],
41517 "type" : "object",
41518 "properties" : {
41519 "data" : {
41520 "type" : "array",
41521 "items" : {
41522 "$ref" : "#/components/schemas/Tracks_SimilarTracks_Resource_Identifier"
41523 }
41524 },
41525 "included" : {
41526 "$ref" : "#/components/schemas/Included"
41527 },
41528 "links" : {
41529 "$ref" : "#/components/schemas/Links"
41530 }
41531 }
41532 },
41533 "Tracks_SimilarTracks_Resource_Identifier" : {
41534 "required" : [ "id", "type" ],
41535 "type" : "object",
41536 "properties" : {
41537 "id" : {
41538 "type" : "string",
41539 "description" : "Resource id",
41540 "example" : "12345"
41541 },
41542 "meta" : {
41543 "$ref" : "#/components/schemas/Tracks_SimilarTracks_Resource_Identifier_Meta"
41544 },
41545 "type" : {
41546 "type" : "string",
41547 "description" : "Resource type",
41548 "example" : "tracks"
41549 }
41550 }
41551 },
41552 "Tracks_SimilarTracks_Resource_Identifier_Meta" : {
41553 "type" : "object",
41554 "properties" : {
41555 "replacement" : {
41556 "$ref" : "#/components/schemas/Replacement_Provenance"
41557 }
41558 }
41559 },
41560 "Tracks_Single_Relationship_Data_Document" : {
41561 "required" : [ "links" ],
41562 "type" : "object",
41563 "properties" : {
41564 "data" : {
41565 "oneOf" : [ {
41566 "$ref" : "#/components/schemas/Resource_Identifier"
41567 }, {
41568 "type" : "object",
41569 "nullable" : true,
41570 "enum" : [ null ]
41571 } ]
41572 },
41573 "included" : {
41574 "$ref" : "#/components/schemas/Included"
41575 },
41576 "links" : {
41577 "$ref" : "#/components/schemas/Links"
41578 }
41579 }
41580 },
41581 "Tracks_Single_Resource_Data_Document" : {
41582 "required" : [ "data", "links" ],
41583 "type" : "object",
41584 "properties" : {
41585 "data" : {
41586 "$ref" : "#/components/schemas/Tracks_Resource_Object"
41587 },
41588 "included" : {
41589 "$ref" : "#/components/schemas/Included"
41590 },
41591 "links" : {
41592 "$ref" : "#/components/schemas/Links"
41593 }
41594 }
41595 },
41596 "Tracks_SuggestedTracks_Multi_Relationship_Data_Document" : {
41597 "required" : [ "links" ],
41598 "type" : "object",
41599 "properties" : {
41600 "data" : {
41601 "type" : "array",
41602 "items" : {
41603 "$ref" : "#/components/schemas/Tracks_SuggestedTracks_Resource_Identifier"
41604 }
41605 },
41606 "included" : {
41607 "$ref" : "#/components/schemas/Included"
41608 },
41609 "links" : {
41610 "$ref" : "#/components/schemas/Links"
41611 }
41612 }
41613 },
41614 "Tracks_SuggestedTracks_Resource_Identifier" : {
41615 "required" : [ "id", "type" ],
41616 "type" : "object",
41617 "properties" : {
41618 "id" : {
41619 "type" : "string",
41620 "description" : "Resource id",
41621 "example" : "12345"
41622 },
41623 "meta" : {
41624 "$ref" : "#/components/schemas/Tracks_SuggestedTracks_Resource_Identifier_Meta"
41625 },
41626 "type" : {
41627 "type" : "string",
41628 "description" : "Resource type",
41629 "example" : "tracks"
41630 }
41631 }
41632 },
41633 "Tracks_SuggestedTracks_Resource_Identifier_Meta" : {
41634 "type" : "object",
41635 "properties" : {
41636 "replacement" : {
41637 "$ref" : "#/components/schemas/Replacement_Provenance"
41638 }
41639 }
41640 },
41641 "UsageRulesCreateOperation_Payload" : {
41642 "required" : [ "data" ],
41643 "type" : "object",
41644 "properties" : {
41645 "data" : {
41646 "$ref" : "#/components/schemas/UsageRulesCreateOperation_Payload_Data"
41647 }
41648 }
41649 },
41650 "UsageRulesCreateOperation_Payload_Data" : {
41651 "required" : [ "attributes", "relationships", "type" ],
41652 "type" : "object",
41653 "properties" : {
41654 "attributes" : {
41655 "$ref" : "#/components/schemas/UsageRulesCreateOperation_Payload_Data_Attributes"
41656 },
41657 "relationships" : {
41658 "$ref" : "#/components/schemas/UsageRulesCreateOperation_Payload_Data_Relationships"
41659 },
41660 "type" : {
41661 "type" : "string",
41662 "enum" : [ "usageRules" ]
41663 }
41664 }
41665 },
41666 "UsageRulesCreateOperation_Payload_Data_Attributes" : {
41667 "type" : "object",
41668 "properties" : {
41669 "countryCode" : {
41670 "type" : "string"
41671 },
41672 "free" : {
41673 "type" : "array",
41674 "items" : {
41675 "type" : "string",
41676 "enum" : [ "STREAM", "DJ", "STEM", "DOWNLOAD" ]
41677 }
41678 },
41679 "inherited" : {
41680 "type" : "boolean",
41681 "description" : "Tracks only. Set to true (with empty paid/subscription/free) to clear an explicit track-level override and inherit usage rules from the album. Must be omitted or false when providing explicit usage values."
41682 },
41683 "paid" : {
41684 "type" : "array",
41685 "items" : {
41686 "type" : "string",
41687 "enum" : [ "STREAM", "DJ", "STEM", "DOWNLOAD" ]
41688 }
41689 },
41690 "subscription" : {
41691 "type" : "array",
41692 "items" : {
41693 "type" : "string",
41694 "enum" : [ "STREAM", "DJ", "STEM", "DOWNLOAD" ]
41695 }
41696 },
41697 "validFrom" : {
41698 "type" : "string",
41699 "description" : "Datetime from which these usage rules are valid (ISO 8601)",
41700 "format" : "date-time"
41701 }
41702 }
41703 },
41704 "UsageRulesCreateOperation_Payload_Data_Relationships" : {
41705 "required" : [ "subject" ],
41706 "type" : "object",
41707 "properties" : {
41708 "subject" : {
41709 "$ref" : "#/components/schemas/UsageRulesCreateOperation_Payload_Data_Relationships_Subject"
41710 }
41711 }
41712 },
41713 "UsageRulesCreateOperation_Payload_Data_Relationships_Subject" : {
41714 "required" : [ "data" ],
41715 "type" : "object",
41716 "properties" : {
41717 "data" : {
41718 "$ref" : "#/components/schemas/UsageRulesCreateOperation_Payload_Subject"
41719 }
41720 }
41721 },
41722 "UsageRulesCreateOperation_Payload_Subject" : {
41723 "required" : [ "id", "type" ],
41724 "type" : "object",
41725 "properties" : {
41726 "id" : {
41727 "type" : "string"
41728 },
41729 "type" : {
41730 "type" : "string",
41731 "enum" : [ "tracks", "albums", "videos" ]
41732 }
41733 }
41734 },
41735 "UsageRules_Attributes" : {
41736 "required" : [ "countryCode" ],
41737 "type" : "object",
41738 "properties" : {
41739 "countryCode" : {
41740 "type" : "string",
41741 "description" : "Country code (ISO 3166-1 alpha-2)"
41742 },
41743 "free" : {
41744 "type" : "array",
41745 "description" : "Usage types allowed for free/ad-supported model",
41746 "items" : {
41747 "type" : "string",
41748 "description" : "Usage types allowed for free/ad-supported model",
41749 "enum" : [ "STREAM", "DJ", "STEM", "DOWNLOAD" ]
41750 }
41751 },
41752 "inherited" : {
41753 "type" : "boolean",
41754 "description" : "Whether these usage rules are inherited from a parent (e.g. a track inheriting from its album). Tri-state: true means the rules are inherited, false means an explicit per-track override, null means the value is unknown or not applicable (albums, videos, and legacy data)."
41755 },
41756 "paid" : {
41757 "type" : "array",
41758 "description" : "Usage types allowed for paid/purchase model",
41759 "items" : {
41760 "type" : "string",
41761 "description" : "Usage types allowed for paid/purchase model",
41762 "enum" : [ "STREAM", "DJ", "STEM", "DOWNLOAD" ]
41763 }
41764 },
41765 "subscription" : {
41766 "type" : "array",
41767 "description" : "Usage types allowed for subscription model",
41768 "items" : {
41769 "type" : "string",
41770 "description" : "Usage types allowed for subscription model",
41771 "enum" : [ "STREAM", "DJ", "STEM", "DOWNLOAD" ]
41772 }
41773 },
41774 "validFrom" : {
41775 "type" : "string",
41776 "description" : "Datetime from which these usage rules are valid (ISO 8601)",
41777 "format" : "date-time"
41778 }
41779 }
41780 },
41781 "UsageRules_Create_Single_Resource_Data_Document" : {
41782 "required" : [ "data", "links" ],
41783 "type" : "object",
41784 "properties" : {
41785 "data" : {
41786 "$ref" : "#/components/schemas/UsageRules_Resource_Object"
41787 },
41788 "links" : {
41789 "$ref" : "#/components/schemas/Links"
41790 }
41791 }
41792 },
41793 "UsageRules_Resource_Object" : {
41794 "required" : [ "id", "type" ],
41795 "type" : "object",
41796 "properties" : {
41797 "attributes" : {
41798 "$ref" : "#/components/schemas/UsageRules_Attributes"
41799 },
41800 "id" : {
41801 "type" : "string",
41802 "description" : "Resource id",
41803 "example" : "12345"
41804 },
41805 "type" : {
41806 "minLength" : 1,
41807 "type" : "string",
41808 "description" : "Resource type",
41809 "example" : "tracks"
41810 }
41811 }
41812 },
41813 "UsageRules_Single_Resource_Data_Document" : {
41814 "required" : [ "data", "links" ],
41815 "type" : "object",
41816 "properties" : {
41817 "data" : {
41818 "$ref" : "#/components/schemas/UsageRules_Resource_Object"
41819 },
41820 "included" : {
41821 "$ref" : "#/components/schemas/Included"
41822 },
41823 "links" : {
41824 "$ref" : "#/components/schemas/Links"
41825 }
41826 }
41827 },
41828 "UserCollection" : {
41829 "required" : [ "id", "type" ],
41830 "type" : "object",
41831 "properties" : {
41832 "id" : {
41833 "type" : "string"
41834 },
41835 "type" : {
41836 "type" : "string",
41837 "enum" : [ "userCollectionPlaylists" ]
41838 }
41839 }
41840 },
41841 "UserCollectionAlbumsAddMultiDataRelationshipWithResponse409ResponseBody" : {
41842 "required" : [ "errors" ],
41843 "type" : "object",
41844 "properties" : {
41845 "errors" : {
41846 "type" : "array",
41847 "items" : {
41848 "required" : [ "code", "status" ],
41849 "type" : "object",
41850 "properties" : {
41851 "code" : {
41852 "type" : "string",
41853 "example" : "DUPLICATE_ITEMS_IN_COLLECTION",
41854 "enum" : [ "DUPLICATE_ITEMS_IN_COLLECTION", "IDEMPOTENT_REQUEST_IN_PROGRESS", "TOO_MANY_ITEMS_IN_COLLECTION" ]
41855 },
41856 "detail" : {
41857 "type" : "string",
41858 "example" : "Collection item limit reached"
41859 },
41860 "status" : {
41861 "type" : "string",
41862 "example" : "409"
41863 }
41864 }
41865 }
41866 }
41867 }
41868 },
41869 "UserCollectionAlbumsItemsRelationshipAddOperation_Payload" : {
41870 "required" : [ "data" ],
41871 "type" : "object",
41872 "properties" : {
41873 "data" : {
41874 "maxItems" : 50,
41875 "minItems" : 1,
41876 "type" : "array",
41877 "items" : {
41878 "$ref" : "#/components/schemas/UserCollectionAlbumsItemsRelationshipAddOperation_Payload_Data"
41879 }
41880 }
41881 }
41882 },
41883 "UserCollectionAlbumsItemsRelationshipAddOperation_Payload_Data" : {
41884 "required" : [ "id", "type" ],
41885 "type" : "object",
41886 "properties" : {
41887 "id" : {
41888 "type" : "string"
41889 },
41890 "meta" : {
41891 "$ref" : "#/components/schemas/UserCollectionAlbumsItemsRelationshipAddOperation_Payload_Data_Meta"
41892 },
41893 "type" : {
41894 "type" : "string",
41895 "enum" : [ "albums" ]
41896 }
41897 }
41898 },
41899 "UserCollectionAlbumsItemsRelationshipAddOperation_Payload_Data_Meta" : {
41900 "type" : "object",
41901 "properties" : {
41902 "addedAt" : {
41903 "type" : "string",
41904 "format" : "date-time"
41905 }
41906 }
41907 },
41908 "UserCollectionAlbumsItemsRelationshipAddOperation_Response_Meta_SkippedItem" : {
41909 "required" : [ "id", "reason", "type" ],
41910 "type" : "object",
41911 "properties" : {
41912 "id" : {
41913 "type" : "string"
41914 },
41915 "reason" : {
41916 "type" : "string",
41917 "enum" : [ "NOT_FOUND", "ALREADY_PRESENT" ]
41918 },
41919 "type" : {
41920 "type" : "string",
41921 "enum" : [ "albums" ]
41922 }
41923 }
41924 },
41925 "UserCollectionAlbumsItemsRelationshipRemoveOperation_Payload" : {
41926 "required" : [ "data" ],
41927 "type" : "object",
41928 "properties" : {
41929 "data" : {
41930 "maxItems" : 50,
41931 "minItems" : 1,
41932 "type" : "array",
41933 "items" : {
41934 "$ref" : "#/components/schemas/UserCollectionAlbumsItemsRelationshipRemoveOperation_Payload_Data"
41935 }
41936 }
41937 }
41938 },
41939 "UserCollectionAlbumsItemsRelationshipRemoveOperation_Payload_Data" : {
41940 "required" : [ "id", "type" ],
41941 "type" : "object",
41942 "properties" : {
41943 "id" : {
41944 "type" : "string"
41945 },
41946 "type" : {
41947 "type" : "string",
41948 "enum" : [ "albums" ]
41949 }
41950 }
41951 },
41952 "UserCollectionAlbums_Attributes" : {
41953 "required" : [ "numberOfItems" ],
41954 "type" : "object",
41955 "properties" : {
41956 "lastModifiedAt" : {
41957 "type" : "string",
41958 "description" : "When the collection was last modified",
41959 "format" : "date-time"
41960 },
41961 "numberOfItems" : {
41962 "type" : "integer",
41963 "description" : "Number of items in the collection",
41964 "format" : "int32"
41965 }
41966 }
41967 },
41968 "UserCollectionAlbums_Items_Add_Multi_Relationship_Data_Document" : {
41969 "required" : [ "data", "links" ],
41970 "type" : "object",
41971 "properties" : {
41972 "data" : {
41973 "type" : "array",
41974 "items" : {
41975 "$ref" : "#/components/schemas/UserCollectionAlbums_Items_Add_Resource_Identifier"
41976 }
41977 },
41978 "links" : {
41979 "$ref" : "#/components/schemas/Links"
41980 },
41981 "meta" : {
41982 "$ref" : "#/components/schemas/UserCollectionAlbums_Items_Add_Multi_Relationship_Data_Document_Meta"
41983 }
41984 }
41985 },
41986 "UserCollectionAlbums_Items_Add_Multi_Relationship_Data_Document_Meta" : {
41987 "required" : [ "skipped" ],
41988 "type" : "object",
41989 "properties" : {
41990 "skipped" : {
41991 "type" : "array",
41992 "items" : {
41993 "$ref" : "#/components/schemas/UserCollectionAlbumsItemsRelationshipAddOperation_Response_Meta_SkippedItem"
41994 }
41995 }
41996 }
41997 },
41998 "UserCollectionAlbums_Items_Add_Resource_Identifier" : {
41999 "required" : [ "id", "type" ],
42000 "type" : "object",
42001 "properties" : {
42002 "id" : {
42003 "type" : "string"
42004 },
42005 "meta" : {
42006 "$ref" : "#/components/schemas/UserCollectionAlbums_Items_Add_Resource_Identifier_Meta"
42007 },
42008 "type" : {
42009 "type" : "string",
42010 "enum" : [ "albums" ]
42011 }
42012 }
42013 },
42014 "UserCollectionAlbums_Items_Add_Resource_Identifier_Meta" : {
42015 "required" : [ "addedAt" ],
42016 "type" : "object",
42017 "properties" : {
42018 "addedAt" : {
42019 "type" : "string",
42020 "format" : "date-time"
42021 }
42022 }
42023 },
42024 "UserCollectionAlbums_Items_Multi_Relationship_Data_Document" : {
42025 "required" : [ "links" ],
42026 "type" : "object",
42027 "properties" : {
42028 "data" : {
42029 "type" : "array",
42030 "items" : {
42031 "$ref" : "#/components/schemas/UserCollectionAlbums_Items_Resource_Identifier"
42032 }
42033 },
42034 "included" : {
42035 "$ref" : "#/components/schemas/Included"
42036 },
42037 "links" : {
42038 "$ref" : "#/components/schemas/Links"
42039 }
42040 }
42041 },
42042 "UserCollectionAlbums_Items_Resource_Identifier" : {
42043 "required" : [ "id", "type" ],
42044 "type" : "object",
42045 "properties" : {
42046 "id" : {
42047 "type" : "string",
42048 "description" : "Resource id",
42049 "example" : "12345"
42050 },
42051 "meta" : {
42052 "$ref" : "#/components/schemas/UserCollectionAlbums_Items_Resource_Identifier_Meta"
42053 },
42054 "type" : {
42055 "type" : "string",
42056 "description" : "Resource type",
42057 "example" : "tracks"
42058 }
42059 }
42060 },
42061 "UserCollectionAlbums_Items_Resource_Identifier_Meta" : {
42062 "required" : [ "addedAt" ],
42063 "type" : "object",
42064 "properties" : {
42065 "addedAt" : {
42066 "type" : "string",
42067 "format" : "date-time"
42068 },
42069 "replacement" : {
42070 "$ref" : "#/components/schemas/Replacement_Provenance"
42071 }
42072 }
42073 },
42074 "UserCollectionAlbums_Multi_Relationship_Data_Document" : {
42075 "required" : [ "links" ],
42076 "type" : "object",
42077 "properties" : {
42078 "data" : {
42079 "type" : "array",
42080 "items" : {
42081 "$ref" : "#/components/schemas/Resource_Identifier"
42082 }
42083 },
42084 "included" : {
42085 "$ref" : "#/components/schemas/Included"
42086 },
42087 "links" : {
42088 "$ref" : "#/components/schemas/Links"
42089 }
42090 }
42091 },
42092 "UserCollectionAlbums_Relationships" : {
42093 "properties" : {
42094 "items" : {
42095 "$ref" : "#/components/schemas/UserCollectionAlbums_Items_Multi_Relationship_Data_Document"
42096 },
42097 "owners" : {
42098 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
42099 }
42100 }
42101 },
42102 "UserCollectionAlbums_Resource_Object" : {
42103 "required" : [ "id", "type" ],
42104 "type" : "object",
42105 "properties" : {
42106 "attributes" : {
42107 "$ref" : "#/components/schemas/UserCollectionAlbums_Attributes"
42108 },
42109 "id" : {
42110 "type" : "string",
42111 "description" : "Resource id",
42112 "example" : "12345"
42113 },
42114 "relationships" : {
42115 "$ref" : "#/components/schemas/UserCollectionAlbums_Relationships"
42116 },
42117 "type" : {
42118 "minLength" : 1,
42119 "type" : "string",
42120 "description" : "Resource type",
42121 "example" : "tracks"
42122 }
42123 }
42124 },
42125 "UserCollectionAlbums_Single_Resource_Data_Document" : {
42126 "required" : [ "data", "links" ],
42127 "type" : "object",
42128 "properties" : {
42129 "data" : {
42130 "$ref" : "#/components/schemas/UserCollectionAlbums_Resource_Object"
42131 },
42132 "included" : {
42133 "$ref" : "#/components/schemas/Included"
42134 },
42135 "links" : {
42136 "$ref" : "#/components/schemas/Links"
42137 }
42138 }
42139 },
42140 "UserCollectionArtistsAddMultiDataRelationshipWithResponse409ResponseBody" : {
42141 "required" : [ "errors" ],
42142 "type" : "object",
42143 "properties" : {
42144 "errors" : {
42145 "type" : "array",
42146 "items" : {
42147 "required" : [ "code", "status" ],
42148 "type" : "object",
42149 "properties" : {
42150 "code" : {
42151 "type" : "string",
42152 "example" : "DUPLICATE_ITEMS_IN_COLLECTION",
42153 "enum" : [ "DUPLICATE_ITEMS_IN_COLLECTION", "IDEMPOTENT_REQUEST_IN_PROGRESS", "TOO_MANY_ITEMS_IN_COLLECTION" ]
42154 },
42155 "detail" : {
42156 "type" : "string",
42157 "example" : "Collection item limit reached"
42158 },
42159 "status" : {
42160 "type" : "string",
42161 "example" : "409"
42162 }
42163 }
42164 }
42165 }
42166 }
42167 },
42168 "UserCollectionArtistsItemsRelationshipAddOperation_Payload" : {
42169 "required" : [ "data" ],
42170 "type" : "object",
42171 "properties" : {
42172 "data" : {
42173 "maxItems" : 50,
42174 "minItems" : 1,
42175 "type" : "array",
42176 "items" : {
42177 "$ref" : "#/components/schemas/UserCollectionArtistsItemsRelationshipAddOperation_Payload_Data"
42178 }
42179 }
42180 }
42181 },
42182 "UserCollectionArtistsItemsRelationshipAddOperation_Payload_Data" : {
42183 "required" : [ "id", "type" ],
42184 "type" : "object",
42185 "properties" : {
42186 "id" : {
42187 "type" : "string"
42188 },
42189 "meta" : {
42190 "$ref" : "#/components/schemas/UserCollectionArtistsItemsRelationshipAddOperation_Payload_Data_Meta"
42191 },
42192 "type" : {
42193 "type" : "string",
42194 "enum" : [ "artists" ]
42195 }
42196 }
42197 },
42198 "UserCollectionArtistsItemsRelationshipAddOperation_Payload_Data_Meta" : {
42199 "type" : "object",
42200 "properties" : {
42201 "addedAt" : {
42202 "type" : "string",
42203 "format" : "date-time"
42204 }
42205 }
42206 },
42207 "UserCollectionArtistsItemsRelationshipAddOperation_Response_Meta_SkippedItem" : {
42208 "required" : [ "id", "reason", "type" ],
42209 "type" : "object",
42210 "properties" : {
42211 "id" : {
42212 "type" : "string"
42213 },
42214 "reason" : {
42215 "type" : "string",
42216 "enum" : [ "NOT_FOUND", "ALREADY_PRESENT" ]
42217 },
42218 "type" : {
42219 "type" : "string",
42220 "enum" : [ "artists" ]
42221 }
42222 }
42223 },
42224 "UserCollectionArtistsItemsRelationshipRemoveOperation_Payload" : {
42225 "required" : [ "data" ],
42226 "type" : "object",
42227 "properties" : {
42228 "data" : {
42229 "maxItems" : 50,
42230 "minItems" : 1,
42231 "type" : "array",
42232 "items" : {
42233 "$ref" : "#/components/schemas/UserCollectionArtistsItemsRelationshipRemoveOperation_Payload_Data"
42234 }
42235 }
42236 }
42237 },
42238 "UserCollectionArtistsItemsRelationshipRemoveOperation_Payload_Data" : {
42239 "required" : [ "id", "type" ],
42240 "type" : "object",
42241 "properties" : {
42242 "id" : {
42243 "type" : "string"
42244 },
42245 "type" : {
42246 "type" : "string",
42247 "enum" : [ "artists" ]
42248 }
42249 }
42250 },
42251 "UserCollectionArtists_Attributes" : {
42252 "required" : [ "numberOfItems" ],
42253 "type" : "object",
42254 "properties" : {
42255 "lastModifiedAt" : {
42256 "type" : "string",
42257 "description" : "When the collection was last modified",
42258 "format" : "date-time"
42259 },
42260 "numberOfItems" : {
42261 "type" : "integer",
42262 "description" : "Number of items in the collection",
42263 "format" : "int32"
42264 }
42265 }
42266 },
42267 "UserCollectionArtists_Items_Add_Multi_Relationship_Data_Document" : {
42268 "required" : [ "data", "links" ],
42269 "type" : "object",
42270 "properties" : {
42271 "data" : {
42272 "type" : "array",
42273 "items" : {
42274 "$ref" : "#/components/schemas/UserCollectionArtists_Items_Add_Resource_Identifier"
42275 }
42276 },
42277 "links" : {
42278 "$ref" : "#/components/schemas/Links"
42279 },
42280 "meta" : {
42281 "$ref" : "#/components/schemas/UserCollectionArtists_Items_Add_Multi_Relationship_Data_Document_Meta"
42282 }
42283 }
42284 },
42285 "UserCollectionArtists_Items_Add_Multi_Relationship_Data_Document_Meta" : {
42286 "required" : [ "skipped" ],
42287 "type" : "object",
42288 "properties" : {
42289 "skipped" : {
42290 "type" : "array",
42291 "items" : {
42292 "$ref" : "#/components/schemas/UserCollectionArtistsItemsRelationshipAddOperation_Response_Meta_SkippedItem"
42293 }
42294 }
42295 }
42296 },
42297 "UserCollectionArtists_Items_Add_Resource_Identifier" : {
42298 "required" : [ "id", "type" ],
42299 "type" : "object",
42300 "properties" : {
42301 "id" : {
42302 "type" : "string"
42303 },
42304 "meta" : {
42305 "$ref" : "#/components/schemas/UserCollectionArtists_Items_Add_Resource_Identifier_Meta"
42306 },
42307 "type" : {
42308 "type" : "string",
42309 "enum" : [ "artists" ]
42310 }
42311 }
42312 },
42313 "UserCollectionArtists_Items_Add_Resource_Identifier_Meta" : {
42314 "required" : [ "addedAt" ],
42315 "type" : "object",
42316 "properties" : {
42317 "addedAt" : {
42318 "type" : "string",
42319 "format" : "date-time"
42320 }
42321 }
42322 },
42323 "UserCollectionArtists_Items_Multi_Relationship_Data_Document" : {
42324 "required" : [ "links" ],
42325 "type" : "object",
42326 "properties" : {
42327 "data" : {
42328 "type" : "array",
42329 "items" : {
42330 "$ref" : "#/components/schemas/UserCollectionArtists_Items_Resource_Identifier"
42331 }
42332 },
42333 "included" : {
42334 "$ref" : "#/components/schemas/Included"
42335 },
42336 "links" : {
42337 "$ref" : "#/components/schemas/Links"
42338 }
42339 }
42340 },
42341 "UserCollectionArtists_Items_Resource_Identifier" : {
42342 "required" : [ "id", "type" ],
42343 "type" : "object",
42344 "properties" : {
42345 "id" : {
42346 "type" : "string",
42347 "description" : "Resource id",
42348 "example" : "12345"
42349 },
42350 "meta" : {
42351 "$ref" : "#/components/schemas/UserCollectionArtists_Items_Resource_Identifier_Meta"
42352 },
42353 "type" : {
42354 "type" : "string",
42355 "description" : "Resource type",
42356 "example" : "tracks"
42357 }
42358 }
42359 },
42360 "UserCollectionArtists_Items_Resource_Identifier_Meta" : {
42361 "required" : [ "addedAt" ],
42362 "type" : "object",
42363 "properties" : {
42364 "addedAt" : {
42365 "type" : "string",
42366 "format" : "date-time"
42367 }
42368 }
42369 },
42370 "UserCollectionArtists_Multi_Relationship_Data_Document" : {
42371 "required" : [ "links" ],
42372 "type" : "object",
42373 "properties" : {
42374 "data" : {
42375 "type" : "array",
42376 "items" : {
42377 "$ref" : "#/components/schemas/Resource_Identifier"
42378 }
42379 },
42380 "included" : {
42381 "$ref" : "#/components/schemas/Included"
42382 },
42383 "links" : {
42384 "$ref" : "#/components/schemas/Links"
42385 }
42386 }
42387 },
42388 "UserCollectionArtists_Relationships" : {
42389 "properties" : {
42390 "items" : {
42391 "$ref" : "#/components/schemas/UserCollectionArtists_Items_Multi_Relationship_Data_Document"
42392 },
42393 "owners" : {
42394 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
42395 }
42396 }
42397 },
42398 "UserCollectionArtists_Resource_Object" : {
42399 "required" : [ "id", "type" ],
42400 "type" : "object",
42401 "properties" : {
42402 "attributes" : {
42403 "$ref" : "#/components/schemas/UserCollectionArtists_Attributes"
42404 },
42405 "id" : {
42406 "type" : "string",
42407 "description" : "Resource id",
42408 "example" : "12345"
42409 },
42410 "relationships" : {
42411 "$ref" : "#/components/schemas/UserCollectionArtists_Relationships"
42412 },
42413 "type" : {
42414 "minLength" : 1,
42415 "type" : "string",
42416 "description" : "Resource type",
42417 "example" : "tracks"
42418 }
42419 }
42420 },
42421 "UserCollectionArtists_Single_Resource_Data_Document" : {
42422 "required" : [ "data", "links" ],
42423 "type" : "object",
42424 "properties" : {
42425 "data" : {
42426 "$ref" : "#/components/schemas/UserCollectionArtists_Resource_Object"
42427 },
42428 "included" : {
42429 "$ref" : "#/components/schemas/Included"
42430 },
42431 "links" : {
42432 "$ref" : "#/components/schemas/Links"
42433 }
42434 }
42435 },
42436 "UserCollectionFoldersCreateOperation_Payload" : {
42437 "required" : [ "data" ],
42438 "type" : "object",
42439 "properties" : {
42440 "data" : {
42441 "$ref" : "#/components/schemas/UserCollectionFoldersCreateOperation_Payload_Data"
42442 }
42443 }
42444 },
42445 "UserCollectionFoldersCreateOperation_Payload_Data" : {
42446 "required" : [ "attributes", "relationships", "type" ],
42447 "type" : "object",
42448 "properties" : {
42449 "attributes" : {
42450 "$ref" : "#/components/schemas/UserCollectionFoldersCreateOperation_Payload_Data_Attributes"
42451 },
42452 "relationships" : {
42453 "$ref" : "#/components/schemas/UserCollectionFoldersCreateOperation_Payload_Data_Relationships"
42454 },
42455 "type" : {
42456 "type" : "string",
42457 "enum" : [ "userCollectionFolders" ]
42458 }
42459 }
42460 },
42461 "UserCollectionFoldersCreateOperation_Payload_Data_Attributes" : {
42462 "required" : [ "name" ],
42463 "type" : "object",
42464 "properties" : {
42465 "name" : {
42466 "type" : "string"
42467 }
42468 }
42469 },
42470 "UserCollectionFoldersCreateOperation_Payload_Data_Relationships" : {
42471 "required" : [ "userCollection" ],
42472 "type" : "object",
42473 "properties" : {
42474 "userCollection" : {
42475 "$ref" : "#/components/schemas/UserCollectionFoldersCreateOperation_Payload_Data_Relationships_UserCollection"
42476 }
42477 }
42478 },
42479 "UserCollectionFoldersCreateOperation_Payload_Data_Relationships_UserCollection" : {
42480 "required" : [ "data" ],
42481 "type" : "object",
42482 "properties" : {
42483 "data" : {
42484 "$ref" : "#/components/schemas/UserCollection"
42485 }
42486 }
42487 },
42488 "UserCollectionFoldersDeleteResource400ResponseBody" : {
42489 "required" : [ "errors" ],
42490 "type" : "object",
42491 "properties" : {
42492 "errors" : {
42493 "type" : "array",
42494 "items" : {
42495 "required" : [ "code", "status" ],
42496 "type" : "object",
42497 "properties" : {
42498 "code" : {
42499 "type" : "string",
42500 "example" : "FOLDER_NOT_EMPTY",
42501 "enum" : [ "FOLDER_NOT_EMPTY" ]
42502 },
42503 "detail" : {
42504 "type" : "string",
42505 "example" : "Folder must be empty and owned by you"
42506 },
42507 "status" : {
42508 "type" : "string",
42509 "example" : "400"
42510 }
42511 }
42512 }
42513 }
42514 }
42515 },
42516 "UserCollectionFoldersItemsRelationshipAddOperation_Payload" : {
42517 "type" : "object",
42518 "properties" : {
42519 "data" : {
42520 "maxItems" : 10,
42521 "minItems" : 1,
42522 "type" : "array",
42523 "items" : {
42524 "$ref" : "#/components/schemas/UserCollectionFoldersItemsRelationshipAddOperation_Payload_Data"
42525 }
42526 }
42527 }
42528 },
42529 "UserCollectionFoldersItemsRelationshipAddOperation_Payload_Data" : {
42530 "required" : [ "id", "type" ],
42531 "type" : "object",
42532 "properties" : {
42533 "id" : {
42534 "type" : "string"
42535 },
42536 "type" : {
42537 "type" : "string",
42538 "enum" : [ "playlists" ]
42539 }
42540 }
42541 },
42542 "UserCollectionFoldersItemsRelationshipRemoveOperation_Payload" : {
42543 "type" : "object",
42544 "properties" : {
42545 "data" : {
42546 "maxItems" : 10,
42547 "minItems" : 1,
42548 "type" : "array",
42549 "items" : {
42550 "$ref" : "#/components/schemas/UserCollectionFoldersItemsRelationshipRemoveOperation_Payload_Data"
42551 }
42552 }
42553 }
42554 },
42555 "UserCollectionFoldersItemsRelationshipRemoveOperation_Payload_Data" : {
42556 "required" : [ "id", "type" ],
42557 "type" : "object",
42558 "properties" : {
42559 "id" : {
42560 "type" : "string"
42561 },
42562 "type" : {
42563 "type" : "string",
42564 "enum" : [ "playlists" ]
42565 }
42566 }
42567 },
42568 "UserCollectionFoldersUpdateOperation_Payload" : {
42569 "required" : [ "data" ],
42570 "type" : "object",
42571 "properties" : {
42572 "data" : {
42573 "$ref" : "#/components/schemas/UserCollectionFoldersUpdateOperation_Payload_Data"
42574 }
42575 }
42576 },
42577 "UserCollectionFoldersUpdateOperation_Payload_Data" : {
42578 "required" : [ "attributes", "id", "type" ],
42579 "type" : "object",
42580 "properties" : {
42581 "attributes" : {
42582 "$ref" : "#/components/schemas/UserCollectionFoldersUpdateOperation_Payload_Data_Attributes"
42583 },
42584 "id" : {
42585 "type" : "string"
42586 },
42587 "type" : {
42588 "type" : "string",
42589 "enum" : [ "userCollectionFolders" ]
42590 }
42591 }
42592 },
42593 "UserCollectionFoldersUpdateOperation_Payload_Data_Attributes" : {
42594 "type" : "object",
42595 "properties" : {
42596 "name" : {
42597 "type" : "string"
42598 }
42599 }
42600 },
42601 "UserCollectionFolders_Attributes" : {
42602 "required" : [ "createdAt", "lastModifiedAt", "name" ],
42603 "type" : "object",
42604 "properties" : {
42605 "createdAt" : {
42606 "type" : "string",
42607 "format" : "date-time"
42608 },
42609 "lastModifiedAt" : {
42610 "type" : "string",
42611 "format" : "date-time"
42612 },
42613 "name" : {
42614 "type" : "string"
42615 },
42616 "numberOfItems" : {
42617 "type" : "integer",
42618 "format" : "int32"
42619 }
42620 }
42621 },
42622 "UserCollectionFolders_Create_Single_Resource_Data_Document" : {
42623 "required" : [ "data", "links" ],
42624 "type" : "object",
42625 "properties" : {
42626 "data" : {
42627 "$ref" : "#/components/schemas/UserCollectionFolders_Resource_Object"
42628 },
42629 "links" : {
42630 "$ref" : "#/components/schemas/Links"
42631 }
42632 }
42633 },
42634 "UserCollectionFolders_Items_Multi_Relationship_Data_Document" : {
42635 "required" : [ "links" ],
42636 "type" : "object",
42637 "properties" : {
42638 "data" : {
42639 "type" : "array",
42640 "items" : {
42641 "$ref" : "#/components/schemas/UserCollectionFolders_Items_Resource_Identifier"
42642 }
42643 },
42644 "included" : {
42645 "$ref" : "#/components/schemas/Included"
42646 },
42647 "links" : {
42648 "$ref" : "#/components/schemas/Links"
42649 }
42650 }
42651 },
42652 "UserCollectionFolders_Items_Resource_Identifier" : {
42653 "required" : [ "id", "type" ],
42654 "type" : "object",
42655 "properties" : {
42656 "id" : {
42657 "type" : "string",
42658 "description" : "Resource id",
42659 "example" : "12345"
42660 },
42661 "meta" : {
42662 "$ref" : "#/components/schemas/UserCollectionFolders_Items_Resource_Identifier_Meta"
42663 },
42664 "type" : {
42665 "type" : "string",
42666 "description" : "Resource type",
42667 "example" : "tracks"
42668 }
42669 }
42670 },
42671 "UserCollectionFolders_Items_Resource_Identifier_Meta" : {
42672 "required" : [ "addedAt" ],
42673 "type" : "object",
42674 "properties" : {
42675 "addedAt" : {
42676 "type" : "string",
42677 "format" : "date-time"
42678 }
42679 }
42680 },
42681 "UserCollectionFolders_Multi_Relationship_Data_Document" : {
42682 "required" : [ "links" ],
42683 "type" : "object",
42684 "properties" : {
42685 "data" : {
42686 "type" : "array",
42687 "items" : {
42688 "$ref" : "#/components/schemas/Resource_Identifier"
42689 }
42690 },
42691 "included" : {
42692 "$ref" : "#/components/schemas/Included"
42693 },
42694 "links" : {
42695 "$ref" : "#/components/schemas/Links"
42696 }
42697 }
42698 },
42699 "UserCollectionFolders_Multi_Resource_Data_Document" : {
42700 "required" : [ "data", "links" ],
42701 "type" : "object",
42702 "properties" : {
42703 "data" : {
42704 "type" : "array",
42705 "items" : {
42706 "$ref" : "#/components/schemas/UserCollectionFolders_Resource_Object"
42707 }
42708 },
42709 "included" : {
42710 "$ref" : "#/components/schemas/Included"
42711 },
42712 "links" : {
42713 "$ref" : "#/components/schemas/Links"
42714 }
42715 }
42716 },
42717 "UserCollectionFolders_Relationships" : {
42718 "properties" : {
42719 "items" : {
42720 "$ref" : "#/components/schemas/UserCollectionFolders_Items_Multi_Relationship_Data_Document"
42721 },
42722 "owners" : {
42723 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
42724 },
42725 "userCollection" : {
42726 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
42727 }
42728 }
42729 },
42730 "UserCollectionFolders_Resource_Object" : {
42731 "required" : [ "id", "type" ],
42732 "type" : "object",
42733 "properties" : {
42734 "attributes" : {
42735 "$ref" : "#/components/schemas/UserCollectionFolders_Attributes"
42736 },
42737 "id" : {
42738 "type" : "string",
42739 "description" : "Resource id",
42740 "example" : "12345"
42741 },
42742 "relationships" : {
42743 "$ref" : "#/components/schemas/UserCollectionFolders_Relationships"
42744 },
42745 "type" : {
42746 "minLength" : 1,
42747 "type" : "string",
42748 "description" : "Resource type",
42749 "example" : "tracks"
42750 }
42751 }
42752 },
42753 "UserCollectionFolders_Single_Relationship_Data_Document" : {
42754 "required" : [ "links" ],
42755 "type" : "object",
42756 "properties" : {
42757 "data" : {
42758 "oneOf" : [ {
42759 "$ref" : "#/components/schemas/Resource_Identifier"
42760 }, {
42761 "type" : "object",
42762 "nullable" : true,
42763 "enum" : [ null ]
42764 } ]
42765 },
42766 "included" : {
42767 "$ref" : "#/components/schemas/Included"
42768 },
42769 "links" : {
42770 "$ref" : "#/components/schemas/Links"
42771 }
42772 }
42773 },
42774 "UserCollectionFolders_Single_Resource_Data_Document" : {
42775 "required" : [ "data", "links" ],
42776 "type" : "object",
42777 "properties" : {
42778 "data" : {
42779 "$ref" : "#/components/schemas/UserCollectionFolders_Resource_Object"
42780 },
42781 "included" : {
42782 "$ref" : "#/components/schemas/Included"
42783 },
42784 "links" : {
42785 "$ref" : "#/components/schemas/Links"
42786 }
42787 }
42788 },
42789 "UserCollectionPlaylistsAddMultiDataRelationshipWithResponse409ResponseBody" : {
42790 "required" : [ "errors" ],
42791 "type" : "object",
42792 "properties" : {
42793 "errors" : {
42794 "type" : "array",
42795 "items" : {
42796 "required" : [ "code", "status" ],
42797 "type" : "object",
42798 "properties" : {
42799 "code" : {
42800 "type" : "string",
42801 "example" : "DUPLICATE_ITEMS_IN_COLLECTION",
42802 "enum" : [ "DUPLICATE_ITEMS_IN_COLLECTION", "IDEMPOTENT_REQUEST_IN_PROGRESS", "TOO_MANY_ITEMS_IN_COLLECTION" ]
42803 },
42804 "detail" : {
42805 "type" : "string",
42806 "example" : "Collection item limit reached"
42807 },
42808 "status" : {
42809 "type" : "string",
42810 "example" : "409"
42811 }
42812 }
42813 }
42814 }
42815 }
42816 },
42817 "UserCollectionPlaylistsItemsRelationshipAddOperation_Payload" : {
42818 "required" : [ "data" ],
42819 "type" : "object",
42820 "properties" : {
42821 "data" : {
42822 "maxItems" : 50,
42823 "minItems" : 1,
42824 "type" : "array",
42825 "items" : {
42826 "$ref" : "#/components/schemas/UserCollectionPlaylistsItemsRelationshipAddOperation_Payload_Data"
42827 }
42828 }
42829 }
42830 },
42831 "UserCollectionPlaylistsItemsRelationshipAddOperation_Payload_Data" : {
42832 "required" : [ "id", "type" ],
42833 "type" : "object",
42834 "properties" : {
42835 "id" : {
42836 "type" : "string"
42837 },
42838 "meta" : {
42839 "$ref" : "#/components/schemas/UserCollectionPlaylistsItemsRelationshipAddOperation_Payload_Data_Meta"
42840 },
42841 "type" : {
42842 "type" : "string",
42843 "enum" : [ "playlists" ]
42844 }
42845 }
42846 },
42847 "UserCollectionPlaylistsItemsRelationshipAddOperation_Payload_Data_Meta" : {
42848 "type" : "object",
42849 "properties" : {
42850 "addedAt" : {
42851 "type" : "string",
42852 "format" : "date-time"
42853 }
42854 }
42855 },
42856 "UserCollectionPlaylistsItemsRelationshipAddOperation_Response_Meta_SkippedItem" : {
42857 "required" : [ "id", "reason", "type" ],
42858 "type" : "object",
42859 "properties" : {
42860 "id" : {
42861 "type" : "string"
42862 },
42863 "reason" : {
42864 "type" : "string",
42865 "enum" : [ "NOT_FOUND", "ALREADY_PRESENT" ]
42866 },
42867 "type" : {
42868 "type" : "string",
42869 "enum" : [ "playlists" ]
42870 }
42871 }
42872 },
42873 "UserCollectionPlaylistsItemsRelationshipRemoveOperation_Payload" : {
42874 "required" : [ "data" ],
42875 "type" : "object",
42876 "properties" : {
42877 "data" : {
42878 "maxItems" : 50,
42879 "minItems" : 1,
42880 "type" : "array",
42881 "items" : {
42882 "$ref" : "#/components/schemas/UserCollectionPlaylistsItemsRelationshipRemoveOperation_Payload_Data"
42883 }
42884 }
42885 }
42886 },
42887 "UserCollectionPlaylistsItemsRelationshipRemoveOperation_Payload_Data" : {
42888 "required" : [ "id", "type" ],
42889 "type" : "object",
42890 "properties" : {
42891 "id" : {
42892 "type" : "string"
42893 },
42894 "type" : {
42895 "type" : "string",
42896 "enum" : [ "playlists" ]
42897 }
42898 }
42899 },
42900 "UserCollectionPlaylists_Attributes" : {
42901 "required" : [ "numberOfItems" ],
42902 "type" : "object",
42903 "properties" : {
42904 "lastModifiedAt" : {
42905 "type" : "string",
42906 "description" : "When the collection was last modified",
42907 "format" : "date-time"
42908 },
42909 "numberOfItems" : {
42910 "type" : "integer",
42911 "description" : "Number of items in the collection",
42912 "format" : "int32"
42913 }
42914 }
42915 },
42916 "UserCollectionPlaylists_Items_Add_Multi_Relationship_Data_Document" : {
42917 "required" : [ "data", "links" ],
42918 "type" : "object",
42919 "properties" : {
42920 "data" : {
42921 "type" : "array",
42922 "items" : {
42923 "$ref" : "#/components/schemas/UserCollectionPlaylists_Items_Add_Resource_Identifier"
42924 }
42925 },
42926 "links" : {
42927 "$ref" : "#/components/schemas/Links"
42928 },
42929 "meta" : {
42930 "$ref" : "#/components/schemas/UserCollectionPlaylists_Items_Add_Multi_Relationship_Data_Document_Meta"
42931 }
42932 }
42933 },
42934 "UserCollectionPlaylists_Items_Add_Multi_Relationship_Data_Document_Meta" : {
42935 "required" : [ "skipped" ],
42936 "type" : "object",
42937 "properties" : {
42938 "skipped" : {
42939 "type" : "array",
42940 "items" : {
42941 "$ref" : "#/components/schemas/UserCollectionPlaylistsItemsRelationshipAddOperation_Response_Meta_SkippedItem"
42942 }
42943 }
42944 }
42945 },
42946 "UserCollectionPlaylists_Items_Add_Resource_Identifier" : {
42947 "required" : [ "id", "type" ],
42948 "type" : "object",
42949 "properties" : {
42950 "id" : {
42951 "type" : "string"
42952 },
42953 "meta" : {
42954 "$ref" : "#/components/schemas/UserCollectionPlaylists_Items_Add_Resource_Identifier_Meta"
42955 },
42956 "type" : {
42957 "type" : "string",
42958 "enum" : [ "playlists" ]
42959 }
42960 }
42961 },
42962 "UserCollectionPlaylists_Items_Add_Resource_Identifier_Meta" : {
42963 "required" : [ "addedAt" ],
42964 "type" : "object",
42965 "properties" : {
42966 "addedAt" : {
42967 "type" : "string",
42968 "format" : "date-time"
42969 }
42970 }
42971 },
42972 "UserCollectionPlaylists_Items_Multi_Relationship_Data_Document" : {
42973 "required" : [ "links" ],
42974 "type" : "object",
42975 "properties" : {
42976 "data" : {
42977 "type" : "array",
42978 "items" : {
42979 "$ref" : "#/components/schemas/UserCollectionPlaylists_Items_Resource_Identifier"
42980 }
42981 },
42982 "included" : {
42983 "$ref" : "#/components/schemas/Included"
42984 },
42985 "links" : {
42986 "$ref" : "#/components/schemas/Links"
42987 }
42988 }
42989 },
42990 "UserCollectionPlaylists_Items_Resource_Identifier" : {
42991 "required" : [ "id", "type" ],
42992 "type" : "object",
42993 "properties" : {
42994 "id" : {
42995 "type" : "string",
42996 "description" : "Resource id",
42997 "example" : "12345"
42998 },
42999 "meta" : {
43000 "$ref" : "#/components/schemas/UserCollectionPlaylists_Items_Resource_Identifier_Meta"
43001 },
43002 "type" : {
43003 "type" : "string",
43004 "description" : "Resource type",
43005 "example" : "tracks"
43006 }
43007 }
43008 },
43009 "UserCollectionPlaylists_Items_Resource_Identifier_Meta" : {
43010 "required" : [ "addedAt" ],
43011 "type" : "object",
43012 "properties" : {
43013 "addedAt" : {
43014 "type" : "string",
43015 "format" : "date-time"
43016 }
43017 }
43018 },
43019 "UserCollectionPlaylists_Multi_Relationship_Data_Document" : {
43020 "required" : [ "links" ],
43021 "type" : "object",
43022 "properties" : {
43023 "data" : {
43024 "type" : "array",
43025 "items" : {
43026 "$ref" : "#/components/schemas/Resource_Identifier"
43027 }
43028 },
43029 "included" : {
43030 "$ref" : "#/components/schemas/Included"
43031 },
43032 "links" : {
43033 "$ref" : "#/components/schemas/Links"
43034 }
43035 }
43036 },
43037 "UserCollectionPlaylists_Relationships" : {
43038 "properties" : {
43039 "items" : {
43040 "$ref" : "#/components/schemas/UserCollectionPlaylists_Items_Multi_Relationship_Data_Document"
43041 },
43042 "owners" : {
43043 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
43044 }
43045 }
43046 },
43047 "UserCollectionPlaylists_Resource_Object" : {
43048 "required" : [ "id", "type" ],
43049 "type" : "object",
43050 "properties" : {
43051 "attributes" : {
43052 "$ref" : "#/components/schemas/UserCollectionPlaylists_Attributes"
43053 },
43054 "id" : {
43055 "type" : "string",
43056 "description" : "Resource id",
43057 "example" : "12345"
43058 },
43059 "relationships" : {
43060 "$ref" : "#/components/schemas/UserCollectionPlaylists_Relationships"
43061 },
43062 "type" : {
43063 "minLength" : 1,
43064 "type" : "string",
43065 "description" : "Resource type",
43066 "example" : "tracks"
43067 }
43068 }
43069 },
43070 "UserCollectionPlaylists_Single_Resource_Data_Document" : {
43071 "required" : [ "data", "links" ],
43072 "type" : "object",
43073 "properties" : {
43074 "data" : {
43075 "$ref" : "#/components/schemas/UserCollectionPlaylists_Resource_Object"
43076 },
43077 "included" : {
43078 "$ref" : "#/components/schemas/Included"
43079 },
43080 "links" : {
43081 "$ref" : "#/components/schemas/Links"
43082 }
43083 }
43084 },
43085 "UserCollectionSaveForLatersAddMultiDataRelationshipWithResponse409ResponseBody" : {
43086 "required" : [ "errors" ],
43087 "type" : "object",
43088 "properties" : {
43089 "errors" : {
43090 "type" : "array",
43091 "items" : {
43092 "required" : [ "code", "status" ],
43093 "type" : "object",
43094 "properties" : {
43095 "code" : {
43096 "type" : "string",
43097 "example" : "DUPLICATE_ITEMS_IN_COLLECTION",
43098 "enum" : [ "DUPLICATE_ITEMS_IN_COLLECTION", "IDEMPOTENT_REQUEST_IN_PROGRESS", "TOO_MANY_ITEMS_IN_COLLECTION" ]
43099 },
43100 "detail" : {
43101 "type" : "string",
43102 "example" : "Collection item limit reached"
43103 },
43104 "status" : {
43105 "type" : "string",
43106 "example" : "409"
43107 }
43108 }
43109 }
43110 }
43111 }
43112 },
43113 "UserCollectionSaveForLatersItemsRelationshipAddOperation_Payload" : {
43114 "required" : [ "data" ],
43115 "type" : "object",
43116 "properties" : {
43117 "data" : {
43118 "maxItems" : 20,
43119 "minItems" : 1,
43120 "type" : "array",
43121 "items" : {
43122 "$ref" : "#/components/schemas/UserCollectionSaveForLatersItemsRelationshipAddOperation_Payload_Data"
43123 }
43124 }
43125 }
43126 },
43127 "UserCollectionSaveForLatersItemsRelationshipAddOperation_Payload_Data" : {
43128 "required" : [ "id", "type" ],
43129 "type" : "object",
43130 "properties" : {
43131 "id" : {
43132 "type" : "string"
43133 },
43134 "type" : {
43135 "type" : "string",
43136 "enum" : [ "tracks", "albums", "artists", "playlists", "videos" ]
43137 }
43138 }
43139 },
43140 "UserCollectionSaveForLatersItemsRelationshipAddOperation_Response_Meta_SkippedItem" : {
43141 "required" : [ "id", "reason", "type" ],
43142 "type" : "object",
43143 "properties" : {
43144 "id" : {
43145 "type" : "string"
43146 },
43147 "reason" : {
43148 "type" : "string",
43149 "enum" : [ "NOT_FOUND", "ALREADY_PRESENT" ]
43150 },
43151 "type" : {
43152 "type" : "string",
43153 "enum" : [ "tracks", "albums", "artists", "playlists", "videos" ]
43154 }
43155 }
43156 },
43157 "UserCollectionSaveForLatersItemsRelationshipRemoveOperation_Payload" : {
43158 "required" : [ "data" ],
43159 "type" : "object",
43160 "properties" : {
43161 "data" : {
43162 "maxItems" : 20,
43163 "minItems" : 1,
43164 "type" : "array",
43165 "items" : {
43166 "$ref" : "#/components/schemas/UserCollectionSaveForLatersItemsRelationshipRemoveOperation_Payload_Data"
43167 }
43168 }
43169 }
43170 },
43171 "UserCollectionSaveForLatersItemsRelationshipRemoveOperation_Payload_Data" : {
43172 "required" : [ "id", "type" ],
43173 "type" : "object",
43174 "properties" : {
43175 "id" : {
43176 "type" : "string"
43177 },
43178 "type" : {
43179 "type" : "string",
43180 "enum" : [ "tracks", "albums", "artists", "playlists", "videos" ]
43181 }
43182 }
43183 },
43184 "UserCollectionSaveForLaters_Attributes" : {
43185 "required" : [ "numberOfItems" ],
43186 "type" : "object",
43187 "properties" : {
43188 "lastModifiedAt" : {
43189 "type" : "string",
43190 "description" : "When the collection was last modified",
43191 "format" : "date-time"
43192 },
43193 "numberOfItems" : {
43194 "type" : "integer",
43195 "description" : "Number of items in the collection",
43196 "format" : "int32"
43197 }
43198 }
43199 },
43200 "UserCollectionSaveForLaters_Items_Add_Multi_Relationship_Data_Document" : {
43201 "required" : [ "data", "links" ],
43202 "type" : "object",
43203 "properties" : {
43204 "data" : {
43205 "type" : "array",
43206 "items" : {
43207 "$ref" : "#/components/schemas/UserCollectionSaveForLaters_Items_Add_Resource_Identifier"
43208 }
43209 },
43210 "links" : {
43211 "$ref" : "#/components/schemas/Links"
43212 },
43213 "meta" : {
43214 "$ref" : "#/components/schemas/UserCollectionSaveForLaters_Items_Add_Multi_Relationship_Data_Document_Meta"
43215 }
43216 }
43217 },
43218 "UserCollectionSaveForLaters_Items_Add_Multi_Relationship_Data_Document_Meta" : {
43219 "required" : [ "skipped" ],
43220 "type" : "object",
43221 "properties" : {
43222 "skipped" : {
43223 "type" : "array",
43224 "items" : {
43225 "$ref" : "#/components/schemas/UserCollectionSaveForLatersItemsRelationshipAddOperation_Response_Meta_SkippedItem"
43226 }
43227 }
43228 }
43229 },
43230 "UserCollectionSaveForLaters_Items_Add_Resource_Identifier" : {
43231 "required" : [ "id", "type" ],
43232 "type" : "object",
43233 "properties" : {
43234 "id" : {
43235 "type" : "string"
43236 },
43237 "meta" : {
43238 "$ref" : "#/components/schemas/UserCollectionSaveForLaters_Items_Add_Resource_Identifier_Meta"
43239 },
43240 "type" : {
43241 "type" : "string",
43242 "enum" : [ "tracks", "albums", "artists", "playlists", "videos" ]
43243 }
43244 }
43245 },
43246 "UserCollectionSaveForLaters_Items_Add_Resource_Identifier_Meta" : {
43247 "required" : [ "addedAt" ],
43248 "type" : "object",
43249 "properties" : {
43250 "addedAt" : {
43251 "type" : "string",
43252 "format" : "date-time"
43253 }
43254 }
43255 },
43256 "UserCollectionSaveForLaters_Items_Multi_Relationship_Data_Document" : {
43257 "required" : [ "links" ],
43258 "type" : "object",
43259 "properties" : {
43260 "data" : {
43261 "type" : "array",
43262 "items" : {
43263 "$ref" : "#/components/schemas/UserCollectionSaveForLaters_Items_Resource_Identifier"
43264 }
43265 },
43266 "included" : {
43267 "$ref" : "#/components/schemas/Included"
43268 },
43269 "links" : {
43270 "$ref" : "#/components/schemas/Links"
43271 }
43272 }
43273 },
43274 "UserCollectionSaveForLaters_Items_Resource_Identifier" : {
43275 "required" : [ "id", "type" ],
43276 "type" : "object",
43277 "properties" : {
43278 "id" : {
43279 "type" : "string",
43280 "description" : "Resource id",
43281 "example" : "12345"
43282 },
43283 "meta" : {
43284 "$ref" : "#/components/schemas/UserCollectionSaveForLaters_Items_Resource_Identifier_Meta"
43285 },
43286 "type" : {
43287 "type" : "string",
43288 "description" : "Resource type",
43289 "example" : "tracks"
43290 }
43291 }
43292 },
43293 "UserCollectionSaveForLaters_Items_Resource_Identifier_Meta" : {
43294 "required" : [ "addedAt" ],
43295 "type" : "object",
43296 "properties" : {
43297 "addedAt" : {
43298 "type" : "string",
43299 "format" : "date-time"
43300 },
43301 "replacement" : {
43302 "$ref" : "#/components/schemas/Replacement_Provenance"
43303 }
43304 }
43305 },
43306 "UserCollectionSaveForLaters_Multi_Relationship_Data_Document" : {
43307 "required" : [ "links" ],
43308 "type" : "object",
43309 "properties" : {
43310 "data" : {
43311 "type" : "array",
43312 "items" : {
43313 "$ref" : "#/components/schemas/Resource_Identifier"
43314 }
43315 },
43316 "included" : {
43317 "$ref" : "#/components/schemas/Included"
43318 },
43319 "links" : {
43320 "$ref" : "#/components/schemas/Links"
43321 }
43322 }
43323 },
43324 "UserCollectionSaveForLaters_Relationships" : {
43325 "properties" : {
43326 "items" : {
43327 "$ref" : "#/components/schemas/UserCollectionSaveForLaters_Items_Multi_Relationship_Data_Document"
43328 },
43329 "owners" : {
43330 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
43331 }
43332 }
43333 },
43334 "UserCollectionSaveForLaters_Resource_Object" : {
43335 "required" : [ "id", "type" ],
43336 "type" : "object",
43337 "properties" : {
43338 "attributes" : {
43339 "$ref" : "#/components/schemas/UserCollectionSaveForLaters_Attributes"
43340 },
43341 "id" : {
43342 "type" : "string",
43343 "description" : "Resource id",
43344 "example" : "12345"
43345 },
43346 "relationships" : {
43347 "$ref" : "#/components/schemas/UserCollectionSaveForLaters_Relationships"
43348 },
43349 "type" : {
43350 "minLength" : 1,
43351 "type" : "string",
43352 "description" : "Resource type",
43353 "example" : "tracks"
43354 }
43355 }
43356 },
43357 "UserCollectionSaveForLaters_Single_Resource_Data_Document" : {
43358 "required" : [ "data", "links" ],
43359 "type" : "object",
43360 "properties" : {
43361 "data" : {
43362 "$ref" : "#/components/schemas/UserCollectionSaveForLaters_Resource_Object"
43363 },
43364 "included" : {
43365 "$ref" : "#/components/schemas/Included"
43366 },
43367 "links" : {
43368 "$ref" : "#/components/schemas/Links"
43369 }
43370 }
43371 },
43372 "UserCollectionTracksAddMultiDataRelationshipWithResponse409ResponseBody" : {
43373 "required" : [ "errors" ],
43374 "type" : "object",
43375 "properties" : {
43376 "errors" : {
43377 "type" : "array",
43378 "items" : {
43379 "required" : [ "code", "status" ],
43380 "type" : "object",
43381 "properties" : {
43382 "code" : {
43383 "type" : "string",
43384 "example" : "DUPLICATE_ITEMS_IN_COLLECTION",
43385 "enum" : [ "DUPLICATE_ITEMS_IN_COLLECTION", "IDEMPOTENT_REQUEST_IN_PROGRESS", "TOO_MANY_ITEMS_IN_COLLECTION" ]
43386 },
43387 "detail" : {
43388 "type" : "string",
43389 "example" : "Collection item limit reached"
43390 },
43391 "status" : {
43392 "type" : "string",
43393 "example" : "409"
43394 }
43395 }
43396 }
43397 }
43398 }
43399 },
43400 "UserCollectionTracksItemsRelationshipAddOperation_Payload" : {
43401 "required" : [ "data" ],
43402 "type" : "object",
43403 "properties" : {
43404 "data" : {
43405 "maxItems" : 50,
43406 "minItems" : 1,
43407 "type" : "array",
43408 "items" : {
43409 "$ref" : "#/components/schemas/UserCollectionTracksItemsRelationshipAddOperation_Payload_Data"
43410 }
43411 }
43412 }
43413 },
43414 "UserCollectionTracksItemsRelationshipAddOperation_Payload_Data" : {
43415 "required" : [ "id", "type" ],
43416 "type" : "object",
43417 "properties" : {
43418 "id" : {
43419 "type" : "string"
43420 },
43421 "meta" : {
43422 "$ref" : "#/components/schemas/UserCollectionTracksItemsRelationshipAddOperation_Payload_Data_Meta"
43423 },
43424 "type" : {
43425 "type" : "string",
43426 "enum" : [ "tracks" ]
43427 }
43428 }
43429 },
43430 "UserCollectionTracksItemsRelationshipAddOperation_Payload_Data_Meta" : {
43431 "type" : "object",
43432 "properties" : {
43433 "addedAt" : {
43434 "type" : "string",
43435 "format" : "date-time"
43436 }
43437 }
43438 },
43439 "UserCollectionTracksItemsRelationshipAddOperation_Response_Meta_SkippedItem" : {
43440 "required" : [ "id", "reason", "type" ],
43441 "type" : "object",
43442 "properties" : {
43443 "id" : {
43444 "type" : "string"
43445 },
43446 "reason" : {
43447 "type" : "string",
43448 "enum" : [ "NOT_FOUND", "ALREADY_PRESENT" ]
43449 },
43450 "type" : {
43451 "type" : "string",
43452 "enum" : [ "tracks" ]
43453 }
43454 }
43455 },
43456 "UserCollectionTracksItemsRelationshipRemoveOperation_Payload" : {
43457 "required" : [ "data" ],
43458 "type" : "object",
43459 "properties" : {
43460 "data" : {
43461 "maxItems" : 50,
43462 "minItems" : 1,
43463 "type" : "array",
43464 "items" : {
43465 "$ref" : "#/components/schemas/UserCollectionTracksItemsRelationshipRemoveOperation_Payload_Data"
43466 }
43467 }
43468 }
43469 },
43470 "UserCollectionTracksItemsRelationshipRemoveOperation_Payload_Data" : {
43471 "required" : [ "id", "type" ],
43472 "type" : "object",
43473 "properties" : {
43474 "id" : {
43475 "type" : "string"
43476 },
43477 "type" : {
43478 "type" : "string",
43479 "enum" : [ "tracks" ]
43480 }
43481 }
43482 },
43483 "UserCollectionTracks_Attributes" : {
43484 "required" : [ "numberOfItems" ],
43485 "type" : "object",
43486 "properties" : {
43487 "lastModifiedAt" : {
43488 "type" : "string",
43489 "description" : "When the collection was last modified",
43490 "format" : "date-time"
43491 },
43492 "numberOfItems" : {
43493 "type" : "integer",
43494 "description" : "Number of items in the collection",
43495 "format" : "int32"
43496 }
43497 }
43498 },
43499 "UserCollectionTracks_Items_Add_Multi_Relationship_Data_Document" : {
43500 "required" : [ "data", "links" ],
43501 "type" : "object",
43502 "properties" : {
43503 "data" : {
43504 "type" : "array",
43505 "items" : {
43506 "$ref" : "#/components/schemas/UserCollectionTracks_Items_Add_Resource_Identifier"
43507 }
43508 },
43509 "links" : {
43510 "$ref" : "#/components/schemas/Links"
43511 },
43512 "meta" : {
43513 "$ref" : "#/components/schemas/UserCollectionTracks_Items_Add_Multi_Relationship_Data_Document_Meta"
43514 }
43515 }
43516 },
43517 "UserCollectionTracks_Items_Add_Multi_Relationship_Data_Document_Meta" : {
43518 "required" : [ "skipped" ],
43519 "type" : "object",
43520 "properties" : {
43521 "skipped" : {
43522 "type" : "array",
43523 "items" : {
43524 "$ref" : "#/components/schemas/UserCollectionTracksItemsRelationshipAddOperation_Response_Meta_SkippedItem"
43525 }
43526 }
43527 }
43528 },
43529 "UserCollectionTracks_Items_Add_Resource_Identifier" : {
43530 "required" : [ "id", "type" ],
43531 "type" : "object",
43532 "properties" : {
43533 "id" : {
43534 "type" : "string"
43535 },
43536 "meta" : {
43537 "$ref" : "#/components/schemas/UserCollectionTracks_Items_Add_Resource_Identifier_Meta"
43538 },
43539 "type" : {
43540 "type" : "string",
43541 "enum" : [ "tracks" ]
43542 }
43543 }
43544 },
43545 "UserCollectionTracks_Items_Add_Resource_Identifier_Meta" : {
43546 "required" : [ "addedAt" ],
43547 "type" : "object",
43548 "properties" : {
43549 "addedAt" : {
43550 "type" : "string",
43551 "format" : "date-time"
43552 }
43553 }
43554 },
43555 "UserCollectionTracks_Items_Multi_Relationship_Data_Document" : {
43556 "required" : [ "links" ],
43557 "type" : "object",
43558 "properties" : {
43559 "data" : {
43560 "type" : "array",
43561 "items" : {
43562 "$ref" : "#/components/schemas/UserCollectionTracks_Items_Resource_Identifier"
43563 }
43564 },
43565 "included" : {
43566 "$ref" : "#/components/schemas/Included"
43567 },
43568 "links" : {
43569 "$ref" : "#/components/schemas/Links"
43570 }
43571 }
43572 },
43573 "UserCollectionTracks_Items_Resource_Identifier" : {
43574 "required" : [ "id", "type" ],
43575 "type" : "object",
43576 "properties" : {
43577 "id" : {
43578 "type" : "string",
43579 "description" : "Resource id",
43580 "example" : "12345"
43581 },
43582 "meta" : {
43583 "$ref" : "#/components/schemas/UserCollectionTracks_Items_Resource_Identifier_Meta"
43584 },
43585 "type" : {
43586 "type" : "string",
43587 "description" : "Resource type",
43588 "example" : "tracks"
43589 }
43590 }
43591 },
43592 "UserCollectionTracks_Items_Resource_Identifier_Meta" : {
43593 "required" : [ "addedAt" ],
43594 "type" : "object",
43595 "properties" : {
43596 "addedAt" : {
43597 "type" : "string",
43598 "format" : "date-time"
43599 },
43600 "replacement" : {
43601 "$ref" : "#/components/schemas/Replacement_Provenance"
43602 }
43603 }
43604 },
43605 "UserCollectionTracks_Multi_Relationship_Data_Document" : {
43606 "required" : [ "links" ],
43607 "type" : "object",
43608 "properties" : {
43609 "data" : {
43610 "type" : "array",
43611 "items" : {
43612 "$ref" : "#/components/schemas/Resource_Identifier"
43613 }
43614 },
43615 "included" : {
43616 "$ref" : "#/components/schemas/Included"
43617 },
43618 "links" : {
43619 "$ref" : "#/components/schemas/Links"
43620 }
43621 }
43622 },
43623 "UserCollectionTracks_Relationships" : {
43624 "properties" : {
43625 "items" : {
43626 "$ref" : "#/components/schemas/UserCollectionTracks_Items_Multi_Relationship_Data_Document"
43627 },
43628 "owners" : {
43629 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
43630 }
43631 }
43632 },
43633 "UserCollectionTracks_Resource_Object" : {
43634 "required" : [ "id", "type" ],
43635 "type" : "object",
43636 "properties" : {
43637 "attributes" : {
43638 "$ref" : "#/components/schemas/UserCollectionTracks_Attributes"
43639 },
43640 "id" : {
43641 "type" : "string",
43642 "description" : "Resource id",
43643 "example" : "12345"
43644 },
43645 "relationships" : {
43646 "$ref" : "#/components/schemas/UserCollectionTracks_Relationships"
43647 },
43648 "type" : {
43649 "minLength" : 1,
43650 "type" : "string",
43651 "description" : "Resource type",
43652 "example" : "tracks"
43653 }
43654 }
43655 },
43656 "UserCollectionTracks_Single_Resource_Data_Document" : {
43657 "required" : [ "data", "links" ],
43658 "type" : "object",
43659 "properties" : {
43660 "data" : {
43661 "$ref" : "#/components/schemas/UserCollectionTracks_Resource_Object"
43662 },
43663 "included" : {
43664 "$ref" : "#/components/schemas/Included"
43665 },
43666 "links" : {
43667 "$ref" : "#/components/schemas/Links"
43668 }
43669 }
43670 },
43671 "UserCollectionVideosAddMultiDataRelationshipWithResponse409ResponseBody" : {
43672 "required" : [ "errors" ],
43673 "type" : "object",
43674 "properties" : {
43675 "errors" : {
43676 "type" : "array",
43677 "items" : {
43678 "required" : [ "code", "status" ],
43679 "type" : "object",
43680 "properties" : {
43681 "code" : {
43682 "type" : "string",
43683 "example" : "DUPLICATE_ITEMS_IN_COLLECTION",
43684 "enum" : [ "DUPLICATE_ITEMS_IN_COLLECTION", "IDEMPOTENT_REQUEST_IN_PROGRESS", "TOO_MANY_ITEMS_IN_COLLECTION" ]
43685 },
43686 "detail" : {
43687 "type" : "string",
43688 "example" : "Collection item limit reached"
43689 },
43690 "status" : {
43691 "type" : "string",
43692 "example" : "409"
43693 }
43694 }
43695 }
43696 }
43697 }
43698 },
43699 "UserCollectionVideosItemsRelationshipAddOperation_Payload" : {
43700 "required" : [ "data" ],
43701 "type" : "object",
43702 "properties" : {
43703 "data" : {
43704 "maxItems" : 50,
43705 "minItems" : 1,
43706 "type" : "array",
43707 "items" : {
43708 "$ref" : "#/components/schemas/UserCollectionVideosItemsRelationshipAddOperation_Payload_Data"
43709 }
43710 }
43711 }
43712 },
43713 "UserCollectionVideosItemsRelationshipAddOperation_Payload_Data" : {
43714 "required" : [ "id", "type" ],
43715 "type" : "object",
43716 "properties" : {
43717 "id" : {
43718 "type" : "string"
43719 },
43720 "meta" : {
43721 "$ref" : "#/components/schemas/UserCollectionVideosItemsRelationshipAddOperation_Payload_Data_Meta"
43722 },
43723 "type" : {
43724 "type" : "string",
43725 "enum" : [ "videos" ]
43726 }
43727 }
43728 },
43729 "UserCollectionVideosItemsRelationshipAddOperation_Payload_Data_Meta" : {
43730 "type" : "object",
43731 "properties" : {
43732 "addedAt" : {
43733 "type" : "string",
43734 "format" : "date-time"
43735 }
43736 }
43737 },
43738 "UserCollectionVideosItemsRelationshipAddOperation_Response_Meta_SkippedItem" : {
43739 "required" : [ "id", "reason", "type" ],
43740 "type" : "object",
43741 "properties" : {
43742 "id" : {
43743 "type" : "string"
43744 },
43745 "reason" : {
43746 "type" : "string",
43747 "enum" : [ "NOT_FOUND", "ALREADY_PRESENT" ]
43748 },
43749 "type" : {
43750 "type" : "string",
43751 "enum" : [ "videos" ]
43752 }
43753 }
43754 },
43755 "UserCollectionVideosItemsRelationshipRemoveOperation_Payload" : {
43756 "required" : [ "data" ],
43757 "type" : "object",
43758 "properties" : {
43759 "data" : {
43760 "maxItems" : 50,
43761 "minItems" : 1,
43762 "type" : "array",
43763 "items" : {
43764 "$ref" : "#/components/schemas/UserCollectionVideosItemsRelationshipRemoveOperation_Payload_Data"
43765 }
43766 }
43767 }
43768 },
43769 "UserCollectionVideosItemsRelationshipRemoveOperation_Payload_Data" : {
43770 "required" : [ "id", "type" ],
43771 "type" : "object",
43772 "properties" : {
43773 "id" : {
43774 "type" : "string"
43775 },
43776 "type" : {
43777 "type" : "string",
43778 "enum" : [ "videos" ]
43779 }
43780 }
43781 },
43782 "UserCollectionVideos_Attributes" : {
43783 "required" : [ "numberOfItems" ],
43784 "type" : "object",
43785 "properties" : {
43786 "lastModifiedAt" : {
43787 "type" : "string",
43788 "description" : "When the collection was last modified",
43789 "format" : "date-time"
43790 },
43791 "numberOfItems" : {
43792 "type" : "integer",
43793 "description" : "Number of items in the collection",
43794 "format" : "int32"
43795 }
43796 }
43797 },
43798 "UserCollectionVideos_Items_Add_Multi_Relationship_Data_Document" : {
43799 "required" : [ "data", "links" ],
43800 "type" : "object",
43801 "properties" : {
43802 "data" : {
43803 "type" : "array",
43804 "items" : {
43805 "$ref" : "#/components/schemas/UserCollectionVideos_Items_Add_Resource_Identifier"
43806 }
43807 },
43808 "links" : {
43809 "$ref" : "#/components/schemas/Links"
43810 },
43811 "meta" : {
43812 "$ref" : "#/components/schemas/UserCollectionVideos_Items_Add_Multi_Relationship_Data_Document_Meta"
43813 }
43814 }
43815 },
43816 "UserCollectionVideos_Items_Add_Multi_Relationship_Data_Document_Meta" : {
43817 "required" : [ "skipped" ],
43818 "type" : "object",
43819 "properties" : {
43820 "skipped" : {
43821 "type" : "array",
43822 "items" : {
43823 "$ref" : "#/components/schemas/UserCollectionVideosItemsRelationshipAddOperation_Response_Meta_SkippedItem"
43824 }
43825 }
43826 }
43827 },
43828 "UserCollectionVideos_Items_Add_Resource_Identifier" : {
43829 "required" : [ "id", "type" ],
43830 "type" : "object",
43831 "properties" : {
43832 "id" : {
43833 "type" : "string"
43834 },
43835 "meta" : {
43836 "$ref" : "#/components/schemas/UserCollectionVideos_Items_Add_Resource_Identifier_Meta"
43837 },
43838 "type" : {
43839 "type" : "string",
43840 "enum" : [ "videos" ]
43841 }
43842 }
43843 },
43844 "UserCollectionVideos_Items_Add_Resource_Identifier_Meta" : {
43845 "required" : [ "addedAt" ],
43846 "type" : "object",
43847 "properties" : {
43848 "addedAt" : {
43849 "type" : "string",
43850 "format" : "date-time"
43851 }
43852 }
43853 },
43854 "UserCollectionVideos_Items_Multi_Relationship_Data_Document" : {
43855 "required" : [ "links" ],
43856 "type" : "object",
43857 "properties" : {
43858 "data" : {
43859 "type" : "array",
43860 "items" : {
43861 "$ref" : "#/components/schemas/UserCollectionVideos_Items_Resource_Identifier"
43862 }
43863 },
43864 "included" : {
43865 "$ref" : "#/components/schemas/Included"
43866 },
43867 "links" : {
43868 "$ref" : "#/components/schemas/Links"
43869 }
43870 }
43871 },
43872 "UserCollectionVideos_Items_Resource_Identifier" : {
43873 "required" : [ "id", "type" ],
43874 "type" : "object",
43875 "properties" : {
43876 "id" : {
43877 "type" : "string",
43878 "description" : "Resource id",
43879 "example" : "12345"
43880 },
43881 "meta" : {
43882 "$ref" : "#/components/schemas/UserCollectionVideos_Items_Resource_Identifier_Meta"
43883 },
43884 "type" : {
43885 "type" : "string",
43886 "description" : "Resource type",
43887 "example" : "tracks"
43888 }
43889 }
43890 },
43891 "UserCollectionVideos_Items_Resource_Identifier_Meta" : {
43892 "required" : [ "addedAt" ],
43893 "type" : "object",
43894 "properties" : {
43895 "addedAt" : {
43896 "type" : "string",
43897 "format" : "date-time"
43898 },
43899 "replacement" : {
43900 "$ref" : "#/components/schemas/Replacement_Provenance"
43901 }
43902 }
43903 },
43904 "UserCollectionVideos_Multi_Relationship_Data_Document" : {
43905 "required" : [ "links" ],
43906 "type" : "object",
43907 "properties" : {
43908 "data" : {
43909 "type" : "array",
43910 "items" : {
43911 "$ref" : "#/components/schemas/Resource_Identifier"
43912 }
43913 },
43914 "included" : {
43915 "$ref" : "#/components/schemas/Included"
43916 },
43917 "links" : {
43918 "$ref" : "#/components/schemas/Links"
43919 }
43920 }
43921 },
43922 "UserCollectionVideos_Relationships" : {
43923 "properties" : {
43924 "items" : {
43925 "$ref" : "#/components/schemas/UserCollectionVideos_Items_Multi_Relationship_Data_Document"
43926 },
43927 "owners" : {
43928 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
43929 }
43930 }
43931 },
43932 "UserCollectionVideos_Resource_Object" : {
43933 "required" : [ "id", "type" ],
43934 "type" : "object",
43935 "properties" : {
43936 "attributes" : {
43937 "$ref" : "#/components/schemas/UserCollectionVideos_Attributes"
43938 },
43939 "id" : {
43940 "type" : "string",
43941 "description" : "Resource id",
43942 "example" : "12345"
43943 },
43944 "relationships" : {
43945 "$ref" : "#/components/schemas/UserCollectionVideos_Relationships"
43946 },
43947 "type" : {
43948 "minLength" : 1,
43949 "type" : "string",
43950 "description" : "Resource type",
43951 "example" : "tracks"
43952 }
43953 }
43954 },
43955 "UserCollectionVideos_Single_Resource_Data_Document" : {
43956 "required" : [ "data", "links" ],
43957 "type" : "object",
43958 "properties" : {
43959 "data" : {
43960 "$ref" : "#/components/schemas/UserCollectionVideos_Resource_Object"
43961 },
43962 "included" : {
43963 "$ref" : "#/components/schemas/Included"
43964 },
43965 "links" : {
43966 "$ref" : "#/components/schemas/Links"
43967 }
43968 }
43969 },
43970 "UserCollectionsAddMultiDataRelationship409ResponseBody" : {
43971 "required" : [ "errors" ],
43972 "type" : "object",
43973 "properties" : {
43974 "errors" : {
43975 "type" : "array",
43976 "items" : {
43977 "required" : [ "code", "status" ],
43978 "type" : "object",
43979 "properties" : {
43980 "code" : {
43981 "type" : "string",
43982 "example" : "DUPLICATE_ITEMS_IN_COLLECTION",
43983 "enum" : [ "DUPLICATE_ITEMS_IN_COLLECTION", "IDEMPOTENT_REQUEST_IN_PROGRESS", "TOO_MANY_ITEMS_IN_COLLECTION" ]
43984 },
43985 "detail" : {
43986 "type" : "string",
43987 "example" : "Collection item limit reached"
43988 },
43989 "status" : {
43990 "type" : "string",
43991 "example" : "409"
43992 }
43993 }
43994 }
43995 }
43996 }
43997 },
43998 "UserCollectionsAlbumsRelationshipAddOperation_Payload" : {
43999 "required" : [ "data" ],
44000 "type" : "object",
44001 "properties" : {
44002 "data" : {
44003 "maxItems" : 50,
44004 "minItems" : 1,
44005 "type" : "array",
44006 "items" : {
44007 "$ref" : "#/components/schemas/UserCollectionsAlbumsRelationshipAddOperation_Payload_Data"
44008 }
44009 }
44010 }
44011 },
44012 "UserCollectionsAlbumsRelationshipAddOperation_Payload_Data" : {
44013 "required" : [ "id", "type" ],
44014 "type" : "object",
44015 "properties" : {
44016 "id" : {
44017 "type" : "string"
44018 },
44019 "meta" : {
44020 "$ref" : "#/components/schemas/UserCollectionsAlbumsRelationshipAddOperation_Payload_Data_Meta"
44021 },
44022 "type" : {
44023 "type" : "string",
44024 "enum" : [ "albums" ]
44025 }
44026 }
44027 },
44028 "UserCollectionsAlbumsRelationshipAddOperation_Payload_Data_Meta" : {
44029 "type" : "object",
44030 "properties" : {
44031 "addedAt" : {
44032 "type" : "string",
44033 "format" : "date-time"
44034 }
44035 }
44036 },
44037 "UserCollectionsAlbumsRelationshipRemoveOperation_Payload" : {
44038 "required" : [ "data" ],
44039 "type" : "object",
44040 "properties" : {
44041 "data" : {
44042 "maxItems" : 50,
44043 "minItems" : 1,
44044 "type" : "array",
44045 "items" : {
44046 "$ref" : "#/components/schemas/UserCollectionsAlbumsRelationshipRemoveOperation_Payload_Data"
44047 }
44048 }
44049 }
44050 },
44051 "UserCollectionsAlbumsRelationshipRemoveOperation_Payload_Data" : {
44052 "required" : [ "id", "type" ],
44053 "type" : "object",
44054 "properties" : {
44055 "id" : {
44056 "type" : "string"
44057 },
44058 "type" : {
44059 "type" : "string",
44060 "enum" : [ "albums" ]
44061 }
44062 }
44063 },
44064 "UserCollectionsArtistsRelationshipAddOperation_Payload" : {
44065 "required" : [ "data" ],
44066 "type" : "object",
44067 "properties" : {
44068 "data" : {
44069 "maxItems" : 50,
44070 "minItems" : 1,
44071 "type" : "array",
44072 "items" : {
44073 "$ref" : "#/components/schemas/UserCollectionsArtistsRelationshipAddOperation_Payload_Data"
44074 }
44075 }
44076 }
44077 },
44078 "UserCollectionsArtistsRelationshipAddOperation_Payload_Data" : {
44079 "required" : [ "id", "type" ],
44080 "type" : "object",
44081 "properties" : {
44082 "id" : {
44083 "type" : "string"
44084 },
44085 "meta" : {
44086 "$ref" : "#/components/schemas/UserCollectionsArtistsRelationshipAddOperation_Payload_Data_Meta"
44087 },
44088 "type" : {
44089 "type" : "string",
44090 "enum" : [ "artists" ]
44091 }
44092 }
44093 },
44094 "UserCollectionsArtistsRelationshipAddOperation_Payload_Data_Meta" : {
44095 "type" : "object",
44096 "properties" : {
44097 "addedAt" : {
44098 "type" : "string",
44099 "format" : "date-time"
44100 }
44101 }
44102 },
44103 "UserCollectionsArtistsRelationshipRemoveOperation_Payload" : {
44104 "required" : [ "data" ],
44105 "type" : "object",
44106 "properties" : {
44107 "data" : {
44108 "maxItems" : 50,
44109 "minItems" : 1,
44110 "type" : "array",
44111 "items" : {
44112 "$ref" : "#/components/schemas/UserCollectionsArtistsRelationshipRemoveOperation_Payload_Data"
44113 }
44114 }
44115 }
44116 },
44117 "UserCollectionsArtistsRelationshipRemoveOperation_Payload_Data" : {
44118 "required" : [ "id", "type" ],
44119 "type" : "object",
44120 "properties" : {
44121 "id" : {
44122 "type" : "string"
44123 },
44124 "type" : {
44125 "type" : "string",
44126 "enum" : [ "artists" ]
44127 }
44128 }
44129 },
44130 "UserCollectionsPlaylistsRelationshipAddOperation_Payload" : {
44131 "required" : [ "data" ],
44132 "type" : "object",
44133 "properties" : {
44134 "data" : {
44135 "maxItems" : 50,
44136 "minItems" : 1,
44137 "type" : "array",
44138 "items" : {
44139 "$ref" : "#/components/schemas/UserCollectionsPlaylistsRelationshipAddOperation_Payload_Data"
44140 }
44141 }
44142 }
44143 },
44144 "UserCollectionsPlaylistsRelationshipAddOperation_Payload_Data" : {
44145 "required" : [ "id", "type" ],
44146 "type" : "object",
44147 "properties" : {
44148 "id" : {
44149 "type" : "string"
44150 },
44151 "type" : {
44152 "type" : "string",
44153 "enum" : [ "playlists" ]
44154 }
44155 }
44156 },
44157 "UserCollectionsPlaylistsRelationshipRemoveOperation_Payload" : {
44158 "required" : [ "data" ],
44159 "type" : "object",
44160 "properties" : {
44161 "data" : {
44162 "maxItems" : 50,
44163 "minItems" : 1,
44164 "type" : "array",
44165 "items" : {
44166 "$ref" : "#/components/schemas/UserCollectionsPlaylistsRelationshipRemoveOperation_Payload_Data"
44167 }
44168 }
44169 }
44170 },
44171 "UserCollectionsPlaylistsRelationshipRemoveOperation_Payload_Data" : {
44172 "required" : [ "id", "type" ],
44173 "type" : "object",
44174 "properties" : {
44175 "id" : {
44176 "type" : "string"
44177 },
44178 "type" : {
44179 "type" : "string",
44180 "enum" : [ "playlists" ]
44181 }
44182 }
44183 },
44184 "UserCollectionsTracksRelationshipAddOperation_Payload" : {
44185 "required" : [ "data" ],
44186 "type" : "object",
44187 "properties" : {
44188 "data" : {
44189 "maxItems" : 50,
44190 "minItems" : 1,
44191 "type" : "array",
44192 "items" : {
44193 "$ref" : "#/components/schemas/UserCollectionsTracksRelationshipAddOperation_Payload_Data"
44194 }
44195 }
44196 }
44197 },
44198 "UserCollectionsTracksRelationshipAddOperation_Payload_Data" : {
44199 "required" : [ "id", "type" ],
44200 "type" : "object",
44201 "properties" : {
44202 "id" : {
44203 "type" : "string"
44204 },
44205 "meta" : {
44206 "$ref" : "#/components/schemas/UserCollectionsTracksRelationshipAddOperation_Payload_Data_Meta"
44207 },
44208 "type" : {
44209 "type" : "string",
44210 "enum" : [ "tracks" ]
44211 }
44212 }
44213 },
44214 "UserCollectionsTracksRelationshipAddOperation_Payload_Data_Meta" : {
44215 "type" : "object",
44216 "properties" : {
44217 "addedAt" : {
44218 "type" : "string",
44219 "format" : "date-time"
44220 }
44221 }
44222 },
44223 "UserCollectionsTracksRelationshipRemoveOperation_Payload" : {
44224 "required" : [ "data" ],
44225 "type" : "object",
44226 "properties" : {
44227 "data" : {
44228 "maxItems" : 50,
44229 "minItems" : 1,
44230 "type" : "array",
44231 "items" : {
44232 "$ref" : "#/components/schemas/UserCollectionsTracksRelationshipRemoveOperation_Payload_Data"
44233 }
44234 }
44235 }
44236 },
44237 "UserCollectionsTracksRelationshipRemoveOperation_Payload_Data" : {
44238 "required" : [ "id", "type" ],
44239 "type" : "object",
44240 "properties" : {
44241 "id" : {
44242 "type" : "string"
44243 },
44244 "type" : {
44245 "type" : "string",
44246 "enum" : [ "tracks" ]
44247 }
44248 }
44249 },
44250 "UserCollectionsVideosRelationshipAddOperation_Payload" : {
44251 "required" : [ "data" ],
44252 "type" : "object",
44253 "properties" : {
44254 "data" : {
44255 "maxItems" : 50,
44256 "minItems" : 1,
44257 "type" : "array",
44258 "items" : {
44259 "$ref" : "#/components/schemas/UserCollectionsVideosRelationshipAddOperation_Payload_Data"
44260 }
44261 }
44262 }
44263 },
44264 "UserCollectionsVideosRelationshipAddOperation_Payload_Data" : {
44265 "required" : [ "id", "type" ],
44266 "type" : "object",
44267 "properties" : {
44268 "id" : {
44269 "type" : "string"
44270 },
44271 "type" : {
44272 "type" : "string",
44273 "enum" : [ "videos" ]
44274 }
44275 }
44276 },
44277 "UserCollectionsVideosRelationshipRemoveOperation_Payload" : {
44278 "required" : [ "data" ],
44279 "type" : "object",
44280 "properties" : {
44281 "data" : {
44282 "maxItems" : 50,
44283 "minItems" : 1,
44284 "type" : "array",
44285 "items" : {
44286 "$ref" : "#/components/schemas/UserCollectionsVideosRelationshipRemoveOperation_Payload_Data"
44287 }
44288 }
44289 }
44290 },
44291 "UserCollectionsVideosRelationshipRemoveOperation_Payload_Data" : {
44292 "required" : [ "id", "type" ],
44293 "type" : "object",
44294 "properties" : {
44295 "id" : {
44296 "type" : "string"
44297 },
44298 "type" : {
44299 "type" : "string",
44300 "enum" : [ "videos" ]
44301 }
44302 }
44303 },
44304 "UserCollections_Albums_Multi_Relationship_Data_Document" : {
44305 "required" : [ "links" ],
44306 "type" : "object",
44307 "properties" : {
44308 "data" : {
44309 "type" : "array",
44310 "items" : {
44311 "$ref" : "#/components/schemas/UserCollections_Albums_Resource_Identifier"
44312 }
44313 },
44314 "included" : {
44315 "$ref" : "#/components/schemas/Included"
44316 },
44317 "links" : {
44318 "$ref" : "#/components/schemas/Links"
44319 }
44320 }
44321 },
44322 "UserCollections_Albums_Resource_Identifier" : {
44323 "required" : [ "id", "type" ],
44324 "type" : "object",
44325 "properties" : {
44326 "id" : {
44327 "type" : "string",
44328 "description" : "Resource id",
44329 "example" : "12345"
44330 },
44331 "meta" : {
44332 "$ref" : "#/components/schemas/UserCollections_Albums_Resource_Identifier_Meta"
44333 },
44334 "type" : {
44335 "type" : "string",
44336 "description" : "Resource type",
44337 "example" : "tracks"
44338 }
44339 }
44340 },
44341 "UserCollections_Albums_Resource_Identifier_Meta" : {
44342 "required" : [ "addedAt" ],
44343 "type" : "object",
44344 "properties" : {
44345 "addedAt" : {
44346 "type" : "string",
44347 "format" : "date-time"
44348 },
44349 "replacement" : {
44350 "$ref" : "#/components/schemas/Replacement_Provenance"
44351 }
44352 }
44353 },
44354 "UserCollections_Artists_Multi_Relationship_Data_Document" : {
44355 "required" : [ "links" ],
44356 "type" : "object",
44357 "properties" : {
44358 "data" : {
44359 "type" : "array",
44360 "items" : {
44361 "$ref" : "#/components/schemas/UserCollections_Artists_Resource_Identifier"
44362 }
44363 },
44364 "included" : {
44365 "$ref" : "#/components/schemas/Included"
44366 },
44367 "links" : {
44368 "$ref" : "#/components/schemas/Links"
44369 }
44370 }
44371 },
44372 "UserCollections_Artists_Resource_Identifier" : {
44373 "required" : [ "id", "type" ],
44374 "type" : "object",
44375 "properties" : {
44376 "id" : {
44377 "type" : "string",
44378 "description" : "Resource id",
44379 "example" : "12345"
44380 },
44381 "meta" : {
44382 "$ref" : "#/components/schemas/UserCollections_Artists_Resource_Identifier_Meta"
44383 },
44384 "type" : {
44385 "type" : "string",
44386 "description" : "Resource type",
44387 "example" : "tracks"
44388 }
44389 }
44390 },
44391 "UserCollections_Artists_Resource_Identifier_Meta" : {
44392 "required" : [ "addedAt" ],
44393 "type" : "object",
44394 "properties" : {
44395 "addedAt" : {
44396 "type" : "string",
44397 "format" : "date-time"
44398 }
44399 }
44400 },
44401 "UserCollections_Attributes" : {
44402 "type" : "object"
44403 },
44404 "UserCollections_Multi_Relationship_Data_Document" : {
44405 "required" : [ "links" ],
44406 "type" : "object",
44407 "properties" : {
44408 "data" : {
44409 "type" : "array",
44410 "items" : {
44411 "$ref" : "#/components/schemas/Resource_Identifier"
44412 }
44413 },
44414 "included" : {
44415 "$ref" : "#/components/schemas/Included"
44416 },
44417 "links" : {
44418 "$ref" : "#/components/schemas/Links"
44419 }
44420 }
44421 },
44422 "UserCollections_Playlists_Multi_Relationship_Data_Document" : {
44423 "required" : [ "links" ],
44424 "type" : "object",
44425 "properties" : {
44426 "data" : {
44427 "type" : "array",
44428 "items" : {
44429 "$ref" : "#/components/schemas/UserCollections_Playlists_Resource_Identifier"
44430 }
44431 },
44432 "included" : {
44433 "$ref" : "#/components/schemas/Included"
44434 },
44435 "links" : {
44436 "$ref" : "#/components/schemas/Links"
44437 }
44438 }
44439 },
44440 "UserCollections_Playlists_Resource_Identifier" : {
44441 "required" : [ "id", "type" ],
44442 "type" : "object",
44443 "properties" : {
44444 "id" : {
44445 "type" : "string",
44446 "description" : "Resource id",
44447 "example" : "12345"
44448 },
44449 "meta" : {
44450 "$ref" : "#/components/schemas/UserCollections_Playlists_Resource_Identifier_Meta"
44451 },
44452 "type" : {
44453 "type" : "string",
44454 "description" : "Resource type",
44455 "example" : "tracks"
44456 }
44457 }
44458 },
44459 "UserCollections_Playlists_Resource_Identifier_Meta" : {
44460 "required" : [ "addedAt" ],
44461 "type" : "object",
44462 "properties" : {
44463 "addedAt" : {
44464 "type" : "string",
44465 "format" : "date-time"
44466 }
44467 }
44468 },
44469 "UserCollections_Relationships" : {
44470 "properties" : {
44471 "albums" : {
44472 "$ref" : "#/components/schemas/UserCollections_Albums_Multi_Relationship_Data_Document"
44473 },
44474 "artists" : {
44475 "$ref" : "#/components/schemas/UserCollections_Artists_Multi_Relationship_Data_Document"
44476 },
44477 "owners" : {
44478 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
44479 },
44480 "playlists" : {
44481 "$ref" : "#/components/schemas/UserCollections_Playlists_Multi_Relationship_Data_Document"
44482 },
44483 "tracks" : {
44484 "$ref" : "#/components/schemas/UserCollections_Tracks_Multi_Relationship_Data_Document"
44485 },
44486 "videos" : {
44487 "$ref" : "#/components/schemas/UserCollections_Videos_Multi_Relationship_Data_Document"
44488 }
44489 }
44490 },
44491 "UserCollections_Resource_Object" : {
44492 "required" : [ "id", "type" ],
44493 "type" : "object",
44494 "properties" : {
44495 "attributes" : {
44496 "$ref" : "#/components/schemas/UserCollections_Attributes"
44497 },
44498 "id" : {
44499 "type" : "string",
44500 "description" : "Resource id",
44501 "example" : "12345"
44502 },
44503 "relationships" : {
44504 "$ref" : "#/components/schemas/UserCollections_Relationships"
44505 },
44506 "type" : {
44507 "minLength" : 1,
44508 "type" : "string",
44509 "description" : "Resource type",
44510 "example" : "tracks"
44511 }
44512 }
44513 },
44514 "UserCollections_Single_Resource_Data_Document" : {
44515 "required" : [ "data", "links" ],
44516 "type" : "object",
44517 "properties" : {
44518 "data" : {
44519 "$ref" : "#/components/schemas/UserCollections_Resource_Object"
44520 },
44521 "included" : {
44522 "$ref" : "#/components/schemas/Included"
44523 },
44524 "links" : {
44525 "$ref" : "#/components/schemas/Links"
44526 }
44527 }
44528 },
44529 "UserCollections_Tracks_Multi_Relationship_Data_Document" : {
44530 "required" : [ "links" ],
44531 "type" : "object",
44532 "properties" : {
44533 "data" : {
44534 "type" : "array",
44535 "items" : {
44536 "$ref" : "#/components/schemas/UserCollections_Tracks_Resource_Identifier"
44537 }
44538 },
44539 "included" : {
44540 "$ref" : "#/components/schemas/Included"
44541 },
44542 "links" : {
44543 "$ref" : "#/components/schemas/Links"
44544 }
44545 }
44546 },
44547 "UserCollections_Tracks_Resource_Identifier" : {
44548 "required" : [ "id", "type" ],
44549 "type" : "object",
44550 "properties" : {
44551 "id" : {
44552 "type" : "string",
44553 "description" : "Resource id",
44554 "example" : "12345"
44555 },
44556 "meta" : {
44557 "$ref" : "#/components/schemas/UserCollections_Tracks_Resource_Identifier_Meta"
44558 },
44559 "type" : {
44560 "type" : "string",
44561 "description" : "Resource type",
44562 "example" : "tracks"
44563 }
44564 }
44565 },
44566 "UserCollections_Tracks_Resource_Identifier_Meta" : {
44567 "required" : [ "addedAt" ],
44568 "type" : "object",
44569 "properties" : {
44570 "addedAt" : {
44571 "type" : "string",
44572 "format" : "date-time"
44573 },
44574 "replacement" : {
44575 "$ref" : "#/components/schemas/Replacement_Provenance"
44576 }
44577 }
44578 },
44579 "UserCollections_Videos_Multi_Relationship_Data_Document" : {
44580 "required" : [ "links" ],
44581 "type" : "object",
44582 "properties" : {
44583 "data" : {
44584 "type" : "array",
44585 "items" : {
44586 "$ref" : "#/components/schemas/UserCollections_Videos_Resource_Identifier"
44587 }
44588 },
44589 "included" : {
44590 "$ref" : "#/components/schemas/Included"
44591 },
44592 "links" : {
44593 "$ref" : "#/components/schemas/Links"
44594 }
44595 }
44596 },
44597 "UserCollections_Videos_Resource_Identifier" : {
44598 "required" : [ "id", "type" ],
44599 "type" : "object",
44600 "properties" : {
44601 "id" : {
44602 "type" : "string",
44603 "description" : "Resource id",
44604 "example" : "12345"
44605 },
44606 "meta" : {
44607 "$ref" : "#/components/schemas/UserCollections_Videos_Resource_Identifier_Meta"
44608 },
44609 "type" : {
44610 "type" : "string",
44611 "description" : "Resource type",
44612 "example" : "tracks"
44613 }
44614 }
44615 },
44616 "UserCollections_Videos_Resource_Identifier_Meta" : {
44617 "required" : [ "addedAt" ],
44618 "type" : "object",
44619 "properties" : {
44620 "addedAt" : {
44621 "type" : "string",
44622 "format" : "date-time"
44623 },
44624 "replacement" : {
44625 "$ref" : "#/components/schemas/Replacement_Provenance"
44626 }
44627 }
44628 },
44629 "UserDailyMixes_Attributes" : {
44630 "type" : "object"
44631 },
44632 "UserDailyMixes_Multi_Relationship_Data_Document" : {
44633 "required" : [ "links" ],
44634 "type" : "object",
44635 "properties" : {
44636 "data" : {
44637 "type" : "array",
44638 "items" : {
44639 "$ref" : "#/components/schemas/Resource_Identifier"
44640 }
44641 },
44642 "included" : {
44643 "$ref" : "#/components/schemas/Included"
44644 },
44645 "links" : {
44646 "$ref" : "#/components/schemas/Links"
44647 }
44648 }
44649 },
44650 "UserDailyMixes_Relationships" : {
44651 "properties" : {
44652 "items" : {
44653 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
44654 }
44655 }
44656 },
44657 "UserDailyMixes_Resource_Object" : {
44658 "required" : [ "id", "type" ],
44659 "type" : "object",
44660 "properties" : {
44661 "attributes" : {
44662 "$ref" : "#/components/schemas/UserDailyMixes_Attributes"
44663 },
44664 "id" : {
44665 "type" : "string",
44666 "description" : "Resource id",
44667 "example" : "12345"
44668 },
44669 "relationships" : {
44670 "$ref" : "#/components/schemas/UserDailyMixes_Relationships"
44671 },
44672 "type" : {
44673 "minLength" : 1,
44674 "type" : "string",
44675 "description" : "Resource type",
44676 "example" : "tracks"
44677 }
44678 }
44679 },
44680 "UserDailyMixes_Single_Resource_Data_Document" : {
44681 "required" : [ "data", "links" ],
44682 "type" : "object",
44683 "properties" : {
44684 "data" : {
44685 "$ref" : "#/components/schemas/UserDailyMixes_Resource_Object"
44686 },
44687 "included" : {
44688 "$ref" : "#/components/schemas/Included"
44689 },
44690 "links" : {
44691 "$ref" : "#/components/schemas/Links"
44692 }
44693 }
44694 },
44695 "UserDataExportRequestsCreateOperation_Payload" : {
44696 "required" : [ "data" ],
44697 "type" : "object",
44698 "properties" : {
44699 "data" : {
44700 "$ref" : "#/components/schemas/UserDataExportRequestsCreateOperation_Payload_Data"
44701 }
44702 }
44703 },
44704 "UserDataExportRequestsCreateOperation_Payload_Data" : {
44705 "required" : [ "attributes", "type" ],
44706 "type" : "object",
44707 "properties" : {
44708 "attributes" : {
44709 "$ref" : "#/components/schemas/UserDataExportRequestsCreateOperation_Payload_Data_Attributes"
44710 },
44711 "type" : {
44712 "type" : "string",
44713 "enum" : [ "userDataExportRequests" ]
44714 }
44715 }
44716 },
44717 "UserDataExportRequestsCreateOperation_Payload_Data_Attributes" : {
44718 "required" : [ "flowType" ],
44719 "type" : "object",
44720 "properties" : {
44721 "flowType" : {
44722 "type" : "string",
44723 "enum" : [ "GDPR", "CCPA", "COPPA", "ANZ_PA", "US_PRIVACY_REGULATION", "APPI", "RETENTION_POLICY" ]
44724 }
44725 }
44726 },
44727 "UserDataExportRequests_Attributes" : {
44728 "required" : [ "flowType" ],
44729 "type" : "object",
44730 "properties" : {
44731 "flowType" : {
44732 "type" : "string",
44733 "description" : "The type of data export flow",
44734 "enum" : [ "GDPR", "CCPA", "COPPA", "ANZ_PA", "US_PRIVACY_REGULATION", "APPI", "RETENTION_POLICY" ]
44735 }
44736 }
44737 },
44738 "UserDataExportRequests_Create_Single_Resource_Data_Document" : {
44739 "required" : [ "data", "links" ],
44740 "type" : "object",
44741 "properties" : {
44742 "data" : {
44743 "$ref" : "#/components/schemas/UserDataExportRequests_Resource_Object"
44744 },
44745 "links" : {
44746 "$ref" : "#/components/schemas/Links"
44747 }
44748 }
44749 },
44750 "UserDataExportRequests_Resource_Object" : {
44751 "required" : [ "id", "type" ],
44752 "type" : "object",
44753 "properties" : {
44754 "attributes" : {
44755 "$ref" : "#/components/schemas/UserDataExportRequests_Attributes"
44756 },
44757 "id" : {
44758 "type" : "string",
44759 "description" : "Resource id",
44760 "example" : "12345"
44761 },
44762 "type" : {
44763 "minLength" : 1,
44764 "type" : "string",
44765 "description" : "Resource type",
44766 "example" : "tracks"
44767 }
44768 }
44769 },
44770 "UserDiscoveryMixes_Attributes" : {
44771 "type" : "object"
44772 },
44773 "UserDiscoveryMixes_Multi_Relationship_Data_Document" : {
44774 "required" : [ "links" ],
44775 "type" : "object",
44776 "properties" : {
44777 "data" : {
44778 "type" : "array",
44779 "items" : {
44780 "$ref" : "#/components/schemas/Resource_Identifier"
44781 }
44782 },
44783 "included" : {
44784 "$ref" : "#/components/schemas/Included"
44785 },
44786 "links" : {
44787 "$ref" : "#/components/schemas/Links"
44788 }
44789 }
44790 },
44791 "UserDiscoveryMixes_Relationships" : {
44792 "properties" : {
44793 "items" : {
44794 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
44795 }
44796 }
44797 },
44798 "UserDiscoveryMixes_Resource_Object" : {
44799 "required" : [ "id", "type" ],
44800 "type" : "object",
44801 "properties" : {
44802 "attributes" : {
44803 "$ref" : "#/components/schemas/UserDiscoveryMixes_Attributes"
44804 },
44805 "id" : {
44806 "type" : "string",
44807 "description" : "Resource id",
44808 "example" : "12345"
44809 },
44810 "relationships" : {
44811 "$ref" : "#/components/schemas/UserDiscoveryMixes_Relationships"
44812 },
44813 "type" : {
44814 "minLength" : 1,
44815 "type" : "string",
44816 "description" : "Resource type",
44817 "example" : "tracks"
44818 }
44819 }
44820 },
44821 "UserDiscoveryMixes_Single_Resource_Data_Document" : {
44822 "required" : [ "data", "links" ],
44823 "type" : "object",
44824 "properties" : {
44825 "data" : {
44826 "$ref" : "#/components/schemas/UserDiscoveryMixes_Resource_Object"
44827 },
44828 "included" : {
44829 "$ref" : "#/components/schemas/Included"
44830 },
44831 "links" : {
44832 "$ref" : "#/components/schemas/Links"
44833 }
44834 }
44835 },
44836 "UserNewReleaseMixes_Attributes" : {
44837 "type" : "object"
44838 },
44839 "UserNewReleaseMixes_Multi_Relationship_Data_Document" : {
44840 "required" : [ "links" ],
44841 "type" : "object",
44842 "properties" : {
44843 "data" : {
44844 "type" : "array",
44845 "items" : {
44846 "$ref" : "#/components/schemas/Resource_Identifier"
44847 }
44848 },
44849 "included" : {
44850 "$ref" : "#/components/schemas/Included"
44851 },
44852 "links" : {
44853 "$ref" : "#/components/schemas/Links"
44854 }
44855 }
44856 },
44857 "UserNewReleaseMixes_Relationships" : {
44858 "properties" : {
44859 "items" : {
44860 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
44861 }
44862 }
44863 },
44864 "UserNewReleaseMixes_Resource_Object" : {
44865 "required" : [ "id", "type" ],
44866 "type" : "object",
44867 "properties" : {
44868 "attributes" : {
44869 "$ref" : "#/components/schemas/UserNewReleaseMixes_Attributes"
44870 },
44871 "id" : {
44872 "type" : "string",
44873 "description" : "Resource id",
44874 "example" : "12345"
44875 },
44876 "relationships" : {
44877 "$ref" : "#/components/schemas/UserNewReleaseMixes_Relationships"
44878 },
44879 "type" : {
44880 "minLength" : 1,
44881 "type" : "string",
44882 "description" : "Resource type",
44883 "example" : "tracks"
44884 }
44885 }
44886 },
44887 "UserNewReleaseMixes_Single_Resource_Data_Document" : {
44888 "required" : [ "data", "links" ],
44889 "type" : "object",
44890 "properties" : {
44891 "data" : {
44892 "$ref" : "#/components/schemas/UserNewReleaseMixes_Resource_Object"
44893 },
44894 "included" : {
44895 "$ref" : "#/components/schemas/Included"
44896 },
44897 "links" : {
44898 "$ref" : "#/components/schemas/Links"
44899 }
44900 }
44901 },
44902 "UserOfflineMixes_Attributes" : {
44903 "type" : "object"
44904 },
44905 "UserOfflineMixes_Multi_Relationship_Data_Document" : {
44906 "required" : [ "links" ],
44907 "type" : "object",
44908 "properties" : {
44909 "data" : {
44910 "type" : "array",
44911 "items" : {
44912 "$ref" : "#/components/schemas/Resource_Identifier"
44913 }
44914 },
44915 "included" : {
44916 "$ref" : "#/components/schemas/Included"
44917 },
44918 "links" : {
44919 "$ref" : "#/components/schemas/Links"
44920 }
44921 }
44922 },
44923 "UserOfflineMixes_Relationships" : {
44924 "properties" : {
44925 "items" : {
44926 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
44927 }
44928 }
44929 },
44930 "UserOfflineMixes_Resource_Object" : {
44931 "required" : [ "id", "type" ],
44932 "type" : "object",
44933 "properties" : {
44934 "attributes" : {
44935 "$ref" : "#/components/schemas/UserOfflineMixes_Attributes"
44936 },
44937 "id" : {
44938 "type" : "string",
44939 "description" : "Resource id",
44940 "example" : "12345"
44941 },
44942 "relationships" : {
44943 "$ref" : "#/components/schemas/UserOfflineMixes_Relationships"
44944 },
44945 "type" : {
44946 "minLength" : 1,
44947 "type" : "string",
44948 "description" : "Resource type",
44949 "example" : "tracks"
44950 }
44951 }
44952 },
44953 "UserOfflineMixes_Single_Resource_Data_Document" : {
44954 "required" : [ "data", "links" ],
44955 "type" : "object",
44956 "properties" : {
44957 "data" : {
44958 "$ref" : "#/components/schemas/UserOfflineMixes_Resource_Object"
44959 },
44960 "included" : {
44961 "$ref" : "#/components/schemas/Included"
44962 },
44963 "links" : {
44964 "$ref" : "#/components/schemas/Links"
44965 }
44966 }
44967 },
44968 "UserRecommendationBlocksAddMultiDataRelationshipWithResponse409ResponseBody" : {
44969 "required" : [ "errors" ],
44970 "type" : "object",
44971 "properties" : {
44972 "errors" : {
44973 "type" : "array",
44974 "items" : {
44975 "required" : [ "code", "status" ],
44976 "type" : "object",
44977 "properties" : {
44978 "code" : {
44979 "type" : "string",
44980 "example" : "IDEMPOTENT_REQUEST_IN_PROGRESS",
44981 "enum" : [ "IDEMPOTENT_REQUEST_IN_PROGRESS", "MAXIMUM_NUMBER_OF_BLOCKS_EXCEEDED" ]
44982 },
44983 "detail" : {
44984 "type" : "string",
44985 "example" : "Recommendation block limit reached"
44986 },
44987 "status" : {
44988 "type" : "string",
44989 "example" : "409"
44990 }
44991 }
44992 }
44993 }
44994 }
44995 },
44996 "UserRecommendationBlocksArtistsRelationshipAddOperation_Payload" : {
44997 "required" : [ "data" ],
44998 "type" : "object",
44999 "properties" : {
45000 "data" : {
45001 "maxItems" : 1,
45002 "minItems" : 1,
45003 "type" : "array",
45004 "items" : {
45005 "$ref" : "#/components/schemas/UserRecommendationBlocksArtistsRelationshipAddOperation_Payload_Data"
45006 }
45007 }
45008 }
45009 },
45010 "UserRecommendationBlocksArtistsRelationshipAddOperation_Payload_Data" : {
45011 "required" : [ "id", "type" ],
45012 "type" : "object",
45013 "properties" : {
45014 "id" : {
45015 "type" : "string"
45016 },
45017 "type" : {
45018 "type" : "string",
45019 "enum" : [ "artists" ]
45020 }
45021 }
45022 },
45023 "UserRecommendationBlocksArtistsRelationshipRemoveOperation_Payload" : {
45024 "required" : [ "data" ],
45025 "type" : "object",
45026 "properties" : {
45027 "data" : {
45028 "maxItems" : 1,
45029 "minItems" : 1,
45030 "type" : "array",
45031 "items" : {
45032 "$ref" : "#/components/schemas/UserRecommendationBlocksArtistsRelationshipRemoveOperation_Payload_Data"
45033 }
45034 }
45035 }
45036 },
45037 "UserRecommendationBlocksArtistsRelationshipRemoveOperation_Payload_Data" : {
45038 "required" : [ "id", "type" ],
45039 "type" : "object",
45040 "properties" : {
45041 "id" : {
45042 "type" : "string"
45043 },
45044 "type" : {
45045 "type" : "string",
45046 "enum" : [ "artists" ]
45047 }
45048 }
45049 },
45050 "UserRecommendationBlocksTracksRelationshipAddOperation_Payload" : {
45051 "required" : [ "data" ],
45052 "type" : "object",
45053 "properties" : {
45054 "data" : {
45055 "maxItems" : 1,
45056 "minItems" : 1,
45057 "type" : "array",
45058 "items" : {
45059 "$ref" : "#/components/schemas/UserRecommendationBlocksTracksRelationshipAddOperation_Payload_Data"
45060 }
45061 }
45062 }
45063 },
45064 "UserRecommendationBlocksTracksRelationshipAddOperation_Payload_Data" : {
45065 "required" : [ "id", "type" ],
45066 "type" : "object",
45067 "properties" : {
45068 "id" : {
45069 "type" : "string"
45070 },
45071 "type" : {
45072 "type" : "string",
45073 "enum" : [ "tracks" ]
45074 }
45075 }
45076 },
45077 "UserRecommendationBlocksTracksRelationshipRemoveOperation_Payload" : {
45078 "required" : [ "data" ],
45079 "type" : "object",
45080 "properties" : {
45081 "data" : {
45082 "maxItems" : 1,
45083 "minItems" : 1,
45084 "type" : "array",
45085 "items" : {
45086 "$ref" : "#/components/schemas/UserRecommendationBlocksTracksRelationshipRemoveOperation_Payload_Data"
45087 }
45088 }
45089 }
45090 },
45091 "UserRecommendationBlocksTracksRelationshipRemoveOperation_Payload_Data" : {
45092 "required" : [ "id", "type" ],
45093 "type" : "object",
45094 "properties" : {
45095 "id" : {
45096 "type" : "string"
45097 },
45098 "type" : {
45099 "type" : "string",
45100 "enum" : [ "tracks" ]
45101 }
45102 }
45103 },
45104 "UserRecommendationBlocksVideosRelationshipAddOperation_Payload" : {
45105 "required" : [ "data" ],
45106 "type" : "object",
45107 "properties" : {
45108 "data" : {
45109 "maxItems" : 1,
45110 "minItems" : 1,
45111 "type" : "array",
45112 "items" : {
45113 "$ref" : "#/components/schemas/UserRecommendationBlocksVideosRelationshipAddOperation_Payload_Data"
45114 }
45115 }
45116 }
45117 },
45118 "UserRecommendationBlocksVideosRelationshipAddOperation_Payload_Data" : {
45119 "required" : [ "id", "type" ],
45120 "type" : "object",
45121 "properties" : {
45122 "id" : {
45123 "type" : "string"
45124 },
45125 "type" : {
45126 "type" : "string",
45127 "enum" : [ "videos" ]
45128 }
45129 }
45130 },
45131 "UserRecommendationBlocksVideosRelationshipRemoveOperation_Payload" : {
45132 "required" : [ "data" ],
45133 "type" : "object",
45134 "properties" : {
45135 "data" : {
45136 "maxItems" : 1,
45137 "minItems" : 1,
45138 "type" : "array",
45139 "items" : {
45140 "$ref" : "#/components/schemas/UserRecommendationBlocksVideosRelationshipRemoveOperation_Payload_Data"
45141 }
45142 }
45143 }
45144 },
45145 "UserRecommendationBlocksVideosRelationshipRemoveOperation_Payload_Data" : {
45146 "required" : [ "id", "type" ],
45147 "type" : "object",
45148 "properties" : {
45149 "id" : {
45150 "type" : "string"
45151 },
45152 "type" : {
45153 "type" : "string",
45154 "enum" : [ "videos" ]
45155 }
45156 }
45157 },
45158 "UserRecommendationBlocks_Artists_Add_Multi_Relationship_Data_Document" : {
45159 "required" : [ "data", "links" ],
45160 "type" : "object",
45161 "properties" : {
45162 "data" : {
45163 "type" : "array",
45164 "items" : {
45165 "$ref" : "#/components/schemas/UserRecommendationBlocks_Artists_Add_Resource_Identifier"
45166 }
45167 },
45168 "links" : {
45169 "$ref" : "#/components/schemas/Links"
45170 }
45171 }
45172 },
45173 "UserRecommendationBlocks_Artists_Add_Resource_Identifier" : {
45174 "required" : [ "id", "type" ],
45175 "type" : "object",
45176 "properties" : {
45177 "id" : {
45178 "type" : "string"
45179 },
45180 "type" : {
45181 "type" : "string",
45182 "enum" : [ "artists" ]
45183 }
45184 }
45185 },
45186 "UserRecommendationBlocks_Artists_Multi_Relationship_Data_Document" : {
45187 "required" : [ "links" ],
45188 "type" : "object",
45189 "properties" : {
45190 "data" : {
45191 "type" : "array",
45192 "items" : {
45193 "$ref" : "#/components/schemas/UserRecommendationBlocks_Artists_Resource_Identifier"
45194 }
45195 },
45196 "included" : {
45197 "$ref" : "#/components/schemas/Included"
45198 },
45199 "links" : {
45200 "$ref" : "#/components/schemas/Links"
45201 }
45202 }
45203 },
45204 "UserRecommendationBlocks_Artists_Resource_Identifier" : {
45205 "required" : [ "id", "type" ],
45206 "type" : "object",
45207 "properties" : {
45208 "id" : {
45209 "type" : "string",
45210 "description" : "Resource id",
45211 "example" : "12345"
45212 },
45213 "meta" : {
45214 "$ref" : "#/components/schemas/UserRecommendationBlocks_Artists_Resource_Identifier_Meta"
45215 },
45216 "type" : {
45217 "type" : "string",
45218 "description" : "Resource type",
45219 "example" : "tracks"
45220 }
45221 }
45222 },
45223 "UserRecommendationBlocks_Artists_Resource_Identifier_Meta" : {
45224 "required" : [ "createdAt" ],
45225 "type" : "object",
45226 "properties" : {
45227 "createdAt" : {
45228 "type" : "string",
45229 "description" : "When the item was blocked",
45230 "format" : "date-time"
45231 }
45232 }
45233 },
45234 "UserRecommendationBlocks_Attributes" : {
45235 "type" : "object"
45236 },
45237 "UserRecommendationBlocks_Multi_Relationship_Data_Document" : {
45238 "required" : [ "links" ],
45239 "type" : "object",
45240 "properties" : {
45241 "data" : {
45242 "type" : "array",
45243 "items" : {
45244 "$ref" : "#/components/schemas/Resource_Identifier"
45245 }
45246 },
45247 "included" : {
45248 "$ref" : "#/components/schemas/Included"
45249 },
45250 "links" : {
45251 "$ref" : "#/components/schemas/Links"
45252 }
45253 }
45254 },
45255 "UserRecommendationBlocks_Relationships" : {
45256 "properties" : {
45257 "artists" : {
45258 "$ref" : "#/components/schemas/UserRecommendationBlocks_Artists_Multi_Relationship_Data_Document"
45259 },
45260 "owners" : {
45261 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
45262 },
45263 "tracks" : {
45264 "$ref" : "#/components/schemas/UserRecommendationBlocks_Tracks_Multi_Relationship_Data_Document"
45265 },
45266 "videos" : {
45267 "$ref" : "#/components/schemas/UserRecommendationBlocks_Videos_Multi_Relationship_Data_Document"
45268 }
45269 }
45270 },
45271 "UserRecommendationBlocks_Resource_Object" : {
45272 "required" : [ "id", "type" ],
45273 "type" : "object",
45274 "properties" : {
45275 "attributes" : {
45276 "$ref" : "#/components/schemas/UserRecommendationBlocks_Attributes"
45277 },
45278 "id" : {
45279 "type" : "string",
45280 "description" : "Resource id",
45281 "example" : "12345"
45282 },
45283 "relationships" : {
45284 "$ref" : "#/components/schemas/UserRecommendationBlocks_Relationships"
45285 },
45286 "type" : {
45287 "minLength" : 1,
45288 "type" : "string",
45289 "description" : "Resource type",
45290 "example" : "tracks"
45291 }
45292 }
45293 },
45294 "UserRecommendationBlocks_Single_Resource_Data_Document" : {
45295 "required" : [ "data", "links" ],
45296 "type" : "object",
45297 "properties" : {
45298 "data" : {
45299 "$ref" : "#/components/schemas/UserRecommendationBlocks_Resource_Object"
45300 },
45301 "included" : {
45302 "$ref" : "#/components/schemas/Included"
45303 },
45304 "links" : {
45305 "$ref" : "#/components/schemas/Links"
45306 }
45307 }
45308 },
45309 "UserRecommendationBlocks_Tracks_Add_Multi_Relationship_Data_Document" : {
45310 "required" : [ "data", "links" ],
45311 "type" : "object",
45312 "properties" : {
45313 "data" : {
45314 "type" : "array",
45315 "items" : {
45316 "$ref" : "#/components/schemas/UserRecommendationBlocks_Tracks_Add_Resource_Identifier"
45317 }
45318 },
45319 "links" : {
45320 "$ref" : "#/components/schemas/Links"
45321 }
45322 }
45323 },
45324 "UserRecommendationBlocks_Tracks_Add_Resource_Identifier" : {
45325 "required" : [ "id", "type" ],
45326 "type" : "object",
45327 "properties" : {
45328 "id" : {
45329 "type" : "string"
45330 },
45331 "type" : {
45332 "type" : "string",
45333 "enum" : [ "tracks" ]
45334 }
45335 }
45336 },
45337 "UserRecommendationBlocks_Tracks_Multi_Relationship_Data_Document" : {
45338 "required" : [ "links" ],
45339 "type" : "object",
45340 "properties" : {
45341 "data" : {
45342 "type" : "array",
45343 "items" : {
45344 "$ref" : "#/components/schemas/UserRecommendationBlocks_Tracks_Resource_Identifier"
45345 }
45346 },
45347 "included" : {
45348 "$ref" : "#/components/schemas/Included"
45349 },
45350 "links" : {
45351 "$ref" : "#/components/schemas/Links"
45352 }
45353 }
45354 },
45355 "UserRecommendationBlocks_Tracks_Resource_Identifier" : {
45356 "required" : [ "id", "type" ],
45357 "type" : "object",
45358 "properties" : {
45359 "id" : {
45360 "type" : "string",
45361 "description" : "Resource id",
45362 "example" : "12345"
45363 },
45364 "meta" : {
45365 "$ref" : "#/components/schemas/UserRecommendationBlocks_Tracks_Resource_Identifier_Meta"
45366 },
45367 "type" : {
45368 "type" : "string",
45369 "description" : "Resource type",
45370 "example" : "tracks"
45371 }
45372 }
45373 },
45374 "UserRecommendationBlocks_Tracks_Resource_Identifier_Meta" : {
45375 "required" : [ "createdAt" ],
45376 "type" : "object",
45377 "properties" : {
45378 "createdAt" : {
45379 "type" : "string",
45380 "description" : "When the item was blocked",
45381 "format" : "date-time"
45382 },
45383 "replacement" : {
45384 "$ref" : "#/components/schemas/Replacement_Provenance"
45385 }
45386 }
45387 },
45388 "UserRecommendationBlocks_Videos_Add_Multi_Relationship_Data_Document" : {
45389 "required" : [ "data", "links" ],
45390 "type" : "object",
45391 "properties" : {
45392 "data" : {
45393 "type" : "array",
45394 "items" : {
45395 "$ref" : "#/components/schemas/UserRecommendationBlocks_Videos_Add_Resource_Identifier"
45396 }
45397 },
45398 "links" : {
45399 "$ref" : "#/components/schemas/Links"
45400 }
45401 }
45402 },
45403 "UserRecommendationBlocks_Videos_Add_Resource_Identifier" : {
45404 "required" : [ "id", "type" ],
45405 "type" : "object",
45406 "properties" : {
45407 "id" : {
45408 "type" : "string"
45409 },
45410 "type" : {
45411 "type" : "string",
45412 "enum" : [ "videos" ]
45413 }
45414 }
45415 },
45416 "UserRecommendationBlocks_Videos_Multi_Relationship_Data_Document" : {
45417 "required" : [ "links" ],
45418 "type" : "object",
45419 "properties" : {
45420 "data" : {
45421 "type" : "array",
45422 "items" : {
45423 "$ref" : "#/components/schemas/UserRecommendationBlocks_Videos_Resource_Identifier"
45424 }
45425 },
45426 "included" : {
45427 "$ref" : "#/components/schemas/Included"
45428 },
45429 "links" : {
45430 "$ref" : "#/components/schemas/Links"
45431 }
45432 }
45433 },
45434 "UserRecommendationBlocks_Videos_Resource_Identifier" : {
45435 "required" : [ "id", "type" ],
45436 "type" : "object",
45437 "properties" : {
45438 "id" : {
45439 "type" : "string",
45440 "description" : "Resource id",
45441 "example" : "12345"
45442 },
45443 "meta" : {
45444 "$ref" : "#/components/schemas/UserRecommendationBlocks_Videos_Resource_Identifier_Meta"
45445 },
45446 "type" : {
45447 "type" : "string",
45448 "description" : "Resource type",
45449 "example" : "tracks"
45450 }
45451 }
45452 },
45453 "UserRecommendationBlocks_Videos_Resource_Identifier_Meta" : {
45454 "required" : [ "createdAt" ],
45455 "type" : "object",
45456 "properties" : {
45457 "createdAt" : {
45458 "type" : "string",
45459 "description" : "When the item was blocked",
45460 "format" : "date-time"
45461 },
45462 "replacement" : {
45463 "$ref" : "#/components/schemas/Replacement_Provenance"
45464 }
45465 }
45466 },
45467 "UserRecommendations_Attributes" : {
45468 "type" : "object"
45469 },
45470 "UserRecommendations_Multi_Relationship_Data_Document" : {
45471 "required" : [ "links" ],
45472 "type" : "object",
45473 "properties" : {
45474 "data" : {
45475 "type" : "array",
45476 "items" : {
45477 "$ref" : "#/components/schemas/Resource_Identifier"
45478 }
45479 },
45480 "included" : {
45481 "$ref" : "#/components/schemas/Included"
45482 },
45483 "links" : {
45484 "$ref" : "#/components/schemas/Links"
45485 }
45486 }
45487 },
45488 "UserRecommendations_Relationships" : {
45489 "properties" : {
45490 "discoveryMixes" : {
45491 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
45492 },
45493 "myMixes" : {
45494 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
45495 },
45496 "newArrivalMixes" : {
45497 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
45498 },
45499 "offlineMixes" : {
45500 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
45501 }
45502 }
45503 },
45504 "UserRecommendations_Resource_Object" : {
45505 "required" : [ "id", "type" ],
45506 "type" : "object",
45507 "properties" : {
45508 "attributes" : {
45509 "$ref" : "#/components/schemas/UserRecommendations_Attributes"
45510 },
45511 "id" : {
45512 "type" : "string",
45513 "description" : "Resource id",
45514 "example" : "12345"
45515 },
45516 "relationships" : {
45517 "$ref" : "#/components/schemas/UserRecommendations_Relationships"
45518 },
45519 "type" : {
45520 "minLength" : 1,
45521 "type" : "string",
45522 "description" : "Resource type",
45523 "example" : "tracks"
45524 }
45525 }
45526 },
45527 "UserRecommendations_Single_Resource_Data_Document" : {
45528 "required" : [ "data", "links" ],
45529 "type" : "object",
45530 "properties" : {
45531 "data" : {
45532 "$ref" : "#/components/schemas/UserRecommendations_Resource_Object"
45533 },
45534 "included" : {
45535 "$ref" : "#/components/schemas/Included"
45536 },
45537 "links" : {
45538 "$ref" : "#/components/schemas/Links"
45539 }
45540 }
45541 },
45542 "UserReportsCreateOperation_Payload" : {
45543 "required" : [ "data" ],
45544 "type" : "object",
45545 "properties" : {
45546 "data" : {
45547 "$ref" : "#/components/schemas/UserReportsCreateOperation_Payload_Data"
45548 }
45549 }
45550 },
45551 "UserReportsCreateOperation_Payload_Data" : {
45552 "required" : [ "attributes", "relationships", "type" ],
45553 "type" : "object",
45554 "properties" : {
45555 "attributes" : {
45556 "$ref" : "#/components/schemas/UserReportsCreateOperation_Payload_Data_Attributes"
45557 },
45558 "relationships" : {
45559 "$ref" : "#/components/schemas/UserReportsCreateOperation_Payload_Data_Relationships"
45560 },
45561 "type" : {
45562 "type" : "string",
45563 "enum" : [ "userReports" ]
45564 }
45565 }
45566 },
45567 "UserReportsCreateOperation_Payload_Data_Attributes" : {
45568 "required" : [ "description", "reason" ],
45569 "type" : "object",
45570 "properties" : {
45571 "description" : {
45572 "type" : "string"
45573 },
45574 "reason" : {
45575 "type" : "string",
45576 "enum" : [ "SEXUAL_CONTENT_OR_NUDITY", "VIOLENT_OR_DANGEROUS_CONTENT", "HATEFUL_OR_ABUSIVE_CONTENT", "HARASSMENT", "PRIVACY_VIOLATION", "SCAMS_OR_FRAUD", "SPAM", "COPYRIGHT_INFRINGEMENT", "APPEAL", "UNKNOWN" ]
45577 }
45578 }
45579 },
45580 "UserReportsCreateOperation_Payload_Data_Relationships" : {
45581 "required" : [ "reportedResources" ],
45582 "type" : "object",
45583 "properties" : {
45584 "reportedResources" : {
45585 "$ref" : "#/components/schemas/UserReportsCreateOperation_Payload_Data_Relationships_ReportedResources"
45586 }
45587 }
45588 },
45589 "UserReportsCreateOperation_Payload_Data_Relationships_ReportedResources" : {
45590 "required" : [ "data" ],
45591 "type" : "object",
45592 "properties" : {
45593 "data" : {
45594 "maxItems" : 1,
45595 "minItems" : 1,
45596 "type" : "array",
45597 "items" : {
45598 "$ref" : "#/components/schemas/UserReportsCreateOperation_Payload_Data_Relationships_ReportedResources_Data"
45599 }
45600 }
45601 }
45602 },
45603 "UserReportsCreateOperation_Payload_Data_Relationships_ReportedResources_Data" : {
45604 "required" : [ "id", "type" ],
45605 "type" : "object",
45606 "properties" : {
45607 "id" : {
45608 "type" : "string"
45609 },
45610 "type" : {
45611 "type" : "string",
45612 "enum" : [ "tracks", "artists", "playlists" ]
45613 }
45614 }
45615 },
45616 "UserReports_Attributes" : {
45617 "required" : [ "description", "reason" ],
45618 "type" : "object",
45619 "properties" : {
45620 "description" : {
45621 "type" : "string",
45622 "description" : "Description"
45623 },
45624 "reason" : {
45625 "type" : "string",
45626 "description" : "Reason",
45627 "enum" : [ "SEXUAL_CONTENT_OR_NUDITY", "VIOLENT_OR_DANGEROUS_CONTENT", "HATEFUL_OR_ABUSIVE_CONTENT", "HARASSMENT", "PRIVACY_VIOLATION", "SCAMS_OR_FRAUD", "SPAM", "COPYRIGHT_INFRINGEMENT", "APPEAL", "UNKNOWN" ]
45628 }
45629 }
45630 },
45631 "UserReports_Create_Single_Resource_Data_Document" : {
45632 "required" : [ "data", "links" ],
45633 "type" : "object",
45634 "properties" : {
45635 "data" : {
45636 "$ref" : "#/components/schemas/UserReports_Resource_Object"
45637 },
45638 "links" : {
45639 "$ref" : "#/components/schemas/Links"
45640 }
45641 }
45642 },
45643 "UserReports_Resource_Object" : {
45644 "required" : [ "id", "type" ],
45645 "type" : "object",
45646 "properties" : {
45647 "attributes" : {
45648 "$ref" : "#/components/schemas/UserReports_Attributes"
45649 },
45650 "id" : {
45651 "type" : "string",
45652 "description" : "Resource id",
45653 "example" : "12345"
45654 },
45655 "type" : {
45656 "minLength" : 1,
45657 "type" : "string",
45658 "description" : "Resource type",
45659 "example" : "tracks"
45660 }
45661 }
45662 },
45663 "UserSubscriptionPriceChanges_Attributes" : {
45664 "required" : [ "currency", "currentPrice", "effectiveDate", "newPrice" ],
45665 "type" : "object",
45666 "properties" : {
45667 "currency" : {
45668 "type" : "string",
45669 "description" : "ISO 4217 currency code",
45670 "example" : "EUR"
45671 },
45672 "currentPrice" : {
45673 "type" : "string",
45674 "description" : "Price amount with max 2 decimal places",
45675 "example" : "9.99"
45676 },
45677 "effectiveDate" : {
45678 "type" : "string",
45679 "description" : "The date the new price takes effect",
45680 "format" : "date"
45681 },
45682 "newPrice" : {
45683 "type" : "string",
45684 "description" : "Price amount with max 2 decimal places",
45685 "example" : "9.99"
45686 }
45687 }
45688 },
45689 "UserSubscriptionPriceChanges_Multi_Resource_Data_Document" : {
45690 "required" : [ "data", "links" ],
45691 "type" : "object",
45692 "properties" : {
45693 "data" : {
45694 "type" : "array",
45695 "items" : {
45696 "$ref" : "#/components/schemas/UserSubscriptionPriceChanges_Resource_Object"
45697 }
45698 },
45699 "included" : {
45700 "$ref" : "#/components/schemas/Included"
45701 },
45702 "links" : {
45703 "$ref" : "#/components/schemas/Links"
45704 }
45705 }
45706 },
45707 "UserSubscriptionPriceChanges_Relationships" : {
45708 "properties" : {
45709 "decision" : {
45710 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
45711 }
45712 }
45713 },
45714 "UserSubscriptionPriceChanges_Resource_Object" : {
45715 "required" : [ "id", "type" ],
45716 "type" : "object",
45717 "properties" : {
45718 "attributes" : {
45719 "$ref" : "#/components/schemas/UserSubscriptionPriceChanges_Attributes"
45720 },
45721 "id" : {
45722 "type" : "string",
45723 "description" : "Resource id",
45724 "example" : "12345"
45725 },
45726 "relationships" : {
45727 "$ref" : "#/components/schemas/UserSubscriptionPriceChanges_Relationships"
45728 },
45729 "type" : {
45730 "minLength" : 1,
45731 "type" : "string",
45732 "description" : "Resource type",
45733 "example" : "tracks"
45734 }
45735 }
45736 },
45737 "UserSubscriptionPriceChanges_Single_Relationship_Data_Document" : {
45738 "required" : [ "links" ],
45739 "type" : "object",
45740 "properties" : {
45741 "data" : {
45742 "oneOf" : [ {
45743 "$ref" : "#/components/schemas/Resource_Identifier"
45744 }, {
45745 "type" : "object",
45746 "nullable" : true,
45747 "enum" : [ null ]
45748 } ]
45749 },
45750 "included" : {
45751 "$ref" : "#/components/schemas/Included"
45752 },
45753 "links" : {
45754 "$ref" : "#/components/schemas/Links"
45755 }
45756 }
45757 },
45758 "Users_Attributes" : {
45759 "required" : [ "country", "developerAccessTier", "username" ],
45760 "type" : "object",
45761 "properties" : {
45762 "country" : {
45763 "type" : "string",
45764 "description" : "ISO 3166-1 alpha-2 country code",
45765 "example" : "US"
45766 },
45767 "developerAccessTier" : {
45768 "type" : "string",
45769 "description" : "Developer access tier for this user.",
45770 "example" : "THIRD_PARTY",
45771 "enum" : [ "THIRD_PARTY", "THIRD_PARTY_PROD", "PARTNER", "INTERNAL" ]
45772 },
45773 "email" : {
45774 "type" : "string",
45775 "description" : "email address",
45776 "example" : "[email protected]"
45777 },
45778 "emailVerified" : {
45779 "type" : "boolean",
45780 "description" : "Is the email verified",
45781 "example" : true
45782 },
45783 "firstName" : {
45784 "type" : "string",
45785 "description" : "Users first name",
45786 "example" : "John"
45787 },
45788 "lastName" : {
45789 "type" : "string",
45790 "description" : "Users last name",
45791 "example" : "Rambo"
45792 },
45793 "nostrPublicKey" : {
45794 "type" : "string",
45795 "description" : "Users nostr public key",
45796 "example" : "e3fc3965800f9c729b483a2a7291f30e569fbf5ab91a6eef332f9e28a5e923dd"
45797 },
45798 "username" : {
45799 "type" : "string",
45800 "description" : "user name",
45801 "example" : "username"
45802 }
45803 }
45804 },
45805 "Users_Resource_Object" : {
45806 "required" : [ "id", "type" ],
45807 "type" : "object",
45808 "properties" : {
45809 "attributes" : {
45810 "$ref" : "#/components/schemas/Users_Attributes"
45811 },
45812 "id" : {
45813 "type" : "string",
45814 "description" : "Resource id",
45815 "example" : "12345"
45816 },
45817 "type" : {
45818 "minLength" : 1,
45819 "type" : "string",
45820 "description" : "Resource type",
45821 "example" : "tracks"
45822 }
45823 }
45824 },
45825 "Users_Single_Resource_Data_Document" : {
45826 "required" : [ "data", "links" ],
45827 "type" : "object",
45828 "properties" : {
45829 "data" : {
45830 "$ref" : "#/components/schemas/Users_Resource_Object"
45831 },
45832 "included" : {
45833 "$ref" : "#/components/schemas/Included"
45834 },
45835 "links" : {
45836 "$ref" : "#/components/schemas/Links"
45837 }
45838 }
45839 },
45840 "VideoManifestsReadById403ResponseBody" : {
45841 "required" : [ "errors" ],
45842 "type" : "object",
45843 "properties" : {
45844 "errors" : {
45845 "type" : "array",
45846 "items" : {
45847 "required" : [ "code", "status" ],
45848 "type" : "object",
45849 "properties" : {
45850 "code" : {
45851 "type" : "string",
45852 "example" : "CLIENT_NOT_ENTITLED",
45853 "enum" : [ "CLIENT_NOT_ENTITLED", "CONCURRENT_PLAYBACK", "GEO_RESTRICTED", "PREREQUISITE_MISSING", "PURCHASE_REQUIRED" ]
45854 },
45855 "detail" : {
45856 "type" : "string",
45857 "example" : "Required playback prerequisites are missing"
45858 },
45859 "status" : {
45860 "type" : "string",
45861 "example" : "403"
45862 }
45863 }
45864 }
45865 }
45866 }
45867 },
45868 "VideoManifestsReadById404ResponseBody" : {
45869 "required" : [ "errors" ],
45870 "type" : "object",
45871 "properties" : {
45872 "errors" : {
45873 "type" : "array",
45874 "items" : {
45875 "required" : [ "code", "status" ],
45876 "type" : "object",
45877 "properties" : {
45878 "code" : {
45879 "type" : "string",
45880 "example" : "CONTENT_NOT_FOUND",
45881 "enum" : [ "CONTENT_NOT_FOUND" ]
45882 },
45883 "detail" : {
45884 "type" : "string",
45885 "example" : "Content does not exist or is no longer available"
45886 },
45887 "status" : {
45888 "type" : "string",
45889 "example" : "404"
45890 }
45891 }
45892 }
45893 }
45894 }
45895 },
45896 "VideoManifests_Attributes" : {
45897 "type" : "object",
45898 "properties" : {
45899 "drmData" : {
45900 "$ref" : "#/components/schemas/DrmData"
45901 },
45902 "link" : {
45903 "$ref" : "#/components/schemas/Link_Object"
45904 },
45905 "previewReason" : {
45906 "type" : "string",
45907 "description" : "Why a preview is served instead of the full video",
45908 "enum" : [ "FULL_REQUIRES_SUBSCRIPTION", "FULL_REQUIRES_PURCHASE", "FULL_REQUIRES_HIGHER_ACCESS_TIER" ]
45909 },
45910 "videoPresentation" : {
45911 "type" : "string",
45912 "description" : "Video presentation",
45913 "enum" : [ "FULL", "PREVIEW" ]
45914 }
45915 }
45916 },
45917 "VideoManifests_Resource_Object" : {
45918 "required" : [ "id", "type" ],
45919 "type" : "object",
45920 "properties" : {
45921 "attributes" : {
45922 "$ref" : "#/components/schemas/VideoManifests_Attributes"
45923 },
45924 "id" : {
45925 "type" : "string",
45926 "description" : "Resource id",
45927 "example" : "12345"
45928 },
45929 "type" : {
45930 "minLength" : 1,
45931 "type" : "string",
45932 "description" : "Resource type",
45933 "example" : "tracks"
45934 }
45935 }
45936 },
45937 "VideoManifests_Single_Resource_Data_Document" : {
45938 "required" : [ "data", "links" ],
45939 "type" : "object",
45940 "properties" : {
45941 "data" : {
45942 "$ref" : "#/components/schemas/VideoManifests_Resource_Object"
45943 },
45944 "included" : {
45945 "$ref" : "#/components/schemas/Included"
45946 },
45947 "links" : {
45948 "$ref" : "#/components/schemas/Links"
45949 }
45950 }
45951 },
45952 "Videos_Albums_Multi_Relationship_Data_Document" : {
45953 "required" : [ "links" ],
45954 "type" : "object",
45955 "properties" : {
45956 "data" : {
45957 "type" : "array",
45958 "items" : {
45959 "$ref" : "#/components/schemas/Videos_Albums_Resource_Identifier"
45960 }
45961 },
45962 "included" : {
45963 "$ref" : "#/components/schemas/Included"
45964 },
45965 "links" : {
45966 "$ref" : "#/components/schemas/Links"
45967 }
45968 }
45969 },
45970 "Videos_Albums_Resource_Identifier" : {
45971 "required" : [ "id", "type" ],
45972 "type" : "object",
45973 "properties" : {
45974 "id" : {
45975 "type" : "string",
45976 "description" : "Resource id",
45977 "example" : "12345"
45978 },
45979 "meta" : {
45980 "$ref" : "#/components/schemas/Videos_Albums_Resource_Identifier_Meta"
45981 },
45982 "type" : {
45983 "type" : "string",
45984 "description" : "Resource type",
45985 "example" : "tracks"
45986 }
45987 }
45988 },
45989 "Videos_Albums_Resource_Identifier_Meta" : {
45990 "type" : "object",
45991 "properties" : {
45992 "replacement" : {
45993 "$ref" : "#/components/schemas/Replacement_Provenance"
45994 }
45995 }
45996 },
45997 "Videos_Attributes" : {
45998 "required" : [ "duration", "explicit", "isrc", "popularity", "title" ],
45999 "type" : "object",
46000 "properties" : {
46001 "availability" : {
46002 "type" : "array",
46003 "description" : "Available usage for this video. Deprecated: use 'usageRules' instead. This field will be removed in a future version.",
46004 "deprecated" : true,
46005 "items" : {
46006 "type" : "string",
46007 "deprecated" : true,
46008 "enum" : [ "STREAM", "DJ", "STEM" ]
46009 }
46010 },
46011 "copyright" : {
46012 "$ref" : "#/components/schemas/Copyright"
46013 },
46014 "duration" : {
46015 "type" : "string",
46016 "description" : "Duration (ISO 8601)",
46017 "example" : "PT2M58S"
46018 },
46019 "explicit" : {
46020 "type" : "boolean",
46021 "description" : "Explicit content",
46022 "example" : false
46023 },
46024 "externalLinks" : {
46025 "type" : "array",
46026 "description" : "Video links external to TIDAL API",
46027 "items" : {
46028 "$ref" : "#/components/schemas/External_Link"
46029 }
46030 },
46031 "isrc" : {
46032 "type" : "string",
46033 "description" : "International Standard Recording Code (ISRC)",
46034 "example" : "TIDAL2274"
46035 },
46036 "popularity" : {
46037 "type" : "number",
46038 "description" : "Popularity (0.0 - 1.0)",
46039 "format" : "double",
46040 "example" : 0.56
46041 },
46042 "releaseDate" : {
46043 "type" : "string",
46044 "description" : "Release date (ISO-8601)",
46045 "format" : "date",
46046 "example" : "2017-06-27"
46047 },
46048 "title" : {
46049 "type" : "string",
46050 "description" : "Video title",
46051 "example" : "Kill Jay Z"
46052 },
46053 "version" : {
46054 "type" : "string",
46055 "description" : "Video version, complements title",
46056 "example" : "original, mix etc"
46057 }
46058 }
46059 },
46060 "Videos_Multi_Relationship_Data_Document" : {
46061 "required" : [ "links" ],
46062 "type" : "object",
46063 "properties" : {
46064 "data" : {
46065 "type" : "array",
46066 "items" : {
46067 "$ref" : "#/components/schemas/Resource_Identifier"
46068 }
46069 },
46070 "included" : {
46071 "$ref" : "#/components/schemas/Included"
46072 },
46073 "links" : {
46074 "$ref" : "#/components/schemas/Links"
46075 }
46076 }
46077 },
46078 "Videos_Multi_Resource_Data_Document" : {
46079 "required" : [ "data", "links" ],
46080 "type" : "object",
46081 "properties" : {
46082 "data" : {
46083 "type" : "array",
46084 "items" : {
46085 "$ref" : "#/components/schemas/Videos_Resource_Object"
46086 }
46087 },
46088 "included" : {
46089 "$ref" : "#/components/schemas/Included"
46090 },
46091 "links" : {
46092 "$ref" : "#/components/schemas/Links"
46093 }
46094 }
46095 },
46096 "Videos_Relationships" : {
46097 "properties" : {
46098 "albums" : {
46099 "$ref" : "#/components/schemas/Videos_Albums_Multi_Relationship_Data_Document"
46100 },
46101 "artists" : {
46102 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
46103 },
46104 "credits" : {
46105 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
46106 },
46107 "providers" : {
46108 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
46109 },
46110 "replacement" : {
46111 "$ref" : "#/components/schemas/Videos_Replacement_Single_Relationship_Data_Document"
46112 },
46113 "similarVideos" : {
46114 "$ref" : "#/components/schemas/Videos_SimilarVideos_Multi_Relationship_Data_Document"
46115 },
46116 "suggestedVideos" : {
46117 "$ref" : "#/components/schemas/Videos_SuggestedVideos_Multi_Relationship_Data_Document"
46118 },
46119 "thumbnailArt" : {
46120 "$ref" : "#/components/schemas/Multi_Relationship_Data_Document"
46121 },
46122 "usageRules" : {
46123 "$ref" : "#/components/schemas/Single_Relationship_Data_Document"
46124 }
46125 }
46126 },
46127 "Videos_Replacement_Resource_Identifier" : {
46128 "required" : [ "id", "type" ],
46129 "type" : "object",
46130 "properties" : {
46131 "id" : {
46132 "type" : "string",
46133 "description" : "Resource id",
46134 "example" : "12345"
46135 },
46136 "meta" : {
46137 "$ref" : "#/components/schemas/Videos_Replacement_Resource_Identifier_Meta"
46138 },
46139 "type" : {
46140 "type" : "string",
46141 "description" : "Resource type",
46142 "example" : "tracks"
46143 }
46144 }
46145 },
46146 "Videos_Replacement_Resource_Identifier_Meta" : {
46147 "type" : "object",
46148 "properties" : {
46149 "replacement" : {
46150 "$ref" : "#/components/schemas/Replacement_Provenance"
46151 }
46152 }
46153 },
46154 "Videos_Replacement_Single_Relationship_Data_Document" : {
46155 "required" : [ "links" ],
46156 "type" : "object",
46157 "properties" : {
46158 "data" : {
46159 "oneOf" : [ {
46160 "$ref" : "#/components/schemas/Videos_Replacement_Resource_Identifier"
46161 }, {
46162 "type" : "object",
46163 "nullable" : true,
46164 "enum" : [ null ]
46165 } ]
46166 },
46167 "included" : {
46168 "$ref" : "#/components/schemas/Included"
46169 },
46170 "links" : {
46171 "$ref" : "#/components/schemas/Links"
46172 }
46173 }
46174 },
46175 "Videos_Resource_Object" : {
46176 "required" : [ "id", "type" ],
46177 "type" : "object",
46178 "properties" : {
46179 "attributes" : {
46180 "$ref" : "#/components/schemas/Videos_Attributes"
46181 },
46182 "id" : {
46183 "type" : "string",
46184 "description" : "Resource id",
46185 "example" : "12345"
46186 },
46187 "relationships" : {
46188 "$ref" : "#/components/schemas/Videos_Relationships"
46189 },
46190 "type" : {
46191 "minLength" : 1,
46192 "type" : "string",
46193 "description" : "Resource type",
46194 "example" : "tracks"
46195 }
46196 }
46197 },
46198 "Videos_SimilarVideos_Multi_Relationship_Data_Document" : {
46199 "required" : [ "links" ],
46200 "type" : "object",
46201 "properties" : {
46202 "data" : {
46203 "type" : "array",
46204 "items" : {
46205 "$ref" : "#/components/schemas/Videos_SimilarVideos_Resource_Identifier"
46206 }
46207 },
46208 "included" : {
46209 "$ref" : "#/components/schemas/Included"
46210 },
46211 "links" : {
46212 "$ref" : "#/components/schemas/Links"
46213 }
46214 }
46215 },
46216 "Videos_SimilarVideos_Resource_Identifier" : {
46217 "required" : [ "id", "type" ],
46218 "type" : "object",
46219 "properties" : {
46220 "id" : {
46221 "type" : "string",
46222 "description" : "Resource id",
46223 "example" : "12345"
46224 },
46225 "meta" : {
46226 "$ref" : "#/components/schemas/Videos_SimilarVideos_Resource_Identifier_Meta"
46227 },
46228 "type" : {
46229 "type" : "string",
46230 "description" : "Resource type",
46231 "example" : "tracks"
46232 }
46233 }
46234 },
46235 "Videos_SimilarVideos_Resource_Identifier_Meta" : {
46236 "type" : "object",
46237 "properties" : {
46238 "replacement" : {
46239 "$ref" : "#/components/schemas/Replacement_Provenance"
46240 }
46241 }
46242 },
46243 "Videos_Single_Relationship_Data_Document" : {
46244 "required" : [ "links" ],
46245 "type" : "object",
46246 "properties" : {
46247 "data" : {
46248 "oneOf" : [ {
46249 "$ref" : "#/components/schemas/Resource_Identifier"
46250 }, {
46251 "type" : "object",
46252 "nullable" : true,
46253 "enum" : [ null ]
46254 } ]
46255 },
46256 "included" : {
46257 "$ref" : "#/components/schemas/Included"
46258 },
46259 "links" : {
46260 "$ref" : "#/components/schemas/Links"
46261 }
46262 }
46263 },
46264 "Videos_Single_Resource_Data_Document" : {
46265 "required" : [ "data", "links" ],
46266 "type" : "object",
46267 "properties" : {
46268 "data" : {
46269 "$ref" : "#/components/schemas/Videos_Resource_Object"
46270 },
46271 "included" : {
46272 "$ref" : "#/components/schemas/Included"
46273 },
46274 "links" : {
46275 "$ref" : "#/components/schemas/Links"
46276 }
46277 }
46278 },
46279 "Videos_SuggestedVideos_Multi_Relationship_Data_Document" : {
46280 "required" : [ "links" ],
46281 "type" : "object",
46282 "properties" : {
46283 "data" : {
46284 "type" : "array",
46285 "items" : {
46286 "$ref" : "#/components/schemas/Videos_SuggestedVideos_Resource_Identifier"
46287 }
46288 },
46289 "included" : {
46290 "$ref" : "#/components/schemas/Included"
46291 },
46292 "links" : {
46293 "$ref" : "#/components/schemas/Links"
46294 }
46295 }
46296 },
46297 "Videos_SuggestedVideos_Resource_Identifier" : {
46298 "required" : [ "id", "type" ],
46299 "type" : "object",
46300 "properties" : {
46301 "id" : {
46302 "type" : "string",
46303 "description" : "Resource id",
46304 "example" : "12345"
46305 },
46306 "meta" : {
46307 "$ref" : "#/components/schemas/Videos_SuggestedVideos_Resource_Identifier_Meta"
46308 },
46309 "type" : {
46310 "type" : "string",
46311 "description" : "Resource type",
46312 "example" : "tracks"
46313 }
46314 }
46315 },
46316 "Videos_SuggestedVideos_Resource_Identifier_Meta" : {
46317 "type" : "object",
46318 "properties" : {
46319 "replacement" : {
46320 "$ref" : "#/components/schemas/Replacement_Provenance"
46321 }
46322 }
46323 }
46324 },
46325 "securitySchemes" : {
46326 "Authorization_Code_PKCE" : {
46327 "description" : "See https://developer.tidal.com/documentation/api-sdk/api-sdk-authorization",
46328 "flows" : {
46329 "authorizationCode" : {
46330 "authorizationUrl" : "https://login.tidal.com/authorize",
46331 "scopes" : {
46332 "collection.read" : "Read access to a user's \"My Collection\".",
46333 "collection.write" : "Write access to a user's \"My Collection\".",
46334 "entitlements.read" : "Read access to what functionality a user is entitled to access on TIDAL, such as whether they can stream music, use DJ add-ons and similar.",
46335 "playback" : "Required to play media content and control playback.",
46336 "playlists.read" : "Required to list playlists created by a user.",
46337 "playlists.write" : "Write access to a user's playlists.",
46338 "r_usr" : "Read access to all end user data",
46339 "recommendations.read" : "Read access to a userâs personal recommendations.",
46340 "search.read" : "Required to read personalized search results.",
46341 "search.write" : "Required to update personalized search results, e.g. delete search history.",
46342 "user.read" : "Read access to a user's account information, such as country and email address.",
46343 "w_usr" : "Write user"
46344 },
46345 "tokenUrl" : "https://auth.tidal.com/v1/oauth2/token",
46346 "x-scopes-required-access-tier" : {
46347 "collection.read" : "THIRD_PARTY",
46348 "collection.write" : "THIRD_PARTY",
46349 "entitlements.read" : "THIRD_PARTY",
46350 "playback" : "THIRD_PARTY",
46351 "playlists.read" : "THIRD_PARTY",
46352 "playlists.write" : "THIRD_PARTY",
46353 "r_usr" : "INTERNAL",
46354 "recommendations.read" : "THIRD_PARTY",
46355 "search.read" : "THIRD_PARTY",
46356 "search.write" : "THIRD_PARTY",
46357 "user.read" : "THIRD_PARTY",
46358 "w_usr" : "INTERNAL"
46359 }
46360 }
46361 },
46362 "type" : "oauth2"
46363 },
46364 "Client_Credentials" : {
46365 "description" : "See https://developer.tidal.com/documentation/api-sdk/api-sdk-authorization",
46366 "flows" : {
46367 "clientCredentials" : {
46368 "scopes" : { },
46369 "tokenUrl" : "https://auth.tidal.com/v1/oauth2/token"
46370 }
46371 },
46372 "type" : "oauth2"
46373 }
46374 }
46375 }
46376}
46377