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

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

@@ -12,11 +12,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v6.0.2
+        uses: actions/checkout@v7.0.1
         with:
           fetch-depth: 0
       - name: Set up Python
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v7
         with:
           python-version: "3.14"
       - name: Install black

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

@@ -14,9 +14,9 @@ jobs:
       id-token: write
     steps:
       - name: Checkout
-        uses: actions/checkout@v6.0.2
+        uses: actions/checkout@v7.0.1
       - name: Set up Python 3.14
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v7
         with:
           python-version: '3.14'
       - name: Install dependencies

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

@@ -15,10 +15,10 @@ jobs:
       fail-fast: false
       matrix:
         python-version: [ '3.10', '3.11', '3.12', '3.13', '3.14' ]
-        rocket-chat-version: [ '7.11.6', '7.12.6', '7.13.5' , '8.0.3', '8.1.2', '8.2.1', '8.3.1']
+        rocket-chat-version: [ '8.1.7', '8.2.7', '8.3.7', '8.4.5', '8.5.2', '8.6.1', '8.7.0']
     steps:
       - name: Checkout
-        uses: actions/checkout@v6.0.2
+        uses: actions/checkout@v7.0.1
       - name: Test
         uses: ./.github/actions/test_rocketchat
         with:

{rocketchat_api-3.6.1 → rocketchat_api-3.7.1}/.github/workflows/test_latest.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v6.0.2
+        uses: actions/checkout@v7.0.1
       - name: Test
         uses: ./.github/actions/test_rocketchat
         with:

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

@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v6.0.2
+        uses: actions/checkout@v7.0.1
       - name: Test
         uses: ./.github/actions/test_rocketchat
         with:

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rocketchat_API
-Version: 3.6.1
+Version: 3.7.1
 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>
@@ -182,10 +182,3 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to contribute to th
 ## License
 
 This project is licensed under the MIT License. See [LICENSE.txt](LICENSE.txt) for details.
-
-
-## Supporters
-
-[![JetBrains logo.](https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg)](https://jb.gg/OpenSourceSupport)
-
-[JetBrains](https://www.jetbrains.com/) supports this project by providing licenses for their development tools.

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

@@ -159,10 +159,3 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to contribute to th
 ## License
 
 This project is licensed under the MIT License. See [LICENSE.txt](LICENSE.txt) for details.
-
-
-## Supporters
-
-[![JetBrains logo.](https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg)](https://jb.gg/OpenSourceSupport)
-
-[JetBrains](https://www.jetbrains.com/) supports this project by providing licenses for their development tools.

{rocketchat_api-3.6.1 → rocketchat_api-3.7.1}/rocketchat_API/APIExceptions/RocketExceptions.py

@@ -5,6 +5,9 @@ ROOM_ID_OR_NAME_REQUIRED = "room_id or room_name required"
 ROOM_ID_OR_GROUP_REQUIRED = "room_id or group required"
 ROOM_ID_OR_CHANNEL_REQUIRED = "room_id or channel required"
 USER_ID_OR_USERNAME_REQUIRED = "user_id or username required"
+USER_INFO_LOOKUP_REQUIRED = (
+    "user_id, username, import_id, email or free_switch_extension required"
+)
 ROOM_ID_OR_USERNAME_REQUIRED = "room_id or username required"
 MESSAGE_RID_REQUIRED = "message.rid required"
 TEAM_ID_OR_TEAM_NAME_REQUIRED = "team_id or team_name required"

{rocketchat_api-3.6.1 → rocketchat_api-3.7.1}/rocketchat_API/APISections/chat.py

@@ -72,7 +72,6 @@ class RocketChatChat(RocketChatBase):
             "chat.search", roomId=room_id, searchText=search_text, kwargs=kwargs
         )
 
-    @paginated("receipts")
     def chat_get_message_read_receipts(self, message_id, **kwargs):
         """Get Message Read Receipts"""
         return self.call_api_get(

{rocketchat_api-3.6.1 → rocketchat_api-3.7.1}/rocketchat_API/APISections/users.py

@@ -3,6 +3,7 @@ import os
 
 from rocketchat_API.APIExceptions.RocketExceptions import (
     USER_ID_OR_USERNAME_REQUIRED,
+    USER_INFO_LOOKUP_REQUIRED,
     RocketMissingParamException,
 )
 from rocketchat_API.APISections.base import (
@@ -10,19 +11,43 @@ from rocketchat_API.APISections.base import (
     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, **kwargs):
-        """Gets a user's information, limited to the caller's permissions."""
+    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)
+            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)
-        raise RocketMissingParamException(USER_ID_OR_USERNAME_REQUIRED)
+            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):

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rocketchat_API
-Version: 3.6.1
+Version: 3.7.1
 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>
@@ -182,10 +182,3 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to contribute to th
 ## License
 
 This project is licensed under the MIT License. See [LICENSE.txt](LICENSE.txt) for details.
-
-
-## Supporters
-
-[![JetBrains logo.](https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg)](https://jb.gg/OpenSourceSupport)
-
-[JetBrains](https://www.jetbrains.com/) supports this project by providing licenses for their development tools.

{rocketchat_api-3.6.1 → rocketchat_api-3.7.1}/rocketchat_API.egg-info/SOURCES.txt

@@ -24,6 +24,8 @@ rocketchat_API.egg-info/PKG-INFO
 rocketchat_API.egg-info/SOURCES.txt
 rocketchat_API.egg-info/dependency_links.txt
 rocketchat_API.egg-info/requires.txt
+rocketchat_API.egg-info/scm_file_list.json
+rocketchat_API.egg-info/scm_version.json
 rocketchat_API.egg-info/top_level.txt
 rocketchat_API/APIExceptions/RocketExceptions.py
 rocketchat_API/APIExceptions/__init__.py

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

@@ -0,0 +1,84 @@
+{
+  "files": [
+    ".coveragerc",
+    ".deepsource.toml",
+    ".editorconfig",
+    ".github/ISSUE_TEMPLATE/bug_report.md",
+    ".github/ISSUE_TEMPLATE/feature_request.md",
+    ".github/actions/test_rocketchat/action.yml",
+    ".github/dependabot.yml",
+    ".github/workflows/lint.yml",
+    ".github/workflows/release.yml",
+    ".github/workflows/test.yml",
+    ".github/workflows/test_latest.yml",
+    ".github/workflows/test_manually.yml",
+    ".gitignore",
+    "CONTRIBUTING.md",
+    "LICENSE.txt",
+    "README.md",
+    "bandit.yml",
+    "docker-compose.yml",
+    "pyproject.toml",
+    "qodana.yaml",
+    "rocketchat_API/APIExceptions/RocketExceptions.py",
+    "rocketchat_API/APIExceptions/__init__.py",
+    "rocketchat_API/APISections/__init__.py",
+    "rocketchat_API/APISections/assets.py",
+    "rocketchat_API/APISections/banners.py",
+    "rocketchat_API/APISections/base.py",
+    "rocketchat_API/APISections/channels.py",
+    "rocketchat_API/APISections/chat.py",
+    "rocketchat_API/APISections/custom_emoji.py",
+    "rocketchat_API/APISections/custom_sounds.py",
+    "rocketchat_API/APISections/custom_user_status.py",
+    "rocketchat_API/APISections/dm.py",
+    "rocketchat_API/APISections/groups.py",
+    "rocketchat_API/APISections/integrations.py",
+    "rocketchat_API/APISections/invites.py",
+    "rocketchat_API/APISections/licenses.py",
+    "rocketchat_API/APISections/livechat.py",
+    "rocketchat_API/APISections/miscellaneous.py",
+    "rocketchat_API/APISections/moderation.py",
+    "rocketchat_API/APISections/permissions.py",
+    "rocketchat_API/APISections/roles.py",
+    "rocketchat_API/APISections/rooms.py",
+    "rocketchat_API/APISections/settings.py",
+    "rocketchat_API/APISections/statistics.py",
+    "rocketchat_API/APISections/subscriptions.py",
+    "rocketchat_API/APISections/teams.py",
+    "rocketchat_API/APISections/users.py",
+    "rocketchat_API/APISections/users_engagement.py",
+    "rocketchat_API/__init__.py",
+    "rocketchat_API/rocketchat.py",
+    "tests/__init__.py",
+    "tests/assets/avatar.png",
+    "tests/assets/avatar.svg",
+    "tests/assets/logo.png",
+    "tests/conftest.py",
+    "tests/test_assets.py",
+    "tests/test_banners.py",
+    "tests/test_channels.py",
+    "tests/test_chat.py",
+    "tests/test_custom_emoji.py",
+    "tests/test_custom_sounds.py",
+    "tests/test_custom_user_status.py",
+    "tests/test_dms.py",
+    "tests/test_exceptions.py",
+    "tests/test_groups.py",
+    "tests/test_integrations.py",
+    "tests/test_invites.py",
+    "tests/test_licenses.py",
+    "tests/test_livechat.py",
+    "tests/test_moderation.py",
+    "tests/test_paginated.py",
+    "tests/test_permissions.py",
+    "tests/test_roles.py",
+    "tests/test_rooms.py",
+    "tests/test_server.py",
+    "tests/test_settings.py",
+    "tests/test_subscriptions.py",
+    "tests/test_teams.py",
+    "tests/test_user.py",
+    "tests/test_users_engagement.py"
+  ]
+}

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

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

{rocketchat_api-3.6.1 → rocketchat_api-3.7.1}/tests/conftest.py

@@ -92,17 +92,49 @@ def skip_if_version_under(rocket):
 
 @pytest.fixture
 def skip_if_no_license(logged_rocket):
-    try:
-        licenses_info = logged_rocket.licenses_info()
-        if "license" in licenses_info and "license" in licenses_info.get("license"):
-            return
-    except (RocketApiException, RocketBadStatusCodeException):
-        pytest.fail("License endpoint not available")
-    pytest.skip("No license available")
+    licenses_info = logged_rocket.licenses_info()
+    if "license" in licenses_info and "license" in licenses_info.get("license"):
+        return
+    pytest.skip("No license available")  # pragma: no cover
+
+
+@pytest.fixture(scope="session", autouse=True)
+def grant_message_impersonate(logged_rocket):
+    """Grant the 'message-impersonate' permission to the admin role.
+
+    Incoming integrations that post as a user require that user to hold the
+    'message-impersonate' permission. It is granted to the 'bot' and 'app' roles
+    by default but not to 'admin', so the integration tests would otherwise fail
+    with 'error-user-lacks-message-impersonate-permission'.
+    """
+    logged_rocket.permissions_update(
+        permissions=[{"_id": "message-impersonate", "roles": ["admin", "bot", "app"]}]
+    )
+
+
+@pytest.fixture
+def accept_chats_with_no_agents(logged_rocket):
+    """Allow opening livechat rooms while no agent is online.
+
+    In a headless test environment there is no persistent connection keeping an
+    agent's presence 'online', so Rocket.Chat would otherwise refuse to open a
+    room with 'no-agent-online'. Accepting chats with no agents online lets the
+    room be created and the inquiry queued regardless.
+    """
+    original_accept = logged_rocket.settings_get(
+        "Livechat_accept_chats_with_no_agents"
+    ).get("value")
+    logged_rocket.settings_update("Livechat_accept_chats_with_no_agents", True)
+
+    yield
+
+    logged_rocket.settings_update(
+        "Livechat_accept_chats_with_no_agents", original_accept
+    )
 
 
 @pytest.fixture
-def livechat_inquiry(logged_rocket):
+def livechat_inquiry(logged_rocket, accept_chats_with_no_agents):
     """Create a livechat agent, visitor, and room to generate an inquiry."""
     # Save original routing method and set to Manual_Selection to prevent auto-assignment
     original_routing = logged_rocket.settings_get("Livechat_Routing_Method")

{rocketchat_api-3.6.1 → rocketchat_api-3.7.1}/tests/test_chat.py

@@ -147,7 +147,9 @@ def test_chat_get_message_read_receipts(
     second_rocket = RocketChat("secondary", get_tests_passowrd())
     second_rocket.subscriptions_read(rid="GENERAL")
 
-    receipts = list(logged_rocket.chat_get_message_read_receipts(message_id=message_id))
+    receipts = logged_rocket.chat_get_message_read_receipts(message_id=message_id).get(
+        "receipts"
+    )
     assert len(receipts) > 0
     for receipt in receipts:
         assert "userId" in receipt

{rocketchat_api-3.6.1 → rocketchat_api-3.7.1}/tests/test_livechat.py

@@ -58,7 +58,7 @@ def test_livechat_visitor_minimal(logged_rocket):
     assert "visitor" in new_visitor
 
 
-def test_livechat_visitor_room_and_message(logged_rocket):
+def test_livechat_visitor_room_and_message(logged_rocket, accept_chats_with_no_agents):
     token = str(uuid.uuid1())
     name = str(uuid.uuid1())
     new_visitor = logged_rocket.livechat_register_visitor(
@@ -69,7 +69,9 @@ def test_livechat_visitor_room_and_message(logged_rocket):
     get_visitor = logged_rocket.livechat_get_visitor(token=token)
     assert name == get_visitor.get("visitor").get("username")
 
-    # We need to create a livechat agent and set the user online in order to be able to get a room
+    # We need to create a livechat agent and set the user online in order to be able to get a room.
+    # The accept_chats_with_no_agents fixture allows the room to open despite the agent's presence
+    # not staying online in a headless test environment.
     username = logged_rocket.me().get("username")
     new_user = logged_rocket.livechat_create_user(user_type="agent", username=username)
     logged_rocket.users_set_status(message="working on it", status="online")

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

@@ -7,6 +7,7 @@ from rocketchat_API.APIExceptions.RocketExceptions import (
     RocketMissingParamException,
     RocketApiException,
 )
+from tests.conftest import get_tests_passowrd
 
 
 def test_login(logged_rocket, user):
@@ -55,6 +56,48 @@ def test_users_info(logged_rocket, user):
         logged_rocket.users_info()
 
 
+def test_users_info_by_email(logged_rocket, skip_if_version_under):
+    skip_if_version_under("8.4.0")
+    email = f"{uuid.uuid4().hex}@domain.com"
+    username = f"info_email_{uuid.uuid4().hex[:8]}"
+
+    # No user has this email yet, so the lookup must fail.
+    with pytest.raises(RocketApiException):
+        logged_rocket.users_info(email=email)
+
+    created = logged_rocket.users_create(
+        email, username, get_tests_passowrd(), username
+    )
+    user_id = created.get("user").get("_id")
+    try:
+        users_info_by_email = logged_rocket.users_info(email=email)
+        assert users_info_by_email.get("user").get("_id") == user_id
+    finally:
+        logged_rocket.users_delete(user_id)
+
+
+def test_users_info_by_import_id(logged_rocket):
+    # An importId can only be set while importing users (CSV, Slack, ...), which
+    # is not exposed through the API, so the success path cannot be set up from
+    # code. We only assert the parameter reaches the server: the API answering
+    # with a "user not found" error (rather than the wrapper raising a
+    # missing-param error) proves importId was sent as a query parameter.
+    with pytest.raises(RocketApiException):
+        logged_rocket.users_info(import_id="nonexistent")
+
+
+def test_users_info_by_free_switch_extension(logged_rocket, skip_if_version_under):
+    skip_if_version_under("8.5.0")
+    # Assigning a freeSwitchExtension requires a configured FreeSwitch server
+    # (VoIP_TeamCollab), which is part of the deployment rather than something we
+    # can set up from code, so the success path cannot be exercised here. We only
+    # assert the parameter reaches the server: the API answering with a "user not
+    # found" error (rather than the wrapper raising a missing-param error) proves
+    # freeSwitchExtension was sent as a query parameter.
+    with pytest.raises(RocketApiException):
+        logged_rocket.users_info(free_switch_extension="0000")
+
+
 def test_users_get_presence(logged_rocket, user):
     login = logged_rocket.login(user.name, user.password)
     users_get_presence = logged_rocket.users_get_presence(