@gofynd/fdk-client-javascript 1.2.0 → 1.3.0

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 (262) hide show
  1. package/README.md +44 -7
  2. package/package.json +1 -2
  3. package/sdk/application/ApplicationAPIClient.d.ts +3 -3
  4. package/sdk/application/ApplicationAPIClient.js +6 -4
  5. package/sdk/application/ApplicationClient.d.ts +2 -3
  6. package/sdk/application/ApplicationClient.js +1 -45
  7. package/sdk/application/ApplicationConfig.d.ts +46 -6
  8. package/sdk/application/ApplicationConfig.js +15 -16
  9. package/sdk/application/Cart/CartApplicationClient.d.ts +61 -33
  10. package/sdk/application/Cart/CartApplicationClient.js +225 -134
  11. package/sdk/application/Cart/CartApplicationModel.d.ts +4 -4
  12. package/sdk/application/Cart/CartApplicationModel.js +4 -4
  13. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +61 -30
  14. package/sdk/application/Catalog/CatalogApplicationClient.js +234 -146
  15. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +115 -13
  16. package/sdk/application/Catalog/CatalogApplicationModel.js +77 -12
  17. package/sdk/application/Common/CommonApplicationClient.d.ts +5 -3
  18. package/sdk/application/Common/CommonApplicationClient.js +13 -11
  19. package/sdk/application/Common/CommonApplicationModel.d.ts +3 -83
  20. package/sdk/application/Common/CommonApplicationModel.js +2 -58
  21. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +9 -3
  22. package/sdk/application/Communication/CommunicationApplicationClient.js +25 -13
  23. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +1 -34
  24. package/sdk/application/Communication/CommunicationApplicationModel.js +0 -36
  25. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +46 -16
  26. package/sdk/application/Configuration/ConfigurationApplicationClient.js +144 -68
  27. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1 -219
  28. package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -226
  29. package/sdk/application/Content/ContentApplicationClient.d.ts +49 -21
  30. package/sdk/application/Content/ContentApplicationClient.js +159 -80
  31. package/sdk/application/Content/ContentApplicationModel.d.ts +5 -622
  32. package/sdk/application/Content/ContentApplicationModel.js +11 -763
  33. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -3
  34. package/sdk/application/FileStorage/FileStorageApplicationClient.js +20 -14
  35. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +1 -152
  36. package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -180
  37. package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -7
  38. package/sdk/application/Lead/LeadApplicationClient.js +50 -31
  39. package/sdk/application/Lead/LeadApplicationModel.d.ts +22 -741
  40. package/sdk/application/Lead/LeadApplicationModel.js +21 -481
  41. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +11 -5
  42. package/sdk/application/Logistic/LogisticApplicationClient.js +41 -20
  43. package/sdk/application/Order/OrderApplicationClient.d.ts +24 -12
  44. package/sdk/application/Order/OrderApplicationClient.js +88 -56
  45. package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -42
  46. package/sdk/application/Payment/PaymentApplicationClient.js +293 -194
  47. package/sdk/application/Payment/PaymentApplicationModel.d.ts +36 -36
  48. package/sdk/application/Payment/PaymentApplicationModel.js +36 -36
  49. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +59 -32
  50. package/sdk/application/PosCart/PosCartApplicationClient.js +214 -130
  51. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +2 -2
  52. package/sdk/application/PosCart/PosCartApplicationModel.js +2 -2
  53. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +16 -7
  54. package/sdk/application/Rewards/RewardsApplicationClient.js +56 -29
  55. package/sdk/application/Share/ShareApplicationClient.d.ts +15 -7
  56. package/sdk/application/Share/ShareApplicationClient.js +51 -31
  57. package/sdk/application/Share/ShareApplicationModel.d.ts +1 -33
  58. package/sdk/application/Share/ShareApplicationModel.js +0 -38
  59. package/sdk/application/Theme/ThemeApplicationClient.d.ts +9 -4
  60. package/sdk/application/Theme/ThemeApplicationClient.js +35 -18
  61. package/sdk/application/Theme/ThemeApplicationModel.d.ts +982 -312
  62. package/sdk/application/Theme/ThemeApplicationModel.js +621 -284
  63. package/sdk/application/User/UserApplicationClient.d.ts +74 -35
  64. package/sdk/application/User/UserApplicationClient.js +252 -161
  65. package/sdk/application/User/UserApplicationModel.d.ts +3 -401
  66. package/sdk/application/User/UserApplicationModel.js +2 -490
  67. package/sdk/common/AxiosHelper.js +1 -2
  68. package/sdk/common/FDKError.d.ts +3 -0
  69. package/sdk/common/FDKError.js +8 -0
  70. package/sdk/common/utils.d.ts +3 -0
  71. package/sdk/common/utils.js +29 -0
  72. package/sdk/partner/PartnerAPIClient.d.ts +5 -4
  73. package/sdk/partner/PartnerAPIClient.js +7 -4
  74. package/sdk/partner/PartnerClient.d.ts +2 -0
  75. package/sdk/partner/PartnerClient.js +3 -0
  76. package/sdk/partner/Theme/ThemePartnerClient.d.ts +299 -0
  77. package/sdk/partner/Theme/ThemePartnerClient.js +768 -0
  78. package/sdk/partner/Theme/ThemePartnerModel.d.ts +1706 -0
  79. package/sdk/partner/Theme/ThemePartnerModel.js +1409 -0
  80. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +22 -0
  81. package/sdk/partner/Theme/ThemePartnerValidator.js +157 -0
  82. package/sdk/partner/index.d.ts +3 -1
  83. package/sdk/partner/index.js +3 -1
  84. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -4
  85. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +38 -16
  86. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +1 -13
  87. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +0 -12
  88. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +10 -0
  89. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +4 -0
  90. package/sdk/platform/Billing/BillingPlatformClient.d.ts +59 -14
  91. package/sdk/platform/Billing/BillingPlatformClient.js +315 -64
  92. package/sdk/platform/Billing/BillingPlatformModel.d.ts +56 -196
  93. package/sdk/platform/Billing/BillingPlatformModel.js +63 -217
  94. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +23 -1
  95. package/sdk/platform/Billing/BillingPlatformValidator.js +31 -0
  96. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +124 -63
  97. package/sdk/platform/Cart/CartPlatformApplicationClient.js +431 -265
  98. package/sdk/platform/Cart/CartPlatformModel.d.ts +253 -53
  99. package/sdk/platform/Cart/CartPlatformModel.js +104 -54
  100. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +120 -53
  101. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +398 -247
  102. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +155 -78
  103. package/sdk/platform/Catalog/CatalogPlatformClient.js +561 -355
  104. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +10 -12
  105. package/sdk/platform/Catalog/CatalogPlatformModel.js +10 -12
  106. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +30 -0
  107. package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -0
  108. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -3
  109. package/sdk/platform/Common/CommonPlatformClient.js +13 -11
  110. package/sdk/platform/Common/CommonPlatformModel.d.ts +39 -64
  111. package/sdk/platform/Common/CommonPlatformModel.js +23 -57
  112. package/sdk/platform/Common/CommonPlatformValidator.d.ts +5 -10
  113. package/sdk/platform/Common/CommonPlatformValidator.js +3 -4
  114. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +370 -120
  115. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +2328 -888
  116. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +143 -24
  117. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +179 -15
  118. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
  119. package/sdk/platform/Communication/CommunicationPlatformClient.js +6 -5
  120. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +386 -308
  121. package/sdk/platform/Communication/CommunicationPlatformModel.js +415 -355
  122. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +38 -13
  123. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +171 -57
  124. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +53 -1
  125. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +54 -0
  126. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +5 -1
  127. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +7 -0
  128. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +96 -29
  129. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +311 -126
  130. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +5 -1
  131. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +7 -0
  132. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +36 -18
  133. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +121 -86
  134. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +13 -180
  135. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +5 -113
  136. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +162 -70
  137. package/sdk/platform/Content/ContentPlatformApplicationClient.js +528 -309
  138. package/sdk/platform/Content/ContentPlatformModel.d.ts +9 -198
  139. package/sdk/platform/Content/ContentPlatformModel.js +8 -231
  140. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +48 -11
  141. package/sdk/platform/Discount/DiscountPlatformClient.js +142 -48
  142. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +40 -1
  143. package/sdk/platform/Discount/DiscountPlatformModel.js +27 -0
  144. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +84 -18
  145. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +486 -53
  146. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +71 -7
  147. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +81 -5
  148. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +13 -18
  149. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +58 -65
  150. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +198 -71
  151. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +212 -64
  152. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +18 -10
  153. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -6
  154. package/sdk/platform/Finance/FinancePlatformClient.d.ts +177 -40
  155. package/sdk/platform/Finance/FinancePlatformClient.js +1028 -132
  156. package/sdk/platform/Finance/FinancePlatformModel.d.ts +670 -22
  157. package/sdk/platform/Finance/FinancePlatformModel.js +809 -23
  158. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +111 -1
  159. package/sdk/platform/Finance/FinancePlatformValidator.js +134 -0
  160. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +24 -12
  161. package/sdk/platform/Inventory/InventoryPlatformClient.js +94 -52
  162. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +27 -13
  163. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +101 -55
  164. package/sdk/platform/Lead/LeadPlatformClient.d.ts +50 -39
  165. package/sdk/platform/Lead/LeadPlatformClient.js +171 -112
  166. package/sdk/platform/Lead/LeadPlatformModel.d.ts +32 -390
  167. package/sdk/platform/Lead/LeadPlatformModel.js +31 -214
  168. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +33 -33
  169. package/sdk/platform/Lead/LeadPlatformValidator.js +23 -23
  170. package/sdk/platform/OAuthClient.js +6 -2
  171. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -2
  172. package/sdk/platform/Order/OrderPlatformApplicationClient.js +12 -10
  173. package/sdk/platform/Order/OrderPlatformClient.d.ts +165 -71
  174. package/sdk/platform/Order/OrderPlatformClient.js +738 -205
  175. package/sdk/platform/Order/OrderPlatformModel.d.ts +261 -3
  176. package/sdk/platform/Order/OrderPlatformModel.js +225 -2
  177. package/sdk/platform/Order/OrderPlatformValidator.d.ts +104 -3
  178. package/sdk/platform/Order/OrderPlatformValidator.js +85 -2
  179. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -22
  180. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +12 -159
  181. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -30
  182. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +0 -26
  183. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -690
  184. package/sdk/platform/Partner/PartnerPlatformModel.js +0 -809
  185. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +167 -32
  186. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +793 -145
  187. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +91 -1
  188. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +91 -0
  189. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -10
  190. package/sdk/platform/Payment/PaymentPlatformClient.js +68 -47
  191. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +549 -7
  192. package/sdk/platform/Payment/PaymentPlatformModel.js +305 -6
  193. package/sdk/platform/PlatformAPIClient.d.ts +3 -3
  194. package/sdk/platform/PlatformAPIClient.js +2 -2
  195. package/sdk/platform/PlatformClient.d.ts +2 -2
  196. package/sdk/platform/PlatformClient.js +4 -4
  197. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +28 -12
  198. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +90 -53
  199. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +1 -12
  200. package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -14
  201. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +62 -26
  202. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +210 -93
  203. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +20 -11
  204. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +23 -11
  205. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +36 -18
  206. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +142 -78
  207. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +12 -3
  208. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +14 -2
  209. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -26
  210. package/sdk/platform/Share/SharePlatformApplicationClient.js +36 -67
  211. package/sdk/platform/Share/SharePlatformModel.d.ts +4 -4
  212. package/sdk/platform/Share/SharePlatformModel.js +4 -4
  213. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +127 -57
  214. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +564 -189
  215. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +63 -26
  216. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +62 -22
  217. package/sdk/platform/Theme/ThemePlatformClient.d.ts +37 -0
  218. package/sdk/platform/Theme/ThemePlatformClient.js +235 -0
  219. package/sdk/platform/Theme/ThemePlatformModel.d.ts +1167 -261
  220. package/sdk/platform/Theme/ThemePlatformModel.js +801 -244
  221. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +32 -0
  222. package/sdk/platform/Theme/ThemePlatformValidator.js +38 -0
  223. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -17
  224. package/sdk/platform/User/UserPlatformApplicationClient.js +132 -73
  225. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -0
  226. package/sdk/platform/User/UserPlatformApplicationValidator.js +3 -0
  227. package/sdk/platform/User/UserPlatformModel.d.ts +1 -738
  228. package/sdk/platform/User/UserPlatformModel.js +3 -899
  229. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +120 -7
  230. package/sdk/platform/Webhook/WebhookPlatformClient.js +799 -41
  231. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +476 -86
  232. package/sdk/platform/Webhook/WebhookPlatformModel.js +388 -89
  233. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +96 -9
  234. package/sdk/platform/Webhook/WebhookPlatformValidator.js +117 -5
  235. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -3
  236. package/sdk/public/Configuration/ConfigurationPublicClient.js +13 -11
  237. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +3 -106
  238. package/sdk/public/Configuration/ConfigurationPublicModel.js +2 -59
  239. package/sdk/public/Inventory/InventoryPublicClient.d.ts +12 -6
  240. package/sdk/public/Inventory/InventoryPublicClient.js +42 -27
  241. package/sdk/public/Partner/PartnerPublicClient.d.ts +22 -0
  242. package/sdk/public/Partner/PartnerPublicClient.js +110 -0
  243. package/sdk/public/Partner/PartnerPublicModel.d.ts +240 -0
  244. package/sdk/public/Partner/PartnerPublicModel.js +280 -0
  245. package/sdk/public/Partner/PartnerPublicValidator.d.ts +18 -0
  246. package/sdk/public/Partner/PartnerPublicValidator.js +19 -0
  247. package/sdk/public/PublicAPIClient.d.ts +14 -1
  248. package/sdk/public/PublicAPIClient.js +7 -1
  249. package/sdk/public/PublicClient.d.ts +2 -0
  250. package/sdk/public/PublicClient.js +4 -0
  251. package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -2
  252. package/sdk/public/Webhook/WebhookPublicClient.js +15 -9
  253. package/sdk/public/Webhook/WebhookPublicModel.d.ts +1 -191
  254. package/sdk/public/Webhook/WebhookPublicModel.js +0 -229
  255. package/sdk/public/index.d.ts +1 -0
  256. package/sdk/public/index.js +2 -0
  257. package/sdk/application/ApplicationModels.d.ts +0 -48
  258. package/sdk/application/ApplicationModels.js +0 -38
  259. package/sdk/platform/Partner/PartnerPlatformClient.d.ts +0 -106
  260. package/sdk/platform/Partner/PartnerPlatformClient.js +0 -878
  261. package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +0 -208
  262. package/sdk/platform/Partner/PartnerPlatformValidator.js +0 -169
@@ -1,4 +1,36 @@
1
1
  export = CommunicationPlatformModel;
2
+ /**
3
+ * @typedef AppProvider
4
+ * @property {number} [__v]
5
+ * @property {string} [_id]
6
+ * @property {string} [application]
7
+ * @property {string} [created_at]
8
+ * @property {AppProviderRes} [email]
9
+ * @property {AppProviderRes} [sms]
10
+ * @property {string} [updated_at]
11
+ * @property {AppProviderResVoice} [voice]
12
+ */
13
+ /**
14
+ * @typedef AppProviderReq
15
+ * @property {AppProviderRes} [email]
16
+ * @property {AppProviderRes} [sms]
17
+ * @property {AppProviderResVoice} [voice]
18
+ */
19
+ /**
20
+ * @typedef AppProviderRes
21
+ * @property {AppProviderResObj} [otp]
22
+ * @property {AppProviderResObj} [promotional]
23
+ * @property {AppProviderResObj} [transaction]
24
+ */
25
+ /**
26
+ * @typedef AppProviderResObj
27
+ * @property {string} [provider]
28
+ */
29
+ /**
30
+ * @typedef AppProviderResVoice
31
+ * @property {AppProviderResObj} [otp]
32
+ * @property {AppProviderResObj} [transaction]
33
+ */
2
34
  /**
3
35
  * @typedef Audience
4
36
  * @property {number} [__v]
@@ -18,11 +50,9 @@ export = CommunicationPlatformModel;
18
50
  */
19
51
  /**
20
52
  * @typedef AudienceReq
21
- * @property {string} [application]
22
53
  * @property {string} [description]
23
54
  * @property {string} [file_url]
24
55
  * @property {string[]} [headers]
25
- * @property {boolean} [is_active]
26
56
  * @property {string} [name]
27
57
  * @property {number} [records_count]
28
58
  * @property {string[]} [tags]
@@ -38,20 +68,6 @@ export = CommunicationPlatformModel;
38
68
  * @property {string} [message] - Failure message.
39
69
  * @property {string} [status] - Response status.
40
70
  */
41
- /**
42
- * @typedef BigqueryHeadersReq
43
- * @property {string} [query]
44
- * @property {string} [type]
45
- */
46
- /**
47
- * @typedef BigqueryHeadersRes
48
- * @property {BigqueryHeadersResHeaders[]} [headers]
49
- */
50
- /**
51
- * @typedef BigqueryHeadersResHeaders
52
- * @property {string} [name]
53
- * @property {string} [type]
54
- */
55
71
  /**
56
72
  * @typedef Campaign
57
73
  * @property {number} [__v]
@@ -102,6 +118,26 @@ export = CommunicationPlatformModel;
102
118
  * @property {string} [from_email]
103
119
  * @property {string} [from_name]
104
120
  */
121
+ /**
122
+ * @typedef DefaultSmsProviders
123
+ * @property {string} [_id]
124
+ * @property {boolean} [is_default]
125
+ * @property {string} [name]
126
+ */
127
+ /**
128
+ * @typedef DummyDatasources
129
+ * @property {number} [id]
130
+ * @property {string} [name]
131
+ */
132
+ /**
133
+ * @typedef DummyDatasourcesMeta
134
+ * @property {DummyDatasourcesMetaObj} [data]
135
+ * @property {number} [id]
136
+ */
137
+ /**
138
+ * @typedef DummyDatasourcesMetaObj
139
+ * @property {number} [b]
140
+ */
105
141
  /**
106
142
  * @typedef EmailProvider
107
143
  * @property {number} [__v]
@@ -141,35 +177,32 @@ export = CommunicationPlatformModel;
141
177
  * @typedef EmailTemplate
142
178
  * @property {number} [__v]
143
179
  * @property {string} [_id]
144
- * @property {Object[]} [attachments]
180
+ * @property {string} [application]
181
+ * @property {number[]} [attachments]
182
+ * @property {string} [category]
145
183
  * @property {string} [created_at]
146
184
  * @property {string} [description]
185
+ * @property {string} [editor_meta]
186
+ * @property {string} [editor_type]
147
187
  * @property {string} [from_name]
148
- * @property {Object[]} [headers]
188
+ * @property {EmailTemplateHeaders[]} [headers]
149
189
  * @property {TemplateAndType} [html]
150
190
  * @property {boolean} [is_internal]
151
191
  * @property {boolean} [is_system]
152
192
  * @property {string} [name]
153
193
  * @property {string} [priority]
154
194
  * @property {boolean} [published]
195
+ * @property {string} [reply_to]
155
196
  * @property {string} [slug]
156
- * @property {Object[]} [static_bcc]
157
- * @property {Object[]} [static_cc]
158
- * @property {Object[]} [static_to]
197
+ * @property {string[]} [static_bcc]
198
+ * @property {string[]} [static_cc]
199
+ * @property {string[]} [static_to]
159
200
  * @property {TemplateAndType} [subject]
160
- * @property {Object[]} [tags]
201
+ * @property {string[]} [tags]
202
+ * @property {Object} [template_variables]
161
203
  * @property {TemplateAndType} [text]
162
204
  * @property {string} [updated_at]
163
- */
164
- /**
165
- * @typedef EmailTemplateDeleteFailureRes
166
- * @property {string} [message]
167
- * @property {boolean} [success]
168
- */
169
- /**
170
- * @typedef EmailTemplateDeleteSuccessRes
171
- * @property {string} [message]
172
- * @property {boolean} [success]
205
+ * @property {EnabledObj} [url_shorten]
173
206
  */
174
207
  /**
175
208
  * @typedef EmailTemplateHeaders
@@ -184,50 +217,35 @@ export = CommunicationPlatformModel;
184
217
  */
185
218
  /**
186
219
  * @typedef EmailTemplateReq
187
- * @property {Object[]} [attachments]
188
- * @property {string} [description]
189
- * @property {EmailTemplateHeaders[]} [headers]
190
- * @property {TemplateAndType} [html]
191
- * @property {EmailTemplateKeys} [keys]
192
- * @property {string} [name]
193
- * @property {string} [priority]
194
- * @property {string} [reply_to]
195
- * @property {string[]} [static_bcc]
196
- * @property {string[]} [static_cc]
197
- * @property {string[]} [static_to]
198
- * @property {TemplateAndType} [subject]
199
- * @property {TemplateAndType} [text]
200
- */
201
- /**
202
- * @typedef EmailTemplateRes
203
- * @property {number} [__v]
204
- * @property {string} [_id]
205
- * @property {Object[]} [attachments]
206
- * @property {string} [created_at]
220
+ * @property {number[]} [attachments]
207
221
  * @property {string} [description]
222
+ * @property {string} [editor_meta]
223
+ * @property {string} [editor_type]
224
+ * @property {string} [from_name]
208
225
  * @property {EmailTemplateHeaders[]} [headers]
209
226
  * @property {TemplateAndType} [html]
210
- * @property {boolean} [is_internal]
211
- * @property {boolean} [is_system]
212
227
  * @property {EmailTemplateKeys} [keys]
213
- * @property {string} [name]
228
+ * @property {string} name
214
229
  * @property {string} [priority]
215
230
  * @property {boolean} [published]
216
231
  * @property {string} [reply_to]
217
- * @property {string} [slug]
218
232
  * @property {string[]} [static_bcc]
219
233
  * @property {string[]} [static_cc]
220
234
  * @property {string[]} [static_to]
221
235
  * @property {TemplateAndType} [subject]
222
- * @property {Object[]} [tags]
236
+ * @property {string[]} [tags]
237
+ * @property {Object} [template_variables]
223
238
  * @property {TemplateAndType} [text]
224
- * @property {string} [updated_at]
225
239
  */
226
240
  /**
227
241
  * @typedef EmailTemplates
228
242
  * @property {EmailTemplate[]} [items]
229
243
  * @property {Page} [page]
230
244
  */
245
+ /**
246
+ * @typedef EnabledObj
247
+ * @property {boolean} [enabled]
248
+ */
231
249
  /**
232
250
  * @typedef EngineRequest
233
251
  * @property {MetaStructure} [meta]
@@ -269,6 +287,18 @@ export = CommunicationPlatformModel;
269
287
  * @property {boolean} [subscribed]
270
288
  * @property {string} [template]
271
289
  */
290
+ /**
291
+ * @typedef GenericDelete
292
+ * @property {boolean} [acknowledged]
293
+ * @property {number} [affected]
294
+ * @property {string} [message]
295
+ * @property {string} [operation]
296
+ */
297
+ /**
298
+ * @typedef GenericError
299
+ * @property {Message} [message]
300
+ * @property {string} [sentry]
301
+ */
272
302
  /**
273
303
  * @typedef GetNRecordsCsvReq
274
304
  * @property {number} [count]
@@ -291,6 +321,34 @@ export = CommunicationPlatformModel;
291
321
  * @typedef GetStats
292
322
  * @property {Stats[]} [items]
293
323
  */
324
+ /**
325
+ * @typedef GlobalProviders
326
+ * @property {GlobalProvidersResObj[]} [email]
327
+ * @property {GlobalProvidersResObj[]} [sms]
328
+ * @property {GlobalProvidersResObj[]} [voice]
329
+ */
330
+ /**
331
+ * @typedef GlobalProvidersResObj
332
+ * @property {string} [_id]
333
+ * @property {string} [name]
334
+ */
335
+ /**
336
+ * @typedef GlobalVariablesGetResponse
337
+ * @property {Object} [editable]
338
+ * @property {Object} [read_only]
339
+ */
340
+ /**
341
+ * @typedef GlobalVariablesPostResponse
342
+ * @property {string} [_id]
343
+ * @property {string} [application]
344
+ * @property {string} [category]
345
+ * @property {string} [created_at]
346
+ * @property {Object} [global_variables]
347
+ */
348
+ /**
349
+ * @typedef GlobalVariablesReq
350
+ * @property {Object} [global_variables]
351
+ */
294
352
  /**
295
353
  * @typedef Job
296
354
  * @property {number} [__v]
@@ -327,7 +385,6 @@ export = CommunicationPlatformModel;
327
385
  * @typedef Log
328
386
  * @property {string} [_id]
329
387
  * @property {string} [application]
330
- * @property {string} [channel_type]
331
388
  * @property {string} [created_at]
332
389
  * @property {Object} [data]
333
390
  * @property {LogEmail} [email]
@@ -335,7 +392,6 @@ export = CommunicationPlatformModel;
335
392
  * @property {LogMeta} [meta]
336
393
  * @property {LogPushnotification} [pushnotification]
337
394
  * @property {string} [service]
338
- * @property {string} [source]
339
395
  * @property {string} [status]
340
396
  * @property {string} [step]
341
397
  */
@@ -361,6 +417,19 @@ export = CommunicationPlatformModel;
361
417
  * @property {Log[]} [items]
362
418
  * @property {Page} [page]
363
419
  */
420
+ /**
421
+ * @typedef Message
422
+ * @property {string} [info]
423
+ * @property {string} [message]
424
+ * @property {string} [operation]
425
+ * @property {boolean} [success]
426
+ */
427
+ /**
428
+ * @typedef metaObj
429
+ * @property {boolean} [is_system]
430
+ * @property {string} [template]
431
+ * @property {string} [type]
432
+ */
364
433
  /**
365
434
  * @typedef MetaStructure
366
435
  * @property {string} [action]
@@ -426,27 +495,6 @@ export = CommunicationPlatformModel;
426
495
  * @property {PayloadEmailStructure} [email]
427
496
  * @property {PayloadSmsStructure} [sms]
428
497
  */
429
- /**
430
- * @typedef PushtokenReq
431
- * @property {string} [action]
432
- * @property {string} [bundle_identifier]
433
- * @property {string} [push_token]
434
- * @property {string} [unique_device_id]
435
- */
436
- /**
437
- * @typedef PushtokenRes
438
- * @property {string} [_id]
439
- * @property {string} [application_id]
440
- * @property {string} [bundle_identifier]
441
- * @property {string} [created_at]
442
- * @property {string} [expired_at]
443
- * @property {string} [platform]
444
- * @property {string} [push_token]
445
- * @property {string} [type]
446
- * @property {string} [unique_device_id]
447
- * @property {string} [updated_at]
448
- * @property {string} [user_id]
449
- */
450
498
  /**
451
499
  * @typedef RecipientHeaders
452
500
  * @property {string} [email]
@@ -468,7 +516,6 @@ export = CommunicationPlatformModel;
468
516
  * @typedef SendOtpCommsReqEmail
469
517
  * @property {number} [expiry]
470
518
  * @property {number} [otp_length]
471
- * @property {SendOtpEmailCommsProvider} [provider]
472
519
  * @property {SendOtpEmailCommsTemplate} [template]
473
520
  */
474
521
  /**
@@ -500,11 +547,6 @@ export = CommunicationPlatformModel;
500
547
  * @property {number} [resend_timer]
501
548
  * @property {boolean} [success]
502
549
  */
503
- /**
504
- * @typedef SendOtpEmailCommsProvider
505
- * @property {string} [_id]
506
- * @property {string} [slug]
507
- */
508
550
  /**
509
551
  * @typedef SendOtpEmailCommsTemplate
510
552
  * @property {string} [key]
@@ -539,13 +581,25 @@ export = CommunicationPlatformModel;
539
581
  */
540
582
  /**
541
583
  * @typedef SmsProviderReq
584
+ * @property {string} [api_key] - The api_key for the test.
585
+ * @property {string} [apikey] - The apikey for the test.
542
586
  * @property {string} [authkey]
543
587
  * @property {string} [description]
588
+ * @property {string} [entity_id] - The entity ID for the test.
589
+ * @property {string} [entityid] - The entity ID for the test.
590
+ * @property {string} [feedid] - The feed ID for the test.
591
+ * @property {string} [host] - The host for the test.
544
592
  * @property {string} [name]
593
+ * @property {boolean} [override_dnd] - Whether to override Do Not Disturb.
594
+ * @property {string} [password] - The password for the test.
595
+ * @property {number} [port] - The port for the test.
545
596
  * @property {string} [provider]
546
597
  * @property {string} [sender]
598
+ * @property {string} [sender_id] - The sender ID for the test.
599
+ * @property {string} [senderid] - The sender ID for the test.
547
600
  * @property {string} [type]
548
601
  * @property {string} [username]
602
+ * @property {number} [version_id] - The version ID for the test.
549
603
  */
550
604
  /**
551
605
  * @typedef SmsProviders
@@ -556,28 +610,23 @@ export = CommunicationPlatformModel;
556
610
  * @typedef SmsTemplate
557
611
  * @property {number} [__v]
558
612
  * @property {string} [_id]
613
+ * @property {string} [application]
614
+ * @property {string} [category]
559
615
  * @property {string} [created_at]
560
616
  * @property {string} [description]
561
617
  * @property {boolean} [is_internal]
562
618
  * @property {boolean} [is_system]
563
619
  * @property {SmsTemplateMessage} [message]
620
+ * @property {metaObj} [meta]
564
621
  * @property {string} [name]
565
622
  * @property {string} [priority]
566
623
  * @property {boolean} [published]
567
624
  * @property {string} [slug]
568
- * @property {Object[]} [tags]
625
+ * @property {string[]} [tags]
626
+ * @property {string} [template_id]
569
627
  * @property {Object} [template_variables]
570
628
  * @property {string} [updated_at]
571
- */
572
- /**
573
- * @typedef SmsTemplateDeleteFailureRes
574
- * @property {string} [message]
575
- * @property {boolean} [success]
576
- */
577
- /**
578
- * @typedef SmsTemplateDeleteSuccessRes
579
- * @property {string} [message]
580
- * @property {boolean} [success]
629
+ * @property {EnabledObj} [url_shorten]
581
630
  */
582
631
  /**
583
632
  * @typedef SmsTemplateMessage
@@ -586,29 +635,14 @@ export = CommunicationPlatformModel;
586
635
  */
587
636
  /**
588
637
  * @typedef SmsTemplateReq
589
- * @property {Object[]} [attachments]
590
- * @property {string} [description]
591
- * @property {SmsTemplateMessage} [message]
592
- * @property {string} [name]
593
- * @property {string} [priority]
594
- * @property {Object} [template_variables]
595
- */
596
- /**
597
- * @typedef SmsTemplateRes
598
- * @property {number} [__v]
599
- * @property {string} [_id]
600
- * @property {string} [created_at]
601
638
  * @property {string} [description]
602
- * @property {boolean} [is_internal]
603
- * @property {boolean} [is_system]
604
639
  * @property {SmsTemplateMessage} [message]
605
- * @property {string} [name]
640
+ * @property {metaObj} [meta]
641
+ * @property {string} name
606
642
  * @property {string} [priority]
607
643
  * @property {boolean} [published]
608
- * @property {string} [slug]
609
- * @property {Object[]} [tags]
644
+ * @property {string} [template_id]
610
645
  * @property {Object} [template_variables]
611
- * @property {string} [updated_at]
612
646
  */
613
647
  /**
614
648
  * @typedef SmsTemplates
@@ -646,11 +680,11 @@ export = CommunicationPlatformModel;
646
680
  * @typedef SystemEmailTemplate
647
681
  * @property {number} [__v]
648
682
  * @property {string} [_id]
649
- * @property {Object[]} [attachments]
683
+ * @property {number[]} [attachments]
684
+ * @property {string} [category]
650
685
  * @property {string} [created_at]
651
686
  * @property {string} [description]
652
- * @property {string} [from_name]
653
- * @property {Object[]} [headers]
687
+ * @property {EmailTemplateHeaders[]} [headers]
654
688
  * @property {TemplateAndType} [html]
655
689
  * @property {boolean} [is_internal]
656
690
  * @property {boolean} [is_system]
@@ -658,18 +692,19 @@ export = CommunicationPlatformModel;
658
692
  * @property {string} [priority]
659
693
  * @property {boolean} [published]
660
694
  * @property {string} [slug]
661
- * @property {Object[]} [static_bcc]
662
- * @property {Object[]} [static_cc]
663
- * @property {Object[]} [static_to]
695
+ * @property {string[]} [static_bcc]
696
+ * @property {string[]} [static_cc]
697
+ * @property {string[]} [static_to]
664
698
  * @property {TemplateAndType} [subject]
665
- * @property {Object[]} [tags]
699
+ * @property {string[]} [tags]
700
+ * @property {Object} [template_variables]
666
701
  * @property {TemplateAndType} [text]
667
702
  * @property {string} [updated_at]
703
+ * @property {EnabledObj} [url_shorten]
668
704
  */
669
705
  /**
670
706
  * @typedef SystemEmailTemplates
671
707
  * @property {SystemEmailTemplate[]} [items]
672
- * @property {Page} [page]
673
708
  */
674
709
  /**
675
710
  * @typedef SystemNotification
@@ -686,29 +721,16 @@ export = CommunicationPlatformModel;
686
721
  * @property {number} [last_read_anchor]
687
722
  * @property {Page} [page]
688
723
  */
689
- /**
690
- * @typedef SystemNotificationSettings
691
- * @property {string} [priority]
692
- * @property {boolean} [sound]
693
- * @property {string} [time_to_live]
694
- */
695
- /**
696
- * @typedef SystemNotificationsPage
697
- * @property {number} [current]
698
- * @property {boolean} [has_next]
699
- * @property {number} [item_total]
700
- * @property {number} [size]
701
- * @property {string} [type]
702
- */
703
724
  /**
704
725
  * @typedef SystemNotificationUser
705
726
  * @property {string} [type]
706
727
  * @property {string} [value]
707
728
  */
708
729
  /**
709
- * @typedef SystemSmsTemplate
730
+ * @typedef SystemSmsTemplates
710
731
  * @property {number} [__v]
711
732
  * @property {string} [_id]
733
+ * @property {string} [category]
712
734
  * @property {string} [created_at]
713
735
  * @property {string} [description]
714
736
  * @property {boolean} [is_internal]
@@ -718,14 +740,11 @@ export = CommunicationPlatformModel;
718
740
  * @property {string} [priority]
719
741
  * @property {boolean} [published]
720
742
  * @property {string} [slug]
721
- * @property {Object[]} [tags]
743
+ * @property {string[]} [tags]
744
+ * @property {string} [template_id]
722
745
  * @property {Object} [template_variables]
723
746
  * @property {string} [updated_at]
724
- */
725
- /**
726
- * @typedef SystemSmsTemplates
727
- * @property {SystemSmsTemplate[]} [items]
728
- * @property {Page} [page]
747
+ * @property {EnabledObj} [url_shorten]
729
748
  */
730
749
  /**
731
750
  * @typedef TemplateAndType
@@ -760,8 +779,45 @@ export = CommunicationPlatformModel;
760
779
  declare class CommunicationPlatformModel {
761
780
  }
762
781
  declare namespace CommunicationPlatformModel {
763
- export { Audience, AudienceReq, Audiences, BadRequestSchema, BigqueryHeadersReq, BigqueryHeadersRes, BigqueryHeadersResHeaders, Campaign, CampaignEmail, CampaignEmailTemplate, CampaignReq, Campaigns, CampignEmailProvider, EmailProvider, EmailProviderReq, EmailProviderReqFrom, EmailProviders, EmailTemplate, EmailTemplateDeleteFailureRes, EmailTemplateDeleteSuccessRes, EmailTemplateHeaders, EmailTemplateKeys, EmailTemplateReq, EmailTemplateRes, EmailTemplates, EngineRequest, EngineResponse, EventSubscription, EventSubscriptions, EventSubscriptionTemplate, EventSubscriptionTemplateEmail, EventSubscriptionTemplateSms, GetNRecordsCsvReq, GetNRecordsCsvRes, GetNRecordsCsvResItems, GetStats, Job, JobLog, JobLogs, Jobs, Log, LogEmail, LogMeta, LogPushnotification, Logs, MetaStructure, NotFound, Notification, Page, PayloadEmailProviderStructure, PayloadEmailStructure, PayloadEmailTemplateStructure, PayloadSmsProviderStructure, PayloadSmsStructure, PayloadSmsTemplateStructure, PayloadStructure, PushtokenReq, PushtokenRes, RecipientHeaders, SendOtpCommsReq, SendOtpCommsReqData, SendOtpCommsReqEmail, SendOtpCommsReqSms, SendOtpCommsRes, SendOtpCommsResEmail, SendOtpCommsResSms, SendOtpEmailCommsProvider, SendOtpEmailCommsTemplate, SendOtpSmsCommsProvider, SendOtpSmsCommsTemplate, SmsProvider, SmsProviderReq, SmsProviders, SmsTemplate, SmsTemplateDeleteFailureRes, SmsTemplateDeleteSuccessRes, SmsTemplateMessage, SmsTemplateReq, SmsTemplateRes, SmsTemplates, Stats, StatsImported, StatsProcessed, StatsProcessedEmail, StatsProcessedSms, SystemEmailTemplate, SystemEmailTemplates, SystemNotification, SystemNotifications, SystemNotificationSettings, SystemNotificationsPage, SystemNotificationUser, SystemSmsTemplate, SystemSmsTemplates, TemplateAndType, TriggerJobRequest, TriggerJobResponse, VerifyOtpCommsErrorRes, VerifyOtpCommsReq, VerifyOtpCommsSuccessRes };
782
+ export { AppProvider, AppProviderReq, AppProviderRes, AppProviderResObj, AppProviderResVoice, Audience, AudienceReq, Audiences, BadRequestSchema, Campaign, CampaignEmail, CampaignEmailTemplate, CampaignReq, Campaigns, CampignEmailProvider, DefaultSmsProviders, DummyDatasources, DummyDatasourcesMeta, DummyDatasourcesMetaObj, EmailProvider, EmailProviderReq, EmailProviderReqFrom, EmailProviders, EmailTemplate, EmailTemplateHeaders, EmailTemplateKeys, EmailTemplateReq, EmailTemplates, EnabledObj, EngineRequest, EngineResponse, EventSubscription, EventSubscriptions, 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, Page, PayloadEmailProviderStructure, PayloadEmailStructure, PayloadEmailTemplateStructure, PayloadSmsProviderStructure, PayloadSmsStructure, PayloadSmsTemplateStructure, PayloadStructure, RecipientHeaders, SendOtpCommsReq, SendOtpCommsReqData, SendOtpCommsReqEmail, SendOtpCommsReqSms, SendOtpCommsRes, SendOtpCommsResEmail, SendOtpCommsResSms, SendOtpEmailCommsTemplate, SendOtpSmsCommsProvider, SendOtpSmsCommsTemplate, SmsProvider, SmsProviderReq, SmsProviders, SmsTemplate, SmsTemplateMessage, SmsTemplateReq, SmsTemplates, Stats, StatsImported, StatsProcessed, StatsProcessedEmail, StatsProcessedSms, SystemEmailTemplate, SystemEmailTemplates, SystemNotification, SystemNotifications, SystemNotificationUser, SystemSmsTemplates, TemplateAndType, TriggerJobRequest, TriggerJobResponse, VerifyOtpCommsErrorRes, VerifyOtpCommsReq, VerifyOtpCommsSuccessRes };
764
783
  }
784
+ /** @returns {AppProvider} */
785
+ declare function AppProvider(): AppProvider;
786
+ type AppProvider = {
787
+ __v?: number;
788
+ _id?: string;
789
+ application?: string;
790
+ created_at?: string;
791
+ email?: AppProviderRes;
792
+ sms?: AppProviderRes;
793
+ updated_at?: string;
794
+ voice?: AppProviderResVoice;
795
+ };
796
+ /** @returns {AppProviderReq} */
797
+ declare function AppProviderReq(): AppProviderReq;
798
+ type AppProviderReq = {
799
+ email?: AppProviderRes;
800
+ sms?: AppProviderRes;
801
+ voice?: AppProviderResVoice;
802
+ };
803
+ /** @returns {AppProviderRes} */
804
+ declare function AppProviderRes(): AppProviderRes;
805
+ type AppProviderRes = {
806
+ otp?: AppProviderResObj;
807
+ promotional?: AppProviderResObj;
808
+ transaction?: AppProviderResObj;
809
+ };
810
+ /** @returns {AppProviderResObj} */
811
+ declare function AppProviderResObj(): AppProviderResObj;
812
+ type AppProviderResObj = {
813
+ provider?: string;
814
+ };
815
+ /** @returns {AppProviderResVoice} */
816
+ declare function AppProviderResVoice(): AppProviderResVoice;
817
+ type AppProviderResVoice = {
818
+ otp?: AppProviderResObj;
819
+ transaction?: AppProviderResObj;
820
+ };
765
821
  /** @returns {Audience} */
766
822
  declare function Audience(): Audience;
767
823
  type Audience = {
@@ -783,11 +839,9 @@ type Audience = {
783
839
  /** @returns {AudienceReq} */
784
840
  declare function AudienceReq(): AudienceReq;
785
841
  type AudienceReq = {
786
- application?: string;
787
842
  description?: string;
788
843
  file_url?: string;
789
844
  headers?: string[];
790
- is_active?: boolean;
791
845
  name?: string;
792
846
  records_count?: number;
793
847
  tags?: string[];
@@ -811,23 +865,6 @@ type BadRequestSchema = {
811
865
  */
812
866
  status?: string;
813
867
  };
814
- /** @returns {BigqueryHeadersReq} */
815
- declare function BigqueryHeadersReq(): BigqueryHeadersReq;
816
- type BigqueryHeadersReq = {
817
- query?: string;
818
- type?: string;
819
- };
820
- /** @returns {BigqueryHeadersRes} */
821
- declare function BigqueryHeadersRes(): BigqueryHeadersRes;
822
- type BigqueryHeadersRes = {
823
- headers?: BigqueryHeadersResHeaders[];
824
- };
825
- /** @returns {BigqueryHeadersResHeaders} */
826
- declare function BigqueryHeadersResHeaders(): BigqueryHeadersResHeaders;
827
- type BigqueryHeadersResHeaders = {
828
- name?: string;
829
- type?: string;
830
- };
831
868
  /** @returns {Campaign} */
832
869
  declare function Campaign(): Campaign;
833
870
  type Campaign = {
@@ -884,6 +921,30 @@ type CampignEmailProvider = {
884
921
  from_email?: string;
885
922
  from_name?: string;
886
923
  };
924
+ /** @returns {DefaultSmsProviders} */
925
+ declare function DefaultSmsProviders(): DefaultSmsProviders;
926
+ type DefaultSmsProviders = {
927
+ _id?: string;
928
+ is_default?: boolean;
929
+ name?: string;
930
+ };
931
+ /** @returns {DummyDatasources} */
932
+ declare function DummyDatasources(): DummyDatasources;
933
+ type DummyDatasources = {
934
+ id?: number;
935
+ name?: string;
936
+ };
937
+ /** @returns {DummyDatasourcesMeta} */
938
+ declare function DummyDatasourcesMeta(): DummyDatasourcesMeta;
939
+ type DummyDatasourcesMeta = {
940
+ data?: DummyDatasourcesMetaObj;
941
+ id?: number;
942
+ };
943
+ /** @returns {DummyDatasourcesMetaObj} */
944
+ declare function DummyDatasourcesMetaObj(): DummyDatasourcesMetaObj;
945
+ type DummyDatasourcesMetaObj = {
946
+ b?: number;
947
+ };
887
948
  /** @returns {EmailProvider} */
888
949
  declare function EmailProvider(): EmailProvider;
889
950
  type EmailProvider = {
@@ -928,37 +989,32 @@ declare function EmailTemplate(): EmailTemplate;
928
989
  type EmailTemplate = {
929
990
  __v?: number;
930
991
  _id?: string;
931
- attachments?: any[];
992
+ application?: string;
993
+ attachments?: number[];
994
+ category?: string;
932
995
  created_at?: string;
933
996
  description?: string;
997
+ editor_meta?: string;
998
+ editor_type?: string;
934
999
  from_name?: string;
935
- headers?: any[];
1000
+ headers?: EmailTemplateHeaders[];
936
1001
  html?: TemplateAndType;
937
1002
  is_internal?: boolean;
938
1003
  is_system?: boolean;
939
1004
  name?: string;
940
1005
  priority?: string;
941
1006
  published?: boolean;
1007
+ reply_to?: string;
942
1008
  slug?: string;
943
- static_bcc?: any[];
944
- static_cc?: any[];
945
- static_to?: any[];
1009
+ static_bcc?: string[];
1010
+ static_cc?: string[];
1011
+ static_to?: string[];
946
1012
  subject?: TemplateAndType;
947
- tags?: any[];
1013
+ tags?: string[];
1014
+ template_variables?: any;
948
1015
  text?: TemplateAndType;
949
1016
  updated_at?: string;
950
- };
951
- /** @returns {EmailTemplateDeleteFailureRes} */
952
- declare function EmailTemplateDeleteFailureRes(): EmailTemplateDeleteFailureRes;
953
- type EmailTemplateDeleteFailureRes = {
954
- message?: string;
955
- success?: boolean;
956
- };
957
- /** @returns {EmailTemplateDeleteSuccessRes} */
958
- declare function EmailTemplateDeleteSuccessRes(): EmailTemplateDeleteSuccessRes;
959
- type EmailTemplateDeleteSuccessRes = {
960
- message?: string;
961
- success?: boolean;
1017
+ url_shorten?: EnabledObj;
962
1018
  };
963
1019
  /** @returns {EmailTemplateHeaders} */
964
1020
  declare function EmailTemplateHeaders(): EmailTemplateHeaders;
@@ -976,45 +1032,25 @@ type EmailTemplateKeys = {
976
1032
  /** @returns {EmailTemplateReq} */
977
1033
  declare function EmailTemplateReq(): EmailTemplateReq;
978
1034
  type EmailTemplateReq = {
979
- attachments?: any[];
980
- description?: string;
981
- headers?: EmailTemplateHeaders[];
982
- html?: TemplateAndType;
983
- keys?: EmailTemplateKeys;
984
- name?: string;
985
- priority?: string;
986
- reply_to?: string;
987
- static_bcc?: string[];
988
- static_cc?: string[];
989
- static_to?: string[];
990
- subject?: TemplateAndType;
991
- text?: TemplateAndType;
992
- };
993
- /** @returns {EmailTemplateRes} */
994
- declare function EmailTemplateRes(): EmailTemplateRes;
995
- type EmailTemplateRes = {
996
- __v?: number;
997
- _id?: string;
998
- attachments?: any[];
999
- created_at?: string;
1035
+ attachments?: number[];
1000
1036
  description?: string;
1037
+ editor_meta?: string;
1038
+ editor_type?: string;
1039
+ from_name?: string;
1001
1040
  headers?: EmailTemplateHeaders[];
1002
1041
  html?: TemplateAndType;
1003
- is_internal?: boolean;
1004
- is_system?: boolean;
1005
1042
  keys?: EmailTemplateKeys;
1006
- name?: string;
1043
+ name: string;
1007
1044
  priority?: string;
1008
1045
  published?: boolean;
1009
1046
  reply_to?: string;
1010
- slug?: string;
1011
1047
  static_bcc?: string[];
1012
1048
  static_cc?: string[];
1013
1049
  static_to?: string[];
1014
1050
  subject?: TemplateAndType;
1015
- tags?: any[];
1051
+ tags?: string[];
1052
+ template_variables?: any;
1016
1053
  text?: TemplateAndType;
1017
- updated_at?: string;
1018
1054
  };
1019
1055
  /** @returns {EmailTemplates} */
1020
1056
  declare function EmailTemplates(): EmailTemplates;
@@ -1022,6 +1058,11 @@ type EmailTemplates = {
1022
1058
  items?: EmailTemplate[];
1023
1059
  page?: Page;
1024
1060
  };
1061
+ /** @returns {EnabledObj} */
1062
+ declare function EnabledObj(): EnabledObj;
1063
+ type EnabledObj = {
1064
+ enabled?: boolean;
1065
+ };
1025
1066
  /** @returns {EngineRequest} */
1026
1067
  declare function EngineRequest(): EngineRequest;
1027
1068
  type EngineRequest = {
@@ -1070,6 +1111,20 @@ type EventSubscriptionTemplateSms = {
1070
1111
  subscribed?: boolean;
1071
1112
  template?: string;
1072
1113
  };
1114
+ /** @returns {GenericDelete} */
1115
+ declare function GenericDelete(): GenericDelete;
1116
+ type GenericDelete = {
1117
+ acknowledged?: boolean;
1118
+ affected?: number;
1119
+ message?: string;
1120
+ operation?: string;
1121
+ };
1122
+ /** @returns {GenericError} */
1123
+ declare function GenericError(): GenericError;
1124
+ type GenericError = {
1125
+ message?: Message;
1126
+ sentry?: string;
1127
+ };
1073
1128
  /** @returns {GetNRecordsCsvReq} */
1074
1129
  declare function GetNRecordsCsvReq(): GetNRecordsCsvReq;
1075
1130
  type GetNRecordsCsvReq = {
@@ -1096,6 +1151,39 @@ declare function GetStats(): GetStats;
1096
1151
  type GetStats = {
1097
1152
  items?: Stats[];
1098
1153
  };
1154
+ /** @returns {GlobalProviders} */
1155
+ declare function GlobalProviders(): GlobalProviders;
1156
+ type GlobalProviders = {
1157
+ email?: GlobalProvidersResObj[];
1158
+ sms?: GlobalProvidersResObj[];
1159
+ voice?: GlobalProvidersResObj[];
1160
+ };
1161
+ /** @returns {GlobalProvidersResObj} */
1162
+ declare function GlobalProvidersResObj(): GlobalProvidersResObj;
1163
+ type GlobalProvidersResObj = {
1164
+ _id?: string;
1165
+ name?: string;
1166
+ };
1167
+ /** @returns {GlobalVariablesGetResponse} */
1168
+ declare function GlobalVariablesGetResponse(): GlobalVariablesGetResponse;
1169
+ type GlobalVariablesGetResponse = {
1170
+ editable?: any;
1171
+ read_only?: any;
1172
+ };
1173
+ /** @returns {GlobalVariablesPostResponse} */
1174
+ declare function GlobalVariablesPostResponse(): GlobalVariablesPostResponse;
1175
+ type GlobalVariablesPostResponse = {
1176
+ _id?: string;
1177
+ application?: string;
1178
+ category?: string;
1179
+ created_at?: string;
1180
+ global_variables?: any;
1181
+ };
1182
+ /** @returns {GlobalVariablesReq} */
1183
+ declare function GlobalVariablesReq(): GlobalVariablesReq;
1184
+ type GlobalVariablesReq = {
1185
+ global_variables?: any;
1186
+ };
1099
1187
  /** @returns {Job} */
1100
1188
  declare function Job(): Job;
1101
1189
  type Job = {
@@ -1137,7 +1225,6 @@ declare function Log(): Log;
1137
1225
  type Log = {
1138
1226
  _id?: string;
1139
1227
  application?: string;
1140
- channel_type?: string;
1141
1228
  created_at?: string;
1142
1229
  data?: any;
1143
1230
  email?: LogEmail;
@@ -1145,7 +1232,6 @@ type Log = {
1145
1232
  meta?: LogMeta;
1146
1233
  pushnotification?: LogPushnotification;
1147
1234
  service?: string;
1148
- source?: string;
1149
1235
  status?: string;
1150
1236
  step?: string;
1151
1237
  };
@@ -1175,6 +1261,21 @@ type Logs = {
1175
1261
  items?: Log[];
1176
1262
  page?: Page;
1177
1263
  };
1264
+ /** @returns {Message} */
1265
+ declare function Message(): Message;
1266
+ type Message = {
1267
+ info?: string;
1268
+ message?: string;
1269
+ operation?: string;
1270
+ success?: boolean;
1271
+ };
1272
+ /** @returns {metaObj} */
1273
+ declare function metaObj(): metaObj;
1274
+ type metaObj = {
1275
+ is_system?: boolean;
1276
+ template?: string;
1277
+ type?: string;
1278
+ };
1178
1279
  /** @returns {MetaStructure} */
1179
1280
  declare function MetaStructure(): MetaStructure;
1180
1281
  type MetaStructure = {
@@ -1254,29 +1355,6 @@ type PayloadStructure = {
1254
1355
  email?: PayloadEmailStructure;
1255
1356
  sms?: PayloadSmsStructure;
1256
1357
  };
1257
- /** @returns {PushtokenReq} */
1258
- declare function PushtokenReq(): PushtokenReq;
1259
- type PushtokenReq = {
1260
- action?: string;
1261
- bundle_identifier?: string;
1262
- push_token?: string;
1263
- unique_device_id?: string;
1264
- };
1265
- /** @returns {PushtokenRes} */
1266
- declare function PushtokenRes(): PushtokenRes;
1267
- type PushtokenRes = {
1268
- _id?: string;
1269
- application_id?: string;
1270
- bundle_identifier?: string;
1271
- created_at?: string;
1272
- expired_at?: string;
1273
- platform?: string;
1274
- push_token?: string;
1275
- type?: string;
1276
- unique_device_id?: string;
1277
- updated_at?: string;
1278
- user_id?: string;
1279
- };
1280
1358
  /** @returns {RecipientHeaders} */
1281
1359
  declare function RecipientHeaders(): RecipientHeaders;
1282
1360
  type RecipientHeaders = {
@@ -1302,7 +1380,6 @@ declare function SendOtpCommsReqEmail(): SendOtpCommsReqEmail;
1302
1380
  type SendOtpCommsReqEmail = {
1303
1381
  expiry?: number;
1304
1382
  otp_length?: number;
1305
- provider?: SendOtpEmailCommsProvider;
1306
1383
  template?: SendOtpEmailCommsTemplate;
1307
1384
  };
1308
1385
  /** @returns {SendOtpCommsReqSms} */
@@ -1338,12 +1415,6 @@ type SendOtpCommsResSms = {
1338
1415
  resend_timer?: number;
1339
1416
  success?: boolean;
1340
1417
  };
1341
- /** @returns {SendOtpEmailCommsProvider} */
1342
- declare function SendOtpEmailCommsProvider(): SendOtpEmailCommsProvider;
1343
- type SendOtpEmailCommsProvider = {
1344
- _id?: string;
1345
- slug?: string;
1346
- };
1347
1418
  /** @returns {SendOtpEmailCommsTemplate} */
1348
1419
  declare function SendOtpEmailCommsTemplate(): SendOtpEmailCommsTemplate;
1349
1420
  type SendOtpEmailCommsTemplate = {
@@ -1383,13 +1454,61 @@ type SmsProvider = {
1383
1454
  /** @returns {SmsProviderReq} */
1384
1455
  declare function SmsProviderReq(): SmsProviderReq;
1385
1456
  type SmsProviderReq = {
1457
+ /**
1458
+ * - The api_key for the test.
1459
+ */
1460
+ api_key?: string;
1461
+ /**
1462
+ * - The apikey for the test.
1463
+ */
1464
+ apikey?: string;
1386
1465
  authkey?: string;
1387
1466
  description?: string;
1467
+ /**
1468
+ * - The entity ID for the test.
1469
+ */
1470
+ entity_id?: string;
1471
+ /**
1472
+ * - The entity ID for the test.
1473
+ */
1474
+ entityid?: string;
1475
+ /**
1476
+ * - The feed ID for the test.
1477
+ */
1478
+ feedid?: string;
1479
+ /**
1480
+ * - The host for the test.
1481
+ */
1482
+ host?: string;
1388
1483
  name?: string;
1484
+ /**
1485
+ * - Whether to override Do Not Disturb.
1486
+ */
1487
+ override_dnd?: boolean;
1488
+ /**
1489
+ * - The password for the test.
1490
+ */
1491
+ password?: string;
1492
+ /**
1493
+ * - The port for the test.
1494
+ */
1495
+ port?: number;
1389
1496
  provider?: string;
1390
1497
  sender?: string;
1498
+ /**
1499
+ * - The sender ID for the test.
1500
+ */
1501
+ sender_id?: string;
1502
+ /**
1503
+ * - The sender ID for the test.
1504
+ */
1505
+ senderid?: string;
1391
1506
  type?: string;
1392
1507
  username?: string;
1508
+ /**
1509
+ * - The version ID for the test.
1510
+ */
1511
+ version_id?: number;
1393
1512
  };
1394
1513
  /** @returns {SmsProviders} */
1395
1514
  declare function SmsProviders(): SmsProviders;
@@ -1402,30 +1521,23 @@ declare function SmsTemplate(): SmsTemplate;
1402
1521
  type SmsTemplate = {
1403
1522
  __v?: number;
1404
1523
  _id?: string;
1524
+ application?: string;
1525
+ category?: string;
1405
1526
  created_at?: string;
1406
1527
  description?: string;
1407
1528
  is_internal?: boolean;
1408
1529
  is_system?: boolean;
1409
1530
  message?: SmsTemplateMessage;
1531
+ meta?: metaObj;
1410
1532
  name?: string;
1411
1533
  priority?: string;
1412
1534
  published?: boolean;
1413
1535
  slug?: string;
1414
- tags?: any[];
1536
+ tags?: string[];
1537
+ template_id?: string;
1415
1538
  template_variables?: any;
1416
1539
  updated_at?: string;
1417
- };
1418
- /** @returns {SmsTemplateDeleteFailureRes} */
1419
- declare function SmsTemplateDeleteFailureRes(): SmsTemplateDeleteFailureRes;
1420
- type SmsTemplateDeleteFailureRes = {
1421
- message?: string;
1422
- success?: boolean;
1423
- };
1424
- /** @returns {SmsTemplateDeleteSuccessRes} */
1425
- declare function SmsTemplateDeleteSuccessRes(): SmsTemplateDeleteSuccessRes;
1426
- type SmsTemplateDeleteSuccessRes = {
1427
- message?: string;
1428
- success?: boolean;
1540
+ url_shorten?: EnabledObj;
1429
1541
  };
1430
1542
  /** @returns {SmsTemplateMessage} */
1431
1543
  declare function SmsTemplateMessage(): SmsTemplateMessage;
@@ -1436,30 +1548,14 @@ type SmsTemplateMessage = {
1436
1548
  /** @returns {SmsTemplateReq} */
1437
1549
  declare function SmsTemplateReq(): SmsTemplateReq;
1438
1550
  type SmsTemplateReq = {
1439
- attachments?: any[];
1440
1551
  description?: string;
1441
1552
  message?: SmsTemplateMessage;
1442
- name?: string;
1443
- priority?: string;
1444
- template_variables?: any;
1445
- };
1446
- /** @returns {SmsTemplateRes} */
1447
- declare function SmsTemplateRes(): SmsTemplateRes;
1448
- type SmsTemplateRes = {
1449
- __v?: number;
1450
- _id?: string;
1451
- created_at?: string;
1452
- description?: string;
1453
- is_internal?: boolean;
1454
- is_system?: boolean;
1455
- message?: SmsTemplateMessage;
1456
- name?: string;
1553
+ meta?: metaObj;
1554
+ name: string;
1457
1555
  priority?: string;
1458
1556
  published?: boolean;
1459
- slug?: string;
1460
- tags?: any[];
1557
+ template_id?: string;
1461
1558
  template_variables?: any;
1462
- updated_at?: string;
1463
1559
  };
1464
1560
  /** @returns {SmsTemplates} */
1465
1561
  declare function SmsTemplates(): SmsTemplates;
@@ -1504,11 +1600,11 @@ declare function SystemEmailTemplate(): SystemEmailTemplate;
1504
1600
  type SystemEmailTemplate = {
1505
1601
  __v?: number;
1506
1602
  _id?: string;
1507
- attachments?: any[];
1603
+ attachments?: number[];
1604
+ category?: string;
1508
1605
  created_at?: string;
1509
1606
  description?: string;
1510
- from_name?: string;
1511
- headers?: any[];
1607
+ headers?: EmailTemplateHeaders[];
1512
1608
  html?: TemplateAndType;
1513
1609
  is_internal?: boolean;
1514
1610
  is_system?: boolean;
@@ -1516,19 +1612,20 @@ type SystemEmailTemplate = {
1516
1612
  priority?: string;
1517
1613
  published?: boolean;
1518
1614
  slug?: string;
1519
- static_bcc?: any[];
1520
- static_cc?: any[];
1521
- static_to?: any[];
1615
+ static_bcc?: string[];
1616
+ static_cc?: string[];
1617
+ static_to?: string[];
1522
1618
  subject?: TemplateAndType;
1523
- tags?: any[];
1619
+ tags?: string[];
1620
+ template_variables?: any;
1524
1621
  text?: TemplateAndType;
1525
1622
  updated_at?: string;
1623
+ url_shorten?: EnabledObj;
1526
1624
  };
1527
1625
  /** @returns {SystemEmailTemplates} */
1528
1626
  declare function SystemEmailTemplates(): SystemEmailTemplates;
1529
1627
  type SystemEmailTemplates = {
1530
1628
  items?: SystemEmailTemplate[];
1531
- page?: Page;
1532
1629
  };
1533
1630
  /** @returns {SystemNotification} */
1534
1631
  declare function SystemNotification(): SystemNotification;
@@ -1547,33 +1644,18 @@ type SystemNotifications = {
1547
1644
  last_read_anchor?: number;
1548
1645
  page?: Page;
1549
1646
  };
1550
- /** @returns {SystemNotificationSettings} */
1551
- declare function SystemNotificationSettings(): SystemNotificationSettings;
1552
- type SystemNotificationSettings = {
1553
- priority?: string;
1554
- sound?: boolean;
1555
- time_to_live?: string;
1556
- };
1557
- /** @returns {SystemNotificationsPage} */
1558
- declare function SystemNotificationsPage(): SystemNotificationsPage;
1559
- type SystemNotificationsPage = {
1560
- current?: number;
1561
- has_next?: boolean;
1562
- item_total?: number;
1563
- size?: number;
1564
- type?: string;
1565
- };
1566
1647
  /** @returns {SystemNotificationUser} */
1567
1648
  declare function SystemNotificationUser(): SystemNotificationUser;
1568
1649
  type SystemNotificationUser = {
1569
1650
  type?: string;
1570
1651
  value?: string;
1571
1652
  };
1572
- /** @returns {SystemSmsTemplate} */
1573
- declare function SystemSmsTemplate(): SystemSmsTemplate;
1574
- type SystemSmsTemplate = {
1653
+ /** @returns {SystemSmsTemplates} */
1654
+ declare function SystemSmsTemplates(): SystemSmsTemplates;
1655
+ type SystemSmsTemplates = {
1575
1656
  __v?: number;
1576
1657
  _id?: string;
1658
+ category?: string;
1577
1659
  created_at?: string;
1578
1660
  description?: string;
1579
1661
  is_internal?: boolean;
@@ -1583,15 +1665,11 @@ type SystemSmsTemplate = {
1583
1665
  priority?: string;
1584
1666
  published?: boolean;
1585
1667
  slug?: string;
1586
- tags?: any[];
1668
+ tags?: string[];
1669
+ template_id?: string;
1587
1670
  template_variables?: any;
1588
1671
  updated_at?: string;
1589
- };
1590
- /** @returns {SystemSmsTemplates} */
1591
- declare function SystemSmsTemplates(): SystemSmsTemplates;
1592
- type SystemSmsTemplates = {
1593
- items?: SystemSmsTemplate[];
1594
- page?: Page;
1672
+ url_shorten?: EnabledObj;
1595
1673
  };
1596
1674
  /** @returns {TemplateAndType} */
1597
1675
  declare function TemplateAndType(): TemplateAndType;