@verdocs/js-sdk 6.1.1 → 6.2.0-beta.2

package/dist/index.mjs

@@ -1608,13 +1608,13 @@ const getEnvelope = async (endpoint, envelopeId) => endpoint.api //
  * @apiParam string(format: 'uuid') document_id The ID of the document to retrieve.
  * @apiSuccess IEnvelopeDocument . The detailed metadata for the document requested
  */
-const getEnvelopeDocument = async (endpoint, _envelopeId, documentId) => endpoint.api //
+const getEnvelopeDocument = async (endpoint, documentId) => endpoint.api //
     .get(`/v2/envelope-documents/${documentId}`)
     .then((r) => r.data);
 /**
  * Download a document directly.
  */
-const downloadDocument = async (endpoint, _envelopeId, documentId) => endpoint.api //
+const downloadEnvelopeDocument = async (endpoint, documentId) => endpoint.api //
     .get(`/v2/envelope-documents/${documentId}?type=file`, { responseType: 'blob' })
     .then((r) => r.data);
 /**
@@ -1630,14 +1630,14 @@ const downloadDocument = async (endpoint, _envelopeId, documentId) => endpoint.a
  * @apiQuery string(enum:'file'|'download'|'preview') type? Download the file directly, generate a download link, or generate a preview link.
  * @apiSuccess string . The generated link.
  */
-const getDocumentDownloadLink = async (endpoint, _envelopeId, documentId) => endpoint.api //
+const getEnvelopeDocumentDownloadLink = async (endpoint, documentId) => endpoint.api //
     .get(`/v2/envelope-documents/${documentId}?type=download`)
     .then((r) => r.data);
 /**
  * Get a pre-signed preview link for an Envelope Document. This link expires quickly, so it should
  * be accessed immediately and never shared. Content-Disposition will be set to "inline".
  */
-const getDocumentPreviewLink = async (endpoint, _envelopeId, documentId) => endpoint.api //
+const getEnvelopeDocumentPreviewLink = async (endpoint, documentId) => endpoint.api //
     .get(`/v2/envelope-documents/${documentId}?type=preview`)
     .then((r) => r.data);
 /**
@@ -1659,7 +1659,7 @@ const cancelEnvelope = async (endpoint, envelopeId) => endpoint.api //
  *
  * @deprecated Use getDocumentPreviewLink/getDocumentDownloadLink/downloadDocument instead.
  */
-const getEnvelopeFile = async (endpoint, envelopeId, documentId) => endpoint.api //
+const getEnvelopeFile = async (endpoint, documentId) => endpoint.api //
     .get(`/v2/envelope-documents/${documentId}?type=file`, { responseType: 'blob' })
     .then((r) => r.data);
 /**
@@ -1678,60 +1678,25 @@ const updateEnvelope = async (endpoint, envelopeId, params) => endpoint.api //
  * Update a Document field. Typically called during the signing process as a Recipient fills in fields.
  *
  * @group Envelopes
- * @api PUT /envelopes/:envelope_id/fields/:field_name Update Envelope Field
+ * @api PUT /v2/envelopes/:envelope_id/fields/:field_name Update Envelope Field
  * @apiParam string(format: 'uuid') envelope_id The ID of the envelope to retrieve.
+ * @apiParam string role_name The role to submit. Be sure to URL-encode the value.
  * @apiParam string field_name The name of the field to update. Be sure to URL-encode the value.
- * @apiBody IEnvelopeFieldSettings . Set of properties to update. Leave undefined any properties that should not be changed.
- * @apiSuccess IEnvelope . A copy of the newly-updated field.
+ * @apiParam string value The value to set. For signature/initial fields, the UUID of the signature/initial block. For attachment fields, a file uploaded in a FORM-POST field named "document". For checkbox/radio buttons, a boolean. For all other fields, a string.
+ * @apiBody value . Value to set.
+ * @apiSuccess IEnvelopeField . A copy of the newly-updated field.
  */
-const updateEnvelopeField = async (endpoint, envelopeId, fieldName, value) => endpoint.api //
-    .put(`/envelopes/${envelopeId}/fields/${fieldName}`, value)
+const updateEnvelopeField = async (endpoint, envelopeId, roleName, fieldName, value) => endpoint.api //
+    .put(`/v2/envelopes/${envelopeId}/recipients/${roleName}/fields/${fieldName}`, { value })
     .then((r) => r.data);
 /**
- * Apply a signature to a signature field. Signature fields are ID-driven. Call `createSignature()`
- * first to create a signature for a Recipient, then call `updateEnvelopeFieldSignature()` to
- * attach it to a field.
- *
- * @group Envelopes
- * @api PUT /envelopes/:envelope_id/fields/:field_name/signature/:signature_id Update Envelope
- * @apiParam string(format: 'uuid') envelope_id The ID of the envelope to update.
- * @apiParam string field_name The name of the field to update. Be sure to URL-encode the value.
- * @apiParam string(format: 'uuid') signature_id The ID of the signature to attach.
- * @apiSuccess IEnvelopeFieldSettings . A copy of the newly-updated field.
+ * Upload an attachment to an attachment field.
  */
-const updateEnvelopeFieldSignature = async (endpoint, envelopeId, fieldName, signatureId) => endpoint.api //
-    .put(`/envelopes/${envelopeId}/fields/${fieldName}/signature/${signatureId}`)
-    .then((r) => r.data);
-/**
- * Apply an initial to an initials field. Initial fields are ID-driven. Call `createInitial()`
- * first to create an initial block for a Recipient, then call `supdateEnvelopeFieldInitials()` to
- * attach it to a field.
- *
- * @group Envelopes
- * @api PUT /envelopes/:envelope_id/fields/:field_name/initial/:initial_id Update Envelope
- * @apiParam string(format: 'uuid') envelope_id The ID of the envelope to update.
- * @apiParam string field_name The name of the field to update. Be sure to URL-encode the value.
- * @apiParam string(format: 'uuid') initial_id The ID of the initial block to attach.
- * @apiSuccess IEnvelopeFieldSettings . A copy of the newly-updated field.
- */
-const updateEnvelopeFieldInitials = async (endpoint, envelopeId, fieldName, initialId) => endpoint.api //
-    .put(`/envelopes/${envelopeId}/fields/${fieldName}/initial/${initialId}`)
-    .then((r) => r.data);
-/**
- * Upload an attachment to an attachment field
- *
- * @group Envelopes
- * @api PUT /envelopes/:envelope_id/fields/:field_name Upload or Delete Attachment
- * @apiParam string(format: 'uuid') envelope_id The ID of the envelope to update.
- * @apiParam string field_name The name of the field to update. Be sure to URL-encode the value.
- * @apiBody string document The file to attach. Must contain standard File object fields. If omitted, the attachment will be deleted instead.
- * @apiSuccess IEnvelopeFieldSettings . A copy of the newly-updated field.
- */
-const uploadEnvelopeFieldAttachment = async (endpoint, envelopeId, fieldName, file, onUploadProgress) => {
+const uploadEnvelopeFieldAttachment = async (endpoint, envelopeId, roleName, fieldName, file, onUploadProgress) => {
     const formData = new FormData();
     formData.append('document', file, file.name);
     return endpoint.api //
-        .put(`/envelopes/${envelopeId}/fields/${fieldName}`, formData, {
+        .put(`/v2/envelopes/${envelopeId}/recipients/${roleName}/fields/${fieldName}`, formData, {
         timeout: 120000,
         onUploadProgress: (event) => {
             const total = event.total || 1;
@@ -1746,25 +1711,13 @@ const uploadEnvelopeFieldAttachment = async (endpoint, envelopeId, fieldName, fi
  * being deleted. Instead, it is a similar operation to uploading a new attachment, but the
  * omission of the attachment signals the server to delete the current entry.
  */
-const deleteEnvelopeFieldAttachment = async (endpoint, envelopeId, fieldName) => {
+const deleteEnvelopeFieldAttachment = async (endpoint, envelopeId, roleName, fieldName) => {
     const formData = new FormData();
     // Omitting file is the trigger here
     return endpoint.api //
-        .put(`/envelopes/${envelopeId}/fields/${fieldName}`, formData)
+        .put(`/v2/envelopes/${envelopeId}/recipients/${roleName}/fields/${fieldName}`, formData)
         .then((r) => r.data);
 };
-/**
- * Get the attached file for an attachment field (if any).
- *
- * @group Envelopes
- * @api GET /envelopes/:envelope_id/fields/:field_name/document Download attachment in binary format
- * @apiParam string(format: 'uuid') envelope_id The ID of the envelope to retrieve.
- * @apiParam string field_name The name of the field from which to download the attachment.
- * @apiSuccess string . The file binary data.
- */
-const getFieldAttachment = async (endpoint, envelopeId, fieldName) => endpoint.api //
-    .get(`/envelopes/${envelopeId}/fields/${fieldName}/document`, { responseType: 'blob' })
-    .then((r) => r.data);
 /**
  * Get a display URI for a given page in a file attached to an envelope document. These pages are rendered server-side
  * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are intended
@@ -1808,12 +1761,18 @@ const getEnvelopeDocumentPageDisplayUri = async (endpoint, documentId, page, var
 const getEnvelopes = (endpoint, params) => endpoint.api //
     .get('/v2/envelopes', { params })
     .then((r) => r.data);
+/**
+ * Generate a ZIP file containing all data for the specified envelopes. The caller must be the
+ * owner of each envelope. The returned ZIP file contains a folder for each envelope.
+ */
+const getEnvelopesZip = (endpoint, envelope_ids) => endpoint.api //
+    .get(`/v2/envelopes/zip/${envelope_ids.join(',')}`);
 
 /**
- * Create an initials block. In a typical signing workflow, the user is asked at the beginning of the process to "adopt"
- * an initials block to be used for all initials fields in the document. Thus, this is typically called one time to
- * create and store an initials block. Thereafter, the ID of the initials block may be re-used for each initials field
- * to be "stamped" by the user.
+ * Create an initials block. In a typical signing workflow, the user is asked at the beginning of the process to
+ * "adopt" an initials block to be used for all initials fields in the document. Thus, this is typically called
+ * one time to create and store an initials block. Thereafter, the ID of the initials block may be re-used for each
+ * initials field to be "stamped" by the user.
  *
  * Note: Both "guest" signers and authenticated users can create initials blocks. Guest signers
  * typically only ever have one, tied to that session. But authenticated users can create more than
@@ -1863,49 +1822,43 @@ const submitKbaChallengeResponse = (endpoint, envelope_id, role_name, responses)
     .then((r) => r.data);
 
 /**
- * Update a recipient's status.
+ * Agree to electronic signing dislosures.
  *
  * @group Recipients
- * @api PUT /envelopes/:envelope_id/recipients/:role_name Update Recipient Status
+ * @api POST /envelopes/:envelope_id/recipients/:role_name/agree Agree to e-Signing Disclosures
  * @apiParam string(format:uuid) envelope_id The envelope to operate on.
- * @apiParam string role_name The role to adjust.
- * @apiBody string(enum:'submit'|'decline'|'owner_update'|'update'|'prepare') action The action to take. Adjusts the status, and may also perform other operations.
- * @apiBody string first_name? Ignored unless action is 'owner_update' or 'update'. The new owner's or recipient's first name.
- * @apiBody string last_name? Ignored unless action is 'owner_update' or 'update'. The new owner's or recipient's last name.
- * @apiBody string email? Ignored unless action is 'owner_update'. The new owner's email address.
- * @apiBody boolean agreed? Ignored unless action is 'update'. Set to true to accept the e-signing disclosures.
- * @apiBody array(items:IRecipient) recipients? Ignored unless action is 'prepare'. A list of recipients and their fields to set defaults for.
+ * @apiParam string role_name The role to operate on.
  * @apiSuccess IRecipient . The updated Recipient.
  */
-const updateRecipientStatus = async (endpoint, envelope_id, role_name, params) => endpoint.api //
-    .put(`/envelopes/${envelope_id}/recipients/${role_name}`, params)
-    .then((r) => r.data);
-/**
- * Submit an envelope (signing is finished). Note that all fields must be valid/completed for this to succeed.
- */
-const envelopeRecipientSubmit = (endpoint, envelopeId, roleName) => updateRecipientStatus(endpoint, envelopeId, roleName, { action: 'submit' });
-/**
- * Decline to complete an envelope (signing will not terminated).
- */
-const envelopeRecipientDecline = (endpoint, envelopeId, roleName) => updateRecipientStatus(endpoint, envelopeId, roleName, { action: 'decline' });
-/**
- * Claim / change ownership of an envelope. This is a special-case operation only available in certain workflows.
- */
-const envelopeRecipientChangeOwner = (endpoint, envelope_id, role_name, email, first_name, last_name) => updateRecipientStatus(endpoint, envelope_id, role_name, { action: 'owner_update', email, first_name, last_name });
-/**
- * Agree to electronic signing disclosures.
- */
 const envelopeRecipientAgree = (endpoint, envelopeId, roleName, disclosures) => endpoint.api //
-    .put(`/v2/envelopes/${envelopeId}/recipients/${encodeURIComponent(roleName)}`, { action: 'accept', disclosures })
+    .post(`/v2/envelopes/${envelopeId}/recipients/${encodeURIComponent(roleName)}/agree`, { disclosures })
     .then((r) => r.data);
 /**
- * Change a recipient's name.
+ * Decline electronic signing dislosures. Note that if any recipient declines, the entire envelope
+ * becomes non-viable and later recipients may no longer act. The creator will receive a notification
+ * when this occurs.
+ *
+ * @group Recipients
+ * @api POST /envelopes/:envelope_id/recipients/:role_name/decline Decline e-Signing Disclosures
+ * @apiParam string(format:uuid) envelope_id The envelope to operate on.
+ * @apiParam string role_name The role to adjust.
+ * @apiSuccess IRecipient . The updated Recipient.
  */
-const envelopeRecipientUpdateName = (endpoint, envelopeId, roleName, first_name, last_name) => updateRecipientStatus(endpoint, envelopeId, roleName, { action: 'update', first_name, last_name });
+const envelopeRecipientDecline = (endpoint, envelopeId, roleName) => endpoint.api //
+    .post(`/v2/envelopes/${envelopeId}/recipients/${encodeURIComponent(roleName)}/decline`)
+    .then((r) => r.data);
 /**
- * Change a recipient's name.
+ * Submit an envelope (signing is finished). Note that all fields must be valid/completed for this to succeed.
+ *
+ * @group Recipients
+ * @api POST /envelopes/:envelope_id/recipients/:role_name/submit Submit envelope
+ * @apiParam string(format:uuid) envelope_id The envelope to operate on.
+ * @apiParam string role_name The role to submit.
+ * @apiSuccess IRecipient . The updated Recipient.
  */
-const envelopeRecipientPrepare = (endpoint, envelopeId, roleName, recipients) => updateRecipientStatus(endpoint, envelopeId, roleName, { action: 'prepare', recipients });
+const envelopeRecipientSubmit = (endpoint, envelopeId, roleName) => endpoint.api //
+    .put(`/v2/envelopes/${envelopeId}/recipients/${roleName}/submit`)
+    .then((r) => r.data);
 /**
  * Begin a signing session for an Envelope. This path requires an invite code, and should generally
  * be called with a NON-default Endpoint to avoid conflicting with any active user session the user
@@ -2099,7 +2052,7 @@ const recipientHasAction = (recipient) => !['submitted', 'canceled', 'declined']
 /**
  * Returns the recipients who still have a pending action. Note that not all of these recipients may be able to act (yet).
  */
-const getRecipientsWithActions = (envelope) => (envelope?.recipients || []).filter(recipientHasAction);
+const getRecipientsWithActions = (envelope) => ['complete', 'declined', 'canceled'].includes(envelope.status) ? [] : (envelope?.recipients || []).filter(recipientHasAction);
 /**
  * Returns true if the recipient can act.
  */
@@ -2131,10 +2084,10 @@ const getNextRecipient = (envelope) => {
 };
 
 /**
- * Create a signature block. In a typical signing workflow, the user is asked at the beginning of the process to "adopt"
- * a signature block to be used for all signature fields in the document. Thus, this is typically called one time to
- * create and store a signature block. Thereafter, the ID of the signature block may be re-used for each signature field
- * to be "stamped" by the user.
+ * Create a signature block. In a typical signing workflow, the user is asked at the beginning of the process to
+ * "adopt" a signature block to be used for all signature fields in the document. Thus, this is typically called one
+ * time to create and store a signature block. Thereafter, the ID of the signature block may be re-used for each
+ * signature field to be "stamped" by the user.
  *
  * Note: Both "guest" signers and authenticated users can create initials blocks. Guest signers
  * typically only ever have one, tied to that session. But authenticated users can create more than
@@ -2152,39 +2105,6 @@ const createSignature = (endpoint, name, signature) => {
         .post(`/v2/profiles/signatures`, data)
         .then((r) => r.data);
 };
-/**
- * Get the available signatures for a user.
- *
- * @group Signatures and Initials
- * @api GET /signatures Create Signature Block
- *
- * @apiSuccess array(items:ISignature) . A list of signatures previously stored for the user.
- */
-const getSignatures = (endpoint) => endpoint.api //
-    .get('/signatures')
-    .then((r) => r.data);
-/**
- * Get a user's signature by ID.
- *
- * @group Signatures and Initials
- * @api GET /signatures/:id Delete Signature Block
- * @apiParam string(format: 'uuid') id The ID of the signature to delete.
- * @apiSuccess ISignature . The signature metadata requested.
- */
-const getSignature = (endpoint, signatureId) => endpoint.api //
-    .get(`/signatures/${signatureId}`)
-    .then((r) => r.data);
-/**
- * Delete a user's signature.
- *
- * @group Signatures and Initials
- * @api DELETE /signatures/:id Delete Signature Block
- * @apiParam string(format: 'uuid') id The ID of the signature to delete.
- * @apiSuccess string . OK
- */
-const deleteSignature = (endpoint, signatureId) => endpoint.api //
-    .delete(`/signatures/${signatureId}`)
-    .then((r) => r.data);
 
 /**
  * API keys are used to authenticate server-to-server calls. (API keys should **never** be used for client-to-server operations!)
@@ -3306,63 +3226,6 @@ const deleteTemplateRole = (endpoint, template_id, name) => endpoint.api //
     .delete(`/v2/roles/${template_id}/${encodeURIComponent(name)}`)
     .then((r) => r.data);
 
-/**
- * Get the template stars for a template.
- */
-const getStars = (endpoint, templateId) => endpoint.api //
-    .get(`/templates/${templateId}/stars`)
-    .then((r) => r.data);
-/**
- * Toggle the template star for a template.
- */
-const toggleStar = (endpoint, templateId) => endpoint.api //
-    .post(`/templates/${templateId}/stars/toggle`)
-    .then((r) => r.data);
-
-/**
- * A Tag is a user-specified label applied to a template. Tags help users organize and find Templates.
- * recipients. Every Organization has a set of tags "owned" by that Organization and only visible inside it.
- * Verdocs also provides a set of system-wide "featured" tags available to all Organizations.
- *
- * @module
- */
-/**
- * Apply a tag to a template.
- */
-const addTemplateTag = (endpoint, templateId, params) => endpoint.api //
-    .post(`/templates/${templateId}/tags/`, params)
-    .then((r) => r.data);
-/**
- * Get all tags for a template.
- */
-const getTemplateTags = (endpoint, templateId) => endpoint.api //
-    .get(`/templates/${templateId}/tags/`)
-    .then((r) => r.data);
-/**
- * Remove a tag from a template.
- */
-const deleteTemplateTag = (endpoint, templateId, tagName) => endpoint.api //
-    .post(`/templates/${templateId}/tags/${tagName}`)
-    .then((r) => r.data);
-/**
- * Create an Organization-wide tag.
- */
-const createTag = (endpoint, name) => endpoint.api //
-    .post('/tags', { tag_name: name })
-    .then((r) => r.data);
-/**
- * Get an Organization-wide tag.
- */
-const getTag = (endpoint, name) => endpoint.api //
-    .get(`/tags/${name}`)
-    .then((r) => r.data);
-/**
- * Get all tags available for use by an Organization.
- */
-const getAllTags = (endpoint) => endpoint.api //
-    .get('/tags')
-    .then((r) => r.data);
-
 /**
  * A Template defines how a Verdocs signing flow will be performed, including attachments, signing fields, and
  * recipients.
@@ -3578,44 +3441,28 @@ const updateTemplate = (endpoint, templateId, params) => endpoint.api //
 const deleteTemplate = (endpoint, templateId) => endpoint.api //
     .delete(`/v2/templates/${templateId}`)
     .then((r) => r.data);
-
-/**
- * A TemplateDocument represents a PDF or other attachment in a Template.
- *
- * @module
- */
 /**
- * Get all the Template Documents associated to a particular Template.
+ * Toggle the template star for a template.
  *
  * ```typescript
- * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
+ * import {toggleTemplateStar} from '@verdocs/js-sdk/Templates';
  *
- * await TemplateDocument.geTemplateDocuments((VerdocsEndpoint.getDefault(), templateId);
+ * await toggleTemplateStar((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
  * ```
  *
- * @group Template Documents
- * @api GET /v2/templates/:template_id/documents List the documents assigned to a template
- * @apiSuccess array(items: ITemplateDocument) . Template documents
+ * @group Templates
+ * @api POST /v2/templates/:template_id/star Star or unstar a template (toggle state)
+ * @apiSuccess ITemplate . Success
  */
-const getTemplateDocuments = (endpoint, templateId) => endpoint.api //
-    .get(`/templates/${templateId}/documents/`)
+const toggleTemplateStar = (endpoint, templateId) => endpoint.api //
+    .post(`/v2/templates/${templateId}/stars/toggle`)
     .then((r) => r.data);
+
 /**
- * Get a specific Document.
- *
- * ```typescript
- * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
- *
- * await TemplateDocument.geTemplateDocument((VerdocsEndpoint.getDefault(), templateId,documentId);
- * ```
+ * A TemplateDocument represents a PDF or other attachment in a Template.
  *
- * @group Template Documents
- * @api GET /v2/templates/:template_id/documents/:document_id Get an individual template document
- * @apiSuccess ITemplateDocument . Template document
+ * @module
  */
-const getTemplateDocument = (endpoint, templateId, documentId) => endpoint.api //
-    .get(`/templates/${templateId}/documents/${documentId}`)
-    .then((r) => r.data);
 /**
  * Create a Document for a particular Template.
  *
@@ -3630,11 +3477,11 @@ const getTemplateDocument = (endpoint, templateId, documentId) => endpoint.api /
  * @apiBody string(format:binary) file Document file to attach. The file name will automatically be used as the document name.
  * @apiSuccess ITemplateDocument . Template document
  */
-const createTemplateDocument = (endpoint, templateId, file, onUploadProgress) => {
+const createTemplateDocument = (endpoint, file, onUploadProgress) => {
     const formData = new FormData();
     formData.append('document', file, file.name);
     return endpoint.api //
-        .post(`/templates/${templateId}/documents`, formData, {
+        .post(`/v2/template-documents`, formData, {
         timeout: 120000,
         onUploadProgress: (event) => {
             const total = event.total || 1;
@@ -3658,7 +3505,48 @@ const createTemplateDocument = (endpoint, templateId, file, onUploadProgress) =>
  * @apiSuccess string . Success
  */
 const deleteTemplateDocument = (endpoint, templateId, documentId) => endpoint.api //
-    .delete(`/templates/${templateId}/documents/${documentId}`)
+    .delete(`/v2/templates/${templateId}/documents/${documentId}`)
+    .then((r) => r.data);
+/**
+ * Get all metadata for a template document. Note that when called by non-creators (e.g. Org Collaborators)
+ * this will return only the **metadata** the caller is allowed to view.
+ *
+ * @group Template Documents
+ * @api GET /v2/envelope-documents/:id Get envelope document
+ * @apiParam string(format: 'uuid') document_id The ID of the document to retrieve.
+ * @apiSuccess IEnvelopeDocument . The detailed metadata for the document requested
+ */
+const getTemplateDocument = async (endpoint, documentId) => endpoint.api //
+    .get(`/v2/template-documents/${documentId}`)
+    .then((r) => r.data);
+/**
+ * Download a document directly.
+ */
+const downloadTemplateDocument = async (endpoint, documentId) => endpoint.api //
+    .get(`/v2/template-documents/${documentId}?type=file`, { responseType: 'blob' })
+    .then((r) => r.data);
+/**
+ * Get an envelope document's metadata, or the document itself. If no "type" parameter is specified,
+ * the document metadata is returned. If "type" is set to "file", the document binary content is
+ * returned with Content-Type set to the MIME type of the file. If "type" is set to "download", a
+ * string download link will be returned. If "type" is set to "preview" a string preview link will
+ * be returned. This link expires quickly, so it should be accessed immediately and never shared.
+ *
+ * @group Template Documents
+ * @api GET /v2/envelope-documents/:document_id Preview, Download, or Link to a Document
+ * @apiParam string(format: 'uuid') document_id The ID of the document to retrieve.
+ * @apiQuery string(enum:'file'|'download'|'preview') type? Download the file directly, generate a download link, or generate a preview link.
+ * @apiSuccess string . The generated link.
+ */
+const getTemplateDocumentDownloadLink = async (endpoint, _envelopeId, documentId) => endpoint.api //
+    .get(`/v2/template-documents/${documentId}?type=download`)
+    .then((r) => r.data);
+/**
+ * Get a pre-signed preview link for an Envelope Document. This link expires quickly, so it should
+ * be accessed immediately and never shared. Content-Disposition will be set to "inline".
+ */
+const getTemplateDocumentPreviewLink = async (endpoint, _envelopeId, documentId) => endpoint.api //
+    .get(`/v2/envelope-documents/${documentId}?type=preview`)
     .then((r) => r.data);
 /**
  * Get (binary download) a file attached to a Template. It is important to use this method
@@ -3666,7 +3554,7 @@ const deleteTemplateDocument = (endpoint, templateId, documentId) => endpoint.ap
  * request.
  */
 const getTemplateDocumentFile = async (endpoint, templateId, documentId) => endpoint.api //
-    .get(`/templates/${templateId}/documents/${documentId}?file=true`, { responseType: 'blob' })
+    .get(`/v2/templates/${templateId}/documents/${documentId}?file=true`, { responseType: 'blob' })
     .then((r) => r.data);
 /**
  * Get (binary download) a file attached to a Template. It is important to use this method
@@ -3674,7 +3562,7 @@ const getTemplateDocumentFile = async (endpoint, templateId, documentId) => endp
  * request.
  */
 const getTemplateDocumentThumbnail = async (endpoint, templateId, documentId) => endpoint.api //
-    .get(`/templates/${templateId}/documents/${documentId}?thumbnail=true`, { responseType: 'blob' })
+    .get(`/v2/templates/${templateId}/documents/${documentId}?thumbnail=true`, { responseType: 'blob' })
     .then((r) => r.data);
 /**
  * Get a display URI for a given page in a file attached to a template document. These pages are rendered server-side
@@ -3684,29 +3572,34 @@ const getTemplateDocumentThumbnail = async (endpoint, templateId, documentId) =>
  */
 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
- *
- * ```typescript
- * import {Documents} from '@verdocs/js-sdk/Templates';
- *
- * await Documents.getDocuments(templateID);
- * ```
- */
-const getValidators = (endpoint) => endpoint.api //
-    .get('/validators')
-    .then((r) => r.data);
-const getValidator = (endpoint, validatorName) => endpoint.api //
-    .get(`/validators/${validatorName}`)
-    .then((r) => r.data);
 const EMAIL_REGEX = /^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
-const isValidEmail = (email) => !!email && EMAIL_REGEX.test(email);
 // @see https://www.regextester.com/1978
 const PHONE_REGEX = /((?:\+|00)[17](?: |\-)?|(?:\+|00)[1-9]\d{0,2}(?: |\-)?|(?:\+|00)1\-\d{3}(?: |\-)?)?(0\d|\([0-9]{3}\)|[1-9]{0,3})(?:((?: |\-)[0-9]{2}){4}|((?:[0-9]{2}){4})|((?: |\-)[0-9]{3}(?: |\-)[0-9]{4})|([0-9]{7}))/;
+const URL_REGEX = /https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)/;
+const POSTAL_CODE_REGEX = /^[A-Za-z0-9-\s]{3,10}$/;
+const NUMBER_REGEX = /^\d+$/;
+const DATE_REGEX = /^(\d{4}[-\/]\d{2}[-\/]\d{2})|(\d{2}[-\/]\d{2}[-\/]\d{4})$/;
+const VALIDATORS = {
+    email: { regex: EMAIL_REGEX, label: 'Email Address' },
+    phone: { regex: PHONE_REGEX, label: 'Phone Number' },
+    url: { regex: URL_REGEX, label: 'URL' },
+    postal_code: { regex: POSTAL_CODE_REGEX, label: 'Zip/Postal Code' },
+    number: { regex: NUMBER_REGEX, label: 'Number' },
+    date: { regex: DATE_REGEX, label: 'Date' },
+};
+const isValidInput = (value, validator) => Object.keys(VALIDATORS).includes(validator) && VALIDATORS[validator].regex.test(value);
+/**
+ * Get a list of available validators for field inputs. Note that validators always check strings,
+ * because that is all a user can enter in an HTML input field. Numeric-format validators should
+ * perform any necessary conversions internally. Validators never throw - they just return a boolean.
+ * indicating whether the value is valid.
+ */
+const getValidators = () => Object.keys(VALIDATORS);
+const isValidEmail = (email) => !!email && EMAIL_REGEX.test(email);
 const isValidPhone = (phone) => !!phone && PHONE_REGEX.test(phone);
 const isValidRoleName = (value, roles) => roles.findIndex((role) => role.name === value) !== -1;
 const TagRegEx = /^[a-zA-Z0-9-]{0,32}$/;
 const isValidTag = (value, tags) => TagRegEx.test(value) || tags.findIndex((tag) => tag === value) !== -1;
 
-export { ALL_PERMISSIONS, AtoB, Countries, DEFAULT_FIELD_HEIGHTS, DEFAULT_FIELD_WIDTHS, FIELD_TYPES, RolePermissions, VerdocsEndpoint, WEBHOOK_EVENTS, acceptOrganizationInvitation, addGroupMember, addTemplateTag, authenticate, blobToBase64, canAccessEnvelope, canPerformTemplateAction, cancelEnvelope, capitalize, changePassword, collapseEntitlements, convertToE164, createApiKey, createEnvelope, createField, createGroup, createInitials, createOrganization, createOrganizationContact, createOrganizationInvitation, createProfile, createSignature, createTag, createTemplate, createTemplateDocument, createTemplateFromSharepoint, createTemplateRole, declineOrganizationInvitation, decodeAccessTokenBody, decodeJWTBody, delegateRecipient, deleteApiKey, deleteEnvelopeFieldAttachment, deleteField, deleteGroup, deleteGroupMember, deleteOrganization, deleteOrganizationContact, deleteOrganizationInvitation, deleteOrganizationMember, deleteProfile, deleteSignature, deleteTemplate, deleteTemplateDocument, deleteTemplateRole, deleteTemplateTag, downloadBlob, downloadDocument, duplicateTemplate, envelopeIsActive, envelopeIsComplete, envelopeRecipientAgree, envelopeRecipientChangeOwner, envelopeRecipientDecline, envelopeRecipientPrepare, envelopeRecipientSubmit, envelopeRecipientUpdateName, fileToDataUrl, formatFullName, formatInitials, formatShortTimeAgo, fullNameToInitials, getActiveEntitlements, getAllTags, getApiKeys, getCountryByCode, getCurrentProfile, getDocumentDownloadLink, getDocumentPreviewLink, getEntitlements, getEnvelope, getEnvelopeDocument, getEnvelopeDocumentPageDisplayUri, getEnvelopeFile, getEnvelopes, getFieldAttachment, getFieldsForRole, getGroup, getGroups, getInPersonLink, getKbaStep, getMatchingCountry, getMyUser, getNextRecipient, getNotifications, getOrganization, getOrganizationChildren, getOrganizationContacts, getOrganizationInvitation, getOrganizationInvitations, getOrganizationMembers, getOrganizationUsage, getPlusOneCountry, getProfiles, getRGB, getRGBA, getRLeft, getRTop, getRValue, getRecipientsWithActions, getRoleColor, getSignature, getSignatures, getStars, getTag, getTemplate, getTemplateDocument, getTemplateDocumentFile, getTemplateDocumentPageDisplayUri, getTemplateDocumentThumbnail, getTemplateDocuments, getTemplateTags, getTemplates, getValidator, getValidators, getWebhooks, hasRequiredPermissions, integerSequence, isAmericanSamoa, isCanada, isDominicanRepublic, isEnvelopeOwner, isEnvelopeRecipient, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, isPuertoRico, isValidEmail, isValidPhone, isValidRoleName, isValidTag, nameToRGBA, randomString, recipientCanAct, recipientHasAction, refreshToken, remindRecipient, rescale, resendOrganizationInvitation, resendVerification, resetPassword, resetRecipient, rotateApiKey, setWebhooks, sortFields, startSigningSession, submitKbaChallengeResponse, submitKbaIdentity, submitKbaPin, switchProfile, toggleStar, updateApiKey, updateEnvelope, updateEnvelopeField, updateEnvelopeFieldInitials, updateEnvelopeFieldSignature, updateField, updateGroup, updateOrganization, updateOrganizationContact, updateOrganizationInvitation, updateOrganizationLogo, updateOrganizationMember, updateOrganizationThumbnail, updateProfile, updateProfilePhoto, updateRecipient, updateRecipientStatus, updateTemplate, updateTemplateRole, uploadEnvelopeFieldAttachment, useCanAccessEnvelope, userCanAct, userCanBuildTemplate, userCanCancelEnvelope, userCanChangeOrgVisibility, userCanCreateOrgTemplate, userCanCreatePersonalTemplate, userCanCreatePublicTemplate, userCanCreateTemplate, userCanDeleteTemplate, userCanFinishEnvelope, userCanMakeTemplatePrivate, userCanMakeTemplatePublic, userCanMakeTemplateShared, userCanPreviewTemplate, userCanReadTemplate, userCanSendTemplate, userCanSignNow, userCanUpdateTemplate, userHasPermissions, userHasSharedTemplate, userIsEnvelopeOwner, userIsEnvelopeRecipient, userIsTemplateCreator, verifyEmail, verifySigner };
+export { ALL_PERMISSIONS, AtoB, Countries, DEFAULT_FIELD_HEIGHTS, DEFAULT_FIELD_WIDTHS, FIELD_TYPES, RolePermissions, VerdocsEndpoint, WEBHOOK_EVENTS, acceptOrganizationInvitation, addGroupMember, authenticate, blobToBase64, canAccessEnvelope, canPerformTemplateAction, cancelEnvelope, capitalize, changePassword, collapseEntitlements, convertToE164, createApiKey, createEnvelope, createField, createGroup, createInitials, createOrganization, createOrganizationContact, createOrganizationInvitation, createProfile, createSignature, createTemplate, createTemplateDocument, createTemplateFromSharepoint, createTemplateRole, declineOrganizationInvitation, decodeAccessTokenBody, decodeJWTBody, delegateRecipient, deleteApiKey, deleteEnvelopeFieldAttachment, deleteField, deleteGroup, deleteGroupMember, deleteOrganization, deleteOrganizationContact, deleteOrganizationInvitation, deleteOrganizationMember, deleteProfile, deleteTemplate, deleteTemplateDocument, deleteTemplateRole, downloadBlob, downloadEnvelopeDocument, downloadTemplateDocument, duplicateTemplate, envelopeIsActive, envelopeIsComplete, envelopeRecipientAgree, envelopeRecipientDecline, envelopeRecipientSubmit, fileToDataUrl, formatFullName, formatInitials, formatShortTimeAgo, fullNameToInitials, getActiveEntitlements, getApiKeys, getCountryByCode, getCurrentProfile, getEntitlements, getEnvelope, getEnvelopeDocument, getEnvelopeDocumentDownloadLink, getEnvelopeDocumentPageDisplayUri, getEnvelopeDocumentPreviewLink, getEnvelopeFile, getEnvelopes, getEnvelopesZip, getFieldsForRole, getGroup, getGroups, getInPersonLink, getKbaStep, getMatchingCountry, getMyUser, getNextRecipient, getNotifications, getOrganization, getOrganizationChildren, getOrganizationContacts, getOrganizationInvitation, getOrganizationInvitations, getOrganizationMembers, getOrganizationUsage, getPlusOneCountry, getProfiles, getRGB, getRGBA, getRLeft, getRTop, getRValue, getRecipientsWithActions, getRoleColor, getTemplate, getTemplateDocument, getTemplateDocumentDownloadLink, getTemplateDocumentFile, getTemplateDocumentPageDisplayUri, getTemplateDocumentPreviewLink, getTemplateDocumentThumbnail, getTemplates, getValidators, getWebhooks, hasRequiredPermissions, integerSequence, isAmericanSamoa, isCanada, isDominicanRepublic, isEnvelopeOwner, isEnvelopeRecipient, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, isPuertoRico, isValidEmail, isValidInput, isValidPhone, isValidRoleName, isValidTag, nameToRGBA, randomString, recipientCanAct, recipientHasAction, refreshToken, remindRecipient, rescale, resendOrganizationInvitation, resendVerification, resetPassword, resetRecipient, rotateApiKey, setWebhooks, sortFields, startSigningSession, submitKbaChallengeResponse, submitKbaIdentity, submitKbaPin, switchProfile, toggleTemplateStar, updateApiKey, updateEnvelope, updateEnvelopeField, updateField, updateGroup, updateOrganization, updateOrganizationContact, updateOrganizationInvitation, updateOrganizationLogo, updateOrganizationMember, updateOrganizationThumbnail, updateProfile, updateProfilePhoto, updateRecipient, updateTemplate, updateTemplateRole, uploadEnvelopeFieldAttachment, useCanAccessEnvelope, userCanAct, userCanBuildTemplate, userCanCancelEnvelope, userCanChangeOrgVisibility, userCanCreateOrgTemplate, userCanCreatePersonalTemplate, userCanCreatePublicTemplate, userCanCreateTemplate, userCanDeleteTemplate, userCanFinishEnvelope, userCanMakeTemplatePrivate, userCanMakeTemplatePublic, userCanMakeTemplateShared, userCanPreviewTemplate, userCanReadTemplate, userCanSendTemplate, userCanSignNow, userCanUpdateTemplate, userHasPermissions, userHasSharedTemplate, userIsEnvelopeOwner, userIsEnvelopeRecipient, userIsTemplateCreator, verifyEmail, verifySigner };
 //# sourceMappingURL=index.mjs.map