files.com 1.0.226 → 1.0.228
Sign up to get free protection for your applications and to get access to all the features.
- package/_VERSION +1 -1
- package/docs/Errors.md +2 -0
- package/docs/models/FileMigration.md +1 -1
- package/docs/models/IpAddress.md +16 -0
- package/docs/models/RemoteServer.md +82 -2
- package/docs/models/RemoteServerConfigurationFile.md +29 -0
- package/docs/models/Site.md +4 -0
- package/lib/Errors.js +814 -786
- package/lib/models/IpAddress.js +40 -2
- package/lib/models/RemoteServer.js +362 -165
- package/lib/models/RemoteServerConfigurationFile.js +76 -0
- package/lib/models/Site.js +80 -71
- package/package.json +1 -1
- package/src/Errors.js +2 -0
- package/src/models/FileMigration.js +1 -1
- package/src/models/IpAddress.js +17 -0
- package/src/models/RemoteServer.js +127 -0
- package/src/models/RemoteServerConfigurationFile.js +58 -0
- package/src/models/Site.js +8 -0
package/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.0.
|
1
|
+
1.0.228
|
package/docs/Errors.md
CHANGED
@@ -47,6 +47,7 @@ Each of these error classes is used as the base class for each associated error.
|
|
47
47
|
|
48
48
|
These errors are derived from the error groups listed above.
|
49
49
|
|
50
|
+
### BadRequest_AgentUpgradeRequiredError
|
50
51
|
### BadRequest_AttachmentTooLargeError
|
51
52
|
### BadRequest_CannotDownloadDirectoryError
|
52
53
|
### BadRequest_CantMoveWithMultipleLocationsError
|
@@ -84,6 +85,7 @@ These errors are derived from the error groups listed above.
|
|
84
85
|
### BadRequest_UserRequiredError
|
85
86
|
### NotAuthenticated_AuthenticationRequiredError
|
86
87
|
### NotAuthenticated_BundleRegistrationCodeFailedError
|
88
|
+
### NotAuthenticated_FilesAgentTokenFailedError
|
87
89
|
### NotAuthenticated_InboxRegistrationCodeFailedError
|
88
90
|
### NotAuthenticated_InvalidCredentialsError
|
89
91
|
### NotAuthenticated_InvalidOauthError
|
@@ -20,7 +20,7 @@
|
|
20
20
|
* `path` (string): Source path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
21
21
|
* `dest_path` (string): Destination path
|
22
22
|
* `files_moved` (int64): Number of files processed
|
23
|
-
* `files_total` (int64):
|
23
|
+
* `files_total` (int64): Deprecated: used to return a count of the applicable files. Currently returns 0 always. On remote servers, it is not possible to reliably determine the number of affected files for every migration operation.
|
24
24
|
* `operation` (string): The type of operation
|
25
25
|
* `region` (string): Region
|
26
26
|
* `status` (string): Status
|
package/docs/models/IpAddress.md
CHANGED
@@ -29,6 +29,22 @@ await IpAddress.list({
|
|
29
29
|
```
|
30
30
|
|
31
31
|
|
32
|
+
### Parameters
|
33
|
+
|
34
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
35
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
36
|
+
|
37
|
+
---
|
38
|
+
|
39
|
+
## List all possible public ExaVault IP addresses
|
40
|
+
|
41
|
+
```
|
42
|
+
await IpAddress.getExavaultReserved({
|
43
|
+
'per_page': 1,
|
44
|
+
})
|
45
|
+
```
|
46
|
+
|
47
|
+
|
32
48
|
### Parameters
|
33
49
|
|
34
50
|
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
@@ -46,7 +46,10 @@
|
|
46
46
|
"s3_compatible_endpoint": "mys3platform.com",
|
47
47
|
"s3_compatible_region": "us-east-1",
|
48
48
|
"s3_compatible_access_key": "example",
|
49
|
-
"enable_dedicated_ips": true
|
49
|
+
"enable_dedicated_ips": true,
|
50
|
+
"files_agent_permission_set": "read_write",
|
51
|
+
"files_agent_root": "example",
|
52
|
+
"files_agent_api_token": "example"
|
50
53
|
}
|
51
54
|
```
|
52
55
|
|
@@ -93,6 +96,9 @@
|
|
93
96
|
* `s3_compatible_region` (string): S3-compatible endpoint
|
94
97
|
* `s3_compatible_access_key` (string): S3-compatible Access Key.
|
95
98
|
* `enable_dedicated_ips` (boolean): `true` if remote server only accepts connections from dedicated IPs
|
99
|
+
* `files_agent_permission_set` (string): Local permissions for files agent. read_only, write_only, or read_write
|
100
|
+
* `files_agent_root` (string): Agent local root path
|
101
|
+
* `files_agent_api_token` (string): Files Agent API Token
|
96
102
|
* `aws_secret_key` (string): AWS secret key.
|
97
103
|
* `password` (string): Password if needed.
|
98
104
|
* `private_key` (string): Private key if needed.
|
@@ -133,6 +139,19 @@ await RemoteServer.find(id)
|
|
133
139
|
```
|
134
140
|
|
135
141
|
|
142
|
+
### Parameters
|
143
|
+
|
144
|
+
* `id` (int64): Required - Remote Server ID.
|
145
|
+
|
146
|
+
---
|
147
|
+
|
148
|
+
## Download configuration file (required for some Remote Server integrations, such as the Files.com Agent)
|
149
|
+
|
150
|
+
```
|
151
|
+
await RemoteServer.findConfigurationFile(id)
|
152
|
+
```
|
153
|
+
|
154
|
+
|
136
155
|
### Parameters
|
137
156
|
|
138
157
|
* `id` (int64): Required - Remote Server ID.
|
@@ -179,6 +198,8 @@ await RemoteServer.create({
|
|
179
198
|
's3_compatible_region': "us-east-1",
|
180
199
|
'enable_dedicated_ips': true,
|
181
200
|
's3_compatible_access_key': "example",
|
201
|
+
'files_agent_root': "example",
|
202
|
+
'files_agent_permission_set': "read_write",
|
182
203
|
})
|
183
204
|
```
|
184
205
|
|
@@ -234,6 +255,58 @@ await RemoteServer.create({
|
|
234
255
|
* `enable_dedicated_ips` (boolean): `true` if remote server only accepts connections from dedicated IPs
|
235
256
|
* `s3_compatible_access_key` (string): S3-compatible Access Key.
|
236
257
|
* `s3_compatible_secret_key` (string): S3-compatible secret key
|
258
|
+
* `files_agent_root` (string): Agent local root path
|
259
|
+
* `files_agent_permission_set` (string): Local permissions for files agent. read_only, write_only, or read_write
|
260
|
+
|
261
|
+
---
|
262
|
+
|
263
|
+
## Post local changes, check in, and download configuration file (used by some Remote Server integrations, such as the Files.com Agent)
|
264
|
+
|
265
|
+
```
|
266
|
+
const [remote_server] = await RemoteServer.list()
|
267
|
+
|
268
|
+
await remote_server.configuration_file({
|
269
|
+
'api_token': "example",
|
270
|
+
'permission_set': "full",
|
271
|
+
'root': "example",
|
272
|
+
'hostname': "example",
|
273
|
+
'port': 1,
|
274
|
+
'status': "example",
|
275
|
+
'config_version': "example",
|
276
|
+
'private_key': "example",
|
277
|
+
'public_key': "example",
|
278
|
+
})
|
279
|
+
```
|
280
|
+
|
281
|
+
### Parameters
|
282
|
+
|
283
|
+
* `id` (int64): Required - Remote Server ID.
|
284
|
+
* `api_token` (string): Files Agent API Token
|
285
|
+
* `permission_set` (string):
|
286
|
+
* `root` (string): Agent local root path
|
287
|
+
* `hostname` (string):
|
288
|
+
* `port` (int64): Incoming port for files agent connections
|
289
|
+
* `status` (string): either running or shutdown
|
290
|
+
* `config_version` (string): agent config version
|
291
|
+
* `private_key` (string): private key
|
292
|
+
* `public_key` (string): public key
|
293
|
+
|
294
|
+
### Example Response
|
295
|
+
|
296
|
+
```json
|
297
|
+
{
|
298
|
+
"id": 1,
|
299
|
+
"permission_set": "full",
|
300
|
+
"api_token": "example",
|
301
|
+
"root": "example",
|
302
|
+
"port": 1,
|
303
|
+
"hostname": "example",
|
304
|
+
"public_key": "example",
|
305
|
+
"private_key": "example",
|
306
|
+
"status": "example",
|
307
|
+
"config_version": "example"
|
308
|
+
}
|
309
|
+
```
|
237
310
|
|
238
311
|
---
|
239
312
|
|
@@ -279,6 +352,8 @@ await remote_server.update({
|
|
279
352
|
's3_compatible_region': "us-east-1",
|
280
353
|
'enable_dedicated_ips': true,
|
281
354
|
's3_compatible_access_key': "example",
|
355
|
+
'files_agent_root': "example",
|
356
|
+
'files_agent_permission_set': "read_write",
|
282
357
|
})
|
283
358
|
```
|
284
359
|
|
@@ -334,6 +409,8 @@ await remote_server.update({
|
|
334
409
|
* `enable_dedicated_ips` (boolean): `true` if remote server only accepts connections from dedicated IPs
|
335
410
|
* `s3_compatible_access_key` (string): S3-compatible Access Key.
|
336
411
|
* `s3_compatible_secret_key` (string): S3-compatible secret key
|
412
|
+
* `files_agent_root` (string): Agent local root path
|
413
|
+
* `files_agent_permission_set` (string): Local permissions for files agent. read_only, write_only, or read_write
|
337
414
|
|
338
415
|
### Example Response
|
339
416
|
|
@@ -381,7 +458,10 @@ await remote_server.update({
|
|
381
458
|
"s3_compatible_endpoint": "mys3platform.com",
|
382
459
|
"s3_compatible_region": "us-east-1",
|
383
460
|
"s3_compatible_access_key": "example",
|
384
|
-
"enable_dedicated_ips": true
|
461
|
+
"enable_dedicated_ips": true,
|
462
|
+
"files_agent_permission_set": "read_write",
|
463
|
+
"files_agent_root": "example",
|
464
|
+
"files_agent_api_token": "example"
|
385
465
|
}
|
386
466
|
```
|
387
467
|
|
@@ -0,0 +1,29 @@
|
|
1
|
+
# RemoteServerConfigurationFile
|
2
|
+
|
3
|
+
## Example RemoteServerConfigurationFile Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"permission_set": "full",
|
9
|
+
"api_token": "example",
|
10
|
+
"root": "example",
|
11
|
+
"port": 1,
|
12
|
+
"hostname": "example",
|
13
|
+
"public_key": "example",
|
14
|
+
"private_key": "example",
|
15
|
+
"status": "example",
|
16
|
+
"config_version": "example"
|
17
|
+
}
|
18
|
+
```
|
19
|
+
|
20
|
+
* `id` (int64): Agent ID
|
21
|
+
* `permission_set` (string):
|
22
|
+
* `api_token` (string): Files Agent API Token
|
23
|
+
* `root` (string): Agent local root path
|
24
|
+
* `port` (int64): Incoming port for files agent connections
|
25
|
+
* `hostname` (string):
|
26
|
+
* `public_key` (string): public key
|
27
|
+
* `private_key` (string): private key
|
28
|
+
* `status` (string): either running or shutdown
|
29
|
+
* `config_version` (string): agent config version
|
package/docs/models/Site.md
CHANGED
@@ -18,6 +18,7 @@
|
|
18
18
|
"ask_about_overwrites": true,
|
19
19
|
"bundle_expiration": 1,
|
20
20
|
"bundle_password_required": true,
|
21
|
+
"bundle_registration_notifications": "never",
|
21
22
|
"bundle_require_share_recipient": true,
|
22
23
|
"bundle_watermark_attachment": "",
|
23
24
|
"bundle_watermark_value": {
|
@@ -160,6 +161,7 @@
|
|
160
161
|
* `ask_about_overwrites` (boolean): If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
|
161
162
|
* `bundle_expiration` (int64): Site-wide Bundle expiration in days
|
162
163
|
* `bundle_password_required` (boolean): Do Bundles require password protection?
|
164
|
+
* `bundle_registration_notifications` (string): Do Bundle owners receive registration notification?
|
163
165
|
* `bundle_require_share_recipient` (boolean): Do Bundles require recipients for sharing?
|
164
166
|
* `bundle_watermark_attachment` (Image): Preview watermark image applied to all bundle items.
|
165
167
|
* `bundle_watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
|
@@ -368,6 +370,7 @@ await Site.update({
|
|
368
370
|
'session_pinned_by_ip': true,
|
369
371
|
'bundle_password_required': true,
|
370
372
|
'bundle_require_share_recipient': true,
|
373
|
+
'bundle_registration_notifications': "never",
|
371
374
|
'password_requirements_apply_to_bundles': true,
|
372
375
|
'opt_out_global': true,
|
373
376
|
'use_provided_modified_at': true,
|
@@ -493,6 +496,7 @@ await Site.update({
|
|
493
496
|
* `session_pinned_by_ip` (boolean): Are sessions locked to the same IP? (i.e. do users need to log in again if they change IPs?)
|
494
497
|
* `bundle_password_required` (boolean): Do Bundles require password protection?
|
495
498
|
* `bundle_require_share_recipient` (boolean): Do Bundles require recipients for sharing?
|
499
|
+
* `bundle_registration_notifications` (string): Do Bundle owners receive registration notification?
|
496
500
|
* `password_requirements_apply_to_bundles` (boolean): Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
|
497
501
|
* `opt_out_global` (boolean): Use servers in the USA only?
|
498
502
|
* `use_provided_modified_at` (boolean): Allow uploaders to set `provided_modified_at` for uploaded files?
|