@veroxm/sdk 1.14.0 → 1.15.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/CHANGELOG.md +9 -0
- package/dist/client.d.ts +10 -0
- package/dist/client.js +9 -1
- package/dist/embed.d.ts +24 -2
- package/dist/embed.js +44 -1
- package/dist/errors.d.ts +7 -0
- package/dist/errors.js +4 -2
- package/dist/generated/api.d.ts +1054 -31
- package/dist/http.d.ts +2 -0
- package/dist/http.js +18 -1
- package/dist/index.d.ts +2 -0
- package/dist/index.js +2 -0
- package/dist/push.d.ts +32 -0
- package/dist/push.js +26 -0
- package/package.json +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -849,6 +849,281 @@ export interface paths {
|
|
|
849
849
|
patch?: never;
|
|
850
850
|
trace?: never;
|
|
851
851
|
};
|
|
852
|
+
"/projects/{uuid}/users": {
|
|
853
|
+
parameters: {
|
|
854
|
+
query?: never;
|
|
855
|
+
header?: never;
|
|
856
|
+
path?: never;
|
|
857
|
+
cookie?: never;
|
|
858
|
+
};
|
|
859
|
+
/**
|
|
860
|
+
* The app's people (users:admin keys)
|
|
861
|
+
* @description As Authentication > People lists them, newest first, up to 200 a page. `email` finds one address exactly; `search` looks in emails, usernames and names. A project key on your server (or the veroxm CLI): an end user's login answers 403 (`code: "key_required"`).
|
|
862
|
+
*/
|
|
863
|
+
get: operations["listAppUsers"];
|
|
864
|
+
put?: never;
|
|
865
|
+
post?: never;
|
|
866
|
+
delete?: never;
|
|
867
|
+
options?: never;
|
|
868
|
+
head?: never;
|
|
869
|
+
patch?: never;
|
|
870
|
+
trace?: never;
|
|
871
|
+
};
|
|
872
|
+
"/projects/{uuid}/users/invite": {
|
|
873
|
+
parameters: {
|
|
874
|
+
query?: never;
|
|
875
|
+
header?: never;
|
|
876
|
+
path?: never;
|
|
877
|
+
cookie?: never;
|
|
878
|
+
};
|
|
879
|
+
get?: never;
|
|
880
|
+
put?: never;
|
|
881
|
+
/**
|
|
882
|
+
* Invite someone (users:admin keys)
|
|
883
|
+
* @description An account with no password yet, and an email with a code to choose one. Someone who already has an account answers 409. In the activity log under the key's name.
|
|
884
|
+
*/
|
|
885
|
+
post: operations["inviteAppUser"];
|
|
886
|
+
delete?: never;
|
|
887
|
+
options?: never;
|
|
888
|
+
head?: never;
|
|
889
|
+
patch?: never;
|
|
890
|
+
trace?: never;
|
|
891
|
+
};
|
|
892
|
+
"/projects/{uuid}/users/invite/batch": {
|
|
893
|
+
parameters: {
|
|
894
|
+
query?: never;
|
|
895
|
+
header?: never;
|
|
896
|
+
path?: never;
|
|
897
|
+
cookie?: never;
|
|
898
|
+
};
|
|
899
|
+
get?: never;
|
|
900
|
+
put?: never;
|
|
901
|
+
/**
|
|
902
|
+
* Invite a list of people (users:admin keys)
|
|
903
|
+
* @description Up to 500, each on its own: one bad line doesn't hold up the rest, and someone who already has an account is skipped (not changed). `veroxm users invite --file staff.csv` sends a CSV this way.
|
|
904
|
+
*/
|
|
905
|
+
post: operations["inviteAppUsers"];
|
|
906
|
+
delete?: never;
|
|
907
|
+
options?: never;
|
|
908
|
+
head?: never;
|
|
909
|
+
patch?: never;
|
|
910
|
+
trace?: never;
|
|
911
|
+
};
|
|
912
|
+
"/projects/{uuid}/users/{idOrEmail}": {
|
|
913
|
+
parameters: {
|
|
914
|
+
query?: never;
|
|
915
|
+
header?: never;
|
|
916
|
+
path?: never;
|
|
917
|
+
cookie?: never;
|
|
918
|
+
};
|
|
919
|
+
/** One person, by id or email (users:admin keys) */
|
|
920
|
+
get: operations["getAppUser"];
|
|
921
|
+
put?: never;
|
|
922
|
+
post?: never;
|
|
923
|
+
delete?: never;
|
|
924
|
+
options?: never;
|
|
925
|
+
head?: never;
|
|
926
|
+
/**
|
|
927
|
+
* Change someone's roles, permissions or name, or turn the account off or on (users:admin keys)
|
|
928
|
+
* @description Roles are the project's (at least one once it has any). Turning an account off ends every session it has. In the activity log under the key's name.
|
|
929
|
+
*/
|
|
930
|
+
patch: operations["updateAppUser"];
|
|
931
|
+
trace?: never;
|
|
932
|
+
};
|
|
933
|
+
"/projects/{uuid}/users/{idOrEmail}/sign-out": {
|
|
934
|
+
parameters: {
|
|
935
|
+
query?: never;
|
|
936
|
+
header?: never;
|
|
937
|
+
path?: never;
|
|
938
|
+
cookie?: never;
|
|
939
|
+
};
|
|
940
|
+
get?: never;
|
|
941
|
+
put?: never;
|
|
942
|
+
/** Sign someone out on every device (users:admin keys) */
|
|
943
|
+
post: operations["signOutAppUser"];
|
|
944
|
+
delete?: never;
|
|
945
|
+
options?: never;
|
|
946
|
+
head?: never;
|
|
947
|
+
patch?: never;
|
|
948
|
+
trace?: never;
|
|
949
|
+
};
|
|
950
|
+
"/projects/{uuid}/push/devices": {
|
|
951
|
+
parameters: {
|
|
952
|
+
query?: never;
|
|
953
|
+
header?: never;
|
|
954
|
+
path?: never;
|
|
955
|
+
cookie?: never;
|
|
956
|
+
};
|
|
957
|
+
get?: never;
|
|
958
|
+
put?: never;
|
|
959
|
+
/**
|
|
960
|
+
* Register a device for push notifications (any key, or an end user)
|
|
961
|
+
* @description Again on every start of the app, and when its token, language, topics or marketing choice change. A signed-in end user's device is theirs: pushes to them reach it. The same token registered by someone else moves to them.
|
|
962
|
+
*/
|
|
963
|
+
post: operations["registerPushDevice"];
|
|
964
|
+
delete?: never;
|
|
965
|
+
options?: never;
|
|
966
|
+
head?: never;
|
|
967
|
+
patch?: never;
|
|
968
|
+
trace?: never;
|
|
969
|
+
};
|
|
970
|
+
"/projects/{uuid}/push/devices/unregister": {
|
|
971
|
+
parameters: {
|
|
972
|
+
query?: never;
|
|
973
|
+
header?: never;
|
|
974
|
+
path?: never;
|
|
975
|
+
cookie?: never;
|
|
976
|
+
};
|
|
977
|
+
get?: never;
|
|
978
|
+
put?: never;
|
|
979
|
+
/**
|
|
980
|
+
* Forget a device (signed out, or pushes turned off)
|
|
981
|
+
* @description An end user may forget their own device, or one nobody is signed in on.
|
|
982
|
+
*/
|
|
983
|
+
post: operations["unregisterPushDevice"];
|
|
984
|
+
delete?: never;
|
|
985
|
+
options?: never;
|
|
986
|
+
head?: never;
|
|
987
|
+
patch?: never;
|
|
988
|
+
trace?: never;
|
|
989
|
+
};
|
|
990
|
+
"/projects/{uuid}/push/messages": {
|
|
991
|
+
parameters: {
|
|
992
|
+
query?: never;
|
|
993
|
+
header?: never;
|
|
994
|
+
path?: never;
|
|
995
|
+
cookie?: never;
|
|
996
|
+
};
|
|
997
|
+
get?: never;
|
|
998
|
+
put?: never;
|
|
999
|
+
/**
|
|
1000
|
+
* Send a push notification (push:send keys)
|
|
1001
|
+
* @description Queued and answered at once with its id; delivered in the background through the project's Firebase project (Settings > Push notifications). An Idempotency-Key header queues the same push once. 503 `push_not_configured` without an account.
|
|
1002
|
+
*/
|
|
1003
|
+
post: operations["sendPush"];
|
|
1004
|
+
delete?: never;
|
|
1005
|
+
options?: never;
|
|
1006
|
+
head?: never;
|
|
1007
|
+
patch?: never;
|
|
1008
|
+
trace?: never;
|
|
1009
|
+
};
|
|
1010
|
+
"/projects/{uuid}/push/messages/{pushId}": {
|
|
1011
|
+
parameters: {
|
|
1012
|
+
query?: never;
|
|
1013
|
+
header?: never;
|
|
1014
|
+
path?: never;
|
|
1015
|
+
cookie?: never;
|
|
1016
|
+
};
|
|
1017
|
+
/**
|
|
1018
|
+
* What a push did (push:send keys)
|
|
1019
|
+
* @description Kept 30 days.
|
|
1020
|
+
*/
|
|
1021
|
+
get: operations["getPush"];
|
|
1022
|
+
put?: never;
|
|
1023
|
+
post?: never;
|
|
1024
|
+
delete?: never;
|
|
1025
|
+
options?: never;
|
|
1026
|
+
head?: never;
|
|
1027
|
+
patch?: never;
|
|
1028
|
+
trace?: never;
|
|
1029
|
+
};
|
|
1030
|
+
"/projects/{uuid}/database-connections": {
|
|
1031
|
+
parameters: {
|
|
1032
|
+
query?: never;
|
|
1033
|
+
header?: never;
|
|
1034
|
+
path?: never;
|
|
1035
|
+
cookie?: never;
|
|
1036
|
+
};
|
|
1037
|
+
/**
|
|
1038
|
+
* The project's connected databases (databases:admin keys)
|
|
1039
|
+
* @description By slug, with their address, status and when their schema was last read; never a password. `veroxm databases list`. A project key on your server or in CI: an end user's login answers 403 (`code: "key_required"`).
|
|
1040
|
+
*/
|
|
1041
|
+
get: operations["listDatabaseConnections"];
|
|
1042
|
+
put?: never;
|
|
1043
|
+
post?: never;
|
|
1044
|
+
delete?: never;
|
|
1045
|
+
options?: never;
|
|
1046
|
+
head?: never;
|
|
1047
|
+
patch?: never;
|
|
1048
|
+
trace?: never;
|
|
1049
|
+
};
|
|
1050
|
+
"/projects/{uuid}/database-connections/{slug}": {
|
|
1051
|
+
parameters: {
|
|
1052
|
+
query?: never;
|
|
1053
|
+
header?: never;
|
|
1054
|
+
path?: never;
|
|
1055
|
+
cookie?: never;
|
|
1056
|
+
};
|
|
1057
|
+
get?: never;
|
|
1058
|
+
/**
|
|
1059
|
+
* Connect a database by its slug, from a connection string (databases:admin keys)
|
|
1060
|
+
* @description Creates the connection, or points the existing one at the string's server and credentials (a rotation: its settings, tables and models stay). Then tests it unless `test: false`; a failed test is in the answer, not an error. In linked environments, pointing development or staging at production's database (or the reverse) answers 409 `shared_with_production` unless confirmed. `veroxm databases connect <slug>`.
|
|
1061
|
+
*/
|
|
1062
|
+
put: operations["connectDatabase"];
|
|
1063
|
+
post?: never;
|
|
1064
|
+
delete?: never;
|
|
1065
|
+
options?: never;
|
|
1066
|
+
head?: never;
|
|
1067
|
+
patch?: never;
|
|
1068
|
+
trace?: never;
|
|
1069
|
+
};
|
|
1070
|
+
"/projects/{uuid}/database-connections/{slug}/test": {
|
|
1071
|
+
parameters: {
|
|
1072
|
+
query?: never;
|
|
1073
|
+
header?: never;
|
|
1074
|
+
path?: never;
|
|
1075
|
+
cookie?: never;
|
|
1076
|
+
};
|
|
1077
|
+
get?: never;
|
|
1078
|
+
put?: never;
|
|
1079
|
+
/**
|
|
1080
|
+
* Test a connected database (databases:admin keys)
|
|
1081
|
+
* @description Connects, and reports the server's version and the round trip. A failure is `ok: false` with its reason.
|
|
1082
|
+
*/
|
|
1083
|
+
post: operations["testDatabaseConnection"];
|
|
1084
|
+
delete?: never;
|
|
1085
|
+
options?: never;
|
|
1086
|
+
head?: never;
|
|
1087
|
+
patch?: never;
|
|
1088
|
+
trace?: never;
|
|
1089
|
+
};
|
|
1090
|
+
"/projects/{uuid}/database-connections/{slug}/schema/refresh": {
|
|
1091
|
+
parameters: {
|
|
1092
|
+
query?: never;
|
|
1093
|
+
header?: never;
|
|
1094
|
+
path?: never;
|
|
1095
|
+
cookie?: never;
|
|
1096
|
+
};
|
|
1097
|
+
get?: never;
|
|
1098
|
+
put?: never;
|
|
1099
|
+
/**
|
|
1100
|
+
* Read a database's schema again, after a migration (databases:admin keys)
|
|
1101
|
+
* @description New tables and columns stay hidden until chosen; tables that are gone answer `table_missing`. What changed since the last review is in `drift`; `accept: true` marks it reviewed. A setup file's models are checked against this schema when pushed, so read it again before `veroxm push`. `veroxm databases refresh`.
|
|
1102
|
+
*/
|
|
1103
|
+
post: operations["refreshDatabaseSchema"];
|
|
1104
|
+
delete?: never;
|
|
1105
|
+
options?: never;
|
|
1106
|
+
head?: never;
|
|
1107
|
+
patch?: never;
|
|
1108
|
+
trace?: never;
|
|
1109
|
+
};
|
|
1110
|
+
"/projects/{uuid}/database-connections/{slug}/schema/reviewed": {
|
|
1111
|
+
parameters: {
|
|
1112
|
+
query?: never;
|
|
1113
|
+
header?: never;
|
|
1114
|
+
path?: never;
|
|
1115
|
+
cookie?: never;
|
|
1116
|
+
};
|
|
1117
|
+
get?: never;
|
|
1118
|
+
put?: never;
|
|
1119
|
+
/** Mark a database's schema changes reviewed (databases:admin keys) */
|
|
1120
|
+
post: operations["reviewDatabaseSchema"];
|
|
1121
|
+
delete?: never;
|
|
1122
|
+
options?: never;
|
|
1123
|
+
head?: never;
|
|
1124
|
+
patch?: never;
|
|
1125
|
+
trace?: never;
|
|
1126
|
+
};
|
|
852
1127
|
"/projects/{uuid}/storage/files": {
|
|
853
1128
|
parameters: {
|
|
854
1129
|
query?: never;
|
|
@@ -1582,10 +1857,26 @@ export type webhooks = Record<string, never>;
|
|
|
1582
1857
|
export interface components {
|
|
1583
1858
|
schemas: {
|
|
1584
1859
|
Error: {
|
|
1585
|
-
/** @description What went wrong, in
|
|
1860
|
+
/** @description What went wrong, in English, for the developer. Nest-generated errors (a malformed id) use it for the status name. */
|
|
1586
1861
|
error?: string | Record<string, never>;
|
|
1587
|
-
/** @description A stable code to branch on
|
|
1862
|
+
/** @description A stable code to branch on: the error's own (for example "access_denied", "invalid_credentials", "validation_failed"), or one for its status ("not_found", "rate_limited", "server_error"). */
|
|
1588
1863
|
code?: string;
|
|
1864
|
+
/** @description The words to show the app's user, in `locale`: the project's own (app translations, `errors.<code>`) or VeroXM's English and Arabic. The language is the `X-VeroXM-Locale` header, else `?locale=`, else the best of `Accept-Language`. */
|
|
1865
|
+
userMessage?: string;
|
|
1866
|
+
/** @description The language of `userMessage` (also the Content-Language header). */
|
|
1867
|
+
locale?: string;
|
|
1868
|
+
/** @description With code `validation_failed`: by field, what to show under it, in `locale` (a field's own message, when its rules set one). */
|
|
1869
|
+
fieldErrors?: {
|
|
1870
|
+
[key: string]: string;
|
|
1871
|
+
};
|
|
1872
|
+
/** @description With code `validation_failed`: each field's problem as a code (required, unique, email, length_max...) and its numbers, to word yourself. */
|
|
1873
|
+
problems?: {
|
|
1874
|
+
field: string;
|
|
1875
|
+
code: string;
|
|
1876
|
+
label?: string;
|
|
1877
|
+
params?: Record<string, never>;
|
|
1878
|
+
message?: string;
|
|
1879
|
+
}[];
|
|
1589
1880
|
/** @description Validation messages from the API framework. */
|
|
1590
1881
|
message?: string | string[];
|
|
1591
1882
|
/** @description Per-field problems, when a form or body has several. */
|
|
@@ -1945,37 +2236,303 @@ export interface components {
|
|
|
1945
2236
|
/** @constant */
|
|
1946
2237
|
success: true;
|
|
1947
2238
|
};
|
|
1948
|
-
|
|
1949
|
-
/** @description
|
|
1950
|
-
|
|
1951
|
-
|
|
1952
|
-
|
|
1953
|
-
|
|
1954
|
-
|
|
1955
|
-
|
|
1956
|
-
|
|
1957
|
-
|
|
1958
|
-
/**
|
|
1959
|
-
|
|
1960
|
-
/** Format: date-time */
|
|
1961
|
-
expiresAt: string | null;
|
|
1962
|
-
createdBy: {
|
|
1963
|
-
/** @enum {string} */
|
|
1964
|
-
kind: "function" | "key" | "grant" | "dashboard";
|
|
1965
|
-
name: string | null;
|
|
1966
|
-
};
|
|
2239
|
+
PushDevice: {
|
|
2240
|
+
/** @description The device's Firebase Cloud Messaging token (from the Firebase SDK in the app). */
|
|
2241
|
+
token: string;
|
|
2242
|
+
/** @enum {string} */
|
|
2243
|
+
platform: "android" | "ios" | "web";
|
|
2244
|
+
/** @description The language the app is in: pushes with text by language arrive in it. */
|
|
2245
|
+
locale?: string;
|
|
2246
|
+
appVersion?: string;
|
|
2247
|
+
/** @description The topics this device follows (up to 50), replacing the ones it had. */
|
|
2248
|
+
topics?: string[];
|
|
2249
|
+
/** @description The person agreed to marketing messages: only then do marketing pushes reach this device. */
|
|
2250
|
+
marketing?: boolean;
|
|
1967
2251
|
};
|
|
1968
|
-
|
|
1969
|
-
|
|
1970
|
-
|
|
1971
|
-
|
|
2252
|
+
PushDeviceRegistered: {
|
|
2253
|
+
/** @constant */
|
|
2254
|
+
registered: true;
|
|
2255
|
+
platform: string;
|
|
2256
|
+
/** @description Linked to the signed-in end user. */
|
|
2257
|
+
signedIn: boolean;
|
|
2258
|
+
topics: string[];
|
|
2259
|
+
marketing: boolean;
|
|
1972
2260
|
};
|
|
1973
|
-
|
|
1974
|
-
|
|
1975
|
-
|
|
1976
|
-
|
|
1977
|
-
|
|
1978
|
-
|
|
2261
|
+
PushDeviceToken: {
|
|
2262
|
+
token: string;
|
|
2263
|
+
};
|
|
2264
|
+
PushDeviceRemoved: {
|
|
2265
|
+
removed: boolean;
|
|
2266
|
+
};
|
|
2267
|
+
/** @description Text, or text by language ({ "en": "…", "ar": "…" }): each device gets its own language, else English, else the first. */
|
|
2268
|
+
PushText: string | {
|
|
2269
|
+
[key: string]: string;
|
|
2270
|
+
};
|
|
2271
|
+
PushMessageInput: {
|
|
2272
|
+
/** @description Who it is for: one account (id or email), up to 1000 accounts, an app role, a topic, up to 500 device tokens, or every device. */
|
|
2273
|
+
to: {
|
|
2274
|
+
user: number | string;
|
|
2275
|
+
} | {
|
|
2276
|
+
users: (number | string)[];
|
|
2277
|
+
} | {
|
|
2278
|
+
role: string;
|
|
2279
|
+
} | {
|
|
2280
|
+
topic: string;
|
|
2281
|
+
} | {
|
|
2282
|
+
devices: string[];
|
|
2283
|
+
} | {
|
|
2284
|
+
/** @enum {boolean} */
|
|
2285
|
+
all: true;
|
|
2286
|
+
};
|
|
2287
|
+
title: components["schemas"]["PushText"];
|
|
2288
|
+
body: components["schemas"]["PushText"];
|
|
2289
|
+
/** @description Values for your app (3000 bytes at most). */
|
|
2290
|
+
data?: {
|
|
2291
|
+
[key: string]: string;
|
|
2292
|
+
};
|
|
2293
|
+
/** @description Opened when it's tapped: https://…, a path in your app (/orders/42) or your app's own link (myapp://…). Also in data.link. */
|
|
2294
|
+
link?: string;
|
|
2295
|
+
image?: string;
|
|
2296
|
+
badge?: number;
|
|
2297
|
+
sound?: boolean;
|
|
2298
|
+
collapseKey?: string;
|
|
2299
|
+
ttlSeconds?: number;
|
|
2300
|
+
/** @enum {string} */
|
|
2301
|
+
priority?: "high" | "normal";
|
|
2302
|
+
/**
|
|
2303
|
+
* @description marketing: only devices whose person agreed.
|
|
2304
|
+
* @enum {string}
|
|
2305
|
+
*/
|
|
2306
|
+
kind?: "transactional" | "marketing";
|
|
2307
|
+
};
|
|
2308
|
+
PushQueued: {
|
|
2309
|
+
pushId: string;
|
|
2310
|
+
status: string;
|
|
2311
|
+
};
|
|
2312
|
+
PushStatus: {
|
|
2313
|
+
pushId: string;
|
|
2314
|
+
source?: string;
|
|
2315
|
+
/** @enum {string} */
|
|
2316
|
+
kind?: "transactional" | "marketing";
|
|
2317
|
+
/** @description Who it was for, in a line. */
|
|
2318
|
+
target?: string;
|
|
2319
|
+
title?: string;
|
|
2320
|
+
/** @enum {string} */
|
|
2321
|
+
status: "queued" | "sending" | "sent" | "partly" | "failed" | "no_devices";
|
|
2322
|
+
devices: number;
|
|
2323
|
+
sent: number;
|
|
2324
|
+
failed: number;
|
|
2325
|
+
/** @description Devices Firebase said are gone: deleted. */
|
|
2326
|
+
removed: number;
|
|
2327
|
+
error?: string | null;
|
|
2328
|
+
/** Format: date-time */
|
|
2329
|
+
createdAt?: string;
|
|
2330
|
+
/** Format: date-time */
|
|
2331
|
+
finishedAt?: string | null;
|
|
2332
|
+
};
|
|
2333
|
+
SchemaDrift: {
|
|
2334
|
+
addedTables: string[];
|
|
2335
|
+
removedTables: string[];
|
|
2336
|
+
addedColumns: {
|
|
2337
|
+
table: string;
|
|
2338
|
+
column: string;
|
|
2339
|
+
}[];
|
|
2340
|
+
removedColumns: {
|
|
2341
|
+
table: string;
|
|
2342
|
+
column: string;
|
|
2343
|
+
}[];
|
|
2344
|
+
changedColumns: {
|
|
2345
|
+
table: string;
|
|
2346
|
+
column: string;
|
|
2347
|
+
from: string;
|
|
2348
|
+
to: string;
|
|
2349
|
+
}[];
|
|
2350
|
+
};
|
|
2351
|
+
DatabaseConnection: {
|
|
2352
|
+
name: string;
|
|
2353
|
+
/** @description The name models, saved queries and keys use. The same in every environment. */
|
|
2354
|
+
slug: string;
|
|
2355
|
+
/** @enum {string} */
|
|
2356
|
+
engine: "postgres" | "mysql" | "oracle" | "sqlserver" | "mongodb";
|
|
2357
|
+
host: string;
|
|
2358
|
+
port: number;
|
|
2359
|
+
databaseName: string;
|
|
2360
|
+
schemaName: string;
|
|
2361
|
+
username: string;
|
|
2362
|
+
/** @enum {string} */
|
|
2363
|
+
sslMode: "disable" | "require" | "verify-full";
|
|
2364
|
+
hasSslCa?: boolean;
|
|
2365
|
+
statementTimeoutMs?: number;
|
|
2366
|
+
maxRows?: number;
|
|
2367
|
+
poolSize?: number;
|
|
2368
|
+
paused: boolean;
|
|
2369
|
+
/** @enum {string} */
|
|
2370
|
+
status: "untested" | "ok" | "error" | "drifted";
|
|
2371
|
+
lastError?: string | null;
|
|
2372
|
+
/** Format: date-time */
|
|
2373
|
+
lastCheckedAt?: string | null;
|
|
2374
|
+
serverVersion?: string | null;
|
|
2375
|
+
canWrite?: boolean | null;
|
|
2376
|
+
/** Format: date-time */
|
|
2377
|
+
schemaRefreshedAt?: string | null;
|
|
2378
|
+
tableCount: number;
|
|
2379
|
+
exposedTables?: number;
|
|
2380
|
+
drift: components["schemas"]["SchemaDrift"] | null;
|
|
2381
|
+
breakerOpen?: boolean;
|
|
2382
|
+
/** Format: date-time */
|
|
2383
|
+
createdAt?: string;
|
|
2384
|
+
/** Format: date-time */
|
|
2385
|
+
updatedAt?: string;
|
|
2386
|
+
/** @description After a connect: another environment reads the same database. */
|
|
2387
|
+
warnings?: string[];
|
|
2388
|
+
};
|
|
2389
|
+
DatabaseConnect: {
|
|
2390
|
+
/** @description The connection string: postgres://, mysql://, mariadb://, sqlserver://, mongodb:// or mongodb+srv://, JDBC, or an Oracle address. Its password is sealed and never answered. */
|
|
2391
|
+
url: string;
|
|
2392
|
+
/**
|
|
2393
|
+
* @description When the string doesn't say.
|
|
2394
|
+
* @enum {string}
|
|
2395
|
+
*/
|
|
2396
|
+
engine?: "postgres" | "mysql" | "oracle" | "sqlserver" | "mongodb";
|
|
2397
|
+
name?: string;
|
|
2398
|
+
/** @description The schema (Postgres, SQL Server, Oracle) or database (MySQL, MongoDB) the tables are in. */
|
|
2399
|
+
schemaName?: string;
|
|
2400
|
+
/**
|
|
2401
|
+
* @description When the string doesn't say (default require).
|
|
2402
|
+
* @enum {string}
|
|
2403
|
+
*/
|
|
2404
|
+
sslMode?: "disable" | "require" | "verify-full";
|
|
2405
|
+
/** @description A PEM CA certificate, for verify-full. */
|
|
2406
|
+
sslCa?: string;
|
|
2407
|
+
/** @description false: don't test it now. */
|
|
2408
|
+
test?: boolean;
|
|
2409
|
+
/** @description Confirms reading the same database as production from another environment (or the reverse); otherwise 409 `shared_with_production`. */
|
|
2410
|
+
allowSharedWithProduction?: boolean;
|
|
2411
|
+
};
|
|
2412
|
+
DatabaseTest: {
|
|
2413
|
+
ok: boolean;
|
|
2414
|
+
serverVersion?: string;
|
|
2415
|
+
latencyMs?: number;
|
|
2416
|
+
canWrite?: boolean;
|
|
2417
|
+
warnings?: string[];
|
|
2418
|
+
error?: string;
|
|
2419
|
+
code?: string;
|
|
2420
|
+
};
|
|
2421
|
+
DatabaseConnected: {
|
|
2422
|
+
created: boolean;
|
|
2423
|
+
connection: components["schemas"]["DatabaseConnection"];
|
|
2424
|
+
test: components["schemas"]["DatabaseTest"] | null;
|
|
2425
|
+
warnings: string[];
|
|
2426
|
+
};
|
|
2427
|
+
SchemaRefreshed: {
|
|
2428
|
+
tables: number;
|
|
2429
|
+
truncated: boolean;
|
|
2430
|
+
drift: components["schemas"]["SchemaDrift"] | null;
|
|
2431
|
+
/** @description The changes were marked reviewed (accept: true). */
|
|
2432
|
+
accepted: boolean;
|
|
2433
|
+
};
|
|
2434
|
+
SchemaReviewed: {
|
|
2435
|
+
/** @constant */
|
|
2436
|
+
reviewed: true;
|
|
2437
|
+
};
|
|
2438
|
+
AppUser: {
|
|
2439
|
+
id: number;
|
|
2440
|
+
/** @description The email for a person; a username for a device or credential. */
|
|
2441
|
+
username: string;
|
|
2442
|
+
email?: string | null;
|
|
2443
|
+
name?: string | null;
|
|
2444
|
+
roles?: string[];
|
|
2445
|
+
/** @description Their own permissions; their roles' come on top. */
|
|
2446
|
+
abilities: string[];
|
|
2447
|
+
emailVerified?: boolean;
|
|
2448
|
+
disabled?: boolean;
|
|
2449
|
+
/** @description Invited and not accepted yet. */
|
|
2450
|
+
invited?: boolean;
|
|
2451
|
+
/** @enum {string} */
|
|
2452
|
+
kind?: "person" | "device" | "credential" | "provider";
|
|
2453
|
+
/** Format: date-time */
|
|
2454
|
+
lastSignInAt?: string | null;
|
|
2455
|
+
/** Format: date-time */
|
|
2456
|
+
createdAt: string | null;
|
|
2457
|
+
/** @description An invitation email that didn't send. */
|
|
2458
|
+
warning?: string;
|
|
2459
|
+
};
|
|
2460
|
+
AppUserList: {
|
|
2461
|
+
items: components["schemas"]["AppUser"][];
|
|
2462
|
+
total: number;
|
|
2463
|
+
offset: number;
|
|
2464
|
+
limit: number;
|
|
2465
|
+
};
|
|
2466
|
+
AppUserInvite: {
|
|
2467
|
+
email: string;
|
|
2468
|
+
name?: string;
|
|
2469
|
+
/** @description Left out: the invite defaults for keys (inviteDefaults.api), else the sign-up defaults. */
|
|
2470
|
+
roles?: string[];
|
|
2471
|
+
/** @description Left out: as roles. */
|
|
2472
|
+
abilities?: string[];
|
|
2473
|
+
};
|
|
2474
|
+
AppUserBatchInvite: {
|
|
2475
|
+
/** @description 500 at most. */
|
|
2476
|
+
people: components["schemas"]["AppUserInvite"][];
|
|
2477
|
+
};
|
|
2478
|
+
AppUserBatchResult: {
|
|
2479
|
+
invited: components["schemas"]["AppUser"][];
|
|
2480
|
+
/** @description Already have an account, or listed twice: nothing changed for them. */
|
|
2481
|
+
skipped: {
|
|
2482
|
+
email: string;
|
|
2483
|
+
reason: string;
|
|
2484
|
+
}[];
|
|
2485
|
+
failed: {
|
|
2486
|
+
/** @description 1 for the first person. */
|
|
2487
|
+
line: number;
|
|
2488
|
+
email: string | null;
|
|
2489
|
+
error: string;
|
|
2490
|
+
}[];
|
|
2491
|
+
};
|
|
2492
|
+
AppUserChange: {
|
|
2493
|
+
/** @description Replaces their roles. */
|
|
2494
|
+
roles?: string[];
|
|
2495
|
+
/** @description Replaces their own permissions. */
|
|
2496
|
+
abilities?: string[];
|
|
2497
|
+
/** @description Turned off (every session ends) or on. */
|
|
2498
|
+
disabled?: boolean;
|
|
2499
|
+
name?: string | null;
|
|
2500
|
+
};
|
|
2501
|
+
SignedOut: {
|
|
2502
|
+
/** @constant */
|
|
2503
|
+
ok: true;
|
|
2504
|
+
};
|
|
2505
|
+
StoredFile: {
|
|
2506
|
+
/** @description f_… */
|
|
2507
|
+
id: string;
|
|
2508
|
+
name: string;
|
|
2509
|
+
/** @description "" when it isn't in one. */
|
|
2510
|
+
folder: string;
|
|
2511
|
+
/** @description What its bytes show it is; a data or text type its writer gave; else application/octet-stream. */
|
|
2512
|
+
contentType: string;
|
|
2513
|
+
size: number;
|
|
2514
|
+
sha256: string;
|
|
2515
|
+
/** Format: date-time */
|
|
2516
|
+
createdAt: string;
|
|
2517
|
+
/** Format: date-time */
|
|
2518
|
+
expiresAt: string | null;
|
|
2519
|
+
createdBy: {
|
|
2520
|
+
/** @enum {string} */
|
|
2521
|
+
kind: "function" | "key" | "grant" | "dashboard";
|
|
2522
|
+
name: string | null;
|
|
2523
|
+
};
|
|
2524
|
+
};
|
|
2525
|
+
StoredFilePage: {
|
|
2526
|
+
files: components["schemas"]["StoredFile"][];
|
|
2527
|
+
/** @description The last id: pass it as after for the next page. */
|
|
2528
|
+
next: string | null;
|
|
2529
|
+
};
|
|
2530
|
+
StoredFileUpload: {
|
|
2531
|
+
file: string;
|
|
2532
|
+
/** @description Instead of the uploaded file's own name. */
|
|
2533
|
+
name?: string;
|
|
2534
|
+
folder?: string;
|
|
2535
|
+
/** @description For a file whose bytes don't show its type: a data or text type. */
|
|
1979
2536
|
contentType?: string;
|
|
1980
2537
|
/** @description Removed after this long (60 to 31536000). */
|
|
1981
2538
|
keepSeconds?: number;
|
|
@@ -2407,6 +2964,8 @@ export interface components {
|
|
|
2407
2964
|
binary?: boolean;
|
|
2408
2965
|
/** @description A file: returned as a signed link `{ url, expiresAt }` (GET /projects/{uuid}/files/{token}) or null, never its bytes. */
|
|
2409
2966
|
file?: boolean;
|
|
2967
|
+
/** @description A personal field looked up by its whole value, any case: `where: [{ field: { equals: "..." } }]`, and no other filter. */
|
|
2968
|
+
exactSearch?: boolean;
|
|
2410
2969
|
/** @description The values an ENUM column lists. */
|
|
2411
2970
|
values?: string[];
|
|
2412
2971
|
};
|
|
@@ -2715,6 +3274,8 @@ export interface components {
|
|
|
2715
3274
|
};
|
|
2716
3275
|
/** @description The language the person saw: the definition's `locale` or one of its `translations`. Error messages come back in it. */
|
|
2717
3276
|
locale?: string;
|
|
3277
|
+
/** @description Answered in a survey card: the `vx_survey` token the card opened the form with. Links the response to its survey, test and variant. */
|
|
3278
|
+
survey?: string;
|
|
2718
3279
|
};
|
|
2719
3280
|
FormResponseResult: {
|
|
2720
3281
|
/** @description The response id (r_...). */
|
|
@@ -4903,6 +5464,468 @@ export interface operations {
|
|
|
4903
5464
|
504: components["responses"]["E504"];
|
|
4904
5465
|
};
|
|
4905
5466
|
};
|
|
5467
|
+
listAppUsers: {
|
|
5468
|
+
parameters: {
|
|
5469
|
+
query?: {
|
|
5470
|
+
search?: string;
|
|
5471
|
+
email?: string;
|
|
5472
|
+
status?: "active" | "disabled" | "unverified";
|
|
5473
|
+
role?: string;
|
|
5474
|
+
offset?: number;
|
|
5475
|
+
limit?: number;
|
|
5476
|
+
};
|
|
5477
|
+
header?: never;
|
|
5478
|
+
path: {
|
|
5479
|
+
/** @description The project's UUID. */
|
|
5480
|
+
uuid: string;
|
|
5481
|
+
};
|
|
5482
|
+
cookie?: never;
|
|
5483
|
+
};
|
|
5484
|
+
requestBody?: never;
|
|
5485
|
+
responses: {
|
|
5486
|
+
/** @description OK */
|
|
5487
|
+
200: {
|
|
5488
|
+
headers: {
|
|
5489
|
+
[name: string]: unknown;
|
|
5490
|
+
};
|
|
5491
|
+
content: {
|
|
5492
|
+
"application/json": components["schemas"]["AppUserList"];
|
|
5493
|
+
};
|
|
5494
|
+
};
|
|
5495
|
+
401: components["responses"]["E401"];
|
|
5496
|
+
403: components["responses"]["E403"];
|
|
5497
|
+
404: components["responses"]["E404"];
|
|
5498
|
+
429: components["responses"]["E429"];
|
|
5499
|
+
};
|
|
5500
|
+
};
|
|
5501
|
+
inviteAppUser: {
|
|
5502
|
+
parameters: {
|
|
5503
|
+
query?: never;
|
|
5504
|
+
header?: never;
|
|
5505
|
+
path: {
|
|
5506
|
+
/** @description The project's UUID. */
|
|
5507
|
+
uuid: string;
|
|
5508
|
+
};
|
|
5509
|
+
cookie?: never;
|
|
5510
|
+
};
|
|
5511
|
+
requestBody: {
|
|
5512
|
+
content: {
|
|
5513
|
+
"application/json": components["schemas"]["AppUserInvite"];
|
|
5514
|
+
};
|
|
5515
|
+
};
|
|
5516
|
+
responses: {
|
|
5517
|
+
/** @description Invited */
|
|
5518
|
+
201: {
|
|
5519
|
+
headers: {
|
|
5520
|
+
[name: string]: unknown;
|
|
5521
|
+
};
|
|
5522
|
+
content: {
|
|
5523
|
+
"application/json": components["schemas"]["AppUser"];
|
|
5524
|
+
};
|
|
5525
|
+
};
|
|
5526
|
+
400: components["responses"]["E400"];
|
|
5527
|
+
401: components["responses"]["E401"];
|
|
5528
|
+
403: components["responses"]["E403"];
|
|
5529
|
+
404: components["responses"]["E404"];
|
|
5530
|
+
409: components["responses"]["E409"];
|
|
5531
|
+
429: components["responses"]["E429"];
|
|
5532
|
+
};
|
|
5533
|
+
};
|
|
5534
|
+
inviteAppUsers: {
|
|
5535
|
+
parameters: {
|
|
5536
|
+
query?: never;
|
|
5537
|
+
header?: never;
|
|
5538
|
+
path: {
|
|
5539
|
+
/** @description The project's UUID. */
|
|
5540
|
+
uuid: string;
|
|
5541
|
+
};
|
|
5542
|
+
cookie?: never;
|
|
5543
|
+
};
|
|
5544
|
+
requestBody: {
|
|
5545
|
+
content: {
|
|
5546
|
+
"application/json": components["schemas"]["AppUserBatchInvite"];
|
|
5547
|
+
};
|
|
5548
|
+
};
|
|
5549
|
+
responses: {
|
|
5550
|
+
/** @description OK */
|
|
5551
|
+
200: {
|
|
5552
|
+
headers: {
|
|
5553
|
+
[name: string]: unknown;
|
|
5554
|
+
};
|
|
5555
|
+
content: {
|
|
5556
|
+
"application/json": components["schemas"]["AppUserBatchResult"];
|
|
5557
|
+
};
|
|
5558
|
+
};
|
|
5559
|
+
400: components["responses"]["E400"];
|
|
5560
|
+
401: components["responses"]["E401"];
|
|
5561
|
+
403: components["responses"]["E403"];
|
|
5562
|
+
404: components["responses"]["E404"];
|
|
5563
|
+
429: components["responses"]["E429"];
|
|
5564
|
+
};
|
|
5565
|
+
};
|
|
5566
|
+
getAppUser: {
|
|
5567
|
+
parameters: {
|
|
5568
|
+
query?: never;
|
|
5569
|
+
header?: never;
|
|
5570
|
+
path: {
|
|
5571
|
+
/** @description The project's UUID. */
|
|
5572
|
+
uuid: string;
|
|
5573
|
+
idOrEmail: string;
|
|
5574
|
+
};
|
|
5575
|
+
cookie?: never;
|
|
5576
|
+
};
|
|
5577
|
+
requestBody?: never;
|
|
5578
|
+
responses: {
|
|
5579
|
+
/** @description OK */
|
|
5580
|
+
200: {
|
|
5581
|
+
headers: {
|
|
5582
|
+
[name: string]: unknown;
|
|
5583
|
+
};
|
|
5584
|
+
content: {
|
|
5585
|
+
"application/json": components["schemas"]["AppUser"];
|
|
5586
|
+
};
|
|
5587
|
+
};
|
|
5588
|
+
401: components["responses"]["E401"];
|
|
5589
|
+
403: components["responses"]["E403"];
|
|
5590
|
+
404: components["responses"]["E404"];
|
|
5591
|
+
429: components["responses"]["E429"];
|
|
5592
|
+
};
|
|
5593
|
+
};
|
|
5594
|
+
updateAppUser: {
|
|
5595
|
+
parameters: {
|
|
5596
|
+
query?: never;
|
|
5597
|
+
header?: never;
|
|
5598
|
+
path: {
|
|
5599
|
+
/** @description The project's UUID. */
|
|
5600
|
+
uuid: string;
|
|
5601
|
+
idOrEmail: string;
|
|
5602
|
+
};
|
|
5603
|
+
cookie?: never;
|
|
5604
|
+
};
|
|
5605
|
+
requestBody: {
|
|
5606
|
+
content: {
|
|
5607
|
+
"application/json": components["schemas"]["AppUserChange"];
|
|
5608
|
+
};
|
|
5609
|
+
};
|
|
5610
|
+
responses: {
|
|
5611
|
+
/** @description OK */
|
|
5612
|
+
200: {
|
|
5613
|
+
headers: {
|
|
5614
|
+
[name: string]: unknown;
|
|
5615
|
+
};
|
|
5616
|
+
content: {
|
|
5617
|
+
"application/json": components["schemas"]["AppUser"];
|
|
5618
|
+
};
|
|
5619
|
+
};
|
|
5620
|
+
400: components["responses"]["E400"];
|
|
5621
|
+
401: components["responses"]["E401"];
|
|
5622
|
+
403: components["responses"]["E403"];
|
|
5623
|
+
404: components["responses"]["E404"];
|
|
5624
|
+
429: components["responses"]["E429"];
|
|
5625
|
+
};
|
|
5626
|
+
};
|
|
5627
|
+
signOutAppUser: {
|
|
5628
|
+
parameters: {
|
|
5629
|
+
query?: never;
|
|
5630
|
+
header?: never;
|
|
5631
|
+
path: {
|
|
5632
|
+
/** @description The project's UUID. */
|
|
5633
|
+
uuid: string;
|
|
5634
|
+
idOrEmail: string;
|
|
5635
|
+
};
|
|
5636
|
+
cookie?: never;
|
|
5637
|
+
};
|
|
5638
|
+
requestBody?: never;
|
|
5639
|
+
responses: {
|
|
5640
|
+
/** @description OK */
|
|
5641
|
+
200: {
|
|
5642
|
+
headers: {
|
|
5643
|
+
[name: string]: unknown;
|
|
5644
|
+
};
|
|
5645
|
+
content: {
|
|
5646
|
+
"application/json": components["schemas"]["SignedOut"];
|
|
5647
|
+
};
|
|
5648
|
+
};
|
|
5649
|
+
401: components["responses"]["E401"];
|
|
5650
|
+
403: components["responses"]["E403"];
|
|
5651
|
+
404: components["responses"]["E404"];
|
|
5652
|
+
429: components["responses"]["E429"];
|
|
5653
|
+
};
|
|
5654
|
+
};
|
|
5655
|
+
registerPushDevice: {
|
|
5656
|
+
parameters: {
|
|
5657
|
+
query?: never;
|
|
5658
|
+
header?: never;
|
|
5659
|
+
path: {
|
|
5660
|
+
/** @description The project's UUID. */
|
|
5661
|
+
uuid: string;
|
|
5662
|
+
};
|
|
5663
|
+
cookie?: never;
|
|
5664
|
+
};
|
|
5665
|
+
requestBody: {
|
|
5666
|
+
content: {
|
|
5667
|
+
"application/json": components["schemas"]["PushDevice"];
|
|
5668
|
+
};
|
|
5669
|
+
};
|
|
5670
|
+
responses: {
|
|
5671
|
+
/** @description OK */
|
|
5672
|
+
200: {
|
|
5673
|
+
headers: {
|
|
5674
|
+
[name: string]: unknown;
|
|
5675
|
+
};
|
|
5676
|
+
content: {
|
|
5677
|
+
"application/json": components["schemas"]["PushDeviceRegistered"];
|
|
5678
|
+
};
|
|
5679
|
+
};
|
|
5680
|
+
400: components["responses"]["E400"];
|
|
5681
|
+
401: components["responses"]["E401"];
|
|
5682
|
+
429: components["responses"]["E429"];
|
|
5683
|
+
};
|
|
5684
|
+
};
|
|
5685
|
+
unregisterPushDevice: {
|
|
5686
|
+
parameters: {
|
|
5687
|
+
query?: never;
|
|
5688
|
+
header?: never;
|
|
5689
|
+
path: {
|
|
5690
|
+
/** @description The project's UUID. */
|
|
5691
|
+
uuid: string;
|
|
5692
|
+
};
|
|
5693
|
+
cookie?: never;
|
|
5694
|
+
};
|
|
5695
|
+
requestBody: {
|
|
5696
|
+
content: {
|
|
5697
|
+
"application/json": components["schemas"]["PushDeviceToken"];
|
|
5698
|
+
};
|
|
5699
|
+
};
|
|
5700
|
+
responses: {
|
|
5701
|
+
/** @description OK */
|
|
5702
|
+
200: {
|
|
5703
|
+
headers: {
|
|
5704
|
+
[name: string]: unknown;
|
|
5705
|
+
};
|
|
5706
|
+
content: {
|
|
5707
|
+
"application/json": components["schemas"]["PushDeviceRemoved"];
|
|
5708
|
+
};
|
|
5709
|
+
};
|
|
5710
|
+
400: components["responses"]["E400"];
|
|
5711
|
+
401: components["responses"]["E401"];
|
|
5712
|
+
403: components["responses"]["E403"];
|
|
5713
|
+
429: components["responses"]["E429"];
|
|
5714
|
+
};
|
|
5715
|
+
};
|
|
5716
|
+
sendPush: {
|
|
5717
|
+
parameters: {
|
|
5718
|
+
query?: never;
|
|
5719
|
+
header?: never;
|
|
5720
|
+
path: {
|
|
5721
|
+
/** @description The project's UUID. */
|
|
5722
|
+
uuid: string;
|
|
5723
|
+
};
|
|
5724
|
+
cookie?: never;
|
|
5725
|
+
};
|
|
5726
|
+
requestBody: {
|
|
5727
|
+
content: {
|
|
5728
|
+
"application/json": components["schemas"]["PushMessageInput"];
|
|
5729
|
+
};
|
|
5730
|
+
};
|
|
5731
|
+
responses: {
|
|
5732
|
+
/** @description Queued */
|
|
5733
|
+
202: {
|
|
5734
|
+
headers: {
|
|
5735
|
+
[name: string]: unknown;
|
|
5736
|
+
};
|
|
5737
|
+
content: {
|
|
5738
|
+
"application/json": components["schemas"]["PushQueued"];
|
|
5739
|
+
};
|
|
5740
|
+
};
|
|
5741
|
+
400: components["responses"]["E400"];
|
|
5742
|
+
401: components["responses"]["E401"];
|
|
5743
|
+
403: components["responses"]["E403"];
|
|
5744
|
+
429: components["responses"]["E429"];
|
|
5745
|
+
503: components["responses"]["E503"];
|
|
5746
|
+
};
|
|
5747
|
+
};
|
|
5748
|
+
getPush: {
|
|
5749
|
+
parameters: {
|
|
5750
|
+
query?: never;
|
|
5751
|
+
header?: never;
|
|
5752
|
+
path: {
|
|
5753
|
+
/** @description The project's UUID. */
|
|
5754
|
+
uuid: string;
|
|
5755
|
+
pushId: string;
|
|
5756
|
+
};
|
|
5757
|
+
cookie?: never;
|
|
5758
|
+
};
|
|
5759
|
+
requestBody?: never;
|
|
5760
|
+
responses: {
|
|
5761
|
+
/** @description OK */
|
|
5762
|
+
200: {
|
|
5763
|
+
headers: {
|
|
5764
|
+
[name: string]: unknown;
|
|
5765
|
+
};
|
|
5766
|
+
content: {
|
|
5767
|
+
"application/json": components["schemas"]["PushStatus"];
|
|
5768
|
+
};
|
|
5769
|
+
};
|
|
5770
|
+
400: components["responses"]["E400"];
|
|
5771
|
+
401: components["responses"]["E401"];
|
|
5772
|
+
403: components["responses"]["E403"];
|
|
5773
|
+
404: components["responses"]["E404"];
|
|
5774
|
+
429: components["responses"]["E429"];
|
|
5775
|
+
};
|
|
5776
|
+
};
|
|
5777
|
+
listDatabaseConnections: {
|
|
5778
|
+
parameters: {
|
|
5779
|
+
query?: never;
|
|
5780
|
+
header?: never;
|
|
5781
|
+
path: {
|
|
5782
|
+
/** @description The project's UUID. */
|
|
5783
|
+
uuid: string;
|
|
5784
|
+
};
|
|
5785
|
+
cookie?: never;
|
|
5786
|
+
};
|
|
5787
|
+
requestBody?: never;
|
|
5788
|
+
responses: {
|
|
5789
|
+
/** @description OK */
|
|
5790
|
+
200: {
|
|
5791
|
+
headers: {
|
|
5792
|
+
[name: string]: unknown;
|
|
5793
|
+
};
|
|
5794
|
+
content: {
|
|
5795
|
+
"application/json": components["schemas"]["DatabaseConnection"][];
|
|
5796
|
+
};
|
|
5797
|
+
};
|
|
5798
|
+
401: components["responses"]["E401"];
|
|
5799
|
+
403: components["responses"]["E403"];
|
|
5800
|
+
404: components["responses"]["E404"];
|
|
5801
|
+
429: components["responses"]["E429"];
|
|
5802
|
+
};
|
|
5803
|
+
};
|
|
5804
|
+
connectDatabase: {
|
|
5805
|
+
parameters: {
|
|
5806
|
+
query?: never;
|
|
5807
|
+
header?: never;
|
|
5808
|
+
path: {
|
|
5809
|
+
/** @description The project's UUID. */
|
|
5810
|
+
uuid: string;
|
|
5811
|
+
slug: string;
|
|
5812
|
+
};
|
|
5813
|
+
cookie?: never;
|
|
5814
|
+
};
|
|
5815
|
+
requestBody: {
|
|
5816
|
+
content: {
|
|
5817
|
+
"application/json": components["schemas"]["DatabaseConnect"];
|
|
5818
|
+
};
|
|
5819
|
+
};
|
|
5820
|
+
responses: {
|
|
5821
|
+
/** @description OK */
|
|
5822
|
+
200: {
|
|
5823
|
+
headers: {
|
|
5824
|
+
[name: string]: unknown;
|
|
5825
|
+
};
|
|
5826
|
+
content: {
|
|
5827
|
+
"application/json": components["schemas"]["DatabaseConnected"];
|
|
5828
|
+
};
|
|
5829
|
+
};
|
|
5830
|
+
400: components["responses"]["E400"];
|
|
5831
|
+
401: components["responses"]["E401"];
|
|
5832
|
+
403: components["responses"]["E403"];
|
|
5833
|
+
404: components["responses"]["E404"];
|
|
5834
|
+
409: components["responses"]["E409"];
|
|
5835
|
+
429: components["responses"]["E429"];
|
|
5836
|
+
};
|
|
5837
|
+
};
|
|
5838
|
+
testDatabaseConnection: {
|
|
5839
|
+
parameters: {
|
|
5840
|
+
query?: never;
|
|
5841
|
+
header?: never;
|
|
5842
|
+
path: {
|
|
5843
|
+
/** @description The project's UUID. */
|
|
5844
|
+
uuid: string;
|
|
5845
|
+
slug: string;
|
|
5846
|
+
};
|
|
5847
|
+
cookie?: never;
|
|
5848
|
+
};
|
|
5849
|
+
requestBody?: never;
|
|
5850
|
+
responses: {
|
|
5851
|
+
/** @description OK */
|
|
5852
|
+
200: {
|
|
5853
|
+
headers: {
|
|
5854
|
+
[name: string]: unknown;
|
|
5855
|
+
};
|
|
5856
|
+
content: {
|
|
5857
|
+
"application/json": components["schemas"]["DatabaseTest"];
|
|
5858
|
+
};
|
|
5859
|
+
};
|
|
5860
|
+
401: components["responses"]["E401"];
|
|
5861
|
+
403: components["responses"]["E403"];
|
|
5862
|
+
404: components["responses"]["E404"];
|
|
5863
|
+
429: components["responses"]["E429"];
|
|
5864
|
+
};
|
|
5865
|
+
};
|
|
5866
|
+
refreshDatabaseSchema: {
|
|
5867
|
+
parameters: {
|
|
5868
|
+
query?: never;
|
|
5869
|
+
header?: never;
|
|
5870
|
+
path: {
|
|
5871
|
+
/** @description The project's UUID. */
|
|
5872
|
+
uuid: string;
|
|
5873
|
+
slug: string;
|
|
5874
|
+
};
|
|
5875
|
+
cookie?: never;
|
|
5876
|
+
};
|
|
5877
|
+
requestBody?: {
|
|
5878
|
+
content: {
|
|
5879
|
+
"application/json": {
|
|
5880
|
+
accept?: boolean;
|
|
5881
|
+
};
|
|
5882
|
+
};
|
|
5883
|
+
};
|
|
5884
|
+
responses: {
|
|
5885
|
+
/** @description OK */
|
|
5886
|
+
200: {
|
|
5887
|
+
headers: {
|
|
5888
|
+
[name: string]: unknown;
|
|
5889
|
+
};
|
|
5890
|
+
content: {
|
|
5891
|
+
"application/json": components["schemas"]["SchemaRefreshed"];
|
|
5892
|
+
};
|
|
5893
|
+
};
|
|
5894
|
+
401: components["responses"]["E401"];
|
|
5895
|
+
403: components["responses"]["E403"];
|
|
5896
|
+
404: components["responses"]["E404"];
|
|
5897
|
+
429: components["responses"]["E429"];
|
|
5898
|
+
502: components["responses"]["E502"];
|
|
5899
|
+
};
|
|
5900
|
+
};
|
|
5901
|
+
reviewDatabaseSchema: {
|
|
5902
|
+
parameters: {
|
|
5903
|
+
query?: never;
|
|
5904
|
+
header?: never;
|
|
5905
|
+
path: {
|
|
5906
|
+
/** @description The project's UUID. */
|
|
5907
|
+
uuid: string;
|
|
5908
|
+
slug: string;
|
|
5909
|
+
};
|
|
5910
|
+
cookie?: never;
|
|
5911
|
+
};
|
|
5912
|
+
requestBody?: never;
|
|
5913
|
+
responses: {
|
|
5914
|
+
/** @description OK */
|
|
5915
|
+
200: {
|
|
5916
|
+
headers: {
|
|
5917
|
+
[name: string]: unknown;
|
|
5918
|
+
};
|
|
5919
|
+
content: {
|
|
5920
|
+
"application/json": components["schemas"]["SchemaReviewed"];
|
|
5921
|
+
};
|
|
5922
|
+
};
|
|
5923
|
+
401: components["responses"]["E401"];
|
|
5924
|
+
403: components["responses"]["E403"];
|
|
5925
|
+
404: components["responses"]["E404"];
|
|
5926
|
+
429: components["responses"]["E429"];
|
|
5927
|
+
};
|
|
5928
|
+
};
|
|
4906
5929
|
listStoredFiles: {
|
|
4907
5930
|
parameters: {
|
|
4908
5931
|
query?: {
|