Files.com 1.4.143__tar.gz → 1.4.145__tar.gz

{Files.com-1.4.143 → Files.com-1.4.145}/Files.com.egg-info/PKG-INFO

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

{Files.com-1.4.143 → Files.com-1.4.145}/PKG-INFO

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

{Files.com-1.4.143 → Files.com-1.4.145}/README.md

@@ -195,45 +195,18 @@ files_sdk.source_ip = '10.1.2.3'
 
 ## Sort and Filter
 
-Several of the Files.com API resources have list operations that return multiple instances of the resource.  The List operations
-can be sorted and filtered.
+Several of the Files.com API resources have list operations that return multiple instances of the
+resource. The List operations can be sorted and filtered.
 
 ### Sorting
 
-The returned data can be sorted by passing in the ```sort_by``` method argument.
+To sort the returned data, pass in the ```sort_by``` method argument.
 
-Each resource has a set of valid fields for sorting and can be sorted by one field at a time.
+Each resource supports a unique set of valid sort fields and can only be sorted by one field at a
+time.
 
-The argument value is a Python dictionary that has a key of the resource field name sort on and a value of either ```"asc"``` or ```"desc"``` to specify the sort order.
-
-### Filters
-
-Filters apply selection criteria to the underlying query that returns the results. Filters can be applied individually to select resource fields
-and/or in a combination with each other.  The results of applying filters and filter combinations can be sorted by a single field.
-
-The passed in argument value is a Python dictionary that has a key of the resource field name to filter on and a passed in value to use in the filter comparison.
-
-Each resource has their own set of valid filters and fields, valid combinations of filters, and sortable fields.
-
-#### Types of Filters
-
-##### Exact Filter
-
-`filter` - find resources that have an exact field value match to a passed in value. (i.e., FIELD_VALUE = PASS_IN_VALUE).
-
-#### Range Filters
-
-`filter_gt` - find resources that have a field value that is greater than the passed in value.  (i.e., FIELD_VALUE > PASS_IN_VALUE).
-
-`filter_gte` - find resources that have a field value that is greater than or equal to the passed in value.  (i.e., FIELD_VALUE >=  PASS_IN_VALUE).
-
-`filter_lt` - find resources that have a field value that is less than the passed in value.  (i.e., FIELD_VALUE < PASS_IN_VALUE).
-
-`filter_lte` - find resources that have a field value that is less than or equal to the passed in value.  (i.e., FIELD_VALUE \<= PASS_IN_VALUE).
-
-##### Pattern Filter
-
-`filter_prefix` - find resources where the specified field is prefixed by the supplied value. This is applicable to values that are strings.
+The argument value is a Python dictionary that has a key of the resource field name sort on and a
+value of either ```"asc"``` or ```"desc"``` to specify the sort order.
 
 ```python title="Sort Example"
 ## users sorted by username
@@ -243,46 +216,63 @@ users = files_sdk.user.list({
 })
 for user in users.auto_paging_iter():
   # Operate on user
-
 ````
 
+### Filtering
+
+Filters apply selection criteria to the underlying query that returns the results. They can be
+applied individually or combined with other filters, and the resulting data can be sorted by a
+single field.
+
+Each resource supports a unique set of valid filter fields, filter combinations, and combinations of
+filters and sort fields.
+
+The passed in argument value is a Python dictionary that has a key of the resource field name to
+filter on and a passed in value to use in the filter comparison.
+
+#### Filter Types
+
+| Filter | Type | Description |
+| --------- | --------- | --------- |
+| `filter` | Exact | Find resources that have an exact field value match to a passed in value. (i.e., FIELD_VALUE = PASS_IN_VALUE). |
+| `filter_prefix` | Pattern | Find resources where the specified field is prefixed by the supplied value. This is applicable to values that are strings. |
+| `filter_gt` | Range | Find resources that have a field value that is greater than the passed in value.  (i.e., FIELD_VALUE > PASS_IN_VALUE). |
+| `filter_gteq` | Range | Find resources that have a field value that is greater than or equal to the passed in value.  (i.e., FIELD_VALUE >=  PASS_IN_VALUE). |
+| `filter_lt` | Range | Find resources that have a field value that is less than the passed in value.  (i.e., FIELD_VALUE < PASS_IN_VALUE). |
+| `filter_lteq` | Range | Find resources that have a field value that is less than or equal to the passed in value.  (i.e., FIELD_VALUE \<= PASS_IN_VALUE). |
+
 ```python title="Exact Filter Example"
 ## non admin users
 files_sdk.set_api_key("my-key")
 users = files_sdk.user.list({
-  "filter": { "not_site_admin": true},
-  "sort_by": { "username": "asc"}
+  "filter": { "not_site_admin": true}
 })
 for user in users.auto_paging_iter():
   # Operate on user
-
 ````
 
 ```python title="Range Filter Example"
 ## users who haven't logged in since 2024-01-01
 files_sdk.set_api_key("my-key")
 users = files_sdk.user.list({
-  "filter_gte": { "last_login_at": "2024-01-01" },
-  "sort_by": { "last_login_at": "asc" }
+  "filter_gteq": { "last_login_at": "2024-01-01" }
 })
 for user in users.auto_paging_iter():
   # Operate on user
 ```
 
 ```python title="Pattern Filter Example"
-## users who usernames start with 'test'
+## users whose usernames start with 'test'
 files_sdk.set_api_key("my-key")
 users = files_sdk.user.list({
-  "filter_prefix": { "username": "test" },
-  "sort_by": { "username": "asc"}
+  "filter_prefix": { "username": "test" }
 })
 for user in users.auto_paging_iter():
   # Operate on user
-
 ```
 
-```python title="Combined Filter Example"
-## users who usernames start with 'test' and are not admins
+```python title="Combination Filter with Sort Example"
+## users whose usernames start with 'test' and are not admins
 files_sdk.set_api_key("my-key")
 users = files_sdk.user.list({
   "filter_prefix": { "username": "test" },
@@ -291,7 +281,6 @@ users = files_sdk.user.list({
 })
 for user in users.auto_paging_iter():
   # Operate on user
-
 ```
 
 ## Errors

{Files.com-1.4.143 → Files.com-1.4.145}/files_sdk/__init__.py

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

{Files.com-1.4.143 → Files.com-1.4.145}/files_sdk/models/automation.py

@@ -273,7 +273,6 @@ class Automation:
 #   filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `last_modified_at`.
 #   filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `last_modified_at`.
 #   filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `last_modified_at`.
-#   with_deleted - boolean - Set to true to include deleted automations in the results.
 def list(params=None, options=None):
     if not isinstance(params, dict):
         params = {}

{Files.com-1.4.143 → Files.com-1.4.145}/files_sdk/models/site.py

@@ -53,6 +53,7 @@ class Site:
         "dav_enabled": None,  # boolean - Is WebDAV enabled?
         "dav_user_root_enabled": None,  # boolean - Use user FTP roots also for WebDAV?
         "days_to_retain_backups": None,  # int64 - Number of days to keep deleted files
+        "document_edits_in_bundle_allowed": None,  # string - If true, allow public viewers of Bundles with full permissions to use document editing integrations.
         "default_time_zone": None,  # string - Site default time zone
         "desktop_app": None,  # boolean - Is the desktop app enabled?
         "desktop_app_session_ip_pinning": None,  # boolean - Is desktop app session IP pinning enabled?
@@ -106,8 +107,8 @@ class Site:
         "motd_use_for_sftp": None,  # boolean - Show message to users connecting via SFTP
         "next_billing_amount": None,  # double - Next billing amount
         "next_billing_date": None,  # string - Next billing date
-        "office_integration_available": None,  # boolean - Allow users to use Office for the web?
-        "office_integration_type": None,  # string - Office integration application used to edit and view the MS Office documents
+        "office_integration_available": None,  # boolean - If true, allows users to use a document editing integration.
+        "office_integration_type": None,  # string - Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
         "oncehub_link": None,  # string - Link to scheduling a meeting with our Sales team
         "opt_out_global": None,  # boolean - Use servers in the USA only?
         "overdue": None,  # boolean - Is this site's billing overdue?
@@ -239,8 +240,8 @@ def get_usage(params=None, options=None):
 #   mobile_app_session_lifetime - int64 - Mobile app session lifetime (in hours)
 #   folder_permissions_groups_only - boolean - If true, permissions for this site must be bound to a group (not a user). Otherwise, permissions must be bound to a user.
 #   welcome_screen - string - Does the welcome screen appear?
-#   office_integration_available - boolean - Allow users to use Office for the web?
-#   office_integration_type - string - Office integration application used to edit and view the MS Office documents
+#   office_integration_available - boolean - If true, allows users to use a document editing integration.
+#   office_integration_type - string - Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
 #   pin_all_remote_servers_to_site_region - boolean - If true, we will ensure that all internal communications with any remote server are made through the primary region of the site. This setting overrides individual remote server settings.
 #   motd_text - string - A message to show users when they connect via FTP or SFTP.
 #   motd_use_for_ftp - boolean - Show message to users connecting via FTP
@@ -284,6 +285,7 @@ def get_usage(params=None, options=None):
 #   bundle_registration_notifications - string - Do Bundle owners receive registration notification?
 #   bundle_activity_notifications - string - Do Bundle owners receive activity notifications?
 #   bundle_upload_receipt_notifications - string - Do Bundle uploaders receive upload confirmation notifications?
+#   document_edits_in_bundle_allowed - string - If true, allow public viewers of Bundles with full permissions to use document editing integrations.
 #   password_requirements_apply_to_bundles - boolean - Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
 #   prevent_root_permissions_for_non_site_admins - boolean - If true, we will prevent non-administrators from receiving any permissions directly on the root folder.  This is commonly used to prevent the accidental application of permissions.
 #   opt_out_global - boolean - Use servers in the USA only?
@@ -550,6 +552,12 @@ def update(params=None, options=None):
         raise InvalidParameterError(
             "Bad parameter: bundle_upload_receipt_notifications must be an str"
         )
+    if "document_edits_in_bundle_allowed" in params and not isinstance(
+        params["document_edits_in_bundle_allowed"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: document_edits_in_bundle_allowed must be an str"
+        )
     if (
         "disable_users_from_inactivity_period_days" in params
         and not isinstance(