instasign 1.1.2 → 1.1.4

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 +16 -0
  2. package/README.md +16 -9
  3. package/dist/index.cjs +50 -17
  4. package/dist/index.cjs.map +1 -1
  5. package/dist/index.d.cts +321 -855
  6. package/dist/index.d.ts +321 -855
  7. package/dist/index.js +45 -19
  8. package/dist/index.js.map +1 -1
  9. package/package.json +1 -1
  10. package/types/schema.d.ts +149 -637
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,11 +42,7 @@ export interface paths {
47
42
  };
48
43
  content: {
49
44
  "application/json": {
50
- result?: {
51
- requestId?: string;
52
- signUrl?: string;
53
- envelopeSignUrl?: string;
54
- };
45
+ result: components["schemas"]["EnvelopeAddSignRequestResult"];
55
46
  };
56
47
  };
57
48
  };
@@ -63,7 +54,7 @@ export interface paths {
63
54
  patch?: never;
64
55
  trace?: never;
65
56
  };
66
- "/functions/completeEnvelope": {
57
+ "/functions/envelope:complete": {
67
58
  parameters: {
68
59
  query?: never;
69
60
  header?: never;
@@ -72,7 +63,7 @@ export interface paths {
72
63
  };
73
64
  get?: never;
74
65
  put?: never;
75
- /** Cloud Function: completeEnvelope */
66
+ /** envelope:complete */
76
67
  post: {
77
68
  parameters: {
78
69
  query?: never;
@@ -83,7 +74,6 @@ export interface paths {
83
74
  requestBody?: {
84
75
  content: {
85
76
  "application/json": {
86
- /** @description The unique identifier of the envelope to mark as completed */
87
77
  envelopeId: string;
88
78
  };
89
79
  };
@@ -96,10 +86,7 @@ export interface paths {
96
86
  };
97
87
  content: {
98
88
  "application/json": {
99
- result?: {
100
- success?: boolean;
101
- message?: string;
102
- };
89
+ result: components["schemas"]["EnvelopeCompleteResult"];
103
90
  };
104
91
  };
105
92
  };
@@ -111,7 +98,7 @@ export interface paths {
111
98
  patch?: never;
112
99
  trace?: never;
113
100
  };
114
- "/functions/createEnvelope": {
101
+ "/functions/envelope:create": {
115
102
  parameters: {
116
103
  query?: never;
117
104
  header?: never;
@@ -120,7 +107,7 @@ export interface paths {
120
107
  };
121
108
  get?: never;
122
109
  put?: never;
123
- /** Cloud Function: createEnvelope */
110
+ /** envelope:create */
124
111
  post: {
125
112
  parameters: {
126
113
  query?: never;
@@ -131,20 +118,13 @@ export interface paths {
131
118
  requestBody?: {
132
119
  content: {
133
120
  "application/json": {
134
- /** @description The name of the envelope */
135
121
  name: string;
136
- /** @description The description of the envelope */
137
122
  description?: string;
138
- /** @description Associated metadata for the envelope */
139
123
  metadata?: {
140
124
  [key: string]: unknown;
141
125
  };
142
- /**
143
- * Format: date-time
144
- * @description The expiration date of the envelope
145
- */
126
+ /** Format: date-time */
146
127
  expirationDate?: string;
147
- /** @description External reference ID for the client */
148
128
  clientReferenceId?: string;
149
129
  };
150
130
  };
@@ -157,9 +137,7 @@ export interface paths {
157
137
  };
158
138
  content: {
159
139
  "application/json": {
160
- result?: {
161
- envelopeId?: string;
162
- };
140
+ result: components["schemas"]["EnvelopeCreateResult"];
163
141
  };
164
142
  };
165
143
  };
@@ -171,7 +149,7 @@ export interface paths {
171
149
  patch?: never;
172
150
  trace?: never;
173
151
  };
174
- "/functions/deleteEnvelope": {
152
+ "/functions/envelope:delete": {
175
153
  parameters: {
176
154
  query?: never;
177
155
  header?: never;
@@ -180,7 +158,7 @@ export interface paths {
180
158
  };
181
159
  get?: never;
182
160
  put?: never;
183
- /** Cloud Function: deleteEnvelope */
161
+ /** envelope:delete */
184
162
  post: {
185
163
  parameters: {
186
164
  query?: never;
@@ -191,7 +169,6 @@ export interface paths {
191
169
  requestBody?: {
192
170
  content: {
193
171
  "application/json": {
194
- /** @description The unique identifier of the envelope to delete */
195
172
  envelopeId: string;
196
173
  };
197
174
  };
@@ -204,9 +181,7 @@ export interface paths {
204
181
  };
205
182
  content: {
206
183
  "application/json": {
207
- result?: {
208
- success?: boolean;
209
- };
184
+ result: components["schemas"]["EnvelopeDeleteResult"];
210
185
  };
211
186
  };
212
187
  };
@@ -218,7 +193,7 @@ export interface paths {
218
193
  patch?: never;
219
194
  trace?: never;
220
195
  };
221
- "/functions/getEnvelope": {
196
+ "/functions/envelope:get": {
222
197
  parameters: {
223
198
  query?: never;
224
199
  header?: never;
@@ -227,7 +202,7 @@ export interface paths {
227
202
  };
228
203
  get?: never;
229
204
  put?: never;
230
- /** Cloud Function: getEnvelope */
205
+ /** envelope:get */
231
206
  post: {
232
207
  parameters: {
233
208
  query?: never;
@@ -238,8 +213,8 @@ export interface paths {
238
213
  requestBody?: {
239
214
  content: {
240
215
  "application/json": {
241
- /** @description The unique identifier of the envelope */
242
216
  envelopeId: string;
217
+ includeSignRequests?: boolean;
243
218
  };
244
219
  };
245
220
  };
@@ -251,29 +226,7 @@ export interface paths {
251
226
  };
252
227
  content: {
253
228
  "application/json": {
254
- result?: {
255
- signUrl?: string;
256
- envelopeId?: string;
257
- name?: string;
258
- description?: string;
259
- status?: {
260
- [key: string]: unknown;
261
- };
262
- clientReferenceId?: string;
263
- signRequests?: {
264
- requestId?: string;
265
- status?: {
266
- [key: string]: unknown;
267
- };
268
- fileName?: string;
269
- fileUrl?: string;
270
- signedFileUrl?: string;
271
- metadata?: {
272
- [key: string]: unknown;
273
- };
274
- clientReferenceId?: string;
275
- }[];
276
- };
229
+ result: components["schemas"]["EnvelopeGetResult"];
277
230
  };
278
231
  };
279
232
  };
@@ -285,7 +238,7 @@ export interface paths {
285
238
  patch?: never;
286
239
  trace?: never;
287
240
  };
288
- "/functions/getEnvelopes": {
241
+ "/functions/envelope:list": {
289
242
  parameters: {
290
243
  query?: never;
291
244
  header?: never;
@@ -294,7 +247,7 @@ export interface paths {
294
247
  };
295
248
  get?: never;
296
249
  put?: never;
297
- /** Cloud Function: getEnvelopes */
250
+ /** envelope:list */
298
251
  post: {
299
252
  parameters: {
300
253
  query?: never;
@@ -305,28 +258,20 @@ export interface paths {
305
258
  requestBody?: {
306
259
  content: {
307
260
  "application/json": {
308
- /** @description Filter by envelope name (case-insensitive regex) */
309
261
  name?: string;
310
- /** @description Filter by envelope status */
311
- status?: string;
312
- /** @description Filter by client reference ID */
262
+ /** @enum {string} */
263
+ status?: "pending" | "in-progress" | "completed" | "cancelled";
313
264
  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 */
265
+ signRequests?: string[];
266
+ /** @enum {string} */
267
+ orderBy?: "updatedAt" | "createdAt";
268
+ /** @enum {string} */
269
+ orderDirection?: "asc" | "desc";
323
270
  expirationDateStart?: string;
324
- /** @description Filter by expiration date less than or equal to */
325
271
  expirationDateEnd?: string;
326
- /** @description Number of items to skip for pagination */
327
272
  skip?: number;
328
- /** @description Maximum number of items to return */
329
273
  limit?: number;
274
+ includeSignRequests?: boolean;
330
275
  };
331
276
  };
332
277
  };
@@ -338,414 +283,7 @@ export interface paths {
338
283
  };
339
284
  content: {
340
285
  "application/json": {
341
- result?: {
342
- signUrl?: string;
343
- envelopeId?: string;
344
- name?: string;
345
- description?: string;
346
- status?: {
347
- [key: string]: unknown;
348
- };
349
- 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?: {
370
- [key: string]: unknown;
371
- };
372
- }[];
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
- };
748
- }[];
286
+ result: components["schemas"]["EnvelopeListResult"][];
749
287
  };
750
288
  };
751
289
  };
@@ -757,7 +295,7 @@ export interface paths {
757
295
  patch?: never;
758
296
  trace?: never;
759
297
  };
760
- "/functions/removeSignRequestFromEnvelope": {
298
+ "/functions/envelope:remove-sign-request": {
761
299
  parameters: {
762
300
  query?: never;
763
301
  header?: never;
@@ -766,7 +304,7 @@ export interface paths {
766
304
  };
767
305
  get?: never;
768
306
  put?: never;
769
- /** Cloud Function: removeSignRequestFromEnvelope */
307
+ /** envelope:remove-sign-request */
770
308
  post: {
771
309
  parameters: {
772
310
  query?: never;
@@ -777,9 +315,7 @@ export interface paths {
777
315
  requestBody?: {
778
316
  content: {
779
317
  "application/json": {
780
- /** @description The unique identifier of the envelope */
781
318
  envelopeId: string;
782
- /** @description The unique identifier of the sign request */
783
319
  requestId: string;
784
320
  };
785
321
  };
@@ -792,10 +328,7 @@ export interface paths {
792
328
  };
793
329
  content: {
794
330
  "application/json": {
795
- result?: {
796
- success?: boolean;
797
- message?: string;
798
- };
331
+ result: components["schemas"]["EnvelopeRemoveSignRequestResult"];
799
332
  };
800
333
  };
801
334
  };
@@ -807,7 +340,7 @@ export interface paths {
807
340
  patch?: never;
808
341
  trace?: never;
809
342
  };
810
- "/functions/updateEnvelopeMetadata": {
343
+ "/functions/envelope:update-metadata": {
811
344
  parameters: {
812
345
  query?: never;
813
346
  header?: never;
@@ -816,7 +349,7 @@ export interface paths {
816
349
  };
817
350
  get?: never;
818
351
  put?: never;
819
- /** Cloud Function: updateEnvelopeMetadata */
352
+ /** envelope:update-metadata */
820
353
  post: {
821
354
  parameters: {
822
355
  query?: never;
@@ -827,9 +360,7 @@ export interface paths {
827
360
  requestBody?: {
828
361
  content: {
829
362
  "application/json": {
830
- /** @description The unique identifier of the envelope */
831
363
  envelopeId: string;
832
- /** @description The metadata to be merged into the existing envelope metadata */
833
364
  metadata: {
834
365
  [key: string]: unknown;
835
366
  };
@@ -844,12 +375,7 @@ export interface paths {
844
375
  };
845
376
  content: {
846
377
  "application/json": {
847
- result?: {
848
- envelopeId?: string;
849
- metadata?: {
850
- [key: string]: unknown;
851
- };
852
- };
378
+ result: components["schemas"]["EnvelopeUpdateMetadataResult"];
853
379
  };
854
380
  };
855
381
  };
@@ -861,7 +387,7 @@ export interface paths {
861
387
  patch?: never;
862
388
  trace?: never;
863
389
  };
864
- "/functions/completeSignRequest": {
390
+ "/functions/sign-request:complete": {
865
391
  parameters: {
866
392
  query?: never;
867
393
  header?: never;
@@ -870,7 +396,7 @@ export interface paths {
870
396
  };
871
397
  get?: never;
872
398
  put?: never;
873
- /** Cloud Function: completeSignRequest */
399
+ /** sign-request:complete */
874
400
  post: {
875
401
  parameters: {
876
402
  query?: never;
@@ -881,9 +407,7 @@ export interface paths {
881
407
  requestBody?: {
882
408
  content: {
883
409
  "application/json": {
884
- /** @description The unique identifier of the sign request to complete */
885
410
  requestId: string;
886
- /** @description The base64 encoded content of the signed file */
887
411
  signedFileDataBase64: string;
888
412
  };
889
413
  };
@@ -896,9 +420,7 @@ export interface paths {
896
420
  };
897
421
  content: {
898
422
  "application/json": {
899
- result?: {
900
- signedFileUrl?: string;
901
- };
423
+ result: components["schemas"]["SignRequestCompleteResult"];
902
424
  };
903
425
  };
904
426
  };
@@ -910,7 +432,7 @@ export interface paths {
910
432
  patch?: never;
911
433
  trace?: never;
912
434
  };
913
- "/functions/createSignRequest": {
435
+ "/functions/sign-request:create": {
914
436
  parameters: {
915
437
  query?: never;
916
438
  header?: never;
@@ -919,7 +441,7 @@ export interface paths {
919
441
  };
920
442
  get?: never;
921
443
  put?: never;
922
- /** Cloud Function: createSignRequest */
444
+ /** sign-request:create */
923
445
  post: {
924
446
  parameters: {
925
447
  query?: never;
@@ -930,16 +452,15 @@ export interface paths {
930
452
  requestBody?: {
931
453
  content: {
932
454
  "application/json": {
933
- /** @description The name of the file to be signed */
934
455
  filename: string;
935
- /** @description The base64 encoded content of the file */
936
456
  base64File?: string;
937
- /** @description Remote URL of the file. MUST be publicly accessible. */
938
457
  fileUrl?: string;
939
- /** @description Associated metadata for the sign request */
940
458
  metadata?: {
941
459
  [key: string]: unknown;
942
460
  };
461
+ clientReferenceId?: string;
462
+ /** Format: date-time */
463
+ expirationDate?: string;
943
464
  };
944
465
  };
945
466
  };
@@ -951,64 +472,7 @@ export interface paths {
951
472
  };
952
473
  content: {
953
474
  "application/json": {
954
- result?: {
955
- requestId?: string;
956
- signUrl?: string;
957
- };
958
- };
959
- };
960
- };
961
- };
962
- };
963
- delete?: never;
964
- options?: never;
965
- head?: never;
966
- patch?: never;
967
- trace?: never;
968
- };
969
- "/functions/getFileFromRequestId": {
970
- parameters: {
971
- query?: never;
972
- header?: never;
973
- path?: never;
974
- cookie?: never;
975
- };
976
- get?: never;
977
- put?: never;
978
- /** Cloud Function: getFileFromRequestId */
979
- post: {
980
- parameters: {
981
- query?: never;
982
- header?: never;
983
- path?: never;
984
- cookie?: never;
985
- };
986
- requestBody?: {
987
- content: {
988
- "application/json": {
989
- /** @description The unique identifier of the sign request */
990
- requestId: string;
991
- };
992
- };
993
- };
994
- responses: {
995
- /** @description Successful response */
996
- 200: {
997
- headers: {
998
- [name: string]: unknown;
999
- };
1000
- content: {
1001
- "application/json": {
1002
- result?: {
1003
- requestId?: string;
1004
- name?: string;
1005
- originalFile?: string;
1006
- signedFile?: string;
1007
- metadata?: {
1008
- [key: string]: unknown;
1009
- };
1010
- status?: string;
1011
- };
475
+ result: components["schemas"]["SignRequestCreateResult"];
1012
476
  };
1013
477
  };
1014
478
  };
@@ -1020,7 +484,7 @@ export interface paths {
1020
484
  patch?: never;
1021
485
  trace?: never;
1022
486
  };
1023
- "/functions/getSignedFile": {
487
+ "/functions/sign-request:get": {
1024
488
  parameters: {
1025
489
  query?: never;
1026
490
  header?: never;
@@ -1029,7 +493,7 @@ export interface paths {
1029
493
  };
1030
494
  get?: never;
1031
495
  put?: never;
1032
- /** Cloud Function: getSignedFile */
496
+ /** sign-request:get */
1033
497
  post: {
1034
498
  parameters: {
1035
499
  query?: never;
@@ -1040,7 +504,6 @@ export interface paths {
1040
504
  requestBody?: {
1041
505
  content: {
1042
506
  "application/json": {
1043
- /** @description The unique identifier of the sign request */
1044
507
  requestId: string;
1045
508
  };
1046
509
  };
@@ -1053,11 +516,7 @@ export interface paths {
1053
516
  };
1054
517
  content: {
1055
518
  "application/json": {
1056
- result?: {
1057
- fileName?: string;
1058
- fileUrl?: string;
1059
- signedFileUrl?: string;
1060
- };
519
+ result: components["schemas"]["SignRequestGetResult"];
1061
520
  };
1062
521
  };
1063
522
  };
@@ -1069,7 +528,7 @@ export interface paths {
1069
528
  patch?: never;
1070
529
  trace?: never;
1071
530
  };
1072
- "/functions/updateSignRequestMetadata": {
531
+ "/functions/sign-request:update-metadata": {
1073
532
  parameters: {
1074
533
  query?: never;
1075
534
  header?: never;
@@ -1078,7 +537,7 @@ export interface paths {
1078
537
  };
1079
538
  get?: never;
1080
539
  put?: never;
1081
- /** Cloud Function: updateSignRequestMetadata */
540
+ /** sign-request:update-metadata */
1082
541
  post: {
1083
542
  parameters: {
1084
543
  query?: never;
@@ -1089,9 +548,7 @@ export interface paths {
1089
548
  requestBody?: {
1090
549
  content: {
1091
550
  "application/json": {
1092
- /** @description The unique identifier of the sign request */
1093
551
  requestId: string;
1094
- /** @description The metadata to be merged into the existing sign request metadata */
1095
552
  metadata: {
1096
553
  [key: string]: unknown;
1097
554
  };
@@ -1106,12 +563,7 @@ export interface paths {
1106
563
  };
1107
564
  content: {
1108
565
  "application/json": {
1109
- result?: {
1110
- requestId?: string;
1111
- metadata?: {
1112
- [key: string]: unknown;
1113
- };
1114
- };
566
+ result: components["schemas"]["SignRequestUpdateMetadataResult"];
1115
567
  };
1116
568
  };
1117
569
  };
@@ -1127,55 +579,115 @@ export interface paths {
1127
579
  export type webhooks = Record<string, never>;
1128
580
  export interface components {
1129
581
  schemas: {
1130
- ApiLog: {
1131
- apiKey?: string;
1132
- functionName?: string;
1133
- statusCode?: string;
1134
- statusMessage?: string;
582
+ EnvelopeAddSignRequestResult: {
583
+ requestId: string;
584
+ signUrl: string;
585
+ envelopeSignUrl?: string;
1135
586
  };
1136
- Authentication: {
1137
- apiKey?: string;
1138
- name?: string;
1139
- status?: string;
1140
- expirationDate?: string;
1141
- callbackUrl?: string;
1142
- webhookSecret?: string;
587
+ EnvelopeCompleteResult: {
588
+ success: boolean;
589
+ message: string;
590
+ };
591
+ EnvelopeCreateResult: {
592
+ envelopeId: string;
1143
593
  };
1144
- Envelope: {
1145
- name?: string;
594
+ EnvelopeDeleteResult: {
595
+ success: boolean;
596
+ };
597
+ EnvelopeGetResult: {
598
+ envelopeId: string;
599
+ name: string;
1146
600
  description?: string;
1147
- envelopeId?: string;
1148
- signRequests?: string;
1149
- status?: string;
1150
- metadata?: string;
1151
- apiKey?: string;
601
+ /** @enum {string} */
602
+ status: "pending" | "in-progress" | "completed" | "cancelled";
603
+ clientReferenceId?: string;
604
+ signRequestsCount: number;
605
+ signRequests: {
606
+ requestId: string;
607
+ /** @enum {string} */
608
+ status: "pending" | "completed" | "canceled" | "queued";
609
+ fileName: string;
610
+ fileUrl: string;
611
+ signedFileUrl?: string;
612
+ metadata: {
613
+ [key: string]: unknown;
614
+ };
615
+ clientReferenceId?: string;
616
+ }[];
617
+ /** Format: date-time */
618
+ createdAt: string;
619
+ /** Format: date-time */
620
+ updatedAt: string;
621
+ /** Format: date-time */
1152
622
  expirationDate?: string;
1153
- isDeleted?: string;
623
+ signUrl?: string;
624
+ };
625
+ EnvelopeListResult: {
626
+ envelopeId: string;
627
+ name: string;
628
+ description?: string;
629
+ /** @enum {string} */
630
+ status: "pending" | "in-progress" | "completed" | "cancelled";
1154
631
  clientReferenceId?: string;
632
+ signRequestsCount: number;
633
+ signRequests: {
634
+ requestId: string;
635
+ /** @enum {string} */
636
+ status: "pending" | "completed" | "canceled" | "queued";
637
+ fileName: string;
638
+ fileUrl: string;
639
+ signedFileUrl?: string;
640
+ metadata: {
641
+ [key: string]: unknown;
642
+ };
643
+ clientReferenceId?: string;
644
+ }[];
645
+ /** Format: date-time */
646
+ createdAt: string;
647
+ /** Format: date-time */
648
+ updatedAt: string;
649
+ /** Format: date-time */
650
+ expirationDate?: string;
651
+ signUrl?: string;
652
+ };
653
+ EnvelopeRemoveSignRequestResult: {
654
+ success: boolean;
655
+ message: string;
1155
656
  };
1156
- SignRequest: {
1157
- status?: string;
1158
- file?: string;
1159
- fileName?: string;
657
+ EnvelopeUpdateMetadataResult: {
658
+ envelopeId: string;
659
+ metadata: {
660
+ [key: string]: unknown;
661
+ };
662
+ };
663
+ SignRequestCompleteResult: {
664
+ signedFileUrl: string;
665
+ };
666
+ SignRequestCreateResult: {
667
+ requestId: string;
668
+ signUrl: string;
669
+ };
670
+ SignRequestGetResult: {
671
+ requestId: string;
672
+ /** @enum {string} */
673
+ status: "pending" | "completed" | "canceled" | "queued";
674
+ fileName: string;
675
+ originalFile: string;
1160
676
  signedFile?: string;
1161
- requestId?: string;
1162
- metadata?: string;
1163
- apiKey?: string;
1164
- expirationDate?: string;
1165
- isDeleted?: string;
677
+ metadata?: {
678
+ [key: string]: unknown;
679
+ };
1166
680
  clientReferenceId?: string;
681
+ /** Format: date-time */
682
+ createdAt: string;
683
+ /** Format: date-time */
684
+ updatedAt: string;
1167
685
  };
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;
686
+ SignRequestUpdateMetadataResult: {
687
+ requestId: string;
688
+ metadata: {
689
+ [key: string]: unknown;
690
+ };
1179
691
  };
1180
692
  };
1181
693
  responses: never;