feat/additonal-info-sdk - TKT-864

CHANGES

@@ -1,3 +1,7 @@
+1.18.9
+------
+- Add additional info property to send phishing email.
+
 1.18.8
 ------
 - Fix is_available method.

intezer_sdk/__init__.py

@@ -1 +1 @@
-__version__ = '1.18.8'
+__version__ = '1.18.9'

intezer_sdk/alerts.py

@@ -235,7 +235,8 @@ def send_phishing_email(cls,
                             alert_sender: Optional[str] = None,
                             wait: bool = False,
                             timeout: Optional[int] = None,
-                            email_path: Optional[str] = None):
+                            email_path: Optional[str] = None,
+                            additional_info: Optional[dict] = None):
         """
         Send an alert for further investigation using the Intezer Analyze API.
         Should pass either raw_email or email_path.
@@ -248,6 +249,7 @@ def send_phishing_email(cls,
         :param wait: Wait for the alert to finish processing before returning.
         :param timeout: The timeout for the wait operation.
         :param email_path: The path to the email file.
+        :param additional_info: Additional information to send with the alert.
         :raises: :class:`requests.HTTPError` if the request failed for any reason.
         :return: The Alert instance, initialized with the alert id. when the `wait` parameter is set to True, the
                  resulting alert object will be initialized with the alert triage data.
@@ -266,9 +268,10 @@ def send_phishing_email(cls,
             file_name=cls._parse_alert_id_from_alert_stream(raw_email),
             alert_source='phishing_emails',
             environment=environment,
-            display_fields=','.join(['sender', 'received', 'subject', 'message_id', 'to']),
+            display_fields=','.join(['received_by', 'sender', 'received', 'subject', 'message_id', 'to']),
             default_verdict=default_verdict,
-            alert_sender=alert_sender
+            alert_sender=alert_sender,
+            additional_info=json.dumps(additional_info) if additional_info else None,
         )
 
         send_alert_params = {key: value for key, value in send_alert_params.items() if value is not None}