From bd633d0d0a501d8d2aab61d78e507e1d46fe18eb Mon Sep 17 00:00:00 2001 From: mattgd Date: Tue, 30 Jul 2024 17:18:48 -0400 Subject: [PATCH] Fix methods missing _id for unique IDs. --- tests/test_organizations.py | 8 +++++--- workos/directory_sync.py | 4 ++-- workos/events.py | 4 ++-- workos/organizations.py | 30 +++++++++++++++--------------- 4 files changed, 24 insertions(+), 22 deletions(-) diff --git a/tests/test_organizations.py b/tests/test_organizations.py index d06ec3fe..d2a31b3e 100644 --- a/tests/test_organizations.py +++ b/tests/test_organizations.py @@ -83,7 +83,7 @@ def test_get_organization(self, mock_organization, mock_http_client_with_respons mock_http_client_with_response(self.http_client, mock_organization, 200) organization = self.organizations.get_organization( - organization="organization_id" + organization_id="organization_id" ) assert organization.dict() == mock_organization @@ -140,7 +140,7 @@ def test_update_organization_with_domain_data( mock_http_client_with_response(self.http_client, mock_organization_updated, 201) updated_organization = self.organizations.update_organization( - organization="org_01EHT88Z8J8795GZNQ4ZP1J81T", + organization_id="org_01EHT88Z8J8795GZNQ4ZP1J81T", name="Example Organization", domain_data=[{"domain": "example.io", "state": "verified"}], ) @@ -162,7 +162,9 @@ def test_delete_organization(self, setup, mock_http_client_with_response): headers={"content-type": "text/plain; charset=utf-8"}, ) - response = self.organizations.delete_organization(organization="connection_id") + response = self.organizations.delete_organization( + organization_id="connection_id" + ) assert response is None diff --git a/workos/directory_sync.py b/workos/directory_sync.py index 9f13c826..cb9b31f3 100644 --- a/workos/directory_sync.py +++ b/workos/directory_sync.py @@ -76,7 +76,7 @@ def list_directories( limit: int = DEFAULT_LIST_RESPONSE_LIMIT, before: Optional[str] = None, after: Optional[str] = None, - organization: Optional[str] = None, + organization_id: Optional[str] = None, order: PaginationOrder = "desc", ) -> SyncOrAsyncListResource: ... @@ -485,7 +485,7 @@ async def list_directories( Args: domain (str): Domain of a Directory. (Optional) - organization: ID of an Organization (Optional) + organization_id: ID of an Organization (Optional) search (str): Searchable text for a Directory. (Optional) limit (int): Maximum number of records to return. (Optional) before (str): Pagination cursor to receive records before a provided Directory ID. (Optional) diff --git a/workos/events.py b/workos/events.py index fe97d4cb..b1d52f58 100644 --- a/workos/events.py +++ b/workos/events.py @@ -53,7 +53,7 @@ def list_events( self, events: List[EventType], limit: int = DEFAULT_LIST_RESPONSE_LIMIT, - organization: Optional[str] = None, + organization_id: Optional[str] = None, after: Optional[str] = None, range_start: Optional[str] = None, range_end: Optional[str] = None, @@ -76,7 +76,7 @@ def list_events( "events": events, "limit": limit, "after": after, - "organization_id": organization, + "organization_id": organization_id, "range_start": range_start, "range_end": range_end, } diff --git a/workos/organizations.py b/workos/organizations.py index af10e680..ed2cb201 100644 --- a/workos/organizations.py +++ b/workos/organizations.py @@ -33,7 +33,7 @@ def list_organizations( order: PaginationOrder = "desc", ) -> WorkOsListResource[Organization, OrganizationListFilters, ListMetadata]: ... - def get_organization(self, organization: str) -> Organization: ... + def get_organization(self, organization_id: str) -> Organization: ... def get_organization_by_lookup_key(self, lookup_key: str) -> Organization: ... @@ -46,12 +46,12 @@ def create_organization( def update_organization( self, - organization: str, + organization_id: str, name: str, domain_data: Optional[List[DomainDataInput]] = None, ) -> Organization: ... - def delete_organization(self, organization: str) -> None: ... + def delete_organization(self, organization_id: str) -> None: ... class Organizations(OrganizationsModule): @@ -101,18 +101,18 @@ def list_organizations( return WorkOsListResource[Organization, OrganizationListFilters, ListMetadata]( list_method=self.list_organizations, list_args=list_params, - **ListPage[Organization](**response).model_dump() + **ListPage[Organization](**response).model_dump(), ) - def get_organization(self, organization: str) -> Organization: + def get_organization(self, organization_id: str) -> Organization: """Gets details for a single Organization Args: - organization (str): Organization's unique identifier + organization_id (str): Organization's unique identifier Returns: - dict: Organization response from WorkOS + Organization: Organization response from WorkOS """ response = self._http_client.request( - "organizations/{organization}".format(organization=organization), + f"organizations/{organization_id}", method=REQUEST_METHOD_GET, token=workos.api_key, ) @@ -163,17 +163,17 @@ def create_organization( def update_organization( self, - organization: str, + organization_id: str, name: str, domain_data: Optional[List[DomainDataInput]] = None, - ): + ) -> Organization: params = { "name": name, "domain_data": domain_data, } response = self._http_client.request( - "organizations/{organization}".format(organization=organization), + f"organizations/{organization_id}", method=REQUEST_METHOD_PUT, params=params, token=workos.api_key, @@ -181,14 +181,14 @@ def update_organization( return Organization.model_validate(response) - def delete_organization(self, organization: str): + def delete_organization(self, organization_id: str) -> None: """Deletes a single Organization Args: - organization (str): Organization unique identifier + organization_id (str): Organization unique identifier """ - return self._http_client.request( - "organizations/{organization}".format(organization=organization), + self._http_client.request( + f"organizations/{organization_id}", method=REQUEST_METHOD_DELETE, token=workos.api_key, )