@verdocs/js-sdk 4.1.11 → 4.1.13

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);
-const acceptOrganizationInvitation = (endpoint, email, token) => endpoint.api //
-    .post('/v2/organization-invitations/accept', { email, token })
+/**
+ * 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, params) => endpoint.api //
+    .post('/v2/organization-invitations/accept', params)
     .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);