@gofynd/fdk-client-javascript 0.1.36 → 1.0.0

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

@@ -0,0 +1,611 @@
+export = Communication;
+declare class Communication {
+    constructor(config: any, applicationId: any);
+    config: any;
+    applicationId: any;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageNo] - Current page no
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {Object} [arg.sort] - To sort based on created_at
+     * @summary: Get campaigns
+     * @description: Get campaigns
+     */
+    getCampaigns({ pageNo, pageSize, sort }?: {
+        pageNo?: number;
+        pageSize?: number;
+        sort?: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.companyId - Company id
+     * @param {string} arg.applicationId - Application id
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {Object} [arg.sort] - To sort based on created_at
+     * @summary: Get campaigns
+     * @description: Get campaigns
+     */
+    getCampaignsPaginator({ companyId, applicationId, pageSize, sort }?: {
+        companyId: string;
+        applicationId: string;
+        pageSize?: number;
+        sort?: any;
+    }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {CampaignReq} arg.body
+     * @summary: Create campaign
+     * @description: Create campaign
+     */
+    createCampaign({ body }?: {
+        body: CampaignReq;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Campaign id
+     * @summary: Get campaign by id
+     * @description: Get campaign by id
+     */
+    getCampaignById({ id }?: {
+        id: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Campaign id
+     * @param {CampaignReq} arg.body
+     * @summary: Update campaign by id
+     * @description: Update campaign by id
+     */
+    updateCampaignById({ id, body }?: {
+        id: string;
+        body: CampaignReq;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Campaign id
+     * @summary: Get stats of campaign by id
+     * @description: Get stats of campaign by id
+     */
+    getStatsOfCampaignById({ id }?: {
+        id: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageNo] - Current page no
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {Object} [arg.sort] - To sort based on created_at
+     * @summary: Get audiences
+     * @description: Get audiences
+     */
+    getAudiences({ pageNo, pageSize, sort }?: {
+        pageNo?: number;
+        pageSize?: number;
+        sort?: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.companyId - Company id
+     * @param {string} arg.applicationId - Application id
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {Object} [arg.sort] - To sort based on created_at
+     * @summary: Get audiences
+     * @description: Get audiences
+     */
+    getAudiencesPaginator({ companyId, applicationId, pageSize, sort }?: {
+        companyId: string;
+        applicationId: string;
+        pageSize?: number;
+        sort?: any;
+    }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {AudienceReq} arg.body
+     * @summary: Create audience
+     * @description: Create audience
+     */
+    createAudience({ body }?: {
+        body: AudienceReq;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {BigqueryHeadersReq} arg.body
+     * @summary: Get bigquery headers
+     * @description: Get bigquery headers
+     */
+    getBigqueryHeaders({ body }?: {
+        body: BigqueryHeadersReq;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Audience id
+     * @summary: Get audience by id
+     * @description: Get audience by id
+     */
+    getAudienceById({ id }?: {
+        id: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Audience id
+     * @param {AudienceReq} arg.body
+     * @summary: Update audience by id
+     * @description: Update audience by id
+     */
+    updateAudienceById({ id, body }?: {
+        id: string;
+        body: AudienceReq;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {GetNRecordsCsvReq} arg.body
+     * @summary: Get n sample records from csv
+     * @description: Get n sample records from csv
+     */
+    getNSampleRecordsFromCsv({ body }?: {
+        body: GetNRecordsCsvReq;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageNo] - Current page no
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {Object} [arg.sort] - To sort based on created_at
+     * @summary: Get email providers
+     * @description: Get email providers
+     */
+    getEmailProviders({ pageNo, pageSize, sort }?: {
+        pageNo?: number;
+        pageSize?: number;
+        sort?: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.companyId - Company id
+     * @param {string} arg.applicationId - Application id
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {Object} [arg.sort] - To sort based on created_at
+     * @summary: Get email providers
+     * @description: Get email providers
+     */
+    getEmailProvidersPaginator({ companyId, applicationId, pageSize, sort, }?: {
+        companyId: string;
+        applicationId: string;
+        pageSize?: number;
+        sort?: any;
+    }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {EmailProviderReq} arg.body
+     * @summary: Create email provider
+     * @description: Create email provider
+     */
+    createEmailProvider({ body }?: {
+        body: EmailProviderReq;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Email provider id
+     * @summary: Get email provider by id
+     * @description: Get email provider by id
+     */
+    getEmailProviderById({ id }?: {
+        id: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Email provider id
+     * @param {EmailProviderReq} arg.body
+     * @summary: Update email provider by id
+     * @description: Update email provider by id
+     */
+    updateEmailProviderById({ id, body }?: {
+        id: string;
+        body: EmailProviderReq;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageNo] - Current page no
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {Object} [arg.sort] - To sort based on created_at
+     * @summary: Get email templates
+     * @description: Get email templates
+     */
+    getEmailTemplates({ pageNo, pageSize, sort }?: {
+        pageNo?: number;
+        pageSize?: number;
+        sort?: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.companyId - Company id
+     * @param {string} arg.applicationId - Application id
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {Object} [arg.sort] - To sort based on created_at
+     * @summary: Get email templates
+     * @description: Get email templates
+     */
+    getEmailTemplatesPaginator({ companyId, applicationId, pageSize, sort, }?: {
+        companyId: string;
+        applicationId: string;
+        pageSize?: number;
+        sort?: any;
+    }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {EmailTemplateReq} arg.body
+     * @summary: Create email template
+     * @description: Create email template
+     */
+    createEmailTemplate({ body }?: {
+        body: EmailTemplateReq;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageNo] - Current page no
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {Object} [arg.sort] - To sort based on created_at
+     * @summary: Get system email templates
+     * @description: Get system email templates
+     */
+    getSystemEmailTemplates({ pageNo, pageSize, sort }?: {
+        pageNo?: number;
+        pageSize?: number;
+        sort?: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.companyId - Company id
+     * @param {string} arg.applicationId - Application id
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {Object} [arg.sort] - To sort based on created_at
+     * @summary: Get system email templates
+     * @description: Get system email templates
+     */
+    getSystemEmailTemplatesPaginator({ companyId, applicationId, pageSize, sort, }?: {
+        companyId: string;
+        applicationId: string;
+        pageSize?: number;
+        sort?: any;
+    }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Email template id
+     * @summary: Get email template by id
+     * @description: Get email template by id
+     */
+    getEmailTemplateById({ id }?: {
+        id: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Email template id
+     * @param {EmailTemplateReq} arg.body
+     * @summary: Update email template by id
+     * @description: Update email template by id
+     */
+    updateEmailTemplateById({ id, body }?: {
+        id: string;
+        body: EmailTemplateReq;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Email template id
+     * @summary: Delete email template by id
+     * @description: Delete email template by id
+     */
+    deleteEmailTemplateById({ id }?: {
+        id: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {EngineRequest} arg.body
+     * @summary: Send email or sms synchronously
+     * @description: Send email or sms synchronously
+     */
+    sendCommunicationSynchronously({ body }?: {
+        body: EngineRequest;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {EngineRequest} arg.body
+     * @summary: Send email or sms asynchronously
+     * @description: Send email or sms asynchronously
+     */
+    sendCommunicationAsynchronously({ body }?: {
+        body: EngineRequest;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageNo] - Current page no
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {string} [arg.populate] - Populate fields
+     * @summary: Get event subscriptions
+     * @description: Get event subscriptions
+     */
+    getEventSubscriptions({ pageNo, pageSize, populate }?: {
+        pageNo?: number;
+        pageSize?: number;
+        populate?: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.companyId - Company id
+     * @param {string} arg.applicationId - Application id
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {string} [arg.populate] - Populate fields
+     * @summary: Get event subscriptions
+     * @description: Get event subscriptions
+     */
+    getEventSubscriptionsPaginator({ companyId, applicationId, pageSize, populate, }?: {
+        companyId: string;
+        applicationId: string;
+        pageSize?: number;
+        populate?: string;
+    }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageNo] - Current page no
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {Object} [arg.sort] - To sort based on created_at
+     * @summary: Get jobs
+     * @description: Get jobs
+     */
+    getJobs({ pageNo, pageSize, sort }?: {
+        pageNo?: number;
+        pageSize?: number;
+        sort?: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.companyId - Company id
+     * @param {string} arg.applicationId - Application id
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {Object} [arg.sort] - To sort based on created_at
+     * @summary: Get jobs
+     * @description: Get jobs
+     */
+    getJobsPaginator({ companyId, applicationId, pageSize, sort }?: {
+        companyId: string;
+        applicationId: string;
+        pageSize?: number;
+        sort?: any;
+    }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {TriggerJobRequest} arg.body
+     * @summary: Trigger campaign job
+     * @description: Trigger campaign job
+     */
+    triggerCampaignJob({ body }?: {
+        body: TriggerJobRequest;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageNo] - Current page no
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {Object} [arg.sort] - To sort based on created_at
+     * @summary: Get job logs
+     * @description: Get job logs
+     */
+    getJobLogs({ pageNo, pageSize, sort }?: {
+        pageNo?: number;
+        pageSize?: number;
+        sort?: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.companyId - Company id
+     * @param {string} arg.applicationId - Application id
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {Object} [arg.sort] - To sort based on created_at
+     * @summary: Get job logs
+     * @description: Get job logs
+     */
+    getJobLogsPaginator({ companyId, applicationId, pageSize, sort }?: {
+        companyId: string;
+        applicationId: string;
+        pageSize?: number;
+        sort?: any;
+    }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.pageId] - Current page no
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {Object} [arg.sort] - To sort based on _id
+     * @param {Object} [arg.query] -
+     * @summary: Get communication logs
+     * @description: Get communication logs
+     */
+    getCommunicationLogs({ pageId, pageSize, sort, query }?: {
+        pageId?: string;
+        pageSize?: number;
+        sort?: any;
+        query?: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.companyId - Company id
+     * @param {string} arg.applicationId - Application id
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {Object} [arg.sort] - To sort based on _id
+     * @param {Object} [arg.query] -
+     * @summary: Get communication logs
+     * @description: Get communication logs
+     */
+    getCommunicationLogsPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
+        companyId: string;
+        applicationId: string;
+        pageSize?: number;
+        sort?: any;
+        query?: any;
+    }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {SendOtpCommsReq} arg.body
+     * @summary: Send OTP using email and sms
+     * @description: Send OTP Comms via email and sms
+     */
+    sendOtp({ body }?: {
+        body: SendOtpCommsReq;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {VerifyOtpCommsReq} arg.body
+     * @summary: Verify OTP sent via email and sms
+     * @description: Verify OTP sent via email and sms
+     */
+    verfiyOtp({ body }?: {
+        body: VerifyOtpCommsReq;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageNo] - Current page no
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {Object} [arg.sort] - To sort based on created_at
+     * @summary: Get sms providers
+     * @description: Get sms providers
+     */
+    getSmsProviders({ pageNo, pageSize, sort }?: {
+        pageNo?: number;
+        pageSize?: number;
+        sort?: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.companyId - Company id
+     * @param {string} arg.applicationId - Application id
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {Object} [arg.sort] - To sort based on created_at
+     * @summary: Get sms providers
+     * @description: Get sms providers
+     */
+    getSmsProvidersPaginator({ companyId, applicationId, pageSize, sort }?: {
+        companyId: string;
+        applicationId: string;
+        pageSize?: number;
+        sort?: any;
+    }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {SmsProviderReq} arg.body
+     * @summary: Create sms provider
+     * @description: Create sms provider
+     */
+    createSmsProvider({ body }?: {
+        body: SmsProviderReq;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Sms provider id
+     * @summary: Get sms provider by id
+     * @description: Get sms provider by id
+     */
+    getSmsProviderById({ id }?: {
+        id: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Sms provider id
+     * @param {SmsProviderReq} arg.body
+     * @summary: Update sms provider by id
+     * @description: Update sms provider by id
+     */
+    updateSmsProviderById({ id, body }?: {
+        id: string;
+        body: SmsProviderReq;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageNo] - Current page no
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {Object} [arg.sort] - To sort based on created_at
+     * @summary: Get sms templates
+     * @description: Get sms templates
+     */
+    getSmsTemplates({ pageNo, pageSize, sort }?: {
+        pageNo?: number;
+        pageSize?: number;
+        sort?: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.companyId - Company id
+     * @param {string} arg.applicationId - Application id
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {Object} [arg.sort] - To sort based on created_at
+     * @summary: Get sms templates
+     * @description: Get sms templates
+     */
+    getSmsTemplatesPaginator({ companyId, applicationId, pageSize, sort }?: {
+        companyId: string;
+        applicationId: string;
+        pageSize?: number;
+        sort?: any;
+    }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {SmsTemplateReq} arg.body
+     * @summary: Create sms template
+     * @description: Create sms template
+     */
+    createSmsTemplate({ body }?: {
+        body: SmsTemplateReq;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Sms template id
+     * @summary: Get sms template by id
+     * @description: Get sms template by id
+     */
+    getSmsTemplateById({ id }?: {
+        id: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Sms template id
+     * @param {SmsTemplateReq} arg.body
+     * @summary: Update sms template by id
+     * @description: Update sms template by id
+     */
+    updateSmsTemplateById({ id, body }?: {
+        id: string;
+        body: SmsTemplateReq;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Sms template id
+     * @summary: Delete sms template by id
+     * @description: Delete sms template by id
+     */
+    deleteSmsTemplateById({ id }?: {
+        id: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageNo] - Current page no
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {Object} [arg.sort] - To sort based on created_at
+     * @summary: Get system sms templates
+     * @description: Get system sms templates
+     */
+    getSystemSystemTemplates({ pageNo, pageSize, sort }?: {
+        pageNo?: number;
+        pageSize?: number;
+        sort?: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.companyId - Company id
+     * @param {string} arg.applicationId - Application id
+     * @param {number} [arg.pageSize] - Current request items count
+     * @param {Object} [arg.sort] - To sort based on created_at
+     * @summary: Get system sms templates
+     * @description: Get system sms templates
+     */
+    getSystemSystemTemplatesPaginator({ companyId, applicationId, pageSize, sort, }?: {
+        companyId: string;
+        applicationId: string;
+        pageSize?: number;
+        sort?: any;
+    }): Paginator;
+}
+import Paginator = require("../../common/Paginator");