files.com 1.1.58 → 1.1.60

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 948523e774c915cb425a1e647fe90a8e9c9fb27025be60b99e4ce38575dba0c5
-  data.tar.gz: 78e8bfc8a77e89a81a4958e453f1490ecc7d0c4e4b41f7a16366dda58822087c
+  metadata.gz: fa067300739233694bf0dac0061b367f3e65ad6efc0b4ec6261c206c410d22f0
+  data.tar.gz: b3be973b3f2e73d32494cc8908da36c95a5cd9f4e26aada993b0128635687e1e
 SHA512:
-  metadata.gz: 0df0cdf920ed758bee09414d82cfefb74cba9d8e4ca816d95d47bb9c9915880c91ec9d6d8db8f0f2e2d7d70aab2235c507249d9824dd57df80957850ba16ca84
-  data.tar.gz: 5ba379033b66c3d2dd84562b3291e703d30f18bfa2575020425479459992a155f32343a823c841ba5702c8c9ba2dc70c3b8ec81006c16ebbe55c70e33c36eb19
+  metadata.gz: b9e10fb760b852c97122cfb49962b5a21473f03af8533ddc3f594abdd8ff4b7a4eb4479b0367d92373a92b3ec669dbd694a398fc3403be38a696178183718a23
+  data.tar.gz: f33e2e45041ba265595acc7d8f63fc4c43db76a17baa71274abf073a79e762b719d00821ef9cab902a0badcc03cd38e8e909cbab14d73365364e6ae6e6aef62c

data/_VERSION

@@ -1 +1 @@
-1.1.58
+1.1.60

data/docs/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`
@@ -152,6 +154,7 @@ Files::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 @@ Files::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.
@@ -227,6 +231,7 @@ Files::Automation.update(id,
   always_overwrite_size_matching_files: true, 
   description: "example", 
   disabled: true, 
+  flatten_destination_structure: true, 
   ignore_locked_folders: true, 
   name: "example", 
   overwrite_files: true, 
@@ -258,6 +263,7 @@ Files::Automation.update(id,
 * `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.
@@ -320,6 +326,7 @@ 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,
@@ -351,6 +358,7 @@ 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.

data/docs/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 @@ Files::Behavior.list_for(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.
 
 
@@ -92,6 +94,7 @@ Files::Behavior.list_for(path,
 Files::Behavior.create(
   value: "{\"method\": \"GET\"}", 
   disable_parent_folder_behavior: true, 
+  recursive: true, 
   name: "example", 
   description: "example", 
   path: "path", 
@@ -104,6 +107,7 @@ Files::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.
@@ -143,6 +147,7 @@ Files::Behavior.webhook_test(
 Files::Behavior.update(id, 
   value: "{\"method\": \"GET\"}", 
   disable_parent_folder_behavior: true, 
+  recursive: true, 
   name: "example", 
   description: "example", 
   behavior: "webhook", 
@@ -157,6 +162,7 @@ Files::Behavior.update(id,
 * `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.
@@ -187,6 +193,7 @@ behavior = Files::Behavior.list.first
 behavior.update(
   value: "{\"method\": \"GET\"}",
   disable_parent_folder_behavior: true,
+  recursive: true,
   name: "example",
   description: "example",
   behavior: "webhook",
@@ -201,6 +208,7 @@ 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.

data/lib/files.com/models/automation.rb

@@ -90,6 +90,15 @@ module Files
       @attributes[:disabled] = value
     end
 
+    # 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.
+    def flatten_destination_structure
+      @attributes[:flatten_destination_structure]
+    end
+
+    def flatten_destination_structure=(value)
+      @attributes[:flatten_destination_structure] = value
+    end
+
     # array - IDs of Groups for the Automation (i.e. who to Request File from)
     def group_ids
       @attributes[:group_ids]
@@ -325,6 +334,7 @@ module Files
     #   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.
@@ -452,6 +462,7 @@ module Files
     #   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.
@@ -517,6 +528,7 @@ module Files
     #   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.

data/lib/files.com/models/behavior.rb

@@ -81,6 +81,15 @@ module Files
       @attributes[:disable_parent_folder_behavior] = value
     end
 
+    # boolean - Is behavior recursive?
+    def recursive
+      @attributes[:recursive]
+    end
+
+    def recursive=(value)
+      @attributes[:recursive] = value
+    end
+
     # file - Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
     def attachment_file
       @attributes[:attachment_file]
@@ -103,6 +112,7 @@ module Files
     #   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.
@@ -194,7 +204,7 @@ module Files
     #   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.
     def self.list_for(path, params = {}, options = {})
       params ||= {}
@@ -205,7 +215,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
       raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
       raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: recursive must be an String") if params[:recursive] and !params[:recursive].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: ancestor_behaviors must be an String") if params[:ancestor_behaviors] and !params[:ancestor_behaviors].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: behavior must be an String") if params[:behavior] and !params[:behavior].is_a?(String)
       raise MissingParameterError.new("Parameter missing: path") unless params[:path]
 
@@ -218,6 +228,7 @@ module Files
     #   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.
@@ -259,6 +270,7 @@ module Files
     #   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.

data/lib/files.com/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Files
-  VERSION = "1.1.58"
+  VERSION = "1.1.60"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.58
+  version: 1.1.60
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-29 00:00:00.000000000 Z
+date: 2024-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable