Allow for same param name but different contextual usage

The param provided by users is `user_id`/ `group_id` / `directory_id`;
this is expected as `user` / `group` / `directory` by the API. BUT,
paginating through these endpoints requires the `*_id` version of these
params, so we need to add some kind of translation to change the value,
depending on context

Author: gjtorikian

src/workos/directory_sync.py

@@ -1,4 +1,4 @@
-from typing import Optional, Protocol
+from typing import Any, Dict, Optional, Protocol
 
 from workos.types.directory_sync.list_filters import (
     DirectoryGroupListFilters,
@@ -32,6 +32,24 @@
     Directory, DirectoryListFilters, ListMetadata
 ]
 
+# Mapping from SDK parameter names to API parameter names
+PARAM_KEY_MAPPING = {
+    "directory_id": "directory",
+    "group_id": "group",
+    "user_id": "user",
+}
+
+
+def _prepare_request_params(
+    list_params: DirectoryUserListFilters | DirectoryGroupListFilters,
+) -> Dict[str, Any]:
+    """Convert list_params to API request params by renaming keys."""
+    request_params: Dict[str, Any] = dict(list_params)
+    for sdk_key, api_key in PARAM_KEY_MAPPING.items():
+        if sdk_key in request_params:
+            request_params[api_key] = request_params.pop(sdk_key)
+    return request_params
+
 
 class DirectorySyncModule(Protocol):
     """Offers methods through the WorkOS Directory Sync service."""
@@ -191,7 +209,7 @@ def list_users(
         response = self._http_client.request(
             "directory_users",
             method=REQUEST_METHOD_GET,
-            params=list_params,
+            params=_prepare_request_params(list_params),
         )
 
         return WorkOSListResource(
@@ -225,7 +243,7 @@ def list_groups(
         response = self._http_client.request(
             "directory_groups",
             method=REQUEST_METHOD_GET,
-            params=list_params,
+            params=_prepare_request_params(list_params),
         )
 
         return WorkOSListResource[
@@ -329,7 +347,7 @@ async def list_users(
         response = await self._http_client.request(
             "directory_users",
             method=REQUEST_METHOD_GET,
-            params=list_params,
+            params=_prepare_request_params(list_params),
         )
 
         return WorkOSListResource(
@@ -354,6 +372,7 @@ async def list_groups(
             "after": after,
             "order": order,
         }
+
         if user_id is not None:
             list_params["user_id"] = user_id
         if directory_id is not None:
@@ -362,7 +381,7 @@ async def list_groups(
         response = await self._http_client.request(
             "directory_groups",
             method=REQUEST_METHOD_GET,
-            params=list_params,
+            params=_prepare_request_params(list_params),
         )
 
         return WorkOSListResource[

tests/test_directory_sync.py

@@ -1,7 +1,8 @@
 from typing import Union
 
 import pytest
-from workos.directory_sync import AsyncDirectorySync, DirectorySync
+
+from workos.directory_sync import _prepare_request_params
 
 from tests.types.test_auto_pagination_function import TestAutoPaginationFunction
 from tests.utils.fixtures.mock_directory import (
@@ -13,6 +14,7 @@
 from tests.utils.fixtures.mock_directory_user import MockDirectoryUser
 from tests.utils.list_resource import list_data_to_dicts, list_response_of
 from tests.utils.syncify import syncify
+from workos.directory_sync import AsyncDirectorySync, DirectorySync
 
 
 def api_directory_to_sdk(directory):
@@ -145,7 +147,7 @@ def test_list_users_with_directory(
         assert request_kwargs["url"].endswith("/directory_users")
         assert request_kwargs["method"] == "get"
         assert request_kwargs["params"] == {
-            "directory_id": "directory_id",
+            "directory": "directory_id",
             "limit": 10,
             "order": "desc",
         }
@@ -163,7 +165,7 @@ def test_list_users_with_group(
         assert request_kwargs["url"].endswith("/directory_users")
         assert request_kwargs["method"] == "get"
         assert request_kwargs["params"] == {
-            "group_id": "directory_grp_id",
+            "group": "directory_grp_id",
             "limit": 10,
             "order": "desc",
         }
@@ -181,7 +183,7 @@ def test_list_groups_with_directory(
         assert request_kwargs["url"].endswith("/directory_groups")
         assert request_kwargs["method"] == "get"
         assert request_kwargs["params"] == {
-            "directory_id": "directory_id",
+            "directory": "directory_id",
             "limit": 10,
             "order": "desc",
         }
@@ -199,7 +201,7 @@ def test_list_groups_with_user(
         assert request_kwargs["url"].endswith("/directory_groups")
         assert request_kwargs["method"] == "get"
         assert request_kwargs["params"] == {
-            "user_id": "directory_user_id",
+            "user": "directory_user_id",
             "limit": 10,
             "order": "desc",
         }
@@ -371,3 +373,53 @@ def test_directory_user_groups_auto_pagination(
             list_function=self.directory_sync.list_groups,
             expected_all_page_data=mock_directory_groups_multiple_data_pages,
         )
+
+
+class TestPrepareRequestParams:
+    """Tests for SDK-to-API parameter name translation.
+
+    The SDK uses Pythonic parameter names (directory_id, group_id, user_id)
+    but the WorkOS API expects shorter names (directory, group, user).
+    The _prepare_request_params function handles this translation.
+
+    See: https://github.com/workos/workos-python/issues/511
+    See: https://github.com/workos/workos-python/issues/519
+    """
+
+    def test_translates_directory_id_to_directory(self):
+        params = {"directory_id": "dir_123", "limit": 10}
+        result = _prepare_request_params(params)
+        assert "directory" in result
+        assert "directory_id" not in result
+        assert result["directory"] == "dir_123"
+
+    def test_translates_group_id_to_group(self):
+        params = {"group_id": "grp_123", "limit": 10}
+        result = _prepare_request_params(params)
+        assert "group" in result
+        assert "group_id" not in result
+        assert result["group"] == "grp_123"
+
+    def test_translates_user_id_to_user(self):
+        params = {"user_id": "usr_123", "limit": 10}
+        result = _prepare_request_params(params)
+        assert "user" in result
+        assert "user_id" not in result
+        assert result["user"] == "usr_123"
+
+    def test_preserves_non_id_params(self):
+        params = {
+            "directory_id": "dir_123",
+            "limit": 10,
+            "order": "desc",
+            "after": "cursor",
+        }
+        result = _prepare_request_params(params)
+        assert result["limit"] == 10
+        assert result["order"] == "desc"
+        assert result["after"] == "cursor"
+
+    def test_handles_empty_params(self):
+        params = {"limit": 10, "order": "desc"}
+        result = _prepare_request_params(params)
+        assert result == {"limit": 10, "order": "desc"}