@tidal-music/api 0.38.0 → 0.39.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.
@@ -377,7 +377,7 @@ export interface paths {
377
377
  countryCode?: string;
378
378
  /**
379
379
  * @description Allows the client to customize which related resources should be returned. Available options: albumStatistics, artists, coverArt, genres, items, owners, priceConfig, providers, replacement, shares, similarAlbums, suggestedCoverArts, usageRules
380
- * @example albumStatistics
380
+ * @example artists.albums
381
381
  */
382
382
  include?: string[];
383
383
  /** @description List of barcode IDs (EAN-13 or UPC-A). NOTE: Supplying more than one barcode ID will currently only return one album per barcode ID. (e.g. `196589525444`) */
@@ -386,6 +386,11 @@ export interface paths {
386
386
  "filter[id]"?: string[];
387
387
  /** @description User id. Use `me` for the authenticated user */
388
388
  "filter[owners.id]"?: string[];
389
+ /**
390
+ * @description 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
391
+ * @example artists.albums
392
+ */
393
+ replaceMedia?: string;
389
394
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
390
395
  shareCode?: string;
391
396
  };
@@ -483,9 +488,14 @@ export interface paths {
483
488
  countryCode?: string;
484
489
  /**
485
490
  * @description Allows the client to customize which related resources should be returned. Available options: albumStatistics, artists, coverArt, genres, items, owners, priceConfig, providers, replacement, shares, similarAlbums, suggestedCoverArts, usageRules
486
- * @example albumStatistics
491
+ * @example artists.albums
487
492
  */
488
493
  include?: string[];
494
+ /**
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
496
+ * @example artists.albums
497
+ */
498
+ replaceMedia?: string;
489
499
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
490
500
  shareCode?: string;
491
501
  };
@@ -682,9 +692,14 @@ export interface paths {
682
692
  countryCode?: string;
683
693
  /**
684
694
  * @description Allows the client to customize which related resources should be returned. Available options: artists
685
- * @example artists
695
+ * @example artists.albums
686
696
  */
687
697
  include?: string[];
698
+ /**
699
+ * @description 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
700
+ * @example artists.albums
701
+ */
702
+ replaceMedia?: string;
688
703
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
689
704
  shareCode?: string;
690
705
  };
@@ -926,6 +941,11 @@ export interface paths {
926
941
  * @example items
927
942
  */
928
943
  include?: string[];
944
+ /**
945
+ * @description 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
946
+ * @example items
947
+ */
948
+ replaceMedia?: string;
929
949
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
930
950
  shareCode?: string;
931
951
  };
@@ -1231,6 +1251,11 @@ export interface paths {
1231
1251
  * @example replacement
1232
1252
  */
1233
1253
  include?: string[];
1254
+ /**
1255
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: replacement
1256
+ * @example replacement
1257
+ */
1258
+ replaceMedia?: string;
1234
1259
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
1235
1260
  shareCode?: string;
1236
1261
  };
@@ -1289,11 +1314,16 @@ export interface paths {
1289
1314
  query?: {
1290
1315
  /**
1291
1316
  * @description Allows the client to customize which related resources should be returned. Available options: shares
1292
- * @example shares
1317
+ * @example shares.sharedResources
1293
1318
  */
1294
1319
  include?: string[];
1295
1320
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
1296
1321
  "page[cursor]"?: string;
1322
+ /**
1323
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: shares.sharedResources
1324
+ * @example shares.sharedResources
1325
+ */
1326
+ replaceMedia?: string;
1297
1327
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
1298
1328
  shareCode?: string;
1299
1329
  };
@@ -1362,6 +1392,11 @@ export interface paths {
1362
1392
  * @example similarAlbums
1363
1393
  */
1364
1394
  include?: string[];
1395
+ /**
1396
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: similarAlbums
1397
+ * @example similarAlbums
1398
+ */
1399
+ replaceMedia?: string;
1365
1400
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
1366
1401
  shareCode?: string;
1367
1402
  };
@@ -1817,11 +1852,16 @@ export interface paths {
1817
1852
  query: {
1818
1853
  /**
1819
1854
  * @description Allows the client to customize which related resources should be returned. Available options: acceptedArtists, owners, recommendedArtists
1820
- * @example acceptedArtists
1855
+ * @example acceptedArtists.albums
1821
1856
  */
1822
1857
  include?: string[];
1823
1858
  /** @description User id. Use `me` for the authenticated user */
1824
1859
  "filter[owners.id]": string[];
1860
+ /**
1861
+ * @description 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
1862
+ * @example acceptedArtists.albums
1863
+ */
1864
+ replaceMedia?: string;
1825
1865
  };
1826
1866
  header?: never;
1827
1867
  path?: never;
@@ -1918,9 +1958,14 @@ export interface paths {
1918
1958
  query?: {
1919
1959
  /**
1920
1960
  * @description Allows the client to customize which related resources should be returned. Available options: acceptedArtists, owners, recommendedArtists
1921
- * @example acceptedArtists
1961
+ * @example acceptedArtists.albums
1922
1962
  */
1923
1963
  include?: string[];
1964
+ /**
1965
+ * @description 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
1966
+ * @example acceptedArtists.albums
1967
+ */
1968
+ replaceMedia?: string;
1924
1969
  };
1925
1970
  header?: never;
1926
1971
  path: {
@@ -2053,11 +2098,16 @@ export interface paths {
2053
2098
  query?: {
2054
2099
  /**
2055
2100
  * @description Allows the client to customize which related resources should be returned. Available options: acceptedArtists
2056
- * @example acceptedArtists
2101
+ * @example acceptedArtists.albums
2057
2102
  */
2058
2103
  include?: string[];
2059
2104
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
2060
2105
  "page[cursor]"?: string;
2106
+ /**
2107
+ * @description 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
2108
+ * @example acceptedArtists.albums
2109
+ */
2110
+ replaceMedia?: string;
2061
2111
  };
2062
2112
  header?: never;
2063
2113
  path: {
@@ -2218,11 +2268,16 @@ export interface paths {
2218
2268
  query?: {
2219
2269
  /**
2220
2270
  * @description Allows the client to customize which related resources should be returned. Available options: recommendedArtists
2221
- * @example recommendedArtists
2271
+ * @example recommendedArtists.albums
2222
2272
  */
2223
2273
  include?: string[];
2224
2274
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
2225
2275
  "page[cursor]"?: string;
2276
+ /**
2277
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: recommendedArtists.albums
2278
+ * @example recommendedArtists.albums
2279
+ */
2280
+ replaceMedia?: string;
2226
2281
  };
2227
2282
  header?: never;
2228
2283
  path: {
@@ -2346,6 +2401,11 @@ export interface paths {
2346
2401
  "filter[id]"?: string[];
2347
2402
  /** @description User id. Use `me` for the authenticated user */
2348
2403
  "filter[owners.id]"?: string[];
2404
+ /**
2405
+ * @description 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
2406
+ * @example albums
2407
+ */
2408
+ replaceMedia?: string;
2349
2409
  };
2350
2410
  header?: never;
2351
2411
  path?: never;
@@ -2444,6 +2504,11 @@ export interface paths {
2444
2504
  * @example albums
2445
2505
  */
2446
2506
  include?: string[];
2507
+ /**
2508
+ * @description 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
2509
+ * @example albums
2510
+ */
2511
+ replaceMedia?: string;
2447
2512
  };
2448
2513
  header?: never;
2449
2514
  path: {
@@ -2547,6 +2612,11 @@ export interface paths {
2547
2612
  * @example albums
2548
2613
  */
2549
2614
  include?: string[];
2615
+ /**
2616
+ * @description 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
2617
+ * @example albums
2618
+ */
2619
+ replaceMedia?: string;
2550
2620
  };
2551
2621
  header?: never;
2552
2622
  path: {
@@ -2729,9 +2799,14 @@ export interface paths {
2729
2799
  "page[cursor]"?: string;
2730
2800
  /**
2731
2801
  * @description Allows the client to customize which related resources should be returned. Available options: followers
2732
- * @example followers
2802
+ * @example followers.albums
2733
2803
  */
2734
2804
  include?: string[];
2805
+ /**
2806
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: followers.albums
2807
+ * @example followers.albums
2808
+ */
2809
+ replaceMedia?: string;
2735
2810
  };
2736
2811
  header?: never;
2737
2812
  path: {
@@ -2791,9 +2866,14 @@ export interface paths {
2791
2866
  "page[cursor]"?: string;
2792
2867
  /**
2793
2868
  * @description Allows the client to customize which related resources should be returned. Available options: following
2794
- * @example following
2869
+ * @example following.albums
2795
2870
  */
2796
2871
  include?: string[];
2872
+ /**
2873
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: following.albums
2874
+ * @example following.albums
2875
+ */
2876
+ replaceMedia?: string;
2797
2877
  };
2798
2878
  header?: never;
2799
2879
  path: {
@@ -3101,9 +3181,14 @@ export interface paths {
3101
3181
  countryCode?: string;
3102
3182
  /**
3103
3183
  * @description Allows the client to customize which related resources should be returned. Available options: radio
3104
- * @example radio
3184
+ * @example radio.items
3105
3185
  */
3106
3186
  include?: string[];
3187
+ /**
3188
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: radio.items
3189
+ * @example radio.items
3190
+ */
3191
+ replaceMedia?: string;
3107
3192
  };
3108
3193
  header?: never;
3109
3194
  path: {
@@ -3228,9 +3313,14 @@ export interface paths {
3228
3313
  countryCode?: string;
3229
3314
  /**
3230
3315
  * @description Allows the client to customize which related resources should be returned. Available options: similarArtists
3231
- * @example similarArtists
3316
+ * @example similarArtists.albums
3232
3317
  */
3233
3318
  include?: string[];
3319
+ /**
3320
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: similarArtists.albums
3321
+ * @example similarArtists.albums
3322
+ */
3323
+ replaceMedia?: string;
3234
3324
  };
3235
3325
  header?: never;
3236
3326
  path: {
@@ -3363,6 +3453,11 @@ export interface paths {
3363
3453
  * @example tracks
3364
3454
  */
3365
3455
  include?: string[];
3456
+ /**
3457
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: tracks
3458
+ * @example tracks
3459
+ */
3460
+ replaceMedia?: string;
3366
3461
  };
3367
3462
  header?: never;
3368
3463
  path: {
@@ -3429,6 +3524,11 @@ export interface paths {
3429
3524
  * @example videos
3430
3525
  */
3431
3526
  include?: string[];
3527
+ /**
3528
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: videos
3529
+ * @example videos
3530
+ */
3531
+ replaceMedia?: string;
3432
3532
  };
3433
3533
  header?: never;
3434
3534
  path: {
@@ -4060,11 +4160,16 @@ export interface paths {
4060
4160
  query: {
4061
4161
  /**
4062
4162
  * @description Allows the client to customize which related resources should be returned. Available options: owners, subject
4063
- * @example owners
4163
+ * @example subject.items
4064
4164
  */
4065
4165
  include?: string[];
4066
4166
  /** @description Invite code */
4067
4167
  "filter[code]": string[];
4168
+ /**
4169
+ * @description 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
4170
+ * @example subject.items
4171
+ */
4172
+ replaceMedia?: string;
4068
4173
  };
4069
4174
  header?: never;
4070
4175
  path?: never;
@@ -4155,9 +4260,14 @@ export interface paths {
4155
4260
  query?: {
4156
4261
  /**
4157
4262
  * @description Allows the client to customize which related resources should be returned. Available options: owners, subject
4158
- * @example owners
4263
+ * @example subject.items
4159
4264
  */
4160
4265
  include?: string[];
4266
+ /**
4267
+ * @description 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
4268
+ * @example subject.items
4269
+ */
4270
+ replaceMedia?: string;
4161
4271
  };
4162
4272
  header?: never;
4163
4273
  path: {
@@ -4308,9 +4418,14 @@ export interface paths {
4308
4418
  query?: {
4309
4419
  /**
4310
4420
  * @description Allows the client to customize which related resources should be returned. Available options: subject
4311
- * @example subject
4421
+ * @example subject.items
4312
4422
  */
4313
4423
  include?: string[];
4424
+ /**
4425
+ * @description 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
4426
+ * @example subject.items
4427
+ */
4428
+ replaceMedia?: string;
4314
4429
  };
4315
4430
  header?: never;
4316
4431
  path: {
@@ -4785,6 +4900,11 @@ export interface paths {
4785
4900
  include?: string[];
4786
4901
  /** @description User id. Use `me` for the authenticated user */
4787
4902
  "filter[owners.id]": string[];
4903
+ /**
4904
+ * @description 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
4905
+ * @example claimedResource
4906
+ */
4907
+ replaceMedia?: string;
4788
4908
  };
4789
4909
  header?: never;
4790
4910
  path?: never;
@@ -4878,6 +4998,11 @@ export interface paths {
4878
4998
  * @example claimedResource
4879
4999
  */
4880
5000
  include?: string[];
5001
+ /**
5002
+ * @description 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
5003
+ * @example claimedResource
5004
+ */
5005
+ replaceMedia?: string;
4881
5006
  };
4882
5007
  header?: never;
4883
5008
  path: {
@@ -4937,6 +5062,11 @@ export interface paths {
4937
5062
  * @example claimedResource
4938
5063
  */
4939
5064
  include?: string[];
5065
+ /**
5066
+ * @description 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
5067
+ * @example claimedResource
5068
+ */
5069
+ replaceMedia?: string;
4940
5070
  };
4941
5071
  header?: never;
4942
5072
  path: {
@@ -4993,9 +5123,14 @@ export interface paths {
4993
5123
  query?: {
4994
5124
  /**
4995
5125
  * @description Allows the client to customize which related resources should be returned. Available options: claimingArtist
4996
- * @example claimingArtist
5126
+ * @example claimingArtist.albums
4997
5127
  */
4998
5128
  include?: string[];
5129
+ /**
5130
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: claimingArtist.albums
5131
+ * @example claimingArtist.albums
5132
+ */
5133
+ replaceMedia?: string;
4999
5134
  };
5000
5135
  header?: never;
5001
5136
  path: {
@@ -5113,9 +5248,14 @@ export interface paths {
5113
5248
  query?: {
5114
5249
  /**
5115
5250
  * @description Allows the client to customize which related resources should be returned. Available options: artist, category
5116
- * @example artist
5251
+ * @example artist.albums
5117
5252
  */
5118
5253
  include?: string[];
5254
+ /**
5255
+ * @description 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
5256
+ * @example artist.albums
5257
+ */
5258
+ replaceMedia?: string;
5119
5259
  };
5120
5260
  header?: never;
5121
5261
  path: {
@@ -5172,9 +5312,14 @@ export interface paths {
5172
5312
  query?: {
5173
5313
  /**
5174
5314
  * @description Allows the client to customize which related resources should be returned. Available options: artist
5175
- * @example artist
5315
+ * @example artist.albums
5176
5316
  */
5177
5317
  include?: string[];
5318
+ /**
5319
+ * @description 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
5320
+ * @example artist.albums
5321
+ */
5322
+ replaceMedia?: string;
5178
5323
  };
5179
5324
  header?: never;
5180
5325
  path: {
@@ -5472,6 +5617,11 @@ export interface paths {
5472
5617
  "filter[subject.id]": string[];
5473
5618
  /** @description The type of the subject resource (e.g., albums, tracks, artists) (e.g. `tracks`) */
5474
5619
  "filter[subject.type]": ("tracks" | "albums" | "artists")[];
5620
+ /**
5621
+ * @description 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
5622
+ * @example subject
5623
+ */
5624
+ replaceMedia?: string;
5475
5625
  };
5476
5626
  header?: never;
5477
5627
  path?: never;
@@ -5525,6 +5675,11 @@ export interface paths {
5525
5675
  * @example subject
5526
5676
  */
5527
5677
  include?: string[];
5678
+ /**
5679
+ * @description 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
5680
+ * @example subject
5681
+ */
5682
+ replaceMedia?: string;
5528
5683
  };
5529
5684
  header?: never;
5530
5685
  path: {
@@ -5613,6 +5768,11 @@ export interface paths {
5613
5768
  include?: string[];
5614
5769
  /** @description DynamicModules Id (e.g. `nejMcAhh5N8S3EQ4LaqysVdI0cZZ`) */
5615
5770
  "filter[id]": string[];
5771
+ /**
5772
+ * @description 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
5773
+ * @example items
5774
+ */
5775
+ replaceMedia?: string;
5616
5776
  };
5617
5777
  header?: never;
5618
5778
  path?: never;
@@ -5693,6 +5853,11 @@ export interface paths {
5693
5853
  * @example items
5694
5854
  */
5695
5855
  include?: string[];
5856
+ /**
5857
+ * @description 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
5858
+ * @example items
5859
+ */
5860
+ replaceMedia?: string;
5696
5861
  };
5697
5862
  header?: never;
5698
5863
  path: {
@@ -5781,6 +5946,11 @@ export interface paths {
5781
5946
  * @example items
5782
5947
  */
5783
5948
  include?: string[];
5949
+ /**
5950
+ * @description 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
5951
+ * @example items
5952
+ */
5953
+ replaceMedia?: string;
5784
5954
  };
5785
5955
  header?: never;
5786
5956
  path: {
@@ -5830,7 +6000,7 @@ export interface paths {
5830
6000
  };
5831
6001
  /**
5832
6002
  * Get seedItem relationship ("to-one").
5833
- * @description The item whose listen or add event seeded this module's collection (e.g. the album a BECAUSE_YOU_* module is based on); null for modules that are not seeded by an item. The seed comes from the same fetch as the module's items, so the two always agree.
6003
+ * @description The item whose listen or add event seeded this module's collection (e.g. the album a BECAUSE_YOU_* module is based on); null for modules that are not seeded by an item.
5834
6004
  */
5835
6005
  get: {
5836
6006
  parameters: {
@@ -5867,6 +6037,11 @@ export interface paths {
5867
6037
  * @example seedItem
5868
6038
  */
5869
6039
  include?: string[];
6040
+ /**
6041
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: seedItem
6042
+ * @example seedItem
6043
+ */
6044
+ replaceMedia?: string;
5870
6045
  };
5871
6046
  header?: never;
5872
6047
  path: {
@@ -5950,13 +6125,18 @@ export interface paths {
5950
6125
  clientVersion: string;
5951
6126
  /**
5952
6127
  * @description Allows the client to customize which related resources should be returned. Available options: modules, subject
5953
- * @example modules
6128
+ * @example modules.items
5954
6129
  */
5955
6130
  include?: string[];
5956
6131
  /** @description type of the page (e.g. `ARTIST`) */
5957
6132
  "filter[pageType]": string[];
5958
6133
  /** @description The subject resource ID. Required except for HOME_FREE, where it must be omitted. (e.g. `67890`) */
5959
6134
  "filter[subject.id]"?: string[];
6135
+ /**
6136
+ * @description 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
6137
+ * @example modules.items
6138
+ */
6139
+ replaceMedia?: string;
5960
6140
  };
5961
6141
  header?: never;
5962
6142
  path?: never;
@@ -6036,9 +6216,14 @@ export interface paths {
6036
6216
  clientVersion: string;
6037
6217
  /**
6038
6218
  * @description Allows the client to customize which related resources should be returned. Available options: modules
6039
- * @example modules
6219
+ * @example modules.items
6040
6220
  */
6041
6221
  include?: string[];
6222
+ /**
6223
+ * @description 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
6224
+ * @example modules.items
6225
+ */
6226
+ replaceMedia?: string;
6042
6227
  };
6043
6228
  header?: never;
6044
6229
  path: {
@@ -6098,6 +6283,11 @@ export interface paths {
6098
6283
  * @example subject
6099
6284
  */
6100
6285
  include?: string[];
6286
+ /**
6287
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: subject
6288
+ * @example subject
6289
+ */
6290
+ replaceMedia?: string;
6101
6291
  };
6102
6292
  header?: never;
6103
6293
  path: {
@@ -6279,6 +6469,11 @@ export interface paths {
6279
6469
  "filter[clientProvidedInstallationId]"?: string[];
6280
6470
  /** @description User ID to filter by. Use `me` for the authenticated user */
6281
6471
  "filter[owners.id]"?: string[];
6472
+ /**
6473
+ * @description 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
6474
+ * @example offlineInventory
6475
+ */
6476
+ replaceMedia?: string;
6282
6477
  };
6283
6478
  header?: never;
6284
6479
  path?: never;
@@ -6372,6 +6567,11 @@ export interface paths {
6372
6567
  * @example offlineInventory
6373
6568
  */
6374
6569
  include?: string[];
6570
+ /**
6571
+ * @description 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
6572
+ * @example offlineInventory
6573
+ */
6574
+ replaceMedia?: string;
6375
6575
  };
6376
6576
  header?: never;
6377
6577
  path: {
@@ -6439,6 +6639,11 @@ export interface paths {
6439
6639
  "filter[state]"?: ("PENDING" | "STORED")[];
6440
6640
  /** @description One of: tracks, videos, albums, playlists, userCollectionTracks (e.g. `tracks`) */
6441
6641
  "filter[type]": ("tracks" | "videos" | "albums" | "playlists" | "userCollectionTracks")[];
6642
+ /**
6643
+ * @description 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
6644
+ * @example offlineInventory
6645
+ */
6646
+ replaceMedia?: string;
6442
6647
  };
6443
6648
  header?: never;
6444
6649
  path: {
@@ -6686,9 +6891,14 @@ export interface paths {
6686
6891
  query?: {
6687
6892
  /**
6688
6893
  * @description Allows the client to customize which related resources should be returned. Available options: owners, track
6689
- * @example owners
6894
+ * @example track
6690
6895
  */
6691
6896
  include?: string[];
6897
+ /**
6898
+ * @description 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
6899
+ * @example track
6900
+ */
6901
+ replaceMedia?: string;
6692
6902
  };
6693
6903
  header?: never;
6694
6904
  path: {
@@ -6889,6 +7099,11 @@ export interface paths {
6889
7099
  * @example track
6890
7100
  */
6891
7101
  include?: string[];
7102
+ /**
7103
+ * @description 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
7104
+ * @example track
7105
+ */
7106
+ replaceMedia?: string;
6892
7107
  };
6893
7108
  header?: never;
6894
7109
  path: {
@@ -7008,6 +7223,11 @@ export interface paths {
7008
7223
  include?: string[];
7009
7224
  /** @description List of offline task IDs (e.g. `a468bee88def`) */
7010
7225
  "filter[installation.id]": string[];
7226
+ /**
7227
+ * @description 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
7228
+ * @example collection
7229
+ */
7230
+ replaceMedia?: string;
7011
7231
  };
7012
7232
  header?: never;
7013
7233
  path?: never;
@@ -7061,6 +7281,11 @@ export interface paths {
7061
7281
  * @example collection
7062
7282
  */
7063
7283
  include?: string[];
7284
+ /**
7285
+ * @description 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
7286
+ * @example collection
7287
+ */
7288
+ replaceMedia?: string;
7064
7289
  };
7065
7290
  header?: never;
7066
7291
  path: {
@@ -7157,6 +7382,11 @@ export interface paths {
7157
7382
  * @example collection
7158
7383
  */
7159
7384
  include?: string[];
7385
+ /**
7386
+ * @description 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
7387
+ * @example collection
7388
+ */
7389
+ replaceMedia?: string;
7160
7390
  };
7161
7391
  header?: never;
7162
7392
  path: {
@@ -7216,6 +7446,11 @@ export interface paths {
7216
7446
  * @example item
7217
7447
  */
7218
7448
  include?: string[];
7449
+ /**
7450
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: item
7451
+ * @example item
7452
+ */
7453
+ replaceMedia?: string;
7219
7454
  };
7220
7455
  header?: never;
7221
7456
  path: {
@@ -7340,6 +7575,11 @@ export interface paths {
7340
7575
  include?: string[];
7341
7576
  /** @description User id. Use `me` for the authenticated user */
7342
7577
  "filter[owners.id]": string[];
7578
+ /**
7579
+ * @description 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
7580
+ * @example current
7581
+ */
7582
+ replaceMedia?: string;
7343
7583
  };
7344
7584
  header?: never;
7345
7585
  path?: never;
@@ -7433,6 +7673,11 @@ export interface paths {
7433
7673
  * @example current
7434
7674
  */
7435
7675
  include?: string[];
7676
+ /**
7677
+ * @description 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
7678
+ * @example current
7679
+ */
7680
+ replaceMedia?: string;
7436
7681
  };
7437
7682
  header?: never;
7438
7683
  path: {
@@ -7562,6 +7807,11 @@ export interface paths {
7562
7807
  * @example current
7563
7808
  */
7564
7809
  include?: string[];
7810
+ /**
7811
+ * @description 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
7812
+ * @example current
7813
+ */
7814
+ replaceMedia?: string;
7565
7815
  };
7566
7816
  header?: never;
7567
7817
  path: {
@@ -7660,6 +7910,11 @@ export interface paths {
7660
7910
  * @example future
7661
7911
  */
7662
7912
  include?: string[];
7913
+ /**
7914
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: future
7915
+ * @example future
7916
+ */
7917
+ replaceMedia?: string;
7663
7918
  };
7664
7919
  header?: never;
7665
7920
  path: {
@@ -7893,6 +8148,11 @@ export interface paths {
7893
8148
  * @example past
7894
8149
  */
7895
8150
  include?: string[];
8151
+ /**
8152
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: past
8153
+ * @example past
8154
+ */
8155
+ replaceMedia?: string;
7896
8156
  };
7897
8157
  header?: never;
7898
8158
  path: {
@@ -7958,13 +8218,18 @@ export interface paths {
7958
8218
  countryCode?: string;
7959
8219
  /**
7960
8220
  * @description Allows the client to customize which related resources should be returned. Available options: collaboratorProfiles, collaborators, coverArt, items, ownerProfiles, owners, suggestedCoverArts
7961
- * @example collaboratorProfiles
8221
+ * @example items
7962
8222
  */
7963
8223
  include?: string[];
7964
8224
  /** @description List of playlist IDs (e.g. `550e8400-e29b-41d4-a716-446655440000`) */
7965
8225
  "filter[id]"?: string[];
7966
8226
  /** @description User id. Use `me` for the authenticated user */
7967
8227
  "filter[owners.id]"?: string[];
8228
+ /**
8229
+ * @description 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
8230
+ * @example items
8231
+ */
8232
+ replaceMedia?: string;
7968
8233
  };
7969
8234
  header?: never;
7970
8235
  path?: never;
@@ -8066,9 +8331,14 @@ export interface paths {
8066
8331
  countryCode?: string;
8067
8332
  /**
8068
8333
  * @description Allows the client to customize which related resources should be returned. Available options: collaboratorProfiles, collaborators, coverArt, items, ownerProfiles, owners, suggestedCoverArts
8069
- * @example collaboratorProfiles
8334
+ * @example items
8070
8335
  */
8071
8336
  include?: string[];
8337
+ /**
8338
+ * @description 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
8339
+ * @example items
8340
+ */
8341
+ replaceMedia?: string;
8072
8342
  };
8073
8343
  header?: never;
8074
8344
  path: {
@@ -8522,6 +8792,11 @@ export interface paths {
8522
8792
  * @example items
8523
8793
  */
8524
8794
  include?: string[];
8795
+ /**
8796
+ * @description 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
8797
+ * @example items
8798
+ */
8799
+ replaceMedia?: string;
8525
8800
  };
8526
8801
  header?: never;
8527
8802
  path: {
@@ -9214,7 +9489,7 @@ export interface paths {
9214
9489
  countryCode?: string;
9215
9490
  /**
9216
9491
  * @description Allows the client to customize which related resources should be returned. Available options: provider, subject
9217
- * @example provider
9492
+ * @example subject
9218
9493
  */
9219
9494
  include?: string[];
9220
9495
  /** @description List of barcode IDs (EAN-13 or UPC-A) (e.g. `00602527336510`) */
@@ -9223,6 +9498,11 @@ export interface paths {
9223
9498
  "filter[grid]"?: string[];
9224
9499
  /** @description Content provider ID (e.g. `50`) */
9225
9500
  "filter[provider.id]": string[];
9501
+ /**
9502
+ * @description 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
9503
+ * @example subject
9504
+ */
9505
+ replaceMedia?: string;
9226
9506
  };
9227
9507
  header?: never;
9228
9508
  path?: never;
@@ -9337,6 +9617,11 @@ export interface paths {
9337
9617
  * @example subject
9338
9618
  */
9339
9619
  include?: string[];
9620
+ /**
9621
+ * @description 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
9622
+ * @example subject
9623
+ */
9624
+ replaceMedia?: string;
9340
9625
  };
9341
9626
  header?: never;
9342
9627
  path: {
@@ -9445,13 +9730,18 @@ export interface paths {
9445
9730
  "page[cursor]"?: string;
9446
9731
  /**
9447
9732
  * @description Allows the client to customize which related resources should be returned. Available options: owners, subject
9448
- * @example owners
9733
+ * @example subject
9449
9734
  */
9450
9735
  include?: string[];
9451
9736
  /** @description User id. Use `me` for the authenticated user */
9452
9737
  "filter[owners.id]": string[];
9453
9738
  /** @description The type of purchased content (e.g. `albums`) */
9454
9739
  "filter[subject.type]": ("albums" | "tracks")[];
9740
+ /**
9741
+ * @description 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
9742
+ * @example subject
9743
+ */
9744
+ replaceMedia?: string;
9455
9745
  };
9456
9746
  header?: never;
9457
9747
  path?: never;
@@ -9566,6 +9856,11 @@ export interface paths {
9566
9856
  * @example subject
9567
9857
  */
9568
9858
  include?: string[];
9859
+ /**
9860
+ * @description 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
9861
+ * @example subject
9862
+ */
9863
+ replaceMedia?: string;
9569
9864
  };
9570
9865
  header?: never;
9571
9866
  path: {
@@ -10080,6 +10375,11 @@ export interface paths {
10080
10375
  * @example albums
10081
10376
  */
10082
10377
  include?: string[];
10378
+ /**
10379
+ * @description 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
10380
+ * @example albums
10381
+ */
10382
+ replaceMedia?: string;
10083
10383
  };
10084
10384
  header?: never;
10085
10385
  path: {
@@ -10166,6 +10466,11 @@ export interface paths {
10166
10466
  * @example albums
10167
10467
  */
10168
10468
  include?: string[];
10469
+ /**
10470
+ * @description 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
10471
+ * @example albums
10472
+ */
10473
+ replaceMedia?: string;
10169
10474
  };
10170
10475
  header?: never;
10171
10476
  path: {
@@ -10252,6 +10557,11 @@ export interface paths {
10252
10557
  * @example artists
10253
10558
  */
10254
10559
  include?: string[];
10560
+ /**
10561
+ * @description 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
10562
+ * @example artists
10563
+ */
10564
+ replaceMedia?: string;
10255
10565
  };
10256
10566
  header?: never;
10257
10567
  path: {
@@ -10338,6 +10648,11 @@ export interface paths {
10338
10648
  * @example playlists
10339
10649
  */
10340
10650
  include?: string[];
10651
+ /**
10652
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: playlists
10653
+ * @example playlists
10654
+ */
10655
+ replaceMedia?: string;
10341
10656
  };
10342
10657
  header?: never;
10343
10658
  path: {
@@ -10424,6 +10739,11 @@ export interface paths {
10424
10739
  * @example topHits
10425
10740
  */
10426
10741
  include?: string[];
10742
+ /**
10743
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: topHits
10744
+ * @example topHits
10745
+ */
10746
+ replaceMedia?: string;
10427
10747
  };
10428
10748
  header?: never;
10429
10749
  path: {
@@ -10510,6 +10830,11 @@ export interface paths {
10510
10830
  * @example tracks
10511
10831
  */
10512
10832
  include?: string[];
10833
+ /**
10834
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: tracks
10835
+ * @example tracks
10836
+ */
10837
+ replaceMedia?: string;
10513
10838
  };
10514
10839
  header?: never;
10515
10840
  path: {
@@ -10596,6 +10921,11 @@ export interface paths {
10596
10921
  * @example videos
10597
10922
  */
10598
10923
  include?: string[];
10924
+ /**
10925
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: videos
10926
+ * @example videos
10927
+ */
10928
+ replaceMedia?: string;
10599
10929
  };
10600
10930
  header?: never;
10601
10931
  path: {
@@ -10665,6 +10995,11 @@ export interface paths {
10665
10995
  * @example directHits
10666
10996
  */
10667
10997
  include?: string[];
10998
+ /**
10999
+ * @description 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
11000
+ * @example directHits
11001
+ */
11002
+ replaceMedia?: string;
10668
11003
  };
10669
11004
  header?: never;
10670
11005
  path: {
@@ -10736,6 +11071,11 @@ export interface paths {
10736
11071
  include?: string[];
10737
11072
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
10738
11073
  "page[cursor]"?: string;
11074
+ /**
11075
+ * @description 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
11076
+ * @example directHits
11077
+ */
11078
+ replaceMedia?: string;
10739
11079
  };
10740
11080
  header?: never;
10741
11081
  path: {
@@ -10863,11 +11203,16 @@ export interface paths {
10863
11203
  query: {
10864
11204
  /**
10865
11205
  * @description Allows the client to customize which related resources should be returned. Available options: owners, sharedResources
10866
- * @example owners
11206
+ * @example sharedResources
10867
11207
  */
10868
11208
  include?: string[];
10869
11209
  /** @description A share code (e.g. `xyz`) */
10870
11210
  "filter[code]": string[];
11211
+ /**
11212
+ * @description 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
11213
+ * @example sharedResources
11214
+ */
11215
+ replaceMedia?: string;
10871
11216
  };
10872
11217
  header?: never;
10873
11218
  path?: never;
@@ -10958,9 +11303,14 @@ export interface paths {
10958
11303
  query?: {
10959
11304
  /**
10960
11305
  * @description Allows the client to customize which related resources should be returned. Available options: owners, sharedResources
10961
- * @example owners
11306
+ * @example sharedResources
10962
11307
  */
10963
11308
  include?: string[];
11309
+ /**
11310
+ * @description 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
11311
+ * @example sharedResources
11312
+ */
11313
+ replaceMedia?: string;
10964
11314
  };
10965
11315
  header?: never;
10966
11316
  path: {
@@ -11083,6 +11433,11 @@ export interface paths {
11083
11433
  * @example sharedResources
11084
11434
  */
11085
11435
  include?: string[];
11436
+ /**
11437
+ * @description 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
11438
+ * @example sharedResources
11439
+ */
11440
+ replaceMedia?: string;
11086
11441
  };
11087
11442
  header?: never;
11088
11443
  path: {
@@ -12649,6 +13004,11 @@ export interface paths {
12649
13004
  "filter[isrc]"?: string[];
12650
13005
  /** @description User id. Use `me` for the authenticated user */
12651
13006
  "filter[owners.id]"?: string[];
13007
+ /**
13008
+ * @description 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
13009
+ * @example albums
13010
+ */
13011
+ replaceMedia?: string;
12652
13012
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
12653
13013
  shareCode?: string;
12654
13014
  };
@@ -12749,6 +13109,11 @@ export interface paths {
12749
13109
  * @example albums
12750
13110
  */
12751
13111
  include?: string[];
13112
+ /**
13113
+ * @description 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
13114
+ * @example albums
13115
+ */
13116
+ replaceMedia?: string;
12752
13117
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
12753
13118
  shareCode?: string;
12754
13119
  };
@@ -12887,6 +13252,11 @@ export interface paths {
12887
13252
  include?: string[];
12888
13253
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
12889
13254
  "page[cursor]"?: string;
13255
+ /**
13256
+ * @description 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
13257
+ * @example albums
13258
+ */
13259
+ replaceMedia?: string;
12890
13260
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
12891
13261
  shareCode?: string;
12892
13262
  };
@@ -12989,9 +13359,14 @@ export interface paths {
12989
13359
  countryCode?: string;
12990
13360
  /**
12991
13361
  * @description Allows the client to customize which related resources should be returned. Available options: artists
12992
- * @example artists
13362
+ * @example artists.albums
12993
13363
  */
12994
13364
  include?: string[];
13365
+ /**
13366
+ * @description 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
13367
+ * @example artists.albums
13368
+ */
13369
+ replaceMedia?: string;
12995
13370
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
12996
13371
  shareCode?: string;
12997
13372
  };
@@ -13052,9 +13427,14 @@ export interface paths {
13052
13427
  "page[cursor]"?: string;
13053
13428
  /**
13054
13429
  * @description Allows the client to customize which related resources should be returned. Available options: credits
13055
- * @example credits
13430
+ * @example credits.artist.albums
13056
13431
  */
13057
13432
  include?: string[];
13433
+ /**
13434
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: credits.artist.albums
13435
+ * @example credits.artist.albums
13436
+ */
13437
+ replaceMedia?: string;
13058
13438
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
13059
13439
  shareCode?: string;
13060
13440
  };
@@ -13242,11 +13622,16 @@ export interface paths {
13242
13622
  query?: {
13243
13623
  /**
13244
13624
  * @description Allows the client to customize which related resources should be returned. Available options: lyrics
13245
- * @example lyrics
13625
+ * @example lyrics.track
13246
13626
  */
13247
13627
  include?: string[];
13248
13628
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
13249
13629
  "page[cursor]"?: string;
13630
+ /**
13631
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: lyrics.track
13632
+ * @example lyrics.track
13633
+ */
13634
+ replaceMedia?: string;
13250
13635
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
13251
13636
  shareCode?: string;
13252
13637
  };
@@ -13568,11 +13953,16 @@ export interface paths {
13568
13953
  query?: {
13569
13954
  /**
13570
13955
  * @description Allows the client to customize which related resources should be returned. Available options: radio
13571
- * @example radio
13956
+ * @example radio.items
13572
13957
  */
13573
13958
  include?: string[];
13574
13959
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
13575
13960
  "page[cursor]"?: string;
13961
+ /**
13962
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: radio.items
13963
+ * @example radio.items
13964
+ */
13965
+ replaceMedia?: string;
13576
13966
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
13577
13967
  shareCode?: string;
13578
13968
  };
@@ -13639,6 +14029,11 @@ export interface paths {
13639
14029
  * @example replacement
13640
14030
  */
13641
14031
  include?: string[];
14032
+ /**
14033
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: replacement
14034
+ * @example replacement
14035
+ */
14036
+ replaceMedia?: string;
13642
14037
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
13643
14038
  shareCode?: string;
13644
14039
  };
@@ -13697,11 +14092,16 @@ export interface paths {
13697
14092
  query?: {
13698
14093
  /**
13699
14094
  * @description Allows the client to customize which related resources should be returned. Available options: shares
13700
- * @example shares
14095
+ * @example shares.sharedResources
13701
14096
  */
13702
14097
  include?: string[];
13703
14098
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
13704
14099
  "page[cursor]"?: string;
14100
+ /**
14101
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: shares.sharedResources
14102
+ * @example shares.sharedResources
14103
+ */
14104
+ replaceMedia?: string;
13705
14105
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
13706
14106
  shareCode?: string;
13707
14107
  };
@@ -13770,6 +14170,11 @@ export interface paths {
13770
14170
  * @example similarTracks
13771
14171
  */
13772
14172
  include?: string[];
14173
+ /**
14174
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: similarTracks
14175
+ * @example similarTracks
14176
+ */
14177
+ replaceMedia?: string;
13773
14178
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
13774
14179
  shareCode?: string;
13775
14180
  };
@@ -13899,6 +14304,11 @@ export interface paths {
13899
14304
  * @example suggestedTracks
13900
14305
  */
13901
14306
  include?: string[];
14307
+ /**
14308
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: suggestedTracks
14309
+ * @example suggestedTracks
14310
+ */
14311
+ replaceMedia?: string;
13902
14312
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
13903
14313
  shareCode?: string;
13904
14314
  };
@@ -14254,6 +14664,11 @@ export interface paths {
14254
14664
  * @example items
14255
14665
  */
14256
14666
  include?: string[];
14667
+ /**
14668
+ * @description 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
14669
+ * @example items
14670
+ */
14671
+ replaceMedia?: string;
14257
14672
  };
14258
14673
  header?: never;
14259
14674
  path: {
@@ -14322,6 +14737,11 @@ export interface paths {
14322
14737
  * @example items
14323
14738
  */
14324
14739
  include?: string[];
14740
+ /**
14741
+ * @description 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
14742
+ * @example items
14743
+ */
14744
+ replaceMedia?: string;
14325
14745
  };
14326
14746
  header?: never;
14327
14747
  path: {
@@ -14527,9 +14947,14 @@ export interface paths {
14527
14947
  locale?: string;
14528
14948
  /**
14529
14949
  * @description Allows the client to customize which related resources should be returned. Available options: items, owners
14530
- * @example items
14950
+ * @example items.albums
14531
14951
  */
14532
14952
  include?: string[];
14953
+ /**
14954
+ * @description 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
14955
+ * @example items.albums
14956
+ */
14957
+ replaceMedia?: string;
14533
14958
  };
14534
14959
  header?: never;
14535
14960
  path: {
@@ -14595,9 +15020,14 @@ export interface paths {
14595
15020
  locale?: string;
14596
15021
  /**
14597
15022
  * @description Allows the client to customize which related resources should be returned. Available options: items
14598
- * @example items
15023
+ * @example items.albums
14599
15024
  */
14600
15025
  include?: string[];
15026
+ /**
15027
+ * @description 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
15028
+ * @example items.albums
15029
+ */
15030
+ replaceMedia?: string;
14601
15031
  };
14602
15032
  header?: never;
14603
15033
  path: {
@@ -14798,12 +15228,17 @@ export interface paths {
14798
15228
  query: {
14799
15229
  /**
14800
15230
  * @description Allows the client to customize which related resources should be returned. Available options: items, owners, userCollection
14801
- * @example items
15231
+ * @example items.items
14802
15232
  */
14803
15233
  include?: string[];
14804
15234
  /** @description Folder Id (e.g. `CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX`) */
14805
15235
  "filter[id]": string[];
14806
- };
15236
+ /**
15237
+ * @description 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
15238
+ * @example items.items
15239
+ */
15240
+ replaceMedia?: string;
15241
+ };
14807
15242
  header?: never;
14808
15243
  path?: never;
14809
15244
  cookie?: never;
@@ -14893,9 +15328,14 @@ export interface paths {
14893
15328
  query?: {
14894
15329
  /**
14895
15330
  * @description Allows the client to customize which related resources should be returned. Available options: items, owners, userCollection
14896
- * @example items
15331
+ * @example items.items
14897
15332
  */
14898
15333
  include?: string[];
15334
+ /**
15335
+ * @description 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
15336
+ * @example items.items
15337
+ */
15338
+ replaceMedia?: string;
14899
15339
  };
14900
15340
  header?: never;
14901
15341
  path: {
@@ -15026,9 +15466,14 @@ export interface paths {
15026
15466
  sort?: ("addedAt" | "-addedAt" | "lastModifiedAt" | "-lastModifiedAt" | "name" | "-name")[];
15027
15467
  /**
15028
15468
  * @description Allows the client to customize which related resources should be returned. Available options: items
15029
- * @example items
15469
+ * @example items.items
15030
15470
  */
15031
15471
  include?: string[];
15472
+ /**
15473
+ * @description 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
15474
+ * @example items.items
15475
+ */
15476
+ replaceMedia?: string;
15032
15477
  };
15033
15478
  header?: never;
15034
15479
  path: {
@@ -15220,9 +15665,14 @@ export interface paths {
15220
15665
  query?: {
15221
15666
  /**
15222
15667
  * @description Allows the client to customize which related resources should be returned. Available options: userCollection
15223
- * @example userCollection
15668
+ * @example userCollection.items.items
15224
15669
  */
15225
15670
  include?: string[];
15671
+ /**
15672
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: userCollection.items.items
15673
+ * @example userCollection.items.items
15674
+ */
15675
+ replaceMedia?: string;
15226
15676
  };
15227
15677
  header?: never;
15228
15678
  path: {
@@ -15284,9 +15734,14 @@ export interface paths {
15284
15734
  locale?: string;
15285
15735
  /**
15286
15736
  * @description Allows the client to customize which related resources should be returned. Available options: items, owners
15287
- * @example items
15737
+ * @example items.items
15288
15738
  */
15289
15739
  include?: string[];
15740
+ /**
15741
+ * @description 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
15742
+ * @example items.items
15743
+ */
15744
+ replaceMedia?: string;
15290
15745
  };
15291
15746
  header?: never;
15292
15747
  path: {
@@ -15348,9 +15803,14 @@ export interface paths {
15348
15803
  sort?: ("addedAt" | "-addedAt" | "lastModifiedAt" | "-lastModifiedAt" | "name" | "-name")[];
15349
15804
  /**
15350
15805
  * @description Allows the client to customize which related resources should be returned. Available options: items
15351
- * @example items
15806
+ * @example items.items
15352
15807
  */
15353
15808
  include?: string[];
15809
+ /**
15810
+ * @description 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
15811
+ * @example items.items
15812
+ */
15813
+ replaceMedia?: string;
15354
15814
  };
15355
15815
  header?: never;
15356
15816
  path: {
@@ -15554,6 +16014,11 @@ export interface paths {
15554
16014
  * @example items
15555
16015
  */
15556
16016
  include?: string[];
16017
+ /**
16018
+ * @description 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
16019
+ * @example items
16020
+ */
16021
+ replaceMedia?: string;
15557
16022
  };
15558
16023
  header?: never;
15559
16024
  path: {
@@ -15615,6 +16080,11 @@ export interface paths {
15615
16080
  * @example items
15616
16081
  */
15617
16082
  include?: string[];
16083
+ /**
16084
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: items
16085
+ * @example items
16086
+ */
16087
+ replaceMedia?: string;
15618
16088
  };
15619
16089
  header?: never;
15620
16090
  path: {
@@ -15823,6 +16293,11 @@ export interface paths {
15823
16293
  * @example items
15824
16294
  */
15825
16295
  include?: string[];
16296
+ /**
16297
+ * @description 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
16298
+ * @example items
16299
+ */
16300
+ replaceMedia?: string;
15826
16301
  };
15827
16302
  header?: never;
15828
16303
  path: {
@@ -15891,6 +16366,11 @@ export interface paths {
15891
16366
  * @example items
15892
16367
  */
15893
16368
  include?: string[];
16369
+ /**
16370
+ * @description 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
16371
+ * @example items
16372
+ */
16373
+ replaceMedia?: string;
15894
16374
  };
15895
16375
  header?: never;
15896
16376
  path: {
@@ -16099,6 +16579,11 @@ export interface paths {
16099
16579
  * @example items
16100
16580
  */
16101
16581
  include?: string[];
16582
+ /**
16583
+ * @description 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
16584
+ * @example items
16585
+ */
16586
+ replaceMedia?: string;
16102
16587
  };
16103
16588
  header?: never;
16104
16589
  path: {
@@ -16167,6 +16652,11 @@ export interface paths {
16167
16652
  * @example items
16168
16653
  */
16169
16654
  include?: string[];
16655
+ /**
16656
+ * @description 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
16657
+ * @example items
16658
+ */
16659
+ replaceMedia?: string;
16170
16660
  };
16171
16661
  header?: never;
16172
16662
  path: {
@@ -16376,6 +16866,11 @@ export interface paths {
16376
16866
  * @example albums
16377
16867
  */
16378
16868
  include?: string[];
16869
+ /**
16870
+ * @description 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
16871
+ * @example albums
16872
+ */
16873
+ replaceMedia?: string;
16379
16874
  };
16380
16875
  header?: never;
16381
16876
  path: {
@@ -16445,6 +16940,11 @@ export interface paths {
16445
16940
  * @example albums
16446
16941
  */
16447
16942
  include?: string[];
16943
+ /**
16944
+ * @description 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
16945
+ * @example albums
16946
+ */
16947
+ replaceMedia?: string;
16448
16948
  };
16449
16949
  header?: never;
16450
16950
  path: {
@@ -16587,9 +17087,14 @@ export interface paths {
16587
17087
  locale?: string;
16588
17088
  /**
16589
17089
  * @description Allows the client to customize which related resources should be returned. Available options: artists
16590
- * @example artists
17090
+ * @example artists.albums
16591
17091
  */
16592
17092
  include?: string[];
17093
+ /**
17094
+ * @description 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
17095
+ * @example artists.albums
17096
+ */
17097
+ replaceMedia?: string;
16593
17098
  };
16594
17099
  header?: never;
16595
17100
  path: {
@@ -16789,9 +17294,14 @@ export interface paths {
16789
17294
  sort?: ("playlists.addedAt" | "-playlists.addedAt" | "playlists.lastUpdatedAt" | "-playlists.lastUpdatedAt" | "playlists.name" | "-playlists.name")[];
16790
17295
  /**
16791
17296
  * @description Allows the client to customize which related resources should be returned. Available options: playlists
16792
- * @example playlists
17297
+ * @example playlists.items
16793
17298
  */
16794
17299
  include?: string[];
17300
+ /**
17301
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: playlists.items
17302
+ * @example playlists.items
17303
+ */
17304
+ replaceMedia?: string;
16795
17305
  };
16796
17306
  header?: never;
16797
17307
  path: {
@@ -16937,6 +17447,11 @@ export interface paths {
16937
17447
  * @example tracks
16938
17448
  */
16939
17449
  include?: string[];
17450
+ /**
17451
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: tracks
17452
+ * @example tracks
17453
+ */
17454
+ replaceMedia?: string;
16940
17455
  };
16941
17456
  header?: never;
16942
17457
  path: {
@@ -17082,6 +17597,11 @@ export interface paths {
17082
17597
  * @example videos
17083
17598
  */
17084
17599
  include?: string[];
17600
+ /**
17601
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: videos
17602
+ * @example videos
17603
+ */
17604
+ replaceMedia?: string;
17085
17605
  };
17086
17606
  header?: never;
17087
17607
  path: {
@@ -17219,9 +17739,14 @@ export interface paths {
17219
17739
  locale?: string;
17220
17740
  /**
17221
17741
  * @description Allows the client to customize which related resources should be returned. Available options: items
17222
- * @example items
17742
+ * @example items.items
17223
17743
  */
17224
17744
  include?: string[];
17745
+ /**
17746
+ * @description 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
17747
+ * @example items.items
17748
+ */
17749
+ replaceMedia?: string;
17225
17750
  };
17226
17751
  header?: never;
17227
17752
  path: {
@@ -17285,9 +17810,14 @@ export interface paths {
17285
17810
  locale?: string;
17286
17811
  /**
17287
17812
  * @description Allows the client to customize which related resources should be returned. Available options: items
17288
- * @example items
17813
+ * @example items.items
17289
17814
  */
17290
17815
  include?: string[];
17816
+ /**
17817
+ * @description 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
17818
+ * @example items.items
17819
+ */
17820
+ replaceMedia?: string;
17291
17821
  };
17292
17822
  header?: never;
17293
17823
  path: {
@@ -17405,9 +17935,14 @@ export interface paths {
17405
17935
  locale?: string;
17406
17936
  /**
17407
17937
  * @description Allows the client to customize which related resources should be returned. Available options: items
17408
- * @example items
17938
+ * @example items.items
17409
17939
  */
17410
17940
  include?: string[];
17941
+ /**
17942
+ * @description 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
17943
+ * @example items.items
17944
+ */
17945
+ replaceMedia?: string;
17411
17946
  };
17412
17947
  header?: never;
17413
17948
  path: {
@@ -17471,9 +18006,14 @@ export interface paths {
17471
18006
  locale?: string;
17472
18007
  /**
17473
18008
  * @description Allows the client to customize which related resources should be returned. Available options: items
17474
- * @example items
18009
+ * @example items.items
17475
18010
  */
17476
18011
  include?: string[];
18012
+ /**
18013
+ * @description 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
18014
+ * @example items.items
18015
+ */
18016
+ replaceMedia?: string;
17477
18017
  };
17478
18018
  header?: never;
17479
18019
  path: {
@@ -17535,9 +18075,14 @@ export interface paths {
17535
18075
  locale?: string;
17536
18076
  /**
17537
18077
  * @description Allows the client to customize which related resources should be returned. Available options: items
17538
- * @example items
18078
+ * @example items.items
17539
18079
  */
17540
18080
  include?: string[];
18081
+ /**
18082
+ * @description 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
18083
+ * @example items.items
18084
+ */
18085
+ replaceMedia?: string;
17541
18086
  };
17542
18087
  header?: never;
17543
18088
  path: {
@@ -17601,9 +18146,14 @@ export interface paths {
17601
18146
  locale?: string;
17602
18147
  /**
17603
18148
  * @description Allows the client to customize which related resources should be returned. Available options: items
17604
- * @example items
18149
+ * @example items.items
17605
18150
  */
17606
18151
  include?: string[];
18152
+ /**
18153
+ * @description 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
18154
+ * @example items.items
18155
+ */
18156
+ replaceMedia?: string;
17607
18157
  };
17608
18158
  header?: never;
17609
18159
  path: {
@@ -17665,9 +18215,14 @@ export interface paths {
17665
18215
  locale?: string;
17666
18216
  /**
17667
18217
  * @description Allows the client to customize which related resources should be returned. Available options: items
17668
- * @example items
18218
+ * @example items.items
17669
18219
  */
17670
18220
  include?: string[];
18221
+ /**
18222
+ * @description 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
18223
+ * @example items.items
18224
+ */
18225
+ replaceMedia?: string;
17671
18226
  };
17672
18227
  header?: never;
17673
18228
  path: {
@@ -17731,9 +18286,14 @@ export interface paths {
17731
18286
  locale?: string;
17732
18287
  /**
17733
18288
  * @description Allows the client to customize which related resources should be returned. Available options: items
17734
- * @example items
18289
+ * @example items.items
17735
18290
  */
17736
18291
  include?: string[];
18292
+ /**
18293
+ * @description 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
18294
+ * @example items.items
18295
+ */
18296
+ replaceMedia?: string;
17737
18297
  };
17738
18298
  header?: never;
17739
18299
  path: {
@@ -17795,9 +18355,14 @@ export interface paths {
17795
18355
  locale?: string;
17796
18356
  /**
17797
18357
  * @description Allows the client to customize which related resources should be returned. Available options: artists, owners, tracks, videos
17798
- * @example artists
18358
+ * @example artists.albums
17799
18359
  */
17800
18360
  include?: string[];
18361
+ /**
18362
+ * @description 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
18363
+ * @example artists.albums
18364
+ */
18365
+ replaceMedia?: string;
17801
18366
  };
17802
18367
  header?: never;
17803
18368
  path: {
@@ -17856,9 +18421,14 @@ export interface paths {
17856
18421
  "page[cursor]"?: string;
17857
18422
  /**
17858
18423
  * @description Allows the client to customize which related resources should be returned. Available options: artists
17859
- * @example artists
18424
+ * @example artists.albums
17860
18425
  */
17861
18426
  include?: string[];
18427
+ /**
18428
+ * @description 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
18429
+ * @example artists.albums
18430
+ */
18431
+ replaceMedia?: string;
17862
18432
  };
17863
18433
  header?: never;
17864
18434
  path: {
@@ -18064,6 +18634,11 @@ export interface paths {
18064
18634
  * @example tracks
18065
18635
  */
18066
18636
  include?: string[];
18637
+ /**
18638
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: tracks
18639
+ * @example tracks
18640
+ */
18641
+ replaceMedia?: string;
18067
18642
  };
18068
18643
  header?: never;
18069
18644
  path: {
@@ -18208,6 +18783,11 @@ export interface paths {
18208
18783
  * @example videos
18209
18784
  */
18210
18785
  include?: string[];
18786
+ /**
18787
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: videos
18788
+ * @example videos
18789
+ */
18790
+ replaceMedia?: string;
18211
18791
  };
18212
18792
  header?: never;
18213
18793
  path: {
@@ -18353,9 +18933,14 @@ export interface paths {
18353
18933
  locale?: string;
18354
18934
  /**
18355
18935
  * @description Allows the client to customize which related resources should be returned. Available options: discoveryMixes, myMixes, newArrivalMixes, offlineMixes
18356
- * @example discoveryMixes
18936
+ * @example discoveryMixes.items
18357
18937
  */
18358
18938
  include?: string[];
18939
+ /**
18940
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: discoveryMixes.items
18941
+ * @example discoveryMixes.items
18942
+ */
18943
+ replaceMedia?: string;
18359
18944
  };
18360
18945
  header?: never;
18361
18946
  path: {
@@ -18420,9 +19005,14 @@ export interface paths {
18420
19005
  locale?: string;
18421
19006
  /**
18422
19007
  * @description Allows the client to customize which related resources should be returned. Available options: discoveryMixes
18423
- * @example discoveryMixes
19008
+ * @example discoveryMixes.items
18424
19009
  */
18425
19010
  include?: string[];
19011
+ /**
19012
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: discoveryMixes.items
19013
+ * @example discoveryMixes.items
19014
+ */
19015
+ replaceMedia?: string;
18426
19016
  };
18427
19017
  header?: never;
18428
19018
  path: {
@@ -18487,9 +19077,14 @@ export interface paths {
18487
19077
  locale?: string;
18488
19078
  /**
18489
19079
  * @description Allows the client to customize which related resources should be returned. Available options: myMixes
18490
- * @example myMixes
19080
+ * @example myMixes.items
18491
19081
  */
18492
19082
  include?: string[];
19083
+ /**
19084
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: myMixes.items
19085
+ * @example myMixes.items
19086
+ */
19087
+ replaceMedia?: string;
18493
19088
  };
18494
19089
  header?: never;
18495
19090
  path: {
@@ -18554,9 +19149,14 @@ export interface paths {
18554
19149
  locale?: string;
18555
19150
  /**
18556
19151
  * @description Allows the client to customize which related resources should be returned. Available options: newArrivalMixes
18557
- * @example newArrivalMixes
19152
+ * @example newArrivalMixes.items
18558
19153
  */
18559
19154
  include?: string[];
19155
+ /**
19156
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: newArrivalMixes.items
19157
+ * @example newArrivalMixes.items
19158
+ */
19159
+ replaceMedia?: string;
18560
19160
  };
18561
19161
  header?: never;
18562
19162
  path: {
@@ -18621,9 +19221,14 @@ export interface paths {
18621
19221
  locale?: string;
18622
19222
  /**
18623
19223
  * @description Allows the client to customize which related resources should be returned. Available options: offlineMixes
18624
- * @example offlineMixes
19224
+ * @example offlineMixes.items
18625
19225
  */
18626
19226
  include?: string[];
19227
+ /**
19228
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: offlineMixes.items
19229
+ * @example offlineMixes.items
19230
+ */
19231
+ replaceMedia?: string;
18627
19232
  };
18628
19233
  header?: never;
18629
19234
  path: {
@@ -18972,6 +19577,11 @@ export interface paths {
18972
19577
  "filter[id]"?: string[];
18973
19578
  /** @description List of ISRCs (e.g. `QMJMT1701237`) */
18974
19579
  "filter[isrc]"?: string[];
19580
+ /**
19581
+ * @description 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
19582
+ * @example albums
19583
+ */
19584
+ replaceMedia?: string;
18975
19585
  };
18976
19586
  header?: never;
18977
19587
  path?: never;
@@ -19030,6 +19640,11 @@ export interface paths {
19030
19640
  * @example albums
19031
19641
  */
19032
19642
  include?: string[];
19643
+ /**
19644
+ * @description 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
19645
+ * @example albums
19646
+ */
19647
+ replaceMedia?: string;
19033
19648
  };
19034
19649
  header?: never;
19035
19650
  path: {
@@ -19096,6 +19711,11 @@ export interface paths {
19096
19711
  * @example albums
19097
19712
  */
19098
19713
  include?: string[];
19714
+ /**
19715
+ * @description 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
19716
+ * @example albums
19717
+ */
19718
+ replaceMedia?: string;
19099
19719
  };
19100
19720
  header?: never;
19101
19721
  path: {
@@ -19159,9 +19779,14 @@ export interface paths {
19159
19779
  countryCode?: string;
19160
19780
  /**
19161
19781
  * @description Allows the client to customize which related resources should be returned. Available options: artists
19162
- * @example artists
19782
+ * @example artists.albums
19163
19783
  */
19164
19784
  include?: string[];
19785
+ /**
19786
+ * @description 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
19787
+ * @example artists.albums
19788
+ */
19789
+ replaceMedia?: string;
19165
19790
  };
19166
19791
  header?: never;
19167
19792
  path: {
@@ -19220,9 +19845,14 @@ export interface paths {
19220
19845
  "page[cursor]"?: string;
19221
19846
  /**
19222
19847
  * @description Allows the client to customize which related resources should be returned. Available options: credits
19223
- * @example credits
19848
+ * @example credits.artist.albums
19224
19849
  */
19225
19850
  include?: string[];
19851
+ /**
19852
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: credits.artist.albums
19853
+ * @example credits.artist.albums
19854
+ */
19855
+ replaceMedia?: string;
19226
19856
  };
19227
19857
  header?: never;
19228
19858
  path: {
@@ -19353,6 +19983,11 @@ export interface paths {
19353
19983
  * @example replacement
19354
19984
  */
19355
19985
  include?: string[];
19986
+ /**
19987
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: replacement
19988
+ * @example replacement
19989
+ */
19990
+ replaceMedia?: string;
19356
19991
  };
19357
19992
  header?: never;
19358
19993
  path: {
@@ -19419,6 +20054,11 @@ export interface paths {
19419
20054
  * @example similarVideos
19420
20055
  */
19421
20056
  include?: string[];
20057
+ /**
20058
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: similarVideos
20059
+ * @example similarVideos
20060
+ */
20061
+ replaceMedia?: string;
19422
20062
  };
19423
20063
  header?: never;
19424
20064
  path: {
@@ -19485,6 +20125,11 @@ export interface paths {
19485
20125
  * @example suggestedVideos
19486
20126
  */
19487
20127
  include?: string[];
20128
+ /**
20129
+ * @description Applies context-dependent replacements to media resource identifiers in selected relationships without changing stored data. Paths are comma-separated and follow `include` syntax. Example: suggestedVideos
20130
+ * @example suggestedVideos
20131
+ */
20132
+ replaceMedia?: string;
19488
20133
  };
19489
20134
  header?: never;
19490
20135
  path: {
@@ -19991,6 +20636,7 @@ export interface components {
19991
20636
  };
19992
20637
  Albums_Items_Resource_Identifier_Meta: {
19993
20638
  itemCursor?: string;
20639
+ replacement?: components["schemas"]["Replacement_Provenance"];
19994
20640
  /**
19995
20641
  * Format: int32
19996
20642
  * @description track number
@@ -20023,12 +20669,33 @@ export interface components {
20023
20669
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
20024
20670
  priceConfig?: components["schemas"]["Single_Relationship_Data_Document"];
20025
20671
  providers?: components["schemas"]["Multi_Relationship_Data_Document"];
20026
- replacement?: components["schemas"]["Single_Relationship_Data_Document"];
20672
+ replacement?: components["schemas"]["Albums_Replacement_Single_Relationship_Data_Document"];
20027
20673
  shares?: components["schemas"]["Multi_Relationship_Data_Document"];
20028
- similarAlbums?: components["schemas"]["Multi_Relationship_Data_Document"];
20674
+ similarAlbums?: components["schemas"]["Albums_SimilarAlbums_Multi_Relationship_Data_Document"];
20029
20675
  suggestedCoverArts?: components["schemas"]["Albums_SuggestedCoverArts_Multi_Relationship_Data_Document"];
20030
20676
  usageRules?: components["schemas"]["Single_Relationship_Data_Document"];
20031
20677
  };
20678
+ Albums_Replacement_Resource_Identifier: {
20679
+ /**
20680
+ * @description Resource id
20681
+ * @example 12345
20682
+ */
20683
+ id: string;
20684
+ meta?: components["schemas"]["Albums_Replacement_Resource_Identifier_Meta"];
20685
+ /**
20686
+ * @description Resource type
20687
+ * @example tracks
20688
+ */
20689
+ type: string;
20690
+ };
20691
+ Albums_Replacement_Resource_Identifier_Meta: {
20692
+ replacement?: components["schemas"]["Replacement_Provenance"];
20693
+ };
20694
+ Albums_Replacement_Single_Relationship_Data_Document: {
20695
+ data?: components["schemas"]["Albums_Replacement_Resource_Identifier"] | (never | null);
20696
+ included?: components["schemas"]["Included"];
20697
+ links: components["schemas"]["Links"];
20698
+ };
20032
20699
  Albums_Resource_Object: {
20033
20700
  attributes?: components["schemas"]["Albums_Attributes"];
20034
20701
  /**
@@ -20043,6 +20710,27 @@ export interface components {
20043
20710
  */
20044
20711
  type: "albums";
20045
20712
  };
20713
+ Albums_SimilarAlbums_Multi_Relationship_Data_Document: {
20714
+ data?: components["schemas"]["Albums_SimilarAlbums_Resource_Identifier"][];
20715
+ included?: components["schemas"]["Included"];
20716
+ links: components["schemas"]["Links"];
20717
+ };
20718
+ Albums_SimilarAlbums_Resource_Identifier: {
20719
+ /**
20720
+ * @description Resource id
20721
+ * @example 12345
20722
+ */
20723
+ id: string;
20724
+ meta?: components["schemas"]["Albums_SimilarAlbums_Resource_Identifier_Meta"];
20725
+ /**
20726
+ * @description Resource type
20727
+ * @example tracks
20728
+ */
20729
+ type: string;
20730
+ };
20731
+ Albums_SimilarAlbums_Resource_Identifier_Meta: {
20732
+ replacement?: components["schemas"]["Replacement_Provenance"];
20733
+ };
20046
20734
  Albums_Single_Relationship_Data_Document: {
20047
20735
  data?: components["schemas"]["Resource_Identifier"] | (never | null);
20048
20736
  included?: components["schemas"]["Included"];
@@ -20415,6 +21103,27 @@ export interface components {
20415
21103
  ArtistsUpdateOperation_Payload_Meta: {
20416
21104
  dryRun?: boolean;
20417
21105
  };
21106
+ Artists_Albums_Multi_Relationship_Data_Document: {
21107
+ data?: components["schemas"]["Artists_Albums_Resource_Identifier"][];
21108
+ included?: components["schemas"]["Included"];
21109
+ links: components["schemas"]["Links"];
21110
+ };
21111
+ Artists_Albums_Resource_Identifier: {
21112
+ /**
21113
+ * @description Resource id
21114
+ * @example 12345
21115
+ */
21116
+ id: string;
21117
+ meta?: components["schemas"]["Artists_Albums_Resource_Identifier_Meta"];
21118
+ /**
21119
+ * @description Resource type
21120
+ * @example tracks
21121
+ */
21122
+ type: string;
21123
+ };
21124
+ Artists_Albums_Resource_Identifier_Meta: {
21125
+ replacement?: components["schemas"]["Replacement_Provenance"];
21126
+ };
20418
21127
  Artists_Attributes: {
20419
21128
  /**
20420
21129
  * @description Is the artist enabled for contributions?
@@ -20521,7 +21230,7 @@ export interface components {
20521
21230
  links: components["schemas"]["Links"];
20522
21231
  };
20523
21232
  Artists_Relationships: {
20524
- albums?: components["schemas"]["Multi_Relationship_Data_Document"];
21233
+ albums?: components["schemas"]["Artists_Albums_Multi_Relationship_Data_Document"];
20525
21234
  biography?: components["schemas"]["Single_Relationship_Data_Document"];
20526
21235
  claimStatus?: components["schemas"]["Single_Relationship_Data_Document"];
20527
21236
  followers?: components["schemas"]["Artists_Followers_Multi_Relationship_Data_Document"];
@@ -20532,8 +21241,8 @@ export interface components {
20532
21241
  roles?: components["schemas"]["Multi_Relationship_Data_Document"];
20533
21242
  similarArtists?: components["schemas"]["Multi_Relationship_Data_Document"];
20534
21243
  trackProviders?: components["schemas"]["Artists_TrackProviders_Multi_Relationship_Data_Document"];
20535
- tracks?: components["schemas"]["Multi_Relationship_Data_Document"];
20536
- videos?: components["schemas"]["Multi_Relationship_Data_Document"];
21244
+ tracks?: components["schemas"]["Artists_Tracks_Multi_Relationship_Data_Document"];
21245
+ videos?: components["schemas"]["Artists_Videos_Multi_Relationship_Data_Document"];
20537
21246
  };
20538
21247
  Artists_Resource_Object: {
20539
21248
  attributes?: components["schemas"]["Artists_Attributes"];
@@ -20585,6 +21294,48 @@ export interface components {
20585
21294
  */
20586
21295
  numberOfTracks: number;
20587
21296
  };
21297
+ Artists_Tracks_Multi_Relationship_Data_Document: {
21298
+ data?: components["schemas"]["Artists_Tracks_Resource_Identifier"][];
21299
+ included?: components["schemas"]["Included"];
21300
+ links: components["schemas"]["Links"];
21301
+ };
21302
+ Artists_Tracks_Resource_Identifier: {
21303
+ /**
21304
+ * @description Resource id
21305
+ * @example 12345
21306
+ */
21307
+ id: string;
21308
+ meta?: components["schemas"]["Artists_Tracks_Resource_Identifier_Meta"];
21309
+ /**
21310
+ * @description Resource type
21311
+ * @example tracks
21312
+ */
21313
+ type: string;
21314
+ };
21315
+ Artists_Tracks_Resource_Identifier_Meta: {
21316
+ replacement?: components["schemas"]["Replacement_Provenance"];
21317
+ };
21318
+ Artists_Videos_Multi_Relationship_Data_Document: {
21319
+ data?: components["schemas"]["Artists_Videos_Resource_Identifier"][];
21320
+ included?: components["schemas"]["Included"];
21321
+ links: components["schemas"]["Links"];
21322
+ };
21323
+ Artists_Videos_Resource_Identifier: {
21324
+ /**
21325
+ * @description Resource id
21326
+ * @example 12345
21327
+ */
21328
+ id: string;
21329
+ meta?: components["schemas"]["Artists_Videos_Resource_Identifier_Meta"];
21330
+ /**
21331
+ * @description Resource type
21332
+ * @example tracks
21333
+ */
21334
+ type: string;
21335
+ };
21336
+ Artists_Videos_Resource_Identifier_Meta: {
21337
+ replacement?: components["schemas"]["Replacement_Provenance"];
21338
+ };
20588
21339
  /** @description Artwork files */
20589
21340
  Artwork_File: {
20590
21341
  /** @description Artwork file href */
@@ -21073,6 +21824,27 @@ export interface components {
21073
21824
  */
21074
21825
  status: "OPEN" | "IN_PROGRESS" | "RESOLVED" | "REJECTED";
21075
21826
  };
21827
+ ContentClaims_ClaimedResource_Resource_Identifier: {
21828
+ /**
21829
+ * @description Resource id
21830
+ * @example 12345
21831
+ */
21832
+ id: string;
21833
+ meta?: components["schemas"]["ContentClaims_ClaimedResource_Resource_Identifier_Meta"];
21834
+ /**
21835
+ * @description Resource type
21836
+ * @example tracks
21837
+ */
21838
+ type: string;
21839
+ };
21840
+ ContentClaims_ClaimedResource_Resource_Identifier_Meta: {
21841
+ replacement?: components["schemas"]["Replacement_Provenance"];
21842
+ };
21843
+ ContentClaims_ClaimedResource_Single_Relationship_Data_Document: {
21844
+ data?: components["schemas"]["ContentClaims_ClaimedResource_Resource_Identifier"] | (never | null);
21845
+ included?: components["schemas"]["Included"];
21846
+ links: components["schemas"]["Links"];
21847
+ };
21076
21848
  ContentClaims_Multi_Relationship_Data_Document: {
21077
21849
  data?: components["schemas"]["Resource_Identifier"][];
21078
21850
  included?: components["schemas"]["Included"];
@@ -21084,7 +21856,7 @@ export interface components {
21084
21856
  links: components["schemas"]["Links"];
21085
21857
  };
21086
21858
  ContentClaims_Relationships: {
21087
- claimedResource?: components["schemas"]["Single_Relationship_Data_Document"];
21859
+ claimedResource?: components["schemas"]["ContentClaims_ClaimedResource_Single_Relationship_Data_Document"];
21088
21860
  claimingArtist?: components["schemas"]["Single_Relationship_Data_Document"];
21089
21861
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
21090
21862
  };
@@ -21302,7 +22074,7 @@ export interface components {
21302
22074
  links: components["schemas"]["Links"];
21303
22075
  };
21304
22076
  DspSharingLinks_Relationships: {
21305
- subject?: components["schemas"]["Single_Relationship_Data_Document"];
22077
+ subject?: components["schemas"]["DspSharingLinks_Subject_Single_Relationship_Data_Document"];
21306
22078
  };
21307
22079
  DspSharingLinks_Resource_Object: {
21308
22080
  attributes?: components["schemas"]["DspSharingLinks_Attributes"];
@@ -21328,6 +22100,27 @@ export interface components {
21328
22100
  included?: components["schemas"]["Included"];
21329
22101
  links: components["schemas"]["Links"];
21330
22102
  };
22103
+ DspSharingLinks_Subject_Resource_Identifier: {
22104
+ /**
22105
+ * @description Resource id
22106
+ * @example 12345
22107
+ */
22108
+ id: string;
22109
+ meta?: components["schemas"]["DspSharingLinks_Subject_Resource_Identifier_Meta"];
22110
+ /**
22111
+ * @description Resource type
22112
+ * @example tracks
22113
+ */
22114
+ type: string;
22115
+ };
22116
+ DspSharingLinks_Subject_Resource_Identifier_Meta: {
22117
+ replacement?: components["schemas"]["Replacement_Provenance"];
22118
+ };
22119
+ DspSharingLinks_Subject_Single_Relationship_Data_Document: {
22120
+ data?: components["schemas"]["DspSharingLinks_Subject_Resource_Identifier"] | (never | null);
22121
+ included?: components["schemas"]["Included"];
22122
+ links: components["schemas"]["Links"];
22123
+ };
21331
22124
  DynamicModules_Attributes: {
21332
22125
  /**
21333
22126
  * @description Semantic icons the module should show. SPOTLIGHT_INFO identifies modules whose content was selected by TIDAL's editorial team.
@@ -21357,6 +22150,27 @@ export interface components {
21357
22150
  */
21358
22151
  viewAllLayout?: "GRID" | "LIST" | "COMPACT" | "UNKNOWN";
21359
22152
  };
22153
+ DynamicModules_Items_Multi_Relationship_Data_Document: {
22154
+ data?: components["schemas"]["DynamicModules_Items_Resource_Identifier"][];
22155
+ included?: components["schemas"]["Included"];
22156
+ links: components["schemas"]["Links"];
22157
+ };
22158
+ DynamicModules_Items_Resource_Identifier: {
22159
+ /**
22160
+ * @description Resource id
22161
+ * @example 12345
22162
+ */
22163
+ id: string;
22164
+ meta?: components["schemas"]["DynamicModules_Items_Resource_Identifier_Meta"];
22165
+ /**
22166
+ * @description Resource type
22167
+ * @example tracks
22168
+ */
22169
+ type: string;
22170
+ };
22171
+ DynamicModules_Items_Resource_Identifier_Meta: {
22172
+ replacement?: components["schemas"]["Replacement_Provenance"];
22173
+ };
21360
22174
  DynamicModules_Multi_Relationship_Data_Document: {
21361
22175
  data?: components["schemas"]["Resource_Identifier"][];
21362
22176
  included?: components["schemas"]["Included"];
@@ -21368,8 +22182,8 @@ export interface components {
21368
22182
  links: components["schemas"]["Links"];
21369
22183
  };
21370
22184
  DynamicModules_Relationships: {
21371
- items?: components["schemas"]["Multi_Relationship_Data_Document"];
21372
- seedItem?: components["schemas"]["Single_Relationship_Data_Document"];
22185
+ items?: components["schemas"]["DynamicModules_Items_Multi_Relationship_Data_Document"];
22186
+ seedItem?: components["schemas"]["DynamicModules_SeedItem_Single_Relationship_Data_Document"];
21373
22187
  };
21374
22188
  DynamicModules_Resource_Object: {
21375
22189
  attributes?: components["schemas"]["DynamicModules_Attributes"];
@@ -21385,19 +22199,40 @@ export interface components {
21385
22199
  */
21386
22200
  type: "dynamicModules";
21387
22201
  };
21388
- DynamicModules_Single_Relationship_Data_Document: {
21389
- data?: components["schemas"]["Resource_Identifier"] | (never | null);
21390
- included?: components["schemas"]["Included"];
21391
- links: components["schemas"]["Links"];
21392
- };
21393
- DynamicModules_Single_Resource_Data_Document: {
21394
- data: components["schemas"]["DynamicModules_Resource_Object"];
21395
- included?: components["schemas"]["Included"];
21396
- links: components["schemas"]["Links"];
21397
- };
21398
- DynamicPages_Attributes: {
22202
+ DynamicModules_SeedItem_Resource_Identifier: {
21399
22203
  /**
21400
- * @description Type of the page eg. home, artist
22204
+ * @description Resource id
22205
+ * @example 12345
22206
+ */
22207
+ id: string;
22208
+ meta?: components["schemas"]["DynamicModules_SeedItem_Resource_Identifier_Meta"];
22209
+ /**
22210
+ * @description Resource type
22211
+ * @example tracks
22212
+ */
22213
+ type: string;
22214
+ };
22215
+ DynamicModules_SeedItem_Resource_Identifier_Meta: {
22216
+ replacement?: components["schemas"]["Replacement_Provenance"];
22217
+ };
22218
+ DynamicModules_SeedItem_Single_Relationship_Data_Document: {
22219
+ data?: components["schemas"]["DynamicModules_SeedItem_Resource_Identifier"] | (never | null);
22220
+ included?: components["schemas"]["Included"];
22221
+ links: components["schemas"]["Links"];
22222
+ };
22223
+ DynamicModules_Single_Relationship_Data_Document: {
22224
+ data?: components["schemas"]["Resource_Identifier"] | (never | null);
22225
+ included?: components["schemas"]["Included"];
22226
+ links: components["schemas"]["Links"];
22227
+ };
22228
+ DynamicModules_Single_Resource_Data_Document: {
22229
+ data: components["schemas"]["DynamicModules_Resource_Object"];
22230
+ included?: components["schemas"]["Included"];
22231
+ links: components["schemas"]["Links"];
22232
+ };
22233
+ DynamicPages_Attributes: {
22234
+ /**
22235
+ * @description Type of the page eg. home, artist
21401
22236
  * @example HOME_STATIC
21402
22237
  * @enum {string}
21403
22238
  */
@@ -21421,7 +22256,7 @@ export interface components {
21421
22256
  };
21422
22257
  DynamicPages_Relationships: {
21423
22258
  modules?: components["schemas"]["Multi_Relationship_Data_Document"];
21424
- subject?: components["schemas"]["Single_Relationship_Data_Document"];
22259
+ subject?: components["schemas"]["DynamicPages_Subject_Single_Relationship_Data_Document"];
21425
22260
  };
21426
22261
  DynamicPages_Resource_Object: {
21427
22262
  attributes?: components["schemas"]["DynamicPages_Attributes"];
@@ -21455,6 +22290,27 @@ export interface components {
21455
22290
  included?: components["schemas"]["Included"];
21456
22291
  links: components["schemas"]["Links"];
21457
22292
  };
22293
+ DynamicPages_Subject_Resource_Identifier: {
22294
+ /**
22295
+ * @description Resource id
22296
+ * @example 12345
22297
+ */
22298
+ id: string;
22299
+ meta?: components["schemas"]["DynamicPages_Subject_Resource_Identifier_Meta"];
22300
+ /**
22301
+ * @description Resource type
22302
+ * @example tracks
22303
+ */
22304
+ type: string;
22305
+ };
22306
+ DynamicPages_Subject_Resource_Identifier_Meta: {
22307
+ replacement?: components["schemas"]["Replacement_Provenance"];
22308
+ };
22309
+ DynamicPages_Subject_Single_Relationship_Data_Document: {
22310
+ data?: components["schemas"]["DynamicPages_Subject_Resource_Identifier"] | (never | null);
22311
+ included?: components["schemas"]["Included"];
22312
+ links: components["schemas"]["Links"];
22313
+ };
21458
22314
  Error_Object: {
21459
22315
  /** @description application-specific error code */
21460
22316
  code?: string;
@@ -21666,6 +22522,7 @@ export interface components {
21666
22522
  Installations_OfflineInventory_Resource_Identifier_Meta: {
21667
22523
  /** Format: date-time */
21668
22524
  addedAt: string;
22525
+ replacement?: components["schemas"]["Replacement_Provenance"];
21669
22526
  };
21670
22527
  Installations_Relationships: {
21671
22528
  offlineInventory?: components["schemas"]["Installations_OfflineInventory_Multi_Relationship_Data_Document"];
@@ -21796,7 +22653,7 @@ export interface components {
21796
22653
  };
21797
22654
  Lyrics_Relationships: {
21798
22655
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
21799
- track?: components["schemas"]["Single_Relationship_Data_Document"];
22656
+ track?: components["schemas"]["Lyrics_Track_Single_Relationship_Data_Document"];
21800
22657
  };
21801
22658
  Lyrics_Resource_Object: {
21802
22659
  attributes?: components["schemas"]["Lyrics_Attributes"];
@@ -21822,6 +22679,27 @@ export interface components {
21822
22679
  included?: components["schemas"]["Included"];
21823
22680
  links: components["schemas"]["Links"];
21824
22681
  };
22682
+ Lyrics_Track_Resource_Identifier: {
22683
+ /**
22684
+ * @description Resource id
22685
+ * @example 12345
22686
+ */
22687
+ id: string;
22688
+ meta?: components["schemas"]["Lyrics_Track_Resource_Identifier_Meta"];
22689
+ /**
22690
+ * @description Resource type
22691
+ * @example tracks
22692
+ */
22693
+ type: string;
22694
+ };
22695
+ Lyrics_Track_Resource_Identifier_Meta: {
22696
+ replacement?: components["schemas"]["Replacement_Provenance"];
22697
+ };
22698
+ Lyrics_Track_Single_Relationship_Data_Document: {
22699
+ data?: components["schemas"]["Lyrics_Track_Resource_Identifier"] | (never | null);
22700
+ included?: components["schemas"]["Included"];
22701
+ links: components["schemas"]["Links"];
22702
+ };
21825
22703
  ManualArtistClaimsCreateOperation_Payload: {
21826
22704
  data: components["schemas"]["ManualArtistClaimsCreateOperation_Payload_Data"];
21827
22705
  };
@@ -21965,6 +22843,48 @@ export interface components {
21965
22843
  */
21966
22844
  volume: number;
21967
22845
  };
22846
+ OfflineTasks_Collection_Resource_Identifier: {
22847
+ /**
22848
+ * @description Resource id
22849
+ * @example 12345
22850
+ */
22851
+ id: string;
22852
+ meta?: components["schemas"]["OfflineTasks_Collection_Resource_Identifier_Meta"];
22853
+ /**
22854
+ * @description Resource type
22855
+ * @example tracks
22856
+ */
22857
+ type: string;
22858
+ };
22859
+ OfflineTasks_Collection_Resource_Identifier_Meta: {
22860
+ replacement?: components["schemas"]["Replacement_Provenance"];
22861
+ };
22862
+ OfflineTasks_Collection_Single_Relationship_Data_Document: {
22863
+ data?: components["schemas"]["OfflineTasks_Collection_Resource_Identifier"] | (never | null);
22864
+ included?: components["schemas"]["Included"];
22865
+ links: components["schemas"]["Links"];
22866
+ };
22867
+ OfflineTasks_Item_Resource_Identifier: {
22868
+ /**
22869
+ * @description Resource id
22870
+ * @example 12345
22871
+ */
22872
+ id: string;
22873
+ meta?: components["schemas"]["OfflineTasks_Item_Resource_Identifier_Meta"];
22874
+ /**
22875
+ * @description Resource type
22876
+ * @example tracks
22877
+ */
22878
+ type: string;
22879
+ };
22880
+ OfflineTasks_Item_Resource_Identifier_Meta: {
22881
+ replacement?: components["schemas"]["Replacement_Provenance"];
22882
+ };
22883
+ OfflineTasks_Item_Single_Relationship_Data_Document: {
22884
+ data?: components["schemas"]["OfflineTasks_Item_Resource_Identifier"] | (never | null);
22885
+ included?: components["schemas"]["Included"];
22886
+ links: components["schemas"]["Links"];
22887
+ };
21968
22888
  OfflineTasks_Multi_Relationship_Data_Document: {
21969
22889
  data?: components["schemas"]["Resource_Identifier"][];
21970
22890
  included?: components["schemas"]["Included"];
@@ -21976,8 +22896,8 @@ export interface components {
21976
22896
  links: components["schemas"]["Links"];
21977
22897
  };
21978
22898
  OfflineTasks_Relationships: {
21979
- collection?: components["schemas"]["Single_Relationship_Data_Document"];
21980
- item?: components["schemas"]["Single_Relationship_Data_Document"];
22899
+ collection?: components["schemas"]["OfflineTasks_Collection_Single_Relationship_Data_Document"];
22900
+ item?: components["schemas"]["OfflineTasks_Item_Single_Relationship_Data_Document"];
21981
22901
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
21982
22902
  };
21983
22903
  OfflineTasks_Resource_Object: {
@@ -22130,6 +23050,7 @@ export interface components {
22130
23050
  batchId: string;
22131
23051
  itemId: string;
22132
23052
  legacySource?: components["schemas"]["LegacySource"];
23053
+ replacement?: components["schemas"]["Replacement_Provenance"];
22133
23054
  };
22134
23055
  PlayQueues_Current_Single_Relationship_Data_Document: {
22135
23056
  data?: components["schemas"]["PlayQueues_Current_Resource_Identifier"] | (never | null);
@@ -22159,6 +23080,7 @@ export interface components {
22159
23080
  batchId: string;
22160
23081
  itemId: string;
22161
23082
  legacySource?: components["schemas"]["LegacySource"];
23083
+ replacement?: components["schemas"]["Replacement_Provenance"];
22162
23084
  };
22163
23085
  PlayQueues_Multi_Relationship_Data_Document: {
22164
23086
  data?: components["schemas"]["Resource_Identifier"][];
@@ -22193,6 +23115,7 @@ export interface components {
22193
23115
  batchId: string;
22194
23116
  itemId: string;
22195
23117
  legacySource?: components["schemas"]["LegacySource"];
23118
+ replacement?: components["schemas"]["Replacement_Provenance"];
22196
23119
  };
22197
23120
  PlayQueues_Relationships: {
22198
23121
  current?: components["schemas"]["PlayQueues_Current_Single_Relationship_Data_Document"];
@@ -22400,6 +23323,7 @@ export interface components {
22400
23323
  addedAt?: string;
22401
23324
  itemCursor?: string;
22402
23325
  itemId?: string;
23326
+ replacement?: components["schemas"]["Replacement_Provenance"];
22403
23327
  };
22404
23328
  Playlists_Multi_Relationship_Data_Document: {
22405
23329
  data?: components["schemas"]["Resource_Identifier"][];
@@ -22587,7 +23511,7 @@ export interface components {
22587
23511
  };
22588
23512
  ProviderProductInfos_Relationships: {
22589
23513
  provider?: components["schemas"]["Single_Relationship_Data_Document"];
22590
- subject?: components["schemas"]["Single_Relationship_Data_Document"];
23514
+ subject?: components["schemas"]["ProviderProductInfos_Subject_Single_Relationship_Data_Document"];
22591
23515
  };
22592
23516
  ProviderProductInfos_Resource_Object: {
22593
23517
  attributes?: components["schemas"]["ProviderProductInfos_Attributes"];
@@ -22613,6 +23537,27 @@ export interface components {
22613
23537
  included?: components["schemas"]["Included"];
22614
23538
  links: components["schemas"]["Links"];
22615
23539
  };
23540
+ ProviderProductInfos_Subject_Resource_Identifier: {
23541
+ /**
23542
+ * @description Resource id
23543
+ * @example 12345
23544
+ */
23545
+ id: string;
23546
+ meta?: components["schemas"]["ProviderProductInfos_Subject_Resource_Identifier_Meta"];
23547
+ /**
23548
+ * @description Resource type
23549
+ * @example tracks
23550
+ */
23551
+ type: string;
23552
+ };
23553
+ ProviderProductInfos_Subject_Resource_Identifier_Meta: {
23554
+ replacement?: components["schemas"]["Replacement_Provenance"];
23555
+ };
23556
+ ProviderProductInfos_Subject_Single_Relationship_Data_Document: {
23557
+ data?: components["schemas"]["ProviderProductInfos_Subject_Resource_Identifier"] | (never | null);
23558
+ included?: components["schemas"]["Included"];
23559
+ links: components["schemas"]["Links"];
23560
+ };
22616
23561
  Providers_Attributes: {
22617
23562
  /**
22618
23563
  * @description Provider name
@@ -22667,7 +23612,7 @@ export interface components {
22667
23612
  };
22668
23613
  Purchases_Relationships: {
22669
23614
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
22670
- subject?: components["schemas"]["Single_Relationship_Data_Document"];
23615
+ subject?: components["schemas"]["Purchases_Subject_Single_Relationship_Data_Document"];
22671
23616
  };
22672
23617
  Purchases_Resource_Object: {
22673
23618
  attributes?: components["schemas"]["Purchases_Attributes"];
@@ -22693,6 +23638,27 @@ export interface components {
22693
23638
  included?: components["schemas"]["Included"];
22694
23639
  links: components["schemas"]["Links"];
22695
23640
  };
23641
+ Purchases_Subject_Resource_Identifier: {
23642
+ /**
23643
+ * @description Resource id
23644
+ * @example 12345
23645
+ */
23646
+ id: string;
23647
+ meta?: components["schemas"]["Purchases_Subject_Resource_Identifier_Meta"];
23648
+ /**
23649
+ * @description Resource type
23650
+ * @example tracks
23651
+ */
23652
+ type: string;
23653
+ };
23654
+ Purchases_Subject_Resource_Identifier_Meta: {
23655
+ replacement?: components["schemas"]["Replacement_Provenance"];
23656
+ };
23657
+ Purchases_Subject_Single_Relationship_Data_Document: {
23658
+ data?: components["schemas"]["Purchases_Subject_Resource_Identifier"] | (never | null);
23659
+ included?: components["schemas"]["Included"];
23660
+ links: components["schemas"]["Links"];
23661
+ };
22696
23662
  /** @description Reaction statistics */
22697
23663
  ReactionStats: {
22698
23664
  /** @description Count of reactions by type */
@@ -22777,6 +23743,19 @@ export interface components {
22777
23743
  included?: components["schemas"]["Included"];
22778
23744
  links: components["schemas"]["Links"];
22779
23745
  };
23746
+ /** @description Relationship identifier before contextual replacement projection. */
23747
+ Replacement_Original_Identifier: {
23748
+ /** @example 12345 */
23749
+ id: string;
23750
+ /** @example tracks */
23751
+ type: string;
23752
+ };
23753
+ /** @description Relationship replacement projection provenance. ORIGINAL retains the requested identifier as the applicable resource, REPLACED projects another identifier, and NOT_REPLACED retains the requested identifier because no applicable replacement exists. */
23754
+ Replacement_Provenance: {
23755
+ original?: components["schemas"]["Replacement_Original_Identifier"];
23756
+ /** @enum {string} */
23757
+ status: "ORIGINAL" | "REPLACED" | "NOT_REPLACED";
23758
+ };
22780
23759
  Resource_Identifier: {
22781
23760
  /**
22782
23761
  * @description Resource id
@@ -22925,6 +23904,48 @@ export interface components {
22925
23904
  included?: components["schemas"]["Included"];
22926
23905
  links: components["schemas"]["Links"];
22927
23906
  };
23907
+ SearchResults_Albums_Multi_Relationship_Data_Document: {
23908
+ data?: components["schemas"]["SearchResults_Albums_Resource_Identifier"][];
23909
+ included?: components["schemas"]["Included"];
23910
+ links: components["schemas"]["Links"];
23911
+ };
23912
+ SearchResults_Albums_Resource_Identifier: {
23913
+ /**
23914
+ * @description Resource id
23915
+ * @example 12345
23916
+ */
23917
+ id: string;
23918
+ meta?: components["schemas"]["SearchResults_Albums_Resource_Identifier_Meta"];
23919
+ /**
23920
+ * @description Resource type
23921
+ * @example tracks
23922
+ */
23923
+ type: string;
23924
+ };
23925
+ SearchResults_Albums_Resource_Identifier_Meta: {
23926
+ replacement?: components["schemas"]["Replacement_Provenance"];
23927
+ };
23928
+ SearchResults_Artists_Multi_Relationship_Data_Document: {
23929
+ data?: components["schemas"]["SearchResults_Artists_Resource_Identifier"][];
23930
+ included?: components["schemas"]["Included"];
23931
+ links: components["schemas"]["Links"];
23932
+ };
23933
+ SearchResults_Artists_Resource_Identifier: {
23934
+ /**
23935
+ * @description Resource id
23936
+ * @example 12345
23937
+ */
23938
+ id: string;
23939
+ meta?: components["schemas"]["SearchResults_Artists_Resource_Identifier_Meta"];
23940
+ /**
23941
+ * @description Resource type
23942
+ * @example tracks
23943
+ */
23944
+ type: string;
23945
+ };
23946
+ SearchResults_Artists_Resource_Identifier_Meta: {
23947
+ replacement?: components["schemas"]["Replacement_Provenance"];
23948
+ };
22928
23949
  SearchResults_Attributes: {
22929
23950
  /**
22930
23951
  * @description 'did you mean' prompt
@@ -22947,13 +23968,34 @@ export interface components {
22947
23968
  included?: components["schemas"]["Included"];
22948
23969
  links: components["schemas"]["Links"];
22949
23970
  };
23971
+ SearchResults_Playlists_Multi_Relationship_Data_Document: {
23972
+ data?: components["schemas"]["SearchResults_Playlists_Resource_Identifier"][];
23973
+ included?: components["schemas"]["Included"];
23974
+ links: components["schemas"]["Links"];
23975
+ };
23976
+ SearchResults_Playlists_Resource_Identifier: {
23977
+ /**
23978
+ * @description Resource id
23979
+ * @example 12345
23980
+ */
23981
+ id: string;
23982
+ meta?: components["schemas"]["SearchResults_Playlists_Resource_Identifier_Meta"];
23983
+ /**
23984
+ * @description Resource type
23985
+ * @example tracks
23986
+ */
23987
+ type: string;
23988
+ };
23989
+ SearchResults_Playlists_Resource_Identifier_Meta: {
23990
+ replacement?: components["schemas"]["Replacement_Provenance"];
23991
+ };
22950
23992
  SearchResults_Relationships: {
22951
- albums?: components["schemas"]["Multi_Relationship_Data_Document"];
22952
- artists?: components["schemas"]["Multi_Relationship_Data_Document"];
22953
- playlists?: components["schemas"]["Multi_Relationship_Data_Document"];
22954
- topHits?: components["schemas"]["Multi_Relationship_Data_Document"];
22955
- tracks?: components["schemas"]["Multi_Relationship_Data_Document"];
22956
- videos?: components["schemas"]["Multi_Relationship_Data_Document"];
23993
+ albums?: components["schemas"]["SearchResults_Albums_Multi_Relationship_Data_Document"];
23994
+ artists?: components["schemas"]["SearchResults_Artists_Multi_Relationship_Data_Document"];
23995
+ playlists?: components["schemas"]["SearchResults_Playlists_Multi_Relationship_Data_Document"];
23996
+ topHits?: components["schemas"]["SearchResults_TopHits_Multi_Relationship_Data_Document"];
23997
+ tracks?: components["schemas"]["SearchResults_Tracks_Multi_Relationship_Data_Document"];
23998
+ videos?: components["schemas"]["SearchResults_Videos_Multi_Relationship_Data_Document"];
22957
23999
  };
22958
24000
  SearchResults_Resource_Object: {
22959
24001
  attributes?: components["schemas"]["SearchResults_Attributes"];
@@ -22974,6 +24016,69 @@ export interface components {
22974
24016
  included?: components["schemas"]["Included"];
22975
24017
  links: components["schemas"]["Links"];
22976
24018
  };
24019
+ SearchResults_TopHits_Multi_Relationship_Data_Document: {
24020
+ data?: components["schemas"]["SearchResults_TopHits_Resource_Identifier"][];
24021
+ included?: components["schemas"]["Included"];
24022
+ links: components["schemas"]["Links"];
24023
+ };
24024
+ SearchResults_TopHits_Resource_Identifier: {
24025
+ /**
24026
+ * @description Resource id
24027
+ * @example 12345
24028
+ */
24029
+ id: string;
24030
+ meta?: components["schemas"]["SearchResults_TopHits_Resource_Identifier_Meta"];
24031
+ /**
24032
+ * @description Resource type
24033
+ * @example tracks
24034
+ */
24035
+ type: string;
24036
+ };
24037
+ SearchResults_TopHits_Resource_Identifier_Meta: {
24038
+ replacement?: components["schemas"]["Replacement_Provenance"];
24039
+ };
24040
+ SearchResults_Tracks_Multi_Relationship_Data_Document: {
24041
+ data?: components["schemas"]["SearchResults_Tracks_Resource_Identifier"][];
24042
+ included?: components["schemas"]["Included"];
24043
+ links: components["schemas"]["Links"];
24044
+ };
24045
+ SearchResults_Tracks_Resource_Identifier: {
24046
+ /**
24047
+ * @description Resource id
24048
+ * @example 12345
24049
+ */
24050
+ id: string;
24051
+ meta?: components["schemas"]["SearchResults_Tracks_Resource_Identifier_Meta"];
24052
+ /**
24053
+ * @description Resource type
24054
+ * @example tracks
24055
+ */
24056
+ type: string;
24057
+ };
24058
+ SearchResults_Tracks_Resource_Identifier_Meta: {
24059
+ replacement?: components["schemas"]["Replacement_Provenance"];
24060
+ };
24061
+ SearchResults_Videos_Multi_Relationship_Data_Document: {
24062
+ data?: components["schemas"]["SearchResults_Videos_Resource_Identifier"][];
24063
+ included?: components["schemas"]["Included"];
24064
+ links: components["schemas"]["Links"];
24065
+ };
24066
+ SearchResults_Videos_Resource_Identifier: {
24067
+ /**
24068
+ * @description Resource id
24069
+ * @example 12345
24070
+ */
24071
+ id: string;
24072
+ meta?: components["schemas"]["SearchResults_Videos_Resource_Identifier_Meta"];
24073
+ /**
24074
+ * @description Resource type
24075
+ * @example tracks
24076
+ */
24077
+ type: string;
24078
+ };
24079
+ SearchResults_Videos_Resource_Identifier_Meta: {
24080
+ replacement?: components["schemas"]["Replacement_Provenance"];
24081
+ };
22977
24082
  SearchSuggestions_Attributes: {
22978
24083
  /**
22979
24084
  * @deprecated
@@ -22985,6 +24090,27 @@ export interface components {
22985
24090
  /** @description Unique tracking id */
22986
24091
  trackingId: string;
22987
24092
  };
24093
+ SearchSuggestions_DirectHits_Multi_Relationship_Data_Document: {
24094
+ data?: components["schemas"]["SearchSuggestions_DirectHits_Resource_Identifier"][];
24095
+ included?: components["schemas"]["Included"];
24096
+ links: components["schemas"]["Links"];
24097
+ };
24098
+ SearchSuggestions_DirectHits_Resource_Identifier: {
24099
+ /**
24100
+ * @description Resource id
24101
+ * @example 12345
24102
+ */
24103
+ id: string;
24104
+ meta?: components["schemas"]["SearchSuggestions_DirectHits_Resource_Identifier_Meta"];
24105
+ /**
24106
+ * @description Resource type
24107
+ * @example tracks
24108
+ */
24109
+ type: string;
24110
+ };
24111
+ SearchSuggestions_DirectHits_Resource_Identifier_Meta: {
24112
+ replacement?: components["schemas"]["Replacement_Provenance"];
24113
+ };
22988
24114
  SearchSuggestions_Highlights: {
22989
24115
  /** Format: int32 */
22990
24116
  length: number;
@@ -23007,7 +24133,7 @@ export interface components {
23007
24133
  links: components["schemas"]["Links"];
23008
24134
  };
23009
24135
  SearchSuggestions_Relationships: {
23010
- directHits?: components["schemas"]["Multi_Relationship_Data_Document"];
24136
+ directHits?: components["schemas"]["SearchSuggestions_DirectHits_Multi_Relationship_Data_Document"];
23011
24137
  history?: components["schemas"]["Multi_Relationship_Data_Document"];
23012
24138
  };
23013
24139
  SearchSuggestions_Resource_Object: {
@@ -23076,7 +24202,7 @@ export interface components {
23076
24202
  };
23077
24203
  Shares_Relationships: {
23078
24204
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
23079
- sharedResources?: components["schemas"]["Multi_Relationship_Data_Document"];
24205
+ sharedResources?: components["schemas"]["Shares_SharedResources_Multi_Relationship_Data_Document"];
23080
24206
  };
23081
24207
  Shares_Resource_Object: {
23082
24208
  attributes?: components["schemas"]["Shares_Attributes"];
@@ -23092,6 +24218,27 @@ export interface components {
23092
24218
  */
23093
24219
  type: "shares";
23094
24220
  };
24221
+ Shares_SharedResources_Multi_Relationship_Data_Document: {
24222
+ data?: components["schemas"]["Shares_SharedResources_Resource_Identifier"][];
24223
+ included?: components["schemas"]["Included"];
24224
+ links: components["schemas"]["Links"];
24225
+ };
24226
+ Shares_SharedResources_Resource_Identifier: {
24227
+ /**
24228
+ * @description Resource id
24229
+ * @example 12345
24230
+ */
24231
+ id: string;
24232
+ meta?: components["schemas"]["Shares_SharedResources_Resource_Identifier_Meta"];
24233
+ /**
24234
+ * @description Resource type
24235
+ * @example tracks
24236
+ */
24237
+ type: string;
24238
+ };
24239
+ Shares_SharedResources_Resource_Identifier_Meta: {
24240
+ replacement?: components["schemas"]["Replacement_Provenance"];
24241
+ };
23095
24242
  Shares_Single_Resource_Data_Document: {
23096
24243
  data: components["schemas"]["Shares_Resource_Object"];
23097
24244
  included?: components["schemas"]["Included"];
@@ -23952,6 +25099,27 @@ export interface components {
23952
25099
  /** @enum {string} */
23953
25100
  type: "genres";
23954
25101
  };
25102
+ Tracks_Albums_Multi_Relationship_Data_Document: {
25103
+ data?: components["schemas"]["Tracks_Albums_Resource_Identifier"][];
25104
+ included?: components["schemas"]["Included"];
25105
+ links: components["schemas"]["Links"];
25106
+ };
25107
+ Tracks_Albums_Resource_Identifier: {
25108
+ /**
25109
+ * @description Resource id
25110
+ * @example 12345
25111
+ */
25112
+ id: string;
25113
+ meta?: components["schemas"]["Tracks_Albums_Resource_Identifier_Meta"];
25114
+ /**
25115
+ * @description Resource type
25116
+ * @example tracks
25117
+ */
25118
+ type: string;
25119
+ };
25120
+ Tracks_Albums_Resource_Identifier_Meta: {
25121
+ replacement?: components["schemas"]["Replacement_Provenance"];
25122
+ };
23955
25123
  Tracks_Attributes: {
23956
25124
  /**
23957
25125
  * @description Access type
@@ -24043,7 +25211,7 @@ export interface components {
24043
25211
  links: components["schemas"]["Links"];
24044
25212
  };
24045
25213
  Tracks_Relationships: {
24046
- albums?: components["schemas"]["Multi_Relationship_Data_Document"];
25214
+ albums?: components["schemas"]["Tracks_Albums_Multi_Relationship_Data_Document"];
24047
25215
  artists?: components["schemas"]["Multi_Relationship_Data_Document"];
24048
25216
  credits?: components["schemas"]["Multi_Relationship_Data_Document"];
24049
25217
  download?: components["schemas"]["Single_Relationship_Data_Document"];
@@ -24054,14 +25222,35 @@ export interface components {
24054
25222
  priceConfig?: components["schemas"]["Single_Relationship_Data_Document"];
24055
25223
  providers?: components["schemas"]["Multi_Relationship_Data_Document"];
24056
25224
  radio?: components["schemas"]["Multi_Relationship_Data_Document"];
24057
- replacement?: components["schemas"]["Single_Relationship_Data_Document"];
25225
+ replacement?: components["schemas"]["Tracks_Replacement_Single_Relationship_Data_Document"];
24058
25226
  shares?: components["schemas"]["Multi_Relationship_Data_Document"];
24059
- similarTracks?: components["schemas"]["Multi_Relationship_Data_Document"];
25227
+ similarTracks?: components["schemas"]["Tracks_SimilarTracks_Multi_Relationship_Data_Document"];
24060
25228
  sourceFile?: components["schemas"]["Single_Relationship_Data_Document"];
24061
- suggestedTracks?: components["schemas"]["Multi_Relationship_Data_Document"];
25229
+ suggestedTracks?: components["schemas"]["Tracks_SuggestedTracks_Multi_Relationship_Data_Document"];
24062
25230
  trackStatistics?: components["schemas"]["Single_Relationship_Data_Document"];
24063
25231
  usageRules?: components["schemas"]["Single_Relationship_Data_Document"];
24064
25232
  };
25233
+ Tracks_Replacement_Resource_Identifier: {
25234
+ /**
25235
+ * @description Resource id
25236
+ * @example 12345
25237
+ */
25238
+ id: string;
25239
+ meta?: components["schemas"]["Tracks_Replacement_Resource_Identifier_Meta"];
25240
+ /**
25241
+ * @description Resource type
25242
+ * @example tracks
25243
+ */
25244
+ type: string;
25245
+ };
25246
+ Tracks_Replacement_Resource_Identifier_Meta: {
25247
+ replacement?: components["schemas"]["Replacement_Provenance"];
25248
+ };
25249
+ Tracks_Replacement_Single_Relationship_Data_Document: {
25250
+ data?: components["schemas"]["Tracks_Replacement_Resource_Identifier"] | (never | null);
25251
+ included?: components["schemas"]["Included"];
25252
+ links: components["schemas"]["Links"];
25253
+ };
24065
25254
  Tracks_Resource_Object: {
24066
25255
  attributes?: components["schemas"]["Tracks_Attributes"];
24067
25256
  /**
@@ -24076,6 +25265,27 @@ export interface components {
24076
25265
  */
24077
25266
  type: "tracks";
24078
25267
  };
25268
+ Tracks_SimilarTracks_Multi_Relationship_Data_Document: {
25269
+ data?: components["schemas"]["Tracks_SimilarTracks_Resource_Identifier"][];
25270
+ included?: components["schemas"]["Included"];
25271
+ links: components["schemas"]["Links"];
25272
+ };
25273
+ Tracks_SimilarTracks_Resource_Identifier: {
25274
+ /**
25275
+ * @description Resource id
25276
+ * @example 12345
25277
+ */
25278
+ id: string;
25279
+ meta?: components["schemas"]["Tracks_SimilarTracks_Resource_Identifier_Meta"];
25280
+ /**
25281
+ * @description Resource type
25282
+ * @example tracks
25283
+ */
25284
+ type: string;
25285
+ };
25286
+ Tracks_SimilarTracks_Resource_Identifier_Meta: {
25287
+ replacement?: components["schemas"]["Replacement_Provenance"];
25288
+ };
24079
25289
  Tracks_Single_Relationship_Data_Document: {
24080
25290
  data?: components["schemas"]["Resource_Identifier"] | (never | null);
24081
25291
  included?: components["schemas"]["Included"];
@@ -24086,6 +25296,27 @@ export interface components {
24086
25296
  included?: components["schemas"]["Included"];
24087
25297
  links: components["schemas"]["Links"];
24088
25298
  };
25299
+ Tracks_SuggestedTracks_Multi_Relationship_Data_Document: {
25300
+ data?: components["schemas"]["Tracks_SuggestedTracks_Resource_Identifier"][];
25301
+ included?: components["schemas"]["Included"];
25302
+ links: components["schemas"]["Links"];
25303
+ };
25304
+ Tracks_SuggestedTracks_Resource_Identifier: {
25305
+ /**
25306
+ * @description Resource id
25307
+ * @example 12345
25308
+ */
25309
+ id: string;
25310
+ meta?: components["schemas"]["Tracks_SuggestedTracks_Resource_Identifier_Meta"];
25311
+ /**
25312
+ * @description Resource type
25313
+ * @example tracks
25314
+ */
25315
+ type: string;
25316
+ };
25317
+ Tracks_SuggestedTracks_Resource_Identifier_Meta: {
25318
+ replacement?: components["schemas"]["Replacement_Provenance"];
25319
+ };
24089
25320
  UsageRulesCreateOperation_Payload: {
24090
25321
  data: components["schemas"]["UsageRulesCreateOperation_Payload_Data"];
24091
25322
  };
@@ -24247,6 +25478,7 @@ export interface components {
24247
25478
  UserCollectionAlbums_Items_Resource_Identifier_Meta: {
24248
25479
  /** Format: date-time */
24249
25480
  addedAt: string;
25481
+ replacement?: components["schemas"]["Replacement_Provenance"];
24250
25482
  };
24251
25483
  UserCollectionAlbums_Multi_Relationship_Data_Document: {
24252
25484
  data?: components["schemas"]["Resource_Identifier"][];
@@ -24722,6 +25954,7 @@ export interface components {
24722
25954
  UserCollectionSaveForLaters_Items_Resource_Identifier_Meta: {
24723
25955
  /** Format: date-time */
24724
25956
  addedAt: string;
25957
+ replacement?: components["schemas"]["Replacement_Provenance"];
24725
25958
  };
24726
25959
  UserCollectionSaveForLaters_Multi_Relationship_Data_Document: {
24727
25960
  data?: components["schemas"]["Resource_Identifier"][];
@@ -24839,6 +26072,7 @@ export interface components {
24839
26072
  UserCollectionTracks_Items_Resource_Identifier_Meta: {
24840
26073
  /** Format: date-time */
24841
26074
  addedAt: string;
26075
+ replacement?: components["schemas"]["Replacement_Provenance"];
24842
26076
  };
24843
26077
  UserCollectionTracks_Multi_Relationship_Data_Document: {
24844
26078
  data?: components["schemas"]["Resource_Identifier"][];
@@ -24956,6 +26190,7 @@ export interface components {
24956
26190
  UserCollectionVideos_Items_Resource_Identifier_Meta: {
24957
26191
  /** Format: date-time */
24958
26192
  addedAt: string;
26193
+ replacement?: components["schemas"]["Replacement_Provenance"];
24959
26194
  };
24960
26195
  UserCollectionVideos_Multi_Relationship_Data_Document: {
24961
26196
  data?: components["schemas"]["Resource_Identifier"][];
@@ -25119,6 +26354,7 @@ export interface components {
25119
26354
  UserCollections_Albums_Resource_Identifier_Meta: {
25120
26355
  /** Format: date-time */
25121
26356
  addedAt: string;
26357
+ replacement?: components["schemas"]["Replacement_Provenance"];
25122
26358
  };
25123
26359
  UserCollections_Artists_Multi_Relationship_Data_Document: {
25124
26360
  data?: components["schemas"]["UserCollections_Artists_Resource_Identifier"][];
@@ -25223,6 +26459,7 @@ export interface components {
25223
26459
  UserCollections_Tracks_Resource_Identifier_Meta: {
25224
26460
  /** Format: date-time */
25225
26461
  addedAt: string;
26462
+ replacement?: components["schemas"]["Replacement_Provenance"];
25226
26463
  };
25227
26464
  UserCollections_Videos_Multi_Relationship_Data_Document: {
25228
26465
  data?: components["schemas"]["UserCollections_Videos_Resource_Identifier"][];
@@ -25245,6 +26482,7 @@ export interface components {
25245
26482
  UserCollections_Videos_Resource_Identifier_Meta: {
25246
26483
  /** Format: date-time */
25247
26484
  addedAt: string;
26485
+ replacement?: components["schemas"]["Replacement_Provenance"];
25248
26486
  };
25249
26487
  UserDailyMixes_Attributes: Record<string, never>;
25250
26488
  UserDailyMixes_Multi_Relationship_Data_Document: {
@@ -25566,6 +26804,7 @@ export interface components {
25566
26804
  * @description When the item was blocked
25567
26805
  */
25568
26806
  createdAt: string;
26807
+ replacement?: components["schemas"]["Replacement_Provenance"];
25569
26808
  };
25570
26809
  UserRecommendationBlocks_Videos_Multi_Relationship_Data_Document: {
25571
26810
  data?: components["schemas"]["UserRecommendationBlocks_Videos_Resource_Identifier"][];
@@ -25591,6 +26830,7 @@ export interface components {
25591
26830
  * @description When the item was blocked
25592
26831
  */
25593
26832
  createdAt: string;
26833
+ replacement?: components["schemas"]["Replacement_Provenance"];
25594
26834
  };
25595
26835
  UserRecommendations_Attributes: Record<string, never>;
25596
26836
  UserRecommendations_Multi_Relationship_Data_Document: {
@@ -25868,6 +27108,27 @@ export interface components {
25868
27108
  included?: components["schemas"]["Included"];
25869
27109
  links: components["schemas"]["Links"];
25870
27110
  };
27111
+ Videos_Albums_Multi_Relationship_Data_Document: {
27112
+ data?: components["schemas"]["Videos_Albums_Resource_Identifier"][];
27113
+ included?: components["schemas"]["Included"];
27114
+ links: components["schemas"]["Links"];
27115
+ };
27116
+ Videos_Albums_Resource_Identifier: {
27117
+ /**
27118
+ * @description Resource id
27119
+ * @example 12345
27120
+ */
27121
+ id: string;
27122
+ meta?: components["schemas"]["Videos_Albums_Resource_Identifier_Meta"];
27123
+ /**
27124
+ * @description Resource type
27125
+ * @example tracks
27126
+ */
27127
+ type: string;
27128
+ };
27129
+ Videos_Albums_Resource_Identifier_Meta: {
27130
+ replacement?: components["schemas"]["Replacement_Provenance"];
27131
+ };
25871
27132
  Videos_Attributes: {
25872
27133
  /**
25873
27134
  * @deprecated
@@ -25926,16 +27187,37 @@ export interface components {
25926
27187
  links: components["schemas"]["Links"];
25927
27188
  };
25928
27189
  Videos_Relationships: {
25929
- albums?: components["schemas"]["Multi_Relationship_Data_Document"];
27190
+ albums?: components["schemas"]["Videos_Albums_Multi_Relationship_Data_Document"];
25930
27191
  artists?: components["schemas"]["Multi_Relationship_Data_Document"];
25931
27192
  credits?: components["schemas"]["Multi_Relationship_Data_Document"];
25932
27193
  providers?: components["schemas"]["Multi_Relationship_Data_Document"];
25933
- replacement?: components["schemas"]["Single_Relationship_Data_Document"];
25934
- similarVideos?: components["schemas"]["Multi_Relationship_Data_Document"];
25935
- suggestedVideos?: components["schemas"]["Multi_Relationship_Data_Document"];
27194
+ replacement?: components["schemas"]["Videos_Replacement_Single_Relationship_Data_Document"];
27195
+ similarVideos?: components["schemas"]["Videos_SimilarVideos_Multi_Relationship_Data_Document"];
27196
+ suggestedVideos?: components["schemas"]["Videos_SuggestedVideos_Multi_Relationship_Data_Document"];
25936
27197
  thumbnailArt?: components["schemas"]["Multi_Relationship_Data_Document"];
25937
27198
  usageRules?: components["schemas"]["Single_Relationship_Data_Document"];
25938
27199
  };
27200
+ Videos_Replacement_Resource_Identifier: {
27201
+ /**
27202
+ * @description Resource id
27203
+ * @example 12345
27204
+ */
27205
+ id: string;
27206
+ meta?: components["schemas"]["Videos_Replacement_Resource_Identifier_Meta"];
27207
+ /**
27208
+ * @description Resource type
27209
+ * @example tracks
27210
+ */
27211
+ type: string;
27212
+ };
27213
+ Videos_Replacement_Resource_Identifier_Meta: {
27214
+ replacement?: components["schemas"]["Replacement_Provenance"];
27215
+ };
27216
+ Videos_Replacement_Single_Relationship_Data_Document: {
27217
+ data?: components["schemas"]["Videos_Replacement_Resource_Identifier"] | (never | null);
27218
+ included?: components["schemas"]["Included"];
27219
+ links: components["schemas"]["Links"];
27220
+ };
25939
27221
  Videos_Resource_Object: {
25940
27222
  attributes?: components["schemas"]["Videos_Attributes"];
25941
27223
  /**
@@ -25950,6 +27232,27 @@ export interface components {
25950
27232
  */
25951
27233
  type: "videos";
25952
27234
  };
27235
+ Videos_SimilarVideos_Multi_Relationship_Data_Document: {
27236
+ data?: components["schemas"]["Videos_SimilarVideos_Resource_Identifier"][];
27237
+ included?: components["schemas"]["Included"];
27238
+ links: components["schemas"]["Links"];
27239
+ };
27240
+ Videos_SimilarVideos_Resource_Identifier: {
27241
+ /**
27242
+ * @description Resource id
27243
+ * @example 12345
27244
+ */
27245
+ id: string;
27246
+ meta?: components["schemas"]["Videos_SimilarVideos_Resource_Identifier_Meta"];
27247
+ /**
27248
+ * @description Resource type
27249
+ * @example tracks
27250
+ */
27251
+ type: string;
27252
+ };
27253
+ Videos_SimilarVideos_Resource_Identifier_Meta: {
27254
+ replacement?: components["schemas"]["Replacement_Provenance"];
27255
+ };
25953
27256
  Videos_Single_Relationship_Data_Document: {
25954
27257
  data?: components["schemas"]["Resource_Identifier"] | (never | null);
25955
27258
  included?: components["schemas"]["Included"];
@@ -25960,6 +27263,27 @@ export interface components {
25960
27263
  included?: components["schemas"]["Included"];
25961
27264
  links: components["schemas"]["Links"];
25962
27265
  };
27266
+ Videos_SuggestedVideos_Multi_Relationship_Data_Document: {
27267
+ data?: components["schemas"]["Videos_SuggestedVideos_Resource_Identifier"][];
27268
+ included?: components["schemas"]["Included"];
27269
+ links: components["schemas"]["Links"];
27270
+ };
27271
+ Videos_SuggestedVideos_Resource_Identifier: {
27272
+ /**
27273
+ * @description Resource id
27274
+ * @example 12345
27275
+ */
27276
+ id: string;
27277
+ meta?: components["schemas"]["Videos_SuggestedVideos_Resource_Identifier_Meta"];
27278
+ /**
27279
+ * @description Resource type
27280
+ * @example tracks
27281
+ */
27282
+ type: string;
27283
+ };
27284
+ Videos_SuggestedVideos_Resource_Identifier_Meta: {
27285
+ replacement?: components["schemas"]["Replacement_Provenance"];
27286
+ };
25963
27287
  };
25964
27288
  responses: {
25965
27289
  /** @description Invalid request */