files.com 1.2.105 → 1.2.107

Sign up to get free protection for your applications and to get access to all the features.
package/README.md CHANGED
@@ -366,6 +366,7 @@ Error
366
366
  | `NotAuthorized_ApiKeyOnlyForDesktopAppError`| `NotAuthorizedError` |
367
367
  | `NotAuthorized_ApiKeyOnlyForMobileAppError`| `NotAuthorizedError` |
368
368
  | `NotAuthorized_ApiKeyOnlyForOfficeIntegrationError`| `NotAuthorizedError` |
369
+ | `NotAuthorized_BillingOrSiteAdminPermissionRequiredError`| `NotAuthorizedError` |
369
370
  | `NotAuthorized_BillingPermissionRequiredError`| `NotAuthorizedError` |
370
371
  | `NotAuthorized_BundleMaximumUsesReachedError`| `NotAuthorizedError` |
371
372
  | `NotAuthorized_CannotLoginWhileUsingKeyError`| `NotAuthorizedError` |
package/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.2.105
1
+ 1.2.107
package/docs/Errors.md CHANGED
@@ -106,6 +106,7 @@ These errors are derived from the error groups listed above.
106
106
  ### NotAuthorized_ApiKeyOnlyForDesktopAppError
107
107
  ### NotAuthorized_ApiKeyOnlyForMobileAppError
108
108
  ### NotAuthorized_ApiKeyOnlyForOfficeIntegrationError
109
+ ### NotAuthorized_BillingOrSiteAdminPermissionRequiredError
109
110
  ### NotAuthorized_BillingPermissionRequiredError
110
111
  ### NotAuthorized_BundleMaximumUsesReachedError
111
112
  ### NotAuthorized_CannotLoginWhileUsingKeyError
@@ -27,7 +27,7 @@
27
27
  * `key` (string): API Key actual key string
28
28
  * `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.
29
29
  * `name` (string): Internal name for the API Key. For your use.
30
- * `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.
30
+ * `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.
31
31
  * `platform` (string): If this API key represents a Desktop app, what platform was it created on?
32
32
  * `url` (string): URL for API host.
33
33
  * `user_id` (int64): User ID for the owner of this API Key. May be blank for Site-wide API Keys.
@@ -99,7 +99,7 @@ await ApiKey.create({
99
99
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
100
100
  * `description` (string): User-supplied description of API key.
101
101
  * `expires_at` (string): API Key expiration date
102
- * `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.
102
+ * `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.
103
103
  * `name` (string): Required - Internal name for the API Key. For your use.
104
104
  * `path` (string): Folder path restriction for this API key.
105
105
 
@@ -120,7 +120,7 @@ await ApiKey.updateCurrent({
120
120
 
121
121
  * `expires_at` (string): API Key expiration date
122
122
  * `name` (string): Internal name for the API Key. For your use.
123
- * `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.
123
+ * `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.
124
124
 
125
125
  ---
126
126
 
@@ -151,7 +151,7 @@ await api_key.update({
151
151
  * `id` (int64): Required - Api Key ID.
152
152
  * `description` (string): User-supplied description of API key.
153
153
  * `expires_at` (string): API Key expiration date
154
- * `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.
154
+ * `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.
155
155
  * `name` (string): Internal name for the API Key. For your use.
156
156
 
157
157
  ### Example Response
@@ -248,6 +248,7 @@
248
248
  "active_2fa": true,
249
249
  "require_password_change": true,
250
250
  "password_expired": true,
251
+ "readonly_site_admin": true,
251
252
  "restapi_permission": true,
252
253
  "self_managed": true,
253
254
  "sftp_permission": true,
@@ -53,6 +53,7 @@
53
53
  "active_2fa": true,
54
54
  "require_password_change": true,
55
55
  "password_expired": true,
56
+ "readonly_site_admin": true,
56
57
  "restapi_permission": true,
57
58
  "self_managed": true,
58
59
  "sftp_permission": true,
@@ -118,6 +119,7 @@
118
119
  * `active_2fa` (boolean): Is 2fa active for the user?
119
120
  * `require_password_change` (boolean): Is a password change required upon next user login?
120
121
  * `password_expired` (boolean): Is user's password expired?
122
+ * `readonly_site_admin` (boolean): Is the user an allowed to view all (non-billing) site configuration for this site?
121
123
  * `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.)
122
124
  * `self_managed` (boolean): Does this user manage it's own credentials or is it a shared/bot user?
123
125
  * `sftp_permission` (boolean): Can the user access with SFTP?
@@ -209,6 +211,7 @@ await User.create({
209
211
  'notes': "Internal notes on this user.",
210
212
  'office_integration_enabled': true,
211
213
  'password_validity_days': 1,
214
+ 'readonly_site_admin': true,
212
215
  'receive_admin_alerts': true,
213
216
  'require_login_by': "2000-01-01T01:00:00Z",
214
217
  'require_password_change': true,
@@ -260,6 +263,7 @@ await User.create({
260
263
  * `notes` (string): Any internal notes on the user
261
264
  * `office_integration_enabled` (boolean): Enable integration with Office for the web?
262
265
  * `password_validity_days` (int64): Number of days to allow user to use the same password
266
+ * `readonly_site_admin` (boolean): Is the user an allowed to view all (non-billing) site configuration for this site?
263
267
  * `receive_admin_alerts` (boolean): Should the user receive admin alerts such a certificate expiration notifications and overages?
264
268
  * `require_login_by` (string): Require user to login by specified date otherwise it will be disabled.
265
269
  * `require_password_change` (boolean): Is a password change required upon next user login?
@@ -352,6 +356,7 @@ await user.update({
352
356
  'notes': "Internal notes on this user.",
353
357
  'office_integration_enabled': true,
354
358
  'password_validity_days': 1,
359
+ 'readonly_site_admin': true,
355
360
  'receive_admin_alerts': true,
356
361
  'require_login_by': "2000-01-01T01:00:00Z",
357
362
  'require_password_change': true,
@@ -403,6 +408,7 @@ await user.update({
403
408
  * `notes` (string): Any internal notes on the user
404
409
  * `office_integration_enabled` (boolean): Enable integration with Office for the web?
405
410
  * `password_validity_days` (int64): Number of days to allow user to use the same password
411
+ * `readonly_site_admin` (boolean): Is the user an allowed to view all (non-billing) site configuration for this site?
406
412
  * `receive_admin_alerts` (boolean): Should the user receive admin alerts such a certificate expiration notifications and overages?
407
413
  * `require_login_by` (string): Require user to login by specified date otherwise it will be disabled.
408
414
  * `require_password_change` (boolean): Is a password change required upon next user login?
@@ -472,6 +478,7 @@ await user.update({
472
478
  "active_2fa": true,
473
479
  "require_password_change": true,
474
480
  "password_expired": true,
481
+ "readonly_site_admin": true,
475
482
  "restapi_permission": true,
476
483
  "self_managed": true,
477
484
  "sftp_permission": true,