export = Communication; declare class Communication { constructor(config: any, applicationId: any); config: any; applicationId: any; /** * @param {CommunicationPlatformApplicationValidator.CreateAudienceParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name createAudience * @summary: Create an audience * @description: Creates a new email audience. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createAudience/). */ createAudience({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateAudienceParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.CreateCampaignParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name createCampaign * @summary: Create a campaign * @description: Creates a new communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createCampaign/). */ createCampaign({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateCampaignParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.CreateEmailProviderParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name createEmailProvider * @summary: Create an email provider * @description: Creates a new email communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createEmailProvider/). */ createEmailProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEmailProviderParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.CreateEmailTemplateParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name createEmailTemplate * @summary: Creat an email template * @description: Creates a new email communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createEmailTemplate/). */ createEmailTemplate({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEmailTemplateParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.CreateEventSubscriptionsParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name createEventSubscriptions * @summary: Create an event subscription * @description: Creates a new event subscription. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createEventSubscriptions/). */ createEventSubscriptions({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.CreateEventSubscriptionsByBulkParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise< * CommunicationPlatformModel.EventSubscriptionsBulkUpdateResult[] * >} * - Success response * * @name createEventSubscriptionsByBulk * @summary: Create event subscriptions in bulk * @description: Creates a new event subscription in bulk. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createEventSubscriptionsByBulk/). */ createEventSubscriptionsByBulk({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateEventSubscriptionsByBulkParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.CreateJobsParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name createJobs * @summary: Create a campaign jobs * @description: Creates a new campaign job. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createJobs/). */ createJobs({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateJobsParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.CreateSmsProviderParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name createSmsProvider * @summary: Create SMS provider * @description: Creates a new SMS communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createSmsProvider/). */ createSmsProvider({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsProviderParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.CreateSmsTemplateParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name createSmsTemplate * @summary: Create a SMS template * @description: Creates a new SMS communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createSmsTemplate/). */ createSmsTemplate({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.CreateSmsTemplateParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.DeleteAudienceByIdParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name deleteAudienceById * @summary: Delete an audience * @description: Remove a specific audience permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteAudienceById/). */ deleteAudienceById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteAudienceByIdParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.DeleteEmailProviderByIdParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name deleteEmailProviderById * @summary: Delete an email provider * @description: Removes a specific email communication provider from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteEmailProviderById/). */ deleteEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailProviderByIdParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name deleteEmailTemplateById * @summary: Delete an email template * @description: Removes a specific email communication template from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteEmailTemplateById/). */ deleteEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEmailTemplateByIdParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.DeleteEventSubscriptionsByIdParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name deleteEventSubscriptionsById * @summary: Delete an event subscriptions * @description: Removes a specific event subscription from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteEventSubscriptionsById/). */ deleteEventSubscriptionsById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteEventSubscriptionsByIdParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.DeleteSmsProviderByIdParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name deleteSmsProviderById * @summary: Delete an SMS provider * @description: Removes a specific SMS communication provider from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteSmsProviderById/). */ deleteSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsProviderByIdParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name deleteSmsTemplateById * @summary: Delete an SMS template * @description: Removes a specific SMS communication template from the platform permenantly. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/deleteSmsTemplateById/). */ deleteSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.DeleteSmsTemplateByIdParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.EditEventSubscriptionsParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name editEventSubscriptions * @summary: Update an event subscriptions * @description: Modifys the configuration and settings of a specific event subscription. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/editEventSubscriptions/). */ editEventSubscriptions({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.EditEventSubscriptionsParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetAppProvidersParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getAppProviders * @summary: Get application providers * @description: Retrieve a list of providers associated with the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getAppProviders/). */ getAppProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetAudienceByIdParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getAudienceById * @summary: Get an audience * @description: Retrieves detailed information about an specific audience. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getAudienceById/). */ getAudienceById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudienceByIdParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetAudiencesParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getAudiences * @summary: Get all the audiences * @description: Retrieves a list of all the audiences. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getAudiences/). */ getAudiences({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetAudiencesParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetCampaignByIdParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getCampaignById * @summary: Get a campaign * @description: Retrieves detailed information about a specific communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getCampaignById/). */ getCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCampaignByIdParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetCampaignsParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getCampaigns * @summary: Get all campaigns * @description: Retrieves a list of communication campaigns. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getCampaigns/). */ getCampaigns({ query, pageNo, pageSize, sort, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCampaignsParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetCommunicationLogsParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getCommunicationLogs * @summary: Get communication reports * @description: Retrieve a lsit of logs and records of communication activities. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getCommunicationLogs/). */ getCommunicationLogs({ pageId, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetCommunicationLogsParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetDefaultSmsProvidersParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name getDefaultSmsProviders * @summary: Get all default SMS providers * @description: Retrieve all the default SMS communication providers. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getDefaultSmsProviders/). */ getDefaultSmsProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetDummyDatasourcesParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name getDummyDatasources * @summary: Get dummy data sources * @description: Retrieve a list of dummy data sources. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getDummyDatasources/). */ getDummyDatasources({ requestHeaders }?: any, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetDummyDatasourcesMetaParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name getDummyDatasourcesMeta * @summary: Get dummy data sources metadata * @description: Retrieve metadata information about dummy data sources. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getDummyDatasourcesMeta/). */ getDummyDatasourcesMeta({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetDummyDatasourcesMetaParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetEmailProviderByIdParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getEmailProviderById * @summary: Get a email provider * @description: Retrieves detailed information about a specific email communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEmailProviderById/). */ getEmailProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProviderByIdParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetEmailProvidersParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getEmailProviders * @summary: Get all email providers * @description: Retrieves a list of all email communication providers associated with the sales channel.. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEmailProviders/). */ getEmailProviders({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailProvidersParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getEmailTemplateById * @summary: Get an email template * @description: Retrieves detailed information about a specific email communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEmailTemplateById/). */ getEmailTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplateByIdParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetEmailTemplatesParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getEmailTemplates * @summary: Get all email templates * @description: Retrieves a list of available email communication templates. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEmailTemplates/). */ getEmailTemplates({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEmailTemplatesParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name getEventSubscriptions * @summary: Get all event subscriptions * @description: Retrieves a list of all event subscriptions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEventSubscriptions/). */ getEventSubscriptions({ pageNo, pageSize, populate, group, subGroup, fulfillmentOptionSlug, requestHeaders, }?: CommunicationPlatformApplicationValidator.GetEventSubscriptionsParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetEventSubscriptionsByIdParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getEventSubscriptionsById * @summary: Get an event subscription * @description: Retrieves detailed information about a specific event subscription. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getEventSubscriptionsById/). */ getEventSubscriptionsById({ id, populate, requestHeaders }?: CommunicationPlatformApplicationValidator.GetEventSubscriptionsByIdParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetGlobalProvidersParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getGlobalProviders * @summary: Get global providers * @description: Retrieve a list of global communication providers associated with the sales channel.. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getGlobalProviders/). */ getGlobalProviders({ requestHeaders }?: any, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetGlobalVariablesParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name getGlobalVariables * @summary: Get all global variables * @description: Retrieves a list of communication global variables. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getGlobalVariables/). */ getGlobalVariables({ requestHeaders }?: any, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetJobLogsParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getJobLogs * @summary: Get logs of all campaign job * @description: Retrieve logs and details related to campaign jobs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getJobLogs/). */ getJobLogs({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobLogsParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetJobsParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getJobs * @summary: Get all campaign jobs * @description: Retrieves a list of campaign jobs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getJobs/). */ getJobs({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetJobsParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getNSampleRecordsFromCsv * @summary: Get N sample records of a CSV * @description: Retrieve a specified number of sample records from a CSV data source. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getNSampleRecordsFromCsv/). */ getNSampleRecordsFromCsv({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetNSampleRecordsFromCsvByGetParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getNSampleRecordsFromCsvByGet * @summary: Get N sample records of a CSV * @description: Retrieve a specified number of sample records from a CSV data source. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getNSampleRecordsFromCsvByGet/). */ getNSampleRecordsFromCsvByGet({ requestHeaders }?: any, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetOtpConfigurationParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getOtpConfiguration * @summary: Get configuration of otp * @description: Retrieves all configurations related to OTP. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getOtpConfiguration/). */ getOtpConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetSmsProviderByIdParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getSmsProviderById * @summary: Get a SMS provider * @description: Retrieve detailed information about a specific SMS communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSmsProviderById/). */ getSmsProviderById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProviderByIdParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetSmsProvidersParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getSmsProviders * @summary: Get all SMS providers * @description: Retrieves a list of SMS communication providers. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSmsProviders/). */ getSmsProviders({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsProvidersParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetSmsTemplateByIdParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getSmsTemplateById * @summary: Get a SMS template * @description: Retrieves detailed information about a specific SMS communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSmsTemplateById/). */ getSmsTemplateById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplateByIdParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetSmsTemplatesParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getSmsTemplates * @summary: Get all SMS templates * @description: Retrieve a list of all SMS communication templates. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSmsTemplates/). */ getSmsTemplates({ pageNo, pageSize, sort, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSmsTemplatesParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getStatsOfCampaignById * @summary: Get campaign statistics * @description: Retrieves statistical data for a specific a communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getStatsOfCampaignById/). */ getStatsOfCampaignById({ id, requestHeaders }?: CommunicationPlatformApplicationValidator.GetStatsOfCampaignByIdParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetSubscribedEmailTemplatesParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getSubscribedEmailTemplates * @summary: Get all subscribed email templates * @description: Retrieves a list of email communication templates that are subscribed to an event. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSubscribedEmailTemplates/). */ getSubscribedEmailTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedEmailTemplatesParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name getSubscribedSmsTemplates * @summary: Get all subscribed SMS templates * @description: Retrieve a list of SMS communication templates that are subscribed to an event. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSubscribedSmsTemplates/). */ getSubscribedSmsTemplates({ pageNo, pageSize, query, requestHeaders }?: CommunicationPlatformApplicationValidator.GetSubscribedSmsTemplatesParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetSystemEmailTemplatesParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name getSystemEmailTemplates * @summary: Get all system email templates * @description: Retrieves system-defined email communication templates. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSystemEmailTemplates/). */ getSystemEmailTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.GetSystemSmsTemplatesParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - * Success response * @name getSystemSmsTemplates * @summary: Gets all system SMS templates * @description: Retrieves system-defined SMS communication templates. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSystemSmsTemplates/). */ getSystemSmsTemplates({ requestHeaders }?: any, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.PostGlobalVariablesParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name postGlobalVariables * @summary: Create global variables * @description: Updates and creates communication global variables. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/postGlobalVariables/). */ postGlobalVariables({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.PostGlobalVariablesParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name sendCommunicationAsynchronously * @summary: Send communication asynchronously * @description: Sends communications to sellers with deffered delivery. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/sendCommunicationAsynchronously/). */ sendCommunicationAsynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationAsynchronouslyParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name sendCommunicationSynchronously * @summary: Send communication synchronously * @description: Sends real-time communications to sellers with immediate delivery. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/sendCommunicationSynchronously/). */ sendCommunicationSynchronously({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendCommunicationSynchronouslyParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.SendOtpParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name sendOtp * @summary: Send OTP * @description: Sends a one-time password (OTP) for authentication or verification. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/sendOtp/). */ sendOtp({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.SendOtpParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.TriggerCampaignJobParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name triggerCampaignJob * @summary: Trigger a campaign job * @description: Initiates a job to execute a communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/triggerCampaignJob/). */ triggerCampaignJob({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.TriggerCampaignJobParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.UpdateAppProvidersParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name updateAppProviders * @summary: Update application providers * @description: Modify provider configuration using provider object id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateAppProviders/). */ updateAppProviders({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAppProvidersParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.UpdateAudienceByIdParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name updateAudienceById * @summary: Update an audience * @description: Modify the configuration of a specific audience. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateAudienceById/). */ updateAudienceById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateAudienceByIdParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.UpdateCampaignByIdParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name updateCampaignById * @summary: Update a campaign * @description: Modify the configuration of a specific communication campaign. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateCampaignById/). */ updateCampaignById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateCampaignByIdParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.UpdateEmailProviderByIdParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name updateEmailProviderById * @summary: Update email provider * @description: Modifys the configurations of a specific email communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateEmailProviderById/). */ updateEmailProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateEmailProviderByIdParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.UpdateEmailTemplateByIdParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name updateEmailTemplateById * @summary: Update an email template * @description: Modifys the content and settings of a specific email communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateEmailTemplateById/). */ updateEmailTemplateById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateEmailTemplateByIdParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.UpdateOtpConfigurationParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name updateOtpConfiguration * @summary: Update configuration of otp * @description: Updates all configurations related to OTP. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateOtpConfiguration/). */ updateOtpConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name updateSmsProviderById * @summary: Update SMS provider * @description: Modifys the configurations of a specific SMS communication provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateSmsProviderById/). */ updateSmsProviderById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsProviderByIdParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.UpdateSmsTemplateByIdParam} arg * - Arg object * * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} - Success response * @name updateSmsTemplateById * @summary: Update a SMS template * @description: Modifys the content and settings of a specific SMS communication template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/updateSmsTemplateById/). */ updateSmsTemplateById({ id, body, requestHeaders }?: CommunicationPlatformApplicationValidator.UpdateSmsTemplateByIdParam, { responseHeaders }?: object): Promise; /** * @param {CommunicationPlatformApplicationValidator.VerfiyOtpParam} arg - Arg object * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}` * @param {import("../PlatformAPIClient").Options} - Options * @returns {Promise} * - Success response * * @name verfiyOtp * @summary: Verify OTP * @description: Verifies the one-time password (OTP) for authentication or verification. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/verfiyOtp/). */ verfiyOtp({ body, requestHeaders }?: CommunicationPlatformApplicationValidator.VerfiyOtpParam, { responseHeaders }?: object): Promise; } import CommunicationPlatformApplicationValidator = require("./CommunicationPlatformApplicationValidator"); import CommunicationPlatformModel = require("./CommunicationPlatformModel");