@nivaro/sdk 0.2.5 → 0.2.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +479 -6
- package/dist/index.js +127 -33
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -3,8 +3,16 @@ interface Command<TResult> {
|
|
|
3
3
|
readonly _path: string;
|
|
4
4
|
readonly _params?: Record<string, unknown>;
|
|
5
5
|
readonly _body?: unknown;
|
|
6
|
+
/** Cancels the request when it aborts (never serialized; see withSignal). */
|
|
7
|
+
readonly _signal?: AbortSignal;
|
|
6
8
|
readonly _phantom?: TResult;
|
|
7
9
|
}
|
|
10
|
+
/**
|
|
11
|
+
* The same command, cancelled when `signal` aborts — e.g. TanStack Query's queryFn signal, so a
|
|
12
|
+
* report widget whose filters changed stops waiting for the answer to the old filters (the
|
|
13
|
+
* server then drops it from its read queue). Without a signal the command is returned as is.
|
|
14
|
+
*/
|
|
15
|
+
declare function withSignal<T>(command: Command<T>, signal: AbortSignal | null | undefined): Command<T>;
|
|
8
16
|
|
|
9
17
|
/**
|
|
10
18
|
* Administration commands: roles & policies (RBAC/RLS), user management +
|
|
@@ -1870,6 +1878,169 @@ declare function readIntegrationHealth(): Command<{
|
|
|
1870
1878
|
};
|
|
1871
1879
|
}>;
|
|
1872
1880
|
|
|
1881
|
+
/**
|
|
1882
|
+
* Agents working with people: ask_human questions (#3220), agent task assignees (#3223) and
|
|
1883
|
+
* agent triggers (#3210, administrators).
|
|
1884
|
+
*/
|
|
1885
|
+
|
|
1886
|
+
type AgentQuestionStatus = 'open' | 'answered' | 'expired' | 'cancelled';
|
|
1887
|
+
interface AgentQuestion {
|
|
1888
|
+
id: UUID;
|
|
1889
|
+
status: AgentQuestionStatus;
|
|
1890
|
+
question: string;
|
|
1891
|
+
choices: string[];
|
|
1892
|
+
/** false = the answer must be one of the choices. */
|
|
1893
|
+
allow_text: boolean;
|
|
1894
|
+
collection: string | null;
|
|
1895
|
+
item: string | null;
|
|
1896
|
+
/** The assistant's name (its OAuth app or API key). */
|
|
1897
|
+
asked_by: string;
|
|
1898
|
+
/** The person the assistant acts for. */
|
|
1899
|
+
asked_for: UUID;
|
|
1900
|
+
asked_for_name: string | null;
|
|
1901
|
+
recipient: UUID;
|
|
1902
|
+
recipient_name: string | null;
|
|
1903
|
+
answer: string | null;
|
|
1904
|
+
answer_choice: string | null;
|
|
1905
|
+
answered_at: ISODate | null;
|
|
1906
|
+
expires_at: ISODate;
|
|
1907
|
+
created_at: ISODate;
|
|
1908
|
+
/** Asker only: the connection key it came from and when the answer was collected. */
|
|
1909
|
+
connection?: string;
|
|
1910
|
+
answer_seen_at?: ISODate | null;
|
|
1911
|
+
}
|
|
1912
|
+
/** Ask a person (default: the caller's own person) a question; it lands in their inbox. */
|
|
1913
|
+
declare function askHuman(body: {
|
|
1914
|
+
to?: UUID | 'me';
|
|
1915
|
+
question: string;
|
|
1916
|
+
choices?: string[];
|
|
1917
|
+
allow_text?: boolean;
|
|
1918
|
+
expires_in_minutes?: number;
|
|
1919
|
+
collection?: string;
|
|
1920
|
+
item?: string;
|
|
1921
|
+
}): Command<{
|
|
1922
|
+
data: AgentQuestion;
|
|
1923
|
+
}>;
|
|
1924
|
+
/** Read a question; `wait` (0–25 s) holds the request until it is answered. */
|
|
1925
|
+
declare function readAgentQuestion(id: UUID, wait?: number): Command<{
|
|
1926
|
+
data: AgentQuestion;
|
|
1927
|
+
}>;
|
|
1928
|
+
/** Questions waiting on the caller. `can_answer` is false outside a signed-in browser. */
|
|
1929
|
+
declare function listMyAgentQuestions(): Command<{
|
|
1930
|
+
data: AgentQuestion[];
|
|
1931
|
+
ready: boolean;
|
|
1932
|
+
can_answer?: boolean;
|
|
1933
|
+
}>;
|
|
1934
|
+
/** What the calling connection asked (`unseen` = answered, not collected yet). */
|
|
1935
|
+
declare function listAskedQuestions(query?: {
|
|
1936
|
+
status?: 'open' | 'unseen' | 'answered' | 'expired' | 'cancelled' | 'all';
|
|
1937
|
+
limit?: number;
|
|
1938
|
+
}): Command<{
|
|
1939
|
+
data: AgentQuestion[];
|
|
1940
|
+
}>;
|
|
1941
|
+
/** Answer a question (the person asked, from a signed-in session only). */
|
|
1942
|
+
declare function answerAgentQuestion(id: UUID, body: {
|
|
1943
|
+
choice?: string;
|
|
1944
|
+
answer?: string;
|
|
1945
|
+
}): Command<{
|
|
1946
|
+
data: AgentQuestion;
|
|
1947
|
+
}>;
|
|
1948
|
+
declare function cancelAgentQuestion(id: UUID): Command<{
|
|
1949
|
+
data: AgentQuestion;
|
|
1950
|
+
}>;
|
|
1951
|
+
interface TaskAgent {
|
|
1952
|
+
/** Connection key: o<grant id> (a connected app) or k<api key id>. */
|
|
1953
|
+
conn: string;
|
|
1954
|
+
kind: 'oauth' | 'api_key';
|
|
1955
|
+
name: string;
|
|
1956
|
+
/** The person the agent acts for — the task's assignee. */
|
|
1957
|
+
user_id: UUID;
|
|
1958
|
+
user_name: string | null;
|
|
1959
|
+
}
|
|
1960
|
+
/** Agents the caller may hand a task to (their own; `all` for an administrator). */
|
|
1961
|
+
declare function listTaskAgents(opts?: {
|
|
1962
|
+
all?: boolean;
|
|
1963
|
+
}): Command<{
|
|
1964
|
+
data: TaskAgent[];
|
|
1965
|
+
ready: boolean;
|
|
1966
|
+
me?: string | null;
|
|
1967
|
+
}>;
|
|
1968
|
+
/** Tasks handed to the calling agent connection. */
|
|
1969
|
+
declare function listAgentTasks(status?: string): Command<{
|
|
1970
|
+
data: Array<Record<string, unknown>>;
|
|
1971
|
+
}>;
|
|
1972
|
+
type AgentTriggerEvent = 'create' | 'update' | 'transition';
|
|
1973
|
+
interface AgentTrigger {
|
|
1974
|
+
id: number;
|
|
1975
|
+
name: string;
|
|
1976
|
+
description: string | null;
|
|
1977
|
+
enabled: boolean;
|
|
1978
|
+
collection: string;
|
|
1979
|
+
events: AgentTriggerEvent[];
|
|
1980
|
+
conditions: Array<{
|
|
1981
|
+
field: string;
|
|
1982
|
+
op: string;
|
|
1983
|
+
value: unknown;
|
|
1984
|
+
}>;
|
|
1985
|
+
to_states: string[];
|
|
1986
|
+
fields: string[] | null;
|
|
1987
|
+
instructions: string | null;
|
|
1988
|
+
url: string;
|
|
1989
|
+
/** Masked when set. */
|
|
1990
|
+
signing_secret: string | null;
|
|
1991
|
+
/** Values masked. */
|
|
1992
|
+
headers: Record<string, string>;
|
|
1993
|
+
max_attempts: number;
|
|
1994
|
+
owner: UUID;
|
|
1995
|
+
owner_name: string | null;
|
|
1996
|
+
last_fired_at: ISODate | null;
|
|
1997
|
+
created_at: ISODate;
|
|
1998
|
+
updated_at: ISODate;
|
|
1999
|
+
last_7_days?: {
|
|
2000
|
+
delivered: number;
|
|
2001
|
+
dead: number;
|
|
2002
|
+
retrying: number;
|
|
2003
|
+
skipped: number;
|
|
2004
|
+
};
|
|
2005
|
+
}
|
|
2006
|
+
interface AgentTriggerDelivery {
|
|
2007
|
+
id: number;
|
|
2008
|
+
trigger_id: number;
|
|
2009
|
+
delivery_id: UUID;
|
|
2010
|
+
event: string;
|
|
2011
|
+
collection: string;
|
|
2012
|
+
item: string | null;
|
|
2013
|
+
status: 'sending' | 'retrying' | 'delivered' | 'dead' | 'discarded' | 'skipped';
|
|
2014
|
+
attempts: number;
|
|
2015
|
+
max_attempts: number;
|
|
2016
|
+
next_attempt_at: ISODate | null;
|
|
2017
|
+
last_status_code: number | null;
|
|
2018
|
+
last_error: string | null;
|
|
2019
|
+
latency_ms: number | null;
|
|
2020
|
+
delivered_at: ISODate | null;
|
|
2021
|
+
created_at: ISODate;
|
|
2022
|
+
request_body?: string | null;
|
|
2023
|
+
response_body?: string | null;
|
|
2024
|
+
}
|
|
2025
|
+
declare function listAgentTriggers(): Command<{
|
|
2026
|
+
data: {
|
|
2027
|
+
ready: boolean;
|
|
2028
|
+
triggers: AgentTrigger[];
|
|
2029
|
+
events: AgentTriggerEvent[];
|
|
2030
|
+
ops: string[];
|
|
2031
|
+
max_attempts_cap: number;
|
|
2032
|
+
};
|
|
2033
|
+
}>;
|
|
2034
|
+
declare function listAgentTriggerDeliveries(query?: {
|
|
2035
|
+
trigger?: number;
|
|
2036
|
+
status?: string;
|
|
2037
|
+
limit?: number;
|
|
2038
|
+
before?: number;
|
|
2039
|
+
}): Command<{
|
|
2040
|
+
data: AgentTriggerDelivery[];
|
|
2041
|
+
has_more: boolean;
|
|
2042
|
+
}>;
|
|
2043
|
+
|
|
1873
2044
|
/**
|
|
1874
2045
|
* AI commands: field generation, record summarization, natural-language
|
|
1875
2046
|
* query, CSV column mapping, and semantic (vector) search.
|
|
@@ -2106,11 +2277,6 @@ declare function chaosWhatIf(dependency: string): Command<{
|
|
|
2106
2277
|
data: ChaosWhatIfAnswer;
|
|
2107
2278
|
}>;
|
|
2108
2279
|
|
|
2109
|
-
/**
|
|
2110
|
-
* Collaboration commands: tasks, approval chains, item locks, notifications
|
|
2111
|
-
* (paginated center), per-user activity, issues.
|
|
2112
|
-
*/
|
|
2113
|
-
|
|
2114
2280
|
type TaskStatus = 'open' | 'in_progress' | 'done' | 'cancelled';
|
|
2115
2281
|
type TaskPriority = 'low' | 'normal' | 'urgent';
|
|
2116
2282
|
/** One `[{field, op, value}]` rule: the task closes itself when the record
|
|
@@ -2148,6 +2314,9 @@ interface Task {
|
|
|
2148
2314
|
team_name?: string | null;
|
|
2149
2315
|
/** The record's human id (TP26-80366). */
|
|
2150
2316
|
item_label?: string | null;
|
|
2317
|
+
/** #3223 — the agent connection the task is handed to (assignee = the person it acts for). */
|
|
2318
|
+
agent_assignee?: string | null;
|
|
2319
|
+
agent_name?: string | null;
|
|
2151
2320
|
}
|
|
2152
2321
|
interface MyTask extends Task {
|
|
2153
2322
|
item_label: string | null;
|
|
@@ -2215,6 +2384,8 @@ declare function createTask(body: {
|
|
|
2215
2384
|
due_date?: string | null;
|
|
2216
2385
|
priority?: TaskPriority;
|
|
2217
2386
|
done_when?: TaskDoneWhenRule[] | null;
|
|
2387
|
+
/** #3223 — hand it to an agent connection (o<grant id> | k<api key id>) instead of a person. */
|
|
2388
|
+
agent?: string | null;
|
|
2218
2389
|
}): Command<{
|
|
2219
2390
|
data: Task & {
|
|
2220
2391
|
delegated_from: UUID | null;
|
|
@@ -2228,6 +2399,8 @@ declare function updateTask(id: number, body: Partial<{
|
|
|
2228
2399
|
status: TaskStatus;
|
|
2229
2400
|
priority: TaskPriority;
|
|
2230
2401
|
done_when: TaskDoneWhenRule[] | null;
|
|
2402
|
+
/** #3223 — hand to an agent connection; null takes it back. */
|
|
2403
|
+
agent: string | null;
|
|
2231
2404
|
}>): Command<{
|
|
2232
2405
|
data: Task;
|
|
2233
2406
|
}>;
|
|
@@ -2947,6 +3120,17 @@ interface MyWorkSummary {
|
|
|
2947
3120
|
item: string | null;
|
|
2948
3121
|
timestamp: ISODate;
|
|
2949
3122
|
}>;
|
|
3123
|
+
/** #3220 — questions assistants asked the caller (open). */
|
|
3124
|
+
questions?: AgentQuestion[];
|
|
3125
|
+
/** #3223 / #3220 — present only when the caller is an agent connection. */
|
|
3126
|
+
agent?: {
|
|
3127
|
+
connection: string;
|
|
3128
|
+
};
|
|
3129
|
+
agent_tasks?: Array<Task & {
|
|
3130
|
+
item_label?: string | null;
|
|
3131
|
+
}>;
|
|
3132
|
+
/** Answers to this connection's questions it had not collected (now collected). */
|
|
3133
|
+
answers?: AgentQuestion[];
|
|
2950
3134
|
counts: {
|
|
2951
3135
|
owned: number;
|
|
2952
3136
|
owned_breached: number;
|
|
@@ -2954,6 +3138,9 @@ interface MyWorkSummary {
|
|
|
2954
3138
|
tasks: number;
|
|
2955
3139
|
approvals: number;
|
|
2956
3140
|
notifications: number;
|
|
3141
|
+
questions?: number;
|
|
3142
|
+
agent_tasks?: number;
|
|
3143
|
+
answers?: number;
|
|
2957
3144
|
};
|
|
2958
3145
|
}
|
|
2959
3146
|
/** The current user's actionable inbox: owned records (SLA-first), tasks,
|
|
@@ -5171,6 +5358,37 @@ declare function updateFileMeta(id: string, data: {
|
|
|
5171
5358
|
data: FileRecord;
|
|
5172
5359
|
}>;
|
|
5173
5360
|
declare function deleteFile(id: string): Command<void>;
|
|
5361
|
+
/** What POST /files/attach answers (#3212). */
|
|
5362
|
+
interface AttachedFile {
|
|
5363
|
+
collection: string;
|
|
5364
|
+
item: string;
|
|
5365
|
+
field: string;
|
|
5366
|
+
/** The file a single-file field held before (`replace: true`), else null. */
|
|
5367
|
+
replaced: string | null;
|
|
5368
|
+
file: {
|
|
5369
|
+
id: string;
|
|
5370
|
+
filename_download: string;
|
|
5371
|
+
type: string;
|
|
5372
|
+
filesize: number;
|
|
5373
|
+
};
|
|
5374
|
+
}
|
|
5375
|
+
/**
|
|
5376
|
+
* Upload a file as base64 and link it to a record's file field in one call (#3212): the
|
|
5377
|
+
* record is judged as the caller (read gate, update permission, field list, edit lock) and the
|
|
5378
|
+
* link goes through the items service. 10 MB decoded at most. A single-file field that already
|
|
5379
|
+
* holds a file answers 409 FIELD_HAS_FILE unless `replace` is true.
|
|
5380
|
+
*/
|
|
5381
|
+
declare function attachFileToRecord(data: {
|
|
5382
|
+
collection: string;
|
|
5383
|
+
item: string | number;
|
|
5384
|
+
field?: string;
|
|
5385
|
+
filename: string;
|
|
5386
|
+
content_base64: string;
|
|
5387
|
+
type?: string;
|
|
5388
|
+
replace?: boolean;
|
|
5389
|
+
}): Command<{
|
|
5390
|
+
data: AttachedFile;
|
|
5391
|
+
}>;
|
|
5174
5392
|
interface FileUsageEntry {
|
|
5175
5393
|
table: string;
|
|
5176
5394
|
column: string;
|
|
@@ -5203,6 +5421,181 @@ declare function fileTransformPath(id: string, options?: {
|
|
|
5203
5421
|
quality?: number;
|
|
5204
5422
|
}): string;
|
|
5205
5423
|
|
|
5424
|
+
/**
|
|
5425
|
+
* Form and widget drill-down reads for assistants (#3208 #3216 #3217 #3218).
|
|
5426
|
+
* Every one is computed AS THE CALLER — permissions, row filters, User Scopes
|
|
5427
|
+
* and field lists bind; a role preview is for administrators only.
|
|
5428
|
+
*/
|
|
5429
|
+
|
|
5430
|
+
type UUID$1 = string;
|
|
5431
|
+
/** The rows behind a dashboard or report widget's number. */
|
|
5432
|
+
interface WidgetDrillRows {
|
|
5433
|
+
/** What the number is: type, collection, metric, filters, date range, segment, query. */
|
|
5434
|
+
definition: Record<string, unknown>;
|
|
5435
|
+
collection: string | null;
|
|
5436
|
+
total: number | null;
|
|
5437
|
+
capped: boolean;
|
|
5438
|
+
columns: string[];
|
|
5439
|
+
rows: Array<Record<string, unknown>>;
|
|
5440
|
+
/** The record filter the rows came from (items filter syntax). */
|
|
5441
|
+
filter?: Record<string, unknown> | null;
|
|
5442
|
+
note?: string;
|
|
5443
|
+
dashboard?: {
|
|
5444
|
+
id: string;
|
|
5445
|
+
name?: string;
|
|
5446
|
+
};
|
|
5447
|
+
report?: {
|
|
5448
|
+
id: string;
|
|
5449
|
+
name?: string;
|
|
5450
|
+
};
|
|
5451
|
+
}
|
|
5452
|
+
interface WidgetDrillBody {
|
|
5453
|
+
/** One part of the figure: a chart bar's value, a series dimension, a day ('date'). */
|
|
5454
|
+
segment?: {
|
|
5455
|
+
field?: string | null;
|
|
5456
|
+
value?: unknown;
|
|
5457
|
+
} | null;
|
|
5458
|
+
/** Columns to return (readable, registered fields only). Default: the widget's own. */
|
|
5459
|
+
fields?: string[];
|
|
5460
|
+
/** Rows (1–100, default 25). */
|
|
5461
|
+
limit?: number;
|
|
5462
|
+
}
|
|
5463
|
+
/** The definition and rows behind a dashboard widget, as the caller. */
|
|
5464
|
+
declare function drillDashboardWidgetRows(widgetId: UUID$1, body?: WidgetDrillBody & {
|
|
5465
|
+
extra_filters?: DashboardFilter[];
|
|
5466
|
+
}): Command<{
|
|
5467
|
+
data: WidgetDrillRows;
|
|
5468
|
+
}>;
|
|
5469
|
+
/** The definition and rows behind a Report Studio widget, as the caller. */
|
|
5470
|
+
declare function drillReportWidgetRows(reportId: UUID$1, widgetId: UUID$1, body?: WidgetDrillBody & {
|
|
5471
|
+
date_range?: {
|
|
5472
|
+
preset: string;
|
|
5473
|
+
start?: string;
|
|
5474
|
+
end?: string;
|
|
5475
|
+
} | null;
|
|
5476
|
+
entity_filters?: Array<{
|
|
5477
|
+
field: string;
|
|
5478
|
+
values: Array<string | number>;
|
|
5479
|
+
}>;
|
|
5480
|
+
}): Command<{
|
|
5481
|
+
data: WidgetDrillRows;
|
|
5482
|
+
}>;
|
|
5483
|
+
interface FormFieldStateRow {
|
|
5484
|
+
field: string;
|
|
5485
|
+
label: string;
|
|
5486
|
+
group_key: string | null;
|
|
5487
|
+
section: string | null;
|
|
5488
|
+
visible: boolean;
|
|
5489
|
+
required: boolean;
|
|
5490
|
+
locked: boolean;
|
|
5491
|
+
missing?: true;
|
|
5492
|
+
hidden_by?: string;
|
|
5493
|
+
locked_by?: string;
|
|
5494
|
+
why?: string;
|
|
5495
|
+
}
|
|
5496
|
+
interface FormStateAnswer {
|
|
5497
|
+
collection: string;
|
|
5498
|
+
record: string | null;
|
|
5499
|
+
as: {
|
|
5500
|
+
role: string | null;
|
|
5501
|
+
admin: boolean;
|
|
5502
|
+
preview: boolean;
|
|
5503
|
+
};
|
|
5504
|
+
layout: {
|
|
5505
|
+
id: number;
|
|
5506
|
+
name: string;
|
|
5507
|
+
why: string | null;
|
|
5508
|
+
} | null;
|
|
5509
|
+
can_update: boolean;
|
|
5510
|
+
derived: Record<string, unknown>;
|
|
5511
|
+
groups: Array<{
|
|
5512
|
+
key: string;
|
|
5513
|
+
label: string;
|
|
5514
|
+
type: string;
|
|
5515
|
+
parent_key: string | null;
|
|
5516
|
+
visible: boolean;
|
|
5517
|
+
locked: boolean;
|
|
5518
|
+
why?: string;
|
|
5519
|
+
}>;
|
|
5520
|
+
fields: FormFieldStateRow[];
|
|
5521
|
+
summary: {
|
|
5522
|
+
visible: number;
|
|
5523
|
+
hidden: number;
|
|
5524
|
+
required: string[];
|
|
5525
|
+
locked: string[];
|
|
5526
|
+
missing: string[];
|
|
5527
|
+
};
|
|
5528
|
+
note?: string;
|
|
5529
|
+
}
|
|
5530
|
+
interface FormStateQuery {
|
|
5531
|
+
collection: string;
|
|
5532
|
+
item?: string | number;
|
|
5533
|
+
layout_id?: number;
|
|
5534
|
+
/** Field values laid over the record (or a new one) before the rules run. */
|
|
5535
|
+
values?: Record<string, unknown>;
|
|
5536
|
+
/** Administrators only: judge as this role (name or id). */
|
|
5537
|
+
role?: string;
|
|
5538
|
+
viewport?: 'phone';
|
|
5539
|
+
}
|
|
5540
|
+
/** Which fields the resolved form shows, requires and locks, and why. */
|
|
5541
|
+
declare function readFormState(query: FormStateQuery): Command<{
|
|
5542
|
+
data: FormStateAnswer;
|
|
5543
|
+
}>;
|
|
5544
|
+
interface FormImageAnswer {
|
|
5545
|
+
mime: 'image/png';
|
|
5546
|
+
base64: string;
|
|
5547
|
+
bytes: number;
|
|
5548
|
+
width: number;
|
|
5549
|
+
collection: string;
|
|
5550
|
+
record: string | null;
|
|
5551
|
+
as: FormStateAnswer['as'];
|
|
5552
|
+
layout: FormStateAnswer['layout'];
|
|
5553
|
+
can_update: boolean;
|
|
5554
|
+
summary: FormStateAnswer['summary'];
|
|
5555
|
+
}
|
|
5556
|
+
/** A PNG of how the form looks (base64), values only where the caller may read them. */
|
|
5557
|
+
declare function renderFormImage(query: FormStateQuery & {
|
|
5558
|
+
theme?: 'light' | 'dark';
|
|
5559
|
+
show_hidden?: boolean;
|
|
5560
|
+
}): Command<{
|
|
5561
|
+
data: FormImageAnswer;
|
|
5562
|
+
}>;
|
|
5563
|
+
interface LayoutLintAnswer {
|
|
5564
|
+
layout: {
|
|
5565
|
+
id: number;
|
|
5566
|
+
name: string;
|
|
5567
|
+
collection: string;
|
|
5568
|
+
};
|
|
5569
|
+
score: number;
|
|
5570
|
+
costs: Array<{
|
|
5571
|
+
label: string;
|
|
5572
|
+
points: number;
|
|
5573
|
+
}>;
|
|
5574
|
+
counts: {
|
|
5575
|
+
error: number;
|
|
5576
|
+
warn: number;
|
|
5577
|
+
info: number;
|
|
5578
|
+
};
|
|
5579
|
+
findings: Array<{
|
|
5580
|
+
id: string;
|
|
5581
|
+
rule: string;
|
|
5582
|
+
severity: 'error' | 'warn' | 'info';
|
|
5583
|
+
where: string;
|
|
5584
|
+
target: Record<string, unknown>;
|
|
5585
|
+
message: string;
|
|
5586
|
+
fix?: {
|
|
5587
|
+
label: string;
|
|
5588
|
+
ops: Array<Record<string, unknown>>;
|
|
5589
|
+
};
|
|
5590
|
+
}>;
|
|
5591
|
+
truncated?: true;
|
|
5592
|
+
total?: number;
|
|
5593
|
+
}
|
|
5594
|
+
/** The layout editor's lint findings and health score for a saved form. Admin only. */
|
|
5595
|
+
declare function readLayoutLint(layoutId: number): Command<{
|
|
5596
|
+
data: LayoutLintAnswer;
|
|
5597
|
+
}>;
|
|
5598
|
+
|
|
5206
5599
|
/**
|
|
5207
5600
|
* Help videos: tutorial recordings with edits, versions, where they show,
|
|
5208
5601
|
* required viewing and progress. Upload parts are raw octet-stream PUTs to
|
|
@@ -6299,6 +6692,8 @@ interface McpCapabilities {
|
|
|
6299
6692
|
admin_tools: boolean;
|
|
6300
6693
|
/** Chat tools (#2492): none, reading only, or reading and posting. */
|
|
6301
6694
|
chat: 'none' | 'read' | 'post';
|
|
6695
|
+
/** PATCH /items/:collection/:id?dry_run=1 rehearses an update (#3222); absent on older instances. */
|
|
6696
|
+
update_preview?: boolean;
|
|
6302
6697
|
}
|
|
6303
6698
|
/** What the MCP server may offer this credential (GET /api/mcp/capabilities). */
|
|
6304
6699
|
declare function readMcpCapabilities(): Command<{
|
|
@@ -6852,6 +7247,84 @@ declare function setQueueDefaultView(id: UUID, viewId: number | null): Command<{
|
|
|
6852
7247
|
};
|
|
6853
7248
|
}>;
|
|
6854
7249
|
|
|
7250
|
+
/**
|
|
7251
|
+
* Schema change proposals (#3209): draft a field or collection change for an administrator to
|
|
7252
|
+
* review. Nothing changes until an administrator applies it on the Data Model page.
|
|
7253
|
+
*/
|
|
7254
|
+
|
|
7255
|
+
type SchemaFieldType = 'string' | 'text' | 'integer' | 'bigInteger' | 'boolean' | 'decimal' | 'float' | 'date' | 'datetime' | 'uuid';
|
|
7256
|
+
interface SchemaChoice {
|
|
7257
|
+
value: string | number;
|
|
7258
|
+
text?: string;
|
|
7259
|
+
}
|
|
7260
|
+
interface ProposedField {
|
|
7261
|
+
field: string;
|
|
7262
|
+
type?: SchemaFieldType;
|
|
7263
|
+
label?: string;
|
|
7264
|
+
note?: string;
|
|
7265
|
+
choices?: SchemaChoice[];
|
|
7266
|
+
required?: boolean;
|
|
7267
|
+
max_length?: number;
|
|
7268
|
+
}
|
|
7269
|
+
type ProposedSchemaChange = ({
|
|
7270
|
+
kind: 'add_field';
|
|
7271
|
+
collection: string;
|
|
7272
|
+
} & ProposedField) | {
|
|
7273
|
+
kind: 'update_field';
|
|
7274
|
+
collection: string;
|
|
7275
|
+
field: string;
|
|
7276
|
+
label?: string;
|
|
7277
|
+
note?: string;
|
|
7278
|
+
choices?: SchemaChoice[];
|
|
7279
|
+
required?: boolean;
|
|
7280
|
+
} | {
|
|
7281
|
+
kind: 'add_collection';
|
|
7282
|
+
collection: string;
|
|
7283
|
+
display_name?: string;
|
|
7284
|
+
singular?: string;
|
|
7285
|
+
plural?: string;
|
|
7286
|
+
icon?: string;
|
|
7287
|
+
note?: string;
|
|
7288
|
+
fields?: ProposedField[];
|
|
7289
|
+
};
|
|
7290
|
+
/**
|
|
7291
|
+
* Store a schema proposal (POST /schema-proposals). Answers the plain-words reading of each
|
|
7292
|
+
* change; changes that would not hold (a field that exists, an unknown collection) are refused
|
|
7293
|
+
* with 400 and `change_index`.
|
|
7294
|
+
*/
|
|
7295
|
+
declare function proposeSchemaChange(body: {
|
|
7296
|
+
changes: ProposedSchemaChange[];
|
|
7297
|
+
note?: string;
|
|
7298
|
+
}): Command<{
|
|
7299
|
+
data: {
|
|
7300
|
+
id: string;
|
|
7301
|
+
status: 'proposed';
|
|
7302
|
+
changes: string[];
|
|
7303
|
+
note: string;
|
|
7304
|
+
};
|
|
7305
|
+
}>;
|
|
7306
|
+
interface SchemaProposal {
|
|
7307
|
+
id: string;
|
|
7308
|
+
status: 'proposed' | 'applied' | 'rejected' | 'expired';
|
|
7309
|
+
collections: string[];
|
|
7310
|
+
changes: ProposedSchemaChange[];
|
|
7311
|
+
sentences: string[];
|
|
7312
|
+
note: string | null;
|
|
7313
|
+
proposed_by: {
|
|
7314
|
+
id: string;
|
|
7315
|
+
name: string;
|
|
7316
|
+
};
|
|
7317
|
+
via: string;
|
|
7318
|
+
client: string | null;
|
|
7319
|
+
created_at: string;
|
|
7320
|
+
resolved_at: string | null;
|
|
7321
|
+
result: Record<string, unknown> | null;
|
|
7322
|
+
}
|
|
7323
|
+
/** One proposal and its outcome (the proposer or an administrator). */
|
|
7324
|
+
declare function readSchemaProposal(id: string): Command<{
|
|
7325
|
+
data: SchemaProposal;
|
|
7326
|
+
}>;
|
|
7327
|
+
|
|
6855
7328
|
/**
|
|
6856
7329
|
* Support desk commands (/api/support) — tickets live on Tasks (kind 'support').
|
|
6857
7330
|
* Requesters see their own; desk members (a routed team) and administrators the
|
|
@@ -8912,4 +9385,4 @@ declare function submitFormItem(collection: string, values: Record<string, unkno
|
|
|
8912
9385
|
data: Record<string, unknown>;
|
|
8913
9386
|
}>;
|
|
8914
9387
|
|
|
8915
|
-
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 ChaosWhatIfAnswer, type ChatChannel, type ChatChannelMember, type ChatDirectoryChannel, type ChatMessage, type ChatPin, type ChatReaction, type ChatRoomKind, type ChatRoomSummary, type ChatRoomType, type ChatSearchHit, type CollectionLayout, type CollectionLayoutType, type CollectionPresetSummary, type Command, type Comment, type CommentVersion, type ConfigSnapshot, type ConfigTableClassification, type ContentBundle, type ContentExportFormat, type ContentExportOptions, type CoverageGapItem, type CoverageGapOwner, type CoverageGapReport, type CpuProfileSummary, type CronJob, type CustomQuery, type CustomQueryCatalogEntry, type Dashboard, type DashboardFilter, type DashboardWidget, type DashboardWidgetData, type DashboardWidgetType, type DataQualityRule, type DataQualityRuleResult, type DataQualityRuleType, type DataQualityRun, type DataQualitySeverity, type DeadLetter, type DmvResult, type DraftPublishConfig, type DraftStatus, type DryRunReport, EDITOR_NOTE_MAX, type ErpSubmission, type ErpSubmissionStatus, type ExpensiveStatement, 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, GROUP_PATCH_KEYS, type GlobalSearchRecord, type GlobalSearchResults, type GraphQLResponse, type GroupPatch, type GroupRow, type HealthDetailed, type HelpVideo, type HelpVideoClick, type HelpVideoContext, type HelpVideoDownloadUrls, type HelpVideoFinalizedUpload, type HelpVideoProgress, type HelpVideoUploadSession, type HelpVideoVersion, type HelpVideoVisibility, type HelpVideoWalkStep, type HelpVideoWhatsNew, 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 InfrastructureSummaryTool, type InstanceOwner, type InstanceToolEntry, type IntegrationApiHealth, type InternalWidget, type Issue, type IssueSeverity, type IssueStatus, type IssueSummary, type ItemLock, type ItemWriteMeta, type JobRegistryCron, type JobRun, LAYOUT_PATCH_KEYS, type LastTouch, type LayoutAssignment, type LayoutBundle, type LayoutDescription, type LayoutFieldExplanation, type LayoutGroup, type LayoutOp, type LayoutOverviewRow, type LayoutPatch, type LayoutPickReason, type LayoutProposal, type LayoutRow, type LayoutVersion, type ListResponse, type ManagedUser, type McpCapabilities, type McpToolsConfig, type MetricAlertRule, type MetricAlertSubscription, type MetricDefinition, type MyTask, type MyWorkOwnedEntry, type MyWorkSla, type MyWorkSummary, type NamedMcpToolConfig, type NivaroClient, type NivaroClientOptions, type NivaroExtensionPlugin, type NivaroRealtime, type NivaroRuntime, type NotificationItem, type NotificationPage, type NotificationSubscription, type NumberFilterOps, type OmniSearchHit, type OnlinePresenceConfig, type OnlinePresenceUser, PLACEMENT_PATCH_KEYS, 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 PlacementKey, type PlacementPatch, type PlacementRow, type PluginSlots, type Policy, type PoolStats, type PreflightCheck, type PreflightReport, type PreflightSeverity, type PresenceClient, type PresenceOptions, type PresenceSession, type PresenceSessionInfo, type PresenceViewer, type ProjectedPlacement, 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 ReadyReport, 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 RuntimeStats, type SavedView, type ScheduledChange, type ScheduledReport, type ScopeDimension, type ScopeDimensionInfo, type SemanticSearchMatch, type SessionRecording, type SessionReplayMasking, type ShareLink, type SlaBatchStatus, type SlaRule, type SlaStatus, type StagedImportRun, type StagedImportStats, type StringFilterOps, type SubRow, type SubRowTemplate, type SupportTicket, type SupportTicketDetail, type SupportTicketStatus, type SyncJob, type Task, type TaskDoneWhenRule, type TaskPriority, type TaskStatus, type TimelineEvent, type TraceSpan, type TrafficSnapshot, type TrafficSnapshotEntity, 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 WhichLayoutForm, 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, applyHelpVideoPackageImport, applyRecordTemplate, applySubRowTemplate, approveAddendum, approveAiProposal, archiveHelpVideo, asc, backupExportPath, batchPickerExclusionStatus, bulkPickerExclusion, callExternalApi, callExternalApiEndpoint, callInstanceTool, cancelScheduledChange, cancelStagedImport, captureCpuProfile, cascadeFieldDependencies, chaosWhatIf, checkBlackoutDate, claimQueueItem, claimSupportTicket, 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, describeLayoutForm, diffLayoutVersion, disableTwoFactor, discardHelpVideoPackageImport, drillReportRow, editChatMessage, endSessionRecording, evaluateAlerts, evaluateAtRisk, evaluateFieldDefaults, evaluateFieldLock, evaluateFieldRules, evaluateFieldVisibility, excludeFromPicker, excludeFromPickers, executeBulkAction, executeCustomQuery, executeImportTemplate, executeItemAction, executeScheduledChange, explainLayout, explainLayoutField, explainRecordAccess, explainReportTrend, exportBlueprint, exportConfigSnapshot, exportContent, exportContentBundle, exportHelpVideoPackage, exportSchemaSnapshot, fetchFormSchema, fileDownloadPath, fileTransformPath, finalizeHelpVideoUpload, generateToken, generateUserToken, getAlertDefinition, getAttributeValues, getBrunoCollection, getCommentHistory, getExternalApi, getExternalApiEndpoint, getFieldTranslations, getFlowRun, getLocales, getOpenApi, getPickerExclusionStatus, getPostmanCollection, getPresence, getRetentionPolicy, getSlaRule, getSlaStatus, getTranslations, getTypes, getWebhook, globalSearch, heartbeatItemLock, helpVideosFor, importExternalApiSpec, importSchemaSnapshot, includeInPicker, includeInPickers, 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, listCustomQueryCatalog, listDashboards, listDataQualityRules, listDataQualityRuns, listDeadLetters, listExternalApiEndpoints, listExternalApiSchemas, listExternalApis, listFieldGroups, listFieldWatches, listFiles, listFlowRuns, listHelpVideoPages, listHelpVideoVersions, listHelpVideos, listHierarchyConfigs, listImportDefinitionVersions, listImportDefinitions, listImportJobs, listImportTemplates, listInstanceTools, listInternalWidgetPlacements, listInternalWidgets, listIssues, listItemActions, listItemScheduledChanges, listJobRuns, 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, listSupportTickets, listSyncJobs, listTasks, listTeamTasks, listThroughputCollections, listTraces, listTreePermissions, listViewSubscriptions, listVirtualCollections, listWebhookDeliveries, listWebhooks, listWidgetFeeds, listWorkspaceTemplates, listWorkspaces, markAllNotificationsRead, markChatRoomRead, markNotificationRead, markNotificationsRead, moveTreeNode, nudgeTask, omniSearch, openHelpVideoPackageImport, openHelpVideoUpload, presignFileUpload, previewContentBundle, previewHelpVideoPackageImport, previewImportJob, previewReportWidget, projectFieldConfig, proposeLayoutOps, 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, readDashboard, readDashboardWidgetData, readDataQualityRun, readDbPool, readDetailLayout, readDistinctValues, readDraftPublishConfig, readErpSubmissionHistory, readExpensiveSql, readFieldChangeHistory, readFieldConfig, readFieldImpact, readFieldWatch, readFileMeta, readFileUsage, readFilesByIds, readHealthDetailed, readHelpVideo, readHelpVideoAnalytics, readHelpVideoDownloadLink, readHelpVideoDraft, readHelpVideoWalk, readHierarchyConfig, readHierarchyNodeAncestors, readHierarchyNodeChildren, readHierarchyNodes, readHierarchyTree, readImportJob, readImportProcedure, readInfrastructureSummary, readInstanceOwners, readInstanceRoster, readIntegrationHealth, readInternalWidget, readIssue, readIssueSummary, readItem, readItemLock, readItemLockConfig, readItems, readJobRegistry, readLastTouch, readLayoutAssignments, readLayoutBundle, readLayoutDrift, readLayoutGroups, readLayoutOverview, readLayoutProposals, readLayoutVersion, readMany, readMcpCapabilities, readMcpToolsConfig, readMe, readMetricAlertLog, readMyScopes, readMyWork, readNotificationCount, readNotificationSubscriptionStats, readOnlinePresence, readOwnerGroups, readPage, readPageWidgetData, readPdfTemplate, readPersistedQuery, readPickerExclusion, readPickerExclusions, readPipelineFlowMap, readPipelineReplay, readPipelineTemplate, readPipelineTemplates, readPipelineVersion, readPreflight, readQueue, readQueueCollectionStates, readQueueColumnPrefs, readQueueItems, readQueueTrends, readQueueWorkload, readReadiness, readRecordGraph, readRelationOptions, readReport, readReportAlertLog, readReportAlertsLog, readReportFilterOptions, readReportFiring, readReportSnapshot, readReportSubscription, readReportUsage, readReportWidgetData, readRequiredHelpVideos, readRevision, readRevisions, readRole, readRuntimeStats, readScopeDimensionCoverage, readSessionRecordingEvents, readSettings, readSingleton, readSlaStatusBatch, readStagedImport, readStagedImportStats, readStateOwnerGroups, readStateOwners, readStateOwnersBatch, readSupportTicket, readSyncJob, readTask, readTaskCounts, readTaskHistory, readThroughputReport, readTimeline, readTrace, readTrafficSnapshot, 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, replySupportTicket, reportClientError, requestRecordAccess, requeueStagedImport, rerecordHelpVideo, rerenderHelpVideo, resetReportCache, resolveLayoutProposal, resolveReportAlert, restoreHelpVideoVersion, restoreImportDefinitionVersion, restoreLayoutVersion, restorePipelineVersion, restoreReportVersion, retryDeadLetter, retryErpSubmission, retryWebhookDelivery, revokeApiKey, revokeShareLink, revokeToken, revokeUserToken, rollbackRevision, rotateWidgetFeedToken, runAccessAudit, runActivityReport, runActivityReportCsv, runCronJob, runDataQuality, runRetentionPolicy, runScheduledReport, runSyncJob, saveHelpVideoDraft, saveMcpToolsConfig, saveMyScopeDefaults, saveReportFilterPreset, saveReportTemplate, saveReportWidgets, saveUserScope, searchChatMessages, semanticSearch, sendBulkNotification, sendChatMessage, sendTestMail, sessionRecordingEnabled, setHelpVideoContexts, setHelpVideoRequirements, setMyDelegate, setQueueDefaultView, setReportSubscription, setSupportTicketStatus, setTranslations, setupTwoFactor, simulatePermissions, simulatePipeline, simulatePipelineImpact, startApproval, startMasquerade, startSessionRecording, startWorkflow, stopMasquerade, submitAddendum, submitFormItem, submitItemForReview, submitLayoutOps, submitToErp, subscribeFieldWatch, subscribeMetricAlert, suggestImportValidation, suggestQueueLabels, switchWorkspace, testExternalApi, testFlow, testWebhook, toggleChatPin, toggleChatReaction, togglePinnedItem, toggleReportAlert, touchRecordView, transitionWorkflow, unpublishHelpVideo, 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, whichLayoutForm };
|
|
9388
|
+
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 AgentQuestion, type AgentQuestionStatus, type AgentTrigger, type AgentTriggerDelivery, type AgentTriggerEvent, 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 AttachedFile, type AttributeDefinition, type AttributeValue, type BatchRead, type BatchReadResult, type BlackoutDate, type BoolFilterOps, type CMSCollection, type CascadeFilterRule, type ChangeOrder, type ChaosWhatIfAnswer, type ChatChannel, type ChatChannelMember, type ChatDirectoryChannel, type ChatMessage, type ChatPin, type ChatReaction, type ChatRoomKind, type ChatRoomSummary, type ChatRoomType, type ChatSearchHit, type CollectionLayout, type CollectionLayoutType, type CollectionPresetSummary, type Command, type Comment, type CommentVersion, type ConfigSnapshot, type ConfigTableClassification, type ContentBundle, type ContentExportFormat, type ContentExportOptions, type CoverageGapItem, type CoverageGapOwner, type CoverageGapReport, type CpuProfileSummary, type CronJob, type CustomQuery, type CustomQueryCatalogEntry, type Dashboard, type DashboardFilter, type DashboardWidget, type DashboardWidgetData, type DashboardWidgetType, type DataQualityRule, type DataQualityRuleResult, type DataQualityRuleType, type DataQualityRun, type DataQualitySeverity, type DeadLetter, type DmvResult, type DraftPublishConfig, type DraftStatus, type DryRunReport, EDITOR_NOTE_MAX, type ErpSubmission, type ErpSubmissionStatus, type ExpensiveStatement, 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 FormFieldStateRow, type FormGroupDescriptor, type FormImageAnswer, type FormLockCondition, type FormSchema, type FormStateAnswer, type FormStateQuery, type FormValidationRule, type FormVisibilityRule, GROUP_PATCH_KEYS, type GlobalSearchRecord, type GlobalSearchResults, type GraphQLResponse, type GroupPatch, type GroupRow, type HealthDetailed, type HelpVideo, type HelpVideoClick, type HelpVideoContext, type HelpVideoDownloadUrls, type HelpVideoFinalizedUpload, type HelpVideoProgress, type HelpVideoUploadSession, type HelpVideoVersion, type HelpVideoVisibility, type HelpVideoWalkStep, type HelpVideoWhatsNew, 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 InfrastructureSummaryTool, type InstanceOwner, type InstanceToolEntry, type IntegrationApiHealth, type InternalWidget, type Issue, type IssueSeverity, type IssueStatus, type IssueSummary, type ItemLock, type ItemWriteMeta, type JobRegistryCron, type JobRun, LAYOUT_PATCH_KEYS, type LastTouch, type LayoutAssignment, type LayoutBundle, type LayoutDescription, type LayoutFieldExplanation, type LayoutGroup, type LayoutLintAnswer, type LayoutOp, type LayoutOverviewRow, type LayoutPatch, type LayoutPickReason, type LayoutProposal, type LayoutRow, type LayoutVersion, type ListResponse, type ManagedUser, type McpCapabilities, type McpToolsConfig, type MetricAlertRule, type MetricAlertSubscription, type MetricDefinition, type MyTask, type MyWorkOwnedEntry, type MyWorkSla, type MyWorkSummary, type NamedMcpToolConfig, type NivaroClient, type NivaroClientOptions, type NivaroExtensionPlugin, type NivaroRealtime, type NivaroRuntime, type NotificationItem, type NotificationPage, type NotificationSubscription, type NumberFilterOps, type OmniSearchHit, type OnlinePresenceConfig, type OnlinePresenceUser, PLACEMENT_PATCH_KEYS, 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 PlacementKey, type PlacementPatch, type PlacementRow, type PluginSlots, type Policy, type PoolStats, type PreflightCheck, type PreflightReport, type PreflightSeverity, type PresenceClient, type PresenceOptions, type PresenceSession, type PresenceSessionInfo, type PresenceViewer, type ProjectedPlacement, type PromotionApplyResult, type PromotionPreview, type ProposedField, type ProposedSchemaChange, 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 ReadyReport, 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 RuntimeStats, type SavedView, type ScheduledChange, type ScheduledReport, type SchemaChoice, type SchemaFieldType, type SchemaProposal, type ScopeDimension, type ScopeDimensionInfo, type SemanticSearchMatch, type SessionRecording, type SessionReplayMasking, type ShareLink, type SlaBatchStatus, type SlaRule, type SlaStatus, type StagedImportRun, type StagedImportStats, type StringFilterOps, type SubRow, type SubRowTemplate, type SupportTicket, type SupportTicketDetail, type SupportTicketStatus, type SyncJob, type Task, type TaskAgent, type TaskDoneWhenRule, type TaskPriority, type TaskStatus, type TimelineEvent, type TraceSpan, type TrafficSnapshot, type TrafficSnapshotEntity, 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 WhichLayoutForm, type WidgetDrillBody, type WidgetDrillRows, 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, answerAgentQuestion, appendSessionRecordingEvents, applyContentBundle, applyHelpVideoPackageImport, applyRecordTemplate, applySubRowTemplate, approveAddendum, approveAiProposal, archiveHelpVideo, asc, askHuman, attachFileToRecord, backupExportPath, batchPickerExclusionStatus, bulkPickerExclusion, callExternalApi, callExternalApiEndpoint, callInstanceTool, cancelAgentQuestion, cancelScheduledChange, cancelStagedImport, captureCpuProfile, cascadeFieldDependencies, chaosWhatIf, checkBlackoutDate, claimQueueItem, claimSupportTicket, 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, describeLayoutForm, diffLayoutVersion, disableTwoFactor, discardHelpVideoPackageImport, drillDashboardWidgetRows, drillReportRow, drillReportWidgetRows, editChatMessage, endSessionRecording, evaluateAlerts, evaluateAtRisk, evaluateFieldDefaults, evaluateFieldLock, evaluateFieldRules, evaluateFieldVisibility, excludeFromPicker, excludeFromPickers, executeBulkAction, executeCustomQuery, executeImportTemplate, executeItemAction, executeScheduledChange, explainLayout, explainLayoutField, explainRecordAccess, explainReportTrend, exportBlueprint, exportConfigSnapshot, exportContent, exportContentBundle, exportHelpVideoPackage, exportSchemaSnapshot, fetchFormSchema, fileDownloadPath, fileTransformPath, finalizeHelpVideoUpload, generateToken, generateUserToken, getAlertDefinition, getAttributeValues, getBrunoCollection, getCommentHistory, getExternalApi, getExternalApiEndpoint, getFieldTranslations, getFlowRun, getLocales, getOpenApi, getPickerExclusionStatus, getPostmanCollection, getPresence, getRetentionPolicy, getSlaRule, getSlaStatus, getTranslations, getTypes, getWebhook, globalSearch, heartbeatItemLock, helpVideosFor, importExternalApiSpec, importSchemaSnapshot, includeInPicker, includeInPickers, installBlueprint, installCollectionPreset, invokeInternalWidgetAction, isPageSlot, joinChatRoom, leaveChatRoom, listAccessAuditRuns, listAccessAudits, listActiveAtRiskRules, listActivePresence, listAddendums, listAgentTasks, listAgentTriggerDeliveries, listAgentTriggers, listAlertDefinitions, listAlertSubscriptions, listAllNotificationSubscriptions, listAnomalyDefinitions, listAnomalyRules, listApiKeys, listApprovalChains, listApprovalInstances, listAskedQuestions, listAtRiskRules, listAttributeDefinitions, listBlackoutDates, listBulkActions, listChangeOrders, listChatChannelMembers, listChatMessages, listChatPins, listChatRoles, listChatRoomTypes, listChatRooms, listCollectionPresets, listCollectionRecordTemplates, listComments, listCronJobs, listCustomQueries, listCustomQueryCatalog, listDashboards, listDataQualityRules, listDataQualityRuns, listDeadLetters, listExternalApiEndpoints, listExternalApiSchemas, listExternalApis, listFieldGroups, listFieldWatches, listFiles, listFlowRuns, listHelpVideoPages, listHelpVideoVersions, listHelpVideos, listHierarchyConfigs, listImportDefinitionVersions, listImportDefinitions, listImportJobs, listImportTemplates, listInstanceTools, listInternalWidgetPlacements, listInternalWidgets, listIssues, listItemActions, listItemScheduledChanges, listJobRuns, listLayoutVersions, listMetricAlertRules, listMetricAlertSubscriptions, listMetricDefinitions, listMyAgentQuestions, 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, listSupportTickets, listSyncJobs, listTaskAgents, listTasks, listTeamTasks, listThroughputCollections, listTraces, listTreePermissions, listViewSubscriptions, listVirtualCollections, listWebhookDeliveries, listWebhooks, listWidgetFeeds, listWorkspaceTemplates, listWorkspaces, markAllNotificationsRead, markChatRoomRead, markNotificationRead, markNotificationsRead, moveTreeNode, nudgeTask, omniSearch, openHelpVideoPackageImport, openHelpVideoUpload, presignFileUpload, previewContentBundle, previewHelpVideoPackageImport, previewImportJob, previewReportWidget, projectFieldConfig, proposeLayoutOps, proposeSchemaChange, publishHelpVideo, publishItem, queryVirtualCollection, readAccessAuditFindings, readActiveLayout, readActivity, readActivityReportSummary, readAddendum, readAgentQuestion, readAiSettings, readAlertLog, readAllStateOwners, readAnomalyLog, readApiAnalyticsErrors, readApiAnalyticsSummary, readApiAnalyticsTimeseries, readApiAnalyticsTopCollections, readApiAnalyticsTopPaths, readApiKey, readApprovalBrief, readApprovalChain, readAtRiskSummary, readBackupManifest, readChatConfig, readChatDirectory, readChatPeerRead, readCollection, readCollectionLayout, readCollectionLayouts, readCollections, readConfigInventory, readCoverageGaps, readDashboard, readDashboardWidgetData, readDataQualityRun, readDbPool, readDetailLayout, readDistinctValues, readDraftPublishConfig, readErpSubmissionHistory, readExpensiveSql, readFieldChangeHistory, readFieldConfig, readFieldImpact, readFieldWatch, readFileMeta, readFileUsage, readFilesByIds, readFormState, readHealthDetailed, readHelpVideo, readHelpVideoAnalytics, readHelpVideoDownloadLink, readHelpVideoDraft, readHelpVideoWalk, readHierarchyConfig, readHierarchyNodeAncestors, readHierarchyNodeChildren, readHierarchyNodes, readHierarchyTree, readImportJob, readImportProcedure, readInfrastructureSummary, readInstanceOwners, readInstanceRoster, readIntegrationHealth, readInternalWidget, readIssue, readIssueSummary, readItem, readItemLock, readItemLockConfig, readItems, readJobRegistry, readLastTouch, readLayoutAssignments, readLayoutBundle, readLayoutDrift, readLayoutGroups, readLayoutLint, readLayoutOverview, readLayoutProposals, readLayoutVersion, readMany, readMcpCapabilities, readMcpToolsConfig, readMe, readMetricAlertLog, readMyScopes, readMyWork, readNotificationCount, readNotificationSubscriptionStats, readOnlinePresence, readOwnerGroups, readPage, readPageWidgetData, readPdfTemplate, readPersistedQuery, readPickerExclusion, readPickerExclusions, readPipelineFlowMap, readPipelineReplay, readPipelineTemplate, readPipelineTemplates, readPipelineVersion, readPreflight, readQueue, readQueueCollectionStates, readQueueColumnPrefs, readQueueItems, readQueueTrends, readQueueWorkload, readReadiness, readRecordGraph, readRelationOptions, readReport, readReportAlertLog, readReportAlertsLog, readReportFilterOptions, readReportFiring, readReportSnapshot, readReportSubscription, readReportUsage, readReportWidgetData, readRequiredHelpVideos, readRevision, readRevisions, readRole, readRuntimeStats, readSchemaProposal, readScopeDimensionCoverage, readSessionRecordingEvents, readSettings, readSingleton, readSlaStatusBatch, readStagedImport, readStagedImportStats, readStateOwnerGroups, readStateOwners, readStateOwnersBatch, readSupportTicket, readSyncJob, readTask, readTaskCounts, readTaskHistory, readThroughputReport, readTimeline, readTrace, readTrafficSnapshot, 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, renderFormImage, renderInternalWidget, renderPdfTemplate, reorderFieldGroups, reorderSubRows, reorderTreeSiblings, replaceSubRows, replayActivityEvent, replayFlow, replySupportTicket, reportClientError, requestRecordAccess, requeueStagedImport, rerecordHelpVideo, rerenderHelpVideo, resetReportCache, resolveLayoutProposal, resolveReportAlert, restoreHelpVideoVersion, restoreImportDefinitionVersion, restoreLayoutVersion, restorePipelineVersion, restoreReportVersion, retryDeadLetter, retryErpSubmission, retryWebhookDelivery, revokeApiKey, revokeShareLink, revokeToken, revokeUserToken, rollbackRevision, rotateWidgetFeedToken, runAccessAudit, runActivityReport, runActivityReportCsv, runCronJob, runDataQuality, runRetentionPolicy, runScheduledReport, runSyncJob, saveHelpVideoDraft, saveMcpToolsConfig, saveMyScopeDefaults, saveReportFilterPreset, saveReportTemplate, saveReportWidgets, saveUserScope, searchChatMessages, semanticSearch, sendBulkNotification, sendChatMessage, sendTestMail, sessionRecordingEnabled, setHelpVideoContexts, setHelpVideoRequirements, setMyDelegate, setQueueDefaultView, setReportSubscription, setSupportTicketStatus, setTranslations, setupTwoFactor, simulatePermissions, simulatePipeline, simulatePipelineImpact, startApproval, startMasquerade, startSessionRecording, startWorkflow, stopMasquerade, submitAddendum, submitFormItem, submitItemForReview, submitLayoutOps, submitToErp, subscribeFieldWatch, subscribeMetricAlert, suggestImportValidation, suggestQueueLabels, switchWorkspace, testExternalApi, testFlow, testWebhook, toggleChatPin, toggleChatReaction, togglePinnedItem, toggleReportAlert, touchRecordView, transitionWorkflow, unpublishHelpVideo, 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, whichLayoutForm, withSignal };
|
package/dist/index.js
CHANGED
|
@@ -2,6 +2,9 @@
|
|
|
2
2
|
function cmd(method, path, params, body) {
|
|
3
3
|
return { _method: method, _path: path, _params: params, _body: body };
|
|
4
4
|
}
|
|
5
|
+
function withSignal(command, signal) {
|
|
6
|
+
return signal ? { ...command, _signal: signal } : command;
|
|
7
|
+
}
|
|
5
8
|
|
|
6
9
|
// src/commands/admin.ts
|
|
7
10
|
function listRoles() {
|
|
@@ -514,6 +517,38 @@ function readIntegrationHealth() {
|
|
|
514
517
|
return cmd("GET", "/integration-health");
|
|
515
518
|
}
|
|
516
519
|
|
|
520
|
+
// src/commands/agents.ts
|
|
521
|
+
function askHuman(body) {
|
|
522
|
+
return cmd("POST", "/agent-questions", void 0, body);
|
|
523
|
+
}
|
|
524
|
+
function readAgentQuestion(id, wait) {
|
|
525
|
+
return cmd("GET", `/agent-questions/${encodeURIComponent(id)}`, wait ? { wait } : void 0);
|
|
526
|
+
}
|
|
527
|
+
function listMyAgentQuestions() {
|
|
528
|
+
return cmd("GET", "/agent-questions/mine");
|
|
529
|
+
}
|
|
530
|
+
function listAskedQuestions(query) {
|
|
531
|
+
return cmd("GET", "/agent-questions/asked", query);
|
|
532
|
+
}
|
|
533
|
+
function answerAgentQuestion(id, body) {
|
|
534
|
+
return cmd("POST", `/agent-questions/${encodeURIComponent(id)}/answer`, void 0, body);
|
|
535
|
+
}
|
|
536
|
+
function cancelAgentQuestion(id) {
|
|
537
|
+
return cmd("POST", `/agent-questions/${encodeURIComponent(id)}/cancel`);
|
|
538
|
+
}
|
|
539
|
+
function listTaskAgents(opts) {
|
|
540
|
+
return cmd("GET", "/tasks/agents", opts?.all ? { all: 1 } : void 0);
|
|
541
|
+
}
|
|
542
|
+
function listAgentTasks(status) {
|
|
543
|
+
return cmd("GET", "/tasks", { agent: "mine", ...status ? { status } : {} });
|
|
544
|
+
}
|
|
545
|
+
function listAgentTriggers() {
|
|
546
|
+
return cmd("GET", "/agent-triggers");
|
|
547
|
+
}
|
|
548
|
+
function listAgentTriggerDeliveries(query) {
|
|
549
|
+
return cmd("GET", "/agent-triggers/deliveries", query);
|
|
550
|
+
}
|
|
551
|
+
|
|
517
552
|
// src/commands/ai.ts
|
|
518
553
|
function aiGenerate(body) {
|
|
519
554
|
return cmd("POST", "/ai/generate", void 0, body);
|
|
@@ -1396,6 +1431,9 @@ function updateFileMeta(id, data) {
|
|
|
1396
1431
|
function deleteFile(id) {
|
|
1397
1432
|
return cmd("DELETE", `/files/${id}`);
|
|
1398
1433
|
}
|
|
1434
|
+
function attachFileToRecord(data) {
|
|
1435
|
+
return cmd("POST", "/files/attach", void 0, { ...data, item: String(data.item) });
|
|
1436
|
+
}
|
|
1399
1437
|
function readFileUsage(id) {
|
|
1400
1438
|
return cmd("GET", `/files/${id}/usage`);
|
|
1401
1439
|
}
|
|
@@ -1417,6 +1455,23 @@ function fileTransformPath(id, options = {}) {
|
|
|
1417
1455
|
return `/api/files/${id}/transform${qs ? `?${qs}` : ""}`;
|
|
1418
1456
|
}
|
|
1419
1457
|
|
|
1458
|
+
// src/commands/form-tools.ts
|
|
1459
|
+
function drillDashboardWidgetRows(widgetId, body = {}) {
|
|
1460
|
+
return cmd("POST", `/dashboards/widgets/${widgetId}/rows`, void 0, body);
|
|
1461
|
+
}
|
|
1462
|
+
function drillReportWidgetRows(reportId, widgetId, body = {}) {
|
|
1463
|
+
return cmd("POST", `/report-studio/${reportId}/widgets/${widgetId}/rows`, void 0, body);
|
|
1464
|
+
}
|
|
1465
|
+
function readFormState(query) {
|
|
1466
|
+
return cmd("POST", "/collection-layouts/form-state", void 0, query);
|
|
1467
|
+
}
|
|
1468
|
+
function renderFormImage(query) {
|
|
1469
|
+
return cmd("POST", "/collection-layouts/render-form", void 0, query);
|
|
1470
|
+
}
|
|
1471
|
+
function readLayoutLint(layoutId) {
|
|
1472
|
+
return cmd("GET", `/collection-layouts/${layoutId}/lint`);
|
|
1473
|
+
}
|
|
1474
|
+
|
|
1420
1475
|
// src/commands/help-videos.ts
|
|
1421
1476
|
function listHelpVideos(params) {
|
|
1422
1477
|
return cmd("GET", "/help-videos", params);
|
|
@@ -1949,6 +2004,14 @@ function setQueueDefaultView(id, viewId) {
|
|
|
1949
2004
|
return cmd("PUT", `/queues/${id}/default-view`, void 0, { view_id: viewId });
|
|
1950
2005
|
}
|
|
1951
2006
|
|
|
2007
|
+
// src/commands/schema-proposals.ts
|
|
2008
|
+
function proposeSchemaChange(body) {
|
|
2009
|
+
return cmd("POST", "/schema-proposals", void 0, body);
|
|
2010
|
+
}
|
|
2011
|
+
function readSchemaProposal(id) {
|
|
2012
|
+
return cmd("GET", `/schema-proposals/${id}`);
|
|
2013
|
+
}
|
|
2014
|
+
|
|
1952
2015
|
// src/commands/support.ts
|
|
1953
2016
|
function listSupportTickets(query) {
|
|
1954
2017
|
return cmd("GET", "/support/tickets", query);
|
|
@@ -2627,42 +2690,54 @@ function createNivaro(url, options = {}) {
|
|
|
2627
2690
|
const timed = command._method === "GET" && timeoutMs > 0;
|
|
2628
2691
|
const ctrl = timed ? new AbortController() : null;
|
|
2629
2692
|
const timer = ctrl ? setTimeout(() => ctrl.abort(), timeoutMs) : null;
|
|
2630
|
-
|
|
2693
|
+
const callerSignal = command._signal;
|
|
2694
|
+
const onCallerAbort = () => ctrl?.abort();
|
|
2695
|
+
if (callerSignal && ctrl) {
|
|
2696
|
+
if (callerSignal.aborted) ctrl.abort();
|
|
2697
|
+
else callerSignal.addEventListener("abort", onCallerAbort, { once: true });
|
|
2698
|
+
}
|
|
2699
|
+
const signal = ctrl ? ctrl.signal : callerSignal;
|
|
2631
2700
|
try {
|
|
2632
|
-
res
|
|
2633
|
-
|
|
2634
|
-
|
|
2635
|
-
|
|
2636
|
-
|
|
2637
|
-
|
|
2638
|
-
|
|
2639
|
-
|
|
2640
|
-
if (ctrl?.signal.aborted)
|
|
2641
|
-
throw Object.assign(new Error(`Request timed out after ${timeoutMs / 1e3}s`), {
|
|
2642
|
-
name: "TimeoutError"
|
|
2701
|
+
let res;
|
|
2702
|
+
try {
|
|
2703
|
+
res = await fetcher(`${baseUrl}/api${command._path}${qs}`, {
|
|
2704
|
+
method: command._method,
|
|
2705
|
+
headers: authHeaders(),
|
|
2706
|
+
credentials: credentialsMode(),
|
|
2707
|
+
body: command._body != null ? JSON.stringify(command._body) : void 0,
|
|
2708
|
+
...signal ? { signal } : {}
|
|
2643
2709
|
});
|
|
2644
|
-
|
|
2645
|
-
|
|
2646
|
-
|
|
2647
|
-
|
|
2648
|
-
|
|
2649
|
-
|
|
2650
|
-
|
|
2651
|
-
|
|
2652
|
-
|
|
2653
|
-
|
|
2654
|
-
|
|
2655
|
-
|
|
2656
|
-
});
|
|
2657
|
-
}
|
|
2658
|
-
const contentType = res.headers.get("content-type") ?? "";
|
|
2659
|
-
if (!contentType.includes("application/json")) {
|
|
2660
|
-
if (contentType.includes("application/pdf") || contentType.includes("application/octet-stream")) {
|
|
2661
|
-
return await res.arrayBuffer();
|
|
2710
|
+
} catch (e) {
|
|
2711
|
+
if (callerSignal?.aborted) throw e;
|
|
2712
|
+
if (ctrl?.signal.aborted)
|
|
2713
|
+
throw Object.assign(new Error(`Request timed out after ${timeoutMs / 1e3}s`), {
|
|
2714
|
+
name: "TimeoutError"
|
|
2715
|
+
});
|
|
2716
|
+
throw e;
|
|
2717
|
+
} finally {
|
|
2718
|
+
if (timer) clearTimeout(timer);
|
|
2719
|
+
}
|
|
2720
|
+
if (command._method === "DELETE" && res.status === 204) {
|
|
2721
|
+
return void 0;
|
|
2662
2722
|
}
|
|
2663
|
-
|
|
2723
|
+
if (!res.ok) {
|
|
2724
|
+
const err = await res.json().catch(() => ({ error: res.statusText }));
|
|
2725
|
+
throw Object.assign(new Error(err.error ?? res.statusText), {
|
|
2726
|
+
status: res.status,
|
|
2727
|
+
response: err
|
|
2728
|
+
});
|
|
2729
|
+
}
|
|
2730
|
+
const contentType = res.headers.get("content-type") ?? "";
|
|
2731
|
+
if (!contentType.includes("application/json")) {
|
|
2732
|
+
if (contentType.includes("application/pdf") || contentType.includes("application/octet-stream")) {
|
|
2733
|
+
return await res.arrayBuffer();
|
|
2734
|
+
}
|
|
2735
|
+
return await res.text();
|
|
2736
|
+
}
|
|
2737
|
+
return await res.json();
|
|
2738
|
+
} finally {
|
|
2739
|
+
callerSignal?.removeEventListener("abort", onCallerAbort);
|
|
2664
2740
|
}
|
|
2665
|
-
return res.json();
|
|
2666
2741
|
}
|
|
2667
2742
|
async function upload(file, opts = {}) {
|
|
2668
2743
|
const fd = new FormData();
|
|
@@ -2997,6 +3072,7 @@ export {
|
|
|
2997
3072
|
aiReview,
|
|
2998
3073
|
aiSummarize,
|
|
2999
3074
|
aiValidate,
|
|
3075
|
+
answerAgentQuestion,
|
|
3000
3076
|
appendSessionRecordingEvents,
|
|
3001
3077
|
applyContentBundle,
|
|
3002
3078
|
applyHelpVideoPackageImport,
|
|
@@ -3006,12 +3082,15 @@ export {
|
|
|
3006
3082
|
approveAiProposal,
|
|
3007
3083
|
archiveHelpVideo,
|
|
3008
3084
|
asc,
|
|
3085
|
+
askHuman,
|
|
3086
|
+
attachFileToRecord,
|
|
3009
3087
|
backupExportPath,
|
|
3010
3088
|
batchPickerExclusionStatus,
|
|
3011
3089
|
bulkPickerExclusion,
|
|
3012
3090
|
callExternalApi,
|
|
3013
3091
|
callExternalApiEndpoint,
|
|
3014
3092
|
callInstanceTool,
|
|
3093
|
+
cancelAgentQuestion,
|
|
3015
3094
|
cancelScheduledChange,
|
|
3016
3095
|
cancelStagedImport,
|
|
3017
3096
|
captureCpuProfile,
|
|
@@ -3165,7 +3244,9 @@ export {
|
|
|
3165
3244
|
diffLayoutVersion,
|
|
3166
3245
|
disableTwoFactor,
|
|
3167
3246
|
discardHelpVideoPackageImport,
|
|
3247
|
+
drillDashboardWidgetRows,
|
|
3168
3248
|
drillReportRow,
|
|
3249
|
+
drillReportWidgetRows,
|
|
3169
3250
|
editChatMessage,
|
|
3170
3251
|
endSessionRecording,
|
|
3171
3252
|
evaluateAlerts,
|
|
@@ -3234,6 +3315,9 @@ export {
|
|
|
3234
3315
|
listActiveAtRiskRules,
|
|
3235
3316
|
listActivePresence,
|
|
3236
3317
|
listAddendums,
|
|
3318
|
+
listAgentTasks,
|
|
3319
|
+
listAgentTriggerDeliveries,
|
|
3320
|
+
listAgentTriggers,
|
|
3237
3321
|
listAlertDefinitions,
|
|
3238
3322
|
listAlertSubscriptions,
|
|
3239
3323
|
listAllNotificationSubscriptions,
|
|
@@ -3242,6 +3326,7 @@ export {
|
|
|
3242
3326
|
listApiKeys,
|
|
3243
3327
|
listApprovalChains,
|
|
3244
3328
|
listApprovalInstances,
|
|
3329
|
+
listAskedQuestions,
|
|
3245
3330
|
listAtRiskRules,
|
|
3246
3331
|
listAttributeDefinitions,
|
|
3247
3332
|
listBlackoutDates,
|
|
@@ -3289,6 +3374,7 @@ export {
|
|
|
3289
3374
|
listMetricAlertRules,
|
|
3290
3375
|
listMetricAlertSubscriptions,
|
|
3291
3376
|
listMetricDefinitions,
|
|
3377
|
+
listMyAgentQuestions,
|
|
3292
3378
|
listMyHelpVideoUploads,
|
|
3293
3379
|
listMyTasks,
|
|
3294
3380
|
listNotificationSubscriptions,
|
|
@@ -3334,6 +3420,7 @@ export {
|
|
|
3334
3420
|
listSubRows,
|
|
3335
3421
|
listSupportTickets,
|
|
3336
3422
|
listSyncJobs,
|
|
3423
|
+
listTaskAgents,
|
|
3337
3424
|
listTasks,
|
|
3338
3425
|
listTeamTasks,
|
|
3339
3426
|
listThroughputCollections,
|
|
@@ -3362,6 +3449,7 @@ export {
|
|
|
3362
3449
|
previewReportWidget,
|
|
3363
3450
|
projectFieldConfig,
|
|
3364
3451
|
proposeLayoutOps,
|
|
3452
|
+
proposeSchemaChange,
|
|
3365
3453
|
publishHelpVideo,
|
|
3366
3454
|
publishItem,
|
|
3367
3455
|
queryVirtualCollection,
|
|
@@ -3370,6 +3458,7 @@ export {
|
|
|
3370
3458
|
readActivity,
|
|
3371
3459
|
readActivityReportSummary,
|
|
3372
3460
|
readAddendum,
|
|
3461
|
+
readAgentQuestion,
|
|
3373
3462
|
readAiSettings,
|
|
3374
3463
|
readAlertLog,
|
|
3375
3464
|
readAllStateOwners,
|
|
@@ -3409,6 +3498,7 @@ export {
|
|
|
3409
3498
|
readFileMeta,
|
|
3410
3499
|
readFileUsage,
|
|
3411
3500
|
readFilesByIds,
|
|
3501
|
+
readFormState,
|
|
3412
3502
|
readHealthDetailed,
|
|
3413
3503
|
readHelpVideo,
|
|
3414
3504
|
readHelpVideoAnalytics,
|
|
@@ -3439,6 +3529,7 @@ export {
|
|
|
3439
3529
|
readLayoutBundle,
|
|
3440
3530
|
readLayoutDrift,
|
|
3441
3531
|
readLayoutGroups,
|
|
3532
|
+
readLayoutLint,
|
|
3442
3533
|
readLayoutOverview,
|
|
3443
3534
|
readLayoutProposals,
|
|
3444
3535
|
readLayoutVersion,
|
|
@@ -3488,6 +3579,7 @@ export {
|
|
|
3488
3579
|
readRevisions,
|
|
3489
3580
|
readRole,
|
|
3490
3581
|
readRuntimeStats,
|
|
3582
|
+
readSchemaProposal,
|
|
3491
3583
|
readScopeDimensionCoverage,
|
|
3492
3584
|
readSessionRecordingEvents,
|
|
3493
3585
|
readSettings,
|
|
@@ -3538,6 +3630,7 @@ export {
|
|
|
3538
3630
|
rematerializeQueue,
|
|
3539
3631
|
removeChatChannelMember,
|
|
3540
3632
|
removeInstanceOwner,
|
|
3633
|
+
renderFormImage,
|
|
3541
3634
|
renderInternalWidget,
|
|
3542
3635
|
renderPdfTemplate,
|
|
3543
3636
|
reorderFieldGroups,
|
|
@@ -3698,5 +3791,6 @@ export {
|
|
|
3698
3791
|
updateWorkspace,
|
|
3699
3792
|
validateVirtualCollectionSql,
|
|
3700
3793
|
verifyTwoFactor,
|
|
3701
|
-
whichLayoutForm
|
|
3794
|
+
whichLayoutForm,
|
|
3795
|
+
withSignal
|
|
3702
3796
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nivaro/sdk",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.7",
|
|
4
4
|
"description": "TypeScript SDK for Nivaro CMS — typed REST client, GraphQL, realtime subscriptions, and presence.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -50,7 +50,7 @@
|
|
|
50
50
|
"scripts": {
|
|
51
51
|
"build": "tsup src/index.ts --format esm --dts --out-dir dist",
|
|
52
52
|
"dev": "tsup src/index.ts --format esm --dts --out-dir dist --watch",
|
|
53
|
-
"test": "node --test bin/lib/*.test.mjs"
|
|
53
|
+
"test": "node --test bin/lib/*.test.mjs test/*.test.mjs"
|
|
54
54
|
},
|
|
55
55
|
"dependencies": {
|
|
56
56
|
"socket.io-client": "^4.8.4"
|