instasign 1.1.3 → 1.1.5

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 +7 -0
  2. package/README.md +9 -5
  3. package/dist/index.cjs +37 -12
  4. package/dist/index.cjs.map +1 -1
  5. package/dist/index.d.cts +214 -142
  6. package/dist/index.d.ts +214 -142
  7. package/dist/index.js +32 -12
  8. package/dist/index.js.map +1 -1
  9. package/package.json +1 -1
  10. package/types/schema.d.ts +137 -119
package/types/schema.d.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  */
5
5
 
6
6
  export interface paths {
7
- "/functions/envelope:add-sign-request": {
7
+ "/functions/envelope:add-sign-requests": {
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
- /** envelope:add-sign-request */
16
+ /** envelope:add-sign-requests */
17
17
  post: {
18
18
  parameters: {
19
19
  query?: never;
@@ -25,12 +25,15 @@ export interface paths {
25
25
  content: {
26
26
  "application/json": {
27
27
  envelopeId: string;
28
- filename: string;
29
- base64File?: string;
30
- fileUrl?: string;
31
- metadata?: {
32
- [key: string]: unknown;
33
- };
28
+ signRequests: {
29
+ filename: string;
30
+ base64File?: string;
31
+ fileUrl?: string;
32
+ metadata?: {
33
+ [key: string]: unknown;
34
+ };
35
+ clientReferenceId?: string;
36
+ }[];
34
37
  };
35
38
  };
36
39
  };
@@ -42,11 +45,7 @@ export interface paths {
42
45
  };
43
46
  content: {
44
47
  "application/json": {
45
- result: {
46
- requestId: string;
47
- signUrl: string;
48
- envelopeSignUrl?: string;
49
- };
48
+ result: components["schemas"]["EnvelopeAddSignRequestsResult"];
50
49
  };
51
50
  };
52
51
  };
@@ -90,10 +89,7 @@ export interface paths {
90
89
  };
91
90
  content: {
92
91
  "application/json": {
93
- result: {
94
- success: boolean;
95
- message: string;
96
- };
92
+ result: components["schemas"]["EnvelopeCompleteResult"];
97
93
  };
98
94
  };
99
95
  };
@@ -144,9 +140,7 @@ export interface paths {
144
140
  };
145
141
  content: {
146
142
  "application/json": {
147
- result: {
148
- envelopeId: string;
149
- };
143
+ result: components["schemas"]["EnvelopeCreateResult"];
150
144
  };
151
145
  };
152
146
  };
@@ -190,9 +184,7 @@ export interface paths {
190
184
  };
191
185
  content: {
192
186
  "application/json": {
193
- result: {
194
- success: boolean;
195
- };
187
+ result: components["schemas"]["EnvelopeDeleteResult"];
196
188
  };
197
189
  };
198
190
  };
@@ -237,34 +229,7 @@ export interface paths {
237
229
  };
238
230
  content: {
239
231
  "application/json": {
240
- result: {
241
- envelopeId: string;
242
- name: string;
243
- description?: string;
244
- /** @enum {string} */
245
- status: "pending" | "in-progress" | "completed" | "cancelled";
246
- clientReferenceId?: string;
247
- signRequestsCount: number;
248
- signRequests: {
249
- requestId: string;
250
- /** @enum {string} */
251
- status: "pending" | "completed" | "canceled" | "queued";
252
- fileName: string;
253
- fileUrl: string;
254
- signedFileUrl?: string;
255
- metadata: {
256
- [key: string]: unknown;
257
- };
258
- clientReferenceId?: string;
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;
267
- };
232
+ result: components["schemas"]["EnvelopeGetResult"];
268
233
  };
269
234
  };
270
235
  };
@@ -321,34 +286,7 @@ export interface paths {
321
286
  };
322
287
  content: {
323
288
  "application/json": {
324
- result: {
325
- envelopeId: string;
326
- name: string;
327
- description?: string;
328
- /** @enum {string} */
329
- status: "pending" | "in-progress" | "completed" | "cancelled";
330
- clientReferenceId?: string;
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: {
340
- [key: string]: unknown;
341
- };
342
- clientReferenceId?: string;
343
- }[];
344
- /** Format: date-time */
345
- createdAt: string;
346
- /** Format: date-time */
347
- updatedAt: string;
348
- /** Format: date-time */
349
- expirationDate?: string;
350
- signUrl?: string;
351
- }[];
289
+ result: components["schemas"]["EnvelopeListResult"][];
352
290
  };
353
291
  };
354
292
  };
@@ -393,10 +331,7 @@ export interface paths {
393
331
  };
394
332
  content: {
395
333
  "application/json": {
396
- result: {
397
- success: boolean;
398
- message: string;
399
- };
334
+ result: components["schemas"]["EnvelopeRemoveSignRequestResult"];
400
335
  };
401
336
  };
402
337
  };
@@ -443,12 +378,7 @@ export interface paths {
443
378
  };
444
379
  content: {
445
380
  "application/json": {
446
- result: {
447
- envelopeId: string;
448
- metadata: {
449
- [key: string]: unknown;
450
- };
451
- };
381
+ result: components["schemas"]["EnvelopeUpdateMetadataResult"];
452
382
  };
453
383
  };
454
384
  };
@@ -493,9 +423,7 @@ export interface paths {
493
423
  };
494
424
  content: {
495
425
  "application/json": {
496
- result: {
497
- signedFileUrl: string;
498
- };
426
+ result: components["schemas"]["SignRequestCompleteResult"];
499
427
  };
500
428
  };
501
429
  };
@@ -547,10 +475,7 @@ export interface paths {
547
475
  };
548
476
  content: {
549
477
  "application/json": {
550
- result: {
551
- requestId: string;
552
- signUrl: string;
553
- };
478
+ result: components["schemas"]["SignRequestCreateResult"];
554
479
  };
555
480
  };
556
481
  };
@@ -594,22 +519,7 @@ export interface paths {
594
519
  };
595
520
  content: {
596
521
  "application/json": {
597
- result: {
598
- requestId: string;
599
- /** @enum {string} */
600
- status: "pending" | "completed" | "canceled" | "queued";
601
- fileName: string;
602
- originalFile: string;
603
- signedFile?: string;
604
- metadata?: {
605
- [key: string]: unknown;
606
- };
607
- clientReferenceId?: string;
608
- /** Format: date-time */
609
- createdAt: string;
610
- /** Format: date-time */
611
- updatedAt: string;
612
- };
522
+ result: components["schemas"]["SignRequestGetResult"];
613
523
  };
614
524
  };
615
525
  };
@@ -656,12 +566,7 @@ export interface paths {
656
566
  };
657
567
  content: {
658
568
  "application/json": {
659
- result: {
660
- requestId: string;
661
- metadata: {
662
- [key: string]: unknown;
663
- };
664
- };
569
+ result: components["schemas"]["SignRequestUpdateMetadataResult"];
665
570
  };
666
571
  };
667
572
  };
@@ -676,7 +581,120 @@ export interface paths {
676
581
  }
677
582
  export type webhooks = Record<string, never>;
678
583
  export interface components {
679
- schemas: never;
584
+ schemas: {
585
+ EnvelopeAddSignRequestsResult: {
586
+ signRequests: {
587
+ requestId: string;
588
+ signUrl: string;
589
+ }[];
590
+ envelopeSignUrl?: string;
591
+ };
592
+ EnvelopeCompleteResult: {
593
+ success: boolean;
594
+ message: string;
595
+ };
596
+ EnvelopeCreateResult: {
597
+ envelopeId: string;
598
+ };
599
+ EnvelopeDeleteResult: {
600
+ success: boolean;
601
+ };
602
+ EnvelopeGetResult: {
603
+ envelopeId: string;
604
+ name: string;
605
+ description?: string;
606
+ /** @enum {string} */
607
+ status: "pending" | "in-progress" | "completed" | "cancelled";
608
+ clientReferenceId?: string;
609
+ signRequestsCount: number;
610
+ signRequests: {
611
+ requestId: string;
612
+ /** @enum {string} */
613
+ status: "pending" | "completed" | "canceled" | "queued";
614
+ fileName: string;
615
+ fileUrl: string;
616
+ signedFileUrl?: string;
617
+ metadata: {
618
+ [key: string]: unknown;
619
+ };
620
+ clientReferenceId?: string;
621
+ }[];
622
+ /** Format: date-time */
623
+ createdAt: string;
624
+ /** Format: date-time */
625
+ updatedAt: string;
626
+ /** Format: date-time */
627
+ expirationDate?: string;
628
+ signUrl?: string;
629
+ };
630
+ EnvelopeListResult: {
631
+ envelopeId: string;
632
+ name: string;
633
+ description?: string;
634
+ /** @enum {string} */
635
+ status: "pending" | "in-progress" | "completed" | "cancelled";
636
+ clientReferenceId?: string;
637
+ signRequestsCount: number;
638
+ signRequests: {
639
+ requestId: string;
640
+ /** @enum {string} */
641
+ status: "pending" | "completed" | "canceled" | "queued";
642
+ fileName: string;
643
+ fileUrl: string;
644
+ signedFileUrl?: string;
645
+ metadata: {
646
+ [key: string]: unknown;
647
+ };
648
+ clientReferenceId?: string;
649
+ }[];
650
+ /** Format: date-time */
651
+ createdAt: string;
652
+ /** Format: date-time */
653
+ updatedAt: string;
654
+ /** Format: date-time */
655
+ expirationDate?: string;
656
+ signUrl?: string;
657
+ };
658
+ EnvelopeRemoveSignRequestResult: {
659
+ success: boolean;
660
+ message: string;
661
+ };
662
+ EnvelopeUpdateMetadataResult: {
663
+ envelopeId: string;
664
+ metadata: {
665
+ [key: string]: unknown;
666
+ };
667
+ };
668
+ SignRequestCompleteResult: {
669
+ signedFileUrl: string;
670
+ };
671
+ SignRequestCreateResult: {
672
+ requestId: string;
673
+ signUrl: string;
674
+ };
675
+ SignRequestGetResult: {
676
+ requestId: string;
677
+ /** @enum {string} */
678
+ status: "pending" | "completed" | "canceled" | "queued";
679
+ fileName: string;
680
+ originalFile: string;
681
+ signedFile?: string;
682
+ metadata?: {
683
+ [key: string]: unknown;
684
+ };
685
+ clientReferenceId?: string;
686
+ /** Format: date-time */
687
+ createdAt: string;
688
+ /** Format: date-time */
689
+ updatedAt: string;
690
+ };
691
+ SignRequestUpdateMetadataResult: {
692
+ requestId: string;
693
+ metadata: {
694
+ [key: string]: unknown;
695
+ };
696
+ };
697
+ };
680
698
  responses: never;
681
699
  parameters: never;
682
700
  requestBodies: never;