@tidal-music/api 0.48.0 → 0.49.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 +888 -255
- 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[];
|
|
@@ -3890,8 +3912,10 @@ export interface paths {
|
|
|
3890
3912
|
query: {
|
|
3891
3913
|
/** @description User id. Use `me` for the authenticated user */
|
|
3892
3914
|
"filter[owners.id]": string[];
|
|
3893
|
-
/** @description
|
|
3915
|
+
/** @description Include related resources. Available relationships: owners */
|
|
3894
3916
|
include?: string[];
|
|
3917
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
3918
|
+
includeLinkage?: "owners"[];
|
|
3895
3919
|
};
|
|
3896
3920
|
header?: never;
|
|
3897
3921
|
path?: never;
|
|
@@ -3980,8 +4004,10 @@ export interface paths {
|
|
|
3980
4004
|
get: {
|
|
3981
4005
|
parameters: {
|
|
3982
4006
|
query?: {
|
|
3983
|
-
/** @description
|
|
4007
|
+
/** @description Include related resources. Available relationships: owners */
|
|
3984
4008
|
include?: string[];
|
|
4009
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
4010
|
+
includeLinkage?: "owners"[];
|
|
3985
4011
|
};
|
|
3986
4012
|
header?: never;
|
|
3987
4013
|
path: {
|
|
@@ -4125,7 +4151,7 @@ export interface paths {
|
|
|
4125
4151
|
parameters: {
|
|
4126
4152
|
query?: {
|
|
4127
4153
|
/**
|
|
4128
|
-
* @description
|
|
4154
|
+
* @description Include related resources. Available relationships: owners
|
|
4129
4155
|
* @example owners
|
|
4130
4156
|
*/
|
|
4131
4157
|
include?: string[];
|
|
@@ -4244,10 +4270,12 @@ export interface paths {
|
|
|
4244
4270
|
/** @description Invite code */
|
|
4245
4271
|
"filter[code]": string[];
|
|
4246
4272
|
/**
|
|
4247
|
-
* @description
|
|
4273
|
+
* @description Include related resources. Available relationships: owners, subject
|
|
4248
4274
|
* @example subject.items
|
|
4249
4275
|
*/
|
|
4250
4276
|
include?: string[];
|
|
4277
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
4278
|
+
includeLinkage?: ("owners" | "subject")[];
|
|
4251
4279
|
/**
|
|
4252
4280
|
* @description 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
4281
|
* @example subject.items
|
|
@@ -4342,10 +4370,12 @@ export interface paths {
|
|
|
4342
4370
|
parameters: {
|
|
4343
4371
|
query?: {
|
|
4344
4372
|
/**
|
|
4345
|
-
* @description
|
|
4373
|
+
* @description Include related resources. Available relationships: owners, subject
|
|
4346
4374
|
* @example subject.items
|
|
4347
4375
|
*/
|
|
4348
4376
|
include?: string[];
|
|
4377
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
4378
|
+
includeLinkage?: ("owners" | "subject")[];
|
|
4349
4379
|
/**
|
|
4350
4380
|
* @description 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
4381
|
* @example subject.items
|
|
@@ -4448,7 +4478,7 @@ export interface paths {
|
|
|
4448
4478
|
parameters: {
|
|
4449
4479
|
query?: {
|
|
4450
4480
|
/**
|
|
4451
|
-
* @description
|
|
4481
|
+
* @description Include related resources. Available relationships: owners
|
|
4452
4482
|
* @example owners
|
|
4453
4483
|
*/
|
|
4454
4484
|
include?: string[];
|
|
@@ -4509,7 +4539,7 @@ export interface paths {
|
|
|
4509
4539
|
parameters: {
|
|
4510
4540
|
query?: {
|
|
4511
4541
|
/**
|
|
4512
|
-
* @description
|
|
4542
|
+
* @description Include related resources. Available relationships: subject
|
|
4513
4543
|
* @example subject.items
|
|
4514
4544
|
*/
|
|
4515
4545
|
include?: string[];
|
|
@@ -4577,7 +4607,7 @@ export interface paths {
|
|
|
4577
4607
|
/** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */
|
|
4578
4608
|
sort?: ("createdAt" | "-createdAt" | "likeCount" | "-likeCount" | "replyCount" | "-replyCount" | "startTime" | "-startTime")[];
|
|
4579
4609
|
/**
|
|
4580
|
-
* @description
|
|
4610
|
+
* @description Include related resources. Available relationships: author, owners, parentComment
|
|
4581
4611
|
* @example author.albums
|
|
4582
4612
|
*/
|
|
4583
4613
|
include?: string[];
|
|
@@ -4595,6 +4625,8 @@ export interface paths {
|
|
|
4595
4625
|
* @description Deprecated: use filter[subject]. Filter by subject resource type (e.g. `albums`)
|
|
4596
4626
|
*/
|
|
4597
4627
|
"filter[subject.type]"?: ("albums" | "tracks" | "trackSourceFiles")[];
|
|
4628
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
4629
|
+
includeLinkage?: ("author" | "owners" | "parentComment")[];
|
|
4598
4630
|
/**
|
|
4599
4631
|
* @description 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
4632
|
* @example author.albums
|
|
@@ -4689,10 +4721,12 @@ export interface paths {
|
|
|
4689
4721
|
parameters: {
|
|
4690
4722
|
query?: {
|
|
4691
4723
|
/**
|
|
4692
|
-
* @description
|
|
4724
|
+
* @description Include related resources. Available relationships: author, owners, parentComment
|
|
4693
4725
|
* @example author.albums
|
|
4694
4726
|
*/
|
|
4695
4727
|
include?: string[];
|
|
4728
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
4729
|
+
includeLinkage?: ("author" | "owners" | "parentComment")[];
|
|
4696
4730
|
/**
|
|
4697
4731
|
* @description 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
4732
|
* @example author.albums
|
|
@@ -4841,7 +4875,7 @@ export interface paths {
|
|
|
4841
4875
|
parameters: {
|
|
4842
4876
|
query?: {
|
|
4843
4877
|
/**
|
|
4844
|
-
* @description
|
|
4878
|
+
* @description Include related resources. Available relationships: author
|
|
4845
4879
|
* @example author.albums
|
|
4846
4880
|
*/
|
|
4847
4881
|
include?: string[];
|
|
@@ -4905,7 +4939,7 @@ export interface paths {
|
|
|
4905
4939
|
parameters: {
|
|
4906
4940
|
query?: {
|
|
4907
4941
|
/**
|
|
4908
|
-
* @description
|
|
4942
|
+
* @description Include related resources. Available relationships: owners
|
|
4909
4943
|
* @example owners
|
|
4910
4944
|
*/
|
|
4911
4945
|
include?: string[];
|
|
@@ -4966,7 +5000,7 @@ export interface paths {
|
|
|
4966
5000
|
parameters: {
|
|
4967
5001
|
query?: {
|
|
4968
5002
|
/**
|
|
4969
|
-
* @description
|
|
5003
|
+
* @description Include related resources. Available relationships: parentComment
|
|
4970
5004
|
* @example parentComment.author.albums
|
|
4971
5005
|
*/
|
|
4972
5006
|
include?: string[];
|
|
@@ -5032,10 +5066,12 @@ export interface paths {
|
|
|
5032
5066
|
/** @description User id. Use `me` for the authenticated user */
|
|
5033
5067
|
"filter[owners.id]": string[];
|
|
5034
5068
|
/**
|
|
5035
|
-
* @description
|
|
5069
|
+
* @description Include related resources. Available relationships: claimedResource, claimingArtist, owners
|
|
5036
5070
|
* @example claimedResource
|
|
5037
5071
|
*/
|
|
5038
5072
|
include?: string[];
|
|
5073
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
5074
|
+
includeLinkage?: ("claimedResource" | "claimingArtist" | "owners")[];
|
|
5039
5075
|
/**
|
|
5040
5076
|
* @description 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
5077
|
* @example claimedResource
|
|
@@ -5130,10 +5166,12 @@ export interface paths {
|
|
|
5130
5166
|
parameters: {
|
|
5131
5167
|
query?: {
|
|
5132
5168
|
/**
|
|
5133
|
-
* @description
|
|
5169
|
+
* @description Include related resources. Available relationships: claimedResource, claimingArtist, owners
|
|
5134
5170
|
* @example claimedResource
|
|
5135
5171
|
*/
|
|
5136
5172
|
include?: string[];
|
|
5173
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
5174
|
+
includeLinkage?: ("claimedResource" | "claimingArtist" | "owners")[];
|
|
5137
5175
|
/**
|
|
5138
5176
|
* @description 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
5177
|
* @example claimedResource
|
|
@@ -5194,7 +5232,7 @@ export interface paths {
|
|
|
5194
5232
|
parameters: {
|
|
5195
5233
|
query?: {
|
|
5196
5234
|
/**
|
|
5197
|
-
* @description
|
|
5235
|
+
* @description Include related resources. Available relationships: claimedResource
|
|
5198
5236
|
* @example claimedResource
|
|
5199
5237
|
*/
|
|
5200
5238
|
include?: string[];
|
|
@@ -5258,7 +5296,7 @@ export interface paths {
|
|
|
5258
5296
|
parameters: {
|
|
5259
5297
|
query?: {
|
|
5260
5298
|
/**
|
|
5261
|
-
* @description
|
|
5299
|
+
* @description Include related resources. Available relationships: claimingArtist
|
|
5262
5300
|
* @example claimingArtist.albums
|
|
5263
5301
|
*/
|
|
5264
5302
|
include?: string[];
|
|
@@ -5322,7 +5360,7 @@ export interface paths {
|
|
|
5322
5360
|
parameters: {
|
|
5323
5361
|
query?: {
|
|
5324
5362
|
/**
|
|
5325
|
-
* @description
|
|
5363
|
+
* @description Include related resources. Available relationships: owners
|
|
5326
5364
|
* @example owners
|
|
5327
5365
|
*/
|
|
5328
5366
|
include?: string[];
|
|
@@ -5383,10 +5421,12 @@ export interface paths {
|
|
|
5383
5421
|
parameters: {
|
|
5384
5422
|
query?: {
|
|
5385
5423
|
/**
|
|
5386
|
-
* @description
|
|
5424
|
+
* @description Include related resources. Available relationships: artist, category
|
|
5387
5425
|
* @example artist.albums
|
|
5388
5426
|
*/
|
|
5389
5427
|
include?: string[];
|
|
5428
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
5429
|
+
includeLinkage?: ("artist" | "category")[];
|
|
5390
5430
|
/**
|
|
5391
5431
|
* @description 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
5432
|
* @example artist.albums
|
|
@@ -5447,7 +5487,7 @@ export interface paths {
|
|
|
5447
5487
|
parameters: {
|
|
5448
5488
|
query?: {
|
|
5449
5489
|
/**
|
|
5450
|
-
* @description
|
|
5490
|
+
* @description Include related resources. Available relationships: artist
|
|
5451
5491
|
* @example artist.albums
|
|
5452
5492
|
*/
|
|
5453
5493
|
include?: string[];
|
|
@@ -5511,7 +5551,7 @@ export interface paths {
|
|
|
5511
5551
|
parameters: {
|
|
5512
5552
|
query?: {
|
|
5513
5553
|
/**
|
|
5514
|
-
* @description
|
|
5554
|
+
* @description Include related resources. Available relationships: category
|
|
5515
5555
|
* @example category
|
|
5516
5556
|
*/
|
|
5517
5557
|
include?: string[];
|
|
@@ -5571,8 +5611,10 @@ export interface paths {
|
|
|
5571
5611
|
query: {
|
|
5572
5612
|
/** @description Download id (e.g. `VFJBQ0tTOjEyMzQ1`) */
|
|
5573
5613
|
"filter[id]": string[];
|
|
5574
|
-
/** @description
|
|
5614
|
+
/** @description Include related resources. Available relationships: owners */
|
|
5575
5615
|
include?: string[];
|
|
5616
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
5617
|
+
includeLinkage?: "owners"[];
|
|
5576
5618
|
};
|
|
5577
5619
|
header?: never;
|
|
5578
5620
|
path?: never;
|
|
@@ -5621,8 +5663,10 @@ export interface paths {
|
|
|
5621
5663
|
get: {
|
|
5622
5664
|
parameters: {
|
|
5623
5665
|
query?: {
|
|
5624
|
-
/** @description
|
|
5666
|
+
/** @description Include related resources. Available relationships: owners */
|
|
5625
5667
|
include?: string[];
|
|
5668
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
5669
|
+
includeLinkage?: "owners"[];
|
|
5626
5670
|
};
|
|
5627
5671
|
header?: never;
|
|
5628
5672
|
path: {
|
|
@@ -5678,7 +5722,7 @@ export interface paths {
|
|
|
5678
5722
|
parameters: {
|
|
5679
5723
|
query?: {
|
|
5680
5724
|
/**
|
|
5681
|
-
* @description
|
|
5725
|
+
* @description Include related resources. Available relationships: owners
|
|
5682
5726
|
* @example owners
|
|
5683
5727
|
*/
|
|
5684
5728
|
include?: string[];
|
|
@@ -5739,7 +5783,7 @@ export interface paths {
|
|
|
5739
5783
|
parameters: {
|
|
5740
5784
|
query?: {
|
|
5741
5785
|
/**
|
|
5742
|
-
* @description
|
|
5786
|
+
* @description Include related resources. Available relationships: subject
|
|
5743
5787
|
* @example subject
|
|
5744
5788
|
*/
|
|
5745
5789
|
include?: string[];
|
|
@@ -5755,6 +5799,8 @@ export interface paths {
|
|
|
5755
5799
|
* @description Deprecated: use filter[subject]. The type of the subject resource (e.g. `tracks`)
|
|
5756
5800
|
*/
|
|
5757
5801
|
"filter[subject.type]"?: ("tracks" | "albums" | "artists")[];
|
|
5802
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
5803
|
+
includeLinkage?: "subject"[];
|
|
5758
5804
|
/**
|
|
5759
5805
|
* @description 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
5806
|
* @example subject
|
|
@@ -5809,7 +5855,7 @@ export interface paths {
|
|
|
5809
5855
|
parameters: {
|
|
5810
5856
|
query?: {
|
|
5811
5857
|
/**
|
|
5812
|
-
* @description
|
|
5858
|
+
* @description Include related resources. Available relationships: subject
|
|
5813
5859
|
* @example subject
|
|
5814
5860
|
*/
|
|
5815
5861
|
include?: string[];
|
|
@@ -5902,10 +5948,12 @@ export interface paths {
|
|
|
5902
5948
|
*/
|
|
5903
5949
|
locale?: string;
|
|
5904
5950
|
/**
|
|
5905
|
-
* @description
|
|
5951
|
+
* @description Include related resources. Available relationships: items, seedItem
|
|
5906
5952
|
* @example items
|
|
5907
5953
|
*/
|
|
5908
5954
|
include?: string[];
|
|
5955
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
5956
|
+
includeLinkage?: ("items" | "seedItem")[];
|
|
5909
5957
|
/**
|
|
5910
5958
|
* @description 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
5959
|
* @example items
|
|
@@ -5987,10 +6035,12 @@ export interface paths {
|
|
|
5987
6035
|
*/
|
|
5988
6036
|
locale?: string;
|
|
5989
6037
|
/**
|
|
5990
|
-
* @description
|
|
6038
|
+
* @description Include related resources. Available relationships: items, seedItem
|
|
5991
6039
|
* @example items
|
|
5992
6040
|
*/
|
|
5993
6041
|
include?: string[];
|
|
6042
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
6043
|
+
includeLinkage?: ("items" | "seedItem")[];
|
|
5994
6044
|
/**
|
|
5995
6045
|
* @description 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
6046
|
* @example items
|
|
@@ -6080,7 +6130,7 @@ export interface paths {
|
|
|
6080
6130
|
*/
|
|
6081
6131
|
locale?: string;
|
|
6082
6132
|
/**
|
|
6083
|
-
* @description
|
|
6133
|
+
* @description Include related resources. Available relationships: items
|
|
6084
6134
|
* @example items
|
|
6085
6135
|
*/
|
|
6086
6136
|
include?: string[];
|
|
@@ -6171,7 +6221,7 @@ export interface paths {
|
|
|
6171
6221
|
*/
|
|
6172
6222
|
locale?: string;
|
|
6173
6223
|
/**
|
|
6174
|
-
* @description
|
|
6224
|
+
* @description Include related resources. Available relationships: seedItem
|
|
6175
6225
|
* @example seedItem
|
|
6176
6226
|
*/
|
|
6177
6227
|
include?: string[];
|
|
@@ -6264,7 +6314,7 @@ export interface paths {
|
|
|
6264
6314
|
*/
|
|
6265
6315
|
locale?: string;
|
|
6266
6316
|
/**
|
|
6267
|
-
* @description
|
|
6317
|
+
* @description Include related resources. Available relationships: modules, subject
|
|
6268
6318
|
* @example modules.items
|
|
6269
6319
|
*/
|
|
6270
6320
|
include?: string[];
|
|
@@ -6275,6 +6325,8 @@ export interface paths {
|
|
|
6275
6325
|
* @description Deprecated alternative to filter[subject]. Omit when subject is supplied or pageType is HOME_FREE. (e.g. `67890`)
|
|
6276
6326
|
*/
|
|
6277
6327
|
"filter[subject.id]"?: string[];
|
|
6328
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
6329
|
+
includeLinkage?: ("modules" | "subject")[];
|
|
6278
6330
|
/**
|
|
6279
6331
|
* @description 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
6332
|
* @example modules.items
|
|
@@ -6358,7 +6410,7 @@ export interface paths {
|
|
|
6358
6410
|
*/
|
|
6359
6411
|
locale?: string;
|
|
6360
6412
|
/**
|
|
6361
|
-
* @description
|
|
6413
|
+
* @description Include related resources. Available relationships: modules
|
|
6362
6414
|
* @example modules.items
|
|
6363
6415
|
*/
|
|
6364
6416
|
include?: string[];
|
|
@@ -6422,7 +6474,7 @@ export interface paths {
|
|
|
6422
6474
|
parameters: {
|
|
6423
6475
|
query?: {
|
|
6424
6476
|
/**
|
|
6425
|
-
* @description
|
|
6477
|
+
* @description Include related resources. Available relationships: subject
|
|
6426
6478
|
* @example subject
|
|
6427
6479
|
*/
|
|
6428
6480
|
include?: string[];
|
|
@@ -6542,10 +6594,12 @@ export interface paths {
|
|
|
6542
6594
|
parameters: {
|
|
6543
6595
|
query?: {
|
|
6544
6596
|
/**
|
|
6545
|
-
* @description
|
|
6597
|
+
* @description Include related resources. Available relationships: owners, parent, subject
|
|
6546
6598
|
* @example parent.children.subject
|
|
6547
6599
|
*/
|
|
6548
6600
|
include?: string[];
|
|
6601
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
6602
|
+
includeLinkage?: ("owners" | "parent" | "subject")[];
|
|
6549
6603
|
/**
|
|
6550
6604
|
* @description 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
6605
|
* @example parent.children.subject
|
|
@@ -6648,7 +6702,7 @@ export interface paths {
|
|
|
6648
6702
|
parameters: {
|
|
6649
6703
|
query?: {
|
|
6650
6704
|
/**
|
|
6651
|
-
* @description
|
|
6705
|
+
* @description Include related resources. Available relationships: owners
|
|
6652
6706
|
* @example owners
|
|
6653
6707
|
*/
|
|
6654
6708
|
include?: string[];
|
|
@@ -6709,7 +6763,7 @@ export interface paths {
|
|
|
6709
6763
|
parameters: {
|
|
6710
6764
|
query?: {
|
|
6711
6765
|
/**
|
|
6712
|
-
* @description
|
|
6766
|
+
* @description Include related resources. Available relationships: parent
|
|
6713
6767
|
* @example parent.children.subject
|
|
6714
6768
|
*/
|
|
6715
6769
|
include?: string[];
|
|
@@ -6819,7 +6873,7 @@ export interface paths {
|
|
|
6819
6873
|
parameters: {
|
|
6820
6874
|
query?: {
|
|
6821
6875
|
/**
|
|
6822
|
-
* @description
|
|
6876
|
+
* @description Include related resources. Available relationships: subject
|
|
6823
6877
|
* @example subject
|
|
6824
6878
|
*/
|
|
6825
6879
|
include?: string[];
|
|
@@ -6939,10 +6993,12 @@ export interface paths {
|
|
|
6939
6993
|
parameters: {
|
|
6940
6994
|
query?: {
|
|
6941
6995
|
/**
|
|
6942
|
-
* @description
|
|
6996
|
+
* @description Include related resources. Available relationships: children, owners
|
|
6943
6997
|
* @example children.subject
|
|
6944
6998
|
*/
|
|
6945
6999
|
include?: string[];
|
|
7000
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
7001
|
+
includeLinkage?: ("children" | "owners")[];
|
|
6946
7002
|
/**
|
|
6947
7003
|
* @description 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
7004
|
* @example children.subject
|
|
@@ -7093,7 +7149,7 @@ export interface paths {
|
|
|
7093
7149
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
7094
7150
|
"page[cursor]"?: string;
|
|
7095
7151
|
/**
|
|
7096
|
-
* @description
|
|
7152
|
+
* @description Include related resources. Available relationships: children
|
|
7097
7153
|
* @example children.subject
|
|
7098
7154
|
*/
|
|
7099
7155
|
include?: string[];
|
|
@@ -7157,7 +7213,7 @@ export interface paths {
|
|
|
7157
7213
|
parameters: {
|
|
7158
7214
|
query?: {
|
|
7159
7215
|
/**
|
|
7160
|
-
* @description
|
|
7216
|
+
* @description Include related resources. Available relationships: owners
|
|
7161
7217
|
* @example owners
|
|
7162
7218
|
*/
|
|
7163
7219
|
include?: string[];
|
|
@@ -7336,7 +7392,7 @@ export interface paths {
|
|
|
7336
7392
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
7337
7393
|
"page[cursor]"?: string;
|
|
7338
7394
|
/**
|
|
7339
|
-
* @description
|
|
7395
|
+
* @description Include related resources. Available relationships: offlineInventory, owners
|
|
7340
7396
|
* @example offlineInventory
|
|
7341
7397
|
*/
|
|
7342
7398
|
include?: string[];
|
|
@@ -7344,6 +7400,8 @@ export interface paths {
|
|
|
7344
7400
|
"filter[clientProvidedInstallationId]"?: string[];
|
|
7345
7401
|
/** @description User ID to filter by. Use `me` for the authenticated user */
|
|
7346
7402
|
"filter[owners.id]"?: string[];
|
|
7403
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
7404
|
+
includeLinkage?: ("offlineInventory" | "owners")[];
|
|
7347
7405
|
/**
|
|
7348
7406
|
* @description 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
7407
|
* @example offlineInventory
|
|
@@ -7438,10 +7496,12 @@ export interface paths {
|
|
|
7438
7496
|
parameters: {
|
|
7439
7497
|
query?: {
|
|
7440
7498
|
/**
|
|
7441
|
-
* @description
|
|
7499
|
+
* @description Include related resources. Available relationships: offlineInventory, owners
|
|
7442
7500
|
* @example offlineInventory
|
|
7443
7501
|
*/
|
|
7444
7502
|
include?: string[];
|
|
7503
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
7504
|
+
includeLinkage?: ("offlineInventory" | "owners")[];
|
|
7445
7505
|
/**
|
|
7446
7506
|
* @description 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
7507
|
* @example offlineInventory
|
|
@@ -7506,7 +7566,7 @@ export interface paths {
|
|
|
7506
7566
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
7507
7567
|
"page[cursor]"?: string;
|
|
7508
7568
|
/**
|
|
7509
|
-
* @description
|
|
7569
|
+
* @description Include related resources. Available relationships: offlineInventory
|
|
7510
7570
|
* @example offlineInventory
|
|
7511
7571
|
*/
|
|
7512
7572
|
include?: string[];
|
|
@@ -7666,7 +7726,7 @@ export interface paths {
|
|
|
7666
7726
|
parameters: {
|
|
7667
7727
|
query?: {
|
|
7668
7728
|
/**
|
|
7669
|
-
* @description
|
|
7729
|
+
* @description Include related resources. Available relationships: owners
|
|
7670
7730
|
* @example owners
|
|
7671
7731
|
*/
|
|
7672
7732
|
include?: string[];
|
|
@@ -7783,10 +7843,12 @@ export interface paths {
|
|
|
7783
7843
|
parameters: {
|
|
7784
7844
|
query?: {
|
|
7785
7845
|
/**
|
|
7786
|
-
* @description
|
|
7846
|
+
* @description Include related resources. Available relationships: owners, track
|
|
7787
7847
|
* @example track
|
|
7788
7848
|
*/
|
|
7789
7849
|
include?: string[];
|
|
7850
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
7851
|
+
includeLinkage?: ("owners" | "track")[];
|
|
7790
7852
|
/**
|
|
7791
7853
|
* @description 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
7854
|
* @example track
|
|
@@ -7935,7 +7997,7 @@ export interface paths {
|
|
|
7935
7997
|
parameters: {
|
|
7936
7998
|
query?: {
|
|
7937
7999
|
/**
|
|
7938
|
-
* @description
|
|
8000
|
+
* @description Include related resources. Available relationships: owners
|
|
7939
8001
|
* @example owners
|
|
7940
8002
|
*/
|
|
7941
8003
|
include?: string[];
|
|
@@ -8001,7 +8063,7 @@ export interface paths {
|
|
|
8001
8063
|
*/
|
|
8002
8064
|
countryCode?: string;
|
|
8003
8065
|
/**
|
|
8004
|
-
* @description
|
|
8066
|
+
* @description Include related resources. Available relationships: track
|
|
8005
8067
|
* @example track
|
|
8006
8068
|
*/
|
|
8007
8069
|
include?: string[];
|
|
@@ -8125,10 +8187,12 @@ export interface paths {
|
|
|
8125
8187
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
8126
8188
|
"page[cursor]"?: string;
|
|
8127
8189
|
/**
|
|
8128
|
-
* @description
|
|
8190
|
+
* @description Include related resources. Available relationships: collection, item, owners
|
|
8129
8191
|
* @example collection
|
|
8130
8192
|
*/
|
|
8131
8193
|
include?: string[];
|
|
8194
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
8195
|
+
includeLinkage?: ("collection" | "item" | "owners")[];
|
|
8132
8196
|
/**
|
|
8133
8197
|
* @description 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
8198
|
* @example collection
|
|
@@ -8183,10 +8247,12 @@ export interface paths {
|
|
|
8183
8247
|
parameters: {
|
|
8184
8248
|
query?: {
|
|
8185
8249
|
/**
|
|
8186
|
-
* @description
|
|
8250
|
+
* @description Include related resources. Available relationships: collection, item, owners
|
|
8187
8251
|
* @example collection
|
|
8188
8252
|
*/
|
|
8189
8253
|
include?: string[];
|
|
8254
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
8255
|
+
includeLinkage?: ("collection" | "item" | "owners")[];
|
|
8190
8256
|
/**
|
|
8191
8257
|
* @description 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
8258
|
* @example collection
|
|
@@ -8293,7 +8359,7 @@ export interface paths {
|
|
|
8293
8359
|
parameters: {
|
|
8294
8360
|
query?: {
|
|
8295
8361
|
/**
|
|
8296
|
-
* @description
|
|
8362
|
+
* @description Include related resources. Available relationships: collection
|
|
8297
8363
|
* @example collection
|
|
8298
8364
|
*/
|
|
8299
8365
|
include?: string[];
|
|
@@ -8357,7 +8423,7 @@ export interface paths {
|
|
|
8357
8423
|
parameters: {
|
|
8358
8424
|
query?: {
|
|
8359
8425
|
/**
|
|
8360
|
-
* @description
|
|
8426
|
+
* @description Include related resources. Available relationships: item
|
|
8361
8427
|
* @example item
|
|
8362
8428
|
*/
|
|
8363
8429
|
include?: string[];
|
|
@@ -8421,7 +8487,7 @@ export interface paths {
|
|
|
8421
8487
|
parameters: {
|
|
8422
8488
|
query?: {
|
|
8423
8489
|
/**
|
|
8424
|
-
* @description
|
|
8490
|
+
* @description Include related resources. Available relationships: owners
|
|
8425
8491
|
* @example owners
|
|
8426
8492
|
*/
|
|
8427
8493
|
include?: string[];
|
|
@@ -8486,10 +8552,12 @@ export interface paths {
|
|
|
8486
8552
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
8487
8553
|
"page[cursor]"?: string;
|
|
8488
8554
|
/**
|
|
8489
|
-
* @description
|
|
8555
|
+
* @description Include related resources. Available relationships: changeEventStream, current, future, owners, past
|
|
8490
8556
|
* @example current
|
|
8491
8557
|
*/
|
|
8492
8558
|
include?: string[];
|
|
8559
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
8560
|
+
includeLinkage?: ("changeEventStream" | "current" | "future" | "owners" | "past")[];
|
|
8493
8561
|
/**
|
|
8494
8562
|
* @description 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
8563
|
* @example current
|
|
@@ -8584,10 +8652,12 @@ export interface paths {
|
|
|
8584
8652
|
parameters: {
|
|
8585
8653
|
query?: {
|
|
8586
8654
|
/**
|
|
8587
|
-
* @description
|
|
8655
|
+
* @description Include related resources. Available relationships: changeEventStream, current, future, owners, past
|
|
8588
8656
|
* @example current
|
|
8589
8657
|
*/
|
|
8590
8658
|
include?: string[];
|
|
8659
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
8660
|
+
includeLinkage?: ("changeEventStream" | "current" | "future" | "owners" | "past")[];
|
|
8591
8661
|
/**
|
|
8592
8662
|
* @description 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
8663
|
* @example current
|
|
@@ -8736,7 +8806,7 @@ export interface paths {
|
|
|
8736
8806
|
parameters: {
|
|
8737
8807
|
query?: {
|
|
8738
8808
|
/**
|
|
8739
|
-
* @description
|
|
8809
|
+
* @description Include related resources. Available relationships: changeEventStream
|
|
8740
8810
|
* @example changeEventStream
|
|
8741
8811
|
*/
|
|
8742
8812
|
include?: string[];
|
|
@@ -8791,7 +8861,7 @@ export interface paths {
|
|
|
8791
8861
|
parameters: {
|
|
8792
8862
|
query?: {
|
|
8793
8863
|
/**
|
|
8794
|
-
* @description
|
|
8864
|
+
* @description Include related resources. Available relationships: current
|
|
8795
8865
|
* @example current
|
|
8796
8866
|
*/
|
|
8797
8867
|
include?: string[];
|
|
@@ -8903,7 +8973,7 @@ export interface paths {
|
|
|
8903
8973
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
8904
8974
|
"page[cursor]"?: string;
|
|
8905
8975
|
/**
|
|
8906
|
-
* @description
|
|
8976
|
+
* @description Include related resources. Available relationships: future
|
|
8907
8977
|
* @example future
|
|
8908
8978
|
*/
|
|
8909
8979
|
include?: string[];
|
|
@@ -8947,7 +9017,7 @@ export interface paths {
|
|
|
8947
9017
|
put?: never;
|
|
8948
9018
|
/**
|
|
8949
9019
|
* Add to future relationship ("to-many").
|
|
8950
|
-
* @description
|
|
9020
|
+
* @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
9021
|
*/
|
|
8952
9022
|
post: {
|
|
8953
9023
|
parameters: {
|
|
@@ -9105,7 +9175,7 @@ export interface paths {
|
|
|
9105
9175
|
parameters: {
|
|
9106
9176
|
query?: {
|
|
9107
9177
|
/**
|
|
9108
|
-
* @description
|
|
9178
|
+
* @description Include related resources. Available relationships: owners
|
|
9109
9179
|
* @example owners
|
|
9110
9180
|
*/
|
|
9111
9181
|
include?: string[];
|
|
@@ -9168,7 +9238,7 @@ export interface paths {
|
|
|
9168
9238
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
9169
9239
|
"page[cursor]"?: string;
|
|
9170
9240
|
/**
|
|
9171
|
-
* @description
|
|
9241
|
+
* @description Include related resources. Available relationships: past
|
|
9172
9242
|
* @example past
|
|
9173
9243
|
*/
|
|
9174
9244
|
include?: string[];
|
|
@@ -9234,10 +9304,12 @@ export interface paths {
|
|
|
9234
9304
|
/** @description Playlist id (e.g. `550e8400-e29b-41d4-a716-446655440000`) */
|
|
9235
9305
|
"filter[playlist.id]": string[];
|
|
9236
9306
|
/**
|
|
9237
|
-
* @description
|
|
9307
|
+
* @description Include related resources. Available relationships: playlist
|
|
9238
9308
|
* @example playlist.items
|
|
9239
9309
|
*/
|
|
9240
9310
|
include?: string[];
|
|
9311
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
9312
|
+
includeLinkage?: "playlist"[];
|
|
9241
9313
|
/**
|
|
9242
9314
|
* @description 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
9315
|
* @example playlist.items
|
|
@@ -9333,10 +9405,12 @@ export interface paths {
|
|
|
9333
9405
|
parameters: {
|
|
9334
9406
|
query?: {
|
|
9335
9407
|
/**
|
|
9336
|
-
* @description
|
|
9408
|
+
* @description Include related resources. Available relationships: playlist
|
|
9337
9409
|
* @example playlist.items
|
|
9338
9410
|
*/
|
|
9339
9411
|
include?: string[];
|
|
9412
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
9413
|
+
includeLinkage?: "playlist"[];
|
|
9340
9414
|
/**
|
|
9341
9415
|
* @description 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
9416
|
* @example playlist.items
|
|
@@ -9473,7 +9547,7 @@ export interface paths {
|
|
|
9473
9547
|
parameters: {
|
|
9474
9548
|
query?: {
|
|
9475
9549
|
/**
|
|
9476
|
-
* @description
|
|
9550
|
+
* @description Include related resources. Available relationships: playlist
|
|
9477
9551
|
* @example playlist.items
|
|
9478
9552
|
*/
|
|
9479
9553
|
include?: string[];
|
|
@@ -9535,10 +9609,12 @@ export interface paths {
|
|
|
9535
9609
|
/** @description Playlist id (e.g. `550e8400-e29b-41d4-a716-446655440000`) */
|
|
9536
9610
|
"filter[playlist.id]": string[];
|
|
9537
9611
|
/**
|
|
9538
|
-
* @description
|
|
9612
|
+
* @description Include related resources. Available relationships: baseGeneration, playlist, trackPreferences
|
|
9539
9613
|
* @example baseGeneration.trackPreferences
|
|
9540
9614
|
*/
|
|
9541
9615
|
include?: string[];
|
|
9616
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
9617
|
+
includeLinkage?: ("baseGeneration" | "playlist" | "trackPreferences")[];
|
|
9542
9618
|
/**
|
|
9543
9619
|
* @description 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
9620
|
* @example baseGeneration.trackPreferences
|
|
@@ -9633,10 +9709,12 @@ export interface paths {
|
|
|
9633
9709
|
parameters: {
|
|
9634
9710
|
query?: {
|
|
9635
9711
|
/**
|
|
9636
|
-
* @description
|
|
9712
|
+
* @description Include related resources. Available relationships: baseGeneration, playlist, trackPreferences
|
|
9637
9713
|
* @example baseGeneration.trackPreferences
|
|
9638
9714
|
*/
|
|
9639
9715
|
include?: string[];
|
|
9716
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
9717
|
+
includeLinkage?: ("baseGeneration" | "playlist" | "trackPreferences")[];
|
|
9640
9718
|
/**
|
|
9641
9719
|
* @description 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
9720
|
* @example baseGeneration.trackPreferences
|
|
@@ -9697,7 +9775,7 @@ export interface paths {
|
|
|
9697
9775
|
parameters: {
|
|
9698
9776
|
query?: {
|
|
9699
9777
|
/**
|
|
9700
|
-
* @description
|
|
9778
|
+
* @description Include related resources. Available relationships: baseGeneration
|
|
9701
9779
|
* @example baseGeneration.trackPreferences
|
|
9702
9780
|
*/
|
|
9703
9781
|
include?: string[];
|
|
@@ -9761,7 +9839,7 @@ export interface paths {
|
|
|
9761
9839
|
parameters: {
|
|
9762
9840
|
query?: {
|
|
9763
9841
|
/**
|
|
9764
|
-
* @description
|
|
9842
|
+
* @description Include related resources. Available relationships: playlist
|
|
9765
9843
|
* @example playlist.items
|
|
9766
9844
|
*/
|
|
9767
9845
|
include?: string[];
|
|
@@ -9827,7 +9905,7 @@ export interface paths {
|
|
|
9827
9905
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
9828
9906
|
"page[cursor]"?: string;
|
|
9829
9907
|
/**
|
|
9830
|
-
* @description
|
|
9908
|
+
* @description Include related resources. Available relationships: trackPreferences
|
|
9831
9909
|
* @example trackPreferences
|
|
9832
9910
|
*/
|
|
9833
9911
|
include?: string[];
|
|
@@ -10038,7 +10116,7 @@ export interface paths {
|
|
|
10038
10116
|
*/
|
|
10039
10117
|
countryCode?: string;
|
|
10040
10118
|
/**
|
|
10041
|
-
* @description
|
|
10119
|
+
* @description Include related resources. Available relationships: collaboratorProfiles, collaborators, coverArt, curators, items, ownerProfiles, owners, suggestedCoverArts
|
|
10042
10120
|
* @example curators.albums
|
|
10043
10121
|
*/
|
|
10044
10122
|
include?: string[];
|
|
@@ -10048,6 +10126,8 @@ export interface paths {
|
|
|
10048
10126
|
"filter[id]"?: string[];
|
|
10049
10127
|
/** @description User id. Use `me` for the authenticated user */
|
|
10050
10128
|
"filter[owners.id]"?: string[];
|
|
10129
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
10130
|
+
includeLinkage?: ("collaboratorProfiles" | "collaborators" | "coverArt" | "curators" | "items" | "ownerProfiles" | "owners" | "suggestedCoverArts")[];
|
|
10051
10131
|
/**
|
|
10052
10132
|
* @description 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
10133
|
* @example curators.albums
|
|
@@ -10147,10 +10227,12 @@ export interface paths {
|
|
|
10147
10227
|
*/
|
|
10148
10228
|
countryCode?: string;
|
|
10149
10229
|
/**
|
|
10150
|
-
* @description
|
|
10230
|
+
* @description Include related resources. Available relationships: collaboratorProfiles, collaborators, coverArt, curators, items, ownerProfiles, owners, suggestedCoverArts
|
|
10151
10231
|
* @example curators.albums
|
|
10152
10232
|
*/
|
|
10153
10233
|
include?: string[];
|
|
10234
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
10235
|
+
includeLinkage?: ("collaboratorProfiles" | "collaborators" | "coverArt" | "curators" | "items" | "ownerProfiles" | "owners" | "suggestedCoverArts")[];
|
|
10154
10236
|
/**
|
|
10155
10237
|
* @description 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
10238
|
* @example curators.albums
|
|
@@ -10300,7 +10382,7 @@ export interface paths {
|
|
|
10300
10382
|
parameters: {
|
|
10301
10383
|
query?: {
|
|
10302
10384
|
/**
|
|
10303
|
-
* @description
|
|
10385
|
+
* @description Include related resources. Available relationships: collaboratorProfiles
|
|
10304
10386
|
* @example collaboratorProfiles
|
|
10305
10387
|
*/
|
|
10306
10388
|
include?: string[];
|
|
@@ -10408,7 +10490,7 @@ export interface paths {
|
|
|
10408
10490
|
parameters: {
|
|
10409
10491
|
query?: {
|
|
10410
10492
|
/**
|
|
10411
|
-
* @description
|
|
10493
|
+
* @description Include related resources. Available relationships: collaborators
|
|
10412
10494
|
* @example collaborators
|
|
10413
10495
|
*/
|
|
10414
10496
|
include?: string[];
|
|
@@ -10474,7 +10556,7 @@ export interface paths {
|
|
|
10474
10556
|
*/
|
|
10475
10557
|
countryCode?: string;
|
|
10476
10558
|
/**
|
|
10477
|
-
* @description
|
|
10559
|
+
* @description Include related resources. Available relationships: coverArt
|
|
10478
10560
|
* @example coverArt
|
|
10479
10561
|
*/
|
|
10480
10562
|
include?: string[];
|
|
@@ -10583,7 +10665,7 @@ export interface paths {
|
|
|
10583
10665
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
10584
10666
|
"page[cursor]"?: string;
|
|
10585
10667
|
/**
|
|
10586
|
-
* @description
|
|
10668
|
+
* @description Include related resources. Available relationships: curators
|
|
10587
10669
|
* @example curators.albums
|
|
10588
10670
|
*/
|
|
10589
10671
|
include?: string[];
|
|
@@ -10656,7 +10738,7 @@ export interface paths {
|
|
|
10656
10738
|
*/
|
|
10657
10739
|
countryCode?: string;
|
|
10658
10740
|
/**
|
|
10659
|
-
* @description
|
|
10741
|
+
* @description Include related resources. Available relationships: items
|
|
10660
10742
|
* @example items
|
|
10661
10743
|
*/
|
|
10662
10744
|
include?: string[];
|
|
@@ -10861,7 +10943,7 @@ export interface paths {
|
|
|
10861
10943
|
parameters: {
|
|
10862
10944
|
query?: {
|
|
10863
10945
|
/**
|
|
10864
|
-
* @description
|
|
10946
|
+
* @description Include related resources. Available relationships: ownerProfiles
|
|
10865
10947
|
* @example ownerProfiles
|
|
10866
10948
|
*/
|
|
10867
10949
|
include?: string[];
|
|
@@ -10922,7 +11004,7 @@ export interface paths {
|
|
|
10922
11004
|
parameters: {
|
|
10923
11005
|
query?: {
|
|
10924
11006
|
/**
|
|
10925
|
-
* @description
|
|
11007
|
+
* @description Include related resources. Available relationships: owners
|
|
10926
11008
|
* @example owners
|
|
10927
11009
|
*/
|
|
10928
11010
|
include?: string[];
|
|
@@ -10983,7 +11065,7 @@ export interface paths {
|
|
|
10983
11065
|
parameters: {
|
|
10984
11066
|
query?: {
|
|
10985
11067
|
/**
|
|
10986
|
-
* @description
|
|
11068
|
+
* @description Include related resources. Available relationships: suggestedCoverArts
|
|
10987
11069
|
* @example suggestedCoverArts
|
|
10988
11070
|
*/
|
|
10989
11071
|
include?: string[];
|
|
@@ -11189,10 +11271,12 @@ export interface paths {
|
|
|
11189
11271
|
/** @description User id. Use `me` for the authenticated user */
|
|
11190
11272
|
"filter[owners.id]": string[];
|
|
11191
11273
|
/**
|
|
11192
|
-
* @description
|
|
11274
|
+
* @description Include related resources. Available relationships: owners, provider
|
|
11193
11275
|
* @example provider
|
|
11194
11276
|
*/
|
|
11195
11277
|
include?: string[];
|
|
11278
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
11279
|
+
includeLinkage?: ("owners" | "provider")[];
|
|
11196
11280
|
};
|
|
11197
11281
|
header?: never;
|
|
11198
11282
|
path?: never;
|
|
@@ -11242,7 +11326,7 @@ export interface paths {
|
|
|
11242
11326
|
parameters: {
|
|
11243
11327
|
query?: {
|
|
11244
11328
|
/**
|
|
11245
|
-
* @description
|
|
11329
|
+
* @description Include related resources. Available relationships: owners
|
|
11246
11330
|
* @example owners
|
|
11247
11331
|
*/
|
|
11248
11332
|
include?: string[];
|
|
@@ -11300,7 +11384,7 @@ export interface paths {
|
|
|
11300
11384
|
parameters: {
|
|
11301
11385
|
query?: {
|
|
11302
11386
|
/**
|
|
11303
|
-
* @description
|
|
11387
|
+
* @description Include related resources. Available relationships: provider
|
|
11304
11388
|
* @example provider
|
|
11305
11389
|
*/
|
|
11306
11390
|
include?: string[];
|
|
@@ -11363,7 +11447,7 @@ export interface paths {
|
|
|
11363
11447
|
*/
|
|
11364
11448
|
countryCode?: string;
|
|
11365
11449
|
/**
|
|
11366
|
-
* @description
|
|
11450
|
+
* @description Include related resources. Available relationships: provider, subject
|
|
11367
11451
|
* @example subject
|
|
11368
11452
|
*/
|
|
11369
11453
|
include?: string[];
|
|
@@ -11371,6 +11455,8 @@ export interface paths {
|
|
|
11371
11455
|
"filter[barcodeId]"?: string[];
|
|
11372
11456
|
/** @description List of GRIDs (Global Release Identifier, ISO 7064) (e.g. `A10302B0013941653J`) */
|
|
11373
11457
|
"filter[grid]"?: string[];
|
|
11458
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
11459
|
+
includeLinkage?: ("provider" | "subject")[];
|
|
11374
11460
|
/**
|
|
11375
11461
|
* @description 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
11462
|
* @example subject
|
|
@@ -11425,7 +11511,7 @@ export interface paths {
|
|
|
11425
11511
|
parameters: {
|
|
11426
11512
|
query?: {
|
|
11427
11513
|
/**
|
|
11428
|
-
* @description
|
|
11514
|
+
* @description Include related resources. Available relationships: provider
|
|
11429
11515
|
* @example provider
|
|
11430
11516
|
*/
|
|
11431
11517
|
include?: string[];
|
|
@@ -11486,7 +11572,7 @@ export interface paths {
|
|
|
11486
11572
|
*/
|
|
11487
11573
|
countryCode?: string;
|
|
11488
11574
|
/**
|
|
11489
|
-
* @description
|
|
11575
|
+
* @description Include related resources. Available relationships: subject
|
|
11490
11576
|
* @example subject
|
|
11491
11577
|
*/
|
|
11492
11578
|
include?: string[];
|
|
@@ -11606,10 +11692,12 @@ export interface paths {
|
|
|
11606
11692
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
11607
11693
|
"page[cursor]"?: string;
|
|
11608
11694
|
/**
|
|
11609
|
-
* @description
|
|
11695
|
+
* @description Include related resources. Available relationships: owners, subject
|
|
11610
11696
|
* @example subject
|
|
11611
11697
|
*/
|
|
11612
11698
|
include?: string[];
|
|
11699
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
11700
|
+
includeLinkage?: ("owners" | "subject")[];
|
|
11613
11701
|
/**
|
|
11614
11702
|
* @description 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
11703
|
* @example subject
|
|
@@ -11664,7 +11752,7 @@ export interface paths {
|
|
|
11664
11752
|
parameters: {
|
|
11665
11753
|
query?: {
|
|
11666
11754
|
/**
|
|
11667
|
-
* @description
|
|
11755
|
+
* @description Include related resources. Available relationships: owners
|
|
11668
11756
|
* @example owners
|
|
11669
11757
|
*/
|
|
11670
11758
|
include?: string[];
|
|
@@ -11725,7 +11813,7 @@ export interface paths {
|
|
|
11725
11813
|
parameters: {
|
|
11726
11814
|
query?: {
|
|
11727
11815
|
/**
|
|
11728
|
-
* @description
|
|
11816
|
+
* @description Include related resources. Available relationships: subject
|
|
11729
11817
|
* @example subject
|
|
11730
11818
|
*/
|
|
11731
11819
|
include?: string[];
|
|
@@ -11794,7 +11882,7 @@ export interface paths {
|
|
|
11794
11882
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
11795
11883
|
"page[cursor]"?: string;
|
|
11796
11884
|
/**
|
|
11797
|
-
* @description
|
|
11885
|
+
* @description Include related resources. Available relationships: author, ownerProfiles, owners
|
|
11798
11886
|
* @example author.albums
|
|
11799
11887
|
*/
|
|
11800
11888
|
include?: string[];
|
|
@@ -11812,6 +11900,8 @@ export interface paths {
|
|
|
11812
11900
|
* @description Deprecated: use filter[subject]. Filter by subject resource type (e.g. `albums`)
|
|
11813
11901
|
*/
|
|
11814
11902
|
"filter[subject.type]"?: ("albums" | "tracks" | "artists" | "videos" | "playlists" | "comments" | "trackSourceFiles")[];
|
|
11903
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
11904
|
+
includeLinkage?: ("author" | "ownerProfiles" | "owners")[];
|
|
11815
11905
|
/**
|
|
11816
11906
|
* @description 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
11907
|
* @example author.albums
|
|
@@ -11964,7 +12054,7 @@ export interface paths {
|
|
|
11964
12054
|
parameters: {
|
|
11965
12055
|
query?: {
|
|
11966
12056
|
/**
|
|
11967
|
-
* @description
|
|
12057
|
+
* @description Include related resources. Available relationships: author
|
|
11968
12058
|
* @example author.albums
|
|
11969
12059
|
*/
|
|
11970
12060
|
include?: string[];
|
|
@@ -12029,7 +12119,7 @@ export interface paths {
|
|
|
12029
12119
|
parameters: {
|
|
12030
12120
|
query?: {
|
|
12031
12121
|
/**
|
|
12032
|
-
* @description
|
|
12122
|
+
* @description Include related resources. Available relationships: ownerProfiles
|
|
12033
12123
|
* @example ownerProfiles
|
|
12034
12124
|
*/
|
|
12035
12125
|
include?: string[];
|
|
@@ -12090,7 +12180,7 @@ export interface paths {
|
|
|
12090
12180
|
parameters: {
|
|
12091
12181
|
query?: {
|
|
12092
12182
|
/**
|
|
12093
|
-
* @description
|
|
12183
|
+
* @description Include related resources. Available relationships: owners
|
|
12094
12184
|
* @example owners
|
|
12095
12185
|
*/
|
|
12096
12186
|
include?: string[];
|
|
@@ -12342,10 +12432,12 @@ export interface paths {
|
|
|
12342
12432
|
*/
|
|
12343
12433
|
clientVersion?: string;
|
|
12344
12434
|
/**
|
|
12345
|
-
* @description
|
|
12435
|
+
* @description Include related resources. Available relationships: albums, artists, playlists, topHits, tracks, videos
|
|
12346
12436
|
* @example albums
|
|
12347
12437
|
*/
|
|
12348
12438
|
include?: string[];
|
|
12439
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
12440
|
+
includeLinkage?: ("albums" | "artists" | "playlists" | "topHits" | "tracks" | "videos")[];
|
|
12349
12441
|
/**
|
|
12350
12442
|
* @description 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
12443
|
* @example albums
|
|
@@ -12427,7 +12519,7 @@ export interface paths {
|
|
|
12427
12519
|
*/
|
|
12428
12520
|
clientVersion?: string;
|
|
12429
12521
|
/**
|
|
12430
|
-
* @description
|
|
12522
|
+
* @description Include related resources. Available relationships: albums
|
|
12431
12523
|
* @example albums
|
|
12432
12524
|
*/
|
|
12433
12525
|
include?: string[];
|
|
@@ -12515,7 +12607,7 @@ export interface paths {
|
|
|
12515
12607
|
*/
|
|
12516
12608
|
clientVersion?: string;
|
|
12517
12609
|
/**
|
|
12518
|
-
* @description
|
|
12610
|
+
* @description Include related resources. Available relationships: artists
|
|
12519
12611
|
* @example artists
|
|
12520
12612
|
*/
|
|
12521
12613
|
include?: string[];
|
|
@@ -12603,7 +12695,7 @@ export interface paths {
|
|
|
12603
12695
|
*/
|
|
12604
12696
|
clientVersion?: string;
|
|
12605
12697
|
/**
|
|
12606
|
-
* @description
|
|
12698
|
+
* @description Include related resources. Available relationships: playlists
|
|
12607
12699
|
* @example playlists
|
|
12608
12700
|
*/
|
|
12609
12701
|
include?: string[];
|
|
@@ -12691,7 +12783,7 @@ export interface paths {
|
|
|
12691
12783
|
*/
|
|
12692
12784
|
clientVersion?: string;
|
|
12693
12785
|
/**
|
|
12694
|
-
* @description
|
|
12786
|
+
* @description Include related resources. Available relationships: topHits
|
|
12695
12787
|
* @example topHits
|
|
12696
12788
|
*/
|
|
12697
12789
|
include?: string[];
|
|
@@ -12779,7 +12871,7 @@ export interface paths {
|
|
|
12779
12871
|
*/
|
|
12780
12872
|
clientVersion?: string;
|
|
12781
12873
|
/**
|
|
12782
|
-
* @description
|
|
12874
|
+
* @description Include related resources. Available relationships: tracks
|
|
12783
12875
|
* @example tracks
|
|
12784
12876
|
*/
|
|
12785
12877
|
include?: string[];
|
|
@@ -12867,7 +12959,7 @@ export interface paths {
|
|
|
12867
12959
|
*/
|
|
12868
12960
|
clientVersion?: string;
|
|
12869
12961
|
/**
|
|
12870
|
-
* @description
|
|
12962
|
+
* @description Include related resources. Available relationships: videos
|
|
12871
12963
|
* @example videos
|
|
12872
12964
|
*/
|
|
12873
12965
|
include?: string[];
|
|
@@ -12940,10 +13032,12 @@ export interface paths {
|
|
|
12940
13032
|
*/
|
|
12941
13033
|
countryCode?: string;
|
|
12942
13034
|
/**
|
|
12943
|
-
* @description
|
|
13035
|
+
* @description Include related resources. Available relationships: directHits, history
|
|
12944
13036
|
* @example directHits
|
|
12945
13037
|
*/
|
|
12946
13038
|
include?: string[];
|
|
13039
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
13040
|
+
includeLinkage?: ("directHits" | "history")[];
|
|
12947
13041
|
/**
|
|
12948
13042
|
* @description 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
13043
|
* @example directHits
|
|
@@ -13008,7 +13102,7 @@ export interface paths {
|
|
|
13008
13102
|
*/
|
|
13009
13103
|
countryCode?: string;
|
|
13010
13104
|
/**
|
|
13011
|
-
* @description
|
|
13105
|
+
* @description Include related resources. Available relationships: directHits
|
|
13012
13106
|
* @example directHits
|
|
13013
13107
|
*/
|
|
13014
13108
|
include?: string[];
|
|
@@ -13081,7 +13175,7 @@ export interface paths {
|
|
|
13081
13175
|
*/
|
|
13082
13176
|
countryCode?: string;
|
|
13083
13177
|
/**
|
|
13084
|
-
* @description
|
|
13178
|
+
* @description Include related resources. Available relationships: history
|
|
13085
13179
|
* @example history
|
|
13086
13180
|
*/
|
|
13087
13181
|
include?: string[];
|
|
@@ -13141,10 +13235,12 @@ export interface paths {
|
|
|
13141
13235
|
/** @description A share code (e.g. `xyz`) */
|
|
13142
13236
|
"filter[code]": string[];
|
|
13143
13237
|
/**
|
|
13144
|
-
* @description
|
|
13238
|
+
* @description Include related resources. Available relationships: owners, sharedResources
|
|
13145
13239
|
* @example sharedResources
|
|
13146
13240
|
*/
|
|
13147
13241
|
include?: string[];
|
|
13242
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
13243
|
+
includeLinkage?: ("owners" | "sharedResources")[];
|
|
13148
13244
|
/**
|
|
13149
13245
|
* @description 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
13246
|
* @example sharedResources
|
|
@@ -13239,10 +13335,12 @@ export interface paths {
|
|
|
13239
13335
|
parameters: {
|
|
13240
13336
|
query?: {
|
|
13241
13337
|
/**
|
|
13242
|
-
* @description
|
|
13338
|
+
* @description Include related resources. Available relationships: owners, sharedResources
|
|
13243
13339
|
* @example sharedResources
|
|
13244
13340
|
*/
|
|
13245
13341
|
include?: string[];
|
|
13342
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
13343
|
+
includeLinkage?: ("owners" | "sharedResources")[];
|
|
13246
13344
|
/**
|
|
13247
13345
|
* @description 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
13346
|
* @example sharedResources
|
|
@@ -13303,7 +13401,7 @@ export interface paths {
|
|
|
13303
13401
|
parameters: {
|
|
13304
13402
|
query?: {
|
|
13305
13403
|
/**
|
|
13306
|
-
* @description
|
|
13404
|
+
* @description Include related resources. Available relationships: owners
|
|
13307
13405
|
* @example owners
|
|
13308
13406
|
*/
|
|
13309
13407
|
include?: string[];
|
|
@@ -13366,7 +13464,7 @@ export interface paths {
|
|
|
13366
13464
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
13367
13465
|
"page[cursor]"?: string;
|
|
13368
13466
|
/**
|
|
13369
|
-
* @description
|
|
13467
|
+
* @description Include related resources. Available relationships: sharedResources
|
|
13370
13468
|
* @example sharedResources
|
|
13371
13469
|
*/
|
|
13372
13470
|
include?: string[];
|
|
@@ -13486,10 +13584,12 @@ export interface paths {
|
|
|
13486
13584
|
parameters: {
|
|
13487
13585
|
query?: {
|
|
13488
13586
|
/**
|
|
13489
|
-
* @description
|
|
13587
|
+
* @description Include related resources. Available relationships: selectedSite, sites
|
|
13490
13588
|
* @example selectedSite
|
|
13491
13589
|
*/
|
|
13492
13590
|
include?: string[];
|
|
13591
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
13592
|
+
includeLinkage?: ("selectedSite" | "sites")[];
|
|
13493
13593
|
};
|
|
13494
13594
|
header?: never;
|
|
13495
13595
|
path: {
|
|
@@ -13546,7 +13646,7 @@ export interface paths {
|
|
|
13546
13646
|
parameters: {
|
|
13547
13647
|
query?: {
|
|
13548
13648
|
/**
|
|
13549
|
-
* @description
|
|
13649
|
+
* @description Include related resources. Available relationships: selectedSite
|
|
13550
13650
|
* @example selectedSite
|
|
13551
13651
|
*/
|
|
13552
13652
|
include?: string[];
|
|
@@ -13653,7 +13753,7 @@ export interface paths {
|
|
|
13653
13753
|
parameters: {
|
|
13654
13754
|
query?: {
|
|
13655
13755
|
/**
|
|
13656
|
-
* @description
|
|
13756
|
+
* @description Include related resources. Available relationships: sites
|
|
13657
13757
|
* @example sites
|
|
13658
13758
|
*/
|
|
13659
13759
|
include?: string[];
|
|
@@ -13716,8 +13816,10 @@ export interface paths {
|
|
|
13716
13816
|
query: {
|
|
13717
13817
|
/** @description User id. Use `me` for the authenticated user */
|
|
13718
13818
|
"filter[owners.id]": string[];
|
|
13719
|
-
/** @description
|
|
13819
|
+
/** @description Include related resources. Available relationships: owners */
|
|
13720
13820
|
include?: string[];
|
|
13821
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
13822
|
+
includeLinkage?: "owners"[];
|
|
13721
13823
|
};
|
|
13722
13824
|
header?: never;
|
|
13723
13825
|
path?: never;
|
|
@@ -13807,7 +13909,7 @@ export interface paths {
|
|
|
13807
13909
|
parameters: {
|
|
13808
13910
|
query?: {
|
|
13809
13911
|
/**
|
|
13810
|
-
* @description
|
|
13912
|
+
* @description Include related resources. Available relationships: owners
|
|
13811
13913
|
* @example owners
|
|
13812
13914
|
*/
|
|
13813
13915
|
include?: string[];
|
|
@@ -13869,8 +13971,10 @@ export interface paths {
|
|
|
13869
13971
|
query: {
|
|
13870
13972
|
/** @description User id. Use `me` for the authenticated user */
|
|
13871
13973
|
"filter[owners.id]": string[];
|
|
13872
|
-
/** @description
|
|
13974
|
+
/** @description Include related resources. Available relationships: owners */
|
|
13873
13975
|
include?: string[];
|
|
13976
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
13977
|
+
includeLinkage?: "owners"[];
|
|
13874
13978
|
};
|
|
13875
13979
|
header?: never;
|
|
13876
13980
|
path?: never;
|
|
@@ -13920,7 +14024,7 @@ export interface paths {
|
|
|
13920
14024
|
parameters: {
|
|
13921
14025
|
query?: {
|
|
13922
14026
|
/**
|
|
13923
|
-
* @description
|
|
14027
|
+
* @description Include related resources. Available relationships: owners
|
|
13924
14028
|
* @example owners
|
|
13925
14029
|
*/
|
|
13926
14030
|
include?: string[];
|
|
@@ -13983,10 +14087,12 @@ export interface paths {
|
|
|
13983
14087
|
/** @description User id. Use `me` for the authenticated user */
|
|
13984
14088
|
"filter[owners.id]": string[];
|
|
13985
14089
|
/**
|
|
13986
|
-
* @description
|
|
14090
|
+
* @description Include related resources. Available relationships: priceChange
|
|
13987
14091
|
* @example priceChange
|
|
13988
14092
|
*/
|
|
13989
14093
|
include?: string[];
|
|
14094
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
14095
|
+
includeLinkage?: "priceChange"[];
|
|
13990
14096
|
};
|
|
13991
14097
|
header?: never;
|
|
13992
14098
|
path?: never;
|
|
@@ -14138,7 +14244,7 @@ export interface paths {
|
|
|
14138
14244
|
parameters: {
|
|
14139
14245
|
query?: {
|
|
14140
14246
|
/**
|
|
14141
|
-
* @description
|
|
14247
|
+
* @description Include related resources. Available relationships: priceChange
|
|
14142
14248
|
* @example priceChange
|
|
14143
14249
|
*/
|
|
14144
14250
|
include?: string[];
|
|
@@ -14252,8 +14358,10 @@ export interface paths {
|
|
|
14252
14358
|
get: {
|
|
14253
14359
|
parameters: {
|
|
14254
14360
|
query?: {
|
|
14255
|
-
/** @description
|
|
14361
|
+
/** @description Include related resources. Available relationships: owners */
|
|
14256
14362
|
include?: string[];
|
|
14363
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
14364
|
+
includeLinkage?: "owners"[];
|
|
14257
14365
|
};
|
|
14258
14366
|
header?: never;
|
|
14259
14367
|
path: {
|
|
@@ -14309,7 +14417,7 @@ export interface paths {
|
|
|
14309
14417
|
parameters: {
|
|
14310
14418
|
query?: {
|
|
14311
14419
|
/**
|
|
14312
|
-
* @description
|
|
14420
|
+
* @description Include related resources. Available relationships: owners
|
|
14313
14421
|
* @example owners
|
|
14314
14422
|
*/
|
|
14315
14423
|
include?: string[];
|
|
@@ -14653,8 +14761,10 @@ export interface paths {
|
|
|
14653
14761
|
get: {
|
|
14654
14762
|
parameters: {
|
|
14655
14763
|
query?: {
|
|
14656
|
-
/** @description
|
|
14764
|
+
/** @description Include related resources. Available relationships: owners */
|
|
14657
14765
|
include?: string[];
|
|
14766
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
14767
|
+
includeLinkage?: "owners"[];
|
|
14658
14768
|
};
|
|
14659
14769
|
header?: never;
|
|
14660
14770
|
path: {
|
|
@@ -14710,7 +14820,7 @@ export interface paths {
|
|
|
14710
14820
|
parameters: {
|
|
14711
14821
|
query?: {
|
|
14712
14822
|
/**
|
|
14713
|
-
* @description
|
|
14823
|
+
* @description Include related resources. Available relationships: owners
|
|
14714
14824
|
* @example owners
|
|
14715
14825
|
*/
|
|
14716
14826
|
include?: string[];
|
|
@@ -14775,8 +14885,10 @@ export interface paths {
|
|
|
14775
14885
|
* @example US
|
|
14776
14886
|
*/
|
|
14777
14887
|
countryCode?: string;
|
|
14778
|
-
/** @description
|
|
14888
|
+
/** @description Include related resources. Available relationships: owners */
|
|
14779
14889
|
include?: string[];
|
|
14890
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
14891
|
+
includeLinkage?: "owners"[];
|
|
14780
14892
|
};
|
|
14781
14893
|
header?: never;
|
|
14782
14894
|
path: {
|
|
@@ -14832,7 +14944,7 @@ export interface paths {
|
|
|
14832
14944
|
parameters: {
|
|
14833
14945
|
query?: {
|
|
14834
14946
|
/**
|
|
14835
|
-
* @description
|
|
14947
|
+
* @description Include related resources. Available relationships: owners
|
|
14836
14948
|
* @example owners
|
|
14837
14949
|
*/
|
|
14838
14950
|
include?: string[];
|
|
@@ -14902,7 +15014,7 @@ export interface paths {
|
|
|
14902
15014
|
*/
|
|
14903
15015
|
countryCode?: string;
|
|
14904
15016
|
/**
|
|
14905
|
-
* @description
|
|
15017
|
+
* @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
15018
|
* @example albums
|
|
14907
15019
|
*/
|
|
14908
15020
|
include?: string[];
|
|
@@ -14912,6 +15024,8 @@ export interface paths {
|
|
|
14912
15024
|
"filter[isrc]"?: string[];
|
|
14913
15025
|
/** @description User id. Use `me` for the authenticated user */
|
|
14914
15026
|
"filter[owners.id]"?: string[];
|
|
15027
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
15028
|
+
includeLinkage?: ("albums" | "artists" | "credits" | "download" | "genres" | "lyrics" | "metadataStatus" | "owners" | "priceConfig" | "providers" | "radio" | "replacement" | "shares" | "similarTracks" | "sourceFile" | "suggestedTracks" | "trackStatistics" | "usageRules")[];
|
|
14915
15029
|
/**
|
|
14916
15030
|
* @description 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
15031
|
* @example albums
|
|
@@ -15013,10 +15127,12 @@ export interface paths {
|
|
|
15013
15127
|
*/
|
|
15014
15128
|
countryCode?: string;
|
|
15015
15129
|
/**
|
|
15016
|
-
* @description
|
|
15130
|
+
* @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
15131
|
* @example albums
|
|
15018
15132
|
*/
|
|
15019
15133
|
include?: string[];
|
|
15134
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
15135
|
+
includeLinkage?: ("albums" | "artists" | "credits" | "download" | "genres" | "lyrics" | "metadataStatus" | "owners" | "priceConfig" | "providers" | "radio" | "replacement" | "shares" | "similarTracks" | "sourceFile" | "suggestedTracks" | "trackStatistics" | "usageRules")[];
|
|
15020
15136
|
/**
|
|
15021
15137
|
* @description 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
15138
|
* @example albums
|
|
@@ -15172,7 +15288,7 @@ export interface paths {
|
|
|
15172
15288
|
*/
|
|
15173
15289
|
countryCode?: string;
|
|
15174
15290
|
/**
|
|
15175
|
-
* @description
|
|
15291
|
+
* @description Include related resources. Available relationships: albums
|
|
15176
15292
|
* @example albums
|
|
15177
15293
|
*/
|
|
15178
15294
|
include?: string[];
|
|
@@ -15293,7 +15409,7 @@ export interface paths {
|
|
|
15293
15409
|
*/
|
|
15294
15410
|
countryCode?: string;
|
|
15295
15411
|
/**
|
|
15296
|
-
* @description
|
|
15412
|
+
* @description Include related resources. Available relationships: artists
|
|
15297
15413
|
* @example artists.albums
|
|
15298
15414
|
*/
|
|
15299
15415
|
include?: string[];
|
|
@@ -15361,7 +15477,7 @@ export interface paths {
|
|
|
15361
15477
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
15362
15478
|
"page[cursor]"?: string;
|
|
15363
15479
|
/**
|
|
15364
|
-
* @description
|
|
15480
|
+
* @description Include related resources. Available relationships: credits
|
|
15365
15481
|
* @example credits.artist.albums
|
|
15366
15482
|
*/
|
|
15367
15483
|
include?: string[];
|
|
@@ -15427,7 +15543,7 @@ export interface paths {
|
|
|
15427
15543
|
parameters: {
|
|
15428
15544
|
query?: {
|
|
15429
15545
|
/**
|
|
15430
|
-
* @description
|
|
15546
|
+
* @description Include related resources. Available relationships: download
|
|
15431
15547
|
* @example download
|
|
15432
15548
|
*/
|
|
15433
15549
|
include?: string[];
|
|
@@ -15493,7 +15609,7 @@ export interface paths {
|
|
|
15493
15609
|
*/
|
|
15494
15610
|
countryCode?: string;
|
|
15495
15611
|
/**
|
|
15496
|
-
* @description
|
|
15612
|
+
* @description Include related resources. Available relationships: genres
|
|
15497
15613
|
* @example genres
|
|
15498
15614
|
*/
|
|
15499
15615
|
include?: string[];
|
|
@@ -15556,7 +15672,7 @@ export interface paths {
|
|
|
15556
15672
|
parameters: {
|
|
15557
15673
|
query?: {
|
|
15558
15674
|
/**
|
|
15559
|
-
* @description
|
|
15675
|
+
* @description Include related resources. Available relationships: lyrics
|
|
15560
15676
|
* @example lyrics.track
|
|
15561
15677
|
*/
|
|
15562
15678
|
include?: string[];
|
|
@@ -15624,7 +15740,7 @@ export interface paths {
|
|
|
15624
15740
|
parameters: {
|
|
15625
15741
|
query?: {
|
|
15626
15742
|
/**
|
|
15627
|
-
* @description
|
|
15743
|
+
* @description Include related resources. Available relationships: metadataStatus
|
|
15628
15744
|
* @example metadataStatus
|
|
15629
15745
|
*/
|
|
15630
15746
|
include?: string[];
|
|
@@ -15685,7 +15801,7 @@ export interface paths {
|
|
|
15685
15801
|
parameters: {
|
|
15686
15802
|
query?: {
|
|
15687
15803
|
/**
|
|
15688
|
-
* @description
|
|
15804
|
+
* @description Include related resources. Available relationships: owners
|
|
15689
15805
|
* @example owners
|
|
15690
15806
|
*/
|
|
15691
15807
|
include?: string[];
|
|
@@ -15753,7 +15869,7 @@ export interface paths {
|
|
|
15753
15869
|
*/
|
|
15754
15870
|
countryCode?: string;
|
|
15755
15871
|
/**
|
|
15756
|
-
* @description
|
|
15872
|
+
* @description Include related resources. Available relationships: priceConfig
|
|
15757
15873
|
* @example priceConfig
|
|
15758
15874
|
*/
|
|
15759
15875
|
include?: string[];
|
|
@@ -15819,7 +15935,7 @@ export interface paths {
|
|
|
15819
15935
|
*/
|
|
15820
15936
|
countryCode?: string;
|
|
15821
15937
|
/**
|
|
15822
|
-
* @description
|
|
15938
|
+
* @description Include related resources. Available relationships: providers
|
|
15823
15939
|
* @example providers
|
|
15824
15940
|
*/
|
|
15825
15941
|
include?: string[];
|
|
@@ -15882,7 +15998,7 @@ export interface paths {
|
|
|
15882
15998
|
parameters: {
|
|
15883
15999
|
query?: {
|
|
15884
16000
|
/**
|
|
15885
|
-
* @description
|
|
16001
|
+
* @description Include related resources. Available relationships: radio
|
|
15886
16002
|
* @example radio.items
|
|
15887
16003
|
*/
|
|
15888
16004
|
include?: string[];
|
|
@@ -15955,7 +16071,7 @@ export interface paths {
|
|
|
15955
16071
|
*/
|
|
15956
16072
|
countryCode?: string;
|
|
15957
16073
|
/**
|
|
15958
|
-
* @description
|
|
16074
|
+
* @description Include related resources. Available relationships: replacement
|
|
15959
16075
|
* @example replacement
|
|
15960
16076
|
*/
|
|
15961
16077
|
include?: string[];
|
|
@@ -16021,7 +16137,7 @@ export interface paths {
|
|
|
16021
16137
|
parameters: {
|
|
16022
16138
|
query?: {
|
|
16023
16139
|
/**
|
|
16024
|
-
* @description
|
|
16140
|
+
* @description Include related resources. Available relationships: shares
|
|
16025
16141
|
* @example shares.sharedResources
|
|
16026
16142
|
*/
|
|
16027
16143
|
include?: string[];
|
|
@@ -16096,7 +16212,7 @@ export interface paths {
|
|
|
16096
16212
|
*/
|
|
16097
16213
|
countryCode?: string;
|
|
16098
16214
|
/**
|
|
16099
|
-
* @description
|
|
16215
|
+
* @description Include related resources. Available relationships: similarTracks
|
|
16100
16216
|
* @example similarTracks
|
|
16101
16217
|
*/
|
|
16102
16218
|
include?: string[];
|
|
@@ -16162,7 +16278,7 @@ export interface paths {
|
|
|
16162
16278
|
parameters: {
|
|
16163
16279
|
query?: {
|
|
16164
16280
|
/**
|
|
16165
|
-
* @description
|
|
16281
|
+
* @description Include related resources. Available relationships: sourceFile
|
|
16166
16282
|
* @example sourceFile
|
|
16167
16283
|
*/
|
|
16168
16284
|
include?: string[];
|
|
@@ -16230,7 +16346,7 @@ export interface paths {
|
|
|
16230
16346
|
*/
|
|
16231
16347
|
countryCode?: string;
|
|
16232
16348
|
/**
|
|
16233
|
-
* @description
|
|
16349
|
+
* @description Include related resources. Available relationships: suggestedTracks
|
|
16234
16350
|
* @example suggestedTracks
|
|
16235
16351
|
*/
|
|
16236
16352
|
include?: string[];
|
|
@@ -16296,7 +16412,7 @@ export interface paths {
|
|
|
16296
16412
|
parameters: {
|
|
16297
16413
|
query?: {
|
|
16298
16414
|
/**
|
|
16299
|
-
* @description
|
|
16415
|
+
* @description Include related resources. Available relationships: trackStatistics
|
|
16300
16416
|
* @example trackStatistics
|
|
16301
16417
|
*/
|
|
16302
16418
|
include?: string[];
|
|
@@ -16362,7 +16478,7 @@ export interface paths {
|
|
|
16362
16478
|
*/
|
|
16363
16479
|
countryCode?: string;
|
|
16364
16480
|
/**
|
|
16365
|
-
* @description
|
|
16481
|
+
* @description Include related resources. Available relationships: usageRules
|
|
16366
16482
|
* @example usageRules
|
|
16367
16483
|
*/
|
|
16368
16484
|
include?: string[];
|
|
@@ -16590,10 +16706,12 @@ export interface paths {
|
|
|
16590
16706
|
*/
|
|
16591
16707
|
locale?: string;
|
|
16592
16708
|
/**
|
|
16593
|
-
* @description
|
|
16709
|
+
* @description Include related resources. Available relationships: items, owners
|
|
16594
16710
|
* @example items
|
|
16595
16711
|
*/
|
|
16596
16712
|
include?: string[];
|
|
16713
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
16714
|
+
includeLinkage?: ("items" | "owners")[];
|
|
16597
16715
|
/**
|
|
16598
16716
|
* @description 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
16717
|
* @example items
|
|
@@ -16663,10 +16781,12 @@ export interface paths {
|
|
|
16663
16781
|
*/
|
|
16664
16782
|
locale?: string;
|
|
16665
16783
|
/**
|
|
16666
|
-
* @description
|
|
16784
|
+
* @description Include related resources. Available relationships: items
|
|
16667
16785
|
* @example items
|
|
16668
16786
|
*/
|
|
16669
16787
|
include?: string[];
|
|
16788
|
+
/** @description Filter albums by a free-text query matched against the album title and artist names. Internal clients only (e.g. `love`) */
|
|
16789
|
+
"filter[query]"?: string;
|
|
16670
16790
|
/**
|
|
16671
16791
|
* @description 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
16792
|
* @example items
|
|
@@ -16695,6 +16815,7 @@ export interface paths {
|
|
|
16695
16815
|
};
|
|
16696
16816
|
};
|
|
16697
16817
|
400: components["responses"]["Default400Response"];
|
|
16818
|
+
403: components["responses"]["UserCollectionAlbumsReadMultiDataRelationship403Response"];
|
|
16698
16819
|
404: components["responses"]["Default404Response"];
|
|
16699
16820
|
405: components["responses"]["Default405Response"];
|
|
16700
16821
|
406: components["responses"]["Default406Response"];
|
|
@@ -16819,7 +16940,7 @@ export interface paths {
|
|
|
16819
16940
|
parameters: {
|
|
16820
16941
|
query?: {
|
|
16821
16942
|
/**
|
|
16822
|
-
* @description
|
|
16943
|
+
* @description Include related resources. Available relationships: owners
|
|
16823
16944
|
* @example owners
|
|
16824
16945
|
*/
|
|
16825
16946
|
include?: string[];
|
|
@@ -16885,10 +17006,12 @@ export interface paths {
|
|
|
16885
17006
|
*/
|
|
16886
17007
|
locale?: string;
|
|
16887
17008
|
/**
|
|
16888
|
-
* @description
|
|
17009
|
+
* @description Include related resources. Available relationships: items, owners
|
|
16889
17010
|
* @example items.albums
|
|
16890
17011
|
*/
|
|
16891
17012
|
include?: string[];
|
|
17013
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
17014
|
+
includeLinkage?: ("items" | "owners")[];
|
|
16892
17015
|
/**
|
|
16893
17016
|
* @description 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
17017
|
* @example items.albums
|
|
@@ -16958,10 +17081,12 @@ export interface paths {
|
|
|
16958
17081
|
*/
|
|
16959
17082
|
locale?: string;
|
|
16960
17083
|
/**
|
|
16961
|
-
* @description
|
|
17084
|
+
* @description Include related resources. Available relationships: items
|
|
16962
17085
|
* @example items.albums
|
|
16963
17086
|
*/
|
|
16964
17087
|
include?: string[];
|
|
17088
|
+
/** @description Filter artists by a free-text query matched against the artist name. Internal clients only (e.g. `love`) */
|
|
17089
|
+
"filter[query]"?: string;
|
|
16965
17090
|
/**
|
|
16966
17091
|
* @description 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
17092
|
* @example items.albums
|
|
@@ -16990,6 +17115,7 @@ export interface paths {
|
|
|
16990
17115
|
};
|
|
16991
17116
|
};
|
|
16992
17117
|
400: components["responses"]["Default400Response"];
|
|
17118
|
+
403: components["responses"]["UserCollectionArtistsReadMultiDataRelationship403Response"];
|
|
16993
17119
|
404: components["responses"]["Default404Response"];
|
|
16994
17120
|
405: components["responses"]["Default405Response"];
|
|
16995
17121
|
406: components["responses"]["Default406Response"];
|
|
@@ -17114,7 +17240,7 @@ export interface paths {
|
|
|
17114
17240
|
parameters: {
|
|
17115
17241
|
query?: {
|
|
17116
17242
|
/**
|
|
17117
|
-
* @description
|
|
17243
|
+
* @description Include related resources. Available relationships: owners
|
|
17118
17244
|
* @example owners
|
|
17119
17245
|
*/
|
|
17120
17246
|
include?: string[];
|
|
@@ -17177,10 +17303,12 @@ export interface paths {
|
|
|
17177
17303
|
/** @description Folder Id (e.g. `CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX`) */
|
|
17178
17304
|
"filter[id]": string[];
|
|
17179
17305
|
/**
|
|
17180
|
-
* @description
|
|
17306
|
+
* @description Include related resources. Available relationships: items, owners, userCollection
|
|
17181
17307
|
* @example items.items
|
|
17182
17308
|
*/
|
|
17183
17309
|
include?: string[];
|
|
17310
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
17311
|
+
includeLinkage?: ("items" | "owners" | "userCollection")[];
|
|
17184
17312
|
/**
|
|
17185
17313
|
* @description 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
17314
|
* @example items.items
|
|
@@ -17275,10 +17403,12 @@ export interface paths {
|
|
|
17275
17403
|
parameters: {
|
|
17276
17404
|
query?: {
|
|
17277
17405
|
/**
|
|
17278
|
-
* @description
|
|
17406
|
+
* @description Include related resources. Available relationships: items, owners, userCollection
|
|
17279
17407
|
* @example items.items
|
|
17280
17408
|
*/
|
|
17281
17409
|
include?: string[];
|
|
17410
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
17411
|
+
includeLinkage?: ("items" | "owners" | "userCollection")[];
|
|
17282
17412
|
/**
|
|
17283
17413
|
* @description 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
17414
|
* @example items.items
|
|
@@ -17431,7 +17561,7 @@ export interface paths {
|
|
|
17431
17561
|
/** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */
|
|
17432
17562
|
sort?: ("addedAt" | "-addedAt" | "lastModifiedAt" | "-lastModifiedAt" | "name" | "-name")[];
|
|
17433
17563
|
/**
|
|
17434
|
-
* @description
|
|
17564
|
+
* @description Include related resources. Available relationships: items
|
|
17435
17565
|
* @example items.items
|
|
17436
17566
|
*/
|
|
17437
17567
|
include?: string[];
|
|
@@ -17587,7 +17717,7 @@ export interface paths {
|
|
|
17587
17717
|
parameters: {
|
|
17588
17718
|
query?: {
|
|
17589
17719
|
/**
|
|
17590
|
-
* @description
|
|
17720
|
+
* @description Include related resources. Available relationships: owners
|
|
17591
17721
|
* @example owners
|
|
17592
17722
|
*/
|
|
17593
17723
|
include?: string[];
|
|
@@ -17648,7 +17778,7 @@ export interface paths {
|
|
|
17648
17778
|
parameters: {
|
|
17649
17779
|
query?: {
|
|
17650
17780
|
/**
|
|
17651
|
-
* @description
|
|
17781
|
+
* @description Include related resources. Available relationships: userCollection
|
|
17652
17782
|
* @example userCollection.items.items
|
|
17653
17783
|
*/
|
|
17654
17784
|
include?: string[];
|
|
@@ -17717,10 +17847,12 @@ export interface paths {
|
|
|
17717
17847
|
*/
|
|
17718
17848
|
locale?: string;
|
|
17719
17849
|
/**
|
|
17720
|
-
* @description
|
|
17850
|
+
* @description Include related resources. Available relationships: items, owners
|
|
17721
17851
|
* @example items.items
|
|
17722
17852
|
*/
|
|
17723
17853
|
include?: string[];
|
|
17854
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
17855
|
+
includeLinkage?: ("items" | "owners")[];
|
|
17724
17856
|
/**
|
|
17725
17857
|
* @description 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
17858
|
* @example items.items
|
|
@@ -17786,7 +17918,7 @@ export interface paths {
|
|
|
17786
17918
|
/** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */
|
|
17787
17919
|
sort?: ("addedAt" | "-addedAt" | "lastModifiedAt" | "-lastModifiedAt" | "name" | "-name")[];
|
|
17788
17920
|
/**
|
|
17789
|
-
* @description
|
|
17921
|
+
* @description Include related resources. Available relationships: items
|
|
17790
17922
|
* @example items.items
|
|
17791
17923
|
*/
|
|
17792
17924
|
include?: string[];
|
|
@@ -17820,6 +17952,7 @@ export interface paths {
|
|
|
17820
17952
|
};
|
|
17821
17953
|
};
|
|
17822
17954
|
400: components["responses"]["Default400Response"];
|
|
17955
|
+
403: components["responses"]["UserCollectionPlaylistsReadMultiDataRelationship403Response"];
|
|
17823
17956
|
404: components["responses"]["Default404Response"];
|
|
17824
17957
|
405: components["responses"]["Default405Response"];
|
|
17825
17958
|
406: components["responses"]["Default406Response"];
|
|
@@ -17944,7 +18077,7 @@ export interface paths {
|
|
|
17944
18077
|
parameters: {
|
|
17945
18078
|
query?: {
|
|
17946
18079
|
/**
|
|
17947
|
-
* @description
|
|
18080
|
+
* @description Include related resources. Available relationships: owners
|
|
17948
18081
|
* @example owners
|
|
17949
18082
|
*/
|
|
17950
18083
|
include?: string[];
|
|
@@ -18005,10 +18138,12 @@ export interface paths {
|
|
|
18005
18138
|
parameters: {
|
|
18006
18139
|
query?: {
|
|
18007
18140
|
/**
|
|
18008
|
-
* @description
|
|
18141
|
+
* @description Include related resources. Available relationships: items, owners
|
|
18009
18142
|
* @example items
|
|
18010
18143
|
*/
|
|
18011
18144
|
include?: string[];
|
|
18145
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
18146
|
+
includeLinkage?: ("items" | "owners")[];
|
|
18012
18147
|
/**
|
|
18013
18148
|
* @description 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
18149
|
* @example items
|
|
@@ -18071,7 +18206,7 @@ export interface paths {
|
|
|
18071
18206
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
18072
18207
|
"page[cursor]"?: string;
|
|
18073
18208
|
/**
|
|
18074
|
-
* @description
|
|
18209
|
+
* @description Include related resources. Available relationships: items
|
|
18075
18210
|
* @example items
|
|
18076
18211
|
*/
|
|
18077
18212
|
include?: string[];
|
|
@@ -18227,7 +18362,7 @@ export interface paths {
|
|
|
18227
18362
|
parameters: {
|
|
18228
18363
|
query?: {
|
|
18229
18364
|
/**
|
|
18230
|
-
* @description
|
|
18365
|
+
* @description Include related resources. Available relationships: owners
|
|
18231
18366
|
* @example owners
|
|
18232
18367
|
*/
|
|
18233
18368
|
include?: string[];
|
|
@@ -18293,10 +18428,12 @@ export interface paths {
|
|
|
18293
18428
|
*/
|
|
18294
18429
|
locale?: string;
|
|
18295
18430
|
/**
|
|
18296
|
-
* @description
|
|
18431
|
+
* @description Include related resources. Available relationships: items, owners
|
|
18297
18432
|
* @example items
|
|
18298
18433
|
*/
|
|
18299
18434
|
include?: string[];
|
|
18435
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
18436
|
+
includeLinkage?: ("items" | "owners")[];
|
|
18300
18437
|
/**
|
|
18301
18438
|
* @description 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
18439
|
* @example items
|
|
@@ -18366,10 +18503,12 @@ export interface paths {
|
|
|
18366
18503
|
*/
|
|
18367
18504
|
locale?: string;
|
|
18368
18505
|
/**
|
|
18369
|
-
* @description
|
|
18506
|
+
* @description Include related resources. Available relationships: items
|
|
18370
18507
|
* @example items
|
|
18371
18508
|
*/
|
|
18372
18509
|
include?: string[];
|
|
18510
|
+
/** @description Filter tracks by a free-text query matched against the track title, artist names and album title. Internal clients only (e.g. `love`) */
|
|
18511
|
+
"filter[query]"?: string;
|
|
18373
18512
|
/**
|
|
18374
18513
|
* @description 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
18514
|
* @example items
|
|
@@ -18398,6 +18537,7 @@ export interface paths {
|
|
|
18398
18537
|
};
|
|
18399
18538
|
};
|
|
18400
18539
|
400: components["responses"]["Default400Response"];
|
|
18540
|
+
403: components["responses"]["UserCollectionTracksReadMultiDataRelationship403Response"];
|
|
18401
18541
|
404: components["responses"]["Default404Response"];
|
|
18402
18542
|
405: components["responses"]["Default405Response"];
|
|
18403
18543
|
406: components["responses"]["Default406Response"];
|
|
@@ -18522,7 +18662,7 @@ export interface paths {
|
|
|
18522
18662
|
parameters: {
|
|
18523
18663
|
query?: {
|
|
18524
18664
|
/**
|
|
18525
|
-
* @description
|
|
18665
|
+
* @description Include related resources. Available relationships: owners
|
|
18526
18666
|
* @example owners
|
|
18527
18667
|
*/
|
|
18528
18668
|
include?: string[];
|
|
@@ -18588,10 +18728,12 @@ export interface paths {
|
|
|
18588
18728
|
*/
|
|
18589
18729
|
locale?: string;
|
|
18590
18730
|
/**
|
|
18591
|
-
* @description
|
|
18731
|
+
* @description Include related resources. Available relationships: items, owners
|
|
18592
18732
|
* @example items
|
|
18593
18733
|
*/
|
|
18594
18734
|
include?: string[];
|
|
18735
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
18736
|
+
includeLinkage?: ("items" | "owners")[];
|
|
18595
18737
|
/**
|
|
18596
18738
|
* @description 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
18739
|
* @example items
|
|
@@ -18661,10 +18803,12 @@ export interface paths {
|
|
|
18661
18803
|
*/
|
|
18662
18804
|
locale?: string;
|
|
18663
18805
|
/**
|
|
18664
|
-
* @description
|
|
18806
|
+
* @description Include related resources. Available relationships: items
|
|
18665
18807
|
* @example items
|
|
18666
18808
|
*/
|
|
18667
18809
|
include?: string[];
|
|
18810
|
+
/** @description Filter videos by a free-text query matched against the video title and artist names. Internal clients only (e.g. `love`) */
|
|
18811
|
+
"filter[query]"?: string;
|
|
18668
18812
|
/**
|
|
18669
18813
|
* @description 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
18814
|
* @example items
|
|
@@ -18693,6 +18837,7 @@ export interface paths {
|
|
|
18693
18837
|
};
|
|
18694
18838
|
};
|
|
18695
18839
|
400: components["responses"]["Default400Response"];
|
|
18840
|
+
403: components["responses"]["UserCollectionVideosReadMultiDataRelationship403Response"];
|
|
18696
18841
|
404: components["responses"]["Default404Response"];
|
|
18697
18842
|
405: components["responses"]["Default405Response"];
|
|
18698
18843
|
406: components["responses"]["Default406Response"];
|
|
@@ -18817,7 +18962,7 @@ export interface paths {
|
|
|
18817
18962
|
parameters: {
|
|
18818
18963
|
query?: {
|
|
18819
18964
|
/**
|
|
18820
|
-
* @description
|
|
18965
|
+
* @description Include related resources. Available relationships: owners
|
|
18821
18966
|
* @example owners
|
|
18822
18967
|
*/
|
|
18823
18968
|
include?: string[];
|
|
@@ -18883,10 +19028,12 @@ export interface paths {
|
|
|
18883
19028
|
*/
|
|
18884
19029
|
locale?: string;
|
|
18885
19030
|
/**
|
|
18886
|
-
* @description
|
|
19031
|
+
* @description Include related resources. Available relationships: items
|
|
18887
19032
|
* @example items.items
|
|
18888
19033
|
*/
|
|
18889
19034
|
include?: string[];
|
|
19035
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
19036
|
+
includeLinkage?: "items"[];
|
|
18890
19037
|
/**
|
|
18891
19038
|
* @description 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
19039
|
* @example items.items
|
|
@@ -18954,7 +19101,7 @@ export interface paths {
|
|
|
18954
19101
|
*/
|
|
18955
19102
|
locale?: string;
|
|
18956
19103
|
/**
|
|
18957
|
-
* @description
|
|
19104
|
+
* @description Include related resources. Available relationships: items
|
|
18958
19105
|
* @example items.items
|
|
18959
19106
|
*/
|
|
18960
19107
|
include?: string[];
|
|
@@ -19079,10 +19226,12 @@ export interface paths {
|
|
|
19079
19226
|
*/
|
|
19080
19227
|
locale?: string;
|
|
19081
19228
|
/**
|
|
19082
|
-
* @description
|
|
19229
|
+
* @description Include related resources. Available relationships: items
|
|
19083
19230
|
* @example items.items
|
|
19084
19231
|
*/
|
|
19085
19232
|
include?: string[];
|
|
19233
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
19234
|
+
includeLinkage?: "items"[];
|
|
19086
19235
|
/**
|
|
19087
19236
|
* @description 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
19237
|
* @example items.items
|
|
@@ -19150,7 +19299,7 @@ export interface paths {
|
|
|
19150
19299
|
*/
|
|
19151
19300
|
locale?: string;
|
|
19152
19301
|
/**
|
|
19153
|
-
* @description
|
|
19302
|
+
* @description Include related resources. Available relationships: items
|
|
19154
19303
|
* @example items.items
|
|
19155
19304
|
*/
|
|
19156
19305
|
include?: string[];
|
|
@@ -19219,10 +19368,12 @@ export interface paths {
|
|
|
19219
19368
|
*/
|
|
19220
19369
|
locale?: string;
|
|
19221
19370
|
/**
|
|
19222
|
-
* @description
|
|
19371
|
+
* @description Include related resources. Available relationships: items
|
|
19223
19372
|
* @example items.items
|
|
19224
19373
|
*/
|
|
19225
19374
|
include?: string[];
|
|
19375
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
19376
|
+
includeLinkage?: "items"[];
|
|
19226
19377
|
/**
|
|
19227
19378
|
* @description 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
19379
|
* @example items.items
|
|
@@ -19290,7 +19441,7 @@ export interface paths {
|
|
|
19290
19441
|
*/
|
|
19291
19442
|
locale?: string;
|
|
19292
19443
|
/**
|
|
19293
|
-
* @description
|
|
19444
|
+
* @description Include related resources. Available relationships: items
|
|
19294
19445
|
* @example items.items
|
|
19295
19446
|
*/
|
|
19296
19447
|
include?: string[];
|
|
@@ -19359,10 +19510,12 @@ export interface paths {
|
|
|
19359
19510
|
*/
|
|
19360
19511
|
locale?: string;
|
|
19361
19512
|
/**
|
|
19362
|
-
* @description
|
|
19513
|
+
* @description Include related resources. Available relationships: items
|
|
19363
19514
|
* @example items.items
|
|
19364
19515
|
*/
|
|
19365
19516
|
include?: string[];
|
|
19517
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
19518
|
+
includeLinkage?: "items"[];
|
|
19366
19519
|
/**
|
|
19367
19520
|
* @description 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
19521
|
* @example items.items
|
|
@@ -19430,7 +19583,7 @@ export interface paths {
|
|
|
19430
19583
|
*/
|
|
19431
19584
|
locale?: string;
|
|
19432
19585
|
/**
|
|
19433
|
-
* @description
|
|
19586
|
+
* @description Include related resources. Available relationships: items
|
|
19434
19587
|
* @example items.items
|
|
19435
19588
|
*/
|
|
19436
19589
|
include?: string[];
|
|
@@ -19494,10 +19647,12 @@ export interface paths {
|
|
|
19494
19647
|
parameters: {
|
|
19495
19648
|
query?: {
|
|
19496
19649
|
/**
|
|
19497
|
-
* @description
|
|
19650
|
+
* @description Include related resources. Available relationships: activePlayer, availablePlayers, changeEventStream, playQueue
|
|
19498
19651
|
* @example activePlayer.offlineInventory
|
|
19499
19652
|
*/
|
|
19500
19653
|
include?: string[];
|
|
19654
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
19655
|
+
includeLinkage?: ("activePlayer" | "availablePlayers" | "changeEventStream" | "playQueue")[];
|
|
19501
19656
|
/**
|
|
19502
19657
|
* @description 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
19658
|
* @example activePlayer.offlineInventory
|
|
@@ -19604,7 +19759,7 @@ export interface paths {
|
|
|
19604
19759
|
parameters: {
|
|
19605
19760
|
query?: {
|
|
19606
19761
|
/**
|
|
19607
|
-
* @description
|
|
19762
|
+
* @description Include related resources. Available relationships: activePlayer
|
|
19608
19763
|
* @example activePlayer.offlineInventory
|
|
19609
19764
|
*/
|
|
19610
19765
|
include?: string[];
|
|
@@ -19714,7 +19869,7 @@ export interface paths {
|
|
|
19714
19869
|
parameters: {
|
|
19715
19870
|
query?: {
|
|
19716
19871
|
/**
|
|
19717
|
-
* @description
|
|
19872
|
+
* @description Include related resources. Available relationships: availablePlayers
|
|
19718
19873
|
* @example availablePlayers.offlineInventory
|
|
19719
19874
|
*/
|
|
19720
19875
|
include?: string[];
|
|
@@ -19872,7 +20027,7 @@ export interface paths {
|
|
|
19872
20027
|
parameters: {
|
|
19873
20028
|
query?: {
|
|
19874
20029
|
/**
|
|
19875
|
-
* @description
|
|
20030
|
+
* @description Include related resources. Available relationships: changeEventStream
|
|
19876
20031
|
* @example changeEventStream
|
|
19877
20032
|
*/
|
|
19878
20033
|
include?: string[];
|
|
@@ -19927,7 +20082,7 @@ export interface paths {
|
|
|
19927
20082
|
parameters: {
|
|
19928
20083
|
query?: {
|
|
19929
20084
|
/**
|
|
19930
|
-
* @description
|
|
20085
|
+
* @description Include related resources. Available relationships: playQueue
|
|
19931
20086
|
* @example playQueue.current
|
|
19932
20087
|
*/
|
|
19933
20088
|
include?: string[];
|
|
@@ -20042,10 +20197,12 @@ export interface paths {
|
|
|
20042
20197
|
*/
|
|
20043
20198
|
locale?: string;
|
|
20044
20199
|
/**
|
|
20045
|
-
* @description
|
|
20200
|
+
* @description Include related resources. Available relationships: artists, owners, tracks, videos
|
|
20046
20201
|
* @example artists.albums
|
|
20047
20202
|
*/
|
|
20048
20203
|
include?: string[];
|
|
20204
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
20205
|
+
includeLinkage?: ("artists" | "owners" | "tracks" | "videos")[];
|
|
20049
20206
|
/**
|
|
20050
20207
|
* @description 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
20208
|
* @example artists.albums
|
|
@@ -20108,7 +20265,7 @@ export interface paths {
|
|
|
20108
20265
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
20109
20266
|
"page[cursor]"?: string;
|
|
20110
20267
|
/**
|
|
20111
|
-
* @description
|
|
20268
|
+
* @description Include related resources. Available relationships: artists
|
|
20112
20269
|
* @example artists.albums
|
|
20113
20270
|
*/
|
|
20114
20271
|
include?: string[];
|
|
@@ -20264,7 +20421,7 @@ export interface paths {
|
|
|
20264
20421
|
parameters: {
|
|
20265
20422
|
query?: {
|
|
20266
20423
|
/**
|
|
20267
|
-
* @description
|
|
20424
|
+
* @description Include related resources. Available relationships: owners
|
|
20268
20425
|
* @example owners
|
|
20269
20426
|
*/
|
|
20270
20427
|
include?: string[];
|
|
@@ -20327,7 +20484,7 @@ export interface paths {
|
|
|
20327
20484
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
20328
20485
|
"page[cursor]"?: string;
|
|
20329
20486
|
/**
|
|
20330
|
-
* @description
|
|
20487
|
+
* @description Include related resources. Available relationships: tracks
|
|
20331
20488
|
* @example tracks
|
|
20332
20489
|
*/
|
|
20333
20490
|
include?: string[];
|
|
@@ -20485,7 +20642,7 @@ export interface paths {
|
|
|
20485
20642
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
20486
20643
|
"page[cursor]"?: string;
|
|
20487
20644
|
/**
|
|
20488
|
-
* @description
|
|
20645
|
+
* @description Include related resources. Available relationships: videos
|
|
20489
20646
|
* @example videos
|
|
20490
20647
|
*/
|
|
20491
20648
|
include?: string[];
|
|
@@ -20700,10 +20857,12 @@ export interface paths {
|
|
|
20700
20857
|
/** @description User id. Use `me` for the authenticated user */
|
|
20701
20858
|
"filter[owners.id]": string[];
|
|
20702
20859
|
/**
|
|
20703
|
-
* @description
|
|
20860
|
+
* @description Include related resources. Available relationships: decision
|
|
20704
20861
|
* @example decision
|
|
20705
20862
|
*/
|
|
20706
20863
|
include?: string[];
|
|
20864
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
20865
|
+
includeLinkage?: "decision"[];
|
|
20707
20866
|
};
|
|
20708
20867
|
header?: never;
|
|
20709
20868
|
path?: never;
|
|
@@ -20753,7 +20912,7 @@ export interface paths {
|
|
|
20753
20912
|
parameters: {
|
|
20754
20913
|
query?: {
|
|
20755
20914
|
/**
|
|
20756
|
-
* @description
|
|
20915
|
+
* @description Include related resources. Available relationships: decision
|
|
20757
20916
|
* @example decision
|
|
20758
20917
|
*/
|
|
20759
20918
|
include?: string[];
|
|
@@ -20812,10 +20971,12 @@ export interface paths {
|
|
|
20812
20971
|
parameters: {
|
|
20813
20972
|
query?: {
|
|
20814
20973
|
/**
|
|
20815
|
-
* @description
|
|
20974
|
+
* @description Include related resources. Available relationships: artist
|
|
20816
20975
|
* @example artist.albums
|
|
20817
20976
|
*/
|
|
20818
20977
|
include?: string[];
|
|
20978
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
20979
|
+
includeLinkage?: "artist"[];
|
|
20819
20980
|
/**
|
|
20820
20981
|
* @description 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
20982
|
* @example artist.albums
|
|
@@ -20876,7 +21037,7 @@ export interface paths {
|
|
|
20876
21037
|
parameters: {
|
|
20877
21038
|
query?: {
|
|
20878
21039
|
/**
|
|
20879
|
-
* @description
|
|
21040
|
+
* @description Include related resources. Available relationships: artist
|
|
20880
21041
|
* @example artist.albums
|
|
20881
21042
|
*/
|
|
20882
21043
|
include?: string[];
|
|
@@ -21002,7 +21163,7 @@ export interface paths {
|
|
|
21002
21163
|
*/
|
|
21003
21164
|
countryCode?: string;
|
|
21004
21165
|
/**
|
|
21005
|
-
* @description
|
|
21166
|
+
* @description Include related resources. Available relationships: albums, artists, credits, providers, replacement, similarVideos, suggestedVideos, thumbnailArt, usageRules
|
|
21006
21167
|
* @example albums
|
|
21007
21168
|
*/
|
|
21008
21169
|
include?: string[];
|
|
@@ -21010,6 +21171,8 @@ export interface paths {
|
|
|
21010
21171
|
"filter[id]"?: string[];
|
|
21011
21172
|
/** @description List of ISRCs (e.g. `QMJMT1701237`) */
|
|
21012
21173
|
"filter[isrc]"?: string[];
|
|
21174
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
21175
|
+
includeLinkage?: ("albums" | "artists" | "credits" | "providers" | "replacement" | "similarVideos" | "suggestedVideos" | "thumbnailArt" | "usageRules")[];
|
|
21013
21176
|
/**
|
|
21014
21177
|
* @description 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
21178
|
* @example albums
|
|
@@ -21069,10 +21232,12 @@ export interface paths {
|
|
|
21069
21232
|
*/
|
|
21070
21233
|
countryCode?: string;
|
|
21071
21234
|
/**
|
|
21072
|
-
* @description
|
|
21235
|
+
* @description Include related resources. Available relationships: albums, artists, credits, providers, replacement, similarVideos, suggestedVideos, thumbnailArt, usageRules
|
|
21073
21236
|
* @example albums
|
|
21074
21237
|
*/
|
|
21075
21238
|
include?: string[];
|
|
21239
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
21240
|
+
includeLinkage?: ("albums" | "artists" | "credits" | "providers" | "replacement" | "similarVideos" | "suggestedVideos" | "thumbnailArt" | "usageRules")[];
|
|
21076
21241
|
/**
|
|
21077
21242
|
* @description 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
21243
|
* @example albums
|
|
@@ -21140,7 +21305,7 @@ export interface paths {
|
|
|
21140
21305
|
*/
|
|
21141
21306
|
countryCode?: string;
|
|
21142
21307
|
/**
|
|
21143
|
-
* @description
|
|
21308
|
+
* @description Include related resources. Available relationships: albums
|
|
21144
21309
|
* @example albums
|
|
21145
21310
|
*/
|
|
21146
21311
|
include?: string[];
|
|
@@ -21211,7 +21376,7 @@ export interface paths {
|
|
|
21211
21376
|
*/
|
|
21212
21377
|
countryCode?: string;
|
|
21213
21378
|
/**
|
|
21214
|
-
* @description
|
|
21379
|
+
* @description Include related resources. Available relationships: artists
|
|
21215
21380
|
* @example artists.albums
|
|
21216
21381
|
*/
|
|
21217
21382
|
include?: string[];
|
|
@@ -21277,7 +21442,7 @@ export interface paths {
|
|
|
21277
21442
|
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
21278
21443
|
"page[cursor]"?: string;
|
|
21279
21444
|
/**
|
|
21280
|
-
* @description
|
|
21445
|
+
* @description Include related resources. Available relationships: credits
|
|
21281
21446
|
* @example credits.artist.albums
|
|
21282
21447
|
*/
|
|
21283
21448
|
include?: string[];
|
|
@@ -21348,7 +21513,7 @@ export interface paths {
|
|
|
21348
21513
|
*/
|
|
21349
21514
|
countryCode?: string;
|
|
21350
21515
|
/**
|
|
21351
|
-
* @description
|
|
21516
|
+
* @description Include related resources. Available relationships: providers
|
|
21352
21517
|
* @example providers
|
|
21353
21518
|
*/
|
|
21354
21519
|
include?: string[];
|
|
@@ -21412,7 +21577,7 @@ export interface paths {
|
|
|
21412
21577
|
*/
|
|
21413
21578
|
countryCode?: string;
|
|
21414
21579
|
/**
|
|
21415
|
-
* @description
|
|
21580
|
+
* @description Include related resources. Available relationships: replacement
|
|
21416
21581
|
* @example replacement
|
|
21417
21582
|
*/
|
|
21418
21583
|
include?: string[];
|
|
@@ -21483,7 +21648,7 @@ export interface paths {
|
|
|
21483
21648
|
*/
|
|
21484
21649
|
countryCode?: string;
|
|
21485
21650
|
/**
|
|
21486
|
-
* @description
|
|
21651
|
+
* @description Include related resources. Available relationships: similarVideos
|
|
21487
21652
|
* @example similarVideos
|
|
21488
21653
|
*/
|
|
21489
21654
|
include?: string[];
|
|
@@ -21554,7 +21719,7 @@ export interface paths {
|
|
|
21554
21719
|
*/
|
|
21555
21720
|
countryCode?: string;
|
|
21556
21721
|
/**
|
|
21557
|
-
* @description
|
|
21722
|
+
* @description Include related resources. Available relationships: suggestedVideos
|
|
21558
21723
|
* @example suggestedVideos
|
|
21559
21724
|
*/
|
|
21560
21725
|
include?: string[];
|
|
@@ -21625,7 +21790,7 @@ export interface paths {
|
|
|
21625
21790
|
*/
|
|
21626
21791
|
countryCode?: string;
|
|
21627
21792
|
/**
|
|
21628
|
-
* @description
|
|
21793
|
+
* @description Include related resources. Available relationships: thumbnailArt
|
|
21629
21794
|
* @example thumbnailArt
|
|
21630
21795
|
*/
|
|
21631
21796
|
include?: string[];
|
|
@@ -21689,7 +21854,7 @@ export interface paths {
|
|
|
21689
21854
|
*/
|
|
21690
21855
|
countryCode?: string;
|
|
21691
21856
|
/**
|
|
21692
|
-
* @description
|
|
21857
|
+
* @description Include related resources. Available relationships: usageRules
|
|
21693
21858
|
* @example usageRules
|
|
21694
21859
|
*/
|
|
21695
21860
|
include?: string[];
|
|
@@ -21733,6 +21898,253 @@ export interface paths {
|
|
|
21733
21898
|
patch?: never;
|
|
21734
21899
|
trace?: never;
|
|
21735
21900
|
};
|
|
21901
|
+
"/viewerContexts": {
|
|
21902
|
+
parameters: {
|
|
21903
|
+
query?: never;
|
|
21904
|
+
header?: never;
|
|
21905
|
+
path?: never;
|
|
21906
|
+
cookie?: never;
|
|
21907
|
+
};
|
|
21908
|
+
/**
|
|
21909
|
+
* Get multiple viewerContexts.
|
|
21910
|
+
* @description Returns viewer contexts for up to 20 original subjects. Duplicate subjects are returned once.
|
|
21911
|
+
*/
|
|
21912
|
+
get: {
|
|
21913
|
+
parameters: {
|
|
21914
|
+
query: {
|
|
21915
|
+
/** @description Original subjects to look up. */
|
|
21916
|
+
"filter[subject]": string[];
|
|
21917
|
+
/**
|
|
21918
|
+
* @description Include related resources. Available relationships: subject, viewer
|
|
21919
|
+
* @example subject
|
|
21920
|
+
*/
|
|
21921
|
+
include?: string[];
|
|
21922
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
21923
|
+
includeLinkage?: ("subject" | "viewer")[];
|
|
21924
|
+
/**
|
|
21925
|
+
* @description 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
|
|
21926
|
+
* @example subject
|
|
21927
|
+
*/
|
|
21928
|
+
replaceMedia?: string;
|
|
21929
|
+
};
|
|
21930
|
+
header?: never;
|
|
21931
|
+
path?: never;
|
|
21932
|
+
cookie?: never;
|
|
21933
|
+
};
|
|
21934
|
+
requestBody?: never;
|
|
21935
|
+
responses: {
|
|
21936
|
+
/** @description Successful response */
|
|
21937
|
+
200: {
|
|
21938
|
+
headers: {
|
|
21939
|
+
[name: string]: unknown;
|
|
21940
|
+
};
|
|
21941
|
+
content: {
|
|
21942
|
+
"application/vnd.api+json": components["schemas"]["ViewerContexts_Multi_Resource_Data_Document"];
|
|
21943
|
+
};
|
|
21944
|
+
};
|
|
21945
|
+
400: components["responses"]["Default400Response"];
|
|
21946
|
+
404: components["responses"]["Default404Response"];
|
|
21947
|
+
405: components["responses"]["Default405Response"];
|
|
21948
|
+
406: components["responses"]["Default406Response"];
|
|
21949
|
+
415: components["responses"]["Default415Response"];
|
|
21950
|
+
429: components["responses"]["Default429Response"];
|
|
21951
|
+
500: components["responses"]["Default500Response"];
|
|
21952
|
+
503: components["responses"]["Default503Response"];
|
|
21953
|
+
};
|
|
21954
|
+
};
|
|
21955
|
+
put?: never;
|
|
21956
|
+
post?: never;
|
|
21957
|
+
delete?: never;
|
|
21958
|
+
options?: never;
|
|
21959
|
+
head?: never;
|
|
21960
|
+
patch?: never;
|
|
21961
|
+
trace?: never;
|
|
21962
|
+
};
|
|
21963
|
+
"/viewerContexts/{id}": {
|
|
21964
|
+
parameters: {
|
|
21965
|
+
query?: never;
|
|
21966
|
+
header?: never;
|
|
21967
|
+
path?: never;
|
|
21968
|
+
cookie?: never;
|
|
21969
|
+
};
|
|
21970
|
+
/**
|
|
21971
|
+
* Get single viewerContext.
|
|
21972
|
+
* @description Retrieves single viewerContext by id.
|
|
21973
|
+
*/
|
|
21974
|
+
get: {
|
|
21975
|
+
parameters: {
|
|
21976
|
+
query?: {
|
|
21977
|
+
/**
|
|
21978
|
+
* @description Include related resources. Available relationships: subject, viewer
|
|
21979
|
+
* @example subject
|
|
21980
|
+
*/
|
|
21981
|
+
include?: string[];
|
|
21982
|
+
/** @description Comma-separated direct relationships to return as linkage only, without related content. */
|
|
21983
|
+
includeLinkage?: ("subject" | "viewer")[];
|
|
21984
|
+
/**
|
|
21985
|
+
* @description 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
|
|
21986
|
+
* @example subject
|
|
21987
|
+
*/
|
|
21988
|
+
replaceMedia?: string;
|
|
21989
|
+
};
|
|
21990
|
+
header?: never;
|
|
21991
|
+
path: {
|
|
21992
|
+
/** @description Opaque identifier of one authenticated viewer and original subject pair */
|
|
21993
|
+
id: string;
|
|
21994
|
+
};
|
|
21995
|
+
cookie?: never;
|
|
21996
|
+
};
|
|
21997
|
+
requestBody?: never;
|
|
21998
|
+
responses: {
|
|
21999
|
+
/** @description Successful response */
|
|
22000
|
+
200: {
|
|
22001
|
+
headers: {
|
|
22002
|
+
[name: string]: unknown;
|
|
22003
|
+
};
|
|
22004
|
+
content: {
|
|
22005
|
+
"application/vnd.api+json": components["schemas"]["ViewerContexts_Single_Resource_Data_Document"];
|
|
22006
|
+
};
|
|
22007
|
+
};
|
|
22008
|
+
400: components["responses"]["Default400Response"];
|
|
22009
|
+
404: components["responses"]["Default404Response"];
|
|
22010
|
+
405: components["responses"]["Default405Response"];
|
|
22011
|
+
406: components["responses"]["Default406Response"];
|
|
22012
|
+
415: components["responses"]["Default415Response"];
|
|
22013
|
+
429: components["responses"]["Default429Response"];
|
|
22014
|
+
500: components["responses"]["Default500Response"];
|
|
22015
|
+
503: components["responses"]["Default503Response"];
|
|
22016
|
+
};
|
|
22017
|
+
};
|
|
22018
|
+
put?: never;
|
|
22019
|
+
post?: never;
|
|
22020
|
+
delete?: never;
|
|
22021
|
+
options?: never;
|
|
22022
|
+
head?: never;
|
|
22023
|
+
patch?: never;
|
|
22024
|
+
trace?: never;
|
|
22025
|
+
};
|
|
22026
|
+
"/viewerContexts/{id}/relationships/subject": {
|
|
22027
|
+
parameters: {
|
|
22028
|
+
query?: never;
|
|
22029
|
+
header?: never;
|
|
22030
|
+
path?: never;
|
|
22031
|
+
cookie?: never;
|
|
22032
|
+
};
|
|
22033
|
+
/**
|
|
22034
|
+
* Get subject relationship ("to-one").
|
|
22035
|
+
* @description Returns the subject of this viewer context.
|
|
22036
|
+
*/
|
|
22037
|
+
get: {
|
|
22038
|
+
parameters: {
|
|
22039
|
+
query?: {
|
|
22040
|
+
/**
|
|
22041
|
+
* @description Include related resources. Available relationships: subject
|
|
22042
|
+
* @example subject
|
|
22043
|
+
*/
|
|
22044
|
+
include?: string[];
|
|
22045
|
+
/**
|
|
22046
|
+
* @description 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
|
|
22047
|
+
* @example subject
|
|
22048
|
+
*/
|
|
22049
|
+
replaceMedia?: string;
|
|
22050
|
+
};
|
|
22051
|
+
header?: never;
|
|
22052
|
+
path: {
|
|
22053
|
+
/** @description Opaque identifier of one authenticated viewer and original subject pair */
|
|
22054
|
+
id: string;
|
|
22055
|
+
};
|
|
22056
|
+
cookie?: never;
|
|
22057
|
+
};
|
|
22058
|
+
requestBody?: never;
|
|
22059
|
+
responses: {
|
|
22060
|
+
/** @description Successful response */
|
|
22061
|
+
200: {
|
|
22062
|
+
headers: {
|
|
22063
|
+
[name: string]: unknown;
|
|
22064
|
+
};
|
|
22065
|
+
content: {
|
|
22066
|
+
"application/vnd.api+json": components["schemas"]["ViewerContexts_Subject_Single_Relationship_Data_Document"];
|
|
22067
|
+
};
|
|
22068
|
+
};
|
|
22069
|
+
400: components["responses"]["Default400Response"];
|
|
22070
|
+
404: components["responses"]["Default404Response"];
|
|
22071
|
+
405: components["responses"]["Default405Response"];
|
|
22072
|
+
406: components["responses"]["Default406Response"];
|
|
22073
|
+
415: components["responses"]["Default415Response"];
|
|
22074
|
+
429: components["responses"]["Default429Response"];
|
|
22075
|
+
500: components["responses"]["Default500Response"];
|
|
22076
|
+
503: components["responses"]["Default503Response"];
|
|
22077
|
+
};
|
|
22078
|
+
};
|
|
22079
|
+
put?: never;
|
|
22080
|
+
post?: never;
|
|
22081
|
+
delete?: never;
|
|
22082
|
+
options?: never;
|
|
22083
|
+
head?: never;
|
|
22084
|
+
patch?: never;
|
|
22085
|
+
trace?: never;
|
|
22086
|
+
};
|
|
22087
|
+
"/viewerContexts/{id}/relationships/viewer": {
|
|
22088
|
+
parameters: {
|
|
22089
|
+
query?: never;
|
|
22090
|
+
header?: never;
|
|
22091
|
+
path?: never;
|
|
22092
|
+
cookie?: never;
|
|
22093
|
+
};
|
|
22094
|
+
/**
|
|
22095
|
+
* Get viewer relationship ("to-one").
|
|
22096
|
+
* @description Returns the authenticated viewer of this context.
|
|
22097
|
+
*/
|
|
22098
|
+
get: {
|
|
22099
|
+
parameters: {
|
|
22100
|
+
query?: {
|
|
22101
|
+
/**
|
|
22102
|
+
* @description Include related resources. Available relationships: viewer
|
|
22103
|
+
* @example viewer.artist.albums
|
|
22104
|
+
*/
|
|
22105
|
+
include?: string[];
|
|
22106
|
+
/**
|
|
22107
|
+
* @description 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
|
|
22108
|
+
* @example viewer.artist.albums
|
|
22109
|
+
*/
|
|
22110
|
+
replaceMedia?: string;
|
|
22111
|
+
};
|
|
22112
|
+
header?: never;
|
|
22113
|
+
path: {
|
|
22114
|
+
/** @description Opaque identifier of one authenticated viewer and original subject pair */
|
|
22115
|
+
id: string;
|
|
22116
|
+
};
|
|
22117
|
+
cookie?: never;
|
|
22118
|
+
};
|
|
22119
|
+
requestBody?: never;
|
|
22120
|
+
responses: {
|
|
22121
|
+
/** @description Successful response */
|
|
22122
|
+
200: {
|
|
22123
|
+
headers: {
|
|
22124
|
+
[name: string]: unknown;
|
|
22125
|
+
};
|
|
22126
|
+
content: {
|
|
22127
|
+
"application/vnd.api+json": components["schemas"]["ViewerContexts_Viewer_Single_Relationship_Data_Document"];
|
|
22128
|
+
};
|
|
22129
|
+
};
|
|
22130
|
+
400: components["responses"]["Default400Response"];
|
|
22131
|
+
404: components["responses"]["Default404Response"];
|
|
22132
|
+
405: components["responses"]["Default405Response"];
|
|
22133
|
+
406: components["responses"]["Default406Response"];
|
|
22134
|
+
415: components["responses"]["Default415Response"];
|
|
22135
|
+
429: components["responses"]["Default429Response"];
|
|
22136
|
+
500: components["responses"]["Default500Response"];
|
|
22137
|
+
503: components["responses"]["Default503Response"];
|
|
22138
|
+
};
|
|
22139
|
+
};
|
|
22140
|
+
put?: never;
|
|
22141
|
+
post?: never;
|
|
22142
|
+
delete?: never;
|
|
22143
|
+
options?: never;
|
|
22144
|
+
head?: never;
|
|
22145
|
+
patch?: never;
|
|
22146
|
+
trace?: never;
|
|
22147
|
+
};
|
|
21736
22148
|
}
|
|
21737
22149
|
export type webhooks = Record<string, never>;
|
|
21738
22150
|
export interface components {
|
|
@@ -22084,7 +22496,6 @@ export interface components {
|
|
|
22084
22496
|
type: string;
|
|
22085
22497
|
};
|
|
22086
22498
|
Albums_Items_Resource_Identifier_Meta: {
|
|
22087
|
-
itemCursor?: string;
|
|
22088
22499
|
replacement?: components["schemas"]["Replacement_Provenance"];
|
|
22089
22500
|
/**
|
|
22090
22501
|
* Format: int32
|
|
@@ -22830,7 +23241,10 @@ export interface components {
|
|
|
22830
23241
|
};
|
|
22831
23242
|
/** @description Artwork files */
|
|
22832
23243
|
Artwork_File: {
|
|
22833
|
-
/**
|
|
23244
|
+
/**
|
|
23245
|
+
* Format: uri
|
|
23246
|
+
* @description Artwork file href
|
|
23247
|
+
*/
|
|
22834
23248
|
href: string;
|
|
22835
23249
|
meta: components["schemas"]["Artwork_File_Meta"];
|
|
22836
23250
|
};
|
|
@@ -23159,6 +23573,8 @@ export interface components {
|
|
|
23159
23573
|
included?: components["schemas"]["Included"];
|
|
23160
23574
|
links: components["schemas"]["Links"];
|
|
23161
23575
|
};
|
|
23576
|
+
/** @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. */
|
|
23577
|
+
Commented: Record<string, never>;
|
|
23162
23578
|
CommentsCreateOperation_Payload: {
|
|
23163
23579
|
data: components["schemas"]["CommentsCreateOperation_Payload_Data"];
|
|
23164
23580
|
};
|
|
@@ -23543,7 +23959,10 @@ export interface components {
|
|
|
23543
23959
|
}[];
|
|
23544
23960
|
};
|
|
23545
23961
|
Download_Link: {
|
|
23546
|
-
/**
|
|
23962
|
+
/**
|
|
23963
|
+
* Format: uri
|
|
23964
|
+
* @description URL to download the content from
|
|
23965
|
+
*/
|
|
23547
23966
|
href: string;
|
|
23548
23967
|
meta: components["schemas"]["Download_Link_Meta"];
|
|
23549
23968
|
};
|
|
@@ -23848,6 +24267,7 @@ export interface components {
|
|
|
23848
24267
|
links?: components["schemas"]["Links"];
|
|
23849
24268
|
};
|
|
23850
24269
|
External_Link: {
|
|
24270
|
+
/** Format: uri */
|
|
23851
24271
|
href: string;
|
|
23852
24272
|
meta: components["schemas"]["External_Link_Meta"];
|
|
23853
24273
|
};
|
|
@@ -23857,6 +24277,7 @@ export interface components {
|
|
|
23857
24277
|
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
24278
|
};
|
|
23859
24279
|
External_Link_Payload: {
|
|
24280
|
+
/** Format: uri */
|
|
23860
24281
|
href?: string;
|
|
23861
24282
|
meta: components["schemas"]["External_Link_Meta"];
|
|
23862
24283
|
};
|
|
@@ -23880,7 +24301,10 @@ export interface components {
|
|
|
23880
24301
|
};
|
|
23881
24302
|
/** @description Upload link */
|
|
23882
24303
|
File_Upload_Link: {
|
|
23883
|
-
/**
|
|
24304
|
+
/**
|
|
24305
|
+
* Format: uri
|
|
24306
|
+
* @description Href to upload actual file to
|
|
24307
|
+
*/
|
|
23884
24308
|
href: string;
|
|
23885
24309
|
meta: components["schemas"]["File_Upload_Link_Meta"];
|
|
23886
24310
|
};
|
|
@@ -24117,6 +24541,10 @@ export interface components {
|
|
|
24117
24541
|
data: components["schemas"]["Folders_Resource_Object"];
|
|
24118
24542
|
links: components["schemas"]["Links"];
|
|
24119
24543
|
};
|
|
24544
|
+
/** @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. */
|
|
24545
|
+
FollowedBy: Record<string, never>;
|
|
24546
|
+
/** @description The viewer follows the subject. Reserved; not currently populated and omitted from responses. Omission does not indicate that the relation is absent. */
|
|
24547
|
+
Following: Record<string, never>;
|
|
24120
24548
|
Genres_Attributes: {
|
|
24121
24549
|
/**
|
|
24122
24550
|
* @description Genre name
|
|
@@ -24173,7 +24601,9 @@ export interface components {
|
|
|
24173
24601
|
status: string;
|
|
24174
24602
|
}[];
|
|
24175
24603
|
};
|
|
24176
|
-
|
|
24604
|
+
/** @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. */
|
|
24605
|
+
InCollection: Record<string, never>;
|
|
24606
|
+
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"]["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
24607
|
InstallationsCreateOperation_Payload: {
|
|
24178
24608
|
data: components["schemas"]["InstallationsCreateOperation_Payload_Data"];
|
|
24179
24609
|
};
|
|
@@ -24442,9 +24872,13 @@ export interface components {
|
|
|
24442
24872
|
role?: string;
|
|
24443
24873
|
selectedAlbums?: string[];
|
|
24444
24874
|
selectedSingles?: string[];
|
|
24445
|
-
socialLink?: components["schemas"]["
|
|
24875
|
+
socialLink?: components["schemas"]["ManualArtistClaimsExternalLink"];
|
|
24446
24876
|
upcs?: string[];
|
|
24447
|
-
websiteOrSocialLink: components["schemas"]["
|
|
24877
|
+
websiteOrSocialLink: components["schemas"]["ManualArtistClaimsExternalLink"];
|
|
24878
|
+
};
|
|
24879
|
+
ManualArtistClaimsExternalLink: {
|
|
24880
|
+
/** Format: uri */
|
|
24881
|
+
href: string;
|
|
24448
24882
|
};
|
|
24449
24883
|
ManualArtistClaims_Attributes: {
|
|
24450
24884
|
/** @description Accepted terms and conditions */
|
|
@@ -24514,6 +24948,14 @@ export interface components {
|
|
|
24514
24948
|
*/
|
|
24515
24949
|
type: "manualArtistClaims";
|
|
24516
24950
|
};
|
|
24951
|
+
/** @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. */
|
|
24952
|
+
Membership: {
|
|
24953
|
+
/**
|
|
24954
|
+
* @description Positive identity-derived membership role; NONE does not represent membership.
|
|
24955
|
+
* @enum {string}
|
|
24956
|
+
*/
|
|
24957
|
+
role: "NONE" | "VIEWER" | "COLLABORATOR" | "OWNER";
|
|
24958
|
+
};
|
|
24517
24959
|
Mutation_Response_Document: {
|
|
24518
24960
|
links: components["schemas"]["Links"];
|
|
24519
24961
|
/** @description Non-standard meta information */
|
|
@@ -24662,12 +25104,8 @@ export interface components {
|
|
|
24662
25104
|
};
|
|
24663
25105
|
PlayQueuesFutureRelationshipAddOperation_Payload_Data: {
|
|
24664
25106
|
id: string;
|
|
24665
|
-
meta?: components["schemas"]["PlayQueuesFutureRelationshipAddOperation_Payload_Data_Meta"];
|
|
24666
25107
|
/** @enum {string} */
|
|
24667
|
-
type: "tracks" | "videos"
|
|
24668
|
-
};
|
|
24669
|
-
PlayQueuesFutureRelationshipAddOperation_Payload_Data_Meta: {
|
|
24670
|
-
itemCursor?: string;
|
|
25108
|
+
type: "tracks" | "videos";
|
|
24671
25109
|
};
|
|
24672
25110
|
PlayQueuesFutureRelationshipAddOperation_Payload_Meta: {
|
|
24673
25111
|
/** Format: uuid */
|
|
@@ -24676,6 +25114,7 @@ export interface components {
|
|
|
24676
25114
|
/** @enum {string} */
|
|
24677
25115
|
mode: "ADD_TO_FRONT" | "ADD_TO_BACK" | "ADD_BEFORE" | "REPLACE_ALL" | "REPLACE_ALL_AND_CURRENT" | "ADD_TO_FRONT_REPLACE_CURRENT";
|
|
24678
25116
|
positionBefore?: string;
|
|
25117
|
+
source?: components["schemas"]["PlayQueuesFutureRelationshipSource"];
|
|
24679
25118
|
};
|
|
24680
25119
|
PlayQueuesFutureRelationshipRemoveOperation_Payload: {
|
|
24681
25120
|
data: components["schemas"]["PlayQueuesFutureRelationshipRemoveOperation_Payload_Data"][];
|
|
@@ -24689,6 +25128,19 @@ export interface components {
|
|
|
24689
25128
|
PlayQueuesFutureRelationshipRemoveOperation_Payload_Data_Meta: {
|
|
24690
25129
|
itemId: string;
|
|
24691
25130
|
};
|
|
25131
|
+
/** @description Adds up to 1000 playable items from a relationship page and subsequent pages, reading at most 100 pages. Requires empty data. */
|
|
25132
|
+
PlayQueuesFutureRelationshipSource: {
|
|
25133
|
+
/**
|
|
25134
|
+
* Format: uri-reference
|
|
25135
|
+
* @description API-relative self link of a TIDAL API to-many relationship page.
|
|
25136
|
+
*/
|
|
25137
|
+
href: string;
|
|
25138
|
+
/**
|
|
25139
|
+
* Format: int32
|
|
25140
|
+
* @description Zero-based index in the page's complete data array from which to start adding.
|
|
25141
|
+
*/
|
|
25142
|
+
startIndex: number;
|
|
25143
|
+
};
|
|
24692
25144
|
PlayQueuesFutureRelationshipUpdateOperation_Payload: {
|
|
24693
25145
|
data: components["schemas"]["PlayQueuesFutureRelationshipUpdateOperation_Payload_Data"][];
|
|
24694
25146
|
meta: components["schemas"]["PlayQueuesFutureRelationshipUpdateOperation_Payload_Meta"];
|
|
@@ -25266,7 +25718,7 @@ export interface components {
|
|
|
25266
25718
|
* @example DUPLICATE_ITEMS_IN_PLAYLIST
|
|
25267
25719
|
* @enum {string}
|
|
25268
25720
|
*/
|
|
25269
|
-
code: "DUPLICATE_ITEMS_IN_PLAYLIST" | "IDEMPOTENT_REQUEST_IN_PROGRESS";
|
|
25721
|
+
code: "DUPLICATE_ITEMS_IN_PLAYLIST" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_PLAYLIST";
|
|
25270
25722
|
/** @example Playlist already contains one or more requested items */
|
|
25271
25723
|
detail?: string;
|
|
25272
25724
|
/** @example 409 */
|
|
@@ -25510,7 +25962,6 @@ export interface components {
|
|
|
25510
25962
|
Playlists_Items_Resource_Identifier_Meta: {
|
|
25511
25963
|
/** Format: date-time */
|
|
25512
25964
|
addedAt?: string;
|
|
25513
|
-
itemCursor?: string;
|
|
25514
25965
|
itemId?: string;
|
|
25515
25966
|
replacement?: components["schemas"]["Replacement_Provenance"];
|
|
25516
25967
|
};
|
|
@@ -25778,6 +26229,8 @@ export interface components {
|
|
|
25778
26229
|
included?: components["schemas"]["Included"];
|
|
25779
26230
|
links: components["schemas"]["Links"];
|
|
25780
26231
|
};
|
|
26232
|
+
/** @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. */
|
|
26233
|
+
Purchased: Record<string, never>;
|
|
25781
26234
|
Purchases_Attributes: {
|
|
25782
26235
|
/**
|
|
25783
26236
|
* Format: date-time
|
|
@@ -25839,6 +26292,10 @@ export interface components {
|
|
|
25839
26292
|
included?: components["schemas"]["Included"];
|
|
25840
26293
|
links: components["schemas"]["Links"];
|
|
25841
26294
|
};
|
|
26295
|
+
/** @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. */
|
|
26296
|
+
Reaction: {
|
|
26297
|
+
emoji: string;
|
|
26298
|
+
};
|
|
25842
26299
|
/** @description Reaction statistics */
|
|
25843
26300
|
ReactionStats: {
|
|
25844
26301
|
/** @description Count of reactions by type */
|
|
@@ -25973,6 +26430,8 @@ export interface components {
|
|
|
25973
26430
|
*/
|
|
25974
26431
|
type: string;
|
|
25975
26432
|
};
|
|
26433
|
+
/** @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. */
|
|
26434
|
+
SavedForLater: Record<string, never>;
|
|
25976
26435
|
SavedSharesCreateOperation_Payload: {
|
|
25977
26436
|
data: components["schemas"]["SavedSharesCreateOperation_Payload_Data"];
|
|
25978
26437
|
};
|
|
@@ -27693,6 +28152,19 @@ export interface components {
|
|
|
27693
28152
|
/** @enum {string} */
|
|
27694
28153
|
type: "albums";
|
|
27695
28154
|
};
|
|
28155
|
+
UserCollectionAlbumsReadMultiDataRelationship403ResponseBody: {
|
|
28156
|
+
errors: {
|
|
28157
|
+
/**
|
|
28158
|
+
* @example UNAUTHORIZED
|
|
28159
|
+
* @enum {string}
|
|
28160
|
+
*/
|
|
28161
|
+
code: "UNAUTHORIZED";
|
|
28162
|
+
/** @example filter[query] requires INTERNAL access tier */
|
|
28163
|
+
detail?: string;
|
|
28164
|
+
/** @example 403 */
|
|
28165
|
+
status: string;
|
|
28166
|
+
}[];
|
|
28167
|
+
};
|
|
27696
28168
|
UserCollectionAlbums_Attributes: {
|
|
27697
28169
|
/**
|
|
27698
28170
|
* Format: date-time
|
|
@@ -27815,6 +28287,19 @@ export interface components {
|
|
|
27815
28287
|
/** @enum {string} */
|
|
27816
28288
|
type: "artists";
|
|
27817
28289
|
};
|
|
28290
|
+
UserCollectionArtistsReadMultiDataRelationship403ResponseBody: {
|
|
28291
|
+
errors: {
|
|
28292
|
+
/**
|
|
28293
|
+
* @example UNAUTHORIZED
|
|
28294
|
+
* @enum {string}
|
|
28295
|
+
*/
|
|
28296
|
+
code: "UNAUTHORIZED";
|
|
28297
|
+
/** @example filter[query] requires INTERNAL access tier */
|
|
28298
|
+
detail?: string;
|
|
28299
|
+
/** @example 403 */
|
|
28300
|
+
status: string;
|
|
28301
|
+
}[];
|
|
28302
|
+
};
|
|
27818
28303
|
UserCollectionArtists_Attributes: {
|
|
27819
28304
|
/**
|
|
27820
28305
|
* Format: date-time
|
|
@@ -28069,6 +28554,19 @@ export interface components {
|
|
|
28069
28554
|
/** @enum {string} */
|
|
28070
28555
|
type: "playlists";
|
|
28071
28556
|
};
|
|
28557
|
+
UserCollectionPlaylistsReadMultiDataRelationship403ResponseBody: {
|
|
28558
|
+
errors: {
|
|
28559
|
+
/**
|
|
28560
|
+
* @example UNAUTHORIZED
|
|
28561
|
+
* @enum {string}
|
|
28562
|
+
*/
|
|
28563
|
+
code: "UNAUTHORIZED";
|
|
28564
|
+
/** @example filter[query] requires INTERNAL access tier */
|
|
28565
|
+
detail?: string;
|
|
28566
|
+
/** @example 403 */
|
|
28567
|
+
status: string;
|
|
28568
|
+
}[];
|
|
28569
|
+
};
|
|
28072
28570
|
UserCollectionPlaylists_Attributes: {
|
|
28073
28571
|
/**
|
|
28074
28572
|
* Format: date-time
|
|
@@ -28307,6 +28805,19 @@ export interface components {
|
|
|
28307
28805
|
/** @enum {string} */
|
|
28308
28806
|
type: "tracks";
|
|
28309
28807
|
};
|
|
28808
|
+
UserCollectionTracksReadMultiDataRelationship403ResponseBody: {
|
|
28809
|
+
errors: {
|
|
28810
|
+
/**
|
|
28811
|
+
* @example UNAUTHORIZED
|
|
28812
|
+
* @enum {string}
|
|
28813
|
+
*/
|
|
28814
|
+
code: "UNAUTHORIZED";
|
|
28815
|
+
/** @example filter[query] requires INTERNAL access tier */
|
|
28816
|
+
detail?: string;
|
|
28817
|
+
/** @example 403 */
|
|
28818
|
+
status: string;
|
|
28819
|
+
}[];
|
|
28820
|
+
};
|
|
28310
28821
|
UserCollectionTracks_Attributes: {
|
|
28311
28822
|
/**
|
|
28312
28823
|
* Format: date-time
|
|
@@ -28429,6 +28940,19 @@ export interface components {
|
|
|
28429
28940
|
/** @enum {string} */
|
|
28430
28941
|
type: "videos";
|
|
28431
28942
|
};
|
|
28943
|
+
UserCollectionVideosReadMultiDataRelationship403ResponseBody: {
|
|
28944
|
+
errors: {
|
|
28945
|
+
/**
|
|
28946
|
+
* @example UNAUTHORIZED
|
|
28947
|
+
* @enum {string}
|
|
28948
|
+
*/
|
|
28949
|
+
code: "UNAUTHORIZED";
|
|
28950
|
+
/** @example filter[query] requires INTERNAL access tier */
|
|
28951
|
+
detail?: string;
|
|
28952
|
+
/** @example 403 */
|
|
28953
|
+
status: string;
|
|
28954
|
+
}[];
|
|
28955
|
+
};
|
|
28432
28956
|
UserCollectionVideos_Attributes: {
|
|
28433
28957
|
/**
|
|
28434
28958
|
* Format: date-time
|
|
@@ -29406,6 +29930,70 @@ export interface components {
|
|
|
29406
29930
|
included?: components["schemas"]["Included"];
|
|
29407
29931
|
links: components["schemas"]["Links"];
|
|
29408
29932
|
};
|
|
29933
|
+
ViewerContexts_Attributes: {
|
|
29934
|
+
hasCommentedOn?: components["schemas"]["Commented"];
|
|
29935
|
+
hasInCollection?: components["schemas"]["InCollection"];
|
|
29936
|
+
hasPurchased?: components["schemas"]["Purchased"];
|
|
29937
|
+
hasReactedTo?: components["schemas"]["Reaction"];
|
|
29938
|
+
hasSavedForLater?: components["schemas"]["SavedForLater"];
|
|
29939
|
+
isFollowedBy?: components["schemas"]["FollowedBy"];
|
|
29940
|
+
isFollowing?: components["schemas"]["Following"];
|
|
29941
|
+
isMemberOf?: components["schemas"]["Membership"];
|
|
29942
|
+
};
|
|
29943
|
+
ViewerContexts_Multi_Resource_Data_Document: {
|
|
29944
|
+
data: components["schemas"]["ViewerContexts_Resource_Object"][];
|
|
29945
|
+
included?: components["schemas"]["Included"];
|
|
29946
|
+
links: components["schemas"]["Links"];
|
|
29947
|
+
};
|
|
29948
|
+
ViewerContexts_Relationships: {
|
|
29949
|
+
subject?: components["schemas"]["ViewerContexts_Subject_Single_Relationship_Data_Document"];
|
|
29950
|
+
viewer?: components["schemas"]["ViewerContexts_Viewer_Single_Relationship_Data_Document"];
|
|
29951
|
+
};
|
|
29952
|
+
ViewerContexts_Resource_Object: {
|
|
29953
|
+
attributes?: components["schemas"]["ViewerContexts_Attributes"];
|
|
29954
|
+
/**
|
|
29955
|
+
* @description Resource id
|
|
29956
|
+
* @example 12345
|
|
29957
|
+
*/
|
|
29958
|
+
id: string;
|
|
29959
|
+
relationships?: components["schemas"]["ViewerContexts_Relationships"];
|
|
29960
|
+
/**
|
|
29961
|
+
* @description Resource type (enum property replaced by openapi-typescript)
|
|
29962
|
+
* @enum {string}
|
|
29963
|
+
*/
|
|
29964
|
+
type: "viewerContexts";
|
|
29965
|
+
};
|
|
29966
|
+
ViewerContexts_Single_Resource_Data_Document: {
|
|
29967
|
+
data: components["schemas"]["ViewerContexts_Resource_Object"];
|
|
29968
|
+
included?: components["schemas"]["Included"];
|
|
29969
|
+
links: components["schemas"]["Links"];
|
|
29970
|
+
};
|
|
29971
|
+
ViewerContexts_Subject_Resource_Identifier: {
|
|
29972
|
+
/**
|
|
29973
|
+
* @description Resource id
|
|
29974
|
+
* @example 12345
|
|
29975
|
+
*/
|
|
29976
|
+
id: string;
|
|
29977
|
+
meta?: components["schemas"]["ViewerContexts_Subject_Resource_Identifier_Meta"];
|
|
29978
|
+
/**
|
|
29979
|
+
* @description Resource type
|
|
29980
|
+
* @example tracks
|
|
29981
|
+
*/
|
|
29982
|
+
type: string;
|
|
29983
|
+
};
|
|
29984
|
+
ViewerContexts_Subject_Resource_Identifier_Meta: {
|
|
29985
|
+
replacement?: components["schemas"]["Replacement_Provenance"];
|
|
29986
|
+
};
|
|
29987
|
+
ViewerContexts_Subject_Single_Relationship_Data_Document: {
|
|
29988
|
+
data?: components["schemas"]["ViewerContexts_Subject_Resource_Identifier"] | (never | null);
|
|
29989
|
+
included?: components["schemas"]["Included"];
|
|
29990
|
+
links: components["schemas"]["Links"];
|
|
29991
|
+
};
|
|
29992
|
+
ViewerContexts_Viewer_Single_Relationship_Data_Document: {
|
|
29993
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
29994
|
+
included?: components["schemas"]["Included"];
|
|
29995
|
+
links: components["schemas"]["Links"];
|
|
29996
|
+
};
|
|
29409
29997
|
};
|
|
29410
29998
|
responses: {
|
|
29411
29999
|
/** @description Invalid request */
|
|
@@ -29579,7 +30167,7 @@ export interface components {
|
|
|
29579
30167
|
"application/vnd.api+json": components["schemas"]["PlaylistGenerationsUpdateMultiDataRelationship409ResponseBody"];
|
|
29580
30168
|
};
|
|
29581
30169
|
};
|
|
29582
|
-
/** @description Playlist already contains one or more requested items; Request already in progress for this idempotency key */
|
|
30170
|
+
/** @description Playlist already contains one or more requested items; Playlist item limit reached; Request already in progress for this idempotency key */
|
|
29583
30171
|
PlaylistsAddMultiDataRelationshipWithResponse409Response: {
|
|
29584
30172
|
headers: {
|
|
29585
30173
|
[name: string]: unknown;
|
|
@@ -29678,6 +30266,15 @@ export interface components {
|
|
|
29678
30266
|
"application/vnd.api+json": components["schemas"]["UserCollectionAlbumsAddMultiDataRelationshipWithResponse409ResponseBody"];
|
|
29679
30267
|
};
|
|
29680
30268
|
};
|
|
30269
|
+
/** @description filter[query] requires INTERNAL access tier */
|
|
30270
|
+
UserCollectionAlbumsReadMultiDataRelationship403Response: {
|
|
30271
|
+
headers: {
|
|
30272
|
+
[name: string]: unknown;
|
|
30273
|
+
};
|
|
30274
|
+
content: {
|
|
30275
|
+
"application/vnd.api+json": components["schemas"]["UserCollectionAlbumsReadMultiDataRelationship403ResponseBody"];
|
|
30276
|
+
};
|
|
30277
|
+
};
|
|
29681
30278
|
/** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */
|
|
29682
30279
|
UserCollectionArtistsAddMultiDataRelationshipWithResponse409Response: {
|
|
29683
30280
|
headers: {
|
|
@@ -29687,6 +30284,15 @@ export interface components {
|
|
|
29687
30284
|
"application/vnd.api+json": components["schemas"]["UserCollectionArtistsAddMultiDataRelationshipWithResponse409ResponseBody"];
|
|
29688
30285
|
};
|
|
29689
30286
|
};
|
|
30287
|
+
/** @description filter[query] requires INTERNAL access tier */
|
|
30288
|
+
UserCollectionArtistsReadMultiDataRelationship403Response: {
|
|
30289
|
+
headers: {
|
|
30290
|
+
[name: string]: unknown;
|
|
30291
|
+
};
|
|
30292
|
+
content: {
|
|
30293
|
+
"application/vnd.api+json": components["schemas"]["UserCollectionArtistsReadMultiDataRelationship403ResponseBody"];
|
|
30294
|
+
};
|
|
30295
|
+
};
|
|
29690
30296
|
/** @description Folder must be empty and owned by you */
|
|
29691
30297
|
UserCollectionFoldersDeleteResource400Response: {
|
|
29692
30298
|
headers: {
|
|
@@ -29705,6 +30311,15 @@ export interface components {
|
|
|
29705
30311
|
"application/vnd.api+json": components["schemas"]["UserCollectionPlaylistsAddMultiDataRelationshipWithResponse409ResponseBody"];
|
|
29706
30312
|
};
|
|
29707
30313
|
};
|
|
30314
|
+
/** @description filter[query] requires INTERNAL access tier */
|
|
30315
|
+
UserCollectionPlaylistsReadMultiDataRelationship403Response: {
|
|
30316
|
+
headers: {
|
|
30317
|
+
[name: string]: unknown;
|
|
30318
|
+
};
|
|
30319
|
+
content: {
|
|
30320
|
+
"application/vnd.api+json": components["schemas"]["UserCollectionPlaylistsReadMultiDataRelationship403ResponseBody"];
|
|
30321
|
+
};
|
|
30322
|
+
};
|
|
29708
30323
|
/** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */
|
|
29709
30324
|
UserCollectionSaveForLatersAddMultiDataRelationshipWithResponse409Response: {
|
|
29710
30325
|
headers: {
|
|
@@ -29723,6 +30338,15 @@ export interface components {
|
|
|
29723
30338
|
"application/vnd.api+json": components["schemas"]["UserCollectionTracksAddMultiDataRelationshipWithResponse409ResponseBody"];
|
|
29724
30339
|
};
|
|
29725
30340
|
};
|
|
30341
|
+
/** @description filter[query] requires INTERNAL access tier */
|
|
30342
|
+
UserCollectionTracksReadMultiDataRelationship403Response: {
|
|
30343
|
+
headers: {
|
|
30344
|
+
[name: string]: unknown;
|
|
30345
|
+
};
|
|
30346
|
+
content: {
|
|
30347
|
+
"application/vnd.api+json": components["schemas"]["UserCollectionTracksReadMultiDataRelationship403ResponseBody"];
|
|
30348
|
+
};
|
|
30349
|
+
};
|
|
29726
30350
|
/** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */
|
|
29727
30351
|
UserCollectionVideosAddMultiDataRelationshipWithResponse409Response: {
|
|
29728
30352
|
headers: {
|
|
@@ -29732,6 +30356,15 @@ export interface components {
|
|
|
29732
30356
|
"application/vnd.api+json": components["schemas"]["UserCollectionVideosAddMultiDataRelationshipWithResponse409ResponseBody"];
|
|
29733
30357
|
};
|
|
29734
30358
|
};
|
|
30359
|
+
/** @description filter[query] requires INTERNAL access tier */
|
|
30360
|
+
UserCollectionVideosReadMultiDataRelationship403Response: {
|
|
30361
|
+
headers: {
|
|
30362
|
+
[name: string]: unknown;
|
|
30363
|
+
};
|
|
30364
|
+
content: {
|
|
30365
|
+
"application/vnd.api+json": components["schemas"]["UserCollectionVideosReadMultiDataRelationship403ResponseBody"];
|
|
30366
|
+
};
|
|
30367
|
+
};
|
|
29735
30368
|
/** @description Recommendation block limit reached; Request already in progress for this idempotency key */
|
|
29736
30369
|
UserRecommendationBlocksAddMultiDataRelationshipWithResponse409Response: {
|
|
29737
30370
|
headers: {
|