files.com 1.1.326 → 1.1.328

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: 6e3b57a4f3d778bf9bcc60bd8e478891f5ce69e5f84ad4438dd9849b80d84c47
4
- data.tar.gz: 6e9ae272c50d961e884c0d076bfedb268e620d98d814df8dc50d51e9375edf1c
3
+ metadata.gz: 55ec352a68bc861c4214d0a6056bdc9ebccc92c38013d3e6efe50c18f08ea765
4
+ data.tar.gz: 8ee70d9136bf5428d6421d41c11a8e640e1a7a706d4ef970879fce623503da6a
5
5
  SHA512:
6
- metadata.gz: cf95045a9ab99a38ae194559ba85d1770ffd26a1cd2636aae6145268a3bcbf4242a973a1d402846168d6d55498d41cbce8ef69e44e37b239f49f9f719c7c48f0
7
- data.tar.gz: '083eab09174e8b86a6b2b7da4429218b916e8e09a021c3d549cfdc49a577452b06f4c1ffe38f361cc805b628911b24877c9b35ba365e3dbba4e07dae90bc38dc'
6
+ metadata.gz: 1a8e62568c7dc98f66f12aa3b96941d8b6de9ec30f69f69f8093c2bf0f013e09f94b4e54757a7fd6448cf7e8f55b116006c850b0cdd2963d7d83d25aafad683d
7
+ data.tar.gz: d85db8bc2eff91b881200d243f635244dc5f3f2185335b75c7d9fd3dd9d4f1b7916223afb07f376a677d698469a564ca58ed8c394f1283a111ccf525024dd67a
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.326
1
+ 1.1.328
data/docs/automation.md CHANGED
@@ -128,7 +128,7 @@
128
128
  * `source` (string): Source path/glob. See Automation docs for exact description, but this is used to filter for files in the `path` to find files to operate on. Supports globs, except on remote mounts.
129
129
  * `legacy_sync_ids` (array(int64)): IDs of remote sync folder behaviors to run by this Automation
130
130
  * `sync_ids` (array(int64)): IDs of syncs to run by this Automation. This is the new way to specify syncs, and it is recommended to use this instead of `legacy_sync_ids`.
131
- * `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
131
+ * `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, archived_delete, copy
132
132
  * `trigger` (string): How this automation is triggered to run.
133
133
  * `user_id` (int64): User ID of the Automation's creator.
134
134
  * `user_ids` (array(int64)): IDs of Users for the Automation (i.e. who to Request File from)
@@ -243,7 +243,7 @@ Files::Automation.create(
243
243
  * `retry_on_failure_interval_in_minutes` (int64): If the Automation fails, retry at this interval (in minutes). Acceptable values are 5 through 1440 (one day). Set to null to disable.
244
244
  * `retry_on_failure_number_of_attempts` (int64): If the Automation fails, retry at most this many times. Maximum allowed value: 10. Set to null to disable.
245
245
  * `trigger` (string): How this automation is triggered to run.
246
- * `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
246
+ * `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, archived_delete, copy
247
247
  * `value` (object): A Hash of attributes specific to the automation type.
248
248
  * `recurring_day` (int64): If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
249
249
  * `automation` (string): Required - Automation type
@@ -336,7 +336,7 @@ Files::Automation.update(id,
336
336
  * `retry_on_failure_interval_in_minutes` (int64): If the Automation fails, retry at this interval (in minutes). Acceptable values are 5 through 1440 (one day). Set to null to disable.
337
337
  * `retry_on_failure_number_of_attempts` (int64): If the Automation fails, retry at most this many times. Maximum allowed value: 10. Set to null to disable.
338
338
  * `trigger` (string): How this automation is triggered to run.
339
- * `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
339
+ * `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, archived_delete, copy
340
340
  * `value` (object): A Hash of attributes specific to the automation type.
341
341
  * `recurring_day` (int64): If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
342
342
  * `automation` (string): Automation type
@@ -446,7 +446,7 @@ automation.update(
446
446
  * `retry_on_failure_interval_in_minutes` (int64): If the Automation fails, retry at this interval (in minutes). Acceptable values are 5 through 1440 (one day). Set to null to disable.
447
447
  * `retry_on_failure_number_of_attempts` (int64): If the Automation fails, retry at most this many times. Maximum allowed value: 10. Set to null to disable.
448
448
  * `trigger` (string): How this automation is triggered to run.
449
- * `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
449
+ * `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, archived_delete, copy
450
450
  * `value` (object): A Hash of attributes specific to the automation type.
451
451
  * `recurring_day` (int64): If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
452
452
  * `automation` (string): Automation type
@@ -5,21 +5,32 @@
5
5
  ```
6
6
  {
7
7
  "id": 1,
8
- "site_id": 1,
9
- "site_setting_name": "color2_left",
10
- "managed_value": "#FF0000",
8
+ "policy_type": "settings",
9
+ "name": "example",
10
+ "description": "example",
11
+ "value": "{ \"color2_left\": \"#000000\" }",
12
+ "applied_child_site_ids": [
13
+ 1,
14
+ 2
15
+ ],
11
16
  "skip_child_site_ids": [
12
17
  1,
13
- 5
14
- ]
18
+ 2
19
+ ],
20
+ "created_at": "2000-01-01T01:00:00Z",
21
+ "updated_at": "2000-01-01T01:00:00Z"
15
22
  }
16
23
  ```
17
24
 
18
- * `id` (int64): ChildSiteManagementPolicy ID
19
- * `site_id` (int64): ID of the Site managing the policy
20
- * `site_setting_name` (string): The name of the setting that is managed by the policy
21
- * `managed_value` (string): The value for the setting that will be enforced for all child sites that are not exempt
22
- * `skip_child_site_ids` (array(int64)): The list of child site IDs that are exempt from this policy
25
+ * `id` (int64): Policy ID.
26
+ * `policy_type` (string): Type of policy. Valid values: `settings`.
27
+ * `name` (string): Name for this policy.
28
+ * `description` (string): Description for this policy.
29
+ * `value` (object): Policy configuration data. Attributes differ by policy type. For more information, refer to the Value Hash section of the developer documentation.
30
+ * `applied_child_site_ids` (array(int64)): IDs of child sites that this policy has been applied to. This field is read-only.
31
+ * `skip_child_site_ids` (array(int64)): IDs of child sites that this policy has been exempted from. If `skip_child_site_ids` is empty, the policy will be applied to all child sites. To apply a policy to a child site that has been exempted, remove it from `skip_child_site_ids` or set it to an empty array (`[]`).
32
+ * `created_at` (date-time): When this policy was created.
33
+ * `updated_at` (date-time): When this policy was last updated.
23
34
 
24
35
 
25
36
  ---
@@ -55,17 +66,21 @@ Files::ChildSiteManagementPolicy.find(id)
55
66
 
56
67
  ```
57
68
  Files::ChildSiteManagementPolicy.create(
58
- site_setting_name: "color2_left",
59
- managed_value: "#FF0000",
60
- skip_child_site_ids: [1,5]
69
+ value: "{ \"color2_left\": \"#000000\" }",
70
+ skip_child_site_ids: [1,2],
71
+ policy_type: "settings",
72
+ name: "example",
73
+ description: "example"
61
74
  )
62
75
  ```
63
76
 
64
77
  ### Parameters
65
78
 
66
- * `site_setting_name` (string): Required - The name of the setting that is managed by the policy
67
- * `managed_value` (string): Required - The value for the setting that will be enforced for all child sites that are not exempt
68
- * `skip_child_site_ids` (array(int64)): The list of child site IDs that are exempt from this policy
79
+ * `value` (string):
80
+ * `skip_child_site_ids` (array(int64)): IDs of child sites that this policy has been exempted from. If `skip_child_site_ids` is empty, the policy will be applied to all child sites. To apply a policy to a child site that has been exempted, remove it from `skip_child_site_ids` or set it to an empty array (`[]`).
81
+ * `policy_type` (string): Required - Type of policy. Valid values: `settings`.
82
+ * `name` (string): Name for this policy.
83
+ * `description` (string): Description for this policy.
69
84
 
70
85
 
71
86
  ---
@@ -74,18 +89,22 @@ Files::ChildSiteManagementPolicy.create(
74
89
 
75
90
  ```
76
91
  Files::ChildSiteManagementPolicy.update(id,
77
- site_setting_name: "color2_left",
78
- managed_value: "#FF0000",
79
- skip_child_site_ids: [1,5]
92
+ value: "{ \"color2_left\": \"#000000\" }",
93
+ skip_child_site_ids: [1,2],
94
+ policy_type: "settings",
95
+ name: "example",
96
+ description: "example"
80
97
  )
81
98
  ```
82
99
 
83
100
  ### Parameters
84
101
 
85
102
  * `id` (int64): Required - Child Site Management Policy ID.
86
- * `site_setting_name` (string): Required - The name of the setting that is managed by the policy
87
- * `managed_value` (string): Required - The value for the setting that will be enforced for all child sites that are not exempt
88
- * `skip_child_site_ids` (array(int64)): The list of child site IDs that are exempt from this policy
103
+ * `value` (string):
104
+ * `skip_child_site_ids` (array(int64)): IDs of child sites that this policy has been exempted from. If `skip_child_site_ids` is empty, the policy will be applied to all child sites. To apply a policy to a child site that has been exempted, remove it from `skip_child_site_ids` or set it to an empty array (`[]`).
105
+ * `policy_type` (string): Type of policy. Valid values: `settings`.
106
+ * `name` (string): Name for this policy.
107
+ * `description` (string): Description for this policy.
89
108
 
90
109
 
91
110
  ---
@@ -109,18 +128,22 @@ Files::ChildSiteManagementPolicy.delete(id)
109
128
  child_site_management_policy = Files::ChildSiteManagementPolicy.find(id)
110
129
 
111
130
  child_site_management_policy.update(
112
- site_setting_name: "color2_left",
113
- managed_value: "#FF0000",
114
- skip_child_site_ids: [1,5]
131
+ value: "{ \"color2_left\": \"#000000\" }",
132
+ skip_child_site_ids: [1,2],
133
+ policy_type: "settings",
134
+ name: "example",
135
+ description: "example"
115
136
  )
116
137
  ```
117
138
 
118
139
  ### Parameters
119
140
 
120
141
  * `id` (int64): Required - Child Site Management Policy ID.
121
- * `site_setting_name` (string): Required - The name of the setting that is managed by the policy
122
- * `managed_value` (string): Required - The value for the setting that will be enforced for all child sites that are not exempt
123
- * `skip_child_site_ids` (array(int64)): The list of child site IDs that are exempt from this policy
142
+ * `value` (string):
143
+ * `skip_child_site_ids` (array(int64)): IDs of child sites that this policy has been exempted from. If `skip_child_site_ids` is empty, the policy will be applied to all child sites. To apply a policy to a child site that has been exempted, remove it from `skip_child_site_ids` or set it to an empty array (`[]`).
144
+ * `policy_type` (string): Type of policy. Valid values: `settings`.
145
+ * `name` (string): Name for this policy.
146
+ * `description` (string): Description for this policy.
124
147
 
125
148
 
126
149
  ---
@@ -37,7 +37,7 @@
37
37
  * `start_at` (date-time): Start date/time of export range.
38
38
  * `end_at` (date-time): End date/time of export range.
39
39
  * `status` (string): Status of export. Will be: `building`, `ready`, or `failed`
40
- * `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
40
+ * `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`, `archived_delete`
41
41
  * `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
42
42
  * `query_user_id` (string): Return results that are actions performed by the user indicated by this User ID
43
43
  * `query_file_id` (string): Return results that are file actions related to the file indicated by this File ID
@@ -109,7 +109,7 @@ Files::HistoryExport.create(
109
109
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
110
110
  * `start_at` (string): Start date/time of export range.
111
111
  * `end_at` (string): End date/time of export range.
112
- * `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
112
+ * `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`, `archived_delete`
113
113
  * `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
114
114
  * `query_user_id` (string): Return results that are actions performed by the user indicated by this User ID
115
115
  * `query_file_id` (string): Return results that are file actions related to the file indicated by this File ID
@@ -46,7 +46,7 @@
46
46
  * `ip` (string): Client IP that performed the action
47
47
  * `username` (string): Username of the user that performed the action
48
48
  * `user_is_from_parent_site` (boolean): true if this change was performed by a user on a parent site.
49
- * `action` (string): What action was taken. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
49
+ * `action` (string): What action was taken. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`, `archived_delete`
50
50
  * `failure_type` (string): The type of login failure, if applicable. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`, `insecure_ftp`, `insecure_cipher`, `rate_limited`
51
51
  * `interface` (string): Interface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
52
52
  * `target_id` (int64): ID of the object (such as Users, or API Keys) on which the action was taken
@@ -8,6 +8,18 @@
8
8
  "enabled": true,
9
9
  "fall": 1,
10
10
  "health_check_enabled": true,
11
+ "health_check_results": [
12
+ {
13
+ "timestamp": "2025-09-19T12:32:52+00:00",
14
+ "status": "healthy",
15
+ "canary_timestamp": "2025-09-19T12:32:52+00:00"
16
+ },
17
+ {
18
+ "status": "failed",
19
+ "reason": "Unable to connect",
20
+ "timestamp": "2025-09-19T12:32:52+00:00"
21
+ }
22
+ ],
11
23
  "health_check_type": "active",
12
24
  "id": 1,
13
25
  "interval": 60,
@@ -27,6 +39,7 @@
27
39
  * `enabled` (boolean): True if this backend is enabled.
28
40
  * `fall` (int64): Number of consecutive failures before considering the backend unhealthy.
29
41
  * `health_check_enabled` (boolean): True if health checks are enabled for this backend.
42
+ * `health_check_results` (array(object)): Array of recent health check results.
30
43
  * `health_check_type` (string): Type of health check to perform.
31
44
  * `id` (int64): Unique identifier for this backend.
32
45
  * `interval` (int64): Interval in seconds between health checks.
data/docs/site.md CHANGED
@@ -130,6 +130,7 @@
130
130
  "uri": "https://mysite.files.com/.../my_image.png"
131
131
  },
132
132
  "max_prior_passwords": 1,
133
+ "managed_site_settings": "example",
133
134
  "motd_text": "example",
134
135
  "motd_use_for_ftp": true,
135
136
  "motd_use_for_sftp": true,
@@ -300,10 +301,7 @@
300
301
  "welcome_email_enabled": true,
301
302
  "welcome_screen": "user_controlled",
302
303
  "windows_mode_ftp": true,
303
- "group_admins_can_set_user_password": true,
304
- "managed_site_settings": [
305
- "example"
306
- ]
304
+ "group_admins_can_set_user_password": true
307
305
  }
308
306
  ```
309
307
 
@@ -406,6 +404,7 @@
406
404
  * `logo` (Image): Branded logo
407
405
  * `login_page_background_image` (Image): Branded login page background
408
406
  * `max_prior_passwords` (int64): Number of prior passwords to disallow
407
+ * `managed_site_settings` (object): List of site settings managed by the parent site
409
408
  * `motd_text` (string): A message to show users when they connect via FTP or SFTP.
410
409
  * `motd_use_for_ftp` (boolean): Show message to users connecting via FTP
411
410
  * `motd_use_for_sftp` (boolean): Show message to users connecting via SFTP
@@ -478,7 +477,6 @@
478
477
  * `welcome_screen` (string): Does the welcome screen appear?
479
478
  * `windows_mode_ftp` (boolean): Does FTP user Windows emulation mode?
480
479
  * `group_admins_can_set_user_password` (boolean): Allow group admins set password authentication method
481
- * `managed_site_settings` (array(string)): List of site settings managed by the parent site
482
480
 
483
481
 
484
482
  ---
@@ -306,7 +306,7 @@ module Files
306
306
  @attributes[:sync_ids] = value
307
307
  end
308
308
 
309
- # array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
309
+ # array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, archived_delete, copy
310
310
  def trigger_actions
311
311
  @attributes[:trigger_actions]
312
312
  end
@@ -410,7 +410,7 @@ module Files
410
410
  # retry_on_failure_interval_in_minutes - int64 - If the Automation fails, retry at this interval (in minutes). Acceptable values are 5 through 1440 (one day). Set to null to disable.
411
411
  # retry_on_failure_number_of_attempts - int64 - If the Automation fails, retry at most this many times. Maximum allowed value: 10. Set to null to disable.
412
412
  # trigger - string - How this automation is triggered to run.
413
- # trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
413
+ # trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, archived_delete, copy
414
414
  # value - object - A Hash of attributes specific to the automation type.
415
415
  # recurring_day - int64 - If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
416
416
  # automation - string - Automation type
@@ -549,7 +549,7 @@ module Files
549
549
  # retry_on_failure_interval_in_minutes - int64 - If the Automation fails, retry at this interval (in minutes). Acceptable values are 5 through 1440 (one day). Set to null to disable.
550
550
  # retry_on_failure_number_of_attempts - int64 - If the Automation fails, retry at most this many times. Maximum allowed value: 10. Set to null to disable.
551
551
  # trigger - string - How this automation is triggered to run.
552
- # trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
552
+ # trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, archived_delete, copy
553
553
  # value - object - A Hash of attributes specific to the automation type.
554
554
  # recurring_day - int64 - If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
555
555
  # automation (required) - string - Automation type
@@ -627,7 +627,7 @@ module Files
627
627
  # retry_on_failure_interval_in_minutes - int64 - If the Automation fails, retry at this interval (in minutes). Acceptable values are 5 through 1440 (one day). Set to null to disable.
628
628
  # retry_on_failure_number_of_attempts - int64 - If the Automation fails, retry at most this many times. Maximum allowed value: 10. Set to null to disable.
629
629
  # trigger - string - How this automation is triggered to run.
630
- # trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
630
+ # trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, archived_delete, copy
631
631
  # value - object - A Hash of attributes specific to the automation type.
632
632
  # recurring_day - int64 - If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
633
633
  # automation - string - Automation type
@@ -9,7 +9,7 @@ module Files
9
9
  @options = options || {}
10
10
  end
11
11
 
12
- # int64 - ChildSiteManagementPolicy ID
12
+ # int64 - Policy ID.
13
13
  def id
14
14
  @attributes[:id]
15
15
  end
@@ -18,34 +18,52 @@ module Files
18
18
  @attributes[:id] = value
19
19
  end
20
20
 
21
- # int64 - ID of the Site managing the policy
22
- def site_id
23
- @attributes[:site_id]
21
+ # string - Type of policy. Valid values: `settings`.
22
+ def policy_type
23
+ @attributes[:policy_type]
24
24
  end
25
25
 
26
- def site_id=(value)
27
- @attributes[:site_id] = value
26
+ def policy_type=(value)
27
+ @attributes[:policy_type] = value
28
28
  end
29
29
 
30
- # string - The name of the setting that is managed by the policy
31
- def site_setting_name
32
- @attributes[:site_setting_name]
30
+ # string - Name for this policy.
31
+ def name
32
+ @attributes[:name]
33
33
  end
34
34
 
35
- def site_setting_name=(value)
36
- @attributes[:site_setting_name] = value
35
+ def name=(value)
36
+ @attributes[:name] = value
37
37
  end
38
38
 
39
- # string - The value for the setting that will be enforced for all child sites that are not exempt
40
- def managed_value
41
- @attributes[:managed_value]
39
+ # string - Description for this policy.
40
+ def description
41
+ @attributes[:description]
42
42
  end
43
43
 
44
- def managed_value=(value)
45
- @attributes[:managed_value] = value
44
+ def description=(value)
45
+ @attributes[:description] = value
46
46
  end
47
47
 
48
- # array(int64) - The list of child site IDs that are exempt from this policy
48
+ # object - Policy configuration data. Attributes differ by policy type. For more information, refer to the Value Hash section of the developer documentation.
49
+ def value
50
+ @attributes[:value]
51
+ end
52
+
53
+ def value=(value)
54
+ @attributes[:value] = value
55
+ end
56
+
57
+ # array(int64) - IDs of child sites that this policy has been applied to. This field is read-only.
58
+ def applied_child_site_ids
59
+ @attributes[:applied_child_site_ids]
60
+ end
61
+
62
+ def applied_child_site_ids=(value)
63
+ @attributes[:applied_child_site_ids] = value
64
+ end
65
+
66
+ # array(int64) - IDs of child sites that this policy has been exempted from. If `skip_child_site_ids` is empty, the policy will be applied to all child sites. To apply a policy to a child site that has been exempted, remove it from `skip_child_site_ids` or set it to an empty array (`[]`).
49
67
  def skip_child_site_ids
50
68
  @attributes[:skip_child_site_ids]
51
69
  end
@@ -54,21 +72,33 @@ module Files
54
72
  @attributes[:skip_child_site_ids] = value
55
73
  end
56
74
 
75
+ # date-time - When this policy was created.
76
+ def created_at
77
+ @attributes[:created_at]
78
+ end
79
+
80
+ # date-time - When this policy was last updated.
81
+ def updated_at
82
+ @attributes[:updated_at]
83
+ end
84
+
57
85
  # Parameters:
58
- # site_setting_name (required) - string - The name of the setting that is managed by the policy
59
- # managed_value (required) - string - The value for the setting that will be enforced for all child sites that are not exempt
60
- # skip_child_site_ids - array(int64) - The list of child site IDs that are exempt from this policy
86
+ # value - string
87
+ # skip_child_site_ids - array(int64) - IDs of child sites that this policy has been exempted from. If `skip_child_site_ids` is empty, the policy will be applied to all child sites. To apply a policy to a child site that has been exempted, remove it from `skip_child_site_ids` or set it to an empty array (`[]`).
88
+ # policy_type - string - Type of policy. Valid values: `settings`.
89
+ # name - string - Name for this policy.
90
+ # description - string - Description for this policy.
61
91
  def update(params = {})
62
92
  params ||= {}
63
93
  params[:id] = @attributes[:id]
64
94
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
65
95
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
66
- raise InvalidParameterError.new("Bad parameter: site_setting_name must be an String") if params[:site_setting_name] and !params[:site_setting_name].is_a?(String)
67
- raise InvalidParameterError.new("Bad parameter: managed_value must be an String") if params[:managed_value] and !params[:managed_value].is_a?(String)
96
+ raise InvalidParameterError.new("Bad parameter: value must be an String") if params[:value] and !params[:value].is_a?(String)
68
97
  raise InvalidParameterError.new("Bad parameter: skip_child_site_ids must be an Array") if params[:skip_child_site_ids] and !params[:skip_child_site_ids].is_a?(Array)
98
+ raise InvalidParameterError.new("Bad parameter: policy_type must be an String") if params[:policy_type] and !params[:policy_type].is_a?(String)
99
+ raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
100
+ raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
69
101
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
70
- raise MissingParameterError.new("Parameter missing: site_setting_name") unless params[:site_setting_name]
71
- raise MissingParameterError.new("Parameter missing: managed_value") unless params[:managed_value]
72
102
 
73
103
  Api.send_request("/child_site_management_policies/#{@attributes[:id]}", :patch, params, @options)
74
104
  end
@@ -132,34 +162,39 @@ module Files
132
162
  end
133
163
 
134
164
  # Parameters:
135
- # site_setting_name (required) - string - The name of the setting that is managed by the policy
136
- # managed_value (required) - string - The value for the setting that will be enforced for all child sites that are not exempt
137
- # skip_child_site_ids - array(int64) - The list of child site IDs that are exempt from this policy
165
+ # value - string
166
+ # skip_child_site_ids - array(int64) - IDs of child sites that this policy has been exempted from. If `skip_child_site_ids` is empty, the policy will be applied to all child sites. To apply a policy to a child site that has been exempted, remove it from `skip_child_site_ids` or set it to an empty array (`[]`).
167
+ # policy_type (required) - string - Type of policy. Valid values: `settings`.
168
+ # name - string - Name for this policy.
169
+ # description - string - Description for this policy.
138
170
  def self.create(params = {}, options = {})
139
- raise InvalidParameterError.new("Bad parameter: site_setting_name must be an String") if params[:site_setting_name] and !params[:site_setting_name].is_a?(String)
140
- raise InvalidParameterError.new("Bad parameter: managed_value must be an String") if params[:managed_value] and !params[:managed_value].is_a?(String)
171
+ raise InvalidParameterError.new("Bad parameter: value must be an String") if params[:value] and !params[:value].is_a?(String)
141
172
  raise InvalidParameterError.new("Bad parameter: skip_child_site_ids must be an Array") if params[:skip_child_site_ids] and !params[:skip_child_site_ids].is_a?(Array)
142
- raise MissingParameterError.new("Parameter missing: site_setting_name") unless params[:site_setting_name]
143
- raise MissingParameterError.new("Parameter missing: managed_value") unless params[:managed_value]
173
+ raise InvalidParameterError.new("Bad parameter: policy_type must be an String") if params[:policy_type] and !params[:policy_type].is_a?(String)
174
+ raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
175
+ raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
176
+ raise MissingParameterError.new("Parameter missing: policy_type") unless params[:policy_type]
144
177
 
145
178
  response, options = Api.send_request("/child_site_management_policies", :post, params, options)
146
179
  ChildSiteManagementPolicy.new(response.data, options)
147
180
  end
148
181
 
149
182
  # Parameters:
150
- # site_setting_name (required) - string - The name of the setting that is managed by the policy
151
- # managed_value (required) - string - The value for the setting that will be enforced for all child sites that are not exempt
152
- # skip_child_site_ids - array(int64) - The list of child site IDs that are exempt from this policy
183
+ # value - string
184
+ # skip_child_site_ids - array(int64) - IDs of child sites that this policy has been exempted from. If `skip_child_site_ids` is empty, the policy will be applied to all child sites. To apply a policy to a child site that has been exempted, remove it from `skip_child_site_ids` or set it to an empty array (`[]`).
185
+ # policy_type - string - Type of policy. Valid values: `settings`.
186
+ # name - string - Name for this policy.
187
+ # description - string - Description for this policy.
153
188
  def self.update(id, params = {}, options = {})
154
189
  params ||= {}
155
190
  params[:id] = id
156
- raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
157
- raise InvalidParameterError.new("Bad parameter: site_setting_name must be an String") if params[:site_setting_name] and !params[:site_setting_name].is_a?(String)
158
- raise InvalidParameterError.new("Bad parameter: managed_value must be an String") if params[:managed_value] and !params[:managed_value].is_a?(String)
191
+ raise InvalidParameterError.new("Bad parameter: id must be one of String, Integer, Hash") if params[:id] and [ String, Integer, Hash ].none? { |klass| params[:id].is_a?(klass) }
192
+ raise InvalidParameterError.new("Bad parameter: value must be an String") if params[:value] and !params[:value].is_a?(String)
159
193
  raise InvalidParameterError.new("Bad parameter: skip_child_site_ids must be an Array") if params[:skip_child_site_ids] and !params[:skip_child_site_ids].is_a?(Array)
194
+ raise InvalidParameterError.new("Bad parameter: policy_type must be an String") if params[:policy_type] and !params[:policy_type].is_a?(String)
195
+ raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
196
+ raise InvalidParameterError.new("Bad parameter: description must be one of String, Integer, Hash") if params[:description] and [ String, Integer, Hash ].none? { |klass| params[:description].is_a?(klass) }
160
197
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
161
- raise MissingParameterError.new("Parameter missing: site_setting_name") unless params[:site_setting_name]
162
- raise MissingParameterError.new("Parameter missing: managed_value") unless params[:managed_value]
163
198
 
164
199
  response, options = Api.send_request("/child_site_management_policies/#{params[:id]}", :patch, params, options)
165
200
  ChildSiteManagementPolicy.new(response.data, options)
@@ -54,7 +54,7 @@ module Files
54
54
  @attributes[:status] = value
55
55
  end
56
56
 
57
- # string - Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
57
+ # string - Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`, `archived_delete`
58
58
  def query_action
59
59
  @attributes[:query_action]
60
60
  end
@@ -274,7 +274,7 @@ module Files
274
274
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
275
275
  # start_at - string - Start date/time of export range.
276
276
  # end_at - string - End date/time of export range.
277
- # query_action - string - Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
277
+ # query_action - string - Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`, `archived_delete`
278
278
  # query_interface - string - Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
279
279
  # query_user_id - string - Return results that are actions performed by the user indicated by this User ID
280
280
  # query_file_id - string - Return results that are file actions related to the file indicated by this File ID
@@ -74,7 +74,7 @@ module Files
74
74
  @attributes[:user_is_from_parent_site]
75
75
  end
76
76
 
77
- # string - What action was taken. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
77
+ # string - What action was taken. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`, `archived_delete`
78
78
  def action
79
79
  @attributes[:action]
80
80
  end
@@ -45,6 +45,15 @@ module Files
45
45
  @attributes[:health_check_enabled] = value
46
46
  end
47
47
 
48
+ # array(object) - Array of recent health check results.
49
+ def health_check_results
50
+ @attributes[:health_check_results]
51
+ end
52
+
53
+ def health_check_results=(value)
54
+ @attributes[:health_check_results] = value
55
+ end
56
+
48
57
  # string - Type of health check to perform.
49
58
  def health_check_type
50
59
  @attributes[:health_check_type]
@@ -504,6 +504,11 @@ module Files
504
504
  @attributes[:max_prior_passwords]
505
505
  end
506
506
 
507
+ # object - List of site settings managed by the parent site
508
+ def managed_site_settings
509
+ @attributes[:managed_site_settings]
510
+ end
511
+
507
512
  # string - A message to show users when they connect via FTP or SFTP.
508
513
  def motd_text
509
514
  @attributes[:motd_text]
@@ -864,11 +869,6 @@ module Files
864
869
  @attributes[:group_admins_can_set_user_password]
865
870
  end
866
871
 
867
- # array(string) - List of site settings managed by the parent site
868
- def managed_site_settings
869
- @attributes[:managed_site_settings]
870
- end
871
-
872
872
  def self.get(params = {}, options = {})
873
873
  response, options = Api.send_request("/site", :get, params, options)
874
874
  Site.new(response.data, options)
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Files
4
- VERSION = "1.1.326"
4
+ VERSION = "1.1.328"
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.326
4
+ version: 1.1.328
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-09-17 00:00:00.000000000 Z
11
+ date: 2025-09-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable