@gofynd/fdk-client-javascript 1.4.15-beta.14 → 1.4.15-beta.15

package/sdk/platform/Communication/CommunicationPlatformModel.js

@@ -1,12 +1,31 @@
 const Joi = require("joi");
 
 /**
- * @typedef EventSubscriptionsBulkUpdateRequest
+ * @typedef GroupMapping
+ * @property {EventGroup[]} items - List of event groups configured for the application.
+ */
+
+/**
+ * @typedef EventGroup
+ * @property {string} name - Event group identifier
+ * @property {string} display - Human-readable group name
+ * @property {EventSubgroup[]} subgroups - List of sub-groups that belong to
+ *   this event group.
+ */
+
+/**
+ * @typedef EventSubgroup
+ * @property {string} name - Sub-group identifier
+ * @property {string} display - Human-readable sub-group name
+ */
+
+/**
+ * @typedef EventSubscriptionsBulkUpdatePayload
  * @property {SubscriptionsObject[]} [subscriptions]
  */
 
 /**
- * @typedef EventSubscriptionsBulkUpdateResponse
+ * @typedef EventSubscriptionsBulkUpdateResult
  * @property {EventSubscriptionTemplate} [template]
  * @property {string} [_id]
  * @property {string} [application]
@@ -133,6 +152,7 @@ const Joi = require("joi");
  * @property {string} [name]
  * @property {string} [file_url]
  * @property {string} [type]
+ * @property {string} [datasource_type] - Type of the datasource (audience or user_group)
  * @property {number} [records_count]
  * @property {string} [application]
  */
@@ -171,6 +191,7 @@ const Joi = require("joi");
  * @property {string} [_id]
  * @property {string} [datasource]
  * @property {string} [type]
+ * @property {string} [datasource_type] - Type of the datasource (audience or user_group)
  * @property {string} [name]
  * @property {string} [application]
  * @property {string} [created_at]
@@ -471,26 +492,26 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef EngineRequest
+ * @typedef EnginePayload
  * @property {PayloadStructure} [payload]
  * @property {MetaStructure} [meta]
  */
 
 /**
- * @typedef EngineResponse
+ * @typedef EngineResult
  * @property {boolean} [success]
  */
 
 /**
  * @typedef EventSubscriptionTemplateSms
  * @property {boolean} [subscribed]
- * @property {string} [template]
+ * @property {SmsTemplate} [template]
  */
 
 /**
  * @typedef EventSubscriptionTemplateEmail
  * @property {boolean} [subscribed]
- * @property {string} [template]
+ * @property {EmailTemplate} [template]
  */
 
 /**
@@ -505,13 +526,35 @@ const Joi = require("joi");
  * @property {boolean} [is_default]
  * @property {string} [_id]
  * @property {string} [application]
- * @property {string} [event]
+ * @property {EventSubscriptionEvents} [event]
  * @property {string} [slug]
  * @property {string} [created_at]
  * @property {string} [updated_at]
  * @property {number} [__v]
  */
 
+/**
+ * @typedef EventSubscriptionEvents
+ * @property {string} [category]
+ * @property {string} [event_name]
+ * @property {string} [group]
+ * @property {string} [slug]
+ * @property {EventTemplate} [template]
+ */
+
+/**
+ * @typedef EventTemplate
+ * @property {EventProviderTemplates} [email]
+ * @property {EventProviderTemplates} [pushnotification]
+ * @property {EventProviderTemplates} [sms]
+ */
+
+/**
+ * @typedef EventProviderTemplates
+ * @property {string} [provider_type] - Provider type for the event template
+ * @property {string} [template] - This is the unique id of the template
+ */
+
 /**
  * @typedef EventSubscriptions
  * @property {EventSubscription[]} [items]
@@ -519,23 +562,23 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef TriggerJobResponse
+ * @typedef TriggerJobResult
  * @property {number} [status]
  */
 
 /**
- * @typedef TriggerJobRequest
+ * @typedef TriggerJobPayload
  * @property {string} [job_id]
  */
 
 /**
- * @typedef GlobalVariablesGetResponse
+ * @typedef GetGlobalVariablesResult
  * @property {Object} [read_only]
  * @property {Object} [editable]
  */
 
 /**
- * @typedef GlobalVariablesPostResponse
+ * @typedef CreateGlobalVariablesResult
  * @property {string} [_id]
  * @property {string} [category]
  * @property {string} [application]
@@ -672,6 +715,9 @@ const Joi = require("joi");
  * @property {string} [mobile]
  * @property {string} [country_code]
  * @property {string} [to]
+ * @property {Object} [additional_template_variables] - Additional key-value
+ *   pairs for personalizing message content. Values can be of any type and will
+ *   be substituted into the communication templates when rendering the message.
  */
 
 /**
@@ -765,6 +811,8 @@ const Joi = require("joi");
  * @property {number} [version_id] - The version ID for the test.
  * @property {string} [sender_id] - The sender ID for the test.
  * @property {string} [api_key] - The api_key for the test.
+ * @property {string} [tenant_name_1] - First part of jiocx url.
+ * @property {string} [tenant_name_2] - Second part of jiocx url.
  */
 
 /**
@@ -839,6 +887,11 @@ const Joi = require("joi");
 
 /**
  * @typedef SystemSmsTemplates
+ * @property {SystemSmsTemplate[]} [items] - An array of system SMS templates
+ */
+
+/**
+ * @typedef SystemSmsTemplate
  * @property {EnabledObj} [url_shorten]
  * @property {string} [_id]
  * @property {boolean} [is_system]
@@ -912,13 +965,14 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total] - The total number of items on the page.
+ * @property {number} [item_total] - The total number of all items across all pages.
  * @property {string} [next_id] - The identifier for the next page.
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
  * @property {boolean} [has_next] - Indicates whether there is a next page.
  * @property {number} [current] - The current page number.
- * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {string} type - The type of the page, can be 'cursor' or 'number'.
  * @property {number} [size] - The number of items per page.
+ * @property {number} [page_size] - The number of items per page.
  */
 
 /**
@@ -970,8 +1024,36 @@ const Joi = require("joi");
  */
 
 class CommunicationPlatformModel {
-  /** @returns {EventSubscriptionsBulkUpdateRequest} */
-  static EventSubscriptionsBulkUpdateRequest() {
+  /** @returns {GroupMapping} */
+  static GroupMapping() {
+    return Joi.object({
+      items: Joi.array()
+        .items(CommunicationPlatformModel.EventGroup())
+        .required(),
+    });
+  }
+
+  /** @returns {EventGroup} */
+  static EventGroup() {
+    return Joi.object({
+      name: Joi.string().allow("").required(),
+      display: Joi.string().allow("").required(),
+      subgroups: Joi.array()
+        .items(CommunicationPlatformModel.EventSubgroup())
+        .required(),
+    });
+  }
+
+  /** @returns {EventSubgroup} */
+  static EventSubgroup() {
+    return Joi.object({
+      name: Joi.string().allow("").required(),
+      display: Joi.string().allow("").required(),
+    });
+  }
+
+  /** @returns {EventSubscriptionsBulkUpdatePayload} */
+  static EventSubscriptionsBulkUpdatePayload() {
     return Joi.object({
       subscriptions: Joi.array().items(
         CommunicationPlatformModel.SubscriptionsObject()
@@ -979,8 +1061,8 @@ class CommunicationPlatformModel {
     });
   }
 
-  /** @returns {EventSubscriptionsBulkUpdateResponse} */
-  static EventSubscriptionsBulkUpdateResponse() {
+  /** @returns {EventSubscriptionsBulkUpdateResult} */
+  static EventSubscriptionsBulkUpdateResult() {
     return Joi.object({
       template: CommunicationPlatformModel.EventSubscriptionTemplate(),
       _id: Joi.string().allow(""),
@@ -1148,6 +1230,7 @@ class CommunicationPlatformModel {
       name: Joi.string().allow(""),
       file_url: Joi.string().allow(""),
       type: Joi.string().allow(""),
+      datasource_type: Joi.string().allow(""),
       records_count: Joi.number(),
       application: Joi.string().allow(""),
     });
@@ -1196,6 +1279,7 @@ class CommunicationPlatformModel {
       _id: Joi.string().allow(""),
       datasource: Joi.string().allow(""),
       type: Joi.string().allow(""),
+      datasource_type: Joi.string().allow(""),
       name: Joi.string().allow(""),
       application: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
@@ -1401,7 +1485,7 @@ class CommunicationPlatformModel {
       reply_to: Joi.string().allow(""),
       priority: Joi.string().allow(""),
       tags: Joi.array().items(Joi.string().allow("")),
-      template_variables: Joi.any(),
+      template_variables: Joi.object().pattern(/\S/, Joi.any()),
       published: Joi.boolean(),
       subject: CommunicationPlatformModel.TemplateAndType(),
       html: CommunicationPlatformModel.TemplateAndType(),
@@ -1443,7 +1527,7 @@ class CommunicationPlatformModel {
       html: CommunicationPlatformModel.TemplateAndType(),
       url_shorten: CommunicationPlatformModel.EnabledObj(),
       priority: Joi.string().allow(""),
-      template_variables: Joi.any(),
+      template_variables: Joi.object().pattern(/\S/, Joi.any()),
       published: Joi.boolean(),
       category: Joi.string().allow(""),
       _id: Joi.string().allow(""),
@@ -1475,7 +1559,7 @@ class CommunicationPlatformModel {
       html: CommunicationPlatformModel.TemplateAndType(),
       url_shorten: CommunicationPlatformModel.EnabledObj(),
       priority: Joi.string().allow(""),
-      template_variables: Joi.any(),
+      template_variables: Joi.object().pattern(/\S/, Joi.any()),
       published: Joi.boolean(),
       category: Joi.string().allow(""),
       _id: Joi.string().allow(""),
@@ -1574,16 +1658,16 @@ class CommunicationPlatformModel {
     });
   }
 
-  /** @returns {EngineRequest} */
-  static EngineRequest() {
+  /** @returns {EnginePayload} */
+  static EnginePayload() {
     return Joi.object({
       payload: CommunicationPlatformModel.PayloadStructure(),
       meta: CommunicationPlatformModel.MetaStructure(),
     });
   }
 
-  /** @returns {EngineResponse} */
-  static EngineResponse() {
+  /** @returns {EngineResult} */
+  static EngineResult() {
     return Joi.object({
       success: Joi.boolean(),
     });
@@ -1593,7 +1677,7 @@ class CommunicationPlatformModel {
   static EventSubscriptionTemplateSms() {
     return Joi.object({
       subscribed: Joi.boolean(),
-      template: Joi.string().allow(""),
+      template: CommunicationPlatformModel.SmsTemplate(),
     });
   }
 
@@ -1601,7 +1685,7 @@ class CommunicationPlatformModel {
   static EventSubscriptionTemplateEmail() {
     return Joi.object({
       subscribed: Joi.boolean(),
-      template: Joi.string().allow(""),
+      template: CommunicationPlatformModel.EmailTemplate(),
     });
   }
 
@@ -1620,7 +1704,7 @@ class CommunicationPlatformModel {
       is_default: Joi.boolean(),
       _id: Joi.string().allow(""),
       application: Joi.string().allow(""),
-      event: Joi.string().allow(""),
+      event: CommunicationPlatformModel.EventSubscriptionEvents(),
       slug: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
       updated_at: Joi.string().allow(""),
@@ -1628,6 +1712,34 @@ class CommunicationPlatformModel {
     });
   }
 
+  /** @returns {EventSubscriptionEvents} */
+  static EventSubscriptionEvents() {
+    return Joi.object({
+      category: Joi.string().allow(""),
+      event_name: Joi.string().allow(""),
+      group: Joi.string().allow(""),
+      slug: Joi.string().allow(""),
+      template: CommunicationPlatformModel.EventTemplate(),
+    });
+  }
+
+  /** @returns {EventTemplate} */
+  static EventTemplate() {
+    return Joi.object({
+      email: CommunicationPlatformModel.EventProviderTemplates(),
+      pushnotification: CommunicationPlatformModel.EventProviderTemplates(),
+      sms: CommunicationPlatformModel.EventProviderTemplates(),
+    });
+  }
+
+  /** @returns {EventProviderTemplates} */
+  static EventProviderTemplates() {
+    return Joi.object({
+      provider_type: Joi.string().allow("").allow(null),
+      template: Joi.string().allow("").allow(null),
+    });
+  }
+
   /** @returns {EventSubscriptions} */
   static EventSubscriptions() {
     return Joi.object({
@@ -1636,35 +1748,35 @@ class CommunicationPlatformModel {
     });
   }
 
-  /** @returns {TriggerJobResponse} */
-  static TriggerJobResponse() {
+  /** @returns {TriggerJobResult} */
+  static TriggerJobResult() {
     return Joi.object({
       status: Joi.number(),
     });
   }
 
-  /** @returns {TriggerJobRequest} */
-  static TriggerJobRequest() {
+  /** @returns {TriggerJobPayload} */
+  static TriggerJobPayload() {
     return Joi.object({
       job_id: Joi.string().allow(""),
     });
   }
 
-  /** @returns {GlobalVariablesGetResponse} */
-  static GlobalVariablesGetResponse() {
+  /** @returns {GetGlobalVariablesResult} */
+  static GetGlobalVariablesResult() {
     return Joi.object({
-      read_only: Joi.any(),
-      editable: Joi.any(),
+      read_only: Joi.object().pattern(/\S/, Joi.any()),
+      editable: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 
-  /** @returns {GlobalVariablesPostResponse} */
-  static GlobalVariablesPostResponse() {
+  /** @returns {CreateGlobalVariablesResult} */
+  static CreateGlobalVariablesResult() {
     return Joi.object({
       _id: Joi.string().allow(""),
       category: Joi.string().allow(""),
       application: Joi.string().allow(""),
-      global_variables: Joi.any(),
+      global_variables: Joi.object().pattern(/\S/, Joi.any()),
       created_at: Joi.string().allow(""),
     });
   }
@@ -1672,7 +1784,7 @@ class CommunicationPlatformModel {
   /** @returns {GlobalVariablesReq} */
   static GlobalVariablesReq() {
     return Joi.object({
-      global_variables: Joi.any(),
+      global_variables: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 
@@ -1831,6 +1943,7 @@ class CommunicationPlatformModel {
       mobile: Joi.string().allow(""),
       country_code: Joi.string().allow(""),
       to: Joi.string().allow(""),
+      additional_template_variables: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 
@@ -1944,6 +2057,8 @@ class CommunicationPlatformModel {
       version_id: Joi.number(),
       sender_id: Joi.string().allow(""),
       api_key: Joi.string().allow(""),
+      tenant_name_1: Joi.string().allow(""),
+      tenant_name_2: Joi.string().allow(""),
     });
   }
 
@@ -2018,7 +2133,7 @@ class CommunicationPlatformModel {
       message: CommunicationPlatformModel.SmsTemplateMessage(),
       priority: Joi.string().allow(""),
       tags: Joi.array().items(Joi.string().allow("")),
-      template_variables: Joi.any(),
+      template_variables: Joi.object().pattern(/\S/, Joi.any()),
       template_id: Joi.string().allow(""),
       published: Joi.boolean(),
       category: Joi.string().allow(""),
@@ -2031,6 +2146,13 @@ class CommunicationPlatformModel {
 
   /** @returns {SystemSmsTemplates} */
   static SystemSmsTemplates() {
+    return Joi.object({
+      items: Joi.array().items(CommunicationPlatformModel.SystemSmsTemplate()),
+    });
+  }
+
+  /** @returns {SystemSmsTemplate} */
+  static SystemSmsTemplate() {
     return Joi.object({
       url_shorten: CommunicationPlatformModel.EnabledObj(),
       _id: Joi.string().allow(""),
@@ -2041,7 +2163,7 @@ class CommunicationPlatformModel {
       message: CommunicationPlatformModel.SmsTemplateMessage(),
       priority: Joi.string().allow(""),
       tags: Joi.array().items(Joi.string().allow("")),
-      template_variables: Joi.any(),
+      template_variables: Joi.object().pattern(/\S/, Joi.any()),
       template_id: Joi.string().allow(""),
       published: Joi.boolean(),
       category: Joi.string().allow(""),
@@ -2069,7 +2191,7 @@ class CommunicationPlatformModel {
       priority: Joi.string().allow(""),
       template_id: Joi.string().allow(""),
       meta: CommunicationPlatformModel.metaObj(),
-      template_variables: Joi.any(),
+      template_variables: Joi.object().pattern(/\S/, Joi.any()),
       published: Joi.boolean(),
       message: CommunicationPlatformModel.SmsTemplateMessage(),
     });
@@ -2126,6 +2248,7 @@ class CommunicationPlatformModel {
       current: Joi.number(),
       type: Joi.string().allow("").required(),
       size: Joi.number(),
+      page_size: Joi.number(),
     });
   }