@verdocs/js-sdk 5.2.1 → 5.2.3

package/dist/index.d.mts

@@ -1387,6 +1387,7 @@ interface ICreateEnvelopeFromTemplateRequest {
     name?: string;
     description?: string;
     fields?: Pick<IEnvelopeField, "name" | "role_name" | "default">[];
+    /** Environment in which to execute the envelope. Do not set this unless instructed to do so by Verdocs support. */
     environment?: string;
     /** If set, Verdocs will not attempt to contact the recipient via email or SMS. */
     no_contact?: boolean;
@@ -1405,7 +1406,11 @@ interface ICreateEnvelopeDirectlyRequest {
     visiblity?: "private" | "shared";
     recipients: ICreateEnvelopeRecipient[];
     documents: IEnvelopeDocument[];
-    fields: Pick<IEnvelopeField, "name" | "role_name" | "default">[];
+    /** Fields to create in the envelope. Note that document_id is a number in this call and should match the index of the document in the documents array. */
+    fields: (Pick<IEnvelopeField, "name" | "role_name" | "type" | "page" | "x" | "y"> & Partial<Pick<IEnvelopeField, "default" | "placeholder" | "multiline" | "group" | "options" | "required" | "readonly" | "label" | "page" | "width" | "height">> & {
+        document_id: number;
+    })[];
+    /** Environment in which to execute the envelope. Do not set this unless instructed to do so by Verdocs support. */
     environment?: string;
     /** If set, Verdocs will not attempt to contact the recipient via email or SMS. */
     no_contact?: boolean;
@@ -1934,7 +1939,7 @@ declare const resendInvitation: (endpoint: VerdocsEndpoint, envelopeId: string,
  * @apiBody string ssn_last_4? If KBA-based authentication is used, the recipient's SSN-last-4 to prefill. May only be changed if the recipient has not already completed KBA-based auth.
  * @apiSuccess IRecipient . The updated Recipient.
  */
-declare const updateRecipient: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IRecipient>;
+declare const updateRecipient: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, params: IUpdateRecipientParams) => Promise<IRecipient>;
 /**
  * Check to see if the user owns the envelope.
  */

package/dist/index.d.ts

@@ -1387,6 +1387,7 @@ interface ICreateEnvelopeFromTemplateRequest {
     name?: string;
     description?: string;
     fields?: Pick<IEnvelopeField, "name" | "role_name" | "default">[];
+    /** Environment in which to execute the envelope. Do not set this unless instructed to do so by Verdocs support. */
     environment?: string;
     /** If set, Verdocs will not attempt to contact the recipient via email or SMS. */
     no_contact?: boolean;
@@ -1405,7 +1406,11 @@ interface ICreateEnvelopeDirectlyRequest {
     visiblity?: "private" | "shared";
     recipients: ICreateEnvelopeRecipient[];
     documents: IEnvelopeDocument[];
-    fields: Pick<IEnvelopeField, "name" | "role_name" | "default">[];
+    /** Fields to create in the envelope. Note that document_id is a number in this call and should match the index of the document in the documents array. */
+    fields: (Pick<IEnvelopeField, "name" | "role_name" | "type" | "page" | "x" | "y"> & Partial<Pick<IEnvelopeField, "default" | "placeholder" | "multiline" | "group" | "options" | "required" | "readonly" | "label" | "page" | "width" | "height">> & {
+        document_id: number;
+    })[];
+    /** Environment in which to execute the envelope. Do not set this unless instructed to do so by Verdocs support. */
     environment?: string;
     /** If set, Verdocs will not attempt to contact the recipient via email or SMS. */
     no_contact?: boolean;
@@ -1934,7 +1939,7 @@ declare const resendInvitation: (endpoint: VerdocsEndpoint, envelopeId: string,
  * @apiBody string ssn_last_4? If KBA-based authentication is used, the recipient's SSN-last-4 to prefill. May only be changed if the recipient has not already completed KBA-based auth.
  * @apiSuccess IRecipient . The updated Recipient.
  */
-declare const updateRecipient: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IRecipient>;
+declare const updateRecipient: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, params: IUpdateRecipientParams) => Promise<IRecipient>;
 /**
  * Check to see if the user owns the envelope.
  */

package/dist/index.js

@@ -2007,8 +2007,8 @@ const resendInvitation = (endpoint, envelopeId, roleName) => endpoint.api //
  * @apiBody string ssn_last_4? If KBA-based authentication is used, the recipient's SSN-last-4 to prefill. May only be changed if the recipient has not already completed KBA-based auth.
  * @apiSuccess IRecipient . The updated Recipient.
  */
-const updateRecipient = (endpoint, envelopeId, roleName) => endpoint.api //
-    .patch(`/v2/envelopes/${envelopeId}/recipients/${encodeURIComponent(roleName)}`, { action: 'resend' })
+const updateRecipient = (endpoint, envelopeId, roleName, params) => endpoint.api //
+    .patch(`/v2/envelopes/${envelopeId}/recipients/${encodeURIComponent(roleName)}`, params)
     .then((r) => r.data);
 
 /**