files.com 1.2.198 → 1.2.200

package/README.md

@@ -81,14 +81,25 @@ that user can access, and no access will be granted to site administration funct
 ```javascript title="Example Request"
 import Files from 'files.com/lib/Files';
 import User from 'files.com/lib/models/User';
+import * as FilesErrors from 'files.com/lib/Errors';
 
 Files.setApiKey('YOUR_API_KEY');
 
-// Alternatively, you can specify the API key on a per-object basis in the second parameter to a model constructor.
-const user = new User(params, { apiKey: 'YOUR_API_KEY' });
+try {
+  // Alternatively, you can specify the API key on a per-object basis in the second parameter to a model constructor.
+  const user = new User(params, { apiKey: 'YOUR_API_KEY' });
 
-// You may also specify the API key on a per-request basis in the final parameter to static methods.
-await User.find(id, params, { apiKey: 'YOUR_API_KEY' });
+  // You may also specify the API key on a per-request basis in the final parameter to static methods.
+  await User.find(id, params, { apiKey: 'YOUR_API_KEY' });
+} catch (err) {
+  if (err instanceof FilesErrors.NotAuthenticatedError) {
+    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
+  } else if (err instanceof FilesErrors.FilesError) {
+    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
+  } else {
+    throw err;
+  }
+}
 ```
 
 Don't forget to replace the placeholder, `YOUR_API_KEY`, with your actual API key.
@@ -114,8 +125,19 @@ This returns a session object that can be used to authenticate SDK method calls.
 
 ```javascript title="Example Request"
 import Session from 'files.com/lib/models/Session';
+import * as FilesErrors from 'files.com/lib/Errors';
 
-const session = await Session.create({ username: 'motor', password: 'vroom' });
+try {
+  const session = await Session.create({ username: 'motor', password: 'vroom' });
+} catch (err) {
+  if (err instanceof FilesErrors.NotAuthenticatedError) {
+    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
+  } else if (err instanceof FilesErrors.FilesError) {
+    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
+  } else {
+    throw err;
+  }
+}
 ```
 
 #### Using a Session
@@ -125,15 +147,26 @@ Once a session has been created, you can store the session globally, use the ses
 ```javascript title="Example Request"
 import Files from 'files.com/lib/Files';
 import User from 'files.com/lib/models/User';
+import * as FilesErrors from 'files.com/lib/Errors';
 
 // You may set the returned session ID to be used by default for subsequent requests.
 Files.setSessionId(session.id);
 
-// Alternatively, you can specify the session ID on a per-object basis in the second parameter to a model constructor.
-const user = new User(params, { session_id: session.id });
+try {
+  // Alternatively, you can specify the session ID on a per-object basis in the second parameter to a model constructor.
+  const user = new User(params, { session_id: session.id });
 
-// You may also specify the session ID on a per-request basis in the final parameter to static methods.
-await User.find(id, params, { session_id: session.id });
+  // You may also specify the session ID on a per-request basis in the final parameter to static methods.
+  await User.find(id, params, { session_id: session.id });
+} catch (err) {
+  if (err instanceof FilesErrors.NotAuthenticatedError) {
+    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
+  } else if (err instanceof FilesErrors.FilesError) {
+    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
+  } else {
+    throw err;
+  }
+}
 ```
 
 #### Logging Out
@@ -142,8 +175,19 @@ User sessions can be ended calling the `destroy` method on the `session` object.
 
 ```javascript title="Example Request"
 import Session from 'files.com/lib/models/Session';
+import * as FilesErrors from 'files.com/lib/Errors';
 
-await Session.destroy();
+try {
+  await Session.destroy();
+} catch (err) {
+  if (err instanceof FilesErrors.NotAuthenticatedError) {
+    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
+  } else if (err instanceof FilesErrors.FilesError) {
+    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
+  } else {
+    throw err;
+  }
+}
 ```
 
 ## Configuration
@@ -233,15 +277,26 @@ a value of either ```"asc"``` or ```"desc"``` to specify the sort order.
 
 ```javascript title="Sort Example"
 import User from 'files.com/lib/models/User';
+import * as FilesErrors from 'files.com/lib/Errors';
 
-// Users, sorted by username in ascending order.
-const users = await User.list({
-  sort_by: { username: "asc"}
-});
-
-users.forEach(user => {
-  console.log(user.username);
-});
+try {
+  // Users, sorted by username in ascending order.
+  const users = await User.list({
+    sort_by: { username: "asc" }
+  });
+
+  users.forEach(user => {
+    console.log(user.username);
+  });
+} catch (err) {
+  if (err instanceof FilesErrors.NotAuthenticatedError) {
+    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
+  } else if (err instanceof FilesErrors.FilesError) {
+    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
+  } else {
+    throw err;
+  }
+}
 ```
 
 ### Filtering
@@ -269,56 +324,101 @@ to filter on and a passed in value to use in the filter comparison.
 
 ```javascript title="Exact Filter Example"
 import User from 'files.com/lib/models/User';
+import * as FilesErrors from 'files.com/lib/Errors';
 
-// Users who are not site admins.
-const users = await User.list({
-  filter: { not_site_admin: true }
-});
-
-users.forEach(user => {
-  console.log(user.username);
-});
+try {
+  // Users who are not site admins.
+  const users = await User.list({
+    filter: { not_site_admin: true }
+  });
+
+  users.forEach(user => {
+    console.log(user.username);
+  });
+} catch (err) {
+  if (err instanceof FilesErrors.NotAuthenticatedError) {
+    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
+  } else if (err instanceof FilesErrors.FilesError) {
+    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
+  } else {
+    throw err;
+  }
+}
 ```
 
 ```javascript title="Range Filter Example"
 import User from 'files.com/lib/models/User';
+import * as FilesErrors from 'files.com/lib/Errors';
 
-// Users who haven't logged in since 2024-01-01.
-const users = await User.list({
-  filter_gteq: { last_login_at: "2024-01-01" }
-});
-
-users.forEach(user => {
-  console.log(user.username);
-});
+try {
+  // Users who haven't logged in since 2024-01-01.
+  const users = await User.list({
+    filter_gteq: { last_login_at: "2024-01-01" }
+  });
+
+  users.forEach(user => {
+    console.log(user.username);
+  });
+} catch (err) {
+  if (err instanceof FilesErrors.NotAuthenticatedError) {
+    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
+  } else if (err instanceof FilesErrors.FilesError) {
+    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
+  } else {
+    throw err;
+  }
+}
+```
 ```
 
 ```javascript title="Pattern Filter Example"
 import User from 'files.com/lib/models/User';
+import * as FilesErrors from 'files.com/lib/Errors';
 
-// Users whose usernames start with 'test'.
-const users = await User.list({
-  filter_prefix: { username: "test" }
-});
-
-users.forEach(user => {
-  console.log(user.username);
-});
+try {
+  // Users whose usernames start with 'test'.
+  const users = await User.list({
+    filter_prefix: { username: "test" }
+  });
+
+  users.forEach(user => {
+    console.log(user.username);
+  });
+} catch (err) {
+  if (err instanceof FilesErrors.NotAuthenticatedError) {
+    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
+  } else if (err instanceof FilesErrors.FilesError) {
+    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
+  } else {
+    throw err;
+  }
+}
 ```
 
 ```javascript title="Combination Filter with Sort Example"
 import User from 'files.com/lib/models/User';
+import * as FilesErrors from 'files.com/lib/Errors';
 
-// Users whose usernames start with 'test' and are not site admins, sorted by last login date.
-const users = await User.list({
-  filter_prefix: { username: "test" },
-  filter: { not_site_admin: true },
-  sort_by: { last_login_at: "asc" }
-});
-
-users.forEach(user => {
-  console.log(user.username);
-});
+try {
+  // Users whose usernames start with 'test' and are not site admins, sorted by last login date.
+  const users = await User.list({
+    filter_prefix: { username: "test" },
+    filter: { not_site_admin: true },
+    sort_by: { last_login_at: "asc" }
+  });
+
+  users.forEach(user => {
+    console.log(user.username);
+  });
+} catch (err) {
+  if (err instanceof FilesErrors.NotAuthenticatedError) {
+    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
+  } else if (err instanceof FilesErrors.FilesError) {
+    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
+  } else {
+    throw err;
+  }
+}
 ```
 
 ## Errors
@@ -344,9 +444,9 @@ import * as FilesErrors from 'files.com/lib/Errors';
 
 try {
   const session = await Session.create({ username: 'USERNAME', password: 'BADPASSWORD' });
-} catch(err) {
+} catch (err) {
   if (err instanceof FilesErrors.NotAuthenticatedError) {
-    console.error(`Authorization Error Occurred (${err.constructor.name}): ${err.error}`);
+    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
   } else if (err instanceof FilesErrors.FilesError) {
     console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
   } else {

package/_VERSION

@@ -1 +1 @@
-1.2.198
+1.2.200

package/docs/models/Folder.md

@@ -108,7 +108,7 @@ await Folder.listFor(path, {
 * `path` (string): Required - Path to operate on.
 * `preview_size` (string): Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
 * `sort_by` (object): Search by field and direction. Valid fields are `path`, `size`, `modified_at_datetime`, `provided_modified_at`.  Valid directions are `asc` and `desc`.  Defaults to `{"path":"asc"}`.
-* `search` (string): If specified, will search the folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'.  Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing.  Results may be trunacted if more than 1,000 possible matches exist.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
+* `search` (string): If specified, will search the folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'.  Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing.  Results may be truncated if more than 1,000 possible matches exist.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
 * `search_all` (boolean): Search entire site?  If set, we will ignore the folder path provided and search the entire site.  This is the same API used by the search bar in the web UI when running 'Search All Files'.  Search results are a best effort, not real time, and not guaranteed to match every file.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
 * `with_previews` (boolean): Include file previews?
 * `with_priority_color` (boolean): Include file priority color information?

package/lib/Files.js

@@ -11,7 +11,7 @@ var endpointPrefix = '/api/rest/v1';
 var apiKey;
 var baseUrl = 'https://app.files.com';
 var sessionId = null;
-var version = '1.2.198';
+var version = '1.2.200';
 var userAgent = "Files.com JavaScript SDK v".concat(version);
 var logLevel = _Logger.LogLevel.INFO;
 var debugRequest = false;

package/lib/models/Folder.js

@@ -316,7 +316,7 @@ var Folder = /*#__PURE__*/(0, _createClass2.default)(function Folder() {
 //   path (required) - string - Path to operate on.
 //   preview_size - string - Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
 //   sort_by - object - Search by field and direction. Valid fields are `path`, `size`, `modified_at_datetime`, `provided_modified_at`.  Valid directions are `asc` and `desc`.  Defaults to `{"path":"asc"}`.
-//   search - string - If specified, will search the folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'.  Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing.  Results may be trunacted if more than 1,000 possible matches exist.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
+//   search - string - If specified, will search the folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'.  Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing.  Results may be truncated if more than 1,000 possible matches exist.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
 //   search_all - boolean - Search entire site?  If set, we will ignore the folder path provided and search the entire site.  This is the same API used by the search bar in the web UI when running 'Search All Files'.  Search results are a best effort, not real time, and not guaranteed to match every file.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
 //   with_previews - boolean - Include file previews?
 //   with_priority_color - boolean - Include file priority color information?

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "files.com",
-  "version": "1.2.198",
+  "version": "1.2.200",
   "description": "Files.com SDK for JavaScript",
   "keywords": [
     "files.com",

package/src/Files.js

@@ -5,7 +5,7 @@ const endpointPrefix = '/api/rest/v1'
 let apiKey
 let baseUrl = 'https://app.files.com'
 let sessionId = null
-const version = '1.2.198'
+const version = '1.2.200'
 let userAgent = `Files.com JavaScript SDK v${version}`
 
 let logLevel = LogLevel.INFO

package/src/models/Folder.js

@@ -288,7 +288,7 @@ class Folder {
   //   path (required) - string - Path to operate on.
   //   preview_size - string - Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
   //   sort_by - object - Search by field and direction. Valid fields are `path`, `size`, `modified_at_datetime`, `provided_modified_at`.  Valid directions are `asc` and `desc`.  Defaults to `{"path":"asc"}`.
-  //   search - string - If specified, will search the folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'.  Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing.  Results may be trunacted if more than 1,000 possible matches exist.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
+  //   search - string - If specified, will search the folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'.  Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing.  Results may be truncated if more than 1,000 possible matches exist.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
   //   search_all - boolean - Search entire site?  If set, we will ignore the folder path provided and search the entire site.  This is the same API used by the search bar in the web UI when running 'Search All Files'.  Search results are a best effort, not real time, and not guaranteed to match every file.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
   //   with_previews - boolean - Include file previews?
   //   with_priority_color - boolean - Include file priority color information?