cleanup

Author: swaroopAkkineniWorkos

tests/test_audit_logs.py

@@ -4,6 +4,7 @@
 
 from workos.audit_logs import AuditLogEvent, AuditLogs
 from workos.exceptions import AuthenticationException, BadRequestException
+from workos.types.audit_logs.audit_log_event_response import AuditLogEventResponse
 
 
 class _TestSetup:
@@ -84,7 +85,9 @@ def test_succeeds(self, capture_and_mock_http_client_request):
                 "organization_id": organization_id,
                 "event": event,
             }
-            assert response is None
+            assert response is not None
+            assert response.success is True
+            assert isinstance(response, AuditLogEventResponse)
 
         def test_sends_idempotency_key(
             self, mock_audit_log_event, capture_and_mock_http_client_request
@@ -104,7 +107,8 @@ def test_sends_idempotency_key(
             )
 
             assert request_kwargs["headers"]["idempotency-key"] == idempotency_key
-            assert response is None
+            assert response is not None
+            assert response.success is True
 
         def test_auto_generates_idempotency_key(
             self, mock_audit_log_event, capture_and_mock_http_client_request
@@ -130,7 +134,8 @@ def test_auto_generates_idempotency_key(
             assert idempotency_key.startswith("workos-python-")
             # Assert the key has the expected UUID format after the prefix
             assert len(idempotency_key) > len("workos-python-")
-            assert response is None
+            assert response is not None
+            assert response.success is True
 
         def test_throws_unauthorized_exception(
             self, mock_audit_log_event, mock_http_client_with_response
@@ -178,6 +183,74 @@ def test_throws_badrequest_excpetion(
                     == "Audit Log could not be processed due to missing or incorrect data."
                 )
 
+        def test_handles_missing_success_field(
+            self, mock_audit_log_event, mock_http_client_with_response
+        ):
+            """Test that schema validation fails when response is missing required fields."""
+            organization_id = "org_123456789"
+
+            # Mock response missing the 'success' field
+            mock_http_client_with_response(
+                self.http_client,
+                {},  # Empty response
+                200,
+            )
+
+            with pytest.raises(Exception) as excinfo:  # Pydantic will raise ValidationError
+                self.audit_logs.create_event(
+                    organization_id=organization_id,
+                    event=mock_audit_log_event,
+                )
+
+            # Assert that validation error occurred
+            assert "success" in str(excinfo.value).lower() or "validation" in str(
+                excinfo.value
+            ).lower()
+
+        def test_handles_invalid_success_type(
+            self, mock_audit_log_event, mock_http_client_with_response
+        ):
+            """Test that schema validation fails when response has incorrect field types."""
+            organization_id = "org_123456789"
+
+            # Mock response with wrong type for 'success' field (non-coercible value)
+            mock_http_client_with_response(
+                self.http_client,
+                {"success": ["invalid", "list"]},  # List instead of boolean
+                200,
+            )
+
+            with pytest.raises(Exception) as excinfo:  # Pydantic will raise ValidationError
+                self.audit_logs.create_event(
+                    organization_id=organization_id,
+                    event=mock_audit_log_event,
+                )
+
+            # Assert that validation error occurred
+            assert excinfo.value is not None
+
+        def test_handles_malformed_json_response(
+            self, mock_audit_log_event, mock_http_client_with_response
+        ):
+            """Test that schema validation fails when response is completely malformed."""
+            organization_id = "org_123456789"
+
+            # Mock response with unexpected structure
+            mock_http_client_with_response(
+                self.http_client,
+                {"unexpected": "data", "structure": 123},
+                200,
+            )
+
+            with pytest.raises(Exception) as excinfo:
+                self.audit_logs.create_event(
+                    organization_id=organization_id,
+                    event=mock_audit_log_event,
+                )
+
+            # Assert that validation error occurred
+            assert excinfo.value is not None
+
     class TestCreateExport(_TestSetup):
         def test_succeeds(self, mock_http_client_with_response):
             organization_id = "org_123456789"

workos/audit_logs.py

@@ -3,6 +3,7 @@
 
 from workos.types.audit_logs import AuditLogExport
 from workos.types.audit_logs.audit_log_event import AuditLogEvent
+from workos.types.audit_logs.audit_log_event_response import AuditLogEventResponse
 from workos.utils._base_http_client import RetryConfig
 from workos.utils.http_client import SyncHTTPClient
 from workos.utils.request_helper import REQUEST_METHOD_GET, REQUEST_METHOD_POST
@@ -20,15 +21,15 @@ def create_event(
         organization_id: str,
         event: AuditLogEvent,
         idempotency_key: Optional[str] = None,
-    ) -> None:
+    ) -> AuditLogEventResponse:
         """Create an Audit Logs event.
 
         Kwargs:
             organization_id (str): Organization's unique identifier.
             event (AuditLogEvent): An AuditLogEvent object.
             idempotency_key (str): Idempotency key. (Optional)
         Returns:
-            None
+            AuditLogEventResponse: Response indicating success
         """
         ...
 
@@ -80,7 +81,7 @@ def create_event(
         organization_id: str,
         event: AuditLogEvent,
         idempotency_key: Optional[str] = None,
-    ) -> None:
+    ) -> AuditLogEventResponse:
         json = {"organization_id": organization_id, "event": event}
 
         headers = {}
@@ -91,14 +92,16 @@ def create_event(
         headers["idempotency-key"] = idempotency_key
 
         # Enable retries for audit log event creation with default retryConfig
-        self._http_client.request(
+        response = self._http_client.request(
             EVENTS_PATH,
             method=REQUEST_METHOD_POST,
             json=json,
             headers=headers,
             retry_config=RetryConfig(),
         )
 
+        return AuditLogEventResponse.model_validate(response)
+
     def create_export(
         self,
         *,

workos/types/audit_logs/__init__.py

@@ -2,5 +2,6 @@
 from .audit_log_event_context import *
 from .audit_log_event_target import *
 from .audit_log_event import *
+from .audit_log_event_response import *
 from .audit_log_export import *
 from .audit_log_metadata import *

workos/types/audit_logs/audit_log_event_response.py

@@ -0,0 +1,8 @@
+from workos.types.workos_model import WorkOSModel
+
+
+class AuditLogEventResponse(WorkOSModel):
+    """Response from creating an audit log event."""
+
+    success: bool
+