@verdocs/js-sdk 4.2.85 → 4.2.87
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +23 -67
- package/dist/index.d.ts +23 -67
- package/dist/index.js +2 -64
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +3 -57
- package/dist/index.mjs.map +1 -1
- package/dist/package.json +3 -2
- package/package.json +3 -2
package/dist/index.mjs
CHANGED
|
@@ -1578,9 +1578,7 @@ const getFieldAttachment = async (endpoint, envelopeId, fieldName) => endpoint.a
|
|
|
1578
1578
|
* into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are intended
|
|
1579
1579
|
* for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants.
|
|
1580
1580
|
*/
|
|
1581
|
-
const getEnvelopeDocumentPageDisplayUri = async (endpoint,
|
|
1582
|
-
.get(`/envelopes/${envelopeId}/envelope_documents/${documentId}/pages/${page}/image?type=${type}`, { timeout: 20000 })
|
|
1583
|
-
.then((r) => r.data);
|
|
1581
|
+
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);
|
|
1584
1582
|
/**
|
|
1585
1583
|
* Lists all envelopes accessible by the caller, with optional filters.
|
|
1586
1584
|
*
|
|
@@ -1702,32 +1700,6 @@ const resendInvitation = (endpoint, envelopeId, roleName) => endpoint.api //
|
|
|
1702
1700
|
.put(`/v2/envelopes/${envelopeId}/recipients/${encodeURIComponent(roleName)}`, { action: 'resend' })
|
|
1703
1701
|
.then((r) => r.data);
|
|
1704
1702
|
|
|
1705
|
-
/**
|
|
1706
|
-
* Enable automatic reminders. setup_time is the number of days after the envelope is sent that the first reminder
|
|
1707
|
-
* should be sent. interval_time is the number of days between reminders.
|
|
1708
|
-
*/
|
|
1709
|
-
const createEnvelopeReminder = (endpoint, envelopeId, params) => endpoint.api //
|
|
1710
|
-
.post(`/envelopes/${envelopeId}/reminder/`, params)
|
|
1711
|
-
.then((r) => r.data);
|
|
1712
|
-
/**
|
|
1713
|
-
* Get the reminder configuration for an envelope.
|
|
1714
|
-
*/
|
|
1715
|
-
const getEnvelopeReminder = (endpoint, envelopeId, reminderId) => endpoint.api //
|
|
1716
|
-
.get(`/envelopes/${envelopeId}/reminder/${reminderId}`)
|
|
1717
|
-
.then((r) => r.data);
|
|
1718
|
-
/**
|
|
1719
|
-
* Update the reminder configuration for an envelope.
|
|
1720
|
-
*/
|
|
1721
|
-
const updateEnvelopeReminder = (endpoint, envelopeId, reminderId, params) => endpoint.api //
|
|
1722
|
-
.put(`/envelopes/${envelopeId}/reminder/${reminderId}`, params)
|
|
1723
|
-
.then((r) => r.data);
|
|
1724
|
-
/**
|
|
1725
|
-
* Delete the reminder configuration for an envelope.
|
|
1726
|
-
*/
|
|
1727
|
-
const deleteEnvelopeReminder = (endpoint, envelopeId, reminderId) => endpoint.api //
|
|
1728
|
-
.delete(`/envelopes/${envelopeId}/reminder/${reminderId}`)
|
|
1729
|
-
.then((r) => r.data);
|
|
1730
|
-
|
|
1731
1703
|
/**
|
|
1732
1704
|
* Various helpers to identify available operations for an envelope by a user.
|
|
1733
1705
|
*
|
|
@@ -2589,32 +2561,6 @@ const userCanPreviewTemplate = (profile, template) => {
|
|
|
2589
2561
|
return hasPermission && signers.length > 0 && signers.every((signer) => getFieldsForRole(template, signer.name).length > 0);
|
|
2590
2562
|
};
|
|
2591
2563
|
|
|
2592
|
-
/**
|
|
2593
|
-
* Enable automatic reminders. setup_time is the number of days after the envelope is sent that the first reminder
|
|
2594
|
-
* should be sent. interval_time is the number of days between reminders.
|
|
2595
|
-
*/
|
|
2596
|
-
const createTemplateReminder = (endpoint, templateId, params) => endpoint.api //
|
|
2597
|
-
.post(`/templates/${templateId}/reminder/`, params)
|
|
2598
|
-
.then((r) => r.data);
|
|
2599
|
-
/**
|
|
2600
|
-
* Get the reminder configuration for a template.
|
|
2601
|
-
*/
|
|
2602
|
-
const getTemplateReminder = (endpoint, templateId, reminderId) => endpoint.api //
|
|
2603
|
-
.get(`/templates/${templateId}/reminder/${reminderId}`)
|
|
2604
|
-
.then((r) => r.data);
|
|
2605
|
-
/**
|
|
2606
|
-
* Update the reminder configuration for a template.
|
|
2607
|
-
*/
|
|
2608
|
-
const updateTemplateReminder = (endpoint, templateId, reminderId, params) => endpoint.api //
|
|
2609
|
-
.put(`/templates/${templateId}/reminder/${reminderId}`, params)
|
|
2610
|
-
.then((r) => r.data);
|
|
2611
|
-
/**
|
|
2612
|
-
* Delete the reminder configuration for a template.
|
|
2613
|
-
*/
|
|
2614
|
-
const deleteTemplateReminder = (endpoint, templateId, reminderId) => endpoint.api //
|
|
2615
|
-
.delete(`/templates/${templateId}/reminder/${reminderId}`)
|
|
2616
|
-
.then((r) => r.data);
|
|
2617
|
-
|
|
2618
2564
|
/**
|
|
2619
2565
|
* A "role" is an individual participant in a signing flow, such as a signer or CC contact.
|
|
2620
2566
|
* A role is a placeholder that will eventually become a named recipient. For example, "Tenant 1"
|
|
@@ -2948,7 +2894,7 @@ const getTemplateDocumentThumbnail = async (endpoint, templateId, documentId) =>
|
|
|
2948
2894
|
* for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants. The
|
|
2949
2895
|
* original asset may be obtained by calling `getTemplateDocumentFile()` or similar.
|
|
2950
2896
|
*/
|
|
2951
|
-
const getTemplateDocumentPageDisplayUri = async (endpoint,
|
|
2897
|
+
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);
|
|
2952
2898
|
|
|
2953
2899
|
/**
|
|
2954
2900
|
* Get all defined validators
|
|
@@ -2974,5 +2920,5 @@ const isValidRoleName = (value, roles) => roles.findIndex((role) => role.name ==
|
|
|
2974
2920
|
const TagRegEx = /^[a-zA-Z0-9-]{0,32}$/;
|
|
2975
2921
|
const isValidTag = (value, tags) => TagRegEx.test(value) || tags.findIndex((tag) => tag === value) !== -1;
|
|
2976
2922
|
|
|
2977
|
-
export { ALL_PERMISSIONS, AtoB, Countries, DEFAULT_FIELD_HEIGHTS, DEFAULT_FIELD_WIDTHS, FIELD_TYPES, RolePermissions, VerdocsEndpoint, WEBHOOK_EVENTS, acceptOrganizationInvitation, addGroupMember, addTemplateTag, authenticate, blobToBase64, canPerformTemplateAction, cancelEnvelope, capitalize, changePassword, convertToE164, createApiKey, createEnvelope,
|
|
2923
|
+
export { ALL_PERMISSIONS, AtoB, Countries, DEFAULT_FIELD_HEIGHTS, DEFAULT_FIELD_WIDTHS, FIELD_TYPES, RolePermissions, VerdocsEndpoint, WEBHOOK_EVENTS, acceptOrganizationInvitation, addGroupMember, addTemplateTag, authenticate, blobToBase64, canPerformTemplateAction, cancelEnvelope, capitalize, changePassword, convertToE164, createApiKey, createEnvelope, createField, createGroup, createInitials, createOrganizationContact, createOrganizationInvitation, createProfile, createSignature, createTag, createTemplate, createTemplateDocument, createTemplateFromSharepoint, createTemplateRole, declineOrganizationInvitation, decodeAccessTokenBody, decodeJWTBody, deleteApiKey, deleteEnvelopeFieldAttachment, deleteField, deleteGroup, deleteGroupMember, deleteOrganizationContact, deleteOrganizationInvitation, deleteOrganizationMember, deleteProfile, deleteSignature, deleteTemplate, deleteTemplateDocument, deleteTemplateRole, deleteTemplateTag, downloadBlob, envelopeIsActive, envelopeIsComplete, envelopeRecipientAgree, envelopeRecipientChangeOwner, envelopeRecipientDecline, envelopeRecipientPrepare, envelopeRecipientSubmit, envelopeRecipientUpdateName, fileToDataUrl, formatFullName, formatInitials, formatShortTimeAgo, fullNameToInitials, getAllTags, getApiKeys, getCountryByCode, getCurrentProfile, getDocumentDownloadLink, getDocumentPreviewLink, getEnvelope, getEnvelopeDocument, getEnvelopeDocumentPageDisplayUri, getEnvelopeFile, getEnvelopes, getFieldAttachment, getFieldsForRole, getGroup, getGroups, getInPersonLink, getKbaStep, getMatchingCountry, getMyUser, getNextRecipient, getNotifications, getOrganization, getOrganizationContacts, getOrganizationInvitation, getOrganizationInvitations, getOrganizationMembers, 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, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, isPuertoRico, isValidEmail, isValidPhone, isValidRoleName, isValidTag, nameToRGBA, randomString, recipientCanAct, recipientHasAction, refreshToken, rescale, resendInvitation, resendOrganizationInvitation, resendVerification, resetPassword, rotateApiKey, sendDelegate, setWebhooks, startSigningSession, submitKbaChallengeResponse, submitKbaIdentity, submitKbaPin, switchProfile, toggleStar, updateApiKey, updateEnvelopeField, updateEnvelopeFieldInitials, updateEnvelopeFieldSignature, updateField, updateGroup, updateOrganization, updateOrganizationContact, updateOrganizationInvitation, updateOrganizationLogo, updateOrganizationMember, updateOrganizationThumbnail, updateProfile, updateProfilePhoto, updateRecipient, updateTemplate, updateTemplateRole, uploadEnvelopeFieldAttachment, userCanAct, userCanBuildTemplate, userCanCancelEnvelope, userCanChangeOrgVisibility, userCanCreateOrgTemplate, userCanCreatePersonalTemplate, userCanCreatePublicTemplate, userCanCreateTemplate, userCanDeleteTemplate, userCanFinishEnvelope, userCanMakeTemplatePrivate, userCanMakeTemplatePublic, userCanMakeTemplateShared, userCanPreviewTemplate, userCanReadTemplate, userCanSendTemplate, userCanSignNow, userCanUpdateTemplate, userHasPermissions, userHasSharedTemplate, userIsEnvelopeOwner, userIsEnvelopeRecipient, userIsTemplateCreator, verifyEmail };
|
|
2978
2924
|
//# sourceMappingURL=index.mjs.map
|