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

files_sdk/models/sync_run.py

@@ -11,22 +11,25 @@ from files_sdk.error import (  # noqa: F401
 class SyncRun:
     default_attributes = {
         "id": None,  # int64 - SyncRun ID
-        "sync_id": None,  # int64 - ID of the Sync this run belongs to
-        "site_id": None,  # int64 - Site ID
-        "status": None,  # string - Status of the sync run (success, failure, partial_failure, in_progress, skipped)
-        "remote_server_type": None,  # string - Type of remote server used, if any
         "body": None,  # string - Log or summary body for this run
-        "event_errors": None,  # array(string) - Array of errors encountered during the run
         "bytes_synced": None,  # int64 - Total bytes synced in this run
         "compared_files": None,  # int64 - Number of files compared
         "compared_folders": None,  # int64 - Number of folders compared
-        "errored_files": None,  # int64 - Number of files that errored
-        "successful_files": None,  # int64 - Number of files successfully synced
-        "runtime": None,  # double - Total runtime in seconds
-        "log_url": None,  # string - Link to external log file.
         "completed_at": None,  # date-time - When this run was completed
-        "notified": None,  # boolean - Whether notifications were sent for this run
         "created_at": None,  # date-time - When this run was created
+        "dest_remote_server_type": None,  # string - Destination remote server type, if any
+        "dry_run": None,  # boolean - Whether this run was a dry run (no actual changes made)
+        "errored_files": None,  # int64 - Number of files that errored
+        "estimated_bytes_count": None,  # int64 - Estimated bytes count for this run
+        "event_errors": None,  # array(string) - Array of errors encountered during the run
+        "log_url": None,  # string - Link to external log file.
+        "runtime": None,  # double - Total runtime in seconds
+        "site_id": None,  # int64 - Site ID
+        "src_remote_server_type": None,  # string - Source remote server type, if any
+        "status": None,  # string - Status of the sync run (success, failure, partial_failure, in_progress, skipped)
+        "successful_files": None,  # int64 - Number of files successfully synced
+        "sync_id": None,  # int64 - ID of the Sync this run belongs to
+        "sync_name": None,  # string - Name of the Sync this run belongs to
         "updated_at": None,  # date-time - When this run was last updated
     }
 
@@ -54,9 +57,12 @@ class SyncRun:
 #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
 #   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 `sync_id`, `created_at` or `status`.
-#   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status` and `sync_id`. Valid field combinations are `[ sync_id, status ]`.
-#   sync_id (required) - int64 - ID of the Sync this run belongs to
+#   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `sync_id`, `created_at` or `status`.
+#   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `status`, `dry_run`, `src_remote_server_type`, `dest_remote_server_type` or `sync_id`. Valid field combinations are `[ status, created_at ]`, `[ src_remote_server_type, created_at ]`, `[ dest_remote_server_type, created_at ]`, `[ sync_id, created_at ]`, `[ src_remote_server_type, status ]`, `[ dest_remote_server_type, status ]`, `[ sync_id, status ]`, `[ src_remote_server_type, status, created_at ]`, `[ dest_remote_server_type, status, created_at ]` or `[ sync_id, status, created_at ]`.
+#   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
+#   filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
+#   filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
+#   filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
 def list(params=None, options=None):
     if not isinstance(params, dict):
         params = {}
@@ -72,10 +78,18 @@ def list(params=None, options=None):
         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")
-    if "sync_id" in params and not isinstance(params["sync_id"], int):
-        raise InvalidParameterError("Bad parameter: sync_id must be an int")
-    if "sync_id" not in params:
-        raise MissingParameterError("Parameter missing: sync_id")
+    if "filter_gt" in params and not isinstance(params["filter_gt"], dict):
+        raise InvalidParameterError("Bad parameter: filter_gt must be an dict")
+    if "filter_gteq" in params and not isinstance(params["filter_gteq"], dict):
+        raise InvalidParameterError(
+            "Bad parameter: filter_gteq must be an dict"
+        )
+    if "filter_lt" in params and not isinstance(params["filter_lt"], dict):
+        raise InvalidParameterError("Bad parameter: filter_lt must be an dict")
+    if "filter_lteq" in params and not isinstance(params["filter_lteq"], dict):
+        raise InvalidParameterError(
+            "Bad parameter: filter_lteq must be an dict"
+        )
     return ListObj(SyncRun, "GET", "/sync_runs", params, options)
 
 

files_sdk/models/user.py

@@ -28,6 +28,7 @@ class User:
         "disabled": None,  # boolean - Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
         "disabled_expired_or_inactive": None,  # boolean - Computed property that returns true if user disabled or expired or inactive.
         "email": None,  # email - User email address
+        "filesystem_layout": None,  # string - File system layout
         "first_login_at": None,  # date-time - User's first login time
         "ftp_permission": None,  # boolean - Can the user access with FTP/FTPS?
         "group_ids": None,  # string - Comma-separated list of group IDs of which this user is a member
@@ -49,6 +50,9 @@ class User:
         "notes": None,  # string - Any internal notes on the user
         "notification_daily_send_time": None,  # int64 - Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
         "office_integration_enabled": None,  # boolean - Enable integration with Office for the web?
+        "partner_admin": None,  # boolean - Is this user a Partner administrator?
+        "partner_id": None,  # int64 - Partner ID if this user belongs to a Partner
+        "partner_name": None,  # string - Name of the Partner if this user belongs to a Partner
         "password_set_at": None,  # date-time - Last time the user's password was set
         "password_validity_days": None,  # int64 - Number of days to allow user to use the same password
         "public_keys_count": None,  # int64 - Number of public keys associated with this user
@@ -69,6 +73,7 @@ class User:
         "sso_strategy_id": None,  # int64 - SSO (Single Sign On) strategy ID for the user, if applicable.
         "subscribe_to_newsletter": None,  # boolean - Is the user subscribed to the newsletter?
         "externally_managed": None,  # boolean - Is this user managed by a SsoStrategy?
+        "tags": None,  # string - Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
         "time_zone": None,  # string - User time zone
         "type_of_2fa": None,  # string - Type(s) of 2FA methods in use, for programmatic use.  Will be either `sms`, `totp`, `webauthn`, `yubi`, `email`, or multiple values sorted alphabetically and joined by an underscore.  Does not specify whether user has more than one of a given method.
         "type_of_2fa_for_display": None,  # string - Type(s) of 2FA methods in use, formatted for displaying in the UI.  Unlike `type_of_2fa`, this value will make clear when a user has more than 1 of the same type of method.
@@ -86,6 +91,8 @@ class User:
         "password": None,  # string - User password.
         "password_confirmation": None,  # string - Optional, but if provided, we will ensure that it matches the value sent in `password`.
         "announcements_read": None,  # boolean - Signifies that the user has read all the announcements in the UI.
+        "clear_2fa": None,  # boolean - If true when changing authentication_method from `password` to `sso`, remove all two-factor methods. Ignored in all other cases.
+        "convert_to_partner_user": None,  # boolean - If true, convert this user to a partner user by assigning the partner_id provided.
     }
 
     def __init__(self, attributes=None, options=None):
@@ -189,6 +196,7 @@ class User:
     #   bypass_site_allowed_ips - boolean - Allow this user to skip site-wide IP blacklists?
     #   dav_permission - boolean - Can the user connect with WebDAV?
     #   disabled - boolean - Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
+    #   filesystem_layout - string - File system layout
     #   ftp_permission - boolean - Can the user access with FTP/FTPS?
     #   header_text - string - Text to display to the user in the header of the UI
     #   language - string - Preferred language
@@ -197,6 +205,8 @@ class User:
     #   company - string - User's company
     #   notes - string - Any internal notes on the user
     #   office_integration_enabled - boolean - Enable integration with Office for the web?
+    #   partner_admin - boolean - Is this user a Partner administrator?
+    #   partner_id - int64 - Partner ID if this user belongs to a Partner
     #   password_validity_days - int64 - Number of days to allow user to use the same password
     #   readonly_site_admin - boolean - Is the user an allowed to view all (non-billing) site configuration for this site?
     #   receive_admin_alerts - boolean - Should the user receive admin alerts such a certificate expiration notifications and overages?
@@ -211,10 +221,13 @@ class User:
     #   sso_strategy_id - int64 - SSO (Single Sign On) strategy ID for the user, if applicable.
     #   subscribe_to_newsletter - boolean - Is the user subscribed to the newsletter?
     #   require_2fa - string - 2FA required setting
+    #   tags - string - Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
     #   time_zone - string - User time zone
     #   user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set).  Note that this is not used for API, Desktop, or Web interface.
     #   user_home - string - Home folder for FTP/SFTP.  Note that this is not used for API, Desktop, or Web interface.
     #   username - string - User's username
+    #   clear_2fa - boolean - If true when changing authentication_method from `password` to `sso`, remove all two-factor methods. Ignored in all other cases.
+    #   convert_to_partner_user - boolean - If true, convert this user to a partner user by assigning the partner_id provided.
     def update(self, params=None):
         if not isinstance(params, dict):
             params = {}
@@ -289,6 +302,12 @@ class User:
             raise InvalidParameterError(
                 "Bad parameter: authentication_method must be an str"
             )
+        if "filesystem_layout" in params and not isinstance(
+            params["filesystem_layout"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: filesystem_layout must be an str"
+            )
         if "header_text" in params and not isinstance(
             params["header_text"], str
         ):
@@ -313,6 +332,12 @@ class User:
             )
         if "notes" in params and not isinstance(params["notes"], str):
             raise InvalidParameterError("Bad parameter: notes must be an str")
+        if "partner_id" in params and not isinstance(
+            params["partner_id"], int
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: partner_id must be an int"
+            )
         if "password_validity_days" in params and not isinstance(
             params["password_validity_days"], int
         ):
@@ -343,6 +368,8 @@ class User:
             raise InvalidParameterError(
                 "Bad parameter: require_2fa must be an str"
             )
+        if "tags" in params and not isinstance(params["tags"], str):
+            raise InvalidParameterError("Bad parameter: tags must be an str")
         if "time_zone" in params and not isinstance(params["time_zone"], str):
             raise InvalidParameterError(
                 "Bad parameter: time_zone must be an str"
@@ -411,11 +438,11 @@ class User:
 # 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`, `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `name`, `company`, `password_validity_days`, `ssl_required`, `username` or `site_admin`.
-#   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ site_admin, username ]`, `[ not_site_admin, username ]` or `[ company, name ]`.
+#   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `name`, `company`, `password_validity_days`, `ssl_required`, `username`, `site_admin` or `disabled`.
+#   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until`, `not_site_admin`, `disabled` or `partner_id`. Valid field combinations are `[ site_admin, username ]`.
 #   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
 #   filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
-#   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `username`, `name`, `email` or `company`. Valid field combinations are `[ company, name ]`.
+#   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `username`, `name`, `email` or `company`.
 #   filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
 #   filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
 #   ids - string - comma-separated list of User IDs
@@ -513,6 +540,7 @@ def get(id, params=None, options=None):
 #   bypass_site_allowed_ips - boolean - Allow this user to skip site-wide IP blacklists?
 #   dav_permission - boolean - Can the user connect with WebDAV?
 #   disabled - boolean - Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
+#   filesystem_layout - string - File system layout
 #   ftp_permission - boolean - Can the user access with FTP/FTPS?
 #   header_text - string - Text to display to the user in the header of the UI
 #   language - string - Preferred language
@@ -521,6 +549,8 @@ def get(id, params=None, options=None):
 #   company - string - User's company
 #   notes - string - Any internal notes on the user
 #   office_integration_enabled - boolean - Enable integration with Office for the web?
+#   partner_admin - boolean - Is this user a Partner administrator?
+#   partner_id - int64 - Partner ID if this user belongs to a Partner
 #   password_validity_days - int64 - Number of days to allow user to use the same password
 #   readonly_site_admin - boolean - Is the user an allowed to view all (non-billing) site configuration for this site?
 #   receive_admin_alerts - boolean - Should the user receive admin alerts such a certificate expiration notifications and overages?
@@ -535,6 +565,7 @@ def get(id, params=None, options=None):
 #   sso_strategy_id - int64 - SSO (Single Sign On) strategy ID for the user, if applicable.
 #   subscribe_to_newsletter - boolean - Is the user subscribed to the newsletter?
 #   require_2fa - string - 2FA required setting
+#   tags - string - Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
 #   time_zone - string - User time zone
 #   user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set).  Note that this is not used for API, Desktop, or Web interface.
 #   user_home - string - Home folder for FTP/SFTP.  Note that this is not used for API, Desktop, or Web interface.
@@ -642,6 +673,12 @@ def create(params=None, options=None):
         )
     if "disabled" in params and not isinstance(params["disabled"], bool):
         raise InvalidParameterError("Bad parameter: disabled must be an bool")
+    if "filesystem_layout" in params and not isinstance(
+        params["filesystem_layout"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: filesystem_layout must be an str"
+        )
     if "ftp_permission" in params and not isinstance(
         params["ftp_permission"], bool
     ):
@@ -672,6 +709,14 @@ def create(params=None, options=None):
         raise InvalidParameterError(
             "Bad parameter: office_integration_enabled must be an bool"
         )
+    if "partner_admin" in params and not isinstance(
+        params["partner_admin"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: partner_admin must be an bool"
+        )
+    if "partner_id" in params and not isinstance(params["partner_id"], int):
+        raise InvalidParameterError("Bad parameter: partner_id must be an int")
     if "password_validity_days" in params and not isinstance(
         params["password_validity_days"], int
     ):
@@ -752,6 +797,8 @@ def create(params=None, options=None):
         raise InvalidParameterError(
             "Bad parameter: require_2fa must be an str"
         )
+    if "tags" in params and not isinstance(params["tags"], str):
+        raise InvalidParameterError("Bad parameter: tags must be an str")
     if "time_zone" in params and not isinstance(params["time_zone"], str):
         raise InvalidParameterError("Bad parameter: time_zone must be an str")
     if "user_root" in params and not isinstance(params["user_root"], str):
@@ -842,6 +889,7 @@ def user_2fa_reset(id, params=None, options=None):
 #   bypass_site_allowed_ips - boolean - Allow this user to skip site-wide IP blacklists?
 #   dav_permission - boolean - Can the user connect with WebDAV?
 #   disabled - boolean - Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
+#   filesystem_layout - string - File system layout
 #   ftp_permission - boolean - Can the user access with FTP/FTPS?
 #   header_text - string - Text to display to the user in the header of the UI
 #   language - string - Preferred language
@@ -850,6 +898,8 @@ def user_2fa_reset(id, params=None, options=None):
 #   company - string - User's company
 #   notes - string - Any internal notes on the user
 #   office_integration_enabled - boolean - Enable integration with Office for the web?
+#   partner_admin - boolean - Is this user a Partner administrator?
+#   partner_id - int64 - Partner ID if this user belongs to a Partner
 #   password_validity_days - int64 - Number of days to allow user to use the same password
 #   readonly_site_admin - boolean - Is the user an allowed to view all (non-billing) site configuration for this site?
 #   receive_admin_alerts - boolean - Should the user receive admin alerts such a certificate expiration notifications and overages?
@@ -864,10 +914,13 @@ def user_2fa_reset(id, params=None, options=None):
 #   sso_strategy_id - int64 - SSO (Single Sign On) strategy ID for the user, if applicable.
 #   subscribe_to_newsletter - boolean - Is the user subscribed to the newsletter?
 #   require_2fa - string - 2FA required setting
+#   tags - string - Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
 #   time_zone - string - User time zone
 #   user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set).  Note that this is not used for API, Desktop, or Web interface.
 #   user_home - string - Home folder for FTP/SFTP.  Note that this is not used for API, Desktop, or Web interface.
 #   username - string - User's username
+#   clear_2fa - boolean - If true when changing authentication_method from `password` to `sso`, remove all two-factor methods. Ignored in all other cases.
+#   convert_to_partner_user - boolean - If true, convert this user to a partner user by assigning the partner_id provided.
 def update(id, params=None, options=None):
     if not isinstance(params, dict):
         params = {}
@@ -974,6 +1027,12 @@ def update(id, params=None, options=None):
         )
     if "disabled" in params and not isinstance(params["disabled"], bool):
         raise InvalidParameterError("Bad parameter: disabled must be an bool")
+    if "filesystem_layout" in params and not isinstance(
+        params["filesystem_layout"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: filesystem_layout must be an str"
+        )
     if "ftp_permission" in params and not isinstance(
         params["ftp_permission"], bool
     ):
@@ -1004,6 +1063,14 @@ def update(id, params=None, options=None):
         raise InvalidParameterError(
             "Bad parameter: office_integration_enabled must be an bool"
         )
+    if "partner_admin" in params and not isinstance(
+        params["partner_admin"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: partner_admin must be an bool"
+        )
+    if "partner_id" in params and not isinstance(params["partner_id"], int):
+        raise InvalidParameterError("Bad parameter: partner_id must be an int")
     if "password_validity_days" in params and not isinstance(
         params["password_validity_days"], int
     ):
@@ -1084,6 +1151,8 @@ def update(id, params=None, options=None):
         raise InvalidParameterError(
             "Bad parameter: require_2fa must be an str"
         )
+    if "tags" in params and not isinstance(params["tags"], str):
+        raise InvalidParameterError("Bad parameter: tags must be an str")
     if "time_zone" in params and not isinstance(params["time_zone"], str):
         raise InvalidParameterError("Bad parameter: time_zone must be an str")
     if "user_root" in params and not isinstance(params["user_root"], str):
@@ -1092,6 +1161,14 @@ def update(id, params=None, options=None):
         raise InvalidParameterError("Bad parameter: user_home must be an str")
     if "username" in params and not isinstance(params["username"], str):
         raise InvalidParameterError("Bad parameter: username must be an str")
+    if "clear_2fa" in params and not isinstance(params["clear_2fa"], bool):
+        raise InvalidParameterError("Bad parameter: clear_2fa must be an bool")
+    if "convert_to_partner_user" in params and not isinstance(
+        params["convert_to_partner_user"], bool
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: convert_to_partner_user must be an bool"
+        )
     if "id" not in params:
         raise MissingParameterError("Parameter missing: id")
     response, options = Api.send_request(

files_sdk/models/user_cipher_use.py

@@ -11,12 +11,13 @@ from files_sdk.error import (  # noqa: F401
 class UserCipherUse:
     default_attributes = {
         "id": None,  # int64 - UserCipherUse ID
+        "user_id": None,  # int64 - ID of the user who performed this access
+        "username": None,  # string - Username of the user who performed this access
         "protocol_cipher": None,  # string - The protocol and cipher employed
         "created_at": None,  # date-time - The earliest recorded use of this combination of interface and protocol and cipher (for this user)
         "insecure": None,  # boolean - Is this cipher considered insecure?
         "interface": None,  # string - The interface accessed
         "updated_at": None,  # date-time - The most recent use of this combination of interface and protocol and cipher (for this user)
-        "user_id": None,  # int64 - ID of the user who performed this access
     }
 
     def __init__(self, attributes=None, options=None):
@@ -46,6 +47,12 @@ class UserCipherUse:
 #   user_id - int64 - User ID. If provided, will return uses for this user.
 #   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 `updated_at`.
+#   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `insecure` and `updated_at`. Valid field combinations are `[ insecure, updated_at ]`.
+#   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `updated_at`.
+#   filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `updated_at`.
+#   filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `updated_at`.
+#   filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `updated_at`.
 def list(params=None, options=None):
     if not isinstance(params, dict):
         params = {}
@@ -57,6 +64,22 @@ 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")
+    if "filter" in params and not isinstance(params["filter"], dict):
+        raise InvalidParameterError("Bad parameter: filter must be an dict")
+    if "filter_gt" in params and not isinstance(params["filter_gt"], dict):
+        raise InvalidParameterError("Bad parameter: filter_gt must be an dict")
+    if "filter_gteq" in params and not isinstance(params["filter_gteq"], dict):
+        raise InvalidParameterError(
+            "Bad parameter: filter_gteq must be an dict"
+        )
+    if "filter_lt" in params and not isinstance(params["filter_lt"], dict):
+        raise InvalidParameterError("Bad parameter: filter_lt must be an dict")
+    if "filter_lteq" in params and not isinstance(params["filter_lteq"], dict):
+        raise InvalidParameterError(
+            "Bad parameter: filter_lteq must be an dict"
+        )
     return ListObj(UserCipherUse, "GET", "/user_cipher_uses", params, options)
 
 

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"]),