@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

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

@@ -8,6 +8,7 @@ declare class Communication {
      * @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
+     * @returns {Promise<Campaigns>} - Success response
      * @summary: Get campaigns
      * @description: Get campaigns
      */
@@ -15,7 +16,7 @@ declare class Communication {
         pageNo?: number;
         pageSize?: number;
         sort?: any;
-    }): Promise<any>;
+    }): Promise<Campaigns>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Company id
@@ -34,46 +35,51 @@ declare class Communication {
     /**
      * @param {Object} arg - Arg object.
      * @param {CampaignReq} arg.body
+     * @returns {Promise<Campaign>} - Success response
      * @summary: Create campaign
      * @description: Create campaign
      */
     createCampaign({ body }?: {
         body: CampaignReq;
-    }): Promise<any>;
+    }): Promise<Campaign>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Campaign id
+     * @returns {Promise<Campaign>} - Success response
      * @summary: Get campaign by id
      * @description: Get campaign by id
      */
     getCampaignById({ id }?: {
         id: string;
-    }): Promise<any>;
+    }): Promise<Campaign>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Campaign id
      * @param {CampaignReq} arg.body
+     * @returns {Promise<Campaign>} - Success response
      * @summary: Update campaign by id
      * @description: Update campaign by id
      */
     updateCampaignById({ id, body }?: {
         id: string;
         body: CampaignReq;
-    }): Promise<any>;
+    }): Promise<Campaign>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Campaign id
+     * @returns {Promise<GetStats>} - Success response
      * @summary: Get stats of campaign by id
      * @description: Get stats of campaign by id
      */
     getStatsOfCampaignById({ id }?: {
         id: string;
-    }): Promise<any>;
+    }): Promise<GetStats>;
     /**
      * @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
+     * @returns {Promise<Audiences>} - Success response
      * @summary: Get audiences
      * @description: Get audiences
      */
@@ -81,7 +87,7 @@ declare class Communication {
         pageNo?: number;
         pageSize?: number;
         sort?: any;
-    }): Promise<any>;
+    }): Promise<Audiences>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Company id
@@ -100,55 +106,61 @@ declare class Communication {
     /**
      * @param {Object} arg - Arg object.
      * @param {AudienceReq} arg.body
+     * @returns {Promise<Audience>} - Success response
      * @summary: Create audience
      * @description: Create audience
      */
     createAudience({ body }?: {
         body: AudienceReq;
-    }): Promise<any>;
+    }): Promise<Audience>;
     /**
      * @param {Object} arg - Arg object.
      * @param {BigqueryHeadersReq} arg.body
+     * @returns {Promise<BigqueryHeadersRes>} - Success response
      * @summary: Get bigquery headers
      * @description: Get bigquery headers
      */
     getBigqueryHeaders({ body }?: {
         body: BigqueryHeadersReq;
-    }): Promise<any>;
+    }): Promise<BigqueryHeadersRes>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Audience id
+     * @returns {Promise<Audience>} - Success response
      * @summary: Get audience by id
      * @description: Get audience by id
      */
     getAudienceById({ id }?: {
         id: string;
-    }): Promise<any>;
+    }): Promise<Audience>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Audience id
      * @param {AudienceReq} arg.body
+     * @returns {Promise<Audience>} - Success response
      * @summary: Update audience by id
      * @description: Update audience by id
      */
     updateAudienceById({ id, body }?: {
         id: string;
         body: AudienceReq;
-    }): Promise<any>;
+    }): Promise<Audience>;
     /**
      * @param {Object} arg - Arg object.
      * @param {GetNRecordsCsvReq} arg.body
+     * @returns {Promise<GetNRecordsCsvRes>} - Success response
      * @summary: Get n sample records from csv
      * @description: Get n sample records from csv
      */
     getNSampleRecordsFromCsv({ body }?: {
         body: GetNRecordsCsvReq;
-    }): Promise<any>;
+    }): Promise<GetNRecordsCsvRes>;
     /**
      * @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
+     * @returns {Promise<EmailProviders>} - Success response
      * @summary: Get email providers
      * @description: Get email providers
      */
@@ -156,7 +168,7 @@ declare class Communication {
         pageNo?: number;
         pageSize?: number;
         sort?: any;
-    }): Promise<any>;
+    }): Promise<EmailProviders>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Company id
@@ -175,37 +187,41 @@ declare class Communication {
     /**
      * @param {Object} arg - Arg object.
      * @param {EmailProviderReq} arg.body
+     * @returns {Promise<EmailProvider>} - Success response
      * @summary: Create email provider
      * @description: Create email provider
      */
     createEmailProvider({ body }?: {
         body: EmailProviderReq;
-    }): Promise<any>;
+    }): Promise<EmailProvider>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Email provider id
+     * @returns {Promise<EmailProvider>} - Success response
      * @summary: Get email provider by id
      * @description: Get email provider by id
      */
     getEmailProviderById({ id }?: {
         id: string;
-    }): Promise<any>;
+    }): Promise<EmailProvider>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Email provider id
      * @param {EmailProviderReq} arg.body
+     * @returns {Promise<EmailProvider>} - Success response
      * @summary: Update email provider by id
      * @description: Update email provider by id
      */
     updateEmailProviderById({ id, body }?: {
         id: string;
         body: EmailProviderReq;
-    }): Promise<any>;
+    }): Promise<EmailProvider>;
     /**
      * @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
+     * @returns {Promise<EmailTemplates>} - Success response
      * @summary: Get email templates
      * @description: Get email templates
      */
@@ -213,7 +229,7 @@ declare class Communication {
         pageNo?: number;
         pageSize?: number;
         sort?: any;
-    }): Promise<any>;
+    }): Promise<EmailTemplates>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Company id
@@ -232,17 +248,19 @@ declare class Communication {
     /**
      * @param {Object} arg - Arg object.
      * @param {EmailTemplateReq} arg.body
+     * @returns {Promise<EmailTemplateRes>} - Success response
      * @summary: Create email template
      * @description: Create email template
      */
     createEmailTemplate({ body }?: {
         body: EmailTemplateReq;
-    }): Promise<any>;
+    }): Promise<EmailTemplateRes>;
     /**
      * @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
+     * @returns {Promise<SystemEmailTemplates>} - Success response
      * @summary: Get system email templates
      * @description: Get system email templates
      */
@@ -250,7 +268,7 @@ declare class Communication {
         pageNo?: number;
         pageSize?: number;
         sort?: any;
-    }): Promise<any>;
+    }): Promise<SystemEmailTemplates>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Company id
@@ -269,55 +287,61 @@ declare class Communication {
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Email template id
+     * @returns {Promise<EmailTemplate>} - Success response
      * @summary: Get email template by id
      * @description: Get email template by id
      */
     getEmailTemplateById({ id }?: {
         id: string;
-    }): Promise<any>;
+    }): Promise<EmailTemplate>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Email template id
      * @param {EmailTemplateReq} arg.body
+     * @returns {Promise<EmailTemplateRes>} - Success response
      * @summary: Update email template by id
      * @description: Update email template by id
      */
     updateEmailTemplateById({ id, body }?: {
         id: string;
         body: EmailTemplateReq;
-    }): Promise<any>;
+    }): Promise<EmailTemplateRes>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Email template id
+     * @returns {Promise<EmailTemplateDeleteSuccessRes>} - Success response
      * @summary: Delete email template by id
      * @description: Delete email template by id
      */
     deleteEmailTemplateById({ id }?: {
         id: string;
-    }): Promise<any>;
+    }): Promise<EmailTemplateDeleteSuccessRes>;
     /**
      * @param {Object} arg - Arg object.
      * @param {EngineRequest} arg.body
+     * @returns {Promise<EngineResponse>} - Success response
      * @summary: Send email or sms synchronously
      * @description: Send email or sms synchronously
      */
     sendCommunicationSynchronously({ body }?: {
         body: EngineRequest;
-    }): Promise<any>;
+    }): Promise<EngineResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {EngineRequest} arg.body
+     * @returns {Promise<EngineResponse>} - Success response
      * @summary: Send email or sms asynchronously
      * @description: Send email or sms asynchronously
      */
     sendCommunicationAsynchronously({ body }?: {
         body: EngineRequest;
-    }): Promise<any>;
+    }): Promise<EngineResponse>;
     /**
      * @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
+     * @returns {Promise<EventSubscriptions>} - Success response
      * @summary: Get event subscriptions
      * @description: Get event subscriptions
      */
@@ -325,7 +349,7 @@ declare class Communication {
         pageNo?: number;
         pageSize?: number;
         populate?: string;
-    }): Promise<any>;
+    }): Promise<EventSubscriptions>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Company id
@@ -346,6 +370,7 @@ declare class Communication {
      * @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
+     * @returns {Promise<Jobs>} - Success response
      * @summary: Get jobs
      * @description: Get jobs
      */
@@ -353,7 +378,7 @@ declare class Communication {
         pageNo?: number;
         pageSize?: number;
         sort?: any;
-    }): Promise<any>;
+    }): Promise<Jobs>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Company id
@@ -372,17 +397,19 @@ declare class Communication {
     /**
      * @param {Object} arg - Arg object.
      * @param {TriggerJobRequest} arg.body
+     * @returns {Promise<TriggerJobResponse>} - Success response
      * @summary: Trigger campaign job
      * @description: Trigger campaign job
      */
     triggerCampaignJob({ body }?: {
         body: TriggerJobRequest;
-    }): Promise<any>;
+    }): Promise<TriggerJobResponse>;
     /**
      * @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
+     * @returns {Promise<JobLogs>} - Success response
      * @summary: Get job logs
      * @description: Get job logs
      */
@@ -390,7 +417,7 @@ declare class Communication {
         pageNo?: number;
         pageSize?: number;
         sort?: any;
-    }): Promise<any>;
+    }): Promise<JobLogs>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Company id
@@ -412,6 +439,7 @@ declare class Communication {
      * @param {number} [arg.pageSize] - Current request items count
      * @param {Object} [arg.sort] - To sort based on _id
      * @param {Object} [arg.query] -
+     * @returns {Promise<Logs>} - Success response
      * @summary: Get communication logs
      * @description: Get communication logs
      */
@@ -420,7 +448,7 @@ declare class Communication {
         pageSize?: number;
         sort?: any;
         query?: any;
-    }): Promise<any>;
+    }): Promise<Logs>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Company id
@@ -441,26 +469,29 @@ declare class Communication {
     /**
      * @param {Object} arg - Arg object.
      * @param {SendOtpCommsReq} arg.body
+     * @returns {Promise<SendOtpCommsRes>} - Success response
      * @summary: Send OTP using email and sms
      * @description: Send OTP Comms via email and sms
      */
     sendOtp({ body }?: {
         body: SendOtpCommsReq;
-    }): Promise<any>;
+    }): Promise<SendOtpCommsRes>;
     /**
      * @param {Object} arg - Arg object.
      * @param {VerifyOtpCommsReq} arg.body
+     * @returns {Promise<VerifyOtpCommsSuccessRes>} - Success response
      * @summary: Verify OTP sent via email and sms
      * @description: Verify OTP sent via email and sms
      */
     verfiyOtp({ body }?: {
         body: VerifyOtpCommsReq;
-    }): Promise<any>;
+    }): Promise<VerifyOtpCommsSuccessRes>;
     /**
      * @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
+     * @returns {Promise<SmsProviders>} - Success response
      * @summary: Get sms providers
      * @description: Get sms providers
      */
@@ -468,7 +499,7 @@ declare class Communication {
         pageNo?: number;
         pageSize?: number;
         sort?: any;
-    }): Promise<any>;
+    }): Promise<SmsProviders>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Company id
@@ -487,37 +518,41 @@ declare class Communication {
     /**
      * @param {Object} arg - Arg object.
      * @param {SmsProviderReq} arg.body
+     * @returns {Promise<SmsProvider>} - Success response
      * @summary: Create sms provider
      * @description: Create sms provider
      */
     createSmsProvider({ body }?: {
         body: SmsProviderReq;
-    }): Promise<any>;
+    }): Promise<SmsProvider>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Sms provider id
+     * @returns {Promise<SmsProvider>} - Success response
      * @summary: Get sms provider by id
      * @description: Get sms provider by id
      */
     getSmsProviderById({ id }?: {
         id: string;
-    }): Promise<any>;
+    }): Promise<SmsProvider>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Sms provider id
      * @param {SmsProviderReq} arg.body
+     * @returns {Promise<SmsProvider>} - Success response
      * @summary: Update sms provider by id
      * @description: Update sms provider by id
      */
     updateSmsProviderById({ id, body }?: {
         id: string;
         body: SmsProviderReq;
-    }): Promise<any>;
+    }): Promise<SmsProvider>;
     /**
      * @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
+     * @returns {Promise<SmsTemplates>} - Success response
      * @summary: Get sms templates
      * @description: Get sms templates
      */
@@ -525,7 +560,7 @@ declare class Communication {
         pageNo?: number;
         pageSize?: number;
         sort?: any;
-    }): Promise<any>;
+    }): Promise<SmsTemplates>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Company id
@@ -544,46 +579,51 @@ declare class Communication {
     /**
      * @param {Object} arg - Arg object.
      * @param {SmsTemplateReq} arg.body
+     * @returns {Promise<SmsTemplateRes>} - Success response
      * @summary: Create sms template
      * @description: Create sms template
      */
     createSmsTemplate({ body }?: {
         body: SmsTemplateReq;
-    }): Promise<any>;
+    }): Promise<SmsTemplateRes>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Sms template id
+     * @returns {Promise<SmsTemplate>} - Success response
      * @summary: Get sms template by id
      * @description: Get sms template by id
      */
     getSmsTemplateById({ id }?: {
         id: string;
-    }): Promise<any>;
+    }): Promise<SmsTemplate>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Sms template id
      * @param {SmsTemplateReq} arg.body
+     * @returns {Promise<SmsTemplateRes>} - Success response
      * @summary: Update sms template by id
      * @description: Update sms template by id
      */
     updateSmsTemplateById({ id, body }?: {
         id: string;
         body: SmsTemplateReq;
-    }): Promise<any>;
+    }): Promise<SmsTemplateRes>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Sms template id
+     * @returns {Promise<SmsTemplateDeleteSuccessRes>} - Success response
      * @summary: Delete sms template by id
      * @description: Delete sms template by id
      */
     deleteSmsTemplateById({ id }?: {
         id: string;
-    }): Promise<any>;
+    }): Promise<SmsTemplateDeleteSuccessRes>;
     /**
      * @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
+     * @returns {Promise<SystemSmsTemplates>} - Success response
      * @summary: Get system sms templates
      * @description: Get system sms templates
      */
@@ -591,7 +631,7 @@ declare class Communication {
         pageNo?: number;
         pageSize?: number;
         sort?: any;
-    }): Promise<any>;
+    }): Promise<SystemSmsTemplates>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Company id