@arbidocs/client 0.4.61 → 0.4.63
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 +1129 -463
- package/dist/index.d.ts +1129 -463
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -919,7 +919,10 @@ interface paths {
|
|
|
919
919
|
* along:
|
|
920
920
|
*
|
|
921
921
|
* - ``doc-`` document — row + MinIO files + Qdrant vectors, all re-encrypted
|
|
922
|
-
* with the target workspace key
|
|
922
|
+
* with the target workspace key, for EVERY version of the document (any
|
|
923
|
+
* version's id names it; the copy of the current one is current in the
|
|
924
|
+
* target). Chunk external IDs are preserved; email-family and provenance
|
|
925
|
+
* links between copied documents are kept.
|
|
923
926
|
* - ``tag-`` tag — merged into a same-named tag already in the target if there
|
|
924
927
|
* is one, otherwise created. A parent tag that is not in the target flattens
|
|
925
928
|
* the copy to a root tag.
|
|
@@ -929,7 +932,11 @@ interface paths {
|
|
|
929
932
|
* - ``fct-`` fact — content, date span, timezone and citations preserved; pins
|
|
930
933
|
* are not (a pin is the pinning account's own state).
|
|
931
934
|
* - ``con-`` chat — conversation + every message, with the parent/child tree
|
|
932
|
-
* and the encrypted ``tools`` blob rebuilt.
|
|
935
|
+
* and the encrypted ``tools`` blob rebuilt; a task keeps its definition.
|
|
936
|
+
* - ``wfl-`` automation — copied paused.
|
|
937
|
+
*
|
|
938
|
+
* For a scoped, resumable copy or move that brings dependencies along, use
|
|
939
|
+
* ``POST /v1/workspace/transfer`` instead.
|
|
933
940
|
*
|
|
934
941
|
* Facts and chats need no vector copy: both live in pointer-only collections
|
|
935
942
|
* keyed by external ID and are indexed on write / by the lazy backfill.
|
|
@@ -976,6 +983,169 @@ interface paths {
|
|
|
976
983
|
patch: operations['update_workspace'];
|
|
977
984
|
trace?: never;
|
|
978
985
|
};
|
|
986
|
+
'/v1/workspace/transfer/plan': {
|
|
987
|
+
parameters: {
|
|
988
|
+
query?: never;
|
|
989
|
+
header?: never;
|
|
990
|
+
path?: never;
|
|
991
|
+
cookie?: never;
|
|
992
|
+
};
|
|
993
|
+
get?: never;
|
|
994
|
+
put?: never;
|
|
995
|
+
/**
|
|
996
|
+
* Plan Workspace Transfer
|
|
997
|
+
* @description Preview what a download / copy / move of this scope would include.
|
|
998
|
+
*
|
|
999
|
+
* Counts per entity type, what rides along (older versions, attachments, cited
|
|
1000
|
+
* documents, labels in use), provenance links kept vs dropped, references left
|
|
1001
|
+
* dangling, and — for a move — how many items you may not delete here.
|
|
1002
|
+
*/
|
|
1003
|
+
post: operations['plan_workspace_transfer'];
|
|
1004
|
+
delete?: never;
|
|
1005
|
+
options?: never;
|
|
1006
|
+
head?: never;
|
|
1007
|
+
patch?: never;
|
|
1008
|
+
trace?: never;
|
|
1009
|
+
};
|
|
1010
|
+
'/v1/workspace/export': {
|
|
1011
|
+
parameters: {
|
|
1012
|
+
query?: never;
|
|
1013
|
+
header?: never;
|
|
1014
|
+
path?: never;
|
|
1015
|
+
cookie?: never;
|
|
1016
|
+
};
|
|
1017
|
+
get?: never;
|
|
1018
|
+
put?: never;
|
|
1019
|
+
/**
|
|
1020
|
+
* Export Workspace Data
|
|
1021
|
+
* @description The decrypted structured data of a scope, plus the document files to fetch for a download.
|
|
1022
|
+
*
|
|
1023
|
+
* One JSON array per entity type, a manifest, and ``files`` — each a document
|
|
1024
|
+
* version to fetch through ``/v1/document/{doc_ext_id}/download`` and store at
|
|
1025
|
+
* ``path`` (current versions under ``documents/``, older ones under
|
|
1026
|
+
* ``documents/_versions/``).
|
|
1027
|
+
*/
|
|
1028
|
+
post: operations['export_workspace_data'];
|
|
1029
|
+
delete?: never;
|
|
1030
|
+
options?: never;
|
|
1031
|
+
head?: never;
|
|
1032
|
+
patch?: never;
|
|
1033
|
+
trace?: never;
|
|
1034
|
+
};
|
|
1035
|
+
'/v1/workspace/transfer': {
|
|
1036
|
+
parameters: {
|
|
1037
|
+
query?: never;
|
|
1038
|
+
header?: never;
|
|
1039
|
+
path?: never;
|
|
1040
|
+
cookie?: never;
|
|
1041
|
+
};
|
|
1042
|
+
/**
|
|
1043
|
+
* List Workspace Transfers
|
|
1044
|
+
* @description Your recent transfers out of the current workspace, newest first (to find one to resume).
|
|
1045
|
+
*/
|
|
1046
|
+
get: operations['list_workspace_transfers'];
|
|
1047
|
+
put?: never;
|
|
1048
|
+
/**
|
|
1049
|
+
* Start Workspace Transfer
|
|
1050
|
+
* @description Copy or move a scope of the current workspace into another one, in the background.
|
|
1051
|
+
*
|
|
1052
|
+
* The target must be a workspace you own or collaborate on. Poll
|
|
1053
|
+
* ``GET /transfer/{id}`` for progress. Everything is re-encrypted under the
|
|
1054
|
+
* target workspace key; each item keeps its privacy (a private item is in scope
|
|
1055
|
+
* only if it is yours). Copied automations arrive paused. A move removes an item
|
|
1056
|
+
* from here only after it, and everything else, has been copied — and only if you
|
|
1057
|
+
* may delete it here; otherwise it is copied and kept.
|
|
1058
|
+
*/
|
|
1059
|
+
post: operations['start_workspace_transfer'];
|
|
1060
|
+
delete?: never;
|
|
1061
|
+
options?: never;
|
|
1062
|
+
head?: never;
|
|
1063
|
+
patch?: never;
|
|
1064
|
+
trace?: never;
|
|
1065
|
+
};
|
|
1066
|
+
'/v1/workspace/transfer/{transfer_ext_id}': {
|
|
1067
|
+
parameters: {
|
|
1068
|
+
query?: never;
|
|
1069
|
+
header?: never;
|
|
1070
|
+
path?: never;
|
|
1071
|
+
cookie?: never;
|
|
1072
|
+
};
|
|
1073
|
+
/**
|
|
1074
|
+
* Get Workspace Transfer
|
|
1075
|
+
* @description Progress and outcome of one transfer, with the items that need attention.
|
|
1076
|
+
*/
|
|
1077
|
+
get: operations['get_workspace_transfer'];
|
|
1078
|
+
put?: never;
|
|
1079
|
+
post?: never;
|
|
1080
|
+
delete?: never;
|
|
1081
|
+
options?: never;
|
|
1082
|
+
head?: never;
|
|
1083
|
+
patch?: never;
|
|
1084
|
+
trace?: never;
|
|
1085
|
+
};
|
|
1086
|
+
'/v1/workspace/transfer/{transfer_ext_id}/items': {
|
|
1087
|
+
parameters: {
|
|
1088
|
+
query?: never;
|
|
1089
|
+
header?: never;
|
|
1090
|
+
path?: never;
|
|
1091
|
+
cookie?: never;
|
|
1092
|
+
};
|
|
1093
|
+
/**
|
|
1094
|
+
* List Workspace Transfer Items
|
|
1095
|
+
* @description The full ledger of a transfer: every item, where it went and what happened to it.
|
|
1096
|
+
*/
|
|
1097
|
+
get: operations['list_workspace_transfer_items'];
|
|
1098
|
+
put?: never;
|
|
1099
|
+
post?: never;
|
|
1100
|
+
delete?: never;
|
|
1101
|
+
options?: never;
|
|
1102
|
+
head?: never;
|
|
1103
|
+
patch?: never;
|
|
1104
|
+
trace?: never;
|
|
1105
|
+
};
|
|
1106
|
+
'/v1/workspace/transfer/{transfer_ext_id}/resume': {
|
|
1107
|
+
parameters: {
|
|
1108
|
+
query?: never;
|
|
1109
|
+
header?: never;
|
|
1110
|
+
path?: never;
|
|
1111
|
+
cookie?: never;
|
|
1112
|
+
};
|
|
1113
|
+
get?: never;
|
|
1114
|
+
put?: never;
|
|
1115
|
+
/**
|
|
1116
|
+
* Resume Workspace Transfer
|
|
1117
|
+
* @description Resume an interrupted, cancelled or failed transfer (also retries the items that failed).
|
|
1118
|
+
*
|
|
1119
|
+
* Items already copied are not copied again. Must be called from the source
|
|
1120
|
+
* workspace, with the target workspace key sealed for this session.
|
|
1121
|
+
*/
|
|
1122
|
+
post: operations['resume_workspace_transfer'];
|
|
1123
|
+
delete?: never;
|
|
1124
|
+
options?: never;
|
|
1125
|
+
head?: never;
|
|
1126
|
+
patch?: never;
|
|
1127
|
+
trace?: never;
|
|
1128
|
+
};
|
|
1129
|
+
'/v1/workspace/transfer/{transfer_ext_id}/cancel': {
|
|
1130
|
+
parameters: {
|
|
1131
|
+
query?: never;
|
|
1132
|
+
header?: never;
|
|
1133
|
+
path?: never;
|
|
1134
|
+
cookie?: never;
|
|
1135
|
+
};
|
|
1136
|
+
get?: never;
|
|
1137
|
+
put?: never;
|
|
1138
|
+
/**
|
|
1139
|
+
* Cancel Workspace Transfer
|
|
1140
|
+
* @description Stop a transfer after the item in flight. What was copied stays copied; it can be resumed.
|
|
1141
|
+
*/
|
|
1142
|
+
post: operations['cancel_workspace_transfer'];
|
|
1143
|
+
delete?: never;
|
|
1144
|
+
options?: never;
|
|
1145
|
+
head?: never;
|
|
1146
|
+
patch?: never;
|
|
1147
|
+
trace?: never;
|
|
1148
|
+
};
|
|
979
1149
|
'/v1/editor/{document_id}/mentions': {
|
|
980
1150
|
parameters: {
|
|
981
1151
|
query?: never;
|
|
@@ -1335,8 +1505,9 @@ interface paths {
|
|
|
1335
1505
|
*
|
|
1336
1506
|
* Optional parameters for versions, provenance and document typing:
|
|
1337
1507
|
* - version_of: Saves the file as the next version of that document
|
|
1338
|
-
* - derived_from + derived_role: Records that the new document was made from another (a crop
|
|
1339
|
-
*
|
|
1508
|
+
* - derived_from + derived_role: Records that the new document was made from another (a crop, a
|
|
1509
|
+
* redacted or annotated copy) or, with derived_from repeated, from several (a production set)
|
|
1510
|
+
* - wp_type: Document type (source, skill, artifact). Defaults to 'source'.
|
|
1340
1511
|
* - tag_ext_id: Links document to a tag
|
|
1341
1512
|
* - folder: Logical folder path for grouping (URL safe, e.g., 'skills/weather')
|
|
1342
1513
|
*
|
|
@@ -1582,6 +1753,66 @@ interface paths {
|
|
|
1582
1753
|
patch?: never;
|
|
1583
1754
|
trace?: never;
|
|
1584
1755
|
};
|
|
1756
|
+
'/v1/document/{document_ext_id}/sign/prepare': {
|
|
1757
|
+
parameters: {
|
|
1758
|
+
query?: never;
|
|
1759
|
+
header?: never;
|
|
1760
|
+
path?: never;
|
|
1761
|
+
cookie?: never;
|
|
1762
|
+
};
|
|
1763
|
+
get?: never;
|
|
1764
|
+
put?: never;
|
|
1765
|
+
/**
|
|
1766
|
+
* Prepare Document Signature
|
|
1767
|
+
* @description Return the exact statement the signer's key must sign, and the hash of the PDF they are shown.
|
|
1768
|
+
*/
|
|
1769
|
+
post: operations['prepare_document_signature'];
|
|
1770
|
+
delete?: never;
|
|
1771
|
+
options?: never;
|
|
1772
|
+
head?: never;
|
|
1773
|
+
patch?: never;
|
|
1774
|
+
trace?: never;
|
|
1775
|
+
};
|
|
1776
|
+
'/v1/document/{document_ext_id}/sign': {
|
|
1777
|
+
parameters: {
|
|
1778
|
+
query?: never;
|
|
1779
|
+
header?: never;
|
|
1780
|
+
path?: never;
|
|
1781
|
+
cookie?: never;
|
|
1782
|
+
};
|
|
1783
|
+
get?: never;
|
|
1784
|
+
put?: never;
|
|
1785
|
+
/**
|
|
1786
|
+
* Sign Document
|
|
1787
|
+
* @description Sign a document: verify the signer's statement, seal a signed copy, save it as a new child document.
|
|
1788
|
+
*/
|
|
1789
|
+
post: operations['sign_document'];
|
|
1790
|
+
delete?: never;
|
|
1791
|
+
options?: never;
|
|
1792
|
+
head?: never;
|
|
1793
|
+
patch?: never;
|
|
1794
|
+
trace?: never;
|
|
1795
|
+
};
|
|
1796
|
+
'/v1/document/{document_ext_id}/signatures': {
|
|
1797
|
+
parameters: {
|
|
1798
|
+
query?: never;
|
|
1799
|
+
header?: never;
|
|
1800
|
+
path?: never;
|
|
1801
|
+
cookie?: never;
|
|
1802
|
+
};
|
|
1803
|
+
/**
|
|
1804
|
+
* Get Document Signature Status
|
|
1805
|
+
* @description Is this document a signed copy, and is it unchanged since signing? Read from the PDF itself.
|
|
1806
|
+
*/
|
|
1807
|
+
get: operations['get_document_signature_status'];
|
|
1808
|
+
put?: never;
|
|
1809
|
+
post?: never;
|
|
1810
|
+
delete?: never;
|
|
1811
|
+
options?: never;
|
|
1812
|
+
head?: never;
|
|
1813
|
+
patch?: never;
|
|
1814
|
+
trace?: never;
|
|
1815
|
+
};
|
|
1585
1816
|
'/v1/conversation/list': {
|
|
1586
1817
|
parameters: {
|
|
1587
1818
|
query?: never;
|
|
@@ -4323,66 +4554,6 @@ interface paths {
|
|
|
4323
4554
|
patch?: never;
|
|
4324
4555
|
trace?: never;
|
|
4325
4556
|
};
|
|
4326
|
-
'/v1/document/{document_ext_id}/sign/prepare': {
|
|
4327
|
-
parameters: {
|
|
4328
|
-
query?: never;
|
|
4329
|
-
header?: never;
|
|
4330
|
-
path?: never;
|
|
4331
|
-
cookie?: never;
|
|
4332
|
-
};
|
|
4333
|
-
get?: never;
|
|
4334
|
-
put?: never;
|
|
4335
|
-
/**
|
|
4336
|
-
* Prepare Document Signature
|
|
4337
|
-
* @description Return the exact statement the signer's key must sign, and the hash of the PDF they are shown.
|
|
4338
|
-
*/
|
|
4339
|
-
post: operations['prepare_document_signature'];
|
|
4340
|
-
delete?: never;
|
|
4341
|
-
options?: never;
|
|
4342
|
-
head?: never;
|
|
4343
|
-
patch?: never;
|
|
4344
|
-
trace?: never;
|
|
4345
|
-
};
|
|
4346
|
-
'/v1/document/{document_ext_id}/sign': {
|
|
4347
|
-
parameters: {
|
|
4348
|
-
query?: never;
|
|
4349
|
-
header?: never;
|
|
4350
|
-
path?: never;
|
|
4351
|
-
cookie?: never;
|
|
4352
|
-
};
|
|
4353
|
-
get?: never;
|
|
4354
|
-
put?: never;
|
|
4355
|
-
/**
|
|
4356
|
-
* Sign Document
|
|
4357
|
-
* @description Sign a document: verify the signer's statement, seal a signed copy, save it as a new child document.
|
|
4358
|
-
*/
|
|
4359
|
-
post: operations['sign_document'];
|
|
4360
|
-
delete?: never;
|
|
4361
|
-
options?: never;
|
|
4362
|
-
head?: never;
|
|
4363
|
-
patch?: never;
|
|
4364
|
-
trace?: never;
|
|
4365
|
-
};
|
|
4366
|
-
'/v1/document/{document_ext_id}/signatures': {
|
|
4367
|
-
parameters: {
|
|
4368
|
-
query?: never;
|
|
4369
|
-
header?: never;
|
|
4370
|
-
path?: never;
|
|
4371
|
-
cookie?: never;
|
|
4372
|
-
};
|
|
4373
|
-
/**
|
|
4374
|
-
* Get Document Signature Status
|
|
4375
|
-
* @description Is this document a signed copy, and is it unchanged since signing? Read from the PDF itself.
|
|
4376
|
-
*/
|
|
4377
|
-
get: operations['get_document_signature_status'];
|
|
4378
|
-
put?: never;
|
|
4379
|
-
post?: never;
|
|
4380
|
-
delete?: never;
|
|
4381
|
-
options?: never;
|
|
4382
|
-
head?: never;
|
|
4383
|
-
patch?: never;
|
|
4384
|
-
trace?: never;
|
|
4385
|
-
};
|
|
4386
4557
|
}
|
|
4387
4558
|
type webhooks = Record<string, never>;
|
|
4388
4559
|
interface components {
|
|
@@ -4881,12 +5052,6 @@ interface components {
|
|
|
4881
5052
|
* @description Allowlist of skill slugs this config may invoke via run_skill/list_skills. None = no restriction (every skill the caller can see — back-compat default). A list (including []) restricts to exactly those slugs. Set a list on an agent's config to scope which skills that agent can use.
|
|
4882
5053
|
*/
|
|
4883
5054
|
ENABLED_SKILLS?: string[] | null;
|
|
4884
|
-
/**
|
|
4885
|
-
* Memory Creation
|
|
4886
|
-
* @description Transient flag set by /setup command to enable the save_profile agent tool (authors the per-workspace practice-profile memory document).
|
|
4887
|
-
* @default false
|
|
4888
|
-
*/
|
|
4889
|
-
MEMORY_CREATION: boolean;
|
|
4890
5055
|
/**
|
|
4891
5056
|
* Goals Enabled
|
|
4892
5057
|
* @description Feature gate for the goal/Ralph-loop system. When False, the /goal command is unavailable (falls through to a normal query) and the router may not auto-escalate to goal mode. Mirrors SKILLS_ENABLED; set per workspace/config to expose the feature.
|
|
@@ -5209,7 +5374,6 @@ interface components {
|
|
|
5209
5374
|
* "SKILL_CREATION": false,
|
|
5210
5375
|
* "WORKSPACE_TOOLS_ENABLED": false,
|
|
5211
5376
|
* "REMOTE_CONTROL_ENABLED": false,
|
|
5212
|
-
* "MEMORY_CREATION": false,
|
|
5213
5377
|
* "GOALS_ENABLED": false,
|
|
5214
5378
|
* "GOAL_MAX_OUTER_LOOPS": 6,
|
|
5215
5379
|
* "PERSONA": "You are ARBI, an AI assistant created by ARBI CITY. Be proactive, helpful and professional.",
|
|
@@ -6531,6 +6695,12 @@ interface components {
|
|
|
6531
6695
|
/** Email */
|
|
6532
6696
|
email: string;
|
|
6533
6697
|
};
|
|
6698
|
+
/**
|
|
6699
|
+
* ConflictPolicy
|
|
6700
|
+
* @description When the target already has a same-named document / automation, or an identical note.
|
|
6701
|
+
* @enum {string}
|
|
6702
|
+
*/
|
|
6703
|
+
ConflictPolicy: 'skip' | 'keep_both';
|
|
6534
6704
|
/** ConnectMailAccount */
|
|
6535
6705
|
ConnectMailAccount: {
|
|
6536
6706
|
/** Profile Id */
|
|
@@ -6935,13 +7105,18 @@ interface components {
|
|
|
6935
7105
|
kind: components['schemas']['CopyItemKind'];
|
|
6936
7106
|
/** Warning */
|
|
6937
7107
|
warning?: string | null;
|
|
7108
|
+
/**
|
|
7109
|
+
* Skipped
|
|
7110
|
+
* @default false
|
|
7111
|
+
*/
|
|
7112
|
+
skipped: boolean;
|
|
6938
7113
|
};
|
|
6939
7114
|
/**
|
|
6940
7115
|
* CopyItemKind
|
|
6941
7116
|
* @description Which entity a copy result refers to — derived from the ext-id prefix.
|
|
6942
7117
|
* @enum {string}
|
|
6943
7118
|
*/
|
|
6944
|
-
CopyItemKind: 'document' | 'tag' | 'doctag' | 'fact' | 'chat' | 'unknown';
|
|
7119
|
+
CopyItemKind: 'document' | 'tag' | 'doctag' | 'fact' | 'chat' | 'workflow' | 'unknown';
|
|
6945
7120
|
/** CopyRequest */
|
|
6946
7121
|
CopyRequest: {
|
|
6947
7122
|
/** Target Workspace Ext Id */
|
|
@@ -6953,7 +7128,7 @@ interface components {
|
|
|
6953
7128
|
target_workspace_key: string;
|
|
6954
7129
|
/**
|
|
6955
7130
|
* Items
|
|
6956
|
-
* @description External IDs to copy. Heterogeneous: documents (doc-), tags (tag-), doctags (dtj-), facts (fct-)
|
|
7131
|
+
* @description External IDs to copy. Heterogeneous: documents (doc-), tags (tag-), doctags (dtj-), facts (fct-), chats (con-) and automations (wfl-) may be mixed in one call — the server dispatches on the prefix and copies them in dependency order (tags → documents → doctags/facts → chats → automations). Selection is exact: nothing is copied that was not listed, except that a document always brings all of its versions. For a scoped, resumable copy or move with dependencies, use POST /v1/workspace/transfer.
|
|
6957
7132
|
*/
|
|
6958
7133
|
items: string[];
|
|
6959
7134
|
};
|
|
@@ -7458,7 +7633,7 @@ interface components {
|
|
|
7458
7633
|
* @description How ``from_doc`` was derived from ``to_doc`` (provenance only, no behaviour).
|
|
7459
7634
|
* @enum {string}
|
|
7460
7635
|
*/
|
|
7461
|
-
DocRelationRole: 'edit' | 'sync' | 'crop' | 'redline_base' | 'redline_revised';
|
|
7636
|
+
DocRelationRole: 'edit' | 'sync' | 'crop' | 'redline_base' | 'redline_revised' | 'redaction' | 'annotated' | 'production';
|
|
7462
7637
|
/** DocResponse */
|
|
7463
7638
|
DocResponse: {
|
|
7464
7639
|
/** External Id */
|
|
@@ -8145,11 +8320,26 @@ interface components {
|
|
|
8145
8320
|
*/
|
|
8146
8321
|
EVAL_BATCH_TIMEOUT_S: number;
|
|
8147
8322
|
};
|
|
8148
|
-
/**
|
|
8149
|
-
|
|
8323
|
+
/**
|
|
8324
|
+
* ExportFile
|
|
8325
|
+
* @description One file of a download: fetch ``/v1/document/{doc_ext_id}/download`` and store it at ``path``.
|
|
8326
|
+
*/
|
|
8327
|
+
ExportFile: {
|
|
8328
|
+
/** Doc Ext Id */
|
|
8329
|
+
doc_ext_id: string;
|
|
8330
|
+
/** Path */
|
|
8331
|
+
path: string;
|
|
8150
8332
|
/**
|
|
8151
|
-
*
|
|
8152
|
-
* @default
|
|
8333
|
+
* Is Current
|
|
8334
|
+
* @default true
|
|
8335
|
+
*/
|
|
8336
|
+
is_current: boolean;
|
|
8337
|
+
};
|
|
8338
|
+
/** FactDeleteResponse */
|
|
8339
|
+
FactDeleteResponse: {
|
|
8340
|
+
/**
|
|
8341
|
+
* Detail
|
|
8342
|
+
* @default Note deleted successfully
|
|
8153
8343
|
*/
|
|
8154
8344
|
detail: string;
|
|
8155
8345
|
};
|
|
@@ -10232,6 +10422,32 @@ interface components {
|
|
|
10232
10422
|
*/
|
|
10233
10423
|
content: string;
|
|
10234
10424
|
};
|
|
10425
|
+
/** PrepareSignatureRequest */
|
|
10426
|
+
PrepareSignatureRequest: {
|
|
10427
|
+
signer: components['schemas']['SignerDetails'];
|
|
10428
|
+
/** @description Omit for the bottom of the last page */
|
|
10429
|
+
appearance?: components['schemas']['SignatureAppearance'] | null;
|
|
10430
|
+
};
|
|
10431
|
+
/** PrepareSignatureResponse */
|
|
10432
|
+
PrepareSignatureResponse: {
|
|
10433
|
+
/**
|
|
10434
|
+
* Statement
|
|
10435
|
+
* @description The exact text to sign with the user's Ed25519 key
|
|
10436
|
+
*/
|
|
10437
|
+
statement: string;
|
|
10438
|
+
/**
|
|
10439
|
+
* Intent
|
|
10440
|
+
* @description The statement of intent shown to the signer
|
|
10441
|
+
*/
|
|
10442
|
+
intent: string;
|
|
10443
|
+
/**
|
|
10444
|
+
* Source Sha256
|
|
10445
|
+
* @description SHA-256 of the PDF the signer is shown (the /view rendition)
|
|
10446
|
+
*/
|
|
10447
|
+
source_sha256: string;
|
|
10448
|
+
/** Timestamp */
|
|
10449
|
+
timestamp: number;
|
|
10450
|
+
};
|
|
10235
10451
|
/**
|
|
10236
10452
|
* PresenceUpdateMessage
|
|
10237
10453
|
* @description Sent when a contact's online status changes or is no longer tracked.
|
|
@@ -10710,6 +10926,12 @@ interface components {
|
|
|
10710
10926
|
/** @description ARBI agent-trace extension (non-standard). */
|
|
10711
10927
|
arbi?: components['schemas']['ArbiItemMeta'] | null;
|
|
10712
10928
|
};
|
|
10929
|
+
/**
|
|
10930
|
+
* ReferencedDocuments
|
|
10931
|
+
* @description What to do with a document a note / conversation / automation cites but the scope does not include.
|
|
10932
|
+
* @enum {string}
|
|
10933
|
+
*/
|
|
10934
|
+
ReferencedDocuments: 'include' | 'link';
|
|
10713
10935
|
/**
|
|
10714
10936
|
* RegisterRequest
|
|
10715
10937
|
* @description Unified user registration request (local and SSO).
|
|
@@ -12130,6 +12352,137 @@ interface components {
|
|
|
12130
12352
|
/** Auto Sync Workspace Ext Id */
|
|
12131
12353
|
auto_sync_workspace_ext_id?: string | null;
|
|
12132
12354
|
};
|
|
12355
|
+
/** SignDocumentRequest */
|
|
12356
|
+
SignDocumentRequest: {
|
|
12357
|
+
signer: components['schemas']['SignerDetails'];
|
|
12358
|
+
/** @description Omit for the bottom of the last page */
|
|
12359
|
+
appearance?: components['schemas']['SignatureAppearance'] | null;
|
|
12360
|
+
/** Timestamp */
|
|
12361
|
+
timestamp: number;
|
|
12362
|
+
/**
|
|
12363
|
+
* Signature
|
|
12364
|
+
* @description Ed25519 signature (base64) of the prepared statement
|
|
12365
|
+
*/
|
|
12366
|
+
signature: string;
|
|
12367
|
+
};
|
|
12368
|
+
/** SignDocumentResponse */
|
|
12369
|
+
SignDocumentResponse: {
|
|
12370
|
+
/** Signed Doc Ext Id */
|
|
12371
|
+
signed_doc_ext_id: string;
|
|
12372
|
+
signature: components['schemas']['SignatureRecord'];
|
|
12373
|
+
};
|
|
12374
|
+
/**
|
|
12375
|
+
* SignatureAppearance
|
|
12376
|
+
* @description Where the visible signature goes. Coordinates are fractions of the page, origin top-left.
|
|
12377
|
+
*/
|
|
12378
|
+
SignatureAppearance: {
|
|
12379
|
+
/**
|
|
12380
|
+
* Page
|
|
12381
|
+
* @description 0-based page index; negative counts from the end (-1 = last page)
|
|
12382
|
+
* @default -1
|
|
12383
|
+
*/
|
|
12384
|
+
page: number;
|
|
12385
|
+
/**
|
|
12386
|
+
* X
|
|
12387
|
+
* @default 0.08
|
|
12388
|
+
*/
|
|
12389
|
+
x: number;
|
|
12390
|
+
/**
|
|
12391
|
+
* Y
|
|
12392
|
+
* @default 0.8
|
|
12393
|
+
*/
|
|
12394
|
+
y: number;
|
|
12395
|
+
/**
|
|
12396
|
+
* Width
|
|
12397
|
+
* @default 0.4
|
|
12398
|
+
*/
|
|
12399
|
+
width: number;
|
|
12400
|
+
/**
|
|
12401
|
+
* Height
|
|
12402
|
+
* @default 0.1
|
|
12403
|
+
*/
|
|
12404
|
+
height: number;
|
|
12405
|
+
};
|
|
12406
|
+
/** SignatureRecord */
|
|
12407
|
+
SignatureRecord: {
|
|
12408
|
+
/** Reference */
|
|
12409
|
+
reference: string;
|
|
12410
|
+
/** Signer Email */
|
|
12411
|
+
signer_email: string;
|
|
12412
|
+
/** Intent */
|
|
12413
|
+
intent: string;
|
|
12414
|
+
/**
|
|
12415
|
+
* Source Doc Ext Id
|
|
12416
|
+
* @description The document that was signed
|
|
12417
|
+
*/
|
|
12418
|
+
source_doc_ext_id: string;
|
|
12419
|
+
/** Source Sha256 */
|
|
12420
|
+
source_sha256: string;
|
|
12421
|
+
/**
|
|
12422
|
+
* Signed At
|
|
12423
|
+
* Format: date-time
|
|
12424
|
+
*/
|
|
12425
|
+
signed_at: string;
|
|
12426
|
+
/**
|
|
12427
|
+
* Statement Valid
|
|
12428
|
+
* @description The signer's Ed25519 signature over the statement verifies
|
|
12429
|
+
*/
|
|
12430
|
+
statement_valid: boolean;
|
|
12431
|
+
/**
|
|
12432
|
+
* Signer Name
|
|
12433
|
+
* @description The name the signer signed as
|
|
12434
|
+
*/
|
|
12435
|
+
signer_name?: string | null;
|
|
12436
|
+
/**
|
|
12437
|
+
* Capacity
|
|
12438
|
+
* @description The signer's role, e.g. 'Partner'
|
|
12439
|
+
*/
|
|
12440
|
+
capacity?: string | null;
|
|
12441
|
+
/**
|
|
12442
|
+
* On Behalf Of
|
|
12443
|
+
* @description Who the signer signed for, e.g. a firm
|
|
12444
|
+
*/
|
|
12445
|
+
on_behalf_of?: string | null;
|
|
12446
|
+
};
|
|
12447
|
+
/** SignatureStatusResponse */
|
|
12448
|
+
SignatureStatusResponse: {
|
|
12449
|
+
/**
|
|
12450
|
+
* Signed
|
|
12451
|
+
* @description This document is a PDF signed and sealed by ARBI
|
|
12452
|
+
*/
|
|
12453
|
+
signed: boolean;
|
|
12454
|
+
/**
|
|
12455
|
+
* Intact
|
|
12456
|
+
* @description The seal verifies: nothing changed since signing
|
|
12457
|
+
*/
|
|
12458
|
+
intact: boolean;
|
|
12459
|
+
/**
|
|
12460
|
+
* Timestamped
|
|
12461
|
+
* @description The seal carries an RFC 3161 timestamp
|
|
12462
|
+
* @default false
|
|
12463
|
+
*/
|
|
12464
|
+
timestamped: boolean;
|
|
12465
|
+
/**
|
|
12466
|
+
* Signatures
|
|
12467
|
+
* @default []
|
|
12468
|
+
*/
|
|
12469
|
+
signatures: components['schemas']['SignatureRecord'][];
|
|
12470
|
+
};
|
|
12471
|
+
/** SignerDetails */
|
|
12472
|
+
SignerDetails: {
|
|
12473
|
+
/** Name */
|
|
12474
|
+
name: string;
|
|
12475
|
+
/**
|
|
12476
|
+
* Capacity
|
|
12477
|
+
* @description e.g. 'Partner', 'Solicitor'
|
|
12478
|
+
*/
|
|
12479
|
+
capacity?: string | null;
|
|
12480
|
+
/**
|
|
12481
|
+
* On Behalf Of
|
|
12482
|
+
* @description e.g. the firm's name
|
|
12483
|
+
*/
|
|
12484
|
+
on_behalf_of?: string | null;
|
|
12485
|
+
};
|
|
12133
12486
|
/**
|
|
12134
12487
|
* SkillSummaryResponse
|
|
12135
12488
|
* @description One row of ``GET /v1/assistant/skills``.
|
|
@@ -12905,102 +13258,285 @@ interface components {
|
|
|
12905
13258
|
/** Text */
|
|
12906
13259
|
text: string;
|
|
12907
13260
|
};
|
|
13261
|
+
/** TransferItemResult */
|
|
13262
|
+
TransferItemResult: {
|
|
13263
|
+
/** Kind */
|
|
13264
|
+
kind: string;
|
|
13265
|
+
/** Source Ext Id */
|
|
13266
|
+
source_ext_id: string;
|
|
13267
|
+
/** Target Ext Id */
|
|
13268
|
+
target_ext_id?: string | null;
|
|
13269
|
+
status: components['schemas']['TransferItemStatus'];
|
|
13270
|
+
/** Message */
|
|
13271
|
+
message?: string | null;
|
|
13272
|
+
};
|
|
12908
13273
|
/**
|
|
12909
|
-
*
|
|
12910
|
-
* @
|
|
12911
|
-
* is server-managed and renames would break the derived agent email.
|
|
13274
|
+
* TransferItemStatus
|
|
13275
|
+
* @enum {string}
|
|
12912
13276
|
*/
|
|
12913
|
-
|
|
12914
|
-
/** Picture */
|
|
12915
|
-
picture?: string | null;
|
|
12916
|
-
};
|
|
12917
|
-
/** UpdateConversationRequest */
|
|
12918
|
-
UpdateConversationRequest: {
|
|
12919
|
-
/** Add Label Ext Ids */
|
|
12920
|
-
add_label_ext_ids?: string[];
|
|
12921
|
-
/** Remove Label Ext Ids */
|
|
12922
|
-
remove_label_ext_ids?: string[];
|
|
12923
|
-
/** Title */
|
|
12924
|
-
title?: string | null;
|
|
12925
|
-
/** Shared */
|
|
12926
|
-
shared?: boolean | null;
|
|
12927
|
-
/** Description */
|
|
12928
|
-
description?: string | null;
|
|
12929
|
-
/** Due At */
|
|
12930
|
-
due_at?: string | null;
|
|
12931
|
-
/** Parent Conversation Ext Id */
|
|
12932
|
-
parent_conversation_ext_id?: string | null;
|
|
12933
|
-
/** Status */
|
|
12934
|
-
status?: ('todo' | 'done') | null;
|
|
12935
|
-
plan?: components['schemas']['TaskPlan'] | null;
|
|
12936
|
-
};
|
|
13277
|
+
TransferItemStatus: 'pending' | 'copied' | 'skipped' | 'failed' | 'removed' | 'kept';
|
|
12937
13278
|
/**
|
|
12938
|
-
*
|
|
12939
|
-
* @description
|
|
13279
|
+
* TransferKind
|
|
13280
|
+
* @description The entity types a user can tick. Folders are not a kind: they are a property of documents.
|
|
13281
|
+
* @enum {string}
|
|
12940
13282
|
*/
|
|
12941
|
-
|
|
12942
|
-
/** Tag Ext Id */
|
|
12943
|
-
tag_ext_id: string;
|
|
12944
|
-
/** Doc Ext Id */
|
|
12945
|
-
doc_ext_id: string;
|
|
12946
|
-
/** Note */
|
|
12947
|
-
note?: string | null;
|
|
12948
|
-
citations?: components['schemas']['CitationSources'] | null;
|
|
12949
|
-
};
|
|
13283
|
+
TransferKind: 'documents' | 'skills' | 'labels' | 'fields' | 'facts' | 'conversations' | 'automations';
|
|
12950
13284
|
/**
|
|
12951
|
-
*
|
|
12952
|
-
* @
|
|
13285
|
+
* TransferMode
|
|
13286
|
+
* @enum {string}
|
|
12953
13287
|
*/
|
|
12954
|
-
|
|
12955
|
-
/** Documents */
|
|
12956
|
-
documents: components['schemas']['DocUpdateRequest'][];
|
|
12957
|
-
};
|
|
13288
|
+
TransferMode: 'download' | 'copy' | 'move';
|
|
12958
13289
|
/**
|
|
12959
|
-
*
|
|
12960
|
-
* @
|
|
12961
|
-
* inserts a replacement (append + soft-delete lifecycle); ``pinned``/``shared``/
|
|
12962
|
-
* ``tag_ext_ids`` update in place.
|
|
13290
|
+
* TransferPhase
|
|
13291
|
+
* @enum {string}
|
|
12963
13292
|
*/
|
|
12964
|
-
|
|
12965
|
-
|
|
12966
|
-
|
|
12967
|
-
|
|
12968
|
-
|
|
12969
|
-
|
|
12970
|
-
shared?: boolean | null;
|
|
12971
|
-
/** Confirmed */
|
|
12972
|
-
confirmed?: boolean | null;
|
|
12973
|
-
/** Date */
|
|
12974
|
-
date?: string | null;
|
|
12975
|
-
/** Date End */
|
|
12976
|
-
date_end?: string | null;
|
|
12977
|
-
/** Timezone */
|
|
12978
|
-
timezone?: string | null;
|
|
12979
|
-
/** Tag Ext Ids */
|
|
12980
|
-
tag_ext_ids?: string[] | null;
|
|
12981
|
-
citations?: components['schemas']['CitationSources'] | null;
|
|
13293
|
+
TransferPhase: 'copy' | 'link' | 'remove' | 'done';
|
|
13294
|
+
/** TransferPlanRequest */
|
|
13295
|
+
TransferPlanRequest: {
|
|
13296
|
+
scope: components['schemas']['TransferScope'];
|
|
13297
|
+
/** @default copy */
|
|
13298
|
+
mode: components['schemas']['TransferMode'];
|
|
12982
13299
|
};
|
|
12983
13300
|
/**
|
|
12984
|
-
*
|
|
12985
|
-
* @description
|
|
13301
|
+
* TransferPlanResponse
|
|
13302
|
+
* @description What a transfer with this scope would touch — shown to the user before they confirm.
|
|
12986
13303
|
*/
|
|
12987
|
-
|
|
12988
|
-
/**
|
|
12989
|
-
|
|
12990
|
-
|
|
12991
|
-
|
|
12992
|
-
|
|
12993
|
-
|
|
12994
|
-
|
|
12995
|
-
/**
|
|
12996
|
-
|
|
12997
|
-
|
|
12998
|
-
|
|
12999
|
-
|
|
13000
|
-
|
|
13001
|
-
|
|
13002
|
-
/**
|
|
13003
|
-
|
|
13304
|
+
TransferPlanResponse: {
|
|
13305
|
+
/**
|
|
13306
|
+
* Counts
|
|
13307
|
+
* @default {}
|
|
13308
|
+
*/
|
|
13309
|
+
counts: {
|
|
13310
|
+
[key: string]: number;
|
|
13311
|
+
};
|
|
13312
|
+
/**
|
|
13313
|
+
* Added
|
|
13314
|
+
* @default {}
|
|
13315
|
+
*/
|
|
13316
|
+
added: {
|
|
13317
|
+
[key: string]: number;
|
|
13318
|
+
};
|
|
13319
|
+
/**
|
|
13320
|
+
* Relations Inside
|
|
13321
|
+
* @default 0
|
|
13322
|
+
*/
|
|
13323
|
+
relations_inside: number;
|
|
13324
|
+
/**
|
|
13325
|
+
* Relations Outside
|
|
13326
|
+
* @default 0
|
|
13327
|
+
*/
|
|
13328
|
+
relations_outside: number;
|
|
13329
|
+
/**
|
|
13330
|
+
* Dangling References
|
|
13331
|
+
* @default 0
|
|
13332
|
+
*/
|
|
13333
|
+
dangling_references: number;
|
|
13334
|
+
/**
|
|
13335
|
+
* Not Removable
|
|
13336
|
+
* @default 0
|
|
13337
|
+
*/
|
|
13338
|
+
not_removable: number;
|
|
13339
|
+
/**
|
|
13340
|
+
* Total Bytes
|
|
13341
|
+
* @default 0
|
|
13342
|
+
*/
|
|
13343
|
+
total_bytes: number;
|
|
13344
|
+
/**
|
|
13345
|
+
* Item Count
|
|
13346
|
+
* @default 0
|
|
13347
|
+
*/
|
|
13348
|
+
item_count: number;
|
|
13349
|
+
};
|
|
13350
|
+
/** TransferResumeRequest */
|
|
13351
|
+
TransferResumeRequest: {
|
|
13352
|
+
/**
|
|
13353
|
+
* Target Workspace Key
|
|
13354
|
+
* @description SealedBox-encrypted target workspace key (encrypted with the session public key)
|
|
13355
|
+
*/
|
|
13356
|
+
target_workspace_key: string;
|
|
13357
|
+
};
|
|
13358
|
+
/**
|
|
13359
|
+
* TransferScope
|
|
13360
|
+
* @description What to transfer.
|
|
13361
|
+
*/
|
|
13362
|
+
TransferScope: {
|
|
13363
|
+
kind: components['schemas']['TransferScopeKind'];
|
|
13364
|
+
/**
|
|
13365
|
+
* Items
|
|
13366
|
+
* @description selection: external ids — documents (doc-), labels/fields (tag-), facts (fct-), conversations (con-) and automations (wfl-). A document brings all its versions and its attachments; an id of any version names the whole document.
|
|
13367
|
+
*/
|
|
13368
|
+
items?: string[];
|
|
13369
|
+
/** Label Ext Id */
|
|
13370
|
+
label_ext_id?: string | null;
|
|
13371
|
+
/** Kinds */
|
|
13372
|
+
kinds?: components['schemas']['TransferKind'][];
|
|
13373
|
+
/** @default include */
|
|
13374
|
+
referenced_documents: components['schemas']['ReferencedDocuments'];
|
|
13375
|
+
};
|
|
13376
|
+
/**
|
|
13377
|
+
* TransferScopeKind
|
|
13378
|
+
* @enum {string}
|
|
13379
|
+
*/
|
|
13380
|
+
TransferScopeKind: 'selection' | 'label' | 'all';
|
|
13381
|
+
/** TransferStartRequest */
|
|
13382
|
+
TransferStartRequest: {
|
|
13383
|
+
scope: components['schemas']['TransferScope'];
|
|
13384
|
+
/** @default copy */
|
|
13385
|
+
mode: components['schemas']['TransferMode'];
|
|
13386
|
+
/** Target Workspace Ext Id */
|
|
13387
|
+
target_workspace_ext_id: string;
|
|
13388
|
+
/**
|
|
13389
|
+
* Target Workspace Key
|
|
13390
|
+
* @description SealedBox-encrypted target workspace key (encrypted with the session public key)
|
|
13391
|
+
*/
|
|
13392
|
+
target_workspace_key: string;
|
|
13393
|
+
/** @default skip */
|
|
13394
|
+
on_conflict: components['schemas']['ConflictPolicy'];
|
|
13395
|
+
};
|
|
13396
|
+
/**
|
|
13397
|
+
* TransferStatus
|
|
13398
|
+
* @enum {string}
|
|
13399
|
+
*/
|
|
13400
|
+
TransferStatus: 'queued' | 'running' | 'completed' | 'failed' | 'cancelled' | 'interrupted';
|
|
13401
|
+
/** TransferStatusResponse */
|
|
13402
|
+
TransferStatusResponse: {
|
|
13403
|
+
/** External Id */
|
|
13404
|
+
external_id: string;
|
|
13405
|
+
mode: components['schemas']['TransferMode'];
|
|
13406
|
+
status: components['schemas']['TransferStatus'];
|
|
13407
|
+
phase: components['schemas']['TransferPhase'];
|
|
13408
|
+
/** Source Workspace Ext Id */
|
|
13409
|
+
source_workspace_ext_id?: string | null;
|
|
13410
|
+
/** Target Workspace Ext Id */
|
|
13411
|
+
target_workspace_ext_id?: string | null;
|
|
13412
|
+
/**
|
|
13413
|
+
* Total
|
|
13414
|
+
* @default 0
|
|
13415
|
+
*/
|
|
13416
|
+
total: number;
|
|
13417
|
+
/**
|
|
13418
|
+
* Processed
|
|
13419
|
+
* @default 0
|
|
13420
|
+
*/
|
|
13421
|
+
processed: number;
|
|
13422
|
+
/**
|
|
13423
|
+
* Counts
|
|
13424
|
+
* @default {}
|
|
13425
|
+
*/
|
|
13426
|
+
counts: {
|
|
13427
|
+
[key: string]: unknown;
|
|
13428
|
+
};
|
|
13429
|
+
/** Error */
|
|
13430
|
+
error?: string | null;
|
|
13431
|
+
/**
|
|
13432
|
+
* Created At
|
|
13433
|
+
* Format: date-time
|
|
13434
|
+
*/
|
|
13435
|
+
created_at: string;
|
|
13436
|
+
/** Finished At */
|
|
13437
|
+
finished_at?: string | null;
|
|
13438
|
+
/**
|
|
13439
|
+
* Issues
|
|
13440
|
+
* @default []
|
|
13441
|
+
*/
|
|
13442
|
+
issues: components['schemas']['TransferItemResult'][];
|
|
13443
|
+
};
|
|
13444
|
+
/**
|
|
13445
|
+
* UpdateAgentRequest
|
|
13446
|
+
* @description Mutable agent fields. Only appearance for now — identity (name/email/keys)
|
|
13447
|
+
* is server-managed and renames would break the derived agent email.
|
|
13448
|
+
*/
|
|
13449
|
+
UpdateAgentRequest: {
|
|
13450
|
+
/** Picture */
|
|
13451
|
+
picture?: string | null;
|
|
13452
|
+
};
|
|
13453
|
+
/** UpdateConversationRequest */
|
|
13454
|
+
UpdateConversationRequest: {
|
|
13455
|
+
/** Add Label Ext Ids */
|
|
13456
|
+
add_label_ext_ids?: string[];
|
|
13457
|
+
/** Remove Label Ext Ids */
|
|
13458
|
+
remove_label_ext_ids?: string[];
|
|
13459
|
+
/** Title */
|
|
13460
|
+
title?: string | null;
|
|
13461
|
+
/** Shared */
|
|
13462
|
+
shared?: boolean | null;
|
|
13463
|
+
/** Description */
|
|
13464
|
+
description?: string | null;
|
|
13465
|
+
/** Due At */
|
|
13466
|
+
due_at?: string | null;
|
|
13467
|
+
/** Parent Conversation Ext Id */
|
|
13468
|
+
parent_conversation_ext_id?: string | null;
|
|
13469
|
+
/** Status */
|
|
13470
|
+
status?: ('todo' | 'done') | null;
|
|
13471
|
+
plan?: components['schemas']['TaskPlan'] | null;
|
|
13472
|
+
};
|
|
13473
|
+
/**
|
|
13474
|
+
* UpdateDocTagRequest
|
|
13475
|
+
* @description Update a doctag's note or citations. Identified by (tag_ext_id, doc_ext_id) pair.
|
|
13476
|
+
*/
|
|
13477
|
+
UpdateDocTagRequest: {
|
|
13478
|
+
/** Tag Ext Id */
|
|
13479
|
+
tag_ext_id: string;
|
|
13480
|
+
/** Doc Ext Id */
|
|
13481
|
+
doc_ext_id: string;
|
|
13482
|
+
/** Note */
|
|
13483
|
+
note?: string | null;
|
|
13484
|
+
citations?: components['schemas']['CitationSources'] | null;
|
|
13485
|
+
};
|
|
13486
|
+
/**
|
|
13487
|
+
* UpdateDocumentsRequest
|
|
13488
|
+
* @description Update one or more documents.
|
|
13489
|
+
*/
|
|
13490
|
+
UpdateDocumentsRequest: {
|
|
13491
|
+
/** Documents */
|
|
13492
|
+
documents: components['schemas']['DocUpdateRequest'][];
|
|
13493
|
+
};
|
|
13494
|
+
/**
|
|
13495
|
+
* UpdateFactRequest
|
|
13496
|
+
* @description Patch a fact. An edit to ``text`` soft-deletes the old row and
|
|
13497
|
+
* inserts a replacement (append + soft-delete lifecycle); ``pinned``/``shared``/
|
|
13498
|
+
* ``tag_ext_ids`` update in place.
|
|
13499
|
+
*/
|
|
13500
|
+
UpdateFactRequest: {
|
|
13501
|
+
/** Text */
|
|
13502
|
+
text?: string | null;
|
|
13503
|
+
/** Pinned */
|
|
13504
|
+
pinned?: boolean | null;
|
|
13505
|
+
/** Shared */
|
|
13506
|
+
shared?: boolean | null;
|
|
13507
|
+
/** Confirmed */
|
|
13508
|
+
confirmed?: boolean | null;
|
|
13509
|
+
/** Date */
|
|
13510
|
+
date?: string | null;
|
|
13511
|
+
/** Date End */
|
|
13512
|
+
date_end?: string | null;
|
|
13513
|
+
/** Timezone */
|
|
13514
|
+
timezone?: string | null;
|
|
13515
|
+
/** Tag Ext Ids */
|
|
13516
|
+
tag_ext_ids?: string[] | null;
|
|
13517
|
+
citations?: components['schemas']['CitationSources'] | null;
|
|
13518
|
+
};
|
|
13519
|
+
/**
|
|
13520
|
+
* UpdateNotificationsRequest
|
|
13521
|
+
* @description Bulk update notifications.
|
|
13522
|
+
*/
|
|
13523
|
+
UpdateNotificationsRequest: {
|
|
13524
|
+
/** Updates */
|
|
13525
|
+
updates: components['schemas']['NotificationUpdate'][];
|
|
13526
|
+
};
|
|
13527
|
+
/** UpdateProfileRequest */
|
|
13528
|
+
UpdateProfileRequest: {
|
|
13529
|
+
/** Given Name */
|
|
13530
|
+
given_name?: string | null;
|
|
13531
|
+
/** Family Name */
|
|
13532
|
+
family_name?: string | null;
|
|
13533
|
+
/** Picture */
|
|
13534
|
+
picture?: string | null;
|
|
13535
|
+
};
|
|
13536
|
+
/** UpdateProfileResponse */
|
|
13537
|
+
UpdateProfileResponse: {
|
|
13538
|
+
/** Given Name */
|
|
13539
|
+
given_name: string;
|
|
13004
13540
|
/** Family Name */
|
|
13005
13541
|
family_name?: string | null;
|
|
13006
13542
|
/** Email */
|
|
@@ -13940,6 +14476,31 @@ interface components {
|
|
|
13940
14476
|
/** Project Ext Id */
|
|
13941
14477
|
project_ext_id: string;
|
|
13942
14478
|
};
|
|
14479
|
+
/** WorkspaceExportRequest */
|
|
14480
|
+
WorkspaceExportRequest: {
|
|
14481
|
+
scope: components['schemas']['TransferScope'];
|
|
14482
|
+
};
|
|
14483
|
+
/**
|
|
14484
|
+
* WorkspaceExportResponse
|
|
14485
|
+
* @description Structured data for a download, plus the files to fetch.
|
|
14486
|
+
*
|
|
14487
|
+
* ``data`` is decrypted plaintext keyed by entity type (one JSON file per type in
|
|
14488
|
+
* the archive); ``manifest`` describes the archive itself.
|
|
14489
|
+
*/
|
|
14490
|
+
WorkspaceExportResponse: {
|
|
14491
|
+
/** Manifest */
|
|
14492
|
+
manifest: {
|
|
14493
|
+
[key: string]: unknown;
|
|
14494
|
+
};
|
|
14495
|
+
/** Data */
|
|
14496
|
+
data: {
|
|
14497
|
+
[key: string]: {
|
|
14498
|
+
[key: string]: unknown;
|
|
14499
|
+
}[];
|
|
14500
|
+
};
|
|
14501
|
+
/** Files */
|
|
14502
|
+
files: components['schemas']['ExportFile'][];
|
|
14503
|
+
};
|
|
13943
14504
|
/**
|
|
13944
14505
|
* WorkspaceOpenRequest
|
|
13945
14506
|
* @description Request to open a workspace — stores encrypted key in session and sets active.
|
|
@@ -14131,167 +14692,25 @@ interface components {
|
|
|
14131
14692
|
*
|
|
14132
14693
|
* ``scheduled_permanent`` (tier 3, advanced) — standing ``WorkspaceUsers`` membership: the server
|
|
14133
14694
|
* can derive the workspace key from the agent's own deployment-wrapped identity at any time,
|
|
14134
|
-
* owner offline. An explicit "I trust this agent's environment" opt-in, NOT the default.
|
|
14135
|
-
* @enum {string}
|
|
14136
|
-
*/
|
|
14137
|
-
src__models__work__AuthMode: 'run_now_temp' | 'scheduled_require_auth' | 'scheduled_permanent';
|
|
14138
|
-
/**
|
|
14139
|
-
* AuthMode
|
|
14140
|
-
* @description How a workflow's agent obtains the workspace key it needs to act (least privilege).
|
|
14141
|
-
*
|
|
14142
|
-
* NOTE: the same concept as ``src.models.work.AuthMode`` (work-core); the names and values are identical so
|
|
14143
|
-
* the two can be deduplicated.
|
|
14144
|
-
*
|
|
14145
|
-
* ``run_now_temp`` (default) — a person is present (Run): the run session is granted
|
|
14146
|
-
* from their own workspace key. No standing membership.
|
|
14147
|
-
* ``scheduled_require_auth`` — an unattended run parks (``pending_auth_request_id`` + a
|
|
14148
|
-
* ``workspace_access_request`` notification) until the owner grants a key.
|
|
14149
|
-
* ``scheduled_permanent`` — the agent holds a standing membership; the server derives the key at any time.
|
|
14150
|
-
* @enum {string}
|
|
14151
|
-
*/
|
|
14152
|
-
src__models__workflow__AuthMode: 'run_now_temp' | 'scheduled_require_auth' | 'scheduled_permanent';
|
|
14153
|
-
/** PrepareSignatureRequest */
|
|
14154
|
-
PrepareSignatureRequest: {
|
|
14155
|
-
signer: components['schemas']['SignerDetails'];
|
|
14156
|
-
/** @description Omit for the bottom of the last page */
|
|
14157
|
-
appearance?: components['schemas']['SignatureAppearance'] | null;
|
|
14158
|
-
};
|
|
14159
|
-
/** PrepareSignatureResponse */
|
|
14160
|
-
PrepareSignatureResponse: {
|
|
14161
|
-
/**
|
|
14162
|
-
* Statement
|
|
14163
|
-
* @description The exact text to sign with the user's Ed25519 key
|
|
14164
|
-
*/
|
|
14165
|
-
statement: string;
|
|
14166
|
-
/**
|
|
14167
|
-
* Intent
|
|
14168
|
-
* @description The statement of intent shown to the signer
|
|
14169
|
-
*/
|
|
14170
|
-
intent: string;
|
|
14171
|
-
/**
|
|
14172
|
-
* Source Sha256
|
|
14173
|
-
* @description SHA-256 of the PDF the signer is shown (the /view rendition)
|
|
14174
|
-
*/
|
|
14175
|
-
source_sha256: string;
|
|
14176
|
-
/** Timestamp */
|
|
14177
|
-
timestamp: number;
|
|
14178
|
-
};
|
|
14179
|
-
/** SignDocumentRequest */
|
|
14180
|
-
SignDocumentRequest: {
|
|
14181
|
-
signer: components['schemas']['SignerDetails'];
|
|
14182
|
-
/** @description Omit for the bottom of the last page */
|
|
14183
|
-
appearance?: components['schemas']['SignatureAppearance'] | null;
|
|
14184
|
-
/** Timestamp */
|
|
14185
|
-
timestamp: number;
|
|
14186
|
-
/**
|
|
14187
|
-
* Signature
|
|
14188
|
-
* @description Ed25519 signature (base64) of the prepared statement
|
|
14189
|
-
*/
|
|
14190
|
-
signature: string;
|
|
14191
|
-
};
|
|
14192
|
-
/** SignDocumentResponse */
|
|
14193
|
-
SignDocumentResponse: {
|
|
14194
|
-
/** Signed Doc Ext Id */
|
|
14195
|
-
signed_doc_ext_id: string;
|
|
14196
|
-
signature: components['schemas']['SignatureRecord'];
|
|
14197
|
-
};
|
|
14198
|
-
/**
|
|
14199
|
-
* SignatureAppearance
|
|
14200
|
-
* @description Where the visible signature goes. Coordinates are fractions of the page, origin top-left.
|
|
14201
|
-
*/
|
|
14202
|
-
SignatureAppearance: {
|
|
14203
|
-
/**
|
|
14204
|
-
* Page
|
|
14205
|
-
* @description 0-based page index; negative counts from the end (-1 = last page)
|
|
14206
|
-
* @default -1
|
|
14207
|
-
*/
|
|
14208
|
-
page: number;
|
|
14209
|
-
/**
|
|
14210
|
-
* X
|
|
14211
|
-
* @default 0.08
|
|
14212
|
-
*/
|
|
14213
|
-
x: number;
|
|
14214
|
-
/**
|
|
14215
|
-
* Y
|
|
14216
|
-
* @default 0.8
|
|
14217
|
-
*/
|
|
14218
|
-
y: number;
|
|
14219
|
-
/**
|
|
14220
|
-
* Width
|
|
14221
|
-
* @default 0.4
|
|
14222
|
-
*/
|
|
14223
|
-
width: number;
|
|
14224
|
-
/**
|
|
14225
|
-
* Height
|
|
14226
|
-
* @default 0.1
|
|
14227
|
-
*/
|
|
14228
|
-
height: number;
|
|
14229
|
-
};
|
|
14230
|
-
/** SignerDetails */
|
|
14231
|
-
SignerDetails: {
|
|
14232
|
-
/** Name */
|
|
14233
|
-
name: string;
|
|
14234
|
-
/**
|
|
14235
|
-
* Capacity
|
|
14236
|
-
* @description e.g. 'Partner', 'Solicitor'
|
|
14237
|
-
*/
|
|
14238
|
-
capacity?: string | null;
|
|
14239
|
-
/**
|
|
14240
|
-
* On Behalf Of
|
|
14241
|
-
* @description e.g. the firm's name
|
|
14242
|
-
*/
|
|
14243
|
-
on_behalf_of?: string | null;
|
|
14244
|
-
};
|
|
14245
|
-
/** SignatureRecord */
|
|
14246
|
-
SignatureRecord: {
|
|
14247
|
-
/** Reference */
|
|
14248
|
-
reference: string;
|
|
14249
|
-
/** Signer Email */
|
|
14250
|
-
signer_email: string;
|
|
14251
|
-
/** Intent */
|
|
14252
|
-
intent: string;
|
|
14253
|
-
/**
|
|
14254
|
-
* Source Doc Ext Id
|
|
14255
|
-
* @description The document that was signed
|
|
14256
|
-
*/
|
|
14257
|
-
source_doc_ext_id: string;
|
|
14258
|
-
/** Source Sha256 */
|
|
14259
|
-
source_sha256: string;
|
|
14260
|
-
/**
|
|
14261
|
-
* Signed At
|
|
14262
|
-
* Format: date-time
|
|
14263
|
-
*/
|
|
14264
|
-
signed_at: string;
|
|
14265
|
-
/**
|
|
14266
|
-
* Statement Valid
|
|
14267
|
-
* @description The signer's Ed25519 signature over the statement verifies
|
|
14268
|
-
*/
|
|
14269
|
-
statement_valid: boolean;
|
|
14270
|
-
};
|
|
14271
|
-
/** SignatureStatusResponse */
|
|
14272
|
-
SignatureStatusResponse: {
|
|
14273
|
-
/**
|
|
14274
|
-
* Signed
|
|
14275
|
-
* @description This document is a PDF signed and sealed by ARBI
|
|
14276
|
-
*/
|
|
14277
|
-
signed: boolean;
|
|
14278
|
-
/**
|
|
14279
|
-
* Intact
|
|
14280
|
-
* @description The seal verifies: nothing changed since signing
|
|
14281
|
-
*/
|
|
14282
|
-
intact: boolean;
|
|
14283
|
-
/**
|
|
14284
|
-
* Timestamped
|
|
14285
|
-
* @description The seal carries an RFC 3161 timestamp
|
|
14286
|
-
* @default false
|
|
14287
|
-
*/
|
|
14288
|
-
timestamped: boolean;
|
|
14289
|
-
/**
|
|
14290
|
-
* Signatures
|
|
14291
|
-
* @default []
|
|
14292
|
-
*/
|
|
14293
|
-
signatures: components['schemas']['SignatureRecord'][];
|
|
14294
|
-
};
|
|
14695
|
+
* owner offline. An explicit "I trust this agent's environment" opt-in, NOT the default.
|
|
14696
|
+
* @enum {string}
|
|
14697
|
+
*/
|
|
14698
|
+
src__models__work__AuthMode: 'run_now_temp' | 'scheduled_require_auth' | 'scheduled_permanent';
|
|
14699
|
+
/**
|
|
14700
|
+
* AuthMode
|
|
14701
|
+
* @description How a workflow's agent obtains the workspace key it needs to act (least privilege).
|
|
14702
|
+
*
|
|
14703
|
+
* NOTE: the same concept as ``src.models.work.AuthMode`` (work-core); the names and values are identical so
|
|
14704
|
+
* the two can be deduplicated.
|
|
14705
|
+
*
|
|
14706
|
+
* ``run_now_temp`` (default) — a person is present (Run): the run session is granted
|
|
14707
|
+
* from their own workspace key. No standing membership.
|
|
14708
|
+
* ``scheduled_require_auth`` — an unattended run parks (``pending_auth_request_id`` + a
|
|
14709
|
+
* ``workspace_access_request`` notification) until the owner grants a key.
|
|
14710
|
+
* ``scheduled_permanent`` — the agent holds a standing membership; the server derives the key at any time.
|
|
14711
|
+
* @enum {string}
|
|
14712
|
+
*/
|
|
14713
|
+
src__models__workflow__AuthMode: 'run_now_temp' | 'scheduled_require_auth' | 'scheduled_permanent';
|
|
14295
14714
|
};
|
|
14296
14715
|
responses: never;
|
|
14297
14716
|
parameters: never;
|
|
@@ -15530,12 +15949,259 @@ interface operations {
|
|
|
15530
15949
|
[name: string]: unknown;
|
|
15531
15950
|
};
|
|
15532
15951
|
content: {
|
|
15533
|
-
'application/json': components['schemas']['HTTPValidationError'];
|
|
15952
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
15953
|
+
};
|
|
15954
|
+
};
|
|
15955
|
+
};
|
|
15956
|
+
};
|
|
15957
|
+
remove_workspace_users: {
|
|
15958
|
+
parameters: {
|
|
15959
|
+
query?: never;
|
|
15960
|
+
header?: never;
|
|
15961
|
+
path?: never;
|
|
15962
|
+
cookie?: never;
|
|
15963
|
+
};
|
|
15964
|
+
requestBody: {
|
|
15965
|
+
content: {
|
|
15966
|
+
'application/json': components['schemas']['RemoveWorkspaceUsersRequest'];
|
|
15967
|
+
};
|
|
15968
|
+
};
|
|
15969
|
+
responses: {
|
|
15970
|
+
/** @description Successful Response */
|
|
15971
|
+
204: {
|
|
15972
|
+
headers: {
|
|
15973
|
+
[name: string]: unknown;
|
|
15974
|
+
};
|
|
15975
|
+
content?: never;
|
|
15976
|
+
};
|
|
15977
|
+
/** @description Validation Error */
|
|
15978
|
+
422: {
|
|
15979
|
+
headers: {
|
|
15980
|
+
[name: string]: unknown;
|
|
15981
|
+
};
|
|
15982
|
+
content: {
|
|
15983
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
15984
|
+
};
|
|
15985
|
+
};
|
|
15986
|
+
};
|
|
15987
|
+
};
|
|
15988
|
+
update_workspace_user_roles: {
|
|
15989
|
+
parameters: {
|
|
15990
|
+
query?: never;
|
|
15991
|
+
header?: never;
|
|
15992
|
+
path?: never;
|
|
15993
|
+
cookie?: never;
|
|
15994
|
+
};
|
|
15995
|
+
requestBody: {
|
|
15996
|
+
content: {
|
|
15997
|
+
'application/json': components['schemas']['UpdateWorkspaceUserRolesRequest'];
|
|
15998
|
+
};
|
|
15999
|
+
};
|
|
16000
|
+
responses: {
|
|
16001
|
+
/** @description Successful Response */
|
|
16002
|
+
200: {
|
|
16003
|
+
headers: {
|
|
16004
|
+
[name: string]: unknown;
|
|
16005
|
+
};
|
|
16006
|
+
content: {
|
|
16007
|
+
'application/json': components['schemas']['WorkspaceUserResponse'][];
|
|
16008
|
+
};
|
|
16009
|
+
};
|
|
16010
|
+
/** @description Validation Error */
|
|
16011
|
+
422: {
|
|
16012
|
+
headers: {
|
|
16013
|
+
[name: string]: unknown;
|
|
16014
|
+
};
|
|
16015
|
+
content: {
|
|
16016
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
16017
|
+
};
|
|
16018
|
+
};
|
|
16019
|
+
};
|
|
16020
|
+
};
|
|
16021
|
+
copy_workspace_data: {
|
|
16022
|
+
parameters: {
|
|
16023
|
+
query?: never;
|
|
16024
|
+
header?: never;
|
|
16025
|
+
path?: never;
|
|
16026
|
+
cookie?: never;
|
|
16027
|
+
};
|
|
16028
|
+
requestBody: {
|
|
16029
|
+
content: {
|
|
16030
|
+
'application/json': components['schemas']['CopyRequest'];
|
|
16031
|
+
};
|
|
16032
|
+
};
|
|
16033
|
+
responses: {
|
|
16034
|
+
/** @description Successful Response */
|
|
16035
|
+
200: {
|
|
16036
|
+
headers: {
|
|
16037
|
+
[name: string]: unknown;
|
|
16038
|
+
};
|
|
16039
|
+
content: {
|
|
16040
|
+
'application/json': components['schemas']['CopyResponse'];
|
|
16041
|
+
};
|
|
16042
|
+
};
|
|
16043
|
+
/** @description Validation Error */
|
|
16044
|
+
422: {
|
|
16045
|
+
headers: {
|
|
16046
|
+
[name: string]: unknown;
|
|
16047
|
+
};
|
|
16048
|
+
content: {
|
|
16049
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
16050
|
+
};
|
|
16051
|
+
};
|
|
16052
|
+
};
|
|
16053
|
+
};
|
|
16054
|
+
delete_workspaces: {
|
|
16055
|
+
parameters: {
|
|
16056
|
+
query?: never;
|
|
16057
|
+
header?: never;
|
|
16058
|
+
path?: never;
|
|
16059
|
+
cookie?: never;
|
|
16060
|
+
};
|
|
16061
|
+
requestBody: {
|
|
16062
|
+
content: {
|
|
16063
|
+
'application/json': components['schemas']['DeleteWorkspacesRequest'];
|
|
16064
|
+
};
|
|
16065
|
+
};
|
|
16066
|
+
responses: {
|
|
16067
|
+
/** @description Successful Response */
|
|
16068
|
+
204: {
|
|
16069
|
+
headers: {
|
|
16070
|
+
[name: string]: unknown;
|
|
16071
|
+
};
|
|
16072
|
+
content?: never;
|
|
16073
|
+
};
|
|
16074
|
+
/** @description Validation Error */
|
|
16075
|
+
422: {
|
|
16076
|
+
headers: {
|
|
16077
|
+
[name: string]: unknown;
|
|
16078
|
+
};
|
|
16079
|
+
content: {
|
|
16080
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
16081
|
+
};
|
|
16082
|
+
};
|
|
16083
|
+
};
|
|
16084
|
+
};
|
|
16085
|
+
update_workspace: {
|
|
16086
|
+
parameters: {
|
|
16087
|
+
query?: never;
|
|
16088
|
+
header?: never;
|
|
16089
|
+
path?: never;
|
|
16090
|
+
cookie?: never;
|
|
16091
|
+
};
|
|
16092
|
+
requestBody: {
|
|
16093
|
+
content: {
|
|
16094
|
+
'application/json': components['schemas']['WorkspaceUpdateRequest'];
|
|
16095
|
+
};
|
|
16096
|
+
};
|
|
16097
|
+
responses: {
|
|
16098
|
+
/** @description Successful Response */
|
|
16099
|
+
200: {
|
|
16100
|
+
headers: {
|
|
16101
|
+
[name: string]: unknown;
|
|
16102
|
+
};
|
|
16103
|
+
content: {
|
|
16104
|
+
'application/json': components['schemas']['WorkspaceResponse'];
|
|
16105
|
+
};
|
|
16106
|
+
};
|
|
16107
|
+
/** @description Validation Error */
|
|
16108
|
+
422: {
|
|
16109
|
+
headers: {
|
|
16110
|
+
[name: string]: unknown;
|
|
16111
|
+
};
|
|
16112
|
+
content: {
|
|
16113
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
16114
|
+
};
|
|
16115
|
+
};
|
|
16116
|
+
};
|
|
16117
|
+
};
|
|
16118
|
+
plan_workspace_transfer: {
|
|
16119
|
+
parameters: {
|
|
16120
|
+
query?: never;
|
|
16121
|
+
header?: never;
|
|
16122
|
+
path?: never;
|
|
16123
|
+
cookie?: never;
|
|
16124
|
+
};
|
|
16125
|
+
requestBody: {
|
|
16126
|
+
content: {
|
|
16127
|
+
'application/json': components['schemas']['TransferPlanRequest'];
|
|
16128
|
+
};
|
|
16129
|
+
};
|
|
16130
|
+
responses: {
|
|
16131
|
+
/** @description Successful Response */
|
|
16132
|
+
200: {
|
|
16133
|
+
headers: {
|
|
16134
|
+
[name: string]: unknown;
|
|
16135
|
+
};
|
|
16136
|
+
content: {
|
|
16137
|
+
'application/json': components['schemas']['TransferPlanResponse'];
|
|
16138
|
+
};
|
|
16139
|
+
};
|
|
16140
|
+
/** @description Validation Error */
|
|
16141
|
+
422: {
|
|
16142
|
+
headers: {
|
|
16143
|
+
[name: string]: unknown;
|
|
16144
|
+
};
|
|
16145
|
+
content: {
|
|
16146
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
16147
|
+
};
|
|
16148
|
+
};
|
|
16149
|
+
};
|
|
16150
|
+
};
|
|
16151
|
+
export_workspace_data: {
|
|
16152
|
+
parameters: {
|
|
16153
|
+
query?: never;
|
|
16154
|
+
header?: never;
|
|
16155
|
+
path?: never;
|
|
16156
|
+
cookie?: never;
|
|
16157
|
+
};
|
|
16158
|
+
requestBody: {
|
|
16159
|
+
content: {
|
|
16160
|
+
'application/json': components['schemas']['WorkspaceExportRequest'];
|
|
16161
|
+
};
|
|
16162
|
+
};
|
|
16163
|
+
responses: {
|
|
16164
|
+
/** @description Successful Response */
|
|
16165
|
+
200: {
|
|
16166
|
+
headers: {
|
|
16167
|
+
[name: string]: unknown;
|
|
16168
|
+
};
|
|
16169
|
+
content: {
|
|
16170
|
+
'application/json': components['schemas']['WorkspaceExportResponse'];
|
|
16171
|
+
};
|
|
16172
|
+
};
|
|
16173
|
+
/** @description Validation Error */
|
|
16174
|
+
422: {
|
|
16175
|
+
headers: {
|
|
16176
|
+
[name: string]: unknown;
|
|
16177
|
+
};
|
|
16178
|
+
content: {
|
|
16179
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
16180
|
+
};
|
|
16181
|
+
};
|
|
16182
|
+
};
|
|
16183
|
+
};
|
|
16184
|
+
list_workspace_transfers: {
|
|
16185
|
+
parameters: {
|
|
16186
|
+
query?: never;
|
|
16187
|
+
header?: never;
|
|
16188
|
+
path?: never;
|
|
16189
|
+
cookie?: never;
|
|
16190
|
+
};
|
|
16191
|
+
requestBody?: never;
|
|
16192
|
+
responses: {
|
|
16193
|
+
/** @description Successful Response */
|
|
16194
|
+
200: {
|
|
16195
|
+
headers: {
|
|
16196
|
+
[name: string]: unknown;
|
|
16197
|
+
};
|
|
16198
|
+
content: {
|
|
16199
|
+
'application/json': components['schemas']['TransferStatusResponse'][];
|
|
15534
16200
|
};
|
|
15535
16201
|
};
|
|
15536
16202
|
};
|
|
15537
16203
|
};
|
|
15538
|
-
|
|
16204
|
+
start_workspace_transfer: {
|
|
15539
16205
|
parameters: {
|
|
15540
16206
|
query?: never;
|
|
15541
16207
|
header?: never;
|
|
@@ -15544,16 +16210,18 @@ interface operations {
|
|
|
15544
16210
|
};
|
|
15545
16211
|
requestBody: {
|
|
15546
16212
|
content: {
|
|
15547
|
-
'application/json': components['schemas']['
|
|
16213
|
+
'application/json': components['schemas']['TransferStartRequest'];
|
|
15548
16214
|
};
|
|
15549
16215
|
};
|
|
15550
16216
|
responses: {
|
|
15551
16217
|
/** @description Successful Response */
|
|
15552
|
-
|
|
16218
|
+
202: {
|
|
15553
16219
|
headers: {
|
|
15554
16220
|
[name: string]: unknown;
|
|
15555
16221
|
};
|
|
15556
|
-
content
|
|
16222
|
+
content: {
|
|
16223
|
+
'application/json': components['schemas']['TransferStatusResponse'];
|
|
16224
|
+
};
|
|
15557
16225
|
};
|
|
15558
16226
|
/** @description Validation Error */
|
|
15559
16227
|
422: {
|
|
@@ -15566,18 +16234,16 @@ interface operations {
|
|
|
15566
16234
|
};
|
|
15567
16235
|
};
|
|
15568
16236
|
};
|
|
15569
|
-
|
|
16237
|
+
get_workspace_transfer: {
|
|
15570
16238
|
parameters: {
|
|
15571
16239
|
query?: never;
|
|
15572
16240
|
header?: never;
|
|
15573
|
-
path
|
|
15574
|
-
|
|
15575
|
-
};
|
|
15576
|
-
requestBody: {
|
|
15577
|
-
content: {
|
|
15578
|
-
'application/json': components['schemas']['UpdateWorkspaceUserRolesRequest'];
|
|
16241
|
+
path: {
|
|
16242
|
+
transfer_ext_id: string;
|
|
15579
16243
|
};
|
|
16244
|
+
cookie?: never;
|
|
15580
16245
|
};
|
|
16246
|
+
requestBody?: never;
|
|
15581
16247
|
responses: {
|
|
15582
16248
|
/** @description Successful Response */
|
|
15583
16249
|
200: {
|
|
@@ -15585,7 +16251,7 @@ interface operations {
|
|
|
15585
16251
|
[name: string]: unknown;
|
|
15586
16252
|
};
|
|
15587
16253
|
content: {
|
|
15588
|
-
'application/json': components['schemas']['
|
|
16254
|
+
'application/json': components['schemas']['TransferStatusResponse'];
|
|
15589
16255
|
};
|
|
15590
16256
|
};
|
|
15591
16257
|
/** @description Validation Error */
|
|
@@ -15599,18 +16265,16 @@ interface operations {
|
|
|
15599
16265
|
};
|
|
15600
16266
|
};
|
|
15601
16267
|
};
|
|
15602
|
-
|
|
16268
|
+
list_workspace_transfer_items: {
|
|
15603
16269
|
parameters: {
|
|
15604
16270
|
query?: never;
|
|
15605
16271
|
header?: never;
|
|
15606
|
-
path
|
|
15607
|
-
|
|
15608
|
-
};
|
|
15609
|
-
requestBody: {
|
|
15610
|
-
content: {
|
|
15611
|
-
'application/json': components['schemas']['CopyRequest'];
|
|
16272
|
+
path: {
|
|
16273
|
+
transfer_ext_id: string;
|
|
15612
16274
|
};
|
|
16275
|
+
cookie?: never;
|
|
15613
16276
|
};
|
|
16277
|
+
requestBody?: never;
|
|
15614
16278
|
responses: {
|
|
15615
16279
|
/** @description Successful Response */
|
|
15616
16280
|
200: {
|
|
@@ -15618,7 +16282,7 @@ interface operations {
|
|
|
15618
16282
|
[name: string]: unknown;
|
|
15619
16283
|
};
|
|
15620
16284
|
content: {
|
|
15621
|
-
'application/json': components['schemas']['
|
|
16285
|
+
'application/json': components['schemas']['TransferItemResult'][];
|
|
15622
16286
|
};
|
|
15623
16287
|
};
|
|
15624
16288
|
/** @description Validation Error */
|
|
@@ -15632,25 +16296,29 @@ interface operations {
|
|
|
15632
16296
|
};
|
|
15633
16297
|
};
|
|
15634
16298
|
};
|
|
15635
|
-
|
|
16299
|
+
resume_workspace_transfer: {
|
|
15636
16300
|
parameters: {
|
|
15637
16301
|
query?: never;
|
|
15638
16302
|
header?: never;
|
|
15639
|
-
path
|
|
16303
|
+
path: {
|
|
16304
|
+
transfer_ext_id: string;
|
|
16305
|
+
};
|
|
15640
16306
|
cookie?: never;
|
|
15641
16307
|
};
|
|
15642
16308
|
requestBody: {
|
|
15643
16309
|
content: {
|
|
15644
|
-
'application/json': components['schemas']['
|
|
16310
|
+
'application/json': components['schemas']['TransferResumeRequest'];
|
|
15645
16311
|
};
|
|
15646
16312
|
};
|
|
15647
16313
|
responses: {
|
|
15648
16314
|
/** @description Successful Response */
|
|
15649
|
-
|
|
16315
|
+
202: {
|
|
15650
16316
|
headers: {
|
|
15651
16317
|
[name: string]: unknown;
|
|
15652
16318
|
};
|
|
15653
|
-
content
|
|
16319
|
+
content: {
|
|
16320
|
+
'application/json': components['schemas']['TransferStatusResponse'];
|
|
16321
|
+
};
|
|
15654
16322
|
};
|
|
15655
16323
|
/** @description Validation Error */
|
|
15656
16324
|
422: {
|
|
@@ -15663,18 +16331,16 @@ interface operations {
|
|
|
15663
16331
|
};
|
|
15664
16332
|
};
|
|
15665
16333
|
};
|
|
15666
|
-
|
|
16334
|
+
cancel_workspace_transfer: {
|
|
15667
16335
|
parameters: {
|
|
15668
16336
|
query?: never;
|
|
15669
16337
|
header?: never;
|
|
15670
|
-
path
|
|
15671
|
-
|
|
15672
|
-
};
|
|
15673
|
-
requestBody: {
|
|
15674
|
-
content: {
|
|
15675
|
-
'application/json': components['schemas']['WorkspaceUpdateRequest'];
|
|
16338
|
+
path: {
|
|
16339
|
+
transfer_ext_id: string;
|
|
15676
16340
|
};
|
|
16341
|
+
cookie?: never;
|
|
15677
16342
|
};
|
|
16343
|
+
requestBody?: never;
|
|
15678
16344
|
responses: {
|
|
15679
16345
|
/** @description Successful Response */
|
|
15680
16346
|
200: {
|
|
@@ -15682,7 +16348,7 @@ interface operations {
|
|
|
15682
16348
|
[name: string]: unknown;
|
|
15683
16349
|
};
|
|
15684
16350
|
content: {
|
|
15685
|
-
'application/json': components['schemas']['
|
|
16351
|
+
'application/json': components['schemas']['TransferStatusResponse'];
|
|
15686
16352
|
};
|
|
15687
16353
|
};
|
|
15688
16354
|
/** @description Validation Error */
|
|
@@ -16326,11 +16992,11 @@ interface operations {
|
|
|
16326
16992
|
config_ext_id?: string | null;
|
|
16327
16993
|
/** @description Upload a single file as the next version of this document (any of its versions). It becomes the current version and takes the document's sharing, folder and labels. */
|
|
16328
16994
|
version_of?: string | null;
|
|
16329
|
-
/** @description A new, separate document made from this one (
|
|
16330
|
-
derived_from?: string | null;
|
|
16995
|
+
/** @description A new, separate document made from this one (a crop, a redacted copy) or, repeated, from several (a production set); recorded as provenance only */
|
|
16996
|
+
derived_from?: string[] | null;
|
|
16331
16997
|
/** @description How it was made from `derived_from` */
|
|
16332
|
-
derived_role?: ('crop' | 'redline_base' | 'redline_revised') | null;
|
|
16333
|
-
/** @description Work product type: source, skill,
|
|
16998
|
+
derived_role?: ('crop' | 'redline_base' | 'redline_revised' | 'redaction' | 'annotated' | 'production') | null;
|
|
16999
|
+
/** @description Work product type: source, skill, artifact */
|
|
16334
17000
|
wp_type?: string | null;
|
|
16335
17001
|
/** @description Tag to link the document to */
|
|
16336
17002
|
tag_ext_id?: string | null;
|
|
@@ -16668,6 +17334,107 @@ interface operations {
|
|
|
16668
17334
|
};
|
|
16669
17335
|
};
|
|
16670
17336
|
};
|
|
17337
|
+
prepare_document_signature: {
|
|
17338
|
+
parameters: {
|
|
17339
|
+
query?: never;
|
|
17340
|
+
header?: never;
|
|
17341
|
+
path: {
|
|
17342
|
+
document_ext_id: string;
|
|
17343
|
+
};
|
|
17344
|
+
cookie?: never;
|
|
17345
|
+
};
|
|
17346
|
+
requestBody: {
|
|
17347
|
+
content: {
|
|
17348
|
+
'application/json': components['schemas']['PrepareSignatureRequest'];
|
|
17349
|
+
};
|
|
17350
|
+
};
|
|
17351
|
+
responses: {
|
|
17352
|
+
/** @description Successful Response */
|
|
17353
|
+
200: {
|
|
17354
|
+
headers: {
|
|
17355
|
+
[name: string]: unknown;
|
|
17356
|
+
};
|
|
17357
|
+
content: {
|
|
17358
|
+
'application/json': components['schemas']['PrepareSignatureResponse'];
|
|
17359
|
+
};
|
|
17360
|
+
};
|
|
17361
|
+
/** @description Validation Error */
|
|
17362
|
+
422: {
|
|
17363
|
+
headers: {
|
|
17364
|
+
[name: string]: unknown;
|
|
17365
|
+
};
|
|
17366
|
+
content: {
|
|
17367
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
17368
|
+
};
|
|
17369
|
+
};
|
|
17370
|
+
};
|
|
17371
|
+
};
|
|
17372
|
+
sign_document: {
|
|
17373
|
+
parameters: {
|
|
17374
|
+
query?: never;
|
|
17375
|
+
header?: never;
|
|
17376
|
+
path: {
|
|
17377
|
+
document_ext_id: string;
|
|
17378
|
+
};
|
|
17379
|
+
cookie?: never;
|
|
17380
|
+
};
|
|
17381
|
+
requestBody: {
|
|
17382
|
+
content: {
|
|
17383
|
+
'application/json': components['schemas']['SignDocumentRequest'];
|
|
17384
|
+
};
|
|
17385
|
+
};
|
|
17386
|
+
responses: {
|
|
17387
|
+
/** @description Successful Response */
|
|
17388
|
+
200: {
|
|
17389
|
+
headers: {
|
|
17390
|
+
[name: string]: unknown;
|
|
17391
|
+
};
|
|
17392
|
+
content: {
|
|
17393
|
+
'application/json': components['schemas']['SignDocumentResponse'];
|
|
17394
|
+
};
|
|
17395
|
+
};
|
|
17396
|
+
/** @description Validation Error */
|
|
17397
|
+
422: {
|
|
17398
|
+
headers: {
|
|
17399
|
+
[name: string]: unknown;
|
|
17400
|
+
};
|
|
17401
|
+
content: {
|
|
17402
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
17403
|
+
};
|
|
17404
|
+
};
|
|
17405
|
+
};
|
|
17406
|
+
};
|
|
17407
|
+
get_document_signature_status: {
|
|
17408
|
+
parameters: {
|
|
17409
|
+
query?: never;
|
|
17410
|
+
header?: never;
|
|
17411
|
+
path: {
|
|
17412
|
+
document_ext_id: string;
|
|
17413
|
+
};
|
|
17414
|
+
cookie?: never;
|
|
17415
|
+
};
|
|
17416
|
+
requestBody?: never;
|
|
17417
|
+
responses: {
|
|
17418
|
+
/** @description Successful Response */
|
|
17419
|
+
200: {
|
|
17420
|
+
headers: {
|
|
17421
|
+
[name: string]: unknown;
|
|
17422
|
+
};
|
|
17423
|
+
content: {
|
|
17424
|
+
'application/json': components['schemas']['SignatureStatusResponse'];
|
|
17425
|
+
};
|
|
17426
|
+
};
|
|
17427
|
+
/** @description Validation Error */
|
|
17428
|
+
422: {
|
|
17429
|
+
headers: {
|
|
17430
|
+
[name: string]: unknown;
|
|
17431
|
+
};
|
|
17432
|
+
content: {
|
|
17433
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
17434
|
+
};
|
|
17435
|
+
};
|
|
17436
|
+
};
|
|
17437
|
+
};
|
|
16671
17438
|
list_conversations: {
|
|
16672
17439
|
parameters: {
|
|
16673
17440
|
query?: never;
|
|
@@ -20986,107 +21753,6 @@ interface operations {
|
|
|
20986
21753
|
};
|
|
20987
21754
|
};
|
|
20988
21755
|
};
|
|
20989
|
-
prepare_document_signature: {
|
|
20990
|
-
parameters: {
|
|
20991
|
-
query?: never;
|
|
20992
|
-
header?: never;
|
|
20993
|
-
path: {
|
|
20994
|
-
document_ext_id: string;
|
|
20995
|
-
};
|
|
20996
|
-
cookie?: never;
|
|
20997
|
-
};
|
|
20998
|
-
requestBody: {
|
|
20999
|
-
content: {
|
|
21000
|
-
'application/json': components['schemas']['PrepareSignatureRequest'];
|
|
21001
|
-
};
|
|
21002
|
-
};
|
|
21003
|
-
responses: {
|
|
21004
|
-
/** @description Successful Response */
|
|
21005
|
-
200: {
|
|
21006
|
-
headers: {
|
|
21007
|
-
[name: string]: unknown;
|
|
21008
|
-
};
|
|
21009
|
-
content: {
|
|
21010
|
-
'application/json': components['schemas']['PrepareSignatureResponse'];
|
|
21011
|
-
};
|
|
21012
|
-
};
|
|
21013
|
-
/** @description Validation Error */
|
|
21014
|
-
422: {
|
|
21015
|
-
headers: {
|
|
21016
|
-
[name: string]: unknown;
|
|
21017
|
-
};
|
|
21018
|
-
content: {
|
|
21019
|
-
'application/json': components['schemas']['HTTPValidationError'];
|
|
21020
|
-
};
|
|
21021
|
-
};
|
|
21022
|
-
};
|
|
21023
|
-
};
|
|
21024
|
-
sign_document: {
|
|
21025
|
-
parameters: {
|
|
21026
|
-
query?: never;
|
|
21027
|
-
header?: never;
|
|
21028
|
-
path: {
|
|
21029
|
-
document_ext_id: string;
|
|
21030
|
-
};
|
|
21031
|
-
cookie?: never;
|
|
21032
|
-
};
|
|
21033
|
-
requestBody: {
|
|
21034
|
-
content: {
|
|
21035
|
-
'application/json': components['schemas']['SignDocumentRequest'];
|
|
21036
|
-
};
|
|
21037
|
-
};
|
|
21038
|
-
responses: {
|
|
21039
|
-
/** @description Successful Response */
|
|
21040
|
-
200: {
|
|
21041
|
-
headers: {
|
|
21042
|
-
[name: string]: unknown;
|
|
21043
|
-
};
|
|
21044
|
-
content: {
|
|
21045
|
-
'application/json': components['schemas']['SignDocumentResponse'];
|
|
21046
|
-
};
|
|
21047
|
-
};
|
|
21048
|
-
/** @description Validation Error */
|
|
21049
|
-
422: {
|
|
21050
|
-
headers: {
|
|
21051
|
-
[name: string]: unknown;
|
|
21052
|
-
};
|
|
21053
|
-
content: {
|
|
21054
|
-
'application/json': components['schemas']['HTTPValidationError'];
|
|
21055
|
-
};
|
|
21056
|
-
};
|
|
21057
|
-
};
|
|
21058
|
-
};
|
|
21059
|
-
get_document_signature_status: {
|
|
21060
|
-
parameters: {
|
|
21061
|
-
query?: never;
|
|
21062
|
-
header?: never;
|
|
21063
|
-
path: {
|
|
21064
|
-
document_ext_id: string;
|
|
21065
|
-
};
|
|
21066
|
-
cookie?: never;
|
|
21067
|
-
};
|
|
21068
|
-
requestBody?: never;
|
|
21069
|
-
responses: {
|
|
21070
|
-
/** @description Successful Response */
|
|
21071
|
-
200: {
|
|
21072
|
-
headers: {
|
|
21073
|
-
[name: string]: unknown;
|
|
21074
|
-
};
|
|
21075
|
-
content: {
|
|
21076
|
-
'application/json': components['schemas']['SignatureStatusResponse'];
|
|
21077
|
-
};
|
|
21078
|
-
};
|
|
21079
|
-
/** @description Validation Error */
|
|
21080
|
-
422: {
|
|
21081
|
-
headers: {
|
|
21082
|
-
[name: string]: unknown;
|
|
21083
|
-
};
|
|
21084
|
-
content: {
|
|
21085
|
-
'application/json': components['schemas']['HTTPValidationError'];
|
|
21086
|
-
};
|
|
21087
|
-
};
|
|
21088
|
-
};
|
|
21089
|
-
};
|
|
21090
21756
|
}
|
|
21091
21757
|
|
|
21092
21758
|
/**
|