added get_user_metadata (draft)

Author: Narek Mkhitaryan

docs/source/api_reference/api_team.rst

@@ -7,3 +7,4 @@ Team
 .. automethod:: superannotate.SAClient.get_integrations
 .. automethod:: superannotate.SAClient.invite_contributors_to_team
 .. automethod:: superannotate.SAClient.search_team_contributors
+.. automethod:: superannotate.SAClient.get_user_metadata

src/superannotate/lib/app/interface/sdk_interface.py

@@ -279,6 +279,29 @@ def get_team_metadata(self):
         response = self.controller.get_team()
         return TeamSerializer(response.data).serialize()
 
+    def get_user_metadata(
+        self, pk: Union[str, int], include: List[Literal["custom_fields"]] = None
+    ):
+        """
+        Returns team contributor metadata
+
+        :param pk: The email address or ID of the team contributor.
+        :type pk: str or int
+
+        :param include: Specifies additional fields to include in the response.
+
+                Possible values are
+
+                    - "custom_fields": whether to include custom fields that have been created for the team user.
+
+        :type include: list of str, optional
+
+        :return: metadata of team contributor
+        :rtype: dict
+        """
+        response = self.controller.get_user_metadata()
+        return TeamSerializer(response.data).serialize()
+
     def get_component_config(self, project: Union[NotEmptyStr, int], component_id: str):
         """
         Retrieves the configuration for a given project and component ID.
@@ -3088,6 +3111,7 @@ def list_projects(
                 - status__in: List[Literal[“NotStarted”, “InProgress”, “Completed”, “OnHold”]]
                 - status__notin: List[Literal[“NotStarted”, “InProgress”, “Completed”, “OnHold”]]
                 - custom_field: Optional[dict] – Specifies custom fields attributes to filter projects by.
+
                   Custom fields can be accessed using the `custom_field__` prefix followed by the attribute name.
 
         :type filters: ProjectFilters

src/superannotate/lib/core/entities/work_managament.py

@@ -87,3 +87,14 @@ def json(self, **kwargs):
         if "exclude" not in kwargs:
             kwargs["exclude"] = {"custom_fields"}
         return super().json(**kwargs)
+
+
+class UserEntity(TimedBaseModel):
+    id: Optional[str]
+    first_name: Optional[str]
+    last_name: Optional[str]
+    email: Optional[str]
+    user_role: Optional[int]
+
+    class Config:
+        extra = Extra.ignore

src/superannotate/lib/core/service_types.py

@@ -6,6 +6,7 @@
 
 from lib.core import entities
 from lib.core.entities.work_managament import WMProjectEntity
+from lib.core.entities.work_managament import WMUserEntity
 from lib.core.enums import ProjectType
 from lib.core.exceptions import AppException
 from lib.core.pydantic_v1 import BaseModel
@@ -247,6 +248,10 @@ class WMProjectListResponse(ServiceResponse):
     res_data: List[WMProjectEntity] = None
 
 
+class WMUserListResponse(ServiceResponse):
+    res_data: List[WMUserEntity] = None
+
+
 class SettingsListResponse(ServiceResponse):
     res_data: List[entities.SettingEntity] = None
 

src/superannotate/lib/infrastructure/controller.py

@@ -1362,6 +1362,11 @@ def search_team_contributors(self, **kwargs):
         )
         return use_case.execute()
 
+    def get_user_metadata(
+        self, pk: Union[str, int], include: List[Literal["custom_fields"]] = None
+    ):
+        self.service_provider.work_management.list_projects()
+
     def _get_image(
         self,
         project: ProjectEntity,

src/superannotate/lib/infrastructure/services/work_management.py

@@ -12,6 +12,7 @@
 from lib.core.service_types import ListCategoryResponse
 from lib.core.service_types import ServiceResponse
 from lib.core.service_types import WMProjectListResponse
+from lib.core.service_types import WMUserListResponse
 from lib.core.serviceproviders import BaseWorkManagementService
 
 
@@ -27,7 +28,7 @@ class WorkManagementService(BaseWorkManagementService):
     URL_CUSTOM_FIELD_TEMPLATES = "customfieldtemplates"
     URL_CUSTOM_FIELD_TEMPLATE_DELETE = "customfieldtemplates/{template_id}"
     URL_PROJECT_CUSTOM_ENTITIES = "customentities/{project_id}"
-    LIST_PROJECTS = "customentities/search"
+    SEARCH_CUSTOM_ENTITIES = "customentities/search"
 
     @staticmethod
     def _generate_context(**kwargs):
@@ -214,7 +215,7 @@ def set_project_custom_field_value(self, project_id: int, data: dict):
 
     def list_projects(self, body_query: Query, chunk_size=100) -> WMProjectListResponse:
         return self.client.jsx_paginate(
-            url=self.LIST_PROJECTS,
+            url=self.SEARCH_CUSTOM_ENTITIES,
             method="post",
             body_query=body_query,
             query_params={
@@ -229,3 +230,21 @@ def list_projects(self, body_query: Query, chunk_size=100) -> WMProjectListRespo
             chunk_size=chunk_size,
             item_type=WMProjectEntity,
         )
+
+    def list_users(self, body_query: Query, chunk_size=100) -> WMUserListResponse:
+        return self.client.jsx_paginate(
+            url=self.SEARCH_CUSTOM_ENTITIES,
+            method="post",
+            body_query=body_query,
+            query_params={
+                "entity": "Contributor",
+                "parentEntity": "Team",
+            },
+            headers={
+                "x-sa-entity-context": self._generate_context(
+                    team_id=self.client.team_id
+                ),
+            },
+            chunk_size=chunk_size,
+            item_type=WMProjectEntity,
+        )