files.com 1.2.197 → 1.2.199

package/README.md

@@ -79,13 +79,27 @@ access to the entire API. If the user is not an administrator, you will only be
 that user can access, and no access will be granted to site administration functions in the API.
 
 ```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.
@@ -110,7 +124,20 @@ password.
 This returns a session object that can be used to authenticate SDK method calls.
 
 ```javascript title="Example Request"
-const session = await Session.create({ username: 'motor', password: 'vroom' });
+import Session from 'files.com/lib/models/Session';
+import * as FilesErrors from 'files.com/lib/Errors';
+
+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
@@ -118,14 +145,28 @@ const session = await Session.create({ username: 'motor', password: 'vroom' });
 Once a session has been created, you can store the session globally, use the session per object, or use the session per request to authenticate SDK operations.
 
 ```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
@@ -133,7 +174,20 @@ await User.find(id, params, { session_id: session.id });
 User sessions can be ended calling the `destroy` method on the `session` object.
 
 ```javascript title="Example Request"
-await Session.destroy();
+import Session from 'files.com/lib/models/Session';
+import * as FilesErrors from 'files.com/lib/Errors';
+
+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
@@ -148,6 +202,8 @@ Setting the base URL for the API is required if your site is configured to disab
 This can also be set to use a mock server in development or CI.
 
 ```javascript title="Example setting"
+import Files from 'files.com/lib/Files';
+
 Files.setBaseUrl("https://MY-SUBDOMAIN.files.com");
 ```
 
@@ -162,7 +218,8 @@ Supported values:
 * LogLevel.DEBUG
 
 ```javascript title="Example setting"
-import { LogLevel } from 'files.com/lib/Logger.js';
+import Files from 'files.com/lib/Files';
+import { LogLevel } from 'files.com/lib/Logger';
 
 Files.setLogLevel(LogLevel.INFO);
 ```
@@ -172,6 +229,8 @@ Files.setLogLevel(LogLevel.INFO);
 Enable debug logging of API requests and/or response headers. Both settings default to `false`.
 
 ```javascript title="Example setting"
+import Files from 'files.com/lib/Files';
+
 Files.configureDebugging({
   debugRequest: true,
   debugResponseHeaders: true,
@@ -181,6 +240,8 @@ Files.configureDebugging({
 #### Network Settings
 
 ```javascript title="Example setting"
+import Files from 'files.com/lib/Files';
+
 Files.configureNetwork({
   // max retries (default: 3)
   maxNetworkRetries: 3,
@@ -215,16 +276,27 @@ The argument value is a Javascript object that has a property of the resource fi
 a value of either ```"asc"``` or ```"desc"``` to specify the sort order.
 
 ```javascript title="Sort Example"
-Files.setApiKey('my-key');
+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
@@ -251,57 +323,102 @@ to filter on and a passed in value to use in the filter comparison.
 | `filter_lteq` | Range | Find resources that have a field value that is less than or equal to the passed in value.  (i.e., FIELD_VALUE \<= PASS_IN_VALUE). |
 
 ```javascript title="Exact Filter Example"
-Files.setApiKey('my-key');
-
-// Users who are not site admins.
-const users = await User.list({
-  filter: { not_site_admin: true }
-});
+import User from 'files.com/lib/models/User';
+import * as FilesErrors from 'files.com/lib/Errors';
 
-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"
-Files.setApiKey('my-key');
-
-// Users who haven't logged in since 2024-01-01.
-const users = await User.list({
-  filter_gteq: { last_login_at: "2024-01-01" }
-});
+import User from 'files.com/lib/models/User';
+import * as FilesErrors from 'files.com/lib/Errors';
 
-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"
-Files.setApiKey('my-key');
-
-// Users whose usernames start with 'test'.
-const users = await User.list({
-  filter_prefix: { username: "test" }
-});
+import User from 'files.com/lib/models/User';
+import * as FilesErrors from 'files.com/lib/Errors';
 
-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"
-Files.setApiKey('my-key');
+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
@@ -322,14 +439,14 @@ Use standard Javascript exception handling to detect and deal with errors.  It i
 catch the general `FilesError` exception as a catch-all.
 
 ```javascript title="Example Error Handling"
-import Session from 'files.com/lib/models/Session.js';
-import * as FilesErrors from 'files.com/lib/Errors.js';
+import Session from 'files.com/lib/models/Session';
+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 {
@@ -346,7 +463,7 @@ SDK errors are general errors that occur within the SDK code.  These errors gene
 exception classes inherit from a standard `FilesError` base class.
 
 ```javascript title="Example SDK Exception Class Inheritance Structure"
-import * as FilesErrors from 'files.com/lib/Errors.js'
+import * as FilesErrors from 'files.com/lib/Errors'
 
 FilesErrors.ConfigurationError ->
 FilesErrors.FilesError ->
@@ -367,8 +484,8 @@ Error
 API errors are errors returned by the Files.com API.  Each exception class inherits from an error group base class.
 The error group base class indicates a particular type of error.
 
-```shell title="Example API Exception Class Inheritance Structure"
-import * as FilesErrors from 'files.com/lib/Errors.js'
+```javascript title="Example API Exception Class Inheritance Structure"
+import * as FilesErrors from 'files.com/lib/Errors'
 
 FilesErrors.NotAuthorized_FolderAdminPermissionRequiredError ->
 FilesErrors.NotAuthorizedError ->
@@ -562,7 +679,7 @@ when handling errors related to duplicate file names and when developing tools f
 synchronization.
 
 ```javascript title="Compare Case-Insensitive Files and Paths"
-import { pathNormalizer } from 'files.com/lib/utils.js';
+import { pathNormalizer } from 'files.com/lib/utils';
 
 if (pathNormalizer.same('Fïłèńämê.Txt', 'filename.txt')) {
   // the paths are the same

package/_VERSION

@@ -1 +1 @@
-1.2.197
+1.2.199

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.197';
+var version = '1.2.199';
 var userAgent = "Files.com JavaScript SDK v".concat(version);
 var logLevel = _Logger.LogLevel.INFO;
 var debugRequest = false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "files.com",
-  "version": "1.2.197",
+  "version": "1.2.199",
   "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.197'
+const version = '1.2.199'
 let userAgent = `Files.com JavaScript SDK v${version}`
 
 let logLevel = LogLevel.INFO