files.com 1.0.227 → 1.0.229

package/_VERSION

@@ -1 +1 @@
-1.0.227
+1.0.229

package/docs/Errors.md

@@ -47,6 +47,7 @@ Each of these error classes is used as the base class for each associated error.
 
 These errors are derived from the error groups listed above.
 
+### BadRequest_AgentUpgradeRequiredError
 ### BadRequest_AttachmentTooLargeError
 ### BadRequest_CannotDownloadDirectoryError
 ### BadRequest_CantMoveWithMultipleLocationsError
@@ -84,6 +85,7 @@ These errors are derived from the error groups listed above.
 ### BadRequest_UserRequiredError
 ### NotAuthenticated_AuthenticationRequiredError
 ### NotAuthenticated_BundleRegistrationCodeFailedError
+### NotAuthenticated_FilesAgentTokenFailedError
 ### NotAuthenticated_InboxRegistrationCodeFailedError
 ### NotAuthenticated_InvalidCredentialsError
 ### NotAuthenticated_InvalidOauthError

package/docs/models/FileMigration.md

@@ -20,7 +20,7 @@
 * `path` (string): Source path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
 * `dest_path` (string): Destination path
 * `files_moved` (int64): Number of files processed
-* `files_total` (int64): Total number of files to process
+* `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.
 * `operation` (string): The type of operation
 * `region` (string): Region
 * `status` (string): Status

package/docs/models/PublicIpAddress.md

@@ -6,12 +6,12 @@
 {
   "ip_address": "1.1.1.1",
   "server_name": "server-1",
-  "ftp_enabled": "example",
-  "sftp_enabled": "example"
+  "ftp_enabled": true,
+  "sftp_enabled": true
 }
 ```
 
 * `ip_address` (string): The public IP address.
 * `server_name` (string): The name of the frontend server.
-* `ftp_enabled` (string): 
-* `sftp_enabled` (string): 
+* `ftp_enabled` (boolean): 
+* `sftp_enabled` (boolean): 

package/docs/models/RemoteServer.md

@@ -46,7 +46,10 @@
   "s3_compatible_endpoint": "mys3platform.com",
   "s3_compatible_region": "us-east-1",
   "s3_compatible_access_key": "example",
-  "enable_dedicated_ips": true
+  "enable_dedicated_ips": true,
+  "files_agent_permission_set": "read_write",
+  "files_agent_root": "example",
+  "files_agent_api_token": "example"
 }
 ```
 
@@ -93,6 +96,9 @@
 * `s3_compatible_region` (string): S3-compatible endpoint
 * `s3_compatible_access_key` (string): S3-compatible Access Key.
 * `enable_dedicated_ips` (boolean): `true` if remote server only accepts connections from dedicated IPs
+* `files_agent_permission_set` (string): Local permissions for files agent. read_only, write_only, or read_write
+* `files_agent_root` (string): Agent local root path
+* `files_agent_api_token` (string): Files Agent API Token
 * `aws_secret_key` (string): AWS secret key.
 * `password` (string): Password if needed.
 * `private_key` (string): Private key if needed.
@@ -133,6 +139,19 @@ await RemoteServer.find(id)
 ```
 
 
+### Parameters
+
+* `id` (int64): Required - Remote Server ID.
+
+---
+
+## Download configuration file (required for some Remote Server integrations, such as the Files.com Agent)
+
+```
+await RemoteServer.findConfigurationFile(id)
+```
+
+
 ### Parameters
 
 * `id` (int64): Required - Remote Server ID.
@@ -179,6 +198,8 @@ await RemoteServer.create({
   's3_compatible_region': "us-east-1",
   'enable_dedicated_ips': true,
   's3_compatible_access_key': "example",
+  'files_agent_root': "example",
+  'files_agent_permission_set': "read_write",
 })
 ```
 
@@ -234,6 +255,58 @@ await RemoteServer.create({
 * `enable_dedicated_ips` (boolean): `true` if remote server only accepts connections from dedicated IPs
 * `s3_compatible_access_key` (string): S3-compatible Access Key.
 * `s3_compatible_secret_key` (string): S3-compatible secret key
+* `files_agent_root` (string): Agent local root path
+* `files_agent_permission_set` (string): Local permissions for files agent. read_only, write_only, or read_write
+
+---
+
+## Post local changes, check in, and download configuration file (used by some Remote Server integrations, such as the Files.com Agent)
+
+```
+const [remote_server] = await RemoteServer.list()
+
+await remote_server.configuration_file({
+  'api_token': "example",
+  'permission_set': "full",
+  'root': "example",
+  'hostname': "example",
+  'port': 1,
+  'status': "example",
+  'config_version': "example",
+  'private_key': "example",
+  'public_key': "example",
+})
+```
+
+### Parameters
+
+* `id` (int64): Required - Remote Server ID.
+* `api_token` (string): Files Agent API Token
+* `permission_set` (string): 
+* `root` (string): Agent local root path
+* `hostname` (string): 
+* `port` (int64): Incoming port for files agent connections
+* `status` (string): either running or shutdown
+* `config_version` (string): agent config version
+* `private_key` (string): private key
+* `public_key` (string): public key
+
+### Example Response
+
+```json
+{
+  "id": 1,
+  "permission_set": "full",
+  "api_token": "example",
+  "root": "example",
+  "port": 1,
+  "hostname": "example",
+  "public_key": "example",
+  "private_key": "example",
+  "status": "example",
+  "config_version": "example"
+}
+```
 
 ---
 
@@ -279,6 +352,8 @@ await remote_server.update({
   's3_compatible_region': "us-east-1",
   'enable_dedicated_ips': true,
   's3_compatible_access_key': "example",
+  'files_agent_root': "example",
+  'files_agent_permission_set': "read_write",
 })
 ```
 
@@ -334,6 +409,8 @@ await remote_server.update({
 * `enable_dedicated_ips` (boolean): `true` if remote server only accepts connections from dedicated IPs
 * `s3_compatible_access_key` (string): S3-compatible Access Key.
 * `s3_compatible_secret_key` (string): S3-compatible secret key
+* `files_agent_root` (string): Agent local root path
+* `files_agent_permission_set` (string): Local permissions for files agent. read_only, write_only, or read_write
 
 ### Example Response
 
@@ -381,7 +458,10 @@ await remote_server.update({
   "s3_compatible_endpoint": "mys3platform.com",
   "s3_compatible_region": "us-east-1",
   "s3_compatible_access_key": "example",
-  "enable_dedicated_ips": true
+  "enable_dedicated_ips": true,
+  "files_agent_permission_set": "read_write",
+  "files_agent_root": "example",
+  "files_agent_api_token": "example"
 }
 ```
 

package/docs/models/RemoteServerConfigurationFile.md

@@ -0,0 +1,29 @@
+# RemoteServerConfigurationFile
+
+## Example RemoteServerConfigurationFile Object
+
+```
+{
+  "id": 1,
+  "permission_set": "full",
+  "api_token": "example",
+  "root": "example",
+  "port": 1,
+  "hostname": "example",
+  "public_key": "example",
+  "private_key": "example",
+  "status": "example",
+  "config_version": "example"
+}
+```
+
+* `id` (int64): Agent ID
+* `permission_set` (string): 
+* `api_token` (string): Files Agent API Token
+* `root` (string): Agent local root path
+* `port` (int64): Incoming port for files agent connections
+* `hostname` (string): 
+* `public_key` (string): public key
+* `private_key` (string): private key
+* `status` (string): either running or shutdown
+* `config_version` (string): agent config version

package/docs/models/Site.md

@@ -18,6 +18,7 @@
   "ask_about_overwrites": true,
   "bundle_expiration": 1,
   "bundle_password_required": true,
+  "bundle_registration_notifications": "never",
   "bundle_require_share_recipient": true,
   "bundle_watermark_attachment": "",
   "bundle_watermark_value": {
@@ -160,6 +161,7 @@
 * `ask_about_overwrites` (boolean): If false, rename conflicting files instead of asking for overwrite confirmation.  Only applies to web interface.
 * `bundle_expiration` (int64): Site-wide Bundle expiration in days
 * `bundle_password_required` (boolean): Do Bundles require password protection?
+* `bundle_registration_notifications` (string): Do Bundle owners receive registration notification?
 * `bundle_require_share_recipient` (boolean): Do Bundles require recipients for sharing?
 * `bundle_watermark_attachment` (Image): Preview watermark image applied to all bundle items.
 * `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({
   'session_pinned_by_ip': true,
   'bundle_password_required': true,
   'bundle_require_share_recipient': true,
+  'bundle_registration_notifications': "never",
   'password_requirements_apply_to_bundles': true,
   'opt_out_global': true,
   'use_provided_modified_at': true,
@@ -493,6 +496,7 @@ await Site.update({
 * `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?)
 * `bundle_password_required` (boolean): Do Bundles require password protection?
 * `bundle_require_share_recipient` (boolean): Do Bundles require recipients for sharing?
+* `bundle_registration_notifications` (string): Do Bundle owners receive registration notification?
 * `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?
 * `opt_out_global` (boolean): Use servers in the USA only?
 * `use_provided_modified_at` (boolean): Allow uploaders to set `provided_modified_at` for uploaded files?