workos 5.39.1__py3-none-any.whl → 5.40.1__py3-none-any.whl

workos/async_client.py

@@ -2,7 +2,7 @@ from typing import Optional
 from importlib.metadata import version
 from workos._base_client import BaseClient
 from workos.api_keys import AsyncApiKeys
-from workos.audit_logs import AuditLogsModule
+from workos.audit_logs import AsyncAuditLogs
 from workos.directory_sync import AsyncDirectorySync
 from workos.events import AsyncEvents
 from workos.fga import FGAModule
@@ -64,10 +64,10 @@ class AsyncClient(BaseClient):
         return self._sso
 
     @property
-    def audit_logs(self) -> AuditLogsModule:
-        raise NotImplementedError(
-            "Audit logs APIs are not yet supported in the async client."
-        )
+    def audit_logs(self) -> AsyncAuditLogs:
+        if not getattr(self, "_audit_logs", None):
+            self._audit_logs = AsyncAuditLogs(self._http_client)
+        return self._audit_logs
 
     @property
     def directory_sync(self) -> AsyncDirectorySync:

workos/audit_logs.py

@@ -1,12 +1,44 @@
-from typing import Optional, Protocol, Sequence
+from typing import Dict, Literal, Optional, Protocol, Sequence
 
-from workos.types.audit_logs import AuditLogExport
+from workos.types.audit_logs import (
+    AuditLogAction,
+    AuditLogConfiguration,
+    AuditLogExport,
+    AuditLogRetention,
+    AuditLogSchema,
+    AuditLogSchemaListFilters,
+    AuditLogActionListFilters,
+)
+from workos.types.audit_logs.audit_log_schema_input import (
+    AuditLogSchemaActorInput,
+    AuditLogSchemaTargetInput,
+    MetadataSchemaInput,
+    serialize_schema_options,
+)
 from workos.types.audit_logs.audit_log_event import AuditLogEvent
-from workos.utils.http_client import SyncHTTPClient
-from workos.utils.request_helper import REQUEST_METHOD_GET, REQUEST_METHOD_POST
+from workos.types.list_resource import ListMetadata, ListPage, WorkOSListResource
+from workos.typing.sync_or_async import SyncOrAsync
+from workos.utils.http_client import AsyncHTTPClient, SyncHTTPClient
+from workos.utils.pagination_order import PaginationOrder
+from workos.utils.request_helper import (
+    DEFAULT_LIST_RESPONSE_LIMIT,
+    REQUEST_METHOD_GET,
+    REQUEST_METHOD_POST,
+    REQUEST_METHOD_PUT,
+)
 
 EVENTS_PATH = "audit_logs/events"
 EXPORTS_PATH = "audit_logs/exports"
+ACTIONS_PATH = "audit_logs/actions"
+
+
+AuditLogActionsListResource = WorkOSListResource[
+    AuditLogAction, AuditLogActionListFilters, ListMetadata
+]
+
+AuditLogSchemasListResource = WorkOSListResource[
+    AuditLogSchema, AuditLogSchemaListFilters, ListMetadata
+]
 
 
 class AuditLogsModule(Protocol):
@@ -18,7 +50,7 @@ class AuditLogsModule(Protocol):
         organization_id: str,
         event: AuditLogEvent,
         idempotency_key: Optional[str] = None,
-    ) -> None:
+    ) -> SyncOrAsync[None]:
         """Create an Audit Logs event.
 
         Kwargs:
@@ -40,7 +72,7 @@ class AuditLogsModule(Protocol):
         targets: Optional[Sequence[str]] = None,
         actor_names: Optional[Sequence[str]] = None,
         actor_ids: Optional[Sequence[str]] = None,
-    ) -> AuditLogExport:
+    ) -> SyncOrAsync[AuditLogExport]:
         """Trigger the creation of an export of audit logs.
 
         Kwargs:
@@ -49,6 +81,7 @@ class AuditLogsModule(Protocol):
             range_end (str): End date of the date range filter.
             actions (list): Optional list of actions to filter. (Optional)
             actor_names (list): Optional list of actors to filter by name. (Optional)
+            actor_ids (list): Optional list of actors to filter by ID. (Optional)
             targets (list): Optional list of targets to filter. (Optional)
 
         Returns:
@@ -56,15 +89,129 @@ class AuditLogsModule(Protocol):
         """
         ...
 
-    def get_export(self, audit_log_export_id: str) -> AuditLogExport:
-        """Retrieve an created export.
+    def get_export(self, audit_log_export_id: str) -> SyncOrAsync[AuditLogExport]:
+        """Retrieve a created export.
+
         Args:
             audit_log_export_id (str): Audit log export unique identifier.
+
         Returns:
             AuditLogExport: Object that describes the audit log export
         """
         ...
 
+    def create_schema(
+        self,
+        *,
+        action: str,
+        targets: Sequence[AuditLogSchemaTargetInput],
+        actor: Optional[AuditLogSchemaActorInput] = None,
+        metadata: Optional[MetadataSchemaInput] = None,
+        idempotency_key: Optional[str] = None,
+    ) -> SyncOrAsync[AuditLogSchema]:
+        """Create an Audit Log schema for an action.
+
+        Kwargs:
+            action (str): The action name for the schema (e.g., 'user.signed_in').
+            targets (list): List of target definitions with type and optional metadata.
+                Each target has a 'type' and optional 'metadata' mapping property
+                names to types (e.g., {"status": "string"}).
+            actor (dict): Optional actor definition with metadata schema. (Optional)
+                The metadata maps property names to types (e.g., {"role": "string"}).
+            metadata (dict): Optional event-level metadata schema. (Optional)
+                Maps property names to types (e.g., {"invoice_id": "string"}).
+            idempotency_key (str): Idempotency key. (Optional)
+
+        Returns:
+            AuditLogSchema: The created audit log schema
+        """
+        ...
+
+    def list_schemas(
+        self,
+        *,
+        action: str,
+        limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
+        before: Optional[str] = None,
+        after: Optional[str] = None,
+        order: PaginationOrder = "desc",
+    ) -> SyncOrAsync[AuditLogSchemasListResource]:
+        """List all schemas for an Audit Log action.
+
+        Kwargs:
+            action (str): The action name to list schemas for.
+            limit (int): Maximum number of records to return. (Optional)
+            before (str): Pagination cursor to receive records before a provided ID. (Optional)
+            after (str): Pagination cursor to receive records after a provided ID. (Optional)
+            order (Literal["asc","desc"]): Sort order by created_at timestamp. (Optional)
+
+        Returns:
+            AuditLogSchemasListResource: Paginated list of audit log schemas
+        """
+        ...
+
+    def list_actions(
+        self,
+        *,
+        limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
+        before: Optional[str] = None,
+        after: Optional[str] = None,
+        order: PaginationOrder = "desc",
+    ) -> SyncOrAsync[AuditLogActionsListResource]:
+        """List all registered Audit Log actions.
+
+        Kwargs:
+            limit (int): Maximum number of records to return. (Optional)
+            before (str): Pagination cursor to receive records before a provided ID. (Optional)
+            after (str): Pagination cursor to receive records after a provided ID. (Optional)
+            order (Literal["asc","desc"]): Sort order by created_at timestamp. (Optional)
+
+        Returns:
+            AuditLogActionsListResource: Paginated list of audit log actions
+        """
+        ...
+
+    def get_retention(self, organization_id: str) -> SyncOrAsync[AuditLogRetention]:
+        """Get the event retention period for an organization.
+
+        Args:
+            organization_id (str): Organization's unique identifier.
+
+        Returns:
+            AuditLogRetention: The retention configuration
+        """
+        ...
+
+    def set_retention(
+        self,
+        *,
+        organization_id: str,
+        retention_period_in_days: Literal[30, 365],
+    ) -> SyncOrAsync[AuditLogRetention]:
+        """Set the event retention period for an organization.
+
+        Kwargs:
+            organization_id (str): Organization's unique identifier.
+            retention_period_in_days (int): The number of days to retain events (30 or 365).
+
+        Returns:
+            AuditLogRetention: The updated retention configuration
+        """
+        ...
+
+    def get_configuration(
+        self, organization_id: str
+    ) -> SyncOrAsync[AuditLogConfiguration]:
+        """Get the audit log configuration for an organization.
+
+        Args:
+            organization_id (str): Organization's unique identifier.
+
+        Returns:
+            AuditLogConfiguration: The complete audit log configuration
+        """
+        ...
+
 
 class AuditLogs(AuditLogsModule):
     _http_client: SyncHTTPClient
@@ -81,7 +228,7 @@ class AuditLogs(AuditLogsModule):
     ) -> None:
         json = {"organization_id": organization_id, "event": event}
 
-        headers = {}
+        headers: Dict[str, str] = {}
         if idempotency_key:
             headers["idempotency-key"] = idempotency_key
 
@@ -118,8 +265,297 @@ class AuditLogs(AuditLogsModule):
 
     def get_export(self, audit_log_export_id: str) -> AuditLogExport:
         response = self._http_client.request(
-            "{0}/{1}".format(EXPORTS_PATH, audit_log_export_id),
+            f"{EXPORTS_PATH}/{audit_log_export_id}",
+            method=REQUEST_METHOD_GET,
+        )
+
+        return AuditLogExport.model_validate(response)
+
+    def create_schema(
+        self,
+        *,
+        action: str,
+        targets: Sequence[AuditLogSchemaTargetInput],
+        actor: Optional[AuditLogSchemaActorInput] = None,
+        metadata: Optional[MetadataSchemaInput] = None,
+        idempotency_key: Optional[str] = None,
+    ) -> AuditLogSchema:
+        json = serialize_schema_options(targets, actor, metadata)
+
+        headers: Dict[str, str] = {}
+        if idempotency_key:
+            headers["idempotency-key"] = idempotency_key
+
+        response = self._http_client.request(
+            f"{ACTIONS_PATH}/{action}/schemas",
+            method=REQUEST_METHOD_POST,
+            json=json,
+            headers=headers,
+        )
+
+        return AuditLogSchema.model_validate(response)
+
+    def list_schemas(
+        self,
+        *,
+        action: str,
+        limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
+        before: Optional[str] = None,
+        after: Optional[str] = None,
+        order: PaginationOrder = "desc",
+    ) -> AuditLogSchemasListResource:
+        list_params: AuditLogSchemaListFilters = {
+            "limit": limit,
+            "before": before,
+            "after": after,
+            "order": order,
+        }
+
+        response = self._http_client.request(
+            f"{ACTIONS_PATH}/{action}/schemas",
+            method=REQUEST_METHOD_GET,
+            params=list_params,
+        )
+
+        return WorkOSListResource[
+            AuditLogSchema, AuditLogSchemaListFilters, ListMetadata
+        ](
+            list_method=lambda **kwargs: self.list_schemas(action=action, **kwargs),
+            list_args=list_params,
+            **ListPage[AuditLogSchema](**response).model_dump(),
+        )
+
+    def list_actions(
+        self,
+        *,
+        limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
+        before: Optional[str] = None,
+        after: Optional[str] = None,
+        order: PaginationOrder = "desc",
+    ) -> AuditLogActionsListResource:
+        list_params: AuditLogActionListFilters = {
+            "limit": limit,
+            "before": before,
+            "after": after,
+            "order": order,
+        }
+
+        response = self._http_client.request(
+            ACTIONS_PATH,
+            method=REQUEST_METHOD_GET,
+            params=list_params,
+        )
+
+        return WorkOSListResource[
+            AuditLogAction, AuditLogActionListFilters, ListMetadata
+        ](
+            list_method=self.list_actions,
+            list_args=list_params,
+            **ListPage[AuditLogAction](**response).model_dump(),
+        )
+
+    def get_retention(self, organization_id: str) -> AuditLogRetention:
+        response = self._http_client.request(
+            f"organizations/{organization_id}/audit_logs_retention",
+            method=REQUEST_METHOD_GET,
+        )
+
+        return AuditLogRetention.model_validate(response)
+
+    def set_retention(
+        self,
+        *,
+        organization_id: str,
+        retention_period_in_days: Literal[30, 365],
+    ) -> AuditLogRetention:
+        json = {"retention_period_in_days": retention_period_in_days}
+
+        response = self._http_client.request(
+            f"organizations/{organization_id}/audit_logs_retention",
+            method=REQUEST_METHOD_PUT,
+            json=json,
+        )
+
+        return AuditLogRetention.model_validate(response)
+
+    def get_configuration(self, organization_id: str) -> AuditLogConfiguration:
+        response = self._http_client.request(
+            f"organizations/{organization_id}/audit_log_configuration",
+            method=REQUEST_METHOD_GET,
+        )
+
+        return AuditLogConfiguration.model_validate(response)
+
+
+class AsyncAuditLogs(AuditLogsModule):
+    _http_client: AsyncHTTPClient
+
+    def __init__(self, http_client: AsyncHTTPClient):
+        self._http_client = http_client
+
+    async def create_event(
+        self,
+        *,
+        organization_id: str,
+        event: AuditLogEvent,
+        idempotency_key: Optional[str] = None,
+    ) -> None:
+        json = {"organization_id": organization_id, "event": event}
+
+        headers: Dict[str, str] = {}
+        if idempotency_key:
+            headers["idempotency-key"] = idempotency_key
+
+        await self._http_client.request(
+            EVENTS_PATH, method=REQUEST_METHOD_POST, json=json, headers=headers
+        )
+
+    async def create_export(
+        self,
+        *,
+        organization_id: str,
+        range_start: str,
+        range_end: str,
+        actions: Optional[Sequence[str]] = None,
+        targets: Optional[Sequence[str]] = None,
+        actor_names: Optional[Sequence[str]] = None,
+        actor_ids: Optional[Sequence[str]] = None,
+    ) -> AuditLogExport:
+        json = {
+            "actions": actions,
+            "actor_ids": actor_ids,
+            "actor_names": actor_names,
+            "organization_id": organization_id,
+            "range_start": range_start,
+            "range_end": range_end,
+            "targets": targets,
+        }
+
+        response = await self._http_client.request(
+            EXPORTS_PATH, method=REQUEST_METHOD_POST, json=json
+        )
+
+        return AuditLogExport.model_validate(response)
+
+    async def get_export(self, audit_log_export_id: str) -> AuditLogExport:
+        response = await self._http_client.request(
+            f"{EXPORTS_PATH}/{audit_log_export_id}",
             method=REQUEST_METHOD_GET,
         )
 
         return AuditLogExport.model_validate(response)
+
+    async def create_schema(
+        self,
+        *,
+        action: str,
+        targets: Sequence[AuditLogSchemaTargetInput],
+        actor: Optional[AuditLogSchemaActorInput] = None,
+        metadata: Optional[MetadataSchemaInput] = None,
+        idempotency_key: Optional[str] = None,
+    ) -> AuditLogSchema:
+        json = serialize_schema_options(targets, actor, metadata)
+
+        headers: Dict[str, str] = {}
+        if idempotency_key:
+            headers["idempotency-key"] = idempotency_key
+
+        response = await self._http_client.request(
+            f"{ACTIONS_PATH}/{action}/schemas",
+            method=REQUEST_METHOD_POST,
+            json=json,
+            headers=headers,
+        )
+
+        return AuditLogSchema.model_validate(response)
+
+    async def list_schemas(
+        self,
+        *,
+        action: str,
+        limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
+        before: Optional[str] = None,
+        after: Optional[str] = None,
+        order: PaginationOrder = "desc",
+    ) -> AuditLogSchemasListResource:
+        list_params: AuditLogSchemaListFilters = {
+            "limit": limit,
+            "before": before,
+            "after": after,
+            "order": order,
+        }
+
+        response = await self._http_client.request(
+            f"{ACTIONS_PATH}/{action}/schemas",
+            method=REQUEST_METHOD_GET,
+            params=list_params,
+        )
+
+        return WorkOSListResource[
+            AuditLogSchema, AuditLogSchemaListFilters, ListMetadata
+        ](
+            list_method=lambda **kwargs: self.list_schemas(action=action, **kwargs),
+            list_args=list_params,
+            **ListPage[AuditLogSchema](**response).model_dump(),
+        )
+
+    async def list_actions(
+        self,
+        *,
+        limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
+        before: Optional[str] = None,
+        after: Optional[str] = None,
+        order: PaginationOrder = "desc",
+    ) -> AuditLogActionsListResource:
+        list_params: AuditLogActionListFilters = {
+            "limit": limit,
+            "before": before,
+            "after": after,
+            "order": order,
+        }
+
+        response = await self._http_client.request(
+            ACTIONS_PATH,
+            method=REQUEST_METHOD_GET,
+            params=list_params,
+        )
+
+        return WorkOSListResource[
+            AuditLogAction, AuditLogActionListFilters, ListMetadata
+        ](
+            list_method=self.list_actions,
+            list_args=list_params,
+            **ListPage[AuditLogAction](**response).model_dump(),
+        )
+
+    async def get_retention(self, organization_id: str) -> AuditLogRetention:
+        response = await self._http_client.request(
+            f"organizations/{organization_id}/audit_logs_retention",
+            method=REQUEST_METHOD_GET,
+        )
+
+        return AuditLogRetention.model_validate(response)
+
+    async def set_retention(
+        self,
+        *,
+        organization_id: str,
+        retention_period_in_days: Literal[30, 365],
+    ) -> AuditLogRetention:
+        json = {"retention_period_in_days": retention_period_in_days}
+
+        response = await self._http_client.request(
+            f"organizations/{organization_id}/audit_logs_retention",
+            method=REQUEST_METHOD_PUT,
+            json=json,
+        )
+
+        return AuditLogRetention.model_validate(response)
+
+    async def get_configuration(self, organization_id: str) -> AuditLogConfiguration:
+        response = await self._http_client.request(
+            f"organizations/{organization_id}/audit_log_configuration",
+            method=REQUEST_METHOD_GET,
+        )
+
+        return AuditLogConfiguration.model_validate(response)

workos/types/audit_logs/__init__.py

@@ -1,6 +1,12 @@
+from .audit_log_action import *
+from .audit_log_configuration import *
 from .audit_log_event_actor import *
 from .audit_log_event_context import *
 from .audit_log_event_target import *
 from .audit_log_event import *
 from .audit_log_export import *
 from .audit_log_metadata import *
+from .audit_log_retention import *
+from .audit_log_schema import *
+from .audit_log_schema_input import *
+from .list_filters import *

workos/types/audit_logs/audit_log_action.py

@@ -0,0 +1,28 @@
+import warnings
+from typing import Literal
+
+from workos.types.audit_logs.audit_log_schema import AuditLogSchema
+from workos.types.workos_model import WorkOSModel
+
+# Suppress Pydantic warning about 'schema' shadowing BaseModel.schema()
+# (a deprecated method replaced by model_json_schema() in Pydantic v2)
+warnings.filterwarnings(
+    "ignore",
+    message='Field name "schema" in "AuditLogAction" shadows an attribute',
+    category=UserWarning,
+)
+
+
+class AuditLogAction(WorkOSModel):
+    """Representation of a WorkOS audit log action.
+
+    An audit log action represents a configured action type that can be
+    used in audit log events. Each action has an associated schema that
+    defines the structure of events for that action.
+    """
+
+    object: Literal["audit_log_action"]
+    name: str
+    schema: AuditLogSchema  # type: ignore[assignment]
+    created_at: str
+    updated_at: str

workos/types/audit_logs/audit_log_configuration.py

@@ -0,0 +1,41 @@
+from typing import Literal, Optional
+
+from workos.types.workos_model import WorkOSModel
+from workos.typing.literals import LiteralOrUntyped
+
+
+AuditLogStreamType = Literal[
+    "Datadog", "Splunk", "S3", "GoogleCloudStorage", "GenericHttps"
+]
+
+AuditLogStreamState = Literal["active", "inactive", "error", "invalid"]
+
+AuditLogTrailState = Literal["active", "inactive", "disabled"]
+
+
+class AuditLogStream(WorkOSModel):
+    """Representation of a WorkOS audit log stream.
+
+    An audit log stream sends audit log events to an external destination
+    such as Datadog, Splunk, S3, Google Cloud Storage, or a custom HTTPS endpoint.
+    """
+
+    id: str
+    type: LiteralOrUntyped[AuditLogStreamType]
+    state: LiteralOrUntyped[AuditLogStreamState]
+    last_synced_at: Optional[str] = None
+    created_at: str
+
+
+class AuditLogConfiguration(WorkOSModel):
+    """Representation of a WorkOS audit log configuration for an organization.
+
+    The audit log configuration provides a single view of an organization's
+    audit logging setup, including retention settings, state, and optional
+    log stream configuration.
+    """
+
+    organization_id: str
+    retention_period_in_days: int
+    state: LiteralOrUntyped[AuditLogTrailState]
+    log_stream: Optional[AuditLogStream] = None

workos/types/audit_logs/audit_log_retention.py

@@ -0,0 +1,13 @@
+from typing import Optional
+
+from workos.types.workos_model import WorkOSModel
+
+
+class AuditLogRetention(WorkOSModel):
+    """Representation of a WorkOS audit log retention configuration.
+
+    Specifies how long audit log events are retained for an organization.
+    Valid values are 30 and 365 days, or None if not configured.
+    """
+
+    retention_period_in_days: Optional[int] = None

workos/types/audit_logs/audit_log_schema.py

@@ -0,0 +1,49 @@
+from typing import Dict, Literal, Optional, Sequence
+
+from workos.types.workos_model import WorkOSModel
+
+
+class AuditLogSchemaMetadataProperty(WorkOSModel):
+    """A property definition within an audit log schema metadata object."""
+
+    type: Literal["string", "boolean", "number"]
+
+
+class AuditLogSchemaMetadata(WorkOSModel):
+    """The metadata definition for an audit log schema.
+
+    Represents a JSON Schema object type with property definitions.
+    """
+
+    type: Literal["object"]
+    properties: Optional[Dict[str, AuditLogSchemaMetadataProperty]] = None
+
+
+class AuditLogSchemaTarget(WorkOSModel):
+    """A target definition within an audit log schema."""
+
+    type: str
+    metadata: Optional[AuditLogSchemaMetadata] = None
+
+
+class AuditLogSchemaActor(WorkOSModel):
+    """The actor definition within an audit log schema."""
+
+    metadata: AuditLogSchemaMetadata
+
+
+class AuditLogSchema(WorkOSModel):
+    """Representation of a WorkOS audit log schema.
+
+    Audit log schemas define the structure and validation rules
+    for audit log events, including the allowed targets, actor metadata,
+    and event-level metadata.
+    """
+
+    object: Literal["audit_log_schema"] = "audit_log_schema"
+    version: int
+    targets: Sequence[AuditLogSchemaTarget]
+    actor: Optional[AuditLogSchemaActor] = None
+    metadata: Optional[AuditLogSchemaMetadata] = None
+    created_at: Optional[str] = None
+    updated_at: Optional[str] = None

workos/types/audit_logs/audit_log_schema_input.py

@@ -0,0 +1,78 @@
+from typing import Any, Dict, Literal, Mapping, Optional, Sequence
+
+from typing_extensions import NotRequired, TypedDict
+
+MetadataSchemaInput = Mapping[str, Literal["string", "number", "boolean"]]
+
+
+class AuditLogSchemaTargetInput(TypedDict):
+    """Input type for target definitions when creating an audit log schema.
+
+    Attributes:
+        type: The target type identifier (e.g., "team", "user", "document").
+        metadata: Optional simplified metadata schema mapping property names to types.
+    """
+
+    type: str
+    metadata: NotRequired[MetadataSchemaInput]
+
+
+class AuditLogSchemaActorInput(TypedDict):
+    """Input type for actor definition when creating an audit log schema.
+
+    Attributes:
+        metadata: Simplified metadata schema mapping property names to types.
+    """
+
+    metadata: MetadataSchemaInput
+
+
+def _serialize_metadata(
+    metadata: Optional[MetadataSchemaInput],
+) -> Optional[Dict[str, Any]]:
+    """Transform simplified metadata to full JSON Schema format.
+
+    Transforms {"role": "string"} to:
+    {"type": "object", "properties": {"role": {"type": "string"}}}
+    """
+    if not metadata:
+        return None
+
+    properties: Dict[str, Dict[str, str]] = {}
+    for key, type_value in metadata.items():
+        properties[key] = {"type": type_value}
+
+    return {"type": "object", "properties": properties}
+
+
+def serialize_schema_options(
+    targets: Sequence[AuditLogSchemaTargetInput],
+    actor: Optional[AuditLogSchemaActorInput] = None,
+    metadata: Optional[MetadataSchemaInput] = None,
+) -> Dict[str, Any]:
+    """Serialize schema options from simplified format to API format.
+
+    Transforms the simplified input format (matching JS SDK ergonomics)
+    to the full JSON Schema format expected by the API.
+    """
+    result: Dict[str, Any] = {
+        "targets": [
+            {
+                "type": target["type"],
+                **(
+                    {"metadata": _serialize_metadata(target.get("metadata"))}
+                    if target.get("metadata")
+                    else {}
+                ),
+            }
+            for target in targets
+        ],
+    }
+
+    if actor is not None:
+        result["actor"] = {"metadata": _serialize_metadata(actor["metadata"])}
+
+    if metadata is not None:
+        result["metadata"] = _serialize_metadata(metadata)
+
+    return result

workos/types/audit_logs/list_filters.py

@@ -0,0 +1,13 @@
+from workos.types.list_resource import ListArgs
+
+
+class AuditLogActionListFilters(ListArgs, total=False):
+    """Filters for listing audit log actions."""
+
+    pass
+
+
+class AuditLogSchemaListFilters(ListArgs, total=False):
+    """Filters for listing audit log schemas."""
+
+    pass

workos/types/list_resource.py

@@ -17,6 +17,7 @@ from typing import (
     cast,
 )
 from typing_extensions import Required, TypedDict
+from workos.types.audit_logs import AuditLogAction, AuditLogSchema
 from workos.types.directory_sync import (
     Directory,
     DirectoryGroup,
@@ -42,6 +43,8 @@ from workos.utils.request_helper import DEFAULT_LIST_RESPONSE_LIMIT
 ListableResource = TypeVar(
     # add all possible generics of List Resource
     "ListableResource",
+    AuditLogAction,
+    AuditLogSchema,
     AuthenticationFactor,
     ConnectionWithDomains,
     Directory,

workos/types/user_management/invitation.py

@@ -15,6 +15,7 @@ class InvitationCommon(WorkOSModel):
     expires_at: str
     organization_id: Optional[str] = None
     inviter_user_id: Optional[str] = None
+    accepted_user_id: Optional[str] = None
     created_at: str
     updated_at: str
 

workos/types/user_management/organization_membership.py

@@ -1,4 +1,4 @@
-from typing import Literal, Sequence, Optional
+from typing import Any, Literal, Mapping, Optional, Sequence
 from typing_extensions import TypedDict
 
 from workos.types.workos_model import WorkOSModel
@@ -21,5 +21,6 @@ class OrganizationMembership(WorkOSModel):
     role: OrganizationMembershipRole
     roles: Optional[Sequence[OrganizationMembershipRole]] = None
     status: LiteralOrUntyped[OrganizationMembershipStatus]
+    custom_attributes: Mapping[str, Any]
     created_at: str
     updated_at: str

{workos-5.39.1.dist-info → workos-5.40.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: workos
-Version: 5.39.1
+Version: 5.40.1
 Summary: WorkOS Python Client
 Author: WorkOS
 Author-email: WorkOS <team@workos.com>

{workos-5.39.1.dist-info → workos-5.40.1.dist-info}/RECORD

@@ -2,8 +2,8 @@ workos/__init__.py,sha256=hOdbO_MJCvpLx8EbRjQg-fvFAB-glJmrmxUZK8kWG0k,167
 workos/_base_client.py,sha256=UIdpMKXqShq2Pq4_LsrvvID0V5E4KGhlsySBygP9660,3920
 workos/_client_configuration.py,sha256=FFOVVU5Pd04tNbLGOY_4pnBdGsqA6ficypTcTU8Q3iE,275
 workos/api_keys.py,sha256=3AljcqAO1uJYP315AZymX184eJ9X_gH7xa_rKU6rMjw,1817
-workos/async_client.py,sha256=CHK_4rHxQ88D5_BJsj_5EeSWbcKj_FqGq-CsfIRTSBw,4879
-workos/audit_logs.py,sha256=bYoAoNO4FRSaT34UxiVkgTXCVH8givcS2YGhH_9O3NA,3983
+workos/async_client.py,sha256=PZW4DI4LmYNJe0weNQjvOGHaHYdVu7QGaQSAH1i5hL8,4907
+workos/audit_logs.py,sha256=svHTq838MiS_rTyrMNPTRUoUuu1iBnpxIH1Dr6rxbkQ,18225
 workos/client.py,sha256=WFDREJnzpxu6_Cz-Vd1GfCudQsk1KOeHLiuac_jWgKw,4836
 workos/directory_sync.py,sha256=mo3NZ8aPGghav2JB73HTtG1uejihfN-9dN41J3OjNFg,15345
 workos/events.py,sha256=b4JIzMbd5LlVtpOMKVojC70RCHAgmLN3nJ62_2U0GwI,3892
@@ -21,13 +21,19 @@ workos/sso.py,sha256=ZBC3y-IRmxG0jPd0BOj7s7XQkXJoTLUg1fx-h3Gfy4g,13541
 workos/types/__init__.py,sha256=aYScTXq5jOyp0AYvdWffaj5-zdDuNtCCJtbzt5GM19k,267
 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/__init__.py,sha256=4q8IxKQAD3khdUcjjNo8Eh_OeM49WokvkU0usbeQSmA,415
+workos/types/audit_logs/audit_log_action.py,sha256=bHE7oIlLa9PLfb6MlMVb4IF12rA0LhlM8M-fzqna8GQ,894
+workos/types/audit_logs/audit_log_configuration.py,sha256=Q28wK-HDm70sFH9zPl-8-uY_fODkPvzgFi1cdI6Cc20,1273
 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
 workos/types/audit_logs/audit_log_event_context.py,sha256=Cc4a5oVrPf9PhydJfMBy5EiSxJqqLdb9D1pYm8T4Pp4,195
 workos/types/audit_logs/audit_log_event_target.py,sha256=cCK13Ya1n-7QKQKiIW2SjkQLq9AM5JVoWp_Rpxuamfc,327
 workos/types/audit_logs/audit_log_export.py,sha256=brU6HoNsq-H8jVDd9zRzCDkBnAD95yrFyrekhp3vSlE,466
 workos/types/audit_logs/audit_log_metadata.py,sha256=GaJrSxYboUpdJPz2jJf2uc4za9zwUrgqwRnTCl1dbpw,71
+workos/types/audit_logs/audit_log_retention.py,sha256=ifeAEFdRH0S3jEol3mo2oqa4GgLSAL0dUr4GjGHVTYI,388
+workos/types/audit_logs/audit_log_schema.py,sha256=Y7JGC5f559k0JbYbTQNcy1F2OzZO-Ud0zvJ2cFB8_ds,1438
+workos/types/audit_logs/audit_log_schema_input.py,sha256=GRYMHh77DljYZRFPXicwZpOMI4qwUyQN63_LfeHQowg,2339
+workos/types/audit_logs/list_filters.py,sha256=7CZ298Rxr-LHOlLMJ2fUmfQge8wBagXEVX8oIi9NHRU,282
 workos/types/directory_sync/__init__.py,sha256=U26Aq1DCRicStFn7Y4OcPRVjy_03c0C0fAWNi_4_d4s,147
 workos/types/directory_sync/directory.py,sha256=M7IvlTeKrLj-BpGeX-nafBM6BWUnHb3-1ninObWyuRY,902
 workos/types/directory_sync/directory_group.py,sha256=4bRB3inN72GfsJEA17OpMEI-_6hhdXFVGpTL0PWaXL0,439
@@ -60,7 +66,7 @@ workos/types/fga/check.py,sha256=6AIHsc2WmsXbpEFZcSTy2hIoSr2rmoLt-8wLWdSrc_E,127
 workos/types/fga/list_filters.py,sha256=wLQt_AJprmvglZSWv7ZRjwjD4b2vHL0V_7c9u-5u_Uw,640
 workos/types/fga/warnings.py,sha256=hX2A-PvXpy9rH0E4_-8Hfrv_to0tgL6jqeGzhz-N2yA,910
 workos/types/fga/warrant.py,sha256=aKO-9t0NGk-9oQs8j_gnG3VfNU6U9IdGCH4EN3imRWs,1016
-workos/types/list_resource.py,sha256=VcJaz8qE91y9t-PRI0mTjzPdtyoU8EGAo6-TJGjbqzg,6747
+workos/types/list_resource.py,sha256=mGp8Zs4CpaK0DlMYdI-5-nTbofxY-rPe5pSZP0kNR4U,6854
 workos/types/metadata.py,sha256=uUqDkGJGyFY3H4JZObSiCfn4jKBue5CBhOqv79TI1n0,52
 workos/types/mfa/__init__.py,sha256=-gHL2QwZYbqDGPrIMkUrciJm4EiSRz3fJVF55B3rKiM,253
 workos/types/mfa/authentication_challenge.py,sha256=V8UYutxCAxenaOeqWuPwQU0QcO4HD_0RoQbkG3sqgAU,436
@@ -96,11 +102,11 @@ workos/types/user_management/authenticate_with_common.py,sha256=2mGRfIgoeX5Ee7c_
 workos/types/user_management/authentication_response.py,sha256=2A6vU8FBEE7bXl5aULB-s80_xsR9caqC9tSr9Yq1NtE,1437
 workos/types/user_management/email_verification.py,sha256=4EqlN7qZBVTZGKaU9WdCSdgFjOMZtkYWTolE-h_hTXA,399
 workos/types/user_management/impersonator.py,sha256=_PAPYg_Q1M8wpwtnkQxuA2vtUIwvs_G30vYY91aqw8E,192
-workos/types/user_management/invitation.py,sha256=4fK-Fk786MlhzZvvOrZtU_6SCJXmem3xw62SkBE1c-0,721
+workos/types/user_management/invitation.py,sha256=qdQausiwLGCCJBUT8jEYYXoWVDPueFY24_SP0S8BLjQ,764
 workos/types/user_management/list_filters.py,sha256=9QH4UbU28LaZ1iyiMs8H6heqbWpbCunD2MYmO_qA9pY,756
 workos/types/user_management/magic_auth.py,sha256=Sda13_uMOC-hHlyGeOXNnCn-HrpwUmtrf2hO5ek9U98,359
 workos/types/user_management/oauth_tokens.py,sha256=pANk6AyqyRq6hrOrJYQ9AHALVxUbqhGnggzD8PVV-Ew,468
-workos/types/user_management/organization_membership.py,sha256=dllONFtD1IZZiyqxnV8lJpJyH55OeOeaHRBDZlcWLwk,735
+workos/types/user_management/organization_membership.py,sha256=bURjhJngjJilLHGhxRT53GFlhA8SJQ3WdJ-Rs33-B8U,790
 workos/types/user_management/password_hash_type.py,sha256=hT8UagiPJtYJn1pNouuCr8gzcksUDuTRZnyvzDh1vWw,128
 workos/types/user_management/password_reset.py,sha256=-NJCfEh4Q1xS9fFXJaF_acYeuUc9POqERLh8urMhqt8,403
 workos/types/user_management/screen_hint.py,sha256=DnPgvjRK-20i82v3YPzggna1rc6yOMyhiqwUdk01L3s,75
@@ -133,6 +139,6 @@ workos/utils/request_helper.py,sha256=9FgeDfz_hiHlbCkuo6bcBjSpdDM5ObRok9-G_jFedd
 workos/vault.py,sha256=fe2OkFLVV1U4x9E78baWGksPIxg32decAuawEaJ63w4,16417
 workos/webhooks.py,sha256=CuwBxh6va9VZFVSXOknveGt6CCGDF3em07a-J12DbXI,4790
 workos/widgets.py,sha256=YAjiffcewHXcPx2kjScGs2-xZpmYsed33UQ6xDTqjJM,1720
-workos-5.39.1.dist-info/WHEEL,sha256=eh7sammvW2TypMMMGKgsM83HyA_3qQ5Lgg3ynoecH3M,79
-workos-5.39.1.dist-info/METADATA,sha256=9QrcsQwmzvuLNItbr64khE15oFI_jPNwq2UaLfmLm3o,3348
-workos-5.39.1.dist-info/RECORD,,
+workos-5.40.1.dist-info/WHEEL,sha256=eh7sammvW2TypMMMGKgsM83HyA_3qQ5Lgg3ynoecH3M,79
+workos-5.40.1.dist-info/METADATA,sha256=1xvfkrr6x1yA4Q7_9eLhhSHSQyHJ3Um5lPmLFDGffdI,3348
+workos-5.40.1.dist-info/RECORD,,