@inweb/client 25.9.5 → 25.9.7

package/dist/client.js

@@ -144,8 +144,9 @@
     // acknowledge and accept the above terms.
     ///////////////////////////////////////////////////////////////////////////////
     /**
-     * Provides properties and methods for working with view of the file or assembly. For example,
-     * for `dwg` it is a `Model` space or layout, and for `rvt` files it is a `3D` view.
+     * Provides properties and methods for working with view of the {@link File | file} or
+     * {@link Assembly| assembly}. For example, for `dwg` it is a `Model` space or layout, and for
+     * `rvt` files it is a `3D` view.
      */
     class Model {
         /**
@@ -283,7 +284,7 @@
          * Saves a new model owner file/assembly viewpoint to the server. To create a new viewpoint
          * use `Viewer.createViewpoint()`.
          *
-         * @param viewpoint - Viewpoint.
+         * @param viewpoint - Viewpoint object.
          */
         saveViewpoint(viewpoint) {
             return this._file.saveViewpoint({
@@ -509,7 +510,8 @@
      */
     class ClashTest {
         /**
-         * @param data - Raw test data received from the server.
+         * @param data - Raw test data received from the server. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Assemblies | Open Cloud Assemblies API}.
          * @param basePath - The clash test API base path of the file/assembly that owns the test.
          * @param httpClient - HTTP client instance used to send requests to the REST API server.
          */
@@ -550,7 +552,8 @@
             return this.data.createdAt;
         }
         /**
-         * Raw test data received from the server.
+         * Raw test data received from the server. For more information, see
+         * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Assemblies | Open Cloud Assemblies API}.
          *
          * @readonly
          */
@@ -668,7 +671,8 @@
         /**
          * Updates test data on the server.
          *
-         * @param data - Raw test data.
+         * @param data - Raw test data. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Assemblies | Open Cloud Assemblies API}.
          */
         async update(data) {
             const response = await this.internalPut("", data);
@@ -678,7 +682,8 @@
         /**
          * Deletes a test and its results report from the server.
          *
-         * @returns Returns the raw data of a deleted test.
+         * @returns Returns the raw data of a deleted test. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Assemblies | Open Cloud Assemblies API}.
          */
         delete() {
             return this.internalDelete("").then((response) => response.json());
@@ -713,7 +718,7 @@
             return waitFor(checkDone, params).then(() => this);
         }
         /**
-         * Returns a report with the clash detection results for this test.
+         * Returns a list of detected clashes for this test.
          */
         getReport() {
             return this.internalGet("/report").then((response) => response.json());
@@ -748,8 +753,9 @@
      */
     class Assembly {
         /**
-         * @param data - Raw assembly data received from the server.
-         * @param httpClient - HTTP client instance used to send requests to the REST API server..
+         * @param data - Raw assembly data received from the server. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Assemblies | Open Cloud Assemblies API}.
+         * @param httpClient - HTTP client instance used to send requests to the REST API server.
          */
         constructor(data, httpClient) {
             this.path = `/assemblies/${data.id}`;
@@ -800,9 +806,8 @@
             return this.data.created;
         }
         /**
-         * Raw assembly data received from the server.
-         *
-         * @readonly
+         * Returns the raw assembly data received from the server. For more information, see
+         * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Assemblies | Open Cloud Assemblies API}.
          */
         get data() {
             return this._data;
@@ -913,7 +918,8 @@
         /**
          * Updates assembly data on the server.
          *
-         * @param data - Raw assembly data.
+         * @param data - Raw assembly data. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Assemblies | Open Cloud Assemblies API}.
          */
         async update(data) {
             const response = await this.internalPut("", data);
@@ -923,7 +929,8 @@
         /**
          * Deletes an assembly from the server.
          *
-         * @returns Returns the raw data of a deleted assembly.
+         * @returns Returns the raw data of a deleted assembly. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Assemblies | Open Cloud Assemblies API}.
          */
         delete() {
             return this.internalDelete("").then((response) => response.json());
@@ -971,12 +978,18 @@
             obj[handle] = transform;
             return this.update({ transform: obj });
         }
+        /**
+         * Object properties.
+         *
+         * @typedef {any} Properties
+         * @property {string} handle - Object original handle.
+         * @property {string | any} * - Object property. Can be `any` for nested properties.
+         */
         /**
          * Returns the properties for an objects in the assembly.
          *
          * @param handles - Object original handle or handles array. Specify `undefined` to get
          *   properties for all objects in the assembly.
-         * @returns {Promise<any>}
          */
         getProperties(handles) {
             const relativePath = handles !== undefined ? `/properties?handles=${handles}` : "/properties";
@@ -1017,7 +1030,8 @@
             return this.internalGet(`/properties/tree`).then((response) => response.json());
         }
         /**
-         * Returns a list of assembly viewpoints.
+         * Returns a list of assembly viewpoints. For more information, see
+         * {@link https://cloud.opendesign.com/docs//pages/server/api.html#AssemblyViewpoints | Open Cloud Assembly Viewpoints API}.
          */
         getViewpoints() {
             return this.internalGet("/viewpoints")
@@ -1027,7 +1041,8 @@
         /**
          * Saves a new assembly viewpoint to the server. To create a viewpoint use `Viewer.createViewpoint()`.
          *
-         * @param viewpoint - Viewpoint.
+         * @param viewpoint - Viewpoint object. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#AssemblyViewpoints | Open Cloud Assembly Viewpoints API}.
          */
         saveViewpoint(viewpoint) {
             return this.internalPost("/viewpoints", viewpoint).then((response) => response.json());
@@ -1036,13 +1051,14 @@
          * Deletes the specified assembly viewpoint.
          *
          * @param guid - Viewpoint GUID.
-         * @returns Returns the raw data of a deleted viewpoint.
+         * @returns Returns a deleted viewpoint. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#AssemblyViewpoints | Open Cloud Assembly Viewpoints API}.
          */
         deleteViewpoint(guid) {
             return this.internalDelete(`/viewpoints/${guid}`).then((response) => response.json());
         }
         /**
-         * Returns viewpoint snapshot as base64-encoded
+         * Returns the viewpoint snapshot as base64-encoded
          * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
          *
          * @param guid - Viewpoint GUID.
@@ -1051,7 +1067,7 @@
             return this.internalGet(`/viewpoints/${guid}/snapshot`).then((response) => response.text());
         }
         /**
-         * Returns viewpoint snapshot data.
+         * Returns the viewpoint snapshot data.
          *
          * @param guid - Viewpoint GUID.
          * @param bitmapGuid - Bitmap GUID.
@@ -1108,9 +1124,24 @@
         async downloadFileRange(requestId, records, dataId, onProgress, signal) {
             await this.downloadResourceRange(dataId, requestId, records, onProgress, signal);
         }
-        // Reserved for future use
-        getReferences(signal) {
-            return Promise.resolve({ fileId: "", references: [] });
+        /**
+         * Returns a list of assembly references containing references from all the files from which
+         * the assembly was created.
+         *
+         * References are images, fonts, or any other files to correct rendering of the assembly.
+         *
+         * @param signal - An
+         *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+         *   signal, which can be used to abort waiting as desired.
+         */
+        async getReferences(signal) {
+            const references = await Promise.all(this.associatedFiles
+                .map((file) => `/files/${file.fileId}/references`)
+                .map((link) => this.httpClient.get(link, signal).then((response) => response.json())))
+                .then((references) => references.map((x) => x.references))
+                .then((references) => references.reduce((x, v) => [...v, ...x], []))
+                .then((references) => [...new Set(references.map(JSON.stringify))].map((x) => JSON.parse(x)));
+            return { id: "", references };
         }
         /**
          * Waits for assembly to be created. Assembly is created when it changes to `done` or `failed` status.
@@ -1253,7 +1284,8 @@
          * Deletes the specified assembly clash test.
          *
          * @param testId - Test ID.
-         * @returns Returns the raw data of a deleted test.
+         * @returns Returns the raw data of a deleted test. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Assemblies | Open Cloud Assemblies API}.
          */
         deleteClashTest(testId) {
             return this.internalDelete(`/clashes/${testId}`).then((response) => response.json());
@@ -1621,11 +1653,12 @@
     ///////////////////////////////////////////////////////////////////////////////
     /**
      * Provides properties and methods for obtaining information about {@link File | file} actions
-     * granted to a specific {@link User | users}, or project {@link Member | member}.
+     * granted to a specific user, project, or group.
      */
     class Permission {
         /**
-         * @param data - Raw permission data received from the server.
+         * @param data - Raw permission data received from the server. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Permission | Open Cloud Permissions API}.
          * @param fileId - Owner file ID.
          * @param httpClient - HTTP client instance used to send requests to the REST API server.
          */
@@ -1651,6 +1684,20 @@
          * - `write` - The ability to modify file name, description and references.
          * - `readViewpoint` - The ability to read file viewpoints.
          * - `createViewpoint` - The ability to create file viewpoints.
+         *
+         * @example <caption>Change file permissions for the the specified project.</caption>
+         *   const myFile = client.getFile(myFileId);
+         *   const permissions = await myFile.getPermissions();
+         *   const projectPermissions = permissions.filter((permission) =>
+         *     permission.grantedTo.some((x) => x.project?.id === myProjectId)
+         *   );
+         *   const newActions = ["read", "readSourceFile", "update"];
+         *   await Promise.all(
+         *     projectPermissions.map((permission) => {
+         *       permission.actions = newActions;
+         *       return permission.save();
+         *     })
+         *   );
          */
         get actions() {
             return this.data.actions;
@@ -1659,7 +1706,8 @@
             this._data.actions = value;
         }
         /**
-         * Raw permission data received from the server.
+         * Raw permission data received from the server. For more information, see
+         * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Permission | Open Cloud Permissions API}.
          *
          * @readonly
          */
@@ -1678,7 +1726,7 @@
             return this.data.id;
         }
         /**
-         * A list of entities that will get access to the file.
+         * A list of users, projects, or groups that will get access to the file.
          */
         get grantedTo() {
             return this.data.grantedTo;
@@ -1706,18 +1754,8 @@
         /**
          * Updates permission data on the server.
          *
-         * @example <caption>Update file permissions for the the specified project.</caption>
-         *   const myFile = client.getFile(myFileId);
-         *   const permissions = await myFile.getPermissions();
-         *   const projectPermissions = permissions.filter((permission) =>
-         *     permission.grantedTo.some((x) => x.project?.id === myProjectId)
-         *   );
-         *   const newActions = ["read", "readSourceFile", "update"];
-         *   await Promise.allSettled(
-         *     projectPermissions.map((permission) => permission.update({ newActions }))
-         *   );
-         *
-         * @param data - Raw permission data.
+         * @param data - Raw permission data. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Permission | Open Cloud Permissions API}.
          */
         async update(data) {
             const response = await this.internalPut(data);
@@ -1727,7 +1765,8 @@
         /**
          * Removes a permission from the file.
          *
-         * @returns Returns the raw data of a deleted permission.
+         * @returns Returns the raw data of a deleted permission. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Permission | Open Cloud Permissions API}.
          */
         delete() {
             return this.internalDelete().then((response) => response.json());
@@ -1768,7 +1807,8 @@
      */
     class Job {
         /**
-         * @param data - Raw job data received from the server.
+         * @param data - Raw job data received from the server. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Jobs | Open Cloud Jobs API}.
          * @param httpClient - HTTP client instance used to send requests to the REST API server.
          */
         constructor(data, httpClient) {
@@ -1810,7 +1850,8 @@
             return this.data.createdAt;
         }
         /**
-         * Raw job data received from the server.
+         * Raw job data received from the server. For more information, see
+         * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Jobs | Open Cloud Jobs API}.
          *
          * @readonly
          */
@@ -1863,7 +1904,8 @@
             return this.data.outputFormat;
         }
         /**
-         * Parameters for the job runner.
+         * Parameters with which the job runner was started. For more information, see
+         * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Jobs | Open Cloud Jobs API}.
          *
          * @readonly
          */
@@ -1909,7 +1951,8 @@
          * Only administrators can update job data. If the current logged in user is not an
          * administrator, an exception will be thrown.
          *
-         * @param data - Raw job data.
+         * @param data - Raw job data. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Jobs | Open Cloud Jobs API}.
          */
         async update(data) {
             const response = await this.internalPut(data);
@@ -1920,7 +1963,8 @@
          * Deletes a job from the server job list. Jobs that are in progress or have already been
          * completed cannot be deleted.
          *
-         * @returns Returns the raw data of a deleted job.
+         * @returns Returns the raw data of a deleted job. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Jobs | Open Cloud Jobs API}.
          */
         delete() {
             return this.internalDelete().then((response) => response.json());
@@ -1984,7 +2028,8 @@
      */
     class File {
         /**
-         * @param data - Raw file data received from the server.
+         * @param data - Raw file data received from the server. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Files | Open Cloud Files API}.
          * @param httpClient - HTTP client instance used to send requests to the REST API server.
          */
         constructor(data, httpClient) {
@@ -2043,7 +2088,8 @@
             this.data.customFields = value;
         }
         /**
-         * Raw file data received from the server.
+         * Raw file data received from the server. For more information, see
+         * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Files | Open Cloud Files API}.
          *
          * @readonly
          */
@@ -2247,7 +2293,8 @@
         /**
          * Updates file data on the server.
          *
-         * @param data - Raw file data.
+         * @param data - Raw file data. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Files | Open Cloud Files API}.
          */
         async update(data) {
             const response = await this.internalPut("", data);
@@ -2260,7 +2307,8 @@
          * You cannot delete a version file using `delete()`, only the original file. To delete a
          * version file use {@link deleteVersion | deleteVersion()}.
          *
-         * @returns Returns the raw data of a deleted file.
+         * @returns Returns the raw data of a deleted file. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Files | Open Cloud Files API}.
          */
         delete() {
             return this.internalDelete("").then((response) => response.json());
@@ -2322,7 +2370,7 @@
          *
          * @typedef {any} Properties
          * @property {string} handle - Object original handle.
-         * @property {string | any} * - Object property. Can be `any` for nested properties.
+         * @property {string | any} - Object property. Can be `any` for nested properties.
          */
         /**
          * Returns the properties for an objects in the active version of the file.
@@ -2385,7 +2433,8 @@
             return this.internalGet(`/properties/tree`).then((response) => response.json());
         }
         /**
-         * Returns a list of file viewpoints.
+         * Returns a list of file viewpoints. For more information, see
+         * {@link https://cloud.opendesign.com/docs//pages/server/api.html#FileViewpoints | Open Cloud File Viewpoints API}.
          */
         getViewpoints() {
             return this.internalGet("/viewpoints")
@@ -2395,7 +2444,8 @@
         /**
          * Saves a new file viewpoint to the server. To create a viewpoint use `Viewer.createViewpoint()`.
          *
-         * @param viewpoint - Viewpoint.
+         * @param viewpoint - Viewpoint object. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#FileViewpoints | Open Cloud File Viewpoints API}.
          */
         saveViewpoint(viewpoint) {
             return this.internalPost("/viewpoints", viewpoint).then((response) => response.json());
@@ -2404,7 +2454,8 @@
          * Deletes the specified file viewpoint.
          *
          * @param guid - Viewpoint GUID.
-         * @returns Returns the raw data of a deleted viewpoint.
+         * @returns Returns the raw data of a deleted viewpoint. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#FileViewpoints | Open Cloud File Viewpoints API}.
          */
         deleteViewpoint(guid) {
             return this.internalDelete(`/viewpoints/${guid}`).then((response) => response.json());
@@ -2680,7 +2731,8 @@
          * Removes the specified permission from the file.
          *
          * @param permissionId - Permission ID.
-         * @returns Returns the raw data of a deleted permission.
+         * @returns Returns the raw data of a deleted permission. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Permission | Open Cloud File Permissions API}.
          */
         deletePermission(permissionId) {
             return this.internalDelete(`/permissions/${permissionId}`).then((response) => response.json());
@@ -2761,6 +2813,8 @@
          * Deletes the specified version file.
          *
          * @param version - Version to delete.
+         * @returns Returns the raw data of a deleted version file. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Files | Open Cloud Files API}.
          */
         async deleteVersion(version) {
             const response = await this.internalDelete(`/versions/${version}`);
@@ -2843,7 +2897,8 @@
      */
     class Role {
         /**
-         * @param data - Raw role data received from the server.
+         * @param data - Raw role data received from the server. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
          * @param projectId - Owner project ID.
          * @param httpClient - HTTP client instance used to send requests to the REST API server.
          */
@@ -2871,7 +2926,8 @@
             this._data.description = value;
         }
         /**
-         * Raw role data received from the server.
+         * Raw role data received from the server. For more information, see
+         * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
          *
          * @readonly
          */
@@ -2910,7 +2966,8 @@
         /**
          * Updates role data on the server.
          *
-         * @param data - Raw role data.
+         * @param data - Raw role data. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
          */
         async update(data) {
             const response = await this.internalPut(data);
@@ -2920,7 +2977,8 @@
         /**
          * Deletes a role from the project.
          *
-         * @returns Returns the raw data of a deleted role.
+         * @returns Returns the raw data of a deleted role. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
          */
         delete() {
             return this.internalDelete().then((response) => response.json());
@@ -2962,7 +3020,8 @@
      */
     class Member {
         /**
-         * @param data - Raw member data received from the server.
+         * @param data - Raw member data received from the server. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
          * @param projectId - Owner project ID.
          * @param httpClient - HTTP client instance used to send requests to the REST API server.
          */
@@ -2981,7 +3040,8 @@
             return this.httpClient.delete(`/projects/${this.projectId}/members/${this.id}`);
         }
         /**
-         * Raw member data received from the server.
+         * Raw member data received from the server. For more information, see
+         * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
          *
          * @readonly
          */
@@ -3039,7 +3099,8 @@
         /**
          * Updates member data on the server.
          *
-         * @param data - Raw member data.
+         * @param data - Raw member data. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
          */
         async update(data) {
             const response = await this.internalPut(data);
@@ -3049,7 +3110,8 @@
         /**
          * Removes a member from the project.
          *
-         * @returns Returns the raw data of a deleted member.
+         * @returns Returns the raw data of a deleted member. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
          */
         delete() {
             return this.internalDelete().then((response) => response.json());
@@ -3091,7 +3153,8 @@
      */
     class Project {
         /**
-         * @param data - Raw project data received from the server.
+         * @param data - Raw project data received from the server. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
          * @param httpClient - HTTP client instance used to send requests to the REST API server.
          */
         constructor(data, httpClient) {
@@ -3137,7 +3200,8 @@
             this.data.customFields = value;
         }
         /**
-         * Raw project data received from the server.
+         * Raw project data received from the server. For more information, see
+         * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
          *
          * @readonly
          */
@@ -3269,7 +3333,8 @@
         /**
          * Updates project data on the server.
          *
-         * @param data - Raw project data.
+         * @param data - Raw project data. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
          */
         async update(data) {
             const response = await this.internalPut("", data);
@@ -3279,7 +3344,8 @@
         /**
          * Deletes a project from the server.
          *
-         * @returns Returns the raw data of a deleted project.
+         * @returns Returns the raw data of a deleted project. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
          */
         delete() {
             return this.internalDelete("")
@@ -3369,7 +3435,8 @@
          * Deletes the specified project role.
          *
          * @param name - Role name.
-         * @returns Returns the raw data of a deleted role.
+         * @returns Returns the raw data of a deleted role. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
          */
         deleteRole(name) {
             return this.internalDelete(`/roles/${name}`).then((response) => response.json());
@@ -3407,7 +3474,8 @@
          * Removes the specified member from a project.
          *
          * @param memberId - Member ID.
-         * @returns Returns the raw data of a deleted member.
+         * @returns Returns the raw data of a deleted member. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
          */
         removeMember(memberId) {
             return this.internalDelete(`/members/${memberId}`).then((response) => response.json());
@@ -3425,7 +3493,8 @@
          * @property {string} file.reference - File ID.
          */
         /**
-         * Returns a list of project files.
+         * Returns a list of project files. For more information, see
+         * {@link https://cloud.opendesign.com/docs//pages/server/bcf3.html#ProjectFilesInformation | Open Cloud BCF3 API}.
          *
          * This list contains all files that the project has access to. To add a file to this list,
          * create a {@link IGrantedTo.project | project} permission on the file using
@@ -3490,7 +3559,7 @@
         /**
          * Adds a file to the project with specified permissions.
          *
-         * To change file permissions for the project use {@link Permission.update | Permissions.update()}.
+         * To change file permissions for the project use {@link Permission.actions}.
          *
          * @param fileId - File ID.
          * @param actions - Actions are allowed to be performed on a file:
@@ -3560,7 +3629,8 @@
      */
     class User {
         /**
-         * @param data - Raw user data received from the server.
+         * @param data - Raw user data received from the server. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Users | Open Cloud Users API}.
          * @param httpClient - HTTP client instance used to send requests to the REST API server.
          */
         constructor(data, httpClient) {
@@ -3606,7 +3676,8 @@
             this._data.customFields = value;
         }
         /**
-         * Raw user data received from the server.
+         * Raw user data received from the server. For more information, see
+         * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Users | Open Cloud Users API}.
          *
          * @readonly
          */
@@ -3633,6 +3704,9 @@
         /**
          * The user's email confirmation code, or an empty string if the email has already been confirmed.
          *
+         * To send the confirmation code to the server, use
+         * {@link Client.confirmUserEmail | Client.confirmUserEmail()}.
+         *
          * @readonly
          */
         get emailConfirmationId() {
@@ -3800,7 +3874,8 @@
          * Only administrators can update other users. If the current logged in user is not an
          * administrator, they can only update themself, otherwise an exception will be thrown.
          *
-         * @param data - Raw user data.
+         * @param data - Raw user data. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Users | Open Cloud Users API}.
          */
         async update(data) {
             if (this.httpClient.signInUserIsAdmin) {
@@ -3829,7 +3904,8 @@
          *
          * You need to re-login after deleting the current logged in user.
          *
-         * @returns Returns the raw data of a deleted user.
+         * @returns Returns the raw data of a deleted user. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Users | Open Cloud Users API}.
          */
         delete() {
             if (this.httpClient.signInUserIsAdmin) {
@@ -4054,15 +4130,10 @@
             this._user = null;
             return this;
         }
-        /**
-         * The Object represents server version information.
-         *
-         * @typedef {any} VersionResult
-         * @property {string} version - The server version.
-         * @property {string} hash - Build hash.
-         */
         /**
          * Returns client and server versions.
+         *
+         * No login is required to obtain the version.
          */
         version() {
             return this.httpClient
@@ -4071,12 +4142,14 @@
                 .then((data) => ({
                 ...data,
                 server: data.version,
-                client: "25.9.5",
+                client: "25.9.7",
             }));
         }
         /**
          * Registers a new user on the server.
          *
+         * No login is required to register a new user.
+         *
          * @param email - User email. Cannot be empty. Must be unique within the server.
          * @param password - User password. Cannot be empty. Password can only contain letters (a-z,
          *   A-Z), numbers (0-9), and special characters (~!@#$%^&*()_-+={}[]<>|/'":;.,?).
@@ -4170,6 +4243,9 @@
         }
         /**
          * Returns the current server settings.
+         *
+         * @returns Returns an object with server settings. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Settings | Open Cloud Settings API}.
          */
         getServerSettings() {
             return this.httpClient.get("/settings").then((response) => response.json());
@@ -4179,6 +4255,11 @@
          *
          * Only administrators can change server settings. If the current logged in user is not an
          * administrator, an exception will be thrown.
+         *
+         * @param settings - An object with the new server settings or part of the settings. For more
+         *   information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Settings | Open Cloud Settings API}.
+         * @returns Returns an object with updated server settings.
          */
         updateServerSettings(settings) {
             return this.httpClient.put("/settings", settings).then((response) => response.json());
@@ -4270,7 +4351,8 @@
          * You need to re-login after deleting the current logged in user.
          *
          * @param userId - User ID.
-         * @returns Returns the raw data of a deleted user.
+         * @returns Returns the raw data of a deleted user. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Users | Open Cloud Users API}.
          */
         deleteUser(userId) {
             if (this.httpClient.signInUserIsAdmin) {
@@ -4310,7 +4392,7 @@
          * @param ids - List of file IDs to return.
          * @param sortByDesc - Allows to specify the descending order of the result. By default,
          *   files are sorted by name in ascending order.
-         * @param {string} sortField - Allows to specify sort field.
+         * @param sortField - Allows to specify sort field.
          */
         getFiles(start, limit, name, ext, ids, sortByDesc, sortField) {
             const searchParams = new URLSearchParams();
@@ -4423,7 +4505,8 @@
          * version file use {@link File.deleteVersion | File.deleteVersion()}.
          *
          * @param fileId - File ID.
-         * @returns Returns the raw data of a deleted file.
+         * @returns Returns the raw data of a deleted file. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Files | Open Cloud Files API}.
          */
         deleteFile(fileId) {
             return this.httpClient.delete(`/files/${fileId}`).then((response) => response.json());
@@ -4534,7 +4617,8 @@
          * already been completed cannot be deleted.
          *
          * @param jobId - Job ID.
-         * @returns Returns the raw data of a deleted job.
+         * @returns Returns the raw data of a deleted job. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Jobs | Open Cloud Jobs API}.
          */
         deleteJob(jobId) {
             return this.httpClient.delete(`/jobs/${jobId}`).then((response) => response.json());
@@ -4634,7 +4718,8 @@
          * Deletes the specified assembly from the server.
          *
          * @param assemblyId - Assembly ID.
-         * @returns Returns the raw data of a deleted assembly.
+         * @returns Returns the raw data of a deleted assembly. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Assemblies | Open Cloud API}.
          */
         deleteAssembly(assemblyId) {
             return this.httpClient.delete(`/assemblies/${assemblyId}`).then((response) => response.json());
@@ -4746,7 +4831,8 @@
          * Deletes the specified project from the server.
          *
          * @param projectId - Project ID.
-         * @returns Returns the raw data of a deleted project.
+         * @returns Returns the raw data of a deleted project. For more information, see
+         *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
          */
         deleteProject(projectId) {
             return this.httpClient
@@ -4786,7 +4872,7 @@
     // By use of this software, its documentation or related materials, you
     // acknowledge and accept the above terms.
     ///////////////////////////////////////////////////////////////////////////////
-    const version = "25.9.5";
+    const version = "25.9.7";
 
     exports.Assembly = Assembly;
     exports.ClashTest = ClashTest;