Merge pull request #73 from mayorJAY/feat-modify-field-data-type

Modify Field Data Types
novuhq · Apr 30, 2024 · d4172c1 · d4172c1
2 parents 813c81d + 50859db
commit d4172c1
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 18 deletions.
diff --git a/src/main/kotlin/dto/request/BaseEventRequest.kt b/src/main/kotlin/dto/request/BaseEventRequest.kt
@@ -1,5 +1,7 @@
 package co.novu.dto.request
 
+import co.novu.dto.Tenant
+
 abstract class BaseEventRequest {
 
     // Mandatory fields
@@ -9,16 +11,40 @@ abstract class BaseEventRequest {
     // Optional fields
     private var overrides: Map<String, Any>? = null
     private var transactionId: String? = null
-    private var actor: String? = null
-    private var tenant: String? = null
+
+    /**
+     * Possible types this field accepts are; String or [Map]
+     *
+     * For example:
+     *
+     * actor = mapOf(
+     *         "subscriberId" to "sId",
+     *         "email" to "[email protected]",
+     *         "firstName" to "fName",
+     *         "lastName" to "lName",
+     *         "phone" to "phoneNo")
+     */
+    private var actor: Any? = null
+
+    /**
+     * Possible types this field accepts are; String or [Tenant]
+     *
+     * For example:
+     *
+     * tenant = Tenant(
+     *          identifier = "identifier",
+     *          name = "name",
+     *          data = Any())
+     */
+    private var tenant: Any? = null
 
     protected fun init(
         name: String,
         payload: Map<String, Any>,
         overrides: Map<String, Any>? = null,
         transactionId: String? = null,
-        actor: String? = null,
-        tenant: String? = null
+        actor: Any? = null,
+        tenant: Any? = null
     ): BaseEventRequest {
         return this.apply {
             this.name = name

diff --git a/src/main/kotlin/dto/request/TriggerEventRequest.kt b/src/main/kotlin/dto/request/TriggerEventRequest.kt
@@ -3,6 +3,9 @@ package co.novu.dto.request
 import co.novu.dto.Topic
 
 class TriggerEventRequest private constructor() : BaseEventRequest() {
+    /**
+     * Possible types this field accepts are; [SubscriberRequest], list of [SubscriberRequest], [Topic] or list of [Topic]
+     */
     private var to: Any? = null
 
     companion object {
@@ -12,8 +15,8 @@ class TriggerEventRequest private constructor() : BaseEventRequest() {
             payload: Map<String, Any>,
             overrides: Map<String, Any>?,
             transactionId: String?,
-            actor: String? = null,
-            tenant: String? = null
+            actor: Any? = null,
+            tenant: Any? = null
         ) =
             TriggerEventRequest()
                 .apply {
@@ -28,8 +31,8 @@ class TriggerEventRequest private constructor() : BaseEventRequest() {
             payload: Map<String, Any> = mapOf(),
             overrides: Map<String, Any>? = null,
             transactionId: String? = null,
-            actor: String? = null,
-            tenant: String? = null
+            actor: Any? = null,
+            tenant: Any? = null
         ) = initFields(name, to, payload, overrides, transactionId, actor, tenant)
 
         @JvmName("fromListOfString")
@@ -39,8 +42,8 @@ class TriggerEventRequest private constructor() : BaseEventRequest() {
             payload: Map<String, Any> = mapOf(),
             overrides: Map<String, Any>? = null,
             transactionId: String? = null,
-            actor: String? = null,
-            tenant: String? = null
+            actor: Any? = null,
+            tenant: Any? = null
         ) = initFields(name, to, payload, overrides, transactionId, actor, tenant)
 
         @JvmName("fromListOfSubscribers")
@@ -50,8 +53,8 @@ class TriggerEventRequest private constructor() : BaseEventRequest() {
             payload: Map<String, Any> = mapOf(),
             overrides: Map<String, Any>? = null,
             transactionId: String? = null,
-            actor: String? = null,
-            tenant: String? = null
+            actor: Any? = null,
+            tenant: Any? = null
         ) = initFields(name, to, payload, overrides, transactionId, actor, tenant)
 
         @JvmName("fromSubscriber")
@@ -61,8 +64,8 @@ class TriggerEventRequest private constructor() : BaseEventRequest() {
             payload: Map<String, Any> = mapOf(),
             overrides: Map<String, Any>? = null,
             transactionId: String? = null,
-            actor: String? = null,
-            tenant: String? = null
+            actor: Any? = null,
+            tenant: Any? = null
         ) = initFields(name, to, payload, overrides, transactionId, actor, tenant)
 
         @JvmName("fromListOfTopics")
@@ -72,8 +75,8 @@ class TriggerEventRequest private constructor() : BaseEventRequest() {
             payload: Map<String, Any> = mapOf(),
             overrides: Map<String, Any>? = null,
             transactionId: String? = null,
-            actor: String? = null,
-            tenant: String? = null
+            actor: Any? = null,
+            tenant: Any? = null
         ) = initFields(name, to, payload, overrides, transactionId, actor, tenant)
     }
 }
diff --git a/src/test/kotlin/EventsApiTest.kt b/src/test/kotlin/EventsApiTest.kt
@@ -1,5 +1,6 @@
 import co.novu.Novu
 import co.novu.NovuConfig
+import co.novu.dto.Tenant
 import co.novu.dto.Topic
 import co.novu.dto.request.BroadcastEventRequest
 import co.novu.dto.request.BulkTriggerEventRequest
@@ -50,7 +51,14 @@ class EventsApiTest {
                 lastName = "Doe"
             ),
             payload = mapOf("customVariables" to "Hello"),
-            transactionId = "transactionId"
+            transactionId = "transactionId",
+            actor = mapOf(
+                "subscriberId" to "sId",
+                "email" to "[email protected]",
+                "firstName" to "fName",
+                "lastName" to "lName",
+                "phone" to "phoneNo"
+            )
         )
         val result = mockNovu.trigger(requestBody)
         val request = mockWebServer.takeRequest()
@@ -84,7 +92,12 @@ class EventsApiTest {
                 )
             ),
             payload = mapOf("customVariables" to "Hello"),
-            transactionId = "transactionId"
+            transactionId = "transactionId",
+            tenant = Tenant(
+                identifier = "identifier",
+                name = "name",
+                data = Any()
+            )
         )
         val result = mockNovu.trigger(requestBody)
         val request = mockWebServer.takeRequest()