files.com 1.2.50 → 1.2.52

package/_VERSION

@@ -1 +1 @@
-1.2.50
+1.2.52

package/docs/models/Automation.md

@@ -15,6 +15,7 @@
     "destination"
   ],
   "disabled": true,
+  "flatten_destination_structure": true,
   "group_ids": [
     1,
     2
@@ -69,6 +70,7 @@
 * `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
 * `destinations` (array): Destination Paths
 * `disabled` (boolean): If true, this automation will not run.
+* `flatten_destination_structure` (boolean): Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination.  If this flag is `true`, the source folder structure will be flattened in the destination.  This is useful for copying or moving files from multiple folders into a single destination folder.
 * `group_ids` (array): IDs of Groups for the Automation (i.e. who to Request File from)
 * `ignore_locked_folders` (boolean): If true, the Lock Folders behavior will be disregarded for automated actions.
 * `interval` (string): If trigger is `daily`, this specifies how often to run this automation.  One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
@@ -151,6 +153,7 @@ await Automation.create({
   'always_overwrite_size_matching_files': true,
   'description': "example",
   'disabled': true,
+  'flatten_destination_structure': true,
   'ignore_locked_folders': true,
   'name': "example",
   'overwrite_files': true,
@@ -182,6 +185,7 @@ await Automation.create({
 * `always_overwrite_size_matching_files` (boolean): Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer.  If this flag is `true` we will overwrite the destination file always.  Note that this may cause large amounts of wasted transfer usage.
 * `description` (string): Description for the this Automation.
 * `disabled` (boolean): If true, this automation will not run.
+* `flatten_destination_structure` (boolean): Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination.  If this flag is `true`, the source folder structure will be flattened in the destination.  This is useful for copying or moving files from multiple folders into a single destination folder.
 * `ignore_locked_folders` (boolean): If true, the Lock Folders behavior will be disregarded for automated actions.
 * `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.
@@ -230,6 +234,7 @@ await automation.update({
   'always_overwrite_size_matching_files': true,
   'description': "example",
   'disabled': true,
+  'flatten_destination_structure': true,
   'ignore_locked_folders': true,
   'name': "example",
   'overwrite_files': true,
@@ -261,6 +266,7 @@ await automation.update({
 * `always_overwrite_size_matching_files` (boolean): Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer.  If this flag is `true` we will overwrite the destination file always.  Note that this may cause large amounts of wasted transfer usage.
 * `description` (string): Description for the this Automation.
 * `disabled` (boolean): If true, this automation will not run.
+* `flatten_destination_structure` (boolean): Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination.  If this flag is `true`, the source folder structure will be flattened in the destination.  This is useful for copying or moving files from multiple folders into a single destination folder.
 * `ignore_locked_folders` (boolean): If true, the Lock Folders behavior will be disregarded for automated actions.
 * `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.
@@ -286,6 +292,7 @@ await automation.update({
     "destination"
   ],
   "disabled": true,
+  "flatten_destination_structure": true,
   "group_ids": [
     1,
     2

package/docs/models/Behavior.md

@@ -13,7 +13,8 @@
   "value": {
     "key": "example value"
   },
-  "disable_parent_folder_behavior": true
+  "disable_parent_folder_behavior": true,
+  "recursive": true
 }
 ```
 
@@ -25,6 +26,7 @@
 * `description` (string): Description for this behavior.
 * `value` (object): Settings for this behavior.  See the section above for an example value to provide here.  Formatting is different for each Behavior type.  May be sent as nested JSON or a single JSON-encoded string.  If using XML encoding for the API call, this data must be sent as a JSON-encoded string.
 * `disable_parent_folder_behavior` (boolean): If true, the parent folder's behavior will be disabled for this folder.
+* `recursive` (boolean): Is behavior recursive?
 * `attachment_file` (file): Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
 * `attachment_delete` (boolean): If true, will delete the file stored in attachment
 
@@ -80,7 +82,7 @@ await Behavior.listFor(path, {
 * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
 * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
 * `path` (string): Required - Path to operate on.
-* `recursive` (string): Show behaviors above this path?
+* `ancestor_behaviors` (string): Show behaviors above this path?
 * `behavior` (string): DEPRECATED: If set only shows folder behaviors matching this behavior type. Use `filter[behavior]` instead.
 
 ---
@@ -91,6 +93,7 @@ await Behavior.listFor(path, {
 await Behavior.create({
   'value': "{\"method\": \"GET\"}",
   'disable_parent_folder_behavior': true,
+  'recursive': true,
   'name': "example",
   'description': "example",
   'path': "path",
@@ -104,6 +107,7 @@ await Behavior.create({
 * `value` (string): The value of the folder behavior.  Can be an integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.
 * `attachment_file` (file): Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
 * `disable_parent_folder_behavior` (boolean): If true, the parent folder's behavior will be disabled for this folder.
+* `recursive` (boolean): Is behavior recursive?
 * `name` (string): Name for this behavior.
 * `description` (string): Description for this behavior.
 * `path` (string): Required - Folder behaviors path.
@@ -144,6 +148,7 @@ const [behavior] = await Behavior.list()
 await behavior.update({
   'value': "{\"method\": \"GET\"}",
   'disable_parent_folder_behavior': true,
+  'recursive': true,
   'name': "example",
   'description': "example",
   'behavior': "webhook",
@@ -158,6 +163,7 @@ await behavior.update({
 * `value` (string): The value of the folder behavior.  Can be an integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.
 * `attachment_file` (file): Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
 * `disable_parent_folder_behavior` (boolean): If true, the parent folder's behavior will be disabled for this folder.
+* `recursive` (boolean): Is behavior recursive?
 * `name` (string): Name for this behavior.
 * `description` (string): Description for this behavior.
 * `behavior` (string): Behavior type.
@@ -177,7 +183,8 @@ await behavior.update({
   "value": {
     "key": "example value"
   },
-  "disable_parent_folder_behavior": true
+  "disable_parent_folder_behavior": true,
+  "recursive": true
 }
 ```
 

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

package/lib/models/Automation.js

@@ -96,6 +96,13 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
   (0, _defineProperty2.default)(this, "setDisabled", function (value) {
     _this.attributes.disabled = value;
   });
+  // boolean # Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination.  If this flag is `true`, the source folder structure will be flattened in the destination.  This is useful for copying or moving files from multiple folders into a single destination folder.
+  (0, _defineProperty2.default)(this, "getFlattenDestinationStructure", function () {
+    return _this.attributes.flatten_destination_structure;
+  });
+  (0, _defineProperty2.default)(this, "setFlattenDestinationStructure", function (value) {
+    _this.attributes.flatten_destination_structure = value;
+  });
   // array # IDs of Groups for the Automation (i.e. who to Request File from)
   (0, _defineProperty2.default)(this, "getGroupIds", function () {
     return _this.attributes.group_ids;
@@ -323,6 +330,7 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
   //   always_overwrite_size_matching_files - boolean - Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer.  If this flag is `true` we will overwrite the destination file always.  Note that this may cause large amounts of wasted transfer usage.
   //   description - string - Description for the this Automation.
   //   disabled - boolean - If true, this automation will not run.
+  //   flatten_destination_structure - boolean - Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination.  If this flag is `true`, the source folder structure will be flattened in the destination.  This is useful for copying or moving files from multiple folders into a single destination folder.
   //   ignore_locked_folders - boolean - If true, the Lock Folders behavior will be disregarded for automated actions.
   //   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.
@@ -718,6 +726,7 @@ _Automation = Automation;
 //   always_overwrite_size_matching_files - boolean - Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer.  If this flag is `true` we will overwrite the destination file always.  Note that this may cause large amounts of wasted transfer usage.
 //   description - string - Description for the this Automation.
 //   disabled - boolean - If true, this automation will not run.
+//   flatten_destination_structure - boolean - Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination.  If this flag is `true`, the source folder structure will be flattened in the destination.  This is useful for copying or moving files from multiple folders into a single destination folder.
 //   ignore_locked_folders - boolean - If true, the Lock Folders behavior will be disregarded for automated actions.
 //   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.

package/lib/models/Behavior.js

@@ -89,6 +89,13 @@ var Behavior = /*#__PURE__*/(0, _createClass2.default)(function Behavior() {
   (0, _defineProperty2.default)(this, "setDisableParentFolderBehavior", function (value) {
     _this.attributes.disable_parent_folder_behavior = value;
   });
+  // boolean # Is behavior recursive?
+  (0, _defineProperty2.default)(this, "getRecursive", function () {
+    return _this.attributes.recursive;
+  });
+  (0, _defineProperty2.default)(this, "setRecursive", function (value) {
+    _this.attributes.recursive = value;
+  });
   // file # Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
   (0, _defineProperty2.default)(this, "getAttachmentFile", function () {
     return _this.attributes.attachment_file;
@@ -107,6 +114,7 @@ var Behavior = /*#__PURE__*/(0, _createClass2.default)(function Behavior() {
   //   value - string - The value of the folder behavior.  Can be an integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.
   //   attachment_file - file - Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
   //   disable_parent_folder_behavior - boolean - If true, the parent folder's behavior will be disabled for this folder.
+  //   recursive - boolean - Is behavior recursive?
   //   name - string - Name for this behavior.
   //   description - string - Description for this behavior.
   //   behavior - string - Behavior type.
@@ -394,7 +402,7 @@ _Behavior = Behavior;
 //   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
 //   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
 //   path (required) - string - Path to operate on.
-//   recursive - string - Show behaviors above this path?
+//   ancestor_behaviors - string - Show behaviors above this path?
 //   behavior - string - DEPRECATED: If set only shows folder behaviors matching this behavior type. Use `filter[behavior]` instead.
 (0, _defineProperty2.default)(Behavior, "listFor", /*#__PURE__*/function () {
   var _ref8 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6(path) {
@@ -439,11 +447,11 @@ _Behavior = Behavior;
           }
           throw new errors.InvalidParameterError("Bad parameter: path must be of type String, received ".concat((0, _utils.getType)(params.path)));
         case 13:
-          if (!(params.recursive && !(0, _utils.isString)(params.recursive))) {
+          if (!(params.ancestor_behaviors && !(0, _utils.isString)(params.ancestor_behaviors))) {
             _context6.next = 15;
             break;
           }
-          throw new errors.InvalidParameterError("Bad parameter: recursive must be of type String, received ".concat((0, _utils.getType)(params.recursive)));
+          throw new errors.InvalidParameterError("Bad parameter: ancestor_behaviors must be of type String, received ".concat((0, _utils.getType)(params.ancestor_behaviors)));
         case 15:
           if (!(params.behavior && !(0, _utils.isString)(params.behavior))) {
             _context6.next = 17;
@@ -472,6 +480,7 @@ _Behavior = Behavior;
 //   value - string - The value of the folder behavior.  Can be an integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.
 //   attachment_file - file - Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
 //   disable_parent_folder_behavior - boolean - If true, the parent folder's behavior will be disabled for this folder.
+//   recursive - boolean - Is behavior recursive?
 //   name - string - Name for this behavior.
 //   description - string - Description for this behavior.
 //   path (required) - string - Folder behaviors path.

package/package.json

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

package/src/models/Automation.js

@@ -91,6 +91,13 @@ class Automation {
     this.attributes.disabled = value
   }
 
+  // boolean # Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination.  If this flag is `true`, the source folder structure will be flattened in the destination.  This is useful for copying or moving files from multiple folders into a single destination folder.
+  getFlattenDestinationStructure = () => this.attributes.flatten_destination_structure
+
+  setFlattenDestinationStructure = value => {
+    this.attributes.flatten_destination_structure = value
+  }
+
   // array # IDs of Groups for the Automation (i.e. who to Request File from)
   getGroupIds = () => this.attributes.group_ids
 
@@ -295,6 +302,7 @@ class Automation {
   //   always_overwrite_size_matching_files - boolean - Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer.  If this flag is `true` we will overwrite the destination file always.  Note that this may cause large amounts of wasted transfer usage.
   //   description - string - Description for the this Automation.
   //   disabled - boolean - If true, this automation will not run.
+  //   flatten_destination_structure - boolean - Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination.  If this flag is `true`, the source folder structure will be flattened in the destination.  This is useful for copying or moving files from multiple folders into a single destination folder.
   //   ignore_locked_folders - boolean - If true, the Lock Folders behavior will be disregarded for automated actions.
   //   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.
@@ -520,6 +528,7 @@ class Automation {
   //   always_overwrite_size_matching_files - boolean - Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer.  If this flag is `true` we will overwrite the destination file always.  Note that this may cause large amounts of wasted transfer usage.
   //   description - string - Description for the this Automation.
   //   disabled - boolean - If true, this automation will not run.
+  //   flatten_destination_structure - boolean - Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination.  If this flag is `true`, the source folder structure will be flattened in the destination.  This is useful for copying or moving files from multiple folders into a single destination folder.
   //   ignore_locked_folders - boolean - If true, the Lock Folders behavior will be disregarded for automated actions.
   //   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.

package/src/models/Behavior.js

@@ -84,6 +84,13 @@ class Behavior {
     this.attributes.disable_parent_folder_behavior = value
   }
 
+  // boolean # Is behavior recursive?
+  getRecursive = () => this.attributes.recursive
+
+  setRecursive = value => {
+    this.attributes.recursive = value
+  }
+
   // file # Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
   getAttachmentFile = () => this.attributes.attachment_file
 
@@ -102,6 +109,7 @@ class Behavior {
   //   value - string - The value of the folder behavior.  Can be an integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.
   //   attachment_file - file - Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
   //   disable_parent_folder_behavior - boolean - If true, the parent folder's behavior will be disabled for this folder.
+  //   recursive - boolean - Is behavior recursive?
   //   name - string - Name for this behavior.
   //   description - string - Description for this behavior.
   //   behavior - string - Behavior type.
@@ -249,7 +257,7 @@ class Behavior {
   //   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
   //   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
   //   path (required) - string - Path to operate on.
-  //   recursive - string - Show behaviors above this path?
+  //   ancestor_behaviors - string - Show behaviors above this path?
   //   behavior - string - DEPRECATED: If set only shows folder behaviors matching this behavior type. Use `filter[behavior]` instead.
   static listFor = async (path, params = {}, options = {}) => {
     if (!isObject(params)) {
@@ -274,8 +282,8 @@ class Behavior {
       throw new errors.InvalidParameterError(`Bad parameter: path must be of type String, received ${getType(params.path)}`)
     }
 
-    if (params.recursive && !isString(params.recursive)) {
-      throw new errors.InvalidParameterError(`Bad parameter: recursive must be of type String, received ${getType(params.recursive)}`)
+    if (params.ancestor_behaviors && !isString(params.ancestor_behaviors)) {
+      throw new errors.InvalidParameterError(`Bad parameter: ancestor_behaviors must be of type String, received ${getType(params.ancestor_behaviors)}`)
     }
 
     if (params.behavior && !isString(params.behavior)) {
@@ -291,6 +299,7 @@ class Behavior {
   //   value - string - The value of the folder behavior.  Can be an integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.
   //   attachment_file - file - Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
   //   disable_parent_folder_behavior - boolean - If true, the parent folder's behavior will be disabled for this folder.
+  //   recursive - boolean - Is behavior recursive?
   //   name - string - Name for this behavior.
   //   description - string - Description for this behavior.
   //   path (required) - string - Folder behaviors path.