@verdocs/js-sdk 5.1.6 → 5.1.8

package/dist/index.d.mts

@@ -398,6 +398,7 @@ interface IWebhookEvents {
     envelope_completed: boolean;
     envelope_updated: boolean;
     envelope_canceled: boolean;
+    envelope_expired: boolean;
     template_created: boolean;
     template_updated: boolean;
     template_deleted: boolean;
@@ -501,6 +502,8 @@ interface IEnvelope {
     updated_at: string;
     /** Date/time when the envelope was canceled, or null. */
     canceled_at: string;
+    /** Date/time when the envelope will automatically expire, or null. */
+    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;
@@ -965,12 +968,12 @@ type TAccessKeyType = "email" | "in_app" | "in_person_link" | "sms";
 type TApiKeyPermission = "personal" | "global_read" | "global_write";
 /** @deprecated. See envelope.created_at, .updated_at, and .canceled_at. */
 type TDeprecatedHistoryEvent = "envelope:created" | "envelope:completed";
-type THistoryEvent = "recipient:signed" | "recipient:opened" | "recipient:submitted" | "recipient:prepared" | "recipient:claimed" | "recipient:agreed" | "recipient:invited" | "recipient:reminder" | "recipient:delegated" | "recipient:updated_info" | "recipient:declined" | "recipient:kba_verified" | "recipient:kba_failed" | "recipient:id_verified" | "recipient:id_failed" | "recipient:pin_verified" | "recipient:pin_failed" | "invitation:resent" | "envelope:cc" | "envelope:canceled" | "owner:updated_recipient_info" | "owner:get_in_person_link" | TDeprecatedHistoryEvent;
+type THistoryEvent = "recipient:signed" | "recipient:opened" | "recipient:submitted" | "recipient:prepared" | "recipient:claimed" | "recipient:agreed" | "recipient:invited" | "recipient:reminder" | "recipient:delegated" | "recipient:updated_info" | "recipient:declined" | "recipient:kba_verified" | "recipient:kba_failed" | "recipient:id_verified" | "recipient:id_failed" | "recipient:pin_verified" | "recipient:pin_failed" | "invitation:resent" | "envelope:cc" | "envelope:canceled" | "envelope:expired" | "owner:updated_recipient_info" | "owner:get_in_person_link" | TDeprecatedHistoryEvent;
 type TEventDetail = "in_app" | "mail" | "signer" | "sms" | "reminder" | "preparer" | "manual" | "in_person_link" | "guest" | "email" | "" | string; // Modification events have a string description
 // Modification events have a string description
 type TEnvelopeUpdateResult = Omit<IEnvelope, "histories" | "recipients" | "certificate" | "document" | "fields" | "profile">;
 type TFieldType = "signature" | "initial" | "checkbox" | "radio" | "textbox" | "timestamp" | "date" | "dropdown" | "textarea" | "attachment" | "payment";
-type TWebhookEvent = "envelope_created" | "envelope_completed" | "envelope_canceled" | "envelope_updated" | "template_created" | "template_updated" | "template_deleted" | "template_used" | "entitlement_used";
+type TWebhookEvent = "envelope_created" | "envelope_completed" | "envelope_canceled" | "envelope_updated" | "envelope_expired" | "template_created" | "template_updated" | "template_deleted" | "template_used" | "entitlement_used";
 type TTemplateVisibility = "private" | "shared" | "public";
 type TEntitlement = "envelope" | "kba_auth" | "passcode_auth" | "sms_auth" | "kba_id_auth" | "id_auth" | "custom_disclaimer";
 /**
@@ -982,7 +985,7 @@ type TEntitlement = "envelope" | "kba_auth" | "passcode_auth" | "sms_auth" | "kb
  */
 type TRecipientAuthMethod = "kba" | "passcode" | "sms" | "email" | "id";
 type TRecipientAuthStep = TRecipientAuthMethod | null;
-type TUsageType = "envelope" | "envelope_canceled" | "envelope_completed" | "sms_invite" | "template" | "auth_email" | "auth_sms" | "auth_kba" | "auth_id" | "auth_passcode";
+type TUsageType = "envelope" | "envelope_canceled" | "envelope_completed" | "envelope_expired" | "sms_invite" | "template" | "auth_email" | "auth_sms" | "auth_kba" | "auth_id" | "auth_passcode";
 declare const FIELD_TYPES: TFieldType[];
 declare const DEFAULT_FIELD_WIDTHS: Record<TFieldType, number>;
 declare const DEFAULT_FIELD_HEIGHTS: Record<TFieldType, number>;
@@ -1359,6 +1362,7 @@ interface ICreateEnvelopeFromTemplateRequest {
     description?: string;
     fields?: Pick<IEnvelopeField, "name" | "role_name" | "default">[];
     environment?: string;
+    /** If set, Verdocs will not attempt to contact the recipient via email or SMS. */
     no_contact?: boolean;
     /** 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;
@@ -1366,6 +1370,8 @@ interface ICreateEnvelopeFromTemplateRequest {
     initial_reminder?: number;
     /** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
     followup_reminders?: number;
+    /** If set, the envelope will automatically expire at the specified date/time (ISO8601, UTC) */
+    expires_at?: string;
 }
 interface ICreateEnvelopeDirectlyRequest {
     name: string;
@@ -1375,11 +1381,14 @@ interface ICreateEnvelopeDirectlyRequest {
     documents: IEnvelopeDocument[];
     fields: Pick<IEnvelopeField, "name" | "role_name" | "default">[];
     environment?: string;
+    /** If set, Verdocs will not attempt to contact the recipient via email or SMS. */
     no_contact?: boolean;
     /** Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable. */
     initial_reminder: number;
     /** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
     followup_reminders: number;
+    /** If set, the envelope will automatically expire at the specified date/time (ISO8601, UTC) */
+    expires_at?: string;
 }
 type TCreateEnvelopeRequest = ICreateEnvelopeFromTemplateRequest | ICreateEnvelopeDirectlyRequest;
 interface IAuthenticateRecipientViaPasscodeRequest {
@@ -1448,15 +1457,17 @@ type TAuthenticateRecipientRequest = IAuthenticateRecipientViaPasscodeRequest |
  * ```
  *
  * @group Envelopes
- * @api POST /v2/envelopes Create Envelope From Template
- * @apiBody string(format:uuid) template_id The ID of the template to copy
+ * @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: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).
  * @apiBody string description? Override the description of the envelope (defaults to the template description).
- * @apiBody array(items:IEnvelopeField) fields? Provide default values for fields in the envelope. Note that only "name", "role_name", and "default" should be set in this array.
  * @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.
  * @apiBody integer(min: 0) followup_reminders? Override the template initial-reminder setting.
+ * @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.
  */
 declare const createEnvelope: (endpoint: VerdocsEndpoint, request: TCreateEnvelopeRequest) => Promise<IEnvelope>;

package/dist/index.d.ts

@@ -398,6 +398,7 @@ interface IWebhookEvents {
     envelope_completed: boolean;
     envelope_updated: boolean;
     envelope_canceled: boolean;
+    envelope_expired: boolean;
     template_created: boolean;
     template_updated: boolean;
     template_deleted: boolean;
@@ -501,6 +502,8 @@ interface IEnvelope {
     updated_at: string;
     /** Date/time when the envelope was canceled, or null. */
     canceled_at: string;
+    /** Date/time when the envelope will automatically expire, or null. */
+    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;
@@ -965,12 +968,12 @@ type TAccessKeyType = "email" | "in_app" | "in_person_link" | "sms";
 type TApiKeyPermission = "personal" | "global_read" | "global_write";
 /** @deprecated. See envelope.created_at, .updated_at, and .canceled_at. */
 type TDeprecatedHistoryEvent = "envelope:created" | "envelope:completed";
-type THistoryEvent = "recipient:signed" | "recipient:opened" | "recipient:submitted" | "recipient:prepared" | "recipient:claimed" | "recipient:agreed" | "recipient:invited" | "recipient:reminder" | "recipient:delegated" | "recipient:updated_info" | "recipient:declined" | "recipient:kba_verified" | "recipient:kba_failed" | "recipient:id_verified" | "recipient:id_failed" | "recipient:pin_verified" | "recipient:pin_failed" | "invitation:resent" | "envelope:cc" | "envelope:canceled" | "owner:updated_recipient_info" | "owner:get_in_person_link" | TDeprecatedHistoryEvent;
+type THistoryEvent = "recipient:signed" | "recipient:opened" | "recipient:submitted" | "recipient:prepared" | "recipient:claimed" | "recipient:agreed" | "recipient:invited" | "recipient:reminder" | "recipient:delegated" | "recipient:updated_info" | "recipient:declined" | "recipient:kba_verified" | "recipient:kba_failed" | "recipient:id_verified" | "recipient:id_failed" | "recipient:pin_verified" | "recipient:pin_failed" | "invitation:resent" | "envelope:cc" | "envelope:canceled" | "envelope:expired" | "owner:updated_recipient_info" | "owner:get_in_person_link" | TDeprecatedHistoryEvent;
 type TEventDetail = "in_app" | "mail" | "signer" | "sms" | "reminder" | "preparer" | "manual" | "in_person_link" | "guest" | "email" | "" | string; // Modification events have a string description
 // Modification events have a string description
 type TEnvelopeUpdateResult = Omit<IEnvelope, "histories" | "recipients" | "certificate" | "document" | "fields" | "profile">;
 type TFieldType = "signature" | "initial" | "checkbox" | "radio" | "textbox" | "timestamp" | "date" | "dropdown" | "textarea" | "attachment" | "payment";
-type TWebhookEvent = "envelope_created" | "envelope_completed" | "envelope_canceled" | "envelope_updated" | "template_created" | "template_updated" | "template_deleted" | "template_used" | "entitlement_used";
+type TWebhookEvent = "envelope_created" | "envelope_completed" | "envelope_canceled" | "envelope_updated" | "envelope_expired" | "template_created" | "template_updated" | "template_deleted" | "template_used" | "entitlement_used";
 type TTemplateVisibility = "private" | "shared" | "public";
 type TEntitlement = "envelope" | "kba_auth" | "passcode_auth" | "sms_auth" | "kba_id_auth" | "id_auth" | "custom_disclaimer";
 /**
@@ -982,7 +985,7 @@ type TEntitlement = "envelope" | "kba_auth" | "passcode_auth" | "sms_auth" | "kb
  */
 type TRecipientAuthMethod = "kba" | "passcode" | "sms" | "email" | "id";
 type TRecipientAuthStep = TRecipientAuthMethod | null;
-type TUsageType = "envelope" | "envelope_canceled" | "envelope_completed" | "sms_invite" | "template" | "auth_email" | "auth_sms" | "auth_kba" | "auth_id" | "auth_passcode";
+type TUsageType = "envelope" | "envelope_canceled" | "envelope_completed" | "envelope_expired" | "sms_invite" | "template" | "auth_email" | "auth_sms" | "auth_kba" | "auth_id" | "auth_passcode";
 declare const FIELD_TYPES: TFieldType[];
 declare const DEFAULT_FIELD_WIDTHS: Record<TFieldType, number>;
 declare const DEFAULT_FIELD_HEIGHTS: Record<TFieldType, number>;
@@ -1359,6 +1362,7 @@ interface ICreateEnvelopeFromTemplateRequest {
     description?: string;
     fields?: Pick<IEnvelopeField, "name" | "role_name" | "default">[];
     environment?: string;
+    /** If set, Verdocs will not attempt to contact the recipient via email or SMS. */
     no_contact?: boolean;
     /** 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;
@@ -1366,6 +1370,8 @@ interface ICreateEnvelopeFromTemplateRequest {
     initial_reminder?: number;
     /** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
     followup_reminders?: number;
+    /** If set, the envelope will automatically expire at the specified date/time (ISO8601, UTC) */
+    expires_at?: string;
 }
 interface ICreateEnvelopeDirectlyRequest {
     name: string;
@@ -1375,11 +1381,14 @@ interface ICreateEnvelopeDirectlyRequest {
     documents: IEnvelopeDocument[];
     fields: Pick<IEnvelopeField, "name" | "role_name" | "default">[];
     environment?: string;
+    /** If set, Verdocs will not attempt to contact the recipient via email or SMS. */
     no_contact?: boolean;
     /** Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable. */
     initial_reminder: number;
     /** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
     followup_reminders: number;
+    /** If set, the envelope will automatically expire at the specified date/time (ISO8601, UTC) */
+    expires_at?: string;
 }
 type TCreateEnvelopeRequest = ICreateEnvelopeFromTemplateRequest | ICreateEnvelopeDirectlyRequest;
 interface IAuthenticateRecipientViaPasscodeRequest {
@@ -1448,15 +1457,17 @@ type TAuthenticateRecipientRequest = IAuthenticateRecipientViaPasscodeRequest |
  * ```
  *
  * @group Envelopes
- * @api POST /v2/envelopes Create Envelope From Template
- * @apiBody string(format:uuid) template_id The ID of the template to copy
+ * @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: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).
  * @apiBody string description? Override the description of the envelope (defaults to the template description).
- * @apiBody array(items:IEnvelopeField) fields? Provide default values for fields in the envelope. Note that only "name", "role_name", and "default" should be set in this array.
  * @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.
  * @apiBody integer(min: 0) followup_reminders? Override the template initial-reminder setting.
+ * @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.
  */
 declare const createEnvelope: (endpoint: VerdocsEndpoint, request: TCreateEnvelopeRequest) => Promise<IEnvelope>;

package/dist/index.js

@@ -1573,15 +1573,17 @@ class VerdocsEndpoint {
  * ```
  *
  * @group Envelopes
- * @api POST /v2/envelopes Create Envelope From Template
- * @apiBody string(format:uuid) template_id The ID of the template to copy
+ * @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: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).
  * @apiBody string description? Override the description of the envelope (defaults to the template description).
- * @apiBody array(items:IEnvelopeField) fields? Provide default values for fields in the envelope. Note that only "name", "role_name", and "default" should be set in this array.
  * @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.
  * @apiBody integer(min: 0) followup_reminders? Override the template initial-reminder setting.
+ * @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.
  */
 const createEnvelope = async (endpoint, request) => endpoint.api //