@verdocs/js-sdk 5.1.6 → 5.1.7

package/dist/index.d.mts

@@ -501,6 +501,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;
@@ -970,7 +972,7 @@ type TEventDetail = "in_app" | "mail" | "signer" | "sms" | "reminder" | "prepare
 // 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 +984,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 +1361,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 +1369,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 +1380,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 {

package/dist/index.d.ts

@@ -501,6 +501,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;
@@ -970,7 +972,7 @@ type TEventDetail = "in_app" | "mail" | "signer" | "sms" | "reminder" | "prepare
 // 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 +984,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 +1361,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 +1369,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 +1380,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 {

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "5.1.6",
+  "version": "5.1.7",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Isomorphic JS/TS SDK providing types and API wrappers for the Verdocs platform for Node and browser clients",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "5.1.6",
+  "version": "5.1.7",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Isomorphic JS/TS SDK providing types and API wrappers for the Verdocs platform for Node and browser clients",