@arbidocs/client 0.4.63 → 0.4.65
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 +548 -35
- package/dist/index.d.ts +548 -35
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1021,7 +1021,7 @@ interface paths {
|
|
|
1021
1021
|
* @description The decrypted structured data of a scope, plus the document files to fetch for a download.
|
|
1022
1022
|
*
|
|
1023
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
|
|
1024
|
+
* version to fetch through ``/v1/document/{doc_ext_id}/download?version={version}`` and store at
|
|
1025
1025
|
* ``path`` (current versions under ``documents/``, older ones under
|
|
1026
1026
|
* ``documents/_versions/``).
|
|
1027
1027
|
*/
|
|
@@ -1298,7 +1298,10 @@ interface paths {
|
|
|
1298
1298
|
path?: never;
|
|
1299
1299
|
cookie?: never;
|
|
1300
1300
|
};
|
|
1301
|
-
/**
|
|
1301
|
+
/**
|
|
1302
|
+
* Native Content
|
|
1303
|
+
* @description The document as DOCX — its current version, or ``version`` (a read-only snapshot).
|
|
1304
|
+
*/
|
|
1302
1305
|
get: operations['native_content_v1_editor__document_id__content_get'];
|
|
1303
1306
|
put?: never;
|
|
1304
1307
|
post?: never;
|
|
@@ -1319,10 +1322,11 @@ interface paths {
|
|
|
1319
1322
|
put?: never;
|
|
1320
1323
|
/**
|
|
1321
1324
|
* Create Word Redline
|
|
1322
|
-
* @description Compare two
|
|
1325
|
+
* @description Compare two document versions into a NEW redline document (base -> revised).
|
|
1323
1326
|
*
|
|
1324
|
-
* Without ``base_ext_id`` the base is the revised document's
|
|
1325
|
-
* The redline records both inputs
|
|
1327
|
+
* Without ``base_ext_id`` the base is the revised document's version before the
|
|
1328
|
+
* one compared. The redline records both inputs (document and version) as
|
|
1329
|
+
* provenance and is shared only if both documents are.
|
|
1326
1330
|
*/
|
|
1327
1331
|
post: operations['create_word_redline_v1_editor_redline_post'];
|
|
1328
1332
|
delete?: never;
|
|
@@ -1443,10 +1447,11 @@ interface paths {
|
|
|
1443
1447
|
};
|
|
1444
1448
|
/**
|
|
1445
1449
|
* List Document Versions
|
|
1446
|
-
* @description Every version of the document ``
|
|
1450
|
+
* @description Every version of the document, oldest first; ``is_current`` marks the current one.
|
|
1447
1451
|
*
|
|
1448
|
-
*
|
|
1449
|
-
*
|
|
1452
|
+
* A document keeps one id for its whole life: an older version is opened with
|
|
1453
|
+
* ``?version=n`` on the view / download / parsed / signature endpoints, and
|
|
1454
|
+
* retrieval asks about it as ``doc-…@v{n}``.
|
|
1450
1455
|
*/
|
|
1451
1456
|
get: operations['list_document_versions'];
|
|
1452
1457
|
put?: never;
|
|
@@ -1619,7 +1624,7 @@ interface paths {
|
|
|
1619
1624
|
};
|
|
1620
1625
|
/**
|
|
1621
1626
|
* Download Document
|
|
1622
|
-
* @description Download a document by its external ID.
|
|
1627
|
+
* @description Download a document (its original file) by its external ID — ``version`` for an older version.
|
|
1623
1628
|
* Retrieves and decrypts the document for downloading as an attachment.
|
|
1624
1629
|
*/
|
|
1625
1630
|
get: operations['download_document'];
|
|
@@ -1784,7 +1789,8 @@ interface paths {
|
|
|
1784
1789
|
put?: never;
|
|
1785
1790
|
/**
|
|
1786
1791
|
* Sign Document
|
|
1787
|
-
* @description Sign a document: verify the signer's statement, seal a signed copy, save it as
|
|
1792
|
+
* @description Sign a document: verify the signer's statement, seal a signed copy, save it as the document's next
|
|
1793
|
+
* version (reason ``signed``; the document keeps its id).
|
|
1788
1794
|
*/
|
|
1789
1795
|
post: operations['sign_document'];
|
|
1790
1796
|
delete?: never;
|
|
@@ -1802,7 +1808,7 @@ interface paths {
|
|
|
1802
1808
|
};
|
|
1803
1809
|
/**
|
|
1804
1810
|
* Get Document Signature Status
|
|
1805
|
-
* @description Is this document a signed copy, and is it unchanged since signing? Read from the PDF itself.
|
|
1811
|
+
* @description Is this document version a signed copy, and is it unchanged since signing? Read from the PDF itself.
|
|
1806
1812
|
*/
|
|
1807
1813
|
get: operations['get_document_signature_status'];
|
|
1808
1814
|
put?: never;
|
|
@@ -1813,6 +1819,56 @@ interface paths {
|
|
|
1813
1819
|
patch?: never;
|
|
1814
1820
|
trace?: never;
|
|
1815
1821
|
};
|
|
1822
|
+
'/v1/document/{document_ext_id}/markup': {
|
|
1823
|
+
parameters: {
|
|
1824
|
+
query?: never;
|
|
1825
|
+
header?: never;
|
|
1826
|
+
path?: never;
|
|
1827
|
+
cookie?: never;
|
|
1828
|
+
};
|
|
1829
|
+
/**
|
|
1830
|
+
* Get Document Markup
|
|
1831
|
+
* @description The version's marks and their revision (0 = no markup yet). Anyone who can see the document
|
|
1832
|
+
* can read them; ``can_edit`` says whether the caller may save.
|
|
1833
|
+
*/
|
|
1834
|
+
get: operations['get_document_markup'];
|
|
1835
|
+
/**
|
|
1836
|
+
* Save Document Markup
|
|
1837
|
+
* @description Save the version's whole layer, overwriting its markup in place.
|
|
1838
|
+
*
|
|
1839
|
+
* Optimistic concurrency: the save must name the revision it started from (``If-Match`` or
|
|
1840
|
+
* ``base_revision``). When someone saved in between, nothing is written and the 409 carries the
|
|
1841
|
+
* latest revision: the client re-reads it, merges by annotation id and saves again.
|
|
1842
|
+
*/
|
|
1843
|
+
put: operations['save_document_markup'];
|
|
1844
|
+
post?: never;
|
|
1845
|
+
delete?: never;
|
|
1846
|
+
options?: never;
|
|
1847
|
+
head?: never;
|
|
1848
|
+
patch?: never;
|
|
1849
|
+
trace?: never;
|
|
1850
|
+
};
|
|
1851
|
+
'/v1/document/{document_ext_id}/markup/pdf': {
|
|
1852
|
+
parameters: {
|
|
1853
|
+
query?: never;
|
|
1854
|
+
header?: never;
|
|
1855
|
+
path?: never;
|
|
1856
|
+
cookie?: never;
|
|
1857
|
+
};
|
|
1858
|
+
/**
|
|
1859
|
+
* Download Document Markup
|
|
1860
|
+
* @description "Download with markup": the version's PDF with its annotations as native PDF annotations
|
|
1861
|
+
* (Acrobat, Preview and other viewers show them). The plain download serves the original.
|
|
1862
|
+
*/
|
|
1863
|
+
get: operations['download_document_markup'];
|
|
1864
|
+
put?: never;
|
|
1865
|
+
post?: never;
|
|
1866
|
+
delete?: never;
|
|
1867
|
+
options?: never;
|
|
1868
|
+
head?: never;
|
|
1869
|
+
patch?: never;
|
|
1870
|
+
trace?: never;
|
|
1871
|
+
};
|
|
1816
1872
|
'/v1/conversation/list': {
|
|
1817
1873
|
parameters: {
|
|
1818
1874
|
query?: never;
|
|
@@ -5941,13 +5997,13 @@ interface components {
|
|
|
5941
5997
|
is_complete: boolean;
|
|
5942
5998
|
/**
|
|
5943
5999
|
* Version
|
|
5944
|
-
* @description
|
|
6000
|
+
* @description The document version this artifact was saved as (1 for a new artifact)
|
|
5945
6001
|
* @default 1
|
|
5946
6002
|
*/
|
|
5947
6003
|
version: number;
|
|
5948
6004
|
/**
|
|
5949
6005
|
* Version Of
|
|
5950
|
-
* @description
|
|
6006
|
+
* @description Set when this artifact updates an existing document: that document (equal to doc_ext_id — the update is saved as its next version, same id)
|
|
5951
6007
|
*/
|
|
5952
6008
|
version_of?: string | null;
|
|
5953
6009
|
/**
|
|
@@ -6105,6 +6161,29 @@ interface components {
|
|
|
6105
6161
|
/** Audio */
|
|
6106
6162
|
audio: string;
|
|
6107
6163
|
};
|
|
6164
|
+
/** BoxMark */
|
|
6165
|
+
BoxMark: {
|
|
6166
|
+
/** Id */
|
|
6167
|
+
id: string;
|
|
6168
|
+
/** Page */
|
|
6169
|
+
page: number;
|
|
6170
|
+
/** Author */
|
|
6171
|
+
author: string;
|
|
6172
|
+
/** Createdat */
|
|
6173
|
+
createdAt: string;
|
|
6174
|
+
/** Updatedat */
|
|
6175
|
+
updatedAt: string;
|
|
6176
|
+
/**
|
|
6177
|
+
* @description discriminator enum property added by openapi-typescript
|
|
6178
|
+
* @enum {string}
|
|
6179
|
+
*/
|
|
6180
|
+
kind: 'box';
|
|
6181
|
+
rect: components['schemas']['MarkupRect'];
|
|
6182
|
+
/** Color */
|
|
6183
|
+
color: string;
|
|
6184
|
+
/** Strokewidth */
|
|
6185
|
+
strokeWidth: number;
|
|
6186
|
+
};
|
|
6108
6187
|
/**
|
|
6109
6188
|
* CalendarRead
|
|
6110
6189
|
* @description A selectable calendar in the picker.
|
|
@@ -6283,6 +6362,8 @@ interface components {
|
|
|
6283
6362
|
workspace_ext_id?: string | null;
|
|
6284
6363
|
/** Doc Ext Id */
|
|
6285
6364
|
doc_ext_id?: string | null;
|
|
6365
|
+
/** Doc Version */
|
|
6366
|
+
doc_version?: number | null;
|
|
6286
6367
|
/** Doc Title */
|
|
6287
6368
|
doc_title?: string | null;
|
|
6288
6369
|
/** Chunk Id */
|
|
@@ -6398,6 +6479,8 @@ interface components {
|
|
|
6398
6479
|
CitedDocument: {
|
|
6399
6480
|
/** Doc Ext Id */
|
|
6400
6481
|
doc_ext_id: string;
|
|
6482
|
+
/** Version */
|
|
6483
|
+
version?: number | null;
|
|
6401
6484
|
/** Chunks */
|
|
6402
6485
|
chunks?: components['schemas']['CitedChunk'][];
|
|
6403
6486
|
};
|
|
@@ -6509,6 +6592,34 @@ interface components {
|
|
|
6509
6592
|
/** Commands */
|
|
6510
6593
|
commands: components['schemas']['CommandDescriptorResponse'][];
|
|
6511
6594
|
};
|
|
6595
|
+
/** CommentMark */
|
|
6596
|
+
CommentMark: {
|
|
6597
|
+
/** Id */
|
|
6598
|
+
id: string;
|
|
6599
|
+
/** Page */
|
|
6600
|
+
page: number;
|
|
6601
|
+
/** Author */
|
|
6602
|
+
author: string;
|
|
6603
|
+
/** Createdat */
|
|
6604
|
+
createdAt: string;
|
|
6605
|
+
/** Updatedat */
|
|
6606
|
+
updatedAt: string;
|
|
6607
|
+
/**
|
|
6608
|
+
* @description discriminator enum property added by openapi-typescript
|
|
6609
|
+
* @enum {string}
|
|
6610
|
+
*/
|
|
6611
|
+
kind: 'comment';
|
|
6612
|
+
rect: components['schemas']['MarkupRect'];
|
|
6613
|
+
/** Body */
|
|
6614
|
+
body: string;
|
|
6615
|
+
/** Replies */
|
|
6616
|
+
replies?: components['schemas']['MarkupReply'][];
|
|
6617
|
+
/**
|
|
6618
|
+
* Resolved
|
|
6619
|
+
* @default false
|
|
6620
|
+
*/
|
|
6621
|
+
resolved: boolean;
|
|
6622
|
+
};
|
|
6512
6623
|
/**
|
|
6513
6624
|
* CompactionEvent
|
|
6514
6625
|
* @description Emitted when the thread was compacted this turn.
|
|
@@ -7595,12 +7706,16 @@ interface components {
|
|
|
7595
7706
|
};
|
|
7596
7707
|
/**
|
|
7597
7708
|
* DerivedFrom
|
|
7598
|
-
* @description One provenance link of a document: it was made from ``
|
|
7709
|
+
* @description One provenance link of a document: it was made from version ``version`` of
|
|
7710
|
+
* ``doc_ext_id`` as ``role``. ``version`` is None only for links whose version was
|
|
7711
|
+
* never recorded.
|
|
7599
7712
|
*/
|
|
7600
7713
|
DerivedFrom: {
|
|
7601
7714
|
/** Doc Ext Id */
|
|
7602
7715
|
doc_ext_id: string;
|
|
7603
7716
|
role: components['schemas']['DocRelationRole'];
|
|
7717
|
+
/** Version */
|
|
7718
|
+
version?: number | null;
|
|
7604
7719
|
};
|
|
7605
7720
|
/**
|
|
7606
7721
|
* DmAttachmentUploadResponse
|
|
@@ -7631,9 +7746,11 @@ interface components {
|
|
|
7631
7746
|
/**
|
|
7632
7747
|
* DocRelationRole
|
|
7633
7748
|
* @description How ``from_doc`` was derived from ``to_doc`` (provenance only, no behaviour).
|
|
7749
|
+
*
|
|
7750
|
+
* Versions are not relations: they live inside their document (``docs.versions``).
|
|
7634
7751
|
* @enum {string}
|
|
7635
7752
|
*/
|
|
7636
|
-
DocRelationRole: '
|
|
7753
|
+
DocRelationRole: 'crop' | 'redline_base' | 'redline_revised' | 'redaction' | 'annotated' | 'production';
|
|
7637
7754
|
/** DocResponse */
|
|
7638
7755
|
DocResponse: {
|
|
7639
7756
|
/** External Id */
|
|
@@ -7672,18 +7789,16 @@ interface components {
|
|
|
7672
7789
|
config_ext_id?: string | null;
|
|
7673
7790
|
/** Parent Ext Id */
|
|
7674
7791
|
parent_ext_id?: string | null;
|
|
7675
|
-
/** Lineage Id */
|
|
7676
|
-
lineage_id?: string | null;
|
|
7677
7792
|
/**
|
|
7678
|
-
* Version
|
|
7793
|
+
* Current Version
|
|
7679
7794
|
* @default 1
|
|
7680
7795
|
*/
|
|
7681
|
-
|
|
7796
|
+
current_version: number;
|
|
7682
7797
|
/**
|
|
7683
|
-
*
|
|
7684
|
-
* @default
|
|
7798
|
+
* Versions
|
|
7799
|
+
* @default []
|
|
7685
7800
|
*/
|
|
7686
|
-
|
|
7801
|
+
versions: components['schemas']['DocVersion'][];
|
|
7687
7802
|
/** Thread Id */
|
|
7688
7803
|
thread_id?: string | null;
|
|
7689
7804
|
/**
|
|
@@ -7810,6 +7925,55 @@ interface components {
|
|
|
7810
7925
|
*/
|
|
7811
7926
|
config_ext_id?: string | null;
|
|
7812
7927
|
};
|
|
7928
|
+
/**
|
|
7929
|
+
* DocVersion
|
|
7930
|
+
* @description One version of a document (``GET /v1/document/{id}/versions`` and ``DocResponse.versions``).
|
|
7931
|
+
*/
|
|
7932
|
+
DocVersion: {
|
|
7933
|
+
/** N */
|
|
7934
|
+
n: number;
|
|
7935
|
+
/** Created At */
|
|
7936
|
+
created_at?: string | null;
|
|
7937
|
+
/** Created By Ext Id */
|
|
7938
|
+
created_by_ext_id?: string | null;
|
|
7939
|
+
/**
|
|
7940
|
+
* Reason
|
|
7941
|
+
* @default upload
|
|
7942
|
+
* @enum {string}
|
|
7943
|
+
*/
|
|
7944
|
+
reason: 'upload' | 'edit' | 'signed' | 'sync';
|
|
7945
|
+
/** File Name */
|
|
7946
|
+
file_name?: string | null;
|
|
7947
|
+
/** File Type */
|
|
7948
|
+
file_type?: string | null;
|
|
7949
|
+
/** File Size */
|
|
7950
|
+
file_size?: number | null;
|
|
7951
|
+
/** Content Hash */
|
|
7952
|
+
content_hash?: string | null;
|
|
7953
|
+
/** Status */
|
|
7954
|
+
status?: string | null;
|
|
7955
|
+
/** N Pages */
|
|
7956
|
+
n_pages?: number | null;
|
|
7957
|
+
/** N Chunks */
|
|
7958
|
+
n_chunks?: number | null;
|
|
7959
|
+
/** Made From */
|
|
7960
|
+
made_from?: number | null;
|
|
7961
|
+
/**
|
|
7962
|
+
* Is Current
|
|
7963
|
+
* @default false
|
|
7964
|
+
*/
|
|
7965
|
+
is_current: boolean;
|
|
7966
|
+
/**
|
|
7967
|
+
* Markup Revision
|
|
7968
|
+
* @default 0
|
|
7969
|
+
*/
|
|
7970
|
+
markup_revision: number;
|
|
7971
|
+
/**
|
|
7972
|
+
* Markup Count
|
|
7973
|
+
* @default 0
|
|
7974
|
+
*/
|
|
7975
|
+
markup_count: number;
|
|
7976
|
+
};
|
|
7813
7977
|
/**
|
|
7814
7978
|
* DoctagLLMConfig
|
|
7815
7979
|
* @description Configuration for DoctagLLM - extracts information from documents based on tag instructions.
|
|
@@ -8322,11 +8486,18 @@ interface components {
|
|
|
8322
8486
|
};
|
|
8323
8487
|
/**
|
|
8324
8488
|
* ExportFile
|
|
8325
|
-
* @description One file of a download: fetch ``/v1/document/{doc_ext_id}/download`` and store
|
|
8489
|
+
* @description One file of a download: fetch ``/v1/document/{doc_ext_id}/download?version={version}`` and store
|
|
8490
|
+
* it at ``path`` — or, for ``markup``, the version's markup PDF from
|
|
8491
|
+
* ``/v1/document/{doc_ext_id}/markup/pdf?version={version}``.
|
|
8326
8492
|
*/
|
|
8327
8493
|
ExportFile: {
|
|
8328
8494
|
/** Doc Ext Id */
|
|
8329
8495
|
doc_ext_id: string;
|
|
8496
|
+
/**
|
|
8497
|
+
* Version
|
|
8498
|
+
* @default 1
|
|
8499
|
+
*/
|
|
8500
|
+
version: number;
|
|
8330
8501
|
/** Path */
|
|
8331
8502
|
path: string;
|
|
8332
8503
|
/**
|
|
@@ -8334,6 +8505,11 @@ interface components {
|
|
|
8334
8505
|
* @default true
|
|
8335
8506
|
*/
|
|
8336
8507
|
is_current: boolean;
|
|
8508
|
+
/**
|
|
8509
|
+
* Markup
|
|
8510
|
+
* @default false
|
|
8511
|
+
*/
|
|
8512
|
+
markup: boolean;
|
|
8337
8513
|
};
|
|
8338
8514
|
/** FactDeleteResponse */
|
|
8339
8515
|
FactDeleteResponse: {
|
|
@@ -8853,6 +9029,30 @@ interface components {
|
|
|
8853
9029
|
/** Detail */
|
|
8854
9030
|
detail?: components['schemas']['ValidationError'][];
|
|
8855
9031
|
};
|
|
9032
|
+
/** HighlightMark */
|
|
9033
|
+
HighlightMark: {
|
|
9034
|
+
/** Id */
|
|
9035
|
+
id: string;
|
|
9036
|
+
/** Page */
|
|
9037
|
+
page: number;
|
|
9038
|
+
/** Author */
|
|
9039
|
+
author: string;
|
|
9040
|
+
/** Createdat */
|
|
9041
|
+
createdAt: string;
|
|
9042
|
+
/** Updatedat */
|
|
9043
|
+
updatedAt: string;
|
|
9044
|
+
/**
|
|
9045
|
+
* @description discriminator enum property added by openapi-typescript
|
|
9046
|
+
* @enum {string}
|
|
9047
|
+
*/
|
|
9048
|
+
kind: 'highlight';
|
|
9049
|
+
/** Rects */
|
|
9050
|
+
rects: components['schemas']['MarkupRect'][];
|
|
9051
|
+
/** Color */
|
|
9052
|
+
color: string;
|
|
9053
|
+
/** Text */
|
|
9054
|
+
text?: string | null;
|
|
9055
|
+
};
|
|
8856
9056
|
/**
|
|
8857
9057
|
* ImageGenConfig
|
|
8858
9058
|
* @description Configuration for ImageGen — conversational text→image / image editing.
|
|
@@ -9395,6 +9595,67 @@ interface components {
|
|
|
9395
9595
|
/** Last Sync At */
|
|
9396
9596
|
last_sync_at?: string | null;
|
|
9397
9597
|
};
|
|
9598
|
+
/**
|
|
9599
|
+
* MarkupConflict
|
|
9600
|
+
* @description The 409 body: someone saved first. Re-read, merge by annotation id, save again.
|
|
9601
|
+
*/
|
|
9602
|
+
MarkupConflict: {
|
|
9603
|
+
/** Detail */
|
|
9604
|
+
detail: string;
|
|
9605
|
+
/** Revision */
|
|
9606
|
+
revision: number;
|
|
9607
|
+
};
|
|
9608
|
+
/**
|
|
9609
|
+
* MarkupLayerResponse
|
|
9610
|
+
* @description ``GET /v1/document/{id}/markup``: the version's marks and the revision they are at.
|
|
9611
|
+
*/
|
|
9612
|
+
MarkupLayerResponse: {
|
|
9613
|
+
/** Doc Ext Id */
|
|
9614
|
+
doc_ext_id: string;
|
|
9615
|
+
/** Version */
|
|
9616
|
+
version: number;
|
|
9617
|
+
/**
|
|
9618
|
+
* Revision
|
|
9619
|
+
* @default 0
|
|
9620
|
+
*/
|
|
9621
|
+
revision: number;
|
|
9622
|
+
/** Annotations */
|
|
9623
|
+
annotations?: (components['schemas']['HighlightMark'] | components['schemas']['BoxMark'] | components['schemas']['CommentMark'] | components['schemas']['StampMark'] | components['schemas']['RedactionMark'])[];
|
|
9624
|
+
/** Updated At */
|
|
9625
|
+
updated_at?: string | null;
|
|
9626
|
+
/** Updated By Ext Id */
|
|
9627
|
+
updated_by_ext_id?: string | null;
|
|
9628
|
+
/**
|
|
9629
|
+
* Can Edit
|
|
9630
|
+
* @default false
|
|
9631
|
+
*/
|
|
9632
|
+
can_edit: boolean;
|
|
9633
|
+
};
|
|
9634
|
+
/**
|
|
9635
|
+
* MarkupRect
|
|
9636
|
+
* @description A rectangle in fractions of the displayed page, origin top-left.
|
|
9637
|
+
*/
|
|
9638
|
+
MarkupRect: {
|
|
9639
|
+
/** X */
|
|
9640
|
+
x: number;
|
|
9641
|
+
/** Y */
|
|
9642
|
+
y: number;
|
|
9643
|
+
/** W */
|
|
9644
|
+
w: number;
|
|
9645
|
+
/** H */
|
|
9646
|
+
h: number;
|
|
9647
|
+
};
|
|
9648
|
+
/** MarkupReply */
|
|
9649
|
+
MarkupReply: {
|
|
9650
|
+
/** Id */
|
|
9651
|
+
id: string;
|
|
9652
|
+
/** Author */
|
|
9653
|
+
author: string;
|
|
9654
|
+
/** Createdat */
|
|
9655
|
+
createdAt: string;
|
|
9656
|
+
/** Body */
|
|
9657
|
+
body: string;
|
|
9658
|
+
};
|
|
9398
9659
|
/** McpToolInfo */
|
|
9399
9660
|
McpToolInfo: {
|
|
9400
9661
|
/** Name */
|
|
@@ -10173,6 +10434,8 @@ interface components {
|
|
|
10173
10434
|
ParsedDocMetadata: {
|
|
10174
10435
|
/** Doc Ext Id */
|
|
10175
10436
|
doc_ext_id?: string | null;
|
|
10437
|
+
/** Doc Version */
|
|
10438
|
+
doc_version?: number | null;
|
|
10176
10439
|
/** File Name */
|
|
10177
10440
|
file_name?: string | null;
|
|
10178
10441
|
/**
|
|
@@ -10926,6 +11189,40 @@ interface components {
|
|
|
10926
11189
|
/** @description ARBI agent-trace extension (non-standard). */
|
|
10927
11190
|
arbi?: components['schemas']['ArbiItemMeta'] | null;
|
|
10928
11191
|
};
|
|
11192
|
+
/** RedactionMark */
|
|
11193
|
+
RedactionMark: {
|
|
11194
|
+
/** Id */
|
|
11195
|
+
id: string;
|
|
11196
|
+
/** Page */
|
|
11197
|
+
page: number;
|
|
11198
|
+
/** Author */
|
|
11199
|
+
author: string;
|
|
11200
|
+
/** Createdat */
|
|
11201
|
+
createdAt: string;
|
|
11202
|
+
/** Updatedat */
|
|
11203
|
+
updatedAt: string;
|
|
11204
|
+
/**
|
|
11205
|
+
* @description discriminator enum property added by openapi-typescript
|
|
11206
|
+
* @enum {string}
|
|
11207
|
+
*/
|
|
11208
|
+
kind: 'redaction';
|
|
11209
|
+
/** Rects */
|
|
11210
|
+
rects: components['schemas']['MarkupRect'][];
|
|
11211
|
+
/** Reason */
|
|
11212
|
+
reason: string;
|
|
11213
|
+
/** Text */
|
|
11214
|
+
text?: string | null;
|
|
11215
|
+
/**
|
|
11216
|
+
* Status
|
|
11217
|
+
* @default pending
|
|
11218
|
+
* @enum {string}
|
|
11219
|
+
*/
|
|
11220
|
+
status: 'pending' | 'approved' | 'rejected';
|
|
11221
|
+
/** Reviewedby */
|
|
11222
|
+
reviewedBy?: string | null;
|
|
11223
|
+
/** Reviewedat */
|
|
11224
|
+
reviewedAt?: string | null;
|
|
11225
|
+
};
|
|
10929
11226
|
/**
|
|
10930
11227
|
* ReferencedDocuments
|
|
10931
11228
|
* @description What to do with a document a note / conversation / automation cites but the scope does not include.
|
|
@@ -12122,6 +12419,29 @@ interface components {
|
|
|
12122
12419
|
/** State */
|
|
12123
12420
|
state?: string | null;
|
|
12124
12421
|
};
|
|
12422
|
+
/**
|
|
12423
|
+
* SaveMarkupRequest
|
|
12424
|
+
* @description ``PUT /v1/document/{id}/markup``: the whole layer, and the revision the client started from.
|
|
12425
|
+
*
|
|
12426
|
+
* The ``If-Match`` header, when present, takes precedence over ``base_revision``.
|
|
12427
|
+
*/
|
|
12428
|
+
SaveMarkupRequest: {
|
|
12429
|
+
/** Base Revision */
|
|
12430
|
+
base_revision?: number | null;
|
|
12431
|
+
/** Annotations */
|
|
12432
|
+
annotations?: (components['schemas']['HighlightMark'] | components['schemas']['BoxMark'] | components['schemas']['CommentMark'] | components['schemas']['StampMark'] | components['schemas']['RedactionMark'])[];
|
|
12433
|
+
};
|
|
12434
|
+
/** SaveMarkupResponse */
|
|
12435
|
+
SaveMarkupResponse: {
|
|
12436
|
+
/** Doc Ext Id */
|
|
12437
|
+
doc_ext_id: string;
|
|
12438
|
+
/** Version */
|
|
12439
|
+
version: number;
|
|
12440
|
+
/** Revision */
|
|
12441
|
+
revision: number;
|
|
12442
|
+
/** Count */
|
|
12443
|
+
count: number;
|
|
12444
|
+
};
|
|
12125
12445
|
/**
|
|
12126
12446
|
* SaveSkillDetail
|
|
12127
12447
|
* @description Detail for a save_skill tool call.
|
|
@@ -12367,8 +12687,16 @@ interface components {
|
|
|
12367
12687
|
};
|
|
12368
12688
|
/** SignDocumentResponse */
|
|
12369
12689
|
SignDocumentResponse: {
|
|
12370
|
-
/**
|
|
12371
|
-
|
|
12690
|
+
/**
|
|
12691
|
+
* Doc Ext Id
|
|
12692
|
+
* @description The signed document (it keeps its id)
|
|
12693
|
+
*/
|
|
12694
|
+
doc_ext_id: string;
|
|
12695
|
+
/**
|
|
12696
|
+
* Version
|
|
12697
|
+
* @description The new version holding the signed, sealed PDF
|
|
12698
|
+
*/
|
|
12699
|
+
version: number;
|
|
12372
12700
|
signature: components['schemas']['SignatureRecord'];
|
|
12373
12701
|
};
|
|
12374
12702
|
/**
|
|
@@ -12610,6 +12938,29 @@ interface components {
|
|
|
12610
12938
|
*/
|
|
12611
12939
|
task_length: number;
|
|
12612
12940
|
};
|
|
12941
|
+
/** StampMark */
|
|
12942
|
+
StampMark: {
|
|
12943
|
+
/** Id */
|
|
12944
|
+
id: string;
|
|
12945
|
+
/** Page */
|
|
12946
|
+
page: number;
|
|
12947
|
+
/** Author */
|
|
12948
|
+
author: string;
|
|
12949
|
+
/** Createdat */
|
|
12950
|
+
createdAt: string;
|
|
12951
|
+
/** Updatedat */
|
|
12952
|
+
updatedAt: string;
|
|
12953
|
+
/**
|
|
12954
|
+
* @description discriminator enum property added by openapi-typescript
|
|
12955
|
+
* @enum {string}
|
|
12956
|
+
*/
|
|
12957
|
+
kind: 'stamp';
|
|
12958
|
+
rect: components['schemas']['MarkupRect'];
|
|
12959
|
+
/** Label */
|
|
12960
|
+
label: string;
|
|
12961
|
+
/** Color */
|
|
12962
|
+
color: string;
|
|
12963
|
+
};
|
|
12613
12964
|
/**
|
|
12614
12965
|
* StepUsage
|
|
12615
12966
|
* @description Per-step token usage from a single LLM call.
|
|
@@ -12999,6 +13350,11 @@ interface components {
|
|
|
12999
13350
|
type: 'task_update';
|
|
13000
13351
|
/** Doc Ext Id */
|
|
13001
13352
|
doc_ext_id: string;
|
|
13353
|
+
/**
|
|
13354
|
+
* Version
|
|
13355
|
+
* @default 1
|
|
13356
|
+
*/
|
|
13357
|
+
version: number;
|
|
13002
13358
|
/** Workspace Ext Id */
|
|
13003
13359
|
workspace_ext_id: string;
|
|
13004
13360
|
/** File Name */
|
|
@@ -13363,7 +13719,7 @@ interface components {
|
|
|
13363
13719
|
kind: components['schemas']['TransferScopeKind'];
|
|
13364
13720
|
/**
|
|
13365
13721
|
* 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
|
|
13722
|
+
* @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.
|
|
13367
13723
|
*/
|
|
13368
13724
|
items?: string[];
|
|
13369
13725
|
/** Label Ext Id */
|
|
@@ -13646,6 +14002,8 @@ interface components {
|
|
|
13646
14002
|
UploadDocumentsResponse: {
|
|
13647
14003
|
/** Doc Ext Ids */
|
|
13648
14004
|
doc_ext_ids?: string[];
|
|
14005
|
+
/** Version */
|
|
14006
|
+
version?: number | null;
|
|
13649
14007
|
/**
|
|
13650
14008
|
* Batch Id
|
|
13651
14009
|
* @description Batch ID for tracking completion via WebSocket batch_complete events
|
|
@@ -13673,7 +14031,7 @@ interface components {
|
|
|
13673
14031
|
config_ext_id?: string | null;
|
|
13674
14032
|
/**
|
|
13675
14033
|
* Version Of
|
|
13676
|
-
* @description Upload as the next version of this document
|
|
14034
|
+
* @description Upload as the next version of this document
|
|
13677
14035
|
*/
|
|
13678
14036
|
version_of?: string | null;
|
|
13679
14037
|
/** Wp Type */
|
|
@@ -16627,7 +16985,10 @@ interface operations {
|
|
|
16627
16985
|
};
|
|
16628
16986
|
native_content_v1_editor__document_id__content_get: {
|
|
16629
16987
|
parameters: {
|
|
16630
|
-
query?:
|
|
16988
|
+
query?: {
|
|
16989
|
+
/** @description Document version (default: the current one) */
|
|
16990
|
+
version?: number | null;
|
|
16991
|
+
};
|
|
16631
16992
|
header?: never;
|
|
16632
16993
|
path: {
|
|
16633
16994
|
document_id: string;
|
|
@@ -16661,6 +17022,10 @@ interface operations {
|
|
|
16661
17022
|
query: {
|
|
16662
17023
|
revised_ext_id: string;
|
|
16663
17024
|
base_ext_id?: string | null;
|
|
17025
|
+
/** @description Version of the revised document (default current) */
|
|
17026
|
+
revised_version?: number | null;
|
|
17027
|
+
/** @description Version of the base document (default current) */
|
|
17028
|
+
base_version?: number | null;
|
|
16664
17029
|
};
|
|
16665
17030
|
header?: never;
|
|
16666
17031
|
path?: never;
|
|
@@ -16872,7 +17237,7 @@ interface operations {
|
|
|
16872
17237
|
[name: string]: unknown;
|
|
16873
17238
|
};
|
|
16874
17239
|
content: {
|
|
16875
|
-
'application/json': components['schemas']['
|
|
17240
|
+
'application/json': components['schemas']['DocVersion'][];
|
|
16876
17241
|
};
|
|
16877
17242
|
};
|
|
16878
17243
|
/** @description Validation Error */
|
|
@@ -16990,7 +17355,7 @@ interface operations {
|
|
|
16990
17355
|
shared?: boolean;
|
|
16991
17356
|
/** @description Configuration to use for processing */
|
|
16992
17357
|
config_ext_id?: string | null;
|
|
16993
|
-
/** @description Upload a single file as the next version of this document
|
|
17358
|
+
/** @description Upload a single file as the next version of this document. The document keeps its id, sharing, folder and labels; the new version becomes current (the response's `version`). */
|
|
16994
17359
|
version_of?: string | null;
|
|
16995
17360
|
/** @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
17361
|
derived_from?: string[] | null;
|
|
@@ -17142,7 +17507,10 @@ interface operations {
|
|
|
17142
17507
|
};
|
|
17143
17508
|
download_document: {
|
|
17144
17509
|
parameters: {
|
|
17145
|
-
query?:
|
|
17510
|
+
query?: {
|
|
17511
|
+
/** @description Document version (default: the current one) */
|
|
17512
|
+
version?: number | null;
|
|
17513
|
+
};
|
|
17146
17514
|
header?: never;
|
|
17147
17515
|
path: {
|
|
17148
17516
|
document_ext_id: string;
|
|
@@ -17173,7 +17541,10 @@ interface operations {
|
|
|
17173
17541
|
};
|
|
17174
17542
|
view_document_inline: {
|
|
17175
17543
|
parameters: {
|
|
17176
|
-
query?:
|
|
17544
|
+
query?: {
|
|
17545
|
+
/** @description Document version (default: the current one) */
|
|
17546
|
+
version?: number | null;
|
|
17547
|
+
};
|
|
17177
17548
|
header?: never;
|
|
17178
17549
|
path: {
|
|
17179
17550
|
document_ext_id: string;
|
|
@@ -17204,7 +17575,10 @@ interface operations {
|
|
|
17204
17575
|
};
|
|
17205
17576
|
get_document_thumbnail: {
|
|
17206
17577
|
parameters: {
|
|
17207
|
-
query?:
|
|
17578
|
+
query?: {
|
|
17579
|
+
/** @description Document version (default: the current one) */
|
|
17580
|
+
version?: number | null;
|
|
17581
|
+
};
|
|
17208
17582
|
header?: never;
|
|
17209
17583
|
path: {
|
|
17210
17584
|
document_ext_id: string;
|
|
@@ -17268,7 +17642,10 @@ interface operations {
|
|
|
17268
17642
|
};
|
|
17269
17643
|
get_parsed_document: {
|
|
17270
17644
|
parameters: {
|
|
17271
|
-
query?:
|
|
17645
|
+
query?: {
|
|
17646
|
+
/** @description Document version (default: the current one) */
|
|
17647
|
+
version?: number | null;
|
|
17648
|
+
};
|
|
17272
17649
|
header?: never;
|
|
17273
17650
|
path: {
|
|
17274
17651
|
document_ext_id: string;
|
|
@@ -17406,7 +17783,10 @@ interface operations {
|
|
|
17406
17783
|
};
|
|
17407
17784
|
get_document_signature_status: {
|
|
17408
17785
|
parameters: {
|
|
17409
|
-
query?:
|
|
17786
|
+
query?: {
|
|
17787
|
+
/** @description Document version (default: the current one) */
|
|
17788
|
+
version?: number | null;
|
|
17789
|
+
};
|
|
17410
17790
|
header?: never;
|
|
17411
17791
|
path: {
|
|
17412
17792
|
document_ext_id: string;
|
|
@@ -17435,6 +17815,139 @@ interface operations {
|
|
|
17435
17815
|
};
|
|
17436
17816
|
};
|
|
17437
17817
|
};
|
|
17818
|
+
get_document_markup: {
|
|
17819
|
+
parameters: {
|
|
17820
|
+
query?: {
|
|
17821
|
+
/** @description Document version (default: the current one) */
|
|
17822
|
+
version?: number | null;
|
|
17823
|
+
};
|
|
17824
|
+
header?: {
|
|
17825
|
+
'if-none-match'?: string | null;
|
|
17826
|
+
};
|
|
17827
|
+
path: {
|
|
17828
|
+
document_ext_id: string;
|
|
17829
|
+
};
|
|
17830
|
+
cookie?: never;
|
|
17831
|
+
};
|
|
17832
|
+
requestBody?: never;
|
|
17833
|
+
responses: {
|
|
17834
|
+
/** @description Successful Response */
|
|
17835
|
+
200: {
|
|
17836
|
+
headers: {
|
|
17837
|
+
[name: string]: unknown;
|
|
17838
|
+
};
|
|
17839
|
+
content: {
|
|
17840
|
+
'application/json': components['schemas']['MarkupLayerResponse'];
|
|
17841
|
+
};
|
|
17842
|
+
};
|
|
17843
|
+
/** @description Unchanged since the revision in If-None-Match */
|
|
17844
|
+
304: {
|
|
17845
|
+
headers: {
|
|
17846
|
+
[name: string]: unknown;
|
|
17847
|
+
};
|
|
17848
|
+
content?: never;
|
|
17849
|
+
};
|
|
17850
|
+
/** @description Validation Error */
|
|
17851
|
+
422: {
|
|
17852
|
+
headers: {
|
|
17853
|
+
[name: string]: unknown;
|
|
17854
|
+
};
|
|
17855
|
+
content: {
|
|
17856
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
17857
|
+
};
|
|
17858
|
+
};
|
|
17859
|
+
};
|
|
17860
|
+
};
|
|
17861
|
+
save_document_markup: {
|
|
17862
|
+
parameters: {
|
|
17863
|
+
query?: {
|
|
17864
|
+
/** @description Document version (default: the current one) */
|
|
17865
|
+
version?: number | null;
|
|
17866
|
+
};
|
|
17867
|
+
header?: {
|
|
17868
|
+
'if-match'?: string | null;
|
|
17869
|
+
};
|
|
17870
|
+
path: {
|
|
17871
|
+
document_ext_id: string;
|
|
17872
|
+
};
|
|
17873
|
+
cookie?: never;
|
|
17874
|
+
};
|
|
17875
|
+
requestBody: {
|
|
17876
|
+
content: {
|
|
17877
|
+
'application/json': components['schemas']['SaveMarkupRequest'];
|
|
17878
|
+
};
|
|
17879
|
+
};
|
|
17880
|
+
responses: {
|
|
17881
|
+
/** @description Successful Response */
|
|
17882
|
+
200: {
|
|
17883
|
+
headers: {
|
|
17884
|
+
[name: string]: unknown;
|
|
17885
|
+
};
|
|
17886
|
+
content: {
|
|
17887
|
+
'application/json': components['schemas']['SaveMarkupResponse'];
|
|
17888
|
+
};
|
|
17889
|
+
};
|
|
17890
|
+
/** @description Saved by someone else first; re-read and merge */
|
|
17891
|
+
409: {
|
|
17892
|
+
headers: {
|
|
17893
|
+
[name: string]: unknown;
|
|
17894
|
+
};
|
|
17895
|
+
content: {
|
|
17896
|
+
'application/json': components['schemas']['MarkupConflict'];
|
|
17897
|
+
};
|
|
17898
|
+
};
|
|
17899
|
+
/** @description Validation Error */
|
|
17900
|
+
422: {
|
|
17901
|
+
headers: {
|
|
17902
|
+
[name: string]: unknown;
|
|
17903
|
+
};
|
|
17904
|
+
content: {
|
|
17905
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
17906
|
+
};
|
|
17907
|
+
};
|
|
17908
|
+
};
|
|
17909
|
+
};
|
|
17910
|
+
download_document_markup: {
|
|
17911
|
+
parameters: {
|
|
17912
|
+
query?: {
|
|
17913
|
+
/** @description Document version (default: the current one) */
|
|
17914
|
+
version?: number | null;
|
|
17915
|
+
};
|
|
17916
|
+
header?: never;
|
|
17917
|
+
path: {
|
|
17918
|
+
document_ext_id: string;
|
|
17919
|
+
};
|
|
17920
|
+
cookie?: never;
|
|
17921
|
+
};
|
|
17922
|
+
requestBody?: never;
|
|
17923
|
+
responses: {
|
|
17924
|
+
/** @description Successful Response */
|
|
17925
|
+
200: {
|
|
17926
|
+
headers: {
|
|
17927
|
+
[name: string]: unknown;
|
|
17928
|
+
};
|
|
17929
|
+
content: {
|
|
17930
|
+
'application/pdf': unknown;
|
|
17931
|
+
};
|
|
17932
|
+
};
|
|
17933
|
+
/** @description This version has no markup */
|
|
17934
|
+
404: {
|
|
17935
|
+
headers: {
|
|
17936
|
+
[name: string]: unknown;
|
|
17937
|
+
};
|
|
17938
|
+
content?: never;
|
|
17939
|
+
};
|
|
17940
|
+
/** @description Validation Error */
|
|
17941
|
+
422: {
|
|
17942
|
+
headers: {
|
|
17943
|
+
[name: string]: unknown;
|
|
17944
|
+
};
|
|
17945
|
+
content: {
|
|
17946
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
17947
|
+
};
|
|
17948
|
+
};
|
|
17949
|
+
};
|
|
17950
|
+
};
|
|
17438
17951
|
list_conversations: {
|
|
17439
17952
|
parameters: {
|
|
17440
17953
|
query?: never;
|