@tidal-music/api 0.10.0 → 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 +576 -1
- package/package.json +4 -4
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"]["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"])[];
|
|
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: {
|
|
@@ -5012,6 +5142,166 @@ export declare function createAPIClient(credentialsProvider: CredentialsProvider
|
|
|
5012
5142
|
* Do not make direct changes to the file.
|
|
5013
5143
|
*/
|
|
5014
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
|
+
};
|
|
5015
5305
|
"/albumStatistics": {
|
|
5016
5306
|
parameters: {
|
|
5017
5307
|
query?: never;
|
|
@@ -8396,6 +8686,291 @@ declare interface paths {
|
|
|
8396
8686
|
patch?: never;
|
|
8397
8687
|
trace?: never;
|
|
8398
8688
|
};
|
|
8689
|
+
"/clients": {
|
|
8690
|
+
parameters: {
|
|
8691
|
+
query?: never;
|
|
8692
|
+
header?: never;
|
|
8693
|
+
path?: never;
|
|
8694
|
+
cookie?: never;
|
|
8695
|
+
};
|
|
8696
|
+
/**
|
|
8697
|
+
* Get multiple clients.
|
|
8698
|
+
* @description Retrieves multiple clients by available filters, or without if applicable.
|
|
8699
|
+
*/
|
|
8700
|
+
get: {
|
|
8701
|
+
parameters: {
|
|
8702
|
+
query?: {
|
|
8703
|
+
/**
|
|
8704
|
+
* @description Allows the client to customize which related resources should be returned. Available options: owners
|
|
8705
|
+
* @example owners
|
|
8706
|
+
*/
|
|
8707
|
+
include?: string[];
|
|
8708
|
+
/** @description User id. Use `me` for the authenticated user */
|
|
8709
|
+
"filter[owners.id]"?: string[];
|
|
8710
|
+
};
|
|
8711
|
+
header?: never;
|
|
8712
|
+
path?: never;
|
|
8713
|
+
cookie?: never;
|
|
8714
|
+
};
|
|
8715
|
+
requestBody?: never;
|
|
8716
|
+
responses: {
|
|
8717
|
+
/** @description Successful response */
|
|
8718
|
+
200: {
|
|
8719
|
+
headers: {
|
|
8720
|
+
[name: string]: unknown;
|
|
8721
|
+
};
|
|
8722
|
+
content: {
|
|
8723
|
+
"application/vnd.api+json": components["schemas"]["Clients_Multi_Resource_Data_Document"];
|
|
8724
|
+
};
|
|
8725
|
+
};
|
|
8726
|
+
400: components["responses"]["Default400Response"];
|
|
8727
|
+
404: components["responses"]["Default404Response"];
|
|
8728
|
+
405: components["responses"]["Default405Response"];
|
|
8729
|
+
406: components["responses"]["Default406Response"];
|
|
8730
|
+
415: components["responses"]["Default415Response"];
|
|
8731
|
+
429: components["responses"]["Default429Response"];
|
|
8732
|
+
500: components["responses"]["Default500Response"];
|
|
8733
|
+
503: components["responses"]["Default503Response"];
|
|
8734
|
+
};
|
|
8735
|
+
};
|
|
8736
|
+
put?: never;
|
|
8737
|
+
/**
|
|
8738
|
+
* Create single client.
|
|
8739
|
+
* @description Creates a new client.
|
|
8740
|
+
*/
|
|
8741
|
+
post: {
|
|
8742
|
+
parameters: {
|
|
8743
|
+
query?: never;
|
|
8744
|
+
header?: {
|
|
8745
|
+
/** @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. */
|
|
8746
|
+
"Idempotency-Key"?: components["parameters"]["IdempotencyKey"];
|
|
8747
|
+
};
|
|
8748
|
+
path?: never;
|
|
8749
|
+
cookie?: never;
|
|
8750
|
+
};
|
|
8751
|
+
requestBody?: {
|
|
8752
|
+
content: {
|
|
8753
|
+
"application/vnd.api+json": components["schemas"]["ClientsCreateOperation_Payload"];
|
|
8754
|
+
};
|
|
8755
|
+
};
|
|
8756
|
+
responses: {
|
|
8757
|
+
/** @description Successful response */
|
|
8758
|
+
201: {
|
|
8759
|
+
headers: {
|
|
8760
|
+
[name: string]: unknown;
|
|
8761
|
+
};
|
|
8762
|
+
content: {
|
|
8763
|
+
"application/vnd.api+json": components["schemas"]["Clients_Single_Resource_Data_Document"];
|
|
8764
|
+
};
|
|
8765
|
+
};
|
|
8766
|
+
400: components["responses"]["Default400Response"];
|
|
8767
|
+
404: components["responses"]["Default404Response"];
|
|
8768
|
+
405: components["responses"]["Default405Response"];
|
|
8769
|
+
406: components["responses"]["Default406Response"];
|
|
8770
|
+
409: components["responses"]["Idempotency409Response"];
|
|
8771
|
+
415: components["responses"]["Default415Response"];
|
|
8772
|
+
422: components["responses"]["Idempotency422Response"];
|
|
8773
|
+
429: components["responses"]["Default429Response"];
|
|
8774
|
+
500: components["responses"]["Default500Response"];
|
|
8775
|
+
503: components["responses"]["Default503Response"];
|
|
8776
|
+
};
|
|
8777
|
+
};
|
|
8778
|
+
delete?: never;
|
|
8779
|
+
options?: never;
|
|
8780
|
+
head?: never;
|
|
8781
|
+
patch?: never;
|
|
8782
|
+
trace?: never;
|
|
8783
|
+
};
|
|
8784
|
+
"/clients/{id}": {
|
|
8785
|
+
parameters: {
|
|
8786
|
+
query?: never;
|
|
8787
|
+
header?: never;
|
|
8788
|
+
path?: never;
|
|
8789
|
+
cookie?: never;
|
|
8790
|
+
};
|
|
8791
|
+
/**
|
|
8792
|
+
* Get single client.
|
|
8793
|
+
* @description Retrieves single client by id.
|
|
8794
|
+
*/
|
|
8795
|
+
get: {
|
|
8796
|
+
parameters: {
|
|
8797
|
+
query?: {
|
|
8798
|
+
/**
|
|
8799
|
+
* @description Allows the client to customize which related resources should be returned. Available options: owners
|
|
8800
|
+
* @example owners
|
|
8801
|
+
*/
|
|
8802
|
+
include?: string[];
|
|
8803
|
+
};
|
|
8804
|
+
header?: never;
|
|
8805
|
+
path: {
|
|
8806
|
+
/**
|
|
8807
|
+
* @description OAuth client identifier
|
|
8808
|
+
* @example a468bee88def
|
|
8809
|
+
*/
|
|
8810
|
+
id: string;
|
|
8811
|
+
};
|
|
8812
|
+
cookie?: never;
|
|
8813
|
+
};
|
|
8814
|
+
requestBody?: never;
|
|
8815
|
+
responses: {
|
|
8816
|
+
/** @description Successful response */
|
|
8817
|
+
200: {
|
|
8818
|
+
headers: {
|
|
8819
|
+
[name: string]: unknown;
|
|
8820
|
+
};
|
|
8821
|
+
content: {
|
|
8822
|
+
"application/vnd.api+json": components["schemas"]["Clients_Single_Resource_Data_Document"];
|
|
8823
|
+
};
|
|
8824
|
+
};
|
|
8825
|
+
400: components["responses"]["Default400Response"];
|
|
8826
|
+
404: components["responses"]["Default404Response"];
|
|
8827
|
+
405: components["responses"]["Default405Response"];
|
|
8828
|
+
406: components["responses"]["Default406Response"];
|
|
8829
|
+
415: components["responses"]["Default415Response"];
|
|
8830
|
+
429: components["responses"]["Default429Response"];
|
|
8831
|
+
500: components["responses"]["Default500Response"];
|
|
8832
|
+
503: components["responses"]["Default503Response"];
|
|
8833
|
+
};
|
|
8834
|
+
};
|
|
8835
|
+
put?: never;
|
|
8836
|
+
post?: never;
|
|
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
|
+
};
|
|
8871
|
+
options?: never;
|
|
8872
|
+
head?: never;
|
|
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
|
+
};
|
|
8911
|
+
trace?: never;
|
|
8912
|
+
};
|
|
8913
|
+
"/clients/{id}/relationships/owners": {
|
|
8914
|
+
parameters: {
|
|
8915
|
+
query?: never;
|
|
8916
|
+
header?: never;
|
|
8917
|
+
path?: never;
|
|
8918
|
+
cookie?: never;
|
|
8919
|
+
};
|
|
8920
|
+
/**
|
|
8921
|
+
* Get owners relationship ("to-many").
|
|
8922
|
+
* @description Retrieves owners relationship.
|
|
8923
|
+
*/
|
|
8924
|
+
get: {
|
|
8925
|
+
parameters: {
|
|
8926
|
+
query?: {
|
|
8927
|
+
/**
|
|
8928
|
+
* @description Allows the client to customize which related resources should be returned. Available options: owners
|
|
8929
|
+
* @example owners
|
|
8930
|
+
*/
|
|
8931
|
+
include?: string[];
|
|
8932
|
+
/** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
|
|
8933
|
+
"page[cursor]"?: string;
|
|
8934
|
+
};
|
|
8935
|
+
header?: never;
|
|
8936
|
+
path: {
|
|
8937
|
+
/**
|
|
8938
|
+
* @description OAuth client identifier
|
|
8939
|
+
* @example a468bee88def
|
|
8940
|
+
*/
|
|
8941
|
+
id: string;
|
|
8942
|
+
};
|
|
8943
|
+
cookie?: never;
|
|
8944
|
+
};
|
|
8945
|
+
requestBody?: never;
|
|
8946
|
+
responses: {
|
|
8947
|
+
/** @description Successful response */
|
|
8948
|
+
200: {
|
|
8949
|
+
headers: {
|
|
8950
|
+
[name: string]: unknown;
|
|
8951
|
+
};
|
|
8952
|
+
content: {
|
|
8953
|
+
"application/vnd.api+json": components["schemas"]["Clients_Multi_Relationship_Data_Document"];
|
|
8954
|
+
};
|
|
8955
|
+
};
|
|
8956
|
+
400: components["responses"]["Default400Response"];
|
|
8957
|
+
404: components["responses"]["Default404Response"];
|
|
8958
|
+
405: components["responses"]["Default405Response"];
|
|
8959
|
+
406: components["responses"]["Default406Response"];
|
|
8960
|
+
415: components["responses"]["Default415Response"];
|
|
8961
|
+
429: components["responses"]["Default429Response"];
|
|
8962
|
+
500: components["responses"]["Default500Response"];
|
|
8963
|
+
503: components["responses"]["Default503Response"];
|
|
8964
|
+
};
|
|
8965
|
+
};
|
|
8966
|
+
put?: never;
|
|
8967
|
+
post?: never;
|
|
8968
|
+
delete?: never;
|
|
8969
|
+
options?: never;
|
|
8970
|
+
head?: never;
|
|
8971
|
+
patch?: never;
|
|
8972
|
+
trace?: never;
|
|
8973
|
+
};
|
|
8399
8974
|
"/comments": {
|
|
8400
8975
|
parameters: {
|
|
8401
8976
|
query?: never;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tidal-music/api",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.11.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"files": [
|
|
6
6
|
"dist"
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
},
|
|
19
19
|
"dependencies": {
|
|
20
20
|
"openapi-fetch": "0.17.0",
|
|
21
|
-
"@tidal-music/api": "0.
|
|
21
|
+
"@tidal-music/api": "0.11.0"
|
|
22
22
|
},
|
|
23
23
|
"devDependencies": {
|
|
24
24
|
"@vitest/coverage-v8": "4.1.0",
|
|
@@ -28,8 +28,8 @@
|
|
|
28
28
|
"vite": "8.0.0",
|
|
29
29
|
"vite-plugin-dts": "4.5.4",
|
|
30
30
|
"vitest": "4.1.0",
|
|
31
|
-
"@tidal-music/
|
|
32
|
-
"@tidal-music/
|
|
31
|
+
"@tidal-music/auth": "^1.4.0",
|
|
32
|
+
"@tidal-music/common": "^0.2.0"
|
|
33
33
|
},
|
|
34
34
|
"scripts": {
|
|
35
35
|
"build": "vite build",
|