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

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

@@ -229,8 +229,8 @@ export = CommunicationPlatformModel;
 /**
  * @typedef Stats
  * @property {string} [_id]
- * @property {Object} [imported]
- * @property {Object} [processed]
+ * @property {StatsImported} [imported]
+ * @property {StatsProcessed} [processed]
  */
 /**
  * @typedef GetStats
@@ -510,12 +510,12 @@ export = CommunicationPlatformModel;
 /**
  * @typedef EventSubscriptionTemplateSms
  * @property {boolean} [subscribed]
- * @property {Object} [template]
+ * @property {string} [template]
  */
 /**
  * @typedef EventSubscriptionTemplateEmail
  * @property {boolean} [subscribed]
- * @property {Object} [template]
+ * @property {string} [template]
  */
 /**
  * @typedef EventSubscriptionTemplatePushnotification
@@ -540,9 +540,38 @@ export = CommunicationPlatformModel;
  * @property {string} [updated_at]
  * @property {number} [__v]
  */
+/**
+ * @typedef EventSubscriptionTemplateSmsObj
+ * @property {boolean} [subscribed]
+ * @property {Object} [template]
+ */
+/**
+ * @typedef EventSubscriptionTemplateEmailObj
+ * @property {boolean} [subscribed]
+ * @property {string} [template]
+ */
+/**
+ * @typedef EventSubscriptionTemplateObj
+ * @property {EventSubscriptionTemplateSmsObj} [sms]
+ * @property {EventSubscriptionTemplateEmailObj} [email]
+ * @property {EventSubscriptionTemplatePushnotification} [pushnotification]
+ */
+/**
+ * @typedef EventSubscriptionObj
+ * @property {EventSubscriptionTemplateObj} [template]
+ * @property {boolean} [is_default]
+ * @property {string} [_id]
+ * @property {string} [application]
+ * @property {string} [category]
+ * @property {Object} [event]
+ * @property {string} [slug]
+ * @property {string} [created_at]
+ * @property {string} [updated_at]
+ * @property {number} [__v]
+ */
 /**
  * @typedef EventSubscriptions
- * @property {EventSubscription[]} [items]
+ * @property {EventSubscriptionObj[]} [items]
  * @property {Page} [page]
  */
 /**
@@ -603,8 +632,8 @@ export = CommunicationPlatformModel;
  */
 /**
  * @typedef JobLog
- * @property {Object} [imported]
- * @property {Object} [processed]
+ * @property {StatsImported} [imported]
+ * @property {StatsProcessed} [processed]
  * @property {string} [_id]
  * @property {string} [job]
  * @property {string} [campaign]
@@ -666,11 +695,6 @@ export = CommunicationPlatformModel;
  * @property {Log[]} [items]
  * @property {Page} [page]
  */
-/**
- * @typedef SendOtpSmsCommsTemplate
- * @property {string} [key]
- * @property {Object} [value]
- */
 /**
  * @typedef SendOtpSmsCommsProvider
  * @property {string} [slug]
@@ -697,7 +721,7 @@ export = CommunicationPlatformModel;
  * @typedef SendOtpCommsReqSms
  * @property {number} [otp_length]
  * @property {number} [expiry]
- * @property {SendOtpSmsCommsTemplate} [template]
+ * @property {Object} [template]
  * @property {SendOtpSmsCommsProvider} [provider]
  */
 /**
@@ -877,6 +901,12 @@ export = CommunicationPlatformModel;
  * @property {string} [deeplink]
  * @property {string} [click_action]
  */
+/**
+ * @typedef SystemNotificationSetting
+ * @property {boolean} [sound]
+ * @property {string} [priority]
+ * @property {string} [time_to_live]
+ */
 /**
  * @typedef SystemNotificationUser
  * @property {string} [type]
@@ -886,7 +916,7 @@ export = CommunicationPlatformModel;
  * @typedef SystemNotification
  * @property {Notification} [notification]
  * @property {SystemNotificationUser} [user]
- * @property {SystemNotificationUser} [settings]
+ * @property {SystemNotificationSetting} [settings]
  * @property {string} [_id]
  * @property {string} [group]
  * @property {string} [created_at]
@@ -944,7 +974,7 @@ export = CommunicationPlatformModel;
 declare class CommunicationPlatformModel {
 }
 declare namespace CommunicationPlatformModel {
-    export { AppProvidersGlobalProviderRequestObjProvider, AppProvidersGlobalProviderRequestObj, AppProvidersGlobalProviderRequest, UpdateAppProvidersGlobalProviderResponseEmailSmsObj, UpdateAppProvidersGlobalProviderResponse, DefaultEmailProvidersFromAddresses, DefaultEmailProviders, PushtokenReq, PushtokenRes, SendInstantResponse, MetaStructure, PayloadSmsTemplateStructure, PayloadSmsProviderStructure, PayloadEmailTemplateStructure, PayloadEmailProviderStructure, PayloadEmailStructure, PayloadSmsStructure, SendSyncData, SendSyncRequest, EngineRequest, EngineResponse, EventSubscriptionsBulkUpdateRequest, EventSubscriptionsBulkUpdateResponse, SubscriptionsObjectRequest, SubscriptionsObject, TemplateObject, CommunicationTemplate, AppProvider, AppProviderRes, AppProviderResVoice, AppProviderResObj, GlobalProviders, GlobalProvidersResObj, AppProviderReq, StatsImported, StatsProcessedEmail, StatsProcessedSms, StatsProcessed, Stats, GetStats, CampaignReq, RecipientHeaders, CampaignEmailTemplate, CampignEmailProvider, CampaignEmail, Campaign, Campaigns, AudienceReq, Audience, Audiences, GetNRecordsCsvReq, GetNRecordsCsvResItems, GetNRecordsCsvRes, DummyDatasources, DummyDatasourcesMeta, DummyDatasourcesMetaObj, EmailProviderReqFrom, EmailProviderReq, EmailProvider, EmailProviders, EmailTemplateKeys, EmailTemplateHeaders, EmailTemplateReq, TemplateAndType, TemplateKeys, EmailTemplate, SystemEmailTemplate, EmailTemplates, SubscribedSmsTemplates, SubscribedEmailTemplates, EventSubscriptionTemplateSms, EventSubscriptionTemplateEmail, EventSubscriptionTemplatePushnotification, EventSubscriptionTemplate, EventSubscription, EventSubscriptions, TriggerJobResponse, TriggerJobRequest, GlobalVariablesGetResponse, GlobalVariablesPostResponse, GlobalVariablesReq, Job, Jobs, CreateJobsRes, CreateJobsReq, JobLog, JobLogs, LogEmail, LogSms, LogPushnotification, LogMeta, Log, Logs, SendOtpSmsCommsTemplate, SendOtpSmsCommsProvider, SendOtpEmailCommsProvider, SendOtpEmailCommsTemplate, SendOtpCommsReqData, SendOtpCommsReqSms, SendOtpCommsReqEmail, SendOtpCommsResSms, SendOtpCommsResEmail, SendOtpCommsReq, SendOtpCommsRes, VerifyOtpCommsReq, VerifyOtpCommsSuccessRes, SmsProviderReq, SmsProvider, SmsProviders, DefaultSmsProviders, SmsTemplateMessage, SmsTemplates, SmsTemplate, SystemSmsTemplates, metaObj, SmsTemplateReq, Notification, SystemNotificationUser, SystemNotification, SystemNotifications, Page, BasicDelete, EnabledObj, OtpConfigurationExpiryDuration, OtpConfigurationExpiry, OtpConfigRateLimit, OtpConfiguration };
+    export { AppProvidersGlobalProviderRequestObjProvider, AppProvidersGlobalProviderRequestObj, AppProvidersGlobalProviderRequest, UpdateAppProvidersGlobalProviderResponseEmailSmsObj, UpdateAppProvidersGlobalProviderResponse, DefaultEmailProvidersFromAddresses, DefaultEmailProviders, PushtokenReq, PushtokenRes, SendInstantResponse, MetaStructure, PayloadSmsTemplateStructure, PayloadSmsProviderStructure, PayloadEmailTemplateStructure, PayloadEmailProviderStructure, PayloadEmailStructure, PayloadSmsStructure, SendSyncData, SendSyncRequest, EngineRequest, EngineResponse, EventSubscriptionsBulkUpdateRequest, EventSubscriptionsBulkUpdateResponse, SubscriptionsObjectRequest, SubscriptionsObject, TemplateObject, CommunicationTemplate, AppProvider, AppProviderRes, AppProviderResVoice, AppProviderResObj, GlobalProviders, GlobalProvidersResObj, AppProviderReq, StatsImported, StatsProcessedEmail, StatsProcessedSms, StatsProcessed, Stats, GetStats, CampaignReq, RecipientHeaders, CampaignEmailTemplate, CampignEmailProvider, CampaignEmail, Campaign, Campaigns, AudienceReq, Audience, Audiences, GetNRecordsCsvReq, GetNRecordsCsvResItems, GetNRecordsCsvRes, DummyDatasources, DummyDatasourcesMeta, DummyDatasourcesMetaObj, EmailProviderReqFrom, EmailProviderReq, EmailProvider, EmailProviders, EmailTemplateKeys, EmailTemplateHeaders, EmailTemplateReq, TemplateAndType, TemplateKeys, EmailTemplate, SystemEmailTemplate, EmailTemplates, SubscribedSmsTemplates, SubscribedEmailTemplates, EventSubscriptionTemplateSms, EventSubscriptionTemplateEmail, EventSubscriptionTemplatePushnotification, EventSubscriptionTemplate, EventSubscription, EventSubscriptionTemplateSmsObj, EventSubscriptionTemplateEmailObj, EventSubscriptionTemplateObj, EventSubscriptionObj, EventSubscriptions, TriggerJobResponse, TriggerJobRequest, GlobalVariablesGetResponse, GlobalVariablesPostResponse, GlobalVariablesReq, Job, Jobs, CreateJobsRes, CreateJobsReq, JobLog, JobLogs, LogEmail, LogSms, LogPushnotification, LogMeta, Log, Logs, SendOtpSmsCommsProvider, SendOtpEmailCommsProvider, SendOtpEmailCommsTemplate, SendOtpCommsReqData, SendOtpCommsReqSms, SendOtpCommsReqEmail, SendOtpCommsResSms, SendOtpCommsResEmail, SendOtpCommsReq, SendOtpCommsRes, VerifyOtpCommsReq, VerifyOtpCommsSuccessRes, SmsProviderReq, SmsProvider, SmsProviders, DefaultSmsProviders, SmsTemplateMessage, SmsTemplates, SmsTemplate, SystemSmsTemplates, metaObj, SmsTemplateReq, Notification, SystemNotificationSetting, SystemNotificationUser, SystemNotification, SystemNotifications, Page, BasicDelete, EnabledObj, OtpConfigurationExpiryDuration, OtpConfigurationExpiry, OtpConfigRateLimit, OtpConfiguration };
 }
 /** @returns {AppProvidersGlobalProviderRequestObjProvider} */
 declare function AppProvidersGlobalProviderRequestObjProvider(): AppProvidersGlobalProviderRequestObjProvider;
@@ -1224,8 +1254,8 @@ type StatsProcessed = {
 declare function Stats(): Stats;
 type Stats = {
     _id?: string;
-    imported?: any;
-    processed?: any;
+    imported?: StatsImported;
+    processed?: StatsProcessed;
 };
 /** @returns {GetStats} */
 declare function GetStats(): GetStats;
@@ -1537,13 +1567,13 @@ type SubscribedEmailTemplates = {
 declare function EventSubscriptionTemplateSms(): EventSubscriptionTemplateSms;
 type EventSubscriptionTemplateSms = {
     subscribed?: boolean;
-    template?: any;
+    template?: string;
 };
 /** @returns {EventSubscriptionTemplateEmail} */
 declare function EventSubscriptionTemplateEmail(): EventSubscriptionTemplateEmail;
 type EventSubscriptionTemplateEmail = {
     subscribed?: boolean;
-    template?: any;
+    template?: string;
 };
 /** @returns {EventSubscriptionTemplatePushnotification} */
 declare function EventSubscriptionTemplatePushnotification(): EventSubscriptionTemplatePushnotification;
@@ -1571,10 +1601,43 @@ type EventSubscription = {
     updated_at?: string;
     __v?: number;
 };
+/** @returns {EventSubscriptionTemplateSmsObj} */
+declare function EventSubscriptionTemplateSmsObj(): EventSubscriptionTemplateSmsObj;
+type EventSubscriptionTemplateSmsObj = {
+    subscribed?: boolean;
+    template?: any;
+};
+/** @returns {EventSubscriptionTemplateEmailObj} */
+declare function EventSubscriptionTemplateEmailObj(): EventSubscriptionTemplateEmailObj;
+type EventSubscriptionTemplateEmailObj = {
+    subscribed?: boolean;
+    template?: string;
+};
+/** @returns {EventSubscriptionTemplateObj} */
+declare function EventSubscriptionTemplateObj(): EventSubscriptionTemplateObj;
+type EventSubscriptionTemplateObj = {
+    sms?: EventSubscriptionTemplateSmsObj;
+    email?: EventSubscriptionTemplateEmailObj;
+    pushnotification?: EventSubscriptionTemplatePushnotification;
+};
+/** @returns {EventSubscriptionObj} */
+declare function EventSubscriptionObj(): EventSubscriptionObj;
+type EventSubscriptionObj = {
+    template?: EventSubscriptionTemplateObj;
+    is_default?: boolean;
+    _id?: string;
+    application?: string;
+    category?: string;
+    event?: any;
+    slug?: string;
+    created_at?: string;
+    updated_at?: string;
+    __v?: number;
+};
 /** @returns {EventSubscriptions} */
 declare function EventSubscriptions(): EventSubscriptions;
 type EventSubscriptions = {
-    items?: EventSubscription[];
+    items?: EventSubscriptionObj[];
     page?: Page;
 };
 /** @returns {TriggerJobResponse} */
@@ -1645,8 +1708,8 @@ type CreateJobsReq = {
 /** @returns {JobLog} */
 declare function JobLog(): JobLog;
 type JobLog = {
-    imported?: any;
-    processed?: any;
+    imported?: StatsImported;
+    processed?: StatsProcessed;
     _id?: string;
     job?: string;
     campaign?: string;
@@ -1715,12 +1778,6 @@ type Logs = {
     items?: Log[];
     page?: Page;
 };
-/** @returns {SendOtpSmsCommsTemplate} */
-declare function SendOtpSmsCommsTemplate(): SendOtpSmsCommsTemplate;
-type SendOtpSmsCommsTemplate = {
-    key?: string;
-    value?: any;
-};
 /** @returns {SendOtpSmsCommsProvider} */
 declare function SendOtpSmsCommsProvider(): SendOtpSmsCommsProvider;
 type SendOtpSmsCommsProvider = {
@@ -1752,7 +1809,7 @@ declare function SendOtpCommsReqSms(): SendOtpCommsReqSms;
 type SendOtpCommsReqSms = {
     otp_length?: number;
     expiry?: number;
-    template?: SendOtpSmsCommsTemplate;
+    template?: any;
     provider?: SendOtpSmsCommsProvider;
 };
 /** @returns {SendOtpCommsReqEmail} */
@@ -1986,6 +2043,13 @@ type Notification = {
     deeplink?: string;
     click_action?: string;
 };
+/** @returns {SystemNotificationSetting} */
+declare function SystemNotificationSetting(): SystemNotificationSetting;
+type SystemNotificationSetting = {
+    sound?: boolean;
+    priority?: string;
+    time_to_live?: string;
+};
 /** @returns {SystemNotificationUser} */
 declare function SystemNotificationUser(): SystemNotificationUser;
 type SystemNotificationUser = {
@@ -1997,7 +2061,7 @@ declare function SystemNotification(): SystemNotification;
 type SystemNotification = {
     notification?: Notification;
     user?: SystemNotificationUser;
-    settings?: SystemNotificationUser;
+    settings?: SystemNotificationSetting;
     _id?: string;
     group?: string;
     created_at?: string;

package/sdk/platform/Communication/CommunicationPlatformModel.js

@@ -268,8 +268,8 @@ const Joi = require("joi");
 /**
  * @typedef Stats
  * @property {string} [_id]
- * @property {Object} [imported]
- * @property {Object} [processed]
+ * @property {StatsImported} [imported]
+ * @property {StatsProcessed} [processed]
  */
 
 /**
@@ -581,13 +581,13 @@ const Joi = require("joi");
 /**
  * @typedef EventSubscriptionTemplateSms
  * @property {boolean} [subscribed]
- * @property {Object} [template]
+ * @property {string} [template]
  */
 
 /**
  * @typedef EventSubscriptionTemplateEmail
  * @property {boolean} [subscribed]
- * @property {Object} [template]
+ * @property {string} [template]
  */
 
 /**
@@ -616,9 +616,42 @@ const Joi = require("joi");
  * @property {number} [__v]
  */
 
+/**
+ * @typedef EventSubscriptionTemplateSmsObj
+ * @property {boolean} [subscribed]
+ * @property {Object} [template]
+ */
+
+/**
+ * @typedef EventSubscriptionTemplateEmailObj
+ * @property {boolean} [subscribed]
+ * @property {string} [template]
+ */
+
+/**
+ * @typedef EventSubscriptionTemplateObj
+ * @property {EventSubscriptionTemplateSmsObj} [sms]
+ * @property {EventSubscriptionTemplateEmailObj} [email]
+ * @property {EventSubscriptionTemplatePushnotification} [pushnotification]
+ */
+
+/**
+ * @typedef EventSubscriptionObj
+ * @property {EventSubscriptionTemplateObj} [template]
+ * @property {boolean} [is_default]
+ * @property {string} [_id]
+ * @property {string} [application]
+ * @property {string} [category]
+ * @property {Object} [event]
+ * @property {string} [slug]
+ * @property {string} [created_at]
+ * @property {string} [updated_at]
+ * @property {number} [__v]
+ */
+
 /**
  * @typedef EventSubscriptions
- * @property {EventSubscription[]} [items]
+ * @property {EventSubscriptionObj[]} [items]
  * @property {Page} [page]
  */
 
@@ -689,8 +722,8 @@ const Joi = require("joi");
 
 /**
  * @typedef JobLog
- * @property {Object} [imported]
- * @property {Object} [processed]
+ * @property {StatsImported} [imported]
+ * @property {StatsProcessed} [processed]
  * @property {string} [_id]
  * @property {string} [job]
  * @property {string} [campaign]
@@ -760,12 +793,6 @@ const Joi = require("joi");
  * @property {Page} [page]
  */
 
-/**
- * @typedef SendOtpSmsCommsTemplate
- * @property {string} [key]
- * @property {Object} [value]
- */
-
 /**
  * @typedef SendOtpSmsCommsProvider
  * @property {string} [slug]
@@ -796,7 +823,7 @@ const Joi = require("joi");
  * @typedef SendOtpCommsReqSms
  * @property {number} [otp_length]
  * @property {number} [expiry]
- * @property {SendOtpSmsCommsTemplate} [template]
+ * @property {Object} [template]
  * @property {SendOtpSmsCommsProvider} [provider]
  */
 
@@ -995,6 +1022,13 @@ const Joi = require("joi");
  * @property {string} [click_action]
  */
 
+/**
+ * @typedef SystemNotificationSetting
+ * @property {boolean} [sound]
+ * @property {string} [priority]
+ * @property {string} [time_to_live]
+ */
+
 /**
  * @typedef SystemNotificationUser
  * @property {string} [type]
@@ -1005,7 +1039,7 @@ const Joi = require("joi");
  * @typedef SystemNotification
  * @property {Notification} [notification]
  * @property {SystemNotificationUser} [user]
- * @property {SystemNotificationUser} [settings]
+ * @property {SystemNotificationSetting} [settings]
  * @property {string} [_id]
  * @property {string} [group]
  * @property {string} [created_at]
@@ -1425,8 +1459,8 @@ class CommunicationPlatformModel {
   static Stats() {
     return Joi.object({
       _id: Joi.string().allow(""),
-      imported: Joi.any(),
-      processed: Joi.any(),
+      imported: CommunicationPlatformModel.StatsImported(),
+      processed: CommunicationPlatformModel.StatsProcessed(),
     });
   }
 
@@ -1814,7 +1848,7 @@ class CommunicationPlatformModel {
   static EventSubscriptionTemplateSms() {
     return Joi.object({
       subscribed: Joi.boolean(),
-      template: Joi.any(),
+      template: Joi.string().allow("").allow(null),
     });
   }
 
@@ -1822,7 +1856,7 @@ class CommunicationPlatformModel {
   static EventSubscriptionTemplateEmail() {
     return Joi.object({
       subscribed: Joi.boolean(),
-      template: Joi.any(),
+      template: Joi.string().allow("").allow(null),
     });
   }
 
@@ -1858,10 +1892,53 @@ class CommunicationPlatformModel {
     });
   }
 
+  /** @returns {EventSubscriptionTemplateSmsObj} */
+  static EventSubscriptionTemplateSmsObj() {
+    return Joi.object({
+      subscribed: Joi.boolean(),
+      template: Joi.any().allow(null),
+    });
+  }
+
+  /** @returns {EventSubscriptionTemplateEmailObj} */
+  static EventSubscriptionTemplateEmailObj() {
+    return Joi.object({
+      subscribed: Joi.boolean(),
+      template: Joi.string().allow("").allow(null),
+    });
+  }
+
+  /** @returns {EventSubscriptionTemplateObj} */
+  static EventSubscriptionTemplateObj() {
+    return Joi.object({
+      sms: CommunicationPlatformModel.EventSubscriptionTemplateSmsObj(),
+      email: CommunicationPlatformModel.EventSubscriptionTemplateEmailObj(),
+      pushnotification: CommunicationPlatformModel.EventSubscriptionTemplatePushnotification(),
+    });
+  }
+
+  /** @returns {EventSubscriptionObj} */
+  static EventSubscriptionObj() {
+    return Joi.object({
+      template: CommunicationPlatformModel.EventSubscriptionTemplateObj(),
+      is_default: Joi.boolean(),
+      _id: Joi.string().allow(""),
+      application: Joi.string().allow(""),
+      category: Joi.string().allow(""),
+      event: Joi.any(),
+      slug: Joi.string().allow(""),
+      created_at: Joi.string().allow(""),
+      updated_at: Joi.string().allow(""),
+      __v: Joi.number(),
+    });
+  }
+
   /** @returns {EventSubscriptions} */
   static EventSubscriptions() {
     return Joi.object({
-      items: Joi.array().items(CommunicationPlatformModel.EventSubscription()),
+      items: Joi.array().items(
+        CommunicationPlatformModel.EventSubscriptionObj()
+      ),
       page: CommunicationPlatformModel.Page(),
     });
   }
@@ -1952,8 +2029,8 @@ class CommunicationPlatformModel {
   /** @returns {JobLog} */
   static JobLog() {
     return Joi.object({
-      imported: Joi.any(),
-      processed: Joi.any(),
+      imported: CommunicationPlatformModel.StatsImported(),
+      processed: CommunicationPlatformModel.StatsProcessed(),
       _id: Joi.string().allow(""),
       job: Joi.string().allow(""),
       campaign: Joi.string().allow(""),
@@ -2038,14 +2115,6 @@ class CommunicationPlatformModel {
     });
   }
 
-  /** @returns {SendOtpSmsCommsTemplate} */
-  static SendOtpSmsCommsTemplate() {
-    return Joi.object({
-      key: Joi.string().allow(""),
-      value: Joi.any(),
-    });
-  }
-
   /** @returns {SendOtpSmsCommsProvider} */
   static SendOtpSmsCommsProvider() {
     return Joi.object({
@@ -2085,7 +2154,7 @@ class CommunicationPlatformModel {
     return Joi.object({
       otp_length: Joi.number(),
       expiry: Joi.number(),
-      template: CommunicationPlatformModel.SendOtpSmsCommsTemplate(),
+      template: Joi.object().pattern(/\S/, Joi.any()),
       provider: CommunicationPlatformModel.SendOtpSmsCommsProvider(),
     });
   }
@@ -2321,6 +2390,15 @@ class CommunicationPlatformModel {
     });
   }
 
+  /** @returns {SystemNotificationSetting} */
+  static SystemNotificationSetting() {
+    return Joi.object({
+      sound: Joi.boolean(),
+      priority: Joi.string().allow(""),
+      time_to_live: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {SystemNotificationUser} */
   static SystemNotificationUser() {
     return Joi.object({
@@ -2334,7 +2412,7 @@ class CommunicationPlatformModel {
     return Joi.object({
       notification: CommunicationPlatformModel.Notification(),
       user: CommunicationPlatformModel.SystemNotificationUser(),
-      settings: CommunicationPlatformModel.SystemNotificationUser(),
+      settings: CommunicationPlatformModel.SystemNotificationSetting(),
       _id: Joi.string().allow(""),
       group: Joi.string().allow(""),
       created_at: Joi.string().allow(""),

package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts

@@ -152,7 +152,39 @@ declare class CompanyProfile {
      * @summary: Get list of locations
      * @description: This API allows to view all the locations associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocations/).
      */
-    getLocations({ storeType, q, stage, pageNo, pageSize, locationIds, types, tags, requestHeaders, }?: CompanyProfilePlatformValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.LocationListSerializer>;
+    getLocations({ storeType, storeCodes, q, stage, pageNo, pageSize, locationIds, types, tags, requestHeaders, }?: CompanyProfilePlatformValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.LocationListSerializer>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.storeType] - Helps to sort the location list on the
+     *   basis of location type.
+     * @param {string[]} [arg.storeCodes] - List of up to 50 store codes to
+     *   fetch. Specify multiple values by repeating the query parameter (e.g.,
+     *   `?store_codes=high_street&store_codes=main_avenue`). Comma-separated
+     *   values are not supported.
+     * @param {string} [arg.q] - Query that is to be searched.
+     * @param {string} [arg.stage] - To filter companies on basis of verified or
+     *   unverified companies.
+     * @param {number} [arg.pageSize] - Number of items to retrieve in each
+     *   page. Default is 10.
+     * @param {number[]} [arg.locationIds] - Helps to filter stores on the basis of uids.
+     * @param {string[]} [arg.types] - Helps to get the location list on the
+     *   basis of multiple location type.
+     * @param {string[]} [arg.tags] - Helps to get the location list on the
+     *   basis of multiple location tag.
+     * @returns {Paginator<CompanyProfilePlatformModel.LocationListSerializer>}
+     * @summary: Get list of locations
+     * @description: This API allows to view all the locations associated to a company.
+     */
+    getLocationsPaginator({ storeType, storeCodes, q, stage, pageSize, locationIds, types, tags, }?: {
+        storeType?: string;
+        storeCodes?: string[];
+        q?: string;
+        stage?: string;
+        pageSize?: number;
+        locationIds?: number[];
+        types?: string[];
+        tags?: string[];
+    }): Paginator<CompanyProfilePlatformModel.LocationListSerializer>;
     /**
      * @param {CompanyProfilePlatformValidator.UpdateCompanyParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js

@@ -950,6 +950,7 @@ class CompanyProfile {
   async getLocations(
     {
       storeType,
+      storeCodes,
       q,
       stage,
       pageNo,
@@ -964,6 +965,7 @@ class CompanyProfile {
     const { error } = CompanyProfilePlatformValidator.getLocations().validate(
       {
         storeType,
+        storeCodes,
         q,
         stage,
         pageNo,
@@ -984,6 +986,7 @@ class CompanyProfile {
     } = CompanyProfilePlatformValidator.getLocations().validate(
       {
         storeType,
+        storeCodes,
         q,
         stage,
         pageNo,
@@ -1003,6 +1006,7 @@ class CompanyProfile {
 
     const query_params = {};
     query_params["store_type"] = storeType;
+    query_params["store_codes"] = storeCodes;
     query_params["q"] = q;
     query_params["stage"] = stage;
     query_params["page_no"] = pageNo;
@@ -1049,6 +1053,64 @@ class CompanyProfile {
     return response;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} [arg.storeType] - Helps to sort the location list on the
+   *   basis of location type.
+   * @param {string[]} [arg.storeCodes] - List of up to 50 store codes to
+   *   fetch. Specify multiple values by repeating the query parameter (e.g.,
+   *   `?store_codes=high_street&store_codes=main_avenue`). Comma-separated
+   *   values are not supported.
+   * @param {string} [arg.q] - Query that is to be searched.
+   * @param {string} [arg.stage] - To filter companies on basis of verified or
+   *   unverified companies.
+   * @param {number} [arg.pageSize] - Number of items to retrieve in each
+   *   page. Default is 10.
+   * @param {number[]} [arg.locationIds] - Helps to filter stores on the basis of uids.
+   * @param {string[]} [arg.types] - Helps to get the location list on the
+   *   basis of multiple location type.
+   * @param {string[]} [arg.tags] - Helps to get the location list on the
+   *   basis of multiple location tag.
+   * @returns {Paginator<CompanyProfilePlatformModel.LocationListSerializer>}
+   * @summary: Get list of locations
+   * @description: This API allows to view all the locations associated to a company.
+   */
+  getLocationsPaginator({
+    storeType,
+    storeCodes,
+    q,
+    stage,
+    pageSize,
+    locationIds,
+    types,
+    tags,
+  } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.getLocations({
+        storeType: storeType,
+        storeCodes: storeCodes,
+        q: q,
+        stage: stage,
+        pageNo: pageNo,
+        pageSize: pageSize,
+        locationIds: locationIds,
+        types: types,
+        tags: tags,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback.bind(this));
+    return paginator;
+  }
+
   /**
    * @param {CompanyProfilePlatformValidator.UpdateCompanyParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts

@@ -43,6 +43,10 @@ export = CompanyProfilePlatformValidator;
  * @typedef GetLocationsParam
  * @property {string} [storeType] - Helps to sort the location list on the basis
  *   of location type.
+ * @property {string[]} [storeCodes] - List of up to 50 store codes to fetch.
+ *   Specify multiple values by repeating the query parameter (e.g.,
+ *   `?store_codes=high_street&store_codes=main_avenue`). Comma-separated values
+ *   are not supported.
  * @property {string} [q] - Query that is to be searched.
  * @property {string} [stage] - To filter companies on basis of verified or
  *   unverified companies.
@@ -151,6 +155,13 @@ type GetLocationsParam = {
      * of location type.
      */
     storeType?: string;
+    /**
+     * - List of up to 50 store codes to fetch.
+     * Specify multiple values by repeating the query parameter (e.g.,
+     * `?store_codes=high_street&store_codes=main_avenue`). Comma-separated values
+     * are not supported.
+     */
+    storeCodes?: string[];
     /**
      * - Query that is to be searched.
      */