@verdocs/js-sdk 6.2.3 → 6.2.6

package/dist/index.d.mts

@@ -508,6 +508,10 @@ interface IEnvelope {
     organization_id: string;
     /** Name of the envelope. By defaut, inherited from the envelope's template, but may be overridden when the envelope is created. */
     name: string;
+    /** Override the sender "name" in places like the Certificate. */
+    sender_name: string;
+    /** Override the sender "email address" in places like the Certificate. */
+    sender_email: string;
     /** If set to true, no email or SMS messages will be sent to any of the envelope's recipients. */
     no_contact?: boolean;
     /** Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable. */
@@ -526,7 +530,6 @@ interface IEnvelope {
     expires_at?: string;
     /** Defaults to 'private'. If set to 'shared', this envelope will be visible to other users in the same organization. Ignored for personal profiles. */
     visibility: "private" | "shared";
-    search_key?: string | null;
     /**
      * Storage for arbitrary data that may be used e.g. to track source database/record IDs to relate Envelopes back to
      * internal systems/applications.
@@ -542,21 +545,38 @@ interface IEnvelope {
     /** Documents attached to this envelope */
     documents?: IEnvelopeDocument[] | null;
 }
+/**
+ * An EnvelopeDocument is an individual document inside an Envelope package.
+ */
 interface IEnvelopeDocument {
+    /** Unique identifier for the document (UUID) */
     id: string;
+    /** Unique identifier for the envelope (UUID) */
     envelope_id: string;
+    /** Unique identifier for the template (UUID). May be null for envelopes created without templates */
     template_document_id: string | null;
+    /**
+     * The order in which the document appears in the envelope.
+     */
     order: number;
+    /** Whether the document is a signer-supplied attachment or a Verdocs-generated certificate */
     type: "attachment" | "certificate";
+    /** The name of the document */
     name: string;
+    /** Page count */
     pages: number;
+    /** MIME type */
     mime: string;
+    /** File size (bytes) */
     size: number;
+    /** Collection of width/height dimensions for each page */
     page_sizes: {
         width: number;
         height: number;
     }[];
+    /** Date/time when the document was created. */
     created_at: string;
+    /** Date/time when the document was created. */
     updated_at: string;
 }
 interface IDropdownOption {
@@ -1516,6 +1536,8 @@ interface ICreateEnvelopeFromTemplateRequest {
     description?: string;
     /** Override the sender name of the envelope in email and other notifications. NOTE: To prevent spam filters from blocking messages, only the NAME may be overidden. The "from" email address will be notifications@verdocs.com and cannot be changed. */
     sender_name?: string;
+    /** Override the sender email of the envelope in email and other notifications. NOTE: This will change areas that reflect the sender's email in the Web UI and certificate. It cannot change the email address used for notifications. */
+    sender_email?: string;
     /** If set, Verdocs will not attempt to contact the recipient via email or SMS. */
     no_contact?: boolean;
     /** If set, the envelope will automatically expire at the specified date/time (ISO8601, UTC) */
@@ -1542,6 +1564,8 @@ interface ICreateEnvelopeDirectlyRequest {
     description?: string;
     /** Override the sender name of the envelope in email and other notifications. NOTE: To prevent spam filters from blocking messages, only the NAME may be overidden. The "from" email address will be notifications@verdocs.com and cannot be changed. */
     sender_name?: string;
+    /** Override the sender email of the envelope in email and other notifications. NOTE: This will change areas that reflect the sender's email in the Web UI and certificate. It cannot change the email address used for notifications. */
+    sender_email?: string;
     /** If set, Verdocs will not attempt to contact the recipient via email or SMS. */
     no_contact?: boolean;
     /** If set, the envelope will automatically expire at the specified date/time (ISO8601, UTC) */
@@ -1643,8 +1667,8 @@ declare const DEFAULT_DISCLOSURES = "\n<ul>\n  <li>\n    Agree to use electronic
  * @apiBody string name? Override the name of the envelope (defaults to the template name).
  * @apiBody string description? Override the description of the envelope (defaults to the template description).
  * @apiBody boolean no_contact? If set to true, no email or SMS messages will be sent to any recipients.
- * @apiBody integer(min: 0) initial_reminder? Override the template initial-reminder setting (in milliseconds).
- * @apiBody integer(min: 0) followup_reminders? Override the template initial-reminder setting (in milliseconds).
+ * @apiBody integer(min: 0) initial_reminder? Override the template initial-reminder setting in ms.
+ * @apiBody integer(min: 0) followup_reminders? Override the template initial-reminder setting in ms.
  * @apiBody string expires_at? If set, the envelope will automatically expire (be canceled) at this date and time. Expirations must be at least 1 day in the future.
  * @apiSuccess IEnvelope . The newly-created envelope.
  */
@@ -1716,12 +1740,20 @@ declare const getEnvelopeFile: (endpoint: VerdocsEndpoint, documentId: string) =
  * @group Envelopes
  * @api PATCH /v2/envelopes/:id Update Envelope
  * @apiParam string(format: 'uuid') id The ID of the envelope to update.
- * @apiBody IEnvelope . Set of fields to update. Omit (leave undefined) any fields that should not be changed.
+ * @apiBody string name? New name for the envelope
+ * @apiBody string sender_name? New Sender Name for the envelope
+ * @apiBody string sender_email? New Sender Email for the envelope
+ * @apiBody integer(min: 0) initial_reminder? Change the initial-reminder setting (in ms).
+ * @apiBody integer(min: 0) followup_reminders? Change the followup-reminder setting (in ms).
+ * @apiBody string expires_at? If set, the envelope will automatically expire (be canceled) at this date and time. Expirations must be at least 1 day in the future.
+ * @apiBody string(enum:'private'|'shared') visibility? Change the envelope's visibility setting
+ * @apiBody boolean no_contact? If set to true, no email or SMS messages will be sent to any recipients.
+ * @apiBody object data? Update the developer-supplied metadata attached to the envelope.
  * @apiSuccess IEnvelope . A copy of the newly-updated envelope.
  */
-declare const updateEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string, params: Pick<IEnvelope, "initial_reminder" | "followup_reminders">) => Promise<IEnvelope>;
+declare const updateEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string, params: Pick<IEnvelope, "name" | "sender_name" | "sender_email" | "initial_reminder" | "followup_reminders" | "expires_at" | "visibility" | "no_contact" | "data">) => Promise<IEnvelope>;
 /**
- * Update a Document field. Typically called during the signing process as a Recipient fills in fields.
+ * Update an Envelope field. Typically called during the signing process as a Recipient fills in fields.
  *
  * @group Envelopes
  * @api PUT /v2/envelopes/:envelope_id/fields/:field_name Update Envelope Field
@@ -1729,7 +1761,7 @@ declare const updateEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string, pa
  * @apiParam string role_name The role to submit. Be sure to URL-encode the value.
  * @apiParam string field_name The name of the field to update. Be sure to URL-encode the value.
  * @apiParam string value The value to set. For signature/initial fields, the UUID of the signature/initial block. For attachment fields, a file uploaded in a FORM-POST field named "document". For checkbox/radio buttons, a boolean. For all other fields, a string.
- * @apiBody value . Value to set.
+ * @apiBody string value Value to set.
  * @apiSuccess IEnvelopeField . A copy of the newly-updated field.
  */
 declare const updateEnvelopeField: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, fieldName: string, value: string, prepared: boolean) => Promise<IEnvelopeField>;
@@ -3486,8 +3518,8 @@ declare const createTemplateFromSharepoint: (endpoint: VerdocsEndpoint, params:
  * @apiBody boolean is_personal? Deprecated. If true, the template is personal and can only be seen by the caller. (Use "visibility" for new calls.)
  * @apiBody boolean is_public? Deprecated. If true, the template is public and can be seen by anybody. (Use "visibility" for new calls.)
  * @apiBody TTemplateSender sender? Who may send envelopes using this template
- * @apiBody number initial_reminder? Delay (in milliseconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable.
- * @apiBody number followup_reminders? Delay (in milliseconds) before the subsequent reminders are sent (min: 12hrs). Set to 0 or null to disable.
+ * @apiBody number initial_reminder? Delay in ms before the first reminder is sent (min: 4hrs). Set to 0 or null to disable.
+ * @apiBody number followup_reminders? Delay in ms before the subsequent reminders are sent (min: 12hrs). Set to 0 or null to disable.
  * @apiSuccess ITemplate . The updated template
  */
 declare const updateTemplate: (endpoint: VerdocsEndpoint, templateId: string, params: Partial<ITemplateCreateParams>) => Promise<ITemplate>;

package/dist/index.d.ts

@@ -508,6 +508,10 @@ interface IEnvelope {
     organization_id: string;
     /** Name of the envelope. By defaut, inherited from the envelope's template, but may be overridden when the envelope is created. */
     name: string;
+    /** Override the sender "name" in places like the Certificate. */
+    sender_name: string;
+    /** Override the sender "email address" in places like the Certificate. */
+    sender_email: string;
     /** If set to true, no email or SMS messages will be sent to any of the envelope's recipients. */
     no_contact?: boolean;
     /** Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable. */
@@ -526,7 +530,6 @@ interface IEnvelope {
     expires_at?: string;
     /** Defaults to 'private'. If set to 'shared', this envelope will be visible to other users in the same organization. Ignored for personal profiles. */
     visibility: "private" | "shared";
-    search_key?: string | null;
     /**
      * Storage for arbitrary data that may be used e.g. to track source database/record IDs to relate Envelopes back to
      * internal systems/applications.
@@ -542,21 +545,38 @@ interface IEnvelope {
     /** Documents attached to this envelope */
     documents?: IEnvelopeDocument[] | null;
 }
+/**
+ * An EnvelopeDocument is an individual document inside an Envelope package.
+ */
 interface IEnvelopeDocument {
+    /** Unique identifier for the document (UUID) */
     id: string;
+    /** Unique identifier for the envelope (UUID) */
     envelope_id: string;
+    /** Unique identifier for the template (UUID). May be null for envelopes created without templates */
     template_document_id: string | null;
+    /**
+     * The order in which the document appears in the envelope.
+     */
     order: number;
+    /** Whether the document is a signer-supplied attachment or a Verdocs-generated certificate */
     type: "attachment" | "certificate";
+    /** The name of the document */
     name: string;
+    /** Page count */
     pages: number;
+    /** MIME type */
     mime: string;
+    /** File size (bytes) */
     size: number;
+    /** Collection of width/height dimensions for each page */
     page_sizes: {
         width: number;
         height: number;
     }[];
+    /** Date/time when the document was created. */
     created_at: string;
+    /** Date/time when the document was created. */
     updated_at: string;
 }
 interface IDropdownOption {
@@ -1516,6 +1536,8 @@ interface ICreateEnvelopeFromTemplateRequest {
     description?: string;
     /** Override the sender name of the envelope in email and other notifications. NOTE: To prevent spam filters from blocking messages, only the NAME may be overidden. The "from" email address will be notifications@verdocs.com and cannot be changed. */
     sender_name?: string;
+    /** Override the sender email of the envelope in email and other notifications. NOTE: This will change areas that reflect the sender's email in the Web UI and certificate. It cannot change the email address used for notifications. */
+    sender_email?: string;
     /** If set, Verdocs will not attempt to contact the recipient via email or SMS. */
     no_contact?: boolean;
     /** If set, the envelope will automatically expire at the specified date/time (ISO8601, UTC) */
@@ -1542,6 +1564,8 @@ interface ICreateEnvelopeDirectlyRequest {
     description?: string;
     /** Override the sender name of the envelope in email and other notifications. NOTE: To prevent spam filters from blocking messages, only the NAME may be overidden. The "from" email address will be notifications@verdocs.com and cannot be changed. */
     sender_name?: string;
+    /** Override the sender email of the envelope in email and other notifications. NOTE: This will change areas that reflect the sender's email in the Web UI and certificate. It cannot change the email address used for notifications. */
+    sender_email?: string;
     /** If set, Verdocs will not attempt to contact the recipient via email or SMS. */
     no_contact?: boolean;
     /** If set, the envelope will automatically expire at the specified date/time (ISO8601, UTC) */
@@ -1643,8 +1667,8 @@ declare const DEFAULT_DISCLOSURES = "\n<ul>\n  <li>\n    Agree to use electronic
  * @apiBody string name? Override the name of the envelope (defaults to the template name).
  * @apiBody string description? Override the description of the envelope (defaults to the template description).
  * @apiBody boolean no_contact? If set to true, no email or SMS messages will be sent to any recipients.
- * @apiBody integer(min: 0) initial_reminder? Override the template initial-reminder setting (in milliseconds).
- * @apiBody integer(min: 0) followup_reminders? Override the template initial-reminder setting (in milliseconds).
+ * @apiBody integer(min: 0) initial_reminder? Override the template initial-reminder setting in ms.
+ * @apiBody integer(min: 0) followup_reminders? Override the template initial-reminder setting in ms.
  * @apiBody string expires_at? If set, the envelope will automatically expire (be canceled) at this date and time. Expirations must be at least 1 day in the future.
  * @apiSuccess IEnvelope . The newly-created envelope.
  */
@@ -1716,12 +1740,20 @@ declare const getEnvelopeFile: (endpoint: VerdocsEndpoint, documentId: string) =
  * @group Envelopes
  * @api PATCH /v2/envelopes/:id Update Envelope
  * @apiParam string(format: 'uuid') id The ID of the envelope to update.
- * @apiBody IEnvelope . Set of fields to update. Omit (leave undefined) any fields that should not be changed.
+ * @apiBody string name? New name for the envelope
+ * @apiBody string sender_name? New Sender Name for the envelope
+ * @apiBody string sender_email? New Sender Email for the envelope
+ * @apiBody integer(min: 0) initial_reminder? Change the initial-reminder setting (in ms).
+ * @apiBody integer(min: 0) followup_reminders? Change the followup-reminder setting (in ms).
+ * @apiBody string expires_at? If set, the envelope will automatically expire (be canceled) at this date and time. Expirations must be at least 1 day in the future.
+ * @apiBody string(enum:'private'|'shared') visibility? Change the envelope's visibility setting
+ * @apiBody boolean no_contact? If set to true, no email or SMS messages will be sent to any recipients.
+ * @apiBody object data? Update the developer-supplied metadata attached to the envelope.
  * @apiSuccess IEnvelope . A copy of the newly-updated envelope.
  */
-declare const updateEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string, params: Pick<IEnvelope, "initial_reminder" | "followup_reminders">) => Promise<IEnvelope>;
+declare const updateEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string, params: Pick<IEnvelope, "name" | "sender_name" | "sender_email" | "initial_reminder" | "followup_reminders" | "expires_at" | "visibility" | "no_contact" | "data">) => Promise<IEnvelope>;
 /**
- * Update a Document field. Typically called during the signing process as a Recipient fills in fields.
+ * Update an Envelope field. Typically called during the signing process as a Recipient fills in fields.
  *
  * @group Envelopes
  * @api PUT /v2/envelopes/:envelope_id/fields/:field_name Update Envelope Field
@@ -1729,7 +1761,7 @@ declare const updateEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string, pa
  * @apiParam string role_name The role to submit. Be sure to URL-encode the value.
  * @apiParam string field_name The name of the field to update. Be sure to URL-encode the value.
  * @apiParam string value The value to set. For signature/initial fields, the UUID of the signature/initial block. For attachment fields, a file uploaded in a FORM-POST field named "document". For checkbox/radio buttons, a boolean. For all other fields, a string.
- * @apiBody value . Value to set.
+ * @apiBody string value Value to set.
  * @apiSuccess IEnvelopeField . A copy of the newly-updated field.
  */
 declare const updateEnvelopeField: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, fieldName: string, value: string, prepared: boolean) => Promise<IEnvelopeField>;
@@ -3486,8 +3518,8 @@ declare const createTemplateFromSharepoint: (endpoint: VerdocsEndpoint, params:
  * @apiBody boolean is_personal? Deprecated. If true, the template is personal and can only be seen by the caller. (Use "visibility" for new calls.)
  * @apiBody boolean is_public? Deprecated. If true, the template is public and can be seen by anybody. (Use "visibility" for new calls.)
  * @apiBody TTemplateSender sender? Who may send envelopes using this template
- * @apiBody number initial_reminder? Delay (in milliseconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable.
- * @apiBody number followup_reminders? Delay (in milliseconds) before the subsequent reminders are sent (min: 12hrs). Set to 0 or null to disable.
+ * @apiBody number initial_reminder? Delay in ms before the first reminder is sent (min: 4hrs). Set to 0 or null to disable.
+ * @apiBody number followup_reminders? Delay in ms before the subsequent reminders are sent (min: 12hrs). Set to 0 or null to disable.
  * @apiSuccess ITemplate . The updated template
  */
 declare const updateTemplate: (endpoint: VerdocsEndpoint, templateId: string, params: Partial<ITemplateCreateParams>) => Promise<ITemplate>;

package/dist/index.js

@@ -1589,8 +1589,8 @@ class VerdocsEndpoint {
  * @apiBody string name? Override the name of the envelope (defaults to the template name).
  * @apiBody string description? Override the description of the envelope (defaults to the template description).
  * @apiBody boolean no_contact? If set to true, no email or SMS messages will be sent to any recipients.
- * @apiBody integer(min: 0) initial_reminder? Override the template initial-reminder setting (in milliseconds).
- * @apiBody integer(min: 0) followup_reminders? Override the template initial-reminder setting (in milliseconds).
+ * @apiBody integer(min: 0) initial_reminder? Override the template initial-reminder setting in ms.
+ * @apiBody integer(min: 0) followup_reminders? Override the template initial-reminder setting in ms.
  * @apiBody string expires_at? If set, the envelope will automatically expire (be canceled) at this date and time. Expirations must be at least 1 day in the future.
  * @apiSuccess IEnvelope . The newly-created envelope.
  */
@@ -1678,14 +1678,22 @@ const getEnvelopeFile = async (endpoint, documentId) => endpoint.api //
  * @group Envelopes
  * @api PATCH /v2/envelopes/:id Update Envelope
  * @apiParam string(format: 'uuid') id The ID of the envelope to update.
- * @apiBody IEnvelope . Set of fields to update. Omit (leave undefined) any fields that should not be changed.
+ * @apiBody string name? New name for the envelope
+ * @apiBody string sender_name? New Sender Name for the envelope
+ * @apiBody string sender_email? New Sender Email for the envelope
+ * @apiBody integer(min: 0) initial_reminder? Change the initial-reminder setting (in ms).
+ * @apiBody integer(min: 0) followup_reminders? Change the followup-reminder setting (in ms).
+ * @apiBody string expires_at? If set, the envelope will automatically expire (be canceled) at this date and time. Expirations must be at least 1 day in the future.
+ * @apiBody string(enum:'private'|'shared') visibility? Change the envelope's visibility setting
+ * @apiBody boolean no_contact? If set to true, no email or SMS messages will be sent to any recipients.
+ * @apiBody object data? Update the developer-supplied metadata attached to the envelope.
  * @apiSuccess IEnvelope . A copy of the newly-updated envelope.
  */
 const updateEnvelope = async (endpoint, envelopeId, params) => endpoint.api //
     .patch(`/v2/envelopes/${envelopeId}`, params)
     .then((r) => r.data);
 /**
- * Update a Document field. Typically called during the signing process as a Recipient fills in fields.
+ * Update an Envelope field. Typically called during the signing process as a Recipient fills in fields.
  *
  * @group Envelopes
  * @api PUT /v2/envelopes/:envelope_id/fields/:field_name Update Envelope Field
@@ -1693,7 +1701,7 @@ const updateEnvelope = async (endpoint, envelopeId, params) => endpoint.api //
  * @apiParam string role_name The role to submit. Be sure to URL-encode the value.
  * @apiParam string field_name The name of the field to update. Be sure to URL-encode the value.
  * @apiParam string value The value to set. For signature/initial fields, the UUID of the signature/initial block. For attachment fields, a file uploaded in a FORM-POST field named "document". For checkbox/radio buttons, a boolean. For all other fields, a string.
- * @apiBody value . Value to set.
+ * @apiBody string value Value to set.
  * @apiSuccess IEnvelopeField . A copy of the newly-updated field.
  */
 const updateEnvelopeField = async (endpoint, envelopeId, roleName, fieldName, value, prepared) => endpoint.api //
@@ -2398,8 +2406,8 @@ const createTemplateFromSharepoint = (endpoint, params) => {
  * @apiBody boolean is_personal? Deprecated. If true, the template is personal and can only be seen by the caller. (Use "visibility" for new calls.)
  * @apiBody boolean is_public? Deprecated. If true, the template is public and can be seen by anybody. (Use "visibility" for new calls.)
  * @apiBody TTemplateSender sender? Who may send envelopes using this template
- * @apiBody number initial_reminder? Delay (in milliseconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable.
- * @apiBody number followup_reminders? Delay (in milliseconds) before the subsequent reminders are sent (min: 12hrs). Set to 0 or null to disable.
+ * @apiBody number initial_reminder? Delay in ms before the first reminder is sent (min: 4hrs). Set to 0 or null to disable.
+ * @apiBody number followup_reminders? Delay in ms before the subsequent reminders are sent (min: 12hrs). Set to 0 or null to disable.
  * @apiSuccess ITemplate . The updated template
  */
 const updateTemplate = (endpoint, templateId, params) => endpoint.api //