rocketchat-API 3.7.1__tar.gz → 3.8.0__tar.gz

{rocketchat_api-3.7.1 → rocketchat_api-3.8.0}/.github/actions/test_rocketchat/action.yml

@@ -4,7 +4,7 @@ description: 'Run tests on the Rocket.Chat server'
 inputs:
   python-version:
     description: 'The version of Python to use'
-    default: '3.14'
+    default: '3.15'
     required: true
   rocket-chat-version:
     description: 'The version of Rocket.Chat to use'
@@ -35,7 +35,7 @@ runs:
       run: pip install .[test]
     - name: Wait for rocket.chat server to be online
       shell: bash
-      run: until curl --silent http://localhost:3000/api/info/; do sleep 15; echo "waiting for Rocket.Chat server to start"; done;
+      run: until curl --silent http://localhost:3000/api/info; do sleep 15; echo "waiting for Rocket.Chat server to start"; done;
     - name: Run tests
       shell: bash
       run: pytest tests rocketchat_API --cov-report xml --cov=./

{rocketchat_api-3.7.1 → rocketchat_api-3.8.0}/.github/workflows/lint.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v7
         with:
-          python-version: "3.14"
+          python-version: "3.15"
       - name: Install black
         run: |
           pip install black

{rocketchat_api-3.7.1 → rocketchat_api-3.8.0}/.github/workflows/release.yml

@@ -15,10 +15,10 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v7.0.1
-      - name: Set up Python 3.14
+      - name: Set up Python 3.15
         uses: actions/setup-python@v7
         with:
-          python-version: '3.14'
+          python-version: '3.15'
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip

{rocketchat_api-3.7.1 → rocketchat_api-3.8.0}/.github/workflows/test.yml

@@ -14,8 +14,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [ '3.10', '3.11', '3.12', '3.13', '3.14' ]
-        rocket-chat-version: [ '8.1.7', '8.2.7', '8.3.7', '8.4.5', '8.5.2', '8.6.1', '8.7.0']
+        python-version: [ '3.11', '3.12', '3.13', '3.14', '3.15' ]
+        rocket-chat-version: [ '8.5.5', '8.6.4', '8.7.1', '8.8.2', '8.9.1']
     steps:
       - name: Checkout
         uses: actions/checkout@v7.0.1

{rocketchat_api-3.7.1 → rocketchat_api-3.8.0}/.github/workflows/test_manually.yml

@@ -10,7 +10,7 @@ on:
       python-version:
         description: 'The version of Python to use'
         required: true
-        default: '3.14'
+        default: '3.15'
 
 jobs:
   test:

{rocketchat_api-3.7.1 → rocketchat_api-3.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rocketchat_API
-Version: 3.7.1
+Version: 3.8.0
 Summary: Python API wrapper for Rocket.Chat
 Author-email: "Jorge Alberto Díaz Orozco (Akiel)" <diazorozcoj@gmail.com>
 Maintainer-email: "Jorge Alberto Díaz Orozco (Akiel)" <diazorozcoj@gmail.com>
@@ -8,6 +8,7 @@ License-Expression: MIT
 Project-URL: Homepage, https://github.com/jadolg/rocketchat_API
 Project-URL: Issues, https://github.com/jadolg/rocketchat_API/issues
 Keywords: rocketchat,api,wrapper,rest
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: requests
@@ -47,7 +48,7 @@ pip install .
 
 ## Requirements
 
-- Python 3.10 or higher
+- Python 3.11 or higher
 - [requests](https://github.com/kennethreitz/requests)
 
 

{rocketchat_api-3.7.1 → rocketchat_api-3.8.0}/README.md

@@ -24,7 +24,7 @@ pip install .
 
 ## Requirements
 
-- Python 3.10 or higher
+- Python 3.11 or higher
 - [requests](https://github.com/kennethreitz/requests)
 
 

{rocketchat_api-3.7.1 → rocketchat_api-3.8.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [build-system]
 requires = [
-    "setuptools",
+    "setuptools>=61",
     "setuptools_scm",
 ]
 build-backend = "setuptools.build_meta"
@@ -9,6 +9,7 @@ build-backend = "setuptools.build_meta"
 name = "rocketchat_API"
 dynamic = ["version"]
 description = "Python API wrapper for Rocket.Chat"
+requires-python = ">=3.11"
 
 dependencies = [
     "requests",

{rocketchat_api-3.7.1 → rocketchat_api-3.8.0}/rocketchat_API/APISections/integrations.py

@@ -16,7 +16,7 @@ class RocketChatIntegrations(RocketChatBase):
         script_enabled,
         event=None,
         urls=None,
-        **kwargs
+        **kwargs,
     ):
         """Creates an integration."""
         if integrations_type == "webhook-outgoing":
@@ -82,7 +82,7 @@ class RocketChatIntegrations(RocketChatBase):
         channel,
         script_enabled,
         integration_id,
-        **kwargs
+        **kwargs,
     ):
         """Updates an existing integration."""
         return self.call_api_put(

rocketchat_api-3.8.0/rocketchat_API/APISections/users.py

@@ -0,0 +1,370 @@
+import hashlib
+import mimetypes
+import os
+
+from rocketchat_API.APIExceptions.RocketExceptions import (
+    USER_ID_OR_USERNAME_REQUIRED,
+    USER_INFO_LOOKUP_REQUIRED,
+    RocketMissingParamException,
+)
+from rocketchat_API.APISections.base import (
+    RocketChatBase,
+    paginated,
+)
+
+USERS_GET_STATUS = "users.getStatus"
+
+USERS_INFO = "users.info"
+
+
+class RocketChatUsers(RocketChatBase):
+    def me(self, **kwargs):
+        """Displays information about the authenticated user."""
+        return self.call_api_get("me", kwargs=kwargs)
+
+    def users_info(
+        self,
+        user_id=None,
+        username=None,
+        import_id=None,
+        email=None,
+        free_switch_extension=None,
+        **kwargs,
+    ):
+        """Gets a user's information, limited to the caller's permissions.
+
+        Exactly one lookup parameter must be provided. ``email`` requires
+        Rocket.Chat >= 8.4.0 and ``free_switch_extension`` requires >= 8.5.0.
+        """
+        if user_id:
+            return self.call_api_get(USERS_INFO, userId=user_id, kwargs=kwargs)
+        if username:
+            return self.call_api_get(USERS_INFO, username=username, kwargs=kwargs)
+        if import_id:
+            return self.call_api_get(USERS_INFO, importId=import_id, kwargs=kwargs)
+        if email:
+            return self.call_api_get(USERS_INFO, email=email, kwargs=kwargs)
+        if free_switch_extension:
+            return self.call_api_get(
+                USERS_INFO,
+                freeSwitchExtension=free_switch_extension,
+                kwargs=kwargs,
+            )
+        raise RocketMissingParamException(USER_INFO_LOOKUP_REQUIRED)
+
+    @paginated("users")
+    def users_list(self, **kwargs):
+        """All of the users and their information, limited to permissions."""
+        return self.call_api_get("users.list", kwargs=kwargs)
+
+    def users_get_presence(self, user_id=None, username=None, **kwargs):
+        """Gets the online presence of the a user."""
+        if user_id:
+            return self.call_api_get("users.getPresence", userId=user_id, kwargs=kwargs)
+        if username:
+            return self.call_api_get(
+                "users.getPresence", username=username, kwargs=kwargs
+            )
+        raise RocketMissingParamException(USER_ID_OR_USERNAME_REQUIRED)
+
+    def users_create(self, email, name, password, username, **kwargs):
+        """Creates a user"""
+        return self.call_api_post(
+            "users.create",
+            email=email,
+            name=name,
+            password=password,
+            username=username,
+            kwargs=kwargs,
+        )
+
+    def users_delete(self, user_id, **kwargs):
+        """Deletes a user"""
+        return self.call_api_post("users.delete", userId=user_id, **kwargs)
+
+    def users_register(self, email, name, password, username, **kwargs):
+        """Register a new user."""
+        return self.call_api_post(
+            "users.register",
+            email=email,
+            name=name,
+            password=password,
+            username=username,
+            kwargs=kwargs,
+        )
+
+    def users_get_avatar(self, user_id=None, username=None, **kwargs):
+        """Gets the URL for a user's avatar."""
+        if user_id:
+            return self.call_api_get("users.getAvatar", userId=user_id, kwargs=kwargs)
+        if username:
+            return self.call_api_get(
+                "users.getAvatar", username=username, kwargs=kwargs
+            )
+        raise RocketMissingParamException(USER_ID_OR_USERNAME_REQUIRED)
+
+    def users_set_avatar(self, avatar_url, **kwargs):
+        """Set a user's avatar"""
+        if avatar_url.startswith(("http://", "https://")):
+            return self.call_api_post(
+                "users.setAvatar", avatarUrl=avatar_url, kwargs=kwargs
+            )
+
+        avatar_file = {
+            "image": (
+                os.path.basename(avatar_url),
+                open(avatar_url, "rb"),
+                mimetypes.guess_type(avatar_url)[0],
+            ),
+        }
+
+        return self.call_api_post("users.setAvatar", files=avatar_file, kwargs=kwargs)
+
+    def users_reset_avatar(self, user_id=None, username=None, **kwargs):
+        """
+        Reset a user's avatar to the default icon. By default, icons contain the user's initials. Permissions required, if the setting AllowUserAvatarChange is enabled:
+        - edit-other-user-avatar: Permission to change other user's avatar
+        - manage-moderation-actions: Permission to manage moderation actions, perform actions on reported users
+        """
+        if user_id:
+            return self.call_api_post(
+                "users.resetAvatar", userId=user_id, kwargs=kwargs
+            )
+        if username:
+            return self.call_api_post(
+                "users.resetAvatar", username=username, kwargs=kwargs
+            )
+        raise RocketMissingParamException(USER_ID_OR_USERNAME_REQUIRED)
+
+    def users_create_token(self, user_id, secret, **kwargs):
+        """Create a user authentication token."""
+        return self.call_api_post(
+            "users.createToken", userId=user_id, secret=secret, kwargs=kwargs
+        )
+
+    def users_update(self, user_id, **kwargs):
+        """Update an existing user."""
+        return self.call_api_post("users.update", userId=user_id, data=kwargs)
+
+    def users_set_active_status(self, user_id, active_status, **kwargs):
+        """Update user active status."""
+        return self.call_api_post(
+            "users.setActiveStatus",
+            userId=user_id,
+            activeStatus=active_status,
+            kwargs=kwargs,
+        )
+
+    def users_forgot_password(self, email, **kwargs):
+        """Send email to reset your password."""
+        return self.call_api_post("users.forgotPassword", email=email, kwargs=kwargs)
+
+    def users_get_preferences(self, **kwargs):
+        """Gets all preferences of user."""
+        return self.call_api_get("users.getPreferences", kwargs=kwargs)
+
+    def users_set_preferences(self, user_id, data, **kwargs):
+        """Set user's preferences."""
+        return self.call_api_post(
+            "users.setPreferences", userId=user_id, data=data, kwargs=kwargs
+        )
+
+    def users_set_status(self, message, **kwargs):
+        """Sets a user Status when the status message and state is given."""
+        return self.call_api_post("users.setStatus", message=message, kwargs=kwargs)
+
+    @paginated("users")
+    def users_list_by_status(self, **kwargs):
+        """Lists users filtered by status, role or search term.
+
+        Accepts ``status`` (active or deactivated), ``hasLoggedIn``, ``type``,
+        ``roles``, ``searchTerm`` and ``inactiveReason``. Requires ``view-d-room``,
+        and ``view-outside-room`` when Apply_permission_view-outside-room is on.
+        """
+        return self.call_api_get("users.listByStatus", kwargs=kwargs)
+
+    def users_get_username_suggestion(self, **kwargs):
+        """Gets a free username suggestion for the authenticated user."""
+        return self.call_api_get("users.getUsernameSuggestion", kwargs=kwargs)
+
+    def users_get_avatar_suggestion(self, **kwargs):
+        """Gets avatar suggestions from the user's connected OAuth services."""
+        return self.call_api_get("users.getAvatarSuggestion", kwargs=kwargs)
+
+    def users_check_username_availability(self, username, **kwargs):
+        """Checks whether a username is available."""
+        return self.call_api_get(
+            "users.checkUsernameAvailability", username=username, kwargs=kwargs
+        )
+
+    def users_presence(self, **kwargs):
+        """Gets the presence of users.
+
+        Accepts ``ids`` and ``from`` (ISO 8601 datetime). Without ``from``, the
+        presence of all users is returned.
+        """
+        return self.call_api_get("users.presence", kwargs=kwargs)
+
+    def users_autocomplete(self, selector, **kwargs):
+        """Autocompletes users. ``selector`` is a JSON string, e.g. ``{"term": "ab"}``."""
+        return self.call_api_get("users.autocomplete", selector=selector, kwargs=kwargs)
+
+    def users_get_status(self, user_id=None, username=None, **kwargs):
+        """Gets the status of a user by ``user_id`` or ``username``.
+
+        Returns the authenticated user's status if neither is given.
+        """
+        if user_id:
+            return self.call_api_get(USERS_GET_STATUS, userId=user_id, kwargs=kwargs)
+        if username:
+            return self.call_api_get(USERS_GET_STATUS, username=username, kwargs=kwargs)
+        return self.call_api_get(USERS_GET_STATUS, kwargs=kwargs)
+
+    def users_list_teams(self, user_id, **kwargs):
+        """Lists the teams a user belongs to. Seeing all of them needs view-all-teams."""
+        return self.call_api_get("users.listTeams", userId=user_id, kwargs=kwargs)
+
+    def users_generate_personal_access_token(self, token_name, **kwargs):
+        """Generates a personal access token. Accepts ``bypassTwoFactor``.
+
+        Requires ``create-personal-access-tokens`` and 2FA.
+        """
+        return self.call_api_post(
+            "users.generatePersonalAccessToken", tokenName=token_name, kwargs=kwargs
+        )
+
+    def users_regenerate_personal_access_token(self, token_name, **kwargs):
+        """Regenerates an existing personal access token.
+
+        Requires ``create-personal-access-tokens`` and 2FA.
+        """
+        return self.call_api_post(
+            "users.regeneratePersonalAccessToken", tokenName=token_name, kwargs=kwargs
+        )
+
+    def users_get_personal_access_tokens(self, **kwargs):
+        """Lists the personal access tokens of the authenticated user.
+
+        Requires ``create-personal-access-tokens``.
+        """
+        return self.call_api_get("users.getPersonalAccessTokens", kwargs=kwargs)
+
+    def users_remove_personal_access_token(self, token_name, **kwargs):
+        """Removes a personal access token.
+
+        Requires ``create-personal-access-tokens`` and 2FA.
+        """
+        return self.call_api_post(
+            "users.removePersonalAccessToken", tokenName=token_name, kwargs=kwargs
+        )
+
+    def users_request_data_download(self, full_export=False, **kwargs):
+        """Requests an export of the authenticated user's data.
+
+        The User Data Download feature must be configured in the workspace.
+        """
+        return self.call_api_get(
+            "users.requestDataDownload",
+            fullExport=str(full_export).lower(),
+            kwargs=kwargs,
+        )
+
+    def users_deactivate_idle(self, days_idle, **kwargs):
+        """Deactivates users idle for ``days_idle`` days. Accepts ``role``.
+
+        Requires ``edit-other-user-active-status``.
+        """
+        return self.call_api_post(
+            "users.deactivateIdle", daysIdle=days_idle, kwargs=kwargs
+        )
+
+    def users_send_confirmation_email(self, email, **kwargs):
+        """Sends the email verification again. Rate limited to one per 60 seconds."""
+        return self.call_api_post(
+            "users.sendConfirmationEmail", email=email, kwargs=kwargs
+        )
+
+    def users_update_own_basic_info(self, data, **kwargs):
+        """Updates the authenticated user's own profile. Accepts ``customFields``."""
+        return self.call_api_post("users.updateOwnBasicInfo", data=data, kwargs=kwargs)
+
+    def users_2fa_send_email_code(self, email_or_username, **kwargs):
+        """Sends an email 2FA code to the user."""
+        return self.call_api_post(
+            "users.2fa.sendEmailCode", emailOrUsername=email_or_username, kwargs=kwargs
+        )
+
+    def users_2fa_enable_email(self, **kwargs):
+        """Enables email 2FA. The user must have a verified email."""
+        return self.call_api_post("users.2fa.enableEmail", kwargs=kwargs)
+
+    def users_2fa_disable_email(self, **kwargs):
+        """Disables email 2FA. Requires a 2FA code."""
+        return self.call_api_post("users.2fa.disableEmail", kwargs=kwargs)
+
+    def users_enable_totp(self, **kwargs):
+        """Starts TOTP setup, returns the ``secret`` and a ``url`` for the QR code.
+
+        Finish it with ``users_validate_totp``. Requires 2FA.
+        """
+        return self.call_api_post("users.enableTotp", kwargs=kwargs)
+
+    def users_validate_totp(self, code, **kwargs):
+        """Finishes TOTP setup with a code from the app, returns the backup codes."""
+        return self.call_api_post("users.validateTotp", code=code, kwargs=kwargs)
+
+    def users_disable_totp(self, code, **kwargs):
+        """Disables TOTP."""
+        return self.call_api_post("users.disableTotp", code=code, kwargs=kwargs)
+
+    def users_regenerate_totp_codes(self, code, **kwargs):
+        """Regenerates the TOTP backup codes. The previous ones stop working."""
+        return self.call_api_post("users.regenerateTotpCodes", code=code, kwargs=kwargs)
+
+    def users_totp_codes_remaining(self, **kwargs):
+        """Gets how many TOTP backup codes are left."""
+        return self.call_api_get("users.totpCodesRemaining", kwargs=kwargs)
+
+    def users_reset_totp(self, **kwargs):
+        """Resets TOTP of a user (``userId`` or ``username``), or your own if omitted.
+
+        Resetting another user's needs ``edit-other-user-totp``.
+        """
+        return self.call_api_post("users.resetTOTP", kwargs=kwargs)
+
+    def users_reset_e2e_key(self, **kwargs):
+        """Resets E2E key of a user (``userId`` or ``username``), or your own if omitted.
+
+        Resetting another user's needs ``edit-other-user-e2ee``.
+        """
+        return self.call_api_post("users.resetE2EKey", kwargs=kwargs)
+
+    def users_logout(self, **kwargs):
+        """Logs out the given user (``userId``), or yourself if omitted.
+
+        Logging out another user needs ``logout-other-user``.
+        """
+        return self.call_api_post("users.logout", kwargs=kwargs)
+
+    def users_logout_other_clients(self, **kwargs):
+        """Logs out all other sessions of the authenticated user."""
+        return self.call_api_post("users.logoutOtherClients", kwargs=kwargs)
+
+    def users_remove_other_tokens(self, **kwargs):
+        """Removes all login tokens except the current one."""
+        return self.call_api_post("users.removeOtherTokens", kwargs=kwargs)
+
+    def users_delete_own_account(self, password, **kwargs):
+        """Deletes the authenticated user's account.
+
+        Requires the Accounts_AllowDeleteOwnAccount setting. Accepts
+        ``confirmRelinquish`` to delete it even if it is the last owner of a room.
+        """
+        return self.call_api_post(
+            "users.deleteOwnAccount",
+            body={
+                # Rocket.Chat expects the password as a SHA-256 hex digest
+                "password": hashlib.sha256(password.encode()).hexdigest(),
+                **kwargs,
+            },
+        )

{rocketchat_api-3.7.1 → rocketchat_api-3.8.0}/rocketchat_API.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rocketchat_API
-Version: 3.7.1
+Version: 3.8.0
 Summary: Python API wrapper for Rocket.Chat
 Author-email: "Jorge Alberto Díaz Orozco (Akiel)" <diazorozcoj@gmail.com>
 Maintainer-email: "Jorge Alberto Díaz Orozco (Akiel)" <diazorozcoj@gmail.com>
@@ -8,6 +8,7 @@ License-Expression: MIT
 Project-URL: Homepage, https://github.com/jadolg/rocketchat_API
 Project-URL: Issues, https://github.com/jadolg/rocketchat_API/issues
 Keywords: rocketchat,api,wrapper,rest
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: requests
@@ -47,7 +48,7 @@ pip install .
 
 ## Requirements
 
-- Python 3.10 or higher
+- Python 3.11 or higher
 - [requests](https://github.com/kennethreitz/requests)
 
 

rocketchat_api-3.8.0/rocketchat_API.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "3.8.0",
+  "distance": 0,
+  "node": "g0563e243a72ca50e40109593be854d605cc0be34",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-11-07"
+}

{rocketchat_api-3.7.1 → rocketchat_api-3.8.0}/tests/test_user.py

@@ -1,15 +1,50 @@
+import base64
+import hashlib
+import hmac
+import json
+import struct
+import time
 import uuid
+from types import SimpleNamespace
 
 import pytest
+import semver
 
 from rocketchat_API.APIExceptions.RocketExceptions import (
+    RocketApiException,
     RocketAuthenticationException,
     RocketMissingParamException,
-    RocketApiException,
 )
+from rocketchat_API.rocketchat import RocketChat
 from tests.conftest import get_tests_passowrd
 
 
+def totp_code(secret):
+    key = base64.b32decode(secret.upper() + "=" * (-len(secret) % 8))
+    digest = hmac.new(
+        key, struct.pack(">Q", int(time.time()) // 30), hashlib.sha1
+    ).digest()
+    offset = digest[-1] & 0x0F
+    value = struct.unpack(">I", digest[offset : offset + 4])[0] & 0x7FFFFFFF
+    return f"{value % 10**6:06d}"
+
+
+@pytest.fixture
+def temp_user(logged_rocket):
+    username = f"tmp_{uuid.uuid4().hex[:10]}"
+    created = logged_rocket.users_create(
+        f"{username}@domain.com", username, get_tests_passowrd(), username
+    )
+    user_id = created.get("user").get("_id")
+    session = RocketChat(username, get_tests_passowrd())
+    yield SimpleNamespace(id=user_id, name=username, rocket=session)
+    # The user may already have been removed by the test itself
+    try:
+        logged_rocket.users_delete(user_id)
+    except RocketApiException:
+        pass
+
+
 def test_login(logged_rocket, user):
     login = logged_rocket.login(user.name, user.password)
 
@@ -220,3 +255,176 @@ def test_users_list(logged_rocket):
 
 def test_users_set_status(logged_rocket):
     logged_rocket.users_set_status(message="working on it", status="online")
+
+
+def test_users_list_by_status(logged_rocket, user):
+    listed = list(logged_rocket.users_list_by_status(status="active"))
+    assert user.name in [u.get("username") for u in listed]
+
+
+def test_users_get_username_suggestion(logged_rocket):
+    assert logged_rocket.users_get_username_suggestion().get("result")
+
+
+def test_users_get_avatar_suggestion(logged_rocket):
+    assert "suggestions" in logged_rocket.users_get_avatar_suggestion()
+
+
+def test_users_check_username_availability(logged_rocket, user):
+    free = logged_rocket.users_check_username_availability(uuid.uuid4().hex[:12])
+    assert free.get("result") is True
+
+    taken = logged_rocket.users_check_username_availability("rocket.cat")
+    assert taken.get("result") is False
+
+
+def test_users_presence(logged_rocket):
+    presence = logged_rocket.users_presence()
+    assert presence.get("full") is True
+    assert "rocket.cat" in [u.get("username") for u in presence.get("users")]
+
+    by_ids = logged_rocket.users_presence(
+        ids=["rocket.cat"], **{"from": "2000-01-01T00:00:00.000Z"}
+    )
+    assert [u.get("_id") for u in by_ids.get("users")] == ["rocket.cat"]
+
+
+def test_users_autocomplete(logged_rocket, user):
+    found = logged_rocket.users_autocomplete(json.dumps({"term": user.name}))
+    assert user.name in [u.get("username") for u in found.get("items")]
+
+
+def test_users_get_status(logged_rocket, user):
+    user_id = logged_rocket.me().get("_id")
+
+    by_id = logged_rocket.users_get_status(user_id=user_id)
+    assert by_id.get("_id") == user_id
+    assert "status" in by_id
+
+    by_name = logged_rocket.users_get_status(username=user.name)
+    assert by_name.get("_id") == user_id
+
+    own = logged_rocket.users_get_status()
+    assert own.get("_id") == user_id
+
+
+def test_users_list_teams(logged_rocket):
+    teams = logged_rocket.users_list_teams(logged_rocket.me().get("_id"))
+    assert isinstance(teams.get("teams"), list)
+
+
+def test_users_personal_access_tokens(logged_rocket):
+    token_name = f"token_{uuid.uuid4().hex[:8]}"
+    generated = logged_rocket.users_generate_personal_access_token(
+        token_name, bypassTwoFactor=True
+    )
+    assert generated.get("token")
+
+    listed = logged_rocket.users_get_personal_access_tokens()
+    assert token_name in [t.get("name") for t in listed.get("tokens")]
+
+    regenerated = logged_rocket.users_regenerate_personal_access_token(token_name)
+    assert regenerated.get("token")
+    assert regenerated.get("token") != generated.get("token")
+
+    logged_rocket.users_remove_personal_access_token(token_name)
+    listed = logged_rocket.users_get_personal_access_tokens()
+    assert token_name not in [t.get("name") for t in listed.get("tokens")]
+
+
+def test_users_request_data_download(temp_user):
+    assert temp_user.rocket.users_request_data_download().get("requested") is True
+    assert "requested" in temp_user.rocket.users_request_data_download(full_export=True)
+
+
+def test_users_deactivate_idle(logged_rocket):
+    assert logged_rocket.users_deactivate_idle(days_idle=36500).get("count") == 0
+
+
+def test_users_send_confirmation_email(rocket, logged_rocket, user):
+    # TODO: remove the 8.5 branch once Rocket.Chat 8.5 reaches EOL
+    version = semver.Version.parse(
+        rocket.info()["version"], optional_minor_and_patch=True
+    )
+    client = logged_rocket if version < semver.Version(8, 6, 0) else rocket
+    client.users_send_confirmation_email(user.email)
+
+
+def test_users_update_own_basic_info(temp_user):
+    new_name = f"renamed_{uuid.uuid4().hex[:6]}"
+    updated = temp_user.rocket.users_update_own_basic_info(data={"name": new_name})
+    assert updated.get("user").get("name") == new_name
+    assert temp_user.rocket.me().get("name") == new_name
+
+
+def test_users_2fa_email(logged_rocket, temp_user):
+    # Email 2FA can only be enabled with a verified email
+    logged_rocket.users_update(temp_user.id, verified=True)
+
+    temp_user.rocket.users_2fa_enable_email()
+    temp_user.rocket.users_2fa_send_email_code(temp_user.name)
+
+    # With 2FA on, protected endpoints reject requests without a code
+    with pytest.raises(RocketApiException):
+        temp_user.rocket.users_2fa_disable_email()
+
+
+def test_users_2fa_send_email_code_and_disable(logged_rocket, temp_user):
+    temp_user.rocket.users_2fa_disable_email()
+    temp_user.rocket.users_2fa_send_email_code(temp_user.name)
+
+
+def test_users_totp(temp_user, skip_if_version_under):
+    skip_if_version_under("8.8.0")
+    enabled = temp_user.rocket.users_enable_totp()
+    secret = enabled.get("secret")
+    assert secret
+
+    assert temp_user.rocket.users_validate_totp(totp_code(secret)).get("codes")
+    assert temp_user.rocket.users_totp_codes_remaining().get("remaining") is not None
+
+    regenerated = temp_user.rocket.users_regenerate_totp_codes(totp_code(secret))
+    assert regenerated.get("codes")
+
+    temp_user.rocket.users_disable_totp(totp_code(secret))
+
+
+def test_users_reset_totp(logged_rocket, temp_user):
+    logged_rocket.users_reset_totp(userId=temp_user.id)
+    logged_rocket.users_reset_totp(username=temp_user.name)
+    temp_user.rocket.users_reset_totp()
+
+
+def test_users_reset_e2e_key(logged_rocket, temp_user):
+    logged_rocket.users_reset_e2e_key(userId=temp_user.id)
+    logged_rocket.users_reset_e2e_key(username=temp_user.name)
+    # Resetting another user's key logs them out
+    session = RocketChat(temp_user.name, get_tests_passowrd())
+    session.users_reset_e2e_key()
+
+
+def test_users_logout_other_clients(temp_user):
+    temp_user.rocket.users_logout_other_clients()
+
+
+def test_users_remove_other_tokens(temp_user):
+    temp_user.rocket.users_remove_other_tokens()
+
+
+def test_users_logout(logged_rocket, temp_user):
+    logged_rocket.users_logout(userId=temp_user.id)
+    with pytest.raises(RocketApiException):
+        temp_user.rocket.me()
+
+    session = RocketChat(temp_user.name, get_tests_passowrd())
+    session.users_logout()
+
+
+def test_users_delete_own_account(logged_rocket, temp_user):
+    logged_rocket.settings_update("Accounts_AllowDeleteOwnAccount", True)
+    try:
+        temp_user.rocket.users_delete_own_account(get_tests_passowrd())
+    finally:
+        logged_rocket.settings_update("Accounts_AllowDeleteOwnAccount", False)
+    with pytest.raises(RocketApiException):
+        logged_rocket.users_info(user_id=temp_user.id)

rocketchat_api-3.7.1/rocketchat_API/APISections/users.py

@@ -1,171 +0,0 @@
-import mimetypes
-import os
-
-from rocketchat_API.APIExceptions.RocketExceptions import (
-    USER_ID_OR_USERNAME_REQUIRED,
-    USER_INFO_LOOKUP_REQUIRED,
-    RocketMissingParamException,
-)
-from rocketchat_API.APISections.base import (
-    RocketChatBase,
-    paginated,
-)
-
-USERS_INFO = "users.info"
-
-
-class RocketChatUsers(RocketChatBase):
-    def me(self, **kwargs):
-        """Displays information about the authenticated user."""
-        return self.call_api_get("me", kwargs=kwargs)
-
-    def users_info(
-        self,
-        user_id=None,
-        username=None,
-        import_id=None,
-        email=None,
-        free_switch_extension=None,
-        **kwargs,
-    ):
-        """Gets a user's information, limited to the caller's permissions.
-
-        Exactly one lookup parameter must be provided. ``email`` requires
-        Rocket.Chat >= 8.4.0 and ``free_switch_extension`` requires >= 8.5.0.
-        """
-        if user_id:
-            return self.call_api_get(USERS_INFO, userId=user_id, kwargs=kwargs)
-        if username:
-            return self.call_api_get(USERS_INFO, username=username, kwargs=kwargs)
-        if import_id:
-            return self.call_api_get(USERS_INFO, importId=import_id, kwargs=kwargs)
-        if email:
-            return self.call_api_get(USERS_INFO, email=email, kwargs=kwargs)
-        if free_switch_extension:
-            return self.call_api_get(
-                USERS_INFO,
-                freeSwitchExtension=free_switch_extension,
-                kwargs=kwargs,
-            )
-        raise RocketMissingParamException(USER_INFO_LOOKUP_REQUIRED)
-
-    @paginated("users")
-    def users_list(self, **kwargs):
-        """All of the users and their information, limited to permissions."""
-        return self.call_api_get("users.list", kwargs=kwargs)
-
-    def users_get_presence(self, user_id=None, username=None, **kwargs):
-        """Gets the online presence of the a user."""
-        if user_id:
-            return self.call_api_get("users.getPresence", userId=user_id, kwargs=kwargs)
-        if username:
-            return self.call_api_get(
-                "users.getPresence", username=username, kwargs=kwargs
-            )
-        raise RocketMissingParamException(USER_ID_OR_USERNAME_REQUIRED)
-
-    def users_create(self, email, name, password, username, **kwargs):
-        """Creates a user"""
-        return self.call_api_post(
-            "users.create",
-            email=email,
-            name=name,
-            password=password,
-            username=username,
-            kwargs=kwargs,
-        )
-
-    def users_delete(self, user_id, **kwargs):
-        """Deletes a user"""
-        return self.call_api_post("users.delete", userId=user_id, **kwargs)
-
-    def users_register(self, email, name, password, username, **kwargs):
-        """Register a new user."""
-        return self.call_api_post(
-            "users.register",
-            email=email,
-            name=name,
-            password=password,
-            username=username,
-            kwargs=kwargs,
-        )
-
-    def users_get_avatar(self, user_id=None, username=None, **kwargs):
-        """Gets the URL for a user's avatar."""
-        if user_id:
-            return self.call_api_get("users.getAvatar", userId=user_id, kwargs=kwargs)
-        if username:
-            return self.call_api_get(
-                "users.getAvatar", username=username, kwargs=kwargs
-            )
-        raise RocketMissingParamException(USER_ID_OR_USERNAME_REQUIRED)
-
-    def users_set_avatar(self, avatar_url, **kwargs):
-        """Set a user's avatar"""
-        if avatar_url.startswith("http://") or avatar_url.startswith("https://"):
-            return self.call_api_post(
-                "users.setAvatar", avatarUrl=avatar_url, kwargs=kwargs
-            )
-
-        avatar_file = {
-            "image": (
-                os.path.basename(avatar_url),
-                open(avatar_url, "rb"),
-                mimetypes.guess_type(avatar_url)[0],
-            ),
-        }
-
-        return self.call_api_post("users.setAvatar", files=avatar_file, kwargs=kwargs)
-
-    def users_reset_avatar(self, user_id=None, username=None, **kwargs):
-        """
-        Reset a user's avatar to the default icon. By default, icons contain the user's initials. Permissions required, if the setting AllowUserAvatarChange is enabled:
-        - edit-other-user-avatar: Permission to change other user's avatar
-        - manage-moderation-actions: Permission to manage moderation actions, perform actions on reported users
-        """
-        if user_id:
-            return self.call_api_post(
-                "users.resetAvatar", userId=user_id, kwargs=kwargs
-            )
-        if username:
-            return self.call_api_post(
-                "users.resetAvatar", username=username, kwargs=kwargs
-            )
-        raise RocketMissingParamException(USER_ID_OR_USERNAME_REQUIRED)
-
-    def users_create_token(self, user_id, secret, **kwargs):
-        """Create a user authentication token."""
-        return self.call_api_post(
-            "users.createToken", userId=user_id, secret=secret, kwargs=kwargs
-        )
-
-    def users_update(self, user_id, **kwargs):
-        """Update an existing user."""
-        return self.call_api_post("users.update", userId=user_id, data=kwargs)
-
-    def users_set_active_status(self, user_id, active_status, **kwargs):
-        """Update user active status."""
-        return self.call_api_post(
-            "users.setActiveStatus",
-            userId=user_id,
-            activeStatus=active_status,
-            kwargs=kwargs,
-        )
-
-    def users_forgot_password(self, email, **kwargs):
-        """Send email to reset your password."""
-        return self.call_api_post("users.forgotPassword", email=email, kwargs=kwargs)
-
-    def users_get_preferences(self, **kwargs):
-        """Gets all preferences of user."""
-        return self.call_api_get("users.getPreferences", kwargs=kwargs)
-
-    def users_set_preferences(self, user_id, data, **kwargs):
-        """Set user's preferences."""
-        return self.call_api_post(
-            "users.setPreferences", userId=user_id, data=data, kwargs=kwargs
-        )
-
-    def users_set_status(self, message, **kwargs):
-        """Sets a user Status when the status message and state is given."""
-        return self.call_api_post("users.setStatus", message=message, kwargs=kwargs)

rocketchat_api-3.7.1/rocketchat_API.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "3.7.1",
-  "distance": 0,
-  "node": "ge845a9551018dfeee5dc625e061969b524e217e0",
-  "dirty": false,
-  "branch": "HEAD",
-  "node_date": "2026-08-08"
-}