rocketchat-API 3.6.0__tar.gz → 3.7.0__tar.gz

{rocketchat_api-3.6.0 → rocketchat_api-3.7.0}/.github/workflows/lint.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v6.0.2
+        uses: actions/checkout@v6.0.3
         with:
           fetch-depth: 0
       - name: Set up Python

{rocketchat_api-3.6.0 → rocketchat_api-3.7.0}/.github/workflows/release.yml

@@ -14,7 +14,7 @@ jobs:
       id-token: write
     steps:
       - name: Checkout
-        uses: actions/checkout@v6.0.2
+        uses: actions/checkout@v6.0.3
       - name: Set up Python 3.14
         uses: actions/setup-python@v6
         with:

{rocketchat_api-3.6.0 → rocketchat_api-3.7.0}/.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.0.5', '8.1.5', '8.2.5', '8.3.5', '8.4.3', '8.5.0']
     steps:
       - name: Checkout
-        uses: actions/checkout@v6.0.2
+        uses: actions/checkout@v6.0.3
       - name: Test
         uses: ./.github/actions/test_rocketchat
         with:

{rocketchat_api-3.6.0 → rocketchat_api-3.7.0}/.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@v6.0.3
       - name: Test
         uses: ./.github/actions/test_rocketchat
         with:

{rocketchat_api-3.6.0 → rocketchat_api-3.7.0}/.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@v6.0.3
       - name: Test
         uses: ./.github/actions/test_rocketchat
         with:

{rocketchat_api-3.6.0 → rocketchat_api-3.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rocketchat_API
-Version: 3.6.0
+Version: 3.7.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>

{rocketchat_api-3.6.0 → rocketchat_api-3.7.0}/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.0 → rocketchat_api-3.7.0}/rocketchat_API/APISections/dm.py

@@ -78,10 +78,10 @@ class RocketChatDM(RocketChatBase):
             return self.call_api_get("dm.files", username=user_name, kwargs=kwargs)
         raise RocketMissingParamException(ROOM_ID_OR_USERNAME_REQUIRED)
 
-    def dm_counters(self, room_id, user_name=None):
+    def dm_counters(self, room_id, user_id=None):
         """Gets counters of direct messages."""
-        if user_name:
-            return self.call_api_get("dm.counters", roomId=room_id, username=user_name)
+        if user_id:
+            return self.call_api_get("dm.counters", roomId=room_id, userId=user_id)
         return self.call_api_get("dm.counters", roomId=room_id)
 
     def dm_delete(self, room_id, **kwargs):

{rocketchat_api-3.6.0 → rocketchat_api-3.7.0}/rocketchat_API/APISections/teams.py

@@ -173,7 +173,7 @@ class RocketChatTeams(RocketChatBase):
 
     @paginated("rooms")
     def teams_list_rooms_of_user(
-        self, team_id=None, team_name=None, user_id=None, can_add=False, **kwargs
+        self, team_id=None, team_name=None, user_id=None, **kwargs
     ):
         """
         Lists only the team's rooms that a particular user has joined.
@@ -184,7 +184,6 @@ class RocketChatTeams(RocketChatBase):
                 "teams.listRoomsOfUser",
                 teamId=team_id,
                 userId=user_id,
-                canAdd=can_add,
                 kwargs=kwargs,
             )
         if team_name:
@@ -192,7 +191,6 @@ class RocketChatTeams(RocketChatBase):
                 "teams.listRoomsOfUser",
                 teamName=team_name,
                 userId=user_id,
-                canAdd=can_add,
                 kwargs=kwargs,
             )
         raise RocketMissingParamException(TEAM_ID_OR_TEAM_NAME_REQUIRED)

{rocketchat_api-3.6.0 → rocketchat_api-3.7.0}/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):
@@ -129,7 +154,7 @@ class RocketChatUsers(RocketChatBase):
 
     def users_forgot_password(self, email, **kwargs):
         """Send email to reset your password."""
-        return self.call_api_post("users.forgotPassword", email=email, data=kwargs)
+        return self.call_api_post("users.forgotPassword", email=email, kwargs=kwargs)
 
     def users_get_preferences(self, **kwargs):
         """Gets all preferences of user."""

{rocketchat_api-3.6.0 → rocketchat_api-3.7.0}/rocketchat_API.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rocketchat_API
-Version: 3.6.0
+Version: 3.7.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>

{rocketchat_api-3.6.0 → rocketchat_api-3.7.0}/tests/test_dms.py

@@ -146,7 +146,7 @@ def test_dm_counters(logged_rocket, recipient_user):
 
     dm_counters = logged_rocket.dm_counters(
         room_id=dm_create.get("room").get("_id"),
-        user_name=logged_rocket.me().get("_id"),
+        user_id=logged_rocket.me().get("_id"),
     )
     assert all(
         key in dm_counters

{rocketchat_api-3.6.0 → rocketchat_api-3.7.0}/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(