files.com 1.1.146 → 1.1.147

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9962a456febacc4404f95b369aee63c7a4dee7a2f832b092413b99665dc7428
-  data.tar.gz: f49b782f9f1c1448a2749514d77960d5d78064f7ada3bb75268b3553fdc4ad7b
+  metadata.gz: bb798851ff19d0a3d0d0edca0d08bc4a8c4e110df74f55cb99a7000195abafc7
+  data.tar.gz: ef479ae58069b1edc3d6013e54051e4c7355ed9fb83a7b69dbda25057a621e07
 SHA512:
-  metadata.gz: 13d6fd66729774563e14559167c24e3250cdc86bb5e7d8742c6d1f8d3385790e4695acd587db035e4c2fb8bb6b0ad8a77ed0d1b9650baa5376d9df81aa6ef321
-  data.tar.gz: 878ffd35cd027836d9de453e684d9dbb1ee494e53aa06d5357d686ccf1e1864e0cdce320dc205118029af52ece1e05cab09eb27e3c5785a250e127766b4a5649
+  metadata.gz: 5b3d99aad929ef1185dc3461c5394a1af82a8c12ff29df98ad964a8902e98df6b590a8b9ea5a6d25427f451cb2020b8d6e64b7234a91ed8e49567b0cd3e5d4f2
+  data.tar.gz: f49779d948ad5ae25f774ec4d24ae6f37b96b415fefc0dc178cb2e49f0869d2476b8c0bf81193a82e0640685d19b8ef389a86d76ff6cb07cb6bde7a74d2baff1

data/README.md

@@ -194,45 +194,18 @@ Files.max_network_retries = 5
 
 ## 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.
 
-The argument value is a Ruby hash that has a key of the resource field name to sort on and a value of either ```"asc"``` or ```"desc"``` to specify the sort order.
+Each resource supports a unique set of valid sort fields and can only be sorted by one field at a
+time.
 
-Each resource has a set of valid fields for sorting and can be sorted by one field at a time.
-
-### 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 Ruby hash 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 Ruby hash that has a key of the resource field name to sort on and a value
+of either ```"asc"``` or ```"desc"``` to specify the sort order.
 
 ```ruby title="Sort Example"
 ## users sorted by username
@@ -242,35 +215,55 @@ Files::User.list(
 )
 ```
 
+### 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 Ruby hash 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). |
+
 ```ruby title="Exact Filter Example"
 ## non admin users
 Files.api_key = 'YOUR_API_KEY'
 Files::User.list(
-  filter: { not_site_admin: true },
-  sort_by: { "username": "asc"}
+  filter: { not_site_admin: true }
 )
 ```
 
 ```ruby title="Range Filter Example"
-#users who haven't logged in since 2024-01-01
+## users who haven't logged in since 2024-01-01
 Files.api_key = 'YOUR_API_KEY'
 Files::User.list(
-filter_gte: { "last_login_at": "2024-01-01" },
-  sort_by: { "last_login_at": "asc"}
+  filter_gteq: { "last_login_at": "2024-01-01" }
 )
 ```
 
 ```ruby title="Pattern Filter Example"
-## users who usernames start with 'test'
+## users whose usernames start with 'test'
 Files.api_key = 'YOUR_API_KEY'
 Files::User.list(
-  filter_pre: { username: "test" },
-  sort_by: { "username": "asc"}
+  filter_pre: { username: "test" }
 )
 ```
 
-```ruby title="Combined Filter Example"
-## users who usernames start with 'test' and are not admins
+```ruby title="Combination Filter with Sort Example"
+## users whose usernames start with 'test' and are not admins
 Files.api_key = 'YOUR_API_KEY'
 Files::User.list(
   filter_prefix: { username: "test" },

data/_VERSION

@@ -1 +1 @@
-1.1.146
+1.1.147

data/lib/files.com/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.146
+  version: 1.1.147
 platform: ruby
 authors:
 - files.com