@tidal-music/api 0.24.1 → 0.26.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.
@@ -16,18 +16,18 @@ export interface paths {
16
16
  */
17
17
  get: {
18
18
  parameters: {
19
- query?: {
19
+ query: {
20
20
  /**
21
21
  * @description Allows the client to customize which related resources should be returned. Available options: owners, terms
22
22
  * @example owners
23
23
  */
24
24
  include?: string[];
25
25
  /** @description User id. Use `me` for the authenticated user */
26
- "filter[owners.id]"?: string[];
26
+ "filter[owners.id]": string[];
27
27
  /** @description Filter by terms.isLatestVersion */
28
28
  "filter[terms.isLatestVersion]"?: string[];
29
29
  /** @description One of: DEVELOPER, UPLOAD_MARKETPLACE (e.g. `DEVELOPER`) */
30
- "filter[terms.termsType]"?: ("DEVELOPER" | "UPLOAD_MARKETPLACE")[];
30
+ "filter[terms.termsType]": ("DEVELOPER" | "UPLOAD_MARKETPLACE")[];
31
31
  };
32
32
  header?: never;
33
33
  path?: never;
@@ -222,61 +222,6 @@ export interface paths {
222
222
  patch?: never;
223
223
  trace?: never;
224
224
  };
225
- "/albumStatistics": {
226
- parameters: {
227
- query?: never;
228
- header?: never;
229
- path?: never;
230
- cookie?: never;
231
- };
232
- /**
233
- * Get multiple albumStatistics.
234
- * @description Retrieves multiple albumStatistics by available filters, or without if applicable.
235
- */
236
- get: {
237
- parameters: {
238
- query?: {
239
- /**
240
- * @description Allows the client to customize which related resources should be returned. Available options: owners
241
- * @example owners
242
- */
243
- include?: string[];
244
- /** @description List of album IDs (e.g. `251380836`) */
245
- "filter[id]"?: string[];
246
- };
247
- header?: never;
248
- path?: never;
249
- cookie?: never;
250
- };
251
- requestBody?: never;
252
- responses: {
253
- /** @description Successful response */
254
- 200: {
255
- headers: {
256
- [name: string]: unknown;
257
- };
258
- content: {
259
- "application/vnd.api+json": components["schemas"]["AlbumStatistics_Multi_Resource_Data_Document"];
260
- };
261
- };
262
- 400: components["responses"]["Default400Response"];
263
- 404: components["responses"]["Default404Response"];
264
- 405: components["responses"]["Default405Response"];
265
- 406: components["responses"]["Default406Response"];
266
- 415: components["responses"]["Default415Response"];
267
- 429: components["responses"]["Default429Response"];
268
- 500: components["responses"]["Default500Response"];
269
- 503: components["responses"]["Default503Response"];
270
- };
271
- };
272
- put?: never;
273
- post?: never;
274
- delete?: never;
275
- options?: never;
276
- head?: never;
277
- patch?: never;
278
- trace?: never;
279
- };
280
225
  "/albumStatistics/{id}": {
281
226
  parameters: {
282
227
  query?: never;
@@ -427,7 +372,7 @@ export interface paths {
427
372
  include?: string[];
428
373
  /** @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`) */
429
374
  "filter[barcodeId]"?: string[];
430
- /** @description Album id (e.g. `251380836`) */
375
+ /** @description List of album IDs (e.g. `251380836`) */
431
376
  "filter[id]"?: string[];
432
377
  /** @description User id. Use `me` for the authenticated user */
433
378
  "filter[owners.id]"?: string[];
@@ -1629,66 +1574,6 @@ export interface paths {
1629
1574
  patch?: never;
1630
1575
  trace?: never;
1631
1576
  };
1632
- "/artistBiographies": {
1633
- parameters: {
1634
- query?: never;
1635
- header?: never;
1636
- path?: never;
1637
- cookie?: never;
1638
- };
1639
- /**
1640
- * Get multiple artistBiographies.
1641
- * @description Retrieves multiple artistBiographies by available filters, or without if applicable.
1642
- */
1643
- get: {
1644
- parameters: {
1645
- query?: {
1646
- /**
1647
- * @description ISO 3166-1 alpha-2 country code
1648
- * @example US
1649
- */
1650
- countryCode?: string;
1651
- /**
1652
- * @description Allows the client to customize which related resources should be returned. Available options: owners
1653
- * @example owners
1654
- */
1655
- include?: string[];
1656
- /** @description Artist id (e.g. `1566`) */
1657
- "filter[id]"?: string[];
1658
- };
1659
- header?: never;
1660
- path?: never;
1661
- cookie?: never;
1662
- };
1663
- requestBody?: never;
1664
- responses: {
1665
- /** @description Successful response */
1666
- 200: {
1667
- headers: {
1668
- [name: string]: unknown;
1669
- };
1670
- content: {
1671
- "application/vnd.api+json": components["schemas"]["ArtistBiographies_Multi_Resource_Data_Document"];
1672
- };
1673
- };
1674
- 400: components["responses"]["Default400Response"];
1675
- 404: components["responses"]["Default404Response"];
1676
- 405: components["responses"]["Default405Response"];
1677
- 406: components["responses"]["Default406Response"];
1678
- 415: components["responses"]["Default415Response"];
1679
- 429: components["responses"]["Default429Response"];
1680
- 500: components["responses"]["Default500Response"];
1681
- 503: components["responses"]["Default503Response"];
1682
- };
1683
- };
1684
- put?: never;
1685
- post?: never;
1686
- delete?: never;
1687
- options?: never;
1688
- head?: never;
1689
- patch?: never;
1690
- trace?: never;
1691
- };
1692
1577
  "/artistBiographies/{id}": {
1693
1578
  parameters: {
1694
1579
  query?: never;
@@ -1864,14 +1749,14 @@ export interface paths {
1864
1749
  */
1865
1750
  get: {
1866
1751
  parameters: {
1867
- query?: {
1752
+ query: {
1868
1753
  /**
1869
1754
  * @description Allows the client to customize which related resources should be returned. Available options: acceptedArtists, owners, recommendedArtists
1870
1755
  * @example acceptedArtists
1871
1756
  */
1872
1757
  include?: string[];
1873
1758
  /** @description User id. Use `me` for the authenticated user */
1874
- "filter[owners.id]"?: string[];
1759
+ "filter[owners.id]": string[];
1875
1760
  };
1876
1761
  header?: never;
1877
1762
  path?: never;
@@ -2313,56 +2198,6 @@ export interface paths {
2313
2198
  patch?: never;
2314
2199
  trace?: never;
2315
2200
  };
2316
- "/artistRoles": {
2317
- parameters: {
2318
- query?: never;
2319
- header?: never;
2320
- path?: never;
2321
- cookie?: never;
2322
- };
2323
- /**
2324
- * Get multiple artistRoles.
2325
- * @description Retrieves multiple artistRoles by available filters, or without if applicable.
2326
- */
2327
- get: {
2328
- parameters: {
2329
- query?: {
2330
- /** @description List of artist role IDs (e.g. `1`) */
2331
- "filter[id]"?: string[];
2332
- };
2333
- header?: never;
2334
- path?: never;
2335
- cookie?: never;
2336
- };
2337
- requestBody?: never;
2338
- responses: {
2339
- /** @description Successful response */
2340
- 200: {
2341
- headers: {
2342
- [name: string]: unknown;
2343
- };
2344
- content: {
2345
- "application/vnd.api+json": components["schemas"]["ArtistRoles_Multi_Resource_Data_Document"];
2346
- };
2347
- };
2348
- 400: components["responses"]["Default400Response"];
2349
- 404: components["responses"]["Default404Response"];
2350
- 405: components["responses"]["Default405Response"];
2351
- 406: components["responses"]["Default406Response"];
2352
- 415: components["responses"]["Default415Response"];
2353
- 429: components["responses"]["Default429Response"];
2354
- 500: components["responses"]["Default500Response"];
2355
- 503: components["responses"]["Default503Response"];
2356
- };
2357
- };
2358
- put?: never;
2359
- post?: never;
2360
- delete?: never;
2361
- options?: never;
2362
- head?: never;
2363
- patch?: never;
2364
- trace?: never;
2365
- };
2366
2201
  "/artistRoles/{id}": {
2367
2202
  parameters: {
2368
2203
  query?: never;
@@ -2442,7 +2277,7 @@ export interface paths {
2442
2277
  include?: string[];
2443
2278
  /** @description Artist handle (e.g. `jayz`) */
2444
2279
  "filter[handle]"?: string[];
2445
- /** @description Artist id (e.g. `1566`) */
2280
+ /** @description List of artist IDs (e.g. `1566`) */
2446
2281
  "filter[id]"?: string[];
2447
2282
  /** @description User id. Use `me` for the authenticated user */
2448
2283
  "filter[owners.id]"?: string[];
@@ -3523,7 +3358,7 @@ export interface paths {
3523
3358
  */
3524
3359
  get: {
3525
3360
  parameters: {
3526
- query?: {
3361
+ query: {
3527
3362
  /**
3528
3363
  * @description ISO 3166-1 alpha-2 country code
3529
3364
  * @example US
@@ -3535,7 +3370,7 @@ export interface paths {
3535
3370
  */
3536
3371
  include?: string[];
3537
3372
  /** @description Artwork id (e.g. `a468bee88def`) */
3538
- "filter[id]"?: string[];
3373
+ "filter[id]": string[];
3539
3374
  };
3540
3375
  header?: never;
3541
3376
  path?: never;
@@ -3748,14 +3583,14 @@ export interface paths {
3748
3583
  */
3749
3584
  get: {
3750
3585
  parameters: {
3751
- query?: {
3586
+ query: {
3752
3587
  /**
3753
3588
  * @description Allows the client to customize which related resources should be returned. Available options: owners
3754
3589
  * @example owners
3755
3590
  */
3756
3591
  include?: string[];
3757
3592
  /** @description User id. Use `me` for the authenticated user */
3758
- "filter[owners.id]"?: string[];
3593
+ "filter[owners.id]": string[];
3759
3594
  };
3760
3595
  header?: never;
3761
3596
  path?: never;
@@ -4020,35 +3855,83 @@ export interface paths {
4020
3855
  patch?: never;
4021
3856
  trace?: never;
4022
3857
  };
4023
- "/comments": {
3858
+ "/collaborationInviteRedemptions": {
4024
3859
  parameters: {
4025
3860
  query?: never;
4026
3861
  header?: never;
4027
3862
  path?: never;
4028
3863
  cookie?: never;
4029
3864
  };
3865
+ get?: never;
3866
+ put?: never;
4030
3867
  /**
4031
- * Get multiple comments.
4032
- * @description Retrieves multiple comments by available filters, or without if applicable.
3868
+ * Create single collaborationInviteRedemption.
3869
+ * @description Creates a new collaborationInviteRedemption.
3870
+ */
3871
+ post: {
3872
+ parameters: {
3873
+ query?: never;
3874
+ header?: {
3875
+ /** @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. */
3876
+ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
3877
+ };
3878
+ path?: never;
3879
+ cookie?: never;
3880
+ };
3881
+ requestBody?: {
3882
+ content: {
3883
+ "application/vnd.api+json": components["schemas"]["CollaborationInviteRedemptionsCreateOperation_Payload"];
3884
+ };
3885
+ };
3886
+ responses: {
3887
+ /** @description Successful response */
3888
+ 201: {
3889
+ headers: {
3890
+ [name: string]: unknown;
3891
+ };
3892
+ content: {
3893
+ "application/vnd.api+json": components["schemas"]["CollaborationInviteRedemptions_Single_Resource_Data_Document"];
3894
+ };
3895
+ };
3896
+ 400: components["responses"]["Default400Response"];
3897
+ 404: components["responses"]["Default404Response"];
3898
+ 405: components["responses"]["Default405Response"];
3899
+ 406: components["responses"]["Default406Response"];
3900
+ 409: components["responses"]["Idempotency409Response"];
3901
+ 415: components["responses"]["Default415Response"];
3902
+ 422: components["responses"]["Idempotency422Response"];
3903
+ 429: components["responses"]["Default429Response"];
3904
+ 500: components["responses"]["Default500Response"];
3905
+ 503: components["responses"]["Default503Response"];
3906
+ };
3907
+ };
3908
+ delete?: never;
3909
+ options?: never;
3910
+ head?: never;
3911
+ patch?: never;
3912
+ trace?: never;
3913
+ };
3914
+ "/collaborationInvites": {
3915
+ parameters: {
3916
+ query?: never;
3917
+ header?: never;
3918
+ path?: never;
3919
+ cookie?: never;
3920
+ };
3921
+ /**
3922
+ * Get multiple collaborationInvites.
3923
+ * @description Retrieves multiple collaborationInvites by available filters, or without if applicable.
4033
3924
  */
4034
3925
  get: {
4035
3926
  parameters: {
4036
- query?: {
4037
- /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
4038
- "page[cursor]"?: string;
4039
- /** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */
4040
- sort?: ("createdAt" | "-createdAt" | "likeCount" | "-likeCount" | "replyCount" | "-replyCount" | "startTime" | "-startTime")[];
3927
+ query: {
4041
3928
  /**
4042
- * @description Allows the client to customize which related resources should be returned. Available options: ownerProfiles, owners, parentComment
4043
- * @example ownerProfiles
3929
+ * @description Allows the client to customize which related resources should be returned. Available options: owners, subject
3930
+ * @example owners
4044
3931
  */
4045
3932
  include?: string[];
4046
- /** @description Filter by parent comment ID to get replies (e.g. `550e8400-e29b-41d4-a716-446655440000`) */
4047
- "filter[parentComment.id]"?: string[];
4048
- /** @description Filter by subject resource ID (e.g. `12345`) */
4049
- "filter[subject.id]"?: string[];
4050
- /** @description Filter by subject resource type (e.g. `albums`) */
4051
- "filter[subject.type]"?: ("albums" | "tracks")[];
3933
+ /** @description Invite code */
3934
+ "filter[code]": string[];
4052
3935
  };
4053
3936
  header?: never;
4054
3937
  path?: never;
@@ -4062,7 +3945,7 @@ export interface paths {
4062
3945
  [name: string]: unknown;
4063
3946
  };
4064
3947
  content: {
4065
- "application/vnd.api+json": components["schemas"]["Comments_Multi_Resource_Data_Document"];
3948
+ "application/vnd.api+json": components["schemas"]["CollaborationInvites_Multi_Resource_Data_Document"];
4066
3949
  };
4067
3950
  };
4068
3951
  400: components["responses"]["Default400Response"];
@@ -4077,8 +3960,8 @@ export interface paths {
4077
3960
  };
4078
3961
  put?: never;
4079
3962
  /**
4080
- * Create single comment.
4081
- * @description Creates a new comment.
3963
+ * Create single collaborationInvite.
3964
+ * @description Creates a new collaborationInvite.
4082
3965
  */
4083
3966
  post: {
4084
3967
  parameters: {
@@ -4092,7 +3975,7 @@ export interface paths {
4092
3975
  };
4093
3976
  requestBody?: {
4094
3977
  content: {
4095
- "application/vnd.api+json": components["schemas"]["CommentsCreateOperation_Payload"];
3978
+ "application/vnd.api+json": components["schemas"]["CollaborationInvitesCreateOperation_Payload"];
4096
3979
  };
4097
3980
  };
4098
3981
  responses: {
@@ -4102,7 +3985,7 @@ export interface paths {
4102
3985
  [name: string]: unknown;
4103
3986
  };
4104
3987
  content: {
4105
- "application/vnd.api+json": components["schemas"]["Comments_Single_Resource_Data_Document"];
3988
+ "application/vnd.api+json": components["schemas"]["CollaborationInvites_Single_Resource_Data_Document"];
4106
3989
  };
4107
3990
  };
4108
3991
  400: components["responses"]["Default400Response"];
@@ -4123,7 +4006,7 @@ export interface paths {
4123
4006
  patch?: never;
4124
4007
  trace?: never;
4125
4008
  };
4126
- "/comments/{id}": {
4009
+ "/collaborationInvites/{id}": {
4127
4010
  parameters: {
4128
4011
  query?: never;
4129
4012
  header?: never;
@@ -4131,22 +4014,22 @@ export interface paths {
4131
4014
  cookie?: never;
4132
4015
  };
4133
4016
  /**
4134
- * Get single comment.
4135
- * @description Retrieves single comment by id.
4017
+ * Get single collaborationInvite.
4018
+ * @description Retrieves single collaborationInvite by id.
4136
4019
  */
4137
4020
  get: {
4138
4021
  parameters: {
4139
4022
  query?: {
4140
4023
  /**
4141
- * @description Allows the client to customize which related resources should be returned. Available options: ownerProfiles, owners, parentComment
4142
- * @example ownerProfiles
4024
+ * @description Allows the client to customize which related resources should be returned. Available options: owners, subject
4025
+ * @example owners
4143
4026
  */
4144
4027
  include?: string[];
4145
4028
  };
4146
4029
  header?: never;
4147
4030
  path: {
4148
4031
  /**
4149
- * @description Comment Id
4032
+ * @description Collaboration invite id
4150
4033
  * @example 550e8400-e29b-41d4-a716-446655440000
4151
4034
  */
4152
4035
  id: string;
@@ -4161,7 +4044,7 @@ export interface paths {
4161
4044
  [name: string]: unknown;
4162
4045
  };
4163
4046
  content: {
4164
- "application/vnd.api+json": components["schemas"]["Comments_Single_Resource_Data_Document"];
4047
+ "application/vnd.api+json": components["schemas"]["CollaborationInvites_Single_Resource_Data_Document"];
4165
4048
  };
4166
4049
  };
4167
4050
  400: components["responses"]["Default400Response"];
@@ -4177,8 +4060,8 @@ export interface paths {
4177
4060
  put?: never;
4178
4061
  post?: never;
4179
4062
  /**
4180
- * Delete single comment.
4181
- * @description Deletes existing comment.
4063
+ * Delete single collaborationInvite.
4064
+ * @description Deletes existing collaborationInvite.
4182
4065
  */
4183
4066
  delete: {
4184
4067
  parameters: {
@@ -4189,7 +4072,7 @@ export interface paths {
4189
4072
  };
4190
4073
  path: {
4191
4074
  /**
4192
- * @description Comment Id
4075
+ * @description Collaboration invite id
4193
4076
  * @example 550e8400-e29b-41d4-a716-446655440000
4194
4077
  */
4195
4078
  id: string;
@@ -4212,13 +4095,328 @@ export interface paths {
4212
4095
  };
4213
4096
  options?: never;
4214
4097
  head?: never;
4215
- /**
4216
- * Update single comment.
4217
- * @description Updates existing comment.
4218
- */
4219
- patch: {
4220
- parameters: {
4221
- query?: never;
4098
+ patch?: never;
4099
+ trace?: never;
4100
+ };
4101
+ "/collaborationInvites/{id}/relationships/owners": {
4102
+ parameters: {
4103
+ query?: never;
4104
+ header?: never;
4105
+ path?: never;
4106
+ cookie?: never;
4107
+ };
4108
+ /**
4109
+ * Get owners relationship ("to-many").
4110
+ * @description Retrieves owners relationship.
4111
+ */
4112
+ get: {
4113
+ parameters: {
4114
+ query?: {
4115
+ /**
4116
+ * @description Allows the client to customize which related resources should be returned. Available options: owners
4117
+ * @example owners
4118
+ */
4119
+ include?: string[];
4120
+ /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
4121
+ "page[cursor]"?: string;
4122
+ };
4123
+ header?: never;
4124
+ path: {
4125
+ /**
4126
+ * @description Collaboration invite id
4127
+ * @example 550e8400-e29b-41d4-a716-446655440000
4128
+ */
4129
+ id: string;
4130
+ };
4131
+ cookie?: never;
4132
+ };
4133
+ requestBody?: never;
4134
+ responses: {
4135
+ /** @description Successful response */
4136
+ 200: {
4137
+ headers: {
4138
+ [name: string]: unknown;
4139
+ };
4140
+ content: {
4141
+ "application/vnd.api+json": components["schemas"]["CollaborationInvites_Multi_Relationship_Data_Document"];
4142
+ };
4143
+ };
4144
+ 400: components["responses"]["Default400Response"];
4145
+ 404: components["responses"]["Default404Response"];
4146
+ 405: components["responses"]["Default405Response"];
4147
+ 406: components["responses"]["Default406Response"];
4148
+ 415: components["responses"]["Default415Response"];
4149
+ 429: components["responses"]["Default429Response"];
4150
+ 500: components["responses"]["Default500Response"];
4151
+ 503: components["responses"]["Default503Response"];
4152
+ };
4153
+ };
4154
+ put?: never;
4155
+ post?: never;
4156
+ delete?: never;
4157
+ options?: never;
4158
+ head?: never;
4159
+ patch?: never;
4160
+ trace?: never;
4161
+ };
4162
+ "/collaborationInvites/{id}/relationships/subject": {
4163
+ parameters: {
4164
+ query?: never;
4165
+ header?: never;
4166
+ path?: never;
4167
+ cookie?: never;
4168
+ };
4169
+ /**
4170
+ * Get subject relationship ("to-one").
4171
+ * @description Retrieves subject relationship.
4172
+ */
4173
+ get: {
4174
+ parameters: {
4175
+ query?: {
4176
+ /**
4177
+ * @description Allows the client to customize which related resources should be returned. Available options: subject
4178
+ * @example subject
4179
+ */
4180
+ include?: string[];
4181
+ };
4182
+ header?: never;
4183
+ path: {
4184
+ /**
4185
+ * @description Collaboration invite id
4186
+ * @example 550e8400-e29b-41d4-a716-446655440000
4187
+ */
4188
+ id: string;
4189
+ };
4190
+ cookie?: never;
4191
+ };
4192
+ requestBody?: never;
4193
+ responses: {
4194
+ /** @description Successful response */
4195
+ 200: {
4196
+ headers: {
4197
+ [name: string]: unknown;
4198
+ };
4199
+ content: {
4200
+ "application/vnd.api+json": components["schemas"]["CollaborationInvites_Single_Relationship_Data_Document"];
4201
+ };
4202
+ };
4203
+ 400: components["responses"]["Default400Response"];
4204
+ 404: components["responses"]["Default404Response"];
4205
+ 405: components["responses"]["Default405Response"];
4206
+ 406: components["responses"]["Default406Response"];
4207
+ 415: components["responses"]["Default415Response"];
4208
+ 429: components["responses"]["Default429Response"];
4209
+ 500: components["responses"]["Default500Response"];
4210
+ 503: components["responses"]["Default503Response"];
4211
+ };
4212
+ };
4213
+ put?: never;
4214
+ post?: never;
4215
+ delete?: never;
4216
+ options?: never;
4217
+ head?: never;
4218
+ patch?: never;
4219
+ trace?: never;
4220
+ };
4221
+ "/comments": {
4222
+ parameters: {
4223
+ query?: never;
4224
+ header?: never;
4225
+ path?: never;
4226
+ cookie?: never;
4227
+ };
4228
+ /**
4229
+ * Get multiple comments.
4230
+ * @description Retrieves multiple comments by available filters, or without if applicable.
4231
+ */
4232
+ get: {
4233
+ parameters: {
4234
+ query: {
4235
+ /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
4236
+ "page[cursor]"?: string;
4237
+ /** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */
4238
+ sort?: ("createdAt" | "-createdAt" | "likeCount" | "-likeCount" | "replyCount" | "-replyCount" | "startTime" | "-startTime")[];
4239
+ /**
4240
+ * @description Allows the client to customize which related resources should be returned. Available options: ownerProfiles, owners, parentComment
4241
+ * @example ownerProfiles
4242
+ */
4243
+ include?: string[];
4244
+ /** @description Filter by parent comment ID to get replies (e.g. `550e8400-e29b-41d4-a716-446655440000`) */
4245
+ "filter[parentComment.id]"?: string[];
4246
+ /** @description Filter by subject resource ID (e.g. `12345`) */
4247
+ "filter[subject.id]": string[];
4248
+ /** @description Filter by subject resource type (e.g. `albums`) */
4249
+ "filter[subject.type]": ("albums" | "tracks")[];
4250
+ };
4251
+ header?: never;
4252
+ path?: never;
4253
+ cookie?: never;
4254
+ };
4255
+ requestBody?: never;
4256
+ responses: {
4257
+ /** @description Successful response */
4258
+ 200: {
4259
+ headers: {
4260
+ [name: string]: unknown;
4261
+ };
4262
+ content: {
4263
+ "application/vnd.api+json": components["schemas"]["Comments_Multi_Resource_Data_Document"];
4264
+ };
4265
+ };
4266
+ 400: components["responses"]["Default400Response"];
4267
+ 404: components["responses"]["Default404Response"];
4268
+ 405: components["responses"]["Default405Response"];
4269
+ 406: components["responses"]["Default406Response"];
4270
+ 415: components["responses"]["Default415Response"];
4271
+ 429: components["responses"]["Default429Response"];
4272
+ 500: components["responses"]["Default500Response"];
4273
+ 503: components["responses"]["Default503Response"];
4274
+ };
4275
+ };
4276
+ put?: never;
4277
+ /**
4278
+ * Create single comment.
4279
+ * @description Creates a new comment.
4280
+ */
4281
+ post: {
4282
+ parameters: {
4283
+ query?: never;
4284
+ header?: {
4285
+ /** @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. */
4286
+ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
4287
+ };
4288
+ path?: never;
4289
+ cookie?: never;
4290
+ };
4291
+ requestBody?: {
4292
+ content: {
4293
+ "application/vnd.api+json": components["schemas"]["CommentsCreateOperation_Payload"];
4294
+ };
4295
+ };
4296
+ responses: {
4297
+ /** @description Successful response */
4298
+ 201: {
4299
+ headers: {
4300
+ [name: string]: unknown;
4301
+ };
4302
+ content: {
4303
+ "application/vnd.api+json": components["schemas"]["Comments_Single_Resource_Data_Document"];
4304
+ };
4305
+ };
4306
+ 400: components["responses"]["Default400Response"];
4307
+ 404: components["responses"]["Default404Response"];
4308
+ 405: components["responses"]["Default405Response"];
4309
+ 406: components["responses"]["Default406Response"];
4310
+ 409: components["responses"]["Idempotency409Response"];
4311
+ 415: components["responses"]["Default415Response"];
4312
+ 422: components["responses"]["Idempotency422Response"];
4313
+ 429: components["responses"]["Default429Response"];
4314
+ 500: components["responses"]["Default500Response"];
4315
+ 503: components["responses"]["Default503Response"];
4316
+ };
4317
+ };
4318
+ delete?: never;
4319
+ options?: never;
4320
+ head?: never;
4321
+ patch?: never;
4322
+ trace?: never;
4323
+ };
4324
+ "/comments/{id}": {
4325
+ parameters: {
4326
+ query?: never;
4327
+ header?: never;
4328
+ path?: never;
4329
+ cookie?: never;
4330
+ };
4331
+ /**
4332
+ * Get single comment.
4333
+ * @description Retrieves single comment by id.
4334
+ */
4335
+ get: {
4336
+ parameters: {
4337
+ query?: {
4338
+ /**
4339
+ * @description Allows the client to customize which related resources should be returned. Available options: ownerProfiles, owners, parentComment
4340
+ * @example ownerProfiles
4341
+ */
4342
+ include?: string[];
4343
+ };
4344
+ header?: never;
4345
+ path: {
4346
+ /**
4347
+ * @description Comment Id
4348
+ * @example 550e8400-e29b-41d4-a716-446655440000
4349
+ */
4350
+ id: string;
4351
+ };
4352
+ cookie?: never;
4353
+ };
4354
+ requestBody?: never;
4355
+ responses: {
4356
+ /** @description Successful response */
4357
+ 200: {
4358
+ headers: {
4359
+ [name: string]: unknown;
4360
+ };
4361
+ content: {
4362
+ "application/vnd.api+json": components["schemas"]["Comments_Single_Resource_Data_Document"];
4363
+ };
4364
+ };
4365
+ 400: components["responses"]["Default400Response"];
4366
+ 404: components["responses"]["Default404Response"];
4367
+ 405: components["responses"]["Default405Response"];
4368
+ 406: components["responses"]["Default406Response"];
4369
+ 415: components["responses"]["Default415Response"];
4370
+ 429: components["responses"]["Default429Response"];
4371
+ 500: components["responses"]["Default500Response"];
4372
+ 503: components["responses"]["Default503Response"];
4373
+ };
4374
+ };
4375
+ put?: never;
4376
+ post?: never;
4377
+ /**
4378
+ * Delete single comment.
4379
+ * @description Deletes existing comment.
4380
+ */
4381
+ delete: {
4382
+ parameters: {
4383
+ query?: never;
4384
+ header?: {
4385
+ /** @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. */
4386
+ "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
4387
+ };
4388
+ path: {
4389
+ /**
4390
+ * @description Comment Id
4391
+ * @example 550e8400-e29b-41d4-a716-446655440000
4392
+ */
4393
+ id: string;
4394
+ };
4395
+ cookie?: never;
4396
+ };
4397
+ requestBody?: never;
4398
+ responses: {
4399
+ 400: components["responses"]["Default400Response"];
4400
+ 404: components["responses"]["Default404Response"];
4401
+ 405: components["responses"]["Default405Response"];
4402
+ 406: components["responses"]["Default406Response"];
4403
+ 409: components["responses"]["Idempotency409Response"];
4404
+ 415: components["responses"]["Default415Response"];
4405
+ 422: components["responses"]["Idempotency422Response"];
4406
+ 429: components["responses"]["Default429Response"];
4407
+ 500: components["responses"]["Default500Response"];
4408
+ 503: components["responses"]["Default503Response"];
4409
+ };
4410
+ };
4411
+ options?: never;
4412
+ head?: never;
4413
+ /**
4414
+ * Update single comment.
4415
+ * @description Updates existing comment.
4416
+ */
4417
+ patch: {
4418
+ parameters: {
4419
+ query?: never;
4222
4420
  header?: {
4223
4421
  /** @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. */
4224
4422
  "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
@@ -4446,14 +4644,14 @@ export interface paths {
4446
4644
  */
4447
4645
  get: {
4448
4646
  parameters: {
4449
- query?: {
4647
+ query: {
4450
4648
  /**
4451
4649
  * @description Allows the client to customize which related resources should be returned. Available options: claimedResource, claimingArtist, owners
4452
4650
  * @example claimedResource
4453
4651
  */
4454
4652
  include?: string[];
4455
4653
  /** @description User id. Use `me` for the authenticated user */
4456
- "filter[owners.id]"?: string[];
4654
+ "filter[owners.id]": string[];
4457
4655
  };
4458
4656
  header?: never;
4459
4657
  path?: never;
@@ -4730,66 +4928,11 @@ export interface paths {
4730
4928
  header?: never;
4731
4929
  path: {
4732
4930
  /**
4733
- * @description Content claim id
4734
- * @example f47ac10b-58cc-4372-a567-0e02b2c3d479
4735
- */
4736
- id: string;
4737
- };
4738
- cookie?: never;
4739
- };
4740
- requestBody?: never;
4741
- responses: {
4742
- /** @description Successful response */
4743
- 200: {
4744
- headers: {
4745
- [name: string]: unknown;
4746
- };
4747
- content: {
4748
- "application/vnd.api+json": components["schemas"]["ContentClaims_Multi_Relationship_Data_Document"];
4749
- };
4750
- };
4751
- 400: components["responses"]["Default400Response"];
4752
- 404: components["responses"]["Default404Response"];
4753
- 405: components["responses"]["Default405Response"];
4754
- 406: components["responses"]["Default406Response"];
4755
- 415: components["responses"]["Default415Response"];
4756
- 429: components["responses"]["Default429Response"];
4757
- 500: components["responses"]["Default500Response"];
4758
- 503: components["responses"]["Default503Response"];
4759
- };
4760
- };
4761
- put?: never;
4762
- post?: never;
4763
- delete?: never;
4764
- options?: never;
4765
- head?: never;
4766
- patch?: never;
4767
- trace?: never;
4768
- };
4769
- "/credits": {
4770
- parameters: {
4771
- query?: never;
4772
- header?: never;
4773
- path?: never;
4774
- cookie?: never;
4775
- };
4776
- /**
4777
- * Get multiple credits.
4778
- * @description Retrieves multiple credits by available filters, or without if applicable.
4779
- */
4780
- get: {
4781
- parameters: {
4782
- query?: {
4783
- /**
4784
- * @description Allows the client to customize which related resources should be returned. Available options: artist, category
4785
- * @example artist
4931
+ * @description Content claim id
4932
+ * @example f47ac10b-58cc-4372-a567-0e02b2c3d479
4786
4933
  */
4787
- include?: string[];
4788
- /** @description List of credit IDs (e.g. `3fG7kLmN2pQrStUv`) */
4789
- "filter[id]"?: string[];
4934
+ id: string;
4790
4935
  };
4791
- header?: never;
4792
- path?: never;
4793
4936
  cookie?: never;
4794
4937
  };
4795
4938
  requestBody?: never;
@@ -4800,7 +4943,7 @@ export interface paths {
4800
4943
  [name: string]: unknown;
4801
4944
  };
4802
4945
  content: {
4803
- "application/vnd.api+json": components["schemas"]["Credits_Multi_Resource_Data_Document"];
4946
+ "application/vnd.api+json": components["schemas"]["ContentClaims_Multi_Relationship_Data_Document"];
4804
4947
  };
4805
4948
  };
4806
4949
  400: components["responses"]["Default400Response"];
@@ -5011,14 +5154,14 @@ export interface paths {
5011
5154
  */
5012
5155
  get: {
5013
5156
  parameters: {
5014
- query?: {
5157
+ query: {
5015
5158
  /**
5016
5159
  * @description Allows the client to customize which related resources should be returned. Available options: owners
5017
5160
  * @example owners
5018
5161
  */
5019
5162
  include?: string[];
5020
5163
  /** @description Download id (e.g. `VFJBQ0tTOjEyMzQ1`) */
5021
- "filter[id]"?: string[];
5164
+ "filter[id]": string[];
5022
5165
  };
5023
5166
  header?: never;
5024
5167
  path?: never;
@@ -5186,16 +5329,16 @@ export interface paths {
5186
5329
  */
5187
5330
  get: {
5188
5331
  parameters: {
5189
- query?: {
5332
+ query: {
5190
5333
  /**
5191
5334
  * @description Allows the client to customize which related resources should be returned. Available options: subject
5192
5335
  * @example subject
5193
5336
  */
5194
5337
  include?: string[];
5195
5338
  /** @description The id of the subject resource */
5196
- "filter[subject.id]"?: string[];
5339
+ "filter[subject.id]": string[];
5197
5340
  /** @description The type of the subject resource (e.g., albums, tracks, artists) (e.g. `tracks`) */
5198
- "filter[subject.type]"?: ("tracks" | "albums" | "artists")[];
5341
+ "filter[subject.type]": ("tracks" | "albums" | "artists")[];
5199
5342
  };
5200
5343
  header?: never;
5201
5344
  path?: never;
@@ -5289,87 +5432,6 @@ export interface paths {
5289
5432
  patch?: never;
5290
5433
  trace?: never;
5291
5434
  };
5292
- "/dynamicModules": {
5293
- parameters: {
5294
- query?: never;
5295
- header?: never;
5296
- path?: never;
5297
- cookie?: never;
5298
- };
5299
- /**
5300
- * Get multiple dynamicModules.
5301
- * @description Retrieves multiple dynamicModules by available filters, or without if applicable.
5302
- */
5303
- get: {
5304
- parameters: {
5305
- query: {
5306
- refreshId?: string;
5307
- /**
5308
- * @description ISO 3166-1 alpha-2 country code
5309
- * @example US
5310
- */
5311
- countryCode?: string;
5312
- /**
5313
- * @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.
5314
- * @example en-US
5315
- */
5316
- locale?: string;
5317
- /**
5318
- * @description The type of device making the request
5319
- * @example PHONE
5320
- */
5321
- deviceType: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV";
5322
- /**
5323
- * @description The system type of the device making the request
5324
- * @example IOS
5325
- */
5326
- systemType: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB";
5327
- /**
5328
- * @description Client version number
5329
- * @example 2026.0.1
5330
- */
5331
- clientVersion: string;
5332
- /**
5333
- * @description Allows the client to customize which related resources should be returned. Available options: items
5334
- * @example items
5335
- */
5336
- include?: string[];
5337
- /** @description DynamicModules Id (e.g. `nejMcAhh5N8S3EQ4LaqysVdI0cZZ`) */
5338
- "filter[id]"?: string[];
5339
- };
5340
- header?: never;
5341
- path?: never;
5342
- cookie?: never;
5343
- };
5344
- requestBody?: never;
5345
- responses: {
5346
- /** @description Successful response */
5347
- 200: {
5348
- headers: {
5349
- [name: string]: unknown;
5350
- };
5351
- content: {
5352
- "application/vnd.api+json": components["schemas"]["DynamicModules_Multi_Resource_Data_Document"];
5353
- };
5354
- };
5355
- 400: components["responses"]["Default400Response"];
5356
- 404: components["responses"]["Default404Response"];
5357
- 405: components["responses"]["Default405Response"];
5358
- 406: components["responses"]["Default406Response"];
5359
- 415: components["responses"]["Default415Response"];
5360
- 429: components["responses"]["Default429Response"];
5361
- 500: components["responses"]["Default500Response"];
5362
- 503: components["responses"]["Default503Response"];
5363
- };
5364
- };
5365
- put?: never;
5366
- post?: never;
5367
- delete?: never;
5368
- options?: never;
5369
- head?: never;
5370
- patch?: never;
5371
- trace?: never;
5372
- };
5373
5435
  "/dynamicModules/{id}/relationships/items": {
5374
5436
  parameters: {
5375
5437
  query?: never;
@@ -5503,9 +5565,9 @@ export interface paths {
5503
5565
  */
5504
5566
  include?: string[];
5505
5567
  /** @description type of the page (e.g. `ARTIST`) */
5506
- "filter[pageType]"?: string[];
5568
+ "filter[pageType]": string[];
5507
5569
  /** @description the subject id, eg. artistId (e.g. `67890`) */
5508
- "filter[subject.id]"?: string[];
5570
+ "filter[subject.id]": string[];
5509
5571
  };
5510
5572
  header?: never;
5511
5573
  path?: never;
@@ -5699,7 +5761,7 @@ export interface paths {
5699
5761
  */
5700
5762
  get: {
5701
5763
  parameters: {
5702
- query?: {
5764
+ query: {
5703
5765
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
5704
5766
  "page[cursor]"?: string;
5705
5767
  /**
@@ -5708,7 +5770,7 @@ export interface paths {
5708
5770
  */
5709
5771
  locale?: string;
5710
5772
  /** @description Allows filtering by genre id(s). USER_SELECTABLE is special value used to return specific genres which users can select from (e.g. `'1,2,3' or 'USER_SELECTABLE'`) */
5711
- "filter[id]"?: string[];
5773
+ "filter[id]": string[];
5712
5774
  };
5713
5775
  header?: never;
5714
5776
  path?: never;
@@ -5825,8 +5887,6 @@ export interface paths {
5825
5887
  include?: string[];
5826
5888
  /** @description Client-provided installation identifier to filter by (e.g. `a468bee88def`) */
5827
5889
  "filter[clientProvidedInstallationId]"?: string[];
5828
- /** @description List of installation IDs (e.g. `a468bee88def`) */
5829
- "filter[id]"?: string[];
5830
5890
  /** @description User ID to filter by. Use `me` for the authenticated user */
5831
5891
  "filter[owners.id]"?: string[];
5832
5892
  };
@@ -5975,7 +6035,7 @@ export interface paths {
5975
6035
  */
5976
6036
  get: {
5977
6037
  parameters: {
5978
- query?: {
6038
+ query: {
5979
6039
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
5980
6040
  "page[cursor]"?: string;
5981
6041
  /**
@@ -5988,7 +6048,7 @@ export interface paths {
5988
6048
  /** @description One of: PENDING, STORED (e.g. `PENDING`) */
5989
6049
  "filter[state]"?: ("PENDING" | "STORED")[];
5990
6050
  /** @description One of: tracks, videos, albums, playlists, userCollectionTracks (e.g. `tracks`) */
5991
- "filter[type]"?: ("tracks" | "videos" | "albums" | "playlists" | "userCollectionTracks")[];
6051
+ "filter[type]": ("tracks" | "videos" | "albums" | "playlists" | "userCollectionTracks")[];
5992
6052
  };
5993
6053
  header?: never;
5994
6054
  path: {
@@ -6171,46 +6231,7 @@ export interface paths {
6171
6231
  path?: never;
6172
6232
  cookie?: never;
6173
6233
  };
6174
- /**
6175
- * Get multiple lyrics.
6176
- * @description Retrieves multiple lyrics by available filters, or without if applicable.
6177
- */
6178
- get: {
6179
- parameters: {
6180
- query?: {
6181
- /**
6182
- * @description Allows the client to customize which related resources should be returned. Available options: owners, track
6183
- * @example owners
6184
- */
6185
- include?: string[];
6186
- /** @description Lyrics Id (e.g. `nejMcAhh5N8S3EQ4LaqysVdI0cZZ`) */
6187
- "filter[id]"?: string[];
6188
- };
6189
- header?: never;
6190
- path?: never;
6191
- cookie?: never;
6192
- };
6193
- requestBody?: never;
6194
- responses: {
6195
- /** @description Successful response */
6196
- 200: {
6197
- headers: {
6198
- [name: string]: unknown;
6199
- };
6200
- content: {
6201
- "application/vnd.api+json": components["schemas"]["Lyrics_Multi_Resource_Data_Document"];
6202
- };
6203
- };
6204
- 400: components["responses"]["Default400Response"];
6205
- 404: components["responses"]["Default404Response"];
6206
- 405: components["responses"]["Default405Response"];
6207
- 406: components["responses"]["Default406Response"];
6208
- 415: components["responses"]["Default415Response"];
6209
- 429: components["responses"]["Default429Response"];
6210
- 500: components["responses"]["Default500Response"];
6211
- 503: components["responses"]["Default503Response"];
6212
- };
6213
- };
6234
+ get?: never;
6214
6235
  put?: never;
6215
6236
  /**
6216
6237
  * Create single lyric.
@@ -6587,7 +6608,7 @@ export interface paths {
6587
6608
  */
6588
6609
  get: {
6589
6610
  parameters: {
6590
- query?: {
6611
+ query: {
6591
6612
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
6592
6613
  "page[cursor]"?: string;
6593
6614
  /**
@@ -6595,10 +6616,8 @@ export interface paths {
6595
6616
  * @example collection
6596
6617
  */
6597
6618
  include?: string[];
6598
- /** @description List of offline task IDs (e.g. `a468bee8-8def-4a1b-8c1e-123456789abc`) */
6599
- "filter[id]"?: string[];
6600
6619
  /** @description List of offline task IDs (e.g. `a468bee88def`) */
6601
- "filter[installation.id]"?: string[];
6620
+ "filter[installation.id]": string[];
6602
6621
  };
6603
6622
  header?: never;
6604
6623
  path?: never;
@@ -6921,7 +6940,7 @@ export interface paths {
6921
6940
  */
6922
6941
  get: {
6923
6942
  parameters: {
6924
- query?: {
6943
+ query: {
6925
6944
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
6926
6945
  "page[cursor]"?: string;
6927
6946
  /**
@@ -6930,7 +6949,7 @@ export interface paths {
6930
6949
  */
6931
6950
  include?: string[];
6932
6951
  /** @description User id. Use `me` for the authenticated user */
6933
- "filter[owners.id]"?: string[];
6952
+ "filter[owners.id]": string[];
6934
6953
  };
6935
6954
  header?: never;
6936
6955
  path?: never;
@@ -7552,7 +7571,7 @@ export interface paths {
7552
7571
  * @example collaboratorProfiles
7553
7572
  */
7554
7573
  include?: string[];
7555
- /** @description Playlist id (e.g. `550e8400-e29b-41d4-a716-446655440000`) */
7574
+ /** @description List of playlist IDs (e.g. `550e8400-e29b-41d4-a716-446655440000`) */
7556
7575
  "filter[id]"?: string[];
7557
7576
  /** @description User id. Use `me` for the authenticated user */
7558
7577
  "filter[owners.id]"?: string[];
@@ -8422,9 +8441,9 @@ export interface paths {
8422
8441
  */
8423
8442
  get: {
8424
8443
  parameters: {
8425
- query?: {
8444
+ query: {
8426
8445
  /** @description List of price configurations IDs (e.g. `cHJpY2UtY29uZmlnLTEyMzpVUw`) */
8427
- "filter[id]"?: string[];
8446
+ "filter[id]": string[];
8428
8447
  };
8429
8448
  header?: never;
8430
8449
  path?: never;
@@ -8565,14 +8584,14 @@ export interface paths {
8565
8584
  */
8566
8585
  get: {
8567
8586
  parameters: {
8568
- query?: {
8587
+ query: {
8569
8588
  /**
8570
8589
  * @description Allows the client to customize which related resources should be returned. Available options: owners, provider
8571
8590
  * @example owners
8572
8591
  */
8573
8592
  include?: string[];
8574
8593
  /** @description User id. Use `me` for the authenticated user */
8575
- "filter[owners.id]"?: string[];
8594
+ "filter[owners.id]": string[];
8576
8595
  };
8577
8596
  header?: never;
8578
8597
  path?: never;
@@ -8734,7 +8753,7 @@ export interface paths {
8734
8753
  */
8735
8754
  get: {
8736
8755
  parameters: {
8737
- query?: {
8756
+ query: {
8738
8757
  /**
8739
8758
  * @description ISO 3166-1 alpha-2 country code
8740
8759
  * @example US
@@ -8746,9 +8765,9 @@ export interface paths {
8746
8765
  */
8747
8766
  include?: string[];
8748
8767
  /** @description List of barcode IDs (EAN-13 or UPC-A) (e.g. `00602527336510`) */
8749
- "filter[barcodeId]"?: string[];
8768
+ "filter[barcodeId]": string[];
8750
8769
  /** @description Content provider ID (e.g. `50`) */
8751
- "filter[provider.id]"?: string[];
8770
+ "filter[provider.id]": string[];
8752
8771
  };
8753
8772
  header?: never;
8754
8773
  path?: never;
@@ -8900,56 +8919,6 @@ export interface paths {
8900
8919
  patch?: never;
8901
8920
  trace?: never;
8902
8921
  };
8903
- "/providers": {
8904
- parameters: {
8905
- query?: never;
8906
- header?: never;
8907
- path?: never;
8908
- cookie?: never;
8909
- };
8910
- /**
8911
- * Get multiple providers.
8912
- * @description Retrieves multiple providers by available filters, or without if applicable.
8913
- */
8914
- get: {
8915
- parameters: {
8916
- query?: {
8917
- /** @description List of provider IDs (e.g. `12345`) */
8918
- "filter[id]"?: string[];
8919
- };
8920
- header?: never;
8921
- path?: never;
8922
- cookie?: never;
8923
- };
8924
- requestBody?: never;
8925
- responses: {
8926
- /** @description Successful response */
8927
- 200: {
8928
- headers: {
8929
- [name: string]: unknown;
8930
- };
8931
- content: {
8932
- "application/vnd.api+json": components["schemas"]["Providers_Multi_Resource_Data_Document"];
8933
- };
8934
- };
8935
- 400: components["responses"]["Default400Response"];
8936
- 404: components["responses"]["Default404Response"];
8937
- 405: components["responses"]["Default405Response"];
8938
- 406: components["responses"]["Default406Response"];
8939
- 415: components["responses"]["Default415Response"];
8940
- 429: components["responses"]["Default429Response"];
8941
- 500: components["responses"]["Default500Response"];
8942
- 503: components["responses"]["Default503Response"];
8943
- };
8944
- };
8945
- put?: never;
8946
- post?: never;
8947
- delete?: never;
8948
- options?: never;
8949
- head?: never;
8950
- patch?: never;
8951
- trace?: never;
8952
- };
8953
8922
  "/providers/{id}": {
8954
8923
  parameters: {
8955
8924
  query?: never;
@@ -9016,7 +8985,7 @@ export interface paths {
9016
8985
  */
9017
8986
  get: {
9018
8987
  parameters: {
9019
- query?: {
8988
+ query: {
9020
8989
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
9021
8990
  "page[cursor]"?: string;
9022
8991
  /**
@@ -9025,9 +8994,9 @@ export interface paths {
9025
8994
  */
9026
8995
  include?: string[];
9027
8996
  /** @description User id. Use `me` for the authenticated user */
9028
- "filter[owners.id]"?: string[];
8997
+ "filter[owners.id]": string[];
9029
8998
  /** @description The type of purchased content (e.g. `albums`) */
9030
- "filter[subject.type]"?: ("albums" | "tracks")[];
8999
+ "filter[subject.type]": ("albums" | "tracks")[];
9031
9000
  };
9032
9001
  header?: never;
9033
9002
  path?: never;
@@ -9195,7 +9164,7 @@ export interface paths {
9195
9164
  */
9196
9165
  get: {
9197
9166
  parameters: {
9198
- query?: {
9167
+ query: {
9199
9168
  stats?: "ALL" | "COUNTS_BY_TYPE" | "TOTAL_COUNT";
9200
9169
  statsOnly?: boolean;
9201
9170
  viewerContext?: string;
@@ -9209,9 +9178,9 @@ export interface paths {
9209
9178
  /** @description Filter by emoji (e.g. `👍`) */
9210
9179
  "filter[emoji]"?: string[];
9211
9180
  /** @description Filter by subject resource ID (e.g. `12345`) */
9212
- "filter[subject.id]"?: string[];
9181
+ "filter[subject.id]": string[];
9213
9182
  /** @description Filter by subject resource type (e.g. `albums`) */
9214
- "filter[subject.type]"?: ("albums" | "tracks" | "artists" | "videos" | "playlists" | "comments")[];
9183
+ "filter[subject.type]": ("albums" | "tracks" | "artists" | "videos" | "playlists" | "comments")[];
9215
9184
  };
9216
9185
  header?: never;
9217
9186
  path?: never;
@@ -9513,7 +9482,7 @@ export interface paths {
9513
9482
  patch?: never;
9514
9483
  trace?: never;
9515
9484
  };
9516
- "/searchHistoryEntries": {
9485
+ "/scopes": {
9517
9486
  parameters: {
9518
9487
  query?: never;
9519
9488
  header?: never;
@@ -9521,19 +9490,14 @@ export interface paths {
9521
9490
  cookie?: never;
9522
9491
  };
9523
9492
  /**
9524
- * Get multiple searchHistoryEntries.
9525
- * @description Retrieves multiple searchHistoryEntries by available filters, or without if applicable.
9493
+ * Get multiple scopes.
9494
+ * @description Retrieves multiple scopes by available filters, or without if applicable.
9526
9495
  */
9527
9496
  get: {
9528
9497
  parameters: {
9529
- query?: {
9530
- /**
9531
- * @description ISO 3166-1 alpha-2 country code
9532
- * @example US
9533
- */
9534
- countryCode?: string;
9535
- /** @description Opaque identifier for a search history entry (e.g. `MjcyNjg5OTAjamF5`) */
9536
- "filter[id]"?: string[];
9498
+ query: {
9499
+ /** @description Filters scopes by their `requiredAccessTier`. (e.g. `THIRD_PARTY`) */
9500
+ "filter[requiredAccessTier]": ("THIRD_PARTY" | "THIRD_PARTY_PROD" | "PARTNER" | "INTERNAL")[];
9537
9501
  };
9538
9502
  header?: never;
9539
9503
  path?: never;
@@ -9547,7 +9511,7 @@ export interface paths {
9547
9511
  [name: string]: unknown;
9548
9512
  };
9549
9513
  content: {
9550
- "application/vnd.api+json": components["schemas"]["SearchHistoryEntries_Multi_Resource_Data_Document"];
9514
+ "application/vnd.api+json": components["schemas"]["Scopes_Multi_Resource_Data_Document"];
9551
9515
  };
9552
9516
  };
9553
9517
  400: components["responses"]["Default400Response"];
@@ -10336,16 +10300,14 @@ export interface paths {
10336
10300
  */
10337
10301
  get: {
10338
10302
  parameters: {
10339
- query?: {
10303
+ query: {
10340
10304
  /**
10341
10305
  * @description Allows the client to customize which related resources should be returned. Available options: owners, sharedResources
10342
10306
  * @example owners
10343
10307
  */
10344
10308
  include?: string[];
10345
10309
  /** @description A share code (e.g. `xyz`) */
10346
- "filter[code]"?: string[];
10347
- /** @description List of shares IDs (e.g. `a468bee88def`) */
10348
- "filter[id]"?: string[];
10310
+ "filter[code]": string[];
10349
10311
  };
10350
10312
  header?: never;
10351
10313
  path?: never;
@@ -10618,6 +10580,7 @@ export interface paths {
10618
10580
  parameters: {
10619
10581
  query?: {
10620
10582
  /**
10583
+ * @deprecated
10621
10584
  * @description ISO 3166-1 alpha-2 country code
10622
10585
  * @example US
10623
10586
  */
@@ -10729,14 +10692,14 @@ export interface paths {
10729
10692
  */
10730
10693
  get: {
10731
10694
  parameters: {
10732
- query?: {
10695
+ query: {
10733
10696
  /**
10734
10697
  * @description Allows the client to customize which related resources should be returned. Available options: owners
10735
10698
  * @example owners
10736
10699
  */
10737
10700
  include?: string[];
10738
10701
  /** @description User id. Use `me` for the authenticated user */
10739
- "filter[owners.id]"?: string[];
10702
+ "filter[owners.id]": string[];
10740
10703
  };
10741
10704
  header?: never;
10742
10705
  path?: never;
@@ -10891,14 +10854,14 @@ export interface paths {
10891
10854
  */
10892
10855
  get: {
10893
10856
  parameters: {
10894
- query?: {
10857
+ query: {
10895
10858
  /**
10896
10859
  * @description Allows the client to customize which related resources should be returned. Available options: owners
10897
10860
  * @example owners
10898
10861
  */
10899
10862
  include?: string[];
10900
10863
  /** @description User id. Use `me` for the authenticated user */
10901
- "filter[owners.id]"?: string[];
10864
+ "filter[owners.id]": string[];
10902
10865
  };
10903
10866
  header?: never;
10904
10867
  path?: never;
@@ -11183,15 +11146,13 @@ export interface paths {
11183
11146
  */
11184
11147
  get: {
11185
11148
  parameters: {
11186
- query?: {
11149
+ query: {
11187
11150
  /** @description Filter by countryCode */
11188
11151
  "filter[countryCode]"?: string[];
11189
- /** @description Terms id (e.g. `a468bee88def`) */
11190
- "filter[id]"?: string[];
11191
11152
  /** @description Filter by isLatestVersion */
11192
11153
  "filter[isLatestVersion]"?: string[];
11193
11154
  /** @description One of: DEVELOPER, UPLOAD_MARKETPLACE (e.g. `DEVELOPER`) */
11194
- "filter[termsType]"?: ("DEVELOPER" | "UPLOAD_MARKETPLACE")[];
11155
+ "filter[termsType]": ("DEVELOPER" | "UPLOAD_MARKETPLACE")[];
11195
11156
  };
11196
11157
  header?: never;
11197
11158
  path?: never;
@@ -11405,46 +11366,7 @@ export interface paths {
11405
11366
  path?: never;
11406
11367
  cookie?: never;
11407
11368
  };
11408
- /**
11409
- * Get multiple trackSourceFiles.
11410
- * @description Retrieves multiple trackSourceFiles by available filters, or without if applicable.
11411
- */
11412
- get: {
11413
- parameters: {
11414
- query?: {
11415
- /**
11416
- * @description Allows the client to customize which related resources should be returned. Available options: owners
11417
- * @example owners
11418
- */
11419
- include?: string[];
11420
- /** @description Track source file id (e.g. `a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11`) */
11421
- "filter[id]"?: string[];
11422
- };
11423
- header?: never;
11424
- path?: never;
11425
- cookie?: never;
11426
- };
11427
- requestBody?: never;
11428
- responses: {
11429
- /** @description Successful response */
11430
- 200: {
11431
- headers: {
11432
- [name: string]: unknown;
11433
- };
11434
- content: {
11435
- "application/vnd.api+json": components["schemas"]["TrackSourceFiles_Multi_Resource_Data_Document"];
11436
- };
11437
- };
11438
- 400: components["responses"]["Default400Response"];
11439
- 404: components["responses"]["Default404Response"];
11440
- 405: components["responses"]["Default405Response"];
11441
- 406: components["responses"]["Default406Response"];
11442
- 415: components["responses"]["Default415Response"];
11443
- 429: components["responses"]["Default429Response"];
11444
- 500: components["responses"]["Default500Response"];
11445
- 503: components["responses"]["Default503Response"];
11446
- };
11447
- };
11369
+ get?: never;
11448
11370
  put?: never;
11449
11371
  /**
11450
11372
  * Create single trackSourceFile.
@@ -11615,61 +11537,6 @@ export interface paths {
11615
11537
  patch?: never;
11616
11538
  trace?: never;
11617
11539
  };
11618
- "/trackStatistics": {
11619
- parameters: {
11620
- query?: never;
11621
- header?: never;
11622
- path?: never;
11623
- cookie?: never;
11624
- };
11625
- /**
11626
- * Get multiple trackStatistics.
11627
- * @description Retrieves multiple trackStatistics by available filters, or without if applicable.
11628
- */
11629
- get: {
11630
- parameters: {
11631
- query?: {
11632
- /**
11633
- * @description Allows the client to customize which related resources should be returned. Available options: owners
11634
- * @example owners
11635
- */
11636
- include?: string[];
11637
- /** @description List of track IDs (e.g. `75413016`) */
11638
- "filter[id]"?: string[];
11639
- };
11640
- header?: never;
11641
- path?: never;
11642
- cookie?: never;
11643
- };
11644
- requestBody?: never;
11645
- responses: {
11646
- /** @description Successful response */
11647
- 200: {
11648
- headers: {
11649
- [name: string]: unknown;
11650
- };
11651
- content: {
11652
- "application/vnd.api+json": components["schemas"]["TrackStatistics_Multi_Resource_Data_Document"];
11653
- };
11654
- };
11655
- 400: components["responses"]["Default400Response"];
11656
- 404: components["responses"]["Default404Response"];
11657
- 405: components["responses"]["Default405Response"];
11658
- 406: components["responses"]["Default406Response"];
11659
- 415: components["responses"]["Default415Response"];
11660
- 429: components["responses"]["Default429Response"];
11661
- 500: components["responses"]["Default500Response"];
11662
- 503: components["responses"]["Default503Response"];
11663
- };
11664
- };
11665
- put?: never;
11666
- post?: never;
11667
- delete?: never;
11668
- options?: never;
11669
- head?: never;
11670
- patch?: never;
11671
- trace?: never;
11672
- };
11673
11540
  "/trackStatistics/{id}": {
11674
11541
  parameters: {
11675
11542
  query?: never;
@@ -13238,56 +13105,6 @@ export interface paths {
13238
13105
  patch?: never;
13239
13106
  trace?: never;
13240
13107
  };
13241
- "/tracksMetadataStatus": {
13242
- parameters: {
13243
- query?: never;
13244
- header?: never;
13245
- path?: never;
13246
- cookie?: never;
13247
- };
13248
- /**
13249
- * Get multiple tracksMetadataStatus.
13250
- * @description Retrieves multiple tracksMetadataStatus by available filters, or without if applicable.
13251
- */
13252
- get: {
13253
- parameters: {
13254
- query?: {
13255
- /** @description List of track IDs (e.g. `75413016`) */
13256
- "filter[id]"?: string[];
13257
- };
13258
- header?: never;
13259
- path?: never;
13260
- cookie?: never;
13261
- };
13262
- requestBody?: never;
13263
- responses: {
13264
- /** @description Successful response */
13265
- 200: {
13266
- headers: {
13267
- [name: string]: unknown;
13268
- };
13269
- content: {
13270
- "application/vnd.api+json": components["schemas"]["TracksMetadataStatus_Multi_Resource_Data_Document"];
13271
- };
13272
- };
13273
- 400: components["responses"]["Default400Response"];
13274
- 404: components["responses"]["Default404Response"];
13275
- 405: components["responses"]["Default405Response"];
13276
- 406: components["responses"]["Default406Response"];
13277
- 415: components["responses"]["Default415Response"];
13278
- 429: components["responses"]["Default429Response"];
13279
- 500: components["responses"]["Default500Response"];
13280
- 503: components["responses"]["Default503Response"];
13281
- };
13282
- };
13283
- put?: never;
13284
- post?: never;
13285
- delete?: never;
13286
- options?: never;
13287
- head?: never;
13288
- patch?: never;
13289
- trace?: never;
13290
- };
13291
13108
  "/tracksMetadataStatus/{id}": {
13292
13109
  parameters: {
13293
13110
  query?: never;
@@ -13348,41 +13165,7 @@ export interface paths {
13348
13165
  path?: never;
13349
13166
  cookie?: never;
13350
13167
  };
13351
- /**
13352
- * Get multiple usageRules.
13353
- * @description Retrieves multiple usageRules by available filters, or without if applicable.
13354
- */
13355
- get: {
13356
- parameters: {
13357
- query?: {
13358
- /** @description List of usage rules IDs (e.g. `VFJBQ0tTOjEyMzpOTw`) */
13359
- "filter[id]"?: string[];
13360
- };
13361
- header?: never;
13362
- path?: never;
13363
- cookie?: never;
13364
- };
13365
- requestBody?: never;
13366
- responses: {
13367
- /** @description Successful response */
13368
- 200: {
13369
- headers: {
13370
- [name: string]: unknown;
13371
- };
13372
- content: {
13373
- "application/vnd.api+json": components["schemas"]["UsageRules_Multi_Resource_Data_Document"];
13374
- };
13375
- };
13376
- 400: components["responses"]["Default400Response"];
13377
- 404: components["responses"]["Default404Response"];
13378
- 405: components["responses"]["Default405Response"];
13379
- 406: components["responses"]["Default406Response"];
13380
- 415: components["responses"]["Default415Response"];
13381
- 429: components["responses"]["Default429Response"];
13382
- 500: components["responses"]["Default500Response"];
13383
- 503: components["responses"]["Default503Response"];
13384
- };
13385
- };
13168
+ get?: never;
13386
13169
  put?: never;
13387
13170
  /**
13388
13171
  * Create single usageRule.
@@ -13657,7 +13440,7 @@ export interface paths {
13657
13440
  [name: string]: unknown;
13658
13441
  };
13659
13442
  content: {
13660
- "application/vnd.api+json": components["schemas"]["UserCollectionAlbums_Items_Multi_Relationship_Data_Document"];
13443
+ "application/vnd.api+json": components["schemas"]["UserCollectionAlbums_Items_Add_Multi_Relationship_Data_Document"];
13661
13444
  };
13662
13445
  };
13663
13446
  400: components["responses"]["Default400Response"];
@@ -13949,7 +13732,7 @@ export interface paths {
13949
13732
  [name: string]: unknown;
13950
13733
  };
13951
13734
  content: {
13952
- "application/vnd.api+json": components["schemas"]["UserCollectionArtists_Items_Multi_Relationship_Data_Document"];
13735
+ "application/vnd.api+json": components["schemas"]["UserCollectionArtists_Items_Add_Multi_Relationship_Data_Document"];
13953
13736
  };
13954
13737
  };
13955
13738
  400: components["responses"]["Default400Response"];
@@ -14081,14 +13864,14 @@ export interface paths {
14081
13864
  */
14082
13865
  get: {
14083
13866
  parameters: {
14084
- query?: {
13867
+ query: {
14085
13868
  /**
14086
- * @description Allows the client to customize which related resources should be returned. Available options: items, owners
13869
+ * @description Allows the client to customize which related resources should be returned. Available options: items, owners, userCollection
14087
13870
  * @example items
14088
13871
  */
14089
13872
  include?: string[];
14090
13873
  /** @description Folder Id (e.g. `CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX`) */
14091
- "filter[id]"?: string[];
13874
+ "filter[id]": string[];
14092
13875
  };
14093
13876
  header?: never;
14094
13877
  path?: never;
@@ -14178,7 +13961,7 @@ export interface paths {
14178
13961
  parameters: {
14179
13962
  query?: {
14180
13963
  /**
14181
- * @description Allows the client to customize which related resources should be returned. Available options: items, owners
13964
+ * @description Allows the client to customize which related resources should be returned. Available options: items, owners, userCollection
14182
13965
  * @example items
14183
13966
  */
14184
13967
  include?: string[];
@@ -14490,6 +14273,65 @@ export interface paths {
14490
14273
  patch?: never;
14491
14274
  trace?: never;
14492
14275
  };
14276
+ "/userCollectionFolders/{id}/relationships/userCollection": {
14277
+ parameters: {
14278
+ query?: never;
14279
+ header?: never;
14280
+ path?: never;
14281
+ cookie?: never;
14282
+ };
14283
+ /**
14284
+ * Get userCollection relationship ("to-one").
14285
+ * @description Retrieves userCollection relationship.
14286
+ */
14287
+ get: {
14288
+ parameters: {
14289
+ query?: {
14290
+ /**
14291
+ * @description Allows the client to customize which related resources should be returned. Available options: userCollection
14292
+ * @example userCollection
14293
+ */
14294
+ include?: string[];
14295
+ };
14296
+ header?: never;
14297
+ path: {
14298
+ /**
14299
+ * @description Folder Id
14300
+ * @example CBMHXUOuJZgroV2kWpeVLL1I7xdgvF6ocDEGCXov8SZq3WVhrOcOq5pjnGawKX
14301
+ */
14302
+ id: string;
14303
+ };
14304
+ cookie?: never;
14305
+ };
14306
+ requestBody?: never;
14307
+ responses: {
14308
+ /** @description Successful response */
14309
+ 200: {
14310
+ headers: {
14311
+ [name: string]: unknown;
14312
+ };
14313
+ content: {
14314
+ "application/vnd.api+json": components["schemas"]["UserCollectionFolders_Single_Relationship_Data_Document"];
14315
+ };
14316
+ };
14317
+ 400: components["responses"]["Default400Response"];
14318
+ 404: components["responses"]["Default404Response"];
14319
+ 405: components["responses"]["Default405Response"];
14320
+ 406: components["responses"]["Default406Response"];
14321
+ 415: components["responses"]["Default415Response"];
14322
+ 429: components["responses"]["Default429Response"];
14323
+ 500: components["responses"]["Default500Response"];
14324
+ 503: components["responses"]["Default503Response"];
14325
+ };
14326
+ };
14327
+ put?: never;
14328
+ post?: never;
14329
+ delete?: never;
14330
+ options?: never;
14331
+ head?: never;
14332
+ patch?: never;
14333
+ trace?: never;
14334
+ };
14493
14335
  "/userCollectionPlaylists/{id}": {
14494
14336
  parameters: {
14495
14337
  query?: never;
@@ -14573,7 +14415,7 @@ export interface paths {
14573
14415
  get: {
14574
14416
  parameters: {
14575
14417
  query?: {
14576
- collectionView?: "FOLDERS";
14418
+ collectionView?: "FLAT" | "FOLDERS";
14577
14419
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
14578
14420
  "page[cursor]"?: string;
14579
14421
  /** @description Values prefixed with "-" are sorted descending; values without it are sorted ascending. */
@@ -14648,7 +14490,7 @@ export interface paths {
14648
14490
  [name: string]: unknown;
14649
14491
  };
14650
14492
  content: {
14651
- "application/vnd.api+json": components["schemas"]["UserCollectionPlaylists_Items_Multi_Relationship_Data_Document"];
14493
+ "application/vnd.api+json": components["schemas"]["UserCollectionPlaylists_Items_Add_Multi_Relationship_Data_Document"];
14652
14494
  };
14653
14495
  };
14654
14496
  400: components["responses"]["Default400Response"];
@@ -14842,6 +14684,11 @@ export interface paths {
14842
14684
  query?: {
14843
14685
  /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
14844
14686
  "page[cursor]"?: string;
14687
+ /**
14688
+ * @description ISO 3166-1 alpha-2 country code
14689
+ * @example US
14690
+ */
14691
+ countryCode?: string;
14845
14692
  /**
14846
14693
  * @description Allows the client to customize which related resources should be returned. Available options: items
14847
14694
  * @example items
@@ -14886,7 +14733,13 @@ export interface paths {
14886
14733
  */
14887
14734
  post: {
14888
14735
  parameters: {
14889
- query?: never;
14736
+ query?: {
14737
+ /**
14738
+ * @description ISO 3166-1 alpha-2 country code
14739
+ * @example US
14740
+ */
14741
+ countryCode?: string;
14742
+ };
14890
14743
  header?: {
14891
14744
  /** @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. */
14892
14745
  "Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
@@ -14912,7 +14765,7 @@ export interface paths {
14912
14765
  [name: string]: unknown;
14913
14766
  };
14914
14767
  content: {
14915
- "application/vnd.api+json": components["schemas"]["UserCollectionSaveForLaters_Items_Multi_Relationship_Data_Document"];
14768
+ "application/vnd.api+json": components["schemas"]["UserCollectionSaveForLaters_Items_Add_Multi_Relationship_Data_Document"];
14916
14769
  };
14917
14770
  };
14918
14771
  400: components["responses"]["Default400Response"];
@@ -14997,64 +14850,9 @@ export interface paths {
14997
14850
  /**
14998
14851
  * @description User collection save for later id. Use `me` for the authenticated user's resource
14999
14852
  * @example me
15000
- */
15001
- id: string;
15002
- };
15003
- cookie?: never;
15004
- };
15005
- requestBody?: never;
15006
- responses: {
15007
- /** @description Successful response */
15008
- 200: {
15009
- headers: {
15010
- [name: string]: unknown;
15011
- };
15012
- content: {
15013
- "application/vnd.api+json": components["schemas"]["UserCollectionSaveForLaters_Multi_Relationship_Data_Document"];
15014
- };
15015
- };
15016
- 400: components["responses"]["Default400Response"];
15017
- 404: components["responses"]["Default404Response"];
15018
- 405: components["responses"]["Default405Response"];
15019
- 406: components["responses"]["Default406Response"];
15020
- 415: components["responses"]["Default415Response"];
15021
- 429: components["responses"]["Default429Response"];
15022
- 500: components["responses"]["Default500Response"];
15023
- 503: components["responses"]["Default503Response"];
15024
- };
15025
- };
15026
- put?: never;
15027
- post?: never;
15028
- delete?: never;
15029
- options?: never;
15030
- head?: never;
15031
- patch?: never;
15032
- trace?: never;
15033
- };
15034
- "/userCollectionTracks": {
15035
- parameters: {
15036
- query?: never;
15037
- header?: never;
15038
- path?: never;
15039
- cookie?: never;
15040
- };
15041
- /**
15042
- * Get multiple userCollectionTracks.
15043
- * @description Retrieves multiple userCollectionTracks by available filters, or without if applicable.
15044
- */
15045
- get: {
15046
- parameters: {
15047
- query?: {
15048
- /**
15049
- * @description Allows the client to customize which related resources should be returned. Available options: items, owners
15050
- * @example items
15051
- */
15052
- include?: string[];
15053
- /** @description User collection tracks id (e.g. `FMJUCzH4`) */
15054
- "filter[id]"?: string[];
14853
+ */
14854
+ id: string;
15055
14855
  };
15056
- header?: never;
15057
- path?: never;
15058
14856
  cookie?: never;
15059
14857
  };
15060
14858
  requestBody?: never;
@@ -15065,7 +14863,7 @@ export interface paths {
15065
14863
  [name: string]: unknown;
15066
14864
  };
15067
14865
  content: {
15068
- "application/vnd.api+json": components["schemas"]["UserCollectionTracks_Multi_Resource_Data_Document"];
14866
+ "application/vnd.api+json": components["schemas"]["UserCollectionSaveForLaters_Multi_Relationship_Data_Document"];
15069
14867
  };
15070
14868
  };
15071
14869
  400: components["responses"]["Default400Response"];
@@ -15259,7 +15057,7 @@ export interface paths {
15259
15057
  [name: string]: unknown;
15260
15058
  };
15261
15059
  content: {
15262
- "application/vnd.api+json": components["schemas"]["UserCollectionTracks_Items_Multi_Relationship_Data_Document"];
15060
+ "application/vnd.api+json": components["schemas"]["UserCollectionTracks_Items_Add_Multi_Relationship_Data_Document"];
15263
15061
  };
15264
15062
  };
15265
15063
  400: components["responses"]["Default400Response"];
@@ -15551,7 +15349,7 @@ export interface paths {
15551
15349
  [name: string]: unknown;
15552
15350
  };
15553
15351
  content: {
15554
- "application/vnd.api+json": components["schemas"]["UserCollectionVideos_Items_Multi_Relationship_Data_Document"];
15352
+ "application/vnd.api+json": components["schemas"]["UserCollectionVideos_Items_Add_Multi_Relationship_Data_Document"];
15555
15353
  };
15556
15354
  };
15557
15355
  400: components["responses"]["Default400Response"];
@@ -19480,6 +19278,128 @@ export interface components {
19480
19278
  included?: components["schemas"]["Included"];
19481
19279
  links: components["schemas"]["Links"];
19482
19280
  };
19281
+ CollaborationInviteRedemptionsCreateOperation_Payload: {
19282
+ data: components["schemas"]["CollaborationInviteRedemptionsCreateOperation_Payload_Data"];
19283
+ };
19284
+ CollaborationInviteRedemptionsCreateOperation_Payload_Data: {
19285
+ relationships: components["schemas"]["CollaborationInviteRedemptionsCreateOperation_Payload_Data_Relationships"];
19286
+ /** @enum {string} */
19287
+ type: "collaborationInviteRedemptions";
19288
+ };
19289
+ CollaborationInviteRedemptionsCreateOperation_Payload_Data_Relationships: {
19290
+ invite: components["schemas"]["CollaborationInviteRedemptionsCreateOperation_Payload_Data_Relationships_Invite"];
19291
+ };
19292
+ CollaborationInviteRedemptionsCreateOperation_Payload_Data_Relationships_Invite: {
19293
+ data: components["schemas"]["CollaborationInviteRedemptionsCreateOperation_Payload_Data_Relationships_Invite_Data"];
19294
+ };
19295
+ CollaborationInviteRedemptionsCreateOperation_Payload_Data_Relationships_Invite_Data: {
19296
+ id: string;
19297
+ /** @enum {string} */
19298
+ type: "collaborationInvites";
19299
+ };
19300
+ CollaborationInviteRedemptions_Attributes: {
19301
+ /**
19302
+ * Format: date-time
19303
+ * @description Datetime the invite was redeemed (ISO 8601)
19304
+ */
19305
+ redeemedAt: string;
19306
+ };
19307
+ CollaborationInviteRedemptions_Multi_Resource_Data_Document: {
19308
+ data: components["schemas"]["CollaborationInviteRedemptions_Resource_Object"][];
19309
+ included?: components["schemas"]["Included"];
19310
+ links: components["schemas"]["Links"];
19311
+ };
19312
+ CollaborationInviteRedemptions_Resource_Object: {
19313
+ attributes?: components["schemas"]["CollaborationInviteRedemptions_Attributes"];
19314
+ /**
19315
+ * @description Resource id
19316
+ * @example 12345
19317
+ */
19318
+ id: string;
19319
+ /**
19320
+ * @description Resource type (enum property replaced by openapi-typescript)
19321
+ * @enum {string}
19322
+ */
19323
+ type: "collaborationInviteRedemptions";
19324
+ };
19325
+ CollaborationInviteRedemptions_Single_Resource_Data_Document: {
19326
+ data: components["schemas"]["CollaborationInviteRedemptions_Resource_Object"];
19327
+ included?: components["schemas"]["Included"];
19328
+ links: components["schemas"]["Links"];
19329
+ };
19330
+ CollaborationInvitesCreateOperation_Payload: {
19331
+ data: components["schemas"]["CollaborationInvitesCreateOperation_Payload_Data"];
19332
+ };
19333
+ CollaborationInvitesCreateOperation_Payload_Data: {
19334
+ relationships: components["schemas"]["CollaborationInvitesCreateOperation_Payload_Data_Relationships"];
19335
+ /** @enum {string} */
19336
+ type: "collaborationInvites";
19337
+ };
19338
+ CollaborationInvitesCreateOperation_Payload_Data_Relationships: {
19339
+ subject: components["schemas"]["CollaborationInvitesCreateOperation_Payload_Data_Relationships_Subject"];
19340
+ };
19341
+ CollaborationInvitesCreateOperation_Payload_Data_Relationships_Subject: {
19342
+ data: components["schemas"]["CollaborationInvitesCreateOperation_Payload_Data_Relationships_Subject_Data"];
19343
+ };
19344
+ CollaborationInvitesCreateOperation_Payload_Data_Relationships_Subject_Data: {
19345
+ id: string;
19346
+ /** @enum {string} */
19347
+ type: "playlists";
19348
+ };
19349
+ CollaborationInvites_Attributes: {
19350
+ /** @description Opaque invite code embedded in the share link */
19351
+ code: string;
19352
+ /**
19353
+ * Format: date-time
19354
+ * @description Datetime the invite was created (ISO 8601)
19355
+ */
19356
+ createdAt: string;
19357
+ /**
19358
+ * Format: date-time
19359
+ * @description Datetime the invite expires (ISO 8601)
19360
+ */
19361
+ expiresAt: string;
19362
+ /** @description Whether the invite has been revoked by the subject's owner */
19363
+ revoked: boolean;
19364
+ };
19365
+ CollaborationInvites_Multi_Relationship_Data_Document: {
19366
+ data?: components["schemas"]["Resource_Identifier"][];
19367
+ included?: components["schemas"]["Included"];
19368
+ links: components["schemas"]["Links"];
19369
+ };
19370
+ CollaborationInvites_Multi_Resource_Data_Document: {
19371
+ data: components["schemas"]["CollaborationInvites_Resource_Object"][];
19372
+ included?: components["schemas"]["Included"];
19373
+ links: components["schemas"]["Links"];
19374
+ };
19375
+ CollaborationInvites_Relationships: {
19376
+ owners?: components["schemas"]["Multi_Relationship_Data_Document"];
19377
+ subject?: components["schemas"]["Single_Relationship_Data_Document"];
19378
+ };
19379
+ CollaborationInvites_Resource_Object: {
19380
+ attributes?: components["schemas"]["CollaborationInvites_Attributes"];
19381
+ /**
19382
+ * @description Resource id
19383
+ * @example 12345
19384
+ */
19385
+ id: string;
19386
+ relationships?: components["schemas"]["CollaborationInvites_Relationships"];
19387
+ /**
19388
+ * @description Resource type (enum property replaced by openapi-typescript)
19389
+ * @enum {string}
19390
+ */
19391
+ type: "collaborationInvites";
19392
+ };
19393
+ CollaborationInvites_Single_Relationship_Data_Document: {
19394
+ data?: components["schemas"]["Resource_Identifier"];
19395
+ included?: components["schemas"]["Included"];
19396
+ links: components["schemas"]["Links"];
19397
+ };
19398
+ CollaborationInvites_Single_Resource_Data_Document: {
19399
+ data: components["schemas"]["CollaborationInvites_Resource_Object"];
19400
+ included?: components["schemas"]["Included"];
19401
+ links: components["schemas"]["Links"];
19402
+ };
19483
19403
  CommentsCreateOperation_Payload: {
19484
19404
  data: components["schemas"]["CommentsCreateOperation_Payload_Data"];
19485
19405
  };
@@ -20173,7 +20093,7 @@ export interface components {
20173
20093
  status: string;
20174
20094
  }[];
20175
20095
  };
20176
- 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"]["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"]["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"]["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"]["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"]["UserRecommendations_Resource_Object"] | components["schemas"]["UserReports_Resource_Object"] | components["schemas"]["Users_Resource_Object"] | components["schemas"]["VideoManifests_Resource_Object"] | components["schemas"]["Videos_Resource_Object"])[];
20096
+ 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"]["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"]["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"]["UserRecommendations_Resource_Object"] | components["schemas"]["UserReports_Resource_Object"] | components["schemas"]["Users_Resource_Object"] | components["schemas"]["VideoManifests_Resource_Object"] | components["schemas"]["Videos_Resource_Object"])[];
20177
20097
  InstallationsCreateOperation_Payload: {
20178
20098
  data: components["schemas"]["InstallationsCreateOperation_Payload_Data"];
20179
20099
  };
@@ -21391,6 +21311,52 @@ export interface components {
21391
21311
  included?: components["schemas"]["Included"];
21392
21312
  links: components["schemas"]["Links"];
21393
21313
  };
21314
+ Scopes_Attributes: {
21315
+ /**
21316
+ * @description Text shown to the end user on the OAuth consent screen when this scope is requested.
21317
+ * @example List all playlists created by you.
21318
+ */
21319
+ consentText?: string;
21320
+ /**
21321
+ * @description Technical description of the scope.
21322
+ * @example Required to list playlists created by a user.
21323
+ */
21324
+ description: string;
21325
+ /**
21326
+ * @description Wire-format scope name as used in OAuth requests.
21327
+ * @example playlists.read
21328
+ */
21329
+ name: string;
21330
+ /**
21331
+ * @description Client access tier required to request this scope. A client whose access tier is at least this value can include the scope when initiating an OAuth flow.
21332
+ * @example THIRD_PARTY
21333
+ * @enum {string}
21334
+ */
21335
+ requiredAccessTier: "THIRD_PARTY" | "THIRD_PARTY_PROD" | "PARTNER" | "INTERNAL";
21336
+ };
21337
+ Scopes_Multi_Resource_Data_Document: {
21338
+ data: components["schemas"]["Scopes_Resource_Object"][];
21339
+ included?: components["schemas"]["Included"];
21340
+ links: components["schemas"]["Links"];
21341
+ };
21342
+ Scopes_Resource_Object: {
21343
+ attributes?: components["schemas"]["Scopes_Attributes"];
21344
+ /**
21345
+ * @description Resource id
21346
+ * @example 12345
21347
+ */
21348
+ id: string;
21349
+ /**
21350
+ * @description Resource type (enum property replaced by openapi-typescript)
21351
+ * @enum {string}
21352
+ */
21353
+ type: "scopes";
21354
+ };
21355
+ Scopes_Single_Resource_Data_Document: {
21356
+ data: components["schemas"]["Scopes_Resource_Object"];
21357
+ included?: components["schemas"]["Included"];
21358
+ links: components["schemas"]["Links"];
21359
+ };
21394
21360
  SearchHistoryEntries_Attributes: {
21395
21361
  highlights: components["schemas"]["Highlight"][];
21396
21362
  query: string;
@@ -21608,6 +21574,11 @@ export interface components {
21608
21574
  * @enum {string}
21609
21575
  */
21610
21576
  platform: "WEB" | "ANDROID" | "IOS";
21577
+ /**
21578
+ * @description Optional post-finalize redirect URL. Otherwise uses platform default.
21579
+ * @example tidal://square-auth/return?flow=onboarding&ref=abc
21580
+ */
21581
+ redirectUrl?: string;
21611
21582
  };
21612
21583
  SquareConnections_Attributes: {
21613
21584
  /**
@@ -21626,7 +21597,7 @@ export interface components {
21626
21597
  * @description Current status of this Square connection
21627
21598
  * @enum {string}
21628
21599
  */
21629
- status: "PENDING_REQUIREMENTS" | "ACCEPTED" | "REJECTED";
21600
+ status: "DRAFT" | "PENDING_REQUIREMENTS" | "KYC_PENDING" | "ACCEPTED" | "REJECTED" | "SUSPENDED";
21630
21601
  };
21631
21602
  SquareConnections_Multi_Resource_Data_Document: {
21632
21603
  data: components["schemas"]["SquareConnections_Resource_Object"][];
@@ -21718,7 +21689,7 @@ export interface components {
21718
21689
  * @description Current status of this Stripe connection
21719
21690
  * @enum {string}
21720
21691
  */
21721
- status: "PENDING_REQUIREMENTS" | "UNDER_REVIEW" | "ACCEPTED" | "REJECTED";
21692
+ status: "PENDING_REQUIREMENTS" | "UNDER_REVIEW" | "ACCEPTED" | "REJECTED" | "SUSPENDED";
21722
21693
  };
21723
21694
  StripeConnections_Multi_Relationship_Data_Document: {
21724
21695
  data?: components["schemas"]["Resource_Identifier"][];
@@ -22417,6 +22388,11 @@ export interface components {
22417
22388
  inherited?: boolean;
22418
22389
  paid?: ("STREAM" | "DJ" | "STEM" | "DOWNLOAD")[];
22419
22390
  subscription?: ("STREAM" | "DJ" | "STEM" | "DOWNLOAD")[];
22391
+ /**
22392
+ * Format: date-time
22393
+ * @description Datetime from which these usage rules are valid (ISO 8601)
22394
+ */
22395
+ validFrom?: string;
22420
22396
  };
22421
22397
  UsageRulesCreateOperation_Payload_Data_Relationships: {
22422
22398
  subject: components["schemas"]["UsageRulesCreateOperation_Payload_Data_Relationships_Subject"];
@@ -22440,6 +22416,11 @@ export interface components {
22440
22416
  paid?: ("STREAM" | "DJ" | "STEM" | "DOWNLOAD")[];
22441
22417
  /** @description Usage types allowed for subscription model */
22442
22418
  subscription?: ("STREAM" | "DJ" | "STEM" | "DOWNLOAD")[];
22419
+ /**
22420
+ * Format: date-time
22421
+ * @description Datetime from which these usage rules are valid (ISO 8601)
22422
+ */
22423
+ validFrom?: string;
22443
22424
  };
22444
22425
  UsageRules_Multi_Resource_Data_Document: {
22445
22426
  data: components["schemas"]["UsageRules_Resource_Object"][];
@@ -22464,6 +22445,11 @@ export interface components {
22464
22445
  included?: components["schemas"]["Included"];
22465
22446
  links: components["schemas"]["Links"];
22466
22447
  };
22448
+ UserCollection: {
22449
+ id: string;
22450
+ /** @enum {string} */
22451
+ type: "userCollectionPlaylists";
22452
+ };
22467
22453
  UserCollectionAlbumsAddMultiDataRelationshipWithResponse409ResponseBody: {
22468
22454
  errors: {
22469
22455
  /**
@@ -22490,6 +22476,13 @@ export interface components {
22490
22476
  /** Format: date-time */
22491
22477
  addedAt?: string;
22492
22478
  };
22479
+ UserCollectionAlbumsItemsRelationshipAddOperation_Response_Meta_SkippedItem: {
22480
+ id: string;
22481
+ /** @enum {string} */
22482
+ reason: "NOT_FOUND" | "ALREADY_PRESENT";
22483
+ /** @enum {string} */
22484
+ type: "albums";
22485
+ };
22493
22486
  UserCollectionAlbumsItemsRelationshipRemoveOperation_Payload: {
22494
22487
  data: components["schemas"]["UserCollectionAlbumsItemsRelationshipRemoveOperation_Payload_Data"][];
22495
22488
  };
@@ -22499,12 +22492,26 @@ export interface components {
22499
22492
  type: "albums";
22500
22493
  };
22501
22494
  UserCollectionAlbums_Attributes: {
22495
+ /**
22496
+ * Format: date-time
22497
+ * @description When the collection was last modified
22498
+ */
22499
+ lastModifiedAt?: string;
22502
22500
  /**
22503
22501
  * Format: int32
22504
22502
  * @description Number of items in the collection
22505
22503
  */
22506
22504
  numberOfItems: number;
22507
22505
  };
22506
+ UserCollectionAlbums_Items_Add_Multi_Relationship_Data_Document: {
22507
+ data?: components["schemas"]["UserCollectionAlbums_Items_Resource_Identifier"][];
22508
+ included?: components["schemas"]["Included"];
22509
+ links: components["schemas"]["Links"];
22510
+ meta?: components["schemas"]["UserCollectionAlbums_Items_Add_Multi_Relationship_Data_Document_Meta"];
22511
+ };
22512
+ UserCollectionAlbums_Items_Add_Multi_Relationship_Data_Document_Meta: {
22513
+ skipped: components["schemas"]["UserCollectionAlbumsItemsRelationshipAddOperation_Response_Meta_SkippedItem"][];
22514
+ };
22508
22515
  UserCollectionAlbums_Items_Multi_Relationship_Data_Document: {
22509
22516
  data?: components["schemas"]["UserCollectionAlbums_Items_Resource_Identifier"][];
22510
22517
  included?: components["schemas"]["Included"];
@@ -22586,6 +22593,13 @@ export interface components {
22586
22593
  /** Format: date-time */
22587
22594
  addedAt?: string;
22588
22595
  };
22596
+ UserCollectionArtistsItemsRelationshipAddOperation_Response_Meta_SkippedItem: {
22597
+ id: string;
22598
+ /** @enum {string} */
22599
+ reason: "NOT_FOUND" | "ALREADY_PRESENT";
22600
+ /** @enum {string} */
22601
+ type: "artists";
22602
+ };
22589
22603
  UserCollectionArtistsItemsRelationshipRemoveOperation_Payload: {
22590
22604
  data: components["schemas"]["UserCollectionArtistsItemsRelationshipRemoveOperation_Payload_Data"][];
22591
22605
  };
@@ -22594,7 +22608,27 @@ export interface components {
22594
22608
  /** @enum {string} */
22595
22609
  type: "artists";
22596
22610
  };
22597
- UserCollectionArtists_Attributes: Record<string, never>;
22611
+ UserCollectionArtists_Attributes: {
22612
+ /**
22613
+ * Format: date-time
22614
+ * @description When the collection was last modified
22615
+ */
22616
+ lastModifiedAt?: string;
22617
+ /**
22618
+ * Format: int32
22619
+ * @description Number of items in the collection
22620
+ */
22621
+ numberOfItems: number;
22622
+ };
22623
+ UserCollectionArtists_Items_Add_Multi_Relationship_Data_Document: {
22624
+ data?: components["schemas"]["UserCollectionArtists_Items_Resource_Identifier"][];
22625
+ included?: components["schemas"]["Included"];
22626
+ links: components["schemas"]["Links"];
22627
+ meta?: components["schemas"]["UserCollectionArtists_Items_Add_Multi_Relationship_Data_Document_Meta"];
22628
+ };
22629
+ UserCollectionArtists_Items_Add_Multi_Relationship_Data_Document_Meta: {
22630
+ skipped: components["schemas"]["UserCollectionArtistsItemsRelationshipAddOperation_Response_Meta_SkippedItem"][];
22631
+ };
22598
22632
  UserCollectionArtists_Items_Multi_Relationship_Data_Document: {
22599
22633
  data?: components["schemas"]["UserCollectionArtists_Items_Resource_Identifier"][];
22600
22634
  included?: components["schemas"]["Included"];
@@ -22655,14 +22689,25 @@ export interface components {
22655
22689
  };
22656
22690
  UserCollectionFoldersCreateOperation_Payload_Data: {
22657
22691
  attributes: components["schemas"]["UserCollectionFoldersCreateOperation_Payload_Data_Attributes"];
22692
+ relationships: components["schemas"]["UserCollectionFoldersCreateOperation_Payload_Data_Relationships"];
22658
22693
  /** @enum {string} */
22659
22694
  type: "userCollectionFolders";
22660
22695
  };
22661
22696
  UserCollectionFoldersCreateOperation_Payload_Data_Attributes: {
22662
- /** @enum {string} */
22663
- collectionType: "PLAYLISTS";
22697
+ /**
22698
+ * @deprecated
22699
+ * @description The type of user collection this folder belongs to. Deprecated: send the 'userCollection' relationship instead. Accepted for backward compatibility during migration and will be removed in a future version.
22700
+ * @enum {string}
22701
+ */
22702
+ collectionType?: "PLAYLISTS";
22664
22703
  name: string;
22665
22704
  };
22705
+ UserCollectionFoldersCreateOperation_Payload_Data_Relationships: {
22706
+ userCollection: components["schemas"]["UserCollectionFoldersCreateOperation_Payload_Data_Relationships_UserCollection"];
22707
+ };
22708
+ UserCollectionFoldersCreateOperation_Payload_Data_Relationships_UserCollection: {
22709
+ data: components["schemas"]["UserCollection"];
22710
+ };
22666
22711
  UserCollectionFoldersDeleteResource400ResponseBody: {
22667
22712
  errors: {
22668
22713
  /**
@@ -22703,8 +22748,12 @@ export interface components {
22703
22748
  name?: string;
22704
22749
  };
22705
22750
  UserCollectionFolders_Attributes: {
22706
- /** @enum {string} */
22707
- collectionType: "PLAYLISTS";
22751
+ /**
22752
+ * @deprecated
22753
+ * @description The type of user collection this folder belongs to. Deprecated: use the 'userCollection' relationship instead. This field will be removed in a future version, so clients should not depend on its presence.
22754
+ * @enum {string}
22755
+ */
22756
+ collectionType?: "PLAYLISTS";
22708
22757
  /** Format: date-time */
22709
22758
  createdAt: string;
22710
22759
  /** Format: date-time */
@@ -22748,6 +22797,7 @@ export interface components {
22748
22797
  UserCollectionFolders_Relationships: {
22749
22798
  items?: components["schemas"]["UserCollectionFolders_Items_Multi_Relationship_Data_Document"];
22750
22799
  owners?: components["schemas"]["Multi_Relationship_Data_Document"];
22800
+ userCollection?: components["schemas"]["Single_Relationship_Data_Document"];
22751
22801
  };
22752
22802
  UserCollectionFolders_Resource_Object: {
22753
22803
  attributes?: components["schemas"]["UserCollectionFolders_Attributes"];
@@ -22763,6 +22813,11 @@ export interface components {
22763
22813
  */
22764
22814
  type: "userCollectionFolders";
22765
22815
  };
22816
+ UserCollectionFolders_Single_Relationship_Data_Document: {
22817
+ data?: components["schemas"]["Resource_Identifier"];
22818
+ included?: components["schemas"]["Included"];
22819
+ links: components["schemas"]["Links"];
22820
+ };
22766
22821
  UserCollectionFolders_Single_Resource_Data_Document: {
22767
22822
  data: components["schemas"]["UserCollectionFolders_Resource_Object"];
22768
22823
  included?: components["schemas"]["Included"];
@@ -22786,6 +22841,18 @@ export interface components {
22786
22841
  };
22787
22842
  UserCollectionPlaylistsItemsRelationshipAddOperation_Payload_Data: {
22788
22843
  id: string;
22844
+ meta?: components["schemas"]["UserCollectionPlaylistsItemsRelationshipAddOperation_Payload_Data_Meta"];
22845
+ /** @enum {string} */
22846
+ type: "playlists";
22847
+ };
22848
+ UserCollectionPlaylistsItemsRelationshipAddOperation_Payload_Data_Meta: {
22849
+ /** Format: date-time */
22850
+ addedAt?: string;
22851
+ };
22852
+ UserCollectionPlaylistsItemsRelationshipAddOperation_Response_Meta_SkippedItem: {
22853
+ id: string;
22854
+ /** @enum {string} */
22855
+ reason: "NOT_FOUND" | "ALREADY_PRESENT";
22789
22856
  /** @enum {string} */
22790
22857
  type: "playlists";
22791
22858
  };
@@ -22797,7 +22864,27 @@ export interface components {
22797
22864
  /** @enum {string} */
22798
22865
  type: "playlists";
22799
22866
  };
22800
- UserCollectionPlaylists_Attributes: Record<string, never>;
22867
+ UserCollectionPlaylists_Attributes: {
22868
+ /**
22869
+ * Format: date-time
22870
+ * @description When the collection was last modified
22871
+ */
22872
+ lastModifiedAt?: string;
22873
+ /**
22874
+ * Format: int32
22875
+ * @description Number of items in the collection
22876
+ */
22877
+ numberOfItems: number;
22878
+ };
22879
+ UserCollectionPlaylists_Items_Add_Multi_Relationship_Data_Document: {
22880
+ data?: components["schemas"]["UserCollectionPlaylists_Items_Resource_Identifier"][];
22881
+ included?: components["schemas"]["Included"];
22882
+ links: components["schemas"]["Links"];
22883
+ meta?: components["schemas"]["UserCollectionPlaylists_Items_Add_Multi_Relationship_Data_Document_Meta"];
22884
+ };
22885
+ UserCollectionPlaylists_Items_Add_Multi_Relationship_Data_Document_Meta: {
22886
+ skipped: components["schemas"]["UserCollectionPlaylistsItemsRelationshipAddOperation_Response_Meta_SkippedItem"][];
22887
+ };
22801
22888
  UserCollectionPlaylists_Items_Multi_Relationship_Data_Document: {
22802
22889
  data?: components["schemas"]["UserCollectionPlaylists_Items_Resource_Identifier"][];
22803
22890
  included?: components["schemas"]["Included"];
@@ -22874,6 +22961,13 @@ export interface components {
22874
22961
  /** @enum {string} */
22875
22962
  type: "tracks" | "albums" | "artists" | "playlists" | "videos";
22876
22963
  };
22964
+ UserCollectionSaveForLatersItemsRelationshipAddOperation_Response_Meta_SkippedItem: {
22965
+ id: string;
22966
+ /** @enum {string} */
22967
+ reason: "NOT_FOUND" | "ALREADY_PRESENT";
22968
+ /** @enum {string} */
22969
+ type: "tracks" | "albums" | "artists" | "playlists" | "videos";
22970
+ };
22877
22971
  UserCollectionSaveForLatersItemsRelationshipRemoveOperation_Payload: {
22878
22972
  data: components["schemas"]["UserCollectionSaveForLatersItemsRelationshipRemoveOperation_Payload_Data"][];
22879
22973
  };
@@ -22882,7 +22976,27 @@ export interface components {
22882
22976
  /** @enum {string} */
22883
22977
  type: "tracks" | "albums" | "artists" | "playlists" | "videos";
22884
22978
  };
22885
- UserCollectionSaveForLaters_Attributes: Record<string, never>;
22979
+ UserCollectionSaveForLaters_Attributes: {
22980
+ /**
22981
+ * Format: date-time
22982
+ * @description When the collection was last modified
22983
+ */
22984
+ lastModifiedAt?: string;
22985
+ /**
22986
+ * Format: int32
22987
+ * @description Number of items in the collection
22988
+ */
22989
+ numberOfItems: number;
22990
+ };
22991
+ UserCollectionSaveForLaters_Items_Add_Multi_Relationship_Data_Document: {
22992
+ data?: components["schemas"]["UserCollectionSaveForLaters_Items_Resource_Identifier"][];
22993
+ included?: components["schemas"]["Included"];
22994
+ links: components["schemas"]["Links"];
22995
+ meta?: components["schemas"]["UserCollectionSaveForLaters_Items_Add_Multi_Relationship_Data_Document_Meta"];
22996
+ };
22997
+ UserCollectionSaveForLaters_Items_Add_Multi_Relationship_Data_Document_Meta: {
22998
+ skipped: components["schemas"]["UserCollectionSaveForLatersItemsRelationshipAddOperation_Response_Meta_SkippedItem"][];
22999
+ };
22886
23000
  UserCollectionSaveForLaters_Items_Multi_Relationship_Data_Document: {
22887
23001
  data?: components["schemas"]["UserCollectionSaveForLaters_Items_Resource_Identifier"][];
22888
23002
  included?: components["schemas"]["Included"];
@@ -22964,6 +23078,13 @@ export interface components {
22964
23078
  /** Format: date-time */
22965
23079
  addedAt?: string;
22966
23080
  };
23081
+ UserCollectionTracksItemsRelationshipAddOperation_Response_Meta_SkippedItem: {
23082
+ id: string;
23083
+ /** @enum {string} */
23084
+ reason: "NOT_FOUND" | "ALREADY_PRESENT";
23085
+ /** @enum {string} */
23086
+ type: "tracks";
23087
+ };
22967
23088
  UserCollectionTracksItemsRelationshipRemoveOperation_Payload: {
22968
23089
  data: components["schemas"]["UserCollectionTracksItemsRelationshipRemoveOperation_Payload_Data"][];
22969
23090
  };
@@ -22972,7 +23093,27 @@ export interface components {
22972
23093
  /** @enum {string} */
22973
23094
  type: "tracks";
22974
23095
  };
22975
- UserCollectionTracks_Attributes: Record<string, never>;
23096
+ UserCollectionTracks_Attributes: {
23097
+ /**
23098
+ * Format: date-time
23099
+ * @description When the collection was last modified
23100
+ */
23101
+ lastModifiedAt?: string;
23102
+ /**
23103
+ * Format: int32
23104
+ * @description Number of items in the collection
23105
+ */
23106
+ numberOfItems: number;
23107
+ };
23108
+ UserCollectionTracks_Items_Add_Multi_Relationship_Data_Document: {
23109
+ data?: components["schemas"]["UserCollectionTracks_Items_Resource_Identifier"][];
23110
+ included?: components["schemas"]["Included"];
23111
+ links: components["schemas"]["Links"];
23112
+ meta?: components["schemas"]["UserCollectionTracks_Items_Add_Multi_Relationship_Data_Document_Meta"];
23113
+ };
23114
+ UserCollectionTracks_Items_Add_Multi_Relationship_Data_Document_Meta: {
23115
+ skipped: components["schemas"]["UserCollectionTracksItemsRelationshipAddOperation_Response_Meta_SkippedItem"][];
23116
+ };
22976
23117
  UserCollectionTracks_Items_Multi_Relationship_Data_Document: {
22977
23118
  data?: components["schemas"]["UserCollectionTracks_Items_Resource_Identifier"][];
22978
23119
  included?: components["schemas"]["Included"];
@@ -23045,8 +23186,20 @@ export interface components {
23045
23186
  data: components["schemas"]["UserCollectionVideosItemsRelationshipAddOperation_Payload_Data"][];
23046
23187
  };
23047
23188
  UserCollectionVideosItemsRelationshipAddOperation_Payload_Data: {
23189
+ id: string;
23190
+ meta?: components["schemas"]["UserCollectionVideosItemsRelationshipAddOperation_Payload_Data_Meta"];
23191
+ /** @enum {string} */
23192
+ type: "videos";
23193
+ };
23194
+ UserCollectionVideosItemsRelationshipAddOperation_Payload_Data_Meta: {
23195
+ /** Format: date-time */
23196
+ addedAt?: string;
23197
+ };
23198
+ UserCollectionVideosItemsRelationshipAddOperation_Response_Meta_SkippedItem: {
23048
23199
  id: string;
23049
23200
  /** @enum {string} */
23201
+ reason: "NOT_FOUND" | "ALREADY_PRESENT";
23202
+ /** @enum {string} */
23050
23203
  type: "videos";
23051
23204
  };
23052
23205
  UserCollectionVideosItemsRelationshipRemoveOperation_Payload: {
@@ -23057,7 +23210,27 @@ export interface components {
23057
23210
  /** @enum {string} */
23058
23211
  type: "videos";
23059
23212
  };
23060
- UserCollectionVideos_Attributes: Record<string, never>;
23213
+ UserCollectionVideos_Attributes: {
23214
+ /**
23215
+ * Format: date-time
23216
+ * @description When the collection was last modified
23217
+ */
23218
+ lastModifiedAt?: string;
23219
+ /**
23220
+ * Format: int32
23221
+ * @description Number of items in the collection
23222
+ */
23223
+ numberOfItems: number;
23224
+ };
23225
+ UserCollectionVideos_Items_Add_Multi_Relationship_Data_Document: {
23226
+ data?: components["schemas"]["UserCollectionVideos_Items_Resource_Identifier"][];
23227
+ included?: components["schemas"]["Included"];
23228
+ links: components["schemas"]["Links"];
23229
+ meta?: components["schemas"]["UserCollectionVideos_Items_Add_Multi_Relationship_Data_Document_Meta"];
23230
+ };
23231
+ UserCollectionVideos_Items_Add_Multi_Relationship_Data_Document_Meta: {
23232
+ skipped: components["schemas"]["UserCollectionVideosItemsRelationshipAddOperation_Response_Meta_SkippedItem"][];
23233
+ };
23061
23234
  UserCollectionVideos_Items_Multi_Relationship_Data_Document: {
23062
23235
  data?: components["schemas"]["UserCollectionVideos_Items_Resource_Identifier"][];
23063
23236
  included?: components["schemas"]["Included"];