@tidal-music/api 0.48.0 → 0.50.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/allAPI.generated.d.ts +1252 -287
- package/package.json +1 -1
|
@@ -22,12 +22,14 @@ export interface paths {
|
|
|
22
22
|
/** @description One of: DEVELOPER, UPLOAD_MARKETPLACE, MERCH_GUIDELINES, TIDAL_CONNECT_DEVELOPER (e.g. `DEVELOPER`) */
|
|
23
23
|
"filter[terms.termsType]": ("DEVELOPER" | "UPLOAD_MARKETPLACE" | "MERCH_GUIDELINES" | "TIDAL_CONNECT_DEVELOPER")[];
|
|
24
24
|
/**
|
|
25
|
-
* @description
|
|
25
|
+
* @description Include related resources. Available relationships: owners, terms
|
|
26
26
|
* @example terms
|
|
27
27
|
*/
|
|
28
28
|
include?: string[];
|
|
29
29
|
/** @description Filter by terms.isLatestVersion */
|
|
30
30
|
"filter[terms.isLatestVersion]"?: string[];
|
|
31
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
32
|
+
includeLinkage?: ("owners" | "terms")[];
|
|
31
33
|
};
|
|
32
34
|
header?: never;
|
|
33
35
|
path?: never;
|
|
@@ -117,7 +119,7 @@ export interface paths {
|
|
|
117
119
|
parameters: {
|
|
118
120
|
query?: {
|
|
119
121
|
/**
|
|
120
|
-
* @description
|
|
122
|
+
* @description Include related resources. Available relationships: owners
|
|
121
123
|
* @example owners
|
|
122
124
|
*/
|
|
123
125
|
include?: string[];
|
|
@@ -178,7 +180,7 @@ export interface paths {
|
|
|
178
180
|
parameters: {
|
|
179
181
|
query?: {
|
|
180
182
|
/**
|
|
181
|
-
* @description
|
|
183
|
+
* @description Include related resources. Available relationships: terms
|
|
182
184
|
* @example terms
|
|
183
185
|
*/
|
|
184
186
|
include?: string[];
|
|
@@ -241,8 +243,10 @@ export interface paths {
|
|
|
241
243
|
* @example US
|
|
242
244
|
*/
|
|
243
245
|
countryCode?: string;
|
|
244
|
-
/** @description
|
|
246
|
+
/** @description Include related resources. Available relationships: owners */
|
|
245
247
|
include?: string[];
|
|
248
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
249
|
+
includeLinkage?: "owners"[];
|
|
246
250
|
};
|
|
247
251
|
header?: never;
|
|
248
252
|
path: {
|
|
@@ -298,7 +302,7 @@ export interface paths {
|
|
|
298
302
|
parameters: {
|
|
299
303
|
query?: {
|
|
300
304
|
/**
|
|
301
|
-
* @description
|
|
305
|
+
* @description Include related resources. Available relationships: owners
|
|
302
306
|
* @example owners
|
|
303
307
|
*/
|
|
304
308
|
include?: string[];
|
|
@@ -368,7 +372,7 @@ export interface paths {
|
|
|
368
372
|
*/
|
|
369
373
|
countryCode?: string;
|
|
370
374
|
/**
|
|
371
|
-
* @description
|
|
375
|
+
* @description Include related resources. Available relationships: albumStatistics, artists, coverArt, genres, items, owners, priceConfig, providers, replacement, shares, similarAlbums, suggestedCoverArts, usageRules
|
|
372
376
|
* @example artists.albums
|
|
373
377
|
*/
|
|
374
378
|
include?: string[];
|
|
@@ -378,6 +382,8 @@ export interface paths {
|
|
|
378
382
|
"filter[id]"?: string[];
|
|
379
383
|
/** @description User id. Use `me` for the authenticated user */
|
|
380
384
|
"filter[owners.id]"?: string[];
|
|
385
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
386
|
+
includeLinkage?: ("albumStatistics" | "artists" | "coverArt" | "genres" | "items" | "owners" | "priceConfig" | "providers" | "replacement" | "shares" | "similarAlbums" | "suggestedCoverArts" | "usageRules")[];
|
|
381
387
|
/**
|
|
382
388
|
* @description 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
|
|
383
389
|
* @example artists.albums
|
|
@@ -479,10 +485,12 @@ export interface paths {
|
|
|
479
485
|
*/
|
|
480
486
|
countryCode?: string;
|
|
481
487
|
/**
|
|
482
|
-
* @description
|
|
488
|
+
* @description Include related resources. Available relationships: albumStatistics, artists, coverArt, genres, items, owners, priceConfig, providers, replacement, shares, similarAlbums, suggestedCoverArts, usageRules
|
|
483
489
|
* @example artists.albums
|
|
484
490
|
*/
|
|
485
491
|
include?: string[];
|
|
492
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
493
|
+
includeLinkage?: ("albumStatistics" | "artists" | "coverArt" | "genres" | "items" | "owners" | "priceConfig" | "providers" | "replacement" | "shares" | "similarAlbums" | "suggestedCoverArts" | "usageRules")[];
|
|
486
494
|
/**
|
|
487
495
|
* @description 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
|
|
488
496
|
* @example artists.albums
|
|
@@ -633,7 +641,7 @@ export interface paths {
|
|
|
633
641
|
parameters: {
|
|
634
642
|
query?: {
|
|
635
643
|
/**
|
|
636
|
-
* @description
|
|
644
|
+
* @description Include related resources. Available relationships: albumStatistics
|
|
637
645
|
* @example albumStatistics
|
|
638
646
|
*/
|
|
639
647
|
include?: string[];
|
|
@@ -701,7 +709,7 @@ export interface paths {
|
|
|
701
709
|
*/
|
|
702
710
|
countryCode?: string;
|
|
703
711
|
/**
|
|
704
|
-
* @description
|
|
712
|
+
* @description Include related resources. Available relationships: artists
|
|
705
713
|
* @example artists.albums
|
|
706
714
|
*/
|
|
707
715
|
include?: string[];
|
|
@@ -774,7 +782,7 @@ export interface paths {
|
|
|
774
782
|
*/
|
|
775
783
|
countryCode?: string;
|
|
776
784
|
/**
|
|
777
|
-
* @description
|
|
785
|
+
* @description Include related resources. Available relationships: coverArt
|
|
778
786
|
* @example coverArt
|
|
779
787
|
*/
|
|
780
788
|
include?: string[];
|
|
@@ -888,7 +896,7 @@ export interface paths {
|
|
|
888
896
|
*/
|
|
889
897
|
countryCode?: string;
|
|
890
898
|
/**
|
|
891
|
-
* @description
|
|
899
|
+
* @description Include related resources. Available relationships: genres
|
|
892
900
|
* @example genres
|
|
893
901
|
*/
|
|
894
902
|
include?: string[];
|
|
@@ -956,7 +964,7 @@ export interface paths {
|
|
|
956
964
|
*/
|
|
957
965
|
countryCode?: string;
|
|
958
966
|
/**
|
|
959
|
-
* @description
|
|
967
|
+
* @description Include related resources. Available relationships: items
|
|
960
968
|
* @example items
|
|
961
969
|
*/
|
|
962
970
|
include?: string[];
|
|
@@ -1068,7 +1076,7 @@ export interface paths {
|
|
|
1068
1076
|
parameters: {
|
|
1069
1077
|
query?: {
|
|
1070
1078
|
/**
|
|
1071
|
-
* @description
|
|
1079
|
+
* @description Include related resources. Available relationships: owners
|
|
1072
1080
|
* @example owners
|
|
1073
1081
|
*/
|
|
1074
1082
|
include?: string[];
|
|
@@ -1136,7 +1144,7 @@ export interface paths {
|
|
|
1136
1144
|
*/
|
|
1137
1145
|
countryCode?: string;
|
|
1138
1146
|
/**
|
|
1139
|
-
* @description
|
|
1147
|
+
* @description Include related resources. Available relationships: priceConfig
|
|
1140
1148
|
* @example priceConfig
|
|
1141
1149
|
*/
|
|
1142
1150
|
include?: string[];
|
|
@@ -1202,7 +1210,7 @@ export interface paths {
|
|
|
1202
1210
|
*/
|
|
1203
1211
|
countryCode?: string;
|
|
1204
1212
|
/**
|
|
1205
|
-
* @description
|
|
1213
|
+
* @description Include related resources. Available relationships: providers
|
|
1206
1214
|
* @example providers
|
|
1207
1215
|
*/
|
|
1208
1216
|
include?: string[];
|
|
@@ -1270,7 +1278,7 @@ export interface paths {
|
|
|
1270
1278
|
*/
|
|
1271
1279
|
countryCode?: string;
|
|
1272
1280
|
/**
|
|
1273
|
-
* @description
|
|
1281
|
+
* @description Include related resources. Available relationships: replacement
|
|
1274
1282
|
* @example replacement
|
|
1275
1283
|
*/
|
|
1276
1284
|
include?: string[];
|
|
@@ -1336,7 +1344,7 @@ export interface paths {
|
|
|
1336
1344
|
parameters: {
|
|
1337
1345
|
query?: {
|
|
1338
1346
|
/**
|
|
1339
|
-
* @description
|
|
1347
|
+
* @description Include related resources. Available relationships: shares
|
|
1340
1348
|
* @example shares.sharedResources
|
|
1341
1349
|
*/
|
|
1342
1350
|
include?: string[];
|
|
@@ -1411,7 +1419,7 @@ export interface paths {
|
|
|
1411
1419
|
*/
|
|
1412
1420
|
countryCode?: string;
|
|
1413
1421
|
/**
|
|
1414
|
-
* @description
|
|
1422
|
+
* @description Include related resources. Available relationships: similarAlbums
|
|
1415
1423
|
* @example similarAlbums
|
|
1416
1424
|
*/
|
|
1417
1425
|
include?: string[];
|
|
@@ -1477,7 +1485,7 @@ export interface paths {
|
|
|
1477
1485
|
parameters: {
|
|
1478
1486
|
query?: {
|
|
1479
1487
|
/**
|
|
1480
|
-
* @description
|
|
1488
|
+
* @description Include related resources. Available relationships: suggestedCoverArts
|
|
1481
1489
|
* @example suggestedCoverArts
|
|
1482
1490
|
*/
|
|
1483
1491
|
include?: string[];
|
|
@@ -1545,7 +1553,7 @@ export interface paths {
|
|
|
1545
1553
|
*/
|
|
1546
1554
|
countryCode?: string;
|
|
1547
1555
|
/**
|
|
1548
|
-
* @description
|
|
1556
|
+
* @description Include related resources. Available relationships: usageRules
|
|
1549
1557
|
* @example usageRules
|
|
1550
1558
|
*/
|
|
1551
1559
|
include?: string[];
|
|
@@ -1675,8 +1683,10 @@ export interface paths {
|
|
|
1675
1683
|
* @example US
|
|
1676
1684
|
*/
|
|
1677
1685
|
countryCode?: string;
|
|
1678
|
-
/** @description
|
|
1686
|
+
/** @description Include related resources. Available relationships: owners */
|
|
1679
1687
|
include?: string[];
|
|
1688
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
1689
|
+
includeLinkage?: "owners"[];
|
|
1680
1690
|
};
|
|
1681
1691
|
header?: never;
|
|
1682
1692
|
path: {
|
|
@@ -1778,7 +1788,7 @@ export interface paths {
|
|
|
1778
1788
|
parameters: {
|
|
1779
1789
|
query?: {
|
|
1780
1790
|
/**
|
|
1781
|
-
* @description
|
|
1791
|
+
* @description Include related resources. Available relationships: owners
|
|
1782
1792
|
* @example owners
|
|
1783
1793
|
*/
|
|
1784
1794
|
include?: string[];
|
|
@@ -1891,10 +1901,12 @@ export interface paths {
|
|
|
1891
1901
|
/** @description User id. Use `me` for the authenticated user */
|
|
1892
1902
|
"filter[owners.id]": string[];
|
|
1893
1903
|
/**
|
|
1894
|
-
* @description
|
|
1904
|
+
* @description Include related resources. Available relationships: acceptedArtists, owners, recommendedArtists
|
|
1895
1905
|
* @example acceptedArtists.albums
|
|
1896
1906
|
*/
|
|
1897
1907
|
include?: string[];
|
|
1908
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
1909
|
+
includeLinkage?: ("acceptedArtists" | "owners" | "recommendedArtists")[];
|
|
1898
1910
|
/**
|
|
1899
1911
|
* @description 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
|
|
1900
1912
|
* @example acceptedArtists.albums
|
|
@@ -1989,10 +2001,12 @@ export interface paths {
|
|
|
1989
2001
|
parameters: {
|
|
1990
2002
|
query?: {
|
|
1991
2003
|
/**
|
|
1992
|
-
* @description
|
|
2004
|
+
* @description Include related resources. Available relationships: acceptedArtists, owners, recommendedArtists
|
|
1993
2005
|
* @example acceptedArtists.albums
|
|
1994
2006
|
*/
|
|
1995
2007
|
include?: string[];
|
|
2008
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
2009
|
+
includeLinkage?: ("acceptedArtists" | "owners" | "recommendedArtists")[];
|
|
1996
2010
|
/**
|
|
1997
2011
|
* @description 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
|
|
1998
2012
|
* @example acceptedArtists.albums
|
|
@@ -2141,7 +2155,7 @@ export interface paths {
|
|
|
2141
2155
|
parameters: {
|
|
2142
2156
|
query?: {
|
|
2143
2157
|
/**
|
|
2144
|
-
* @description
|
|
2158
|
+
* @description Include related resources. Available relationships: acceptedArtists
|
|
2145
2159
|
* @example acceptedArtists.albums
|
|
2146
2160
|
*/
|
|
2147
2161
|
include?: string[];
|
|
@@ -2253,7 +2267,7 @@ export interface paths {
|
|
|
2253
2267
|
parameters: {
|
|
2254
2268
|
query?: {
|
|
2255
2269
|
/**
|
|
2256
|
-
* @description
|
|
2270
|
+
* @description Include related resources. Available relationships: owners
|
|
2257
2271
|
* @example owners
|
|
2258
2272
|
*/
|
|
2259
2273
|
include?: string[];
|
|
@@ -2314,7 +2328,7 @@ export interface paths {
|
|
|
2314
2328
|
parameters: {
|
|
2315
2329
|
query?: {
|
|
2316
2330
|
/**
|
|
2317
|
-
* @description
|
|
2331
|
+
* @description Include related resources. Available relationships: recommendedArtists
|
|
2318
2332
|
* @example recommendedArtists.albums
|
|
2319
2333
|
*/
|
|
2320
2334
|
include?: string[];
|
|
@@ -2438,7 +2452,7 @@ export interface paths {
|
|
|
2438
2452
|
*/
|
|
2439
2453
|
countryCode?: string;
|
|
2440
2454
|
/**
|
|
2441
|
-
* @description
|
|
2455
|
+
* @description Include related resources. Available relationships: albums, biography, claimStatus, followers, following, owners, profileArt, radio, roles, similarArtists, trackProviders, tracks, videos
|
|
2442
2456
|
* @example albums
|
|
2443
2457
|
*/
|
|
2444
2458
|
include?: string[];
|
|
@@ -2448,6 +2462,8 @@ export interface paths {
|
|
|
2448
2462
|
"filter[id]"?: string[];
|
|
2449
2463
|
/** @description User id. Use `me` for the authenticated user */
|
|
2450
2464
|
"filter[owners.id]"?: string[];
|
|
2465
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
2466
|
+
includeLinkage?: ("albums" | "biography" | "claimStatus" | "followers" | "following" | "owners" | "profileArt" | "radio" | "roles" | "similarArtists" | "trackProviders" | "tracks" | "videos")[];
|
|
2451
2467
|
/**
|
|
2452
2468
|
* @description 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
|
|
2453
2469
|
* @example albums
|
|
@@ -2556,10 +2572,12 @@ export interface paths {
|
|
|
2556
2572
|
*/
|
|
2557
2573
|
countryCode?: string;
|
|
2558
2574
|
/**
|
|
2559
|
-
* @description
|
|
2575
|
+
* @description Include related resources. Available relationships: albums, biography, claimStatus, followers, following, owners, profileArt, radio, roles, similarArtists, trackProviders, tracks, videos
|
|
2560
2576
|
* @example albums
|
|
2561
2577
|
*/
|
|
2562
2578
|
include?: string[];
|
|
2579
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
2580
|
+
includeLinkage?: ("albums" | "biography" | "claimStatus" | "followers" | "following" | "owners" | "profileArt" | "radio" | "roles" | "similarArtists" | "trackProviders" | "tracks" | "videos")[];
|
|
2563
2581
|
/**
|
|
2564
2582
|
* @description 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
|
|
2565
2583
|
* @example albums
|
|
@@ -2673,7 +2691,7 @@ export interface paths {
|
|
|
2673
2691
|
*/
|
|
2674
2692
|
countryCode?: string;
|
|
2675
2693
|
/**
|
|
2676
|
-
* @description
|
|
2694
|
+
* @description Include related resources. Available relationships: albums
|
|
2677
2695
|
* @example albums
|
|
2678
2696
|
*/
|
|
2679
2697
|
include?: string[];
|
|
@@ -2742,7 +2760,7 @@ export interface paths {
|
|
|
2742
2760
|
*/
|
|
2743
2761
|
countryCode?: string;
|
|
2744
2762
|
/**
|
|
2745
|
-
* @description
|
|
2763
|
+
* @description Include related resources. Available relationships: biography
|
|
2746
2764
|
* @example biography
|
|
2747
2765
|
*/
|
|
2748
2766
|
include?: string[];
|
|
@@ -2801,7 +2819,7 @@ export interface paths {
|
|
|
2801
2819
|
parameters: {
|
|
2802
2820
|
query?: {
|
|
2803
2821
|
/**
|
|
2804
|
-
* @description
|
|
2822
|
+
* @description Include related resources. Available relationships: claimStatus
|
|
2805
2823
|
* @example claimStatus
|
|
2806
2824
|
*/
|
|
2807
2825
|
include?: string[];
|
|
@@ -2863,7 +2881,7 @@ export interface paths {
|
|
|
2863
2881
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
2864
2882
|
"page[cursor]"?: string;
|
|
2865
2883
|
/**
|
|
2866
|
-
* @description
|
|
2884
|
+
* @description Include related resources. Available relationships: followers
|
|
2867
2885
|
* @example followers.albums
|
|
2868
2886
|
*/
|
|
2869
2887
|
include?: string[];
|
|
@@ -2930,7 +2948,7 @@ export interface paths {
|
|
|
2930
2948
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
2931
2949
|
"page[cursor]"?: string;
|
|
2932
2950
|
/**
|
|
2933
|
-
* @description
|
|
2951
|
+
* @description Include related resources. Available relationships: following
|
|
2934
2952
|
* @example following.albums
|
|
2935
2953
|
*/
|
|
2936
2954
|
include?: string[];
|
|
@@ -3086,7 +3104,7 @@ export interface paths {
|
|
|
3086
3104
|
parameters: {
|
|
3087
3105
|
query?: {
|
|
3088
3106
|
/**
|
|
3089
|
-
* @description
|
|
3107
|
+
* @description Include related resources. Available relationships: owners
|
|
3090
3108
|
* @example owners
|
|
3091
3109
|
*/
|
|
3092
3110
|
include?: string[];
|
|
@@ -3152,7 +3170,7 @@ export interface paths {
|
|
|
3152
3170
|
*/
|
|
3153
3171
|
countryCode?: string;
|
|
3154
3172
|
/**
|
|
3155
|
-
* @description
|
|
3173
|
+
* @description Include related resources. Available relationships: profileArt
|
|
3156
3174
|
* @example profileArt
|
|
3157
3175
|
*/
|
|
3158
3176
|
include?: string[];
|
|
@@ -3266,7 +3284,7 @@ export interface paths {
|
|
|
3266
3284
|
*/
|
|
3267
3285
|
countryCode?: string;
|
|
3268
3286
|
/**
|
|
3269
|
-
* @description
|
|
3287
|
+
* @description Include related resources. Available relationships: radio
|
|
3270
3288
|
* @example radio.items
|
|
3271
3289
|
*/
|
|
3272
3290
|
include?: string[];
|
|
@@ -3330,7 +3348,7 @@ export interface paths {
|
|
|
3330
3348
|
parameters: {
|
|
3331
3349
|
query?: {
|
|
3332
3350
|
/**
|
|
3333
|
-
* @description
|
|
3351
|
+
* @description Include related resources. Available relationships: roles
|
|
3334
3352
|
* @example roles
|
|
3335
3353
|
*/
|
|
3336
3354
|
include?: string[];
|
|
@@ -3398,7 +3416,7 @@ export interface paths {
|
|
|
3398
3416
|
*/
|
|
3399
3417
|
countryCode?: string;
|
|
3400
3418
|
/**
|
|
3401
|
-
* @description
|
|
3419
|
+
* @description Include related resources. Available relationships: similarArtists
|
|
3402
3420
|
* @example similarArtists.albums
|
|
3403
3421
|
*/
|
|
3404
3422
|
include?: string[];
|
|
@@ -3464,7 +3482,7 @@ export interface paths {
|
|
|
3464
3482
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
3465
3483
|
"page[cursor]"?: string;
|
|
3466
3484
|
/**
|
|
3467
|
-
* @description
|
|
3485
|
+
* @description Include related resources. Available relationships: trackProviders
|
|
3468
3486
|
* @example trackProviders
|
|
3469
3487
|
*/
|
|
3470
3488
|
include?: string[];
|
|
@@ -3535,7 +3553,7 @@ export interface paths {
|
|
|
3535
3553
|
*/
|
|
3536
3554
|
countryCode?: string;
|
|
3537
3555
|
/**
|
|
3538
|
-
* @description
|
|
3556
|
+
* @description Include related resources. Available relationships: tracks
|
|
3539
3557
|
* @example tracks
|
|
3540
3558
|
*/
|
|
3541
3559
|
include?: string[];
|
|
@@ -3606,7 +3624,7 @@ export interface paths {
|
|
|
3606
3624
|
*/
|
|
3607
3625
|
countryCode?: string;
|
|
3608
3626
|
/**
|
|
3609
|
-
* @description
|
|
3627
|
+
* @description Include related resources. Available relationships: videos
|
|
3610
3628
|
* @example videos
|
|
3611
3629
|
*/
|
|
3612
3630
|
include?: string[];
|
|
@@ -3676,8 +3694,10 @@ export interface paths {
|
|
|
3676
3694
|
* @example US
|
|
3677
3695
|
*/
|
|
3678
3696
|
countryCode?: string;
|
|
3679
|
-
/** @description
|
|
3697
|
+
/** @description Include related resources. Available relationships: owners */
|
|
3680
3698
|
include?: string[];
|
|
3699
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
3700
|
+
includeLinkage?: "owners"[];
|
|
3681
3701
|
};
|
|
3682
3702
|
header?: never;
|
|
3683
3703
|
path?: never;
|
|
@@ -3771,8 +3791,10 @@ export interface paths {
|
|
|
3771
3791
|
* @example US
|
|
3772
3792
|
*/
|
|
3773
3793
|
countryCode?: string;
|
|
3774
|
-
/** @description
|
|
3794
|
+
/** @description Include related resources. Available relationships: owners */
|
|
3775
3795
|
include?: string[];
|
|
3796
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
3797
|
+
includeLinkage?: "owners"[];
|
|
3776
3798
|
};
|
|
3777
3799
|
header?: never;
|
|
3778
3800
|
path: {
|
|
@@ -3828,7 +3850,7 @@ export interface paths {
|
|
|
3828
3850
|
parameters: {
|
|
3829
3851
|
query?: {
|
|
3830
3852
|
/**
|
|
3831
|
-
* @description
|
|
3853
|
+
* @description Include related resources. Available relationships: owners
|
|
3832
3854
|
* @example owners
|
|
3833
3855
|
*/
|
|
3834
3856
|
include?: string[];
|
|
@@ -3874,6 +3896,181 @@ export interface paths {
|
|
|
3874
3896
|
patch?: never;
|
|
3875
3897
|
trace?: never;
|
|
3876
3898
|
};
|
|
3899
|
+
"/clientCertificates": {
|
|
3900
|
+
parameters: {
|
|
3901
|
+
query?: never;
|
|
3902
|
+
header?: never;
|
|
3903
|
+
path?: never;
|
|
3904
|
+
cookie?: never;
|
|
3905
|
+
};
|
|
3906
|
+
get?: never;
|
|
3907
|
+
put?: never;
|
|
3908
|
+
/**
|
|
3909
|
+
* Create single clientCertificate.
|
|
3910
|
+
* @description Creates a new clientCertificate.
|
|
3911
|
+
*/
|
|
3912
|
+
post: {
|
|
3913
|
+
parameters: {
|
|
3914
|
+
query?: never;
|
|
3915
|
+
header?: {
|
|
3916
|
+
/** @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. */
|
|
3917
|
+
"Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
|
|
3918
|
+
};
|
|
3919
|
+
path?: never;
|
|
3920
|
+
cookie?: never;
|
|
3921
|
+
};
|
|
3922
|
+
requestBody?: {
|
|
3923
|
+
content: {
|
|
3924
|
+
"application/vnd.api+json": components["schemas"]["ClientCertificatesCreateOperation_Payload"];
|
|
3925
|
+
};
|
|
3926
|
+
};
|
|
3927
|
+
responses: {
|
|
3928
|
+
/** @description Successful response */
|
|
3929
|
+
201: {
|
|
3930
|
+
headers: {
|
|
3931
|
+
[name: string]: unknown;
|
|
3932
|
+
};
|
|
3933
|
+
content: {
|
|
3934
|
+
"application/vnd.api+json": components["schemas"]["ClientCertificates_Create_Single_Resource_Data_Document"];
|
|
3935
|
+
};
|
|
3936
|
+
};
|
|
3937
|
+
400: components["responses"]["Default400Response"];
|
|
3938
|
+
404: components["responses"]["Default404Response"];
|
|
3939
|
+
405: components["responses"]["Default405Response"];
|
|
3940
|
+
406: components["responses"]["Default406Response"];
|
|
3941
|
+
409: components["responses"]["Idempotency409Response"];
|
|
3942
|
+
415: components["responses"]["Default415Response"];
|
|
3943
|
+
422: components["responses"]["Idempotency422Response"];
|
|
3944
|
+
429: components["responses"]["Default429Response"];
|
|
3945
|
+
500: components["responses"]["Default500Response"];
|
|
3946
|
+
503: components["responses"]["Default503Response"];
|
|
3947
|
+
};
|
|
3948
|
+
};
|
|
3949
|
+
delete?: never;
|
|
3950
|
+
options?: never;
|
|
3951
|
+
head?: never;
|
|
3952
|
+
patch?: never;
|
|
3953
|
+
trace?: never;
|
|
3954
|
+
};
|
|
3955
|
+
"/clientCertificates/{id}": {
|
|
3956
|
+
parameters: {
|
|
3957
|
+
query?: never;
|
|
3958
|
+
header?: never;
|
|
3959
|
+
path?: never;
|
|
3960
|
+
cookie?: never;
|
|
3961
|
+
};
|
|
3962
|
+
/**
|
|
3963
|
+
* Get single clientCertificate.
|
|
3964
|
+
* @description Retrieves single clientCertificate by id.
|
|
3965
|
+
*/
|
|
3966
|
+
get: {
|
|
3967
|
+
parameters: {
|
|
3968
|
+
query?: {
|
|
3969
|
+
/** @description Include related resources. Available relationships: owners */
|
|
3970
|
+
include?: string[];
|
|
3971
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
3972
|
+
includeLinkage?: "owners"[];
|
|
3973
|
+
};
|
|
3974
|
+
header?: never;
|
|
3975
|
+
path: {
|
|
3976
|
+
/**
|
|
3977
|
+
* @description TIDAL Connect client certificate identifier
|
|
3978
|
+
* @example 0cb39ea1-1d2d-4f56-b5cf-195b34b2a727
|
|
3979
|
+
*/
|
|
3980
|
+
id: string;
|
|
3981
|
+
};
|
|
3982
|
+
cookie?: never;
|
|
3983
|
+
};
|
|
3984
|
+
requestBody?: never;
|
|
3985
|
+
responses: {
|
|
3986
|
+
/** @description Successful response */
|
|
3987
|
+
200: {
|
|
3988
|
+
headers: {
|
|
3989
|
+
[name: string]: unknown;
|
|
3990
|
+
};
|
|
3991
|
+
content: {
|
|
3992
|
+
"application/vnd.api+json": components["schemas"]["ClientCertificates_Single_Resource_Data_Document"];
|
|
3993
|
+
};
|
|
3994
|
+
};
|
|
3995
|
+
400: components["responses"]["Default400Response"];
|
|
3996
|
+
404: components["responses"]["Default404Response"];
|
|
3997
|
+
405: components["responses"]["Default405Response"];
|
|
3998
|
+
406: components["responses"]["Default406Response"];
|
|
3999
|
+
415: components["responses"]["Default415Response"];
|
|
4000
|
+
429: components["responses"]["Default429Response"];
|
|
4001
|
+
500: components["responses"]["Default500Response"];
|
|
4002
|
+
503: components["responses"]["Default503Response"];
|
|
4003
|
+
};
|
|
4004
|
+
};
|
|
4005
|
+
put?: never;
|
|
4006
|
+
post?: never;
|
|
4007
|
+
delete?: never;
|
|
4008
|
+
options?: never;
|
|
4009
|
+
head?: never;
|
|
4010
|
+
patch?: never;
|
|
4011
|
+
trace?: never;
|
|
4012
|
+
};
|
|
4013
|
+
"/clientCertificates/{id}/relationships/owners": {
|
|
4014
|
+
parameters: {
|
|
4015
|
+
query?: never;
|
|
4016
|
+
header?: never;
|
|
4017
|
+
path?: never;
|
|
4018
|
+
cookie?: never;
|
|
4019
|
+
};
|
|
4020
|
+
/**
|
|
4021
|
+
* Get owners relationship ("to-many").
|
|
4022
|
+
* @description Retrieves owners relationship.
|
|
4023
|
+
*/
|
|
4024
|
+
get: {
|
|
4025
|
+
parameters: {
|
|
4026
|
+
query?: {
|
|
4027
|
+
/**
|
|
4028
|
+
* @description Include related resources. Available relationships: owners
|
|
4029
|
+
* @example owners
|
|
4030
|
+
*/
|
|
4031
|
+
include?: string[];
|
|
4032
|
+
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
4033
|
+
"page[cursor]"?: string;
|
|
4034
|
+
};
|
|
4035
|
+
header?: never;
|
|
4036
|
+
path: {
|
|
4037
|
+
/**
|
|
4038
|
+
* @description TIDAL Connect client certificate identifier
|
|
4039
|
+
* @example 0cb39ea1-1d2d-4f56-b5cf-195b34b2a727
|
|
4040
|
+
*/
|
|
4041
|
+
id: string;
|
|
4042
|
+
};
|
|
4043
|
+
cookie?: never;
|
|
4044
|
+
};
|
|
4045
|
+
requestBody?: never;
|
|
4046
|
+
responses: {
|
|
4047
|
+
/** @description Successful response */
|
|
4048
|
+
200: {
|
|
4049
|
+
headers: {
|
|
4050
|
+
[name: string]: unknown;
|
|
4051
|
+
};
|
|
4052
|
+
content: {
|
|
4053
|
+
"application/vnd.api+json": components["schemas"]["ClientCertificates_Owners_Multi_Relationship_Data_Document"];
|
|
4054
|
+
};
|
|
4055
|
+
};
|
|
4056
|
+
400: components["responses"]["Default400Response"];
|
|
4057
|
+
404: components["responses"]["Default404Response"];
|
|
4058
|
+
405: components["responses"]["Default405Response"];
|
|
4059
|
+
406: components["responses"]["Default406Response"];
|
|
4060
|
+
415: components["responses"]["Default415Response"];
|
|
4061
|
+
429: components["responses"]["Default429Response"];
|
|
4062
|
+
500: components["responses"]["Default500Response"];
|
|
4063
|
+
503: components["responses"]["Default503Response"];
|
|
4064
|
+
};
|
|
4065
|
+
};
|
|
4066
|
+
put?: never;
|
|
4067
|
+
post?: never;
|
|
4068
|
+
delete?: never;
|
|
4069
|
+
options?: never;
|
|
4070
|
+
head?: never;
|
|
4071
|
+
patch?: never;
|
|
4072
|
+
trace?: never;
|
|
4073
|
+
};
|
|
3877
4074
|
"/clients": {
|
|
3878
4075
|
parameters: {
|
|
3879
4076
|
query?: never;
|
|
@@ -3890,8 +4087,13 @@ export interface paths {
|
|
|
3890
4087
|
query: {
|
|
3891
4088
|
/** @description User id. Use `me` for the authenticated user */
|
|
3892
4089
|
"filter[owners.id]": string[];
|
|
3893
|
-
/**
|
|
4090
|
+
/**
|
|
4091
|
+
* @description Include related resources. Available relationships: certificates, owners
|
|
4092
|
+
* @example certificates
|
|
4093
|
+
*/
|
|
3894
4094
|
include?: string[];
|
|
4095
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
4096
|
+
includeLinkage?: ("certificates" | "owners")[];
|
|
3895
4097
|
};
|
|
3896
4098
|
header?: never;
|
|
3897
4099
|
path?: never;
|
|
@@ -3980,8 +4182,13 @@ export interface paths {
|
|
|
3980
4182
|
get: {
|
|
3981
4183
|
parameters: {
|
|
3982
4184
|
query?: {
|
|
3983
|
-
/**
|
|
4185
|
+
/**
|
|
4186
|
+
* @description Include related resources. Available relationships: certificates, owners
|
|
4187
|
+
* @example certificates
|
|
4188
|
+
*/
|
|
3984
4189
|
include?: string[];
|
|
4190
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
4191
|
+
includeLinkage?: ("certificates" | "owners")[];
|
|
3985
4192
|
};
|
|
3986
4193
|
header?: never;
|
|
3987
4194
|
path: {
|
|
@@ -4110,6 +4317,67 @@ export interface paths {
|
|
|
4110
4317
|
};
|
|
4111
4318
|
trace?: never;
|
|
4112
4319
|
};
|
|
4320
|
+
"/clients/{id}/relationships/certificates": {
|
|
4321
|
+
parameters: {
|
|
4322
|
+
query?: never;
|
|
4323
|
+
header?: never;
|
|
4324
|
+
path?: never;
|
|
4325
|
+
cookie?: never;
|
|
4326
|
+
};
|
|
4327
|
+
/**
|
|
4328
|
+
* Get certificates relationship ("to-many").
|
|
4329
|
+
* @description Retrieves certificates relationship.
|
|
4330
|
+
*/
|
|
4331
|
+
get: {
|
|
4332
|
+
parameters: {
|
|
4333
|
+
query?: {
|
|
4334
|
+
/**
|
|
4335
|
+
* @description Include related resources. Available relationships: certificates
|
|
4336
|
+
* @example certificates
|
|
4337
|
+
*/
|
|
4338
|
+
include?: string[];
|
|
4339
|
+
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
4340
|
+
"page[cursor]"?: string;
|
|
4341
|
+
};
|
|
4342
|
+
header?: never;
|
|
4343
|
+
path: {
|
|
4344
|
+
/**
|
|
4345
|
+
* @description OAuth client identifier
|
|
4346
|
+
* @example a468bee88def
|
|
4347
|
+
*/
|
|
4348
|
+
id: string;
|
|
4349
|
+
};
|
|
4350
|
+
cookie?: never;
|
|
4351
|
+
};
|
|
4352
|
+
requestBody?: never;
|
|
4353
|
+
responses: {
|
|
4354
|
+
/** @description Successful response */
|
|
4355
|
+
200: {
|
|
4356
|
+
headers: {
|
|
4357
|
+
[name: string]: unknown;
|
|
4358
|
+
};
|
|
4359
|
+
content: {
|
|
4360
|
+
"application/vnd.api+json": components["schemas"]["Clients_Certificates_Multi_Relationship_Data_Document"];
|
|
4361
|
+
};
|
|
4362
|
+
};
|
|
4363
|
+
400: components["responses"]["Default400Response"];
|
|
4364
|
+
404: components["responses"]["Default404Response"];
|
|
4365
|
+
405: components["responses"]["Default405Response"];
|
|
4366
|
+
406: components["responses"]["Default406Response"];
|
|
4367
|
+
415: components["responses"]["Default415Response"];
|
|
4368
|
+
429: components["responses"]["Default429Response"];
|
|
4369
|
+
500: components["responses"]["Default500Response"];
|
|
4370
|
+
503: components["responses"]["Default503Response"];
|
|
4371
|
+
};
|
|
4372
|
+
};
|
|
4373
|
+
put?: never;
|
|
4374
|
+
post?: never;
|
|
4375
|
+
delete?: never;
|
|
4376
|
+
options?: never;
|
|
4377
|
+
head?: never;
|
|
4378
|
+
patch?: never;
|
|
4379
|
+
trace?: never;
|
|
4380
|
+
};
|
|
4113
4381
|
"/clients/{id}/relationships/owners": {
|
|
4114
4382
|
parameters: {
|
|
4115
4383
|
query?: never;
|
|
@@ -4125,7 +4393,7 @@ export interface paths {
|
|
|
4125
4393
|
parameters: {
|
|
4126
4394
|
query?: {
|
|
4127
4395
|
/**
|
|
4128
|
-
* @description
|
|
4396
|
+
* @description Include related resources. Available relationships: owners
|
|
4129
4397
|
* @example owners
|
|
4130
4398
|
*/
|
|
4131
4399
|
include?: string[];
|
|
@@ -4244,10 +4512,12 @@ export interface paths {
|
|
|
4244
4512
|
/** @description Invite code */
|
|
4245
4513
|
"filter[code]": string[];
|
|
4246
4514
|
/**
|
|
4247
|
-
* @description
|
|
4515
|
+
* @description Include related resources. Available relationships: owners, subject
|
|
4248
4516
|
* @example subject.items
|
|
4249
4517
|
*/
|
|
4250
4518
|
include?: string[];
|
|
4519
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
4520
|
+
includeLinkage?: ("owners" | "subject")[];
|
|
4251
4521
|
/**
|
|
4252
4522
|
* @description 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
|
|
4253
4523
|
* @example subject.items
|
|
@@ -4342,10 +4612,12 @@ export interface paths {
|
|
|
4342
4612
|
parameters: {
|
|
4343
4613
|
query?: {
|
|
4344
4614
|
/**
|
|
4345
|
-
* @description
|
|
4615
|
+
* @description Include related resources. Available relationships: owners, subject
|
|
4346
4616
|
* @example subject.items
|
|
4347
4617
|
*/
|
|
4348
4618
|
include?: string[];
|
|
4619
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
4620
|
+
includeLinkage?: ("owners" | "subject")[];
|
|
4349
4621
|
/**
|
|
4350
4622
|
* @description 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
|
|
4351
4623
|
* @example subject.items
|
|
@@ -4448,7 +4720,7 @@ export interface paths {
|
|
|
4448
4720
|
parameters: {
|
|
4449
4721
|
query?: {
|
|
4450
4722
|
/**
|
|
4451
|
-
* @description
|
|
4723
|
+
* @description Include related resources. Available relationships: owners
|
|
4452
4724
|
* @example owners
|
|
4453
4725
|
*/
|
|
4454
4726
|
include?: string[];
|
|
@@ -4509,7 +4781,7 @@ export interface paths {
|
|
|
4509
4781
|
parameters: {
|
|
4510
4782
|
query?: {
|
|
4511
4783
|
/**
|
|
4512
|
-
* @description
|
|
4784
|
+
* @description Include related resources. Available relationships: subject
|
|
4513
4785
|
* @example subject.items
|
|
4514
4786
|
*/
|
|
4515
4787
|
include?: string[];
|
|
@@ -4577,7 +4849,7 @@ export interface paths {
|
|
|
4577
4849
|
/** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */
|
|
4578
4850
|
sort?: ("createdAt" | "-createdAt" | "likeCount" | "-likeCount" | "replyCount" | "-replyCount" | "startTime" | "-startTime")[];
|
|
4579
4851
|
/**
|
|
4580
|
-
* @description
|
|
4852
|
+
* @description Include related resources. Available relationships: author, owners, parentComment
|
|
4581
4853
|
* @example author.albums
|
|
4582
4854
|
*/
|
|
4583
4855
|
include?: string[];
|
|
@@ -4595,6 +4867,8 @@ export interface paths {
|
|
|
4595
4867
|
* @description Deprecated: use filter[subject]. Filter by subject resource type (e.g. `albums`)
|
|
4596
4868
|
*/
|
|
4597
4869
|
"filter[subject.type]"?: ("albums" | "tracks" | "trackSourceFiles")[];
|
|
4870
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
4871
|
+
includeLinkage?: ("author" | "owners" | "parentComment")[];
|
|
4598
4872
|
/**
|
|
4599
4873
|
* @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: author.albums
|
|
4600
4874
|
* @example author.albums
|
|
@@ -4689,10 +4963,12 @@ export interface paths {
|
|
|
4689
4963
|
parameters: {
|
|
4690
4964
|
query?: {
|
|
4691
4965
|
/**
|
|
4692
|
-
* @description
|
|
4966
|
+
* @description Include related resources. Available relationships: author, owners, parentComment
|
|
4693
4967
|
* @example author.albums
|
|
4694
4968
|
*/
|
|
4695
4969
|
include?: string[];
|
|
4970
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
4971
|
+
includeLinkage?: ("author" | "owners" | "parentComment")[];
|
|
4696
4972
|
/**
|
|
4697
4973
|
* @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: author.albums
|
|
4698
4974
|
* @example author.albums
|
|
@@ -4841,7 +5117,7 @@ export interface paths {
|
|
|
4841
5117
|
parameters: {
|
|
4842
5118
|
query?: {
|
|
4843
5119
|
/**
|
|
4844
|
-
* @description
|
|
5120
|
+
* @description Include related resources. Available relationships: author
|
|
4845
5121
|
* @example author.albums
|
|
4846
5122
|
*/
|
|
4847
5123
|
include?: string[];
|
|
@@ -4905,7 +5181,7 @@ export interface paths {
|
|
|
4905
5181
|
parameters: {
|
|
4906
5182
|
query?: {
|
|
4907
5183
|
/**
|
|
4908
|
-
* @description
|
|
5184
|
+
* @description Include related resources. Available relationships: owners
|
|
4909
5185
|
* @example owners
|
|
4910
5186
|
*/
|
|
4911
5187
|
include?: string[];
|
|
@@ -4966,7 +5242,7 @@ export interface paths {
|
|
|
4966
5242
|
parameters: {
|
|
4967
5243
|
query?: {
|
|
4968
5244
|
/**
|
|
4969
|
-
* @description
|
|
5245
|
+
* @description Include related resources. Available relationships: parentComment
|
|
4970
5246
|
* @example parentComment.author.albums
|
|
4971
5247
|
*/
|
|
4972
5248
|
include?: string[];
|
|
@@ -5032,10 +5308,12 @@ export interface paths {
|
|
|
5032
5308
|
/** @description User id. Use `me` for the authenticated user */
|
|
5033
5309
|
"filter[owners.id]": string[];
|
|
5034
5310
|
/**
|
|
5035
|
-
* @description
|
|
5311
|
+
* @description Include related resources. Available relationships: claimedResource, claimingArtist, owners
|
|
5036
5312
|
* @example claimedResource
|
|
5037
5313
|
*/
|
|
5038
5314
|
include?: string[];
|
|
5315
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
5316
|
+
includeLinkage?: ("claimedResource" | "claimingArtist" | "owners")[];
|
|
5039
5317
|
/**
|
|
5040
5318
|
* @description 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
|
|
5041
5319
|
* @example claimedResource
|
|
@@ -5130,10 +5408,12 @@ export interface paths {
|
|
|
5130
5408
|
parameters: {
|
|
5131
5409
|
query?: {
|
|
5132
5410
|
/**
|
|
5133
|
-
* @description
|
|
5411
|
+
* @description Include related resources. Available relationships: claimedResource, claimingArtist, owners
|
|
5134
5412
|
* @example claimedResource
|
|
5135
5413
|
*/
|
|
5136
5414
|
include?: string[];
|
|
5415
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
5416
|
+
includeLinkage?: ("claimedResource" | "claimingArtist" | "owners")[];
|
|
5137
5417
|
/**
|
|
5138
5418
|
* @description 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
|
|
5139
5419
|
* @example claimedResource
|
|
@@ -5194,7 +5474,7 @@ export interface paths {
|
|
|
5194
5474
|
parameters: {
|
|
5195
5475
|
query?: {
|
|
5196
5476
|
/**
|
|
5197
|
-
* @description
|
|
5477
|
+
* @description Include related resources. Available relationships: claimedResource
|
|
5198
5478
|
* @example claimedResource
|
|
5199
5479
|
*/
|
|
5200
5480
|
include?: string[];
|
|
@@ -5258,7 +5538,7 @@ export interface paths {
|
|
|
5258
5538
|
parameters: {
|
|
5259
5539
|
query?: {
|
|
5260
5540
|
/**
|
|
5261
|
-
* @description
|
|
5541
|
+
* @description Include related resources. Available relationships: claimingArtist
|
|
5262
5542
|
* @example claimingArtist.albums
|
|
5263
5543
|
*/
|
|
5264
5544
|
include?: string[];
|
|
@@ -5322,7 +5602,7 @@ export interface paths {
|
|
|
5322
5602
|
parameters: {
|
|
5323
5603
|
query?: {
|
|
5324
5604
|
/**
|
|
5325
|
-
* @description
|
|
5605
|
+
* @description Include related resources. Available relationships: owners
|
|
5326
5606
|
* @example owners
|
|
5327
5607
|
*/
|
|
5328
5608
|
include?: string[];
|
|
@@ -5383,10 +5663,12 @@ export interface paths {
|
|
|
5383
5663
|
parameters: {
|
|
5384
5664
|
query?: {
|
|
5385
5665
|
/**
|
|
5386
|
-
* @description
|
|
5666
|
+
* @description Include related resources. Available relationships: artist, category
|
|
5387
5667
|
* @example artist.albums
|
|
5388
5668
|
*/
|
|
5389
5669
|
include?: string[];
|
|
5670
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
5671
|
+
includeLinkage?: ("artist" | "category")[];
|
|
5390
5672
|
/**
|
|
5391
5673
|
* @description 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
|
|
5392
5674
|
* @example artist.albums
|
|
@@ -5447,7 +5729,7 @@ export interface paths {
|
|
|
5447
5729
|
parameters: {
|
|
5448
5730
|
query?: {
|
|
5449
5731
|
/**
|
|
5450
|
-
* @description
|
|
5732
|
+
* @description Include related resources. Available relationships: artist
|
|
5451
5733
|
* @example artist.albums
|
|
5452
5734
|
*/
|
|
5453
5735
|
include?: string[];
|
|
@@ -5511,7 +5793,7 @@ export interface paths {
|
|
|
5511
5793
|
parameters: {
|
|
5512
5794
|
query?: {
|
|
5513
5795
|
/**
|
|
5514
|
-
* @description
|
|
5796
|
+
* @description Include related resources. Available relationships: category
|
|
5515
5797
|
* @example category
|
|
5516
5798
|
*/
|
|
5517
5799
|
include?: string[];
|
|
@@ -5571,8 +5853,10 @@ export interface paths {
|
|
|
5571
5853
|
query: {
|
|
5572
5854
|
/** @description Download id (e.g. `VFJBQ0tTOjEyMzQ1`) */
|
|
5573
5855
|
"filter[id]": string[];
|
|
5574
|
-
/** @description
|
|
5856
|
+
/** @description Include related resources. Available relationships: owners */
|
|
5575
5857
|
include?: string[];
|
|
5858
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
5859
|
+
includeLinkage?: "owners"[];
|
|
5576
5860
|
};
|
|
5577
5861
|
header?: never;
|
|
5578
5862
|
path?: never;
|
|
@@ -5621,8 +5905,10 @@ export interface paths {
|
|
|
5621
5905
|
get: {
|
|
5622
5906
|
parameters: {
|
|
5623
5907
|
query?: {
|
|
5624
|
-
/** @description
|
|
5908
|
+
/** @description Include related resources. Available relationships: owners */
|
|
5625
5909
|
include?: string[];
|
|
5910
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
5911
|
+
includeLinkage?: "owners"[];
|
|
5626
5912
|
};
|
|
5627
5913
|
header?: never;
|
|
5628
5914
|
path: {
|
|
@@ -5678,7 +5964,7 @@ export interface paths {
|
|
|
5678
5964
|
parameters: {
|
|
5679
5965
|
query?: {
|
|
5680
5966
|
/**
|
|
5681
|
-
* @description
|
|
5967
|
+
* @description Include related resources. Available relationships: owners
|
|
5682
5968
|
* @example owners
|
|
5683
5969
|
*/
|
|
5684
5970
|
include?: string[];
|
|
@@ -5739,7 +6025,7 @@ export interface paths {
|
|
|
5739
6025
|
parameters: {
|
|
5740
6026
|
query?: {
|
|
5741
6027
|
/**
|
|
5742
|
-
* @description
|
|
6028
|
+
* @description Include related resources. Available relationships: subject
|
|
5743
6029
|
* @example subject
|
|
5744
6030
|
*/
|
|
5745
6031
|
include?: string[];
|
|
@@ -5755,6 +6041,8 @@ export interface paths {
|
|
|
5755
6041
|
* @description Deprecated: use filter[subject]. The type of the subject resource (e.g. `tracks`)
|
|
5756
6042
|
*/
|
|
5757
6043
|
"filter[subject.type]"?: ("tracks" | "albums" | "artists")[];
|
|
6044
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
6045
|
+
includeLinkage?: "subject"[];
|
|
5758
6046
|
/**
|
|
5759
6047
|
* @description 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
|
|
5760
6048
|
* @example subject
|
|
@@ -5809,7 +6097,7 @@ export interface paths {
|
|
|
5809
6097
|
parameters: {
|
|
5810
6098
|
query?: {
|
|
5811
6099
|
/**
|
|
5812
|
-
* @description
|
|
6100
|
+
* @description Include related resources. Available relationships: subject
|
|
5813
6101
|
* @example subject
|
|
5814
6102
|
*/
|
|
5815
6103
|
include?: string[];
|
|
@@ -5902,10 +6190,12 @@ export interface paths {
|
|
|
5902
6190
|
*/
|
|
5903
6191
|
locale?: string;
|
|
5904
6192
|
/**
|
|
5905
|
-
* @description
|
|
6193
|
+
* @description Include related resources. Available relationships: items, seedItem
|
|
5906
6194
|
* @example items
|
|
5907
6195
|
*/
|
|
5908
6196
|
include?: string[];
|
|
6197
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
6198
|
+
includeLinkage?: ("items" | "seedItem")[];
|
|
5909
6199
|
/**
|
|
5910
6200
|
* @description 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
|
|
5911
6201
|
* @example items
|
|
@@ -5987,10 +6277,12 @@ export interface paths {
|
|
|
5987
6277
|
*/
|
|
5988
6278
|
locale?: string;
|
|
5989
6279
|
/**
|
|
5990
|
-
* @description
|
|
6280
|
+
* @description Include related resources. Available relationships: items, seedItem
|
|
5991
6281
|
* @example items
|
|
5992
6282
|
*/
|
|
5993
6283
|
include?: string[];
|
|
6284
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
6285
|
+
includeLinkage?: ("items" | "seedItem")[];
|
|
5994
6286
|
/**
|
|
5995
6287
|
* @description 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
|
|
5996
6288
|
* @example items
|
|
@@ -6080,7 +6372,7 @@ export interface paths {
|
|
|
6080
6372
|
*/
|
|
6081
6373
|
locale?: string;
|
|
6082
6374
|
/**
|
|
6083
|
-
* @description
|
|
6375
|
+
* @description Include related resources. Available relationships: items
|
|
6084
6376
|
* @example items
|
|
6085
6377
|
*/
|
|
6086
6378
|
include?: string[];
|
|
@@ -6171,7 +6463,7 @@ export interface paths {
|
|
|
6171
6463
|
*/
|
|
6172
6464
|
locale?: string;
|
|
6173
6465
|
/**
|
|
6174
|
-
* @description
|
|
6466
|
+
* @description Include related resources. Available relationships: seedItem
|
|
6175
6467
|
* @example seedItem
|
|
6176
6468
|
*/
|
|
6177
6469
|
include?: string[];
|
|
@@ -6264,7 +6556,7 @@ export interface paths {
|
|
|
6264
6556
|
*/
|
|
6265
6557
|
locale?: string;
|
|
6266
6558
|
/**
|
|
6267
|
-
* @description
|
|
6559
|
+
* @description Include related resources. Available relationships: modules, subject
|
|
6268
6560
|
* @example modules.items
|
|
6269
6561
|
*/
|
|
6270
6562
|
include?: string[];
|
|
@@ -6275,6 +6567,8 @@ export interface paths {
|
|
|
6275
6567
|
* @description Deprecated alternative to filter[subject]. Omit when subject is supplied or pageType is HOME_FREE. (e.g. `67890`)
|
|
6276
6568
|
*/
|
|
6277
6569
|
"filter[subject.id]"?: string[];
|
|
6570
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
6571
|
+
includeLinkage?: ("modules" | "subject")[];
|
|
6278
6572
|
/**
|
|
6279
6573
|
* @description 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
|
|
6280
6574
|
* @example modules.items
|
|
@@ -6358,7 +6652,7 @@ export interface paths {
|
|
|
6358
6652
|
*/
|
|
6359
6653
|
locale?: string;
|
|
6360
6654
|
/**
|
|
6361
|
-
* @description
|
|
6655
|
+
* @description Include related resources. Available relationships: modules
|
|
6362
6656
|
* @example modules.items
|
|
6363
6657
|
*/
|
|
6364
6658
|
include?: string[];
|
|
@@ -6422,7 +6716,7 @@ export interface paths {
|
|
|
6422
6716
|
parameters: {
|
|
6423
6717
|
query?: {
|
|
6424
6718
|
/**
|
|
6425
|
-
* @description
|
|
6719
|
+
* @description Include related resources. Available relationships: subject
|
|
6426
6720
|
* @example subject
|
|
6427
6721
|
*/
|
|
6428
6722
|
include?: string[];
|
|
@@ -6542,10 +6836,12 @@ export interface paths {
|
|
|
6542
6836
|
parameters: {
|
|
6543
6837
|
query?: {
|
|
6544
6838
|
/**
|
|
6545
|
-
* @description
|
|
6839
|
+
* @description Include related resources. Available relationships: owners, parent, subject
|
|
6546
6840
|
* @example parent.children.subject
|
|
6547
6841
|
*/
|
|
6548
6842
|
include?: string[];
|
|
6843
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
6844
|
+
includeLinkage?: ("owners" | "parent" | "subject")[];
|
|
6549
6845
|
/**
|
|
6550
6846
|
* @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: parent.children.subject
|
|
6551
6847
|
* @example parent.children.subject
|
|
@@ -6648,7 +6944,7 @@ export interface paths {
|
|
|
6648
6944
|
parameters: {
|
|
6649
6945
|
query?: {
|
|
6650
6946
|
/**
|
|
6651
|
-
* @description
|
|
6947
|
+
* @description Include related resources. Available relationships: owners
|
|
6652
6948
|
* @example owners
|
|
6653
6949
|
*/
|
|
6654
6950
|
include?: string[];
|
|
@@ -6709,7 +7005,7 @@ export interface paths {
|
|
|
6709
7005
|
parameters: {
|
|
6710
7006
|
query?: {
|
|
6711
7007
|
/**
|
|
6712
|
-
* @description
|
|
7008
|
+
* @description Include related resources. Available relationships: parent
|
|
6713
7009
|
* @example parent.children.subject
|
|
6714
7010
|
*/
|
|
6715
7011
|
include?: string[];
|
|
@@ -6819,7 +7115,7 @@ export interface paths {
|
|
|
6819
7115
|
parameters: {
|
|
6820
7116
|
query?: {
|
|
6821
7117
|
/**
|
|
6822
|
-
* @description
|
|
7118
|
+
* @description Include related resources. Available relationships: subject
|
|
6823
7119
|
* @example subject
|
|
6824
7120
|
*/
|
|
6825
7121
|
include?: string[];
|
|
@@ -6939,10 +7235,12 @@ export interface paths {
|
|
|
6939
7235
|
parameters: {
|
|
6940
7236
|
query?: {
|
|
6941
7237
|
/**
|
|
6942
|
-
* @description
|
|
7238
|
+
* @description Include related resources. Available relationships: children, owners
|
|
6943
7239
|
* @example children.subject
|
|
6944
7240
|
*/
|
|
6945
7241
|
include?: string[];
|
|
7242
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
7243
|
+
includeLinkage?: ("children" | "owners")[];
|
|
6946
7244
|
/**
|
|
6947
7245
|
* @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: children.subject
|
|
6948
7246
|
* @example children.subject
|
|
@@ -7093,7 +7391,7 @@ export interface paths {
|
|
|
7093
7391
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
7094
7392
|
"page[cursor]"?: string;
|
|
7095
7393
|
/**
|
|
7096
|
-
* @description
|
|
7394
|
+
* @description Include related resources. Available relationships: children
|
|
7097
7395
|
* @example children.subject
|
|
7098
7396
|
*/
|
|
7099
7397
|
include?: string[];
|
|
@@ -7157,7 +7455,7 @@ export interface paths {
|
|
|
7157
7455
|
parameters: {
|
|
7158
7456
|
query?: {
|
|
7159
7457
|
/**
|
|
7160
|
-
* @description
|
|
7458
|
+
* @description Include related resources. Available relationships: owners
|
|
7161
7459
|
* @example owners
|
|
7162
7460
|
*/
|
|
7163
7461
|
include?: string[];
|
|
@@ -7336,7 +7634,7 @@ export interface paths {
|
|
|
7336
7634
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
7337
7635
|
"page[cursor]"?: string;
|
|
7338
7636
|
/**
|
|
7339
|
-
* @description
|
|
7637
|
+
* @description Include related resources. Available relationships: offlineInventory, owners
|
|
7340
7638
|
* @example offlineInventory
|
|
7341
7639
|
*/
|
|
7342
7640
|
include?: string[];
|
|
@@ -7344,6 +7642,8 @@ export interface paths {
|
|
|
7344
7642
|
"filter[clientProvidedInstallationId]"?: string[];
|
|
7345
7643
|
/** @description User ID to filter by. Use `me` for the authenticated user */
|
|
7346
7644
|
"filter[owners.id]"?: string[];
|
|
7645
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
7646
|
+
includeLinkage?: ("offlineInventory" | "owners")[];
|
|
7347
7647
|
/**
|
|
7348
7648
|
* @description 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
|
|
7349
7649
|
* @example offlineInventory
|
|
@@ -7438,10 +7738,12 @@ export interface paths {
|
|
|
7438
7738
|
parameters: {
|
|
7439
7739
|
query?: {
|
|
7440
7740
|
/**
|
|
7441
|
-
* @description
|
|
7741
|
+
* @description Include related resources. Available relationships: offlineInventory, owners
|
|
7442
7742
|
* @example offlineInventory
|
|
7443
7743
|
*/
|
|
7444
7744
|
include?: string[];
|
|
7745
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
7746
|
+
includeLinkage?: ("offlineInventory" | "owners")[];
|
|
7445
7747
|
/**
|
|
7446
7748
|
* @description 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
|
|
7447
7749
|
* @example offlineInventory
|
|
@@ -7506,7 +7808,7 @@ export interface paths {
|
|
|
7506
7808
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
7507
7809
|
"page[cursor]"?: string;
|
|
7508
7810
|
/**
|
|
7509
|
-
* @description
|
|
7811
|
+
* @description Include related resources. Available relationships: offlineInventory
|
|
7510
7812
|
* @example offlineInventory
|
|
7511
7813
|
*/
|
|
7512
7814
|
include?: string[];
|
|
@@ -7666,7 +7968,7 @@ export interface paths {
|
|
|
7666
7968
|
parameters: {
|
|
7667
7969
|
query?: {
|
|
7668
7970
|
/**
|
|
7669
|
-
* @description
|
|
7971
|
+
* @description Include related resources. Available relationships: owners
|
|
7670
7972
|
* @example owners
|
|
7671
7973
|
*/
|
|
7672
7974
|
include?: string[];
|
|
@@ -7783,10 +8085,12 @@ export interface paths {
|
|
|
7783
8085
|
parameters: {
|
|
7784
8086
|
query?: {
|
|
7785
8087
|
/**
|
|
7786
|
-
* @description
|
|
8088
|
+
* @description Include related resources. Available relationships: owners, track
|
|
7787
8089
|
* @example track
|
|
7788
8090
|
*/
|
|
7789
8091
|
include?: string[];
|
|
8092
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
8093
|
+
includeLinkage?: ("owners" | "track")[];
|
|
7790
8094
|
/**
|
|
7791
8095
|
* @description 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
|
|
7792
8096
|
* @example track
|
|
@@ -7935,7 +8239,7 @@ export interface paths {
|
|
|
7935
8239
|
parameters: {
|
|
7936
8240
|
query?: {
|
|
7937
8241
|
/**
|
|
7938
|
-
* @description
|
|
8242
|
+
* @description Include related resources. Available relationships: owners
|
|
7939
8243
|
* @example owners
|
|
7940
8244
|
*/
|
|
7941
8245
|
include?: string[];
|
|
@@ -8001,7 +8305,7 @@ export interface paths {
|
|
|
8001
8305
|
*/
|
|
8002
8306
|
countryCode?: string;
|
|
8003
8307
|
/**
|
|
8004
|
-
* @description
|
|
8308
|
+
* @description Include related resources. Available relationships: track
|
|
8005
8309
|
* @example track
|
|
8006
8310
|
*/
|
|
8007
8311
|
include?: string[];
|
|
@@ -8125,10 +8429,12 @@ export interface paths {
|
|
|
8125
8429
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
8126
8430
|
"page[cursor]"?: string;
|
|
8127
8431
|
/**
|
|
8128
|
-
* @description
|
|
8432
|
+
* @description Include related resources. Available relationships: collection, item, owners
|
|
8129
8433
|
* @example collection
|
|
8130
8434
|
*/
|
|
8131
8435
|
include?: string[];
|
|
8436
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
8437
|
+
includeLinkage?: ("collection" | "item" | "owners")[];
|
|
8132
8438
|
/**
|
|
8133
8439
|
* @description 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
|
|
8134
8440
|
* @example collection
|
|
@@ -8183,10 +8489,12 @@ export interface paths {
|
|
|
8183
8489
|
parameters: {
|
|
8184
8490
|
query?: {
|
|
8185
8491
|
/**
|
|
8186
|
-
* @description
|
|
8492
|
+
* @description Include related resources. Available relationships: collection, item, owners
|
|
8187
8493
|
* @example collection
|
|
8188
8494
|
*/
|
|
8189
8495
|
include?: string[];
|
|
8496
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
8497
|
+
includeLinkage?: ("collection" | "item" | "owners")[];
|
|
8190
8498
|
/**
|
|
8191
8499
|
* @description 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
|
|
8192
8500
|
* @example collection
|
|
@@ -8293,7 +8601,7 @@ export interface paths {
|
|
|
8293
8601
|
parameters: {
|
|
8294
8602
|
query?: {
|
|
8295
8603
|
/**
|
|
8296
|
-
* @description
|
|
8604
|
+
* @description Include related resources. Available relationships: collection
|
|
8297
8605
|
* @example collection
|
|
8298
8606
|
*/
|
|
8299
8607
|
include?: string[];
|
|
@@ -8357,7 +8665,7 @@ export interface paths {
|
|
|
8357
8665
|
parameters: {
|
|
8358
8666
|
query?: {
|
|
8359
8667
|
/**
|
|
8360
|
-
* @description
|
|
8668
|
+
* @description Include related resources. Available relationships: item
|
|
8361
8669
|
* @example item
|
|
8362
8670
|
*/
|
|
8363
8671
|
include?: string[];
|
|
@@ -8421,7 +8729,7 @@ export interface paths {
|
|
|
8421
8729
|
parameters: {
|
|
8422
8730
|
query?: {
|
|
8423
8731
|
/**
|
|
8424
|
-
* @description
|
|
8732
|
+
* @description Include related resources. Available relationships: owners
|
|
8425
8733
|
* @example owners
|
|
8426
8734
|
*/
|
|
8427
8735
|
include?: string[];
|
|
@@ -8486,10 +8794,12 @@ export interface paths {
|
|
|
8486
8794
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
8487
8795
|
"page[cursor]"?: string;
|
|
8488
8796
|
/**
|
|
8489
|
-
* @description
|
|
8797
|
+
* @description Include related resources. Available relationships: changeEventStream, current, future, owners, past
|
|
8490
8798
|
* @example current
|
|
8491
8799
|
*/
|
|
8492
8800
|
include?: string[];
|
|
8801
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
8802
|
+
includeLinkage?: ("changeEventStream" | "current" | "future" | "owners" | "past")[];
|
|
8493
8803
|
/**
|
|
8494
8804
|
* @description 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
|
|
8495
8805
|
* @example current
|
|
@@ -8584,10 +8894,12 @@ export interface paths {
|
|
|
8584
8894
|
parameters: {
|
|
8585
8895
|
query?: {
|
|
8586
8896
|
/**
|
|
8587
|
-
* @description
|
|
8897
|
+
* @description Include related resources. Available relationships: changeEventStream, current, future, owners, past
|
|
8588
8898
|
* @example current
|
|
8589
8899
|
*/
|
|
8590
8900
|
include?: string[];
|
|
8901
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
8902
|
+
includeLinkage?: ("changeEventStream" | "current" | "future" | "owners" | "past")[];
|
|
8591
8903
|
/**
|
|
8592
8904
|
* @description 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
|
|
8593
8905
|
* @example current
|
|
@@ -8736,7 +9048,7 @@ export interface paths {
|
|
|
8736
9048
|
parameters: {
|
|
8737
9049
|
query?: {
|
|
8738
9050
|
/**
|
|
8739
|
-
* @description
|
|
9051
|
+
* @description Include related resources. Available relationships: changeEventStream
|
|
8740
9052
|
* @example changeEventStream
|
|
8741
9053
|
*/
|
|
8742
9054
|
include?: string[];
|
|
@@ -8791,7 +9103,7 @@ export interface paths {
|
|
|
8791
9103
|
parameters: {
|
|
8792
9104
|
query?: {
|
|
8793
9105
|
/**
|
|
8794
|
-
* @description
|
|
9106
|
+
* @description Include related resources. Available relationships: current
|
|
8795
9107
|
* @example current
|
|
8796
9108
|
*/
|
|
8797
9109
|
include?: string[];
|
|
@@ -8903,7 +9215,7 @@ export interface paths {
|
|
|
8903
9215
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
8904
9216
|
"page[cursor]"?: string;
|
|
8905
9217
|
/**
|
|
8906
|
-
* @description
|
|
9218
|
+
* @description Include related resources. Available relationships: future
|
|
8907
9219
|
* @example future
|
|
8908
9220
|
*/
|
|
8909
9221
|
include?: string[];
|
|
@@ -8947,7 +9259,7 @@ export interface paths {
|
|
|
8947
9259
|
put?: never;
|
|
8948
9260
|
/**
|
|
8949
9261
|
* Add to future relationship ("to-many").
|
|
8950
|
-
* @description
|
|
9262
|
+
* @description With meta.source, startIndex selects an entry in the first page's data before unsupported types are skipped. Tracks and videos are added in page order, retaining duplicates; other types are skipped without expansion. Reaching 1000 added items or 100 pages queues the collected prefix. Invalid sources or indexes, a suffix with no playable items, repeated pages, and read failures encountered before a cap leave the queue unchanged.
|
|
8951
9263
|
*/
|
|
8952
9264
|
post: {
|
|
8953
9265
|
parameters: {
|
|
@@ -9105,7 +9417,7 @@ export interface paths {
|
|
|
9105
9417
|
parameters: {
|
|
9106
9418
|
query?: {
|
|
9107
9419
|
/**
|
|
9108
|
-
* @description
|
|
9420
|
+
* @description Include related resources. Available relationships: owners
|
|
9109
9421
|
* @example owners
|
|
9110
9422
|
*/
|
|
9111
9423
|
include?: string[];
|
|
@@ -9168,7 +9480,7 @@ export interface paths {
|
|
|
9168
9480
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
9169
9481
|
"page[cursor]"?: string;
|
|
9170
9482
|
/**
|
|
9171
|
-
* @description
|
|
9483
|
+
* @description Include related resources. Available relationships: past
|
|
9172
9484
|
* @example past
|
|
9173
9485
|
*/
|
|
9174
9486
|
include?: string[];
|
|
@@ -9234,10 +9546,12 @@ export interface paths {
|
|
|
9234
9546
|
/** @description Playlist id (e.g. `550e8400-e29b-41d4-a716-446655440000`) */
|
|
9235
9547
|
"filter[playlist.id]": string[];
|
|
9236
9548
|
/**
|
|
9237
|
-
* @description
|
|
9549
|
+
* @description Include related resources. Available relationships: playlist
|
|
9238
9550
|
* @example playlist.items
|
|
9239
9551
|
*/
|
|
9240
9552
|
include?: string[];
|
|
9553
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
9554
|
+
includeLinkage?: "playlist"[];
|
|
9241
9555
|
/**
|
|
9242
9556
|
* @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: playlist.items
|
|
9243
9557
|
* @example playlist.items
|
|
@@ -9333,10 +9647,12 @@ export interface paths {
|
|
|
9333
9647
|
parameters: {
|
|
9334
9648
|
query?: {
|
|
9335
9649
|
/**
|
|
9336
|
-
* @description
|
|
9650
|
+
* @description Include related resources. Available relationships: playlist
|
|
9337
9651
|
* @example playlist.items
|
|
9338
9652
|
*/
|
|
9339
9653
|
include?: string[];
|
|
9654
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
9655
|
+
includeLinkage?: "playlist"[];
|
|
9340
9656
|
/**
|
|
9341
9657
|
* @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: playlist.items
|
|
9342
9658
|
* @example playlist.items
|
|
@@ -9473,7 +9789,7 @@ export interface paths {
|
|
|
9473
9789
|
parameters: {
|
|
9474
9790
|
query?: {
|
|
9475
9791
|
/**
|
|
9476
|
-
* @description
|
|
9792
|
+
* @description Include related resources. Available relationships: playlist
|
|
9477
9793
|
* @example playlist.items
|
|
9478
9794
|
*/
|
|
9479
9795
|
include?: string[];
|
|
@@ -9534,11 +9850,15 @@ export interface paths {
|
|
|
9534
9850
|
query: {
|
|
9535
9851
|
/** @description Playlist id (e.g. `550e8400-e29b-41d4-a716-446655440000`) */
|
|
9536
9852
|
"filter[playlist.id]": string[];
|
|
9853
|
+
/** @description CURRENT selects the committed generation. LATEST selects the newest accepted attempt, regardless of status. New values may be added at any time. */
|
|
9854
|
+
generationView?: "CURRENT" | "LATEST";
|
|
9537
9855
|
/**
|
|
9538
|
-
* @description
|
|
9856
|
+
* @description Include related resources. Available relationships: baseGeneration, playlist, trackPreferences
|
|
9539
9857
|
* @example baseGeneration.trackPreferences
|
|
9540
9858
|
*/
|
|
9541
9859
|
include?: string[];
|
|
9860
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
9861
|
+
includeLinkage?: ("baseGeneration" | "playlist" | "trackPreferences")[];
|
|
9542
9862
|
/**
|
|
9543
9863
|
* @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: baseGeneration.trackPreferences
|
|
9544
9864
|
* @example baseGeneration.trackPreferences
|
|
@@ -9633,10 +9953,12 @@ export interface paths {
|
|
|
9633
9953
|
parameters: {
|
|
9634
9954
|
query?: {
|
|
9635
9955
|
/**
|
|
9636
|
-
* @description
|
|
9956
|
+
* @description Include related resources. Available relationships: baseGeneration, playlist, trackPreferences
|
|
9637
9957
|
* @example baseGeneration.trackPreferences
|
|
9638
9958
|
*/
|
|
9639
9959
|
include?: string[];
|
|
9960
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
9961
|
+
includeLinkage?: ("baseGeneration" | "playlist" | "trackPreferences")[];
|
|
9640
9962
|
/**
|
|
9641
9963
|
* @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: baseGeneration.trackPreferences
|
|
9642
9964
|
* @example baseGeneration.trackPreferences
|
|
@@ -9697,7 +10019,7 @@ export interface paths {
|
|
|
9697
10019
|
parameters: {
|
|
9698
10020
|
query?: {
|
|
9699
10021
|
/**
|
|
9700
|
-
* @description
|
|
10022
|
+
* @description Include related resources. Available relationships: baseGeneration
|
|
9701
10023
|
* @example baseGeneration.trackPreferences
|
|
9702
10024
|
*/
|
|
9703
10025
|
include?: string[];
|
|
@@ -9761,7 +10083,7 @@ export interface paths {
|
|
|
9761
10083
|
parameters: {
|
|
9762
10084
|
query?: {
|
|
9763
10085
|
/**
|
|
9764
|
-
* @description
|
|
10086
|
+
* @description Include related resources. Available relationships: playlist
|
|
9765
10087
|
* @example playlist.items
|
|
9766
10088
|
*/
|
|
9767
10089
|
include?: string[];
|
|
@@ -9827,7 +10149,7 @@ export interface paths {
|
|
|
9827
10149
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
9828
10150
|
"page[cursor]"?: string;
|
|
9829
10151
|
/**
|
|
9830
|
-
* @description
|
|
10152
|
+
* @description Include related resources. Available relationships: trackPreferences
|
|
9831
10153
|
* @example trackPreferences
|
|
9832
10154
|
*/
|
|
9833
10155
|
include?: string[];
|
|
@@ -10038,7 +10360,7 @@ export interface paths {
|
|
|
10038
10360
|
*/
|
|
10039
10361
|
countryCode?: string;
|
|
10040
10362
|
/**
|
|
10041
|
-
* @description
|
|
10363
|
+
* @description Include related resources. Available relationships: collaboratorProfiles, collaborators, coverArt, curators, items, ownerProfiles, owners, suggestedCoverArts
|
|
10042
10364
|
* @example curators.albums
|
|
10043
10365
|
*/
|
|
10044
10366
|
include?: string[];
|
|
@@ -10048,6 +10370,8 @@ export interface paths {
|
|
|
10048
10370
|
"filter[id]"?: string[];
|
|
10049
10371
|
/** @description User id. Use `me` for the authenticated user */
|
|
10050
10372
|
"filter[owners.id]"?: string[];
|
|
10373
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
10374
|
+
includeLinkage?: ("collaboratorProfiles" | "collaborators" | "coverArt" | "curators" | "items" | "ownerProfiles" | "owners" | "suggestedCoverArts")[];
|
|
10051
10375
|
/**
|
|
10052
10376
|
* @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: curators.albums
|
|
10053
10377
|
* @example curators.albums
|
|
@@ -10147,10 +10471,12 @@ export interface paths {
|
|
|
10147
10471
|
*/
|
|
10148
10472
|
countryCode?: string;
|
|
10149
10473
|
/**
|
|
10150
|
-
* @description
|
|
10474
|
+
* @description Include related resources. Available relationships: collaboratorProfiles, collaborators, coverArt, curators, items, ownerProfiles, owners, suggestedCoverArts
|
|
10151
10475
|
* @example curators.albums
|
|
10152
10476
|
*/
|
|
10153
10477
|
include?: string[];
|
|
10478
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
10479
|
+
includeLinkage?: ("collaboratorProfiles" | "collaborators" | "coverArt" | "curators" | "items" | "ownerProfiles" | "owners" | "suggestedCoverArts")[];
|
|
10154
10480
|
/**
|
|
10155
10481
|
* @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: curators.albums
|
|
10156
10482
|
* @example curators.albums
|
|
@@ -10300,7 +10626,7 @@ export interface paths {
|
|
|
10300
10626
|
parameters: {
|
|
10301
10627
|
query?: {
|
|
10302
10628
|
/**
|
|
10303
|
-
* @description
|
|
10629
|
+
* @description Include related resources. Available relationships: collaboratorProfiles
|
|
10304
10630
|
* @example collaboratorProfiles
|
|
10305
10631
|
*/
|
|
10306
10632
|
include?: string[];
|
|
@@ -10408,7 +10734,7 @@ export interface paths {
|
|
|
10408
10734
|
parameters: {
|
|
10409
10735
|
query?: {
|
|
10410
10736
|
/**
|
|
10411
|
-
* @description
|
|
10737
|
+
* @description Include related resources. Available relationships: collaborators
|
|
10412
10738
|
* @example collaborators
|
|
10413
10739
|
*/
|
|
10414
10740
|
include?: string[];
|
|
@@ -10474,7 +10800,7 @@ export interface paths {
|
|
|
10474
10800
|
*/
|
|
10475
10801
|
countryCode?: string;
|
|
10476
10802
|
/**
|
|
10477
|
-
* @description
|
|
10803
|
+
* @description Include related resources. Available relationships: coverArt
|
|
10478
10804
|
* @example coverArt
|
|
10479
10805
|
*/
|
|
10480
10806
|
include?: string[];
|
|
@@ -10583,7 +10909,7 @@ export interface paths {
|
|
|
10583
10909
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
10584
10910
|
"page[cursor]"?: string;
|
|
10585
10911
|
/**
|
|
10586
|
-
* @description
|
|
10912
|
+
* @description Include related resources. Available relationships: curators
|
|
10587
10913
|
* @example curators.albums
|
|
10588
10914
|
*/
|
|
10589
10915
|
include?: string[];
|
|
@@ -10656,7 +10982,7 @@ export interface paths {
|
|
|
10656
10982
|
*/
|
|
10657
10983
|
countryCode?: string;
|
|
10658
10984
|
/**
|
|
10659
|
-
* @description
|
|
10985
|
+
* @description Include related resources. Available relationships: items
|
|
10660
10986
|
* @example items
|
|
10661
10987
|
*/
|
|
10662
10988
|
include?: string[];
|
|
@@ -10861,7 +11187,7 @@ export interface paths {
|
|
|
10861
11187
|
parameters: {
|
|
10862
11188
|
query?: {
|
|
10863
11189
|
/**
|
|
10864
|
-
* @description
|
|
11190
|
+
* @description Include related resources. Available relationships: ownerProfiles
|
|
10865
11191
|
* @example ownerProfiles
|
|
10866
11192
|
*/
|
|
10867
11193
|
include?: string[];
|
|
@@ -10922,7 +11248,7 @@ export interface paths {
|
|
|
10922
11248
|
parameters: {
|
|
10923
11249
|
query?: {
|
|
10924
11250
|
/**
|
|
10925
|
-
* @description
|
|
11251
|
+
* @description Include related resources. Available relationships: owners
|
|
10926
11252
|
* @example owners
|
|
10927
11253
|
*/
|
|
10928
11254
|
include?: string[];
|
|
@@ -10983,7 +11309,7 @@ export interface paths {
|
|
|
10983
11309
|
parameters: {
|
|
10984
11310
|
query?: {
|
|
10985
11311
|
/**
|
|
10986
|
-
* @description
|
|
11312
|
+
* @description Include related resources. Available relationships: suggestedCoverArts
|
|
10987
11313
|
* @example suggestedCoverArts
|
|
10988
11314
|
*/
|
|
10989
11315
|
include?: string[];
|
|
@@ -11189,10 +11515,12 @@ export interface paths {
|
|
|
11189
11515
|
/** @description User id. Use `me` for the authenticated user */
|
|
11190
11516
|
"filter[owners.id]": string[];
|
|
11191
11517
|
/**
|
|
11192
|
-
* @description
|
|
11518
|
+
* @description Include related resources. Available relationships: owners, provider
|
|
11193
11519
|
* @example provider
|
|
11194
11520
|
*/
|
|
11195
11521
|
include?: string[];
|
|
11522
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
11523
|
+
includeLinkage?: ("owners" | "provider")[];
|
|
11196
11524
|
};
|
|
11197
11525
|
header?: never;
|
|
11198
11526
|
path?: never;
|
|
@@ -11242,7 +11570,7 @@ export interface paths {
|
|
|
11242
11570
|
parameters: {
|
|
11243
11571
|
query?: {
|
|
11244
11572
|
/**
|
|
11245
|
-
* @description
|
|
11573
|
+
* @description Include related resources. Available relationships: owners
|
|
11246
11574
|
* @example owners
|
|
11247
11575
|
*/
|
|
11248
11576
|
include?: string[];
|
|
@@ -11300,7 +11628,7 @@ export interface paths {
|
|
|
11300
11628
|
parameters: {
|
|
11301
11629
|
query?: {
|
|
11302
11630
|
/**
|
|
11303
|
-
* @description
|
|
11631
|
+
* @description Include related resources. Available relationships: provider
|
|
11304
11632
|
* @example provider
|
|
11305
11633
|
*/
|
|
11306
11634
|
include?: string[];
|
|
@@ -11363,7 +11691,7 @@ export interface paths {
|
|
|
11363
11691
|
*/
|
|
11364
11692
|
countryCode?: string;
|
|
11365
11693
|
/**
|
|
11366
|
-
* @description
|
|
11694
|
+
* @description Include related resources. Available relationships: provider, subject
|
|
11367
11695
|
* @example subject
|
|
11368
11696
|
*/
|
|
11369
11697
|
include?: string[];
|
|
@@ -11371,6 +11699,8 @@ export interface paths {
|
|
|
11371
11699
|
"filter[barcodeId]"?: string[];
|
|
11372
11700
|
/** @description List of GRIDs (Global Release Identifier, ISO 7064) (e.g. `A10302B0013941653J`) */
|
|
11373
11701
|
"filter[grid]"?: string[];
|
|
11702
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
11703
|
+
includeLinkage?: ("provider" | "subject")[];
|
|
11374
11704
|
/**
|
|
11375
11705
|
* @description 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
|
|
11376
11706
|
* @example subject
|
|
@@ -11425,7 +11755,7 @@ export interface paths {
|
|
|
11425
11755
|
parameters: {
|
|
11426
11756
|
query?: {
|
|
11427
11757
|
/**
|
|
11428
|
-
* @description
|
|
11758
|
+
* @description Include related resources. Available relationships: provider
|
|
11429
11759
|
* @example provider
|
|
11430
11760
|
*/
|
|
11431
11761
|
include?: string[];
|
|
@@ -11486,7 +11816,7 @@ export interface paths {
|
|
|
11486
11816
|
*/
|
|
11487
11817
|
countryCode?: string;
|
|
11488
11818
|
/**
|
|
11489
|
-
* @description
|
|
11819
|
+
* @description Include related resources. Available relationships: subject
|
|
11490
11820
|
* @example subject
|
|
11491
11821
|
*/
|
|
11492
11822
|
include?: string[];
|
|
@@ -11606,10 +11936,12 @@ export interface paths {
|
|
|
11606
11936
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
11607
11937
|
"page[cursor]"?: string;
|
|
11608
11938
|
/**
|
|
11609
|
-
* @description
|
|
11939
|
+
* @description Include related resources. Available relationships: owners, subject
|
|
11610
11940
|
* @example subject
|
|
11611
11941
|
*/
|
|
11612
11942
|
include?: string[];
|
|
11943
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
11944
|
+
includeLinkage?: ("owners" | "subject")[];
|
|
11613
11945
|
/**
|
|
11614
11946
|
* @description 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
|
|
11615
11947
|
* @example subject
|
|
@@ -11664,7 +11996,7 @@ export interface paths {
|
|
|
11664
11996
|
parameters: {
|
|
11665
11997
|
query?: {
|
|
11666
11998
|
/**
|
|
11667
|
-
* @description
|
|
11999
|
+
* @description Include related resources. Available relationships: owners
|
|
11668
12000
|
* @example owners
|
|
11669
12001
|
*/
|
|
11670
12002
|
include?: string[];
|
|
@@ -11725,7 +12057,7 @@ export interface paths {
|
|
|
11725
12057
|
parameters: {
|
|
11726
12058
|
query?: {
|
|
11727
12059
|
/**
|
|
11728
|
-
* @description
|
|
12060
|
+
* @description Include related resources. Available relationships: subject
|
|
11729
12061
|
* @example subject
|
|
11730
12062
|
*/
|
|
11731
12063
|
include?: string[];
|
|
@@ -11794,7 +12126,7 @@ export interface paths {
|
|
|
11794
12126
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
11795
12127
|
"page[cursor]"?: string;
|
|
11796
12128
|
/**
|
|
11797
|
-
* @description
|
|
12129
|
+
* @description Include related resources. Available relationships: author, ownerProfiles, owners
|
|
11798
12130
|
* @example author.albums
|
|
11799
12131
|
*/
|
|
11800
12132
|
include?: string[];
|
|
@@ -11812,6 +12144,8 @@ export interface paths {
|
|
|
11812
12144
|
* @description Deprecated: use filter[subject]. Filter by subject resource type (e.g. `albums`)
|
|
11813
12145
|
*/
|
|
11814
12146
|
"filter[subject.type]"?: ("albums" | "tracks" | "artists" | "videos" | "playlists" | "comments" | "trackSourceFiles")[];
|
|
12147
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
12148
|
+
includeLinkage?: ("author" | "ownerProfiles" | "owners")[];
|
|
11815
12149
|
/**
|
|
11816
12150
|
* @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: author.albums
|
|
11817
12151
|
* @example author.albums
|
|
@@ -11964,7 +12298,7 @@ export interface paths {
|
|
|
11964
12298
|
parameters: {
|
|
11965
12299
|
query?: {
|
|
11966
12300
|
/**
|
|
11967
|
-
* @description
|
|
12301
|
+
* @description Include related resources. Available relationships: author
|
|
11968
12302
|
* @example author.albums
|
|
11969
12303
|
*/
|
|
11970
12304
|
include?: string[];
|
|
@@ -12029,7 +12363,7 @@ export interface paths {
|
|
|
12029
12363
|
parameters: {
|
|
12030
12364
|
query?: {
|
|
12031
12365
|
/**
|
|
12032
|
-
* @description
|
|
12366
|
+
* @description Include related resources. Available relationships: ownerProfiles
|
|
12033
12367
|
* @example ownerProfiles
|
|
12034
12368
|
*/
|
|
12035
12369
|
include?: string[];
|
|
@@ -12090,7 +12424,7 @@ export interface paths {
|
|
|
12090
12424
|
parameters: {
|
|
12091
12425
|
query?: {
|
|
12092
12426
|
/**
|
|
12093
|
-
* @description
|
|
12427
|
+
* @description Include related resources. Available relationships: owners
|
|
12094
12428
|
* @example owners
|
|
12095
12429
|
*/
|
|
12096
12430
|
include?: string[];
|
|
@@ -12342,10 +12676,12 @@ export interface paths {
|
|
|
12342
12676
|
*/
|
|
12343
12677
|
clientVersion?: string;
|
|
12344
12678
|
/**
|
|
12345
|
-
* @description
|
|
12679
|
+
* @description Include related resources. Available relationships: albums, artists, playlists, topHits, tracks, videos
|
|
12346
12680
|
* @example albums
|
|
12347
12681
|
*/
|
|
12348
12682
|
include?: string[];
|
|
12683
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
12684
|
+
includeLinkage?: ("albums" | "artists" | "playlists" | "topHits" | "tracks" | "videos")[];
|
|
12349
12685
|
/**
|
|
12350
12686
|
* @description 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
|
|
12351
12687
|
* @example albums
|
|
@@ -12427,7 +12763,7 @@ export interface paths {
|
|
|
12427
12763
|
*/
|
|
12428
12764
|
clientVersion?: string;
|
|
12429
12765
|
/**
|
|
12430
|
-
* @description
|
|
12766
|
+
* @description Include related resources. Available relationships: albums
|
|
12431
12767
|
* @example albums
|
|
12432
12768
|
*/
|
|
12433
12769
|
include?: string[];
|
|
@@ -12515,7 +12851,7 @@ export interface paths {
|
|
|
12515
12851
|
*/
|
|
12516
12852
|
clientVersion?: string;
|
|
12517
12853
|
/**
|
|
12518
|
-
* @description
|
|
12854
|
+
* @description Include related resources. Available relationships: artists
|
|
12519
12855
|
* @example artists
|
|
12520
12856
|
*/
|
|
12521
12857
|
include?: string[];
|
|
@@ -12603,7 +12939,7 @@ export interface paths {
|
|
|
12603
12939
|
*/
|
|
12604
12940
|
clientVersion?: string;
|
|
12605
12941
|
/**
|
|
12606
|
-
* @description
|
|
12942
|
+
* @description Include related resources. Available relationships: playlists
|
|
12607
12943
|
* @example playlists
|
|
12608
12944
|
*/
|
|
12609
12945
|
include?: string[];
|
|
@@ -12691,7 +13027,7 @@ export interface paths {
|
|
|
12691
13027
|
*/
|
|
12692
13028
|
clientVersion?: string;
|
|
12693
13029
|
/**
|
|
12694
|
-
* @description
|
|
13030
|
+
* @description Include related resources. Available relationships: topHits
|
|
12695
13031
|
* @example topHits
|
|
12696
13032
|
*/
|
|
12697
13033
|
include?: string[];
|
|
@@ -12779,7 +13115,7 @@ export interface paths {
|
|
|
12779
13115
|
*/
|
|
12780
13116
|
clientVersion?: string;
|
|
12781
13117
|
/**
|
|
12782
|
-
* @description
|
|
13118
|
+
* @description Include related resources. Available relationships: tracks
|
|
12783
13119
|
* @example tracks
|
|
12784
13120
|
*/
|
|
12785
13121
|
include?: string[];
|
|
@@ -12867,7 +13203,7 @@ export interface paths {
|
|
|
12867
13203
|
*/
|
|
12868
13204
|
clientVersion?: string;
|
|
12869
13205
|
/**
|
|
12870
|
-
* @description
|
|
13206
|
+
* @description Include related resources. Available relationships: videos
|
|
12871
13207
|
* @example videos
|
|
12872
13208
|
*/
|
|
12873
13209
|
include?: string[];
|
|
@@ -12940,10 +13276,12 @@ export interface paths {
|
|
|
12940
13276
|
*/
|
|
12941
13277
|
countryCode?: string;
|
|
12942
13278
|
/**
|
|
12943
|
-
* @description
|
|
13279
|
+
* @description Include related resources. Available relationships: directHits, history
|
|
12944
13280
|
* @example directHits
|
|
12945
13281
|
*/
|
|
12946
13282
|
include?: string[];
|
|
13283
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
13284
|
+
includeLinkage?: ("directHits" | "history")[];
|
|
12947
13285
|
/**
|
|
12948
13286
|
* @description 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
|
|
12949
13287
|
* @example directHits
|
|
@@ -13008,7 +13346,7 @@ export interface paths {
|
|
|
13008
13346
|
*/
|
|
13009
13347
|
countryCode?: string;
|
|
13010
13348
|
/**
|
|
13011
|
-
* @description
|
|
13349
|
+
* @description Include related resources. Available relationships: directHits
|
|
13012
13350
|
* @example directHits
|
|
13013
13351
|
*/
|
|
13014
13352
|
include?: string[];
|
|
@@ -13081,7 +13419,7 @@ export interface paths {
|
|
|
13081
13419
|
*/
|
|
13082
13420
|
countryCode?: string;
|
|
13083
13421
|
/**
|
|
13084
|
-
* @description
|
|
13422
|
+
* @description Include related resources. Available relationships: history
|
|
13085
13423
|
* @example history
|
|
13086
13424
|
*/
|
|
13087
13425
|
include?: string[];
|
|
@@ -13141,10 +13479,12 @@ export interface paths {
|
|
|
13141
13479
|
/** @description A share code (e.g. `xyz`) */
|
|
13142
13480
|
"filter[code]": string[];
|
|
13143
13481
|
/**
|
|
13144
|
-
* @description
|
|
13482
|
+
* @description Include related resources. Available relationships: owners, sharedResources
|
|
13145
13483
|
* @example sharedResources
|
|
13146
13484
|
*/
|
|
13147
13485
|
include?: string[];
|
|
13486
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
13487
|
+
includeLinkage?: ("owners" | "sharedResources")[];
|
|
13148
13488
|
/**
|
|
13149
13489
|
* @description 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
|
|
13150
13490
|
* @example sharedResources
|
|
@@ -13239,10 +13579,12 @@ export interface paths {
|
|
|
13239
13579
|
parameters: {
|
|
13240
13580
|
query?: {
|
|
13241
13581
|
/**
|
|
13242
|
-
* @description
|
|
13582
|
+
* @description Include related resources. Available relationships: owners, sharedResources
|
|
13243
13583
|
* @example sharedResources
|
|
13244
13584
|
*/
|
|
13245
13585
|
include?: string[];
|
|
13586
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
13587
|
+
includeLinkage?: ("owners" | "sharedResources")[];
|
|
13246
13588
|
/**
|
|
13247
13589
|
* @description 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
|
|
13248
13590
|
* @example sharedResources
|
|
@@ -13303,7 +13645,7 @@ export interface paths {
|
|
|
13303
13645
|
parameters: {
|
|
13304
13646
|
query?: {
|
|
13305
13647
|
/**
|
|
13306
|
-
* @description
|
|
13648
|
+
* @description Include related resources. Available relationships: owners
|
|
13307
13649
|
* @example owners
|
|
13308
13650
|
*/
|
|
13309
13651
|
include?: string[];
|
|
@@ -13366,7 +13708,7 @@ export interface paths {
|
|
|
13366
13708
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
13367
13709
|
"page[cursor]"?: string;
|
|
13368
13710
|
/**
|
|
13369
|
-
* @description
|
|
13711
|
+
* @description Include related resources. Available relationships: sharedResources
|
|
13370
13712
|
* @example sharedResources
|
|
13371
13713
|
*/
|
|
13372
13714
|
include?: string[];
|
|
@@ -13486,10 +13828,12 @@ export interface paths {
|
|
|
13486
13828
|
parameters: {
|
|
13487
13829
|
query?: {
|
|
13488
13830
|
/**
|
|
13489
|
-
* @description
|
|
13831
|
+
* @description Include related resources. Available relationships: selectedSite, sites
|
|
13490
13832
|
* @example selectedSite
|
|
13491
13833
|
*/
|
|
13492
13834
|
include?: string[];
|
|
13835
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
13836
|
+
includeLinkage?: ("selectedSite" | "sites")[];
|
|
13493
13837
|
};
|
|
13494
13838
|
header?: never;
|
|
13495
13839
|
path: {
|
|
@@ -13546,7 +13890,7 @@ export interface paths {
|
|
|
13546
13890
|
parameters: {
|
|
13547
13891
|
query?: {
|
|
13548
13892
|
/**
|
|
13549
|
-
* @description
|
|
13893
|
+
* @description Include related resources. Available relationships: selectedSite
|
|
13550
13894
|
* @example selectedSite
|
|
13551
13895
|
*/
|
|
13552
13896
|
include?: string[];
|
|
@@ -13653,7 +13997,7 @@ export interface paths {
|
|
|
13653
13997
|
parameters: {
|
|
13654
13998
|
query?: {
|
|
13655
13999
|
/**
|
|
13656
|
-
* @description
|
|
14000
|
+
* @description Include related resources. Available relationships: sites
|
|
13657
14001
|
* @example sites
|
|
13658
14002
|
*/
|
|
13659
14003
|
include?: string[];
|
|
@@ -13716,8 +14060,10 @@ export interface paths {
|
|
|
13716
14060
|
query: {
|
|
13717
14061
|
/** @description User id. Use `me` for the authenticated user */
|
|
13718
14062
|
"filter[owners.id]": string[];
|
|
13719
|
-
/** @description
|
|
14063
|
+
/** @description Include related resources. Available relationships: owners */
|
|
13720
14064
|
include?: string[];
|
|
14065
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
14066
|
+
includeLinkage?: "owners"[];
|
|
13721
14067
|
};
|
|
13722
14068
|
header?: never;
|
|
13723
14069
|
path?: never;
|
|
@@ -13807,7 +14153,7 @@ export interface paths {
|
|
|
13807
14153
|
parameters: {
|
|
13808
14154
|
query?: {
|
|
13809
14155
|
/**
|
|
13810
|
-
* @description
|
|
14156
|
+
* @description Include related resources. Available relationships: owners
|
|
13811
14157
|
* @example owners
|
|
13812
14158
|
*/
|
|
13813
14159
|
include?: string[];
|
|
@@ -13869,8 +14215,10 @@ export interface paths {
|
|
|
13869
14215
|
query: {
|
|
13870
14216
|
/** @description User id. Use `me` for the authenticated user */
|
|
13871
14217
|
"filter[owners.id]": string[];
|
|
13872
|
-
/** @description
|
|
14218
|
+
/** @description Include related resources. Available relationships: owners */
|
|
13873
14219
|
include?: string[];
|
|
14220
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
14221
|
+
includeLinkage?: "owners"[];
|
|
13874
14222
|
};
|
|
13875
14223
|
header?: never;
|
|
13876
14224
|
path?: never;
|
|
@@ -13920,7 +14268,7 @@ export interface paths {
|
|
|
13920
14268
|
parameters: {
|
|
13921
14269
|
query?: {
|
|
13922
14270
|
/**
|
|
13923
|
-
* @description
|
|
14271
|
+
* @description Include related resources. Available relationships: owners
|
|
13924
14272
|
* @example owners
|
|
13925
14273
|
*/
|
|
13926
14274
|
include?: string[];
|
|
@@ -13983,10 +14331,12 @@ export interface paths {
|
|
|
13983
14331
|
/** @description User id. Use `me` for the authenticated user */
|
|
13984
14332
|
"filter[owners.id]": string[];
|
|
13985
14333
|
/**
|
|
13986
|
-
* @description
|
|
14334
|
+
* @description Include related resources. Available relationships: priceChange
|
|
13987
14335
|
* @example priceChange
|
|
13988
14336
|
*/
|
|
13989
14337
|
include?: string[];
|
|
14338
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
14339
|
+
includeLinkage?: "priceChange"[];
|
|
13990
14340
|
};
|
|
13991
14341
|
header?: never;
|
|
13992
14342
|
path?: never;
|
|
@@ -14138,7 +14488,7 @@ export interface paths {
|
|
|
14138
14488
|
parameters: {
|
|
14139
14489
|
query?: {
|
|
14140
14490
|
/**
|
|
14141
|
-
* @description
|
|
14491
|
+
* @description Include related resources. Available relationships: priceChange
|
|
14142
14492
|
* @example priceChange
|
|
14143
14493
|
*/
|
|
14144
14494
|
include?: string[];
|
|
@@ -14252,8 +14602,10 @@ export interface paths {
|
|
|
14252
14602
|
get: {
|
|
14253
14603
|
parameters: {
|
|
14254
14604
|
query?: {
|
|
14255
|
-
/** @description
|
|
14605
|
+
/** @description Include related resources. Available relationships: owners */
|
|
14256
14606
|
include?: string[];
|
|
14607
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
14608
|
+
includeLinkage?: "owners"[];
|
|
14257
14609
|
};
|
|
14258
14610
|
header?: never;
|
|
14259
14611
|
path: {
|
|
@@ -14309,7 +14661,7 @@ export interface paths {
|
|
|
14309
14661
|
parameters: {
|
|
14310
14662
|
query?: {
|
|
14311
14663
|
/**
|
|
14312
|
-
* @description
|
|
14664
|
+
* @description Include related resources. Available relationships: owners
|
|
14313
14665
|
* @example owners
|
|
14314
14666
|
*/
|
|
14315
14667
|
include?: string[];
|
|
@@ -14653,8 +15005,10 @@ export interface paths {
|
|
|
14653
15005
|
get: {
|
|
14654
15006
|
parameters: {
|
|
14655
15007
|
query?: {
|
|
14656
|
-
/** @description
|
|
15008
|
+
/** @description Include related resources. Available relationships: owners */
|
|
14657
15009
|
include?: string[];
|
|
15010
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
15011
|
+
includeLinkage?: "owners"[];
|
|
14658
15012
|
};
|
|
14659
15013
|
header?: never;
|
|
14660
15014
|
path: {
|
|
@@ -14710,7 +15064,7 @@ export interface paths {
|
|
|
14710
15064
|
parameters: {
|
|
14711
15065
|
query?: {
|
|
14712
15066
|
/**
|
|
14713
|
-
* @description
|
|
15067
|
+
* @description Include related resources. Available relationships: owners
|
|
14714
15068
|
* @example owners
|
|
14715
15069
|
*/
|
|
14716
15070
|
include?: string[];
|
|
@@ -14775,8 +15129,10 @@ export interface paths {
|
|
|
14775
15129
|
* @example US
|
|
14776
15130
|
*/
|
|
14777
15131
|
countryCode?: string;
|
|
14778
|
-
/** @description
|
|
15132
|
+
/** @description Include related resources. Available relationships: owners */
|
|
14779
15133
|
include?: string[];
|
|
15134
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
15135
|
+
includeLinkage?: "owners"[];
|
|
14780
15136
|
};
|
|
14781
15137
|
header?: never;
|
|
14782
15138
|
path: {
|
|
@@ -14832,7 +15188,7 @@ export interface paths {
|
|
|
14832
15188
|
parameters: {
|
|
14833
15189
|
query?: {
|
|
14834
15190
|
/**
|
|
14835
|
-
* @description
|
|
15191
|
+
* @description Include related resources. Available relationships: owners
|
|
14836
15192
|
* @example owners
|
|
14837
15193
|
*/
|
|
14838
15194
|
include?: string[];
|
|
@@ -14902,7 +15258,7 @@ export interface paths {
|
|
|
14902
15258
|
*/
|
|
14903
15259
|
countryCode?: string;
|
|
14904
15260
|
/**
|
|
14905
|
-
* @description
|
|
15261
|
+
* @description Include related resources. Available relationships: albums, artists, credits, download, genres, lyrics, metadataStatus, owners, priceConfig, providers, radio, replacement, shares, similarTracks, sourceFile, suggestedTracks, trackStatistics, usageRules
|
|
14906
15262
|
* @example albums
|
|
14907
15263
|
*/
|
|
14908
15264
|
include?: string[];
|
|
@@ -14912,6 +15268,8 @@ export interface paths {
|
|
|
14912
15268
|
"filter[isrc]"?: string[];
|
|
14913
15269
|
/** @description User id. Use `me` for the authenticated user */
|
|
14914
15270
|
"filter[owners.id]"?: string[];
|
|
15271
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
15272
|
+
includeLinkage?: ("albums" | "artists" | "credits" | "download" | "genres" | "lyrics" | "metadataStatus" | "owners" | "priceConfig" | "providers" | "radio" | "replacement" | "shares" | "similarTracks" | "sourceFile" | "suggestedTracks" | "trackStatistics" | "usageRules")[];
|
|
14915
15273
|
/**
|
|
14916
15274
|
* @description 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
|
|
14917
15275
|
* @example albums
|
|
@@ -15013,10 +15371,12 @@ export interface paths {
|
|
|
15013
15371
|
*/
|
|
15014
15372
|
countryCode?: string;
|
|
15015
15373
|
/**
|
|
15016
|
-
* @description
|
|
15374
|
+
* @description Include related resources. Available relationships: albums, artists, credits, download, genres, lyrics, metadataStatus, owners, priceConfig, providers, radio, replacement, shares, similarTracks, sourceFile, suggestedTracks, trackStatistics, usageRules
|
|
15017
15375
|
* @example albums
|
|
15018
15376
|
*/
|
|
15019
15377
|
include?: string[];
|
|
15378
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
15379
|
+
includeLinkage?: ("albums" | "artists" | "credits" | "download" | "genres" | "lyrics" | "metadataStatus" | "owners" | "priceConfig" | "providers" | "radio" | "replacement" | "shares" | "similarTracks" | "sourceFile" | "suggestedTracks" | "trackStatistics" | "usageRules")[];
|
|
15020
15380
|
/**
|
|
15021
15381
|
* @description 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
|
|
15022
15382
|
* @example albums
|
|
@@ -15172,7 +15532,7 @@ export interface paths {
|
|
|
15172
15532
|
*/
|
|
15173
15533
|
countryCode?: string;
|
|
15174
15534
|
/**
|
|
15175
|
-
* @description
|
|
15535
|
+
* @description Include related resources. Available relationships: albums
|
|
15176
15536
|
* @example albums
|
|
15177
15537
|
*/
|
|
15178
15538
|
include?: string[];
|
|
@@ -15293,7 +15653,7 @@ export interface paths {
|
|
|
15293
15653
|
*/
|
|
15294
15654
|
countryCode?: string;
|
|
15295
15655
|
/**
|
|
15296
|
-
* @description
|
|
15656
|
+
* @description Include related resources. Available relationships: artists
|
|
15297
15657
|
* @example artists.albums
|
|
15298
15658
|
*/
|
|
15299
15659
|
include?: string[];
|
|
@@ -15361,7 +15721,7 @@ export interface paths {
|
|
|
15361
15721
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
15362
15722
|
"page[cursor]"?: string;
|
|
15363
15723
|
/**
|
|
15364
|
-
* @description
|
|
15724
|
+
* @description Include related resources. Available relationships: credits
|
|
15365
15725
|
* @example credits.artist.albums
|
|
15366
15726
|
*/
|
|
15367
15727
|
include?: string[];
|
|
@@ -15427,7 +15787,7 @@ export interface paths {
|
|
|
15427
15787
|
parameters: {
|
|
15428
15788
|
query?: {
|
|
15429
15789
|
/**
|
|
15430
|
-
* @description
|
|
15790
|
+
* @description Include related resources. Available relationships: download
|
|
15431
15791
|
* @example download
|
|
15432
15792
|
*/
|
|
15433
15793
|
include?: string[];
|
|
@@ -15493,7 +15853,7 @@ export interface paths {
|
|
|
15493
15853
|
*/
|
|
15494
15854
|
countryCode?: string;
|
|
15495
15855
|
/**
|
|
15496
|
-
* @description
|
|
15856
|
+
* @description Include related resources. Available relationships: genres
|
|
15497
15857
|
* @example genres
|
|
15498
15858
|
*/
|
|
15499
15859
|
include?: string[];
|
|
@@ -15556,7 +15916,7 @@ export interface paths {
|
|
|
15556
15916
|
parameters: {
|
|
15557
15917
|
query?: {
|
|
15558
15918
|
/**
|
|
15559
|
-
* @description
|
|
15919
|
+
* @description Include related resources. Available relationships: lyrics
|
|
15560
15920
|
* @example lyrics.track
|
|
15561
15921
|
*/
|
|
15562
15922
|
include?: string[];
|
|
@@ -15624,7 +15984,7 @@ export interface paths {
|
|
|
15624
15984
|
parameters: {
|
|
15625
15985
|
query?: {
|
|
15626
15986
|
/**
|
|
15627
|
-
* @description
|
|
15987
|
+
* @description Include related resources. Available relationships: metadataStatus
|
|
15628
15988
|
* @example metadataStatus
|
|
15629
15989
|
*/
|
|
15630
15990
|
include?: string[];
|
|
@@ -15685,7 +16045,7 @@ export interface paths {
|
|
|
15685
16045
|
parameters: {
|
|
15686
16046
|
query?: {
|
|
15687
16047
|
/**
|
|
15688
|
-
* @description
|
|
16048
|
+
* @description Include related resources. Available relationships: owners
|
|
15689
16049
|
* @example owners
|
|
15690
16050
|
*/
|
|
15691
16051
|
include?: string[];
|
|
@@ -15753,7 +16113,7 @@ export interface paths {
|
|
|
15753
16113
|
*/
|
|
15754
16114
|
countryCode?: string;
|
|
15755
16115
|
/**
|
|
15756
|
-
* @description
|
|
16116
|
+
* @description Include related resources. Available relationships: priceConfig
|
|
15757
16117
|
* @example priceConfig
|
|
15758
16118
|
*/
|
|
15759
16119
|
include?: string[];
|
|
@@ -15819,7 +16179,7 @@ export interface paths {
|
|
|
15819
16179
|
*/
|
|
15820
16180
|
countryCode?: string;
|
|
15821
16181
|
/**
|
|
15822
|
-
* @description
|
|
16182
|
+
* @description Include related resources. Available relationships: providers
|
|
15823
16183
|
* @example providers
|
|
15824
16184
|
*/
|
|
15825
16185
|
include?: string[];
|
|
@@ -15882,7 +16242,7 @@ export interface paths {
|
|
|
15882
16242
|
parameters: {
|
|
15883
16243
|
query?: {
|
|
15884
16244
|
/**
|
|
15885
|
-
* @description
|
|
16245
|
+
* @description Include related resources. Available relationships: radio
|
|
15886
16246
|
* @example radio.items
|
|
15887
16247
|
*/
|
|
15888
16248
|
include?: string[];
|
|
@@ -15955,7 +16315,7 @@ export interface paths {
|
|
|
15955
16315
|
*/
|
|
15956
16316
|
countryCode?: string;
|
|
15957
16317
|
/**
|
|
15958
|
-
* @description
|
|
16318
|
+
* @description Include related resources. Available relationships: replacement
|
|
15959
16319
|
* @example replacement
|
|
15960
16320
|
*/
|
|
15961
16321
|
include?: string[];
|
|
@@ -16021,7 +16381,7 @@ export interface paths {
|
|
|
16021
16381
|
parameters: {
|
|
16022
16382
|
query?: {
|
|
16023
16383
|
/**
|
|
16024
|
-
* @description
|
|
16384
|
+
* @description Include related resources. Available relationships: shares
|
|
16025
16385
|
* @example shares.sharedResources
|
|
16026
16386
|
*/
|
|
16027
16387
|
include?: string[];
|
|
@@ -16096,7 +16456,7 @@ export interface paths {
|
|
|
16096
16456
|
*/
|
|
16097
16457
|
countryCode?: string;
|
|
16098
16458
|
/**
|
|
16099
|
-
* @description
|
|
16459
|
+
* @description Include related resources. Available relationships: similarTracks
|
|
16100
16460
|
* @example similarTracks
|
|
16101
16461
|
*/
|
|
16102
16462
|
include?: string[];
|
|
@@ -16162,7 +16522,7 @@ export interface paths {
|
|
|
16162
16522
|
parameters: {
|
|
16163
16523
|
query?: {
|
|
16164
16524
|
/**
|
|
16165
|
-
* @description
|
|
16525
|
+
* @description Include related resources. Available relationships: sourceFile
|
|
16166
16526
|
* @example sourceFile
|
|
16167
16527
|
*/
|
|
16168
16528
|
include?: string[];
|
|
@@ -16230,7 +16590,7 @@ export interface paths {
|
|
|
16230
16590
|
*/
|
|
16231
16591
|
countryCode?: string;
|
|
16232
16592
|
/**
|
|
16233
|
-
* @description
|
|
16593
|
+
* @description Include related resources. Available relationships: suggestedTracks
|
|
16234
16594
|
* @example suggestedTracks
|
|
16235
16595
|
*/
|
|
16236
16596
|
include?: string[];
|
|
@@ -16296,7 +16656,7 @@ export interface paths {
|
|
|
16296
16656
|
parameters: {
|
|
16297
16657
|
query?: {
|
|
16298
16658
|
/**
|
|
16299
|
-
* @description
|
|
16659
|
+
* @description Include related resources. Available relationships: trackStatistics
|
|
16300
16660
|
* @example trackStatistics
|
|
16301
16661
|
*/
|
|
16302
16662
|
include?: string[];
|
|
@@ -16362,7 +16722,7 @@ export interface paths {
|
|
|
16362
16722
|
*/
|
|
16363
16723
|
countryCode?: string;
|
|
16364
16724
|
/**
|
|
16365
|
-
* @description
|
|
16725
|
+
* @description Include related resources. Available relationships: usageRules
|
|
16366
16726
|
* @example usageRules
|
|
16367
16727
|
*/
|
|
16368
16728
|
include?: string[];
|
|
@@ -16590,10 +16950,12 @@ export interface paths {
|
|
|
16590
16950
|
*/
|
|
16591
16951
|
locale?: string;
|
|
16592
16952
|
/**
|
|
16593
|
-
* @description
|
|
16953
|
+
* @description Include related resources. Available relationships: items, owners
|
|
16594
16954
|
* @example items
|
|
16595
16955
|
*/
|
|
16596
16956
|
include?: string[];
|
|
16957
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
16958
|
+
includeLinkage?: ("items" | "owners")[];
|
|
16597
16959
|
/**
|
|
16598
16960
|
* @description 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
|
|
16599
16961
|
* @example items
|
|
@@ -16663,10 +17025,12 @@ export interface paths {
|
|
|
16663
17025
|
*/
|
|
16664
17026
|
locale?: string;
|
|
16665
17027
|
/**
|
|
16666
|
-
* @description
|
|
17028
|
+
* @description Include related resources. Available relationships: items
|
|
16667
17029
|
* @example items
|
|
16668
17030
|
*/
|
|
16669
17031
|
include?: string[];
|
|
17032
|
+
/** @description Filter albums by a free-text query matched against the album title and artist names. Internal clients only (e.g. `love`) */
|
|
17033
|
+
"filter[query]"?: string;
|
|
16670
17034
|
/**
|
|
16671
17035
|
* @description 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
|
|
16672
17036
|
* @example items
|
|
@@ -16695,6 +17059,7 @@ export interface paths {
|
|
|
16695
17059
|
};
|
|
16696
17060
|
};
|
|
16697
17061
|
400: components["responses"]["Default400Response"];
|
|
17062
|
+
403: components["responses"]["UserCollectionAlbumsReadMultiDataRelationship403Response"];
|
|
16698
17063
|
404: components["responses"]["Default404Response"];
|
|
16699
17064
|
405: components["responses"]["Default405Response"];
|
|
16700
17065
|
406: components["responses"]["Default406Response"];
|
|
@@ -16819,7 +17184,7 @@ export interface paths {
|
|
|
16819
17184
|
parameters: {
|
|
16820
17185
|
query?: {
|
|
16821
17186
|
/**
|
|
16822
|
-
* @description
|
|
17187
|
+
* @description Include related resources. Available relationships: owners
|
|
16823
17188
|
* @example owners
|
|
16824
17189
|
*/
|
|
16825
17190
|
include?: string[];
|
|
@@ -16885,10 +17250,12 @@ export interface paths {
|
|
|
16885
17250
|
*/
|
|
16886
17251
|
locale?: string;
|
|
16887
17252
|
/**
|
|
16888
|
-
* @description
|
|
17253
|
+
* @description Include related resources. Available relationships: items, owners
|
|
16889
17254
|
* @example items.albums
|
|
16890
17255
|
*/
|
|
16891
17256
|
include?: string[];
|
|
17257
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
17258
|
+
includeLinkage?: ("items" | "owners")[];
|
|
16892
17259
|
/**
|
|
16893
17260
|
* @description 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
|
|
16894
17261
|
* @example items.albums
|
|
@@ -16958,10 +17325,12 @@ export interface paths {
|
|
|
16958
17325
|
*/
|
|
16959
17326
|
locale?: string;
|
|
16960
17327
|
/**
|
|
16961
|
-
* @description
|
|
17328
|
+
* @description Include related resources. Available relationships: items
|
|
16962
17329
|
* @example items.albums
|
|
16963
17330
|
*/
|
|
16964
17331
|
include?: string[];
|
|
17332
|
+
/** @description Filter artists by a free-text query matched against the artist name. Internal clients only (e.g. `love`) */
|
|
17333
|
+
"filter[query]"?: string;
|
|
16965
17334
|
/**
|
|
16966
17335
|
* @description 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
|
|
16967
17336
|
* @example items.albums
|
|
@@ -16990,6 +17359,7 @@ export interface paths {
|
|
|
16990
17359
|
};
|
|
16991
17360
|
};
|
|
16992
17361
|
400: components["responses"]["Default400Response"];
|
|
17362
|
+
403: components["responses"]["UserCollectionArtistsReadMultiDataRelationship403Response"];
|
|
16993
17363
|
404: components["responses"]["Default404Response"];
|
|
16994
17364
|
405: components["responses"]["Default405Response"];
|
|
16995
17365
|
406: components["responses"]["Default406Response"];
|
|
@@ -17114,7 +17484,7 @@ export interface paths {
|
|
|
17114
17484
|
parameters: {
|
|
17115
17485
|
query?: {
|
|
17116
17486
|
/**
|
|
17117
|
-
* @description
|
|
17487
|
+
* @description Include related resources. Available relationships: owners
|
|
17118
17488
|
* @example owners
|
|
17119
17489
|
*/
|
|
17120
17490
|
include?: string[];
|
|
@@ -17177,10 +17547,12 @@ export interface paths {
|
|
|
17177
17547
|
/** @description Folder Id (e.g. `CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX`) */
|
|
17178
17548
|
"filter[id]": string[];
|
|
17179
17549
|
/**
|
|
17180
|
-
* @description
|
|
17550
|
+
* @description Include related resources. Available relationships: items, owners, userCollection
|
|
17181
17551
|
* @example items.items
|
|
17182
17552
|
*/
|
|
17183
17553
|
include?: string[];
|
|
17554
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
17555
|
+
includeLinkage?: ("items" | "owners" | "userCollection")[];
|
|
17184
17556
|
/**
|
|
17185
17557
|
* @description 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
|
|
17186
17558
|
* @example items.items
|
|
@@ -17275,10 +17647,12 @@ export interface paths {
|
|
|
17275
17647
|
parameters: {
|
|
17276
17648
|
query?: {
|
|
17277
17649
|
/**
|
|
17278
|
-
* @description
|
|
17650
|
+
* @description Include related resources. Available relationships: items, owners, userCollection
|
|
17279
17651
|
* @example items.items
|
|
17280
17652
|
*/
|
|
17281
17653
|
include?: string[];
|
|
17654
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
17655
|
+
includeLinkage?: ("items" | "owners" | "userCollection")[];
|
|
17282
17656
|
/**
|
|
17283
17657
|
* @description 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
|
|
17284
17658
|
* @example items.items
|
|
@@ -17431,7 +17805,7 @@ export interface paths {
|
|
|
17431
17805
|
/** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */
|
|
17432
17806
|
sort?: ("addedAt" | "-addedAt" | "lastModifiedAt" | "-lastModifiedAt" | "name" | "-name")[];
|
|
17433
17807
|
/**
|
|
17434
|
-
* @description
|
|
17808
|
+
* @description Include related resources. Available relationships: items
|
|
17435
17809
|
* @example items.items
|
|
17436
17810
|
*/
|
|
17437
17811
|
include?: string[];
|
|
@@ -17587,7 +17961,7 @@ export interface paths {
|
|
|
17587
17961
|
parameters: {
|
|
17588
17962
|
query?: {
|
|
17589
17963
|
/**
|
|
17590
|
-
* @description
|
|
17964
|
+
* @description Include related resources. Available relationships: owners
|
|
17591
17965
|
* @example owners
|
|
17592
17966
|
*/
|
|
17593
17967
|
include?: string[];
|
|
@@ -17648,7 +18022,7 @@ export interface paths {
|
|
|
17648
18022
|
parameters: {
|
|
17649
18023
|
query?: {
|
|
17650
18024
|
/**
|
|
17651
|
-
* @description
|
|
18025
|
+
* @description Include related resources. Available relationships: userCollection
|
|
17652
18026
|
* @example userCollection.items.items
|
|
17653
18027
|
*/
|
|
17654
18028
|
include?: string[];
|
|
@@ -17717,10 +18091,12 @@ export interface paths {
|
|
|
17717
18091
|
*/
|
|
17718
18092
|
locale?: string;
|
|
17719
18093
|
/**
|
|
17720
|
-
* @description
|
|
18094
|
+
* @description Include related resources. Available relationships: items, owners
|
|
17721
18095
|
* @example items.items
|
|
17722
18096
|
*/
|
|
17723
18097
|
include?: string[];
|
|
18098
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
18099
|
+
includeLinkage?: ("items" | "owners")[];
|
|
17724
18100
|
/**
|
|
17725
18101
|
* @description 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
|
|
17726
18102
|
* @example items.items
|
|
@@ -17786,7 +18162,7 @@ export interface paths {
|
|
|
17786
18162
|
/** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */
|
|
17787
18163
|
sort?: ("addedAt" | "-addedAt" | "lastModifiedAt" | "-lastModifiedAt" | "name" | "-name")[];
|
|
17788
18164
|
/**
|
|
17789
|
-
* @description
|
|
18165
|
+
* @description Include related resources. Available relationships: items
|
|
17790
18166
|
* @example items.items
|
|
17791
18167
|
*/
|
|
17792
18168
|
include?: string[];
|
|
@@ -17820,6 +18196,7 @@ export interface paths {
|
|
|
17820
18196
|
};
|
|
17821
18197
|
};
|
|
17822
18198
|
400: components["responses"]["Default400Response"];
|
|
18199
|
+
403: components["responses"]["UserCollectionPlaylistsReadMultiDataRelationship403Response"];
|
|
17823
18200
|
404: components["responses"]["Default404Response"];
|
|
17824
18201
|
405: components["responses"]["Default405Response"];
|
|
17825
18202
|
406: components["responses"]["Default406Response"];
|
|
@@ -17944,7 +18321,7 @@ export interface paths {
|
|
|
17944
18321
|
parameters: {
|
|
17945
18322
|
query?: {
|
|
17946
18323
|
/**
|
|
17947
|
-
* @description
|
|
18324
|
+
* @description Include related resources. Available relationships: owners
|
|
17948
18325
|
* @example owners
|
|
17949
18326
|
*/
|
|
17950
18327
|
include?: string[];
|
|
@@ -18005,10 +18382,12 @@ export interface paths {
|
|
|
18005
18382
|
parameters: {
|
|
18006
18383
|
query?: {
|
|
18007
18384
|
/**
|
|
18008
|
-
* @description
|
|
18385
|
+
* @description Include related resources. Available relationships: items, owners
|
|
18009
18386
|
* @example items
|
|
18010
18387
|
*/
|
|
18011
18388
|
include?: string[];
|
|
18389
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
18390
|
+
includeLinkage?: ("items" | "owners")[];
|
|
18012
18391
|
/**
|
|
18013
18392
|
* @description 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
|
|
18014
18393
|
* @example items
|
|
@@ -18071,7 +18450,7 @@ export interface paths {
|
|
|
18071
18450
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
18072
18451
|
"page[cursor]"?: string;
|
|
18073
18452
|
/**
|
|
18074
|
-
* @description
|
|
18453
|
+
* @description Include related resources. Available relationships: items
|
|
18075
18454
|
* @example items
|
|
18076
18455
|
*/
|
|
18077
18456
|
include?: string[];
|
|
@@ -18227,7 +18606,7 @@ export interface paths {
|
|
|
18227
18606
|
parameters: {
|
|
18228
18607
|
query?: {
|
|
18229
18608
|
/**
|
|
18230
|
-
* @description
|
|
18609
|
+
* @description Include related resources. Available relationships: owners
|
|
18231
18610
|
* @example owners
|
|
18232
18611
|
*/
|
|
18233
18612
|
include?: string[];
|
|
@@ -18293,10 +18672,12 @@ export interface paths {
|
|
|
18293
18672
|
*/
|
|
18294
18673
|
locale?: string;
|
|
18295
18674
|
/**
|
|
18296
|
-
* @description
|
|
18675
|
+
* @description Include related resources. Available relationships: items, owners
|
|
18297
18676
|
* @example items
|
|
18298
18677
|
*/
|
|
18299
18678
|
include?: string[];
|
|
18679
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
18680
|
+
includeLinkage?: ("items" | "owners")[];
|
|
18300
18681
|
/**
|
|
18301
18682
|
* @description 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
|
|
18302
18683
|
* @example items
|
|
@@ -18366,10 +18747,12 @@ export interface paths {
|
|
|
18366
18747
|
*/
|
|
18367
18748
|
locale?: string;
|
|
18368
18749
|
/**
|
|
18369
|
-
* @description
|
|
18750
|
+
* @description Include related resources. Available relationships: items
|
|
18370
18751
|
* @example items
|
|
18371
18752
|
*/
|
|
18372
18753
|
include?: string[];
|
|
18754
|
+
/** @description Filter tracks by a free-text query matched against the track title, artist names and album title. Internal clients only (e.g. `love`) */
|
|
18755
|
+
"filter[query]"?: string;
|
|
18373
18756
|
/**
|
|
18374
18757
|
* @description 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
|
|
18375
18758
|
* @example items
|
|
@@ -18398,6 +18781,7 @@ export interface paths {
|
|
|
18398
18781
|
};
|
|
18399
18782
|
};
|
|
18400
18783
|
400: components["responses"]["Default400Response"];
|
|
18784
|
+
403: components["responses"]["UserCollectionTracksReadMultiDataRelationship403Response"];
|
|
18401
18785
|
404: components["responses"]["Default404Response"];
|
|
18402
18786
|
405: components["responses"]["Default405Response"];
|
|
18403
18787
|
406: components["responses"]["Default406Response"];
|
|
@@ -18522,7 +18906,7 @@ export interface paths {
|
|
|
18522
18906
|
parameters: {
|
|
18523
18907
|
query?: {
|
|
18524
18908
|
/**
|
|
18525
|
-
* @description
|
|
18909
|
+
* @description Include related resources. Available relationships: owners
|
|
18526
18910
|
* @example owners
|
|
18527
18911
|
*/
|
|
18528
18912
|
include?: string[];
|
|
@@ -18588,10 +18972,12 @@ export interface paths {
|
|
|
18588
18972
|
*/
|
|
18589
18973
|
locale?: string;
|
|
18590
18974
|
/**
|
|
18591
|
-
* @description
|
|
18975
|
+
* @description Include related resources. Available relationships: items, owners
|
|
18592
18976
|
* @example items
|
|
18593
18977
|
*/
|
|
18594
18978
|
include?: string[];
|
|
18979
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
18980
|
+
includeLinkage?: ("items" | "owners")[];
|
|
18595
18981
|
/**
|
|
18596
18982
|
* @description 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
|
|
18597
18983
|
* @example items
|
|
@@ -18661,10 +19047,12 @@ export interface paths {
|
|
|
18661
19047
|
*/
|
|
18662
19048
|
locale?: string;
|
|
18663
19049
|
/**
|
|
18664
|
-
* @description
|
|
19050
|
+
* @description Include related resources. Available relationships: items
|
|
18665
19051
|
* @example items
|
|
18666
19052
|
*/
|
|
18667
19053
|
include?: string[];
|
|
19054
|
+
/** @description Filter videos by a free-text query matched against the video title and artist names. Internal clients only (e.g. `love`) */
|
|
19055
|
+
"filter[query]"?: string;
|
|
18668
19056
|
/**
|
|
18669
19057
|
* @description 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
|
|
18670
19058
|
* @example items
|
|
@@ -18693,6 +19081,7 @@ export interface paths {
|
|
|
18693
19081
|
};
|
|
18694
19082
|
};
|
|
18695
19083
|
400: components["responses"]["Default400Response"];
|
|
19084
|
+
403: components["responses"]["UserCollectionVideosReadMultiDataRelationship403Response"];
|
|
18696
19085
|
404: components["responses"]["Default404Response"];
|
|
18697
19086
|
405: components["responses"]["Default405Response"];
|
|
18698
19087
|
406: components["responses"]["Default406Response"];
|
|
@@ -18817,7 +19206,7 @@ export interface paths {
|
|
|
18817
19206
|
parameters: {
|
|
18818
19207
|
query?: {
|
|
18819
19208
|
/**
|
|
18820
|
-
* @description
|
|
19209
|
+
* @description Include related resources. Available relationships: owners
|
|
18821
19210
|
* @example owners
|
|
18822
19211
|
*/
|
|
18823
19212
|
include?: string[];
|
|
@@ -18883,10 +19272,12 @@ export interface paths {
|
|
|
18883
19272
|
*/
|
|
18884
19273
|
locale?: string;
|
|
18885
19274
|
/**
|
|
18886
|
-
* @description
|
|
19275
|
+
* @description Include related resources. Available relationships: items
|
|
18887
19276
|
* @example items.items
|
|
18888
19277
|
*/
|
|
18889
19278
|
include?: string[];
|
|
19279
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
19280
|
+
includeLinkage?: "items"[];
|
|
18890
19281
|
/**
|
|
18891
19282
|
* @description 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
|
|
18892
19283
|
* @example items.items
|
|
@@ -18954,7 +19345,7 @@ export interface paths {
|
|
|
18954
19345
|
*/
|
|
18955
19346
|
locale?: string;
|
|
18956
19347
|
/**
|
|
18957
|
-
* @description
|
|
19348
|
+
* @description Include related resources. Available relationships: items
|
|
18958
19349
|
* @example items.items
|
|
18959
19350
|
*/
|
|
18960
19351
|
include?: string[];
|
|
@@ -19079,10 +19470,12 @@ export interface paths {
|
|
|
19079
19470
|
*/
|
|
19080
19471
|
locale?: string;
|
|
19081
19472
|
/**
|
|
19082
|
-
* @description
|
|
19473
|
+
* @description Include related resources. Available relationships: items
|
|
19083
19474
|
* @example items.items
|
|
19084
19475
|
*/
|
|
19085
19476
|
include?: string[];
|
|
19477
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
19478
|
+
includeLinkage?: "items"[];
|
|
19086
19479
|
/**
|
|
19087
19480
|
* @description 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
|
|
19088
19481
|
* @example items.items
|
|
@@ -19150,7 +19543,7 @@ export interface paths {
|
|
|
19150
19543
|
*/
|
|
19151
19544
|
locale?: string;
|
|
19152
19545
|
/**
|
|
19153
|
-
* @description
|
|
19546
|
+
* @description Include related resources. Available relationships: items
|
|
19154
19547
|
* @example items.items
|
|
19155
19548
|
*/
|
|
19156
19549
|
include?: string[];
|
|
@@ -19219,10 +19612,12 @@ export interface paths {
|
|
|
19219
19612
|
*/
|
|
19220
19613
|
locale?: string;
|
|
19221
19614
|
/**
|
|
19222
|
-
* @description
|
|
19615
|
+
* @description Include related resources. Available relationships: items
|
|
19223
19616
|
* @example items.items
|
|
19224
19617
|
*/
|
|
19225
19618
|
include?: string[];
|
|
19619
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
19620
|
+
includeLinkage?: "items"[];
|
|
19226
19621
|
/**
|
|
19227
19622
|
* @description 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
|
|
19228
19623
|
* @example items.items
|
|
@@ -19290,7 +19685,7 @@ export interface paths {
|
|
|
19290
19685
|
*/
|
|
19291
19686
|
locale?: string;
|
|
19292
19687
|
/**
|
|
19293
|
-
* @description
|
|
19688
|
+
* @description Include related resources. Available relationships: items
|
|
19294
19689
|
* @example items.items
|
|
19295
19690
|
*/
|
|
19296
19691
|
include?: string[];
|
|
@@ -19359,10 +19754,12 @@ export interface paths {
|
|
|
19359
19754
|
*/
|
|
19360
19755
|
locale?: string;
|
|
19361
19756
|
/**
|
|
19362
|
-
* @description
|
|
19757
|
+
* @description Include related resources. Available relationships: items
|
|
19363
19758
|
* @example items.items
|
|
19364
19759
|
*/
|
|
19365
19760
|
include?: string[];
|
|
19761
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
19762
|
+
includeLinkage?: "items"[];
|
|
19366
19763
|
/**
|
|
19367
19764
|
* @description 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
|
|
19368
19765
|
* @example items.items
|
|
@@ -19430,7 +19827,7 @@ export interface paths {
|
|
|
19430
19827
|
*/
|
|
19431
19828
|
locale?: string;
|
|
19432
19829
|
/**
|
|
19433
|
-
* @description
|
|
19830
|
+
* @description Include related resources. Available relationships: items
|
|
19434
19831
|
* @example items.items
|
|
19435
19832
|
*/
|
|
19436
19833
|
include?: string[];
|
|
@@ -19494,10 +19891,12 @@ export interface paths {
|
|
|
19494
19891
|
parameters: {
|
|
19495
19892
|
query?: {
|
|
19496
19893
|
/**
|
|
19497
|
-
* @description
|
|
19894
|
+
* @description Include related resources. Available relationships: activePlayer, availablePlayers, changeEventStream, playQueue
|
|
19498
19895
|
* @example activePlayer.offlineInventory
|
|
19499
19896
|
*/
|
|
19500
19897
|
include?: string[];
|
|
19898
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
19899
|
+
includeLinkage?: ("activePlayer" | "availablePlayers" | "changeEventStream" | "playQueue")[];
|
|
19501
19900
|
/**
|
|
19502
19901
|
* @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: activePlayer.offlineInventory
|
|
19503
19902
|
* @example activePlayer.offlineInventory
|
|
@@ -19604,7 +20003,7 @@ export interface paths {
|
|
|
19604
20003
|
parameters: {
|
|
19605
20004
|
query?: {
|
|
19606
20005
|
/**
|
|
19607
|
-
* @description
|
|
20006
|
+
* @description Include related resources. Available relationships: activePlayer
|
|
19608
20007
|
* @example activePlayer.offlineInventory
|
|
19609
20008
|
*/
|
|
19610
20009
|
include?: string[];
|
|
@@ -19714,7 +20113,7 @@ export interface paths {
|
|
|
19714
20113
|
parameters: {
|
|
19715
20114
|
query?: {
|
|
19716
20115
|
/**
|
|
19717
|
-
* @description
|
|
20116
|
+
* @description Include related resources. Available relationships: availablePlayers
|
|
19718
20117
|
* @example availablePlayers.offlineInventory
|
|
19719
20118
|
*/
|
|
19720
20119
|
include?: string[];
|
|
@@ -19872,7 +20271,7 @@ export interface paths {
|
|
|
19872
20271
|
parameters: {
|
|
19873
20272
|
query?: {
|
|
19874
20273
|
/**
|
|
19875
|
-
* @description
|
|
20274
|
+
* @description Include related resources. Available relationships: changeEventStream
|
|
19876
20275
|
* @example changeEventStream
|
|
19877
20276
|
*/
|
|
19878
20277
|
include?: string[];
|
|
@@ -19927,7 +20326,7 @@ export interface paths {
|
|
|
19927
20326
|
parameters: {
|
|
19928
20327
|
query?: {
|
|
19929
20328
|
/**
|
|
19930
|
-
* @description
|
|
20329
|
+
* @description Include related resources. Available relationships: playQueue
|
|
19931
20330
|
* @example playQueue.current
|
|
19932
20331
|
*/
|
|
19933
20332
|
include?: string[];
|
|
@@ -20042,10 +20441,12 @@ export interface paths {
|
|
|
20042
20441
|
*/
|
|
20043
20442
|
locale?: string;
|
|
20044
20443
|
/**
|
|
20045
|
-
* @description
|
|
20444
|
+
* @description Include related resources. Available relationships: artists, owners, tracks, videos
|
|
20046
20445
|
* @example artists.albums
|
|
20047
20446
|
*/
|
|
20048
20447
|
include?: string[];
|
|
20448
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
20449
|
+
includeLinkage?: ("artists" | "owners" | "tracks" | "videos")[];
|
|
20049
20450
|
/**
|
|
20050
20451
|
* @description 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
|
|
20051
20452
|
* @example artists.albums
|
|
@@ -20108,7 +20509,7 @@ export interface paths {
|
|
|
20108
20509
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
20109
20510
|
"page[cursor]"?: string;
|
|
20110
20511
|
/**
|
|
20111
|
-
* @description
|
|
20512
|
+
* @description Include related resources. Available relationships: artists
|
|
20112
20513
|
* @example artists.albums
|
|
20113
20514
|
*/
|
|
20114
20515
|
include?: string[];
|
|
@@ -20264,7 +20665,7 @@ export interface paths {
|
|
|
20264
20665
|
parameters: {
|
|
20265
20666
|
query?: {
|
|
20266
20667
|
/**
|
|
20267
|
-
* @description
|
|
20668
|
+
* @description Include related resources. Available relationships: owners
|
|
20268
20669
|
* @example owners
|
|
20269
20670
|
*/
|
|
20270
20671
|
include?: string[];
|
|
@@ -20327,7 +20728,7 @@ export interface paths {
|
|
|
20327
20728
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
20328
20729
|
"page[cursor]"?: string;
|
|
20329
20730
|
/**
|
|
20330
|
-
* @description
|
|
20731
|
+
* @description Include related resources. Available relationships: tracks
|
|
20331
20732
|
* @example tracks
|
|
20332
20733
|
*/
|
|
20333
20734
|
include?: string[];
|
|
@@ -20485,7 +20886,7 @@ export interface paths {
|
|
|
20485
20886
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
20486
20887
|
"page[cursor]"?: string;
|
|
20487
20888
|
/**
|
|
20488
|
-
* @description
|
|
20889
|
+
* @description Include related resources. Available relationships: videos
|
|
20489
20890
|
* @example videos
|
|
20490
20891
|
*/
|
|
20491
20892
|
include?: string[];
|
|
@@ -20700,10 +21101,12 @@ export interface paths {
|
|
|
20700
21101
|
/** @description User id. Use `me` for the authenticated user */
|
|
20701
21102
|
"filter[owners.id]": string[];
|
|
20702
21103
|
/**
|
|
20703
|
-
* @description
|
|
21104
|
+
* @description Include related resources. Available relationships: decision
|
|
20704
21105
|
* @example decision
|
|
20705
21106
|
*/
|
|
20706
21107
|
include?: string[];
|
|
21108
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
21109
|
+
includeLinkage?: "decision"[];
|
|
20707
21110
|
};
|
|
20708
21111
|
header?: never;
|
|
20709
21112
|
path?: never;
|
|
@@ -20753,7 +21156,7 @@ export interface paths {
|
|
|
20753
21156
|
parameters: {
|
|
20754
21157
|
query?: {
|
|
20755
21158
|
/**
|
|
20756
|
-
* @description
|
|
21159
|
+
* @description Include related resources. Available relationships: decision
|
|
20757
21160
|
* @example decision
|
|
20758
21161
|
*/
|
|
20759
21162
|
include?: string[];
|
|
@@ -20812,10 +21215,12 @@ export interface paths {
|
|
|
20812
21215
|
parameters: {
|
|
20813
21216
|
query?: {
|
|
20814
21217
|
/**
|
|
20815
|
-
* @description
|
|
21218
|
+
* @description Include related resources. Available relationships: artist
|
|
20816
21219
|
* @example artist.albums
|
|
20817
21220
|
*/
|
|
20818
21221
|
include?: string[];
|
|
21222
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
21223
|
+
includeLinkage?: "artist"[];
|
|
20819
21224
|
/**
|
|
20820
21225
|
* @description 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
|
|
20821
21226
|
* @example artist.albums
|
|
@@ -20876,7 +21281,7 @@ export interface paths {
|
|
|
20876
21281
|
parameters: {
|
|
20877
21282
|
query?: {
|
|
20878
21283
|
/**
|
|
20879
|
-
* @description
|
|
21284
|
+
* @description Include related resources. Available relationships: artist
|
|
20880
21285
|
* @example artist.albums
|
|
20881
21286
|
*/
|
|
20882
21287
|
include?: string[];
|
|
@@ -21002,7 +21407,7 @@ export interface paths {
|
|
|
21002
21407
|
*/
|
|
21003
21408
|
countryCode?: string;
|
|
21004
21409
|
/**
|
|
21005
|
-
* @description
|
|
21410
|
+
* @description Include related resources. Available relationships: albums, artists, credits, providers, replacement, similarVideos, suggestedVideos, thumbnailArt, usageRules
|
|
21006
21411
|
* @example albums
|
|
21007
21412
|
*/
|
|
21008
21413
|
include?: string[];
|
|
@@ -21010,6 +21415,8 @@ export interface paths {
|
|
|
21010
21415
|
"filter[id]"?: string[];
|
|
21011
21416
|
/** @description List of ISRCs (e.g. `QMJMT1701237`) */
|
|
21012
21417
|
"filter[isrc]"?: string[];
|
|
21418
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
21419
|
+
includeLinkage?: ("albums" | "artists" | "credits" | "providers" | "replacement" | "similarVideos" | "suggestedVideos" | "thumbnailArt" | "usageRules")[];
|
|
21013
21420
|
/**
|
|
21014
21421
|
* @description 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
|
|
21015
21422
|
* @example albums
|
|
@@ -21069,10 +21476,12 @@ export interface paths {
|
|
|
21069
21476
|
*/
|
|
21070
21477
|
countryCode?: string;
|
|
21071
21478
|
/**
|
|
21072
|
-
* @description
|
|
21479
|
+
* @description Include related resources. Available relationships: albums, artists, credits, providers, replacement, similarVideos, suggestedVideos, thumbnailArt, usageRules
|
|
21073
21480
|
* @example albums
|
|
21074
21481
|
*/
|
|
21075
21482
|
include?: string[];
|
|
21483
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
21484
|
+
includeLinkage?: ("albums" | "artists" | "credits" | "providers" | "replacement" | "similarVideos" | "suggestedVideos" | "thumbnailArt" | "usageRules")[];
|
|
21076
21485
|
/**
|
|
21077
21486
|
* @description 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
|
|
21078
21487
|
* @example albums
|
|
@@ -21140,7 +21549,7 @@ export interface paths {
|
|
|
21140
21549
|
*/
|
|
21141
21550
|
countryCode?: string;
|
|
21142
21551
|
/**
|
|
21143
|
-
* @description
|
|
21552
|
+
* @description Include related resources. Available relationships: albums
|
|
21144
21553
|
* @example albums
|
|
21145
21554
|
*/
|
|
21146
21555
|
include?: string[];
|
|
@@ -21211,7 +21620,7 @@ export interface paths {
|
|
|
21211
21620
|
*/
|
|
21212
21621
|
countryCode?: string;
|
|
21213
21622
|
/**
|
|
21214
|
-
* @description
|
|
21623
|
+
* @description Include related resources. Available relationships: artists
|
|
21215
21624
|
* @example artists.albums
|
|
21216
21625
|
*/
|
|
21217
21626
|
include?: string[];
|
|
@@ -21277,7 +21686,7 @@ export interface paths {
|
|
|
21277
21686
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
21278
21687
|
"page[cursor]"?: string;
|
|
21279
21688
|
/**
|
|
21280
|
-
* @description
|
|
21689
|
+
* @description Include related resources. Available relationships: credits
|
|
21281
21690
|
* @example credits.artist.albums
|
|
21282
21691
|
*/
|
|
21283
21692
|
include?: string[];
|
|
@@ -21348,7 +21757,7 @@ export interface paths {
|
|
|
21348
21757
|
*/
|
|
21349
21758
|
countryCode?: string;
|
|
21350
21759
|
/**
|
|
21351
|
-
* @description
|
|
21760
|
+
* @description Include related resources. Available relationships: providers
|
|
21352
21761
|
* @example providers
|
|
21353
21762
|
*/
|
|
21354
21763
|
include?: string[];
|
|
@@ -21412,7 +21821,7 @@ export interface paths {
|
|
|
21412
21821
|
*/
|
|
21413
21822
|
countryCode?: string;
|
|
21414
21823
|
/**
|
|
21415
|
-
* @description
|
|
21824
|
+
* @description Include related resources. Available relationships: replacement
|
|
21416
21825
|
* @example replacement
|
|
21417
21826
|
*/
|
|
21418
21827
|
include?: string[];
|
|
@@ -21483,7 +21892,7 @@ export interface paths {
|
|
|
21483
21892
|
*/
|
|
21484
21893
|
countryCode?: string;
|
|
21485
21894
|
/**
|
|
21486
|
-
* @description
|
|
21895
|
+
* @description Include related resources. Available relationships: similarVideos
|
|
21487
21896
|
* @example similarVideos
|
|
21488
21897
|
*/
|
|
21489
21898
|
include?: string[];
|
|
@@ -21554,7 +21963,7 @@ export interface paths {
|
|
|
21554
21963
|
*/
|
|
21555
21964
|
countryCode?: string;
|
|
21556
21965
|
/**
|
|
21557
|
-
* @description
|
|
21966
|
+
* @description Include related resources. Available relationships: suggestedVideos
|
|
21558
21967
|
* @example suggestedVideos
|
|
21559
21968
|
*/
|
|
21560
21969
|
include?: string[];
|
|
@@ -21625,7 +22034,7 @@ export interface paths {
|
|
|
21625
22034
|
*/
|
|
21626
22035
|
countryCode?: string;
|
|
21627
22036
|
/**
|
|
21628
|
-
* @description
|
|
22037
|
+
* @description Include related resources. Available relationships: thumbnailArt
|
|
21629
22038
|
* @example thumbnailArt
|
|
21630
22039
|
*/
|
|
21631
22040
|
include?: string[];
|
|
@@ -21689,7 +22098,7 @@ export interface paths {
|
|
|
21689
22098
|
*/
|
|
21690
22099
|
countryCode?: string;
|
|
21691
22100
|
/**
|
|
21692
|
-
* @description
|
|
22101
|
+
* @description Include related resources. Available relationships: usageRules
|
|
21693
22102
|
* @example usageRules
|
|
21694
22103
|
*/
|
|
21695
22104
|
include?: string[];
|
|
@@ -21733,39 +22142,286 @@ export interface paths {
|
|
|
21733
22142
|
patch?: never;
|
|
21734
22143
|
trace?: never;
|
|
21735
22144
|
};
|
|
21736
|
-
|
|
21737
|
-
|
|
21738
|
-
|
|
21739
|
-
|
|
21740
|
-
|
|
21741
|
-
|
|
21742
|
-
};
|
|
21743
|
-
AcceptedTermsCreateOperation_Payload_Data: {
|
|
21744
|
-
relationships: components["schemas"]["AcceptedTermsCreateOperation_Payload_Data_Relationships"];
|
|
21745
|
-
/** @enum {string} */
|
|
21746
|
-
type: "acceptedTerms";
|
|
21747
|
-
};
|
|
21748
|
-
AcceptedTermsCreateOperation_Payload_Data_Relationships: {
|
|
21749
|
-
terms: components["schemas"]["AcceptedTermsCreateOperation_Payload_Data_Relationships_Terms"];
|
|
21750
|
-
};
|
|
21751
|
-
AcceptedTermsCreateOperation_Payload_Data_Relationships_Terms: {
|
|
21752
|
-
data: components["schemas"]["AcceptedTermsCreateOperation_Payload_Data_Relationships_Terms_Data"];
|
|
21753
|
-
};
|
|
21754
|
-
AcceptedTermsCreateOperation_Payload_Data_Relationships_Terms_Data: {
|
|
21755
|
-
id: string;
|
|
21756
|
-
/** @enum {string} */
|
|
21757
|
-
type: "terms";
|
|
21758
|
-
};
|
|
21759
|
-
AcceptedTerms_Attributes: {
|
|
21760
|
-
/** Format: date-time */
|
|
21761
|
-
createdAt: string;
|
|
21762
|
-
};
|
|
21763
|
-
AcceptedTerms_Create_Single_Resource_Data_Document: {
|
|
21764
|
-
data: components["schemas"]["AcceptedTerms_Resource_Object"];
|
|
21765
|
-
links: components["schemas"]["Links"];
|
|
22145
|
+
"/viewerContexts": {
|
|
22146
|
+
parameters: {
|
|
22147
|
+
query?: never;
|
|
22148
|
+
header?: never;
|
|
22149
|
+
path?: never;
|
|
22150
|
+
cookie?: never;
|
|
21766
22151
|
};
|
|
21767
|
-
|
|
21768
|
-
|
|
22152
|
+
/**
|
|
22153
|
+
* Get multiple viewerContexts.
|
|
22154
|
+
* @description Returns viewer contexts for up to 20 original subjects. Duplicate subjects are returned once.
|
|
22155
|
+
*/
|
|
22156
|
+
get: {
|
|
22157
|
+
parameters: {
|
|
22158
|
+
query: {
|
|
22159
|
+
/** @description Original subjects to look up. */
|
|
22160
|
+
"filter[subject]": string[];
|
|
22161
|
+
/**
|
|
22162
|
+
* @description Include related resources. Available relationships: subject, viewer
|
|
22163
|
+
* @example subject
|
|
22164
|
+
*/
|
|
22165
|
+
include?: string[];
|
|
22166
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
22167
|
+
includeLinkage?: ("subject" | "viewer")[];
|
|
22168
|
+
/**
|
|
22169
|
+
* @description 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
|
|
22170
|
+
* @example subject
|
|
22171
|
+
*/
|
|
22172
|
+
replaceMedia?: string;
|
|
22173
|
+
};
|
|
22174
|
+
header?: never;
|
|
22175
|
+
path?: never;
|
|
22176
|
+
cookie?: never;
|
|
22177
|
+
};
|
|
22178
|
+
requestBody?: never;
|
|
22179
|
+
responses: {
|
|
22180
|
+
/** @description Successful response */
|
|
22181
|
+
200: {
|
|
22182
|
+
headers: {
|
|
22183
|
+
[name: string]: unknown;
|
|
22184
|
+
};
|
|
22185
|
+
content: {
|
|
22186
|
+
"application/vnd.api+json": components["schemas"]["ViewerContexts_Multi_Resource_Data_Document"];
|
|
22187
|
+
};
|
|
22188
|
+
};
|
|
22189
|
+
400: components["responses"]["Default400Response"];
|
|
22190
|
+
404: components["responses"]["Default404Response"];
|
|
22191
|
+
405: components["responses"]["Default405Response"];
|
|
22192
|
+
406: components["responses"]["Default406Response"];
|
|
22193
|
+
415: components["responses"]["Default415Response"];
|
|
22194
|
+
429: components["responses"]["Default429Response"];
|
|
22195
|
+
500: components["responses"]["Default500Response"];
|
|
22196
|
+
503: components["responses"]["Default503Response"];
|
|
22197
|
+
};
|
|
22198
|
+
};
|
|
22199
|
+
put?: never;
|
|
22200
|
+
post?: never;
|
|
22201
|
+
delete?: never;
|
|
22202
|
+
options?: never;
|
|
22203
|
+
head?: never;
|
|
22204
|
+
patch?: never;
|
|
22205
|
+
trace?: never;
|
|
22206
|
+
};
|
|
22207
|
+
"/viewerContexts/{id}": {
|
|
22208
|
+
parameters: {
|
|
22209
|
+
query?: never;
|
|
22210
|
+
header?: never;
|
|
22211
|
+
path?: never;
|
|
22212
|
+
cookie?: never;
|
|
22213
|
+
};
|
|
22214
|
+
/**
|
|
22215
|
+
* Get single viewerContext.
|
|
22216
|
+
* @description Retrieves single viewerContext by id.
|
|
22217
|
+
*/
|
|
22218
|
+
get: {
|
|
22219
|
+
parameters: {
|
|
22220
|
+
query?: {
|
|
22221
|
+
/**
|
|
22222
|
+
* @description Include related resources. Available relationships: subject, viewer
|
|
22223
|
+
* @example subject
|
|
22224
|
+
*/
|
|
22225
|
+
include?: string[];
|
|
22226
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
22227
|
+
includeLinkage?: ("subject" | "viewer")[];
|
|
22228
|
+
/**
|
|
22229
|
+
* @description 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
|
|
22230
|
+
* @example subject
|
|
22231
|
+
*/
|
|
22232
|
+
replaceMedia?: string;
|
|
22233
|
+
};
|
|
22234
|
+
header?: never;
|
|
22235
|
+
path: {
|
|
22236
|
+
/** @description Opaque identifier of one authenticated viewer and original subject pair */
|
|
22237
|
+
id: string;
|
|
22238
|
+
};
|
|
22239
|
+
cookie?: never;
|
|
22240
|
+
};
|
|
22241
|
+
requestBody?: never;
|
|
22242
|
+
responses: {
|
|
22243
|
+
/** @description Successful response */
|
|
22244
|
+
200: {
|
|
22245
|
+
headers: {
|
|
22246
|
+
[name: string]: unknown;
|
|
22247
|
+
};
|
|
22248
|
+
content: {
|
|
22249
|
+
"application/vnd.api+json": components["schemas"]["ViewerContexts_Single_Resource_Data_Document"];
|
|
22250
|
+
};
|
|
22251
|
+
};
|
|
22252
|
+
400: components["responses"]["Default400Response"];
|
|
22253
|
+
404: components["responses"]["Default404Response"];
|
|
22254
|
+
405: components["responses"]["Default405Response"];
|
|
22255
|
+
406: components["responses"]["Default406Response"];
|
|
22256
|
+
415: components["responses"]["Default415Response"];
|
|
22257
|
+
429: components["responses"]["Default429Response"];
|
|
22258
|
+
500: components["responses"]["Default500Response"];
|
|
22259
|
+
503: components["responses"]["Default503Response"];
|
|
22260
|
+
};
|
|
22261
|
+
};
|
|
22262
|
+
put?: never;
|
|
22263
|
+
post?: never;
|
|
22264
|
+
delete?: never;
|
|
22265
|
+
options?: never;
|
|
22266
|
+
head?: never;
|
|
22267
|
+
patch?: never;
|
|
22268
|
+
trace?: never;
|
|
22269
|
+
};
|
|
22270
|
+
"/viewerContexts/{id}/relationships/subject": {
|
|
22271
|
+
parameters: {
|
|
22272
|
+
query?: never;
|
|
22273
|
+
header?: never;
|
|
22274
|
+
path?: never;
|
|
22275
|
+
cookie?: never;
|
|
22276
|
+
};
|
|
22277
|
+
/**
|
|
22278
|
+
* Get subject relationship ("to-one").
|
|
22279
|
+
* @description Returns the subject of this viewer context.
|
|
22280
|
+
*/
|
|
22281
|
+
get: {
|
|
22282
|
+
parameters: {
|
|
22283
|
+
query?: {
|
|
22284
|
+
/**
|
|
22285
|
+
* @description Include related resources. Available relationships: subject
|
|
22286
|
+
* @example subject
|
|
22287
|
+
*/
|
|
22288
|
+
include?: string[];
|
|
22289
|
+
/**
|
|
22290
|
+
* @description 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
|
|
22291
|
+
* @example subject
|
|
22292
|
+
*/
|
|
22293
|
+
replaceMedia?: string;
|
|
22294
|
+
};
|
|
22295
|
+
header?: never;
|
|
22296
|
+
path: {
|
|
22297
|
+
/** @description Opaque identifier of one authenticated viewer and original subject pair */
|
|
22298
|
+
id: string;
|
|
22299
|
+
};
|
|
22300
|
+
cookie?: never;
|
|
22301
|
+
};
|
|
22302
|
+
requestBody?: never;
|
|
22303
|
+
responses: {
|
|
22304
|
+
/** @description Successful response */
|
|
22305
|
+
200: {
|
|
22306
|
+
headers: {
|
|
22307
|
+
[name: string]: unknown;
|
|
22308
|
+
};
|
|
22309
|
+
content: {
|
|
22310
|
+
"application/vnd.api+json": components["schemas"]["ViewerContexts_Subject_Single_Relationship_Data_Document"];
|
|
22311
|
+
};
|
|
22312
|
+
};
|
|
22313
|
+
400: components["responses"]["Default400Response"];
|
|
22314
|
+
404: components["responses"]["Default404Response"];
|
|
22315
|
+
405: components["responses"]["Default405Response"];
|
|
22316
|
+
406: components["responses"]["Default406Response"];
|
|
22317
|
+
415: components["responses"]["Default415Response"];
|
|
22318
|
+
429: components["responses"]["Default429Response"];
|
|
22319
|
+
500: components["responses"]["Default500Response"];
|
|
22320
|
+
503: components["responses"]["Default503Response"];
|
|
22321
|
+
};
|
|
22322
|
+
};
|
|
22323
|
+
put?: never;
|
|
22324
|
+
post?: never;
|
|
22325
|
+
delete?: never;
|
|
22326
|
+
options?: never;
|
|
22327
|
+
head?: never;
|
|
22328
|
+
patch?: never;
|
|
22329
|
+
trace?: never;
|
|
22330
|
+
};
|
|
22331
|
+
"/viewerContexts/{id}/relationships/viewer": {
|
|
22332
|
+
parameters: {
|
|
22333
|
+
query?: never;
|
|
22334
|
+
header?: never;
|
|
22335
|
+
path?: never;
|
|
22336
|
+
cookie?: never;
|
|
22337
|
+
};
|
|
22338
|
+
/**
|
|
22339
|
+
* Get viewer relationship ("to-one").
|
|
22340
|
+
* @description Returns the authenticated viewer of this context.
|
|
22341
|
+
*/
|
|
22342
|
+
get: {
|
|
22343
|
+
parameters: {
|
|
22344
|
+
query?: {
|
|
22345
|
+
/**
|
|
22346
|
+
* @description Include related resources. Available relationships: viewer
|
|
22347
|
+
* @example viewer.artist.albums
|
|
22348
|
+
*/
|
|
22349
|
+
include?: string[];
|
|
22350
|
+
/**
|
|
22351
|
+
* @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: viewer.artist.albums
|
|
22352
|
+
* @example viewer.artist.albums
|
|
22353
|
+
*/
|
|
22354
|
+
replaceMedia?: string;
|
|
22355
|
+
};
|
|
22356
|
+
header?: never;
|
|
22357
|
+
path: {
|
|
22358
|
+
/** @description Opaque identifier of one authenticated viewer and original subject pair */
|
|
22359
|
+
id: string;
|
|
22360
|
+
};
|
|
22361
|
+
cookie?: never;
|
|
22362
|
+
};
|
|
22363
|
+
requestBody?: never;
|
|
22364
|
+
responses: {
|
|
22365
|
+
/** @description Successful response */
|
|
22366
|
+
200: {
|
|
22367
|
+
headers: {
|
|
22368
|
+
[name: string]: unknown;
|
|
22369
|
+
};
|
|
22370
|
+
content: {
|
|
22371
|
+
"application/vnd.api+json": components["schemas"]["ViewerContexts_Viewer_Single_Relationship_Data_Document"];
|
|
22372
|
+
};
|
|
22373
|
+
};
|
|
22374
|
+
400: components["responses"]["Default400Response"];
|
|
22375
|
+
404: components["responses"]["Default404Response"];
|
|
22376
|
+
405: components["responses"]["Default405Response"];
|
|
22377
|
+
406: components["responses"]["Default406Response"];
|
|
22378
|
+
415: components["responses"]["Default415Response"];
|
|
22379
|
+
429: components["responses"]["Default429Response"];
|
|
22380
|
+
500: components["responses"]["Default500Response"];
|
|
22381
|
+
503: components["responses"]["Default503Response"];
|
|
22382
|
+
};
|
|
22383
|
+
};
|
|
22384
|
+
put?: never;
|
|
22385
|
+
post?: never;
|
|
22386
|
+
delete?: never;
|
|
22387
|
+
options?: never;
|
|
22388
|
+
head?: never;
|
|
22389
|
+
patch?: never;
|
|
22390
|
+
trace?: never;
|
|
22391
|
+
};
|
|
22392
|
+
}
|
|
22393
|
+
export type webhooks = Record<string, never>;
|
|
22394
|
+
export interface components {
|
|
22395
|
+
schemas: {
|
|
22396
|
+
AcceptedTermsCreateOperation_Payload: {
|
|
22397
|
+
data: components["schemas"]["AcceptedTermsCreateOperation_Payload_Data"];
|
|
22398
|
+
};
|
|
22399
|
+
AcceptedTermsCreateOperation_Payload_Data: {
|
|
22400
|
+
relationships: components["schemas"]["AcceptedTermsCreateOperation_Payload_Data_Relationships"];
|
|
22401
|
+
/** @enum {string} */
|
|
22402
|
+
type: "acceptedTerms";
|
|
22403
|
+
};
|
|
22404
|
+
AcceptedTermsCreateOperation_Payload_Data_Relationships: {
|
|
22405
|
+
terms: components["schemas"]["AcceptedTermsCreateOperation_Payload_Data_Relationships_Terms"];
|
|
22406
|
+
};
|
|
22407
|
+
AcceptedTermsCreateOperation_Payload_Data_Relationships_Terms: {
|
|
22408
|
+
data: components["schemas"]["AcceptedTermsCreateOperation_Payload_Data_Relationships_Terms_Data"];
|
|
22409
|
+
};
|
|
22410
|
+
AcceptedTermsCreateOperation_Payload_Data_Relationships_Terms_Data: {
|
|
22411
|
+
id: string;
|
|
22412
|
+
/** @enum {string} */
|
|
22413
|
+
type: "terms";
|
|
22414
|
+
};
|
|
22415
|
+
AcceptedTerms_Attributes: {
|
|
22416
|
+
/** Format: date-time */
|
|
22417
|
+
createdAt: string;
|
|
22418
|
+
};
|
|
22419
|
+
AcceptedTerms_Create_Single_Resource_Data_Document: {
|
|
22420
|
+
data: components["schemas"]["AcceptedTerms_Resource_Object"];
|
|
22421
|
+
links: components["schemas"]["Links"];
|
|
22422
|
+
};
|
|
22423
|
+
AcceptedTerms_Multi_Resource_Data_Document: {
|
|
22424
|
+
data: components["schemas"]["AcceptedTerms_Resource_Object"][];
|
|
21769
22425
|
included?: components["schemas"]["Included"];
|
|
21770
22426
|
links: components["schemas"]["Links"];
|
|
21771
22427
|
};
|
|
@@ -22084,7 +22740,6 @@ export interface components {
|
|
|
22084
22740
|
type: string;
|
|
22085
22741
|
};
|
|
22086
22742
|
Albums_Items_Resource_Identifier_Meta: {
|
|
22087
|
-
itemCursor?: string;
|
|
22088
22743
|
replacement?: components["schemas"]["Replacement_Provenance"];
|
|
22089
22744
|
/**
|
|
22090
22745
|
* Format: int32
|
|
@@ -22830,7 +23485,10 @@ export interface components {
|
|
|
22830
23485
|
};
|
|
22831
23486
|
/** @description Artwork files */
|
|
22832
23487
|
Artwork_File: {
|
|
22833
|
-
/**
|
|
23488
|
+
/**
|
|
23489
|
+
* Format: uri
|
|
23490
|
+
* @description Artwork file href
|
|
23491
|
+
*/
|
|
22834
23492
|
href: string;
|
|
22835
23493
|
meta: components["schemas"]["Artwork_File_Meta"];
|
|
22836
23494
|
};
|
|
@@ -22961,6 +23619,88 @@ export interface components {
|
|
|
22961
23619
|
*/
|
|
22962
23620
|
type: "changeEventStreams";
|
|
22963
23621
|
};
|
|
23622
|
+
ClientCertificatesCreateOperation_Payload: {
|
|
23623
|
+
data: components["schemas"]["ClientCertificatesCreateOperation_Payload_Data"];
|
|
23624
|
+
};
|
|
23625
|
+
ClientCertificatesCreateOperation_Payload_Data: {
|
|
23626
|
+
relationships: components["schemas"]["ClientCertificatesCreateOperation_Payload_Data_Relationships"];
|
|
23627
|
+
/** @enum {string} */
|
|
23628
|
+
type: "clientCertificates";
|
|
23629
|
+
};
|
|
23630
|
+
ClientCertificatesCreateOperation_Payload_Data_Relationships: {
|
|
23631
|
+
client: components["schemas"]["ClientCertificatesCreateOperation_Payload_Data_Relationships_Client"];
|
|
23632
|
+
};
|
|
23633
|
+
ClientCertificatesCreateOperation_Payload_Data_Relationships_Client: {
|
|
23634
|
+
data: components["schemas"]["ClientCertificatesCreateOperation_Payload_Data_Relationships_Client_Data"];
|
|
23635
|
+
};
|
|
23636
|
+
ClientCertificatesCreateOperation_Payload_Data_Relationships_Client_Data: {
|
|
23637
|
+
id: string;
|
|
23638
|
+
/** @enum {string} */
|
|
23639
|
+
type: "clients";
|
|
23640
|
+
};
|
|
23641
|
+
ClientCertificates_Attributes: {
|
|
23642
|
+
/**
|
|
23643
|
+
* Format: date-time
|
|
23644
|
+
* @description Time when the issued certificate expires
|
|
23645
|
+
*/
|
|
23646
|
+
certificateExpiresAt?: string;
|
|
23647
|
+
/**
|
|
23648
|
+
* @description Current lifecycle status of the certificate
|
|
23649
|
+
* @enum {string}
|
|
23650
|
+
*/
|
|
23651
|
+
certificateStatus: "NOT_ISSUED" | "ACTIVE" | "EXPIRED" | "REVOKED";
|
|
23652
|
+
/**
|
|
23653
|
+
* Format: date-time
|
|
23654
|
+
* @description Time when the certificate request was created
|
|
23655
|
+
*/
|
|
23656
|
+
createdAt: string;
|
|
23657
|
+
/**
|
|
23658
|
+
* Format: date-time
|
|
23659
|
+
* @description Time when the certificate request was last modified
|
|
23660
|
+
*/
|
|
23661
|
+
lastModifiedAt: string;
|
|
23662
|
+
/**
|
|
23663
|
+
* Format: date-time
|
|
23664
|
+
* @description Time until which the certificate package can be downloaded
|
|
23665
|
+
*/
|
|
23666
|
+
packageExpiresAt?: string;
|
|
23667
|
+
/**
|
|
23668
|
+
* @description Status of certificate and package provisioning
|
|
23669
|
+
* @enum {string}
|
|
23670
|
+
*/
|
|
23671
|
+
provisioningStatus: "PENDING" | "PROCESSING" | "OK" | "ERROR";
|
|
23672
|
+
};
|
|
23673
|
+
ClientCertificates_Create_Single_Resource_Data_Document: {
|
|
23674
|
+
data: components["schemas"]["ClientCertificates_Resource_Object"];
|
|
23675
|
+
links: components["schemas"]["Links"];
|
|
23676
|
+
};
|
|
23677
|
+
ClientCertificates_Owners_Multi_Relationship_Data_Document: {
|
|
23678
|
+
data?: components["schemas"]["Resource_Identifier"][];
|
|
23679
|
+
included?: components["schemas"]["Included"];
|
|
23680
|
+
links: components["schemas"]["Links"];
|
|
23681
|
+
};
|
|
23682
|
+
ClientCertificates_Relationships: {
|
|
23683
|
+
owners?: components["schemas"]["ClientCertificates_Owners_Multi_Relationship_Data_Document"];
|
|
23684
|
+
};
|
|
23685
|
+
ClientCertificates_Resource_Object: {
|
|
23686
|
+
attributes?: components["schemas"]["ClientCertificates_Attributes"];
|
|
23687
|
+
/**
|
|
23688
|
+
* @description Resource id
|
|
23689
|
+
* @example 12345
|
|
23690
|
+
*/
|
|
23691
|
+
id: string;
|
|
23692
|
+
relationships?: components["schemas"]["ClientCertificates_Relationships"];
|
|
23693
|
+
/**
|
|
23694
|
+
* @description Resource type (enum property replaced by openapi-typescript)
|
|
23695
|
+
* @enum {string}
|
|
23696
|
+
*/
|
|
23697
|
+
type: "clientCertificates";
|
|
23698
|
+
};
|
|
23699
|
+
ClientCertificates_Single_Resource_Data_Document: {
|
|
23700
|
+
data: components["schemas"]["ClientCertificates_Resource_Object"];
|
|
23701
|
+
included?: components["schemas"]["Included"];
|
|
23702
|
+
links: components["schemas"]["Links"];
|
|
23703
|
+
};
|
|
22964
23704
|
ClientsCreateOperation_Payload: {
|
|
22965
23705
|
data: components["schemas"]["ClientsCreateOperation_Payload_Data"];
|
|
22966
23706
|
};
|
|
@@ -22999,6 +23739,11 @@ export interface components {
|
|
|
22999
23739
|
redirectUris?: string[];
|
|
23000
23740
|
scopes?: string[];
|
|
23001
23741
|
};
|
|
23742
|
+
Clients_Certificates_Multi_Relationship_Data_Document: {
|
|
23743
|
+
data?: components["schemas"]["Resource_Identifier"][];
|
|
23744
|
+
included?: components["schemas"]["Included"];
|
|
23745
|
+
links: components["schemas"]["Links"];
|
|
23746
|
+
};
|
|
23002
23747
|
Clients_Create_Single_Resource_Data_Document: {
|
|
23003
23748
|
data: components["schemas"]["Clients_Resource_Object"];
|
|
23004
23749
|
links: components["schemas"]["Links"];
|
|
@@ -23014,6 +23759,7 @@ export interface components {
|
|
|
23014
23759
|
links: components["schemas"]["Links"];
|
|
23015
23760
|
};
|
|
23016
23761
|
Clients_Relationships: {
|
|
23762
|
+
certificates?: components["schemas"]["Clients_Certificates_Multi_Relationship_Data_Document"];
|
|
23017
23763
|
owners?: components["schemas"]["Clients_Owners_Multi_Relationship_Data_Document"];
|
|
23018
23764
|
};
|
|
23019
23765
|
Clients_Resource_Object: {
|
|
@@ -23159,6 +23905,8 @@ export interface components {
|
|
|
23159
23905
|
included?: components["schemas"]["Included"];
|
|
23160
23906
|
links: components["schemas"]["Links"];
|
|
23161
23907
|
};
|
|
23908
|
+
/** @description The viewer has at least one existing comment on the subject; deleted historical comments do not count. Reserved; not currently populated and omitted from responses. Omission does not indicate that the relation is absent. */
|
|
23909
|
+
Commented: Record<string, never>;
|
|
23162
23910
|
CommentsCreateOperation_Payload: {
|
|
23163
23911
|
data: components["schemas"]["CommentsCreateOperation_Payload_Data"];
|
|
23164
23912
|
};
|
|
@@ -23543,7 +24291,10 @@ export interface components {
|
|
|
23543
24291
|
}[];
|
|
23544
24292
|
};
|
|
23545
24293
|
Download_Link: {
|
|
23546
|
-
/**
|
|
24294
|
+
/**
|
|
24295
|
+
* Format: uri
|
|
24296
|
+
* @description URL to download the content from
|
|
24297
|
+
*/
|
|
23547
24298
|
href: string;
|
|
23548
24299
|
meta: components["schemas"]["Download_Link_Meta"];
|
|
23549
24300
|
};
|
|
@@ -23848,6 +24599,7 @@ export interface components {
|
|
|
23848
24599
|
links?: components["schemas"]["Links"];
|
|
23849
24600
|
};
|
|
23850
24601
|
External_Link: {
|
|
24602
|
+
/** Format: uri */
|
|
23851
24603
|
href: string;
|
|
23852
24604
|
meta: components["schemas"]["External_Link_Meta"];
|
|
23853
24605
|
};
|
|
@@ -23857,6 +24609,7 @@ export interface components {
|
|
|
23857
24609
|
type: "TIDAL_SHARING" | "TIDAL_USER_SHARING" | "TIDAL_AUTOPLAY_ANDROID" | "TIDAL_AUTOPLAY_IOS" | "TIDAL_AUTOPLAY_WEB" | "TWITTER" | "FACEBOOK" | "INSTAGRAM" | "TIKTOK" | "SNAPCHAT" | "OFFICIAL_HOMEPAGE" | "CASHAPP_CONTRIBUTIONS" | "ARTIST_CLAIM_PROVIDER_REDIRECT" | "STRIPE_AUTHORIZATION_REDIRECT" | "SQUARE_AUTHORIZATION_REDIRECT";
|
|
23858
24610
|
};
|
|
23859
24611
|
External_Link_Payload: {
|
|
24612
|
+
/** Format: uri */
|
|
23860
24613
|
href?: string;
|
|
23861
24614
|
meta: components["schemas"]["External_Link_Meta"];
|
|
23862
24615
|
};
|
|
@@ -23880,7 +24633,10 @@ export interface components {
|
|
|
23880
24633
|
};
|
|
23881
24634
|
/** @description Upload link */
|
|
23882
24635
|
File_Upload_Link: {
|
|
23883
|
-
/**
|
|
24636
|
+
/**
|
|
24637
|
+
* Format: uri
|
|
24638
|
+
* @description Href to upload actual file to
|
|
24639
|
+
*/
|
|
23884
24640
|
href: string;
|
|
23885
24641
|
meta: components["schemas"]["File_Upload_Link_Meta"];
|
|
23886
24642
|
};
|
|
@@ -24117,6 +24873,10 @@ export interface components {
|
|
|
24117
24873
|
data: components["schemas"]["Folders_Resource_Object"];
|
|
24118
24874
|
links: components["schemas"]["Links"];
|
|
24119
24875
|
};
|
|
24876
|
+
/** @description The viewer is followed by the subject. Reserved; not currently populated and omitted from responses. Omission does not indicate that the relation is absent. */
|
|
24877
|
+
FollowedBy: Record<string, never>;
|
|
24878
|
+
/** @description The viewer follows the subject. Reserved; not currently populated and omitted from responses. Omission does not indicate that the relation is absent. */
|
|
24879
|
+
Following: Record<string, never>;
|
|
24120
24880
|
Genres_Attributes: {
|
|
24121
24881
|
/**
|
|
24122
24882
|
* @description Genre name
|
|
@@ -24173,7 +24933,9 @@ export interface components {
|
|
|
24173
24933
|
status: string;
|
|
24174
24934
|
}[];
|
|
24175
24935
|
};
|
|
24176
|
-
|
|
24936
|
+
/** @description The viewer has the original subject in their normal collection. Present as an empty object when known present, otherwise omitted. Includes owned and saved playlists and saved mixes across folders; excludes Save for Later. */
|
|
24937
|
+
InCollection: Record<string, never>;
|
|
24938
|
+
Included: (components["schemas"]["AcceptedTerms_Resource_Object"] | components["schemas"]["AlbumStatistics_Resource_Object"] | components["schemas"]["Albums_Resource_Object"] | components["schemas"]["Appreciations_Resource_Object"] | components["schemas"]["ArtistBiographies_Resource_Object"] | components["schemas"]["ArtistClaimStatuses_Resource_Object"] | components["schemas"]["ArtistClaims_Resource_Object"] | components["schemas"]["ArtistRoles_Resource_Object"] | components["schemas"]["Artists_Resource_Object"] | components["schemas"]["Artworks_Resource_Object"] | components["schemas"]["ChangeEventStreams_Resource_Object"] | components["schemas"]["ClientCertificates_Resource_Object"] | components["schemas"]["Clients_Resource_Object"] | components["schemas"]["CollaborationInviteRedemptions_Resource_Object"] | components["schemas"]["CollaborationInvites_Resource_Object"] | components["schemas"]["Comments_Resource_Object"] | components["schemas"]["ContentClaims_Resource_Object"] | components["schemas"]["Credits_Resource_Object"] | components["schemas"]["Downloads_Resource_Object"] | components["schemas"]["DspSharingLinks_Resource_Object"] | components["schemas"]["DynamicModules_Resource_Object"] | components["schemas"]["DynamicPages_Resource_Object"] | components["schemas"]["FolderItems_Resource_Object"] | components["schemas"]["Folders_Resource_Object"] | components["schemas"]["Genres_Resource_Object"] | components["schemas"]["Installations_Resource_Object"] | components["schemas"]["Lyrics_Resource_Object"] | components["schemas"]["ManualArtistClaims_Resource_Object"] | components["schemas"]["OfflineTasks_Resource_Object"] | components["schemas"]["PlayQueues_Resource_Object"] | components["schemas"]["PlaylistGenerationSchedules_Resource_Object"] | components["schemas"]["PlaylistGenerations_Resource_Object"] | components["schemas"]["Playlists_Resource_Object"] | components["schemas"]["PriceConfigurations_Resource_Object"] | components["schemas"]["ProviderOwners_Resource_Object"] | components["schemas"]["ProviderProductInfos_Resource_Object"] | components["schemas"]["Providers_Resource_Object"] | components["schemas"]["Purchases_Resource_Object"] | components["schemas"]["Reactions_Resource_Object"] | components["schemas"]["SavedShares_Resource_Object"] | components["schemas"]["Scopes_Resource_Object"] | components["schemas"]["SearchHistoryEntries_Resource_Object"] | components["schemas"]["SearchResults_Resource_Object"] | components["schemas"]["SearchSuggestions_Resource_Object"] | components["schemas"]["Shares_Resource_Object"] | components["schemas"]["SquareConnections_Resource_Object"] | components["schemas"]["SquareSites_Resource_Object"] | components["schemas"]["StripeConnections_Resource_Object"] | components["schemas"]["StripeDashboardLinks_Resource_Object"] | components["schemas"]["SubscriptionPriceChangeDecisions_Resource_Object"] | components["schemas"]["TemporaryUserTokens_Resource_Object"] | components["schemas"]["Terms_Resource_Object"] | components["schemas"]["TrackFiles_Resource_Object"] | components["schemas"]["TrackManifests_Resource_Object"] | components["schemas"]["TrackSourceFiles_Resource_Object"] | components["schemas"]["TrackStatistics_Resource_Object"] | components["schemas"]["Tracks_Resource_Object"] | components["schemas"]["TracksMetadataStatus_Resource_Object"] | components["schemas"]["UsageRules_Resource_Object"] | components["schemas"]["UserCollectionAlbums_Resource_Object"] | components["schemas"]["UserCollectionArtists_Resource_Object"] | components["schemas"]["UserCollectionFolders_Resource_Object"] | components["schemas"]["UserCollectionPlaylists_Resource_Object"] | components["schemas"]["UserCollectionSaveForLaters_Resource_Object"] | components["schemas"]["UserCollectionTracks_Resource_Object"] | components["schemas"]["UserCollectionVideos_Resource_Object"] | components["schemas"]["UserDailyMixes_Resource_Object"] | components["schemas"]["UserDataExportRequests_Resource_Object"] | components["schemas"]["UserDiscoveryMixes_Resource_Object"] | components["schemas"]["UserNewReleaseMixes_Resource_Object"] | components["schemas"]["UserOfflineMixes_Resource_Object"] | components["schemas"]["UserPlaybackStates_Resource_Object"] | components["schemas"]["UserRecommendationBlocks_Resource_Object"] | components["schemas"]["UserReports_Resource_Object"] | components["schemas"]["UserSubscriptionPriceChanges_Resource_Object"] | components["schemas"]["Users_Resource_Object"] | components["schemas"]["VideoManifests_Resource_Object"] | components["schemas"]["Videos_Resource_Object"] | components["schemas"]["ViewerContexts_Resource_Object"])[];
|
|
24177
24939
|
InstallationsCreateOperation_Payload: {
|
|
24178
24940
|
data: components["schemas"]["InstallationsCreateOperation_Payload_Data"];
|
|
24179
24941
|
};
|
|
@@ -24442,9 +25204,13 @@ export interface components {
|
|
|
24442
25204
|
role?: string;
|
|
24443
25205
|
selectedAlbums?: string[];
|
|
24444
25206
|
selectedSingles?: string[];
|
|
24445
|
-
socialLink?: components["schemas"]["
|
|
25207
|
+
socialLink?: components["schemas"]["ManualArtistClaimsExternalLink"];
|
|
24446
25208
|
upcs?: string[];
|
|
24447
|
-
websiteOrSocialLink: components["schemas"]["
|
|
25209
|
+
websiteOrSocialLink: components["schemas"]["ManualArtistClaimsExternalLink"];
|
|
25210
|
+
};
|
|
25211
|
+
ManualArtistClaimsExternalLink: {
|
|
25212
|
+
/** Format: uri */
|
|
25213
|
+
href: string;
|
|
24448
25214
|
};
|
|
24449
25215
|
ManualArtistClaims_Attributes: {
|
|
24450
25216
|
/** @description Accepted terms and conditions */
|
|
@@ -24514,6 +25280,14 @@ export interface components {
|
|
|
24514
25280
|
*/
|
|
24515
25281
|
type: "manualArtistClaims";
|
|
24516
25282
|
};
|
|
25283
|
+
/** @description The viewer has current identity-derived membership in the subject; role describes that membership and excludes raw share bearer access. Reserved; not currently populated and omitted from responses. Omission does not indicate that the relation is absent. */
|
|
25284
|
+
Membership: {
|
|
25285
|
+
/**
|
|
25286
|
+
* @description Identity-derived membership role.
|
|
25287
|
+
* @enum {string}
|
|
25288
|
+
*/
|
|
25289
|
+
role: "VIEWER" | "COLLABORATOR" | "OWNER";
|
|
25290
|
+
};
|
|
24517
25291
|
Mutation_Response_Document: {
|
|
24518
25292
|
links: components["schemas"]["Links"];
|
|
24519
25293
|
/** @description Non-standard meta information */
|
|
@@ -24662,12 +25436,8 @@ export interface components {
|
|
|
24662
25436
|
};
|
|
24663
25437
|
PlayQueuesFutureRelationshipAddOperation_Payload_Data: {
|
|
24664
25438
|
id: string;
|
|
24665
|
-
meta?: components["schemas"]["PlayQueuesFutureRelationshipAddOperation_Payload_Data_Meta"];
|
|
24666
25439
|
/** @enum {string} */
|
|
24667
|
-
type: "tracks" | "videos"
|
|
24668
|
-
};
|
|
24669
|
-
PlayQueuesFutureRelationshipAddOperation_Payload_Data_Meta: {
|
|
24670
|
-
itemCursor?: string;
|
|
25440
|
+
type: "tracks" | "videos";
|
|
24671
25441
|
};
|
|
24672
25442
|
PlayQueuesFutureRelationshipAddOperation_Payload_Meta: {
|
|
24673
25443
|
/** Format: uuid */
|
|
@@ -24676,6 +25446,7 @@ export interface components {
|
|
|
24676
25446
|
/** @enum {string} */
|
|
24677
25447
|
mode: "ADD_TO_FRONT" | "ADD_TO_BACK" | "ADD_BEFORE" | "REPLACE_ALL" | "REPLACE_ALL_AND_CURRENT" | "ADD_TO_FRONT_REPLACE_CURRENT";
|
|
24678
25448
|
positionBefore?: string;
|
|
25449
|
+
source?: components["schemas"]["PlayQueuesFutureRelationshipSource"];
|
|
24679
25450
|
};
|
|
24680
25451
|
PlayQueuesFutureRelationshipRemoveOperation_Payload: {
|
|
24681
25452
|
data: components["schemas"]["PlayQueuesFutureRelationshipRemoveOperation_Payload_Data"][];
|
|
@@ -24689,6 +25460,19 @@ export interface components {
|
|
|
24689
25460
|
PlayQueuesFutureRelationshipRemoveOperation_Payload_Data_Meta: {
|
|
24690
25461
|
itemId: string;
|
|
24691
25462
|
};
|
|
25463
|
+
/** @description Adds up to 1000 playable items from a relationship page and subsequent pages, reading at most 100 pages. Requires empty data. */
|
|
25464
|
+
PlayQueuesFutureRelationshipSource: {
|
|
25465
|
+
/**
|
|
25466
|
+
* Format: uri-reference
|
|
25467
|
+
* @description API-relative self link of a TIDAL API to-many relationship page.
|
|
25468
|
+
*/
|
|
25469
|
+
href: string;
|
|
25470
|
+
/**
|
|
25471
|
+
* Format: int32
|
|
25472
|
+
* @description Zero-based index in the page's complete data array from which to start adding.
|
|
25473
|
+
*/
|
|
25474
|
+
startIndex: number;
|
|
25475
|
+
};
|
|
24692
25476
|
PlayQueuesFutureRelationshipUpdateOperation_Payload: {
|
|
24693
25477
|
data: components["schemas"]["PlayQueuesFutureRelationshipUpdateOperation_Payload_Data"][];
|
|
24694
25478
|
meta: components["schemas"]["PlayQueuesFutureRelationshipUpdateOperation_Payload_Meta"];
|
|
@@ -25266,7 +26050,7 @@ export interface components {
|
|
|
25266
26050
|
* @example DUPLICATE_ITEMS_IN_PLAYLIST
|
|
25267
26051
|
* @enum {string}
|
|
25268
26052
|
*/
|
|
25269
|
-
code: "DUPLICATE_ITEMS_IN_PLAYLIST" | "IDEMPOTENT_REQUEST_IN_PROGRESS";
|
|
26053
|
+
code: "DUPLICATE_ITEMS_IN_PLAYLIST" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_PLAYLIST";
|
|
25270
26054
|
/** @example Playlist already contains one or more requested items */
|
|
25271
26055
|
detail?: string;
|
|
25272
26056
|
/** @example 409 */
|
|
@@ -25510,7 +26294,6 @@ export interface components {
|
|
|
25510
26294
|
Playlists_Items_Resource_Identifier_Meta: {
|
|
25511
26295
|
/** Format: date-time */
|
|
25512
26296
|
addedAt?: string;
|
|
25513
|
-
itemCursor?: string;
|
|
25514
26297
|
itemId?: string;
|
|
25515
26298
|
replacement?: components["schemas"]["Replacement_Provenance"];
|
|
25516
26299
|
};
|
|
@@ -25778,6 +26561,8 @@ export interface components {
|
|
|
25778
26561
|
included?: components["schemas"]["Included"];
|
|
25779
26562
|
links: components["schemas"]["Links"];
|
|
25780
26563
|
};
|
|
26564
|
+
/** @description The viewer has a current qualifying purchase entitlement. Includes a track covered by its purchased album; excludes subscription access and free downloads. Reserved; not currently populated and omitted from responses. Omission does not indicate that the relation is absent. */
|
|
26565
|
+
Purchased: Record<string, never>;
|
|
25781
26566
|
Purchases_Attributes: {
|
|
25782
26567
|
/**
|
|
25783
26568
|
* Format: date-time
|
|
@@ -25839,6 +26624,10 @@ export interface components {
|
|
|
25839
26624
|
included?: components["schemas"]["Included"];
|
|
25840
26625
|
links: components["schemas"]["Links"];
|
|
25841
26626
|
};
|
|
26627
|
+
/** @description The viewer has a current reaction to the subject, with its emoji. Reserved; not currently populated and omitted from responses. Omission does not indicate that the relation is absent. */
|
|
26628
|
+
Reaction: {
|
|
26629
|
+
emoji: string;
|
|
26630
|
+
};
|
|
25842
26631
|
/** @description Reaction statistics */
|
|
25843
26632
|
ReactionStats: {
|
|
25844
26633
|
/** @description Count of reactions by type */
|
|
@@ -25973,6 +26762,8 @@ export interface components {
|
|
|
25973
26762
|
*/
|
|
25974
26763
|
type: string;
|
|
25975
26764
|
};
|
|
26765
|
+
/** @description The viewer has saved the subject for later. Reserved; not currently populated and omitted from responses. Omission does not indicate that the relation is absent. */
|
|
26766
|
+
SavedForLater: Record<string, never>;
|
|
25976
26767
|
SavedSharesCreateOperation_Payload: {
|
|
25977
26768
|
data: components["schemas"]["SavedSharesCreateOperation_Payload_Data"];
|
|
25978
26769
|
};
|
|
@@ -27693,6 +28484,19 @@ export interface components {
|
|
|
27693
28484
|
/** @enum {string} */
|
|
27694
28485
|
type: "albums";
|
|
27695
28486
|
};
|
|
28487
|
+
UserCollectionAlbumsReadMultiDataRelationship403ResponseBody: {
|
|
28488
|
+
errors: {
|
|
28489
|
+
/**
|
|
28490
|
+
* @example UNAUTHORIZED
|
|
28491
|
+
* @enum {string}
|
|
28492
|
+
*/
|
|
28493
|
+
code: "UNAUTHORIZED";
|
|
28494
|
+
/** @example filter[query] requires INTERNAL access tier */
|
|
28495
|
+
detail?: string;
|
|
28496
|
+
/** @example 403 */
|
|
28497
|
+
status: string;
|
|
28498
|
+
}[];
|
|
28499
|
+
};
|
|
27696
28500
|
UserCollectionAlbums_Attributes: {
|
|
27697
28501
|
/**
|
|
27698
28502
|
* Format: date-time
|
|
@@ -27815,6 +28619,19 @@ export interface components {
|
|
|
27815
28619
|
/** @enum {string} */
|
|
27816
28620
|
type: "artists";
|
|
27817
28621
|
};
|
|
28622
|
+
UserCollectionArtistsReadMultiDataRelationship403ResponseBody: {
|
|
28623
|
+
errors: {
|
|
28624
|
+
/**
|
|
28625
|
+
* @example UNAUTHORIZED
|
|
28626
|
+
* @enum {string}
|
|
28627
|
+
*/
|
|
28628
|
+
code: "UNAUTHORIZED";
|
|
28629
|
+
/** @example filter[query] requires INTERNAL access tier */
|
|
28630
|
+
detail?: string;
|
|
28631
|
+
/** @example 403 */
|
|
28632
|
+
status: string;
|
|
28633
|
+
}[];
|
|
28634
|
+
};
|
|
27818
28635
|
UserCollectionArtists_Attributes: {
|
|
27819
28636
|
/**
|
|
27820
28637
|
* Format: date-time
|
|
@@ -28069,6 +28886,19 @@ export interface components {
|
|
|
28069
28886
|
/** @enum {string} */
|
|
28070
28887
|
type: "playlists";
|
|
28071
28888
|
};
|
|
28889
|
+
UserCollectionPlaylistsReadMultiDataRelationship403ResponseBody: {
|
|
28890
|
+
errors: {
|
|
28891
|
+
/**
|
|
28892
|
+
* @example UNAUTHORIZED
|
|
28893
|
+
* @enum {string}
|
|
28894
|
+
*/
|
|
28895
|
+
code: "UNAUTHORIZED";
|
|
28896
|
+
/** @example filter[query] requires INTERNAL access tier */
|
|
28897
|
+
detail?: string;
|
|
28898
|
+
/** @example 403 */
|
|
28899
|
+
status: string;
|
|
28900
|
+
}[];
|
|
28901
|
+
};
|
|
28072
28902
|
UserCollectionPlaylists_Attributes: {
|
|
28073
28903
|
/**
|
|
28074
28904
|
* Format: date-time
|
|
@@ -28307,6 +29137,19 @@ export interface components {
|
|
|
28307
29137
|
/** @enum {string} */
|
|
28308
29138
|
type: "tracks";
|
|
28309
29139
|
};
|
|
29140
|
+
UserCollectionTracksReadMultiDataRelationship403ResponseBody: {
|
|
29141
|
+
errors: {
|
|
29142
|
+
/**
|
|
29143
|
+
* @example UNAUTHORIZED
|
|
29144
|
+
* @enum {string}
|
|
29145
|
+
*/
|
|
29146
|
+
code: "UNAUTHORIZED";
|
|
29147
|
+
/** @example filter[query] requires INTERNAL access tier */
|
|
29148
|
+
detail?: string;
|
|
29149
|
+
/** @example 403 */
|
|
29150
|
+
status: string;
|
|
29151
|
+
}[];
|
|
29152
|
+
};
|
|
28310
29153
|
UserCollectionTracks_Attributes: {
|
|
28311
29154
|
/**
|
|
28312
29155
|
* Format: date-time
|
|
@@ -28429,6 +29272,19 @@ export interface components {
|
|
|
28429
29272
|
/** @enum {string} */
|
|
28430
29273
|
type: "videos";
|
|
28431
29274
|
};
|
|
29275
|
+
UserCollectionVideosReadMultiDataRelationship403ResponseBody: {
|
|
29276
|
+
errors: {
|
|
29277
|
+
/**
|
|
29278
|
+
* @example UNAUTHORIZED
|
|
29279
|
+
* @enum {string}
|
|
29280
|
+
*/
|
|
29281
|
+
code: "UNAUTHORIZED";
|
|
29282
|
+
/** @example filter[query] requires INTERNAL access tier */
|
|
29283
|
+
detail?: string;
|
|
29284
|
+
/** @example 403 */
|
|
29285
|
+
status: string;
|
|
29286
|
+
}[];
|
|
29287
|
+
};
|
|
28432
29288
|
UserCollectionVideos_Attributes: {
|
|
28433
29289
|
/**
|
|
28434
29290
|
* Format: date-time
|
|
@@ -29406,6 +30262,70 @@ export interface components {
|
|
|
29406
30262
|
included?: components["schemas"]["Included"];
|
|
29407
30263
|
links: components["schemas"]["Links"];
|
|
29408
30264
|
};
|
|
30265
|
+
ViewerContexts_Attributes: {
|
|
30266
|
+
hasCommentedOn?: components["schemas"]["Commented"];
|
|
30267
|
+
hasInCollection?: components["schemas"]["InCollection"];
|
|
30268
|
+
hasPurchased?: components["schemas"]["Purchased"];
|
|
30269
|
+
hasReactedTo?: components["schemas"]["Reaction"];
|
|
30270
|
+
hasSavedForLater?: components["schemas"]["SavedForLater"];
|
|
30271
|
+
isFollowedBy?: components["schemas"]["FollowedBy"];
|
|
30272
|
+
isFollowing?: components["schemas"]["Following"];
|
|
30273
|
+
isMemberOf?: components["schemas"]["Membership"];
|
|
30274
|
+
};
|
|
30275
|
+
ViewerContexts_Multi_Resource_Data_Document: {
|
|
30276
|
+
data: components["schemas"]["ViewerContexts_Resource_Object"][];
|
|
30277
|
+
included?: components["schemas"]["Included"];
|
|
30278
|
+
links: components["schemas"]["Links"];
|
|
30279
|
+
};
|
|
30280
|
+
ViewerContexts_Relationships: {
|
|
30281
|
+
subject?: components["schemas"]["ViewerContexts_Subject_Single_Relationship_Data_Document"];
|
|
30282
|
+
viewer?: components["schemas"]["ViewerContexts_Viewer_Single_Relationship_Data_Document"];
|
|
30283
|
+
};
|
|
30284
|
+
ViewerContexts_Resource_Object: {
|
|
30285
|
+
attributes?: components["schemas"]["ViewerContexts_Attributes"];
|
|
30286
|
+
/**
|
|
30287
|
+
* @description Resource id
|
|
30288
|
+
* @example 12345
|
|
30289
|
+
*/
|
|
30290
|
+
id: string;
|
|
30291
|
+
relationships?: components["schemas"]["ViewerContexts_Relationships"];
|
|
30292
|
+
/**
|
|
30293
|
+
* @description Resource type (enum property replaced by openapi-typescript)
|
|
30294
|
+
* @enum {string}
|
|
30295
|
+
*/
|
|
30296
|
+
type: "viewerContexts";
|
|
30297
|
+
};
|
|
30298
|
+
ViewerContexts_Single_Resource_Data_Document: {
|
|
30299
|
+
data: components["schemas"]["ViewerContexts_Resource_Object"];
|
|
30300
|
+
included?: components["schemas"]["Included"];
|
|
30301
|
+
links: components["schemas"]["Links"];
|
|
30302
|
+
};
|
|
30303
|
+
ViewerContexts_Subject_Resource_Identifier: {
|
|
30304
|
+
/**
|
|
30305
|
+
* @description Resource id
|
|
30306
|
+
* @example 12345
|
|
30307
|
+
*/
|
|
30308
|
+
id: string;
|
|
30309
|
+
meta?: components["schemas"]["ViewerContexts_Subject_Resource_Identifier_Meta"];
|
|
30310
|
+
/**
|
|
30311
|
+
* @description Resource type
|
|
30312
|
+
* @example tracks
|
|
30313
|
+
*/
|
|
30314
|
+
type: string;
|
|
30315
|
+
};
|
|
30316
|
+
ViewerContexts_Subject_Resource_Identifier_Meta: {
|
|
30317
|
+
replacement?: components["schemas"]["Replacement_Provenance"];
|
|
30318
|
+
};
|
|
30319
|
+
ViewerContexts_Subject_Single_Relationship_Data_Document: {
|
|
30320
|
+
data?: components["schemas"]["ViewerContexts_Subject_Resource_Identifier"] | (never | null);
|
|
30321
|
+
included?: components["schemas"]["Included"];
|
|
30322
|
+
links: components["schemas"]["Links"];
|
|
30323
|
+
};
|
|
30324
|
+
ViewerContexts_Viewer_Single_Relationship_Data_Document: {
|
|
30325
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
30326
|
+
included?: components["schemas"]["Included"];
|
|
30327
|
+
links: components["schemas"]["Links"];
|
|
30328
|
+
};
|
|
29409
30329
|
};
|
|
29410
30330
|
responses: {
|
|
29411
30331
|
/** @description Invalid request */
|
|
@@ -29579,7 +30499,7 @@ export interface components {
|
|
|
29579
30499
|
"application/vnd.api+json": components["schemas"]["PlaylistGenerationsUpdateMultiDataRelationship409ResponseBody"];
|
|
29580
30500
|
};
|
|
29581
30501
|
};
|
|
29582
|
-
/** @description Playlist already contains one or more requested items; Request already in progress for this idempotency key */
|
|
30502
|
+
/** @description Playlist already contains one or more requested items; Playlist item limit reached; Request already in progress for this idempotency key */
|
|
29583
30503
|
PlaylistsAddMultiDataRelationshipWithResponse409Response: {
|
|
29584
30504
|
headers: {
|
|
29585
30505
|
[name: string]: unknown;
|
|
@@ -29678,6 +30598,15 @@ export interface components {
|
|
|
29678
30598
|
"application/vnd.api+json": components["schemas"]["UserCollectionAlbumsAddMultiDataRelationshipWithResponse409ResponseBody"];
|
|
29679
30599
|
};
|
|
29680
30600
|
};
|
|
30601
|
+
/** @description filter[query] requires INTERNAL access tier */
|
|
30602
|
+
UserCollectionAlbumsReadMultiDataRelationship403Response: {
|
|
30603
|
+
headers: {
|
|
30604
|
+
[name: string]: unknown;
|
|
30605
|
+
};
|
|
30606
|
+
content: {
|
|
30607
|
+
"application/vnd.api+json": components["schemas"]["UserCollectionAlbumsReadMultiDataRelationship403ResponseBody"];
|
|
30608
|
+
};
|
|
30609
|
+
};
|
|
29681
30610
|
/** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */
|
|
29682
30611
|
UserCollectionArtistsAddMultiDataRelationshipWithResponse409Response: {
|
|
29683
30612
|
headers: {
|
|
@@ -29687,6 +30616,15 @@ export interface components {
|
|
|
29687
30616
|
"application/vnd.api+json": components["schemas"]["UserCollectionArtistsAddMultiDataRelationshipWithResponse409ResponseBody"];
|
|
29688
30617
|
};
|
|
29689
30618
|
};
|
|
30619
|
+
/** @description filter[query] requires INTERNAL access tier */
|
|
30620
|
+
UserCollectionArtistsReadMultiDataRelationship403Response: {
|
|
30621
|
+
headers: {
|
|
30622
|
+
[name: string]: unknown;
|
|
30623
|
+
};
|
|
30624
|
+
content: {
|
|
30625
|
+
"application/vnd.api+json": components["schemas"]["UserCollectionArtistsReadMultiDataRelationship403ResponseBody"];
|
|
30626
|
+
};
|
|
30627
|
+
};
|
|
29690
30628
|
/** @description Folder must be empty and owned by you */
|
|
29691
30629
|
UserCollectionFoldersDeleteResource400Response: {
|
|
29692
30630
|
headers: {
|
|
@@ -29705,6 +30643,15 @@ export interface components {
|
|
|
29705
30643
|
"application/vnd.api+json": components["schemas"]["UserCollectionPlaylistsAddMultiDataRelationshipWithResponse409ResponseBody"];
|
|
29706
30644
|
};
|
|
29707
30645
|
};
|
|
30646
|
+
/** @description filter[query] requires INTERNAL access tier */
|
|
30647
|
+
UserCollectionPlaylistsReadMultiDataRelationship403Response: {
|
|
30648
|
+
headers: {
|
|
30649
|
+
[name: string]: unknown;
|
|
30650
|
+
};
|
|
30651
|
+
content: {
|
|
30652
|
+
"application/vnd.api+json": components["schemas"]["UserCollectionPlaylistsReadMultiDataRelationship403ResponseBody"];
|
|
30653
|
+
};
|
|
30654
|
+
};
|
|
29708
30655
|
/** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */
|
|
29709
30656
|
UserCollectionSaveForLatersAddMultiDataRelationshipWithResponse409Response: {
|
|
29710
30657
|
headers: {
|
|
@@ -29723,6 +30670,15 @@ export interface components {
|
|
|
29723
30670
|
"application/vnd.api+json": components["schemas"]["UserCollectionTracksAddMultiDataRelationshipWithResponse409ResponseBody"];
|
|
29724
30671
|
};
|
|
29725
30672
|
};
|
|
30673
|
+
/** @description filter[query] requires INTERNAL access tier */
|
|
30674
|
+
UserCollectionTracksReadMultiDataRelationship403Response: {
|
|
30675
|
+
headers: {
|
|
30676
|
+
[name: string]: unknown;
|
|
30677
|
+
};
|
|
30678
|
+
content: {
|
|
30679
|
+
"application/vnd.api+json": components["schemas"]["UserCollectionTracksReadMultiDataRelationship403ResponseBody"];
|
|
30680
|
+
};
|
|
30681
|
+
};
|
|
29726
30682
|
/** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */
|
|
29727
30683
|
UserCollectionVideosAddMultiDataRelationshipWithResponse409Response: {
|
|
29728
30684
|
headers: {
|
|
@@ -29732,6 +30688,15 @@ export interface components {
|
|
|
29732
30688
|
"application/vnd.api+json": components["schemas"]["UserCollectionVideosAddMultiDataRelationshipWithResponse409ResponseBody"];
|
|
29733
30689
|
};
|
|
29734
30690
|
};
|
|
30691
|
+
/** @description filter[query] requires INTERNAL access tier */
|
|
30692
|
+
UserCollectionVideosReadMultiDataRelationship403Response: {
|
|
30693
|
+
headers: {
|
|
30694
|
+
[name: string]: unknown;
|
|
30695
|
+
};
|
|
30696
|
+
content: {
|
|
30697
|
+
"application/vnd.api+json": components["schemas"]["UserCollectionVideosReadMultiDataRelationship403ResponseBody"];
|
|
30698
|
+
};
|
|
30699
|
+
};
|
|
29735
30700
|
/** @description Recommendation block limit reached; Request already in progress for this idempotency key */
|
|
29736
30701
|
UserRecommendationBlocksAddMultiDataRelationshipWithResponse409Response: {
|
|
29737
30702
|
headers: {
|