Files.com 1.4.210__tar.gz → 1.4.212__tar.gz

{Files.com-1.4.210 → Files.com-1.4.212}/Files.com.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: Files.com
-Version: 1.4.210
+Version: 1.4.212
 Summary: Python bindings for the Files.com API
 Home-page: UNKNOWN
 License: MIT

{Files.com-1.4.210 → Files.com-1.4.212}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: Files.com
-Version: 1.4.210
+Version: 1.4.212
 Summary: Python bindings for the Files.com API
 Home-page: UNKNOWN
 License: MIT

{Files.com-1.4.210 → Files.com-1.4.212}/README.md

@@ -584,6 +584,51 @@ files_sdk.error.FolderAdminPermissionRequiredError -> files_sdk.error.NotAuthori
 |`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 Python SDK provides multiple ways to paginate through lists of objects.
+
+### Automatic Pagination
+
+The `auto_paging_iter` method automatically paginates and loads each page into memory.
+
+```python title="Example Request"
+import files_sdk
+
+try:
+  for item in files_sdk.folder.list_for("remote/path/to/folder").auto_paging_iter():
+    print(item.type, item.path)
+except files_sdk.error.NotAuthenticatedError as err:
+  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
+except files_sdk.error.Error as err:
+  print(f"Unknown Error Occurred ({type(err).__name__}):", err)
+```
+
+### Manual Pagination
+
+The `load_next_page/has_next_page` methods allow for manual pagination and loading of each page into memory.
+
+```python title="Example Request"
+import files_sdk
+
+try:
+  list_obj = files_sdk.folder.list_for("remote/path/to/folder")
+
+  while True:
+    for item in list_obj:
+      print(item.type, item.path)
+    if not list_obj.has_next_page:
+      break
+    list_obj.load_next_page()
+except files_sdk.error.NotAuthenticatedError as err:
+  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
+except files_sdk.error.Error as err:
+  print(f"Unknown Error Occurred ({type(err).__name__}):", err)
+```
+
 ## Case Sensitivity
 
 The Files.com API compares files and paths in a case-insensitive manner.

{Files.com-1.4.210 → Files.com-1.4.212}/files_sdk/__init__.py

@@ -208,7 +208,7 @@ session_id = None
 source_ip = None
 base_url = "https://app.files.com"
 base_path = "api/rest/v1"
-version = "1.4.210"
+version = "1.4.212"
 
 __version__ = version
 

{Files.com-1.4.210 → Files.com-1.4.212}/files_sdk/models/automation.py

@@ -32,8 +32,8 @@ class Automation:
         "path": None,  # 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": None,  # string - Timezone to use when rendering timestamps in paths.
         "recurring_day": None,  # 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": None,  # int64 - If the Automation fails, retry at this interval (in minutes).
-        "retry_on_failure_number_of_attempts": None,  # int64 - If the Automation fails, retry at most this many times.
+        "retry_on_failure_interval_in_minutes": None,  # 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": None,  # int64 - If the Automation fails, retry at most this many times.  Maximum allowed value: 10.  Set to null to disable.
         "schedule": None,  # object - If trigger is `custom_schedule`, Custom schedule description for when the automation should be run in json format.
         "human_readable_schedule": None,  # string - If trigger is `custom_schedule`, Human readable Custom schedule description for when the automation should be run.
         "schedule_days_of_week": None,  # 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.
@@ -112,8 +112,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.
@@ -378,8 +378,8 @@ def get(id, params=None, options=None):
 #   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.
@@ -543,8 +543,8 @@ def manual_run(id, params=None, options=None):
 #   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.