files.com 1.1.212 → 1.1.214

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f298bcfed091f21eb8876b3fec2b4bf799dc9558a517475e91bf84ebda754079
-  data.tar.gz: 73edc75fcdc3f00368c7e588fadcf079dbc0bfd3b2f20c7d59af09d3954082b7
+  metadata.gz: 11bd2f9bb9533128c97bf9198afd675c42bc956935f433d2925c20fcf6a72638
+  data.tar.gz: 2b1f492c3470c6fecb11f66b2626b4715be24d70e6a3ddcc7c69034867632caa
 SHA512:
-  metadata.gz: 8821417b213ed08d666ca7e426b7ffc9b2d9e0b47d181e2862eae7324c88b87500b9aa3a5ebc6d3114c034b0104467495530bdcefdcddf2070ea275147104a6f
-  data.tar.gz: 02b15cb5768938d36eb2661a550906a22ed0bd93a99ab1df571c8788904e5b09e31c11ce16b300c8e76306a2f9685c2668070efffa711c38c9031465962f7558
+  metadata.gz: 90627b2d3b8cd0de08fc7833fd4d6345a22a082a2dad560467a40e2da6ea2f07d5712ef13f4fba2a8edf2072a1cca6fbadd706db024965671ee43aeb4fa9814f
+  data.tar.gz: 8025e79d0ca34c65f66cbc568c461f0826317b9d92d46d50e3f55108965fd00ee40dbd95fd4117cea3ca010e1a3d41b8f182e922cdb1c3a8e9e570f73460b6c5

data/README.md

@@ -557,6 +557,28 @@ Files::FolderAdminPermissionRequiredError -> Files::NotAuthorizedError -> Files:
 |`TrialLockedError`|  `SiteConfigurationError` |
 |`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 Ruby SDK automatically paginates through lists of objects by default.
+
+```ruby title="Example Request" hasDataFormatSelector
+begin
+  files = Files::Folder.list_for(path,
+    search: "some-partial-filename"
+  )
+  files.auto_paging_each do |file|
+    # Operate on file
+  end
+rescue Files::NotAuthenticatedError => e
+  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
+rescue Files::Error => e
+  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
+end
+```
+
 ## Case Sensitivity
 
 The Files.com API compares files and paths in a case-insensitive manner.

data/_VERSION

@@ -1 +1 @@
-1.1.212
+1.1.214

data/docs/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 @@ Files::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.
@@ -301,8 +301,8 @@ Files::Automation.update(id,
 * `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.
@@ -405,8 +405,8 @@ 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.

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

@@ -207,7 +207,7 @@ module Files
       @attributes[:recurring_day] = value
     end
 
-    # 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.
     def retry_on_failure_interval_in_minutes
       @attributes[:retry_on_failure_interval_in_minutes]
     end
@@ -216,7 +216,7 @@ module Files
       @attributes[:retry_on_failure_interval_in_minutes] = value
     end
 
-    # 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.
     def retry_on_failure_number_of_attempts
       @attributes[:retry_on_failure_number_of_attempts]
     end
@@ -377,8 +377,8 @@ module Files
     #   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.
@@ -511,8 +511,8 @@ module Files
     #   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.
@@ -584,8 +584,8 @@ module Files
     #   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.

data/lib/files.com/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.212
+  version: 1.1.214
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-01-14 00:00:00.000000000 Z
+date: 2025-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable