visualvault-api 2.0.0-beta.3 → 2.1.0-beta.1

package/dist/VVRestApi.cjs

@@ -607,15 +607,43 @@ var common_default = {
 // lib/docApi/documentManager.js
 init_cjs_shims();
 var DocumentManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Creates a new document.
+   * @param {object} data - The document creation payload.
+   * @param {string} data.folderId - (Required) The Guid of the folder to create the document in.
+   * @param {string} [data.name] - The document name.
+   * @param {string} [data.revision] - The revision label.
+   * @param {string} [data.documentState] - The document state.
+   * @param {string} [data.fileName] - The file name of the attached file.
+   * @param {string} [data.contentType] - The MIME type of the attached file.
+   * @param {number[]|Uint8Array} [data.fileBytes] - The file content as a byte array.
+   * @param {number} [data.fileLength] - The byte length of the file.
+   * @param {Array<{key: string, value: string}>} [data.indexFields] - Index field key/value pairs.
+   * @param {string} [data.docType] - The document type.
+   * @param {number} [data.confidence] - OCR confidence score (decimal).
+   * @param {string} [data.description] - Document description.
+   * @param {string} [data.keywords] - Document keywords.
+   * @param {string} [data.abstract] - Document abstract.
+   * @param {string} [data.changeText] - Change description for this revision.
+   * @returns {Promise<string>} The API response containing the created document details.
+   */
   async createDocument(data) {
     const resourceUri = this._httpHelper._config.ResourceUri.DocApi.CreateDocument;
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "POST" };
     return this._httpHelper.doVvClientRequest(url, opts, null, data);
   }
+  /**
+   * Retrieves a specific document revision by its ID.
+   * @param {string} documentRevisionId - The ID (Guid) of the document revision to retrieve.
+   * @returns {Promise<string>} The API response containing the document revision details.
+   */
   async GetRevision(documentRevisionId) {
     let resourceUri = this._httpHelper._config.ResourceUri.DocApi.GetRevision;
     resourceUri = resourceUri.replace("{id}", documentRevisionId);
@@ -623,6 +651,11 @@ var DocumentManager = class {
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, null, null);
   }
+  /**
+   * Retrieves the OCR processing status for a document revision.
+   * @param {string} documentRevisionId - The ID (Guid) of the document revision to check.
+   * @returns {Promise<string>} The API response containing the OCR status for the document revision.
+   */
   async getDocumentOcrStatus(documentRevisionId) {
     let resourceUri = this._httpHelper._config.ResourceUri.DocApi.OcrStatus;
     resourceUri = resourceUri.replace("{id}", documentRevisionId);
@@ -630,6 +663,16 @@ var DocumentManager = class {
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, null, null);
   }
+  /**
+   * Updates the OCR processing status for a document revision.
+   * @param {string} documentRevisionId - The ID (Guid) of the document revision to update.
+   * @param {object} data - The OCR status payload.
+   * @param {number} data.ocrErrorCode - Error code enum: 0=None, 1=ErrorThrown, 2=OcrProcessingError, 3=OcrOutputSaveError, 4=CheckinError.
+   * @param {number} data.ocrStatus - Status enum: 0=None, 1=Success, 2=SuccessNoTextExtracted, 3=Failure, 4=FailureNoRetry, 5=ResultingDocumentFromSuccess.
+   * @param {number} data.pageCount - Number of pages processed.
+   * @param {number} data.wordCount - Number of words extracted.
+   * @returns {Promise<string>} The API response confirming the OCR status update.
+   */
   async updateDocumentOcrStatus(documentRevisionId, data) {
     let resourceUri = this._httpHelper._config.ResourceUri.DocApi.OcrStatus;
     resourceUri = resourceUri.replace("{id}", documentRevisionId);
@@ -637,6 +680,24 @@ var DocumentManager = class {
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, null, data);
   }
+  /**
+   * Updates an existing document by its ID.
+   * @param {string} documentId - The ID (Guid) of the document to update.
+   * @param {object} data - The document update payload.
+   * @param {string} [data.name] - The document name.
+   * @param {string} [data.displayRev] - The display revision label.
+   * @param {string} [data.description] - Document description.
+   * @param {string} [data.keywords] - Document keywords.
+   * @param {string} [data.comments] - Comments for this revision.
+   * @param {string} [data.abstract] - Document abstract.
+   * @param {string} [data.changeText] - Change description for this revision.
+   * @param {string} [data.archive] - Archive state value.
+   * @param {string} [data.state] - Document state.
+   * @param {Array<{key: string, value: string}>} [data.indexFields] - Index field key/value pairs.
+   * @param {string} [data.docType] - The document type.
+   * @param {number} [data.confidence] - OCR confidence score (decimal).
+   * @returns {Promise<string>} The API response confirming the document update.
+   */
   async updateDocument(documentId, data) {
     let resourceUri = this._httpHelper._config.ResourceUri.DocApi.UpdateDocument;
     resourceUri = resourceUri.replace("{id}", documentId);
@@ -644,6 +705,19 @@ var DocumentManager = class {
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, null, data);
   }
+  /**
+   * Searches for documents using advanced search criteria.
+   * @param {object[]} criteriaList - List of search criteria objects to filter results.
+   * @param {string[]} searchFolders - List of folder paths to include in the search scope.
+   * @param {string[]} excludeFolders - List of folder paths to exclude from the search scope.
+   * @param {string} sortBy - The field name to sort the results by.
+   * @param {string} [sortDirection='desc'] - Sort direction, either 'asc' or 'desc'.
+   * @param {number} [page=0] - Zero-based page index for pagination.
+   * @param {number} [take=15] - Number of results to return per page.
+   * @param {number} [archiveType=0] - Archive type filter: 0 for active, 1 for archived documents.
+   * @param {boolean} [roleSecurity=false] - Whether to apply role-based security filtering.
+   * @returns {Promise<string>} The API response containing the matching documents and pagination info.
+   */
   async search(criteriaList, searchFolders, excludeFolders, sortBy, sortDirection = "desc", page = 0, take = 15, archiveType = 0, roleSecurity = false) {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.DocApi.AdvancedSearch);
     const data = {
@@ -670,6 +744,18 @@ var import_path = __toESM(require("path"), 1);
 var __filename2 = (0, import_url.fileURLToPath)(importMetaUrl);
 var __dirname = import_path.default.dirname(__filename2);
 var DocApi = class {
+  /** @type {boolean} */
+  isEnabled;
+  /** @type {string|null} */
+  baseUrl;
+  /** @type {boolean} */
+  roleSecurity;
+  /** @type {DocumentManager} */
+  documents;
+  /**
+   * @param {object} sessionToken - JWT session token from authentication.
+   * @param {object} docApiConfig - DocApi configuration object returned by the VV configuration endpoint.
+   */
   constructor(sessionToken, docApiConfig) {
     if (!sessionToken["tokenType"] && sessionToken["tokenType"] != "jwt") {
       return;
@@ -692,9 +778,26 @@ init_cjs_shims();
 // lib/formsApi/formInstanceManager.js
 init_cjs_shims();
 var FormInstanceManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Creates a new form instance from a form template.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {object} data - The form instance creation payload.
+   * @param {string} data.formTemplateId - The Guid of the form template revision; overridden by the formTemplateRevisionId argument if provided.
+   * @param {Array<{key: string, value: *, props?: Array<{key: string, value: string}>}>} data.fields - (Required) Form field values. Each item's key is the field name or its Guid; value is the field's value; props holds any extra key/value pairs to save alongside.
+   * @param {string} [data.formName] - The DhDocId (display name) for the new form instance.
+   * @param {string} [data.parentFormId] - Guid of the parent form instance (for child forms linked via a relation).
+   * @param {string} [data.controlFormId] - Guid of the form control (e.g. RRC or Questions) associated with this instance.
+   * @param {string} [data.offlineFormId] - Guid assigned to this form while offline; used when syncing offline forms.
+   * @param {boolean} [data.ignoreWorkflow] - When true, skips workflow processing for this save.
+   * @param {string} formTemplateRevisionId - The ID (Guid) of the form template revision to use; overrides any value in data.
+   * @returns {Promise<string>} The API response containing the created form instance details.
+   */
   async postForm(params, data, formTemplateRevisionId) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormsApi.FormInstance;
     const url = this._httpHelper.getUrl(resourceUri);
@@ -702,6 +805,23 @@ var FormInstanceManager = class {
     data["formTemplateId"] = formTemplateRevisionId || data["formTemplateId"];
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Submits a new revision for an existing form instance.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {object} data - The form instance revision payload.
+   * @param {string} data.formTemplateId - The Guid of the form template revision; overridden by the formTemplateRevisionId argument if provided.
+   * @param {string} data.formId - The Guid of the existing form instance being revised; overridden by the formId argument if provided.
+   * @param {Array<{key: string, value: *, props?: Array<{key: string, value: string}>}>} data.fields - (Required) Form field values. Each item's key is the field name or its Guid; value is the field's value; props holds any extra key/value pairs to save alongside.
+   * @param {boolean} [data.replaceRevision] - When true, replaces the current revision instead of creating a new one.
+   * @param {string} [data.formName] - The DhDocId (display name) for this revision.
+   * @param {string} [data.parentFormId] - Guid of the parent form instance (for child forms linked via a relation).
+   * @param {string} [data.controlFormId] - Guid of the form control (e.g. RRC or Questions) associated with this instance.
+   * @param {string} [data.offlineFormId] - Guid assigned to this form while offline; used when syncing offline forms.
+   * @param {boolean} [data.ignoreWorkflow] - When true, skips workflow processing for this save.
+   * @param {string} formTemplateRevisionId - The ID (Guid) of the form template revision; overrides any value in data.
+   * @param {string} formId - The ID (Guid) of the existing form instance to revise; overrides any value in data.
+   * @returns {Promise<string>} The API response containing the updated form instance details.
+   */
   async postFormRevision(params, data, formTemplateRevisionId, formId) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormsApi.FormInstance;
     const url = this._httpHelper.getUrl(resourceUri);
@@ -721,6 +841,16 @@ var import_path2 = __toESM(require("path"), 1);
 var __filename3 = (0, import_url2.fileURLToPath)(importMetaUrl);
 var __dirname2 = import_path2.default.dirname(__filename3);
 var FormsApi = class {
+  /** @type {boolean} */
+  isEnabled;
+  /** @type {string|null} */
+  baseUrl;
+  /** @type {FormInstanceManager} */
+  formInstances;
+  /**
+   * @param {object} sessionToken - JWT session token from authentication.
+   * @param {object} formsApiConfig - FormsApi configuration object returned by the VV configuration endpoint.
+   */
   constructor(sessionToken, formsApiConfig) {
     if (!sessionToken["tokenType"] && sessionToken["tokenType"] != "jwt") {
       return;
@@ -742,12 +872,16 @@ init_cjs_shims();
 // lib/objectsApi/modelManager.js
 init_cjs_shims();
 var ModelManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
   /**
-   * Retrieves a list of available models
-   * @param {object} params - Optional URL parameters to include in the request
+   * Retrieves a list of available models.
+   * @param {object} [params] - Optional URL parameters to include in the request.
+   * @returns {Promise<object>} The API response containing the list of models.
    */
   async getModels(params) {
     const resourceUri = this._httpHelper._config.ResourceUri.ObjectsApi.Models;
@@ -757,9 +891,10 @@ var ModelManager = class {
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
   /**
-   * Retrieves a specific model by its ID
-   * @param {string} modelId - The ID (Guid) for the requested model
-   * @param {object} params - Optional URL parameters to include in the request
+   * Retrieves a specific model by its ID.
+   * @param {string} modelId - The ID (Guid) for the requested model.
+   * @param {object} [params] - Optional URL parameters to include in the request.
+   * @returns {Promise<object>} The API response containing the model details.
    */
   async getModelById(modelId, params) {
     let resourceUri = this._httpHelper._config.ResourceUri.ObjectsApi.ModelById;
@@ -775,13 +910,17 @@ var modelManager_default = ModelManager;
 // lib/objectsApi/objectManager.js
 init_cjs_shims();
 var ObjectManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
   /**
-   * Retrieves a specific object by its ID
-   * @param {string} objectId - The ID (Guid) for the requested object
-   * @param {object} params - Optional URL parameters to include in the request
+   * Retrieves a specific object by its ID.
+   * @param {string} objectId - The ID (Guid) for the requested object.
+   * @param {object} [params] - Optional URL parameters to include in the request.
+   * @returns {Promise<string>} The API response containing the object details.
    */
   async getObject(objectId, params) {
     let resourceUri = this._httpHelper._config.ResourceUri.ObjectsApi.ObjectById;
@@ -792,10 +931,16 @@ var ObjectManager = class {
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
   /**
-   * Retrieves a paged list of objects associated with a given model
-   * @param {string} modelId - The ID (Guid) for the requested model to search
-   * @param {object} data - Data to send in the request body
-   * @param {object} params - Optional URL parameters to include in the request
+   * Retrieves a paged list of objects associated with a given model.
+   * @param {string} modelId - The ID (Guid) for the requested model to search.
+   * @param {object} data - The search payload.
+   * @param {number} [data.page=0] - Zero-based page index for pagination.
+   * @param {number} [data.take=10] - Number of results to return per page.
+   * @param {Array<{sortField: string, direction: number}>} [data.sort] - Sort criteria; direction: 0=Ascending, 1=Descending.
+   * @param {Array<{lookIn: string, clause: string, criteria: string, condition?: string, leftBracket?: boolean, rightBracket?: boolean}>} [data.criteriaList] - Filter criteria items. lookIn: property name or Guid. clause: 'IsEqual'|'NotEqual'|'GreaterThan'|'GreaterThanEqual'|'LessThan'|'LessThanEqual'|'BeginWith'|'NotBeginWith'|'EndWith'|'NotEndWith'|'Contain'|'NotContain'|'Null'|'NotNull'|'Between'|'NotBetween'|'In'|'NotIn'. criteria: value to compare. condition: 'AND'|'OR'. leftBracket/rightBracket: open/close a logical group.
+   * @param {string[]} [data.propertyList] - Property names or Guids to include in results; empty array returns all properties.
+   * @param {object} [params] - Optional URL parameters to include in the request.
+   * @returns {Promise<string>} The API response containing the list of matching objects and pagination info.
    */
   async getObjectsByModelId(modelId, data, params) {
     let resourceUri = this._httpHelper._config.ResourceUri.ObjectsApi.ObjectSearchByModelId;
@@ -807,10 +952,14 @@ var ObjectManager = class {
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
   /**
-   * Creates a new object adhering to a given model
-   * @param {string} modelId - The ID (Guid) used to create a new object for that model
-   * @param {object} data - Data to send in the request body
-   * @param {object} params - Optional URL parameters to include in the request
+   * Creates a new object adhering to a given model.
+   * @param {string} modelId - The ID (Guid) used to create a new object for that model; overrides any value in data.
+   * @param {object} data - The object creation payload.
+   * @param {string} data.modelId - The Guid of the model this object belongs to; overridden by the modelId argument.
+   * @param {object} [data.properties] - Key/value pairs for object property values, keyed by property name or Guid.
+   * @param {Array<{id: string, revisionId: string, properties: object, relatedObjectUpdates?: Array}>} [data.relatedModels] - Related object instances to create or link alongside this object.
+   * @param {object} [params] - Optional URL parameters to include in the request.
+   * @returns {Promise<string>} The API response containing the created object details.
    */
   async createObject(modelId, data, params) {
     const resourceUri = this._httpHelper._config.ResourceUri.ObjectsApi.Object;
@@ -822,11 +971,15 @@ var ObjectManager = class {
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
   /**
-   * Updates an existing object by its ID (Guid) and revision ID (Guid)
-   * @param {string} objectId - The ID (Guid) for the requested object to update
-   * @param {string} objectRevisionId - The revision ID (Guid) for the requested object to update
-   * @param {object} data - Data to send in the request body
-   * @param {object} params - Optional URL parameters to include in the request
+   * Updates an existing object by its ID and revision ID.
+   * @param {string} objectId - The ID (Guid) for the requested object to update.
+   * @param {string} objectRevisionId - The revision ID (Guid) for the requested object to update; overrides any value in data.
+   * @param {object} data - The object update payload.
+   * @param {string} data.revisionId - The revision Guid to update; overridden by the objectRevisionId argument.
+   * @param {object} [data.properties] - Key/value pairs for the updated object property values, keyed by property name or Guid.
+   * @param {Array<{id: string, revisionId: string, properties: object, relatedObjectUpdates?: Array}>} [data.relatedObjectUpdates] - Related object instances to update alongside this object.
+   * @param {object} [params] - Optional URL parameters to include in the request.
+   * @returns {Promise<string>} The API response confirming the object update.
    */
   async updateObject(objectId, objectRevisionId, data, params) {
     let resourceUri = this._httpHelper._config.ResourceUri.ObjectsApi.ObjectById;
@@ -839,9 +992,10 @@ var ObjectManager = class {
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
   /**
-   * Deletes an existing object by its ID (Guid)
-   * @param {string} objectId - The ID (Guid) for the requested object to delete
-   * @param {object} params - Optional URL parameters to include in the request
+   * Deletes an existing object by its ID.
+   * @param {string} objectId - The ID (Guid) for the requested object to delete.
+   * @param {object} [params] - Optional URL parameters to include in the request.
+   * @returns {Promise<string>} The API response confirming the object deletion.
    */
   async deleteObject(objectId, params) {
     let resourceUri = this._httpHelper._config.ResourceUri.ObjectsApi.ObjectById;
@@ -862,6 +1016,18 @@ var import_path3 = __toESM(require("path"), 1);
 var __filename4 = (0, import_url3.fileURLToPath)(importMetaUrl);
 var __dirname3 = import_path3.default.dirname(__filename4);
 var ObjectsApi = class {
+  /** @type {boolean} */
+  isEnabled;
+  /** @type {string|null} */
+  baseUrl;
+  /** @type {ModelManager} */
+  models;
+  /** @type {ObjectManager} */
+  objects;
+  /**
+   * @param {object} sessionToken - JWT session token from authentication.
+   * @param {object} objectsApiConfig - ObjectsApi configuration object returned by the VV configuration endpoint.
+   */
   constructor(sessionToken, objectsApiConfig) {
     if (!sessionToken["tokenType"] && sessionToken["tokenType"] != "jwt") {
       return;
@@ -884,9 +1050,17 @@ init_cjs_shims();
 // lib/studioApi/workflowManager.js
 init_cjs_shims();
 var WorkflowManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Retrieves the latest published version of a workflow by its ID.
+   * @param {string} workflowId - The ID (Guid) of the workflow to retrieve.
+   * @returns {Promise<object>} The API response containing the workflow details.
+   */
   async getWorkflow(workflowId) {
     const resourceUri = this._httpHelper._config.ResourceUri.StudioApi.WorkflowLatestPublishedId.replace("{id}", workflowId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -895,6 +1069,11 @@ var WorkflowManager = class {
     const params = {};
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Retrieves the latest published version of a workflow by its name.
+   * @param {string} workflowName - The name of the workflow to retrieve.
+   * @returns {Promise<object>} The API response containing the workflow details.
+   */
   async getWorkflowByName(workflowName) {
     const resourceUri = this._httpHelper._config.ResourceUri.StudioApi.WorkflowLatestPublished;
     const url = this._httpHelper.getUrl(resourceUri);
@@ -903,6 +1082,12 @@ var WorkflowManager = class {
     const params = { name: workflowName };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Retrieves the variables defined for a specific workflow.
+   * @param {object} [params] - Optional URL parameters to include in the request.
+   * @param {string} workflowId - The ID (Guid) of the workflow whose variables to retrieve.
+   * @returns {Promise<object>} The API response containing the list of workflow variables.
+   */
   async getWorkflowVariables(params, workflowId) {
     const resourceUri = this._httpHelper._config.ResourceUri.StudioApi.WorkflowVariables.replace("{id}", workflowId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -912,14 +1097,15 @@ var WorkflowManager = class {
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
   /**
-   * Triggers workflow
-   * @param {string} workflowId
-   * @param {number} workflowRevision
-   * @param {string} objectId
-   * @param {object[]} workflowVariables - workflow values to be submitted to the workflow
-   * * @param {string} workflowVariables[].name = name of variable
-   * * @param {*} workflowVariables[].value - value to be passed
-   * * @param {number} workflowVariables[].dataType - Text: 1, Number: 2, Date: 3, Boolean: 4
+   * Triggers a workflow run for a specific object.
+   * @param {string} workflowId - The ID (Guid) of the workflow to trigger.
+   * @param {number} workflowRevision - The revision number of the workflow to run.
+   * @param {string} objectId - The ID (Guid) of the object to run the workflow against.
+   * @param {object[]} workflowVariables - Workflow variable values to pass into the workflow.
+   * @param {string} workflowVariables[].name - The name of the variable.
+   * @param {*} workflowVariables[].value - The value to pass for the variable.
+   * @param {number} workflowVariables[].dataType - The data type: Text: 1, Number: 2, Date: 3, Boolean: 4.
+   * @returns {Promise<object>} The API response containing the triggered workflow instance details.
    */
   async triggerWorkflow(workflowId, workflowRevision, objectId, workflowVariables) {
     const resourceUri = this._httpHelper._config.ResourceUri.StudioApi.WorkflowRun.replace("{id}", workflowId).replace("{revision}", workflowRevision);
@@ -937,10 +1123,10 @@ var WorkflowManager = class {
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
   /**
-   * Terminates the workflow instance
-   * @param {string} workflowId
-   * @param {string} instanceId
-   * @returns
+   * Terminates a running workflow instance.
+   * @param {string} workflowId - The ID (Guid) of the workflow containing the instance to terminate.
+   * @param {string} instanceId - The ID (Guid) of the workflow instance to terminate.
+   * @returns {Promise<object>} The API response confirming the workflow instance was terminated.
    */
   async terminateWorkflow(workflowId, instanceId) {
     const resourceUri = this._httpHelper._config.ResourceUri.StudioApi.WorkflowTerminate.replace("{workflowId}", workflowId).replace("{instanceId}", instanceId);
@@ -951,11 +1137,11 @@ var WorkflowManager = class {
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
   /**
-       * Returns workflow history for an object under the provided workflow
-       * @param {string} workflowId
-       * @param {string} objectId
-       * @returns
-       */
+   * Returns the workflow execution history for an object under the provided workflow.
+   * @param {string} objectId - The ID (Guid) of the object whose workflow history to retrieve.
+   * @param {string} workflowId - The ID (Guid) of the workflow to query history for.
+   * @returns {Promise<object>} The API response containing the workflow history entries for the object.
+   */
   async GetWorkflowHistoryForObject(objectId, workflowId) {
     const resourceUri = this._httpHelper._config.ResourceUri.StudioApi.WorkflowHistoryObject.replace("{workflowId}", workflowId).replace("{objectId}", objectId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -965,10 +1151,10 @@ var WorkflowManager = class {
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
   /**
-   * Returns the running workflow, if any, for an object under the provided workflow
-   * @param {string} workflowId
-   * @param {string} objectId
-   * @returns
+   * Returns the currently running workflow instance, if any, for an object under the provided workflow.
+   * @param {string} objectId - The ID (Guid) of the object to check for a running workflow.
+   * @param {string} workflowId - The ID (Guid) of the workflow to query.
+   * @returns {Promise<object>} The API response containing the running workflow instance, or empty if none is active.
    */
   async GetRunningWorkflowForObject(objectId, workflowId) {
     const resourceUri = this._httpHelper._config.ResourceUri.StudioApi.WorkflowHistoryRunningObject.replace("{workflowId}", workflowId).replace("{objectId}", objectId);
@@ -984,12 +1170,16 @@ var workflowManager_default = WorkflowManager;
 // lib/studioApi/rolesAndPermissionsManager.js
 init_cjs_shims();
 var RolesAndPermissionsManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
   /**
-   * Retrieves available features for the requesting user
-   * @param {object} params - Optional URL parameters to include in the request
+   * Retrieves available features for the requesting user.
+   * @param {object} [params] - Optional URL parameters to include in the request.
+   * @returns {Promise<object>} The API response containing the list of features available to the user.
    */
   async getUserFeatures(params) {
     var resourceUri = this._httpHelper._config.ResourceUri.StudioApi.ResourceUserFeatures;
@@ -1010,6 +1200,18 @@ var import_path4 = __toESM(require("path"), 1);
 var __filename5 = (0, import_url4.fileURLToPath)(importMetaUrl);
 var __dirname4 = import_path4.default.dirname(__filename5);
 var StudioApi = class {
+  /** @type {boolean} */
+  isEnabled;
+  /** @type {string|null} */
+  baseUrl;
+  /** @type {WorkflowManager} */
+  workflow;
+  /** @type {RolesAndPermissionsManager} */
+  permissions;
+  /**
+   * @param {object} sessionToken - JWT session token from authentication.
+   * @param {object} studioApiConfig - StudioApi configuration object returned by the VV configuration endpoint.
+   */
   constructor(sessionToken, studioApiConfig) {
     if (!sessionToken["tokenType"] && sessionToken["tokenType"] != "jwt") {
       return;
@@ -1032,9 +1234,17 @@ init_cjs_shims();
 // lib/notificationsApi/userNotificationsManager.js
 init_cjs_shims();
 var UserNotificationsManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Forces a UI refresh notification for a specific user.
+   * @param {string} userGuid - The ID (Guid) of the user whose UI should be refreshed.
+   * @returns {Promise<object>} The API response confirming the refresh notification was sent.
+   */
   async forceUIRefresh(userGuid) {
     const resourceUri = this._httpHelper._config.ResourceUri.NotificationsApi.ForceUIRefresh.replace("{id}", userGuid);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -1054,6 +1264,16 @@ var import_path5 = __toESM(require("path"), 1);
 var __filename6 = (0, import_url5.fileURLToPath)(importMetaUrl);
 var __dirname5 = import_path5.default.dirname(__filename6);
 var NotificationsApi = class {
+  /** @type {boolean} */
+  isEnabled;
+  /** @type {string|null} */
+  baseUrl;
+  /** @type {UserNotificationsManager} */
+  users;
+  /**
+   * @param {object} sessionToken - JWT session token from authentication.
+   * @param {object} notificationsApiConfig - NotificationsApi configuration object returned by the VV configuration endpoint.
+   */
   constructor(sessionToken, notificationsApiConfig) {
     if (!sessionToken["tokenType"] && sessionToken["tokenType"] != "jwt") {
       return;
@@ -1129,9 +1349,16 @@ var Constants = class {
 // lib/vvRestApi/configurationManager.js
 init_cjs_shims();
 var ConfigurationManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Retrieves the configuration settings for the DocApi service.
+   * @returns {Promise<string>} JSON string containing the DocApi configuration.
+   */
   getDocApiConfig() {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.ConfigurationDocApi);
     const opts = { method: "GET" };
@@ -1139,6 +1366,10 @@ var ConfigurationManager = class {
     const data = {};
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Retrieves the configuration settings for the FormsApi service.
+   * @returns {Promise<string>} JSON string containing the FormsApi configuration.
+   */
   getFormsApiConfig() {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.ConfigurationFormsApi);
     const opts = { method: "GET" };
@@ -1146,6 +1377,10 @@ var ConfigurationManager = class {
     const data = {};
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Retrieves the configuration settings for the ObjectsApi service.
+   * @returns {Promise<string>} JSON string containing the ObjectsApi configuration.
+   */
   getObjectsApiConfig() {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.ConfigurationObjectsApi);
     const opts = { method: "GET" };
@@ -1153,6 +1388,10 @@ var ConfigurationManager = class {
     const data = {};
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Retrieves the configuration settings for the StudioApi service.
+   * @returns {Promise<string>} JSON string containing the StudioApi configuration.
+   */
   getStudioApiConfig() {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.ConfigurationStudioApi);
     const opts = { method: "GET" };
@@ -1160,6 +1399,10 @@ var ConfigurationManager = class {
     const data = {};
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Retrieves the configuration settings for the NotificationsApi service.
+   * @returns {Promise<string>} JSON string containing the NotificationsApi configuration.
+   */
   getNotificationsApiConfig() {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.ConfigurationNotificationApi);
     const opts = { method: "GET" };
@@ -1172,14 +1415,44 @@ var ConfigurationManager = class {
 // lib/vvRestApi/emailManager.js
 init_cjs_shims();
 var EmailManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Sends one or more emails.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {object} data - The email data to submit in the request body.
+   * @param {string} data.recipients - The recipient email address(es).
+   * @param {string} data.body - The email body content.
+   * @param {string} [data.ccRecipients] - CC recipient email address(es).
+   * @param {string} [data.bccRecipients] - BCC recipient email address(es).
+   * @param {string} [data.subject] - The email subject line.
+   * @param {boolean} [data.hasAttachments] - Whether the email includes document attachments.
+   * @param {string|string[]} [data.documents] - One or more document IDs (Guids) to attach. Used when hasAttachments is true.
+   * @returns {Promise<string>} The API response confirming the emails were sent.
+   */
   postEmails(params, data) {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.Emails);
     const opts = { method: "POST" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Sends one or more emails with file attachments.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {object} data - The email data to submit in the request body.
+   * @param {string} data.recipients - The recipient email address(es).
+   * @param {string} data.body - The email body content.
+   * @param {string} [data.ccRecipients] - CC recipient email address(es).
+   * @param {string} [data.bccRecipients] - BCC recipient email address(es).
+   * @param {string} [data.subject] - The email subject line.
+   * @param {boolean} [data.hasAttachments] - Whether the email includes document attachments.
+   * @param {string|string[]} [data.documents] - One or more document IDs (Guids) to attach alongside the direct file uploads.
+   * @param {object[]} fileObjs - Array of file objects to attach directly to the email.
+   * @returns {Promise<string>} The API response confirming the emails were sent.
+   */
   postEmailsWithAttachments(params, data, fileObjs) {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.Emails);
     const opts = { method: "POSTSTREAM" };
@@ -1256,22 +1529,37 @@ var FormFieldCollection = class {
 };
 var FormsManager = class {
   /**
-   * @param {*} httpHelper - HTTP helper instance
+   * @param {object} httpHelper - HTTP helper instance
    */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Creates a ReturnField instance representing a form field value or error.
+   * @param {string} id - The field ID.
+   * @param {string} name - The field name.
+   * @param {*} value - The field value.
+   * @param {boolean} isError - Whether the field has an error.
+   * @param {string} errorMessage - The error message if isError is true.
+   * @returns {ReturnField} A new ReturnField instance.
+   */
   returnField(id, name, value, isError, errorMessage) {
     return new ReturnField(id, name, value, isError, errorMessage);
   }
+  /**
+   * Retrieves available form templates in the vault.
+   * @param {object} params - Optional query parameters for filtering and pagination.
+   * @returns {Promise<string>} The API response containing the form templates.
+   */
   getFormTemplates(params) {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.FormTemplates);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
   /**
-   * @param {string} templateName
-   * @returns {Promise<{formsManager: FormsManager, templateIdGuid: string, templateRevisionIdGuid: string, error?: string}>}
+   * Looks up the GUID and revision GUID for a form template by its display name.
+   * @param {string} templateName - The display name of the form template.
+   * @returns {Promise<{formsManager: FormsManager, templateIdGuid: string, templateRevisionIdGuid: string, error?: string}>} A promise that resolves with the template IDs, or an error property if the lookup fails.
    */
   async getFormTemplateIdByName(templateName) {
     const params = {
@@ -1304,6 +1592,12 @@ var FormsManager = class {
       };
     }
   }
+  /**
+   * Retrieves form instances for a given form template. Accepts either a template GUID or template name.
+   * @param {object} params - Optional query parameters for filtering and pagination.
+   * @param {string} formTemplateId - The form template GUID or display name.
+   * @returns {Promise<string>} The API response containing the form instances.
+   */
   async getForms(params, formTemplateId) {
     if (!this.isGuid(formTemplateId)) {
       const resp = await this.getFormTemplateIdByName(formTemplateId);
@@ -1319,6 +1613,13 @@ var FormsManager = class {
       return this._httpHelper.doVvClientRequest(url, opts, params, null);
     }
   }
+  /**
+   * Sets an image field on a form instance.
+   * @param {string} formId - The ID of the form instance.
+   * @param {string} fieldId - The ID of the image field to set.
+   * @param {string} imageId - The ID of the image to assign to the field.
+   * @returns {Promise<string>} The API response confirming the update.
+   */
   setFieldImage(formId, fieldId, imageId) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormInstanceImage.replace("{id}", formId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -1327,12 +1628,26 @@ var FormsManager = class {
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Imports a form template from a file stream.
+   * @param {object} data - Multipart metadata sent alongside the file stream.
+   * @param {string} formTemplateId - The ID of the form template to import into.
+   * @param {Uint8Array} buffer - The file content of the form template to import.
+   * @returns {Promise<string>} The API response confirming the import.
+   */
   importFormTemplate(data, formTemplateId, buffer) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormTemplatesImport.replace("{id}", formTemplateId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "PUTSTREAM" };
     return this._httpHelper.doVvClientRequest(url, opts, null, data, buffer);
   }
+  /**
+   * Creates a new form instance for a given template. Accepts either a template GUID or template name.
+   * @param {object} params - Optional query parameters.
+   * @param {{[key: string]: string}} data - Form field key-value pairs where each key is a field name or Guid ID and each value is the field's string value.
+   * @param {string} formTemplateId - The form template GUID or display name.
+   * @returns {Promise<string>} The API response containing the created form instance.
+   */
   async postForms(params, data, formTemplateId) {
     if (!this.isGuid(formTemplateId)) {
       const resp = await this.getFormTemplateIdByName(formTemplateId);
@@ -1348,6 +1663,14 @@ var FormsManager = class {
       return this._httpHelper.doVvClientRequest(url, opts, params, data);
     }
   }
+  /**
+   * Creates a new revision of an existing form instance. Accepts either a template GUID or template name.
+   * @param {object} params - Optional query parameters.
+   * @param {{[key: string]: string}} data - Form field key-value pairs where each key is a field name or Guid ID and each value is the field's string value.
+   * @param {string} formTemplateId - The form template GUID or display name.
+   * @param {string} formId - The ID of the existing form instance to revise.
+   * @returns {Promise<string>} The API response containing the new form revision.
+   */
   async postFormRevision(params, data, formTemplateId, formId) {
     if (!this.isGuid(formTemplateId)) {
       const resp = await this.getFormTemplateIdByName(formTemplateId);
@@ -1363,11 +1686,24 @@ var FormsManager = class {
       return this._httpHelper.doVvClientRequest(url, opts, params, data);
     }
   }
+  /**
+   * Creates a new revision of a form instance identified directly by its form ID.
+   * @param {object} params - Optional query parameters.
+   * @param {{[key: string]: string}} data - Form field key-value pairs where each key is a field name or Guid ID and each value is the field's string value.
+   * @param {string} formId - The ID of the form instance to revise.
+   * @returns {Promise<string>} The API response containing the new form revision.
+   */
   postFormRevisionByFormId(params, data, formId) {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.FormsId).replace("{id}", formId);
     const opts = { method: "POST" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Updates the originator (owner) of a form instance.
+   * @param {string} formInstanceId - The ID of the form instance to update.
+   * @param {string} newOriginatorUsID - The user ID of the new originator.
+   * @returns {Promise<string>} The API response confirming the update.
+   */
   updateFormInstanceOriginator(formInstanceId, newOriginatorUsID) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormInstanceUpdateOriginator.replace("{id}", formInstanceId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -1376,6 +1712,12 @@ var FormsManager = class {
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Relates a form instance to another form instance by form ID.
+   * @param {string} formId - The ID of the source form instance.
+   * @param {string} relateToId - The ID of the form instance to relate to.
+   * @returns {Promise<string>} The API response confirming the relation.
+   */
   relateForm(formId, relateToId) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormInstance.replace("{id}", formId);
     const url = this._httpHelper.getUrl(resourceUri + "/relateForm");
@@ -1384,6 +1726,12 @@ var FormsManager = class {
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Relates a form instance to another form instance by document ID.
+   * @param {string} formId - The ID of the source form instance.
+   * @param {string} relateToDocId - The document ID of the form instance to relate to.
+   * @returns {Promise<string>} The API response confirming the relation.
+   */
   relateFormByDocId(formId, relateToDocId) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormInstance.replace("{id}", formId);
     const url = this._httpHelper.getUrl(resourceUri + "/relateForm");
@@ -1392,6 +1740,12 @@ var FormsManager = class {
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Relates a form instance to a document by document revision ID.
+   * @param {string} formId - The ID of the form instance.
+   * @param {string} relateToId - The revision ID of the document to relate to.
+   * @returns {Promise<string>} The API response confirming the relation.
+   */
   relateDocument(formId, relateToId) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormInstance.replace("{id}", formId);
     const url = this._httpHelper.getUrl(resourceUri + "/relateDocument");
@@ -1400,6 +1754,12 @@ var FormsManager = class {
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Relates a form instance to a document by document ID.
+   * @param {string} formId - The ID of the form instance.
+   * @param {string} relateToDocId - The document ID to relate to.
+   * @returns {Promise<string>} The API response confirming the relation.
+   */
   relateDocumentByDocId(formId, relateToDocId) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormInstance.replace("{id}", formId);
     const url = this._httpHelper.getUrl(resourceUri + "/relateDocument");
@@ -1408,6 +1768,12 @@ var FormsManager = class {
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Relates a form instance to a project by project ID.
+   * @param {string} formId - The ID of the form instance.
+   * @param {string} relateToId - The ID of the project to relate to.
+   * @returns {Promise<string>} The API response confirming the relation.
+   */
   relateProject(formId, relateToId) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormInstance.replace("{id}", formId);
     const url = this._httpHelper.getUrl(resourceUri + "/relateProject");
@@ -1416,6 +1782,12 @@ var FormsManager = class {
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Relates a form instance to a project by project name.
+   * @param {string} formId - The ID of the form instance.
+   * @param {string} relateToProjectName - The name of the project to relate to.
+   * @returns {Promise<string>} The API response confirming the relation.
+   */
   relateProjectByName(formId, relateToProjectName) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormInstance.replace("{id}", formId);
     const url = this._httpHelper.getUrl(resourceUri + "/relateProject");
@@ -1424,6 +1796,12 @@ var FormsManager = class {
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Removes a relationship between two form instances by form ID.
+   * @param {string} formId - The ID of the source form instance.
+   * @param {string} relateToId - The ID of the related form instance to unrelate.
+   * @returns {Promise<string>} The API response confirming the unrelation.
+   */
   unrelateForm(formId, relateToId) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormInstance.replace("{id}", formId);
     const url = this._httpHelper.getUrl(resourceUri + "/unrelateForm");
@@ -1432,6 +1810,12 @@ var FormsManager = class {
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Removes a relationship between two form instances by document ID.
+   * @param {string} formId - The ID of the source form instance.
+   * @param {string} relateToDocId - The document ID of the related form instance to unrelate.
+   * @returns {Promise<string>} The API response confirming the unrelation.
+   */
   unrelateFormByDocId(formId, relateToDocId) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormInstance.replace("{id}", formId);
     const url = this._httpHelper.getUrl(resourceUri + "/unrelateForm");
@@ -1440,6 +1824,12 @@ var FormsManager = class {
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Removes a relationship between a form instance and a document by document revision ID.
+   * @param {string} formId - The ID of the form instance.
+   * @param {string} relateToId - The revision ID of the related document to unrelate.
+   * @returns {Promise<string>} The API response confirming the unrelation.
+   */
   unrelateDocument(formId, relateToId) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormInstance.replace("{id}", formId);
     const url = this._httpHelper.getUrl(resourceUri + "/unrelateDocument");
@@ -1448,6 +1838,12 @@ var FormsManager = class {
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Removes a relationship between a form instance and a document by document ID.
+   * @param {string} formId - The ID of the form instance.
+   * @param {string} relateToDocId - The document ID of the related document to unrelate.
+   * @returns {Promise<string>} The API response confirming the unrelation.
+   */
   unrelateDocumentByDocId(formId, relateToDocId) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormInstance.replace("{id}", formId);
     const url = this._httpHelper.getUrl(resourceUri + "/unrelateDocument");
@@ -1456,6 +1852,12 @@ var FormsManager = class {
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Removes a relationship between a form instance and a project by project ID.
+   * @param {string} formId - The ID of the form instance.
+   * @param {string} relateToId - The ID of the related project to unrelate.
+   * @returns {Promise<string>} The API response confirming the unrelation.
+   */
   unrelateProject(formId, relateToId) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormInstance.replace("{id}", formId);
     const url = this._httpHelper.getUrl(resourceUri + "/unrelateProject");
@@ -1464,6 +1866,12 @@ var FormsManager = class {
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Removes a relationship between a form instance and a project by project name.
+   * @param {string} formId - The ID of the form instance.
+   * @param {string} relateToProjectName - The name of the related project to unrelate.
+   * @returns {Promise<string>} The API response confirming the unrelation.
+   */
   unrelateProjectByName(formId, relateToProjectName) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormInstance.replace("{id}", formId);
     const url = this._httpHelper.getUrl(resourceUri + "/unrelateProject");
@@ -1472,6 +1880,12 @@ var FormsManager = class {
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Retrieves documents related to a form instance.
+   * @param {string} formId - The ID of the form instance.
+   * @param {object} [params] - Optional query parameters for filtering and pagination.
+   * @returns {Promise<string>} The API response containing the related documents.
+   */
   getFormRelatedDocs(formId, params) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormInstanceRelatedDocs.replace("{id}", formId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -1481,6 +1895,12 @@ var FormsManager = class {
     }
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves form instances related to a given form instance.
+   * @param {string} formId - The ID of the form instance.
+   * @param {object} [params] - Optional query parameters for filtering and pagination.
+   * @returns {Promise<string>} The API response containing the related form instances.
+   */
   getFormRelatedForms(formId, params) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormInstanceRelatedForms.replace("{id}", formId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -1490,6 +1910,11 @@ var FormsManager = class {
     }
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Tests whether a string is a valid GUID.
+   * @param {string} stringToTest - The string to test.
+   * @returns {boolean} True if the string is a valid GUID, false otherwise.
+   */
   isGuid(stringToTest) {
     let testString = stringToTest;
     if (testString[0] === "{") {
@@ -1498,30 +1923,57 @@ var FormsManager = class {
     const regexGuid = /^(\{){0,1}[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}(\}){0,1}$/gi;
     return regexGuid.test(testString);
   }
+  /**
+   * Retrieves a specific form instance by template ID and instance ID.
+   * @param {string} templateId - The ID of the form template.
+   * @param {string} instanceId - The ID of the form instance.
+   * @returns {Promise<string>} The API response containing the form instance.
+   */
   getFormInstanceById(templateId, instanceId) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormId.replace("{id}", templateId).replace("{formId}", instanceId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, null, null);
   }
+  /**
+   * Retrieves a form instance as a PDF stream.
+   * @param {string} templateId - The ID of the form template.
+   * @param {string} instanceId - The ID of the form instance.
+   * @returns {Promise<string>} The API response containing the PDF content stream.
+   */
   getFormInstancePDF(templateId, instanceId) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormIdPdf.replace("{id}", templateId).replace("{formId}", instanceId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GETSTREAM" };
     return this._httpHelper.doVvClientRequest(url, opts, null, null);
   }
+  /**
+   * Retrieves the field definitions for a form template.
+   * @param {string} templateId - The ID of the form template.
+   * @returns {Promise<string>} The API response containing the template's field definitions.
+   */
   getFormTemplateFields(templateId) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormDesignerFormsTemplatesIdFields.replace("{id}", templateId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, null, null);
   }
+  /**
+   * Deletes a form instance.
+   * @param {string} instanceId - The ID of the form instance to delete.
+   * @returns {Promise<string>} The API response confirming the deletion.
+   */
   deleteFormInstance(instanceId) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormInstance.replace("{id}", instanceId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "DELETE" };
     return this._httpHelper.doVvClientRequest(url, opts, null, null);
   }
+  /**
+   * Releases a form template.
+   * @param {string} formTemplateId - The ID of the form template to release.
+   * @returns {Promise<string>} The API response confirming the release.
+   */
   releaseFormTemplate(formTemplateId) {
     const resourceUri = this._httpHelper._config.ResourceUri.FormTemplatesRelease.replace("{id}", formTemplateId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -1533,57 +1985,117 @@ var FormsManager = class {
 // lib/vvRestApi/groupsManager.js
 init_cjs_shims();
 var GroupsManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Retrieves a list of groups.
+   * @param {object} params - URL parameters to include in the request.
+   * @returns {Promise<string>} JSON string containing the list of groups.
+   */
   getGroups(params) {
     const resourceUri = this._httpHelper._config.ResourceUri.GetGroups;
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves a specific group by its ID.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {string} groupId - The ID (Guid) of the group to retrieve.
+   * @returns {Promise<string>} JSON string containing the group details.
+   */
   getGroupById(params, groupId) {
     const resourceUri = this._httpHelper._config.ResourceUri.GroupById.replace("{id}", groupId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Creates a new group.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {object} formData - The group data to submit in the request body.
+   * @returns {Promise<string>} JSON string containing the created group details.
+   */
   addGroup(params, formData) {
     const resourceUri = this._httpHelper._config.ResourceUri.AddGroup;
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "POST" };
     return this._httpHelper.doVvClientRequest(url, opts, params, formData);
   }
+  /**
+   * Updates an existing group by its ID.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {string} groupId - The ID (Guid) of the group to update.
+   * @param {object} formData - The updated group data to submit in the request body.
+   * @returns {Promise<string>} JSON string confirming the group was updated.
+   */
   updateGroup(params, groupId, formData) {
     const resourceUri = this._httpHelper._config.ResourceUri.UpdateGroup.replace("{id}", groupId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, formData);
   }
+  /**
+   * Deletes a group by its ID.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {string} groupId - The ID (Guid) of the group to delete.
+   * @returns {Promise<string>} JSON string confirming the group was deleted.
+   */
   deleteGroup(params, groupId) {
     const resourceUri = this._httpHelper._config.ResourceUri.DeleteGroup.replace("{id}", groupId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "DELETE" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves all users belonging to a specific group.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {string} groupId - The ID (Guid) of the group whose users to retrieve.
+   * @returns {Promise<string>} JSON string containing the list of users in the group.
+   */
   getGroupsUsers(params, groupId) {
     const resourceUri = this._httpHelper._config.ResourceUri.GroupsUsers.replace("{id}", groupId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves a specific user within a group.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {string} groupId - The ID (Guid) of the group to look up the user in.
+   * @param {string} userId - The ID (Guid) of the user to retrieve.
+   * @returns {Promise<string>} JSON string containing the user's membership details within the group.
+   */
   getGroupUser(params, groupId, userId) {
     const resourceUri = this._httpHelper._config.ResourceUri.GroupsAddUser.replace("{groupId}", groupId).replace("{userId}", userId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Adds a user to a group.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {string} groupId - The ID (Guid) of the group to add the user to.
+   * @param {string} userId - The ID (Guid) of the user to add to the group.
+   * @returns {Promise<string>} JSON string confirming the user was added to the group.
+   */
   addUserToGroup(params, groupId, userId) {
     const resourceUri = this._httpHelper._config.ResourceUri.GroupsAddUser.replace("{groupId}", groupId).replace("{userId}", userId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Removes a user from a group.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {string} groupId - The ID (Guid) of the group to remove the user from.
+   * @param {string} userId - The ID (Guid) of the user to remove from the group.
+   * @returns {Promise<string>} JSON string confirming the user was removed from the group.
+   */
   removeUserFromGroup(params, groupId, userId) {
     const resourceUri = this._httpHelper._config.ResourceUri.GroupsAddUser.replace("{groupId}", groupId).replace("{userId}", userId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -1595,53 +2107,136 @@ var GroupsManager = class {
 // lib/vvRestApi/libraryManager.js
 init_cjs_shims();
 var LibraryManager = class {
+  /**
+   * @param {object} httpHelper - HTTP helper instance
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Retrieves all folders.
+   * @param {object} params - Optional query parameters for filtering and pagination.
+   * @returns {Promise<string>} The API response containing the list of folders.
+   */
   getFolders(params) {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.Folders);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Creates a new folder at the specified path.
+   * @param {object} params - Optional query parameters.
+   * @param {object} data - Folder properties to create.
+   * @param {string} [data.name] - Folder name; if omitted, derived from the last segment of folderPath.
+   * @param {string} [data.description] - Folder description.
+   * @param {boolean} [data.allowRevisions] - Whether documents in this folder allow revisions.
+   * @param {string} [data.formUploadControlId] - Guid of the form upload control to associate.
+   * @param {string} [data.formId] - Guid of the form to associate with the folder.
+   * @param {boolean} [data.inheritNamingConvention] - Whether to inherit the naming convention from the parent folder.
+   * @param {boolean} [data.inheritRecordRetention] - Whether to inherit record retention settings from the parent folder.
+   * @param {string} [data.defaultDocType] - Default document type for the folder.
+   * @param {boolean} [data.docTypeRequired] - Whether a document type is required when uploading.
+   * @param {string} folderPath - The full path where the folder should be created.
+   * @returns {Promise<string>} The API response containing the created folder.
+   */
   postFolderByPath(params, data, folderPath) {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.Folders);
     data.folderpath = folderPath;
     const opts = { method: "POST" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
-  // Valid fields to be defined on the "data" parameter to be updated on the folder: name, description
+  /**
+   * Updates a folder's properties.
+   * @param {object} params - Optional query parameters.
+   * @param {object} data - Folder properties to update.
+   * @param {string} [data.name] - New folder name.
+   * @param {string} [data.description] - New folder description.
+   * @param {string} [data.defaultDocType] - Default document type for the folder.
+   * @param {boolean} [data.docTypeRequired] - Whether a document type is required when uploading.
+   * @param {string} folderId - The ID of the folder to update.
+   * @returns {Promise<string>} The API response containing the updated folder.
+   */
   putFolder(params, data, folderId) {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.FoldersId.replace("{id}", folderId));
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Deletes a folder.
+   * @param {string} folderId - The ID of the folder to delete.
+   * @returns {Promise<string>} The API response confirming the deletion.
+   */
   deleteFolder(folderId) {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.FoldersId.replace("{id}", folderId));
     const opts = { method: "DELETE" };
     return this._httpHelper.doVvClientRequest(url, opts, null, null);
   }
+  /**
+   * Copies a folder to a new location.
+   * @param {object} params - Optional query parameters.
+   * @param {object} data - Copy options.
+   * @param {string} [data.sourceFolderId] - Guid of the folder to copy; use instead of sourceFolderPath.
+   * @param {string} [data.sourceFolderPath] - Full path of the folder to copy; use instead of sourceFolderId.
+   * @param {string} [data.targetFolderId] - Guid of the destination folder; use instead of targetFolderPath.
+   * @param {string} [data.targetFolderPath] - Full path of the destination folder; use instead of targetFolderId.
+   * @returns {Promise<string>} The API response confirming the copy operation.
+   */
   copyFolder(params, data) {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.FoldersCopy);
     const opts = { method: "POST" };
     return this._httpHelper.doVvClientRequest(url, opts, null, data);
   }
+  /**
+   * Moves a folder to a new location.
+   * @param {object} params - Optional query parameters.
+   * @param {object} data - Move options.
+   * @param {string} [data.sourceFolderId] - Guid of the folder to move; use instead of sourceFolderPath.
+   * @param {string} [data.sourceFolderPath] - Full path of the folder to move; use instead of sourceFolderId.
+   * @param {string} [data.targetFolderId] - Guid of the destination folder; use instead of targetFolderPath.
+   * @param {string} [data.targetFolderPath] - Full path of the destination folder; use instead of targetFolderId.
+   * @returns {Promise<string>} The API response confirming the move operation.
+   */
   moveFolder(params, data) {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.FoldersMove);
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, null, data);
   }
+  /**
+   * Retrieves documents within a specific folder.
+   * @param {object} params - Optional query parameters for filtering and pagination.
+   * @param {string} folderId - The ID of the folder to retrieve documents from.
+   * @returns {Promise<string>} The API response containing the folder's documents.
+   */
   getDocuments(params, folderId) {
     const resourceUri = this._httpHelper._config.ResourceUri.Documents.replace("{id}", folderId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves a folder by its full path.
+   * @param {object} params - Optional query parameters.
+   * @param {string} folderPath - The full path of the folder to retrieve.
+   * @returns {Promise<string>} The API response containing the folder.
+   */
   getFolderByPath(params, folderPath) {
     const resourceUri = this._httpHelper._config.ResourceUri.Folders + "?folderpath=" + encodeURIComponent(folderPath);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Updates the index field override settings for a folder (query, dropdown list, required, default value).
+   * @param {string} folderId - The ID of the folder.
+   * @param {string} fieldId - The ID of the index field to configure.
+   * @param {string} queryId - The ID of the query to use for the field's dropdown.
+   * @param {string} displayField - The query field to display in the dropdown.
+   * @param {string} valueField - The query field to use as the stored value.
+   * @param {string} dropDownListId - The ID of a static dropdown list, if used instead of a query.
+   * @param {boolean} required - Whether the field is required.
+   * @param {string} defaultValue - The default value for the field.
+   * @returns {Promise<string>} The API response confirming the update.
+   */
   updateFolderIndexFieldOverrideSettings(folderId, fieldId, queryId, displayField, valueField, dropDownListId, required, defaultValue) {
     const data = {
       queryId,
@@ -1656,12 +2251,25 @@ var LibraryManager = class {
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, null, data);
   }
+  /**
+   * Retrieves the index fields associated with a folder.
+   * @param {object} params - Optional query parameters for filtering.
+   * @param {string} folderId - The ID of the folder.
+   * @returns {Promise<string>} The API response containing the folder's index fields.
+   */
   getFolderIndexFields(params, folderId) {
     const resourceUri = this._httpHelper._config.ResourceUri.FolderIndexFields.replace("{id}", folderId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Subscribes a user to alert notifications for a specific folder event.
+   * @param {string} folderId - The ID of the folder to subscribe to.
+   * @param {string} eventId - The ID of the event to subscribe to.
+   * @param {string} userId - The ID of the user to subscribe.
+   * @returns {Promise<string>} The API response confirming the subscription.
+   */
   postFolderAlertSubscription(folderId, eventId, userId) {
     const resourceUri = this._httpHelper._config.ResourceUri.FolderAlertsId.replace("{folderId}", folderId).replace("{eventId}", eventId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -1671,6 +2279,13 @@ var LibraryManager = class {
     };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Removes a user's subscription to alert notifications for a specific folder event.
+   * @param {string} folderId - The ID of the folder.
+   * @param {string} eventId - The ID of the event to unsubscribe from.
+   * @param {string} userId - The ID of the user to unsubscribe.
+   * @returns {Promise<string>} The API response confirming the unsubscription.
+   */
   deleteFolderAlertSubscription(folderId, eventId, userId) {
     const resourceUri = this._httpHelper._config.ResourceUri.FolderAlertsId.replace("{folderId}", folderId).replace("{eventId}", eventId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -1680,12 +2295,27 @@ var LibraryManager = class {
     };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves the security members (users and groups) assigned to a folder.
+   * @param {object} params - Optional query parameters for filtering.
+   * @param {string} folderId - The ID of the folder.
+   * @returns {Promise<string>} The API response containing the folder's security members.
+   */
   getFolderSecurityMembers(params, folderId) {
     const resourceUri = this._httpHelper._config.ResourceUri.FolderSecurity.replace("{folderId}", folderId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Adds or updates a security member's role on a folder.
+   * @param {string} folderId - The ID of the folder.
+   * @param {string} memberId - The ID of the user or group.
+   * @param {"user"|"group"} memberType - The type of member.
+   * @param {string} securityRole - The security role to assign (e.g., `editor`, `viewer`).
+   * @param {boolean} cascadeSecurityChanges - Whether to apply the change to all subfolders.
+   * @returns {Promise<string>} The API response confirming the update.
+   */
   putFolderSecurityMember(folderId, memberId, memberType, securityRole, cascadeSecurityChanges) {
     const resourceUri = this._httpHelper._config.ResourceUri.FolderSecurityId.replace("{folderId}", folderId).replace("{memberId}", memberId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -1697,6 +2327,13 @@ var LibraryManager = class {
     };
     return this._httpHelper.doVvClientRequest(url, opts, null, data);
   }
+  /**
+   * Removes a security member from a folder.
+   * @param {string} folderId - The ID of the folder.
+   * @param {string} memberId - The ID of the user or group to remove.
+   * @param {boolean} cascadeSecurityChanges - Whether to remove the member from all subfolders.
+   * @returns {Promise<string>} The API response confirming the deletion.
+   */
   deleteFolderSecurityMember(folderId, memberId, cascadeSecurityChanges) {
     const resourceUri = this._httpHelper._config.ResourceUri.FolderSecurityId.replace("{folderId}", folderId).replace("{memberId}", memberId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -1711,44 +2348,101 @@ var LibraryManager = class {
 // lib/vvRestApi/sitesManager.js
 init_cjs_shims();
 var SitesManager = class {
+  /**
+   * @param {object} httpHelper - HTTP helper instance
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Retrieves all sites.
+   * @param {object} params - Optional query parameters for filtering and pagination.
+   * @returns {Promise<string>} The API response containing the list of sites.
+   */
   getSites(params) {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.Sites);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Creates a new site.
+   * @param {object} params - Optional query parameters.
+   * @param {object} data - Site properties to create.
+   * @param {string} data.name - Site name (required).
+   * @param {string} [data.description] - Site description.
+   * @param {string} [data.sitetype] - Site type identifier.
+   * @returns {Promise<string>} The API response containing the created site.
+   */
   postSites(params, data) {
     const resourceUri = this._httpHelper._config.ResourceUri.Sites;
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "POST" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Updates an existing site.
+   * @param {object} params - Optional query parameters.
+   * @param {object} data - Site properties to update.
+   * @param {string} [data.name] - New site name.
+   * @param {string} [data.description] - New site description.
+   * @param {string} siteId - The ID of the site to update.
+   * @returns {Promise<string>} The API response containing the updated site.
+   */
   putSites(params, data, siteId) {
     const resourceUri = this._httpHelper._config.ResourceUri.SiteById.replace("{id}", siteId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Retrieves all groups belonging to a site.
+   * @param {object} params - Optional query parameters for filtering and pagination.
+   * @param {string} siteId - The ID of the site.
+   * @returns {Promise<string>} The API response containing the site's groups.
+   */
   getGroups(params, siteId) {
     const resourceUri = this._httpHelper._config.ResourceUri.Groups.replace("{id}", siteId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Creates a new group within a site.
+   * @param {object} params - Optional query parameters.
+   * @param {object} data - Group properties to create.
+   * @param {string} data.name - Group name (required).
+   * @param {string} [data.description] - Group description; defaults to name if omitted.
+   * @param {string} siteId - The ID of the site to create the group in.
+   * @returns {Promise<string>} The API response containing the created group.
+   */
   postGroups(params, data, siteId) {
     const resourceUri = this._httpHelper._config.ResourceUri.Groups.replace("{id}", siteId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "POST" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Updates a group within a site.
+   * @param {object} params - Optional query parameters.
+   * @param {object} data - Group properties to update.
+   * @param {string} [data.name] - New group name.
+   * @param {string} [data.description] - New group description.
+   * @param {string} siteId - The ID of the site the group belongs to.
+   * @param {string} grId - The ID of the group to update.
+   * @returns {Promise<string>} The API response containing the updated group.
+   */
   putGroups(params, data, siteId, grId) {
     const resourceUri = this._httpHelper._config.ResourceUri.SiteGroupById.replace("{siteId}", siteId).replace("{groupId}", grId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Moves a user to a different site.
+   * @param {string} userId - The ID of the user to move.
+   * @param {string} newSiteId - The ID of the destination site.
+   * @returns {Promise<string>} The API response confirming the site change.
+   */
   changeUserSite(userId, newSiteId) {
     const resourceUri = this._httpHelper._config.ResourceUri.ChangeUserSite;
     const url = this._httpHelper.getUrl(resourceUri);
@@ -1759,18 +2453,37 @@ var SitesManager = class {
     };
     return this._httpHelper.doVvClientRequest(url, opts, null, data);
   }
+  /**
+   * Retrieves a specific site by its ID.
+   * @param {object} params - Optional query parameters.
+   * @param {string} siteId - The ID of the site to retrieve.
+   * @returns {Promise<string>} The API response containing the site.
+   */
   getSiteById(params, siteId) {
     const resourceUri = this._httpHelper._config.ResourceUri.SiteById.replace("{id}", siteId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Deletes a site.
+   * @param {object} params - Optional query parameters.
+   * @param {string} siteId - The ID of the site to delete.
+   * @returns {Promise<string>} The API response confirming the deletion.
+   */
   deleteSite(params, siteId) {
     const resourceUri = this._httpHelper._config.ResourceUri.SiteById.replace("{id}", siteId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "DELETE" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Moves a group to a different site.
+   * @param {object} params - Optional query parameters.
+   * @param {string} groupId - The ID of the group to move.
+   * @param {string} newSiteId - The ID of the destination site.
+   * @returns {Promise<string>} The API response confirming the site change.
+   */
   changeGroupSite(params, groupId, newSiteId) {
     const resourceUri = this._httpHelper._config.ResourceUri.ChangeGroupSite;
     const data = {
@@ -1786,62 +2499,160 @@ var SitesManager = class {
 // lib/vvRestApi/usersManager.js
 init_cjs_shims();
 var UsersManager = class {
+  /**
+   * @param {object} httpHelper - HTTP helper instance
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Retrieves all users belonging to a site.
+   * @param {object} params - Optional query parameters for filtering and pagination.
+   * @param {string} siteId - The ID of the site to retrieve users from.
+   * @returns {Promise<string>} The API response containing the list of users.
+   */
   getUsers(params, siteId) {
     const resourceUri = this._httpHelper._config.ResourceUri.Users.replace("{id}", siteId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Creates a new user within a site.
+   * @param {object} params - Optional query parameters.
+   * @param {object} data - User properties to create.
+   * @param {string} data.userId - Username (required if emailAddress is omitted; defaults to emailAddress when omitted).
+   * @param {string} data.emailAddress - User email address (required if userId is omitted).
+   * @param {string} [data.firstName] - User first name.
+   * @param {string} [data.middleInitial] - User middle initial.
+   * @param {string} [data.lastName] - User last name.
+   * @param {string} [data.password] - Initial password.
+   * @param {boolean} [data.mustChangePassword] - Whether the user must change their password on first login.
+   * @param {boolean} [data.sendEmail] - Whether to send a welcome email; defaults to true.
+   * @param {boolean} [data.passwordNeverExpires] - Whether the password never expires.
+   * @param {string} [data.passwordExpires] - Date when the password expires.
+   * @param {boolean} [data.getPasswordResetToken] - If true, the response includes a password reset token.
+   * @param {string} [data.employeeId] - Employee ID.
+   * @param {string} [data.employmentStatus] - Employment status.
+   * @param {string} siteId - The ID of the site to create the user in.
+   * @returns {Promise<string>} The API response containing the created user.
+   */
   postUsers(params, data, siteId) {
     const resourceUri = this._httpHelper._config.ResourceUri.Users.replace("{id}", siteId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "POST" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Updates a user within a site.
+   * @param {object} params - Optional query parameters.
+   * @param {object} data - User properties to update.
+   * @param {string} [data.firstName] - New first name.
+   * @param {string} [data.middleInitial] - New middle initial.
+   * @param {string} [data.lastName] - New last name.
+   * @param {string} [data.emailAddress] - New email address.
+   * @param {string} [data.userId] - New username.
+   * @param {string} [data.password] - New password.
+   * @param {boolean} [data.mustChangePassword] - Whether the user must change their password on next login.
+   * @param {boolean} [data.passwordNeverExpires] - Whether the password never expires.
+   * @param {string} [data.passwordExpires] - Date when the password expires.
+   * @param {string} [data.employeeId] - Employee ID.
+   * @param {string} [data.employmentStatus] - Employment status.
+   * @param {string} siteId - The ID of the site the user belongs to.
+   * @param {string} usId - The ID of the user to update.
+   * @returns {Promise<string>} The API response containing the updated user.
+   */
   putUsers(params, data, siteId, usId) {
     const resourceUri = this._httpHelper._config.ResourceUri.Users.replace("{id}", siteId);
     const url = this._httpHelper.getUrl(resourceUri + "/" + usId);
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Updates a user via the users endpoint (without site context).
+   * When updating own profile: supports `newPassword`+`oldPassword`, `emailAddress`, and `firstName`+`lastName`.
+   * When an admin updates another user: supports `isVaultAccess` and `enabled` in addition to profile fields.
+   * @param {object} params - Optional query parameters.
+   * @param {object} data - User properties to update.
+   * @param {string} [data.firstName] - New first name.
+   * @param {string} [data.lastName] - New last name.
+   * @param {string} [data.emailAddress] - New email address.
+   * @param {string} [data.newPassword] - New password (requires oldPassword).
+   * @param {string} [data.oldPassword] - Current password (required when changing password).
+   * @param {boolean} [data.isVaultAccess] - Whether the user has vault (account owner) access; admin only.
+   * @param {boolean} [data.enabled] - Whether the user account is enabled; admin only.
+   * @param {string} usId - The ID of the user to update.
+   * @returns {Promise<string>} The API response containing the updated user.
+   */
   putUsersEndpoint(params, data, usId) {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.User + "/" + usId);
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Retrieves users matching optional query parameters.
+   * @param {object} params - Optional query parameters for filtering and pagination.
+   * @returns {Promise<string>} The API response containing the matching users.
+   */
   getUser(params) {
     const resourceUri = this._httpHelper._config.ResourceUri.User;
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves a specific user by their ID.
+   * @param {object} params - Optional query parameters.
+   * @param {string} usId - The ID of the user to retrieve.
+   * @returns {Promise<string>} The API response containing the user.
+   */
   getUserById(params, usId) {
     const resourceUri = this._httpHelper._config.ResourceUri.UserById.replace("{id}", usId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves the groups a user belongs to.
+   * @param {object} params - Optional query parameters for filtering and pagination.
+   * @param {string} usId - The ID of the user.
+   * @returns {Promise<string>} The API response containing the user's groups.
+   */
   getUserGroups(params, usId) {
     const resourceUri = this._httpHelper._config.ResourceUri.UserGroups.replace("{id}", usId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves the supervisors of a user.
+   * @param {object} params - Optional query parameters for filtering and pagination.
+   * @param {string} usId - The ID of the user.
+   * @returns {Promise<string>} The API response containing the user's supervisors.
+   */
   getUserSupervisors(params, usId) {
     const resourceUri = this._httpHelper._config.ResourceUri.UserSupervisors.replace("{id}", usId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves the supervisees of a user.
+   * @param {object} params - Optional query parameters for filtering and pagination.
+   * @param {string} usId - The ID of the user.
+   * @returns {Promise<string>} The API response containing the user's supervisees.
+   */
   getUserSupervisees(params, usId) {
     const resourceUri = this._httpHelper._config.ResourceUri.UserSupervisees.replace("{id}", usId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves a web login token for a user.
+   * @param {string} usId - The ID of the user.
+   * @returns {Promise<string>} The API response containing the user's login token.
+   */
   getUserLoginToken(usId) {
     const resourceUri = this._httpHelper._config.ResourceUri.UserWebToken.replace("{id}", usId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -1849,6 +2660,11 @@ var UsersManager = class {
     const params = [];
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves a JWT for the current user, optionally scoped to an audience.
+   * @param {string} [audience] - The intended audience for the JWT.
+   * @returns {Promise<string>} The API response containing the JWT token data.
+   */
   getUserJwt(audience) {
     const resourceUri = this._httpHelper._config.ResourceUri.UsersGetJwt;
     const url = this._httpHelper.getUrl(resourceUri);
@@ -1859,6 +2675,10 @@ var UsersManager = class {
     }
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves the currently authenticated user's profile.
+   * @returns {Promise<string>} The API response containing the current user's data.
+   */
   getCurrentUser() {
     const resourceUri = this._httpHelper._config.ResourceUri.UsersMe;
     const url = this._httpHelper.getUrl(resourceUri);
@@ -1866,6 +2686,12 @@ var UsersManager = class {
     const params = [];
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Resets a user's password, optionally sending a notification email.
+   * @param {string} usId - The ID of the user whose password to reset.
+   * @param {boolean} [sendEmail=true] - Whether to send a password reset email to the user.
+   * @returns {Promise<string>} The API response confirming the password reset.
+   */
   resetPassword(usId, sendEmail = true) {
     const resourceUri = this._httpHelper._config.ResourceUri.UsersPassword.replace("{id}", usId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -1877,6 +2703,12 @@ var UsersManager = class {
     };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Updates the username (userId) of an existing user.
+   * @param {string} usId - The ID of the user to update.
+   * @param {string} newUserId - The new username to assign.
+   * @returns {Promise<string>} The API response confirming the update.
+   */
   updateUserId(usId, newUserId) {
     const resourceUri = this._httpHelper._config.ResourceUri.UsersIdUserId.replace("{id}", usId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -1892,13 +2724,16 @@ var UsersManager = class {
 // lib/vvRestApi/currentUserManager.js
 init_cjs_shims();
 var CurrentUserManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
   /**
    * Gets the currently authenticated user's information.
-   * @param {Object} [params] - Optional query parameters.
-   * @returns {Promise<string>} A promise that resolves with the current user's information as a JSON string.
+   * @param {object} [params] - Optional query parameters to include in the request.
+   * @returns {Promise<string>} JSON string containing the current user's details.
    */
   async getCurrentUser(params) {
     var resourceUri = this._httpHelper._config.ResourceUri.UsersMe;
@@ -1911,9 +2746,20 @@ var CurrentUserManager = class {
 // lib/vvRestApi/scheduledProcessManager.js
 init_cjs_shims();
 var ScheduledProcessManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Posts a completion status for a scheduled process.
+   * @param {string} id - The ID of the scheduled process to complete.
+   * @param {string} action - The action taken by the scheduled process.
+   * @param {boolean|string} result - The result of the scheduled process execution.
+   * @param {string} [message] - An optional message describing the result.
+   * @returns {Promise<string>} JSON string confirming the completion was recorded.
+   */
   postCompletion(id, action, result, message) {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.ScheduledProcess) + "/" + id;
     const opts = { method: "POST" };
@@ -1928,6 +2774,10 @@ var ScheduledProcessManager = class {
     }
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Triggers an immediate run of all pending scheduled processes.
+   * @returns {Promise<string>} JSON string confirming the scheduled processes were triggered.
+   */
   runAllScheduledProcesses() {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.ScheduledProcess) + "/Run";
     const opts = { method: "PUT" };
@@ -1938,9 +2788,18 @@ var ScheduledProcessManager = class {
 // lib/vvRestApi/customQueryManager.js
 init_cjs_shims();
 var CustomQueryManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Retrieves the results of a custom query by its name.
+   * @param {string} queryName - The name of the custom query to execute.
+   * @param {object} [params] - Optional URL parameters to include in the request.
+   * @returns {Promise<string>} JSON string containing the custom query results.
+   */
   getCustomQueryResultsByName(queryName, params) {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.CustomQuery);
     const opts = { method: "GET" };
@@ -1950,6 +2809,12 @@ var CustomQueryManager = class {
     params.queryName = queryName;
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves the results of a custom query by its ID.
+   * @param {string} id - The ID (Guid) of the custom query to execute.
+   * @param {object} [params] - Optional URL parameters to include in the request.
+   * @returns {Promise<string>} JSON string containing the custom query results.
+   */
   getCustomQueryResultsById(id, params) {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.CustomQuery + "/" + id);
     const opts = { method: "GET" };
@@ -1963,9 +2828,18 @@ var CustomQueryManager = class {
 // lib/vvRestApi/customerManager.js
 init_cjs_shims();
 var CustomerManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Creates a new customer invitation.
+   * @param {object} data - The invitation data to submit in the request body.
+   * @param {string} [data.email] - The email address to send the invitation code to. If omitted, the invite code is returned in the response metadata instead.
+   * @returns {Promise<string>} The API response containing the created invitation details.
+   */
   createCustomerInvite(data) {
     const baseUrl = this._httpHelper._sessionToken.baseUrl;
     let url = baseUrl + "/api/v1/" + this._httpHelper._config.ResourceUri.CustomerInvite;
@@ -1974,6 +2848,14 @@ var CustomerManager = class {
     const opts = { method: "POST" };
     return this._httpHelper.doVvClientRequest(url, opts, "", data);
   }
+  /**
+   * Assigns a user to a customer.
+   * @param {string} customerId - The ID (Guid) of the customer to assign the user to.
+   * @param {object} data - The user assignment data to submit in the request body.
+   * @param {string} data.userId - The username (authentication user ID) of the user to assign.
+   * @param {boolean} [data.allowMultipleCustomers] - Whether to allow the user to belong to multiple customers if already assigned to another.
+   * @returns {Promise<string>} The API response confirming the user assignment.
+   */
   assignUser(customerId, data) {
     const baseUrl = this._httpHelper._sessionToken.baseUrl;
     const url = baseUrl + "/api/v1/" + this._httpHelper._config.ResourceUri.CustomerAssignUser.replace("{customerId}", customerId);
@@ -1987,15 +2869,31 @@ init_cjs_shims();
 var import_debug4 = __toESM(require("debug"), 1);
 var debug4 = (0, import_debug4.default)("visualvault:customer-db");
 var CustomerDatabaseManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Assigns a user to a customer database.
+   * @param {string} customerId - The ID (Guid) of the customer database to assign the user to.
+   * @param {object} data - The user assignment data to submit in the request body.
+   * @param {string} data.userId - The username (authentication user ID) of the user to assign.
+   * @returns {Promise<string>} The API response confirming the user assignment.
+   */
   assignUser(customerId, data) {
     const baseUrl = this._httpHelper._sessionToken.baseUrl;
     const url = baseUrl + "/api/v1/" + this._httpHelper._config.ResourceUri.CustomerDatabaseAssignUser.replace("{databaseId}", customerId);
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, "", data);
   }
+  /**
+   * Removes a user from a customer database.
+   * @param {string} authenticationUserId - The authentication user ID of the user to remove.
+   * @param {string} databaseId - The ID (Guid) of the customer database to remove the user from.
+   * @returns {Promise<string>} The API response confirming the user removal.
+   */
   removeUser(authenticationUserId, databaseId) {
     const baseUrl = this._httpHelper._sessionToken.baseUrl;
     let url = baseUrl + "/api/v1" + this._httpHelper._config.ResourceUri.UserDelete.replace("{databaseId}", databaseId);
@@ -2010,21 +2908,49 @@ var CustomerDatabaseManager = class {
 // lib/vvRestApi/filesManager.js
 init_cjs_shims();
 var FilesManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Downloads file bytes using a query string path.
+   * @param {string} query - The query string to append to the files resource URI.
+   * @returns {Promise<Buffer>} The API response containing the raw file bytes.
+   */
   getFileBytesQuery(query) {
     const resourceUri = this._httpHelper._config.ResourceUri.FilesQuery + query;
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GETSTREAM" };
     return this._httpHelper.doVvClientRequest(url, opts, null, null);
   }
+  /**
+   * Downloads file bytes by file ID.
+   * @param {string} id - The ID (Guid) of the file to download.
+   * @returns {Promise<Buffer>} The API response containing the raw file bytes.
+   */
   getFileBytesId(id) {
     const resourceUri = this._httpHelper._config.ResourceUri.FilesId.replace("{id}", id);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GETSTREAM" };
     return this._httpHelper.doVvClientRequest(url, opts, null, null);
   }
+  /**
+   * Uploads a file to the VVRestApi.
+   * @param {object} data - The file metadata to include in the request body.
+   * @param {string} [data.fileId] - The file revision ID of the document to update. Required if documentId is not provided.
+   * @param {string} [data.documentId] - The document ID of the document to update. Required if fileId is not provided.
+   * @param {string} [data.fileName] - The filename to assign to the uploaded file.
+   * @param {string} [data.revision] - The revision label to assign to the new revision.
+   * @param {string} [data.changeReason] - The reason for uploading a new revision.
+   * @param {string} [data.checkInDocumentState] - The document state after check-in: "Released", "Unreleased", or "Replace". Defaults to "Released".
+   * @param {boolean} [data.checkIn] - Whether to check in the document after upload. Defaults to true.
+   * @param {string} [data.indexFields] - JSON-serialized index fields; accepts an array of `{"fieldLabel": "value"}` objects or a single object with field labels as keys.
+   * @param {string} [data.parameters] - JSON string with optional upload parameters: `source`, `command`, `ocrStatus`, `keepAnnotations`.
+   * @param {Uint8Array} buffer - The raw file bytes to upload.
+   * @returns {Promise<string>} The API response containing the uploaded file details.
+   */
   postFile(data, buffer) {
     const resourceUri = this._httpHelper._config.ResourceUri.Files;
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2036,9 +2962,19 @@ var FilesManager = class {
 // lib/vvRestApi/scriptsManager.js
 init_cjs_shims();
 var ScriptsManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Executes a named web service script.
+   * @param {string} serviceName - The name of the web service script to run.
+   * @param {object} serviceData - The data to pass to the script in the request body.
+   * @param {string} [usId] - The user session ID to run the script on behalf of.
+   * @returns {Promise<string>} JSON string containing the script execution result.
+   */
   runWebService(serviceName, serviceData, usId) {
     let resourceUri = this._httpHelper._config.ResourceUri.Scripts + "?name=" + serviceName;
     if (typeof usId !== "undefined" && usId !== null) {
@@ -2048,6 +2984,12 @@ var ScriptsManager = class {
     const opts = { method: "POST" };
     return this._httpHelper.doVvClientRequest(url, opts, null, serviceData);
   }
+  /**
+   * Completes a workflow web service execution and returns variables to the workflow.
+   * @param {string} executionId - The ID of the workflow script execution to complete.
+   * @param {object[]} workflowVariables - The workflow variables to return upon completion.
+   * @returns {Promise<string>} JSON string confirming the workflow completion was recorded.
+   */
   completeWorkflowWebService(executionId, workflowVariables) {
     const resourceUri = this._httpHelper._config.ResourceUri.ScriptsCompleteWf;
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2063,57 +3005,135 @@ var ScriptsManager = class {
 // lib/vvRestApi/documentsManager.js
 init_cjs_shims();
 var DocumentsManager = class {
+  /**
+   * @param {object} httpHelper - HTTP helper instance
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Creates a new document record.
+   * @param {object} data - Document metadata.
+   * @param {string} data.folderId - The Guid of the destination folder.
+   * @param {string} [data.name] - Display name for the document.
+   * @param {string} [data.description] - Document description.
+   * @param {string} [data.revision] - Revision label (e.g. "0").
+   * @param {string} [data.documentState] - Check-in state (e.g. "Released", "Checked In").
+   * @param {string} [data.filename] - File name for the document.
+   * @param {number} [data.fileLength] - File size in bytes.
+   * @param {string} [data.indexFields] - JSON-serialized index field key-value pairs.
+   * @param {string} [data.allowNoFile] - Set to "true" to create without a file.
+   * @returns {Promise<string>} The API response containing the created document.
+   */
   postDoc(data) {
     const resourceUri = this._httpHelper._config.ResourceUri.DocumentsPost;
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "POST" };
     return this._httpHelper.doVvClientRequest(url, opts, null, data);
   }
+  /**
+   * Creates a new document record with an attached file.
+   * @param {object} data - Document metadata to create.
+   * @param {string} data.folderId - The Guid of the destination folder.
+   * @param {string} [data.name] - Display name for the document.
+   * @param {string} [data.description] - Document description.
+   * @param {string} [data.revision] - Revision label (e.g. "0").
+   * @param {string} [data.documentState] - Check-in state (e.g. "Released", "Checked In").
+   * @param {string} [data.filename] - File name for the document.
+   * @param {number} [data.fileLength] - File size in bytes.
+   * @param {string} [data.indexFields] - JSON-serialized index field key-value pairs.
+   * @param {Uint8Array} fileData - The file content to upload.
+   * @returns {Promise<string>} The API response containing the created document.
+   */
   postDocWithFile(data, fileData) {
     const resourceUri = this._httpHelper._config.ResourceUri.DocumentsPost;
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "POSTSTREAM" };
     return this._httpHelper.doVvClientRequest(url, opts, null, data, fileData);
   }
+  /**
+   * Copies a document to a new location.
+   * @param {object} params - Optional query parameters.
+   * @param {object} data - Copy options.
+   * @param {string} data.folderId - The Guid of the destination folder to copy the document into.
+   * @param {string} documentId - The Id of the document to copy.
+   * @returns {Promise<string>} The API response containing the copied document.
+   */
   copyDocument(params, data, documentId) {
     const resourceUri = this._httpHelper._config.ResourceUri.DocumentsIdCopy.replace("{id}", documentId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "POST" };
     return this._httpHelper.doVvClientRequest(url, opts, null, data);
   }
+  /**
+   * Moves a document to a different folder.
+   * @param {object} params - Optional query parameters.
+   * @param {object} data - Move options.
+   * @param {string} data.folderId - The Guid of the destination folder to move the document into.
+   * @param {string} documentId - The Id of the document to move.
+   * @returns {Promise<string>} The API response containing the updated document.
+   */
   moveDocument(params, data, documentId) {
     const resourceUri = this._httpHelper._config.ResourceUri.DocumentsIdMove.replace("{id}", documentId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Deletes a specific document.
+   * @param {object} params - Optional query parameters.
+   * @param {string} revisionId - The Id of the document revision to delete.
+   * @returns {Promise<string>} The API response confirming the deletion.
+   */
   deleteDocument(params, revisionId) {
     const resourceUri = this._httpHelper._config.ResourceUri.DocumentsId.replace("{id}", revisionId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "DELETE" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves metadata for a specific document.
+   * @param {object} params - Optional query parameters.
+   * @param {string} revisionId - The revision Id of the document to retrieve.
+   * @returns {Promise<string>} The API response containing the document metadata.
+   */
   getDocumentRevision(params, revisionId) {
     const resourceUri = this._httpHelper._config.ResourceUri.DocumentsId.replace("{id}", revisionId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves a list of documents matching the given query parameters.
+   * @param {object} params - Query parameters for filtering, sorting, and pagination.
+   * @returns {Promise<string>} The API response containing the matching documents.
+   */
   getDocuments(params) {
     const resourceUri = this._httpHelper._config.ResourceUri.DocumentsPost;
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Updates the index fields on a document.
+   * @param {object} data - Index field values to update.
+   * @param {string} data.indexFields - JSON-serialized index fields; accepts a JSON array of `{"fieldLabel": "value"}` objects or a single `{"fieldLabel": "value"}` object where keys are field labels or Guid IDs.
+   * @param {string} documentId - The Id of the document to update.
+   * @returns {Promise<string>} The API response confirming the update.
+   */
   putDocumentIndexFields(data, documentId) {
     const resourceUri = this._httpHelper._config.ResourceUri.DocumentIndexFields.replace("{id}", documentId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, null, data);
   }
+  /**
+   * Subscribes a user to alert notifications for a specific document event.
+   * @param {string} documentId - The Id of the document to subscribe to.
+   * @param {string} eventId - The Id of the event to subscribe to.
+   * @param {string} userId - The Id of the user to subscribe.
+   * @returns {Promise<string>} The API response confirming the subscription.
+   */
   postDocumentAlertSubscription(documentId, eventId, userId) {
     const resourceUri = this._httpHelper._config.ResourceUri.DocumentAlertsId.replace("{documentId}", documentId).replace("{eventId}", eventId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2123,6 +3143,13 @@ var DocumentsManager = class {
     };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Removes a user's subscription to alert notifications for a specific document event.
+   * @param {string} documentId - The Id of the document.
+   * @param {string} eventId - The Id of the event to unsubscribe from.
+   * @param {string} userId - The Id of the user to unsubscribe.
+   * @returns {Promise<string>} The API response confirming the unsubscription.
+   */
   deleteDocumentAlertSubscription(documentId, eventId, userId) {
     const resourceUri = this._httpHelper._config.ResourceUri.DocumentAlertsId.replace("{documentId}", documentId).replace("{eventId}", eventId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2132,12 +3159,25 @@ var DocumentsManager = class {
     };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves OCR processing properties for a specific document revision.
+   * @param {object} params - Optional query parameters.
+   * @param {string} revisionId - The revision Id of the document.
+   * @returns {Promise<string>} The API response containing the OCR properties.
+   */
   getDocumentRevisionOcrProperties(params, revisionId) {
     const resourceUri = this._httpHelper._config.ResourceUri.DocumentsIdOcr.replace("{id}", revisionId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Creates a relationship between two document revisions.
+   * @param {string} revisionId - The Id of the source document revision.
+   * @param {string} relateToRevisionId - The revision Id of the document to relate to.
+   * @param {string} relateType - The type of relationship to create.
+   * @returns {Promise<string>} The API response confirming the relation.
+   */
   relateDocuments(revisionId, relateToRevisionId, relateType) {
     const resourceUri = this._httpHelper._config.ResourceUri.DocumentsIdRelateDocument.replace("{id}", revisionId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2148,6 +3188,12 @@ var DocumentsManager = class {
     };
     return this._httpHelper.doVvClientRequest(url, opts, null, data);
   }
+  /**
+   * Sets or updates the expiration date on a document.
+   * @param {string} documentId - The Id of the document to update.
+   * @param {string} expirationDate - The expiration date in ISO 8601 format.
+   * @returns {Promise<string>} The API response confirming the update.
+   */
   updateDocumentExpiration(documentId, expirationDate) {
     const resourceUri = this._httpHelper._config.ResourceUri.DocumentsIdExpiration.replace("{id}", documentId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2157,18 +3203,34 @@ var DocumentsManager = class {
     };
     return this._httpHelper.doVvClientRequest(url, opts, null, data);
   }
+  /**
+   * Retrieves the WebDAV URL for a document.
+   * @param {string} documentId - The Id of the document.
+   * @returns {Promise<string>} The API response containing the WebDAV URL.
+   */
   getDocumentWebDavUrl(documentId) {
     const resourceUri = this._httpHelper._config.ResourceUri.DocumentsWebDavUrl.replace("{id}", documentId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, null, null);
   }
+  /**
+   * Retrieves the WOPI URL for a document.
+   * @param {string} documentId - The Id of the document.
+   * @returns {Promise<string>} The API response containing the WOPI URL.
+   */
   getDocumentWopiUrl(documentId) {
     const resourceUri = this._httpHelper._config.ResourceUri.DocumentsWopiUrl.replace("{id}", documentId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, null, null);
   }
+  /**
+   * Initiates creation of a zip archive containing multiple documents.
+   * @param {object} params - Optional query parameters.
+   * @param {string[]} documentIds - Array of document Ids to include in the zip.
+   * @returns {Promise<string>} The API response containing a download key for polling zip status.
+   */
   createDocumentZipFile(params, documentIds) {
     const resourceUri = this._httpHelper._config.ResourceUri.CreateDocumentZipFile;
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2176,24 +3238,47 @@ var DocumentsManager = class {
     const data = { documentDhIds: documentIds };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Checks the status of a zip file creation request initiated by createDocumentZipFile.
+   * @param {object} params - Optional query parameters.
+   * @param {string} downloadKey - The download key returned from createDocumentZipFile.
+   * @returns {Promise<string>} The API response containing the zip status and download URL.
+   */
   getDocumentZipFileStatus(params, downloadKey) {
     const resourceUri = this._httpHelper._config.ResourceUri.GetDocumentZipFileStatus + `?downloadKey=${encodeURIComponent(downloadKey)}`;
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves the index fields and their values for a specific document.
+   * @param {object} params - Optional query parameters.
+   * @param {string} documentId - The Id of the document.
+   * @returns {Promise<string>} The API response containing the document's index fields.
+   */
   getDocumentIndexFields(params, documentId) {
     const resourceUri = this._httpHelper._config.ResourceUri.DocumentIndexFields.replace("{id}", documentId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves available document types defined in the vault.
+   * @param {object} params - Optional query parameters for filtering.
+   * @returns {Promise<string>} The API response containing the document types.
+   */
   getDocumentTypes(params) {
     const resourceUri = this._httpHelper._config.ResourceUri.DocumentTypes;
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Creates a new document type in the vault.
+   * @param {object} params - Optional query parameters.
+   * @param {string} name - The name of the document type to create.
+   * @returns {Promise<string>} The API response containing the created document type.
+   */
   createDocumentType(params, name) {
     const resourceUri = this._httpHelper._config.ResourceUri.DocumentTypes;
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2201,18 +3286,34 @@ var DocumentsManager = class {
     const data = { documentTypeName: name };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Retrieves saved document searches available to the current user.
+   * @param {object} params - Optional query parameters for filtering.
+   * @returns {Promise<string>} The API response containing the saved searches.
+   */
   getSavedSearches(params) {
     const resourceUri = this._httpHelper._config.ResourceUri.SavedSearches;
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves available document metadata fields defined in the vault.
+   * @param {object} params - Optional query parameters for filtering.
+   * @returns {Promise<string>} The API response containing the document fields.
+   */
   getDocumentFields(params) {
     const resourceUri = this._httpHelper._config.ResourceUri.DocumentFields;
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves the index fields associated with a saved search.
+   * @param {object} params - Optional query parameters.
+   * @param {string} savedSearchId - The Id of the saved search.
+   * @returns {Promise<string>} The API response containing the saved search's index fields.
+   */
   getSavedSearchIndexFields(params, savedSearchId) {
     const resourceUri = this._httpHelper._config.ResourceUri.SavedSearchIndexFields;
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2220,24 +3321,46 @@ var DocumentsManager = class {
     const mergedParams = { ...params, savedSearchId };
     return this._httpHelper.doVvClientRequest(url, opts, mergedParams, null);
   }
+  /**
+   * Retrieves the most recently accessed documents for the current user.
+   * @param {object} params - Optional query parameters for filtering and pagination.
+   * @returns {Promise<string>} The API response containing the recent documents.
+   */
   getLastDocuments(params) {
     const resourceUri = this._httpHelper._config.ResourceUri.LastDocuments;
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves the most frequently accessed documents for the current user.
+   * @param {object} params - Optional query parameters for filtering and pagination.
+   * @returns {Promise<string>} The API response containing the frequent documents.
+   */
   getFrequentDocuments(params) {
     const resourceUri = this._httpHelper._config.ResourceUri.FrequentDocuments;
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves documents matching a saved search.
+   * @param {object} params - Optional query parameters for filtering and pagination.
+   * @param {string} savedSearchId - The Id of the saved search to execute.
+   * @returns {Promise<string>} The API response containing the matching documents.
+   */
   getSavedSearchDocuments(params, savedSearchId) {
     const resourceUri = this._httpHelper._config.ResourceUri.SavedSearchDocuments.replace("{savedSearchId}", savedSearchId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves the default action link for a document.
+   * @param {object} params - Optional query parameters.
+   * @param {string} documentId - The Id of the document.
+   * @returns {Promise<string>} The API response containing the default action link.
+   */
   getDocumentDefaultLink(params, documentId) {
     const resourceUri = this._httpHelper._config.ResourceUri.DocumentDefaultAction.replace("{documentId}", documentId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2249,9 +3372,19 @@ var DocumentsManager = class {
 // lib/vvRestApi/projectsManager.js
 init_cjs_shims();
 var ProjectsManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Subscribes a user to alerts for a specific project event.
+   * @param {string} projectId - The ID (Guid) of the project to subscribe to.
+   * @param {string} eventId - The ID (Guid) of the project event to subscribe to.
+   * @param {string} userId - The ID (Guid) of the user to subscribe.
+   * @returns {Promise<string>} JSON string confirming the alert subscription was created.
+   */
   postProjectAlertSubscription(projectId, eventId, userId) {
     const resourceUri = this._httpHelper._config.ResourceUri.ProjectAlertsId.replace("{projectId}", projectId).replace("{eventId}", eventId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2261,6 +3394,13 @@ var ProjectsManager = class {
     };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Removes a user's subscription from alerts for a specific project event.
+   * @param {string} projectId - The ID (Guid) of the project to unsubscribe from.
+   * @param {string} eventId - The ID (Guid) of the project event to unsubscribe from.
+   * @param {string} userId - The ID (Guid) of the user to unsubscribe.
+   * @returns {Promise<string>} JSON string confirming the alert subscription was removed.
+   */
   deleteProjectAlertSubscription(projectId, eventId, userId) {
     const resourceUri = this._httpHelper._config.ResourceUri.ProjectAlertsId.replace("{projectId}", projectId).replace("{eventId}", eventId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2275,15 +3415,29 @@ var ProjectsManager = class {
 // lib/vvRestApi/indexFieldsManager.js
 init_cjs_shims();
 var IndexFieldsManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Retrieves all index fields.
+   * @param {object} params - URL parameters to include in the request.
+   * @returns {Promise<string>} JSON string containing the list of index fields.
+   */
   getIndexFields(params) {
     const resourceUri = this._httpHelper._config.ResourceUri.IndexFields;
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves a specific index field by its ID.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {string} id - The ID (Guid) of the index field to retrieve.
+   * @returns {Promise<string>} JSON string containing the index field details.
+   */
   getIndexField(params, id) {
     const resourceUri = this._httpHelper._config.ResourceUri.IndexFields + "/" + id;
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2291,24 +3445,24 @@ var IndexFieldsManager = class {
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
   /**
-   * Payload for creating/updating index fields.
-   * @typedef {Object} IndexFieldData
+   * Payload for creating or updating index fields.
+   * @typedef {object} IndexFieldData
    * @property {string} fieldType
    * @property {string} label
    * @property {string} [description]
    * @property {boolean} [required]
-   * @property {?string} [connectionId]
-   * @property {?string} [queryId]
-   * @property {?string} [queryDisplayField]
-   * @property {?string} [queryValueField]
-   * @property {?string} [dropDownListId]
-   * @property {?string} [defaultValue]
+   * @property {string|null} [connectionId]
+   * @property {string|null} [queryId]
+   * @property {string|null} [queryDisplayField]
+   * @property {string|null} [queryValueField]
+   * @property {string|null} [dropDownListId]
+   * @property {string|null} [defaultValue]
    */
   /**
-   * Create an index field
-   * @param {Object} params - Query parameters
-   * @param {IndexFieldData} data - Request body
-   * @returns {Promise<string>}
+   * Creates a new index field.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {IndexFieldData} data - The index field data to submit in the request body.
+   * @returns {Promise<string>} JSON string containing the created index field details.
    */
   createIndexField(params, data) {
     const resourceUri = this._httpHelper._config.ResourceUri.IndexFields;
@@ -2317,11 +3471,11 @@ var IndexFieldsManager = class {
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
   /**
-   * Update an index field
-   * @param {Object} params - Query parameters
-   * @param {string} id - Index field id
-   * @param {IndexFieldData} data - Request body
-   * @returns {Promise<string>}
+   * Updates an existing index field by its ID.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {string} id - The ID (Guid) of the index field to update.
+   * @param {IndexFieldData} data - The updated index field data to submit in the request body.
+   * @returns {Promise<string>} JSON string confirming the index field was updated.
    */
   updateIndexField(params, id, data) {
     const resourceUri = this._httpHelper._config.ResourceUri.IndexFields + "/" + id;
@@ -2329,12 +3483,25 @@ var IndexFieldsManager = class {
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Deletes an index field by its ID.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {string} id - The ID (Guid) of the index field to delete.
+   * @returns {Promise<string>} JSON string confirming the index field was deleted.
+   */
   deleteIndexField(params, id) {
     const resourceUri = this._httpHelper._config.ResourceUri.IndexFields + "/" + id;
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "DELETE" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Moves an index field to appear after a specified destination field.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {string} sourceFieldId - The ID (Guid) of the index field to move.
+   * @param {string} destinationFieldId - The ID (Guid) of the index field to place the source after.
+   * @returns {Promise<string>} JSON string confirming the index field was moved.
+   */
   moveIndexFieldAfter(params, sourceFieldId, destinationFieldId) {
     const resourceUri = this._httpHelper._config.ResourceUri.IndexFields + "/MoveIndexFieldAfter";
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2342,6 +3509,12 @@ var IndexFieldsManager = class {
     const data = { sourceFieldId, destinationFieldId };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Associates an index field with a folder.
+   * @param {string} indexFieldId - The ID (Guid) of the index field to associate.
+   * @param {string} folderId - The ID (Guid) of the folder to associate the index field with.
+   * @returns {Promise<string>} JSON string confirming the index field was added to the folder.
+   */
   addIndexFieldToFolder(indexFieldId, folderId) {
     const resourceUri = this._httpHelper._config.ResourceUri.IndexFieldsFolder.replace("{id}", indexFieldId).replace("{folderId}", folderId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2353,9 +3526,17 @@ var IndexFieldsManager = class {
 // lib/vvRestApi/outsideProcessesManager.js
 init_cjs_shims();
 var OutsideProcessesManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Retrieves a list of outside processes.
+   * @param {object} params - URL parameters to include in the request.
+   * @returns {Promise<string>} JSON string containing the list of outside processes.
+   */
   getOutsideProcesses(params) {
     const resourceUri = this._httpHelper._config.ResourceUri.OutsideProcesses;
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2367,9 +3548,20 @@ var OutsideProcessesManager = class {
 // lib/vvRestApi/securityMembersManager.js
 init_cjs_shims();
 var SecurityMembersManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Adds a user or group as a security member to a parent resource.
+   * @param {string} parentId - The ID (Guid) of the parent resource to add the member to.
+   * @param {string} memberId - The ID (Guid) of the user or group to add as a member.
+   * @param {string} roleType - The role to assign to the member on the parent resource.
+   * @param {boolean} isGroup - Whether the member being added is a group.
+   * @returns {Promise<string>} JSON string containing the created security member details.
+   */
   addSecurityMember(parentId, memberId, roleType, isGroup) {
     const resourceUri = this._httpHelper._config.ResourceUri.SecurityMembers;
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2382,6 +3574,11 @@ var SecurityMembersManager = class {
     };
     return this._httpHelper.doVvClientRequest(url, opts, null, postData);
   }
+  /**
+   * Retrieves all security members associated with a parent resource.
+   * @param {string} parentId - The ID (Guid) of the parent resource whose members to retrieve.
+   * @returns {Promise<string>} JSON string containing the list of security members.
+   */
   getSecurityMembersForParentId(parentId) {
     const resourceUri = this._httpHelper._config.ResourceUri.SecurityMembers;
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2391,6 +3588,12 @@ var SecurityMembersManager = class {
     };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Removes a security member from a parent resource.
+   * @param {string} parentId - The ID (Guid) of the parent resource to remove the member from.
+   * @param {string} memberId - The ID (Guid) of the user or group to remove.
+   * @returns {Promise<string>} JSON string confirming the security member was removed.
+   */
   removeSecurityMember(parentId, memberId) {
     const resourceUri = this._httpHelper._config.ResourceUri.SecurityMembers;
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2401,6 +3604,13 @@ var SecurityMembersManager = class {
     };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Updates the role of an existing security member on a parent resource.
+   * @param {string} parentId - The ID (Guid) of the parent resource containing the member.
+   * @param {string} memberId - The ID (Guid) of the user or group whose role to update.
+   * @param {string} roleType - The new role to assign to the member.
+   * @returns {Promise<string>} JSON string confirming the security member role was updated.
+   */
   updateSecurityMember(parentId, memberId, roleType) {
     const resourceUri = this._httpHelper._config.ResourceUri.SecurityMembers;
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2417,9 +3627,16 @@ var SecurityMembersManager = class {
 // lib/vvRestApi/layoutsManager.js
 init_cjs_shims();
 var LayoutsManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Retrieves the layout configuration for the current site.
+   * @returns {Promise<string>} JSON string containing the layout configuration.
+   */
   getLayout() {
     const resourceUri = this._httpHelper._config.ResourceUri.Layout;
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2431,15 +3648,29 @@ var LayoutsManager = class {
 // lib/vvRestApi/reportsManager.js
 init_cjs_shims();
 var ReportsManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Retrieves a list of available reports.
+   * @param {object} params - URL parameters to include in the request.
+   * @returns {Promise<string>} JSON string containing the list of reports.
+   */
   getReports(params) {
     const resourceUri = this._httpHelper._config.ResourceUri.Reports;
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Downloads a report as a PDF by its ID.
+   * @param {string} reportId - The ID (Guid) of the report to download.
+   * @param {object} params - URL parameters to include in the request.
+   * @returns {Promise<Buffer>} The API response containing the raw PDF file bytes.
+   */
   getReportPDF(reportId, params) {
     const resourceUri = this._httpHelper._config.ResourceUri.ReportServerPDF.replace("{id}", reportId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2451,29 +3682,55 @@ var ReportsManager = class {
 // lib/vvRestApi/languageResourcesManager.js
 init_cjs_shims();
 var LanguageResourcesManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   * @param {string} baseUrl - The base URL of the VisualVault server.
+   */
   constructor(httpHelper, baseUrl) {
     this._httpHelper = httpHelper;
     this._baseUrl = baseUrl;
     this._apiUrl = httpHelper._config.BaseApiUri;
   }
+  /**
+   * Retrieves available language areas.
+   * @param {object} params - URL parameters to include in the request.
+   * @returns {Promise<string>} JSON string containing the list of language areas.
+   */
   getLanguageAreas(params) {
     const resourceUri = this._httpHelper._config.ResourceUri.LanguageAreas;
     const url = this._baseUrl + this._apiUrl + resourceUri;
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves available languages.
+   * @param {object} params - URL parameters to include in the request.
+   * @returns {Promise<string>} JSON string containing the list of available languages.
+   */
   getLanguages(params) {
     const resourceUri = this._httpHelper._config.ResourceUri.Languages;
     const url = this._baseUrl + this._apiUrl + resourceUri;
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Exports language resource translations as a downloadable file.
+   * @param {object} params - URL parameters to include in the request.
+   * @returns {Promise<Buffer>} The API response containing the raw exported language file bytes.
+   */
   exportLanguages(params) {
     const resourceUri = this._httpHelper._config.ResourceUri.ExportLanguages;
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GETSTREAM" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Imports language resource translations from a file.
+   * @param {object} params - URL parameters containing the target area and language (params.area, params.lang).
+   * @param {Buffer} fileData - The raw file bytes of the language file to import.
+   * @param {string} fileName - The name of the file being imported.
+   * @returns {Promise<string>} JSON string confirming the language import was processed.
+   */
   importLanguages(params, fileData, fileName) {
     const resourceUri = this._httpHelper._config.ResourceUri.ImportLanguages;
     const url = this._httpHelper.getUrl(resourceUri) + `?area=${params.area}&lang=${params.lang}`;
@@ -2486,27 +3743,55 @@ var LanguageResourcesManager = class {
 // lib/vvRestApi/dropdownListsManager.js
 init_cjs_shims();
 var DropdownListsManager = class {
+  /**
+   * @param {object} httpHelper - The HTTP helper instance used to make API requests.
+   */
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  /**
+   * Retrieves all dropdown lists.
+   * @param {object} params - URL parameters to include in the request.
+   * @returns {Promise<string>} JSON string containing the list of dropdown lists.
+   */
   getDropDownLists(params) {
     const resourceUri = this._httpHelper._config.ResourceUri.DropDownLists;
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves a specific dropdown list by its ID.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {string} listId - The ID (Guid) of the dropdown list to retrieve.
+   * @returns {Promise<string>} JSON string containing the dropdown list details.
+   */
   getDropDownListById(params, listId) {
     const resourceUri = this._httpHelper._config.ResourceUri.DropDownListsId.replace("{id}", listId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Retrieves the items of a specific dropdown list by its ID.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {string} listId - The ID (Guid) of the dropdown list whose items to retrieve.
+   * @returns {Promise<string>} JSON string containing the dropdown list items.
+   */
   getDropDownListItemsById(params, listId) {
     const resourceUri = this._httpHelper._config.ResourceUri.DropDownListsIdItems.replace("{id}", listId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Creates a new dropdown list with the specified items.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {string} ddName - The name of the new dropdown list.
+   * @param {string} ddDescription - The description of the new dropdown list.
+   * @param {object[]} ddItems - The items to include in the new dropdown list.
+   * @returns {Promise<string>} JSON string containing the created dropdown list details.
+   */
   addDropDownList(params, ddName, ddDescription, ddItems) {
     const resourceUri = this._httpHelper._config.ResourceUri.DropDownLists;
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2518,12 +3803,27 @@ var DropdownListsManager = class {
     };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Deletes a dropdown list by its ID.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {string} listId - The ID (Guid) of the dropdown list to delete.
+   * @returns {Promise<string>} JSON string confirming the dropdown list was deleted.
+   */
   deleteDropDownList(params, listId) {
     const resourceUri = this._httpHelper._config.ResourceUri.DropDownListsId.replace("{id}", listId);
     const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "DELETE" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  /**
+   * Updates an existing dropdown list by its ID.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {string} listId - The ID (Guid) of the dropdown list to update.
+   * @param {string} ddName - The updated name for the dropdown list.
+   * @param {string} ddDescription - The updated description for the dropdown list.
+   * @param {object[]} items - The updated items for the dropdown list.
+   * @returns {Promise<string>} JSON string confirming the dropdown list was updated.
+   */
   updateDropDownList(params, listId, ddName, ddDescription, items) {
     const resourceUri = this._httpHelper._config.ResourceUri.DropDownListsId.replace("{id}", listId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2535,6 +3835,13 @@ var DropdownListsManager = class {
     };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
+  /**
+   * Deletes one or more items from a dropdown list.
+   * @param {object} params - URL parameters to include in the request.
+   * @param {string} listId - The ID (Guid) of the dropdown list containing the items to delete.
+   * @param {string[]} itemIds - Array of item IDs to delete from the dropdown list.
+   * @returns {Promise<string>} JSON string confirming the items were deleted.
+   */
   deleteDropDownListItem(params, listId, itemIds) {
     const resourceUri = this._httpHelper._config.ResourceUri.DropDownListsIdItems.replace("{id}", listId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2549,51 +3856,51 @@ var debug5 = (0, import_debug5.default)("visualvault:api");
 var __filename7 = (0, import_url6.fileURLToPath)(importMetaUrl);
 var __dirname6 = import_path6.default.dirname(__filename7);
 var VVClient = class {
-  /** @type {*} */
+  /** @type {Constants} */
   constants;
-  /** @type {*} */
+  /** @type {ConfigurationManager} */
   configuration;
-  /** @type {*} */
+  /** @type {CustomQueryManager} */
   customQuery;
-  /** @type {*} */
+  /** @type {DocumentsManager} */
   documents;
-  /** @type {*} */
+  /** @type {EmailManager} */
   email;
-  /** @type {*} */
+  /** @type {FilesManager} */
   files;
-  /** @type {*} */
+  /** @type {FormsManager} */
   forms;
-  /** @type {*} */
+  /** @type {GroupsManager} */
   groups;
-  /** @type {*} */
+  /** @type {LibraryManager} */
   library;
-  /** @type {*} */
+  /** @type {SitesManager} */
   sites;
-  /** @type {*} */
+  /** @type {UsersManager} */
   users;
-  /** @type {*} */
+  /** @type {ScheduledProcessManager} */
   scheduledProcess;
-  /** @type {*} */
+  /** @type {ScriptsManager} */
   scripts;
-  /** @type {*} */
+  /** @type {ProjectsManager} */
   projects;
-  /** @type {*} */
+  /** @type {CustomerManager} */
   customer;
-  /** @type {*} */
+  /** @type {CustomerDatabaseManager} */
   customerDatabase;
-  /** @type {*} */
+  /** @type {IndexFieldsManager} */
   indexFields;
-  /** @type {*} */
+  /** @type {OutsideProcessesManager} */
   outsideProcesses;
-  /** @type {*} */
+  /** @type {SecurityMembersManager} */
   securityMembers;
-  /** @type {*} */
+  /** @type {LayoutsManager} */
   layouts;
-  /** @type {*} */
+  /** @type {ReportsManager} */
   reports;
-  /** @type {*} */
+  /** @type {LanguageResourcesManager} */
   languageResources;
-  /** @type {*} */
+  /** @type {DropdownListsManager} */
   dropdownLists;
   /**
    * @param {*} sessionToken - Session token from authentication