@gofynd/fdk-client-javascript 1.6.3 → 3.0.0-beta.1

package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js

@@ -2,17 +2,16 @@ const Joi = require("joi");
 
 const CommunicationPlatformModel = require("./CommunicationPlatformModel");
 
+/**
+ * @typedef CreateAppPushtokenParam
+ * @property {CommunicationPlatformModel.PushtokenReq} body
+ */
+
 /**
  * @typedef CreateAudienceParam
  * @property {CommunicationPlatformModel.AudienceReq} body
  */
 
-/** @typedef CreateBigQueryHeadersParam */
-
-/** @typedef CreateBigQueryNCountParam */
-
-/** @typedef CreateBigQueryRowCountParam */
-
 /**
  * @typedef CreateCampaignParam
  * @property {CommunicationPlatformModel.CampaignReq} body
@@ -35,7 +34,7 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
 
 /**
  * @typedef CreateEventSubscriptionsByBulkParam
- * @property {CommunicationPlatformModel.EventSubscriptionsBulkUpdatePayload} body
+ * @property {CommunicationPlatformModel.EventSubscriptionsBulkUpdateRequest} body
  */
 
 /**
@@ -55,18 +54,23 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
 
 /**
  * @typedef DeleteAudienceByIdParam
- * @property {string} id - Audience id
+ * @property {string} id - Event subscription id
  * @property {CommunicationPlatformModel.AudienceReq} body
  */
 
+/**
+ * @typedef DeleteCampaignByIdParam
+ * @property {string} id - Event subscription id
+ */
+
 /**
  * @typedef DeleteEmailProviderByIdParam
- * @property {string} id - Email provider id
+ * @property {string} id - Event subscription id
  */
 
 /**
  * @typedef DeleteEmailTemplateByIdParam
- * @property {string} id - Email template id
+ * @property {string} id - Event subscription id
  */
 
 /**
@@ -76,66 +80,58 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
 
 /**
  * @typedef DeleteSmsProviderByIdParam
- * @property {string} id - Sms provider id
+ * @property {string} id - Event subscription id
  */
 
 /**
  * @typedef DeleteSmsTemplateByIdParam
- * @property {string} id - Sms template id
+ * @property {string} id - Event subscription id
  */
 
 /**
  * @typedef EditEventSubscriptionsParam
  * @property {string} id - Event subscription id
- * @property {CommunicationPlatformModel.SubscriptionsObject} body
+ * @property {CommunicationPlatformModel.SubscriptionsObjectRequest} body
  */
 
 /** @typedef GetAppProvidersParam */
 
 /**
  * @typedef GetAudienceByIdParam
- * @property {string} id - Audience id
+ * @property {string} id - Event subscription id
  */
 
 /**
  * @typedef GetAudiencesParam
  * @property {number} [pageNo] - Current page no
  * @property {number} [pageSize] - Current request items count
- * @property {Object} [sort] - To sort based on created_at
- * @property {Object} [query] - To search based on plain text
- */
-
-/**
- * @typedef GetBigQueryHeadersByIdParam
- * @property {string} id - Audience id
- */
-
-/**
- * @typedef GetBigQueryRowCountByIdParam
- * @property {string} id - Audience id
+ * @property {string} [sort] - To sort based on created_at
+ * @property {string} [query] - To search based on plain text
  */
 
 /**
  * @typedef GetCampaignByIdParam
- * @property {string} id - Campaign id
+ * @property {string} id - Event subscription id
  */
 
 /**
  * @typedef GetCampaignsParam
- * @property {Object} [query] - To search based on plain text
+ * @property {string} [query] - To search based on plain text
  * @property {number} [pageNo] - Current page no
  * @property {number} [pageSize] - Current request items count
- * @property {Object} [sort] - To sort based on created_at
+ * @property {string} [sort] - To sort based on created_at
  */
 
 /**
  * @typedef GetCommunicationLogsParam
- * @property {string} [pageId] - Current page no
+ * @property {number} [pageNo] - Current page no
  * @property {number} [pageSize] - Current request items count
- * @property {Object} [sort] - To sort based on _id
+ * @property {string} [sort] - To sort based on created_at
  * @property {Object} [query]
  */
 
+/** @typedef GetDefaultEmailProvidersParam */
+
 /** @typedef GetDefaultSmsProvidersParam */
 
 /** @typedef GetDummyDatasourcesParam */
@@ -147,28 +143,28 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
 
 /**
  * @typedef GetEmailProviderByIdParam
- * @property {string} id - Email provider id
+ * @property {string} id - Event subscription id
  */
 
 /**
  * @typedef GetEmailProvidersParam
  * @property {number} [pageNo] - Current page no
  * @property {number} [pageSize] - Current request items count
- * @property {Object} [sort] - To sort based on created_at
- * @property {Object} [query] - To search based on plain text
+ * @property {string} [sort] - To sort based on created_at
+ * @property {string} [query] - To search based on plain text
  */
 
 /**
  * @typedef GetEmailTemplateByIdParam
- * @property {string} id - Email template id
+ * @property {string} id - Event subscription id
  */
 
 /**
  * @typedef GetEmailTemplatesParam
  * @property {number} [pageNo] - Current page no
  * @property {number} [pageSize] - Current request items count
- * @property {Object} [sort] - To sort based on created_at
- * @property {Object} [query] - To search based on plain text
+ * @property {string} [sort] - To sort based on created_at
+ * @property {string} [query] - To search based on plain text
  */
 
 /**
@@ -180,8 +176,8 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
 
 /**
  * @typedef GetEventSubscriptionsByIdParam
- * @property {string} id - Event subscription id
  * @property {string} [populate] - Populate Fields
+ * @property {string} id - Event subscription id
  */
 
 /** @typedef GetGlobalProvidersParam */
@@ -192,16 +188,16 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
  * @typedef GetJobLogsParam
  * @property {number} [pageNo] - Current page no
  * @property {number} [pageSize] - Current request items count
- * @property {Object} [sort] - To sort based on created_at
- * @property {Object} [query] - To search based on plain text
+ * @property {string} [sort] - To sort based on created_at
+ * @property {string} [query] - To search based on plain text
  */
 
 /**
  * @typedef GetJobsParam
  * @property {number} [pageNo] - Current page no
  * @property {number} [pageSize] - Current request items count
- * @property {Object} [sort] - To sort based on created_at
- * @property {Object} [query] - To search based on plain text
+ * @property {string} [sort] - To sort based on created_at
+ * @property {string} [query] - To search based on plain text
  */
 
 /**
@@ -209,57 +205,60 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
  * @property {CommunicationPlatformModel.GetNRecordsCsvReq} body
  */
 
-/** @typedef GetNSampleRecordsFromCsvByGetParam */
+/**
+ * @typedef GetNSampleRecordsFromCsvByGetParam
+ * @property {number} [count] - Number or records
+ * @property {boolean} [header] - Header needed
+ * @property {string} [url] - Url of file
+ */
 
 /** @typedef GetOtpConfigurationParam */
 
 /**
  * @typedef GetSmsProviderByIdParam
- * @property {string} id - Sms provider id
+ * @property {string} id - Event subscription id
  */
 
 /**
  * @typedef GetSmsProvidersParam
  * @property {number} [pageNo] - Current page no
  * @property {number} [pageSize] - Current request items count
- * @property {Object} [sort] - To sort based on created_at
- * @property {Object} [query] - To search based on plain text
+ * @property {string} [sort] - To sort based on created_at
+ * @property {string} [query] - To search based on plain text
  */
 
 /**
  * @typedef GetSmsTemplateByIdParam
- * @property {string} id - Sms template id
+ * @property {string} id - Event subscription id
  */
 
 /**
  * @typedef GetSmsTemplatesParam
  * @property {number} [pageNo] - Current page no
  * @property {number} [pageSize] - Current request items count
- * @property {Object} [sort] - To sort based on created_at
- * @property {Object} [query] - To search based on plain text
+ * @property {string} [sort] - To sort based on created_at
+ * @property {string} [query] - To search based on plain text
  */
 
 /**
  * @typedef GetStatsOfCampaignByIdParam
- * @property {string} id - Campaign id
+ * @property {string} id - Event subscription id
  */
 
 /**
  * @typedef GetSubscribedEmailTemplatesParam
  * @property {number} [pageNo] - Current page no
  * @property {number} [pageSize] - Current request items count
- * @property {Object} [query] - To search based on plain text
+ * @property {string} [query] - To search based on plain text
  */
 
 /**
  * @typedef GetSubscribedSmsTemplatesParam
  * @property {number} [pageNo] - Current page no
  * @property {number} [pageSize] - Current request items count
- * @property {Object} [query] - To search based on plain text
+ * @property {string} [query] - To search based on plain text
  */
 
-/** @typedef GetSystemAudiencesParam */
-
 /** @typedef GetSystemEmailTemplatesParam */
 
 /** @typedef GetSystemSmsTemplatesParam */
@@ -271,22 +270,28 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
 
 /**
  * @typedef SendCommunicationAsynchronouslyParam
- * @property {CommunicationPlatformModel.EnginePayload} body
+ * @property {CommunicationPlatformModel.EngineRequest} body
  */
 
 /**
  * @typedef SendCommunicationSynchronouslyParam
- * @property {CommunicationPlatformModel.EnginePayload} body
+ * @property {CommunicationPlatformModel.EngineRequest} body
+ */
+
+/**
+ * @typedef SendEngineCommunicationSynchronouslyParam
+ * @property {CommunicationPlatformModel.EngineRequest} body
  */
 
 /**
  * @typedef SendOtpParam
+ * @property {boolean} [ci] - Common Information
  * @property {CommunicationPlatformModel.SendOtpCommsReq} body
  */
 
 /**
  * @typedef TriggerCampaignJobParam
- * @property {CommunicationPlatformModel.TriggerJobPayload} body
+ * @property {CommunicationPlatformModel.TriggerJobRequest} body
  */
 
 /**
@@ -294,41 +299,49 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
  * @property {CommunicationPlatformModel.AppProviderReq} body
  */
 
+/**
+ * @typedef UpdateAppProvidersGlobalProviderParam
+ * @property {CommunicationPlatformModel.AppProvidersGlobalProviderRequest} body
+ */
+
 /**
  * @typedef UpdateAudienceByIdParam
- * @property {string} id - Audience id
+ * @property {string} id - Event subscription id
  * @property {CommunicationPlatformModel.AudienceReq} body
  */
 
 /**
  * @typedef UpdateCampaignByIdParam
- * @property {string} id - Campaign id
+ * @property {string} id - Event subscription id
  * @property {CommunicationPlatformModel.CampaignReq} body
  */
 
 /**
  * @typedef UpdateEmailProviderByIdParam
- * @property {string} id - Email provider id
+ * @property {string} id - Event subscription id
  * @property {CommunicationPlatformModel.EmailProviderReq} body
  */
 
 /**
  * @typedef UpdateEmailTemplateByIdParam
- * @property {string} id - Email template id
+ * @property {string} id - Event subscription id
  * @property {CommunicationPlatformModel.EmailTemplateReq} body
  */
 
-/** @typedef UpdateOtpConfigurationParam */
+/**
+ * @typedef UpdateOtpConfigurationParam
+ * @property {CommunicationPlatformModel.OtpConfiguration} body
+ */
 
 /**
  * @typedef UpdateSmsProviderByIdParam
- * @property {string} id - Sms provider id
+ * @property {string} id - Event subscription id
  * @property {CommunicationPlatformModel.SmsProviderReq} body
  */
 
 /**
  * @typedef UpdateSmsTemplateByIdParam
- * @property {string} id - Sms template id
+ * @property {string} id - Event subscription id
  * @property {CommunicationPlatformModel.SmsTemplateReq} body
  */
 
@@ -338,6 +351,13 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
  */
 
 class CommunicationPlatformApplicationValidator {
+  /** @returns {CreateAppPushtokenParam} */
+  static createAppPushtoken() {
+    return Joi.object({
+      body: CommunicationPlatformModel.PushtokenReq().required(),
+    }).required();
+  }
+
   /** @returns {CreateAudienceParam} */
   static createAudience() {
     return Joi.object({
@@ -345,21 +365,6 @@ class CommunicationPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {CreateBigQueryHeadersParam} */
-  static createBigQueryHeaders() {
-    return Joi.object({}).required();
-  }
-
-  /** @returns {CreateBigQueryNCountParam} */
-  static createBigQueryNCount() {
-    return Joi.object({}).required();
-  }
-
-  /** @returns {CreateBigQueryRowCountParam} */
-  static createBigQueryRowCount() {
-    return Joi.object({}).required();
-  }
-
   /** @returns {CreateCampaignParam} */
   static createCampaign() {
     return Joi.object({
@@ -391,7 +396,7 @@ class CommunicationPlatformApplicationValidator {
   /** @returns {CreateEventSubscriptionsByBulkParam} */
   static createEventSubscriptionsByBulk() {
     return Joi.object({
-      body: CommunicationPlatformModel.EventSubscriptionsBulkUpdatePayload().required(),
+      body: CommunicationPlatformModel.EventSubscriptionsBulkUpdateRequest().required(),
     }).required();
   }
 
@@ -424,6 +429,13 @@ class CommunicationPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {DeleteCampaignByIdParam} */
+  static deleteCampaignById() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {DeleteEmailProviderByIdParam} */
   static deleteEmailProviderById() {
     return Joi.object({
@@ -463,7 +475,7 @@ class CommunicationPlatformApplicationValidator {
   static editEventSubscriptions() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: CommunicationPlatformModel.SubscriptionsObject().required(),
+      body: CommunicationPlatformModel.SubscriptionsObjectRequest().required(),
     }).required();
   }
 
@@ -484,22 +496,8 @@ class CommunicationPlatformApplicationValidator {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      sort: Joi.any(),
-      query: Joi.any(),
-    }).required();
-  }
-
-  /** @returns {GetBigQueryHeadersByIdParam} */
-  static getBigQueryHeadersById() {
-    return Joi.object({
-      id: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetBigQueryRowCountByIdParam} */
-  static getBigQueryRowCountById() {
-    return Joi.object({
-      id: Joi.string().allow("").required(),
+      sort: Joi.string().allow(""),
+      query: Joi.string().allow(""),
     }).required();
   }
 
@@ -513,23 +511,28 @@ class CommunicationPlatformApplicationValidator {
   /** @returns {GetCampaignsParam} */
   static getCampaigns() {
     return Joi.object({
-      query: Joi.any(),
+      query: Joi.string().allow(""),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      sort: Joi.any(),
+      sort: Joi.string().allow(""),
     }).required();
   }
 
   /** @returns {GetCommunicationLogsParam} */
   static getCommunicationLogs() {
     return Joi.object({
-      pageId: Joi.string().allow(""),
+      pageNo: Joi.number(),
       pageSize: Joi.number(),
-      sort: Joi.any(),
+      sort: Joi.string().allow(""),
       query: Joi.any(),
     }).required();
   }
 
+  /** @returns {GetDefaultEmailProvidersParam} */
+  static getDefaultEmailProviders() {
+    return Joi.object({}).required();
+  }
+
   /** @returns {GetDefaultSmsProvidersParam} */
   static getDefaultSmsProviders() {
     return Joi.object({}).required();
@@ -559,8 +562,8 @@ class CommunicationPlatformApplicationValidator {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      sort: Joi.any(),
-      query: Joi.any(),
+      sort: Joi.string().allow(""),
+      query: Joi.string().allow(""),
     }).required();
   }
 
@@ -576,8 +579,8 @@ class CommunicationPlatformApplicationValidator {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      sort: Joi.any(),
-      query: Joi.any(),
+      sort: Joi.string().allow(""),
+      query: Joi.string().allow(""),
     }).required();
   }
 
@@ -593,8 +596,8 @@ class CommunicationPlatformApplicationValidator {
   /** @returns {GetEventSubscriptionsByIdParam} */
   static getEventSubscriptionsById() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
       populate: Joi.string().allow(""),
+      id: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -613,8 +616,8 @@ class CommunicationPlatformApplicationValidator {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      sort: Joi.any(),
-      query: Joi.any(),
+      sort: Joi.string().allow(""),
+      query: Joi.string().allow(""),
     }).required();
   }
 
@@ -623,8 +626,8 @@ class CommunicationPlatformApplicationValidator {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      sort: Joi.any(),
-      query: Joi.any(),
+      sort: Joi.string().allow(""),
+      query: Joi.string().allow(""),
     }).required();
   }
 
@@ -637,7 +640,11 @@ class CommunicationPlatformApplicationValidator {
 
   /** @returns {GetNSampleRecordsFromCsvByGetParam} */
   static getNSampleRecordsFromCsvByGet() {
-    return Joi.object({}).required();
+    return Joi.object({
+      count: Joi.number(),
+      header: Joi.boolean(),
+      url: Joi.string().allow(""),
+    }).required();
   }
 
   /** @returns {GetOtpConfigurationParam} */
@@ -657,8 +664,8 @@ class CommunicationPlatformApplicationValidator {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      sort: Joi.any(),
-      query: Joi.any(),
+      sort: Joi.string().allow(""),
+      query: Joi.string().allow(""),
     }).required();
   }
 
@@ -674,8 +681,8 @@ class CommunicationPlatformApplicationValidator {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      sort: Joi.any(),
-      query: Joi.any(),
+      sort: Joi.string().allow(""),
+      query: Joi.string().allow(""),
     }).required();
   }
 
@@ -691,7 +698,7 @@ class CommunicationPlatformApplicationValidator {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      query: Joi.any(),
+      query: Joi.string().allow(""),
     }).required();
   }
 
@@ -700,15 +707,10 @@ class CommunicationPlatformApplicationValidator {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      query: Joi.any(),
+      query: Joi.string().allow(""),
     }).required();
   }
 
-  /** @returns {GetSystemAudiencesParam} */
-  static getSystemAudiences() {
-    return Joi.object({}).required();
-  }
-
   /** @returns {GetSystemEmailTemplatesParam} */
   static getSystemEmailTemplates() {
     return Joi.object({}).required();
@@ -729,20 +731,28 @@ class CommunicationPlatformApplicationValidator {
   /** @returns {SendCommunicationAsynchronouslyParam} */
   static sendCommunicationAsynchronously() {
     return Joi.object({
-      body: CommunicationPlatformModel.EnginePayload().required(),
+      body: CommunicationPlatformModel.EngineRequest().required(),
     }).required();
   }
 
   /** @returns {SendCommunicationSynchronouslyParam} */
   static sendCommunicationSynchronously() {
     return Joi.object({
-      body: CommunicationPlatformModel.EnginePayload().required(),
+      body: CommunicationPlatformModel.EngineRequest().required(),
+    }).required();
+  }
+
+  /** @returns {SendEngineCommunicationSynchronouslyParam} */
+  static sendEngineCommunicationSynchronously() {
+    return Joi.object({
+      body: CommunicationPlatformModel.EngineRequest().required(),
     }).required();
   }
 
   /** @returns {SendOtpParam} */
   static sendOtp() {
     return Joi.object({
+      ci: Joi.boolean(),
       body: CommunicationPlatformModel.SendOtpCommsReq().required(),
     }).required();
   }
@@ -750,7 +760,7 @@ class CommunicationPlatformApplicationValidator {
   /** @returns {TriggerCampaignJobParam} */
   static triggerCampaignJob() {
     return Joi.object({
-      body: CommunicationPlatformModel.TriggerJobPayload().required(),
+      body: CommunicationPlatformModel.TriggerJobRequest().required(),
     }).required();
   }
 
@@ -761,6 +771,13 @@ class CommunicationPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {UpdateAppProvidersGlobalProviderParam} */
+  static updateAppProvidersGlobalProvider() {
+    return Joi.object({
+      body: CommunicationPlatformModel.AppProvidersGlobalProviderRequest().required(),
+    }).required();
+  }
+
   /** @returns {UpdateAudienceByIdParam} */
   static updateAudienceById() {
     return Joi.object({
@@ -795,7 +812,9 @@ class CommunicationPlatformApplicationValidator {
 
   /** @returns {UpdateOtpConfigurationParam} */
   static updateOtpConfiguration() {
-    return Joi.object({}).required();
+    return Joi.object({
+      body: CommunicationPlatformModel.OtpConfiguration().required(),
+    }).required();
   }
 
   /** @returns {UpdateSmsProviderByIdParam} */