files-com 1.6.101__py3-none-any.whl → 1.6.164__py3-none-any.whl

files_sdk/models/remote_server.py

@@ -1,4 +1,5 @@
 import builtins  # noqa: F401
+from files_sdk.models.agent_push_update import AgentPushUpdate
 from files_sdk.models.remote_server_configuration_file import (
     RemoteServerConfigurationFile,
 )
@@ -19,11 +20,13 @@ class RemoteServer:
         "hostname": None,  # string - Hostname or IP address
         "remote_home_path": None,  # string - Initial home folder on remote server
         "name": None,  # string - Internal name for your reference
-        "port": None,  # int64 - Port for remote server.  Not needed for S3.
-        "buffer_uploads_always": None,  # boolean - If true, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections.  It will cause data to be temporarily stored in Files.com.
+        "description": None,  # string - Internal description for your reference
+        "port": None,  # int64 - Port for remote server.
+        "buffer_uploads": None,  # string - If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections.  It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
         "max_connections": None,  # int64 - Max number of parallel connections.  Ignored for S3 connections (we will parallelize these as much as possible).
         "pin_to_site_region": None,  # boolean - If true, we will ensure that all communications with this remote server are made through the primary region of the site.  This setting can also be overridden by a site-wide setting which will force it to true.
         "pinned_region": None,  # string - If set, all communications with this remote server are made through the provided region.
+        "remote_server_credential_id": None,  # int64 - ID of Remote Server Credential, if applicable.
         "s3_bucket": None,  # string - S3 bucket name
         "s3_region": None,  # string - S3 region
         "aws_access_key": None,  # string - AWS Access Key.
@@ -31,7 +34,7 @@ class RemoteServer:
         "server_host_key": None,  # string - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
         "server_type": None,  # string - Remote server type.
         "ssl": None,  # string - Should we require SSL?
-        "username": None,  # string - Remote server username.  Not needed for S3 buckets.
+        "username": None,  # string - Remote server username.
         "google_cloud_storage_bucket": None,  # string - Google Cloud Storage: Bucket Name
         "google_cloud_storage_project_id": None,  # string - Google Cloud Storage: Project ID
         "google_cloud_storage_s3_compatible_access_key": None,  # string - Google Cloud Storage: S3-compatible Access Key.
@@ -59,6 +62,9 @@ class RemoteServer:
         "files_agent_root": None,  # string - Agent local root path
         "files_agent_api_token": None,  # string - Files Agent API Token
         "files_agent_version": None,  # string - Files Agent version
+        "files_agent_up_to_date": None,  # boolean - If true, the Files Agent is up to date.
+        "files_agent_latest_version": None,  # string - Latest available Files Agent version
+        "outbound_agent_id": None,  # int64 - Route traffic to outbound on a files-agent
         "filebase_bucket": None,  # string - Filebase: Bucket name
         "filebase_access_key": None,  # string - Filebase: Access Key.
         "cloudflare_bucket": None,  # string - Cloudflare: Bucket name
@@ -112,6 +118,27 @@ class RemoteServer:
             if getattr(self, k, None) is not None
         }
 
+    # Push update to Files Agent
+    def agent_push_update(self, params=None):
+        if not isinstance(params, dict):
+            params = {}
+
+        if hasattr(self, "id") and self.id:
+            params["id"] = self.id
+        else:
+            raise MissingParameterError("Current object doesn't have a id")
+        if "id" not in params:
+            raise MissingParameterError("Parameter missing: id")
+        if "id" in params and not isinstance(params["id"], int):
+            raise InvalidParameterError("Bad parameter: id must be an int")
+        response, _options = Api.send_request(
+            "POST",
+            "/remote_servers/{id}/agent_push_update".format(id=params["id"]),
+            params,
+            self.options,
+        )
+        return response.data
+
     # Post local changes, check in, and download configuration file (used by some Remote Server integrations, such as the Files.com Agent)
     #
     # Parameters:
@@ -224,10 +251,11 @@ class RemoteServer:
     #   azure_files_storage_share_name - string - Azure Files:  Storage Share name
     #   backblaze_b2_bucket - string - Backblaze B2 Cloud Storage: Bucket name
     #   backblaze_b2_s3_endpoint - string - Backblaze B2 Cloud Storage: S3 Endpoint
-    #   buffer_uploads_always - boolean - If true, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections.  It will cause data to be temporarily stored in Files.com.
+    #   buffer_uploads - string - If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections.  It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
     #   cloudflare_access_key - string - Cloudflare: Access Key.
     #   cloudflare_bucket - string - Cloudflare: Bucket name
     #   cloudflare_endpoint - string - Cloudflare: endpoint
+    #   description - string - Internal description for your reference
     #   dropbox_teams - boolean - Dropbox: If true, list Team folders in root?
     #   enable_dedicated_ips - boolean - `true` if remote server only accepts connections from dedicated IPs
     #   filebase_access_key - string - Filebase: Access Key.
@@ -235,6 +263,7 @@ class RemoteServer:
     #   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_version - string - Files Agent version
+    #   outbound_agent_id - int64 - Route traffic to outbound on a files-agent
     #   google_cloud_storage_bucket - string - Google Cloud Storage: Bucket Name
     #   google_cloud_storage_project_id - string - Google Cloud Storage: Project ID
     #   google_cloud_storage_s3_compatible_access_key - string - Google Cloud Storage: S3-compatible Access Key.
@@ -246,7 +275,8 @@ class RemoteServer:
     #   name - string - Internal name for your reference
     #   one_drive_account_type - string - OneDrive: Either personal or business_other account types
     #   pin_to_site_region - boolean - If true, we will ensure that all communications with this remote server are made through the primary region of the site.  This setting can also be overridden by a site-wide setting which will force it to true.
-    #   port - int64 - Port for remote server.  Not needed for S3.
+    #   port - int64 - Port for remote server.
+    #   remote_server_credential_id - int64 - ID of Remote Server Credential, if applicable.
     #   s3_bucket - string - S3 bucket name
     #   s3_compatible_access_key - string - S3-compatible: Access Key
     #   s3_compatible_bucket - string - S3-compatible: Bucket name
@@ -257,7 +287,7 @@ class RemoteServer:
     #   server_host_key - string - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
     #   server_type - string - Remote server type.
     #   ssl - string - Should we require SSL?
-    #   username - string - Remote server username.  Not needed for S3 buckets.
+    #   username - string - Remote server username.
     #   wasabi_access_key - string - Wasabi: Access Key.
     #   wasabi_bucket - string - Wasabi: Bucket name
     #   wasabi_region - string - Wasabi: Region
@@ -439,6 +469,12 @@ class RemoteServer:
             raise InvalidParameterError(
                 "Bad parameter: backblaze_b2_s3_endpoint must be an str"
             )
+        if "buffer_uploads" in params and not isinstance(
+            params["buffer_uploads"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: buffer_uploads must be an str"
+            )
         if "cloudflare_access_key" in params and not isinstance(
             params["cloudflare_access_key"], str
         ):
@@ -457,6 +493,12 @@ class RemoteServer:
             raise InvalidParameterError(
                 "Bad parameter: cloudflare_endpoint must be an str"
             )
+        if "description" in params and not isinstance(
+            params["description"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: description must be an str"
+            )
         if "filebase_access_key" in params and not isinstance(
             params["filebase_access_key"], str
         ):
@@ -487,6 +529,12 @@ class RemoteServer:
             raise InvalidParameterError(
                 "Bad parameter: files_agent_version must be an str"
             )
+        if "outbound_agent_id" in params and not isinstance(
+            params["outbound_agent_id"], int
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: outbound_agent_id must be an int"
+            )
         if "google_cloud_storage_bucket" in params and not isinstance(
             params["google_cloud_storage_bucket"], str
         ):
@@ -546,6 +594,12 @@ class RemoteServer:
             )
         if "port" in params and not isinstance(params["port"], int):
             raise InvalidParameterError("Bad parameter: port must be an int")
+        if "remote_server_credential_id" in params and not isinstance(
+            params["remote_server_credential_id"], int
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: remote_server_credential_id must be an int"
+            )
         if "s3_bucket" in params and not isinstance(params["s3_bucket"], str):
             raise InvalidParameterError(
                 "Bad parameter: s3_bucket must be an str"
@@ -766,10 +820,11 @@ def find_configuration_file(id, params=None, options=None):
 #   azure_files_storage_share_name - string - Azure Files:  Storage Share name
 #   backblaze_b2_bucket - string - Backblaze B2 Cloud Storage: Bucket name
 #   backblaze_b2_s3_endpoint - string - Backblaze B2 Cloud Storage: S3 Endpoint
-#   buffer_uploads_always - boolean - If true, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections.  It will cause data to be temporarily stored in Files.com.
+#   buffer_uploads - string - If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections.  It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
 #   cloudflare_access_key - string - Cloudflare: Access Key.
 #   cloudflare_bucket - string - Cloudflare: Bucket name
 #   cloudflare_endpoint - string - Cloudflare: endpoint
+#   description - string - Internal description for your reference
 #   dropbox_teams - boolean - Dropbox: If true, list Team folders in root?
 #   enable_dedicated_ips - boolean - `true` if remote server only accepts connections from dedicated IPs
 #   filebase_access_key - string - Filebase: Access Key.
@@ -777,6 +832,7 @@ def find_configuration_file(id, params=None, options=None):
 #   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_version - string - Files Agent version
+#   outbound_agent_id - int64 - Route traffic to outbound on a files-agent
 #   google_cloud_storage_bucket - string - Google Cloud Storage: Bucket Name
 #   google_cloud_storage_project_id - string - Google Cloud Storage: Project ID
 #   google_cloud_storage_s3_compatible_access_key - string - Google Cloud Storage: S3-compatible Access Key.
@@ -788,7 +844,8 @@ def find_configuration_file(id, params=None, options=None):
 #   name - string - Internal name for your reference
 #   one_drive_account_type - string - OneDrive: Either personal or business_other account types
 #   pin_to_site_region - boolean - If true, we will ensure that all communications with this remote server are made through the primary region of the site.  This setting can also be overridden by a site-wide setting which will force it to true.
-#   port - int64 - Port for remote server.  Not needed for S3.
+#   port - int64 - Port for remote server.
+#   remote_server_credential_id - int64 - ID of Remote Server Credential, if applicable.
 #   s3_bucket - string - S3 bucket name
 #   s3_compatible_access_key - string - S3-compatible: Access Key
 #   s3_compatible_bucket - string - S3-compatible: Bucket name
@@ -799,7 +856,7 @@ def find_configuration_file(id, params=None, options=None):
 #   server_host_key - string - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
 #   server_type - string - Remote server type.
 #   ssl - string - Should we require SSL?
-#   username - string - Remote server username.  Not needed for S3 buckets.
+#   username - string - Remote server username.
 #   wasabi_access_key - string - Wasabi: Access Key.
 #   wasabi_bucket - string - Wasabi: Bucket name
 #   wasabi_region - string - Wasabi: Region
@@ -982,11 +1039,11 @@ def create(params=None, options=None):
         raise InvalidParameterError(
             "Bad parameter: backblaze_b2_s3_endpoint must be an str"
         )
-    if "buffer_uploads_always" in params and not isinstance(
-        params["buffer_uploads_always"], bool
+    if "buffer_uploads" in params and not isinstance(
+        params["buffer_uploads"], str
     ):
         raise InvalidParameterError(
-            "Bad parameter: buffer_uploads_always must be an bool"
+            "Bad parameter: buffer_uploads must be an str"
         )
     if "cloudflare_access_key" in params and not isinstance(
         params["cloudflare_access_key"], str
@@ -1006,6 +1063,10 @@ def create(params=None, options=None):
         raise InvalidParameterError(
             "Bad parameter: cloudflare_endpoint must be an str"
         )
+    if "description" in params and not isinstance(params["description"], str):
+        raise InvalidParameterError(
+            "Bad parameter: description must be an str"
+        )
     if "dropbox_teams" in params and not isinstance(
         params["dropbox_teams"], bool
     ):
@@ -1048,6 +1109,12 @@ def create(params=None, options=None):
         raise InvalidParameterError(
             "Bad parameter: files_agent_version must be an str"
         )
+    if "outbound_agent_id" in params and not isinstance(
+        params["outbound_agent_id"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: outbound_agent_id must be an int"
+        )
     if "google_cloud_storage_bucket" in params and not isinstance(
         params["google_cloud_storage_bucket"], str
     ):
@@ -1111,6 +1178,12 @@ def create(params=None, options=None):
         )
     if "port" in params and not isinstance(params["port"], int):
         raise InvalidParameterError("Bad parameter: port must be an int")
+    if "remote_server_credential_id" in params and not isinstance(
+        params["remote_server_credential_id"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: remote_server_credential_id must be an int"
+        )
     if "s3_bucket" in params and not isinstance(params["s3_bucket"], str):
         raise InvalidParameterError("Bad parameter: s3_bucket must be an str")
     if "s3_compatible_access_key" in params and not isinstance(
@@ -1183,6 +1256,26 @@ def create(params=None, options=None):
     return RemoteServer(response.data, options)
 
 
+# Push update to Files Agent
+def agent_push_update(id, params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    params["id"] = id
+    if "id" in params and not isinstance(params["id"], int):
+        raise InvalidParameterError("Bad parameter: id must be an int")
+    if "id" not in params:
+        raise MissingParameterError("Parameter missing: id")
+    response, options = Api.send_request(
+        "POST",
+        "/remote_servers/{id}/agent_push_update".format(id=params["id"]),
+        params,
+        options,
+    )
+    return AgentPushUpdate(response.data, options)
+
+
 # Post local changes, check in, and download configuration file (used by some Remote Server integrations, such as the Files.com Agent)
 #
 # Parameters:
@@ -1282,10 +1375,11 @@ def configuration_file(id, params=None, options=None):
 #   azure_files_storage_share_name - string - Azure Files:  Storage Share name
 #   backblaze_b2_bucket - string - Backblaze B2 Cloud Storage: Bucket name
 #   backblaze_b2_s3_endpoint - string - Backblaze B2 Cloud Storage: S3 Endpoint
-#   buffer_uploads_always - boolean - If true, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections.  It will cause data to be temporarily stored in Files.com.
+#   buffer_uploads - string - If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections.  It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
 #   cloudflare_access_key - string - Cloudflare: Access Key.
 #   cloudflare_bucket - string - Cloudflare: Bucket name
 #   cloudflare_endpoint - string - Cloudflare: endpoint
+#   description - string - Internal description for your reference
 #   dropbox_teams - boolean - Dropbox: If true, list Team folders in root?
 #   enable_dedicated_ips - boolean - `true` if remote server only accepts connections from dedicated IPs
 #   filebase_access_key - string - Filebase: Access Key.
@@ -1293,6 +1387,7 @@ def configuration_file(id, params=None, options=None):
 #   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_version - string - Files Agent version
+#   outbound_agent_id - int64 - Route traffic to outbound on a files-agent
 #   google_cloud_storage_bucket - string - Google Cloud Storage: Bucket Name
 #   google_cloud_storage_project_id - string - Google Cloud Storage: Project ID
 #   google_cloud_storage_s3_compatible_access_key - string - Google Cloud Storage: S3-compatible Access Key.
@@ -1304,7 +1399,8 @@ def configuration_file(id, params=None, options=None):
 #   name - string - Internal name for your reference
 #   one_drive_account_type - string - OneDrive: Either personal or business_other account types
 #   pin_to_site_region - boolean - If true, we will ensure that all communications with this remote server are made through the primary region of the site.  This setting can also be overridden by a site-wide setting which will force it to true.
-#   port - int64 - Port for remote server.  Not needed for S3.
+#   port - int64 - Port for remote server.
+#   remote_server_credential_id - int64 - ID of Remote Server Credential, if applicable.
 #   s3_bucket - string - S3 bucket name
 #   s3_compatible_access_key - string - S3-compatible: Access Key
 #   s3_compatible_bucket - string - S3-compatible: Bucket name
@@ -1315,7 +1411,7 @@ def configuration_file(id, params=None, options=None):
 #   server_host_key - string - Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
 #   server_type - string - Remote server type.
 #   ssl - string - Should we require SSL?
-#   username - string - Remote server username.  Not needed for S3 buckets.
+#   username - string - Remote server username.
 #   wasabi_access_key - string - Wasabi: Access Key.
 #   wasabi_bucket - string - Wasabi: Bucket name
 #   wasabi_region - string - Wasabi: Region
@@ -1501,11 +1597,11 @@ def update(id, params=None, options=None):
         raise InvalidParameterError(
             "Bad parameter: backblaze_b2_s3_endpoint must be an str"
         )
-    if "buffer_uploads_always" in params and not isinstance(
-        params["buffer_uploads_always"], bool
+    if "buffer_uploads" in params and not isinstance(
+        params["buffer_uploads"], str
     ):
         raise InvalidParameterError(
-            "Bad parameter: buffer_uploads_always must be an bool"
+            "Bad parameter: buffer_uploads must be an str"
         )
     if "cloudflare_access_key" in params and not isinstance(
         params["cloudflare_access_key"], str
@@ -1525,6 +1621,10 @@ def update(id, params=None, options=None):
         raise InvalidParameterError(
             "Bad parameter: cloudflare_endpoint must be an str"
         )
+    if "description" in params and not isinstance(params["description"], str):
+        raise InvalidParameterError(
+            "Bad parameter: description must be an str"
+        )
     if "dropbox_teams" in params and not isinstance(
         params["dropbox_teams"], bool
     ):
@@ -1567,6 +1667,12 @@ def update(id, params=None, options=None):
         raise InvalidParameterError(
             "Bad parameter: files_agent_version must be an str"
         )
+    if "outbound_agent_id" in params and not isinstance(
+        params["outbound_agent_id"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: outbound_agent_id must be an int"
+        )
     if "google_cloud_storage_bucket" in params and not isinstance(
         params["google_cloud_storage_bucket"], str
     ):
@@ -1630,6 +1736,12 @@ def update(id, params=None, options=None):
         )
     if "port" in params and not isinstance(params["port"], int):
         raise InvalidParameterError("Bad parameter: port must be an int")
+    if "remote_server_credential_id" in params and not isinstance(
+        params["remote_server_credential_id"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: remote_server_credential_id must be an int"
+        )
     if "s3_bucket" in params and not isinstance(params["s3_bucket"], str):
         raise InvalidParameterError("Bad parameter: s3_bucket must be an str")
     if "s3_compatible_access_key" in params and not isinstance(