@inweb/client 25.9.6 → 25.9.7

package/lib/Api/Permission.d.ts

@@ -2,14 +2,15 @@ import { IHttpClient } from "./IHttpClient";
 import { IGrantedTo } from "./IFile";
 /**
  * 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.
  */
 export declare class Permission {
     private _data;
     fileId: string;
     httpClient: IHttpClient;
     /**
-     * @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.
      */
@@ -25,11 +26,26 @@ export declare class Permission {
      * - `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(): string[];
     set actions(value: string[]);
     /**
-     * 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
      */
@@ -42,7 +58,7 @@ export declare class Permission {
      */
     get id(): string;
     /**
-     * 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(): IGrantedTo[];
     set grantedTo(value: IGrantedTo[]);
@@ -58,24 +74,15 @@ export declare class Permission {
     /**
      * 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}.
      */
     update(data: any): Promise<this>;
     /**
      * 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(): Promise<any>;
     /**

package/lib/Api/Project.d.ts

@@ -12,7 +12,8 @@ export declare class Project {
     private _data;
     httpClient: IHttpClient;
     /**
-     * @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: any, httpClient: IHttpClient);
@@ -48,7 +49,8 @@ export declare class Project {
     get customFields(): any;
     set customFields(value: any);
     /**
-     * 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
      */
@@ -132,13 +134,15 @@ export declare class Project {
     /**
      * 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}.
      */
     update(data: any): Promise<this>;
     /**
      * 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(): Promise<any>;
     /**
@@ -157,7 +161,7 @@ export declare class Project {
      *   {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object. Setting
      *   the `image` to `null` will remove the preview.
      */
-    setPreview(image?: BodyInit | null): Promise<any>;
+    setPreview(image?: BodyInit | null): Promise<this>;
     /**
      * Removes the project preview.
      */
@@ -185,7 +189,8 @@ export declare class Project {
      * 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: string): Promise<any>;
     /**
@@ -209,7 +214,8 @@ export declare class Project {
      * 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: string): Promise<any>;
     /**
@@ -225,7 +231,8 @@ export declare class Project {
      * @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
@@ -239,7 +246,7 @@ export declare class Project {
     /**
      * 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:

package/lib/Api/Role.d.ts

@@ -9,7 +9,8 @@ export declare class Role {
     projectId: string;
     httpClient: IHttpClient;
     /**
-     * @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.
      */
@@ -23,7 +24,8 @@ export declare class Role {
     get description(): string;
     set description(value: string);
     /**
-     * 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
      */
@@ -46,13 +48,15 @@ export declare class Role {
     /**
      * 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}.
      */
     update(data: any): Promise<this>;
     /**
      * 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(): Promise<any>;
     /**

package/lib/Api/User.d.ts

@@ -7,7 +7,8 @@ export declare class User {
     private _data;
     httpClient: IHttpClient;
     /**
-     * @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: any, httpClient: IHttpClient);
@@ -38,7 +39,8 @@ export declare class User {
     get customFields(): any;
     set customFields(value: any);
     /**
-     * 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
      */
@@ -52,6 +54,9 @@ export declare class User {
     /**
      * 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(): string;
@@ -160,7 +165,8 @@ export declare class User {
      * 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}.
      */
     update(data: any): Promise<this>;
     /**
@@ -174,7 +180,8 @@ export declare class User {
      *
      * 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(): Promise<any>;
     /**

package/lib/index.d.ts

@@ -6,8 +6,8 @@ export { File } from "./Api/File";
 export { FetchError, statusText } from "./Api/FetchError";
 export { Job } from "./Api/Job";
 export { IHttpClient } from "./Api/IHttpClient";
-export { IModelTransformMatrix } from "./Api/IAssembly";
-export { IFileDataStatus, IFileReference, IFileReferences, IFileStatus, IGrantedTo } from "./Api/IFile";
+export { IAssociatedFileData, IClashItem, IModelTransformMatrix } from "./Api/IAssembly";
+export { IFileDataStatus, IFileReference, IFileReferences, IFileStatus, IFileVersionInfo, IGrantedTo, } from "./Api/IFile";
 export { IRoleActions } from "./Api/IRole";
 export { IShortUserDesc } from "./Api/IUser";
 export { Member } from "./Api/Member";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "25.9.6",
+  "version": "25.9.7",
   "description": "JavaScript REST API client for the Open Cloud Server",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",
@@ -26,6 +26,6 @@
     "docs": "typedoc"
   },
   "dependencies": {
-    "@inweb/eventemitter2": "~25.9.6"
+    "@inweb/eventemitter2": "~25.9.7"
   }
 }

package/src/Api/Assembly.ts

@@ -41,8 +41,9 @@ export class Assembly {
   public path: string;
 
   /**
-   * @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: any, httpClient: IHttpClient) {
     this.path = `/assemblies/${data.id}`;
@@ -102,9 +103,8 @@ export class Assembly {
   }
 
   /**
-   * 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(): any {
     return this._data;
@@ -232,7 +232,8 @@ export class Assembly {
   /**
    * 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: any): Promise<this> {
     const response = await this.internalPut("", data);
@@ -243,7 +244,8 @@ export class Assembly {
   /**
    * 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(): Promise<any> {
     return this.internalDelete("").then((response) => response.json());
@@ -293,18 +295,25 @@ export class Assembly {
    * @param handle - Model original handle.
    * @param transform - Transformation matrix. Specify `undefined` to remove transformation.
    */
-  setModelTransformMatrix(handle: string, transform: IModelTransformMatrix): Promise<this> {
+  setModelTransformMatrix(handle: string, transform?: IModelTransformMatrix): Promise<this> {
     const obj = { ...this.data.transform };
     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?: string | string[]): Promise<any[]> {
     const relativePath = handles !== undefined ? `/properties?handles=${handles}` : "/properties";
@@ -348,7 +357,8 @@ export class Assembly {
   }
 
   /**
-   * 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(): Promise<any[]> {
     return this.internalGet("/viewpoints")
@@ -359,7 +369,8 @@ export class Assembly {
   /**
    * 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: any): Promise<any> {
     return this.internalPost("/viewpoints", viewpoint).then((response) => response.json());
@@ -369,14 +380,15 @@ export class Assembly {
    * 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: string): Promise<any> {
     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.
@@ -386,12 +398,12 @@ export class Assembly {
   }
 
   /**
-   * Returns viewpoint snapshot data.
+   * Returns the viewpoint snapshot data.
    *
    * @param guid - Viewpoint GUID.
    * @param bitmapGuid - Bitmap GUID.
    */
-  getSnapshotData(guid: any, bitmapGuid: any): Promise<string> {
+  getSnapshotData(guid: string, bitmapGuid: string): Promise<string> {
     return this.internalGet(`/viewpoints/${guid}/bitmaps/${bitmapGuid}`).then((response) => response.text());
   }
 
@@ -656,7 +668,8 @@ export class Assembly {
    * 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: string): Promise<any> {
     return this.internalDelete(`/clashes/${testId}`).then((response) => response.json());

package/src/Api/ClashTest.ts

@@ -22,6 +22,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { IHttpClient } from "./IHttpClient";
+import { IClashItem } from "./IAssembly";
 import { IShortUserDesc } from "./IUser";
 import { waitFor, userFullName, userInitials } from "./Utils";
 
@@ -34,7 +35,8 @@ export class ClashTest {
   public httpClient: IHttpClient;
 
   /**
-   * @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.
    */
@@ -81,7 +83,8 @@ export class ClashTest {
   }
 
   /**
-   * 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
    */
@@ -213,7 +216,8 @@ export class ClashTest {
   /**
    * 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: any): Promise<this> {
     const response = await this.internalPut("", data);
@@ -224,7 +228,8 @@ export class ClashTest {
   /**
    * 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(): Promise<any> {
     return this.internalDelete("").then((response) => response.json());
@@ -267,9 +272,9 @@ export class ClashTest {
   }
 
   /**
-   * Returns a report with the clash detection results for this test.
+   * Returns a list of detected clashes for this test.
    */
-  getReport(): Promise<any> {
+  getReport(): Promise<IClashItem[]> {
     return this.internalGet("/report").then((response) => response.json());
   }
 }

package/src/Api/Client.ts

@@ -132,18 +132,12 @@ export class Client extends EventEmitter2<ClientEventMap> {
     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(): Promise<any> {
+  version(): Promise<{ server: string; client: string; hash: string }> {
     return this.httpClient
       .get("/version")
       .then((response) => response.json())
@@ -157,6 +151,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * 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 (~!@#$%^&*()_-+={}[]<>|/'":;.,?).
@@ -253,12 +249,15 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Returns the list of server enabled indentity providers.
    */
-  getIdentityProviders(): Promise<any> {
+  getIdentityProviders(): Promise<{ name: string; url: string }[]> {
     return this.httpClient.get("/identity").then((response) => response.json());
   }
 
   /**
    * 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(): Promise<any> {
     return this.httpClient.get("/settings").then((response) => response.json());
@@ -269,6 +268,11 @@ export class Client extends EventEmitter2<ClientEventMap> {
    *
    * 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: any): Promise<any> {
     return this.httpClient.put("/settings", settings).then((response) => response.json());
@@ -374,7 +378,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * 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: string): Promise<any> {
     if (this.httpClient.signInUserIsAdmin) {
@@ -415,7 +420,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @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?: number,
@@ -540,7 +545,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * 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: string): Promise<any> {
     return this.httpClient.delete(`/files/${fileId}`).then((response) => response.json());
@@ -657,7 +663,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * 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: string): Promise<any> {
     return this.httpClient.delete(`/jobs/${jobId}`).then((response) => response.json());
@@ -772,7 +779,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * 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: string): Promise<any> {
     return this.httpClient.delete(`/assemblies/${assemblyId}`).then((response) => response.json());
@@ -891,7 +899,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * 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: string): Promise<any> {
     return this.httpClient