@inweb/client 25.9.6 → 25.9.7

package/lib/Api/Assembly.d.ts

@@ -14,8 +14,9 @@ export declare class Assembly {
     httpClient: IHttpClient;
     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);
     appendVersionParam(relativePath: string): string;
@@ -38,9 +39,8 @@ export declare class Assembly {
      */
     get created(): string;
     /**
-     * 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;
     private set data(value);
@@ -106,13 +106,15 @@ export declare 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}.
      */
     update(data: any): Promise<this>;
     /**
      * 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>;
     /**
@@ -138,13 +140,19 @@ export declare 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>;
+    /**
+     * 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[]>;
     /**
@@ -178,36 +186,39 @@ export declare class Assembly {
      */
     getCdaTree(): Promise<any[]>;
     /**
-     * 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[]>;
     /**
      * 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>;
     /**
      * 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>;
     /**
-     * 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.
      */
     getSnapshot(guid: string): Promise<string>;
     /**
-     * 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>;
     /**
      * Downloads an assembly resource file. Resource files are files that contain model scene
      * descriptions, or geometry data.
@@ -355,7 +366,8 @@ export declare 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>;
     updateVersion(files?: string[], params?: {

package/lib/Api/ClashTest.d.ts

@@ -1,4 +1,5 @@
 import { IHttpClient } from "./IHttpClient";
+import { IClashItem } from "./IAssembly";
 import { IShortUserDesc } from "./IUser";
 /**
  * Provides properties and methods for obtaining information about a file/assembly clash detection test.
@@ -8,7 +9,8 @@ export declare class ClashTest {
     basePath: string;
     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.
      */
@@ -35,7 +37,8 @@ export declare class ClashTest {
      */
     get createdAt(): string;
     /**
-     * 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
      */
@@ -120,13 +123,15 @@ export declare 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}.
      */
     update(data: any): Promise<this>;
     /**
      * 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>;
     /**
@@ -154,7 +159,7 @@ export declare class ClashTest {
         onCheckout?: (test: ClashTest, ready: boolean) => boolean;
     }): Promise<this>;
     /**
-     * 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[]>;
 }

package/lib/Api/Client.d.ts

@@ -53,20 +53,21 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
     configure(params: {
         serverUrl?: string;
     }): 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;
+    }>;
     /**
      * 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 (~!@#$%^&*()_-+={}[]<>|/'":;.,?).
@@ -112,9 +113,15 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
     /**
      * Returns the list of server enabled indentity providers.
      */
-    getIdentityProviders(): Promise<any>;
+    getIdentityProviders(): Promise<{
+        name: string;
+        url: string;
+    }[]>;
     /**
      * 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>;
     /**
@@ -122,6 +129,11 @@ export declare 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>;
     /**
@@ -180,7 +192,8 @@ export declare 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>;
     /**
@@ -205,7 +218,7 @@ export declare 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, limit?: number, name?: string, ext?: string | string[], ids?: string | string[], sortByDesc?: boolean, sortField?: string): Promise<{
         allSize: number;
@@ -265,7 +278,8 @@ export declare 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>;
     /**
@@ -334,7 +348,8 @@ export declare 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>;
     /**
@@ -400,7 +415,8 @@ export declare 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>;
     /**
@@ -449,7 +465,8 @@ export declare 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>;
 }

package/lib/Api/File.d.ts

@@ -14,7 +14,8 @@ export declare class File {
     httpClient: IHttpClient;
     path: string;
     /**
-     * @param data - Raw file data received from the server.
+     * @param data - Raw file data received from the server. For more information, see
+     *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Files | Open Cloud Files API}.
      * @param httpClient - HTTP client instance used to send requests to the REST API server.
      */
     constructor(data: any, httpClient: IHttpClient);
@@ -44,7 +45,8 @@ export declare class File {
     get customFields(): any;
     set customFields(value: any);
     /**
-     * Raw file data received from the server.
+     * Raw file data received from the server. For more information, see
+     * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Files | Open Cloud Files API}.
      *
      * @readonly
      */
@@ -173,7 +175,8 @@ export declare class File {
     /**
      * Updates file data on the server.
      *
-     * @param data - Raw file data.
+     * @param data - Raw file data. For more information, see
+     *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Files | Open Cloud Files API}.
      */
     update(data: any): Promise<this>;
     /**
@@ -182,7 +185,8 @@ export declare class File {
      * You cannot delete a version file using `delete()`, only the original file. To delete a
      * version file use {@link deleteVersion | deleteVersion()}.
      *
-     * @returns Returns the raw data of a deleted file.
+     * @returns Returns the raw data of a deleted file. For more information, see
+     *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Files | Open Cloud Files API}.
      */
     delete(): Promise<any>;
     /**
@@ -211,13 +215,13 @@ export declare class File {
      */
     getModels(): Promise<Model[]>;
     getModelTransformMatrix(handle: string): any;
-    setModelTransformMatrix(handle: string, transform: any): Promise<this>;
+    setModelTransformMatrix(handle: string, transform?: any): Promise<this>;
     /**
      * Object properties.
      *
      * @typedef {any} Properties
      * @property {string} handle - Object original handle.
-     * @property {string | any} * - Object property. Can be `any` for nested properties.
+     * @property {string | any} - Object property. Can be `any` for nested properties.
      */
     /**
      * Returns the properties for an objects in the active version of the file.
@@ -273,20 +277,23 @@ export declare class File {
      */
     getCdaTree(): Promise<any[]>;
     /**
-     * Returns a list of file viewpoints.
+     * Returns a list of file viewpoints. For more information, see
+     * {@link https://cloud.opendesign.com/docs//pages/server/api.html#FileViewpoints | Open Cloud File Viewpoints API}.
      */
     getViewpoints(): Promise<any[]>;
     /**
      * Saves a new file viewpoint to the server. To create a viewpoint use `Viewer.createViewpoint()`.
      *
-     * @param viewpoint - Viewpoint.
+     * @param viewpoint - Viewpoint object. For more information, see
+     *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#FileViewpoints | Open Cloud File Viewpoints API}.
      */
     saveViewpoint(viewpoint: any): Promise<any>;
     /**
      * Deletes the specified file viewpoint.
      *
      * @param guid - Viewpoint GUID.
-     * @returns Returns the raw data of a deleted viewpoint.
+     * @returns Returns the raw data of a deleted viewpoint. For more information, see
+     *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#FileViewpoints | Open Cloud File Viewpoints API}.
      */
     deleteViewpoint(guid: string): Promise<any>;
     /**
@@ -494,7 +501,8 @@ export declare class File {
      * Removes the specified permission from the file.
      *
      * @param permissionId - Permission ID.
-     * @returns Returns the raw data of a deleted permission.
+     * @returns Returns the raw data of a deleted permission. For more information, see
+     *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Permission | Open Cloud File Permissions API}.
      */
     deletePermission(permissionId: string): Promise<any>;
     /**
@@ -542,6 +550,8 @@ export declare class File {
      * Deletes the specified version file.
      *
      * @param version - Version to delete.
+     * @returns Returns the raw data of a deleted version file. For more information, see
+     *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Files | Open Cloud Files API}.
      */
     deleteVersion(version: number): Promise<any>;
     /**

package/lib/Api/IAssembly.d.ts

@@ -1,5 +1,14 @@
+/**
+ * Defines the information about file from which the assembly was created.
+ */
 export interface IAssociatedFileData {
+    /**
+     * File ID.
+     */
     fileId: string;
+    /**
+     * File name.
+     */
     name: string;
     link: string;
     version?: number;
@@ -37,3 +46,20 @@ export interface IModelTransformMatrix {
      */
     scale: number;
 }
+/**
+ * Defines the information about the clash of two objects.
+ */
+export interface IClashItem {
+    /**
+     * Handle of the first object, including the assembly model index in the form "model_object".
+     */
+    first: string;
+    /**
+     * Handle of the second object, including the assembly model index in the form "model_object".
+     */
+    second: string;
+    /**
+     * The distance between objects.
+     */
+    distance: number;
+}

package/lib/Api/IFile.d.ts

@@ -59,16 +59,37 @@ export interface IFileReferences {
      */
     references: IFileReference[] | null;
 }
+/**
+ * Defines the information about file version.
+ */
 export interface IFileVersionInfo {
+    /**
+     * Version file ID.
+     */
     fileId: string;
+    /**
+     * Version file data status.
+     */
     status: IFileStatus;
+    /**
+     * Zero-based version number. The original file has version `0`.
+     */
     version: number;
+    /**
+     * Version creation time (UTC).
+     */
     createdAt: string;
+    /**
+     * Size of the version file in bytes.
+     */
     size: number;
+    /**
+     * ID of the user who created the version.
+     */
     ownerId: string;
 }
 /**
- * Defines the entity, that will have access to the {@link File | file}.
+ * Defines the user, project, or group that will have access to the {@link File | file}.
  */
 export interface IGrantedTo {
     /**

package/lib/Api/Job.d.ts

@@ -6,7 +6,8 @@ export declare class Job {
     private _data;
     httpClient: IHttpClient;
     /**
-     * @param data - Raw job data received from the server.
+     * @param data - Raw job data received from the server. For more information, see
+     *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Jobs | Open Cloud Jobs API}.
      * @param httpClient - HTTP client instance used to send requests to the REST API server.
      */
     constructor(data: any, httpClient: IHttpClient);
@@ -33,7 +34,8 @@ export declare class Job {
      */
     get createdAt(): string;
     /**
-     * Raw job data received from the server.
+     * Raw job data received from the server. For more information, see
+     * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Jobs | Open Cloud Jobs API}.
      *
      * @readonly
      */
@@ -72,7 +74,8 @@ export declare class Job {
      */
     get outputFormat(): string;
     /**
-     * Parameters for the job runner.
+     * Parameters with which the job runner was started. For more information, see
+     * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Jobs | Open Cloud Jobs API}.
      *
      * @readonly
      */
@@ -106,14 +109,16 @@ export declare class Job {
      * Only administrators can update job data. If the current logged in user is not an
      * administrator, an exception will be thrown.
      *
-     * @param data - Raw job data.
+     * @param data - Raw job data. For more information, see
+     *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Jobs | Open Cloud Jobs API}.
      */
     update(data: any): Promise<this>;
     /**
      * Deletes a job from the server job list. Jobs that are in progress or have already been
      * completed cannot be deleted.
      *
-     * @returns Returns the raw data of a deleted job.
+     * @returns Returns the raw data of a deleted job. For more information, see
+     *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Jobs | Open Cloud Jobs API}.
      */
     delete(): Promise<any>;
     /**

package/lib/Api/Member.d.ts

@@ -9,7 +9,8 @@ export declare class Member {
     projectId: string;
     httpClient: IHttpClient;
     /**
-     * @param data - Raw member data received from the server.
+     * @param data - Raw member data received from the server. For more information, see
+     *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
      * @param projectId - Owner project ID.
      * @param httpClient - HTTP client instance used to send requests to the REST API server.
      */
@@ -18,7 +19,8 @@ export declare class Member {
     private internalPut;
     private internalDelete;
     /**
-     * Raw member data received from the server.
+     * Raw member data received from the server. For more information, see
+     * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
      *
      * @readonly
      */
@@ -55,13 +57,15 @@ export declare class Member {
     /**
      * Updates member data on the server.
      *
-     * @param data - Raw member data.
+     * @param data - Raw member data. For more information, see
+     *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
      */
     update(data: any): Promise<this>;
     /**
      * Removes a member from the project.
      *
-     * @returns Returns the raw data of a deleted member.
+     * @returns Returns the raw data of a deleted member. For more information, see
+     *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
      */
     delete(): Promise<any>;
     /**

package/lib/Api/Model.d.ts

@@ -1,10 +1,12 @@
 import { IHttpClient } from "./IHttpClient";
 import type { File } from "./File";
 import type { Assembly } from "./Assembly";
+import type { IFileReferences } from "./IFile";
 import type { IModelTransformMatrix } from "./IAssembly";
 /**
- * Provides properties and methods for working with view of the file or assembly. For example,
- * for `dwg` it is a `Model` space or layout, and for `rvt` files it is a `3D` view.
+ * Provides properties and methods for working with view of the {@link File | file} or
+ * {@link Assembly| assembly}. For example, for `dwg` it is a `Model` space or layout, and for
+ * `rvt` files it is a `3D` view.
  */
 export declare class Model {
     private _data;
@@ -97,7 +99,7 @@ export declare class Model {
      * @param handle - Model handle.
      * @param transform - Transformation matrix. Specify `undefined` to remove transformation.
      */
-    setModelTransformMatrix(handle: string, transform: IModelTransformMatrix): Promise<this>;
+    setModelTransformMatrix(handle: string, transform?: IModelTransformMatrix): Promise<this>;
     /**
      * Returns a list of viewpoints of the owner file/assembly.
      */
@@ -106,7 +108,7 @@ export declare class Model {
      * Saves a new model owner file/assembly viewpoint to the server. To create a new viewpoint
      * use `Viewer.createViewpoint()`.
      *
-     * @param viewpoint - Viewpoint.
+     * @param viewpoint - Viewpoint object.
      */
     saveViewpoint(viewpoint: any): Promise<any>;
     /**
@@ -179,5 +181,5 @@ export declare class Model {
      *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
      *   signal, which can be used to abort waiting as desired.
      */
-    getReferences(signal?: AbortSignal): Promise<any>;
+    getReferences(signal?: AbortSignal): Promise<IFileReferences>;
 }