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

files_sdk/models/key_lifecycle_rule.py

@@ -0,0 +1,240 @@
+import builtins  # noqa: F401
+from files_sdk.api import Api  # noqa: F401
+from files_sdk.list_obj import ListObj
+from files_sdk.error import (  # noqa: F401
+    InvalidParameterError,
+    MissingParameterError,
+    NotImplementedError,
+)
+
+
+class KeyLifecycleRule:
+    default_attributes = {
+        "id": None,  # int64 - Key Lifecycle Rule ID
+        "key_type": None,  # string - Key type for which the rule will apply (gpg or ssh).
+        "inactivity_days": None,  # int64 - Number of days of inactivity before the rule applies.
+        "name": None,  # string - Key Lifecycle Rule name
+    }
+
+    def __init__(self, attributes=None, options=None):
+        if not isinstance(attributes, dict):
+            attributes = {}
+        if not isinstance(options, dict):
+            options = {}
+        self.set_attributes(attributes)
+        self.options = options
+
+    def set_attributes(self, attributes):
+        for (
+            attribute,
+            default_value,
+        ) in KeyLifecycleRule.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in KeyLifecycleRule.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+    # Parameters:
+    #   key_type - string - Key type for which the rule will apply (gpg or ssh).
+    #   inactivity_days - int64 - Number of days of inactivity before the rule applies.
+    #   name - string - Key Lifecycle Rule name
+    def 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")
+        if "key_type" in params and not isinstance(params["key_type"], str):
+            raise InvalidParameterError(
+                "Bad parameter: key_type must be an str"
+            )
+        if "inactivity_days" in params and not isinstance(
+            params["inactivity_days"], int
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: inactivity_days must be an int"
+            )
+        if "name" in params and not isinstance(params["name"], str):
+            raise InvalidParameterError("Bad parameter: name must be an str")
+        response, _options = Api.send_request(
+            "PATCH",
+            "/key_lifecycle_rules/{id}".format(id=params["id"]),
+            params,
+            self.options,
+        )
+        return response.data
+
+    def delete(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")
+        Api.send_request(
+            "DELETE",
+            "/key_lifecycle_rules/{id}".format(id=params["id"]),
+            params,
+            self.options,
+        )
+
+    def destroy(self, params=None):
+        self.delete(params)
+
+    def save(self):
+        if hasattr(self, "id") and self.id:
+            new_obj = self.update(self.get_attributes())
+            self.set_attributes(new_obj.get_attributes())
+            return True
+        else:
+            new_obj = create(self.get_attributes(), self.options)
+            self.set_attributes(new_obj.get_attributes())
+            return True
+
+
+# Parameters:
+#   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
+#   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+#   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
+def list(params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    if "cursor" in params and not isinstance(params["cursor"], str):
+        raise InvalidParameterError("Bad parameter: cursor must be an str")
+    if "per_page" in params and not isinstance(params["per_page"], int):
+        raise InvalidParameterError("Bad parameter: per_page must be an int")
+    if "sort_by" in params and not isinstance(params["sort_by"], dict):
+        raise InvalidParameterError("Bad parameter: sort_by must be an dict")
+    return ListObj(
+        KeyLifecycleRule, "GET", "/key_lifecycle_rules", params, options
+    )
+
+
+def all(params=None, options=None):
+    list(params, options)
+
+
+# Parameters:
+#   id (required) - int64 - Key Lifecycle Rule ID.
+def find(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(
+        "GET",
+        "/key_lifecycle_rules/{id}".format(id=params["id"]),
+        params,
+        options,
+    )
+    return KeyLifecycleRule(response.data, options)
+
+
+def get(id, params=None, options=None):
+    find(id, params, options)
+
+
+# Parameters:
+#   key_type - string - Key type for which the rule will apply (gpg or ssh).
+#   inactivity_days - int64 - Number of days of inactivity before the rule applies.
+#   name - string - Key Lifecycle Rule name
+def create(params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    if "key_type" in params and not isinstance(params["key_type"], str):
+        raise InvalidParameterError("Bad parameter: key_type must be an str")
+    if "inactivity_days" in params and not isinstance(
+        params["inactivity_days"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: inactivity_days must be an int"
+        )
+    if "name" in params and not isinstance(params["name"], str):
+        raise InvalidParameterError("Bad parameter: name must be an str")
+    response, options = Api.send_request(
+        "POST", "/key_lifecycle_rules", params, options
+    )
+    return KeyLifecycleRule(response.data, options)
+
+
+# Parameters:
+#   key_type - string - Key type for which the rule will apply (gpg or ssh).
+#   inactivity_days - int64 - Number of days of inactivity before the rule applies.
+#   name - string - Key Lifecycle Rule name
+def 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 "key_type" in params and not isinstance(params["key_type"], str):
+        raise InvalidParameterError("Bad parameter: key_type must be an str")
+    if "inactivity_days" in params and not isinstance(
+        params["inactivity_days"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: inactivity_days must be an int"
+        )
+    if "name" in params and not isinstance(params["name"], str):
+        raise InvalidParameterError("Bad parameter: name must be an str")
+    if "id" not in params:
+        raise MissingParameterError("Parameter missing: id")
+    response, options = Api.send_request(
+        "PATCH",
+        "/key_lifecycle_rules/{id}".format(id=params["id"]),
+        params,
+        options,
+    )
+    return KeyLifecycleRule(response.data, options)
+
+
+def delete(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")
+    Api.send_request(
+        "DELETE",
+        "/key_lifecycle_rules/{id}".format(id=params["id"]),
+        params,
+        options,
+    )
+
+
+def destroy(id, params=None, options=None):
+    delete(id, params, options)
+
+
+def new(*args, **kwargs):
+    return KeyLifecycleRule(*args, **kwargs)

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,
 )
@@ -20,11 +21,12 @@ class RemoteServer:
         "remote_home_path": None,  # string - Initial home folder on remote server
         "name": None,  # string - Internal name for your reference
         "description": None,  # string - Internal description for your reference
-        "port": None,  # int64 - Port for remote server.  Not needed for S3.
+        "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.
@@ -32,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.
@@ -60,6 +62,8 @@ 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.
@@ -114,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:
@@ -250,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
@@ -261,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
@@ -568,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"
@@ -812,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
@@ -823,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
@@ -1145,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(
@@ -1217,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:
@@ -1340,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
@@ -1351,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
@@ -1676,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(