@arbidocs/client 0.4.58 → 0.4.60
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 +423 -11
- package/dist/index.d.ts +423 -11
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1093,7 +1093,10 @@ interface paths {
|
|
|
1093
1093
|
};
|
|
1094
1094
|
get?: never;
|
|
1095
1095
|
put?: never;
|
|
1096
|
-
/**
|
|
1096
|
+
/**
|
|
1097
|
+
* Create Docx Note
|
|
1098
|
+
* @description Store a DOCX note: a new document, or (``version_of``) the next version of an editable one.
|
|
1099
|
+
*/
|
|
1097
1100
|
post: operations['create_docx_note_v1_editor_notes_post'];
|
|
1098
1101
|
delete?: never;
|
|
1099
1102
|
options?: never;
|
|
@@ -1144,7 +1147,13 @@ interface paths {
|
|
|
1144
1147
|
};
|
|
1145
1148
|
get?: never;
|
|
1146
1149
|
put?: never;
|
|
1147
|
-
/**
|
|
1150
|
+
/**
|
|
1151
|
+
* Create Word Redline
|
|
1152
|
+
* @description Compare two documents into a NEW redline document (base -> revised).
|
|
1153
|
+
*
|
|
1154
|
+
* Without ``base_ext_id`` the base is the revised document's previous version.
|
|
1155
|
+
* The redline records both inputs as provenance and is shared only if both are.
|
|
1156
|
+
*/
|
|
1148
1157
|
post: operations['create_word_redline_v1_editor_redline_post'];
|
|
1149
1158
|
delete?: never;
|
|
1150
1159
|
options?: never;
|
|
@@ -1227,6 +1236,10 @@ interface paths {
|
|
|
1227
1236
|
/**
|
|
1228
1237
|
* Delete Documents
|
|
1229
1238
|
* @description Delete one or more documents.
|
|
1239
|
+
*
|
|
1240
|
+
* A document is deleted with all its versions (any version's id names it), and an
|
|
1241
|
+
* email with its attachments (an archive with its messages). In-flight processing
|
|
1242
|
+
* is cancelled so a deleted row does not pop back into the Processing tab.
|
|
1230
1243
|
*/
|
|
1231
1244
|
delete: operations['delete_documents'];
|
|
1232
1245
|
options?: never;
|
|
@@ -1251,6 +1264,29 @@ interface paths {
|
|
|
1251
1264
|
patch: operations['update_documents'];
|
|
1252
1265
|
trace?: never;
|
|
1253
1266
|
};
|
|
1267
|
+
'/v1/document/{document_ext_id}/versions': {
|
|
1268
|
+
parameters: {
|
|
1269
|
+
query?: never;
|
|
1270
|
+
header?: never;
|
|
1271
|
+
path?: never;
|
|
1272
|
+
cookie?: never;
|
|
1273
|
+
};
|
|
1274
|
+
/**
|
|
1275
|
+
* List Document Versions
|
|
1276
|
+
* @description Every version of the document ``document_ext_id`` belongs to (any version's id), oldest first.
|
|
1277
|
+
*
|
|
1278
|
+
* ``is_current`` marks the current one. Lists and search show only current
|
|
1279
|
+
* versions; this is how older ones are reached.
|
|
1280
|
+
*/
|
|
1281
|
+
get: operations['list_document_versions'];
|
|
1282
|
+
put?: never;
|
|
1283
|
+
post?: never;
|
|
1284
|
+
delete?: never;
|
|
1285
|
+
options?: never;
|
|
1286
|
+
head?: never;
|
|
1287
|
+
patch?: never;
|
|
1288
|
+
trace?: never;
|
|
1289
|
+
};
|
|
1254
1290
|
'/v1/document/doctag': {
|
|
1255
1291
|
parameters: {
|
|
1256
1292
|
query?: never;
|
|
@@ -1297,8 +1333,9 @@ interface paths {
|
|
|
1297
1333
|
* - For file uploads: standard multipart form with files
|
|
1298
1334
|
* - For artifacts/content: create a file from text content on the client side
|
|
1299
1335
|
*
|
|
1300
|
-
* Optional parameters for
|
|
1301
|
-
* -
|
|
1336
|
+
* Optional parameters for versions, provenance and document typing:
|
|
1337
|
+
* - version_of: Saves the file as the next version of that document
|
|
1338
|
+
* - derived_from + derived_role: Records that the new document was made from another (a crop)
|
|
1302
1339
|
* - wp_type: Document type (source, skill, memory, artifact). Defaults to 'source'.
|
|
1303
1340
|
* - tag_ext_id: Links document to a tag
|
|
1304
1341
|
* - folder: Logical folder path for grouping (URL safe, e.g., 'skills/weather')
|
|
@@ -4286,6 +4323,66 @@ interface paths {
|
|
|
4286
4323
|
patch?: never;
|
|
4287
4324
|
trace?: never;
|
|
4288
4325
|
};
|
|
4326
|
+
'/v1/document/{document_ext_id}/sign/prepare': {
|
|
4327
|
+
parameters: {
|
|
4328
|
+
query?: never;
|
|
4329
|
+
header?: never;
|
|
4330
|
+
path?: never;
|
|
4331
|
+
cookie?: never;
|
|
4332
|
+
};
|
|
4333
|
+
get?: never;
|
|
4334
|
+
put?: never;
|
|
4335
|
+
/**
|
|
4336
|
+
* Prepare Document Signature
|
|
4337
|
+
* @description Return the exact statement the signer's key must sign, and the hash of the PDF they are shown.
|
|
4338
|
+
*/
|
|
4339
|
+
post: operations['prepare_document_signature'];
|
|
4340
|
+
delete?: never;
|
|
4341
|
+
options?: never;
|
|
4342
|
+
head?: never;
|
|
4343
|
+
patch?: never;
|
|
4344
|
+
trace?: never;
|
|
4345
|
+
};
|
|
4346
|
+
'/v1/document/{document_ext_id}/sign': {
|
|
4347
|
+
parameters: {
|
|
4348
|
+
query?: never;
|
|
4349
|
+
header?: never;
|
|
4350
|
+
path?: never;
|
|
4351
|
+
cookie?: never;
|
|
4352
|
+
};
|
|
4353
|
+
get?: never;
|
|
4354
|
+
put?: never;
|
|
4355
|
+
/**
|
|
4356
|
+
* Sign Document
|
|
4357
|
+
* @description Sign a document: verify the signer's statement, seal a signed copy, save it as a new child document.
|
|
4358
|
+
*/
|
|
4359
|
+
post: operations['sign_document'];
|
|
4360
|
+
delete?: never;
|
|
4361
|
+
options?: never;
|
|
4362
|
+
head?: never;
|
|
4363
|
+
patch?: never;
|
|
4364
|
+
trace?: never;
|
|
4365
|
+
};
|
|
4366
|
+
'/v1/document/{document_ext_id}/signatures': {
|
|
4367
|
+
parameters: {
|
|
4368
|
+
query?: never;
|
|
4369
|
+
header?: never;
|
|
4370
|
+
path?: never;
|
|
4371
|
+
cookie?: never;
|
|
4372
|
+
};
|
|
4373
|
+
/**
|
|
4374
|
+
* Get Document Signature Status
|
|
4375
|
+
* @description Is this document a signed copy, and is it unchanged since signing? Read from the PDF itself.
|
|
4376
|
+
*/
|
|
4377
|
+
get: operations['get_document_signature_status'];
|
|
4378
|
+
put?: never;
|
|
4379
|
+
post?: never;
|
|
4380
|
+
delete?: never;
|
|
4381
|
+
options?: never;
|
|
4382
|
+
head?: never;
|
|
4383
|
+
patch?: never;
|
|
4384
|
+
trace?: never;
|
|
4385
|
+
};
|
|
4289
4386
|
}
|
|
4290
4387
|
type webhooks = Record<string, never>;
|
|
4291
4388
|
interface components {
|
|
@@ -5685,10 +5782,10 @@ interface components {
|
|
|
5685
5782
|
*/
|
|
5686
5783
|
version: number;
|
|
5687
5784
|
/**
|
|
5688
|
-
*
|
|
5785
|
+
* Version Of
|
|
5689
5786
|
* @description Document this artifact updates; it is saved as the next version in that document's chain
|
|
5690
5787
|
*/
|
|
5691
|
-
|
|
5788
|
+
version_of?: string | null;
|
|
5692
5789
|
/**
|
|
5693
5790
|
* Message Ext Id
|
|
5694
5791
|
* @description External ID of the assistant message that generated this artifact
|
|
@@ -7321,6 +7418,15 @@ interface components {
|
|
|
7321
7418
|
/** External Ids */
|
|
7322
7419
|
external_ids: string[];
|
|
7323
7420
|
};
|
|
7421
|
+
/**
|
|
7422
|
+
* DerivedFrom
|
|
7423
|
+
* @description One provenance link of a document: it was made from ``doc_ext_id`` as ``role``.
|
|
7424
|
+
*/
|
|
7425
|
+
DerivedFrom: {
|
|
7426
|
+
/** Doc Ext Id */
|
|
7427
|
+
doc_ext_id: string;
|
|
7428
|
+
role: components['schemas']['DocRelationRole'];
|
|
7429
|
+
};
|
|
7324
7430
|
/**
|
|
7325
7431
|
* DmAttachmentUploadResponse
|
|
7326
7432
|
* @description An uploaded, client-encrypted DM attachment blob.
|
|
@@ -7347,6 +7453,12 @@ interface components {
|
|
|
7347
7453
|
/** Title */
|
|
7348
7454
|
title?: string | null;
|
|
7349
7455
|
};
|
|
7456
|
+
/**
|
|
7457
|
+
* DocRelationRole
|
|
7458
|
+
* @description How ``from_doc`` was derived from ``to_doc`` (provenance only, no behaviour).
|
|
7459
|
+
* @enum {string}
|
|
7460
|
+
*/
|
|
7461
|
+
DocRelationRole: 'edit' | 'sync' | 'crop' | 'redline_base' | 'redline_revised';
|
|
7350
7462
|
/** DocResponse */
|
|
7351
7463
|
DocResponse: {
|
|
7352
7464
|
/** External Id */
|
|
@@ -7385,6 +7497,25 @@ interface components {
|
|
|
7385
7497
|
config_ext_id?: string | null;
|
|
7386
7498
|
/** Parent Ext Id */
|
|
7387
7499
|
parent_ext_id?: string | null;
|
|
7500
|
+
/** Lineage Id */
|
|
7501
|
+
lineage_id?: string | null;
|
|
7502
|
+
/**
|
|
7503
|
+
* Version Number
|
|
7504
|
+
* @default 1
|
|
7505
|
+
*/
|
|
7506
|
+
version_number: number;
|
|
7507
|
+
/**
|
|
7508
|
+
* Is Current
|
|
7509
|
+
* @default true
|
|
7510
|
+
*/
|
|
7511
|
+
is_current: boolean;
|
|
7512
|
+
/** Thread Id */
|
|
7513
|
+
thread_id?: string | null;
|
|
7514
|
+
/**
|
|
7515
|
+
* Derived From
|
|
7516
|
+
* @default []
|
|
7517
|
+
*/
|
|
7518
|
+
derived_from: components['schemas']['DerivedFrom'][];
|
|
7388
7519
|
/** Source Message Ext Id */
|
|
7389
7520
|
source_message_ext_id?: string | null;
|
|
7390
7521
|
/** Conversation Ext Id */
|
|
@@ -13004,8 +13135,11 @@ interface components {
|
|
|
13004
13135
|
shared: boolean;
|
|
13005
13136
|
/** Config Ext Id */
|
|
13006
13137
|
config_ext_id?: string | null;
|
|
13007
|
-
/**
|
|
13008
|
-
|
|
13138
|
+
/**
|
|
13139
|
+
* Version Of
|
|
13140
|
+
* @description Upload as the next version of this document (any of its versions)
|
|
13141
|
+
*/
|
|
13142
|
+
version_of?: string | null;
|
|
13009
13143
|
/** Wp Type */
|
|
13010
13144
|
wp_type?: string | null;
|
|
13011
13145
|
/** Tag Ext Id */
|
|
@@ -14016,6 +14150,148 @@ interface components {
|
|
|
14016
14150
|
* @enum {string}
|
|
14017
14151
|
*/
|
|
14018
14152
|
src__models__workflow__AuthMode: 'run_now_temp' | 'scheduled_require_auth' | 'scheduled_permanent';
|
|
14153
|
+
/** PrepareSignatureRequest */
|
|
14154
|
+
PrepareSignatureRequest: {
|
|
14155
|
+
signer: components['schemas']['SignerDetails'];
|
|
14156
|
+
/** @description Omit for the bottom of the last page */
|
|
14157
|
+
appearance?: components['schemas']['SignatureAppearance'] | null;
|
|
14158
|
+
};
|
|
14159
|
+
/** PrepareSignatureResponse */
|
|
14160
|
+
PrepareSignatureResponse: {
|
|
14161
|
+
/**
|
|
14162
|
+
* Statement
|
|
14163
|
+
* @description The exact text to sign with the user's Ed25519 key
|
|
14164
|
+
*/
|
|
14165
|
+
statement: string;
|
|
14166
|
+
/**
|
|
14167
|
+
* Intent
|
|
14168
|
+
* @description The statement of intent shown to the signer
|
|
14169
|
+
*/
|
|
14170
|
+
intent: string;
|
|
14171
|
+
/**
|
|
14172
|
+
* Source Sha256
|
|
14173
|
+
* @description SHA-256 of the PDF the signer is shown (the /view rendition)
|
|
14174
|
+
*/
|
|
14175
|
+
source_sha256: string;
|
|
14176
|
+
/** Timestamp */
|
|
14177
|
+
timestamp: number;
|
|
14178
|
+
};
|
|
14179
|
+
/** SignDocumentRequest */
|
|
14180
|
+
SignDocumentRequest: {
|
|
14181
|
+
signer: components['schemas']['SignerDetails'];
|
|
14182
|
+
/** @description Omit for the bottom of the last page */
|
|
14183
|
+
appearance?: components['schemas']['SignatureAppearance'] | null;
|
|
14184
|
+
/** Timestamp */
|
|
14185
|
+
timestamp: number;
|
|
14186
|
+
/**
|
|
14187
|
+
* Signature
|
|
14188
|
+
* @description Ed25519 signature (base64) of the prepared statement
|
|
14189
|
+
*/
|
|
14190
|
+
signature: string;
|
|
14191
|
+
};
|
|
14192
|
+
/** SignDocumentResponse */
|
|
14193
|
+
SignDocumentResponse: {
|
|
14194
|
+
/** Signed Doc Ext Id */
|
|
14195
|
+
signed_doc_ext_id: string;
|
|
14196
|
+
signature: components['schemas']['SignatureRecord'];
|
|
14197
|
+
};
|
|
14198
|
+
/**
|
|
14199
|
+
* SignatureAppearance
|
|
14200
|
+
* @description Where the visible signature goes. Coordinates are fractions of the page, origin top-left.
|
|
14201
|
+
*/
|
|
14202
|
+
SignatureAppearance: {
|
|
14203
|
+
/**
|
|
14204
|
+
* Page
|
|
14205
|
+
* @description 0-based page index; negative counts from the end (-1 = last page)
|
|
14206
|
+
* @default -1
|
|
14207
|
+
*/
|
|
14208
|
+
page: number;
|
|
14209
|
+
/**
|
|
14210
|
+
* X
|
|
14211
|
+
* @default 0.08
|
|
14212
|
+
*/
|
|
14213
|
+
x: number;
|
|
14214
|
+
/**
|
|
14215
|
+
* Y
|
|
14216
|
+
* @default 0.8
|
|
14217
|
+
*/
|
|
14218
|
+
y: number;
|
|
14219
|
+
/**
|
|
14220
|
+
* Width
|
|
14221
|
+
* @default 0.4
|
|
14222
|
+
*/
|
|
14223
|
+
width: number;
|
|
14224
|
+
/**
|
|
14225
|
+
* Height
|
|
14226
|
+
* @default 0.1
|
|
14227
|
+
*/
|
|
14228
|
+
height: number;
|
|
14229
|
+
};
|
|
14230
|
+
/** SignerDetails */
|
|
14231
|
+
SignerDetails: {
|
|
14232
|
+
/** Name */
|
|
14233
|
+
name: string;
|
|
14234
|
+
/**
|
|
14235
|
+
* Capacity
|
|
14236
|
+
* @description e.g. 'Partner', 'Solicitor'
|
|
14237
|
+
*/
|
|
14238
|
+
capacity?: string | null;
|
|
14239
|
+
/**
|
|
14240
|
+
* On Behalf Of
|
|
14241
|
+
* @description e.g. the firm's name
|
|
14242
|
+
*/
|
|
14243
|
+
on_behalf_of?: string | null;
|
|
14244
|
+
};
|
|
14245
|
+
/** SignatureRecord */
|
|
14246
|
+
SignatureRecord: {
|
|
14247
|
+
/** Reference */
|
|
14248
|
+
reference: string;
|
|
14249
|
+
/** Signer Email */
|
|
14250
|
+
signer_email: string;
|
|
14251
|
+
/** Intent */
|
|
14252
|
+
intent: string;
|
|
14253
|
+
/**
|
|
14254
|
+
* Source Doc Ext Id
|
|
14255
|
+
* @description The document that was signed
|
|
14256
|
+
*/
|
|
14257
|
+
source_doc_ext_id: string;
|
|
14258
|
+
/** Source Sha256 */
|
|
14259
|
+
source_sha256: string;
|
|
14260
|
+
/**
|
|
14261
|
+
* Signed At
|
|
14262
|
+
* Format: date-time
|
|
14263
|
+
*/
|
|
14264
|
+
signed_at: string;
|
|
14265
|
+
/**
|
|
14266
|
+
* Statement Valid
|
|
14267
|
+
* @description The signer's Ed25519 signature over the statement verifies
|
|
14268
|
+
*/
|
|
14269
|
+
statement_valid: boolean;
|
|
14270
|
+
};
|
|
14271
|
+
/** SignatureStatusResponse */
|
|
14272
|
+
SignatureStatusResponse: {
|
|
14273
|
+
/**
|
|
14274
|
+
* Signed
|
|
14275
|
+
* @description This document is a PDF signed and sealed by ARBI
|
|
14276
|
+
*/
|
|
14277
|
+
signed: boolean;
|
|
14278
|
+
/**
|
|
14279
|
+
* Intact
|
|
14280
|
+
* @description The seal verifies: nothing changed since signing
|
|
14281
|
+
*/
|
|
14282
|
+
intact: boolean;
|
|
14283
|
+
/**
|
|
14284
|
+
* Timestamped
|
|
14285
|
+
* @description The seal carries an RFC 3161 timestamp
|
|
14286
|
+
* @default false
|
|
14287
|
+
*/
|
|
14288
|
+
timestamped: boolean;
|
|
14289
|
+
/**
|
|
14290
|
+
* Signatures
|
|
14291
|
+
* @default []
|
|
14292
|
+
*/
|
|
14293
|
+
signatures: components['schemas']['SignatureRecord'][];
|
|
14294
|
+
};
|
|
14019
14295
|
};
|
|
14020
14296
|
responses: never;
|
|
14021
14297
|
parameters: never;
|
|
@@ -15620,7 +15896,7 @@ interface operations {
|
|
|
15620
15896
|
parameters: {
|
|
15621
15897
|
query?: {
|
|
15622
15898
|
title?: string;
|
|
15623
|
-
|
|
15899
|
+
version_of?: string | null;
|
|
15624
15900
|
};
|
|
15625
15901
|
header?: never;
|
|
15626
15902
|
path?: never;
|
|
@@ -15913,6 +16189,37 @@ interface operations {
|
|
|
15913
16189
|
};
|
|
15914
16190
|
};
|
|
15915
16191
|
};
|
|
16192
|
+
list_document_versions: {
|
|
16193
|
+
parameters: {
|
|
16194
|
+
query?: never;
|
|
16195
|
+
header?: never;
|
|
16196
|
+
path: {
|
|
16197
|
+
document_ext_id: string;
|
|
16198
|
+
};
|
|
16199
|
+
cookie?: never;
|
|
16200
|
+
};
|
|
16201
|
+
requestBody?: never;
|
|
16202
|
+
responses: {
|
|
16203
|
+
/** @description Successful Response */
|
|
16204
|
+
200: {
|
|
16205
|
+
headers: {
|
|
16206
|
+
[name: string]: unknown;
|
|
16207
|
+
};
|
|
16208
|
+
content: {
|
|
16209
|
+
'application/json': components['schemas']['DocResponse'][];
|
|
16210
|
+
};
|
|
16211
|
+
};
|
|
16212
|
+
/** @description Validation Error */
|
|
16213
|
+
422: {
|
|
16214
|
+
headers: {
|
|
16215
|
+
[name: string]: unknown;
|
|
16216
|
+
};
|
|
16217
|
+
content: {
|
|
16218
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
16219
|
+
};
|
|
16220
|
+
};
|
|
16221
|
+
};
|
|
16222
|
+
};
|
|
15916
16223
|
create_doctags: {
|
|
15917
16224
|
parameters: {
|
|
15918
16225
|
query?: never;
|
|
@@ -16017,8 +16324,12 @@ interface operations {
|
|
|
16017
16324
|
shared?: boolean;
|
|
16018
16325
|
/** @description Configuration to use for processing */
|
|
16019
16326
|
config_ext_id?: string | null;
|
|
16020
|
-
/** @description
|
|
16021
|
-
|
|
16327
|
+
/** @description Upload a single file as the next version of this document (any of its versions). It becomes the current version and takes the document's sharing, folder and labels. */
|
|
16328
|
+
version_of?: string | null;
|
|
16329
|
+
/** @description A new, separate document made from this one (e.g. a crop); recorded as provenance only */
|
|
16330
|
+
derived_from?: string | null;
|
|
16331
|
+
/** @description How it was made from `derived_from` */
|
|
16332
|
+
derived_role?: ('crop' | 'redline_base' | 'redline_revised') | null;
|
|
16022
16333
|
/** @description Work product type: source, skill, memory, artifact */
|
|
16023
16334
|
wp_type?: string | null;
|
|
16024
16335
|
/** @description Tag to link the document to */
|
|
@@ -20675,6 +20986,107 @@ interface operations {
|
|
|
20675
20986
|
};
|
|
20676
20987
|
};
|
|
20677
20988
|
};
|
|
20989
|
+
prepare_document_signature: {
|
|
20990
|
+
parameters: {
|
|
20991
|
+
query?: never;
|
|
20992
|
+
header?: never;
|
|
20993
|
+
path: {
|
|
20994
|
+
document_ext_id: string;
|
|
20995
|
+
};
|
|
20996
|
+
cookie?: never;
|
|
20997
|
+
};
|
|
20998
|
+
requestBody: {
|
|
20999
|
+
content: {
|
|
21000
|
+
'application/json': components['schemas']['PrepareSignatureRequest'];
|
|
21001
|
+
};
|
|
21002
|
+
};
|
|
21003
|
+
responses: {
|
|
21004
|
+
/** @description Successful Response */
|
|
21005
|
+
200: {
|
|
21006
|
+
headers: {
|
|
21007
|
+
[name: string]: unknown;
|
|
21008
|
+
};
|
|
21009
|
+
content: {
|
|
21010
|
+
'application/json': components['schemas']['PrepareSignatureResponse'];
|
|
21011
|
+
};
|
|
21012
|
+
};
|
|
21013
|
+
/** @description Validation Error */
|
|
21014
|
+
422: {
|
|
21015
|
+
headers: {
|
|
21016
|
+
[name: string]: unknown;
|
|
21017
|
+
};
|
|
21018
|
+
content: {
|
|
21019
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
21020
|
+
};
|
|
21021
|
+
};
|
|
21022
|
+
};
|
|
21023
|
+
};
|
|
21024
|
+
sign_document: {
|
|
21025
|
+
parameters: {
|
|
21026
|
+
query?: never;
|
|
21027
|
+
header?: never;
|
|
21028
|
+
path: {
|
|
21029
|
+
document_ext_id: string;
|
|
21030
|
+
};
|
|
21031
|
+
cookie?: never;
|
|
21032
|
+
};
|
|
21033
|
+
requestBody: {
|
|
21034
|
+
content: {
|
|
21035
|
+
'application/json': components['schemas']['SignDocumentRequest'];
|
|
21036
|
+
};
|
|
21037
|
+
};
|
|
21038
|
+
responses: {
|
|
21039
|
+
/** @description Successful Response */
|
|
21040
|
+
200: {
|
|
21041
|
+
headers: {
|
|
21042
|
+
[name: string]: unknown;
|
|
21043
|
+
};
|
|
21044
|
+
content: {
|
|
21045
|
+
'application/json': components['schemas']['SignDocumentResponse'];
|
|
21046
|
+
};
|
|
21047
|
+
};
|
|
21048
|
+
/** @description Validation Error */
|
|
21049
|
+
422: {
|
|
21050
|
+
headers: {
|
|
21051
|
+
[name: string]: unknown;
|
|
21052
|
+
};
|
|
21053
|
+
content: {
|
|
21054
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
21055
|
+
};
|
|
21056
|
+
};
|
|
21057
|
+
};
|
|
21058
|
+
};
|
|
21059
|
+
get_document_signature_status: {
|
|
21060
|
+
parameters: {
|
|
21061
|
+
query?: never;
|
|
21062
|
+
header?: never;
|
|
21063
|
+
path: {
|
|
21064
|
+
document_ext_id: string;
|
|
21065
|
+
};
|
|
21066
|
+
cookie?: never;
|
|
21067
|
+
};
|
|
21068
|
+
requestBody?: never;
|
|
21069
|
+
responses: {
|
|
21070
|
+
/** @description Successful Response */
|
|
21071
|
+
200: {
|
|
21072
|
+
headers: {
|
|
21073
|
+
[name: string]: unknown;
|
|
21074
|
+
};
|
|
21075
|
+
content: {
|
|
21076
|
+
'application/json': components['schemas']['SignatureStatusResponse'];
|
|
21077
|
+
};
|
|
21078
|
+
};
|
|
21079
|
+
/** @description Validation Error */
|
|
21080
|
+
422: {
|
|
21081
|
+
headers: {
|
|
21082
|
+
[name: string]: unknown;
|
|
21083
|
+
};
|
|
21084
|
+
content: {
|
|
21085
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
21086
|
+
};
|
|
21087
|
+
};
|
|
21088
|
+
};
|
|
21089
|
+
};
|
|
20678
21090
|
}
|
|
20679
21091
|
|
|
20680
21092
|
/**
|
package/dist/index.d.ts
CHANGED
|
@@ -1093,7 +1093,10 @@ interface paths {
|
|
|
1093
1093
|
};
|
|
1094
1094
|
get?: never;
|
|
1095
1095
|
put?: never;
|
|
1096
|
-
/**
|
|
1096
|
+
/**
|
|
1097
|
+
* Create Docx Note
|
|
1098
|
+
* @description Store a DOCX note: a new document, or (``version_of``) the next version of an editable one.
|
|
1099
|
+
*/
|
|
1097
1100
|
post: operations['create_docx_note_v1_editor_notes_post'];
|
|
1098
1101
|
delete?: never;
|
|
1099
1102
|
options?: never;
|
|
@@ -1144,7 +1147,13 @@ interface paths {
|
|
|
1144
1147
|
};
|
|
1145
1148
|
get?: never;
|
|
1146
1149
|
put?: never;
|
|
1147
|
-
/**
|
|
1150
|
+
/**
|
|
1151
|
+
* Create Word Redline
|
|
1152
|
+
* @description Compare two documents into a NEW redline document (base -> revised).
|
|
1153
|
+
*
|
|
1154
|
+
* Without ``base_ext_id`` the base is the revised document's previous version.
|
|
1155
|
+
* The redline records both inputs as provenance and is shared only if both are.
|
|
1156
|
+
*/
|
|
1148
1157
|
post: operations['create_word_redline_v1_editor_redline_post'];
|
|
1149
1158
|
delete?: never;
|
|
1150
1159
|
options?: never;
|
|
@@ -1227,6 +1236,10 @@ interface paths {
|
|
|
1227
1236
|
/**
|
|
1228
1237
|
* Delete Documents
|
|
1229
1238
|
* @description Delete one or more documents.
|
|
1239
|
+
*
|
|
1240
|
+
* A document is deleted with all its versions (any version's id names it), and an
|
|
1241
|
+
* email with its attachments (an archive with its messages). In-flight processing
|
|
1242
|
+
* is cancelled so a deleted row does not pop back into the Processing tab.
|
|
1230
1243
|
*/
|
|
1231
1244
|
delete: operations['delete_documents'];
|
|
1232
1245
|
options?: never;
|
|
@@ -1251,6 +1264,29 @@ interface paths {
|
|
|
1251
1264
|
patch: operations['update_documents'];
|
|
1252
1265
|
trace?: never;
|
|
1253
1266
|
};
|
|
1267
|
+
'/v1/document/{document_ext_id}/versions': {
|
|
1268
|
+
parameters: {
|
|
1269
|
+
query?: never;
|
|
1270
|
+
header?: never;
|
|
1271
|
+
path?: never;
|
|
1272
|
+
cookie?: never;
|
|
1273
|
+
};
|
|
1274
|
+
/**
|
|
1275
|
+
* List Document Versions
|
|
1276
|
+
* @description Every version of the document ``document_ext_id`` belongs to (any version's id), oldest first.
|
|
1277
|
+
*
|
|
1278
|
+
* ``is_current`` marks the current one. Lists and search show only current
|
|
1279
|
+
* versions; this is how older ones are reached.
|
|
1280
|
+
*/
|
|
1281
|
+
get: operations['list_document_versions'];
|
|
1282
|
+
put?: never;
|
|
1283
|
+
post?: never;
|
|
1284
|
+
delete?: never;
|
|
1285
|
+
options?: never;
|
|
1286
|
+
head?: never;
|
|
1287
|
+
patch?: never;
|
|
1288
|
+
trace?: never;
|
|
1289
|
+
};
|
|
1254
1290
|
'/v1/document/doctag': {
|
|
1255
1291
|
parameters: {
|
|
1256
1292
|
query?: never;
|
|
@@ -1297,8 +1333,9 @@ interface paths {
|
|
|
1297
1333
|
* - For file uploads: standard multipart form with files
|
|
1298
1334
|
* - For artifacts/content: create a file from text content on the client side
|
|
1299
1335
|
*
|
|
1300
|
-
* Optional parameters for
|
|
1301
|
-
* -
|
|
1336
|
+
* Optional parameters for versions, provenance and document typing:
|
|
1337
|
+
* - version_of: Saves the file as the next version of that document
|
|
1338
|
+
* - derived_from + derived_role: Records that the new document was made from another (a crop)
|
|
1302
1339
|
* - wp_type: Document type (source, skill, memory, artifact). Defaults to 'source'.
|
|
1303
1340
|
* - tag_ext_id: Links document to a tag
|
|
1304
1341
|
* - folder: Logical folder path for grouping (URL safe, e.g., 'skills/weather')
|
|
@@ -4286,6 +4323,66 @@ interface paths {
|
|
|
4286
4323
|
patch?: never;
|
|
4287
4324
|
trace?: never;
|
|
4288
4325
|
};
|
|
4326
|
+
'/v1/document/{document_ext_id}/sign/prepare': {
|
|
4327
|
+
parameters: {
|
|
4328
|
+
query?: never;
|
|
4329
|
+
header?: never;
|
|
4330
|
+
path?: never;
|
|
4331
|
+
cookie?: never;
|
|
4332
|
+
};
|
|
4333
|
+
get?: never;
|
|
4334
|
+
put?: never;
|
|
4335
|
+
/**
|
|
4336
|
+
* Prepare Document Signature
|
|
4337
|
+
* @description Return the exact statement the signer's key must sign, and the hash of the PDF they are shown.
|
|
4338
|
+
*/
|
|
4339
|
+
post: operations['prepare_document_signature'];
|
|
4340
|
+
delete?: never;
|
|
4341
|
+
options?: never;
|
|
4342
|
+
head?: never;
|
|
4343
|
+
patch?: never;
|
|
4344
|
+
trace?: never;
|
|
4345
|
+
};
|
|
4346
|
+
'/v1/document/{document_ext_id}/sign': {
|
|
4347
|
+
parameters: {
|
|
4348
|
+
query?: never;
|
|
4349
|
+
header?: never;
|
|
4350
|
+
path?: never;
|
|
4351
|
+
cookie?: never;
|
|
4352
|
+
};
|
|
4353
|
+
get?: never;
|
|
4354
|
+
put?: never;
|
|
4355
|
+
/**
|
|
4356
|
+
* Sign Document
|
|
4357
|
+
* @description Sign a document: verify the signer's statement, seal a signed copy, save it as a new child document.
|
|
4358
|
+
*/
|
|
4359
|
+
post: operations['sign_document'];
|
|
4360
|
+
delete?: never;
|
|
4361
|
+
options?: never;
|
|
4362
|
+
head?: never;
|
|
4363
|
+
patch?: never;
|
|
4364
|
+
trace?: never;
|
|
4365
|
+
};
|
|
4366
|
+
'/v1/document/{document_ext_id}/signatures': {
|
|
4367
|
+
parameters: {
|
|
4368
|
+
query?: never;
|
|
4369
|
+
header?: never;
|
|
4370
|
+
path?: never;
|
|
4371
|
+
cookie?: never;
|
|
4372
|
+
};
|
|
4373
|
+
/**
|
|
4374
|
+
* Get Document Signature Status
|
|
4375
|
+
* @description Is this document a signed copy, and is it unchanged since signing? Read from the PDF itself.
|
|
4376
|
+
*/
|
|
4377
|
+
get: operations['get_document_signature_status'];
|
|
4378
|
+
put?: never;
|
|
4379
|
+
post?: never;
|
|
4380
|
+
delete?: never;
|
|
4381
|
+
options?: never;
|
|
4382
|
+
head?: never;
|
|
4383
|
+
patch?: never;
|
|
4384
|
+
trace?: never;
|
|
4385
|
+
};
|
|
4289
4386
|
}
|
|
4290
4387
|
type webhooks = Record<string, never>;
|
|
4291
4388
|
interface components {
|
|
@@ -5685,10 +5782,10 @@ interface components {
|
|
|
5685
5782
|
*/
|
|
5686
5783
|
version: number;
|
|
5687
5784
|
/**
|
|
5688
|
-
*
|
|
5785
|
+
* Version Of
|
|
5689
5786
|
* @description Document this artifact updates; it is saved as the next version in that document's chain
|
|
5690
5787
|
*/
|
|
5691
|
-
|
|
5788
|
+
version_of?: string | null;
|
|
5692
5789
|
/**
|
|
5693
5790
|
* Message Ext Id
|
|
5694
5791
|
* @description External ID of the assistant message that generated this artifact
|
|
@@ -7321,6 +7418,15 @@ interface components {
|
|
|
7321
7418
|
/** External Ids */
|
|
7322
7419
|
external_ids: string[];
|
|
7323
7420
|
};
|
|
7421
|
+
/**
|
|
7422
|
+
* DerivedFrom
|
|
7423
|
+
* @description One provenance link of a document: it was made from ``doc_ext_id`` as ``role``.
|
|
7424
|
+
*/
|
|
7425
|
+
DerivedFrom: {
|
|
7426
|
+
/** Doc Ext Id */
|
|
7427
|
+
doc_ext_id: string;
|
|
7428
|
+
role: components['schemas']['DocRelationRole'];
|
|
7429
|
+
};
|
|
7324
7430
|
/**
|
|
7325
7431
|
* DmAttachmentUploadResponse
|
|
7326
7432
|
* @description An uploaded, client-encrypted DM attachment blob.
|
|
@@ -7347,6 +7453,12 @@ interface components {
|
|
|
7347
7453
|
/** Title */
|
|
7348
7454
|
title?: string | null;
|
|
7349
7455
|
};
|
|
7456
|
+
/**
|
|
7457
|
+
* DocRelationRole
|
|
7458
|
+
* @description How ``from_doc`` was derived from ``to_doc`` (provenance only, no behaviour).
|
|
7459
|
+
* @enum {string}
|
|
7460
|
+
*/
|
|
7461
|
+
DocRelationRole: 'edit' | 'sync' | 'crop' | 'redline_base' | 'redline_revised';
|
|
7350
7462
|
/** DocResponse */
|
|
7351
7463
|
DocResponse: {
|
|
7352
7464
|
/** External Id */
|
|
@@ -7385,6 +7497,25 @@ interface components {
|
|
|
7385
7497
|
config_ext_id?: string | null;
|
|
7386
7498
|
/** Parent Ext Id */
|
|
7387
7499
|
parent_ext_id?: string | null;
|
|
7500
|
+
/** Lineage Id */
|
|
7501
|
+
lineage_id?: string | null;
|
|
7502
|
+
/**
|
|
7503
|
+
* Version Number
|
|
7504
|
+
* @default 1
|
|
7505
|
+
*/
|
|
7506
|
+
version_number: number;
|
|
7507
|
+
/**
|
|
7508
|
+
* Is Current
|
|
7509
|
+
* @default true
|
|
7510
|
+
*/
|
|
7511
|
+
is_current: boolean;
|
|
7512
|
+
/** Thread Id */
|
|
7513
|
+
thread_id?: string | null;
|
|
7514
|
+
/**
|
|
7515
|
+
* Derived From
|
|
7516
|
+
* @default []
|
|
7517
|
+
*/
|
|
7518
|
+
derived_from: components['schemas']['DerivedFrom'][];
|
|
7388
7519
|
/** Source Message Ext Id */
|
|
7389
7520
|
source_message_ext_id?: string | null;
|
|
7390
7521
|
/** Conversation Ext Id */
|
|
@@ -13004,8 +13135,11 @@ interface components {
|
|
|
13004
13135
|
shared: boolean;
|
|
13005
13136
|
/** Config Ext Id */
|
|
13006
13137
|
config_ext_id?: string | null;
|
|
13007
|
-
/**
|
|
13008
|
-
|
|
13138
|
+
/**
|
|
13139
|
+
* Version Of
|
|
13140
|
+
* @description Upload as the next version of this document (any of its versions)
|
|
13141
|
+
*/
|
|
13142
|
+
version_of?: string | null;
|
|
13009
13143
|
/** Wp Type */
|
|
13010
13144
|
wp_type?: string | null;
|
|
13011
13145
|
/** Tag Ext Id */
|
|
@@ -14016,6 +14150,148 @@ interface components {
|
|
|
14016
14150
|
* @enum {string}
|
|
14017
14151
|
*/
|
|
14018
14152
|
src__models__workflow__AuthMode: 'run_now_temp' | 'scheduled_require_auth' | 'scheduled_permanent';
|
|
14153
|
+
/** PrepareSignatureRequest */
|
|
14154
|
+
PrepareSignatureRequest: {
|
|
14155
|
+
signer: components['schemas']['SignerDetails'];
|
|
14156
|
+
/** @description Omit for the bottom of the last page */
|
|
14157
|
+
appearance?: components['schemas']['SignatureAppearance'] | null;
|
|
14158
|
+
};
|
|
14159
|
+
/** PrepareSignatureResponse */
|
|
14160
|
+
PrepareSignatureResponse: {
|
|
14161
|
+
/**
|
|
14162
|
+
* Statement
|
|
14163
|
+
* @description The exact text to sign with the user's Ed25519 key
|
|
14164
|
+
*/
|
|
14165
|
+
statement: string;
|
|
14166
|
+
/**
|
|
14167
|
+
* Intent
|
|
14168
|
+
* @description The statement of intent shown to the signer
|
|
14169
|
+
*/
|
|
14170
|
+
intent: string;
|
|
14171
|
+
/**
|
|
14172
|
+
* Source Sha256
|
|
14173
|
+
* @description SHA-256 of the PDF the signer is shown (the /view rendition)
|
|
14174
|
+
*/
|
|
14175
|
+
source_sha256: string;
|
|
14176
|
+
/** Timestamp */
|
|
14177
|
+
timestamp: number;
|
|
14178
|
+
};
|
|
14179
|
+
/** SignDocumentRequest */
|
|
14180
|
+
SignDocumentRequest: {
|
|
14181
|
+
signer: components['schemas']['SignerDetails'];
|
|
14182
|
+
/** @description Omit for the bottom of the last page */
|
|
14183
|
+
appearance?: components['schemas']['SignatureAppearance'] | null;
|
|
14184
|
+
/** Timestamp */
|
|
14185
|
+
timestamp: number;
|
|
14186
|
+
/**
|
|
14187
|
+
* Signature
|
|
14188
|
+
* @description Ed25519 signature (base64) of the prepared statement
|
|
14189
|
+
*/
|
|
14190
|
+
signature: string;
|
|
14191
|
+
};
|
|
14192
|
+
/** SignDocumentResponse */
|
|
14193
|
+
SignDocumentResponse: {
|
|
14194
|
+
/** Signed Doc Ext Id */
|
|
14195
|
+
signed_doc_ext_id: string;
|
|
14196
|
+
signature: components['schemas']['SignatureRecord'];
|
|
14197
|
+
};
|
|
14198
|
+
/**
|
|
14199
|
+
* SignatureAppearance
|
|
14200
|
+
* @description Where the visible signature goes. Coordinates are fractions of the page, origin top-left.
|
|
14201
|
+
*/
|
|
14202
|
+
SignatureAppearance: {
|
|
14203
|
+
/**
|
|
14204
|
+
* Page
|
|
14205
|
+
* @description 0-based page index; negative counts from the end (-1 = last page)
|
|
14206
|
+
* @default -1
|
|
14207
|
+
*/
|
|
14208
|
+
page: number;
|
|
14209
|
+
/**
|
|
14210
|
+
* X
|
|
14211
|
+
* @default 0.08
|
|
14212
|
+
*/
|
|
14213
|
+
x: number;
|
|
14214
|
+
/**
|
|
14215
|
+
* Y
|
|
14216
|
+
* @default 0.8
|
|
14217
|
+
*/
|
|
14218
|
+
y: number;
|
|
14219
|
+
/**
|
|
14220
|
+
* Width
|
|
14221
|
+
* @default 0.4
|
|
14222
|
+
*/
|
|
14223
|
+
width: number;
|
|
14224
|
+
/**
|
|
14225
|
+
* Height
|
|
14226
|
+
* @default 0.1
|
|
14227
|
+
*/
|
|
14228
|
+
height: number;
|
|
14229
|
+
};
|
|
14230
|
+
/** SignerDetails */
|
|
14231
|
+
SignerDetails: {
|
|
14232
|
+
/** Name */
|
|
14233
|
+
name: string;
|
|
14234
|
+
/**
|
|
14235
|
+
* Capacity
|
|
14236
|
+
* @description e.g. 'Partner', 'Solicitor'
|
|
14237
|
+
*/
|
|
14238
|
+
capacity?: string | null;
|
|
14239
|
+
/**
|
|
14240
|
+
* On Behalf Of
|
|
14241
|
+
* @description e.g. the firm's name
|
|
14242
|
+
*/
|
|
14243
|
+
on_behalf_of?: string | null;
|
|
14244
|
+
};
|
|
14245
|
+
/** SignatureRecord */
|
|
14246
|
+
SignatureRecord: {
|
|
14247
|
+
/** Reference */
|
|
14248
|
+
reference: string;
|
|
14249
|
+
/** Signer Email */
|
|
14250
|
+
signer_email: string;
|
|
14251
|
+
/** Intent */
|
|
14252
|
+
intent: string;
|
|
14253
|
+
/**
|
|
14254
|
+
* Source Doc Ext Id
|
|
14255
|
+
* @description The document that was signed
|
|
14256
|
+
*/
|
|
14257
|
+
source_doc_ext_id: string;
|
|
14258
|
+
/** Source Sha256 */
|
|
14259
|
+
source_sha256: string;
|
|
14260
|
+
/**
|
|
14261
|
+
* Signed At
|
|
14262
|
+
* Format: date-time
|
|
14263
|
+
*/
|
|
14264
|
+
signed_at: string;
|
|
14265
|
+
/**
|
|
14266
|
+
* Statement Valid
|
|
14267
|
+
* @description The signer's Ed25519 signature over the statement verifies
|
|
14268
|
+
*/
|
|
14269
|
+
statement_valid: boolean;
|
|
14270
|
+
};
|
|
14271
|
+
/** SignatureStatusResponse */
|
|
14272
|
+
SignatureStatusResponse: {
|
|
14273
|
+
/**
|
|
14274
|
+
* Signed
|
|
14275
|
+
* @description This document is a PDF signed and sealed by ARBI
|
|
14276
|
+
*/
|
|
14277
|
+
signed: boolean;
|
|
14278
|
+
/**
|
|
14279
|
+
* Intact
|
|
14280
|
+
* @description The seal verifies: nothing changed since signing
|
|
14281
|
+
*/
|
|
14282
|
+
intact: boolean;
|
|
14283
|
+
/**
|
|
14284
|
+
* Timestamped
|
|
14285
|
+
* @description The seal carries an RFC 3161 timestamp
|
|
14286
|
+
* @default false
|
|
14287
|
+
*/
|
|
14288
|
+
timestamped: boolean;
|
|
14289
|
+
/**
|
|
14290
|
+
* Signatures
|
|
14291
|
+
* @default []
|
|
14292
|
+
*/
|
|
14293
|
+
signatures: components['schemas']['SignatureRecord'][];
|
|
14294
|
+
};
|
|
14019
14295
|
};
|
|
14020
14296
|
responses: never;
|
|
14021
14297
|
parameters: never;
|
|
@@ -15620,7 +15896,7 @@ interface operations {
|
|
|
15620
15896
|
parameters: {
|
|
15621
15897
|
query?: {
|
|
15622
15898
|
title?: string;
|
|
15623
|
-
|
|
15899
|
+
version_of?: string | null;
|
|
15624
15900
|
};
|
|
15625
15901
|
header?: never;
|
|
15626
15902
|
path?: never;
|
|
@@ -15913,6 +16189,37 @@ interface operations {
|
|
|
15913
16189
|
};
|
|
15914
16190
|
};
|
|
15915
16191
|
};
|
|
16192
|
+
list_document_versions: {
|
|
16193
|
+
parameters: {
|
|
16194
|
+
query?: never;
|
|
16195
|
+
header?: never;
|
|
16196
|
+
path: {
|
|
16197
|
+
document_ext_id: string;
|
|
16198
|
+
};
|
|
16199
|
+
cookie?: never;
|
|
16200
|
+
};
|
|
16201
|
+
requestBody?: never;
|
|
16202
|
+
responses: {
|
|
16203
|
+
/** @description Successful Response */
|
|
16204
|
+
200: {
|
|
16205
|
+
headers: {
|
|
16206
|
+
[name: string]: unknown;
|
|
16207
|
+
};
|
|
16208
|
+
content: {
|
|
16209
|
+
'application/json': components['schemas']['DocResponse'][];
|
|
16210
|
+
};
|
|
16211
|
+
};
|
|
16212
|
+
/** @description Validation Error */
|
|
16213
|
+
422: {
|
|
16214
|
+
headers: {
|
|
16215
|
+
[name: string]: unknown;
|
|
16216
|
+
};
|
|
16217
|
+
content: {
|
|
16218
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
16219
|
+
};
|
|
16220
|
+
};
|
|
16221
|
+
};
|
|
16222
|
+
};
|
|
15916
16223
|
create_doctags: {
|
|
15917
16224
|
parameters: {
|
|
15918
16225
|
query?: never;
|
|
@@ -16017,8 +16324,12 @@ interface operations {
|
|
|
16017
16324
|
shared?: boolean;
|
|
16018
16325
|
/** @description Configuration to use for processing */
|
|
16019
16326
|
config_ext_id?: string | null;
|
|
16020
|
-
/** @description
|
|
16021
|
-
|
|
16327
|
+
/** @description Upload a single file as the next version of this document (any of its versions). It becomes the current version and takes the document's sharing, folder and labels. */
|
|
16328
|
+
version_of?: string | null;
|
|
16329
|
+
/** @description A new, separate document made from this one (e.g. a crop); recorded as provenance only */
|
|
16330
|
+
derived_from?: string | null;
|
|
16331
|
+
/** @description How it was made from `derived_from` */
|
|
16332
|
+
derived_role?: ('crop' | 'redline_base' | 'redline_revised') | null;
|
|
16022
16333
|
/** @description Work product type: source, skill, memory, artifact */
|
|
16023
16334
|
wp_type?: string | null;
|
|
16024
16335
|
/** @description Tag to link the document to */
|
|
@@ -20675,6 +20986,107 @@ interface operations {
|
|
|
20675
20986
|
};
|
|
20676
20987
|
};
|
|
20677
20988
|
};
|
|
20989
|
+
prepare_document_signature: {
|
|
20990
|
+
parameters: {
|
|
20991
|
+
query?: never;
|
|
20992
|
+
header?: never;
|
|
20993
|
+
path: {
|
|
20994
|
+
document_ext_id: string;
|
|
20995
|
+
};
|
|
20996
|
+
cookie?: never;
|
|
20997
|
+
};
|
|
20998
|
+
requestBody: {
|
|
20999
|
+
content: {
|
|
21000
|
+
'application/json': components['schemas']['PrepareSignatureRequest'];
|
|
21001
|
+
};
|
|
21002
|
+
};
|
|
21003
|
+
responses: {
|
|
21004
|
+
/** @description Successful Response */
|
|
21005
|
+
200: {
|
|
21006
|
+
headers: {
|
|
21007
|
+
[name: string]: unknown;
|
|
21008
|
+
};
|
|
21009
|
+
content: {
|
|
21010
|
+
'application/json': components['schemas']['PrepareSignatureResponse'];
|
|
21011
|
+
};
|
|
21012
|
+
};
|
|
21013
|
+
/** @description Validation Error */
|
|
21014
|
+
422: {
|
|
21015
|
+
headers: {
|
|
21016
|
+
[name: string]: unknown;
|
|
21017
|
+
};
|
|
21018
|
+
content: {
|
|
21019
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
21020
|
+
};
|
|
21021
|
+
};
|
|
21022
|
+
};
|
|
21023
|
+
};
|
|
21024
|
+
sign_document: {
|
|
21025
|
+
parameters: {
|
|
21026
|
+
query?: never;
|
|
21027
|
+
header?: never;
|
|
21028
|
+
path: {
|
|
21029
|
+
document_ext_id: string;
|
|
21030
|
+
};
|
|
21031
|
+
cookie?: never;
|
|
21032
|
+
};
|
|
21033
|
+
requestBody: {
|
|
21034
|
+
content: {
|
|
21035
|
+
'application/json': components['schemas']['SignDocumentRequest'];
|
|
21036
|
+
};
|
|
21037
|
+
};
|
|
21038
|
+
responses: {
|
|
21039
|
+
/** @description Successful Response */
|
|
21040
|
+
200: {
|
|
21041
|
+
headers: {
|
|
21042
|
+
[name: string]: unknown;
|
|
21043
|
+
};
|
|
21044
|
+
content: {
|
|
21045
|
+
'application/json': components['schemas']['SignDocumentResponse'];
|
|
21046
|
+
};
|
|
21047
|
+
};
|
|
21048
|
+
/** @description Validation Error */
|
|
21049
|
+
422: {
|
|
21050
|
+
headers: {
|
|
21051
|
+
[name: string]: unknown;
|
|
21052
|
+
};
|
|
21053
|
+
content: {
|
|
21054
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
21055
|
+
};
|
|
21056
|
+
};
|
|
21057
|
+
};
|
|
21058
|
+
};
|
|
21059
|
+
get_document_signature_status: {
|
|
21060
|
+
parameters: {
|
|
21061
|
+
query?: never;
|
|
21062
|
+
header?: never;
|
|
21063
|
+
path: {
|
|
21064
|
+
document_ext_id: string;
|
|
21065
|
+
};
|
|
21066
|
+
cookie?: never;
|
|
21067
|
+
};
|
|
21068
|
+
requestBody?: never;
|
|
21069
|
+
responses: {
|
|
21070
|
+
/** @description Successful Response */
|
|
21071
|
+
200: {
|
|
21072
|
+
headers: {
|
|
21073
|
+
[name: string]: unknown;
|
|
21074
|
+
};
|
|
21075
|
+
content: {
|
|
21076
|
+
'application/json': components['schemas']['SignatureStatusResponse'];
|
|
21077
|
+
};
|
|
21078
|
+
};
|
|
21079
|
+
/** @description Validation Error */
|
|
21080
|
+
422: {
|
|
21081
|
+
headers: {
|
|
21082
|
+
[name: string]: unknown;
|
|
21083
|
+
};
|
|
21084
|
+
content: {
|
|
21085
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
21086
|
+
};
|
|
21087
|
+
};
|
|
21088
|
+
};
|
|
21089
|
+
};
|
|
20678
21090
|
}
|
|
20679
21091
|
|
|
20680
21092
|
/**
|