@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

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

@@ -1,43 +1,43 @@
 export = CommunicationValidator;
 declare class CommunicationValidator {
-    static getCampaigns(): any;
+    static createAudience(): any;
     static createCampaign(): any;
-    static getCampaignById(): any;
-    static updateCampaignById(): any;
-    static getStatsOfCampaignById(): any;
+    static createEmailProvider(): any;
+    static createEmailTemplate(): any;
+    static createSmsProvider(): any;
+    static createSmsTemplate(): any;
+    static deleteEmailTemplateById(): any;
+    static deleteSmsTemplateById(): any;
+    static getAudienceById(): any;
     static getAudiences(): any;
-    static createAudience(): any;
     static getBigqueryHeaders(): any;
-    static getAudienceById(): any;
-    static updateAudienceById(): any;
-    static getNSampleRecordsFromCsv(): any;
-    static getEmailProviders(): any;
-    static createEmailProvider(): any;
+    static getCampaignById(): any;
+    static getCampaigns(): any;
+    static getCommunicationLogs(): any;
     static getEmailProviderById(): any;
-    static updateEmailProviderById(): any;
-    static getEmailTemplates(): any;
-    static createEmailTemplate(): any;
-    static getSystemEmailTemplates(): any;
+    static getEmailProviders(): any;
     static getEmailTemplateById(): any;
-    static updateEmailTemplateById(): any;
-    static deleteEmailTemplateById(): any;
-    static sendCommunicationSynchronously(): any;
-    static sendCommunicationAsynchronously(): any;
+    static getEmailTemplates(): any;
     static getEventSubscriptions(): any;
-    static getJobs(): any;
-    static triggerCampaignJob(): any;
     static getJobLogs(): any;
-    static getCommunicationLogs(): any;
-    static sendOtp(): any;
-    static verfiyOtp(): any;
-    static getSmsProviders(): any;
-    static createSmsProvider(): any;
+    static getJobs(): any;
+    static getNSampleRecordsFromCsv(): any;
     static getSmsProviderById(): any;
-    static updateSmsProviderById(): any;
-    static getSmsTemplates(): any;
-    static createSmsTemplate(): any;
+    static getSmsProviders(): any;
     static getSmsTemplateById(): any;
-    static updateSmsTemplateById(): any;
-    static deleteSmsTemplateById(): any;
+    static getSmsTemplates(): any;
+    static getStatsOfCampaignById(): any;
+    static getSystemEmailTemplates(): any;
     static getSystemSystemTemplates(): any;
+    static sendCommunicationAsynchronously(): any;
+    static sendCommunicationSynchronously(): any;
+    static sendOtp(): any;
+    static triggerCampaignJob(): any;
+    static updateAudienceById(): any;
+    static updateCampaignById(): any;
+    static updateEmailProviderById(): any;
+    static updateEmailTemplateById(): any;
+    static updateSmsProviderById(): any;
+    static updateSmsTemplateById(): any;
+    static verfiyOtp(): any;
 }

package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js

@@ -2,11 +2,9 @@ const Joi = require("joi");
 const CommunicationModel = require("./CommunicationPlatformModel");
 
 class CommunicationValidator {
-  static getCampaigns() {
+  static createAudience() {
     return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      sort: Joi.any(),
+      body: CommunicationModel.AudienceReq().required(),
     }).required();
   }
 
@@ -16,42 +14,39 @@ class CommunicationValidator {
     }).required();
   }
 
-  static getCampaignById() {
+  static createEmailProvider() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
+      body: CommunicationModel.EmailProviderReq().required(),
     }).required();
   }
 
-  static updateCampaignById() {
+  static createEmailTemplate() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
-      body: CommunicationModel.CampaignReq().required(),
+      body: CommunicationModel.EmailTemplateReq().required(),
     }).required();
   }
 
-  static getStatsOfCampaignById() {
+  static createSmsProvider() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
+      body: CommunicationModel.SmsProviderReq().required(),
     }).required();
   }
 
-  static getAudiences() {
+  static createSmsTemplate() {
     return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      sort: Joi.any(),
+      body: CommunicationModel.SmsTemplateReq().required(),
     }).required();
   }
 
-  static createAudience() {
+  static deleteEmailTemplateById() {
     return Joi.object({
-      body: CommunicationModel.AudienceReq().required(),
+      id: Joi.string().allow("").required(),
     }).required();
   }
 
-  static getBigqueryHeaders() {
+  static deleteSmsTemplateById() {
     return Joi.object({
-      body: CommunicationModel.BigqueryHeadersReq().required(),
+      id: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -61,20 +56,27 @@ class CommunicationValidator {
     }).required();
   }
 
-  static updateAudienceById() {
+  static getAudiences() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
-      body: CommunicationModel.AudienceReq().required(),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      sort: Joi.any(),
     }).required();
   }
 
-  static getNSampleRecordsFromCsv() {
+  static getBigqueryHeaders() {
     return Joi.object({
-      body: CommunicationModel.GetNRecordsCsvReq().required(),
+      body: CommunicationModel.BigqueryHeadersReq().required(),
     }).required();
   }
 
-  static getEmailProviders() {
+  static getCampaignById() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static getCampaigns() {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
@@ -82,9 +84,12 @@ class CommunicationValidator {
     }).required();
   }
 
-  static createEmailProvider() {
+  static getCommunicationLogs() {
     return Joi.object({
-      body: CommunicationModel.EmailProviderReq().required(),
+      pageId: Joi.string().allow(""),
+      pageSize: Joi.number(),
+      sort: Joi.any(),
+      query: Joi.any(),
     }).required();
   }
 
@@ -94,10 +99,17 @@ class CommunicationValidator {
     }).required();
   }
 
-  static updateEmailProviderById() {
+  static getEmailProviders() {
+    return Joi.object({
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      sort: Joi.any(),
+    }).required();
+  }
+
+  static getEmailTemplateById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: CommunicationModel.EmailProviderReq().required(),
     }).required();
   }
 
@@ -109,13 +121,15 @@ class CommunicationValidator {
     }).required();
   }
 
-  static createEmailTemplate() {
+  static getEventSubscriptions() {
     return Joi.object({
-      body: CommunicationModel.EmailTemplateReq().required(),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      populate: Joi.string().allow(""),
     }).required();
   }
 
-  static getSystemEmailTemplates() {
+  static getJobLogs() {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
@@ -123,46 +137,41 @@ class CommunicationValidator {
     }).required();
   }
 
-  static getEmailTemplateById() {
+  static getJobs() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      sort: Joi.any(),
     }).required();
   }
 
-  static updateEmailTemplateById() {
+  static getNSampleRecordsFromCsv() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
-      body: CommunicationModel.EmailTemplateReq().required(),
+      body: CommunicationModel.GetNRecordsCsvReq().required(),
     }).required();
   }
 
-  static deleteEmailTemplateById() {
+  static getSmsProviderById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
-  static sendCommunicationSynchronously() {
-    return Joi.object({
-      body: CommunicationModel.EngineRequest().required(),
-    }).required();
-  }
-
-  static sendCommunicationAsynchronously() {
+  static getSmsProviders() {
     return Joi.object({
-      body: CommunicationModel.EngineRequest().required(),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      sort: Joi.any(),
     }).required();
   }
 
-  static getEventSubscriptions() {
+  static getSmsTemplateById() {
     return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      populate: Joi.string().allow(""),
+      id: Joi.string().allow("").required(),
     }).required();
   }
 
-  static getJobs() {
+  static getSmsTemplates() {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
@@ -170,13 +179,13 @@ class CommunicationValidator {
     }).required();
   }
 
-  static triggerCampaignJob() {
+  static getStatsOfCampaignById() {
     return Joi.object({
-      body: CommunicationModel.TriggerJobRequest().required(),
+      id: Joi.string().allow("").required(),
     }).required();
   }
 
-  static getJobLogs() {
+  static getSystemEmailTemplates() {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
@@ -184,71 +193,70 @@ class CommunicationValidator {
     }).required();
   }
 
-  static getCommunicationLogs() {
+  static getSystemSystemTemplates() {
     return Joi.object({
-      pageId: Joi.string().allow(""),
+      pageNo: Joi.number(),
       pageSize: Joi.number(),
       sort: Joi.any(),
-      query: Joi.any(),
     }).required();
   }
 
-  static sendOtp() {
+  static sendCommunicationAsynchronously() {
     return Joi.object({
-      body: CommunicationModel.SendOtpCommsReq().required(),
+      body: CommunicationModel.EngineRequest().required(),
     }).required();
   }
 
-  static verfiyOtp() {
+  static sendCommunicationSynchronously() {
     return Joi.object({
-      body: CommunicationModel.VerifyOtpCommsReq().required(),
+      body: CommunicationModel.EngineRequest().required(),
     }).required();
   }
 
-  static getSmsProviders() {
+  static sendOtp() {
     return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      sort: Joi.any(),
+      body: CommunicationModel.SendOtpCommsReq().required(),
     }).required();
   }
 
-  static createSmsProvider() {
+  static triggerCampaignJob() {
     return Joi.object({
-      body: CommunicationModel.SmsProviderReq().required(),
+      body: CommunicationModel.TriggerJobRequest().required(),
     }).required();
   }
 
-  static getSmsProviderById() {
+  static updateAudienceById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
+      body: CommunicationModel.AudienceReq().required(),
     }).required();
   }
 
-  static updateSmsProviderById() {
+  static updateCampaignById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: CommunicationModel.SmsProviderReq().required(),
+      body: CommunicationModel.CampaignReq().required(),
     }).required();
   }
 
-  static getSmsTemplates() {
+  static updateEmailProviderById() {
     return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      sort: Joi.any(),
+      id: Joi.string().allow("").required(),
+      body: CommunicationModel.EmailProviderReq().required(),
     }).required();
   }
 
-  static createSmsTemplate() {
+  static updateEmailTemplateById() {
     return Joi.object({
-      body: CommunicationModel.SmsTemplateReq().required(),
+      id: Joi.string().allow("").required(),
+      body: CommunicationModel.EmailTemplateReq().required(),
     }).required();
   }
 
-  static getSmsTemplateById() {
+  static updateSmsProviderById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
+      body: CommunicationModel.SmsProviderReq().required(),
     }).required();
   }
 
@@ -259,17 +267,9 @@ class CommunicationValidator {
     }).required();
   }
 
-  static deleteSmsTemplateById() {
-    return Joi.object({
-      id: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  static getSystemSystemTemplates() {
+  static verfiyOtp() {
     return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      sort: Joi.any(),
+      body: CommunicationModel.VerifyOtpCommsReq().required(),
     }).required();
   }
 }

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

@@ -6,13 +6,14 @@ declare class Communication {
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] -
      * @param {number} [arg.pageSize] -
+     * @returns {Promise<SystemNotifications>} - Success response
      * @summary: Get system notifications
      * @description: Get system notifications
      */
     getSystemNotifications({ pageNo, pageSize }?: {
         pageNo?: number;
         pageSize?: number;
-    }): Promise<any>;
+    }): Promise<SystemNotifications>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] -

package/sdk/platform/Communication/CommunicationPlatformClient.js

@@ -2,6 +2,9 @@ const Paginator = require("../../common/Paginator");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const CommunicationValidator = require("./CommunicationPlatformValidator");
+const CommunicationModel = require("./CommunicationPlatformModel");
+const { Logger } = require("./../../common/Logger");
+
 class Communication {
   constructor(config) {
     this.config = config;
@@ -11,10 +14,11 @@ class Communication {
    * @param {Object} arg - Arg object.
    * @param {number} [arg.pageNo] -
    * @param {number} [arg.pageSize] -
+   * @returns {Promise<SystemNotifications>} - Success response
    * @summary: Get system notifications
    * @description: Get system notifications
    */
-  getSystemNotifications({ pageNo, pageSize } = {}) {
+  async getSystemNotifications({ pageNo, pageSize } = {}) {
     const { error } = CommunicationValidator.getSystemNotifications().validate(
       {
         pageNo,
@@ -37,8 +41,11 @@ class Communication {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getSystemNotifications");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getSystemNotifications",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -47,7 +54,7 @@ class Communication {
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/communication/v1.0/company/${this.config.companyId}/notification/system-notifications/`,
@@ -55,6 +62,23 @@ class Communication {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = CommunicationModel.SystemNotifications().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getSystemNotifications",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**

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

@@ -1,102 +1,102 @@
 export = CommunicationModel;
 declare class CommunicationModel {
-    static StatsImported(): any;
-    static StatsProcessedEmail(): any;
-    static StatsProcessedSms(): any;
-    static StatsProcessed(): any;
-    static Stats(): any;
-    static GetStats(): any;
-    static CampaignReq(): any;
-    static RecipientHeaders(): any;
-    static CampaignEmailTemplate(): any;
-    static CampignEmailProvider(): any;
-    static CampaignEmail(): any;
-    static Campaign(): any;
-    static Campaigns(): any;
+    static Audience(): any;
+    static AudienceReq(): any;
+    static Audiences(): any;
     static BadRequestSchema(): any;
-    static NotFound(): any;
     static BigqueryHeadersReq(): any;
-    static BigqueryHeadersResHeaders(): any;
     static BigqueryHeadersRes(): any;
-    static GetNRecordsCsvReq(): any;
-    static GetNRecordsCsvResItems(): any;
-    static GetNRecordsCsvRes(): any;
-    static AudienceReq(): any;
-    static Audience(): any;
-    static Audiences(): any;
-    static EmailProviderReqFrom(): any;
-    static EmailProviderReq(): any;
+    static BigqueryHeadersResHeaders(): any;
+    static Campaign(): any;
+    static CampaignEmail(): any;
+    static CampaignEmailTemplate(): any;
+    static CampaignReq(): any;
+    static Campaigns(): any;
+    static CampignEmailProvider(): any;
     static EmailProvider(): any;
+    static EmailProviderReq(): any;
+    static EmailProviderReqFrom(): any;
     static EmailProviders(): any;
-    static EmailTemplateDeleteSuccessRes(): any;
+    static EmailTemplate(): any;
     static EmailTemplateDeleteFailureRes(): any;
-    static EmailTemplateKeys(): any;
+    static EmailTemplateDeleteSuccessRes(): any;
     static EmailTemplateHeaders(): any;
+    static EmailTemplateKeys(): any;
     static EmailTemplateReq(): any;
-    static TemplateAndType(): any;
     static EmailTemplateRes(): any;
-    static EmailTemplate(): any;
-    static SystemEmailTemplate(): any;
     static EmailTemplates(): any;
-    static SystemEmailTemplates(): any;
-    static PayloadEmailTemplateStructure(): any;
-    static PayloadEmailProviderStructure(): any;
-    static PayloadEmailStructure(): any;
-    static PayloadSmsTemplateStructure(): any;
-    static PayloadSmsProviderStructure(): any;
-    static PayloadSmsStructure(): any;
-    static PayloadStructure(): any;
-    static MetaStructure(): any;
     static EngineRequest(): any;
     static EngineResponse(): any;
-    static EventSubscriptionTemplateSms(): any;
-    static EventSubscriptionTemplateEmail(): any;
-    static EventSubscriptionTemplate(): any;
     static EventSubscription(): any;
     static EventSubscriptions(): any;
-    static TriggerJobResponse(): any;
-    static TriggerJobRequest(): any;
+    static EventSubscriptionTemplate(): any;
+    static EventSubscriptionTemplateEmail(): any;
+    static EventSubscriptionTemplateSms(): any;
+    static GetNRecordsCsvReq(): any;
+    static GetNRecordsCsvRes(): any;
+    static GetNRecordsCsvResItems(): any;
+    static GetStats(): any;
     static Job(): any;
-    static Jobs(): any;
     static JobLog(): any;
     static JobLogs(): any;
+    static Jobs(): any;
+    static Log(): any;
     static LogEmail(): any;
-    static LogPushnotification(): any;
     static LogMeta(): any;
-    static Log(): any;
+    static LogPushnotification(): any;
     static Logs(): any;
-    static SendOtpSmsCommsTemplate(): any;
-    static SendOtpSmsCommsProvider(): any;
-    static SendOtpEmailCommsTemplate(): any;
+    static MetaStructure(): any;
+    static NotFound(): any;
+    static Notification(): any;
+    static Page(): any;
+    static PayloadEmailProviderStructure(): any;
+    static PayloadEmailStructure(): any;
+    static PayloadEmailTemplateStructure(): any;
+    static PayloadSmsProviderStructure(): any;
+    static PayloadSmsStructure(): any;
+    static PayloadSmsTemplateStructure(): any;
+    static PayloadStructure(): any;
+    static PushtokenReq(): any;
+    static PushtokenRes(): any;
+    static RecipientHeaders(): any;
+    static SendOtpCommsReq(): any;
     static SendOtpCommsReqData(): any;
-    static SendOtpCommsReqSms(): any;
     static SendOtpCommsReqEmail(): any;
-    static SendOtpCommsResSms(): any;
-    static SendOtpCommsResEmail(): any;
-    static SendOtpCommsReq(): any;
+    static SendOtpCommsReqSms(): any;
     static SendOtpCommsRes(): any;
-    static VerifyOtpCommsReq(): any;
-    static VerifyOtpCommsSuccessRes(): any;
-    static VerifyOtpCommsErrorRes(): any;
-    static PushtokenReq(): any;
-    static PushtokenRes(): any;
-    static SmsProviderReq(): any;
+    static SendOtpCommsResEmail(): any;
+    static SendOtpCommsResSms(): any;
+    static SendOtpEmailCommsTemplate(): any;
+    static SendOtpSmsCommsProvider(): any;
+    static SendOtpSmsCommsTemplate(): any;
     static SmsProvider(): any;
+    static SmsProviderReq(): any;
     static SmsProviders(): any;
-    static SmsTemplateDeleteSuccessRes(): any;
+    static SmsTemplate(): any;
     static SmsTemplateDeleteFailureRes(): any;
+    static SmsTemplateDeleteSuccessRes(): any;
     static SmsTemplateMessage(): any;
     static SmsTemplateReq(): any;
     static SmsTemplateRes(): any;
-    static SmsTemplate(): any;
-    static SystemSmsTemplate(): any;
     static SmsTemplates(): any;
-    static SystemSmsTemplates(): any;
-    static Notification(): any;
-    static SystemNotificationUser(): any;
-    static SystemNotificationSettings(): any;
+    static Stats(): any;
+    static StatsImported(): any;
+    static StatsProcessed(): any;
+    static StatsProcessedEmail(): any;
+    static StatsProcessedSms(): any;
+    static SystemEmailTemplate(): any;
+    static SystemEmailTemplates(): any;
     static SystemNotification(): any;
-    static SystemNotificationsPage(): any;
     static SystemNotifications(): any;
-    static Page(): any;
+    static SystemNotificationSettings(): any;
+    static SystemNotificationsPage(): any;
+    static SystemNotificationUser(): any;
+    static SystemSmsTemplate(): any;
+    static SystemSmsTemplates(): any;
+    static TemplateAndType(): any;
+    static TriggerJobRequest(): any;
+    static TriggerJobResponse(): any;
+    static VerifyOtpCommsErrorRes(): any;
+    static VerifyOtpCommsReq(): any;
+    static VerifyOtpCommsSuccessRes(): any;
 }