@gofynd/fdk-client-javascript 1.3.6-beta.1 → 1.3.6

package/sdk/platform/Communication/CommunicationPlatformClient.js

@@ -1,5 +1,8 @@
 const PlatformAPIClient = require("../PlatformAPIClient");
-const { FDKClientValidationError } = require("../../common/FDKError");
+const {
+  FDKClientValidationError,
+  FDKResponseValidationError,
+} = require("../../common/FDKError");
 const Paginator = require("../../common/Paginator");
 const CommunicationPlatformValidator = require("./CommunicationPlatformValidator");
 const CommunicationPlatformModel = require("./CommunicationPlatformModel");
@@ -86,10 +89,14 @@ class Communication {
     );
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > Communication > getSystemNotifications \n ${res_error}`,
-      });
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > Communication > getSystemNotifications \n ${res_error}`,
+        });
+      }
     }
 
     return response;

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

@@ -516,6 +516,7 @@ export = CommunicationPlatformModel;
  * @typedef SendOtpCommsReqEmail
  * @property {number} [expiry]
  * @property {number} [otp_length]
+ * @property {SendOtpEmailCommsProvider} [provider]
  * @property {SendOtpEmailCommsTemplate} [template]
  */
 /**
@@ -547,6 +548,11 @@ export = CommunicationPlatformModel;
  * @property {number} [resend_timer]
  * @property {boolean} [success]
  */
+/**
+ * @typedef SendOtpEmailCommsProvider
+ * @property {string} [_id]
+ * @property {string} [slug]
+ */
 /**
  * @typedef SendOtpEmailCommsTemplate
  * @property {string} [key]
@@ -779,7 +785,7 @@ export = CommunicationPlatformModel;
 declare class CommunicationPlatformModel {
 }
 declare namespace CommunicationPlatformModel {
-    export { AppProvider, AppProviderReq, AppProviderRes, AppProviderResObj, AppProviderResVoice, Audience, AudienceReq, Audiences, BadRequestSchema, Campaign, CampaignEmail, CampaignEmailTemplate, CampaignReq, Campaigns, CampignEmailProvider, DefaultSmsProviders, DummyDatasources, DummyDatasourcesMeta, DummyDatasourcesMetaObj, EmailProvider, EmailProviderReq, EmailProviderReqFrom, EmailProviders, EmailTemplate, EmailTemplateHeaders, EmailTemplateKeys, EmailTemplateReq, EmailTemplates, EnabledObj, EngineRequest, EngineResponse, EventSubscription, EventSubscriptions, EventSubscriptionTemplate, EventSubscriptionTemplateEmail, EventSubscriptionTemplateSms, GenericDelete, GenericError, GetNRecordsCsvReq, GetNRecordsCsvRes, GetNRecordsCsvResItems, GetStats, GlobalProviders, GlobalProvidersResObj, GlobalVariablesGetResponse, GlobalVariablesPostResponse, GlobalVariablesReq, Job, JobLog, JobLogs, Jobs, Log, LogEmail, LogMeta, LogPushnotification, Logs, Message, metaObj, MetaStructure, NotFound, Notification, Page, PayloadEmailProviderStructure, PayloadEmailStructure, PayloadEmailTemplateStructure, PayloadSmsProviderStructure, PayloadSmsStructure, PayloadSmsTemplateStructure, PayloadStructure, RecipientHeaders, SendOtpCommsReq, SendOtpCommsReqData, SendOtpCommsReqEmail, SendOtpCommsReqSms, SendOtpCommsRes, SendOtpCommsResEmail, SendOtpCommsResSms, SendOtpEmailCommsTemplate, SendOtpSmsCommsProvider, SendOtpSmsCommsTemplate, SmsProvider, SmsProviderReq, SmsProviders, SmsTemplate, SmsTemplateMessage, SmsTemplateReq, SmsTemplates, Stats, StatsImported, StatsProcessed, StatsProcessedEmail, StatsProcessedSms, SystemEmailTemplate, SystemEmailTemplates, SystemNotification, SystemNotifications, SystemNotificationUser, SystemSmsTemplates, TemplateAndType, TriggerJobRequest, TriggerJobResponse, VerifyOtpCommsErrorRes, VerifyOtpCommsReq, VerifyOtpCommsSuccessRes };
+    export { AppProvider, AppProviderReq, AppProviderRes, AppProviderResObj, AppProviderResVoice, Audience, AudienceReq, Audiences, BadRequestSchema, Campaign, CampaignEmail, CampaignEmailTemplate, CampaignReq, Campaigns, CampignEmailProvider, DefaultSmsProviders, DummyDatasources, DummyDatasourcesMeta, DummyDatasourcesMetaObj, EmailProvider, EmailProviderReq, EmailProviderReqFrom, EmailProviders, EmailTemplate, EmailTemplateHeaders, EmailTemplateKeys, EmailTemplateReq, EmailTemplates, EnabledObj, EngineRequest, EngineResponse, EventSubscription, EventSubscriptions, EventSubscriptionTemplate, EventSubscriptionTemplateEmail, EventSubscriptionTemplateSms, GenericDelete, GenericError, GetNRecordsCsvReq, GetNRecordsCsvRes, GetNRecordsCsvResItems, GetStats, GlobalProviders, GlobalProvidersResObj, GlobalVariablesGetResponse, GlobalVariablesPostResponse, GlobalVariablesReq, Job, JobLog, JobLogs, Jobs, Log, LogEmail, LogMeta, LogPushnotification, Logs, Message, metaObj, MetaStructure, NotFound, Notification, Page, PayloadEmailProviderStructure, PayloadEmailStructure, PayloadEmailTemplateStructure, PayloadSmsProviderStructure, PayloadSmsStructure, PayloadSmsTemplateStructure, PayloadStructure, RecipientHeaders, SendOtpCommsReq, SendOtpCommsReqData, SendOtpCommsReqEmail, SendOtpCommsReqSms, SendOtpCommsRes, SendOtpCommsResEmail, SendOtpCommsResSms, SendOtpEmailCommsProvider, SendOtpEmailCommsTemplate, SendOtpSmsCommsProvider, SendOtpSmsCommsTemplate, SmsProvider, SmsProviderReq, SmsProviders, SmsTemplate, SmsTemplateMessage, SmsTemplateReq, SmsTemplates, Stats, StatsImported, StatsProcessed, StatsProcessedEmail, StatsProcessedSms, SystemEmailTemplate, SystemEmailTemplates, SystemNotification, SystemNotifications, SystemNotificationUser, SystemSmsTemplates, TemplateAndType, TriggerJobRequest, TriggerJobResponse, VerifyOtpCommsErrorRes, VerifyOtpCommsReq, VerifyOtpCommsSuccessRes };
 }
 /** @returns {AppProvider} */
 declare function AppProvider(): AppProvider;
@@ -1380,6 +1386,7 @@ declare function SendOtpCommsReqEmail(): SendOtpCommsReqEmail;
 type SendOtpCommsReqEmail = {
     expiry?: number;
     otp_length?: number;
+    provider?: SendOtpEmailCommsProvider;
     template?: SendOtpEmailCommsTemplate;
 };
 /** @returns {SendOtpCommsReqSms} */
@@ -1415,6 +1422,12 @@ type SendOtpCommsResSms = {
     resend_timer?: number;
     success?: boolean;
 };
+/** @returns {SendOtpEmailCommsProvider} */
+declare function SendOtpEmailCommsProvider(): SendOtpEmailCommsProvider;
+type SendOtpEmailCommsProvider = {
+    _id?: string;
+    slug?: string;
+};
 /** @returns {SendOtpEmailCommsTemplate} */
 declare function SendOtpEmailCommsTemplate(): SendOtpEmailCommsTemplate;
 type SendOtpEmailCommsTemplate = {

package/sdk/platform/Communication/CommunicationPlatformModel.js

@@ -589,6 +589,7 @@ const Joi = require("joi");
  * @typedef SendOtpCommsReqEmail
  * @property {number} [expiry]
  * @property {number} [otp_length]
+ * @property {SendOtpEmailCommsProvider} [provider]
  * @property {SendOtpEmailCommsTemplate} [template]
  */
 
@@ -625,6 +626,12 @@ const Joi = require("joi");
  * @property {boolean} [success]
  */
 
+/**
+ * @typedef SendOtpEmailCommsProvider
+ * @property {string} [_id]
+ * @property {string} [slug]
+ */
+
 /**
  * @typedef SendOtpEmailCommsTemplate
  * @property {string} [key]
@@ -1632,6 +1639,7 @@ class CommunicationPlatformModel {
     return Joi.object({
       expiry: Joi.number(),
       otp_length: Joi.number(),
+      provider: CommunicationPlatformModel.SendOtpEmailCommsProvider(),
       template: CommunicationPlatformModel.SendOtpEmailCommsTemplate(),
     });
   }
@@ -1677,6 +1685,14 @@ class CommunicationPlatformModel {
     });
   }
 
+  /** @returns {SendOtpEmailCommsProvider} */
+  static SendOtpEmailCommsProvider() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      slug: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {SendOtpEmailCommsTemplate} */
   static SendOtpEmailCommsTemplate() {
     return Joi.object({

package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js

@@ -1,5 +1,8 @@
 const PlatformAPIClient = require("../PlatformAPIClient");
-const { FDKClientValidationError } = require("../../common/FDKError");
+const {
+  FDKClientValidationError,
+  FDKResponseValidationError,
+} = require("../../common/FDKError");
 const Paginator = require("../../common/Paginator");
 const CompanyProfilePlatformValidator = require("./CompanyProfilePlatformValidator");
 const CompanyProfilePlatformModel = require("./CompanyProfilePlatformModel");
@@ -75,10 +78,14 @@ class CompanyProfile {
     );
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > CompanyProfile > cbsOnboardGet \n ${res_error}`,
-      });
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > CompanyProfile > cbsOnboardGet \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -151,10 +158,14 @@ class CompanyProfile {
     );
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > CompanyProfile > createBrand \n ${res_error}`,
-      });
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > CompanyProfile > createBrand \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -231,10 +242,14 @@ class CompanyProfile {
     );
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > CompanyProfile > createCompanyBrandMapping \n ${res_error}`,
-      });
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > CompanyProfile > createCompanyBrandMapping \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -307,10 +322,14 @@ class CompanyProfile {
     );
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > CompanyProfile > createLocation \n ${res_error}`,
-      });
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > CompanyProfile > createLocation \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -385,10 +404,14 @@ class CompanyProfile {
     );
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > CompanyProfile > createLocationBulk \n ${res_error}`,
-      });
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > CompanyProfile > createLocationBulk \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -463,10 +486,14 @@ class CompanyProfile {
     );
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > CompanyProfile > editBrand \n ${res_error}`,
-      });
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > CompanyProfile > editBrand \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -540,10 +567,14 @@ class CompanyProfile {
     );
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > CompanyProfile > getBrand \n ${res_error}`,
-      });
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > CompanyProfile > getBrand \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -624,10 +655,14 @@ class CompanyProfile {
     );
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > CompanyProfile > getBrands \n ${res_error}`,
-      });
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > CompanyProfile > getBrands \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -728,10 +763,14 @@ class CompanyProfile {
     });
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > CompanyProfile > getCompanyMetrics \n ${res_error}`,
-      });
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > CompanyProfile > getCompanyMetrics \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -806,10 +845,14 @@ class CompanyProfile {
     );
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > CompanyProfile > getLocationDetail \n ${res_error}`,
-      });
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > CompanyProfile > getLocationDetail \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -881,10 +924,14 @@ class CompanyProfile {
     );
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > CompanyProfile > getLocationTags \n ${res_error}`,
-      });
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > CompanyProfile > getLocationTags \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -975,10 +1022,14 @@ class CompanyProfile {
     );
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > CompanyProfile > getLocations \n ${res_error}`,
-      });
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > CompanyProfile > getLocations \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -1089,10 +1140,14 @@ class CompanyProfile {
     );
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > CompanyProfile > updateCompany \n ${res_error}`,
-      });
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > CompanyProfile > updateCompany \n ${res_error}`,
+        });
+      }
     }
 
     return response;
@@ -1167,10 +1222,14 @@ class CompanyProfile {
     );
 
     if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > CompanyProfile > updateLocation \n ${res_error}`,
-      });
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > CompanyProfile > updateLocation \n ${res_error}`,
+        });
+      }
     }
 
     return response;