@gofynd/fdk-client-javascript 1.4.2-beta.2 → 1.4.2-beta.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (106) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationModel.d.ts +1742 -1726
  4. package/sdk/application/Cart/CartApplicationModel.js +1497 -1481
  5. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +1917 -1917
  6. package/sdk/application/Catalog/CatalogApplicationModel.js +1611 -1611
  7. package/sdk/application/Common/CommonApplicationModel.d.ts +235 -235
  8. package/sdk/application/Common/CommonApplicationModel.js +172 -172
  9. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +72 -72
  10. package/sdk/application/Communication/CommunicationApplicationModel.js +64 -64
  11. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1614 -1614
  12. package/sdk/application/Configuration/ConfigurationApplicationModel.js +1151 -1151
  13. package/sdk/application/Content/ContentApplicationModel.d.ts +797 -797
  14. package/sdk/application/Content/ContentApplicationModel.js +757 -757
  15. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +79 -79
  16. package/sdk/application/FileStorage/FileStorageApplicationModel.js +84 -84
  17. package/sdk/application/Lead/LeadApplicationModel.d.ts +417 -417
  18. package/sdk/application/Lead/LeadApplicationModel.js +301 -301
  19. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +666 -666
  20. package/sdk/application/Logistic/LogisticApplicationModel.js +601 -601
  21. package/sdk/application/Order/OrderApplicationModel.d.ts +846 -846
  22. package/sdk/application/Order/OrderApplicationModel.js +822 -822
  23. package/sdk/application/Payment/PaymentApplicationClient.d.ts +5 -5
  24. package/sdk/application/Payment/PaymentApplicationClient.js +10 -10
  25. package/sdk/application/Payment/PaymentApplicationModel.d.ts +2155 -2150
  26. package/sdk/application/Payment/PaymentApplicationModel.js +1460 -1458
  27. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
  28. package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
  29. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1462 -1462
  30. package/sdk/application/PosCart/PosCartApplicationModel.js +1260 -1260
  31. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +214 -214
  32. package/sdk/application/Rewards/RewardsApplicationModel.js +211 -211
  33. package/sdk/application/Share/ShareApplicationModel.d.ts +114 -114
  34. package/sdk/application/Share/ShareApplicationModel.js +121 -121
  35. package/sdk/application/Theme/ThemeApplicationModel.d.ts +895 -895
  36. package/sdk/application/Theme/ThemeApplicationModel.js +684 -684
  37. package/sdk/application/User/UserApplicationModel.d.ts +762 -762
  38. package/sdk/application/User/UserApplicationModel.js +738 -738
  39. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +63 -63
  40. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +65 -65
  41. package/sdk/partner/Lead/LeadPartnerModel.d.ts +661 -661
  42. package/sdk/partner/Lead/LeadPartnerModel.js +491 -491
  43. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +223 -223
  44. package/sdk/partner/Logistics/LogisticsPartnerModel.js +235 -235
  45. package/sdk/partner/Theme/ThemePartnerModel.d.ts +1087 -1087
  46. package/sdk/partner/Theme/ThemePartnerModel.js +819 -819
  47. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +386 -386
  48. package/sdk/partner/Webhook/WebhookPartnerModel.js +342 -342
  49. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +123 -123
  50. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +109 -109
  51. package/sdk/platform/Billing/BillingPlatformModel.d.ts +801 -801
  52. package/sdk/platform/Billing/BillingPlatformModel.js +783 -783
  53. package/sdk/platform/Cart/CartPlatformModel.d.ts +3333 -3317
  54. package/sdk/platform/Cart/CartPlatformModel.js +2936 -2920
  55. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1013 -1013
  56. package/sdk/platform/Catalog/CatalogPlatformModel.js +923 -923
  57. package/sdk/platform/Common/CommonPlatformModel.d.ts +255 -255
  58. package/sdk/platform/Common/CommonPlatformModel.js +187 -187
  59. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1238 -1238
  60. package/sdk/platform/Communication/CommunicationPlatformModel.js +1273 -1273
  61. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +661 -661
  62. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +692 -692
  63. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +3198 -3198
  64. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2247 -2247
  65. package/sdk/platform/Content/ContentPlatformModel.d.ts +1833 -1833
  66. package/sdk/platform/Content/ContentPlatformModel.js +1837 -1837
  67. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +245 -245
  68. package/sdk/platform/Discount/DiscountPlatformModel.js +248 -248
  69. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +865 -865
  70. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +877 -877
  71. package/sdk/platform/Finance/FinancePlatformModel.d.ts +1044 -1044
  72. package/sdk/platform/Finance/FinancePlatformModel.js +974 -974
  73. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +942 -942
  74. package/sdk/platform/Inventory/InventoryPlatformModel.js +1003 -1003
  75. package/sdk/platform/Lead/LeadPlatformModel.d.ts +608 -608
  76. package/sdk/platform/Lead/LeadPlatformModel.js +465 -465
  77. package/sdk/platform/Order/OrderPlatformModel.d.ts +5180 -5176
  78. package/sdk/platform/Order/OrderPlatformModel.js +4740 -4736
  79. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +22 -22
  80. package/sdk/platform/Partner/PartnerPlatformModel.js +22 -22
  81. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2670 -2660
  82. package/sdk/platform/Payment/PaymentPlatformModel.js +1831 -1827
  83. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +204 -204
  84. package/sdk/platform/Rewards/RewardsPlatformModel.js +199 -199
  85. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1505 -1507
  86. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1532 -1536
  87. package/sdk/platform/Share/SharePlatformModel.d.ts +147 -147
  88. package/sdk/platform/Share/SharePlatformModel.js +139 -139
  89. package/sdk/platform/Theme/ThemePlatformModel.d.ts +1046 -1046
  90. package/sdk/platform/Theme/ThemePlatformModel.js +789 -789
  91. package/sdk/platform/User/UserPlatformModel.d.ts +758 -758
  92. package/sdk/platform/User/UserPlatformModel.js +643 -643
  93. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +439 -439
  94. package/sdk/platform/Webhook/WebhookPlatformModel.js +364 -364
  95. package/sdk/public/Billing/BillingPublicModel.d.ts +55 -55
  96. package/sdk/public/Billing/BillingPublicModel.js +51 -51
  97. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +237 -237
  98. package/sdk/public/Configuration/ConfigurationPublicModel.js +174 -174
  99. package/sdk/public/Content/ContentPublicModel.d.ts +26 -26
  100. package/sdk/public/Content/ContentPublicModel.js +28 -28
  101. package/sdk/public/Inventory/InventoryPublicModel.d.ts +237 -237
  102. package/sdk/public/Inventory/InventoryPublicModel.js +257 -257
  103. package/sdk/public/Partner/PartnerPublicModel.d.ts +104 -104
  104. package/sdk/public/Partner/PartnerPublicModel.js +113 -113
  105. package/sdk/public/Webhook/WebhookPublicModel.d.ts +87 -87
  106. package/sdk/public/Webhook/WebhookPublicModel.js +93 -93
@@ -1,94 +1,125 @@
1
1
  export = CommunicationPlatformModel;
2
2
  /**
3
- * @typedef AppProvider
4
- * @property {number} [__v]
3
+ * @typedef EventSubscriptionsBulkUpdateRequest
4
+ * @property {SubscriptionsObject[]} [subscriptions]
5
+ */
6
+ /**
7
+ * @typedef EventSubscriptionsBulkUpdateResponse
8
+ * @property {EventSubscriptionTemplate} [template]
5
9
  * @property {string} [_id]
6
10
  * @property {string} [application]
11
+ * @property {string} [event]
12
+ * @property {string} [slug]
13
+ * @property {string} [category]
7
14
  * @property {string} [created_at]
8
- * @property {AppProviderRes} [email]
9
- * @property {AppProviderRes} [sms]
10
15
  * @property {string} [updated_at]
11
- * @property {AppProviderResVoice} [voice]
16
+ * @property {number} [__v]
12
17
  */
13
18
  /**
14
- * @typedef AppProviderReq
19
+ * @typedef SubscriptionsObject
20
+ * @property {string} [_id] - Subscription ID
21
+ * @property {TemplateObject} [template]
22
+ */
23
+ /**
24
+ * @typedef TemplateObject
25
+ * @property {CommunicationTemplate} [sms]
26
+ * @property {CommunicationTemplate} [email]
27
+ * @property {CommunicationTemplate} [pushnotification]
28
+ */
29
+ /**
30
+ * @typedef CommunicationTemplate
31
+ * @property {boolean} [subscribed] - Whether the user is subscribed or not
32
+ * @property {string} [template] - Template ID
33
+ */
34
+ /**
35
+ * @typedef AppProvider
15
36
  * @property {AppProviderRes} [email]
16
37
  * @property {AppProviderRes} [sms]
17
38
  * @property {AppProviderResVoice} [voice]
39
+ * @property {string} [_id]
40
+ * @property {string} [application]
41
+ * @property {string} [created_at]
42
+ * @property {string} [updated_at]
43
+ * @property {number} [__v]
18
44
  */
19
45
  /**
20
46
  * @typedef AppProviderRes
21
- * @property {AppProviderResObj} [otp]
47
+ * @property {AppProviderResObj} [transaction]
22
48
  * @property {AppProviderResObj} [promotional]
49
+ * @property {AppProviderResObj} [otp]
50
+ */
51
+ /**
52
+ * @typedef AppProviderResVoice
23
53
  * @property {AppProviderResObj} [transaction]
54
+ * @property {AppProviderResObj} [otp]
24
55
  */
25
56
  /**
26
57
  * @typedef AppProviderResObj
27
58
  * @property {string} [provider]
28
59
  */
29
60
  /**
30
- * @typedef AppProviderResVoice
31
- * @property {AppProviderResObj} [otp]
32
- * @property {AppProviderResObj} [transaction]
61
+ * @typedef GlobalProviders
62
+ * @property {GlobalProvidersResObj[]} [email]
63
+ * @property {GlobalProvidersResObj[]} [sms]
64
+ * @property {GlobalProvidersResObj[]} [voice]
33
65
  */
34
66
  /**
35
- * @typedef Audience
36
- * @property {number} [__v]
67
+ * @typedef GlobalProvidersResObj
37
68
  * @property {string} [_id]
38
- * @property {string} [application]
39
- * @property {string} [created_at]
40
- * @property {string} [description]
41
- * @property {string} [file_url]
42
- * @property {string[]} [headers]
43
- * @property {boolean} [is_active]
44
69
  * @property {string} [name]
45
- * @property {number} [records_count]
46
- * @property {string} [slug]
47
- * @property {string[]} [tags]
48
- * @property {string} [type]
49
- * @property {string} [updated_at]
50
70
  */
51
71
  /**
52
- * @typedef AudienceReq
53
- * @property {string} [description]
54
- * @property {string} [file_url]
55
- * @property {string[]} [headers]
56
- * @property {string} [name]
57
- * @property {number} [records_count]
58
- * @property {string[]} [tags]
59
- * @property {string} [type]
72
+ * @typedef AppProviderReq
73
+ * @property {AppProviderRes} [email]
74
+ * @property {AppProviderRes} [sms]
75
+ * @property {AppProviderResVoice} [voice]
60
76
  */
61
77
  /**
62
- * @typedef Audiences
63
- * @property {Audience[]} [items]
64
- * @property {Page} [page]
78
+ * @typedef StatsImported
79
+ * @property {number} [count]
65
80
  */
66
81
  /**
67
- * @typedef BadRequestSchema
68
- * @property {string} [message] - Failure message.
69
- * @property {string} [status] - Response status.
82
+ * @typedef StatsProcessedEmail
83
+ * @property {number} [success]
84
+ * @property {number} [failed]
85
+ * @property {number} [suppressed]
70
86
  */
71
87
  /**
72
- * @typedef Campaign
73
- * @property {number} [__v]
88
+ * @typedef StatsProcessedSms
89
+ * @property {number} [success]
90
+ * @property {number} [failed]
91
+ * @property {number} [suppressed]
92
+ */
93
+ /**
94
+ * @typedef StatsProcessed
95
+ * @property {StatsProcessedEmail} [email]
96
+ * @property {StatsProcessedSms} [sms]
97
+ */
98
+ /**
99
+ * @typedef Stats
74
100
  * @property {string} [_id]
75
- * @property {string} [application]
76
- * @property {string} [created_at]
77
- * @property {string} [datasource]
101
+ * @property {Object} [imported]
102
+ * @property {Object} [processed]
103
+ */
104
+ /**
105
+ * @typedef GetStats
106
+ * @property {Stats[]} [items]
107
+ */
108
+ /**
109
+ * @typedef CampaignReq
78
110
  * @property {string} [description]
79
- * @property {CampaignEmail} [email]
111
+ * @property {string[]} [tags]
112
+ * @property {string[]} [headers]
80
113
  * @property {boolean} [is_active]
81
114
  * @property {string} [name]
82
- * @property {RecipientHeaders} [recipient_headers]
83
- * @property {string} [slug]
84
- * @property {Object[]} [tags]
115
+ * @property {string} [file_url]
85
116
  * @property {string} [type]
86
- * @property {string} [updated_at]
117
+ * @property {number} [records_count]
118
+ * @property {string} [application]
87
119
  */
88
120
  /**
89
- * @typedef CampaignEmail
90
- * @property {CampignEmailProvider} [provider]
91
- * @property {CampaignEmailTemplate} [template]
121
+ * @typedef RecipientHeaders
122
+ * @property {string} [email]
92
123
  */
93
124
  /**
94
125
  * @typedef CampaignEmailTemplate
@@ -96,16 +127,32 @@ export = CommunicationPlatformModel;
96
127
  * @property {string} [value]
97
128
  */
98
129
  /**
99
- * @typedef CampaignReq
100
- * @property {string} [application]
130
+ * @typedef CampignEmailProvider
131
+ * @property {string} [_id]
132
+ * @property {string} [from_name]
133
+ * @property {string} [from_email]
134
+ */
135
+ /**
136
+ * @typedef CampaignEmail
137
+ * @property {CampaignEmailTemplate} [template]
138
+ * @property {CampignEmailProvider} [provider]
139
+ */
140
+ /**
141
+ * @typedef Campaign
142
+ * @property {RecipientHeaders} [recipient_headers]
143
+ * @property {CampaignEmail} [email]
101
144
  * @property {string} [description]
102
- * @property {string} [file_url]
103
- * @property {string[]} [headers]
145
+ * @property {Object[]} [tags]
104
146
  * @property {boolean} [is_active]
105
- * @property {string} [name]
106
- * @property {number} [records_count]
107
- * @property {string[]} [tags]
147
+ * @property {string} [_id]
148
+ * @property {string} [datasource]
108
149
  * @property {string} [type]
150
+ * @property {string} [name]
151
+ * @property {string} [application]
152
+ * @property {string} [created_at]
153
+ * @property {string} [updated_at]
154
+ * @property {string} [slug]
155
+ * @property {number} [__v]
109
156
  */
110
157
  /**
111
158
  * @typedef Campaigns
@@ -113,36 +160,63 @@ export = CommunicationPlatformModel;
113
160
  * @property {Page} [page]
114
161
  */
115
162
  /**
116
- * @typedef CampignEmailProvider
117
- * @property {string} [_id]
118
- * @property {string} [from_email]
119
- * @property {string} [from_name]
163
+ * @typedef BadRequestSchema
164
+ * @property {string} [status] - Response status.
165
+ * @property {string} [message] - Failure message.
120
166
  */
121
167
  /**
122
- * @typedef CommunicationTemplate
123
- * @property {boolean} [subscribed] - Whether the user is subscribed or not
124
- * @property {string} [template] - Template ID
168
+ * @typedef NotFound
169
+ * @property {string} [message] - Failure message.
125
170
  */
126
171
  /**
127
- * @typedef CreateJobsReq
128
- * @property {string} [campaign]
172
+ * @typedef AudienceReq
173
+ * @property {string} [name]
174
+ * @property {string} [description]
175
+ * @property {string[]} [tags]
176
+ * @property {string} [file_url]
177
+ * @property {string} [type]
178
+ * @property {number} [records_count]
179
+ * @property {string[]} [headers]
129
180
  */
130
181
  /**
131
- * @typedef CreateJobsRes
132
- * @property {number} [__v]
182
+ * @typedef Audience
133
183
  * @property {string} [_id]
134
184
  * @property {string} [application]
135
- * @property {string} [campaign]
136
- * @property {boolean} [completed]
137
- * @property {string} [created_at]
185
+ * @property {string} [name]
186
+ * @property {string} [description]
187
+ * @property {number} [records_count]
188
+ * @property {string} [type]
189
+ * @property {string[]} [tags]
190
+ * @property {string[]} [headers]
191
+ * @property {string} [file_url]
138
192
  * @property {boolean} [is_active]
193
+ * @property {string} [created_at]
139
194
  * @property {string} [updated_at]
195
+ * @property {string} [slug]
196
+ * @property {number} [__v]
140
197
  */
141
198
  /**
142
- * @typedef DefaultSmsProviders
143
- * @property {string} [_id]
144
- * @property {boolean} [is_default]
145
- * @property {string} [name]
199
+ * @typedef Audiences
200
+ * @property {Audience[]} [items]
201
+ * @property {Page} [page]
202
+ */
203
+ /**
204
+ * @typedef GetNRecordsCsvReq
205
+ * @property {string} [url]
206
+ * @property {boolean} [header]
207
+ * @property {number} [count]
208
+ */
209
+ /**
210
+ * @typedef GetNRecordsCsvResItems
211
+ * @property {string} [phone_number]
212
+ * @property {string} [email]
213
+ * @property {string} [firstname]
214
+ * @property {string} [lastname]
215
+ * @property {string} [orderid]
216
+ */
217
+ /**
218
+ * @typedef GetNRecordsCsvRes
219
+ * @property {GetNRecordsCsvResItems[]} [items]
146
220
  */
147
221
  /**
148
222
  * @typedef DummyDatasources
@@ -151,110 +225,141 @@ export = CommunicationPlatformModel;
151
225
  */
152
226
  /**
153
227
  * @typedef DummyDatasourcesMeta
154
- * @property {DummyDatasourcesMetaObj} [data]
155
228
  * @property {number} [id]
229
+ * @property {DummyDatasourcesMetaObj} [data]
156
230
  */
157
231
  /**
158
232
  * @typedef DummyDatasourcesMetaObj
159
233
  * @property {number} [b]
160
234
  */
161
235
  /**
162
- * @typedef EmailProvider
163
- * @property {number} [__v]
164
- * @property {string} [_id]
165
- * @property {string} [api_key]
166
- * @property {string} [application]
167
- * @property {string} [created_at]
168
- * @property {string} [description]
169
- * @property {EmailProviderReqFrom[]} [from_address]
236
+ * @typedef EmailProviderReqFrom
170
237
  * @property {string} [name]
171
- * @property {string} [provider]
172
- * @property {string} [slug]
173
- * @property {string} [type]
174
- * @property {string} [updated_at]
238
+ * @property {string} [email]
239
+ * @property {boolean} [is_default]
175
240
  */
176
241
  /**
177
242
  * @typedef EmailProviderReq
178
- * @property {string} [api_key]
179
- * @property {string} [description]
180
- * @property {EmailProviderReqFrom[]} [from_address]
181
243
  * @property {string} [name]
182
- * @property {string} [provider]
244
+ * @property {string} [description]
245
+ * @property {string} [api_key]
183
246
  * @property {string} [type]
247
+ * @property {string} [provider]
248
+ * @property {EmailProviderReqFrom[]} [from_address]
184
249
  */
185
250
  /**
186
- * @typedef EmailProviderReqFrom
187
- * @property {string} [email]
188
- * @property {boolean} [is_default]
189
- * @property {string} [name]
190
- */
191
- /**
192
- * @typedef EmailProviders
193
- * @property {EmailProvider[]} [items]
194
- * @property {Page} [page]
195
- */
196
- /**
197
- * @typedef EmailTemplate
198
- * @property {number} [__v]
251
+ * @typedef EmailProvider
252
+ * @property {string} [type]
253
+ * @property {string} [provider]
254
+ * @property {EmailProviderReqFrom[]} [from_address]
199
255
  * @property {string} [_id]
256
+ * @property {string} [name]
257
+ * @property {string} [description]
258
+ * @property {string} [api_key]
200
259
  * @property {string} [application]
201
- * @property {number[]} [attachments]
202
- * @property {string} [category]
203
260
  * @property {string} [created_at]
204
- * @property {string} [description]
205
- * @property {string} [editor_meta]
206
- * @property {string} [editor_type]
207
- * @property {string} [from_name]
208
- * @property {EmailTemplateHeaders[]} [headers]
209
- * @property {TemplateAndType} [html]
210
- * @property {boolean} [is_internal]
211
- * @property {boolean} [is_system]
212
- * @property {string} [name]
213
- * @property {string} [priority]
214
- * @property {boolean} [published]
215
- * @property {string} [reply_to]
216
- * @property {string} [slug]
217
- * @property {string[]} [static_bcc]
218
- * @property {string[]} [static_cc]
219
- * @property {string[]} [static_to]
220
- * @property {TemplateAndType} [subject]
221
- * @property {string[]} [tags]
222
- * @property {Object} [template_variables]
223
- * @property {TemplateAndType} [text]
224
261
  * @property {string} [updated_at]
225
- * @property {EnabledObj} [url_shorten]
262
+ * @property {string} [slug]
263
+ * @property {number} [__v]
226
264
  */
227
265
  /**
228
- * @typedef EmailTemplateHeaders
229
- * @property {string} [key]
230
- * @property {string} [value]
266
+ * @typedef EmailProviders
267
+ * @property {EmailProvider[]} [items]
268
+ * @property {Page} [page]
231
269
  */
232
270
  /**
233
271
  * @typedef EmailTemplateKeys
234
- * @property {string} [bcc]
235
- * @property {string} [cc]
236
272
  * @property {string} [to]
273
+ * @property {string} [cc]
274
+ * @property {string} [bcc]
275
+ */
276
+ /**
277
+ * @typedef EmailTemplateHeaders
278
+ * @property {string} [key]
279
+ * @property {string} [value]
237
280
  */
238
281
  /**
239
282
  * @typedef EmailTemplateReq
240
- * @property {number[]} [attachments]
283
+ * @property {string} name
241
284
  * @property {string} [description]
242
- * @property {string} [editor_meta]
243
- * @property {string} [editor_type]
244
285
  * @property {string} [from_name]
245
- * @property {EmailTemplateHeaders[]} [headers]
286
+ * @property {string[]} [static_to]
287
+ * @property {string[]} [static_cc]
288
+ * @property {string[]} [static_bcc]
289
+ * @property {string} [reply_to]
290
+ * @property {string} [priority]
291
+ * @property {string[]} [tags]
292
+ * @property {Object} [template_variables]
293
+ * @property {boolean} [published]
294
+ * @property {TemplateAndType} [subject]
246
295
  * @property {TemplateAndType} [html]
296
+ * @property {string} [editor_type]
297
+ * @property {string} [editor_meta]
298
+ * @property {number[]} [attachments]
299
+ * @property {EmailTemplateHeaders[]} [headers]
247
300
  * @property {EmailTemplateKeys} [keys]
248
- * @property {string} name
301
+ * @property {TemplateAndType} [text]
302
+ */
303
+ /**
304
+ * @typedef TemplateAndType
305
+ * @property {string} [template_type]
306
+ * @property {string} [template]
307
+ */
308
+ /**
309
+ * @typedef EmailTemplate
310
+ * @property {string} [application]
311
+ * @property {boolean} [is_system]
312
+ * @property {boolean} [is_internal]
313
+ * @property {string} [name]
314
+ * @property {string} [description]
315
+ * @property {string} [editor_type]
316
+ * @property {string} [editor_meta]
317
+ * @property {string[]} [static_to]
318
+ * @property {string[]} [static_cc]
319
+ * @property {string[]} [static_bcc]
320
+ * @property {string} [reply_to]
321
+ * @property {string[]} [tags]
322
+ * @property {TemplateAndType} [subject]
323
+ * @property {TemplateAndType} [html]
324
+ * @property {EnabledObj} [url_shorten]
249
325
  * @property {string} [priority]
326
+ * @property {Object} [template_variables]
250
327
  * @property {boolean} [published]
251
- * @property {string} [reply_to]
252
- * @property {string[]} [static_bcc]
253
- * @property {string[]} [static_cc]
328
+ * @property {string} [category]
329
+ * @property {string} [_id]
330
+ * @property {EmailTemplateHeaders[]} [headers]
331
+ * @property {number[]} [attachments]
332
+ * @property {string} [created_at]
333
+ * @property {string} [updated_at]
334
+ * @property {string} [slug]
335
+ * @property {number} [__v]
336
+ * @property {string} [from_name]
337
+ * @property {TemplateAndType} [text]
338
+ */
339
+ /**
340
+ * @typedef SystemEmailTemplate
341
+ * @property {boolean} [is_system]
342
+ * @property {boolean} [is_internal]
343
+ * @property {string} [name]
344
+ * @property {string} [description]
254
345
  * @property {string[]} [static_to]
255
- * @property {TemplateAndType} [subject]
346
+ * @property {string[]} [static_cc]
347
+ * @property {string[]} [static_bcc]
256
348
  * @property {string[]} [tags]
349
+ * @property {TemplateAndType} [subject]
350
+ * @property {TemplateAndType} [html]
351
+ * @property {EnabledObj} [url_shorten]
352
+ * @property {string} [priority]
257
353
  * @property {Object} [template_variables]
354
+ * @property {boolean} [published]
355
+ * @property {string} [category]
356
+ * @property {string} [_id]
357
+ * @property {EmailTemplateHeaders[]} [headers]
358
+ * @property {number[]} [attachments]
359
+ * @property {string} [created_at]
360
+ * @property {string} [updated_at]
361
+ * @property {string} [slug]
362
+ * @property {number} [__v]
258
363
  * @property {TemplateAndType} [text]
259
364
  */
260
365
  /**
@@ -263,123 +368,112 @@ export = CommunicationPlatformModel;
263
368
  * @property {Page} [page]
264
369
  */
265
370
  /**
266
- * @typedef EnabledObj
267
- * @property {boolean} [enabled]
268
- */
269
- /**
270
- * @typedef EngineRequest
271
- * @property {MetaStructure} [meta]
272
- * @property {PayloadStructure} [payload]
371
+ * @typedef SystemEmailTemplates
372
+ * @property {SystemEmailTemplate[]} [items]
273
373
  */
274
374
  /**
275
- * @typedef EngineResponse
276
- * @property {boolean} [success]
375
+ * @typedef PayloadEmailTemplateStructure
376
+ * @property {string} [key]
377
+ * @property {Object} [value]
277
378
  */
278
379
  /**
279
- * @typedef EventSubscription
280
- * @property {number} [__v]
380
+ * @typedef PayloadEmailProviderStructure
281
381
  * @property {string} [_id]
282
- * @property {string} [application]
283
- * @property {string} [created_at]
284
- * @property {string} [event]
285
- * @property {boolean} [is_default]
286
- * @property {string} [slug]
287
- * @property {EventSubscriptionTemplate} [template]
288
- * @property {string} [updated_at]
289
382
  */
290
383
  /**
291
- * @typedef EventSubscriptions
292
- * @property {EventSubscription[]} [items]
293
- * @property {Page} [page]
384
+ * @typedef PayloadEmailStructure
385
+ * @property {PayloadEmailTemplateStructure} [template]
386
+ * @property {PayloadEmailProviderStructure} [provider]
294
387
  */
295
388
  /**
296
- * @typedef EventSubscriptionsBulkUpdateRequest
297
- * @property {SubscriptionsObject[]} [subscriptions]
389
+ * @typedef PayloadSmsTemplateStructure
390
+ * @property {string} [key]
391
+ * @property {Object} [value]
298
392
  */
299
393
  /**
300
- * @typedef EventSubscriptionsBulkUpdateResponse
301
- * @property {number} [__v]
394
+ * @typedef PayloadSmsProviderStructure
302
395
  * @property {string} [_id]
396
+ */
397
+ /**
398
+ * @typedef PayloadSmsStructure
399
+ * @property {PayloadSmsTemplateStructure} [template]
400
+ * @property {PayloadSmsProviderStructure} [provider]
401
+ */
402
+ /**
403
+ * @typedef PayloadStructure
404
+ * @property {Object[]} [data]
405
+ * @property {PayloadEmailStructure} [email]
406
+ * @property {PayloadSmsStructure} [sms]
303
407
  * @property {string} [application]
304
- * @property {string} [category]
305
- * @property {string} [created_at]
306
- * @property {string} [event]
307
- * @property {string} [slug]
308
- * @property {EventSubscriptionTemplate} [template]
309
- * @property {string} [updated_at]
310
408
  */
311
409
  /**
312
- * @typedef EventSubscriptionTemplate
313
- * @property {EventSubscriptionTemplateEmail} [email]
314
- * @property {EventSubscriptionTemplateSms} [sms]
410
+ * @typedef MetaStructure
411
+ * @property {string} [job_type]
412
+ * @property {string} [action]
413
+ * @property {string} [trace]
414
+ * @property {string} [timestamp]
315
415
  */
316
416
  /**
317
- * @typedef EventSubscriptionTemplateEmail
417
+ * @typedef EngineRequest
418
+ * @property {PayloadStructure} [payload]
419
+ * @property {MetaStructure} [meta]
420
+ */
421
+ /**
422
+ * @typedef EngineResponse
423
+ * @property {boolean} [success]
424
+ */
425
+ /**
426
+ * @typedef EventSubscriptionTemplateSms
318
427
  * @property {boolean} [subscribed]
319
428
  * @property {string} [template]
320
429
  */
321
430
  /**
322
- * @typedef EventSubscriptionTemplateSms
431
+ * @typedef EventSubscriptionTemplateEmail
323
432
  * @property {boolean} [subscribed]
324
433
  * @property {string} [template]
325
434
  */
326
435
  /**
327
- * @typedef GenericDelete
328
- * @property {boolean} [acknowledged]
329
- * @property {number} [affected]
330
- * @property {string} [message]
331
- * @property {string} [operation]
436
+ * @typedef EventSubscriptionTemplate
437
+ * @property {EventSubscriptionTemplateSms} [sms]
438
+ * @property {EventSubscriptionTemplateEmail} [email]
332
439
  */
333
440
  /**
334
- * @typedef GenericError
335
- * @property {Message} [message]
336
- * @property {string} [sentry]
441
+ * @typedef EventSubscription
442
+ * @property {EventSubscriptionTemplate} [template]
443
+ * @property {boolean} [is_default]
444
+ * @property {string} [_id]
445
+ * @property {string} [application]
446
+ * @property {string} [event]
447
+ * @property {string} [slug]
448
+ * @property {string} [created_at]
449
+ * @property {string} [updated_at]
450
+ * @property {number} [__v]
337
451
  */
338
452
  /**
339
- * @typedef GetNRecordsCsvReq
340
- * @property {number} [count]
341
- * @property {boolean} [header]
342
- * @property {string} [url]
453
+ * @typedef EventSubscriptions
454
+ * @property {EventSubscription[]} [items]
455
+ * @property {Page} [page]
343
456
  */
344
457
  /**
345
- * @typedef GetNRecordsCsvRes
346
- * @property {GetNRecordsCsvResItems[]} [items]
458
+ * @typedef TriggerJobResponse
459
+ * @property {number} [status]
347
460
  */
348
461
  /**
349
- * @typedef GetNRecordsCsvResItems
350
- * @property {string} [email]
351
- * @property {string} [firstname]
352
- * @property {string} [lastname]
353
- * @property {string} [orderid]
354
- * @property {string} [phone_number]
462
+ * @typedef TriggerJobRequest
463
+ * @property {string} [job_id]
355
464
  */
356
465
  /**
357
- * @typedef GetStats
358
- * @property {Stats[]} [items]
359
- */
360
- /**
361
- * @typedef GlobalProviders
362
- * @property {GlobalProvidersResObj[]} [email]
363
- * @property {GlobalProvidersResObj[]} [sms]
364
- * @property {GlobalProvidersResObj[]} [voice]
365
- */
366
- /**
367
- * @typedef GlobalProvidersResObj
368
- * @property {string} [_id]
369
- * @property {string} [name]
370
- */
371
- /**
372
- * @typedef GlobalVariablesGetResponse
373
- * @property {Object} [editable]
374
- * @property {Object} [read_only]
466
+ * @typedef GlobalVariablesGetResponse
467
+ * @property {Object} [read_only]
468
+ * @property {Object} [editable]
375
469
  */
376
470
  /**
377
471
  * @typedef GlobalVariablesPostResponse
378
472
  * @property {string} [_id]
379
- * @property {string} [application]
380
473
  * @property {string} [category]
381
- * @property {string} [created_at]
474
+ * @property {string} [application]
382
475
  * @property {Object} [global_variables]
476
+ * @property {string} [created_at]
383
477
  */
384
478
  /**
385
479
  * @typedef GlobalVariablesReq
@@ -387,66 +481,81 @@ export = CommunicationPlatformModel;
387
481
  */
388
482
  /**
389
483
  * @typedef Job
390
- * @property {number} [__v]
484
+ * @property {boolean} [completed]
485
+ * @property {boolean} [is_active]
391
486
  * @property {string} [_id]
487
+ * @property {string} [campaign]
488
+ * @property {string} [application]
489
+ * @property {string} [created_at]
490
+ * @property {string} [updated_at]
491
+ * @property {number} [__v]
492
+ */
493
+ /**
494
+ * @typedef Jobs
495
+ * @property {Job[]} [items]
496
+ * @property {Page} [page]
497
+ */
498
+ /**
499
+ * @typedef CreateJobsRes
392
500
  * @property {string} [application]
393
501
  * @property {string} [campaign]
394
502
  * @property {boolean} [completed]
395
- * @property {string} [created_at]
396
503
  * @property {boolean} [is_active]
504
+ * @property {string} [_id]
505
+ * @property {string} [created_at]
397
506
  * @property {string} [updated_at]
507
+ * @property {number} [__v]
508
+ */
509
+ /**
510
+ * @typedef CreateJobsReq
511
+ * @property {string} [campaign]
398
512
  */
399
513
  /**
400
514
  * @typedef JobLog
401
- * @property {number} [__v]
515
+ * @property {Object} [imported]
516
+ * @property {Object} [processed]
402
517
  * @property {string} [_id]
518
+ * @property {string} [job]
403
519
  * @property {string} [campaign]
404
520
  * @property {string} [created_at]
405
- * @property {Object} [imported]
406
- * @property {string} [job]
407
- * @property {Object} [processed]
408
521
  * @property {string} [updated_at]
522
+ * @property {number} [__v]
409
523
  */
410
524
  /**
411
525
  * @typedef JobLogs
412
526
  * @property {JobLog[]} [items]
413
527
  * @property {Page} [page]
414
528
  */
415
- /**
416
- * @typedef Jobs
417
- * @property {Job[]} [items]
418
- * @property {Page} [page]
419
- */
420
- /**
421
- * @typedef Log
422
- * @property {string} [_id]
423
- * @property {string} [application]
424
- * @property {string} [created_at]
425
- * @property {Object} [data]
426
- * @property {LogEmail} [email]
427
- * @property {string} [expire_at]
428
- * @property {LogMeta} [meta]
429
- * @property {LogPushnotification} [pushnotification]
430
- * @property {string} [service]
431
- * @property {string} [status]
432
- * @property {string} [step]
433
- */
434
529
  /**
435
530
  * @typedef LogEmail
436
531
  * @property {string} [template]
437
532
  */
533
+ /**
534
+ * @typedef LogPushnotification
535
+ * @property {string[]} [pushtokens]
536
+ */
438
537
  /**
439
538
  * @typedef LogMeta
539
+ * @property {string} [type]
440
540
  * @property {string} [identifier]
441
541
  * @property {string} [key]
442
542
  * @property {string} [offset]
443
543
  * @property {string} [partition]
444
544
  * @property {string} [topic]
445
- * @property {string} [type]
446
545
  */
447
546
  /**
448
- * @typedef LogPushnotification
449
- * @property {string[]} [pushtokens]
547
+ * @typedef Log
548
+ * @property {LogEmail} [email]
549
+ * @property {LogPushnotification} [pushnotification]
550
+ * @property {LogMeta} [meta]
551
+ * @property {string} [_id]
552
+ * @property {string} [application]
553
+ * @property {string} [service]
554
+ * @property {string} [step]
555
+ * @property {string} [status]
556
+ * @property {Object} [data]
557
+ * @property {string} [expire_at]
558
+ * @property {string} [created_at]
450
559
  */
451
560
  /**
452
561
  * @typedef Logs
@@ -454,579 +563,564 @@ export = CommunicationPlatformModel;
454
563
  * @property {Page} [page]
455
564
  */
456
565
  /**
457
- * @typedef Message
458
- * @property {string} [info]
459
- * @property {string} [message]
460
- * @property {string} [operation]
461
- * @property {boolean} [success]
462
- */
463
- /**
464
- * @typedef metaObj
465
- * @property {boolean} [is_system]
466
- * @property {string} [template]
467
- * @property {string} [type]
468
- */
469
- /**
470
- * @typedef MetaStructure
471
- * @property {string} [action]
472
- * @property {string} [job_type]
473
- * @property {string} [timestamp]
474
- * @property {string} [trace]
475
- */
476
- /**
477
- * @typedef NotFound
478
- * @property {string} [message] - Failure message.
479
- */
480
- /**
481
- * @typedef Notification
482
- * @property {string} [body]
483
- * @property {string} [click_action]
484
- * @property {string} [deeplink]
485
- * @property {string} [icon]
486
- * @property {string} [subtitle]
487
- * @property {string} [title]
488
- */
489
- /**
490
- * @typedef OtpConfiguration
491
- * @property {string} [application_id]
492
- * @property {string} [company_id]
493
- * @property {OtpConfigurationExpiry} expiry
494
- * @property {number} otp_length
495
- * @property {string} type
496
- */
497
- /**
498
- * @typedef OtpConfigurationExpiry
499
- * @property {OtpConfigurationExpiryDuration} duration
500
- * @property {string} type
501
- */
502
- /**
503
- * @typedef OtpConfigurationExpiryDuration
504
- * @property {string} denomination
505
- * @property {number} time
506
- */
507
- /**
508
- * @typedef Page
509
- * @property {number} [current]
510
- * @property {boolean} [has_next]
511
- * @property {boolean} [has_previous]
512
- * @property {number} [item_total]
513
- * @property {string} [next_id]
514
- * @property {number} [size]
515
- * @property {string} type
516
- */
517
- /**
518
- * @typedef PayloadEmailProviderStructure
519
- * @property {string} [_id]
520
- */
521
- /**
522
- * @typedef PayloadEmailStructure
523
- * @property {PayloadEmailProviderStructure} [provider]
524
- * @property {PayloadEmailTemplateStructure} [template]
525
- */
526
- /**
527
- * @typedef PayloadEmailTemplateStructure
566
+ * @typedef SendOtpSmsCommsTemplate
528
567
  * @property {string} [key]
529
568
  * @property {Object} [value]
530
569
  */
531
570
  /**
532
- * @typedef PayloadSmsProviderStructure
571
+ * @typedef SendOtpSmsCommsProvider
572
+ * @property {string} [slug]
533
573
  * @property {string} [_id]
534
574
  */
535
575
  /**
536
- * @typedef PayloadSmsStructure
537
- * @property {PayloadSmsProviderStructure} [provider]
538
- * @property {PayloadSmsTemplateStructure} [template]
576
+ * @typedef SendOtpEmailCommsProvider
577
+ * @property {string} [slug]
578
+ * @property {string} [_id]
539
579
  */
540
580
  /**
541
- * @typedef PayloadSmsTemplateStructure
581
+ * @typedef SendOtpEmailCommsTemplate
542
582
  * @property {string} [key]
543
583
  * @property {Object} [value]
544
584
  */
545
- /**
546
- * @typedef PayloadStructure
547
- * @property {string} [application]
548
- * @property {Object[]} [data]
549
- * @property {PayloadEmailStructure} [email]
550
- * @property {PayloadSmsStructure} [sms]
551
- */
552
- /**
553
- * @typedef RecipientHeaders
554
- * @property {string} [email]
555
- */
556
- /**
557
- * @typedef SendOtpCommsReq
558
- * @property {SendOtpCommsReqData} [data]
559
- * @property {SendOtpCommsReqEmail} [email]
560
- * @property {SendOtpCommsReqSms} [sms]
561
- */
562
585
  /**
563
586
  * @typedef SendOtpCommsReqData
564
- * @property {string} [country_code]
565
- * @property {string} [mobile]
566
587
  * @property {boolean} [send_same_otp_to_channel]
588
+ * @property {string} [mobile]
589
+ * @property {string} [country_code]
567
590
  * @property {string} [to]
568
591
  */
569
- /**
570
- * @typedef SendOtpCommsReqEmail
571
- * @property {number} [expiry]
572
- * @property {number} [otp_length]
573
- * @property {SendOtpEmailCommsProvider} [provider]
574
- * @property {SendOtpEmailCommsTemplate} [template]
575
- */
576
592
  /**
577
593
  * @typedef SendOtpCommsReqSms
578
- * @property {number} [expiry]
579
594
  * @property {number} [otp_length]
580
- * @property {SendOtpSmsCommsProvider} [provider]
595
+ * @property {number} [expiry]
581
596
  * @property {SendOtpSmsCommsTemplate} [template]
597
+ * @property {SendOtpSmsCommsProvider} [provider]
582
598
  */
583
599
  /**
584
- * @typedef SendOtpCommsRes
585
- * @property {SendOtpCommsResEmail} [email]
586
- * @property {SendOtpCommsResSms} [sms]
587
- */
588
- /**
589
- * @typedef SendOtpCommsResEmail
590
- * @property {string} [message]
591
- * @property {string} [request_id]
592
- * @property {number} [resend_timer]
593
- * @property {boolean} [success]
594
- * @property {string} [to]
600
+ * @typedef SendOtpCommsReqEmail
601
+ * @property {number} [otp_length]
602
+ * @property {number} [expiry]
603
+ * @property {SendOtpEmailCommsTemplate} [template]
604
+ * @property {SendOtpEmailCommsProvider} [provider]
595
605
  */
596
606
  /**
597
607
  * @typedef SendOtpCommsResSms
598
- * @property {string} [country_code]
608
+ * @property {boolean} [success]
609
+ * @property {string} [request_id]
599
610
  * @property {string} [message]
600
611
  * @property {string} [mobile]
601
- * @property {string} [request_id]
612
+ * @property {string} [country_code]
602
613
  * @property {number} [resend_timer]
603
- * @property {boolean} [success]
604
614
  */
605
615
  /**
606
- * @typedef SendOtpEmailCommsProvider
607
- * @property {string} [_id]
608
- * @property {string} [slug]
616
+ * @typedef SendOtpCommsResEmail
617
+ * @property {boolean} [success]
618
+ * @property {string} [request_id]
619
+ * @property {string} [message]
620
+ * @property {string} [to]
621
+ * @property {number} [resend_timer]
609
622
  */
610
623
  /**
611
- * @typedef SendOtpEmailCommsTemplate
612
- * @property {string} [key]
613
- * @property {Object} [value]
624
+ * @typedef SendOtpCommsReq
625
+ * @property {SendOtpCommsReqData} [data]
626
+ * @property {SendOtpCommsReqSms} [sms]
627
+ * @property {SendOtpCommsReqEmail} [email]
614
628
  */
615
629
  /**
616
- * @typedef SendOtpSmsCommsProvider
617
- * @property {string} [_id]
618
- * @property {string} [slug]
630
+ * @typedef SendOtpCommsRes
631
+ * @property {SendOtpCommsResSms} [sms]
632
+ * @property {SendOtpCommsResEmail} [email]
619
633
  */
620
634
  /**
621
- * @typedef SendOtpSmsCommsTemplate
622
- * @property {string} [key]
623
- * @property {Object} [value]
635
+ * @typedef VerifyOtpCommsReq
636
+ * @property {string} [request_id]
637
+ * @property {string} [otp]
624
638
  */
625
639
  /**
626
- * @typedef SmsProvider
627
- * @property {number} [__v]
628
- * @property {string} [_id]
629
- * @property {string} [application]
630
- * @property {string} [authkey]
631
- * @property {string} [created_at]
632
- * @property {string} [description]
633
- * @property {string} [name]
634
- * @property {string} [provider]
635
- * @property {number} [rpt]
636
- * @property {string} [sender]
637
- * @property {string} [slug]
638
- * @property {string} [type]
639
- * @property {string} [updated_at]
640
- * @property {string} [username]
640
+ * @typedef VerifyOtpCommsSuccessRes
641
+ * @property {boolean} [success]
642
+ * @property {string} [mobile]
643
+ * @property {string} [country_code]
644
+ * @property {string} [message]
645
+ */
646
+ /**
647
+ * @typedef VerifyOtpCommsErrorRes
648
+ * @property {boolean} [success]
649
+ * @property {string} [message]
641
650
  */
642
651
  /**
643
652
  * @typedef SmsProviderReq
644
- * @property {string} [api_key] - The api_key for the test.
645
- * @property {string} [apikey] - The apikey for the test.
646
- * @property {string} [authkey]
653
+ * @property {string} [name]
647
654
  * @property {string} [description]
648
- * @property {string} [entity_id] - The entity ID for the test.
649
- * @property {string} [entityid] - The entity ID for the test.
655
+ * @property {string} [sender]
656
+ * @property {string} [username]
657
+ * @property {string} [authkey]
658
+ * @property {string} [type]
659
+ * @property {string} [provider]
660
+ * @property {string} [password] - The password for the test.
661
+ * @property {string} [senderid] - The sender ID for the test.
650
662
  * @property {string} [feedid] - The feed ID for the test.
651
- * @property {string} [host] - The host for the test.
652
- * @property {string} [name]
663
+ * @property {string} [entityid] - The entity ID for the test.
653
664
  * @property {boolean} [override_dnd] - Whether to override Do Not Disturb.
654
- * @property {string} [password] - The password for the test.
665
+ * @property {string} [host] - The host for the test.
655
666
  * @property {number} [port] - The port for the test.
656
- * @property {string} [provider]
657
- * @property {string} [sender]
667
+ * @property {string} [entity_id] - The entity ID for the test.
668
+ * @property {string} [apikey] - The apikey for the test.
669
+ * @property {number} [version_id] - The version ID for the test.
658
670
  * @property {string} [sender_id] - The sender ID for the test.
659
- * @property {string} [senderid] - The sender ID for the test.
671
+ * @property {string} [api_key] - The api_key for the test.
672
+ */
673
+ /**
674
+ * @typedef SmsProvider
675
+ * @property {number} [rpt]
660
676
  * @property {string} [type]
677
+ * @property {string} [provider]
678
+ * @property {string} [_id]
679
+ * @property {string} [name]
680
+ * @property {string} [description]
681
+ * @property {string} [sender]
661
682
  * @property {string} [username]
662
- * @property {number} [version_id] - The version ID for the test.
683
+ * @property {string} [authkey]
684
+ * @property {string} [application]
685
+ * @property {string} [created_at]
686
+ * @property {string} [updated_at]
687
+ * @property {string} [slug]
688
+ * @property {number} [__v]
663
689
  */
664
690
  /**
665
691
  * @typedef SmsProviders
666
692
  * @property {SmsProvider[]} [items]
667
693
  * @property {Page} [page]
668
694
  */
695
+ /**
696
+ * @typedef DefaultSmsProviders
697
+ * @property {string} [_id]
698
+ * @property {string} [name]
699
+ * @property {boolean} [is_default]
700
+ */
701
+ /**
702
+ * @typedef SmsTemplateMessage
703
+ * @property {string} [template_type]
704
+ * @property {string} [template]
705
+ */
706
+ /**
707
+ * @typedef SmsTemplates
708
+ * @property {SmsTemplate[]} [items]
709
+ * @property {Page} [page]
710
+ */
669
711
  /**
670
712
  * @typedef SmsTemplate
671
- * @property {number} [__v]
713
+ * @property {EnabledObj} [url_shorten]
672
714
  * @property {string} [_id]
673
715
  * @property {string} [application]
674
- * @property {string} [category]
675
- * @property {string} [created_at]
676
- * @property {string} [description]
677
- * @property {boolean} [is_internal]
678
716
  * @property {boolean} [is_system]
679
- * @property {SmsTemplateMessage} [message]
717
+ * @property {boolean} [is_internal]
680
718
  * @property {metaObj} [meta]
681
719
  * @property {string} [name]
720
+ * @property {string} [description]
721
+ * @property {SmsTemplateMessage} [message]
682
722
  * @property {string} [priority]
723
+ * @property {string[]} [tags]
724
+ * @property {Object} [template_variables]
725
+ * @property {string} [template_id]
683
726
  * @property {boolean} [published]
727
+ * @property {string} [category]
728
+ * @property {string} [created_at]
729
+ * @property {string} [updated_at]
684
730
  * @property {string} [slug]
731
+ * @property {number} [__v]
732
+ */
733
+ /**
734
+ * @typedef SystemSmsTemplates
735
+ * @property {EnabledObj} [url_shorten]
736
+ * @property {string} [_id]
737
+ * @property {boolean} [is_system]
738
+ * @property {boolean} [is_internal]
739
+ * @property {string} [name]
740
+ * @property {string} [description]
741
+ * @property {SmsTemplateMessage} [message]
742
+ * @property {string} [priority]
685
743
  * @property {string[]} [tags]
686
- * @property {string} [template_id]
687
744
  * @property {Object} [template_variables]
745
+ * @property {string} [template_id]
746
+ * @property {boolean} [published]
747
+ * @property {string} [category]
748
+ * @property {string} [created_at]
688
749
  * @property {string} [updated_at]
689
- * @property {EnabledObj} [url_shorten]
750
+ * @property {string} [slug]
751
+ * @property {number} [__v]
690
752
  */
691
753
  /**
692
- * @typedef SmsTemplateMessage
754
+ * @typedef metaObj
755
+ * @property {string} [type]
756
+ * @property {boolean} [is_system]
693
757
  * @property {string} [template]
694
- * @property {string} [template_type]
695
758
  */
696
759
  /**
697
760
  * @typedef SmsTemplateReq
698
- * @property {string} [description]
699
- * @property {SmsTemplateMessage} [message]
700
- * @property {metaObj} [meta]
701
761
  * @property {string} name
762
+ * @property {string} [description]
702
763
  * @property {string} [priority]
703
- * @property {boolean} [published]
704
764
  * @property {string} [template_id]
765
+ * @property {metaObj} [meta]
705
766
  * @property {Object} [template_variables]
767
+ * @property {boolean} [published]
768
+ * @property {SmsTemplateMessage} [message]
706
769
  */
707
770
  /**
708
- * @typedef SmsTemplates
709
- * @property {SmsTemplate[]} [items]
710
- * @property {Page} [page]
771
+ * @typedef Notification
772
+ * @property {string} [title]
773
+ * @property {string} [body]
774
+ * @property {string} [subtitle]
775
+ * @property {string} [icon]
776
+ * @property {string} [deeplink]
777
+ * @property {string} [click_action]
711
778
  */
712
779
  /**
713
- * @typedef Stats
714
- * @property {string} [_id]
715
- * @property {Object} [imported]
716
- * @property {Object} [processed]
780
+ * @typedef SystemNotificationUser
781
+ * @property {string} [type]
782
+ * @property {string} [value]
717
783
  */
718
784
  /**
719
- * @typedef StatsImported
720
- * @property {number} [count]
785
+ * @typedef SystemNotification
786
+ * @property {Notification} [notification]
787
+ * @property {SystemNotificationUser} [user]
788
+ * @property {SystemNotificationUser} [settings]
789
+ * @property {string} [_id]
790
+ * @property {string} [group]
791
+ * @property {string} [created_at]
721
792
  */
722
793
  /**
723
- * @typedef StatsProcessed
724
- * @property {StatsProcessedEmail} [email]
725
- * @property {StatsProcessedSms} [sms]
794
+ * @typedef SystemNotifications
795
+ * @property {SystemNotification[]} [items]
796
+ * @property {number} [last_read_anchor]
797
+ * @property {Page} [page]
726
798
  */
727
799
  /**
728
- * @typedef StatsProcessedEmail
729
- * @property {number} [failed]
730
- * @property {number} [success]
731
- * @property {number} [suppressed]
800
+ * @typedef Page
801
+ * @property {number} [item_total]
802
+ * @property {string} [next_id]
803
+ * @property {boolean} [has_previous]
804
+ * @property {boolean} [has_next]
805
+ * @property {number} [current]
806
+ * @property {string} type
807
+ * @property {number} [size]
732
808
  */
733
809
  /**
734
- * @typedef StatsProcessedSms
735
- * @property {number} [failed]
736
- * @property {number} [success]
737
- * @property {number} [suppressed]
810
+ * @typedef GenericError
811
+ * @property {Message} [message]
812
+ * @property {string} [sentry]
738
813
  */
739
814
  /**
740
- * @typedef SubscriptionsObject
741
- * @property {string} [_id] - Subscription ID
742
- * @property {TemplateObject} [template]
815
+ * @typedef GenericDelete
816
+ * @property {string} [message]
817
+ * @property {boolean} [acknowledged]
818
+ * @property {number} [affected]
819
+ * @property {string} [operation]
743
820
  */
744
821
  /**
745
- * @typedef SystemEmailTemplate
746
- * @property {number} [__v]
747
- * @property {string} [_id]
748
- * @property {number[]} [attachments]
749
- * @property {string} [category]
750
- * @property {string} [created_at]
751
- * @property {string} [description]
752
- * @property {EmailTemplateHeaders[]} [headers]
753
- * @property {TemplateAndType} [html]
754
- * @property {boolean} [is_internal]
755
- * @property {boolean} [is_system]
756
- * @property {string} [name]
757
- * @property {string} [priority]
758
- * @property {boolean} [published]
759
- * @property {string} [slug]
760
- * @property {string[]} [static_bcc]
761
- * @property {string[]} [static_cc]
762
- * @property {string[]} [static_to]
763
- * @property {TemplateAndType} [subject]
764
- * @property {string[]} [tags]
765
- * @property {Object} [template_variables]
766
- * @property {TemplateAndType} [text]
767
- * @property {string} [updated_at]
768
- * @property {EnabledObj} [url_shorten]
822
+ * @typedef Message
823
+ * @property {string} [message]
824
+ * @property {boolean} [success]
825
+ * @property {string} [info]
826
+ * @property {string} [operation]
769
827
  */
770
828
  /**
771
- * @typedef SystemEmailTemplates
772
- * @property {SystemEmailTemplate[]} [items]
829
+ * @typedef EnabledObj
830
+ * @property {boolean} [enabled]
773
831
  */
774
832
  /**
775
- * @typedef SystemNotification
776
- * @property {string} [_id]
777
- * @property {string} [created_at]
778
- * @property {string} [group]
779
- * @property {Notification} [notification]
780
- * @property {SystemNotificationUser} [settings]
781
- * @property {SystemNotificationUser} [user]
833
+ * @typedef OtpConfigurationExpiryDuration
834
+ * @property {number} time
835
+ * @property {string} denomination
782
836
  */
783
837
  /**
784
- * @typedef SystemNotifications
785
- * @property {SystemNotification[]} [items]
786
- * @property {number} [last_read_anchor]
787
- * @property {Page} [page]
838
+ * @typedef OtpConfigurationExpiry
839
+ * @property {OtpConfigurationExpiryDuration} duration
840
+ * @property {string} type
788
841
  */
789
842
  /**
790
- * @typedef SystemNotificationUser
791
- * @property {string} [type]
792
- * @property {string} [value]
793
- */
794
- /**
795
- * @typedef SystemSmsTemplates
796
- * @property {number} [__v]
797
- * @property {string} [_id]
798
- * @property {string} [category]
799
- * @property {string} [created_at]
800
- * @property {string} [description]
801
- * @property {boolean} [is_internal]
802
- * @property {boolean} [is_system]
803
- * @property {SmsTemplateMessage} [message]
804
- * @property {string} [name]
805
- * @property {string} [priority]
806
- * @property {boolean} [published]
807
- * @property {string} [slug]
808
- * @property {string[]} [tags]
809
- * @property {string} [template_id]
810
- * @property {Object} [template_variables]
811
- * @property {string} [updated_at]
812
- * @property {EnabledObj} [url_shorten]
813
- */
814
- /**
815
- * @typedef TemplateAndType
816
- * @property {string} [template]
817
- * @property {string} [template_type]
818
- */
819
- /**
820
- * @typedef TemplateObject
821
- * @property {CommunicationTemplate} [email]
822
- * @property {CommunicationTemplate} [pushnotification]
823
- * @property {CommunicationTemplate} [sms]
824
- */
825
- /**
826
- * @typedef TriggerJobRequest
827
- * @property {string} [job_id]
828
- */
829
- /**
830
- * @typedef TriggerJobResponse
831
- * @property {number} [status]
832
- */
833
- /**
834
- * @typedef VerifyOtpCommsErrorRes
835
- * @property {string} [message]
836
- * @property {boolean} [success]
837
- */
838
- /**
839
- * @typedef VerifyOtpCommsReq
840
- * @property {string} [otp]
841
- * @property {string} [request_id]
842
- */
843
- /**
844
- * @typedef VerifyOtpCommsSuccessRes
845
- * @property {string} [country_code]
846
- * @property {string} [message]
847
- * @property {string} [mobile]
848
- * @property {boolean} [success]
843
+ * @typedef OtpConfiguration
844
+ * @property {number} otp_length
845
+ * @property {string} type
846
+ * @property {OtpConfigurationExpiry} expiry
847
+ * @property {string} [application_id]
848
+ * @property {string} [company_id]
849
849
  */
850
850
  declare class CommunicationPlatformModel {
851
851
  }
852
852
  declare namespace CommunicationPlatformModel {
853
- export { AppProvider, AppProviderReq, AppProviderRes, AppProviderResObj, AppProviderResVoice, Audience, AudienceReq, Audiences, BadRequestSchema, Campaign, CampaignEmail, CampaignEmailTemplate, CampaignReq, Campaigns, CampignEmailProvider, CommunicationTemplate, CreateJobsReq, CreateJobsRes, DefaultSmsProviders, DummyDatasources, DummyDatasourcesMeta, DummyDatasourcesMetaObj, EmailProvider, EmailProviderReq, EmailProviderReqFrom, EmailProviders, EmailTemplate, EmailTemplateHeaders, EmailTemplateKeys, EmailTemplateReq, EmailTemplates, EnabledObj, EngineRequest, EngineResponse, EventSubscription, EventSubscriptions, EventSubscriptionsBulkUpdateRequest, EventSubscriptionsBulkUpdateResponse, EventSubscriptionTemplate, EventSubscriptionTemplateEmail, EventSubscriptionTemplateSms, GenericDelete, GenericError, GetNRecordsCsvReq, GetNRecordsCsvRes, GetNRecordsCsvResItems, GetStats, GlobalProviders, GlobalProvidersResObj, GlobalVariablesGetResponse, GlobalVariablesPostResponse, GlobalVariablesReq, Job, JobLog, JobLogs, Jobs, Log, LogEmail, LogMeta, LogPushnotification, Logs, Message, metaObj, MetaStructure, NotFound, Notification, OtpConfiguration, OtpConfigurationExpiry, OtpConfigurationExpiryDuration, Page, PayloadEmailProviderStructure, PayloadEmailStructure, PayloadEmailTemplateStructure, PayloadSmsProviderStructure, PayloadSmsStructure, PayloadSmsTemplateStructure, PayloadStructure, RecipientHeaders, SendOtpCommsReq, SendOtpCommsReqData, SendOtpCommsReqEmail, SendOtpCommsReqSms, SendOtpCommsRes, SendOtpCommsResEmail, SendOtpCommsResSms, SendOtpEmailCommsProvider, SendOtpEmailCommsTemplate, SendOtpSmsCommsProvider, SendOtpSmsCommsTemplate, SmsProvider, SmsProviderReq, SmsProviders, SmsTemplate, SmsTemplateMessage, SmsTemplateReq, SmsTemplates, Stats, StatsImported, StatsProcessed, StatsProcessedEmail, StatsProcessedSms, SubscriptionsObject, SystemEmailTemplate, SystemEmailTemplates, SystemNotification, SystemNotifications, SystemNotificationUser, SystemSmsTemplates, TemplateAndType, TemplateObject, TriggerJobRequest, TriggerJobResponse, VerifyOtpCommsErrorRes, VerifyOtpCommsReq, VerifyOtpCommsSuccessRes };
853
+ export { EventSubscriptionsBulkUpdateRequest, EventSubscriptionsBulkUpdateResponse, SubscriptionsObject, TemplateObject, CommunicationTemplate, AppProvider, AppProviderRes, AppProviderResVoice, AppProviderResObj, GlobalProviders, GlobalProvidersResObj, AppProviderReq, StatsImported, StatsProcessedEmail, StatsProcessedSms, StatsProcessed, Stats, GetStats, CampaignReq, RecipientHeaders, CampaignEmailTemplate, CampignEmailProvider, CampaignEmail, Campaign, Campaigns, BadRequestSchema, NotFound, AudienceReq, Audience, Audiences, GetNRecordsCsvReq, GetNRecordsCsvResItems, GetNRecordsCsvRes, DummyDatasources, DummyDatasourcesMeta, DummyDatasourcesMetaObj, EmailProviderReqFrom, EmailProviderReq, EmailProvider, EmailProviders, EmailTemplateKeys, EmailTemplateHeaders, EmailTemplateReq, TemplateAndType, EmailTemplate, SystemEmailTemplate, EmailTemplates, SystemEmailTemplates, PayloadEmailTemplateStructure, PayloadEmailProviderStructure, PayloadEmailStructure, PayloadSmsTemplateStructure, PayloadSmsProviderStructure, PayloadSmsStructure, PayloadStructure, MetaStructure, EngineRequest, EngineResponse, EventSubscriptionTemplateSms, EventSubscriptionTemplateEmail, EventSubscriptionTemplate, EventSubscription, EventSubscriptions, TriggerJobResponse, TriggerJobRequest, GlobalVariablesGetResponse, GlobalVariablesPostResponse, GlobalVariablesReq, Job, Jobs, CreateJobsRes, CreateJobsReq, JobLog, JobLogs, LogEmail, LogPushnotification, LogMeta, Log, Logs, SendOtpSmsCommsTemplate, SendOtpSmsCommsProvider, SendOtpEmailCommsProvider, SendOtpEmailCommsTemplate, SendOtpCommsReqData, SendOtpCommsReqSms, SendOtpCommsReqEmail, SendOtpCommsResSms, SendOtpCommsResEmail, SendOtpCommsReq, SendOtpCommsRes, VerifyOtpCommsReq, VerifyOtpCommsSuccessRes, VerifyOtpCommsErrorRes, SmsProviderReq, SmsProvider, SmsProviders, DefaultSmsProviders, SmsTemplateMessage, SmsTemplates, SmsTemplate, SystemSmsTemplates, metaObj, SmsTemplateReq, Notification, SystemNotificationUser, SystemNotification, SystemNotifications, Page, GenericError, GenericDelete, Message, EnabledObj, OtpConfigurationExpiryDuration, OtpConfigurationExpiry, OtpConfiguration };
854
854
  }
855
- /** @returns {AppProvider} */
856
- declare function AppProvider(): AppProvider;
857
- type AppProvider = {
858
- __v?: number;
855
+ /** @returns {EventSubscriptionsBulkUpdateRequest} */
856
+ declare function EventSubscriptionsBulkUpdateRequest(): EventSubscriptionsBulkUpdateRequest;
857
+ type EventSubscriptionsBulkUpdateRequest = {
858
+ subscriptions?: SubscriptionsObject[];
859
+ };
860
+ /** @returns {EventSubscriptionsBulkUpdateResponse} */
861
+ declare function EventSubscriptionsBulkUpdateResponse(): EventSubscriptionsBulkUpdateResponse;
862
+ type EventSubscriptionsBulkUpdateResponse = {
863
+ template?: EventSubscriptionTemplate;
859
864
  _id?: string;
860
865
  application?: string;
866
+ event?: string;
867
+ slug?: string;
868
+ category?: string;
861
869
  created_at?: string;
862
- email?: AppProviderRes;
863
- sms?: AppProviderRes;
864
870
  updated_at?: string;
865
- voice?: AppProviderResVoice;
871
+ __v?: number;
866
872
  };
867
- /** @returns {AppProviderReq} */
868
- declare function AppProviderReq(): AppProviderReq;
869
- type AppProviderReq = {
873
+ /** @returns {SubscriptionsObject} */
874
+ declare function SubscriptionsObject(): SubscriptionsObject;
875
+ type SubscriptionsObject = {
876
+ /**
877
+ * - Subscription ID
878
+ */
879
+ _id?: string;
880
+ template?: TemplateObject;
881
+ };
882
+ /** @returns {TemplateObject} */
883
+ declare function TemplateObject(): TemplateObject;
884
+ type TemplateObject = {
885
+ sms?: CommunicationTemplate;
886
+ email?: CommunicationTemplate;
887
+ pushnotification?: CommunicationTemplate;
888
+ };
889
+ /** @returns {CommunicationTemplate} */
890
+ declare function CommunicationTemplate(): CommunicationTemplate;
891
+ type CommunicationTemplate = {
892
+ /**
893
+ * - Whether the user is subscribed or not
894
+ */
895
+ subscribed?: boolean;
896
+ /**
897
+ * - Template ID
898
+ */
899
+ template?: string;
900
+ };
901
+ /** @returns {AppProvider} */
902
+ declare function AppProvider(): AppProvider;
903
+ type AppProvider = {
870
904
  email?: AppProviderRes;
871
905
  sms?: AppProviderRes;
872
906
  voice?: AppProviderResVoice;
907
+ _id?: string;
908
+ application?: string;
909
+ created_at?: string;
910
+ updated_at?: string;
911
+ __v?: number;
873
912
  };
874
913
  /** @returns {AppProviderRes} */
875
914
  declare function AppProviderRes(): AppProviderRes;
876
915
  type AppProviderRes = {
877
- otp?: AppProviderResObj;
916
+ transaction?: AppProviderResObj;
878
917
  promotional?: AppProviderResObj;
918
+ otp?: AppProviderResObj;
919
+ };
920
+ /** @returns {AppProviderResVoice} */
921
+ declare function AppProviderResVoice(): AppProviderResVoice;
922
+ type AppProviderResVoice = {
879
923
  transaction?: AppProviderResObj;
924
+ otp?: AppProviderResObj;
880
925
  };
881
926
  /** @returns {AppProviderResObj} */
882
927
  declare function AppProviderResObj(): AppProviderResObj;
883
928
  type AppProviderResObj = {
884
929
  provider?: string;
885
930
  };
886
- /** @returns {AppProviderResVoice} */
887
- declare function AppProviderResVoice(): AppProviderResVoice;
888
- type AppProviderResVoice = {
889
- otp?: AppProviderResObj;
890
- transaction?: AppProviderResObj;
931
+ /** @returns {GlobalProviders} */
932
+ declare function GlobalProviders(): GlobalProviders;
933
+ type GlobalProviders = {
934
+ email?: GlobalProvidersResObj[];
935
+ sms?: GlobalProvidersResObj[];
936
+ voice?: GlobalProvidersResObj[];
891
937
  };
892
- /** @returns {Audience} */
893
- declare function Audience(): Audience;
894
- type Audience = {
895
- __v?: number;
938
+ /** @returns {GlobalProvidersResObj} */
939
+ declare function GlobalProvidersResObj(): GlobalProvidersResObj;
940
+ type GlobalProvidersResObj = {
896
941
  _id?: string;
897
- application?: string;
898
- created_at?: string;
942
+ name?: string;
943
+ };
944
+ /** @returns {AppProviderReq} */
945
+ declare function AppProviderReq(): AppProviderReq;
946
+ type AppProviderReq = {
947
+ email?: AppProviderRes;
948
+ sms?: AppProviderRes;
949
+ voice?: AppProviderResVoice;
950
+ };
951
+ /** @returns {StatsImported} */
952
+ declare function StatsImported(): StatsImported;
953
+ type StatsImported = {
954
+ count?: number;
955
+ };
956
+ /** @returns {StatsProcessedEmail} */
957
+ declare function StatsProcessedEmail(): StatsProcessedEmail;
958
+ type StatsProcessedEmail = {
959
+ success?: number;
960
+ failed?: number;
961
+ suppressed?: number;
962
+ };
963
+ /** @returns {StatsProcessedSms} */
964
+ declare function StatsProcessedSms(): StatsProcessedSms;
965
+ type StatsProcessedSms = {
966
+ success?: number;
967
+ failed?: number;
968
+ suppressed?: number;
969
+ };
970
+ /** @returns {StatsProcessed} */
971
+ declare function StatsProcessed(): StatsProcessed;
972
+ type StatsProcessed = {
973
+ email?: StatsProcessedEmail;
974
+ sms?: StatsProcessedSms;
975
+ };
976
+ /** @returns {Stats} */
977
+ declare function Stats(): Stats;
978
+ type Stats = {
979
+ _id?: string;
980
+ imported?: any;
981
+ processed?: any;
982
+ };
983
+ /** @returns {GetStats} */
984
+ declare function GetStats(): GetStats;
985
+ type GetStats = {
986
+ items?: Stats[];
987
+ };
988
+ /** @returns {CampaignReq} */
989
+ declare function CampaignReq(): CampaignReq;
990
+ type CampaignReq = {
899
991
  description?: string;
900
- file_url?: string;
992
+ tags?: string[];
901
993
  headers?: string[];
902
994
  is_active?: boolean;
903
995
  name?: string;
904
- records_count?: number;
905
- slug?: string;
906
- tags?: string[];
996
+ file_url?: string;
907
997
  type?: string;
908
- updated_at?: string;
998
+ records_count?: number;
999
+ application?: string;
909
1000
  };
910
- /** @returns {AudienceReq} */
911
- declare function AudienceReq(): AudienceReq;
912
- type AudienceReq = {
1001
+ /** @returns {RecipientHeaders} */
1002
+ declare function RecipientHeaders(): RecipientHeaders;
1003
+ type RecipientHeaders = {
1004
+ email?: string;
1005
+ };
1006
+ /** @returns {CampaignEmailTemplate} */
1007
+ declare function CampaignEmailTemplate(): CampaignEmailTemplate;
1008
+ type CampaignEmailTemplate = {
1009
+ key?: string;
1010
+ value?: string;
1011
+ };
1012
+ /** @returns {CampignEmailProvider} */
1013
+ declare function CampignEmailProvider(): CampignEmailProvider;
1014
+ type CampignEmailProvider = {
1015
+ _id?: string;
1016
+ from_name?: string;
1017
+ from_email?: string;
1018
+ };
1019
+ /** @returns {CampaignEmail} */
1020
+ declare function CampaignEmail(): CampaignEmail;
1021
+ type CampaignEmail = {
1022
+ template?: CampaignEmailTemplate;
1023
+ provider?: CampignEmailProvider;
1024
+ };
1025
+ /** @returns {Campaign} */
1026
+ declare function Campaign(): Campaign;
1027
+ type Campaign = {
1028
+ recipient_headers?: RecipientHeaders;
1029
+ email?: CampaignEmail;
913
1030
  description?: string;
914
- file_url?: string;
915
- headers?: string[];
916
- name?: string;
917
- records_count?: number;
918
- tags?: string[];
1031
+ tags?: any[];
1032
+ is_active?: boolean;
1033
+ _id?: string;
1034
+ datasource?: string;
919
1035
  type?: string;
1036
+ name?: string;
1037
+ application?: string;
1038
+ created_at?: string;
1039
+ updated_at?: string;
1040
+ slug?: string;
1041
+ __v?: number;
920
1042
  };
921
- /** @returns {Audiences} */
922
- declare function Audiences(): Audiences;
923
- type Audiences = {
924
- items?: Audience[];
1043
+ /** @returns {Campaigns} */
1044
+ declare function Campaigns(): Campaigns;
1045
+ type Campaigns = {
1046
+ items?: Campaign[];
925
1047
  page?: Page;
926
1048
  };
927
1049
  /** @returns {BadRequestSchema} */
928
1050
  declare function BadRequestSchema(): BadRequestSchema;
929
1051
  type BadRequestSchema = {
930
- /**
931
- * - Failure message.
932
- */
933
- message?: string;
934
1052
  /**
935
1053
  * - Response status.
936
1054
  */
937
1055
  status?: string;
1056
+ /**
1057
+ * - Failure message.
1058
+ */
1059
+ message?: string;
938
1060
  };
939
- /** @returns {Campaign} */
940
- declare function Campaign(): Campaign;
941
- type Campaign = {
942
- __v?: number;
943
- _id?: string;
944
- application?: string;
945
- created_at?: string;
946
- datasource?: string;
947
- description?: string;
948
- email?: CampaignEmail;
949
- is_active?: boolean;
950
- name?: string;
951
- recipient_headers?: RecipientHeaders;
952
- slug?: string;
953
- tags?: any[];
954
- type?: string;
955
- updated_at?: string;
956
- };
957
- /** @returns {CampaignEmail} */
958
- declare function CampaignEmail(): CampaignEmail;
959
- type CampaignEmail = {
960
- provider?: CampignEmailProvider;
961
- template?: CampaignEmailTemplate;
962
- };
963
- /** @returns {CampaignEmailTemplate} */
964
- declare function CampaignEmailTemplate(): CampaignEmailTemplate;
965
- type CampaignEmailTemplate = {
966
- key?: string;
967
- value?: string;
1061
+ /** @returns {NotFound} */
1062
+ declare function NotFound(): NotFound;
1063
+ type NotFound = {
1064
+ /**
1065
+ * - Failure message.
1066
+ */
1067
+ message?: string;
968
1068
  };
969
- /** @returns {CampaignReq} */
970
- declare function CampaignReq(): CampaignReq;
971
- type CampaignReq = {
972
- application?: string;
1069
+ /** @returns {AudienceReq} */
1070
+ declare function AudienceReq(): AudienceReq;
1071
+ type AudienceReq = {
1072
+ name?: string;
973
1073
  description?: string;
1074
+ tags?: string[];
974
1075
  file_url?: string;
1076
+ type?: string;
1077
+ records_count?: number;
975
1078
  headers?: string[];
976
- is_active?: boolean;
1079
+ };
1080
+ /** @returns {Audience} */
1081
+ declare function Audience(): Audience;
1082
+ type Audience = {
1083
+ _id?: string;
1084
+ application?: string;
977
1085
  name?: string;
1086
+ description?: string;
978
1087
  records_count?: number;
979
- tags?: string[];
980
1088
  type?: string;
1089
+ tags?: string[];
1090
+ headers?: string[];
1091
+ file_url?: string;
1092
+ is_active?: boolean;
1093
+ created_at?: string;
1094
+ updated_at?: string;
1095
+ slug?: string;
1096
+ __v?: number;
981
1097
  };
982
- /** @returns {Campaigns} */
983
- declare function Campaigns(): Campaigns;
984
- type Campaigns = {
985
- items?: Campaign[];
1098
+ /** @returns {Audiences} */
1099
+ declare function Audiences(): Audiences;
1100
+ type Audiences = {
1101
+ items?: Audience[];
986
1102
  page?: Page;
987
1103
  };
988
- /** @returns {CampignEmailProvider} */
989
- declare function CampignEmailProvider(): CampignEmailProvider;
990
- type CampignEmailProvider = {
991
- _id?: string;
992
- from_email?: string;
993
- from_name?: string;
994
- };
995
- /** @returns {CommunicationTemplate} */
996
- declare function CommunicationTemplate(): CommunicationTemplate;
997
- type CommunicationTemplate = {
998
- /**
999
- * - Whether the user is subscribed or not
1000
- */
1001
- subscribed?: boolean;
1002
- /**
1003
- * - Template ID
1004
- */
1005
- template?: string;
1006
- };
1007
- /** @returns {CreateJobsReq} */
1008
- declare function CreateJobsReq(): CreateJobsReq;
1009
- type CreateJobsReq = {
1010
- campaign?: string;
1104
+ /** @returns {GetNRecordsCsvReq} */
1105
+ declare function GetNRecordsCsvReq(): GetNRecordsCsvReq;
1106
+ type GetNRecordsCsvReq = {
1107
+ url?: string;
1108
+ header?: boolean;
1109
+ count?: number;
1011
1110
  };
1012
- /** @returns {CreateJobsRes} */
1013
- declare function CreateJobsRes(): CreateJobsRes;
1014
- type CreateJobsRes = {
1015
- __v?: number;
1016
- _id?: string;
1017
- application?: string;
1018
- campaign?: string;
1019
- completed?: boolean;
1020
- created_at?: string;
1021
- is_active?: boolean;
1022
- updated_at?: string;
1111
+ /** @returns {GetNRecordsCsvResItems} */
1112
+ declare function GetNRecordsCsvResItems(): GetNRecordsCsvResItems;
1113
+ type GetNRecordsCsvResItems = {
1114
+ phone_number?: string;
1115
+ email?: string;
1116
+ firstname?: string;
1117
+ lastname?: string;
1118
+ orderid?: string;
1023
1119
  };
1024
- /** @returns {DefaultSmsProviders} */
1025
- declare function DefaultSmsProviders(): DefaultSmsProviders;
1026
- type DefaultSmsProviders = {
1027
- _id?: string;
1028
- is_default?: boolean;
1029
- name?: string;
1120
+ /** @returns {GetNRecordsCsvRes} */
1121
+ declare function GetNRecordsCsvRes(): GetNRecordsCsvRes;
1122
+ type GetNRecordsCsvRes = {
1123
+ items?: GetNRecordsCsvResItems[];
1030
1124
  };
1031
1125
  /** @returns {DummyDatasources} */
1032
1126
  declare function DummyDatasources(): DummyDatasources;
@@ -1037,46 +1131,46 @@ type DummyDatasources = {
1037
1131
  /** @returns {DummyDatasourcesMeta} */
1038
1132
  declare function DummyDatasourcesMeta(): DummyDatasourcesMeta;
1039
1133
  type DummyDatasourcesMeta = {
1040
- data?: DummyDatasourcesMetaObj;
1041
1134
  id?: number;
1135
+ data?: DummyDatasourcesMetaObj;
1042
1136
  };
1043
1137
  /** @returns {DummyDatasourcesMetaObj} */
1044
1138
  declare function DummyDatasourcesMetaObj(): DummyDatasourcesMetaObj;
1045
1139
  type DummyDatasourcesMetaObj = {
1046
1140
  b?: number;
1047
1141
  };
1048
- /** @returns {EmailProvider} */
1049
- declare function EmailProvider(): EmailProvider;
1050
- type EmailProvider = {
1051
- __v?: number;
1052
- _id?: string;
1053
- api_key?: string;
1054
- application?: string;
1055
- created_at?: string;
1056
- description?: string;
1057
- from_address?: EmailProviderReqFrom[];
1142
+ /** @returns {EmailProviderReqFrom} */
1143
+ declare function EmailProviderReqFrom(): EmailProviderReqFrom;
1144
+ type EmailProviderReqFrom = {
1058
1145
  name?: string;
1059
- provider?: string;
1060
- slug?: string;
1061
- type?: string;
1062
- updated_at?: string;
1146
+ email?: string;
1147
+ is_default?: boolean;
1063
1148
  };
1064
1149
  /** @returns {EmailProviderReq} */
1065
1150
  declare function EmailProviderReq(): EmailProviderReq;
1066
1151
  type EmailProviderReq = {
1067
- api_key?: string;
1068
- description?: string;
1069
- from_address?: EmailProviderReqFrom[];
1070
1152
  name?: string;
1071
- provider?: string;
1153
+ description?: string;
1154
+ api_key?: string;
1072
1155
  type?: string;
1156
+ provider?: string;
1157
+ from_address?: EmailProviderReqFrom[];
1073
1158
  };
1074
- /** @returns {EmailProviderReqFrom} */
1075
- declare function EmailProviderReqFrom(): EmailProviderReqFrom;
1076
- type EmailProviderReqFrom = {
1077
- email?: string;
1078
- is_default?: boolean;
1159
+ /** @returns {EmailProvider} */
1160
+ declare function EmailProvider(): EmailProvider;
1161
+ type EmailProvider = {
1162
+ type?: string;
1163
+ provider?: string;
1164
+ from_address?: EmailProviderReqFrom[];
1165
+ _id?: string;
1079
1166
  name?: string;
1167
+ description?: string;
1168
+ api_key?: string;
1169
+ application?: string;
1170
+ created_at?: string;
1171
+ updated_at?: string;
1172
+ slug?: string;
1173
+ __v?: number;
1080
1174
  };
1081
1175
  /** @returns {EmailProviders} */
1082
1176
  declare function EmailProviders(): EmailProviders;
@@ -1084,37 +1178,12 @@ type EmailProviders = {
1084
1178
  items?: EmailProvider[];
1085
1179
  page?: Page;
1086
1180
  };
1087
- /** @returns {EmailTemplate} */
1088
- declare function EmailTemplate(): EmailTemplate;
1089
- type EmailTemplate = {
1090
- __v?: number;
1091
- _id?: string;
1092
- application?: string;
1093
- attachments?: number[];
1094
- category?: string;
1095
- created_at?: string;
1096
- description?: string;
1097
- editor_meta?: string;
1098
- editor_type?: string;
1099
- from_name?: string;
1100
- headers?: EmailTemplateHeaders[];
1101
- html?: TemplateAndType;
1102
- is_internal?: boolean;
1103
- is_system?: boolean;
1104
- name?: string;
1105
- priority?: string;
1106
- published?: boolean;
1107
- reply_to?: string;
1108
- slug?: string;
1109
- static_bcc?: string[];
1110
- static_cc?: string[];
1111
- static_to?: string[];
1112
- subject?: TemplateAndType;
1113
- tags?: string[];
1114
- template_variables?: any;
1115
- text?: TemplateAndType;
1116
- updated_at?: string;
1117
- url_shorten?: EnabledObj;
1181
+ /** @returns {EmailTemplateKeys} */
1182
+ declare function EmailTemplateKeys(): EmailTemplateKeys;
1183
+ type EmailTemplateKeys = {
1184
+ to?: string;
1185
+ cc?: string;
1186
+ bcc?: string;
1118
1187
  };
1119
1188
  /** @returns {EmailTemplateHeaders} */
1120
1189
  declare function EmailTemplateHeaders(): EmailTemplateHeaders;
@@ -1122,70 +1191,196 @@ type EmailTemplateHeaders = {
1122
1191
  key?: string;
1123
1192
  value?: string;
1124
1193
  };
1125
- /** @returns {EmailTemplateKeys} */
1126
- declare function EmailTemplateKeys(): EmailTemplateKeys;
1127
- type EmailTemplateKeys = {
1128
- bcc?: string;
1129
- cc?: string;
1130
- to?: string;
1131
- };
1132
1194
  /** @returns {EmailTemplateReq} */
1133
1195
  declare function EmailTemplateReq(): EmailTemplateReq;
1134
1196
  type EmailTemplateReq = {
1135
- attachments?: number[];
1197
+ name: string;
1136
1198
  description?: string;
1137
- editor_meta?: string;
1138
- editor_type?: string;
1139
1199
  from_name?: string;
1140
- headers?: EmailTemplateHeaders[];
1141
- html?: TemplateAndType;
1142
- keys?: EmailTemplateKeys;
1143
- name: string;
1144
- priority?: string;
1145
- published?: boolean;
1146
- reply_to?: string;
1147
- static_bcc?: string[];
1148
- static_cc?: string[];
1149
1200
  static_to?: string[];
1150
- subject?: TemplateAndType;
1201
+ static_cc?: string[];
1202
+ static_bcc?: string[];
1203
+ reply_to?: string;
1204
+ priority?: string;
1151
1205
  tags?: string[];
1152
1206
  template_variables?: any;
1207
+ published?: boolean;
1208
+ subject?: TemplateAndType;
1209
+ html?: TemplateAndType;
1210
+ editor_type?: string;
1211
+ editor_meta?: string;
1212
+ attachments?: number[];
1213
+ headers?: EmailTemplateHeaders[];
1214
+ keys?: EmailTemplateKeys;
1153
1215
  text?: TemplateAndType;
1154
1216
  };
1155
- /** @returns {EmailTemplates} */
1156
- declare function EmailTemplates(): EmailTemplates;
1157
- type EmailTemplates = {
1158
- items?: EmailTemplate[];
1159
- page?: Page;
1160
- };
1161
- /** @returns {EnabledObj} */
1162
- declare function EnabledObj(): EnabledObj;
1163
- type EnabledObj = {
1164
- enabled?: boolean;
1217
+ /** @returns {TemplateAndType} */
1218
+ declare function TemplateAndType(): TemplateAndType;
1219
+ type TemplateAndType = {
1220
+ template_type?: string;
1221
+ template?: string;
1222
+ };
1223
+ /** @returns {EmailTemplate} */
1224
+ declare function EmailTemplate(): EmailTemplate;
1225
+ type EmailTemplate = {
1226
+ application?: string;
1227
+ is_system?: boolean;
1228
+ is_internal?: boolean;
1229
+ name?: string;
1230
+ description?: string;
1231
+ editor_type?: string;
1232
+ editor_meta?: string;
1233
+ static_to?: string[];
1234
+ static_cc?: string[];
1235
+ static_bcc?: string[];
1236
+ reply_to?: string;
1237
+ tags?: string[];
1238
+ subject?: TemplateAndType;
1239
+ html?: TemplateAndType;
1240
+ url_shorten?: EnabledObj;
1241
+ priority?: string;
1242
+ template_variables?: any;
1243
+ published?: boolean;
1244
+ category?: string;
1245
+ _id?: string;
1246
+ headers?: EmailTemplateHeaders[];
1247
+ attachments?: number[];
1248
+ created_at?: string;
1249
+ updated_at?: string;
1250
+ slug?: string;
1251
+ __v?: number;
1252
+ from_name?: string;
1253
+ text?: TemplateAndType;
1254
+ };
1255
+ /** @returns {SystemEmailTemplate} */
1256
+ declare function SystemEmailTemplate(): SystemEmailTemplate;
1257
+ type SystemEmailTemplate = {
1258
+ is_system?: boolean;
1259
+ is_internal?: boolean;
1260
+ name?: string;
1261
+ description?: string;
1262
+ static_to?: string[];
1263
+ static_cc?: string[];
1264
+ static_bcc?: string[];
1265
+ tags?: string[];
1266
+ subject?: TemplateAndType;
1267
+ html?: TemplateAndType;
1268
+ url_shorten?: EnabledObj;
1269
+ priority?: string;
1270
+ template_variables?: any;
1271
+ published?: boolean;
1272
+ category?: string;
1273
+ _id?: string;
1274
+ headers?: EmailTemplateHeaders[];
1275
+ attachments?: number[];
1276
+ created_at?: string;
1277
+ updated_at?: string;
1278
+ slug?: string;
1279
+ __v?: number;
1280
+ text?: TemplateAndType;
1281
+ };
1282
+ /** @returns {EmailTemplates} */
1283
+ declare function EmailTemplates(): EmailTemplates;
1284
+ type EmailTemplates = {
1285
+ items?: EmailTemplate[];
1286
+ page?: Page;
1287
+ };
1288
+ /** @returns {SystemEmailTemplates} */
1289
+ declare function SystemEmailTemplates(): SystemEmailTemplates;
1290
+ type SystemEmailTemplates = {
1291
+ items?: SystemEmailTemplate[];
1292
+ };
1293
+ /** @returns {PayloadEmailTemplateStructure} */
1294
+ declare function PayloadEmailTemplateStructure(): PayloadEmailTemplateStructure;
1295
+ type PayloadEmailTemplateStructure = {
1296
+ key?: string;
1297
+ value?: any;
1298
+ };
1299
+ /** @returns {PayloadEmailProviderStructure} */
1300
+ declare function PayloadEmailProviderStructure(): PayloadEmailProviderStructure;
1301
+ type PayloadEmailProviderStructure = {
1302
+ _id?: string;
1303
+ };
1304
+ /** @returns {PayloadEmailStructure} */
1305
+ declare function PayloadEmailStructure(): PayloadEmailStructure;
1306
+ type PayloadEmailStructure = {
1307
+ template?: PayloadEmailTemplateStructure;
1308
+ provider?: PayloadEmailProviderStructure;
1309
+ };
1310
+ /** @returns {PayloadSmsTemplateStructure} */
1311
+ declare function PayloadSmsTemplateStructure(): PayloadSmsTemplateStructure;
1312
+ type PayloadSmsTemplateStructure = {
1313
+ key?: string;
1314
+ value?: any;
1315
+ };
1316
+ /** @returns {PayloadSmsProviderStructure} */
1317
+ declare function PayloadSmsProviderStructure(): PayloadSmsProviderStructure;
1318
+ type PayloadSmsProviderStructure = {
1319
+ _id?: string;
1320
+ };
1321
+ /** @returns {PayloadSmsStructure} */
1322
+ declare function PayloadSmsStructure(): PayloadSmsStructure;
1323
+ type PayloadSmsStructure = {
1324
+ template?: PayloadSmsTemplateStructure;
1325
+ provider?: PayloadSmsProviderStructure;
1326
+ };
1327
+ /** @returns {PayloadStructure} */
1328
+ declare function PayloadStructure(): PayloadStructure;
1329
+ type PayloadStructure = {
1330
+ data?: any[];
1331
+ email?: PayloadEmailStructure;
1332
+ sms?: PayloadSmsStructure;
1333
+ application?: string;
1334
+ };
1335
+ /** @returns {MetaStructure} */
1336
+ declare function MetaStructure(): MetaStructure;
1337
+ type MetaStructure = {
1338
+ job_type?: string;
1339
+ action?: string;
1340
+ trace?: string;
1341
+ timestamp?: string;
1165
1342
  };
1166
1343
  /** @returns {EngineRequest} */
1167
1344
  declare function EngineRequest(): EngineRequest;
1168
1345
  type EngineRequest = {
1169
- meta?: MetaStructure;
1170
1346
  payload?: PayloadStructure;
1347
+ meta?: MetaStructure;
1171
1348
  };
1172
1349
  /** @returns {EngineResponse} */
1173
1350
  declare function EngineResponse(): EngineResponse;
1174
1351
  type EngineResponse = {
1175
1352
  success?: boolean;
1176
1353
  };
1354
+ /** @returns {EventSubscriptionTemplateSms} */
1355
+ declare function EventSubscriptionTemplateSms(): EventSubscriptionTemplateSms;
1356
+ type EventSubscriptionTemplateSms = {
1357
+ subscribed?: boolean;
1358
+ template?: string;
1359
+ };
1360
+ /** @returns {EventSubscriptionTemplateEmail} */
1361
+ declare function EventSubscriptionTemplateEmail(): EventSubscriptionTemplateEmail;
1362
+ type EventSubscriptionTemplateEmail = {
1363
+ subscribed?: boolean;
1364
+ template?: string;
1365
+ };
1366
+ /** @returns {EventSubscriptionTemplate} */
1367
+ declare function EventSubscriptionTemplate(): EventSubscriptionTemplate;
1368
+ type EventSubscriptionTemplate = {
1369
+ sms?: EventSubscriptionTemplateSms;
1370
+ email?: EventSubscriptionTemplateEmail;
1371
+ };
1177
1372
  /** @returns {EventSubscription} */
1178
1373
  declare function EventSubscription(): EventSubscription;
1179
1374
  type EventSubscription = {
1180
- __v?: number;
1375
+ template?: EventSubscriptionTemplate;
1376
+ is_default?: boolean;
1181
1377
  _id?: string;
1182
1378
  application?: string;
1183
- created_at?: string;
1184
1379
  event?: string;
1185
- is_default?: boolean;
1186
1380
  slug?: string;
1187
- template?: EventSubscriptionTemplate;
1381
+ created_at?: string;
1188
1382
  updated_at?: string;
1383
+ __v?: number;
1189
1384
  };
1190
1385
  /** @returns {EventSubscriptions} */
1191
1386
  declare function EventSubscriptions(): EventSubscriptions;
@@ -1193,109 +1388,30 @@ type EventSubscriptions = {
1193
1388
  items?: EventSubscription[];
1194
1389
  page?: Page;
1195
1390
  };
1196
- /** @returns {EventSubscriptionsBulkUpdateRequest} */
1197
- declare function EventSubscriptionsBulkUpdateRequest(): EventSubscriptionsBulkUpdateRequest;
1198
- type EventSubscriptionsBulkUpdateRequest = {
1199
- subscriptions?: SubscriptionsObject[];
1200
- };
1201
- /** @returns {EventSubscriptionsBulkUpdateResponse} */
1202
- declare function EventSubscriptionsBulkUpdateResponse(): EventSubscriptionsBulkUpdateResponse;
1203
- type EventSubscriptionsBulkUpdateResponse = {
1204
- __v?: number;
1205
- _id?: string;
1206
- application?: string;
1207
- category?: string;
1208
- created_at?: string;
1209
- event?: string;
1210
- slug?: string;
1211
- template?: EventSubscriptionTemplate;
1212
- updated_at?: string;
1213
- };
1214
- /** @returns {EventSubscriptionTemplate} */
1215
- declare function EventSubscriptionTemplate(): EventSubscriptionTemplate;
1216
- type EventSubscriptionTemplate = {
1217
- email?: EventSubscriptionTemplateEmail;
1218
- sms?: EventSubscriptionTemplateSms;
1219
- };
1220
- /** @returns {EventSubscriptionTemplateEmail} */
1221
- declare function EventSubscriptionTemplateEmail(): EventSubscriptionTemplateEmail;
1222
- type EventSubscriptionTemplateEmail = {
1223
- subscribed?: boolean;
1224
- template?: string;
1225
- };
1226
- /** @returns {EventSubscriptionTemplateSms} */
1227
- declare function EventSubscriptionTemplateSms(): EventSubscriptionTemplateSms;
1228
- type EventSubscriptionTemplateSms = {
1229
- subscribed?: boolean;
1230
- template?: string;
1231
- };
1232
- /** @returns {GenericDelete} */
1233
- declare function GenericDelete(): GenericDelete;
1234
- type GenericDelete = {
1235
- acknowledged?: boolean;
1236
- affected?: number;
1237
- message?: string;
1238
- operation?: string;
1239
- };
1240
- /** @returns {GenericError} */
1241
- declare function GenericError(): GenericError;
1242
- type GenericError = {
1243
- message?: Message;
1244
- sentry?: string;
1245
- };
1246
- /** @returns {GetNRecordsCsvReq} */
1247
- declare function GetNRecordsCsvReq(): GetNRecordsCsvReq;
1248
- type GetNRecordsCsvReq = {
1249
- count?: number;
1250
- header?: boolean;
1251
- url?: string;
1252
- };
1253
- /** @returns {GetNRecordsCsvRes} */
1254
- declare function GetNRecordsCsvRes(): GetNRecordsCsvRes;
1255
- type GetNRecordsCsvRes = {
1256
- items?: GetNRecordsCsvResItems[];
1257
- };
1258
- /** @returns {GetNRecordsCsvResItems} */
1259
- declare function GetNRecordsCsvResItems(): GetNRecordsCsvResItems;
1260
- type GetNRecordsCsvResItems = {
1261
- email?: string;
1262
- firstname?: string;
1263
- lastname?: string;
1264
- orderid?: string;
1265
- phone_number?: string;
1266
- };
1267
- /** @returns {GetStats} */
1268
- declare function GetStats(): GetStats;
1269
- type GetStats = {
1270
- items?: Stats[];
1271
- };
1272
- /** @returns {GlobalProviders} */
1273
- declare function GlobalProviders(): GlobalProviders;
1274
- type GlobalProviders = {
1275
- email?: GlobalProvidersResObj[];
1276
- sms?: GlobalProvidersResObj[];
1277
- voice?: GlobalProvidersResObj[];
1391
+ /** @returns {TriggerJobResponse} */
1392
+ declare function TriggerJobResponse(): TriggerJobResponse;
1393
+ type TriggerJobResponse = {
1394
+ status?: number;
1278
1395
  };
1279
- /** @returns {GlobalProvidersResObj} */
1280
- declare function GlobalProvidersResObj(): GlobalProvidersResObj;
1281
- type GlobalProvidersResObj = {
1282
- _id?: string;
1283
- name?: string;
1396
+ /** @returns {TriggerJobRequest} */
1397
+ declare function TriggerJobRequest(): TriggerJobRequest;
1398
+ type TriggerJobRequest = {
1399
+ job_id?: string;
1284
1400
  };
1285
1401
  /** @returns {GlobalVariablesGetResponse} */
1286
1402
  declare function GlobalVariablesGetResponse(): GlobalVariablesGetResponse;
1287
1403
  type GlobalVariablesGetResponse = {
1288
- editable?: any;
1289
1404
  read_only?: any;
1405
+ editable?: any;
1290
1406
  };
1291
1407
  /** @returns {GlobalVariablesPostResponse} */
1292
1408
  declare function GlobalVariablesPostResponse(): GlobalVariablesPostResponse;
1293
1409
  type GlobalVariablesPostResponse = {
1294
1410
  _id?: string;
1295
- application?: string;
1296
1411
  category?: string;
1297
- created_at?: string;
1412
+ application?: string;
1298
1413
  global_variables?: any;
1414
+ created_at?: string;
1299
1415
  };
1300
1416
  /** @returns {GlobalVariablesReq} */
1301
1417
  declare function GlobalVariablesReq(): GlobalVariablesReq;
@@ -1305,26 +1421,49 @@ type GlobalVariablesReq = {
1305
1421
  /** @returns {Job} */
1306
1422
  declare function Job(): Job;
1307
1423
  type Job = {
1308
- __v?: number;
1424
+ completed?: boolean;
1425
+ is_active?: boolean;
1309
1426
  _id?: string;
1427
+ campaign?: string;
1428
+ application?: string;
1429
+ created_at?: string;
1430
+ updated_at?: string;
1431
+ __v?: number;
1432
+ };
1433
+ /** @returns {Jobs} */
1434
+ declare function Jobs(): Jobs;
1435
+ type Jobs = {
1436
+ items?: Job[];
1437
+ page?: Page;
1438
+ };
1439
+ /** @returns {CreateJobsRes} */
1440
+ declare function CreateJobsRes(): CreateJobsRes;
1441
+ type CreateJobsRes = {
1310
1442
  application?: string;
1311
1443
  campaign?: string;
1312
1444
  completed?: boolean;
1313
- created_at?: string;
1314
1445
  is_active?: boolean;
1446
+ _id?: string;
1447
+ created_at?: string;
1315
1448
  updated_at?: string;
1449
+ __v?: number;
1450
+ };
1451
+ /** @returns {CreateJobsReq} */
1452
+ declare function CreateJobsReq(): CreateJobsReq;
1453
+ type CreateJobsReq = {
1454
+ campaign?: string;
1316
1455
  };
1317
1456
  /** @returns {JobLog} */
1318
1457
  declare function JobLog(): JobLog;
1319
1458
  type JobLog = {
1320
- __v?: number;
1459
+ imported?: any;
1460
+ processed?: any;
1321
1461
  _id?: string;
1462
+ job?: string;
1322
1463
  campaign?: string;
1323
1464
  created_at?: string;
1324
- imported?: any;
1325
- job?: string;
1326
- processed?: any;
1327
1465
  updated_at?: string;
1466
+ __v?: number;
1328
1467
  };
1329
1468
  /** @returns {JobLogs} */
1330
1469
  declare function JobLogs(): JobLogs;
@@ -1332,46 +1471,40 @@ type JobLogs = {
1332
1471
  items?: JobLog[];
1333
1472
  page?: Page;
1334
1473
  };
1335
- /** @returns {Jobs} */
1336
- declare function Jobs(): Jobs;
1337
- type Jobs = {
1338
- items?: Job[];
1339
- page?: Page;
1340
- };
1341
- /** @returns {Log} */
1342
- declare function Log(): Log;
1343
- type Log = {
1344
- _id?: string;
1345
- application?: string;
1346
- created_at?: string;
1347
- data?: any;
1348
- email?: LogEmail;
1349
- expire_at?: string;
1350
- meta?: LogMeta;
1351
- pushnotification?: LogPushnotification;
1352
- service?: string;
1353
- status?: string;
1354
- step?: string;
1355
- };
1356
1474
  /** @returns {LogEmail} */
1357
1475
  declare function LogEmail(): LogEmail;
1358
1476
  type LogEmail = {
1359
1477
  template?: string;
1360
1478
  };
1479
+ /** @returns {LogPushnotification} */
1480
+ declare function LogPushnotification(): LogPushnotification;
1481
+ type LogPushnotification = {
1482
+ pushtokens?: string[];
1483
+ };
1361
1484
  /** @returns {LogMeta} */
1362
1485
  declare function LogMeta(): LogMeta;
1363
1486
  type LogMeta = {
1487
+ type?: string;
1364
1488
  identifier?: string;
1365
1489
  key?: string;
1366
1490
  offset?: string;
1367
1491
  partition?: string;
1368
1492
  topic?: string;
1369
- type?: string;
1370
1493
  };
1371
- /** @returns {LogPushnotification} */
1372
- declare function LogPushnotification(): LogPushnotification;
1373
- type LogPushnotification = {
1374
- pushtokens?: string[];
1494
+ /** @returns {Log} */
1495
+ declare function Log(): Log;
1496
+ type Log = {
1497
+ email?: LogEmail;
1498
+ pushnotification?: LogPushnotification;
1499
+ meta?: LogMeta;
1500
+ _id?: string;
1501
+ application?: string;
1502
+ service?: string;
1503
+ step?: string;
1504
+ status?: string;
1505
+ data?: any;
1506
+ expire_at?: string;
1507
+ created_at?: string;
1375
1508
  };
1376
1509
  /** @returns {Logs} */
1377
1510
  declare function Logs(): Logs;
@@ -1379,282 +1512,182 @@ type Logs = {
1379
1512
  items?: Log[];
1380
1513
  page?: Page;
1381
1514
  };
1382
- /** @returns {Message} */
1383
- declare function Message(): Message;
1384
- type Message = {
1385
- info?: string;
1386
- message?: string;
1387
- operation?: string;
1388
- success?: boolean;
1389
- };
1390
- /** @returns {metaObj} */
1391
- declare function metaObj(): metaObj;
1392
- type metaObj = {
1393
- is_system?: boolean;
1394
- template?: string;
1395
- type?: string;
1396
- };
1397
- /** @returns {MetaStructure} */
1398
- declare function MetaStructure(): MetaStructure;
1399
- type MetaStructure = {
1400
- action?: string;
1401
- job_type?: string;
1402
- timestamp?: string;
1403
- trace?: string;
1404
- };
1405
- /** @returns {NotFound} */
1406
- declare function NotFound(): NotFound;
1407
- type NotFound = {
1408
- /**
1409
- * - Failure message.
1410
- */
1411
- message?: string;
1412
- };
1413
- /** @returns {Notification} */
1414
- declare function Notification(): Notification;
1415
- type Notification = {
1416
- body?: string;
1417
- click_action?: string;
1418
- deeplink?: string;
1419
- icon?: string;
1420
- subtitle?: string;
1421
- title?: string;
1422
- };
1423
- /** @returns {OtpConfiguration} */
1424
- declare function OtpConfiguration(): OtpConfiguration;
1425
- type OtpConfiguration = {
1426
- application_id?: string;
1427
- company_id?: string;
1428
- expiry: OtpConfigurationExpiry;
1429
- otp_length: number;
1430
- type: string;
1431
- };
1432
- /** @returns {OtpConfigurationExpiry} */
1433
- declare function OtpConfigurationExpiry(): OtpConfigurationExpiry;
1434
- type OtpConfigurationExpiry = {
1435
- duration: OtpConfigurationExpiryDuration;
1436
- type: string;
1437
- };
1438
- /** @returns {OtpConfigurationExpiryDuration} */
1439
- declare function OtpConfigurationExpiryDuration(): OtpConfigurationExpiryDuration;
1440
- type OtpConfigurationExpiryDuration = {
1441
- denomination: string;
1442
- time: number;
1443
- };
1444
- /** @returns {Page} */
1445
- declare function Page(): Page;
1446
- type Page = {
1447
- current?: number;
1448
- has_next?: boolean;
1449
- has_previous?: boolean;
1450
- item_total?: number;
1451
- next_id?: string;
1452
- size?: number;
1453
- type: string;
1454
- };
1455
- /** @returns {PayloadEmailProviderStructure} */
1456
- declare function PayloadEmailProviderStructure(): PayloadEmailProviderStructure;
1457
- type PayloadEmailProviderStructure = {
1458
- _id?: string;
1459
- };
1460
- /** @returns {PayloadEmailStructure} */
1461
- declare function PayloadEmailStructure(): PayloadEmailStructure;
1462
- type PayloadEmailStructure = {
1463
- provider?: PayloadEmailProviderStructure;
1464
- template?: PayloadEmailTemplateStructure;
1465
- };
1466
- /** @returns {PayloadEmailTemplateStructure} */
1467
- declare function PayloadEmailTemplateStructure(): PayloadEmailTemplateStructure;
1468
- type PayloadEmailTemplateStructure = {
1515
+ /** @returns {SendOtpSmsCommsTemplate} */
1516
+ declare function SendOtpSmsCommsTemplate(): SendOtpSmsCommsTemplate;
1517
+ type SendOtpSmsCommsTemplate = {
1469
1518
  key?: string;
1470
1519
  value?: any;
1471
1520
  };
1472
- /** @returns {PayloadSmsProviderStructure} */
1473
- declare function PayloadSmsProviderStructure(): PayloadSmsProviderStructure;
1474
- type PayloadSmsProviderStructure = {
1521
+ /** @returns {SendOtpSmsCommsProvider} */
1522
+ declare function SendOtpSmsCommsProvider(): SendOtpSmsCommsProvider;
1523
+ type SendOtpSmsCommsProvider = {
1524
+ slug?: string;
1475
1525
  _id?: string;
1476
1526
  };
1477
- /** @returns {PayloadSmsStructure} */
1478
- declare function PayloadSmsStructure(): PayloadSmsStructure;
1479
- type PayloadSmsStructure = {
1480
- provider?: PayloadSmsProviderStructure;
1481
- template?: PayloadSmsTemplateStructure;
1527
+ /** @returns {SendOtpEmailCommsProvider} */
1528
+ declare function SendOtpEmailCommsProvider(): SendOtpEmailCommsProvider;
1529
+ type SendOtpEmailCommsProvider = {
1530
+ slug?: string;
1531
+ _id?: string;
1482
1532
  };
1483
- /** @returns {PayloadSmsTemplateStructure} */
1484
- declare function PayloadSmsTemplateStructure(): PayloadSmsTemplateStructure;
1485
- type PayloadSmsTemplateStructure = {
1533
+ /** @returns {SendOtpEmailCommsTemplate} */
1534
+ declare function SendOtpEmailCommsTemplate(): SendOtpEmailCommsTemplate;
1535
+ type SendOtpEmailCommsTemplate = {
1486
1536
  key?: string;
1487
1537
  value?: any;
1488
1538
  };
1489
- /** @returns {PayloadStructure} */
1490
- declare function PayloadStructure(): PayloadStructure;
1491
- type PayloadStructure = {
1492
- application?: string;
1493
- data?: any[];
1494
- email?: PayloadEmailStructure;
1495
- sms?: PayloadSmsStructure;
1496
- };
1497
- /** @returns {RecipientHeaders} */
1498
- declare function RecipientHeaders(): RecipientHeaders;
1499
- type RecipientHeaders = {
1500
- email?: string;
1501
- };
1502
- /** @returns {SendOtpCommsReq} */
1503
- declare function SendOtpCommsReq(): SendOtpCommsReq;
1504
- type SendOtpCommsReq = {
1505
- data?: SendOtpCommsReqData;
1506
- email?: SendOtpCommsReqEmail;
1507
- sms?: SendOtpCommsReqSms;
1508
- };
1509
1539
  /** @returns {SendOtpCommsReqData} */
1510
1540
  declare function SendOtpCommsReqData(): SendOtpCommsReqData;
1511
1541
  type SendOtpCommsReqData = {
1512
- country_code?: string;
1513
- mobile?: string;
1514
1542
  send_same_otp_to_channel?: boolean;
1543
+ mobile?: string;
1544
+ country_code?: string;
1515
1545
  to?: string;
1516
1546
  };
1517
- /** @returns {SendOtpCommsReqEmail} */
1518
- declare function SendOtpCommsReqEmail(): SendOtpCommsReqEmail;
1519
- type SendOtpCommsReqEmail = {
1520
- expiry?: number;
1521
- otp_length?: number;
1522
- provider?: SendOtpEmailCommsProvider;
1523
- template?: SendOtpEmailCommsTemplate;
1524
- };
1525
1547
  /** @returns {SendOtpCommsReqSms} */
1526
1548
  declare function SendOtpCommsReqSms(): SendOtpCommsReqSms;
1527
1549
  type SendOtpCommsReqSms = {
1528
- expiry?: number;
1529
1550
  otp_length?: number;
1530
- provider?: SendOtpSmsCommsProvider;
1551
+ expiry?: number;
1531
1552
  template?: SendOtpSmsCommsTemplate;
1553
+ provider?: SendOtpSmsCommsProvider;
1532
1554
  };
1533
- /** @returns {SendOtpCommsRes} */
1534
- declare function SendOtpCommsRes(): SendOtpCommsRes;
1535
- type SendOtpCommsRes = {
1536
- email?: SendOtpCommsResEmail;
1537
- sms?: SendOtpCommsResSms;
1538
- };
1539
- /** @returns {SendOtpCommsResEmail} */
1540
- declare function SendOtpCommsResEmail(): SendOtpCommsResEmail;
1541
- type SendOtpCommsResEmail = {
1542
- message?: string;
1543
- request_id?: string;
1544
- resend_timer?: number;
1545
- success?: boolean;
1546
- to?: string;
1555
+ /** @returns {SendOtpCommsReqEmail} */
1556
+ declare function SendOtpCommsReqEmail(): SendOtpCommsReqEmail;
1557
+ type SendOtpCommsReqEmail = {
1558
+ otp_length?: number;
1559
+ expiry?: number;
1560
+ template?: SendOtpEmailCommsTemplate;
1561
+ provider?: SendOtpEmailCommsProvider;
1547
1562
  };
1548
1563
  /** @returns {SendOtpCommsResSms} */
1549
1564
  declare function SendOtpCommsResSms(): SendOtpCommsResSms;
1550
1565
  type SendOtpCommsResSms = {
1551
- country_code?: string;
1566
+ success?: boolean;
1567
+ request_id?: string;
1552
1568
  message?: string;
1553
1569
  mobile?: string;
1554
- request_id?: string;
1570
+ country_code?: string;
1555
1571
  resend_timer?: number;
1572
+ };
1573
+ /** @returns {SendOtpCommsResEmail} */
1574
+ declare function SendOtpCommsResEmail(): SendOtpCommsResEmail;
1575
+ type SendOtpCommsResEmail = {
1556
1576
  success?: boolean;
1577
+ request_id?: string;
1578
+ message?: string;
1579
+ to?: string;
1580
+ resend_timer?: number;
1557
1581
  };
1558
- /** @returns {SendOtpEmailCommsProvider} */
1559
- declare function SendOtpEmailCommsProvider(): SendOtpEmailCommsProvider;
1560
- type SendOtpEmailCommsProvider = {
1561
- _id?: string;
1562
- slug?: string;
1582
+ /** @returns {SendOtpCommsReq} */
1583
+ declare function SendOtpCommsReq(): SendOtpCommsReq;
1584
+ type SendOtpCommsReq = {
1585
+ data?: SendOtpCommsReqData;
1586
+ sms?: SendOtpCommsReqSms;
1587
+ email?: SendOtpCommsReqEmail;
1563
1588
  };
1564
- /** @returns {SendOtpEmailCommsTemplate} */
1565
- declare function SendOtpEmailCommsTemplate(): SendOtpEmailCommsTemplate;
1566
- type SendOtpEmailCommsTemplate = {
1567
- key?: string;
1568
- value?: any;
1589
+ /** @returns {SendOtpCommsRes} */
1590
+ declare function SendOtpCommsRes(): SendOtpCommsRes;
1591
+ type SendOtpCommsRes = {
1592
+ sms?: SendOtpCommsResSms;
1593
+ email?: SendOtpCommsResEmail;
1569
1594
  };
1570
- /** @returns {SendOtpSmsCommsProvider} */
1571
- declare function SendOtpSmsCommsProvider(): SendOtpSmsCommsProvider;
1572
- type SendOtpSmsCommsProvider = {
1573
- _id?: string;
1574
- slug?: string;
1595
+ /** @returns {VerifyOtpCommsReq} */
1596
+ declare function VerifyOtpCommsReq(): VerifyOtpCommsReq;
1597
+ type VerifyOtpCommsReq = {
1598
+ request_id?: string;
1599
+ otp?: string;
1575
1600
  };
1576
- /** @returns {SendOtpSmsCommsTemplate} */
1577
- declare function SendOtpSmsCommsTemplate(): SendOtpSmsCommsTemplate;
1578
- type SendOtpSmsCommsTemplate = {
1579
- key?: string;
1580
- value?: any;
1601
+ /** @returns {VerifyOtpCommsSuccessRes} */
1602
+ declare function VerifyOtpCommsSuccessRes(): VerifyOtpCommsSuccessRes;
1603
+ type VerifyOtpCommsSuccessRes = {
1604
+ success?: boolean;
1605
+ mobile?: string;
1606
+ country_code?: string;
1607
+ message?: string;
1581
1608
  };
1582
- /** @returns {SmsProvider} */
1583
- declare function SmsProvider(): SmsProvider;
1584
- type SmsProvider = {
1585
- __v?: number;
1586
- _id?: string;
1587
- application?: string;
1588
- authkey?: string;
1589
- created_at?: string;
1590
- description?: string;
1591
- name?: string;
1592
- provider?: string;
1593
- rpt?: number;
1594
- sender?: string;
1595
- slug?: string;
1596
- type?: string;
1597
- updated_at?: string;
1598
- username?: string;
1609
+ /** @returns {VerifyOtpCommsErrorRes} */
1610
+ declare function VerifyOtpCommsErrorRes(): VerifyOtpCommsErrorRes;
1611
+ type VerifyOtpCommsErrorRes = {
1612
+ success?: boolean;
1613
+ message?: string;
1599
1614
  };
1600
1615
  /** @returns {SmsProviderReq} */
1601
1616
  declare function SmsProviderReq(): SmsProviderReq;
1602
1617
  type SmsProviderReq = {
1618
+ name?: string;
1619
+ description?: string;
1620
+ sender?: string;
1621
+ username?: string;
1622
+ authkey?: string;
1623
+ type?: string;
1624
+ provider?: string;
1603
1625
  /**
1604
- * - The api_key for the test.
1626
+ * - The password for the test.
1605
1627
  */
1606
- api_key?: string;
1628
+ password?: string;
1607
1629
  /**
1608
- * - The apikey for the test.
1630
+ * - The sender ID for the test.
1609
1631
  */
1610
- apikey?: string;
1611
- authkey?: string;
1612
- description?: string;
1632
+ senderid?: string;
1613
1633
  /**
1614
- * - The entity ID for the test.
1634
+ * - The feed ID for the test.
1615
1635
  */
1616
- entity_id?: string;
1636
+ feedid?: string;
1617
1637
  /**
1618
1638
  * - The entity ID for the test.
1619
1639
  */
1620
1640
  entityid?: string;
1621
1641
  /**
1622
- * - The feed ID for the test.
1642
+ * - Whether to override Do Not Disturb.
1623
1643
  */
1624
- feedid?: string;
1644
+ override_dnd?: boolean;
1625
1645
  /**
1626
1646
  * - The host for the test.
1627
1647
  */
1628
1648
  host?: string;
1629
- name?: string;
1630
1649
  /**
1631
- * - Whether to override Do Not Disturb.
1650
+ * - The port for the test.
1632
1651
  */
1633
- override_dnd?: boolean;
1652
+ port?: number;
1634
1653
  /**
1635
- * - The password for the test.
1654
+ * - The entity ID for the test.
1636
1655
  */
1637
- password?: string;
1656
+ entity_id?: string;
1638
1657
  /**
1639
- * - The port for the test.
1658
+ * - The apikey for the test.
1640
1659
  */
1641
- port?: number;
1642
- provider?: string;
1643
- sender?: string;
1660
+ apikey?: string;
1661
+ /**
1662
+ * - The version ID for the test.
1663
+ */
1664
+ version_id?: number;
1644
1665
  /**
1645
1666
  * - The sender ID for the test.
1646
1667
  */
1647
1668
  sender_id?: string;
1648
1669
  /**
1649
- * - The sender ID for the test.
1670
+ * - The api_key for the test.
1650
1671
  */
1651
- senderid?: string;
1672
+ api_key?: string;
1673
+ };
1674
+ /** @returns {SmsProvider} */
1675
+ declare function SmsProvider(): SmsProvider;
1676
+ type SmsProvider = {
1677
+ rpt?: number;
1652
1678
  type?: string;
1679
+ provider?: string;
1680
+ _id?: string;
1681
+ name?: string;
1682
+ description?: string;
1683
+ sender?: string;
1653
1684
  username?: string;
1654
- /**
1655
- * - The version ID for the test.
1656
- */
1657
- version_id?: number;
1685
+ authkey?: string;
1686
+ application?: string;
1687
+ created_at?: string;
1688
+ updated_at?: string;
1689
+ slug?: string;
1690
+ __v?: number;
1658
1691
  };
1659
1692
  /** @returns {SmsProviders} */
1660
1693
  declare function SmsProviders(): SmsProviders;
@@ -1662,135 +1695,113 @@ type SmsProviders = {
1662
1695
  items?: SmsProvider[];
1663
1696
  page?: Page;
1664
1697
  };
1698
+ /** @returns {DefaultSmsProviders} */
1699
+ declare function DefaultSmsProviders(): DefaultSmsProviders;
1700
+ type DefaultSmsProviders = {
1701
+ _id?: string;
1702
+ name?: string;
1703
+ is_default?: boolean;
1704
+ };
1705
+ /** @returns {SmsTemplateMessage} */
1706
+ declare function SmsTemplateMessage(): SmsTemplateMessage;
1707
+ type SmsTemplateMessage = {
1708
+ template_type?: string;
1709
+ template?: string;
1710
+ };
1711
+ /** @returns {SmsTemplates} */
1712
+ declare function SmsTemplates(): SmsTemplates;
1713
+ type SmsTemplates = {
1714
+ items?: SmsTemplate[];
1715
+ page?: Page;
1716
+ };
1665
1717
  /** @returns {SmsTemplate} */
1666
1718
  declare function SmsTemplate(): SmsTemplate;
1667
1719
  type SmsTemplate = {
1668
- __v?: number;
1720
+ url_shorten?: EnabledObj;
1669
1721
  _id?: string;
1670
1722
  application?: string;
1671
- category?: string;
1672
- created_at?: string;
1673
- description?: string;
1674
- is_internal?: boolean;
1675
1723
  is_system?: boolean;
1676
- message?: SmsTemplateMessage;
1724
+ is_internal?: boolean;
1677
1725
  meta?: metaObj;
1678
1726
  name?: string;
1727
+ description?: string;
1728
+ message?: SmsTemplateMessage;
1679
1729
  priority?: string;
1730
+ tags?: string[];
1731
+ template_variables?: any;
1732
+ template_id?: string;
1680
1733
  published?: boolean;
1734
+ category?: string;
1735
+ created_at?: string;
1736
+ updated_at?: string;
1681
1737
  slug?: string;
1738
+ __v?: number;
1739
+ };
1740
+ /** @returns {SystemSmsTemplates} */
1741
+ declare function SystemSmsTemplates(): SystemSmsTemplates;
1742
+ type SystemSmsTemplates = {
1743
+ url_shorten?: EnabledObj;
1744
+ _id?: string;
1745
+ is_system?: boolean;
1746
+ is_internal?: boolean;
1747
+ name?: string;
1748
+ description?: string;
1749
+ message?: SmsTemplateMessage;
1750
+ priority?: string;
1682
1751
  tags?: string[];
1683
- template_id?: string;
1684
1752
  template_variables?: any;
1753
+ template_id?: string;
1754
+ published?: boolean;
1755
+ category?: string;
1756
+ created_at?: string;
1685
1757
  updated_at?: string;
1686
- url_shorten?: EnabledObj;
1758
+ slug?: string;
1759
+ __v?: number;
1687
1760
  };
1688
- /** @returns {SmsTemplateMessage} */
1689
- declare function SmsTemplateMessage(): SmsTemplateMessage;
1690
- type SmsTemplateMessage = {
1761
+ /** @returns {metaObj} */
1762
+ declare function metaObj(): metaObj;
1763
+ type metaObj = {
1764
+ type?: string;
1765
+ is_system?: boolean;
1691
1766
  template?: string;
1692
- template_type?: string;
1693
1767
  };
1694
1768
  /** @returns {SmsTemplateReq} */
1695
1769
  declare function SmsTemplateReq(): SmsTemplateReq;
1696
1770
  type SmsTemplateReq = {
1697
- description?: string;
1698
- message?: SmsTemplateMessage;
1699
- meta?: metaObj;
1700
1771
  name: string;
1772
+ description?: string;
1701
1773
  priority?: string;
1702
- published?: boolean;
1703
1774
  template_id?: string;
1775
+ meta?: metaObj;
1704
1776
  template_variables?: any;
1705
- };
1706
- /** @returns {SmsTemplates} */
1707
- declare function SmsTemplates(): SmsTemplates;
1708
- type SmsTemplates = {
1709
- items?: SmsTemplate[];
1710
- page?: Page;
1711
- };
1712
- /** @returns {Stats} */
1713
- declare function Stats(): Stats;
1714
- type Stats = {
1715
- _id?: string;
1716
- imported?: any;
1717
- processed?: any;
1718
- };
1719
- /** @returns {StatsImported} */
1720
- declare function StatsImported(): StatsImported;
1721
- type StatsImported = {
1722
- count?: number;
1723
- };
1724
- /** @returns {StatsProcessed} */
1725
- declare function StatsProcessed(): StatsProcessed;
1726
- type StatsProcessed = {
1727
- email?: StatsProcessedEmail;
1728
- sms?: StatsProcessedSms;
1729
- };
1730
- /** @returns {StatsProcessedEmail} */
1731
- declare function StatsProcessedEmail(): StatsProcessedEmail;
1732
- type StatsProcessedEmail = {
1733
- failed?: number;
1734
- success?: number;
1735
- suppressed?: number;
1736
- };
1737
- /** @returns {StatsProcessedSms} */
1738
- declare function StatsProcessedSms(): StatsProcessedSms;
1739
- type StatsProcessedSms = {
1740
- failed?: number;
1741
- success?: number;
1742
- suppressed?: number;
1743
- };
1744
- /** @returns {SubscriptionsObject} */
1745
- declare function SubscriptionsObject(): SubscriptionsObject;
1746
- type SubscriptionsObject = {
1747
- /**
1748
- * - Subscription ID
1749
- */
1750
- _id?: string;
1751
- template?: TemplateObject;
1752
- };
1753
- /** @returns {SystemEmailTemplate} */
1754
- declare function SystemEmailTemplate(): SystemEmailTemplate;
1755
- type SystemEmailTemplate = {
1756
- __v?: number;
1757
- _id?: string;
1758
- attachments?: number[];
1759
- category?: string;
1760
- created_at?: string;
1761
- description?: string;
1762
- headers?: EmailTemplateHeaders[];
1763
- html?: TemplateAndType;
1764
- is_internal?: boolean;
1765
- is_system?: boolean;
1766
- name?: string;
1767
- priority?: string;
1768
1777
  published?: boolean;
1769
- slug?: string;
1770
- static_bcc?: string[];
1771
- static_cc?: string[];
1772
- static_to?: string[];
1773
- subject?: TemplateAndType;
1774
- tags?: string[];
1775
- template_variables?: any;
1776
- text?: TemplateAndType;
1777
- updated_at?: string;
1778
- url_shorten?: EnabledObj;
1778
+ message?: SmsTemplateMessage;
1779
1779
  };
1780
- /** @returns {SystemEmailTemplates} */
1781
- declare function SystemEmailTemplates(): SystemEmailTemplates;
1782
- type SystemEmailTemplates = {
1783
- items?: SystemEmailTemplate[];
1780
+ /** @returns {Notification} */
1781
+ declare function Notification(): Notification;
1782
+ type Notification = {
1783
+ title?: string;
1784
+ body?: string;
1785
+ subtitle?: string;
1786
+ icon?: string;
1787
+ deeplink?: string;
1788
+ click_action?: string;
1789
+ };
1790
+ /** @returns {SystemNotificationUser} */
1791
+ declare function SystemNotificationUser(): SystemNotificationUser;
1792
+ type SystemNotificationUser = {
1793
+ type?: string;
1794
+ value?: string;
1784
1795
  };
1785
1796
  /** @returns {SystemNotification} */
1786
1797
  declare function SystemNotification(): SystemNotification;
1787
1798
  type SystemNotification = {
1788
- _id?: string;
1789
- created_at?: string;
1790
- group?: string;
1791
1799
  notification?: Notification;
1792
- settings?: SystemNotificationUser;
1793
1800
  user?: SystemNotificationUser;
1801
+ settings?: SystemNotificationUser;
1802
+ _id?: string;
1803
+ group?: string;
1804
+ created_at?: string;
1794
1805
  };
1795
1806
  /** @returns {SystemNotifications} */
1796
1807
  declare function SystemNotifications(): SystemNotifications;
@@ -1799,73 +1810,62 @@ type SystemNotifications = {
1799
1810
  last_read_anchor?: number;
1800
1811
  page?: Page;
1801
1812
  };
1802
- /** @returns {SystemNotificationUser} */
1803
- declare function SystemNotificationUser(): SystemNotificationUser;
1804
- type SystemNotificationUser = {
1805
- type?: string;
1806
- value?: string;
1807
- };
1808
- /** @returns {SystemSmsTemplates} */
1809
- declare function SystemSmsTemplates(): SystemSmsTemplates;
1810
- type SystemSmsTemplates = {
1811
- __v?: number;
1812
- _id?: string;
1813
- category?: string;
1814
- created_at?: string;
1815
- description?: string;
1816
- is_internal?: boolean;
1817
- is_system?: boolean;
1818
- message?: SmsTemplateMessage;
1819
- name?: string;
1820
- priority?: string;
1821
- published?: boolean;
1822
- slug?: string;
1823
- tags?: string[];
1824
- template_id?: string;
1825
- template_variables?: any;
1826
- updated_at?: string;
1827
- url_shorten?: EnabledObj;
1828
- };
1829
- /** @returns {TemplateAndType} */
1830
- declare function TemplateAndType(): TemplateAndType;
1831
- type TemplateAndType = {
1832
- template?: string;
1833
- template_type?: string;
1834
- };
1835
- /** @returns {TemplateObject} */
1836
- declare function TemplateObject(): TemplateObject;
1837
- type TemplateObject = {
1838
- email?: CommunicationTemplate;
1839
- pushnotification?: CommunicationTemplate;
1840
- sms?: CommunicationTemplate;
1813
+ /** @returns {Page} */
1814
+ declare function Page(): Page;
1815
+ type Page = {
1816
+ item_total?: number;
1817
+ next_id?: string;
1818
+ has_previous?: boolean;
1819
+ has_next?: boolean;
1820
+ current?: number;
1821
+ type: string;
1822
+ size?: number;
1841
1823
  };
1842
- /** @returns {TriggerJobRequest} */
1843
- declare function TriggerJobRequest(): TriggerJobRequest;
1844
- type TriggerJobRequest = {
1845
- job_id?: string;
1824
+ /** @returns {GenericError} */
1825
+ declare function GenericError(): GenericError;
1826
+ type GenericError = {
1827
+ message?: Message;
1828
+ sentry?: string;
1846
1829
  };
1847
- /** @returns {TriggerJobResponse} */
1848
- declare function TriggerJobResponse(): TriggerJobResponse;
1849
- type TriggerJobResponse = {
1850
- status?: number;
1830
+ /** @returns {GenericDelete} */
1831
+ declare function GenericDelete(): GenericDelete;
1832
+ type GenericDelete = {
1833
+ message?: string;
1834
+ acknowledged?: boolean;
1835
+ affected?: number;
1836
+ operation?: string;
1851
1837
  };
1852
- /** @returns {VerifyOtpCommsErrorRes} */
1853
- declare function VerifyOtpCommsErrorRes(): VerifyOtpCommsErrorRes;
1854
- type VerifyOtpCommsErrorRes = {
1838
+ /** @returns {Message} */
1839
+ declare function Message(): Message;
1840
+ type Message = {
1855
1841
  message?: string;
1856
1842
  success?: boolean;
1843
+ info?: string;
1844
+ operation?: string;
1857
1845
  };
1858
- /** @returns {VerifyOtpCommsReq} */
1859
- declare function VerifyOtpCommsReq(): VerifyOtpCommsReq;
1860
- type VerifyOtpCommsReq = {
1861
- otp?: string;
1862
- request_id?: string;
1846
+ /** @returns {EnabledObj} */
1847
+ declare function EnabledObj(): EnabledObj;
1848
+ type EnabledObj = {
1849
+ enabled?: boolean;
1863
1850
  };
1864
- /** @returns {VerifyOtpCommsSuccessRes} */
1865
- declare function VerifyOtpCommsSuccessRes(): VerifyOtpCommsSuccessRes;
1866
- type VerifyOtpCommsSuccessRes = {
1867
- country_code?: string;
1868
- message?: string;
1869
- mobile?: string;
1870
- success?: boolean;
1851
+ /** @returns {OtpConfigurationExpiryDuration} */
1852
+ declare function OtpConfigurationExpiryDuration(): OtpConfigurationExpiryDuration;
1853
+ type OtpConfigurationExpiryDuration = {
1854
+ time: number;
1855
+ denomination: string;
1856
+ };
1857
+ /** @returns {OtpConfigurationExpiry} */
1858
+ declare function OtpConfigurationExpiry(): OtpConfigurationExpiry;
1859
+ type OtpConfigurationExpiry = {
1860
+ duration: OtpConfigurationExpiryDuration;
1861
+ type: string;
1862
+ };
1863
+ /** @returns {OtpConfiguration} */
1864
+ declare function OtpConfiguration(): OtpConfiguration;
1865
+ type OtpConfiguration = {
1866
+ otp_length: number;
1867
+ type: string;
1868
+ expiry: OtpConfigurationExpiry;
1869
+ application_id?: string;
1870
+ company_id?: string;
1871
1871
  };