@verdocs/js-sdk 4.2.1 → 4.2.3

package/dist/index.js

@@ -1414,26 +1414,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.
  */
@@ -1575,32 +1563,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);
 
 /**
@@ -1624,7 +1597,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);
 /**
@@ -1640,7 +1613,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 })
@@ -2592,7 +2566,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;
@@ -2626,7 +2600,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);
@@ -2649,18 +2623,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',
@@ -2670,43 +2632,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.
  *
@@ -2716,7 +2641,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) => {
@@ -2792,33 +2717,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.
  *
@@ -2972,7 +2870,6 @@ exports.createTemplateDocument = createTemplateDocument;
 exports.createTemplateFromSharepoint = createTemplateFromSharepoint;
 exports.createTemplateReminder = createTemplateReminder;
 exports.createTemplateRole = createTemplateRole;
-exports.createTemplatev2 = createTemplatev2;
 exports.declineOrganizationInvitation = declineOrganizationInvitation;
 exports.decodeAccessTokenBody = decodeAccessTokenBody;
 exports.decodeJWTBody = decodeJWTBody;
@@ -3023,7 +2920,7 @@ exports.getFieldsForRole = getFieldsForRole;
 exports.getGroup = getGroup;
 exports.getGroups = getGroups;
 exports.getInPersonLink = getInPersonLink;
-exports.getKbaStatus = getKbaStatus;
+exports.getKbaStep = getKbaStep;
 exports.getMatchingCountry = getMatchingCountry;
 exports.getNextRecipient = getNextRecipient;
 exports.getNotifications = getNotifications;
@@ -3053,14 +2950,12 @@ exports.getTemplateDocumentFile = getTemplateDocumentFile;
 exports.getTemplateDocumentPageDisplayUri = getTemplateDocumentPageDisplayUri;
 exports.getTemplateDocumentThumbnail = getTemplateDocumentThumbnail;
 exports.getTemplateDocuments = getTemplateDocuments;
-exports.getTemplateOwnerInfo = getTemplateOwnerInfo;
 exports.getTemplateReminder = getTemplateReminder;
 exports.getTemplateRole = getTemplateRole;
 exports.getTemplateRoleFields = getTemplateRoleFields;
 exports.getTemplateRoles = getTemplateRoles;
 exports.getTemplateTags = getTemplateTags;
 exports.getTemplates = getTemplates;
-exports.getTemplatesSummary = getTemplatesSummary;
 exports.getValidator = getValidator;
 exports.getValidators = getValidators;
 exports.getWebhooks = getWebhooks;
@@ -3089,7 +2984,6 @@ exports.resendOrganizationInvitation = resendOrganizationInvitation;
 exports.resendVerification = resendVerification;
 exports.resetPassword = resetPassword;
 exports.rotateApiKey = rotateApiKey;
-exports.searchEnvelopes = searchEnvelopes;
 exports.searchTemplates = searchTemplates;
 exports.sendDelegate = sendDelegate;
 exports.setWebhooks = setWebhooks;
@@ -3097,8 +2991,6 @@ exports.submitKbaChallengeResponse = submitKbaChallengeResponse;
 exports.submitKbaIdentity = submitKbaIdentity;
 exports.submitKbaPin = submitKbaPin;
 exports.switchProfile = switchProfile;
-exports.throttledGetEnvelope = throttledGetEnvelope;
-exports.throttledGetTemplate = throttledGetTemplate;
 exports.timePeriod = timePeriod;
 exports.toggleStar = toggleStar;
 exports.updateApiKey = updateApiKey;