@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/platform/Communication/CommunicationPlatformModel.js

@@ -1,6 +1,865 @@
 const Joi = require("joi");
 
-class CommunicationModel {
+/**
+ * @typedef Audience
+ * @property {number} [__v]
+ * @property {string} [_id]
+ * @property {string} [application]
+ * @property {string} [created_at]
+ * @property {string} [description]
+ * @property {string} [file_url]
+ * @property {string[]} [headers]
+ * @property {boolean} [is_active]
+ * @property {string} [name]
+ * @property {number} [records_count]
+ * @property {string} [slug]
+ * @property {string[]} [tags]
+ * @property {string} [type]
+ * @property {string} [updated_at]
+ */
+
+/**
+ * @typedef AudienceReq
+ * @property {string} [application]
+ * @property {string} [description]
+ * @property {string} [file_url]
+ * @property {string[]} [headers]
+ * @property {boolean} [is_active]
+ * @property {string} [name]
+ * @property {number} [records_count]
+ * @property {string[]} [tags]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef Audiences
+ * @property {Audience[]} [items]
+ * @property {Page} [page]
+ */
+
+/**
+ * @typedef BadRequestSchema
+ * @property {string} [message] - Failure message.
+ * @property {string} [status] - Response status.
+ */
+
+/**
+ * @typedef BigqueryHeadersReq
+ * @property {string} [query]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef BigqueryHeadersRes
+ * @property {BigqueryHeadersResHeaders[]} [headers]
+ */
+
+/**
+ * @typedef BigqueryHeadersResHeaders
+ * @property {string} [name]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef Campaign
+ * @property {number} [__v]
+ * @property {string} [_id]
+ * @property {string} [application]
+ * @property {string} [created_at]
+ * @property {string} [datasource]
+ * @property {string} [description]
+ * @property {CampaignEmail} [email]
+ * @property {boolean} [is_active]
+ * @property {string} [name]
+ * @property {RecipientHeaders} [recipient_headers]
+ * @property {string} [slug]
+ * @property {Object[]} [tags]
+ * @property {string} [type]
+ * @property {string} [updated_at]
+ */
+
+/**
+ * @typedef CampaignEmail
+ * @property {CampignEmailProvider} [provider]
+ * @property {CampaignEmailTemplate} [template]
+ */
+
+/**
+ * @typedef CampaignEmailTemplate
+ * @property {string} [key]
+ * @property {string} [value]
+ */
+
+/**
+ * @typedef CampaignReq
+ * @property {string} [application]
+ * @property {string} [description]
+ * @property {string} [file_url]
+ * @property {string[]} [headers]
+ * @property {boolean} [is_active]
+ * @property {string} [name]
+ * @property {number} [records_count]
+ * @property {string[]} [tags]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef Campaigns
+ * @property {Campaign[]} [items]
+ * @property {Page} [page]
+ */
+
+/**
+ * @typedef CampignEmailProvider
+ * @property {string} [_id]
+ * @property {string} [from_email]
+ * @property {string} [from_name]
+ */
+
+/**
+ * @typedef EmailProvider
+ * @property {number} [__v]
+ * @property {string} [_id]
+ * @property {string} [api_key]
+ * @property {string} [application]
+ * @property {string} [created_at]
+ * @property {string} [description]
+ * @property {EmailProviderReqFrom[]} [from_address]
+ * @property {string} [name]
+ * @property {string} [provider]
+ * @property {string} [slug]
+ * @property {string} [type]
+ * @property {string} [updated_at]
+ */
+
+/**
+ * @typedef EmailProviderReq
+ * @property {string} [api_key]
+ * @property {string} [description]
+ * @property {EmailProviderReqFrom[]} [from_address]
+ * @property {string} [name]
+ * @property {string} [provider]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef EmailProviderReqFrom
+ * @property {string} [email]
+ * @property {boolean} [is_default]
+ * @property {string} [name]
+ */
+
+/**
+ * @typedef EmailProviders
+ * @property {EmailProvider[]} [items]
+ * @property {Page} [page]
+ */
+
+/**
+ * @typedef EmailTemplate
+ * @property {number} [__v]
+ * @property {string} [_id]
+ * @property {Object[]} [attachments]
+ * @property {string} [created_at]
+ * @property {string} [description]
+ * @property {string} [from_name]
+ * @property {Object[]} [headers]
+ * @property {TemplateAndType} [html]
+ * @property {boolean} [is_internal]
+ * @property {boolean} [is_system]
+ * @property {string} [name]
+ * @property {string} [priority]
+ * @property {boolean} [published]
+ * @property {string} [slug]
+ * @property {Object[]} [static_bcc]
+ * @property {Object[]} [static_cc]
+ * @property {Object[]} [static_to]
+ * @property {TemplateAndType} [subject]
+ * @property {Object[]} [tags]
+ * @property {TemplateAndType} [text]
+ * @property {string} [updated_at]
+ */
+
+/**
+ * @typedef EmailTemplateDeleteFailureRes
+ * @property {string} [message]
+ * @property {boolean} [success]
+ */
+
+/**
+ * @typedef EmailTemplateDeleteSuccessRes
+ * @property {string} [message]
+ * @property {boolean} [success]
+ */
+
+/**
+ * @typedef EmailTemplateHeaders
+ * @property {string} [key]
+ * @property {string} [value]
+ */
+
+/**
+ * @typedef EmailTemplateKeys
+ * @property {string} [bcc]
+ * @property {string} [cc]
+ * @property {string} [to]
+ */
+
+/**
+ * @typedef EmailTemplateReq
+ * @property {Object[]} [attachments]
+ * @property {string} [description]
+ * @property {EmailTemplateHeaders[]} [headers]
+ * @property {TemplateAndType} [html]
+ * @property {EmailTemplateKeys} [keys]
+ * @property {string} [name]
+ * @property {string} [priority]
+ * @property {string} [reply_to]
+ * @property {string[]} [static_bcc]
+ * @property {string[]} [static_cc]
+ * @property {string[]} [static_to]
+ * @property {TemplateAndType} [subject]
+ * @property {TemplateAndType} [text]
+ */
+
+/**
+ * @typedef EmailTemplateRes
+ * @property {number} [__v]
+ * @property {string} [_id]
+ * @property {Object[]} [attachments]
+ * @property {string} [created_at]
+ * @property {string} [description]
+ * @property {EmailTemplateHeaders[]} [headers]
+ * @property {TemplateAndType} [html]
+ * @property {boolean} [is_internal]
+ * @property {boolean} [is_system]
+ * @property {EmailTemplateKeys} [keys]
+ * @property {string} [name]
+ * @property {string} [priority]
+ * @property {boolean} [published]
+ * @property {string} [reply_to]
+ * @property {string} [slug]
+ * @property {string[]} [static_bcc]
+ * @property {string[]} [static_cc]
+ * @property {string[]} [static_to]
+ * @property {TemplateAndType} [subject]
+ * @property {Object[]} [tags]
+ * @property {TemplateAndType} [text]
+ * @property {string} [updated_at]
+ */
+
+/**
+ * @typedef EmailTemplates
+ * @property {EmailTemplate[]} [items]
+ * @property {Page} [page]
+ */
+
+/**
+ * @typedef EngineRequest
+ * @property {MetaStructure} [meta]
+ * @property {PayloadStructure} [payload]
+ */
+
+/**
+ * @typedef EngineResponse
+ * @property {boolean} [success]
+ */
+
+/**
+ * @typedef EventSubscription
+ * @property {number} [__v]
+ * @property {string} [_id]
+ * @property {string} [application]
+ * @property {string} [created_at]
+ * @property {string} [event]
+ * @property {boolean} [is_default]
+ * @property {string} [slug]
+ * @property {EventSubscriptionTemplate} [template]
+ * @property {string} [updated_at]
+ */
+
+/**
+ * @typedef EventSubscriptions
+ * @property {EventSubscription[]} [items]
+ * @property {Page} [page]
+ */
+
+/**
+ * @typedef EventSubscriptionTemplate
+ * @property {EventSubscriptionTemplateEmail} [email]
+ * @property {EventSubscriptionTemplateSms} [sms]
+ */
+
+/**
+ * @typedef EventSubscriptionTemplateEmail
+ * @property {boolean} [subscribed]
+ * @property {string} [template]
+ */
+
+/**
+ * @typedef EventSubscriptionTemplateSms
+ * @property {boolean} [subscribed]
+ * @property {string} [template]
+ */
+
+/**
+ * @typedef GetNRecordsCsvReq
+ * @property {number} [count]
+ * @property {boolean} [header]
+ * @property {string} [url]
+ */
+
+/**
+ * @typedef GetNRecordsCsvRes
+ * @property {GetNRecordsCsvResItems[]} [items]
+ */
+
+/**
+ * @typedef GetNRecordsCsvResItems
+ * @property {string} [email]
+ * @property {string} [firstname]
+ * @property {string} [lastname]
+ * @property {string} [orderid]
+ * @property {string} [phone_number]
+ */
+
+/**
+ * @typedef GetStats
+ * @property {Stats[]} [items]
+ */
+
+/**
+ * @typedef Job
+ * @property {number} [__v]
+ * @property {string} [_id]
+ * @property {string} [application]
+ * @property {string} [campaign]
+ * @property {boolean} [completed]
+ * @property {string} [created_at]
+ * @property {boolean} [is_active]
+ * @property {string} [updated_at]
+ */
+
+/**
+ * @typedef JobLog
+ * @property {number} [__v]
+ * @property {string} [_id]
+ * @property {string} [campaign]
+ * @property {string} [created_at]
+ * @property {Object} [imported]
+ * @property {string} [job]
+ * @property {Object} [processed]
+ * @property {string} [updated_at]
+ */
+
+/**
+ * @typedef JobLogs
+ * @property {JobLog[]} [items]
+ * @property {Page} [page]
+ */
+
+/**
+ * @typedef Jobs
+ * @property {Job[]} [items]
+ * @property {Page} [page]
+ */
+
+/**
+ * @typedef Log
+ * @property {string} [_id]
+ * @property {string} [application]
+ * @property {string} [channel_type]
+ * @property {string} [created_at]
+ * @property {Object} [data]
+ * @property {LogEmail} [email]
+ * @property {string} [expire_at]
+ * @property {LogMeta} [meta]
+ * @property {LogPushnotification} [pushnotification]
+ * @property {string} [service]
+ * @property {string} [source]
+ * @property {string} [status]
+ * @property {string} [step]
+ */
+
+/**
+ * @typedef LogEmail
+ * @property {string} [template]
+ */
+
+/**
+ * @typedef LogMeta
+ * @property {string} [identifier]
+ * @property {string} [key]
+ * @property {string} [offset]
+ * @property {string} [partition]
+ * @property {string} [topic]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef LogPushnotification
+ * @property {string[]} [pushtokens]
+ */
+
+/**
+ * @typedef Logs
+ * @property {Log[]} [items]
+ * @property {Page} [page]
+ */
+
+/**
+ * @typedef MetaStructure
+ * @property {string} [action]
+ * @property {string} [job_type]
+ * @property {string} [timestamp]
+ * @property {string} [trace]
+ */
+
+/**
+ * @typedef NotFound
+ * @property {string} [message] - Failure message.
+ */
+
+/**
+ * @typedef Notification
+ * @property {string} [body]
+ * @property {string} [click_action]
+ * @property {string} [deeplink]
+ * @property {string} [icon]
+ * @property {string} [subtitle]
+ * @property {string} [title]
+ */
+
+/**
+ * @typedef Page
+ * @property {number} [current]
+ * @property {boolean} [has_next]
+ * @property {boolean} [has_previous]
+ * @property {number} [item_total]
+ * @property {string} [next_id]
+ * @property {number} [size]
+ * @property {string} type
+ */
+
+/**
+ * @typedef PayloadEmailProviderStructure
+ * @property {string} [_id]
+ */
+
+/**
+ * @typedef PayloadEmailStructure
+ * @property {PayloadEmailProviderStructure} [provider]
+ * @property {PayloadEmailTemplateStructure} [template]
+ */
+
+/**
+ * @typedef PayloadEmailTemplateStructure
+ * @property {string} [key]
+ * @property {Object} [value]
+ */
+
+/**
+ * @typedef PayloadSmsProviderStructure
+ * @property {string} [_id]
+ */
+
+/**
+ * @typedef PayloadSmsStructure
+ * @property {PayloadSmsProviderStructure} [provider]
+ * @property {PayloadSmsTemplateStructure} [template]
+ */
+
+/**
+ * @typedef PayloadSmsTemplateStructure
+ * @property {string} [key]
+ * @property {Object} [value]
+ */
+
+/**
+ * @typedef PayloadStructure
+ * @property {string} [application]
+ * @property {Object[]} [data]
+ * @property {PayloadEmailStructure} [email]
+ * @property {PayloadSmsStructure} [sms]
+ */
+
+/**
+ * @typedef PushtokenReq
+ * @property {string} [action]
+ * @property {string} [bundle_identifier]
+ * @property {string} [push_token]
+ * @property {string} [unique_device_id]
+ */
+
+/**
+ * @typedef PushtokenRes
+ * @property {string} [_id]
+ * @property {string} [application_id]
+ * @property {string} [bundle_identifier]
+ * @property {string} [created_at]
+ * @property {string} [expired_at]
+ * @property {string} [platform]
+ * @property {string} [push_token]
+ * @property {string} [type]
+ * @property {string} [unique_device_id]
+ * @property {string} [updated_at]
+ * @property {string} [user_id]
+ */
+
+/**
+ * @typedef RecipientHeaders
+ * @property {string} [email]
+ */
+
+/**
+ * @typedef SendOtpCommsReq
+ * @property {SendOtpCommsReqData} [data]
+ * @property {SendOtpCommsReqEmail} [email]
+ * @property {SendOtpCommsReqSms} [sms]
+ */
+
+/**
+ * @typedef SendOtpCommsReqData
+ * @property {string} [country_code]
+ * @property {string} [mobile]
+ * @property {boolean} [send_same_otp_to_channel]
+ * @property {string} [to]
+ */
+
+/**
+ * @typedef SendOtpCommsReqEmail
+ * @property {number} [expiry]
+ * @property {number} [otp_length]
+ * @property {SendOtpEmailCommsProvider} [provider]
+ * @property {SendOtpEmailCommsTemplate} [template]
+ */
+
+/**
+ * @typedef SendOtpCommsReqSms
+ * @property {number} [expiry]
+ * @property {number} [otp_length]
+ * @property {SendOtpSmsCommsProvider} [provider]
+ * @property {SendOtpSmsCommsTemplate} [template]
+ */
+
+/**
+ * @typedef SendOtpCommsRes
+ * @property {SendOtpCommsResEmail} [email]
+ * @property {SendOtpCommsResSms} [sms]
+ */
+
+/**
+ * @typedef SendOtpCommsResEmail
+ * @property {string} [message]
+ * @property {string} [request_id]
+ * @property {number} [resend_timer]
+ * @property {boolean} [success]
+ * @property {string} [to]
+ */
+
+/**
+ * @typedef SendOtpCommsResSms
+ * @property {string} [country_code]
+ * @property {string} [message]
+ * @property {string} [mobile]
+ * @property {string} [request_id]
+ * @property {number} [resend_timer]
+ * @property {boolean} [success]
+ */
+
+/**
+ * @typedef SendOtpEmailCommsProvider
+ * @property {string} [_id]
+ * @property {string} [slug]
+ */
+
+/**
+ * @typedef SendOtpEmailCommsTemplate
+ * @property {string} [key]
+ * @property {Object} [value]
+ */
+
+/**
+ * @typedef SendOtpSmsCommsProvider
+ * @property {string} [_id]
+ * @property {string} [slug]
+ */
+
+/**
+ * @typedef SendOtpSmsCommsTemplate
+ * @property {string} [key]
+ * @property {Object} [value]
+ */
+
+/**
+ * @typedef SmsProvider
+ * @property {number} [__v]
+ * @property {string} [_id]
+ * @property {string} [application]
+ * @property {string} [authkey]
+ * @property {string} [created_at]
+ * @property {string} [description]
+ * @property {string} [name]
+ * @property {string} [provider]
+ * @property {number} [rpt]
+ * @property {string} [sender]
+ * @property {string} [slug]
+ * @property {string} [type]
+ * @property {string} [updated_at]
+ * @property {string} [username]
+ */
+
+/**
+ * @typedef SmsProviderReq
+ * @property {string} [authkey]
+ * @property {string} [description]
+ * @property {string} [name]
+ * @property {string} [provider]
+ * @property {string} [sender]
+ * @property {string} [type]
+ * @property {string} [username]
+ */
+
+/**
+ * @typedef SmsProviders
+ * @property {SmsProvider[]} [items]
+ * @property {Page} [page]
+ */
+
+/**
+ * @typedef SmsTemplate
+ * @property {number} [__v]
+ * @property {string} [_id]
+ * @property {string} [created_at]
+ * @property {string} [description]
+ * @property {boolean} [is_internal]
+ * @property {boolean} [is_system]
+ * @property {SmsTemplateMessage} [message]
+ * @property {string} [name]
+ * @property {string} [priority]
+ * @property {boolean} [published]
+ * @property {string} [slug]
+ * @property {Object[]} [tags]
+ * @property {Object} [template_variables]
+ * @property {string} [updated_at]
+ */
+
+/**
+ * @typedef SmsTemplateDeleteFailureRes
+ * @property {string} [message]
+ * @property {boolean} [success]
+ */
+
+/**
+ * @typedef SmsTemplateDeleteSuccessRes
+ * @property {string} [message]
+ * @property {boolean} [success]
+ */
+
+/**
+ * @typedef SmsTemplateMessage
+ * @property {string} [template]
+ * @property {string} [template_type]
+ */
+
+/**
+ * @typedef SmsTemplateReq
+ * @property {Object[]} [attachments]
+ * @property {string} [description]
+ * @property {SmsTemplateMessage} [message]
+ * @property {string} [name]
+ * @property {string} [priority]
+ * @property {Object} [template_variables]
+ */
+
+/**
+ * @typedef SmsTemplateRes
+ * @property {number} [__v]
+ * @property {string} [_id]
+ * @property {string} [created_at]
+ * @property {string} [description]
+ * @property {boolean} [is_internal]
+ * @property {boolean} [is_system]
+ * @property {SmsTemplateMessage} [message]
+ * @property {string} [name]
+ * @property {string} [priority]
+ * @property {boolean} [published]
+ * @property {string} [slug]
+ * @property {Object[]} [tags]
+ * @property {Object} [template_variables]
+ * @property {string} [updated_at]
+ */
+
+/**
+ * @typedef SmsTemplates
+ * @property {SmsTemplate[]} [items]
+ * @property {Page} [page]
+ */
+
+/**
+ * @typedef Stats
+ * @property {string} [_id]
+ * @property {Object} [imported]
+ * @property {Object} [processed]
+ */
+
+/**
+ * @typedef StatsImported
+ * @property {number} [count]
+ */
+
+/**
+ * @typedef StatsProcessed
+ * @property {StatsProcessedEmail} [email]
+ * @property {StatsProcessedSms} [sms]
+ */
+
+/**
+ * @typedef StatsProcessedEmail
+ * @property {number} [failed]
+ * @property {number} [success]
+ * @property {number} [suppressed]
+ */
+
+/**
+ * @typedef StatsProcessedSms
+ * @property {number} [failed]
+ * @property {number} [success]
+ * @property {number} [suppressed]
+ */
+
+/**
+ * @typedef SystemEmailTemplate
+ * @property {number} [__v]
+ * @property {string} [_id]
+ * @property {Object[]} [attachments]
+ * @property {string} [created_at]
+ * @property {string} [description]
+ * @property {string} [from_name]
+ * @property {Object[]} [headers]
+ * @property {TemplateAndType} [html]
+ * @property {boolean} [is_internal]
+ * @property {boolean} [is_system]
+ * @property {string} [name]
+ * @property {string} [priority]
+ * @property {boolean} [published]
+ * @property {string} [slug]
+ * @property {Object[]} [static_bcc]
+ * @property {Object[]} [static_cc]
+ * @property {Object[]} [static_to]
+ * @property {TemplateAndType} [subject]
+ * @property {Object[]} [tags]
+ * @property {TemplateAndType} [text]
+ * @property {string} [updated_at]
+ */
+
+/**
+ * @typedef SystemEmailTemplates
+ * @property {SystemEmailTemplate[]} [items]
+ * @property {Page} [page]
+ */
+
+/**
+ * @typedef SystemNotification
+ * @property {string} [_id]
+ * @property {string} [created_at]
+ * @property {string} [group]
+ * @property {Notification} [notification]
+ * @property {SystemNotificationUser} [settings]
+ * @property {SystemNotificationUser} [user]
+ */
+
+/**
+ * @typedef SystemNotifications
+ * @property {SystemNotification[]} [items]
+ * @property {number} [last_read_anchor]
+ * @property {Page} [page]
+ */
+
+/**
+ * @typedef SystemNotificationSettings
+ * @property {string} [priority]
+ * @property {boolean} [sound]
+ * @property {string} [time_to_live]
+ */
+
+/**
+ * @typedef SystemNotificationsPage
+ * @property {number} [current]
+ * @property {boolean} [has_next]
+ * @property {number} [item_total]
+ * @property {number} [size]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef SystemNotificationUser
+ * @property {string} [type]
+ * @property {string} [value]
+ */
+
+/**
+ * @typedef SystemSmsTemplate
+ * @property {number} [__v]
+ * @property {string} [_id]
+ * @property {string} [created_at]
+ * @property {string} [description]
+ * @property {boolean} [is_internal]
+ * @property {boolean} [is_system]
+ * @property {SmsTemplateMessage} [message]
+ * @property {string} [name]
+ * @property {string} [priority]
+ * @property {boolean} [published]
+ * @property {string} [slug]
+ * @property {Object[]} [tags]
+ * @property {Object} [template_variables]
+ * @property {string} [updated_at]
+ */
+
+/**
+ * @typedef SystemSmsTemplates
+ * @property {SystemSmsTemplate[]} [items]
+ * @property {Page} [page]
+ */
+
+/**
+ * @typedef TemplateAndType
+ * @property {string} [template]
+ * @property {string} [template_type]
+ */
+
+/**
+ * @typedef TriggerJobRequest
+ * @property {string} [job_id]
+ */
+
+/**
+ * @typedef TriggerJobResponse
+ * @property {number} [status]
+ */
+
+/**
+ * @typedef VerifyOtpCommsErrorRes
+ * @property {string} [message]
+ * @property {boolean} [success]
+ */
+
+/**
+ * @typedef VerifyOtpCommsReq
+ * @property {string} [otp]
+ * @property {string} [request_id]
+ */
+
+/**
+ * @typedef VerifyOtpCommsSuccessRes
+ * @property {string} [country_code]
+ * @property {string} [message]
+ * @property {string} [mobile]
+ * @property {boolean} [success]
+ */
+
+class CommunicationPlatformModel {
+  /** @returns {Audience} */
   static Audience() {
     return Joi.object({
       __v: Joi.number(),
@@ -19,6 +878,8 @@ class CommunicationModel {
       updated_at: Joi.string().allow(""),
     });
   }
+
+  /** @returns {AudienceReq} */
   static AudienceReq() {
     return Joi.object({
       application: Joi.string().allow(""),
@@ -32,37 +893,49 @@ class CommunicationModel {
       type: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Audiences} */
   static Audiences() {
     return Joi.object({
-      items: Joi.array().items(CommunicationModel.Audience()),
-      page: CommunicationModel.Page(),
+      items: Joi.array().items(CommunicationPlatformModel.Audience()),
+      page: CommunicationPlatformModel.Page(),
     });
   }
+
+  /** @returns {BadRequestSchema} */
   static BadRequestSchema() {
     return Joi.object({
       message: Joi.string().allow(""),
       status: Joi.string().allow(""),
     });
   }
+
+  /** @returns {BigqueryHeadersReq} */
   static BigqueryHeadersReq() {
     return Joi.object({
       query: Joi.string().allow(""),
       type: Joi.string().allow(""),
     });
   }
+
+  /** @returns {BigqueryHeadersRes} */
   static BigqueryHeadersRes() {
     return Joi.object({
       headers: Joi.array().items(
-        CommunicationModel.BigqueryHeadersResHeaders()
+        CommunicationPlatformModel.BigqueryHeadersResHeaders()
       ),
     });
   }
+
+  /** @returns {BigqueryHeadersResHeaders} */
   static BigqueryHeadersResHeaders() {
     return Joi.object({
       name: Joi.string().allow(""),
       type: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Campaign} */
   static Campaign() {
     return Joi.object({
       __v: Joi.number(),
@@ -71,28 +944,34 @@ class CommunicationModel {
       created_at: Joi.string().allow(""),
       datasource: Joi.string().allow(""),
       description: Joi.string().allow(""),
-      email: CommunicationModel.CampaignEmail(),
+      email: CommunicationPlatformModel.CampaignEmail(),
       is_active: Joi.boolean(),
       name: Joi.string().allow(""),
-      recipient_headers: CommunicationModel.RecipientHeaders(),
+      recipient_headers: CommunicationPlatformModel.RecipientHeaders(),
       slug: Joi.string().allow(""),
       tags: Joi.array().items(Joi.any()),
       type: Joi.string().allow(""),
       updated_at: Joi.string().allow(""),
     });
   }
+
+  /** @returns {CampaignEmail} */
   static CampaignEmail() {
     return Joi.object({
-      provider: CommunicationModel.CampignEmailProvider(),
-      template: CommunicationModel.CampaignEmailTemplate(),
+      provider: CommunicationPlatformModel.CampignEmailProvider(),
+      template: CommunicationPlatformModel.CampaignEmailTemplate(),
     });
   }
+
+  /** @returns {CampaignEmailTemplate} */
   static CampaignEmailTemplate() {
     return Joi.object({
       key: Joi.string().allow(""),
       value: Joi.string().allow(""),
     });
   }
+
+  /** @returns {CampaignReq} */
   static CampaignReq() {
     return Joi.object({
       application: Joi.string().allow(""),
@@ -106,12 +985,16 @@ class CommunicationModel {
       type: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Campaigns} */
   static Campaigns() {
     return Joi.object({
-      items: Joi.array().items(CommunicationModel.Campaign()),
-      page: CommunicationModel.Page(),
+      items: Joi.array().items(CommunicationPlatformModel.Campaign()),
+      page: CommunicationPlatformModel.Page(),
     });
   }
+
+  /** @returns {CampignEmailProvider} */
   static CampignEmailProvider() {
     return Joi.object({
       _id: Joi.string().allow(""),
@@ -119,6 +1002,8 @@ class CommunicationModel {
       from_name: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EmailProvider} */
   static EmailProvider() {
     return Joi.object({
       __v: Joi.number(),
@@ -128,7 +1013,7 @@ class CommunicationModel {
       created_at: Joi.string().allow(""),
       description: Joi.string().allow(""),
       from_address: Joi.array().items(
-        CommunicationModel.EmailProviderReqFrom()
+        CommunicationPlatformModel.EmailProviderReqFrom()
       ),
       name: Joi.string().allow(""),
       provider: Joi.string().allow(""),
@@ -137,18 +1022,22 @@ class CommunicationModel {
       updated_at: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EmailProviderReq} */
   static EmailProviderReq() {
     return Joi.object({
       api_key: Joi.string().allow(""),
       description: Joi.string().allow(""),
       from_address: Joi.array().items(
-        CommunicationModel.EmailProviderReqFrom()
+        CommunicationPlatformModel.EmailProviderReqFrom()
       ),
       name: Joi.string().allow(""),
       provider: Joi.string().allow(""),
       type: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EmailProviderReqFrom} */
   static EmailProviderReqFrom() {
     return Joi.object({
       email: Joi.string().allow(""),
@@ -156,12 +1045,16 @@ class CommunicationModel {
       name: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EmailProviders} */
   static EmailProviders() {
     return Joi.object({
-      items: Joi.array().items(CommunicationModel.EmailProvider()),
-      page: CommunicationModel.Page(),
+      items: Joi.array().items(CommunicationPlatformModel.EmailProvider()),
+      page: CommunicationPlatformModel.Page(),
     });
   }
+
+  /** @returns {EmailTemplate} */
   static EmailTemplate() {
     return Joi.object({
       __v: Joi.number(),
@@ -171,7 +1064,7 @@ class CommunicationModel {
       description: Joi.string().allow(""),
       from_name: Joi.string().allow(""),
       headers: Joi.array().items(Joi.any()),
-      html: CommunicationModel.TemplateAndType(),
+      html: CommunicationPlatformModel.TemplateAndType(),
       is_internal: Joi.boolean(),
       is_system: Joi.boolean(),
       name: Joi.string().allow(""),
@@ -181,30 +1074,38 @@ class CommunicationModel {
       static_bcc: Joi.array().items(Joi.any()),
       static_cc: Joi.array().items(Joi.any()),
       static_to: Joi.array().items(Joi.any()),
-      subject: CommunicationModel.TemplateAndType(),
+      subject: CommunicationPlatformModel.TemplateAndType(),
       tags: Joi.array().items(Joi.any()),
-      text: CommunicationModel.TemplateAndType(),
+      text: CommunicationPlatformModel.TemplateAndType(),
       updated_at: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EmailTemplateDeleteFailureRes} */
   static EmailTemplateDeleteFailureRes() {
     return Joi.object({
       message: Joi.string().allow(""),
       success: Joi.boolean(),
     });
   }
+
+  /** @returns {EmailTemplateDeleteSuccessRes} */
   static EmailTemplateDeleteSuccessRes() {
     return Joi.object({
       message: Joi.string().allow(""),
       success: Joi.boolean(),
     });
   }
+
+  /** @returns {EmailTemplateHeaders} */
   static EmailTemplateHeaders() {
     return Joi.object({
       key: Joi.string().allow(""),
       value: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EmailTemplateKeys} */
   static EmailTemplateKeys() {
     return Joi.object({
       bcc: Joi.string().allow(""),
@@ -212,23 +1113,29 @@ class CommunicationModel {
       to: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EmailTemplateReq} */
   static EmailTemplateReq() {
     return Joi.object({
       attachments: Joi.array().items(Joi.any()),
       description: Joi.string().allow(""),
-      headers: Joi.array().items(CommunicationModel.EmailTemplateHeaders()),
-      html: CommunicationModel.TemplateAndType(),
-      keys: CommunicationModel.EmailTemplateKeys(),
+      headers: Joi.array().items(
+        CommunicationPlatformModel.EmailTemplateHeaders()
+      ),
+      html: CommunicationPlatformModel.TemplateAndType(),
+      keys: CommunicationPlatformModel.EmailTemplateKeys(),
       name: Joi.string().allow(""),
       priority: Joi.string().allow(""),
       reply_to: Joi.string().allow(""),
       static_bcc: Joi.array().items(Joi.string().allow("")),
       static_cc: Joi.array().items(Joi.string().allow("")),
       static_to: Joi.array().items(Joi.string().allow("")),
-      subject: CommunicationModel.TemplateAndType(),
-      text: CommunicationModel.TemplateAndType(),
+      subject: CommunicationPlatformModel.TemplateAndType(),
+      text: CommunicationPlatformModel.TemplateAndType(),
     });
   }
+
+  /** @returns {EmailTemplateRes} */
   static EmailTemplateRes() {
     return Joi.object({
       __v: Joi.number(),
@@ -236,11 +1143,13 @@ class CommunicationModel {
       attachments: Joi.array().items(Joi.any()),
       created_at: Joi.string().allow(""),
       description: Joi.string().allow(""),
-      headers: Joi.array().items(CommunicationModel.EmailTemplateHeaders()),
-      html: CommunicationModel.TemplateAndType(),
+      headers: Joi.array().items(
+        CommunicationPlatformModel.EmailTemplateHeaders()
+      ),
+      html: CommunicationPlatformModel.TemplateAndType(),
       is_internal: Joi.boolean(),
       is_system: Joi.boolean(),
-      keys: CommunicationModel.EmailTemplateKeys(),
+      keys: CommunicationPlatformModel.EmailTemplateKeys(),
       name: Joi.string().allow(""),
       priority: Joi.string().allow(""),
       published: Joi.boolean(),
@@ -249,29 +1158,37 @@ class CommunicationModel {
       static_bcc: Joi.array().items(Joi.string().allow("")),
       static_cc: Joi.array().items(Joi.string().allow("")),
       static_to: Joi.array().items(Joi.string().allow("")),
-      subject: CommunicationModel.TemplateAndType(),
+      subject: CommunicationPlatformModel.TemplateAndType(),
       tags: Joi.array().items(Joi.any()),
-      text: CommunicationModel.TemplateAndType(),
+      text: CommunicationPlatformModel.TemplateAndType(),
       updated_at: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EmailTemplates} */
   static EmailTemplates() {
     return Joi.object({
-      items: Joi.array().items(CommunicationModel.EmailTemplate()),
-      page: CommunicationModel.Page(),
+      items: Joi.array().items(CommunicationPlatformModel.EmailTemplate()),
+      page: CommunicationPlatformModel.Page(),
     });
   }
+
+  /** @returns {EngineRequest} */
   static EngineRequest() {
     return Joi.object({
-      meta: CommunicationModel.MetaStructure(),
-      payload: CommunicationModel.PayloadStructure(),
+      meta: CommunicationPlatformModel.MetaStructure(),
+      payload: CommunicationPlatformModel.PayloadStructure(),
     });
   }
+
+  /** @returns {EngineResponse} */
   static EngineResponse() {
     return Joi.object({
       success: Joi.boolean(),
     });
   }
+
+  /** @returns {EventSubscription} */
   static EventSubscription() {
     return Joi.object({
       __v: Joi.number(),
@@ -281,34 +1198,44 @@ class CommunicationModel {
       event: Joi.string().allow(""),
       is_default: Joi.boolean(),
       slug: Joi.string().allow(""),
-      template: CommunicationModel.EventSubscriptionTemplate(),
+      template: CommunicationPlatformModel.EventSubscriptionTemplate(),
       updated_at: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EventSubscriptions} */
   static EventSubscriptions() {
     return Joi.object({
-      items: Joi.array().items(CommunicationModel.EventSubscription()),
-      page: CommunicationModel.Page(),
+      items: Joi.array().items(CommunicationPlatformModel.EventSubscription()),
+      page: CommunicationPlatformModel.Page(),
     });
   }
+
+  /** @returns {EventSubscriptionTemplate} */
   static EventSubscriptionTemplate() {
     return Joi.object({
-      email: CommunicationModel.EventSubscriptionTemplateEmail(),
-      sms: CommunicationModel.EventSubscriptionTemplateSms(),
+      email: CommunicationPlatformModel.EventSubscriptionTemplateEmail(),
+      sms: CommunicationPlatformModel.EventSubscriptionTemplateSms(),
     });
   }
+
+  /** @returns {EventSubscriptionTemplateEmail} */
   static EventSubscriptionTemplateEmail() {
     return Joi.object({
       subscribed: Joi.boolean(),
       template: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EventSubscriptionTemplateSms} */
   static EventSubscriptionTemplateSms() {
     return Joi.object({
       subscribed: Joi.boolean(),
       template: Joi.string().allow(""),
     });
   }
+
+  /** @returns {GetNRecordsCsvReq} */
   static GetNRecordsCsvReq() {
     return Joi.object({
       count: Joi.number(),
@@ -316,11 +1243,17 @@ class CommunicationModel {
       url: Joi.string().allow(""),
     });
   }
+
+  /** @returns {GetNRecordsCsvRes} */
   static GetNRecordsCsvRes() {
     return Joi.object({
-      items: Joi.array().items(CommunicationModel.GetNRecordsCsvResItems()),
+      items: Joi.array().items(
+        CommunicationPlatformModel.GetNRecordsCsvResItems()
+      ),
     });
   }
+
+  /** @returns {GetNRecordsCsvResItems} */
   static GetNRecordsCsvResItems() {
     return Joi.object({
       email: Joi.string().allow(""),
@@ -330,11 +1263,15 @@ class CommunicationModel {
       phone_number: Joi.string().allow(""),
     });
   }
+
+  /** @returns {GetStats} */
   static GetStats() {
     return Joi.object({
-      items: Joi.array().items(CommunicationModel.Stats()),
+      items: Joi.array().items(CommunicationPlatformModel.Stats()),
     });
   }
+
+  /** @returns {Job} */
   static Job() {
     return Joi.object({
       __v: Joi.number(),
@@ -347,6 +1284,8 @@ class CommunicationModel {
       updated_at: Joi.string().allow(""),
     });
   }
+
+  /** @returns {JobLog} */
   static JobLog() {
     return Joi.object({
       __v: Joi.number(),
@@ -359,18 +1298,24 @@ class CommunicationModel {
       updated_at: Joi.string().allow(""),
     });
   }
+
+  /** @returns {JobLogs} */
   static JobLogs() {
     return Joi.object({
-      items: Joi.array().items(CommunicationModel.JobLog()),
-      page: CommunicationModel.Page(),
+      items: Joi.array().items(CommunicationPlatformModel.JobLog()),
+      page: CommunicationPlatformModel.Page(),
     });
   }
+
+  /** @returns {Jobs} */
   static Jobs() {
     return Joi.object({
-      items: Joi.array().items(CommunicationModel.Job()),
-      page: CommunicationModel.Page(),
+      items: Joi.array().items(CommunicationPlatformModel.Job()),
+      page: CommunicationPlatformModel.Page(),
     });
   }
+
+  /** @returns {Log} */
   static Log() {
     return Joi.object({
       _id: Joi.string().allow(""),
@@ -378,21 +1323,25 @@ class CommunicationModel {
       channel_type: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
       data: Joi.any(),
-      email: CommunicationModel.LogEmail(),
+      email: CommunicationPlatformModel.LogEmail(),
       expire_at: Joi.string().allow(""),
-      meta: CommunicationModel.LogMeta(),
-      pushnotification: CommunicationModel.LogPushnotification(),
+      meta: CommunicationPlatformModel.LogMeta(),
+      pushnotification: CommunicationPlatformModel.LogPushnotification(),
       service: Joi.string().allow(""),
       source: Joi.string().allow(""),
       status: Joi.string().allow(""),
       step: Joi.string().allow(""),
     });
   }
+
+  /** @returns {LogEmail} */
   static LogEmail() {
     return Joi.object({
       template: Joi.string().allow(""),
     });
   }
+
+  /** @returns {LogMeta} */
   static LogMeta() {
     return Joi.object({
       identifier: Joi.string().allow(""),
@@ -403,17 +1352,23 @@ class CommunicationModel {
       type: Joi.string().allow(""),
     });
   }
+
+  /** @returns {LogPushnotification} */
   static LogPushnotification() {
     return Joi.object({
       pushtokens: Joi.array().items(Joi.string().allow("")),
     });
   }
+
+  /** @returns {Logs} */
   static Logs() {
     return Joi.object({
-      items: Joi.array().items(CommunicationModel.Log()),
-      page: CommunicationModel.Page(),
+      items: Joi.array().items(CommunicationPlatformModel.Log()),
+      page: CommunicationPlatformModel.Page(),
     });
   }
+
+  /** @returns {MetaStructure} */
   static MetaStructure() {
     return Joi.object({
       action: Joi.string().allow(""),
@@ -422,11 +1377,15 @@ class CommunicationModel {
       trace: Joi.string().allow(""),
     });
   }
+
+  /** @returns {NotFound} */
   static NotFound() {
     return Joi.object({
       message: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Notification} */
   static Notification() {
     return Joi.object({
       body: Joi.string().allow(""),
@@ -437,6 +1396,8 @@ class CommunicationModel {
       title: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Page} */
   static Page() {
     return Joi.object({
       current: Joi.number(),
@@ -448,48 +1409,64 @@ class CommunicationModel {
       type: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {PayloadEmailProviderStructure} */
   static PayloadEmailProviderStructure() {
     return Joi.object({
       _id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {PayloadEmailStructure} */
   static PayloadEmailStructure() {
     return Joi.object({
-      provider: CommunicationModel.PayloadEmailProviderStructure(),
-      template: CommunicationModel.PayloadEmailTemplateStructure(),
+      provider: CommunicationPlatformModel.PayloadEmailProviderStructure(),
+      template: CommunicationPlatformModel.PayloadEmailTemplateStructure(),
     });
   }
+
+  /** @returns {PayloadEmailTemplateStructure} */
   static PayloadEmailTemplateStructure() {
     return Joi.object({
       key: Joi.string().allow(""),
       value: Joi.any(),
     });
   }
+
+  /** @returns {PayloadSmsProviderStructure} */
   static PayloadSmsProviderStructure() {
     return Joi.object({
       _id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {PayloadSmsStructure} */
   static PayloadSmsStructure() {
     return Joi.object({
-      provider: CommunicationModel.PayloadSmsProviderStructure(),
-      template: CommunicationModel.PayloadSmsTemplateStructure(),
+      provider: CommunicationPlatformModel.PayloadSmsProviderStructure(),
+      template: CommunicationPlatformModel.PayloadSmsTemplateStructure(),
     });
   }
+
+  /** @returns {PayloadSmsTemplateStructure} */
   static PayloadSmsTemplateStructure() {
     return Joi.object({
       key: Joi.string().allow(""),
       value: Joi.any(),
     });
   }
+
+  /** @returns {PayloadStructure} */
   static PayloadStructure() {
     return Joi.object({
       application: Joi.string().allow(""),
       data: Joi.array().items(Joi.any()),
-      email: CommunicationModel.PayloadEmailStructure(),
-      sms: CommunicationModel.PayloadSmsStructure(),
+      email: CommunicationPlatformModel.PayloadEmailStructure(),
+      sms: CommunicationPlatformModel.PayloadSmsStructure(),
     });
   }
+
+  /** @returns {PushtokenReq} */
   static PushtokenReq() {
     return Joi.object({
       action: Joi.string().allow(""),
@@ -498,6 +1475,8 @@ class CommunicationModel {
       unique_device_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {PushtokenRes} */
   static PushtokenRes() {
     return Joi.object({
       _id: Joi.string().allow(""),
@@ -513,18 +1492,24 @@ class CommunicationModel {
       user_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {RecipientHeaders} */
   static RecipientHeaders() {
     return Joi.object({
       email: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SendOtpCommsReq} */
   static SendOtpCommsReq() {
     return Joi.object({
-      data: CommunicationModel.SendOtpCommsReqData(),
-      email: CommunicationModel.SendOtpCommsReqEmail(),
-      sms: CommunicationModel.SendOtpCommsReqSms(),
+      data: CommunicationPlatformModel.SendOtpCommsReqData(),
+      email: CommunicationPlatformModel.SendOtpCommsReqEmail(),
+      sms: CommunicationPlatformModel.SendOtpCommsReqSms(),
     });
   }
+
+  /** @returns {SendOtpCommsReqData} */
   static SendOtpCommsReqData() {
     return Joi.object({
       country_code: Joi.string().allow(""),
@@ -533,28 +1518,36 @@ class CommunicationModel {
       to: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SendOtpCommsReqEmail} */
   static SendOtpCommsReqEmail() {
     return Joi.object({
       expiry: Joi.number(),
       otp_length: Joi.number(),
-      provider: CommunicationModel.SendOtpEmailCommsProvider(),
-      template: CommunicationModel.SendOtpEmailCommsTemplate(),
+      provider: CommunicationPlatformModel.SendOtpEmailCommsProvider(),
+      template: CommunicationPlatformModel.SendOtpEmailCommsTemplate(),
     });
   }
+
+  /** @returns {SendOtpCommsReqSms} */
   static SendOtpCommsReqSms() {
     return Joi.object({
       expiry: Joi.number(),
       otp_length: Joi.number(),
-      provider: CommunicationModel.SendOtpSmsCommsProvider(),
-      template: CommunicationModel.SendOtpSmsCommsTemplate(),
+      provider: CommunicationPlatformModel.SendOtpSmsCommsProvider(),
+      template: CommunicationPlatformModel.SendOtpSmsCommsTemplate(),
     });
   }
+
+  /** @returns {SendOtpCommsRes} */
   static SendOtpCommsRes() {
     return Joi.object({
-      email: CommunicationModel.SendOtpCommsResEmail(),
-      sms: CommunicationModel.SendOtpCommsResSms(),
+      email: CommunicationPlatformModel.SendOtpCommsResEmail(),
+      sms: CommunicationPlatformModel.SendOtpCommsResSms(),
     });
   }
+
+  /** @returns {SendOtpCommsResEmail} */
   static SendOtpCommsResEmail() {
     return Joi.object({
       message: Joi.string().allow(""),
@@ -564,6 +1557,8 @@ class CommunicationModel {
       to: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SendOtpCommsResSms} */
   static SendOtpCommsResSms() {
     return Joi.object({
       country_code: Joi.string().allow(""),
@@ -574,30 +1569,40 @@ class CommunicationModel {
       success: Joi.boolean(),
     });
   }
+
+  /** @returns {SendOtpEmailCommsProvider} */
   static SendOtpEmailCommsProvider() {
     return Joi.object({
       _id: Joi.string().allow(""),
       slug: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SendOtpEmailCommsTemplate} */
   static SendOtpEmailCommsTemplate() {
     return Joi.object({
       key: Joi.string().allow(""),
       value: Joi.any(),
     });
   }
+
+  /** @returns {SendOtpSmsCommsProvider} */
   static SendOtpSmsCommsProvider() {
     return Joi.object({
       _id: Joi.string().allow(""),
       slug: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SendOtpSmsCommsTemplate} */
   static SendOtpSmsCommsTemplate() {
     return Joi.object({
       key: Joi.string().allow(""),
       value: Joi.any(),
     });
   }
+
+  /** @returns {SmsProvider} */
   static SmsProvider() {
     return Joi.object({
       __v: Joi.number(),
@@ -616,6 +1621,8 @@ class CommunicationModel {
       username: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SmsProviderReq} */
   static SmsProviderReq() {
     return Joi.object({
       authkey: Joi.string().allow(""),
@@ -627,12 +1634,16 @@ class CommunicationModel {
       username: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SmsProviders} */
   static SmsProviders() {
     return Joi.object({
-      items: Joi.array().items(CommunicationModel.SmsProvider()),
-      page: CommunicationModel.Page(),
+      items: Joi.array().items(CommunicationPlatformModel.SmsProvider()),
+      page: CommunicationPlatformModel.Page(),
     });
   }
+
+  /** @returns {SmsTemplate} */
   static SmsTemplate() {
     return Joi.object({
       __v: Joi.number(),
@@ -641,7 +1652,7 @@ class CommunicationModel {
       description: Joi.string().allow(""),
       is_internal: Joi.boolean(),
       is_system: Joi.boolean(),
-      message: CommunicationModel.SmsTemplateMessage(),
+      message: CommunicationPlatformModel.SmsTemplateMessage(),
       name: Joi.string().allow(""),
       priority: Joi.string().allow(""),
       published: Joi.boolean(),
@@ -651,34 +1662,44 @@ class CommunicationModel {
       updated_at: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SmsTemplateDeleteFailureRes} */
   static SmsTemplateDeleteFailureRes() {
     return Joi.object({
       message: Joi.string().allow(""),
       success: Joi.boolean(),
     });
   }
+
+  /** @returns {SmsTemplateDeleteSuccessRes} */
   static SmsTemplateDeleteSuccessRes() {
     return Joi.object({
       message: Joi.string().allow(""),
       success: Joi.boolean(),
     });
   }
+
+  /** @returns {SmsTemplateMessage} */
   static SmsTemplateMessage() {
     return Joi.object({
       template: Joi.string().allow(""),
       template_type: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SmsTemplateReq} */
   static SmsTemplateReq() {
     return Joi.object({
       attachments: Joi.array().items(Joi.any()),
       description: Joi.string().allow(""),
-      message: CommunicationModel.SmsTemplateMessage(),
+      message: CommunicationPlatformModel.SmsTemplateMessage(),
       name: Joi.string().allow(""),
       priority: Joi.string().allow(""),
       template_variables: Joi.any(),
     });
   }
+
+  /** @returns {SmsTemplateRes} */
   static SmsTemplateRes() {
     return Joi.object({
       __v: Joi.number(),
@@ -687,7 +1708,7 @@ class CommunicationModel {
       description: Joi.string().allow(""),
       is_internal: Joi.boolean(),
       is_system: Joi.boolean(),
-      message: CommunicationModel.SmsTemplateMessage(),
+      message: CommunicationPlatformModel.SmsTemplateMessage(),
       name: Joi.string().allow(""),
       priority: Joi.string().allow(""),
       published: Joi.boolean(),
@@ -697,12 +1718,16 @@ class CommunicationModel {
       updated_at: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SmsTemplates} */
   static SmsTemplates() {
     return Joi.object({
-      items: Joi.array().items(CommunicationModel.SmsTemplate()),
-      page: CommunicationModel.Page(),
+      items: Joi.array().items(CommunicationPlatformModel.SmsTemplate()),
+      page: CommunicationPlatformModel.Page(),
     });
   }
+
+  /** @returns {Stats} */
   static Stats() {
     return Joi.object({
       _id: Joi.string().allow(""),
@@ -710,17 +1735,23 @@ class CommunicationModel {
       processed: Joi.any(),
     });
   }
+
+  /** @returns {StatsImported} */
   static StatsImported() {
     return Joi.object({
       count: Joi.number(),
     });
   }
+
+  /** @returns {StatsProcessed} */
   static StatsProcessed() {
     return Joi.object({
-      email: CommunicationModel.StatsProcessedEmail(),
-      sms: CommunicationModel.StatsProcessedSms(),
+      email: CommunicationPlatformModel.StatsProcessedEmail(),
+      sms: CommunicationPlatformModel.StatsProcessedSms(),
     });
   }
+
+  /** @returns {StatsProcessedEmail} */
   static StatsProcessedEmail() {
     return Joi.object({
       failed: Joi.number(),
@@ -728,6 +1759,8 @@ class CommunicationModel {
       suppressed: Joi.number(),
     });
   }
+
+  /** @returns {StatsProcessedSms} */
   static StatsProcessedSms() {
     return Joi.object({
       failed: Joi.number(),
@@ -735,6 +1768,8 @@ class CommunicationModel {
       suppressed: Joi.number(),
     });
   }
+
+  /** @returns {SystemEmailTemplate} */
   static SystemEmailTemplate() {
     return Joi.object({
       __v: Joi.number(),
@@ -744,7 +1779,7 @@ class CommunicationModel {
       description: Joi.string().allow(""),
       from_name: Joi.string().allow(""),
       headers: Joi.array().items(Joi.any()),
-      html: CommunicationModel.TemplateAndType(),
+      html: CommunicationPlatformModel.TemplateAndType(),
       is_internal: Joi.boolean(),
       is_system: Joi.boolean(),
       name: Joi.string().allow(""),
@@ -754,35 +1789,45 @@ class CommunicationModel {
       static_bcc: Joi.array().items(Joi.any()),
       static_cc: Joi.array().items(Joi.any()),
       static_to: Joi.array().items(Joi.any()),
-      subject: CommunicationModel.TemplateAndType(),
+      subject: CommunicationPlatformModel.TemplateAndType(),
       tags: Joi.array().items(Joi.any()),
-      text: CommunicationModel.TemplateAndType(),
+      text: CommunicationPlatformModel.TemplateAndType(),
       updated_at: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SystemEmailTemplates} */
   static SystemEmailTemplates() {
     return Joi.object({
-      items: Joi.array().items(CommunicationModel.SystemEmailTemplate()),
-      page: CommunicationModel.Page(),
+      items: Joi.array().items(
+        CommunicationPlatformModel.SystemEmailTemplate()
+      ),
+      page: CommunicationPlatformModel.Page(),
     });
   }
+
+  /** @returns {SystemNotification} */
   static SystemNotification() {
     return Joi.object({
       _id: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
       group: Joi.string().allow(""),
-      notification: CommunicationModel.Notification(),
-      settings: CommunicationModel.SystemNotificationUser(),
-      user: CommunicationModel.SystemNotificationUser(),
+      notification: CommunicationPlatformModel.Notification(),
+      settings: CommunicationPlatformModel.SystemNotificationUser(),
+      user: CommunicationPlatformModel.SystemNotificationUser(),
     });
   }
+
+  /** @returns {SystemNotifications} */
   static SystemNotifications() {
     return Joi.object({
-      items: Joi.array().items(CommunicationModel.SystemNotification()),
+      items: Joi.array().items(CommunicationPlatformModel.SystemNotification()),
       last_read_anchor: Joi.number(),
-      page: CommunicationModel.Page(),
+      page: CommunicationPlatformModel.Page(),
     });
   }
+
+  /** @returns {SystemNotificationSettings} */
   static SystemNotificationSettings() {
     return Joi.object({
       priority: Joi.string().allow(""),
@@ -790,6 +1835,8 @@ class CommunicationModel {
       time_to_live: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SystemNotificationsPage} */
   static SystemNotificationsPage() {
     return Joi.object({
       current: Joi.number(),
@@ -799,12 +1846,16 @@ class CommunicationModel {
       type: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SystemNotificationUser} */
   static SystemNotificationUser() {
     return Joi.object({
       type: Joi.string().allow(""),
       value: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SystemSmsTemplate} */
   static SystemSmsTemplate() {
     return Joi.object({
       __v: Joi.number(),
@@ -813,7 +1864,7 @@ class CommunicationModel {
       description: Joi.string().allow(""),
       is_internal: Joi.boolean(),
       is_system: Joi.boolean(),
-      message: CommunicationModel.SmsTemplateMessage(),
+      message: CommunicationPlatformModel.SmsTemplateMessage(),
       name: Joi.string().allow(""),
       priority: Joi.string().allow(""),
       published: Joi.boolean(),
@@ -823,40 +1874,54 @@ class CommunicationModel {
       updated_at: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SystemSmsTemplates} */
   static SystemSmsTemplates() {
     return Joi.object({
-      items: Joi.array().items(CommunicationModel.SystemSmsTemplate()),
-      page: CommunicationModel.Page(),
+      items: Joi.array().items(CommunicationPlatformModel.SystemSmsTemplate()),
+      page: CommunicationPlatformModel.Page(),
     });
   }
+
+  /** @returns {TemplateAndType} */
   static TemplateAndType() {
     return Joi.object({
       template: Joi.string().allow(""),
       template_type: Joi.string().allow(""),
     });
   }
+
+  /** @returns {TriggerJobRequest} */
   static TriggerJobRequest() {
     return Joi.object({
       job_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {TriggerJobResponse} */
   static TriggerJobResponse() {
     return Joi.object({
       status: Joi.number(),
     });
   }
+
+  /** @returns {VerifyOtpCommsErrorRes} */
   static VerifyOtpCommsErrorRes() {
     return Joi.object({
       message: Joi.string().allow(""),
       success: Joi.boolean(),
     });
   }
+
+  /** @returns {VerifyOtpCommsReq} */
   static VerifyOtpCommsReq() {
     return Joi.object({
       otp: Joi.string().allow(""),
       request_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {VerifyOtpCommsSuccessRes} */
   static VerifyOtpCommsSuccessRes() {
     return Joi.object({
       country_code: Joi.string().allow(""),
@@ -866,4 +1931,4 @@ class CommunicationModel {
     });
   }
 }
-module.exports = CommunicationModel;
+module.exports = CommunicationPlatformModel;