@verdocs/js-sdk 5.0.12 → 5.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -169,10 +169,10 @@ interface IUserSession {
169
169
  email: string;
170
170
  iat: number;
171
171
  exp: number;
172
- "https://verdocs.com/session_type": "user";
173
- "https://verdocs.com/profile_id": string;
174
- "https://verdocs.com/organization_id": string;
175
- "https://verdocs.com/global_admin": boolean;
172
+ session_type: "user";
173
+ profile_id: string;
174
+ organization_id: string;
175
+ global_admin: boolean;
176
176
  }
177
177
  interface IIdToken {
178
178
  aud: string;
@@ -635,16 +635,26 @@ interface IRecipient {
635
635
  role_name: string;
636
636
  profile_id: string;
637
637
  status: TRecipientStatus;
638
+ first_name: string;
639
+ last_name: string;
638
640
  email: string;
641
+ /** Phone number for SMS invites */
639
642
  phone?: string | null;
640
643
  full_name?: string | null;
641
- first_name: string;
642
- last_name: string;
644
+ /** Phone number for SMS verification */
645
+ phone_otp?: string | null;
646
+ /** Street address. Only used in KBA workflows. Combine two-line addresses into a single string. */
643
647
  address?: string | null;
648
+ /** Zip code. Only used in KBA workflows. */
644
649
  city?: string | null;
650
+ /** Zip code. Only used in KBA workflows. */
645
651
  state?: string | null;
652
+ /** Zip code. Only used in KBA workflows. */
646
653
  zip?: string | null;
654
+ /** @deprecated. Use dob instead. */
647
655
  ssn_last_4?: string | null;
656
+ /** Date of birth. Only used in KBA workflows. */
657
+ dob?: string | null;
648
658
  /**
649
659
  * The sequence number indicates the order in which Recipients act. Multiple recipients may have the same sequence
650
660
  * number, in which case they may act in parallel. (e.g. all Recipients at sequence 2 will receive invites once
@@ -727,7 +737,8 @@ interface IRole {
727
737
  delegator: boolean | null;
728
738
  /**
729
739
  * If set, "KBA required" will carry through to automatically enable the same setting in Envelopes
730
- * created from this template.
740
+ * created from this template. Note that KBA details may not be specified here. They must be unique to
741
+ * each individual recipient and therefore cannot be set as defaults in the template.
731
742
  */
732
743
  kba_method: TKBAMethod;
733
744
  }
package/dist/index.d.ts CHANGED
@@ -169,10 +169,10 @@ interface IUserSession {
169
169
  email: string;
170
170
  iat: number;
171
171
  exp: number;
172
- "https://verdocs.com/session_type": "user";
173
- "https://verdocs.com/profile_id": string;
174
- "https://verdocs.com/organization_id": string;
175
- "https://verdocs.com/global_admin": boolean;
172
+ session_type: "user";
173
+ profile_id: string;
174
+ organization_id: string;
175
+ global_admin: boolean;
176
176
  }
177
177
  interface IIdToken {
178
178
  aud: string;
@@ -635,16 +635,26 @@ interface IRecipient {
635
635
  role_name: string;
636
636
  profile_id: string;
637
637
  status: TRecipientStatus;
638
+ first_name: string;
639
+ last_name: string;
638
640
  email: string;
641
+ /** Phone number for SMS invites */
639
642
  phone?: string | null;
640
643
  full_name?: string | null;
641
- first_name: string;
642
- last_name: string;
644
+ /** Phone number for SMS verification */
645
+ phone_otp?: string | null;
646
+ /** Street address. Only used in KBA workflows. Combine two-line addresses into a single string. */
643
647
  address?: string | null;
648
+ /** Zip code. Only used in KBA workflows. */
644
649
  city?: string | null;
650
+ /** Zip code. Only used in KBA workflows. */
645
651
  state?: string | null;
652
+ /** Zip code. Only used in KBA workflows. */
646
653
  zip?: string | null;
654
+ /** @deprecated. Use dob instead. */
647
655
  ssn_last_4?: string | null;
656
+ /** Date of birth. Only used in KBA workflows. */
657
+ dob?: string | null;
648
658
  /**
649
659
  * The sequence number indicates the order in which Recipients act. Multiple recipients may have the same sequence
650
660
  * number, in which case they may act in parallel. (e.g. all Recipients at sequence 2 will receive invites once
@@ -727,7 +737,8 @@ interface IRole {
727
737
  delegator: boolean | null;
728
738
  /**
729
739
  * If set, "KBA required" will carry through to automatically enable the same setting in Envelopes
730
- * created from this template.
740
+ * created from this template. Note that KBA details may not be specified here. They must be unique to
741
+ * each individual recipient and therefore cannot be set as defaults in the template.
731
742
  */
732
743
  kba_method: TKBAMethod;
733
744
  }
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@verdocs/js-sdk",
3
- "version": "5.0.12",
3
+ "version": "5.0.14",
4
4
  "private": false,
5
5
  "homepage": "https://github.com/Verdocs/js-sdk",
6
6
  "description": "Isomorphic JS/TS SDK providing types and API wrappers for the Verdocs platform for Node and browser clients",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@verdocs/js-sdk",
3
- "version": "5.0.12",
3
+ "version": "5.0.14",
4
4
  "private": false,
5
5
  "homepage": "https://github.com/Verdocs/js-sdk",
6
6
  "description": "Isomorphic JS/TS SDK providing types and API wrappers for the Verdocs platform for Node and browser clients",