@verdocs/js-sdk 4.2.85 → 4.2.87

package/dist/index.d.mts

@@ -461,9 +461,12 @@ interface IEnvelope {
     profile_id: string;
     template_id: string | null;
     organization_id: string;
-    reminder_id: string | null;
     name: string;
     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;
     created_at: string;
     updated_at: string;
     canceled_at: string;
@@ -478,7 +481,6 @@ interface IEnvelope {
     profile?: IProfile;
     template?: ITemplate | null;
     organization?: IOrganization;
-    reminder?: IReminder | null;
     access_keys?: TAccessKey[];
     fields?: IEnvelopeField[];
     history_entries?: IEnvelopeHistory[];
@@ -669,16 +671,6 @@ interface IRecipient {
     envelope?: IEnvelope;
     profile?: IProfile;
 }
-interface IReminder {
-    id?: string;
-    is_on: boolean;
-    key: string;
-    setup_time: number;
-    interval_time: number;
-    created_at: string | null;
-    last_time: number | null;
-    next_time: number | null;
-}
 /**
  * A placeholder for an individual recipient, CC, or other party in a signing flow. Roles may be "known" or "unknown."
  * "Known" roles will have their email address supplied in the template which will get copied to envelopes created from
@@ -742,10 +734,6 @@ interface ITemplate {
      * Organization the template lives in.
      */
     organization_id: string;
-    /**
-     * If set, the template has reminders enabled.
-     */
-    reminder_id: string | null;
     /**
      * Who may create new documents from the template.
      */
@@ -766,6 +754,10 @@ interface ITemplate {
      * Number of times the template has been "starred".
      */
     star_counter: number;
+    /** 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 true, the template is only visible to the creator. If false, the template will also be visible to the user's
      * organization, if any.
@@ -808,7 +800,6 @@ interface ITemplate {
     tags?: string[];
     profile?: IProfile;
     organization?: IOrganization;
-    reminder?: IReminder | null;
     roles?: IRole[];
     documents?: ITemplateDocument[];
     fields?: ITemplateField[];
@@ -1275,6 +1266,10 @@ interface ICreateEnvelopeFromTemplateRequest {
     fields?: Pick<IEnvelopeField, "name" | "role_name" | "default">[];
     environment?: string;
     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;
 }
 interface ICreateEnvelopeDirectlyRequest {
     name: string;
@@ -1285,6 +1280,10 @@ interface ICreateEnvelopeDirectlyRequest {
     fields: Pick<IEnvelopeField, "name" | "role_name" | "default">[];
     environment?: string;
     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;
 }
 type TCreateEnvelopeRequest = ICreateEnvelopeFromTemplateRequest | ICreateEnvelopeDirectlyRequest;
 /**
@@ -1381,7 +1380,7 @@ declare const getFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string
  * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are intended
  * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants.
  */
-declare const getEnvelopeDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string, page: number, type?: "original" | "filled" | "certificate") => Promise<string>;
+declare const getEnvelopeDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, documentId: string, page: number, variant?: "original" | "filled" | "certificate") => Promise<string>;
 interface ITimeRange {
     start: string;
     end: string;
@@ -1563,23 +1562,6 @@ declare const sendDelegate: (endpoint: VerdocsEndpoint, envelopeId: string, role
  * Resend a recipient's invitation.
  */
 declare const resendInvitation: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<any>;
-/**
- * Enable automatic reminders. setup_time is the number of days after the envelope is sent that the first reminder
- * should be sent. interval_time is the number of days between reminders.
- */
-declare const createEnvelopeReminder: (endpoint: VerdocsEndpoint, envelopeId: string, params: ICreateEnvelopeReminderRequest) => Promise<IReminder>;
-/**
- * Get the reminder configuration for an envelope.
- */
-declare const getEnvelopeReminder: (endpoint: VerdocsEndpoint, envelopeId: string, reminderId: string) => Promise<IReminder>;
-/**
- * Update the reminder configuration for an envelope.
- */
-declare const updateEnvelopeReminder: (endpoint: VerdocsEndpoint, envelopeId: string, reminderId: string, params: ICreateEnvelopeReminderRequest) => Promise<IReminder>;
-/**
- * Delete the reminder configuration for an envelope.
- */
-declare const deleteEnvelopeReminder: (endpoint: VerdocsEndpoint, envelopeId: string, reminderId: string) => Promise<any>;
 /**
  * Check to see if the user owns the envelope.
  */
@@ -2346,27 +2328,6 @@ declare const getFieldsForRole: (template: ITemplate, role_name: string) => ITem
  * have at least one signer, and every signer must have at least one field.
  */
 declare const userCanPreviewTemplate: (profile: IProfile | null | undefined, template: ITemplate) => boolean | null | undefined;
-interface ICreateTemplateReminderRequest {
-    setup_time: number;
-    interval_time: number;
-}
-/**
- * Enable automatic reminders. setup_time is the number of days after the envelope is sent that the first reminder
- * should be sent. interval_time is the number of days between reminders.
- */
-declare const createTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, params: ICreateTemplateReminderRequest) => Promise<ITemplate>;
-/**
- * Get the reminder configuration for a template.
- */
-declare const getTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string) => Promise<IReminder>;
-/**
- * Update the reminder configuration for a template.
- */
-declare const updateTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string, params: ICreateTemplateReminderRequest) => Promise<IReminder>;
-/**
- * Delete the reminder configuration for a template.
- */
-declare const deleteTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string) => Promise<any>;
 /**
  * Create a role.
  *
@@ -2543,15 +2504,10 @@ interface ITemplateCreateParams {
     is_public?: boolean;
     /** Optional (defaults to EVERYONE_AS_CREATOR). Who may create and send envelopes using this template. */
     sender?: TTemplateSenderType;
-    /** Optional (defaults to inactive). Enable reminders for the template. */
-    reminders?: {
-        /** Set to false to deactivate. */
-        is_on: boolean;
-        /** Delay (in ms) before the first reminder will be sent (min: 4hrs). If on, defaults to 86400000 (1 day). */
-        setup_time: number;
-        /** Delay (in ms) between subsequent reminders (min: 12hrs). If on, defaults to 86400000 (1 day). */
-        interval_time: number;
-    };
+    /** 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;
     /** Optional description for the template to help identify it. */
     description?: string;
     /**
@@ -2682,7 +2638,7 @@ declare const getTemplateDocumentThumbnail: (endpoint: VerdocsEndpoint, template
  * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants. The
  * original asset may be obtained by calling `getTemplateDocumentFile()` or similar.
  */
-declare const getTemplateDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, templateId: string, documentId: string, page: number) => Promise<string>;
+declare const getTemplateDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, documentId: string, page: number, variant?: "original" | "tagged") => Promise<string>;
 interface IValidator {
     name: string;
     regex: string;
@@ -2810,4 +2766,4 @@ declare const decodeJWTBody: (token: string) => any;
  * the presence of the `document_id` field, which will only be present for signing sessions.
  */
 declare const decodeAccessTokenBody: (token: string) => TSession;
-export { TRequestStatus, TTemplateSenderType, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, TTemplateVisibility, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, WEBHOOK_EVENTS, ALL_PERMISSIONS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IDropdownOption, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IRecipient, IReminder, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelope, getEnvelopeDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, ITimeRange, IListEnvelopesParams, getEnvelopes, createInitials, IRecipientKbaStepNone, IRecipientKbaStepComplete, IRecipientKbaStepPin, IRecipientKbaStepIdentity, IRecipientKbaStepChallenge, IRecipientKbaStepFailed, TRecipientKbaStep, getKbaStep, submitKbaPin, IKbaIdentity, submitKbaIdentity, IKbaChallengeResponse, submitKbaChallengeResponse, updateRecipient, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, startSigningSession, getInPersonLink, sendDelegate, resendInvitation, createEnvelopeReminder, getEnvelopeReminder, updateEnvelopeReminder, deleteEnvelopeReminder, userIsEnvelopeOwner, userIsEnvelopeRecipient, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResult, IDocumentSearchOptions, ICreateEnvelopeRecipient, ISignerTokenResponse, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeFromTemplateRequest, ICreateEnvelopeDirectlyRequest, TCreateEnvelopeRequest, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getOrganizationContacts, deleteOrganizationContact, createOrganizationContact, updateOrganizationContact, getGroups, getGroup, createGroup, updateGroup, deleteGroup, addGroupMember, deleteGroupMember, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, getOrganizationMembers, deleteOrganizationMember, updateOrganizationMember, getOrganization, updateOrganization, updateOrganizationLogo, updateOrganizationThumbnail, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, IAcceptOrganizationInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, TTemplatePermissionCreatePublic, TTemplatePermissionCreateOrg, TTemplatePermissionCreatePersonal, TTemplatePermissionDelete, TTemplatePermissionVisibility, TTemplateMemberRead, TTemplateMemberWrite, TTemplateMemberDelete, TTemplateMemberVisibility, TTemplatePermission, TAccountPermissionOwnerAdd, TAccountPermissionOwnerRemove, TAccountPermissionAdminAdd, TAccountPermissionAdminRemove, TAccountPermissionMemberView, TAccountPermissionMemberAdd, TAccountPermissionMemberRemove, TAccountPermission, TOrgPermissionCreate, TOrgPermissionView, TOrgPermissionUpdate, TOrgPermissionDelete, TOrgPermissionTransfer, TOrgPermissionList, TOrgPermission, TEnvelopePermissionCreate, TEnvelopePermissionCancel, TEnvelopePermissionView, TEnvelopePermissionOrg, TEnvelopePermission, TPermission, TRole, RolePermissions, userHasPermissions, ISigningSession, IUserSession, IIdToken, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, userIsTemplateCreator, userHasSharedTemplate, userCanCreatePersonalTemplate, userCanCreateOrgTemplate, userCanCreatePublicTemplate, userCanReadTemplate, userCanUpdateTemplate, userCanMakeTemplatePrivate, userCanMakeTemplateShared, userCanMakeTemplatePublic, userCanChangeOrgVisibility, userCanDeleteTemplate, userCanSendTemplate, userCanCreateTemplate, userCanBuildTemplate, getFieldsForRole, userCanPreviewTemplate, ICreateTemplateReminderRequest, createTemplateReminder, getTemplateReminder, updateTemplateReminder, deleteTemplateReminder, createTemplateRole, updateTemplateRole, deleteTemplateRole, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, ITemplateSortBy, IGetTemplatesParams, getTemplates, getTemplate, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateTag, ITag, IStar, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, resendVerification, verifyEmail, getMyUser, getNotifications, getProfiles, getCurrentProfile, switchProfile, updateProfile, deleteProfile, createProfile, updateProfilePhoto, ICreateProfileRequest, IUpdateProfileRequest, IAuthenticateResponse, IChangePasswordRequest, IChangePasswordResponse, IResetPasswordRequest, IResetPasswordResponse, IVerifyEmailRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, getRTop, getRLeft, getRValue, blobToBase64, rescale, fileToDataUrl, downloadBlob, Countries, getCountryByCode, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, getPlusOneCountry, isCanada, isAmericanSamoa, isDominicanRepublic, isPuertoRico, getMatchingCountry, integerSequence, formatFullName, formatInitials, fullNameToInitials, capitalize, convertToE164, randomString, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry };
+export { TRequestStatus, TTemplateSenderType, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, TTemplateVisibility, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, WEBHOOK_EVENTS, ALL_PERMISSIONS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IDropdownOption, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IRecipient, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelope, getEnvelopeDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, ITimeRange, IListEnvelopesParams, getEnvelopes, createInitials, IRecipientKbaStepNone, IRecipientKbaStepComplete, IRecipientKbaStepPin, IRecipientKbaStepIdentity, IRecipientKbaStepChallenge, IRecipientKbaStepFailed, TRecipientKbaStep, getKbaStep, submitKbaPin, IKbaIdentity, submitKbaIdentity, IKbaChallengeResponse, submitKbaChallengeResponse, updateRecipient, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, startSigningSession, getInPersonLink, sendDelegate, resendInvitation, userIsEnvelopeOwner, userIsEnvelopeRecipient, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResult, IDocumentSearchOptions, ICreateEnvelopeRecipient, ISignerTokenResponse, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeFromTemplateRequest, ICreateEnvelopeDirectlyRequest, TCreateEnvelopeRequest, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getOrganizationContacts, deleteOrganizationContact, createOrganizationContact, updateOrganizationContact, getGroups, getGroup, createGroup, updateGroup, deleteGroup, addGroupMember, deleteGroupMember, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, getOrganizationMembers, deleteOrganizationMember, updateOrganizationMember, getOrganization, updateOrganization, updateOrganizationLogo, updateOrganizationThumbnail, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, IAcceptOrganizationInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, TTemplatePermissionCreatePublic, TTemplatePermissionCreateOrg, TTemplatePermissionCreatePersonal, TTemplatePermissionDelete, TTemplatePermissionVisibility, TTemplateMemberRead, TTemplateMemberWrite, TTemplateMemberDelete, TTemplateMemberVisibility, TTemplatePermission, TAccountPermissionOwnerAdd, TAccountPermissionOwnerRemove, TAccountPermissionAdminAdd, TAccountPermissionAdminRemove, TAccountPermissionMemberView, TAccountPermissionMemberAdd, TAccountPermissionMemberRemove, TAccountPermission, TOrgPermissionCreate, TOrgPermissionView, TOrgPermissionUpdate, TOrgPermissionDelete, TOrgPermissionTransfer, TOrgPermissionList, TOrgPermission, TEnvelopePermissionCreate, TEnvelopePermissionCancel, TEnvelopePermissionView, TEnvelopePermissionOrg, TEnvelopePermission, TPermission, TRole, RolePermissions, userHasPermissions, ISigningSession, IUserSession, IIdToken, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, userIsTemplateCreator, userHasSharedTemplate, userCanCreatePersonalTemplate, userCanCreateOrgTemplate, userCanCreatePublicTemplate, userCanReadTemplate, userCanUpdateTemplate, userCanMakeTemplatePrivate, userCanMakeTemplateShared, userCanMakeTemplatePublic, userCanChangeOrgVisibility, userCanDeleteTemplate, userCanSendTemplate, userCanCreateTemplate, userCanBuildTemplate, getFieldsForRole, userCanPreviewTemplate, createTemplateRole, updateTemplateRole, deleteTemplateRole, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, ITemplateSortBy, IGetTemplatesParams, getTemplates, getTemplate, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateTag, ITag, IStar, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, resendVerification, verifyEmail, getMyUser, getNotifications, getProfiles, getCurrentProfile, switchProfile, updateProfile, deleteProfile, createProfile, updateProfilePhoto, ICreateProfileRequest, IUpdateProfileRequest, IAuthenticateResponse, IChangePasswordRequest, IChangePasswordResponse, IResetPasswordRequest, IResetPasswordResponse, IVerifyEmailRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, getRTop, getRLeft, getRValue, blobToBase64, rescale, fileToDataUrl, downloadBlob, Countries, getCountryByCode, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, getPlusOneCountry, isCanada, isAmericanSamoa, isDominicanRepublic, isPuertoRico, getMatchingCountry, integerSequence, formatFullName, formatInitials, fullNameToInitials, capitalize, convertToE164, randomString, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry };

package/dist/index.d.ts

@@ -461,9 +461,12 @@ interface IEnvelope {
     profile_id: string;
     template_id: string | null;
     organization_id: string;
-    reminder_id: string | null;
     name: string;
     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;
     created_at: string;
     updated_at: string;
     canceled_at: string;
@@ -478,7 +481,6 @@ interface IEnvelope {
     profile?: IProfile;
     template?: ITemplate | null;
     organization?: IOrganization;
-    reminder?: IReminder | null;
     access_keys?: TAccessKey[];
     fields?: IEnvelopeField[];
     history_entries?: IEnvelopeHistory[];
@@ -669,16 +671,6 @@ interface IRecipient {
     envelope?: IEnvelope;
     profile?: IProfile;
 }
-interface IReminder {
-    id?: string;
-    is_on: boolean;
-    key: string;
-    setup_time: number;
-    interval_time: number;
-    created_at: string | null;
-    last_time: number | null;
-    next_time: number | null;
-}
 /**
  * A placeholder for an individual recipient, CC, or other party in a signing flow. Roles may be "known" or "unknown."
  * "Known" roles will have their email address supplied in the template which will get copied to envelopes created from
@@ -742,10 +734,6 @@ interface ITemplate {
      * Organization the template lives in.
      */
     organization_id: string;
-    /**
-     * If set, the template has reminders enabled.
-     */
-    reminder_id: string | null;
     /**
      * Who may create new documents from the template.
      */
@@ -766,6 +754,10 @@ interface ITemplate {
      * Number of times the template has been "starred".
      */
     star_counter: number;
+    /** 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 true, the template is only visible to the creator. If false, the template will also be visible to the user's
      * organization, if any.
@@ -808,7 +800,6 @@ interface ITemplate {
     tags?: string[];
     profile?: IProfile;
     organization?: IOrganization;
-    reminder?: IReminder | null;
     roles?: IRole[];
     documents?: ITemplateDocument[];
     fields?: ITemplateField[];
@@ -1275,6 +1266,10 @@ interface ICreateEnvelopeFromTemplateRequest {
     fields?: Pick<IEnvelopeField, "name" | "role_name" | "default">[];
     environment?: string;
     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;
 }
 interface ICreateEnvelopeDirectlyRequest {
     name: string;
@@ -1285,6 +1280,10 @@ interface ICreateEnvelopeDirectlyRequest {
     fields: Pick<IEnvelopeField, "name" | "role_name" | "default">[];
     environment?: string;
     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;
 }
 type TCreateEnvelopeRequest = ICreateEnvelopeFromTemplateRequest | ICreateEnvelopeDirectlyRequest;
 /**
@@ -1381,7 +1380,7 @@ declare const getFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string
  * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are intended
  * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants.
  */
-declare const getEnvelopeDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string, page: number, type?: "original" | "filled" | "certificate") => Promise<string>;
+declare const getEnvelopeDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, documentId: string, page: number, variant?: "original" | "filled" | "certificate") => Promise<string>;
 interface ITimeRange {
     start: string;
     end: string;
@@ -1563,23 +1562,6 @@ declare const sendDelegate: (endpoint: VerdocsEndpoint, envelopeId: string, role
  * Resend a recipient's invitation.
  */
 declare const resendInvitation: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<any>;
-/**
- * Enable automatic reminders. setup_time is the number of days after the envelope is sent that the first reminder
- * should be sent. interval_time is the number of days between reminders.
- */
-declare const createEnvelopeReminder: (endpoint: VerdocsEndpoint, envelopeId: string, params: ICreateEnvelopeReminderRequest) => Promise<IReminder>;
-/**
- * Get the reminder configuration for an envelope.
- */
-declare const getEnvelopeReminder: (endpoint: VerdocsEndpoint, envelopeId: string, reminderId: string) => Promise<IReminder>;
-/**
- * Update the reminder configuration for an envelope.
- */
-declare const updateEnvelopeReminder: (endpoint: VerdocsEndpoint, envelopeId: string, reminderId: string, params: ICreateEnvelopeReminderRequest) => Promise<IReminder>;
-/**
- * Delete the reminder configuration for an envelope.
- */
-declare const deleteEnvelopeReminder: (endpoint: VerdocsEndpoint, envelopeId: string, reminderId: string) => Promise<any>;
 /**
  * Check to see if the user owns the envelope.
  */
@@ -2346,27 +2328,6 @@ declare const getFieldsForRole: (template: ITemplate, role_name: string) => ITem
  * have at least one signer, and every signer must have at least one field.
  */
 declare const userCanPreviewTemplate: (profile: IProfile | null | undefined, template: ITemplate) => boolean | null | undefined;
-interface ICreateTemplateReminderRequest {
-    setup_time: number;
-    interval_time: number;
-}
-/**
- * Enable automatic reminders. setup_time is the number of days after the envelope is sent that the first reminder
- * should be sent. interval_time is the number of days between reminders.
- */
-declare const createTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, params: ICreateTemplateReminderRequest) => Promise<ITemplate>;
-/**
- * Get the reminder configuration for a template.
- */
-declare const getTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string) => Promise<IReminder>;
-/**
- * Update the reminder configuration for a template.
- */
-declare const updateTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string, params: ICreateTemplateReminderRequest) => Promise<IReminder>;
-/**
- * Delete the reminder configuration for a template.
- */
-declare const deleteTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string) => Promise<any>;
 /**
  * Create a role.
  *
@@ -2543,15 +2504,10 @@ interface ITemplateCreateParams {
     is_public?: boolean;
     /** Optional (defaults to EVERYONE_AS_CREATOR). Who may create and send envelopes using this template. */
     sender?: TTemplateSenderType;
-    /** Optional (defaults to inactive). Enable reminders for the template. */
-    reminders?: {
-        /** Set to false to deactivate. */
-        is_on: boolean;
-        /** Delay (in ms) before the first reminder will be sent (min: 4hrs). If on, defaults to 86400000 (1 day). */
-        setup_time: number;
-        /** Delay (in ms) between subsequent reminders (min: 12hrs). If on, defaults to 86400000 (1 day). */
-        interval_time: number;
-    };
+    /** 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;
     /** Optional description for the template to help identify it. */
     description?: string;
     /**
@@ -2682,7 +2638,7 @@ declare const getTemplateDocumentThumbnail: (endpoint: VerdocsEndpoint, template
  * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants. The
  * original asset may be obtained by calling `getTemplateDocumentFile()` or similar.
  */
-declare const getTemplateDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, templateId: string, documentId: string, page: number) => Promise<string>;
+declare const getTemplateDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, documentId: string, page: number, variant?: "original" | "tagged") => Promise<string>;
 interface IValidator {
     name: string;
     regex: string;
@@ -2810,4 +2766,4 @@ declare const decodeJWTBody: (token: string) => any;
  * the presence of the `document_id` field, which will only be present for signing sessions.
  */
 declare const decodeAccessTokenBody: (token: string) => TSession;
-export { TRequestStatus, TTemplateSenderType, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, TTemplateVisibility, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, WEBHOOK_EVENTS, ALL_PERMISSIONS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IDropdownOption, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IRecipient, IReminder, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelope, getEnvelopeDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, ITimeRange, IListEnvelopesParams, getEnvelopes, createInitials, IRecipientKbaStepNone, IRecipientKbaStepComplete, IRecipientKbaStepPin, IRecipientKbaStepIdentity, IRecipientKbaStepChallenge, IRecipientKbaStepFailed, TRecipientKbaStep, getKbaStep, submitKbaPin, IKbaIdentity, submitKbaIdentity, IKbaChallengeResponse, submitKbaChallengeResponse, updateRecipient, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, startSigningSession, getInPersonLink, sendDelegate, resendInvitation, createEnvelopeReminder, getEnvelopeReminder, updateEnvelopeReminder, deleteEnvelopeReminder, userIsEnvelopeOwner, userIsEnvelopeRecipient, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResult, IDocumentSearchOptions, ICreateEnvelopeRecipient, ISignerTokenResponse, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeFromTemplateRequest, ICreateEnvelopeDirectlyRequest, TCreateEnvelopeRequest, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getOrganizationContacts, deleteOrganizationContact, createOrganizationContact, updateOrganizationContact, getGroups, getGroup, createGroup, updateGroup, deleteGroup, addGroupMember, deleteGroupMember, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, getOrganizationMembers, deleteOrganizationMember, updateOrganizationMember, getOrganization, updateOrganization, updateOrganizationLogo, updateOrganizationThumbnail, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, IAcceptOrganizationInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, TTemplatePermissionCreatePublic, TTemplatePermissionCreateOrg, TTemplatePermissionCreatePersonal, TTemplatePermissionDelete, TTemplatePermissionVisibility, TTemplateMemberRead, TTemplateMemberWrite, TTemplateMemberDelete, TTemplateMemberVisibility, TTemplatePermission, TAccountPermissionOwnerAdd, TAccountPermissionOwnerRemove, TAccountPermissionAdminAdd, TAccountPermissionAdminRemove, TAccountPermissionMemberView, TAccountPermissionMemberAdd, TAccountPermissionMemberRemove, TAccountPermission, TOrgPermissionCreate, TOrgPermissionView, TOrgPermissionUpdate, TOrgPermissionDelete, TOrgPermissionTransfer, TOrgPermissionList, TOrgPermission, TEnvelopePermissionCreate, TEnvelopePermissionCancel, TEnvelopePermissionView, TEnvelopePermissionOrg, TEnvelopePermission, TPermission, TRole, RolePermissions, userHasPermissions, ISigningSession, IUserSession, IIdToken, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, userIsTemplateCreator, userHasSharedTemplate, userCanCreatePersonalTemplate, userCanCreateOrgTemplate, userCanCreatePublicTemplate, userCanReadTemplate, userCanUpdateTemplate, userCanMakeTemplatePrivate, userCanMakeTemplateShared, userCanMakeTemplatePublic, userCanChangeOrgVisibility, userCanDeleteTemplate, userCanSendTemplate, userCanCreateTemplate, userCanBuildTemplate, getFieldsForRole, userCanPreviewTemplate, ICreateTemplateReminderRequest, createTemplateReminder, getTemplateReminder, updateTemplateReminder, deleteTemplateReminder, createTemplateRole, updateTemplateRole, deleteTemplateRole, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, ITemplateSortBy, IGetTemplatesParams, getTemplates, getTemplate, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateTag, ITag, IStar, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, resendVerification, verifyEmail, getMyUser, getNotifications, getProfiles, getCurrentProfile, switchProfile, updateProfile, deleteProfile, createProfile, updateProfilePhoto, ICreateProfileRequest, IUpdateProfileRequest, IAuthenticateResponse, IChangePasswordRequest, IChangePasswordResponse, IResetPasswordRequest, IResetPasswordResponse, IVerifyEmailRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, getRTop, getRLeft, getRValue, blobToBase64, rescale, fileToDataUrl, downloadBlob, Countries, getCountryByCode, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, getPlusOneCountry, isCanada, isAmericanSamoa, isDominicanRepublic, isPuertoRico, getMatchingCountry, integerSequence, formatFullName, formatInitials, fullNameToInitials, capitalize, convertToE164, randomString, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry };
+export { TRequestStatus, TTemplateSenderType, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, TTemplateVisibility, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, WEBHOOK_EVENTS, ALL_PERMISSIONS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IDropdownOption, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IRecipient, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelope, getEnvelopeDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, ITimeRange, IListEnvelopesParams, getEnvelopes, createInitials, IRecipientKbaStepNone, IRecipientKbaStepComplete, IRecipientKbaStepPin, IRecipientKbaStepIdentity, IRecipientKbaStepChallenge, IRecipientKbaStepFailed, TRecipientKbaStep, getKbaStep, submitKbaPin, IKbaIdentity, submitKbaIdentity, IKbaChallengeResponse, submitKbaChallengeResponse, updateRecipient, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, startSigningSession, getInPersonLink, sendDelegate, resendInvitation, userIsEnvelopeOwner, userIsEnvelopeRecipient, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResult, IDocumentSearchOptions, ICreateEnvelopeRecipient, ISignerTokenResponse, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeFromTemplateRequest, ICreateEnvelopeDirectlyRequest, TCreateEnvelopeRequest, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getOrganizationContacts, deleteOrganizationContact, createOrganizationContact, updateOrganizationContact, getGroups, getGroup, createGroup, updateGroup, deleteGroup, addGroupMember, deleteGroupMember, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, getOrganizationMembers, deleteOrganizationMember, updateOrganizationMember, getOrganization, updateOrganization, updateOrganizationLogo, updateOrganizationThumbnail, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, IAcceptOrganizationInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, TTemplatePermissionCreatePublic, TTemplatePermissionCreateOrg, TTemplatePermissionCreatePersonal, TTemplatePermissionDelete, TTemplatePermissionVisibility, TTemplateMemberRead, TTemplateMemberWrite, TTemplateMemberDelete, TTemplateMemberVisibility, TTemplatePermission, TAccountPermissionOwnerAdd, TAccountPermissionOwnerRemove, TAccountPermissionAdminAdd, TAccountPermissionAdminRemove, TAccountPermissionMemberView, TAccountPermissionMemberAdd, TAccountPermissionMemberRemove, TAccountPermission, TOrgPermissionCreate, TOrgPermissionView, TOrgPermissionUpdate, TOrgPermissionDelete, TOrgPermissionTransfer, TOrgPermissionList, TOrgPermission, TEnvelopePermissionCreate, TEnvelopePermissionCancel, TEnvelopePermissionView, TEnvelopePermissionOrg, TEnvelopePermission, TPermission, TRole, RolePermissions, userHasPermissions, ISigningSession, IUserSession, IIdToken, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, userIsTemplateCreator, userHasSharedTemplate, userCanCreatePersonalTemplate, userCanCreateOrgTemplate, userCanCreatePublicTemplate, userCanReadTemplate, userCanUpdateTemplate, userCanMakeTemplatePrivate, userCanMakeTemplateShared, userCanMakeTemplatePublic, userCanChangeOrgVisibility, userCanDeleteTemplate, userCanSendTemplate, userCanCreateTemplate, userCanBuildTemplate, getFieldsForRole, userCanPreviewTemplate, createTemplateRole, updateTemplateRole, deleteTemplateRole, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, ITemplateSortBy, IGetTemplatesParams, getTemplates, getTemplate, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateTag, ITag, IStar, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, resendVerification, verifyEmail, getMyUser, getNotifications, getProfiles, getCurrentProfile, switchProfile, updateProfile, deleteProfile, createProfile, updateProfilePhoto, ICreateProfileRequest, IUpdateProfileRequest, IAuthenticateResponse, IChangePasswordRequest, IChangePasswordResponse, IResetPasswordRequest, IResetPasswordResponse, IVerifyEmailRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, getRTop, getRLeft, getRValue, blobToBase64, rescale, fileToDataUrl, downloadBlob, Countries, getCountryByCode, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, getPlusOneCountry, isCanada, isAmericanSamoa, isDominicanRepublic, isPuertoRico, getMatchingCountry, integerSequence, formatFullName, formatInitials, fullNameToInitials, capitalize, convertToE164, randomString, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry };

package/dist/index.js

@@ -1580,9 +1580,7 @@ const getFieldAttachment = async (endpoint, envelopeId, fieldName) => endpoint.a
  * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are intended
  * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants.
  */
-const getEnvelopeDocumentPageDisplayUri = async (endpoint, envelopeId, documentId, page, type = 'original') => endpoint.api
-    .get(`/envelopes/${envelopeId}/envelope_documents/${documentId}/pages/${page}/image?type=${type}`, { timeout: 20000 })
-    .then((r) => r.data);
+const getEnvelopeDocumentPageDisplayUri = async (endpoint, documentId, page, variant = 'original') => endpoint.api.get(`/v2/envelope-documents/page-image/${documentId}/${variant}/${page}`, { timeout: 20000 }).then((r) => r.data);
 /**
  * Lists all envelopes accessible by the caller, with optional filters.
  *
@@ -1704,32 +1702,6 @@ const resendInvitation = (endpoint, envelopeId, roleName) => endpoint.api //
     .put(`/v2/envelopes/${envelopeId}/recipients/${encodeURIComponent(roleName)}`, { action: 'resend' })
     .then((r) => r.data);
 
-/**
- * Enable automatic reminders. setup_time is the number of days after the envelope is sent that the first reminder
- * should be sent. interval_time is the number of days between reminders.
- */
-const createEnvelopeReminder = (endpoint, envelopeId, params) => endpoint.api //
-    .post(`/envelopes/${envelopeId}/reminder/`, params)
-    .then((r) => r.data);
-/**
- * Get the reminder configuration for an envelope.
- */
-const getEnvelopeReminder = (endpoint, envelopeId, reminderId) => endpoint.api //
-    .get(`/envelopes/${envelopeId}/reminder/${reminderId}`)
-    .then((r) => r.data);
-/**
- * Update the reminder configuration for an envelope.
- */
-const updateEnvelopeReminder = (endpoint, envelopeId, reminderId, params) => endpoint.api //
-    .put(`/envelopes/${envelopeId}/reminder/${reminderId}`, params)
-    .then((r) => r.data);
-/**
- * Delete the reminder configuration for an envelope.
- */
-const deleteEnvelopeReminder = (endpoint, envelopeId, reminderId) => endpoint.api //
-    .delete(`/envelopes/${envelopeId}/reminder/${reminderId}`)
-    .then((r) => r.data);
-
 /**
  * Various helpers to identify available operations for an envelope by a user.
  *
@@ -2591,32 +2563,6 @@ const userCanPreviewTemplate = (profile, template) => {
     return hasPermission && signers.length > 0 && signers.every((signer) => getFieldsForRole(template, signer.name).length > 0);
 };
 
-/**
- * Enable automatic reminders. setup_time is the number of days after the envelope is sent that the first reminder
- * should be sent. interval_time is the number of days between reminders.
- */
-const createTemplateReminder = (endpoint, templateId, params) => endpoint.api //
-    .post(`/templates/${templateId}/reminder/`, params)
-    .then((r) => r.data);
-/**
- * Get the reminder configuration for a template.
- */
-const getTemplateReminder = (endpoint, templateId, reminderId) => endpoint.api //
-    .get(`/templates/${templateId}/reminder/${reminderId}`)
-    .then((r) => r.data);
-/**
- * Update the reminder configuration for a template.
- */
-const updateTemplateReminder = (endpoint, templateId, reminderId, params) => endpoint.api //
-    .put(`/templates/${templateId}/reminder/${reminderId}`, params)
-    .then((r) => r.data);
-/**
- * Delete the reminder configuration for a template.
- */
-const deleteTemplateReminder = (endpoint, templateId, reminderId) => endpoint.api //
-    .delete(`/templates/${templateId}/reminder/${reminderId}`)
-    .then((r) => r.data);
-
 /**
  * A "role" is an individual participant in a signing flow, such as a signer or CC contact.
  * A role is a placeholder that will eventually become a named recipient. For example, "Tenant 1"
@@ -2950,7 +2896,7 @@ const getTemplateDocumentThumbnail = async (endpoint, templateId, documentId) =>
  * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants. The
  * original asset may be obtained by calling `getTemplateDocumentFile()` or similar.
  */
-const getTemplateDocumentPageDisplayUri = async (endpoint, templateId, documentId, page) => endpoint.api.get(`/templates/${templateId}/documents/${documentId}/pages/${page}/image`).then((r) => r.data);
+const getTemplateDocumentPageDisplayUri = async (endpoint, documentId, page, variant = 'original') => endpoint.api.get(`/v2/template-documents/page-image/${documentId}/${variant}/${page}`, { timeout: 20000 }).then((r) => r.data);
 
 /**
  * Get all defined validators
@@ -2997,7 +2943,6 @@ exports.changePassword = changePassword;
 exports.convertToE164 = convertToE164;
 exports.createApiKey = createApiKey;
 exports.createEnvelope = createEnvelope;
-exports.createEnvelopeReminder = createEnvelopeReminder;
 exports.createField = createField;
 exports.createGroup = createGroup;
 exports.createInitials = createInitials;
@@ -3009,14 +2954,12 @@ exports.createTag = createTag;
 exports.createTemplate = createTemplate;
 exports.createTemplateDocument = createTemplateDocument;
 exports.createTemplateFromSharepoint = createTemplateFromSharepoint;
-exports.createTemplateReminder = createTemplateReminder;
 exports.createTemplateRole = createTemplateRole;
 exports.declineOrganizationInvitation = declineOrganizationInvitation;
 exports.decodeAccessTokenBody = decodeAccessTokenBody;
 exports.decodeJWTBody = decodeJWTBody;
 exports.deleteApiKey = deleteApiKey;
 exports.deleteEnvelopeFieldAttachment = deleteEnvelopeFieldAttachment;
-exports.deleteEnvelopeReminder = deleteEnvelopeReminder;
 exports.deleteField = deleteField;
 exports.deleteGroup = deleteGroup;
 exports.deleteGroupMember = deleteGroupMember;
@@ -3027,7 +2970,6 @@ exports.deleteProfile = deleteProfile;
 exports.deleteSignature = deleteSignature;
 exports.deleteTemplate = deleteTemplate;
 exports.deleteTemplateDocument = deleteTemplateDocument;
-exports.deleteTemplateReminder = deleteTemplateReminder;
 exports.deleteTemplateRole = deleteTemplateRole;
 exports.deleteTemplateTag = deleteTemplateTag;
 exports.downloadBlob = downloadBlob;
@@ -3054,7 +2996,6 @@ exports.getEnvelope = getEnvelope;
 exports.getEnvelopeDocument = getEnvelopeDocument;
 exports.getEnvelopeDocumentPageDisplayUri = getEnvelopeDocumentPageDisplayUri;
 exports.getEnvelopeFile = getEnvelopeFile;
-exports.getEnvelopeReminder = getEnvelopeReminder;
 exports.getEnvelopes = getEnvelopes;
 exports.getFieldAttachment = getFieldAttachment;
 exports.getFieldsForRole = getFieldsForRole;
@@ -3090,7 +3031,6 @@ exports.getTemplateDocumentFile = getTemplateDocumentFile;
 exports.getTemplateDocumentPageDisplayUri = getTemplateDocumentPageDisplayUri;
 exports.getTemplateDocumentThumbnail = getTemplateDocumentThumbnail;
 exports.getTemplateDocuments = getTemplateDocuments;
-exports.getTemplateReminder = getTemplateReminder;
 exports.getTemplateTags = getTemplateTags;
 exports.getTemplates = getTemplates;
 exports.getValidator = getValidator;
@@ -3133,7 +3073,6 @@ exports.updateApiKey = updateApiKey;
 exports.updateEnvelopeField = updateEnvelopeField;
 exports.updateEnvelopeFieldInitials = updateEnvelopeFieldInitials;
 exports.updateEnvelopeFieldSignature = updateEnvelopeFieldSignature;
-exports.updateEnvelopeReminder = updateEnvelopeReminder;
 exports.updateField = updateField;
 exports.updateGroup = updateGroup;
 exports.updateOrganization = updateOrganization;
@@ -3146,7 +3085,6 @@ exports.updateProfile = updateProfile;
 exports.updateProfilePhoto = updateProfilePhoto;
 exports.updateRecipient = updateRecipient;
 exports.updateTemplate = updateTemplate;
-exports.updateTemplateReminder = updateTemplateReminder;
 exports.updateTemplateRole = updateTemplateRole;
 exports.uploadEnvelopeFieldAttachment = uploadEnvelopeFieldAttachment;
 exports.userCanAct = userCanAct;