workos 5.34.1__tar.gz → 5.36.0__tar.gz

{workos-5.34.1 → workos-5.36.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: workos
-Version: 5.34.1
+Version: 5.36.0
 Summary: WorkOS Python Client
 Home-page: https://github.com/workos-inc/workos-python
 Author: WorkOS

workos-5.36.0/tests/test_api_keys.py

@@ -0,0 +1,50 @@
+# type: ignore
+import pytest
+
+from tests.utils.fixtures.mock_api_key import MockApiKey
+from tests.utils.syncify import syncify
+from workos.api_keys import API_KEY_VALIDATION_PATH, ApiKeys, AsyncApiKeys
+
+
+@pytest.mark.sync_and_async(ApiKeys, AsyncApiKeys)
+class TestApiKeys:
+    @pytest.fixture
+    def mock_api_key(self):
+        return MockApiKey().dict()
+
+    @pytest.fixture
+    def api_key(self):
+        return "sk_my_api_key"
+
+    def test_validate_api_key_with_valid_key(
+        self,
+        module_instance,
+        api_key,
+        mock_api_key,
+        capture_and_mock_http_client_request,
+    ):
+        response_body = {"api_key": mock_api_key}
+        request_kwargs = capture_and_mock_http_client_request(
+            module_instance._http_client, response_body, 200
+        )
+
+        api_key_details = syncify(module_instance.validate_api_key(value=api_key))
+
+        assert request_kwargs["url"].endswith(API_KEY_VALIDATION_PATH)
+        assert request_kwargs["method"] == "post"
+        assert api_key_details.id == mock_api_key["id"]
+        assert api_key_details.name == mock_api_key["name"]
+        assert api_key_details.object == "api_key"
+
+    def test_validate_api_key_with_invalid_key(
+        self,
+        module_instance,
+        mock_http_client_with_response,
+    ):
+        mock_http_client_with_response(
+            module_instance._http_client,
+            {"api_key": None},
+            200,
+        )
+
+        assert syncify(module_instance.validate_api_key(value="invalid-key")) is None

{workos-5.34.1 → workos-5.36.0}/tests/test_client.py

@@ -37,6 +37,9 @@ class TestClient:
         os.environ.pop("WORKOS_API_KEY")
         os.environ.pop("WORKOS_CLIENT_ID")
 
+    def test_initialize_api_keys(self, default_client):
+        assert bool(default_client.api_keys)
+
     def test_initialize_sso(self, default_client):
         assert bool(default_client.sso)
 
@@ -112,6 +115,9 @@ class TestAsyncClient:
         os.environ.pop("WORKOS_API_KEY")
         os.environ.pop("WORKOS_CLIENT_ID")
 
+    def test_initialize_api_keys(self, default_client):
+        assert bool(default_client.api_keys)
+
     def test_initialize_directory_sync(self, default_client):
         assert bool(default_client.directory_sync)
 

{workos-5.34.1 → workos-5.36.0}/workos/__about__.py

@@ -12,7 +12,7 @@ __package_name__ = "workos"
 
 __package_url__ = "https://github.com/workos-inc/workos-python"
 
-__version__ = "5.34.1"
+__version__ = "5.36.0"
 
 __author__ = "WorkOS"
 

{workos-5.34.1 → workos-5.36.0}/workos/_base_client.py

@@ -1,21 +1,21 @@
-from abc import abstractmethod
 import os
+from abc import abstractmethod
 from typing import Optional
-from workos.__about__ import __version__
+
 from workos._client_configuration import ClientConfiguration
-from workos.fga import FGAModule
-from workos.utils._base_http_client import DEFAULT_REQUEST_TIMEOUT
-from workos.utils.http_client import HTTPClient
+from workos.api_keys import ApiKeysModule
 from workos.audit_logs import AuditLogsModule
 from workos.directory_sync import DirectorySyncModule
 from workos.events import EventsModule
+from workos.fga import FGAModule
 from workos.mfa import MFAModule
-from workos.organizations import OrganizationsModule
 from workos.organization_domains import OrganizationDomainsModule
+from workos.organizations import OrganizationsModule
 from workos.passwordless import PasswordlessModule
 from workos.portal import PortalModule
 from workos.sso import SSOModule
 from workos.user_management import UserManagementModule
+from workos.utils._base_http_client import DEFAULT_REQUEST_TIMEOUT
 from workos.webhooks import WebhooksModule
 
 
@@ -65,6 +65,10 @@ class BaseClient(ClientConfiguration):
             else int(os.getenv("WORKOS_REQUEST_TIMEOUT", DEFAULT_REQUEST_TIMEOUT))
         )
 
+    @property
+    @abstractmethod
+    def api_keys(self) -> ApiKeysModule: ...
+
     @property
     @abstractmethod
     def audit_logs(self) -> AuditLogsModule: ...

workos-5.36.0/workos/api_keys.py

@@ -0,0 +1,53 @@
+from typing import Optional, Protocol
+
+from workos.types.api_keys import ApiKey
+from workos.typing.sync_or_async import SyncOrAsync
+from workos.utils.http_client import AsyncHTTPClient, SyncHTTPClient
+from workos.utils.request_helper import REQUEST_METHOD_POST
+
+API_KEY_VALIDATION_PATH = "api_keys/validations"
+RESOURCE_OBJECT_ATTRIBUTE_NAME = "api_key"
+
+
+class ApiKeysModule(Protocol):
+    def validate_api_key(self, *, value: str) -> SyncOrAsync[Optional[ApiKey]]:
+        """Validate an API key.
+
+        Kwargs:
+            value (str): API key value
+
+        Returns:
+            Optional[ApiKey]: Returns ApiKey resource object
+                if supplied value was valid, None if it was not
+        """
+        ...
+
+
+class ApiKeys(ApiKeysModule):
+    _http_client: SyncHTTPClient
+
+    def __init__(self, http_client: SyncHTTPClient):
+        self._http_client = http_client
+
+    def validate_api_key(self, *, value: str) -> Optional[ApiKey]:
+        response = self._http_client.request(
+            API_KEY_VALIDATION_PATH, method=REQUEST_METHOD_POST, json={"value": value}
+        )
+        if response.get(RESOURCE_OBJECT_ATTRIBUTE_NAME) is None:
+            return None
+        return ApiKey.model_validate(response[RESOURCE_OBJECT_ATTRIBUTE_NAME])
+
+
+class AsyncApiKeys(ApiKeysModule):
+    _http_client: AsyncHTTPClient
+
+    def __init__(self, http_client: AsyncHTTPClient):
+        self._http_client = http_client
+
+    async def validate_api_key(self, *, value: str) -> Optional[ApiKey]:
+        response = await self._http_client.request(
+            API_KEY_VALIDATION_PATH, method=REQUEST_METHOD_POST, json={"value": value}
+        )
+        if response.get(RESOURCE_OBJECT_ATTRIBUTE_NAME) is None:
+            return None
+        return ApiKey.model_validate(response[RESOURCE_OBJECT_ATTRIBUTE_NAME])

{workos-5.34.1 → workos-5.36.0}/workos/async_client.py

@@ -1,6 +1,7 @@
 from typing import Optional
 from workos.__about__ import __version__
 from workos._base_client import BaseClient
+from workos.api_keys import AsyncApiKeys
 from workos.audit_logs import AuditLogsModule
 from workos.directory_sync import AsyncDirectorySync
 from workos.events import AsyncEvents
@@ -45,6 +46,12 @@ class AsyncClient(BaseClient):
             timeout=self.request_timeout,
         )
 
+    @property
+    def api_keys(self) -> AsyncApiKeys:
+        if not getattr(self, "_api_keys", None):
+            self._api_keys = AsyncApiKeys(self._http_client)
+        return self._api_keys
+
     @property
     def sso(self) -> AsyncSSO:
         if not getattr(self, "_sso", None):

{workos-5.34.1 → workos-5.36.0}/workos/client.py

@@ -1,6 +1,7 @@
 from typing import Optional
 from workos.__about__ import __version__
 from workos._base_client import BaseClient
+from workos.api_keys import ApiKeys
 from workos.audit_logs import AuditLogs
 from workos.directory_sync import DirectorySync
 from workos.fga import FGA
@@ -45,6 +46,12 @@ class SyncClient(BaseClient):
             timeout=self.request_timeout,
         )
 
+    @property
+    def api_keys(self) -> ApiKeys:
+        if not getattr(self, "_api_keys", None):
+            self._api_keys = ApiKeys(self._http_client)
+        return self._api_keys
+
     @property
     def sso(self) -> SSO:
         if not getattr(self, "_sso", None):

workos-5.36.0/workos/types/api_keys/__init__.py

@@ -0,0 +1 @@
+from .api_keys import ApiKey as ApiKey  # noqa: F401

workos-5.36.0/workos/types/api_keys/api_keys.py

@@ -0,0 +1,20 @@
+from typing import Literal, Optional, Sequence
+
+from workos.types.workos_model import WorkOSModel
+
+
+class ApiKeyOwner(WorkOSModel):
+    type: str
+    id: str
+
+
+class ApiKey(WorkOSModel):
+    object: Literal["api_key"]
+    id: str
+    owner: ApiKeyOwner
+    name: str
+    obfuscated_value: str
+    last_used_at: Optional[str] = None
+    permissions: Sequence[str]
+    created_at: str
+    updated_at: str

{workos-5.34.1 → workos-5.36.0}/workos/types/events/__init__.py

@@ -10,4 +10,4 @@ from .event_type import *
 from .event import *
 from .organization_domain_verification_failed_payload import *
 from .previous_attributes import *
-from .session_created_payload import *
+from .session_payload import *

{workos-5.34.1 → workos-5.36.0}/workos/types/events/event.py

@@ -36,7 +36,10 @@ from workos.types.events.event_model import EventModel
 from workos.types.events.organization_domain_verification_failed_payload import (
     OrganizationDomainVerificationFailedPayload,
 )
-from workos.types.events.session_created_payload import SessionCreatedPayload
+from workos.types.events.session_payload import (
+    SessionCreatedPayload,
+    SessionRevokedPayload,
+)
 from workos.types.organizations.organization_common import OrganizationCommon
 from workos.types.organization_domains import OrganizationDomain
 from workos.types.roles.role import EventRole
@@ -249,6 +252,10 @@ class SessionCreatedEvent(EventModel[SessionCreatedPayload]):
     event: Literal["session.created"]
 
 
+class SessionRevokedEvent(EventModel[SessionRevokedPayload]):
+    event: Literal["session.revoked"]
+
+
 class UserCreatedEvent(EventModel[User]):
     event: Literal["user.created"]
 
@@ -308,6 +315,7 @@ Event = Annotated[
         RoleDeletedEvent,
         RoleUpdatedEvent,
         SessionCreatedEvent,
+        SessionRevokedEvent,
         UserCreatedEvent,
         UserDeletedEvent,
         UserUpdatedEvent,

{workos-5.34.1 → workos-5.36.0}/workos/types/events/event_model.py

@@ -35,7 +35,11 @@ from workos.types.events.directory_user_with_previous_attributes import (
 from workos.types.events.organization_domain_verification_failed_payload import (
     OrganizationDomainVerificationFailedPayload,
 )
-from workos.types.events.session_created_payload import SessionCreatedPayload
+
+from workos.types.events.session_payload import (
+    SessionCreatedPayload,
+    SessionRevokedPayload,
+)
 from workos.types.organizations.organization_common import OrganizationCommon
 from workos.types.organization_domains import OrganizationDomain
 from workos.types.roles.role import EventRole
@@ -81,6 +85,7 @@ EventPayload = TypeVar(
     OrganizationMembership,
     PasswordResetCommon,
     SessionCreatedPayload,
+    SessionRevokedPayload,
     User,
 )
 

{workos-5.34.1 → workos-5.36.0}/workos/types/events/event_type.py

@@ -50,6 +50,7 @@ EventType = Literal[
     "role.deleted",
     "role.updated",
     "session.created",
+    "session.revoked",
     "user.created",
     "user.deleted",
     "user.updated",

workos-5.34.1/workos/types/events/session_created_payload.py → workos-5.36.0/workos/types/events/session_payload.py

@@ -13,3 +13,15 @@ class SessionCreatedPayload(WorkOSModel):
     user_id: str
     created_at: str
     updated_at: str
+
+
+class SessionRevokedPayload(WorkOSModel):
+    object: Literal["session"]
+    id: str
+    impersonator: Optional[Impersonator] = None
+    ip_address: Optional[str] = None
+    organization_id: Optional[str] = None
+    user_agent: Optional[str] = None
+    user_id: str
+    created_at: str
+    updated_at: str

{workos-5.34.1 → workos-5.36.0}/workos/types/webhooks/webhook.py

@@ -36,7 +36,10 @@ from workos.types.events.directory_user_with_previous_attributes import (
 from workos.types.events.organization_domain_verification_failed_payload import (
     OrganizationDomainVerificationFailedPayload,
 )
-from workos.types.events.session_created_payload import SessionCreatedPayload
+from workos.types.events.session_payload import (
+    SessionCreatedPayload,
+    SessionRevokedPayload,
+)
 from workos.types.organization_domains import OrganizationDomain
 from workos.types.organizations.organization_common import OrganizationCommon
 from workos.types.roles.role import EventRole
@@ -255,6 +258,10 @@ class SessionCreatedWebhook(WebhookModel[SessionCreatedPayload]):
     event: Literal["session.created"]
 
 
+class SessionRevokedWebhook(WebhookModel[SessionRevokedPayload]):
+    event: Literal["session.revoked"]
+
+
 class UserCreatedWebhook(WebhookModel[User]):
     event: Literal["user.created"]
 
@@ -314,6 +321,7 @@ Webhook = Annotated[
         RoleDeletedWebhook,
         RoleUpdatedWebhook,
         SessionCreatedWebhook,
+        SessionRevokedWebhook,
         UserCreatedWebhook,
         UserDeletedWebhook,
         UserUpdatedWebhook,

{workos-5.34.1 → workos-5.36.0}/workos.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: workos
-Version: 5.34.1
+Version: 5.36.0
 Summary: WorkOS Python Client
 Home-page: https://github.com/workos-inc/workos-python
 Author: WorkOS

{workos-5.34.1 → workos-5.36.0}/workos.egg-info/SOURCES.txt

@@ -1,6 +1,7 @@
 LICENSE
 README.md
 setup.py
+tests/test_api_keys.py
 tests/test_async_http_client.py
 tests/test_audit_logs.py
 tests/test_client.py
@@ -25,6 +26,7 @@ workos/__about__.py
 workos/__init__.py
 workos/_base_client.py
 workos/_client_configuration.py
+workos/api_keys.py
 workos/async_client.py
 workos/audit_logs.py
 workos/client.py
@@ -54,6 +56,8 @@ workos/types/__init__.py
 workos/types/list_resource.py
 workos/types/metadata.py
 workos/types/workos_model.py
+workos/types/api_keys/__init__.py
+workos/types/api_keys/api_keys.py
 workos/types/audit_logs/__init__.py
 workos/types/audit_logs/audit_log_event.py
 workos/types/audit_logs/audit_log_event_actor.py
@@ -82,7 +86,7 @@ workos/types/events/event_type.py
 workos/types/events/list_filters.py
 workos/types/events/organization_domain_verification_failed_payload.py
 workos/types/events/previous_attributes.py
-workos/types/events/session_created_payload.py
+workos/types/events/session_payload.py
 workos/types/feature_flags/__init__.py
 workos/types/feature_flags/feature_flag.py
 workos/types/feature_flags/list_filters.py