@arbidocs/client 0.4.101 → 0.4.103
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 +856 -12
- package/dist/index.d.ts +856 -12
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -33,8 +33,7 @@ interface paths {
|
|
|
33
33
|
* a usable project behind. Free projects are usable at once with the free-tier
|
|
34
34
|
* allowance, like the personal project created at signup (see user.py).
|
|
35
35
|
*
|
|
36
|
-
* On a members-only deployment (
|
|
37
|
-
* members may create projects.
|
|
36
|
+
* On a members-only deployment (project creation ``members``, Box) only firm members may create projects.
|
|
38
37
|
*/
|
|
39
38
|
post: operations['create_project'];
|
|
40
39
|
delete?: never;
|
|
@@ -1186,7 +1185,7 @@ interface paths {
|
|
|
1186
1185
|
* - Only members can see the member list
|
|
1187
1186
|
*
|
|
1188
1187
|
* Only users with developer flag can create public workspaces. On a members-only deployment
|
|
1189
|
-
* (
|
|
1188
|
+
* (project creation ``members``, Box) only firm members may create workspaces.
|
|
1190
1189
|
*/
|
|
1191
1190
|
post: operations['create_workspace'];
|
|
1192
1191
|
delete?: never;
|
|
@@ -2338,6 +2337,198 @@ interface paths {
|
|
|
2338
2337
|
patch?: never;
|
|
2339
2338
|
trace?: never;
|
|
2340
2339
|
};
|
|
2340
|
+
'/v1/document/{document_ext_id}/signature-fields/suggest': {
|
|
2341
|
+
parameters: {
|
|
2342
|
+
query?: never;
|
|
2343
|
+
header?: never;
|
|
2344
|
+
path?: never;
|
|
2345
|
+
cookie?: never;
|
|
2346
|
+
};
|
|
2347
|
+
/**
|
|
2348
|
+
* Suggest Signature Fields
|
|
2349
|
+
* @description Where the document's signature blocks ask for fields: signature lines ("……" / "____") labelled "Director",
|
|
2350
|
+
* "Witness name", "[Signature]", "Date:" and so on, as in the house template's execution blocks. Grouped by block,
|
|
2351
|
+
* with its role, so the author assigns a signer per block. Read from the same PDF the signers will be shown.
|
|
2352
|
+
*/
|
|
2353
|
+
get: operations['suggest_signature_fields'];
|
|
2354
|
+
put?: never;
|
|
2355
|
+
post?: never;
|
|
2356
|
+
delete?: never;
|
|
2357
|
+
options?: never;
|
|
2358
|
+
head?: never;
|
|
2359
|
+
patch?: never;
|
|
2360
|
+
trace?: never;
|
|
2361
|
+
};
|
|
2362
|
+
'/v1/document/{document_ext_id}/signature-requests': {
|
|
2363
|
+
parameters: {
|
|
2364
|
+
query?: never;
|
|
2365
|
+
header?: never;
|
|
2366
|
+
path?: never;
|
|
2367
|
+
cookie?: never;
|
|
2368
|
+
};
|
|
2369
|
+
/**
|
|
2370
|
+
* List Document Signature Requests
|
|
2371
|
+
* @description The document's signature requests, newest first.
|
|
2372
|
+
*/
|
|
2373
|
+
get: operations['list_document_signature_requests'];
|
|
2374
|
+
put?: never;
|
|
2375
|
+
/**
|
|
2376
|
+
* Create Signature Request
|
|
2377
|
+
* @description Ask workspace members to sign a document at the fields placed on it. The fields are on the PDF rendition of
|
|
2378
|
+
* ``version`` (the one ``GET /view?version=`` serves), which must be the current version and not signed yet. With
|
|
2379
|
+
* ``send`` the signers are notified straight away; otherwise it is a draft to change and send later.
|
|
2380
|
+
*/
|
|
2381
|
+
post: operations['create_signature_request'];
|
|
2382
|
+
delete?: never;
|
|
2383
|
+
options?: never;
|
|
2384
|
+
head?: never;
|
|
2385
|
+
patch?: never;
|
|
2386
|
+
trace?: never;
|
|
2387
|
+
};
|
|
2388
|
+
'/v1/signature-requests': {
|
|
2389
|
+
parameters: {
|
|
2390
|
+
query?: never;
|
|
2391
|
+
header?: never;
|
|
2392
|
+
path?: never;
|
|
2393
|
+
cookie?: never;
|
|
2394
|
+
};
|
|
2395
|
+
/**
|
|
2396
|
+
* List Signature Requests
|
|
2397
|
+
* @description Signature requests in the active workspace, newest first (at most 100).
|
|
2398
|
+
*/
|
|
2399
|
+
get: operations['list_signature_requests'];
|
|
2400
|
+
put?: never;
|
|
2401
|
+
post?: never;
|
|
2402
|
+
delete?: never;
|
|
2403
|
+
options?: never;
|
|
2404
|
+
head?: never;
|
|
2405
|
+
patch?: never;
|
|
2406
|
+
trace?: never;
|
|
2407
|
+
};
|
|
2408
|
+
'/v1/signature-requests/{request_ext_id}': {
|
|
2409
|
+
parameters: {
|
|
2410
|
+
query?: never;
|
|
2411
|
+
header?: never;
|
|
2412
|
+
path?: never;
|
|
2413
|
+
cookie?: never;
|
|
2414
|
+
};
|
|
2415
|
+
/** Get Signature Request */
|
|
2416
|
+
get: operations['get_signature_request'];
|
|
2417
|
+
put?: never;
|
|
2418
|
+
post?: never;
|
|
2419
|
+
delete?: never;
|
|
2420
|
+
options?: never;
|
|
2421
|
+
head?: never;
|
|
2422
|
+
/**
|
|
2423
|
+
* Update Signature Request
|
|
2424
|
+
* @description Change a draft's fields or message (its author or a workspace owner).
|
|
2425
|
+
*/
|
|
2426
|
+
patch: operations['update_signature_request'];
|
|
2427
|
+
trace?: never;
|
|
2428
|
+
};
|
|
2429
|
+
'/v1/signature-requests/{request_ext_id}/send': {
|
|
2430
|
+
parameters: {
|
|
2431
|
+
query?: never;
|
|
2432
|
+
header?: never;
|
|
2433
|
+
path?: never;
|
|
2434
|
+
cookie?: never;
|
|
2435
|
+
};
|
|
2436
|
+
get?: never;
|
|
2437
|
+
put?: never;
|
|
2438
|
+
/**
|
|
2439
|
+
* Send Signature Request
|
|
2440
|
+
* @description Send a draft: every signer is notified and the fields are fixed.
|
|
2441
|
+
*/
|
|
2442
|
+
post: operations['send_signature_request'];
|
|
2443
|
+
delete?: never;
|
|
2444
|
+
options?: never;
|
|
2445
|
+
head?: never;
|
|
2446
|
+
patch?: never;
|
|
2447
|
+
trace?: never;
|
|
2448
|
+
};
|
|
2449
|
+
'/v1/signature-requests/{request_ext_id}/void': {
|
|
2450
|
+
parameters: {
|
|
2451
|
+
query?: never;
|
|
2452
|
+
header?: never;
|
|
2453
|
+
path?: never;
|
|
2454
|
+
cookie?: never;
|
|
2455
|
+
};
|
|
2456
|
+
get?: never;
|
|
2457
|
+
put?: never;
|
|
2458
|
+
/**
|
|
2459
|
+
* Void Signature Request
|
|
2460
|
+
* @description Withdraw a draft or a sent request (its author or a workspace owner). The document is unchanged.
|
|
2461
|
+
*/
|
|
2462
|
+
post: operations['void_signature_request'];
|
|
2463
|
+
delete?: never;
|
|
2464
|
+
options?: never;
|
|
2465
|
+
head?: never;
|
|
2466
|
+
patch?: never;
|
|
2467
|
+
trace?: never;
|
|
2468
|
+
};
|
|
2469
|
+
'/v1/signature-requests/{request_ext_id}/decline': {
|
|
2470
|
+
parameters: {
|
|
2471
|
+
query?: never;
|
|
2472
|
+
header?: never;
|
|
2473
|
+
path?: never;
|
|
2474
|
+
cookie?: never;
|
|
2475
|
+
};
|
|
2476
|
+
get?: never;
|
|
2477
|
+
put?: never;
|
|
2478
|
+
/**
|
|
2479
|
+
* Decline Signature Request
|
|
2480
|
+
* @description A signer declines: the request ends (``declined``), nothing is drawn, and its author is told.
|
|
2481
|
+
*/
|
|
2482
|
+
post: operations['decline_signature_request'];
|
|
2483
|
+
delete?: never;
|
|
2484
|
+
options?: never;
|
|
2485
|
+
head?: never;
|
|
2486
|
+
patch?: never;
|
|
2487
|
+
trace?: never;
|
|
2488
|
+
};
|
|
2489
|
+
'/v1/signature-requests/{request_ext_id}/sign/prepare': {
|
|
2490
|
+
parameters: {
|
|
2491
|
+
query?: never;
|
|
2492
|
+
header?: never;
|
|
2493
|
+
path?: never;
|
|
2494
|
+
cookie?: never;
|
|
2495
|
+
};
|
|
2496
|
+
get?: never;
|
|
2497
|
+
put?: never;
|
|
2498
|
+
/**
|
|
2499
|
+
* Prepare Signature Request Signing
|
|
2500
|
+
* @description The statement the signer's key signs for all of their fields at once: the PDF they were shown (the request's
|
|
2501
|
+
* version), every field they applied and the signature they adopted. Send the same body to ``/sign``.
|
|
2502
|
+
*/
|
|
2503
|
+
post: operations['prepare_signature_request_signing'];
|
|
2504
|
+
delete?: never;
|
|
2505
|
+
options?: never;
|
|
2506
|
+
head?: never;
|
|
2507
|
+
patch?: never;
|
|
2508
|
+
trace?: never;
|
|
2509
|
+
};
|
|
2510
|
+
'/v1/signature-requests/{request_ext_id}/sign': {
|
|
2511
|
+
parameters: {
|
|
2512
|
+
query?: never;
|
|
2513
|
+
header?: never;
|
|
2514
|
+
path?: never;
|
|
2515
|
+
cookie?: never;
|
|
2516
|
+
};
|
|
2517
|
+
get?: never;
|
|
2518
|
+
put?: never;
|
|
2519
|
+
/**
|
|
2520
|
+
* Sign Signature Request
|
|
2521
|
+
* @description Sign every one of the caller's fields. When this is the last signature, every field is drawn into the PDF,
|
|
2522
|
+
* it is sealed once per signer, saved as the document's next version (reason ``signed``) and each signer gets a
|
|
2523
|
+
* signing record and public certificate; the request is ``completed``.
|
|
2524
|
+
*/
|
|
2525
|
+
post: operations['sign_signature_request'];
|
|
2526
|
+
delete?: never;
|
|
2527
|
+
options?: never;
|
|
2528
|
+
head?: never;
|
|
2529
|
+
patch?: never;
|
|
2530
|
+
trace?: never;
|
|
2531
|
+
};
|
|
2341
2532
|
'/v1/conversation/list': {
|
|
2342
2533
|
parameters: {
|
|
2343
2534
|
query?: never;
|
|
@@ -6598,6 +6789,38 @@ interface components {
|
|
|
6598
6789
|
now: components['schemas']['TaxQuoteResponse'];
|
|
6599
6790
|
renewal: components['schemas']['TaxQuoteResponse'];
|
|
6600
6791
|
};
|
|
6792
|
+
/**
|
|
6793
|
+
* AdoptedSignature
|
|
6794
|
+
* @description What a signer adopts once and applies at each of their fields.
|
|
6795
|
+
*
|
|
6796
|
+
* A typed signature is the name rendered in a signature face (as a single signing draws it). A drawn or uploaded
|
|
6797
|
+
* one is a PNG the browser made (a canvas, or the uploaded image redrawn onto one); the server re-encodes it.
|
|
6798
|
+
*/
|
|
6799
|
+
AdoptedSignature: {
|
|
6800
|
+
/**
|
|
6801
|
+
* Name
|
|
6802
|
+
* @description Full name
|
|
6803
|
+
*/
|
|
6804
|
+
name: string;
|
|
6805
|
+
/** Initials */
|
|
6806
|
+
initials: string;
|
|
6807
|
+
/**
|
|
6808
|
+
* Style
|
|
6809
|
+
* @default typed
|
|
6810
|
+
* @enum {string}
|
|
6811
|
+
*/
|
|
6812
|
+
style: 'typed' | 'drawn' | 'uploaded';
|
|
6813
|
+
/**
|
|
6814
|
+
* Signature Image
|
|
6815
|
+
* @description Base64 PNG of the drawn/uploaded signature (style != typed)
|
|
6816
|
+
*/
|
|
6817
|
+
signature_image?: string | null;
|
|
6818
|
+
/**
|
|
6819
|
+
* Initials Image
|
|
6820
|
+
* @description Base64 PNG of the initials
|
|
6821
|
+
*/
|
|
6822
|
+
initials_image?: string | null;
|
|
6823
|
+
};
|
|
6601
6824
|
/** AgentChatResponse */
|
|
6602
6825
|
AgentChatResponse: {
|
|
6603
6826
|
/** Conversation Ext Id */
|
|
@@ -10506,6 +10729,27 @@ interface components {
|
|
|
10506
10729
|
*/
|
|
10507
10730
|
query: string;
|
|
10508
10731
|
};
|
|
10732
|
+
/** CreateSignatureRequest */
|
|
10733
|
+
CreateSignatureRequest: {
|
|
10734
|
+
/**
|
|
10735
|
+
* Version
|
|
10736
|
+
* @description The version the fields were placed on (its /view PDF). Default: current
|
|
10737
|
+
*/
|
|
10738
|
+
version?: number | null;
|
|
10739
|
+
/** Fields */
|
|
10740
|
+
fields?: components['schemas']['SignatureField'][];
|
|
10741
|
+
/**
|
|
10742
|
+
* Message
|
|
10743
|
+
* @description A note to the signers
|
|
10744
|
+
*/
|
|
10745
|
+
message?: string | null;
|
|
10746
|
+
/**
|
|
10747
|
+
* Send
|
|
10748
|
+
* @description Send it straight away (else it stays a draft)
|
|
10749
|
+
* @default false
|
|
10750
|
+
*/
|
|
10751
|
+
send: boolean;
|
|
10752
|
+
};
|
|
10509
10753
|
/**
|
|
10510
10754
|
* CreateTagRequest
|
|
10511
10755
|
* @description Request to create a new tag in a workspace.
|
|
@@ -11106,6 +11350,11 @@ interface components {
|
|
|
11106
11350
|
/** Content Type */
|
|
11107
11351
|
content_type?: string | null;
|
|
11108
11352
|
};
|
|
11353
|
+
/** DeclineSignatureRequest */
|
|
11354
|
+
DeclineSignatureRequest: {
|
|
11355
|
+
/** Reason */
|
|
11356
|
+
reason?: string | null;
|
|
11357
|
+
};
|
|
11109
11358
|
/**
|
|
11110
11359
|
* DeferredInterjectionEvent
|
|
11111
11360
|
* @description A steering message that arrived too late to steer — owed a new turn.
|
|
@@ -14266,7 +14515,7 @@ interface components {
|
|
|
14266
14515
|
* Type is self-descriptive, no need to parse content field.
|
|
14267
14516
|
* @enum {string}
|
|
14268
14517
|
*/
|
|
14269
|
-
NotificationType: 'user_message' | 'workspaceuser_added_owner' | 'workspaceuser_added_collaborator' | 'workspaceuser_added_guest' | 'workspaceuser_removed' | 'workspaceuser_updated_owner' | 'workspaceuser_updated_collaborator' | 'workspaceuser_updated_guest' | 'contact_accepted' | 'signup_reward' | 'referral_reward' | 'native_mail_received' | 'mail_draft_ready' | 'email_reply' | 'quota_threshold_50' | 'quota_threshold_90' | 'quota_threshold_100' | 'doc_shared' | 'docx_mention' | 'workspace_access_request' | 'conversation_ready' | 'conversation_done' | 'conversation_notified' | 'workflow_failed' | 'agent_input_requested' | 'workflow_completed' | 'workflow_signal' | 'step_ready' | 'task_started' | 'task_completed' | 'mailbox_sync_complete' | 'drive_sync_complete' | 'activity' | 'mention' | 'thread_reply' | 'document_activity' | 'call_missed' | 'calendar_invite' | 'calendar_update' | 'calendar_cancel' | 'calendar_reply' | 'calendar_counter' | 'calendar_reminder' | 'calendar_share';
|
|
14518
|
+
NotificationType: 'user_message' | 'workspaceuser_added_owner' | 'workspaceuser_added_collaborator' | 'workspaceuser_added_guest' | 'workspaceuser_removed' | 'workspaceuser_updated_owner' | 'workspaceuser_updated_collaborator' | 'workspaceuser_updated_guest' | 'contact_accepted' | 'signup_reward' | 'referral_reward' | 'native_mail_received' | 'mail_draft_ready' | 'email_reply' | 'quota_threshold_50' | 'quota_threshold_90' | 'quota_threshold_100' | 'doc_shared' | 'docx_mention' | 'signature_requested' | 'signature_completed' | 'signature_declined' | 'workspace_access_request' | 'conversation_ready' | 'conversation_done' | 'conversation_notified' | 'workflow_failed' | 'agent_input_requested' | 'workflow_completed' | 'workflow_signal' | 'step_ready' | 'task_started' | 'task_completed' | 'mailbox_sync_complete' | 'drive_sync_complete' | 'activity' | 'mention' | 'thread_reply' | 'document_activity' | 'call_missed' | 'calendar_invite' | 'calendar_update' | 'calendar_cancel' | 'calendar_reply' | 'calendar_counter' | 'calendar_reminder' | 'calendar_share';
|
|
14270
14519
|
/**
|
|
14271
14520
|
* NotificationUpdate
|
|
14272
14521
|
* @description Single notification update for bulk PATCH.
|
|
@@ -17454,6 +17703,62 @@ interface components {
|
|
|
17454
17703
|
version: number;
|
|
17455
17704
|
signature: components['schemas']['SignatureRecord'];
|
|
17456
17705
|
};
|
|
17706
|
+
/** SignRequestPrepare */
|
|
17707
|
+
SignRequestPrepare: {
|
|
17708
|
+
adopted: components['schemas']['AdoptedSignature'];
|
|
17709
|
+
/**
|
|
17710
|
+
* Fields
|
|
17711
|
+
* @description The ids of the fields the signer applied: all of their required ones
|
|
17712
|
+
*/
|
|
17713
|
+
fields: string[];
|
|
17714
|
+
};
|
|
17715
|
+
/** SignRequestPrepareResponse */
|
|
17716
|
+
SignRequestPrepareResponse: {
|
|
17717
|
+
/**
|
|
17718
|
+
* Statement
|
|
17719
|
+
* @description The exact text to sign with the user's Ed25519 key
|
|
17720
|
+
*/
|
|
17721
|
+
statement: string;
|
|
17722
|
+
/**
|
|
17723
|
+
* Intent
|
|
17724
|
+
* @description The statement of intent shown to the signer
|
|
17725
|
+
*/
|
|
17726
|
+
intent: string;
|
|
17727
|
+
/**
|
|
17728
|
+
* Source Sha256
|
|
17729
|
+
* @description SHA-256 of the PDF the signer is shown (the /view rendition of that version)
|
|
17730
|
+
*/
|
|
17731
|
+
source_sha256: string;
|
|
17732
|
+
/** Timestamp */
|
|
17733
|
+
timestamp: number;
|
|
17734
|
+
};
|
|
17735
|
+
/** SignRequestSign */
|
|
17736
|
+
SignRequestSign: {
|
|
17737
|
+
adopted: components['schemas']['AdoptedSignature'];
|
|
17738
|
+
/**
|
|
17739
|
+
* Fields
|
|
17740
|
+
* @description The ids of the fields the signer applied: all of their required ones
|
|
17741
|
+
*/
|
|
17742
|
+
fields: string[];
|
|
17743
|
+
/** Timestamp */
|
|
17744
|
+
timestamp: number;
|
|
17745
|
+
/**
|
|
17746
|
+
* Signature
|
|
17747
|
+
* @description Ed25519 signature (base64) of the prepared statement
|
|
17748
|
+
*/
|
|
17749
|
+
signature: string;
|
|
17750
|
+
};
|
|
17751
|
+
/** SignRequestSignResponse */
|
|
17752
|
+
SignRequestSignResponse: {
|
|
17753
|
+
request: components['schemas']['SignatureRequestResponse'];
|
|
17754
|
+
/**
|
|
17755
|
+
* Completed
|
|
17756
|
+
* @description This was the last signature: the signed copy is saved
|
|
17757
|
+
*/
|
|
17758
|
+
completed: boolean;
|
|
17759
|
+
/** Signed Version */
|
|
17760
|
+
signed_version?: number | null;
|
|
17761
|
+
};
|
|
17457
17762
|
/**
|
|
17458
17763
|
* SignatureAppearance
|
|
17459
17764
|
* @description Where the visible signature goes. Coordinates are fractions of the page, origin top-left.
|
|
@@ -17486,6 +17791,48 @@ interface components {
|
|
|
17486
17791
|
*/
|
|
17487
17792
|
height: number;
|
|
17488
17793
|
};
|
|
17794
|
+
/**
|
|
17795
|
+
* SignatureField
|
|
17796
|
+
* @description One place a signer acts. Coordinates are fractions of the page as shown, origin top-left (like
|
|
17797
|
+
* ``SignatureAppearance``); ``page`` is 0-based.
|
|
17798
|
+
*/
|
|
17799
|
+
SignatureField: {
|
|
17800
|
+
/**
|
|
17801
|
+
* Id
|
|
17802
|
+
* @description Unique within the request; chosen by the client
|
|
17803
|
+
*/
|
|
17804
|
+
id: string;
|
|
17805
|
+
/**
|
|
17806
|
+
* Type
|
|
17807
|
+
* @description signature (the adopted signature), initials, date (the signing date) or name (printed name)
|
|
17808
|
+
* @enum {string}
|
|
17809
|
+
*/
|
|
17810
|
+
type: 'signature' | 'initials' | 'date' | 'name';
|
|
17811
|
+
/**
|
|
17812
|
+
* Page
|
|
17813
|
+
* @description 0-based page index
|
|
17814
|
+
*/
|
|
17815
|
+
page: number;
|
|
17816
|
+
/** X */
|
|
17817
|
+
x: number;
|
|
17818
|
+
/** Y */
|
|
17819
|
+
y: number;
|
|
17820
|
+
/** Width */
|
|
17821
|
+
width: number;
|
|
17822
|
+
/** Height */
|
|
17823
|
+
height: number;
|
|
17824
|
+
/**
|
|
17825
|
+
* Signer
|
|
17826
|
+
* @description The workspace member who completes this field
|
|
17827
|
+
*/
|
|
17828
|
+
signer: string;
|
|
17829
|
+
/**
|
|
17830
|
+
* Required
|
|
17831
|
+
* @description An optional field may be left out by its signer
|
|
17832
|
+
* @default true
|
|
17833
|
+
*/
|
|
17834
|
+
required: boolean;
|
|
17835
|
+
};
|
|
17489
17836
|
/** SignatureRecord */
|
|
17490
17837
|
SignatureRecord: {
|
|
17491
17838
|
/** Reference */
|
|
@@ -17522,18 +17869,97 @@ interface components {
|
|
|
17522
17869
|
*/
|
|
17523
17870
|
certificate_url: string;
|
|
17524
17871
|
};
|
|
17525
|
-
/**
|
|
17526
|
-
|
|
17872
|
+
/** SignatureRequestResponse */
|
|
17873
|
+
SignatureRequestResponse: {
|
|
17874
|
+
/** External Id */
|
|
17875
|
+
external_id: string;
|
|
17876
|
+
/** Doc Ext Id */
|
|
17877
|
+
doc_ext_id: string | null;
|
|
17527
17878
|
/**
|
|
17528
|
-
*
|
|
17529
|
-
* @description
|
|
17879
|
+
* Version
|
|
17880
|
+
* @description The document version the fields are on
|
|
17530
17881
|
*/
|
|
17531
|
-
|
|
17882
|
+
version: number;
|
|
17532
17883
|
/**
|
|
17533
|
-
*
|
|
17534
|
-
* @description
|
|
17884
|
+
* Source Sha256
|
|
17885
|
+
* @description SHA-256 of that version's PDF (what every signer is shown)
|
|
17535
17886
|
*/
|
|
17536
|
-
|
|
17887
|
+
source_sha256: string;
|
|
17888
|
+
status: components['schemas']['SignatureRequestStatus'];
|
|
17889
|
+
/** Message */
|
|
17890
|
+
message?: string | null;
|
|
17891
|
+
/** Fields */
|
|
17892
|
+
fields: components['schemas']['SignatureField'][];
|
|
17893
|
+
/** Signers */
|
|
17894
|
+
signers: components['schemas']['SignatureRequestSigner'][];
|
|
17895
|
+
/**
|
|
17896
|
+
* Created By
|
|
17897
|
+
* @description The author (usr-*)
|
|
17898
|
+
*/
|
|
17899
|
+
created_by?: string | null;
|
|
17900
|
+
/**
|
|
17901
|
+
* Created At
|
|
17902
|
+
* Format: date-time
|
|
17903
|
+
*/
|
|
17904
|
+
created_at: string;
|
|
17905
|
+
/** Sent At */
|
|
17906
|
+
sent_at?: string | null;
|
|
17907
|
+
/** Completed At */
|
|
17908
|
+
completed_at?: string | null;
|
|
17909
|
+
/**
|
|
17910
|
+
* Signed Version
|
|
17911
|
+
* @description The version holding the signed PDF
|
|
17912
|
+
*/
|
|
17913
|
+
signed_version?: number | null;
|
|
17914
|
+
/**
|
|
17915
|
+
* Stale
|
|
17916
|
+
* @description The document has a newer version than the one the fields are on
|
|
17917
|
+
* @default false
|
|
17918
|
+
*/
|
|
17919
|
+
stale: boolean;
|
|
17920
|
+
};
|
|
17921
|
+
/** SignatureRequestSigner */
|
|
17922
|
+
SignatureRequestSigner: {
|
|
17923
|
+
/** User Ext Id */
|
|
17924
|
+
user_ext_id: string;
|
|
17925
|
+
/**
|
|
17926
|
+
* Name
|
|
17927
|
+
* @description The member's account name
|
|
17928
|
+
*/
|
|
17929
|
+
name: string;
|
|
17930
|
+
/** Email */
|
|
17931
|
+
email?: string | null;
|
|
17932
|
+
status: components['schemas']['SignerStatus'];
|
|
17933
|
+
/** Signed At */
|
|
17934
|
+
signed_at?: string | null;
|
|
17935
|
+
/**
|
|
17936
|
+
* Reference
|
|
17937
|
+
* @description Their signing's certificate reference, once final
|
|
17938
|
+
*/
|
|
17939
|
+
reference?: string | null;
|
|
17940
|
+
/**
|
|
17941
|
+
* Fields
|
|
17942
|
+
* @description How many fields are theirs
|
|
17943
|
+
*/
|
|
17944
|
+
fields: number;
|
|
17945
|
+
};
|
|
17946
|
+
/**
|
|
17947
|
+
* SignatureRequestStatus
|
|
17948
|
+
* @enum {string}
|
|
17949
|
+
*/
|
|
17950
|
+
SignatureRequestStatus: 'draft' | 'sent' | 'completed' | 'declined' | 'voided';
|
|
17951
|
+
/** SignatureStatusResponse */
|
|
17952
|
+
SignatureStatusResponse: {
|
|
17953
|
+
/**
|
|
17954
|
+
* Signed
|
|
17955
|
+
* @description This document version is a PDF signed and sealed by ARBI
|
|
17956
|
+
*/
|
|
17957
|
+
signed: boolean;
|
|
17958
|
+
/**
|
|
17959
|
+
* Intact
|
|
17960
|
+
* @description The seal verifies: nothing changed since signing
|
|
17961
|
+
*/
|
|
17962
|
+
intact: boolean;
|
|
17537
17963
|
/**
|
|
17538
17964
|
* Timestamped
|
|
17539
17965
|
* @description The seal carries an RFC 3161 timestamp
|
|
@@ -17580,6 +18006,11 @@ interface components {
|
|
|
17580
18006
|
*/
|
|
17581
18007
|
name: string;
|
|
17582
18008
|
};
|
|
18009
|
+
/**
|
|
18010
|
+
* SignerStatus
|
|
18011
|
+
* @enum {string}
|
|
18012
|
+
*/
|
|
18013
|
+
SignerStatus: 'pending' | 'signed' | 'declined';
|
|
17583
18014
|
/**
|
|
17584
18015
|
* SkillSummaryResponse
|
|
17585
18016
|
* @description One row of ``GET /v1/assistant/skills``.
|
|
@@ -17998,6 +18429,44 @@ interface components {
|
|
|
17998
18429
|
*/
|
|
17999
18430
|
status: string;
|
|
18000
18431
|
};
|
|
18432
|
+
/** SuggestSignatureFieldsResponse */
|
|
18433
|
+
SuggestSignatureFieldsResponse: {
|
|
18434
|
+
/** Fields */
|
|
18435
|
+
fields: components['schemas']['SuggestedSignatureField'][];
|
|
18436
|
+
};
|
|
18437
|
+
/** SuggestedSignatureField */
|
|
18438
|
+
SuggestedSignatureField: {
|
|
18439
|
+
/**
|
|
18440
|
+
* Type
|
|
18441
|
+
* @enum {string}
|
|
18442
|
+
*/
|
|
18443
|
+
type: 'signature' | 'initials' | 'date' | 'name';
|
|
18444
|
+
/** Page */
|
|
18445
|
+
page: number;
|
|
18446
|
+
/** X */
|
|
18447
|
+
x: number;
|
|
18448
|
+
/** Y */
|
|
18449
|
+
y: number;
|
|
18450
|
+
/** Width */
|
|
18451
|
+
width: number;
|
|
18452
|
+
/** Height */
|
|
18453
|
+
height: number;
|
|
18454
|
+
/**
|
|
18455
|
+
* Group
|
|
18456
|
+
* @description Fields of one signature block share a group (assign a signer per group)
|
|
18457
|
+
*/
|
|
18458
|
+
group: number;
|
|
18459
|
+
/**
|
|
18460
|
+
* Role
|
|
18461
|
+
* @description The block's role label, e.g. Director, Witness
|
|
18462
|
+
*/
|
|
18463
|
+
role?: string | null;
|
|
18464
|
+
/**
|
|
18465
|
+
* Anchor
|
|
18466
|
+
* @description The text the field was found by
|
|
18467
|
+
*/
|
|
18468
|
+
anchor: string;
|
|
18469
|
+
};
|
|
18001
18470
|
/**
|
|
18002
18471
|
* SummariseLLMConfig
|
|
18003
18472
|
* @description Configuration for conversation summarisation. Used for compaction and general summaries.
|
|
@@ -19113,6 +19582,16 @@ interface components {
|
|
|
19113
19582
|
*/
|
|
19114
19583
|
is_identity_verified: boolean;
|
|
19115
19584
|
};
|
|
19585
|
+
/**
|
|
19586
|
+
* UpdateSignatureRequest
|
|
19587
|
+
* @description Only a draft changes. Omitted fields stay as they are.
|
|
19588
|
+
*/
|
|
19589
|
+
UpdateSignatureRequest: {
|
|
19590
|
+
/** Fields */
|
|
19591
|
+
fields?: components['schemas']['SignatureField'][] | null;
|
|
19592
|
+
/** Message */
|
|
19593
|
+
message?: string | null;
|
|
19594
|
+
};
|
|
19116
19595
|
/**
|
|
19117
19596
|
* UpdateTagKindRequest
|
|
19118
19597
|
* @description The kind's fields, in full and in order: give a field's id to keep it (its type cannot change; its name and
|
|
@@ -24077,6 +24556,371 @@ interface operations {
|
|
|
24077
24556
|
};
|
|
24078
24557
|
};
|
|
24079
24558
|
};
|
|
24559
|
+
suggest_signature_fields: {
|
|
24560
|
+
parameters: {
|
|
24561
|
+
query?: {
|
|
24562
|
+
/** @description The version shown (default: the current one) */
|
|
24563
|
+
version?: number | null;
|
|
24564
|
+
};
|
|
24565
|
+
header?: never;
|
|
24566
|
+
path: {
|
|
24567
|
+
document_ext_id: string;
|
|
24568
|
+
};
|
|
24569
|
+
cookie?: never;
|
|
24570
|
+
};
|
|
24571
|
+
requestBody?: never;
|
|
24572
|
+
responses: {
|
|
24573
|
+
/** @description Successful Response */
|
|
24574
|
+
200: {
|
|
24575
|
+
headers: {
|
|
24576
|
+
[name: string]: unknown;
|
|
24577
|
+
};
|
|
24578
|
+
content: {
|
|
24579
|
+
'application/json': components['schemas']['SuggestSignatureFieldsResponse'];
|
|
24580
|
+
};
|
|
24581
|
+
};
|
|
24582
|
+
/** @description Validation Error */
|
|
24583
|
+
422: {
|
|
24584
|
+
headers: {
|
|
24585
|
+
[name: string]: unknown;
|
|
24586
|
+
};
|
|
24587
|
+
content: {
|
|
24588
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
24589
|
+
};
|
|
24590
|
+
};
|
|
24591
|
+
};
|
|
24592
|
+
};
|
|
24593
|
+
list_document_signature_requests: {
|
|
24594
|
+
parameters: {
|
|
24595
|
+
query?: never;
|
|
24596
|
+
header?: never;
|
|
24597
|
+
path: {
|
|
24598
|
+
document_ext_id: string;
|
|
24599
|
+
};
|
|
24600
|
+
cookie?: never;
|
|
24601
|
+
};
|
|
24602
|
+
requestBody?: never;
|
|
24603
|
+
responses: {
|
|
24604
|
+
/** @description Successful Response */
|
|
24605
|
+
200: {
|
|
24606
|
+
headers: {
|
|
24607
|
+
[name: string]: unknown;
|
|
24608
|
+
};
|
|
24609
|
+
content: {
|
|
24610
|
+
'application/json': components['schemas']['SignatureRequestResponse'][];
|
|
24611
|
+
};
|
|
24612
|
+
};
|
|
24613
|
+
/** @description Validation Error */
|
|
24614
|
+
422: {
|
|
24615
|
+
headers: {
|
|
24616
|
+
[name: string]: unknown;
|
|
24617
|
+
};
|
|
24618
|
+
content: {
|
|
24619
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
24620
|
+
};
|
|
24621
|
+
};
|
|
24622
|
+
};
|
|
24623
|
+
};
|
|
24624
|
+
create_signature_request: {
|
|
24625
|
+
parameters: {
|
|
24626
|
+
query?: never;
|
|
24627
|
+
header?: never;
|
|
24628
|
+
path: {
|
|
24629
|
+
document_ext_id: string;
|
|
24630
|
+
};
|
|
24631
|
+
cookie?: never;
|
|
24632
|
+
};
|
|
24633
|
+
requestBody: {
|
|
24634
|
+
content: {
|
|
24635
|
+
'application/json': components['schemas']['CreateSignatureRequest'];
|
|
24636
|
+
};
|
|
24637
|
+
};
|
|
24638
|
+
responses: {
|
|
24639
|
+
/** @description Successful Response */
|
|
24640
|
+
200: {
|
|
24641
|
+
headers: {
|
|
24642
|
+
[name: string]: unknown;
|
|
24643
|
+
};
|
|
24644
|
+
content: {
|
|
24645
|
+
'application/json': components['schemas']['SignatureRequestResponse'];
|
|
24646
|
+
};
|
|
24647
|
+
};
|
|
24648
|
+
/** @description Validation Error */
|
|
24649
|
+
422: {
|
|
24650
|
+
headers: {
|
|
24651
|
+
[name: string]: unknown;
|
|
24652
|
+
};
|
|
24653
|
+
content: {
|
|
24654
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
24655
|
+
};
|
|
24656
|
+
};
|
|
24657
|
+
};
|
|
24658
|
+
};
|
|
24659
|
+
list_signature_requests: {
|
|
24660
|
+
parameters: {
|
|
24661
|
+
query?: {
|
|
24662
|
+
/** @description Only requests sent and still waiting on the caller's signature */
|
|
24663
|
+
awaiting_me?: boolean;
|
|
24664
|
+
};
|
|
24665
|
+
header?: never;
|
|
24666
|
+
path?: never;
|
|
24667
|
+
cookie?: never;
|
|
24668
|
+
};
|
|
24669
|
+
requestBody?: never;
|
|
24670
|
+
responses: {
|
|
24671
|
+
/** @description Successful Response */
|
|
24672
|
+
200: {
|
|
24673
|
+
headers: {
|
|
24674
|
+
[name: string]: unknown;
|
|
24675
|
+
};
|
|
24676
|
+
content: {
|
|
24677
|
+
'application/json': components['schemas']['SignatureRequestResponse'][];
|
|
24678
|
+
};
|
|
24679
|
+
};
|
|
24680
|
+
/** @description Validation Error */
|
|
24681
|
+
422: {
|
|
24682
|
+
headers: {
|
|
24683
|
+
[name: string]: unknown;
|
|
24684
|
+
};
|
|
24685
|
+
content: {
|
|
24686
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
24687
|
+
};
|
|
24688
|
+
};
|
|
24689
|
+
};
|
|
24690
|
+
};
|
|
24691
|
+
get_signature_request: {
|
|
24692
|
+
parameters: {
|
|
24693
|
+
query?: never;
|
|
24694
|
+
header?: never;
|
|
24695
|
+
path: {
|
|
24696
|
+
request_ext_id: string;
|
|
24697
|
+
};
|
|
24698
|
+
cookie?: never;
|
|
24699
|
+
};
|
|
24700
|
+
requestBody?: never;
|
|
24701
|
+
responses: {
|
|
24702
|
+
/** @description Successful Response */
|
|
24703
|
+
200: {
|
|
24704
|
+
headers: {
|
|
24705
|
+
[name: string]: unknown;
|
|
24706
|
+
};
|
|
24707
|
+
content: {
|
|
24708
|
+
'application/json': components['schemas']['SignatureRequestResponse'];
|
|
24709
|
+
};
|
|
24710
|
+
};
|
|
24711
|
+
/** @description Validation Error */
|
|
24712
|
+
422: {
|
|
24713
|
+
headers: {
|
|
24714
|
+
[name: string]: unknown;
|
|
24715
|
+
};
|
|
24716
|
+
content: {
|
|
24717
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
24718
|
+
};
|
|
24719
|
+
};
|
|
24720
|
+
};
|
|
24721
|
+
};
|
|
24722
|
+
update_signature_request: {
|
|
24723
|
+
parameters: {
|
|
24724
|
+
query?: never;
|
|
24725
|
+
header?: never;
|
|
24726
|
+
path: {
|
|
24727
|
+
request_ext_id: string;
|
|
24728
|
+
};
|
|
24729
|
+
cookie?: never;
|
|
24730
|
+
};
|
|
24731
|
+
requestBody: {
|
|
24732
|
+
content: {
|
|
24733
|
+
'application/json': components['schemas']['UpdateSignatureRequest'];
|
|
24734
|
+
};
|
|
24735
|
+
};
|
|
24736
|
+
responses: {
|
|
24737
|
+
/** @description Successful Response */
|
|
24738
|
+
200: {
|
|
24739
|
+
headers: {
|
|
24740
|
+
[name: string]: unknown;
|
|
24741
|
+
};
|
|
24742
|
+
content: {
|
|
24743
|
+
'application/json': components['schemas']['SignatureRequestResponse'];
|
|
24744
|
+
};
|
|
24745
|
+
};
|
|
24746
|
+
/** @description Validation Error */
|
|
24747
|
+
422: {
|
|
24748
|
+
headers: {
|
|
24749
|
+
[name: string]: unknown;
|
|
24750
|
+
};
|
|
24751
|
+
content: {
|
|
24752
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
24753
|
+
};
|
|
24754
|
+
};
|
|
24755
|
+
};
|
|
24756
|
+
};
|
|
24757
|
+
send_signature_request: {
|
|
24758
|
+
parameters: {
|
|
24759
|
+
query?: never;
|
|
24760
|
+
header?: never;
|
|
24761
|
+
path: {
|
|
24762
|
+
request_ext_id: string;
|
|
24763
|
+
};
|
|
24764
|
+
cookie?: never;
|
|
24765
|
+
};
|
|
24766
|
+
requestBody?: never;
|
|
24767
|
+
responses: {
|
|
24768
|
+
/** @description Successful Response */
|
|
24769
|
+
200: {
|
|
24770
|
+
headers: {
|
|
24771
|
+
[name: string]: unknown;
|
|
24772
|
+
};
|
|
24773
|
+
content: {
|
|
24774
|
+
'application/json': components['schemas']['SignatureRequestResponse'];
|
|
24775
|
+
};
|
|
24776
|
+
};
|
|
24777
|
+
/** @description Validation Error */
|
|
24778
|
+
422: {
|
|
24779
|
+
headers: {
|
|
24780
|
+
[name: string]: unknown;
|
|
24781
|
+
};
|
|
24782
|
+
content: {
|
|
24783
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
24784
|
+
};
|
|
24785
|
+
};
|
|
24786
|
+
};
|
|
24787
|
+
};
|
|
24788
|
+
void_signature_request: {
|
|
24789
|
+
parameters: {
|
|
24790
|
+
query?: never;
|
|
24791
|
+
header?: never;
|
|
24792
|
+
path: {
|
|
24793
|
+
request_ext_id: string;
|
|
24794
|
+
};
|
|
24795
|
+
cookie?: never;
|
|
24796
|
+
};
|
|
24797
|
+
requestBody?: never;
|
|
24798
|
+
responses: {
|
|
24799
|
+
/** @description Successful Response */
|
|
24800
|
+
200: {
|
|
24801
|
+
headers: {
|
|
24802
|
+
[name: string]: unknown;
|
|
24803
|
+
};
|
|
24804
|
+
content: {
|
|
24805
|
+
'application/json': components['schemas']['SignatureRequestResponse'];
|
|
24806
|
+
};
|
|
24807
|
+
};
|
|
24808
|
+
/** @description Validation Error */
|
|
24809
|
+
422: {
|
|
24810
|
+
headers: {
|
|
24811
|
+
[name: string]: unknown;
|
|
24812
|
+
};
|
|
24813
|
+
content: {
|
|
24814
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
24815
|
+
};
|
|
24816
|
+
};
|
|
24817
|
+
};
|
|
24818
|
+
};
|
|
24819
|
+
decline_signature_request: {
|
|
24820
|
+
parameters: {
|
|
24821
|
+
query?: never;
|
|
24822
|
+
header?: never;
|
|
24823
|
+
path: {
|
|
24824
|
+
request_ext_id: string;
|
|
24825
|
+
};
|
|
24826
|
+
cookie?: never;
|
|
24827
|
+
};
|
|
24828
|
+
requestBody: {
|
|
24829
|
+
content: {
|
|
24830
|
+
'application/json': components['schemas']['DeclineSignatureRequest'];
|
|
24831
|
+
};
|
|
24832
|
+
};
|
|
24833
|
+
responses: {
|
|
24834
|
+
/** @description Successful Response */
|
|
24835
|
+
200: {
|
|
24836
|
+
headers: {
|
|
24837
|
+
[name: string]: unknown;
|
|
24838
|
+
};
|
|
24839
|
+
content: {
|
|
24840
|
+
'application/json': components['schemas']['SignatureRequestResponse'];
|
|
24841
|
+
};
|
|
24842
|
+
};
|
|
24843
|
+
/** @description Validation Error */
|
|
24844
|
+
422: {
|
|
24845
|
+
headers: {
|
|
24846
|
+
[name: string]: unknown;
|
|
24847
|
+
};
|
|
24848
|
+
content: {
|
|
24849
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
24850
|
+
};
|
|
24851
|
+
};
|
|
24852
|
+
};
|
|
24853
|
+
};
|
|
24854
|
+
prepare_signature_request_signing: {
|
|
24855
|
+
parameters: {
|
|
24856
|
+
query?: never;
|
|
24857
|
+
header?: never;
|
|
24858
|
+
path: {
|
|
24859
|
+
request_ext_id: string;
|
|
24860
|
+
};
|
|
24861
|
+
cookie?: never;
|
|
24862
|
+
};
|
|
24863
|
+
requestBody: {
|
|
24864
|
+
content: {
|
|
24865
|
+
'application/json': components['schemas']['SignRequestPrepare'];
|
|
24866
|
+
};
|
|
24867
|
+
};
|
|
24868
|
+
responses: {
|
|
24869
|
+
/** @description Successful Response */
|
|
24870
|
+
200: {
|
|
24871
|
+
headers: {
|
|
24872
|
+
[name: string]: unknown;
|
|
24873
|
+
};
|
|
24874
|
+
content: {
|
|
24875
|
+
'application/json': components['schemas']['SignRequestPrepareResponse'];
|
|
24876
|
+
};
|
|
24877
|
+
};
|
|
24878
|
+
/** @description Validation Error */
|
|
24879
|
+
422: {
|
|
24880
|
+
headers: {
|
|
24881
|
+
[name: string]: unknown;
|
|
24882
|
+
};
|
|
24883
|
+
content: {
|
|
24884
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
24885
|
+
};
|
|
24886
|
+
};
|
|
24887
|
+
};
|
|
24888
|
+
};
|
|
24889
|
+
sign_signature_request: {
|
|
24890
|
+
parameters: {
|
|
24891
|
+
query?: never;
|
|
24892
|
+
header?: never;
|
|
24893
|
+
path: {
|
|
24894
|
+
request_ext_id: string;
|
|
24895
|
+
};
|
|
24896
|
+
cookie?: never;
|
|
24897
|
+
};
|
|
24898
|
+
requestBody: {
|
|
24899
|
+
content: {
|
|
24900
|
+
'application/json': components['schemas']['SignRequestSign'];
|
|
24901
|
+
};
|
|
24902
|
+
};
|
|
24903
|
+
responses: {
|
|
24904
|
+
/** @description Successful Response */
|
|
24905
|
+
200: {
|
|
24906
|
+
headers: {
|
|
24907
|
+
[name: string]: unknown;
|
|
24908
|
+
};
|
|
24909
|
+
content: {
|
|
24910
|
+
'application/json': components['schemas']['SignRequestSignResponse'];
|
|
24911
|
+
};
|
|
24912
|
+
};
|
|
24913
|
+
/** @description Validation Error */
|
|
24914
|
+
422: {
|
|
24915
|
+
headers: {
|
|
24916
|
+
[name: string]: unknown;
|
|
24917
|
+
};
|
|
24918
|
+
content: {
|
|
24919
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
24920
|
+
};
|
|
24921
|
+
};
|
|
24922
|
+
};
|
|
24923
|
+
};
|
|
24080
24924
|
list_conversations: {
|
|
24081
24925
|
parameters: {
|
|
24082
24926
|
query?: never;
|