files.com 1.1.112 → 1.1.114

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18fa64da839810ed00562ec71c7c1a27eb4ffad729020b79fe33a7eec54f701d
-  data.tar.gz: 57e6b2336a33a39806e80bf1da896dac16c7951825233eafe90bb033ad9fec93
+  metadata.gz: 578b92a8aeefb7ed5116b22ecd06c0b2248f37919f6ab13f64afcd495f098cd3
+  data.tar.gz: c157f057f96ca7af7543f302e0884c9624908555966d5b86523f2e846972bb47
 SHA512:
-  metadata.gz: 672a3b4894c4f3fc3d80eb2ab6471ac8e0ef9b7e2339762cfe7e58e8b369c078d4aa052a813700fbd649ddc7bc214126218aa946a5221a1e68af2718e0d9a3e8
-  data.tar.gz: 62d5ac9edea75c1bbfed744271014df953234190f73e621d4ea059a7381be34a52b0f608c3cdb86d52d73b1dc9b81f3d5d398ea6e1ec71d1fc22ce5036dafe47
+  metadata.gz: 111c1245c11016fce37a630340e61ebc4ec768a4cb9a7d820cbf77c2a556647927c37c874f91b6bfd7ba480b9d12e3ddddc66fa35a09f8bee4fcceb861fc9187
+  data.tar.gz: af683024ddafd3234f97bdf067845f26e4dd4839310db4a541c6c374d85b5696adf8e6864b5bbd7fc06c8e879ef1e72673cc686832aa0615b3b9f96bcb915bb1

data/README.md

@@ -339,6 +339,7 @@ Files::FolderAdminPermissionRequiredError -> Files::NotAuthorizedError -> Files:
 |`ApiKeyOnlyForDesktopAppError`|  `NotAuthorizedError` |
 |`ApiKeyOnlyForMobileAppError`|  `NotAuthorizedError` |
 |`ApiKeyOnlyForOfficeIntegrationError`|  `NotAuthorizedError` |
+|`BillingOrSiteAdminPermissionRequiredError`|  `NotAuthorizedError` |
 |`BillingPermissionRequiredError`|  `NotAuthorizedError` |
 |`BundleMaximumUsesReachedError`|  `NotAuthorizedError` |
 |`CannotLoginWhileUsingKeyError`|  `NotAuthorizedError` |

data/_VERSION

@@ -1 +1 @@
-1.1.112
+1.1.114

data/docs/api_key.md

@@ -27,7 +27,7 @@
 * `key` (string): API Key actual key string
 * `last_use_at` (date-time): API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
 * `name` (string): Internal name for the API Key.  For your use.
-* `permission_set` (string): Permissions for this API Key. It must be full for site-wide API Keys.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
+* `permission_set` (string): Permissions for this API Key. It must be full for site-wide API Keys.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
 * `platform` (string): If this API key represents a Desktop app, what platform was it created on?
 * `url` (string): URL for API host.
 * `user_id` (int64): User ID for the owner of this API Key.  May be blank for Site-wide API Keys.
@@ -99,7 +99,7 @@ Files::ApiKey.create(
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 * `description` (string): User-supplied description of API key.
 * `expires_at` (string): API Key expiration date
-* `permission_set` (string): Permissions for this API Key. It must be full for site-wide API Keys.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
+* `permission_set` (string): Permissions for this API Key. It must be full for site-wide API Keys.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
 * `name` (string): Required - Internal name for the API Key.  For your use.
 * `path` (string): Folder path restriction for this API key.
 
@@ -120,7 +120,7 @@ Files::ApiKey.update_current(
 
 * `expires_at` (string): API Key expiration date
 * `name` (string): Internal name for the API Key.  For your use.
-* `permission_set` (string): Permissions for this API Key. It must be full for site-wide API Keys.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
+* `permission_set` (string): Permissions for this API Key. It must be full for site-wide API Keys.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
 
 
 ---
@@ -141,7 +141,7 @@ Files::ApiKey.update(id,
 * `id` (int64): Required - Api Key ID.
 * `description` (string): User-supplied description of API key.
 * `expires_at` (string): API Key expiration date
-* `permission_set` (string): Permissions for this API Key. It must be full for site-wide API Keys.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
+* `permission_set` (string): Permissions for this API Key. It must be full for site-wide API Keys.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
 * `name` (string): Internal name for the API Key.  For your use.
 
 
@@ -187,7 +187,7 @@ api_key.update(
 * `id` (int64): Required - Api Key ID.
 * `description` (string): User-supplied description of API key.
 * `expires_at` (string): API Key expiration date
-* `permission_set` (string): Permissions for this API Key. It must be full for site-wide API Keys.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
+* `permission_set` (string): Permissions for this API Key. It must be full for site-wide API Keys.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
 * `name` (string): Internal name for the API Key.  For your use.
 
 

data/docs/site.md

@@ -248,6 +248,7 @@
     "active_2fa": true,
     "require_password_change": true,
     "password_expired": true,
+    "readonly_site_admin": true,
     "restapi_permission": true,
     "self_managed": true,
     "sftp_permission": true,

data/docs/user.md

@@ -53,6 +53,7 @@
   "active_2fa": true,
   "require_password_change": true,
   "password_expired": true,
+  "readonly_site_admin": true,
   "restapi_permission": true,
   "self_managed": true,
   "sftp_permission": true,
@@ -118,6 +119,7 @@
 * `active_2fa` (boolean): Is 2fa active for the user?
 * `require_password_change` (boolean): Is a password change required upon next user login?
 * `password_expired` (boolean): Is user's password expired?
+* `readonly_site_admin` (boolean): Is the user an allowed to view all (non-billing) site configuration for this site?
 * `restapi_permission` (boolean): Can this user access the Web app, Desktop app, SDKs, or REST API?  (All of these tools use the API internally, so this is one unified permission set.)
 * `self_managed` (boolean): Does this user manage it's own credentials or is it a shared/bot user?
 * `sftp_permission` (boolean): Can the user access with SFTP?
@@ -210,6 +212,7 @@ Files::User.create(
   notes: "Internal notes on this user.", 
   office_integration_enabled: true, 
   password_validity_days: 1, 
+  readonly_site_admin: true, 
   receive_admin_alerts: true, 
   require_login_by: "2000-01-01T01:00:00Z", 
   require_password_change: true, 
@@ -260,6 +263,7 @@ Files::User.create(
 * `notes` (string): Any internal notes on the user
 * `office_integration_enabled` (boolean): Enable integration with Office for the web?
 * `password_validity_days` (int64): Number of days to allow user to use the same password
+* `readonly_site_admin` (boolean): Is the user an allowed to view all (non-billing) site configuration for this site?
 * `receive_admin_alerts` (boolean): Should the user receive admin alerts such a certificate expiration notifications and overages?
 * `require_login_by` (string): Require user to login by specified date otherwise it will be disabled.
 * `require_password_change` (boolean): Is a password change required upon next user login?
@@ -345,6 +349,7 @@ Files::User.update(id,
   notes: "Internal notes on this user.", 
   office_integration_enabled: true, 
   password_validity_days: 1, 
+  readonly_site_admin: true, 
   receive_admin_alerts: true, 
   require_login_by: "2000-01-01T01:00:00Z", 
   require_password_change: true, 
@@ -396,6 +401,7 @@ Files::User.update(id,
 * `notes` (string): Any internal notes on the user
 * `office_integration_enabled` (boolean): Enable integration with Office for the web?
 * `password_validity_days` (int64): Number of days to allow user to use the same password
+* `readonly_site_admin` (boolean): Is the user an allowed to view all (non-billing) site configuration for this site?
 * `receive_admin_alerts` (boolean): Should the user receive admin alerts such a certificate expiration notifications and overages?
 * `require_login_by` (string): Require user to login by specified date otherwise it will be disabled.
 * `require_password_change` (boolean): Is a password change required upon next user login?
@@ -502,6 +508,7 @@ user.update(
   notes: "Internal notes on this user.",
   office_integration_enabled: true,
   password_validity_days: 1,
+  readonly_site_admin: true,
   receive_admin_alerts: true,
   require_login_by: "2000-01-01T01:00:00Z",
   require_password_change: true,
@@ -553,6 +560,7 @@ user.update(
 * `notes` (string): Any internal notes on the user
 * `office_integration_enabled` (boolean): Enable integration with Office for the web?
 * `password_validity_days` (int64): Number of days to allow user to use the same password
+* `readonly_site_admin` (boolean): Is the user an allowed to view all (non-billing) site configuration for this site?
 * `receive_admin_alerts` (boolean): Should the user receive admin alerts such a certificate expiration notifications and overages?
 * `require_login_by` (string): Require user to login by specified date otherwise it will be disabled.
 * `require_password_change` (boolean): Is a password change required upon next user login?

data/lib/files.com/errors.rb

@@ -109,6 +109,7 @@ module Files
   class ApiKeyOnlyForDesktopAppError < NotAuthorizedError; end
   class ApiKeyOnlyForMobileAppError < NotAuthorizedError; end
   class ApiKeyOnlyForOfficeIntegrationError < NotAuthorizedError; end
+  class BillingOrSiteAdminPermissionRequiredError < NotAuthorizedError; end
   class BillingPermissionRequiredError < NotAuthorizedError; end
   class BundleMaximumUsesReachedError < NotAuthorizedError; end
   class CannotLoginWhileUsingKeyError < NotAuthorizedError; end

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

@@ -77,7 +77,7 @@ module Files
       @attributes[:name] = value
     end
 
-    # string - Permissions for this API Key. It must be full for site-wide API Keys.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
+    # string - Permissions for this API Key. It must be full for site-wide API Keys.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
     def permission_set
       @attributes[:permission_set]
     end
@@ -125,7 +125,7 @@ module Files
     # Parameters:
     #   description - string - User-supplied description of API key.
     #   expires_at - string - API Key expiration date
-    #   permission_set - string - Permissions for this API Key. It must be full for site-wide API Keys.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
+    #   permission_set - string - Permissions for this API Key. It must be full for site-wide API Keys.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
     #   name - string - Internal name for the API Key.  For your use.
     def update(params = {})
       params ||= {}
@@ -222,7 +222,7 @@ module Files
     #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
     #   description - string - User-supplied description of API key.
     #   expires_at - string - API Key expiration date
-    #   permission_set - string - Permissions for this API Key. It must be full for site-wide API Keys.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
+    #   permission_set - string - Permissions for this API Key. It must be full for site-wide API Keys.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
     #   name (required) - string - Internal name for the API Key.  For your use.
     #   path - string - Folder path restriction for this API key.
     def self.create(params = {}, options = {})
@@ -241,7 +241,7 @@ module Files
     # Parameters:
     #   expires_at - string - API Key expiration date
     #   name - string - Internal name for the API Key.  For your use.
-    #   permission_set - string - Permissions for this API Key. It must be full for site-wide API Keys.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
+    #   permission_set - string - Permissions for this API Key. It must be full for site-wide API Keys.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
     def self.update_current(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params[:expires_at] and !params[:expires_at].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
@@ -254,7 +254,7 @@ module Files
     # Parameters:
     #   description - string - User-supplied description of API key.
     #   expires_at - string - API Key expiration date
-    #   permission_set - string - Permissions for this API Key. It must be full for site-wide API Keys.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
+    #   permission_set - string - Permissions for this API Key. It must be full for site-wide API Keys.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
     #   name - string - Internal name for the API Key.  For your use.
     def self.update(id, params = {}, options = {})
       params ||= {}

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

@@ -428,6 +428,15 @@ module Files
       @attributes[:password_expired] = value
     end
 
+    # boolean - Is the user an allowed to view all (non-billing) site configuration for this site?
+    def readonly_site_admin
+      @attributes[:readonly_site_admin]
+    end
+
+    def readonly_site_admin=(value)
+      @attributes[:readonly_site_admin] = value
+    end
+
     # boolean - Can this user access the Web app, Desktop app, SDKs, or REST API?  (All of these tools use the API internally, so this is one unified permission set.)
     def restapi_permission
       @attributes[:restapi_permission]
@@ -717,6 +726,7 @@ module Files
     #   notes - string - Any internal notes on the user
     #   office_integration_enabled - boolean - Enable integration with Office for the web?
     #   password_validity_days - int64 - Number of days to allow user to use the same password
+    #   readonly_site_admin - boolean - Is the user an allowed to view all (non-billing) site configuration for this site?
     #   receive_admin_alerts - boolean - Should the user receive admin alerts such a certificate expiration notifications and overages?
     #   require_login_by - string - Require user to login by specified date otherwise it will be disabled.
     #   require_password_change - boolean - Is a password change required upon next user login?
@@ -875,6 +885,7 @@ module Files
     #   notes - string - Any internal notes on the user
     #   office_integration_enabled - boolean - Enable integration with Office for the web?
     #   password_validity_days - int64 - Number of days to allow user to use the same password
+    #   readonly_site_admin - boolean - Is the user an allowed to view all (non-billing) site configuration for this site?
     #   receive_admin_alerts - boolean - Should the user receive admin alerts such a certificate expiration notifications and overages?
     #   require_login_by - string - Require user to login by specified date otherwise it will be disabled.
     #   require_password_change - boolean - Is a password change required upon next user login?
@@ -987,6 +998,7 @@ module Files
     #   notes - string - Any internal notes on the user
     #   office_integration_enabled - boolean - Enable integration with Office for the web?
     #   password_validity_days - int64 - Number of days to allow user to use the same password
+    #   readonly_site_admin - boolean - Is the user an allowed to view all (non-billing) site configuration for this site?
     #   receive_admin_alerts - boolean - Should the user receive admin alerts such a certificate expiration notifications and overages?
     #   require_login_by - string - Require user to login by specified date otherwise it will be disabled.
     #   require_password_change - boolean - Is a password change required upon next user login?

data/lib/files.com/version.rb

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

metadata

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