@verdocs/js-sdk 4.1.5 → 4.1.7

package/dist/index.js

@@ -1385,6 +1385,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
  */
@@ -1770,6 +1799,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
@@ -2495,11 +2570,10 @@ const authenticate = (endpoint, params) => endpoint.api //
  * If called before the session expires, this will refresh the caller's session and tokens.
  *
  * ```typescript
- * import {Auth} from '@verdocs/js-sdk/Auth';
- * import {Transport} from '@verdocs/js-sdk/HTTP';
+ * import {Auth, VerdocsEndpoint} from '@verdocs/js-sdk';
  *
  * const {accessToken} = await Auth.refreshTokens();
- * Transport.setAuthToken(accessToken);
+ * VerdocsEndpoint.setAuthToken(accessToken);
  * ```
  */
 const refreshToken = (endpoint, refreshToken) => authenticate(endpoint, { grant_type: 'refresh_token', refresh_token: refreshToken });
@@ -2507,7 +2581,7 @@ const refreshToken = (endpoint, refreshToken) => authenticate(endpoint, { grant_
  * Update the caller's password when the old password is known (typically for logged-in users).
  *
  * ```typescript
- * import {changePassword} from '@verdocs/js-sdk/Auth';
+ * import {changePassword} from '@verdocs/js-sdk';
  *
  * const {status, message} = await changePassword({ email, oldPassword, newPassword });
  * if (status !== 'OK') {
@@ -2522,7 +2596,7 @@ const changePassword = (endpoint, params) => endpoint.api //
  * Request a password reset, when the old password is not known (typically in login forms).
  *
  * ```typescript
- * import {resetPassword} from '@verdocs/js-sdk/Auth';
+ * import {resetPassword} from '@verdocs/js-sdk';
  *
  * const {success} = await resetPassword({ email });
  * if (status !== 'OK') {
@@ -2541,9 +2615,25 @@ const resetPassword = (endpoint, params) => endpoint.api //
  * "anonymous" mode while verification is being performed.
  *
  * ```typescript
- * import {Auth} from '@verdocs/js-sdk/Auth';
+ * import {resendVerification} from '@verdocs/js-sdk';
  *
- * const result = await Auth.resendVerification();
+ * const result = await resendVerification();
+ * ```
+ */
+const verifyEmail = (endpoint, email, code) => endpoint.api //
+    .post('/v2/users/verify-email', { email, code })
+    .then((r) => r.data);
+/**
+ * Resend the email verification request. Note that to prevent certain forms of abuse, the email address is not
+ * a parameter here. Instead, the caller must be authenticated as the (unverified) user. To simplify this process,
+ * the access token to be used may be passed directly as a parameter here. This avoids the need to set it as the
+ * active token on an endpoint, which may be inconvenient in workflows where it is preferable to keep the user in
+ * "anonymous" mode while verification is being performed.
+ *
+ * ```typescript
+ * import {resendVerification} from '@verdocs/js-sdk';
+ *
+ * const result = await resendVerification();
  * ```
  */
 const resendVerification = (endpoint, accessToken) => endpoint.api //
@@ -2558,9 +2648,9 @@ const getNotifications = async (endpoint) => endpoint.api //
  * Get the user's available profiles. The current profile will be marked with `current: true`.
  *
  * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
+ * import {getProfiles} from '@verdocs/js-sdk';
  *
- * const profiles = await Profiles.getProfiles()
+ * const profiles = await getProfiles();
  * ```
  */
 const getProfiles = (endpoint) => endpoint.api //
@@ -2570,95 +2660,116 @@ const getProfiles = (endpoint) => endpoint.api //
  * Get the user's available profiles. The current profile will be marked with `current: true`.
  *
  * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
+ * import {getCurrentProfile} from '@verdocs/js-sdk';
  *
- * const profiles = await Profiles.getCurrentProfile()
+ * const profiles = await getCurrentProfile();
  * ```
  */
 const getCurrentProfile = (endpoint) => endpoint.api //
     .get('/v2/profiles')
     .then((r) => (r.data || []).find((profile) => profile.current));
-/**
- * Create a profile. If the caller does not have a "current" profile set, the new profile will be made current.
- *
- * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
- *
- * const newProfile = await Profiles.createProfile({ first_name: 'FIRST', last_name: 'LAST', email: 'EMAIL' });
- * ```
- */
-const createProfile = (endpoint, params) => endpoint.api //
-    .post('/v2/profiles', params)
-    .then((r) => r.data);
 /**
  * Get a profile. The caller must have admin access to the given profile.
  * TODO: Add a "public" profile endpoint for public pages
  *
  * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
+ * import {getProfile} from '@verdocs/js-sdk';
  *
- * const profile = await Profiles.getProfile('PROFILEID');
+ * const profile = await getProfile('PROFILEID');
  * ```
  */
 const getProfile = (endpoint, profileId) => endpoint.api //
     .get(`/v2/profiles/${profileId}`)
     .then((r) => r.data);
 /**
- * Switch the caller's "current" profile. The current profile is used for permissions checking and profile_id field settings
- * for most operations in Verdocs. It is important to select the appropropriate profile before calling other API functions.
+ * Switch the caller's "current" profile. The current profile is used for permissions checking
+ * and profile_id field settings for most operations in Verdocs. It is important to select the
+ * appropropriate profile before calling other API functions.
  *
  * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
+ * import {switchProfile} from '@verdocs/js-sdk';
  *
- * const newProfile = await Profiles.switchProfile('PROFILEID');
+ * const newProfile = await switchProfile('PROFILEID');
  * ```
  */
 const switchProfile = (endpoint, profileId) => endpoint.api //
     .post(`/v2/profiles/${profileId}/switch`)
     .then((r) => r.data);
 /**
- * Update a profile. For future expansion, the profile ID to update is required, but currently this must also be the
- * "current" profile for the caller.
+ * Update a profile. For future expansion, the profile ID to update is required, but currently
+ * this must also be the "current" profile for the caller.
  *
  * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
+ * import {updateProfile} from '@verdocs/js-sdk/Users';
  *
- * const newProfile = await Profiles.updateProfile('PROFILEID');
+ * const newProfile = await updateProfile('PROFILEID');
  * ```
  */
 const updateProfile = (endpoint, profileId, params) => endpoint.api //
     .patch(`/v2/profiles/${profileId}`, params)
     .then((r) => r.data);
 /**
- * Delete a profile. If the requested profile is the caller's curent profile, the next available profile will be selected.
+ * Delete a profile. If the requested profile is the caller's curent profile, the next
+ * available profile will be selected.
  *
  * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
+ * import {deleteProfile} from '@verdocs/js-sdk';
  *
- * await Profiles.deleteProfile('PROFILEID');
+ * await deleteProfile('PROFILEID');
  * ```
  */
 const deleteProfile = (endpoint, profileId) => endpoint.api //
     .delete(`/v2/profiles/${profileId}`)
     .then((r) => r.data);
 /**
- * Create a user account and parent organization. This endpoint is for creating a new organization. Users joining an
- * existing organization should be invited, and follow their invitation links/instructions to create their accounts.
+ * Create a new user account. Note that there are two registration paths for creation:
+ *   - Get invited to an organization, by an admin or owner of that org.
+ *   - Created a new organization. The caller will become the first owner of the new org.
+ *
+ * This endpoint is for the second path, so an organization name is required. It is NOT
+ * required to be unique because it is very common for businesses to have the same names,
+ * without conflicting (e.g. "Delta" could be Delta Faucet or Delta Airlines).
+ *
+ * The new profile will automatically be set as the user's "current" profile, and new
+ * session tokens will be returned to the caller. However, the caller's email may not yet
+ * be verified. In that case, the caller will not yet be able to call other endpoints in
+ * the Verdocs API. The caller will need to check their email for a verification code,
+ * which should be submitted via the `verifyEmail` endpoint.
  *
  * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
+ * import {createProfile} from '@verdocs/js-sdk';
  *
- * const newAccount = await Profiles.createBusinessAccount({
- *   orgName: 'ORG', email: 'a@b.com', password: '12345678', firstName: 'FIRST', lastName: 'LAST'
+ * const newSession = await createProfile({
+ *   orgName: 'NEW ORG', email: 'a@b.com', password: '12345678', firstName: 'FIRST', lastName: 'LAST'
  * });
  * ```
  */
-const createAccount = (endpoint, params) => endpoint.api //
-    .post('/user/business', params)
-    .then((r) => r.data);
-const recordSignupSurvey = (endpoint, params) => endpoint.api //
-    .post('/user/signup', params)
+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);
+};
 
 exports.AtoB = AtoB;
 exports.Countries = Countries;
@@ -2673,7 +2784,6 @@ exports.cancelEnvelope = cancelEnvelope;
 exports.capitalize = capitalize;
 exports.changePassword = changePassword;
 exports.convertToE164 = convertToE164;
-exports.createAccount = createAccount;
 exports.createApiKey = createApiKey;
 exports.createEnvelope = createEnvelope;
 exports.createEnvelopeReminder = createEnvelopeReminder;
@@ -2742,6 +2852,7 @@ exports.getFieldsForRole = getFieldsForRole;
 exports.getGroup = getGroup;
 exports.getGroups = getGroups;
 exports.getInPersonLink = getInPersonLink;
+exports.getKbaStatus = getKbaStatus;
 exports.getMatchingCountry = getMatchingCountry;
 exports.getNextRecipient = getNextRecipient;
 exports.getNotifications = getNotifications;
@@ -2802,7 +2913,6 @@ exports.listTemplates = listTemplates;
 exports.nameToRGBA = nameToRGBA;
 exports.recipientCanAct = recipientCanAct;
 exports.recipientHasAction = recipientHasAction;
-exports.recordSignupSurvey = recordSignupSurvey;
 exports.refreshToken = refreshToken;
 exports.rescale = rescale;
 exports.resendInvitation = resendInvitation;
@@ -2814,6 +2924,9 @@ exports.searchEnvelopes = searchEnvelopes;
 exports.searchTemplates = searchTemplates;
 exports.sendDelegate = sendDelegate;
 exports.setWebhooks = setWebhooks;
+exports.submitKbaChallengeResponse = submitKbaChallengeResponse;
+exports.submitKbaIdentity = submitKbaIdentity;
+exports.submitKbaPin = submitKbaPin;
 exports.switchProfile = switchProfile;
 exports.throttledGetEnvelope = throttledGetEnvelope;
 exports.throttledGetTemplate = throttledGetTemplate;
@@ -2835,6 +2948,9 @@ exports.updateTemplate = updateTemplate;
 exports.updateTemplateReminder = updateTemplateReminder;
 exports.updateTemplateRole = updateTemplateRole;
 exports.uploadEnvelopeFieldAttachment = uploadEnvelopeFieldAttachment;
+exports.uploadOrganizationLogo = uploadOrganizationLogo;
+exports.uploadOrganizationThumbnail = uploadOrganizationThumbnail;
+exports.uploadProfilePhoto = uploadProfilePhoto;
 exports.userCanAct = userCanAct;
 exports.userCanBuildTemplate = userCanBuildTemplate;
 exports.userCanCancelEnvelope = userCanCancelEnvelope;
@@ -2858,4 +2974,5 @@ exports.userHasSharedTemplate = userHasSharedTemplate;
 exports.userIsEnvelopeOwner = userIsEnvelopeOwner;
 exports.userIsEnvelopeRecipient = userIsEnvelopeRecipient;
 exports.userIsTemplateCreator = userIsTemplateCreator;
+exports.verifyEmail = verifyEmail;
 //# sourceMappingURL=index.js.map