files.com 1.1.146 → 1.1.148

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9962a456febacc4404f95b369aee63c7a4dee7a2f832b092413b99665dc7428
-  data.tar.gz: f49b782f9f1c1448a2749514d77960d5d78064f7ada3bb75268b3553fdc4ad7b
+  metadata.gz: 01b556c1e4110c4fe2f19c4eb3cc837666d96b8bf9aa5dfab43134f84a195396
+  data.tar.gz: 39fad710efe27bdce3e25c9912d9555da07169fa183610c23ed50abad7f46733
 SHA512:
-  metadata.gz: 13d6fd66729774563e14559167c24e3250cdc86bb5e7d8742c6d1f8d3385790e4695acd587db035e4c2fb8bb6b0ad8a77ed0d1b9650baa5376d9df81aa6ef321
-  data.tar.gz: 878ffd35cd027836d9de453e684d9dbb1ee494e53aa06d5357d686ccf1e1864e0cdce320dc205118029af52ece1e05cab09eb27e3c5785a250e127766b4a5649
+  metadata.gz: 00047fb734bcfd0311b8e7fb14876490f4535515c0161b600f7702673c72cfd606d1287b274b75a820efb9650605ed456782b3a1222d6add89cdce62e6387f2f
+  data.tar.gz: 50374ba0bb21964bd0507c05a8ef9415864eae085f0c1f976583ef6e641ae6da83532143ff041293c870dc070f4cee48cadfe494bfae79ffa39c18d03efeb06a

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.148

data/docs/automation.md

@@ -104,9 +104,7 @@
 ## List Automations
 
 ```
-Files::Automation.list(
-  with_deleted: true
-)
+Files::Automation.list
 ```
 
 ### Parameters
@@ -119,7 +117,6 @@ Files::Automation.list(
 * `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.
 
 
 ---

data/docs/site.md

@@ -56,6 +56,7 @@
   "dav_enabled": true,
   "dav_user_root_enabled": true,
   "days_to_retain_backups": 30,
+  "document_edits_in_bundle_allowed": "example",
   "default_time_zone": "Pacific Time (US & Canada)",
   "desktop_app": true,
   "desktop_app_session_ip_pinning": true,
@@ -329,6 +330,7 @@
 * `dav_enabled` (boolean): Is WebDAV enabled?
 * `dav_user_root_enabled` (boolean): Use user FTP roots also for WebDAV?
 * `days_to_retain_backups` (int64): Number of days to keep deleted files
+* `document_edits_in_bundle_allowed` (string): If true, allow public viewers of Bundles with full permissions to use document editing integrations.
 * `default_time_zone` (string): Site default time zone
 * `desktop_app` (boolean): Is the desktop app enabled?
 * `desktop_app_session_ip_pinning` (boolean): Is desktop app session IP pinning enabled?
@@ -382,8 +384,8 @@
 * `motd_use_for_sftp` (boolean): Show message to users connecting via SFTP
 * `next_billing_amount` (double): Next billing amount
 * `next_billing_date` (string): Next billing date
-* `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.
 * `oncehub_link` (string): Link to scheduling a meeting with our Sales team
 * `opt_out_global` (boolean): Use servers in the USA only?
 * `overdue` (boolean): Is this site's billing overdue?
@@ -544,6 +546,7 @@ Files::Site.update(
   bundle_registration_notifications: "never", 
   bundle_activity_notifications: "never", 
   bundle_upload_receipt_notifications: "never", 
+  document_edits_in_bundle_allowed: "example", 
   password_requirements_apply_to_bundles: true, 
   prevent_root_permissions_for_non_site_admins: true, 
   opt_out_global: true, 
@@ -649,8 +652,8 @@ Files::Site.update(
 * `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
@@ -694,6 +697,7 @@ Files::Site.update(
 * `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?

data/lib/files.com/models/automation.rb

@@ -419,7 +419,6 @@ module Files
     #   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 self.list(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)

data/lib/files.com/models/site.rb

@@ -224,6 +224,11 @@ module Files
       @attributes[:days_to_retain_backups]
     end
 
+    # string - If true, allow public viewers of Bundles with full permissions to use document editing integrations.
+    def document_edits_in_bundle_allowed
+      @attributes[:document_edits_in_bundle_allowed]
+    end
+
     # string - Site default time zone
     def default_time_zone
       @attributes[:default_time_zone]
@@ -489,12 +494,12 @@ module Files
       @attributes[:next_billing_date]
     end
 
-    # boolean - Allow users to use Office for the web?
+    # boolean - If true, allows users to use a document editing integration.
     def office_integration_available
       @attributes[:office_integration_available]
     end
 
-    # string - Office integration application used to edit and view the MS Office documents
+    # string - Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
     def office_integration_type
       @attributes[:office_integration_type]
     end
@@ -852,8 +857,8 @@ module Files
     #   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
@@ -897,6 +902,7 @@ module Files
     #   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?
@@ -1015,6 +1021,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: bundle_registration_notifications must be an String") if params[:bundle_registration_notifications] and !params[:bundle_registration_notifications].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: bundle_activity_notifications must be an String") if params[:bundle_activity_notifications] and !params[:bundle_activity_notifications].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: bundle_upload_receipt_notifications must be an String") if params[:bundle_upload_receipt_notifications] and !params[:bundle_upload_receipt_notifications].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: document_edits_in_bundle_allowed must be an String") if params[:document_edits_in_bundle_allowed] and !params[:document_edits_in_bundle_allowed].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: disable_users_from_inactivity_period_days must be an Integer") if params[:disable_users_from_inactivity_period_days] and !params[:disable_users_from_inactivity_period_days].is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: sftp_host_key_type must be an String") if params[:sftp_host_key_type] and !params[:sftp_host_key_type].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: active_sftp_host_key_id must be an Integer") if params[:active_sftp_host_key_id] and !params[:active_sftp_host_key_id].is_a?(Integer)

data/lib/files.com/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.146
+  version: 1.1.148
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-07 00:00:00.000000000 Z
+date: 2024-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable