@arbidocs/client 0.4.157 → 0.4.159
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 +203 -17
- package/dist/index.d.ts +203 -17
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -869,6 +869,37 @@ interface paths {
|
|
|
869
869
|
patch?: never;
|
|
870
870
|
trace?: never;
|
|
871
871
|
};
|
|
872
|
+
'/v1/user/signature': {
|
|
873
|
+
parameters: {
|
|
874
|
+
query?: never;
|
|
875
|
+
header?: never;
|
|
876
|
+
path?: never;
|
|
877
|
+
cookie?: never;
|
|
878
|
+
};
|
|
879
|
+
/**
|
|
880
|
+
* Get Saved Signature
|
|
881
|
+
* @description The caller's saved signature and initials, sealed to their own encryption key (only their browser opens it);
|
|
882
|
+
* ``sealed`` is null when none is saved.
|
|
883
|
+
*/
|
|
884
|
+
get: operations['get_saved_signature'];
|
|
885
|
+
/**
|
|
886
|
+
* Save Signature
|
|
887
|
+
* @description Save (or replace) the caller's signature and initials, sealed in the browser to their own encryption key.
|
|
888
|
+
* Only with the user's explicit consent ("Save to my account for future use"). The server cannot read it.
|
|
889
|
+
*/
|
|
890
|
+
put: operations['save_signature'];
|
|
891
|
+
post?: never;
|
|
892
|
+
/**
|
|
893
|
+
* Delete Saved Signature
|
|
894
|
+
* @description Delete the caller's saved signature and initials completely (the one row that holds them; no copy is kept).
|
|
895
|
+
* Signatures already placed in documents or sealed in signed PDFs are not touched.
|
|
896
|
+
*/
|
|
897
|
+
delete: operations['delete_saved_signature'];
|
|
898
|
+
options?: never;
|
|
899
|
+
head?: never;
|
|
900
|
+
patch?: never;
|
|
901
|
+
trace?: never;
|
|
902
|
+
};
|
|
872
903
|
'/v1/user/settings': {
|
|
873
904
|
parameters: {
|
|
874
905
|
query?: never;
|
|
@@ -1481,6 +1512,9 @@ interface paths {
|
|
|
1481
1512
|
* Remove Workspace Users
|
|
1482
1513
|
* @description Remove users from a workspace (bulk operation). Only workspace owners can remove users.
|
|
1483
1514
|
* Users can also remove themselves from a workspace.
|
|
1515
|
+
*
|
|
1516
|
+
* The workspace is ``workspace_ext_id`` when given (its key must be on the session, e.g. via
|
|
1517
|
+
* ``/prime-key``), else the session's active one; the active workspace is never changed.
|
|
1484
1518
|
*/
|
|
1485
1519
|
delete: operations['remove_workspace_users'];
|
|
1486
1520
|
options?: never;
|
|
@@ -2082,7 +2116,7 @@ interface paths {
|
|
|
2082
2116
|
};
|
|
2083
2117
|
/**
|
|
2084
2118
|
* List Documents
|
|
2085
|
-
* @description List documents in the current workspace.
|
|
2119
|
+
* @description List documents in the current workspace, or the ``workspace_ext_id`` one (its key on the session).
|
|
2086
2120
|
*
|
|
2087
2121
|
* By default returns all documents (no pagination, full shape) since the
|
|
2088
2122
|
* frontend's client-side sort/search/filter needs the complete set.
|
|
@@ -2722,9 +2756,12 @@ interface paths {
|
|
|
2722
2756
|
};
|
|
2723
2757
|
/**
|
|
2724
2758
|
* Suggest Signature Fields
|
|
2725
|
-
* @description Where the document
|
|
2726
|
-
*
|
|
2727
|
-
*
|
|
2759
|
+
* @description Where the document asks for fields. First the signature fields its author placed in the Word document
|
|
2760
|
+
* (``source=anchor``): exactly where each goes, with the signer it names (``signer_email``). Then its signature
|
|
2761
|
+
* blocks (``source=layout``, optional extras): signature lines ("……" / "____") labelled "Director", "Witness name",
|
|
2762
|
+
* "[Signature]", "Date:" and so on, as in the house template's execution blocks, grouped by block with its role so
|
|
2763
|
+
* the author assigns a signer per block. Read from the same PDF the signers will be shown. 409 while a placed field
|
|
2764
|
+
* is still a pending tracked insertion.
|
|
2728
2765
|
*/
|
|
2729
2766
|
get: operations['suggest_signature_fields'];
|
|
2730
2767
|
put?: never;
|
|
@@ -2750,7 +2787,9 @@ interface paths {
|
|
|
2750
2787
|
put?: never;
|
|
2751
2788
|
/**
|
|
2752
2789
|
* Create Signature Request
|
|
2753
|
-
* @description Ask
|
|
2790
|
+
* @description Ask people to sign a document at the fields placed on it: workspace members (``usr-*``), or anyone by email
|
|
2791
|
+
* (an email that is not a member's makes an *invited* signer, who signs once they join the workspace - invite them
|
|
2792
|
+
* with ``POST /v1/workspace/users``). The fields are on the PDF rendition of
|
|
2754
2793
|
* ``version`` (the one ``GET /view?version=`` serves), which must be the current version and not signed yet. With
|
|
2755
2794
|
* ``send`` the signers are notified straight away; otherwise it is a draft to change and send later.
|
|
2756
2795
|
*/
|
|
@@ -2788,7 +2827,10 @@ interface paths {
|
|
|
2788
2827
|
path?: never;
|
|
2789
2828
|
cookie?: never;
|
|
2790
2829
|
};
|
|
2791
|
-
/**
|
|
2830
|
+
/**
|
|
2831
|
+
* Get Signature Request
|
|
2832
|
+
* @description One request. A signer's first read marks them as having viewed it.
|
|
2833
|
+
*/
|
|
2792
2834
|
get: operations['get_signature_request'];
|
|
2793
2835
|
put?: never;
|
|
2794
2836
|
post?: never;
|
|
@@ -2813,7 +2855,8 @@ interface paths {
|
|
|
2813
2855
|
put?: never;
|
|
2814
2856
|
/**
|
|
2815
2857
|
* Send Signature Request
|
|
2816
|
-
* @description Send a draft: every signer is notified and the fields are fixed.
|
|
2858
|
+
* @description Send a draft: every signer who is a member is notified and the fields are fixed. A signer still invited by
|
|
2859
|
+
* email is asked when they join the workspace.
|
|
2817
2860
|
*/
|
|
2818
2861
|
post: operations['send_signature_request'];
|
|
2819
2862
|
delete?: never;
|
|
@@ -8176,6 +8219,7 @@ interface components {
|
|
|
8176
8219
|
*
|
|
8177
8220
|
* A typed signature is the name rendered in a signature face (as a single signing draws it). A drawn or uploaded
|
|
8178
8221
|
* one is a PNG the browser made (a canvas, or the uploaded image redrawn onto one); the server re-encodes it.
|
|
8222
|
+
* Initials are typed, or drawn (``initials_image``) whichever way the signature was adopted.
|
|
8179
8223
|
*/
|
|
8180
8224
|
AdoptedSignature: {
|
|
8181
8225
|
/**
|
|
@@ -8198,7 +8242,7 @@ interface components {
|
|
|
8198
8242
|
signature_image?: string | null;
|
|
8199
8243
|
/**
|
|
8200
8244
|
* Initials Image
|
|
8201
|
-
* @description Base64 PNG of
|
|
8245
|
+
* @description Base64 PNG of drawn initials (else they are typed)
|
|
8202
8246
|
*/
|
|
8203
8247
|
initials_image?: string | null;
|
|
8204
8248
|
};
|
|
@@ -19097,6 +19141,11 @@ interface components {
|
|
|
19097
19141
|
RemoveWorkspaceUsersRequest: {
|
|
19098
19142
|
/** Users */
|
|
19099
19143
|
users: components['schemas']['RemoveWorkspaceUserItem'][];
|
|
19144
|
+
/**
|
|
19145
|
+
* Workspace Ext Id
|
|
19146
|
+
* @description The workspace to remove them from; defaults to the session's active workspace.
|
|
19147
|
+
*/
|
|
19148
|
+
workspace_ext_id?: string | null;
|
|
19100
19149
|
};
|
|
19101
19150
|
/**
|
|
19102
19151
|
* RequestDeletionResponse
|
|
@@ -20330,6 +20379,28 @@ interface components {
|
|
|
20330
20379
|
*/
|
|
20331
20380
|
title: string;
|
|
20332
20381
|
};
|
|
20382
|
+
/**
|
|
20383
|
+
* SavedSignature
|
|
20384
|
+
* @description A user's saved signature and initials, sealed in the browser to their own X25519 key (``SealedBox`` to
|
|
20385
|
+
* ``users.encryption_key_pub``): the server stores and returns it, and can never read it.
|
|
20386
|
+
*/
|
|
20387
|
+
SavedSignature: {
|
|
20388
|
+
/**
|
|
20389
|
+
* Sealed
|
|
20390
|
+
* @description Base64 SealedBox to the caller's own encryption key of the JSON {name, initials, style, signature_png, initials_png}
|
|
20391
|
+
*/
|
|
20392
|
+
sealed: string;
|
|
20393
|
+
};
|
|
20394
|
+
/** SavedSignatureResponse */
|
|
20395
|
+
SavedSignatureResponse: {
|
|
20396
|
+
/**
|
|
20397
|
+
* Sealed
|
|
20398
|
+
* @description The sealed signature; null when none is saved
|
|
20399
|
+
*/
|
|
20400
|
+
sealed?: string | null;
|
|
20401
|
+
/** Updated At */
|
|
20402
|
+
updated_at?: string | null;
|
|
20403
|
+
};
|
|
20333
20404
|
/**
|
|
20334
20405
|
* SealedConnectorToken
|
|
20335
20406
|
* @description A connector's user-sealed OAuth tokens, for the client to decrypt at login.
|
|
@@ -20723,7 +20794,7 @@ interface components {
|
|
|
20723
20794
|
height: number;
|
|
20724
20795
|
/**
|
|
20725
20796
|
* Signer
|
|
20726
|
-
* @description
|
|
20797
|
+
* @description Who completes this field: a workspace member (usr-*), a pending signer of this request (srs-*), or on input an email address (a member's resolves to their usr-*, anyone else's to a pending srs-* signer, who signs once they join the workspace)
|
|
20727
20798
|
*/
|
|
20728
20799
|
signer: string;
|
|
20729
20800
|
/**
|
|
@@ -20820,16 +20891,28 @@ interface components {
|
|
|
20820
20891
|
};
|
|
20821
20892
|
/** SignatureRequestSigner */
|
|
20822
20893
|
SignatureRequestSigner: {
|
|
20823
|
-
/**
|
|
20824
|
-
|
|
20894
|
+
/**
|
|
20895
|
+
* External Id
|
|
20896
|
+
* @description The signer (srs-*); fields name it while the signer is still invited
|
|
20897
|
+
*/
|
|
20898
|
+
external_id: string;
|
|
20899
|
+
/**
|
|
20900
|
+
* User Ext Id
|
|
20901
|
+
* @description The member (usr-*), once they have joined
|
|
20902
|
+
*/
|
|
20903
|
+
user_ext_id?: string | null;
|
|
20825
20904
|
/**
|
|
20826
20905
|
* Name
|
|
20827
|
-
* @description The member's account name
|
|
20906
|
+
* @description The member's account name (empty while invited)
|
|
20828
20907
|
*/
|
|
20829
20908
|
name: string;
|
|
20830
20909
|
/** Email */
|
|
20831
20910
|
email?: string | null;
|
|
20832
20911
|
status: components['schemas']['SignerStatus'];
|
|
20912
|
+
/** @description invited, registered, viewed, signed or declined */
|
|
20913
|
+
progress: components['schemas']['SignerProgress'];
|
|
20914
|
+
/** Viewed At */
|
|
20915
|
+
viewed_at?: string | null;
|
|
20833
20916
|
/** Signed At */
|
|
20834
20917
|
signed_at?: string | null;
|
|
20835
20918
|
/**
|
|
@@ -20906,6 +20989,11 @@ interface components {
|
|
|
20906
20989
|
*/
|
|
20907
20990
|
name: string;
|
|
20908
20991
|
};
|
|
20992
|
+
/**
|
|
20993
|
+
* SignerProgress
|
|
20994
|
+
* @enum {string}
|
|
20995
|
+
*/
|
|
20996
|
+
SignerProgress: 'invited' | 'registered' | 'viewed' | 'signed' | 'declined';
|
|
20909
20997
|
/**
|
|
20910
20998
|
* SignerStatus
|
|
20911
20999
|
* @enum {string}
|
|
@@ -21064,6 +21152,8 @@ interface components {
|
|
|
21064
21152
|
label: string;
|
|
21065
21153
|
/** Color */
|
|
21066
21154
|
color: string;
|
|
21155
|
+
/** Image */
|
|
21156
|
+
image?: string | null;
|
|
21067
21157
|
};
|
|
21068
21158
|
/**
|
|
21069
21159
|
* StepActionRequest
|
|
@@ -21583,9 +21673,32 @@ interface components {
|
|
|
21583
21673
|
role?: string | null;
|
|
21584
21674
|
/**
|
|
21585
21675
|
* Anchor
|
|
21586
|
-
* @description The text the field was found by
|
|
21676
|
+
* @description The text the field was found by (a placed field's key or kind)
|
|
21587
21677
|
*/
|
|
21588
21678
|
anchor: string;
|
|
21679
|
+
/**
|
|
21680
|
+
* Source
|
|
21681
|
+
* @description anchor: a field the author placed in the Word document, exactly where it goes; layout: found from a signature line, an optional extra
|
|
21682
|
+
* @default layout
|
|
21683
|
+
* @enum {string}
|
|
21684
|
+
*/
|
|
21685
|
+
source: 'anchor' | 'layout';
|
|
21686
|
+
/**
|
|
21687
|
+
* Signer Email
|
|
21688
|
+
* @description The signer the placed field names, if any
|
|
21689
|
+
*/
|
|
21690
|
+
signer_email?: string | null;
|
|
21691
|
+
/**
|
|
21692
|
+
* Signer Name
|
|
21693
|
+
* @description Their name as the field gives it
|
|
21694
|
+
*/
|
|
21695
|
+
signer_name?: string | null;
|
|
21696
|
+
/**
|
|
21697
|
+
* Required
|
|
21698
|
+
* @description Whether the placed field is required
|
|
21699
|
+
* @default true
|
|
21700
|
+
*/
|
|
21701
|
+
required: boolean;
|
|
21589
21702
|
};
|
|
21590
21703
|
/**
|
|
21591
21704
|
* SummariseLLMConfig
|
|
@@ -25633,6 +25746,77 @@ interface operations {
|
|
|
25633
25746
|
};
|
|
25634
25747
|
};
|
|
25635
25748
|
};
|
|
25749
|
+
get_saved_signature: {
|
|
25750
|
+
parameters: {
|
|
25751
|
+
query?: never;
|
|
25752
|
+
header?: never;
|
|
25753
|
+
path?: never;
|
|
25754
|
+
cookie?: never;
|
|
25755
|
+
};
|
|
25756
|
+
requestBody?: never;
|
|
25757
|
+
responses: {
|
|
25758
|
+
/** @description Successful Response */
|
|
25759
|
+
200: {
|
|
25760
|
+
headers: {
|
|
25761
|
+
[name: string]: unknown;
|
|
25762
|
+
};
|
|
25763
|
+
content: {
|
|
25764
|
+
'application/json': components['schemas']['SavedSignatureResponse'];
|
|
25765
|
+
};
|
|
25766
|
+
};
|
|
25767
|
+
};
|
|
25768
|
+
};
|
|
25769
|
+
save_signature: {
|
|
25770
|
+
parameters: {
|
|
25771
|
+
query?: never;
|
|
25772
|
+
header?: never;
|
|
25773
|
+
path?: never;
|
|
25774
|
+
cookie?: never;
|
|
25775
|
+
};
|
|
25776
|
+
requestBody: {
|
|
25777
|
+
content: {
|
|
25778
|
+
'application/json': components['schemas']['SavedSignature'];
|
|
25779
|
+
};
|
|
25780
|
+
};
|
|
25781
|
+
responses: {
|
|
25782
|
+
/** @description Successful Response */
|
|
25783
|
+
200: {
|
|
25784
|
+
headers: {
|
|
25785
|
+
[name: string]: unknown;
|
|
25786
|
+
};
|
|
25787
|
+
content: {
|
|
25788
|
+
'application/json': components['schemas']['SavedSignatureResponse'];
|
|
25789
|
+
};
|
|
25790
|
+
};
|
|
25791
|
+
/** @description Validation Error */
|
|
25792
|
+
422: {
|
|
25793
|
+
headers: {
|
|
25794
|
+
[name: string]: unknown;
|
|
25795
|
+
};
|
|
25796
|
+
content: {
|
|
25797
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
25798
|
+
};
|
|
25799
|
+
};
|
|
25800
|
+
};
|
|
25801
|
+
};
|
|
25802
|
+
delete_saved_signature: {
|
|
25803
|
+
parameters: {
|
|
25804
|
+
query?: never;
|
|
25805
|
+
header?: never;
|
|
25806
|
+
path?: never;
|
|
25807
|
+
cookie?: never;
|
|
25808
|
+
};
|
|
25809
|
+
requestBody?: never;
|
|
25810
|
+
responses: {
|
|
25811
|
+
/** @description Successful Response */
|
|
25812
|
+
204: {
|
|
25813
|
+
headers: {
|
|
25814
|
+
[name: string]: unknown;
|
|
25815
|
+
};
|
|
25816
|
+
content?: never;
|
|
25817
|
+
};
|
|
25818
|
+
};
|
|
25819
|
+
};
|
|
25636
25820
|
get_user_settings: {
|
|
25637
25821
|
parameters: {
|
|
25638
25822
|
query?: never;
|
|
@@ -27492,6 +27676,8 @@ interface operations {
|
|
|
27492
27676
|
order?: string;
|
|
27493
27677
|
/** @description Response payload shape. ``full`` (default) returns DocResponse with doctags and decrypted doc_metadata — unchanged legacy behavior. ``lite`` skips the doctags JOIN and doc_metadata decrypt for each row: doctags=[] and doc_metadata=None. Used by the frontend's progressive loader to halve per-row decrypt work; full metadata is fetched on-demand per doc via /v1/document/ when a row is opened. */
|
|
27494
27678
|
fields?: string;
|
|
27679
|
+
/** @description The workspace to act on; defaults to the active workspace */
|
|
27680
|
+
workspace_ext_id?: string | null;
|
|
27495
27681
|
};
|
|
27496
27682
|
header?: never;
|
|
27497
27683
|
path?: never;
|
|
@@ -27795,7 +27981,7 @@ interface operations {
|
|
|
27795
27981
|
tag_ext_id?: string | null;
|
|
27796
27982
|
/** @description Optional logical folder path (preserved as-is for e-discovery) */
|
|
27797
27983
|
folder?: string | null;
|
|
27798
|
-
/** @description
|
|
27984
|
+
/** @description The workspace to act on; defaults to the active workspace */
|
|
27799
27985
|
workspace_ext_id?: string | null;
|
|
27800
27986
|
};
|
|
27801
27987
|
header?: never;
|
|
@@ -28313,7 +28499,7 @@ interface operations {
|
|
|
28313
28499
|
list_deleted_documents: {
|
|
28314
28500
|
parameters: {
|
|
28315
28501
|
query?: {
|
|
28316
|
-
/** @description
|
|
28502
|
+
/** @description The workspace to act on; defaults to the active workspace */
|
|
28317
28503
|
workspace_ext_id?: string | null;
|
|
28318
28504
|
};
|
|
28319
28505
|
header?: never;
|
|
@@ -28345,7 +28531,7 @@ interface operations {
|
|
|
28345
28531
|
purge_deleted_documents: {
|
|
28346
28532
|
parameters: {
|
|
28347
28533
|
query?: {
|
|
28348
|
-
/** @description
|
|
28534
|
+
/** @description The workspace to act on; defaults to the active workspace */
|
|
28349
28535
|
workspace_ext_id?: string | null;
|
|
28350
28536
|
};
|
|
28351
28537
|
header?: never;
|
|
@@ -28381,7 +28567,7 @@ interface operations {
|
|
|
28381
28567
|
restore_documents: {
|
|
28382
28568
|
parameters: {
|
|
28383
28569
|
query?: {
|
|
28384
|
-
/** @description
|
|
28570
|
+
/** @description The workspace to act on; defaults to the active workspace */
|
|
28385
28571
|
workspace_ext_id?: string | null;
|
|
28386
28572
|
};
|
|
28387
28573
|
header?: never;
|
package/dist/index.d.ts
CHANGED
|
@@ -869,6 +869,37 @@ interface paths {
|
|
|
869
869
|
patch?: never;
|
|
870
870
|
trace?: never;
|
|
871
871
|
};
|
|
872
|
+
'/v1/user/signature': {
|
|
873
|
+
parameters: {
|
|
874
|
+
query?: never;
|
|
875
|
+
header?: never;
|
|
876
|
+
path?: never;
|
|
877
|
+
cookie?: never;
|
|
878
|
+
};
|
|
879
|
+
/**
|
|
880
|
+
* Get Saved Signature
|
|
881
|
+
* @description The caller's saved signature and initials, sealed to their own encryption key (only their browser opens it);
|
|
882
|
+
* ``sealed`` is null when none is saved.
|
|
883
|
+
*/
|
|
884
|
+
get: operations['get_saved_signature'];
|
|
885
|
+
/**
|
|
886
|
+
* Save Signature
|
|
887
|
+
* @description Save (or replace) the caller's signature and initials, sealed in the browser to their own encryption key.
|
|
888
|
+
* Only with the user's explicit consent ("Save to my account for future use"). The server cannot read it.
|
|
889
|
+
*/
|
|
890
|
+
put: operations['save_signature'];
|
|
891
|
+
post?: never;
|
|
892
|
+
/**
|
|
893
|
+
* Delete Saved Signature
|
|
894
|
+
* @description Delete the caller's saved signature and initials completely (the one row that holds them; no copy is kept).
|
|
895
|
+
* Signatures already placed in documents or sealed in signed PDFs are not touched.
|
|
896
|
+
*/
|
|
897
|
+
delete: operations['delete_saved_signature'];
|
|
898
|
+
options?: never;
|
|
899
|
+
head?: never;
|
|
900
|
+
patch?: never;
|
|
901
|
+
trace?: never;
|
|
902
|
+
};
|
|
872
903
|
'/v1/user/settings': {
|
|
873
904
|
parameters: {
|
|
874
905
|
query?: never;
|
|
@@ -1481,6 +1512,9 @@ interface paths {
|
|
|
1481
1512
|
* Remove Workspace Users
|
|
1482
1513
|
* @description Remove users from a workspace (bulk operation). Only workspace owners can remove users.
|
|
1483
1514
|
* Users can also remove themselves from a workspace.
|
|
1515
|
+
*
|
|
1516
|
+
* The workspace is ``workspace_ext_id`` when given (its key must be on the session, e.g. via
|
|
1517
|
+
* ``/prime-key``), else the session's active one; the active workspace is never changed.
|
|
1484
1518
|
*/
|
|
1485
1519
|
delete: operations['remove_workspace_users'];
|
|
1486
1520
|
options?: never;
|
|
@@ -2082,7 +2116,7 @@ interface paths {
|
|
|
2082
2116
|
};
|
|
2083
2117
|
/**
|
|
2084
2118
|
* List Documents
|
|
2085
|
-
* @description List documents in the current workspace.
|
|
2119
|
+
* @description List documents in the current workspace, or the ``workspace_ext_id`` one (its key on the session).
|
|
2086
2120
|
*
|
|
2087
2121
|
* By default returns all documents (no pagination, full shape) since the
|
|
2088
2122
|
* frontend's client-side sort/search/filter needs the complete set.
|
|
@@ -2722,9 +2756,12 @@ interface paths {
|
|
|
2722
2756
|
};
|
|
2723
2757
|
/**
|
|
2724
2758
|
* Suggest Signature Fields
|
|
2725
|
-
* @description Where the document
|
|
2726
|
-
*
|
|
2727
|
-
*
|
|
2759
|
+
* @description Where the document asks for fields. First the signature fields its author placed in the Word document
|
|
2760
|
+
* (``source=anchor``): exactly where each goes, with the signer it names (``signer_email``). Then its signature
|
|
2761
|
+
* blocks (``source=layout``, optional extras): signature lines ("……" / "____") labelled "Director", "Witness name",
|
|
2762
|
+
* "[Signature]", "Date:" and so on, as in the house template's execution blocks, grouped by block with its role so
|
|
2763
|
+
* the author assigns a signer per block. Read from the same PDF the signers will be shown. 409 while a placed field
|
|
2764
|
+
* is still a pending tracked insertion.
|
|
2728
2765
|
*/
|
|
2729
2766
|
get: operations['suggest_signature_fields'];
|
|
2730
2767
|
put?: never;
|
|
@@ -2750,7 +2787,9 @@ interface paths {
|
|
|
2750
2787
|
put?: never;
|
|
2751
2788
|
/**
|
|
2752
2789
|
* Create Signature Request
|
|
2753
|
-
* @description Ask
|
|
2790
|
+
* @description Ask people to sign a document at the fields placed on it: workspace members (``usr-*``), or anyone by email
|
|
2791
|
+
* (an email that is not a member's makes an *invited* signer, who signs once they join the workspace - invite them
|
|
2792
|
+
* with ``POST /v1/workspace/users``). The fields are on the PDF rendition of
|
|
2754
2793
|
* ``version`` (the one ``GET /view?version=`` serves), which must be the current version and not signed yet. With
|
|
2755
2794
|
* ``send`` the signers are notified straight away; otherwise it is a draft to change and send later.
|
|
2756
2795
|
*/
|
|
@@ -2788,7 +2827,10 @@ interface paths {
|
|
|
2788
2827
|
path?: never;
|
|
2789
2828
|
cookie?: never;
|
|
2790
2829
|
};
|
|
2791
|
-
/**
|
|
2830
|
+
/**
|
|
2831
|
+
* Get Signature Request
|
|
2832
|
+
* @description One request. A signer's first read marks them as having viewed it.
|
|
2833
|
+
*/
|
|
2792
2834
|
get: operations['get_signature_request'];
|
|
2793
2835
|
put?: never;
|
|
2794
2836
|
post?: never;
|
|
@@ -2813,7 +2855,8 @@ interface paths {
|
|
|
2813
2855
|
put?: never;
|
|
2814
2856
|
/**
|
|
2815
2857
|
* Send Signature Request
|
|
2816
|
-
* @description Send a draft: every signer is notified and the fields are fixed.
|
|
2858
|
+
* @description Send a draft: every signer who is a member is notified and the fields are fixed. A signer still invited by
|
|
2859
|
+
* email is asked when they join the workspace.
|
|
2817
2860
|
*/
|
|
2818
2861
|
post: operations['send_signature_request'];
|
|
2819
2862
|
delete?: never;
|
|
@@ -8176,6 +8219,7 @@ interface components {
|
|
|
8176
8219
|
*
|
|
8177
8220
|
* A typed signature is the name rendered in a signature face (as a single signing draws it). A drawn or uploaded
|
|
8178
8221
|
* one is a PNG the browser made (a canvas, or the uploaded image redrawn onto one); the server re-encodes it.
|
|
8222
|
+
* Initials are typed, or drawn (``initials_image``) whichever way the signature was adopted.
|
|
8179
8223
|
*/
|
|
8180
8224
|
AdoptedSignature: {
|
|
8181
8225
|
/**
|
|
@@ -8198,7 +8242,7 @@ interface components {
|
|
|
8198
8242
|
signature_image?: string | null;
|
|
8199
8243
|
/**
|
|
8200
8244
|
* Initials Image
|
|
8201
|
-
* @description Base64 PNG of
|
|
8245
|
+
* @description Base64 PNG of drawn initials (else they are typed)
|
|
8202
8246
|
*/
|
|
8203
8247
|
initials_image?: string | null;
|
|
8204
8248
|
};
|
|
@@ -19097,6 +19141,11 @@ interface components {
|
|
|
19097
19141
|
RemoveWorkspaceUsersRequest: {
|
|
19098
19142
|
/** Users */
|
|
19099
19143
|
users: components['schemas']['RemoveWorkspaceUserItem'][];
|
|
19144
|
+
/**
|
|
19145
|
+
* Workspace Ext Id
|
|
19146
|
+
* @description The workspace to remove them from; defaults to the session's active workspace.
|
|
19147
|
+
*/
|
|
19148
|
+
workspace_ext_id?: string | null;
|
|
19100
19149
|
};
|
|
19101
19150
|
/**
|
|
19102
19151
|
* RequestDeletionResponse
|
|
@@ -20330,6 +20379,28 @@ interface components {
|
|
|
20330
20379
|
*/
|
|
20331
20380
|
title: string;
|
|
20332
20381
|
};
|
|
20382
|
+
/**
|
|
20383
|
+
* SavedSignature
|
|
20384
|
+
* @description A user's saved signature and initials, sealed in the browser to their own X25519 key (``SealedBox`` to
|
|
20385
|
+
* ``users.encryption_key_pub``): the server stores and returns it, and can never read it.
|
|
20386
|
+
*/
|
|
20387
|
+
SavedSignature: {
|
|
20388
|
+
/**
|
|
20389
|
+
* Sealed
|
|
20390
|
+
* @description Base64 SealedBox to the caller's own encryption key of the JSON {name, initials, style, signature_png, initials_png}
|
|
20391
|
+
*/
|
|
20392
|
+
sealed: string;
|
|
20393
|
+
};
|
|
20394
|
+
/** SavedSignatureResponse */
|
|
20395
|
+
SavedSignatureResponse: {
|
|
20396
|
+
/**
|
|
20397
|
+
* Sealed
|
|
20398
|
+
* @description The sealed signature; null when none is saved
|
|
20399
|
+
*/
|
|
20400
|
+
sealed?: string | null;
|
|
20401
|
+
/** Updated At */
|
|
20402
|
+
updated_at?: string | null;
|
|
20403
|
+
};
|
|
20333
20404
|
/**
|
|
20334
20405
|
* SealedConnectorToken
|
|
20335
20406
|
* @description A connector's user-sealed OAuth tokens, for the client to decrypt at login.
|
|
@@ -20723,7 +20794,7 @@ interface components {
|
|
|
20723
20794
|
height: number;
|
|
20724
20795
|
/**
|
|
20725
20796
|
* Signer
|
|
20726
|
-
* @description
|
|
20797
|
+
* @description Who completes this field: a workspace member (usr-*), a pending signer of this request (srs-*), or on input an email address (a member's resolves to their usr-*, anyone else's to a pending srs-* signer, who signs once they join the workspace)
|
|
20727
20798
|
*/
|
|
20728
20799
|
signer: string;
|
|
20729
20800
|
/**
|
|
@@ -20820,16 +20891,28 @@ interface components {
|
|
|
20820
20891
|
};
|
|
20821
20892
|
/** SignatureRequestSigner */
|
|
20822
20893
|
SignatureRequestSigner: {
|
|
20823
|
-
/**
|
|
20824
|
-
|
|
20894
|
+
/**
|
|
20895
|
+
* External Id
|
|
20896
|
+
* @description The signer (srs-*); fields name it while the signer is still invited
|
|
20897
|
+
*/
|
|
20898
|
+
external_id: string;
|
|
20899
|
+
/**
|
|
20900
|
+
* User Ext Id
|
|
20901
|
+
* @description The member (usr-*), once they have joined
|
|
20902
|
+
*/
|
|
20903
|
+
user_ext_id?: string | null;
|
|
20825
20904
|
/**
|
|
20826
20905
|
* Name
|
|
20827
|
-
* @description The member's account name
|
|
20906
|
+
* @description The member's account name (empty while invited)
|
|
20828
20907
|
*/
|
|
20829
20908
|
name: string;
|
|
20830
20909
|
/** Email */
|
|
20831
20910
|
email?: string | null;
|
|
20832
20911
|
status: components['schemas']['SignerStatus'];
|
|
20912
|
+
/** @description invited, registered, viewed, signed or declined */
|
|
20913
|
+
progress: components['schemas']['SignerProgress'];
|
|
20914
|
+
/** Viewed At */
|
|
20915
|
+
viewed_at?: string | null;
|
|
20833
20916
|
/** Signed At */
|
|
20834
20917
|
signed_at?: string | null;
|
|
20835
20918
|
/**
|
|
@@ -20906,6 +20989,11 @@ interface components {
|
|
|
20906
20989
|
*/
|
|
20907
20990
|
name: string;
|
|
20908
20991
|
};
|
|
20992
|
+
/**
|
|
20993
|
+
* SignerProgress
|
|
20994
|
+
* @enum {string}
|
|
20995
|
+
*/
|
|
20996
|
+
SignerProgress: 'invited' | 'registered' | 'viewed' | 'signed' | 'declined';
|
|
20909
20997
|
/**
|
|
20910
20998
|
* SignerStatus
|
|
20911
20999
|
* @enum {string}
|
|
@@ -21064,6 +21152,8 @@ interface components {
|
|
|
21064
21152
|
label: string;
|
|
21065
21153
|
/** Color */
|
|
21066
21154
|
color: string;
|
|
21155
|
+
/** Image */
|
|
21156
|
+
image?: string | null;
|
|
21067
21157
|
};
|
|
21068
21158
|
/**
|
|
21069
21159
|
* StepActionRequest
|
|
@@ -21583,9 +21673,32 @@ interface components {
|
|
|
21583
21673
|
role?: string | null;
|
|
21584
21674
|
/**
|
|
21585
21675
|
* Anchor
|
|
21586
|
-
* @description The text the field was found by
|
|
21676
|
+
* @description The text the field was found by (a placed field's key or kind)
|
|
21587
21677
|
*/
|
|
21588
21678
|
anchor: string;
|
|
21679
|
+
/**
|
|
21680
|
+
* Source
|
|
21681
|
+
* @description anchor: a field the author placed in the Word document, exactly where it goes; layout: found from a signature line, an optional extra
|
|
21682
|
+
* @default layout
|
|
21683
|
+
* @enum {string}
|
|
21684
|
+
*/
|
|
21685
|
+
source: 'anchor' | 'layout';
|
|
21686
|
+
/**
|
|
21687
|
+
* Signer Email
|
|
21688
|
+
* @description The signer the placed field names, if any
|
|
21689
|
+
*/
|
|
21690
|
+
signer_email?: string | null;
|
|
21691
|
+
/**
|
|
21692
|
+
* Signer Name
|
|
21693
|
+
* @description Their name as the field gives it
|
|
21694
|
+
*/
|
|
21695
|
+
signer_name?: string | null;
|
|
21696
|
+
/**
|
|
21697
|
+
* Required
|
|
21698
|
+
* @description Whether the placed field is required
|
|
21699
|
+
* @default true
|
|
21700
|
+
*/
|
|
21701
|
+
required: boolean;
|
|
21589
21702
|
};
|
|
21590
21703
|
/**
|
|
21591
21704
|
* SummariseLLMConfig
|
|
@@ -25633,6 +25746,77 @@ interface operations {
|
|
|
25633
25746
|
};
|
|
25634
25747
|
};
|
|
25635
25748
|
};
|
|
25749
|
+
get_saved_signature: {
|
|
25750
|
+
parameters: {
|
|
25751
|
+
query?: never;
|
|
25752
|
+
header?: never;
|
|
25753
|
+
path?: never;
|
|
25754
|
+
cookie?: never;
|
|
25755
|
+
};
|
|
25756
|
+
requestBody?: never;
|
|
25757
|
+
responses: {
|
|
25758
|
+
/** @description Successful Response */
|
|
25759
|
+
200: {
|
|
25760
|
+
headers: {
|
|
25761
|
+
[name: string]: unknown;
|
|
25762
|
+
};
|
|
25763
|
+
content: {
|
|
25764
|
+
'application/json': components['schemas']['SavedSignatureResponse'];
|
|
25765
|
+
};
|
|
25766
|
+
};
|
|
25767
|
+
};
|
|
25768
|
+
};
|
|
25769
|
+
save_signature: {
|
|
25770
|
+
parameters: {
|
|
25771
|
+
query?: never;
|
|
25772
|
+
header?: never;
|
|
25773
|
+
path?: never;
|
|
25774
|
+
cookie?: never;
|
|
25775
|
+
};
|
|
25776
|
+
requestBody: {
|
|
25777
|
+
content: {
|
|
25778
|
+
'application/json': components['schemas']['SavedSignature'];
|
|
25779
|
+
};
|
|
25780
|
+
};
|
|
25781
|
+
responses: {
|
|
25782
|
+
/** @description Successful Response */
|
|
25783
|
+
200: {
|
|
25784
|
+
headers: {
|
|
25785
|
+
[name: string]: unknown;
|
|
25786
|
+
};
|
|
25787
|
+
content: {
|
|
25788
|
+
'application/json': components['schemas']['SavedSignatureResponse'];
|
|
25789
|
+
};
|
|
25790
|
+
};
|
|
25791
|
+
/** @description Validation Error */
|
|
25792
|
+
422: {
|
|
25793
|
+
headers: {
|
|
25794
|
+
[name: string]: unknown;
|
|
25795
|
+
};
|
|
25796
|
+
content: {
|
|
25797
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
25798
|
+
};
|
|
25799
|
+
};
|
|
25800
|
+
};
|
|
25801
|
+
};
|
|
25802
|
+
delete_saved_signature: {
|
|
25803
|
+
parameters: {
|
|
25804
|
+
query?: never;
|
|
25805
|
+
header?: never;
|
|
25806
|
+
path?: never;
|
|
25807
|
+
cookie?: never;
|
|
25808
|
+
};
|
|
25809
|
+
requestBody?: never;
|
|
25810
|
+
responses: {
|
|
25811
|
+
/** @description Successful Response */
|
|
25812
|
+
204: {
|
|
25813
|
+
headers: {
|
|
25814
|
+
[name: string]: unknown;
|
|
25815
|
+
};
|
|
25816
|
+
content?: never;
|
|
25817
|
+
};
|
|
25818
|
+
};
|
|
25819
|
+
};
|
|
25636
25820
|
get_user_settings: {
|
|
25637
25821
|
parameters: {
|
|
25638
25822
|
query?: never;
|
|
@@ -27492,6 +27676,8 @@ interface operations {
|
|
|
27492
27676
|
order?: string;
|
|
27493
27677
|
/** @description Response payload shape. ``full`` (default) returns DocResponse with doctags and decrypted doc_metadata — unchanged legacy behavior. ``lite`` skips the doctags JOIN and doc_metadata decrypt for each row: doctags=[] and doc_metadata=None. Used by the frontend's progressive loader to halve per-row decrypt work; full metadata is fetched on-demand per doc via /v1/document/ when a row is opened. */
|
|
27494
27678
|
fields?: string;
|
|
27679
|
+
/** @description The workspace to act on; defaults to the active workspace */
|
|
27680
|
+
workspace_ext_id?: string | null;
|
|
27495
27681
|
};
|
|
27496
27682
|
header?: never;
|
|
27497
27683
|
path?: never;
|
|
@@ -27795,7 +27981,7 @@ interface operations {
|
|
|
27795
27981
|
tag_ext_id?: string | null;
|
|
27796
27982
|
/** @description Optional logical folder path (preserved as-is for e-discovery) */
|
|
27797
27983
|
folder?: string | null;
|
|
27798
|
-
/** @description
|
|
27984
|
+
/** @description The workspace to act on; defaults to the active workspace */
|
|
27799
27985
|
workspace_ext_id?: string | null;
|
|
27800
27986
|
};
|
|
27801
27987
|
header?: never;
|
|
@@ -28313,7 +28499,7 @@ interface operations {
|
|
|
28313
28499
|
list_deleted_documents: {
|
|
28314
28500
|
parameters: {
|
|
28315
28501
|
query?: {
|
|
28316
|
-
/** @description
|
|
28502
|
+
/** @description The workspace to act on; defaults to the active workspace */
|
|
28317
28503
|
workspace_ext_id?: string | null;
|
|
28318
28504
|
};
|
|
28319
28505
|
header?: never;
|
|
@@ -28345,7 +28531,7 @@ interface operations {
|
|
|
28345
28531
|
purge_deleted_documents: {
|
|
28346
28532
|
parameters: {
|
|
28347
28533
|
query?: {
|
|
28348
|
-
/** @description
|
|
28534
|
+
/** @description The workspace to act on; defaults to the active workspace */
|
|
28349
28535
|
workspace_ext_id?: string | null;
|
|
28350
28536
|
};
|
|
28351
28537
|
header?: never;
|
|
@@ -28381,7 +28567,7 @@ interface operations {
|
|
|
28381
28567
|
restore_documents: {
|
|
28382
28568
|
parameters: {
|
|
28383
28569
|
query?: {
|
|
28384
|
-
/** @description
|
|
28570
|
+
/** @description The workspace to act on; defaults to the active workspace */
|
|
28385
28571
|
workspace_ext_id?: string | null;
|
|
28386
28572
|
};
|
|
28387
28573
|
header?: never;
|
package/package.json
CHANGED