files.com 1.1.212 → 1.1.214

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f298bcfed091f21eb8876b3fec2b4bf799dc9558a517475e91bf84ebda754079
4
- data.tar.gz: 73edc75fcdc3f00368c7e588fadcf079dbc0bfd3b2f20c7d59af09d3954082b7
3
+ metadata.gz: 11bd2f9bb9533128c97bf9198afd675c42bc956935f433d2925c20fcf6a72638
4
+ data.tar.gz: 2b1f492c3470c6fecb11f66b2626b4715be24d70e6a3ddcc7c69034867632caa
5
5
  SHA512:
6
- metadata.gz: 8821417b213ed08d666ca7e426b7ffc9b2d9e0b47d181e2862eae7324c88b87500b9aa3a5ebc6d3114c034b0104467495530bdcefdcddf2070ea275147104a6f
7
- data.tar.gz: 02b15cb5768938d36eb2661a550906a22ed0bd93a99ab1df571c8788904e5b09e31c11ce16b300c8e76306a2f9685c2668070efffa711c38c9031465962f7558
6
+ metadata.gz: 90627b2d3b8cd0de08fc7833fd4d6345a22a082a2dad560467a40e2da6ea2f07d5712ef13f4fba2a8edf2072a1cca6fbadd706db024965671ee43aeb4fa9814f
7
+ data.tar.gz: 8025e79d0ca34c65f66cbc568c461f0826317b9d92d46d50e3f55108965fd00ee40dbd95fd4117cea3ca010e1a3d41b8f182e922cdb1c3a8e9e570f73460b6c5
data/README.md CHANGED
@@ -557,6 +557,28 @@ Files::FolderAdminPermissionRequiredError -> Files::NotAuthorizedError -> Files:
557
557
  |`TrialLockedError`| `SiteConfigurationError` |
558
558
  |`UserRequestsEnabledRequiredError`| `SiteConfigurationError` |
559
559
 
560
+ ## {frontmatter.title}
561
+
562
+ Certain API operations return lists of objects. When the number of objects in the list is large,
563
+ the API will paginate the results.
564
+
565
+ The Files.com Ruby SDK automatically paginates through lists of objects by default.
566
+
567
+ ```ruby title="Example Request" hasDataFormatSelector
568
+ begin
569
+ files = Files::Folder.list_for(path,
570
+ search: "some-partial-filename"
571
+ )
572
+ files.auto_paging_each do |file|
573
+ # Operate on file
574
+ end
575
+ rescue Files::NotAuthenticatedError => e
576
+ puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
577
+ rescue Files::Error => e
578
+ puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
579
+ end
580
+ ```
581
+
560
582
  ## Case Sensitivity
561
583
 
562
584
  The Files.com API compares files and paths in a case-insensitive manner.
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.212
1
+ 1.1.214
data/docs/automation.md CHANGED
@@ -100,8 +100,8 @@
100
100
  * `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.
101
101
  * `path_time_zone` (string): Timezone to use when rendering timestamps in paths.
102
102
  * `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`.
103
- * `retry_on_failure_interval_in_minutes` (int64): If the Automation fails, retry at this interval (in minutes).
104
- * `retry_on_failure_number_of_attempts` (int64): If the Automation fails, retry at most this many times.
103
+ * `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.
104
+ * `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.
105
105
  * `schedule` (object): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run in json format.
106
106
  * `human_readable_schedule` (string): If trigger is `custom_schedule`, Human readable Custom schedule description for when the automation should be run.
107
107
  * `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(
214
214
  * `name` (string): Name for this automation.
215
215
  * `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.
216
216
  * `path_time_zone` (string): Timezone to use when rendering timestamps in paths.
217
- * `retry_on_failure_interval_in_minutes` (int64): If the Automation fails, retry at this interval (in minutes).
218
- * `retry_on_failure_number_of_attempts` (int64): If the Automation fails, retry at most this many times.
217
+ * `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.
218
+ * `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.
219
219
  * `trigger` (string): How this automation is triggered to run.
220
220
  * `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
221
221
  * `value` (object): A Hash of attributes specific to the automation type.
@@ -301,8 +301,8 @@ Files::Automation.update(id,
301
301
  * `name` (string): Name for this automation.
302
302
  * `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.
303
303
  * `path_time_zone` (string): Timezone to use when rendering timestamps in paths.
304
- * `retry_on_failure_interval_in_minutes` (int64): If the Automation fails, retry at this interval (in minutes).
305
- * `retry_on_failure_number_of_attempts` (int64): If the Automation fails, retry at most this many times.
304
+ * `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.
305
+ * `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.
306
306
  * `trigger` (string): How this automation is triggered to run.
307
307
  * `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
308
308
  * `value` (object): A Hash of attributes specific to the automation type.
@@ -405,8 +405,8 @@ automation.update(
405
405
  * `name` (string): Name for this automation.
406
406
  * `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.
407
407
  * `path_time_zone` (string): Timezone to use when rendering timestamps in paths.
408
- * `retry_on_failure_interval_in_minutes` (int64): If the Automation fails, retry at this interval (in minutes).
409
- * `retry_on_failure_number_of_attempts` (int64): If the Automation fails, retry at most this many times.
408
+ * `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.
409
+ * `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.
410
410
  * `trigger` (string): How this automation is triggered to run.
411
411
  * `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
412
412
  * `value` (object): A Hash of attributes specific to the automation type.
@@ -207,7 +207,7 @@ module Files
207
207
  @attributes[:recurring_day] = value
208
208
  end
209
209
 
210
- # int64 - If the Automation fails, retry at this interval (in minutes).
210
+ # int64 - If the Automation fails, retry at this interval (in minutes). Acceptable values are 5 through 1440 (one day). Set to null to disable.
211
211
  def retry_on_failure_interval_in_minutes
212
212
  @attributes[:retry_on_failure_interval_in_minutes]
213
213
  end
@@ -216,7 +216,7 @@ module Files
216
216
  @attributes[:retry_on_failure_interval_in_minutes] = value
217
217
  end
218
218
 
219
- # int64 - If the Automation fails, retry at most this many times.
219
+ # int64 - If the Automation fails, retry at most this many times. Maximum allowed value: 10. Set to null to disable.
220
220
  def retry_on_failure_number_of_attempts
221
221
  @attributes[:retry_on_failure_number_of_attempts]
222
222
  end
@@ -377,8 +377,8 @@ module Files
377
377
  # name - string - Name for this automation.
378
378
  # 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.
379
379
  # path_time_zone - string - Timezone to use when rendering timestamps in paths.
380
- # retry_on_failure_interval_in_minutes - int64 - If the Automation fails, retry at this interval (in minutes).
381
- # retry_on_failure_number_of_attempts - int64 - If the Automation fails, retry at most this many times.
380
+ # 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.
381
+ # 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.
382
382
  # trigger - string - How this automation is triggered to run.
383
383
  # 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
384
384
  # value - object - A Hash of attributes specific to the automation type.
@@ -511,8 +511,8 @@ module Files
511
511
  # name - string - Name for this automation.
512
512
  # 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.
513
513
  # path_time_zone - string - Timezone to use when rendering timestamps in paths.
514
- # retry_on_failure_interval_in_minutes - int64 - If the Automation fails, retry at this interval (in minutes).
515
- # retry_on_failure_number_of_attempts - int64 - If the Automation fails, retry at most this many times.
514
+ # 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.
515
+ # 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.
516
516
  # trigger - string - How this automation is triggered to run.
517
517
  # 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
518
518
  # value - object - A Hash of attributes specific to the automation type.
@@ -584,8 +584,8 @@ module Files
584
584
  # name - string - Name for this automation.
585
585
  # 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.
586
586
  # path_time_zone - string - Timezone to use when rendering timestamps in paths.
587
- # retry_on_failure_interval_in_minutes - int64 - If the Automation fails, retry at this interval (in minutes).
588
- # retry_on_failure_number_of_attempts - int64 - If the Automation fails, retry at most this many times.
587
+ # 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.
588
+ # 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.
589
589
  # trigger - string - How this automation is triggered to run.
590
590
  # 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
591
591
  # value - object - A Hash of attributes specific to the automation type.
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Files
4
- VERSION = "1.1.212"
4
+ VERSION = "1.1.214"
5
5
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: files.com
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.212
4
+ version: 1.1.214
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-01-14 00:00:00.000000000 Z
11
+ date: 2025-01-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable