@gofynd/fdk-client-javascript 1.4.15-beta.13 → 1.4.15-beta.15

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

@@ -3,9 +3,6 @@ export = CommunicationPlatformApplicationValidator;
  * @typedef CreateAudienceParam
  * @property {CommunicationPlatformModel.AudienceReq} body
  */
-/** @typedef CreateBigQueryHeadersParam */
-/** @typedef CreateBigQueryNCountParam */
-/** @typedef CreateBigQueryRowCountParam */
 /**
  * @typedef CreateCampaignParam
  * @property {CommunicationPlatformModel.CampaignReq} body
@@ -24,7 +21,7 @@ export = CommunicationPlatformApplicationValidator;
  */
 /**
  * @typedef CreateEventSubscriptionsByBulkParam
- * @property {CommunicationPlatformModel.EventSubscriptionsBulkUpdateRequest} body
+ * @property {CommunicationPlatformModel.EventSubscriptionsBulkUpdatePayload} body
  */
 /**
  * @typedef CreateJobsParam
@@ -80,14 +77,6 @@ export = CommunicationPlatformApplicationValidator;
  * @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 - Campaign id
@@ -139,6 +128,15 @@ export = CommunicationPlatformApplicationValidator;
  * @property {number} [pageNo] - Current page no
  * @property {number} [pageSize] - Current request items count
  * @property {string} [populate] - Populate Fields
+ * @property {string} [group] - An event group is a collection of email and SMS
+ *   templates. Filtering by event group lets you view or manage all related
+ *   communication templates together.
+ * @property {string} [subGroup] - Filter by event subgroup. Here, a subgroup is
+ *   a subset within a group, containing specific email and SMS templates for
+ *   more detailed organization.
+ * @property {string} [fulfillmentOptionSlug] - Filter by fulfillment option
+ *   slug. Indicates the delivery choice selected, e.g., standard-delivery or
+ *   homedelivery.
  */
 /**
  * @typedef GetEventSubscriptionsByIdParam
@@ -205,7 +203,6 @@ export = CommunicationPlatformApplicationValidator;
  * @property {number} [pageSize] - Current request items count
  * @property {Object} [query] - To search based on plain text
  */
-/** @typedef GetSystemAudiencesParam */
 /** @typedef GetSystemEmailTemplatesParam */
 /** @typedef GetSystemSmsTemplatesParam */
 /**
@@ -214,11 +211,11 @@ export = CommunicationPlatformApplicationValidator;
  */
 /**
  * @typedef SendCommunicationAsynchronouslyParam
- * @property {CommunicationPlatformModel.EngineRequest} body
+ * @property {CommunicationPlatformModel.EnginePayload} body
  */
 /**
  * @typedef SendCommunicationSynchronouslyParam
- * @property {CommunicationPlatformModel.EngineRequest} body
+ * @property {CommunicationPlatformModel.EnginePayload} body
  */
 /**
  * @typedef SendOtpParam
@@ -226,7 +223,7 @@ export = CommunicationPlatformApplicationValidator;
  */
 /**
  * @typedef TriggerCampaignJobParam
- * @property {CommunicationPlatformModel.TriggerJobRequest} body
+ * @property {CommunicationPlatformModel.TriggerJobPayload} body
  */
 /**
  * @typedef UpdateAppProvidersParam
@@ -270,12 +267,6 @@ export = CommunicationPlatformApplicationValidator;
 declare class CommunicationPlatformApplicationValidator {
     /** @returns {CreateAudienceParam} */
     static createAudience(): CreateAudienceParam;
-    /** @returns {CreateBigQueryHeadersParam} */
-    static createBigQueryHeaders(): any;
-    /** @returns {CreateBigQueryNCountParam} */
-    static createBigQueryNCount(): any;
-    /** @returns {CreateBigQueryRowCountParam} */
-    static createBigQueryRowCount(): any;
     /** @returns {CreateCampaignParam} */
     static createCampaign(): CreateCampaignParam;
     /** @returns {CreateEmailProviderParam} */
@@ -312,10 +303,6 @@ declare class CommunicationPlatformApplicationValidator {
     static getAudienceById(): GetAudienceByIdParam;
     /** @returns {GetAudiencesParam} */
     static getAudiences(): GetAudiencesParam;
-    /** @returns {GetBigQueryHeadersByIdParam} */
-    static getBigQueryHeadersById(): GetBigQueryHeadersByIdParam;
-    /** @returns {GetBigQueryRowCountByIdParam} */
-    static getBigQueryRowCountById(): GetBigQueryRowCountByIdParam;
     /** @returns {GetCampaignByIdParam} */
     static getCampaignById(): GetCampaignByIdParam;
     /** @returns {GetCampaignsParam} */
@@ -368,8 +355,6 @@ declare class CommunicationPlatformApplicationValidator {
     static getSubscribedEmailTemplates(): GetSubscribedEmailTemplatesParam;
     /** @returns {GetSubscribedSmsTemplatesParam} */
     static getSubscribedSmsTemplates(): GetSubscribedSmsTemplatesParam;
-    /** @returns {GetSystemAudiencesParam} */
-    static getSystemAudiences(): any;
     /** @returns {GetSystemEmailTemplatesParam} */
     static getSystemEmailTemplates(): any;
     /** @returns {GetSystemSmsTemplatesParam} */
@@ -404,7 +389,7 @@ declare class CommunicationPlatformApplicationValidator {
     static verfiyOtp(): VerfiyOtpParam;
 }
 declare namespace CommunicationPlatformApplicationValidator {
-    export { CreateAudienceParam, CreateBigQueryHeadersParam, CreateBigQueryNCountParam, CreateBigQueryRowCountParam, CreateCampaignParam, CreateEmailProviderParam, CreateEmailTemplateParam, CreateEventSubscriptionsParam, CreateEventSubscriptionsByBulkParam, CreateJobsParam, CreateSmsProviderParam, CreateSmsTemplateParam, DeleteAudienceByIdParam, DeleteEmailProviderByIdParam, DeleteEmailTemplateByIdParam, DeleteEventSubscriptionsByIdParam, DeleteSmsProviderByIdParam, DeleteSmsTemplateByIdParam, EditEventSubscriptionsParam, GetAppProvidersParam, GetAudienceByIdParam, GetAudiencesParam, GetBigQueryHeadersByIdParam, GetBigQueryRowCountByIdParam, GetCampaignByIdParam, GetCampaignsParam, GetCommunicationLogsParam, GetDefaultSmsProvidersParam, GetDummyDatasourcesParam, GetDummyDatasourcesMetaParam, GetEmailProviderByIdParam, GetEmailProvidersParam, GetEmailTemplateByIdParam, GetEmailTemplatesParam, GetEventSubscriptionsParam, GetEventSubscriptionsByIdParam, GetGlobalProvidersParam, GetGlobalVariablesParam, GetJobLogsParam, GetJobsParam, GetNSampleRecordsFromCsvParam, GetNSampleRecordsFromCsvByGetParam, GetOtpConfigurationParam, GetSmsProviderByIdParam, GetSmsProvidersParam, GetSmsTemplateByIdParam, GetSmsTemplatesParam, GetStatsOfCampaignByIdParam, GetSubscribedEmailTemplatesParam, GetSubscribedSmsTemplatesParam, GetSystemAudiencesParam, GetSystemEmailTemplatesParam, GetSystemSmsTemplatesParam, PostGlobalVariablesParam, SendCommunicationAsynchronouslyParam, SendCommunicationSynchronouslyParam, SendOtpParam, TriggerCampaignJobParam, UpdateAppProvidersParam, UpdateAudienceByIdParam, UpdateCampaignByIdParam, UpdateEmailProviderByIdParam, UpdateEmailTemplateByIdParam, UpdateOtpConfigurationParam, UpdateSmsProviderByIdParam, UpdateSmsTemplateByIdParam, VerfiyOtpParam };
+    export { CreateAudienceParam, CreateCampaignParam, CreateEmailProviderParam, CreateEmailTemplateParam, CreateEventSubscriptionsParam, CreateEventSubscriptionsByBulkParam, CreateJobsParam, CreateSmsProviderParam, CreateSmsTemplateParam, DeleteAudienceByIdParam, DeleteEmailProviderByIdParam, DeleteEmailTemplateByIdParam, DeleteEventSubscriptionsByIdParam, DeleteSmsProviderByIdParam, DeleteSmsTemplateByIdParam, EditEventSubscriptionsParam, GetAppProvidersParam, GetAudienceByIdParam, GetAudiencesParam, GetCampaignByIdParam, GetCampaignsParam, GetCommunicationLogsParam, GetDefaultSmsProvidersParam, GetDummyDatasourcesParam, GetDummyDatasourcesMetaParam, GetEmailProviderByIdParam, GetEmailProvidersParam, GetEmailTemplateByIdParam, GetEmailTemplatesParam, GetEventSubscriptionsParam, GetEventSubscriptionsByIdParam, GetGlobalProvidersParam, GetGlobalVariablesParam, GetJobLogsParam, GetJobsParam, GetNSampleRecordsFromCsvParam, GetNSampleRecordsFromCsvByGetParam, GetOtpConfigurationParam, GetSmsProviderByIdParam, GetSmsProvidersParam, GetSmsTemplateByIdParam, GetSmsTemplatesParam, GetStatsOfCampaignByIdParam, GetSubscribedEmailTemplatesParam, GetSubscribedSmsTemplatesParam, GetSystemEmailTemplatesParam, GetSystemSmsTemplatesParam, PostGlobalVariablesParam, SendCommunicationAsynchronouslyParam, SendCommunicationSynchronouslyParam, SendOtpParam, TriggerCampaignJobParam, UpdateAppProvidersParam, UpdateAudienceByIdParam, UpdateCampaignByIdParam, UpdateEmailProviderByIdParam, UpdateEmailTemplateByIdParam, UpdateOtpConfigurationParam, UpdateSmsProviderByIdParam, UpdateSmsTemplateByIdParam, VerfiyOtpParam };
 }
 type CreateAudienceParam = {
     body: CommunicationPlatformModel.AudienceReq;
@@ -422,7 +407,7 @@ type CreateEventSubscriptionsParam = {
     body: CommunicationPlatformModel.SubscriptionsObject;
 };
 type CreateEventSubscriptionsByBulkParam = {
-    body: CommunicationPlatformModel.EventSubscriptionsBulkUpdateRequest;
+    body: CommunicationPlatformModel.EventSubscriptionsBulkUpdatePayload;
 };
 type CreateJobsParam = {
     body: CommunicationPlatformModel.CreateJobsReq;
@@ -501,18 +486,6 @@ type GetAudiencesParam = {
      */
     query?: any;
 };
-type GetBigQueryHeadersByIdParam = {
-    /**
-     * - Audience id
-     */
-    id: string;
-};
-type GetBigQueryRowCountByIdParam = {
-    /**
-     * - Audience id
-     */
-    id: string;
-};
 type GetCampaignByIdParam = {
     /**
      * - Campaign id
@@ -619,6 +592,24 @@ type GetEventSubscriptionsParam = {
      * - Populate Fields
      */
     populate?: string;
+    /**
+     * - An event group is a collection of email and SMS
+     * templates. Filtering by event group lets you view or manage all related
+     * communication templates together.
+     */
+    group?: string;
+    /**
+     * - Filter by event subgroup. Here, a subgroup is
+     * a subset within a group, containing specific email and SMS templates for
+     * more detailed organization.
+     */
+    subGroup?: string;
+    /**
+     * - Filter by fulfillment option
+     * slug. Indicates the delivery choice selected, e.g., standard-delivery or
+     * homedelivery.
+     */
+    fulfillmentOptionSlug?: string;
 };
 type GetEventSubscriptionsByIdParam = {
     /**
@@ -755,16 +746,16 @@ type PostGlobalVariablesParam = {
     body: CommunicationPlatformModel.GlobalVariablesReq;
 };
 type SendCommunicationAsynchronouslyParam = {
-    body: CommunicationPlatformModel.EngineRequest;
+    body: CommunicationPlatformModel.EnginePayload;
 };
 type SendCommunicationSynchronouslyParam = {
-    body: CommunicationPlatformModel.EngineRequest;
+    body: CommunicationPlatformModel.EnginePayload;
 };
 type SendOtpParam = {
     body: CommunicationPlatformModel.SendOtpCommsReq;
 };
 type TriggerCampaignJobParam = {
-    body: CommunicationPlatformModel.TriggerJobRequest;
+    body: CommunicationPlatformModel.TriggerJobPayload;
 };
 type UpdateAppProvidersParam = {
     body: CommunicationPlatformModel.AppProviderReq;
@@ -814,9 +805,6 @@ type UpdateSmsTemplateByIdParam = {
 type VerfiyOtpParam = {
     body: CommunicationPlatformModel.VerifyOtpCommsReq;
 };
-type CreateBigQueryHeadersParam = any;
-type CreateBigQueryNCountParam = any;
-type CreateBigQueryRowCountParam = any;
 type GetAppProvidersParam = any;
 type GetDefaultSmsProvidersParam = any;
 type GetDummyDatasourcesParam = any;
@@ -824,7 +812,6 @@ type GetGlobalProvidersParam = any;
 type GetGlobalVariablesParam = any;
 type GetNSampleRecordsFromCsvByGetParam = any;
 type GetOtpConfigurationParam = any;
-type GetSystemAudiencesParam = any;
 type GetSystemEmailTemplatesParam = any;
 type GetSystemSmsTemplatesParam = any;
 type UpdateOtpConfigurationParam = any;

package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js

@@ -7,12 +7,6 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
  * @property {CommunicationPlatformModel.AudienceReq} body
  */
 
-/** @typedef CreateBigQueryHeadersParam */
-
-/** @typedef CreateBigQueryNCountParam */
-
-/** @typedef CreateBigQueryRowCountParam */
-
 /**
  * @typedef CreateCampaignParam
  * @property {CommunicationPlatformModel.CampaignReq} body
@@ -35,7 +29,7 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
 
 /**
  * @typedef CreateEventSubscriptionsByBulkParam
- * @property {CommunicationPlatformModel.EventSubscriptionsBulkUpdateRequest} body
+ * @property {CommunicationPlatformModel.EventSubscriptionsBulkUpdatePayload} body
  */
 
 /**
@@ -105,16 +99,6 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
  * @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 - Campaign id
@@ -176,6 +160,15 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
  * @property {number} [pageNo] - Current page no
  * @property {number} [pageSize] - Current request items count
  * @property {string} [populate] - Populate Fields
+ * @property {string} [group] - An event group is a collection of email and SMS
+ *   templates. Filtering by event group lets you view or manage all related
+ *   communication templates together.
+ * @property {string} [subGroup] - Filter by event subgroup. Here, a subgroup is
+ *   a subset within a group, containing specific email and SMS templates for
+ *   more detailed organization.
+ * @property {string} [fulfillmentOptionSlug] - Filter by fulfillment option
+ *   slug. Indicates the delivery choice selected, e.g., standard-delivery or
+ *   homedelivery.
  */
 
 /**
@@ -258,8 +251,6 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
  * @property {Object} [query] - To search based on plain text
  */
 
-/** @typedef GetSystemAudiencesParam */
-
 /** @typedef GetSystemEmailTemplatesParam */
 
 /** @typedef GetSystemSmsTemplatesParam */
@@ -271,12 +262,12 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
 
 /**
  * @typedef SendCommunicationAsynchronouslyParam
- * @property {CommunicationPlatformModel.EngineRequest} body
+ * @property {CommunicationPlatformModel.EnginePayload} body
  */
 
 /**
  * @typedef SendCommunicationSynchronouslyParam
- * @property {CommunicationPlatformModel.EngineRequest} body
+ * @property {CommunicationPlatformModel.EnginePayload} body
  */
 
 /**
@@ -286,7 +277,7 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
 
 /**
  * @typedef TriggerCampaignJobParam
- * @property {CommunicationPlatformModel.TriggerJobRequest} body
+ * @property {CommunicationPlatformModel.TriggerJobPayload} body
  */
 
 /**
@@ -345,21 +336,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 +367,7 @@ class CommunicationPlatformApplicationValidator {
   /** @returns {CreateEventSubscriptionsByBulkParam} */
   static createEventSubscriptionsByBulk() {
     return Joi.object({
-      body: CommunicationPlatformModel.EventSubscriptionsBulkUpdateRequest().required(),
+      body: CommunicationPlatformModel.EventSubscriptionsBulkUpdatePayload().required(),
     }).required();
   }
 
@@ -489,20 +465,6 @@ class CommunicationPlatformApplicationValidator {
     }).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();
-  }
-
   /** @returns {GetCampaignByIdParam} */
   static getCampaignById() {
     return Joi.object({
@@ -587,6 +549,9 @@ class CommunicationPlatformApplicationValidator {
       pageNo: Joi.number(),
       pageSize: Joi.number(),
       populate: Joi.string().allow(""),
+      group: Joi.string().allow(""),
+      subGroup: Joi.string().allow(""),
+      fulfillmentOptionSlug: Joi.string().allow(""),
     }).required();
   }
 
@@ -704,11 +669,6 @@ class CommunicationPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {GetSystemAudiencesParam} */
-  static getSystemAudiences() {
-    return Joi.object({}).required();
-  }
-
   /** @returns {GetSystemEmailTemplatesParam} */
   static getSystemEmailTemplates() {
     return Joi.object({}).required();
@@ -729,14 +689,14 @@ 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(),
+      body: CommunicationPlatformModel.EnginePayload().required(),
     }).required();
   }
 
@@ -750,7 +710,7 @@ class CommunicationPlatformApplicationValidator {
   /** @returns {TriggerCampaignJobParam} */
   static triggerCampaignJob() {
     return Joi.object({
-      body: CommunicationPlatformModel.TriggerJobRequest().required(),
+      body: CommunicationPlatformModel.TriggerJobPayload().required(),
     }).required();
   }
 

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

@@ -12,7 +12,7 @@ declare class Communication {
      *   Success response
      * @name getSystemNotifications
      * @summary: Get system notifications
-     * @description: Retrieves a list of system notifications. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemNotifications/).
+     * @description: Retrieves a list of system notifications. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSystemNotifications/).
      */
     getSystemNotifications({ pageNo, pageSize, requestHeaders }?: CommunicationPlatformValidator.GetSystemNotificationsParam, { responseHeaders }?: object): Promise<CommunicationPlatformModel.SystemNotifications>;
 }

package/sdk/platform/Communication/CommunicationPlatformClient.js

@@ -24,7 +24,7 @@ class Communication {
    *   Success response
    * @name getSystemNotifications
    * @summary: Get system notifications
-   * @description: Retrieves a list of system notifications. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/communication/getSystemNotifications/).
+   * @description: Retrieves a list of system notifications. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSystemNotifications/).
    */
   async getSystemNotifications(
     { pageNo, pageSize, requestHeaders } = { requestHeaders: {} },