@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js

@@ -1,61 +1,303 @@
 const Joi = require("joi");
 
-const CommunicationModel = require("./CommunicationPlatformModel");
-class CommunicationValidator {
+const CommunicationPlatformModel = require("./CommunicationPlatformModel");
+
+/**
+ * @typedef CreateAudienceParam
+ * @property {CommunicationPlatformModel.AudienceReq} body
+ */
+
+/**
+ * @typedef CreateCampaignParam
+ * @property {CommunicationPlatformModel.CampaignReq} body
+ */
+
+/**
+ * @typedef CreateEmailProviderParam
+ * @property {CommunicationPlatformModel.EmailProviderReq} body
+ */
+
+/**
+ * @typedef CreateEmailTemplateParam
+ * @property {CommunicationPlatformModel.EmailTemplateReq} body
+ */
+
+/**
+ * @typedef CreateSmsProviderParam
+ * @property {CommunicationPlatformModel.SmsProviderReq} body
+ */
+
+/**
+ * @typedef CreateSmsTemplateParam
+ * @property {CommunicationPlatformModel.SmsTemplateReq} body
+ */
+
+/**
+ * @typedef DeleteEmailTemplateByIdParam
+ * @property {string} id - Email template id
+ */
+
+/**
+ * @typedef DeleteSmsTemplateByIdParam
+ * @property {string} id - Sms template id
+ */
+
+/**
+ * @typedef GetAudienceByIdParam
+ * @property {string} id - Audience 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
+ */
+
+/**
+ * @typedef GetBigqueryHeadersParam
+ * @property {CommunicationPlatformModel.BigqueryHeadersReq} body
+ */
+
+/**
+ * @typedef GetCampaignByIdParam
+ * @property {string} id - Campaign id
+ */
+
+/**
+ * @typedef GetCampaignsParam
+ * @property {number} [pageNo] - Current page no
+ * @property {number} [pageSize] - Current request items count
+ * @property {Object} [sort] - To sort based on created_at
+ */
+
+/**
+ * @typedef GetCommunicationLogsParam
+ * @property {string} [pageId] - Current page no
+ * @property {number} [pageSize] - Current request items count
+ * @property {Object} [sort] - To sort based on _id
+ * @property {Object} [query]
+ */
+
+/**
+ * @typedef GetEmailProviderByIdParam
+ * @property {string} id - Email provider 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
+ */
+
+/**
+ * @typedef GetEmailTemplateByIdParam
+ * @property {string} id - Email template 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
+ */
+
+/**
+ * @typedef GetEventSubscriptionsParam
+ * @property {number} [pageNo] - Current page no
+ * @property {number} [pageSize] - Current request items count
+ * @property {string} [populate] - Populate fields
+ */
+
+/**
+ * @typedef GetJobLogsParam
+ * @property {number} [pageNo] - Current page no
+ * @property {number} [pageSize] - Current request items count
+ * @property {Object} [sort] - To sort based on created_at
+ */
+
+/**
+ * @typedef GetJobsParam
+ * @property {number} [pageNo] - Current page no
+ * @property {number} [pageSize] - Current request items count
+ * @property {Object} [sort] - To sort based on created_at
+ */
+
+/**
+ * @typedef GetNSampleRecordsFromCsvParam
+ * @property {CommunicationPlatformModel.GetNRecordsCsvReq} body
+ */
+
+/**
+ * @typedef GetSmsProviderByIdParam
+ * @property {string} id - Sms provider 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
+ */
+
+/**
+ * @typedef GetSmsTemplateByIdParam
+ * @property {string} id - Sms template 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
+ */
+
+/**
+ * @typedef GetStatsOfCampaignByIdParam
+ * @property {string} id - Campaign id
+ */
+
+/**
+ * @typedef GetSystemEmailTemplatesParam
+ * @property {number} [pageNo] - Current page no
+ * @property {number} [pageSize] - Current request items count
+ * @property {Object} [sort] - To sort based on created_at
+ */
+
+/**
+ * @typedef GetSystemSystemTemplatesParam
+ * @property {number} [pageNo] - Current page no
+ * @property {number} [pageSize] - Current request items count
+ * @property {Object} [sort] - To sort based on created_at
+ */
+
+/**
+ * @typedef SendCommunicationAsynchronouslyParam
+ * @property {CommunicationPlatformModel.EngineRequest} body
+ */
+
+/**
+ * @typedef SendCommunicationSynchronouslyParam
+ * @property {CommunicationPlatformModel.EngineRequest} body
+ */
+
+/**
+ * @typedef SendOtpParam
+ * @property {CommunicationPlatformModel.SendOtpCommsReq} body
+ */
+
+/**
+ * @typedef TriggerCampaignJobParam
+ * @property {CommunicationPlatformModel.TriggerJobRequest} body
+ */
+
+/**
+ * @typedef UpdateAudienceByIdParam
+ * @property {string} id - Audience id
+ * @property {CommunicationPlatformModel.AudienceReq} body
+ */
+
+/**
+ * @typedef UpdateCampaignByIdParam
+ * @property {string} id - Campaign id
+ * @property {CommunicationPlatformModel.CampaignReq} body
+ */
+
+/**
+ * @typedef UpdateEmailProviderByIdParam
+ * @property {string} id - Email provider id
+ * @property {CommunicationPlatformModel.EmailProviderReq} body
+ */
+
+/**
+ * @typedef UpdateEmailTemplateByIdParam
+ * @property {string} id - Email template id
+ * @property {CommunicationPlatformModel.EmailTemplateReq} body
+ */
+
+/**
+ * @typedef UpdateSmsProviderByIdParam
+ * @property {string} id - Sms provider id
+ * @property {CommunicationPlatformModel.SmsProviderReq} body
+ */
+
+/**
+ * @typedef UpdateSmsTemplateByIdParam
+ * @property {string} id - Sms template id
+ * @property {CommunicationPlatformModel.SmsTemplateReq} body
+ */
+
+/**
+ * @typedef VerfiyOtpParam
+ * @property {CommunicationPlatformModel.VerifyOtpCommsReq} body
+ */
+
+class CommunicationPlatformApplicationValidator {
+  /** @returns {CreateAudienceParam} */
   static createAudience() {
     return Joi.object({
-      body: CommunicationModel.AudienceReq().required(),
+      body: CommunicationPlatformModel.AudienceReq().required(),
     }).required();
   }
 
+  /** @returns {CreateCampaignParam} */
   static createCampaign() {
     return Joi.object({
-      body: CommunicationModel.CampaignReq().required(),
+      body: CommunicationPlatformModel.CampaignReq().required(),
     }).required();
   }
 
+  /** @returns {CreateEmailProviderParam} */
   static createEmailProvider() {
     return Joi.object({
-      body: CommunicationModel.EmailProviderReq().required(),
+      body: CommunicationPlatformModel.EmailProviderReq().required(),
     }).required();
   }
 
+  /** @returns {CreateEmailTemplateParam} */
   static createEmailTemplate() {
     return Joi.object({
-      body: CommunicationModel.EmailTemplateReq().required(),
+      body: CommunicationPlatformModel.EmailTemplateReq().required(),
     }).required();
   }
 
+  /** @returns {CreateSmsProviderParam} */
   static createSmsProvider() {
     return Joi.object({
-      body: CommunicationModel.SmsProviderReq().required(),
+      body: CommunicationPlatformModel.SmsProviderReq().required(),
     }).required();
   }
 
+  /** @returns {CreateSmsTemplateParam} */
   static createSmsTemplate() {
     return Joi.object({
-      body: CommunicationModel.SmsTemplateReq().required(),
+      body: CommunicationPlatformModel.SmsTemplateReq().required(),
     }).required();
   }
 
+  /** @returns {DeleteEmailTemplateByIdParam} */
   static deleteEmailTemplateById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {DeleteSmsTemplateByIdParam} */
   static deleteSmsTemplateById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetAudienceByIdParam} */
   static getAudienceById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetAudiencesParam} */
   static getAudiences() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -64,18 +306,21 @@ class CommunicationValidator {
     }).required();
   }
 
+  /** @returns {GetBigqueryHeadersParam} */
   static getBigqueryHeaders() {
     return Joi.object({
-      body: CommunicationModel.BigqueryHeadersReq().required(),
+      body: CommunicationPlatformModel.BigqueryHeadersReq().required(),
     }).required();
   }
 
+  /** @returns {GetCampaignByIdParam} */
   static getCampaignById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetCampaignsParam} */
   static getCampaigns() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -84,6 +329,7 @@ class CommunicationValidator {
     }).required();
   }
 
+  /** @returns {GetCommunicationLogsParam} */
   static getCommunicationLogs() {
     return Joi.object({
       pageId: Joi.string().allow(""),
@@ -93,12 +339,14 @@ class CommunicationValidator {
     }).required();
   }
 
+  /** @returns {GetEmailProviderByIdParam} */
   static getEmailProviderById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetEmailProvidersParam} */
   static getEmailProviders() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -107,12 +355,14 @@ class CommunicationValidator {
     }).required();
   }
 
+  /** @returns {GetEmailTemplateByIdParam} */
   static getEmailTemplateById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetEmailTemplatesParam} */
   static getEmailTemplates() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -121,6 +371,7 @@ class CommunicationValidator {
     }).required();
   }
 
+  /** @returns {GetEventSubscriptionsParam} */
   static getEventSubscriptions() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -129,6 +380,7 @@ class CommunicationValidator {
     }).required();
   }
 
+  /** @returns {GetJobLogsParam} */
   static getJobLogs() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -137,6 +389,7 @@ class CommunicationValidator {
     }).required();
   }
 
+  /** @returns {GetJobsParam} */
   static getJobs() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -145,18 +398,21 @@ class CommunicationValidator {
     }).required();
   }
 
+  /** @returns {GetNSampleRecordsFromCsvParam} */
   static getNSampleRecordsFromCsv() {
     return Joi.object({
-      body: CommunicationModel.GetNRecordsCsvReq().required(),
+      body: CommunicationPlatformModel.GetNRecordsCsvReq().required(),
     }).required();
   }
 
+  /** @returns {GetSmsProviderByIdParam} */
   static getSmsProviderById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetSmsProvidersParam} */
   static getSmsProviders() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -165,12 +421,14 @@ class CommunicationValidator {
     }).required();
   }
 
+  /** @returns {GetSmsTemplateByIdParam} */
   static getSmsTemplateById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetSmsTemplatesParam} */
   static getSmsTemplates() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -179,12 +437,14 @@ class CommunicationValidator {
     }).required();
   }
 
+  /** @returns {GetStatsOfCampaignByIdParam} */
   static getStatsOfCampaignById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetSystemEmailTemplatesParam} */
   static getSystemEmailTemplates() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -193,6 +453,7 @@ class CommunicationValidator {
     }).required();
   }
 
+  /** @returns {GetSystemSystemTemplatesParam} */
   static getSystemSystemTemplates() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -201,77 +462,88 @@ class CommunicationValidator {
     }).required();
   }
 
+  /** @returns {SendCommunicationAsynchronouslyParam} */
   static sendCommunicationAsynchronously() {
     return Joi.object({
-      body: CommunicationModel.EngineRequest().required(),
+      body: CommunicationPlatformModel.EngineRequest().required(),
     }).required();
   }
 
+  /** @returns {SendCommunicationSynchronouslyParam} */
   static sendCommunicationSynchronously() {
     return Joi.object({
-      body: CommunicationModel.EngineRequest().required(),
+      body: CommunicationPlatformModel.EngineRequest().required(),
     }).required();
   }
 
+  /** @returns {SendOtpParam} */
   static sendOtp() {
     return Joi.object({
-      body: CommunicationModel.SendOtpCommsReq().required(),
+      body: CommunicationPlatformModel.SendOtpCommsReq().required(),
     }).required();
   }
 
+  /** @returns {TriggerCampaignJobParam} */
   static triggerCampaignJob() {
     return Joi.object({
-      body: CommunicationModel.TriggerJobRequest().required(),
+      body: CommunicationPlatformModel.TriggerJobRequest().required(),
     }).required();
   }
 
+  /** @returns {UpdateAudienceByIdParam} */
   static updateAudienceById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: CommunicationModel.AudienceReq().required(),
+      body: CommunicationPlatformModel.AudienceReq().required(),
     }).required();
   }
 
+  /** @returns {UpdateCampaignByIdParam} */
   static updateCampaignById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: CommunicationModel.CampaignReq().required(),
+      body: CommunicationPlatformModel.CampaignReq().required(),
     }).required();
   }
 
+  /** @returns {UpdateEmailProviderByIdParam} */
   static updateEmailProviderById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: CommunicationModel.EmailProviderReq().required(),
+      body: CommunicationPlatformModel.EmailProviderReq().required(),
     }).required();
   }
 
+  /** @returns {UpdateEmailTemplateByIdParam} */
   static updateEmailTemplateById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: CommunicationModel.EmailTemplateReq().required(),
+      body: CommunicationPlatformModel.EmailTemplateReq().required(),
     }).required();
   }
 
+  /** @returns {UpdateSmsProviderByIdParam} */
   static updateSmsProviderById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: CommunicationModel.SmsProviderReq().required(),
+      body: CommunicationPlatformModel.SmsProviderReq().required(),
     }).required();
   }
 
+  /** @returns {UpdateSmsTemplateByIdParam} */
   static updateSmsTemplateById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: CommunicationModel.SmsTemplateReq().required(),
+      body: CommunicationPlatformModel.SmsTemplateReq().required(),
     }).required();
   }
 
+  /** @returns {VerfiyOtpParam} */
   static verfiyOtp() {
     return Joi.object({
-      body: CommunicationModel.VerifyOtpCommsReq().required(),
+      body: CommunicationPlatformModel.VerifyOtpCommsReq().required(),
     }).required();
   }
 }
 
-module.exports = CommunicationValidator;
+module.exports = CommunicationPlatformApplicationValidator;

package/sdk/platform/Communication/CommunicationPlatformClient.d.ts

@@ -2,16 +2,29 @@ export = Communication;
 declare class Communication {
     constructor(config: any);
     config: any;
+    /**
+     * @param {CommunicationPlatformValidator.GetSystemNotificationsParam} arg
+     *   - Arg object
+     *
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<CommunicationPlatformModel.SystemNotifications>} -
+     *   Success response
+     * @name getSystemNotifications
+     * @summary: Get system notifications
+     * @description: Get system notifications - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemNotifications/).
+     */
+    getSystemNotifications({ pageNo, pageSize }?: CommunicationPlatformValidator.GetSystemNotificationsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommunicationPlatformModel.SystemNotifications>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {number} [arg.pageNo] -
      * @param {number} [arg.pageSize] -
-     * @returns {Promise<SystemNotifications>} - Success response
+     * @returns {Paginator<CommunicationPlatformModel.SystemNotifications>}
      * @summary: Get system notifications
      * @description: Get system notifications
      */
-    getSystemNotifications({ pageNo, pageSize }?: {
-        pageNo?: number;
+    getSystemNotificationsPaginator({ pageSize }?: {
         pageSize?: number;
-    }): Promise<SystemNotifications>;
+    }): Paginator<CommunicationPlatformModel.SystemNotifications>;
 }
+import CommunicationPlatformValidator = require("./CommunicationPlatformValidator");
+import CommunicationPlatformModel = require("./CommunicationPlatformModel");
+import Paginator = require("../../common/Paginator");