@verdocs/js-sdk 4.2.1 → 4.2.3

package/dist/index.mjs

@@ -1412,26 +1412,14 @@ const createEnvelope = async (endpoint, request) => endpoint.api //
  * Get a summary of currently active envelopes.
  *
  * ```typescript
- * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
+ * import {getEnvelopesSummary} from '@verdocs/js-sdk/Envelopes';
  *
- * const {action_required, completed, waiting_on_others} = await Envelopes.getSummary(VerdocsEndpoint.getDefault());
+ * const {action_required, completed, waiting_on_others} = await getEnvelopesSummary(VerdocsEndpoint.getDefault());
  * ```
  */
 const getEnvelopesSummary = async (endpoint, page) => endpoint.api //
     .post('/envelopes/summary', { page })
     .then((r) => r.data);
-/**
- * Search for envelopes matching various criteria.
- *
- * ```typescript
- * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
- *
- * const {result, page, total} = await Envelopes.search(VerdocsEndpoint.getDefault(), { ... });
- * ```
- */
-const searchEnvelopes = async (endpoint, params) => endpoint.api //
-    .post('/envelopes/search', params)
-    .then((r) => r.data);
 /**
  * Get a signing session for an Envelope.
  */
@@ -1573,32 +1561,17 @@ const getFieldAttachment = async (endpoint, envelopeId, fieldName) => endpoint.a
 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 cachedEnvelopes = {};
 /**
- * Wrapper for `getEnvelope()` that limits queries to one every 2 seconds per template ID.
- * This is intended for use in component hierarchies that all rely on the same template
- * to avoid unnecessary repeat server calls.
- */
-const throttledGetEnvelope = (endpoint, envelopeId) => {
-    if (cachedEnvelopes[envelopeId] && cachedEnvelopes[envelopeId].loaded + 2000 < new Date().getTime()) {
-        return cachedEnvelopes[envelopeId].envelope;
-    }
-    return getEnvelope(endpoint, envelopeId).then((envelope) => {
-        cachedEnvelopes[envelopeId] = { loaded: new Date().getTime(), envelope };
-        return envelope;
-    });
-};
-/**a
  * Lists all envelopes accessible by the caller, with optional filters.
  *
  * ```typescript
- * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
+ * import {getEnvelopes} from '@verdocs/js-sdk/Envelopes';
  *
- * const {totals, envelopes} = await Envelopes.listEnvelopes((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created_at' });
+ * const {count, envelopes} = await getEnvelopes((VerdocsEndpoint.getDefault(), { q: 'test' });
  * ```
  */
 const getEnvelopes = (endpoint, params) => endpoint.api //
-    .post('/envelopes/list', params)
+    .get('/envelopes', { params })
     .then((r) => r.data);
 
 /**
@@ -1622,7 +1595,7 @@ const createInitials = (endpoint, name, initials) => {
  * `recipient.kba_method` is set (not null), and `recipient.kba_completed` is false, this endpoint
  * should be called to determine the next KBA step required.
  */
-const getKbaStatus = (endpoint, envelopeId, roleName) => endpoint.api //
+const getKbaStep = (endpoint, envelopeId, roleName) => endpoint.api //
     .get(`/v2/kba/${envelopeId}/${encodeURIComponent(roleName)}`)
     .then((r) => r.data);
 /**
@@ -1638,7 +1611,8 @@ const submitKbaIdentity = (endpoint, envelopeId, roleName, identity) => endpoint
     .post(`/v2/kba/identity`, { envelopeId, roleName, identity })
     .then((r) => r.data);
 /**
- * Submit an identity response to a KBA challenge.
+ * Submit an identity response to a KBA challenge. Answers should be submitted in the same order as
+ * the challenges were listed in `IRecipientKbaStepChallenge.questions`.
  */
 const submitKbaChallengeResponse = (endpoint, envelopeId, roleName, response) => endpoint.api //
     .post(`/v2/kba/response`, { envelopeId, roleName, response })
@@ -2590,7 +2564,7 @@ const getAllTags = (endpoint) => endpoint.api //
  * ```
  */
 const getTemplates = (endpoint, params) => endpoint.api //
-    .post('/templates', { params })
+    .post('/v2/templates', { params })
     .then((r) => r.data);
 // export interface IListTemplatesParams {
 //   name?: string;
@@ -2624,7 +2598,7 @@ const getTemplates = (endpoint, params) => endpoint.api //
  * ```
  */
 const getTemplate = (endpoint, templateId) => endpoint.api //
-    .get(`/templates/${templateId}`)
+    .get(`/v2/templates/${templateId}`)
     .then((r) => {
     const template = r.data;
     window?.console?.log('[JS_SDK] Post-processing template', template);
@@ -2647,18 +2621,6 @@ const getTemplate = (endpoint, templateId) => endpoint.api //
     });
     return template;
 });
-/**
- * Get owner information for a template.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * const template = await Templates.getTemplateOwnerInfo((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
- * ```
- */
-const getTemplateOwnerInfo = (endpoint, templateId) => endpoint.api //
-    .get(`/templates/${templateId}`)
-    .then((r) => r.data);
 const ALLOWED_CREATE_FIELDS = [
     'name',
     'is_personal',
@@ -2668,43 +2630,6 @@ const ALLOWED_CREATE_FIELDS = [
     'roles',
     'fields',
 ];
-/**
- * Create a template.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * const newTemplate = await Templates.createTemplate((VerdocsEndpoint.getDefault(), {...});
- * ```
- */
-const createTemplate = (endpoint, params, onUploadProgress) => {
-    const options = {
-        timeout: 120000,
-        onUploadProgress: (event) => {
-            const total = event.total || 1;
-            const loaded = event.loaded || 0;
-            onUploadProgress?.(Math.floor((loaded * 100) / (total || 1)), loaded, total || 1);
-        },
-    };
-    if (params.documents && params.documents[0] instanceof File) {
-        if (params.documents.length > 10) {
-            throw new Error('createTemplate() has a maximum of 10 documents that can be attached.');
-        }
-        const formData = new FormData();
-        ALLOWED_CREATE_FIELDS.forEach((allowedKey) => {
-            if (params[allowedKey] !== undefined) {
-                formData.append(allowedKey, params[allowedKey]);
-            }
-        });
-        params.documents.forEach((file) => {
-            formData.append('documents', file, file.name);
-        });
-        return endpoint.api.post('/templates', formData, options).then((r) => r.data);
-    }
-    else {
-        return endpoint.api.post('/templates', params, options).then((r) => r.data);
-    }
-};
 /**
  * Create a template.
  *
@@ -2714,7 +2639,7 @@ const createTemplate = (endpoint, params, onUploadProgress) => {
  * const newTemplate = await Templates.createTemplatev2((VerdocsEndpoint.getDefault(), {...});
  * ```
  */
-const createTemplatev2 = (endpoint, params, onUploadProgress) => {
+const createTemplate = (endpoint, params, onUploadProgress) => {
     const options = {
         timeout: 120000,
         onUploadProgress: (event) => {
@@ -2790,33 +2715,6 @@ const deleteTemplate = (endpoint, templateId) => endpoint.api //
 const searchTemplates = async (endpoint, params) => endpoint.api //
     .post('/templates/search', params)
     .then((r) => r.data);
-/**
- * Get a summary of template data, typically used to populate admin panel dashboard pages.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * const summary = await Templates.getSummary((VerdocsEndpoint.getDefault(), 0);
- * ```
- */
-const getTemplatesSummary = async (endpoint, params = {}) => endpoint.api //
-    .post('/templates/summary', params)
-    .then((r) => r.data);
-const cachedTemplates = {};
-/**
- * Wrapper for `getTemplate()` that limits queries to one every 2 seconds per template ID.
- * This is intended for use in component hierarchies that all rely on the same template
- * to avoid unnecessary repeat server calls.
- */
-const throttledGetTemplate = (endpoint, templateId) => {
-    if (cachedTemplates[templateId] && cachedTemplates[templateId].loaded + 2000 < new Date().getTime()) {
-        return cachedTemplates[templateId].template;
-    }
-    return getTemplate(endpoint, templateId).then((template) => {
-        cachedTemplates[templateId] = { loaded: new Date().getTime(), template };
-        return template;
-    });
-};
 /**
  * List templates.
  *
@@ -2941,5 +2839,5 @@ const isValidRoleName = (value, roles) => roles.findIndex((role) => role.name ==
 const TagRegEx = /^[a-zA-Z0-9-]{0,32}$/;
 const isValidTag = (value, tags) => TagRegEx.test(value) || tags.findIndex((tag) => tag === value) !== -1;
 
-export { AtoB, Countries, RolePermissions, VerdocsEndpoint, acceptOrganizationInvitation, addGroupMember, addTemplateTag, authenticate, blobToBase64, canPerformTemplateAction, cancelEnvelope, capitalize, changePassword, convertToE164, createApiKey, createEnvelope, createEnvelopeReminder, createField, createGroup, createInitials, createOrganizationInvitation, createProfile, createSignature, createTag, createTemplate, createTemplateDocument, createTemplateFromSharepoint, createTemplateReminder, createTemplateRole, createTemplatev2, declineOrganizationInvitation, decodeAccessTokenBody, decodeJWTBody, deleteApiKey, deleteEnvelopeFieldAttachment, deleteEnvelopeReminder, deleteField, deleteGroupMember, deleteOrganizationInvitation, deleteOrganizationMember, deleteProfile, deleteSignature, deleteTemplate, deleteTemplateDocument, deleteTemplateReminder, 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, getEnvelopeRecipients, getEnvelopeReminder, getEnvelopes, getEnvelopesSummary, getFieldAttachment, getFieldsForRole, getGroup, getGroups, getInPersonLink, getKbaStatus, getMatchingCountry, getNextRecipient, getNotifications, getOrganization, getOrganizationInvitation, getOrganizationInvitations, getOrganizationMembers, getPlusOneCountry, getProfile, getProfiles, getRGB, getRGBA, getRLeft, getRTop, getRValue, getRecipientsWithActions, getRoleColor, getSignature, getSignatures, getSignerToken, getSigningSession, getStars, getTag, getTemplate, getTemplateDocument, getTemplateDocumentFile, getTemplateDocumentPageDisplayUri, getTemplateDocumentThumbnail, getTemplateDocuments, getTemplateOwnerInfo, getTemplateReminder, getTemplateRole, getTemplateRoleFields, getTemplateRoles, getTemplateTags, getTemplates, getTemplatesSummary, getValidator, getValidators, getWebhooks, hasRequiredPermissions, integerSequence, isAmericanSamoa, isCanada, isDominicanRepublic, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, isPuertoRico, isValidEmail, isValidPhone, isValidRoleName, isValidTag, listTemplates, nameToRGBA, recipientCanAct, recipientHasAction, refreshToken, rescale, resendInvitation, resendOrganizationInvitation, resendVerification, resetPassword, rotateApiKey, searchEnvelopes, searchTemplates, sendDelegate, setWebhooks, submitKbaChallengeResponse, submitKbaIdentity, submitKbaPin, switchProfile, throttledGetEnvelope, throttledGetTemplate, timePeriod, toggleStar, updateApiKey, updateEnvelopeField, updateEnvelopeFieldInitials, updateEnvelopeFieldSignature, updateEnvelopeReminder, updateField, updateGroup, updateOrganization, updateOrganizationInvitation, updateOrganizationLogo, updateOrganizationMember, updateOrganizationThumbnail, updateProfile, updateProfilePhoto, updateRecipient, updateTemplate, updateTemplateReminder, 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 };
+export { AtoB, Countries, RolePermissions, VerdocsEndpoint, acceptOrganizationInvitation, addGroupMember, addTemplateTag, authenticate, blobToBase64, canPerformTemplateAction, cancelEnvelope, capitalize, changePassword, convertToE164, createApiKey, createEnvelope, createEnvelopeReminder, createField, createGroup, createInitials, createOrganizationInvitation, createProfile, createSignature, createTag, createTemplate, createTemplateDocument, createTemplateFromSharepoint, createTemplateReminder, createTemplateRole, declineOrganizationInvitation, decodeAccessTokenBody, decodeJWTBody, deleteApiKey, deleteEnvelopeFieldAttachment, deleteEnvelopeReminder, deleteField, deleteGroupMember, deleteOrganizationInvitation, deleteOrganizationMember, deleteProfile, deleteSignature, deleteTemplate, deleteTemplateDocument, deleteTemplateReminder, 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, getEnvelopeRecipients, getEnvelopeReminder, getEnvelopes, getEnvelopesSummary, getFieldAttachment, getFieldsForRole, getGroup, getGroups, getInPersonLink, getKbaStep, getMatchingCountry, getNextRecipient, getNotifications, getOrganization, getOrganizationInvitation, getOrganizationInvitations, getOrganizationMembers, getPlusOneCountry, getProfile, getProfiles, getRGB, getRGBA, getRLeft, getRTop, getRValue, getRecipientsWithActions, getRoleColor, getSignature, getSignatures, getSignerToken, getSigningSession, getStars, getTag, getTemplate, getTemplateDocument, getTemplateDocumentFile, getTemplateDocumentPageDisplayUri, getTemplateDocumentThumbnail, getTemplateDocuments, getTemplateReminder, getTemplateRole, getTemplateRoleFields, getTemplateRoles, getTemplateTags, getTemplates, getValidator, getValidators, getWebhooks, hasRequiredPermissions, integerSequence, isAmericanSamoa, isCanada, isDominicanRepublic, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, isPuertoRico, isValidEmail, isValidPhone, isValidRoleName, isValidTag, listTemplates, nameToRGBA, recipientCanAct, recipientHasAction, refreshToken, rescale, resendInvitation, resendOrganizationInvitation, resendVerification, resetPassword, rotateApiKey, searchTemplates, sendDelegate, setWebhooks, submitKbaChallengeResponse, submitKbaIdentity, submitKbaPin, switchProfile, timePeriod, toggleStar, updateApiKey, updateEnvelopeField, updateEnvelopeFieldInitials, updateEnvelopeFieldSignature, updateEnvelopeReminder, updateField, updateGroup, updateOrganization, updateOrganizationInvitation, updateOrganizationLogo, updateOrganizationMember, updateOrganizationThumbnail, updateProfile, updateProfilePhoto, updateRecipient, updateTemplate, updateTemplateReminder, 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 };
 //# sourceMappingURL=index.mjs.map