fix: Introduce BulkResponse

encord/client.py

@@ -50,7 +50,7 @@
     upload_to_signed_url_list,
 )
 from encord.http.v2.api_client import ApiClient
-from encord.http.v2.payloads import Page
+from encord.http.v2.payloads import BulkResponse
 from encord.orm.analytics import (
     CollaboratorTimer,
     CollaboratorTimerParams,
@@ -305,9 +305,9 @@ def add_users(self, user_emails: List[str], user_role: DatasetUserRole) -> List[
 
         return [DatasetUser.from_dict(user) for user in users]
 
-    def list_groups(self, dataset_hash: uuid.UUID) -> Page[DatasetGroup]:
+    def list_groups(self, dataset_hash: uuid.UUID) -> BulkResponse[DatasetGroup]:
         return self._get_api_client().get(
-            f"datasets/{dataset_hash}/groups", params=None, result_type=Page[DatasetGroup]
+            f"datasets/{dataset_hash}/groups", params=None, result_type=BulkResponse[DatasetGroup]
         )
 
     def add_groups(self, dataset_hash: str, group_hash: List[uuid.UUID], user_role: DatasetUserRole) -> None:
@@ -954,9 +954,9 @@ def add_users(self, user_emails: List[str], user_role: ProjectUserRole) -> List[
 
         return [ProjectUser.from_dict(user) for user in users]
 
-    def list_groups(self, project_hash: uuid.UUID) -> Page[ProjectGroup]:
+    def list_groups(self, project_hash: uuid.UUID) -> BulkResponse[ProjectGroup]:
         return self._get_api_client().get(
-            f"projects/{project_hash}/groups", params=None, result_type=Page[ProjectGroup]
+            f"projects/{project_hash}/groups", params=None, result_type=BulkResponse[ProjectGroup]
         )
 
     def add_groups(self, project_hash: uuid.UUID, group_hash: List[uuid.UUID], user_role: ProjectUserRole) -> None:
@@ -1134,7 +1134,7 @@ def remove_datasets(self, dataset_hashes: List[str]) -> bool:
     def list_project_datasets(self, project_hash: UUID) -> Iterable[ProjectDataset]:
         return (
             self._get_api_client()
-            .get(f"projects/{project_hash}/datasets", params=None, result_type=Page[ProjectDataset])
+            .get(f"projects/{project_hash}/datasets", params=None, result_type=BulkResponse[ProjectDataset])
             .results
         )
 

encord/http/v2/payloads.py

@@ -8,3 +8,7 @@
 class Page(GenericBaseDTO, Generic[T]):
     results: List[T]
     next_page_token: Optional[str]
+
+
+class BulkResponse(GenericBaseDTO, Generic[T]):
+    results: List[T]

encord/ontology.py

@@ -16,7 +16,7 @@
 from uuid import UUID
 
 from encord.http.v2.api_client import ApiClient
-from encord.http.v2.payloads import Page
+from encord.http.v2.payloads import BulkResponse
 from encord.objects.ontology_structure import OntologyStructure
 from encord.orm.group import AddOntologyGroupsPayload, OntologyGroup, RemoveGroupsParams
 from encord.orm.ontology import CreateOrUpdateOntologyPayload
@@ -132,7 +132,9 @@ def list_groups(self) -> Iterable[OntologyGroup]:
         List all groups that have access to a particular ontology.
         """
         ontology_hash = convert_to_uuid(self.ontology_hash)
-        page = self.api_client.get(f"ontologies/{ontology_hash}/groups", params=None, result_type=Page[OntologyGroup])
+        page = self.api_client.get(
+            f"ontologies/{ontology_hash}/groups", params=None, result_type=BulkResponse[OntologyGroup]
+        )
 
         yield from page.results
 

encord/storage.py

@@ -31,7 +31,7 @@
 from encord.http.constants import DEFAULT_REQUESTS_SETTINGS
 from encord.http.utils import CloudUploadSettings, _upload_single_file
 from encord.http.v2.api_client import ApiClient
-from encord.http.v2.payloads import Page
+from encord.http.v2.payloads import BulkResponse
 from encord.orm.dataset import LongPollingStatus
 from encord.orm.group import AddStorageFolderGroupsPayload, RemoveGroupsParams, StorageFolderGroup
 from encord.orm.storage import (
@@ -1020,7 +1020,7 @@ def list_groups(self) -> Iterable[StorageFolderGroup]:
         List all groups that have access to this folder.
         """
         page = self._api_client.get(
-            f"/storage/folders/{self.uuid}/groups", params=None, result_type=Page[StorageFolderGroup]
+            f"/storage/folders/{self.uuid}/groups", params=None, result_type=BulkResponse[StorageFolderGroup]
         )
 
         yield from page.results
@@ -1086,7 +1086,7 @@ def _get_upload_signed_urls(
                 count=count,
                 frames_subfolder_name=frames_subfolder_name,
             ),
-            result_type=Page[orm_storage.UploadSignedUrl],
+            result_type=BulkResponse[orm_storage.UploadSignedUrl],
         )
 
         return urls.results
@@ -1334,7 +1334,7 @@ def _patch_multiple_folders(
             "storage/folders/patch-bulk",
             params=None,
             payload=orm_storage.PatchFoldersBulkPayload(folder_patches=folder_patches),
-            result_type=Page[orm_storage.StorageFolder],
+            result_type=BulkResponse[orm_storage.StorageFolder],
         ).results
 
     @staticmethod
@@ -1589,7 +1589,7 @@ def get_child_items(self, get_signed_urls: bool = False) -> Iterable["StorageIte
         child_items = self._api_client.get(
             f"/storage/folders/{self.parent_folder_uuid}/items/{self.uuid}/child-items",
             params=orm_storage.GetChildItemsParams(sign_urls=get_signed_urls),
-            result_type=Page[orm_storage.StorageItem],
+            result_type=BulkResponse[orm_storage.StorageItem],
         ).results
 
         return [StorageItem(self._api_client, item) for item in child_items]
@@ -1737,7 +1737,7 @@ def _get_items(api_client: ApiClient, item_uuids: List[UUID], get_signed_url: bo
             "storage/items/get-bulk",
             params=None,
             payload=GetItemsBulkPayload(item_uuids=item_uuids, sign_urls=get_signed_url),
-            result_type=Page[orm_storage.StorageItem],
+            result_type=BulkResponse[orm_storage.StorageItem],
         )
         return [StorageItem(api_client, orm_item) for orm_item in orm_items.results]
 
@@ -1750,7 +1750,7 @@ def _patch_multiple_items(
             "storage/items/patch-bulk",
             params=None,
             payload=orm_storage.PatchItemsBulkPayload(item_patches=item_patches),
-            result_type=Page[orm_storage.StorageItem],
+            result_type=BulkResponse[orm_storage.StorageItem],
         ).results
 
     def _set_orm_item(self, orm_item: orm_storage.StorageItem) -> None:

encord/user_client.py

@@ -44,7 +44,7 @@
     upload_to_signed_url_list,
 )
 from encord.http.v2.api_client import ApiClient
-from encord.http.v2.payloads import Page
+from encord.http.v2.payloads import BulkResponse
 from encord.metadata_schema import MetadataSchema
 from encord.objects import OntologyStructure
 from encord.objects.common import (
@@ -811,7 +811,9 @@ def get_ontologies(
         """
         properties_filter = OntologiesFilterParams.from_dict(self.__validate_filter(locals()))
         properties_filter.include_org_access = include_org_access
-        page = self._api_client.get("ontologies", params=properties_filter, result_type=Page[OntologyWithUserRole])
+        page = self._api_client.get(
+            "ontologies", params=properties_filter, result_type=BulkResponse[OntologyWithUserRole]
+        )
 
         # a hack to be able to share validation code without too much c&p
         retval: List[Dict] = []
@@ -882,7 +884,7 @@ def list_groups(self) -> Iterable[OrmGroup]:
         """
         List all groups belonging to the user's current organization.
         """
-        page = self._api_client.get("user/current-organisation/groups", params=None, result_type=Page[OrmGroup])
+        page = self._api_client.get("user/current-organisation/groups", params=None, result_type=BulkResponse[OrmGroup])
         yield from page.results
 
     def deidentify_dicom_files_start(