files-com 1.5.0__py3-none-any.whl

files_sdk/models/remote_server_configuration_file.py

@@ -0,0 +1,72 @@
+import builtins  # noqa: F401
+from files_sdk.api import Api  # noqa: F401
+from files_sdk.error import (  # noqa: F401
+    InvalidParameterError,
+    MissingParameterError,
+    NotImplementedError,
+)
+
+
+class RemoteServerConfigurationFile:
+    default_attributes = {
+        "id": None,  # int64 - The remote server ID of the agent
+        "permission_set": None,  # string - The permission set for the agent ['read_write', 'read_only', 'write_only']
+        "private_key": None,  # string - The private key for the agent
+        "subdomain": None,  # string - Files.com subdomain site name
+        "root": None,  # string - The root directory for the agent
+        "follow_links": None,  # boolean - Follow symlinks when traversing directories
+        "prefer_protocol": None,  # string - Preferred network protocol ['udp', 'tcp'] (default udp)
+        "dns": None,  # string - DNS lookup method ['auto','doh','system'] (default auto)
+        "proxy_all_outbound": None,  # boolean - Proxy all outbound traffic through files.com proxy server
+        "endpoint_override": None,  # string - Custom site endpoint URL
+        "log_file": None,  # string - Log file name and location
+        "log_level": None,  # string - Log level for the agent logs ['debug', 'info', 'warn', 'error', 'fatal'] (default info)
+        "log_rotate_num": None,  # int64 - Log route for agent logs. (default 5)
+        "log_rotate_size": None,  # int64 - Log route size in MB for agent logs. (default 20)
+        "override_max_concurrent_jobs": None,  # int64 - Maximum number of concurrent jobs (default 500)
+        "graceful_shutdown_timeout": None,  # int64 - Graceful shutdown timeout in seconds (default 15)
+        "transfer_rate_limit": None,  # string - File transfer (upload/download) rate limit
+        #  `<limit>-<period>`, with the given periods:
+        # * 'S': second
+        # * 'M': minute
+        # * 'H': hour
+        # * 'D': day
+        # Examples:
+        # * 5 requests/second: '5-S'
+        # * 10 requests/minute: '10-M'
+        # * 1000 requests/hour: '1000-H'
+        # * 2000 requests/day: '2000-D'
+        "api_token": None,  # string - Files Agent API Token
+        "port": None,  # int64 - Incoming port for files agent connections
+        "hostname": None,  # string
+        "public_key": None,  # string - public key
+        "status": None,  # string - either running or shutdown
+        "server_host_key": None,  # string
+        "config_version": None,  # string - agent config version
+    }
+
+    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 RemoteServerConfigurationFile.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in RemoteServerConfigurationFile.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+
+def new(*args, **kwargs):
+    return RemoteServerConfigurationFile(*args, **kwargs)

files_sdk/models/request.py

@@ -0,0 +1,180 @@
+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 Request:
+    default_attributes = {
+        "id": None,  # int64 - Request ID
+        "path": None,  # string - Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+        "source": None,  # string - Source filename, if applicable
+        "destination": None,  # string - Destination filename
+        "automation_id": None,  # int64 - ID of automation that created request
+        "user_display_name": None,  # string - User making the request (if applicable)
+        "user_ids": None,  # string - A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
+        "group_ids": None,  # string - A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
+    }
+
+    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 Request.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in Request.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+    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",
+            "/requests/{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:
+            raise NotImplementedError(
+                "The Request object doesn't support updates."
+            )
+        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 .
+#   mine - boolean - Only show requests of the current user?  (Defaults to true if current user is not a site admin.)
+#   path - string - Path to show requests for.  If omitted, shows all paths. Send `/` to represent the root directory.
+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")
+    if "path" in params and not isinstance(params["path"], str):
+        raise InvalidParameterError("Bad parameter: path must be an str")
+    return ListObj(Request, "GET", "/requests", params, options)
+
+
+def all(params=None, options=None):
+    list(params, options)
+
+
+# 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 .
+#   mine - boolean - Only show requests of the current user?  (Defaults to true if current user is not a site admin.)
+#   path (required) - string - Path to show requests for.  If omitted, shows all paths. Send `/` to represent the root directory.
+def get_folder(path, params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    params["path"] = path
+    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")
+    if "path" in params and not isinstance(params["path"], str):
+        raise InvalidParameterError("Bad parameter: path must be an str")
+    if "path" not in params:
+        raise MissingParameterError("Parameter missing: path")
+    return ListObj(
+        Request,
+        "GET",
+        "/requests/folders/{path}".format(path=params["path"]),
+        params,
+        options,
+    )
+
+
+# Parameters:
+#   path (required) - string - Folder path on which to request the file.
+#   destination (required) - string - Destination filename (without extension) to request.
+#   user_ids - string - A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
+#   group_ids - string - A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
+def create(params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    if "path" in params and not isinstance(params["path"], str):
+        raise InvalidParameterError("Bad parameter: path must be an str")
+    if "destination" in params and not isinstance(params["destination"], str):
+        raise InvalidParameterError(
+            "Bad parameter: destination must be an str"
+        )
+    if "user_ids" in params and not isinstance(params["user_ids"], str):
+        raise InvalidParameterError("Bad parameter: user_ids must be an str")
+    if "group_ids" in params and not isinstance(params["group_ids"], str):
+        raise InvalidParameterError("Bad parameter: group_ids must be an str")
+    if "path" not in params:
+        raise MissingParameterError("Parameter missing: path")
+    if "destination" not in params:
+        raise MissingParameterError("Parameter missing: destination")
+    response, options = Api.send_request("POST", "/requests", params, options)
+    return Request(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", "/requests/{id}".format(id=params["id"]), params, options
+    )
+
+
+def destroy(id, params=None, options=None):
+    delete(id, params, options)
+
+
+def new(*args, **kwargs):
+    return Request(*args, **kwargs)

files_sdk/models/restore.py

@@ -0,0 +1,104 @@
+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 Restore:
+    default_attributes = {
+        "earliest_date": None,  # date-time - Restore all files deleted after this date/time. Don't set this earlier than you need. Can not be greater than 365 days prior to the restore request.
+        "id": None,  # int64 - Restore Record ID.
+        "dirs_restored": None,  # int64 - Number of directories that were successfully restored.
+        "dirs_errored": None,  # int64 - Number of directories that were not able to be restored.
+        "dirs_total": None,  # int64 - Total number of directories processed.
+        "files_restored": None,  # int64 - Number of files successfully restored.
+        "files_errored": None,  # int64 - Number of files that were not able to be restored.
+        "files_total": None,  # int64 - Total number of files processed.
+        "prefix": None,  # string - Prefix of the files/folders to restore. To restore a folder, add a trailing slash to the folder name. Do not use a leading slash. To restore all deleted items, specify an empty string (`''`) in the prefix field or omit the field from the request.
+        "restore_in_place": None,  # boolean - If true, we will restore the files in place (into their original paths). If false, we will create a new restoration folder in the root and restore files there.
+        "restore_deleted_permissions": None,  # boolean - If true, we will also restore any Permissions that match the same path prefix from the same dates.
+        "status": None,  # string - Status of the restoration process.
+        "update_timestamps": None,  # boolean - If true, we will update the last modified timestamp of restored files to today's date. If false, we might trigger File Expiration to delete the file again.
+        "error_messages": None,  # array(string) - Error messages received while restoring files and/or directories. Only present if there were errors.
+    }
+
+    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 Restore.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in Restore.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+    def save(self):
+        if hasattr(self, "id") and self.id:
+            raise NotImplementedError(
+                "The Restore object doesn't support updates."
+            )
+        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).
+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")
+    return ListObj(Restore, "GET", "/restores", params, options)
+
+
+def all(params=None, options=None):
+    list(params, options)
+
+
+# Parameters:
+#   earliest_date (required) - string - Restore all files deleted after this date/time. Don't set this earlier than you need. Can not be greater than 365 days prior to the restore request.
+#   prefix - string - Prefix of the files/folders to restore. To restore a folder, add a trailing slash to the folder name. Do not use a leading slash. To restore all deleted items, specify an empty string (`''`) in the prefix field or omit the field from the request.
+#   restore_deleted_permissions - boolean - If true, we will also restore any Permissions that match the same path prefix from the same dates.
+#   restore_in_place - boolean - If true, we will restore the files in place (into their original paths). If false, we will create a new restoration folder in the root and restore files there.
+#   update_timestamps - boolean - If true, we will update the last modified timestamp of restored files to today's date. If false, we might trigger File Expiration to delete the file again.
+def create(params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    if "earliest_date" in params and not isinstance(
+        params["earliest_date"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: earliest_date must be an str"
+        )
+    if "prefix" in params and not isinstance(params["prefix"], str):
+        raise InvalidParameterError("Bad parameter: prefix must be an str")
+    if "earliest_date" not in params:
+        raise MissingParameterError("Parameter missing: earliest_date")
+    response, options = Api.send_request("POST", "/restores", params, options)
+    return Restore(response.data, options)
+
+
+def new(*args, **kwargs):
+    return Restore(*args, **kwargs)

files_sdk/models/session.py

@@ -0,0 +1,100 @@
+import builtins  # noqa: F401
+from files_sdk.api import Api  # noqa: F401
+from files_sdk.error import (  # noqa: F401
+    InvalidParameterError,
+    MissingParameterError,
+    NotImplementedError,
+)
+
+
+class Session:
+    default_attributes = {
+        "id": None,  # string - Session ID
+        "language": None,  # string - Session language
+        "read_only": None,  # boolean - Is this session read only?
+        "sftp_insecure_ciphers": None,  # boolean - Are insecure SFTP ciphers allowed for this user? (If this is set to true, the site administrator has signaled that it is ok to use less secure SSH ciphers for this user.)
+        "username": None,  # string - Username to sign in as
+        "password": None,  # string - Password for sign in
+        "otp": None,  # string - If this user has a 2FA device, provide its OTP or code here.
+        "partial_session_id": None,  # string - Identifier for a partially-completed login
+    }
+
+    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 Session.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in Session.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+    def destroy(self, params=None, options=None):
+        if not isinstance(params, dict):
+            params = {}
+        if not isinstance(options, dict):
+            options = {}
+        options.pop("session_id", None)
+        options["session"] = self
+        Session.destroy(params, options)
+
+    def save(self):
+        if hasattr(self, "id") and self.id:
+            raise NotImplementedError(
+                "The Session object doesn't support updates."
+            )
+        else:
+            new_obj = create(self.get_attributes(), self.options)
+            self.set_attributes(new_obj.get_attributes())
+            return True
+
+
+# Parameters:
+#   username - string - Username to sign in as
+#   password - string - Password for sign in
+#   otp - string - If this user has a 2FA device, provide its OTP or code here.
+#   partial_session_id - string - Identifier for a partially-completed login
+def create(params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    if "username" in params and not isinstance(params["username"], str):
+        raise InvalidParameterError("Bad parameter: username must be an str")
+    if "password" in params and not isinstance(params["password"], str):
+        raise InvalidParameterError("Bad parameter: password must be an str")
+    if "otp" in params and not isinstance(params["otp"], str):
+        raise InvalidParameterError("Bad parameter: otp must be an str")
+    if "partial_session_id" in params and not isinstance(
+        params["partial_session_id"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: partial_session_id must be an str"
+        )
+    response, options = Api.send_request("POST", "/sessions", params, options)
+    return Session(response.data, options)
+
+
+def delete(params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    Api.send_request("DELETE", "/sessions", params, options)
+
+
+def destroy(params=None, options=None):
+    delete(params, options)
+
+
+def new(*args, **kwargs):
+    return Session(*args, **kwargs)

files_sdk/models/settings_change.py

@@ -0,0 +1,71 @@
+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 SettingsChange:
+    default_attributes = {
+        "changes": None,  # array(string) - Markdown-formatted change messages.
+        "created_at": None,  # date-time - The time this change was made
+        "user_id": None,  # int64 - The user id responsible for this change
+        "api_key_id": None,  # int64 - The API key id responsible for this change
+        "user_is_files_support": None,  # boolean - true if this change was performed by Files.com support.
+        "user_is_from_parent_site": None,  # boolean - true if this change was performed by a user on a parent site.
+        "username": None,  # string - The username of the user responsible for this change
+    }
+
+    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 SettingsChange.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in SettingsChange.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+
+# 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 `created_at`, `api_key_id` or `user_id`.
+#   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
+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")
+    if "filter" in params and not isinstance(params["filter"], dict):
+        raise InvalidParameterError("Bad parameter: filter must be an dict")
+    return ListObj(SettingsChange, "GET", "/settings_changes", params, options)
+
+
+def all(params=None, options=None):
+    list(params, options)
+
+
+def new(*args, **kwargs):
+    return SettingsChange(*args, **kwargs)