@subnoto/api-client 1.1.0
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/README.md +68 -0
- package/index.d.ts +3 -0
- package/index.js +4 -0
- package/oak_session_wasm_nodejs_bg.wasm +0 -0
- package/package.json +34 -0
- package/src/base-client.d.ts +4 -0
- package/src/client.d.ts +15 -0
- package/src/client.test.d.ts +1 -0
- package/src/generated/api.gen.d.ts +4227 -0
- package/src/helpers/uploadDocument.d.ts +11 -0
- package/src/middleware/signature.d.ts +3 -0
- package/src/middleware/tunnel.d.ts +3 -0
- package/src/session.d.ts +18 -0
- package/src/types.d.ts +16 -0
|
@@ -0,0 +1,4227 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
export interface paths {
|
|
7
|
+
"/public/contact/create": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
14
|
+
get?: never;
|
|
15
|
+
put?: never;
|
|
16
|
+
/**
|
|
17
|
+
* create
|
|
18
|
+
* @description Create a contact inside the workspace.
|
|
19
|
+
*/
|
|
20
|
+
post: {
|
|
21
|
+
parameters: {
|
|
22
|
+
query?: never;
|
|
23
|
+
header?: never;
|
|
24
|
+
path?: never;
|
|
25
|
+
cookie?: never;
|
|
26
|
+
};
|
|
27
|
+
requestBody: {
|
|
28
|
+
content: {
|
|
29
|
+
"application/json": {
|
|
30
|
+
/** @description The UUID of the workspace to create the envelope in. */
|
|
31
|
+
workspaceUuid: string;
|
|
32
|
+
/** @description The contacts to create. */
|
|
33
|
+
contacts: {
|
|
34
|
+
/** @description The email of the contact. */
|
|
35
|
+
email: string;
|
|
36
|
+
/** @description The first name of the contact. */
|
|
37
|
+
firstname: string;
|
|
38
|
+
/** @description The last name of the contact. */
|
|
39
|
+
lastname: string;
|
|
40
|
+
/**
|
|
41
|
+
* @description The phone number of the contact.
|
|
42
|
+
* @default
|
|
43
|
+
*/
|
|
44
|
+
phone?: string;
|
|
45
|
+
}[];
|
|
46
|
+
};
|
|
47
|
+
};
|
|
48
|
+
};
|
|
49
|
+
responses: {
|
|
50
|
+
/** @description Default Response */
|
|
51
|
+
200: {
|
|
52
|
+
headers: {
|
|
53
|
+
[name: string]: unknown;
|
|
54
|
+
};
|
|
55
|
+
content: {
|
|
56
|
+
"application/json": {
|
|
57
|
+
/** @description The contacts created. */
|
|
58
|
+
contacts: {
|
|
59
|
+
/** @description The UUID of the contact. */
|
|
60
|
+
uuid: string;
|
|
61
|
+
/** @description The email of the contact. */
|
|
62
|
+
email: string;
|
|
63
|
+
/** @description The first name of the contact. */
|
|
64
|
+
firstname: string;
|
|
65
|
+
/** @description The last name of the contact. */
|
|
66
|
+
lastname: string;
|
|
67
|
+
/** @description The phone number of the contact. */
|
|
68
|
+
phone: string | null;
|
|
69
|
+
}[];
|
|
70
|
+
};
|
|
71
|
+
};
|
|
72
|
+
};
|
|
73
|
+
/** @description Default Response */
|
|
74
|
+
400: {
|
|
75
|
+
headers: {
|
|
76
|
+
[name: string]: unknown;
|
|
77
|
+
};
|
|
78
|
+
content: {
|
|
79
|
+
"application/json": {
|
|
80
|
+
/** @description HTTP status code */
|
|
81
|
+
statusCode: number;
|
|
82
|
+
error: {
|
|
83
|
+
/**
|
|
84
|
+
* @description The error code
|
|
85
|
+
* @enum {string}
|
|
86
|
+
*/
|
|
87
|
+
code: "WORKSPACE_NOT_FOUND" | "CONTACT_EMAIL_ALREADY_EXISTS" | "INVALID_REQUEST_FORMAT";
|
|
88
|
+
/** @description The error message */
|
|
89
|
+
message: string;
|
|
90
|
+
/** @description A suggestion to resolve the error */
|
|
91
|
+
suggestion: string;
|
|
92
|
+
/** @description A URL to the documentation */
|
|
93
|
+
documentationUrl: string;
|
|
94
|
+
};
|
|
95
|
+
/** @description The unique identifier of the request */
|
|
96
|
+
requestId: string;
|
|
97
|
+
/** @description The timestamp of the response */
|
|
98
|
+
timestamp: string;
|
|
99
|
+
/** @description The path of the request */
|
|
100
|
+
path: string;
|
|
101
|
+
};
|
|
102
|
+
};
|
|
103
|
+
};
|
|
104
|
+
/** @description Default Response */
|
|
105
|
+
401: {
|
|
106
|
+
headers: {
|
|
107
|
+
[name: string]: unknown;
|
|
108
|
+
};
|
|
109
|
+
content: {
|
|
110
|
+
"application/json": {
|
|
111
|
+
/** @description HTTP status code */
|
|
112
|
+
statusCode: number;
|
|
113
|
+
error: {
|
|
114
|
+
/**
|
|
115
|
+
* @description The error code
|
|
116
|
+
* @enum {string}
|
|
117
|
+
*/
|
|
118
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
119
|
+
/** @description The error message */
|
|
120
|
+
message: string;
|
|
121
|
+
/** @description A suggestion to resolve the error */
|
|
122
|
+
suggestion: string;
|
|
123
|
+
/** @description A URL to the documentation */
|
|
124
|
+
documentationUrl: string;
|
|
125
|
+
};
|
|
126
|
+
/** @description The unique identifier of the request */
|
|
127
|
+
requestId: string;
|
|
128
|
+
/** @description The timestamp of the response */
|
|
129
|
+
timestamp: string;
|
|
130
|
+
/** @description The path of the request */
|
|
131
|
+
path: string;
|
|
132
|
+
};
|
|
133
|
+
};
|
|
134
|
+
};
|
|
135
|
+
/** @description Default Response */
|
|
136
|
+
403: {
|
|
137
|
+
headers: {
|
|
138
|
+
[name: string]: unknown;
|
|
139
|
+
};
|
|
140
|
+
content: {
|
|
141
|
+
"application/json": {
|
|
142
|
+
/** @description HTTP status code */
|
|
143
|
+
statusCode: number;
|
|
144
|
+
error: {
|
|
145
|
+
/**
|
|
146
|
+
* @description The error code
|
|
147
|
+
* @enum {string}
|
|
148
|
+
*/
|
|
149
|
+
code: "AUTHORIZATION_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
150
|
+
/** @description The error message */
|
|
151
|
+
message: string;
|
|
152
|
+
/** @description A suggestion to resolve the error */
|
|
153
|
+
suggestion: string;
|
|
154
|
+
/** @description A URL to the documentation */
|
|
155
|
+
documentationUrl: string;
|
|
156
|
+
};
|
|
157
|
+
/** @description The unique identifier of the request */
|
|
158
|
+
requestId: string;
|
|
159
|
+
/** @description The timestamp of the response */
|
|
160
|
+
timestamp: string;
|
|
161
|
+
/** @description The path of the request */
|
|
162
|
+
path: string;
|
|
163
|
+
};
|
|
164
|
+
};
|
|
165
|
+
};
|
|
166
|
+
/** @description Default Response */
|
|
167
|
+
500: {
|
|
168
|
+
headers: {
|
|
169
|
+
[name: string]: unknown;
|
|
170
|
+
};
|
|
171
|
+
content: {
|
|
172
|
+
"application/json": {
|
|
173
|
+
/** @description HTTP status code */
|
|
174
|
+
statusCode: number;
|
|
175
|
+
error: {
|
|
176
|
+
/**
|
|
177
|
+
* @description The error code
|
|
178
|
+
* @enum {string}
|
|
179
|
+
*/
|
|
180
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
181
|
+
/** @description The error message */
|
|
182
|
+
message: string;
|
|
183
|
+
/** @description A suggestion to resolve the error */
|
|
184
|
+
suggestion: string;
|
|
185
|
+
/** @description A URL to the documentation */
|
|
186
|
+
documentationUrl: string;
|
|
187
|
+
};
|
|
188
|
+
/** @description The unique identifier of the request */
|
|
189
|
+
requestId: string;
|
|
190
|
+
/** @description The timestamp of the response */
|
|
191
|
+
timestamp: string;
|
|
192
|
+
/** @description The path of the request */
|
|
193
|
+
path: string;
|
|
194
|
+
};
|
|
195
|
+
};
|
|
196
|
+
};
|
|
197
|
+
};
|
|
198
|
+
};
|
|
199
|
+
delete?: never;
|
|
200
|
+
options?: never;
|
|
201
|
+
head?: never;
|
|
202
|
+
patch?: never;
|
|
203
|
+
trace?: never;
|
|
204
|
+
};
|
|
205
|
+
"/public/contact/list": {
|
|
206
|
+
parameters: {
|
|
207
|
+
query?: never;
|
|
208
|
+
header?: never;
|
|
209
|
+
path?: never;
|
|
210
|
+
cookie?: never;
|
|
211
|
+
};
|
|
212
|
+
get?: never;
|
|
213
|
+
put?: never;
|
|
214
|
+
/**
|
|
215
|
+
* list
|
|
216
|
+
* @description List all contacts inside the workspace.
|
|
217
|
+
*/
|
|
218
|
+
post: {
|
|
219
|
+
parameters: {
|
|
220
|
+
query?: never;
|
|
221
|
+
header?: never;
|
|
222
|
+
path?: never;
|
|
223
|
+
cookie?: never;
|
|
224
|
+
};
|
|
225
|
+
requestBody: {
|
|
226
|
+
content: {
|
|
227
|
+
"application/json": {
|
|
228
|
+
/** @description The UUID of the workspace to create the envelope in. */
|
|
229
|
+
workspaceUuid: string;
|
|
230
|
+
};
|
|
231
|
+
};
|
|
232
|
+
};
|
|
233
|
+
responses: {
|
|
234
|
+
/** @description Default Response */
|
|
235
|
+
200: {
|
|
236
|
+
headers: {
|
|
237
|
+
[name: string]: unknown;
|
|
238
|
+
};
|
|
239
|
+
content: {
|
|
240
|
+
"application/json": {
|
|
241
|
+
/** @description The list of contacts. */
|
|
242
|
+
contacts: {
|
|
243
|
+
/** @description The UUID of the contact. */
|
|
244
|
+
uuid: string;
|
|
245
|
+
/** @description The email of the contact. */
|
|
246
|
+
email: string;
|
|
247
|
+
/** @description The first name of the contact. */
|
|
248
|
+
firstname: string;
|
|
249
|
+
/** @description The last name of the contact. */
|
|
250
|
+
lastname: string;
|
|
251
|
+
/** @description The phone number of the contact. */
|
|
252
|
+
phone: string | null;
|
|
253
|
+
}[];
|
|
254
|
+
};
|
|
255
|
+
};
|
|
256
|
+
};
|
|
257
|
+
/** @description Default Response */
|
|
258
|
+
400: {
|
|
259
|
+
headers: {
|
|
260
|
+
[name: string]: unknown;
|
|
261
|
+
};
|
|
262
|
+
content: {
|
|
263
|
+
"application/json": {
|
|
264
|
+
/** @description HTTP status code */
|
|
265
|
+
statusCode: number;
|
|
266
|
+
error: {
|
|
267
|
+
/**
|
|
268
|
+
* @description The error code
|
|
269
|
+
* @enum {string}
|
|
270
|
+
*/
|
|
271
|
+
code: "WORKSPACE_NOT_FOUND" | "INVALID_REQUEST_FORMAT";
|
|
272
|
+
/** @description The error message */
|
|
273
|
+
message: string;
|
|
274
|
+
/** @description A suggestion to resolve the error */
|
|
275
|
+
suggestion: string;
|
|
276
|
+
/** @description A URL to the documentation */
|
|
277
|
+
documentationUrl: string;
|
|
278
|
+
};
|
|
279
|
+
/** @description The unique identifier of the request */
|
|
280
|
+
requestId: string;
|
|
281
|
+
/** @description The timestamp of the response */
|
|
282
|
+
timestamp: string;
|
|
283
|
+
/** @description The path of the request */
|
|
284
|
+
path: string;
|
|
285
|
+
};
|
|
286
|
+
};
|
|
287
|
+
};
|
|
288
|
+
/** @description Default Response */
|
|
289
|
+
401: {
|
|
290
|
+
headers: {
|
|
291
|
+
[name: string]: unknown;
|
|
292
|
+
};
|
|
293
|
+
content: {
|
|
294
|
+
"application/json": {
|
|
295
|
+
/** @description HTTP status code */
|
|
296
|
+
statusCode: number;
|
|
297
|
+
error: {
|
|
298
|
+
/**
|
|
299
|
+
* @description The error code
|
|
300
|
+
* @enum {string}
|
|
301
|
+
*/
|
|
302
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
303
|
+
/** @description The error message */
|
|
304
|
+
message: string;
|
|
305
|
+
/** @description A suggestion to resolve the error */
|
|
306
|
+
suggestion: string;
|
|
307
|
+
/** @description A URL to the documentation */
|
|
308
|
+
documentationUrl: string;
|
|
309
|
+
};
|
|
310
|
+
/** @description The unique identifier of the request */
|
|
311
|
+
requestId: string;
|
|
312
|
+
/** @description The timestamp of the response */
|
|
313
|
+
timestamp: string;
|
|
314
|
+
/** @description The path of the request */
|
|
315
|
+
path: string;
|
|
316
|
+
};
|
|
317
|
+
};
|
|
318
|
+
};
|
|
319
|
+
/** @description Default Response */
|
|
320
|
+
403: {
|
|
321
|
+
headers: {
|
|
322
|
+
[name: string]: unknown;
|
|
323
|
+
};
|
|
324
|
+
content: {
|
|
325
|
+
"application/json": {
|
|
326
|
+
/** @description HTTP status code */
|
|
327
|
+
statusCode: number;
|
|
328
|
+
error: {
|
|
329
|
+
/**
|
|
330
|
+
* @description The error code
|
|
331
|
+
* @enum {string}
|
|
332
|
+
*/
|
|
333
|
+
code: "AUTHORIZATION_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
334
|
+
/** @description The error message */
|
|
335
|
+
message: string;
|
|
336
|
+
/** @description A suggestion to resolve the error */
|
|
337
|
+
suggestion: string;
|
|
338
|
+
/** @description A URL to the documentation */
|
|
339
|
+
documentationUrl: string;
|
|
340
|
+
};
|
|
341
|
+
/** @description The unique identifier of the request */
|
|
342
|
+
requestId: string;
|
|
343
|
+
/** @description The timestamp of the response */
|
|
344
|
+
timestamp: string;
|
|
345
|
+
/** @description The path of the request */
|
|
346
|
+
path: string;
|
|
347
|
+
};
|
|
348
|
+
};
|
|
349
|
+
};
|
|
350
|
+
/** @description Default Response */
|
|
351
|
+
500: {
|
|
352
|
+
headers: {
|
|
353
|
+
[name: string]: unknown;
|
|
354
|
+
};
|
|
355
|
+
content: {
|
|
356
|
+
"application/json": {
|
|
357
|
+
/** @description HTTP status code */
|
|
358
|
+
statusCode: number;
|
|
359
|
+
error: {
|
|
360
|
+
/**
|
|
361
|
+
* @description The error code
|
|
362
|
+
* @enum {string}
|
|
363
|
+
*/
|
|
364
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
365
|
+
/** @description The error message */
|
|
366
|
+
message: string;
|
|
367
|
+
/** @description A suggestion to resolve the error */
|
|
368
|
+
suggestion: string;
|
|
369
|
+
/** @description A URL to the documentation */
|
|
370
|
+
documentationUrl: string;
|
|
371
|
+
};
|
|
372
|
+
/** @description The unique identifier of the request */
|
|
373
|
+
requestId: string;
|
|
374
|
+
/** @description The timestamp of the response */
|
|
375
|
+
timestamp: string;
|
|
376
|
+
/** @description The path of the request */
|
|
377
|
+
path: string;
|
|
378
|
+
};
|
|
379
|
+
};
|
|
380
|
+
};
|
|
381
|
+
};
|
|
382
|
+
};
|
|
383
|
+
delete?: never;
|
|
384
|
+
options?: never;
|
|
385
|
+
head?: never;
|
|
386
|
+
patch?: never;
|
|
387
|
+
trace?: never;
|
|
388
|
+
};
|
|
389
|
+
"/public/contact/delete": {
|
|
390
|
+
parameters: {
|
|
391
|
+
query?: never;
|
|
392
|
+
header?: never;
|
|
393
|
+
path?: never;
|
|
394
|
+
cookie?: never;
|
|
395
|
+
};
|
|
396
|
+
get?: never;
|
|
397
|
+
put?: never;
|
|
398
|
+
/**
|
|
399
|
+
* delete
|
|
400
|
+
* @description Delete a contact inside the workspace.
|
|
401
|
+
*/
|
|
402
|
+
post: {
|
|
403
|
+
parameters: {
|
|
404
|
+
query?: never;
|
|
405
|
+
header?: never;
|
|
406
|
+
path?: never;
|
|
407
|
+
cookie?: never;
|
|
408
|
+
};
|
|
409
|
+
requestBody: {
|
|
410
|
+
content: {
|
|
411
|
+
"application/json": {
|
|
412
|
+
/** @description The UUID of the workspace to create the envelope in. */
|
|
413
|
+
workspaceUuid: string;
|
|
414
|
+
/** @description The emails of the contacts to delete. */
|
|
415
|
+
emails: string[];
|
|
416
|
+
};
|
|
417
|
+
};
|
|
418
|
+
};
|
|
419
|
+
responses: {
|
|
420
|
+
/** @description Default Response */
|
|
421
|
+
200: {
|
|
422
|
+
headers: {
|
|
423
|
+
[name: string]: unknown;
|
|
424
|
+
};
|
|
425
|
+
content: {
|
|
426
|
+
"application/json": Record<string, never>;
|
|
427
|
+
};
|
|
428
|
+
};
|
|
429
|
+
/** @description Default Response */
|
|
430
|
+
400: {
|
|
431
|
+
headers: {
|
|
432
|
+
[name: string]: unknown;
|
|
433
|
+
};
|
|
434
|
+
content: {
|
|
435
|
+
"application/json": {
|
|
436
|
+
/** @description HTTP status code */
|
|
437
|
+
statusCode: number;
|
|
438
|
+
error: {
|
|
439
|
+
/**
|
|
440
|
+
* @description The error code
|
|
441
|
+
* @enum {string}
|
|
442
|
+
*/
|
|
443
|
+
code: "WORKSPACE_NOT_FOUND" | "CONTACT_NOT_FOUND" | "INVALID_REQUEST_FORMAT";
|
|
444
|
+
/** @description The error message */
|
|
445
|
+
message: string;
|
|
446
|
+
/** @description A suggestion to resolve the error */
|
|
447
|
+
suggestion: string;
|
|
448
|
+
/** @description A URL to the documentation */
|
|
449
|
+
documentationUrl: string;
|
|
450
|
+
};
|
|
451
|
+
/** @description The unique identifier of the request */
|
|
452
|
+
requestId: string;
|
|
453
|
+
/** @description The timestamp of the response */
|
|
454
|
+
timestamp: string;
|
|
455
|
+
/** @description The path of the request */
|
|
456
|
+
path: string;
|
|
457
|
+
};
|
|
458
|
+
};
|
|
459
|
+
};
|
|
460
|
+
/** @description Default Response */
|
|
461
|
+
401: {
|
|
462
|
+
headers: {
|
|
463
|
+
[name: string]: unknown;
|
|
464
|
+
};
|
|
465
|
+
content: {
|
|
466
|
+
"application/json": {
|
|
467
|
+
/** @description HTTP status code */
|
|
468
|
+
statusCode: number;
|
|
469
|
+
error: {
|
|
470
|
+
/**
|
|
471
|
+
* @description The error code
|
|
472
|
+
* @enum {string}
|
|
473
|
+
*/
|
|
474
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
475
|
+
/** @description The error message */
|
|
476
|
+
message: string;
|
|
477
|
+
/** @description A suggestion to resolve the error */
|
|
478
|
+
suggestion: string;
|
|
479
|
+
/** @description A URL to the documentation */
|
|
480
|
+
documentationUrl: string;
|
|
481
|
+
};
|
|
482
|
+
/** @description The unique identifier of the request */
|
|
483
|
+
requestId: string;
|
|
484
|
+
/** @description The timestamp of the response */
|
|
485
|
+
timestamp: string;
|
|
486
|
+
/** @description The path of the request */
|
|
487
|
+
path: string;
|
|
488
|
+
};
|
|
489
|
+
};
|
|
490
|
+
};
|
|
491
|
+
/** @description Default Response */
|
|
492
|
+
403: {
|
|
493
|
+
headers: {
|
|
494
|
+
[name: string]: unknown;
|
|
495
|
+
};
|
|
496
|
+
content: {
|
|
497
|
+
"application/json": {
|
|
498
|
+
/** @description HTTP status code */
|
|
499
|
+
statusCode: number;
|
|
500
|
+
error: {
|
|
501
|
+
/**
|
|
502
|
+
* @description The error code
|
|
503
|
+
* @enum {string}
|
|
504
|
+
*/
|
|
505
|
+
code: "AUTHORIZATION_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
506
|
+
/** @description The error message */
|
|
507
|
+
message: string;
|
|
508
|
+
/** @description A suggestion to resolve the error */
|
|
509
|
+
suggestion: string;
|
|
510
|
+
/** @description A URL to the documentation */
|
|
511
|
+
documentationUrl: string;
|
|
512
|
+
};
|
|
513
|
+
/** @description The unique identifier of the request */
|
|
514
|
+
requestId: string;
|
|
515
|
+
/** @description The timestamp of the response */
|
|
516
|
+
timestamp: string;
|
|
517
|
+
/** @description The path of the request */
|
|
518
|
+
path: string;
|
|
519
|
+
};
|
|
520
|
+
};
|
|
521
|
+
};
|
|
522
|
+
/** @description Default Response */
|
|
523
|
+
500: {
|
|
524
|
+
headers: {
|
|
525
|
+
[name: string]: unknown;
|
|
526
|
+
};
|
|
527
|
+
content: {
|
|
528
|
+
"application/json": {
|
|
529
|
+
/** @description HTTP status code */
|
|
530
|
+
statusCode: number;
|
|
531
|
+
error: {
|
|
532
|
+
/**
|
|
533
|
+
* @description The error code
|
|
534
|
+
* @enum {string}
|
|
535
|
+
*/
|
|
536
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
537
|
+
/** @description The error message */
|
|
538
|
+
message: string;
|
|
539
|
+
/** @description A suggestion to resolve the error */
|
|
540
|
+
suggestion: string;
|
|
541
|
+
/** @description A URL to the documentation */
|
|
542
|
+
documentationUrl: string;
|
|
543
|
+
};
|
|
544
|
+
/** @description The unique identifier of the request */
|
|
545
|
+
requestId: string;
|
|
546
|
+
/** @description The timestamp of the response */
|
|
547
|
+
timestamp: string;
|
|
548
|
+
/** @description The path of the request */
|
|
549
|
+
path: string;
|
|
550
|
+
};
|
|
551
|
+
};
|
|
552
|
+
};
|
|
553
|
+
};
|
|
554
|
+
};
|
|
555
|
+
delete?: never;
|
|
556
|
+
options?: never;
|
|
557
|
+
head?: never;
|
|
558
|
+
patch?: never;
|
|
559
|
+
trace?: never;
|
|
560
|
+
};
|
|
561
|
+
"/public/contact/get": {
|
|
562
|
+
parameters: {
|
|
563
|
+
query?: never;
|
|
564
|
+
header?: never;
|
|
565
|
+
path?: never;
|
|
566
|
+
cookie?: never;
|
|
567
|
+
};
|
|
568
|
+
get?: never;
|
|
569
|
+
put?: never;
|
|
570
|
+
/**
|
|
571
|
+
* get
|
|
572
|
+
* @description Get a contact inside the workspace.
|
|
573
|
+
*/
|
|
574
|
+
post: {
|
|
575
|
+
parameters: {
|
|
576
|
+
query?: never;
|
|
577
|
+
header?: never;
|
|
578
|
+
path?: never;
|
|
579
|
+
cookie?: never;
|
|
580
|
+
};
|
|
581
|
+
requestBody: {
|
|
582
|
+
content: {
|
|
583
|
+
"application/json": {
|
|
584
|
+
/** @description The UUID of the workspace to create the envelope in. */
|
|
585
|
+
workspaceUuid: string;
|
|
586
|
+
/** @description The email of the contact. */
|
|
587
|
+
email: string;
|
|
588
|
+
};
|
|
589
|
+
};
|
|
590
|
+
};
|
|
591
|
+
responses: {
|
|
592
|
+
/** @description Default Response */
|
|
593
|
+
200: {
|
|
594
|
+
headers: {
|
|
595
|
+
[name: string]: unknown;
|
|
596
|
+
};
|
|
597
|
+
content: {
|
|
598
|
+
"application/json": {
|
|
599
|
+
contact: {
|
|
600
|
+
/** @description The UUID of the contact. */
|
|
601
|
+
uuid: string;
|
|
602
|
+
/** @description The email of the contact. */
|
|
603
|
+
email: string;
|
|
604
|
+
/** @description The first name of the contact. */
|
|
605
|
+
firstname: string;
|
|
606
|
+
/** @description The last name of the contact. */
|
|
607
|
+
lastname: string;
|
|
608
|
+
/** @description The phone number of the contact. */
|
|
609
|
+
phone: string | null;
|
|
610
|
+
};
|
|
611
|
+
};
|
|
612
|
+
};
|
|
613
|
+
};
|
|
614
|
+
/** @description Default Response */
|
|
615
|
+
400: {
|
|
616
|
+
headers: {
|
|
617
|
+
[name: string]: unknown;
|
|
618
|
+
};
|
|
619
|
+
content: {
|
|
620
|
+
"application/json": {
|
|
621
|
+
/** @description HTTP status code */
|
|
622
|
+
statusCode: number;
|
|
623
|
+
error: {
|
|
624
|
+
/**
|
|
625
|
+
* @description The error code
|
|
626
|
+
* @enum {string}
|
|
627
|
+
*/
|
|
628
|
+
code: "WORKSPACE_NOT_FOUND" | "CONTACT_NOT_FOUND" | "INVALID_REQUEST_FORMAT";
|
|
629
|
+
/** @description The error message */
|
|
630
|
+
message: string;
|
|
631
|
+
/** @description A suggestion to resolve the error */
|
|
632
|
+
suggestion: string;
|
|
633
|
+
/** @description A URL to the documentation */
|
|
634
|
+
documentationUrl: string;
|
|
635
|
+
};
|
|
636
|
+
/** @description The unique identifier of the request */
|
|
637
|
+
requestId: string;
|
|
638
|
+
/** @description The timestamp of the response */
|
|
639
|
+
timestamp: string;
|
|
640
|
+
/** @description The path of the request */
|
|
641
|
+
path: string;
|
|
642
|
+
};
|
|
643
|
+
};
|
|
644
|
+
};
|
|
645
|
+
/** @description Default Response */
|
|
646
|
+
401: {
|
|
647
|
+
headers: {
|
|
648
|
+
[name: string]: unknown;
|
|
649
|
+
};
|
|
650
|
+
content: {
|
|
651
|
+
"application/json": {
|
|
652
|
+
/** @description HTTP status code */
|
|
653
|
+
statusCode: number;
|
|
654
|
+
error: {
|
|
655
|
+
/**
|
|
656
|
+
* @description The error code
|
|
657
|
+
* @enum {string}
|
|
658
|
+
*/
|
|
659
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
660
|
+
/** @description The error message */
|
|
661
|
+
message: string;
|
|
662
|
+
/** @description A suggestion to resolve the error */
|
|
663
|
+
suggestion: string;
|
|
664
|
+
/** @description A URL to the documentation */
|
|
665
|
+
documentationUrl: string;
|
|
666
|
+
};
|
|
667
|
+
/** @description The unique identifier of the request */
|
|
668
|
+
requestId: string;
|
|
669
|
+
/** @description The timestamp of the response */
|
|
670
|
+
timestamp: string;
|
|
671
|
+
/** @description The path of the request */
|
|
672
|
+
path: string;
|
|
673
|
+
};
|
|
674
|
+
};
|
|
675
|
+
};
|
|
676
|
+
/** @description Default Response */
|
|
677
|
+
403: {
|
|
678
|
+
headers: {
|
|
679
|
+
[name: string]: unknown;
|
|
680
|
+
};
|
|
681
|
+
content: {
|
|
682
|
+
"application/json": {
|
|
683
|
+
/** @description HTTP status code */
|
|
684
|
+
statusCode: number;
|
|
685
|
+
error: {
|
|
686
|
+
/**
|
|
687
|
+
* @description The error code
|
|
688
|
+
* @enum {string}
|
|
689
|
+
*/
|
|
690
|
+
code: "AUTHORIZATION_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
691
|
+
/** @description The error message */
|
|
692
|
+
message: string;
|
|
693
|
+
/** @description A suggestion to resolve the error */
|
|
694
|
+
suggestion: string;
|
|
695
|
+
/** @description A URL to the documentation */
|
|
696
|
+
documentationUrl: string;
|
|
697
|
+
};
|
|
698
|
+
/** @description The unique identifier of the request */
|
|
699
|
+
requestId: string;
|
|
700
|
+
/** @description The timestamp of the response */
|
|
701
|
+
timestamp: string;
|
|
702
|
+
/** @description The path of the request */
|
|
703
|
+
path: string;
|
|
704
|
+
};
|
|
705
|
+
};
|
|
706
|
+
};
|
|
707
|
+
/** @description Default Response */
|
|
708
|
+
500: {
|
|
709
|
+
headers: {
|
|
710
|
+
[name: string]: unknown;
|
|
711
|
+
};
|
|
712
|
+
content: {
|
|
713
|
+
"application/json": {
|
|
714
|
+
/** @description HTTP status code */
|
|
715
|
+
statusCode: number;
|
|
716
|
+
error: {
|
|
717
|
+
/**
|
|
718
|
+
* @description The error code
|
|
719
|
+
* @enum {string}
|
|
720
|
+
*/
|
|
721
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
722
|
+
/** @description The error message */
|
|
723
|
+
message: string;
|
|
724
|
+
/** @description A suggestion to resolve the error */
|
|
725
|
+
suggestion: string;
|
|
726
|
+
/** @description A URL to the documentation */
|
|
727
|
+
documentationUrl: string;
|
|
728
|
+
};
|
|
729
|
+
/** @description The unique identifier of the request */
|
|
730
|
+
requestId: string;
|
|
731
|
+
/** @description The timestamp of the response */
|
|
732
|
+
timestamp: string;
|
|
733
|
+
/** @description The path of the request */
|
|
734
|
+
path: string;
|
|
735
|
+
};
|
|
736
|
+
};
|
|
737
|
+
};
|
|
738
|
+
};
|
|
739
|
+
};
|
|
740
|
+
delete?: never;
|
|
741
|
+
options?: never;
|
|
742
|
+
head?: never;
|
|
743
|
+
patch?: never;
|
|
744
|
+
trace?: never;
|
|
745
|
+
};
|
|
746
|
+
"/public/contact/update": {
|
|
747
|
+
parameters: {
|
|
748
|
+
query?: never;
|
|
749
|
+
header?: never;
|
|
750
|
+
path?: never;
|
|
751
|
+
cookie?: never;
|
|
752
|
+
};
|
|
753
|
+
get?: never;
|
|
754
|
+
put?: never;
|
|
755
|
+
/**
|
|
756
|
+
* update
|
|
757
|
+
* @description Update a contact inside the workspace.
|
|
758
|
+
*/
|
|
759
|
+
post: {
|
|
760
|
+
parameters: {
|
|
761
|
+
query?: never;
|
|
762
|
+
header?: never;
|
|
763
|
+
path?: never;
|
|
764
|
+
cookie?: never;
|
|
765
|
+
};
|
|
766
|
+
requestBody: {
|
|
767
|
+
content: {
|
|
768
|
+
"application/json": {
|
|
769
|
+
/** @description The UUID of the workspace to create the envelope in. */
|
|
770
|
+
workspaceUuid: string;
|
|
771
|
+
contact: {
|
|
772
|
+
/** @description The email of the contact. */
|
|
773
|
+
email: string;
|
|
774
|
+
/** @description The first name of the contact. */
|
|
775
|
+
firstname: string;
|
|
776
|
+
/** @description The last name of the contact. */
|
|
777
|
+
lastname: string;
|
|
778
|
+
/** @description The phone number of the contact. */
|
|
779
|
+
phone: string | null;
|
|
780
|
+
};
|
|
781
|
+
};
|
|
782
|
+
};
|
|
783
|
+
};
|
|
784
|
+
responses: {
|
|
785
|
+
/** @description Default Response */
|
|
786
|
+
200: {
|
|
787
|
+
headers: {
|
|
788
|
+
[name: string]: unknown;
|
|
789
|
+
};
|
|
790
|
+
content: {
|
|
791
|
+
"application/json": {
|
|
792
|
+
contact: {
|
|
793
|
+
/** @description The UUID of the contact. */
|
|
794
|
+
uuid: string;
|
|
795
|
+
/** @description The email of the contact. */
|
|
796
|
+
email: string;
|
|
797
|
+
/** @description The first name of the contact. */
|
|
798
|
+
firstname: string;
|
|
799
|
+
/** @description The last name of the contact. */
|
|
800
|
+
lastname: string;
|
|
801
|
+
/** @description The phone number of the contact. */
|
|
802
|
+
phone: string | null;
|
|
803
|
+
};
|
|
804
|
+
};
|
|
805
|
+
};
|
|
806
|
+
};
|
|
807
|
+
/** @description Default Response */
|
|
808
|
+
400: {
|
|
809
|
+
headers: {
|
|
810
|
+
[name: string]: unknown;
|
|
811
|
+
};
|
|
812
|
+
content: {
|
|
813
|
+
"application/json": {
|
|
814
|
+
/** @description HTTP status code */
|
|
815
|
+
statusCode: number;
|
|
816
|
+
error: {
|
|
817
|
+
/**
|
|
818
|
+
* @description The error code
|
|
819
|
+
* @enum {string}
|
|
820
|
+
*/
|
|
821
|
+
code: "WORKSPACE_NOT_FOUND" | "CONTACT_NOT_FOUND" | "INVALID_EMAIL" | "INVALID_REQUEST_FORMAT";
|
|
822
|
+
/** @description The error message */
|
|
823
|
+
message: string;
|
|
824
|
+
/** @description A suggestion to resolve the error */
|
|
825
|
+
suggestion: string;
|
|
826
|
+
/** @description A URL to the documentation */
|
|
827
|
+
documentationUrl: string;
|
|
828
|
+
};
|
|
829
|
+
/** @description The unique identifier of the request */
|
|
830
|
+
requestId: string;
|
|
831
|
+
/** @description The timestamp of the response */
|
|
832
|
+
timestamp: string;
|
|
833
|
+
/** @description The path of the request */
|
|
834
|
+
path: string;
|
|
835
|
+
};
|
|
836
|
+
};
|
|
837
|
+
};
|
|
838
|
+
/** @description Default Response */
|
|
839
|
+
401: {
|
|
840
|
+
headers: {
|
|
841
|
+
[name: string]: unknown;
|
|
842
|
+
};
|
|
843
|
+
content: {
|
|
844
|
+
"application/json": {
|
|
845
|
+
/** @description HTTP status code */
|
|
846
|
+
statusCode: number;
|
|
847
|
+
error: {
|
|
848
|
+
/**
|
|
849
|
+
* @description The error code
|
|
850
|
+
* @enum {string}
|
|
851
|
+
*/
|
|
852
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
853
|
+
/** @description The error message */
|
|
854
|
+
message: string;
|
|
855
|
+
/** @description A suggestion to resolve the error */
|
|
856
|
+
suggestion: string;
|
|
857
|
+
/** @description A URL to the documentation */
|
|
858
|
+
documentationUrl: string;
|
|
859
|
+
};
|
|
860
|
+
/** @description The unique identifier of the request */
|
|
861
|
+
requestId: string;
|
|
862
|
+
/** @description The timestamp of the response */
|
|
863
|
+
timestamp: string;
|
|
864
|
+
/** @description The path of the request */
|
|
865
|
+
path: string;
|
|
866
|
+
};
|
|
867
|
+
};
|
|
868
|
+
};
|
|
869
|
+
/** @description Default Response */
|
|
870
|
+
403: {
|
|
871
|
+
headers: {
|
|
872
|
+
[name: string]: unknown;
|
|
873
|
+
};
|
|
874
|
+
content: {
|
|
875
|
+
"application/json": {
|
|
876
|
+
/** @description HTTP status code */
|
|
877
|
+
statusCode: number;
|
|
878
|
+
error: {
|
|
879
|
+
/**
|
|
880
|
+
* @description The error code
|
|
881
|
+
* @enum {string}
|
|
882
|
+
*/
|
|
883
|
+
code: "AUTHORIZATION_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
884
|
+
/** @description The error message */
|
|
885
|
+
message: string;
|
|
886
|
+
/** @description A suggestion to resolve the error */
|
|
887
|
+
suggestion: string;
|
|
888
|
+
/** @description A URL to the documentation */
|
|
889
|
+
documentationUrl: string;
|
|
890
|
+
};
|
|
891
|
+
/** @description The unique identifier of the request */
|
|
892
|
+
requestId: string;
|
|
893
|
+
/** @description The timestamp of the response */
|
|
894
|
+
timestamp: string;
|
|
895
|
+
/** @description The path of the request */
|
|
896
|
+
path: string;
|
|
897
|
+
};
|
|
898
|
+
};
|
|
899
|
+
};
|
|
900
|
+
/** @description Default Response */
|
|
901
|
+
500: {
|
|
902
|
+
headers: {
|
|
903
|
+
[name: string]: unknown;
|
|
904
|
+
};
|
|
905
|
+
content: {
|
|
906
|
+
"application/json": {
|
|
907
|
+
/** @description HTTP status code */
|
|
908
|
+
statusCode: number;
|
|
909
|
+
error: {
|
|
910
|
+
/**
|
|
911
|
+
* @description The error code
|
|
912
|
+
* @enum {string}
|
|
913
|
+
*/
|
|
914
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
915
|
+
/** @description The error message */
|
|
916
|
+
message: string;
|
|
917
|
+
/** @description A suggestion to resolve the error */
|
|
918
|
+
suggestion: string;
|
|
919
|
+
/** @description A URL to the documentation */
|
|
920
|
+
documentationUrl: string;
|
|
921
|
+
};
|
|
922
|
+
/** @description The unique identifier of the request */
|
|
923
|
+
requestId: string;
|
|
924
|
+
/** @description The timestamp of the response */
|
|
925
|
+
timestamp: string;
|
|
926
|
+
/** @description The path of the request */
|
|
927
|
+
path: string;
|
|
928
|
+
};
|
|
929
|
+
};
|
|
930
|
+
};
|
|
931
|
+
};
|
|
932
|
+
};
|
|
933
|
+
delete?: never;
|
|
934
|
+
options?: never;
|
|
935
|
+
head?: never;
|
|
936
|
+
patch?: never;
|
|
937
|
+
trace?: never;
|
|
938
|
+
};
|
|
939
|
+
"/public/envelope/add-blocks": {
|
|
940
|
+
parameters: {
|
|
941
|
+
query?: never;
|
|
942
|
+
header?: never;
|
|
943
|
+
path?: never;
|
|
944
|
+
cookie?: never;
|
|
945
|
+
};
|
|
946
|
+
get?: never;
|
|
947
|
+
put?: never;
|
|
948
|
+
/**
|
|
949
|
+
* add-blocks
|
|
950
|
+
* @description Add blocks to a document snapshot in an envelope
|
|
951
|
+
*/
|
|
952
|
+
post: {
|
|
953
|
+
parameters: {
|
|
954
|
+
query?: never;
|
|
955
|
+
header?: never;
|
|
956
|
+
path?: never;
|
|
957
|
+
cookie?: never;
|
|
958
|
+
};
|
|
959
|
+
requestBody: {
|
|
960
|
+
content: {
|
|
961
|
+
"application/json": {
|
|
962
|
+
/** @description The UUID of the workspace. */
|
|
963
|
+
workspaceUuid: string;
|
|
964
|
+
/** @description The UUID of the envelope. */
|
|
965
|
+
envelopeUuid: string;
|
|
966
|
+
/** @description The UUID of the document. */
|
|
967
|
+
documentUuid: string;
|
|
968
|
+
/** @description Array of blocks to add to the document. */
|
|
969
|
+
blocks: ({
|
|
970
|
+
/** @description The page number where the block should be placed. */
|
|
971
|
+
page: string;
|
|
972
|
+
/** @description The x position of the block on the page. */
|
|
973
|
+
x: number;
|
|
974
|
+
/** @description The y position of the block on the page. */
|
|
975
|
+
y: number;
|
|
976
|
+
/** @description The height of the block. */
|
|
977
|
+
height?: number;
|
|
978
|
+
/** @description The width of the block. */
|
|
979
|
+
width?: number;
|
|
980
|
+
/**
|
|
981
|
+
* Format: email
|
|
982
|
+
* @description The email of the recipient for templated blocks.
|
|
983
|
+
*/
|
|
984
|
+
recipientEmail?: string;
|
|
985
|
+
/** @enum {string} */
|
|
986
|
+
type: "text";
|
|
987
|
+
/** @description The text content of the block. */
|
|
988
|
+
text: string;
|
|
989
|
+
/**
|
|
990
|
+
* @description The type of templated text.
|
|
991
|
+
* @enum {string}
|
|
992
|
+
*/
|
|
993
|
+
templatedText?: "email" | "fullname" | "phone";
|
|
994
|
+
} | {
|
|
995
|
+
/** @description The page number where the block should be placed. */
|
|
996
|
+
page: string;
|
|
997
|
+
/** @description The x position of the block on the page. */
|
|
998
|
+
x: number;
|
|
999
|
+
/** @description The y position of the block on the page. */
|
|
1000
|
+
y: number;
|
|
1001
|
+
/** @description The height of the block. */
|
|
1002
|
+
height?: number;
|
|
1003
|
+
/** @description The width of the block. */
|
|
1004
|
+
width?: number;
|
|
1005
|
+
/**
|
|
1006
|
+
* Format: email
|
|
1007
|
+
* @description The email of the recipient for templated blocks.
|
|
1008
|
+
*/
|
|
1009
|
+
recipientEmail?: string;
|
|
1010
|
+
/** @enum {string} */
|
|
1011
|
+
type: "image";
|
|
1012
|
+
src: string;
|
|
1013
|
+
/** @description The file type of the image. */
|
|
1014
|
+
fileType: string;
|
|
1015
|
+
} | {
|
|
1016
|
+
/** @description The page number where the block should be placed. */
|
|
1017
|
+
page: string;
|
|
1018
|
+
/** @description The x position of the block on the page. */
|
|
1019
|
+
x: number;
|
|
1020
|
+
/** @description The y position of the block on the page. */
|
|
1021
|
+
y: number;
|
|
1022
|
+
/** @description The height of the block. */
|
|
1023
|
+
height?: number;
|
|
1024
|
+
/** @description The width of the block. */
|
|
1025
|
+
width?: number;
|
|
1026
|
+
/**
|
|
1027
|
+
* Format: email
|
|
1028
|
+
* @description The email of the recipient for templated blocks.
|
|
1029
|
+
*/
|
|
1030
|
+
recipientEmail?: string;
|
|
1031
|
+
/** @enum {string} */
|
|
1032
|
+
type: "signature";
|
|
1033
|
+
})[];
|
|
1034
|
+
};
|
|
1035
|
+
};
|
|
1036
|
+
};
|
|
1037
|
+
responses: {
|
|
1038
|
+
/** @description Default Response */
|
|
1039
|
+
200: {
|
|
1040
|
+
headers: {
|
|
1041
|
+
[name: string]: unknown;
|
|
1042
|
+
};
|
|
1043
|
+
content: {
|
|
1044
|
+
"application/json": {
|
|
1045
|
+
/** @description The date and time the snapshot was created (unix timestamp). */
|
|
1046
|
+
snapshotDate: number;
|
|
1047
|
+
};
|
|
1048
|
+
};
|
|
1049
|
+
};
|
|
1050
|
+
/** @description Default Response */
|
|
1051
|
+
400: {
|
|
1052
|
+
headers: {
|
|
1053
|
+
[name: string]: unknown;
|
|
1054
|
+
};
|
|
1055
|
+
content: {
|
|
1056
|
+
"application/json": {
|
|
1057
|
+
/** @description HTTP status code */
|
|
1058
|
+
statusCode: number;
|
|
1059
|
+
error: {
|
|
1060
|
+
/**
|
|
1061
|
+
* @description The error code
|
|
1062
|
+
* @enum {string}
|
|
1063
|
+
*/
|
|
1064
|
+
code: "WORKSPACE_NOT_FOUND" | "ENVELOPE_NOT_FOUND" | "DOCUMENT_NOT_FOUND" | "ENVELOPE_NOT_IN_DRAFT" | "INVALID_RECIPIENT_EMAIL" | "INVALID_REQUEST_FORMAT";
|
|
1065
|
+
/** @description The error message */
|
|
1066
|
+
message: string;
|
|
1067
|
+
/** @description A suggestion to resolve the error */
|
|
1068
|
+
suggestion: string;
|
|
1069
|
+
/** @description A URL to the documentation */
|
|
1070
|
+
documentationUrl: string;
|
|
1071
|
+
};
|
|
1072
|
+
/** @description The unique identifier of the request */
|
|
1073
|
+
requestId: string;
|
|
1074
|
+
/** @description The timestamp of the response */
|
|
1075
|
+
timestamp: string;
|
|
1076
|
+
/** @description The path of the request */
|
|
1077
|
+
path: string;
|
|
1078
|
+
};
|
|
1079
|
+
};
|
|
1080
|
+
};
|
|
1081
|
+
/** @description Default Response */
|
|
1082
|
+
401: {
|
|
1083
|
+
headers: {
|
|
1084
|
+
[name: string]: unknown;
|
|
1085
|
+
};
|
|
1086
|
+
content: {
|
|
1087
|
+
"application/json": {
|
|
1088
|
+
/** @description HTTP status code */
|
|
1089
|
+
statusCode: number;
|
|
1090
|
+
error: {
|
|
1091
|
+
/**
|
|
1092
|
+
* @description The error code
|
|
1093
|
+
* @enum {string}
|
|
1094
|
+
*/
|
|
1095
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
1096
|
+
/** @description The error message */
|
|
1097
|
+
message: string;
|
|
1098
|
+
/** @description A suggestion to resolve the error */
|
|
1099
|
+
suggestion: string;
|
|
1100
|
+
/** @description A URL to the documentation */
|
|
1101
|
+
documentationUrl: string;
|
|
1102
|
+
};
|
|
1103
|
+
/** @description The unique identifier of the request */
|
|
1104
|
+
requestId: string;
|
|
1105
|
+
/** @description The timestamp of the response */
|
|
1106
|
+
timestamp: string;
|
|
1107
|
+
/** @description The path of the request */
|
|
1108
|
+
path: string;
|
|
1109
|
+
};
|
|
1110
|
+
};
|
|
1111
|
+
};
|
|
1112
|
+
/** @description Default Response */
|
|
1113
|
+
403: {
|
|
1114
|
+
headers: {
|
|
1115
|
+
[name: string]: unknown;
|
|
1116
|
+
};
|
|
1117
|
+
content: {
|
|
1118
|
+
"application/json": {
|
|
1119
|
+
/** @description HTTP status code */
|
|
1120
|
+
statusCode: number;
|
|
1121
|
+
error: {
|
|
1122
|
+
/**
|
|
1123
|
+
* @description The error code
|
|
1124
|
+
* @enum {string}
|
|
1125
|
+
*/
|
|
1126
|
+
code: "AUTHORIZATION_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
1127
|
+
/** @description The error message */
|
|
1128
|
+
message: string;
|
|
1129
|
+
/** @description A suggestion to resolve the error */
|
|
1130
|
+
suggestion: string;
|
|
1131
|
+
/** @description A URL to the documentation */
|
|
1132
|
+
documentationUrl: string;
|
|
1133
|
+
};
|
|
1134
|
+
/** @description The unique identifier of the request */
|
|
1135
|
+
requestId: string;
|
|
1136
|
+
/** @description The timestamp of the response */
|
|
1137
|
+
timestamp: string;
|
|
1138
|
+
/** @description The path of the request */
|
|
1139
|
+
path: string;
|
|
1140
|
+
};
|
|
1141
|
+
};
|
|
1142
|
+
};
|
|
1143
|
+
/** @description Default Response */
|
|
1144
|
+
500: {
|
|
1145
|
+
headers: {
|
|
1146
|
+
[name: string]: unknown;
|
|
1147
|
+
};
|
|
1148
|
+
content: {
|
|
1149
|
+
"application/json": {
|
|
1150
|
+
/** @description HTTP status code */
|
|
1151
|
+
statusCode: number;
|
|
1152
|
+
error: {
|
|
1153
|
+
/**
|
|
1154
|
+
* @description The error code
|
|
1155
|
+
* @enum {string}
|
|
1156
|
+
*/
|
|
1157
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
1158
|
+
/** @description The error message */
|
|
1159
|
+
message: string;
|
|
1160
|
+
/** @description A suggestion to resolve the error */
|
|
1161
|
+
suggestion: string;
|
|
1162
|
+
/** @description A URL to the documentation */
|
|
1163
|
+
documentationUrl: string;
|
|
1164
|
+
};
|
|
1165
|
+
/** @description The unique identifier of the request */
|
|
1166
|
+
requestId: string;
|
|
1167
|
+
/** @description The timestamp of the response */
|
|
1168
|
+
timestamp: string;
|
|
1169
|
+
/** @description The path of the request */
|
|
1170
|
+
path: string;
|
|
1171
|
+
};
|
|
1172
|
+
};
|
|
1173
|
+
};
|
|
1174
|
+
};
|
|
1175
|
+
};
|
|
1176
|
+
delete?: never;
|
|
1177
|
+
options?: never;
|
|
1178
|
+
head?: never;
|
|
1179
|
+
patch?: never;
|
|
1180
|
+
trace?: never;
|
|
1181
|
+
};
|
|
1182
|
+
"/public/envelope/add-recipients": {
|
|
1183
|
+
parameters: {
|
|
1184
|
+
query?: never;
|
|
1185
|
+
header?: never;
|
|
1186
|
+
path?: never;
|
|
1187
|
+
cookie?: never;
|
|
1188
|
+
};
|
|
1189
|
+
get?: never;
|
|
1190
|
+
put?: never;
|
|
1191
|
+
/**
|
|
1192
|
+
* add-recipients
|
|
1193
|
+
* @description Add multiple recipients to an envelope
|
|
1194
|
+
*/
|
|
1195
|
+
post: {
|
|
1196
|
+
parameters: {
|
|
1197
|
+
query?: never;
|
|
1198
|
+
header?: never;
|
|
1199
|
+
path?: never;
|
|
1200
|
+
cookie?: never;
|
|
1201
|
+
};
|
|
1202
|
+
requestBody: {
|
|
1203
|
+
content: {
|
|
1204
|
+
"application/json": {
|
|
1205
|
+
/** @description The UUID of the workspace. */
|
|
1206
|
+
workspaceUuid: string;
|
|
1207
|
+
/** @description The UUID of the envelope. */
|
|
1208
|
+
envelopeUuid: string;
|
|
1209
|
+
/** @description List of recipients to add (max 50). */
|
|
1210
|
+
recipients: ({
|
|
1211
|
+
/** @enum {string} */
|
|
1212
|
+
type: "manual";
|
|
1213
|
+
/**
|
|
1214
|
+
* Format: email
|
|
1215
|
+
* @description The recipient's email address.
|
|
1216
|
+
*/
|
|
1217
|
+
email: string;
|
|
1218
|
+
/** @description The recipient's first name. */
|
|
1219
|
+
firstname: string;
|
|
1220
|
+
/** @description The recipient's last name. */
|
|
1221
|
+
lastname: string;
|
|
1222
|
+
} | {
|
|
1223
|
+
/** @enum {string} */
|
|
1224
|
+
type: "contact";
|
|
1225
|
+
/** @description The UUID of the contact to use. */
|
|
1226
|
+
contactUuid: string;
|
|
1227
|
+
} | {
|
|
1228
|
+
/** @enum {string} */
|
|
1229
|
+
type: "member";
|
|
1230
|
+
/** @description The UUID of the workspace member to use. */
|
|
1231
|
+
userUuid: string;
|
|
1232
|
+
})[];
|
|
1233
|
+
};
|
|
1234
|
+
};
|
|
1235
|
+
};
|
|
1236
|
+
responses: {
|
|
1237
|
+
/** @description Default Response */
|
|
1238
|
+
200: {
|
|
1239
|
+
headers: {
|
|
1240
|
+
[name: string]: unknown;
|
|
1241
|
+
};
|
|
1242
|
+
content: {
|
|
1243
|
+
"application/json": {
|
|
1244
|
+
recipients: {
|
|
1245
|
+
/** @description The recipient's email address. */
|
|
1246
|
+
email: string;
|
|
1247
|
+
/** @description The recipient's first name. */
|
|
1248
|
+
firstname: string;
|
|
1249
|
+
/** @description The recipient's last name. */
|
|
1250
|
+
lastname: string;
|
|
1251
|
+
/**
|
|
1252
|
+
* @description The recipient's role.
|
|
1253
|
+
* @enum {string}
|
|
1254
|
+
*/
|
|
1255
|
+
role: "signer";
|
|
1256
|
+
/** @description Whether the recipient is associated with a contact. */
|
|
1257
|
+
associatedContact: boolean;
|
|
1258
|
+
/**
|
|
1259
|
+
* @description The current status of the recipient.
|
|
1260
|
+
* @enum {string}
|
|
1261
|
+
*/
|
|
1262
|
+
status: "pending" | "approved" | "signed" | "declined" | "canceled";
|
|
1263
|
+
}[];
|
|
1264
|
+
};
|
|
1265
|
+
};
|
|
1266
|
+
};
|
|
1267
|
+
/** @description Default Response */
|
|
1268
|
+
400: {
|
|
1269
|
+
headers: {
|
|
1270
|
+
[name: string]: unknown;
|
|
1271
|
+
};
|
|
1272
|
+
content: {
|
|
1273
|
+
"application/json": {
|
|
1274
|
+
/** @description HTTP status code */
|
|
1275
|
+
statusCode: number;
|
|
1276
|
+
error: {
|
|
1277
|
+
/**
|
|
1278
|
+
* @description The error code
|
|
1279
|
+
* @enum {string}
|
|
1280
|
+
*/
|
|
1281
|
+
code: "WORKSPACE_NOT_FOUND" | "ENVELOPE_NOT_FOUND" | "DUPLICATE_RECIPIENT" | "ENVELOPE_NOT_IN_DRAFT" | "CONTACT_NOT_FOUND" | "USER_NOT_FOUND" | "INVALID_REQUEST_FORMAT";
|
|
1282
|
+
/** @description The error message */
|
|
1283
|
+
message: string;
|
|
1284
|
+
/** @description A suggestion to resolve the error */
|
|
1285
|
+
suggestion: string;
|
|
1286
|
+
/** @description A URL to the documentation */
|
|
1287
|
+
documentationUrl: string;
|
|
1288
|
+
};
|
|
1289
|
+
/** @description The unique identifier of the request */
|
|
1290
|
+
requestId: string;
|
|
1291
|
+
/** @description The timestamp of the response */
|
|
1292
|
+
timestamp: string;
|
|
1293
|
+
/** @description The path of the request */
|
|
1294
|
+
path: string;
|
|
1295
|
+
};
|
|
1296
|
+
};
|
|
1297
|
+
};
|
|
1298
|
+
/** @description Default Response */
|
|
1299
|
+
401: {
|
|
1300
|
+
headers: {
|
|
1301
|
+
[name: string]: unknown;
|
|
1302
|
+
};
|
|
1303
|
+
content: {
|
|
1304
|
+
"application/json": {
|
|
1305
|
+
/** @description HTTP status code */
|
|
1306
|
+
statusCode: number;
|
|
1307
|
+
error: {
|
|
1308
|
+
/**
|
|
1309
|
+
* @description The error code
|
|
1310
|
+
* @enum {string}
|
|
1311
|
+
*/
|
|
1312
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
1313
|
+
/** @description The error message */
|
|
1314
|
+
message: string;
|
|
1315
|
+
/** @description A suggestion to resolve the error */
|
|
1316
|
+
suggestion: string;
|
|
1317
|
+
/** @description A URL to the documentation */
|
|
1318
|
+
documentationUrl: string;
|
|
1319
|
+
};
|
|
1320
|
+
/** @description The unique identifier of the request */
|
|
1321
|
+
requestId: string;
|
|
1322
|
+
/** @description The timestamp of the response */
|
|
1323
|
+
timestamp: string;
|
|
1324
|
+
/** @description The path of the request */
|
|
1325
|
+
path: string;
|
|
1326
|
+
};
|
|
1327
|
+
};
|
|
1328
|
+
};
|
|
1329
|
+
/** @description Default Response */
|
|
1330
|
+
403: {
|
|
1331
|
+
headers: {
|
|
1332
|
+
[name: string]: unknown;
|
|
1333
|
+
};
|
|
1334
|
+
content: {
|
|
1335
|
+
"application/json": {
|
|
1336
|
+
/** @description HTTP status code */
|
|
1337
|
+
statusCode: number;
|
|
1338
|
+
error: {
|
|
1339
|
+
/**
|
|
1340
|
+
* @description The error code
|
|
1341
|
+
* @enum {string}
|
|
1342
|
+
*/
|
|
1343
|
+
code: "AUTHORIZATION_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
1344
|
+
/** @description The error message */
|
|
1345
|
+
message: string;
|
|
1346
|
+
/** @description A suggestion to resolve the error */
|
|
1347
|
+
suggestion: string;
|
|
1348
|
+
/** @description A URL to the documentation */
|
|
1349
|
+
documentationUrl: string;
|
|
1350
|
+
};
|
|
1351
|
+
/** @description The unique identifier of the request */
|
|
1352
|
+
requestId: string;
|
|
1353
|
+
/** @description The timestamp of the response */
|
|
1354
|
+
timestamp: string;
|
|
1355
|
+
/** @description The path of the request */
|
|
1356
|
+
path: string;
|
|
1357
|
+
};
|
|
1358
|
+
};
|
|
1359
|
+
};
|
|
1360
|
+
/** @description Default Response */
|
|
1361
|
+
500: {
|
|
1362
|
+
headers: {
|
|
1363
|
+
[name: string]: unknown;
|
|
1364
|
+
};
|
|
1365
|
+
content: {
|
|
1366
|
+
"application/json": {
|
|
1367
|
+
/** @description HTTP status code */
|
|
1368
|
+
statusCode: number;
|
|
1369
|
+
error: {
|
|
1370
|
+
/**
|
|
1371
|
+
* @description The error code
|
|
1372
|
+
* @enum {string}
|
|
1373
|
+
*/
|
|
1374
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
1375
|
+
/** @description The error message */
|
|
1376
|
+
message: string;
|
|
1377
|
+
/** @description A suggestion to resolve the error */
|
|
1378
|
+
suggestion: string;
|
|
1379
|
+
/** @description A URL to the documentation */
|
|
1380
|
+
documentationUrl: string;
|
|
1381
|
+
};
|
|
1382
|
+
/** @description The unique identifier of the request */
|
|
1383
|
+
requestId: string;
|
|
1384
|
+
/** @description The timestamp of the response */
|
|
1385
|
+
timestamp: string;
|
|
1386
|
+
/** @description The path of the request */
|
|
1387
|
+
path: string;
|
|
1388
|
+
};
|
|
1389
|
+
};
|
|
1390
|
+
};
|
|
1391
|
+
};
|
|
1392
|
+
};
|
|
1393
|
+
delete?: never;
|
|
1394
|
+
options?: never;
|
|
1395
|
+
head?: never;
|
|
1396
|
+
patch?: never;
|
|
1397
|
+
trace?: never;
|
|
1398
|
+
};
|
|
1399
|
+
"/public/envelope/create": {
|
|
1400
|
+
parameters: {
|
|
1401
|
+
query?: never;
|
|
1402
|
+
header?: never;
|
|
1403
|
+
path?: never;
|
|
1404
|
+
cookie?: never;
|
|
1405
|
+
};
|
|
1406
|
+
get?: never;
|
|
1407
|
+
put?: never;
|
|
1408
|
+
/**
|
|
1409
|
+
* create
|
|
1410
|
+
* @description Create an envelope and the first document placeholder. Optionally accepts a small file directly (max 10 MB) in the request body. If a file is provided, it will be encrypted and uploaded to S3, and pre-signed S3 parameters will not be returned. Otherwise, returns pre-signed S3 parameters for document upload.
|
|
1411
|
+
*/
|
|
1412
|
+
post: {
|
|
1413
|
+
parameters: {
|
|
1414
|
+
query?: never;
|
|
1415
|
+
header?: never;
|
|
1416
|
+
path?: never;
|
|
1417
|
+
cookie?: never;
|
|
1418
|
+
};
|
|
1419
|
+
requestBody: {
|
|
1420
|
+
content: {
|
|
1421
|
+
"application/json": {
|
|
1422
|
+
/** @description The UUID of the workspace to create the envelope in. */
|
|
1423
|
+
workspaceUuid: string;
|
|
1424
|
+
/** @description The title of the envelope being created. */
|
|
1425
|
+
envelopeTitle: string;
|
|
1426
|
+
/**
|
|
1427
|
+
* Format: base64
|
|
1428
|
+
* @description Base64-encoded PDF file data (max 10 MB). If provided, the file will be encrypted and uploaded directly, and presignedS3Params will not be returned.
|
|
1429
|
+
*/
|
|
1430
|
+
file?: string;
|
|
1431
|
+
};
|
|
1432
|
+
};
|
|
1433
|
+
};
|
|
1434
|
+
responses: {
|
|
1435
|
+
/** @description Default Response */
|
|
1436
|
+
200: {
|
|
1437
|
+
headers: {
|
|
1438
|
+
[name: string]: unknown;
|
|
1439
|
+
};
|
|
1440
|
+
content: {
|
|
1441
|
+
"application/json": {
|
|
1442
|
+
/** @description The unique identifier of the created envelope. */
|
|
1443
|
+
envelopeUuid: string;
|
|
1444
|
+
/** @description The unique identifier of the first document. */
|
|
1445
|
+
documentUuid: string;
|
|
1446
|
+
/** @description Pre-signed S3 parameters for document upload. Only returned when no file is provided in the request. */
|
|
1447
|
+
presignedS3Params?: {
|
|
1448
|
+
/** @description The pre-signed S3 URL for uploading the document. */
|
|
1449
|
+
url: string;
|
|
1450
|
+
/** @description Fields required for the S3 upload. */
|
|
1451
|
+
fields: {
|
|
1452
|
+
/** @description The S3 bucket name. */
|
|
1453
|
+
bucket: string;
|
|
1454
|
+
/** @description The S3 key. */
|
|
1455
|
+
key: string;
|
|
1456
|
+
/** @description The S3 content type. */
|
|
1457
|
+
"content-type": string;
|
|
1458
|
+
/** @description The S3 algorithm. */
|
|
1459
|
+
"x-amz-algorithm": string;
|
|
1460
|
+
/** @description The S3 credential. */
|
|
1461
|
+
"x-amz-credential": string;
|
|
1462
|
+
/** @description The S3 date. */
|
|
1463
|
+
"x-amz-date": string;
|
|
1464
|
+
/** @description The S3 policy. */
|
|
1465
|
+
policy: string;
|
|
1466
|
+
/** @description The S3 signature. */
|
|
1467
|
+
"x-amz-signature": string;
|
|
1468
|
+
};
|
|
1469
|
+
};
|
|
1470
|
+
/** @description The encryption key in base64 for the document revision to be used for encryption. */
|
|
1471
|
+
revisionEncryptionKey: string;
|
|
1472
|
+
};
|
|
1473
|
+
};
|
|
1474
|
+
};
|
|
1475
|
+
/** @description Default Response */
|
|
1476
|
+
400: {
|
|
1477
|
+
headers: {
|
|
1478
|
+
[name: string]: unknown;
|
|
1479
|
+
};
|
|
1480
|
+
content: {
|
|
1481
|
+
"application/json": {
|
|
1482
|
+
/** @description HTTP status code */
|
|
1483
|
+
statusCode: number;
|
|
1484
|
+
error: {
|
|
1485
|
+
/**
|
|
1486
|
+
* @description The error code
|
|
1487
|
+
* @enum {string}
|
|
1488
|
+
*/
|
|
1489
|
+
code: "WORKSPACE_NOT_FOUND" | "INVALID_FILE_DATA" | "FILE_SIZE_EXCEEDED" | "INVALID_PDF" | "INVALID_REQUEST_FORMAT";
|
|
1490
|
+
/** @description The error message */
|
|
1491
|
+
message: string;
|
|
1492
|
+
/** @description A suggestion to resolve the error */
|
|
1493
|
+
suggestion: string;
|
|
1494
|
+
/** @description A URL to the documentation */
|
|
1495
|
+
documentationUrl: string;
|
|
1496
|
+
};
|
|
1497
|
+
/** @description The unique identifier of the request */
|
|
1498
|
+
requestId: string;
|
|
1499
|
+
/** @description The timestamp of the response */
|
|
1500
|
+
timestamp: string;
|
|
1501
|
+
/** @description The path of the request */
|
|
1502
|
+
path: string;
|
|
1503
|
+
};
|
|
1504
|
+
};
|
|
1505
|
+
};
|
|
1506
|
+
/** @description Default Response */
|
|
1507
|
+
401: {
|
|
1508
|
+
headers: {
|
|
1509
|
+
[name: string]: unknown;
|
|
1510
|
+
};
|
|
1511
|
+
content: {
|
|
1512
|
+
"application/json": {
|
|
1513
|
+
/** @description HTTP status code */
|
|
1514
|
+
statusCode: number;
|
|
1515
|
+
error: {
|
|
1516
|
+
/**
|
|
1517
|
+
* @description The error code
|
|
1518
|
+
* @enum {string}
|
|
1519
|
+
*/
|
|
1520
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
1521
|
+
/** @description The error message */
|
|
1522
|
+
message: string;
|
|
1523
|
+
/** @description A suggestion to resolve the error */
|
|
1524
|
+
suggestion: string;
|
|
1525
|
+
/** @description A URL to the documentation */
|
|
1526
|
+
documentationUrl: string;
|
|
1527
|
+
};
|
|
1528
|
+
/** @description The unique identifier of the request */
|
|
1529
|
+
requestId: string;
|
|
1530
|
+
/** @description The timestamp of the response */
|
|
1531
|
+
timestamp: string;
|
|
1532
|
+
/** @description The path of the request */
|
|
1533
|
+
path: string;
|
|
1534
|
+
};
|
|
1535
|
+
};
|
|
1536
|
+
};
|
|
1537
|
+
/** @description Default Response */
|
|
1538
|
+
403: {
|
|
1539
|
+
headers: {
|
|
1540
|
+
[name: string]: unknown;
|
|
1541
|
+
};
|
|
1542
|
+
content: {
|
|
1543
|
+
"application/json": {
|
|
1544
|
+
/** @description HTTP status code */
|
|
1545
|
+
statusCode: number;
|
|
1546
|
+
error: {
|
|
1547
|
+
/**
|
|
1548
|
+
* @description The error code
|
|
1549
|
+
* @enum {string}
|
|
1550
|
+
*/
|
|
1551
|
+
code: "AUTHORIZATION_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
1552
|
+
/** @description The error message */
|
|
1553
|
+
message: string;
|
|
1554
|
+
/** @description A suggestion to resolve the error */
|
|
1555
|
+
suggestion: string;
|
|
1556
|
+
/** @description A URL to the documentation */
|
|
1557
|
+
documentationUrl: string;
|
|
1558
|
+
};
|
|
1559
|
+
/** @description The unique identifier of the request */
|
|
1560
|
+
requestId: string;
|
|
1561
|
+
/** @description The timestamp of the response */
|
|
1562
|
+
timestamp: string;
|
|
1563
|
+
/** @description The path of the request */
|
|
1564
|
+
path: string;
|
|
1565
|
+
};
|
|
1566
|
+
};
|
|
1567
|
+
};
|
|
1568
|
+
/** @description Default Response */
|
|
1569
|
+
500: {
|
|
1570
|
+
headers: {
|
|
1571
|
+
[name: string]: unknown;
|
|
1572
|
+
};
|
|
1573
|
+
content: {
|
|
1574
|
+
"application/json": {
|
|
1575
|
+
/** @description HTTP status code */
|
|
1576
|
+
statusCode: number;
|
|
1577
|
+
error: {
|
|
1578
|
+
/**
|
|
1579
|
+
* @description The error code
|
|
1580
|
+
* @enum {string}
|
|
1581
|
+
*/
|
|
1582
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
1583
|
+
/** @description The error message */
|
|
1584
|
+
message: string;
|
|
1585
|
+
/** @description A suggestion to resolve the error */
|
|
1586
|
+
suggestion: string;
|
|
1587
|
+
/** @description A URL to the documentation */
|
|
1588
|
+
documentationUrl: string;
|
|
1589
|
+
};
|
|
1590
|
+
/** @description The unique identifier of the request */
|
|
1591
|
+
requestId: string;
|
|
1592
|
+
/** @description The timestamp of the response */
|
|
1593
|
+
timestamp: string;
|
|
1594
|
+
/** @description The path of the request */
|
|
1595
|
+
path: string;
|
|
1596
|
+
};
|
|
1597
|
+
};
|
|
1598
|
+
};
|
|
1599
|
+
};
|
|
1600
|
+
};
|
|
1601
|
+
delete?: never;
|
|
1602
|
+
options?: never;
|
|
1603
|
+
head?: never;
|
|
1604
|
+
patch?: never;
|
|
1605
|
+
trace?: never;
|
|
1606
|
+
};
|
|
1607
|
+
"/public/envelope/create-from-template": {
|
|
1608
|
+
parameters: {
|
|
1609
|
+
query?: never;
|
|
1610
|
+
header?: never;
|
|
1611
|
+
path?: never;
|
|
1612
|
+
cookie?: never;
|
|
1613
|
+
};
|
|
1614
|
+
get?: never;
|
|
1615
|
+
put?: never;
|
|
1616
|
+
/**
|
|
1617
|
+
* create-from-template
|
|
1618
|
+
* @description Create a new envelope from a template by copying documents and mapping recipient labels to actual recipients
|
|
1619
|
+
*/
|
|
1620
|
+
post: {
|
|
1621
|
+
parameters: {
|
|
1622
|
+
query?: never;
|
|
1623
|
+
header?: never;
|
|
1624
|
+
path?: never;
|
|
1625
|
+
cookie?: never;
|
|
1626
|
+
};
|
|
1627
|
+
requestBody: {
|
|
1628
|
+
content: {
|
|
1629
|
+
"application/json": {
|
|
1630
|
+
/** @description The UUID of the workspace to create the envelope in. */
|
|
1631
|
+
workspaceUuid: string;
|
|
1632
|
+
/** @description The UUID of the template to copy from. */
|
|
1633
|
+
templateUuid: string;
|
|
1634
|
+
/** @description Array of recipients with labels to map to template recipient labels. */
|
|
1635
|
+
recipients: ({
|
|
1636
|
+
/** @enum {string} */
|
|
1637
|
+
type: "manual";
|
|
1638
|
+
/** @description The label to map to template recipient labels. */
|
|
1639
|
+
label: string;
|
|
1640
|
+
/**
|
|
1641
|
+
* Format: email
|
|
1642
|
+
* @description The recipient's email address.
|
|
1643
|
+
*/
|
|
1644
|
+
email: string;
|
|
1645
|
+
/** @description The recipient's first name. */
|
|
1646
|
+
firstname: string;
|
|
1647
|
+
/** @description The recipient's last name. */
|
|
1648
|
+
lastname: string;
|
|
1649
|
+
} | {
|
|
1650
|
+
/** @enum {string} */
|
|
1651
|
+
type: "contact";
|
|
1652
|
+
/** @description The label to map to template recipient labels. */
|
|
1653
|
+
label: string;
|
|
1654
|
+
/** @description The UUID of the contact to use. */
|
|
1655
|
+
contactUuid: string;
|
|
1656
|
+
} | {
|
|
1657
|
+
/** @enum {string} */
|
|
1658
|
+
type: "member";
|
|
1659
|
+
/** @description The label to map to template recipient labels. */
|
|
1660
|
+
label: string;
|
|
1661
|
+
/** @description The UUID of the workspace member to use. */
|
|
1662
|
+
userUuid: string;
|
|
1663
|
+
})[];
|
|
1664
|
+
};
|
|
1665
|
+
};
|
|
1666
|
+
};
|
|
1667
|
+
responses: {
|
|
1668
|
+
/** @description Default Response */
|
|
1669
|
+
200: {
|
|
1670
|
+
headers: {
|
|
1671
|
+
[name: string]: unknown;
|
|
1672
|
+
};
|
|
1673
|
+
content: {
|
|
1674
|
+
"application/json": {
|
|
1675
|
+
/** @description The UUID of the created envelope. */
|
|
1676
|
+
envelopeUuid: string;
|
|
1677
|
+
/** @description Array of UUIDs of the created documents. */
|
|
1678
|
+
documentUuids: string[];
|
|
1679
|
+
};
|
|
1680
|
+
};
|
|
1681
|
+
};
|
|
1682
|
+
/** @description Default Response */
|
|
1683
|
+
400: {
|
|
1684
|
+
headers: {
|
|
1685
|
+
[name: string]: unknown;
|
|
1686
|
+
};
|
|
1687
|
+
content: {
|
|
1688
|
+
"application/json": {
|
|
1689
|
+
/** @description HTTP status code */
|
|
1690
|
+
statusCode: number;
|
|
1691
|
+
error: {
|
|
1692
|
+
/**
|
|
1693
|
+
* @description The error code
|
|
1694
|
+
* @enum {string}
|
|
1695
|
+
*/
|
|
1696
|
+
code: "WORKSPACE_NOT_FOUND" | "TEMPLATE_NOT_FOUND" | "CONTACT_NOT_FOUND" | "USER_NOT_FOUND" | "INVALID_RECIPIENT_LABELS" | "INVALID_REQUEST_FORMAT";
|
|
1697
|
+
/** @description The error message */
|
|
1698
|
+
message: string;
|
|
1699
|
+
/** @description A suggestion to resolve the error */
|
|
1700
|
+
suggestion: string;
|
|
1701
|
+
/** @description A URL to the documentation */
|
|
1702
|
+
documentationUrl: string;
|
|
1703
|
+
};
|
|
1704
|
+
/** @description The unique identifier of the request */
|
|
1705
|
+
requestId: string;
|
|
1706
|
+
/** @description The timestamp of the response */
|
|
1707
|
+
timestamp: string;
|
|
1708
|
+
/** @description The path of the request */
|
|
1709
|
+
path: string;
|
|
1710
|
+
};
|
|
1711
|
+
};
|
|
1712
|
+
};
|
|
1713
|
+
/** @description Default Response */
|
|
1714
|
+
401: {
|
|
1715
|
+
headers: {
|
|
1716
|
+
[name: string]: unknown;
|
|
1717
|
+
};
|
|
1718
|
+
content: {
|
|
1719
|
+
"application/json": {
|
|
1720
|
+
/** @description HTTP status code */
|
|
1721
|
+
statusCode: number;
|
|
1722
|
+
error: {
|
|
1723
|
+
/**
|
|
1724
|
+
* @description The error code
|
|
1725
|
+
* @enum {string}
|
|
1726
|
+
*/
|
|
1727
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
1728
|
+
/** @description The error message */
|
|
1729
|
+
message: string;
|
|
1730
|
+
/** @description A suggestion to resolve the error */
|
|
1731
|
+
suggestion: string;
|
|
1732
|
+
/** @description A URL to the documentation */
|
|
1733
|
+
documentationUrl: string;
|
|
1734
|
+
};
|
|
1735
|
+
/** @description The unique identifier of the request */
|
|
1736
|
+
requestId: string;
|
|
1737
|
+
/** @description The timestamp of the response */
|
|
1738
|
+
timestamp: string;
|
|
1739
|
+
/** @description The path of the request */
|
|
1740
|
+
path: string;
|
|
1741
|
+
};
|
|
1742
|
+
};
|
|
1743
|
+
};
|
|
1744
|
+
/** @description Default Response */
|
|
1745
|
+
403: {
|
|
1746
|
+
headers: {
|
|
1747
|
+
[name: string]: unknown;
|
|
1748
|
+
};
|
|
1749
|
+
content: {
|
|
1750
|
+
"application/json": {
|
|
1751
|
+
/** @description HTTP status code */
|
|
1752
|
+
statusCode: number;
|
|
1753
|
+
error: {
|
|
1754
|
+
/**
|
|
1755
|
+
* @description The error code
|
|
1756
|
+
* @enum {string}
|
|
1757
|
+
*/
|
|
1758
|
+
code: "AUTHORIZATION_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
1759
|
+
/** @description The error message */
|
|
1760
|
+
message: string;
|
|
1761
|
+
/** @description A suggestion to resolve the error */
|
|
1762
|
+
suggestion: string;
|
|
1763
|
+
/** @description A URL to the documentation */
|
|
1764
|
+
documentationUrl: string;
|
|
1765
|
+
};
|
|
1766
|
+
/** @description The unique identifier of the request */
|
|
1767
|
+
requestId: string;
|
|
1768
|
+
/** @description The timestamp of the response */
|
|
1769
|
+
timestamp: string;
|
|
1770
|
+
/** @description The path of the request */
|
|
1771
|
+
path: string;
|
|
1772
|
+
};
|
|
1773
|
+
};
|
|
1774
|
+
};
|
|
1775
|
+
/** @description Default Response */
|
|
1776
|
+
500: {
|
|
1777
|
+
headers: {
|
|
1778
|
+
[name: string]: unknown;
|
|
1779
|
+
};
|
|
1780
|
+
content: {
|
|
1781
|
+
"application/json": {
|
|
1782
|
+
/** @description HTTP status code */
|
|
1783
|
+
statusCode: number;
|
|
1784
|
+
error: {
|
|
1785
|
+
/**
|
|
1786
|
+
* @description The error code
|
|
1787
|
+
* @enum {string}
|
|
1788
|
+
*/
|
|
1789
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
1790
|
+
/** @description The error message */
|
|
1791
|
+
message: string;
|
|
1792
|
+
/** @description A suggestion to resolve the error */
|
|
1793
|
+
suggestion: string;
|
|
1794
|
+
/** @description A URL to the documentation */
|
|
1795
|
+
documentationUrl: string;
|
|
1796
|
+
};
|
|
1797
|
+
/** @description The unique identifier of the request */
|
|
1798
|
+
requestId: string;
|
|
1799
|
+
/** @description The timestamp of the response */
|
|
1800
|
+
timestamp: string;
|
|
1801
|
+
/** @description The path of the request */
|
|
1802
|
+
path: string;
|
|
1803
|
+
};
|
|
1804
|
+
};
|
|
1805
|
+
};
|
|
1806
|
+
};
|
|
1807
|
+
};
|
|
1808
|
+
delete?: never;
|
|
1809
|
+
options?: never;
|
|
1810
|
+
head?: never;
|
|
1811
|
+
patch?: never;
|
|
1812
|
+
trace?: never;
|
|
1813
|
+
};
|
|
1814
|
+
"/public/envelope/delete-blocks": {
|
|
1815
|
+
parameters: {
|
|
1816
|
+
query?: never;
|
|
1817
|
+
header?: never;
|
|
1818
|
+
path?: never;
|
|
1819
|
+
cookie?: never;
|
|
1820
|
+
};
|
|
1821
|
+
get?: never;
|
|
1822
|
+
put?: never;
|
|
1823
|
+
/**
|
|
1824
|
+
* delete-blocks
|
|
1825
|
+
* @description Delete blocks from a document snapshot in an envelope
|
|
1826
|
+
*/
|
|
1827
|
+
post: {
|
|
1828
|
+
parameters: {
|
|
1829
|
+
query?: never;
|
|
1830
|
+
header?: never;
|
|
1831
|
+
path?: never;
|
|
1832
|
+
cookie?: never;
|
|
1833
|
+
};
|
|
1834
|
+
requestBody: {
|
|
1835
|
+
content: {
|
|
1836
|
+
"application/json": {
|
|
1837
|
+
/** @description The UUID of the workspace. */
|
|
1838
|
+
workspaceUuid: string;
|
|
1839
|
+
/** @description The UUID of the envelope. */
|
|
1840
|
+
envelopeUuid: string;
|
|
1841
|
+
/** @description The UUID of the document. */
|
|
1842
|
+
documentUuid: string;
|
|
1843
|
+
/** @description Array of block UUIDs to delete from the document. */
|
|
1844
|
+
blockUuids: string[];
|
|
1845
|
+
};
|
|
1846
|
+
};
|
|
1847
|
+
};
|
|
1848
|
+
responses: {
|
|
1849
|
+
/** @description Default Response */
|
|
1850
|
+
200: {
|
|
1851
|
+
headers: {
|
|
1852
|
+
[name: string]: unknown;
|
|
1853
|
+
};
|
|
1854
|
+
content: {
|
|
1855
|
+
"application/json": {
|
|
1856
|
+
/** @description The date and time the snapshot was created (unix timestamp). */
|
|
1857
|
+
snapshotDate: number;
|
|
1858
|
+
};
|
|
1859
|
+
};
|
|
1860
|
+
};
|
|
1861
|
+
/** @description Default Response */
|
|
1862
|
+
400: {
|
|
1863
|
+
headers: {
|
|
1864
|
+
[name: string]: unknown;
|
|
1865
|
+
};
|
|
1866
|
+
content: {
|
|
1867
|
+
"application/json": {
|
|
1868
|
+
/** @description HTTP status code */
|
|
1869
|
+
statusCode: number;
|
|
1870
|
+
error: {
|
|
1871
|
+
/**
|
|
1872
|
+
* @description The error code
|
|
1873
|
+
* @enum {string}
|
|
1874
|
+
*/
|
|
1875
|
+
code: "WORKSPACE_NOT_FOUND" | "ENVELOPE_NOT_FOUND" | "DOCUMENT_NOT_FOUND" | "ENVELOPE_NOT_IN_DRAFT" | "INVALID_REQUEST_FORMAT";
|
|
1876
|
+
/** @description The error message */
|
|
1877
|
+
message: string;
|
|
1878
|
+
/** @description A suggestion to resolve the error */
|
|
1879
|
+
suggestion: string;
|
|
1880
|
+
/** @description A URL to the documentation */
|
|
1881
|
+
documentationUrl: string;
|
|
1882
|
+
};
|
|
1883
|
+
/** @description The unique identifier of the request */
|
|
1884
|
+
requestId: string;
|
|
1885
|
+
/** @description The timestamp of the response */
|
|
1886
|
+
timestamp: string;
|
|
1887
|
+
/** @description The path of the request */
|
|
1888
|
+
path: string;
|
|
1889
|
+
};
|
|
1890
|
+
};
|
|
1891
|
+
};
|
|
1892
|
+
/** @description Default Response */
|
|
1893
|
+
401: {
|
|
1894
|
+
headers: {
|
|
1895
|
+
[name: string]: unknown;
|
|
1896
|
+
};
|
|
1897
|
+
content: {
|
|
1898
|
+
"application/json": {
|
|
1899
|
+
/** @description HTTP status code */
|
|
1900
|
+
statusCode: number;
|
|
1901
|
+
error: {
|
|
1902
|
+
/**
|
|
1903
|
+
* @description The error code
|
|
1904
|
+
* @enum {string}
|
|
1905
|
+
*/
|
|
1906
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
1907
|
+
/** @description The error message */
|
|
1908
|
+
message: string;
|
|
1909
|
+
/** @description A suggestion to resolve the error */
|
|
1910
|
+
suggestion: string;
|
|
1911
|
+
/** @description A URL to the documentation */
|
|
1912
|
+
documentationUrl: string;
|
|
1913
|
+
};
|
|
1914
|
+
/** @description The unique identifier of the request */
|
|
1915
|
+
requestId: string;
|
|
1916
|
+
/** @description The timestamp of the response */
|
|
1917
|
+
timestamp: string;
|
|
1918
|
+
/** @description The path of the request */
|
|
1919
|
+
path: string;
|
|
1920
|
+
};
|
|
1921
|
+
};
|
|
1922
|
+
};
|
|
1923
|
+
/** @description Default Response */
|
|
1924
|
+
403: {
|
|
1925
|
+
headers: {
|
|
1926
|
+
[name: string]: unknown;
|
|
1927
|
+
};
|
|
1928
|
+
content: {
|
|
1929
|
+
"application/json": {
|
|
1930
|
+
/** @description HTTP status code */
|
|
1931
|
+
statusCode: number;
|
|
1932
|
+
error: {
|
|
1933
|
+
/**
|
|
1934
|
+
* @description The error code
|
|
1935
|
+
* @enum {string}
|
|
1936
|
+
*/
|
|
1937
|
+
code: "AUTHORIZATION_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
1938
|
+
/** @description The error message */
|
|
1939
|
+
message: string;
|
|
1940
|
+
/** @description A suggestion to resolve the error */
|
|
1941
|
+
suggestion: string;
|
|
1942
|
+
/** @description A URL to the documentation */
|
|
1943
|
+
documentationUrl: string;
|
|
1944
|
+
};
|
|
1945
|
+
/** @description The unique identifier of the request */
|
|
1946
|
+
requestId: string;
|
|
1947
|
+
/** @description The timestamp of the response */
|
|
1948
|
+
timestamp: string;
|
|
1949
|
+
/** @description The path of the request */
|
|
1950
|
+
path: string;
|
|
1951
|
+
};
|
|
1952
|
+
};
|
|
1953
|
+
};
|
|
1954
|
+
/** @description Default Response */
|
|
1955
|
+
500: {
|
|
1956
|
+
headers: {
|
|
1957
|
+
[name: string]: unknown;
|
|
1958
|
+
};
|
|
1959
|
+
content: {
|
|
1960
|
+
"application/json": {
|
|
1961
|
+
/** @description HTTP status code */
|
|
1962
|
+
statusCode: number;
|
|
1963
|
+
error: {
|
|
1964
|
+
/**
|
|
1965
|
+
* @description The error code
|
|
1966
|
+
* @enum {string}
|
|
1967
|
+
*/
|
|
1968
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
1969
|
+
/** @description The error message */
|
|
1970
|
+
message: string;
|
|
1971
|
+
/** @description A suggestion to resolve the error */
|
|
1972
|
+
suggestion: string;
|
|
1973
|
+
/** @description A URL to the documentation */
|
|
1974
|
+
documentationUrl: string;
|
|
1975
|
+
};
|
|
1976
|
+
/** @description The unique identifier of the request */
|
|
1977
|
+
requestId: string;
|
|
1978
|
+
/** @description The timestamp of the response */
|
|
1979
|
+
timestamp: string;
|
|
1980
|
+
/** @description The path of the request */
|
|
1981
|
+
path: string;
|
|
1982
|
+
};
|
|
1983
|
+
};
|
|
1984
|
+
};
|
|
1985
|
+
};
|
|
1986
|
+
};
|
|
1987
|
+
delete?: never;
|
|
1988
|
+
options?: never;
|
|
1989
|
+
head?: never;
|
|
1990
|
+
patch?: never;
|
|
1991
|
+
trace?: never;
|
|
1992
|
+
};
|
|
1993
|
+
"/public/envelope/delete": {
|
|
1994
|
+
parameters: {
|
|
1995
|
+
query?: never;
|
|
1996
|
+
header?: never;
|
|
1997
|
+
path?: never;
|
|
1998
|
+
cookie?: never;
|
|
1999
|
+
};
|
|
2000
|
+
get?: never;
|
|
2001
|
+
put?: never;
|
|
2002
|
+
/**
|
|
2003
|
+
* delete
|
|
2004
|
+
* @description Delete an envelope and all associated data
|
|
2005
|
+
*/
|
|
2006
|
+
post: {
|
|
2007
|
+
parameters: {
|
|
2008
|
+
query?: never;
|
|
2009
|
+
header?: never;
|
|
2010
|
+
path?: never;
|
|
2011
|
+
cookie?: never;
|
|
2012
|
+
};
|
|
2013
|
+
requestBody: {
|
|
2014
|
+
content: {
|
|
2015
|
+
"application/json": {
|
|
2016
|
+
/** @description The UUID of the workspace containing the envelope. */
|
|
2017
|
+
workspaceUuid: string;
|
|
2018
|
+
/** @description The UUID of the envelope to delete. */
|
|
2019
|
+
envelopeUuid: string;
|
|
2020
|
+
};
|
|
2021
|
+
};
|
|
2022
|
+
};
|
|
2023
|
+
responses: {
|
|
2024
|
+
/** @description Default Response */
|
|
2025
|
+
200: {
|
|
2026
|
+
headers: {
|
|
2027
|
+
[name: string]: unknown;
|
|
2028
|
+
};
|
|
2029
|
+
content: {
|
|
2030
|
+
"application/json": Record<string, never>;
|
|
2031
|
+
};
|
|
2032
|
+
};
|
|
2033
|
+
/** @description Default Response */
|
|
2034
|
+
400: {
|
|
2035
|
+
headers: {
|
|
2036
|
+
[name: string]: unknown;
|
|
2037
|
+
};
|
|
2038
|
+
content: {
|
|
2039
|
+
"application/json": {
|
|
2040
|
+
/** @description HTTP status code */
|
|
2041
|
+
statusCode: number;
|
|
2042
|
+
error: {
|
|
2043
|
+
/**
|
|
2044
|
+
* @description The error code
|
|
2045
|
+
* @enum {string}
|
|
2046
|
+
*/
|
|
2047
|
+
code: "WORKSPACE_NOT_FOUND" | "ENVELOPE_NOT_FOUND" | "INVALID_REQUEST_FORMAT";
|
|
2048
|
+
/** @description The error message */
|
|
2049
|
+
message: string;
|
|
2050
|
+
/** @description A suggestion to resolve the error */
|
|
2051
|
+
suggestion: string;
|
|
2052
|
+
/** @description A URL to the documentation */
|
|
2053
|
+
documentationUrl: string;
|
|
2054
|
+
};
|
|
2055
|
+
/** @description The unique identifier of the request */
|
|
2056
|
+
requestId: string;
|
|
2057
|
+
/** @description The timestamp of the response */
|
|
2058
|
+
timestamp: string;
|
|
2059
|
+
/** @description The path of the request */
|
|
2060
|
+
path: string;
|
|
2061
|
+
};
|
|
2062
|
+
};
|
|
2063
|
+
};
|
|
2064
|
+
/** @description Default Response */
|
|
2065
|
+
401: {
|
|
2066
|
+
headers: {
|
|
2067
|
+
[name: string]: unknown;
|
|
2068
|
+
};
|
|
2069
|
+
content: {
|
|
2070
|
+
"application/json": {
|
|
2071
|
+
/** @description HTTP status code */
|
|
2072
|
+
statusCode: number;
|
|
2073
|
+
error: {
|
|
2074
|
+
/**
|
|
2075
|
+
* @description The error code
|
|
2076
|
+
* @enum {string}
|
|
2077
|
+
*/
|
|
2078
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
2079
|
+
/** @description The error message */
|
|
2080
|
+
message: string;
|
|
2081
|
+
/** @description A suggestion to resolve the error */
|
|
2082
|
+
suggestion: string;
|
|
2083
|
+
/** @description A URL to the documentation */
|
|
2084
|
+
documentationUrl: string;
|
|
2085
|
+
};
|
|
2086
|
+
/** @description The unique identifier of the request */
|
|
2087
|
+
requestId: string;
|
|
2088
|
+
/** @description The timestamp of the response */
|
|
2089
|
+
timestamp: string;
|
|
2090
|
+
/** @description The path of the request */
|
|
2091
|
+
path: string;
|
|
2092
|
+
};
|
|
2093
|
+
};
|
|
2094
|
+
};
|
|
2095
|
+
/** @description Default Response */
|
|
2096
|
+
403: {
|
|
2097
|
+
headers: {
|
|
2098
|
+
[name: string]: unknown;
|
|
2099
|
+
};
|
|
2100
|
+
content: {
|
|
2101
|
+
"application/json": {
|
|
2102
|
+
/** @description HTTP status code */
|
|
2103
|
+
statusCode: number;
|
|
2104
|
+
error: {
|
|
2105
|
+
/**
|
|
2106
|
+
* @description The error code
|
|
2107
|
+
* @enum {string}
|
|
2108
|
+
*/
|
|
2109
|
+
code: "AUTHORIZATION_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
2110
|
+
/** @description The error message */
|
|
2111
|
+
message: string;
|
|
2112
|
+
/** @description A suggestion to resolve the error */
|
|
2113
|
+
suggestion: string;
|
|
2114
|
+
/** @description A URL to the documentation */
|
|
2115
|
+
documentationUrl: string;
|
|
2116
|
+
};
|
|
2117
|
+
/** @description The unique identifier of the request */
|
|
2118
|
+
requestId: string;
|
|
2119
|
+
/** @description The timestamp of the response */
|
|
2120
|
+
timestamp: string;
|
|
2121
|
+
/** @description The path of the request */
|
|
2122
|
+
path: string;
|
|
2123
|
+
};
|
|
2124
|
+
};
|
|
2125
|
+
};
|
|
2126
|
+
/** @description Default Response */
|
|
2127
|
+
500: {
|
|
2128
|
+
headers: {
|
|
2129
|
+
[name: string]: unknown;
|
|
2130
|
+
};
|
|
2131
|
+
content: {
|
|
2132
|
+
"application/json": {
|
|
2133
|
+
/** @description HTTP status code */
|
|
2134
|
+
statusCode: number;
|
|
2135
|
+
error: {
|
|
2136
|
+
/**
|
|
2137
|
+
* @description The error code
|
|
2138
|
+
* @enum {string}
|
|
2139
|
+
*/
|
|
2140
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
2141
|
+
/** @description The error message */
|
|
2142
|
+
message: string;
|
|
2143
|
+
/** @description A suggestion to resolve the error */
|
|
2144
|
+
suggestion: string;
|
|
2145
|
+
/** @description A URL to the documentation */
|
|
2146
|
+
documentationUrl: string;
|
|
2147
|
+
};
|
|
2148
|
+
/** @description The unique identifier of the request */
|
|
2149
|
+
requestId: string;
|
|
2150
|
+
/** @description The timestamp of the response */
|
|
2151
|
+
timestamp: string;
|
|
2152
|
+
/** @description The path of the request */
|
|
2153
|
+
path: string;
|
|
2154
|
+
};
|
|
2155
|
+
};
|
|
2156
|
+
};
|
|
2157
|
+
};
|
|
2158
|
+
};
|
|
2159
|
+
delete?: never;
|
|
2160
|
+
options?: never;
|
|
2161
|
+
head?: never;
|
|
2162
|
+
patch?: never;
|
|
2163
|
+
trace?: never;
|
|
2164
|
+
};
|
|
2165
|
+
"/public/envelope/delete-recipients": {
|
|
2166
|
+
parameters: {
|
|
2167
|
+
query?: never;
|
|
2168
|
+
header?: never;
|
|
2169
|
+
path?: never;
|
|
2170
|
+
cookie?: never;
|
|
2171
|
+
};
|
|
2172
|
+
get?: never;
|
|
2173
|
+
put?: never;
|
|
2174
|
+
/**
|
|
2175
|
+
* delete-recipients
|
|
2176
|
+
* @description Remove multiple recipients from an envelope
|
|
2177
|
+
*/
|
|
2178
|
+
post: {
|
|
2179
|
+
parameters: {
|
|
2180
|
+
query?: never;
|
|
2181
|
+
header?: never;
|
|
2182
|
+
path?: never;
|
|
2183
|
+
cookie?: never;
|
|
2184
|
+
};
|
|
2185
|
+
requestBody: {
|
|
2186
|
+
content: {
|
|
2187
|
+
"application/json": {
|
|
2188
|
+
/** @description The UUID of the workspace. */
|
|
2189
|
+
workspaceUuid: string;
|
|
2190
|
+
/** @description The UUID of the envelope. */
|
|
2191
|
+
envelopeUuid: string;
|
|
2192
|
+
/** @description List of recipients to delete (max 50). */
|
|
2193
|
+
recipients: {
|
|
2194
|
+
/**
|
|
2195
|
+
* Format: email
|
|
2196
|
+
* @description The recipient's email address to delete.
|
|
2197
|
+
*/
|
|
2198
|
+
email: string;
|
|
2199
|
+
}[];
|
|
2200
|
+
};
|
|
2201
|
+
};
|
|
2202
|
+
};
|
|
2203
|
+
responses: {
|
|
2204
|
+
/** @description Default Response */
|
|
2205
|
+
200: {
|
|
2206
|
+
headers: {
|
|
2207
|
+
[name: string]: unknown;
|
|
2208
|
+
};
|
|
2209
|
+
content: {
|
|
2210
|
+
"application/json": Record<string, never>;
|
|
2211
|
+
};
|
|
2212
|
+
};
|
|
2213
|
+
/** @description Default Response */
|
|
2214
|
+
400: {
|
|
2215
|
+
headers: {
|
|
2216
|
+
[name: string]: unknown;
|
|
2217
|
+
};
|
|
2218
|
+
content: {
|
|
2219
|
+
"application/json": {
|
|
2220
|
+
/** @description HTTP status code */
|
|
2221
|
+
statusCode: number;
|
|
2222
|
+
error: {
|
|
2223
|
+
/**
|
|
2224
|
+
* @description The error code
|
|
2225
|
+
* @enum {string}
|
|
2226
|
+
*/
|
|
2227
|
+
code: "WORKSPACE_NOT_FOUND" | "ENVELOPE_NOT_FOUND" | "RECIPIENT_NOT_FOUND" | "ENVELOPE_NOT_IN_DRAFT" | "INVALID_REQUEST_FORMAT";
|
|
2228
|
+
/** @description The error message */
|
|
2229
|
+
message: string;
|
|
2230
|
+
/** @description A suggestion to resolve the error */
|
|
2231
|
+
suggestion: string;
|
|
2232
|
+
/** @description A URL to the documentation */
|
|
2233
|
+
documentationUrl: string;
|
|
2234
|
+
};
|
|
2235
|
+
/** @description The unique identifier of the request */
|
|
2236
|
+
requestId: string;
|
|
2237
|
+
/** @description The timestamp of the response */
|
|
2238
|
+
timestamp: string;
|
|
2239
|
+
/** @description The path of the request */
|
|
2240
|
+
path: string;
|
|
2241
|
+
};
|
|
2242
|
+
};
|
|
2243
|
+
};
|
|
2244
|
+
/** @description Default Response */
|
|
2245
|
+
401: {
|
|
2246
|
+
headers: {
|
|
2247
|
+
[name: string]: unknown;
|
|
2248
|
+
};
|
|
2249
|
+
content: {
|
|
2250
|
+
"application/json": {
|
|
2251
|
+
/** @description HTTP status code */
|
|
2252
|
+
statusCode: number;
|
|
2253
|
+
error: {
|
|
2254
|
+
/**
|
|
2255
|
+
* @description The error code
|
|
2256
|
+
* @enum {string}
|
|
2257
|
+
*/
|
|
2258
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
2259
|
+
/** @description The error message */
|
|
2260
|
+
message: string;
|
|
2261
|
+
/** @description A suggestion to resolve the error */
|
|
2262
|
+
suggestion: string;
|
|
2263
|
+
/** @description A URL to the documentation */
|
|
2264
|
+
documentationUrl: string;
|
|
2265
|
+
};
|
|
2266
|
+
/** @description The unique identifier of the request */
|
|
2267
|
+
requestId: string;
|
|
2268
|
+
/** @description The timestamp of the response */
|
|
2269
|
+
timestamp: string;
|
|
2270
|
+
/** @description The path of the request */
|
|
2271
|
+
path: string;
|
|
2272
|
+
};
|
|
2273
|
+
};
|
|
2274
|
+
};
|
|
2275
|
+
/** @description Default Response */
|
|
2276
|
+
403: {
|
|
2277
|
+
headers: {
|
|
2278
|
+
[name: string]: unknown;
|
|
2279
|
+
};
|
|
2280
|
+
content: {
|
|
2281
|
+
"application/json": {
|
|
2282
|
+
/** @description HTTP status code */
|
|
2283
|
+
statusCode: number;
|
|
2284
|
+
error: {
|
|
2285
|
+
/**
|
|
2286
|
+
* @description The error code
|
|
2287
|
+
* @enum {string}
|
|
2288
|
+
*/
|
|
2289
|
+
code: "AUTHORIZATION_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
2290
|
+
/** @description The error message */
|
|
2291
|
+
message: string;
|
|
2292
|
+
/** @description A suggestion to resolve the error */
|
|
2293
|
+
suggestion: string;
|
|
2294
|
+
/** @description A URL to the documentation */
|
|
2295
|
+
documentationUrl: string;
|
|
2296
|
+
};
|
|
2297
|
+
/** @description The unique identifier of the request */
|
|
2298
|
+
requestId: string;
|
|
2299
|
+
/** @description The timestamp of the response */
|
|
2300
|
+
timestamp: string;
|
|
2301
|
+
/** @description The path of the request */
|
|
2302
|
+
path: string;
|
|
2303
|
+
};
|
|
2304
|
+
};
|
|
2305
|
+
};
|
|
2306
|
+
/** @description Default Response */
|
|
2307
|
+
500: {
|
|
2308
|
+
headers: {
|
|
2309
|
+
[name: string]: unknown;
|
|
2310
|
+
};
|
|
2311
|
+
content: {
|
|
2312
|
+
"application/json": {
|
|
2313
|
+
/** @description HTTP status code */
|
|
2314
|
+
statusCode: number;
|
|
2315
|
+
error: {
|
|
2316
|
+
/**
|
|
2317
|
+
* @description The error code
|
|
2318
|
+
* @enum {string}
|
|
2319
|
+
*/
|
|
2320
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
2321
|
+
/** @description The error message */
|
|
2322
|
+
message: string;
|
|
2323
|
+
/** @description A suggestion to resolve the error */
|
|
2324
|
+
suggestion: string;
|
|
2325
|
+
/** @description A URL to the documentation */
|
|
2326
|
+
documentationUrl: string;
|
|
2327
|
+
};
|
|
2328
|
+
/** @description The unique identifier of the request */
|
|
2329
|
+
requestId: string;
|
|
2330
|
+
/** @description The timestamp of the response */
|
|
2331
|
+
timestamp: string;
|
|
2332
|
+
/** @description The path of the request */
|
|
2333
|
+
path: string;
|
|
2334
|
+
};
|
|
2335
|
+
};
|
|
2336
|
+
};
|
|
2337
|
+
};
|
|
2338
|
+
};
|
|
2339
|
+
delete?: never;
|
|
2340
|
+
options?: never;
|
|
2341
|
+
head?: never;
|
|
2342
|
+
patch?: never;
|
|
2343
|
+
trace?: never;
|
|
2344
|
+
};
|
|
2345
|
+
"/public/envelope/send": {
|
|
2346
|
+
parameters: {
|
|
2347
|
+
query?: never;
|
|
2348
|
+
header?: never;
|
|
2349
|
+
path?: never;
|
|
2350
|
+
cookie?: never;
|
|
2351
|
+
};
|
|
2352
|
+
get?: never;
|
|
2353
|
+
put?: never;
|
|
2354
|
+
/**
|
|
2355
|
+
* send
|
|
2356
|
+
* @description Send an envelope to its recipient
|
|
2357
|
+
*/
|
|
2358
|
+
post: {
|
|
2359
|
+
parameters: {
|
|
2360
|
+
query?: never;
|
|
2361
|
+
header?: never;
|
|
2362
|
+
path?: never;
|
|
2363
|
+
cookie?: never;
|
|
2364
|
+
};
|
|
2365
|
+
requestBody: {
|
|
2366
|
+
content: {
|
|
2367
|
+
"application/json": {
|
|
2368
|
+
/** @description The UUID of the workspace to send the envelope from. */
|
|
2369
|
+
workspaceUuid: string;
|
|
2370
|
+
/** @description The UUID of the envelope to send. */
|
|
2371
|
+
envelopeUuid: string;
|
|
2372
|
+
/** @description Whether to use the user's name or by default the company name as the sender name. */
|
|
2373
|
+
useUserAsSenderName?: boolean;
|
|
2374
|
+
/** @description Custom message to include in the invitation email */
|
|
2375
|
+
customInvitationMessage?: string;
|
|
2376
|
+
};
|
|
2377
|
+
};
|
|
2378
|
+
};
|
|
2379
|
+
responses: {
|
|
2380
|
+
/** @description Default Response */
|
|
2381
|
+
200: {
|
|
2382
|
+
headers: {
|
|
2383
|
+
[name: string]: unknown;
|
|
2384
|
+
};
|
|
2385
|
+
content: {
|
|
2386
|
+
"application/json": Record<string, never>;
|
|
2387
|
+
};
|
|
2388
|
+
};
|
|
2389
|
+
/** @description Default Response */
|
|
2390
|
+
400: {
|
|
2391
|
+
headers: {
|
|
2392
|
+
[name: string]: unknown;
|
|
2393
|
+
};
|
|
2394
|
+
content: {
|
|
2395
|
+
"application/json": {
|
|
2396
|
+
/** @description HTTP status code */
|
|
2397
|
+
statusCode: number;
|
|
2398
|
+
error: {
|
|
2399
|
+
/**
|
|
2400
|
+
* @description The error code
|
|
2401
|
+
* @enum {string}
|
|
2402
|
+
*/
|
|
2403
|
+
code: "WORKSPACE_NOT_FOUND" | "ENVELOPE_NOT_FOUND" | "NO_RECIPIENTS" | "ENVELOPE_NOT_IN_DRAFT" | "SUBSCRIPTION_NOT_FOUND" | "SES_LIMIT_EXCEEDED" | "API_CREDITS_LIMIT_EXCEEDED" | "INVALID_REQUEST_FORMAT";
|
|
2404
|
+
/** @description The error message */
|
|
2405
|
+
message: string;
|
|
2406
|
+
/** @description A suggestion to resolve the error */
|
|
2407
|
+
suggestion: string;
|
|
2408
|
+
/** @description A URL to the documentation */
|
|
2409
|
+
documentationUrl: string;
|
|
2410
|
+
};
|
|
2411
|
+
/** @description The unique identifier of the request */
|
|
2412
|
+
requestId: string;
|
|
2413
|
+
/** @description The timestamp of the response */
|
|
2414
|
+
timestamp: string;
|
|
2415
|
+
/** @description The path of the request */
|
|
2416
|
+
path: string;
|
|
2417
|
+
};
|
|
2418
|
+
};
|
|
2419
|
+
};
|
|
2420
|
+
/** @description Default Response */
|
|
2421
|
+
401: {
|
|
2422
|
+
headers: {
|
|
2423
|
+
[name: string]: unknown;
|
|
2424
|
+
};
|
|
2425
|
+
content: {
|
|
2426
|
+
"application/json": {
|
|
2427
|
+
/** @description HTTP status code */
|
|
2428
|
+
statusCode: number;
|
|
2429
|
+
error: {
|
|
2430
|
+
/**
|
|
2431
|
+
* @description The error code
|
|
2432
|
+
* @enum {string}
|
|
2433
|
+
*/
|
|
2434
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
2435
|
+
/** @description The error message */
|
|
2436
|
+
message: string;
|
|
2437
|
+
/** @description A suggestion to resolve the error */
|
|
2438
|
+
suggestion: string;
|
|
2439
|
+
/** @description A URL to the documentation */
|
|
2440
|
+
documentationUrl: string;
|
|
2441
|
+
};
|
|
2442
|
+
/** @description The unique identifier of the request */
|
|
2443
|
+
requestId: string;
|
|
2444
|
+
/** @description The timestamp of the response */
|
|
2445
|
+
timestamp: string;
|
|
2446
|
+
/** @description The path of the request */
|
|
2447
|
+
path: string;
|
|
2448
|
+
};
|
|
2449
|
+
};
|
|
2450
|
+
};
|
|
2451
|
+
/** @description Default Response */
|
|
2452
|
+
403: {
|
|
2453
|
+
headers: {
|
|
2454
|
+
[name: string]: unknown;
|
|
2455
|
+
};
|
|
2456
|
+
content: {
|
|
2457
|
+
"application/json": {
|
|
2458
|
+
/** @description HTTP status code */
|
|
2459
|
+
statusCode: number;
|
|
2460
|
+
error: {
|
|
2461
|
+
/**
|
|
2462
|
+
* @description The error code
|
|
2463
|
+
* @enum {string}
|
|
2464
|
+
*/
|
|
2465
|
+
code: "AUTHORIZATION_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
2466
|
+
/** @description The error message */
|
|
2467
|
+
message: string;
|
|
2468
|
+
/** @description A suggestion to resolve the error */
|
|
2469
|
+
suggestion: string;
|
|
2470
|
+
/** @description A URL to the documentation */
|
|
2471
|
+
documentationUrl: string;
|
|
2472
|
+
};
|
|
2473
|
+
/** @description The unique identifier of the request */
|
|
2474
|
+
requestId: string;
|
|
2475
|
+
/** @description The timestamp of the response */
|
|
2476
|
+
timestamp: string;
|
|
2477
|
+
/** @description The path of the request */
|
|
2478
|
+
path: string;
|
|
2479
|
+
};
|
|
2480
|
+
};
|
|
2481
|
+
};
|
|
2482
|
+
/** @description Default Response */
|
|
2483
|
+
500: {
|
|
2484
|
+
headers: {
|
|
2485
|
+
[name: string]: unknown;
|
|
2486
|
+
};
|
|
2487
|
+
content: {
|
|
2488
|
+
"application/json": {
|
|
2489
|
+
/** @description HTTP status code */
|
|
2490
|
+
statusCode: number;
|
|
2491
|
+
error: {
|
|
2492
|
+
/**
|
|
2493
|
+
* @description The error code
|
|
2494
|
+
* @enum {string}
|
|
2495
|
+
*/
|
|
2496
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
2497
|
+
/** @description The error message */
|
|
2498
|
+
message: string;
|
|
2499
|
+
/** @description A suggestion to resolve the error */
|
|
2500
|
+
suggestion: string;
|
|
2501
|
+
/** @description A URL to the documentation */
|
|
2502
|
+
documentationUrl: string;
|
|
2503
|
+
};
|
|
2504
|
+
/** @description The unique identifier of the request */
|
|
2505
|
+
requestId: string;
|
|
2506
|
+
/** @description The timestamp of the response */
|
|
2507
|
+
timestamp: string;
|
|
2508
|
+
/** @description The path of the request */
|
|
2509
|
+
path: string;
|
|
2510
|
+
};
|
|
2511
|
+
};
|
|
2512
|
+
};
|
|
2513
|
+
};
|
|
2514
|
+
};
|
|
2515
|
+
delete?: never;
|
|
2516
|
+
options?: never;
|
|
2517
|
+
head?: never;
|
|
2518
|
+
patch?: never;
|
|
2519
|
+
trace?: never;
|
|
2520
|
+
};
|
|
2521
|
+
"/public/envelope/sign": {
|
|
2522
|
+
parameters: {
|
|
2523
|
+
query?: never;
|
|
2524
|
+
header?: never;
|
|
2525
|
+
path?: never;
|
|
2526
|
+
cookie?: never;
|
|
2527
|
+
};
|
|
2528
|
+
get?: never;
|
|
2529
|
+
put?: never;
|
|
2530
|
+
/**
|
|
2531
|
+
* sign
|
|
2532
|
+
* @description Sign a document in an envelope as a recipient.
|
|
2533
|
+
*/
|
|
2534
|
+
post: {
|
|
2535
|
+
parameters: {
|
|
2536
|
+
query?: never;
|
|
2537
|
+
header?: never;
|
|
2538
|
+
path?: never;
|
|
2539
|
+
cookie?: never;
|
|
2540
|
+
};
|
|
2541
|
+
requestBody: {
|
|
2542
|
+
content: {
|
|
2543
|
+
"application/json": {
|
|
2544
|
+
/** @description The UUID of the workspace containing the envelope. */
|
|
2545
|
+
workspaceUuid: string;
|
|
2546
|
+
/** @description The UUID of the envelope containing the document to sign. */
|
|
2547
|
+
envelopeUuid: string;
|
|
2548
|
+
/**
|
|
2549
|
+
* Format: email
|
|
2550
|
+
* @description The email of the recipient who is signing.
|
|
2551
|
+
*/
|
|
2552
|
+
recipientEmail: string;
|
|
2553
|
+
/** @description Base64 encoded signature image to be merged with the watermark. */
|
|
2554
|
+
signatureImage?: string;
|
|
2555
|
+
};
|
|
2556
|
+
};
|
|
2557
|
+
};
|
|
2558
|
+
responses: {
|
|
2559
|
+
/** @description Default Response */
|
|
2560
|
+
200: {
|
|
2561
|
+
headers: {
|
|
2562
|
+
[name: string]: unknown;
|
|
2563
|
+
};
|
|
2564
|
+
content: {
|
|
2565
|
+
"application/json": {
|
|
2566
|
+
/** @description Whether the document was successfully signed. */
|
|
2567
|
+
success: boolean;
|
|
2568
|
+
/** @description The UUID of the signed document. */
|
|
2569
|
+
documentUuid: string;
|
|
2570
|
+
/** @description The version number of the signed document revision. */
|
|
2571
|
+
revisionVersion: number;
|
|
2572
|
+
};
|
|
2573
|
+
};
|
|
2574
|
+
};
|
|
2575
|
+
/** @description Default Response */
|
|
2576
|
+
400: {
|
|
2577
|
+
headers: {
|
|
2578
|
+
[name: string]: unknown;
|
|
2579
|
+
};
|
|
2580
|
+
content: {
|
|
2581
|
+
"application/json": {
|
|
2582
|
+
/** @description HTTP status code */
|
|
2583
|
+
statusCode: number;
|
|
2584
|
+
error: {
|
|
2585
|
+
/**
|
|
2586
|
+
* @description The error code
|
|
2587
|
+
* @enum {string}
|
|
2588
|
+
*/
|
|
2589
|
+
code: "WORKSPACE_NOT_FOUND" | "INVALID_TOKEN" | "ENVELOPE_INVITATION_EXPIRED" | "ENVELOPE_INVITATION_NOT_PENDING" | "ENVELOPE_NOT_FOUND" | "DOCUMENT_NOT_FOUND" | "DOCUMENT_REVISION_NOT_FOUND" | "ENVELOPE_ALREADY_SIGNED" | "INVALID_REQUEST_FORMAT";
|
|
2590
|
+
/** @description The error message */
|
|
2591
|
+
message: string;
|
|
2592
|
+
/** @description A suggestion to resolve the error */
|
|
2593
|
+
suggestion: string;
|
|
2594
|
+
/** @description A URL to the documentation */
|
|
2595
|
+
documentationUrl: string;
|
|
2596
|
+
};
|
|
2597
|
+
/** @description The unique identifier of the request */
|
|
2598
|
+
requestId: string;
|
|
2599
|
+
/** @description The timestamp of the response */
|
|
2600
|
+
timestamp: string;
|
|
2601
|
+
/** @description The path of the request */
|
|
2602
|
+
path: string;
|
|
2603
|
+
};
|
|
2604
|
+
};
|
|
2605
|
+
};
|
|
2606
|
+
/** @description Default Response */
|
|
2607
|
+
401: {
|
|
2608
|
+
headers: {
|
|
2609
|
+
[name: string]: unknown;
|
|
2610
|
+
};
|
|
2611
|
+
content: {
|
|
2612
|
+
"application/json": {
|
|
2613
|
+
/** @description HTTP status code */
|
|
2614
|
+
statusCode: number;
|
|
2615
|
+
error: {
|
|
2616
|
+
/**
|
|
2617
|
+
* @description The error code
|
|
2618
|
+
* @enum {string}
|
|
2619
|
+
*/
|
|
2620
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
2621
|
+
/** @description The error message */
|
|
2622
|
+
message: string;
|
|
2623
|
+
/** @description A suggestion to resolve the error */
|
|
2624
|
+
suggestion: string;
|
|
2625
|
+
/** @description A URL to the documentation */
|
|
2626
|
+
documentationUrl: string;
|
|
2627
|
+
};
|
|
2628
|
+
/** @description The unique identifier of the request */
|
|
2629
|
+
requestId: string;
|
|
2630
|
+
/** @description The timestamp of the response */
|
|
2631
|
+
timestamp: string;
|
|
2632
|
+
/** @description The path of the request */
|
|
2633
|
+
path: string;
|
|
2634
|
+
};
|
|
2635
|
+
};
|
|
2636
|
+
};
|
|
2637
|
+
/** @description Default Response */
|
|
2638
|
+
403: {
|
|
2639
|
+
headers: {
|
|
2640
|
+
[name: string]: unknown;
|
|
2641
|
+
};
|
|
2642
|
+
content: {
|
|
2643
|
+
"application/json": {
|
|
2644
|
+
/** @description HTTP status code */
|
|
2645
|
+
statusCode: number;
|
|
2646
|
+
error: {
|
|
2647
|
+
/**
|
|
2648
|
+
* @description The error code
|
|
2649
|
+
* @enum {string}
|
|
2650
|
+
*/
|
|
2651
|
+
code: "AUTHORIZATION_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
2652
|
+
/** @description The error message */
|
|
2653
|
+
message: string;
|
|
2654
|
+
/** @description A suggestion to resolve the error */
|
|
2655
|
+
suggestion: string;
|
|
2656
|
+
/** @description A URL to the documentation */
|
|
2657
|
+
documentationUrl: string;
|
|
2658
|
+
};
|
|
2659
|
+
/** @description The unique identifier of the request */
|
|
2660
|
+
requestId: string;
|
|
2661
|
+
/** @description The timestamp of the response */
|
|
2662
|
+
timestamp: string;
|
|
2663
|
+
/** @description The path of the request */
|
|
2664
|
+
path: string;
|
|
2665
|
+
};
|
|
2666
|
+
};
|
|
2667
|
+
};
|
|
2668
|
+
/** @description Default Response */
|
|
2669
|
+
500: {
|
|
2670
|
+
headers: {
|
|
2671
|
+
[name: string]: unknown;
|
|
2672
|
+
};
|
|
2673
|
+
content: {
|
|
2674
|
+
"application/json": {
|
|
2675
|
+
/** @description HTTP status code */
|
|
2676
|
+
statusCode: number;
|
|
2677
|
+
error: {
|
|
2678
|
+
/**
|
|
2679
|
+
* @description The error code
|
|
2680
|
+
* @enum {string}
|
|
2681
|
+
*/
|
|
2682
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
2683
|
+
/** @description The error message */
|
|
2684
|
+
message: string;
|
|
2685
|
+
/** @description A suggestion to resolve the error */
|
|
2686
|
+
suggestion: string;
|
|
2687
|
+
/** @description A URL to the documentation */
|
|
2688
|
+
documentationUrl: string;
|
|
2689
|
+
};
|
|
2690
|
+
/** @description The unique identifier of the request */
|
|
2691
|
+
requestId: string;
|
|
2692
|
+
/** @description The timestamp of the response */
|
|
2693
|
+
timestamp: string;
|
|
2694
|
+
/** @description The path of the request */
|
|
2695
|
+
path: string;
|
|
2696
|
+
};
|
|
2697
|
+
};
|
|
2698
|
+
};
|
|
2699
|
+
};
|
|
2700
|
+
};
|
|
2701
|
+
delete?: never;
|
|
2702
|
+
options?: never;
|
|
2703
|
+
head?: never;
|
|
2704
|
+
patch?: never;
|
|
2705
|
+
trace?: never;
|
|
2706
|
+
};
|
|
2707
|
+
"/public/envelope/complete-document-upload": {
|
|
2708
|
+
parameters: {
|
|
2709
|
+
query?: never;
|
|
2710
|
+
header?: never;
|
|
2711
|
+
path?: never;
|
|
2712
|
+
cookie?: never;
|
|
2713
|
+
};
|
|
2714
|
+
get?: never;
|
|
2715
|
+
put?: never;
|
|
2716
|
+
/**
|
|
2717
|
+
* complete-document-upload
|
|
2718
|
+
* @description Verify uploaded document exists on S3, validate as PDF, generate a small preview image, and persist it.
|
|
2719
|
+
*/
|
|
2720
|
+
post: {
|
|
2721
|
+
parameters: {
|
|
2722
|
+
query?: never;
|
|
2723
|
+
header?: never;
|
|
2724
|
+
path?: never;
|
|
2725
|
+
cookie?: never;
|
|
2726
|
+
};
|
|
2727
|
+
requestBody: {
|
|
2728
|
+
content: {
|
|
2729
|
+
"application/json": {
|
|
2730
|
+
workspaceUuid: string;
|
|
2731
|
+
envelopeUuid: string;
|
|
2732
|
+
documentUuid: string;
|
|
2733
|
+
};
|
|
2734
|
+
};
|
|
2735
|
+
};
|
|
2736
|
+
responses: {
|
|
2737
|
+
/** @description Default Response */
|
|
2738
|
+
200: {
|
|
2739
|
+
headers: {
|
|
2740
|
+
[name: string]: unknown;
|
|
2741
|
+
};
|
|
2742
|
+
content: {
|
|
2743
|
+
"application/json": Record<string, never>;
|
|
2744
|
+
};
|
|
2745
|
+
};
|
|
2746
|
+
/** @description Default Response */
|
|
2747
|
+
400: {
|
|
2748
|
+
headers: {
|
|
2749
|
+
[name: string]: unknown;
|
|
2750
|
+
};
|
|
2751
|
+
content: {
|
|
2752
|
+
"application/json": {
|
|
2753
|
+
/** @description HTTP status code */
|
|
2754
|
+
statusCode: number;
|
|
2755
|
+
error: {
|
|
2756
|
+
/**
|
|
2757
|
+
* @description The error code
|
|
2758
|
+
* @enum {string}
|
|
2759
|
+
*/
|
|
2760
|
+
code: "WORKSPACE_NOT_FOUND" | "ENVELOPE_NOT_FOUND" | "DOCUMENT_NOT_FOUND" | "DOCUMENT_REVISION_NOT_FOUND" | "DOCUMENT_INVALID" | "DOCUMENT_PREVIEW_GENERATION_FAILED" | "INVALID_REQUEST_FORMAT";
|
|
2761
|
+
/** @description The error message */
|
|
2762
|
+
message: string;
|
|
2763
|
+
/** @description A suggestion to resolve the error */
|
|
2764
|
+
suggestion: string;
|
|
2765
|
+
/** @description A URL to the documentation */
|
|
2766
|
+
documentationUrl: string;
|
|
2767
|
+
};
|
|
2768
|
+
/** @description The unique identifier of the request */
|
|
2769
|
+
requestId: string;
|
|
2770
|
+
/** @description The timestamp of the response */
|
|
2771
|
+
timestamp: string;
|
|
2772
|
+
/** @description The path of the request */
|
|
2773
|
+
path: string;
|
|
2774
|
+
};
|
|
2775
|
+
};
|
|
2776
|
+
};
|
|
2777
|
+
/** @description Default Response */
|
|
2778
|
+
401: {
|
|
2779
|
+
headers: {
|
|
2780
|
+
[name: string]: unknown;
|
|
2781
|
+
};
|
|
2782
|
+
content: {
|
|
2783
|
+
"application/json": {
|
|
2784
|
+
/** @description HTTP status code */
|
|
2785
|
+
statusCode: number;
|
|
2786
|
+
error: {
|
|
2787
|
+
/**
|
|
2788
|
+
* @description The error code
|
|
2789
|
+
* @enum {string}
|
|
2790
|
+
*/
|
|
2791
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
2792
|
+
/** @description The error message */
|
|
2793
|
+
message: string;
|
|
2794
|
+
/** @description A suggestion to resolve the error */
|
|
2795
|
+
suggestion: string;
|
|
2796
|
+
/** @description A URL to the documentation */
|
|
2797
|
+
documentationUrl: string;
|
|
2798
|
+
};
|
|
2799
|
+
/** @description The unique identifier of the request */
|
|
2800
|
+
requestId: string;
|
|
2801
|
+
/** @description The timestamp of the response */
|
|
2802
|
+
timestamp: string;
|
|
2803
|
+
/** @description The path of the request */
|
|
2804
|
+
path: string;
|
|
2805
|
+
};
|
|
2806
|
+
};
|
|
2807
|
+
};
|
|
2808
|
+
/** @description Default Response */
|
|
2809
|
+
403: {
|
|
2810
|
+
headers: {
|
|
2811
|
+
[name: string]: unknown;
|
|
2812
|
+
};
|
|
2813
|
+
content: {
|
|
2814
|
+
"application/json": {
|
|
2815
|
+
/** @description HTTP status code */
|
|
2816
|
+
statusCode: number;
|
|
2817
|
+
error: {
|
|
2818
|
+
/**
|
|
2819
|
+
* @description The error code
|
|
2820
|
+
* @enum {string}
|
|
2821
|
+
*/
|
|
2822
|
+
code: "AUTHORIZATION_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
2823
|
+
/** @description The error message */
|
|
2824
|
+
message: string;
|
|
2825
|
+
/** @description A suggestion to resolve the error */
|
|
2826
|
+
suggestion: string;
|
|
2827
|
+
/** @description A URL to the documentation */
|
|
2828
|
+
documentationUrl: string;
|
|
2829
|
+
};
|
|
2830
|
+
/** @description The unique identifier of the request */
|
|
2831
|
+
requestId: string;
|
|
2832
|
+
/** @description The timestamp of the response */
|
|
2833
|
+
timestamp: string;
|
|
2834
|
+
/** @description The path of the request */
|
|
2835
|
+
path: string;
|
|
2836
|
+
};
|
|
2837
|
+
};
|
|
2838
|
+
};
|
|
2839
|
+
/** @description Default Response */
|
|
2840
|
+
500: {
|
|
2841
|
+
headers: {
|
|
2842
|
+
[name: string]: unknown;
|
|
2843
|
+
};
|
|
2844
|
+
content: {
|
|
2845
|
+
"application/json": {
|
|
2846
|
+
/** @description HTTP status code */
|
|
2847
|
+
statusCode: number;
|
|
2848
|
+
error: {
|
|
2849
|
+
/**
|
|
2850
|
+
* @description The error code
|
|
2851
|
+
* @enum {string}
|
|
2852
|
+
*/
|
|
2853
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
2854
|
+
/** @description The error message */
|
|
2855
|
+
message: string;
|
|
2856
|
+
/** @description A suggestion to resolve the error */
|
|
2857
|
+
suggestion: string;
|
|
2858
|
+
/** @description A URL to the documentation */
|
|
2859
|
+
documentationUrl: string;
|
|
2860
|
+
};
|
|
2861
|
+
/** @description The unique identifier of the request */
|
|
2862
|
+
requestId: string;
|
|
2863
|
+
/** @description The timestamp of the response */
|
|
2864
|
+
timestamp: string;
|
|
2865
|
+
/** @description The path of the request */
|
|
2866
|
+
path: string;
|
|
2867
|
+
};
|
|
2868
|
+
};
|
|
2869
|
+
};
|
|
2870
|
+
};
|
|
2871
|
+
};
|
|
2872
|
+
delete?: never;
|
|
2873
|
+
options?: never;
|
|
2874
|
+
head?: never;
|
|
2875
|
+
patch?: never;
|
|
2876
|
+
trace?: never;
|
|
2877
|
+
};
|
|
2878
|
+
"/public/envelope/get-document": {
|
|
2879
|
+
parameters: {
|
|
2880
|
+
query?: never;
|
|
2881
|
+
header?: never;
|
|
2882
|
+
path?: never;
|
|
2883
|
+
cookie?: never;
|
|
2884
|
+
};
|
|
2885
|
+
get?: never;
|
|
2886
|
+
put?: never;
|
|
2887
|
+
/**
|
|
2888
|
+
* get-document
|
|
2889
|
+
* @description Download the latest version of a document from an envelope.
|
|
2890
|
+
*/
|
|
2891
|
+
post: {
|
|
2892
|
+
parameters: {
|
|
2893
|
+
query?: never;
|
|
2894
|
+
header?: never;
|
|
2895
|
+
path?: never;
|
|
2896
|
+
cookie?: never;
|
|
2897
|
+
};
|
|
2898
|
+
requestBody: {
|
|
2899
|
+
content: {
|
|
2900
|
+
"application/json": {
|
|
2901
|
+
/** @description The UUID of the workspace to get the envelope from. */
|
|
2902
|
+
workspaceUuid: string;
|
|
2903
|
+
/** @description The UUID of the envelope to get the document from. */
|
|
2904
|
+
envelopeUuid: string;
|
|
2905
|
+
/** @description The UUID of the document to download. */
|
|
2906
|
+
documentUuid: string;
|
|
2907
|
+
};
|
|
2908
|
+
};
|
|
2909
|
+
};
|
|
2910
|
+
responses: {
|
|
2911
|
+
/** @description Default Response */
|
|
2912
|
+
200: {
|
|
2913
|
+
headers: {
|
|
2914
|
+
[name: string]: unknown;
|
|
2915
|
+
};
|
|
2916
|
+
content: {
|
|
2917
|
+
"application/octet-stream": unknown;
|
|
2918
|
+
};
|
|
2919
|
+
};
|
|
2920
|
+
/** @description Default Response */
|
|
2921
|
+
400: {
|
|
2922
|
+
headers: {
|
|
2923
|
+
[name: string]: unknown;
|
|
2924
|
+
};
|
|
2925
|
+
content: {
|
|
2926
|
+
"application/octet-stream": {
|
|
2927
|
+
/** @description HTTP status code */
|
|
2928
|
+
statusCode: number;
|
|
2929
|
+
error: {
|
|
2930
|
+
/**
|
|
2931
|
+
* @description The error code
|
|
2932
|
+
* @enum {string}
|
|
2933
|
+
*/
|
|
2934
|
+
code: "WORKSPACE_NOT_FOUND" | "ENVELOPE_NOT_FOUND" | "DOCUMENT_NOT_FOUND" | "DOCUMENT_REVISION_NOT_FOUND" | "DOCUMENT_CORRUPTED" | "INVALID_REQUEST_FORMAT";
|
|
2935
|
+
/** @description The error message */
|
|
2936
|
+
message: string;
|
|
2937
|
+
/** @description A suggestion to resolve the error */
|
|
2938
|
+
suggestion: string;
|
|
2939
|
+
/** @description A URL to the documentation */
|
|
2940
|
+
documentationUrl: string;
|
|
2941
|
+
};
|
|
2942
|
+
/** @description The unique identifier of the request */
|
|
2943
|
+
requestId: string;
|
|
2944
|
+
/** @description The timestamp of the response */
|
|
2945
|
+
timestamp: string;
|
|
2946
|
+
/** @description The path of the request */
|
|
2947
|
+
path: string;
|
|
2948
|
+
};
|
|
2949
|
+
};
|
|
2950
|
+
};
|
|
2951
|
+
/** @description Default Response */
|
|
2952
|
+
401: {
|
|
2953
|
+
headers: {
|
|
2954
|
+
[name: string]: unknown;
|
|
2955
|
+
};
|
|
2956
|
+
content: {
|
|
2957
|
+
"application/octet-stream": {
|
|
2958
|
+
/** @description HTTP status code */
|
|
2959
|
+
statusCode: number;
|
|
2960
|
+
error: {
|
|
2961
|
+
/**
|
|
2962
|
+
* @description The error code
|
|
2963
|
+
* @enum {string}
|
|
2964
|
+
*/
|
|
2965
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
2966
|
+
/** @description The error message */
|
|
2967
|
+
message: string;
|
|
2968
|
+
/** @description A suggestion to resolve the error */
|
|
2969
|
+
suggestion: string;
|
|
2970
|
+
/** @description A URL to the documentation */
|
|
2971
|
+
documentationUrl: string;
|
|
2972
|
+
};
|
|
2973
|
+
/** @description The unique identifier of the request */
|
|
2974
|
+
requestId: string;
|
|
2975
|
+
/** @description The timestamp of the response */
|
|
2976
|
+
timestamp: string;
|
|
2977
|
+
/** @description The path of the request */
|
|
2978
|
+
path: string;
|
|
2979
|
+
};
|
|
2980
|
+
};
|
|
2981
|
+
};
|
|
2982
|
+
/** @description Default Response */
|
|
2983
|
+
403: {
|
|
2984
|
+
headers: {
|
|
2985
|
+
[name: string]: unknown;
|
|
2986
|
+
};
|
|
2987
|
+
content: {
|
|
2988
|
+
"application/octet-stream": {
|
|
2989
|
+
/** @description HTTP status code */
|
|
2990
|
+
statusCode: number;
|
|
2991
|
+
error: {
|
|
2992
|
+
/**
|
|
2993
|
+
* @description The error code
|
|
2994
|
+
* @enum {string}
|
|
2995
|
+
*/
|
|
2996
|
+
code: "AUTHORIZATION_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
2997
|
+
/** @description The error message */
|
|
2998
|
+
message: string;
|
|
2999
|
+
/** @description A suggestion to resolve the error */
|
|
3000
|
+
suggestion: string;
|
|
3001
|
+
/** @description A URL to the documentation */
|
|
3002
|
+
documentationUrl: string;
|
|
3003
|
+
};
|
|
3004
|
+
/** @description The unique identifier of the request */
|
|
3005
|
+
requestId: string;
|
|
3006
|
+
/** @description The timestamp of the response */
|
|
3007
|
+
timestamp: string;
|
|
3008
|
+
/** @description The path of the request */
|
|
3009
|
+
path: string;
|
|
3010
|
+
};
|
|
3011
|
+
};
|
|
3012
|
+
};
|
|
3013
|
+
/** @description Default Response */
|
|
3014
|
+
500: {
|
|
3015
|
+
headers: {
|
|
3016
|
+
[name: string]: unknown;
|
|
3017
|
+
};
|
|
3018
|
+
content: {
|
|
3019
|
+
"application/octet-stream": {
|
|
3020
|
+
/** @description HTTP status code */
|
|
3021
|
+
statusCode: number;
|
|
3022
|
+
error: {
|
|
3023
|
+
/**
|
|
3024
|
+
* @description The error code
|
|
3025
|
+
* @enum {string}
|
|
3026
|
+
*/
|
|
3027
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
3028
|
+
/** @description The error message */
|
|
3029
|
+
message: string;
|
|
3030
|
+
/** @description A suggestion to resolve the error */
|
|
3031
|
+
suggestion: string;
|
|
3032
|
+
/** @description A URL to the documentation */
|
|
3033
|
+
documentationUrl: string;
|
|
3034
|
+
};
|
|
3035
|
+
/** @description The unique identifier of the request */
|
|
3036
|
+
requestId: string;
|
|
3037
|
+
/** @description The timestamp of the response */
|
|
3038
|
+
timestamp: string;
|
|
3039
|
+
/** @description The path of the request */
|
|
3040
|
+
path: string;
|
|
3041
|
+
};
|
|
3042
|
+
};
|
|
3043
|
+
};
|
|
3044
|
+
};
|
|
3045
|
+
};
|
|
3046
|
+
delete?: never;
|
|
3047
|
+
options?: never;
|
|
3048
|
+
head?: never;
|
|
3049
|
+
patch?: never;
|
|
3050
|
+
trace?: never;
|
|
3051
|
+
};
|
|
3052
|
+
"/public/envelope/get": {
|
|
3053
|
+
parameters: {
|
|
3054
|
+
query?: never;
|
|
3055
|
+
header?: never;
|
|
3056
|
+
path?: never;
|
|
3057
|
+
cookie?: never;
|
|
3058
|
+
};
|
|
3059
|
+
get?: never;
|
|
3060
|
+
put?: never;
|
|
3061
|
+
/**
|
|
3062
|
+
* get
|
|
3063
|
+
* @description Get an envelope by UUID. Returns envelope details, documents, and metrics.
|
|
3064
|
+
*/
|
|
3065
|
+
post: {
|
|
3066
|
+
parameters: {
|
|
3067
|
+
query?: never;
|
|
3068
|
+
header?: never;
|
|
3069
|
+
path?: never;
|
|
3070
|
+
cookie?: never;
|
|
3071
|
+
};
|
|
3072
|
+
requestBody: {
|
|
3073
|
+
content: {
|
|
3074
|
+
"application/json": {
|
|
3075
|
+
/** @description The UUID of the workspace to get the envelope from. */
|
|
3076
|
+
workspaceUuid: string;
|
|
3077
|
+
/** @description The UUID of the envelope to get. */
|
|
3078
|
+
envelopeUuid: string;
|
|
3079
|
+
};
|
|
3080
|
+
};
|
|
3081
|
+
};
|
|
3082
|
+
responses: {
|
|
3083
|
+
/** @description Default Response */
|
|
3084
|
+
200: {
|
|
3085
|
+
headers: {
|
|
3086
|
+
[name: string]: unknown;
|
|
3087
|
+
};
|
|
3088
|
+
content: {
|
|
3089
|
+
"application/json": {
|
|
3090
|
+
/** @description The unique identifier of the envelope. */
|
|
3091
|
+
uuid: string;
|
|
3092
|
+
/** @description The title of the envelope. */
|
|
3093
|
+
title: string;
|
|
3094
|
+
/**
|
|
3095
|
+
* @description The status of the envelope.
|
|
3096
|
+
* @enum {string}
|
|
3097
|
+
*/
|
|
3098
|
+
status: "uploading" | "draft" | "approving" | "signing" | "complete" | "declined" | "canceled";
|
|
3099
|
+
/** @description The date and time the envelope was created (unix timestamp). */
|
|
3100
|
+
creationDate: number;
|
|
3101
|
+
/** @description The date and time the envelope was last updated (unix timestamp). */
|
|
3102
|
+
updateDate: number;
|
|
3103
|
+
/** @description The date and time the envelope was sent (unix timestamp). */
|
|
3104
|
+
sentDate: number | null;
|
|
3105
|
+
/** @description The creator of the envelope. */
|
|
3106
|
+
owner: {
|
|
3107
|
+
/** @description The unique identifier of the owner. */
|
|
3108
|
+
uuid: string;
|
|
3109
|
+
/** @description The email of the owner. */
|
|
3110
|
+
email: string;
|
|
3111
|
+
/** @description The first name of the owner. */
|
|
3112
|
+
firstname?: string | null;
|
|
3113
|
+
/** @description The last name of the owner. */
|
|
3114
|
+
lastname?: string | null;
|
|
3115
|
+
};
|
|
3116
|
+
/** @description Information about the sender of the envelope. */
|
|
3117
|
+
sender: {
|
|
3118
|
+
/** @description The email address of the sender. */
|
|
3119
|
+
email: string;
|
|
3120
|
+
/** @description The display name of the sender. */
|
|
3121
|
+
name: string;
|
|
3122
|
+
};
|
|
3123
|
+
/** @description The list of documents in the envelope. */
|
|
3124
|
+
documents: {
|
|
3125
|
+
/** @description The unique identifier of the document. */
|
|
3126
|
+
uuid: string;
|
|
3127
|
+
/** @description The title of the document. */
|
|
3128
|
+
title: string;
|
|
3129
|
+
/** @description The blocks content of the document organized by page number. */
|
|
3130
|
+
blocks: {
|
|
3131
|
+
[key: string]: ({
|
|
3132
|
+
uuid: string;
|
|
3133
|
+
label: string;
|
|
3134
|
+
/** @enum {string} */
|
|
3135
|
+
labelIcon?: "at" | "text-t" | "image" | "signature" | "user";
|
|
3136
|
+
x: number;
|
|
3137
|
+
y: number;
|
|
3138
|
+
height?: number;
|
|
3139
|
+
width?: number;
|
|
3140
|
+
exportable: boolean;
|
|
3141
|
+
recipientEmail?: string;
|
|
3142
|
+
exported?: boolean;
|
|
3143
|
+
/** @enum {string} */
|
|
3144
|
+
color?: "primary" | "info" | "auxiliary" | "success" | "warning" | "danger";
|
|
3145
|
+
recipientLabel?: string;
|
|
3146
|
+
/** @enum {string} */
|
|
3147
|
+
type: "text";
|
|
3148
|
+
text: string;
|
|
3149
|
+
/** @enum {string} */
|
|
3150
|
+
templatedText?: "email" | "fullname" | "phone";
|
|
3151
|
+
editable?: boolean;
|
|
3152
|
+
} | {
|
|
3153
|
+
uuid: string;
|
|
3154
|
+
label: string;
|
|
3155
|
+
/** @enum {string} */
|
|
3156
|
+
labelIcon?: "at" | "text-t" | "image" | "signature" | "user";
|
|
3157
|
+
x: number;
|
|
3158
|
+
y: number;
|
|
3159
|
+
height?: number;
|
|
3160
|
+
width?: number;
|
|
3161
|
+
exportable: boolean;
|
|
3162
|
+
recipientEmail?: string;
|
|
3163
|
+
exported?: boolean;
|
|
3164
|
+
/** @enum {string} */
|
|
3165
|
+
color?: "primary" | "info" | "auxiliary" | "success" | "warning" | "danger";
|
|
3166
|
+
recipientLabel?: string;
|
|
3167
|
+
/** @enum {string} */
|
|
3168
|
+
type: "image";
|
|
3169
|
+
src: string;
|
|
3170
|
+
fileType: string;
|
|
3171
|
+
} | {
|
|
3172
|
+
uuid: string;
|
|
3173
|
+
label: string;
|
|
3174
|
+
/** @enum {string} */
|
|
3175
|
+
labelIcon?: "at" | "text-t" | "image" | "signature" | "user";
|
|
3176
|
+
x: number;
|
|
3177
|
+
y: number;
|
|
3178
|
+
height?: number;
|
|
3179
|
+
width?: number;
|
|
3180
|
+
exportable: boolean;
|
|
3181
|
+
recipientEmail?: string;
|
|
3182
|
+
exported?: boolean;
|
|
3183
|
+
/** @enum {string} */
|
|
3184
|
+
color?: "primary" | "info" | "auxiliary" | "success" | "warning" | "danger";
|
|
3185
|
+
recipientLabel?: string;
|
|
3186
|
+
/** @enum {string} */
|
|
3187
|
+
type: "signature";
|
|
3188
|
+
})[];
|
|
3189
|
+
};
|
|
3190
|
+
/** @description The date and time the document snapshot was last updated (unix timestamp). */
|
|
3191
|
+
snapshotDate?: number;
|
|
3192
|
+
/** @description Whether signatures are placed on a separate page from the document content. */
|
|
3193
|
+
signaturesOnSeparatePage: boolean;
|
|
3194
|
+
/** @description Whether initials are required on all pages of the document. */
|
|
3195
|
+
initialsOnAllPages: boolean;
|
|
3196
|
+
/** @description The number of pages in the document. */
|
|
3197
|
+
pageCount: number;
|
|
3198
|
+
}[];
|
|
3199
|
+
/** @description The tags of the envelope. */
|
|
3200
|
+
tags: string[];
|
|
3201
|
+
metrics: {
|
|
3202
|
+
/** @description The number of signatures on the envelope. */
|
|
3203
|
+
signatureCount: number;
|
|
3204
|
+
/** @description The number of signatures required on the envelope. */
|
|
3205
|
+
signatureRequiredCount: number;
|
|
3206
|
+
/** @description The number of approvals on the envelope. */
|
|
3207
|
+
approvalCount: number;
|
|
3208
|
+
/** @description The number of approvals required on the envelope. */
|
|
3209
|
+
approvalRequiredCount: number;
|
|
3210
|
+
};
|
|
3211
|
+
};
|
|
3212
|
+
};
|
|
3213
|
+
};
|
|
3214
|
+
/** @description Default Response */
|
|
3215
|
+
400: {
|
|
3216
|
+
headers: {
|
|
3217
|
+
[name: string]: unknown;
|
|
3218
|
+
};
|
|
3219
|
+
content: {
|
|
3220
|
+
"application/json": {
|
|
3221
|
+
/** @description HTTP status code */
|
|
3222
|
+
statusCode: number;
|
|
3223
|
+
error: {
|
|
3224
|
+
/**
|
|
3225
|
+
* @description The error code
|
|
3226
|
+
* @enum {string}
|
|
3227
|
+
*/
|
|
3228
|
+
code: "WORKSPACE_NOT_FOUND" | "ENVELOPE_NOT_FOUND" | "INVALID_REQUEST_FORMAT";
|
|
3229
|
+
/** @description The error message */
|
|
3230
|
+
message: string;
|
|
3231
|
+
/** @description A suggestion to resolve the error */
|
|
3232
|
+
suggestion: string;
|
|
3233
|
+
/** @description A URL to the documentation */
|
|
3234
|
+
documentationUrl: string;
|
|
3235
|
+
};
|
|
3236
|
+
/** @description The unique identifier of the request */
|
|
3237
|
+
requestId: string;
|
|
3238
|
+
/** @description The timestamp of the response */
|
|
3239
|
+
timestamp: string;
|
|
3240
|
+
/** @description The path of the request */
|
|
3241
|
+
path: string;
|
|
3242
|
+
};
|
|
3243
|
+
};
|
|
3244
|
+
};
|
|
3245
|
+
/** @description Default Response */
|
|
3246
|
+
401: {
|
|
3247
|
+
headers: {
|
|
3248
|
+
[name: string]: unknown;
|
|
3249
|
+
};
|
|
3250
|
+
content: {
|
|
3251
|
+
"application/json": {
|
|
3252
|
+
/** @description HTTP status code */
|
|
3253
|
+
statusCode: number;
|
|
3254
|
+
error: {
|
|
3255
|
+
/**
|
|
3256
|
+
* @description The error code
|
|
3257
|
+
* @enum {string}
|
|
3258
|
+
*/
|
|
3259
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
3260
|
+
/** @description The error message */
|
|
3261
|
+
message: string;
|
|
3262
|
+
/** @description A suggestion to resolve the error */
|
|
3263
|
+
suggestion: string;
|
|
3264
|
+
/** @description A URL to the documentation */
|
|
3265
|
+
documentationUrl: string;
|
|
3266
|
+
};
|
|
3267
|
+
/** @description The unique identifier of the request */
|
|
3268
|
+
requestId: string;
|
|
3269
|
+
/** @description The timestamp of the response */
|
|
3270
|
+
timestamp: string;
|
|
3271
|
+
/** @description The path of the request */
|
|
3272
|
+
path: string;
|
|
3273
|
+
};
|
|
3274
|
+
};
|
|
3275
|
+
};
|
|
3276
|
+
/** @description Default Response */
|
|
3277
|
+
403: {
|
|
3278
|
+
headers: {
|
|
3279
|
+
[name: string]: unknown;
|
|
3280
|
+
};
|
|
3281
|
+
content: {
|
|
3282
|
+
"application/json": {
|
|
3283
|
+
/** @description HTTP status code */
|
|
3284
|
+
statusCode: number;
|
|
3285
|
+
error: {
|
|
3286
|
+
/**
|
|
3287
|
+
* @description The error code
|
|
3288
|
+
* @enum {string}
|
|
3289
|
+
*/
|
|
3290
|
+
code: "AUTHORIZATION_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
3291
|
+
/** @description The error message */
|
|
3292
|
+
message: string;
|
|
3293
|
+
/** @description A suggestion to resolve the error */
|
|
3294
|
+
suggestion: string;
|
|
3295
|
+
/** @description A URL to the documentation */
|
|
3296
|
+
documentationUrl: string;
|
|
3297
|
+
};
|
|
3298
|
+
/** @description The unique identifier of the request */
|
|
3299
|
+
requestId: string;
|
|
3300
|
+
/** @description The timestamp of the response */
|
|
3301
|
+
timestamp: string;
|
|
3302
|
+
/** @description The path of the request */
|
|
3303
|
+
path: string;
|
|
3304
|
+
};
|
|
3305
|
+
};
|
|
3306
|
+
};
|
|
3307
|
+
/** @description Default Response */
|
|
3308
|
+
500: {
|
|
3309
|
+
headers: {
|
|
3310
|
+
[name: string]: unknown;
|
|
3311
|
+
};
|
|
3312
|
+
content: {
|
|
3313
|
+
"application/json": {
|
|
3314
|
+
/** @description HTTP status code */
|
|
3315
|
+
statusCode: number;
|
|
3316
|
+
error: {
|
|
3317
|
+
/**
|
|
3318
|
+
* @description The error code
|
|
3319
|
+
* @enum {string}
|
|
3320
|
+
*/
|
|
3321
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
3322
|
+
/** @description The error message */
|
|
3323
|
+
message: string;
|
|
3324
|
+
/** @description A suggestion to resolve the error */
|
|
3325
|
+
suggestion: string;
|
|
3326
|
+
/** @description A URL to the documentation */
|
|
3327
|
+
documentationUrl: string;
|
|
3328
|
+
};
|
|
3329
|
+
/** @description The unique identifier of the request */
|
|
3330
|
+
requestId: string;
|
|
3331
|
+
/** @description The timestamp of the response */
|
|
3332
|
+
timestamp: string;
|
|
3333
|
+
/** @description The path of the request */
|
|
3334
|
+
path: string;
|
|
3335
|
+
};
|
|
3336
|
+
};
|
|
3337
|
+
};
|
|
3338
|
+
};
|
|
3339
|
+
};
|
|
3340
|
+
delete?: never;
|
|
3341
|
+
options?: never;
|
|
3342
|
+
head?: never;
|
|
3343
|
+
patch?: never;
|
|
3344
|
+
trace?: never;
|
|
3345
|
+
};
|
|
3346
|
+
"/public/envelope/get-proof": {
|
|
3347
|
+
parameters: {
|
|
3348
|
+
query?: never;
|
|
3349
|
+
header?: never;
|
|
3350
|
+
path?: never;
|
|
3351
|
+
cookie?: never;
|
|
3352
|
+
};
|
|
3353
|
+
get?: never;
|
|
3354
|
+
put?: never;
|
|
3355
|
+
/**
|
|
3356
|
+
* get-proof
|
|
3357
|
+
* @description Download the proof document for a completed envelope.
|
|
3358
|
+
*/
|
|
3359
|
+
post: {
|
|
3360
|
+
parameters: {
|
|
3361
|
+
query?: never;
|
|
3362
|
+
header?: never;
|
|
3363
|
+
path?: never;
|
|
3364
|
+
cookie?: never;
|
|
3365
|
+
};
|
|
3366
|
+
requestBody: {
|
|
3367
|
+
content: {
|
|
3368
|
+
"application/json": {
|
|
3369
|
+
/** @description The UUID of the workspace to get the envelope from. */
|
|
3370
|
+
workspaceUuid: string;
|
|
3371
|
+
/** @description The UUID of the envelope to get the proof document from. */
|
|
3372
|
+
envelopeUuid: string;
|
|
3373
|
+
};
|
|
3374
|
+
};
|
|
3375
|
+
};
|
|
3376
|
+
responses: {
|
|
3377
|
+
/** @description Default Response */
|
|
3378
|
+
200: {
|
|
3379
|
+
headers: {
|
|
3380
|
+
[name: string]: unknown;
|
|
3381
|
+
};
|
|
3382
|
+
content: {
|
|
3383
|
+
"application/octet-stream": unknown;
|
|
3384
|
+
};
|
|
3385
|
+
};
|
|
3386
|
+
/** @description Default Response */
|
|
3387
|
+
400: {
|
|
3388
|
+
headers: {
|
|
3389
|
+
[name: string]: unknown;
|
|
3390
|
+
};
|
|
3391
|
+
content: {
|
|
3392
|
+
"application/octet-stream": {
|
|
3393
|
+
/** @description HTTP status code */
|
|
3394
|
+
statusCode: number;
|
|
3395
|
+
error: {
|
|
3396
|
+
/**
|
|
3397
|
+
* @description The error code
|
|
3398
|
+
* @enum {string}
|
|
3399
|
+
*/
|
|
3400
|
+
code: "WORKSPACE_NOT_FOUND" | "ENVELOPE_NOT_FOUND" | "ENVELOPE_NOT_COMPLETED" | "PROOF_DOCUMENT_NOT_FOUND" | "PROOF_DOCUMENT_CORRUPTED" | "INVALID_REQUEST_FORMAT";
|
|
3401
|
+
/** @description The error message */
|
|
3402
|
+
message: string;
|
|
3403
|
+
/** @description A suggestion to resolve the error */
|
|
3404
|
+
suggestion: string;
|
|
3405
|
+
/** @description A URL to the documentation */
|
|
3406
|
+
documentationUrl: string;
|
|
3407
|
+
};
|
|
3408
|
+
/** @description The unique identifier of the request */
|
|
3409
|
+
requestId: string;
|
|
3410
|
+
/** @description The timestamp of the response */
|
|
3411
|
+
timestamp: string;
|
|
3412
|
+
/** @description The path of the request */
|
|
3413
|
+
path: string;
|
|
3414
|
+
};
|
|
3415
|
+
};
|
|
3416
|
+
};
|
|
3417
|
+
/** @description Default Response */
|
|
3418
|
+
401: {
|
|
3419
|
+
headers: {
|
|
3420
|
+
[name: string]: unknown;
|
|
3421
|
+
};
|
|
3422
|
+
content: {
|
|
3423
|
+
"application/octet-stream": {
|
|
3424
|
+
/** @description HTTP status code */
|
|
3425
|
+
statusCode: number;
|
|
3426
|
+
error: {
|
|
3427
|
+
/**
|
|
3428
|
+
* @description The error code
|
|
3429
|
+
* @enum {string}
|
|
3430
|
+
*/
|
|
3431
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
3432
|
+
/** @description The error message */
|
|
3433
|
+
message: string;
|
|
3434
|
+
/** @description A suggestion to resolve the error */
|
|
3435
|
+
suggestion: string;
|
|
3436
|
+
/** @description A URL to the documentation */
|
|
3437
|
+
documentationUrl: string;
|
|
3438
|
+
};
|
|
3439
|
+
/** @description The unique identifier of the request */
|
|
3440
|
+
requestId: string;
|
|
3441
|
+
/** @description The timestamp of the response */
|
|
3442
|
+
timestamp: string;
|
|
3443
|
+
/** @description The path of the request */
|
|
3444
|
+
path: string;
|
|
3445
|
+
};
|
|
3446
|
+
};
|
|
3447
|
+
};
|
|
3448
|
+
/** @description Default Response */
|
|
3449
|
+
403: {
|
|
3450
|
+
headers: {
|
|
3451
|
+
[name: string]: unknown;
|
|
3452
|
+
};
|
|
3453
|
+
content: {
|
|
3454
|
+
"application/octet-stream": {
|
|
3455
|
+
/** @description HTTP status code */
|
|
3456
|
+
statusCode: number;
|
|
3457
|
+
error: {
|
|
3458
|
+
/**
|
|
3459
|
+
* @description The error code
|
|
3460
|
+
* @enum {string}
|
|
3461
|
+
*/
|
|
3462
|
+
code: "AUTHORIZATION_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
3463
|
+
/** @description The error message */
|
|
3464
|
+
message: string;
|
|
3465
|
+
/** @description A suggestion to resolve the error */
|
|
3466
|
+
suggestion: string;
|
|
3467
|
+
/** @description A URL to the documentation */
|
|
3468
|
+
documentationUrl: string;
|
|
3469
|
+
};
|
|
3470
|
+
/** @description The unique identifier of the request */
|
|
3471
|
+
requestId: string;
|
|
3472
|
+
/** @description The timestamp of the response */
|
|
3473
|
+
timestamp: string;
|
|
3474
|
+
/** @description The path of the request */
|
|
3475
|
+
path: string;
|
|
3476
|
+
};
|
|
3477
|
+
};
|
|
3478
|
+
};
|
|
3479
|
+
/** @description Default Response */
|
|
3480
|
+
500: {
|
|
3481
|
+
headers: {
|
|
3482
|
+
[name: string]: unknown;
|
|
3483
|
+
};
|
|
3484
|
+
content: {
|
|
3485
|
+
"application/octet-stream": {
|
|
3486
|
+
/** @description HTTP status code */
|
|
3487
|
+
statusCode: number;
|
|
3488
|
+
error: {
|
|
3489
|
+
/**
|
|
3490
|
+
* @description The error code
|
|
3491
|
+
* @enum {string}
|
|
3492
|
+
*/
|
|
3493
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
3494
|
+
/** @description The error message */
|
|
3495
|
+
message: string;
|
|
3496
|
+
/** @description A suggestion to resolve the error */
|
|
3497
|
+
suggestion: string;
|
|
3498
|
+
/** @description A URL to the documentation */
|
|
3499
|
+
documentationUrl: string;
|
|
3500
|
+
};
|
|
3501
|
+
/** @description The unique identifier of the request */
|
|
3502
|
+
requestId: string;
|
|
3503
|
+
/** @description The timestamp of the response */
|
|
3504
|
+
timestamp: string;
|
|
3505
|
+
/** @description The path of the request */
|
|
3506
|
+
path: string;
|
|
3507
|
+
};
|
|
3508
|
+
};
|
|
3509
|
+
};
|
|
3510
|
+
};
|
|
3511
|
+
};
|
|
3512
|
+
delete?: never;
|
|
3513
|
+
options?: never;
|
|
3514
|
+
head?: never;
|
|
3515
|
+
patch?: never;
|
|
3516
|
+
trace?: never;
|
|
3517
|
+
};
|
|
3518
|
+
"/public/envelope/list": {
|
|
3519
|
+
parameters: {
|
|
3520
|
+
query?: never;
|
|
3521
|
+
header?: never;
|
|
3522
|
+
path?: never;
|
|
3523
|
+
cookie?: never;
|
|
3524
|
+
};
|
|
3525
|
+
get?: never;
|
|
3526
|
+
put?: never;
|
|
3527
|
+
/**
|
|
3528
|
+
* list
|
|
3529
|
+
* @description List all envelopes in a workspace.
|
|
3530
|
+
*/
|
|
3531
|
+
post: {
|
|
3532
|
+
parameters: {
|
|
3533
|
+
query?: never;
|
|
3534
|
+
header?: never;
|
|
3535
|
+
path?: never;
|
|
3536
|
+
cookie?: never;
|
|
3537
|
+
};
|
|
3538
|
+
requestBody?: {
|
|
3539
|
+
content: {
|
|
3540
|
+
"application/json": {
|
|
3541
|
+
/** @description The UUID of the workspace to list the envelopes in. */
|
|
3542
|
+
workspaceUuid?: string;
|
|
3543
|
+
/** @description Optional array of tag names to filter envelopes by */
|
|
3544
|
+
tags?: string[];
|
|
3545
|
+
/**
|
|
3546
|
+
* @description The page number to retrieve (1-indexed). Defaults to 1. Each page contains up to 50 results.
|
|
3547
|
+
* @default 1
|
|
3548
|
+
*/
|
|
3549
|
+
page?: number;
|
|
3550
|
+
};
|
|
3551
|
+
};
|
|
3552
|
+
};
|
|
3553
|
+
responses: {
|
|
3554
|
+
/** @description Default Response */
|
|
3555
|
+
200: {
|
|
3556
|
+
headers: {
|
|
3557
|
+
[name: string]: unknown;
|
|
3558
|
+
};
|
|
3559
|
+
content: {
|
|
3560
|
+
"application/json": {
|
|
3561
|
+
envelopes: {
|
|
3562
|
+
/** @description The unique identifier of the envelope. */
|
|
3563
|
+
uuid: string;
|
|
3564
|
+
/** @description The title of the envelope. */
|
|
3565
|
+
title: string;
|
|
3566
|
+
/** @description The date and time the envelope was created (unix timestamp). */
|
|
3567
|
+
creationDate: number;
|
|
3568
|
+
/** @description The date and time the envelope was last updated (unix timestamp). */
|
|
3569
|
+
updateDate: number;
|
|
3570
|
+
/** @description The date and time the envelope was sent (unix timestamp). */
|
|
3571
|
+
sentDate: number | null;
|
|
3572
|
+
/**
|
|
3573
|
+
* @description The status of the envelope.
|
|
3574
|
+
* @enum {string}
|
|
3575
|
+
*/
|
|
3576
|
+
status: "uploading" | "draft" | "approving" | "signing" | "complete" | "declined" | "canceled";
|
|
3577
|
+
/** @description The UUID of the workspace the envelope belongs to. */
|
|
3578
|
+
workspaceUuid: string;
|
|
3579
|
+
/** @description The creator of the envelope. */
|
|
3580
|
+
owner: {
|
|
3581
|
+
/** @description The unique identifier of the owner. */
|
|
3582
|
+
uuid: string;
|
|
3583
|
+
/** @description The email of the owner. */
|
|
3584
|
+
email: string;
|
|
3585
|
+
/** @description The first name of the owner. */
|
|
3586
|
+
firstname: string | null;
|
|
3587
|
+
/** @description The last name of the owner. */
|
|
3588
|
+
lastname: string | null;
|
|
3589
|
+
};
|
|
3590
|
+
/** @description The metrics of the envelope. */
|
|
3591
|
+
metrics: {
|
|
3592
|
+
/** @description The number of signatures on the envelope. */
|
|
3593
|
+
signatureCount: number;
|
|
3594
|
+
/** @description The number of signatures required on the envelope. */
|
|
3595
|
+
signatureRequiredCount: number;
|
|
3596
|
+
/** @description The number of approvals on the envelope. */
|
|
3597
|
+
approvalCount: number;
|
|
3598
|
+
/** @description The number of approvals required on the envelope. */
|
|
3599
|
+
approvalRequiredCount: number;
|
|
3600
|
+
};
|
|
3601
|
+
/** @description The tags of the envelope. */
|
|
3602
|
+
tags: string[];
|
|
3603
|
+
}[];
|
|
3604
|
+
};
|
|
3605
|
+
};
|
|
3606
|
+
};
|
|
3607
|
+
/** @description Default Response */
|
|
3608
|
+
401: {
|
|
3609
|
+
headers: {
|
|
3610
|
+
[name: string]: unknown;
|
|
3611
|
+
};
|
|
3612
|
+
content: {
|
|
3613
|
+
"application/json": {
|
|
3614
|
+
/** @description HTTP status code */
|
|
3615
|
+
statusCode: number;
|
|
3616
|
+
error: {
|
|
3617
|
+
/**
|
|
3618
|
+
* @description The error code
|
|
3619
|
+
* @enum {string}
|
|
3620
|
+
*/
|
|
3621
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
3622
|
+
/** @description The error message */
|
|
3623
|
+
message: string;
|
|
3624
|
+
/** @description A suggestion to resolve the error */
|
|
3625
|
+
suggestion: string;
|
|
3626
|
+
/** @description A URL to the documentation */
|
|
3627
|
+
documentationUrl: string;
|
|
3628
|
+
};
|
|
3629
|
+
/** @description The unique identifier of the request */
|
|
3630
|
+
requestId: string;
|
|
3631
|
+
/** @description The timestamp of the response */
|
|
3632
|
+
timestamp: string;
|
|
3633
|
+
/** @description The path of the request */
|
|
3634
|
+
path: string;
|
|
3635
|
+
};
|
|
3636
|
+
};
|
|
3637
|
+
};
|
|
3638
|
+
/** @description Default Response */
|
|
3639
|
+
403: {
|
|
3640
|
+
headers: {
|
|
3641
|
+
[name: string]: unknown;
|
|
3642
|
+
};
|
|
3643
|
+
content: {
|
|
3644
|
+
"application/json": {
|
|
3645
|
+
/** @description HTTP status code */
|
|
3646
|
+
statusCode: number;
|
|
3647
|
+
error: {
|
|
3648
|
+
/**
|
|
3649
|
+
* @description The error code
|
|
3650
|
+
* @enum {string}
|
|
3651
|
+
*/
|
|
3652
|
+
code: "AUTHORIZATION_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
3653
|
+
/** @description The error message */
|
|
3654
|
+
message: string;
|
|
3655
|
+
/** @description A suggestion to resolve the error */
|
|
3656
|
+
suggestion: string;
|
|
3657
|
+
/** @description A URL to the documentation */
|
|
3658
|
+
documentationUrl: string;
|
|
3659
|
+
};
|
|
3660
|
+
/** @description The unique identifier of the request */
|
|
3661
|
+
requestId: string;
|
|
3662
|
+
/** @description The timestamp of the response */
|
|
3663
|
+
timestamp: string;
|
|
3664
|
+
/** @description The path of the request */
|
|
3665
|
+
path: string;
|
|
3666
|
+
};
|
|
3667
|
+
};
|
|
3668
|
+
};
|
|
3669
|
+
/** @description Default Response */
|
|
3670
|
+
500: {
|
|
3671
|
+
headers: {
|
|
3672
|
+
[name: string]: unknown;
|
|
3673
|
+
};
|
|
3674
|
+
content: {
|
|
3675
|
+
"application/json": {
|
|
3676
|
+
/** @description HTTP status code */
|
|
3677
|
+
statusCode: number;
|
|
3678
|
+
error: {
|
|
3679
|
+
/**
|
|
3680
|
+
* @description The error code
|
|
3681
|
+
* @enum {string}
|
|
3682
|
+
*/
|
|
3683
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
3684
|
+
/** @description The error message */
|
|
3685
|
+
message: string;
|
|
3686
|
+
/** @description A suggestion to resolve the error */
|
|
3687
|
+
suggestion: string;
|
|
3688
|
+
/** @description A URL to the documentation */
|
|
3689
|
+
documentationUrl: string;
|
|
3690
|
+
};
|
|
3691
|
+
/** @description The unique identifier of the request */
|
|
3692
|
+
requestId: string;
|
|
3693
|
+
/** @description The timestamp of the response */
|
|
3694
|
+
timestamp: string;
|
|
3695
|
+
/** @description The path of the request */
|
|
3696
|
+
path: string;
|
|
3697
|
+
};
|
|
3698
|
+
};
|
|
3699
|
+
};
|
|
3700
|
+
};
|
|
3701
|
+
};
|
|
3702
|
+
delete?: never;
|
|
3703
|
+
options?: never;
|
|
3704
|
+
head?: never;
|
|
3705
|
+
patch?: never;
|
|
3706
|
+
trace?: never;
|
|
3707
|
+
};
|
|
3708
|
+
"/public/template/list": {
|
|
3709
|
+
parameters: {
|
|
3710
|
+
query?: never;
|
|
3711
|
+
header?: never;
|
|
3712
|
+
path?: never;
|
|
3713
|
+
cookie?: never;
|
|
3714
|
+
};
|
|
3715
|
+
get?: never;
|
|
3716
|
+
put?: never;
|
|
3717
|
+
/**
|
|
3718
|
+
* list
|
|
3719
|
+
* @description List all templates accessible by the team.
|
|
3720
|
+
*/
|
|
3721
|
+
post: {
|
|
3722
|
+
parameters: {
|
|
3723
|
+
query?: never;
|
|
3724
|
+
header?: never;
|
|
3725
|
+
path?: never;
|
|
3726
|
+
cookie?: never;
|
|
3727
|
+
};
|
|
3728
|
+
requestBody?: {
|
|
3729
|
+
content: {
|
|
3730
|
+
"application/json": {
|
|
3731
|
+
/** @description The UUID of the workspace to list the templates in. */
|
|
3732
|
+
workspaceUuid?: string;
|
|
3733
|
+
/**
|
|
3734
|
+
* @description The page number to retrieve (1-indexed). Defaults to 1. Each page contains up to 50 results.
|
|
3735
|
+
* @default 1
|
|
3736
|
+
*/
|
|
3737
|
+
page?: number;
|
|
3738
|
+
};
|
|
3739
|
+
};
|
|
3740
|
+
};
|
|
3741
|
+
responses: {
|
|
3742
|
+
/** @description Default Response */
|
|
3743
|
+
200: {
|
|
3744
|
+
headers: {
|
|
3745
|
+
[name: string]: unknown;
|
|
3746
|
+
};
|
|
3747
|
+
content: {
|
|
3748
|
+
"application/json": {
|
|
3749
|
+
templates: {
|
|
3750
|
+
/** @description The unique identifier of the template. */
|
|
3751
|
+
uuid: string;
|
|
3752
|
+
/** @description The title of the template. */
|
|
3753
|
+
title: string;
|
|
3754
|
+
/** @description The date and time the template was created (unix timestamp). */
|
|
3755
|
+
creationDate: number;
|
|
3756
|
+
/** @description The date and time the template was last updated (unix timestamp). */
|
|
3757
|
+
updateDate: number;
|
|
3758
|
+
/**
|
|
3759
|
+
* @description The status of the template.
|
|
3760
|
+
* @enum {string}
|
|
3761
|
+
*/
|
|
3762
|
+
status: "incomplete" | "draft" | "active" | "archived";
|
|
3763
|
+
/** @description The UUID of the workspace the template belongs to. */
|
|
3764
|
+
workspaceUuid: string;
|
|
3765
|
+
/** @description The creator of the template. */
|
|
3766
|
+
owner: {
|
|
3767
|
+
/** @description The unique identifier of the owner. */
|
|
3768
|
+
uuid: string;
|
|
3769
|
+
/** @description The email of the owner. */
|
|
3770
|
+
email: string;
|
|
3771
|
+
/** @description The first name of the owner. */
|
|
3772
|
+
firstname: string | null;
|
|
3773
|
+
/** @description The last name of the owner. */
|
|
3774
|
+
lastname: string | null;
|
|
3775
|
+
};
|
|
3776
|
+
documents: {
|
|
3777
|
+
/** @description The unique identifier of the document. */
|
|
3778
|
+
uuid: string;
|
|
3779
|
+
/** @description The title of the document. */
|
|
3780
|
+
title: string;
|
|
3781
|
+
}[];
|
|
3782
|
+
/** @description The tags of the template. */
|
|
3783
|
+
tags: string[];
|
|
3784
|
+
/** @description The recipients of the template. */
|
|
3785
|
+
recipients: {
|
|
3786
|
+
/** @description The label of the recipient. */
|
|
3787
|
+
label: string;
|
|
3788
|
+
}[];
|
|
3789
|
+
/** @description The number of recipients in the template. */
|
|
3790
|
+
recipientCount: number;
|
|
3791
|
+
}[];
|
|
3792
|
+
};
|
|
3793
|
+
};
|
|
3794
|
+
};
|
|
3795
|
+
/** @description Default Response */
|
|
3796
|
+
401: {
|
|
3797
|
+
headers: {
|
|
3798
|
+
[name: string]: unknown;
|
|
3799
|
+
};
|
|
3800
|
+
content: {
|
|
3801
|
+
"application/json": {
|
|
3802
|
+
/** @description HTTP status code */
|
|
3803
|
+
statusCode: number;
|
|
3804
|
+
error: {
|
|
3805
|
+
/**
|
|
3806
|
+
* @description The error code
|
|
3807
|
+
* @enum {string}
|
|
3808
|
+
*/
|
|
3809
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
3810
|
+
/** @description The error message */
|
|
3811
|
+
message: string;
|
|
3812
|
+
/** @description A suggestion to resolve the error */
|
|
3813
|
+
suggestion: string;
|
|
3814
|
+
/** @description A URL to the documentation */
|
|
3815
|
+
documentationUrl: string;
|
|
3816
|
+
};
|
|
3817
|
+
/** @description The unique identifier of the request */
|
|
3818
|
+
requestId: string;
|
|
3819
|
+
/** @description The timestamp of the response */
|
|
3820
|
+
timestamp: string;
|
|
3821
|
+
/** @description The path of the request */
|
|
3822
|
+
path: string;
|
|
3823
|
+
};
|
|
3824
|
+
};
|
|
3825
|
+
};
|
|
3826
|
+
/** @description Default Response */
|
|
3827
|
+
403: {
|
|
3828
|
+
headers: {
|
|
3829
|
+
[name: string]: unknown;
|
|
3830
|
+
};
|
|
3831
|
+
content: {
|
|
3832
|
+
"application/json": {
|
|
3833
|
+
/** @description HTTP status code */
|
|
3834
|
+
statusCode: number;
|
|
3835
|
+
error: {
|
|
3836
|
+
/**
|
|
3837
|
+
* @description The error code
|
|
3838
|
+
* @enum {string}
|
|
3839
|
+
*/
|
|
3840
|
+
code: "AUTHORIZATION_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
3841
|
+
/** @description The error message */
|
|
3842
|
+
message: string;
|
|
3843
|
+
/** @description A suggestion to resolve the error */
|
|
3844
|
+
suggestion: string;
|
|
3845
|
+
/** @description A URL to the documentation */
|
|
3846
|
+
documentationUrl: string;
|
|
3847
|
+
};
|
|
3848
|
+
/** @description The unique identifier of the request */
|
|
3849
|
+
requestId: string;
|
|
3850
|
+
/** @description The timestamp of the response */
|
|
3851
|
+
timestamp: string;
|
|
3852
|
+
/** @description The path of the request */
|
|
3853
|
+
path: string;
|
|
3854
|
+
};
|
|
3855
|
+
};
|
|
3856
|
+
};
|
|
3857
|
+
/** @description Default Response */
|
|
3858
|
+
500: {
|
|
3859
|
+
headers: {
|
|
3860
|
+
[name: string]: unknown;
|
|
3861
|
+
};
|
|
3862
|
+
content: {
|
|
3863
|
+
"application/json": {
|
|
3864
|
+
/** @description HTTP status code */
|
|
3865
|
+
statusCode: number;
|
|
3866
|
+
error: {
|
|
3867
|
+
/**
|
|
3868
|
+
* @description The error code
|
|
3869
|
+
* @enum {string}
|
|
3870
|
+
*/
|
|
3871
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
3872
|
+
/** @description The error message */
|
|
3873
|
+
message: string;
|
|
3874
|
+
/** @description A suggestion to resolve the error */
|
|
3875
|
+
suggestion: string;
|
|
3876
|
+
/** @description A URL to the documentation */
|
|
3877
|
+
documentationUrl: string;
|
|
3878
|
+
};
|
|
3879
|
+
/** @description The unique identifier of the request */
|
|
3880
|
+
requestId: string;
|
|
3881
|
+
/** @description The timestamp of the response */
|
|
3882
|
+
timestamp: string;
|
|
3883
|
+
/** @description The path of the request */
|
|
3884
|
+
path: string;
|
|
3885
|
+
};
|
|
3886
|
+
};
|
|
3887
|
+
};
|
|
3888
|
+
};
|
|
3889
|
+
};
|
|
3890
|
+
delete?: never;
|
|
3891
|
+
options?: never;
|
|
3892
|
+
head?: never;
|
|
3893
|
+
patch?: never;
|
|
3894
|
+
trace?: never;
|
|
3895
|
+
};
|
|
3896
|
+
"/public/utils/whoami": {
|
|
3897
|
+
parameters: {
|
|
3898
|
+
query?: never;
|
|
3899
|
+
header?: never;
|
|
3900
|
+
path?: never;
|
|
3901
|
+
cookie?: never;
|
|
3902
|
+
};
|
|
3903
|
+
get?: never;
|
|
3904
|
+
put?: never;
|
|
3905
|
+
/**
|
|
3906
|
+
* whoami
|
|
3907
|
+
* @description Get information about the authenticated team and api key
|
|
3908
|
+
*/
|
|
3909
|
+
post: {
|
|
3910
|
+
parameters: {
|
|
3911
|
+
query?: never;
|
|
3912
|
+
header?: never;
|
|
3913
|
+
path?: never;
|
|
3914
|
+
cookie?: never;
|
|
3915
|
+
};
|
|
3916
|
+
requestBody?: {
|
|
3917
|
+
content: {
|
|
3918
|
+
"application/json": Record<string, never>;
|
|
3919
|
+
};
|
|
3920
|
+
};
|
|
3921
|
+
responses: {
|
|
3922
|
+
/** @description Default Response */
|
|
3923
|
+
200: {
|
|
3924
|
+
headers: {
|
|
3925
|
+
[name: string]: unknown;
|
|
3926
|
+
};
|
|
3927
|
+
content: {
|
|
3928
|
+
"application/json": {
|
|
3929
|
+
/** @description The UUID of the team. */
|
|
3930
|
+
teamUuid: string;
|
|
3931
|
+
/** @description The name of the team. */
|
|
3932
|
+
teamName: string;
|
|
3933
|
+
/** @description The email of the owner. */
|
|
3934
|
+
ownerEmail: string;
|
|
3935
|
+
/** @description The UUID of the owner. */
|
|
3936
|
+
ownerUuid: string;
|
|
3937
|
+
/** @description The API key used to authenticate the request. */
|
|
3938
|
+
accessKey: string;
|
|
3939
|
+
};
|
|
3940
|
+
};
|
|
3941
|
+
};
|
|
3942
|
+
/** @description Default Response */
|
|
3943
|
+
401: {
|
|
3944
|
+
headers: {
|
|
3945
|
+
[name: string]: unknown;
|
|
3946
|
+
};
|
|
3947
|
+
content: {
|
|
3948
|
+
"application/json": {
|
|
3949
|
+
/** @description HTTP status code */
|
|
3950
|
+
statusCode: number;
|
|
3951
|
+
error: {
|
|
3952
|
+
/**
|
|
3953
|
+
* @description The error code
|
|
3954
|
+
* @enum {string}
|
|
3955
|
+
*/
|
|
3956
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
3957
|
+
/** @description The error message */
|
|
3958
|
+
message: string;
|
|
3959
|
+
/** @description A suggestion to resolve the error */
|
|
3960
|
+
suggestion: string;
|
|
3961
|
+
/** @description A URL to the documentation */
|
|
3962
|
+
documentationUrl: string;
|
|
3963
|
+
};
|
|
3964
|
+
/** @description The unique identifier of the request */
|
|
3965
|
+
requestId: string;
|
|
3966
|
+
/** @description The timestamp of the response */
|
|
3967
|
+
timestamp: string;
|
|
3968
|
+
/** @description The path of the request */
|
|
3969
|
+
path: string;
|
|
3970
|
+
};
|
|
3971
|
+
};
|
|
3972
|
+
};
|
|
3973
|
+
/** @description Default Response */
|
|
3974
|
+
403: {
|
|
3975
|
+
headers: {
|
|
3976
|
+
[name: string]: unknown;
|
|
3977
|
+
};
|
|
3978
|
+
content: {
|
|
3979
|
+
"application/json": {
|
|
3980
|
+
/** @description HTTP status code */
|
|
3981
|
+
statusCode: number;
|
|
3982
|
+
error: {
|
|
3983
|
+
/**
|
|
3984
|
+
* @description The error code
|
|
3985
|
+
* @enum {string}
|
|
3986
|
+
*/
|
|
3987
|
+
code: "AUTHORIZATION_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
3988
|
+
/** @description The error message */
|
|
3989
|
+
message: string;
|
|
3990
|
+
/** @description A suggestion to resolve the error */
|
|
3991
|
+
suggestion: string;
|
|
3992
|
+
/** @description A URL to the documentation */
|
|
3993
|
+
documentationUrl: string;
|
|
3994
|
+
};
|
|
3995
|
+
/** @description The unique identifier of the request */
|
|
3996
|
+
requestId: string;
|
|
3997
|
+
/** @description The timestamp of the response */
|
|
3998
|
+
timestamp: string;
|
|
3999
|
+
/** @description The path of the request */
|
|
4000
|
+
path: string;
|
|
4001
|
+
};
|
|
4002
|
+
};
|
|
4003
|
+
};
|
|
4004
|
+
/** @description Default Response */
|
|
4005
|
+
500: {
|
|
4006
|
+
headers: {
|
|
4007
|
+
[name: string]: unknown;
|
|
4008
|
+
};
|
|
4009
|
+
content: {
|
|
4010
|
+
"application/json": {
|
|
4011
|
+
/** @description HTTP status code */
|
|
4012
|
+
statusCode: number;
|
|
4013
|
+
error: {
|
|
4014
|
+
/**
|
|
4015
|
+
* @description The error code
|
|
4016
|
+
* @enum {string}
|
|
4017
|
+
*/
|
|
4018
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
4019
|
+
/** @description The error message */
|
|
4020
|
+
message: string;
|
|
4021
|
+
/** @description A suggestion to resolve the error */
|
|
4022
|
+
suggestion: string;
|
|
4023
|
+
/** @description A URL to the documentation */
|
|
4024
|
+
documentationUrl: string;
|
|
4025
|
+
};
|
|
4026
|
+
/** @description The unique identifier of the request */
|
|
4027
|
+
requestId: string;
|
|
4028
|
+
/** @description The timestamp of the response */
|
|
4029
|
+
timestamp: string;
|
|
4030
|
+
/** @description The path of the request */
|
|
4031
|
+
path: string;
|
|
4032
|
+
};
|
|
4033
|
+
};
|
|
4034
|
+
};
|
|
4035
|
+
};
|
|
4036
|
+
};
|
|
4037
|
+
delete?: never;
|
|
4038
|
+
options?: never;
|
|
4039
|
+
head?: never;
|
|
4040
|
+
patch?: never;
|
|
4041
|
+
trace?: never;
|
|
4042
|
+
};
|
|
4043
|
+
"/public/workspace/list": {
|
|
4044
|
+
parameters: {
|
|
4045
|
+
query?: never;
|
|
4046
|
+
header?: never;
|
|
4047
|
+
path?: never;
|
|
4048
|
+
cookie?: never;
|
|
4049
|
+
};
|
|
4050
|
+
get?: never;
|
|
4051
|
+
put?: never;
|
|
4052
|
+
/**
|
|
4053
|
+
* list
|
|
4054
|
+
* @description List all workspaces the API key owner is a member of.
|
|
4055
|
+
*/
|
|
4056
|
+
post: {
|
|
4057
|
+
parameters: {
|
|
4058
|
+
query?: never;
|
|
4059
|
+
header?: never;
|
|
4060
|
+
path?: never;
|
|
4061
|
+
cookie?: never;
|
|
4062
|
+
};
|
|
4063
|
+
requestBody?: {
|
|
4064
|
+
content: {
|
|
4065
|
+
"application/json": Record<string, never>;
|
|
4066
|
+
};
|
|
4067
|
+
};
|
|
4068
|
+
responses: {
|
|
4069
|
+
/** @description Default Response */
|
|
4070
|
+
200: {
|
|
4071
|
+
headers: {
|
|
4072
|
+
[name: string]: unknown;
|
|
4073
|
+
};
|
|
4074
|
+
content: {
|
|
4075
|
+
"application/json": {
|
|
4076
|
+
workspaces: {
|
|
4077
|
+
/** @description The unique identifier of the workspace. */
|
|
4078
|
+
uuid: string;
|
|
4079
|
+
/** @description The name of the workspace. */
|
|
4080
|
+
name: string;
|
|
4081
|
+
/** @description The date and time the workspace was created (unix timestamp). */
|
|
4082
|
+
creationDate: number;
|
|
4083
|
+
/** @description The date and time the workspace was last updated (unix timestamp). */
|
|
4084
|
+
updateDate: number;
|
|
4085
|
+
/** @description The number of members in this workspace. */
|
|
4086
|
+
membersCount: number;
|
|
4087
|
+
}[];
|
|
4088
|
+
};
|
|
4089
|
+
};
|
|
4090
|
+
};
|
|
4091
|
+
/** @description Default Response */
|
|
4092
|
+
401: {
|
|
4093
|
+
headers: {
|
|
4094
|
+
[name: string]: unknown;
|
|
4095
|
+
};
|
|
4096
|
+
content: {
|
|
4097
|
+
"application/json": {
|
|
4098
|
+
/** @description HTTP status code */
|
|
4099
|
+
statusCode: number;
|
|
4100
|
+
error: {
|
|
4101
|
+
/**
|
|
4102
|
+
* @description The error code
|
|
4103
|
+
* @enum {string}
|
|
4104
|
+
*/
|
|
4105
|
+
code: "AUTHENTICATION_ERROR" | "TUNNEL_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
4106
|
+
/** @description The error message */
|
|
4107
|
+
message: string;
|
|
4108
|
+
/** @description A suggestion to resolve the error */
|
|
4109
|
+
suggestion: string;
|
|
4110
|
+
/** @description A URL to the documentation */
|
|
4111
|
+
documentationUrl: string;
|
|
4112
|
+
};
|
|
4113
|
+
/** @description The unique identifier of the request */
|
|
4114
|
+
requestId: string;
|
|
4115
|
+
/** @description The timestamp of the response */
|
|
4116
|
+
timestamp: string;
|
|
4117
|
+
/** @description The path of the request */
|
|
4118
|
+
path: string;
|
|
4119
|
+
};
|
|
4120
|
+
};
|
|
4121
|
+
};
|
|
4122
|
+
/** @description Default Response */
|
|
4123
|
+
403: {
|
|
4124
|
+
headers: {
|
|
4125
|
+
[name: string]: unknown;
|
|
4126
|
+
};
|
|
4127
|
+
content: {
|
|
4128
|
+
"application/json": {
|
|
4129
|
+
/** @description HTTP status code */
|
|
4130
|
+
statusCode: number;
|
|
4131
|
+
error: {
|
|
4132
|
+
/**
|
|
4133
|
+
* @description The error code
|
|
4134
|
+
* @enum {string}
|
|
4135
|
+
*/
|
|
4136
|
+
code: "AUTHORIZATION_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
4137
|
+
/** @description The error message */
|
|
4138
|
+
message: string;
|
|
4139
|
+
/** @description A suggestion to resolve the error */
|
|
4140
|
+
suggestion: string;
|
|
4141
|
+
/** @description A URL to the documentation */
|
|
4142
|
+
documentationUrl: string;
|
|
4143
|
+
};
|
|
4144
|
+
/** @description The unique identifier of the request */
|
|
4145
|
+
requestId: string;
|
|
4146
|
+
/** @description The timestamp of the response */
|
|
4147
|
+
timestamp: string;
|
|
4148
|
+
/** @description The path of the request */
|
|
4149
|
+
path: string;
|
|
4150
|
+
};
|
|
4151
|
+
};
|
|
4152
|
+
};
|
|
4153
|
+
/** @description Default Response */
|
|
4154
|
+
500: {
|
|
4155
|
+
headers: {
|
|
4156
|
+
[name: string]: unknown;
|
|
4157
|
+
};
|
|
4158
|
+
content: {
|
|
4159
|
+
"application/json": {
|
|
4160
|
+
/** @description HTTP status code */
|
|
4161
|
+
statusCode: number;
|
|
4162
|
+
error: {
|
|
4163
|
+
/**
|
|
4164
|
+
* @description The error code
|
|
4165
|
+
* @enum {string}
|
|
4166
|
+
*/
|
|
4167
|
+
code: "INTERNAL_SERVER_ERROR" | "INVALID_REQUEST_FORMAT";
|
|
4168
|
+
/** @description The error message */
|
|
4169
|
+
message: string;
|
|
4170
|
+
/** @description A suggestion to resolve the error */
|
|
4171
|
+
suggestion: string;
|
|
4172
|
+
/** @description A URL to the documentation */
|
|
4173
|
+
documentationUrl: string;
|
|
4174
|
+
};
|
|
4175
|
+
/** @description The unique identifier of the request */
|
|
4176
|
+
requestId: string;
|
|
4177
|
+
/** @description The timestamp of the response */
|
|
4178
|
+
timestamp: string;
|
|
4179
|
+
/** @description The path of the request */
|
|
4180
|
+
path: string;
|
|
4181
|
+
};
|
|
4182
|
+
};
|
|
4183
|
+
};
|
|
4184
|
+
};
|
|
4185
|
+
};
|
|
4186
|
+
delete?: never;
|
|
4187
|
+
options?: never;
|
|
4188
|
+
head?: never;
|
|
4189
|
+
patch?: never;
|
|
4190
|
+
trace?: never;
|
|
4191
|
+
};
|
|
4192
|
+
}
|
|
4193
|
+
export type webhooks = Record<string, never>;
|
|
4194
|
+
export interface components {
|
|
4195
|
+
schemas: never;
|
|
4196
|
+
responses: never;
|
|
4197
|
+
parameters: never;
|
|
4198
|
+
requestBodies: never;
|
|
4199
|
+
headers: never;
|
|
4200
|
+
pathItems: never;
|
|
4201
|
+
}
|
|
4202
|
+
export type $defs = Record<string, never>;
|
|
4203
|
+
export type operations = Record<string, never>;
|
|
4204
|
+
export enum ApiPaths {
|
|
4205
|
+
PostPublicContactCreate = "/public/contact/create",
|
|
4206
|
+
PostPublicContactList = "/public/contact/list",
|
|
4207
|
+
PostPublicContactDelete = "/public/contact/delete",
|
|
4208
|
+
PostPublicContactGet = "/public/contact/get",
|
|
4209
|
+
PostPublicContactUpdate = "/public/contact/update",
|
|
4210
|
+
PostPublicEnvelopeAddblocks = "/public/envelope/add-blocks",
|
|
4211
|
+
PostPublicEnvelopeAddrecipients = "/public/envelope/add-recipients",
|
|
4212
|
+
PostPublicEnvelopeCreate = "/public/envelope/create",
|
|
4213
|
+
PostPublicEnvelopeCreatefrom_template = "/public/envelope/create-from-template",
|
|
4214
|
+
PostPublicEnvelopeDeleteblocks = "/public/envelope/delete-blocks",
|
|
4215
|
+
PostPublicEnvelopeDelete = "/public/envelope/delete",
|
|
4216
|
+
PostPublicEnvelopeDeleterecipients = "/public/envelope/delete-recipients",
|
|
4217
|
+
PostPublicEnvelopeSend = "/public/envelope/send",
|
|
4218
|
+
PostPublicEnvelopeSign = "/public/envelope/sign",
|
|
4219
|
+
PostPublicEnvelopeCompletedocument_upload = "/public/envelope/complete-document-upload",
|
|
4220
|
+
PostPublicEnvelopeGetdocument = "/public/envelope/get-document",
|
|
4221
|
+
PostPublicEnvelopeGet = "/public/envelope/get",
|
|
4222
|
+
PostPublicEnvelopeGetproof = "/public/envelope/get-proof",
|
|
4223
|
+
PostPublicEnvelopeList = "/public/envelope/list",
|
|
4224
|
+
PostPublicTemplateList = "/public/template/list",
|
|
4225
|
+
PostPublicUtilsWhoami = "/public/utils/whoami",
|
|
4226
|
+
PostPublicWorkspaceList = "/public/workspace/list"
|
|
4227
|
+
}
|