@verdocs/js-sdk 4.2.81 → 4.2.82

package/dist/index.mjs

@@ -50,6 +50,12 @@ const WEBHOOK_EVENTS = [
     'template_used',
 ];
 const ALL_PERMISSIONS = [
+    // TODO: Are these permissions still relevant?
+    // 'member:view',
+    // 'org:create',
+    // 'org:view',
+    // 'org:list',
+    // 'org:transfer',
     'template:creator:create:public',
     'template:creator:create:org',
     'template:creator:create:personal',
@@ -1966,12 +1972,13 @@ const updateOrganizationContact = (endpoint, profileId, params) => endpoint.api
  * @module
  */
 /**
- * Get a list of groups for a given organization. The caller must have admin access to the organization.
+ * Get a list of groups for the caller's organization. NOTE: Any organization member may request
+ * the list of groups, but only Owners and Admins may update them.
  *
  * ```typescript
  * import {getGroups} from '@verdocs/js-sdk';
  *
- * const groups = await getGroups(ORGID);
+ * const groups = await getGroups();
  * ```
  */
 const getGroups = (endpoint) => endpoint.api //
@@ -1983,24 +1990,72 @@ const getGroups = (endpoint) => endpoint.api //
  * ```typescript
  * import {getGroup} from '@verdocs/js-sdk/v2/organization-groups';
  *
- * const groups = await getGroup(GROUPID);
+ * const group = await getGroup(GROUPID);
  * ```
  */
 const getGroup = (endpoint, groupId) => endpoint.api //
     .get(`/v2/organization-groups/${groupId}`)
     .then((r) => r.data);
+/**
+ * Create a group. Note that "everyone" is a reserved name and may not be created.
+ *
+ * ```typescript
+ * import {createGroup} from '@verdocs/js-sdk';
+ *
+ * const group = await createGroup(VerdocsEndpoint.getDefault(), {name:'newgroup'});
+ * ```
+ */
 const createGroup = (endpoint, params) => endpoint.api //
     .post('/v2/organization-groups', params)
     .then((r) => r.data);
+/**
+ * Update a group. Note that "everyone" is a reserved name and may not be changed.
+ *
+ * ```typescript
+ * import {updateGroup} from '@verdocs/js-sdk';
+ *
+ * const updated = await updateGroup(VerdocsEndpoint.getDefault(), {name:'newname'});
+ * ```
+ */
+const updateGroup = (endpoint, groupId, params) => endpoint.api //
+    .patch(`/v2/organization-groups/${groupId}`, params)
+    .then((r) => r.data);
+/**
+ * Get an organization by ID. Note that the "everyone" group cannot be deleted.
+ *
+ * ```typescript
+ * import {deleteGroup} from '@verdocs/js-sdk';
+ *
+ * await deleteGroup(VerdocsEndpoint.getDefault(), 'ORGID');
+ * ```
+ */
+const deleteGroup = (endpoint, groupId) => endpoint.api //
+    .delete(`/v2/organization-groups/${groupId}`)
+    .then((r) => r.data);
+/**
+ * Add a member to a group.
+ *
+ * ```typescript
+ * import {addGroupMember} from '@verdocs/js-sdk';
+ *
+ * await addGroupMember(VerdocsEndpoint.getDefault(), 'GROUPID', 'PROFILEID');
+ * ```
+ */
 const addGroupMember = (endpoint, groupId, profile_id) => endpoint.api //
     .post(`/v2/organization-groups/${groupId}/members`, { profile_id })
     .then((r) => r.data);
+/**
+ * Remove a member from a group.
+ *
+ * ```typescript
+ * import {deleteGroupMember} from '@verdocs/js-sdk';
+ *
+ * await deleteGroupMember(VerdocsEndpoint.getDefault(), 'GROUPID', 'PROFILEID');
+ * ```
+ */
 const deleteGroupMember = (endpoint, groupId, profile_id) => endpoint.api //
     .delete(`/v2/organization-groups/${groupId}/members/${profile_id}`)
     .then((r) => r.data);
-const updateGroup = (endpoint, groupId, params) => endpoint.api //
-    .patch(`/v2/organization-groups/${groupId}`, params)
-    .then((r) => r.data);
 
 /**
  * An invitation represents an opportunity for a Member to join an Organization.
@@ -2919,5 +2974,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 { ALL_PERMISSIONS, AtoB, Countries, DEFAULT_FIELD_HEIGHTS, DEFAULT_FIELD_WIDTHS, FIELD_TYPES, RolePermissions, VerdocsEndpoint, WEBHOOK_EVENTS, acceptOrganizationInvitation, addGroupMember, addTemplateTag, authenticate, blobToBase64, canPerformTemplateAction, cancelEnvelope, capitalize, changePassword, convertToE164, createApiKey, createEnvelope, createEnvelopeReminder, createField, createGroup, createInitials, createOrganizationContact, createOrganizationInvitation, createProfile, createSignature, createTag, createTemplate, createTemplateDocument, createTemplateFromSharepoint, createTemplateReminder, createTemplateRole, declineOrganizationInvitation, decodeAccessTokenBody, decodeJWTBody, deleteApiKey, deleteEnvelopeFieldAttachment, deleteEnvelopeReminder, deleteField, deleteGroupMember, deleteOrganizationContact, 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, getEnvelopeReminder, getEnvelopes, getFieldAttachment, getFieldsForRole, getGroup, getGroups, getInPersonLink, getKbaStep, getMatchingCountry, getMyUser, getNextRecipient, getNotifications, getOrganization, getOrganizationContacts, getOrganizationInvitation, getOrganizationInvitations, getOrganizationMembers, getPlusOneCountry, getProfiles, getRGB, getRGBA, getRLeft, getRTop, getRValue, getRecipientsWithActions, getRoleColor, getSignature, getSignatures, getStars, getTag, getTemplate, getTemplateDocument, getTemplateDocumentFile, getTemplateDocumentPageDisplayUri, getTemplateDocumentThumbnail, getTemplateDocuments, getTemplateReminder, getTemplateTags, getTemplates, getValidator, getValidators, getWebhooks, hasRequiredPermissions, integerSequence, isAmericanSamoa, isCanada, isDominicanRepublic, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, isPuertoRico, isValidEmail, isValidPhone, isValidRoleName, isValidTag, nameToRGBA, randomString, recipientCanAct, recipientHasAction, refreshToken, rescale, resendInvitation, resendOrganizationInvitation, resendVerification, resetPassword, rotateApiKey, sendDelegate, setWebhooks, startSigningSession, submitKbaChallengeResponse, submitKbaIdentity, submitKbaPin, switchProfile, toggleStar, updateApiKey, updateEnvelopeField, updateEnvelopeFieldInitials, updateEnvelopeFieldSignature, updateEnvelopeReminder, updateField, updateGroup, updateOrganization, updateOrganizationContact, 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 { ALL_PERMISSIONS, AtoB, Countries, DEFAULT_FIELD_HEIGHTS, DEFAULT_FIELD_WIDTHS, FIELD_TYPES, RolePermissions, VerdocsEndpoint, WEBHOOK_EVENTS, acceptOrganizationInvitation, addGroupMember, addTemplateTag, authenticate, blobToBase64, canPerformTemplateAction, cancelEnvelope, capitalize, changePassword, convertToE164, createApiKey, createEnvelope, createEnvelopeReminder, createField, createGroup, createInitials, createOrganizationContact, createOrganizationInvitation, createProfile, createSignature, createTag, createTemplate, createTemplateDocument, createTemplateFromSharepoint, createTemplateReminder, createTemplateRole, declineOrganizationInvitation, decodeAccessTokenBody, decodeJWTBody, deleteApiKey, deleteEnvelopeFieldAttachment, deleteEnvelopeReminder, deleteField, deleteGroup, deleteGroupMember, deleteOrganizationContact, 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, getEnvelopeReminder, getEnvelopes, getFieldAttachment, getFieldsForRole, getGroup, getGroups, getInPersonLink, getKbaStep, getMatchingCountry, getMyUser, getNextRecipient, getNotifications, getOrganization, getOrganizationContacts, getOrganizationInvitation, getOrganizationInvitations, getOrganizationMembers, getPlusOneCountry, getProfiles, getRGB, getRGBA, getRLeft, getRTop, getRValue, getRecipientsWithActions, getRoleColor, getSignature, getSignatures, getStars, getTag, getTemplate, getTemplateDocument, getTemplateDocumentFile, getTemplateDocumentPageDisplayUri, getTemplateDocumentThumbnail, getTemplateDocuments, getTemplateReminder, getTemplateTags, getTemplates, getValidator, getValidators, getWebhooks, hasRequiredPermissions, integerSequence, isAmericanSamoa, isCanada, isDominicanRepublic, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, isPuertoRico, isValidEmail, isValidPhone, isValidRoleName, isValidTag, nameToRGBA, randomString, recipientCanAct, recipientHasAction, refreshToken, rescale, resendInvitation, resendOrganizationInvitation, resendVerification, resetPassword, rotateApiKey, sendDelegate, setWebhooks, startSigningSession, submitKbaChallengeResponse, submitKbaIdentity, submitKbaPin, switchProfile, toggleStar, updateApiKey, updateEnvelopeField, updateEnvelopeFieldInitials, updateEnvelopeFieldSignature, updateEnvelopeReminder, updateField, updateGroup, updateOrganization, updateOrganizationContact, 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