@verdocs/js-sdk 4.1.10 → 4.1.12

package/dist/index.js

@@ -1724,27 +1724,61 @@ const updateGroup = (endpoint, groupId, params) => endpoint.api //
  *
  * @module
  */
+/**
+ * Get a list of invitations pending for the caller's organization. The caller must be an admin or owner.
+ */
 const getOrganizationInvitations = (endpoint) => endpoint.api //
     .get(`/v2/organization-invitations`)
     .then((r) => r.data);
+/**
+ * Invite a new user to join the organization.
+ */
 const createOrganizationInvitation = (endpoint, params) => endpoint.api //
     .post(`/v2/organization-invitations`, params)
     .then((r) => r.data);
+/**
+ * Delete an invitation. Note that no cancellation message will be sent. Invitations are also one-time-use.
+ * If the invitee attempts to join after the invitation is deleted, accepted, or decline, they will be
+ * shown an error.
+ */
 const deleteOrganizationInvitation = (endpoint, email) => endpoint.api //
     .delete(`/v2/organization-invitations/${email}`)
     .then((r) => r.data);
+/**
+ * Update an invitation. Note that email may not be changed after the invite is sent. To change
+ * an invitee's email, delete the incorrect entry and create one with the correct value.
+ */
 const updateOrganizationInvitation = (endpoint, email, params) => endpoint.api //
     .patch(`/v2/organization-invitations/${email}`, params)
     .then((r) => r.data);
+/**
+ * Send a reminder to the invitee to join the organization.
+ */
 const resendOrganizationInvitation = (endpoint, email) => endpoint.api //
     .post('/v2/organization-invitations/resend', { email })
     .then((r) => r.data);
+/**
+ * Get an invitation's details. This is generally used as the first step of accepting the invite.
+ * A successful response will indicate that the invite token is still valid, and include some
+ * metadata for the organization to style the acceptance screen.
+ */
 const getOrganizationInvitation = (endpoint, email, token) => endpoint.api //
     .get(`/v2/organization-invitations/${email}/${token}`)
     .then((r) => r.data);
+/**
+ * Accept an invitation. This will automatically create an Auth0 user for the caller as well as a profile
+ * with the appropriate role as specified in the invite. The profile will be set as "current" for the caller,
+ * and session tokens will be returned to access the new profile. The profile's email_verified flag will
+ * also be set to true.
+ */
 const acceptOrganizationInvitation = (endpoint, email, token) => endpoint.api //
     .post('/v2/organization-invitations/accept', { email, token })
     .then((r) => r.data);
+/**
+ * Decline an invitation. This will mark the status "declined," providing a visual indication to the
+ * organization's admins that the invite was declined, preventing further invites from being created
+ * to the same email address, and also preventing the invitee from receiving reminders to join.
+ */
 const declineOrganizationInvitation = (endpoint, email, token) => endpoint.api //
     .post('/v2/organization-invitations/decline', { email, token })
     .then((r) => r.data);
@@ -1754,12 +1788,22 @@ const declineOrganizationInvitation = (endpoint, email, token) => endpoint.api /
  *
  * @module
  */
+/**
+ * Get a list of the members in the caller's organization.
+ */
 const getOrganizationMembers = (endpoint) => endpoint.api //
     .get(`/v2/organization-members`)
     .then((r) => r.data);
+/**
+ * Delete a member from the caller's organization. Note that the caller must be an admin or owner,
+ * may not delete him/herself
+ */
 const deleteOrganizationMember = (endpoint, profileId) => endpoint.api //
     .delete(`/v2/organization-members/${profileId}`)
     .then((r) => r.data);
+/**
+ * Update a member.
+ */
 const updateOrganizationMember = (endpoint, profileId, params) => endpoint.api //
     .patch(`/v2/organization-members/${profileId}`, params)
     .then((r) => r.data);
@@ -1778,19 +1822,8 @@ const updateOrganizationMember = (endpoint, profileId, params) => endpoint.api /
  * @module
  */
 /**
- * Get a list of organizations the caller is a member of.
- *
- * ```typescript
- * import {getOrganizations} from '@verdocs/js-sdk';
- *
- * const organizations = await getOrganizations(VerdocsEndpoint.getDefault());
- * ```
- */
-const getOrganizations = (endpoint) => endpoint.api //
-    .get('/v2/organizations')
-    .then((r) => r.data);
-/**
- * Get an organization by ID.
+ * Get an organization by ID. Note that this endpoint will return only a subset of fields
+ * if the caller is not a member of the organization (the public fields).
  *
  * ```typescript
  * import {getOrganization} from '@verdocs/js-sdk';
@@ -1817,12 +1850,12 @@ const updateOrganization = (endpoint, organizationId, params) => endpoint.api //
  * Update the organization's logo. This can only be called by an admin or owner.
  *
  * ```typescript
- * import {uploadOrganizationLogo} from '@verdocs/js-sdk';
+ * import {updateOrganizationLogo} from '@verdocs/js-sdk';
  *
- * await uploadOrganizationLogo((VerdocsEndpoint.getDefault(), organizationId, file);
+ * await updateOrganizationLogo((VerdocsEndpoint.getDefault(), organizationId, file);
  * ```
  */
-const uploadOrganizationLogo = (endpoint, organizationId, file, onUploadProgress) => {
+const updateOrganizationLogo = (endpoint, organizationId, file, onUploadProgress) => {
     const formData = new FormData();
     formData.append('logo', file, file.name);
     return endpoint.api //
@@ -1840,12 +1873,12 @@ const uploadOrganizationLogo = (endpoint, organizationId, file, onUploadProgress
  * Update the organization's thumbnail. This can only be called by an admin or owner.
  *
  * ```typescript
- * import {uploadOrganizationThumbnail} from '@verdocs/js-sdk';
+ * import {updateOrganizationThumbnail} from '@verdocs/js-sdk';
  *
- * await uploadOrganizationThumbnail((VerdocsEndpoint.getDefault(), organizationId, file);
+ * await updateOrganizationThumbnail((VerdocsEndpoint.getDefault(), organizationId, file);
  * ```
  */
-const uploadOrganizationThumbnail = (endpoint, organizationId, file, onUploadProgress) => {
+const updateOrganizationThumbnail = (endpoint, organizationId, file, onUploadProgress) => {
     const formData = new FormData();
     formData.append('thumbnail', file, file.name);
     return endpoint.api //
@@ -2871,7 +2904,6 @@ exports.getOrganization = getOrganization;
 exports.getOrganizationInvitation = getOrganizationInvitation;
 exports.getOrganizationInvitations = getOrganizationInvitations;
 exports.getOrganizationMembers = getOrganizationMembers;
-exports.getOrganizations = getOrganizations;
 exports.getPlusOneCountry = getPlusOneCountry;
 exports.getProfile = getProfile;
 exports.getProfiles = getProfiles;
@@ -2952,7 +2984,9 @@ exports.updateField = updateField;
 exports.updateGroup = updateGroup;
 exports.updateOrganization = updateOrganization;
 exports.updateOrganizationInvitation = updateOrganizationInvitation;
+exports.updateOrganizationLogo = updateOrganizationLogo;
 exports.updateOrganizationMember = updateOrganizationMember;
+exports.updateOrganizationThumbnail = updateOrganizationThumbnail;
 exports.updateProfile = updateProfile;
 exports.updateProfilePhoto = updateProfilePhoto;
 exports.updateRecipient = updateRecipient;
@@ -2960,8 +2994,6 @@ exports.updateTemplate = updateTemplate;
 exports.updateTemplateReminder = updateTemplateReminder;
 exports.updateTemplateRole = updateTemplateRole;
 exports.uploadEnvelopeFieldAttachment = uploadEnvelopeFieldAttachment;
-exports.uploadOrganizationLogo = uploadOrganizationLogo;
-exports.uploadOrganizationThumbnail = uploadOrganizationThumbnail;
 exports.userCanAct = userCanAct;
 exports.userCanBuildTemplate = userCanBuildTemplate;
 exports.userCanCancelEnvelope = userCanCancelEnvelope;