@verdocs/js-sdk 4.2.5 → 4.2.7

package/dist/index.d.mts

@@ -152,19 +152,16 @@ interface ISigningSessionRequest {
  * A Signing Session connects a caller to a role within an envelope, and can be used only for calls related to signing that envelope.
  */
 interface ISigningSession {
-    profile_id: string;
-    envelope_id: string;
-    role: string;
-    email: string;
-    access_key: {
-        id: string;
-        type: string;
-    };
-    iss: string;
     aud: string;
-    exp: number;
+    iss: string;
+    sub: string; // Verdocs profile_id
+    email: string;
+    email_verified: boolean;
     iat: number;
-    [key: string]: any;
+    exp: number;
+    "https://verdocs.com/session_type": "signing";
+    "https://verdocs.com/envelope_id": string;
+    "https://verdocs.com/role_name": string;
 }
 /**
  * A User Session connects a caller to a Verdocs profile, and can be used for any operations that profile may perform.
@@ -172,11 +169,12 @@ interface ISigningSession {
 interface IUserSession {
     aud: string;
     iss: string;
-    sub: string;
+    sub: string; // Auth0 user_id
     email: string;
     email_verified: boolean;
     iat: number;
     exp: number;
+    "https://verdocs.com/session_type": "user";
     "https://verdocs.com/profile_id": string;
     "https://verdocs.com/organization_id": string;
 }
@@ -1435,11 +1433,11 @@ type TRecipientKbaStep = IRecipientKbaStepNone | IRecipientKbaStepComplete | IRe
  * `recipient.kba_method` is set (not null), and `recipient.kba_completed` is false, this endpoint
  * should be called to determine the next KBA step required.
  */
-declare const getKbaStep: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
+declare const getKbaStep: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
 /**
  * Submit a response to a KBA PIN challenge.
  */
-declare const submitKbaPin: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, pin: string) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
+declare const submitKbaPin: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string, pin: string) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
 interface IKbaIdentity {
     firstName: string;
     lastName: string;
@@ -1452,7 +1450,7 @@ interface IKbaIdentity {
 /**
  * Submit an identity response to a KBA challenge.
  */
-declare const submitKbaIdentity: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, identity: IKbaIdentity) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
+declare const submitKbaIdentity: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string, identity: IKbaIdentity) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
 interface IKbaChallengeResponse {
     responses: {
         type: string;
@@ -1463,7 +1461,7 @@ interface IKbaChallengeResponse {
  * Submit an identity response to a KBA challenge. Answers should be submitted in the same order as
  * the challenges were listed in `IRecipientKbaStepChallenge.questions`.
  */
-declare const submitKbaChallengeResponse: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, response: IKbaChallengeResponse) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
+declare const submitKbaChallengeResponse: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string, response: IKbaChallengeResponse) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
 /**
  * Update a recipient's status block
  */

package/dist/index.d.ts

@@ -152,19 +152,16 @@ interface ISigningSessionRequest {
  * A Signing Session connects a caller to a role within an envelope, and can be used only for calls related to signing that envelope.
  */
 interface ISigningSession {
-    profile_id: string;
-    envelope_id: string;
-    role: string;
-    email: string;
-    access_key: {
-        id: string;
-        type: string;
-    };
-    iss: string;
     aud: string;
-    exp: number;
+    iss: string;
+    sub: string; // Verdocs profile_id
+    email: string;
+    email_verified: boolean;
     iat: number;
-    [key: string]: any;
+    exp: number;
+    "https://verdocs.com/session_type": "signing";
+    "https://verdocs.com/envelope_id": string;
+    "https://verdocs.com/role_name": string;
 }
 /**
  * A User Session connects a caller to a Verdocs profile, and can be used for any operations that profile may perform.
@@ -172,11 +169,12 @@ interface ISigningSession {
 interface IUserSession {
     aud: string;
     iss: string;
-    sub: string;
+    sub: string; // Auth0 user_id
     email: string;
     email_verified: boolean;
     iat: number;
     exp: number;
+    "https://verdocs.com/session_type": "user";
     "https://verdocs.com/profile_id": string;
     "https://verdocs.com/organization_id": string;
 }
@@ -1435,11 +1433,11 @@ type TRecipientKbaStep = IRecipientKbaStepNone | IRecipientKbaStepComplete | IRe
  * `recipient.kba_method` is set (not null), and `recipient.kba_completed` is false, this endpoint
  * should be called to determine the next KBA step required.
  */
-declare const getKbaStep: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
+declare const getKbaStep: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
 /**
  * Submit a response to a KBA PIN challenge.
  */
-declare const submitKbaPin: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, pin: string) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
+declare const submitKbaPin: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string, pin: string) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
 interface IKbaIdentity {
     firstName: string;
     lastName: string;
@@ -1452,7 +1450,7 @@ interface IKbaIdentity {
 /**
  * Submit an identity response to a KBA challenge.
  */
-declare const submitKbaIdentity: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, identity: IKbaIdentity) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
+declare const submitKbaIdentity: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string, identity: IKbaIdentity) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
 interface IKbaChallengeResponse {
     responses: {
         type: string;
@@ -1463,7 +1461,7 @@ interface IKbaChallengeResponse {
  * Submit an identity response to a KBA challenge. Answers should be submitted in the same order as
  * the challenges were listed in `IRecipientKbaStepChallenge.questions`.
  */
-declare const submitKbaChallengeResponse: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, response: IKbaChallengeResponse) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
+declare const submitKbaChallengeResponse: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string, response: IKbaChallengeResponse) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
 /**
  * Update a recipient's status block
  */

package/dist/index.js

@@ -1597,27 +1597,27 @@ const createInitials = (endpoint, name, initials) => {
  * `recipient.kba_method` is set (not null), and `recipient.kba_completed` is false, this endpoint
  * should be called to determine the next KBA step required.
  */
-const getKbaStep = (endpoint, envelopeId, roleName) => endpoint.api //
-    .get(`/v2/kba/${envelopeId}/${encodeURIComponent(roleName)}`)
+const getKbaStep = (endpoint, envelope_id, role_name) => endpoint.api //
+    .get(`/v2/kba/${envelope_id}/${encodeURIComponent(role_name)}`)
     .then((r) => r.data);
 /**
  * Submit a response to a KBA PIN challenge.
  */
-const submitKbaPin = (endpoint, envelopeId, roleName, pin) => endpoint.api //
-    .post(`/v2/kba/pin`, { envelopeId, roleName, pin })
+const submitKbaPin = (endpoint, envelope_id, role_name, pin) => endpoint.api //
+    .post(`/v2/kba/pin`, { envelope_id, role_name, pin })
     .then((r) => r.data);
 /**
  * Submit an identity response to a KBA challenge.
  */
-const submitKbaIdentity = (endpoint, envelopeId, roleName, identity) => endpoint.api //
-    .post(`/v2/kba/identity`, { envelopeId, roleName, identity })
+const submitKbaIdentity = (endpoint, envelope_id, role_name, identity) => endpoint.api //
+    .post(`/v2/kba/identity`, { envelope_id, role_name, identity })
     .then((r) => r.data);
 /**
  * Submit an identity response to a KBA challenge. Answers should be submitted in the same order as
  * the challenges were listed in `IRecipientKbaStepChallenge.questions`.
  */
-const submitKbaChallengeResponse = (endpoint, envelopeId, roleName, response) => endpoint.api //
-    .post(`/v2/kba/response`, { envelopeId, roleName, response })
+const submitKbaChallengeResponse = (endpoint, envelope_id, role_name, response) => endpoint.api //
+    .post(`/v2/kba/response`, { envelope_id, role_name, response })
     .then((r) => r.data);
 
 /**