Add directory metadata (#352)

Author: salbito-workos

tests/test_directory_sync.py

@@ -1,13 +1,18 @@
 from typing import Union
+
 import pytest
+from workos.directory_sync import AsyncDirectorySync, DirectorySync
 
 from tests.types.test_auto_pagination_function import TestAutoPaginationFunction
-from tests.utils.list_resource import list_data_to_dicts, list_response_of
-from tests.utils.fixtures.mock_directory import MockDirectory
-from tests.utils.fixtures.mock_directory_user import MockDirectoryUser
+from tests.utils.fixtures.mock_directory import (
+    MockDirectory,
+    MockDirectoryMetadata,
+    MockDirectoryUsersMetadata,
+)
 from tests.utils.fixtures.mock_directory_group import MockDirectoryGroup
+from tests.utils.fixtures.mock_directory_user import MockDirectoryUser
+from tests.utils.list_resource import list_data_to_dicts, list_response_of
 from tests.utils.syncify import syncify
-from workos.directory_sync import AsyncDirectorySync, DirectorySync
 
 
 def api_directory_to_sdk(directory):
@@ -96,6 +101,16 @@ def mock_directories(self):
         directory_list = [MockDirectory(id=str(i)).dict() for i in range(10)]
         return list_response_of(data=directory_list)
 
+    @pytest.fixture
+    def mock_directories_with_metadata(self):
+        metadata = MockDirectoryMetadata(
+            users=MockDirectoryUsersMetadata(active=1, inactive=0), groups=1
+        )
+        directory_list = [
+            MockDirectory(id=str(i), metadata=metadata).dict() for i in range(10)
+        ]
+        return list_response_of(data=directory_list)
+
     @pytest.fixture
     def mock_directory_users_multiple_data_pages(self):
         return [
@@ -241,6 +256,27 @@ def test_list_directories(
             "order": "desc",
         }
 
+    def test_list_directories_with_metadata(
+        self, mock_directories_with_metadata, capture_and_mock_http_client_request
+    ):
+        request_kwargs = capture_and_mock_http_client_request(
+            http_client=self.http_client,
+            status_code=200,
+            response_dict=mock_directories_with_metadata,
+        )
+
+        directories = syncify(self.directory_sync.list_directories())
+
+        assert list_data_to_dicts(directories.data) == api_directories_to_sdk(
+            mock_directories_with_metadata["data"]
+        )
+        assert request_kwargs["url"].endswith("/directories")
+        assert request_kwargs["method"] == "get"
+        assert request_kwargs["params"] == {
+            "limit": 10,
+            "order": "desc",
+        }
+
     def test_get_directory(self, mock_directory, capture_and_mock_http_client_request):
         request_kwargs = capture_and_mock_http_client_request(
             http_client=self.http_client,

tests/utils/fixtures/mock_directory.py

@@ -1,10 +1,24 @@
 import datetime
 
-from workos.types.directory_sync import Directory
+from workos.types.directory_sync import (
+    Directory,
+    DirectoryMetadata,
+    DirectoryUsersMetadata,
+)
+
+
+class MockDirectoryUsersMetadata(DirectoryUsersMetadata):
+    def __init__(self, active=0, inactive=0):
+        super().__init__(active=active, inactive=inactive)
+
+
+class MockDirectoryMetadata(DirectoryMetadata):
+    def __init__(self, users, groups=0):
+        super().__init__(users=users, groups=groups)
 
 
 class MockDirectory(Directory):
-    def __init__(self, id):
+    def __init__(self, id, metadata=None):
         now = datetime.datetime.now().isoformat()
         super().__init__(
             object="directory",
@@ -15,6 +29,7 @@ def __init__(self, id):
             name="Some fake name",
             state="active",
             type="gsuite directory",
+            metadata=metadata,
             created_at=now,
             updated_at=now,
         )

workos/types/directory_sync/directory.py

@@ -5,6 +5,16 @@
 from workos.typing.literals import LiteralOrUntyped
 
 
+class DirectoryUsersMetadata(WorkOSModel):
+    active: int
+    inactive: int
+
+
+class DirectoryMetadata(WorkOSModel):
+    users: DirectoryUsersMetadata
+    groups: int
+
+
 class Directory(WorkOSModel):
     """Representation of a Directory Response as returned by WorkOS through the Directory Sync feature."""
 
@@ -16,5 +26,6 @@ class Directory(WorkOSModel):
     external_key: str
     state: LiteralOrUntyped[DirectoryState]
     type: LiteralOrUntyped[DirectoryType]
+    metadata: Optional[DirectoryMetadata] = None
     created_at: str
     updated_at: str