Merge pull request #318 from supertokens/functionSignatureUpdate

feat: added query support to get_users_newest_first and get_users_oldest_first

Author: rishabhpoddar

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## unreleased
 
+
+## [0.12.9] - 2023-04-28
+
+- Added missing arguments in `get_users_newest_first` and `get_users_oldest_first`
+
 ## [0.12.8] - 2023-04-19
 
 - Fixed an issues that threw 500 when changing password for user from dashboard

setup.py

@@ -70,7 +70,7 @@
 
 setup(
     name="supertokens_python",
-    version="0.12.8",
+    version="0.12.9",
     author="SuperTokens",
     license="Apache 2.0",
     author_email="[email protected]",

supertokens_python/asyncio/__init__.py

@@ -11,7 +11,7 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations
 # under the License.
-from typing import List, Union, Optional
+from typing import List, Union, Optional, Dict
 
 from supertokens_python import Supertokens
 from supertokens_python.interfaces import (
@@ -31,19 +31,21 @@ async def get_users_oldest_first(
     limit: Union[int, None] = None,
     pagination_token: Union[str, None] = None,
     include_recipe_ids: Union[None, List[str]] = None,
+    query: Union[None, Dict[str, str]] = None,
 ) -> UsersResponse:
     return await Supertokens.get_instance().get_users(
-        "ASC", limit, pagination_token, include_recipe_ids
+        "ASC", limit, pagination_token, include_recipe_ids, query
     )
 
 
 async def get_users_newest_first(
     limit: Union[int, None] = None,
     pagination_token: Union[str, None] = None,
     include_recipe_ids: Union[None, List[str]] = None,
+    query: Union[None, Dict[str, str]] = None,
 ) -> UsersResponse:
     return await Supertokens.get_instance().get_users(
-        "DESC", limit, pagination_token, include_recipe_ids
+        "DESC", limit, pagination_token, include_recipe_ids, query
     )
 
 

supertokens_python/constants.py

@@ -25,7 +25,7 @@
     "2.19",
     "2.20",
 ]
-VERSION = "0.12.8"
+VERSION = "0.12.9"
 TELEMETRY = "/telemetry"
 USER_COUNT = "/users/count"
 USER_DELETE = "/user/remove"

supertokens_python/syncio/__init__.py

@@ -11,7 +11,7 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations
 # under the License.
-from typing import List, Union, Optional
+from typing import List, Union, Optional, Dict
 
 from supertokens_python import Supertokens
 from supertokens_python.async_to_sync_wrapper import sync
@@ -32,10 +32,11 @@ def get_users_oldest_first(
     limit: Union[int, None] = None,
     pagination_token: Union[str, None] = None,
     include_recipe_ids: Union[None, List[str]] = None,
+    query: Union[None, Dict[str, str]] = None,
 ) -> UsersResponse:
     return sync(
         Supertokens.get_instance().get_users(
-            "ASC", limit, pagination_token, include_recipe_ids
+            "ASC", limit, pagination_token, include_recipe_ids, query
         )
     )
 
@@ -44,10 +45,11 @@ def get_users_newest_first(
     limit: Union[int, None] = None,
     pagination_token: Union[str, None] = None,
     include_recipe_ids: Union[None, List[str]] = None,
+    query: Union[None, Dict[str, str]] = None,
 ) -> UsersResponse:
     return sync(
         Supertokens.get_instance().get_users(
-            "DESC", limit, pagination_token, include_recipe_ids
+            "DESC", limit, pagination_token, include_recipe_ids, query
         )
     )
 

tests/supertokens_python/test_supertokens_functions.py

@@ -89,3 +89,28 @@ async def test_supertokens_functions():
     users_asc = (await st_asyncio.get_users_oldest_first(limit=10)).users
     emails_asc = [user.email for user in users_asc]
     assert emails[1] not in emails_asc  # The 2nd user must be deleted now.
+
+    if not is_version_gte(version, "2.20"):
+        # If the version is less than 2.20, query users doesn't exist, so we mark the test successful
+        return
+    users_asc = (
+        await st_asyncio.get_users_oldest_first(limit=10, query={"email": "baz"})
+    ).users
+    users_desc = (
+        await st_asyncio.get_users_newest_first(limit=10, query={"email": "baz"})
+    ).users
+    emails_asc = [user.email for user in users_asc]
+    emails_desc = [user.email for user in users_desc]
+    assert len(emails_asc) == 1
+    assert len(emails_desc) == 1
+
+    users_asc = (
+        await st_asyncio.get_users_oldest_first(limit=10, query={"email": "john"})
+    ).users
+    users_desc = (
+        await st_asyncio.get_users_newest_first(limit=10, query={"email": "john"})
+    ).users
+    emails_asc = [user.email for user in users_asc]
+    emails_desc = [user.email for user in users_desc]
+    assert len(emails_asc) == 0
+    assert len(emails_desc) == 0