Files.com 1.4.129__tar.gz → 1.4.130__tar.gz

{Files.com-1.4.129 → Files.com-1.4.130}/Files.com.egg-info/PKG-INFO

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

{Files.com-1.4.129 → Files.com-1.4.130}/PKG-INFO

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

{Files.com-1.4.129 → Files.com-1.4.130}/README.md

@@ -193,6 +193,107 @@ Configure the local IP address from which to send requests.
 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.
+
+### Sorting
+
+The returned data can be sorted by passing 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.
+
+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.
+
+```python title="Sort Example"
+## users sorted by username
+files_sdk.set_api_key("my-key")
+users = files_sdk.user.list({
+  "sort_by": { "username": "asc"}
+})
+for user in users.auto_paging_iter():
+  # Operate on user
+
+````
+
+```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"}
+})
+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" }
+})
+for user in users.auto_paging_iter():
+  # Operate on user
+```
+
+```python title="Pattern Filter Example"
+## users who usernames start with 'test'
+files_sdk.set_api_key("my-key")
+users = files_sdk.user.list({
+  "filter_prefix": { "username": "test" },
+  "sort_by": { "username": "asc"}
+})
+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
+files_sdk.set_api_key("my-key")
+users = files_sdk.user.list({
+  "filter_prefix": { "username": "test" },
+  "filter": { "not_site_admin": "true" },
+  "sort_by": { "username": "asc"}
+})
+for user in users.auto_paging_iter():
+  # Operate on user
+
+```
+
 ## Errors
 
 The Files.com Python SDK will return errors by raising exceptions. There are many exception classes defined in the Files SDK that correspond

{Files.com-1.4.129 → Files.com-1.4.130}/files_sdk/__init__.py

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