@verdocs/js-sdk 5.0.2 → 5.0.4

package/dist/index.mjs

@@ -888,7 +888,13 @@ var globalThis$1 = /*@__PURE__*/getDefaultExportFromCjs(globalThis_1);
  *
  * @group Authentication
  * @api POST /v2/oauth2/token Authenticate
- * @apiBody string(format: 'uuid') id The ID of the envelope to retrieve.
+ * @apiBody string(enum: 'client_credentials'|'refresh_token'|'password') grant_type The type of grant to request. API callers should nearly always use 'client_credentials'.
+ * @apiBody string(format: 'uuid') client_id? If grant_type is client_credentials or refresh_token, the client ID of the API key to use.
+ * @apiBody string(format: 'uuid') client_secret? If grant_type is client_credentials, the secret key of the API key to use.
+ * @apiBody string username? If grant_type is password, the username to authenticate with.
+ * @apiBody string password? If grant_type is password, the password to authenticate with.
+ * @apiBody string password? If grant_type is password, the password to authenticate with.
+ * @apiBody string scope? Optional scope to limit the auth token to. Do not specify this unless you are instructed to by a Verdocs Support rep.
  * @apiSuccess IAuthenticateResponse . The detailed metadata for the envelope requested
  */
 const authenticate = (endpoint, params) => endpoint.api //
@@ -916,6 +922,12 @@ const refreshToken = (endpoint, refreshToken) => authenticate(endpoint, { grant_
  *   window.alert(`Password reset error: ${message}`);
  * }
  * ```
+ *
+ * @group Authentication
+ * @api POST /v2/users/change-password Change the caller's password
+ * @apiBody string old_password Current password for the caller
+ * @apiBody string new_password New password to set for the caller. Must meet strength requirements.
+ * @apiSuccess string . Success
  */
 const changePassword = (endpoint, params) => endpoint.api //
     .post('/v2/users/change-password', params)
@@ -938,42 +950,59 @@ const changePassword = (endpoint, params) => endpoint.api //
  *   window.alert(`Please check your verification code and try again.`);
  * }
  * ```
+ *
+ * @group Authentication
+ * @api POST /v2/users/reset-password Reset a password for a user
+ * @apiBody string email Email address for the user account
+ * @apiBody string code? To initiate a reset request, omit this field. To complete it, provide the emailed code received by the user.
+ * @apiBody string new_password? To initiate a reset request, omit this field. To complete it, provide the new password the user wishes to use.
+ * @apiSuccess string . Success
  */
 const resetPassword = (endpoint, params) => endpoint.api //
     .post('/v2/users/reset-password', params)
     .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.
+ * Resend the email verification request if the email or token are unknown. Instead, an accessToken
+ * may be supplied through which the user will be identified. This is intended to be used in post-signup
+ * cases where the user is "partially" authenticated (has a session, but is not yet verified).
  *
  * ```typescript
  * import {resendVerification} from '@verdocs/js-sdk';
  *
  * const result = await resendVerification();
  * ```
+ *
+ * @group Authentication
+ * @api POST /v2/users/verify Resend an email verification request for a "partially" authenticated user (authenticated, but not yet verified)
+ * @apiSuccess string . Success
  */
 const resendVerification = (endpoint, accessToken) => endpoint.api //
     .post('/v2/users/resend-verification', {}, accessToken ? { headers: { Authorization: `Bearer ${accessToken}` } } : {})
     .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.
+ * Resend the email verification request if the user is unauthenticated, but the email and token are known.
+ * Used if the token is valid but has expired.
  *
  * ```typescript
  * import {resendVerification} from '@verdocs/js-sdk';
  *
  * const result = await resendVerification();
  * ```
+ *
+ * @group Authentication
+ * @api POST /v2/users/verify Resend the email verification request if both the email and token are known. Used if the token is valid but has expired.
+ * @apiSuccess IAuthenticateResponse . Updated authentication details
  */
 const verifyEmail = (endpoint, params) => endpoint.api //
     .post('/v2/users/verify', params)
     .then((r) => r.data);
+/**
+ * Get the caller's current user record.
+ *
+ * @group Authentication
+ * @api GET /v2/users/me Get the caller's user record.
+ * @apiSuccess IUser . User record
+ */
 const getMyUser = (endpoint) => endpoint.api //
     .get('/v2/users/me')
     .then((r) => r.data);
@@ -983,19 +1012,24 @@ const getNotifications = async (endpoint) => endpoint.api //
     .then((r) => r.data);
 
 /**
- * Get the user's available profiles. The current profile will be marked with `current: true`.
+ * Get the caller's available profiles. The current profile will be marked with `current: true`.
  *
  * ```typescript
  * import {getProfiles} from '@verdocs/js-sdk';
  *
  * const profiles = await getProfiles();
  * ```
+ *
+ * @group Profiles
+ * @api GET /v2/profiles Get the caller's profiles
+ * @apiDescription A user may have multiple profiles, one for each organization of which they are a member. Only one profile may be "current" at a time.
+ * @apiSuccess array(items: IProfile) . The caller's profiles
  */
 const getProfiles = (endpoint) => endpoint.api //
     .get('/v2/profiles')
     .then((r) => r.data);
 /**
- * Get the user's current profile. This is just a convenience accessor that calls `getProfiles()`
+ * Get the caller's current profile. This is just a convenience accessor that calls `getProfiles()`
  * and returns the first `current: true` entry.
  *
  * ```typescript
@@ -1017,6 +1051,10 @@ const getCurrentProfile = (endpoint) => endpoint.api //
  *
  * const newProfile = await switchProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
  * ```
+ *
+ * @group Profiles
+ * @api POST /v2/profiles/:profile_id/switch Change the "current" profile for the caller
+ * @apiSuccess IAuthenticateResponse . New authentication credentials
  */
 const switchProfile = (endpoint, profileId) => endpoint.api //
     .post(`/v2/profiles/${profileId}/switch`)
@@ -1030,6 +1068,15 @@ const switchProfile = (endpoint, profileId) => endpoint.api //
  *
  * const newProfile = await updateProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
  * ```
+ *
+ * @group Profiles
+ * @api PATCH /v2/profiles/:profile_id Update a profile
+ * @apiBody string first_name? First name
+ * @apiBody string last_name? Last name
+ * @apiBody string phone? Phone number
+ * @apiBody array(items:TPermission) permissions? New permissions to directly apply to the profile
+ * @apiBody array(items:TRole) roles? New roles to assign to the profile
+ * @apiSuccess IProfile . The updated profile
  */
 const updateProfile = (endpoint, profileId, params) => endpoint.api //
     .patch(`/v2/profiles/${profileId}`, params)
@@ -1043,12 +1090,16 @@ const updateProfile = (endpoint, profileId, params) => endpoint.api //
  *
  * await deleteProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
  * ```
+ *
+ * @group Profiles
+ * @api DELETE /v2/profiles/:profile_id Delete a profile
+ * @apiSuccess IAuthenticateResponse . New session tokens for the next available profile for the caller, or null if none.
  */
 const deleteProfile = (endpoint, profileId) => endpoint.api //
     .delete(`/v2/profiles/${profileId}`)
     .then((r) => r.data);
 /**
- * Create a new user account. Note that there are two registration paths for creation:
+ * Create a new profile. 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.
  *
@@ -1081,6 +1132,11 @@ const createProfile = (endpoint, params) => endpoint.api //
  *
  * await uploadProfilePhoto((VerdocsEndpoint.getDefault(), profileId, file);
  * ```
+ *
+ * @group Profiles
+ * @api PATCH /v2/templates/:template_id Change a profile's photo
+ * @apiBody string(format:binary) file File to upload
+ * @apiSuccess IProfile . The updated profile
  */
 const updateProfilePhoto = (endpoint, profileId, file, onUploadProgress) => {
     const formData = new FormData();
@@ -1509,8 +1565,8 @@ class VerdocsEndpoint {
  * ```
  *
  * @group Envelopes
- * @api POST /v2/envelopes Create Envelope
- * @apiBody string(format:uuid) template_id The template to base the new Envelope from
+ * @api POST /v2/envelopes Create Envelope From Template
+ * @apiBody string(format:uuid) template_id The ID of the template to copy
  * @apiBody array(items:ICreateEnvelopeRecipient) recipients A list of recipients to include in the workflow. Must specify one recipient to match each template Role.
  * @apiBody string name? Override the name of the envelope (defaults to the template name).
  * @apiBody string description? Override the description of the envelope (defaults to the template description).
@@ -1528,7 +1584,7 @@ const createEnvelope = async (endpoint, request) => endpoint.api //
  * this will return only the **metadata** the caller is allowed to view.
  *
  * @group Envelopes
- * @api GET /v2/envelopes/:id Get Envelope Details
+ * @api GET /v2/envelopes/:id Get envelope details
  * @apiParam string(format: 'uuid') id The ID of the envelope to retrieve.
  * @apiSuccess IEnvelope . The detailed metadata for the envelope requested
  */
@@ -1539,8 +1595,8 @@ const getEnvelope = async (endpoint, envelopeId) => endpoint.api //
  * Get all metadata for an envelope document. Note that when called by non-creators (e.g. Recipients)
  * this will return only the **metadata** the caller is allowed to view.
  *
- * @group Envelopes
- * @api GET /envelopes/:id Get Envelope Details
+ * @group Envelope Documents
+ * @api GET /envelopes/:id Get envelope document
  * @apiParam string(format: 'uuid') id The ID of the document to retrieve.
  * @apiSuccess IEnvelopeDocument . The detailed metadata for the document requested
  */
@@ -1551,7 +1607,7 @@ const getEnvelopeDocument = async (endpoint, envelopeId, documentId) => endpoint
  * Get a pre-signed download link for an Envelope Document. This link expires quickly, so it should
  * be accessed immediately and never shared. Content-Disposition will be set to "download".
  *
- * @group Envelopes
+ * @group Envelope Documents
  * @api GET /envelopes/:envelope_id/envelope_documents/:document_id Preview, Download, or Link to a Document
  * @apiParam string(format: 'uuid') envelope_id The ID of the envelope to retrieve.
  * @apiParam string(format: 'uuid') document_id The ID of the document to retrieve.
@@ -1699,7 +1755,7 @@ const getFieldAttachment = async (endpoint, envelopeId, fieldName) => endpoint.a
  * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants.
  *
  * @group Envelopes
- * @api GET /v2/envelope-documnets/page-image/:document_id/:variant/:page Get Document Page Display URI
+ * @api GET /v2/envelope-documnets/page-image/:document_id/:variant/:page Get envelope document page display URI
  * @apiParam string(format: 'uuid') document_id The ID of the document to retrieve.
  * @apiParam string(enum: 'original'|'filled') variant The variant of the document to retrieve.
  * @apiParam integer page The page number to retrieve
@@ -1716,7 +1772,7 @@ const getEnvelopeDocumentPageDisplayUri = async (endpoint, documentId, page, var
  * ```
  *
  * @group Envelopes
- * @api GET /v2/envelopes List Envelopes
+ * @api GET /v2/envelopes List envelopes
  * @apiQuery string q? Match envelopes whose name contains this string
  * @apiQuery string(enum: 'inbox' | 'sent' | 'action' | 'waiting' | 'completed') view? Request pre-defined view. `inbox` returns envelopes where action is required by the caller. `sent` returns envelopes created by the caller. `action` returns envelopes where action is required by the caller. `waiting` returns envelopes where action is required by anyone. `completed` returns envelopes where all actions are complete.
  * @apiQuery array(items: 'complete' | 'pending' | 'in progress' | 'declined' | 'canceled') status? Match envelopes in one of the specified states.
@@ -2036,6 +2092,10 @@ const deleteSignature = (endpoint, signatureId) => endpoint.api //
  *
  * const keys = await getApiKeys(ORGID);
  * ```
+ *
+ * @group API Keys
+ * @api GET /v2/api-keys Get API keys
+ * @apiSuccess array(items: IApiKey) . A list of the API keys for the caller's organization. Secrets will not be included.
  */
 const getApiKeys = (endpoint) => endpoint.api //
     .get(`/v2/api-keys`)
@@ -2048,6 +2108,13 @@ const getApiKeys = (endpoint) => endpoint.api //
  *
  * await createApiKey(ORGID, {name: NEWNAME});
  * ```
+ *
+ * @group API Keys
+ * @api POST /v2/api-keys Create API key
+ * @apiBody string name A name used to identify the key in the Verdocs Web App
+ * @apiBody string(format:uuid) profile_id The profile ID that calls made using the key will act as
+ * @apiBody array(items:string) permission An array of permissions to assign to the new key. Extends (but does not override) the API key's profile permissions.
+ * @apiSuccess IApiKey . The newly-created API key, including its secret.
  */
 const createApiKey = (endpoint, params) => endpoint.api //
     .post('/v2/api-keys', params)
@@ -2060,6 +2127,11 @@ const createApiKey = (endpoint, params) => endpoint.api //
  *
  * const {client_secret: newSecret} = await rotateApiKey(ORGID, CLIENTID);
  * ```
+ *
+ * @group API Keys
+ * @api POST /v2/api-keys/:client_id/rotate Rotate API key
+ * @apiParam string(format:uuid) client_id The client ID of the key to rotate
+ * @apiSuccess IApiKey . The updated API key with its new secret.
  */
 const rotateApiKey = (endpoint, clientId) => endpoint.api //
     .post(`/v2/api-keys/${clientId}/rotate`)
@@ -2072,6 +2144,12 @@ const rotateApiKey = (endpoint, clientId) => endpoint.api //
  *
  * await updateApiKey(ORGID, CLIENTID, {name: NEWNAME});
  * ```
+ *
+ * @group API Keys
+ * @api PATCH /v2/api-keys/:client_id Update API key
+ * @apiBody string name? New name for the API key
+ * @apiBody array(items:string) permission New array of permissions to assign to the new key. Extends (but does not override) the API key's profile permissions.
+ * @apiSuccess IApiKey . The updated API key. The secret will not be included.
  */
 const updateApiKey = (endpoint, clientId, params) => endpoint.api //
     .patch(`/v2/api-keys/${clientId}`, params)
@@ -2084,6 +2162,10 @@ const updateApiKey = (endpoint, clientId, params) => endpoint.api //
  *
  * await deleteApiKey(ORGID, CLIENTID);
  * ```
+ *
+ * @group API Keys
+ * @api DELETE /v2/api-keys/:client_id Delete API key
+ * @apiSuccess string . Success.
  */
 const deleteApiKey = (endpoint, clientId) => endpoint.api //
     .delete(`/v2/api-keys/${clientId}`)
@@ -2103,19 +2185,30 @@ const deleteApiKey = (endpoint, clientId) => endpoint.api //
  *
  * const members = await getOrganizationContacts(VerdocsEndpoint.getDefault()});
  * ```
+ *
+ * @group Organization Contacts
+ * @api GET /v2/organization-contacts Get a list of organization contacts
+ * @apiBody string email Email address for the invitee
+ * @apiBody string token Invite token for the invitee
+ * @apiSuccess string . Success. The invitation will be marked declined and the token will be invalidated.
  */
 const getOrganizationContacts = (endpoint) => endpoint.api //
     .get(`/v2/organization-contacts`)
     .then((r) => r.data);
 /**
- * Delete a contact from the caller's organization. Note that the caller must be an admin or owner,
- * may not delete him/herself.
+ * Delete a contact from the caller's organization. Note that the caller must be an admin or owner.
  *
  * ```typescript
  * import {deleteOrganizationContact} from '@verdocs/js-sdk';
  *
  * await deleteOrganizationContact(VerdocsEndpoint.getDefault(), 'PROFILEID'});
  * ```
+ *
+ * @group Organization Contacts
+ * @api POST /v2/organization-invitations/decline GET a list of pending invitations
+ * @apiBody string email Email address for the invitee
+ * @apiBody string token Invite token for the invitee
+ * @apiSuccess string . Success. The invitation will be marked declined and the token will be invalidated.
  */
 const deleteOrganizationContact = (endpoint, profileId) => endpoint.api //
     .delete(`/v2/organization-contacts/${profileId}`)
@@ -2247,12 +2340,27 @@ const deleteGroupMember = (endpoint, groupId, profile_id) => endpoint.api //
  */
 /**
  * Get a list of invitations pending for the caller's organization. The caller must be an admin or owner.
+ *
+ * @group Organization Invitations
+ * @api GET /v2/organization-invitations Get a list of pending invitations
+ * @apiBody array(items:TRole) roles URL to send Webhook events to. An empty or invalid URL will disable Webhook calls.
+ * @apiBody string first_name First name. The user may override this after accepting the invitation.
+ * @apiBody string last_name Last name. The user may override this after accepting the invitation.
+ * @apiSuccess array(items:IProfile) . List of caller's current organization's members
  */
 const getOrganizationInvitations = (endpoint) => endpoint.api //
     .get(`/v2/organization-invitations`)
     .then((r) => r.data);
 /**
  * Invite a new user to join the organization.
+ *
+ * @group Organization Invitations
+ * @api POST /v2/organization-invitations Invite a new user to join the organization
+ * @apiBody string email Email address to send the invitation to
+ * @apiBody string first_name First name. The user may override this after accepting the invitation.
+ * @apiBody string last_name Last name. The user may override this after accepting the invitation.
+ * @apiBody TRole role Initial role to assign to the user once they accept.
+ * @apiSuccess IOrganizationInvitation . The newly-created invitation.
  */
 const createOrganizationInvitation = (endpoint, params) => endpoint.api //
     .post(`/v2/organization-invitations`, params)
@@ -2261,6 +2369,10 @@ const createOrganizationInvitation = (endpoint, params) => endpoint.api //
  * 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.
+ *
+ * @group Organization Invitations
+ * @api DELETE /v2/organization-invitations/:email Delete a pending invitation
+ * @apiSuccess string . Success
  */
 const deleteOrganizationInvitation = (endpoint, email) => endpoint.api //
     .delete(`/v2/organization-invitations/${email}`)
@@ -2268,12 +2380,24 @@ const deleteOrganizationInvitation = (endpoint, email) => endpoint.api //
 /**
  * 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.
+ *
+ * @group Organization Invitations
+ * @api PATCH /v2/organization-invitations/:email Update a pending invitation
+ * @apiBody string first_name First name. The user may override this after accepting the invitation.
+ * @apiBody string last_name Last name. The user may override this after accepting the invitation.
+ * @apiBody TRole role Initial role to assign to the user once they accept.
+ * @apiSuccess IOrganizationInvitation . The updated invitation.
  */
 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.
+ *
+ * @group Organization Invitations
+ * @api POST /v2/organization-invitations/resend Send a reminder to a pending invitee
+ * @apiBody string email The recipient to send the reminder to
+ * @apiSuccess IOrganizationInvitation . The updated invitation
  */
 const resendOrganizationInvitation = (endpoint, email) => endpoint.api //
     .post('/v2/organization-invitations/resend', { email })
@@ -2282,15 +2406,28 @@ const resendOrganizationInvitation = (endpoint, email) => endpoint.api //
  * 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.
+ *
+ * @group Organization Invitations
+ * @api GET /v2/organization-invitations/:email/:token Get a pending invitation (_Authenticated via invite token, not an active session._). Intended to be called by the invitee to get details about the invitation they are about to accept.
+ * @apiSuccess IOrganizationInvitation . Requested invitation's details. Will always include summary details for the organization, to be used for branding the accept-invite view.
  */
 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
+ * Accept an invitation. This will automatically create a user record 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.
+ *
+ * @group Organization Invitations
+ * @api POST /v2/organization-invitations/accept Accept an invitation
+ * @apiBody string email Email address for the invitee
+ * @apiBody string token Invite token for the invitee
+ * @apiBody string first_name First name
+ * @apiBody string last_name Last name
+ * @apiBody string password Password
+ * @apiSuccess IAuthenticateResponse . Session credentials for the newly-created user's profile. If the user already had a profile for another organization, the new profile will be made "current" automatically.
  */
 const acceptOrganizationInvitation = (endpoint, params) => endpoint.api //
     .post('/v2/organization-invitations/accept', params)
@@ -2299,6 +2436,13 @@ const acceptOrganizationInvitation = (endpoint, params) => endpoint.api //
  * 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.
+ *
+ * @group Organization Invitations
+ * @api POST /v2/organization-invitations/decline Decline an invitation
+ * @apiDescription 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.
+ * @apiBody string email Email address for the invitee
+ * @apiBody string token Invite token for the invitee
+ * @apiSuccess string . Success. The invitation will be marked declined and the token will be invalidated.
  */
 const declineOrganizationInvitation = (endpoint, email, token) => endpoint.api //
     .post('/v2/organization-invitations/decline', { email, token })
@@ -2317,6 +2461,10 @@ const declineOrganizationInvitation = (endpoint, email, token) => endpoint.api /
  *
  * const members = await getOrganizationMembers(VerdocsEndpoint.getDefault()});
  * ```
+ *
+ * @group Organization Members
+ * @api GET /v2/organization-members List current organization's members
+ * @apiSuccess array(items:IProfile) . List of caller's current organization's members
  */
 const getOrganizationMembers = (endpoint) => endpoint.api //
     .get(`/v2/organization-members`)
@@ -2330,6 +2478,10 @@ const getOrganizationMembers = (endpoint) => endpoint.api //
  *
  * await deleteOrganizationMember(VerdocsEndpoint.getDefault(), 'PROFILEID'});
  * ```
+ *
+ * @group Organization Members
+ * @api DELETE /v2/organization-members/:profile_id Delete a member from the organization
+ * @apiSuccess string . Success
  */
 const deleteOrganizationMember = (endpoint, profileId) => endpoint.api //
     .delete(`/v2/organization-members/${profileId}`)
@@ -2342,6 +2494,13 @@ const deleteOrganizationMember = (endpoint, profileId) => endpoint.api //
  *
  * const result = await updateOrganizationMember(VerdocsEndpoint.getDefault(), 'PROFILEID', {roles:['member']});
  * ```
+ *
+ * @group Organization Members
+ * @api PATCH /v2/organization-members/:profile_id Update an organization member.
+ * @apiBody array(items:TRole) roles URL to send Webhook events to. An empty or invalid URL will disable Webhook calls.
+ * @apiBody string first_name Set to true to enable Webhooks calls.
+ * @apiBody string last_name Record<TWebhookEvent, boolean> map of events to enable/disable.
+ * @apiSuccess array(items:IProfile) . List of caller's current organization's members
  */
 const updateOrganizationMember = (endpoint, profileId, params) => endpoint.api //
     .patch(`/v2/organization-members/${profileId}`, params)
@@ -2369,6 +2528,10 @@ const updateOrganizationMember = (endpoint, profileId, params) => endpoint.api /
  *
  * const organizations = await getOrganization(VerdocsEndpoint.getDefault(), 'ORGID');
  * ```
+ *
+ * @group Organizations
+ * @api GET /v2/organizations/:organization_id Get organization
+ * @apiSuccess IOrganization . The requested organization. The caller must be a member.
  */
 const getOrganization = (endpoint, organizationId) => endpoint.api //
     .get(`/v2/organizations/${organizationId}`)
@@ -2383,6 +2546,18 @@ const getOrganization = (endpoint, organizationId) => endpoint.api //
  *
  * const organization = await createOrganization(VerdocsEndpoint.getDefault(), {name: 'NewOrg'});
  * ```
+ *
+ * @group Organizations
+ * @api POST /v2/organizations Create organization
+ * @apiDescription The caller will be assigned an "Owner" profile in the new organization, and it will be set to "current" automatically. A new set of session tokens will be issued to  the caller, and the caller should update their endpoint to use the new tokens.
+ * @apiBody string name The name of the new organization
+ * @apiBody string contact_email? Contact email for the new organization
+ * @apiBody string url? URL for the new organization
+ * @apiBody string full_logo_url? URL of a large-format PNG logo
+ * @apiBody string thumbnail_url? URL of a small-format (square is recommended) PNG logo
+ * @apiBody string primary_color? URL of a small-format (square is recommended) PNG logo
+ * @apiBody string secondary_color? URL of a small-format (square is recommended) PNG logo
+ * @apiSuccess IAuthenticateResponse . Authentication credentials for user in the new organization. The user will be made an Owner automatically.
  */
 const createOrganization = (endpoint, params) => endpoint.api //
     .post(`/v2/organizations`, params)
@@ -2395,6 +2570,17 @@ const createOrganization = (endpoint, params) => endpoint.api //
  *
  * const organizations = await updateOrganization(VerdocsEndpoint.getDefault(), organizationId, {name:'ORGNAME'});
  * ```
+ *
+ * @group Organizations
+ * @api PATCH /v2/organizations/:organization_id Update organization
+ * @apiBody string name The name of the new organization
+ * @apiBody string contact_email? Contact email for the new organization
+ * @apiBody string url? URL for the new organization
+ * @apiBody string full_logo_url? URL of a large-format PNG logo
+ * @apiBody string thumbnail_url? URL of a small-format (square is recommended) PNG logo
+ * @apiBody string primary_color? URL of a small-format (square is recommended) PNG logo
+ * @apiBody string secondary_color? URL of a small-format (square is recommended) PNG logo
+ * @apiSuccess IOrganization . The details for the updated organization
  */
 const updateOrganization = (endpoint, organizationId, params) => endpoint.api //
     .patch(`/v2/organizations/${organizationId}`, params)
@@ -2408,18 +2594,28 @@ const updateOrganization = (endpoint, organizationId, params) => endpoint.api //
  *
  * const newSession = await deleteOrganization(VerdocsEndpoint.getDefault(), organizationId);
  * ```
+ *
+ * @group Organizations
+ * @api DELETE /v2/organizations/:organization_id Delete organization
+ * @apiSuccess IAuthenticateResponse . If the caller is a member of another organization, authentication credentials for the next organization available. If not, this will be null and the caller will be logged out.
  */
 const deleteOrganization = (endpoint, organizationId) => endpoint.api //
     .delete(`/v2/organizations/${organizationId}`)
     .then((r) => r.data);
 /**
- * Update the organization's logo. This can only be called by an admin or owner.
+ * Update the organization's full or thumbnail logo. This can only be called by an admin or owner.
  *
  * ```typescript
  * import {updateOrganizationLogo} from '@verdocs/js-sdk';
  *
  * await updateOrganizationLogo((VerdocsEndpoint.getDefault(), organizationId, file);
  * ```
+ *
+ * @group Organizations
+ * @api PATCH /v2/organizations/:organization_id Update organization full or thumbnail logo.
+ * @apiBody image/png logo? Form-url-encoded file to upload
+ * @apiBody image/png thumbnail? Form-url-encoded file to upload
+ * @apiSuccess IOrganization . The updated organization.
  */
 const updateOrganizationLogo = (endpoint, organizationId, file, onUploadProgress) => {
     const formData = new FormData();
@@ -2473,6 +2669,10 @@ const updateOrganizationThumbnail = (endpoint, organizationId, file, onUploadPro
  *
  * await getWebhooks(ORGID, params);
  * ```
+ *
+ * @group Webhooks
+ * @api GET /v2/webhooks Get organization Webhooks config
+ * @apiSuccess IWebhook . The current Webhooks config for the caller's organization.
  */
 const getWebhooks = (endpoint) => endpoint.api //
     .get(`/v2/webhooks`)
@@ -2487,6 +2687,14 @@ const getWebhooks = (endpoint) => endpoint.api //
  *
  * await setWebhooks(ORGID, params);
  * ```
+ *
+ * @group Webhooks
+ * @api PATCH /v2/webhooks Update organization Webhooks config
+ * @apiDescription Note that Webhooks cannot currently be deleted, but may be easily disabled by setting `active` to `false` and/or setting the `url` to an empty string.
+ * @apiBody string url URL to send Webhook events to. An empty or invalid URL will disable Webhook calls.
+ * @apiBody boolean active Set to true to enable Webhooks calls.
+ * @apiBody object events Record<TWebhookEvent, boolean> map of events to enable/disable.
+ * @apiSuccess IWebhook . The updated Webhooks config for the caller's organization.
  */
 const setWebhooks = (endpoint, params) => endpoint.api //
     .patch(`/v2/webhooks`, params)
@@ -2671,6 +2879,25 @@ const hasRequiredPermissions = (profile, permissions) => permissions.every((perm
  *
  * await createField((VerdocsEndpoint.getDefault(), template_id, { ... });
  * ```
+ *
+ * @group Fields
+ * @api POST /v2/fields/:template_id Add a field to a template
+ * @apiBody string name Name for the new field. Field names must be unique within a template. Although special characters are allowed, they must be URL-encoded in subsequent requests, so it is recommended to use only alphanumeric characters and hyphens if possible.
+ * @apiBody string role_name Role to assign to the field. Role names must be valid, so it is recommended to create roles before fields.
+ * @apiBody string document_id ID of the document upon which to place the field.
+ * @apiBody string(enum: 'signature' | 'initial' | 'checkbox' | 'radio' | 'textbox' | 'timestamp' | 'date' | 'dropdown' | 'textarea' | 'attachment' | 'payment') type Type of field to create
+ * @apiBody boolean(default: false) required Whether the field is required
+ * @apiBody integer(min: 0) page 0-based page number upon which to place the field
+ * @apiBody integer(min: 0) x X position for the field (left to right)
+ * @apiBody integer(min: 0) y Y position for the field (_bottom to top!_)
+ * @apiBody string label? Optional label to display above the field
+ * @apiBody integer(min: 50) width? Width of the field. Note that all fields have built-in defaults, and it is recommended that this only be set on text fields.
+ * @apiBody integer(min: 15) height? Height of the field. Note that all fields have built-in defaults, and it is recommended that this only be set on text fields.
+ * @apiBody string placeholder? Optional placeholder to display in text fields
+ * @apiBody string group? For fields that support grouping (radio buttons and check boxes) the value selected will be stored under this name
+ * @apiBody array(items:IDropdownOption) options? For dropdown fields, the options to display
+ * @apiBody string value? Optional default value to set on the field
+ * @apiSuccess ITemplateField . Template field
  */
 const createField = (endpoint, templateId, params) => endpoint.api //
     .post(`/v2/fields/${templateId}`, params)
@@ -2683,6 +2910,25 @@ const createField = (endpoint, templateId, params) => endpoint.api //
  *
  * await updateField((VerdocsEndpoint.getDefault(), template_id, field_name, { ... });
  * ```
+ *
+ * @group Fields
+ * @api PATCH /v2/fields/:template_id/:field_name Update a field. See createField for additional details on the supported parameters.
+ * @apiBody string name? Rename the field. Note that template field names must be unique within a template.
+ * @apiBody string role_name Role to assign to the field.
+ * @apiBody string document_id ID of the document upon which to place the field.
+ * @apiBody string(enum: 'signature' | 'initial' | 'checkbox' | 'radio' | 'textbox' | 'timestamp' | 'date' | 'dropdown' | 'textarea' | 'attachment' | 'payment') type? Change the field type. Note that while this is technically allowed, fields have different behaviors, validators, default sizes, etc. It is usually easier to add a new field and delete the old one.
+ * @apiBody boolean(default: false) required? Whether the field is required
+ * @apiBody integer(min: 0) page? 0-based page number upon which to place the field
+ * @apiBody integer(min: 0) x? X position for the field (left to right)
+ * @apiBody integer(min: 0) y? Y position for the field (_bottom to top!_)
+ * @apiBody string label? Optional label to display above the field
+ * @apiBody integer(min: 50) width? Width of the field. Note that all fields have built-in defaults, and it is recommended that this only be set on text fields.
+ * @apiBody integer(min: 15) height? Height of the field. Note that all fields have built-in defaults, and it is recommended that this only be set on text fields.
+ * @apiBody string placeholder? Optional placeholder to display in text fields
+ * @apiBody string group? For fields that support grouping (radio buttons and check boxes) the value selected will be stored under this name
+ * @apiBody array(items:IDropdownOption) options? For dropdown fields, the options to display
+ * @apiBody string value? Optional default value to set on the field
+ * @apiSuccess ITemplateField . Updated template field
  */
 const updateField = (endpoint, templateId, name, params) => endpoint.api //
     .patch(`/v2/fields/${templateId}/${encodeURIComponent(name)}`, params)
@@ -2695,6 +2941,10 @@ const updateField = (endpoint, templateId, name, params) => endpoint.api //
  *
  * await deleteField((VerdocsEndpoint.getDefault(), template_id, field_name);
  * ```
+ *
+ * @group Fields
+ * @api DELETE /v2/fields/:template_id/:field_name Delete a field
+ * @apiSuccess string . Success
  */
 const deleteField = (endpoint, templateId, name) => endpoint.api //
     .delete(`/v2/fields/${templateId}/${encodeURIComponent(name)}`)
@@ -2820,6 +3070,20 @@ const userCanPreviewTemplate = (profile, template) => {
  *
  * const role = await createTemplateRole(VerdocsEndpoint.getDefault(), template_id, params...);
  * ```
+ *
+ * @group Roles
+ * @api POST /v2/roles/:template_id Add a role to a template
+ * @apiBody string name Name for the new role. Must be unique within the template. May include spaces, but later calls must URL-encode any references to this role, so it is recomended that special characters be avoided.
+ * @apiBody string(enum:'signer' | 'cc' | 'approver') type Type of role to create. Signers act on documents by filling and signing fields. CC recipients receive a copy but do not act on the document. Approvers control the final submission of a document, but do not have fields of their own to fill out.
+ * @apiBody string full_name? Default full name for the role. May be completed/overridden later, when envelopes are made from the template.
+ * @apiBody string email? Default email address for the role. May be completed/overridden later, when envelopes are made from the template.
+ * @apiBody string phone? Default (SMS-capable) phone number for the role. May be completed/overridden later, when envelopes are made from the template.
+ * @apiBody string message? Optional message to include in email and SMS signing invitations.
+ * @apiBody integer(min: 1, default: 1) sequence? Optional 1-based sequence number for the role. Roles that share the same sequence number act in parallel, and will receive invitations at the same time.
+ * @apiBody integer(min: 1, default: 1) order? Optional 1-based order number for the role. Controls the left-to-right display order of roles at the same sequence number in the UI components e.g. `<verdocs-template-roles />`.
+ * @apiBody boolean delegator? If true, the role may delegate their signing responsibility to another party.
+ * @apiBody string(enum:'pin'|'identity'|'') kba_method? Active PIN- or Identity-based KBA for the role. NOTE: Some KBA operations may incur additional fees.
+ * @apiSuccess IRole . The newly-created role
  */
 const createTemplateRole = (endpoint, template_id, params) => endpoint.api //
     .post(`/v2/roles/${template_id}`, params)
@@ -2832,6 +3096,20 @@ const createTemplateRole = (endpoint, template_id, params) => endpoint.api //
  *
  * const role = await updateTemplateRole(VerdocsEndpoint.getDefault(), template_id, name, params...);
  * ```
+ *
+ * @group Roles
+ * @api PATCH /v2/roles/:template_id/:role_id Update a role. See createRole for additional details on the parameters available.
+ * @apiBody string name? Rename the role. Note that role names must be unique within a template, so this may fail if the new name is already in use.
+ * @apiBody string(enum:'signer' | 'cc' | 'approver') type? Type of role.
+ * @apiBody string full_name? Default full name for the role.
+ * @apiBody string email? Default email address for the role.
+ * @apiBody string phone? Default (SMS-capable) phone number for the role.
+ * @apiBody string message? Optional message to include in email and SMS signing invitations.
+ * @apiBody integer(min: 1, default: 1) sequence? Optional 1-based sequence number for the role.
+ * @apiBody integer(min: 1, default: 1) order? Optional 1-based order number for the role.
+ * @apiBody boolean delegator? If true, the role may delegate their signing responsibility to another party.
+ * @apiBody string(enum:'pin'|'identity'|'') kba_method? Active PIN- or Identity-based KBA for the role.
+ * @apiSuccess IRole . The newly-created role
  */
 const updateTemplateRole = (endpoint, template_id, name, params) => endpoint.api //
     .patch(`/v2/roles/${template_id}/${encodeURIComponent(name)}`, params)
@@ -2844,6 +3122,10 @@ const updateTemplateRole = (endpoint, template_id, name, params) => endpoint.api
  *
  * const profiles = await deleteTemplateRole(VerdocsEndpoint.getDefault(), template_id, name);
  * ```
+ *
+ * @group Roles
+ * @api DELETE /v2/roles/:template_id/:role_id Delete a role.
+ * @apiSuccess string . Success
  */
 const deleteTemplateRole = (endpoint, template_id, name) => endpoint.api //
     .delete(`/v2/roles/${template_id}/${encodeURIComponent(name)}`)
@@ -2950,6 +3232,10 @@ const getTemplates = (endpoint, params) => endpoint.api //
  *
  * const template = await getTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
  * ```
+ *
+ * @group Templates
+ * @api GET /v2/templates/:template_id Get a template. Note that the caller must have at least View access to the template.
+ * @apiSuccess ITemplate . The requested template
  */
 const getTemplate = (endpoint, templateId) => {
     window?.console?.log('[JS_SDK] Loading template', templateId);
@@ -2996,6 +3282,21 @@ const ALLOWED_CREATE_FIELDS = [
  *
  * const newTemplate = await createTemplate((VerdocsEndpoint.getDefault(), {...});
  * ```
+ *
+ * @group Templates
+ * @api POST /v2/templates Create a template
+ * @apiBody string name Template name
+ * @apiBody string description? Optional description
+ * @apiBody TTemplateVisibility visibility? Visibility setting
+ * @apiBody boolean is_personal? Deprecated. If true, the template is personal and can only be seen by the caller. (Use "visibility" for new calls.)
+ * @apiBody boolean is_public? Deprecated. If true, the template is public and can be seen by anybody. (Use "visibility" for new calls.)
+ * @apiBody TTemplateSender sender? Who may send envelopes using this template
+ * @apiBody number initial_reminder? Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable.
+ * @apiBody number followup_reminders? Delay (in seconds) before the subsequent reminders are sent (min: 12hrs). Set to 0 or null to disable.
+ * @apiBody array(items:object) documents? Optional list of documents to attach to the template
+ * @apiBody array(items:IRole) roles? Optional list of roles to create. Note that if roles are not included in the request, fields will be ignored.
+ * @apiBody array(fields:ITemplateField) fields? Optional list of fields to create. Note that if fields that do not match a role will be ignored.
+ * @apiSuccess ITemplate . The newly-created template
  */
 const createTemplate = (endpoint, params, onUploadProgress) => {
     const options = {
@@ -3031,6 +3332,12 @@ const createTemplate = (endpoint, params, onUploadProgress) => {
  *
  * const newTemplate = await duplicateTemplate((VerdocsEndpoint.getDefault(), originalTemplateId, 'My Template Copy');
  * ```
+ *
+ * @group Templates
+ * @api PUT /v2/templates/:template_id Perform an operation on a template
+ * @apiBody string(enum:'duplicate') action Action to perform
+ * @apiBody string name? If duplicating the template, a name for the new copy
+ * @apiSuccess ITemplate . The newly-copied template
  */
 const duplicateTemplate = (endpoint, templateId, name) => endpoint.api //
     .put(`/v2/templates/${templateId}`, { action: 'duplicate', name })
@@ -3043,6 +3350,14 @@ const duplicateTemplate = (endpoint, templateId, name) => endpoint.api //
  *
  * const newTemplate = await createTemplateFromSharepoint((VerdocsEndpoint.getDefault(), {...});
  * ```
+ *
+ * @group Templates
+ * @api POST /v2/templates/from-sharepoint Create a template from an asset in Sharepoint
+ * @apiBody string name Name for the new template
+ * @apiBody string siteId Name for the new template
+ * @apiBody string itemId Name for the new template
+ * @apiBody string oboToken On-Behalf-Of token for calls to Sharepoint. Should be generated as a short-expiration token with at least Read privileges to the siteId/itemId. This token will be discarded after being used.
+ * @apiSuccess ITemplate . The newly-created template
  */
 const createTemplateFromSharepoint = (endpoint, params) => {
     const options = {
@@ -3058,6 +3373,18 @@ const createTemplateFromSharepoint = (endpoint, params) => {
  *
  * const updatedTemplate = await updateTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9', { name: 'New Name' });
  * ```
+ *
+ * @group Templates
+ * @api PATCH /v2/templates/:template_id Update a template
+ * @apiBody string name? Template name
+ * @apiBody string description? Optional description
+ * @apiBody TTemplateVisibility visibility? Visibility setting
+ * @apiBody boolean is_personal? Deprecated. If true, the template is personal and can only be seen by the caller. (Use "visibility" for new calls.)
+ * @apiBody boolean is_public? Deprecated. If true, the template is public and can be seen by anybody. (Use "visibility" for new calls.)
+ * @apiBody TTemplateSender sender? Who may send envelopes using this template
+ * @apiBody number initial_reminder? Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable.
+ * @apiBody number followup_reminders? Delay (in seconds) before the subsequent reminders are sent (min: 12hrs). Set to 0 or null to disable.
+ * @apiSuccess ITemplate . The updated template
  */
 const updateTemplate = (endpoint, templateId, params) => endpoint.api //
     .patch(`/v2/templates/${templateId}`, params)
@@ -3070,6 +3397,10 @@ const updateTemplate = (endpoint, templateId, params) => endpoint.api //
  *
  * await deleteTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
  * ```
+ *
+ * @group Templates
+ * @api DELETE /v2/templates/:template_id Delete a template
+ * @apiSuccess string . Success
  */
 const deleteTemplate = (endpoint, templateId) => endpoint.api //
     .delete(`/v2/templates/${templateId}`)
@@ -3088,6 +3419,10 @@ const deleteTemplate = (endpoint, templateId) => endpoint.api //
  *
  * await TemplateDocument.geTemplateDocuments((VerdocsEndpoint.getDefault(), templateId);
  * ```
+ *
+ * @group Template Documents
+ * @api GET /v2/templates/:template_id/documents List the documents assigned to a template
+ * @apiSuccess array(items: ITemplateDocument) . Template documents
  */
 const getTemplateDocuments = (endpoint, templateId) => endpoint.api //
     .get(`/templates/${templateId}/documents/`)
@@ -3100,6 +3435,10 @@ const getTemplateDocuments = (endpoint, templateId) => endpoint.api //
  *
  * await TemplateDocument.geTemplateDocument((VerdocsEndpoint.getDefault(), templateId,documentId);
  * ```
+ *
+ * @group Template Documents
+ * @api GET /v2/templates/:template_id/documents/:document_id Get an individual template document
+ * @apiSuccess ITemplateDocument . Template document
  */
 const getTemplateDocument = (endpoint, templateId, documentId) => endpoint.api //
     .get(`/templates/${templateId}/documents/${documentId}`)
@@ -3112,6 +3451,11 @@ const getTemplateDocument = (endpoint, templateId, documentId) => endpoint.api /
  *
  * await TemplateDocument.createDocument((VerdocsEndpoint.getDefault(), templateID, params);
  * ```
+ *
+ * @group Template Documents
+ * @api POST /v2/templates/:template_id/documents Attach a document to a template
+ * @apiBody string(format:binary) file Document file to attach. The file name will automatically be used as the document name.
+ * @apiSuccess ITemplateDocument . Template document
  */
 const createTemplateDocument = (endpoint, templateId, file, onUploadProgress) => {
     const formData = new FormData();
@@ -3135,6 +3479,10 @@ const createTemplateDocument = (endpoint, templateId, file, onUploadProgress) =>
  *
  * await TemplateDocument.deleteDocument((VerdocsEndpoint.getDefault(), templateID, documentID);
  * ```
+ *
+ * @group Template Documents
+ * @api DELETE /v2/templates/:temlate_id/documents/:document_id Delete a template document
+ * @apiSuccess string . Success
  */
 const deleteTemplateDocument = (endpoint, templateId, documentId) => endpoint.api //
     .delete(`/templates/${templateId}/documents/${documentId}`)