@verdocs/js-sdk 5.3.3 → 5.3.5

package/dist/index.d.mts

@@ -680,9 +680,9 @@ interface IRecipient {
     /** Last 4 digits of SSN. Only used in KBA workflows. */
     ssn_last_4?: string | null;
     /** The disclosure text the recipient accepted. */
-    disclosure?: string | null;
+    disclosures?: string | null;
     /** Date/time the recipient agreed to their e-signing disclosures. */
-    disclosure_accepted_at?: string | null;
+    disclosures_accepted_at?: string | null;
     /** Date of birth. Only used in KBA workflows. */
     dob?: string | null;
     /**
@@ -1384,7 +1384,7 @@ interface IUpdateRecipientStatus {
 interface IUpdateRecipientAgreedParams {
     action: "update";
     agreed: boolean;
-    disclosure?: string;
+    disclosures?: string;
 }
 interface IUpdateRecipientNameParams {
     action: "update";
@@ -1636,7 +1636,7 @@ type TAuthenticateRecipientRequest = IAuthenticateRecipientViaPasscodeRequest |
  * @group Envelopes
  * @api POST /v2/envelopes Create Envelope
  * @apiBody string(format:uuid) template_id If using a template, the ID of the template to copy
- * @apiBody array(items:ICreateEnvelopeRecipient) recipients A list of recipients to include in the workflow. Must specify one recipient to match each template Role.
+ * @apiBody array(items:ICreateEnvelopeRecipientDirectly) recipients A list of recipients to include in the workflow. Must specify one recipient to match each template Role.
  * @apiBody array(items:IEnvelopeDocument) documents? If not using a template, a list of documents to include in the envelope.
  * @apiBody array(items:IEnvelopeField) fields? If not using a template, a list of fields to include in the envelope.
  * @apiBody string name? Override the name of the envelope (defaults to the template name).
@@ -1976,7 +1976,7 @@ declare const envelopeRecipientChangeOwner: (endpoint: VerdocsEndpoint, envelope
 /**
  * Agree to electronic signing.
  */
-declare const envelopeRecipientAgree: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, agreed: boolean, disclosure?: string) => Promise<IRecipient>;
+declare const envelopeRecipientAgree: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, agreed: boolean, disclosures?: string) => Promise<IRecipient>;
 /**
  * Change a recipient's name.
  */
@@ -2041,6 +2041,7 @@ declare const getInPersonLink: (endpoint: VerdocsEndpoint, envelope_id: string,
  * @apiSuccess ISignerTokenResponse . Updated signing session.
  */
 declare const verifySigner: (endpoint: VerdocsEndpoint, params: TAuthenticateRecipientRequest) => Promise<ISignerTokenResponse>;
+// TODO: Use "oneOf" to describe the unions of these two calls.
 /**
  * Resend a recipient's invitation. NOTE: User interfaces should rate-limit this operation to
  * avoid spamming recipients. Excessive use of this endpoint may result in Verdocs rate-limiting

package/dist/index.d.ts

@@ -680,9 +680,9 @@ interface IRecipient {
     /** Last 4 digits of SSN. Only used in KBA workflows. */
     ssn_last_4?: string | null;
     /** The disclosure text the recipient accepted. */
-    disclosure?: string | null;
+    disclosures?: string | null;
     /** Date/time the recipient agreed to their e-signing disclosures. */
-    disclosure_accepted_at?: string | null;
+    disclosures_accepted_at?: string | null;
     /** Date of birth. Only used in KBA workflows. */
     dob?: string | null;
     /**
@@ -1384,7 +1384,7 @@ interface IUpdateRecipientStatus {
 interface IUpdateRecipientAgreedParams {
     action: "update";
     agreed: boolean;
-    disclosure?: string;
+    disclosures?: string;
 }
 interface IUpdateRecipientNameParams {
     action: "update";
@@ -1636,7 +1636,7 @@ type TAuthenticateRecipientRequest = IAuthenticateRecipientViaPasscodeRequest |
  * @group Envelopes
  * @api POST /v2/envelopes Create Envelope
  * @apiBody string(format:uuid) template_id If using a template, the ID of the template to copy
- * @apiBody array(items:ICreateEnvelopeRecipient) recipients A list of recipients to include in the workflow. Must specify one recipient to match each template Role.
+ * @apiBody array(items:ICreateEnvelopeRecipientDirectly) recipients A list of recipients to include in the workflow. Must specify one recipient to match each template Role.
  * @apiBody array(items:IEnvelopeDocument) documents? If not using a template, a list of documents to include in the envelope.
  * @apiBody array(items:IEnvelopeField) fields? If not using a template, a list of fields to include in the envelope.
  * @apiBody string name? Override the name of the envelope (defaults to the template name).
@@ -1976,7 +1976,7 @@ declare const envelopeRecipientChangeOwner: (endpoint: VerdocsEndpoint, envelope
 /**
  * Agree to electronic signing.
  */
-declare const envelopeRecipientAgree: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, agreed: boolean, disclosure?: string) => Promise<IRecipient>;
+declare const envelopeRecipientAgree: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, agreed: boolean, disclosures?: string) => Promise<IRecipient>;
 /**
  * Change a recipient's name.
  */
@@ -2041,6 +2041,7 @@ declare const getInPersonLink: (endpoint: VerdocsEndpoint, envelope_id: string,
  * @apiSuccess ISignerTokenResponse . Updated signing session.
  */
 declare const verifySigner: (endpoint: VerdocsEndpoint, params: TAuthenticateRecipientRequest) => Promise<ISignerTokenResponse>;
+// TODO: Use "oneOf" to describe the unions of these two calls.
 /**
  * Resend a recipient's invitation. NOTE: User interfaces should rate-limit this operation to
  * avoid spamming recipients. Excessive use of this endpoint may result in Verdocs rate-limiting

package/dist/index.js

@@ -1575,7 +1575,7 @@ class VerdocsEndpoint {
  * @group Envelopes
  * @api POST /v2/envelopes Create Envelope
  * @apiBody string(format:uuid) template_id If using a template, the ID of the template to copy
- * @apiBody array(items:ICreateEnvelopeRecipient) recipients A list of recipients to include in the workflow. Must specify one recipient to match each template Role.
+ * @apiBody array(items:ICreateEnvelopeRecipientDirectly) recipients A list of recipients to include in the workflow. Must specify one recipient to match each template Role.
  * @apiBody array(items:IEnvelopeDocument) documents? If not using a template, a list of documents to include in the envelope.
  * @apiBody array(items:IEnvelopeField) fields? If not using a template, a list of fields to include in the envelope.
  * @apiBody string name? Override the name of the envelope (defaults to the template name).
@@ -1885,7 +1885,7 @@ const envelopeRecipientChangeOwner = (endpoint, envelope_id, role_name, email, f
 /**
  * Agree to electronic signing.
  */
-const envelopeRecipientAgree = (endpoint, envelopeId, roleName, agreed, disclosure) => updateRecipientStatus(endpoint, envelopeId, roleName, { action: 'update', agreed, disclosure });
+const envelopeRecipientAgree = (endpoint, envelopeId, roleName, agreed, disclosures) => updateRecipientStatus(endpoint, envelopeId, roleName, { action: 'update', agreed, disclosures });
 /**
  * Change a recipient's name.
  */
@@ -1961,6 +1961,7 @@ const getInPersonLink = (endpoint, envelope_id, role_name) => endpoint.api //
 const verifySigner = (endpoint, params) => endpoint.api //
     .post(`/v2/sign/verify`, params)
     .then((r) => r.data);
+// TODO: Use "oneOf" to describe the unions of these two calls.
 /**
  * Resend a recipient's invitation. NOTE: User interfaces should rate-limit this operation to
  * avoid spamming recipients. Excessive use of this endpoint may result in Verdocs rate-limiting