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

files_sdk/models/user_lifecycle_rule.py

@@ -11,13 +11,17 @@ from files_sdk.error import (  # noqa: F401
 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
+        "authentication_method": None,  # string - User authentication method for which the rule will apply.
+        "group_ids": None,  # array(int64) - Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
         "action": None,  # string - Action to take on inactive users (disable or delete)
-        "user_state": None,  # string - State of the users to apply the rule to (inactive or disabled)
+        "inactivity_days": None,  # int64 - Number of days of inactivity before the rule applies
+        "include_folder_admins": None,  # boolean - If true, the rule will apply to folder admins.
+        "include_site_admins": None,  # boolean - If true, the rule will apply to site admins.
+        "name": None,  # string - User Lifecycle Rule name
+        "partner_tag": None,  # string - If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
         "site_id": None,  # int64 - Site ID
+        "user_state": None,  # string - State of the users to apply the rule to (inactive or disabled)
+        "user_tag": None,  # string - If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
     }
 
     def __init__(self, attributes=None, options=None):
@@ -43,12 +47,16 @@ class UserLifecycleRule:
         }
 
     # 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
+    #   action - string - Action to take on inactive users (disable or delete)
+    #   authentication_method - string - User authentication method for which the rule will apply.
+    #   group_ids - array(int64) - Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
+    #   inactivity_days - int64 - Number of days of inactivity before the rule applies
+    #   include_site_admins - boolean - If true, the rule will apply to site admins.
+    #   include_folder_admins - boolean - If true, the rule will apply to folder admins.
+    #   name - string - User Lifecycle Rule name
+    #   partner_tag - string - If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
     #   user_state - string - State of the users to apply the rule to (inactive or disabled)
+    #   user_tag - string - If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
     def update(self, params=None):
         if not isinstance(params, dict):
             params = {}
@@ -59,14 +67,6 @@ class UserLifecycleRule:
             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):
@@ -77,18 +77,36 @@ class UserLifecycleRule:
             raise InvalidParameterError(
                 "Bad parameter: authentication_method must be an str"
             )
+        if "group_ids" in params and not isinstance(
+            params["group_ids"], builtins.list
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: group_ids must be an list"
+            )
         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 "partner_tag" in params and not isinstance(
+            params["partner_tag"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: partner_tag must be an str"
+            )
         if "user_state" in params and not isinstance(
             params["user_state"], str
         ):
             raise InvalidParameterError(
                 "Bad parameter: user_state must be an str"
             )
+        if "user_tag" in params and not isinstance(params["user_tag"], str):
+            raise InvalidParameterError(
+                "Bad parameter: user_tag must be an str"
+            )
         response, _options = Api.send_request(
             "PATCH",
             "/user_lifecycle_rules/{id}".format(id=params["id"]),
@@ -133,6 +151,7 @@ class UserLifecycleRule:
 # 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 `site_id`.
 def list(params=None, options=None):
     if not isinstance(params, dict):
         params = {}
@@ -142,6 +161,8 @@ def list(params=None, options=None):
         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(
         UserLifecycleRule, "GET", "/user_lifecycle_rules", params, options
     )
@@ -177,12 +198,16 @@ def get(id, params=None, options=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
+#   action - string - Action to take on inactive users (disable or delete)
+#   authentication_method - string - User authentication method for which the rule will apply.
+#   group_ids - array(int64) - Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
+#   inactivity_days - int64 - Number of days of inactivity before the rule applies
+#   include_site_admins - boolean - If true, the rule will apply to site admins.
+#   include_folder_admins - boolean - If true, the rule will apply to folder admins.
+#   name - string - User Lifecycle Rule name
+#   partner_tag - string - If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
 #   user_state - string - State of the users to apply the rule to (inactive or disabled)
+#   user_tag - string - If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
 def create(params=None, options=None):
     if not isinstance(params, dict):
         params = {}
@@ -196,6 +221,10 @@ def create(params=None, options=None):
         raise InvalidParameterError(
             "Bad parameter: authentication_method must be an str"
         )
+    if "group_ids" in params and not isinstance(
+        params["group_ids"], builtins.list
+    ):
+        raise InvalidParameterError("Bad parameter: group_ids must be an list")
     if "inactivity_days" in params and not isinstance(
         params["inactivity_days"], int
     ):
@@ -214,14 +243,16 @@ def create(params=None, options=None):
         raise InvalidParameterError(
             "Bad parameter: include_folder_admins must be an bool"
         )
+    if "name" in params and not isinstance(params["name"], str):
+        raise InvalidParameterError("Bad parameter: name must be an str")
+    if "partner_tag" in params and not isinstance(params["partner_tag"], str):
+        raise InvalidParameterError(
+            "Bad parameter: partner_tag must be an str"
+        )
     if "user_state" in params and not isinstance(params["user_state"], str):
         raise InvalidParameterError("Bad parameter: user_state must be an str")
-    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 "user_tag" in params and not isinstance(params["user_tag"], str):
+        raise InvalidParameterError("Bad parameter: user_tag must be an str")
     response, options = Api.send_request(
         "POST", "/user_lifecycle_rules", params, options
     )
@@ -229,12 +260,16 @@ def create(params=None, options=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
+#   action - string - Action to take on inactive users (disable or delete)
+#   authentication_method - string - User authentication method for which the rule will apply.
+#   group_ids - array(int64) - Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
+#   inactivity_days - int64 - Number of days of inactivity before the rule applies
+#   include_site_admins - boolean - If true, the rule will apply to site admins.
+#   include_folder_admins - boolean - If true, the rule will apply to folder admins.
+#   name - string - User Lifecycle Rule name
+#   partner_tag - string - If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
 #   user_state - string - State of the users to apply the rule to (inactive or disabled)
+#   user_tag - string - If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
 def update(id, params=None, options=None):
     if not isinstance(params, dict):
         params = {}
@@ -251,6 +286,10 @@ def update(id, params=None, options=None):
         raise InvalidParameterError(
             "Bad parameter: authentication_method must be an str"
         )
+    if "group_ids" in params and not isinstance(
+        params["group_ids"], builtins.list
+    ):
+        raise InvalidParameterError("Bad parameter: group_ids must be an list")
     if "inactivity_days" in params and not isinstance(
         params["inactivity_days"], int
     ):
@@ -269,16 +308,18 @@ def update(id, params=None, options=None):
         raise InvalidParameterError(
             "Bad parameter: include_folder_admins must be an bool"
         )
+    if "name" in params and not isinstance(params["name"], str):
+        raise InvalidParameterError("Bad parameter: name must be an str")
+    if "partner_tag" in params and not isinstance(params["partner_tag"], str):
+        raise InvalidParameterError(
+            "Bad parameter: partner_tag must be an str"
+        )
     if "user_state" in params and not isinstance(params["user_state"], str):
         raise InvalidParameterError("Bad parameter: user_state must be an str")
+    if "user_tag" in params and not isinstance(params["user_tag"], str):
+        raise InvalidParameterError("Bad parameter: user_tag must be an str")
     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"]),