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

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

@@ -1,10 +1,26 @@
 export = CommunicationPlatformModel;
 /**
- * @typedef EventSubscriptionsBulkUpdateRequest
+ * @typedef GroupMapping
+ * @property {EventGroup[]} items - List of event groups configured for the application.
+ */
+/**
+ * @typedef EventGroup
+ * @property {string} name - Event group identifier
+ * @property {string} display - Human-readable group name
+ * @property {EventSubgroup[]} subgroups - List of sub-groups that belong to
+ *   this event group.
+ */
+/**
+ * @typedef EventSubgroup
+ * @property {string} name - Sub-group identifier
+ * @property {string} display - Human-readable sub-group name
+ */
+/**
+ * @typedef EventSubscriptionsBulkUpdatePayload
  * @property {SubscriptionsObject[]} [subscriptions]
  */
 /**
- * @typedef EventSubscriptionsBulkUpdateResponse
+ * @typedef EventSubscriptionsBulkUpdateResult
  * @property {EventSubscriptionTemplate} [template]
  * @property {string} [_id]
  * @property {string} [application]
@@ -114,6 +130,7 @@ export = CommunicationPlatformModel;
  * @property {string} [name]
  * @property {string} [file_url]
  * @property {string} [type]
+ * @property {string} [datasource_type] - Type of the datasource (audience or user_group)
  * @property {number} [records_count]
  * @property {string} [application]
  */
@@ -147,6 +164,7 @@ export = CommunicationPlatformModel;
  * @property {string} [_id]
  * @property {string} [datasource]
  * @property {string} [type]
+ * @property {string} [datasource_type] - Type of the datasource (audience or user_group)
  * @property {string} [name]
  * @property {string} [application]
  * @property {string} [created_at]
@@ -414,23 +432,23 @@ export = CommunicationPlatformModel;
  * @property {string} [timestamp]
  */
 /**
- * @typedef EngineRequest
+ * @typedef EnginePayload
  * @property {PayloadStructure} [payload]
  * @property {MetaStructure} [meta]
  */
 /**
- * @typedef EngineResponse
+ * @typedef EngineResult
  * @property {boolean} [success]
  */
 /**
  * @typedef EventSubscriptionTemplateSms
  * @property {boolean} [subscribed]
- * @property {string} [template]
+ * @property {SmsTemplate} [template]
  */
 /**
  * @typedef EventSubscriptionTemplateEmail
  * @property {boolean} [subscribed]
- * @property {string} [template]
+ * @property {EmailTemplate} [template]
  */
 /**
  * @typedef EventSubscriptionTemplate
@@ -443,32 +461,51 @@ export = CommunicationPlatformModel;
  * @property {boolean} [is_default]
  * @property {string} [_id]
  * @property {string} [application]
- * @property {string} [event]
+ * @property {EventSubscriptionEvents} [event]
  * @property {string} [slug]
  * @property {string} [created_at]
  * @property {string} [updated_at]
  * @property {number} [__v]
  */
+/**
+ * @typedef EventSubscriptionEvents
+ * @property {string} [category]
+ * @property {string} [event_name]
+ * @property {string} [group]
+ * @property {string} [slug]
+ * @property {EventTemplate} [template]
+ */
+/**
+ * @typedef EventTemplate
+ * @property {EventProviderTemplates} [email]
+ * @property {EventProviderTemplates} [pushnotification]
+ * @property {EventProviderTemplates} [sms]
+ */
+/**
+ * @typedef EventProviderTemplates
+ * @property {string} [provider_type] - Provider type for the event template
+ * @property {string} [template] - This is the unique id of the template
+ */
 /**
  * @typedef EventSubscriptions
  * @property {EventSubscription[]} [items]
  * @property {Page} [page]
  */
 /**
- * @typedef TriggerJobResponse
+ * @typedef TriggerJobResult
  * @property {number} [status]
  */
 /**
- * @typedef TriggerJobRequest
+ * @typedef TriggerJobPayload
  * @property {string} [job_id]
  */
 /**
- * @typedef GlobalVariablesGetResponse
+ * @typedef GetGlobalVariablesResult
  * @property {Object} [read_only]
  * @property {Object} [editable]
  */
 /**
- * @typedef GlobalVariablesPostResponse
+ * @typedef CreateGlobalVariablesResult
  * @property {string} [_id]
  * @property {string} [category]
  * @property {string} [application]
@@ -588,6 +625,9 @@ export = CommunicationPlatformModel;
  * @property {string} [mobile]
  * @property {string} [country_code]
  * @property {string} [to]
+ * @property {Object} [additional_template_variables] - Additional key-value
+ *   pairs for personalizing message content. Values can be of any type and will
+ *   be substituted into the communication templates when rendering the message.
  */
 /**
  * @typedef SendOtpCommsReqSms
@@ -671,6 +711,8 @@ export = CommunicationPlatformModel;
  * @property {number} [version_id] - The version ID for the test.
  * @property {string} [sender_id] - The sender ID for the test.
  * @property {string} [api_key] - The api_key for the test.
+ * @property {string} [tenant_name_1] - First part of jiocx url.
+ * @property {string} [tenant_name_2] - Second part of jiocx url.
  */
 /**
  * @typedef SmsProvider
@@ -738,6 +780,10 @@ export = CommunicationPlatformModel;
  */
 /**
  * @typedef SystemSmsTemplates
+ * @property {SystemSmsTemplate[]} [items] - An array of system SMS templates
+ */
+/**
+ * @typedef SystemSmsTemplate
  * @property {EnabledObj} [url_shorten]
  * @property {string} [_id]
  * @property {boolean} [is_system]
@@ -804,13 +850,14 @@ export = CommunicationPlatformModel;
  */
 /**
  * @typedef Page
- * @property {number} [item_total] - The total number of items on the page.
+ * @property {number} [item_total] - The total number of all items across all pages.
  * @property {string} [next_id] - The identifier for the next page.
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
  * @property {boolean} [has_next] - Indicates whether there is a next page.
  * @property {number} [current] - The current page number.
- * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {string} type - The type of the page, can be 'cursor' or 'number'.
  * @property {number} [size] - The number of items per page.
+ * @property {number} [page_size] - The number of items per page.
  */
 /**
  * @typedef GenericError
@@ -856,16 +903,53 @@ export = CommunicationPlatformModel;
 declare class CommunicationPlatformModel {
 }
 declare namespace CommunicationPlatformModel {
-    export { EventSubscriptionsBulkUpdateRequest, EventSubscriptionsBulkUpdateResponse, SubscriptionsObject, TemplateObject, CommunicationTemplate, AppProvider, AppProviderRes, AppProviderResVoice, AppProviderResObj, GlobalProviders, GlobalProvidersResObj, AppProviderReq, StatsImported, StatsProcessedEmail, StatsProcessedSms, StatsProcessed, Stats, GetStats, CampaignReq, RecipientHeaders, CampaignEmailTemplate, CampignEmailProvider, CampaignEmail, Campaign, Campaigns, BadRequestSchema, NotFound, AudienceReq, Audience, Audiences, GetNRecordsCsvReq, GetNRecordsCsvResItems, GetNRecordsCsvRes, DummyDatasources, DummyDatasourcesMeta, DummyDatasourcesMetaObj, EmailProviderReqFrom, EmailProviderReq, EmailProvider, EmailProviders, EmailTemplateKeys, EmailTemplateHeaders, EmailTemplateReq, TemplateAndType, EmailTemplate, SystemEmailTemplate, EmailTemplates, SystemEmailTemplates, PayloadEmailTemplateStructure, PayloadEmailProviderStructure, PayloadEmailStructure, PayloadSmsTemplateStructure, PayloadSmsProviderStructure, PayloadSmsStructure, PayloadStructure, MetaStructure, EngineRequest, EngineResponse, EventSubscriptionTemplateSms, EventSubscriptionTemplateEmail, EventSubscriptionTemplate, EventSubscription, EventSubscriptions, TriggerJobResponse, TriggerJobRequest, GlobalVariablesGetResponse, GlobalVariablesPostResponse, GlobalVariablesReq, Job, Jobs, CreateJobsRes, CreateJobsReq, JobLog, JobLogs, LogEmail, LogPushnotification, LogMeta, Log, Logs, SendOtpSmsCommsTemplate, SendOtpSmsCommsProvider, SendOtpEmailCommsProvider, SendOtpEmailCommsTemplate, SendOtpCommsReqData, SendOtpCommsReqSms, SendOtpCommsReqEmail, SendOtpCommsResSms, SendOtpCommsResEmail, SendOtpCommsReq, SendOtpCommsRes, VerifyOtpCommsReq, VerifyOtpCommsSuccessRes, VerifyOtpCommsErrorRes, SmsProviderReq, SmsProvider, SmsProviders, DefaultSmsProviders, SmsTemplateMessage, SmsTemplates, SmsTemplate, SystemSmsTemplates, metaObj, SmsTemplateReq, Notification, SystemNotificationUser, SystemNotification, SystemNotifications, Page, GenericError, GenericDelete, Message, EnabledObj, OtpConfigurationExpiryDuration, OtpConfigurationExpiry, OtpConfiguration };
+    export { GroupMapping, EventGroup, EventSubgroup, EventSubscriptionsBulkUpdatePayload, EventSubscriptionsBulkUpdateResult, SubscriptionsObject, TemplateObject, CommunicationTemplate, AppProvider, AppProviderRes, AppProviderResVoice, AppProviderResObj, GlobalProviders, GlobalProvidersResObj, AppProviderReq, StatsImported, StatsProcessedEmail, StatsProcessedSms, StatsProcessed, Stats, GetStats, CampaignReq, RecipientHeaders, CampaignEmailTemplate, CampignEmailProvider, CampaignEmail, Campaign, Campaigns, BadRequestSchema, NotFound, AudienceReq, Audience, Audiences, GetNRecordsCsvReq, GetNRecordsCsvResItems, GetNRecordsCsvRes, DummyDatasources, DummyDatasourcesMeta, DummyDatasourcesMetaObj, EmailProviderReqFrom, EmailProviderReq, EmailProvider, EmailProviders, EmailTemplateKeys, EmailTemplateHeaders, EmailTemplateReq, TemplateAndType, EmailTemplate, SystemEmailTemplate, EmailTemplates, SystemEmailTemplates, PayloadEmailTemplateStructure, PayloadEmailProviderStructure, PayloadEmailStructure, PayloadSmsTemplateStructure, PayloadSmsProviderStructure, PayloadSmsStructure, PayloadStructure, MetaStructure, EnginePayload, EngineResult, EventSubscriptionTemplateSms, EventSubscriptionTemplateEmail, EventSubscriptionTemplate, EventSubscription, EventSubscriptionEvents, EventTemplate, EventProviderTemplates, EventSubscriptions, TriggerJobResult, TriggerJobPayload, GetGlobalVariablesResult, CreateGlobalVariablesResult, GlobalVariablesReq, Job, Jobs, CreateJobsRes, CreateJobsReq, JobLog, JobLogs, LogEmail, LogPushnotification, LogMeta, Log, Logs, SendOtpSmsCommsTemplate, SendOtpSmsCommsProvider, SendOtpEmailCommsProvider, SendOtpEmailCommsTemplate, SendOtpCommsReqData, SendOtpCommsReqSms, SendOtpCommsReqEmail, SendOtpCommsResSms, SendOtpCommsResEmail, SendOtpCommsReq, SendOtpCommsRes, VerifyOtpCommsReq, VerifyOtpCommsSuccessRes, VerifyOtpCommsErrorRes, SmsProviderReq, SmsProvider, SmsProviders, DefaultSmsProviders, SmsTemplateMessage, SmsTemplates, SmsTemplate, SystemSmsTemplates, SystemSmsTemplate, metaObj, SmsTemplateReq, Notification, SystemNotificationUser, SystemNotification, SystemNotifications, Page, GenericError, GenericDelete, Message, EnabledObj, OtpConfigurationExpiryDuration, OtpConfigurationExpiry, OtpConfiguration };
 }
-/** @returns {EventSubscriptionsBulkUpdateRequest} */
-declare function EventSubscriptionsBulkUpdateRequest(): EventSubscriptionsBulkUpdateRequest;
-type EventSubscriptionsBulkUpdateRequest = {
+/** @returns {GroupMapping} */
+declare function GroupMapping(): GroupMapping;
+type GroupMapping = {
+    /**
+     * - List of event groups configured for the application.
+     */
+    items: EventGroup[];
+};
+/** @returns {EventGroup} */
+declare function EventGroup(): EventGroup;
+type EventGroup = {
+    /**
+     * - Event group identifier
+     */
+    name: string;
+    /**
+     * - Human-readable group name
+     */
+    display: string;
+    /**
+     * - List of sub-groups that belong to
+     * this event group.
+     */
+    subgroups: EventSubgroup[];
+};
+/** @returns {EventSubgroup} */
+declare function EventSubgroup(): EventSubgroup;
+type EventSubgroup = {
+    /**
+     * - Sub-group identifier
+     */
+    name: string;
+    /**
+     * - Human-readable sub-group name
+     */
+    display: string;
+};
+/** @returns {EventSubscriptionsBulkUpdatePayload} */
+declare function EventSubscriptionsBulkUpdatePayload(): EventSubscriptionsBulkUpdatePayload;
+type EventSubscriptionsBulkUpdatePayload = {
     subscriptions?: SubscriptionsObject[];
 };
-/** @returns {EventSubscriptionsBulkUpdateResponse} */
-declare function EventSubscriptionsBulkUpdateResponse(): EventSubscriptionsBulkUpdateResponse;
-type EventSubscriptionsBulkUpdateResponse = {
+/** @returns {EventSubscriptionsBulkUpdateResult} */
+declare function EventSubscriptionsBulkUpdateResult(): EventSubscriptionsBulkUpdateResult;
+type EventSubscriptionsBulkUpdateResult = {
     template?: EventSubscriptionTemplate;
     _id?: string;
     application?: string;
@@ -1001,6 +1085,10 @@ type CampaignReq = {
     name?: string;
     file_url?: string;
     type?: string;
+    /**
+     * - Type of the datasource (audience or user_group)
+     */
+    datasource_type?: string;
     records_count?: number;
     application?: string;
 };
@@ -1039,6 +1127,10 @@ type Campaign = {
     _id?: string;
     datasource?: string;
     type?: string;
+    /**
+     * - Type of the datasource (audience or user_group)
+     */
+    datasource_type?: string;
     name?: string;
     application?: string;
     created_at?: string;
@@ -1346,28 +1438,28 @@ type MetaStructure = {
     trace?: string;
     timestamp?: string;
 };
-/** @returns {EngineRequest} */
-declare function EngineRequest(): EngineRequest;
-type EngineRequest = {
+/** @returns {EnginePayload} */
+declare function EnginePayload(): EnginePayload;
+type EnginePayload = {
     payload?: PayloadStructure;
     meta?: MetaStructure;
 };
-/** @returns {EngineResponse} */
-declare function EngineResponse(): EngineResponse;
-type EngineResponse = {
+/** @returns {EngineResult} */
+declare function EngineResult(): EngineResult;
+type EngineResult = {
     success?: boolean;
 };
 /** @returns {EventSubscriptionTemplateSms} */
 declare function EventSubscriptionTemplateSms(): EventSubscriptionTemplateSms;
 type EventSubscriptionTemplateSms = {
     subscribed?: boolean;
-    template?: string;
+    template?: SmsTemplate;
 };
 /** @returns {EventSubscriptionTemplateEmail} */
 declare function EventSubscriptionTemplateEmail(): EventSubscriptionTemplateEmail;
 type EventSubscriptionTemplateEmail = {
     subscribed?: boolean;
-    template?: string;
+    template?: EmailTemplate;
 };
 /** @returns {EventSubscriptionTemplate} */
 declare function EventSubscriptionTemplate(): EventSubscriptionTemplate;
@@ -1382,37 +1474,65 @@ type EventSubscription = {
     is_default?: boolean;
     _id?: string;
     application?: string;
-    event?: string;
+    event?: EventSubscriptionEvents;
     slug?: string;
     created_at?: string;
     updated_at?: string;
     __v?: number;
 };
+/** @returns {EventSubscriptionEvents} */
+declare function EventSubscriptionEvents(): EventSubscriptionEvents;
+type EventSubscriptionEvents = {
+    category?: string;
+    event_name?: string;
+    group?: string;
+    slug?: string;
+    template?: EventTemplate;
+};
+/** @returns {EventTemplate} */
+declare function EventTemplate(): EventTemplate;
+type EventTemplate = {
+    email?: EventProviderTemplates;
+    pushnotification?: EventProviderTemplates;
+    sms?: EventProviderTemplates;
+};
+/** @returns {EventProviderTemplates} */
+declare function EventProviderTemplates(): EventProviderTemplates;
+type EventProviderTemplates = {
+    /**
+     * - Provider type for the event template
+     */
+    provider_type?: string;
+    /**
+     * - This is the unique id of the template
+     */
+    template?: string;
+};
 /** @returns {EventSubscriptions} */
 declare function EventSubscriptions(): EventSubscriptions;
 type EventSubscriptions = {
     items?: EventSubscription[];
     page?: Page;
 };
-/** @returns {TriggerJobResponse} */
-declare function TriggerJobResponse(): TriggerJobResponse;
-type TriggerJobResponse = {
+/** @returns {TriggerJobResult} */
+declare function TriggerJobResult(): TriggerJobResult;
+type TriggerJobResult = {
     status?: number;
 };
-/** @returns {TriggerJobRequest} */
-declare function TriggerJobRequest(): TriggerJobRequest;
-type TriggerJobRequest = {
+/** @returns {TriggerJobPayload} */
+declare function TriggerJobPayload(): TriggerJobPayload;
+type TriggerJobPayload = {
     job_id?: string;
 };
-/** @returns {GlobalVariablesGetResponse} */
-declare function GlobalVariablesGetResponse(): GlobalVariablesGetResponse;
-type GlobalVariablesGetResponse = {
+/** @returns {GetGlobalVariablesResult} */
+declare function GetGlobalVariablesResult(): GetGlobalVariablesResult;
+type GetGlobalVariablesResult = {
     read_only?: any;
     editable?: any;
 };
-/** @returns {GlobalVariablesPostResponse} */
-declare function GlobalVariablesPostResponse(): GlobalVariablesPostResponse;
-type GlobalVariablesPostResponse = {
+/** @returns {CreateGlobalVariablesResult} */
+declare function CreateGlobalVariablesResult(): CreateGlobalVariablesResult;
+type CreateGlobalVariablesResult = {
     _id?: string;
     category?: string;
     application?: string;
@@ -1549,6 +1669,12 @@ type SendOtpCommsReqData = {
     mobile?: string;
     country_code?: string;
     to?: string;
+    /**
+     * - Additional key-value
+     * pairs for personalizing message content. Values can be of any type and will
+     * be substituted into the communication templates when rendering the message.
+     */
+    additional_template_variables?: any;
 };
 /** @returns {SendOtpCommsReqSms} */
 declare function SendOtpCommsReqSms(): SendOtpCommsReqSms;
@@ -1678,6 +1804,14 @@ type SmsProviderReq = {
      * - The api_key for the test.
      */
     api_key?: string;
+    /**
+     * - First part of jiocx url.
+     */
+    tenant_name_1?: string;
+    /**
+     * - Second part of jiocx url.
+     */
+    tenant_name_2?: string;
 };
 /** @returns {SmsProvider} */
 declare function SmsProvider(): SmsProvider;
@@ -1752,6 +1886,14 @@ type SmsTemplate = {
 /** @returns {SystemSmsTemplates} */
 declare function SystemSmsTemplates(): SystemSmsTemplates;
 type SystemSmsTemplates = {
+    /**
+     * - An array of system SMS templates
+     */
+    items?: SystemSmsTemplate[];
+};
+/** @returns {SystemSmsTemplate} */
+declare function SystemSmsTemplate(): SystemSmsTemplate;
+type SystemSmsTemplate = {
     url_shorten?: EnabledObj;
     _id?: string;
     is_system?: boolean;
@@ -1826,7 +1968,7 @@ type SystemNotifications = {
 declare function Page(): Page;
 type Page = {
     /**
-     * - The total number of items on the page.
+     * - The total number of all items across all pages.
      */
     item_total?: number;
     /**
@@ -1846,13 +1988,17 @@ type Page = {
      */
     current?: number;
     /**
-     * - The type of the page, such as 'PageType'.
+     * - The type of the page, can be 'cursor' or 'number'.
      */
     type: string;
     /**
      * - The number of items per page.
      */
     size?: number;
+    /**
+     * - The number of items per page.
+     */
+    page_size?: number;
 };
 /** @returns {GenericError} */
 declare function GenericError(): GenericError;