@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0

package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js

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