@inweb/client 26.1.2 → 26.1.4

package/lib/Api/Assembly.d.ts

@@ -8,8 +8,8 @@ import { ClashTest } from "./ClashTest";
 import { ISharedLinkPermissions } from "./ISharedLink";
 import { SharedLink } from "./SharedLink";
 /**
- * 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 declare class Assembly extends Endpoint {
     private _data;
@@ -113,8 +113,8 @@ export declare class Assembly extends Endpoint {
      */
     delete(): Promise<any>;
     /**
-     * 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>;
     setPreview(image?: BodyInit | null): Promise<this>;
@@ -146,38 +146,32 @@ export declare 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[]>;
     /**
-     * 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.
-     *
-     * ```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" },
-     *   ],
-     * };
-     * ```
+     * 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 <caption>Simple search pattern.</caption>
+     *   searchPattern = {
+     *     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.
      */
@@ -221,27 +215,27 @@ export declare class Assembly extends Endpoint {
      */
     getSnapshotData(guid: string, bitmapGuid: string): Promise<string>;
     /**
-     * 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, onProgress?: (progress: number, chunk: Uint8Array) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
     /**
-     * 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, requestId: number, ranges: Array<{
         begin: number;
@@ -259,27 +253,27 @@ export declare class Assembly extends Endpoint {
      */
     downloadFileRange(requestId: number, records: any | null, dataId: string, onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<void>;
     /**
-     * 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.
      */
     getReferences(signal?: AbortSignal): Promise<IFileReferences>;
     /**
      * 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?: {
@@ -295,8 +289,8 @@ export declare 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(start?: number, limit?: number, name?: string, ids?: string | string[], sortByDesc?: boolean, sortField?: string): Promise<{
@@ -330,28 +324,30 @@ export declare 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, selectionTypeA: string, selectionTypeB: string, selectionSetA?: string | string[], selectionSetB?: string | string[], params?: {
         tolerance?: number | string;

package/lib/Api/ClashTest.d.ts

@@ -17,10 +17,10 @@ export declare 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
      */
@@ -65,8 +65,8 @@ export declare class ClashTest extends Endpoint {
      */
     get owner(): IShortUserDesc;
     /**
-     * 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
      */
@@ -83,8 +83,8 @@ export declare class ClashTest extends Endpoint {
      */
     get selectionTypeA(): string;
     /**
-     * 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
      */
@@ -131,21 +131,21 @@ export declare class ClashTest extends Endpoint {
      */
     delete(): Promise<any>;
     /**
-     * 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>;
     /**
      * 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/lib/Api/Client.d.ts

@@ -10,8 +10,8 @@ import { OAuthClient } from "./OAuthClient";
 import { ISharedLinkPermissions } from "./ISharedLink";
 import { SharedLink } from "./SharedLink";
 /**
- * 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 declare class Client extends EventEmitter2<ClientEventMap> {
     private _serverUrl;
@@ -72,23 +72,23 @@ export declare 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>;
     /**
-     * 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.
      */
     resendConfirmationEmail(email: string, password: string): Promise<any>;
     /**
-     * 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.
      */
@@ -109,15 +109,15 @@ export declare 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;
     private setCurrentUser;
     private clearCurrentUser;
     /**
-     * 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;
     /**
@@ -159,8 +159,8 @@ export declare 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.
@@ -175,8 +175,8 @@ export declare 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.
      */
@@ -184,8 +184,8 @@ export declare 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.
@@ -195,8 +195,8 @@ export declare 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
@@ -206,15 +206,15 @@ export declare 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[]>;
     /**
      * 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.
      */
@@ -222,16 +222,16 @@ export declare 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.
@@ -250,11 +250,11 @@ export declare 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.
      *
@@ -279,12 +279,12 @@ export declare 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.
      */
@@ -308,9 +308,10 @@ export declare 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:
      *
@@ -320,13 +321,13 @@ export declare 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.
      */
     uploadFile(file: globalThis.File, params?: {
@@ -341,8 +342,8 @@ export declare 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
@@ -355,8 +356,8 @@ export declare 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>;
     /**
@@ -375,8 +376,8 @@ export declare 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(status?: string | string[], limit?: number, start?: number, sortByDesc?: boolean, sortField?: string): Promise<{
@@ -403,16 +404,16 @@ export declare 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>;
     /**
-     * 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
@@ -433,12 +434,12 @@ export declare 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(start?: number, limit?: number, name?: string, ids?: string | string[], sortByDesc?: boolean, sortField?: string): Promise<{
@@ -461,14 +462,14 @@ export declare 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(files: string[], name: string, params?: {
@@ -503,8 +504,8 @@ export declare 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, limit?: number, name?: string, ids?: string | string[], sortByDesc?: boolean): Promise<{
         result: Project[];
@@ -552,8 +553,8 @@ export declare 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

package/lib/Api/Endpoint.d.ts

@@ -8,16 +8,16 @@ export declare class Endpoint {
      */
     path: string;
     /**
-     * Endpoint-specific HTTP headers for the `GET`, `POST`, `PUT` and `DELETE` requests. You can add
-     * custom headers at any time.
+     * Endpoint-specific HTTP headers for the `GET`, `POST`, `PUT` and `DELETE` requests. You can
+     * add custom headers at any time.
      */
     headers: HeadersInit;
     httpClient: IHttpClient;
     private _useVersion;
     /**
      * @ignore
-     * @param path - The API path of the endpoint relative to the REST API server URL of the specified HTTP
-     *   client.
+     * @param path - The API path of the endpoint relative to the REST API server URL of the
+     *   specified HTTP client.
      * @param httpClient - HTTP client instance used to send requests to the REST API server.
      * @param headers - Endpoint-specific HTTP headers.
      */
@@ -36,8 +36,8 @@ export declare class Endpoint {
      * @ignore
      * @param relativePath - Nested endpoint relative path.
      * @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.
      */
     get(relativePath: string, signal?: AbortSignal): Promise<Response>;
     /**