files.com 1.1.762 → 1.1.764

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cf73e3d192ff3f0f0c3080260cf28b789d40b244874762d11c567d7503134a50
4
- data.tar.gz: e190c5b8448ee93c21c4dbe305fe4cacc40acf3fd177e85108e41b6b49ef2072
3
+ metadata.gz: 49dfceda26d15e50434c26fa7e029f98da9110f5f450cdcf670ce1795f23fa48
4
+ data.tar.gz: 3adfc8a8080fabb093a89be14deef3610df554c28f8ed9982929e4d1266205c1
5
5
  SHA512:
6
- metadata.gz: 329c7e14bceb7ad4d0543fe5ef2965b239347f5372fbdff69e0fba921bbfdcd6e6c64b61d349e2d0a9942b06adf9ad6911669a2fc3de9eb240e795f8e9f66c8c
7
- data.tar.gz: 838cae9505b9f6e9e54e90d01dd1729a369b4d8317a9659adeb9e87000b785e898202395f403c2868f33c9c1b6f2c7cc9713bedf7922f4f35ec12c423a939390
6
+ metadata.gz: 2dc7126351c5336b53ec3056b75021635abb2bd8a1dbc1d736f0378e480264550199cc2891afc0be7df35f3532705f34746902b44b06eb5f62317401db9fccc6
7
+ data.tar.gz: 940a14a60dc168554f787c6d3ec085125681c259d73ad25ae8706a2ac40017949c7e7d2e53572af9003c383e6c5a1980d6e488b07a8c7443bac947ecf093f7e3
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.762
1
+ 1.1.764
data/docs/restore.md CHANGED
@@ -39,10 +39,10 @@
39
39
  * `files_restored` (int64): Number of files successfully restored.
40
40
  * `files_errored` (int64): Number of files that were not able to be restored.
41
41
  * `files_total` (int64): Total number of files processed.
42
- * `prefix` (string): Prefix of the files/folders to restore, or a case-insensitive username prefix for a user restore. To restore a folder, add a trailing slash to the folder name. Do not use a leading slash. To restore all deleted items of the selected restoration type, specify an empty string (`''`) in the prefix field or omit the field from the request.
42
+ * `prefix` (string): Prefix of the files/folders to restore, or a case-insensitive username prefix for a user restore. A trailing slash selects that folder and its contents only; without it, the prefix matches any path beginning with that text. Do not use a leading slash. To restore all deleted items of the selected restoration type within the selected site or workspace scope, specify an empty string (`''`) or omit the field.
43
43
  * `restoration_type` (string): Type of restoration to perform. `files` restores deleted filesystem items. `users` restores deleted users and associated access/authentication records removed as part of deleting those users.
44
44
  * `restore_in_place` (boolean): If true, we will restore the files in place (into their original paths). If false, we will create a new restoration folder in the root and restore files there.
45
- * `restore_deleted_permissions` (boolean): If true, restore permissions removed as part of deleting the selected users for a user restore, or permissions matching the selected path prefix and deletion dates for a file restore.
45
+ * `restore_deleted_permissions` (boolean): If true, a user restore restores permissions removed as part of deleting the selected users. An in-place file restore restores user and group permissions on returned folders and their subfolders that were deleted from the time of the folder's deletion through 24 hours afterward, including permissions removed independently within that window. File restores into a new folder do not restore permissions.
46
46
  * `users_restored` (int64): Number of users successfully restored (only present for `restoration_type=users`).
47
47
  * `users_errored` (int64): Number of users that failed to restore (only present for `restoration_type=users`).
48
48
  * `users_total` (int64): Total number of users processed (only present for `restoration_type=users`).
@@ -90,9 +90,9 @@ Files::Restore.create(
90
90
  ### Parameters
91
91
 
92
92
  * `earliest_date` (string): Required - Restore files or users deleted on or after this date/time. Don't set this earlier than you need. Can not be greater than 365 days prior to the restore request.
93
- * `prefix` (string): Prefix of the files/folders to restore, or a case-insensitive username prefix for a user restore. To restore a folder, add a trailing slash to the folder name. Do not use a leading slash. To restore all deleted items of the selected restoration type, specify an empty string (`''`) in the prefix field or omit the field from the request.
93
+ * `prefix` (string): Prefix of the files/folders to restore, or a case-insensitive username prefix for a user restore. A trailing slash selects that folder and its contents only; without it, the prefix matches any path beginning with that text. Do not use a leading slash. To restore all deleted items of the selected restoration type within the selected site or workspace scope, specify an empty string (`''`) or omit the field.
94
94
  * `restoration_type` (string): Type of restoration to perform. `files` restores deleted filesystem items. `users` restores deleted users and associated access/authentication records removed as part of deleting those users.
95
- * `restore_deleted_permissions` (boolean): If true, restore permissions removed as part of deleting the selected users for a user restore, or permissions matching the selected path prefix and deletion dates for a file restore.
95
+ * `restore_deleted_permissions` (boolean): If true, a user restore restores permissions removed as part of deleting the selected users. An in-place file restore restores user and group permissions on returned folders and their subfolders that were deleted from the time of the folder's deletion through 24 hours afterward, including permissions removed independently within that window. File restores into a new folder do not restore permissions.
96
96
  * `restore_in_place` (boolean): If true, we will restore the files in place (into their original paths). If false, we will create a new restoration folder in the root and restore files there.
97
97
  * `update_timestamps` (boolean): If true, we will update the last modified timestamp of restored files to today's date. If false, we might trigger File Expiration to delete the file again.
98
98
  * `workspace_id` (int64): Workspace ID for a workspace-scoped restore. `0` means the default site-wide scope.
data/docs/site.md CHANGED
@@ -546,7 +546,7 @@
546
546
  * `smtp_authentication` (string): SMTP server authentication type
547
547
  * `smtp_from` (string): From address to use when mailing through custom SMTP
548
548
  * `smtp_port` (int64): SMTP server port
549
- * `smtp_ssl` (string): Custom SMTP encryption mode: if_available (default) uses STARTTLS when offered and otherwise sends credentials and messages unencrypted; require requires STARTTLS before authentication; require_implicit uses TLS from connection start; never disables TLS. TLS verifies the server certificate against smtp_address.
549
+ * `smtp_ssl` (string): Custom SMTP encryption mode: if_available (default) uses STARTTLS when offered and otherwise sends credentials and messages unencrypted. A certificate-verified STARTTLS connection automatically changes if_available to require unless smtp_ssl is managed by a parent policy. require requires STARTTLS before authentication; require_implicit uses TLS from connection start; never disables TLS. TLS verifies the server certificate against smtp_address. Encryption is never automatically downgraded.
550
550
  * `smtp_username` (string): SMTP server username
551
551
  * `session_expiry_minutes` (int64): Session expiry in minutes
552
552
  * `snapshot_sharing_enabled` (boolean): Allow snapshot share links creation
@@ -939,7 +939,7 @@ Files::Site.update(
939
939
  * `smtp_from` (string): From address to use when mailing through custom SMTP
940
940
  * `smtp_username` (string): SMTP server username
941
941
  * `smtp_port` (int64): SMTP server port
942
- * `smtp_ssl` (string): Custom SMTP encryption mode: if_available (default) uses STARTTLS when offered and otherwise sends credentials and messages unencrypted; require requires STARTTLS before authentication; require_implicit uses TLS from connection start; never disables TLS. TLS verifies the server certificate against smtp_address.
942
+ * `smtp_ssl` (string): Custom SMTP encryption mode: if_available (default) uses STARTTLS when offered and otherwise sends credentials and messages unencrypted. A certificate-verified STARTTLS connection automatically changes if_available to require unless smtp_ssl is managed by a parent policy. require requires STARTTLS before authentication; require_implicit uses TLS from connection start; never disables TLS. TLS verifies the server certificate against smtp_address. Encryption is never automatically downgraded.
943
943
  * `ldap_enabled` (boolean): Main LDAP setting: is LDAP enabled?
944
944
  * `ldap_type` (string): LDAP type
945
945
  * `ldap_host` (string): LDAP host
@@ -20,7 +20,7 @@
20
20
  "notify_users": true,
21
21
  "partner_tag": "guest",
22
22
  "site_id": 1,
23
- "workspace_id": 12,
23
+ "workspace_id": 1,
24
24
  "user_state": "inactive",
25
25
  "user_tag": "guest"
26
26
  }
@@ -32,13 +32,13 @@
32
32
  * `action` (string): Action to take on inactive users (disable or delete)
33
33
  * `inactivity_days` (int64): Number of days of inactivity before the rule applies
34
34
  * `include_folder_admins` (boolean): If true, the rule will apply to folder admins.
35
- * `include_site_admins` (boolean): If true, the rule will apply to site admins.
36
- * `apply_to_all_workspaces` (boolean): If true, a default-workspace rule also applies to users in all workspaces.
35
+ * `include_site_admins` (boolean): If true, the rule includes Site Administrators, who always belong to the Default Workspace. Can only be enabled when `workspace_id` is `0`.
36
+ * `apply_to_all_workspaces` (boolean): If true, a Default Workspace rule also applies to users in all Custom Workspaces. Can only be enabled when `workspace_id` is `0`.
37
37
  * `name` (string): User Lifecycle Rule name
38
38
  * `notify_users` (boolean): If true, users will be emailed before the rule disables or deletes them.
39
39
  * `partner_tag` (string): If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
40
40
  * `site_id` (int64): Site ID
41
- * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
41
+ * `workspace_id` (int64): Workspace whose users the rule applies to. `0` means the Default Workspace. A Custom Workspace rule applies only to users who belong to that Workspace, regardless of access granted to other users.
42
42
  * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
43
43
  * `user_tag` (string): If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
44
44
 
@@ -89,25 +89,25 @@ Files::UserLifecycleRule.create(
89
89
  partner_tag: "guest",
90
90
  user_state: "inactive",
91
91
  user_tag: "guest",
92
- workspace_id: 12
92
+ workspace_id: 0
93
93
  )
94
94
  ```
95
95
 
96
96
  ### Parameters
97
97
 
98
98
  * `action` (string): Action to take on inactive users (disable or delete)
99
- * `apply_to_all_workspaces` (boolean): If true, a default-workspace rule also applies to users in all workspaces.
99
+ * `apply_to_all_workspaces` (boolean): If true, a Default Workspace rule also applies to users in all Custom Workspaces. Can only be enabled when `workspace_id` is `0`.
100
100
  * `authentication_method` (string): User authentication method for which the rule will apply. Use `all_non_sso` to target every non-SSO authentication method with one rule.
101
101
  * `group_ids` (array(int64)): Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
102
102
  * `inactivity_days` (int64): Number of days of inactivity before the rule applies
103
- * `include_site_admins` (boolean): If true, the rule will apply to site admins.
103
+ * `include_site_admins` (boolean): If true, the rule includes Site Administrators, who always belong to the Default Workspace. Can only be enabled when `workspace_id` is `0`.
104
104
  * `include_folder_admins` (boolean): If true, the rule will apply to folder admins.
105
105
  * `name` (string): User Lifecycle Rule name
106
106
  * `notify_users` (boolean): If true, users will be emailed before the rule disables or deletes them.
107
107
  * `partner_tag` (string): If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
108
108
  * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
109
109
  * `user_tag` (string): If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
110
- * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
110
+ * `workspace_id` (int64): Workspace whose users the rule applies to. `0` means the Default Workspace. A Custom Workspace rule applies only to users who belong to that Workspace, regardless of access granted to other users.
111
111
 
112
112
 
113
113
  ---
@@ -127,7 +127,7 @@ Files::UserLifecycleRule.update(id,
127
127
  partner_tag: "guest",
128
128
  user_state: "inactive",
129
129
  user_tag: "guest",
130
- workspace_id: 12
130
+ workspace_id: 0
131
131
  )
132
132
  ```
133
133
 
@@ -135,18 +135,18 @@ Files::UserLifecycleRule.update(id,
135
135
 
136
136
  * `id` (int64): Required - User Lifecycle Rule ID.
137
137
  * `action` (string): Action to take on inactive users (disable or delete)
138
- * `apply_to_all_workspaces` (boolean): If true, a default-workspace rule also applies to users in all workspaces.
138
+ * `apply_to_all_workspaces` (boolean): If true, a Default Workspace rule also applies to users in all Custom Workspaces. Can only be enabled when `workspace_id` is `0`.
139
139
  * `authentication_method` (string): User authentication method for which the rule will apply. Use `all_non_sso` to target every non-SSO authentication method with one rule.
140
140
  * `group_ids` (array(int64)): Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
141
141
  * `inactivity_days` (int64): Number of days of inactivity before the rule applies
142
- * `include_site_admins` (boolean): If true, the rule will apply to site admins.
142
+ * `include_site_admins` (boolean): If true, the rule includes Site Administrators, who always belong to the Default Workspace. Can only be enabled when `workspace_id` is `0`.
143
143
  * `include_folder_admins` (boolean): If true, the rule will apply to folder admins.
144
144
  * `name` (string): User Lifecycle Rule name
145
145
  * `notify_users` (boolean): If true, users will be emailed before the rule disables or deletes them.
146
146
  * `partner_tag` (string): If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
147
147
  * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
148
148
  * `user_tag` (string): If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
149
- * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
149
+ * `workspace_id` (int64): Workspace whose users the rule applies to. `0` means the Default Workspace. A Custom Workspace rule applies only to users who belong to that Workspace, regardless of access granted to other users.
150
150
 
151
151
 
152
152
  ---
@@ -181,7 +181,7 @@ user_lifecycle_rule.update(
181
181
  partner_tag: "guest",
182
182
  user_state: "inactive",
183
183
  user_tag: "guest",
184
- workspace_id: 12
184
+ workspace_id: 0
185
185
  )
186
186
  ```
187
187
 
@@ -189,18 +189,18 @@ user_lifecycle_rule.update(
189
189
 
190
190
  * `id` (int64): Required - User Lifecycle Rule ID.
191
191
  * `action` (string): Action to take on inactive users (disable or delete)
192
- * `apply_to_all_workspaces` (boolean): If true, a default-workspace rule also applies to users in all workspaces.
192
+ * `apply_to_all_workspaces` (boolean): If true, a Default Workspace rule also applies to users in all Custom Workspaces. Can only be enabled when `workspace_id` is `0`.
193
193
  * `authentication_method` (string): User authentication method for which the rule will apply. Use `all_non_sso` to target every non-SSO authentication method with one rule.
194
194
  * `group_ids` (array(int64)): Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
195
195
  * `inactivity_days` (int64): Number of days of inactivity before the rule applies
196
- * `include_site_admins` (boolean): If true, the rule will apply to site admins.
196
+ * `include_site_admins` (boolean): If true, the rule includes Site Administrators, who always belong to the Default Workspace. Can only be enabled when `workspace_id` is `0`.
197
197
  * `include_folder_admins` (boolean): If true, the rule will apply to folder admins.
198
198
  * `name` (string): User Lifecycle Rule name
199
199
  * `notify_users` (boolean): If true, users will be emailed before the rule disables or deletes them.
200
200
  * `partner_tag` (string): If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
201
201
  * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
202
202
  * `user_tag` (string): If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
203
- * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
203
+ * `workspace_id` (int64): Workspace whose users the rule applies to. `0` means the Default Workspace. A Custom Workspace rule applies only to users who belong to that Workspace, regardless of access granted to other users.
204
204
 
205
205
 
206
206
  ---
@@ -81,7 +81,7 @@ module Files
81
81
  @attributes[:files_total] = value
82
82
  end
83
83
 
84
- # string - Prefix of the files/folders to restore, or a case-insensitive username prefix for a user restore. To restore a folder, add a trailing slash to the folder name. Do not use a leading slash. To restore all deleted items of the selected restoration type, specify an empty string (`''`) in the prefix field or omit the field from the request.
84
+ # string - Prefix of the files/folders to restore, or a case-insensitive username prefix for a user restore. A trailing slash selects that folder and its contents only; without it, the prefix matches any path beginning with that text. Do not use a leading slash. To restore all deleted items of the selected restoration type within the selected site or workspace scope, specify an empty string (`''`) or omit the field.
85
85
  def prefix
86
86
  @attributes[:prefix]
87
87
  end
@@ -108,7 +108,7 @@ module Files
108
108
  @attributes[:restore_in_place] = value
109
109
  end
110
110
 
111
- # boolean - If true, restore permissions removed as part of deleting the selected users for a user restore, or permissions matching the selected path prefix and deletion dates for a file restore.
111
+ # boolean - If true, a user restore restores permissions removed as part of deleting the selected users. An in-place file restore restores user and group permissions on returned folders and their subfolders that were deleted from the time of the folder's deletion through 24 hours afterward, including permissions removed independently within that window. File restores into a new folder do not restore permissions.
112
112
  def restore_deleted_permissions
113
113
  @attributes[:restore_deleted_permissions]
114
114
  end
@@ -240,9 +240,9 @@ module Files
240
240
 
241
241
  # Parameters:
242
242
  # earliest_date (required) - string - Restore files or users deleted on or after this date/time. Don't set this earlier than you need. Can not be greater than 365 days prior to the restore request.
243
- # prefix - string - Prefix of the files/folders to restore, or a case-insensitive username prefix for a user restore. To restore a folder, add a trailing slash to the folder name. Do not use a leading slash. To restore all deleted items of the selected restoration type, specify an empty string (`''`) in the prefix field or omit the field from the request.
243
+ # prefix - string - Prefix of the files/folders to restore, or a case-insensitive username prefix for a user restore. A trailing slash selects that folder and its contents only; without it, the prefix matches any path beginning with that text. Do not use a leading slash. To restore all deleted items of the selected restoration type within the selected site or workspace scope, specify an empty string (`''`) or omit the field.
244
244
  # restoration_type - string - Type of restoration to perform. `files` restores deleted filesystem items. `users` restores deleted users and associated access/authentication records removed as part of deleting those users.
245
- # restore_deleted_permissions - boolean - If true, restore permissions removed as part of deleting the selected users for a user restore, or permissions matching the selected path prefix and deletion dates for a file restore.
245
+ # restore_deleted_permissions - boolean - If true, a user restore restores permissions removed as part of deleting the selected users. An in-place file restore restores user and group permissions on returned folders and their subfolders that were deleted from the time of the folder's deletion through 24 hours afterward, including permissions removed independently within that window. File restores into a new folder do not restore permissions.
246
246
  # restore_in_place - boolean - If true, we will restore the files in place (into their original paths). If false, we will create a new restoration folder in the root and restore files there.
247
247
  # update_timestamps - boolean - If true, we will update the last modified timestamp of restored files to today's date. If false, we might trigger File Expiration to delete the file again.
248
248
  # workspace_id - int64 - Workspace ID for a workspace-scoped restore. `0` means the default site-wide scope.
@@ -864,7 +864,7 @@ module Files
864
864
  @attributes[:smtp_port]
865
865
  end
866
866
 
867
- # string - Custom SMTP encryption mode: if_available (default) uses STARTTLS when offered and otherwise sends credentials and messages unencrypted; require requires STARTTLS before authentication; require_implicit uses TLS from connection start; never disables TLS. TLS verifies the server certificate against smtp_address.
867
+ # string - Custom SMTP encryption mode: if_available (default) uses STARTTLS when offered and otherwise sends credentials and messages unencrypted. A certificate-verified STARTTLS connection automatically changes if_available to require unless smtp_ssl is managed by a parent policy. require requires STARTTLS before authentication; require_implicit uses TLS from connection start; never disables TLS. TLS verifies the server certificate against smtp_address. Encryption is never automatically downgraded.
868
868
  def smtp_ssl
869
869
  @attributes[:smtp_ssl]
870
870
  end
@@ -1168,7 +1168,7 @@ module Files
1168
1168
  # smtp_from - string - From address to use when mailing through custom SMTP
1169
1169
  # smtp_username - string - SMTP server username
1170
1170
  # smtp_port - int64 - SMTP server port
1171
- # smtp_ssl - string - Custom SMTP encryption mode: if_available (default) uses STARTTLS when offered and otherwise sends credentials and messages unencrypted; require requires STARTTLS before authentication; require_implicit uses TLS from connection start; never disables TLS. TLS verifies the server certificate against smtp_address.
1171
+ # smtp_ssl - string - Custom SMTP encryption mode: if_available (default) uses STARTTLS when offered and otherwise sends credentials and messages unencrypted. A certificate-verified STARTTLS connection automatically changes if_available to require unless smtp_ssl is managed by a parent policy. require requires STARTTLS before authentication; require_implicit uses TLS from connection start; never disables TLS. TLS verifies the server certificate against smtp_address. Encryption is never automatically downgraded.
1172
1172
  # ldap_enabled - boolean - Main LDAP setting: is LDAP enabled?
1173
1173
  # ldap_type - string - LDAP type
1174
1174
  # ldap_host - string - LDAP host
@@ -63,7 +63,7 @@ module Files
63
63
  @attributes[:include_folder_admins] = value
64
64
  end
65
65
 
66
- # boolean - If true, the rule will apply to site admins.
66
+ # boolean - If true, the rule includes Site Administrators, who always belong to the Default Workspace. Can only be enabled when `workspace_id` is `0`.
67
67
  def include_site_admins
68
68
  @attributes[:include_site_admins]
69
69
  end
@@ -72,7 +72,7 @@ module Files
72
72
  @attributes[:include_site_admins] = value
73
73
  end
74
74
 
75
- # boolean - If true, a default-workspace rule also applies to users in all workspaces.
75
+ # boolean - If true, a Default Workspace rule also applies to users in all Custom Workspaces. Can only be enabled when `workspace_id` is `0`.
76
76
  def apply_to_all_workspaces
77
77
  @attributes[:apply_to_all_workspaces]
78
78
  end
@@ -117,7 +117,7 @@ module Files
117
117
  @attributes[:site_id] = value
118
118
  end
119
119
 
120
- # int64 - Workspace ID. `0` means the default workspace.
120
+ # int64 - Workspace whose users the rule applies to. `0` means the Default Workspace. A Custom Workspace rule applies only to users who belong to that Workspace, regardless of access granted to other users.
121
121
  def workspace_id
122
122
  @attributes[:workspace_id]
123
123
  end
@@ -146,18 +146,18 @@ module Files
146
146
 
147
147
  # Parameters:
148
148
  # action - string - Action to take on inactive users (disable or delete)
149
- # apply_to_all_workspaces - boolean - If true, a default-workspace rule also applies to users in all workspaces.
149
+ # apply_to_all_workspaces - boolean - If true, a Default Workspace rule also applies to users in all Custom Workspaces. Can only be enabled when `workspace_id` is `0`.
150
150
  # authentication_method - string - User authentication method for which the rule will apply. Use `all_non_sso` to target every non-SSO authentication method with one rule.
151
151
  # group_ids - array(int64) - Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
152
152
  # inactivity_days - int64 - Number of days of inactivity before the rule applies
153
- # include_site_admins - boolean - If true, the rule will apply to site admins.
153
+ # include_site_admins - boolean - If true, the rule includes Site Administrators, who always belong to the Default Workspace. Can only be enabled when `workspace_id` is `0`.
154
154
  # include_folder_admins - boolean - If true, the rule will apply to folder admins.
155
155
  # name - string - User Lifecycle Rule name
156
156
  # notify_users - boolean - If true, users will be emailed before the rule disables or deletes them.
157
157
  # partner_tag - string - If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
158
158
  # user_state - string - State of the users to apply the rule to (inactive or disabled)
159
159
  # user_tag - string - If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
160
- # workspace_id - int64 - Workspace ID. `0` means the default workspace.
160
+ # workspace_id - int64 - Workspace whose users the rule applies to. `0` means the Default Workspace. A Custom Workspace rule applies only to users who belong to that Workspace, regardless of access granted to other users.
161
161
  def update(params = {})
162
162
  params ||= {}
163
163
  params[:id] = @attributes[:id]
@@ -241,18 +241,18 @@ module Files
241
241
 
242
242
  # Parameters:
243
243
  # action - string - Action to take on inactive users (disable or delete)
244
- # apply_to_all_workspaces - boolean - If true, a default-workspace rule also applies to users in all workspaces.
244
+ # apply_to_all_workspaces - boolean - If true, a Default Workspace rule also applies to users in all Custom Workspaces. Can only be enabled when `workspace_id` is `0`.
245
245
  # authentication_method - string - User authentication method for which the rule will apply. Use `all_non_sso` to target every non-SSO authentication method with one rule.
246
246
  # group_ids - array(int64) - Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
247
247
  # inactivity_days - int64 - Number of days of inactivity before the rule applies
248
- # include_site_admins - boolean - If true, the rule will apply to site admins.
248
+ # include_site_admins - boolean - If true, the rule includes Site Administrators, who always belong to the Default Workspace. Can only be enabled when `workspace_id` is `0`.
249
249
  # include_folder_admins - boolean - If true, the rule will apply to folder admins.
250
250
  # name - string - User Lifecycle Rule name
251
251
  # notify_users - boolean - If true, users will be emailed before the rule disables or deletes them.
252
252
  # partner_tag - string - If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
253
253
  # user_state - string - State of the users to apply the rule to (inactive or disabled)
254
254
  # user_tag - string - If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
255
- # workspace_id - int64 - Workspace ID. `0` means the default workspace.
255
+ # workspace_id - int64 - Workspace whose users the rule applies to. `0` means the Default Workspace. A Custom Workspace rule applies only to users who belong to that Workspace, regardless of access granted to other users.
256
256
  def self.create(params = {}, options = {})
257
257
  raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
258
258
  raise InvalidParameterError.new("Bad parameter: authentication_method must be an String") if params[:authentication_method] and !params[:authentication_method].is_a?(String)
@@ -270,18 +270,18 @@ module Files
270
270
 
271
271
  # Parameters:
272
272
  # action - string - Action to take on inactive users (disable or delete)
273
- # apply_to_all_workspaces - boolean - If true, a default-workspace rule also applies to users in all workspaces.
273
+ # apply_to_all_workspaces - boolean - If true, a Default Workspace rule also applies to users in all Custom Workspaces. Can only be enabled when `workspace_id` is `0`.
274
274
  # authentication_method - string - User authentication method for which the rule will apply. Use `all_non_sso` to target every non-SSO authentication method with one rule.
275
275
  # group_ids - array(int64) - Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
276
276
  # inactivity_days - int64 - Number of days of inactivity before the rule applies
277
- # include_site_admins - boolean - If true, the rule will apply to site admins.
277
+ # include_site_admins - boolean - If true, the rule includes Site Administrators, who always belong to the Default Workspace. Can only be enabled when `workspace_id` is `0`.
278
278
  # include_folder_admins - boolean - If true, the rule will apply to folder admins.
279
279
  # name - string - User Lifecycle Rule name
280
280
  # notify_users - boolean - If true, users will be emailed before the rule disables or deletes them.
281
281
  # partner_tag - string - If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
282
282
  # user_state - string - State of the users to apply the rule to (inactive or disabled)
283
283
  # user_tag - string - If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
284
- # workspace_id - int64 - Workspace ID. `0` means the default workspace.
284
+ # workspace_id - int64 - Workspace whose users the rule applies to. `0` means the Default Workspace. A Custom Workspace rule applies only to users who belong to that Workspace, regardless of access granted to other users.
285
285
  def self.update(id, params = {}, options = {})
286
286
  params ||= {}
287
287
  params[:id] = id
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Files
4
- VERSION = "1.1.762"
4
+ VERSION = "1.1.764"
5
5
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: files.com
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.762
4
+ version: 1.1.764
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-10-01 00:00:00.000000000 Z
11
+ date: 2026-10-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable