@verdocs/js-sdk 6.7.7 → 6.8.2

package/dist/index.mjs

@@ -2153,6 +2153,12 @@ const userCanSendTemplate = (profile, template) => {
         case 'public':
             return true;
     }
+    if (!template.roles || !template.roles.length) {
+        return false;
+    }
+    if (!template.fields || !template.fields.length) {
+        return false;
+    }
 };
 /**
  * Confirm whether the user can create a new template.
@@ -2986,7 +2992,19 @@ const recipientCanAct = (recipient, recipientsWithActions) => recipient.sequence
  * Returns true if the user can act.
  */
 const userCanAct = (email, recipientsWithActions) => {
-    const recipient = recipientsWithActions.find((r) => r.email === email);
+    const recipient = recipientsWithActions.find((r) => r.email?.toLowerCase() === email?.toLowerCase());
+    return recipient && recipient.sequence === recipientsWithActions?.[0]?.sequence;
+};
+/**
+ * Get a recipient from an envelope via an email match.
+ */
+const getRecipient = (email, envelope) => (envelope.recipients || []).find((r) => r.email?.toLowerCase() === email?.toLowerCase());
+/**
+ * Get a recipient that can act from an envelope via an email match.
+ */
+const getRecipientWithActions = (email, envelope) => {
+    const recipientsWithActions = getRecipientsWithActions(envelope);
+    const recipient = recipientsWithActions.find((r) => r.email?.toLowerCase() === email?.toLowerCase());
     return recipient && recipient.sequence === recipientsWithActions?.[0]?.sequence;
 };
 /**
@@ -2997,7 +3015,7 @@ const userCanSignNow = (profile, envelope) => {
         return false;
     }
     const recipientsWithActions = getRecipientsWithActions(envelope);
-    const myRecipient = recipientsWithActions.find((r) => r.profile_id === profile?.id || r.email === profile?.email);
+    const myRecipient = recipientsWithActions.find((r) => r.profile_id === profile?.id || r.email?.toLowerCase() === profile?.email?.toLowerCase());
     return (myRecipient &&
         envelopeIsActive(envelope) &&
         userIsEnvelopeRecipient(profile, envelope) &&
@@ -3486,6 +3504,47 @@ const deleteOrganizationMember = (endpoint, profileId) => endpoint.api //
 const updateOrganizationMember = (endpoint, profileId, params) => endpoint.api //
     .patch(`/v2/organization-members/${profileId}`, params)
     .then((r) => r.data);
+/**
+ * Lock an organization member's account. The member will be unable to sign in until an admin
+ * unlocks them or they complete the password-reset flow. Caller must be an admin or owner,
+ * may not lock him/herself, and the target must have a linked user account.
+ *
+ * ```typescript
+ * import {lockOrganizationMember} from '@verdocs/js-sdk';
+ *
+ * const result = await lockOrganizationMember(VerdocsEndpoint.getDefault(), 'PROFILEID', 'Departed employee');
+ * ```
+ *
+ * @group Organization Members
+ * @api PUT /v2/organization-members/:profile_id Perform an operation on an organization member.
+ * @apiParam string(format:uuid) profile_id The Profile ID to operate on.
+ * @apiBody string(enum:'lock') action Action to perform
+ * @apiBody string reason Reason the account is being locked. Stored on the user record and shown to admins.
+ * @apiSuccess IProfile . The updated profile for the member, with the joined user record.
+ */
+const lockOrganizationMember = (endpoint, profileId, reason) => endpoint.api //
+    .put(`/v2/organization-members/${profileId}`, { action: 'lock', reason })
+    .then((r) => r.data);
+/**
+ * Unlock a member whose account has been locked (typically after too many failed sign-in attempts
+ * or via an earlier admin lock). Caller must be an admin or owner, may not unlock him/herself, and
+ * the target must have a linked user account. Clears `locked`, `lock_reason`, and `login_failures`.
+ *
+ * ```typescript
+ * import {unlockOrganizationMember} from '@verdocs/js-sdk';
+ *
+ * const result = await unlockOrganizationMember(VerdocsEndpoint.getDefault(), 'PROFILEID');
+ * ```
+ *
+ * @group Organization Members
+ * @api PUT /v2/organization-members/:profile_id Perform an operation on an organization member.
+ * @apiParam string(format:uuid) profile_id The Profile ID to operate on.
+ * @apiBody string(enum:'unlock') action Action to perform
+ * @apiSuccess IProfile . The updated profile for the member, with the joined user record.
+ */
+const unlockOrganizationMember = (endpoint, profileId) => endpoint.api //
+    .put(`/v2/organization-members/${profileId}`, { action: 'unlock' })
+    .then((r) => r.data);
 
 /**
  * Notification Templates allow organizations to customize the email and SMS notifications
@@ -3897,5 +3956,5 @@ const rotateWebhookSecret = (endpoint) => endpoint.api //
     .put(`/v2/webhooks/rotate-secret`)
     .then((r) => r.data);
 
-export { ALL_PERMISSIONS, AtoB, Countries, DEFAULT_DISCLOSURES, DEFAULT_FIELD_HEIGHTS, DEFAULT_FIELD_WIDTHS, FIELD_TYPES, RolePermissions, VerdocsEndpoint, WEBHOOK_EVENTS, acceptOrganizationInvitation, addGroupMember, askQuestion, authenticate, blobToBase64, canAccessEnvelope, canPerformTemplateAction, cancelEnvelope, capitalize, changePassword, collapseEntitlements, convertToE164, createApiKey, createEnvelope, createField, createGroup, createInitials, createNotificationTemplate, createOrganization, createOrganizationContact, createOrganizationInvitation, createProfile, createSignature, createTemplate, createTemplateDocument, createTemplateFromSharepoint, createTemplateRole, declineOrganizationInvitation, decodeAccessTokenBody, decodeJWTBody, delegateRecipient, deleteApiKey, deleteEnvelopeFieldAttachment, deleteField, deleteGroup, deleteGroupMember, deleteNotificationTemplate, deleteOrganization, deleteOrganizationContact, deleteOrganizationInvitation, deleteOrganizationMember, deleteProfile, deleteTemplate, deleteTemplateDocument, deleteTemplateRole, downloadBlob, downloadEnvelopeDocument, downloadTemplateDocument, duplicateTemplate, envelopeIsActive, envelopeIsComplete, envelopeRecipientAgree, envelopeRecipientDecline, envelopeRecipientSubmit, fileToDataUrl, formatFullName, formatInitials, formatShortTimeAgo, fullNameToInitials, getActiveEntitlements, getApiKeys, getCountryByCode, getCurrentProfile, getEntitlements, getEnvelope, getEnvelopeDocument, getEnvelopeDocumentDownloadLink, getEnvelopeDocumentPageDisplayUri, getEnvelopeDocumentPreviewLink, getEnvelopeFile, getEnvelopes, getEnvelopesZip, getFieldsForRole, getGroup, getGroups, getInPersonLink, getKbaStep, getMatchingCountry, getMyUser, getNextRecipient, getNotificationTemplate, getNotificationTemplates, getNotifications, getOrganization, getOrganizationChildren, getOrganizationContacts, getOrganizationInvitation, getOrganizationInvitations, getOrganizationMembers, getOrganizationUsage, getPlusOneCountry, getProfiles, getRGB, getRGBA, getRLeft, getRTop, getRValue, getRecipientsWithActions, getRoleColor, getTemplate, getTemplateDocument, getTemplateDocumentDownloadLink, getTemplateDocumentFile, getTemplateDocumentPageDisplayUri, getTemplateDocumentPreviewLink, getTemplateDocumentThumbnail, getTemplates, getValidators, getWebhooks, hasRequiredPermissions, integerSequence, isAmericanSamoa, isCanada, isDominicanRepublic, isEnvelopeOwner, isEnvelopeRecipient, isFieldFilled, isFieldValid, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, isPuertoRico, isValidEmail, isValidInput, isValidPhone, isValidRoleName, isValidTag, nameToRGBA, randomString, recipientCanAct, recipientHasAction, refreshToken, remindRecipient, rescale, resendOrganizationInvitation, resendVerification, resetPassword, resetRecipient, rotateApiKey, rotateWebhookSecret, setWebhooks, sortDocuments, sortFields, sortRecipients, startSigningSession, submitKbaChallengeResponse, submitKbaIdentity, submitKbaPin, switchProfile, toggleTemplateStar, updateApiKey, updateEnvelope, updateEnvelopeField, updateField, updateGroup, updateNotificationTemplate, updateOrganization, updateOrganizationContact, updateOrganizationInvitation, updateOrganizationLogo, updateOrganizationMember, updateOrganizationThumbnail, updateProfile, updateProfilePhoto, updateRecipient, updateTemplate, updateTemplateRole, uploadEnvelopeFieldAttachment, useCanAccessEnvelope, userCanAct, userCanBuildTemplate, userCanCancelEnvelope, userCanChangeOrgVisibility, userCanCreateOrgTemplate, userCanCreatePersonalTemplate, userCanCreatePublicTemplate, userCanCreateTemplate, userCanDeleteTemplate, userCanFinishEnvelope, userCanMakeTemplatePrivate, userCanMakeTemplatePublic, userCanMakeTemplateShared, userCanPreviewTemplate, userCanReadTemplate, userCanSendTemplate, userCanSignNow, userCanUpdateTemplate, userHasPermissions, userHasSharedTemplate, userIsEnvelopeOwner, userIsEnvelopeRecipient, userIsTemplateCreator, verifyEmail, verifySigner };
+export { ALL_PERMISSIONS, AtoB, Countries, DEFAULT_DISCLOSURES, DEFAULT_FIELD_HEIGHTS, DEFAULT_FIELD_WIDTHS, FIELD_TYPES, RolePermissions, VerdocsEndpoint, WEBHOOK_EVENTS, acceptOrganizationInvitation, addGroupMember, askQuestion, authenticate, blobToBase64, canAccessEnvelope, canPerformTemplateAction, cancelEnvelope, capitalize, changePassword, collapseEntitlements, convertToE164, createApiKey, createEnvelope, createField, createGroup, createInitials, createNotificationTemplate, createOrganization, createOrganizationContact, createOrganizationInvitation, createProfile, createSignature, createTemplate, createTemplateDocument, createTemplateFromSharepoint, createTemplateRole, declineOrganizationInvitation, decodeAccessTokenBody, decodeJWTBody, delegateRecipient, deleteApiKey, deleteEnvelopeFieldAttachment, deleteField, deleteGroup, deleteGroupMember, deleteNotificationTemplate, deleteOrganization, deleteOrganizationContact, deleteOrganizationInvitation, deleteOrganizationMember, deleteProfile, deleteTemplate, deleteTemplateDocument, deleteTemplateRole, downloadBlob, downloadEnvelopeDocument, downloadTemplateDocument, duplicateTemplate, envelopeIsActive, envelopeIsComplete, envelopeRecipientAgree, envelopeRecipientDecline, envelopeRecipientSubmit, fileToDataUrl, formatFullName, formatInitials, formatShortTimeAgo, fullNameToInitials, getActiveEntitlements, getApiKeys, getCountryByCode, getCurrentProfile, getEntitlements, getEnvelope, getEnvelopeDocument, getEnvelopeDocumentDownloadLink, getEnvelopeDocumentPageDisplayUri, getEnvelopeDocumentPreviewLink, getEnvelopeFile, getEnvelopes, getEnvelopesZip, getFieldsForRole, getGroup, getGroups, getInPersonLink, getKbaStep, getMatchingCountry, getMyUser, getNextRecipient, getNotificationTemplate, getNotificationTemplates, getNotifications, getOrganization, getOrganizationChildren, getOrganizationContacts, getOrganizationInvitation, getOrganizationInvitations, getOrganizationMembers, getOrganizationUsage, getPlusOneCountry, getProfiles, getRGB, getRGBA, getRLeft, getRTop, getRValue, getRecipient, getRecipientWithActions, getRecipientsWithActions, getRoleColor, getTemplate, getTemplateDocument, getTemplateDocumentDownloadLink, getTemplateDocumentFile, getTemplateDocumentPageDisplayUri, getTemplateDocumentPreviewLink, getTemplateDocumentThumbnail, getTemplates, getValidators, getWebhooks, hasRequiredPermissions, integerSequence, isAmericanSamoa, isCanada, isDominicanRepublic, isEnvelopeOwner, isEnvelopeRecipient, isFieldFilled, isFieldValid, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, isPuertoRico, isValidEmail, isValidInput, isValidPhone, isValidRoleName, isValidTag, lockOrganizationMember, nameToRGBA, randomString, recipientCanAct, recipientHasAction, refreshToken, remindRecipient, rescale, resendOrganizationInvitation, resendVerification, resetPassword, resetRecipient, rotateApiKey, rotateWebhookSecret, setWebhooks, sortDocuments, sortFields, sortRecipients, startSigningSession, submitKbaChallengeResponse, submitKbaIdentity, submitKbaPin, switchProfile, toggleTemplateStar, unlockOrganizationMember, updateApiKey, updateEnvelope, updateEnvelopeField, updateField, updateGroup, updateNotificationTemplate, updateOrganization, updateOrganizationContact, updateOrganizationInvitation, updateOrganizationLogo, updateOrganizationMember, updateOrganizationThumbnail, updateProfile, updateProfilePhoto, updateRecipient, updateTemplate, updateTemplateRole, uploadEnvelopeFieldAttachment, useCanAccessEnvelope, userCanAct, userCanBuildTemplate, userCanCancelEnvelope, userCanChangeOrgVisibility, userCanCreateOrgTemplate, userCanCreatePersonalTemplate, userCanCreatePublicTemplate, userCanCreateTemplate, userCanDeleteTemplate, userCanFinishEnvelope, userCanMakeTemplatePrivate, userCanMakeTemplatePublic, userCanMakeTemplateShared, userCanPreviewTemplate, userCanReadTemplate, userCanSendTemplate, userCanSignNow, userCanUpdateTemplate, userHasPermissions, userHasSharedTemplate, userIsEnvelopeOwner, userIsEnvelopeRecipient, userIsTemplateCreator, verifyEmail, verifySigner };
 //# sourceMappingURL=index.mjs.map