@verdocs/js-sdk 6.7.0 → 6.7.3

package/dist/index.d.mts

@@ -423,23 +423,7 @@ interface IUser {
     created_at: string;
     updated_at: string;
 }
-// TODO: Combine this with TWebhookEvent in
-interface IWebhookEvents {
-    envelope_created: boolean;
-    envelope_completed: boolean;
-    envelope_updated: boolean;
-    envelope_canceled: boolean;
-    envelope_expired: boolean;
-    template_created: boolean;
-    template_updated: boolean;
-    template_deleted: boolean;
-    template_used: boolean;
-    recipient_submitted: boolean;
-    recipient_updated: boolean;
-    recipient_delegated: boolean;
-    kba_event: boolean;
-    entitlement_used: boolean;
-}
+type IWebhookEvents = Record<TWebhookEvent, boolean>;
 interface IWebhook {
     id: string;
     organization_id: string;
@@ -539,6 +523,8 @@ interface IEnvelope {
     initial_reminder: number | null;
     /** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
     followup_reminders: number | null;
+    /** Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14. */
+    max_reminder_days: number;
     /** When the next reminder is scheduled to be sent. */
     next_reminder: string | null;
     /** Date/time when the envelope was created. */
@@ -888,6 +874,8 @@ interface ITemplate {
     initial_reminder: number | null;
     /** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
     followup_reminders: number | null;
+    /** Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14. */
+    max_reminder_days: number;
     /**
      * If true, the template is only visible to the creator. If false, the template will also be visible to the user's
      * organization, if any.
@@ -1042,7 +1030,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" | "envelope_expired" | "template_created" | "template_updated" | "template_deleted" | "template_used" | "recipient_submitted" | "recipient_updated" | "recipient_delegated" | "kba_event" | "entitlement_used";
+type TWebhookEvent = "envelope_created" | "envelope_completed" | "envelope_canceled" | "envelope_updated" | "envelope_expired" | "template_created" | "template_updated" | "template_deleted" | "template_used" | "recipient_submitted" | "recipient_updated" | "recipient_delegated" | "kba_event" | "entitlement_used" | "recipient_invited" | "recipient_reminded" | "recipient_auth_fail" | "recipient_disclosure_accepted" | "recipient_docs_downloaded" | "recipient_invite_failed";
 declare const WEBHOOK_EVENTS: readonly [
     "envelope_created",
     "envelope_completed",
@@ -1057,7 +1045,13 @@ declare const WEBHOOK_EVENTS: readonly [
     "recipient_updated",
     "recipient_delegated",
     "kba_event",
-    "entitlement_used"
+    "entitlement_used",
+    "recipient_invited",
+    "recipient_reminded",
+    "recipient_auth_fail",
+    "recipient_disclosure_accepted",
+    "recipient_docs_downloaded",
+    "recipient_invite_failed"
 ];
 type TTemplateVisibility = "private" | "shared" | "public";
 type TEntitlement = "envelope" | "kba_auth" | "passcode_auth" | "sms_auth" | "kba_id_auth" | "id_auth" | "custom_disclaimer";
@@ -1612,6 +1606,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;
+    /** Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14. */
+    max_reminder_days?: number;
     /** List of recipients to configure. */
     recipients: ICreateEnvelopeRecipientFromTemplate[];
     /** Optional metadata to attach to the envelope. This is not used by Verdocs, but may be used for internal tracking purposes by the caller. This is not shown to recipients, but is not private and should not be used to store sensitive data. */
@@ -1640,6 +1636,8 @@ interface ICreateEnvelopeDirectlyRequest {
     initial_reminder: number;
     /** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
     followup_reminders: number;
+    /** Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14. */
+    max_reminder_days?: number;
     /** Optional metadata to attach to the envelope. This is not used by Verdocs, but may be used for internal tracking purposes by the caller. This is not shown to recipients, but is not private and should not be used to store sensitive data. */
     data?: any;
     /** List of recipients to configure. */
@@ -1734,6 +1732,7 @@ declare const DEFAULT_DISCLOSURES = "\n<ul>\n  <li>\n    Agree to use electronic
  * @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 ms.
  * @apiBody integer(min: 0) followup_reminders? Override the template initial-reminder setting in ms.
+ * @apiBody number max_reminder_days? Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14.
  * @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.
  */
@@ -1810,6 +1809,7 @@ declare const getEnvelopeFile: (endpoint: VerdocsEndpoint, documentId: string) =
  * @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 number max_reminder_days? Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14.
  * @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.
@@ -3674,6 +3674,8 @@ interface ITemplateCreateParams {
     initial_reminder?: number;
     /** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
     followup_reminders?: number;
+    /** Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14. */
+    max_reminder_days?: number;
     /** Optional description for the template to help identify it. */
     description?: string;
     /**
@@ -3711,6 +3713,7 @@ interface ITemplateCreateParams {
  * @apiBody TTemplateSender sender? Who may send envelopes using this template
  * @apiBody number initial_reminder? Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable.
  * @apiBody number followup_reminders? Delay (in seconds) before the subsequent reminders are sent (min: 12hrs). Set to 0 or null to disable.
+ * @apiBody number max_reminder_days? Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14.
  * @apiBody array(items:object) documents? Optional list of documents to attach to the template
  * @apiBody array(items:IRole) roles? Optional list of roles to create. Note that if roles are not included in the request, fields will be ignored.
  * @apiBody array(fields:ITemplateField) fields? Optional list of fields to create. Note that if fields that do not match a role will be ignored.
@@ -3785,6 +3788,7 @@ declare const createTemplateFromSharepoint: (endpoint: VerdocsEndpoint, params:
  * @apiBody TTemplateSender sender? Who may send envelopes using this template
  * @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.
+ * @apiBody number max_reminder_days? Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14.
  * @apiSuccess ITemplate . The updated template
  */
 declare const updateTemplate: (endpoint: VerdocsEndpoint, templateId: string, params: Partial<ITemplateCreateParams>) => Promise<ITemplate>;

package/dist/index.d.ts

@@ -423,23 +423,7 @@ interface IUser {
     created_at: string;
     updated_at: string;
 }
-// TODO: Combine this with TWebhookEvent in
-interface IWebhookEvents {
-    envelope_created: boolean;
-    envelope_completed: boolean;
-    envelope_updated: boolean;
-    envelope_canceled: boolean;
-    envelope_expired: boolean;
-    template_created: boolean;
-    template_updated: boolean;
-    template_deleted: boolean;
-    template_used: boolean;
-    recipient_submitted: boolean;
-    recipient_updated: boolean;
-    recipient_delegated: boolean;
-    kba_event: boolean;
-    entitlement_used: boolean;
-}
+type IWebhookEvents = Record<TWebhookEvent, boolean>;
 interface IWebhook {
     id: string;
     organization_id: string;
@@ -539,6 +523,8 @@ interface IEnvelope {
     initial_reminder: number | null;
     /** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
     followup_reminders: number | null;
+    /** Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14. */
+    max_reminder_days: number;
     /** When the next reminder is scheduled to be sent. */
     next_reminder: string | null;
     /** Date/time when the envelope was created. */
@@ -888,6 +874,8 @@ interface ITemplate {
     initial_reminder: number | null;
     /** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
     followup_reminders: number | null;
+    /** Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14. */
+    max_reminder_days: number;
     /**
      * If true, the template is only visible to the creator. If false, the template will also be visible to the user's
      * organization, if any.
@@ -1042,7 +1030,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" | "envelope_expired" | "template_created" | "template_updated" | "template_deleted" | "template_used" | "recipient_submitted" | "recipient_updated" | "recipient_delegated" | "kba_event" | "entitlement_used";
+type TWebhookEvent = "envelope_created" | "envelope_completed" | "envelope_canceled" | "envelope_updated" | "envelope_expired" | "template_created" | "template_updated" | "template_deleted" | "template_used" | "recipient_submitted" | "recipient_updated" | "recipient_delegated" | "kba_event" | "entitlement_used" | "recipient_invited" | "recipient_reminded" | "recipient_auth_fail" | "recipient_disclosure_accepted" | "recipient_docs_downloaded" | "recipient_invite_failed";
 declare const WEBHOOK_EVENTS: readonly [
     "envelope_created",
     "envelope_completed",
@@ -1057,7 +1045,13 @@ declare const WEBHOOK_EVENTS: readonly [
     "recipient_updated",
     "recipient_delegated",
     "kba_event",
-    "entitlement_used"
+    "entitlement_used",
+    "recipient_invited",
+    "recipient_reminded",
+    "recipient_auth_fail",
+    "recipient_disclosure_accepted",
+    "recipient_docs_downloaded",
+    "recipient_invite_failed"
 ];
 type TTemplateVisibility = "private" | "shared" | "public";
 type TEntitlement = "envelope" | "kba_auth" | "passcode_auth" | "sms_auth" | "kba_id_auth" | "id_auth" | "custom_disclaimer";
@@ -1612,6 +1606,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;
+    /** Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14. */
+    max_reminder_days?: number;
     /** List of recipients to configure. */
     recipients: ICreateEnvelopeRecipientFromTemplate[];
     /** Optional metadata to attach to the envelope. This is not used by Verdocs, but may be used for internal tracking purposes by the caller. This is not shown to recipients, but is not private and should not be used to store sensitive data. */
@@ -1640,6 +1636,8 @@ interface ICreateEnvelopeDirectlyRequest {
     initial_reminder: number;
     /** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
     followup_reminders: number;
+    /** Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14. */
+    max_reminder_days?: number;
     /** Optional metadata to attach to the envelope. This is not used by Verdocs, but may be used for internal tracking purposes by the caller. This is not shown to recipients, but is not private and should not be used to store sensitive data. */
     data?: any;
     /** List of recipients to configure. */
@@ -1734,6 +1732,7 @@ declare const DEFAULT_DISCLOSURES = "\n<ul>\n  <li>\n    Agree to use electronic
  * @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 ms.
  * @apiBody integer(min: 0) followup_reminders? Override the template initial-reminder setting in ms.
+ * @apiBody number max_reminder_days? Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14.
  * @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.
  */
@@ -1810,6 +1809,7 @@ declare const getEnvelopeFile: (endpoint: VerdocsEndpoint, documentId: string) =
  * @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 number max_reminder_days? Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14.
  * @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.
@@ -3674,6 +3674,8 @@ interface ITemplateCreateParams {
     initial_reminder?: number;
     /** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
     followup_reminders?: number;
+    /** Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14. */
+    max_reminder_days?: number;
     /** Optional description for the template to help identify it. */
     description?: string;
     /**
@@ -3711,6 +3713,7 @@ interface ITemplateCreateParams {
  * @apiBody TTemplateSender sender? Who may send envelopes using this template
  * @apiBody number initial_reminder? Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable.
  * @apiBody number followup_reminders? Delay (in seconds) before the subsequent reminders are sent (min: 12hrs). Set to 0 or null to disable.
+ * @apiBody number max_reminder_days? Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14.
  * @apiBody array(items:object) documents? Optional list of documents to attach to the template
  * @apiBody array(items:IRole) roles? Optional list of roles to create. Note that if roles are not included in the request, fields will be ignored.
  * @apiBody array(fields:ITemplateField) fields? Optional list of fields to create. Note that if fields that do not match a role will be ignored.
@@ -3785,6 +3788,7 @@ declare const createTemplateFromSharepoint: (endpoint: VerdocsEndpoint, params:
  * @apiBody TTemplateSender sender? Who may send envelopes using this template
  * @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.
+ * @apiBody number max_reminder_days? Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14.
  * @apiSuccess ITemplate . The updated template
  */
 declare const updateTemplate: (endpoint: VerdocsEndpoint, templateId: string, params: Partial<ITemplateCreateParams>) => Promise<ITemplate>;

package/dist/index.js

@@ -18,6 +18,12 @@ const WEBHOOK_EVENTS = [
     'recipient_delegated',
     'kba_event',
     'entitlement_used',
+    'recipient_invited',
+    'recipient_reminded',
+    'recipient_auth_fail',
+    'recipient_disclosure_accepted',
+    'recipient_docs_downloaded',
+    'recipient_invite_failed',
 ];
 
 const FIELD_TYPES = [
@@ -1577,6 +1583,7 @@ class VerdocsEndpoint {
  * @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 ms.
  * @apiBody integer(min: 0) followup_reminders? Override the template initial-reminder setting in ms.
+ * @apiBody number max_reminder_days? Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14.
  * @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.
  */
@@ -1676,6 +1683,7 @@ const getEnvelopeFile = async (endpoint, documentId) => endpoint.api //
  * @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 number max_reminder_days? Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14.
  * @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.
@@ -2352,6 +2360,7 @@ const ALLOWED_CREATE_FIELDS = [
  * @apiBody TTemplateSender sender? Who may send envelopes using this template
  * @apiBody number initial_reminder? Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable.
  * @apiBody number followup_reminders? Delay (in seconds) before the subsequent reminders are sent (min: 12hrs). Set to 0 or null to disable.
+ * @apiBody number max_reminder_days? Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14.
  * @apiBody array(items:object) documents? Optional list of documents to attach to the template
  * @apiBody array(items:IRole) roles? Optional list of roles to create. Note that if roles are not included in the request, fields will be ignored.
  * @apiBody array(fields:ITemplateField) fields? Optional list of fields to create. Note that if fields that do not match a role will be ignored.
@@ -2443,6 +2452,7 @@ const createTemplateFromSharepoint = (endpoint, params) => {
  * @apiBody TTemplateSender sender? Who may send envelopes using this template
  * @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.
+ * @apiBody number max_reminder_days? Maximum number of days (after envelope creation) for which reminders will be sent. Defaults to 14.
  * @apiSuccess ITemplate . The updated template
  */
 const updateTemplate = (endpoint, templateId, params) => endpoint.api //