@tidal-music/api 0.36.0 → 0.38.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/src/allAPI.generated.d.ts +793 -93
- package/dist/src/index.d.ts +1 -1
- package/package.json +1 -1
|
@@ -236,6 +236,11 @@ export interface paths {
|
|
|
236
236
|
get: {
|
|
237
237
|
parameters: {
|
|
238
238
|
query?: {
|
|
239
|
+
/**
|
|
240
|
+
* @description ISO 3166-1 alpha-2 country code
|
|
241
|
+
* @example US
|
|
242
|
+
*/
|
|
243
|
+
countryCode?: string;
|
|
239
244
|
/**
|
|
240
245
|
* @description Allows the client to customize which related resources should be returned. Available options: owners
|
|
241
246
|
* @example owners
|
|
@@ -295,6 +300,11 @@ export interface paths {
|
|
|
295
300
|
get: {
|
|
296
301
|
parameters: {
|
|
297
302
|
query?: {
|
|
303
|
+
/**
|
|
304
|
+
* @description ISO 3166-1 alpha-2 country code
|
|
305
|
+
* @example US
|
|
306
|
+
*/
|
|
307
|
+
countryCode?: string;
|
|
298
308
|
/**
|
|
299
309
|
* @description Allows the client to customize which related resources should be returned. Available options: owners
|
|
300
310
|
* @example owners
|
|
@@ -1009,6 +1019,11 @@ export interface paths {
|
|
|
1009
1019
|
get: {
|
|
1010
1020
|
parameters: {
|
|
1011
1021
|
query?: {
|
|
1022
|
+
/**
|
|
1023
|
+
* @description ISO 3166-1 alpha-2 country code
|
|
1024
|
+
* @example US
|
|
1025
|
+
*/
|
|
1026
|
+
countryCode?: string;
|
|
1012
1027
|
/**
|
|
1013
1028
|
* @description Allows the client to customize which related resources should be returned. Available options: owners
|
|
1014
1029
|
* @example owners
|
|
@@ -5592,7 +5607,7 @@ export interface paths {
|
|
|
5592
5607
|
*/
|
|
5593
5608
|
clientVersion: string;
|
|
5594
5609
|
/**
|
|
5595
|
-
* @description Allows the client to customize which related resources should be returned. Available options: items
|
|
5610
|
+
* @description Allows the client to customize which related resources should be returned. Available options: items, seedItem
|
|
5596
5611
|
* @example items
|
|
5597
5612
|
*/
|
|
5598
5613
|
include?: string[];
|
|
@@ -5674,7 +5689,7 @@ export interface paths {
|
|
|
5674
5689
|
*/
|
|
5675
5690
|
clientVersion: string;
|
|
5676
5691
|
/**
|
|
5677
|
-
* @description Allows the client to customize which related resources should be returned. Available options: items
|
|
5692
|
+
* @description Allows the client to customize which related resources should be returned. Available options: items, seedItem
|
|
5678
5693
|
* @example items
|
|
5679
5694
|
*/
|
|
5680
5695
|
include?: string[];
|
|
@@ -5727,7 +5742,7 @@ export interface paths {
|
|
|
5727
5742
|
};
|
|
5728
5743
|
/**
|
|
5729
5744
|
* Get items relationship ("to-many").
|
|
5730
|
-
* @description
|
|
5745
|
+
* @description The module's items, in order — one stable collection per module, consistent for a given refreshSeed. Reads without a cursor return the first page (the slice a page shelf renders, sized for the module's previewLayout and device) with a continuation cursor; passing the cursor returns subsequent pages.
|
|
5731
5746
|
*/
|
|
5732
5747
|
get: {
|
|
5733
5748
|
parameters: {
|
|
@@ -5806,6 +5821,92 @@ export interface paths {
|
|
|
5806
5821
|
patch?: never;
|
|
5807
5822
|
trace?: never;
|
|
5808
5823
|
};
|
|
5824
|
+
"/dynamicModules/{id}/relationships/seedItem": {
|
|
5825
|
+
parameters: {
|
|
5826
|
+
query?: never;
|
|
5827
|
+
header?: never;
|
|
5828
|
+
path?: never;
|
|
5829
|
+
cookie?: never;
|
|
5830
|
+
};
|
|
5831
|
+
/**
|
|
5832
|
+
* Get seedItem relationship ("to-one").
|
|
5833
|
+
* @description The item whose listen or add event seeded this module's collection (e.g. the album a BECAUSE_YOU_* module is based on); null for modules that are not seeded by an item. The seed comes from the same fetch as the module's items, so the two always agree.
|
|
5834
|
+
*/
|
|
5835
|
+
get: {
|
|
5836
|
+
parameters: {
|
|
5837
|
+
query: {
|
|
5838
|
+
/** @description Stable seed used to keep dynamic page and module results consistent across a client session. */
|
|
5839
|
+
refreshSeed?: string;
|
|
5840
|
+
/**
|
|
5841
|
+
* @description ISO 3166-1 alpha-2 country code
|
|
5842
|
+
* @example US
|
|
5843
|
+
*/
|
|
5844
|
+
countryCode?: string;
|
|
5845
|
+
/**
|
|
5846
|
+
* @description BCP 47 locale (e.g., en-US, nb-NO, pt-BR). Defaults to en-US if not provided or unsupported.
|
|
5847
|
+
* @example en-US
|
|
5848
|
+
*/
|
|
5849
|
+
locale?: string;
|
|
5850
|
+
/**
|
|
5851
|
+
* @description The type of device making the request
|
|
5852
|
+
* @example PHONE
|
|
5853
|
+
*/
|
|
5854
|
+
deviceType: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV";
|
|
5855
|
+
/**
|
|
5856
|
+
* @description The system type of the device making the request
|
|
5857
|
+
* @example IOS
|
|
5858
|
+
*/
|
|
5859
|
+
systemType: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB";
|
|
5860
|
+
/**
|
|
5861
|
+
* @description Client version number
|
|
5862
|
+
* @example 2026.0.1
|
|
5863
|
+
*/
|
|
5864
|
+
clientVersion: string;
|
|
5865
|
+
/**
|
|
5866
|
+
* @description Allows the client to customize which related resources should be returned. Available options: seedItem
|
|
5867
|
+
* @example seedItem
|
|
5868
|
+
*/
|
|
5869
|
+
include?: string[];
|
|
5870
|
+
};
|
|
5871
|
+
header?: never;
|
|
5872
|
+
path: {
|
|
5873
|
+
/**
|
|
5874
|
+
* @description DynamicModules Id
|
|
5875
|
+
* @example nejMcAhh5N8S3EQ4LaqysVdI0cZZ
|
|
5876
|
+
*/
|
|
5877
|
+
id: string;
|
|
5878
|
+
};
|
|
5879
|
+
cookie?: never;
|
|
5880
|
+
};
|
|
5881
|
+
requestBody?: never;
|
|
5882
|
+
responses: {
|
|
5883
|
+
/** @description Successful response */
|
|
5884
|
+
200: {
|
|
5885
|
+
headers: {
|
|
5886
|
+
[name: string]: unknown;
|
|
5887
|
+
};
|
|
5888
|
+
content: {
|
|
5889
|
+
"application/vnd.api+json": components["schemas"]["DynamicModules_Single_Relationship_Data_Document"];
|
|
5890
|
+
};
|
|
5891
|
+
};
|
|
5892
|
+
400: components["responses"]["Default400Response"];
|
|
5893
|
+
404: components["responses"]["Default404Response"];
|
|
5894
|
+
405: components["responses"]["Default405Response"];
|
|
5895
|
+
406: components["responses"]["Default406Response"];
|
|
5896
|
+
415: components["responses"]["Default415Response"];
|
|
5897
|
+
429: components["responses"]["Default429Response"];
|
|
5898
|
+
500: components["responses"]["Default500Response"];
|
|
5899
|
+
503: components["responses"]["Default503Response"];
|
|
5900
|
+
};
|
|
5901
|
+
};
|
|
5902
|
+
put?: never;
|
|
5903
|
+
post?: never;
|
|
5904
|
+
delete?: never;
|
|
5905
|
+
options?: never;
|
|
5906
|
+
head?: never;
|
|
5907
|
+
patch?: never;
|
|
5908
|
+
trace?: never;
|
|
5909
|
+
};
|
|
5809
5910
|
"/dynamicPages": {
|
|
5810
5911
|
parameters: {
|
|
5811
5912
|
query?: never;
|
|
@@ -9959,6 +10060,21 @@ export interface paths {
|
|
|
9959
10060
|
* @example US
|
|
9960
10061
|
*/
|
|
9961
10062
|
countryCode?: string;
|
|
10063
|
+
/**
|
|
10064
|
+
* @description The type of device making the request
|
|
10065
|
+
* @example PHONE
|
|
10066
|
+
*/
|
|
10067
|
+
deviceType?: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV";
|
|
10068
|
+
/**
|
|
10069
|
+
* @description The system type of the device making the request
|
|
10070
|
+
* @example IOS
|
|
10071
|
+
*/
|
|
10072
|
+
systemType?: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB";
|
|
10073
|
+
/**
|
|
10074
|
+
* @description Client version number
|
|
10075
|
+
* @example 2026.0.1
|
|
10076
|
+
*/
|
|
10077
|
+
clientVersion?: string;
|
|
9962
10078
|
/**
|
|
9963
10079
|
* @description Allows the client to customize which related resources should be returned. Available options: albums, artists, playlists, topHits, tracks, videos
|
|
9964
10080
|
* @example albums
|
|
@@ -10030,6 +10146,21 @@ export interface paths {
|
|
|
10030
10146
|
* @example US
|
|
10031
10147
|
*/
|
|
10032
10148
|
countryCode?: string;
|
|
10149
|
+
/**
|
|
10150
|
+
* @description The type of device making the request
|
|
10151
|
+
* @example PHONE
|
|
10152
|
+
*/
|
|
10153
|
+
deviceType?: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV";
|
|
10154
|
+
/**
|
|
10155
|
+
* @description The system type of the device making the request
|
|
10156
|
+
* @example IOS
|
|
10157
|
+
*/
|
|
10158
|
+
systemType?: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB";
|
|
10159
|
+
/**
|
|
10160
|
+
* @description Client version number
|
|
10161
|
+
* @example 2026.0.1
|
|
10162
|
+
*/
|
|
10163
|
+
clientVersion?: string;
|
|
10033
10164
|
/**
|
|
10034
10165
|
* @description Allows the client to customize which related resources should be returned. Available options: albums
|
|
10035
10166
|
* @example albums
|
|
@@ -10101,6 +10232,21 @@ export interface paths {
|
|
|
10101
10232
|
* @example US
|
|
10102
10233
|
*/
|
|
10103
10234
|
countryCode?: string;
|
|
10235
|
+
/**
|
|
10236
|
+
* @description The type of device making the request
|
|
10237
|
+
* @example PHONE
|
|
10238
|
+
*/
|
|
10239
|
+
deviceType?: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV";
|
|
10240
|
+
/**
|
|
10241
|
+
* @description The system type of the device making the request
|
|
10242
|
+
* @example IOS
|
|
10243
|
+
*/
|
|
10244
|
+
systemType?: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB";
|
|
10245
|
+
/**
|
|
10246
|
+
* @description Client version number
|
|
10247
|
+
* @example 2026.0.1
|
|
10248
|
+
*/
|
|
10249
|
+
clientVersion?: string;
|
|
10104
10250
|
/**
|
|
10105
10251
|
* @description Allows the client to customize which related resources should be returned. Available options: artists
|
|
10106
10252
|
* @example artists
|
|
@@ -10172,6 +10318,21 @@ export interface paths {
|
|
|
10172
10318
|
* @example US
|
|
10173
10319
|
*/
|
|
10174
10320
|
countryCode?: string;
|
|
10321
|
+
/**
|
|
10322
|
+
* @description The type of device making the request
|
|
10323
|
+
* @example PHONE
|
|
10324
|
+
*/
|
|
10325
|
+
deviceType?: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV";
|
|
10326
|
+
/**
|
|
10327
|
+
* @description The system type of the device making the request
|
|
10328
|
+
* @example IOS
|
|
10329
|
+
*/
|
|
10330
|
+
systemType?: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB";
|
|
10331
|
+
/**
|
|
10332
|
+
* @description Client version number
|
|
10333
|
+
* @example 2026.0.1
|
|
10334
|
+
*/
|
|
10335
|
+
clientVersion?: string;
|
|
10175
10336
|
/**
|
|
10176
10337
|
* @description Allows the client to customize which related resources should be returned. Available options: playlists
|
|
10177
10338
|
* @example playlists
|
|
@@ -10243,6 +10404,21 @@ export interface paths {
|
|
|
10243
10404
|
* @example US
|
|
10244
10405
|
*/
|
|
10245
10406
|
countryCode?: string;
|
|
10407
|
+
/**
|
|
10408
|
+
* @description The type of device making the request
|
|
10409
|
+
* @example PHONE
|
|
10410
|
+
*/
|
|
10411
|
+
deviceType?: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV";
|
|
10412
|
+
/**
|
|
10413
|
+
* @description The system type of the device making the request
|
|
10414
|
+
* @example IOS
|
|
10415
|
+
*/
|
|
10416
|
+
systemType?: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB";
|
|
10417
|
+
/**
|
|
10418
|
+
* @description Client version number
|
|
10419
|
+
* @example 2026.0.1
|
|
10420
|
+
*/
|
|
10421
|
+
clientVersion?: string;
|
|
10246
10422
|
/**
|
|
10247
10423
|
* @description Allows the client to customize which related resources should be returned. Available options: topHits
|
|
10248
10424
|
* @example topHits
|
|
@@ -10314,6 +10490,21 @@ export interface paths {
|
|
|
10314
10490
|
* @example US
|
|
10315
10491
|
*/
|
|
10316
10492
|
countryCode?: string;
|
|
10493
|
+
/**
|
|
10494
|
+
* @description The type of device making the request
|
|
10495
|
+
* @example PHONE
|
|
10496
|
+
*/
|
|
10497
|
+
deviceType?: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV";
|
|
10498
|
+
/**
|
|
10499
|
+
* @description The system type of the device making the request
|
|
10500
|
+
* @example IOS
|
|
10501
|
+
*/
|
|
10502
|
+
systemType?: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB";
|
|
10503
|
+
/**
|
|
10504
|
+
* @description Client version number
|
|
10505
|
+
* @example 2026.0.1
|
|
10506
|
+
*/
|
|
10507
|
+
clientVersion?: string;
|
|
10317
10508
|
/**
|
|
10318
10509
|
* @description Allows the client to customize which related resources should be returned. Available options: tracks
|
|
10319
10510
|
* @example tracks
|
|
@@ -10385,6 +10576,21 @@ export interface paths {
|
|
|
10385
10576
|
* @example US
|
|
10386
10577
|
*/
|
|
10387
10578
|
countryCode?: string;
|
|
10579
|
+
/**
|
|
10580
|
+
* @description The type of device making the request
|
|
10581
|
+
* @example PHONE
|
|
10582
|
+
*/
|
|
10583
|
+
deviceType?: "BROWSER" | "CAR" | "DESKTOP" | "PHONE" | "TABLET" | "TV";
|
|
10584
|
+
/**
|
|
10585
|
+
* @description The system type of the device making the request
|
|
10586
|
+
* @example IOS
|
|
10587
|
+
*/
|
|
10588
|
+
systemType?: "ANDROID" | "DESKTOP" | "TESLA" | "IOS" | "WEB";
|
|
10589
|
+
/**
|
|
10590
|
+
* @description Client version number
|
|
10591
|
+
* @example 2026.0.1
|
|
10592
|
+
*/
|
|
10593
|
+
clientVersion?: string;
|
|
10388
10594
|
/**
|
|
10389
10595
|
* @description Allows the client to customize which related resources should be returned. Available options: videos
|
|
10390
10596
|
* @example videos
|
|
@@ -11359,41 +11565,263 @@ export interface paths {
|
|
|
11359
11565
|
503: components["responses"]["Default503Response"];
|
|
11360
11566
|
};
|
|
11361
11567
|
};
|
|
11362
|
-
put?: never;
|
|
11363
|
-
post?: never;
|
|
11568
|
+
put?: never;
|
|
11569
|
+
post?: never;
|
|
11570
|
+
delete?: never;
|
|
11571
|
+
options?: never;
|
|
11572
|
+
head?: never;
|
|
11573
|
+
patch?: never;
|
|
11574
|
+
trace?: never;
|
|
11575
|
+
};
|
|
11576
|
+
"/stripeDashboardLinks": {
|
|
11577
|
+
parameters: {
|
|
11578
|
+
query?: never;
|
|
11579
|
+
header?: never;
|
|
11580
|
+
path?: never;
|
|
11581
|
+
cookie?: never;
|
|
11582
|
+
};
|
|
11583
|
+
/**
|
|
11584
|
+
* Get multiple stripeDashboardLinks.
|
|
11585
|
+
* @description Retrieves multiple stripeDashboardLinks by available filters, or without if applicable.
|
|
11586
|
+
*/
|
|
11587
|
+
get: {
|
|
11588
|
+
parameters: {
|
|
11589
|
+
query: {
|
|
11590
|
+
/**
|
|
11591
|
+
* @description Allows the client to customize which related resources should be returned. Available options: owners
|
|
11592
|
+
* @example owners
|
|
11593
|
+
*/
|
|
11594
|
+
include?: string[];
|
|
11595
|
+
/** @description User id. Use `me` for the authenticated user */
|
|
11596
|
+
"filter[owners.id]": string[];
|
|
11597
|
+
};
|
|
11598
|
+
header?: never;
|
|
11599
|
+
path?: never;
|
|
11600
|
+
cookie?: never;
|
|
11601
|
+
};
|
|
11602
|
+
requestBody?: never;
|
|
11603
|
+
responses: {
|
|
11604
|
+
/** @description Successful response */
|
|
11605
|
+
200: {
|
|
11606
|
+
headers: {
|
|
11607
|
+
[name: string]: unknown;
|
|
11608
|
+
};
|
|
11609
|
+
content: {
|
|
11610
|
+
"application/vnd.api+json": components["schemas"]["StripeDashboardLinks_Multi_Resource_Data_Document"];
|
|
11611
|
+
};
|
|
11612
|
+
};
|
|
11613
|
+
400: components["responses"]["Default400Response"];
|
|
11614
|
+
404: components["responses"]["Default404Response"];
|
|
11615
|
+
405: components["responses"]["Default405Response"];
|
|
11616
|
+
406: components["responses"]["Default406Response"];
|
|
11617
|
+
415: components["responses"]["Default415Response"];
|
|
11618
|
+
429: components["responses"]["Default429Response"];
|
|
11619
|
+
500: components["responses"]["Default500Response"];
|
|
11620
|
+
503: components["responses"]["Default503Response"];
|
|
11621
|
+
};
|
|
11622
|
+
};
|
|
11623
|
+
put?: never;
|
|
11624
|
+
post?: never;
|
|
11625
|
+
delete?: never;
|
|
11626
|
+
options?: never;
|
|
11627
|
+
head?: never;
|
|
11628
|
+
patch?: never;
|
|
11629
|
+
trace?: never;
|
|
11630
|
+
};
|
|
11631
|
+
"/stripeDashboardLinks/{id}/relationships/owners": {
|
|
11632
|
+
parameters: {
|
|
11633
|
+
query?: never;
|
|
11634
|
+
header?: never;
|
|
11635
|
+
path?: never;
|
|
11636
|
+
cookie?: never;
|
|
11637
|
+
};
|
|
11638
|
+
/**
|
|
11639
|
+
* Get owners relationship ("to-many").
|
|
11640
|
+
* @description Retrieves owners relationship.
|
|
11641
|
+
*/
|
|
11642
|
+
get: {
|
|
11643
|
+
parameters: {
|
|
11644
|
+
query?: {
|
|
11645
|
+
/**
|
|
11646
|
+
* @description Allows the client to customize which related resources should be returned. Available options: owners
|
|
11647
|
+
* @example owners
|
|
11648
|
+
*/
|
|
11649
|
+
include?: string[];
|
|
11650
|
+
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
11651
|
+
"page[cursor]"?: string;
|
|
11652
|
+
};
|
|
11653
|
+
header?: never;
|
|
11654
|
+
path: {
|
|
11655
|
+
/**
|
|
11656
|
+
* @description Stripe dashboard link id. Use `me` for the authenticated user's resource
|
|
11657
|
+
* @example me
|
|
11658
|
+
*/
|
|
11659
|
+
id: string;
|
|
11660
|
+
};
|
|
11661
|
+
cookie?: never;
|
|
11662
|
+
};
|
|
11663
|
+
requestBody?: never;
|
|
11664
|
+
responses: {
|
|
11665
|
+
/** @description Successful response */
|
|
11666
|
+
200: {
|
|
11667
|
+
headers: {
|
|
11668
|
+
[name: string]: unknown;
|
|
11669
|
+
};
|
|
11670
|
+
content: {
|
|
11671
|
+
"application/vnd.api+json": components["schemas"]["StripeDashboardLinks_Multi_Relationship_Data_Document"];
|
|
11672
|
+
};
|
|
11673
|
+
};
|
|
11674
|
+
400: components["responses"]["Default400Response"];
|
|
11675
|
+
404: components["responses"]["Default404Response"];
|
|
11676
|
+
405: components["responses"]["Default405Response"];
|
|
11677
|
+
406: components["responses"]["Default406Response"];
|
|
11678
|
+
415: components["responses"]["Default415Response"];
|
|
11679
|
+
429: components["responses"]["Default429Response"];
|
|
11680
|
+
500: components["responses"]["Default500Response"];
|
|
11681
|
+
503: components["responses"]["Default503Response"];
|
|
11682
|
+
};
|
|
11683
|
+
};
|
|
11684
|
+
put?: never;
|
|
11685
|
+
post?: never;
|
|
11686
|
+
delete?: never;
|
|
11687
|
+
options?: never;
|
|
11688
|
+
head?: never;
|
|
11689
|
+
patch?: never;
|
|
11690
|
+
trace?: never;
|
|
11691
|
+
};
|
|
11692
|
+
"/subscriptionPriceChangeDecisions": {
|
|
11693
|
+
parameters: {
|
|
11694
|
+
query?: never;
|
|
11695
|
+
header?: never;
|
|
11696
|
+
path?: never;
|
|
11697
|
+
cookie?: never;
|
|
11698
|
+
};
|
|
11699
|
+
/**
|
|
11700
|
+
* Get multiple subscriptionPriceChangeDecisions.
|
|
11701
|
+
* @description Retrieves multiple subscriptionPriceChangeDecisions by available filters, or without if applicable.
|
|
11702
|
+
*/
|
|
11703
|
+
get: {
|
|
11704
|
+
parameters: {
|
|
11705
|
+
query: {
|
|
11706
|
+
/**
|
|
11707
|
+
* @description Allows the client to customize which related resources should be returned. Available options: priceChange
|
|
11708
|
+
* @example priceChange
|
|
11709
|
+
*/
|
|
11710
|
+
include?: string[];
|
|
11711
|
+
/** @description User id. Use `me` for the authenticated user */
|
|
11712
|
+
"filter[owners.id]": string[];
|
|
11713
|
+
};
|
|
11714
|
+
header?: never;
|
|
11715
|
+
path?: never;
|
|
11716
|
+
cookie?: never;
|
|
11717
|
+
};
|
|
11718
|
+
requestBody?: never;
|
|
11719
|
+
responses: {
|
|
11720
|
+
/** @description Successful response */
|
|
11721
|
+
200: {
|
|
11722
|
+
headers: {
|
|
11723
|
+
[name: string]: unknown;
|
|
11724
|
+
};
|
|
11725
|
+
content: {
|
|
11726
|
+
"application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisions_Multi_Resource_Data_Document"];
|
|
11727
|
+
};
|
|
11728
|
+
};
|
|
11729
|
+
400: components["responses"]["Default400Response"];
|
|
11730
|
+
404: components["responses"]["Default404Response"];
|
|
11731
|
+
405: components["responses"]["Default405Response"];
|
|
11732
|
+
406: components["responses"]["Default406Response"];
|
|
11733
|
+
415: components["responses"]["Default415Response"];
|
|
11734
|
+
429: components["responses"]["Default429Response"];
|
|
11735
|
+
500: components["responses"]["Default500Response"];
|
|
11736
|
+
503: components["responses"]["Default503Response"];
|
|
11737
|
+
};
|
|
11738
|
+
};
|
|
11739
|
+
put?: never;
|
|
11740
|
+
/**
|
|
11741
|
+
* Create single subscriptionPriceChangeDecision.
|
|
11742
|
+
* @description Creates a new subscriptionPriceChangeDecision.
|
|
11743
|
+
*/
|
|
11744
|
+
post: {
|
|
11745
|
+
parameters: {
|
|
11746
|
+
query?: never;
|
|
11747
|
+
header?: {
|
|
11748
|
+
/** @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. */
|
|
11749
|
+
"Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
|
|
11750
|
+
};
|
|
11751
|
+
path?: never;
|
|
11752
|
+
cookie?: never;
|
|
11753
|
+
};
|
|
11754
|
+
requestBody?: {
|
|
11755
|
+
content: {
|
|
11756
|
+
"application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisionsCreateOperation_Payload"];
|
|
11757
|
+
};
|
|
11758
|
+
};
|
|
11759
|
+
responses: {
|
|
11760
|
+
/** @description Successful response */
|
|
11761
|
+
201: {
|
|
11762
|
+
headers: {
|
|
11763
|
+
[name: string]: unknown;
|
|
11764
|
+
};
|
|
11765
|
+
content: {
|
|
11766
|
+
"application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisions_Single_Resource_Data_Document"];
|
|
11767
|
+
};
|
|
11768
|
+
};
|
|
11769
|
+
400: components["responses"]["Default400Response"];
|
|
11770
|
+
404: components["responses"]["Default404Response"];
|
|
11771
|
+
405: components["responses"]["Default405Response"];
|
|
11772
|
+
406: components["responses"]["Default406Response"];
|
|
11773
|
+
409: components["responses"]["Idempotency409Response"];
|
|
11774
|
+
415: components["responses"]["Default415Response"];
|
|
11775
|
+
422: components["responses"]["Idempotency422Response"];
|
|
11776
|
+
429: components["responses"]["Default429Response"];
|
|
11777
|
+
500: components["responses"]["Default500Response"];
|
|
11778
|
+
503: components["responses"]["Default503Response"];
|
|
11779
|
+
};
|
|
11780
|
+
};
|
|
11364
11781
|
delete?: never;
|
|
11365
11782
|
options?: never;
|
|
11366
11783
|
head?: never;
|
|
11367
11784
|
patch?: never;
|
|
11368
11785
|
trace?: never;
|
|
11369
11786
|
};
|
|
11370
|
-
"/
|
|
11787
|
+
"/subscriptionPriceChangeDecisions/{id}": {
|
|
11371
11788
|
parameters: {
|
|
11372
11789
|
query?: never;
|
|
11373
11790
|
header?: never;
|
|
11374
11791
|
path?: never;
|
|
11375
11792
|
cookie?: never;
|
|
11376
11793
|
};
|
|
11794
|
+
get?: never;
|
|
11795
|
+
put?: never;
|
|
11796
|
+
post?: never;
|
|
11797
|
+
delete?: never;
|
|
11798
|
+
options?: never;
|
|
11799
|
+
head?: never;
|
|
11377
11800
|
/**
|
|
11378
|
-
*
|
|
11379
|
-
* @description
|
|
11801
|
+
* Update single subscriptionPriceChangeDecision.
|
|
11802
|
+
* @description Updates existing subscriptionPriceChangeDecision.
|
|
11380
11803
|
*/
|
|
11381
|
-
|
|
11804
|
+
patch: {
|
|
11382
11805
|
parameters: {
|
|
11383
|
-
query
|
|
11806
|
+
query?: never;
|
|
11807
|
+
header?: {
|
|
11808
|
+
/** @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. */
|
|
11809
|
+
"Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
|
|
11810
|
+
};
|
|
11811
|
+
path: {
|
|
11384
11812
|
/**
|
|
11385
|
-
* @description
|
|
11386
|
-
* @example
|
|
11813
|
+
* @description Price change decision id
|
|
11814
|
+
* @example 1AC1yHZWFAFVjnFOn8XoXA
|
|
11387
11815
|
*/
|
|
11388
|
-
|
|
11389
|
-
/** @description User id. Use `me` for the authenticated user */
|
|
11390
|
-
"filter[owners.id]": string[];
|
|
11816
|
+
id: string;
|
|
11391
11817
|
};
|
|
11392
|
-
header?: never;
|
|
11393
|
-
path?: never;
|
|
11394
11818
|
cookie?: never;
|
|
11395
11819
|
};
|
|
11396
|
-
requestBody?:
|
|
11820
|
+
requestBody?: {
|
|
11821
|
+
content: {
|
|
11822
|
+
"application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisionsUpdateOperation_Payload"];
|
|
11823
|
+
};
|
|
11824
|
+
};
|
|
11397
11825
|
responses: {
|
|
11398
11826
|
/** @description Successful response */
|
|
11399
11827
|
200: {
|
|
@@ -11401,28 +11829,24 @@ export interface paths {
|
|
|
11401
11829
|
[name: string]: unknown;
|
|
11402
11830
|
};
|
|
11403
11831
|
content: {
|
|
11404
|
-
"application/vnd.api+json": components["schemas"]["
|
|
11832
|
+
"application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisions_Single_Resource_Data_Document"];
|
|
11405
11833
|
};
|
|
11406
11834
|
};
|
|
11407
11835
|
400: components["responses"]["Default400Response"];
|
|
11408
11836
|
404: components["responses"]["Default404Response"];
|
|
11409
11837
|
405: components["responses"]["Default405Response"];
|
|
11410
11838
|
406: components["responses"]["Default406Response"];
|
|
11839
|
+
409: components["responses"]["Idempotency409Response"];
|
|
11411
11840
|
415: components["responses"]["Default415Response"];
|
|
11841
|
+
422: components["responses"]["Idempotency422Response"];
|
|
11412
11842
|
429: components["responses"]["Default429Response"];
|
|
11413
11843
|
500: components["responses"]["Default500Response"];
|
|
11414
11844
|
503: components["responses"]["Default503Response"];
|
|
11415
11845
|
};
|
|
11416
11846
|
};
|
|
11417
|
-
put?: never;
|
|
11418
|
-
post?: never;
|
|
11419
|
-
delete?: never;
|
|
11420
|
-
options?: never;
|
|
11421
|
-
head?: never;
|
|
11422
|
-
patch?: never;
|
|
11423
11847
|
trace?: never;
|
|
11424
11848
|
};
|
|
11425
|
-
"/
|
|
11849
|
+
"/subscriptionPriceChangeDecisions/{id}/relationships/priceChange": {
|
|
11426
11850
|
parameters: {
|
|
11427
11851
|
query?: never;
|
|
11428
11852
|
header?: never;
|
|
@@ -11430,25 +11854,23 @@ export interface paths {
|
|
|
11430
11854
|
cookie?: never;
|
|
11431
11855
|
};
|
|
11432
11856
|
/**
|
|
11433
|
-
* Get
|
|
11434
|
-
* @description Retrieves
|
|
11857
|
+
* Get priceChange relationship ("to-one").
|
|
11858
|
+
* @description Retrieves priceChange relationship.
|
|
11435
11859
|
*/
|
|
11436
11860
|
get: {
|
|
11437
11861
|
parameters: {
|
|
11438
11862
|
query?: {
|
|
11439
11863
|
/**
|
|
11440
|
-
* @description Allows the client to customize which related resources should be returned. Available options:
|
|
11441
|
-
* @example
|
|
11864
|
+
* @description Allows the client to customize which related resources should be returned. Available options: priceChange
|
|
11865
|
+
* @example priceChange
|
|
11442
11866
|
*/
|
|
11443
11867
|
include?: string[];
|
|
11444
|
-
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
11445
|
-
"page[cursor]"?: string;
|
|
11446
11868
|
};
|
|
11447
11869
|
header?: never;
|
|
11448
11870
|
path: {
|
|
11449
11871
|
/**
|
|
11450
|
-
* @description
|
|
11451
|
-
* @example
|
|
11872
|
+
* @description Price change decision id
|
|
11873
|
+
* @example 1AC1yHZWFAFVjnFOn8XoXA
|
|
11452
11874
|
*/
|
|
11453
11875
|
id: string;
|
|
11454
11876
|
};
|
|
@@ -11462,7 +11884,7 @@ export interface paths {
|
|
|
11462
11884
|
[name: string]: unknown;
|
|
11463
11885
|
};
|
|
11464
11886
|
content: {
|
|
11465
|
-
"application/vnd.api+json": components["schemas"]["
|
|
11887
|
+
"application/vnd.api+json": components["schemas"]["SubscriptionPriceChangeDecisions_Single_Relationship_Data_Document"];
|
|
11466
11888
|
};
|
|
11467
11889
|
};
|
|
11468
11890
|
400: components["responses"]["Default400Response"];
|
|
@@ -12077,6 +12499,11 @@ export interface paths {
|
|
|
12077
12499
|
get: {
|
|
12078
12500
|
parameters: {
|
|
12079
12501
|
query?: {
|
|
12502
|
+
/**
|
|
12503
|
+
* @description ISO 3166-1 alpha-2 country code
|
|
12504
|
+
* @example US
|
|
12505
|
+
*/
|
|
12506
|
+
countryCode?: string;
|
|
12080
12507
|
/**
|
|
12081
12508
|
* @description Allows the client to customize which related resources should be returned. Available options: owners
|
|
12082
12509
|
* @example owners
|
|
@@ -12136,6 +12563,11 @@ export interface paths {
|
|
|
12136
12563
|
get: {
|
|
12137
12564
|
parameters: {
|
|
12138
12565
|
query?: {
|
|
12566
|
+
/**
|
|
12567
|
+
* @description ISO 3166-1 alpha-2 country code
|
|
12568
|
+
* @example US
|
|
12569
|
+
*/
|
|
12570
|
+
countryCode?: string;
|
|
12139
12571
|
/**
|
|
12140
12572
|
* @description Allows the client to customize which related resources should be returned. Available options: owners
|
|
12141
12573
|
* @example owners
|
|
@@ -12932,6 +13364,11 @@ export interface paths {
|
|
|
12932
13364
|
get: {
|
|
12933
13365
|
parameters: {
|
|
12934
13366
|
query?: {
|
|
13367
|
+
/**
|
|
13368
|
+
* @description ISO 3166-1 alpha-2 country code
|
|
13369
|
+
* @example US
|
|
13370
|
+
*/
|
|
13371
|
+
countryCode?: string;
|
|
12935
13372
|
/**
|
|
12936
13373
|
* @description Allows the client to customize which related resources should be returned. Available options: owners
|
|
12937
13374
|
* @example owners
|
|
@@ -18283,6 +18720,120 @@ export interface paths {
|
|
|
18283
18720
|
patch?: never;
|
|
18284
18721
|
trace?: never;
|
|
18285
18722
|
};
|
|
18723
|
+
"/userSubscriptionPriceChanges": {
|
|
18724
|
+
parameters: {
|
|
18725
|
+
query?: never;
|
|
18726
|
+
header?: never;
|
|
18727
|
+
path?: never;
|
|
18728
|
+
cookie?: never;
|
|
18729
|
+
};
|
|
18730
|
+
/**
|
|
18731
|
+
* Get multiple userSubscriptionPriceChanges.
|
|
18732
|
+
* @description Retrieves multiple userSubscriptionPriceChanges by available filters, or without if applicable.
|
|
18733
|
+
*/
|
|
18734
|
+
get: {
|
|
18735
|
+
parameters: {
|
|
18736
|
+
query: {
|
|
18737
|
+
/**
|
|
18738
|
+
* @description Allows the client to customize which related resources should be returned. Available options: decision
|
|
18739
|
+
* @example decision
|
|
18740
|
+
*/
|
|
18741
|
+
include?: string[];
|
|
18742
|
+
/** @description User id. Use `me` for the authenticated user */
|
|
18743
|
+
"filter[owners.id]": string[];
|
|
18744
|
+
};
|
|
18745
|
+
header?: never;
|
|
18746
|
+
path?: never;
|
|
18747
|
+
cookie?: never;
|
|
18748
|
+
};
|
|
18749
|
+
requestBody?: never;
|
|
18750
|
+
responses: {
|
|
18751
|
+
/** @description Successful response */
|
|
18752
|
+
200: {
|
|
18753
|
+
headers: {
|
|
18754
|
+
[name: string]: unknown;
|
|
18755
|
+
};
|
|
18756
|
+
content: {
|
|
18757
|
+
"application/vnd.api+json": components["schemas"]["UserSubscriptionPriceChanges_Multi_Resource_Data_Document"];
|
|
18758
|
+
};
|
|
18759
|
+
};
|
|
18760
|
+
400: components["responses"]["Default400Response"];
|
|
18761
|
+
404: components["responses"]["Default404Response"];
|
|
18762
|
+
405: components["responses"]["Default405Response"];
|
|
18763
|
+
406: components["responses"]["Default406Response"];
|
|
18764
|
+
415: components["responses"]["Default415Response"];
|
|
18765
|
+
429: components["responses"]["Default429Response"];
|
|
18766
|
+
500: components["responses"]["Default500Response"];
|
|
18767
|
+
503: components["responses"]["Default503Response"];
|
|
18768
|
+
};
|
|
18769
|
+
};
|
|
18770
|
+
put?: never;
|
|
18771
|
+
post?: never;
|
|
18772
|
+
delete?: never;
|
|
18773
|
+
options?: never;
|
|
18774
|
+
head?: never;
|
|
18775
|
+
patch?: never;
|
|
18776
|
+
trace?: never;
|
|
18777
|
+
};
|
|
18778
|
+
"/userSubscriptionPriceChanges/{id}/relationships/decision": {
|
|
18779
|
+
parameters: {
|
|
18780
|
+
query?: never;
|
|
18781
|
+
header?: never;
|
|
18782
|
+
path?: never;
|
|
18783
|
+
cookie?: never;
|
|
18784
|
+
};
|
|
18785
|
+
/**
|
|
18786
|
+
* Get decision relationship ("to-one").
|
|
18787
|
+
* @description Retrieves decision relationship.
|
|
18788
|
+
*/
|
|
18789
|
+
get: {
|
|
18790
|
+
parameters: {
|
|
18791
|
+
query?: {
|
|
18792
|
+
/**
|
|
18793
|
+
* @description Allows the client to customize which related resources should be returned. Available options: decision
|
|
18794
|
+
* @example decision
|
|
18795
|
+
*/
|
|
18796
|
+
include?: string[];
|
|
18797
|
+
};
|
|
18798
|
+
header?: never;
|
|
18799
|
+
path: {
|
|
18800
|
+
/**
|
|
18801
|
+
* @description Price change id
|
|
18802
|
+
* @example 1AC1yHZWFAFVjnFOn8XoXA
|
|
18803
|
+
*/
|
|
18804
|
+
id: string;
|
|
18805
|
+
};
|
|
18806
|
+
cookie?: never;
|
|
18807
|
+
};
|
|
18808
|
+
requestBody?: never;
|
|
18809
|
+
responses: {
|
|
18810
|
+
/** @description Successful response */
|
|
18811
|
+
200: {
|
|
18812
|
+
headers: {
|
|
18813
|
+
[name: string]: unknown;
|
|
18814
|
+
};
|
|
18815
|
+
content: {
|
|
18816
|
+
"application/vnd.api+json": components["schemas"]["UserSubscriptionPriceChanges_Single_Relationship_Data_Document"];
|
|
18817
|
+
};
|
|
18818
|
+
};
|
|
18819
|
+
400: components["responses"]["Default400Response"];
|
|
18820
|
+
404: components["responses"]["Default404Response"];
|
|
18821
|
+
405: components["responses"]["Default405Response"];
|
|
18822
|
+
406: components["responses"]["Default406Response"];
|
|
18823
|
+
415: components["responses"]["Default415Response"];
|
|
18824
|
+
429: components["responses"]["Default429Response"];
|
|
18825
|
+
500: components["responses"]["Default500Response"];
|
|
18826
|
+
503: components["responses"]["Default503Response"];
|
|
18827
|
+
};
|
|
18828
|
+
};
|
|
18829
|
+
put?: never;
|
|
18830
|
+
post?: never;
|
|
18831
|
+
delete?: never;
|
|
18832
|
+
options?: never;
|
|
18833
|
+
head?: never;
|
|
18834
|
+
patch?: never;
|
|
18835
|
+
trace?: never;
|
|
18836
|
+
};
|
|
18286
18837
|
"/users/{id}": {
|
|
18287
18838
|
parameters: {
|
|
18288
18839
|
query?: never;
|
|
@@ -20624,7 +21175,7 @@ export interface components {
|
|
|
20624
21175
|
};
|
|
20625
21176
|
Default400ResponseBody: {
|
|
20626
21177
|
errors: {
|
|
20627
|
-
/** @example
|
|
21178
|
+
/** @example Invalid request */
|
|
20628
21179
|
detail?: string;
|
|
20629
21180
|
/** @example 400 */
|
|
20630
21181
|
status: string;
|
|
@@ -20632,7 +21183,7 @@ export interface components {
|
|
|
20632
21183
|
};
|
|
20633
21184
|
Default404ResponseBody: {
|
|
20634
21185
|
errors: {
|
|
20635
|
-
/** @example
|
|
21186
|
+
/** @example Resource not found */
|
|
20636
21187
|
detail?: string;
|
|
20637
21188
|
/** @example 404 */
|
|
20638
21189
|
status: string;
|
|
@@ -20640,7 +21191,7 @@ export interface components {
|
|
|
20640
21191
|
};
|
|
20641
21192
|
Default405ResponseBody: {
|
|
20642
21193
|
errors: {
|
|
20643
|
-
/** @example
|
|
21194
|
+
/** @example HTTP method not allowed */
|
|
20644
21195
|
detail?: string;
|
|
20645
21196
|
/** @example 405 */
|
|
20646
21197
|
status: string;
|
|
@@ -20648,7 +21199,7 @@ export interface components {
|
|
|
20648
21199
|
};
|
|
20649
21200
|
Default406ResponseBody: {
|
|
20650
21201
|
errors: {
|
|
20651
|
-
/** @example
|
|
21202
|
+
/** @example No acceptable response media type */
|
|
20652
21203
|
detail?: string;
|
|
20653
21204
|
/** @example 406 */
|
|
20654
21205
|
status: string;
|
|
@@ -20656,7 +21207,7 @@ export interface components {
|
|
|
20656
21207
|
};
|
|
20657
21208
|
Default415ResponseBody: {
|
|
20658
21209
|
errors: {
|
|
20659
|
-
/** @example Unsupported request
|
|
21210
|
+
/** @example Unsupported request media type or encoding */
|
|
20660
21211
|
detail?: string;
|
|
20661
21212
|
/** @example 415 */
|
|
20662
21213
|
status: string;
|
|
@@ -20672,7 +21223,7 @@ export interface components {
|
|
|
20672
21223
|
};
|
|
20673
21224
|
Default500ResponseBody: {
|
|
20674
21225
|
errors: {
|
|
20675
|
-
/** @example
|
|
21226
|
+
/** @example Internal server error */
|
|
20676
21227
|
detail?: string;
|
|
20677
21228
|
/** @example 500 */
|
|
20678
21229
|
status: string;
|
|
@@ -20680,7 +21231,7 @@ export interface components {
|
|
|
20680
21231
|
};
|
|
20681
21232
|
Default503ResponseBody: {
|
|
20682
21233
|
errors: {
|
|
20683
|
-
/** @example
|
|
21234
|
+
/** @example Service temporarily unavailable */
|
|
20684
21235
|
detail?: string;
|
|
20685
21236
|
/** @example 503 */
|
|
20686
21237
|
status: string;
|
|
@@ -20779,16 +21330,16 @@ export interface components {
|
|
|
20779
21330
|
};
|
|
20780
21331
|
DynamicModules_Attributes: {
|
|
20781
21332
|
/**
|
|
20782
|
-
* @description
|
|
21333
|
+
* @description Semantic icons the module should show. SPOTLIGHT_INFO identifies modules whose content was selected by TIDAL's editorial team.
|
|
20783
21334
|
* @example SPOTLIGHT_INFO
|
|
20784
21335
|
*/
|
|
20785
21336
|
icons: ("SPOTLIGHT_INFO" | "UNKNOWN")[];
|
|
20786
21337
|
/**
|
|
20787
|
-
* @description
|
|
20788
|
-
* @example
|
|
21338
|
+
* @description Rendering layout for a dynamic module. previewLayout controls the module on a dynamic page. viewAllLayout controls its view-all screen; when omitted, the module has no view-all screen. GRID means artwork-forward tiles; the client owns scroll axis and column count. LIST means detailed text-forward rows in a single column and may be a table on wide screens. COMPACT means dense rows the client may pack into multiple columns; clients should treat it as LIST in a full view. UNKNOWN is the forward-compatible default; clients should skip the module or use a safe default.
|
|
21339
|
+
* @example GRID
|
|
20789
21340
|
* @enum {string}
|
|
20790
21341
|
*/
|
|
20791
|
-
|
|
21342
|
+
previewLayout: "GRID" | "LIST" | "COMPACT" | "UNKNOWN";
|
|
20792
21343
|
/**
|
|
20793
21344
|
* @description Subtitle of the module
|
|
20794
21345
|
* @example Short description of this module
|
|
@@ -20800,11 +21351,11 @@ export interface components {
|
|
|
20800
21351
|
*/
|
|
20801
21352
|
title?: string;
|
|
20802
21353
|
/**
|
|
20803
|
-
* @description
|
|
20804
|
-
* @example
|
|
21354
|
+
* @description Rendering layout for a dynamic module. previewLayout controls the module on a dynamic page. viewAllLayout controls its view-all screen; when omitted, the module has no view-all screen. GRID means artwork-forward tiles; the client owns scroll axis and column count. LIST means detailed text-forward rows in a single column and may be a table on wide screens. COMPACT means dense rows the client may pack into multiple columns; clients should treat it as LIST in a full view. UNKNOWN is the forward-compatible default; clients should skip the module or use a safe default.
|
|
21355
|
+
* @example LIST
|
|
20805
21356
|
* @enum {string}
|
|
20806
21357
|
*/
|
|
20807
|
-
|
|
21358
|
+
viewAllLayout?: "GRID" | "LIST" | "COMPACT" | "UNKNOWN";
|
|
20808
21359
|
};
|
|
20809
21360
|
DynamicModules_Multi_Relationship_Data_Document: {
|
|
20810
21361
|
data?: components["schemas"]["Resource_Identifier"][];
|
|
@@ -20818,6 +21369,7 @@ export interface components {
|
|
|
20818
21369
|
};
|
|
20819
21370
|
DynamicModules_Relationships: {
|
|
20820
21371
|
items?: components["schemas"]["Multi_Relationship_Data_Document"];
|
|
21372
|
+
seedItem?: components["schemas"]["Single_Relationship_Data_Document"];
|
|
20821
21373
|
};
|
|
20822
21374
|
DynamicModules_Resource_Object: {
|
|
20823
21375
|
attributes?: components["schemas"]["DynamicModules_Attributes"];
|
|
@@ -20833,6 +21385,11 @@ export interface components {
|
|
|
20833
21385
|
*/
|
|
20834
21386
|
type: "dynamicModules";
|
|
20835
21387
|
};
|
|
21388
|
+
DynamicModules_Single_Relationship_Data_Document: {
|
|
21389
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
21390
|
+
included?: components["schemas"]["Included"];
|
|
21391
|
+
links: components["schemas"]["Links"];
|
|
21392
|
+
};
|
|
20836
21393
|
DynamicModules_Single_Resource_Data_Document: {
|
|
20837
21394
|
data: components["schemas"]["DynamicModules_Resource_Object"];
|
|
20838
21395
|
included?: components["schemas"]["Included"];
|
|
@@ -21020,7 +21577,7 @@ export interface components {
|
|
|
21020
21577
|
* @enum {string}
|
|
21021
21578
|
*/
|
|
21022
21579
|
code: "IDEMPOTENT_REQUEST_IN_PROGRESS";
|
|
21023
|
-
/** @example
|
|
21580
|
+
/** @example Request already in progress for this idempotency key */
|
|
21024
21581
|
detail?: string;
|
|
21025
21582
|
/** @example 409 */
|
|
21026
21583
|
status: string;
|
|
@@ -21033,13 +21590,13 @@ export interface components {
|
|
|
21033
21590
|
* @enum {string}
|
|
21034
21591
|
*/
|
|
21035
21592
|
code: "IDEMPOTENT_REQUEST_PAYLOAD_MISMATCH";
|
|
21036
|
-
/** @example Idempotency key
|
|
21593
|
+
/** @example Idempotency key reused with a different payload */
|
|
21037
21594
|
detail?: string;
|
|
21038
21595
|
/** @example 422 */
|
|
21039
21596
|
status: string;
|
|
21040
21597
|
}[];
|
|
21041
21598
|
};
|
|
21042
|
-
Included: (components["schemas"]["AcceptedTerms_Resource_Object"] | components["schemas"]["AlbumStatistics_Resource_Object"] | components["schemas"]["Albums_Resource_Object"] | components["schemas"]["Appreciations_Resource_Object"] | components["schemas"]["ArtistBiographies_Resource_Object"] | components["schemas"]["ArtistClaimStatuses_Resource_Object"] | components["schemas"]["ArtistClaims_Resource_Object"] | components["schemas"]["ArtistRoles_Resource_Object"] | components["schemas"]["Artists_Resource_Object"] | components["schemas"]["Artworks_Resource_Object"] | components["schemas"]["Clients_Resource_Object"] | components["schemas"]["CollaborationInviteRedemptions_Resource_Object"] | components["schemas"]["CollaborationInvites_Resource_Object"] | components["schemas"]["Comments_Resource_Object"] | components["schemas"]["ContentClaims_Resource_Object"] | components["schemas"]["Credits_Resource_Object"] | components["schemas"]["Downloads_Resource_Object"] | components["schemas"]["DspSharingLinks_Resource_Object"] | components["schemas"]["DynamicModules_Resource_Object"] | components["schemas"]["DynamicPages_Resource_Object"] | components["schemas"]["Genres_Resource_Object"] | components["schemas"]["Installations_Resource_Object"] | components["schemas"]["Lyrics_Resource_Object"] | components["schemas"]["ManualArtistClaims_Resource_Object"] | components["schemas"]["OfflineTasks_Resource_Object"] | components["schemas"]["PlayQueues_Resource_Object"] | components["schemas"]["Playlists_Resource_Object"] | components["schemas"]["PriceConfigurations_Resource_Object"] | components["schemas"]["ProviderOwners_Resource_Object"] | components["schemas"]["ProviderProductInfos_Resource_Object"] | components["schemas"]["Providers_Resource_Object"] | components["schemas"]["Purchases_Resource_Object"] | components["schemas"]["Reactions_Resource_Object"] | components["schemas"]["SavedShares_Resource_Object"] | components["schemas"]["Scopes_Resource_Object"] | components["schemas"]["SearchHistoryEntries_Resource_Object"] | components["schemas"]["SearchResults_Resource_Object"] | components["schemas"]["SearchSuggestions_Resource_Object"] | components["schemas"]["Shares_Resource_Object"] | components["schemas"]["SquareConnections_Resource_Object"] | components["schemas"]["SquareSites_Resource_Object"] | components["schemas"]["StripeConnections_Resource_Object"] | components["schemas"]["StripeDashboardLinks_Resource_Object"] | components["schemas"]["TemporaryUserTokens_Resource_Object"] | components["schemas"]["Terms_Resource_Object"] | components["schemas"]["TrackFiles_Resource_Object"] | components["schemas"]["TrackManifests_Resource_Object"] | components["schemas"]["TrackSourceFiles_Resource_Object"] | components["schemas"]["TrackStatistics_Resource_Object"] | components["schemas"]["Tracks_Resource_Object"] | components["schemas"]["TracksMetadataStatus_Resource_Object"] | components["schemas"]["UsageRules_Resource_Object"] | components["schemas"]["UserCollectionAlbums_Resource_Object"] | components["schemas"]["UserCollectionArtists_Resource_Object"] | components["schemas"]["UserCollectionFolders_Resource_Object"] | components["schemas"]["UserCollectionPlaylists_Resource_Object"] | components["schemas"]["UserCollectionSaveForLaters_Resource_Object"] | components["schemas"]["UserCollectionTracks_Resource_Object"] | components["schemas"]["UserCollectionVideos_Resource_Object"] | components["schemas"]["UserCollections_Resource_Object"] | components["schemas"]["UserDailyMixes_Resource_Object"] | components["schemas"]["UserDataExportRequests_Resource_Object"] | components["schemas"]["UserDiscoveryMixes_Resource_Object"] | components["schemas"]["UserNewReleaseMixes_Resource_Object"] | components["schemas"]["UserOfflineMixes_Resource_Object"] | components["schemas"]["UserRecommendationBlocks_Resource_Object"] | components["schemas"]["UserRecommendations_Resource_Object"] | components["schemas"]["UserReports_Resource_Object"] | components["schemas"]["Users_Resource_Object"] | components["schemas"]["VideoManifests_Resource_Object"] | components["schemas"]["Videos_Resource_Object"])[];
|
|
21599
|
+
Included: (components["schemas"]["AcceptedTerms_Resource_Object"] | components["schemas"]["AlbumStatistics_Resource_Object"] | components["schemas"]["Albums_Resource_Object"] | components["schemas"]["Appreciations_Resource_Object"] | components["schemas"]["ArtistBiographies_Resource_Object"] | components["schemas"]["ArtistClaimStatuses_Resource_Object"] | components["schemas"]["ArtistClaims_Resource_Object"] | components["schemas"]["ArtistRoles_Resource_Object"] | components["schemas"]["Artists_Resource_Object"] | components["schemas"]["Artworks_Resource_Object"] | components["schemas"]["Clients_Resource_Object"] | components["schemas"]["CollaborationInviteRedemptions_Resource_Object"] | components["schemas"]["CollaborationInvites_Resource_Object"] | components["schemas"]["Comments_Resource_Object"] | components["schemas"]["ContentClaims_Resource_Object"] | components["schemas"]["Credits_Resource_Object"] | components["schemas"]["Downloads_Resource_Object"] | components["schemas"]["DspSharingLinks_Resource_Object"] | components["schemas"]["DynamicModules_Resource_Object"] | components["schemas"]["DynamicPages_Resource_Object"] | components["schemas"]["Genres_Resource_Object"] | components["schemas"]["Installations_Resource_Object"] | components["schemas"]["Lyrics_Resource_Object"] | components["schemas"]["ManualArtistClaims_Resource_Object"] | components["schemas"]["OfflineTasks_Resource_Object"] | components["schemas"]["PlayQueues_Resource_Object"] | components["schemas"]["Playlists_Resource_Object"] | components["schemas"]["PriceConfigurations_Resource_Object"] | components["schemas"]["ProviderOwners_Resource_Object"] | components["schemas"]["ProviderProductInfos_Resource_Object"] | components["schemas"]["Providers_Resource_Object"] | components["schemas"]["Purchases_Resource_Object"] | components["schemas"]["Reactions_Resource_Object"] | components["schemas"]["SavedShares_Resource_Object"] | components["schemas"]["Scopes_Resource_Object"] | components["schemas"]["SearchHistoryEntries_Resource_Object"] | components["schemas"]["SearchResults_Resource_Object"] | components["schemas"]["SearchSuggestions_Resource_Object"] | components["schemas"]["Shares_Resource_Object"] | components["schemas"]["SquareConnections_Resource_Object"] | components["schemas"]["SquareSites_Resource_Object"] | components["schemas"]["StripeConnections_Resource_Object"] | components["schemas"]["StripeDashboardLinks_Resource_Object"] | components["schemas"]["SubscriptionPriceChangeDecisions_Resource_Object"] | components["schemas"]["TemporaryUserTokens_Resource_Object"] | components["schemas"]["Terms_Resource_Object"] | components["schemas"]["TrackFiles_Resource_Object"] | components["schemas"]["TrackManifests_Resource_Object"] | components["schemas"]["TrackSourceFiles_Resource_Object"] | components["schemas"]["TrackStatistics_Resource_Object"] | components["schemas"]["Tracks_Resource_Object"] | components["schemas"]["TracksMetadataStatus_Resource_Object"] | components["schemas"]["UsageRules_Resource_Object"] | components["schemas"]["UserCollectionAlbums_Resource_Object"] | components["schemas"]["UserCollectionArtists_Resource_Object"] | components["schemas"]["UserCollectionFolders_Resource_Object"] | components["schemas"]["UserCollectionPlaylists_Resource_Object"] | components["schemas"]["UserCollectionSaveForLaters_Resource_Object"] | components["schemas"]["UserCollectionTracks_Resource_Object"] | components["schemas"]["UserCollectionVideos_Resource_Object"] | components["schemas"]["UserCollections_Resource_Object"] | components["schemas"]["UserDailyMixes_Resource_Object"] | components["schemas"]["UserDataExportRequests_Resource_Object"] | components["schemas"]["UserDiscoveryMixes_Resource_Object"] | components["schemas"]["UserNewReleaseMixes_Resource_Object"] | components["schemas"]["UserOfflineMixes_Resource_Object"] | components["schemas"]["UserRecommendationBlocks_Resource_Object"] | components["schemas"]["UserRecommendations_Resource_Object"] | components["schemas"]["UserReports_Resource_Object"] | components["schemas"]["UserSubscriptionPriceChanges_Resource_Object"] | components["schemas"]["Users_Resource_Object"] | components["schemas"]["VideoManifests_Resource_Object"] | components["schemas"]["Videos_Resource_Object"])[];
|
|
21043
21600
|
InstallationsCreateOperation_Payload: {
|
|
21044
21601
|
data: components["schemas"]["InstallationsCreateOperation_Payload_Data"];
|
|
21045
21602
|
};
|
|
@@ -22580,7 +23137,7 @@ export interface components {
|
|
|
22580
23137
|
* @enum {string}
|
|
22581
23138
|
*/
|
|
22582
23139
|
code: "IDEMPOTENT_REQUEST_IN_PROGRESS" | "MISSING_SITES_SCOPE";
|
|
22583
|
-
/** @example
|
|
23140
|
+
/** @example Square credential lacks required site scopes; run Square onboarding again */
|
|
22584
23141
|
detail?: string;
|
|
22585
23142
|
/** @example 409 */
|
|
22586
23143
|
status: string;
|
|
@@ -22662,6 +23219,8 @@ export interface components {
|
|
|
22662
23219
|
domain?: string;
|
|
22663
23220
|
/** @description Whether the site is published on Square Online */
|
|
22664
23221
|
published?: boolean;
|
|
23222
|
+
/** @description The site's title as set by the seller in Square */
|
|
23223
|
+
siteTitle?: string;
|
|
22665
23224
|
};
|
|
22666
23225
|
SquareSites_Multi_Resource_Data_Document: {
|
|
22667
23226
|
data: components["schemas"]["SquareSites_Resource_Object"][];
|
|
@@ -22822,6 +23381,93 @@ export interface components {
|
|
|
22822
23381
|
included?: components["schemas"]["Included"];
|
|
22823
23382
|
links: components["schemas"]["Links"];
|
|
22824
23383
|
};
|
|
23384
|
+
SubscriptionPriceChangeDecisionsCreateOperation_Payload: {
|
|
23385
|
+
data: components["schemas"]["SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data"];
|
|
23386
|
+
};
|
|
23387
|
+
SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data: {
|
|
23388
|
+
attributes: components["schemas"]["SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Attributes"];
|
|
23389
|
+
relationships: components["schemas"]["SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships"];
|
|
23390
|
+
/** @enum {string} */
|
|
23391
|
+
type: "subscriptionPriceChangeDecisions";
|
|
23392
|
+
};
|
|
23393
|
+
SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Attributes: {
|
|
23394
|
+
/**
|
|
23395
|
+
* @description The decision to record. A decision may only be created once — changing a rejection to an acceptance is a PATCH.
|
|
23396
|
+
* @enum {string}
|
|
23397
|
+
*/
|
|
23398
|
+
status: "ACCEPTED" | "REJECTED";
|
|
23399
|
+
};
|
|
23400
|
+
SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships: {
|
|
23401
|
+
priceChange: components["schemas"]["SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships_PriceChange"];
|
|
23402
|
+
};
|
|
23403
|
+
SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships_PriceChange: {
|
|
23404
|
+
data: components["schemas"]["SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships_PriceChange_Data"];
|
|
23405
|
+
};
|
|
23406
|
+
SubscriptionPriceChangeDecisionsCreateOperation_Payload_Data_Relationships_PriceChange_Data: {
|
|
23407
|
+
id: string;
|
|
23408
|
+
/** @enum {string} */
|
|
23409
|
+
type: "userSubscriptionPriceChanges";
|
|
23410
|
+
};
|
|
23411
|
+
SubscriptionPriceChangeDecisionsUpdateOperation_Payload: {
|
|
23412
|
+
data: components["schemas"]["SubscriptionPriceChangeDecisionsUpdateOperation_Payload_Data"];
|
|
23413
|
+
};
|
|
23414
|
+
SubscriptionPriceChangeDecisionsUpdateOperation_Payload_Data: {
|
|
23415
|
+
attributes: components["schemas"]["SubscriptionPriceChangeDecisionsUpdateOperation_Payload_Data_Attributes"];
|
|
23416
|
+
id: string;
|
|
23417
|
+
/** @enum {string} */
|
|
23418
|
+
type: "subscriptionPriceChangeDecisions";
|
|
23419
|
+
};
|
|
23420
|
+
SubscriptionPriceChangeDecisionsUpdateOperation_Payload_Data_Attributes: {
|
|
23421
|
+
/**
|
|
23422
|
+
* @description The decision to record. The only allowed transition is REJECTED -> ACCEPTED; acceptance is permanent.
|
|
23423
|
+
* @enum {string}
|
|
23424
|
+
*/
|
|
23425
|
+
status: "ACCEPTED" | "REJECTED";
|
|
23426
|
+
};
|
|
23427
|
+
SubscriptionPriceChangeDecisions_Attributes: {
|
|
23428
|
+
/**
|
|
23429
|
+
* Format: date-time
|
|
23430
|
+
* @description When the user decided. Absent when the consent was implicit (derived from the subscription start).
|
|
23431
|
+
*/
|
|
23432
|
+
decidedAt?: string;
|
|
23433
|
+
/**
|
|
23434
|
+
* @description The user's decision. ACCEPTED is permanent; REJECTED can still be flipped to ACCEPTED before the renewal.
|
|
23435
|
+
* @enum {string}
|
|
23436
|
+
*/
|
|
23437
|
+
status: "ACCEPTED" | "REJECTED";
|
|
23438
|
+
};
|
|
23439
|
+
SubscriptionPriceChangeDecisions_Multi_Resource_Data_Document: {
|
|
23440
|
+
data: components["schemas"]["SubscriptionPriceChangeDecisions_Resource_Object"][];
|
|
23441
|
+
included?: components["schemas"]["Included"];
|
|
23442
|
+
links: components["schemas"]["Links"];
|
|
23443
|
+
};
|
|
23444
|
+
SubscriptionPriceChangeDecisions_Relationships: {
|
|
23445
|
+
priceChange?: components["schemas"]["Single_Relationship_Data_Document"];
|
|
23446
|
+
};
|
|
23447
|
+
SubscriptionPriceChangeDecisions_Resource_Object: {
|
|
23448
|
+
attributes?: components["schemas"]["SubscriptionPriceChangeDecisions_Attributes"];
|
|
23449
|
+
/**
|
|
23450
|
+
* @description Resource id
|
|
23451
|
+
* @example 12345
|
|
23452
|
+
*/
|
|
23453
|
+
id: string;
|
|
23454
|
+
relationships?: components["schemas"]["SubscriptionPriceChangeDecisions_Relationships"];
|
|
23455
|
+
/**
|
|
23456
|
+
* @description Resource type (enum property replaced by openapi-typescript)
|
|
23457
|
+
* @enum {string}
|
|
23458
|
+
*/
|
|
23459
|
+
type: "subscriptionPriceChangeDecisions";
|
|
23460
|
+
};
|
|
23461
|
+
SubscriptionPriceChangeDecisions_Single_Relationship_Data_Document: {
|
|
23462
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
23463
|
+
included?: components["schemas"]["Included"];
|
|
23464
|
+
links: components["schemas"]["Links"];
|
|
23465
|
+
};
|
|
23466
|
+
SubscriptionPriceChangeDecisions_Single_Resource_Data_Document: {
|
|
23467
|
+
data: components["schemas"]["SubscriptionPriceChangeDecisions_Resource_Object"];
|
|
23468
|
+
included?: components["schemas"]["Included"];
|
|
23469
|
+
links: components["schemas"]["Links"];
|
|
23470
|
+
};
|
|
22825
23471
|
TemporaryUserTokensCreateOperation_Payload: {
|
|
22826
23472
|
data: components["schemas"]["TemporaryUserTokensCreateOperation_Payload_Data"];
|
|
22827
23473
|
};
|
|
@@ -22921,7 +23567,7 @@ export interface components {
|
|
|
22921
23567
|
* @enum {string}
|
|
22922
23568
|
*/
|
|
22923
23569
|
code: "CLIENT_NOT_ENTITLED" | "CONCURRENT_PLAYBACK" | "GEO_RESTRICTED" | "PREREQUISITE_MISSING" | "PURCHASE_REQUIRED";
|
|
22924
|
-
/** @example
|
|
23570
|
+
/** @example Required playback prerequisites are missing */
|
|
22925
23571
|
detail?: string;
|
|
22926
23572
|
/** @example 403 */
|
|
22927
23573
|
status: string;
|
|
@@ -22934,7 +23580,7 @@ export interface components {
|
|
|
22934
23580
|
* @enum {string}
|
|
22935
23581
|
*/
|
|
22936
23582
|
code: "CONTENT_NOT_FOUND";
|
|
22937
|
-
/** @example
|
|
23583
|
+
/** @example Content does not exist or is no longer available */
|
|
22938
23584
|
detail?: string;
|
|
22939
23585
|
/** @example 404 */
|
|
22940
23586
|
status: string;
|
|
@@ -22992,7 +23638,7 @@ export interface components {
|
|
|
22992
23638
|
* @enum {string}
|
|
22993
23639
|
*/
|
|
22994
23640
|
code: "CLIENT_NOT_ENTITLED" | "CONCURRENT_PLAYBACK" | "GEO_RESTRICTED" | "PREREQUISITE_MISSING" | "PURCHASE_REQUIRED";
|
|
22995
|
-
/** @example
|
|
23641
|
+
/** @example Required playback prerequisites are missing */
|
|
22996
23642
|
detail?: string;
|
|
22997
23643
|
/** @example 403 */
|
|
22998
23644
|
status: string;
|
|
@@ -23005,7 +23651,7 @@ export interface components {
|
|
|
23005
23651
|
* @enum {string}
|
|
23006
23652
|
*/
|
|
23007
23653
|
code: "CONTENT_NOT_FOUND";
|
|
23008
|
-
/** @example
|
|
23654
|
+
/** @example Content does not exist or is no longer available */
|
|
23009
23655
|
detail?: string;
|
|
23010
23656
|
/** @example 404 */
|
|
23011
23657
|
status: string;
|
|
@@ -23525,7 +24171,7 @@ export interface components {
|
|
|
23525
24171
|
* @enum {string}
|
|
23526
24172
|
*/
|
|
23527
24173
|
code: "DUPLICATE_ITEMS_IN_COLLECTION" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_COLLECTION";
|
|
23528
|
-
/** @example
|
|
24174
|
+
/** @example Collection item limit reached */
|
|
23529
24175
|
detail?: string;
|
|
23530
24176
|
/** @example 409 */
|
|
23531
24177
|
status: string;
|
|
@@ -23642,7 +24288,7 @@ export interface components {
|
|
|
23642
24288
|
* @enum {string}
|
|
23643
24289
|
*/
|
|
23644
24290
|
code: "DUPLICATE_ITEMS_IN_COLLECTION" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_COLLECTION";
|
|
23645
|
-
/** @example
|
|
24291
|
+
/** @example Collection item limit reached */
|
|
23646
24292
|
detail?: string;
|
|
23647
24293
|
/** @example 409 */
|
|
23648
24294
|
status: string;
|
|
@@ -23777,7 +24423,7 @@ export interface components {
|
|
|
23777
24423
|
* @enum {string}
|
|
23778
24424
|
*/
|
|
23779
24425
|
code: "FOLDER_NOT_EMPTY";
|
|
23780
|
-
/** @example
|
|
24426
|
+
/** @example Folder must be empty and owned by you */
|
|
23781
24427
|
detail?: string;
|
|
23782
24428
|
/** @example 400 */
|
|
23783
24429
|
status: string;
|
|
@@ -23888,7 +24534,7 @@ export interface components {
|
|
|
23888
24534
|
* @enum {string}
|
|
23889
24535
|
*/
|
|
23890
24536
|
code: "DUPLICATE_ITEMS_IN_COLLECTION" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_COLLECTION";
|
|
23891
|
-
/** @example
|
|
24537
|
+
/** @example Collection item limit reached */
|
|
23892
24538
|
detail?: string;
|
|
23893
24539
|
/** @example 409 */
|
|
23894
24540
|
status: string;
|
|
@@ -24005,7 +24651,7 @@ export interface components {
|
|
|
24005
24651
|
* @enum {string}
|
|
24006
24652
|
*/
|
|
24007
24653
|
code: "DUPLICATE_ITEMS_IN_COLLECTION" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_COLLECTION";
|
|
24008
|
-
/** @example
|
|
24654
|
+
/** @example Collection item limit reached */
|
|
24009
24655
|
detail?: string;
|
|
24010
24656
|
/** @example 409 */
|
|
24011
24657
|
status: string;
|
|
@@ -24117,7 +24763,7 @@ export interface components {
|
|
|
24117
24763
|
* @enum {string}
|
|
24118
24764
|
*/
|
|
24119
24765
|
code: "DUPLICATE_ITEMS_IN_COLLECTION" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_COLLECTION";
|
|
24120
|
-
/** @example
|
|
24766
|
+
/** @example Collection item limit reached */
|
|
24121
24767
|
detail?: string;
|
|
24122
24768
|
/** @example 409 */
|
|
24123
24769
|
status: string;
|
|
@@ -24234,7 +24880,7 @@ export interface components {
|
|
|
24234
24880
|
* @enum {string}
|
|
24235
24881
|
*/
|
|
24236
24882
|
code: "DUPLICATE_ITEMS_IN_COLLECTION" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_COLLECTION";
|
|
24237
|
-
/** @example
|
|
24883
|
+
/** @example Collection item limit reached */
|
|
24238
24884
|
detail?: string;
|
|
24239
24885
|
/** @example 409 */
|
|
24240
24886
|
status: string;
|
|
@@ -24351,7 +24997,7 @@ export interface components {
|
|
|
24351
24997
|
* @enum {string}
|
|
24352
24998
|
*/
|
|
24353
24999
|
code: "DUPLICATE_ITEMS_IN_COLLECTION" | "IDEMPOTENT_REQUEST_IN_PROGRESS" | "TOO_MANY_ITEMS_IN_COLLECTION";
|
|
24354
|
-
/** @example
|
|
25000
|
+
/** @example Collection item limit reached */
|
|
24355
25001
|
detail?: string;
|
|
24356
25002
|
/** @example 409 */
|
|
24357
25003
|
status: string;
|
|
@@ -24781,7 +25427,7 @@ export interface components {
|
|
|
24781
25427
|
* @enum {string}
|
|
24782
25428
|
*/
|
|
24783
25429
|
code: "IDEMPOTENT_REQUEST_IN_PROGRESS" | "MAXIMUM_NUMBER_OF_BLOCKS_EXCEEDED";
|
|
24784
|
-
/** @example
|
|
25430
|
+
/** @example Recommendation block limit reached */
|
|
24785
25431
|
detail?: string;
|
|
24786
25432
|
/** @example 409 */
|
|
24787
25433
|
status: string;
|
|
@@ -25039,6 +25685,60 @@ export interface components {
|
|
|
25039
25685
|
included?: components["schemas"]["Included"];
|
|
25040
25686
|
links: components["schemas"]["Links"];
|
|
25041
25687
|
};
|
|
25688
|
+
UserSubscriptionPriceChanges_Attributes: {
|
|
25689
|
+
/**
|
|
25690
|
+
* @description ISO 4217 currency code
|
|
25691
|
+
* @example EUR
|
|
25692
|
+
*/
|
|
25693
|
+
currency: string;
|
|
25694
|
+
/**
|
|
25695
|
+
* @description Price amount with max 2 decimal places
|
|
25696
|
+
* @example 9.99
|
|
25697
|
+
*/
|
|
25698
|
+
currentPrice: string;
|
|
25699
|
+
/**
|
|
25700
|
+
* Format: date
|
|
25701
|
+
* @description The date the new price takes effect
|
|
25702
|
+
*/
|
|
25703
|
+
effectiveDate: string;
|
|
25704
|
+
/**
|
|
25705
|
+
* @description Price amount with max 2 decimal places
|
|
25706
|
+
* @example 9.99
|
|
25707
|
+
*/
|
|
25708
|
+
newPrice: string;
|
|
25709
|
+
};
|
|
25710
|
+
UserSubscriptionPriceChanges_Multi_Resource_Data_Document: {
|
|
25711
|
+
data: components["schemas"]["UserSubscriptionPriceChanges_Resource_Object"][];
|
|
25712
|
+
included?: components["schemas"]["Included"];
|
|
25713
|
+
links: components["schemas"]["Links"];
|
|
25714
|
+
};
|
|
25715
|
+
UserSubscriptionPriceChanges_Relationships: {
|
|
25716
|
+
decision?: components["schemas"]["Single_Relationship_Data_Document"];
|
|
25717
|
+
};
|
|
25718
|
+
UserSubscriptionPriceChanges_Resource_Object: {
|
|
25719
|
+
attributes?: components["schemas"]["UserSubscriptionPriceChanges_Attributes"];
|
|
25720
|
+
/**
|
|
25721
|
+
* @description Resource id
|
|
25722
|
+
* @example 12345
|
|
25723
|
+
*/
|
|
25724
|
+
id: string;
|
|
25725
|
+
relationships?: components["schemas"]["UserSubscriptionPriceChanges_Relationships"];
|
|
25726
|
+
/**
|
|
25727
|
+
* @description Resource type (enum property replaced by openapi-typescript)
|
|
25728
|
+
* @enum {string}
|
|
25729
|
+
*/
|
|
25730
|
+
type: "userSubscriptionPriceChanges";
|
|
25731
|
+
};
|
|
25732
|
+
UserSubscriptionPriceChanges_Single_Relationship_Data_Document: {
|
|
25733
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
25734
|
+
included?: components["schemas"]["Included"];
|
|
25735
|
+
links: components["schemas"]["Links"];
|
|
25736
|
+
};
|
|
25737
|
+
UserSubscriptionPriceChanges_Single_Resource_Data_Document: {
|
|
25738
|
+
data: components["schemas"]["UserSubscriptionPriceChanges_Resource_Object"];
|
|
25739
|
+
included?: components["schemas"]["Included"];
|
|
25740
|
+
links: components["schemas"]["Links"];
|
|
25741
|
+
};
|
|
25042
25742
|
Users_Attributes: {
|
|
25043
25743
|
/**
|
|
25044
25744
|
* @description ISO 3166-1 alpha-2 country code
|
|
@@ -25112,7 +25812,7 @@ export interface components {
|
|
|
25112
25812
|
* @enum {string}
|
|
25113
25813
|
*/
|
|
25114
25814
|
code: "CLIENT_NOT_ENTITLED" | "CONCURRENT_PLAYBACK" | "GEO_RESTRICTED" | "PREREQUISITE_MISSING" | "PURCHASE_REQUIRED";
|
|
25115
|
-
/** @example
|
|
25815
|
+
/** @example Required playback prerequisites are missing */
|
|
25116
25816
|
detail?: string;
|
|
25117
25817
|
/** @example 403 */
|
|
25118
25818
|
status: string;
|
|
@@ -25125,7 +25825,7 @@ export interface components {
|
|
|
25125
25825
|
* @enum {string}
|
|
25126
25826
|
*/
|
|
25127
25827
|
code: "CONTENT_NOT_FOUND";
|
|
25128
|
-
/** @example
|
|
25828
|
+
/** @example Content does not exist or is no longer available */
|
|
25129
25829
|
detail?: string;
|
|
25130
25830
|
/** @example 404 */
|
|
25131
25831
|
status: string;
|
|
@@ -25262,7 +25962,7 @@ export interface components {
|
|
|
25262
25962
|
};
|
|
25263
25963
|
};
|
|
25264
25964
|
responses: {
|
|
25265
|
-
/** @description
|
|
25965
|
+
/** @description Invalid request */
|
|
25266
25966
|
Default400Response: {
|
|
25267
25967
|
headers: {
|
|
25268
25968
|
[name: string]: unknown;
|
|
@@ -25271,7 +25971,7 @@ export interface components {
|
|
|
25271
25971
|
"application/vnd.api+json": components["schemas"]["Default400ResponseBody"];
|
|
25272
25972
|
};
|
|
25273
25973
|
};
|
|
25274
|
-
/** @description
|
|
25974
|
+
/** @description Resource not found */
|
|
25275
25975
|
Default404Response: {
|
|
25276
25976
|
headers: {
|
|
25277
25977
|
[name: string]: unknown;
|
|
@@ -25280,7 +25980,7 @@ export interface components {
|
|
|
25280
25980
|
"application/vnd.api+json": components["schemas"]["Default404ResponseBody"];
|
|
25281
25981
|
};
|
|
25282
25982
|
};
|
|
25283
|
-
/** @description
|
|
25983
|
+
/** @description HTTP method not allowed */
|
|
25284
25984
|
Default405Response: {
|
|
25285
25985
|
headers: {
|
|
25286
25986
|
[name: string]: unknown;
|
|
@@ -25289,7 +25989,7 @@ export interface components {
|
|
|
25289
25989
|
"application/vnd.api+json": components["schemas"]["Default405ResponseBody"];
|
|
25290
25990
|
};
|
|
25291
25991
|
};
|
|
25292
|
-
/** @description
|
|
25992
|
+
/** @description No acceptable response media type */
|
|
25293
25993
|
Default406Response: {
|
|
25294
25994
|
headers: {
|
|
25295
25995
|
[name: string]: unknown;
|
|
@@ -25298,7 +25998,7 @@ export interface components {
|
|
|
25298
25998
|
"application/vnd.api+json": components["schemas"]["Default406ResponseBody"];
|
|
25299
25999
|
};
|
|
25300
26000
|
};
|
|
25301
|
-
/** @description Unsupported request
|
|
26001
|
+
/** @description Unsupported request media type or encoding */
|
|
25302
26002
|
Default415Response: {
|
|
25303
26003
|
headers: {
|
|
25304
26004
|
[name: string]: unknown;
|
|
@@ -25316,7 +26016,7 @@ export interface components {
|
|
|
25316
26016
|
"application/vnd.api+json": components["schemas"]["Default429ResponseBody"];
|
|
25317
26017
|
};
|
|
25318
26018
|
};
|
|
25319
|
-
/** @description
|
|
26019
|
+
/** @description Internal server error */
|
|
25320
26020
|
Default500Response: {
|
|
25321
26021
|
headers: {
|
|
25322
26022
|
[name: string]: unknown;
|
|
@@ -25325,7 +26025,7 @@ export interface components {
|
|
|
25325
26025
|
"application/vnd.api+json": components["schemas"]["Default500ResponseBody"];
|
|
25326
26026
|
};
|
|
25327
26027
|
};
|
|
25328
|
-
/** @description
|
|
26028
|
+
/** @description Service temporarily unavailable */
|
|
25329
26029
|
Default503Response: {
|
|
25330
26030
|
headers: {
|
|
25331
26031
|
[name: string]: unknown;
|
|
@@ -25334,7 +26034,7 @@ export interface components {
|
|
|
25334
26034
|
"application/vnd.api+json": components["schemas"]["Default503ResponseBody"];
|
|
25335
26035
|
};
|
|
25336
26036
|
};
|
|
25337
|
-
/** @description
|
|
26037
|
+
/** @description Request already in progress for this idempotency key */
|
|
25338
26038
|
Idempotency409Response: {
|
|
25339
26039
|
headers: {
|
|
25340
26040
|
[name: string]: unknown;
|
|
@@ -25343,7 +26043,7 @@ export interface components {
|
|
|
25343
26043
|
"application/vnd.api+json": components["schemas"]["Idempotency409ResponseBody"];
|
|
25344
26044
|
};
|
|
25345
26045
|
};
|
|
25346
|
-
/** @description Idempotency key
|
|
26046
|
+
/** @description Idempotency key reused with a different payload */
|
|
25347
26047
|
Idempotency422Response: {
|
|
25348
26048
|
headers: {
|
|
25349
26049
|
[name: string]: unknown;
|
|
@@ -25352,7 +26052,7 @@ export interface components {
|
|
|
25352
26052
|
"application/vnd.api+json": components["schemas"]["Idempotency422ResponseBody"];
|
|
25353
26053
|
};
|
|
25354
26054
|
};
|
|
25355
|
-
/** @description
|
|
26055
|
+
/** @description Square credential lacks required site scopes; run Square onboarding again; Request already in progress for this idempotency key */
|
|
25356
26056
|
SquareConnectionsUpdateSingleDataRelationship409Response: {
|
|
25357
26057
|
headers: {
|
|
25358
26058
|
[name: string]: unknown;
|
|
@@ -25361,7 +26061,7 @@ export interface components {
|
|
|
25361
26061
|
"application/vnd.api+json": components["schemas"]["SquareConnectionsUpdateSingleDataRelationship409ResponseBody"];
|
|
25362
26062
|
};
|
|
25363
26063
|
};
|
|
25364
|
-
/** @description
|
|
26064
|
+
/** @description Required playback prerequisites are missing; Content is unavailable in your location; Content must be purchased before playback; Client cannot access this content; Account is playing on another app or device */
|
|
25365
26065
|
TrackFilesReadById403Response: {
|
|
25366
26066
|
headers: {
|
|
25367
26067
|
[name: string]: unknown;
|
|
@@ -25370,7 +26070,7 @@ export interface components {
|
|
|
25370
26070
|
"application/vnd.api+json": components["schemas"]["TrackFilesReadById403ResponseBody"];
|
|
25371
26071
|
};
|
|
25372
26072
|
};
|
|
25373
|
-
/** @description
|
|
26073
|
+
/** @description Content does not exist or is no longer available */
|
|
25374
26074
|
TrackFilesReadById404Response: {
|
|
25375
26075
|
headers: {
|
|
25376
26076
|
[name: string]: unknown;
|
|
@@ -25379,7 +26079,7 @@ export interface components {
|
|
|
25379
26079
|
"application/vnd.api+json": components["schemas"]["TrackFilesReadById404ResponseBody"];
|
|
25380
26080
|
};
|
|
25381
26081
|
};
|
|
25382
|
-
/** @description
|
|
26082
|
+
/** @description Required playback prerequisites are missing; Content is unavailable in your location; Content must be purchased before playback; Client cannot access this content; Account is playing on another app or device */
|
|
25383
26083
|
TrackManifestsReadById403Response: {
|
|
25384
26084
|
headers: {
|
|
25385
26085
|
[name: string]: unknown;
|
|
@@ -25388,7 +26088,7 @@ export interface components {
|
|
|
25388
26088
|
"application/vnd.api+json": components["schemas"]["TrackManifestsReadById403ResponseBody"];
|
|
25389
26089
|
};
|
|
25390
26090
|
};
|
|
25391
|
-
/** @description
|
|
26091
|
+
/** @description Content does not exist or is no longer available */
|
|
25392
26092
|
TrackManifestsReadById404Response: {
|
|
25393
26093
|
headers: {
|
|
25394
26094
|
[name: string]: unknown;
|
|
@@ -25397,7 +26097,7 @@ export interface components {
|
|
|
25397
26097
|
"application/vnd.api+json": components["schemas"]["TrackManifestsReadById404ResponseBody"];
|
|
25398
26098
|
};
|
|
25399
26099
|
};
|
|
25400
|
-
/** @description
|
|
26100
|
+
/** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */
|
|
25401
26101
|
UserCollectionAlbumsAddMultiDataRelationshipWithResponse409Response: {
|
|
25402
26102
|
headers: {
|
|
25403
26103
|
[name: string]: unknown;
|
|
@@ -25406,7 +26106,7 @@ export interface components {
|
|
|
25406
26106
|
"application/vnd.api+json": components["schemas"]["UserCollectionAlbumsAddMultiDataRelationshipWithResponse409ResponseBody"];
|
|
25407
26107
|
};
|
|
25408
26108
|
};
|
|
25409
|
-
/** @description
|
|
26109
|
+
/** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */
|
|
25410
26110
|
UserCollectionArtistsAddMultiDataRelationshipWithResponse409Response: {
|
|
25411
26111
|
headers: {
|
|
25412
26112
|
[name: string]: unknown;
|
|
@@ -25415,7 +26115,7 @@ export interface components {
|
|
|
25415
26115
|
"application/vnd.api+json": components["schemas"]["UserCollectionArtistsAddMultiDataRelationshipWithResponse409ResponseBody"];
|
|
25416
26116
|
};
|
|
25417
26117
|
};
|
|
25418
|
-
/** @description
|
|
26118
|
+
/** @description Folder must be empty and owned by you */
|
|
25419
26119
|
UserCollectionFoldersDeleteResource400Response: {
|
|
25420
26120
|
headers: {
|
|
25421
26121
|
[name: string]: unknown;
|
|
@@ -25424,7 +26124,7 @@ export interface components {
|
|
|
25424
26124
|
"application/vnd.api+json": components["schemas"]["UserCollectionFoldersDeleteResource400ResponseBody"];
|
|
25425
26125
|
};
|
|
25426
26126
|
};
|
|
25427
|
-
/** @description
|
|
26127
|
+
/** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */
|
|
25428
26128
|
UserCollectionPlaylistsAddMultiDataRelationshipWithResponse409Response: {
|
|
25429
26129
|
headers: {
|
|
25430
26130
|
[name: string]: unknown;
|
|
@@ -25433,7 +26133,7 @@ export interface components {
|
|
|
25433
26133
|
"application/vnd.api+json": components["schemas"]["UserCollectionPlaylistsAddMultiDataRelationshipWithResponse409ResponseBody"];
|
|
25434
26134
|
};
|
|
25435
26135
|
};
|
|
25436
|
-
/** @description
|
|
26136
|
+
/** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */
|
|
25437
26137
|
UserCollectionSaveForLatersAddMultiDataRelationshipWithResponse409Response: {
|
|
25438
26138
|
headers: {
|
|
25439
26139
|
[name: string]: unknown;
|
|
@@ -25442,7 +26142,7 @@ export interface components {
|
|
|
25442
26142
|
"application/vnd.api+json": components["schemas"]["UserCollectionSaveForLatersAddMultiDataRelationshipWithResponse409ResponseBody"];
|
|
25443
26143
|
};
|
|
25444
26144
|
};
|
|
25445
|
-
/** @description
|
|
26145
|
+
/** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */
|
|
25446
26146
|
UserCollectionTracksAddMultiDataRelationshipWithResponse409Response: {
|
|
25447
26147
|
headers: {
|
|
25448
26148
|
[name: string]: unknown;
|
|
@@ -25451,7 +26151,7 @@ export interface components {
|
|
|
25451
26151
|
"application/vnd.api+json": components["schemas"]["UserCollectionTracksAddMultiDataRelationshipWithResponse409ResponseBody"];
|
|
25452
26152
|
};
|
|
25453
26153
|
};
|
|
25454
|
-
/** @description
|
|
26154
|
+
/** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */
|
|
25455
26155
|
UserCollectionVideosAddMultiDataRelationshipWithResponse409Response: {
|
|
25456
26156
|
headers: {
|
|
25457
26157
|
[name: string]: unknown;
|
|
@@ -25460,7 +26160,7 @@ export interface components {
|
|
|
25460
26160
|
"application/vnd.api+json": components["schemas"]["UserCollectionVideosAddMultiDataRelationshipWithResponse409ResponseBody"];
|
|
25461
26161
|
};
|
|
25462
26162
|
};
|
|
25463
|
-
/** @description
|
|
26163
|
+
/** @description Collection item limit reached; Collection already contains one or more items; Request already in progress for this idempotency key */
|
|
25464
26164
|
UserCollectionsAddMultiDataRelationship409Response: {
|
|
25465
26165
|
headers: {
|
|
25466
26166
|
[name: string]: unknown;
|
|
@@ -25469,7 +26169,7 @@ export interface components {
|
|
|
25469
26169
|
"application/vnd.api+json": components["schemas"]["UserCollectionsAddMultiDataRelationship409ResponseBody"];
|
|
25470
26170
|
};
|
|
25471
26171
|
};
|
|
25472
|
-
/** @description
|
|
26172
|
+
/** @description Recommendation block limit reached; Request already in progress for this idempotency key */
|
|
25473
26173
|
UserRecommendationBlocksAddMultiDataRelationshipWithResponse409Response: {
|
|
25474
26174
|
headers: {
|
|
25475
26175
|
[name: string]: unknown;
|
|
@@ -25478,7 +26178,7 @@ export interface components {
|
|
|
25478
26178
|
"application/vnd.api+json": components["schemas"]["UserRecommendationBlocksAddMultiDataRelationshipWithResponse409ResponseBody"];
|
|
25479
26179
|
};
|
|
25480
26180
|
};
|
|
25481
|
-
/** @description
|
|
26181
|
+
/** @description Required playback prerequisites are missing; Content is unavailable in your location; Content must be purchased before playback; Client cannot access this content; Account is playing on another app or device */
|
|
25482
26182
|
VideoManifestsReadById403Response: {
|
|
25483
26183
|
headers: {
|
|
25484
26184
|
[name: string]: unknown;
|
|
@@ -25487,7 +26187,7 @@ export interface components {
|
|
|
25487
26187
|
"application/vnd.api+json": components["schemas"]["VideoManifestsReadById403ResponseBody"];
|
|
25488
26188
|
};
|
|
25489
26189
|
};
|
|
25490
|
-
/** @description
|
|
26190
|
+
/** @description Content does not exist or is no longer available */
|
|
25491
26191
|
VideoManifestsReadById404Response: {
|
|
25492
26192
|
headers: {
|
|
25493
26193
|
[name: string]: unknown;
|