@arbidocs/client 0.4.54 → 0.4.55
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.cts +20 -198
- package/dist/index.d.ts +20 -198
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1713,10 +1713,9 @@ interface paths {
|
|
|
1713
1713
|
*
|
|
1714
1714
|
* * ``shared`` — its creator only (a row nobody else can see cannot be written by them): nobody else decides.
|
|
1715
1715
|
* * everything else — the owner, or a collaborator of the workspace on a shared item.
|
|
1716
|
-
* * ``status`` — ``todo`` or ``done`` only. ``done`` is human-only (
|
|
1717
|
-
* ``generating``
|
|
1716
|
+
* * ``status`` — ``todo`` or ``done`` only. ``done`` is human-only (anyone who can edit it); ``todo`` reopens.
|
|
1717
|
+
* ``generating`` is set only by runs.
|
|
1718
1718
|
* * ``parent_conversation_ext_id`` — cycle-checked; ``null`` detaches.
|
|
1719
|
-
* * ``signoff_user_ext_id`` — a human who can edit the workspace; ``null`` falls back to the owner.
|
|
1720
1719
|
*/
|
|
1721
1720
|
patch: operations['update_conversation'];
|
|
1722
1721
|
trace?: never;
|
|
@@ -1812,7 +1811,7 @@ interface paths {
|
|
|
1812
1811
|
put?: never;
|
|
1813
1812
|
/**
|
|
1814
1813
|
* Plan Work
|
|
1815
|
-
* @description Draft
|
|
1814
|
+
* @description Draft an editable ``TaskPlan`` for the active workspace from a plain objective.
|
|
1816
1815
|
*
|
|
1817
1816
|
* The unified planner (``filter_and_plan`` → ``author_checklist``): formulates the goal, proposes the doc
|
|
1818
1817
|
* set, and authors the acceptance criteria. Stateless — the caller attaches the returned plan to a create
|
|
@@ -1850,31 +1849,6 @@ interface paths {
|
|
|
1850
1849
|
patch?: never;
|
|
1851
1850
|
trace?: never;
|
|
1852
1851
|
};
|
|
1853
|
-
'/v1/conversation/{conversation_ext_id}/review': {
|
|
1854
|
-
parameters: {
|
|
1855
|
-
query?: never;
|
|
1856
|
-
header?: never;
|
|
1857
|
-
path?: never;
|
|
1858
|
-
cookie?: never;
|
|
1859
|
-
};
|
|
1860
|
-
get?: never;
|
|
1861
|
-
put?: never;
|
|
1862
|
-
/**
|
|
1863
|
-
* Review Conversation
|
|
1864
|
-
* @description A person's verdict on prepared work (``ready_for_review``). Never an agent.
|
|
1865
|
-
*
|
|
1866
|
-
* ``approve`` (sign-off person only) marks it done and emits ``conversation_done`` so workflows waiting
|
|
1867
|
-
* on it can start.
|
|
1868
|
-
* ``request_changes`` sends ``feedback`` back to the agent as the next turn of the SAME thread and the
|
|
1869
|
-
* status goes back to ``generating``.
|
|
1870
|
-
*/
|
|
1871
|
-
post: operations['review_conversation'];
|
|
1872
|
-
delete?: never;
|
|
1873
|
-
options?: never;
|
|
1874
|
-
head?: never;
|
|
1875
|
-
patch?: never;
|
|
1876
|
-
trace?: never;
|
|
1877
|
-
};
|
|
1878
1852
|
'/v1/conversation/{conversation_ext_id}/activity': {
|
|
1879
1853
|
parameters: {
|
|
1880
1854
|
query?: never;
|
|
@@ -1884,10 +1858,9 @@ interface paths {
|
|
|
1884
1858
|
};
|
|
1885
1859
|
/**
|
|
1886
1860
|
* Get Conversation Activity
|
|
1887
|
-
* @description The task's history, oldest first: when it started, went through each stage,
|
|
1861
|
+
* @description The task's history, oldest first: when it started, went through each stage, and who was notified.
|
|
1888
1862
|
*
|
|
1889
|
-
* Anyone who can see the conversation can read it
|
|
1890
|
-
* caller; who did what is shown by external id.
|
|
1863
|
+
* Anyone who can see the conversation can read it; who did what is shown by external id.
|
|
1891
1864
|
*/
|
|
1892
1865
|
get: operations['get_conversation_activity'];
|
|
1893
1866
|
put?: never;
|
|
@@ -1898,30 +1871,6 @@ interface paths {
|
|
|
1898
1871
|
patch?: never;
|
|
1899
1872
|
trace?: never;
|
|
1900
1873
|
};
|
|
1901
|
-
'/v1/conversation/{conversation_ext_id}/request-approval': {
|
|
1902
|
-
parameters: {
|
|
1903
|
-
query?: never;
|
|
1904
|
-
header?: never;
|
|
1905
|
-
path?: never;
|
|
1906
|
-
cookie?: never;
|
|
1907
|
-
};
|
|
1908
|
-
get?: never;
|
|
1909
|
-
put?: never;
|
|
1910
|
-
/**
|
|
1911
|
-
* Request Conversation Approval
|
|
1912
|
-
* @description Ask another person to approve this work item.
|
|
1913
|
-
*
|
|
1914
|
-
* Anyone who can edit it can pass it on (nobody can take a work item for themselves): the person asked
|
|
1915
|
-
* becomes its sign-off person and gets a ``conversation_approval_request`` notification, and only they (not
|
|
1916
|
-
* the person who asked) can approve it from then on. They can pass it on again the same way.
|
|
1917
|
-
*/
|
|
1918
|
-
post: operations['request_conversation_approval'];
|
|
1919
|
-
delete?: never;
|
|
1920
|
-
options?: never;
|
|
1921
|
-
head?: never;
|
|
1922
|
-
patch?: never;
|
|
1923
|
-
trace?: never;
|
|
1924
|
-
};
|
|
1925
1874
|
'/v1/conversation/{conversation_ext_id}/notify': {
|
|
1926
1875
|
parameters: {
|
|
1927
1876
|
query?: never;
|
|
@@ -1933,7 +1882,7 @@ interface paths {
|
|
|
1933
1882
|
put?: never;
|
|
1934
1883
|
/**
|
|
1935
1884
|
* Notify Collaborators
|
|
1936
|
-
* @description Notify workspace humans about this thread without
|
|
1885
|
+
* @description Notify workspace humans about this thread without changing its status.
|
|
1937
1886
|
*/
|
|
1938
1887
|
post: operations['notify_conversation_collaborators'];
|
|
1939
1888
|
delete?: never;
|
|
@@ -4346,7 +4295,7 @@ interface components {
|
|
|
4346
4295
|
* @description What happened to a task, in the order a person reads its history.
|
|
4347
4296
|
* @enum {string}
|
|
4348
4297
|
*/
|
|
4349
|
-
ActivityKind: 'created' | 'run_started' | 'awaiting_access' | 'access_granted' | '
|
|
4298
|
+
ActivityKind: 'created' | 'run_started' | 'awaiting_access' | 'access_granted' | 'done' | 'reopened' | 'failed' | 'participant_joined' | 'assistant_responded' | 'assistant_stopped' | 'artifact_created' | 'artifact_edited' | 'document_added' | 'document_removed' | 'notified';
|
|
4350
4299
|
/**
|
|
4351
4300
|
* ActivityResponse
|
|
4352
4301
|
* @description One entry of ``GET /v1/conversation/{id}/activity``.
|
|
@@ -4359,8 +4308,6 @@ interface components {
|
|
|
4359
4308
|
actor_ext_id?: string | null;
|
|
4360
4309
|
/** To Ext Id */
|
|
4361
4310
|
to_ext_id?: string | null;
|
|
4362
|
-
/** Note */
|
|
4363
|
-
note?: string | null;
|
|
4364
4311
|
/** Detail */
|
|
4365
4312
|
detail?: {
|
|
4366
4313
|
[key: string]: unknown;
|
|
@@ -6743,13 +6690,6 @@ interface components {
|
|
|
6743
6690
|
description?: string | null;
|
|
6744
6691
|
/** Due At */
|
|
6745
6692
|
due_at?: string | null;
|
|
6746
|
-
/** Signoff Ext Id */
|
|
6747
|
-
signoff_ext_id?: string | null;
|
|
6748
|
-
/**
|
|
6749
|
-
* Can Signoff
|
|
6750
|
-
* @default false
|
|
6751
|
-
*/
|
|
6752
|
-
can_signoff: boolean;
|
|
6753
6693
|
/** Completed At */
|
|
6754
6694
|
completed_at?: string | null;
|
|
6755
6695
|
/** Completed By Ext Id */
|
|
@@ -7152,8 +7092,6 @@ interface components {
|
|
|
7152
7092
|
description?: string | null;
|
|
7153
7093
|
/** Due At */
|
|
7154
7094
|
due_at?: string | null;
|
|
7155
|
-
/** Signoff User Ext Id */
|
|
7156
|
-
signoff_user_ext_id?: string | null;
|
|
7157
7095
|
/** Parent Conversation Ext Id */
|
|
7158
7096
|
parent_conversation_ext_id?: string | null;
|
|
7159
7097
|
/** Shared */
|
|
@@ -7232,8 +7170,6 @@ interface components {
|
|
|
7232
7170
|
agent_ext_id?: string | null;
|
|
7233
7171
|
/** @default run_now_temp */
|
|
7234
7172
|
auth_mode: components['schemas']['src__models__workflow__AuthMode'];
|
|
7235
|
-
/** Signoff User Ext Id */
|
|
7236
|
-
signoff_user_ext_id?: string | null;
|
|
7237
7173
|
};
|
|
7238
7174
|
/**
|
|
7239
7175
|
* DailyUsage
|
|
@@ -9783,7 +9719,7 @@ interface components {
|
|
|
9783
9719
|
* Type is self-descriptive, no need to parse content field.
|
|
9784
9720
|
* @enum {string}
|
|
9785
9721
|
*/
|
|
9786
|
-
NotificationType: 'user_message' | 'workspaceuser_added_owner' | 'workspaceuser_added_collaborator' | 'workspaceuser_added_guest' | 'workspaceuser_removed' | 'workspaceuser_updated_owner' | 'workspaceuser_updated_collaborator' | 'workspaceuser_updated_guest' | 'contact_accepted' | 'signup_reward' | 'referral_reward' | 'native_mail_received' | 'mail_draft_ready' | 'email_reply' | 'quota_threshold_50' | 'quota_threshold_90' | 'quota_threshold_100' | 'doc_shared' | 'docx_mention' | 'workspace_access_request' | '
|
|
9722
|
+
NotificationType: 'user_message' | 'workspaceuser_added_owner' | 'workspaceuser_added_collaborator' | 'workspaceuser_added_guest' | 'workspaceuser_removed' | 'workspaceuser_updated_owner' | 'workspaceuser_updated_collaborator' | 'workspaceuser_updated_guest' | 'contact_accepted' | 'signup_reward' | 'referral_reward' | 'native_mail_received' | 'mail_draft_ready' | 'email_reply' | 'quota_threshold_50' | 'quota_threshold_90' | 'quota_threshold_100' | 'doc_shared' | 'docx_mention' | 'workspace_access_request' | 'conversation_ready' | 'conversation_done' | 'conversation_notified' | 'workflow_failed' | 'agent_input_requested' | 'workflow_completed' | 'task_started' | 'task_completed' | 'mailbox_sync_complete' | 'drive_sync_complete' | 'activity' | 'mention';
|
|
9787
9723
|
/**
|
|
9788
9724
|
* NotificationUpdate
|
|
9789
9725
|
* @description Single notification update for bulk PATCH.
|
|
@@ -10760,24 +10696,6 @@ interface components {
|
|
|
10760
10696
|
/** Users */
|
|
10761
10697
|
users: components['schemas']['RemoveWorkspaceUserItem'][];
|
|
10762
10698
|
};
|
|
10763
|
-
/**
|
|
10764
|
-
* RequestApprovalRequest
|
|
10765
|
-
* @description Ask a person to approve a work item. They become its sign-off person and are notified.
|
|
10766
|
-
*/
|
|
10767
|
-
RequestApprovalRequest: {
|
|
10768
|
-
/** User Ext Id */
|
|
10769
|
-
user_ext_id: string;
|
|
10770
|
-
/**
|
|
10771
|
-
* Note
|
|
10772
|
-
* @default
|
|
10773
|
-
*/
|
|
10774
|
-
note: string;
|
|
10775
|
-
/**
|
|
10776
|
-
* Approve Current
|
|
10777
|
-
* @default false
|
|
10778
|
-
*/
|
|
10779
|
-
approve_current: boolean;
|
|
10780
|
-
};
|
|
10781
10699
|
/**
|
|
10782
10700
|
* RequestDeletionResponse
|
|
10783
10701
|
* @description Response for POST /v1/user/request-deletion.
|
|
@@ -11617,11 +11535,6 @@ interface components {
|
|
|
11617
11535
|
*/
|
|
11618
11536
|
HYBRID_SPARSE_WEIGHT: number;
|
|
11619
11537
|
};
|
|
11620
|
-
/**
|
|
11621
|
-
* ReviewAction
|
|
11622
|
-
* @enum {string}
|
|
11623
|
-
*/
|
|
11624
|
-
ReviewAction: 'approve' | 'request_changes';
|
|
11625
11538
|
/**
|
|
11626
11539
|
* ReviewLLMConfig
|
|
11627
11540
|
* @description Configuration for ReviewLLM - reviews agent draft answers against source material.
|
|
@@ -11681,18 +11594,6 @@ interface components {
|
|
|
11681
11594
|
*/
|
|
11682
11595
|
MAX_TOKEN_SIZE_TO_ANSWER: number;
|
|
11683
11596
|
};
|
|
11684
|
-
/**
|
|
11685
|
-
* ReviewWorkRequest
|
|
11686
|
-
* @description A human's verdict on prepared work (``ready_for_review``).
|
|
11687
|
-
*/
|
|
11688
|
-
ReviewWorkRequest: {
|
|
11689
|
-
action: components['schemas']['ReviewAction'];
|
|
11690
|
-
/**
|
|
11691
|
-
* Feedback
|
|
11692
|
-
* @default
|
|
11693
|
-
*/
|
|
11694
|
-
feedback: string;
|
|
11695
|
-
};
|
|
11696
11597
|
/**
|
|
11697
11598
|
* RunCodeConfig
|
|
11698
11599
|
* @description spawn_coding_agent sandbox tuning (developer-only — image/network/limits are infra,
|
|
@@ -12538,7 +12439,7 @@ interface components {
|
|
|
12538
12439
|
* @description Make the conversation an assistant query starts a task: ``POST /v1/assistant/query`` with ``task`` set.
|
|
12539
12440
|
*
|
|
12540
12441
|
* The query IS the run (as the person asking, with their own access). The conversation gets a status of
|
|
12541
|
-
* ``generating`` while the assistant works and ``
|
|
12442
|
+
* ``generating`` while the assistant works and ``todo`` again when it finishes; every field here is optional.
|
|
12542
12443
|
* Only read when the query starts a conversation (or a conversation that is not a task yet).
|
|
12543
12444
|
*/
|
|
12544
12445
|
TaskOptions: {
|
|
@@ -12548,8 +12449,6 @@ interface components {
|
|
|
12548
12449
|
description?: string | null;
|
|
12549
12450
|
/** Due At */
|
|
12550
12451
|
due_at?: string | null;
|
|
12551
|
-
/** Signoff User Ext Id */
|
|
12552
|
-
signoff_user_ext_id?: string | null;
|
|
12553
12452
|
/** Parent Conversation Ext Id */
|
|
12554
12453
|
parent_conversation_ext_id?: string | null;
|
|
12555
12454
|
/** Shared */
|
|
@@ -12558,7 +12457,7 @@ interface components {
|
|
|
12558
12457
|
};
|
|
12559
12458
|
/**
|
|
12560
12459
|
* TaskPlan
|
|
12561
|
-
* @description The
|
|
12460
|
+
* @description The editable definition-of-done for a goal run.
|
|
12562
12461
|
*
|
|
12563
12462
|
* Authored by ``POST /v1/conversation/work/plan`` (or hand-written), user-editable, stored
|
|
12564
12463
|
* (encrypted) on ``Convos.plan``, and consumed at execution to (a) seed the intra-turn ``/goal``
|
|
@@ -12898,8 +12797,6 @@ interface components {
|
|
|
12898
12797
|
description?: string | null;
|
|
12899
12798
|
/** Due At */
|
|
12900
12799
|
due_at?: string | null;
|
|
12901
|
-
/** Signoff User Ext Id */
|
|
12902
|
-
signoff_user_ext_id?: string | null;
|
|
12903
12800
|
/** Parent Conversation Ext Id */
|
|
12904
12801
|
parent_conversation_ext_id?: string | null;
|
|
12905
12802
|
/** Status */
|
|
@@ -13005,7 +12902,7 @@ interface components {
|
|
|
13005
12902
|
/**
|
|
13006
12903
|
* UpdateWorkflowRequest
|
|
13007
12904
|
* @description Every field optional. Sending any trigger field replaces the whole trigger: exactly one of the four
|
|
13008
|
-
* must then be non-null (the others are cleared). ``agent_ext_id
|
|
12905
|
+
* must then be non-null (the others are cleared). ``agent_ext_id`` null clears.
|
|
13009
12906
|
*/
|
|
13010
12907
|
UpdateWorkflowRequest: {
|
|
13011
12908
|
/** Name */
|
|
@@ -13045,8 +12942,6 @@ interface components {
|
|
|
13045
12942
|
/** Agent Ext Id */
|
|
13046
12943
|
agent_ext_id?: string | null;
|
|
13047
12944
|
auth_mode?: components['schemas']['src__models__workflow__AuthMode'] | null;
|
|
13048
|
-
/** Signoff User Ext Id */
|
|
13049
|
-
signoff_user_ext_id?: string | null;
|
|
13050
12945
|
};
|
|
13051
12946
|
/**
|
|
13052
12947
|
* UpdateWorkspaceUserRolesRequest
|
|
@@ -13752,19 +13647,18 @@ interface components {
|
|
|
13752
13647
|
};
|
|
13753
13648
|
/**
|
|
13754
13649
|
* WorkStatus
|
|
13755
|
-
* @description Where a work conversation is
|
|
13756
|
-
*
|
|
13650
|
+
* @description Where a work conversation is. Agents do the work; **only a human marks it ``done``** (anyone
|
|
13651
|
+
* who can edit it; enforced in the router, never by the runner).
|
|
13757
13652
|
*
|
|
13758
|
-
* ``todo``
|
|
13759
|
-
*
|
|
13760
|
-
* ``
|
|
13761
|
-
* ``done``
|
|
13653
|
+
* ``todo`` — open: nothing automated pending; a person (or Run) moves it on. A finished run
|
|
13654
|
+
* leaves it here.
|
|
13655
|
+
* ``generating`` — an agent run is in flight (``active_run_id`` is set).
|
|
13656
|
+
* ``done`` — a person marked it complete.
|
|
13762
13657
|
*
|
|
13763
|
-
* Only ``todo`` and ``done`` can be set by a client (PATCH). ``generating``
|
|
13764
|
-
* ``ready_for_review`` are set only by runs and by review.
|
|
13658
|
+
* Only ``todo`` and ``done`` can be set by a client (PATCH). ``generating`` is set only by runs.
|
|
13765
13659
|
* @enum {string}
|
|
13766
13660
|
*/
|
|
13767
|
-
WorkStatus: 'todo' | 'generating' | '
|
|
13661
|
+
WorkStatus: 'todo' | 'generating' | 'done';
|
|
13768
13662
|
/** WorkflowResponse */
|
|
13769
13663
|
WorkflowResponse: {
|
|
13770
13664
|
/** External Id */
|
|
@@ -13822,8 +13716,6 @@ interface components {
|
|
|
13822
13716
|
/** Agent Ext Id */
|
|
13823
13717
|
agent_ext_id?: string | null;
|
|
13824
13718
|
auth_mode: components['schemas']['src__models__workflow__AuthMode'];
|
|
13825
|
-
/** Signoff Ext Id */
|
|
13826
|
-
signoff_ext_id?: string | null;
|
|
13827
13719
|
/** Fact Ext Id */
|
|
13828
13720
|
fact_ext_id?: string | null;
|
|
13829
13721
|
/** Last Fired At */
|
|
@@ -14116,7 +14008,7 @@ interface components {
|
|
|
14116
14008
|
* NOTE: the same concept as ``src.models.work.AuthMode`` (work-core); the names and values are identical so
|
|
14117
14009
|
* the two can be deduplicated.
|
|
14118
14010
|
*
|
|
14119
|
-
* ``run_now_temp`` (default) — a person is present (Run
|
|
14011
|
+
* ``run_now_temp`` (default) — a person is present (Run): the run session is granted
|
|
14120
14012
|
* from their own workspace key. No standing membership.
|
|
14121
14013
|
* ``scheduled_require_auth`` — an unattended run parks (``pending_auth_request_id`` + a
|
|
14122
14014
|
* ``workspace_access_request`` notification) until the owner grants a key.
|
|
@@ -16884,41 +16776,6 @@ interface operations {
|
|
|
16884
16776
|
};
|
|
16885
16777
|
};
|
|
16886
16778
|
};
|
|
16887
|
-
review_conversation: {
|
|
16888
|
-
parameters: {
|
|
16889
|
-
query?: never;
|
|
16890
|
-
header?: never;
|
|
16891
|
-
path: {
|
|
16892
|
-
conversation_ext_id: string;
|
|
16893
|
-
};
|
|
16894
|
-
cookie?: never;
|
|
16895
|
-
};
|
|
16896
|
-
requestBody: {
|
|
16897
|
-
content: {
|
|
16898
|
-
'application/json': components['schemas']['ReviewWorkRequest'];
|
|
16899
|
-
};
|
|
16900
|
-
};
|
|
16901
|
-
responses: {
|
|
16902
|
-
/** @description Successful Response */
|
|
16903
|
-
200: {
|
|
16904
|
-
headers: {
|
|
16905
|
-
[name: string]: unknown;
|
|
16906
|
-
};
|
|
16907
|
-
content: {
|
|
16908
|
-
'application/json': components['schemas']['ConversationResponse'];
|
|
16909
|
-
};
|
|
16910
|
-
};
|
|
16911
|
-
/** @description Validation Error */
|
|
16912
|
-
422: {
|
|
16913
|
-
headers: {
|
|
16914
|
-
[name: string]: unknown;
|
|
16915
|
-
};
|
|
16916
|
-
content: {
|
|
16917
|
-
'application/json': components['schemas']['HTTPValidationError'];
|
|
16918
|
-
};
|
|
16919
|
-
};
|
|
16920
|
-
};
|
|
16921
|
-
};
|
|
16922
16779
|
get_conversation_activity: {
|
|
16923
16780
|
parameters: {
|
|
16924
16781
|
query?: never;
|
|
@@ -16950,41 +16807,6 @@ interface operations {
|
|
|
16950
16807
|
};
|
|
16951
16808
|
};
|
|
16952
16809
|
};
|
|
16953
|
-
request_conversation_approval: {
|
|
16954
|
-
parameters: {
|
|
16955
|
-
query?: never;
|
|
16956
|
-
header?: never;
|
|
16957
|
-
path: {
|
|
16958
|
-
conversation_ext_id: string;
|
|
16959
|
-
};
|
|
16960
|
-
cookie?: never;
|
|
16961
|
-
};
|
|
16962
|
-
requestBody: {
|
|
16963
|
-
content: {
|
|
16964
|
-
'application/json': components['schemas']['RequestApprovalRequest'];
|
|
16965
|
-
};
|
|
16966
|
-
};
|
|
16967
|
-
responses: {
|
|
16968
|
-
/** @description Successful Response */
|
|
16969
|
-
200: {
|
|
16970
|
-
headers: {
|
|
16971
|
-
[name: string]: unknown;
|
|
16972
|
-
};
|
|
16973
|
-
content: {
|
|
16974
|
-
'application/json': components['schemas']['ConversationResponse'];
|
|
16975
|
-
};
|
|
16976
|
-
};
|
|
16977
|
-
/** @description Validation Error */
|
|
16978
|
-
422: {
|
|
16979
|
-
headers: {
|
|
16980
|
-
[name: string]: unknown;
|
|
16981
|
-
};
|
|
16982
|
-
content: {
|
|
16983
|
-
'application/json': components['schemas']['HTTPValidationError'];
|
|
16984
|
-
};
|
|
16985
|
-
};
|
|
16986
|
-
};
|
|
16987
|
-
};
|
|
16988
16810
|
notify_conversation_collaborators: {
|
|
16989
16811
|
parameters: {
|
|
16990
16812
|
query?: never;
|
package/dist/index.d.ts
CHANGED
|
@@ -1713,10 +1713,9 @@ interface paths {
|
|
|
1713
1713
|
*
|
|
1714
1714
|
* * ``shared`` — its creator only (a row nobody else can see cannot be written by them): nobody else decides.
|
|
1715
1715
|
* * everything else — the owner, or a collaborator of the workspace on a shared item.
|
|
1716
|
-
* * ``status`` — ``todo`` or ``done`` only. ``done`` is human-only (
|
|
1717
|
-
* ``generating``
|
|
1716
|
+
* * ``status`` — ``todo`` or ``done`` only. ``done`` is human-only (anyone who can edit it); ``todo`` reopens.
|
|
1717
|
+
* ``generating`` is set only by runs.
|
|
1718
1718
|
* * ``parent_conversation_ext_id`` — cycle-checked; ``null`` detaches.
|
|
1719
|
-
* * ``signoff_user_ext_id`` — a human who can edit the workspace; ``null`` falls back to the owner.
|
|
1720
1719
|
*/
|
|
1721
1720
|
patch: operations['update_conversation'];
|
|
1722
1721
|
trace?: never;
|
|
@@ -1812,7 +1811,7 @@ interface paths {
|
|
|
1812
1811
|
put?: never;
|
|
1813
1812
|
/**
|
|
1814
1813
|
* Plan Work
|
|
1815
|
-
* @description Draft
|
|
1814
|
+
* @description Draft an editable ``TaskPlan`` for the active workspace from a plain objective.
|
|
1816
1815
|
*
|
|
1817
1816
|
* The unified planner (``filter_and_plan`` → ``author_checklist``): formulates the goal, proposes the doc
|
|
1818
1817
|
* set, and authors the acceptance criteria. Stateless — the caller attaches the returned plan to a create
|
|
@@ -1850,31 +1849,6 @@ interface paths {
|
|
|
1850
1849
|
patch?: never;
|
|
1851
1850
|
trace?: never;
|
|
1852
1851
|
};
|
|
1853
|
-
'/v1/conversation/{conversation_ext_id}/review': {
|
|
1854
|
-
parameters: {
|
|
1855
|
-
query?: never;
|
|
1856
|
-
header?: never;
|
|
1857
|
-
path?: never;
|
|
1858
|
-
cookie?: never;
|
|
1859
|
-
};
|
|
1860
|
-
get?: never;
|
|
1861
|
-
put?: never;
|
|
1862
|
-
/**
|
|
1863
|
-
* Review Conversation
|
|
1864
|
-
* @description A person's verdict on prepared work (``ready_for_review``). Never an agent.
|
|
1865
|
-
*
|
|
1866
|
-
* ``approve`` (sign-off person only) marks it done and emits ``conversation_done`` so workflows waiting
|
|
1867
|
-
* on it can start.
|
|
1868
|
-
* ``request_changes`` sends ``feedback`` back to the agent as the next turn of the SAME thread and the
|
|
1869
|
-
* status goes back to ``generating``.
|
|
1870
|
-
*/
|
|
1871
|
-
post: operations['review_conversation'];
|
|
1872
|
-
delete?: never;
|
|
1873
|
-
options?: never;
|
|
1874
|
-
head?: never;
|
|
1875
|
-
patch?: never;
|
|
1876
|
-
trace?: never;
|
|
1877
|
-
};
|
|
1878
1852
|
'/v1/conversation/{conversation_ext_id}/activity': {
|
|
1879
1853
|
parameters: {
|
|
1880
1854
|
query?: never;
|
|
@@ -1884,10 +1858,9 @@ interface paths {
|
|
|
1884
1858
|
};
|
|
1885
1859
|
/**
|
|
1886
1860
|
* Get Conversation Activity
|
|
1887
|
-
* @description The task's history, oldest first: when it started, went through each stage,
|
|
1861
|
+
* @description The task's history, oldest first: when it started, went through each stage, and who was notified.
|
|
1888
1862
|
*
|
|
1889
|
-
* Anyone who can see the conversation can read it
|
|
1890
|
-
* caller; who did what is shown by external id.
|
|
1863
|
+
* Anyone who can see the conversation can read it; who did what is shown by external id.
|
|
1891
1864
|
*/
|
|
1892
1865
|
get: operations['get_conversation_activity'];
|
|
1893
1866
|
put?: never;
|
|
@@ -1898,30 +1871,6 @@ interface paths {
|
|
|
1898
1871
|
patch?: never;
|
|
1899
1872
|
trace?: never;
|
|
1900
1873
|
};
|
|
1901
|
-
'/v1/conversation/{conversation_ext_id}/request-approval': {
|
|
1902
|
-
parameters: {
|
|
1903
|
-
query?: never;
|
|
1904
|
-
header?: never;
|
|
1905
|
-
path?: never;
|
|
1906
|
-
cookie?: never;
|
|
1907
|
-
};
|
|
1908
|
-
get?: never;
|
|
1909
|
-
put?: never;
|
|
1910
|
-
/**
|
|
1911
|
-
* Request Conversation Approval
|
|
1912
|
-
* @description Ask another person to approve this work item.
|
|
1913
|
-
*
|
|
1914
|
-
* Anyone who can edit it can pass it on (nobody can take a work item for themselves): the person asked
|
|
1915
|
-
* becomes its sign-off person and gets a ``conversation_approval_request`` notification, and only they (not
|
|
1916
|
-
* the person who asked) can approve it from then on. They can pass it on again the same way.
|
|
1917
|
-
*/
|
|
1918
|
-
post: operations['request_conversation_approval'];
|
|
1919
|
-
delete?: never;
|
|
1920
|
-
options?: never;
|
|
1921
|
-
head?: never;
|
|
1922
|
-
patch?: never;
|
|
1923
|
-
trace?: never;
|
|
1924
|
-
};
|
|
1925
1874
|
'/v1/conversation/{conversation_ext_id}/notify': {
|
|
1926
1875
|
parameters: {
|
|
1927
1876
|
query?: never;
|
|
@@ -1933,7 +1882,7 @@ interface paths {
|
|
|
1933
1882
|
put?: never;
|
|
1934
1883
|
/**
|
|
1935
1884
|
* Notify Collaborators
|
|
1936
|
-
* @description Notify workspace humans about this thread without
|
|
1885
|
+
* @description Notify workspace humans about this thread without changing its status.
|
|
1937
1886
|
*/
|
|
1938
1887
|
post: operations['notify_conversation_collaborators'];
|
|
1939
1888
|
delete?: never;
|
|
@@ -4346,7 +4295,7 @@ interface components {
|
|
|
4346
4295
|
* @description What happened to a task, in the order a person reads its history.
|
|
4347
4296
|
* @enum {string}
|
|
4348
4297
|
*/
|
|
4349
|
-
ActivityKind: 'created' | 'run_started' | 'awaiting_access' | 'access_granted' | '
|
|
4298
|
+
ActivityKind: 'created' | 'run_started' | 'awaiting_access' | 'access_granted' | 'done' | 'reopened' | 'failed' | 'participant_joined' | 'assistant_responded' | 'assistant_stopped' | 'artifact_created' | 'artifact_edited' | 'document_added' | 'document_removed' | 'notified';
|
|
4350
4299
|
/**
|
|
4351
4300
|
* ActivityResponse
|
|
4352
4301
|
* @description One entry of ``GET /v1/conversation/{id}/activity``.
|
|
@@ -4359,8 +4308,6 @@ interface components {
|
|
|
4359
4308
|
actor_ext_id?: string | null;
|
|
4360
4309
|
/** To Ext Id */
|
|
4361
4310
|
to_ext_id?: string | null;
|
|
4362
|
-
/** Note */
|
|
4363
|
-
note?: string | null;
|
|
4364
4311
|
/** Detail */
|
|
4365
4312
|
detail?: {
|
|
4366
4313
|
[key: string]: unknown;
|
|
@@ -6743,13 +6690,6 @@ interface components {
|
|
|
6743
6690
|
description?: string | null;
|
|
6744
6691
|
/** Due At */
|
|
6745
6692
|
due_at?: string | null;
|
|
6746
|
-
/** Signoff Ext Id */
|
|
6747
|
-
signoff_ext_id?: string | null;
|
|
6748
|
-
/**
|
|
6749
|
-
* Can Signoff
|
|
6750
|
-
* @default false
|
|
6751
|
-
*/
|
|
6752
|
-
can_signoff: boolean;
|
|
6753
6693
|
/** Completed At */
|
|
6754
6694
|
completed_at?: string | null;
|
|
6755
6695
|
/** Completed By Ext Id */
|
|
@@ -7152,8 +7092,6 @@ interface components {
|
|
|
7152
7092
|
description?: string | null;
|
|
7153
7093
|
/** Due At */
|
|
7154
7094
|
due_at?: string | null;
|
|
7155
|
-
/** Signoff User Ext Id */
|
|
7156
|
-
signoff_user_ext_id?: string | null;
|
|
7157
7095
|
/** Parent Conversation Ext Id */
|
|
7158
7096
|
parent_conversation_ext_id?: string | null;
|
|
7159
7097
|
/** Shared */
|
|
@@ -7232,8 +7170,6 @@ interface components {
|
|
|
7232
7170
|
agent_ext_id?: string | null;
|
|
7233
7171
|
/** @default run_now_temp */
|
|
7234
7172
|
auth_mode: components['schemas']['src__models__workflow__AuthMode'];
|
|
7235
|
-
/** Signoff User Ext Id */
|
|
7236
|
-
signoff_user_ext_id?: string | null;
|
|
7237
7173
|
};
|
|
7238
7174
|
/**
|
|
7239
7175
|
* DailyUsage
|
|
@@ -9783,7 +9719,7 @@ interface components {
|
|
|
9783
9719
|
* Type is self-descriptive, no need to parse content field.
|
|
9784
9720
|
* @enum {string}
|
|
9785
9721
|
*/
|
|
9786
|
-
NotificationType: 'user_message' | 'workspaceuser_added_owner' | 'workspaceuser_added_collaborator' | 'workspaceuser_added_guest' | 'workspaceuser_removed' | 'workspaceuser_updated_owner' | 'workspaceuser_updated_collaborator' | 'workspaceuser_updated_guest' | 'contact_accepted' | 'signup_reward' | 'referral_reward' | 'native_mail_received' | 'mail_draft_ready' | 'email_reply' | 'quota_threshold_50' | 'quota_threshold_90' | 'quota_threshold_100' | 'doc_shared' | 'docx_mention' | 'workspace_access_request' | '
|
|
9722
|
+
NotificationType: 'user_message' | 'workspaceuser_added_owner' | 'workspaceuser_added_collaborator' | 'workspaceuser_added_guest' | 'workspaceuser_removed' | 'workspaceuser_updated_owner' | 'workspaceuser_updated_collaborator' | 'workspaceuser_updated_guest' | 'contact_accepted' | 'signup_reward' | 'referral_reward' | 'native_mail_received' | 'mail_draft_ready' | 'email_reply' | 'quota_threshold_50' | 'quota_threshold_90' | 'quota_threshold_100' | 'doc_shared' | 'docx_mention' | 'workspace_access_request' | 'conversation_ready' | 'conversation_done' | 'conversation_notified' | 'workflow_failed' | 'agent_input_requested' | 'workflow_completed' | 'task_started' | 'task_completed' | 'mailbox_sync_complete' | 'drive_sync_complete' | 'activity' | 'mention';
|
|
9787
9723
|
/**
|
|
9788
9724
|
* NotificationUpdate
|
|
9789
9725
|
* @description Single notification update for bulk PATCH.
|
|
@@ -10760,24 +10696,6 @@ interface components {
|
|
|
10760
10696
|
/** Users */
|
|
10761
10697
|
users: components['schemas']['RemoveWorkspaceUserItem'][];
|
|
10762
10698
|
};
|
|
10763
|
-
/**
|
|
10764
|
-
* RequestApprovalRequest
|
|
10765
|
-
* @description Ask a person to approve a work item. They become its sign-off person and are notified.
|
|
10766
|
-
*/
|
|
10767
|
-
RequestApprovalRequest: {
|
|
10768
|
-
/** User Ext Id */
|
|
10769
|
-
user_ext_id: string;
|
|
10770
|
-
/**
|
|
10771
|
-
* Note
|
|
10772
|
-
* @default
|
|
10773
|
-
*/
|
|
10774
|
-
note: string;
|
|
10775
|
-
/**
|
|
10776
|
-
* Approve Current
|
|
10777
|
-
* @default false
|
|
10778
|
-
*/
|
|
10779
|
-
approve_current: boolean;
|
|
10780
|
-
};
|
|
10781
10699
|
/**
|
|
10782
10700
|
* RequestDeletionResponse
|
|
10783
10701
|
* @description Response for POST /v1/user/request-deletion.
|
|
@@ -11617,11 +11535,6 @@ interface components {
|
|
|
11617
11535
|
*/
|
|
11618
11536
|
HYBRID_SPARSE_WEIGHT: number;
|
|
11619
11537
|
};
|
|
11620
|
-
/**
|
|
11621
|
-
* ReviewAction
|
|
11622
|
-
* @enum {string}
|
|
11623
|
-
*/
|
|
11624
|
-
ReviewAction: 'approve' | 'request_changes';
|
|
11625
11538
|
/**
|
|
11626
11539
|
* ReviewLLMConfig
|
|
11627
11540
|
* @description Configuration for ReviewLLM - reviews agent draft answers against source material.
|
|
@@ -11681,18 +11594,6 @@ interface components {
|
|
|
11681
11594
|
*/
|
|
11682
11595
|
MAX_TOKEN_SIZE_TO_ANSWER: number;
|
|
11683
11596
|
};
|
|
11684
|
-
/**
|
|
11685
|
-
* ReviewWorkRequest
|
|
11686
|
-
* @description A human's verdict on prepared work (``ready_for_review``).
|
|
11687
|
-
*/
|
|
11688
|
-
ReviewWorkRequest: {
|
|
11689
|
-
action: components['schemas']['ReviewAction'];
|
|
11690
|
-
/**
|
|
11691
|
-
* Feedback
|
|
11692
|
-
* @default
|
|
11693
|
-
*/
|
|
11694
|
-
feedback: string;
|
|
11695
|
-
};
|
|
11696
11597
|
/**
|
|
11697
11598
|
* RunCodeConfig
|
|
11698
11599
|
* @description spawn_coding_agent sandbox tuning (developer-only — image/network/limits are infra,
|
|
@@ -12538,7 +12439,7 @@ interface components {
|
|
|
12538
12439
|
* @description Make the conversation an assistant query starts a task: ``POST /v1/assistant/query`` with ``task`` set.
|
|
12539
12440
|
*
|
|
12540
12441
|
* The query IS the run (as the person asking, with their own access). The conversation gets a status of
|
|
12541
|
-
* ``generating`` while the assistant works and ``
|
|
12442
|
+
* ``generating`` while the assistant works and ``todo`` again when it finishes; every field here is optional.
|
|
12542
12443
|
* Only read when the query starts a conversation (or a conversation that is not a task yet).
|
|
12543
12444
|
*/
|
|
12544
12445
|
TaskOptions: {
|
|
@@ -12548,8 +12449,6 @@ interface components {
|
|
|
12548
12449
|
description?: string | null;
|
|
12549
12450
|
/** Due At */
|
|
12550
12451
|
due_at?: string | null;
|
|
12551
|
-
/** Signoff User Ext Id */
|
|
12552
|
-
signoff_user_ext_id?: string | null;
|
|
12553
12452
|
/** Parent Conversation Ext Id */
|
|
12554
12453
|
parent_conversation_ext_id?: string | null;
|
|
12555
12454
|
/** Shared */
|
|
@@ -12558,7 +12457,7 @@ interface components {
|
|
|
12558
12457
|
};
|
|
12559
12458
|
/**
|
|
12560
12459
|
* TaskPlan
|
|
12561
|
-
* @description The
|
|
12460
|
+
* @description The editable definition-of-done for a goal run.
|
|
12562
12461
|
*
|
|
12563
12462
|
* Authored by ``POST /v1/conversation/work/plan`` (or hand-written), user-editable, stored
|
|
12564
12463
|
* (encrypted) on ``Convos.plan``, and consumed at execution to (a) seed the intra-turn ``/goal``
|
|
@@ -12898,8 +12797,6 @@ interface components {
|
|
|
12898
12797
|
description?: string | null;
|
|
12899
12798
|
/** Due At */
|
|
12900
12799
|
due_at?: string | null;
|
|
12901
|
-
/** Signoff User Ext Id */
|
|
12902
|
-
signoff_user_ext_id?: string | null;
|
|
12903
12800
|
/** Parent Conversation Ext Id */
|
|
12904
12801
|
parent_conversation_ext_id?: string | null;
|
|
12905
12802
|
/** Status */
|
|
@@ -13005,7 +12902,7 @@ interface components {
|
|
|
13005
12902
|
/**
|
|
13006
12903
|
* UpdateWorkflowRequest
|
|
13007
12904
|
* @description Every field optional. Sending any trigger field replaces the whole trigger: exactly one of the four
|
|
13008
|
-
* must then be non-null (the others are cleared). ``agent_ext_id
|
|
12905
|
+
* must then be non-null (the others are cleared). ``agent_ext_id`` null clears.
|
|
13009
12906
|
*/
|
|
13010
12907
|
UpdateWorkflowRequest: {
|
|
13011
12908
|
/** Name */
|
|
@@ -13045,8 +12942,6 @@ interface components {
|
|
|
13045
12942
|
/** Agent Ext Id */
|
|
13046
12943
|
agent_ext_id?: string | null;
|
|
13047
12944
|
auth_mode?: components['schemas']['src__models__workflow__AuthMode'] | null;
|
|
13048
|
-
/** Signoff User Ext Id */
|
|
13049
|
-
signoff_user_ext_id?: string | null;
|
|
13050
12945
|
};
|
|
13051
12946
|
/**
|
|
13052
12947
|
* UpdateWorkspaceUserRolesRequest
|
|
@@ -13752,19 +13647,18 @@ interface components {
|
|
|
13752
13647
|
};
|
|
13753
13648
|
/**
|
|
13754
13649
|
* WorkStatus
|
|
13755
|
-
* @description Where a work conversation is
|
|
13756
|
-
*
|
|
13650
|
+
* @description Where a work conversation is. Agents do the work; **only a human marks it ``done``** (anyone
|
|
13651
|
+
* who can edit it; enforced in the router, never by the runner).
|
|
13757
13652
|
*
|
|
13758
|
-
* ``todo``
|
|
13759
|
-
*
|
|
13760
|
-
* ``
|
|
13761
|
-
* ``done``
|
|
13653
|
+
* ``todo`` — open: nothing automated pending; a person (or Run) moves it on. A finished run
|
|
13654
|
+
* leaves it here.
|
|
13655
|
+
* ``generating`` — an agent run is in flight (``active_run_id`` is set).
|
|
13656
|
+
* ``done`` — a person marked it complete.
|
|
13762
13657
|
*
|
|
13763
|
-
* Only ``todo`` and ``done`` can be set by a client (PATCH). ``generating``
|
|
13764
|
-
* ``ready_for_review`` are set only by runs and by review.
|
|
13658
|
+
* Only ``todo`` and ``done`` can be set by a client (PATCH). ``generating`` is set only by runs.
|
|
13765
13659
|
* @enum {string}
|
|
13766
13660
|
*/
|
|
13767
|
-
WorkStatus: 'todo' | 'generating' | '
|
|
13661
|
+
WorkStatus: 'todo' | 'generating' | 'done';
|
|
13768
13662
|
/** WorkflowResponse */
|
|
13769
13663
|
WorkflowResponse: {
|
|
13770
13664
|
/** External Id */
|
|
@@ -13822,8 +13716,6 @@ interface components {
|
|
|
13822
13716
|
/** Agent Ext Id */
|
|
13823
13717
|
agent_ext_id?: string | null;
|
|
13824
13718
|
auth_mode: components['schemas']['src__models__workflow__AuthMode'];
|
|
13825
|
-
/** Signoff Ext Id */
|
|
13826
|
-
signoff_ext_id?: string | null;
|
|
13827
13719
|
/** Fact Ext Id */
|
|
13828
13720
|
fact_ext_id?: string | null;
|
|
13829
13721
|
/** Last Fired At */
|
|
@@ -14116,7 +14008,7 @@ interface components {
|
|
|
14116
14008
|
* NOTE: the same concept as ``src.models.work.AuthMode`` (work-core); the names and values are identical so
|
|
14117
14009
|
* the two can be deduplicated.
|
|
14118
14010
|
*
|
|
14119
|
-
* ``run_now_temp`` (default) — a person is present (Run
|
|
14011
|
+
* ``run_now_temp`` (default) — a person is present (Run): the run session is granted
|
|
14120
14012
|
* from their own workspace key. No standing membership.
|
|
14121
14013
|
* ``scheduled_require_auth`` — an unattended run parks (``pending_auth_request_id`` + a
|
|
14122
14014
|
* ``workspace_access_request`` notification) until the owner grants a key.
|
|
@@ -16884,41 +16776,6 @@ interface operations {
|
|
|
16884
16776
|
};
|
|
16885
16777
|
};
|
|
16886
16778
|
};
|
|
16887
|
-
review_conversation: {
|
|
16888
|
-
parameters: {
|
|
16889
|
-
query?: never;
|
|
16890
|
-
header?: never;
|
|
16891
|
-
path: {
|
|
16892
|
-
conversation_ext_id: string;
|
|
16893
|
-
};
|
|
16894
|
-
cookie?: never;
|
|
16895
|
-
};
|
|
16896
|
-
requestBody: {
|
|
16897
|
-
content: {
|
|
16898
|
-
'application/json': components['schemas']['ReviewWorkRequest'];
|
|
16899
|
-
};
|
|
16900
|
-
};
|
|
16901
|
-
responses: {
|
|
16902
|
-
/** @description Successful Response */
|
|
16903
|
-
200: {
|
|
16904
|
-
headers: {
|
|
16905
|
-
[name: string]: unknown;
|
|
16906
|
-
};
|
|
16907
|
-
content: {
|
|
16908
|
-
'application/json': components['schemas']['ConversationResponse'];
|
|
16909
|
-
};
|
|
16910
|
-
};
|
|
16911
|
-
/** @description Validation Error */
|
|
16912
|
-
422: {
|
|
16913
|
-
headers: {
|
|
16914
|
-
[name: string]: unknown;
|
|
16915
|
-
};
|
|
16916
|
-
content: {
|
|
16917
|
-
'application/json': components['schemas']['HTTPValidationError'];
|
|
16918
|
-
};
|
|
16919
|
-
};
|
|
16920
|
-
};
|
|
16921
|
-
};
|
|
16922
16779
|
get_conversation_activity: {
|
|
16923
16780
|
parameters: {
|
|
16924
16781
|
query?: never;
|
|
@@ -16950,41 +16807,6 @@ interface operations {
|
|
|
16950
16807
|
};
|
|
16951
16808
|
};
|
|
16952
16809
|
};
|
|
16953
|
-
request_conversation_approval: {
|
|
16954
|
-
parameters: {
|
|
16955
|
-
query?: never;
|
|
16956
|
-
header?: never;
|
|
16957
|
-
path: {
|
|
16958
|
-
conversation_ext_id: string;
|
|
16959
|
-
};
|
|
16960
|
-
cookie?: never;
|
|
16961
|
-
};
|
|
16962
|
-
requestBody: {
|
|
16963
|
-
content: {
|
|
16964
|
-
'application/json': components['schemas']['RequestApprovalRequest'];
|
|
16965
|
-
};
|
|
16966
|
-
};
|
|
16967
|
-
responses: {
|
|
16968
|
-
/** @description Successful Response */
|
|
16969
|
-
200: {
|
|
16970
|
-
headers: {
|
|
16971
|
-
[name: string]: unknown;
|
|
16972
|
-
};
|
|
16973
|
-
content: {
|
|
16974
|
-
'application/json': components['schemas']['ConversationResponse'];
|
|
16975
|
-
};
|
|
16976
|
-
};
|
|
16977
|
-
/** @description Validation Error */
|
|
16978
|
-
422: {
|
|
16979
|
-
headers: {
|
|
16980
|
-
[name: string]: unknown;
|
|
16981
|
-
};
|
|
16982
|
-
content: {
|
|
16983
|
-
'application/json': components['schemas']['HTTPValidationError'];
|
|
16984
|
-
};
|
|
16985
|
-
};
|
|
16986
|
-
};
|
|
16987
|
-
};
|
|
16988
16810
|
notify_conversation_collaborators: {
|
|
16989
16811
|
parameters: {
|
|
16990
16812
|
query?: never;
|