workos 1.13.0__py3-none-any.whl → 5.38.0__py3-none-any.whl

workos/events.py

@@ -0,0 +1,111 @@
+from typing import Optional, Protocol, Sequence
+
+from workos.types.events.list_filters import EventsListFilters
+from workos.typing.sync_or_async import SyncOrAsync
+from workos.utils.request_helper import DEFAULT_LIST_RESPONSE_LIMIT, REQUEST_METHOD_GET
+from workos.types.events import Event, EventType
+from workos.utils.http_client import AsyncHTTPClient, SyncHTTPClient
+from workos.types.list_resource import ListAfterMetadata, ListPage, WorkOSListResource
+
+
+EventsListResource = WorkOSListResource[Event, EventsListFilters, ListAfterMetadata]
+
+
+class EventsModule(Protocol):
+    """Offers methods through the WorkOS Events service."""
+
+    def list_events(
+        self,
+        *,
+        events: Sequence[EventType],
+        limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
+        organization_id: Optional[str] = None,
+        after: Optional[str] = None,
+        range_start: Optional[str] = None,
+        range_end: Optional[str] = None,
+    ) -> SyncOrAsync[EventsListResource]:
+        """Gets a list of Events.
+
+        Kwargs:
+            events (Sequence[EventType]): Filter to only return events of particular types.
+            limit (int): Maximum number of records to return. (Optional)
+            organization_id (str): Organization ID limits scope of events to a single organization. (Optional)
+            after (str): Pagination cursor to receive records after a provided Event ID. (Optional)
+            range_start (str): Date range start for stream of events. (Optional)
+            range_end (str): Date range end for stream of events. (Optional)
+
+        Returns:
+            EventsListResource: Events response from WorkOS.
+        """
+        ...
+
+
+class Events(EventsModule):
+    _http_client: SyncHTTPClient
+
+    def __init__(self, http_client: SyncHTTPClient):
+        self._http_client = http_client
+
+    def list_events(
+        self,
+        *,
+        events: Sequence[EventType],
+        limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
+        organization_id: Optional[str] = None,
+        after: Optional[str] = None,
+        range_start: Optional[str] = None,
+        range_end: Optional[str] = None,
+    ) -> EventsListResource:
+        params: EventsListFilters = {
+            "events": events,
+            "limit": limit,
+            "after": after,
+            "organization_id": organization_id,
+            "range_start": range_start,
+            "range_end": range_end,
+        }
+
+        response = self._http_client.request(
+            "events", method=REQUEST_METHOD_GET, params=params
+        )
+        return WorkOSListResource[Event, EventsListFilters, ListAfterMetadata](
+            list_method=self.list_events,
+            list_args=params,
+            **ListPage[Event](**response).model_dump(exclude_unset=True),
+        )
+
+
+class AsyncEvents(EventsModule):
+    _http_client: AsyncHTTPClient
+
+    def __init__(self, http_client: AsyncHTTPClient):
+        self._http_client = http_client
+
+    async def list_events(
+        self,
+        *,
+        events: Sequence[EventType],
+        limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
+        organization_id: Optional[str] = None,
+        after: Optional[str] = None,
+        range_start: Optional[str] = None,
+        range_end: Optional[str] = None,
+    ) -> EventsListResource:
+        params: EventsListFilters = {
+            "events": events,
+            "limit": limit,
+            "after": after,
+            "organization_id": organization_id,
+            "range_start": range_start,
+            "range_end": range_end,
+        }
+
+        response = await self._http_client.request(
+            "events", method=REQUEST_METHOD_GET, params=params
+        )
+
+        return WorkOSListResource[Event, EventsListFilters, ListAfterMetadata](
+            list_method=self.list_events,
+            list_args=params,
+            **ListPage[Event](**response).model_dump(exclude_unset=True),
+        )

workos/exceptions.py

@@ -1,41 +1,42 @@
-class ConfigurationException(Exception):
-    pass
+from typing import Any, Mapping, Optional
+
+import httpx
 
 
 # Request related exceptions
 class BaseRequestException(Exception):
-    def __init__(self, response, message=None, error=None, error_description=None):
-        super(BaseRequestException, self).__init__(message)
+    def __init__(
+        self,
+        response: httpx.Response,
+        response_json: Optional[Mapping[str, Any]],
+    ) -> None:
+        super(BaseRequestException, self).__init__(response_json)
 
-        self.message = message
-        self.error = error
-        self.error_description = error_description
-        self.extract_and_set_response_related_data(response)
-
-    def extract_and_set_response_related_data(self, response):
         self.response = response
+        self.response_json = response_json
 
-        try:
-            response_json = response.json()
-            self.message = response_json.get("message")
-        except ValueError:
-            self.message = None
+        self.message = self.extract_from_json("message", "No message")
+        self.error = self.extract_from_json("error", "Unknown")
+        self.errors = self.extract_from_json("errors", None)
+        self.code = self.extract_from_json("code", None)
+        self.error_description = self.extract_from_json("error_description", "Unknown")
 
-        headers = response.headers
-        self.request_id = headers.get("X-Request-ID")
+        self.request_id = response.headers.get("X-Request-ID")
 
-    def __str__(self):
-        message = self.message or "No message"
-        exception = "(message=%s" % message
+    def extract_from_json(self, key: str, alt: Optional[str] = None) -> Optional[str]:
+        if self.response_json is None:
+            return alt
 
-        if self.request_id is not None:
-            exception += ", request_id=%s" % self.request_id
+        return self.response_json.get(key, alt)
 
-        if self.error is not None:
-            exception += ", error=%s" % self.error
+    def __str__(self) -> str:
+        exception = "(message=%s" % self.message
+        exception += ", request_id=%s" % self.request_id
 
-        if self.error_description is not None:
-            exception += ", error_description=%s" % self.error_description
+        if self.response_json is not None:
+            for key, value in self.response_json.items():
+                if key != "message":
+                    exception += ", %s=%s" % (key, value)
 
         return exception + ")"
 
@@ -44,6 +45,24 @@ class AuthorizationException(BaseRequestException):
     pass
 
 
+class EmailVerificationRequiredException(AuthorizationException):
+    """Raised when email verification is required before authentication.
+
+    This exception includes an email_verification_id field that can be used
+    to retrieve the email verification object or resend the verification email.
+    """
+
+    def __init__(
+        self,
+        response: httpx.Response,
+        response_json: Optional[Mapping[str, Any]],
+    ) -> None:
+        super().__init__(response, response_json)
+        self.email_verification_id = self.extract_from_json(
+            "email_verification_id", None
+        )
+
+
 class AuthenticationException(BaseRequestException):
     pass
 
@@ -52,5 +71,13 @@ class BadRequestException(BaseRequestException):
     pass
 
 
+class ConflictException(BaseRequestException):
+    pass
+
+
+class NotFoundException(BaseRequestException):
+    pass
+
+
 class ServerException(BaseRequestException):
     pass