Merge pull request #470 from TheHive-Project/445-review-profile-endpoints

#445 - Review profile endpoints

Author: Kamforka

thehive4py/endpoints/profile.py

@@ -10,15 +10,48 @@
 
 class ProfileEndpoint(EndpointBase):
     def create(self, profile: InputProfile) -> OutputProfile:
+        """Create a profile.
+
+        Args:
+            profile: The body of the profile.
+
+        Returns:
+            The created profile.
+        """
         return self._session.make_request("POST", path="/api/v1/profile", json=profile)
 
     def get(self, profile_id: str) -> OutputProfile:
+        """Get a profile by id.
+
+        Args:
+            profile_id: The id of the profile.
+
+        Returns:
+            The profile specified by the id.
+        """
         return self._session.make_request("GET", path=f"/api/v1/profile/{profile_id}")
 
     def delete(self, profile_id: str) -> None:
+        """Delete a profile.
+
+        Args:
+            profile_id: The id of the profile.
+
+        Returns:
+            N/A
+        """
         return self._session.make_request("DELETE", f"/api/v1/profile/{profile_id}")
 
     def update(self, profile_id: str, fields: InputUpdateProfile) -> None:
+        """Update a profile.
+
+        Args:
+            profile_id: The id of the profile.
+            fields: The fields of the profile to update.
+
+        Returns:
+            N/A
+        """
         return self._session.make_request(
             "PATCH", f"/api/v1/profile/{profile_id}", json=fields
         )
@@ -29,6 +62,16 @@ def find(
         sortby: Optional[SortExpr] = None,
         paginate: Optional[Paginate] = None,
     ) -> List[OutputProfile]:
+        """Find multiple profiles.
+
+        Args:
+            filters: The filter expressions to apply in the query.
+            sortby: The sort expressions to apply in the query.
+            paginate: The pagination expression to apply in the query.
+
+        Returns:
+            The list of profiles matched by the query or an empty list.
+        """
         query: QueryExpr = [
             {"_name": "listProfile"},
             *self._build_subquery(filters=filters, sortby=sortby, paginate=paginate),
@@ -42,6 +85,14 @@ def find(
         )
 
     def count(self, filters: Optional[FilterExpr] = None) -> int:
+        """Count profiles.
+
+        Args:
+            filters: The filter expressions to apply in the query.
+
+        Returns:
+            The count of profiles matched by the query.
+        """
         query: QueryExpr = [
             {"_name": "listProfile"},
             *self._build_subquery(filters=filters),

thehive4py/types/profile.py

@@ -1,28 +1,26 @@
 from typing import List, TypedDict
 
-
-class InputProfileRequired(TypedDict):
-    name: str
+from typing_extensions import NotRequired
 
 
-class InputProfile(InputProfileRequired, total=False):
-    permissions: List[str]
+class InputProfile(TypedDict):
+    name: str
+    permissions: NotRequired[List[str]]
 
 
-class OutputProfileRequired(TypedDict):
+class OutputProfile(TypedDict):
     _id: str
     _type: str
     _createdBy: str
+    _updatedBy: NotRequired[str]
     _createdAt: int
+    _updatedAt: NotRequired[int]
     name: str
+    permissions: NotRequired[List[str]]
     editable: bool
-    isAdmin: bool
-
-
-class OutputProfile(OutputProfileRequired, total=False):
-    _updatedBy: str
-    _updatedAt: int
-    permissions: List[str]
+    forAdmin: bool
+    forOrg: bool
+    consumesLicense: bool
 
 
 class InputUpdateProfile(TypedDict, total=False):