@nivaro/sdk 0.1.16 → 0.1.18
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/README.md +93 -0
- package/bin/lib/ext-scaffold.mjs +220 -0
- package/bin/lib/graphql-codegen.mjs +737 -0
- package/bin/nivaro.mjs +150 -29
- package/dist/index.d.ts +290 -1
- package/dist/index.js +126 -0
- package/package.json +4 -2
package/bin/nivaro.mjs
CHANGED
|
@@ -2,20 +2,34 @@
|
|
|
2
2
|
/**
|
|
3
3
|
* nivaro — the @nivaro/sdk command line.
|
|
4
4
|
*
|
|
5
|
-
* nivaro types [--url <api origin>] [--token <
|
|
5
|
+
* nivaro types [--url <api origin>] [--token <token>] [--out <file>] [--typed-client | --graphql]
|
|
6
|
+
* nivaro ext init <id> [--dir <extensions dir>]
|
|
6
7
|
*
|
|
7
|
-
*
|
|
8
|
-
* instance
|
|
8
|
+
* `types` writes TypeScript generated from the LIVE schema of a Nivaro
|
|
9
|
+
* instance: one interface per collection + a `Collections` name map, or with
|
|
9
10
|
* --typed-client the same file plus a thin typed wrapper over createNivaro().
|
|
11
|
+
* Those two read admin-only dev-tools endpoints (an admin static token, or an
|
|
12
|
+
* API key with the dev-tools scope).
|
|
10
13
|
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
+
* `types --graphql` introspects the GraphQL schema AS THE TOKEN'S USER and
|
|
15
|
+
* writes a standalone typed GraphQL client: list / byId / create / update /
|
|
16
|
+
* delete / aggregated / metadata per collection the user may see, with filter
|
|
17
|
+
* and selection types, plus a graphql(doc, variables) escape hatch.
|
|
18
|
+
*
|
|
19
|
+
* `ext init` scaffolds an extension written against @nivaro/extension-kit.
|
|
20
|
+
*
|
|
21
|
+
* The URL and token also come from NIVARO_URL / NIVARO_TOKEN.
|
|
14
22
|
*
|
|
15
23
|
* Exit codes: 0 written · 1 usage · 2 request failed.
|
|
16
24
|
*/
|
|
17
25
|
import { mkdirSync, writeFileSync } from 'node:fs'
|
|
18
|
-
import { dirname, resolve } from 'node:path'
|
|
26
|
+
import { dirname, relative, resolve } from 'node:path'
|
|
27
|
+
import { defaultExtensionsDir, validateExtensionId, writeScaffold } from './lib/ext-scaffold.mjs'
|
|
28
|
+
import {
|
|
29
|
+
accessFromPermissions,
|
|
30
|
+
generateGraphQLClient,
|
|
31
|
+
INTROSPECTION_QUERY
|
|
32
|
+
} from './lib/graphql-codegen.mjs'
|
|
19
33
|
|
|
20
34
|
const argv = process.argv.slice(2)
|
|
21
35
|
const cmd = argv[0]
|
|
@@ -30,19 +44,66 @@ const has = (name) => argv.includes(`--${name}`)
|
|
|
30
44
|
function usage(code = 1) {
|
|
31
45
|
process.stderr.write(
|
|
32
46
|
[
|
|
33
|
-
'Usage:
|
|
47
|
+
'Usage:',
|
|
48
|
+
' nivaro types [--url <api origin>] [--token <token>] [--out <file>] [--typed-client | --graphql]',
|
|
49
|
+
' nivaro ext init <id> [--dir <extensions dir>]',
|
|
34
50
|
'',
|
|
35
51
|
' --url API origin, e.g. https://cms.example.com (or NIVARO_URL)',
|
|
36
|
-
' --token
|
|
52
|
+
' --token Static token or API key (or NIVARO_TOKEN); admin / dev-tools scope',
|
|
53
|
+
' for the REST types, any user for --graphql',
|
|
37
54
|
' --out File to write; stdout when omitted',
|
|
38
55
|
' --typed-client Emit the typed createTypedNivaro() wrapper too',
|
|
56
|
+
" --graphql Emit a typed GraphQL client for the token's user",
|
|
57
|
+
' --dir Where `ext init` creates <id>/ (default api/extensions)',
|
|
39
58
|
''
|
|
40
59
|
].join('\n')
|
|
41
60
|
)
|
|
42
61
|
process.exit(code)
|
|
43
62
|
}
|
|
44
63
|
|
|
64
|
+
function fail(msg, code) {
|
|
65
|
+
process.stderr.write(`${msg}\n`)
|
|
66
|
+
process.exit(code)
|
|
67
|
+
}
|
|
68
|
+
|
|
45
69
|
if (!cmd || cmd === '--help' || cmd === '-h') usage(cmd ? 0 : 1)
|
|
70
|
+
|
|
71
|
+
if (cmd === 'ext') {
|
|
72
|
+
const sub = argv[1]
|
|
73
|
+
const id = argv[2]
|
|
74
|
+
if (sub !== 'init') {
|
|
75
|
+
process.stderr.write(sub ? `Unknown ext command "${sub}"\n\n` : '')
|
|
76
|
+
usage(1)
|
|
77
|
+
}
|
|
78
|
+
const bad = validateExtensionId(id)
|
|
79
|
+
if (bad) fail(bad, 1)
|
|
80
|
+
if (has('dir') && (!flag('dir') || flag('dir').startsWith('--')))
|
|
81
|
+
fail('--dir needs a directory path', 1)
|
|
82
|
+
const dir = has('dir') ? resolve(flag('dir')) : defaultExtensionsDir()
|
|
83
|
+
let result
|
|
84
|
+
try {
|
|
85
|
+
result = writeScaffold(id, dir)
|
|
86
|
+
} catch (err) {
|
|
87
|
+
fail(err instanceof Error ? err.message : String(err), 1)
|
|
88
|
+
}
|
|
89
|
+
const rel = (p) => relative(process.cwd(), p) || '.'
|
|
90
|
+
process.stderr.write(
|
|
91
|
+
[
|
|
92
|
+
`Created ${rel(result.target)}/`,
|
|
93
|
+
...result.written.map((f) => ` ${rel(f)}`),
|
|
94
|
+
result.hasTsconfig
|
|
95
|
+
? ''
|
|
96
|
+
: `\nNo tsconfig.json in ${rel(dir)} — type-check it from a project that includes the folder (api/extensions/tsconfig.json does).`,
|
|
97
|
+
'Next: restart the API so the loader picks it up, then run its test:',
|
|
98
|
+
` (cd api && npx vitest run extensions/${id})`,
|
|
99
|
+
''
|
|
100
|
+
]
|
|
101
|
+
.filter((l) => l !== '')
|
|
102
|
+
.join('\n') + '\n'
|
|
103
|
+
)
|
|
104
|
+
process.exit(0)
|
|
105
|
+
}
|
|
106
|
+
|
|
46
107
|
if (cmd !== 'types') {
|
|
47
108
|
process.stderr.write(`Unknown command "${cmd}"\n\n`)
|
|
48
109
|
usage(1)
|
|
@@ -59,17 +120,87 @@ if (!token) {
|
|
|
59
120
|
process.stderr.write('Missing --token (or NIVARO_TOKEN)\n')
|
|
60
121
|
usage(1)
|
|
61
122
|
}
|
|
123
|
+
if (has('graphql') && has('typed-client')) {
|
|
124
|
+
process.stderr.write('--graphql and --typed-client are separate outputs — pick one\n')
|
|
125
|
+
usage(1)
|
|
126
|
+
}
|
|
62
127
|
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
128
|
+
function write(text, summary) {
|
|
129
|
+
if (out) {
|
|
130
|
+
const file = resolve(out)
|
|
131
|
+
mkdirSync(dirname(file), { recursive: true })
|
|
132
|
+
writeFileSync(file, text, 'utf8')
|
|
133
|
+
process.stderr.write(`Wrote ${file} — ${summary}\n`)
|
|
134
|
+
} else {
|
|
135
|
+
process.stdout.write(text)
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
async function request(path, init) {
|
|
140
|
+
try {
|
|
141
|
+
return await fetch(`${url}${path}`, init)
|
|
142
|
+
} catch (err) {
|
|
143
|
+
fail(`Request failed: ${err instanceof Error ? err.message : String(err)}`, 2)
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
if (has('graphql')) {
|
|
148
|
+
// The schema is the same for everyone and introspection needs no sign-in, so
|
|
149
|
+
// the token is checked here: a refused token fails the command, and the
|
|
150
|
+
// caller's role decides which helpers are written.
|
|
151
|
+
const permsRes = await request('/api/security/my/permissions', {
|
|
152
|
+
headers: { authorization: `Bearer ${token}`, accept: 'application/json' }
|
|
68
153
|
})
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
154
|
+
const permsText = await permsRes.text()
|
|
155
|
+
let access = null
|
|
156
|
+
if (permsRes.status === 401 || permsRes.status === 403) {
|
|
157
|
+
let msg = permsText
|
|
158
|
+
try {
|
|
159
|
+
msg = JSON.parse(permsText)?.error ?? permsText
|
|
160
|
+
} catch {
|
|
161
|
+
/* plain body */
|
|
162
|
+
}
|
|
163
|
+
fail(`Token refused (HTTP ${permsRes.status}): ${String(msg).slice(0, 300)}`, 2)
|
|
164
|
+
} else if (permsRes.ok) {
|
|
165
|
+
try {
|
|
166
|
+
access = accessFromPermissions(JSON.parse(permsText)?.data ?? null)
|
|
167
|
+
} catch {
|
|
168
|
+
access = null
|
|
169
|
+
}
|
|
170
|
+
} else {
|
|
171
|
+
process.stderr.write(
|
|
172
|
+
`Could not read the token's permissions (HTTP ${permsRes.status}) — writing helpers for every collection\n`
|
|
173
|
+
)
|
|
174
|
+
}
|
|
175
|
+
const res = await request('/api/graphql', {
|
|
176
|
+
method: 'POST',
|
|
177
|
+
headers: {
|
|
178
|
+
authorization: `Bearer ${token}`,
|
|
179
|
+
'content-type': 'application/json',
|
|
180
|
+
accept: 'application/json'
|
|
181
|
+
},
|
|
182
|
+
body: JSON.stringify({ query: INTROSPECTION_QUERY, operationName: 'NivaroIntrospection' })
|
|
183
|
+
})
|
|
184
|
+
const text = await res.text()
|
|
185
|
+
let json = null
|
|
186
|
+
try {
|
|
187
|
+
json = JSON.parse(text)
|
|
188
|
+
} catch {
|
|
189
|
+
json = null
|
|
190
|
+
}
|
|
191
|
+
if (json?.errors?.length) fail(`GraphQL error: ${String(json.errors[0].message).slice(0, 300)}`, 2)
|
|
192
|
+
if (!res.ok || !json?.data?.__schema)
|
|
193
|
+
fail(`HTTP ${res.status}: ${String(json?.error ?? text).slice(0, 300)}`, 2)
|
|
194
|
+
const src = generateGraphQLClient(json.data.__schema, { source: url, access })
|
|
195
|
+
const collections = (src.match(/^ {4}[A-Za-z_$][\w$]*: \{$/gm) ?? []).length
|
|
196
|
+
write(src, `${collections} collection(s)`)
|
|
197
|
+
process.exit(0)
|
|
72
198
|
}
|
|
199
|
+
|
|
200
|
+
const path = has('typed-client') ? '/api/dev-tools/typed-client.ts' : '/api/dev-tools/types.ts'
|
|
201
|
+
const res = await request(path, {
|
|
202
|
+
headers: { authorization: `Bearer ${token}`, accept: 'text/plain' }
|
|
203
|
+
})
|
|
73
204
|
const text = await res.text()
|
|
74
205
|
if (!res.ok) {
|
|
75
206
|
let msg = text
|
|
@@ -78,16 +209,6 @@ if (!res.ok) {
|
|
|
78
209
|
} catch {
|
|
79
210
|
/* plain body */
|
|
80
211
|
}
|
|
81
|
-
|
|
82
|
-
process.exit(2)
|
|
83
|
-
}
|
|
84
|
-
|
|
85
|
-
if (out) {
|
|
86
|
-
const file = resolve(out)
|
|
87
|
-
mkdirSync(dirname(file), { recursive: true })
|
|
88
|
-
writeFileSync(file, text, 'utf8')
|
|
89
|
-
const interfaces = (text.match(/^export interface /gm) ?? []).length
|
|
90
|
-
process.stderr.write(`Wrote ${file} — ${interfaces} interface(s)\n`)
|
|
91
|
-
} else {
|
|
92
|
-
process.stdout.write(text)
|
|
212
|
+
fail(`HTTP ${res.status}: ${String(msg).slice(0, 300)}`, 2)
|
|
93
213
|
}
|
|
214
|
+
write(text, `${(text.match(/^export interface /gm) ?? []).length} interface(s)`)
|
package/dist/index.d.ts
CHANGED
|
@@ -4492,6 +4492,263 @@ declare function fileTransformPath(id: string, options?: {
|
|
|
4492
4492
|
quality?: number;
|
|
4493
4493
|
}): string;
|
|
4494
4494
|
|
|
4495
|
+
/**
|
|
4496
|
+
* Help videos: tutorial recordings with edits, versions, where they show,
|
|
4497
|
+
* required viewing and progress. Upload parts are raw octet-stream PUTs to
|
|
4498
|
+
* /help-videos/uploads/:id/parts/:n (see README); everything else is here.
|
|
4499
|
+
*
|
|
4500
|
+
* Error codes callers must handle (all JSON `{ error, code }`):
|
|
4501
|
+
* - 409 `HELP_VIDEO_PROCESSING`: a viewer's `stream_url` answers this while the
|
|
4502
|
+
* video is still being rendered (check `published.playable` first).
|
|
4503
|
+
* - 409 `HELP_VIDEO_EDITS_CONFLICT`: `saveHelpVideoDraft` with a stale
|
|
4504
|
+
* `base_hash`; the body also carries `current_hash`.
|
|
4505
|
+
* - 409 `UPLOAD_CLOSED`: the upload was already finalized or is finishing.
|
|
4506
|
+
* - 422 `UPLOAD_NOT_VIDEO`: a part is not a WebM or MP4 recording.
|
|
4507
|
+
* - 422 `UPLOAD_TOO_LONG`: the recording is over 30 minutes (finalize).
|
|
4508
|
+
* Also: 403 `HELP_VIDEO_AUTHOR_ONLY` on any authoring command by a non-author,
|
|
4509
|
+
* 404 `HELP_VIDEO_NOT_FOUND` for an unknown or invisible video.
|
|
4510
|
+
*/
|
|
4511
|
+
|
|
4512
|
+
type HelpVideoContext = {
|
|
4513
|
+
kind: 'collection' | 'page';
|
|
4514
|
+
key: string;
|
|
4515
|
+
state_key: string | null;
|
|
4516
|
+
};
|
|
4517
|
+
type HelpVideoVisibility = {
|
|
4518
|
+
mode: 'everyone' | 'roles';
|
|
4519
|
+
role_ids: string[];
|
|
4520
|
+
};
|
|
4521
|
+
interface HelpVideoVersion {
|
|
4522
|
+
id: string;
|
|
4523
|
+
version: number;
|
|
4524
|
+
edits: Record<string, unknown>;
|
|
4525
|
+
edits_hash: string;
|
|
4526
|
+
source_duration_ms: number | null;
|
|
4527
|
+
width: number | null;
|
|
4528
|
+
height: number | null;
|
|
4529
|
+
render_status: 'none' | 'queued' | 'rendering' | 'ready' | 'failed' | 'unavailable';
|
|
4530
|
+
render_progress: number | null;
|
|
4531
|
+
render_error: string | null;
|
|
4532
|
+
rendered_current: boolean;
|
|
4533
|
+
/** Published version only: false when a non-author would get a 409 HELP_VIDEO_PROCESSING. */
|
|
4534
|
+
playable?: boolean;
|
|
4535
|
+
note: string | null;
|
|
4536
|
+
created_at: string;
|
|
4537
|
+
/** Draft, re-record and restore results only (recorder data). Clicks on the
|
|
4538
|
+
* recorded tab: `t_ms` source time, `x`/`y` fractions (0–1) of the frame. */
|
|
4539
|
+
clicks?: Array<{
|
|
4540
|
+
t_ms: number;
|
|
4541
|
+
x: number;
|
|
4542
|
+
y: number;
|
|
4543
|
+
}> | null;
|
|
4544
|
+
/** Microphone loudness 0–1, one value per 100 ms of source time. */
|
|
4545
|
+
levels?: number[] | null;
|
|
4546
|
+
}
|
|
4547
|
+
interface HelpVideoProgress {
|
|
4548
|
+
position_ms: number;
|
|
4549
|
+
completed: boolean;
|
|
4550
|
+
percent: number;
|
|
4551
|
+
}
|
|
4552
|
+
interface HelpVideo {
|
|
4553
|
+
id: string;
|
|
4554
|
+
title: string;
|
|
4555
|
+
description: string | null;
|
|
4556
|
+
category: string | null;
|
|
4557
|
+
status: 'draft' | 'published' | 'archived';
|
|
4558
|
+
duration_ms: number | null;
|
|
4559
|
+
/** Ticketed URLs (`?st=`): play them as-is, do not rebuild them. */
|
|
4560
|
+
poster_url: string | null;
|
|
4561
|
+
stream_url: string | null;
|
|
4562
|
+
captions_url: string | null;
|
|
4563
|
+
contexts: HelpVideoContext[];
|
|
4564
|
+
/** Required for THIS viewer's role (not for the video in general). */
|
|
4565
|
+
required: boolean;
|
|
4566
|
+
published: HelpVideoVersion | null;
|
|
4567
|
+
/** Authors only. */
|
|
4568
|
+
visibility?: HelpVideoVisibility;
|
|
4569
|
+
required_role_ids?: string[];
|
|
4570
|
+
draft?: HelpVideoVersion | null;
|
|
4571
|
+
/** Author-only: the draft is exactly the published version; publishing it
|
|
4572
|
+
* answers 409 `HELP_VIDEO_NOTHING_TO_PUBLISH`. */
|
|
4573
|
+
draft_matches_published?: boolean;
|
|
4574
|
+
draft_stream_url?: string | null;
|
|
4575
|
+
draft_captions_url?: string | null;
|
|
4576
|
+
created_by_name?: string | null;
|
|
4577
|
+
updated_at: string;
|
|
4578
|
+
my_progress: HelpVideoProgress | null;
|
|
4579
|
+
}
|
|
4580
|
+
/** An upload session, as returned by open, each part PUT and "my uploads". */
|
|
4581
|
+
interface HelpVideoUploadSession {
|
|
4582
|
+
id: string;
|
|
4583
|
+
mime: string;
|
|
4584
|
+
bytes_received: number;
|
|
4585
|
+
next_part: number;
|
|
4586
|
+
/** `open` while parts arrive; `finalized` once uploaded (listed by
|
|
4587
|
+
* `listMyHelpVideoUploads` only while no video uses it). */
|
|
4588
|
+
status: string;
|
|
4589
|
+
/** Probed length of a finalized recording; null while open. */
|
|
4590
|
+
duration_ms: number | null;
|
|
4591
|
+
created_at: string;
|
|
4592
|
+
updated_at: string;
|
|
4593
|
+
}
|
|
4594
|
+
interface HelpVideoFinalizedUpload {
|
|
4595
|
+
file_id: string;
|
|
4596
|
+
duration_ms: number | null;
|
|
4597
|
+
width: number | null;
|
|
4598
|
+
height: number | null;
|
|
4599
|
+
has_audio: boolean;
|
|
4600
|
+
clicks: unknown;
|
|
4601
|
+
levels: unknown;
|
|
4602
|
+
}
|
|
4603
|
+
declare function listHelpVideos(params?: {
|
|
4604
|
+
search?: string;
|
|
4605
|
+
category?: string;
|
|
4606
|
+
status?: string;
|
|
4607
|
+
page?: number;
|
|
4608
|
+
limit?: number;
|
|
4609
|
+
}): Command<{
|
|
4610
|
+
data: HelpVideo[];
|
|
4611
|
+
total: number;
|
|
4612
|
+
categories: string[];
|
|
4613
|
+
can_author: boolean;
|
|
4614
|
+
}>;
|
|
4615
|
+
declare function readHelpVideo(id: string): Command<{
|
|
4616
|
+
data: HelpVideo;
|
|
4617
|
+
}>;
|
|
4618
|
+
declare function helpVideosFor(params: {
|
|
4619
|
+
collection?: string;
|
|
4620
|
+
item?: string | number;
|
|
4621
|
+
state?: string;
|
|
4622
|
+
page?: string;
|
|
4623
|
+
}): Command<{
|
|
4624
|
+
data: HelpVideo[];
|
|
4625
|
+
can_author: boolean;
|
|
4626
|
+
state: string | null;
|
|
4627
|
+
}>;
|
|
4628
|
+
declare function createHelpVideo(body: {
|
|
4629
|
+
upload_id: string;
|
|
4630
|
+
title?: string;
|
|
4631
|
+
contexts?: HelpVideoContext[];
|
|
4632
|
+
}): Command<{
|
|
4633
|
+
data: HelpVideo;
|
|
4634
|
+
}>;
|
|
4635
|
+
declare function updateHelpVideo(id: string, body: {
|
|
4636
|
+
title?: string;
|
|
4637
|
+
description?: string | null;
|
|
4638
|
+
category?: string | null;
|
|
4639
|
+
visibility?: HelpVideoVisibility;
|
|
4640
|
+
}): Command<{
|
|
4641
|
+
data: HelpVideo;
|
|
4642
|
+
}>;
|
|
4643
|
+
declare function setHelpVideoContexts(id: string, contexts: HelpVideoContext[]): Command<{
|
|
4644
|
+
data: {
|
|
4645
|
+
ok: true;
|
|
4646
|
+
};
|
|
4647
|
+
}>;
|
|
4648
|
+
declare function setHelpVideoRequirements(id: string, role_ids: string[]): Command<{
|
|
4649
|
+
data: {
|
|
4650
|
+
ok: true;
|
|
4651
|
+
added: string[];
|
|
4652
|
+
};
|
|
4653
|
+
}>;
|
|
4654
|
+
/** Archives the video; `purge: true` deletes it for good (administrators only, and only once it is archived). */
|
|
4655
|
+
declare function archiveHelpVideo(id: string, opts?: {
|
|
4656
|
+
purge?: boolean;
|
|
4657
|
+
}): Command<void>;
|
|
4658
|
+
declare function readHelpVideoDraft(id: string): Command<{
|
|
4659
|
+
data: HelpVideoVersion;
|
|
4660
|
+
}>;
|
|
4661
|
+
/** 409 `HELP_VIDEO_EDITS_CONFLICT` (body carries `current_hash`) when `base_hash` is stale. */
|
|
4662
|
+
declare function saveHelpVideoDraft(id: string, edits: Record<string, unknown>, base_hash?: string): Command<{
|
|
4663
|
+
data: HelpVideoVersion;
|
|
4664
|
+
}>;
|
|
4665
|
+
/** 422 `HELP_VIDEO_NOT_READY` (body lists `missing`) or 409 `HELP_VIDEO_NOTHING_TO_PUBLISH`
|
|
4666
|
+
* (no draft, or the draft equals what is published). With `watch_again` on an
|
|
4667
|
+
* unchanged video someone must watch, the requirement is re-armed instead: no
|
|
4668
|
+
* new version, no render. */
|
|
4669
|
+
declare function publishHelpVideo(id: string, opts?: {
|
|
4670
|
+
watch_again?: boolean;
|
|
4671
|
+
}): Command<{
|
|
4672
|
+
data: HelpVideo;
|
|
4673
|
+
}>;
|
|
4674
|
+
declare function rerecordHelpVideo(id: string, upload_id: string): Command<{
|
|
4675
|
+
data: HelpVideoVersion;
|
|
4676
|
+
}>;
|
|
4677
|
+
declare function listHelpVideoVersions(id: string): Command<{
|
|
4678
|
+
data: Array<HelpVideoVersion & {
|
|
4679
|
+
is_published: boolean;
|
|
4680
|
+
is_draft: boolean;
|
|
4681
|
+
created_by_name: string | null;
|
|
4682
|
+
}>;
|
|
4683
|
+
}>;
|
|
4684
|
+
declare function restoreHelpVideoVersion(id: string, versionId: string): Command<{
|
|
4685
|
+
data: HelpVideoVersion;
|
|
4686
|
+
}>;
|
|
4687
|
+
/** Re-queue the render of the published version (or the draft with `draft`).
|
|
4688
|
+
* 409 `HELP_VIDEO_NOTHING_TO_RENDER` when that version does not exist. */
|
|
4689
|
+
declare function rerenderHelpVideo(id: string, opts?: {
|
|
4690
|
+
draft?: boolean;
|
|
4691
|
+
}): Command<{
|
|
4692
|
+
data: {
|
|
4693
|
+
ok: true;
|
|
4694
|
+
};
|
|
4695
|
+
}>;
|
|
4696
|
+
/** `buckets` is a 20-character string of 0/1: the 5% sections watched so far.
|
|
4697
|
+
* Resolves with no body (204) for a masquerade session, which is never tracked. */
|
|
4698
|
+
declare function recordHelpVideoProgress(id: string, body: {
|
|
4699
|
+
position_ms: number;
|
|
4700
|
+
watched_ms_delta: number;
|
|
4701
|
+
buckets: string;
|
|
4702
|
+
version_id?: string;
|
|
4703
|
+
}): Command<{
|
|
4704
|
+
data: {
|
|
4705
|
+
completed: boolean;
|
|
4706
|
+
};
|
|
4707
|
+
} | undefined>;
|
|
4708
|
+
declare function readRequiredHelpVideos(): Command<{
|
|
4709
|
+
data: HelpVideo[];
|
|
4710
|
+
}>;
|
|
4711
|
+
declare function readHelpVideoAnalytics(id: string): Command<{
|
|
4712
|
+
data: {
|
|
4713
|
+
views: number;
|
|
4714
|
+
unique_viewers: number;
|
|
4715
|
+
completion_rate: number;
|
|
4716
|
+
drop_off: number[];
|
|
4717
|
+
watched_hours: number;
|
|
4718
|
+
};
|
|
4719
|
+
}>;
|
|
4720
|
+
declare function openHelpVideoUpload(mime: string): Command<{
|
|
4721
|
+
data: HelpVideoUploadSession;
|
|
4722
|
+
}>;
|
|
4723
|
+
/** 409 `UPLOAD_CLOSED`, 422 `UPLOAD_TOO_LONG`, 422 `UPLOAD_EMPTY`, 422 `UPLOAD_UNREADABLE`. */
|
|
4724
|
+
declare function finalizeHelpVideoUpload(id: string, meta?: {
|
|
4725
|
+
duration_ms?: number;
|
|
4726
|
+
clicks?: unknown;
|
|
4727
|
+
levels?: unknown;
|
|
4728
|
+
}): Command<{
|
|
4729
|
+
data: HelpVideoFinalizedUpload;
|
|
4730
|
+
}>;
|
|
4731
|
+
/** Your unfinished uploads and finished recordings never saved as a video
|
|
4732
|
+
* (save one with `createHelpVideo` / `rerecordHelpVideo`, no finalize). */
|
|
4733
|
+
declare function listMyHelpVideoUploads(): Command<{
|
|
4734
|
+
data: HelpVideoUploadSession[];
|
|
4735
|
+
}>;
|
|
4736
|
+
/** Discards an open upload, or a finished recording no video uses (its file
|
|
4737
|
+
* is deleted). 409 `UPLOAD_CLOSED` for anything else. */
|
|
4738
|
+
declare function abandonHelpVideoUpload(id: string): Command<void>;
|
|
4739
|
+
declare function listHelpVideoPages(): Command<{
|
|
4740
|
+
data: Array<{
|
|
4741
|
+
key: string;
|
|
4742
|
+
label: string;
|
|
4743
|
+
app: string | null;
|
|
4744
|
+
}>;
|
|
4745
|
+
}>;
|
|
4746
|
+
declare function registerHelpVideoPage(body: {
|
|
4747
|
+
key: string;
|
|
4748
|
+
label: string;
|
|
4749
|
+
app?: string;
|
|
4750
|
+
}): Command<void>;
|
|
4751
|
+
|
|
4495
4752
|
interface ImportTemplateSummary {
|
|
4496
4753
|
id: string;
|
|
4497
4754
|
name: string;
|
|
@@ -5909,6 +6166,38 @@ declare function aggregateItems(collection: string, query: AggregateQuery): Comm
|
|
|
5909
6166
|
declare function readItem<T = Record<string, unknown>>(collection: string, id: string | number): Command<{
|
|
5910
6167
|
data: T;
|
|
5911
6168
|
}>;
|
|
6169
|
+
/** One read inside {@link readMany}. Without `id` it is a list read. */
|
|
6170
|
+
interface BatchRead<T = Record<string, unknown>> {
|
|
6171
|
+
/** Echoed on the result so a caller can match answers to reads; defaults to the index. */
|
|
6172
|
+
key?: string;
|
|
6173
|
+
collection: string;
|
|
6174
|
+
id?: string | number;
|
|
6175
|
+
/** The list read's query (ignored on a single-record read except `fields`). */
|
|
6176
|
+
query?: Query<T> & {
|
|
6177
|
+
conditions?: unknown[];
|
|
6178
|
+
};
|
|
6179
|
+
}
|
|
6180
|
+
/** The answer to one read: its own status, never the whole batch's. */
|
|
6181
|
+
interface BatchReadResult<T = Record<string, unknown>> {
|
|
6182
|
+
key: string;
|
|
6183
|
+
status: number;
|
|
6184
|
+
/** A record (single read) or the page of records (list read). */
|
|
6185
|
+
data?: T | T[];
|
|
6186
|
+
/** A list read's paging facts (`total`, `limit`, `offset`, `next_cursor`, …). */
|
|
6187
|
+
meta?: Record<string, unknown>;
|
|
6188
|
+
error?: string;
|
|
6189
|
+
code?: string;
|
|
6190
|
+
}
|
|
6191
|
+
/** The most reads one {@link readMany} call carries. */
|
|
6192
|
+
declare const READ_MANY_MAX = 20;
|
|
6193
|
+
/**
|
|
6194
|
+
* Several reads in one round trip (`POST /items/batch-read`, at most 20). Each
|
|
6195
|
+
* runs as the caller exactly as its own GET would, and answers its own status —
|
|
6196
|
+
* a forbidden or missing record never fails the others. Writes never batch.
|
|
6197
|
+
*/
|
|
6198
|
+
declare function readMany<T = Record<string, unknown>>(reads: BatchRead<T>[]): Command<{
|
|
6199
|
+
results: BatchReadResult<T>[];
|
|
6200
|
+
}>;
|
|
5912
6201
|
declare function createItem<T = Record<string, unknown>>(collection: string, data: Partial<T>): Command<{
|
|
5913
6202
|
data: T;
|
|
5914
6203
|
}>;
|
|
@@ -7160,4 +7449,4 @@ declare function submitFormItem(collection: string, values: Record<string, unkno
|
|
|
7160
7449
|
data: Record<string, unknown>;
|
|
7161
7450
|
}>;
|
|
7162
7451
|
|
|
7163
|
-
export { type AccessAudit, type AccessAuditFinding, type AccessAuditRun, type AccessAuditSubject, type AccessReason, type ActivityEntry, type ActivityQuery, type ActivityReportQuery, type ActivityReportRow, type ActivityReportSummary, type Addendum, type AddendumStatus, type AggregateQuery, type AggregateRow, type AiChatTraceEntry, type AiCollectionSettings, type AiColumnMapping, type AiDuplicateMatch, type AiQueryFilter, type AiQueryResult, type AiReviewFinding, type AiViolation, type AlertDefinition, type AlertLogEntry, type AlertSubscription, type AnomalyDefinition, type AnomalyRule, type ApiAnalyticsBucket, type ApiAnalyticsCollection, type ApiAnalyticsPath, type ApiAnalyticsSummary, type ApiErrorLog, type ApiKey, type ApiKeyScope, type ApprovalBrief, type ApprovalChain, type ApprovalChainStep, type ApprovalDecision, type ApprovalInstance, type ApprovalInstanceDetail, type ApprovalStatus, type ApprovalStepInput, type AtRiskCondition, type AtRiskOp, type AtRiskResult, type AtRiskRule, type AtRiskSummaryEntry, type AttributeDefinition, type AttributeValue, type BlackoutDate, type BoolFilterOps, type CMSCollection, type CascadeFilterRule, type ChangeOrder, type ChatChannel, type ChatChannelMember, type ChatDirectoryChannel, type ChatMessage, type ChatPin, type ChatReaction, type ChatRoomKind, type ChatRoomSummary, type ChatRoomType, type ChatSearchHit, type CollectionLayout, type CollectionPresetSummary, type Command, type Comment, type ConfigSnapshot, type ConfigTableClassification, type ContentBundle, type ContentExportFormat, type ContentExportOptions, type CoverageGapItem, type CoverageGapOwner, type CoverageGapReport, type CronJob, type CustomQuery, type DataQualityRule, type DataQualityRuleResult, type DataQualityRuleType, type DataQualityRun, type DataQualitySeverity, type DeadLetter, type DraftPublishConfig, type DraftStatus, type DryRunReport, type ErpSubmission, type ErpSubmissionStatus, type ExtensionManifest, type ExternalApi, type ExternalApiEndpoint, type ExternalApiSchema, type ExternalApiSlotContext, type ExternalApiSpecImportResult, type ExternalApiTestResult, type FieldChangeEntry, type FieldCondition, type FieldConfig, type FieldDependencyConfig, type FieldFilter, type FieldGroup, type FieldTranslations, type FieldVisibilityRules, type FieldWatch, type FileRecord, type FileUploadResult, type FileUsageEntry, type Filter, type FlowReplayResult, type FlowRun, type FlowTestStep, type FormFieldDescriptor, type FormFieldRelation, type FormGroupDescriptor, type FormLockCondition, type FormSchema, type FormValidationRule, type FormVisibilityRule, type GlobalSearchRecord, type GlobalSearchResults, type GraphQLResponse, type HierarchyConfigDef, type HierarchyFlatNode, type HierarchyLevelDef, type HierarchyNestedNode, type IDFilterOps, type ISODate, type ImportDefinition, type ImportJob, type ImportParseResponse, type ImportPreview, type ImportPreviewDiff, type ImportTemplateSummary, type InstanceOwner, type IntegrationApiHealth, type InternalWidget, type Issue, type IssueSeverity, type IssueStatus, type IssueSummary, type ItemLock, type LastTouch, type LayoutAssignment, type LayoutGroup, type LayoutVersion, type ListResponse, type ManagedUser, type MetricAlertRule, type MetricAlertSubscription, type MetricDefinition, type MyTask, type MyWorkOwnedEntry, type MyWorkSla, type MyWorkSummary, type NivaroClient, type NivaroClientOptions, type NivaroExtensionPlugin, type NivaroRealtime, type NivaroRuntime, type NotificationItem, type NotificationPage, type NotificationSubscription, type NumberFilterOps, type OmniSearchHit, type OnlinePresenceConfig, type OnlinePresenceUser, type Page, type PageLayout, type PageSlotKey, type PageWidget, type PdfTemplate, type PermissionSimulation, type PersistedQuery, type PickerExclusionStatus, type PipelineFlowEdge, type PipelineFlowState, type PipelineImpactResult, type PipelineOwnerGroup, type PipelineOwnerGroupUser, type PipelineSimulation, type PipelineState, type PipelineVersionEntry, type PluginSlots, type Policy, type PreflightCheck, type PreflightReport, type PreflightSeverity, type PresenceClient, type PresenceOptions, type PresenceSession, type PresenceSessionInfo, type PresenceViewer, type PromotionApplyResult, type PromotionPreview, type Query, type Queue, type QueueColumnPrefs, type QueueCondition, type QueueDetail, type QueueDisplayConfig, type QueueItem, type QueueItemsResult, type QueueOwner, type QueueRowClickMode, type QueueScope, type QueueSource, type QueueSourceType, type QueueStats, type QueueTrendPoint, type QueueView, type QueueViewKind, type QueueWorkloadRow, type RealtimeEvent, type RecordGraphEdge, type RecordGraphNode, type RecordLink, type RecordLinkType, type RecordTemplate, type RecordViewRecap, type RegisteredAction, type RelatedCommentEntry, type RelationFilter, type RelationOption, type ReportAlert, type ReportAlertCondition, type ReportAlertLogEntry, type ReportAnnotation, type ReportColumnFormat, type ReportDateRange, type ReportDef, type ReportEntityFilter, type ReportFilterPreset, type ReportQueryColumn, type ReportQueryWidgetConfig, type ReportSnapshotEntry, type ReportSubscription, type ReportTemplateEntry, type ReportVersionEntry, type ReportWidget, type ReportWidgetConfig, type ReportWidgetData, type ReportWidgetPreset, type ReportWidgetType, type RequestTrace, type ResolvedOwner, type RetentionPolicy, type RetentionRun, type RetentionRunResult, type Revision, type Role, type Rule, type SavedView, type ScheduledChange, type ScheduledReport, type ScopeDimension, type ScopeDimensionInfo, type SemanticSearchMatch, type SessionRecording, type ShareLink, type SlaBatchStatus, type SlaRule, type SlaStatus, type StagedImportRun, type StagedImportStats, type StringFilterOps, type SubRow, type SubRowTemplate, type SyncJob, type Task, type TaskDoneWhenRule, type TaskPriority, type TaskStatus, type TimelineEvent, type TraceSpan, type TreeFlatNode, type TreeNestedNode, type TreeNodeConfig, type TreePermission, type TreePermissionAction, type UUID, type UserActivityEntry, type UserActivitySummary, type UserScopesInfo, type ViewSubscription, type VirtualCollection, type Webhook, type WebhookDelivery, type WidgetFeed, type WorkflowBinding, type WorkflowHistoryEntry, type WorkflowInstance, type WorkflowInstanceData, type WorkflowState, type WorkflowTransition, type Workspace, type WorkspaceQuotas, type WorkspaceTemplate, type WorkspaceUsage, _and, _contains, _ends_with, _eq, _gt, _gte, _in, _lt, _lte, _ncontains, _neq, _nin, _nnull, _none, _null, _or, _some, _starts_with, acquireItemLock, activateLayout, addChatChannelMember, addInstanceOwner, addSubRow, aggregateItems, aiBrief, aiBuildReport, aiChat, aiCheckDuplicates, aiGenerate, aiMapColumns, aiQuery, aiReportFilters, aiReview, aiSummarize, aiValidate, appendSessionRecordingEvents, applyContentBundle, applyRecordTemplate, applySubRowTemplate, approveAddendum, approveAiProposal, asc, backupExportPath, batchPickerExclusionStatus, bulkPickerExclusion, callExternalApi, callExternalApiEndpoint, cancelScheduledChange, cancelStagedImport, cascadeFieldDependencies, checkBlackoutDate, claimQueueItem, claimTask, clearTraces, cloneItem, cloneLayout, cloneReport, compareConfigSnapshot, completeTask, copyReportWidget, createAccessAudit, createAddendum, createAlertDefinition, createAlertSubscription, createAnomalyRule, createApiKey, createApprovalChain, createAtRiskRule, createAttributeDefinition, createBlackoutDate, createChatChannel, createChatRoomType, createCollectionLayout, createComment, createDataQualityRule, createExternalApi, createExternalApiEndpoint, createFieldGroup, createFieldWatch, createGroupDm, createHierarchyConfig, createImportDefinition, createImportJob, createImportJobFromUrl, createInternalWidget, createIssue, createItem, createMetricAlertRule, createNivaro, createNotification, createNotificationSubscription, createPage, createPdfTemplate, createPersistedQuery, createPresence, createQueue, createQueueView, createRealtime, createRecordLink, createRecordTemplate, createReport, createReportAlert, createReportAnnotation, createReportFromTemplate, createReportSnapshot, createReportWidgetPreset, createRetentionPolicy, createRole, createRolePolicy, createRule, createSavedView, createScheduledChange, createScheduledReport, createShareLink, createSlaRule, createSubRowTemplate, createSyncJob, createTask, createTreePermission, createUser, createViewSubscription, createVirtualCollection, createWebhook, createWidgetFeed, createWorkspace, createWorkspaceTemplate, decideApproval, deleteAccessAudit, deleteAddendum, deleteAlertDefinition, deleteAlertSubscription, deleteAnomalyRule, deleteApiKey, deleteApprovalChain, deleteAtRiskRule, deleteAttributeDefinition, deleteBlackoutDate, deleteChatMessage, deleteCollectionLayout, deleteComment, deleteDataQualityRule, deleteExternalApi, deleteExternalApiEndpoint, deleteExternalApiSchema, deleteFieldGroup, deleteFieldTranslations, deleteFieldWatch, deleteFile, deleteHierarchyConfig, deleteImportJob, deleteInternalWidget, deleteIssue, deleteItem, deleteMetricAlertRule, deleteNotification, deleteNotificationSubscription, deletePage, deletePdfTemplate, deletePersistedQuery, deleteQueue, deleteQueueView, deleteRecordLink, deleteRecordTemplate, deleteReport, deleteReportAlert, deleteReportAnnotation, deleteReportFilterPreset, deleteReportSnapshot, deleteReportTemplate, deleteReportWidgetPreset, deleteRetentionPolicy, deleteRole, deleteRolePolicy, deleteRule, deleteSavedView, deleteScheduledReport, deleteSessionRecording, deleteSlaRule, deleteSubRow, deleteSubRowTemplate, deleteSyncJob, deleteTask, deleteTreePermission, deleteUser, deleteViewSubscription, deleteVirtualCollection, deleteWebhook, deleteWidgetFeed, deleteWorkspace, deleteWorkspaceTemplate, deployImportProcedure, desc, disableTwoFactor, drillReportRow, editChatMessage, endSessionRecording, evaluateAlerts, evaluateAtRisk, evaluateFieldDefaults, evaluateFieldLock, evaluateFieldRules, evaluateFieldVisibility, excludeFromPicker, executeBulkAction, executeCustomQuery, executeImportTemplate, executeItemAction, executeScheduledChange, explainRecordAccess, explainReportTrend, exportBlueprint, exportConfigSnapshot, exportContent, exportContentBundle, exportSchemaSnapshot, fetchFormSchema, fileDownloadPath, fileTransformPath, generateToken, generateUserToken, getAlertDefinition, getAttributeValues, getBrunoCollection, getExternalApi, getExternalApiEndpoint, getFieldTranslations, getFlowRun, getLocales, getOpenApi, getPickerExclusionStatus, getPostmanCollection, getPresence, getRetentionPolicy, getSlaRule, getSlaStatus, getTranslations, getTypes, getWebhook, globalSearch, heartbeatItemLock, importExternalApiSpec, importSchemaSnapshot, includeInPicker, installBlueprint, installCollectionPreset, invokeInternalWidgetAction, isPageSlot, joinChatRoom, leaveChatRoom, listAccessAuditRuns, listAccessAudits, listActiveAtRiskRules, listActivePresence, listAddendums, listAlertDefinitions, listAlertSubscriptions, listAllNotificationSubscriptions, listAnomalyDefinitions, listAnomalyRules, listApiKeys, listApprovalChains, listApprovalInstances, listAtRiskRules, listAttributeDefinitions, listBlackoutDates, listBulkActions, listChangeOrders, listChatChannelMembers, listChatMessages, listChatPins, listChatRoles, listChatRoomTypes, listChatRooms, listCollectionPresets, listCollectionRecordTemplates, listComments, listCronJobs, listCustomQueries, listDataQualityRules, listDataQualityRuns, listDeadLetters, listExternalApiEndpoints, listExternalApiSchemas, listExternalApis, listFieldGroups, listFieldWatches, listFiles, listFlowRuns, listHierarchyConfigs, listImportDefinitionVersions, listImportDefinitions, listImportJobs, listImportTemplates, listInternalWidgets, listIssues, listItemActions, listItemScheduledChanges, listLayoutVersions, listMetricAlertRules, listMetricAlertSubscriptions, listMetricDefinitions, listMyTasks, listNotificationSubscriptions, listNotifications, listOrphanFiles, listPages, listPdfTemplates, listPersistedQueries, listPinnedItems, listPipelineVersions, listQueueViews, listQueues, listRecordLinks, listRecordTemplates, listRegisteredExtensions, listRegisteredFlowOperations, listRegisteredFlowTriggers, listRelatedComments, listReportAlerts, listReportAnnotations, listReportFilterPresets, listReportSnapshots, listReportTemplates, listReportVersions, listReportWidgetPresets, listReports, listRequestedTasks, listRetentionPolicies, listRetentionRuns, listRolePolicies, listRoleUsers, listRoles, listRules, listSavedViews, listScheduledChanges, listScheduledReports, listScopeDimensions, listSessionRecordings, listShareLinks, listSlaRules, listStagedImports, listSubRowTemplates, listSubRows, listSyncJobs, listTasks, listTeamTasks, listThroughputCollections, listTraces, listTreePermissions, listViewSubscriptions, listVirtualCollections, listWebhookDeliveries, listWebhooks, listWidgetFeeds, listWorkspaceTemplates, listWorkspaces, markAllNotificationsRead, markChatRoomRead, markNotificationRead, markNotificationsRead, moveTreeNode, nudgeTask, omniSearch, presignFileUpload, previewContentBundle, previewImportJob, previewReportWidget, publishItem, queryVirtualCollection, readAccessAuditFindings, readActiveLayout, readActivity, readActivityReportSummary, readAddendum, readAiSettings, readAlertLog, readAllStateOwners, readAnomalyLog, readApiAnalyticsErrors, readApiAnalyticsSummary, readApiAnalyticsTimeseries, readApiAnalyticsTopCollections, readApiAnalyticsTopPaths, readApiKey, readApprovalBrief, readApprovalChain, readAtRiskSummary, readBackupManifest, readChatConfig, readChatDirectory, readChatPeerRead, readCollection, readCollectionLayout, readCollectionLayouts, readCollections, readConfigInventory, readCoverageGaps, readDataQualityRun, readDetailLayout, readDistinctValues, readDraftPublishConfig, readErpSubmissionHistory, readFieldChangeHistory, readFieldConfig, readFieldImpact, readFieldWatch, readFileMeta, readFileUsage, readHierarchyConfig, readHierarchyNodeAncestors, readHierarchyNodeChildren, readHierarchyNodes, readHierarchyTree, readImportJob, readImportProcedure, readInstanceOwners, readIntegrationHealth, readInternalWidget, readIssue, readIssueSummary, readItem, readItemLock, readItemLockConfig, readItems, readLastTouch, readLayoutAssignments, readLayoutGroups, readMe, readMetricAlertLog, readMyScopes, readMyWork, readNotificationCount, readNotificationSubscriptionStats, readOnlinePresence, readOwnerGroups, readPage, readPageWidgetData, readPdfTemplate, readPersistedQuery, readPipelineFlowMap, readPipelineReplay, readPipelineTemplate, readPipelineTemplates, readPipelineVersion, readPreflight, readQueue, readQueueCollectionStates, readQueueColumnPrefs, readQueueItems, readQueueTrends, readQueueWorkload, readRecordGraph, readRelationOptions, readReport, readReportAlertLog, readReportAlertsLog, readReportFilterOptions, readReportFiring, readReportSnapshot, readReportSubscription, readReportUsage, readReportWidgetData, readRevision, readRevisions, readRole, readScopeDimensionCoverage, readSessionRecordingEvents, readSettings, readSingleton, readSlaStatusBatch, readStagedImport, readStagedImportStats, readStateOwnerGroups, readStateOwners, readStateOwnersBatch, readSyncJob, readTask, readTaskCounts, readTaskHistory, readThroughputReport, readTimeline, readTrace, readTreeAncestors, readTreeChildren, readTreeConfig, readTreeDescendants, readTreeNested, readTreeNodes, readTwoFactorStatus, readUnreadNotificationCount, readUser, readUserActivity, readUserActivitySummary, readUserCard, readUserScopes, readUsers, readWorkflowBindings, readWorkflowInstance, readWorkflowInstances, readWorkspace, readWorkspaceUsage, rebuildTreePaths, rehearseCreateItem, reindexSemanticSearch, rejectAddendum, rejectAiProposal, releaseItemLock, releaseQueueItem, rematerializeQueue, removeChatChannelMember, removeInstanceOwner, renderInternalWidget, renderPdfTemplate, reorderFieldGroups, reorderSubRows, reorderTreeSiblings, replaceSubRows, replayActivityEvent, replayFlow, reportClientError, requestRecordAccess, requeueStagedImport, resetReportCache, resolveReportAlert, restoreImportDefinitionVersion, restoreLayoutVersion, restorePipelineVersion, restoreReportVersion, retryDeadLetter, retryErpSubmission, retryWebhookDelivery, revokeApiKey, revokeShareLink, revokeToken, revokeUserToken, rollbackRevision, rotateWidgetFeedToken, runAccessAudit, runActivityReport, runActivityReportCsv, runCronJob, runDataQuality, runRetentionPolicy, runScheduledReport, runSyncJob, saveMyScopeDefaults, saveReportFilterPreset, saveReportTemplate, saveReportWidgets, saveUserScope, searchChatMessages, semanticSearch, sendBulkNotification, sendChatMessage, sendTestMail, sessionRecordingEnabled, setMyDelegate, setQueueDefaultView, setReportSubscription, setTranslations, setupTwoFactor, simulatePermissions, simulatePipeline, simulatePipelineImpact, startApproval, startMasquerade, startSessionRecording, startWorkflow, stopMasquerade, submitAddendum, submitFormItem, submitItemForReview, submitToErp, subscribeFieldWatch, subscribeMetricAlert, suggestImportValidation, suggestQueueLabels, switchWorkspace, testExternalApi, testFlow, testWebhook, toggleChatPin, toggleChatReaction, togglePinnedItem, toggleReportAlert, touchRecordView, transitionWorkflow, unpublishItem, unsubscribeFieldWatch, unsubscribeMetricAlert, updateAccessAudit, updateAddendum, updateAiSettings, updateAlertDefinition, updateAnomalyLogEntry, updateAnomalyRule, updateApiKey, updateApprovalChain, updateAtRiskRule, updateAttributeDefinition, updateAttributeValues, updateChatChannel, updateChatRoom, updateChatRoomType, updateCollectionLayout, updateComment, updateDataQualityRule, updateDraftPublishConfig, updateErpSubmissionStatus, updateExternalApi, updateExternalApiEndpoint, updateFieldConfig, updateFieldGroup, updateFieldWatch, updateFileMeta, updateHierarchyConfig, updateImportDefinition, updateInternalWidget, updateIssue, updateItem, updateItemLockConfig, updateLayoutAssignments, updateLayoutUngroupedSort, updateMe, updateMetricAlertRule, updateMetricAlertSubscription, updateNotificationSubscription, updatePage, updatePdfTemplate, updatePersistedQuery, updateQueue, updateQueueSources, updateQueueView, updateRecordTemplate, updateReport, updateReportAlert, updateReportWidgetPreset, updateRetentionPolicy, updateRole, updateRolePolicy, updateRoleUiPermissions, updateRule, updateSavedView, updateScheduledReport, updateSettings, updateSingleton, updateSlaRule, updateSyncJob, updateTask, updateTreePermission, updateUser, updateVirtualCollection, updateWebhook, updateWidgetFeed, updateWorkflowBinding, updateWorkspace, validateVirtualCollectionSql, verifyTwoFactor };
|
|
7452
|
+
export { type AccessAudit, type AccessAuditFinding, type AccessAuditRun, type AccessAuditSubject, type AccessReason, type ActivityEntry, type ActivityQuery, type ActivityReportQuery, type ActivityReportRow, type ActivityReportSummary, type Addendum, type AddendumStatus, type AggregateQuery, type AggregateRow, type AiChatTraceEntry, type AiCollectionSettings, type AiColumnMapping, type AiDuplicateMatch, type AiQueryFilter, type AiQueryResult, type AiReviewFinding, type AiViolation, type AlertDefinition, type AlertLogEntry, type AlertSubscription, type AnomalyDefinition, type AnomalyRule, type ApiAnalyticsBucket, type ApiAnalyticsCollection, type ApiAnalyticsPath, type ApiAnalyticsSummary, type ApiErrorLog, type ApiKey, type ApiKeyScope, type ApprovalBrief, type ApprovalChain, type ApprovalChainStep, type ApprovalDecision, type ApprovalInstance, type ApprovalInstanceDetail, type ApprovalStatus, type ApprovalStepInput, type AtRiskCondition, type AtRiskOp, type AtRiskResult, type AtRiskRule, type AtRiskSummaryEntry, type AttributeDefinition, type AttributeValue, type BatchRead, type BatchReadResult, type BlackoutDate, type BoolFilterOps, type CMSCollection, type CascadeFilterRule, type ChangeOrder, type ChatChannel, type ChatChannelMember, type ChatDirectoryChannel, type ChatMessage, type ChatPin, type ChatReaction, type ChatRoomKind, type ChatRoomSummary, type ChatRoomType, type ChatSearchHit, type CollectionLayout, type CollectionPresetSummary, type Command, type Comment, type ConfigSnapshot, type ConfigTableClassification, type ContentBundle, type ContentExportFormat, type ContentExportOptions, type CoverageGapItem, type CoverageGapOwner, type CoverageGapReport, type CronJob, type CustomQuery, type DataQualityRule, type DataQualityRuleResult, type DataQualityRuleType, type DataQualityRun, type DataQualitySeverity, type DeadLetter, type DraftPublishConfig, type DraftStatus, type DryRunReport, type ErpSubmission, type ErpSubmissionStatus, type ExtensionManifest, type ExternalApi, type ExternalApiEndpoint, type ExternalApiSchema, type ExternalApiSlotContext, type ExternalApiSpecImportResult, type ExternalApiTestResult, type FieldChangeEntry, type FieldCondition, type FieldConfig, type FieldDependencyConfig, type FieldFilter, type FieldGroup, type FieldTranslations, type FieldVisibilityRules, type FieldWatch, type FileRecord, type FileUploadResult, type FileUsageEntry, type Filter, type FlowReplayResult, type FlowRun, type FlowTestStep, type FormFieldDescriptor, type FormFieldRelation, type FormGroupDescriptor, type FormLockCondition, type FormSchema, type FormValidationRule, type FormVisibilityRule, type GlobalSearchRecord, type GlobalSearchResults, type GraphQLResponse, type HelpVideo, type HelpVideoContext, type HelpVideoFinalizedUpload, type HelpVideoProgress, type HelpVideoUploadSession, type HelpVideoVersion, type HelpVideoVisibility, type HierarchyConfigDef, type HierarchyFlatNode, type HierarchyLevelDef, type HierarchyNestedNode, type IDFilterOps, type ISODate, type ImportDefinition, type ImportJob, type ImportParseResponse, type ImportPreview, type ImportPreviewDiff, type ImportTemplateSummary, type InstanceOwner, type IntegrationApiHealth, type InternalWidget, type Issue, type IssueSeverity, type IssueStatus, type IssueSummary, type ItemLock, type LastTouch, type LayoutAssignment, type LayoutGroup, type LayoutVersion, type ListResponse, type ManagedUser, type MetricAlertRule, type MetricAlertSubscription, type MetricDefinition, type MyTask, type MyWorkOwnedEntry, type MyWorkSla, type MyWorkSummary, type NivaroClient, type NivaroClientOptions, type NivaroExtensionPlugin, type NivaroRealtime, type NivaroRuntime, type NotificationItem, type NotificationPage, type NotificationSubscription, type NumberFilterOps, type OmniSearchHit, type OnlinePresenceConfig, type OnlinePresenceUser, type Page, type PageLayout, type PageSlotKey, type PageWidget, type PdfTemplate, type PermissionSimulation, type PersistedQuery, type PickerExclusionStatus, type PipelineFlowEdge, type PipelineFlowState, type PipelineImpactResult, type PipelineOwnerGroup, type PipelineOwnerGroupUser, type PipelineSimulation, type PipelineState, type PipelineVersionEntry, type PluginSlots, type Policy, type PreflightCheck, type PreflightReport, type PreflightSeverity, type PresenceClient, type PresenceOptions, type PresenceSession, type PresenceSessionInfo, type PresenceViewer, type PromotionApplyResult, type PromotionPreview, type Query, type Queue, type QueueColumnPrefs, type QueueCondition, type QueueDetail, type QueueDisplayConfig, type QueueItem, type QueueItemsResult, type QueueOwner, type QueueRowClickMode, type QueueScope, type QueueSource, type QueueSourceType, type QueueStats, type QueueTrendPoint, type QueueView, type QueueViewKind, type QueueWorkloadRow, READ_MANY_MAX, type RealtimeEvent, type RecordGraphEdge, type RecordGraphNode, type RecordLink, type RecordLinkType, type RecordTemplate, type RecordViewRecap, type RegisteredAction, type RelatedCommentEntry, type RelationFilter, type RelationOption, type ReportAlert, type ReportAlertCondition, type ReportAlertLogEntry, type ReportAnnotation, type ReportColumnFormat, type ReportDateRange, type ReportDef, type ReportEntityFilter, type ReportFilterPreset, type ReportQueryColumn, type ReportQueryWidgetConfig, type ReportSnapshotEntry, type ReportSubscription, type ReportTemplateEntry, type ReportVersionEntry, type ReportWidget, type ReportWidgetConfig, type ReportWidgetData, type ReportWidgetPreset, type ReportWidgetType, type RequestTrace, type ResolvedOwner, type RetentionPolicy, type RetentionRun, type RetentionRunResult, type Revision, type Role, type Rule, type SavedView, type ScheduledChange, type ScheduledReport, type ScopeDimension, type ScopeDimensionInfo, type SemanticSearchMatch, type SessionRecording, type ShareLink, type SlaBatchStatus, type SlaRule, type SlaStatus, type StagedImportRun, type StagedImportStats, type StringFilterOps, type SubRow, type SubRowTemplate, type SyncJob, type Task, type TaskDoneWhenRule, type TaskPriority, type TaskStatus, type TimelineEvent, type TraceSpan, type TreeFlatNode, type TreeNestedNode, type TreeNodeConfig, type TreePermission, type TreePermissionAction, type UUID, type UserActivityEntry, type UserActivitySummary, type UserScopesInfo, type ViewSubscription, type VirtualCollection, type Webhook, type WebhookDelivery, type WidgetFeed, type WorkflowBinding, type WorkflowHistoryEntry, type WorkflowInstance, type WorkflowInstanceData, type WorkflowState, type WorkflowTransition, type Workspace, type WorkspaceQuotas, type WorkspaceTemplate, type WorkspaceUsage, _and, _contains, _ends_with, _eq, _gt, _gte, _in, _lt, _lte, _ncontains, _neq, _nin, _nnull, _none, _null, _or, _some, _starts_with, abandonHelpVideoUpload, acquireItemLock, activateLayout, addChatChannelMember, addInstanceOwner, addSubRow, aggregateItems, aiBrief, aiBuildReport, aiChat, aiCheckDuplicates, aiGenerate, aiMapColumns, aiQuery, aiReportFilters, aiReview, aiSummarize, aiValidate, appendSessionRecordingEvents, applyContentBundle, applyRecordTemplate, applySubRowTemplate, approveAddendum, approveAiProposal, archiveHelpVideo, asc, backupExportPath, batchPickerExclusionStatus, bulkPickerExclusion, callExternalApi, callExternalApiEndpoint, cancelScheduledChange, cancelStagedImport, cascadeFieldDependencies, checkBlackoutDate, claimQueueItem, claimTask, clearTraces, cloneItem, cloneLayout, cloneReport, compareConfigSnapshot, completeTask, copyReportWidget, createAccessAudit, createAddendum, createAlertDefinition, createAlertSubscription, createAnomalyRule, createApiKey, createApprovalChain, createAtRiskRule, createAttributeDefinition, createBlackoutDate, createChatChannel, createChatRoomType, createCollectionLayout, createComment, createDataQualityRule, createExternalApi, createExternalApiEndpoint, createFieldGroup, createFieldWatch, createGroupDm, createHelpVideo, createHierarchyConfig, createImportDefinition, createImportJob, createImportJobFromUrl, createInternalWidget, createIssue, createItem, createMetricAlertRule, createNivaro, createNotification, createNotificationSubscription, createPage, createPdfTemplate, createPersistedQuery, createPresence, createQueue, createQueueView, createRealtime, createRecordLink, createRecordTemplate, createReport, createReportAlert, createReportAnnotation, createReportFromTemplate, createReportSnapshot, createReportWidgetPreset, createRetentionPolicy, createRole, createRolePolicy, createRule, createSavedView, createScheduledChange, createScheduledReport, createShareLink, createSlaRule, createSubRowTemplate, createSyncJob, createTask, createTreePermission, createUser, createViewSubscription, createVirtualCollection, createWebhook, createWidgetFeed, createWorkspace, createWorkspaceTemplate, decideApproval, deleteAccessAudit, deleteAddendum, deleteAlertDefinition, deleteAlertSubscription, deleteAnomalyRule, deleteApiKey, deleteApprovalChain, deleteAtRiskRule, deleteAttributeDefinition, deleteBlackoutDate, deleteChatMessage, deleteCollectionLayout, deleteComment, deleteDataQualityRule, deleteExternalApi, deleteExternalApiEndpoint, deleteExternalApiSchema, deleteFieldGroup, deleteFieldTranslations, deleteFieldWatch, deleteFile, deleteHierarchyConfig, deleteImportJob, deleteInternalWidget, deleteIssue, deleteItem, deleteMetricAlertRule, deleteNotification, deleteNotificationSubscription, deletePage, deletePdfTemplate, deletePersistedQuery, deleteQueue, deleteQueueView, deleteRecordLink, deleteRecordTemplate, deleteReport, deleteReportAlert, deleteReportAnnotation, deleteReportFilterPreset, deleteReportSnapshot, deleteReportTemplate, deleteReportWidgetPreset, deleteRetentionPolicy, deleteRole, deleteRolePolicy, deleteRule, deleteSavedView, deleteScheduledReport, deleteSessionRecording, deleteSlaRule, deleteSubRow, deleteSubRowTemplate, deleteSyncJob, deleteTask, deleteTreePermission, deleteUser, deleteViewSubscription, deleteVirtualCollection, deleteWebhook, deleteWidgetFeed, deleteWorkspace, deleteWorkspaceTemplate, deployImportProcedure, desc, disableTwoFactor, drillReportRow, editChatMessage, endSessionRecording, evaluateAlerts, evaluateAtRisk, evaluateFieldDefaults, evaluateFieldLock, evaluateFieldRules, evaluateFieldVisibility, excludeFromPicker, executeBulkAction, executeCustomQuery, executeImportTemplate, executeItemAction, executeScheduledChange, explainRecordAccess, explainReportTrend, exportBlueprint, exportConfigSnapshot, exportContent, exportContentBundle, exportSchemaSnapshot, fetchFormSchema, fileDownloadPath, fileTransformPath, finalizeHelpVideoUpload, generateToken, generateUserToken, getAlertDefinition, getAttributeValues, getBrunoCollection, getExternalApi, getExternalApiEndpoint, getFieldTranslations, getFlowRun, getLocales, getOpenApi, getPickerExclusionStatus, getPostmanCollection, getPresence, getRetentionPolicy, getSlaRule, getSlaStatus, getTranslations, getTypes, getWebhook, globalSearch, heartbeatItemLock, helpVideosFor, importExternalApiSpec, importSchemaSnapshot, includeInPicker, installBlueprint, installCollectionPreset, invokeInternalWidgetAction, isPageSlot, joinChatRoom, leaveChatRoom, listAccessAuditRuns, listAccessAudits, listActiveAtRiskRules, listActivePresence, listAddendums, listAlertDefinitions, listAlertSubscriptions, listAllNotificationSubscriptions, listAnomalyDefinitions, listAnomalyRules, listApiKeys, listApprovalChains, listApprovalInstances, listAtRiskRules, listAttributeDefinitions, listBlackoutDates, listBulkActions, listChangeOrders, listChatChannelMembers, listChatMessages, listChatPins, listChatRoles, listChatRoomTypes, listChatRooms, listCollectionPresets, listCollectionRecordTemplates, listComments, listCronJobs, listCustomQueries, listDataQualityRules, listDataQualityRuns, listDeadLetters, listExternalApiEndpoints, listExternalApiSchemas, listExternalApis, listFieldGroups, listFieldWatches, listFiles, listFlowRuns, listHelpVideoPages, listHelpVideoVersions, listHelpVideos, listHierarchyConfigs, listImportDefinitionVersions, listImportDefinitions, listImportJobs, listImportTemplates, listInternalWidgets, listIssues, listItemActions, listItemScheduledChanges, listLayoutVersions, listMetricAlertRules, listMetricAlertSubscriptions, listMetricDefinitions, listMyHelpVideoUploads, listMyTasks, listNotificationSubscriptions, listNotifications, listOrphanFiles, listPages, listPdfTemplates, listPersistedQueries, listPinnedItems, listPipelineVersions, listQueueViews, listQueues, listRecordLinks, listRecordTemplates, listRegisteredExtensions, listRegisteredFlowOperations, listRegisteredFlowTriggers, listRelatedComments, listReportAlerts, listReportAnnotations, listReportFilterPresets, listReportSnapshots, listReportTemplates, listReportVersions, listReportWidgetPresets, listReports, listRequestedTasks, listRetentionPolicies, listRetentionRuns, listRolePolicies, listRoleUsers, listRoles, listRules, listSavedViews, listScheduledChanges, listScheduledReports, listScopeDimensions, listSessionRecordings, listShareLinks, listSlaRules, listStagedImports, listSubRowTemplates, listSubRows, listSyncJobs, listTasks, listTeamTasks, listThroughputCollections, listTraces, listTreePermissions, listViewSubscriptions, listVirtualCollections, listWebhookDeliveries, listWebhooks, listWidgetFeeds, listWorkspaceTemplates, listWorkspaces, markAllNotificationsRead, markChatRoomRead, markNotificationRead, markNotificationsRead, moveTreeNode, nudgeTask, omniSearch, openHelpVideoUpload, presignFileUpload, previewContentBundle, previewImportJob, previewReportWidget, publishHelpVideo, publishItem, queryVirtualCollection, readAccessAuditFindings, readActiveLayout, readActivity, readActivityReportSummary, readAddendum, readAiSettings, readAlertLog, readAllStateOwners, readAnomalyLog, readApiAnalyticsErrors, readApiAnalyticsSummary, readApiAnalyticsTimeseries, readApiAnalyticsTopCollections, readApiAnalyticsTopPaths, readApiKey, readApprovalBrief, readApprovalChain, readAtRiskSummary, readBackupManifest, readChatConfig, readChatDirectory, readChatPeerRead, readCollection, readCollectionLayout, readCollectionLayouts, readCollections, readConfigInventory, readCoverageGaps, readDataQualityRun, readDetailLayout, readDistinctValues, readDraftPublishConfig, readErpSubmissionHistory, readFieldChangeHistory, readFieldConfig, readFieldImpact, readFieldWatch, readFileMeta, readFileUsage, readHelpVideo, readHelpVideoAnalytics, readHelpVideoDraft, readHierarchyConfig, readHierarchyNodeAncestors, readHierarchyNodeChildren, readHierarchyNodes, readHierarchyTree, readImportJob, readImportProcedure, readInstanceOwners, readIntegrationHealth, readInternalWidget, readIssue, readIssueSummary, readItem, readItemLock, readItemLockConfig, readItems, readLastTouch, readLayoutAssignments, readLayoutGroups, readMany, readMe, readMetricAlertLog, readMyScopes, readMyWork, readNotificationCount, readNotificationSubscriptionStats, readOnlinePresence, readOwnerGroups, readPage, readPageWidgetData, readPdfTemplate, readPersistedQuery, readPipelineFlowMap, readPipelineReplay, readPipelineTemplate, readPipelineTemplates, readPipelineVersion, readPreflight, readQueue, readQueueCollectionStates, readQueueColumnPrefs, readQueueItems, readQueueTrends, readQueueWorkload, readRecordGraph, readRelationOptions, readReport, readReportAlertLog, readReportAlertsLog, readReportFilterOptions, readReportFiring, readReportSnapshot, readReportSubscription, readReportUsage, readReportWidgetData, readRequiredHelpVideos, readRevision, readRevisions, readRole, readScopeDimensionCoverage, readSessionRecordingEvents, readSettings, readSingleton, readSlaStatusBatch, readStagedImport, readStagedImportStats, readStateOwnerGroups, readStateOwners, readStateOwnersBatch, readSyncJob, readTask, readTaskCounts, readTaskHistory, readThroughputReport, readTimeline, readTrace, readTreeAncestors, readTreeChildren, readTreeConfig, readTreeDescendants, readTreeNested, readTreeNodes, readTwoFactorStatus, readUnreadNotificationCount, readUser, readUserActivity, readUserActivitySummary, readUserCard, readUserScopes, readUsers, readWorkflowBindings, readWorkflowInstance, readWorkflowInstances, readWorkspace, readWorkspaceUsage, rebuildTreePaths, recordHelpVideoProgress, registerHelpVideoPage, rehearseCreateItem, reindexSemanticSearch, rejectAddendum, rejectAiProposal, releaseItemLock, releaseQueueItem, rematerializeQueue, removeChatChannelMember, removeInstanceOwner, renderInternalWidget, renderPdfTemplate, reorderFieldGroups, reorderSubRows, reorderTreeSiblings, replaceSubRows, replayActivityEvent, replayFlow, reportClientError, requestRecordAccess, requeueStagedImport, rerecordHelpVideo, rerenderHelpVideo, resetReportCache, resolveReportAlert, restoreHelpVideoVersion, restoreImportDefinitionVersion, restoreLayoutVersion, restorePipelineVersion, restoreReportVersion, retryDeadLetter, retryErpSubmission, retryWebhookDelivery, revokeApiKey, revokeShareLink, revokeToken, revokeUserToken, rollbackRevision, rotateWidgetFeedToken, runAccessAudit, runActivityReport, runActivityReportCsv, runCronJob, runDataQuality, runRetentionPolicy, runScheduledReport, runSyncJob, saveHelpVideoDraft, saveMyScopeDefaults, saveReportFilterPreset, saveReportTemplate, saveReportWidgets, saveUserScope, searchChatMessages, semanticSearch, sendBulkNotification, sendChatMessage, sendTestMail, sessionRecordingEnabled, setHelpVideoContexts, setHelpVideoRequirements, setMyDelegate, setQueueDefaultView, setReportSubscription, setTranslations, setupTwoFactor, simulatePermissions, simulatePipeline, simulatePipelineImpact, startApproval, startMasquerade, startSessionRecording, startWorkflow, stopMasquerade, submitAddendum, submitFormItem, submitItemForReview, submitToErp, subscribeFieldWatch, subscribeMetricAlert, suggestImportValidation, suggestQueueLabels, switchWorkspace, testExternalApi, testFlow, testWebhook, toggleChatPin, toggleChatReaction, togglePinnedItem, toggleReportAlert, touchRecordView, transitionWorkflow, unpublishItem, unsubscribeFieldWatch, unsubscribeMetricAlert, updateAccessAudit, updateAddendum, updateAiSettings, updateAlertDefinition, updateAnomalyLogEntry, updateAnomalyRule, updateApiKey, updateApprovalChain, updateAtRiskRule, updateAttributeDefinition, updateAttributeValues, updateChatChannel, updateChatRoom, updateChatRoomType, updateCollectionLayout, updateComment, updateDataQualityRule, updateDraftPublishConfig, updateErpSubmissionStatus, updateExternalApi, updateExternalApiEndpoint, updateFieldConfig, updateFieldGroup, updateFieldWatch, updateFileMeta, updateHelpVideo, updateHierarchyConfig, updateImportDefinition, updateInternalWidget, updateIssue, updateItem, updateItemLockConfig, updateLayoutAssignments, updateLayoutUngroupedSort, updateMe, updateMetricAlertRule, updateMetricAlertSubscription, updateNotificationSubscription, updatePage, updatePdfTemplate, updatePersistedQuery, updateQueue, updateQueueSources, updateQueueView, updateRecordTemplate, updateReport, updateReportAlert, updateReportWidgetPreset, updateRetentionPolicy, updateRole, updateRolePolicy, updateRoleUiPermissions, updateRule, updateSavedView, updateScheduledReport, updateSettings, updateSingleton, updateSlaRule, updateSyncJob, updateTask, updateTreePermission, updateUser, updateVirtualCollection, updateWebhook, updateWidgetFeed, updateWorkflowBinding, updateWorkspace, validateVirtualCollectionSql, verifyTwoFactor };
|