workos 5.34.1__py3-none-any.whl → 5.36.0__py3-none-any.whl

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/_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/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/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/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/types/api_keys/__init__.py

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

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/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/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/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/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/types/events/{session_created_payload.py → 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/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.dist-info → workos-5.36.0.dist-info}/METADATA

@@ -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.dist-info → workos-5.36.0.dist-info}/RECORD

@@ -1,10 +1,11 @@
-workos/__about__.py,sha256=TO83oIJgyptIqPq07Ejqr2udJ29rlQa1vD5guygUTZY,406
+workos/__about__.py,sha256=56CCUBHV0EQKOSU4aK_1BMFRIXG6pkLViqDRbzIm7TA,406
 workos/__init__.py,sha256=hOdbO_MJCvpLx8EbRjQg-fvFAB-glJmrmxUZK8kWG0k,167
-workos/_base_client.py,sha256=YWLXBpd0YeID3WKYZkKa4l9ZuB9e6HgdLmPKZIzXsME,3599
+workos/_base_client.py,sha256=CIfAk6Bdj1hpOy3TcfIGXy8X4Efa7wi7cKracjkcTHk,3633
 workos/_client_configuration.py,sha256=g3eXhtrEMN6CW0hZ5uHb2PmLurXjyBkWZeQYMPeJD6s,222
-workos/async_client.py,sha256=c_lP7y49k3FEx0S6We8PrEw3PhTkD0VHyHJaKgc51HU,4358
+workos/api_keys.py,sha256=3AljcqAO1uJYP315AZymX184eJ9X_gH7xa_rKU6rMjw,1817
+workos/async_client.py,sha256=OYwH4BMEQQSaQoKPgAxGs24TQQcaQQndoivCte-Y1FI,4594
 workos/audit_logs.py,sha256=bYoAoNO4FRSaT34UxiVkgTXCVH8givcS2YGhH_9O3NA,3983
-workos/client.py,sha256=hIm87iNtKfwQ93H5aRXnhTqUJIOzUEG1GX0jdLBLAYc,4345
+workos/client.py,sha256=18fDBbsUnHnJj3WqxEmX72oWxgfJvCWIH1CFb_gsjkU,4566
 workos/directory_sync.py,sha256=6Z1gHz1LWNy56EtkXwNm6jhRRcvsJ7ASeDLy_Q1oKM0,14601
 workos/events.py,sha256=b4JIzMbd5LlVtpOMKVojC70RCHAgmLN3nJ62_2U0GwI,3892
 workos/exceptions.py,sha256=wYDlbMLVxrKQTF0M6ExFlxS5YEkvNZ4BeWLryRxcAFs,2335
@@ -25,6 +26,8 @@ workos/types/__init__.py,sha256=aYScTXq5jOyp0AYvdWffaj5-zdDuNtCCJtbzt5GM19k,267
 workos/types/list_resource.py,sha256=VcJaz8qE91y9t-PRI0mTjzPdtyoU8EGAo6-TJGjbqzg,6747
 workos/types/metadata.py,sha256=uUqDkGJGyFY3H4JZObSiCfn4jKBue5CBhOqv79TI1n0,52
 workos/types/workos_model.py,sha256=bV_p3baadcUJOU_7f6ysZ6KXhpt3E_93spuZnfJs9vc,735
+workos/types/api_keys/__init__.py,sha256=CMjEAI6EAO2En9UUwvEQW6EAVuV6l5wWPvmuKH8oKhs,53
+workos/types/api_keys/api_keys.py,sha256=eVpXS6hhLCFhIqJ_oQNIbwjL9u0blVykjpQxZEEKDS8,403
 workos/types/audit_logs/__init__.py,sha256=daPn8wAVEnlM1fCpOsy3dVZV_0YEp8bA1T_nhk5-pU8,211
 workos/types/audit_logs/audit_log_event.py,sha256=GVvbu3JJpXW-N16zdWi-0c3W9z_t3JB7Y6-Rc463upw,672
 workos/types/audit_logs/audit_log_event_actor.py,sha256=vYojEwq4EPwAO01p_9FmVuKg6Cr7lycrWkldB_W26GA,320
@@ -39,7 +42,7 @@ workos/types/directory_sync/directory_state.py,sha256=4qaD1Snonde1oVj1tDUITzXh0i
 workos/types/directory_sync/directory_type.py,sha256=NuHJzxI80WjxKiCSwMj1dfMpfB4o5JHErfLWfxCnKRs,443
 workos/types/directory_sync/directory_user.py,sha256=ZIlhkR2afO5cvWxEXAWsYjOy_sBC9_GBFaa5B3ZYyBo,2135
 workos/types/directory_sync/list_filters.py,sha256=Q4jlocRp4DguCm5e4Oo7udK7IfKmm3N1Rojtg4Eu96w,449
-workos/types/events/__init__.py,sha256=t_Pt--jhehN-qFACREbSsZbUFQjQDe12xU-dQAjZfoI,548
+workos/types/events/__init__.py,sha256=RX4PyjatDLhmNOV_9I08TfY1KjQZWL4CX6LbxhrMxaQ,540
 workos/types/events/authentication_payload.py,sha256=-4DhxWNxyd0Q01w2R4RyoQAwxNrRKMYJAdcRJUrzjEk,1779
 workos/types/events/connection_payload_with_legacy_fields.py,sha256=d0x4BHDMQfrCehKlaU40FcufBiASOtN38idfR5d8hbY,139
 workos/types/events/directory_group_membership_payload.py,sha256=PD81lhsRWUxQmugKo7pm_E6rVAaiBa2sjDYVAoSPGVU,300
@@ -47,13 +50,13 @@ workos/types/events/directory_group_with_previous_attributes.py,sha256=13VLNhdJZ
 workos/types/events/directory_payload.py,sha256=tRo3f9g8VoYertSUPAR25iGDyGLr2Dtb2mTkl73PAeA,503
 workos/types/events/directory_payload_with_legacy_fields.py,sha256=jk9nLmRqgllVkBG4EU3uTgcDOhCNptHgCh93U7aBAYE,1005
 workos/types/events/directory_user_with_previous_attributes.py,sha256=PhnO3WakBxAvnlOGf0UB0bvoppUYlwLyU-g9X_pPdko,244
-workos/types/events/event.py,sha256=5EOOtI7z6Gti5LlkVrHFojp1MWxJc6JL0fAvmp6DQ-k,10090
-workos/types/events/event_model.py,sha256=TuCRgjgTWnTvwL3NTR9FBGuF7WO34OhsbtMGKss5QKA,3722
-workos/types/events/event_type.py,sha256=6pIPTHAwcjpvihWCK4cgNeSG_pSTqD4sZrBczu4EP5A,1743
+workos/types/events/event.py,sha256=oSNel0-Wom2sRyJki7fKokV95Py-ujzbz6mE3Yd1sB0,10249
+workos/types/events/event_model.py,sha256=T7LhScyPfAFoOLJdRK_LsS3aEuePSa1kcH3IzwvNRCw,3778
+workos/types/events/event_type.py,sha256=YgxVsHTau5TGlgDIvruS7NGX7buMWbCCYIF9bV9BAuM,1766
 workos/types/events/list_filters.py,sha256=P04zmRynx9VPqNX_MBXA-3KA6flPZJogtIUqTI7w9Eg,305
 workos/types/events/organization_domain_verification_failed_payload.py,sha256=b4wX8HVbL9Nx6fCjOXkZg9eLc-Bv6YqAjMap1f7UvFc,470
 workos/types/events/previous_attributes.py,sha256=DxolwLwzcnG8r_W6rh5BT29iDfSVsIELvRYJ0NCrNn0,72
-workos/types/events/session_created_payload.py,sha256=F4eKjmetgyRIluNBDUmB2OXq8hDWEVjALJ4rrT2IHJs,462
+workos/types/events/session_payload.py,sha256=fErEOkbZtuJSAnbJPaUJg5ZsUj5u05w6WHQguo_fZEM,770
 workos/types/feature_flags/__init__.py,sha256=zQpY624xaDw8t94ZbNrl_iH9bHPrSYYSKHVDnd7XTmc,91
 workos/types/feature_flags/feature_flag.py,sha256=fS1RP_mOJKMmnaNqpSsePkixbJAExx-153IKb29kC-4,268
 workos/types/feature_flags/list_filters.py,sha256=iTnz1KNzxXAJunBMg-ZE63Mh2DaCFmS4S_q6AoL3rbI,112
@@ -111,7 +114,7 @@ workos/types/vault/__init__.py,sha256=krBuIl8luysrtDf9-b8KTkXOHDOaSsOR-Aao6Wlil0
 workos/types/vault/key.py,sha256=x30XBplSj9AviDDAB8MdpcULbZvvo2sUzi8RCmZQKxU,453
 workos/types/vault/object.py,sha256=-rk4KovS3eT8T8L3JltYUS0cd2Rg1JKcAX9SOaZO3D8,664
 workos/types/webhooks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-workos/types/webhooks/webhook.py,sha256=C7PcSxQFVKxQ81K_XlO2WUHYA9U6rm4dKzltiY4yxW0,10301
+workos/types/webhooks/webhook.py,sha256=BtPliPkUWJgXYRCZCwZNLfCL-pBNaUrUxMyCvlmiMqM,10466
 workos/types/webhooks/webhook_model.py,sha256=v7Hgtzt0nW_5RaYoB_QGVfElhdjySuG3F1BFjoid36w,404
 workos/types/webhooks/webhook_payload.py,sha256=GXt31KtyBM-ji5K5p4dBnu46Gh8adQWTq0ye5USB_6g,68
 workos/types/widgets/__init__.py,sha256=z2Tdlj_bJsRZeJRh4SOFX58PvJdf0LjKnYhrQX1fpME,65
@@ -128,8 +131,8 @@ workos/utils/crypto_provider.py,sha256=QeQSR4t9xLlb90kEfl8onVUsf1yCkYq0EjFTxK0mU
 workos/utils/http_client.py,sha256=TM5yMFFExmAE8D2Z43-5O301tRbnylLG0aXO0isGorE,6197
 workos/utils/pagination_order.py,sha256=_-et1DDJLG0czarTU7op4W6RA0V1f85GNsUgtyRU55Q,70
 workos/utils/request_helper.py,sha256=NaO16qPPbSNnCeE0fiNKYb8gM-dK_okYVJbLGrEGXz8,793
-workos-5.34.1.dist-info/LICENSE,sha256=mU--WL1JzelH2tXpKVoOlpud4cpqKSRTtdArCvYZmb4,1063
-workos-5.34.1.dist-info/METADATA,sha256=HJuPrxINb6WjCQ8xJXpXYSk6gmrkfwKft_EJ2Z2OnXs,4187
-workos-5.34.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-workos-5.34.1.dist-info/top_level.txt,sha256=ZFskIfue1Tw-JwjyIXRvdsAl9i0DX9VbqmgICXV84Sk,7
-workos-5.34.1.dist-info/RECORD,,
+workos-5.36.0.dist-info/LICENSE,sha256=mU--WL1JzelH2tXpKVoOlpud4cpqKSRTtdArCvYZmb4,1063
+workos-5.36.0.dist-info/METADATA,sha256=ZcAKRLSBUOHl2eVwFWVYKNfufg4vxDeSe9JvzHlBELY,4187
+workos-5.36.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+workos-5.36.0.dist-info/top_level.txt,sha256=ZFskIfue1Tw-JwjyIXRvdsAl9i0DX9VbqmgICXV84Sk,7
+workos-5.36.0.dist-info/RECORD,,