@verdocs/js-sdk 6.1.0 → 6.2.0-beta.1

package/dist/index.d.mts

@@ -421,6 +421,8 @@ interface IWebhookEvents {
     template_updated: boolean;
     template_deleted: boolean;
     template_used: boolean;
+    recipient_submitted: boolean;
+    recipient_updated: boolean;
     recipient_delegated: boolean;
     kba_event: boolean;
     entitlement_used: boolean;
@@ -993,7 +995,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_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";
 type TTemplateVisibility = "private" | "shared" | "public";
 type TEntitlement = "envelope" | "kba_auth" | "passcode_auth" | "sms_auth" | "kba_id_auth" | "id_auth" | "custom_disclaimer";
 /**
@@ -1383,38 +1385,12 @@ interface IInPersonLinkResponse {
      */
     recipient: IRecipient;
 }
-interface IUpdateRecipientSubmitParams {
-    action: "submit";
-}
-interface IUpdateRecipientDeclineParams {
-    action: "decline";
-}
-interface IUpdateRecipientClaimEnvelope {
-    action: "owner_update";
-    first_name: string;
-    last_name: string;
-    email: string;
-}
 interface IUpdateRecipientStatus {
     first_name?: string;
     last_name?: string;
     agreed?: boolean;
     action?: "prepare" | "update";
 }
-interface IUpdateRecipientAgreedParams {
-    action: "update";
-    agreed: boolean;
-    disclosures?: string;
-}
-interface IUpdateRecipientNameParams {
-    action: "update";
-    first_name: string;
-    last_name: string;
-}
-interface IUpdateRecipientPrepareParams {
-    action: "prepare";
-    recipients: IRecipient[];
-}
 interface ICreateEnvelopeReminderRequest {
     setup_time: number;
     interval_time: number;
@@ -1689,11 +1665,11 @@ declare const getEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string) => Pr
  * @apiParam string(format: 'uuid') document_id The ID of the document to retrieve.
  * @apiSuccess IEnvelopeDocument . The detailed metadata for the document requested
  */
-declare const getEnvelopeDocument: (endpoint: VerdocsEndpoint, _envelopeId: string, documentId: string) => Promise<IEnvelopeDocument>;
+declare const getEnvelopeDocument: (endpoint: VerdocsEndpoint, documentId: string) => Promise<IEnvelopeDocument>;
 /**
  * Download a document directly.
  */
-declare const downloadDocument: (endpoint: VerdocsEndpoint, _envelopeId: string, documentId: string) => Promise<any>;
+declare const downloadEnvelopeDocument: (endpoint: VerdocsEndpoint, documentId: string) => Promise<any>;
 /**
  * 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
@@ -1707,12 +1683,12 @@ declare const downloadDocument: (endpoint: VerdocsEndpoint, _envelopeId: string,
  * @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.
  */
-declare const getDocumentDownloadLink: (endpoint: VerdocsEndpoint, _envelopeId: string, documentId: string) => Promise<string>;
+declare const getEnvelopeDocumentDownloadLink: (endpoint: VerdocsEndpoint, documentId: string) => Promise<string>;
 /**
  * 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".
  */
-declare const getDocumentPreviewLink: (endpoint: VerdocsEndpoint, _envelopeId: string, documentId: string) => Promise<string>;
+declare const getEnvelopeDocumentPreviewLink: (endpoint: VerdocsEndpoint, documentId: string) => Promise<string>;
 /**
  * Cancel an Envelope.
  *
@@ -1730,7 +1706,7 @@ declare const cancelEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string) =>
  *
  * @deprecated Use getDocumentPreviewLink/getDocumentDownloadLink/downloadDocument instead.
  */
-declare const getEnvelopeFile: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string) => Promise<any>;
+declare const getEnvelopeFile: (endpoint: VerdocsEndpoint, documentId: string) => Promise<any>;
 /**
  * Update an envelope. Currently, only reminder settings may be changed.
  *
@@ -1745,66 +1721,25 @@ declare const updateEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string, pa
  * 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.
  */
-declare const updateEnvelopeField: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string, value: any) => Promise<IEnvelopeFieldSettings>;
+declare const updateEnvelopeField: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, fieldName: string, value: any) => Promise<IEnvelopeField>;
 /**
- * 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.
  */
-declare const updateEnvelopeFieldSignature: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string, signatureId: string) => Promise<IEnvelopeFieldSettings>;
-/**
- * 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.
- */
-declare const updateEnvelopeFieldInitials: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string, initialId: string) => Promise<IEnvelopeFieldSettings>;
-/**
- * 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.
- */
-declare const uploadEnvelopeFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<IEnvelopeFieldSettings>;
+declare const uploadEnvelopeFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, fieldName: string, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<IEnvelopeFieldSettings>;
 /**
  * Delete an attachment. Note that this is not a DELETE endpoint because the field itself is not
  * 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.
  */
-declare const deleteEnvelopeFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string) => Promise<IEnvelopeFieldSettings>;
-/**
- * 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.
- */
-declare const getFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string) => Promise<any>;
+declare const deleteEnvelopeFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, fieldName: string) => Promise<IEnvelopeFieldSettings>;
 /**
  * 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
@@ -1869,10 +1804,10 @@ declare const getEnvelopes: (endpoint: VerdocsEndpoint, params?: IListEnvelopesP
     envelopes: IEnvelope[];
 }>;
 /**
- * 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
@@ -1978,45 +1913,37 @@ interface IKbaChallengeResponse {
  */
 declare const submitKbaChallengeResponse: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string, responses: IKbaChallengeResponse[]) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
 /**
- * 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.
  */
-declare const updateRecipientStatus: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string, params: IUpdateRecipientSubmitParams | IUpdateRecipientClaimEnvelope | IUpdateRecipientAgreedParams | IUpdateRecipientNameParams | IUpdateRecipientDeclineParams | IUpdateRecipientPrepareParams) => Promise<IRecipient>;
-/**
- * Submit an envelope (signing is finished). Note that all fields must be valid/completed for this to succeed.
- */
-declare const envelopeRecipientSubmit: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IRecipient>;
-/**
- * Decline to complete an envelope (signing will not terminated).
- */
-declare const envelopeRecipientDecline: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IRecipient>;
-/**
- * Claim / change ownership of an envelope. This is a special-case operation only available in certain workflows.
- */
-declare const envelopeRecipientChangeOwner: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string, email: string, first_name: string, last_name: string) => Promise<IRecipient>;
-/**
- * Agree to electronic signing disclosures.
- */
 declare const envelopeRecipientAgree: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, disclosures?: string) => Promise<IRecipient>;
 /**
- * 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.
  */
-declare const envelopeRecipientUpdateName: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, first_name: string, last_name: string) => Promise<IRecipient>;
+declare const envelopeRecipientDecline: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IRecipient>;
 /**
- * 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.
  */
-declare const envelopeRecipientPrepare: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, recipients: IRecipient[]) => Promise<IRecipient>;
+declare const envelopeRecipientSubmit: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IRecipient>;
 /**
  * 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
@@ -2206,10 +2133,10 @@ declare const userCanAct: (email: string, recipientsWithActions: IRecipient[]) =
 declare const userCanSignNow: (profile: IProfile | null | undefined, envelope: IEnvelope) => boolean | undefined;
 declare const getNextRecipient: (envelope: IEnvelope) => IRecipient;
 /**
- * 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
@@ -2221,33 +2148,6 @@ declare const getNextRecipient: (envelope: IEnvelope) => IRecipient;
  * @apiSuccess ISignature . The newly-created signature block.
  */
 declare const createSignature: (endpoint: VerdocsEndpoint, name: string, signature: Blob) => Promise<ISignature>;
-/**
- * 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.
- */
-declare const getSignatures: (endpoint: VerdocsEndpoint) => Promise<ISignature[]>;
-/**
- * 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.
- */
-declare const getSignature: (endpoint: VerdocsEndpoint, signatureId: string) => Promise<any>;
-/**
- * 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
- */
-declare const deleteSignature: (endpoint: VerdocsEndpoint, signatureId: string) => Promise<any>;
 interface ICreateApiKeyRequest {
     name: string;
     profile_id: string;
@@ -3354,58 +3254,6 @@ declare const updateTemplateRole: (endpoint: VerdocsEndpoint, template_id: strin
  * @apiSuccess string . Success
  */
 declare const deleteTemplateRole: (endpoint: VerdocsEndpoint, template_id: string, name: string) => Promise<any>;
-interface ITemplateTag {
-    tag_name: string;
-    template_id: string;
-}
-interface ITag {
-    name: string;
-    featured?: boolean;
-    organization_id?: string;
-    created_at?: string;
-}
-interface IStar {
-    template_id: string;
-    profile_id: string;
-}
-interface ITemplateSearchResult {
-    page: number;
-    row: number;
-    total: number;
-    result: ITemplate[];
-}
-/**
- * Get the template stars for a template.
- */
-declare const getStars: (endpoint: VerdocsEndpoint, templateId: string) => Promise<IStar[]>;
-/**
- * Toggle the template star for a template.
- */
-declare const toggleStar: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplate>;
-/**
- * Apply a tag to a template.
- */
-declare const addTemplateTag: (endpoint: VerdocsEndpoint, templateId: string, params: ITag) => Promise<ITemplateTag>;
-/**
- * Get all tags for a template.
- */
-declare const getTemplateTags: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplateTag[]>;
-/**
- * Remove a tag from a template.
- */
-declare const deleteTemplateTag: (endpoint: VerdocsEndpoint, templateId: string, tagName: string) => Promise<any>;
-/**
- * Create an Organization-wide tag.
- */
-declare const createTag: (endpoint: VerdocsEndpoint, name: string) => Promise<ITag>;
-/**
- * Get an Organization-wide tag.
- */
-declare const getTag: (endpoint: VerdocsEndpoint, name: string) => Promise<ITag>;
-/**
- * Get all tags available for use by an Organization.
- */
-declare const getAllTags: (endpoint: VerdocsEndpoint) => Promise<ITag[]>;
 type ITemplateSortBy = "created_at" | "updated_at" | "name" | "last_used_at" | "counter" | "star_counter";
 type TTemplateVisibilityFilter = "private_shared" | "private" | "shared" | "public";
 interface IGetTemplatesParams {
@@ -3648,33 +3496,19 @@ declare const updateTemplate: (endpoint: VerdocsEndpoint, templateId: string, pa
  */
 declare const deleteTemplate: (endpoint: VerdocsEndpoint, templateId: string) => Promise<string>;
 /**
- * Get all the Template Documents associated to a particular Template.
- *
- * ```typescript
- * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
- *
- * await TemplateDocument.geTemplateDocuments((VerdocsEndpoint.getDefault(), templateId);
- * ```
- *
- * @group Template Documents
- * @api GET /v2/templates/:template_id/documents List the documents assigned to a template
- * @apiSuccess array(items: ITemplateDocument) . Template documents
- */
-declare const getTemplateDocuments: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplateDocument[]>;
-/**
- * Get a specific Document.
+ * Toggle the template star for a template.
  *
  * ```typescript
- * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
+ * import {toggleTemplateStar} from '@verdocs/js-sdk/Templates';
  *
- * await TemplateDocument.geTemplateDocument((VerdocsEndpoint.getDefault(), templateId,documentId);
+ * await toggleTemplateStar((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
  * ```
  *
- * @group Template Documents
- * @api GET /v2/templates/:template_id/documents/:document_id Get an individual template document
- * @apiSuccess ITemplateDocument . Template document
+ * @group Templates
+ * @api POST /v2/templates/:template_id/star Star or unstar a template (toggle state)
+ * @apiSuccess ITemplate . Success
  */
-declare const getTemplateDocument: (endpoint: VerdocsEndpoint, templateId: string, documentId: string) => Promise<ITemplateDocument>;
+declare const toggleTemplateStar: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplate>;
 /**
  * Create a Document for a particular Template.
  *
@@ -3689,7 +3523,7 @@ declare const getTemplateDocument: (endpoint: VerdocsEndpoint, templateId: strin
  * @apiBody string(format:binary) file Document file to attach. The file name will automatically be used as the document name.
  * @apiSuccess ITemplateDocument . Template document
  */
-declare const createTemplateDocument: (endpoint: VerdocsEndpoint, templateId: string, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<ITemplateDocument>;
+declare const createTemplateDocument: (endpoint: VerdocsEndpoint, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<ITemplateDocument>;
 /**
  * Delete a specific Document.
  *
@@ -3703,7 +3537,40 @@ declare const createTemplateDocument: (endpoint: VerdocsEndpoint, templateId: st
  * @api DELETE /v2/templates/:temlate_id/documents/:document_id Delete a template document
  * @apiSuccess string . Success
  */
-declare const deleteTemplateDocument: (endpoint: VerdocsEndpoint, templateId: string, documentId: string) => Promise<any>;
+declare const deleteTemplateDocument: (endpoint: VerdocsEndpoint, templateId: string, documentId: string) => Promise<ITemplate>;
+/**
+ * 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
+ */
+declare const getTemplateDocument: (endpoint: VerdocsEndpoint, documentId: string) => Promise<ITemplateDocument>;
+/**
+ * Download a document directly.
+ */
+declare const downloadTemplateDocument: (endpoint: VerdocsEndpoint, documentId: string) => Promise<any>;
+/**
+ * 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.
+ */
+declare const getTemplateDocumentDownloadLink: (endpoint: VerdocsEndpoint, _envelopeId: string, documentId: string) => Promise<string>;
+/**
+ * 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".
+ */
+declare const getTemplateDocumentPreviewLink: (endpoint: VerdocsEndpoint, _envelopeId: string, documentId: string) => Promise<string>;
 /**
  * Get (binary download) a file attached to a Template. It is important to use this method
  * rather than a direct A HREF or similar link to set the authorization headers for the
@@ -3723,21 +3590,38 @@ declare const getTemplateDocumentThumbnail: (endpoint: VerdocsEndpoint, template
  * original asset may be obtained by calling `getTemplateDocumentFile()` or similar.
  */
 declare const getTemplateDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, documentId: string, page: number, variant?: "original" | "tagged") => Promise<string>;
+interface ITemplateTag {
+    tag_name: string;
+    template_id: string;
+}
+interface ITag {
+    name: string;
+    featured?: boolean;
+    organization_id?: string;
+    created_at?: string;
+}
+interface IStar {
+    template_id: string;
+    profile_id: string;
+}
+interface ITemplateSearchResult {
+    page: number;
+    row: number;
+    total: number;
+    result: ITemplate[];
+}
 interface IValidator {
     name: string;
     regex: string;
 }
+declare const isValidInput: (value: string, validator: string) => boolean;
 /**
- * Get all defined validators
- *
- * ```typescript
- * import {Documents} from '@verdocs/js-sdk/Templates';
- *
- * await Documents.getDocuments(templateID);
- * ```
+ * 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.
  */
-declare const getValidators: (endpoint: VerdocsEndpoint) => Promise<IValidator[]>;
-declare const getValidator: (endpoint: VerdocsEndpoint, validatorName: string) => Promise<IValidator>;
+declare const getValidators: () => string[];
 declare const isValidEmail: (email: string | undefined) => boolean;
 declare const isValidPhone: (phone: string | undefined) => boolean;
 declare const isValidRoleName: (value: string, roles: IRole[]) => boolean;
@@ -3856,4 +3740,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, TTemplateSender, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, TDeprecatedHistoryEvent, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, TTemplateVisibility, TEntitlement, TRecipientAuthMethod, TRecipientAuthStep, TUsageType, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, WEBHOOK_EVENTS, ALL_PERMISSIONS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IEntitlement, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IDropdownOption, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IKBAQuestion, IRecipient, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TOrganizationUsage, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelope, getEnvelopeDocument, downloadDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelope, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, ITimeRange, IListEnvelopesParams, getEnvelopes, createInitials, IRecipientKbaStepNone, IRecipientKbaStepComplete, IRecipientKbaStepPin, IRecipientKbaStepIdentity, IRecipientKbaStepChallenge, IRecipientKbaStepFailed, TRecipientKbaStep, getKbaStep, submitKbaPin, IKbaIdentity, submitKbaIdentity, IKbaChallengeResponse, submitKbaChallengeResponse, updateRecipientStatus, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, startSigningSession, getInPersonLink, verifySigner, delegateRecipient, updateRecipient, remindRecipient, resetRecipient, isEnvelopeOwner, isEnvelopeRecipient, canAccessEnvelope, userIsEnvelopeOwner, userIsEnvelopeRecipient, useCanAccessEnvelope, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResult, IDocumentSearchOptions, ICreateEnvelopeRecipientFromTemplate, ICreateEnvelopeRecipientDirectly, ISignerTokenResponse, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, IUpdateRecipientParams, ICreateEnvelopeDocumentFromData, ICreateEnvelopeDocumentFromUri, ICreateEnvelopeDocumentFromFile, ICreateEnvelopeFieldFromTemplate, ICreateEnvelopeFieldDirectly, ICreateEnvelopeFromTemplateRequest, ICreateEnvelopeDirectlyRequest, TCreateEnvelopeRequest, IAuthenticateRecipientViaPasscodeRequest, IAuthenticateRecipientViaEmailRequest, IAuthenticateRecipientViaSMSRequest, IKBAResponse, IAuthenticateRecipientViaKBARequest, TAuthenticateRecipientRequest, 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, getOrganizationChildren, getOrganizationUsage, createOrganization, updateOrganization, deleteOrganization, updateOrganizationLogo, updateOrganizationThumbnail, getEntitlements, getActiveEntitlements, 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, TTemplateVisibilityFilter, IGetTemplatesParams, getTemplates, getTemplate, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, duplicateTemplate, 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, collapseEntitlements, getRTop, getRLeft, getRValue, blobToBase64, rescale, sortFields, 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, TTemplateSender, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, TDeprecatedHistoryEvent, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, TTemplateVisibility, TEntitlement, TRecipientAuthMethod, TRecipientAuthStep, TUsageType, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, WEBHOOK_EVENTS, ALL_PERMISSIONS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IEntitlement, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IDropdownOption, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IKBAQuestion, IRecipient, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TOrganizationUsage, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelope, getEnvelopeDocument, downloadEnvelopeDocument, getEnvelopeDocumentDownloadLink, getEnvelopeDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelope, updateEnvelopeField, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getEnvelopeDocumentPageDisplayUri, ITimeRange, IListEnvelopesParams, getEnvelopes, createInitials, IRecipientKbaStepNone, IRecipientKbaStepComplete, IRecipientKbaStepPin, IRecipientKbaStepIdentity, IRecipientKbaStepChallenge, IRecipientKbaStepFailed, TRecipientKbaStep, getKbaStep, submitKbaPin, IKbaIdentity, submitKbaIdentity, IKbaChallengeResponse, submitKbaChallengeResponse, envelopeRecipientAgree, envelopeRecipientDecline, envelopeRecipientSubmit, startSigningSession, getInPersonLink, verifySigner, delegateRecipient, updateRecipient, remindRecipient, resetRecipient, isEnvelopeOwner, isEnvelopeRecipient, canAccessEnvelope, userIsEnvelopeOwner, userIsEnvelopeRecipient, useCanAccessEnvelope, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, IEnvelopesSearchResult, IDocumentSearchOptions, ICreateEnvelopeRecipientFromTemplate, ICreateEnvelopeRecipientDirectly, ISignerTokenResponse, IInPersonLinkResponse, IUpdateRecipientStatus, ICreateEnvelopeReminderRequest, IUpdateRecipientParams, ICreateEnvelopeDocumentFromData, ICreateEnvelopeDocumentFromUri, ICreateEnvelopeDocumentFromFile, ICreateEnvelopeFieldFromTemplate, ICreateEnvelopeFieldDirectly, ICreateEnvelopeFromTemplateRequest, ICreateEnvelopeDirectlyRequest, TCreateEnvelopeRequest, IAuthenticateRecipientViaPasscodeRequest, IAuthenticateRecipientViaEmailRequest, IAuthenticateRecipientViaSMSRequest, IKBAResponse, IAuthenticateRecipientViaKBARequest, TAuthenticateRecipientRequest, 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, getOrganizationChildren, getOrganizationUsage, createOrganization, updateOrganization, deleteOrganization, updateOrganizationLogo, updateOrganizationThumbnail, getEntitlements, getActiveEntitlements, 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, ITemplateSortBy, TTemplateVisibilityFilter, IGetTemplatesParams, getTemplates, getTemplate, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, duplicateTemplate, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, toggleTemplateStar, createTemplateDocument, deleteTemplateDocument, getTemplateDocument, downloadTemplateDocument, getTemplateDocumentDownloadLink, getTemplateDocumentPreviewLink, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateTag, ITag, IStar, ITemplateSearchResult, IValidator, isValidInput, getValidators, 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, collapseEntitlements, getRTop, getRLeft, getRValue, blobToBase64, rescale, sortFields, 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 };