@verdocs/js-sdk 6.2.4 → 6.2.7

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.
@@ -1737,10 +1740,18 @@ 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: Partial<Pick<IEnvelope, "name" | "sender_name" | "sender_email" | "initial_reminder" | "followup_reminders" | "expires_at" | "visibility" | "no_contact" | "data">>) => Promise<IEnvelope>;
 /**
  * Update an Envelope field. Typically called during the signing process as a Recipient fills in fields.
  *

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.
@@ -1737,10 +1740,18 @@ 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: Partial<Pick<IEnvelope, "name" | "sender_name" | "sender_email" | "initial_reminder" | "followup_reminders" | "expires_at" | "visibility" | "no_contact" | "data">>) => Promise<IEnvelope>;
 /**
  * Update an Envelope field. Typically called during the signing process as a Recipient fills in fields.
  *

package/dist/index.js

@@ -1678,7 +1678,15 @@ 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 //