Add async support for Directory Sync #288
Conversation
mattgd
changed the title
| SyncOrAsyncListResource = Union[ | ||
| Awaitable[AsyncWorkOsListResource], | ||
| WorkOsListResource, | ||
| ] |
There was a problem hiding this comment.
So this is FUN. I wanted this to be:
SyncOrAsyncListResource = Union[
Awaitable[AsyncWorkOsListResource[ListableResource, ListAndFilterParams]],
WorkOsListResource[ListableResource, ListAndFilterParams],
]
but Unions cannot be used as generics. This means I had to make the Protocol return type SyncOrAsyncListResource for list methods, instead of something like SyncOrAsyncListResource[Directory, DirectoryFilterParams].
There was a problem hiding this comment.
I think to do something similar for events I'm creating a union of all event types and using that as a bounds= constraint on a type variable.... I don't know if that's helpful at all.
There was a problem hiding this comment.
Let me give that a go.
| list_params = { | ||
| "limit": limit, | ||
| "before": before, | ||
| "after": after, | ||
| "order": order, | ||
| } | ||
|
|
||
| if group is not None: | ||
| list_params["group"] = group | ||
| if directory is not None: | ||
| list_params["directory"] = directory | ||
|
|
||
| response = await self._http_client.request( | ||
| "directory_users", | ||
| method=REQUEST_METHOD_GET, | ||
| params=list_params, | ||
| token=workos.api_key, | ||
| ) | ||
|
|
||
| return AsyncWorkOsListResource( | ||
| list_method=self.list_users, | ||
| list_args=list_params, | ||
| **ListPage[DirectoryUser](**response).model_dump(), | ||
| ) |
There was a problem hiding this comment.
This PR lacks deduplication of code like this. Might be a good thing for me to take a stab at either before or after I work on connections.
| @@ -32,8 +33,8 @@ class PreparedRequest(TypedDict): | |||
| method: str | |||
| url: str | |||
| headers: httpx.Headers | |||
| params: NotRequired[Union[Dict, None]] | |||
| json: NotRequired[Union[Dict, None]] | |||
| params: NotRequired[Union[Mapping, None]] | |||
There was a problem hiding this comment.
Oh. I just did the same thing in my PR. That's fine, git diffing should be good about any conflicts
There was a problem hiding this comment.
Yeah, I figured it should be okay. Just wanted to get my tests passing.
mattgd
deleted the
feature/dsync-1725-add-async-operation-support-for-dsync-api-methods
branch
Description
Add async support for DirectorySync.
Documentation
Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.
If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.