@inweb/client 26.12.6 → 27.1.0

package/lib/Api/Client.d.ts

@@ -274,7 +274,8 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * @property {number} size - The number of files in the result list.
      */
     /**
-     * Returns a list of files that the current logged in user has uploaded to the server or has access to.
+     * Returns a list of files that the current logged in user has uploaded to the server or has access to
+     * through a project.
      *
      * @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.
@@ -282,7 +283,8 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * @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 ids - List of file IDs to return. The list can include files that the user has access to
+     *   through a project. If not specified, only files uploaded by the current user are returned.
      * @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.
@@ -296,7 +298,8 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
         size: number;
     }>;
     /**
-     * Returns information about the specified file.
+     * Returns information about the specified file that the current logged in user has uploaded or has
+     * access to through a project.
      *
      * @param fileId - File ID.
      */

package/package.json

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

package/src/Api/Client.ts

@@ -524,7 +524,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
    */
 
   /**
-   * Returns a list of files that the current logged in user has uploaded to the server or has access to.
+   * Returns a list of files that the current logged in user has uploaded to the server or has access to
+   * through a project.
    *
    * @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.
@@ -532,7 +533,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @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 ids - List of file IDs to return. The list can include files that the user has access to
+   *   through a project. If not specified, only files uploaded by the current user are returned.
    * @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.
@@ -585,7 +587,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
   }
 
   /**
-   * Returns information about the specified file.
+   * Returns information about the specified file that the current logged in user has uploaded or has
+   * access to through a project.
    *
    * @param fileId - File ID.
    */