workos 5.31.1__tar.gz → 5.32.0__tar.gz

{workos-5.31.1 → workos-5.32.0}/PKG-INFO

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

{workos-5.31.1 → workos-5.32.0}/tests/test_sync_http_client.py

@@ -10,6 +10,7 @@ from workos.exceptions import (
     BadRequestException,
     BaseRequestException,
     ConflictException,
+    EmailVerificationRequiredException,
     ServerException,
 )
 from workos.utils.http_client import SyncHTTPClient
@@ -263,6 +264,57 @@ class TestSyncHTTPClient(object):
             assert str(ex) == "(message=No message, request_id=request-123)"
             assert ex.__class__ == ConflictException
 
+    def test_email_verification_required_exception(self):
+        request_id = "request-123"
+        email_verification_id = "email_verification_01J6K4PMSWQXVFGF5ZQJXC6VC8"
+
+        self.http_client._client.request = MagicMock(
+            return_value=httpx.Response(
+                status_code=403,
+                json={
+                    "message": "Please verify your email to authenticate via password.",
+                    "code": "email_verification_required",
+                    "email_verification_id": email_verification_id,
+                },
+                headers={"X-Request-ID": request_id},
+            ),
+        )
+
+        try:
+            self.http_client.request("bad_place")
+        except EmailVerificationRequiredException as ex:
+            assert (
+                ex.message == "Please verify your email to authenticate via password."
+            )
+            assert ex.code == "email_verification_required"
+            assert ex.email_verification_id == email_verification_id
+            assert ex.request_id == request_id
+            assert ex.__class__ == EmailVerificationRequiredException
+            assert isinstance(ex, AuthorizationException)
+
+    def test_regular_authorization_exception_still_raised(self):
+        request_id = "request-123"
+
+        self.http_client._client.request = MagicMock(
+            return_value=httpx.Response(
+                status_code=403,
+                json={
+                    "message": "You do not have permission to access this resource.",
+                    "code": "forbidden",
+                },
+                headers={"X-Request-ID": request_id},
+            ),
+        )
+
+        try:
+            self.http_client.request("bad_place")
+        except AuthorizationException as ex:
+            assert ex.message == "You do not have permission to access this resource."
+            assert ex.code == "forbidden"
+            assert ex.request_id == request_id
+            assert ex.__class__ == AuthorizationException
+            assert not isinstance(ex, EmailVerificationRequiredException)
+
     def test_request_includes_base_headers(self, capture_and_mock_http_client_request):
         request_kwargs = capture_and_mock_http_client_request(self.http_client, {}, 200)
 

{workos-5.31.1 → workos-5.32.0}/tests/test_user_management.py

@@ -414,6 +414,7 @@ class TestUserManagement(UserManagementFixtures):
         assert user.id == "user_01H7ZGXFP5C6BBQY6Z7277ZCT0"
         assert user.profile_picture_url == "https://example.com/profile-picture.jpg"
         assert user.last_sign_in_at == "2021-06-25T19:07:33.155Z"
+        assert user.locale == "en-US"
 
     def test_get_user_by_external_id(
         self, mock_user, capture_and_mock_http_client_request
@@ -434,6 +435,7 @@ class TestUserManagement(UserManagementFixtures):
         assert user.id == "user_01H7ZGXFP5C6BBQY6Z7277ZCT0"
         assert user.profile_picture_url == "https://example.com/profile-picture.jpg"
         assert user.last_sign_in_at == "2021-06-25T19:07:33.155Z"
+        assert user.locale == "en-US"
         assert user.metadata == mock_user["metadata"]
 
     def test_list_users_auto_pagination(
@@ -492,6 +494,29 @@ class TestUserManagement(UserManagementFixtures):
             "password": "password",
         }
 
+    def test_update_user_with_locale(
+        self, mock_user, capture_and_mock_http_client_request
+    ):
+        request_kwargs = capture_and_mock_http_client_request(
+            self.http_client, mock_user, 200
+        )
+
+        params = {
+            "first_name": "Marcelina",
+            "locale": "fr-FR",
+        }
+        user = syncify(
+            self.user_management.update_user(
+                user_id="user_01H7ZGXFP5C6BBQY6Z7277ZCT0", **params
+            )
+        )
+
+        assert request_kwargs["url"].endswith("users/user_01H7ZGXFP5C6BBQY6Z7277ZCT0")
+        assert user.id == "user_01H7ZGXFP5C6BBQY6Z7277ZCT0"
+        assert request_kwargs["method"] == "put"
+        assert request_kwargs["json"]["first_name"] == "Marcelina"
+        assert request_kwargs["json"]["locale"] == "fr-FR"
+
     def test_delete_user(self, capture_and_mock_http_client_request):
         request_kwargs = capture_and_mock_http_client_request(
             http_client=self.http_client, status_code=204

{workos-5.31.1 → workos-5.32.0}/workos/__about__.py

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

{workos-5.31.1 → workos-5.32.0}/workos/exceptions.py

@@ -45,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
 

{workos-5.31.1 → workos-5.32.0}/workos/types/user_management/user.py

@@ -15,6 +15,7 @@ class User(WorkOSModel):
     email_verified: bool
     profile_picture_url: Optional[str] = None
     last_sign_in_at: Optional[str] = None
+    locale: Optional[str] = None
     created_at: str
     updated_at: str
     external_id: Optional[str] = None

{workos-5.31.1 → workos-5.32.0}/workos/user_management.py

@@ -225,6 +225,7 @@ class UserManagementModule(Protocol):
         password_hash_type: Optional[PasswordHashType] = None,
         external_id: Optional[str] = None,
         metadata: Optional[Metadata] = None,
+        locale: Optional[str] = None,
     ) -> SyncOrAsync[User]:
         """Update user attributes.
 
@@ -237,6 +238,7 @@ class UserManagementModule(Protocol):
             password (str): The password to set for the user. (Optional)
             password_hash (str): The hashed password to set for the user, used when migrating from another user store. Mutually exclusive with password. (Optional)
             password_hash_type (str): The algorithm originally used to hash the password, used when providing a password_hash. Valid values are 'bcrypt', `firebase-scrypt`, and `ssha`. (Optional)
+            locale (str): The user's locale. (Optional)
 
         Returns:
             User: Updated User response from WorkOS.
@@ -1002,6 +1004,7 @@ class UserManagement(UserManagementModule):
         password_hash_type: Optional[PasswordHashType] = None,
         external_id: Optional[str] = None,
         metadata: Optional[Metadata] = None,
+        locale: Optional[str] = None,
     ) -> User:
         json = {
             "first_name": first_name,
@@ -1013,6 +1016,7 @@ class UserManagement(UserManagementModule):
             "password_hash_type": password_hash_type,
             "external_id": external_id,
             "metadata": metadata,
+            "locale": locale,
         }
 
         response = self._http_client.request(
@@ -1688,6 +1692,7 @@ class AsyncUserManagement(UserManagementModule):
         password_hash_type: Optional[PasswordHashType] = None,
         external_id: Optional[str] = None,
         metadata: Optional[Metadata] = None,
+        locale: Optional[str] = None,
     ) -> User:
         json = {
             "first_name": first_name,
@@ -1699,6 +1704,7 @@ class AsyncUserManagement(UserManagementModule):
             "password_hash_type": password_hash_type,
             "external_id": external_id,
             "metadata": metadata,
+            "locale": locale,
         }
 
         response = await self._http_client.request(

{workos-5.31.1 → workos-5.32.0}/workos/utils/_base_http_client.py

@@ -20,6 +20,7 @@ from workos.exceptions import (
     ServerException,
     AuthenticationException,
     AuthorizationException,
+    EmailVerificationRequiredException,
     NotFoundException,
     BadRequestException,
 )
@@ -99,6 +100,11 @@ class BaseHTTPClient(Generic[_HttpxClientT]):
             if status_code == 401:
                 raise AuthenticationException(response, response_json)
             elif status_code == 403:
+                if (
+                    response_json is not None
+                    and response_json.get("code") == "email_verification_required"
+                ):
+                    raise EmailVerificationRequiredException(response, response_json)
                 raise AuthorizationException(response, response_json)
             elif status_code == 404:
                 raise NotFoundException(response, response_json)

{workos-5.31.1 → workos-5.32.0}/workos.egg-info/PKG-INFO

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