@tidal-music/api 0.9.1 → 0.11.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/index.d.ts +774 -101
- package/dist/index.js +333 -377
- package/package.json +6 -6
package/dist/index.d.ts
CHANGED
|
@@ -3,6 +3,57 @@ import { CredentialsProvider } from '@tidal-music/common';
|
|
|
3
3
|
|
|
4
4
|
export declare interface components {
|
|
5
5
|
schemas: {
|
|
6
|
+
AcceptedTermsCreateOperation_Payload: {
|
|
7
|
+
data: components["schemas"]["AcceptedTermsCreateOperation_Payload_Data"];
|
|
8
|
+
};
|
|
9
|
+
AcceptedTermsCreateOperation_Payload_Data: {
|
|
10
|
+
attributes: components["schemas"]["AcceptedTermsCreateOperation_Payload_Data_Attributes"];
|
|
11
|
+
/** @enum {string} */
|
|
12
|
+
type: "acceptedTerms";
|
|
13
|
+
};
|
|
14
|
+
AcceptedTermsCreateOperation_Payload_Data_Attributes: {
|
|
15
|
+
/** @enum {string} */
|
|
16
|
+
termsType: "DEVELOPER";
|
|
17
|
+
};
|
|
18
|
+
AcceptedTerms_Attributes: {
|
|
19
|
+
/** Format: date-time */
|
|
20
|
+
createdAt: string;
|
|
21
|
+
/** @enum {string} */
|
|
22
|
+
termsType: "DEVELOPER";
|
|
23
|
+
termsVersion: string;
|
|
24
|
+
};
|
|
25
|
+
AcceptedTerms_Multi_Relationship_Data_Document: {
|
|
26
|
+
data?: components["schemas"]["Resource_Identifier"][];
|
|
27
|
+
included?: components["schemas"]["Included"];
|
|
28
|
+
links: components["schemas"]["Links"];
|
|
29
|
+
};
|
|
30
|
+
AcceptedTerms_Multi_Resource_Data_Document: {
|
|
31
|
+
data: components["schemas"]["AcceptedTerms_Resource_Object"][];
|
|
32
|
+
included?: components["schemas"]["Included"];
|
|
33
|
+
links: components["schemas"]["Links"];
|
|
34
|
+
};
|
|
35
|
+
AcceptedTerms_Relationships: {
|
|
36
|
+
owners?: components["schemas"]["Multi_Relationship_Data_Document"];
|
|
37
|
+
};
|
|
38
|
+
AcceptedTerms_Resource_Object: {
|
|
39
|
+
attributes?: components["schemas"]["AcceptedTerms_Attributes"];
|
|
40
|
+
/**
|
|
41
|
+
* @description Resource id
|
|
42
|
+
* @example 12345
|
|
43
|
+
*/
|
|
44
|
+
id: string;
|
|
45
|
+
relationships?: components["schemas"]["AcceptedTerms_Relationships"];
|
|
46
|
+
/**
|
|
47
|
+
* @description Resource type (enum property replaced by openapi-typescript)
|
|
48
|
+
* @enum {string}
|
|
49
|
+
*/
|
|
50
|
+
type: "acceptedTerms";
|
|
51
|
+
};
|
|
52
|
+
AcceptedTerms_Single_Resource_Data_Document: {
|
|
53
|
+
data: components["schemas"]["AcceptedTerms_Resource_Object"];
|
|
54
|
+
included?: components["schemas"]["Included"];
|
|
55
|
+
links: components["schemas"]["Links"];
|
|
56
|
+
};
|
|
6
57
|
AlbumStatistics_Attributes: {
|
|
7
58
|
/**
|
|
8
59
|
* Format: int32
|
|
@@ -951,6 +1002,82 @@ export declare interface components {
|
|
|
951
1002
|
BarcodeId: {
|
|
952
1003
|
value: string;
|
|
953
1004
|
};
|
|
1005
|
+
ClientsCreateOperation_Payload: {
|
|
1006
|
+
data: components["schemas"]["ClientsCreateOperation_Payload_Data"];
|
|
1007
|
+
};
|
|
1008
|
+
ClientsCreateOperation_Payload_Data: {
|
|
1009
|
+
attributes: components["schemas"]["ClientsCreateOperation_Payload_Data_Attributes"];
|
|
1010
|
+
/** @enum {string} */
|
|
1011
|
+
type: "clients";
|
|
1012
|
+
};
|
|
1013
|
+
ClientsCreateOperation_Payload_Data_Attributes: {
|
|
1014
|
+
description?: string;
|
|
1015
|
+
name: string;
|
|
1016
|
+
};
|
|
1017
|
+
ClientsUpdateOperation_Payload: {
|
|
1018
|
+
data: components["schemas"]["ClientsUpdateOperation_Payload_Data"];
|
|
1019
|
+
};
|
|
1020
|
+
ClientsUpdateOperation_Payload_Data: {
|
|
1021
|
+
attributes: components["schemas"]["ClientsUpdateOperation_Payload_Data_Attributes"];
|
|
1022
|
+
id: string;
|
|
1023
|
+
/** @enum {string} */
|
|
1024
|
+
type: "clients";
|
|
1025
|
+
};
|
|
1026
|
+
ClientsUpdateOperation_Payload_Data_Attributes: {
|
|
1027
|
+
description?: string;
|
|
1028
|
+
enabled?: boolean;
|
|
1029
|
+
name?: string;
|
|
1030
|
+
/** @enum {string} */
|
|
1031
|
+
platformPreset?: "NONE" | "WEB" | "ANDROID" | "IOS";
|
|
1032
|
+
redirectUris?: string[];
|
|
1033
|
+
scopes?: string[];
|
|
1034
|
+
};
|
|
1035
|
+
Clients_Attributes: {
|
|
1036
|
+
/** @enum {string} */
|
|
1037
|
+
accessTier: "THIRD_PARTY" | "THIRD_PARTY_PROD" | "PARTNER" | "INTERNAL";
|
|
1038
|
+
clientSecret?: string;
|
|
1039
|
+
/** Format: date-time */
|
|
1040
|
+
createdAt?: string;
|
|
1041
|
+
description?: string;
|
|
1042
|
+
enabled?: boolean;
|
|
1043
|
+
name: string;
|
|
1044
|
+
/** @enum {string} */
|
|
1045
|
+
platformPreset?: "NONE" | "WEB" | "ANDROID" | "IOS";
|
|
1046
|
+
redirectUris?: string[];
|
|
1047
|
+
scopes?: string[];
|
|
1048
|
+
};
|
|
1049
|
+
Clients_Multi_Relationship_Data_Document: {
|
|
1050
|
+
data?: components["schemas"]["Resource_Identifier"][];
|
|
1051
|
+
included?: components["schemas"]["Included"];
|
|
1052
|
+
links: components["schemas"]["Links"];
|
|
1053
|
+
};
|
|
1054
|
+
Clients_Multi_Resource_Data_Document: {
|
|
1055
|
+
data: components["schemas"]["Clients_Resource_Object"][];
|
|
1056
|
+
included?: components["schemas"]["Included"];
|
|
1057
|
+
links: components["schemas"]["Links"];
|
|
1058
|
+
};
|
|
1059
|
+
Clients_Relationships: {
|
|
1060
|
+
owners?: components["schemas"]["Multi_Relationship_Data_Document"];
|
|
1061
|
+
};
|
|
1062
|
+
Clients_Resource_Object: {
|
|
1063
|
+
attributes?: components["schemas"]["Clients_Attributes"];
|
|
1064
|
+
/**
|
|
1065
|
+
* @description Resource id
|
|
1066
|
+
* @example 12345
|
|
1067
|
+
*/
|
|
1068
|
+
id: string;
|
|
1069
|
+
relationships?: components["schemas"]["Clients_Relationships"];
|
|
1070
|
+
/**
|
|
1071
|
+
* @description Resource type (enum property replaced by openapi-typescript)
|
|
1072
|
+
* @enum {string}
|
|
1073
|
+
*/
|
|
1074
|
+
type: "clients";
|
|
1075
|
+
};
|
|
1076
|
+
Clients_Single_Resource_Data_Document: {
|
|
1077
|
+
data: components["schemas"]["Clients_Resource_Object"];
|
|
1078
|
+
included?: components["schemas"]["Included"];
|
|
1079
|
+
links: components["schemas"]["Links"];
|
|
1080
|
+
};
|
|
954
1081
|
CommentsCreateOperation_Payload: {
|
|
955
1082
|
data: components["schemas"]["CommentsCreateOperation_Payload_Data"];
|
|
956
1083
|
};
|
|
@@ -1637,7 +1764,7 @@ export declare interface components {
|
|
|
1637
1764
|
status: string;
|
|
1638
1765
|
}[];
|
|
1639
1766
|
};
|
|
1640
|
-
Included: (components["schemas"]["AlbumStatistics_Resource_Object"] | components["schemas"]["Albums_Resource_Object"] | components["schemas"]["Appreciations_Resource_Object"] | components["schemas"]["ArtistBiographies_Resource_Object"] | components["schemas"]["ArtistClaims_Resource_Object"] | components["schemas"]["ArtistRoles_Resource_Object"] | components["schemas"]["Artists_Resource_Object"] | components["schemas"]["Artworks_Resource_Object"] | components["schemas"]["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"]["Providers_Resource_Object"] | components["schemas"]["Reactions_Resource_Object"] | components["schemas"]["SavedShares_Resource_Object"] | components["schemas"]["SearchResults_Resource_Object"] | components["schemas"]["SearchSuggestions_Resource_Object"] | components["schemas"]["Shares_Resource_Object"] | components["schemas"]["StripeConnections_Resource_Object"] | components["schemas"]["StripeDashboardLinks_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"]["UserCollectionTracks_Resource_Object"] | components["schemas"]["UserCollectionVideos_Resource_Object"] | components["schemas"]["UserCollections_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"])[];
|
|
1767
|
+
Included: (components["schemas"]["AcceptedTerms_Resource_Object"] | components["schemas"]["AlbumStatistics_Resource_Object"] | components["schemas"]["Albums_Resource_Object"] | components["schemas"]["Appreciations_Resource_Object"] | components["schemas"]["ArtistBiographies_Resource_Object"] | components["schemas"]["ArtistClaims_Resource_Object"] | components["schemas"]["ArtistRoles_Resource_Object"] | components["schemas"]["Artists_Resource_Object"] | components["schemas"]["Artworks_Resource_Object"] | components["schemas"]["Clients_Resource_Object"] | components["schemas"]["Comments_Resource_Object"] | components["schemas"]["ContentClaims_Resource_Object"] | components["schemas"]["Credits_Resource_Object"] | components["schemas"]["Downloads_Resource_Object"] | components["schemas"]["DspSharingLinks_Resource_Object"] | components["schemas"]["DynamicModules_Resource_Object"] | components["schemas"]["DynamicPages_Resource_Object"] | components["schemas"]["Genres_Resource_Object"] | components["schemas"]["Installations_Resource_Object"] | components["schemas"]["Lyrics_Resource_Object"] | components["schemas"]["ManualArtistClaims_Resource_Object"] | components["schemas"]["OfflineTasks_Resource_Object"] | components["schemas"]["PlayQueues_Resource_Object"] | components["schemas"]["Playlists_Resource_Object"] | components["schemas"]["PriceConfigurations_Resource_Object"] | components["schemas"]["Providers_Resource_Object"] | components["schemas"]["Reactions_Resource_Object"] | components["schemas"]["SavedShares_Resource_Object"] | components["schemas"]["SearchResults_Resource_Object"] | components["schemas"]["SearchSuggestions_Resource_Object"] | components["schemas"]["Shares_Resource_Object"] | components["schemas"]["StripeConnections_Resource_Object"] | components["schemas"]["StripeDashboardLinks_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"]["UserCollectionTracks_Resource_Object"] | components["schemas"]["UserCollectionVideos_Resource_Object"] | components["schemas"]["UserCollections_Resource_Object"] | components["schemas"]["UserDataExportRequests_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"])[];
|
|
1641
1768
|
InstallationsCreateOperation_Payload: {
|
|
1642
1769
|
data: components["schemas"]["InstallationsCreateOperation_Payload_Data"];
|
|
1643
1770
|
};
|
|
@@ -1882,6 +2009,7 @@ export declare interface components {
|
|
|
1882
2009
|
selectedAlbums?: string[];
|
|
1883
2010
|
selectedSingles?: string[];
|
|
1884
2011
|
socialLink?: components["schemas"]["Link_Object"];
|
|
2012
|
+
upcs?: string[];
|
|
1885
2013
|
websiteOrSocialLink: components["schemas"]["Link_Object"];
|
|
1886
2014
|
};
|
|
1887
2015
|
ManualArtistClaims_Attributes: {
|
|
@@ -1931,6 +2059,8 @@ export declare interface components {
|
|
|
1931
2059
|
* @enum {string}
|
|
1932
2060
|
*/
|
|
1933
2061
|
status?: "SUBMITTED" | "PENDING" | "APPROVED" | "REJECTED";
|
|
2062
|
+
/** @description UPCs associated with the claim */
|
|
2063
|
+
upcs?: string[];
|
|
1934
2064
|
websiteOrSocialLink: components["schemas"]["Link_Object"];
|
|
1935
2065
|
};
|
|
1936
2066
|
ManualArtistClaims_Multi_Resource_Data_Document: {
|
|
@@ -4430,6 +4560,48 @@ export declare interface components {
|
|
|
4430
4560
|
/** Format: date-time */
|
|
4431
4561
|
addedAt: string;
|
|
4432
4562
|
};
|
|
4563
|
+
UserDataExportRequestsCreateOperation_Payload: {
|
|
4564
|
+
data: components["schemas"]["UserDataExportRequestsCreateOperation_Payload_Data"];
|
|
4565
|
+
};
|
|
4566
|
+
UserDataExportRequestsCreateOperation_Payload_Data: {
|
|
4567
|
+
attributes: components["schemas"]["UserDataExportRequestsCreateOperation_Payload_Data_Attributes"];
|
|
4568
|
+
/** @enum {string} */
|
|
4569
|
+
type: "userDataExportRequests";
|
|
4570
|
+
};
|
|
4571
|
+
UserDataExportRequestsCreateOperation_Payload_Data_Attributes: {
|
|
4572
|
+
/** @enum {string} */
|
|
4573
|
+
flowType: "GDPR" | "CCPA" | "COPPA" | "ANZ_PA" | "US_PRIVACY_REGULATION" | "APPI" | "RETENTION_POLICY";
|
|
4574
|
+
};
|
|
4575
|
+
UserDataExportRequests_Attributes: {
|
|
4576
|
+
/**
|
|
4577
|
+
* @description The type of data export flow
|
|
4578
|
+
* @enum {string}
|
|
4579
|
+
*/
|
|
4580
|
+
flowType: "GDPR" | "CCPA" | "COPPA" | "ANZ_PA" | "US_PRIVACY_REGULATION" | "APPI" | "RETENTION_POLICY";
|
|
4581
|
+
};
|
|
4582
|
+
UserDataExportRequests_Multi_Resource_Data_Document: {
|
|
4583
|
+
data: components["schemas"]["UserDataExportRequests_Resource_Object"][];
|
|
4584
|
+
included?: components["schemas"]["Included"];
|
|
4585
|
+
links: components["schemas"]["Links"];
|
|
4586
|
+
};
|
|
4587
|
+
UserDataExportRequests_Resource_Object: {
|
|
4588
|
+
attributes?: components["schemas"]["UserDataExportRequests_Attributes"];
|
|
4589
|
+
/**
|
|
4590
|
+
* @description Resource id
|
|
4591
|
+
* @example 12345
|
|
4592
|
+
*/
|
|
4593
|
+
id: string;
|
|
4594
|
+
/**
|
|
4595
|
+
* @description Resource type (enum property replaced by openapi-typescript)
|
|
4596
|
+
* @enum {string}
|
|
4597
|
+
*/
|
|
4598
|
+
type: "userDataExportRequests";
|
|
4599
|
+
};
|
|
4600
|
+
UserDataExportRequests_Single_Resource_Data_Document: {
|
|
4601
|
+
data: components["schemas"]["UserDataExportRequests_Resource_Object"];
|
|
4602
|
+
included?: components["schemas"]["Included"];
|
|
4603
|
+
links: components["schemas"]["Links"];
|
|
4604
|
+
};
|
|
4433
4605
|
UserRecommendations_Attributes: Record<string, never>;
|
|
4434
4606
|
UserRecommendations_Multi_Relationship_Data_Document: {
|
|
4435
4607
|
data?: components["schemas"]["Resource_Identifier"][];
|
|
@@ -4970,6 +5142,166 @@ export declare function createAPIClient(credentialsProvider: CredentialsProvider
|
|
|
4970
5142
|
* Do not make direct changes to the file.
|
|
4971
5143
|
*/
|
|
4972
5144
|
declare interface paths {
|
|
5145
|
+
"/acceptedTerms": {
|
|
5146
|
+
parameters: {
|
|
5147
|
+
query?: never;
|
|
5148
|
+
header?: never;
|
|
5149
|
+
path?: never;
|
|
5150
|
+
cookie?: never;
|
|
5151
|
+
};
|
|
5152
|
+
/**
|
|
5153
|
+
* Get multiple acceptedTerms.
|
|
5154
|
+
* @description Retrieves multiple acceptedTerms by available filters, or without if applicable.
|
|
5155
|
+
*/
|
|
5156
|
+
get: {
|
|
5157
|
+
parameters: {
|
|
5158
|
+
query?: {
|
|
5159
|
+
/**
|
|
5160
|
+
* @description Allows the client to customize which related resources should be returned. Available options: owners
|
|
5161
|
+
* @example owners
|
|
5162
|
+
*/
|
|
5163
|
+
include?: string[];
|
|
5164
|
+
/** @description Filter by latestVersion */
|
|
5165
|
+
"filter[latestVersion]"?: string[];
|
|
5166
|
+
/** @description User id. Use `me` for the authenticated user */
|
|
5167
|
+
"filter[owners.id]"?: string[];
|
|
5168
|
+
/** @description One of: DEVELOPER (e.g. `DEVELOPER`) */
|
|
5169
|
+
"filter[termsType]"?: "DEVELOPER"[];
|
|
5170
|
+
};
|
|
5171
|
+
header?: never;
|
|
5172
|
+
path?: never;
|
|
5173
|
+
cookie?: never;
|
|
5174
|
+
};
|
|
5175
|
+
requestBody?: never;
|
|
5176
|
+
responses: {
|
|
5177
|
+
/** @description Successful response */
|
|
5178
|
+
200: {
|
|
5179
|
+
headers: {
|
|
5180
|
+
[name: string]: unknown;
|
|
5181
|
+
};
|
|
5182
|
+
content: {
|
|
5183
|
+
"application/vnd.api+json": components["schemas"]["AcceptedTerms_Multi_Resource_Data_Document"];
|
|
5184
|
+
};
|
|
5185
|
+
};
|
|
5186
|
+
400: components["responses"]["Default400Response"];
|
|
5187
|
+
404: components["responses"]["Default404Response"];
|
|
5188
|
+
405: components["responses"]["Default405Response"];
|
|
5189
|
+
406: components["responses"]["Default406Response"];
|
|
5190
|
+
415: components["responses"]["Default415Response"];
|
|
5191
|
+
429: components["responses"]["Default429Response"];
|
|
5192
|
+
500: components["responses"]["Default500Response"];
|
|
5193
|
+
503: components["responses"]["Default503Response"];
|
|
5194
|
+
};
|
|
5195
|
+
};
|
|
5196
|
+
put?: never;
|
|
5197
|
+
/**
|
|
5198
|
+
* Create single acceptedTerm.
|
|
5199
|
+
* @description Creates a new acceptedTerm.
|
|
5200
|
+
*/
|
|
5201
|
+
post: {
|
|
5202
|
+
parameters: {
|
|
5203
|
+
query?: never;
|
|
5204
|
+
header?: {
|
|
5205
|
+
/** @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. */
|
|
5206
|
+
"Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
|
|
5207
|
+
};
|
|
5208
|
+
path?: never;
|
|
5209
|
+
cookie?: never;
|
|
5210
|
+
};
|
|
5211
|
+
requestBody?: {
|
|
5212
|
+
content: {
|
|
5213
|
+
"application/vnd.api+json": components["schemas"]["AcceptedTermsCreateOperation_Payload"];
|
|
5214
|
+
};
|
|
5215
|
+
};
|
|
5216
|
+
responses: {
|
|
5217
|
+
/** @description Successful response */
|
|
5218
|
+
201: {
|
|
5219
|
+
headers: {
|
|
5220
|
+
[name: string]: unknown;
|
|
5221
|
+
};
|
|
5222
|
+
content: {
|
|
5223
|
+
"application/vnd.api+json": components["schemas"]["AcceptedTerms_Single_Resource_Data_Document"];
|
|
5224
|
+
};
|
|
5225
|
+
};
|
|
5226
|
+
400: components["responses"]["Default400Response"];
|
|
5227
|
+
404: components["responses"]["Default404Response"];
|
|
5228
|
+
405: components["responses"]["Default405Response"];
|
|
5229
|
+
406: components["responses"]["Default406Response"];
|
|
5230
|
+
409: components["responses"]["Idempotency409Response"];
|
|
5231
|
+
415: components["responses"]["Default415Response"];
|
|
5232
|
+
422: components["responses"]["Idempotency422Response"];
|
|
5233
|
+
429: components["responses"]["Default429Response"];
|
|
5234
|
+
500: components["responses"]["Default500Response"];
|
|
5235
|
+
503: components["responses"]["Default503Response"];
|
|
5236
|
+
};
|
|
5237
|
+
};
|
|
5238
|
+
delete?: never;
|
|
5239
|
+
options?: never;
|
|
5240
|
+
head?: never;
|
|
5241
|
+
patch?: never;
|
|
5242
|
+
trace?: never;
|
|
5243
|
+
};
|
|
5244
|
+
"/acceptedTerms/{id}/relationships/owners": {
|
|
5245
|
+
parameters: {
|
|
5246
|
+
query?: never;
|
|
5247
|
+
header?: never;
|
|
5248
|
+
path?: never;
|
|
5249
|
+
cookie?: never;
|
|
5250
|
+
};
|
|
5251
|
+
/**
|
|
5252
|
+
* Get owners relationship ("to-many").
|
|
5253
|
+
* @description Retrieves owners relationship.
|
|
5254
|
+
*/
|
|
5255
|
+
get: {
|
|
5256
|
+
parameters: {
|
|
5257
|
+
query?: {
|
|
5258
|
+
/**
|
|
5259
|
+
* @description Allows the client to customize which related resources should be returned. Available options: owners
|
|
5260
|
+
* @example owners
|
|
5261
|
+
*/
|
|
5262
|
+
include?: string[];
|
|
5263
|
+
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
5264
|
+
"page[cursor]"?: string;
|
|
5265
|
+
};
|
|
5266
|
+
header?: never;
|
|
5267
|
+
path: {
|
|
5268
|
+
/**
|
|
5269
|
+
* @description Accepted terms id
|
|
5270
|
+
* @example a468bee88def
|
|
5271
|
+
*/
|
|
5272
|
+
id: string;
|
|
5273
|
+
};
|
|
5274
|
+
cookie?: never;
|
|
5275
|
+
};
|
|
5276
|
+
requestBody?: never;
|
|
5277
|
+
responses: {
|
|
5278
|
+
/** @description Successful response */
|
|
5279
|
+
200: {
|
|
5280
|
+
headers: {
|
|
5281
|
+
[name: string]: unknown;
|
|
5282
|
+
};
|
|
5283
|
+
content: {
|
|
5284
|
+
"application/vnd.api+json": components["schemas"]["AcceptedTerms_Multi_Relationship_Data_Document"];
|
|
5285
|
+
};
|
|
5286
|
+
};
|
|
5287
|
+
400: components["responses"]["Default400Response"];
|
|
5288
|
+
404: components["responses"]["Default404Response"];
|
|
5289
|
+
405: components["responses"]["Default405Response"];
|
|
5290
|
+
406: components["responses"]["Default406Response"];
|
|
5291
|
+
415: components["responses"]["Default415Response"];
|
|
5292
|
+
429: components["responses"]["Default429Response"];
|
|
5293
|
+
500: components["responses"]["Default500Response"];
|
|
5294
|
+
503: components["responses"]["Default503Response"];
|
|
5295
|
+
};
|
|
5296
|
+
};
|
|
5297
|
+
put?: never;
|
|
5298
|
+
post?: never;
|
|
5299
|
+
delete?: never;
|
|
5300
|
+
options?: never;
|
|
5301
|
+
head?: never;
|
|
5302
|
+
patch?: never;
|
|
5303
|
+
trace?: never;
|
|
5304
|
+
};
|
|
4973
5305
|
"/albumStatistics": {
|
|
4974
5306
|
parameters: {
|
|
4975
5307
|
query?: never;
|
|
@@ -7910,7 +8242,265 @@ declare interface paths {
|
|
|
7910
8242
|
[name: string]: unknown;
|
|
7911
8243
|
};
|
|
7912
8244
|
content: {
|
|
7913
|
-
"application/vnd.api+json": components["schemas"]["Artists_Multi_Relationship_Data_Document"];
|
|
8245
|
+
"application/vnd.api+json": components["schemas"]["Artists_Multi_Relationship_Data_Document"];
|
|
8246
|
+
};
|
|
8247
|
+
};
|
|
8248
|
+
400: components["responses"]["Default400Response"];
|
|
8249
|
+
404: components["responses"]["Default404Response"];
|
|
8250
|
+
405: components["responses"]["Default405Response"];
|
|
8251
|
+
406: components["responses"]["Default406Response"];
|
|
8252
|
+
415: components["responses"]["Default415Response"];
|
|
8253
|
+
429: components["responses"]["Default429Response"];
|
|
8254
|
+
500: components["responses"]["Default500Response"];
|
|
8255
|
+
503: components["responses"]["Default503Response"];
|
|
8256
|
+
};
|
|
8257
|
+
};
|
|
8258
|
+
put?: never;
|
|
8259
|
+
post?: never;
|
|
8260
|
+
delete?: never;
|
|
8261
|
+
options?: never;
|
|
8262
|
+
head?: never;
|
|
8263
|
+
patch?: never;
|
|
8264
|
+
trace?: never;
|
|
8265
|
+
};
|
|
8266
|
+
"/artists/{id}/relationships/trackProviders": {
|
|
8267
|
+
parameters: {
|
|
8268
|
+
query?: never;
|
|
8269
|
+
header?: never;
|
|
8270
|
+
path?: never;
|
|
8271
|
+
cookie?: never;
|
|
8272
|
+
};
|
|
8273
|
+
/**
|
|
8274
|
+
* Get trackProviders relationship ("to-many").
|
|
8275
|
+
* @description Retrieves trackProviders relationship.
|
|
8276
|
+
*/
|
|
8277
|
+
get: {
|
|
8278
|
+
parameters: {
|
|
8279
|
+
query?: {
|
|
8280
|
+
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
8281
|
+
"page[cursor]"?: string;
|
|
8282
|
+
/**
|
|
8283
|
+
* @description Allows the client to customize which related resources should be returned. Available options: trackProviders
|
|
8284
|
+
* @example trackProviders
|
|
8285
|
+
*/
|
|
8286
|
+
include?: string[];
|
|
8287
|
+
};
|
|
8288
|
+
header?: never;
|
|
8289
|
+
path: {
|
|
8290
|
+
/**
|
|
8291
|
+
* @description Artist id
|
|
8292
|
+
* @example 1566
|
|
8293
|
+
*/
|
|
8294
|
+
id: string;
|
|
8295
|
+
};
|
|
8296
|
+
cookie?: never;
|
|
8297
|
+
};
|
|
8298
|
+
requestBody?: never;
|
|
8299
|
+
responses: {
|
|
8300
|
+
/** @description Successful response */
|
|
8301
|
+
200: {
|
|
8302
|
+
headers: {
|
|
8303
|
+
[name: string]: unknown;
|
|
8304
|
+
};
|
|
8305
|
+
content: {
|
|
8306
|
+
"application/vnd.api+json": components["schemas"]["Artists_TrackProviders_Multi_Relationship_Data_Document"];
|
|
8307
|
+
};
|
|
8308
|
+
};
|
|
8309
|
+
400: components["responses"]["Default400Response"];
|
|
8310
|
+
404: components["responses"]["Default404Response"];
|
|
8311
|
+
405: components["responses"]["Default405Response"];
|
|
8312
|
+
406: components["responses"]["Default406Response"];
|
|
8313
|
+
415: components["responses"]["Default415Response"];
|
|
8314
|
+
429: components["responses"]["Default429Response"];
|
|
8315
|
+
500: components["responses"]["Default500Response"];
|
|
8316
|
+
503: components["responses"]["Default503Response"];
|
|
8317
|
+
};
|
|
8318
|
+
};
|
|
8319
|
+
put?: never;
|
|
8320
|
+
post?: never;
|
|
8321
|
+
delete?: never;
|
|
8322
|
+
options?: never;
|
|
8323
|
+
head?: never;
|
|
8324
|
+
patch?: never;
|
|
8325
|
+
trace?: never;
|
|
8326
|
+
};
|
|
8327
|
+
"/artists/{id}/relationships/tracks": {
|
|
8328
|
+
parameters: {
|
|
8329
|
+
query?: never;
|
|
8330
|
+
header?: never;
|
|
8331
|
+
path?: never;
|
|
8332
|
+
cookie?: never;
|
|
8333
|
+
};
|
|
8334
|
+
/**
|
|
8335
|
+
* Get tracks relationship ("to-many").
|
|
8336
|
+
* @description Retrieves tracks relationship.
|
|
8337
|
+
*/
|
|
8338
|
+
get: {
|
|
8339
|
+
parameters: {
|
|
8340
|
+
query: {
|
|
8341
|
+
/**
|
|
8342
|
+
* @description Collapse by options for getting artist tracks. Available options: FINGERPRINT, ID. FINGERPRINT option might collapse similar tracks based entry fingerprints while collapsing by ID always returns all available items.
|
|
8343
|
+
* @example FINGERPRINT
|
|
8344
|
+
*/
|
|
8345
|
+
collapseBy: "FINGERPRINT" | "NONE";
|
|
8346
|
+
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
8347
|
+
"page[cursor]"?: string;
|
|
8348
|
+
/**
|
|
8349
|
+
* @description ISO 3166-1 alpha-2 country code
|
|
8350
|
+
* @example US
|
|
8351
|
+
*/
|
|
8352
|
+
countryCode?: string;
|
|
8353
|
+
/**
|
|
8354
|
+
* @description Allows the client to customize which related resources should be returned. Available options: tracks
|
|
8355
|
+
* @example tracks
|
|
8356
|
+
*/
|
|
8357
|
+
include?: string[];
|
|
8358
|
+
};
|
|
8359
|
+
header?: never;
|
|
8360
|
+
path: {
|
|
8361
|
+
/**
|
|
8362
|
+
* @description Artist id
|
|
8363
|
+
* @example 1566
|
|
8364
|
+
*/
|
|
8365
|
+
id: string;
|
|
8366
|
+
};
|
|
8367
|
+
cookie?: never;
|
|
8368
|
+
};
|
|
8369
|
+
requestBody?: never;
|
|
8370
|
+
responses: {
|
|
8371
|
+
/** @description Successful response */
|
|
8372
|
+
200: {
|
|
8373
|
+
headers: {
|
|
8374
|
+
[name: string]: unknown;
|
|
8375
|
+
};
|
|
8376
|
+
content: {
|
|
8377
|
+
"application/vnd.api+json": components["schemas"]["Artists_Multi_Relationship_Data_Document"];
|
|
8378
|
+
};
|
|
8379
|
+
};
|
|
8380
|
+
400: components["responses"]["Default400Response"];
|
|
8381
|
+
404: components["responses"]["Default404Response"];
|
|
8382
|
+
405: components["responses"]["Default405Response"];
|
|
8383
|
+
406: components["responses"]["Default406Response"];
|
|
8384
|
+
415: components["responses"]["Default415Response"];
|
|
8385
|
+
429: components["responses"]["Default429Response"];
|
|
8386
|
+
500: components["responses"]["Default500Response"];
|
|
8387
|
+
503: components["responses"]["Default503Response"];
|
|
8388
|
+
};
|
|
8389
|
+
};
|
|
8390
|
+
put?: never;
|
|
8391
|
+
post?: never;
|
|
8392
|
+
delete?: never;
|
|
8393
|
+
options?: never;
|
|
8394
|
+
head?: never;
|
|
8395
|
+
patch?: never;
|
|
8396
|
+
trace?: never;
|
|
8397
|
+
};
|
|
8398
|
+
"/artists/{id}/relationships/videos": {
|
|
8399
|
+
parameters: {
|
|
8400
|
+
query?: never;
|
|
8401
|
+
header?: never;
|
|
8402
|
+
path?: never;
|
|
8403
|
+
cookie?: never;
|
|
8404
|
+
};
|
|
8405
|
+
/**
|
|
8406
|
+
* Get videos relationship ("to-many").
|
|
8407
|
+
* @description Retrieves videos relationship.
|
|
8408
|
+
*/
|
|
8409
|
+
get: {
|
|
8410
|
+
parameters: {
|
|
8411
|
+
query?: {
|
|
8412
|
+
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
8413
|
+
"page[cursor]"?: string;
|
|
8414
|
+
/**
|
|
8415
|
+
* @description ISO 3166-1 alpha-2 country code
|
|
8416
|
+
* @example US
|
|
8417
|
+
*/
|
|
8418
|
+
countryCode?: string;
|
|
8419
|
+
/**
|
|
8420
|
+
* @description Allows the client to customize which related resources should be returned. Available options: videos
|
|
8421
|
+
* @example videos
|
|
8422
|
+
*/
|
|
8423
|
+
include?: string[];
|
|
8424
|
+
};
|
|
8425
|
+
header?: never;
|
|
8426
|
+
path: {
|
|
8427
|
+
/**
|
|
8428
|
+
* @description Artist id
|
|
8429
|
+
* @example 1566
|
|
8430
|
+
*/
|
|
8431
|
+
id: string;
|
|
8432
|
+
};
|
|
8433
|
+
cookie?: never;
|
|
8434
|
+
};
|
|
8435
|
+
requestBody?: never;
|
|
8436
|
+
responses: {
|
|
8437
|
+
/** @description Successful response */
|
|
8438
|
+
200: {
|
|
8439
|
+
headers: {
|
|
8440
|
+
[name: string]: unknown;
|
|
8441
|
+
};
|
|
8442
|
+
content: {
|
|
8443
|
+
"application/vnd.api+json": components["schemas"]["Artists_Multi_Relationship_Data_Document"];
|
|
8444
|
+
};
|
|
8445
|
+
};
|
|
8446
|
+
400: components["responses"]["Default400Response"];
|
|
8447
|
+
404: components["responses"]["Default404Response"];
|
|
8448
|
+
405: components["responses"]["Default405Response"];
|
|
8449
|
+
406: components["responses"]["Default406Response"];
|
|
8450
|
+
415: components["responses"]["Default415Response"];
|
|
8451
|
+
429: components["responses"]["Default429Response"];
|
|
8452
|
+
500: components["responses"]["Default500Response"];
|
|
8453
|
+
503: components["responses"]["Default503Response"];
|
|
8454
|
+
};
|
|
8455
|
+
};
|
|
8456
|
+
put?: never;
|
|
8457
|
+
post?: never;
|
|
8458
|
+
delete?: never;
|
|
8459
|
+
options?: never;
|
|
8460
|
+
head?: never;
|
|
8461
|
+
patch?: never;
|
|
8462
|
+
trace?: never;
|
|
8463
|
+
};
|
|
8464
|
+
"/artworks": {
|
|
8465
|
+
parameters: {
|
|
8466
|
+
query?: never;
|
|
8467
|
+
header?: never;
|
|
8468
|
+
path?: never;
|
|
8469
|
+
cookie?: never;
|
|
8470
|
+
};
|
|
8471
|
+
/**
|
|
8472
|
+
* Get multiple artworks.
|
|
8473
|
+
* @description Retrieves multiple artworks by available filters, or without if applicable.
|
|
8474
|
+
*/
|
|
8475
|
+
get: {
|
|
8476
|
+
parameters: {
|
|
8477
|
+
query?: {
|
|
8478
|
+
/**
|
|
8479
|
+
* @description ISO 3166-1 alpha-2 country code
|
|
8480
|
+
* @example US
|
|
8481
|
+
*/
|
|
8482
|
+
countryCode?: string;
|
|
8483
|
+
/**
|
|
8484
|
+
* @description Allows the client to customize which related resources should be returned. Available options: owners
|
|
8485
|
+
* @example owners
|
|
8486
|
+
*/
|
|
8487
|
+
include?: string[];
|
|
8488
|
+
/** @description Artwork id (e.g. `a468bee88def`) */
|
|
8489
|
+
"filter[id]"?: string[];
|
|
8490
|
+
};
|
|
8491
|
+
header?: never;
|
|
8492
|
+
path?: never;
|
|
8493
|
+
cookie?: never;
|
|
8494
|
+
};
|
|
8495
|
+
requestBody?: never;
|
|
8496
|
+
responses: {
|
|
8497
|
+
/** @description Successful response */
|
|
8498
|
+
200: {
|
|
8499
|
+
headers: {
|
|
8500
|
+
[name: string]: unknown;
|
|
8501
|
+
};
|
|
8502
|
+
content: {
|
|
8503
|
+
"application/vnd.api+json": components["schemas"]["Artworks_Multi_Resource_Data_Document"];
|
|
7914
8504
|
};
|
|
7915
8505
|
};
|
|
7916
8506
|
400: components["responses"]["Default400Response"];
|
|
@@ -7924,75 +8514,54 @@ declare interface paths {
|
|
|
7924
8514
|
};
|
|
7925
8515
|
};
|
|
7926
8516
|
put?: never;
|
|
7927
|
-
post?: never;
|
|
7928
|
-
delete?: never;
|
|
7929
|
-
options?: never;
|
|
7930
|
-
head?: never;
|
|
7931
|
-
patch?: never;
|
|
7932
|
-
trace?: never;
|
|
7933
|
-
};
|
|
7934
|
-
"/artists/{id}/relationships/trackProviders": {
|
|
7935
|
-
parameters: {
|
|
7936
|
-
query?: never;
|
|
7937
|
-
header?: never;
|
|
7938
|
-
path?: never;
|
|
7939
|
-
cookie?: never;
|
|
7940
|
-
};
|
|
7941
8517
|
/**
|
|
7942
|
-
*
|
|
7943
|
-
* @description
|
|
8518
|
+
* Create single artwork.
|
|
8519
|
+
* @description Creates a new artwork.
|
|
7944
8520
|
*/
|
|
7945
|
-
|
|
8521
|
+
post: {
|
|
7946
8522
|
parameters: {
|
|
7947
|
-
query?:
|
|
7948
|
-
|
|
7949
|
-
|
|
7950
|
-
|
|
7951
|
-
* @description Allows the client to customize which related resources should be returned. Available options: trackProviders
|
|
7952
|
-
* @example trackProviders
|
|
7953
|
-
*/
|
|
7954
|
-
include?: string[];
|
|
7955
|
-
};
|
|
7956
|
-
header?: never;
|
|
7957
|
-
path: {
|
|
7958
|
-
/**
|
|
7959
|
-
* @description Artist id
|
|
7960
|
-
* @example 1566
|
|
7961
|
-
*/
|
|
7962
|
-
id: string;
|
|
8523
|
+
query?: never;
|
|
8524
|
+
header?: {
|
|
8525
|
+
/** @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. */
|
|
8526
|
+
"Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
|
|
7963
8527
|
};
|
|
8528
|
+
path?: never;
|
|
7964
8529
|
cookie?: never;
|
|
7965
8530
|
};
|
|
7966
|
-
requestBody?:
|
|
8531
|
+
requestBody?: {
|
|
8532
|
+
content: {
|
|
8533
|
+
"application/vnd.api+json": components["schemas"]["ArtworksCreateOperation_Payload"];
|
|
8534
|
+
};
|
|
8535
|
+
};
|
|
7967
8536
|
responses: {
|
|
7968
8537
|
/** @description Successful response */
|
|
7969
|
-
|
|
8538
|
+
201: {
|
|
7970
8539
|
headers: {
|
|
7971
8540
|
[name: string]: unknown;
|
|
7972
8541
|
};
|
|
7973
8542
|
content: {
|
|
7974
|
-
"application/vnd.api+json": components["schemas"]["
|
|
8543
|
+
"application/vnd.api+json": components["schemas"]["Artworks_Single_Resource_Data_Document"];
|
|
7975
8544
|
};
|
|
7976
8545
|
};
|
|
7977
8546
|
400: components["responses"]["Default400Response"];
|
|
7978
8547
|
404: components["responses"]["Default404Response"];
|
|
7979
8548
|
405: components["responses"]["Default405Response"];
|
|
7980
8549
|
406: components["responses"]["Default406Response"];
|
|
8550
|
+
409: components["responses"]["Idempotency409Response"];
|
|
7981
8551
|
415: components["responses"]["Default415Response"];
|
|
8552
|
+
422: components["responses"]["Idempotency422Response"];
|
|
7982
8553
|
429: components["responses"]["Default429Response"];
|
|
7983
8554
|
500: components["responses"]["Default500Response"];
|
|
7984
8555
|
503: components["responses"]["Default503Response"];
|
|
7985
8556
|
};
|
|
7986
8557
|
};
|
|
7987
|
-
put?: never;
|
|
7988
|
-
post?: never;
|
|
7989
8558
|
delete?: never;
|
|
7990
8559
|
options?: never;
|
|
7991
8560
|
head?: never;
|
|
7992
8561
|
patch?: never;
|
|
7993
8562
|
trace?: never;
|
|
7994
8563
|
};
|
|
7995
|
-
"/
|
|
8564
|
+
"/artworks/{id}": {
|
|
7996
8565
|
parameters: {
|
|
7997
8566
|
query?: never;
|
|
7998
8567
|
header?: never;
|
|
@@ -8000,35 +8569,28 @@ declare interface paths {
|
|
|
8000
8569
|
cookie?: never;
|
|
8001
8570
|
};
|
|
8002
8571
|
/**
|
|
8003
|
-
* Get
|
|
8004
|
-
* @description Retrieves
|
|
8572
|
+
* Get single artwork.
|
|
8573
|
+
* @description Retrieves single artwork by id.
|
|
8005
8574
|
*/
|
|
8006
8575
|
get: {
|
|
8007
8576
|
parameters: {
|
|
8008
|
-
query
|
|
8009
|
-
/**
|
|
8010
|
-
* @description Collapse by options for getting artist tracks. Available options: FINGERPRINT, ID. FINGERPRINT option might collapse similar tracks based entry fingerprints while collapsing by ID always returns all available items.
|
|
8011
|
-
* @example FINGERPRINT
|
|
8012
|
-
*/
|
|
8013
|
-
collapseBy: "FINGERPRINT" | "NONE";
|
|
8014
|
-
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
8015
|
-
"page[cursor]"?: string;
|
|
8577
|
+
query?: {
|
|
8016
8578
|
/**
|
|
8017
8579
|
* @description ISO 3166-1 alpha-2 country code
|
|
8018
8580
|
* @example US
|
|
8019
8581
|
*/
|
|
8020
8582
|
countryCode?: string;
|
|
8021
8583
|
/**
|
|
8022
|
-
* @description Allows the client to customize which related resources should be returned. Available options:
|
|
8023
|
-
* @example
|
|
8584
|
+
* @description Allows the client to customize which related resources should be returned. Available options: owners
|
|
8585
|
+
* @example owners
|
|
8024
8586
|
*/
|
|
8025
8587
|
include?: string[];
|
|
8026
8588
|
};
|
|
8027
8589
|
header?: never;
|
|
8028
8590
|
path: {
|
|
8029
8591
|
/**
|
|
8030
|
-
* @description
|
|
8031
|
-
* @example
|
|
8592
|
+
* @description Artwork id
|
|
8593
|
+
* @example a468bee88def
|
|
8032
8594
|
*/
|
|
8033
8595
|
id: string;
|
|
8034
8596
|
};
|
|
@@ -8042,7 +8604,7 @@ declare interface paths {
|
|
|
8042
8604
|
[name: string]: unknown;
|
|
8043
8605
|
};
|
|
8044
8606
|
content: {
|
|
8045
|
-
"application/vnd.api+json": components["schemas"]["
|
|
8607
|
+
"application/vnd.api+json": components["schemas"]["Artworks_Single_Resource_Data_Document"];
|
|
8046
8608
|
};
|
|
8047
8609
|
};
|
|
8048
8610
|
400: components["responses"]["Default400Response"];
|
|
@@ -8063,7 +8625,7 @@ declare interface paths {
|
|
|
8063
8625
|
patch?: never;
|
|
8064
8626
|
trace?: never;
|
|
8065
8627
|
};
|
|
8066
|
-
"/
|
|
8628
|
+
"/artworks/{id}/relationships/owners": {
|
|
8067
8629
|
parameters: {
|
|
8068
8630
|
query?: never;
|
|
8069
8631
|
header?: never;
|
|
@@ -8071,30 +8633,25 @@ declare interface paths {
|
|
|
8071
8633
|
cookie?: never;
|
|
8072
8634
|
};
|
|
8073
8635
|
/**
|
|
8074
|
-
* Get
|
|
8075
|
-
* @description Retrieves
|
|
8636
|
+
* Get owners relationship ("to-many").
|
|
8637
|
+
* @description Retrieves owners relationship.
|
|
8076
8638
|
*/
|
|
8077
8639
|
get: {
|
|
8078
8640
|
parameters: {
|
|
8079
8641
|
query?: {
|
|
8080
|
-
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
8081
|
-
"page[cursor]"?: string;
|
|
8082
|
-
/**
|
|
8083
|
-
* @description ISO 3166-1 alpha-2 country code
|
|
8084
|
-
* @example US
|
|
8085
|
-
*/
|
|
8086
|
-
countryCode?: string;
|
|
8087
8642
|
/**
|
|
8088
|
-
* @description Allows the client to customize which related resources should be returned. Available options:
|
|
8089
|
-
* @example
|
|
8643
|
+
* @description Allows the client to customize which related resources should be returned. Available options: owners
|
|
8644
|
+
* @example owners
|
|
8090
8645
|
*/
|
|
8091
8646
|
include?: string[];
|
|
8647
|
+
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
8648
|
+
"page[cursor]"?: string;
|
|
8092
8649
|
};
|
|
8093
8650
|
header?: never;
|
|
8094
8651
|
path: {
|
|
8095
8652
|
/**
|
|
8096
|
-
* @description
|
|
8097
|
-
* @example
|
|
8653
|
+
* @description Artwork id
|
|
8654
|
+
* @example a468bee88def
|
|
8098
8655
|
*/
|
|
8099
8656
|
id: string;
|
|
8100
8657
|
};
|
|
@@ -8108,7 +8665,7 @@ declare interface paths {
|
|
|
8108
8665
|
[name: string]: unknown;
|
|
8109
8666
|
};
|
|
8110
8667
|
content: {
|
|
8111
|
-
"application/vnd.api+json": components["schemas"]["
|
|
8668
|
+
"application/vnd.api+json": components["schemas"]["Artworks_Multi_Relationship_Data_Document"];
|
|
8112
8669
|
};
|
|
8113
8670
|
};
|
|
8114
8671
|
400: components["responses"]["Default400Response"];
|
|
@@ -8129,7 +8686,7 @@ declare interface paths {
|
|
|
8129
8686
|
patch?: never;
|
|
8130
8687
|
trace?: never;
|
|
8131
8688
|
};
|
|
8132
|
-
"/
|
|
8689
|
+
"/clients": {
|
|
8133
8690
|
parameters: {
|
|
8134
8691
|
query?: never;
|
|
8135
8692
|
header?: never;
|
|
@@ -8137,24 +8694,19 @@ declare interface paths {
|
|
|
8137
8694
|
cookie?: never;
|
|
8138
8695
|
};
|
|
8139
8696
|
/**
|
|
8140
|
-
* Get multiple
|
|
8141
|
-
* @description Retrieves multiple
|
|
8697
|
+
* Get multiple clients.
|
|
8698
|
+
* @description Retrieves multiple clients by available filters, or without if applicable.
|
|
8142
8699
|
*/
|
|
8143
8700
|
get: {
|
|
8144
8701
|
parameters: {
|
|
8145
8702
|
query?: {
|
|
8146
|
-
/**
|
|
8147
|
-
* @description ISO 3166-1 alpha-2 country code
|
|
8148
|
-
* @example US
|
|
8149
|
-
*/
|
|
8150
|
-
countryCode?: string;
|
|
8151
8703
|
/**
|
|
8152
8704
|
* @description Allows the client to customize which related resources should be returned. Available options: owners
|
|
8153
8705
|
* @example owners
|
|
8154
8706
|
*/
|
|
8155
8707
|
include?: string[];
|
|
8156
|
-
/** @description
|
|
8157
|
-
"filter[id]"?: string[];
|
|
8708
|
+
/** @description User id. Use `me` for the authenticated user */
|
|
8709
|
+
"filter[owners.id]"?: string[];
|
|
8158
8710
|
};
|
|
8159
8711
|
header?: never;
|
|
8160
8712
|
path?: never;
|
|
@@ -8168,7 +8720,7 @@ declare interface paths {
|
|
|
8168
8720
|
[name: string]: unknown;
|
|
8169
8721
|
};
|
|
8170
8722
|
content: {
|
|
8171
|
-
"application/vnd.api+json": components["schemas"]["
|
|
8723
|
+
"application/vnd.api+json": components["schemas"]["Clients_Multi_Resource_Data_Document"];
|
|
8172
8724
|
};
|
|
8173
8725
|
};
|
|
8174
8726
|
400: components["responses"]["Default400Response"];
|
|
@@ -8183,8 +8735,8 @@ declare interface paths {
|
|
|
8183
8735
|
};
|
|
8184
8736
|
put?: never;
|
|
8185
8737
|
/**
|
|
8186
|
-
* Create single
|
|
8187
|
-
* @description Creates a new
|
|
8738
|
+
* Create single client.
|
|
8739
|
+
* @description Creates a new client.
|
|
8188
8740
|
*/
|
|
8189
8741
|
post: {
|
|
8190
8742
|
parameters: {
|
|
@@ -8198,7 +8750,7 @@ declare interface paths {
|
|
|
8198
8750
|
};
|
|
8199
8751
|
requestBody?: {
|
|
8200
8752
|
content: {
|
|
8201
|
-
"application/vnd.api+json": components["schemas"]["
|
|
8753
|
+
"application/vnd.api+json": components["schemas"]["ClientsCreateOperation_Payload"];
|
|
8202
8754
|
};
|
|
8203
8755
|
};
|
|
8204
8756
|
responses: {
|
|
@@ -8208,7 +8760,7 @@ declare interface paths {
|
|
|
8208
8760
|
[name: string]: unknown;
|
|
8209
8761
|
};
|
|
8210
8762
|
content: {
|
|
8211
|
-
"application/vnd.api+json": components["schemas"]["
|
|
8763
|
+
"application/vnd.api+json": components["schemas"]["Clients_Single_Resource_Data_Document"];
|
|
8212
8764
|
};
|
|
8213
8765
|
};
|
|
8214
8766
|
400: components["responses"]["Default400Response"];
|
|
@@ -8229,7 +8781,7 @@ declare interface paths {
|
|
|
8229
8781
|
patch?: never;
|
|
8230
8782
|
trace?: never;
|
|
8231
8783
|
};
|
|
8232
|
-
"/
|
|
8784
|
+
"/clients/{id}": {
|
|
8233
8785
|
parameters: {
|
|
8234
8786
|
query?: never;
|
|
8235
8787
|
header?: never;
|
|
@@ -8237,17 +8789,12 @@ declare interface paths {
|
|
|
8237
8789
|
cookie?: never;
|
|
8238
8790
|
};
|
|
8239
8791
|
/**
|
|
8240
|
-
* Get single
|
|
8241
|
-
* @description Retrieves single
|
|
8792
|
+
* Get single client.
|
|
8793
|
+
* @description Retrieves single client by id.
|
|
8242
8794
|
*/
|
|
8243
8795
|
get: {
|
|
8244
8796
|
parameters: {
|
|
8245
8797
|
query?: {
|
|
8246
|
-
/**
|
|
8247
|
-
* @description ISO 3166-1 alpha-2 country code
|
|
8248
|
-
* @example US
|
|
8249
|
-
*/
|
|
8250
|
-
countryCode?: string;
|
|
8251
8798
|
/**
|
|
8252
8799
|
* @description Allows the client to customize which related resources should be returned. Available options: owners
|
|
8253
8800
|
* @example owners
|
|
@@ -8257,7 +8804,7 @@ declare interface paths {
|
|
|
8257
8804
|
header?: never;
|
|
8258
8805
|
path: {
|
|
8259
8806
|
/**
|
|
8260
|
-
* @description
|
|
8807
|
+
* @description OAuth client identifier
|
|
8261
8808
|
* @example a468bee88def
|
|
8262
8809
|
*/
|
|
8263
8810
|
id: string;
|
|
@@ -8272,7 +8819,7 @@ declare interface paths {
|
|
|
8272
8819
|
[name: string]: unknown;
|
|
8273
8820
|
};
|
|
8274
8821
|
content: {
|
|
8275
|
-
"application/vnd.api+json": components["schemas"]["
|
|
8822
|
+
"application/vnd.api+json": components["schemas"]["Clients_Single_Resource_Data_Document"];
|
|
8276
8823
|
};
|
|
8277
8824
|
};
|
|
8278
8825
|
400: components["responses"]["Default400Response"];
|
|
@@ -8287,13 +8834,83 @@ declare interface paths {
|
|
|
8287
8834
|
};
|
|
8288
8835
|
put?: never;
|
|
8289
8836
|
post?: never;
|
|
8290
|
-
|
|
8837
|
+
/**
|
|
8838
|
+
* Delete single client.
|
|
8839
|
+
* @description Deletes existing client.
|
|
8840
|
+
*/
|
|
8841
|
+
delete: {
|
|
8842
|
+
parameters: {
|
|
8843
|
+
query?: never;
|
|
8844
|
+
header?: {
|
|
8845
|
+
/** @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. */
|
|
8846
|
+
"Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
|
|
8847
|
+
};
|
|
8848
|
+
path: {
|
|
8849
|
+
/**
|
|
8850
|
+
* @description OAuth client identifier
|
|
8851
|
+
* @example a468bee88def
|
|
8852
|
+
*/
|
|
8853
|
+
id: string;
|
|
8854
|
+
};
|
|
8855
|
+
cookie?: never;
|
|
8856
|
+
};
|
|
8857
|
+
requestBody?: never;
|
|
8858
|
+
responses: {
|
|
8859
|
+
400: components["responses"]["Default400Response"];
|
|
8860
|
+
404: components["responses"]["Default404Response"];
|
|
8861
|
+
405: components["responses"]["Default405Response"];
|
|
8862
|
+
406: components["responses"]["Default406Response"];
|
|
8863
|
+
409: components["responses"]["Idempotency409Response"];
|
|
8864
|
+
415: components["responses"]["Default415Response"];
|
|
8865
|
+
422: components["responses"]["Idempotency422Response"];
|
|
8866
|
+
429: components["responses"]["Default429Response"];
|
|
8867
|
+
500: components["responses"]["Default500Response"];
|
|
8868
|
+
503: components["responses"]["Default503Response"];
|
|
8869
|
+
};
|
|
8870
|
+
};
|
|
8291
8871
|
options?: never;
|
|
8292
8872
|
head?: never;
|
|
8293
|
-
|
|
8873
|
+
/**
|
|
8874
|
+
* Update single client.
|
|
8875
|
+
* @description Updates existing client.
|
|
8876
|
+
*/
|
|
8877
|
+
patch: {
|
|
8878
|
+
parameters: {
|
|
8879
|
+
query?: never;
|
|
8880
|
+
header?: {
|
|
8881
|
+
/** @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. */
|
|
8882
|
+
"Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
|
|
8883
|
+
};
|
|
8884
|
+
path: {
|
|
8885
|
+
/**
|
|
8886
|
+
* @description OAuth client identifier
|
|
8887
|
+
* @example a468bee88def
|
|
8888
|
+
*/
|
|
8889
|
+
id: string;
|
|
8890
|
+
};
|
|
8891
|
+
cookie?: never;
|
|
8892
|
+
};
|
|
8893
|
+
requestBody?: {
|
|
8894
|
+
content: {
|
|
8895
|
+
"application/vnd.api+json": components["schemas"]["ClientsUpdateOperation_Payload"];
|
|
8896
|
+
};
|
|
8897
|
+
};
|
|
8898
|
+
responses: {
|
|
8899
|
+
400: components["responses"]["Default400Response"];
|
|
8900
|
+
404: components["responses"]["Default404Response"];
|
|
8901
|
+
405: components["responses"]["Default405Response"];
|
|
8902
|
+
406: components["responses"]["Default406Response"];
|
|
8903
|
+
409: components["responses"]["Idempotency409Response"];
|
|
8904
|
+
415: components["responses"]["Default415Response"];
|
|
8905
|
+
422: components["responses"]["Idempotency422Response"];
|
|
8906
|
+
429: components["responses"]["Default429Response"];
|
|
8907
|
+
500: components["responses"]["Default500Response"];
|
|
8908
|
+
503: components["responses"]["Default503Response"];
|
|
8909
|
+
};
|
|
8910
|
+
};
|
|
8294
8911
|
trace?: never;
|
|
8295
8912
|
};
|
|
8296
|
-
"/
|
|
8913
|
+
"/clients/{id}/relationships/owners": {
|
|
8297
8914
|
parameters: {
|
|
8298
8915
|
query?: never;
|
|
8299
8916
|
header?: never;
|
|
@@ -8318,7 +8935,7 @@ declare interface paths {
|
|
|
8318
8935
|
header?: never;
|
|
8319
8936
|
path: {
|
|
8320
8937
|
/**
|
|
8321
|
-
* @description
|
|
8938
|
+
* @description OAuth client identifier
|
|
8322
8939
|
* @example a468bee88def
|
|
8323
8940
|
*/
|
|
8324
8941
|
id: string;
|
|
@@ -8333,7 +8950,7 @@ declare interface paths {
|
|
|
8333
8950
|
[name: string]: unknown;
|
|
8334
8951
|
};
|
|
8335
8952
|
content: {
|
|
8336
|
-
"application/vnd.api+json": components["schemas"]["
|
|
8953
|
+
"application/vnd.api+json": components["schemas"]["Clients_Multi_Relationship_Data_Document"];
|
|
8337
8954
|
};
|
|
8338
8955
|
};
|
|
8339
8956
|
400: components["responses"]["Default400Response"];
|
|
@@ -19474,6 +20091,62 @@ declare interface paths {
|
|
|
19474
20091
|
patch?: never;
|
|
19475
20092
|
trace?: never;
|
|
19476
20093
|
};
|
|
20094
|
+
"/userDataExportRequests": {
|
|
20095
|
+
parameters: {
|
|
20096
|
+
query?: never;
|
|
20097
|
+
header?: never;
|
|
20098
|
+
path?: never;
|
|
20099
|
+
cookie?: never;
|
|
20100
|
+
};
|
|
20101
|
+
get?: never;
|
|
20102
|
+
put?: never;
|
|
20103
|
+
/**
|
|
20104
|
+
* Create single userDataExportRequest.
|
|
20105
|
+
* @description Creates a new userDataExportRequest.
|
|
20106
|
+
*/
|
|
20107
|
+
post: {
|
|
20108
|
+
parameters: {
|
|
20109
|
+
query?: never;
|
|
20110
|
+
header?: {
|
|
20111
|
+
/** @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. */
|
|
20112
|
+
"Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
|
|
20113
|
+
};
|
|
20114
|
+
path?: never;
|
|
20115
|
+
cookie?: never;
|
|
20116
|
+
};
|
|
20117
|
+
requestBody?: {
|
|
20118
|
+
content: {
|
|
20119
|
+
"application/vnd.api+json": components["schemas"]["UserDataExportRequestsCreateOperation_Payload"];
|
|
20120
|
+
};
|
|
20121
|
+
};
|
|
20122
|
+
responses: {
|
|
20123
|
+
/** @description Successful response */
|
|
20124
|
+
201: {
|
|
20125
|
+
headers: {
|
|
20126
|
+
[name: string]: unknown;
|
|
20127
|
+
};
|
|
20128
|
+
content: {
|
|
20129
|
+
"application/vnd.api+json": components["schemas"]["UserDataExportRequests_Single_Resource_Data_Document"];
|
|
20130
|
+
};
|
|
20131
|
+
};
|
|
20132
|
+
400: components["responses"]["Default400Response"];
|
|
20133
|
+
404: components["responses"]["Default404Response"];
|
|
20134
|
+
405: components["responses"]["Default405Response"];
|
|
20135
|
+
406: components["responses"]["Default406Response"];
|
|
20136
|
+
409: components["responses"]["Idempotency409Response"];
|
|
20137
|
+
415: components["responses"]["Default415Response"];
|
|
20138
|
+
422: components["responses"]["Idempotency422Response"];
|
|
20139
|
+
429: components["responses"]["Default429Response"];
|
|
20140
|
+
500: components["responses"]["Default500Response"];
|
|
20141
|
+
503: components["responses"]["Default503Response"];
|
|
20142
|
+
};
|
|
20143
|
+
};
|
|
20144
|
+
delete?: never;
|
|
20145
|
+
options?: never;
|
|
20146
|
+
head?: never;
|
|
20147
|
+
patch?: never;
|
|
20148
|
+
trace?: never;
|
|
20149
|
+
};
|
|
19477
20150
|
"/userRecommendations/{id}": {
|
|
19478
20151
|
parameters: {
|
|
19479
20152
|
query?: never;
|