@verdocs/js-sdk 4.1.6 → 4.1.7

package/dist/index.mjs

@@ -1383,6 +1383,35 @@ const createInitials = (endpoint, name, initials) => {
         .then((r) => r.data);
 };
 
+/**
+ * Get the current KBA status. Note that this may only be called by the recipient and requires a
+ * valid signing session to proceed. Although the Recipient object itself contains indications of
+ * whether KBA is required, it will not contain the current status of the process. If
+ * `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 //
+    .get(`/v2/kba/${envelopeId}/${encodeURIComponent(roleName)}`)
+    .then((r) => r.data);
+/**
+ * Submit a response to a KBA PIN challenge.
+ */
+const submitKbaPin = (endpoint, envelopeId, roleName, pin) => endpoint.api //
+    .post(`/v2/kba/pin`, { envelopeId, roleName, pin })
+    .then((r) => r.data);
+/**
+ * Submit an identity response to a KBA challenge.
+ */
+const submitKbaIdentity = (endpoint, envelopeId, roleName, identity) => endpoint.api //
+    .post(`/v2/kba/identity`, { envelopeId, roleName, identity })
+    .then((r) => r.data);
+/**
+ * Submit an identity response to a KBA challenge.
+ */
+const submitKbaChallengeResponse = (endpoint, envelopeId, roleName, response) => endpoint.api //
+    .post(`/v2/kba/response`, { envelopeId, roleName, response })
+    .then((r) => r.data);
+
 /**
  * Update a recipient's status block
  */
@@ -1768,6 +1797,52 @@ const deleteOrganization = (endpoint, organizationId) => endpoint.api //
 const updateOrganization = (endpoint, organizationId, params) => endpoint.api //
     .patch(`/v2/organizations/${organizationId}`, params)
     .then((r) => r.data);
+/**
+ * Update the organization's logo. This can only be called by an admin or owner of the organization.
+ *
+ * ```typescript
+ * import {uploadOrganizationLogo} from '@verdocs/js-sdk';
+ *
+ * await uploadOrganizationLogo((VerdocsEndpoint.getDefault(), file);
+ * ```
+ */
+const uploadOrganizationLogo = (endpoint, file, onUploadProgress) => {
+    const formData = new FormData();
+    formData.append('document', file, file.name);
+    return endpoint.api //
+        .post(`/v2/organizations/logo`, formData, {
+        timeout: 120000,
+        onUploadProgress: (event) => {
+            const total = event.total || 1;
+            const loaded = event.loaded || 0;
+            onUploadProgress?.(Math.floor((loaded * 100) / (total || 1)), loaded, total || 1);
+        },
+    })
+        .then((r) => r.data);
+};
+/**
+ * Update the organization's thumbnail. This can only be called by an admin or owner of the organization.
+ *
+ * ```typescript
+ * import {uploadOrganizationThumbnail} from '@verdocs/js-sdk';
+ *
+ * await uploadOrganizationThumbnail((VerdocsEndpoint.getDefault(), file);
+ * ```
+ */
+const uploadOrganizationThumbnail = (endpoint, file, onUploadProgress) => {
+    const formData = new FormData();
+    formData.append('document', file, file.name);
+    return endpoint.api //
+        .post(`/v2/organizations/thumbnail`, formData, {
+        timeout: 120000,
+        onUploadProgress: (event) => {
+            const total = event.total || 1;
+            const loaded = event.loaded || 0;
+            onUploadProgress?.(Math.floor((loaded * 100) / (total || 1)), loaded, total || 1);
+        },
+    })
+        .then((r) => r.data);
+};
 
 /**
  * Webhooks are callback triggers from Verdocs to your servers that notify your applications
@@ -2670,6 +2745,29 @@ const deleteProfile = (endpoint, profileId) => endpoint.api //
 const createProfile = (endpoint, params) => endpoint.api //
     .post('/v2/profiles', params)
     .then((r) => r.data);
+/**
+ * Update the caller's profile photo. This can only be called for the user's "current" profile.
+ *
+ * ```typescript
+ * import {uploadProfilePhoto} from '@verdocs/js-sdk';
+ *
+ * await uploadProfilePhoto((VerdocsEndpoint.getDefault(), file);
+ * ```
+ */
+const uploadProfilePhoto = (endpoint, file, onUploadProgress) => {
+    const formData = new FormData();
+    formData.append('document', file, file.name);
+    return endpoint.api //
+        .post(`/v2/profiles/picture`, formData, {
+        timeout: 120000,
+        onUploadProgress: (event) => {
+            const total = event.total || 1;
+            const loaded = event.loaded || 0;
+            onUploadProgress?.(Math.floor((loaded * 100) / (total || 1)), loaded, total || 1);
+        },
+    })
+        .then((r) => r.data);
+};
 
-export { AtoB, Countries, VerdocsEndpoint, acceptOrganizationInvitation, addGroupMember, addTemplateTag, authenticate, blobToBase64, canPerformTemplateAction, cancelEnvelope, capitalize, changePassword, convertToE164, createApiKey, createEnvelope, createEnvelopeReminder, createField, createGroup, createInitials, createOrganization, createOrganizationInvitation, createProfile, createSignature, createTag, createTemplate, createTemplateDocument, createTemplateFromSharepoint, createTemplateReminder, createTemplateRole, createTemplatev2, declineOrganizationInvitation, decodeAccessTokenBody, decodeJWTBody, deleteApiKey, deleteEnvelopeFieldAttachment, deleteEnvelopeReminder, deleteField, deleteGroupMember, deleteOrganization, 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, getEnvelopesByTemplateId, getEnvelopesSummary, getFieldAttachment, getFieldsForRole, getGroup, getGroups, getInPersonLink, getMatchingCountry, getNextRecipient, getNotifications, getOrganization, getOrganizationInvitation, getOrganizationInvitations, getOrganizationMembers, getOrganizations, 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, listEnvelopes, listTemplates, nameToRGBA, recipientCanAct, recipientHasAction, refreshToken, rescale, resendInvitation, resendOrganizationInvitation, resendVerification, resetPassword, rotateApiKey, searchEnvelopes, searchTemplates, sendDelegate, setWebhooks, switchProfile, throttledGetEnvelope, throttledGetTemplate, timePeriod, toggleStar, updateApiKey, updateEnvelopeField, updateEnvelopeFieldInitials, updateEnvelopeFieldSignature, updateEnvelopeReminder, updateField, updateGroup, updateOrganization, updateOrganizationInvitation, updateOrganizationMember, updateProfile, 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, VerdocsEndpoint, acceptOrganizationInvitation, addGroupMember, addTemplateTag, authenticate, blobToBase64, canPerformTemplateAction, cancelEnvelope, capitalize, changePassword, convertToE164, createApiKey, createEnvelope, createEnvelopeReminder, createField, createGroup, createInitials, createOrganization, createOrganizationInvitation, createProfile, createSignature, createTag, createTemplate, createTemplateDocument, createTemplateFromSharepoint, createTemplateReminder, createTemplateRole, createTemplatev2, declineOrganizationInvitation, decodeAccessTokenBody, decodeJWTBody, deleteApiKey, deleteEnvelopeFieldAttachment, deleteEnvelopeReminder, deleteField, deleteGroupMember, deleteOrganization, 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, getEnvelopesByTemplateId, getEnvelopesSummary, getFieldAttachment, getFieldsForRole, getGroup, getGroups, getInPersonLink, getKbaStatus, getMatchingCountry, getNextRecipient, getNotifications, getOrganization, getOrganizationInvitation, getOrganizationInvitations, getOrganizationMembers, getOrganizations, 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, listEnvelopes, 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, updateOrganizationMember, updateProfile, updateRecipient, updateTemplate, updateTemplateReminder, updateTemplateRole, uploadEnvelopeFieldAttachment, uploadOrganizationLogo, uploadOrganizationThumbnail, uploadProfilePhoto, 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