@veroxm/sdk 1.13.0 → 1.14.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 +11 -0
- package/dist/client.d.ts +3 -0
- package/dist/client.js +2 -0
- package/dist/files.d.ts +73 -0
- package/dist/files.js +100 -0
- package/dist/generated/api.d.ts +834 -38
- package/dist/index.d.ts +2 -0
- package/dist/index.js +2 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,16 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 1.14.0
|
|
4
|
+
|
|
5
|
+
- Private files: `app.files` (`list`, `all`, `upload`, `get`, `delete`, `link`, `grant`) with a server key that has
|
|
6
|
+
"Read private files" / "Write private files", and `uploadWithGrant(uploadUrl, file)` for a browser or app with a
|
|
7
|
+
one-time upload link (no key). Types `StoredFile`, `StoredFilePage`, `StoredFileLink`, `FileGrant`,
|
|
8
|
+
`FileGrantOptions`, `StoredFileListOptions`. Needs a VeroXM server with private files (OpenAPI 2.17.0).
|
|
9
|
+
- The private files access log, `app.files.events({ fileId?, before?, limit? })`: who stored, read, linked, opened and
|
|
10
|
+
deleted each file, an open naming the link's maker and whom it was for (`link(id, { for })`; links now carry
|
|
11
|
+
`linkId`). Folder retention rules: `folders()`, `setFolder(folder, keepDays)`, `removeFolder(folder)`. Types
|
|
12
|
+
`StoredFileEvent`, `StoredFileEventPage`, `StoredFileEventOptions`, `FileFolderRule`.
|
|
13
|
+
|
|
3
14
|
## 1.13.0
|
|
4
15
|
|
|
5
16
|
- App translations: `app.translations.get('ar')` reads a locale's whole bundle in one request: its texts (nested, or
|
package/dist/client.d.ts
CHANGED
|
@@ -6,6 +6,7 @@ import { FunctionsResource } from './functions.js';
|
|
|
6
6
|
import { TasksResource } from './tasks.js';
|
|
7
7
|
import { ProcessesResource } from './processes.js';
|
|
8
8
|
import { FormsResource } from './forms.js';
|
|
9
|
+
import { FilesResource } from './files.js';
|
|
9
10
|
import { TranslationsResource } from './translations.js';
|
|
10
11
|
import { type TokenStorage } from './token-storage.js';
|
|
11
12
|
export interface VeroXMAppOptions {
|
|
@@ -44,6 +45,8 @@ export declare class VeroXMApp {
|
|
|
44
45
|
readonly processes: ProcessesResource;
|
|
45
46
|
/** The project's forms and responses (server keys with forms:read). */
|
|
46
47
|
readonly forms: FormsResource;
|
|
48
|
+
/** The project's private files (server keys with files:read / files:write). */
|
|
49
|
+
readonly files: FilesResource;
|
|
47
50
|
/** The project's app translations: a locale's whole bundle in one request (any key, a browser key too). */
|
|
48
51
|
readonly translations: TranslationsResource;
|
|
49
52
|
private readonly apiBase;
|
package/dist/client.js
CHANGED
|
@@ -7,6 +7,7 @@ import { FunctionsResource } from './functions.js';
|
|
|
7
7
|
import { TasksResource } from './tasks.js';
|
|
8
8
|
import { ProcessesResource } from './processes.js';
|
|
9
9
|
import { FormsResource } from './forms.js';
|
|
10
|
+
import { FilesResource } from './files.js';
|
|
10
11
|
import { TranslationsResource } from './translations.js';
|
|
11
12
|
import { MemoryTokenStorage, BrowserLocalStorageTokenStorage } from './token-storage.js';
|
|
12
13
|
function defaultTokenStorage(projectId) {
|
|
@@ -30,6 +31,7 @@ export class VeroXMApp {
|
|
|
30
31
|
this.tasks = new TasksResource(this);
|
|
31
32
|
this.processes = new ProcessesResource(this);
|
|
32
33
|
this.forms = new FormsResource(this);
|
|
34
|
+
this.files = new FilesResource(this);
|
|
33
35
|
this.translations = new TranslationsResource(this);
|
|
34
36
|
}
|
|
35
37
|
static initializeApp(options) {
|
package/dist/files.d.ts
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
import type { VeroXMApp } from './client.js';
|
|
2
|
+
import type { operations } from './generated/api.js';
|
|
3
|
+
import type { Schemas } from './schemas.js';
|
|
4
|
+
import type { UploadableFile } from './media.js';
|
|
5
|
+
import type { RequestControl } from './http.js';
|
|
6
|
+
/** A private file: never public, read by id with a server key or through a short-lived link. */
|
|
7
|
+
export type StoredFile = Schemas['StoredFile'];
|
|
8
|
+
export type StoredFilePage = Schemas['StoredFilePage'];
|
|
9
|
+
export type StoredFileLink = Schemas['StoredFileLink'];
|
|
10
|
+
/** A one-time upload link: a browser or app POSTs one file to `uploadUrl` with `uploadWithGrant`. */
|
|
11
|
+
export type FileGrant = Schemas['FileGrant'];
|
|
12
|
+
export type FileGrantOptions = Schemas['FileGrantRequest'];
|
|
13
|
+
export type StoredFileListOptions = NonNullable<operations['listStoredFiles']['parameters']['query']>;
|
|
14
|
+
/** One access log entry: who stored, read, linked, opened or deleted a file (an open names the link and whom it was for). */
|
|
15
|
+
export type StoredFileEvent = Schemas['StoredFileEvent'];
|
|
16
|
+
export type StoredFileEventPage = Schemas['StoredFileEventPage'];
|
|
17
|
+
export type StoredFileEventOptions = NonNullable<operations['listFileEvents']['parameters']['query']>;
|
|
18
|
+
/** A folder's retention rule: its files (and its subfolders' without their own rule) kept `keepDays` at most. */
|
|
19
|
+
export type FileFolderRule = Schemas['FileFolderRule'];
|
|
20
|
+
/**
|
|
21
|
+
* The project's private files, for your own servers: a key with "Read private files" (`files:read`) and/or "Write private
|
|
22
|
+
* files" (`files:write`), signed in with `auth.signInWithApiKey`. Never use such a key in a browser: give the browser an
|
|
23
|
+
* upload link (`grant`) or a file link (`link`) instead.
|
|
24
|
+
*/
|
|
25
|
+
export declare class FilesResource {
|
|
26
|
+
private readonly app;
|
|
27
|
+
constructor(app: VeroXMApp);
|
|
28
|
+
/** A page of files in a folder (`under: true` for everything under it), by id, up to 100. */
|
|
29
|
+
list(options?: StoredFileListOptions): Promise<StoredFilePage>;
|
|
30
|
+
/** Every file in a folder, page by page: `for await (const f of app.files.all({ folder: 'reports' }))`. */
|
|
31
|
+
all(options?: Omit<StoredFileListOptions, 'after'>): AsyncGenerator<StoredFile>;
|
|
32
|
+
/** Stores a file (25 MB at most). Its type is what its bytes show. `keepSeconds`: removed after that long. */
|
|
33
|
+
upload(file: UploadableFile, options?: {
|
|
34
|
+
name?: string;
|
|
35
|
+
folder?: string;
|
|
36
|
+
contentType?: string;
|
|
37
|
+
keepSeconds?: number;
|
|
38
|
+
}): Promise<StoredFile>;
|
|
39
|
+
get(id: string): Promise<StoredFile>;
|
|
40
|
+
delete(id: string): Promise<void>;
|
|
41
|
+
/**
|
|
42
|
+
* A link that opens the file with no key until it expires: 15 minutes unless asked, at most 7 days. `for` says whom
|
|
43
|
+
* it's for (an end user's id): the access log shows it next to every open.
|
|
44
|
+
*/
|
|
45
|
+
link(id: string, options?: {
|
|
46
|
+
ttlSeconds?: number;
|
|
47
|
+
download?: boolean;
|
|
48
|
+
for?: string;
|
|
49
|
+
}): Promise<StoredFileLink>;
|
|
50
|
+
/** A one-time upload link for a browser or app, within `maxBytes` and `kinds`. */
|
|
51
|
+
grant(options?: FileGrantOptions): Promise<FileGrant>;
|
|
52
|
+
/** The access log, newest first, up to 100 a page: one file's with `fileId` (kept after it's removed). Kept a year. */
|
|
53
|
+
events(options?: StoredFileEventOptions): Promise<StoredFileEventPage>;
|
|
54
|
+
/** The folder retention rules. */
|
|
55
|
+
folders(): Promise<FileFolderRule[]>;
|
|
56
|
+
/**
|
|
57
|
+
* Sets a folder's retention rule ("" for every folder): files there are kept `keepDays` at most, and the ones already
|
|
58
|
+
* there older than that are removed. `shortened`: how many files now expire sooner.
|
|
59
|
+
*/
|
|
60
|
+
setFolder(folder: string, keepDays: number): Promise<FileFolderRule & {
|
|
61
|
+
shortened: number;
|
|
62
|
+
}>;
|
|
63
|
+
/** Removes a folder's rule: its files keep the expiry they have. */
|
|
64
|
+
removeFolder(folder: string): Promise<{
|
|
65
|
+
removed: boolean;
|
|
66
|
+
}>;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Uploads one file with an upload link (`FileGrant.uploadUrl`, made by your server or a function): no key needed, so it
|
|
70
|
+
* runs in the browser. The link works once; a second upload, an expired link, a file too large (413) or of a kind the
|
|
71
|
+
* grant doesn't take (415) throws `VeroXMApiError`.
|
|
72
|
+
*/
|
|
73
|
+
export declare function uploadWithGrant(uploadUrl: string, file: UploadableFile, control?: RequestControl): Promise<StoredFile>;
|
package/dist/files.js
ADDED
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { apiError } from './errors.js';
|
|
2
|
+
function formOf(file) {
|
|
3
|
+
const form = new FormData();
|
|
4
|
+
if (file instanceof Blob)
|
|
5
|
+
form.append('file', file);
|
|
6
|
+
else
|
|
7
|
+
form.append('file', file.data instanceof Blob ? file.data : new Blob([file.data], { type: file.contentType }), file.filename);
|
|
8
|
+
return form;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* The project's private files, for your own servers: a key with "Read private files" (`files:read`) and/or "Write private
|
|
12
|
+
* files" (`files:write`), signed in with `auth.signInWithApiKey`. Never use such a key in a browser: give the browser an
|
|
13
|
+
* upload link (`grant`) or a file link (`link`) instead.
|
|
14
|
+
*/
|
|
15
|
+
export class FilesResource {
|
|
16
|
+
constructor(app) {
|
|
17
|
+
this.app = app;
|
|
18
|
+
}
|
|
19
|
+
/** A page of files in a folder (`under: true` for everything under it), by id, up to 100. */
|
|
20
|
+
async list(options = {}) {
|
|
21
|
+
return (await this.app.request({ path: '/storage/files', query: { folder: options.folder, under: options.under, after: options.after, limit: options.limit } }));
|
|
22
|
+
}
|
|
23
|
+
/** Every file in a folder, page by page: `for await (const f of app.files.all({ folder: 'reports' }))`. */
|
|
24
|
+
async *all(options = {}) {
|
|
25
|
+
let after;
|
|
26
|
+
do {
|
|
27
|
+
const page = await this.list({ ...options, after });
|
|
28
|
+
yield* page.files;
|
|
29
|
+
after = page.next ?? undefined;
|
|
30
|
+
} while (after);
|
|
31
|
+
}
|
|
32
|
+
/** Stores a file (25 MB at most). Its type is what its bytes show. `keepSeconds`: removed after that long. */
|
|
33
|
+
async upload(file, options = {}) {
|
|
34
|
+
const form = formOf(file);
|
|
35
|
+
if (options.name)
|
|
36
|
+
form.append('name', options.name);
|
|
37
|
+
if (options.folder)
|
|
38
|
+
form.append('folder', options.folder);
|
|
39
|
+
if (options.contentType)
|
|
40
|
+
form.append('contentType', options.contentType);
|
|
41
|
+
if (options.keepSeconds !== undefined)
|
|
42
|
+
form.append('keepSeconds', String(options.keepSeconds));
|
|
43
|
+
return (await this.app.request({ method: 'POST', path: '/storage/files', form }));
|
|
44
|
+
}
|
|
45
|
+
async get(id) {
|
|
46
|
+
return (await this.app.request({ path: `/storage/files/${encodeURIComponent(id)}` }));
|
|
47
|
+
}
|
|
48
|
+
async delete(id) {
|
|
49
|
+
await this.app.request({ method: 'DELETE', path: `/storage/files/${encodeURIComponent(id)}` });
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* A link that opens the file with no key until it expires: 15 minutes unless asked, at most 7 days. `for` says whom
|
|
53
|
+
* it's for (an end user's id): the access log shows it next to every open.
|
|
54
|
+
*/
|
|
55
|
+
async link(id, options = {}) {
|
|
56
|
+
return (await this.app.request({ method: 'POST', path: `/storage/files/${encodeURIComponent(id)}/link`, json: options }));
|
|
57
|
+
}
|
|
58
|
+
/** A one-time upload link for a browser or app, within `maxBytes` and `kinds`. */
|
|
59
|
+
async grant(options = {}) {
|
|
60
|
+
return (await this.app.request({ method: 'POST', path: '/storage/grants', json: options }));
|
|
61
|
+
}
|
|
62
|
+
/** The access log, newest first, up to 100 a page: one file's with `fileId` (kept after it's removed). Kept a year. */
|
|
63
|
+
async events(options = {}) {
|
|
64
|
+
return (await this.app.request({ path: '/storage/events', query: { fileId: options.fileId, before: options.before, limit: options.limit } }));
|
|
65
|
+
}
|
|
66
|
+
/** The folder retention rules. */
|
|
67
|
+
async folders() {
|
|
68
|
+
return (await this.app.request({ path: '/storage/folders' })).folders;
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* Sets a folder's retention rule ("" for every folder): files there are kept `keepDays` at most, and the ones already
|
|
72
|
+
* there older than that are removed. `shortened`: how many files now expire sooner.
|
|
73
|
+
*/
|
|
74
|
+
async setFolder(folder, keepDays) {
|
|
75
|
+
return (await this.app.request({ method: 'PUT', path: '/storage/folders', json: { folder, keepDays } }));
|
|
76
|
+
}
|
|
77
|
+
/** Removes a folder's rule: its files keep the expiry they have. */
|
|
78
|
+
async removeFolder(folder) {
|
|
79
|
+
return (await this.app.request({ method: 'DELETE', path: '/storage/folders', query: { folder } }));
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* Uploads one file with an upload link (`FileGrant.uploadUrl`, made by your server or a function): no key needed, so it
|
|
84
|
+
* runs in the browser. The link works once; a second upload, an expired link, a file too large (413) or of a kind the
|
|
85
|
+
* grant doesn't take (415) throws `VeroXMApiError`.
|
|
86
|
+
*/
|
|
87
|
+
export async function uploadWithGrant(uploadUrl, file, control = {}) {
|
|
88
|
+
const res = await fetch(uploadUrl, { method: 'POST', body: formOf(file), signal: control.signal });
|
|
89
|
+
const text = await res.text();
|
|
90
|
+
let body = text;
|
|
91
|
+
try {
|
|
92
|
+
body = text ? JSON.parse(text) : null;
|
|
93
|
+
}
|
|
94
|
+
catch {
|
|
95
|
+
// not JSON: kept as text for the error
|
|
96
|
+
}
|
|
97
|
+
if (!res.ok)
|
|
98
|
+
throw apiError(res.status, body);
|
|
99
|
+
return body;
|
|
100
|
+
}
|
package/dist/generated/api.d.ts
CHANGED
|
@@ -849,6 +849,173 @@ export interface paths {
|
|
|
849
849
|
patch?: never;
|
|
850
850
|
trace?: never;
|
|
851
851
|
};
|
|
852
|
+
"/projects/{uuid}/storage/files": {
|
|
853
|
+
parameters: {
|
|
854
|
+
query?: never;
|
|
855
|
+
header?: never;
|
|
856
|
+
path?: never;
|
|
857
|
+
cookie?: never;
|
|
858
|
+
};
|
|
859
|
+
/**
|
|
860
|
+
* A page of private files (files:read keys)
|
|
861
|
+
* @description In one folder, or with `under=true` everything under it. By id, up to 100 a page. A project key on your server: an end user's login answers 403 (`code: "key_required"`).
|
|
862
|
+
*/
|
|
863
|
+
get: operations["listStoredFiles"];
|
|
864
|
+
put?: never;
|
|
865
|
+
/**
|
|
866
|
+
* Store a private file (files:write keys)
|
|
867
|
+
* @description Up to 25 MB. Its type is what its bytes show. Never public: read it by id, or make a short-lived link.
|
|
868
|
+
*/
|
|
869
|
+
post: operations["storeFile"];
|
|
870
|
+
delete?: never;
|
|
871
|
+
options?: never;
|
|
872
|
+
head?: never;
|
|
873
|
+
patch?: never;
|
|
874
|
+
trace?: never;
|
|
875
|
+
};
|
|
876
|
+
"/projects/{uuid}/storage/files/{id}": {
|
|
877
|
+
parameters: {
|
|
878
|
+
query?: never;
|
|
879
|
+
header?: never;
|
|
880
|
+
path?: never;
|
|
881
|
+
cookie?: never;
|
|
882
|
+
};
|
|
883
|
+
/** A private file's details (files:read keys) */
|
|
884
|
+
get: operations["getStoredFile"];
|
|
885
|
+
put?: never;
|
|
886
|
+
post?: never;
|
|
887
|
+
/** Delete a private file (files:write keys) */
|
|
888
|
+
delete: operations["deleteStoredFile"];
|
|
889
|
+
options?: never;
|
|
890
|
+
head?: never;
|
|
891
|
+
patch?: never;
|
|
892
|
+
trace?: never;
|
|
893
|
+
};
|
|
894
|
+
"/projects/{uuid}/storage/files/{id}/link": {
|
|
895
|
+
parameters: {
|
|
896
|
+
query?: never;
|
|
897
|
+
header?: never;
|
|
898
|
+
path?: never;
|
|
899
|
+
cookie?: never;
|
|
900
|
+
};
|
|
901
|
+
get?: never;
|
|
902
|
+
put?: never;
|
|
903
|
+
/**
|
|
904
|
+
* A short-lived link to a private file (files:read keys)
|
|
905
|
+
* @description The link opens the file with no key until it expires: 15 minutes unless asked, at most 7 days. Anyone with it can open it, so give it only to whom the file is for.
|
|
906
|
+
*/
|
|
907
|
+
post: operations["linkStoredFile"];
|
|
908
|
+
delete?: never;
|
|
909
|
+
options?: never;
|
|
910
|
+
head?: never;
|
|
911
|
+
patch?: never;
|
|
912
|
+
trace?: never;
|
|
913
|
+
};
|
|
914
|
+
"/projects/{uuid}/storage/events": {
|
|
915
|
+
parameters: {
|
|
916
|
+
query?: never;
|
|
917
|
+
header?: never;
|
|
918
|
+
path?: never;
|
|
919
|
+
cookie?: never;
|
|
920
|
+
};
|
|
921
|
+
/**
|
|
922
|
+
* The private files access log (files:read keys)
|
|
923
|
+
* @description Who stored, read, linked, opened and deleted each file, newest first, up to 100 a page; one file's with `fileId` (kept after it is removed). An open names the link used, who made it and for whom. Kept a year.
|
|
924
|
+
*/
|
|
925
|
+
get: operations["listFileEvents"];
|
|
926
|
+
put?: never;
|
|
927
|
+
post?: never;
|
|
928
|
+
delete?: never;
|
|
929
|
+
options?: never;
|
|
930
|
+
head?: never;
|
|
931
|
+
patch?: never;
|
|
932
|
+
trace?: never;
|
|
933
|
+
};
|
|
934
|
+
"/projects/{uuid}/storage/folders": {
|
|
935
|
+
parameters: {
|
|
936
|
+
query?: never;
|
|
937
|
+
header?: never;
|
|
938
|
+
path?: never;
|
|
939
|
+
cookie?: never;
|
|
940
|
+
};
|
|
941
|
+
/** Folder retention rules (files:read keys) */
|
|
942
|
+
get: operations["listFileFolders"];
|
|
943
|
+
/**
|
|
944
|
+
* Set a folder's retention rule (files:write keys)
|
|
945
|
+
* @description Files in the folder, or in a subfolder without a rule of its own, are kept `keepDays` at most. Files already there that it now holds for are shortened to it: the ones older than it are removed. A longer rule applies to files stored from then on. veroxm.json can carry the rules (`fileFolders`).
|
|
946
|
+
*/
|
|
947
|
+
put: operations["setFileFolder"];
|
|
948
|
+
post?: never;
|
|
949
|
+
/**
|
|
950
|
+
* Remove a folder's retention rule (files:write keys)
|
|
951
|
+
* @description Files keep the expiry they have; new ones follow the next rule up, if any.
|
|
952
|
+
*/
|
|
953
|
+
delete: operations["removeFileFolder"];
|
|
954
|
+
options?: never;
|
|
955
|
+
head?: never;
|
|
956
|
+
patch?: never;
|
|
957
|
+
trace?: never;
|
|
958
|
+
};
|
|
959
|
+
"/projects/{uuid}/storage/grants": {
|
|
960
|
+
parameters: {
|
|
961
|
+
query?: never;
|
|
962
|
+
header?: never;
|
|
963
|
+
path?: never;
|
|
964
|
+
cookie?: never;
|
|
965
|
+
};
|
|
966
|
+
get?: never;
|
|
967
|
+
put?: never;
|
|
968
|
+
/**
|
|
969
|
+
* A one-time upload link for a browser or app (files:write keys)
|
|
970
|
+
* @description The `uploadUrl` takes one file, within `maxBytes` and `kinds` (checked from its bytes), before it expires. Only its hash is kept.
|
|
971
|
+
*/
|
|
972
|
+
post: operations["grantFileUpload"];
|
|
973
|
+
delete?: never;
|
|
974
|
+
options?: never;
|
|
975
|
+
head?: never;
|
|
976
|
+
patch?: never;
|
|
977
|
+
trace?: never;
|
|
978
|
+
};
|
|
979
|
+
"/projects/{uuid}/storage/links/{token}": {
|
|
980
|
+
parameters: {
|
|
981
|
+
query?: never;
|
|
982
|
+
header?: never;
|
|
983
|
+
path?: never;
|
|
984
|
+
cookie?: never;
|
|
985
|
+
};
|
|
986
|
+
/**
|
|
987
|
+
* A private file, by its short-lived link
|
|
988
|
+
* @description No key: the link is the credential. Shown in the browser for images, PDF, plain text, audio and video; downloaded otherwise (never HTML, SVG or XML inline).
|
|
989
|
+
*/
|
|
990
|
+
get: operations["openFileLink"];
|
|
991
|
+
put?: never;
|
|
992
|
+
post?: never;
|
|
993
|
+
delete?: never;
|
|
994
|
+
options?: never;
|
|
995
|
+
head?: never;
|
|
996
|
+
patch?: never;
|
|
997
|
+
trace?: never;
|
|
998
|
+
};
|
|
999
|
+
"/projects/{uuid}/storage/uploads/{token}": {
|
|
1000
|
+
parameters: {
|
|
1001
|
+
query?: never;
|
|
1002
|
+
header?: never;
|
|
1003
|
+
path?: never;
|
|
1004
|
+
cookie?: never;
|
|
1005
|
+
};
|
|
1006
|
+
get?: never;
|
|
1007
|
+
put?: never;
|
|
1008
|
+
/**
|
|
1009
|
+
* Upload one file with an upload link
|
|
1010
|
+
* @description No key: the grant is the credential, once. 403 (`code: "invalid_grant"`) when it was used, has expired or isn't valid; 413 over its size; 415 for a kind it doesn't take.
|
|
1011
|
+
*/
|
|
1012
|
+
post: operations["uploadWithGrant"];
|
|
1013
|
+
delete?: never;
|
|
1014
|
+
options?: never;
|
|
1015
|
+
head?: never;
|
|
1016
|
+
patch?: never;
|
|
1017
|
+
trace?: never;
|
|
1018
|
+
};
|
|
852
1019
|
"/projects/{uuid}/setup": {
|
|
853
1020
|
parameters: {
|
|
854
1021
|
query?: never;
|
|
@@ -1031,6 +1198,26 @@ export interface paths {
|
|
|
1031
1198
|
patch?: never;
|
|
1032
1199
|
trace?: never;
|
|
1033
1200
|
};
|
|
1201
|
+
"/projects/{uuid}/setup/functions/{name}/invoke": {
|
|
1202
|
+
parameters: {
|
|
1203
|
+
query?: never;
|
|
1204
|
+
header?: never;
|
|
1205
|
+
path?: never;
|
|
1206
|
+
cookie?: never;
|
|
1207
|
+
};
|
|
1208
|
+
get?: never;
|
|
1209
|
+
put?: never;
|
|
1210
|
+
/**
|
|
1211
|
+
* Run a deployed function once, as the project or as its schedule (setup keys)
|
|
1212
|
+
* @description For `veroxm functions invoke`. With `dryRun`, only the calls that read are made. In the function's call log as `cli:<key name>`. 400 (`code: "no_schedule"`) for `as: schedule` on a function without one.
|
|
1213
|
+
*/
|
|
1214
|
+
post: operations["invokeFunction"];
|
|
1215
|
+
delete?: never;
|
|
1216
|
+
options?: never;
|
|
1217
|
+
head?: never;
|
|
1218
|
+
patch?: never;
|
|
1219
|
+
trace?: never;
|
|
1220
|
+
};
|
|
1034
1221
|
"/projects/{uuid}/setup/apply": {
|
|
1035
1222
|
parameters: {
|
|
1036
1223
|
query?: never;
|
|
@@ -1758,6 +1945,127 @@ export interface components {
|
|
|
1758
1945
|
/** @constant */
|
|
1759
1946
|
success: true;
|
|
1760
1947
|
};
|
|
1948
|
+
StoredFile: {
|
|
1949
|
+
/** @description f_… */
|
|
1950
|
+
id: string;
|
|
1951
|
+
name: string;
|
|
1952
|
+
/** @description "" when it isn't in one. */
|
|
1953
|
+
folder: string;
|
|
1954
|
+
/** @description What its bytes show it is; a data or text type its writer gave; else application/octet-stream. */
|
|
1955
|
+
contentType: string;
|
|
1956
|
+
size: number;
|
|
1957
|
+
sha256: string;
|
|
1958
|
+
/** Format: date-time */
|
|
1959
|
+
createdAt: string;
|
|
1960
|
+
/** Format: date-time */
|
|
1961
|
+
expiresAt: string | null;
|
|
1962
|
+
createdBy: {
|
|
1963
|
+
/** @enum {string} */
|
|
1964
|
+
kind: "function" | "key" | "grant" | "dashboard";
|
|
1965
|
+
name: string | null;
|
|
1966
|
+
};
|
|
1967
|
+
};
|
|
1968
|
+
StoredFilePage: {
|
|
1969
|
+
files: components["schemas"]["StoredFile"][];
|
|
1970
|
+
/** @description The last id: pass it as after for the next page. */
|
|
1971
|
+
next: string | null;
|
|
1972
|
+
};
|
|
1973
|
+
StoredFileUpload: {
|
|
1974
|
+
file: string;
|
|
1975
|
+
/** @description Instead of the uploaded file's own name. */
|
|
1976
|
+
name?: string;
|
|
1977
|
+
folder?: string;
|
|
1978
|
+
/** @description For a file whose bytes don't show its type: a data or text type. */
|
|
1979
|
+
contentType?: string;
|
|
1980
|
+
/** @description Removed after this long (60 to 31536000). */
|
|
1981
|
+
keepSeconds?: number;
|
|
1982
|
+
};
|
|
1983
|
+
StoredFileLinkRequest: {
|
|
1984
|
+
/** @description 10 to 604800; 900 unless given. */
|
|
1985
|
+
ttlSeconds?: number;
|
|
1986
|
+
/** @description Download it rather than show it. */
|
|
1987
|
+
download?: boolean;
|
|
1988
|
+
/** @description Whom it's for (an end user's id, a case number): the access log shows it next to every open. 160 characters at most. */
|
|
1989
|
+
for?: string;
|
|
1990
|
+
};
|
|
1991
|
+
StoredFileLink: {
|
|
1992
|
+
url: string;
|
|
1993
|
+
/** Format: date-time */
|
|
1994
|
+
expiresAt: string;
|
|
1995
|
+
/** @description How the access log names this link. */
|
|
1996
|
+
linkId: string;
|
|
1997
|
+
};
|
|
1998
|
+
StoredFileEvent: {
|
|
1999
|
+
id: string;
|
|
2000
|
+
fileId: string;
|
|
2001
|
+
/** @enum {string} */
|
|
2002
|
+
action: "stored" | "read" | "linked" | "opened" | "deleted" | "expired";
|
|
2003
|
+
/** Format: date-time */
|
|
2004
|
+
at: string;
|
|
2005
|
+
actor: {
|
|
2006
|
+
/** @description function, key, grant, dashboard; link for an open; system for an expiry. */
|
|
2007
|
+
kind: string;
|
|
2008
|
+
id: string | null;
|
|
2009
|
+
name: string | null;
|
|
2010
|
+
};
|
|
2011
|
+
link: {
|
|
2012
|
+
id: string;
|
|
2013
|
+
for: string | null;
|
|
2014
|
+
madeBy: {
|
|
2015
|
+
kind: string;
|
|
2016
|
+
name: string | null;
|
|
2017
|
+
} | null;
|
|
2018
|
+
} | null;
|
|
2019
|
+
/** @description The opener's address, for an open. */
|
|
2020
|
+
ip: string | null;
|
|
2021
|
+
};
|
|
2022
|
+
StoredFileEventPage: {
|
|
2023
|
+
events: components["schemas"]["StoredFileEvent"][];
|
|
2024
|
+
/** @description The last id: pass it as before for the next page. */
|
|
2025
|
+
next: string | null;
|
|
2026
|
+
};
|
|
2027
|
+
FileFolderRule: {
|
|
2028
|
+
/** @description "" for every folder. */
|
|
2029
|
+
folder: string;
|
|
2030
|
+
/** @description 1 to 3650. */
|
|
2031
|
+
keepDays: number;
|
|
2032
|
+
};
|
|
2033
|
+
FileFolderRules: {
|
|
2034
|
+
folders: components["schemas"]["FileFolderRule"][];
|
|
2035
|
+
};
|
|
2036
|
+
FileFolderRuleSet: {
|
|
2037
|
+
folder: string;
|
|
2038
|
+
keepDays: number;
|
|
2039
|
+
/** @description Files already there that now expire sooner. */
|
|
2040
|
+
shortened: number;
|
|
2041
|
+
};
|
|
2042
|
+
FileFolderRuleRemoved: {
|
|
2043
|
+
removed: boolean;
|
|
2044
|
+
};
|
|
2045
|
+
StoredFileDeleted: {
|
|
2046
|
+
/** @constant */
|
|
2047
|
+
deleted: true;
|
|
2048
|
+
};
|
|
2049
|
+
FileGrantRequest: {
|
|
2050
|
+
/** @description Up to 26214400; 10485760 unless given. */
|
|
2051
|
+
maxBytes?: number;
|
|
2052
|
+
/** @description Checked from the file's bytes; all of them unless given. */
|
|
2053
|
+
kinds?: ("image" | "pdf" | "document" | "spreadsheet" | "audio" | "video")[];
|
|
2054
|
+
folder?: string;
|
|
2055
|
+
/** @description 30 to 86400; 900 unless given. */
|
|
2056
|
+
ttlSeconds?: number;
|
|
2057
|
+
};
|
|
2058
|
+
FileGrant: {
|
|
2059
|
+
/** @description POST one file here (multipart, field "file"), with no key. */
|
|
2060
|
+
uploadUrl: string;
|
|
2061
|
+
/** Format: date-time */
|
|
2062
|
+
expiresAt: string;
|
|
2063
|
+
maxBytes: number;
|
|
2064
|
+
kinds: string[];
|
|
2065
|
+
};
|
|
2066
|
+
FileGrantUpload: {
|
|
2067
|
+
file: string;
|
|
2068
|
+
};
|
|
1761
2069
|
TaskFormField: {
|
|
1762
2070
|
name: string;
|
|
1763
2071
|
label: string;
|
|
@@ -2239,6 +2547,50 @@ export interface components {
|
|
|
2239
2547
|
managedBy: string;
|
|
2240
2548
|
rolledBackTo: number;
|
|
2241
2549
|
};
|
|
2550
|
+
FunctionInvokeRequest: {
|
|
2551
|
+
/**
|
|
2552
|
+
* @description As an HTTP call (default POST).
|
|
2553
|
+
* @enum {string}
|
|
2554
|
+
*/
|
|
2555
|
+
method?: "GET" | "POST";
|
|
2556
|
+
/** @description The query string, as an object. */
|
|
2557
|
+
query?: {
|
|
2558
|
+
[key: string]: unknown;
|
|
2559
|
+
};
|
|
2560
|
+
/** @description The JSON body of a POST. */
|
|
2561
|
+
body?: unknown;
|
|
2562
|
+
/**
|
|
2563
|
+
* @description http (default): as the project's server calls it. schedule: as its schedule runs it.
|
|
2564
|
+
* @enum {string}
|
|
2565
|
+
*/
|
|
2566
|
+
as?: "http" | "schedule";
|
|
2567
|
+
/** @description Make only the calls that read; list the ones that would change something instead. */
|
|
2568
|
+
dryRun?: boolean;
|
|
2569
|
+
};
|
|
2570
|
+
FunctionInvoked: {
|
|
2571
|
+
function: string;
|
|
2572
|
+
version: number;
|
|
2573
|
+
/** @enum {string} */
|
|
2574
|
+
trigger: "http" | "schedule";
|
|
2575
|
+
ok: boolean;
|
|
2576
|
+
/** @description What the function returned (ok). */
|
|
2577
|
+
value?: unknown;
|
|
2578
|
+
/** @description Why it failed (not ok). */
|
|
2579
|
+
error?: string;
|
|
2580
|
+
timedOut?: boolean;
|
|
2581
|
+
/** @description The HTTP status the call answers with (as http). */
|
|
2582
|
+
status?: number;
|
|
2583
|
+
logs: string[];
|
|
2584
|
+
durationMs: number;
|
|
2585
|
+
/** @description A scheduled run asked to run again this much later (not queued for a run started here). */
|
|
2586
|
+
runAgainSeconds?: number;
|
|
2587
|
+
dryRun: boolean;
|
|
2588
|
+
/** @description A dry run: the calls not made, by what they were about, never their values. */
|
|
2589
|
+
skipped?: {
|
|
2590
|
+
method: string;
|
|
2591
|
+
target: string | null;
|
|
2592
|
+
}[];
|
|
2593
|
+
};
|
|
2242
2594
|
SetupApplied: {
|
|
2243
2595
|
/** @description How many changes were made. */
|
|
2244
2596
|
applied: number;
|
|
@@ -2590,6 +2942,15 @@ export interface components {
|
|
|
2590
2942
|
"application/json": components["schemas"]["Error"];
|
|
2591
2943
|
};
|
|
2592
2944
|
};
|
|
2945
|
+
/** @description A kind of file this does not take */
|
|
2946
|
+
E415: {
|
|
2947
|
+
headers: {
|
|
2948
|
+
[name: string]: unknown;
|
|
2949
|
+
};
|
|
2950
|
+
content: {
|
|
2951
|
+
"application/json": components["schemas"]["Error"];
|
|
2952
|
+
};
|
|
2953
|
+
};
|
|
2593
2954
|
/** @description Some answers need attention: `fieldErrors` says which, by question id */
|
|
2594
2955
|
E422: {
|
|
2595
2956
|
headers: {
|
|
@@ -4542,9 +4903,15 @@ export interface operations {
|
|
|
4542
4903
|
504: components["responses"]["E504"];
|
|
4543
4904
|
};
|
|
4544
4905
|
};
|
|
4545
|
-
|
|
4906
|
+
listStoredFiles: {
|
|
4546
4907
|
parameters: {
|
|
4547
|
-
query?:
|
|
4908
|
+
query?: {
|
|
4909
|
+
folder?: string;
|
|
4910
|
+
under?: boolean;
|
|
4911
|
+
/** @description The previous page's next. */
|
|
4912
|
+
after?: string;
|
|
4913
|
+
limit?: number;
|
|
4914
|
+
};
|
|
4548
4915
|
header?: never;
|
|
4549
4916
|
path: {
|
|
4550
4917
|
/** @description The project's UUID. */
|
|
@@ -4560,15 +4927,17 @@ export interface operations {
|
|
|
4560
4927
|
[name: string]: unknown;
|
|
4561
4928
|
};
|
|
4562
4929
|
content: {
|
|
4563
|
-
"application/json": components["schemas"]["
|
|
4930
|
+
"application/json": components["schemas"]["StoredFilePage"];
|
|
4564
4931
|
};
|
|
4565
4932
|
};
|
|
4933
|
+
400: components["responses"]["E400"];
|
|
4566
4934
|
401: components["responses"]["E401"];
|
|
4567
4935
|
403: components["responses"]["E403"];
|
|
4936
|
+
404: components["responses"]["E404"];
|
|
4568
4937
|
429: components["responses"]["E429"];
|
|
4569
4938
|
};
|
|
4570
4939
|
};
|
|
4571
|
-
|
|
4940
|
+
storeFile: {
|
|
4572
4941
|
parameters: {
|
|
4573
4942
|
query?: never;
|
|
4574
4943
|
header?: never;
|
|
@@ -4580,43 +4949,39 @@ export interface operations {
|
|
|
4580
4949
|
};
|
|
4581
4950
|
requestBody: {
|
|
4582
4951
|
content: {
|
|
4583
|
-
"
|
|
4952
|
+
"multipart/form-data": components["schemas"]["StoredFileUpload"];
|
|
4584
4953
|
};
|
|
4585
4954
|
};
|
|
4586
4955
|
responses: {
|
|
4587
|
-
/** @description
|
|
4588
|
-
|
|
4956
|
+
/** @description Stored */
|
|
4957
|
+
201: {
|
|
4589
4958
|
headers: {
|
|
4590
4959
|
[name: string]: unknown;
|
|
4591
4960
|
};
|
|
4592
4961
|
content: {
|
|
4593
|
-
"application/json": components["schemas"]["
|
|
4962
|
+
"application/json": components["schemas"]["StoredFile"];
|
|
4594
4963
|
};
|
|
4595
4964
|
};
|
|
4965
|
+
400: components["responses"]["E400"];
|
|
4596
4966
|
401: components["responses"]["E401"];
|
|
4597
4967
|
403: components["responses"]["E403"];
|
|
4968
|
+
404: components["responses"]["E404"];
|
|
4598
4969
|
413: components["responses"]["E413"];
|
|
4599
4970
|
429: components["responses"]["E429"];
|
|
4600
4971
|
};
|
|
4601
4972
|
};
|
|
4602
|
-
|
|
4973
|
+
getStoredFile: {
|
|
4603
4974
|
parameters: {
|
|
4604
4975
|
query?: never;
|
|
4605
|
-
header
|
|
4606
|
-
/** @description The target project's setup key (it names the target). */
|
|
4607
|
-
"X-VeroXM-Target-Key": string;
|
|
4608
|
-
};
|
|
4976
|
+
header?: never;
|
|
4609
4977
|
path: {
|
|
4610
4978
|
/** @description The project's UUID. */
|
|
4611
4979
|
uuid: string;
|
|
4980
|
+
id: string;
|
|
4612
4981
|
};
|
|
4613
4982
|
cookie?: never;
|
|
4614
4983
|
};
|
|
4615
|
-
requestBody
|
|
4616
|
-
content: {
|
|
4617
|
-
"application/json": components["schemas"]["PromoteContentRequest"];
|
|
4618
|
-
};
|
|
4619
|
-
};
|
|
4984
|
+
requestBody?: never;
|
|
4620
4985
|
responses: {
|
|
4621
4986
|
/** @description OK */
|
|
4622
4987
|
200: {
|
|
@@ -4624,34 +4989,27 @@ export interface operations {
|
|
|
4624
4989
|
[name: string]: unknown;
|
|
4625
4990
|
};
|
|
4626
4991
|
content: {
|
|
4627
|
-
"application/json": components["schemas"]["
|
|
4992
|
+
"application/json": components["schemas"]["StoredFile"];
|
|
4628
4993
|
};
|
|
4629
4994
|
};
|
|
4630
|
-
400: components["responses"]["E400"];
|
|
4631
4995
|
401: components["responses"]["E401"];
|
|
4632
4996
|
403: components["responses"]["E403"];
|
|
4633
4997
|
404: components["responses"]["E404"];
|
|
4634
4998
|
429: components["responses"]["E429"];
|
|
4635
4999
|
};
|
|
4636
5000
|
};
|
|
4637
|
-
|
|
5001
|
+
deleteStoredFile: {
|
|
4638
5002
|
parameters: {
|
|
4639
5003
|
query?: never;
|
|
4640
|
-
header
|
|
4641
|
-
/** @description The target project's setup key (it names the target). */
|
|
4642
|
-
"X-VeroXM-Target-Key": string;
|
|
4643
|
-
};
|
|
5004
|
+
header?: never;
|
|
4644
5005
|
path: {
|
|
4645
5006
|
/** @description The project's UUID. */
|
|
4646
5007
|
uuid: string;
|
|
5008
|
+
id: string;
|
|
4647
5009
|
};
|
|
4648
5010
|
cookie?: never;
|
|
4649
5011
|
};
|
|
4650
|
-
requestBody
|
|
4651
|
-
content: {
|
|
4652
|
-
"application/json": components["schemas"]["PromoteContentRequest"];
|
|
4653
|
-
};
|
|
4654
|
-
};
|
|
5012
|
+
requestBody?: never;
|
|
4655
5013
|
responses: {
|
|
4656
5014
|
/** @description OK */
|
|
4657
5015
|
200: {
|
|
@@ -4659,36 +5017,441 @@ export interface operations {
|
|
|
4659
5017
|
[name: string]: unknown;
|
|
4660
5018
|
};
|
|
4661
5019
|
content: {
|
|
4662
|
-
"application/json": components["schemas"]["
|
|
5020
|
+
"application/json": components["schemas"]["StoredFileDeleted"];
|
|
4663
5021
|
};
|
|
4664
5022
|
};
|
|
4665
|
-
400: components["responses"]["E400"];
|
|
4666
5023
|
401: components["responses"]["E401"];
|
|
4667
5024
|
403: components["responses"]["E403"];
|
|
4668
5025
|
404: components["responses"]["E404"];
|
|
4669
|
-
409: components["responses"]["E409"];
|
|
4670
5026
|
429: components["responses"]["E429"];
|
|
4671
5027
|
};
|
|
4672
5028
|
};
|
|
4673
|
-
|
|
5029
|
+
linkStoredFile: {
|
|
4674
5030
|
parameters: {
|
|
4675
5031
|
query?: never;
|
|
4676
5032
|
header?: never;
|
|
4677
5033
|
path: {
|
|
4678
5034
|
/** @description The project's UUID. */
|
|
4679
5035
|
uuid: string;
|
|
5036
|
+
id: string;
|
|
4680
5037
|
};
|
|
4681
5038
|
cookie?: never;
|
|
4682
5039
|
};
|
|
4683
|
-
requestBody
|
|
5040
|
+
requestBody: {
|
|
5041
|
+
content: {
|
|
5042
|
+
"application/json": components["schemas"]["StoredFileLinkRequest"];
|
|
5043
|
+
};
|
|
5044
|
+
};
|
|
4684
5045
|
responses: {
|
|
4685
|
-
/** @description
|
|
4686
|
-
|
|
5046
|
+
/** @description A link */
|
|
5047
|
+
201: {
|
|
4687
5048
|
headers: {
|
|
4688
5049
|
[name: string]: unknown;
|
|
4689
5050
|
};
|
|
4690
5051
|
content: {
|
|
4691
|
-
"application/json": components["schemas"]["
|
|
5052
|
+
"application/json": components["schemas"]["StoredFileLink"];
|
|
5053
|
+
};
|
|
5054
|
+
};
|
|
5055
|
+
400: components["responses"]["E400"];
|
|
5056
|
+
401: components["responses"]["E401"];
|
|
5057
|
+
403: components["responses"]["E403"];
|
|
5058
|
+
404: components["responses"]["E404"];
|
|
5059
|
+
429: components["responses"]["E429"];
|
|
5060
|
+
};
|
|
5061
|
+
};
|
|
5062
|
+
listFileEvents: {
|
|
5063
|
+
parameters: {
|
|
5064
|
+
query?: {
|
|
5065
|
+
fileId?: string;
|
|
5066
|
+
/** @description The previous page's next. */
|
|
5067
|
+
before?: string;
|
|
5068
|
+
limit?: number;
|
|
5069
|
+
};
|
|
5070
|
+
header?: never;
|
|
5071
|
+
path: {
|
|
5072
|
+
/** @description The project's UUID. */
|
|
5073
|
+
uuid: string;
|
|
5074
|
+
};
|
|
5075
|
+
cookie?: never;
|
|
5076
|
+
};
|
|
5077
|
+
requestBody?: never;
|
|
5078
|
+
responses: {
|
|
5079
|
+
/** @description OK */
|
|
5080
|
+
200: {
|
|
5081
|
+
headers: {
|
|
5082
|
+
[name: string]: unknown;
|
|
5083
|
+
};
|
|
5084
|
+
content: {
|
|
5085
|
+
"application/json": components["schemas"]["StoredFileEventPage"];
|
|
5086
|
+
};
|
|
5087
|
+
};
|
|
5088
|
+
400: components["responses"]["E400"];
|
|
5089
|
+
401: components["responses"]["E401"];
|
|
5090
|
+
403: components["responses"]["E403"];
|
|
5091
|
+
404: components["responses"]["E404"];
|
|
5092
|
+
429: components["responses"]["E429"];
|
|
5093
|
+
};
|
|
5094
|
+
};
|
|
5095
|
+
listFileFolders: {
|
|
5096
|
+
parameters: {
|
|
5097
|
+
query?: never;
|
|
5098
|
+
header?: never;
|
|
5099
|
+
path: {
|
|
5100
|
+
/** @description The project's UUID. */
|
|
5101
|
+
uuid: string;
|
|
5102
|
+
};
|
|
5103
|
+
cookie?: never;
|
|
5104
|
+
};
|
|
5105
|
+
requestBody?: never;
|
|
5106
|
+
responses: {
|
|
5107
|
+
/** @description OK */
|
|
5108
|
+
200: {
|
|
5109
|
+
headers: {
|
|
5110
|
+
[name: string]: unknown;
|
|
5111
|
+
};
|
|
5112
|
+
content: {
|
|
5113
|
+
"application/json": components["schemas"]["FileFolderRules"];
|
|
5114
|
+
};
|
|
5115
|
+
};
|
|
5116
|
+
401: components["responses"]["E401"];
|
|
5117
|
+
403: components["responses"]["E403"];
|
|
5118
|
+
404: components["responses"]["E404"];
|
|
5119
|
+
429: components["responses"]["E429"];
|
|
5120
|
+
};
|
|
5121
|
+
};
|
|
5122
|
+
setFileFolder: {
|
|
5123
|
+
parameters: {
|
|
5124
|
+
query?: never;
|
|
5125
|
+
header?: never;
|
|
5126
|
+
path: {
|
|
5127
|
+
/** @description The project's UUID. */
|
|
5128
|
+
uuid: string;
|
|
5129
|
+
};
|
|
5130
|
+
cookie?: never;
|
|
5131
|
+
};
|
|
5132
|
+
requestBody: {
|
|
5133
|
+
content: {
|
|
5134
|
+
"application/json": components["schemas"]["FileFolderRule"];
|
|
5135
|
+
};
|
|
5136
|
+
};
|
|
5137
|
+
responses: {
|
|
5138
|
+
/** @description OK */
|
|
5139
|
+
200: {
|
|
5140
|
+
headers: {
|
|
5141
|
+
[name: string]: unknown;
|
|
5142
|
+
};
|
|
5143
|
+
content: {
|
|
5144
|
+
"application/json": components["schemas"]["FileFolderRuleSet"];
|
|
5145
|
+
};
|
|
5146
|
+
};
|
|
5147
|
+
400: components["responses"]["E400"];
|
|
5148
|
+
401: components["responses"]["E401"];
|
|
5149
|
+
403: components["responses"]["E403"];
|
|
5150
|
+
404: components["responses"]["E404"];
|
|
5151
|
+
429: components["responses"]["E429"];
|
|
5152
|
+
};
|
|
5153
|
+
};
|
|
5154
|
+
removeFileFolder: {
|
|
5155
|
+
parameters: {
|
|
5156
|
+
query?: {
|
|
5157
|
+
/** @description "" (or left out) for the every-folder rule. */
|
|
5158
|
+
folder?: string;
|
|
5159
|
+
};
|
|
5160
|
+
header?: never;
|
|
5161
|
+
path: {
|
|
5162
|
+
/** @description The project's UUID. */
|
|
5163
|
+
uuid: string;
|
|
5164
|
+
};
|
|
5165
|
+
cookie?: never;
|
|
5166
|
+
};
|
|
5167
|
+
requestBody?: never;
|
|
5168
|
+
responses: {
|
|
5169
|
+
/** @description OK */
|
|
5170
|
+
200: {
|
|
5171
|
+
headers: {
|
|
5172
|
+
[name: string]: unknown;
|
|
5173
|
+
};
|
|
5174
|
+
content: {
|
|
5175
|
+
"application/json": components["schemas"]["FileFolderRuleRemoved"];
|
|
5176
|
+
};
|
|
5177
|
+
};
|
|
5178
|
+
400: components["responses"]["E400"];
|
|
5179
|
+
401: components["responses"]["E401"];
|
|
5180
|
+
403: components["responses"]["E403"];
|
|
5181
|
+
404: components["responses"]["E404"];
|
|
5182
|
+
429: components["responses"]["E429"];
|
|
5183
|
+
};
|
|
5184
|
+
};
|
|
5185
|
+
grantFileUpload: {
|
|
5186
|
+
parameters: {
|
|
5187
|
+
query?: never;
|
|
5188
|
+
header?: never;
|
|
5189
|
+
path: {
|
|
5190
|
+
/** @description The project's UUID. */
|
|
5191
|
+
uuid: string;
|
|
5192
|
+
};
|
|
5193
|
+
cookie?: never;
|
|
5194
|
+
};
|
|
5195
|
+
requestBody: {
|
|
5196
|
+
content: {
|
|
5197
|
+
"application/json": components["schemas"]["FileGrantRequest"];
|
|
5198
|
+
};
|
|
5199
|
+
};
|
|
5200
|
+
responses: {
|
|
5201
|
+
/** @description A grant */
|
|
5202
|
+
201: {
|
|
5203
|
+
headers: {
|
|
5204
|
+
[name: string]: unknown;
|
|
5205
|
+
};
|
|
5206
|
+
content: {
|
|
5207
|
+
"application/json": components["schemas"]["FileGrant"];
|
|
5208
|
+
};
|
|
5209
|
+
};
|
|
5210
|
+
400: components["responses"]["E400"];
|
|
5211
|
+
401: components["responses"]["E401"];
|
|
5212
|
+
403: components["responses"]["E403"];
|
|
5213
|
+
404: components["responses"]["E404"];
|
|
5214
|
+
429: components["responses"]["E429"];
|
|
5215
|
+
};
|
|
5216
|
+
};
|
|
5217
|
+
openFileLink: {
|
|
5218
|
+
parameters: {
|
|
5219
|
+
query?: never;
|
|
5220
|
+
header?: never;
|
|
5221
|
+
path: {
|
|
5222
|
+
/** @description The project's UUID. */
|
|
5223
|
+
uuid: string;
|
|
5224
|
+
token: string;
|
|
5225
|
+
};
|
|
5226
|
+
cookie?: never;
|
|
5227
|
+
};
|
|
5228
|
+
requestBody?: never;
|
|
5229
|
+
responses: {
|
|
5230
|
+
/** @description The file, with the type it was stored with */
|
|
5231
|
+
200: {
|
|
5232
|
+
headers: {
|
|
5233
|
+
[name: string]: unknown;
|
|
5234
|
+
};
|
|
5235
|
+
content: {
|
|
5236
|
+
"application/pdf": string;
|
|
5237
|
+
"image/png": string;
|
|
5238
|
+
"image/jpeg": string;
|
|
5239
|
+
"image/gif": string;
|
|
5240
|
+
"image/webp": string;
|
|
5241
|
+
"image/heic": string;
|
|
5242
|
+
"image/svg+xml": string;
|
|
5243
|
+
"text/plain": string;
|
|
5244
|
+
"text/csv": string;
|
|
5245
|
+
"text/html": string;
|
|
5246
|
+
"text/markdown": string;
|
|
5247
|
+
"text/calendar": string;
|
|
5248
|
+
"application/json": string;
|
|
5249
|
+
"application/xml": string;
|
|
5250
|
+
"text/xml": string;
|
|
5251
|
+
"application/zip": string;
|
|
5252
|
+
"application/msword": string;
|
|
5253
|
+
"application/rtf": string;
|
|
5254
|
+
"application/vnd.ms-excel": string;
|
|
5255
|
+
"application/vnd.openxmlformats-officedocument.wordprocessingml.document": string;
|
|
5256
|
+
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": string;
|
|
5257
|
+
"application/vnd.oasis.opendocument.text": string;
|
|
5258
|
+
"application/vnd.oasis.opendocument.spreadsheet": string;
|
|
5259
|
+
"audio/mpeg": string;
|
|
5260
|
+
"audio/mp4": string;
|
|
5261
|
+
"audio/ogg": string;
|
|
5262
|
+
"audio/wav": string;
|
|
5263
|
+
"audio/webm": string;
|
|
5264
|
+
"video/mp4": string;
|
|
5265
|
+
"video/webm": string;
|
|
5266
|
+
"video/quicktime": string;
|
|
5267
|
+
"application/octet-stream": string;
|
|
5268
|
+
};
|
|
5269
|
+
};
|
|
5270
|
+
403: components["responses"]["E403"];
|
|
5271
|
+
404: components["responses"]["E404"];
|
|
5272
|
+
429: components["responses"]["E429"];
|
|
5273
|
+
};
|
|
5274
|
+
};
|
|
5275
|
+
uploadWithGrant: {
|
|
5276
|
+
parameters: {
|
|
5277
|
+
query?: never;
|
|
5278
|
+
header?: never;
|
|
5279
|
+
path: {
|
|
5280
|
+
/** @description The project's UUID. */
|
|
5281
|
+
uuid: string;
|
|
5282
|
+
token: string;
|
|
5283
|
+
};
|
|
5284
|
+
cookie?: never;
|
|
5285
|
+
};
|
|
5286
|
+
requestBody: {
|
|
5287
|
+
content: {
|
|
5288
|
+
"multipart/form-data": components["schemas"]["FileGrantUpload"];
|
|
5289
|
+
};
|
|
5290
|
+
};
|
|
5291
|
+
responses: {
|
|
5292
|
+
/** @description Stored */
|
|
5293
|
+
201: {
|
|
5294
|
+
headers: {
|
|
5295
|
+
[name: string]: unknown;
|
|
5296
|
+
};
|
|
5297
|
+
content: {
|
|
5298
|
+
"application/json": components["schemas"]["StoredFile"];
|
|
5299
|
+
};
|
|
5300
|
+
};
|
|
5301
|
+
400: components["responses"]["E400"];
|
|
5302
|
+
403: components["responses"]["E403"];
|
|
5303
|
+
413: components["responses"]["E413"];
|
|
5304
|
+
415: components["responses"]["E415"];
|
|
5305
|
+
429: components["responses"]["E429"];
|
|
5306
|
+
};
|
|
5307
|
+
};
|
|
5308
|
+
exportSetup: {
|
|
5309
|
+
parameters: {
|
|
5310
|
+
query?: never;
|
|
5311
|
+
header?: never;
|
|
5312
|
+
path: {
|
|
5313
|
+
/** @description The project's UUID. */
|
|
5314
|
+
uuid: string;
|
|
5315
|
+
};
|
|
5316
|
+
cookie?: never;
|
|
5317
|
+
};
|
|
5318
|
+
requestBody?: never;
|
|
5319
|
+
responses: {
|
|
5320
|
+
/** @description OK */
|
|
5321
|
+
200: {
|
|
5322
|
+
headers: {
|
|
5323
|
+
[name: string]: unknown;
|
|
5324
|
+
};
|
|
5325
|
+
content: {
|
|
5326
|
+
"application/json": components["schemas"]["SetupFile"];
|
|
5327
|
+
};
|
|
5328
|
+
};
|
|
5329
|
+
401: components["responses"]["E401"];
|
|
5330
|
+
403: components["responses"]["E403"];
|
|
5331
|
+
429: components["responses"]["E429"];
|
|
5332
|
+
};
|
|
5333
|
+
};
|
|
5334
|
+
previewSetup: {
|
|
5335
|
+
parameters: {
|
|
5336
|
+
query?: never;
|
|
5337
|
+
header?: never;
|
|
5338
|
+
path: {
|
|
5339
|
+
/** @description The project's UUID. */
|
|
5340
|
+
uuid: string;
|
|
5341
|
+
};
|
|
5342
|
+
cookie?: never;
|
|
5343
|
+
};
|
|
5344
|
+
requestBody: {
|
|
5345
|
+
content: {
|
|
5346
|
+
"application/json": components["schemas"]["SetupPreviewRequest"];
|
|
5347
|
+
};
|
|
5348
|
+
};
|
|
5349
|
+
responses: {
|
|
5350
|
+
/** @description OK */
|
|
5351
|
+
200: {
|
|
5352
|
+
headers: {
|
|
5353
|
+
[name: string]: unknown;
|
|
5354
|
+
};
|
|
5355
|
+
content: {
|
|
5356
|
+
"application/json": components["schemas"]["SetupPreview"];
|
|
5357
|
+
};
|
|
5358
|
+
};
|
|
5359
|
+
401: components["responses"]["E401"];
|
|
5360
|
+
403: components["responses"]["E403"];
|
|
5361
|
+
413: components["responses"]["E413"];
|
|
5362
|
+
429: components["responses"]["E429"];
|
|
5363
|
+
};
|
|
5364
|
+
};
|
|
5365
|
+
previewPromoteContent: {
|
|
5366
|
+
parameters: {
|
|
5367
|
+
query?: never;
|
|
5368
|
+
header: {
|
|
5369
|
+
/** @description The target project's setup key (it names the target). */
|
|
5370
|
+
"X-VeroXM-Target-Key": string;
|
|
5371
|
+
};
|
|
5372
|
+
path: {
|
|
5373
|
+
/** @description The project's UUID. */
|
|
5374
|
+
uuid: string;
|
|
5375
|
+
};
|
|
5376
|
+
cookie?: never;
|
|
5377
|
+
};
|
|
5378
|
+
requestBody: {
|
|
5379
|
+
content: {
|
|
5380
|
+
"application/json": components["schemas"]["PromoteContentRequest"];
|
|
5381
|
+
};
|
|
5382
|
+
};
|
|
5383
|
+
responses: {
|
|
5384
|
+
/** @description OK */
|
|
5385
|
+
200: {
|
|
5386
|
+
headers: {
|
|
5387
|
+
[name: string]: unknown;
|
|
5388
|
+
};
|
|
5389
|
+
content: {
|
|
5390
|
+
"application/json": components["schemas"]["ContentPromotionPreview"];
|
|
5391
|
+
};
|
|
5392
|
+
};
|
|
5393
|
+
400: components["responses"]["E400"];
|
|
5394
|
+
401: components["responses"]["E401"];
|
|
5395
|
+
403: components["responses"]["E403"];
|
|
5396
|
+
404: components["responses"]["E404"];
|
|
5397
|
+
429: components["responses"]["E429"];
|
|
5398
|
+
};
|
|
5399
|
+
};
|
|
5400
|
+
promoteContent: {
|
|
5401
|
+
parameters: {
|
|
5402
|
+
query?: never;
|
|
5403
|
+
header: {
|
|
5404
|
+
/** @description The target project's setup key (it names the target). */
|
|
5405
|
+
"X-VeroXM-Target-Key": string;
|
|
5406
|
+
};
|
|
5407
|
+
path: {
|
|
5408
|
+
/** @description The project's UUID. */
|
|
5409
|
+
uuid: string;
|
|
5410
|
+
};
|
|
5411
|
+
cookie?: never;
|
|
5412
|
+
};
|
|
5413
|
+
requestBody: {
|
|
5414
|
+
content: {
|
|
5415
|
+
"application/json": components["schemas"]["PromoteContentRequest"];
|
|
5416
|
+
};
|
|
5417
|
+
};
|
|
5418
|
+
responses: {
|
|
5419
|
+
/** @description OK */
|
|
5420
|
+
200: {
|
|
5421
|
+
headers: {
|
|
5422
|
+
[name: string]: unknown;
|
|
5423
|
+
};
|
|
5424
|
+
content: {
|
|
5425
|
+
"application/json": components["schemas"]["ContentPromotionResult"];
|
|
5426
|
+
};
|
|
5427
|
+
};
|
|
5428
|
+
400: components["responses"]["E400"];
|
|
5429
|
+
401: components["responses"]["E401"];
|
|
5430
|
+
403: components["responses"]["E403"];
|
|
5431
|
+
404: components["responses"]["E404"];
|
|
5432
|
+
409: components["responses"]["E409"];
|
|
5433
|
+
429: components["responses"]["E429"];
|
|
5434
|
+
};
|
|
5435
|
+
};
|
|
5436
|
+
getProjectTypes: {
|
|
5437
|
+
parameters: {
|
|
5438
|
+
query?: never;
|
|
5439
|
+
header?: never;
|
|
5440
|
+
path: {
|
|
5441
|
+
/** @description The project's UUID. */
|
|
5442
|
+
uuid: string;
|
|
5443
|
+
};
|
|
5444
|
+
cookie?: never;
|
|
5445
|
+
};
|
|
5446
|
+
requestBody?: never;
|
|
5447
|
+
responses: {
|
|
5448
|
+
/** @description OK */
|
|
5449
|
+
200: {
|
|
5450
|
+
headers: {
|
|
5451
|
+
[name: string]: unknown;
|
|
5452
|
+
};
|
|
5453
|
+
content: {
|
|
5454
|
+
"application/json": components["schemas"]["ProjectTypes"];
|
|
4692
5455
|
};
|
|
4693
5456
|
};
|
|
4694
5457
|
401: components["responses"]["E401"];
|
|
@@ -4851,6 +5614,39 @@ export interface operations {
|
|
|
4851
5614
|
429: components["responses"]["E429"];
|
|
4852
5615
|
};
|
|
4853
5616
|
};
|
|
5617
|
+
invokeFunction: {
|
|
5618
|
+
parameters: {
|
|
5619
|
+
query?: never;
|
|
5620
|
+
header?: never;
|
|
5621
|
+
path: {
|
|
5622
|
+
/** @description The project's UUID. */
|
|
5623
|
+
uuid: string;
|
|
5624
|
+
name: string;
|
|
5625
|
+
};
|
|
5626
|
+
cookie?: never;
|
|
5627
|
+
};
|
|
5628
|
+
requestBody: {
|
|
5629
|
+
content: {
|
|
5630
|
+
"application/json": components["schemas"]["FunctionInvokeRequest"];
|
|
5631
|
+
};
|
|
5632
|
+
};
|
|
5633
|
+
responses: {
|
|
5634
|
+
/** @description OK */
|
|
5635
|
+
200: {
|
|
5636
|
+
headers: {
|
|
5637
|
+
[name: string]: unknown;
|
|
5638
|
+
};
|
|
5639
|
+
content: {
|
|
5640
|
+
"application/json": components["schemas"]["FunctionInvoked"];
|
|
5641
|
+
};
|
|
5642
|
+
};
|
|
5643
|
+
400: components["responses"]["E400"];
|
|
5644
|
+
401: components["responses"]["E401"];
|
|
5645
|
+
403: components["responses"]["E403"];
|
|
5646
|
+
404: components["responses"]["E404"];
|
|
5647
|
+
429: components["responses"]["E429"];
|
|
5648
|
+
};
|
|
5649
|
+
};
|
|
4854
5650
|
applySetup: {
|
|
4855
5651
|
parameters: {
|
|
4856
5652
|
query?: never;
|
package/dist/index.d.ts
CHANGED
|
@@ -19,6 +19,8 @@ export { ProcessesResource } from './processes.js';
|
|
|
19
19
|
export type { ProcessRun, ProcessRunDetail, ProcessRunListOptions } from './processes.js';
|
|
20
20
|
export { FormsResource } from './forms.js';
|
|
21
21
|
export type { FormDetail, FormResponse, FormResponseListOptions, FormResponsePage, FormSummary } from './forms.js';
|
|
22
|
+
export { FilesResource, uploadWithGrant } from './files.js';
|
|
23
|
+
export type { FileFolderRule, FileGrant, FileGrantOptions, StoredFile, StoredFileEvent, StoredFileEventOptions, StoredFileEventPage, StoredFileLink, StoredFileListOptions, StoredFilePage } from './files.js';
|
|
22
24
|
export { TranslationsResource, fetchTranslations, fetchTranslationResource, fetchTranslationLocales, createTranslator, VeroxmI18nextBackend, } from './translations.js';
|
|
23
25
|
export type { FetchTranslationsOptions, TranslationBundle, TranslationBundleOptions, TranslationLocale, TranslationLocales, TranslationTexts, TranslationValues, Translator, VeroxmI18nextBackendOptions, } from './translations.js';
|
|
24
26
|
export { embedForm, embedFormsFromPage } from './embed.js';
|
package/dist/index.js
CHANGED
|
@@ -10,6 +10,8 @@ export { FunctionsResource } from './functions.js';
|
|
|
10
10
|
export { TasksResource } from './tasks.js';
|
|
11
11
|
export { ProcessesResource } from './processes.js';
|
|
12
12
|
export { FormsResource } from './forms.js';
|
|
13
|
+
// Private files: a server key's, and one-time upload links a browser uses.
|
|
14
|
+
export { FilesResource, uploadWithGrant } from './files.js';
|
|
13
15
|
// App translations: a locale's bundle in one request, and a t() for its texts.
|
|
14
16
|
export { TranslationsResource, fetchTranslations, fetchTranslationResource, fetchTranslationLocales, createTranslator, VeroxmI18nextBackend, } from './translations.js';
|
|
15
17
|
// Showing forms in a page: inline, popup, full page or toast.
|