files-com 1.5.0__py3-none-any.whl

files_sdk/models/user.py

@@ -0,0 +1,893 @@
+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 User:
+    default_attributes = {
+        "id": None,  # int64 - User ID
+        "username": None,  # string - User's username
+        "admin_group_ids": None,  # array(int64) - List of group IDs of which this user is an administrator
+        "allowed_ips": None,  # string - A list of allowed IPs if applicable.  Newline delimited
+        "attachments_permission": None,  # boolean - If `true`, the user can user create Bundles (aka Share Links). Use the bundle permission instead.
+        "api_keys_count": None,  # int64 - Number of API keys associated with this user
+        "authenticate_until": None,  # date-time - Scheduled Date/Time at which user will be deactivated
+        "authentication_method": None,  # string - How is this user authenticated?
+        "avatar_url": None,  # string - URL holding the user's avatar
+        "billable": None,  # boolean - Is this a billable user record?
+        "billing_permission": None,  # boolean - Allow this user to perform operations on the account, payments, and invoices?
+        "bypass_site_allowed_ips": None,  # boolean - Allow this user to skip site-wide IP blacklists?
+        "bypass_inactive_disable": None,  # boolean - Exempt this user from being disabled based on inactivity?
+        "created_at": None,  # date-time - When this user was created
+        "dav_permission": None,  # boolean - Can the user connect with WebDAV?
+        "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
+        "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
+        "header_text": None,  # string - Text to display to the user in the header of the UI
+        "language": None,  # string - Preferred language
+        "last_login_at": None,  # date-time - User's most recent login time via any protocol
+        "last_web_login_at": None,  # date-time - User's most recent login time via web
+        "last_ftp_login_at": None,  # date-time - User's most recent login time via FTP
+        "last_sftp_login_at": None,  # date-time - User's most recent login time via SFTP
+        "last_dav_login_at": None,  # date-time - User's most recent login time via WebDAV
+        "last_desktop_login_at": None,  # date-time - User's most recent login time via Desktop app
+        "last_restapi_login_at": None,  # date-time - User's most recent login time via Rest API
+        "last_api_use_at": None,  # date-time - User's most recent API use time
+        "last_active_at": None,  # date-time - User's most recent activity time, which is the latest of most recent login, most recent API use, enablement, or creation
+        "last_protocol_cipher": None,  # string - The most recent protocol and cipher used
+        "lockout_expires": None,  # date-time - Time in the future that the user will no longer be locked out if applicable
+        "name": None,  # string - User's full name
+        "company": None,  # string - User's company
+        "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?
+        "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
+        "receive_admin_alerts": None,  # boolean - Should the user receive admin alerts such a certificate expiration notifications and overages?
+        "require_2fa": None,  # string - 2FA required setting
+        "require_login_by": None,  # date-time - Require user to login by specified date otherwise it will be disabled.
+        "active_2fa": None,  # boolean - Is 2fa active for the user?
+        "require_password_change": None,  # boolean - Is a password change required upon next user login?
+        "password_expired": None,  # boolean - Is user's password expired?
+        "readonly_site_admin": None,  # boolean - Is the user an allowed to view all (non-billing) site configuration for this site?
+        "restapi_permission": None,  # boolean - Can this user access the Web app, Desktop app, SDKs, or REST API?  (All of these tools use the API internally, so this is one unified permission set.)
+        "self_managed": None,  # boolean - Does this user manage it's own credentials or is it a shared/bot user?
+        "sftp_permission": None,  # boolean - Can the user access with SFTP?
+        "site_admin": None,  # boolean - Is the user an administrator for this site?
+        "site_id": None,  # int64 - Site ID
+        "skip_welcome_screen": None,  # boolean - Skip Welcome page in the UI?
+        "ssl_required": None,  # string - SSL required setting
+        "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?
+        "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.
+        "user_root": None,  # 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": None,  # string - Home folder for FTP/SFTP.  Note that this is not used for API, Desktop, or Web interface.
+        "days_remaining_until_password_expire": None,  # int64 - Number of days remaining until password expires
+        "password_expire_at": None,  # date-time - Password expiration datetime
+        "avatar_file": None,  # file - An image file for your user avatar.
+        "avatar_delete": None,  # boolean - If true, the avatar will be deleted.
+        "change_password": None,  # string - Used for changing a password on an existing user.
+        "change_password_confirmation": None,  # string - Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
+        "grant_permission": None,  # string - Permission to grant on the User Root upon user creation. Can be blank or `full`, `read`, `write`, `list`, `read+write`, or `list+write`
+        "group_id": None,  # int64 - Group ID to associate this user with.
+        "imported_password_hash": None,  # string - Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
+        "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.
+    }
+
+    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 User.default_attributes.items():
+            setattr(self, attribute, attributes.get(attribute, default_value))
+
+    def get_attributes(self):
+        return {
+            k: getattr(self, k, None)
+            for k in User.default_attributes
+            if getattr(self, k, None) is not None
+        }
+
+    # Unlock user who has been locked out due to failed logins
+    def unlock(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(
+            "POST",
+            "/users/{id}/unlock".format(id=params["id"]),
+            params,
+            self.options,
+        )
+
+    # Resend user welcome email
+    def resend_welcome_email(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(
+            "POST",
+            "/users/{id}/resend_welcome_email".format(id=params["id"]),
+            params,
+            self.options,
+        )
+
+    # Trigger 2FA Reset process for user who has lost access to their existing 2FA methods
+    def user_2fa_reset(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(
+            "POST",
+            "/users/{id}/2fa/reset".format(id=params["id"]),
+            params,
+            self.options,
+        )
+
+    # Parameters:
+    #   avatar_file - file - An image file for your user avatar.
+    #   avatar_delete - boolean - If true, the avatar will be deleted.
+    #   change_password - string - Used for changing a password on an existing user.
+    #   change_password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
+    #   email - string - User's email.
+    #   grant_permission - string - Permission to grant on the User Root upon user creation. Can be blank or `full`, `read`, `write`, `list`, `read+write`, or `list+write`
+    #   group_id - int64 - Group ID to associate this user with.
+    #   group_ids - string - A list of group ids to associate this user with.  Comma delimited.
+    #   imported_password_hash - string - Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
+    #   password - string - User password.
+    #   password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `password`.
+    #   announcements_read - boolean - Signifies that the user has read all the announcements in the UI.
+    #   allowed_ips - string - A list of allowed IPs if applicable.  Newline delimited
+    #   attachments_permission - boolean - DEPRECATED: If `true`, the user can user create Bundles (aka Share Links). Use the bundle permission instead.
+    #   authenticate_until - string - Scheduled Date/Time at which user will be deactivated
+    #   authentication_method - string - How is this user authenticated?
+    #   billing_permission - boolean - Allow this user to perform operations on the account, payments, and invoices?
+    #   bypass_inactive_disable - boolean - Exempt this user from being disabled based on inactivity?
+    #   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.
+    #   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
+    #   notification_daily_send_time - int64 - Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
+    #   name - string - User's full name
+    #   company - string - User's company
+    #   notes - string - Any internal notes on the user
+    #   office_integration_enabled - boolean - Enable integration with Office for the web?
+    #   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?
+    #   require_login_by - string - Require user to login by specified date otherwise it will be disabled.
+    #   require_password_change - boolean - Is a password change required upon next user login?
+    #   restapi_permission - boolean - Can this user access the Web app, Desktop app, SDKs, or REST API?  (All of these tools use the API internally, so this is one unified permission set.)
+    #   self_managed - boolean - Does this user manage it's own credentials or is it a shared/bot user?
+    #   sftp_permission - boolean - Can the user access with SFTP?
+    #   site_admin - boolean - Is the user an administrator for this site?
+    #   skip_welcome_screen - boolean - Skip Welcome page in the UI?
+    #   ssl_required - string - SSL required setting
+    #   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
+    #   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
+    def update(self, params=None):
+        if not isinstance(params, dict):
+            params = {}
+
+        if hasattr(self, "id") and self.id:
+            params["id"] = self.id
+        else:
+            raise MissingParameterError("Current object doesn't have a id")
+        if "id" not in params:
+            raise MissingParameterError("Parameter missing: id")
+        if "id" in params and not isinstance(params["id"], int):
+            raise InvalidParameterError("Bad parameter: id must be an int")
+        if "change_password" in params and not isinstance(
+            params["change_password"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: change_password must be an str"
+            )
+        if "change_password_confirmation" in params and not isinstance(
+            params["change_password_confirmation"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: change_password_confirmation must be an str"
+            )
+        if "email" in params and not isinstance(params["email"], str):
+            raise InvalidParameterError("Bad parameter: email must be an str")
+        if "grant_permission" in params and not isinstance(
+            params["grant_permission"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: grant_permission must be an str"
+            )
+        if "group_id" in params and not isinstance(params["group_id"], int):
+            raise InvalidParameterError(
+                "Bad parameter: group_id must be an int"
+            )
+        if "group_ids" in params and not isinstance(params["group_ids"], str):
+            raise InvalidParameterError(
+                "Bad parameter: group_ids must be an str"
+            )
+        if "imported_password_hash" in params and not isinstance(
+            params["imported_password_hash"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: imported_password_hash must be an str"
+            )
+        if "password" in params and not isinstance(params["password"], str):
+            raise InvalidParameterError(
+                "Bad parameter: password must be an str"
+            )
+        if "password_confirmation" in params and not isinstance(
+            params["password_confirmation"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: password_confirmation must be an str"
+            )
+        if "allowed_ips" in params and not isinstance(
+            params["allowed_ips"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: allowed_ips must be an str"
+            )
+        if "authenticate_until" in params and not isinstance(
+            params["authenticate_until"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: authenticate_until 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 "header_text" in params and not isinstance(
+            params["header_text"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: header_text must be an str"
+            )
+        if "language" in params and not isinstance(params["language"], str):
+            raise InvalidParameterError(
+                "Bad parameter: language must be an str"
+            )
+        if "notification_daily_send_time" in params and not isinstance(
+            params["notification_daily_send_time"], int
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: notification_daily_send_time must be an int"
+            )
+        if "name" in params and not isinstance(params["name"], str):
+            raise InvalidParameterError("Bad parameter: name must be an str")
+        if "company" in params and not isinstance(params["company"], str):
+            raise InvalidParameterError(
+                "Bad parameter: company must be an str"
+            )
+        if "notes" in params and not isinstance(params["notes"], str):
+            raise InvalidParameterError("Bad parameter: notes must be an str")
+        if "password_validity_days" in params and not isinstance(
+            params["password_validity_days"], int
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: password_validity_days must be an int"
+            )
+        if "require_login_by" in params and not isinstance(
+            params["require_login_by"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: require_login_by must be an str"
+            )
+        if "ssl_required" in params and not isinstance(
+            params["ssl_required"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: ssl_required must be an str"
+            )
+        if "sso_strategy_id" in params and not isinstance(
+            params["sso_strategy_id"], int
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: sso_strategy_id must be an int"
+            )
+        if "require_2fa" in params and not isinstance(
+            params["require_2fa"], str
+        ):
+            raise InvalidParameterError(
+                "Bad parameter: require_2fa 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):
+            raise InvalidParameterError(
+                "Bad parameter: user_root must be an str"
+            )
+        if "user_home" in params and not isinstance(params["user_home"], str):
+            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"
+            )
+        response, _options = Api.send_request(
+            "PATCH",
+            "/users/{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",
+            "/users/{id}".format(id=params["id"]),
+            params,
+            self.options,
+        )
+
+    def destroy(self, params=None):
+        self.delete(params)
+
+    def save(self):
+        if hasattr(self, "id") and self.id:
+            new_obj = self.update(self.get_attributes())
+            self.set_attributes(new_obj.get_attributes())
+            return True
+        else:
+            new_obj = create(self.get_attributes(), self.options)
+            self.set_attributes(new_obj.get_attributes())
+            return True
+
+
+# Parameters:
+#   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
+#   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+#   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `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 ]`.
+#   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_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
+#   include_parent_site_users - boolean - Include users from the parent site.
+#   search - string - Searches for partial matches of name, username, or email.
+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")
+    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_prefix" in params and not isinstance(
+        params["filter_prefix"], dict
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: filter_prefix 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"
+        )
+    if "ids" in params and not isinstance(params["ids"], str):
+        raise InvalidParameterError("Bad parameter: ids must be an str")
+    if "search" in params and not isinstance(params["search"], str):
+        raise InvalidParameterError("Bad parameter: search must be an str")
+    return ListObj(User, "GET", "/users", params, options)
+
+
+def all(params=None, options=None):
+    list(params, options)
+
+
+# Parameters:
+#   id (required) - int64 - User 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", "/users/{id}".format(id=params["id"]), params, options
+    )
+    return User(response.data, options)
+
+
+def get(id, params=None, options=None):
+    find(id, params, options)
+
+
+# Parameters:
+#   avatar_file - file - An image file for your user avatar.
+#   avatar_delete - boolean - If true, the avatar will be deleted.
+#   change_password - string - Used for changing a password on an existing user.
+#   change_password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
+#   email - string - User's email.
+#   grant_permission - string - Permission to grant on the User Root upon user creation. Can be blank or `full`, `read`, `write`, `list`, `read+write`, or `list+write`
+#   group_id - int64 - Group ID to associate this user with.
+#   group_ids - string - A list of group ids to associate this user with.  Comma delimited.
+#   imported_password_hash - string - Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
+#   password - string - User password.
+#   password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `password`.
+#   announcements_read - boolean - Signifies that the user has read all the announcements in the UI.
+#   allowed_ips - string - A list of allowed IPs if applicable.  Newline delimited
+#   attachments_permission - boolean - DEPRECATED: If `true`, the user can user create Bundles (aka Share Links). Use the bundle permission instead.
+#   authenticate_until - string - Scheduled Date/Time at which user will be deactivated
+#   authentication_method - string - How is this user authenticated?
+#   billing_permission - boolean - Allow this user to perform operations on the account, payments, and invoices?
+#   bypass_inactive_disable - boolean - Exempt this user from being disabled based on inactivity?
+#   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.
+#   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
+#   notification_daily_send_time - int64 - Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
+#   name - string - User's full name
+#   company - string - User's company
+#   notes - string - Any internal notes on the user
+#   office_integration_enabled - boolean - Enable integration with Office for the web?
+#   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?
+#   require_login_by - string - Require user to login by specified date otherwise it will be disabled.
+#   require_password_change - boolean - Is a password change required upon next user login?
+#   restapi_permission - boolean - Can this user access the Web app, Desktop app, SDKs, or REST API?  (All of these tools use the API internally, so this is one unified permission set.)
+#   self_managed - boolean - Does this user manage it's own credentials or is it a shared/bot user?
+#   sftp_permission - boolean - Can the user access with SFTP?
+#   site_admin - boolean - Is the user an administrator for this site?
+#   skip_welcome_screen - boolean - Skip Welcome page in the UI?
+#   ssl_required - string - SSL required setting
+#   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
+#   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 (required) - string - User's username
+def create(params=None, options=None):
+    if not isinstance(params, dict):
+        params = {}
+    if not isinstance(options, dict):
+        options = {}
+    if "change_password" in params and not isinstance(
+        params["change_password"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: change_password must be an str"
+        )
+    if "change_password_confirmation" in params and not isinstance(
+        params["change_password_confirmation"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: change_password_confirmation must be an str"
+        )
+    if "email" in params and not isinstance(params["email"], str):
+        raise InvalidParameterError("Bad parameter: email must be an str")
+    if "grant_permission" in params and not isinstance(
+        params["grant_permission"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: grant_permission must be an str"
+        )
+    if "group_id" in params and not isinstance(params["group_id"], int):
+        raise InvalidParameterError("Bad parameter: group_id must be an int")
+    if "group_ids" in params and not isinstance(params["group_ids"], str):
+        raise InvalidParameterError("Bad parameter: group_ids must be an str")
+    if "imported_password_hash" in params and not isinstance(
+        params["imported_password_hash"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: imported_password_hash must be an str"
+        )
+    if "password" in params and not isinstance(params["password"], str):
+        raise InvalidParameterError("Bad parameter: password must be an str")
+    if "password_confirmation" in params and not isinstance(
+        params["password_confirmation"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: password_confirmation must be an str"
+        )
+    if "allowed_ips" in params and not isinstance(params["allowed_ips"], str):
+        raise InvalidParameterError(
+            "Bad parameter: allowed_ips must be an str"
+        )
+    if "authenticate_until" in params and not isinstance(
+        params["authenticate_until"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: authenticate_until 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 "header_text" in params and not isinstance(params["header_text"], str):
+        raise InvalidParameterError(
+            "Bad parameter: header_text must be an str"
+        )
+    if "language" in params and not isinstance(params["language"], str):
+        raise InvalidParameterError("Bad parameter: language must be an str")
+    if "notification_daily_send_time" in params and not isinstance(
+        params["notification_daily_send_time"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: notification_daily_send_time must be an int"
+        )
+    if "name" in params and not isinstance(params["name"], str):
+        raise InvalidParameterError("Bad parameter: name must be an str")
+    if "company" in params and not isinstance(params["company"], str):
+        raise InvalidParameterError("Bad parameter: company must be an str")
+    if "notes" in params and not isinstance(params["notes"], str):
+        raise InvalidParameterError("Bad parameter: notes must be an str")
+    if "password_validity_days" in params and not isinstance(
+        params["password_validity_days"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: password_validity_days must be an int"
+        )
+    if "require_login_by" in params and not isinstance(
+        params["require_login_by"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: require_login_by must be an str"
+        )
+    if "ssl_required" in params and not isinstance(
+        params["ssl_required"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: ssl_required must be an str"
+        )
+    if "sso_strategy_id" in params and not isinstance(
+        params["sso_strategy_id"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: sso_strategy_id must be an int"
+        )
+    if "require_2fa" in params and not isinstance(params["require_2fa"], str):
+        raise InvalidParameterError(
+            "Bad parameter: require_2fa 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):
+        raise InvalidParameterError("Bad parameter: user_root must be an str")
+    if "user_home" in params and not isinstance(params["user_home"], str):
+        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 "username" not in params:
+        raise MissingParameterError("Parameter missing: username")
+    response, options = Api.send_request("POST", "/users", params, options)
+    return User(response.data, options)
+
+
+# Unlock user who has been locked out due to failed logins
+def unlock(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(
+        "POST", "/users/{id}/unlock".format(id=params["id"]), params, options
+    )
+
+
+# Resend user welcome email
+def resend_welcome_email(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(
+        "POST",
+        "/users/{id}/resend_welcome_email".format(id=params["id"]),
+        params,
+        options,
+    )
+
+
+# Trigger 2FA Reset process for user who has lost access to their existing 2FA methods
+def user_2fa_reset(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(
+        "POST",
+        "/users/{id}/2fa/reset".format(id=params["id"]),
+        params,
+        options,
+    )
+
+
+# Parameters:
+#   avatar_file - file - An image file for your user avatar.
+#   avatar_delete - boolean - If true, the avatar will be deleted.
+#   change_password - string - Used for changing a password on an existing user.
+#   change_password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
+#   email - string - User's email.
+#   grant_permission - string - Permission to grant on the User Root upon user creation. Can be blank or `full`, `read`, `write`, `list`, `read+write`, or `list+write`
+#   group_id - int64 - Group ID to associate this user with.
+#   group_ids - string - A list of group ids to associate this user with.  Comma delimited.
+#   imported_password_hash - string - Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
+#   password - string - User password.
+#   password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `password`.
+#   announcements_read - boolean - Signifies that the user has read all the announcements in the UI.
+#   allowed_ips - string - A list of allowed IPs if applicable.  Newline delimited
+#   attachments_permission - boolean - DEPRECATED: If `true`, the user can user create Bundles (aka Share Links). Use the bundle permission instead.
+#   authenticate_until - string - Scheduled Date/Time at which user will be deactivated
+#   authentication_method - string - How is this user authenticated?
+#   billing_permission - boolean - Allow this user to perform operations on the account, payments, and invoices?
+#   bypass_inactive_disable - boolean - Exempt this user from being disabled based on inactivity?
+#   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.
+#   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
+#   notification_daily_send_time - int64 - Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
+#   name - string - User's full name
+#   company - string - User's company
+#   notes - string - Any internal notes on the user
+#   office_integration_enabled - boolean - Enable integration with Office for the web?
+#   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?
+#   require_login_by - string - Require user to login by specified date otherwise it will be disabled.
+#   require_password_change - boolean - Is a password change required upon next user login?
+#   restapi_permission - boolean - Can this user access the Web app, Desktop app, SDKs, or REST API?  (All of these tools use the API internally, so this is one unified permission set.)
+#   self_managed - boolean - Does this user manage it's own credentials or is it a shared/bot user?
+#   sftp_permission - boolean - Can the user access with SFTP?
+#   site_admin - boolean - Is the user an administrator for this site?
+#   skip_welcome_screen - boolean - Skip Welcome page in the UI?
+#   ssl_required - string - SSL required setting
+#   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
+#   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
+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 "change_password" in params and not isinstance(
+        params["change_password"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: change_password must be an str"
+        )
+    if "change_password_confirmation" in params and not isinstance(
+        params["change_password_confirmation"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: change_password_confirmation must be an str"
+        )
+    if "email" in params and not isinstance(params["email"], str):
+        raise InvalidParameterError("Bad parameter: email must be an str")
+    if "grant_permission" in params and not isinstance(
+        params["grant_permission"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: grant_permission must be an str"
+        )
+    if "group_id" in params and not isinstance(params["group_id"], int):
+        raise InvalidParameterError("Bad parameter: group_id must be an int")
+    if "group_ids" in params and not isinstance(params["group_ids"], str):
+        raise InvalidParameterError("Bad parameter: group_ids must be an str")
+    if "imported_password_hash" in params and not isinstance(
+        params["imported_password_hash"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: imported_password_hash must be an str"
+        )
+    if "password" in params and not isinstance(params["password"], str):
+        raise InvalidParameterError("Bad parameter: password must be an str")
+    if "password_confirmation" in params and not isinstance(
+        params["password_confirmation"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: password_confirmation must be an str"
+        )
+    if "allowed_ips" in params and not isinstance(params["allowed_ips"], str):
+        raise InvalidParameterError(
+            "Bad parameter: allowed_ips must be an str"
+        )
+    if "authenticate_until" in params and not isinstance(
+        params["authenticate_until"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: authenticate_until 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 "header_text" in params and not isinstance(params["header_text"], str):
+        raise InvalidParameterError(
+            "Bad parameter: header_text must be an str"
+        )
+    if "language" in params and not isinstance(params["language"], str):
+        raise InvalidParameterError("Bad parameter: language must be an str")
+    if "notification_daily_send_time" in params and not isinstance(
+        params["notification_daily_send_time"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: notification_daily_send_time must be an int"
+        )
+    if "name" in params and not isinstance(params["name"], str):
+        raise InvalidParameterError("Bad parameter: name must be an str")
+    if "company" in params and not isinstance(params["company"], str):
+        raise InvalidParameterError("Bad parameter: company must be an str")
+    if "notes" in params and not isinstance(params["notes"], str):
+        raise InvalidParameterError("Bad parameter: notes must be an str")
+    if "password_validity_days" in params and not isinstance(
+        params["password_validity_days"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: password_validity_days must be an int"
+        )
+    if "require_login_by" in params and not isinstance(
+        params["require_login_by"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: require_login_by must be an str"
+        )
+    if "ssl_required" in params and not isinstance(
+        params["ssl_required"], str
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: ssl_required must be an str"
+        )
+    if "sso_strategy_id" in params and not isinstance(
+        params["sso_strategy_id"], int
+    ):
+        raise InvalidParameterError(
+            "Bad parameter: sso_strategy_id must be an int"
+        )
+    if "require_2fa" in params and not isinstance(params["require_2fa"], str):
+        raise InvalidParameterError(
+            "Bad parameter: require_2fa 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):
+        raise InvalidParameterError("Bad parameter: user_root must be an str")
+    if "user_home" in params and not isinstance(params["user_home"], str):
+        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 "id" not in params:
+        raise MissingParameterError("Parameter missing: id")
+    response, options = Api.send_request(
+        "PATCH", "/users/{id}".format(id=params["id"]), params, options
+    )
+    return User(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", "/users/{id}".format(id=params["id"]), params, options
+    )
+
+
+def destroy(id, params=None, options=None):
+    delete(id, params, options)
+
+
+def new(*args, **kwargs):
+    return User(*args, **kwargs)