@verdocs/js-sdk 6.6.0 → 6.6.2

package/dist/index.mjs

@@ -1527,6 +1527,9 @@ class VerdocsEndpoint {
     }
 }
 
+// TODO: We need to re-review all of the models and input types/docs to be sure they match the latest
+//  API work.
+// INIT
 /**
  * Create an envelope
  *
@@ -3444,6 +3447,7 @@ const getOrganizationMembers = (endpoint) => endpoint.api //
  * ```
  *
  * @group Organization Members
+ * @apiParam string(format:uuid) profile_id The Profile ID to remove.
  * @api DELETE /v2/organization-members/:profile_id Delete a member from the organization
  * @apiSuccess string . Success
  */
@@ -3451,7 +3455,7 @@ const deleteOrganizationMember = (endpoint, profileId) => endpoint.api //
     .delete(`/v2/organization-members/${profileId}`)
     .then((r) => r.data);
 /**
- * Update a member.
+ * Update an organization member.
  *
  * ```typescript
  * import {updateOrganizationMember} from '@verdocs/js-sdk';
@@ -3461,10 +3465,11 @@ const deleteOrganizationMember = (endpoint, profileId) => endpoint.api //
  *
  * @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
+ * @apiParam string(format:uuid) profile_id The Profile ID to update.
+ * @apiBody string first_name? First name for the member
+ * @apiBody string last_name? Last name for the member
+ * @apiBody array(items:TRole) roles? Roles (e.g. "member" or "admin") to assign to the user.
+ * @apiSuccess IProfile . The updated profile for the member.
  */
 const updateOrganizationMember = (endpoint, profileId, params) => endpoint.api //
     .patch(`/v2/organization-members/${profileId}`, params)
@@ -3699,7 +3704,8 @@ const getActiveEntitlements = async (endpoint) => {
  * @module
  */
 /**
- * Get the registered Webhook configuration for the caller's organization.
+ * Get the registered Webhook configuration for the caller's organization. Note that an organization
+ * may only have a single Webhook configuration.
  *
  * ```typescript
  * import {getWebhooks} from '@verdocs/js-sdk';
@@ -3730,6 +3736,11 @@ const getWebhooks = (endpoint) => endpoint.api //
  * @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 string(enum:'none'|'hmac'|'client_credentials') auth_method? Enable HMAC or Client Credentials authentication for Webhooks calls.
+ * @apiBody string token_endpoint? Required if `auth_method` is set to `client_credentials`. Token endpoint to use for authenticating Webhooks calls.
+ * @apiBody string client_id? Required if `auth_method` is set to `client_credentials`. Client ID to use for authenticating Webhooks calls.
+ * @apiBody string client_secret? Required if `auth_method` is set to `client_credentials`. Client secret to use for authenticating Webhooks calls.
+ * @apiBody string scope? Optional scope to include in authentication calls if `auth_method` is set to `client_credentials`.
  * @apiBody object events Record<TWebhookEvent, boolean> map of events to enable/disable.
  * @apiSuccess IWebhook . The updated Webhooks config for the caller's organization.
  */