files.com 1.2.178 → 1.2.180

package/README.md

@@ -391,6 +391,7 @@ Error
 |     `BadRequest_InvalidFilterAliasCombinationError`|  `BadRequestError` |
 |     `BadRequest_InvalidFilterFieldError`|  `BadRequestError` |
 |     `BadRequest_InvalidFilterParamError`|  `BadRequestError` |
+|     `BadRequest_InvalidFilterParamFormatError`|  `BadRequestError` |
 |     `BadRequest_InvalidFilterParamValueError`|  `BadRequestError` |
 |     `BadRequest_InvalidInputEncodingError`|  `BadRequestError` |
 |     `BadRequest_InvalidInterfaceError`|  `BadRequestError` |
@@ -545,28 +546,12 @@ Error
 |     `SiteConfiguration_TrialLockedError`|  `SiteConfigurationError` |
 |     `SiteConfiguration_UserRequestsEnabledRequiredError`|  `SiteConfigurationError` |
 
-## Mock Server
-
-Files.com publishes a Files.com API server, which is useful for testing your use of the Files.com
-SDKs and other direct integrations against the Files.com API in an integration test environment.
-
-It is a Ruby app that operates as a minimal server for the purpose of testing basic network
-operations and JSON encoding for your SDK or API client. It does not maintain state and it does not
-deeply inspect your submissions for correctness.
-
-Eventually we will add more features intended for integration testing, such as the ability to
-intentionally provoke errors.
-
-Download the server as a Docker image via [Docker Hub](https://hub.docker.com/r/filescom/files-mock-server).
-
-The Source Code is also available on [GitHub](https://github.com/Files-com/files-mock-server).
-
-A README is available on the GitHub link.
-
-## File/Folder Operations
+## Examples
 
 ### Upload
 
+#### Upload a File
+
 ```javascript
 import File from 'files.com/lib/models/File.js';
 import { isBrowser } from 'files.com/lib/utils.js';
@@ -583,6 +568,16 @@ if (!isBrowser()) {
 }
 ```
 
+#### Create a Folder
+
+```javascript
+import Folder from 'files.com/lib/models/Folder.js';
+
+await Folder.create('path/to/folder/to/be/created', {
+  mkdir_parents: true,
+});
+```
+
 ### Download
 
 #### Get a Downloadable File Object by Path
@@ -613,10 +608,57 @@ if (!isBrowser()) {
 
 ### List
 
+#### List Folder Contents
+
 ```javascript
 import Folder from 'files.com/lib/models/Folder.js';
 
-const dirFiles = await Folder.listFor('/');
+const items = await Folder.listFor('remote/path/to/folder/');
+for (const item of items) {
+  console.log(item.path);
+}
+```
+
+### Copy
+
+The copy method works for both files and folders.
+
+```javascript
+import File from 'files.com/lib/models/File.js';
+
+const file = new File({ path: 'source/path' });
+await file.copy({ destination: 'destination/path' });
+```
+
+### Move
+
+The move method works for both files and folders.
+
+```javascript
+import File from 'files.com/lib/models/File.js';
+
+const file = new File({ path: 'source/path' });
+await file.move({ destination: 'destination/path' });
+```
+
+### Delete
+
+The delete method works for both files and folders.
+
+```javascript
+import File from 'files.com/lib/models/File.js';
+
+const file = new File({ path: 'path/to/file/or/folder' });
+await file.delete();
+```
+
+In case the folder is not empty, you can use the `recursive` argument:
+
+```javascript
+import File from 'files.com/lib/models/File.js';
+
+const folder = new File({ path: 'path/to/folder' });
+await folder.delete({ recursive: true });
 ```
 
 ### Comparing Case-Insensitive Files and Paths
@@ -630,3 +672,21 @@ if (pathNormalizer.same('Fïłèńämê.Txt', 'filename.txt')) {
   // the paths are the same
 }
 ```
+
+## Mock Server
+
+Files.com publishes a Files.com API server, which is useful for testing your use of the Files.com
+SDKs and other direct integrations against the Files.com API in an integration test environment.
+
+It is a Ruby app that operates as a minimal server for the purpose of testing basic network
+operations and JSON encoding for your SDK or API client. It does not maintain state and it does not
+deeply inspect your submissions for correctness.
+
+Eventually we will add more features intended for integration testing, such as the ability to
+intentionally provoke errors.
+
+Download the server as a Docker image via [Docker Hub](https://hub.docker.com/r/filescom/files-mock-server).
+
+The Source Code is also available on [GitHub](https://github.com/Files-com/files-mock-server).
+
+A README is available on the GitHub link.

package/_VERSION

@@ -1 +1 @@
-1.2.178
+1.2.180

package/docs/Errors.md

@@ -62,6 +62,7 @@ These errors are derived from the error groups listed above.
 ### BadRequest_InvalidFilterAliasCombinationError
 ### BadRequest_InvalidFilterFieldError
 ### BadRequest_InvalidFilterParamError
+### BadRequest_InvalidFilterParamFormatError
 ### BadRequest_InvalidFilterParamValueError
 ### BadRequest_InvalidInputEncodingError
 ### BadRequest_InvalidInterfaceError

package/docs/models/User.md

@@ -167,7 +167,7 @@ await User.list({
 
 * `cursor` (string): Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `name`, `company`, `site_admin`, `password_validity_days` or `ssl_required`.
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `name`, `company`, `password_validity_days`, `ssl_required` or `username`.
 * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ not_site_admin, username ]` and `[ company, name ]`.
 * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
 * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.