feat(subscriber): add missing data field

novuhq · Feb 26, 2024 · 79678d6 · 79678d6
1 parent 74218b0
commit 79678d6
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 3 deletions.
diff --git a/novu/dto/subscriber.py b/novu/dto/subscriber.py
@@ -108,7 +108,17 @@ class SubscriberChannelSettingsDto(CamelCaseDto["SubscriberChannelSettingsDto"])
 class SubscriberDto(CamelCaseDto["SubscriberDto"]):  # pylint: disable=R0902
     """Definition of subscriber"""
 
-    camel_case_fields = ["subscriber_id", "email", "first_name", "last_name", "phone", "avatar", "locale", "channels"]
+    camel_case_fields = [
+        "subscriber_id",
+        "email",
+        "first_name",
+        "last_name",
+        "phone",
+        "avatar",
+        "locale",
+        "channels",
+        "data",
+    ]
     # Actually, only these fields are editable in Novu, so prevent any activity on others
 
     subscriber_id: str
@@ -161,6 +171,10 @@ class SubscriberDto(CamelCaseDto["SubscriberDto"]):  # pylint: disable=R0902
     last_online_at: Optional[str] = None
     """Last connection date of the subscriber"""
 
+    data: Optional[dict] = None
+    """Apart from the above fixed structured user data, this field contain
+    any unstructured custom data such as user’s address, nationality, height, etc."""
+
 
 @dataclasses.dataclass
 class PaginatedSubscriberDto(CamelCaseDto["PaginatedSubscriberDto"]):

diff --git a/tests/api/test_subscriber.py b/tests/api/test_subscriber.py
@@ -40,6 +40,7 @@ def setUpClass(cls) -> None:
             "__v": 0,
             "isOnline": False,
             "lastOnlineAt": "2023-02-06T23:03:22.645Z",
+            "data": None,
         }
         cls.response_list = {
             "page": 0,
@@ -64,6 +65,7 @@ def setUpClass(cls) -> None:
             updated_at="2023-02-06T23:03:22.645Z",
             is_online=False,
             last_online_at="2023-02-06T23:03:22.645Z",
+            data=None,
         )
 
     @mock.patch("requests.request")
@@ -139,6 +141,7 @@ def test_create_subscriber(self, mock_request: mock.MagicMock) -> None:
                     "updatedAt": "2023-02-07T22:10:57.433Z",
                     "__v": 0,
                     "id": "63e2cc7151af34c4b2f2b5d1",
+                    "data": None,
                 }
             },
         )
@@ -161,6 +164,7 @@ def test_create_subscriber(self, mock_request: mock.MagicMock) -> None:
                 "avatar": None,
                 "locale": None,
                 "channels": None,
+                "data": None,
             },
             params=None,
             timeout=5,
@@ -188,6 +192,7 @@ def test_bulk_create_subscribers(self, mock_request: mock.MagicMock) -> None:
                             "deleted": None,
                             "__v": 0,
                             "id": "63e2cc7151af34c4b2f2b5d1",
+                            "data": {"test": "value"},
                         },
                         {
                             "_organizationId": None,
@@ -204,6 +209,7 @@ def test_bulk_create_subscribers(self, mock_request: mock.MagicMock) -> None:
                             "deleted": None,
                             "__v": 0,
                             "id": "63e2cc7151af34c4b2f2b5d2",
+                            "data": {"test": "value"},
                         },
                     ],
                     "updated": [],
@@ -213,8 +219,8 @@ def test_bulk_create_subscribers(self, mock_request: mock.MagicMock) -> None:
         )
 
         subscribers = [
-            SubscriberDto(subscriber_id="subscriber-id", email="subscriber@sample.com"),
-            SubscriberDto(subscriber_id="subscriber1-id", email="subscriber1@sample.com"),
+            SubscriberDto(subscriber_id="subscriber-id", email="subscriber@sample.com", data={"test": "value"}),
+            SubscriberDto(subscriber_id="subscriber1-id", email="subscriber1@sample.com", data={"test": "value"}),
         ]
 
         res = self.api.bulk_create(subscribers)
@@ -229,12 +235,14 @@ def test_bulk_create_subscribers(self, mock_request: mock.MagicMock) -> None:
                         email="subscriber@sample.com",
                         _id="63e2cc7151af34c4b2f2b5d1",
                         channels=[],
+                        data={"test": "value"},
                     ),
                     SubscriberDto(
                         subscriber_id="subscriber1-id",
                         email="subscriber1@sample.com",
                         _id="63e2cc7151af34c4b2f2b5d2",
                         channels=[],
+                        data={"test": "value"},
                     ),
                 ],
                 updated=[],
@@ -257,6 +265,7 @@ def test_bulk_create_subscribers(self, mock_request: mock.MagicMock) -> None:
                         "avatar": None,
                         "locale": None,
                         "channels": None,
+                        "data": {"test": "value"},
                     },
                     {
                         "subscriberId": "subscriber1-id",
@@ -267,6 +276,7 @@ def test_bulk_create_subscribers(self, mock_request: mock.MagicMock) -> None:
                         "avatar": None,
                         "locale": None,
                         "channels": None,
+                        "data": {"test": "value"},
                     },
                 ]
             },
@@ -336,6 +346,7 @@ def test_get_subscriber_with_credentials_info(self, mock_request: mock.MagicMock
                         "isOnline": False,
                         "email": "oscar.marie-taillefer@spikeelabs.fr",
                         "lastOnlineAt": "2023-02-06T23:03:22.645Z",
+                        "data": None,
                     }
                 },
             )
@@ -368,6 +379,7 @@ def test_get_subscriber_with_credentials_info(self, mock_request: mock.MagicMock
                     updated_at="2023-02-06T23:03:22.645Z",
                     is_online=False,
                     last_online_at="2023-02-06T23:03:22.645Z",
+                    data=None,
                 ),
             )
 
@@ -402,6 +414,7 @@ def test_update_subscriber(self, mock_request: mock.MagicMock) -> None:
                 "avatar": None,
                 "locale": None,
                 "channels": None,
+                "data": None,
             },
             params=None,
             timeout=5,