files.com 1.2.203 → 1.2.205

package/README.md

@@ -668,6 +668,40 @@ Error
 |     `SiteConfiguration_TrialLockedError`|  `SiteConfigurationError` |
 |     `SiteConfiguration_UserRequestsEnabledRequiredError`|  `SiteConfigurationError` |
 
+## {frontmatter.title}
+
+Certain API operations return lists of objects. When the number of objects in the list is large,
+the API will paginate the results.
+
+The Files.com JavaScript SDK automatically paginates through lists of objects by default.
+
+```javascript title="Example Request" hasDataFormatSelector
+import File from 'files.com/lib/models/File';
+import * as FilesErrors from 'files.com/lib/Errors';
+
+Files.configureNetwork({
+  // true by default
+  autoPaginate: true,
+});
+
+try {
+  const files = await Folder.listFor(path, {
+    search: "some-partial-filename",
+  });
+  for (const file of files) {
+    // Operate on file
+  }
+} 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;
+  }
+}
+```
+
 ## Case Sensitivity
 
 The Files.com API compares files and paths in a case-insensitive manner.

package/_VERSION

@@ -1 +1 @@
-1.2.203
+1.2.205

package/docs/models/Automation.md

@@ -100,8 +100,8 @@
 * `path` (string): Path on which this Automation runs.  Supports globs, except on remote mounts. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
 * `path_time_zone` (string): Timezone to use when rendering timestamps in paths.
 * `recurring_day` (int64): If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
-* `retry_on_failure_interval_in_minutes` (int64): If the Automation fails, retry at this interval (in minutes).
-* `retry_on_failure_number_of_attempts` (int64): If the Automation fails, retry at most this many times.
+* `retry_on_failure_interval_in_minutes` (int64): If the Automation fails, retry at this interval (in minutes).  Acceptable values are 5 through 1440 (one day).  Set to null to disable.
+* `retry_on_failure_number_of_attempts` (int64): If the Automation fails, retry at most this many times.  Maximum allowed value: 10.  Set to null to disable.
 * `schedule` (object): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run in json format.
 * `human_readable_schedule` (string): If trigger is `custom_schedule`, Human readable Custom schedule description for when the automation should be run.
 * `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
@@ -214,8 +214,8 @@ await Automation.create({
 * `name` (string): Name for this automation.
 * `overwrite_files` (boolean): If true, existing files will be overwritten with new files on Move/Copy automations.  Note: by default files will not be overwritten if they appear to be the same file size as the newly incoming file.  Use the `:always_overwrite_size_matching_files` option to override this.
 * `path_time_zone` (string): Timezone to use when rendering timestamps in paths.
-* `retry_on_failure_interval_in_minutes` (int64): If the Automation fails, retry at this interval (in minutes).
-* `retry_on_failure_number_of_attempts` (int64): If the Automation fails, retry at most this many times.
+* `retry_on_failure_interval_in_minutes` (int64): If the Automation fails, retry at this interval (in minutes).  Acceptable values are 5 through 1440 (one day).  Set to null to disable.
+* `retry_on_failure_number_of_attempts` (int64): If the Automation fails, retry at most this many times.  Maximum allowed value: 10.  Set to null to disable.
 * `trigger` (string): How this automation is triggered to run.
 * `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
 * `value` (object): A Hash of attributes specific to the automation type.
@@ -304,8 +304,8 @@ await automation.update({
 * `name` (string): Name for this automation.
 * `overwrite_files` (boolean): If true, existing files will be overwritten with new files on Move/Copy automations.  Note: by default files will not be overwritten if they appear to be the same file size as the newly incoming file.  Use the `:always_overwrite_size_matching_files` option to override this.
 * `path_time_zone` (string): Timezone to use when rendering timestamps in paths.
-* `retry_on_failure_interval_in_minutes` (int64): If the Automation fails, retry at this interval (in minutes).
-* `retry_on_failure_number_of_attempts` (int64): If the Automation fails, retry at most this many times.
+* `retry_on_failure_interval_in_minutes` (int64): If the Automation fails, retry at this interval (in minutes).  Acceptable values are 5 through 1440 (one day).  Set to null to disable.
+* `retry_on_failure_number_of_attempts` (int64): If the Automation fails, retry at most this many times.  Maximum allowed value: 10.  Set to null to disable.
 * `trigger` (string): How this automation is triggered to run.
 * `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
 * `value` (object): A Hash of attributes specific to the automation type.

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

package/lib/models/Automation.js

@@ -187,14 +187,14 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
   (0, _defineProperty2.default)(this, "setRecurringDay", function (value) {
     _this.attributes.recurring_day = value;
   });
-  // int64 # If the Automation fails, retry at this interval (in minutes).
+  // int64 # If the Automation fails, retry at this interval (in minutes).  Acceptable values are 5 through 1440 (one day).  Set to null to disable.
   (0, _defineProperty2.default)(this, "getRetryOnFailureIntervalInMinutes", function () {
     return _this.attributes.retry_on_failure_interval_in_minutes;
   });
   (0, _defineProperty2.default)(this, "setRetryOnFailureIntervalInMinutes", function (value) {
     _this.attributes.retry_on_failure_interval_in_minutes = value;
   });
-  // int64 # If the Automation fails, retry at most this many times.
+  // int64 # If the Automation fails, retry at most this many times.  Maximum allowed value: 10.  Set to null to disable.
   (0, _defineProperty2.default)(this, "getRetryOnFailureNumberOfAttempts", function () {
     return _this.attributes.retry_on_failure_number_of_attempts;
   });
@@ -365,8 +365,8 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
   //   name - string - Name for this automation.
   //   overwrite_files - boolean - If true, existing files will be overwritten with new files on Move/Copy automations.  Note: by default files will not be overwritten if they appear to be the same file size as the newly incoming file.  Use the `:always_overwrite_size_matching_files` option to override this.
   //   path_time_zone - string - Timezone to use when rendering timestamps in paths.
-  //   retry_on_failure_interval_in_minutes - int64 - If the Automation fails, retry at this interval (in minutes).
-  //   retry_on_failure_number_of_attempts - int64 - If the Automation fails, retry at most this many times.
+  //   retry_on_failure_interval_in_minutes - int64 - If the Automation fails, retry at this interval (in minutes).  Acceptable values are 5 through 1440 (one day).  Set to null to disable.
+  //   retry_on_failure_number_of_attempts - int64 - If the Automation fails, retry at most this many times.  Maximum allowed value: 10.  Set to null to disable.
   //   trigger - string - How this automation is triggered to run.
   //   trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
   //   value - object - A Hash of attributes specific to the automation type.
@@ -782,8 +782,8 @@ _Automation = Automation;
 //   name - string - Name for this automation.
 //   overwrite_files - boolean - If true, existing files will be overwritten with new files on Move/Copy automations.  Note: by default files will not be overwritten if they appear to be the same file size as the newly incoming file.  Use the `:always_overwrite_size_matching_files` option to override this.
 //   path_time_zone - string - Timezone to use when rendering timestamps in paths.
-//   retry_on_failure_interval_in_minutes - int64 - If the Automation fails, retry at this interval (in minutes).
-//   retry_on_failure_number_of_attempts - int64 - If the Automation fails, retry at most this many times.
+//   retry_on_failure_interval_in_minutes - int64 - If the Automation fails, retry at this interval (in minutes).  Acceptable values are 5 through 1440 (one day).  Set to null to disable.
+//   retry_on_failure_number_of_attempts - int64 - If the Automation fails, retry at most this many times.  Maximum allowed value: 10.  Set to null to disable.
 //   trigger - string - How this automation is triggered to run.
 //   trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
 //   value - object - A Hash of attributes specific to the automation type.

package/package.json

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

package/src/models/Automation.js

@@ -182,14 +182,14 @@ class Automation {
     this.attributes.recurring_day = value
   }
 
-  // int64 # If the Automation fails, retry at this interval (in minutes).
+  // int64 # If the Automation fails, retry at this interval (in minutes).  Acceptable values are 5 through 1440 (one day).  Set to null to disable.
   getRetryOnFailureIntervalInMinutes = () => this.attributes.retry_on_failure_interval_in_minutes
 
   setRetryOnFailureIntervalInMinutes = value => {
     this.attributes.retry_on_failure_interval_in_minutes = value
   }
 
-  // int64 # If the Automation fails, retry at most this many times.
+  // int64 # If the Automation fails, retry at most this many times.  Maximum allowed value: 10.  Set to null to disable.
   getRetryOnFailureNumberOfAttempts = () => this.attributes.retry_on_failure_number_of_attempts
 
   setRetryOnFailureNumberOfAttempts = value => {
@@ -337,8 +337,8 @@ class Automation {
   //   name - string - Name for this automation.
   //   overwrite_files - boolean - If true, existing files will be overwritten with new files on Move/Copy automations.  Note: by default files will not be overwritten if they appear to be the same file size as the newly incoming file.  Use the `:always_overwrite_size_matching_files` option to override this.
   //   path_time_zone - string - Timezone to use when rendering timestamps in paths.
-  //   retry_on_failure_interval_in_minutes - int64 - If the Automation fails, retry at this interval (in minutes).
-  //   retry_on_failure_number_of_attempts - int64 - If the Automation fails, retry at most this many times.
+  //   retry_on_failure_interval_in_minutes - int64 - If the Automation fails, retry at this interval (in minutes).  Acceptable values are 5 through 1440 (one day).  Set to null to disable.
+  //   retry_on_failure_number_of_attempts - int64 - If the Automation fails, retry at most this many times.  Maximum allowed value: 10.  Set to null to disable.
   //   trigger - string - How this automation is triggered to run.
   //   trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
   //   value - object - A Hash of attributes specific to the automation type.
@@ -578,8 +578,8 @@ class Automation {
   //   name - string - Name for this automation.
   //   overwrite_files - boolean - If true, existing files will be overwritten with new files on Move/Copy automations.  Note: by default files will not be overwritten if they appear to be the same file size as the newly incoming file.  Use the `:always_overwrite_size_matching_files` option to override this.
   //   path_time_zone - string - Timezone to use when rendering timestamps in paths.
-  //   retry_on_failure_interval_in_minutes - int64 - If the Automation fails, retry at this interval (in minutes).
-  //   retry_on_failure_number_of_attempts - int64 - If the Automation fails, retry at most this many times.
+  //   retry_on_failure_interval_in_minutes - int64 - If the Automation fails, retry at this interval (in minutes).  Acceptable values are 5 through 1440 (one day).  Set to null to disable.
+  //   retry_on_failure_number_of_attempts - int64 - If the Automation fails, retry at most this many times.  Maximum allowed value: 10.  Set to null to disable.
   //   trigger - string - How this automation is triggered to run.
   //   trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
   //   value - object - A Hash of attributes specific to the automation type.