files-com 1.6.2__tar.gz → 1.6.4__tar.gz

{files_com-1.6.2/files_com.egg-info → files_com-1.6.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: files_com
-Version: 1.6.2
+Version: 1.6.4
 Summary: Python bindings for the Files.com API
 License: MIT
 Requires-Python: >=3.5

files_com-1.6.4/_VERSION

@@ -0,0 +1 @@
+1.6.4

{files_com-1.6.2 → files_com-1.6.4/files_com.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: files_com
-Version: 1.6.2
+Version: 1.6.4
 Summary: Python bindings for the Files.com API
 License: MIT
 Requires-Python: >=3.5

{files_com-1.6.2 → files_com-1.6.4}/files_com.egg-info/SOURCES.txt

@@ -110,6 +110,7 @@ files_sdk/models/usage_daily_snapshot.py
 files_sdk/models/usage_snapshot.py
 files_sdk/models/user.py
 files_sdk/models/user_cipher_use.py
+files_sdk/models/user_lifecycle_rule.py
 files_sdk/models/user_request.py
 files_sdk/models/user_sftp_client_use.py
 files_sdk/models/web_dav_action_log.py
@@ -211,6 +212,7 @@ tests/test_usage_daily_snapshot.py
 tests/test_usage_snapshot.py
 tests/test_user.py
 tests/test_user_cipher_use.py
+tests/test_user_lifecycle_rule.py
 tests/test_user_request.py
 tests/test_user_sftp_client_use.py
 tests/test_web_dav_action_log.py

{files_com-1.6.2 → files_com-1.6.4}/files_sdk/__init__.py

@@ -93,6 +93,7 @@ import files_sdk.models.usage_daily_snapshot as usage_daily_snapshot
 import files_sdk.models.usage_snapshot as usage_snapshot
 import files_sdk.models.user as user
 import files_sdk.models.user_cipher_use as user_cipher_use
+import files_sdk.models.user_lifecycle_rule as user_lifecycle_rule
 import files_sdk.models.user_request as user_request
 import files_sdk.models.user_sftp_client_use as user_sftp_client_use
 import files_sdk.models.web_dav_action_log as web_dav_action_log
@@ -198,6 +199,7 @@ from files_sdk.models.usage_daily_snapshot import UsageDailySnapshot
 from files_sdk.models.usage_snapshot import UsageSnapshot
 from files_sdk.models.user import User
 from files_sdk.models.user_cipher_use import UserCipherUse
+from files_sdk.models.user_lifecycle_rule import UserLifecycleRule
 from files_sdk.models.user_request import UserRequest
 from files_sdk.models.user_sftp_client_use import UserSftpClientUse
 from files_sdk.models.web_dav_action_log import WebDavActionLog
@@ -213,7 +215,7 @@ session_id = None
 source_ip = None
 base_url = "https://app.files.com"
 base_path = "api/rest/v1"
-version = "1.6.2"
+version = "1.6.4"
 
 __version__ = version
 

{files_com-1.6.2 → files_com-1.6.4}/files_sdk/models/__init__.py

@@ -98,6 +98,7 @@ from files_sdk.models.usage_daily_snapshot import UsageDailySnapshot
 from files_sdk.models.usage_snapshot import UsageSnapshot
 from files_sdk.models.user import User
 from files_sdk.models.user_cipher_use import UserCipherUse
+from files_sdk.models.user_lifecycle_rule import UserLifecycleRule
 from files_sdk.models.user_request import UserRequest
 from files_sdk.models.user_sftp_client_use import UserSftpClientUse
 from files_sdk.models.web_dav_action_log import WebDavActionLog

files_com-1.6.4/files_sdk/models/user_lifecycle_rule.py

@@ -0,0 +1,300 @@
+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 UserLifecycleRule:
+    default_attributes = {
+        "id": None,  # int64 - User Lifecycle Rule ID
+        "authentication_method": None,  # string - User authentication method for the rule
+        "inactivity_days": None,  # int64 - Number of days of inactivity before the rule applies
+        "include_folder_admins": None,  # boolean - Include folder admins in the rule
+        "include_site_admins": None,  # boolean - Include site admins in the rule
+        "action": None,  # string - Action to take on inactive users (disable or delete)
+        "site_id": None,  # int64 - Site ID
+    }
+
+    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 UserLifecycleRule.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in UserLifecycleRule.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+    # Parameters:
+    #   action (required) - string - Action to take on inactive users (disable or delete)
+    #   authentication_method (required) - string - User authentication method for the rule
+    #   inactivity_days (required) - int64 - Number of days of inactivity before the rule applies
+    #   include_site_admins - boolean - Include site admins in the rule
+    #   include_folder_admins - boolean - Include folder admins in the rule
+    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 "action" not in params:
+            raise MissingParameterError("Parameter missing: action")
+        if "authentication_method" not in params:
+            raise MissingParameterError(
+                "Parameter missing: authentication_method"
+            )
+        if "inactivity_days" not in params:
+            raise MissingParameterError("Parameter missing: inactivity_days")
+        if "id" in params and not isinstance(params["id"], int):
+            raise InvalidParameterError("Bad parameter: id must be an int")
+        if "action" in params and not isinstance(params["action"], str):
+            raise InvalidParameterError("Bad parameter: action must be an str")
+        if "authentication_method" in params and not isinstance(
+            params["authentication_method"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: authentication_method 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"
+            )
+        response, _options = Api.send_request(
+            "PATCH",
+            "/user_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",
+            "/user_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).
+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(
+        UserLifecycleRule, "GET", "/user_lifecycle_rules", params, options
+    )
+
+
+def all(params=None, options=None):
+    list(params, options)
+
+
+# Parameters:
+#   id (required) - int64 - User 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",
+        "/user_lifecycle_rules/{id}".format(id=params["id"]),
+        params,
+        options,
+    )
+    return UserLifecycleRule(response.data, options)
+
+
+def get(id, params=None, options=None):
+    find(id, params, options)
+
+
+# Parameters:
+#   action (required) - string - Action to take on inactive users (disable or delete)
+#   authentication_method (required) - string - User authentication method for the rule
+#   inactivity_days (required) - int64 - Number of days of inactivity before the rule applies
+#   include_site_admins - boolean - Include site admins in the rule
+#   include_folder_admins - boolean - Include folder admins in the rule
+def create(params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    if "action" in params and not isinstance(params["action"], str):
+        raise InvalidParameterError("Bad parameter: action must be an str")
+    if "authentication_method" in params and not isinstance(
+        params["authentication_method"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: authentication_method 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 "include_site_admins" in params and not isinstance(
+        params["include_site_admins"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: include_site_admins must be an bool"
+        )
+    if "include_folder_admins" in params and not isinstance(
+        params["include_folder_admins"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: include_folder_admins must be an bool"
+        )
+    if "action" not in params:
+        raise MissingParameterError("Parameter missing: action")
+    if "authentication_method" not in params:
+        raise MissingParameterError("Parameter missing: authentication_method")
+    if "inactivity_days" not in params:
+        raise MissingParameterError("Parameter missing: inactivity_days")
+    response, options = Api.send_request(
+        "POST", "/user_lifecycle_rules", params, options
+    )
+    return UserLifecycleRule(response.data, options)
+
+
+# Parameters:
+#   action (required) - string - Action to take on inactive users (disable or delete)
+#   authentication_method (required) - string - User authentication method for the rule
+#   inactivity_days (required) - int64 - Number of days of inactivity before the rule applies
+#   include_site_admins - boolean - Include site admins in the rule
+#   include_folder_admins - boolean - Include folder admins in the rule
+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 "action" in params and not isinstance(params["action"], str):
+        raise InvalidParameterError("Bad parameter: action must be an str")
+    if "authentication_method" in params and not isinstance(
+        params["authentication_method"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: authentication_method 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 "include_site_admins" in params and not isinstance(
+        params["include_site_admins"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: include_site_admins must be an bool"
+        )
+    if "include_folder_admins" in params and not isinstance(
+        params["include_folder_admins"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: include_folder_admins must be an bool"
+        )
+    if "id" not in params:
+        raise MissingParameterError("Parameter missing: id")
+    if "action" not in params:
+        raise MissingParameterError("Parameter missing: action")
+    if "authentication_method" not in params:
+        raise MissingParameterError("Parameter missing: authentication_method")
+    if "inactivity_days" not in params:
+        raise MissingParameterError("Parameter missing: inactivity_days")
+    response, options = Api.send_request(
+        "PATCH",
+        "/user_lifecycle_rules/{id}".format(id=params["id"]),
+        params,
+        options,
+    )
+    return UserLifecycleRule(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",
+        "/user_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 UserLifecycleRule(*args, **kwargs)

{files_com-1.6.2 → files_com-1.6.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "files_com"
-version = "1.6.2"
+version = "1.6.4"
 description = "Python bindings for the Files.com API"
 readme = "README.md"
 license = { text = "MIT" }

files_com-1.6.4/tests/test_user_lifecycle_rule.py

@@ -0,0 +1,76 @@
+import unittest
+import inspect
+import files_sdk
+from tests.base import TestBase
+from files_sdk.models import UserLifecycleRule
+from files_sdk import user_lifecycle_rule
+
+class UserLifecycleRuleTest(TestBase):
+    pass 
+    # Instance Methods
+    @unittest.skipUnless(TestBase.mock_server_path_exists("PATCH", "/user_lifecycle_rules/{id}"), "Mock path does not exist")
+    def test_update(self):
+        params = {
+            "id" : 12345,
+            "action" : "foo",
+            "authentication_method" : "foo",
+            "inactivity_days" : 12345,
+        }
+        user_lifecycle_rule = UserLifecycleRule(params)
+        user_lifecycle_rule.update(params)
+
+    @unittest.skipUnless(TestBase.mock_server_path_exists("DELETE", "/user_lifecycle_rules/{id}"), "Mock path does not exist")
+    def test_delete(self):
+        params = {
+            "id" : 12345,
+        }
+        user_lifecycle_rule = UserLifecycleRule(params)
+        user_lifecycle_rule.delete(params)
+
+    # Alias of delete
+    def test_destroy(self):
+        pass
+
+    # Static Methods
+    @unittest.skipUnless(TestBase.mock_server_path_exists("GET", "/user_lifecycle_rules"), "Mock path does not exist")
+    def test_list(self):
+        resp = user_lifecycle_rule.list()
+
+    @unittest.skipUnless(TestBase.mock_server_path_exists("GET", "/user_lifecycle_rules/{id}"), "Mock path does not exist")
+    def test_find(self):
+        id = 12345
+        params = {
+            "id" : 12345,
+        }
+        user_lifecycle_rule.find(id, params)
+
+    @unittest.skipUnless(TestBase.mock_server_path_exists("POST", "/user_lifecycle_rules"), "Mock path does not exist")
+    def test_create(self):
+        params = {
+            "action" : "foo",
+            "authentication_method" : "foo",
+            "inactivity_days" : 12345,
+        }
+        user_lifecycle_rule.create(params)
+
+    @unittest.skipUnless(TestBase.mock_server_path_exists("PATCH", "/user_lifecycle_rules/{id}"), "Mock path does not exist")
+    def test_update(self):
+        id = 12345
+        params = {
+            "id" : 12345,
+            "action" : "foo",
+            "authentication_method" : "foo",
+            "inactivity_days" : 12345,
+        }
+        user_lifecycle_rule.update(id, params)
+
+    @unittest.skipUnless(TestBase.mock_server_path_exists("DELETE", "/user_lifecycle_rules/{id}"), "Mock path does not exist")
+    def test_delete(self):
+        id = 12345
+        params = {
+            "id" : 12345,
+        }
+        user_lifecycle_rule.delete(id, params)
+
+if __name__ == '__main__':
+    unittest.main()

files_com-1.6.2/_VERSION

@@ -1 +0,0 @@
-1.6.2