@inweb/client 26.1.2 → 26.1.4

package/src/Api/Assembly.ts

@@ -34,8 +34,8 @@ import { SharedLink } from "./SharedLink";
 import { waitFor, userFullName, userInitials } from "./Utils";
 
 /**
- * Provides properties and methods for obtaining information about an assembly on the Open Cloud Server
- * and managing its data.
+ * Provides properties and methods for obtaining information about an assembly on the Open
+ * Cloud Server and managing its data.
  */
 export class Assembly extends Endpoint {
   private _data: any;
@@ -225,8 +225,8 @@ export class Assembly extends Endpoint {
   }
 
   /**
-   * Saves assembly properties changes to the server. Call this method to update assembly data on the
-   * server after any property changes.
+   * Saves assembly properties changes to the server. Call this method to update assembly data
+   * on the server after any property changes.
    */
   save(): Promise<this> {
     return this.update(this.data);
@@ -285,8 +285,8 @@ export class Assembly extends Endpoint {
   /**
    * 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.
+   * @param handles - Object original handle or handles array. Specify `undefined` to get
+   *   properties for all objects in the assembly.
    */
   getProperties(handles?: string | string[]): Promise<any[]> {
     const relativePath = handles !== undefined ? `/properties?handles=${handles}` : "/properties";
@@ -294,33 +294,27 @@ export class Assembly extends Endpoint {
   }
 
   /**
-   * Returns the list of original handles for an objects in the file that match the specified patterns.
-   * Search patterns may be combined using query operators.
+   * Returns the list of original handles for an objects in the file that match the specified
+   * patterns. Search patterns may be combined using query operators.
    *
-   * @example Simple search pattern.
+   * @example <caption>Simple search pattern.</caption>
+   *   searchPattern = {
+   *     key: "Category",
+   *     value: "OST_Stairs",
+   *   };
    *
-   * ```javascript
-   * searchPattern = {
-   *   key: "Category",
-   *   value: "OST_Stairs",
-   * };
-   * ```
-   *
-   * @example Search patterns combination.
-   *
-   * ```javascript
-   * searchPattern = {
-   *   $or: [
-   *     {
-   *       $and: [
-   *         { key: "Category", value: "OST_GenericModel" },
-   *         { key: "Level", value: "03 - Floor" },
-   *       ],
-   *     },
-   *     { key: "Category", value: "OST_Stairs" },
-   *   ],
-   * };
-   * ```
+   * @example <caption>Search patterns combination.</caption>
+   *   searchPattern = {
+   *     $or: [
+   *       {
+   *         $and: [
+   *           { key: "Category", value: "OST_GenericModel" },
+   *           { key: "Level", value: "03 - Floor" },
+   *         ],
+   *       },
+   *       { key: "Category", value: "OST_Stairs" },
+   *     ],
+   *   };
    *
    * @param searchPattern - Search pattern or combination of the patterns, see example below.
    */
@@ -387,14 +381,14 @@ export class Assembly extends Endpoint {
   }
 
   /**
-   * Downloads an assembly resource file. Resource files are files that contain model scene descriptions,
-   * or geometry data.
+   * Downloads an assembly resource file. Resource files are files that contain model scene
+   * descriptions, or geometry data.
    *
    * @param dataId - Resource file name.
    * @param onProgress - Download progress callback.
    * @param signal - An
-   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal. Allows
-   *   to communicate with a fetch request and abort it if desired.
+   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+   *   signal. Allows to communicate with a fetch request and abort it if desired.
    */
   downloadResource(
     dataId: string,
@@ -407,16 +401,16 @@ export class Assembly extends Endpoint {
   }
 
   /**
-   * Downloads a part of assembly resource file. Resource files are files that contain model scene
-   * descriptions, or geometry data.
+   * Downloads a part of assembly resource file. Resource files are files that contain model
+   * scene descriptions, or geometry data.
    *
    * @param dataId - Resource file name.
    * @param ranges - A range of resource file contents to download.
    * @param requestId - Request ID for download progress callback.
    * @param onProgress - Download progress callback.
    * @param signal - An
-   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal. Allows
-   *   to communicate with a fetch request and abort it if desired.
+   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+   *   signal. Allows to communicate with a fetch request and abort it if desired.
    */
   downloadResourceRange(
     dataId: string,
@@ -466,14 +460,14 @@ export class Assembly extends Endpoint {
   }
 
   /**
-   * Returns a list of assembly references containing references from all the files from which the
-   * assembly was created.
+   * 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.
+   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+   *   signal, which can be used to abort waiting as desired.
    */
   async getReferences(signal?: AbortSignal): Promise<IFileReferences> {
     const files = new Endpoint("/files", this.httpClient, this.headers);
@@ -492,13 +486,13 @@ export class Assembly extends Endpoint {
    * Waits for assembly to be created. Assembly is created when it changes to `done` or `failed` status.
    *
    * @param params - An object containing waiting parameters.
-   * @param params.timeout - The time, in milliseconds that the function should wait assembly. If
-   *   assembly is not created during this time, the `TimeoutError` exception will be thrown.
-   * @param params.interval - The time, in milliseconds, the function should delay in between checking
-   *   assembly status.
+   * @param params.timeout - The time, in milliseconds that the function should wait assembly.
+   *   If assembly is not created during this time, the `TimeoutError` exception will be thrown.
+   * @param params.interval - The time, in milliseconds, the function should delay in between
+   *   checking assembly status.
    * @param params.signal - An
-   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal, which
-   *   can be used to abort waiting as desired.
+   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+   *   signal, which can be used to abort waiting as desired.
    * @param params.onCheckout - Waiting progress callback. Return `true` to cancel waiting.
    */
   waitForDone(params?: {
@@ -524,8 +518,8 @@ export class Assembly extends Endpoint {
    * @param limit - The maximum number of tests that should be returned per request. Used for paging.
    * @param name - Filter the tests by part of the name. Case sensitive.
    * @param ids - List of tests IDs to return.
-   * @param sortByDesc - Allows to specify the descending order of the result. By default tests are
-   *   sorted by name in ascending order.
+   * @param sortByDesc - Allows to specify the descending order of the result. By default tests
+   *   are sorted by name in ascending order.
    * @param sortField - Allows to specify sort field.
    */
   getClashTests(
@@ -590,28 +584,30 @@ export class Assembly extends Endpoint {
    *   - `models` - All objects of the models with original handles specified in the `selectionSetB`.
    *   - `searchquery` - Objects retrieved by the search queries specified in `selectionSetB`.
    *
-   * @param selectionSetA - First selection set for clash detection. Objects from `selectionSetA` will be
-   *   tested against each others by objects from the `selectionSetB` during the test.
-   * @param selectionSetB - Second selection set for clash detection. Objects from `selectionSetB` will
-   *   be tested against each others by objects from the `selectionSetA` during the test.
+   * @param selectionSetA - First selection set for clash detection. Objects from
+   *   `selectionSetA` will be tested against each others by objects from the `selectionSetB`
+   *   during the test.
+   * @param selectionSetB - Second selection set for clash detection. Objects from
+   *   `selectionSetB` will be tested against each others by objects from the `selectionSetA`
+   *   during the test.
    * @param params - An object containing test parameters.
-   * @param params.tolerance - The distance of separation between objects at which test begins detecting
-   *   clashes.
+   * @param params.tolerance - The distance of separation between objects at which test begins
+   *   detecting clashes.
    * @param params.clearance - The type of the clashes that the test detects:
    *
-   *   - `true` - Сlearance clash. A clash in which the object A may or may not intersect with object B, but
-   *       comes within a distance of less than the `tolerance`.
-   *   - `false` - Hard clash. A clash in which the object A intersects with object B by a distance of more
-   *       than the `tolerance`.
+   *   - `true` - Сlearance clash. A clash in which the object A may or may not intersect with
+   *       object B, but comes within a distance of less than the `tolerance`.
+   *   - `false` - Hard clash. A clash in which the object A intersects with object B by a distance
+   *       of more than the `tolerance`.
    *
    * @param params.waitForDone - Wait for test to complete.
-   * @param params.timeout - The time, in milliseconds that the function should wait test. If test is not
-   *   complete during this time, the `TimeoutError` exception will be thrown.
-   * @param params.interval - The time, in milliseconds, the function should delay in between checking
-   *   test status.
+   * @param params.timeout - The time, in milliseconds that the function should wait test. If
+   *   test is not complete during this time, the `TimeoutError` exception will be thrown.
+   * @param params.interval - The time, in milliseconds, the function should delay in between
+   *   checking test status.
    * @param params.signal - An
-   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal, which
-   *   can be used to abort waiting as desired.
+   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+   *   signal, which can be used to abort waiting as desired.
    */
   createClashTest(
     name: string,
@@ -692,15 +688,15 @@ export class Assembly extends Endpoint {
 
   // Reserved for future use
 
-  createSharedLink(permissions?: ISharedLinkPermissions): Promise<SharedLink> {
+  async createSharedLink(permissions?: ISharedLinkPermissions): Promise<SharedLink> {
     return Promise.reject(new Error("Assembly shared link will be implemeted in a future release"));
   }
 
-  getSharedLink(): Promise<SharedLink> {
+  async getSharedLink(): Promise<SharedLink> {
     return Promise.resolve(undefined);
   }
 
-  deleteSharedLink(): Promise<any> {
+  async deleteSharedLink(): Promise<any> {
     return Promise.reject(new FetchError(404));
   }
 }

package/src/Api/ClashTest.ts

@@ -47,10 +47,10 @@ export class ClashTest extends Endpoint {
   /**
    * The type of the clashes that the test detects:
    *
-   * - `true` - Сlearance clash. A clash in which the object A may or may not intersect with object B, but
-   *   comes within a distance of less than the {@link tolerance}.
-   * - `false` - Hard clash. A clash in which the object A intersects with object B by a distance of more
-   *   than the {@link tolerance}.
+   * - `true` - Сlearance clash. A clash in which the object A may or may not intersect with
+   *   object B, but comes within a distance of less than the {@link tolerance}.
+   * - `false` - Hard clash. A clash in which the object A intersects with object B by a distance
+   *   of more than the {@link tolerance}.
    *
    * @readonly
    */
@@ -125,8 +125,8 @@ export class ClashTest extends Endpoint {
   }
 
   /**
-   * First selection set for clash detection. Objects from `selectionSetA` will be tested against each
-   * others by objects from the `selectionSetB` during the test.
+   * First selection set for clash detection. Objects from `selectionSetA` will be tested
+   * against each others by objects from the `selectionSetB` during the test.
    *
    * @readonly
    */
@@ -149,8 +149,8 @@ export class ClashTest extends Endpoint {
   }
 
   /**
-   * Second selection set for clash detection. Objects from `selectionSetB` will be tested against each
-   * others by objects from the `selectionSetA` during the test.
+   * Second selection set for clash detection. Objects from `selectionSetB` will be tested
+   * against each others by objects from the `selectionSetA` during the test.
    *
    * @readonly
    */
@@ -222,8 +222,8 @@ export class ClashTest extends Endpoint {
   }
 
   /**
-   * Saves test properties changes to the server. Call this method to update test data on the server
-   * after any property changes.
+   * Saves test properties changes to the server. Call this method to update test data on the
+   * server after any property changes.
    */
   save(): Promise<this> {
     return this.update(this.data);
@@ -233,13 +233,13 @@ export class ClashTest extends Endpoint {
    * Waits for test to complete. Test is done when it changes to `done` or `failed` status.
    *
    * @param params - An object containing waiting parameters.
-   * @param params.timeout - The time, in milliseconds that the function should wait test. If test is not
-   *   complete during this time, the `TimeoutError` exception will be thrown.
-   * @param params.interval - The time, in milliseconds, the function should delay in between checking
-   *   test status.
+   * @param params.timeout - The time, in milliseconds that the function should wait test. If
+   *   test is not complete during this time, the `TimeoutError` exception will be thrown.
+   * @param params.interval - The time, in milliseconds, the function should delay in between
+   *   checking test status.
    * @param params.signal - An
-   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal, which
-   *   can be used to abort waiting as desired.
+   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+   *   signal, which can be used to abort waiting as desired.
    * @param params.onCheckout - Waiting progress callback. Return `true` to cancel waiting.
    */
   waitForDone(params?: {

package/src/Api/Client.ts

@@ -39,8 +39,8 @@ import { SharedFile } from "./SharedFile";
 import { parseArgs } from "./Utils";
 
 /**
- * Provides methods for managing Open Cloud Server resources such as users, files, assemblies, jobs,
- * projects, etc.
+ * Provides methods for managing Open Cloud Server resources such as users, files, assemblies,
+ * jobs, projects, etc.
  */
 export class Client extends EventEmitter2<ClientEventMap> {
   private _serverUrl = "";
@@ -158,10 +158,10 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * 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 (~!@#$%^&*()_-+={}[]<>|/'":;.,?).
-   * @param userName - User name. Cannot be empty or blank if defined. this to `undefined` to use
-   *   `username` from email.
+   * @param password - User password. Cannot be empty. Password can only contain letters (a-z,
+   *   A-Z), numbers (0-9), and special characters (~!@#$%^&*()_-+={}[]<>|/'":;.,?).
+   * @param userName - User name. Cannot be empty or blank if defined. this to `undefined` to
+   *   use `username` from email.
    */
   registerUser(email: string, password: string, userName?: string): Promise<any> {
     return this.httpClient
@@ -174,8 +174,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
   }
 
   /**
-   * Resends a Confirmation Email to the new user. If the user's email is already confirmed, an exception
-   * will be thrown.
+   * Resends a Confirmation Email to the new user. If the user's email is already confirmed, an
+   * exception will be thrown.
    *
    * @param email - User email.
    * @param password - User password.
@@ -187,8 +187,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
   }
 
   /**
-   * Marks the user's email address as confirmed. If the user's email is already confirmed, an exception
-   * will be thrown.
+   * Marks the user's email address as confirmed. If the user's email is already confirmed, an
+   * exception will be thrown.
    *
    * @param emailConfirmationId - Confirmation code from the Confirmation Email.
    */
@@ -227,8 +227,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Log out.
    *
-   * You must log in again using {@link signInWithEmail} or {@link signInWithToken} to continue making
-   * requests to the server
+   * You must log in again using {@link signInWithEmail} or {@link signInWithToken} to continue
+   * making requests to the server
    */
   signOut(): void {
     this.clearCurrentUser();
@@ -252,8 +252,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
   }
 
   /**
-   * Returns the current logged in user. Returns `null` if the user is not logged in or the logged in
-   * user has deleted themself.
+   * Returns the current logged in user. Returns `null` if the user is not logged in or the
+   * logged in user has deleted themself.
    */
   getCurrentUser(): User | null {
     if (this._user && !this.httpClient.signInUserId) this._user = null;
@@ -306,8 +306,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Returns a list of OAuth clients of the server.
    *
-   * Only administrators can get a list of OAuth clients. If the current logged in user is not an
-   * administrator, an exception will be thrown.
+   * Only administrators can get a list of OAuth clients. If the current logged in user is not
+   * an administrator, an exception will be thrown.
    *
    * @param start - The starting index in the client list. Used for paging.
    * @param limit - The maximum number of clients that should be returned per request. Used for paging.
@@ -343,8 +343,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Returns information about the specified OAuth client.
    *
-   * Only administrators can get OAuth clients. If the current logged in user is not an administrator, an
-   * exception will be thrown.
+   * Only administrators can get OAuth clients. If the current logged in user is not an
+   * administrator, an exception will be thrown.
    *
    * @param clientId - Client ID.
    */
@@ -358,8 +358,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Creates a new OAuth client on the server.
    *
-   * Only administrators can create OAuth clients. If the current logged in user is not an administrator,
-   * an exception will be thrown.
+   * Only administrators can create OAuth clients. If the current logged in user is not an
+   * administrator, an exception will be thrown.
    *
    * @param name - Client name.
    * @param redirectUrl - Endpoint to which the OAuth 2.0 server sends the response.
@@ -379,8 +379,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Deletes the specified OAuth client from the server.
    *
-   * Only administrators can delete OAuth clients. If the current logged in user is not an administrator,
-   * an exception will be thrown.
+   * Only administrators can delete OAuth clients. If the current logged in user is not an
+   * administrator, an exception will be thrown.
    *
    * @param clientId - Client ID.
    * @returns Returns the raw data of a deleted client. For more information, see
@@ -393,8 +393,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Returns the list of server users.
    *
-   * Only administrators can get a list of users. If the current logged in user is not an administrator,
-   * an exception will be thrown.
+   * Only administrators can get a list of users. If the current logged in user is not an
+   * administrator, an exception will be thrown.
    */
   getUsers(): Promise<User[]> {
     return this.httpClient
@@ -407,8 +407,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Returns information about the specified user.
    *
-   * Only administrators can get other users. If the current logged in user is not an administrator, they
-   * can only get themselves, otherwise an exception will be thrown.
+   * Only administrators can get other users. If the current logged in user is not an
+   * administrator, they can only get themselves, otherwise an exception will be thrown.
    *
    * @param userId - User ID.
    */
@@ -433,16 +433,16 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Creates a new user on the server.
    *
-   * Only administrators can create users. If the current logged in user is not an administrator, an
-   * exception will be thrown.
+   * Only administrators can create users. If the current logged in user is not an
+   * administrator, an exception will be thrown.
    *
    * @param email - User email. Cannot be empty. Must be unique within the server.
-   * @param password - User password. Cannot be empty. Password can only contain latin letters (a-z,
-   *   A-Z), numbers (0-9), and special characters (~!@#$%^&*()_-+={}[]<>|/'":;.,?).
+   * @param password - User password. Cannot be empty. Password can only contain latin letters
+   *   (a-z, A-Z), numbers (0-9), and special characters (~!@#$%^&*()_-+={}[]<>|/'":;.,?).
    * @param params - Additional user data.
    * @param params.isAdmin - `true` if user is an administrator.
-   * @param params.userName - User name. Cannot be empty or blank if defined. Specify `undefined` to use
-   *   `username` from email.
+   * @param params.userName - User name. Cannot be empty or blank if defined. Specify
+   *   `undefined` to use `username` from email.
    * @param params.firstName - First name.
    * @param params.lastName - Last name.
    * @param params.canCreateProject - `true` if user is allowed to create a project.
@@ -481,11 +481,11 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Deletes the specified user from the server.
    *
-   * Only administrators can delete users. If the current logged in user is not an administrator, an
-   * exception will be thrown.
+   * Only administrators can delete users. If the current logged in user is not an
+   * administrator, an exception will be thrown.
    *
-   * Administrators can delete themselves or other administrators. An administrator can only delete
-   * themself if they is not the last administrator.
+   * Administrators can delete themselves or other administrators. An administrator can only
+   * delete themself if they is not the last administrator.
    *
    * You need to re-login after deleting the current logged in user.
    *
@@ -526,12 +526,12 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @param start - The starting index in the file list. Used for paging.
    * @param limit - The maximum number of files that should be returned per request. Used for paging.
    * @param name - Filter the files by part of the name. Case sensitive.
-   * @param ext - Filter the files by extension. Extension can be `dgn`, `dwf`, `dwg`, `dxf`, `ifc`,
-   *   `ifczip`, `nwc`, `nwd`, `obj`, `rcs`, `rfa`, `rvt`, `step`, `stl`, `stp`, `vsf`, or any other file
-   *   type extension.
+   * @param ext - Filter the files by extension. Extension can be `dgn`, `dwf`, `dwg`, `dxf`,
+   *   `ifc`, `ifczip`, `nwc`, `nwd`, `obj`, `rcs`, `rfa`, `rvt`, `step`, `stl`, `stp`, `vsf`,
+   *   or any other file type extension.
    * @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 sortByDesc - Allows to specify the descending order of the result. By default,
+   *   files are sorted by name in ascending order.
    * @param sortField - Allows to specify sort field.
    * @param shared - Returns shared files only.
    */
@@ -601,9 +601,10 @@ export class Client extends EventEmitter2<ClientEventMap> {
    *
    * - {@link UploadProgressEvent | uploadprogress}
    *
-   * @param file - {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object are
-   *   generally retrieved from a {@link https://developer.mozilla.org/docs/Web/API/FileList | FileList}
-   *   object returned as a result of a user selecting files using the HTML `<input>` element.
+   * @param file - {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object
+   *   are generally retrieved from a
+   *   {@link https://developer.mozilla.org/docs/Web/API/FileList | FileList} object returned as
+   *   a result of a user selecting files using the HTML `<input>` element.
    * @param params - An object containing upload parameters.
    * @param params.geometry - Create job to convert file geometry data. Can be:
    *
@@ -613,13 +614,13 @@ export class Client extends EventEmitter2<ClientEventMap> {
    *
    * @param params.properties - Create job to extract file properties.
    * @param params.waitForDone - Wait for geometry and properties jobs to complete.
-   * @param params.timeout - The time, in milliseconds that the function should wait jobs. If no one jobs
-   *   are done during this time, the `TimeoutError` exception will be thrown.
-   * @param params.interval - The time, in milliseconds, the function should delay in between checking
-   *   jobs status.
+   * @param params.timeout - The time, in milliseconds that the function should wait jobs. If
+   *   no one jobs are done during this time, the `TimeoutError` exception will be thrown.
+   * @param params.interval - The time, in milliseconds, the function should delay in between
+   *   checking jobs status.
    * @param params.signal - An
-   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal, which
-   *   can be used to abort waiting as desired.
+   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+   *   signal, which can be used to abort waiting as desired.
    * @param params.onProgress - Upload progress callback.
    */
   async uploadFile(
@@ -661,8 +662,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Deletes the specified file and all its versions from the server.
    *
-   * You cannot delete a version file using `deleteFile()`, only the original file. To delete a version
-   * file use {@link File.deleteVersion | File.deleteVersion()}.
+   * You cannot delete a version file using `deleteFile()`, only the original file. To delete a
+   * version file use {@link File.deleteVersion | File.deleteVersion()}.
    *
    * @param fileId - File ID.
    * @returns Returns the raw data of a deleted file. For more information, see
@@ -678,8 +679,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @param fileId - File ID.
    * @param onProgress - Download progress callback.
    * @param signal - An
-   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal. Allows
-   *   to communicate with a fetch request and abort it if desired.
+   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+   *   signal. Allows to communicate with a fetch request and abort it if desired.
    */
   downloadFile(fileId: string, onProgress?: (progress: number) => void, signal?: AbortSignal): Promise<ArrayBuffer> {
     return this.httpClient
@@ -704,8 +705,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @param status - Filter the jobs by status. Status can be `waiting`, `inpogress`, `done` or `failed`.
    * @param limit - The maximum number of jobs that should be returned per request. Used for paging.
    * @param start - The starting index in the job list. Used for paging.
-   * @param sortByDesc - Allows to specify the descending order of the result. By default, jobs are
-   *   sorted by creation time in ascending order.
+   * @param sortByDesc - Allows to specify the descending order of the result. By default, jobs
+   *   are sorted by creation time in ascending order.
    * @param {boolean} sortField - Allows to specify sort field.
    */
   getJobs(
@@ -767,11 +768,11 @@ export class Client extends EventEmitter2<ClientEventMap> {
    *   - `properties` - Extract file properties.
    *   - `validation` - Validate the file. Only for `IFC` files.
    *   - `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` - Export file to the one of the supported format.
-   *   - Other custom job name. Custom job runner must be registered in the job templates table before
-   *       creating a job.
+   *   - Other custom job name. Custom job runner must be registered in the job templates table
+   *       before creating a job.
    *
-   * @param parameters - Parameters for the job runner. Can be given as command line arguments for the
-   *   File Converter tool in form `--arg=value`.
+   * @param parameters - Parameters for the job runner. Can be given as command line arguments
+   *   for the File Converter tool in form `--arg=value`.
    */
   createJob(fileId: string, outputFormat: string, parameters?: string | object): Promise<Job> {
     return this.httpClient
@@ -785,8 +786,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
   }
 
   /**
-   * Deletes the specified job from the server job list. Jobs that are in progress or have already been
-   * completed cannot be deleted.
+   * Deletes the specified job from the server job list. Jobs that are in progress or have
+   * already been completed cannot be deleted.
    *
    * @param jobId - Job ID.
    * @returns Returns the raw data of a deleted job. For more information, see
@@ -811,12 +812,12 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * Returns a list of assemblies created by the current logged in user.
    *
    * @param start - The starting index in the assembly list. Used for paging.
-   * @param limit - The maximum number of assemblies that should be returned per request. Used for
-   *   paging.
+   * @param limit - The maximum number of assemblies that should be returned per request. Used
+   *   for paging.
    * @param name - Filter the assemblies by part of the name. Case sensitive.
    * @param ids - List of assembly IDs to return.
-   * @param sortByDesc - Allows to specify the descending order of the result. By default assemblies are
-   *   sorted by name in ascending order.
+   * @param sortByDesc - Allows to specify the descending order of the result. By default
+   *   assemblies are sorted by name in ascending order.
    * @param sortField - Allows to specify sort field.
    */
   getAssemblies(
@@ -878,14 +879,14 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @param name - Assembly name.
    * @param params - Additional assembly creating parameters.
    * @param params.waitForDone - Wait for assembly to be created.
-   * @param params.timeout - The time, in milliseconds, that the function should wait for the assembly to
-   *   be created. If the assembly is not created within this time, a TimeoutError exception will be
-   *   thrown.
-   * @param params.interval - The time, in milliseconds, the function should delay in between checking
-   *   assembly status.
+   * @param params.timeout - The time, in milliseconds, that the function should wait for the
+   *   assembly to be created. If the assembly is not created within this time, a TimeoutError
+   *   exception will be thrown.
+   * @param params.interval - The time, in milliseconds, the function should delay in between
+   *   checking assembly status.
    * @param params.signal - An
-   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal, which
-   *   can be used to abort waiting as desired.
+   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+   *   signal, which can be used to abort waiting as desired.
    * @param params.onCheckout - Waiting progress callback. Return `true` to cancel waiting.
    */
   createAssembly(
@@ -936,8 +937,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @param limit - The maximum number of projects that should be returned per request. Used for paging.
    * @param name - Filter the projects by part of the name. Case sensitive.
    * @param ids - List of project IDs to return.
-   * @param sortByDesc - Allows to specify the descending order of the result. By default projects are
-   *   sorted by name in ascending order.
+   * @param sortByDesc - Allows to specify the descending order of the result. By default
+   *   projects are sorted by name in ascending order.
    */
   getProjects(
     start?: number,
@@ -1085,8 +1086,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Deletes the specified shared link.
    *
-   * Only file owner can delete shared link. If the current logged in user is not a file owner, an
-   * exception will be thrown.
+   * Only file owner can delete shared link. If the current logged in user is not a file owner,
+   * an exception will be thrown.
    *
    * @param token - Shared link token.
    * @returns Returns the raw data of a deleted shared link. For more information, see