files.com 1.1.144 → 1.1.146
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 +4 -4
- data/_VERSION +1 -1
- data/docs/automation.md +7 -1
- data/docs/email_log.md +1 -1
- data/docs/file.md +2 -2
- data/docs/group_user.md +2 -4
- data/docs/history_export.md +6 -6
- data/docs/history_export_result.md +1 -1
- data/docs/notification.md +4 -4
- data/docs/permission.md +5 -5
- data/docs/sftp_host_key.md +2 -2
- data/lib/files.com/models/automation.rb +6 -0
- data/lib/files.com/models/email_log.rb +1 -1
- data/lib/files.com/models/file.rb +2 -2
- data/lib/files.com/models/group_user.rb +1 -1
- data/lib/files.com/models/history_export.rb +6 -6
- data/lib/files.com/models/history_export_result.rb +1 -1
- data/lib/files.com/models/notification.rb +4 -4
- data/lib/files.com/models/permission.rb +4 -3
- data/lib/files.com/models/sftp_host_key.rb +2 -2
- data/lib/files.com/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d9962a456febacc4404f95b369aee63c7a4dee7a2f832b092413b99665dc7428
|
4
|
+
data.tar.gz: f49b782f9f1c1448a2749514d77960d5d78064f7ada3bb75268b3553fdc4ad7b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 13d6fd66729774563e14559167c24e3250cdc86bb5e7d8742c6d1f8d3385790e4695acd587db035e4c2fb8bb6b0ad8a77ed0d1b9650baa5376d9df81aa6ef321
|
7
|
+
data.tar.gz: 878ffd35cd027836d9de453e684d9dbb1ee494e53aa06d5357d686ccf1e1864e0cdce320dc205118029af52ece1e05cab09eb27e3c5785a250e127766b4a5649
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.1.
|
1
|
+
1.1.146
|
data/docs/automation.md
CHANGED
@@ -15,7 +15,7 @@
|
|
15
15
|
"destination"
|
16
16
|
],
|
17
17
|
"disabled": true,
|
18
|
-
"exclude_pattern": "
|
18
|
+
"exclude_pattern": "path/to/exclude/*",
|
19
19
|
"flatten_destination_structure": true,
|
20
20
|
"group_ids": [
|
21
21
|
1,
|
@@ -156,6 +156,7 @@ Files::Automation.create(
|
|
156
156
|
always_overwrite_size_matching_files: true,
|
157
157
|
description: "example",
|
158
158
|
disabled: true,
|
159
|
+
exclude_pattern: "path/to/exclude/*",
|
159
160
|
flatten_destination_structure: true,
|
160
161
|
ignore_locked_folders: true,
|
161
162
|
legacy_folder_matching: true,
|
@@ -187,6 +188,7 @@ Files::Automation.create(
|
|
187
188
|
* `always_overwrite_size_matching_files` (boolean): Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer. If this flag is `true` we will overwrite the destination file always. Note that this may cause large amounts of wasted transfer usage.
|
188
189
|
* `description` (string): Description for the this Automation.
|
189
190
|
* `disabled` (boolean): If true, this automation will not run.
|
191
|
+
* `exclude_pattern` (string): If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts.
|
190
192
|
* `flatten_destination_structure` (boolean): Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination. If this flag is `true`, the source folder structure will be flattened in the destination. This is useful for copying or moving files from multiple folders into a single destination folder.
|
191
193
|
* `ignore_locked_folders` (boolean): If true, the Lock Folders behavior will be disregarded for automated actions.
|
192
194
|
* `legacy_folder_matching` (boolean): DEPRECATED: If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files. This behavior no longer works and should not be used.
|
@@ -234,6 +236,7 @@ Files::Automation.update(id,
|
|
234
236
|
always_overwrite_size_matching_files: true,
|
235
237
|
description: "example",
|
236
238
|
disabled: true,
|
239
|
+
exclude_pattern: "path/to/exclude/*",
|
237
240
|
flatten_destination_structure: true,
|
238
241
|
ignore_locked_folders: true,
|
239
242
|
legacy_folder_matching: true,
|
@@ -266,6 +269,7 @@ Files::Automation.update(id,
|
|
266
269
|
* `always_overwrite_size_matching_files` (boolean): Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer. If this flag is `true` we will overwrite the destination file always. Note that this may cause large amounts of wasted transfer usage.
|
267
270
|
* `description` (string): Description for the this Automation.
|
268
271
|
* `disabled` (boolean): If true, this automation will not run.
|
272
|
+
* `exclude_pattern` (string): If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts.
|
269
273
|
* `flatten_destination_structure` (boolean): Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination. If this flag is `true`, the source folder structure will be flattened in the destination. This is useful for copying or moving files from multiple folders into a single destination folder.
|
270
274
|
* `ignore_locked_folders` (boolean): If true, the Lock Folders behavior will be disregarded for automated actions.
|
271
275
|
* `legacy_folder_matching` (boolean): DEPRECATED: If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files. This behavior no longer works and should not be used.
|
@@ -330,6 +334,7 @@ automation.update(
|
|
330
334
|
always_overwrite_size_matching_files: true,
|
331
335
|
description: "example",
|
332
336
|
disabled: true,
|
337
|
+
exclude_pattern: "path/to/exclude/*",
|
333
338
|
flatten_destination_structure: true,
|
334
339
|
ignore_locked_folders: true,
|
335
340
|
legacy_folder_matching: true,
|
@@ -362,6 +367,7 @@ automation.update(
|
|
362
367
|
* `always_overwrite_size_matching_files` (boolean): Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer. If this flag is `true` we will overwrite the destination file always. Note that this may cause large amounts of wasted transfer usage.
|
363
368
|
* `description` (string): Description for the this Automation.
|
364
369
|
* `disabled` (boolean): If true, this automation will not run.
|
370
|
+
* `exclude_pattern` (string): If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts.
|
365
371
|
* `flatten_destination_structure` (boolean): Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination. If this flag is `true`, the source folder structure will be flattened in the destination. This is useful for copying or moving files from multiple folders into a single destination folder.
|
366
372
|
* `ignore_locked_folders` (boolean): If true, the Lock Folders behavior will be disregarded for automated actions.
|
367
373
|
* `legacy_folder_matching` (boolean): DEPRECATED: If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files. This behavior no longer works and should not be used.
|
data/docs/email_log.md
CHANGED
@@ -22,7 +22,7 @@
|
|
22
22
|
* `subject` (string): Subject line of E-Mail
|
23
23
|
* `to` (string): To field of E-Mail
|
24
24
|
* `cc` (string): CC field of E-Mail
|
25
|
-
* `delivery_method` (string): How was email
|
25
|
+
* `delivery_method` (string): How was the email delivered? `customer_smtp` or `files.com`
|
26
26
|
* `smtp_hostname` (string): Customer SMTP Hostname used.
|
27
27
|
* `smtp_ip` (string): Customer SMTP IP address as resolved for use (useful for troubleshooting DNS issues with customer SMTP).
|
28
28
|
|
data/docs/file.md
CHANGED
@@ -183,7 +183,7 @@ Files::File.delete(path,
|
|
183
183
|
### Parameters
|
184
184
|
|
185
185
|
* `path` (string): Required - Path to operate on.
|
186
|
-
* `recursive` (boolean): If true, will recursively delete
|
186
|
+
* `recursive` (boolean): If true, will recursively delete folders. Otherwise, will error on non-empty folders.
|
187
187
|
|
188
188
|
|
189
189
|
---
|
@@ -330,7 +330,7 @@ file.delete(
|
|
330
330
|
### Parameters
|
331
331
|
|
332
332
|
* `path` (string): Required - Path to operate on.
|
333
|
-
* `recursive` (boolean): If true, will recursively delete
|
333
|
+
* `recursive` (boolean): If true, will recursively delete folders. Otherwise, will error on non-empty folders.
|
334
334
|
|
335
335
|
|
336
336
|
---
|
data/docs/group_user.md
CHANGED
@@ -8,9 +8,7 @@
|
|
8
8
|
"group_id": 1,
|
9
9
|
"user_id": 1,
|
10
10
|
"admin": true,
|
11
|
-
"usernames":
|
12
|
-
"user"
|
13
|
-
]
|
11
|
+
"usernames": "user"
|
14
12
|
}
|
15
13
|
```
|
16
14
|
|
@@ -18,7 +16,7 @@
|
|
18
16
|
* `group_id` (int64): Group ID
|
19
17
|
* `user_id` (int64): User ID
|
20
18
|
* `admin` (boolean): Is this user an administrator of this group?
|
21
|
-
* `usernames` (
|
19
|
+
* `usernames` (string): Comma-delimited list of usernames who belong to this group (separated by commas).
|
22
20
|
* `id` (int64): Group User ID.
|
23
21
|
|
24
22
|
|
data/docs/history_export.md
CHANGED
@@ -39,7 +39,7 @@
|
|
39
39
|
* `status` (string): Status of export. Will be: `building`, `ready`, or `failed`
|
40
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`
|
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
|
-
* `query_user_id` (string): Return results that are actions performed by the user
|
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
|
44
44
|
* `query_parent_id` (string): Return results that are file actions inside the parent folder specified by this folder ID
|
45
45
|
* `query_path` (string): Return results that are file actions related to paths matching this pattern.
|
@@ -49,9 +49,9 @@
|
|
49
49
|
* `query_ip` (string): Filter results by this IP address.
|
50
50
|
* `query_username` (string): Filter results by this username.
|
51
51
|
* `query_failure_type` (string): If searching for Histories about login failures, this parameter restricts results to failures of this specific type. 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`
|
52
|
-
* `query_target_id` (string): If searching for Histories about specific objects (such as Users, or API Keys), this
|
52
|
+
* `query_target_id` (string): If searching for Histories about specific objects (such as Users, or API Keys), this parameter restricts results to objects that match this ID.
|
53
53
|
* `query_target_name` (string): If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
|
54
|
-
* `query_target_permission` (string): If searching for Histories about
|
54
|
+
* `query_target_permission` (string): If searching for Histories about Permissions, this parameter restricts results to permissions of this level.
|
55
55
|
* `query_target_user_id` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.
|
56
56
|
* `query_target_username` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
|
57
57
|
* `query_target_platform` (string): If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
|
@@ -111,7 +111,7 @@ Files::HistoryExport.create(
|
|
111
111
|
* `end_at` (string): End date/time of export range.
|
112
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`
|
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
|
-
* `query_user_id` (string): Return results that are actions performed by the user
|
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
|
116
116
|
* `query_parent_id` (string): Return results that are file actions inside the parent folder specified by this folder ID
|
117
117
|
* `query_path` (string): Return results that are file actions related to paths matching this pattern.
|
@@ -121,9 +121,9 @@ Files::HistoryExport.create(
|
|
121
121
|
* `query_ip` (string): Filter results by this IP address.
|
122
122
|
* `query_username` (string): Filter results by this username.
|
123
123
|
* `query_failure_type` (string): If searching for Histories about login failures, this parameter restricts results to failures of this specific type. 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`
|
124
|
-
* `query_target_id` (string): If searching for Histories about specific objects (such as Users, or API Keys), this
|
124
|
+
* `query_target_id` (string): If searching for Histories about specific objects (such as Users, or API Keys), this parameter restricts results to objects that match this ID.
|
125
125
|
* `query_target_name` (string): If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
|
126
|
-
* `query_target_permission` (string): If searching for Histories about
|
126
|
+
* `query_target_permission` (string): If searching for Histories about Permissions, this parameter restricts results to permissions of this level.
|
127
127
|
* `query_target_user_id` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.
|
128
128
|
* `query_target_username` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
|
129
129
|
* `query_target_platform` (string): If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
|
@@ -48,7 +48,7 @@
|
|
48
48
|
* `user_is_from_parent_site` (boolean): true if this change was performed by a user on a parent site.
|
49
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`
|
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
|
-
* `interface` (string):
|
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
|
53
53
|
* `target_name` (string): Name of the User, Group or other object with a name related to this action
|
54
54
|
* `target_permission` (string): Permission level of the action
|
data/docs/notification.md
CHANGED
@@ -41,7 +41,7 @@
|
|
41
41
|
* `group_id` (int64): ID of Group to receive notifications
|
42
42
|
* `group_name` (string): Group name, if a Group ID is set
|
43
43
|
* `triggering_group_ids` (array(int64)): If set, will only notify on actions made by a member of one of the specified groups
|
44
|
-
* `triggering_user_ids` (array(int64)): If set, will
|
44
|
+
* `triggering_user_ids` (array(int64)): If set, will only notify on actions made one of the specified users
|
45
45
|
* `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
|
46
46
|
* `notify_user_actions` (boolean): If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.
|
47
47
|
* `notify_on_copy` (boolean): Trigger on files copied to this path?
|
@@ -135,7 +135,7 @@ Files::Notification.create(
|
|
135
135
|
* `message` (string): Custom message to include in notification emails
|
136
136
|
* `triggering_filenames` (array(string)): Array of filenames (possibly with wildcards) to scope trigger
|
137
137
|
* `triggering_group_ids` (array(int64)): If set, will only notify on actions made by a member of one of the specified groups
|
138
|
-
* `triggering_user_ids` (array(int64)): If set, will
|
138
|
+
* `triggering_user_ids` (array(int64)): If set, will only notify on actions made one of the specified users
|
139
139
|
* `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
|
140
140
|
* `group_id` (int64): The ID of the group to notify. Provide `user_id`, `username` or `group_id`.
|
141
141
|
* `path` (string): Path
|
@@ -178,7 +178,7 @@ Files::Notification.update(id,
|
|
178
178
|
* `message` (string): Custom message to include in notification emails
|
179
179
|
* `triggering_filenames` (array(string)): Array of filenames (possibly with wildcards) to scope trigger
|
180
180
|
* `triggering_group_ids` (array(int64)): If set, will only notify on actions made by a member of one of the specified groups
|
181
|
-
* `triggering_user_ids` (array(int64)): If set, will
|
181
|
+
* `triggering_user_ids` (array(int64)): If set, will only notify on actions made one of the specified users
|
182
182
|
* `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
|
183
183
|
|
184
184
|
|
@@ -233,7 +233,7 @@ notification.update(
|
|
233
233
|
* `message` (string): Custom message to include in notification emails
|
234
234
|
* `triggering_filenames` (array(string)): Array of filenames (possibly with wildcards) to scope trigger
|
235
235
|
* `triggering_group_ids` (array(int64)): If set, will only notify on actions made by a member of one of the specified groups
|
236
|
-
* `triggering_user_ids` (array(int64)): If set, will
|
236
|
+
* `triggering_user_ids` (array(int64)): If set, will only notify on actions made one of the specified users
|
237
237
|
* `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
|
238
238
|
|
239
239
|
|
data/docs/permission.md
CHANGED
@@ -7,7 +7,7 @@
|
|
7
7
|
"id": 1,
|
8
8
|
"path": "example",
|
9
9
|
"user_id": 1,
|
10
|
-
"username": "
|
10
|
+
"username": "user",
|
11
11
|
"group_id": 1,
|
12
12
|
"group_name": "example",
|
13
13
|
"permission": "full",
|
@@ -57,20 +57,20 @@ Files::Permission.list(
|
|
57
57
|
|
58
58
|
```
|
59
59
|
Files::Permission.create(
|
60
|
+
path: "path",
|
60
61
|
group_id: 1,
|
61
|
-
path: "example",
|
62
62
|
permission: "full",
|
63
63
|
recursive: true,
|
64
64
|
user_id: 1,
|
65
|
-
username: "
|
65
|
+
username: "user"
|
66
66
|
)
|
67
67
|
```
|
68
68
|
|
69
69
|
### Parameters
|
70
70
|
|
71
|
+
* `path` (string): Required - Folder path
|
71
72
|
* `group_id` (int64): Group ID
|
72
|
-
* `
|
73
|
-
* `permission` (string): Permission type. Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
|
73
|
+
* `permission` (string): Permission type. Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
|
74
74
|
* `recursive` (boolean): Apply to subfolders recursively?
|
75
75
|
* `user_id` (int64): User ID. Provide `username` or `user_id`
|
76
76
|
* `username` (string): User username. Provide `username` or `user_id`
|
data/docs/sftp_host_key.md
CHANGED
@@ -13,8 +13,8 @@
|
|
13
13
|
|
14
14
|
* `id` (int64): SFTP Host Key ID
|
15
15
|
* `name` (string): The friendly name of this SFTP Host Key.
|
16
|
-
* `fingerprint_md5` (string): MD5
|
17
|
-
* `fingerprint_sha256` (string): SHA256
|
16
|
+
* `fingerprint_md5` (string): MD5 Fingerprint of the public key
|
17
|
+
* `fingerprint_sha256` (string): SHA256 Fingerprint of the public key
|
18
18
|
* `private_key` (string): The private key data.
|
19
19
|
|
20
20
|
|
@@ -342,6 +342,7 @@ module Files
|
|
342
342
|
# always_overwrite_size_matching_files - boolean - Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer. If this flag is `true` we will overwrite the destination file always. Note that this may cause large amounts of wasted transfer usage.
|
343
343
|
# description - string - Description for the this Automation.
|
344
344
|
# disabled - boolean - If true, this automation will not run.
|
345
|
+
# exclude_pattern - string - If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts.
|
345
346
|
# flatten_destination_structure - boolean - Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination. If this flag is `true`, the source folder structure will be flattened in the destination. This is useful for copying or moving files from multiple folders into a single destination folder.
|
346
347
|
# ignore_locked_folders - boolean - If true, the Lock Folders behavior will be disregarded for automated actions.
|
347
348
|
# legacy_folder_matching - boolean - DEPRECATED: If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files. This behavior no longer works and should not be used.
|
@@ -371,6 +372,7 @@ module Files
|
|
371
372
|
raise InvalidParameterError.new("Bad parameter: schedule_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
|
372
373
|
raise InvalidParameterError.new("Bad parameter: schedule_time_zone must be an String") if params[:schedule_time_zone] and !params[:schedule_time_zone].is_a?(String)
|
373
374
|
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
375
|
+
raise InvalidParameterError.new("Bad parameter: exclude_pattern must be an String") if params[:exclude_pattern] and !params[:exclude_pattern].is_a?(String)
|
374
376
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
375
377
|
raise InvalidParameterError.new("Bad parameter: path_time_zone must be an String") if params[:path_time_zone] and !params[:path_time_zone].is_a?(String)
|
376
378
|
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
|
@@ -469,6 +471,7 @@ module Files
|
|
469
471
|
# always_overwrite_size_matching_files - boolean - Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer. If this flag is `true` we will overwrite the destination file always. Note that this may cause large amounts of wasted transfer usage.
|
470
472
|
# description - string - Description for the this Automation.
|
471
473
|
# disabled - boolean - If true, this automation will not run.
|
474
|
+
# exclude_pattern - string - If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts.
|
472
475
|
# flatten_destination_structure - boolean - Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination. If this flag is `true`, the source folder structure will be flattened in the destination. This is useful for copying or moving files from multiple folders into a single destination folder.
|
473
476
|
# ignore_locked_folders - boolean - If true, the Lock Folders behavior will be disregarded for automated actions.
|
474
477
|
# legacy_folder_matching - boolean - DEPRECATED: If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files. This behavior no longer works and should not be used.
|
@@ -494,6 +497,7 @@ module Files
|
|
494
497
|
raise InvalidParameterError.new("Bad parameter: schedule_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
|
495
498
|
raise InvalidParameterError.new("Bad parameter: schedule_time_zone must be an String") if params[:schedule_time_zone] and !params[:schedule_time_zone].is_a?(String)
|
496
499
|
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
500
|
+
raise InvalidParameterError.new("Bad parameter: exclude_pattern must be an String") if params[:exclude_pattern] and !params[:exclude_pattern].is_a?(String)
|
497
501
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
498
502
|
raise InvalidParameterError.new("Bad parameter: path_time_zone must be an String") if params[:path_time_zone] and !params[:path_time_zone].is_a?(String)
|
499
503
|
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
|
@@ -534,6 +538,7 @@ module Files
|
|
534
538
|
# always_overwrite_size_matching_files - boolean - Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer. If this flag is `true` we will overwrite the destination file always. Note that this may cause large amounts of wasted transfer usage.
|
535
539
|
# description - string - Description for the this Automation.
|
536
540
|
# disabled - boolean - If true, this automation will not run.
|
541
|
+
# exclude_pattern - string - If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts.
|
537
542
|
# flatten_destination_structure - boolean - Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination. If this flag is `true`, the source folder structure will be flattened in the destination. This is useful for copying or moving files from multiple folders into a single destination folder.
|
538
543
|
# ignore_locked_folders - boolean - If true, the Lock Folders behavior will be disregarded for automated actions.
|
539
544
|
# legacy_folder_matching - boolean - DEPRECATED: If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files. This behavior no longer works and should not be used.
|
@@ -562,6 +567,7 @@ module Files
|
|
562
567
|
raise InvalidParameterError.new("Bad parameter: schedule_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
|
563
568
|
raise InvalidParameterError.new("Bad parameter: schedule_time_zone must be an String") if params[:schedule_time_zone] and !params[:schedule_time_zone].is_a?(String)
|
564
569
|
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
570
|
+
raise InvalidParameterError.new("Bad parameter: exclude_pattern must be an String") if params[:exclude_pattern] and !params[:exclude_pattern].is_a?(String)
|
565
571
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
566
572
|
raise InvalidParameterError.new("Bad parameter: path_time_zone must be an String") if params[:path_time_zone] and !params[:path_time_zone].is_a?(String)
|
567
573
|
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
|
@@ -976,7 +976,7 @@ module Files
|
|
976
976
|
end
|
977
977
|
|
978
978
|
# Parameters:
|
979
|
-
# recursive - boolean - If true, will recursively delete
|
979
|
+
# recursive - boolean - If true, will recursively delete folders. Otherwise, will error on non-empty folders.
|
980
980
|
def delete(params = {})
|
981
981
|
params ||= {}
|
982
982
|
params[:path] = @attributes[:path]
|
@@ -1129,7 +1129,7 @@ module Files
|
|
1129
1129
|
end
|
1130
1130
|
|
1131
1131
|
# Parameters:
|
1132
|
-
# recursive - boolean - If true, will recursively delete
|
1132
|
+
# recursive - boolean - If true, will recursively delete folders. Otherwise, will error on non-empty folders.
|
1133
1133
|
def self.delete(path, params = {}, options = {})
|
1134
1134
|
params ||= {}
|
1135
1135
|
params[:path] = path
|
@@ -45,7 +45,7 @@ module Files
|
|
45
45
|
@attributes[:admin] = value
|
46
46
|
end
|
47
47
|
|
48
|
-
#
|
48
|
+
# string - Comma-delimited list of usernames who belong to this group (separated by commas).
|
49
49
|
def usernames
|
50
50
|
@attributes[:usernames]
|
51
51
|
end
|
@@ -72,7 +72,7 @@ module Files
|
|
72
72
|
@attributes[:query_interface] = value
|
73
73
|
end
|
74
74
|
|
75
|
-
# string - Return results that are actions performed by the user
|
75
|
+
# string - Return results that are actions performed by the user indicated by this User ID
|
76
76
|
def query_user_id
|
77
77
|
@attributes[:query_user_id]
|
78
78
|
end
|
@@ -162,7 +162,7 @@ module Files
|
|
162
162
|
@attributes[:query_failure_type] = value
|
163
163
|
end
|
164
164
|
|
165
|
-
# string - If searching for Histories about specific objects (such as Users, or API Keys), this
|
165
|
+
# string - If searching for Histories about specific objects (such as Users, or API Keys), this parameter restricts results to objects that match this ID.
|
166
166
|
def query_target_id
|
167
167
|
@attributes[:query_target_id]
|
168
168
|
end
|
@@ -180,7 +180,7 @@ module Files
|
|
180
180
|
@attributes[:query_target_name] = value
|
181
181
|
end
|
182
182
|
|
183
|
-
# string - If searching for Histories about
|
183
|
+
# string - If searching for Histories about Permissions, this parameter restricts results to permissions of this level.
|
184
184
|
def query_target_permission
|
185
185
|
@attributes[:query_target_permission]
|
186
186
|
end
|
@@ -276,7 +276,7 @@ module Files
|
|
276
276
|
# end_at - string - End date/time of export range.
|
277
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`
|
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
|
-
# query_user_id - string - Return results that are actions performed by the user
|
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
|
281
281
|
# query_parent_id - string - Return results that are file actions inside the parent folder specified by this folder ID
|
282
282
|
# query_path - string - Return results that are file actions related to paths matching this pattern.
|
@@ -286,9 +286,9 @@ module Files
|
|
286
286
|
# query_ip - string - Filter results by this IP address.
|
287
287
|
# query_username - string - Filter results by this username.
|
288
288
|
# query_failure_type - string - If searching for Histories about login failures, this parameter restricts results to failures of this specific type. 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`
|
289
|
-
# query_target_id - string - If searching for Histories about specific objects (such as Users, or API Keys), this
|
289
|
+
# query_target_id - string - If searching for Histories about specific objects (such as Users, or API Keys), this parameter restricts results to objects that match this ID.
|
290
290
|
# query_target_name - string - If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
|
291
|
-
# query_target_permission - string - If searching for Histories about
|
291
|
+
# query_target_permission - string - If searching for Histories about Permissions, this parameter restricts results to permissions of this level.
|
292
292
|
# query_target_user_id - string - If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.
|
293
293
|
# query_target_username - string - If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
|
294
294
|
# query_target_platform - string - If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
|
@@ -84,7 +84,7 @@ module Files
|
|
84
84
|
@attributes[:failure_type]
|
85
85
|
end
|
86
86
|
|
87
|
-
# string -
|
87
|
+
# 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`
|
88
88
|
def interface
|
89
89
|
@attributes[:interface]
|
90
90
|
end
|
@@ -54,7 +54,7 @@ module Files
|
|
54
54
|
@attributes[:triggering_group_ids] = value
|
55
55
|
end
|
56
56
|
|
57
|
-
# array(int64) - If set, will
|
57
|
+
# array(int64) - If set, will only notify on actions made one of the specified users
|
58
58
|
def triggering_user_ids
|
59
59
|
@attributes[:triggering_user_ids]
|
60
60
|
end
|
@@ -219,7 +219,7 @@ module Files
|
|
219
219
|
# message - string - Custom message to include in notification emails
|
220
220
|
# triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to scope trigger
|
221
221
|
# triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups
|
222
|
-
# triggering_user_ids - array(int64) - If set, will
|
222
|
+
# triggering_user_ids - array(int64) - If set, will only notify on actions made one of the specified users
|
223
223
|
# trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
|
224
224
|
def update(params = {})
|
225
225
|
params ||= {}
|
@@ -318,7 +318,7 @@ module Files
|
|
318
318
|
# message - string - Custom message to include in notification emails
|
319
319
|
# triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to scope trigger
|
320
320
|
# triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups
|
321
|
-
# triggering_user_ids - array(int64) - If set, will
|
321
|
+
# triggering_user_ids - array(int64) - If set, will only notify on actions made one of the specified users
|
322
322
|
# trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
|
323
323
|
# group_id - int64 - The ID of the group to notify. Provide `user_id`, `username` or `group_id`.
|
324
324
|
# path - string - Path
|
@@ -350,7 +350,7 @@ module Files
|
|
350
350
|
# message - string - Custom message to include in notification emails
|
351
351
|
# triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to scope trigger
|
352
352
|
# triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups
|
353
|
-
# triggering_user_ids - array(int64) - If set, will
|
353
|
+
# triggering_user_ids - array(int64) - If set, will only notify on actions made one of the specified users
|
354
354
|
# trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
|
355
355
|
def self.update(id, params = {}, options = {})
|
356
356
|
params ||= {}
|
@@ -137,18 +137,19 @@ module Files
|
|
137
137
|
end
|
138
138
|
|
139
139
|
# Parameters:
|
140
|
+
# path (required) - string - Folder path
|
140
141
|
# group_id - int64 - Group ID
|
141
|
-
#
|
142
|
-
# permission - string - Permission type. Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
|
142
|
+
# permission - string - Permission type. Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
|
143
143
|
# recursive - boolean - Apply to subfolders recursively?
|
144
144
|
# user_id - int64 - User ID. Provide `username` or `user_id`
|
145
145
|
# username - string - User username. Provide `username` or `user_id`
|
146
146
|
def self.create(params = {}, options = {})
|
147
|
-
raise InvalidParameterError.new("Bad parameter: group_id must be an Integer") if params[:group_id] and !params[:group_id].is_a?(Integer)
|
148
147
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
148
|
+
raise InvalidParameterError.new("Bad parameter: group_id must be an Integer") if params[:group_id] and !params[:group_id].is_a?(Integer)
|
149
149
|
raise InvalidParameterError.new("Bad parameter: permission must be an String") if params[:permission] and !params[:permission].is_a?(String)
|
150
150
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
151
151
|
raise InvalidParameterError.new("Bad parameter: username must be an String") if params[:username] and !params[:username].is_a?(String)
|
152
|
+
raise MissingParameterError.new("Parameter missing: path") unless params[:path]
|
152
153
|
|
153
154
|
response, options = Api.send_request("/permissions", :post, params, options)
|
154
155
|
Permission.new(response.data, options)
|
@@ -27,7 +27,7 @@ module Files
|
|
27
27
|
@attributes[:name] = value
|
28
28
|
end
|
29
29
|
|
30
|
-
# string - MD5
|
30
|
+
# string - MD5 Fingerprint of the public key
|
31
31
|
def fingerprint_md5
|
32
32
|
@attributes[:fingerprint_md5]
|
33
33
|
end
|
@@ -36,7 +36,7 @@ module Files
|
|
36
36
|
@attributes[:fingerprint_md5] = value
|
37
37
|
end
|
38
38
|
|
39
|
-
# string - SHA256
|
39
|
+
# string - SHA256 Fingerprint of the public key
|
40
40
|
def fingerprint_sha256
|
41
41
|
@attributes[:fingerprint_sha256]
|
42
42
|
end
|
data/lib/files.com/version.rb
CHANGED
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.
|
4
|
+
version: 1.1.146
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- files.com
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-10-
|
11
|
+
date: 2024-10-07 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: addressable
|