Correct minor issues around typing and args convention

Author: peritz

pycti/entities/opencti_group.py

@@ -1,4 +1,4 @@
-from typing import List, Dict
+from typing import List, Dict, Optional
 
 
 class Group:
@@ -187,17 +187,19 @@ def list(self, **kwargs) -> List[Dict]:
             return self.opencti.process_multiple(result["data"]["groups"],
                                                  withPagination)
 
-    def read(self, **kwargs) -> Dict:
+    def read(self, **kwargs) -> Optional[Dict]:
         """Fetch a given group from OpenCTI
 
+        One of id or filters is required.
+
         :param id: ID of the group to fetch
         :type id: str, optional
         :param filters: Filters to apply to find single group
         :type filters: dict, optional
         :param customAttributes: Custom attributes to fetch for the group
         :type customAttributes: str
         :return: Representation of a group.
-        :rtype: dict
+        :rtype: Optional[Dict]
         """
         id = kwargs.get("id", None)
         filters = kwargs.get("filters", None)
@@ -222,14 +224,15 @@ def read(self, **kwargs) -> Dict:
             return self.opencti.process_multiple_fields(
                 result["data"]["group"])
         elif filters is not None or search is not None:
-            results = self.list(filters=filters, search=search)
+            results = self.list(filters=filters, search=search,
+                                customAttributes=customAttributes)
             return results[0] if results else None
         else:
             self.opencti.admin_logger.error(
                 "[opencti_group] Missing parameters: id or filters")
             return None
 
-    def create(self, **kwargs) -> dict:
+    def create(self, **kwargs) -> Optional[Dict]:
         """Create a group with required details
 
         Groups can be configured after creation using other functions.
@@ -257,7 +260,7 @@ def create(self, **kwargs) -> dict:
         :param customAttributes: Attributes to retrieve from the new group
         :type customAttributes: str, optional
         :return: Representation of the group.
-        :rtype: dict
+        :rtype: Optional[Dict]
         """
         name = kwargs.get("name", None)
         group_confidence_level = kwargs.get("group_confidence_level", None)
@@ -325,7 +328,7 @@ def delete(self, id: str):
         """
         self.opencti.query(query, {"id": id})
 
-    def update_field(self, **kwargs) -> Dict:
+    def update_field(self, **kwargs) -> Optional[Dict]:
         """Update a group using fieldPatch
 
         :param id: ID of the group to update
@@ -335,7 +338,7 @@ def update_field(self, **kwargs) -> Dict:
         :param customAttributes: Custom attributes to retrieve from group
         :type customAttribues: str, optional
         :return: Representation of a group
-        :rtype: dict
+        :rtype: Optional[Dict]
         """
         id = kwargs.get("id", None)
         input = kwargs.get("input", None)
@@ -366,15 +369,15 @@ def update_field(self, **kwargs) -> Dict:
         return self.opencti.process_multiple_fields(
             result["data"]["groupEdit"]["fieldPatch"])
 
-    def add_member(self, **kwargs) -> dict:
+    def add_member(self, **kwargs) -> Optional[Dict]:
         """Add a member to a given group.
 
         :param id: ID of the group to add a member to
         :type id: str
         :param user_id: ID to add to the group
         :type user_id: str
         :return: Representation of the relationship
-        :rtype: dict
+        :rtype: Optional[Dict]
         """
         id = kwargs.get("id", None)
         user_id = kwargs.get("user_id", None)
@@ -412,15 +415,15 @@ def add_member(self, **kwargs) -> dict:
         return self.opencti.process_multiple_fields(
             result["data"]["groupEdit"]["relationAdd"])
 
-    def delete_member(self, **kwargs) -> dict:
+    def delete_member(self, **kwargs) -> Optional[Dict]:
         """Remove a given user from a group
 
         :param id: ID to remove a user from
         :type id: str
         :param user: ID to remove from the group
         :type user: str
         :return: Representation of the group after the member has been removed
-        :rtype: dict
+        :rtype: Optional[Dict]
         """
         id = kwargs.get("id", None)
         user_id = kwargs.get("user_id", None)
@@ -450,15 +453,15 @@ def delete_member(self, **kwargs) -> dict:
         return self.opencti.process_multiple_fields(
             result["data"]["groupEdit"]["relationDelete"])
 
-    def add_role(self, **kwargs) -> Dict:
+    def add_role(self, **kwargs) -> Optional[Dict]:
         """Add a role to a given group
 
         :param id: ID to add a role to
         :type id: str
         :param role_id: Role ID to add to the group
         :type role: str
         :return: Representation of the group after a role has been added
-        :rtype: dict
+        :rtype: Optional[Dict]
         """
         id = kwargs.get("id", None)
         role_id = kwargs.get("role_id", None)
@@ -494,15 +497,15 @@ def add_role(self, **kwargs) -> Dict:
         return self.opencti.process_multiple_fields(
             result["data"]["groupEdit"]["relationAdd"])
 
-    def delete_role(self, **kwargs) -> Dict:
+    def delete_role(self, **kwargs) -> Optional[Dict]:
         """Removes a role from a given group
 
         :param id: ID to remove role from
         :type id: str
         :param role_id: Role ID to remove from the group
         :type role_id: str
         :return: Representation of the group after role is removed
-        :rtype: dict
+        :rtype: Optional[Dict]
         """
         id = kwargs.get("id", None)
         role_id = kwargs.get("role_id", None)
@@ -531,7 +534,7 @@ def delete_role(self, **kwargs) -> Dict:
         return self.opencti.process_multiple_fields(
             result["data"]["groupEdit"]["relationDelete"])
 
-    def edit_default_marking(self, **kwargs) -> Dict:
+    def edit_default_marking(self, **kwargs) -> Optional[Dict]:
         """Adds a default marking to the group.
 
         :param id: ID of the group.
@@ -544,7 +547,7 @@ def edit_default_marking(self, **kwargs) -> Dict:
             defaults to "GLOBAL".
         :type entity: str, optional
         :return: Group after adding the default marking.
-        :rtype: dict
+        :rtype: Optional[Dict]
         """
         id = kwargs.get("id", None)
         marking_ids = kwargs.get("marking_ids", None)
@@ -586,15 +589,15 @@ def edit_default_marking(self, **kwargs) -> Dict:
         return self.opencti.process_multiple_fields(
             result["data"]["groupEdit"]["editDefaultMarking"])
 
-    def add_allowed_marking(self, **kwargs) -> Dict:
+    def add_allowed_marking(self, **kwargs) -> Optional[Dict]:
         """Allow a group to access a marking
 
         :param id: ID of group to authorise
         :type id: str
         :param marking_id: ID of marking to authorise
         :type marking_id: str
         :return: Relationship from the group to the marking definition
-        :rtype: dict
+        :rtype: Optional[Dict]
         """
         id = kwargs.get("id", None)
         marking_id = kwargs.get("marking_id", None)
@@ -653,15 +656,15 @@ def add_allowed_marking(self, **kwargs) -> Dict:
         return self.opencti.process_multiple_fields(
             result["data"]["groupEdit"]["relationAdd"])
 
-    def delete_allowed_marking(self, **kwargs) -> Dict:
+    def delete_allowed_marking(self, **kwargs) -> Optional[Dict]:
         """Removes access to a marking for a group
 
         :param id: ID of group to forbid
         :type id: str
         :param marking_id: ID of marking to deny
         :type marking_id: str
         :return: Group after denying access to marking definition
-        :rtype: dict
+        :rtype: Optional[Dict]
         """
         id = kwargs.get("id", None)
         marking_id = kwargs.get("marking_id", None)

pycti/entities/opencti_role.py

@@ -1,4 +1,4 @@
-from typing import Dict, List
+from typing import Dict, List, Optional
 
 
 class Role:
@@ -138,7 +138,7 @@ def list(self, **kwargs) -> List[Dict]:
             return self.opencti.process_multiple(result["data"]["roles"],
                                                  withPagination)
 
-    def read(self, **kwargs) -> Dict:
+    def read(self, **kwargs) -> Optional[Dict]:
         """Get a role given its ID or a search term
 
         One of id or search must be provided.
@@ -151,7 +151,7 @@ def read(self, **kwargs) -> Dict:
         :type customAttributes: str, optional
 
         :return: Representation of the role
-        :rtype: Dict
+        :rtype: Optional[Dict]
         """
         id = kwargs.get("id", None)
         search = kwargs.get("search", None)
@@ -185,8 +185,8 @@ def read(self, **kwargs) -> Dict:
     def delete(self, **kwargs):
         """Delete a role given its ID
 
-        :param role: ID for the role on the platform.
-        :type role: str
+        :param id: ID for the role on the platform.
+        :type id: str
         """
         id = kwargs.get("id", None)
 
@@ -206,7 +206,7 @@ def delete(self, **kwargs):
         """
         self.opencti.query(query, {"id": id})
 
-    def create(self, **kwargs) -> Dict:
+    def create(self, **kwargs) -> Optional[Dict]:
         """Add a new role to OpenCTI.
 
         :param name: Name to assign to the role.
@@ -217,7 +217,7 @@ def create(self, **kwargs) -> Dict:
         :param customAttributes: Custom attributes to return on role
         :type customAttributes: str, optional
         :return: Representation of the role.
-        :rtype: Dict
+        :rtype: Optional[Dict]
         """
         name = kwargs.get("name", None)
         description = kwargs.get("description", None)
@@ -252,7 +252,7 @@ def create(self, **kwargs) -> Dict:
         })
         return self.opencti.process_multiple_fields(result["data"]["roleAdd"])
 
-    def update_field(self, **kwargs) -> Dict:
+    def update_field(self, **kwargs) -> Optional[Dict]:
         """Updates a given role with the given inputs
 
         Example of input::
@@ -276,7 +276,7 @@ def update_field(self, **kwargs) -> Dict:
         :type customAttributes: str, optional
 
         :return: Representation of the role
-        :rtype: Dict
+        :rtype: Optional[Dict]
         """
         id = kwargs.get("id", None)
         input = kwargs.get("input", None)
@@ -308,7 +308,7 @@ def update_field(self, **kwargs) -> Dict:
         return self.opencti.process_multiple_fields(
             result["data"]["roleEdit"]["fieldPatch"])
 
-    def add_capability(self, **kwargs) -> Dict:
+    def add_capability(self, **kwargs) -> Optional[Dict]:
         """Adds a capability to a role
 
         :param id: ID of the role.
@@ -317,7 +317,7 @@ def add_capability(self, **kwargs) -> Dict:
         :type capability_id: str
         :return: Representation of the relationship, including the role and
             capability
-        :rtype: Dict
+        :rtype: Optional[Dict]
         """
         id = kwargs.get("id", None)
         capability_id = kwargs.get("capability_id", None)
@@ -366,15 +366,15 @@ def add_capability(self, **kwargs) -> Dict:
         return self.opencti.process_multiple_fields(
             result["data"]["roleEdit"]["relationAdd"])
 
-    def delete_capability(self, **kwargs) -> Dict:
+    def delete_capability(self, **kwargs) -> Optional[Dict]:
         """Removes a capability from a role
 
         :param id: ID of the role
         :type id: str
         :param capability_id: ID of the capability to remove
         :type capability_id: str
         :return: Representation of the role after removing the capability
-        :rtype: Dict
+        :rtype: Optional[Dict]
         """
         id = kwargs.get("id", None)
         capability_id = kwargs.get("capability_id", None)

pycti/entities/opencti_settings.py

@@ -1,4 +1,4 @@
-from typing import Dict
+from typing import Dict, Optional
 
 
 class Settings:
@@ -247,7 +247,7 @@ def read(self, **kwargs) -> Dict:
         result = self.opencti.query(query)
         return self.opencti.process_multiple_fields(result["data"]["settings"])
 
-    def update_field(self, **kwargs) -> Dict:
+    def update_field(self, **kwargs) -> Optional[Dict]:
         """Update settings using input to fieldPatch
 
         :param id: ID of the settings object to update
@@ -263,7 +263,7 @@ def update_field(self, **kwargs) -> Dict:
             in query response.
         :type include_messages: bool, optional
         :return: Representation of the platform settings
-        :rtype: Dict
+        :rtype: Optional[Dict]
         """
         id = kwargs.get("id", None)
         input = kwargs.get("input", None)
@@ -302,7 +302,7 @@ def update_field(self, **kwargs) -> Dict:
         return self.opencti.process_multiple_fields(
             result["data"]["settingsEdit"]["fieldPatch"])
 
-    def edit_message(self, **kwargs) -> Dict:
+    def edit_message(self, **kwargs) -> Optional[Dict]:
         """Edit or add a message to the platform
 
         To add a message, don't include an ID in the input object. To edit a
@@ -313,7 +313,7 @@ def edit_message(self, **kwargs) -> Dict:
         :param input: SettingsMessageInput object
         :type input: Dict
         :return: Settings ID and message objects
-        :rtype: Dict
+        :rtype: Optional[Dict]
         """
         id = kwargs.get("id", None)
         input = kwargs.get("input", None)
@@ -341,15 +341,15 @@ def edit_message(self, **kwargs) -> Dict:
         return self.opencti.process_multiple_fields(
             result["data"]["settingsEdit"]["editMessage"])
 
-    def delete_message(self, **kwargs) -> Dict:
+    def delete_message(self, **kwargs) -> Optional[Dict]:
         """Delete a message from the platform
 
         :param id: ID of the settings object on the platform
         :type id: str
         :param input: ID of the message to delete
         :type input: str
         :return: Settings ID and message objects
-        :rtype: Dict
+        :rtype: Optional[Dict]
         """
         id = kwargs.get("id", None)
         input = kwargs.get("input", None)