@tidal-music/api 0.37.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.
@@ -236,6 +236,11 @@ export interface paths {
236
236
  get: {
237
237
  parameters: {
238
238
  query?: {
239
+ /**
240
+ * @description ISO 3166-1 alpha-2 country code
241
+ * @example US
242
+ */
243
+ countryCode?: string;
239
244
  /**
240
245
  * @description Allows the client to customize which related resources should be returned. Available options: owners
241
246
  * @example owners
@@ -295,6 +300,11 @@ export interface paths {
295
300
  get: {
296
301
  parameters: {
297
302
  query?: {
303
+ /**
304
+ * @description ISO 3166-1 alpha-2 country code
305
+ * @example US
306
+ */
307
+ countryCode?: string;
298
308
  /**
299
309
  * @description Allows the client to customize which related resources should be returned. Available options: owners
300
310
  * @example owners
@@ -367,7 +377,7 @@ export interface paths {
367
377
  countryCode?: string;
368
378
  /**
369
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
370
- * @example albumStatistics
380
+ * @example artists.albums
371
381
  */
372
382
  include?: string[];
373
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`) */
@@ -376,6 +386,11 @@ export interface paths {
376
386
  "filter[id]"?: string[];
377
387
  /** @description User id. Use `me` for the authenticated user */
378
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;
379
394
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
380
395
  shareCode?: string;
381
396
  };
@@ -473,9 +488,14 @@ export interface paths {
473
488
  countryCode?: string;
474
489
  /**
475
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
476
- * @example albumStatistics
491
+ * @example artists.albums
477
492
  */
478
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;
479
499
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
480
500
  shareCode?: string;
481
501
  };
@@ -672,9 +692,14 @@ export interface paths {
672
692
  countryCode?: string;
673
693
  /**
674
694
  * @description Allows the client to customize which related resources should be returned. Available options: artists
675
- * @example artists
695
+ * @example artists.albums
676
696
  */
677
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;
678
703
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
679
704
  shareCode?: string;
680
705
  };
@@ -916,6 +941,11 @@ export interface paths {
916
941
  * @example items
917
942
  */
918
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;
919
949
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
920
950
  shareCode?: string;
921
951
  };
@@ -1009,6 +1039,11 @@ export interface paths {
1009
1039
  get: {
1010
1040
  parameters: {
1011
1041
  query?: {
1042
+ /**
1043
+ * @description ISO 3166-1 alpha-2 country code
1044
+ * @example US
1045
+ */
1046
+ countryCode?: string;
1012
1047
  /**
1013
1048
  * @description Allows the client to customize which related resources should be returned. Available options: owners
1014
1049
  * @example owners
@@ -1216,6 +1251,11 @@ export interface paths {
1216
1251
  * @example replacement
1217
1252
  */
1218
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;
1219
1259
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
1220
1260
  shareCode?: string;
1221
1261
  };
@@ -1274,11 +1314,16 @@ export interface paths {
1274
1314
  query?: {
1275
1315
  /**
1276
1316
  * @description Allows the client to customize which related resources should be returned. Available options: shares
1277
- * @example shares
1317
+ * @example shares.sharedResources
1278
1318
  */
1279
1319
  include?: string[];
1280
1320
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
1281
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;
1282
1327
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
1283
1328
  shareCode?: string;
1284
1329
  };
@@ -1347,6 +1392,11 @@ export interface paths {
1347
1392
  * @example similarAlbums
1348
1393
  */
1349
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;
1350
1400
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
1351
1401
  shareCode?: string;
1352
1402
  };
@@ -1802,11 +1852,16 @@ export interface paths {
1802
1852
  query: {
1803
1853
  /**
1804
1854
  * @description Allows the client to customize which related resources should be returned. Available options: acceptedArtists, owners, recommendedArtists
1805
- * @example acceptedArtists
1855
+ * @example acceptedArtists.albums
1806
1856
  */
1807
1857
  include?: string[];
1808
1858
  /** @description User id. Use `me` for the authenticated user */
1809
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;
1810
1865
  };
1811
1866
  header?: never;
1812
1867
  path?: never;
@@ -1903,9 +1958,14 @@ export interface paths {
1903
1958
  query?: {
1904
1959
  /**
1905
1960
  * @description Allows the client to customize which related resources should be returned. Available options: acceptedArtists, owners, recommendedArtists
1906
- * @example acceptedArtists
1961
+ * @example acceptedArtists.albums
1907
1962
  */
1908
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;
1909
1969
  };
1910
1970
  header?: never;
1911
1971
  path: {
@@ -2038,11 +2098,16 @@ export interface paths {
2038
2098
  query?: {
2039
2099
  /**
2040
2100
  * @description Allows the client to customize which related resources should be returned. Available options: acceptedArtists
2041
- * @example acceptedArtists
2101
+ * @example acceptedArtists.albums
2042
2102
  */
2043
2103
  include?: string[];
2044
2104
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
2045
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;
2046
2111
  };
2047
2112
  header?: never;
2048
2113
  path: {
@@ -2203,11 +2268,16 @@ export interface paths {
2203
2268
  query?: {
2204
2269
  /**
2205
2270
  * @description Allows the client to customize which related resources should be returned. Available options: recommendedArtists
2206
- * @example recommendedArtists
2271
+ * @example recommendedArtists.albums
2207
2272
  */
2208
2273
  include?: string[];
2209
2274
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
2210
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;
2211
2281
  };
2212
2282
  header?: never;
2213
2283
  path: {
@@ -2331,6 +2401,11 @@ export interface paths {
2331
2401
  "filter[id]"?: string[];
2332
2402
  /** @description User id. Use `me` for the authenticated user */
2333
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;
2334
2409
  };
2335
2410
  header?: never;
2336
2411
  path?: never;
@@ -2429,6 +2504,11 @@ export interface paths {
2429
2504
  * @example albums
2430
2505
  */
2431
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;
2432
2512
  };
2433
2513
  header?: never;
2434
2514
  path: {
@@ -2532,6 +2612,11 @@ export interface paths {
2532
2612
  * @example albums
2533
2613
  */
2534
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;
2535
2620
  };
2536
2621
  header?: never;
2537
2622
  path: {
@@ -2714,9 +2799,14 @@ export interface paths {
2714
2799
  "page[cursor]"?: string;
2715
2800
  /**
2716
2801
  * @description Allows the client to customize which related resources should be returned. Available options: followers
2717
- * @example followers
2802
+ * @example followers.albums
2718
2803
  */
2719
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;
2720
2810
  };
2721
2811
  header?: never;
2722
2812
  path: {
@@ -2776,9 +2866,14 @@ export interface paths {
2776
2866
  "page[cursor]"?: string;
2777
2867
  /**
2778
2868
  * @description Allows the client to customize which related resources should be returned. Available options: following
2779
- * @example following
2869
+ * @example following.albums
2780
2870
  */
2781
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;
2782
2877
  };
2783
2878
  header?: never;
2784
2879
  path: {
@@ -3086,9 +3181,14 @@ export interface paths {
3086
3181
  countryCode?: string;
3087
3182
  /**
3088
3183
  * @description Allows the client to customize which related resources should be returned. Available options: radio
3089
- * @example radio
3184
+ * @example radio.items
3090
3185
  */
3091
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;
3092
3192
  };
3093
3193
  header?: never;
3094
3194
  path: {
@@ -3213,9 +3313,14 @@ export interface paths {
3213
3313
  countryCode?: string;
3214
3314
  /**
3215
3315
  * @description Allows the client to customize which related resources should be returned. Available options: similarArtists
3216
- * @example similarArtists
3316
+ * @example similarArtists.albums
3217
3317
  */
3218
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;
3219
3324
  };
3220
3325
  header?: never;
3221
3326
  path: {
@@ -3348,6 +3453,11 @@ export interface paths {
3348
3453
  * @example tracks
3349
3454
  */
3350
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;
3351
3461
  };
3352
3462
  header?: never;
3353
3463
  path: {
@@ -3414,6 +3524,11 @@ export interface paths {
3414
3524
  * @example videos
3415
3525
  */
3416
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;
3417
3532
  };
3418
3533
  header?: never;
3419
3534
  path: {
@@ -4045,11 +4160,16 @@ export interface paths {
4045
4160
  query: {
4046
4161
  /**
4047
4162
  * @description Allows the client to customize which related resources should be returned. Available options: owners, subject
4048
- * @example owners
4163
+ * @example subject.items
4049
4164
  */
4050
4165
  include?: string[];
4051
4166
  /** @description Invite code */
4052
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;
4053
4173
  };
4054
4174
  header?: never;
4055
4175
  path?: never;
@@ -4140,9 +4260,14 @@ export interface paths {
4140
4260
  query?: {
4141
4261
  /**
4142
4262
  * @description Allows the client to customize which related resources should be returned. Available options: owners, subject
4143
- * @example owners
4263
+ * @example subject.items
4144
4264
  */
4145
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;
4146
4271
  };
4147
4272
  header?: never;
4148
4273
  path: {
@@ -4293,9 +4418,14 @@ export interface paths {
4293
4418
  query?: {
4294
4419
  /**
4295
4420
  * @description Allows the client to customize which related resources should be returned. Available options: subject
4296
- * @example subject
4421
+ * @example subject.items
4297
4422
  */
4298
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;
4299
4429
  };
4300
4430
  header?: never;
4301
4431
  path: {
@@ -4770,6 +4900,11 @@ export interface paths {
4770
4900
  include?: string[];
4771
4901
  /** @description User id. Use `me` for the authenticated user */
4772
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;
4773
4908
  };
4774
4909
  header?: never;
4775
4910
  path?: never;
@@ -4863,6 +4998,11 @@ export interface paths {
4863
4998
  * @example claimedResource
4864
4999
  */
4865
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;
4866
5006
  };
4867
5007
  header?: never;
4868
5008
  path: {
@@ -4922,6 +5062,11 @@ export interface paths {
4922
5062
  * @example claimedResource
4923
5063
  */
4924
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;
4925
5070
  };
4926
5071
  header?: never;
4927
5072
  path: {
@@ -4978,9 +5123,14 @@ export interface paths {
4978
5123
  query?: {
4979
5124
  /**
4980
5125
  * @description Allows the client to customize which related resources should be returned. Available options: claimingArtist
4981
- * @example claimingArtist
5126
+ * @example claimingArtist.albums
4982
5127
  */
4983
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;
4984
5134
  };
4985
5135
  header?: never;
4986
5136
  path: {
@@ -5098,9 +5248,14 @@ export interface paths {
5098
5248
  query?: {
5099
5249
  /**
5100
5250
  * @description Allows the client to customize which related resources should be returned. Available options: artist, category
5101
- * @example artist
5251
+ * @example artist.albums
5102
5252
  */
5103
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;
5104
5259
  };
5105
5260
  header?: never;
5106
5261
  path: {
@@ -5157,9 +5312,14 @@ export interface paths {
5157
5312
  query?: {
5158
5313
  /**
5159
5314
  * @description Allows the client to customize which related resources should be returned. Available options: artist
5160
- * @example artist
5315
+ * @example artist.albums
5161
5316
  */
5162
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;
5163
5323
  };
5164
5324
  header?: never;
5165
5325
  path: {
@@ -5457,6 +5617,11 @@ export interface paths {
5457
5617
  "filter[subject.id]": string[];
5458
5618
  /** @description The type of the subject resource (e.g., albums, tracks, artists) (e.g. `tracks`) */
5459
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;
5460
5625
  };
5461
5626
  header?: never;
5462
5627
  path?: never;
@@ -5510,6 +5675,11 @@ export interface paths {
5510
5675
  * @example subject
5511
5676
  */
5512
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;
5513
5683
  };
5514
5684
  header?: never;
5515
5685
  path: {
@@ -5592,12 +5762,17 @@ export interface paths {
5592
5762
  */
5593
5763
  clientVersion: string;
5594
5764
  /**
5595
- * @description Allows the client to customize which related resources should be returned. Available options: items
5765
+ * @description Allows the client to customize which related resources should be returned. Available options: items, seedItem
5596
5766
  * @example items
5597
5767
  */
5598
5768
  include?: string[];
5599
5769
  /** @description DynamicModules Id (e.g. `nejMcAhh5N8S3EQ4LaqysVdI0cZZ`) */
5600
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;
5601
5776
  };
5602
5777
  header?: never;
5603
5778
  path?: never;
@@ -5674,10 +5849,15 @@ export interface paths {
5674
5849
  */
5675
5850
  clientVersion: string;
5676
5851
  /**
5677
- * @description Allows the client to customize which related resources should be returned. Available options: items
5852
+ * @description Allows the client to customize which related resources should be returned. Available options: items, seedItem
5678
5853
  * @example items
5679
5854
  */
5680
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;
5681
5861
  };
5682
5862
  header?: never;
5683
5863
  path: {
@@ -5727,7 +5907,7 @@ export interface paths {
5727
5907
  };
5728
5908
  /**
5729
5909
  * Get items relationship ("to-many").
5730
- * @description The resources to render, in order; may be a bounded prefix.
5910
+ * @description The module's items, in order — one stable collection per module, consistent for a given refreshSeed. Reads without a cursor return the first page (the slice a page shelf renders, sized for the module's previewLayout and device) with a continuation cursor; passing the cursor returns subsequent pages.
5731
5911
  */
5732
5912
  get: {
5733
5913
  parameters: {
@@ -5766,6 +5946,11 @@ export interface paths {
5766
5946
  * @example items
5767
5947
  */
5768
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;
5769
5954
  };
5770
5955
  header?: never;
5771
5956
  path: {
@@ -5806,6 +5991,97 @@ export interface paths {
5806
5991
  patch?: never;
5807
5992
  trace?: never;
5808
5993
  };
5994
+ "/dynamicModules/{id}/relationships/seedItem": {
5995
+ parameters: {
5996
+ query?: never;
5997
+ header?: never;
5998
+ path?: never;
5999
+ cookie?: never;
6000
+ };
6001
+ /**
6002
+ * Get seedItem relationship ("to-one").
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.
6004
+ */
6005
+ get: {
6006
+ parameters: {
6007
+ query: {
6008
+ /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */
6009
+ refreshSeed?: string;
6010
+ /**
6011
+ * @description ISO 3166-1 alpha-2 country code
6012
+ * @example US
6013
+ */
6014
+ countryCode?: string;
6015
+ /**
6016
+ * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.
6017
+ * @example en-US
6018
+ */
6019
+ locale?: string;
6020
+ /**
6021
+ * @description The type of device making the request
6022
+ * @example PHONE
6023
+ */
6024
+ deviceType: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV";
6025
+ /**
6026
+ * @description The system type of the device making the request
6027
+ * @example IOS
6028
+ */
6029
+ systemType: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB";
6030
+ /**
6031
+ * @description Client version number
6032
+ * @example 2026.0.1
6033
+ */
6034
+ clientVersion: string;
6035
+ /**
6036
+ * @description Allows the client to customize which related resources should be returned. Available options: seedItem
6037
+ * @example seedItem
6038
+ */
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;
6045
+ };
6046
+ header?: never;
6047
+ path: {
6048
+ /**
6049
+ * @description DynamicModules Id
6050
+ * @example nejMcAhh5N8S3EQ4LaqysVdI0cZZ
6051
+ */
6052
+ id: string;
6053
+ };
6054
+ cookie?: never;
6055
+ };
6056
+ requestBody?: never;
6057
+ responses: {
6058
+ /** @description Successful response */
6059
+ 200: {
6060
+ headers: {
6061
+ [name: string]: unknown;
6062
+ };
6063
+ content: {
6064
+ "application/vnd.api+json": components["schemas"]["DynamicModules_Single_Relationship_Data_Document"];
6065
+ };
6066
+ };
6067
+ 400: components["responses"]["Default400Response"];
6068
+ 404: components["responses"]["Default404Response"];
6069
+ 405: components["responses"]["Default405Response"];
6070
+ 406: components["responses"]["Default406Response"];
6071
+ 415: components["responses"]["Default415Response"];
6072
+ 429: components["responses"]["Default429Response"];
6073
+ 500: components["responses"]["Default500Response"];
6074
+ 503: components["responses"]["Default503Response"];
6075
+ };
6076
+ };
6077
+ put?: never;
6078
+ post?: never;
6079
+ delete?: never;
6080
+ options?: never;
6081
+ head?: never;
6082
+ patch?: never;
6083
+ trace?: never;
6084
+ };
5809
6085
  "/dynamicPages": {
5810
6086
  parameters: {
5811
6087
  query?: never;
@@ -5849,13 +6125,18 @@ export interface paths {
5849
6125
  clientVersion: string;
5850
6126
  /**
5851
6127
  * @description Allows the client to customize which related resources should be returned. Available options: modules, subject
5852
- * @example modules
6128
+ * @example modules.items
5853
6129
  */
5854
6130
  include?: string[];
5855
6131
  /** @description type of the page (e.g. `ARTIST`) */
5856
6132
  "filter[pageType]": string[];
5857
6133
  /** @description The subject resource ID. Required except for HOME_FREE, where it must be omitted. (e.g. `67890`) */
5858
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;
5859
6140
  };
5860
6141
  header?: never;
5861
6142
  path?: never;
@@ -5935,9 +6216,14 @@ export interface paths {
5935
6216
  clientVersion: string;
5936
6217
  /**
5937
6218
  * @description Allows the client to customize which related resources should be returned. Available options: modules
5938
- * @example modules
6219
+ * @example modules.items
5939
6220
  */
5940
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;
5941
6227
  };
5942
6228
  header?: never;
5943
6229
  path: {
@@ -5997,6 +6283,11 @@ export interface paths {
5997
6283
  * @example subject
5998
6284
  */
5999
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;
6000
6291
  };
6001
6292
  header?: never;
6002
6293
  path: {
@@ -6178,6 +6469,11 @@ export interface paths {
6178
6469
  "filter[clientProvidedInstallationId]"?: string[];
6179
6470
  /** @description User ID to filter by. Use `me` for the authenticated user */
6180
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;
6181
6477
  };
6182
6478
  header?: never;
6183
6479
  path?: never;
@@ -6271,6 +6567,11 @@ export interface paths {
6271
6567
  * @example offlineInventory
6272
6568
  */
6273
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;
6274
6575
  };
6275
6576
  header?: never;
6276
6577
  path: {
@@ -6338,6 +6639,11 @@ export interface paths {
6338
6639
  "filter[state]"?: ("PENDING" | "STORED")[];
6339
6640
  /** @description One of: tracks, videos, albums, playlists, userCollectionTracks (e.g. `tracks`) */
6340
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;
6341
6647
  };
6342
6648
  header?: never;
6343
6649
  path: {
@@ -6585,9 +6891,14 @@ export interface paths {
6585
6891
  query?: {
6586
6892
  /**
6587
6893
  * @description Allows the client to customize which related resources should be returned. Available options: owners, track
6588
- * @example owners
6894
+ * @example track
6589
6895
  */
6590
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;
6591
6902
  };
6592
6903
  header?: never;
6593
6904
  path: {
@@ -6788,6 +7099,11 @@ export interface paths {
6788
7099
  * @example track
6789
7100
  */
6790
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;
6791
7107
  };
6792
7108
  header?: never;
6793
7109
  path: {
@@ -6907,6 +7223,11 @@ export interface paths {
6907
7223
  include?: string[];
6908
7224
  /** @description List of offline task IDs (e.g. `a468bee88def`) */
6909
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;
6910
7231
  };
6911
7232
  header?: never;
6912
7233
  path?: never;
@@ -6960,6 +7281,11 @@ export interface paths {
6960
7281
  * @example collection
6961
7282
  */
6962
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;
6963
7289
  };
6964
7290
  header?: never;
6965
7291
  path: {
@@ -7056,6 +7382,11 @@ export interface paths {
7056
7382
  * @example collection
7057
7383
  */
7058
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;
7059
7390
  };
7060
7391
  header?: never;
7061
7392
  path: {
@@ -7115,6 +7446,11 @@ export interface paths {
7115
7446
  * @example item
7116
7447
  */
7117
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;
7118
7454
  };
7119
7455
  header?: never;
7120
7456
  path: {
@@ -7239,6 +7575,11 @@ export interface paths {
7239
7575
  include?: string[];
7240
7576
  /** @description User id. Use `me` for the authenticated user */
7241
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;
7242
7583
  };
7243
7584
  header?: never;
7244
7585
  path?: never;
@@ -7332,6 +7673,11 @@ export interface paths {
7332
7673
  * @example current
7333
7674
  */
7334
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;
7335
7681
  };
7336
7682
  header?: never;
7337
7683
  path: {
@@ -7461,6 +7807,11 @@ export interface paths {
7461
7807
  * @example current
7462
7808
  */
7463
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;
7464
7815
  };
7465
7816
  header?: never;
7466
7817
  path: {
@@ -7559,6 +7910,11 @@ export interface paths {
7559
7910
  * @example future
7560
7911
  */
7561
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;
7562
7918
  };
7563
7919
  header?: never;
7564
7920
  path: {
@@ -7792,6 +8148,11 @@ export interface paths {
7792
8148
  * @example past
7793
8149
  */
7794
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;
7795
8156
  };
7796
8157
  header?: never;
7797
8158
  path: {
@@ -7857,13 +8218,18 @@ export interface paths {
7857
8218
  countryCode?: string;
7858
8219
  /**
7859
8220
  * @description Allows the client to customize which related resources should be returned. Available options: collaboratorProfiles, collaborators, coverArt, items, ownerProfiles, owners, suggestedCoverArts
7860
- * @example collaboratorProfiles
8221
+ * @example items
7861
8222
  */
7862
8223
  include?: string[];
7863
8224
  /** @description List of playlist IDs (e.g. `550e8400-e29b-41d4-a716-446655440000`) */
7864
8225
  "filter[id]"?: string[];
7865
8226
  /** @description User id. Use `me` for the authenticated user */
7866
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;
7867
8233
  };
7868
8234
  header?: never;
7869
8235
  path?: never;
@@ -7965,9 +8331,14 @@ export interface paths {
7965
8331
  countryCode?: string;
7966
8332
  /**
7967
8333
  * @description Allows the client to customize which related resources should be returned. Available options: collaboratorProfiles, collaborators, coverArt, items, ownerProfiles, owners, suggestedCoverArts
7968
- * @example collaboratorProfiles
8334
+ * @example items
7969
8335
  */
7970
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;
7971
8342
  };
7972
8343
  header?: never;
7973
8344
  path: {
@@ -8421,6 +8792,11 @@ export interface paths {
8421
8792
  * @example items
8422
8793
  */
8423
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;
8424
8800
  };
8425
8801
  header?: never;
8426
8802
  path: {
@@ -9113,7 +9489,7 @@ export interface paths {
9113
9489
  countryCode?: string;
9114
9490
  /**
9115
9491
  * @description Allows the client to customize which related resources should be returned. Available options: provider, subject
9116
- * @example provider
9492
+ * @example subject
9117
9493
  */
9118
9494
  include?: string[];
9119
9495
  /** @description List of barcode IDs (EAN-13 or UPC-A) (e.g. `00602527336510`) */
@@ -9122,7 +9498,12 @@ export interface paths {
9122
9498
  "filter[grid]"?: string[];
9123
9499
  /** @description Content provider ID (e.g. `50`) */
9124
9500
  "filter[provider.id]": string[];
9125
- };
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;
9506
+ };
9126
9507
  header?: never;
9127
9508
  path?: never;
9128
9509
  cookie?: never;
@@ -9236,6 +9617,11 @@ export interface paths {
9236
9617
  * @example subject
9237
9618
  */
9238
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;
9239
9625
  };
9240
9626
  header?: never;
9241
9627
  path: {
@@ -9344,13 +9730,18 @@ export interface paths {
9344
9730
  "page[cursor]"?: string;
9345
9731
  /**
9346
9732
  * @description Allows the client to customize which related resources should be returned. Available options: owners, subject
9347
- * @example owners
9733
+ * @example subject
9348
9734
  */
9349
9735
  include?: string[];
9350
9736
  /** @description User id. Use `me` for the authenticated user */
9351
9737
  "filter[owners.id]": string[];
9352
9738
  /** @description The type of purchased content (e.g. `albums`) */
9353
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;
9354
9745
  };
9355
9746
  header?: never;
9356
9747
  path?: never;
@@ -9465,6 +9856,11 @@ export interface paths {
9465
9856
  * @example subject
9466
9857
  */
9467
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;
9468
9864
  };
9469
9865
  header?: never;
9470
9866
  path: {
@@ -9959,11 +10355,31 @@ export interface paths {
9959
10355
  * @example US
9960
10356
  */
9961
10357
  countryCode?: string;
10358
+ /**
10359
+ * @description The type of device making the request
10360
+ * @example PHONE
10361
+ */
10362
+ deviceType?: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV";
10363
+ /**
10364
+ * @description The system type of the device making the request
10365
+ * @example IOS
10366
+ */
10367
+ systemType?: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB";
10368
+ /**
10369
+ * @description Client version number
10370
+ * @example 2026.0.1
10371
+ */
10372
+ clientVersion?: string;
9962
10373
  /**
9963
10374
  * @description Allows the client to customize which related resources should be returned. Available options: albums, artists, playlists, topHits, tracks, videos
9964
10375
  * @example albums
9965
10376
  */
9966
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;
9967
10383
  };
9968
10384
  header?: never;
9969
10385
  path: {
@@ -10030,11 +10446,31 @@ export interface paths {
10030
10446
  * @example US
10031
10447
  */
10032
10448
  countryCode?: string;
10449
+ /**
10450
+ * @description The type of device making the request
10451
+ * @example PHONE
10452
+ */
10453
+ deviceType?: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV";
10454
+ /**
10455
+ * @description The system type of the device making the request
10456
+ * @example IOS
10457
+ */
10458
+ systemType?: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB";
10459
+ /**
10460
+ * @description Client version number
10461
+ * @example 2026.0.1
10462
+ */
10463
+ clientVersion?: string;
10033
10464
  /**
10034
10465
  * @description Allows the client to customize which related resources should be returned. Available options: albums
10035
10466
  * @example albums
10036
10467
  */
10037
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;
10038
10474
  };
10039
10475
  header?: never;
10040
10476
  path: {
@@ -10101,11 +10537,31 @@ export interface paths {
10101
10537
  * @example US
10102
10538
  */
10103
10539
  countryCode?: string;
10540
+ /**
10541
+ * @description The type of device making the request
10542
+ * @example PHONE
10543
+ */
10544
+ deviceType?: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV";
10545
+ /**
10546
+ * @description The system type of the device making the request
10547
+ * @example IOS
10548
+ */
10549
+ systemType?: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB";
10550
+ /**
10551
+ * @description Client version number
10552
+ * @example 2026.0.1
10553
+ */
10554
+ clientVersion?: string;
10104
10555
  /**
10105
10556
  * @description Allows the client to customize which related resources should be returned. Available options: artists
10106
10557
  * @example artists
10107
10558
  */
10108
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;
10109
10565
  };
10110
10566
  header?: never;
10111
10567
  path: {
@@ -10172,11 +10628,31 @@ export interface paths {
10172
10628
  * @example US
10173
10629
  */
10174
10630
  countryCode?: string;
10631
+ /**
10632
+ * @description The type of device making the request
10633
+ * @example PHONE
10634
+ */
10635
+ deviceType?: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV";
10636
+ /**
10637
+ * @description The system type of the device making the request
10638
+ * @example IOS
10639
+ */
10640
+ systemType?: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB";
10641
+ /**
10642
+ * @description Client version number
10643
+ * @example 2026.0.1
10644
+ */
10645
+ clientVersion?: string;
10175
10646
  /**
10176
10647
  * @description Allows the client to customize which related resources should be returned. Available options: playlists
10177
10648
  * @example playlists
10178
10649
  */
10179
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;
10180
10656
  };
10181
10657
  header?: never;
10182
10658
  path: {
@@ -10243,11 +10719,31 @@ export interface paths {
10243
10719
  * @example US
10244
10720
  */
10245
10721
  countryCode?: string;
10722
+ /**
10723
+ * @description The type of device making the request
10724
+ * @example PHONE
10725
+ */
10726
+ deviceType?: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV";
10727
+ /**
10728
+ * @description The system type of the device making the request
10729
+ * @example IOS
10730
+ */
10731
+ systemType?: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB";
10732
+ /**
10733
+ * @description Client version number
10734
+ * @example 2026.0.1
10735
+ */
10736
+ clientVersion?: string;
10246
10737
  /**
10247
10738
  * @description Allows the client to customize which related resources should be returned. Available options: topHits
10248
10739
  * @example topHits
10249
10740
  */
10250
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;
10251
10747
  };
10252
10748
  header?: never;
10253
10749
  path: {
@@ -10314,11 +10810,31 @@ export interface paths {
10314
10810
  * @example US
10315
10811
  */
10316
10812
  countryCode?: string;
10813
+ /**
10814
+ * @description The type of device making the request
10815
+ * @example PHONE
10816
+ */
10817
+ deviceType?: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV";
10818
+ /**
10819
+ * @description The system type of the device making the request
10820
+ * @example IOS
10821
+ */
10822
+ systemType?: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB";
10823
+ /**
10824
+ * @description Client version number
10825
+ * @example 2026.0.1
10826
+ */
10827
+ clientVersion?: string;
10317
10828
  /**
10318
10829
  * @description Allows the client to customize which related resources should be returned. Available options: tracks
10319
10830
  * @example tracks
10320
10831
  */
10321
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;
10322
10838
  };
10323
10839
  header?: never;
10324
10840
  path: {
@@ -10385,11 +10901,31 @@ export interface paths {
10385
10901
  * @example US
10386
10902
  */
10387
10903
  countryCode?: string;
10904
+ /**
10905
+ * @description The type of device making the request
10906
+ * @example PHONE
10907
+ */
10908
+ deviceType?: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV";
10909
+ /**
10910
+ * @description The system type of the device making the request
10911
+ * @example IOS
10912
+ */
10913
+ systemType?: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB";
10914
+ /**
10915
+ * @description Client version number
10916
+ * @example 2026.0.1
10917
+ */
10918
+ clientVersion?: string;
10388
10919
  /**
10389
10920
  * @description Allows the client to customize which related resources should be returned. Available options: videos
10390
10921
  * @example videos
10391
10922
  */
10392
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;
10393
10929
  };
10394
10930
  header?: never;
10395
10931
  path: {
@@ -10459,6 +10995,11 @@ export interface paths {
10459
10995
  * @example directHits
10460
10996
  */
10461
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;
10462
11003
  };
10463
11004
  header?: never;
10464
11005
  path: {
@@ -10530,6 +11071,11 @@ export interface paths {
10530
11071
  include?: string[];
10531
11072
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
10532
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;
10533
11079
  };
10534
11080
  header?: never;
10535
11081
  path: {
@@ -10657,11 +11203,16 @@ export interface paths {
10657
11203
  query: {
10658
11204
  /**
10659
11205
  * @description Allows the client to customize which related resources should be returned. Available options: owners, sharedResources
10660
- * @example owners
11206
+ * @example sharedResources
10661
11207
  */
10662
11208
  include?: string[];
10663
11209
  /** @description A share code (e.g. `xyz`) */
10664
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;
10665
11216
  };
10666
11217
  header?: never;
10667
11218
  path?: never;
@@ -10752,9 +11303,14 @@ export interface paths {
10752
11303
  query?: {
10753
11304
  /**
10754
11305
  * @description Allows the client to customize which related resources should be returned. Available options: owners, sharedResources
10755
- * @example owners
11306
+ * @example sharedResources
10756
11307
  */
10757
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;
10758
11314
  };
10759
11315
  header?: never;
10760
11316
  path: {
@@ -10877,6 +11433,11 @@ export interface paths {
10877
11433
  * @example sharedResources
10878
11434
  */
10879
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;
10880
11441
  };
10881
11442
  header?: never;
10882
11443
  path: {
@@ -11483,18 +12044,57 @@ export interface paths {
11483
12044
  patch?: never;
11484
12045
  trace?: never;
11485
12046
  };
11486
- "/temporaryUserTokens": {
12047
+ "/subscriptionPriceChangeDecisions": {
11487
12048
  parameters: {
11488
12049
  query?: never;
11489
12050
  header?: never;
11490
12051
  path?: never;
11491
12052
  cookie?: never;
11492
12053
  };
11493
- get?: never;
12054
+ /**
12055
+ * Get multiple subscriptionPriceChangeDecisions.
12056
+ * @description Retrieves multiple subscriptionPriceChangeDecisions by available filters, or without if applicable.
12057
+ */
12058
+ get: {
12059
+ parameters: {
12060
+ query: {
12061
+ /**
12062
+ * @description Allows the client to customize which related resources should be returned. Available options: priceChange
12063
+ * @example priceChange
12064
+ */
12065
+ include?: string[];
12066
+ /** @description User id. Use `me` for the authenticated user */
12067
+ "filter[owners.id]": string[];
12068
+ };
12069
+ header?: never;
12070
+ path?: never;
12071
+ cookie?: never;
12072
+ };
12073
+ requestBody?: never;
12074
+ responses: {
12075
+ /** @description Successful response */
12076
+ 200: {
12077
+ headers: {
12078
+ [name: string]: unknown;
12079
+ };
12080
+ content: {
12081
+ "application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisions_Multi_Resource_Data_Document"];
12082
+ };
12083
+ };
12084
+ 400: components["responses"]["Default400Response"];
12085
+ 404: components["responses"]["Default404Response"];
12086
+ 405: components["responses"]["Default405Response"];
12087
+ 406: components["responses"]["Default406Response"];
12088
+ 415: components["responses"]["Default415Response"];
12089
+ 429: components["responses"]["Default429Response"];
12090
+ 500: components["responses"]["Default500Response"];
12091
+ 503: components["responses"]["Default503Response"];
12092
+ };
12093
+ };
11494
12094
  put?: never;
11495
12095
  /**
11496
- * Create single temporaryUserToken.
11497
- * @description Creates a new temporaryUserToken.
12096
+ * Create single subscriptionPriceChangeDecision.
12097
+ * @description Creates a new subscriptionPriceChangeDecision.
11498
12098
  */
11499
12099
  post: {
11500
12100
  parameters: {
@@ -11508,7 +12108,7 @@ export interface paths {
11508
12108
  };
11509
12109
  requestBody?: {
11510
12110
  content: {
11511
- "application/vnd.api+json": components["schemas"]["TemporaryUserTokensCreateOperation_Payload"];
12111
+ "application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisionsCreateOperation_Payload"];
11512
12112
  };
11513
12113
  };
11514
12114
  responses: {
@@ -11518,7 +12118,7 @@ export interface paths {
11518
12118
  [name: string]: unknown;
11519
12119
  };
11520
12120
  content: {
11521
- "application/vnd.api+json": components["schemas"]["TemporaryUserTokens_Single_Resource_Data_Document"];
12121
+ "application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisions_Single_Resource_Data_Document"];
11522
12122
  };
11523
12123
  };
11524
12124
  400: components["responses"]["Default400Response"];
@@ -11539,37 +12139,44 @@ export interface paths {
11539
12139
  patch?: never;
11540
12140
  trace?: never;
11541
12141
  };
11542
- "/temporaryUserTokens/{id}": {
12142
+ "/subscriptionPriceChangeDecisions/{id}": {
11543
12143
  parameters: {
11544
12144
  query?: never;
11545
12145
  header?: never;
11546
12146
  path?: never;
11547
12147
  cookie?: never;
11548
12148
  };
12149
+ get?: never;
12150
+ put?: never;
12151
+ post?: never;
12152
+ delete?: never;
12153
+ options?: never;
12154
+ head?: never;
11549
12155
  /**
11550
- * Get single temporaryUserToken.
11551
- * @description Retrieves single temporaryUserToken by id.
12156
+ * Update single subscriptionPriceChangeDecision.
12157
+ * @description Updates existing subscriptionPriceChangeDecision.
11552
12158
  */
11553
- get: {
12159
+ patch: {
11554
12160
  parameters: {
11555
- query?: {
11556
- /**
11557
- * @description Allows the client to customize which related resources should be returned. Available options: owners
11558
- * @example owners
11559
- */
11560
- include?: string[];
12161
+ query?: never;
12162
+ header?: {
12163
+ /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */
12164
+ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
11561
12165
  };
11562
- header?: never;
11563
12166
  path: {
11564
12167
  /**
11565
- * @description Temporary user token id
11566
- * @example abc123
12168
+ * @description Price change decision id
12169
+ * @example 1AC1yHZWFAFVjnFOn8XoXA
11567
12170
  */
11568
12171
  id: string;
11569
12172
  };
11570
12173
  cookie?: never;
11571
12174
  };
11572
- requestBody?: never;
12175
+ requestBody?: {
12176
+ content: {
12177
+ "application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisionsUpdateOperation_Payload"];
12178
+ };
12179
+ };
11573
12180
  responses: {
11574
12181
  /** @description Successful response */
11575
12182
  200: {
@@ -11577,28 +12184,24 @@ export interface paths {
11577
12184
  [name: string]: unknown;
11578
12185
  };
11579
12186
  content: {
11580
- "application/vnd.api+json": components["schemas"]["TemporaryUserTokens_Single_Resource_Data_Document"];
12187
+ "application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisions_Single_Resource_Data_Document"];
11581
12188
  };
11582
12189
  };
11583
12190
  400: components["responses"]["Default400Response"];
11584
12191
  404: components["responses"]["Default404Response"];
11585
12192
  405: components["responses"]["Default405Response"];
11586
12193
  406: components["responses"]["Default406Response"];
12194
+ 409: components["responses"]["Idempotency409Response"];
11587
12195
  415: components["responses"]["Default415Response"];
12196
+ 422: components["responses"]["Idempotency422Response"];
11588
12197
  429: components["responses"]["Default429Response"];
11589
12198
  500: components["responses"]["Default500Response"];
11590
12199
  503: components["responses"]["Default503Response"];
11591
12200
  };
11592
12201
  };
11593
- put?: never;
11594
- post?: never;
11595
- delete?: never;
11596
- options?: never;
11597
- head?: never;
11598
- patch?: never;
11599
12202
  trace?: never;
11600
12203
  };
11601
- "/temporaryUserTokens/{id}/relationships/owners": {
12204
+ "/subscriptionPriceChangeDecisions/{id}/relationships/priceChange": {
11602
12205
  parameters: {
11603
12206
  query?: never;
11604
12207
  header?: never;
@@ -11606,25 +12209,23 @@ export interface paths {
11606
12209
  cookie?: never;
11607
12210
  };
11608
12211
  /**
11609
- * Get owners relationship ("to-many").
11610
- * @description Retrieves owners relationship.
12212
+ * Get priceChange relationship ("to-one").
12213
+ * @description Retrieves priceChange relationship.
11611
12214
  */
11612
12215
  get: {
11613
12216
  parameters: {
11614
12217
  query?: {
11615
12218
  /**
11616
- * @description Allows the client to customize which related resources should be returned. Available options: owners
11617
- * @example owners
12219
+ * @description Allows the client to customize which related resources should be returned. Available options: priceChange
12220
+ * @example priceChange
11618
12221
  */
11619
12222
  include?: string[];
11620
- /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
11621
- "page[cursor]"?: string;
11622
12223
  };
11623
12224
  header?: never;
11624
12225
  path: {
11625
12226
  /**
11626
- * @description Temporary user token id
11627
- * @example abc123
12227
+ * @description Price change decision id
12228
+ * @example 1AC1yHZWFAFVjnFOn8XoXA
11628
12229
  */
11629
12230
  id: string;
11630
12231
  };
@@ -11638,7 +12239,7 @@ export interface paths {
11638
12239
  [name: string]: unknown;
11639
12240
  };
11640
12241
  content: {
11641
- "application/vnd.api+json": components["schemas"]["TemporaryUserTokens_Multi_Relationship_Data_Document"];
12242
+ "application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisions_Single_Relationship_Data_Document"];
11642
12243
  };
11643
12244
  };
11644
12245
  400: components["responses"]["Default400Response"];
@@ -11659,32 +12260,208 @@ export interface paths {
11659
12260
  patch?: never;
11660
12261
  trace?: never;
11661
12262
  };
11662
- "/terms": {
12263
+ "/temporaryUserTokens": {
11663
12264
  parameters: {
11664
12265
  query?: never;
11665
12266
  header?: never;
11666
12267
  path?: never;
11667
12268
  cookie?: never;
11668
12269
  };
12270
+ get?: never;
12271
+ put?: never;
11669
12272
  /**
11670
- * Get multiple terms.
11671
- * @description Retrieves multiple terms by available filters, or without if applicable.
12273
+ * Create single temporaryUserToken.
12274
+ * @description Creates a new temporaryUserToken.
11672
12275
  */
11673
- get: {
12276
+ post: {
11674
12277
  parameters: {
11675
- query: {
11676
- /** @description Filter by countryCode */
11677
- "filter[countryCode]"?: string[];
11678
- /** @description Filter by isLatestVersion */
11679
- "filter[isLatestVersion]"?: string[];
11680
- /** @description One of: DEVELOPER, UPLOAD_MARKETPLACE (e.g. `DEVELOPER`) */
11681
- "filter[termsType]": ("DEVELOPER" | "UPLOAD_MARKETPLACE")[];
12278
+ query?: never;
12279
+ header?: {
12280
+ /** @description Unique idempotency key for safe retry of mutation requests. If a duplicate key is sent with the same payload, the original response is replayed. If the payload differs, a 422 error is returned. */
12281
+ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
11682
12282
  };
11683
- header?: never;
11684
12283
  path?: never;
11685
12284
  cookie?: never;
11686
12285
  };
11687
- requestBody?: never;
12286
+ requestBody?: {
12287
+ content: {
12288
+ "application/vnd.api+json": components["schemas"]["TemporaryUserTokensCreateOperation_Payload"];
12289
+ };
12290
+ };
12291
+ responses: {
12292
+ /** @description Successful response */
12293
+ 201: {
12294
+ headers: {
12295
+ [name: string]: unknown;
12296
+ };
12297
+ content: {
12298
+ "application/vnd.api+json": components["schemas"]["TemporaryUserTokens_Single_Resource_Data_Document"];
12299
+ };
12300
+ };
12301
+ 400: components["responses"]["Default400Response"];
12302
+ 404: components["responses"]["Default404Response"];
12303
+ 405: components["responses"]["Default405Response"];
12304
+ 406: components["responses"]["Default406Response"];
12305
+ 409: components["responses"]["Idempotency409Response"];
12306
+ 415: components["responses"]["Default415Response"];
12307
+ 422: components["responses"]["Idempotency422Response"];
12308
+ 429: components["responses"]["Default429Response"];
12309
+ 500: components["responses"]["Default500Response"];
12310
+ 503: components["responses"]["Default503Response"];
12311
+ };
12312
+ };
12313
+ delete?: never;
12314
+ options?: never;
12315
+ head?: never;
12316
+ patch?: never;
12317
+ trace?: never;
12318
+ };
12319
+ "/temporaryUserTokens/{id}": {
12320
+ parameters: {
12321
+ query?: never;
12322
+ header?: never;
12323
+ path?: never;
12324
+ cookie?: never;
12325
+ };
12326
+ /**
12327
+ * Get single temporaryUserToken.
12328
+ * @description Retrieves single temporaryUserToken by id.
12329
+ */
12330
+ get: {
12331
+ parameters: {
12332
+ query?: {
12333
+ /**
12334
+ * @description Allows the client to customize which related resources should be returned. Available options: owners
12335
+ * @example owners
12336
+ */
12337
+ include?: string[];
12338
+ };
12339
+ header?: never;
12340
+ path: {
12341
+ /**
12342
+ * @description Temporary user token id
12343
+ * @example abc123
12344
+ */
12345
+ id: string;
12346
+ };
12347
+ cookie?: never;
12348
+ };
12349
+ requestBody?: never;
12350
+ responses: {
12351
+ /** @description Successful response */
12352
+ 200: {
12353
+ headers: {
12354
+ [name: string]: unknown;
12355
+ };
12356
+ content: {
12357
+ "application/vnd.api+json": components["schemas"]["TemporaryUserTokens_Single_Resource_Data_Document"];
12358
+ };
12359
+ };
12360
+ 400: components["responses"]["Default400Response"];
12361
+ 404: components["responses"]["Default404Response"];
12362
+ 405: components["responses"]["Default405Response"];
12363
+ 406: components["responses"]["Default406Response"];
12364
+ 415: components["responses"]["Default415Response"];
12365
+ 429: components["responses"]["Default429Response"];
12366
+ 500: components["responses"]["Default500Response"];
12367
+ 503: components["responses"]["Default503Response"];
12368
+ };
12369
+ };
12370
+ put?: never;
12371
+ post?: never;
12372
+ delete?: never;
12373
+ options?: never;
12374
+ head?: never;
12375
+ patch?: never;
12376
+ trace?: never;
12377
+ };
12378
+ "/temporaryUserTokens/{id}/relationships/owners": {
12379
+ parameters: {
12380
+ query?: never;
12381
+ header?: never;
12382
+ path?: never;
12383
+ cookie?: never;
12384
+ };
12385
+ /**
12386
+ * Get owners relationship ("to-many").
12387
+ * @description Retrieves owners relationship.
12388
+ */
12389
+ get: {
12390
+ parameters: {
12391
+ query?: {
12392
+ /**
12393
+ * @description Allows the client to customize which related resources should be returned. Available options: owners
12394
+ * @example owners
12395
+ */
12396
+ include?: string[];
12397
+ /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
12398
+ "page[cursor]"?: string;
12399
+ };
12400
+ header?: never;
12401
+ path: {
12402
+ /**
12403
+ * @description Temporary user token id
12404
+ * @example abc123
12405
+ */
12406
+ id: string;
12407
+ };
12408
+ cookie?: never;
12409
+ };
12410
+ requestBody?: never;
12411
+ responses: {
12412
+ /** @description Successful response */
12413
+ 200: {
12414
+ headers: {
12415
+ [name: string]: unknown;
12416
+ };
12417
+ content: {
12418
+ "application/vnd.api+json": components["schemas"]["TemporaryUserTokens_Multi_Relationship_Data_Document"];
12419
+ };
12420
+ };
12421
+ 400: components["responses"]["Default400Response"];
12422
+ 404: components["responses"]["Default404Response"];
12423
+ 405: components["responses"]["Default405Response"];
12424
+ 406: components["responses"]["Default406Response"];
12425
+ 415: components["responses"]["Default415Response"];
12426
+ 429: components["responses"]["Default429Response"];
12427
+ 500: components["responses"]["Default500Response"];
12428
+ 503: components["responses"]["Default503Response"];
12429
+ };
12430
+ };
12431
+ put?: never;
12432
+ post?: never;
12433
+ delete?: never;
12434
+ options?: never;
12435
+ head?: never;
12436
+ patch?: never;
12437
+ trace?: never;
12438
+ };
12439
+ "/terms": {
12440
+ parameters: {
12441
+ query?: never;
12442
+ header?: never;
12443
+ path?: never;
12444
+ cookie?: never;
12445
+ };
12446
+ /**
12447
+ * Get multiple terms.
12448
+ * @description Retrieves multiple terms by available filters, or without if applicable.
12449
+ */
12450
+ get: {
12451
+ parameters: {
12452
+ query: {
12453
+ /** @description Filter by countryCode */
12454
+ "filter[countryCode]"?: string[];
12455
+ /** @description Filter by isLatestVersion */
12456
+ "filter[isLatestVersion]"?: string[];
12457
+ /** @description One of: DEVELOPER, UPLOAD_MARKETPLACE (e.g. `DEVELOPER`) */
12458
+ "filter[termsType]": ("DEVELOPER" | "UPLOAD_MARKETPLACE")[];
12459
+ };
12460
+ header?: never;
12461
+ path?: never;
12462
+ cookie?: never;
12463
+ };
12464
+ requestBody?: never;
11688
12465
  responses: {
11689
12466
  /** @description Successful response */
11690
12467
  200: {
@@ -12077,6 +12854,11 @@ export interface paths {
12077
12854
  get: {
12078
12855
  parameters: {
12079
12856
  query?: {
12857
+ /**
12858
+ * @description ISO 3166-1 alpha-2 country code
12859
+ * @example US
12860
+ */
12861
+ countryCode?: string;
12080
12862
  /**
12081
12863
  * @description Allows the client to customize which related resources should be returned. Available options: owners
12082
12864
  * @example owners
@@ -12136,6 +12918,11 @@ export interface paths {
12136
12918
  get: {
12137
12919
  parameters: {
12138
12920
  query?: {
12921
+ /**
12922
+ * @description ISO 3166-1 alpha-2 country code
12923
+ * @example US
12924
+ */
12925
+ countryCode?: string;
12139
12926
  /**
12140
12927
  * @description Allows the client to customize which related resources should be returned. Available options: owners
12141
12928
  * @example owners
@@ -12217,6 +13004,11 @@ export interface paths {
12217
13004
  "filter[isrc]"?: string[];
12218
13005
  /** @description User id. Use `me` for the authenticated user */
12219
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;
12220
13012
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
12221
13013
  shareCode?: string;
12222
13014
  };
@@ -12317,6 +13109,11 @@ export interface paths {
12317
13109
  * @example albums
12318
13110
  */
12319
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;
12320
13117
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
12321
13118
  shareCode?: string;
12322
13119
  };
@@ -12455,6 +13252,11 @@ export interface paths {
12455
13252
  include?: string[];
12456
13253
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
12457
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;
12458
13260
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
12459
13261
  shareCode?: string;
12460
13262
  };
@@ -12557,9 +13359,14 @@ export interface paths {
12557
13359
  countryCode?: string;
12558
13360
  /**
12559
13361
  * @description Allows the client to customize which related resources should be returned. Available options: artists
12560
- * @example artists
13362
+ * @example artists.albums
12561
13363
  */
12562
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;
12563
13370
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
12564
13371
  shareCode?: string;
12565
13372
  };
@@ -12620,9 +13427,14 @@ export interface paths {
12620
13427
  "page[cursor]"?: string;
12621
13428
  /**
12622
13429
  * @description Allows the client to customize which related resources should be returned. Available options: credits
12623
- * @example credits
13430
+ * @example credits.artist.albums
12624
13431
  */
12625
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;
12626
13438
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
12627
13439
  shareCode?: string;
12628
13440
  };
@@ -12810,11 +13622,16 @@ export interface paths {
12810
13622
  query?: {
12811
13623
  /**
12812
13624
  * @description Allows the client to customize which related resources should be returned. Available options: lyrics
12813
- * @example lyrics
13625
+ * @example lyrics.track
12814
13626
  */
12815
13627
  include?: string[];
12816
13628
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
12817
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;
12818
13635
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
12819
13636
  shareCode?: string;
12820
13637
  };
@@ -12932,6 +13749,11 @@ export interface paths {
12932
13749
  get: {
12933
13750
  parameters: {
12934
13751
  query?: {
13752
+ /**
13753
+ * @description ISO 3166-1 alpha-2 country code
13754
+ * @example US
13755
+ */
13756
+ countryCode?: string;
12935
13757
  /**
12936
13758
  * @description Allows the client to customize which related resources should be returned. Available options: owners
12937
13759
  * @example owners
@@ -13131,11 +13953,16 @@ export interface paths {
13131
13953
  query?: {
13132
13954
  /**
13133
13955
  * @description Allows the client to customize which related resources should be returned. Available options: radio
13134
- * @example radio
13956
+ * @example radio.items
13135
13957
  */
13136
13958
  include?: string[];
13137
13959
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
13138
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;
13139
13966
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
13140
13967
  shareCode?: string;
13141
13968
  };
@@ -13202,6 +14029,11 @@ export interface paths {
13202
14029
  * @example replacement
13203
14030
  */
13204
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;
13205
14037
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
13206
14038
  shareCode?: string;
13207
14039
  };
@@ -13260,11 +14092,16 @@ export interface paths {
13260
14092
  query?: {
13261
14093
  /**
13262
14094
  * @description Allows the client to customize which related resources should be returned. Available options: shares
13263
- * @example shares
14095
+ * @example shares.sharedResources
13264
14096
  */
13265
14097
  include?: string[];
13266
14098
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
13267
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;
13268
14105
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
13269
14106
  shareCode?: string;
13270
14107
  };
@@ -13333,6 +14170,11 @@ export interface paths {
13333
14170
  * @example similarTracks
13334
14171
  */
13335
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;
13336
14178
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
13337
14179
  shareCode?: string;
13338
14180
  };
@@ -13462,6 +14304,11 @@ export interface paths {
13462
14304
  * @example suggestedTracks
13463
14305
  */
13464
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;
13465
14312
  /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
13466
14313
  shareCode?: string;
13467
14314
  };
@@ -13817,6 +14664,11 @@ export interface paths {
13817
14664
  * @example items
13818
14665
  */
13819
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;
13820
14672
  };
13821
14673
  header?: never;
13822
14674
  path: {
@@ -13885,6 +14737,11 @@ export interface paths {
13885
14737
  * @example items
13886
14738
  */
13887
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;
13888
14745
  };
13889
14746
  header?: never;
13890
14747
  path: {
@@ -14090,9 +14947,14 @@ export interface paths {
14090
14947
  locale?: string;
14091
14948
  /**
14092
14949
  * @description Allows the client to customize which related resources should be returned. Available options: items, owners
14093
- * @example items
14950
+ * @example items.albums
14094
14951
  */
14095
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;
14096
14958
  };
14097
14959
  header?: never;
14098
14960
  path: {
@@ -14158,9 +15020,14 @@ export interface paths {
14158
15020
  locale?: string;
14159
15021
  /**
14160
15022
  * @description Allows the client to customize which related resources should be returned. Available options: items
14161
- * @example items
15023
+ * @example items.albums
14162
15024
  */
14163
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;
14164
15031
  };
14165
15032
  header?: never;
14166
15033
  path: {
@@ -14361,11 +15228,16 @@ export interface paths {
14361
15228
  query: {
14362
15229
  /**
14363
15230
  * @description Allows the client to customize which related resources should be returned. Available options: items, owners, userCollection
14364
- * @example items
15231
+ * @example items.items
14365
15232
  */
14366
15233
  include?: string[];
14367
15234
  /** @description Folder Id (e.g. `CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX`) */
14368
15235
  "filter[id]": string[];
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;
14369
15241
  };
14370
15242
  header?: never;
14371
15243
  path?: never;
@@ -14456,9 +15328,14 @@ export interface paths {
14456
15328
  query?: {
14457
15329
  /**
14458
15330
  * @description Allows the client to customize which related resources should be returned. Available options: items, owners, userCollection
14459
- * @example items
15331
+ * @example items.items
14460
15332
  */
14461
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;
14462
15339
  };
14463
15340
  header?: never;
14464
15341
  path: {
@@ -14589,9 +15466,14 @@ export interface paths {
14589
15466
  sort?: ("addedAt" | "-addedAt" | "lastModifiedAt" | "-lastModifiedAt" | "name" | "-name")[];
14590
15467
  /**
14591
15468
  * @description Allows the client to customize which related resources should be returned. Available options: items
14592
- * @example items
15469
+ * @example items.items
14593
15470
  */
14594
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;
14595
15477
  };
14596
15478
  header?: never;
14597
15479
  path: {
@@ -14783,9 +15665,14 @@ export interface paths {
14783
15665
  query?: {
14784
15666
  /**
14785
15667
  * @description Allows the client to customize which related resources should be returned. Available options: userCollection
14786
- * @example userCollection
15668
+ * @example userCollection.items.items
14787
15669
  */
14788
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;
14789
15676
  };
14790
15677
  header?: never;
14791
15678
  path: {
@@ -14847,9 +15734,14 @@ export interface paths {
14847
15734
  locale?: string;
14848
15735
  /**
14849
15736
  * @description Allows the client to customize which related resources should be returned. Available options: items, owners
14850
- * @example items
15737
+ * @example items.items
14851
15738
  */
14852
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;
14853
15745
  };
14854
15746
  header?: never;
14855
15747
  path: {
@@ -14911,9 +15803,14 @@ export interface paths {
14911
15803
  sort?: ("addedAt" | "-addedAt" | "lastModifiedAt" | "-lastModifiedAt" | "name" | "-name")[];
14912
15804
  /**
14913
15805
  * @description Allows the client to customize which related resources should be returned. Available options: items
14914
- * @example items
15806
+ * @example items.items
14915
15807
  */
14916
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;
14917
15814
  };
14918
15815
  header?: never;
14919
15816
  path: {
@@ -15117,6 +16014,11 @@ export interface paths {
15117
16014
  * @example items
15118
16015
  */
15119
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;
15120
16022
  };
15121
16023
  header?: never;
15122
16024
  path: {
@@ -15178,6 +16080,11 @@ export interface paths {
15178
16080
  * @example items
15179
16081
  */
15180
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;
15181
16088
  };
15182
16089
  header?: never;
15183
16090
  path: {
@@ -15386,6 +16293,11 @@ export interface paths {
15386
16293
  * @example items
15387
16294
  */
15388
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;
15389
16301
  };
15390
16302
  header?: never;
15391
16303
  path: {
@@ -15454,6 +16366,11 @@ export interface paths {
15454
16366
  * @example items
15455
16367
  */
15456
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;
15457
16374
  };
15458
16375
  header?: never;
15459
16376
  path: {
@@ -15662,6 +16579,11 @@ export interface paths {
15662
16579
  * @example items
15663
16580
  */
15664
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;
15665
16587
  };
15666
16588
  header?: never;
15667
16589
  path: {
@@ -15730,6 +16652,11 @@ export interface paths {
15730
16652
  * @example items
15731
16653
  */
15732
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;
15733
16660
  };
15734
16661
  header?: never;
15735
16662
  path: {
@@ -15939,6 +16866,11 @@ export interface paths {
15939
16866
  * @example albums
15940
16867
  */
15941
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;
15942
16874
  };
15943
16875
  header?: never;
15944
16876
  path: {
@@ -16008,6 +16940,11 @@ export interface paths {
16008
16940
  * @example albums
16009
16941
  */
16010
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;
16011
16948
  };
16012
16949
  header?: never;
16013
16950
  path: {
@@ -16150,9 +17087,14 @@ export interface paths {
16150
17087
  locale?: string;
16151
17088
  /**
16152
17089
  * @description Allows the client to customize which related resources should be returned. Available options: artists
16153
- * @example artists
17090
+ * @example artists.albums
16154
17091
  */
16155
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;
16156
17098
  };
16157
17099
  header?: never;
16158
17100
  path: {
@@ -16352,9 +17294,14 @@ export interface paths {
16352
17294
  sort?: ("playlists.addedAt" | "-playlists.addedAt" | "playlists.lastUpdatedAt" | "-playlists.lastUpdatedAt" | "playlists.name" | "-playlists.name")[];
16353
17295
  /**
16354
17296
  * @description Allows the client to customize which related resources should be returned. Available options: playlists
16355
- * @example playlists
17297
+ * @example playlists.items
16356
17298
  */
16357
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;
16358
17305
  };
16359
17306
  header?: never;
16360
17307
  path: {
@@ -16500,6 +17447,11 @@ export interface paths {
16500
17447
  * @example tracks
16501
17448
  */
16502
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;
16503
17455
  };
16504
17456
  header?: never;
16505
17457
  path: {
@@ -16645,6 +17597,11 @@ export interface paths {
16645
17597
  * @example videos
16646
17598
  */
16647
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;
16648
17605
  };
16649
17606
  header?: never;
16650
17607
  path: {
@@ -16782,9 +17739,14 @@ export interface paths {
16782
17739
  locale?: string;
16783
17740
  /**
16784
17741
  * @description Allows the client to customize which related resources should be returned. Available options: items
16785
- * @example items
17742
+ * @example items.items
16786
17743
  */
16787
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;
16788
17750
  };
16789
17751
  header?: never;
16790
17752
  path: {
@@ -16848,9 +17810,14 @@ export interface paths {
16848
17810
  locale?: string;
16849
17811
  /**
16850
17812
  * @description Allows the client to customize which related resources should be returned. Available options: items
16851
- * @example items
17813
+ * @example items.items
16852
17814
  */
16853
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;
16854
17821
  };
16855
17822
  header?: never;
16856
17823
  path: {
@@ -16968,9 +17935,14 @@ export interface paths {
16968
17935
  locale?: string;
16969
17936
  /**
16970
17937
  * @description Allows the client to customize which related resources should be returned. Available options: items
16971
- * @example items
17938
+ * @example items.items
16972
17939
  */
16973
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;
16974
17946
  };
16975
17947
  header?: never;
16976
17948
  path: {
@@ -17034,9 +18006,14 @@ export interface paths {
17034
18006
  locale?: string;
17035
18007
  /**
17036
18008
  * @description Allows the client to customize which related resources should be returned. Available options: items
17037
- * @example items
18009
+ * @example items.items
17038
18010
  */
17039
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;
17040
18017
  };
17041
18018
  header?: never;
17042
18019
  path: {
@@ -17098,9 +18075,14 @@ export interface paths {
17098
18075
  locale?: string;
17099
18076
  /**
17100
18077
  * @description Allows the client to customize which related resources should be returned. Available options: items
17101
- * @example items
18078
+ * @example items.items
17102
18079
  */
17103
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;
17104
18086
  };
17105
18087
  header?: never;
17106
18088
  path: {
@@ -17164,9 +18146,14 @@ export interface paths {
17164
18146
  locale?: string;
17165
18147
  /**
17166
18148
  * @description Allows the client to customize which related resources should be returned. Available options: items
17167
- * @example items
18149
+ * @example items.items
17168
18150
  */
17169
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;
17170
18157
  };
17171
18158
  header?: never;
17172
18159
  path: {
@@ -17228,9 +18215,14 @@ export interface paths {
17228
18215
  locale?: string;
17229
18216
  /**
17230
18217
  * @description Allows the client to customize which related resources should be returned. Available options: items
17231
- * @example items
18218
+ * @example items.items
17232
18219
  */
17233
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;
17234
18226
  };
17235
18227
  header?: never;
17236
18228
  path: {
@@ -17294,9 +18286,14 @@ export interface paths {
17294
18286
  locale?: string;
17295
18287
  /**
17296
18288
  * @description Allows the client to customize which related resources should be returned. Available options: items
17297
- * @example items
18289
+ * @example items.items
17298
18290
  */
17299
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;
17300
18297
  };
17301
18298
  header?: never;
17302
18299
  path: {
@@ -17358,9 +18355,14 @@ export interface paths {
17358
18355
  locale?: string;
17359
18356
  /**
17360
18357
  * @description Allows the client to customize which related resources should be returned. Available options: artists, owners, tracks, videos
17361
- * @example artists
18358
+ * @example artists.albums
17362
18359
  */
17363
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;
17364
18366
  };
17365
18367
  header?: never;
17366
18368
  path: {
@@ -17419,9 +18421,14 @@ export interface paths {
17419
18421
  "page[cursor]"?: string;
17420
18422
  /**
17421
18423
  * @description Allows the client to customize which related resources should be returned. Available options: artists
17422
- * @example artists
18424
+ * @example artists.albums
17423
18425
  */
17424
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;
17425
18432
  };
17426
18433
  header?: never;
17427
18434
  path: {
@@ -17627,6 +18634,11 @@ export interface paths {
17627
18634
  * @example tracks
17628
18635
  */
17629
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;
17630
18642
  };
17631
18643
  header?: never;
17632
18644
  path: {
@@ -17771,6 +18783,11 @@ export interface paths {
17771
18783
  * @example videos
17772
18784
  */
17773
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;
17774
18791
  };
17775
18792
  header?: never;
17776
18793
  path: {
@@ -17916,9 +18933,14 @@ export interface paths {
17916
18933
  locale?: string;
17917
18934
  /**
17918
18935
  * @description Allows the client to customize which related resources should be returned. Available options: discoveryMixes, myMixes, newArrivalMixes, offlineMixes
17919
- * @example discoveryMixes
18936
+ * @example discoveryMixes.items
17920
18937
  */
17921
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;
17922
18944
  };
17923
18945
  header?: never;
17924
18946
  path: {
@@ -17983,9 +19005,14 @@ export interface paths {
17983
19005
  locale?: string;
17984
19006
  /**
17985
19007
  * @description Allows the client to customize which related resources should be returned. Available options: discoveryMixes
17986
- * @example discoveryMixes
19008
+ * @example discoveryMixes.items
17987
19009
  */
17988
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;
17989
19016
  };
17990
19017
  header?: never;
17991
19018
  path: {
@@ -18050,9 +19077,14 @@ export interface paths {
18050
19077
  locale?: string;
18051
19078
  /**
18052
19079
  * @description Allows the client to customize which related resources should be returned. Available options: myMixes
18053
- * @example myMixes
19080
+ * @example myMixes.items
18054
19081
  */
18055
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;
18056
19088
  };
18057
19089
  header?: never;
18058
19090
  path: {
@@ -18117,9 +19149,14 @@ export interface paths {
18117
19149
  locale?: string;
18118
19150
  /**
18119
19151
  * @description Allows the client to customize which related resources should be returned. Available options: newArrivalMixes
18120
- * @example newArrivalMixes
19152
+ * @example newArrivalMixes.items
18121
19153
  */
18122
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;
18123
19160
  };
18124
19161
  header?: never;
18125
19162
  path: {
@@ -18184,9 +19221,14 @@ export interface paths {
18184
19221
  locale?: string;
18185
19222
  /**
18186
19223
  * @description Allows the client to customize which related resources should be returned. Available options: offlineMixes
18187
- * @example offlineMixes
19224
+ * @example offlineMixes.items
18188
19225
  */
18189
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;
18190
19232
  };
18191
19233
  header?: never;
18192
19234
  path: {
@@ -18283,6 +19325,120 @@ export interface paths {
18283
19325
  patch?: never;
18284
19326
  trace?: never;
18285
19327
  };
19328
+ "/userSubscriptionPriceChanges": {
19329
+ parameters: {
19330
+ query?: never;
19331
+ header?: never;
19332
+ path?: never;
19333
+ cookie?: never;
19334
+ };
19335
+ /**
19336
+ * Get multiple userSubscriptionPriceChanges.
19337
+ * @description Retrieves multiple userSubscriptionPriceChanges by available filters, or without if applicable.
19338
+ */
19339
+ get: {
19340
+ parameters: {
19341
+ query: {
19342
+ /**
19343
+ * @description Allows the client to customize which related resources should be returned. Available options: decision
19344
+ * @example decision
19345
+ */
19346
+ include?: string[];
19347
+ /** @description User id. Use `me` for the authenticated user */
19348
+ "filter[owners.id]": string[];
19349
+ };
19350
+ header?: never;
19351
+ path?: never;
19352
+ cookie?: never;
19353
+ };
19354
+ requestBody?: never;
19355
+ responses: {
19356
+ /** @description Successful response */
19357
+ 200: {
19358
+ headers: {
19359
+ [name: string]: unknown;
19360
+ };
19361
+ content: {
19362
+ "application/vnd.api+json": components["schemas"]["UserSubscriptionPriceChanges_Multi_Resource_Data_Document"];
19363
+ };
19364
+ };
19365
+ 400: components["responses"]["Default400Response"];
19366
+ 404: components["responses"]["Default404Response"];
19367
+ 405: components["responses"]["Default405Response"];
19368
+ 406: components["responses"]["Default406Response"];
19369
+ 415: components["responses"]["Default415Response"];
19370
+ 429: components["responses"]["Default429Response"];
19371
+ 500: components["responses"]["Default500Response"];
19372
+ 503: components["responses"]["Default503Response"];
19373
+ };
19374
+ };
19375
+ put?: never;
19376
+ post?: never;
19377
+ delete?: never;
19378
+ options?: never;
19379
+ head?: never;
19380
+ patch?: never;
19381
+ trace?: never;
19382
+ };
19383
+ "/userSubscriptionPriceChanges/{id}/relationships/decision": {
19384
+ parameters: {
19385
+ query?: never;
19386
+ header?: never;
19387
+ path?: never;
19388
+ cookie?: never;
19389
+ };
19390
+ /**
19391
+ * Get decision relationship ("to-one").
19392
+ * @description Retrieves decision relationship.
19393
+ */
19394
+ get: {
19395
+ parameters: {
19396
+ query?: {
19397
+ /**
19398
+ * @description Allows the client to customize which related resources should be returned. Available options: decision
19399
+ * @example decision
19400
+ */
19401
+ include?: string[];
19402
+ };
19403
+ header?: never;
19404
+ path: {
19405
+ /**
19406
+ * @description Price change id
19407
+ * @example 1AC1yHZWFAFVjnFOn8XoXA
19408
+ */
19409
+ id: string;
19410
+ };
19411
+ cookie?: never;
19412
+ };
19413
+ requestBody?: never;
19414
+ responses: {
19415
+ /** @description Successful response */
19416
+ 200: {
19417
+ headers: {
19418
+ [name: string]: unknown;
19419
+ };
19420
+ content: {
19421
+ "application/vnd.api+json": components["schemas"]["UserSubscriptionPriceChanges_Single_Relationship_Data_Document"];
19422
+ };
19423
+ };
19424
+ 400: components["responses"]["Default400Response"];
19425
+ 404: components["responses"]["Default404Response"];
19426
+ 405: components["responses"]["Default405Response"];
19427
+ 406: components["responses"]["Default406Response"];
19428
+ 415: components["responses"]["Default415Response"];
19429
+ 429: components["responses"]["Default429Response"];
19430
+ 500: components["responses"]["Default500Response"];
19431
+ 503: components["responses"]["Default503Response"];
19432
+ };
19433
+ };
19434
+ put?: never;
19435
+ post?: never;
19436
+ delete?: never;
19437
+ options?: never;
19438
+ head?: never;
19439
+ patch?: never;
19440
+ trace?: never;
19441
+ };
18286
19442
  "/users/{id}": {
18287
19443
  parameters: {
18288
19444
  query?: never;
@@ -18421,6 +19577,11 @@ export interface paths {
18421
19577
  "filter[id]"?: string[];
18422
19578
  /** @description List of ISRCs (e.g. `QMJMT1701237`) */
18423
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;
18424
19585
  };
18425
19586
  header?: never;
18426
19587
  path?: never;
@@ -18479,6 +19640,11 @@ export interface paths {
18479
19640
  * @example albums
18480
19641
  */
18481
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;
18482
19648
  };
18483
19649
  header?: never;
18484
19650
  path: {
@@ -18545,6 +19711,11 @@ export interface paths {
18545
19711
  * @example albums
18546
19712
  */
18547
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;
18548
19719
  };
18549
19720
  header?: never;
18550
19721
  path: {
@@ -18608,9 +19779,14 @@ export interface paths {
18608
19779
  countryCode?: string;
18609
19780
  /**
18610
19781
  * @description Allows the client to customize which related resources should be returned. Available options: artists
18611
- * @example artists
19782
+ * @example artists.albums
18612
19783
  */
18613
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;
18614
19790
  };
18615
19791
  header?: never;
18616
19792
  path: {
@@ -18669,9 +19845,14 @@ export interface paths {
18669
19845
  "page[cursor]"?: string;
18670
19846
  /**
18671
19847
  * @description Allows the client to customize which related resources should be returned. Available options: credits
18672
- * @example credits
19848
+ * @example credits.artist.albums
18673
19849
  */
18674
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;
18675
19856
  };
18676
19857
  header?: never;
18677
19858
  path: {
@@ -18802,6 +19983,11 @@ export interface paths {
18802
19983
  * @example replacement
18803
19984
  */
18804
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;
18805
19991
  };
18806
19992
  header?: never;
18807
19993
  path: {
@@ -18868,6 +20054,11 @@ export interface paths {
18868
20054
  * @example similarVideos
18869
20055
  */
18870
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;
18871
20062
  };
18872
20063
  header?: never;
18873
20064
  path: {
@@ -18934,6 +20125,11 @@ export interface paths {
18934
20125
  * @example suggestedVideos
18935
20126
  */
18936
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;
18937
20133
  };
18938
20134
  header?: never;
18939
20135
  path: {
@@ -19440,6 +20636,7 @@ export interface components {
19440
20636
  };
19441
20637
  Albums_Items_Resource_Identifier_Meta: {
19442
20638
  itemCursor?: string;
20639
+ replacement?: components["schemas"]["Replacement_Provenance"];
19443
20640
  /**
19444
20641
  * Format: int32
19445
20642
  * @description track number
@@ -19472,12 +20669,33 @@ export interface components {
19472
20669
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
19473
20670
  priceConfig?: components["schemas"]["Single_Relationship_Data_Document"];
19474
20671
  providers?: components["schemas"]["Multi_Relationship_Data_Document"];
19475
- replacement?: components["schemas"]["Single_Relationship_Data_Document"];
20672
+ replacement?: components["schemas"]["Albums_Replacement_Single_Relationship_Data_Document"];
19476
20673
  shares?: components["schemas"]["Multi_Relationship_Data_Document"];
19477
- similarAlbums?: components["schemas"]["Multi_Relationship_Data_Document"];
20674
+ similarAlbums?: components["schemas"]["Albums_SimilarAlbums_Multi_Relationship_Data_Document"];
19478
20675
  suggestedCoverArts?: components["schemas"]["Albums_SuggestedCoverArts_Multi_Relationship_Data_Document"];
19479
20676
  usageRules?: components["schemas"]["Single_Relationship_Data_Document"];
19480
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
+ };
19481
20699
  Albums_Resource_Object: {
19482
20700
  attributes?: components["schemas"]["Albums_Attributes"];
19483
20701
  /**
@@ -19492,6 +20710,27 @@ export interface components {
19492
20710
  */
19493
20711
  type: "albums";
19494
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
+ };
19495
20734
  Albums_Single_Relationship_Data_Document: {
19496
20735
  data?: components["schemas"]["Resource_Identifier"] | (never | null);
19497
20736
  included?: components["schemas"]["Included"];
@@ -19864,6 +21103,27 @@ export interface components {
19864
21103
  ArtistsUpdateOperation_Payload_Meta: {
19865
21104
  dryRun?: boolean;
19866
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
+ };
19867
21127
  Artists_Attributes: {
19868
21128
  /**
19869
21129
  * @description Is the artist enabled for contributions?
@@ -19970,7 +21230,7 @@ export interface components {
19970
21230
  links: components["schemas"]["Links"];
19971
21231
  };
19972
21232
  Artists_Relationships: {
19973
- albums?: components["schemas"]["Multi_Relationship_Data_Document"];
21233
+ albums?: components["schemas"]["Artists_Albums_Multi_Relationship_Data_Document"];
19974
21234
  biography?: components["schemas"]["Single_Relationship_Data_Document"];
19975
21235
  claimStatus?: components["schemas"]["Single_Relationship_Data_Document"];
19976
21236
  followers?: components["schemas"]["Artists_Followers_Multi_Relationship_Data_Document"];
@@ -19981,8 +21241,8 @@ export interface components {
19981
21241
  roles?: components["schemas"]["Multi_Relationship_Data_Document"];
19982
21242
  similarArtists?: components["schemas"]["Multi_Relationship_Data_Document"];
19983
21243
  trackProviders?: components["schemas"]["Artists_TrackProviders_Multi_Relationship_Data_Document"];
19984
- tracks?: components["schemas"]["Multi_Relationship_Data_Document"];
19985
- 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"];
19986
21246
  };
19987
21247
  Artists_Resource_Object: {
19988
21248
  attributes?: components["schemas"]["Artists_Attributes"];
@@ -20034,20 +21294,62 @@ export interface components {
20034
21294
  */
20035
21295
  numberOfTracks: number;
20036
21296
  };
20037
- /** @description Artwork files */
20038
- Artwork_File: {
20039
- /** @description Artwork file href */
20040
- href: string;
20041
- meta: components["schemas"]["Artwork_File_Meta"];
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"];
20042
21301
  };
20043
- /** @description Metadata about an artwork file */
20044
- Artwork_File_Meta: {
21302
+ Artists_Tracks_Resource_Identifier: {
20045
21303
  /**
20046
- * Format: int32
20047
- * @description Height (in pixels)
20048
- * @example 80
21304
+ * @description Resource id
21305
+ * @example 12345
20049
21306
  */
20050
- height: number;
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
+ };
21339
+ /** @description Artwork files */
21340
+ Artwork_File: {
21341
+ /** @description Artwork file href */
21342
+ href: string;
21343
+ meta: components["schemas"]["Artwork_File_Meta"];
21344
+ };
21345
+ /** @description Metadata about an artwork file */
21346
+ Artwork_File_Meta: {
21347
+ /**
21348
+ * Format: int32
21349
+ * @description Height (in pixels)
21350
+ * @example 80
21351
+ */
21352
+ height: number;
20051
21353
  /**
20052
21354
  * Format: int32
20053
21355
  * @description Width (in pixels)
@@ -20522,6 +21824,27 @@ export interface components {
20522
21824
  */
20523
21825
  status: "OPEN" | "IN_PROGRESS" | "RESOLVED" | "REJECTED";
20524
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
+ };
20525
21848
  ContentClaims_Multi_Relationship_Data_Document: {
20526
21849
  data?: components["schemas"]["Resource_Identifier"][];
20527
21850
  included?: components["schemas"]["Included"];
@@ -20533,7 +21856,7 @@ export interface components {
20533
21856
  links: components["schemas"]["Links"];
20534
21857
  };
20535
21858
  ContentClaims_Relationships: {
20536
- claimedResource?: components["schemas"]["Single_Relationship_Data_Document"];
21859
+ claimedResource?: components["schemas"]["ContentClaims_ClaimedResource_Single_Relationship_Data_Document"];
20537
21860
  claimingArtist?: components["schemas"]["Single_Relationship_Data_Document"];
20538
21861
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
20539
21862
  };
@@ -20624,7 +21947,7 @@ export interface components {
20624
21947
  };
20625
21948
  Default400ResponseBody: {
20626
21949
  errors: {
20627
- /** @example The request is malformed or invalid */
21950
+ /** @example Invalid request */
20628
21951
  detail?: string;
20629
21952
  /** @example 400 */
20630
21953
  status: string;
@@ -20632,7 +21955,7 @@ export interface components {
20632
21955
  };
20633
21956
  Default404ResponseBody: {
20634
21957
  errors: {
20635
- /** @example The requested resource was not found */
21958
+ /** @example Resource not found */
20636
21959
  detail?: string;
20637
21960
  /** @example 404 */
20638
21961
  status: string;
@@ -20640,7 +21963,7 @@ export interface components {
20640
21963
  };
20641
21964
  Default405ResponseBody: {
20642
21965
  errors: {
20643
- /** @example The HTTP method is not allowed for the requested resource */
21966
+ /** @example HTTP method not allowed */
20644
21967
  detail?: string;
20645
21968
  /** @example 405 */
20646
21969
  status: string;
@@ -20648,7 +21971,7 @@ export interface components {
20648
21971
  };
20649
21972
  Default406ResponseBody: {
20650
21973
  errors: {
20651
- /** @example A response that satisfies the content negotiation headers cannot be produced */
21974
+ /** @example No acceptable response media type */
20652
21975
  detail?: string;
20653
21976
  /** @example 406 */
20654
21977
  status: string;
@@ -20656,7 +21979,7 @@ export interface components {
20656
21979
  };
20657
21980
  Default415ResponseBody: {
20658
21981
  errors: {
20659
- /** @example Unsupported request payload media type or content encoding */
21982
+ /** @example Unsupported request media type or encoding */
20660
21983
  detail?: string;
20661
21984
  /** @example 415 */
20662
21985
  status: string;
@@ -20672,7 +21995,7 @@ export interface components {
20672
21995
  };
20673
21996
  Default500ResponseBody: {
20674
21997
  errors: {
20675
- /** @example An unexpected error was encountered */
21998
+ /** @example Internal server error */
20676
21999
  detail?: string;
20677
22000
  /** @example 500 */
20678
22001
  status: string;
@@ -20680,7 +22003,7 @@ export interface components {
20680
22003
  };
20681
22004
  Default503ResponseBody: {
20682
22005
  errors: {
20683
- /** @example Temporarily unavailable; please try again later */
22006
+ /** @example Service temporarily unavailable */
20684
22007
  detail?: string;
20685
22008
  /** @example 503 */
20686
22009
  status: string;
@@ -20751,7 +22074,7 @@ export interface components {
20751
22074
  links: components["schemas"]["Links"];
20752
22075
  };
20753
22076
  DspSharingLinks_Relationships: {
20754
- subject?: components["schemas"]["Single_Relationship_Data_Document"];
22077
+ subject?: components["schemas"]["DspSharingLinks_Subject_Single_Relationship_Data_Document"];
20755
22078
  };
20756
22079
  DspSharingLinks_Resource_Object: {
20757
22080
  attributes?: components["schemas"]["DspSharingLinks_Attributes"];
@@ -20777,20 +22100,35 @@ export interface components {
20777
22100
  included?: components["schemas"]["Included"];
20778
22101
  links: components["schemas"]["Links"];
20779
22102
  };
20780
- DynamicModules_Attributes: {
22103
+ DspSharingLinks_Subject_Resource_Identifier: {
20781
22104
  /**
20782
- * @description Rendering layout for a dynamic module. previewLayout controls the module on a dynamic page. fullViewLayout controls its view-all screen; when omitted, the module has no view-all screen. GRID means artwork-forward tiles; the client owns scroll axis and column count. LIST means detailed text-forward rows in a single column and may be a table on wide screens. COMPACT means dense rows the client may pack into multiple columns; clients should treat it as LIST in a full view. UNKNOWN is the forward-compatible default; clients should skip the module or use a safe default.
20783
- * @example LIST
20784
- * @enum {string}
22105
+ * @description Resource id
22106
+ * @example 12345
20785
22107
  */
20786
- fullViewLayout?: "GRID" | "LIST" | "COMPACT" | "UNKNOWN";
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
+ };
22124
+ DynamicModules_Attributes: {
20787
22125
  /**
20788
22126
  * @description Semantic icons the module should show. SPOTLIGHT_INFO identifies modules whose content was selected by TIDAL's editorial team.
20789
22127
  * @example SPOTLIGHT_INFO
20790
22128
  */
20791
22129
  icons: ("SPOTLIGHT_INFO" | "UNKNOWN")[];
20792
22130
  /**
20793
- * @description Rendering layout for a dynamic module. previewLayout controls the module on a dynamic page. fullViewLayout controls its view-all screen; when omitted, the module has no view-all screen. GRID means artwork-forward tiles; the client owns scroll axis and column count. LIST means detailed text-forward rows in a single column and may be a table on wide screens. COMPACT means dense rows the client may pack into multiple columns; clients should treat it as LIST in a full view. UNKNOWN is the forward-compatible default; clients should skip the module or use a safe default.
22131
+ * @description Rendering layout for a dynamic module. previewLayout controls the module on a dynamic page. viewAllLayout controls its view-all screen; when omitted, the module has no view-all screen. GRID means artwork-forward tiles; the client owns scroll axis and column count. LIST means detailed text-forward rows in a single column and may be a table on wide screens. COMPACT means dense rows the client may pack into multiple columns; clients should treat it as LIST in a full view. UNKNOWN is the forward-compatible default; clients should skip the module or use a safe default.
20794
22132
  * @example GRID
20795
22133
  * @enum {string}
20796
22134
  */
@@ -20805,6 +22143,33 @@ export interface components {
20805
22143
  * @example Shortcuts
20806
22144
  */
20807
22145
  title?: string;
22146
+ /**
22147
+ * @description Rendering layout for a dynamic module. previewLayout controls the module on a dynamic page. viewAllLayout controls its view-all screen; when omitted, the module has no view-all screen. GRID means artwork-forward tiles; the client owns scroll axis and column count. LIST means detailed text-forward rows in a single column and may be a table on wide screens. COMPACT means dense rows the client may pack into multiple columns; clients should treat it as LIST in a full view. UNKNOWN is the forward-compatible default; clients should skip the module or use a safe default.
22148
+ * @example LIST
22149
+ * @enum {string}
22150
+ */
22151
+ viewAllLayout?: "GRID" | "LIST" | "COMPACT" | "UNKNOWN";
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"];
20808
22173
  };
20809
22174
  DynamicModules_Multi_Relationship_Data_Document: {
20810
22175
  data?: components["schemas"]["Resource_Identifier"][];
@@ -20817,7 +22182,8 @@ export interface components {
20817
22182
  links: components["schemas"]["Links"];
20818
22183
  };
20819
22184
  DynamicModules_Relationships: {
20820
- items?: components["schemas"]["Multi_Relationship_Data_Document"];
22185
+ items?: components["schemas"]["DynamicModules_Items_Multi_Relationship_Data_Document"];
22186
+ seedItem?: components["schemas"]["DynamicModules_SeedItem_Single_Relationship_Data_Document"];
20821
22187
  };
20822
22188
  DynamicModules_Resource_Object: {
20823
22189
  attributes?: components["schemas"]["DynamicModules_Attributes"];
@@ -20833,6 +22199,32 @@ export interface components {
20833
22199
  */
20834
22200
  type: "dynamicModules";
20835
22201
  };
22202
+ DynamicModules_SeedItem_Resource_Identifier: {
22203
+ /**
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
+ };
20836
22228
  DynamicModules_Single_Resource_Data_Document: {
20837
22229
  data: components["schemas"]["DynamicModules_Resource_Object"];
20838
22230
  included?: components["schemas"]["Included"];
@@ -20864,7 +22256,7 @@ export interface components {
20864
22256
  };
20865
22257
  DynamicPages_Relationships: {
20866
22258
  modules?: components["schemas"]["Multi_Relationship_Data_Document"];
20867
- subject?: components["schemas"]["Single_Relationship_Data_Document"];
22259
+ subject?: components["schemas"]["DynamicPages_Subject_Single_Relationship_Data_Document"];
20868
22260
  };
20869
22261
  DynamicPages_Resource_Object: {
20870
22262
  attributes?: components["schemas"]["DynamicPages_Attributes"];
@@ -20898,6 +22290,27 @@ export interface components {
20898
22290
  included?: components["schemas"]["Included"];
20899
22291
  links: components["schemas"]["Links"];
20900
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
+ };
20901
22314
  Error_Object: {
20902
22315
  /** @description application-specific error code */
20903
22316
  code?: string;
@@ -21020,7 +22433,7 @@ export interface components {
21020
22433
  * @enum {string}
21021
22434
  */
21022
22435
  code: "IDEMPOTENT_REQUEST_IN_PROGRESS";
21023
- /** @example A request with this idempotency key is currently being processed */
22436
+ /** @example Request already in progress for this idempotency key */
21024
22437
  detail?: string;
21025
22438
  /** @example 409 */
21026
22439
  status: string;
@@ -21033,13 +22446,13 @@ export interface components {
21033
22446
  * @enum {string}
21034
22447
  */
21035
22448
  code: "IDEMPOTENT_REQUEST_PAYLOAD_MISMATCH";
21036
- /** @example Idempotency key was already used with a different request payload */
22449
+ /** @example Idempotency key reused with a different payload */
21037
22450
  detail?: string;
21038
22451
  /** @example 422 */
21039
22452
  status: string;
21040
22453
  }[];
21041
22454
  };
21042
- Included: (components["schemas"]["AcceptedTerms_Resource_Object"] | components["schemas"]["AlbumStatistics_Resource_Object"] | components["schemas"]["Albums_Resource_Object"] | components["schemas"]["Appreciations_Resource_Object"] | components["schemas"]["ArtistBiographies_Resource_Object"] | components["schemas"]["ArtistClaimStatuses_Resource_Object"] | components["schemas"]["ArtistClaims_Resource_Object"] | components["schemas"]["ArtistRoles_Resource_Object"] | components["schemas"]["Artists_Resource_Object"] | components["schemas"]["Artworks_Resource_Object"] | components["schemas"]["Clients_Resource_Object"] | components["schemas"]["CollaborationInviteRedemptions_Resource_Object"] | components["schemas"]["CollaborationInvites_Resource_Object"] | components["schemas"]["Comments_Resource_Object"] | components["schemas"]["ContentClaims_Resource_Object"] | components["schemas"]["Credits_Resource_Object"] | components["schemas"]["Downloads_Resource_Object"] | components["schemas"]["DspSharingLinks_Resource_Object"] | components["schemas"]["DynamicModules_Resource_Object"] | components["schemas"]["DynamicPages_Resource_Object"] | components["schemas"]["Genres_Resource_Object"] | components["schemas"]["Installations_Resource_Object"] | components["schemas"]["Lyrics_Resource_Object"] | components["schemas"]["ManualArtistClaims_Resource_Object"] | components["schemas"]["OfflineTasks_Resource_Object"] | components["schemas"]["PlayQueues_Resource_Object"] | components["schemas"]["Playlists_Resource_Object"] | components["schemas"]["PriceConfigurations_Resource_Object"] | components["schemas"]["ProviderOwners_Resource_Object"] | components["schemas"]["ProviderProductInfos_Resource_Object"] | components["schemas"]["Providers_Resource_Object"] | components["schemas"]["Purchases_Resource_Object"] | components["schemas"]["Reactions_Resource_Object"] | components["schemas"]["SavedShares_Resource_Object"] | components["schemas"]["Scopes_Resource_Object"] | components["schemas"]["SearchHistoryEntries_Resource_Object"] | components["schemas"]["SearchResults_Resource_Object"] | components["schemas"]["SearchSuggestions_Resource_Object"] | components["schemas"]["Shares_Resource_Object"] | components["schemas"]["SquareConnections_Resource_Object"] | components["schemas"]["SquareSites_Resource_Object"] | components["schemas"]["StripeConnections_Resource_Object"] | components["schemas"]["StripeDashboardLinks_Resource_Object"] | components["schemas"]["TemporaryUserTokens_Resource_Object"] | components["schemas"]["Terms_Resource_Object"] | components["schemas"]["TrackFiles_Resource_Object"] | components["schemas"]["TrackManifests_Resource_Object"] | components["schemas"]["TrackSourceFiles_Resource_Object"] | components["schemas"]["TrackStatistics_Resource_Object"] | components["schemas"]["Tracks_Resource_Object"] | components["schemas"]["TracksMetadataStatus_Resource_Object"] | components["schemas"]["UsageRules_Resource_Object"] | components["schemas"]["UserCollectionAlbums_Resource_Object"] | components["schemas"]["UserCollectionArtists_Resource_Object"] | components["schemas"]["UserCollectionFolders_Resource_Object"] | components["schemas"]["UserCollectionPlaylists_Resource_Object"] | components["schemas"]["UserCollectionSaveForLaters_Resource_Object"] | components["schemas"]["UserCollectionTracks_Resource_Object"] | components["schemas"]["UserCollectionVideos_Resource_Object"] | components["schemas"]["UserCollections_Resource_Object"] | components["schemas"]["UserDailyMixes_Resource_Object"] | components["schemas"]["UserDataExportRequests_Resource_Object"] | components["schemas"]["UserDiscoveryMixes_Resource_Object"] | components["schemas"]["UserNewReleaseMixes_Resource_Object"] | components["schemas"]["UserOfflineMixes_Resource_Object"] | components["schemas"]["UserRecommendationBlocks_Resource_Object"] | components["schemas"]["UserRecommendations_Resource_Object"] | components["schemas"]["UserReports_Resource_Object"] | components["schemas"]["Users_Resource_Object"] | components["schemas"]["VideoManifests_Resource_Object"] | components["schemas"]["Videos_Resource_Object"])[];
22455
+ Included: (components["schemas"]["AcceptedTerms_Resource_Object"] | components["schemas"]["AlbumStatistics_Resource_Object"] | components["schemas"]["Albums_Resource_Object"] | components["schemas"]["Appreciations_Resource_Object"] | components["schemas"]["ArtistBiographies_Resource_Object"] | components["schemas"]["ArtistClaimStatuses_Resource_Object"] | components["schemas"]["ArtistClaims_Resource_Object"] | components["schemas"]["ArtistRoles_Resource_Object"] | components["schemas"]["Artists_Resource_Object"] | components["schemas"]["Artworks_Resource_Object"] | components["schemas"]["Clients_Resource_Object"] | components["schemas"]["CollaborationInviteRedemptions_Resource_Object"] | components["schemas"]["CollaborationInvites_Resource_Object"] | components["schemas"]["Comments_Resource_Object"] | components["schemas"]["ContentClaims_Resource_Object"] | components["schemas"]["Credits_Resource_Object"] | components["schemas"]["Downloads_Resource_Object"] | components["schemas"]["DspSharingLinks_Resource_Object"] | components["schemas"]["DynamicModules_Resource_Object"] | components["schemas"]["DynamicPages_Resource_Object"] | components["schemas"]["Genres_Resource_Object"] | components["schemas"]["Installations_Resource_Object"] | components["schemas"]["Lyrics_Resource_Object"] | components["schemas"]["ManualArtistClaims_Resource_Object"] | components["schemas"]["OfflineTasks_Resource_Object"] | components["schemas"]["PlayQueues_Resource_Object"] | components["schemas"]["Playlists_Resource_Object"] | components["schemas"]["PriceConfigurations_Resource_Object"] | components["schemas"]["ProviderOwners_Resource_Object"] | components["schemas"]["ProviderProductInfos_Resource_Object"] | components["schemas"]["Providers_Resource_Object"] | components["schemas"]["Purchases_Resource_Object"] | components["schemas"]["Reactions_Resource_Object"] | components["schemas"]["SavedShares_Resource_Object"] | components["schemas"]["Scopes_Resource_Object"] | components["schemas"]["SearchHistoryEntries_Resource_Object"] | components["schemas"]["SearchResults_Resource_Object"] | components["schemas"]["SearchSuggestions_Resource_Object"] | components["schemas"]["Shares_Resource_Object"] | components["schemas"]["SquareConnections_Resource_Object"] | components["schemas"]["SquareSites_Resource_Object"] | components["schemas"]["StripeConnections_Resource_Object"] | components["schemas"]["StripeDashboardLinks_Resource_Object"] | components["schemas"]["SubscriptionPriceChangeDecisions_Resource_Object"] | components["schemas"]["TemporaryUserTokens_Resource_Object"] | components["schemas"]["Terms_Resource_Object"] | components["schemas"]["TrackFiles_Resource_Object"] | components["schemas"]["TrackManifests_Resource_Object"] | components["schemas"]["TrackSourceFiles_Resource_Object"] | components["schemas"]["TrackStatistics_Resource_Object"] | components["schemas"]["Tracks_Resource_Object"] | components["schemas"]["TracksMetadataStatus_Resource_Object"] | components["schemas"]["UsageRules_Resource_Object"] | components["schemas"]["UserCollectionAlbums_Resource_Object"] | components["schemas"]["UserCollectionArtists_Resource_Object"] | components["schemas"]["UserCollectionFolders_Resource_Object"] | components["schemas"]["UserCollectionPlaylists_Resource_Object"] | components["schemas"]["UserCollectionSaveForLaters_Resource_Object"] | components["schemas"]["UserCollectionTracks_Resource_Object"] | components["schemas"]["UserCollectionVideos_Resource_Object"] | components["schemas"]["UserCollections_Resource_Object"] | components["schemas"]["UserDailyMixes_Resource_Object"] | components["schemas"]["UserDataExportRequests_Resource_Object"] | components["schemas"]["UserDiscoveryMixes_Resource_Object"] | components["schemas"]["UserNewReleaseMixes_Resource_Object"] | components["schemas"]["UserOfflineMixes_Resource_Object"] | components["schemas"]["UserRecommendationBlocks_Resource_Object"] | components["schemas"]["UserRecommendations_Resource_Object"] | components["schemas"]["UserReports_Resource_Object"] | components["schemas"]["UserSubscriptionPriceChanges_Resource_Object"] | components["schemas"]["Users_Resource_Object"] | components["schemas"]["VideoManifests_Resource_Object"] | components["schemas"]["Videos_Resource_Object"])[];
21043
22456
  InstallationsCreateOperation_Payload: {
21044
22457
  data: components["schemas"]["InstallationsCreateOperation_Payload_Data"];
21045
22458
  };
@@ -21109,6 +22522,7 @@ export interface components {
21109
22522
  Installations_OfflineInventory_Resource_Identifier_Meta: {
21110
22523
  /** Format: date-time */
21111
22524
  addedAt: string;
22525
+ replacement?: components["schemas"]["Replacement_Provenance"];
21112
22526
  };
21113
22527
  Installations_Relationships: {
21114
22528
  offlineInventory?: components["schemas"]["Installations_OfflineInventory_Multi_Relationship_Data_Document"];
@@ -21239,7 +22653,7 @@ export interface components {
21239
22653
  };
21240
22654
  Lyrics_Relationships: {
21241
22655
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
21242
- track?: components["schemas"]["Single_Relationship_Data_Document"];
22656
+ track?: components["schemas"]["Lyrics_Track_Single_Relationship_Data_Document"];
21243
22657
  };
21244
22658
  Lyrics_Resource_Object: {
21245
22659
  attributes?: components["schemas"]["Lyrics_Attributes"];
@@ -21265,6 +22679,27 @@ export interface components {
21265
22679
  included?: components["schemas"]["Included"];
21266
22680
  links: components["schemas"]["Links"];
21267
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
+ };
21268
22703
  ManualArtistClaimsCreateOperation_Payload: {
21269
22704
  data: components["schemas"]["ManualArtistClaimsCreateOperation_Payload_Data"];
21270
22705
  };
@@ -21408,6 +22843,48 @@ export interface components {
21408
22843
  */
21409
22844
  volume: number;
21410
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
+ };
21411
22888
  OfflineTasks_Multi_Relationship_Data_Document: {
21412
22889
  data?: components["schemas"]["Resource_Identifier"][];
21413
22890
  included?: components["schemas"]["Included"];
@@ -21419,8 +22896,8 @@ export interface components {
21419
22896
  links: components["schemas"]["Links"];
21420
22897
  };
21421
22898
  OfflineTasks_Relationships: {
21422
- collection?: components["schemas"]["Single_Relationship_Data_Document"];
21423
- 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"];
21424
22901
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
21425
22902
  };
21426
22903
  OfflineTasks_Resource_Object: {
@@ -21573,6 +23050,7 @@ export interface components {
21573
23050
  batchId: string;
21574
23051
  itemId: string;
21575
23052
  legacySource?: components["schemas"]["LegacySource"];
23053
+ replacement?: components["schemas"]["Replacement_Provenance"];
21576
23054
  };
21577
23055
  PlayQueues_Current_Single_Relationship_Data_Document: {
21578
23056
  data?: components["schemas"]["PlayQueues_Current_Resource_Identifier"] | (never | null);
@@ -21602,6 +23080,7 @@ export interface components {
21602
23080
  batchId: string;
21603
23081
  itemId: string;
21604
23082
  legacySource?: components["schemas"]["LegacySource"];
23083
+ replacement?: components["schemas"]["Replacement_Provenance"];
21605
23084
  };
21606
23085
  PlayQueues_Multi_Relationship_Data_Document: {
21607
23086
  data?: components["schemas"]["Resource_Identifier"][];
@@ -21636,6 +23115,7 @@ export interface components {
21636
23115
  batchId: string;
21637
23116
  itemId: string;
21638
23117
  legacySource?: components["schemas"]["LegacySource"];
23118
+ replacement?: components["schemas"]["Replacement_Provenance"];
21639
23119
  };
21640
23120
  PlayQueues_Relationships: {
21641
23121
  current?: components["schemas"]["PlayQueues_Current_Single_Relationship_Data_Document"];
@@ -21843,6 +23323,7 @@ export interface components {
21843
23323
  addedAt?: string;
21844
23324
  itemCursor?: string;
21845
23325
  itemId?: string;
23326
+ replacement?: components["schemas"]["Replacement_Provenance"];
21846
23327
  };
21847
23328
  Playlists_Multi_Relationship_Data_Document: {
21848
23329
  data?: components["schemas"]["Resource_Identifier"][];
@@ -22030,7 +23511,7 @@ export interface components {
22030
23511
  };
22031
23512
  ProviderProductInfos_Relationships: {
22032
23513
  provider?: components["schemas"]["Single_Relationship_Data_Document"];
22033
- subject?: components["schemas"]["Single_Relationship_Data_Document"];
23514
+ subject?: components["schemas"]["ProviderProductInfos_Subject_Single_Relationship_Data_Document"];
22034
23515
  };
22035
23516
  ProviderProductInfos_Resource_Object: {
22036
23517
  attributes?: components["schemas"]["ProviderProductInfos_Attributes"];
@@ -22056,6 +23537,27 @@ export interface components {
22056
23537
  included?: components["schemas"]["Included"];
22057
23538
  links: components["schemas"]["Links"];
22058
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
+ };
22059
23561
  Providers_Attributes: {
22060
23562
  /**
22061
23563
  * @description Provider name
@@ -22110,7 +23612,7 @@ export interface components {
22110
23612
  };
22111
23613
  Purchases_Relationships: {
22112
23614
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
22113
- subject?: components["schemas"]["Single_Relationship_Data_Document"];
23615
+ subject?: components["schemas"]["Purchases_Subject_Single_Relationship_Data_Document"];
22114
23616
  };
22115
23617
  Purchases_Resource_Object: {
22116
23618
  attributes?: components["schemas"]["Purchases_Attributes"];
@@ -22136,6 +23638,27 @@ export interface components {
22136
23638
  included?: components["schemas"]["Included"];
22137
23639
  links: components["schemas"]["Links"];
22138
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
+ };
22139
23662
  /** @description Reaction statistics */
22140
23663
  ReactionStats: {
22141
23664
  /** @description Count of reactions by type */
@@ -22220,6 +23743,19 @@ export interface components {
22220
23743
  included?: components["schemas"]["Included"];
22221
23744
  links: components["schemas"]["Links"];
22222
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
+ };
22223
23759
  Resource_Identifier: {
22224
23760
  /**
22225
23761
  * @description Resource id
@@ -22368,6 +23904,48 @@ export interface components {
22368
23904
  included?: components["schemas"]["Included"];
22369
23905
  links: components["schemas"]["Links"];
22370
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
+ };
22371
23949
  SearchResults_Attributes: {
22372
23950
  /**
22373
23951
  * @description 'did you mean' prompt
@@ -22380,42 +23958,126 @@ export interface components {
22380
23958
  */
22381
23959
  trackingId: string;
22382
23960
  };
22383
- SearchResults_Multi_Relationship_Data_Document: {
22384
- data?: components["schemas"]["Resource_Identifier"][];
22385
- included?: components["schemas"]["Included"];
22386
- links: components["schemas"]["Links"];
23961
+ SearchResults_Multi_Relationship_Data_Document: {
23962
+ data?: components["schemas"]["Resource_Identifier"][];
23963
+ included?: components["schemas"]["Included"];
23964
+ links: components["schemas"]["Links"];
23965
+ };
23966
+ SearchResults_Multi_Resource_Data_Document: {
23967
+ data: components["schemas"]["SearchResults_Resource_Object"][];
23968
+ included?: components["schemas"]["Included"];
23969
+ links: components["schemas"]["Links"];
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
+ };
23992
+ SearchResults_Relationships: {
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"];
23999
+ };
24000
+ SearchResults_Resource_Object: {
24001
+ attributes?: components["schemas"]["SearchResults_Attributes"];
24002
+ /**
24003
+ * @description Resource id
24004
+ * @example 12345
24005
+ */
24006
+ id: string;
24007
+ relationships?: components["schemas"]["SearchResults_Relationships"];
24008
+ /**
24009
+ * @description Resource type (enum property replaced by openapi-typescript)
24010
+ * @enum {string}
24011
+ */
24012
+ type: "searchResults";
24013
+ };
24014
+ SearchResults_Single_Resource_Data_Document: {
24015
+ data: components["schemas"]["SearchResults_Resource_Object"];
24016
+ included?: components["schemas"]["Included"];
24017
+ links: components["schemas"]["Links"];
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"];
22387
24060
  };
22388
- SearchResults_Multi_Resource_Data_Document: {
22389
- data: components["schemas"]["SearchResults_Resource_Object"][];
24061
+ SearchResults_Videos_Multi_Relationship_Data_Document: {
24062
+ data?: components["schemas"]["SearchResults_Videos_Resource_Identifier"][];
22390
24063
  included?: components["schemas"]["Included"];
22391
24064
  links: components["schemas"]["Links"];
22392
24065
  };
22393
- SearchResults_Relationships: {
22394
- albums?: components["schemas"]["Multi_Relationship_Data_Document"];
22395
- artists?: components["schemas"]["Multi_Relationship_Data_Document"];
22396
- playlists?: components["schemas"]["Multi_Relationship_Data_Document"];
22397
- topHits?: components["schemas"]["Multi_Relationship_Data_Document"];
22398
- tracks?: components["schemas"]["Multi_Relationship_Data_Document"];
22399
- videos?: components["schemas"]["Multi_Relationship_Data_Document"];
22400
- };
22401
- SearchResults_Resource_Object: {
22402
- attributes?: components["schemas"]["SearchResults_Attributes"];
24066
+ SearchResults_Videos_Resource_Identifier: {
22403
24067
  /**
22404
24068
  * @description Resource id
22405
24069
  * @example 12345
22406
24070
  */
22407
24071
  id: string;
22408
- relationships?: components["schemas"]["SearchResults_Relationships"];
24072
+ meta?: components["schemas"]["SearchResults_Videos_Resource_Identifier_Meta"];
22409
24073
  /**
22410
- * @description Resource type (enum property replaced by openapi-typescript)
22411
- * @enum {string}
24074
+ * @description Resource type
24075
+ * @example tracks
22412
24076
  */
22413
- type: "searchResults";
24077
+ type: string;
22414
24078
  };
22415
- SearchResults_Single_Resource_Data_Document: {
22416
- data: components["schemas"]["SearchResults_Resource_Object"];
22417
- included?: components["schemas"]["Included"];
22418
- links: components["schemas"]["Links"];
24079
+ SearchResults_Videos_Resource_Identifier_Meta: {
24080
+ replacement?: components["schemas"]["Replacement_Provenance"];
22419
24081
  };
22420
24082
  SearchSuggestions_Attributes: {
22421
24083
  /**
@@ -22428,6 +24090,27 @@ export interface components {
22428
24090
  /** @description Unique tracking id */
22429
24091
  trackingId: string;
22430
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
+ };
22431
24114
  SearchSuggestions_Highlights: {
22432
24115
  /** Format: int32 */
22433
24116
  length: number;
@@ -22450,7 +24133,7 @@ export interface components {
22450
24133
  links: components["schemas"]["Links"];
22451
24134
  };
22452
24135
  SearchSuggestions_Relationships: {
22453
- directHits?: components["schemas"]["Multi_Relationship_Data_Document"];
24136
+ directHits?: components["schemas"]["SearchSuggestions_DirectHits_Multi_Relationship_Data_Document"];
22454
24137
  history?: components["schemas"]["Multi_Relationship_Data_Document"];
22455
24138
  };
22456
24139
  SearchSuggestions_Resource_Object: {
@@ -22519,7 +24202,7 @@ export interface components {
22519
24202
  };
22520
24203
  Shares_Relationships: {
22521
24204
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
22522
- sharedResources?: components["schemas"]["Multi_Relationship_Data_Document"];
24205
+ sharedResources?: components["schemas"]["Shares_SharedResources_Multi_Relationship_Data_Document"];
22523
24206
  };
22524
24207
  Shares_Resource_Object: {
22525
24208
  attributes?: components["schemas"]["Shares_Attributes"];
@@ -22535,6 +24218,27 @@ export interface components {
22535
24218
  */
22536
24219
  type: "shares";
22537
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
+ };
22538
24242
  Shares_Single_Resource_Data_Document: {
22539
24243
  data: components["schemas"]["Shares_Resource_Object"];
22540
24244
  included?: components["schemas"]["Included"];
@@ -22580,7 +24284,7 @@ export interface components {
22580
24284
  * @enum {string}
22581
24285
  */
22582
24286
  code: "IDEMPOTENT_REQUEST_IN_PROGRESS" | "MISSING_SITES_SCOPE";
22583
- /** @example The Square credential is missing the OAuth scopes required by the Square Online sites feature (ONLINE_STORE_SITE_READ, CHANNELS_READ). Re-run Square onboarding to grant them. */
24287
+ /** @example Square credential lacks required site scopes; run Square onboarding again */
22584
24288
  detail?: string;
22585
24289
  /** @example 409 */
22586
24290
  status: string;
@@ -22662,6 +24366,8 @@ export interface components {
22662
24366
  domain?: string;
22663
24367
  /** @description Whether the site is published on Square Online */
22664
24368
  published?: boolean;
24369
+ /** @description The site's title as set by the seller in Square */
24370
+ siteTitle?: string;
22665
24371
  };
22666
24372
  SquareSites_Multi_Resource_Data_Document: {
22667
24373
  data: components["schemas"]["SquareSites_Resource_Object"][];
@@ -22822,6 +24528,93 @@ export interface components {
22822
24528
  included?: components["schemas"]["Included"];
22823
24529
  links: components["schemas"]["Links"];
22824
24530
  };
24531
+ SubscriptionPriceChangeDecisionsCreateOperation_Payload: {
24532
+ data: components["schemas"]["SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data"];
24533
+ };
24534
+ SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data: {
24535
+ attributes: components["schemas"]["SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Attributes"];
24536
+ relationships: components["schemas"]["SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships"];
24537
+ /** @enum {string} */
24538
+ type: "subscriptionPriceChangeDecisions";
24539
+ };
24540
+ SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Attributes: {
24541
+ /**
24542
+ * @description The decision to record. A decision may only be created once — changing a rejection to an acceptance is a PATCH.
24543
+ * @enum {string}
24544
+ */
24545
+ status: "ACCEPTED" | "REJECTED";
24546
+ };
24547
+ SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships: {
24548
+ priceChange: components["schemas"]["SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships_PriceChange"];
24549
+ };
24550
+ SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships_PriceChange: {
24551
+ data: components["schemas"]["SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships_PriceChange_Data"];
24552
+ };
24553
+ SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships_PriceChange_Data: {
24554
+ id: string;
24555
+ /** @enum {string} */
24556
+ type: "userSubscriptionPriceChanges";
24557
+ };
24558
+ SubscriptionPriceChangeDecisionsUpdateOperation_Payload: {
24559
+ data: components["schemas"]["SubscriptionPriceChangeDecisionsUpdateOperation_Payload_Data"];
24560
+ };
24561
+ SubscriptionPriceChangeDecisionsUpdateOperation_Payload_Data: {
24562
+ attributes: components["schemas"]["SubscriptionPriceChangeDecisionsUpdateOperation_Payload_Data_Attributes"];
24563
+ id: string;
24564
+ /** @enum {string} */
24565
+ type: "subscriptionPriceChangeDecisions";
24566
+ };
24567
+ SubscriptionPriceChangeDecisionsUpdateOperation_Payload_Data_Attributes: {
24568
+ /**
24569
+ * @description The decision to record. The only allowed transition is REJECTED -> ACCEPTED; acceptance is permanent.
24570
+ * @enum {string}
24571
+ */
24572
+ status: "ACCEPTED" | "REJECTED";
24573
+ };
24574
+ SubscriptionPriceChangeDecisions_Attributes: {
24575
+ /**
24576
+ * Format: date-time
24577
+ * @description When the user decided. Absent when the consent was implicit (derived from the subscription start).
24578
+ */
24579
+ decidedAt?: string;
24580
+ /**
24581
+ * @description The user's decision. ACCEPTED is permanent; REJECTED can still be flipped to ACCEPTED before the renewal.
24582
+ * @enum {string}
24583
+ */
24584
+ status: "ACCEPTED" | "REJECTED";
24585
+ };
24586
+ SubscriptionPriceChangeDecisions_Multi_Resource_Data_Document: {
24587
+ data: components["schemas"]["SubscriptionPriceChangeDecisions_Resource_Object"][];
24588
+ included?: components["schemas"]["Included"];
24589
+ links: components["schemas"]["Links"];
24590
+ };
24591
+ SubscriptionPriceChangeDecisions_Relationships: {
24592
+ priceChange?: components["schemas"]["Single_Relationship_Data_Document"];
24593
+ };
24594
+ SubscriptionPriceChangeDecisions_Resource_Object: {
24595
+ attributes?: components["schemas"]["SubscriptionPriceChangeDecisions_Attributes"];
24596
+ /**
24597
+ * @description Resource id
24598
+ * @example 12345
24599
+ */
24600
+ id: string;
24601
+ relationships?: components["schemas"]["SubscriptionPriceChangeDecisions_Relationships"];
24602
+ /**
24603
+ * @description Resource type (enum property replaced by openapi-typescript)
24604
+ * @enum {string}
24605
+ */
24606
+ type: "subscriptionPriceChangeDecisions";
24607
+ };
24608
+ SubscriptionPriceChangeDecisions_Single_Relationship_Data_Document: {
24609
+ data?: components["schemas"]["Resource_Identifier"] | (never | null);
24610
+ included?: components["schemas"]["Included"];
24611
+ links: components["schemas"]["Links"];
24612
+ };
24613
+ SubscriptionPriceChangeDecisions_Single_Resource_Data_Document: {
24614
+ data: components["schemas"]["SubscriptionPriceChangeDecisions_Resource_Object"];
24615
+ included?: components["schemas"]["Included"];
24616
+ links: components["schemas"]["Links"];
24617
+ };
22825
24618
  TemporaryUserTokensCreateOperation_Payload: {
22826
24619
  data: components["schemas"]["TemporaryUserTokensCreateOperation_Payload_Data"];
22827
24620
  };
@@ -22921,7 +24714,7 @@ export interface components {
22921
24714
  * @enum {string}
22922
24715
  */
22923
24716
  code: "CLIENT_NOT_ENTITLED" | "CONCURRENT_PLAYBACK" | "GEO_RESTRICTED" | "PREREQUISITE_MISSING" | "PURCHASE_REQUIRED";
22924
- /** @example Cannot fulfill this request because required prerequisites are missing */
24717
+ /** @example Required playback prerequisites are missing */
22925
24718
  detail?: string;
22926
24719
  /** @example 403 */
22927
24720
  status: string;
@@ -22934,7 +24727,7 @@ export interface components {
22934
24727
  * @enum {string}
22935
24728
  */
22936
24729
  code: "CONTENT_NOT_FOUND";
22937
- /** @example The requested content does not exist or is no longer available */
24730
+ /** @example Content does not exist or is no longer available */
22938
24731
  detail?: string;
22939
24732
  /** @example 404 */
22940
24733
  status: string;
@@ -22992,7 +24785,7 @@ export interface components {
22992
24785
  * @enum {string}
22993
24786
  */
22994
24787
  code: "CLIENT_NOT_ENTITLED" | "CONCURRENT_PLAYBACK" | "GEO_RESTRICTED" | "PREREQUISITE_MISSING" | "PURCHASE_REQUIRED";
22995
- /** @example Cannot fulfill this request because required prerequisites are missing */
24788
+ /** @example Required playback prerequisites are missing */
22996
24789
  detail?: string;
22997
24790
  /** @example 403 */
22998
24791
  status: string;
@@ -23005,7 +24798,7 @@ export interface components {
23005
24798
  * @enum {string}
23006
24799
  */
23007
24800
  code: "CONTENT_NOT_FOUND";
23008
- /** @example The requested content does not exist or is no longer available */
24801
+ /** @example Content does not exist or is no longer available */
23009
24802
  detail?: string;
23010
24803
  /** @example 404 */
23011
24804
  status: string;
@@ -23306,6 +25099,27 @@ export interface components {
23306
25099
  /** @enum {string} */
23307
25100
  type: "genres";
23308
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
+ };
23309
25123
  Tracks_Attributes: {
23310
25124
  /**
23311
25125
  * @description Access type
@@ -23397,7 +25211,7 @@ export interface components {
23397
25211
  links: components["schemas"]["Links"];
23398
25212
  };
23399
25213
  Tracks_Relationships: {
23400
- albums?: components["schemas"]["Multi_Relationship_Data_Document"];
25214
+ albums?: components["schemas"]["Tracks_Albums_Multi_Relationship_Data_Document"];
23401
25215
  artists?: components["schemas"]["Multi_Relationship_Data_Document"];
23402
25216
  credits?: components["schemas"]["Multi_Relationship_Data_Document"];
23403
25217
  download?: components["schemas"]["Single_Relationship_Data_Document"];
@@ -23408,14 +25222,35 @@ export interface components {
23408
25222
  priceConfig?: components["schemas"]["Single_Relationship_Data_Document"];
23409
25223
  providers?: components["schemas"]["Multi_Relationship_Data_Document"];
23410
25224
  radio?: components["schemas"]["Multi_Relationship_Data_Document"];
23411
- replacement?: components["schemas"]["Single_Relationship_Data_Document"];
25225
+ replacement?: components["schemas"]["Tracks_Replacement_Single_Relationship_Data_Document"];
23412
25226
  shares?: components["schemas"]["Multi_Relationship_Data_Document"];
23413
- similarTracks?: components["schemas"]["Multi_Relationship_Data_Document"];
25227
+ similarTracks?: components["schemas"]["Tracks_SimilarTracks_Multi_Relationship_Data_Document"];
23414
25228
  sourceFile?: components["schemas"]["Single_Relationship_Data_Document"];
23415
- suggestedTracks?: components["schemas"]["Multi_Relationship_Data_Document"];
25229
+ suggestedTracks?: components["schemas"]["Tracks_SuggestedTracks_Multi_Relationship_Data_Document"];
23416
25230
  trackStatistics?: components["schemas"]["Single_Relationship_Data_Document"];
23417
25231
  usageRules?: components["schemas"]["Single_Relationship_Data_Document"];
23418
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
+ };
23419
25254
  Tracks_Resource_Object: {
23420
25255
  attributes?: components["schemas"]["Tracks_Attributes"];
23421
25256
  /**
@@ -23430,6 +25265,27 @@ export interface components {
23430
25265
  */
23431
25266
  type: "tracks";
23432
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
+ };
23433
25289
  Tracks_Single_Relationship_Data_Document: {
23434
25290
  data?: components["schemas"]["Resource_Identifier"] | (never | null);
23435
25291
  included?: components["schemas"]["Included"];
@@ -23440,6 +25296,27 @@ export interface components {
23440
25296
  included?: components["schemas"]["Included"];
23441
25297
  links: components["schemas"]["Links"];
23442
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
+ };
23443
25320
  UsageRulesCreateOperation_Payload: {
23444
25321
  data: components["schemas"]["UsageRulesCreateOperation_Payload_Data"];
23445
25322
  };
@@ -23525,7 +25402,7 @@ export interface components {
23525
25402
  * @enum {string}
23526
25403
  */
23527
25404
  code: "DUPLICATE_ITEMS_IN_COLLECTION" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_COLLECTION";
23528
- /** @example You have reached the maximum number of items allowed for this collection. Please remove some items before adding more. */
25405
+ /** @example Collection item limit reached */
23529
25406
  detail?: string;
23530
25407
  /** @example 409 */
23531
25408
  status: string;
@@ -23601,6 +25478,7 @@ export interface components {
23601
25478
  UserCollectionAlbums_Items_Resource_Identifier_Meta: {
23602
25479
  /** Format: date-time */
23603
25480
  addedAt: string;
25481
+ replacement?: components["schemas"]["Replacement_Provenance"];
23604
25482
  };
23605
25483
  UserCollectionAlbums_Multi_Relationship_Data_Document: {
23606
25484
  data?: components["schemas"]["Resource_Identifier"][];
@@ -23642,7 +25520,7 @@ export interface components {
23642
25520
  * @enum {string}
23643
25521
  */
23644
25522
  code: "DUPLICATE_ITEMS_IN_COLLECTION" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_COLLECTION";
23645
- /** @example You have reached the maximum number of items allowed for this collection. Please remove some items before adding more. */
25523
+ /** @example Collection item limit reached */
23646
25524
  detail?: string;
23647
25525
  /** @example 409 */
23648
25526
  status: string;
@@ -23777,7 +25655,7 @@ export interface components {
23777
25655
  * @enum {string}
23778
25656
  */
23779
25657
  code: "FOLDER_NOT_EMPTY";
23780
- /** @example Cannot delete folder: only empty folders owned by you can be deleted. */
25658
+ /** @example Folder must be empty and owned by you */
23781
25659
  detail?: string;
23782
25660
  /** @example 400 */
23783
25661
  status: string;
@@ -23888,7 +25766,7 @@ export interface components {
23888
25766
  * @enum {string}
23889
25767
  */
23890
25768
  code: "DUPLICATE_ITEMS_IN_COLLECTION" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_COLLECTION";
23891
- /** @example You have reached the maximum number of items allowed for this collection. Please remove some items before adding more. */
25769
+ /** @example Collection item limit reached */
23892
25770
  detail?: string;
23893
25771
  /** @example 409 */
23894
25772
  status: string;
@@ -24005,7 +25883,7 @@ export interface components {
24005
25883
  * @enum {string}
24006
25884
  */
24007
25885
  code: "DUPLICATE_ITEMS_IN_COLLECTION" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_COLLECTION";
24008
- /** @example You have reached the maximum number of items allowed for this collection. Please remove some items before adding more. */
25886
+ /** @example Collection item limit reached */
24009
25887
  detail?: string;
24010
25888
  /** @example 409 */
24011
25889
  status: string;
@@ -24076,6 +25954,7 @@ export interface components {
24076
25954
  UserCollectionSaveForLaters_Items_Resource_Identifier_Meta: {
24077
25955
  /** Format: date-time */
24078
25956
  addedAt: string;
25957
+ replacement?: components["schemas"]["Replacement_Provenance"];
24079
25958
  };
24080
25959
  UserCollectionSaveForLaters_Multi_Relationship_Data_Document: {
24081
25960
  data?: components["schemas"]["Resource_Identifier"][];
@@ -24117,7 +25996,7 @@ export interface components {
24117
25996
  * @enum {string}
24118
25997
  */
24119
25998
  code: "DUPLICATE_ITEMS_IN_COLLECTION" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_COLLECTION";
24120
- /** @example You have reached the maximum number of items allowed for this collection. Please remove some items before adding more. */
25999
+ /** @example Collection item limit reached */
24121
26000
  detail?: string;
24122
26001
  /** @example 409 */
24123
26002
  status: string;
@@ -24193,6 +26072,7 @@ export interface components {
24193
26072
  UserCollectionTracks_Items_Resource_Identifier_Meta: {
24194
26073
  /** Format: date-time */
24195
26074
  addedAt: string;
26075
+ replacement?: components["schemas"]["Replacement_Provenance"];
24196
26076
  };
24197
26077
  UserCollectionTracks_Multi_Relationship_Data_Document: {
24198
26078
  data?: components["schemas"]["Resource_Identifier"][];
@@ -24234,7 +26114,7 @@ export interface components {
24234
26114
  * @enum {string}
24235
26115
  */
24236
26116
  code: "DUPLICATE_ITEMS_IN_COLLECTION" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_COLLECTION";
24237
- /** @example You have reached the maximum number of items allowed for this collection. Please remove some items before adding more. */
26117
+ /** @example Collection item limit reached */
24238
26118
  detail?: string;
24239
26119
  /** @example 409 */
24240
26120
  status: string;
@@ -24310,6 +26190,7 @@ export interface components {
24310
26190
  UserCollectionVideos_Items_Resource_Identifier_Meta: {
24311
26191
  /** Format: date-time */
24312
26192
  addedAt: string;
26193
+ replacement?: components["schemas"]["Replacement_Provenance"];
24313
26194
  };
24314
26195
  UserCollectionVideos_Multi_Relationship_Data_Document: {
24315
26196
  data?: components["schemas"]["Resource_Identifier"][];
@@ -24351,7 +26232,7 @@ export interface components {
24351
26232
  * @enum {string}
24352
26233
  */
24353
26234
  code: "DUPLICATE_ITEMS_IN_COLLECTION" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_COLLECTION";
24354
- /** @example You have reached the maximum number of items allowed for this collection. Please remove some items before adding more. */
26235
+ /** @example Collection item limit reached */
24355
26236
  detail?: string;
24356
26237
  /** @example 409 */
24357
26238
  status: string;
@@ -24473,6 +26354,7 @@ export interface components {
24473
26354
  UserCollections_Albums_Resource_Identifier_Meta: {
24474
26355
  /** Format: date-time */
24475
26356
  addedAt: string;
26357
+ replacement?: components["schemas"]["Replacement_Provenance"];
24476
26358
  };
24477
26359
  UserCollections_Artists_Multi_Relationship_Data_Document: {
24478
26360
  data?: components["schemas"]["UserCollections_Artists_Resource_Identifier"][];
@@ -24577,6 +26459,7 @@ export interface components {
24577
26459
  UserCollections_Tracks_Resource_Identifier_Meta: {
24578
26460
  /** Format: date-time */
24579
26461
  addedAt: string;
26462
+ replacement?: components["schemas"]["Replacement_Provenance"];
24580
26463
  };
24581
26464
  UserCollections_Videos_Multi_Relationship_Data_Document: {
24582
26465
  data?: components["schemas"]["UserCollections_Videos_Resource_Identifier"][];
@@ -24599,6 +26482,7 @@ export interface components {
24599
26482
  UserCollections_Videos_Resource_Identifier_Meta: {
24600
26483
  /** Format: date-time */
24601
26484
  addedAt: string;
26485
+ replacement?: components["schemas"]["Replacement_Provenance"];
24602
26486
  };
24603
26487
  UserDailyMixes_Attributes: Record<string, never>;
24604
26488
  UserDailyMixes_Multi_Relationship_Data_Document: {
@@ -24781,7 +26665,7 @@ export interface components {
24781
26665
  * @enum {string}
24782
26666
  */
24783
26667
  code: "IDEMPOTENT_REQUEST_IN_PROGRESS" | "MAXIMUM_NUMBER_OF_BLOCKS_EXCEEDED";
24784
- /** @example You have reached the maximum number of blocked recommendation items. Please remove some blocked items before adding more. */
26668
+ /** @example Recommendation block limit reached */
24785
26669
  detail?: string;
24786
26670
  /** @example 409 */
24787
26671
  status: string;
@@ -24920,6 +26804,7 @@ export interface components {
24920
26804
  * @description When the item was blocked
24921
26805
  */
24922
26806
  createdAt: string;
26807
+ replacement?: components["schemas"]["Replacement_Provenance"];
24923
26808
  };
24924
26809
  UserRecommendationBlocks_Videos_Multi_Relationship_Data_Document: {
24925
26810
  data?: components["schemas"]["UserRecommendationBlocks_Videos_Resource_Identifier"][];
@@ -24945,6 +26830,7 @@ export interface components {
24945
26830
  * @description When the item was blocked
24946
26831
  */
24947
26832
  createdAt: string;
26833
+ replacement?: components["schemas"]["Replacement_Provenance"];
24948
26834
  };
24949
26835
  UserRecommendations_Attributes: Record<string, never>;
24950
26836
  UserRecommendations_Multi_Relationship_Data_Document: {
@@ -25039,6 +26925,60 @@ export interface components {
25039
26925
  included?: components["schemas"]["Included"];
25040
26926
  links: components["schemas"]["Links"];
25041
26927
  };
26928
+ UserSubscriptionPriceChanges_Attributes: {
26929
+ /**
26930
+ * @description ISO 4217 currency code
26931
+ * @example EUR
26932
+ */
26933
+ currency: string;
26934
+ /**
26935
+ * @description Price amount with max 2 decimal places
26936
+ * @example 9.99
26937
+ */
26938
+ currentPrice: string;
26939
+ /**
26940
+ * Format: date
26941
+ * @description The date the new price takes effect
26942
+ */
26943
+ effectiveDate: string;
26944
+ /**
26945
+ * @description Price amount with max 2 decimal places
26946
+ * @example 9.99
26947
+ */
26948
+ newPrice: string;
26949
+ };
26950
+ UserSubscriptionPriceChanges_Multi_Resource_Data_Document: {
26951
+ data: components["schemas"]["UserSubscriptionPriceChanges_Resource_Object"][];
26952
+ included?: components["schemas"]["Included"];
26953
+ links: components["schemas"]["Links"];
26954
+ };
26955
+ UserSubscriptionPriceChanges_Relationships: {
26956
+ decision?: components["schemas"]["Single_Relationship_Data_Document"];
26957
+ };
26958
+ UserSubscriptionPriceChanges_Resource_Object: {
26959
+ attributes?: components["schemas"]["UserSubscriptionPriceChanges_Attributes"];
26960
+ /**
26961
+ * @description Resource id
26962
+ * @example 12345
26963
+ */
26964
+ id: string;
26965
+ relationships?: components["schemas"]["UserSubscriptionPriceChanges_Relationships"];
26966
+ /**
26967
+ * @description Resource type (enum property replaced by openapi-typescript)
26968
+ * @enum {string}
26969
+ */
26970
+ type: "userSubscriptionPriceChanges";
26971
+ };
26972
+ UserSubscriptionPriceChanges_Single_Relationship_Data_Document: {
26973
+ data?: components["schemas"]["Resource_Identifier"] | (never | null);
26974
+ included?: components["schemas"]["Included"];
26975
+ links: components["schemas"]["Links"];
26976
+ };
26977
+ UserSubscriptionPriceChanges_Single_Resource_Data_Document: {
26978
+ data: components["schemas"]["UserSubscriptionPriceChanges_Resource_Object"];
26979
+ included?: components["schemas"]["Included"];
26980
+ links: components["schemas"]["Links"];
26981
+ };
25042
26982
  Users_Attributes: {
25043
26983
  /**
25044
26984
  * @description ISO 3166-1 alpha-2 country code
@@ -25112,7 +27052,7 @@ export interface components {
25112
27052
  * @enum {string}
25113
27053
  */
25114
27054
  code: "CLIENT_NOT_ENTITLED" | "CONCURRENT_PLAYBACK" | "GEO_RESTRICTED" | "PREREQUISITE_MISSING" | "PURCHASE_REQUIRED";
25115
- /** @example Cannot fulfill this request because required prerequisites are missing */
27055
+ /** @example Required playback prerequisites are missing */
25116
27056
  detail?: string;
25117
27057
  /** @example 403 */
25118
27058
  status: string;
@@ -25125,7 +27065,7 @@ export interface components {
25125
27065
  * @enum {string}
25126
27066
  */
25127
27067
  code: "CONTENT_NOT_FOUND";
25128
- /** @example The requested content does not exist or is no longer available */
27068
+ /** @example Content does not exist or is no longer available */
25129
27069
  detail?: string;
25130
27070
  /** @example 404 */
25131
27071
  status: string;
@@ -25168,6 +27108,27 @@ export interface components {
25168
27108
  included?: components["schemas"]["Included"];
25169
27109
  links: components["schemas"]["Links"];
25170
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
+ };
25171
27132
  Videos_Attributes: {
25172
27133
  /**
25173
27134
  * @deprecated
@@ -25226,16 +27187,37 @@ export interface components {
25226
27187
  links: components["schemas"]["Links"];
25227
27188
  };
25228
27189
  Videos_Relationships: {
25229
- albums?: components["schemas"]["Multi_Relationship_Data_Document"];
27190
+ albums?: components["schemas"]["Videos_Albums_Multi_Relationship_Data_Document"];
25230
27191
  artists?: components["schemas"]["Multi_Relationship_Data_Document"];
25231
27192
  credits?: components["schemas"]["Multi_Relationship_Data_Document"];
25232
27193
  providers?: components["schemas"]["Multi_Relationship_Data_Document"];
25233
- replacement?: components["schemas"]["Single_Relationship_Data_Document"];
25234
- similarVideos?: components["schemas"]["Multi_Relationship_Data_Document"];
25235
- 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"];
25236
27197
  thumbnailArt?: components["schemas"]["Multi_Relationship_Data_Document"];
25237
27198
  usageRules?: components["schemas"]["Single_Relationship_Data_Document"];
25238
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
+ };
25239
27221
  Videos_Resource_Object: {
25240
27222
  attributes?: components["schemas"]["Videos_Attributes"];
25241
27223
  /**
@@ -25250,6 +27232,27 @@ export interface components {
25250
27232
  */
25251
27233
  type: "videos";
25252
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
+ };
25253
27256
  Videos_Single_Relationship_Data_Document: {
25254
27257
  data?: components["schemas"]["Resource_Identifier"] | (never | null);
25255
27258
  included?: components["schemas"]["Included"];
@@ -25260,9 +27263,30 @@ export interface components {
25260
27263
  included?: components["schemas"]["Included"];
25261
27264
  links: components["schemas"]["Links"];
25262
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
+ };
25263
27287
  };
25264
27288
  responses: {
25265
- /** @description The request is malformed or invalid */
27289
+ /** @description Invalid request */
25266
27290
  Default400Response: {
25267
27291
  headers: {
25268
27292
  [name: string]: unknown;
@@ -25271,7 +27295,7 @@ export interface components {
25271
27295
  "application/vnd.api+json": components["schemas"]["Default400ResponseBody"];
25272
27296
  };
25273
27297
  };
25274
- /** @description The requested resource was not found */
27298
+ /** @description Resource not found */
25275
27299
  Default404Response: {
25276
27300
  headers: {
25277
27301
  [name: string]: unknown;
@@ -25280,7 +27304,7 @@ export interface components {
25280
27304
  "application/vnd.api+json": components["schemas"]["Default404ResponseBody"];
25281
27305
  };
25282
27306
  };
25283
- /** @description The HTTP method is not allowed for the requested resource */
27307
+ /** @description HTTP method not allowed */
25284
27308
  Default405Response: {
25285
27309
  headers: {
25286
27310
  [name: string]: unknown;
@@ -25289,7 +27313,7 @@ export interface components {
25289
27313
  "application/vnd.api+json": components["schemas"]["Default405ResponseBody"];
25290
27314
  };
25291
27315
  };
25292
- /** @description A response that satisfies the content negotiation headers cannot be produced */
27316
+ /** @description No acceptable response media type */
25293
27317
  Default406Response: {
25294
27318
  headers: {
25295
27319
  [name: string]: unknown;
@@ -25298,7 +27322,7 @@ export interface components {
25298
27322
  "application/vnd.api+json": components["schemas"]["Default406ResponseBody"];
25299
27323
  };
25300
27324
  };
25301
- /** @description Unsupported request payload media type or content encoding */
27325
+ /** @description Unsupported request media type or encoding */
25302
27326
  Default415Response: {
25303
27327
  headers: {
25304
27328
  [name: string]: unknown;
@@ -25316,7 +27340,7 @@ export interface components {
25316
27340
  "application/vnd.api+json": components["schemas"]["Default429ResponseBody"];
25317
27341
  };
25318
27342
  };
25319
- /** @description An unexpected error was encountered */
27343
+ /** @description Internal server error */
25320
27344
  Default500Response: {
25321
27345
  headers: {
25322
27346
  [name: string]: unknown;
@@ -25325,7 +27349,7 @@ export interface components {
25325
27349
  "application/vnd.api+json": components["schemas"]["Default500ResponseBody"];
25326
27350
  };
25327
27351
  };
25328
- /** @description Temporarily unavailable; please try again later */
27352
+ /** @description Service temporarily unavailable */
25329
27353
  Default503Response: {
25330
27354
  headers: {
25331
27355
  [name: string]: unknown;
@@ -25334,7 +27358,7 @@ export interface components {
25334
27358
  "application/vnd.api+json": components["schemas"]["Default503ResponseBody"];
25335
27359
  };
25336
27360
  };
25337
- /** @description A request with this idempotency key is currently being processed */
27361
+ /** @description Request already in progress for this idempotency key */
25338
27362
  Idempotency409Response: {
25339
27363
  headers: {
25340
27364
  [name: string]: unknown;
@@ -25343,7 +27367,7 @@ export interface components {
25343
27367
  "application/vnd.api+json": components["schemas"]["Idempotency409ResponseBody"];
25344
27368
  };
25345
27369
  };
25346
- /** @description Idempotency key was already used with a different request payload */
27370
+ /** @description Idempotency key reused with a different payload */
25347
27371
  Idempotency422Response: {
25348
27372
  headers: {
25349
27373
  [name: string]: unknown;
@@ -25352,7 +27376,7 @@ export interface components {
25352
27376
  "application/vnd.api+json": components["schemas"]["Idempotency422ResponseBody"];
25353
27377
  };
25354
27378
  };
25355
- /** @description The Square credential is missing the OAuth scopes required by the Square Online sites feature (ONLINE_STORE_SITE_READ, CHANNELS_READ). Re-run Square onboarding to grant them.; A request with this idempotency key is currently being processed */
27379
+ /** @description Square credential lacks required site scopes; run Square onboarding again; Request already in progress for this idempotency key */
25356
27380
  SquareConnectionsUpdateSingleDataRelationship409Response: {
25357
27381
  headers: {
25358
27382
  [name: string]: unknown;
@@ -25361,7 +27385,7 @@ export interface components {
25361
27385
  "application/vnd.api+json": components["schemas"]["SquareConnectionsUpdateSingleDataRelationship409ResponseBody"];
25362
27386
  };
25363
27387
  };
25364
- /** @description Cannot fulfill this request because required prerequisites are missing; The requested content is not available in your location; The requested content must be purchased to be accessed; Client is not allowed to access this content; This account is playing on another app or device */
27388
+ /** @description Required playback prerequisites are missing; Content is unavailable in your location; Content must be purchased before playback; Client cannot access this content; Account is playing on another app or device */
25365
27389
  TrackFilesReadById403Response: {
25366
27390
  headers: {
25367
27391
  [name: string]: unknown;
@@ -25370,7 +27394,7 @@ export interface components {
25370
27394
  "application/vnd.api+json": components["schemas"]["TrackFilesReadById403ResponseBody"];
25371
27395
  };
25372
27396
  };
25373
- /** @description The requested content does not exist or is no longer available */
27397
+ /** @description Content does not exist or is no longer available */
25374
27398
  TrackFilesReadById404Response: {
25375
27399
  headers: {
25376
27400
  [name: string]: unknown;
@@ -25379,7 +27403,7 @@ export interface components {
25379
27403
  "application/vnd.api+json": components["schemas"]["TrackFilesReadById404ResponseBody"];
25380
27404
  };
25381
27405
  };
25382
- /** @description Cannot fulfill this request because required prerequisites are missing; The requested content is not available in your location; The requested content must be purchased to be accessed; Client is not allowed to access this content; This account is playing on another app or device */
27406
+ /** @description Required playback prerequisites are missing; Content is unavailable in your location; Content must be purchased before playback; Client cannot access this content; Account is playing on another app or device */
25383
27407
  TrackManifestsReadById403Response: {
25384
27408
  headers: {
25385
27409
  [name: string]: unknown;
@@ -25388,7 +27412,7 @@ export interface components {
25388
27412
  "application/vnd.api+json": components["schemas"]["TrackManifestsReadById403ResponseBody"];
25389
27413
  };
25390
27414
  };
25391
- /** @description The requested content does not exist or is no longer available */
27415
+ /** @description Content does not exist or is no longer available */
25392
27416
  TrackManifestsReadById404Response: {
25393
27417
  headers: {
25394
27418
  [name: string]: unknown;
@@ -25397,7 +27421,7 @@ export interface components {
25397
27421
  "application/vnd.api+json": components["schemas"]["TrackManifestsReadById404ResponseBody"];
25398
27422
  };
25399
27423
  };
25400
- /** @description You have reached the maximum number of items allowed for this collection. Please remove some items before adding more.; One or more items you are trying to add are already in your favorites.; A request with this idempotency key is currently being processed */
27424
+ /** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */
25401
27425
  UserCollectionAlbumsAddMultiDataRelationshipWithResponse409Response: {
25402
27426
  headers: {
25403
27427
  [name: string]: unknown;
@@ -25406,7 +27430,7 @@ export interface components {
25406
27430
  "application/vnd.api+json": components["schemas"]["UserCollectionAlbumsAddMultiDataRelationshipWithResponse409ResponseBody"];
25407
27431
  };
25408
27432
  };
25409
- /** @description You have reached the maximum number of items allowed for this collection. Please remove some items before adding more.; One or more items you are trying to add are already in your favorites.; A request with this idempotency key is currently being processed */
27433
+ /** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */
25410
27434
  UserCollectionArtistsAddMultiDataRelationshipWithResponse409Response: {
25411
27435
  headers: {
25412
27436
  [name: string]: unknown;
@@ -25415,7 +27439,7 @@ export interface components {
25415
27439
  "application/vnd.api+json": components["schemas"]["UserCollectionArtistsAddMultiDataRelationshipWithResponse409ResponseBody"];
25416
27440
  };
25417
27441
  };
25418
- /** @description Cannot delete folder: only empty folders owned by you can be deleted. */
27442
+ /** @description Folder must be empty and owned by you */
25419
27443
  UserCollectionFoldersDeleteResource400Response: {
25420
27444
  headers: {
25421
27445
  [name: string]: unknown;
@@ -25424,7 +27448,7 @@ export interface components {
25424
27448
  "application/vnd.api+json": components["schemas"]["UserCollectionFoldersDeleteResource400ResponseBody"];
25425
27449
  };
25426
27450
  };
25427
- /** @description You have reached the maximum number of items allowed for this collection. Please remove some items before adding more.; One or more items you are trying to add are already in your favorites.; A request with this idempotency key is currently being processed */
27451
+ /** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */
25428
27452
  UserCollectionPlaylistsAddMultiDataRelationshipWithResponse409Response: {
25429
27453
  headers: {
25430
27454
  [name: string]: unknown;
@@ -25433,7 +27457,7 @@ export interface components {
25433
27457
  "application/vnd.api+json": components["schemas"]["UserCollectionPlaylistsAddMultiDataRelationshipWithResponse409ResponseBody"];
25434
27458
  };
25435
27459
  };
25436
- /** @description You have reached the maximum number of items allowed for this collection. Please remove some items before adding more.; One or more items you are trying to add are already in your favorites.; A request with this idempotency key is currently being processed */
27460
+ /** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */
25437
27461
  UserCollectionSaveForLatersAddMultiDataRelationshipWithResponse409Response: {
25438
27462
  headers: {
25439
27463
  [name: string]: unknown;
@@ -25442,7 +27466,7 @@ export interface components {
25442
27466
  "application/vnd.api+json": components["schemas"]["UserCollectionSaveForLatersAddMultiDataRelationshipWithResponse409ResponseBody"];
25443
27467
  };
25444
27468
  };
25445
- /** @description You have reached the maximum number of items allowed for this collection. Please remove some items before adding more.; One or more items you are trying to add are already in your favorites.; A request with this idempotency key is currently being processed */
27469
+ /** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */
25446
27470
  UserCollectionTracksAddMultiDataRelationshipWithResponse409Response: {
25447
27471
  headers: {
25448
27472
  [name: string]: unknown;
@@ -25451,7 +27475,7 @@ export interface components {
25451
27475
  "application/vnd.api+json": components["schemas"]["UserCollectionTracksAddMultiDataRelationshipWithResponse409ResponseBody"];
25452
27476
  };
25453
27477
  };
25454
- /** @description You have reached the maximum number of items allowed for this collection. Please remove some items before adding more.; One or more items you are trying to add are already in your favorites.; A request with this idempotency key is currently being processed */
27478
+ /** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */
25455
27479
  UserCollectionVideosAddMultiDataRelationshipWithResponse409Response: {
25456
27480
  headers: {
25457
27481
  [name: string]: unknown;
@@ -25460,7 +27484,7 @@ export interface components {
25460
27484
  "application/vnd.api+json": components["schemas"]["UserCollectionVideosAddMultiDataRelationshipWithResponse409ResponseBody"];
25461
27485
  };
25462
27486
  };
25463
- /** @description You have reached the maximum number of items allowed for this collection. Please remove some items before adding more.; One or more items you are trying to add are already in your favorites.; A request with this idempotency key is currently being processed */
27487
+ /** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */
25464
27488
  UserCollectionsAddMultiDataRelationship409Response: {
25465
27489
  headers: {
25466
27490
  [name: string]: unknown;
@@ -25469,7 +27493,7 @@ export interface components {
25469
27493
  "application/vnd.api+json": components["schemas"]["UserCollectionsAddMultiDataRelationship409ResponseBody"];
25470
27494
  };
25471
27495
  };
25472
- /** @description You have reached the maximum number of blocked recommendation items. Please remove some blocked items before adding more.; A request with this idempotency key is currently being processed */
27496
+ /** @description Recommendation block limit reached; Request already in progress for this idempotency key */
25473
27497
  UserRecommendationBlocksAddMultiDataRelationshipWithResponse409Response: {
25474
27498
  headers: {
25475
27499
  [name: string]: unknown;
@@ -25478,7 +27502,7 @@ export interface components {
25478
27502
  "application/vnd.api+json": components["schemas"]["UserRecommendationBlocksAddMultiDataRelationshipWithResponse409ResponseBody"];
25479
27503
  };
25480
27504
  };
25481
- /** @description Cannot fulfill this request because required prerequisites are missing; The requested content is not available in your location; The requested content must be purchased to be accessed; Client is not allowed to access this content; This account is playing on another app or device */
27505
+ /** @description Required playback prerequisites are missing; Content is unavailable in your location; Content must be purchased before playback; Client cannot access this content; Account is playing on another app or device */
25482
27506
  VideoManifestsReadById403Response: {
25483
27507
  headers: {
25484
27508
  [name: string]: unknown;
@@ -25487,7 +27511,7 @@ export interface components {
25487
27511
  "application/vnd.api+json": components["schemas"]["VideoManifestsReadById403ResponseBody"];
25488
27512
  };
25489
27513
  };
25490
- /** @description The requested content does not exist or is no longer available */
27514
+ /** @description Content does not exist or is no longer available */
25491
27515
  VideoManifestsReadById404Response: {
25492
27516
  headers: {
25493
27517
  [name: string]: unknown;