support for subscriber creation in trigger function

novu/api/event.py

@@ -8,7 +8,7 @@
 
 from novu.api.base import Api
 from novu.constants import EVENTS_ENDPOINT
-from novu.dto.event import EventDto, InputEventDto
+from novu.dto.event import EventDto, InputEventDto, RecipientDto
 from novu.dto.topic import TriggerTopicDto
 
 
@@ -29,7 +29,7 @@ def __init__(
     def trigger(
         self,
         name: str,
-        recipients: Union[str, List[str]],
+        recipients: Union[str, Iterable[str], RecipientDto, Iterable[RecipientDto]],
         payload: dict,
         overrides: Optional[dict] = None,
         transaction_id: Optional[str] = None,
@@ -51,7 +51,14 @@ def trigger(
 
         Args:
             name: The name of the template trigger to activate.
-            recipients: A subscriber ID (or a list of subscriber ID) to reach with this trigger
+            recipients:
+                One of following format (to define the recipient of the event):
+
+                * A subscriber ID
+                * A list of subscriber ID
+                * A SubscriberDto
+                * A list of SubscriberDto
+
             payload:
                 A JSON serializable python dict to pass additional custom information that could be used to render the
                 template, or perform routing rules based on it. This data will also be available when fetching the
@@ -72,7 +79,20 @@ def trigger(
         Returns:
             Create Event definition in Novu
         """
-        payload = {"name": name, "to": recipients, "payload": payload}
+        tmp = [recipients] if not isinstance(recipients, Iterable) else recipients
+
+        to: List[Union[str, dict]] = []
+        for item in tmp:
+            if isinstance(item, str):
+                to.append(item)
+            elif isinstance(item, RecipientDto):
+                to.append(item.to_camel_case())
+
+            else:
+                raise ValueError(
+                    f"Provided format for the 'recipients' arguments ({type(item)}) isn't supported by the SDK."
+                )
+        payload = {"name": name, "to": to, "payload": payload}
         if overrides:
             payload["overrides"] = overrides
         if actor:
@@ -161,7 +181,11 @@ def trigger_topic(
         """
         _recipients = topics if isinstance(topics, Iterable) else [topics]
 
-        payload = {"name": name, "to": [r.to_camel_case() for r in _recipients], "payload": payload}
+        payload = {
+            "name": name,
+            "to": [r.to_camel_case() for r in _recipients],
+            "payload": payload,
+        }
         if overrides:
             payload["overrides"] = overrides
         if actor:

novu/dto/__init__.py

@@ -11,7 +11,7 @@
     EnvironmentDto,
     EnvironmentWidgetDto,
 )
-from novu.dto.event import EventDto
+from novu.dto.event import EventDto, InputEventDto, RecipientDto
 from novu.dto.execution_detail import ExecutionDetailDto
 from novu.dto.feed import FeedDto
 from novu.dto.field import FieldFilterPartDto
@@ -66,6 +66,8 @@
     "EnvironmentDto",
     "EnvironmentWidgetDto",
     "EventDto",
+    "RecipientDto",
+    "InputEventDto",
     "ExecutionDetailDto",
     "FeedDto",
     "FieldFilterPartDto",

novu/dto/event.py

@@ -2,7 +2,7 @@
 import dataclasses
 from typing import List, Optional, Union
 
-from novu.dto.base import CamelCaseDto
+from novu.dto.base import CamelCaseDto, DtoDescriptor, DtoIterableDescriptor
 from novu.enums import EventStatus
 
 
@@ -20,19 +20,50 @@ class EventDto(CamelCaseDto["EventDto"]):
     """Transaction id for trigger."""
 
 
+@dataclasses.dataclass
+class RecipientDto(CamelCaseDto["RecipientDto"]):  # pylint: disable=R0902
+    """The recipients list of people who will receive the notification."""
+
+    subscriber_id: str
+    """Subscriber ID of the recipient."""
+
+    email: Optional[str] = None
+    """Email of the recipient."""
+
+    first_name: Optional[str] = None
+    """First name of the recipient."""
+
+    last_name: Optional[str] = None
+    """Last name of the recipient."""
+
+    phone: Optional[str] = None
+    """Phone number of the recipient."""
+
+    avatar: Optional[str] = None
+    """Avatar URL of the recipient."""
+
+    locale: Optional[str] = None
+    """Locale(language and region) of the recipient, ."""
+
+    data: Optional[dict] = None
+    """Additional data for the recipient."""
+
+
 @dataclasses.dataclass
 class InputEventDto(CamelCaseDto["InputEventDto"]):
     """Definition of an event used as an input"""
 
     name: str
     """The name of the template trigger to activate."""
 
-    recipients: Union[str, List[str]]
-    """A subscriber ID (or a list of subscriber ID) to reach with this trigger."""
-
     payload: dict
     """A JSON serializable python dict to pass additional custom information."""
 
+    recipients: DtoIterableDescriptor[RecipientDto] = DtoIterableDescriptor[RecipientDto](
+        default_factory=list, item_cls=RecipientDto
+    )
+    """A subscriber ID (or a list of subscriber ID) to reach with this trigger."""
+
     overrides: Optional[dict] = None
     """A JSON serializable python dict used to override provider specific configurations."""