@tidal-music/api 0.34.0 → 0.35.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 +390 -47
- package/package.json +1 -1
|
@@ -7856,7 +7856,7 @@ export interface paths {
|
|
|
7856
7856
|
*/
|
|
7857
7857
|
countryCode?: string;
|
|
7858
7858
|
/**
|
|
7859
|
-
* @description Allows the client to customize which related resources should be returned. Available options: collaboratorProfiles, collaborators, coverArt, items, ownerProfiles, owners
|
|
7859
|
+
* @description Allows the client to customize which related resources should be returned. Available options: collaboratorProfiles, collaborators, coverArt, items, ownerProfiles, owners, suggestedCoverArts
|
|
7860
7860
|
* @example collaboratorProfiles
|
|
7861
7861
|
*/
|
|
7862
7862
|
include?: string[];
|
|
@@ -7964,7 +7964,7 @@ export interface paths {
|
|
|
7964
7964
|
*/
|
|
7965
7965
|
countryCode?: string;
|
|
7966
7966
|
/**
|
|
7967
|
-
* @description Allows the client to customize which related resources should be returned. Available options: collaboratorProfiles, collaborators, coverArt, items, ownerProfiles, owners
|
|
7967
|
+
* @description Allows the client to customize which related resources should be returned. Available options: collaboratorProfiles, collaborators, coverArt, items, ownerProfiles, owners, suggestedCoverArts
|
|
7968
7968
|
* @example collaboratorProfiles
|
|
7969
7969
|
*/
|
|
7970
7970
|
include?: string[];
|
|
@@ -8719,6 +8719,67 @@ export interface paths {
|
|
|
8719
8719
|
patch?: never;
|
|
8720
8720
|
trace?: never;
|
|
8721
8721
|
};
|
|
8722
|
+
"/playlists/{id}/relationships/suggestedCoverArts": {
|
|
8723
|
+
parameters: {
|
|
8724
|
+
query?: never;
|
|
8725
|
+
header?: never;
|
|
8726
|
+
path?: never;
|
|
8727
|
+
cookie?: never;
|
|
8728
|
+
};
|
|
8729
|
+
/**
|
|
8730
|
+
* Get suggestedCoverArts relationship ("to-many").
|
|
8731
|
+
* @description Retrieves suggestedCoverArts relationship.
|
|
8732
|
+
*/
|
|
8733
|
+
get: {
|
|
8734
|
+
parameters: {
|
|
8735
|
+
query?: {
|
|
8736
|
+
/**
|
|
8737
|
+
* @description Allows the client to customize which related resources should be returned. Available options: suggestedCoverArts
|
|
8738
|
+
* @example suggestedCoverArts
|
|
8739
|
+
*/
|
|
8740
|
+
include?: string[];
|
|
8741
|
+
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
8742
|
+
"page[cursor]"?: string;
|
|
8743
|
+
};
|
|
8744
|
+
header?: never;
|
|
8745
|
+
path: {
|
|
8746
|
+
/**
|
|
8747
|
+
* @description Playlist id
|
|
8748
|
+
* @example 550e8400-e29b-41d4-a716-446655440000
|
|
8749
|
+
*/
|
|
8750
|
+
id: string;
|
|
8751
|
+
};
|
|
8752
|
+
cookie?: never;
|
|
8753
|
+
};
|
|
8754
|
+
requestBody?: never;
|
|
8755
|
+
responses: {
|
|
8756
|
+
/** @description Successful response */
|
|
8757
|
+
200: {
|
|
8758
|
+
headers: {
|
|
8759
|
+
[name: string]: unknown;
|
|
8760
|
+
};
|
|
8761
|
+
content: {
|
|
8762
|
+
"application/vnd.api+json": components["schemas"]["Playlists_SuggestedCoverArts_Multi_Relationship_Data_Document"];
|
|
8763
|
+
};
|
|
8764
|
+
};
|
|
8765
|
+
400: components["responses"]["Default400Response"];
|
|
8766
|
+
404: components["responses"]["Default404Response"];
|
|
8767
|
+
405: components["responses"]["Default405Response"];
|
|
8768
|
+
406: components["responses"]["Default406Response"];
|
|
8769
|
+
415: components["responses"]["Default415Response"];
|
|
8770
|
+
429: components["responses"]["Default429Response"];
|
|
8771
|
+
500: components["responses"]["Default500Response"];
|
|
8772
|
+
503: components["responses"]["Default503Response"];
|
|
8773
|
+
};
|
|
8774
|
+
};
|
|
8775
|
+
put?: never;
|
|
8776
|
+
post?: never;
|
|
8777
|
+
delete?: never;
|
|
8778
|
+
options?: never;
|
|
8779
|
+
head?: never;
|
|
8780
|
+
patch?: never;
|
|
8781
|
+
trace?: never;
|
|
8782
|
+
};
|
|
8722
8783
|
"/priceConfigurations": {
|
|
8723
8784
|
parameters: {
|
|
8724
8785
|
query?: never;
|
|
@@ -10932,7 +10993,13 @@ export interface paths {
|
|
|
10932
10993
|
*/
|
|
10933
10994
|
get: {
|
|
10934
10995
|
parameters: {
|
|
10935
|
-
query?:
|
|
10996
|
+
query?: {
|
|
10997
|
+
/**
|
|
10998
|
+
* @description Allows the client to customize which related resources should be returned. Available options: selectedSite, sites
|
|
10999
|
+
* @example selectedSite
|
|
11000
|
+
*/
|
|
11001
|
+
include?: string[];
|
|
11002
|
+
};
|
|
10936
11003
|
header?: never;
|
|
10937
11004
|
path: {
|
|
10938
11005
|
/**
|
|
@@ -10972,6 +11039,172 @@ export interface paths {
|
|
|
10972
11039
|
patch?: never;
|
|
10973
11040
|
trace?: never;
|
|
10974
11041
|
};
|
|
11042
|
+
"/squareConnections/{id}/relationships/selectedSite": {
|
|
11043
|
+
parameters: {
|
|
11044
|
+
query?: never;
|
|
11045
|
+
header?: never;
|
|
11046
|
+
path?: never;
|
|
11047
|
+
cookie?: never;
|
|
11048
|
+
};
|
|
11049
|
+
/**
|
|
11050
|
+
* Get selectedSite relationship ("to-one").
|
|
11051
|
+
* @description Retrieves selectedSite relationship.
|
|
11052
|
+
*/
|
|
11053
|
+
get: {
|
|
11054
|
+
parameters: {
|
|
11055
|
+
query?: {
|
|
11056
|
+
/**
|
|
11057
|
+
* @description Allows the client to customize which related resources should be returned. Available options: selectedSite
|
|
11058
|
+
* @example selectedSite
|
|
11059
|
+
*/
|
|
11060
|
+
include?: string[];
|
|
11061
|
+
};
|
|
11062
|
+
header?: never;
|
|
11063
|
+
path: {
|
|
11064
|
+
/**
|
|
11065
|
+
* @description Square connection id. Use `me` for the authenticated user's resource
|
|
11066
|
+
* @example me
|
|
11067
|
+
*/
|
|
11068
|
+
id: string;
|
|
11069
|
+
};
|
|
11070
|
+
cookie?: never;
|
|
11071
|
+
};
|
|
11072
|
+
requestBody?: never;
|
|
11073
|
+
responses: {
|
|
11074
|
+
/** @description Successful response */
|
|
11075
|
+
200: {
|
|
11076
|
+
headers: {
|
|
11077
|
+
[name: string]: unknown;
|
|
11078
|
+
};
|
|
11079
|
+
content: {
|
|
11080
|
+
"application/vnd.api+json": components["schemas"]["SquareConnections_Single_Relationship_Data_Document"];
|
|
11081
|
+
};
|
|
11082
|
+
};
|
|
11083
|
+
400: components["responses"]["Default400Response"];
|
|
11084
|
+
404: components["responses"]["Default404Response"];
|
|
11085
|
+
405: components["responses"]["Default405Response"];
|
|
11086
|
+
406: components["responses"]["Default406Response"];
|
|
11087
|
+
415: components["responses"]["Default415Response"];
|
|
11088
|
+
429: components["responses"]["Default429Response"];
|
|
11089
|
+
500: components["responses"]["Default500Response"];
|
|
11090
|
+
503: components["responses"]["Default503Response"];
|
|
11091
|
+
};
|
|
11092
|
+
};
|
|
11093
|
+
put?: never;
|
|
11094
|
+
post?: never;
|
|
11095
|
+
delete?: never;
|
|
11096
|
+
options?: never;
|
|
11097
|
+
head?: never;
|
|
11098
|
+
/**
|
|
11099
|
+
* Update selectedSite relationship ("to-one").
|
|
11100
|
+
* @description Updates selectedSite relationship.
|
|
11101
|
+
*/
|
|
11102
|
+
patch: {
|
|
11103
|
+
parameters: {
|
|
11104
|
+
query?: never;
|
|
11105
|
+
header?: {
|
|
11106
|
+
/** @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. */
|
|
11107
|
+
"Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
|
|
11108
|
+
};
|
|
11109
|
+
path: {
|
|
11110
|
+
/**
|
|
11111
|
+
* @description Square connection id. Use `me` for the authenticated user's resource
|
|
11112
|
+
* @example me
|
|
11113
|
+
*/
|
|
11114
|
+
id: string;
|
|
11115
|
+
};
|
|
11116
|
+
cookie?: never;
|
|
11117
|
+
};
|
|
11118
|
+
requestBody?: {
|
|
11119
|
+
content: {
|
|
11120
|
+
"application/vnd.api+json": components["schemas"]["SquareConnectionsSelectedSiteRelationshipUpdateOperation_Payload"];
|
|
11121
|
+
};
|
|
11122
|
+
};
|
|
11123
|
+
responses: {
|
|
11124
|
+
/** @description Successful response */
|
|
11125
|
+
200: {
|
|
11126
|
+
headers: {
|
|
11127
|
+
[name: string]: unknown;
|
|
11128
|
+
};
|
|
11129
|
+
content: {
|
|
11130
|
+
"application/vnd.api+json": components["schemas"]["SquareConnections_Single_Relationship_Data_Document"];
|
|
11131
|
+
};
|
|
11132
|
+
};
|
|
11133
|
+
400: components["responses"]["Default400Response"];
|
|
11134
|
+
404: components["responses"]["Default404Response"];
|
|
11135
|
+
405: components["responses"]["Default405Response"];
|
|
11136
|
+
406: components["responses"]["Default406Response"];
|
|
11137
|
+
409: components["responses"]["SquareConnectionsUpdateSingleDataRelationship409Response"];
|
|
11138
|
+
415: components["responses"]["Default415Response"];
|
|
11139
|
+
422: components["responses"]["Idempotency422Response"];
|
|
11140
|
+
429: components["responses"]["Default429Response"];
|
|
11141
|
+
500: components["responses"]["Default500Response"];
|
|
11142
|
+
503: components["responses"]["Default503Response"];
|
|
11143
|
+
};
|
|
11144
|
+
};
|
|
11145
|
+
trace?: never;
|
|
11146
|
+
};
|
|
11147
|
+
"/squareConnections/{id}/relationships/sites": {
|
|
11148
|
+
parameters: {
|
|
11149
|
+
query?: never;
|
|
11150
|
+
header?: never;
|
|
11151
|
+
path?: never;
|
|
11152
|
+
cookie?: never;
|
|
11153
|
+
};
|
|
11154
|
+
/**
|
|
11155
|
+
* Get sites relationship ("to-many").
|
|
11156
|
+
* @description Retrieves sites relationship.
|
|
11157
|
+
*/
|
|
11158
|
+
get: {
|
|
11159
|
+
parameters: {
|
|
11160
|
+
query?: {
|
|
11161
|
+
/**
|
|
11162
|
+
* @description Allows the client to customize which related resources should be returned. Available options: sites
|
|
11163
|
+
* @example sites
|
|
11164
|
+
*/
|
|
11165
|
+
include?: string[];
|
|
11166
|
+
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
11167
|
+
"page[cursor]"?: string;
|
|
11168
|
+
};
|
|
11169
|
+
header?: never;
|
|
11170
|
+
path: {
|
|
11171
|
+
/**
|
|
11172
|
+
* @description Square connection id. Use `me` for the authenticated user's resource
|
|
11173
|
+
* @example me
|
|
11174
|
+
*/
|
|
11175
|
+
id: string;
|
|
11176
|
+
};
|
|
11177
|
+
cookie?: never;
|
|
11178
|
+
};
|
|
11179
|
+
requestBody?: never;
|
|
11180
|
+
responses: {
|
|
11181
|
+
/** @description Successful response */
|
|
11182
|
+
200: {
|
|
11183
|
+
headers: {
|
|
11184
|
+
[name: string]: unknown;
|
|
11185
|
+
};
|
|
11186
|
+
content: {
|
|
11187
|
+
"application/vnd.api+json": components["schemas"]["SquareConnections_Multi_Relationship_Data_Document"];
|
|
11188
|
+
};
|
|
11189
|
+
};
|
|
11190
|
+
400: components["responses"]["Default400Response"];
|
|
11191
|
+
404: components["responses"]["Default404Response"];
|
|
11192
|
+
405: components["responses"]["Default405Response"];
|
|
11193
|
+
406: components["responses"]["Default406Response"];
|
|
11194
|
+
415: components["responses"]["Default415Response"];
|
|
11195
|
+
429: components["responses"]["Default429Response"];
|
|
11196
|
+
500: components["responses"]["Default500Response"];
|
|
11197
|
+
503: components["responses"]["Default503Response"];
|
|
11198
|
+
};
|
|
11199
|
+
};
|
|
11200
|
+
put?: never;
|
|
11201
|
+
post?: never;
|
|
11202
|
+
delete?: never;
|
|
11203
|
+
options?: never;
|
|
11204
|
+
head?: never;
|
|
11205
|
+
patch?: never;
|
|
11206
|
+
trace?: never;
|
|
11207
|
+
};
|
|
10975
11208
|
"/stripeConnections": {
|
|
10976
11209
|
parameters: {
|
|
10977
11210
|
query?: never;
|
|
@@ -18927,7 +19160,7 @@ export interface components {
|
|
|
18927
19160
|
type: "acceptedTerms";
|
|
18928
19161
|
};
|
|
18929
19162
|
AcceptedTerms_Single_Relationship_Data_Document: {
|
|
18930
|
-
data?: components["schemas"]["Resource_Identifier"];
|
|
19163
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
18931
19164
|
included?: components["schemas"]["Included"];
|
|
18932
19165
|
links: components["schemas"]["Links"];
|
|
18933
19166
|
};
|
|
@@ -19260,7 +19493,7 @@ export interface components {
|
|
|
19260
19493
|
type: "albums";
|
|
19261
19494
|
};
|
|
19262
19495
|
Albums_Single_Relationship_Data_Document: {
|
|
19263
|
-
data?: components["schemas"]["Resource_Identifier"];
|
|
19496
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
19264
19497
|
included?: components["schemas"]["Included"];
|
|
19265
19498
|
links: components["schemas"]["Links"];
|
|
19266
19499
|
};
|
|
@@ -19766,7 +19999,7 @@ export interface components {
|
|
|
19766
19999
|
type: "artists";
|
|
19767
20000
|
};
|
|
19768
20001
|
Artists_Single_Relationship_Data_Document: {
|
|
19769
|
-
data?: components["schemas"]["Resource_Identifier"];
|
|
20002
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
19770
20003
|
included?: components["schemas"]["Included"];
|
|
19771
20004
|
links: components["schemas"]["Links"];
|
|
19772
20005
|
};
|
|
@@ -19805,7 +20038,7 @@ export interface components {
|
|
|
19805
20038
|
Artwork_File: {
|
|
19806
20039
|
/** @description Artwork file href */
|
|
19807
20040
|
href: string;
|
|
19808
|
-
meta
|
|
20041
|
+
meta: components["schemas"]["Artwork_File_Meta"];
|
|
19809
20042
|
};
|
|
19810
20043
|
/** @description Metadata about an artwork file */
|
|
19811
20044
|
Artwork_File_Meta: {
|
|
@@ -20097,7 +20330,7 @@ export interface components {
|
|
|
20097
20330
|
type: "collaborationInvites";
|
|
20098
20331
|
};
|
|
20099
20332
|
CollaborationInvites_Single_Relationship_Data_Document: {
|
|
20100
|
-
data?: components["schemas"]["Resource_Identifier"];
|
|
20333
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
20101
20334
|
included?: components["schemas"]["Included"];
|
|
20102
20335
|
links: components["schemas"]["Links"];
|
|
20103
20336
|
};
|
|
@@ -20125,7 +20358,7 @@ export interface components {
|
|
|
20125
20358
|
subject: components["schemas"]["CommentsCreateOperation_Payload_Data_Relationships_Subject"];
|
|
20126
20359
|
};
|
|
20127
20360
|
CommentsCreateOperation_Payload_Data_Relationships_ParentComment: {
|
|
20128
|
-
data
|
|
20361
|
+
data: components["schemas"]["CommentsCreateOperation_Payload_Data_Relationships_ParentComment_Data"] | (never | null);
|
|
20129
20362
|
};
|
|
20130
20363
|
CommentsCreateOperation_Payload_Data_Relationships_ParentComment_Data: {
|
|
20131
20364
|
id: string;
|
|
@@ -20225,7 +20458,7 @@ export interface components {
|
|
|
20225
20458
|
type: "comments";
|
|
20226
20459
|
};
|
|
20227
20460
|
Comments_Single_Relationship_Data_Document: {
|
|
20228
|
-
data?: components["schemas"]["Resource_Identifier"];
|
|
20461
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
20229
20462
|
included?: components["schemas"]["Included"];
|
|
20230
20463
|
links: components["schemas"]["Links"];
|
|
20231
20464
|
};
|
|
@@ -20319,7 +20552,7 @@ export interface components {
|
|
|
20319
20552
|
type: "contentClaims";
|
|
20320
20553
|
};
|
|
20321
20554
|
ContentClaims_Single_Relationship_Data_Document: {
|
|
20322
|
-
data?: components["schemas"]["Resource_Identifier"];
|
|
20555
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
20323
20556
|
included?: components["schemas"]["Included"];
|
|
20324
20557
|
links: components["schemas"]["Links"];
|
|
20325
20558
|
};
|
|
@@ -20368,7 +20601,7 @@ export interface components {
|
|
|
20368
20601
|
type: "credits";
|
|
20369
20602
|
};
|
|
20370
20603
|
Credits_Single_Relationship_Data_Document: {
|
|
20371
|
-
data?: components["schemas"]["Resource_Identifier"];
|
|
20604
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
20372
20605
|
included?: components["schemas"]["Included"];
|
|
20373
20606
|
links: components["schemas"]["Links"];
|
|
20374
20607
|
};
|
|
@@ -20535,7 +20768,7 @@ export interface components {
|
|
|
20535
20768
|
type: "dspSharingLinks";
|
|
20536
20769
|
};
|
|
20537
20770
|
DspSharingLinks_Single_Relationship_Data_Document: {
|
|
20538
|
-
data?: components["schemas"]["Resource_Identifier"];
|
|
20771
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
20539
20772
|
included?: components["schemas"]["Included"];
|
|
20540
20773
|
links: components["schemas"]["Links"];
|
|
20541
20774
|
};
|
|
@@ -20550,18 +20783,12 @@ export interface components {
|
|
|
20550
20783
|
* @example SPOTLIGHT_INFO
|
|
20551
20784
|
*/
|
|
20552
20785
|
icons: ("SPOTLIGHT_INFO" | "UNKNOWN")[];
|
|
20553
|
-
/**
|
|
20554
|
-
* @description Semantic kind of the module, describing its product purpose and expected item domain.
|
|
20555
|
-
* @example ALBUM_RELATED_ALBUMS
|
|
20556
|
-
* @enum {string}
|
|
20557
|
-
*/
|
|
20558
|
-
moduleKind: "ALBUM_RECOMMENDATIONS" | "BECAUSE_YOU_LISTENED_TO_ALBUM" | "BECAUSE_YOU_ADDED_ALBUM" | "BECAUSE_YOU_ADDED_ARTIST" | "CONTINUE_LISTEN_TO" | "DAILY_MIXES" | "FORGOTTEN_FAVORITES" | "GENRE_MIXES" | "HISTORY_MIXES" | "LOCAL_PLAYLISTS" | "MY_PLAYLISTS" | "NEW_ALBUM_SUGGESTIONS" | "NEW_TRACK_SUGGESTIONS" | "NEW_ALBUMS" | "NEW_TRACKS" | "POPULAR_PLAYLISTS" | "RECENTLY_UPDATED_FAVORITED_PLAYLIST" | "RECOMMENDED_USERS_PLAYLISTS" | "SUGGESTED_ESSENTIAL_PLAYLISTS" | "SUGGESTED_RADIOS_MIXES" | "WELCOME_MIX" | "YOUR_FAVORITE_ARTISTS" | "UPLOADS_FOR_YOU" | "LATEST_SPOTLIGHTED_TRACKS" | "SHORTCUTS" | "ARTIST_TOP_TRACKS" | "ARTIST_SPOTLIGHTED_TRACKS" | "ARTIST_ALBUMS" | "ARTIST_TOP_SINGLES" | "ARTIST_COMPILATIONS" | "ARTIST_LIVE_ALBUMS" | "ARTIST_APPEARS_ON" | "ARTIST_PLAYLIST" | "ARTIST_PUBLIC_PLAYLIST" | "ARTIST_SIMILAR_ARTISTS" | "ARTIST_TRACK_UPLOADS" | "ARTIST_LINKS" | "ARTIST_VIDEOS" | "ARTIST_CREDITS" | "ARTIST_DISCOGRAPHY" | "ALBUM_ITEMS" | "ALBUM_MORE_BY_ARTIST" | "ALBUM_OTHER_VERSIONS" | "ALBUM_RELATED_ALBUMS" | "ALBUM_RELATED_ARTISTS" | "COLLECTION_ITEMS" | "ALBUM_ANNIVERSARY" | "ARTIST_BIRTHDAY" | "ARTIST_MEMORIAM" | "DJ_TOOLS" | "DJ_ARTIST_CURATED" | "THE_HITS" | "FROM_OUR_EDITORS" | "TOP_PLAYLISTS" | "FEATURED_TOP_TRACKS" | "FEATURED_TOP_ALBUMS" | "TOP_ARTISTS_ESSENTIALS" | "FEATURED_RECOMMENDED_PLAYLISTS" | "HOME_3_FEATURED_PLAYLISTS" | "HOME_3_FEATURED_UPLOAD_TRACKS" | "HOME_3_FEATURED_ALBUMS" | "POPULAR_ALBUMS" | "POPULAR_ARTISTS" | "POPULAR_MIXES" | "FEATURED_RECOMMENDED_TRACKS" | "FEATURED_RECOMMENDED_ALBUMS" | "FEATURED_RECOMMENDED_CLASSIC_ALBUMS" | "BACK_TO_SCHOOL_MUSIC_101" | "BACK_TO_SCHOOL_GENRES_FOR_BEGINNERS" | "HEADLINERS_2026" | "HOME_3_0_GENERIC_PLAYLISTS_1" | "HOME_3_0_GENERIC_PLAYLISTS_2" | "HOME_3_0_GENERIC_ALBUMS_1" | "HOME_3_0_GENERIC_TRACKS_1" | "HOME_3_0_GENERIC_ARTISTS_1" | "HOME_3_0_GENERIC_VIDEOS_1" | "STAFF_PICKS_PAGE_ALBUMS_WE_LOVE" | "STAFF_PICKS_PAGE_EXPLORE" | "STAFF_PICKS_PAGE_FAVORITE_SONGS" | "STAFF_PICKS_PAGE_RECENTLY_UPDATED_PLAYLISTS" | "STAFF_PICKS_PAGE_TIDAL_NEWS_MAGAZINE" | "STAFF_PICKS_PAGE_WHAT_LISTENING_TO" | "BASED_ON_YOUR_INTERESTS_1" | "BASED_ON_YOUR_INTERESTS_2" | "UPLOAD_PAGE_SPOTLIGHTED_PLAYLISTS" | "UPLOAD_PAGE_PAYGATED_ALBUMS" | "UPLOAD_PAGE_ALBUMS" | "TOP_UPLOADERS" | "UPLOAD_PAGE_ARTISTS" | "UPLOAD_PAGE_FEATURED_MAGAZINE" | "EXPLORE_DECADES" | "EXPLORE_GENRES" | "EXPLORE_MOODS" | "ARTIST_POPULAR_RELEASES" | "PURCHASES_FOR_YOU" | "UNKNOWN";
|
|
20559
20786
|
/**
|
|
20560
20787
|
* @description Presentation used when rendering the module preview on a dynamic page.
|
|
20561
20788
|
* @example HORIZONTAL_LIST
|
|
20562
20789
|
* @enum {string}
|
|
20563
20790
|
*/
|
|
20564
|
-
previewPresentation: "ARTIST_LIST" | "COMPACT_GRID_CARD" | "COMPACT_HORIZONTAL_LIST" | "COMPACT_HORIZONTAL_LIST_WITH_CONTEXT" | "FEATURED_CARD" | "GRID_CARD" | "GRID_CARD_WITH_CONTEXT" | "GRID_HIGHLIGHT_CARD" | "ANNIVERSARY_CARD" | "ARTIST_BIRTHDAY_CARD" | "ARTIST_MEMORIAM_CARD" | "ARTIST_TRACK_CREDITS_CARD" | "PILL_LIST" | "VERTICAL_LIST" | "DISCOGRAPHY_TABS" | "MAGAZINE_LIST" | "HORIZONTAL_LIST" | "HORIZONTAL_LIST_WITH_CONTEXT" | "SHORTCUT_LIST" | "TRACK_LIST" | "VERTICAL_LIST_CARD" | "TEXT_CARD" | "LINKS_LIST" | "PUBLIC_PLAYLIST_LIST";
|
|
20791
|
+
previewPresentation: "ARTIST_LIST" | "COMPACT_GRID_CARD" | "COMPACT_HORIZONTAL_LIST" | "COMPACT_HORIZONTAL_LIST_WITH_CONTEXT" | "FEATURED_CARD" | "GRID_CARD" | "GRID_CARD_WITH_CONTEXT" | "GRID_HIGHLIGHT_CARD" | "ANNIVERSARY_CARD" | "ARTIST_BIRTHDAY_CARD" | "ARTIST_MEMORIAM_CARD" | "ARTIST_TRACK_CREDITS_CARD" | "PILL_LIST" | "VERTICAL_LIST" | "DISCOGRAPHY_TABS" | "MAGAZINE_LIST" | "HORIZONTAL_LIST" | "HORIZONTAL_LIST_WITH_CONTEXT" | "SHORTCUT_LIST" | "TRACK_LIST" | "VERTICAL_LIST_CARD" | "TEXT_CARD" | "LINKS_LIST" | "PUBLIC_PLAYLIST_LIST" | "UNKNOWN";
|
|
20565
20792
|
/**
|
|
20566
20793
|
* @description Subtitle of the module
|
|
20567
20794
|
* @example Short description of this module
|
|
@@ -20662,7 +20889,7 @@ export interface components {
|
|
|
20662
20889
|
redactionReason?: "NO_BIRTHDAY" | "MINOR";
|
|
20663
20890
|
};
|
|
20664
20891
|
DynamicPages_Single_Relationship_Data_Document: {
|
|
20665
|
-
data?: components["schemas"]["Resource_Identifier"];
|
|
20892
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
20666
20893
|
included?: components["schemas"]["Included"];
|
|
20667
20894
|
links: components["schemas"]["Links"];
|
|
20668
20895
|
};
|
|
@@ -20719,6 +20946,11 @@ export interface components {
|
|
|
20719
20946
|
};
|
|
20720
20947
|
/** @description File status */
|
|
20721
20948
|
File_Status: {
|
|
20949
|
+
/**
|
|
20950
|
+
* @description Status of scanning the file for being AI-generated. Only present for file types that support AI scanning (e.g. track source files) and when a scanning status is available for the file; absent otherwise.
|
|
20951
|
+
* @enum {string}
|
|
20952
|
+
*/
|
|
20953
|
+
aiScanningFileStatus?: "NOT_SCANNED" | "SCANNING" | "IS_AI" | "NOT_AI" | "ERROR";
|
|
20722
20954
|
/**
|
|
20723
20955
|
* @description Moderation status for file
|
|
20724
20956
|
* @enum {string}
|
|
@@ -20807,7 +21039,7 @@ export interface components {
|
|
|
20807
21039
|
status: string;
|
|
20808
21040
|
}[];
|
|
20809
21041
|
};
|
|
20810
|
-
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"]["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"])[];
|
|
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"])[];
|
|
20811
21043
|
InstallationsCreateOperation_Payload: {
|
|
20812
21044
|
data: components["schemas"]["InstallationsCreateOperation_Payload_Data"];
|
|
20813
21045
|
};
|
|
@@ -21024,7 +21256,7 @@ export interface components {
|
|
|
21024
21256
|
type: "lyrics";
|
|
21025
21257
|
};
|
|
21026
21258
|
Lyrics_Single_Relationship_Data_Document: {
|
|
21027
|
-
data?: components["schemas"]["Resource_Identifier"];
|
|
21259
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
21028
21260
|
included?: components["schemas"]["Included"];
|
|
21029
21261
|
links: components["schemas"]["Links"];
|
|
21030
21262
|
};
|
|
@@ -21206,7 +21438,7 @@ export interface components {
|
|
|
21206
21438
|
type: "offlineTasks";
|
|
21207
21439
|
};
|
|
21208
21440
|
OfflineTasks_Single_Relationship_Data_Document: {
|
|
21209
|
-
data?: components["schemas"]["Resource_Identifier"];
|
|
21441
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
21210
21442
|
included?: components["schemas"]["Included"];
|
|
21211
21443
|
links: components["schemas"]["Links"];
|
|
21212
21444
|
};
|
|
@@ -21295,6 +21527,8 @@ export interface components {
|
|
|
21295
21527
|
PlayQueuesUpdateOperation_Payload_Data_Attributes: {
|
|
21296
21528
|
/** @enum {string} */
|
|
21297
21529
|
repeat?: "NONE" | "ONE" | "BATCH";
|
|
21530
|
+
/** @enum {string} */
|
|
21531
|
+
shuffle?: "OFF" | "BATCH" | "ALL";
|
|
21298
21532
|
shuffled?: boolean;
|
|
21299
21533
|
};
|
|
21300
21534
|
PlayQueues_Attributes: {
|
|
@@ -21313,6 +21547,11 @@ export interface components {
|
|
|
21313
21547
|
* @enum {string}
|
|
21314
21548
|
*/
|
|
21315
21549
|
repeat: "NONE" | "ONE" | "BATCH";
|
|
21550
|
+
/**
|
|
21551
|
+
* @description Queue's shuffle mode
|
|
21552
|
+
* @enum {string}
|
|
21553
|
+
*/
|
|
21554
|
+
shuffle: "OFF" | "BATCH" | "ALL";
|
|
21316
21555
|
/** @description Queue is shuffled or not */
|
|
21317
21556
|
shuffled: boolean;
|
|
21318
21557
|
};
|
|
@@ -21336,7 +21575,7 @@ export interface components {
|
|
|
21336
21575
|
legacySource?: components["schemas"]["LegacySource"];
|
|
21337
21576
|
};
|
|
21338
21577
|
PlayQueues_Current_Single_Relationship_Data_Document: {
|
|
21339
|
-
data?: components["schemas"]["PlayQueues_Current_Resource_Identifier"];
|
|
21578
|
+
data?: components["schemas"]["PlayQueues_Current_Resource_Identifier"] | (never | null);
|
|
21340
21579
|
included?: components["schemas"]["Included"];
|
|
21341
21580
|
links: components["schemas"]["Links"];
|
|
21342
21581
|
};
|
|
@@ -21419,7 +21658,7 @@ export interface components {
|
|
|
21419
21658
|
type: "playQueues";
|
|
21420
21659
|
};
|
|
21421
21660
|
PlayQueues_Single_Relationship_Data_Document: {
|
|
21422
|
-
data?: components["schemas"]["Resource_Identifier"];
|
|
21661
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
21423
21662
|
included?: components["schemas"]["Included"];
|
|
21424
21663
|
links: components["schemas"]["Links"];
|
|
21425
21664
|
};
|
|
@@ -21622,6 +21861,7 @@ export interface components {
|
|
|
21622
21861
|
items?: components["schemas"]["Playlists_Items_Multi_Relationship_Data_Document"];
|
|
21623
21862
|
ownerProfiles?: components["schemas"]["Multi_Relationship_Data_Document"];
|
|
21624
21863
|
owners?: components["schemas"]["Multi_Relationship_Data_Document"];
|
|
21864
|
+
suggestedCoverArts?: components["schemas"]["Playlists_SuggestedCoverArts_Multi_Relationship_Data_Document"];
|
|
21625
21865
|
};
|
|
21626
21866
|
Playlists_Resource_Object: {
|
|
21627
21867
|
attributes?: components["schemas"]["Playlists_Attributes"];
|
|
@@ -21642,6 +21882,30 @@ export interface components {
|
|
|
21642
21882
|
included?: components["schemas"]["Included"];
|
|
21643
21883
|
links: components["schemas"]["Links"];
|
|
21644
21884
|
};
|
|
21885
|
+
Playlists_SuggestedCoverArts_Multi_Relationship_Data_Document: {
|
|
21886
|
+
data?: components["schemas"]["Playlists_SuggestedCoverArts_Resource_Identifier"][];
|
|
21887
|
+
included?: components["schemas"]["Included"];
|
|
21888
|
+
links: components["schemas"]["Links"];
|
|
21889
|
+
};
|
|
21890
|
+
Playlists_SuggestedCoverArts_Resource_Identifier: {
|
|
21891
|
+
/**
|
|
21892
|
+
* @description Resource id
|
|
21893
|
+
* @example 12345
|
|
21894
|
+
*/
|
|
21895
|
+
id: string;
|
|
21896
|
+
meta?: components["schemas"]["Playlists_SuggestedCoverArts_Resource_Identifier_Meta"];
|
|
21897
|
+
/**
|
|
21898
|
+
* @description Resource type
|
|
21899
|
+
* @example tracks
|
|
21900
|
+
*/
|
|
21901
|
+
type: string;
|
|
21902
|
+
};
|
|
21903
|
+
Playlists_SuggestedCoverArts_Resource_Identifier_Meta: {
|
|
21904
|
+
/** @description Background color for the suggested artwork */
|
|
21905
|
+
backgroundColor: string;
|
|
21906
|
+
/** @description Foreground color for the suggested artwork */
|
|
21907
|
+
foregroundColor: string;
|
|
21908
|
+
};
|
|
21645
21909
|
PriceConfigurationsCreateOperation_Payload: {
|
|
21646
21910
|
data: components["schemas"]["PriceConfigurationsCreateOperation_Payload_Data"];
|
|
21647
21911
|
};
|
|
@@ -21742,7 +22006,7 @@ export interface components {
|
|
|
21742
22006
|
type: "providerOwners";
|
|
21743
22007
|
};
|
|
21744
22008
|
ProviderOwners_Single_Relationship_Data_Document: {
|
|
21745
|
-
data?: components["schemas"]["Resource_Identifier"];
|
|
22009
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
21746
22010
|
included?: components["schemas"]["Included"];
|
|
21747
22011
|
links: components["schemas"]["Links"];
|
|
21748
22012
|
};
|
|
@@ -21783,7 +22047,7 @@ export interface components {
|
|
|
21783
22047
|
type: "providerProductInfos";
|
|
21784
22048
|
};
|
|
21785
22049
|
ProviderProductInfos_Single_Relationship_Data_Document: {
|
|
21786
|
-
data?: components["schemas"]["Resource_Identifier"];
|
|
22050
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
21787
22051
|
included?: components["schemas"]["Included"];
|
|
21788
22052
|
links: components["schemas"]["Links"];
|
|
21789
22053
|
};
|
|
@@ -21863,7 +22127,7 @@ export interface components {
|
|
|
21863
22127
|
type: "purchases";
|
|
21864
22128
|
};
|
|
21865
22129
|
Purchases_Single_Relationship_Data_Document: {
|
|
21866
|
-
data?: components["schemas"]["Resource_Identifier"];
|
|
22130
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
21867
22131
|
included?: components["schemas"]["Included"];
|
|
21868
22132
|
links: components["schemas"]["Links"];
|
|
21869
22133
|
};
|
|
@@ -22277,7 +22541,7 @@ export interface components {
|
|
|
22277
22541
|
links: components["schemas"]["Links"];
|
|
22278
22542
|
};
|
|
22279
22543
|
Single_Relationship_Data_Document: {
|
|
22280
|
-
data?: components["schemas"]["Resource_Identifier"];
|
|
22544
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
22281
22545
|
links: components["schemas"]["Links"];
|
|
22282
22546
|
};
|
|
22283
22547
|
SquareConnectionsCreateOperation_Payload: {
|
|
@@ -22300,7 +22564,31 @@ export interface components {
|
|
|
22300
22564
|
*/
|
|
22301
22565
|
redirectUrl?: string;
|
|
22302
22566
|
};
|
|
22567
|
+
SquareConnectionsSelectedSiteRelationshipUpdateOperation_Payload: {
|
|
22568
|
+
data: components["schemas"]["SquareConnectionsSelectedSiteRelationshipUpdateOperation_Payload_Data"] | (never | null);
|
|
22569
|
+
};
|
|
22570
|
+
/** @description The site to select; null clears the selection. */
|
|
22571
|
+
SquareConnectionsSelectedSiteRelationshipUpdateOperation_Payload_Data: {
|
|
22572
|
+
id: string;
|
|
22573
|
+
/** @enum {string} */
|
|
22574
|
+
type: "squareSites";
|
|
22575
|
+
};
|
|
22576
|
+
SquareConnectionsUpdateSingleDataRelationship409ResponseBody: {
|
|
22577
|
+
errors: {
|
|
22578
|
+
/**
|
|
22579
|
+
* @example IDEMPOTENT_REQUEST_IN_PROGRESS
|
|
22580
|
+
* @enum {string}
|
|
22581
|
+
*/
|
|
22582
|
+
code: "IDEMPOTENT_REQUEST_IN_PROGRESS" | "MISSING_SITES_SCOPE";
|
|
22583
|
+
/** @example The Square credential is missing the OAuth scopes required by the Square Online sites feature (ONLINE_STORE_SITE_READ, CHANNELS_READ). Re-run Square onboarding to grant them. */
|
|
22584
|
+
detail?: string;
|
|
22585
|
+
/** @example 409 */
|
|
22586
|
+
status: string;
|
|
22587
|
+
}[];
|
|
22588
|
+
};
|
|
22303
22589
|
SquareConnections_Attributes: {
|
|
22590
|
+
/** @description Per-feature capability statuses for this Square connection. Every capability the connection offers is listed with a status carrying more than mere presence: SITES is GRANTED when the Square Online sites scopes are granted, or REQUIRES_REAUTH when the connection exists but its credential lacks them (the seller must reconnect Square via POST /squareConnections). Because a connection always offers the sites feature, SITES is always present here. Extensible — only SITES is defined today. Absent only when the connection has no sites state (e.g. no approved Square credential). Client rule: if SITES != GRANTED prompt reconnect; else if selectedSite.data is null show the site picker; else the selected site is shown to buyers. */
|
|
22591
|
+
capabilities?: components["schemas"]["SquareConnections_Capability"][];
|
|
22304
22592
|
/**
|
|
22305
22593
|
* Format: date-time
|
|
22306
22594
|
* @description Timestamp when the connection was created
|
|
@@ -22319,11 +22607,32 @@ export interface components {
|
|
|
22319
22607
|
*/
|
|
22320
22608
|
status: "DRAFT" | "PENDING_REQUIREMENTS" | "KYC_PENDING" | "ACCEPTED" | "REJECTED" | "SUSPENDED";
|
|
22321
22609
|
};
|
|
22610
|
+
SquareConnections_Capability: {
|
|
22611
|
+
/**
|
|
22612
|
+
* @description The capability name
|
|
22613
|
+
* @enum {string}
|
|
22614
|
+
*/
|
|
22615
|
+
name: "SITES";
|
|
22616
|
+
/**
|
|
22617
|
+
* @description The capability's current status
|
|
22618
|
+
* @enum {string}
|
|
22619
|
+
*/
|
|
22620
|
+
status: "GRANTED" | "REQUIRES_REAUTH";
|
|
22621
|
+
};
|
|
22622
|
+
SquareConnections_Multi_Relationship_Data_Document: {
|
|
22623
|
+
data?: components["schemas"]["Resource_Identifier"][];
|
|
22624
|
+
included?: components["schemas"]["Included"];
|
|
22625
|
+
links: components["schemas"]["Links"];
|
|
22626
|
+
};
|
|
22322
22627
|
SquareConnections_Multi_Resource_Data_Document: {
|
|
22323
22628
|
data: components["schemas"]["SquareConnections_Resource_Object"][];
|
|
22324
22629
|
included?: components["schemas"]["Included"];
|
|
22325
22630
|
links: components["schemas"]["Links"];
|
|
22326
22631
|
};
|
|
22632
|
+
SquareConnections_Relationships: {
|
|
22633
|
+
selectedSite?: components["schemas"]["Single_Relationship_Data_Document"];
|
|
22634
|
+
sites?: components["schemas"]["Multi_Relationship_Data_Document"];
|
|
22635
|
+
};
|
|
22327
22636
|
SquareConnections_Resource_Object: {
|
|
22328
22637
|
attributes?: components["schemas"]["SquareConnections_Attributes"];
|
|
22329
22638
|
/**
|
|
@@ -22331,17 +22640,52 @@ export interface components {
|
|
|
22331
22640
|
* @example 12345
|
|
22332
22641
|
*/
|
|
22333
22642
|
id: string;
|
|
22643
|
+
relationships?: components["schemas"]["SquareConnections_Relationships"];
|
|
22334
22644
|
/**
|
|
22335
22645
|
* @description Resource type (enum property replaced by openapi-typescript)
|
|
22336
22646
|
* @enum {string}
|
|
22337
22647
|
*/
|
|
22338
22648
|
type: "squareConnections";
|
|
22339
22649
|
};
|
|
22650
|
+
SquareConnections_Single_Relationship_Data_Document: {
|
|
22651
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
22652
|
+
included?: components["schemas"]["Included"];
|
|
22653
|
+
links: components["schemas"]["Links"];
|
|
22654
|
+
};
|
|
22340
22655
|
SquareConnections_Single_Resource_Data_Document: {
|
|
22341
22656
|
data: components["schemas"]["SquareConnections_Resource_Object"];
|
|
22342
22657
|
included?: components["schemas"]["Included"];
|
|
22343
22658
|
links: components["schemas"]["Links"];
|
|
22344
22659
|
};
|
|
22660
|
+
SquareSites_Attributes: {
|
|
22661
|
+
/** @description The site's domain, if one is configured */
|
|
22662
|
+
domain?: string;
|
|
22663
|
+
/** @description Whether the site is published on Square Online */
|
|
22664
|
+
published?: boolean;
|
|
22665
|
+
};
|
|
22666
|
+
SquareSites_Multi_Resource_Data_Document: {
|
|
22667
|
+
data: components["schemas"]["SquareSites_Resource_Object"][];
|
|
22668
|
+
included?: components["schemas"]["Included"];
|
|
22669
|
+
links: components["schemas"]["Links"];
|
|
22670
|
+
};
|
|
22671
|
+
SquareSites_Resource_Object: {
|
|
22672
|
+
attributes?: components["schemas"]["SquareSites_Attributes"];
|
|
22673
|
+
/**
|
|
22674
|
+
* @description Resource id
|
|
22675
|
+
* @example 12345
|
|
22676
|
+
*/
|
|
22677
|
+
id: string;
|
|
22678
|
+
/**
|
|
22679
|
+
* @description Resource type (enum property replaced by openapi-typescript)
|
|
22680
|
+
* @enum {string}
|
|
22681
|
+
*/
|
|
22682
|
+
type: "squareSites";
|
|
22683
|
+
};
|
|
22684
|
+
SquareSites_Single_Resource_Data_Document: {
|
|
22685
|
+
data: components["schemas"]["SquareSites_Resource_Object"];
|
|
22686
|
+
included?: components["schemas"]["Included"];
|
|
22687
|
+
links: components["schemas"]["Links"];
|
|
22688
|
+
};
|
|
22345
22689
|
StripeConnectionsCreateOperation_Payload: {
|
|
22346
22690
|
data: components["schemas"]["StripeConnectionsCreateOperation_Payload_Data"];
|
|
22347
22691
|
meta?: components["schemas"]["StripeConnectionsCreateOperation_Payload_Meta"];
|
|
@@ -23087,7 +23431,7 @@ export interface components {
|
|
|
23087
23431
|
type: "tracks";
|
|
23088
23432
|
};
|
|
23089
23433
|
Tracks_Single_Relationship_Data_Document: {
|
|
23090
|
-
data?: components["schemas"]["Resource_Identifier"];
|
|
23434
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
23091
23435
|
included?: components["schemas"]["Included"];
|
|
23092
23436
|
links: components["schemas"]["Links"];
|
|
23093
23437
|
};
|
|
@@ -23418,12 +23762,6 @@ export interface components {
|
|
|
23418
23762
|
type: "userCollectionFolders";
|
|
23419
23763
|
};
|
|
23420
23764
|
UserCollectionFoldersCreateOperation_Payload_Data_Attributes: {
|
|
23421
|
-
/**
|
|
23422
|
-
* @deprecated
|
|
23423
|
-
* @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.
|
|
23424
|
-
* @enum {string}
|
|
23425
|
-
*/
|
|
23426
|
-
collectionType?: "PLAYLISTS";
|
|
23427
23765
|
name: string;
|
|
23428
23766
|
};
|
|
23429
23767
|
UserCollectionFoldersCreateOperation_Payload_Data_Relationships: {
|
|
@@ -23450,14 +23788,16 @@ export interface components {
|
|
|
23450
23788
|
};
|
|
23451
23789
|
UserCollectionFoldersItemsRelationshipAddOperation_Payload_Data: {
|
|
23452
23790
|
id: string;
|
|
23453
|
-
|
|
23791
|
+
/** @enum {string} */
|
|
23792
|
+
type: "playlists";
|
|
23454
23793
|
};
|
|
23455
23794
|
UserCollectionFoldersItemsRelationshipRemoveOperation_Payload: {
|
|
23456
23795
|
data?: components["schemas"]["UserCollectionFoldersItemsRelationshipRemoveOperation_Payload_Data"][];
|
|
23457
23796
|
};
|
|
23458
23797
|
UserCollectionFoldersItemsRelationshipRemoveOperation_Payload_Data: {
|
|
23459
23798
|
id: string;
|
|
23460
|
-
|
|
23799
|
+
/** @enum {string} */
|
|
23800
|
+
type: "playlists";
|
|
23461
23801
|
};
|
|
23462
23802
|
UserCollectionFoldersUpdateOperation_Payload: {
|
|
23463
23803
|
data: components["schemas"]["UserCollectionFoldersUpdateOperation_Payload_Data"];
|
|
@@ -23472,12 +23812,6 @@ export interface components {
|
|
|
23472
23812
|
name?: string;
|
|
23473
23813
|
};
|
|
23474
23814
|
UserCollectionFolders_Attributes: {
|
|
23475
|
-
/**
|
|
23476
|
-
* @deprecated
|
|
23477
|
-
* @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.
|
|
23478
|
-
* @enum {string}
|
|
23479
|
-
*/
|
|
23480
|
-
collectionType?: "PLAYLISTS";
|
|
23481
23815
|
/** Format: date-time */
|
|
23482
23816
|
createdAt: string;
|
|
23483
23817
|
/** Format: date-time */
|
|
@@ -23538,7 +23872,7 @@ export interface components {
|
|
|
23538
23872
|
type: "userCollectionFolders";
|
|
23539
23873
|
};
|
|
23540
23874
|
UserCollectionFolders_Single_Relationship_Data_Document: {
|
|
23541
|
-
data?: components["schemas"]["Resource_Identifier"];
|
|
23875
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
23542
23876
|
included?: components["schemas"]["Included"];
|
|
23543
23877
|
links: components["schemas"]["Links"];
|
|
23544
23878
|
};
|
|
@@ -24917,7 +25251,7 @@ export interface components {
|
|
|
24917
25251
|
type: "videos";
|
|
24918
25252
|
};
|
|
24919
25253
|
Videos_Single_Relationship_Data_Document: {
|
|
24920
|
-
data?: components["schemas"]["Resource_Identifier"];
|
|
25254
|
+
data?: components["schemas"]["Resource_Identifier"] | (never | null);
|
|
24921
25255
|
included?: components["schemas"]["Included"];
|
|
24922
25256
|
links: components["schemas"]["Links"];
|
|
24923
25257
|
};
|
|
@@ -25018,6 +25352,15 @@ export interface components {
|
|
|
25018
25352
|
"application/vnd.api+json": components["schemas"]["Idempotency422ResponseBody"];
|
|
25019
25353
|
};
|
|
25020
25354
|
};
|
|
25355
|
+
/** @description The Square credential is missing the OAuth scopes required by the Square Online sites feature (ONLINE_STORE_SITE_READ, CHANNELS_READ). Re-run Square onboarding to grant them.; A request with this idempotency key is currently being processed */
|
|
25356
|
+
SquareConnectionsUpdateSingleDataRelationship409Response: {
|
|
25357
|
+
headers: {
|
|
25358
|
+
[name: string]: unknown;
|
|
25359
|
+
};
|
|
25360
|
+
content: {
|
|
25361
|
+
"application/vnd.api+json": components["schemas"]["SquareConnectionsUpdateSingleDataRelationship409ResponseBody"];
|
|
25362
|
+
};
|
|
25363
|
+
};
|
|
25021
25364
|
/** @description Cannot fulfill this request because required prerequisites are missing; The requested content is not available in your location; The requested content must be purchased to be accessed; Client is not allowed to access this content; This account is playing on another app or device */
|
|
25022
25365
|
TrackFilesReadById403Response: {
|
|
25023
25366
|
headers: {
|