Add metadata to users and organizations

Eventually the API will always return something, but for now we can
default to an empty object (which is what the API will eventually
return).

Author: ericroberts

tests/test_user_management.py

@@ -411,6 +411,7 @@ def test_get_user_by_external_id(
         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.metadata == mock_user["metadata"]
 
     def test_list_users_auto_pagination(
         self,

tests/utils/fixtures/mock_organization.py

@@ -22,4 +22,5 @@ def __init__(self, id):
                     domain="example.io",
                 )
             ],
+            metadata={"key": "value"},
         )

tests/utils/fixtures/mock_user.py

@@ -17,4 +17,5 @@ def __init__(self, id):
             last_sign_in_at="2021-06-25T19:07:33.155Z",
             created_at=now,
             updated_at=now,
+            metadata={"key": "value"},
         )

workos/types/organizations/organization.py

@@ -1,4 +1,5 @@
-from typing import Optional, Sequence
+from dataclasses import field
+from typing import Optional, Sequence, Dict
 from workos.types.organizations.organization_common import OrganizationCommon
 from workos.types.organizations.organization_domain import OrganizationDomain
 
@@ -8,3 +9,4 @@ class Organization(OrganizationCommon):
     domains: Sequence[OrganizationDomain]
     stripe_customer_id: Optional[str] = None
     external_id: Optional[str] = None
+    metadata: Dict[str, str] = field(default_factory=dict)

workos/types/user_management/user.py

@@ -1,4 +1,5 @@
-from typing import Literal, Optional
+from dataclasses import field
+from typing import Literal, Optional, Dict
 from workos.types.workos_model import WorkOSModel
 
 
@@ -16,3 +17,4 @@ class User(WorkOSModel):
     created_at: str
     updated_at: str
     external_id: Optional[str] = None
+    metadata: Dict[str, str] = field(default_factory=dict)

workos/user_management.py

@@ -139,10 +139,10 @@ def get_user(self, user_id: str) -> SyncOrAsync[User]:
         ...
 
     def get_user_by_external_id(self, external_id: str) -> SyncOrAsync[User]:
-        """Get the details of an existing user.
+        """Get the details of an existing user by external id.
 
         Args:
-            external_id (str): The user's external id
+            external_id (str): User's external id
         Returns:
             User: User response from WorkOS.
         """