instasign 1.1.2 → 1.1.3

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.
Files changed (10) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/README.md +16 -9
  3. package/dist/index.cjs +17 -17
  4. package/dist/index.cjs.map +1 -1
  5. package/dist/index.d.cts +368 -969
  6. package/dist/index.d.ts +368 -969
  7. package/dist/index.js +17 -19
  8. package/dist/index.js.map +1 -1
  9. package/package.json +1 -1
  10. package/types/schema.d.ts +115 -616
package/types/schema.d.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  */
5
5
 
6
6
  export interface paths {
7
- "/functions/addSignRequestToEnvelope": {
7
+ "/functions/envelope:add-sign-request": {
8
8
  parameters: {
9
9
  query?: never;
10
10
  header?: never;
@@ -13,7 +13,7 @@ export interface paths {
13
13
  };
14
14
  get?: never;
15
15
  put?: never;
16
- /** Cloud Function: addSignRequestToEnvelope */
16
+ /** envelope:add-sign-request */
17
17
  post: {
18
18
  parameters: {
19
19
  query?: never;
@@ -24,15 +24,10 @@ export interface paths {
24
24
  requestBody?: {
25
25
  content: {
26
26
  "application/json": {
27
- /** @description The unique identifier of the envelope */
28
27
  envelopeId: string;
29
- /** @description The name of the file to be signed */
30
28
  filename: string;
31
- /** @description The base64 encoded content of the file */
32
29
  base64File?: string;
33
- /** @description Remote URL of the file. MUST be publicly accessible. */
34
30
  fileUrl?: string;
35
- /** @description Associated metadata for the sign request */
36
31
  metadata?: {
37
32
  [key: string]: unknown;
38
33
  };
@@ -47,9 +42,9 @@ export interface paths {
47
42
  };
48
43
  content: {
49
44
  "application/json": {
50
- result?: {
51
- requestId?: string;
52
- signUrl?: string;
45
+ result: {
46
+ requestId: string;
47
+ signUrl: string;
53
48
  envelopeSignUrl?: string;
54
49
  };
55
50
  };
@@ -63,7 +58,7 @@ export interface paths {
63
58
  patch?: never;
64
59
  trace?: never;
65
60
  };
66
- "/functions/completeEnvelope": {
61
+ "/functions/envelope:complete": {
67
62
  parameters: {
68
63
  query?: never;
69
64
  header?: never;
@@ -72,7 +67,7 @@ export interface paths {
72
67
  };
73
68
  get?: never;
74
69
  put?: never;
75
- /** Cloud Function: completeEnvelope */
70
+ /** envelope:complete */
76
71
  post: {
77
72
  parameters: {
78
73
  query?: never;
@@ -83,7 +78,6 @@ export interface paths {
83
78
  requestBody?: {
84
79
  content: {
85
80
  "application/json": {
86
- /** @description The unique identifier of the envelope to mark as completed */
87
81
  envelopeId: string;
88
82
  };
89
83
  };
@@ -96,9 +90,9 @@ export interface paths {
96
90
  };
97
91
  content: {
98
92
  "application/json": {
99
- result?: {
100
- success?: boolean;
101
- message?: string;
93
+ result: {
94
+ success: boolean;
95
+ message: string;
102
96
  };
103
97
  };
104
98
  };
@@ -111,7 +105,7 @@ export interface paths {
111
105
  patch?: never;
112
106
  trace?: never;
113
107
  };
114
- "/functions/createEnvelope": {
108
+ "/functions/envelope:create": {
115
109
  parameters: {
116
110
  query?: never;
117
111
  header?: never;
@@ -120,7 +114,7 @@ export interface paths {
120
114
  };
121
115
  get?: never;
122
116
  put?: never;
123
- /** Cloud Function: createEnvelope */
117
+ /** envelope:create */
124
118
  post: {
125
119
  parameters: {
126
120
  query?: never;
@@ -131,20 +125,13 @@ export interface paths {
131
125
  requestBody?: {
132
126
  content: {
133
127
  "application/json": {
134
- /** @description The name of the envelope */
135
128
  name: string;
136
- /** @description The description of the envelope */
137
129
  description?: string;
138
- /** @description Associated metadata for the envelope */
139
130
  metadata?: {
140
131
  [key: string]: unknown;
141
132
  };
142
- /**
143
- * Format: date-time
144
- * @description The expiration date of the envelope
145
- */
133
+ /** Format: date-time */
146
134
  expirationDate?: string;
147
- /** @description External reference ID for the client */
148
135
  clientReferenceId?: string;
149
136
  };
150
137
  };
@@ -157,8 +144,8 @@ export interface paths {
157
144
  };
158
145
  content: {
159
146
  "application/json": {
160
- result?: {
161
- envelopeId?: string;
147
+ result: {
148
+ envelopeId: string;
162
149
  };
163
150
  };
164
151
  };
@@ -171,7 +158,7 @@ export interface paths {
171
158
  patch?: never;
172
159
  trace?: never;
173
160
  };
174
- "/functions/deleteEnvelope": {
161
+ "/functions/envelope:delete": {
175
162
  parameters: {
176
163
  query?: never;
177
164
  header?: never;
@@ -180,7 +167,7 @@ export interface paths {
180
167
  };
181
168
  get?: never;
182
169
  put?: never;
183
- /** Cloud Function: deleteEnvelope */
170
+ /** envelope:delete */
184
171
  post: {
185
172
  parameters: {
186
173
  query?: never;
@@ -191,7 +178,6 @@ export interface paths {
191
178
  requestBody?: {
192
179
  content: {
193
180
  "application/json": {
194
- /** @description The unique identifier of the envelope to delete */
195
181
  envelopeId: string;
196
182
  };
197
183
  };
@@ -204,8 +190,8 @@ export interface paths {
204
190
  };
205
191
  content: {
206
192
  "application/json": {
207
- result?: {
208
- success?: boolean;
193
+ result: {
194
+ success: boolean;
209
195
  };
210
196
  };
211
197
  };
@@ -218,7 +204,7 @@ export interface paths {
218
204
  patch?: never;
219
205
  trace?: never;
220
206
  };
221
- "/functions/getEnvelope": {
207
+ "/functions/envelope:get": {
222
208
  parameters: {
223
209
  query?: never;
224
210
  header?: never;
@@ -227,7 +213,7 @@ export interface paths {
227
213
  };
228
214
  get?: never;
229
215
  put?: never;
230
- /** Cloud Function: getEnvelope */
216
+ /** envelope:get */
231
217
  post: {
232
218
  parameters: {
233
219
  query?: never;
@@ -238,8 +224,8 @@ export interface paths {
238
224
  requestBody?: {
239
225
  content: {
240
226
  "application/json": {
241
- /** @description The unique identifier of the envelope */
242
227
  envelopeId: string;
228
+ includeSignRequests?: boolean;
243
229
  };
244
230
  };
245
231
  };
@@ -251,28 +237,33 @@ export interface paths {
251
237
  };
252
238
  content: {
253
239
  "application/json": {
254
- result?: {
255
- signUrl?: string;
256
- envelopeId?: string;
257
- name?: string;
240
+ result: {
241
+ envelopeId: string;
242
+ name: string;
258
243
  description?: string;
259
- status?: {
260
- [key: string]: unknown;
261
- };
244
+ /** @enum {string} */
245
+ status: "pending" | "in-progress" | "completed" | "cancelled";
262
246
  clientReferenceId?: string;
263
- signRequests?: {
264
- requestId?: string;
265
- status?: {
266
- [key: string]: unknown;
267
- };
268
- fileName?: string;
269
- fileUrl?: string;
247
+ signRequestsCount: number;
248
+ signRequests: {
249
+ requestId: string;
250
+ /** @enum {string} */
251
+ status: "pending" | "completed" | "canceled" | "queued";
252
+ fileName: string;
253
+ fileUrl: string;
270
254
  signedFileUrl?: string;
271
- metadata?: {
255
+ metadata: {
272
256
  [key: string]: unknown;
273
257
  };
274
258
  clientReferenceId?: string;
275
259
  }[];
260
+ /** Format: date-time */
261
+ createdAt: string;
262
+ /** Format: date-time */
263
+ updatedAt: string;
264
+ /** Format: date-time */
265
+ expirationDate?: string;
266
+ signUrl?: string;
276
267
  };
277
268
  };
278
269
  };
@@ -285,7 +276,7 @@ export interface paths {
285
276
  patch?: never;
286
277
  trace?: never;
287
278
  };
288
- "/functions/getEnvelopes": {
279
+ "/functions/envelope:list": {
289
280
  parameters: {
290
281
  query?: never;
291
282
  header?: never;
@@ -294,7 +285,7 @@ export interface paths {
294
285
  };
295
286
  get?: never;
296
287
  put?: never;
297
- /** Cloud Function: getEnvelopes */
288
+ /** envelope:list */
298
289
  post: {
299
290
  parameters: {
300
291
  query?: never;
@@ -305,28 +296,20 @@ export interface paths {
305
296
  requestBody?: {
306
297
  content: {
307
298
  "application/json": {
308
- /** @description Filter by envelope name (case-insensitive regex) */
309
299
  name?: string;
310
- /** @description Filter by envelope status */
311
- status?: string;
312
- /** @description Filter by client reference ID */
300
+ /** @enum {string} */
301
+ status?: "pending" | "in-progress" | "completed" | "cancelled";
313
302
  clientReferenceId?: string;
314
- /** @description Filter by a list of sign request IDs */
315
- signRequests?: {
316
- [key: string]: unknown;
317
- }[];
318
- /** @description Field to order by (createdAt or updatedAt) */
319
- orderBy?: string;
320
- /** @description Order direction (asc or desc) */
321
- orderDirection?: string;
322
- /** @description Filter by expiration date greater than or equal to */
303
+ signRequests?: string[];
304
+ /** @enum {string} */
305
+ orderBy?: "updatedAt" | "createdAt";
306
+ /** @enum {string} */
307
+ orderDirection?: "asc" | "desc";
323
308
  expirationDateStart?: string;
324
- /** @description Filter by expiration date less than or equal to */
325
309
  expirationDateEnd?: string;
326
- /** @description Number of items to skip for pagination */
327
310
  skip?: number;
328
- /** @description Maximum number of items to return */
329
311
  limit?: number;
312
+ includeSignRequests?: boolean;
330
313
  };
331
314
  };
332
315
  };
@@ -338,413 +321,33 @@ export interface paths {
338
321
  };
339
322
  content: {
340
323
  "application/json": {
341
- result?: {
342
- signUrl?: string;
343
- envelopeId?: string;
344
- name?: string;
324
+ result: {
325
+ envelopeId: string;
326
+ name: string;
345
327
  description?: string;
346
- status?: {
347
- [key: string]: unknown;
348
- };
328
+ /** @enum {string} */
329
+ status: "pending" | "in-progress" | "completed" | "cancelled";
349
330
  clientReferenceId?: string;
350
- signRequests?: {
351
- requestId?: {
352
- [key: string]: unknown;
353
- };
354
- status?: {
355
- [key: string]: unknown;
356
- };
357
- fileName?: {
358
- [key: string]: unknown;
359
- };
360
- fileUrl?: {
361
- [key: string]: unknown;
362
- };
363
- signedFileUrl?: {
364
- [key: string]: unknown;
365
- };
366
- metadata?: {
367
- [key: string]: unknown;
368
- };
369
- clientReferenceId?: {
331
+ signRequestsCount: number;
332
+ signRequests: {
333
+ requestId: string;
334
+ /** @enum {string} */
335
+ status: "pending" | "completed" | "canceled" | "queued";
336
+ fileName: string;
337
+ fileUrl: string;
338
+ signedFileUrl?: string;
339
+ metadata: {
370
340
  [key: string]: unknown;
371
341
  };
342
+ clientReferenceId?: string;
372
343
  }[];
373
- createdAt?: {
374
- toDateString?: {
375
- [key: string]: unknown;
376
- };
377
- toTimeString?: {
378
- [key: string]: unknown;
379
- };
380
- toLocaleDateString?: {
381
- [key: string]: unknown;
382
- };
383
- toLocaleTimeString?: {
384
- [key: string]: unknown;
385
- };
386
- getTime?: {
387
- [key: string]: unknown;
388
- };
389
- getFullYear?: {
390
- [key: string]: unknown;
391
- };
392
- getUTCFullYear?: {
393
- [key: string]: unknown;
394
- };
395
- getMonth?: {
396
- [key: string]: unknown;
397
- };
398
- getUTCMonth?: {
399
- [key: string]: unknown;
400
- };
401
- getDate?: {
402
- [key: string]: unknown;
403
- };
404
- getUTCDate?: {
405
- [key: string]: unknown;
406
- };
407
- getDay?: {
408
- [key: string]: unknown;
409
- };
410
- getUTCDay?: {
411
- [key: string]: unknown;
412
- };
413
- getHours?: {
414
- [key: string]: unknown;
415
- };
416
- getUTCHours?: {
417
- [key: string]: unknown;
418
- };
419
- getMinutes?: {
420
- [key: string]: unknown;
421
- };
422
- getUTCMinutes?: {
423
- [key: string]: unknown;
424
- };
425
- getSeconds?: {
426
- [key: string]: unknown;
427
- };
428
- getUTCSeconds?: {
429
- [key: string]: unknown;
430
- };
431
- getMilliseconds?: {
432
- [key: string]: unknown;
433
- };
434
- getUTCMilliseconds?: {
435
- [key: string]: unknown;
436
- };
437
- getTimezoneOffset?: {
438
- [key: string]: unknown;
439
- };
440
- setTime?: {
441
- [key: string]: unknown;
442
- };
443
- setMilliseconds?: {
444
- [key: string]: unknown;
445
- };
446
- setUTCMilliseconds?: {
447
- [key: string]: unknown;
448
- };
449
- setSeconds?: {
450
- [key: string]: unknown;
451
- };
452
- setUTCSeconds?: {
453
- [key: string]: unknown;
454
- };
455
- setMinutes?: {
456
- [key: string]: unknown;
457
- };
458
- setUTCMinutes?: {
459
- [key: string]: unknown;
460
- };
461
- setHours?: {
462
- [key: string]: unknown;
463
- };
464
- setUTCHours?: {
465
- [key: string]: unknown;
466
- };
467
- setDate?: {
468
- [key: string]: unknown;
469
- };
470
- setUTCDate?: {
471
- [key: string]: unknown;
472
- };
473
- setMonth?: {
474
- [key: string]: unknown;
475
- };
476
- setUTCMonth?: {
477
- [key: string]: unknown;
478
- };
479
- setFullYear?: {
480
- [key: string]: unknown;
481
- };
482
- setUTCFullYear?: {
483
- [key: string]: unknown;
484
- };
485
- toUTCString?: {
486
- [key: string]: unknown;
487
- };
488
- toISOString?: {
489
- [key: string]: unknown;
490
- };
491
- toJSON?: {
492
- [key: string]: unknown;
493
- };
494
- getVarDate?: {
495
- [key: string]: unknown;
496
- };
497
- };
498
- updatedAt?: {
499
- toDateString?: {
500
- [key: string]: unknown;
501
- };
502
- toTimeString?: {
503
- [key: string]: unknown;
504
- };
505
- toLocaleDateString?: {
506
- [key: string]: unknown;
507
- };
508
- toLocaleTimeString?: {
509
- [key: string]: unknown;
510
- };
511
- getTime?: {
512
- [key: string]: unknown;
513
- };
514
- getFullYear?: {
515
- [key: string]: unknown;
516
- };
517
- getUTCFullYear?: {
518
- [key: string]: unknown;
519
- };
520
- getMonth?: {
521
- [key: string]: unknown;
522
- };
523
- getUTCMonth?: {
524
- [key: string]: unknown;
525
- };
526
- getDate?: {
527
- [key: string]: unknown;
528
- };
529
- getUTCDate?: {
530
- [key: string]: unknown;
531
- };
532
- getDay?: {
533
- [key: string]: unknown;
534
- };
535
- getUTCDay?: {
536
- [key: string]: unknown;
537
- };
538
- getHours?: {
539
- [key: string]: unknown;
540
- };
541
- getUTCHours?: {
542
- [key: string]: unknown;
543
- };
544
- getMinutes?: {
545
- [key: string]: unknown;
546
- };
547
- getUTCMinutes?: {
548
- [key: string]: unknown;
549
- };
550
- getSeconds?: {
551
- [key: string]: unknown;
552
- };
553
- getUTCSeconds?: {
554
- [key: string]: unknown;
555
- };
556
- getMilliseconds?: {
557
- [key: string]: unknown;
558
- };
559
- getUTCMilliseconds?: {
560
- [key: string]: unknown;
561
- };
562
- getTimezoneOffset?: {
563
- [key: string]: unknown;
564
- };
565
- setTime?: {
566
- [key: string]: unknown;
567
- };
568
- setMilliseconds?: {
569
- [key: string]: unknown;
570
- };
571
- setUTCMilliseconds?: {
572
- [key: string]: unknown;
573
- };
574
- setSeconds?: {
575
- [key: string]: unknown;
576
- };
577
- setUTCSeconds?: {
578
- [key: string]: unknown;
579
- };
580
- setMinutes?: {
581
- [key: string]: unknown;
582
- };
583
- setUTCMinutes?: {
584
- [key: string]: unknown;
585
- };
586
- setHours?: {
587
- [key: string]: unknown;
588
- };
589
- setUTCHours?: {
590
- [key: string]: unknown;
591
- };
592
- setDate?: {
593
- [key: string]: unknown;
594
- };
595
- setUTCDate?: {
596
- [key: string]: unknown;
597
- };
598
- setMonth?: {
599
- [key: string]: unknown;
600
- };
601
- setUTCMonth?: {
602
- [key: string]: unknown;
603
- };
604
- setFullYear?: {
605
- [key: string]: unknown;
606
- };
607
- setUTCFullYear?: {
608
- [key: string]: unknown;
609
- };
610
- toUTCString?: {
611
- [key: string]: unknown;
612
- };
613
- toISOString?: {
614
- [key: string]: unknown;
615
- };
616
- toJSON?: {
617
- [key: string]: unknown;
618
- };
619
- getVarDate?: {
620
- [key: string]: unknown;
621
- };
622
- };
623
- expirationDate?: {
624
- toDateString?: {
625
- [key: string]: unknown;
626
- };
627
- toTimeString?: {
628
- [key: string]: unknown;
629
- };
630
- toLocaleDateString?: {
631
- [key: string]: unknown;
632
- };
633
- toLocaleTimeString?: {
634
- [key: string]: unknown;
635
- };
636
- getTime?: {
637
- [key: string]: unknown;
638
- };
639
- getFullYear?: {
640
- [key: string]: unknown;
641
- };
642
- getUTCFullYear?: {
643
- [key: string]: unknown;
644
- };
645
- getMonth?: {
646
- [key: string]: unknown;
647
- };
648
- getUTCMonth?: {
649
- [key: string]: unknown;
650
- };
651
- getDate?: {
652
- [key: string]: unknown;
653
- };
654
- getUTCDate?: {
655
- [key: string]: unknown;
656
- };
657
- getDay?: {
658
- [key: string]: unknown;
659
- };
660
- getUTCDay?: {
661
- [key: string]: unknown;
662
- };
663
- getHours?: {
664
- [key: string]: unknown;
665
- };
666
- getUTCHours?: {
667
- [key: string]: unknown;
668
- };
669
- getMinutes?: {
670
- [key: string]: unknown;
671
- };
672
- getUTCMinutes?: {
673
- [key: string]: unknown;
674
- };
675
- getSeconds?: {
676
- [key: string]: unknown;
677
- };
678
- getUTCSeconds?: {
679
- [key: string]: unknown;
680
- };
681
- getMilliseconds?: {
682
- [key: string]: unknown;
683
- };
684
- getUTCMilliseconds?: {
685
- [key: string]: unknown;
686
- };
687
- getTimezoneOffset?: {
688
- [key: string]: unknown;
689
- };
690
- setTime?: {
691
- [key: string]: unknown;
692
- };
693
- setMilliseconds?: {
694
- [key: string]: unknown;
695
- };
696
- setUTCMilliseconds?: {
697
- [key: string]: unknown;
698
- };
699
- setSeconds?: {
700
- [key: string]: unknown;
701
- };
702
- setUTCSeconds?: {
703
- [key: string]: unknown;
704
- };
705
- setMinutes?: {
706
- [key: string]: unknown;
707
- };
708
- setUTCMinutes?: {
709
- [key: string]: unknown;
710
- };
711
- setHours?: {
712
- [key: string]: unknown;
713
- };
714
- setUTCHours?: {
715
- [key: string]: unknown;
716
- };
717
- setDate?: {
718
- [key: string]: unknown;
719
- };
720
- setUTCDate?: {
721
- [key: string]: unknown;
722
- };
723
- setMonth?: {
724
- [key: string]: unknown;
725
- };
726
- setUTCMonth?: {
727
- [key: string]: unknown;
728
- };
729
- setFullYear?: {
730
- [key: string]: unknown;
731
- };
732
- setUTCFullYear?: {
733
- [key: string]: unknown;
734
- };
735
- toUTCString?: {
736
- [key: string]: unknown;
737
- };
738
- toISOString?: {
739
- [key: string]: unknown;
740
- };
741
- toJSON?: {
742
- [key: string]: unknown;
743
- };
744
- getVarDate?: {
745
- [key: string]: unknown;
746
- };
747
- };
344
+ /** Format: date-time */
345
+ createdAt: string;
346
+ /** Format: date-time */
347
+ updatedAt: string;
348
+ /** Format: date-time */
349
+ expirationDate?: string;
350
+ signUrl?: string;
748
351
  }[];
749
352
  };
750
353
  };
@@ -757,7 +360,7 @@ export interface paths {
757
360
  patch?: never;
758
361
  trace?: never;
759
362
  };
760
- "/functions/removeSignRequestFromEnvelope": {
363
+ "/functions/envelope:remove-sign-request": {
761
364
  parameters: {
762
365
  query?: never;
763
366
  header?: never;
@@ -766,7 +369,7 @@ export interface paths {
766
369
  };
767
370
  get?: never;
768
371
  put?: never;
769
- /** Cloud Function: removeSignRequestFromEnvelope */
372
+ /** envelope:remove-sign-request */
770
373
  post: {
771
374
  parameters: {
772
375
  query?: never;
@@ -777,9 +380,7 @@ export interface paths {
777
380
  requestBody?: {
778
381
  content: {
779
382
  "application/json": {
780
- /** @description The unique identifier of the envelope */
781
383
  envelopeId: string;
782
- /** @description The unique identifier of the sign request */
783
384
  requestId: string;
784
385
  };
785
386
  };
@@ -792,9 +393,9 @@ export interface paths {
792
393
  };
793
394
  content: {
794
395
  "application/json": {
795
- result?: {
796
- success?: boolean;
797
- message?: string;
396
+ result: {
397
+ success: boolean;
398
+ message: string;
798
399
  };
799
400
  };
800
401
  };
@@ -807,7 +408,7 @@ export interface paths {
807
408
  patch?: never;
808
409
  trace?: never;
809
410
  };
810
- "/functions/updateEnvelopeMetadata": {
411
+ "/functions/envelope:update-metadata": {
811
412
  parameters: {
812
413
  query?: never;
813
414
  header?: never;
@@ -816,7 +417,7 @@ export interface paths {
816
417
  };
817
418
  get?: never;
818
419
  put?: never;
819
- /** Cloud Function: updateEnvelopeMetadata */
420
+ /** envelope:update-metadata */
820
421
  post: {
821
422
  parameters: {
822
423
  query?: never;
@@ -827,9 +428,7 @@ export interface paths {
827
428
  requestBody?: {
828
429
  content: {
829
430
  "application/json": {
830
- /** @description The unique identifier of the envelope */
831
431
  envelopeId: string;
832
- /** @description The metadata to be merged into the existing envelope metadata */
833
432
  metadata: {
834
433
  [key: string]: unknown;
835
434
  };
@@ -844,9 +443,9 @@ export interface paths {
844
443
  };
845
444
  content: {
846
445
  "application/json": {
847
- result?: {
848
- envelopeId?: string;
849
- metadata?: {
446
+ result: {
447
+ envelopeId: string;
448
+ metadata: {
850
449
  [key: string]: unknown;
851
450
  };
852
451
  };
@@ -861,7 +460,7 @@ export interface paths {
861
460
  patch?: never;
862
461
  trace?: never;
863
462
  };
864
- "/functions/completeSignRequest": {
463
+ "/functions/sign-request:complete": {
865
464
  parameters: {
866
465
  query?: never;
867
466
  header?: never;
@@ -870,7 +469,7 @@ export interface paths {
870
469
  };
871
470
  get?: never;
872
471
  put?: never;
873
- /** Cloud Function: completeSignRequest */
472
+ /** sign-request:complete */
874
473
  post: {
875
474
  parameters: {
876
475
  query?: never;
@@ -881,9 +480,7 @@ export interface paths {
881
480
  requestBody?: {
882
481
  content: {
883
482
  "application/json": {
884
- /** @description The unique identifier of the sign request to complete */
885
483
  requestId: string;
886
- /** @description The base64 encoded content of the signed file */
887
484
  signedFileDataBase64: string;
888
485
  };
889
486
  };
@@ -896,8 +493,8 @@ export interface paths {
896
493
  };
897
494
  content: {
898
495
  "application/json": {
899
- result?: {
900
- signedFileUrl?: string;
496
+ result: {
497
+ signedFileUrl: string;
901
498
  };
902
499
  };
903
500
  };
@@ -910,7 +507,7 @@ export interface paths {
910
507
  patch?: never;
911
508
  trace?: never;
912
509
  };
913
- "/functions/createSignRequest": {
510
+ "/functions/sign-request:create": {
914
511
  parameters: {
915
512
  query?: never;
916
513
  header?: never;
@@ -919,7 +516,7 @@ export interface paths {
919
516
  };
920
517
  get?: never;
921
518
  put?: never;
922
- /** Cloud Function: createSignRequest */
519
+ /** sign-request:create */
923
520
  post: {
924
521
  parameters: {
925
522
  query?: never;
@@ -930,16 +527,15 @@ export interface paths {
930
527
  requestBody?: {
931
528
  content: {
932
529
  "application/json": {
933
- /** @description The name of the file to be signed */
934
530
  filename: string;
935
- /** @description The base64 encoded content of the file */
936
531
  base64File?: string;
937
- /** @description Remote URL of the file. MUST be publicly accessible. */
938
532
  fileUrl?: string;
939
- /** @description Associated metadata for the sign request */
940
533
  metadata?: {
941
534
  [key: string]: unknown;
942
535
  };
536
+ clientReferenceId?: string;
537
+ /** Format: date-time */
538
+ expirationDate?: string;
943
539
  };
944
540
  };
945
541
  };
@@ -951,9 +547,9 @@ export interface paths {
951
547
  };
952
548
  content: {
953
549
  "application/json": {
954
- result?: {
955
- requestId?: string;
956
- signUrl?: string;
550
+ result: {
551
+ requestId: string;
552
+ signUrl: string;
957
553
  };
958
554
  };
959
555
  };
@@ -966,7 +562,7 @@ export interface paths {
966
562
  patch?: never;
967
563
  trace?: never;
968
564
  };
969
- "/functions/getFileFromRequestId": {
565
+ "/functions/sign-request:get": {
970
566
  parameters: {
971
567
  query?: never;
972
568
  header?: never;
@@ -975,7 +571,7 @@ export interface paths {
975
571
  };
976
572
  get?: never;
977
573
  put?: never;
978
- /** Cloud Function: getFileFromRequestId */
574
+ /** sign-request:get */
979
575
  post: {
980
576
  parameters: {
981
577
  query?: never;
@@ -986,7 +582,6 @@ export interface paths {
986
582
  requestBody?: {
987
583
  content: {
988
584
  "application/json": {
989
- /** @description The unique identifier of the sign request */
990
585
  requestId: string;
991
586
  };
992
587
  };
@@ -999,64 +594,21 @@ export interface paths {
999
594
  };
1000
595
  content: {
1001
596
  "application/json": {
1002
- result?: {
1003
- requestId?: string;
1004
- name?: string;
1005
- originalFile?: string;
597
+ result: {
598
+ requestId: string;
599
+ /** @enum {string} */
600
+ status: "pending" | "completed" | "canceled" | "queued";
601
+ fileName: string;
602
+ originalFile: string;
1006
603
  signedFile?: string;
1007
604
  metadata?: {
1008
605
  [key: string]: unknown;
1009
606
  };
1010
- status?: string;
1011
- };
1012
- };
1013
- };
1014
- };
1015
- };
1016
- };
1017
- delete?: never;
1018
- options?: never;
1019
- head?: never;
1020
- patch?: never;
1021
- trace?: never;
1022
- };
1023
- "/functions/getSignedFile": {
1024
- parameters: {
1025
- query?: never;
1026
- header?: never;
1027
- path?: never;
1028
- cookie?: never;
1029
- };
1030
- get?: never;
1031
- put?: never;
1032
- /** Cloud Function: getSignedFile */
1033
- post: {
1034
- parameters: {
1035
- query?: never;
1036
- header?: never;
1037
- path?: never;
1038
- cookie?: never;
1039
- };
1040
- requestBody?: {
1041
- content: {
1042
- "application/json": {
1043
- /** @description The unique identifier of the sign request */
1044
- requestId: string;
1045
- };
1046
- };
1047
- };
1048
- responses: {
1049
- /** @description Successful response */
1050
- 200: {
1051
- headers: {
1052
- [name: string]: unknown;
1053
- };
1054
- content: {
1055
- "application/json": {
1056
- result?: {
1057
- fileName?: string;
1058
- fileUrl?: string;
1059
- signedFileUrl?: string;
607
+ clientReferenceId?: string;
608
+ /** Format: date-time */
609
+ createdAt: string;
610
+ /** Format: date-time */
611
+ updatedAt: string;
1060
612
  };
1061
613
  };
1062
614
  };
@@ -1069,7 +621,7 @@ export interface paths {
1069
621
  patch?: never;
1070
622
  trace?: never;
1071
623
  };
1072
- "/functions/updateSignRequestMetadata": {
624
+ "/functions/sign-request:update-metadata": {
1073
625
  parameters: {
1074
626
  query?: never;
1075
627
  header?: never;
@@ -1078,7 +630,7 @@ export interface paths {
1078
630
  };
1079
631
  get?: never;
1080
632
  put?: never;
1081
- /** Cloud Function: updateSignRequestMetadata */
633
+ /** sign-request:update-metadata */
1082
634
  post: {
1083
635
  parameters: {
1084
636
  query?: never;
@@ -1089,9 +641,7 @@ export interface paths {
1089
641
  requestBody?: {
1090
642
  content: {
1091
643
  "application/json": {
1092
- /** @description The unique identifier of the sign request */
1093
644
  requestId: string;
1094
- /** @description The metadata to be merged into the existing sign request metadata */
1095
645
  metadata: {
1096
646
  [key: string]: unknown;
1097
647
  };
@@ -1106,9 +656,9 @@ export interface paths {
1106
656
  };
1107
657
  content: {
1108
658
  "application/json": {
1109
- result?: {
1110
- requestId?: string;
1111
- metadata?: {
659
+ result: {
660
+ requestId: string;
661
+ metadata: {
1112
662
  [key: string]: unknown;
1113
663
  };
1114
664
  };
@@ -1126,58 +676,7 @@ export interface paths {
1126
676
  }
1127
677
  export type webhooks = Record<string, never>;
1128
678
  export interface components {
1129
- schemas: {
1130
- ApiLog: {
1131
- apiKey?: string;
1132
- functionName?: string;
1133
- statusCode?: string;
1134
- statusMessage?: string;
1135
- };
1136
- Authentication: {
1137
- apiKey?: string;
1138
- name?: string;
1139
- status?: string;
1140
- expirationDate?: string;
1141
- callbackUrl?: string;
1142
- webhookSecret?: string;
1143
- };
1144
- Envelope: {
1145
- name?: string;
1146
- description?: string;
1147
- envelopeId?: string;
1148
- signRequests?: string;
1149
- status?: string;
1150
- metadata?: string;
1151
- apiKey?: string;
1152
- expirationDate?: string;
1153
- isDeleted?: string;
1154
- clientReferenceId?: string;
1155
- };
1156
- SignRequest: {
1157
- status?: string;
1158
- file?: string;
1159
- fileName?: string;
1160
- signedFile?: string;
1161
- requestId?: string;
1162
- metadata?: string;
1163
- apiKey?: string;
1164
- expirationDate?: string;
1165
- isDeleted?: string;
1166
- clientReferenceId?: string;
1167
- };
1168
- WebhookLog: {
1169
- status?: string;
1170
- message?: string;
1171
- signRequest?: string;
1172
- envelope?: string;
1173
- eventType?: string;
1174
- delivered?: string;
1175
- retryCount?: string;
1176
- nextRetryAt?: string;
1177
- payload?: string;
1178
- apiKey?: string;
1179
- };
1180
- };
679
+ schemas: never;
1181
680
  responses: never;
1182
681
  parameters: never;
1183
682
  requestBodies: never;