files.com 1.2.135 → 1.2.137
Sign up to get free protection for your applications and to get access to all the features.
- package/_VERSION +1 -1
- package/docs/models/Automation.md +6 -2
- package/docs/models/EmailLog.md +1 -1
- package/docs/models/File.md +1 -1
- package/docs/models/GroupUser.md +3 -7
- package/docs/models/HistoryExport.md +6 -6
- package/docs/models/HistoryExportResult.md +1 -1
- package/docs/models/Notification.md +3 -3
- package/docs/models/Permission.md +5 -5
- package/docs/models/SftpHostKey.md +2 -2
- package/lib/Files.js +1 -1
- package/lib/models/Automation.js +49 -35
- package/lib/models/EmailLog.js +1 -1
- package/lib/models/File.js +1 -1
- package/lib/models/GroupUser.js +1 -1
- package/lib/models/HistoryExport.js +6 -6
- package/lib/models/HistoryExportResult.js +1 -1
- package/lib/models/Notification.js +3 -3
- package/lib/models/Permission.js +19 -13
- package/lib/models/SftpHostKey.js +2 -2
- package/package.json +1 -1
- package/src/Files.js +1 -1
- package/src/models/Automation.js +10 -0
- package/src/models/EmailLog.js +1 -1
- package/src/models/File.js +1 -1
- package/src/models/GroupUser.js +1 -1
- package/src/models/HistoryExport.js +6 -6
- package/src/models/HistoryExportResult.js +1 -1
- package/src/models/Notification.js +3 -3
- package/src/models/Permission.js +8 -4
- package/src/models/SftpHostKey.js +2 -2
package/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.2.
|
1
|
+
1.2.137
|
@@ -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,
|
@@ -155,6 +155,7 @@ await Automation.create({
|
|
155
155
|
'always_overwrite_size_matching_files': true,
|
156
156
|
'description': "example",
|
157
157
|
'disabled': true,
|
158
|
+
'exclude_pattern': "path/to/exclude/*",
|
158
159
|
'flatten_destination_structure': true,
|
159
160
|
'ignore_locked_folders': true,
|
160
161
|
'legacy_folder_matching': true,
|
@@ -187,6 +188,7 @@ await 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.
|
@@ -237,6 +239,7 @@ await automation.update({
|
|
237
239
|
'always_overwrite_size_matching_files': true,
|
238
240
|
'description': "example",
|
239
241
|
'disabled': true,
|
242
|
+
'exclude_pattern': "path/to/exclude/*",
|
240
243
|
'flatten_destination_structure': true,
|
241
244
|
'ignore_locked_folders': true,
|
242
245
|
'legacy_folder_matching': true,
|
@@ -269,6 +272,7 @@ await automation.update({
|
|
269
272
|
* `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.
|
270
273
|
* `description` (string): Description for the this Automation.
|
271
274
|
* `disabled` (boolean): If true, this automation will not run.
|
275
|
+
* `exclude_pattern` (string): If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts.
|
272
276
|
* `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.
|
273
277
|
* `ignore_locked_folders` (boolean): If true, the Lock Folders behavior will be disregarded for automated actions.
|
274
278
|
* `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.
|
@@ -296,7 +300,7 @@ await automation.update({
|
|
296
300
|
"destination"
|
297
301
|
],
|
298
302
|
"disabled": true,
|
299
|
-
"exclude_pattern": "
|
303
|
+
"exclude_pattern": "path/to/exclude/*",
|
300
304
|
"flatten_destination_structure": true,
|
301
305
|
"group_ids": [
|
302
306
|
1,
|
package/docs/models/EmailLog.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
|
|
package/docs/models/File.md
CHANGED
@@ -298,7 +298,7 @@ await file.delete({
|
|
298
298
|
### Parameters
|
299
299
|
|
300
300
|
* `path` (string): Required - Path to operate on.
|
301
|
-
* `recursive` (boolean): If true, will recursively delete
|
301
|
+
* `recursive` (boolean): If true, will recursively delete folders. Otherwise, will error on non-empty folders.
|
302
302
|
|
303
303
|
|
304
304
|
---
|
package/docs/models/GroupUser.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
|
---
|
@@ -88,9 +86,7 @@ await group_user.update({
|
|
88
86
|
"group_id": 1,
|
89
87
|
"user_id": 1,
|
90
88
|
"admin": true,
|
91
|
-
"usernames":
|
92
|
-
"user"
|
93
|
-
]
|
89
|
+
"usernames": "user"
|
94
90
|
}
|
95
91
|
```
|
96
92
|
|
@@ -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 @@ await 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 @@ await 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
|
@@ -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 @@ await 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
|
@@ -179,7 +179,7 @@ await notification.update({
|
|
179
179
|
* `message` (string): Custom message to include in notification emails
|
180
180
|
* `triggering_filenames` (array(string)): Array of filenames (possibly with wildcards) to scope trigger
|
181
181
|
* `triggering_group_ids` (array(int64)): If set, will only notify on actions made by a member of one of the specified groups
|
182
|
-
* `triggering_user_ids` (array(int64)): If set, will
|
182
|
+
* `triggering_user_ids` (array(int64)): If set, will only notify on actions made one of the specified users
|
183
183
|
* `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
|
184
184
|
|
185
185
|
### Example Response
|
@@ -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",
|
@@ -56,21 +56,21 @@ await Permission.list({
|
|
56
56
|
|
57
57
|
```
|
58
58
|
await Permission.create({
|
59
|
+
'path': "path",
|
59
60
|
'group_id': 1,
|
60
|
-
'path': "example",
|
61
61
|
'permission': "full",
|
62
62
|
'recursive': true,
|
63
63
|
'user_id': 1,
|
64
|
-
'username': "
|
64
|
+
'username': "user",
|
65
65
|
})
|
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`
|
@@ -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
|
---
|
package/lib/Files.js
CHANGED
@@ -11,7 +11,7 @@ var endpointPrefix = '/api/rest/v1';
|
|
11
11
|
var apiKey;
|
12
12
|
var baseUrl = 'https://app.files.com';
|
13
13
|
var sessionId = null;
|
14
|
-
var version = '1.2.
|
14
|
+
var version = '1.2.137';
|
15
15
|
var userAgent = "Files.com JavaScript SDK v".concat(version);
|
16
16
|
var logLevel = _Logger.LogLevel.INFO;
|
17
17
|
var debugRequest = false;
|
package/lib/models/Automation.js
CHANGED
@@ -336,6 +336,7 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
|
|
336
336
|
// 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.
|
337
337
|
// description - string - Description for the this Automation.
|
338
338
|
// disabled - boolean - If true, this automation will not run.
|
339
|
+
// exclude_pattern - string - If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts.
|
339
340
|
// 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.
|
340
341
|
// ignore_locked_folders - boolean - If true, the Lock Folders behavior will be disregarded for automated actions.
|
341
342
|
// 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.
|
@@ -452,62 +453,68 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
|
|
452
453
|
}
|
453
454
|
throw new errors.InvalidParameterError("Bad parameter: description must be of type String, received ".concat((0, _utils.getType)(params.description)));
|
454
455
|
case 34:
|
455
|
-
if (!(params.
|
456
|
+
if (!(params.exclude_pattern && !(0, _utils.isString)(params.exclude_pattern))) {
|
456
457
|
_context2.next = 36;
|
457
458
|
break;
|
458
459
|
}
|
459
|
-
throw new errors.InvalidParameterError("Bad parameter:
|
460
|
+
throw new errors.InvalidParameterError("Bad parameter: exclude_pattern must be of type String, received ".concat((0, _utils.getType)(params.exclude_pattern)));
|
460
461
|
case 36:
|
461
|
-
if (!(params.
|
462
|
+
if (!(params.name && !(0, _utils.isString)(params.name))) {
|
462
463
|
_context2.next = 38;
|
463
464
|
break;
|
464
465
|
}
|
465
|
-
throw new errors.InvalidParameterError("Bad parameter:
|
466
|
+
throw new errors.InvalidParameterError("Bad parameter: name must be of type String, received ".concat((0, _utils.getType)(params.name)));
|
466
467
|
case 38:
|
467
|
-
if (!(params.
|
468
|
+
if (!(params.path_time_zone && !(0, _utils.isString)(params.path_time_zone))) {
|
468
469
|
_context2.next = 40;
|
469
470
|
break;
|
470
471
|
}
|
471
|
-
throw new errors.InvalidParameterError("Bad parameter:
|
472
|
+
throw new errors.InvalidParameterError("Bad parameter: path_time_zone must be of type String, received ".concat((0, _utils.getType)(params.path_time_zone)));
|
472
473
|
case 40:
|
473
|
-
if (!(params.
|
474
|
+
if (!(params.trigger && !(0, _utils.isString)(params.trigger))) {
|
474
475
|
_context2.next = 42;
|
475
476
|
break;
|
476
477
|
}
|
477
|
-
throw new errors.InvalidParameterError("Bad parameter:
|
478
|
+
throw new errors.InvalidParameterError("Bad parameter: trigger must be of type String, received ".concat((0, _utils.getType)(params.trigger)));
|
478
479
|
case 42:
|
479
|
-
if (!(params.
|
480
|
+
if (!(params.trigger_actions && !(0, _utils.isArray)(params.trigger_actions))) {
|
480
481
|
_context2.next = 44;
|
481
482
|
break;
|
482
483
|
}
|
483
|
-
throw new errors.InvalidParameterError("Bad parameter:
|
484
|
+
throw new errors.InvalidParameterError("Bad parameter: trigger_actions must be of type Array, received ".concat((0, _utils.getType)(params.trigger_actions)));
|
484
485
|
case 44:
|
485
|
-
if (!(params.
|
486
|
+
if (!(params.recurring_day && !(0, _utils.isInt)(params.recurring_day))) {
|
486
487
|
_context2.next = 46;
|
487
488
|
break;
|
488
489
|
}
|
489
|
-
throw new errors.InvalidParameterError("Bad parameter:
|
490
|
+
throw new errors.InvalidParameterError("Bad parameter: recurring_day must be of type Int, received ".concat((0, _utils.getType)(params.recurring_day)));
|
490
491
|
case 46:
|
492
|
+
if (!(params.automation && !(0, _utils.isString)(params.automation))) {
|
493
|
+
_context2.next = 48;
|
494
|
+
break;
|
495
|
+
}
|
496
|
+
throw new errors.InvalidParameterError("Bad parameter: automation must be of type String, received ".concat((0, _utils.getType)(params.automation)));
|
497
|
+
case 48:
|
491
498
|
if (params.id) {
|
492
|
-
_context2.next =
|
499
|
+
_context2.next = 54;
|
493
500
|
break;
|
494
501
|
}
|
495
502
|
if (!_this.attributes.id) {
|
496
|
-
_context2.next =
|
503
|
+
_context2.next = 53;
|
497
504
|
break;
|
498
505
|
}
|
499
506
|
params.id = _this.id;
|
500
|
-
_context2.next =
|
507
|
+
_context2.next = 54;
|
501
508
|
break;
|
502
|
-
case
|
509
|
+
case 53:
|
503
510
|
throw new errors.MissingParameterError('Parameter missing: id');
|
504
|
-
case 52:
|
505
|
-
_context2.next = 54;
|
506
|
-
return _Api.default.sendRequest("/automations/".concat(encodeURIComponent(params.id)), 'PATCH', params, _this.options);
|
507
511
|
case 54:
|
512
|
+
_context2.next = 56;
|
513
|
+
return _Api.default.sendRequest("/automations/".concat(encodeURIComponent(params.id)), 'PATCH', params, _this.options);
|
514
|
+
case 56:
|
508
515
|
response = _context2.sent;
|
509
516
|
return _context2.abrupt("return", new Automation(response === null || response === void 0 ? void 0 : response.data, _this.options));
|
510
|
-
case
|
517
|
+
case 58:
|
511
518
|
case "end":
|
512
519
|
return _context2.stop();
|
513
520
|
}
|
@@ -726,6 +733,7 @@ _Automation = Automation;
|
|
726
733
|
// 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.
|
727
734
|
// description - string - Description for the this Automation.
|
728
735
|
// disabled - boolean - If true, this automation will not run.
|
736
|
+
// exclude_pattern - string - If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts.
|
729
737
|
// 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.
|
730
738
|
// ignore_locked_folders - boolean - If true, the Lock Folders behavior will be disregarded for automated actions.
|
731
739
|
// 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.
|
@@ -831,48 +839,54 @@ _Automation = Automation;
|
|
831
839
|
}
|
832
840
|
throw new errors.InvalidParameterError("Bad parameter: description must be of type String, received ".concat((0, _utils.getType)(params.description)));
|
833
841
|
case 30:
|
834
|
-
if (!(params.
|
842
|
+
if (!(params.exclude_pattern && !(0, _utils.isString)(params.exclude_pattern))) {
|
835
843
|
_context7.next = 32;
|
836
844
|
break;
|
837
845
|
}
|
838
|
-
throw new errors.InvalidParameterError("Bad parameter:
|
846
|
+
throw new errors.InvalidParameterError("Bad parameter: exclude_pattern must be of type String, received ".concat((0, _utils.getType)(params.exclude_pattern)));
|
839
847
|
case 32:
|
840
|
-
if (!(params.
|
848
|
+
if (!(params.name && !(0, _utils.isString)(params.name))) {
|
841
849
|
_context7.next = 34;
|
842
850
|
break;
|
843
851
|
}
|
844
|
-
throw new errors.InvalidParameterError("Bad parameter:
|
852
|
+
throw new errors.InvalidParameterError("Bad parameter: name must be of type String, received ".concat((0, _utils.getType)(params.name)));
|
845
853
|
case 34:
|
846
|
-
if (!(params.
|
854
|
+
if (!(params.path_time_zone && !(0, _utils.isString)(params.path_time_zone))) {
|
847
855
|
_context7.next = 36;
|
848
856
|
break;
|
849
857
|
}
|
850
|
-
throw new errors.InvalidParameterError("Bad parameter:
|
858
|
+
throw new errors.InvalidParameterError("Bad parameter: path_time_zone must be of type String, received ".concat((0, _utils.getType)(params.path_time_zone)));
|
851
859
|
case 36:
|
852
|
-
if (!(params.
|
860
|
+
if (!(params.trigger && !(0, _utils.isString)(params.trigger))) {
|
853
861
|
_context7.next = 38;
|
854
862
|
break;
|
855
863
|
}
|
856
|
-
throw new errors.InvalidParameterError("Bad parameter:
|
864
|
+
throw new errors.InvalidParameterError("Bad parameter: trigger must be of type String, received ".concat((0, _utils.getType)(params.trigger)));
|
857
865
|
case 38:
|
858
|
-
if (!(params.
|
866
|
+
if (!(params.trigger_actions && !(0, _utils.isArray)(params.trigger_actions))) {
|
859
867
|
_context7.next = 40;
|
860
868
|
break;
|
861
869
|
}
|
862
|
-
throw new errors.InvalidParameterError("Bad parameter:
|
870
|
+
throw new errors.InvalidParameterError("Bad parameter: trigger_actions must be of type Array, received ".concat((0, _utils.getType)(params.trigger_actions)));
|
863
871
|
case 40:
|
864
|
-
if (!(params.
|
872
|
+
if (!(params.recurring_day && !(0, _utils.isInt)(params.recurring_day))) {
|
865
873
|
_context7.next = 42;
|
866
874
|
break;
|
867
875
|
}
|
868
|
-
throw new errors.InvalidParameterError("Bad parameter:
|
876
|
+
throw new errors.InvalidParameterError("Bad parameter: recurring_day must be of type Int, received ".concat((0, _utils.getType)(params.recurring_day)));
|
869
877
|
case 42:
|
870
|
-
|
871
|
-
|
878
|
+
if (!(params.automation && !(0, _utils.isString)(params.automation))) {
|
879
|
+
_context7.next = 44;
|
880
|
+
break;
|
881
|
+
}
|
882
|
+
throw new errors.InvalidParameterError("Bad parameter: automation must be of type String, received ".concat((0, _utils.getType)(params.automation)));
|
872
883
|
case 44:
|
884
|
+
_context7.next = 46;
|
885
|
+
return _Api.default.sendRequest('/automations', 'POST', params, options);
|
886
|
+
case 46:
|
873
887
|
response = _context7.sent;
|
874
888
|
return _context7.abrupt("return", new _Automation(response === null || response === void 0 ? void 0 : response.data, options));
|
875
|
-
case
|
889
|
+
case 48:
|
876
890
|
case "end":
|
877
891
|
return _context7.stop();
|
878
892
|
}
|
package/lib/models/EmailLog.js
CHANGED
@@ -57,7 +57,7 @@ var EmailLog = /*#__PURE__*/(0, _createClass2.default)(function EmailLog() {
|
|
57
57
|
(0, _defineProperty2.default)(this, "getCc", function () {
|
58
58
|
return _this.attributes.cc;
|
59
59
|
});
|
60
|
-
// string # How was email
|
60
|
+
// string # How was the email delivered? `customer_smtp` or `files.com`
|
61
61
|
(0, _defineProperty2.default)(this, "getDeliveryMethod", function () {
|
62
62
|
return _this.attributes.delivery_method;
|
63
63
|
});
|
package/lib/models/File.js
CHANGED
@@ -596,7 +596,7 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
|
|
596
596
|
}, _callee7);
|
597
597
|
})));
|
598
598
|
// Parameters:
|
599
|
-
// recursive - boolean - If true, will recursively delete
|
599
|
+
// recursive - boolean - If true, will recursively delete folders. Otherwise, will error on non-empty folders.
|
600
600
|
(0, _defineProperty2.default)(this, "delete", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee8() {
|
601
601
|
var params,
|
602
602
|
_args8 = arguments;
|
package/lib/models/GroupUser.js
CHANGED
@@ -61,7 +61,7 @@ var GroupUser = /*#__PURE__*/(0, _createClass2.default)(function GroupUser() {
|
|
61
61
|
(0, _defineProperty2.default)(this, "setAdmin", function (value) {
|
62
62
|
_this.attributes.admin = value;
|
63
63
|
});
|
64
|
-
//
|
64
|
+
// string # Comma-delimited list of usernames who belong to this group (separated by commas).
|
65
65
|
(0, _defineProperty2.default)(this, "getUsernames", function () {
|
66
66
|
return _this.attributes.usernames;
|
67
67
|
});
|
@@ -82,7 +82,7 @@ var HistoryExport = /*#__PURE__*/(0, _createClass2.default)(function HistoryExpo
|
|
82
82
|
(0, _defineProperty2.default)(this, "setQueryInterface", function (value) {
|
83
83
|
_this.attributes.query_interface = value;
|
84
84
|
});
|
85
|
-
// string # Return results that are actions performed by the user
|
85
|
+
// string # Return results that are actions performed by the user indicated by this User ID
|
86
86
|
(0, _defineProperty2.default)(this, "getQueryUserId", function () {
|
87
87
|
return _this.attributes.query_user_id;
|
88
88
|
});
|
@@ -152,7 +152,7 @@ var HistoryExport = /*#__PURE__*/(0, _createClass2.default)(function HistoryExpo
|
|
152
152
|
(0, _defineProperty2.default)(this, "setQueryFailureType", function (value) {
|
153
153
|
_this.attributes.query_failure_type = value;
|
154
154
|
});
|
155
|
-
// string # If searching for Histories about specific objects (such as Users, or API Keys), this
|
155
|
+
// string # If searching for Histories about specific objects (such as Users, or API Keys), this parameter restricts results to objects that match this ID.
|
156
156
|
(0, _defineProperty2.default)(this, "getQueryTargetId", function () {
|
157
157
|
return _this.attributes.query_target_id;
|
158
158
|
});
|
@@ -166,7 +166,7 @@ var HistoryExport = /*#__PURE__*/(0, _createClass2.default)(function HistoryExpo
|
|
166
166
|
(0, _defineProperty2.default)(this, "setQueryTargetName", function (value) {
|
167
167
|
_this.attributes.query_target_name = value;
|
168
168
|
});
|
169
|
-
// string # If searching for Histories about
|
169
|
+
// string # If searching for Histories about Permissions, this parameter restricts results to permissions of this level.
|
170
170
|
(0, _defineProperty2.default)(this, "getQueryTargetPermission", function () {
|
171
171
|
return _this.attributes.query_target_permission;
|
172
172
|
});
|
@@ -310,7 +310,7 @@ _HistoryExport = HistoryExport;
|
|
310
310
|
// end_at - string - End date/time of export range.
|
311
311
|
// 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`
|
312
312
|
// 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`
|
313
|
-
// query_user_id - string - Return results that are actions performed by the user
|
313
|
+
// query_user_id - string - Return results that are actions performed by the user indicated by this User ID
|
314
314
|
// query_file_id - string - Return results that are file actions related to the file indicated by this File ID
|
315
315
|
// query_parent_id - string - Return results that are file actions inside the parent folder specified by this folder ID
|
316
316
|
// query_path - string - Return results that are file actions related to paths matching this pattern.
|
@@ -320,9 +320,9 @@ _HistoryExport = HistoryExport;
|
|
320
320
|
// query_ip - string - Filter results by this IP address.
|
321
321
|
// query_username - string - Filter results by this username.
|
322
322
|
// 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`
|
323
|
-
// query_target_id - string - If searching for Histories about specific objects (such as Users, or API Keys), this
|
323
|
+
// 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.
|
324
324
|
// 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.
|
325
|
-
// query_target_permission - string - If searching for Histories about
|
325
|
+
// query_target_permission - string - If searching for Histories about Permissions, this parameter restricts results to permissions of this level.
|
326
326
|
// 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.
|
327
327
|
// query_target_username - string - If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
|
328
328
|
// query_target_platform - string - If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
|
@@ -93,7 +93,7 @@ var HistoryExportResult = /*#__PURE__*/(0, _createClass2.default)(function Histo
|
|
93
93
|
(0, _defineProperty2.default)(this, "getFailureType", function () {
|
94
94
|
return _this.attributes.failure_type;
|
95
95
|
});
|
96
|
-
// string #
|
96
|
+
// 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`
|
97
97
|
(0, _defineProperty2.default)(this, "getInterface", function () {
|
98
98
|
return _this.attributes.interface;
|
99
99
|
});
|
@@ -68,7 +68,7 @@ var Notification = /*#__PURE__*/(0, _createClass2.default)(function Notification
|
|
68
68
|
(0, _defineProperty2.default)(this, "setTriggeringGroupIds", function (value) {
|
69
69
|
_this.attributes.triggering_group_ids = value;
|
70
70
|
});
|
71
|
-
// array(int64) # If set, will
|
71
|
+
// array(int64) # If set, will only notify on actions made one of the specified users
|
72
72
|
(0, _defineProperty2.default)(this, "getTriggeringUserIds", function () {
|
73
73
|
return _this.attributes.triggering_user_ids;
|
74
74
|
});
|
@@ -199,7 +199,7 @@ var Notification = /*#__PURE__*/(0, _createClass2.default)(function Notification
|
|
199
199
|
// message - string - Custom message to include in notification emails
|
200
200
|
// triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to scope trigger
|
201
201
|
// triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups
|
202
|
-
// triggering_user_ids - array(int64) - If set, will
|
202
|
+
// triggering_user_ids - array(int64) - If set, will only notify on actions made one of the specified users
|
203
203
|
// trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
|
204
204
|
(0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee() {
|
205
205
|
var params,
|
@@ -504,7 +504,7 @@ _Notification = Notification;
|
|
504
504
|
// message - string - Custom message to include in notification emails
|
505
505
|
// triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to scope trigger
|
506
506
|
// triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups
|
507
|
-
// triggering_user_ids - array(int64) - If set, will
|
507
|
+
// triggering_user_ids - array(int64) - If set, will only notify on actions made one of the specified users
|
508
508
|
// trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
|
509
509
|
// group_id - int64 - The ID of the group to notify. Provide `user_id`, `username` or `group_id`.
|
510
510
|
// path - string - Path
|
package/lib/models/Permission.js
CHANGED
@@ -248,9 +248,9 @@ _Permission = Permission;
|
|
248
248
|
return _Permission.list(params, options);
|
249
249
|
});
|
250
250
|
// Parameters:
|
251
|
+
// path (required) - string - Folder path
|
251
252
|
// group_id - int64 - Group ID
|
252
|
-
//
|
253
|
-
// permission - string - Permission type. Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
|
253
|
+
// permission - string - Permission type. Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
|
254
254
|
// recursive - boolean - Apply to subfolders recursively?
|
255
255
|
// user_id - int64 - User ID. Provide `username` or `user_id`
|
256
256
|
// username - string - User username. Provide `username` or `user_id`
|
@@ -264,11 +264,11 @@ _Permission = Permission;
|
|
264
264
|
case 0:
|
265
265
|
params = _args4.length > 0 && _args4[0] !== undefined ? _args4[0] : {};
|
266
266
|
options = _args4.length > 1 && _args4[1] !== undefined ? _args4[1] : {};
|
267
|
-
if (
|
267
|
+
if (params.path) {
|
268
268
|
_context4.next = 4;
|
269
269
|
break;
|
270
270
|
}
|
271
|
-
throw new errors.
|
271
|
+
throw new errors.MissingParameterError('Parameter missing: path');
|
272
272
|
case 4:
|
273
273
|
if (!(params.path && !(0, _utils.isString)(params.path))) {
|
274
274
|
_context4.next = 6;
|
@@ -276,30 +276,36 @@ _Permission = Permission;
|
|
276
276
|
}
|
277
277
|
throw new errors.InvalidParameterError("Bad parameter: path must be of type String, received ".concat((0, _utils.getType)(params.path)));
|
278
278
|
case 6:
|
279
|
-
if (!(params.
|
279
|
+
if (!(params.group_id && !(0, _utils.isInt)(params.group_id))) {
|
280
280
|
_context4.next = 8;
|
281
281
|
break;
|
282
282
|
}
|
283
|
-
throw new errors.InvalidParameterError("Bad parameter:
|
283
|
+
throw new errors.InvalidParameterError("Bad parameter: group_id must be of type Int, received ".concat((0, _utils.getType)(params.group_id)));
|
284
284
|
case 8:
|
285
|
-
if (!(params.
|
285
|
+
if (!(params.permission && !(0, _utils.isString)(params.permission))) {
|
286
286
|
_context4.next = 10;
|
287
287
|
break;
|
288
288
|
}
|
289
|
-
throw new errors.InvalidParameterError("Bad parameter:
|
289
|
+
throw new errors.InvalidParameterError("Bad parameter: permission must be of type String, received ".concat((0, _utils.getType)(params.permission)));
|
290
290
|
case 10:
|
291
|
-
if (!(params.
|
291
|
+
if (!(params.user_id && !(0, _utils.isInt)(params.user_id))) {
|
292
292
|
_context4.next = 12;
|
293
293
|
break;
|
294
294
|
}
|
295
|
-
throw new errors.InvalidParameterError("Bad parameter:
|
295
|
+
throw new errors.InvalidParameterError("Bad parameter: user_id must be of type Int, received ".concat((0, _utils.getType)(params.user_id)));
|
296
296
|
case 12:
|
297
|
-
|
298
|
-
|
297
|
+
if (!(params.username && !(0, _utils.isString)(params.username))) {
|
298
|
+
_context4.next = 14;
|
299
|
+
break;
|
300
|
+
}
|
301
|
+
throw new errors.InvalidParameterError("Bad parameter: username must be of type String, received ".concat((0, _utils.getType)(params.username)));
|
299
302
|
case 14:
|
303
|
+
_context4.next = 16;
|
304
|
+
return _Api.default.sendRequest('/permissions', 'POST', params, options);
|
305
|
+
case 16:
|
300
306
|
response = _context4.sent;
|
301
307
|
return _context4.abrupt("return", new _Permission(response === null || response === void 0 ? void 0 : response.data, options));
|
302
|
-
case
|
308
|
+
case 18:
|
303
309
|
case "end":
|
304
310
|
return _context4.stop();
|
305
311
|
}
|
@@ -47,14 +47,14 @@ var SftpHostKey = /*#__PURE__*/(0, _createClass2.default)(function SftpHostKey()
|
|
47
47
|
(0, _defineProperty2.default)(this, "setName", function (value) {
|
48
48
|
_this.attributes.name = value;
|
49
49
|
});
|
50
|
-
// string # MD5
|
50
|
+
// string # MD5 Fingerprint of the public key
|
51
51
|
(0, _defineProperty2.default)(this, "getFingerprintMd5", function () {
|
52
52
|
return _this.attributes.fingerprint_md5;
|
53
53
|
});
|
54
54
|
(0, _defineProperty2.default)(this, "setFingerprintMd5", function (value) {
|
55
55
|
_this.attributes.fingerprint_md5 = value;
|
56
56
|
});
|
57
|
-
// string # SHA256
|
57
|
+
// string # SHA256 Fingerprint of the public key
|
58
58
|
(0, _defineProperty2.default)(this, "getFingerprintSha256", function () {
|
59
59
|
return _this.attributes.fingerprint_sha256;
|
60
60
|
});
|
package/package.json
CHANGED
package/src/Files.js
CHANGED
package/src/models/Automation.js
CHANGED
@@ -308,6 +308,7 @@ class Automation {
|
|
308
308
|
// 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.
|
309
309
|
// description - string - Description for the this Automation.
|
310
310
|
// disabled - boolean - If true, this automation will not run.
|
311
|
+
// exclude_pattern - string - If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts.
|
311
312
|
// 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.
|
312
313
|
// ignore_locked_folders - boolean - If true, the Lock Folders behavior will be disregarded for automated actions.
|
313
314
|
// 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.
|
@@ -385,6 +386,10 @@ class Automation {
|
|
385
386
|
throw new errors.InvalidParameterError(`Bad parameter: description must be of type String, received ${getType(params.description)}`)
|
386
387
|
}
|
387
388
|
|
389
|
+
if (params.exclude_pattern && !isString(params.exclude_pattern)) {
|
390
|
+
throw new errors.InvalidParameterError(`Bad parameter: exclude_pattern must be of type String, received ${getType(params.exclude_pattern)}`)
|
391
|
+
}
|
392
|
+
|
388
393
|
if (params.name && !isString(params.name)) {
|
389
394
|
throw new errors.InvalidParameterError(`Bad parameter: name must be of type String, received ${getType(params.name)}`)
|
390
395
|
}
|
@@ -530,6 +535,7 @@ class Automation {
|
|
530
535
|
// 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.
|
531
536
|
// description - string - Description for the this Automation.
|
532
537
|
// disabled - boolean - If true, this automation will not run.
|
538
|
+
// exclude_pattern - string - If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts.
|
533
539
|
// 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.
|
534
540
|
// ignore_locked_folders - boolean - If true, the Lock Folders behavior will be disregarded for automated actions.
|
535
541
|
// 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.
|
@@ -598,6 +604,10 @@ class Automation {
|
|
598
604
|
throw new errors.InvalidParameterError(`Bad parameter: description must be of type String, received ${getType(params.description)}`)
|
599
605
|
}
|
600
606
|
|
607
|
+
if (params.exclude_pattern && !isString(params.exclude_pattern)) {
|
608
|
+
throw new errors.InvalidParameterError(`Bad parameter: exclude_pattern must be of type String, received ${getType(params.exclude_pattern)}`)
|
609
|
+
}
|
610
|
+
|
601
611
|
if (params.name && !isString(params.name)) {
|
602
612
|
throw new errors.InvalidParameterError(`Bad parameter: name must be of type String, received ${getType(params.name)}`)
|
603
613
|
}
|
package/src/models/EmailLog.js
CHANGED
@@ -46,7 +46,7 @@ class EmailLog {
|
|
46
46
|
// string # CC field of E-Mail
|
47
47
|
getCc = () => this.attributes.cc
|
48
48
|
|
49
|
-
// string # How was email
|
49
|
+
// string # How was the email delivered? `customer_smtp` or `files.com`
|
50
50
|
getDeliveryMethod = () => this.attributes.delivery_method
|
51
51
|
|
52
52
|
// string # Customer SMTP Hostname used.
|
package/src/models/File.js
CHANGED
@@ -681,7 +681,7 @@ class File {
|
|
681
681
|
}
|
682
682
|
|
683
683
|
// Parameters:
|
684
|
-
// recursive - boolean - If true, will recursively delete
|
684
|
+
// recursive - boolean - If true, will recursively delete folders. Otherwise, will error on non-empty folders.
|
685
685
|
delete = async (params = {}) => {
|
686
686
|
if (!this.attributes.path) {
|
687
687
|
throw new errors.EmptyPropertyError('Current object has no path')
|
package/src/models/GroupUser.js
CHANGED
@@ -56,7 +56,7 @@ class GroupUser {
|
|
56
56
|
this.attributes.admin = value
|
57
57
|
}
|
58
58
|
|
59
|
-
//
|
59
|
+
// string # Comma-delimited list of usernames who belong to this group (separated by commas).
|
60
60
|
getUsernames = () => this.attributes.usernames
|
61
61
|
|
62
62
|
setUsernames = value => {
|
@@ -77,7 +77,7 @@ class HistoryExport {
|
|
77
77
|
this.attributes.query_interface = value
|
78
78
|
}
|
79
79
|
|
80
|
-
// string # Return results that are actions performed by the user
|
80
|
+
// string # Return results that are actions performed by the user indicated by this User ID
|
81
81
|
getQueryUserId = () => this.attributes.query_user_id
|
82
82
|
|
83
83
|
setQueryUserId = value => {
|
@@ -147,7 +147,7 @@ class HistoryExport {
|
|
147
147
|
this.attributes.query_failure_type = value
|
148
148
|
}
|
149
149
|
|
150
|
-
// string # If searching for Histories about specific objects (such as Users, or API Keys), this
|
150
|
+
// string # If searching for Histories about specific objects (such as Users, or API Keys), this parameter restricts results to objects that match this ID.
|
151
151
|
getQueryTargetId = () => this.attributes.query_target_id
|
152
152
|
|
153
153
|
setQueryTargetId = value => {
|
@@ -161,7 +161,7 @@ class HistoryExport {
|
|
161
161
|
this.attributes.query_target_name = value
|
162
162
|
}
|
163
163
|
|
164
|
-
// string # If searching for Histories about
|
164
|
+
// string # If searching for Histories about Permissions, this parameter restricts results to permissions of this level.
|
165
165
|
getQueryTargetPermission = () => this.attributes.query_target_permission
|
166
166
|
|
167
167
|
setQueryTargetPermission = value => {
|
@@ -251,7 +251,7 @@ class HistoryExport {
|
|
251
251
|
// end_at - string - End date/time of export range.
|
252
252
|
// 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`
|
253
253
|
// 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`
|
254
|
-
// query_user_id - string - Return results that are actions performed by the user
|
254
|
+
// query_user_id - string - Return results that are actions performed by the user indicated by this User ID
|
255
255
|
// query_file_id - string - Return results that are file actions related to the file indicated by this File ID
|
256
256
|
// query_parent_id - string - Return results that are file actions inside the parent folder specified by this folder ID
|
257
257
|
// query_path - string - Return results that are file actions related to paths matching this pattern.
|
@@ -261,9 +261,9 @@ class HistoryExport {
|
|
261
261
|
// query_ip - string - Filter results by this IP address.
|
262
262
|
// query_username - string - Filter results by this username.
|
263
263
|
// 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`
|
264
|
-
// query_target_id - string - If searching for Histories about specific objects (such as Users, or API Keys), this
|
264
|
+
// 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.
|
265
265
|
// 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.
|
266
|
-
// query_target_permission - string - If searching for Histories about
|
266
|
+
// query_target_permission - string - If searching for Histories about Permissions, this parameter restricts results to permissions of this level.
|
267
267
|
// 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.
|
268
268
|
// query_target_username - string - If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
|
269
269
|
// query_target_platform - string - If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
|
@@ -73,7 +73,7 @@ class HistoryExportResult {
|
|
73
73
|
// 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`
|
74
74
|
getFailureType = () => this.attributes.failure_type
|
75
75
|
|
76
|
-
// string #
|
76
|
+
// 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`
|
77
77
|
getInterface = () => this.attributes.interface
|
78
78
|
|
79
79
|
// int64 # ID of the object (such as Users, or API Keys) on which the action was taken
|
@@ -63,7 +63,7 @@ class Notification {
|
|
63
63
|
this.attributes.triggering_group_ids = value
|
64
64
|
}
|
65
65
|
|
66
|
-
// array(int64) # If set, will
|
66
|
+
// array(int64) # If set, will only notify on actions made one of the specified users
|
67
67
|
getTriggeringUserIds = () => this.attributes.triggering_user_ids
|
68
68
|
|
69
69
|
setTriggeringUserIds = value => {
|
@@ -194,7 +194,7 @@ class Notification {
|
|
194
194
|
// message - string - Custom message to include in notification emails
|
195
195
|
// triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to scope trigger
|
196
196
|
// triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups
|
197
|
-
// triggering_user_ids - array(int64) - If set, will
|
197
|
+
// triggering_user_ids - array(int64) - If set, will only notify on actions made one of the specified users
|
198
198
|
// trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
|
199
199
|
update = async (params = {}) => {
|
200
200
|
if (!this.attributes.id) {
|
@@ -355,7 +355,7 @@ class Notification {
|
|
355
355
|
// message - string - Custom message to include in notification emails
|
356
356
|
// triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to scope trigger
|
357
357
|
// triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups
|
358
|
-
// triggering_user_ids - array(int64) - If set, will
|
358
|
+
// triggering_user_ids - array(int64) - If set, will only notify on actions made one of the specified users
|
359
359
|
// trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
|
360
360
|
// group_id - int64 - The ID of the group to notify. Provide `user_id`, `username` or `group_id`.
|
361
361
|
// path - string - Path
|
package/src/models/Permission.js
CHANGED
@@ -162,21 +162,25 @@ class Permission {
|
|
162
162
|
Permission.list(params, options)
|
163
163
|
|
164
164
|
// Parameters:
|
165
|
+
// path (required) - string - Folder path
|
165
166
|
// group_id - int64 - Group ID
|
166
|
-
//
|
167
|
-
// permission - string - Permission type. Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
|
167
|
+
// permission - string - Permission type. Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
|
168
168
|
// recursive - boolean - Apply to subfolders recursively?
|
169
169
|
// user_id - int64 - User ID. Provide `username` or `user_id`
|
170
170
|
// username - string - User username. Provide `username` or `user_id`
|
171
171
|
static create = async (params = {}, options = {}) => {
|
172
|
-
if (
|
173
|
-
throw new errors.
|
172
|
+
if (!params.path) {
|
173
|
+
throw new errors.MissingParameterError('Parameter missing: path')
|
174
174
|
}
|
175
175
|
|
176
176
|
if (params.path && !isString(params.path)) {
|
177
177
|
throw new errors.InvalidParameterError(`Bad parameter: path must be of type String, received ${getType(params.path)}`)
|
178
178
|
}
|
179
179
|
|
180
|
+
if (params.group_id && !isInt(params.group_id)) {
|
181
|
+
throw new errors.InvalidParameterError(`Bad parameter: group_id must be of type Int, received ${getType(params.group_id)}`)
|
182
|
+
}
|
183
|
+
|
180
184
|
if (params.permission && !isString(params.permission)) {
|
181
185
|
throw new errors.InvalidParameterError(`Bad parameter: permission must be of type String, received ${getType(params.permission)}`)
|
182
186
|
}
|
@@ -42,14 +42,14 @@ class SftpHostKey {
|
|
42
42
|
this.attributes.name = value
|
43
43
|
}
|
44
44
|
|
45
|
-
// string # MD5
|
45
|
+
// string # MD5 Fingerprint of the public key
|
46
46
|
getFingerprintMd5 = () => this.attributes.fingerprint_md5
|
47
47
|
|
48
48
|
setFingerprintMd5 = value => {
|
49
49
|
this.attributes.fingerprint_md5 = value
|
50
50
|
}
|
51
51
|
|
52
|
-
// string # SHA256
|
52
|
+
// string # SHA256 Fingerprint of the public key
|
53
53
|
getFingerprintSha256 = () => this.attributes.fingerprint_sha256
|
54
54
|
|
55
55
|
setFingerprintSha256 = value => {
|