@gofynd/fdk-client-javascript 1.1.6 → 1.2.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 (321) hide show
  1. package/README.md +12 -0
  2. package/index.js +0 -3
  3. package/package.json +1 -1
  4. package/sdk/application/ApplicationAPIClient.d.ts +15 -1
  5. package/sdk/application/ApplicationAPIClient.js +8 -1
  6. package/sdk/application/ApplicationClient.d.ts +37 -6
  7. package/sdk/application/ApplicationClient.js +31 -0
  8. package/sdk/application/ApplicationConfig.d.ts +52 -12
  9. package/sdk/application/ApplicationConfig.js +37 -2
  10. package/sdk/application/ApplicationModels.d.ts +46 -1
  11. package/sdk/application/ApplicationModels.js +18 -0
  12. package/sdk/application/Cart/CartApplicationClient.d.ts +172 -357
  13. package/sdk/application/Cart/CartApplicationClient.js +620 -483
  14. package/sdk/application/Cart/CartApplicationModel.d.ts +2054 -96
  15. package/sdk/application/Cart/CartApplicationModel.js +1224 -93
  16. package/sdk/application/Cart/CartApplicationValidator.d.ts +508 -30
  17. package/sdk/application/Cart/CartApplicationValidator.js +270 -15
  18. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +234 -413
  19. package/sdk/application/Catalog/CatalogApplicationClient.js +777 -630
  20. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2218 -117
  21. package/sdk/application/Catalog/CatalogApplicationModel.js +1499 -170
  22. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +798 -31
  23. package/sdk/application/Catalog/CatalogApplicationValidator.js +318 -3
  24. package/sdk/application/Common/CommonApplicationClient.d.ts +14 -21
  25. package/sdk/application/Common/CommonApplicationClient.js +50 -33
  26. package/sdk/application/Common/CommonApplicationModel.d.ts +448 -19
  27. package/sdk/application/Common/CommonApplicationModel.js +224 -16
  28. package/sdk/application/Common/CommonApplicationValidator.d.ts +42 -4
  29. package/sdk/application/Common/CommonApplicationValidator.js +21 -3
  30. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +25 -18
  31. package/sdk/application/Communication/CommunicationApplicationClient.js +74 -47
  32. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +190 -14
  33. package/sdk/application/Communication/CommunicationApplicationModel.js +124 -7
  34. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +27 -4
  35. package/sdk/application/Communication/CommunicationApplicationValidator.js +21 -5
  36. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +113 -112
  37. package/sdk/application/Configuration/ConfigurationApplicationClient.js +381 -260
  38. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +2453 -110
  39. package/sdk/application/Configuration/ConfigurationApplicationModel.js +1254 -108
  40. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +160 -8
  41. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +88 -4
  42. package/sdk/application/Content/ContentApplicationClient.d.ts +120 -138
  43. package/sdk/application/Content/ContentApplicationClient.js +409 -277
  44. package/sdk/application/Content/ContentApplicationModel.d.ts +1627 -105
  45. package/sdk/application/Content/ContentApplicationModel.js +1202 -109
  46. package/sdk/application/Content/ContentApplicationValidator.d.ts +214 -12
  47. package/sdk/application/Content/ContentApplicationValidator.js +113 -3
  48. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +20 -29
  49. package/sdk/application/FileStorage/FileStorageApplicationClient.js +68 -47
  50. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +299 -20
  51. package/sdk/application/FileStorage/FileStorageApplicationModel.js +209 -16
  52. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +55 -5
  53. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +33 -6
  54. package/sdk/application/Lead/LeadApplicationClient.d.ts +50 -53
  55. package/sdk/application/Lead/LeadApplicationClient.js +169 -103
  56. package/sdk/application/Lead/LeadApplicationModel.d.ts +1405 -54
  57. package/sdk/application/Lead/LeadApplicationModel.js +619 -73
  58. package/sdk/application/Lead/LeadApplicationValidator.d.ts +91 -9
  59. package/sdk/application/Lead/LeadApplicationValidator.js +51 -6
  60. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +34 -33
  61. package/sdk/application/Logistic/LogisticApplicationClient.js +110 -73
  62. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +399 -28
  63. package/sdk/application/Logistic/LogisticApplicationModel.js +293 -24
  64. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +48 -6
  65. package/sdk/application/Logistic/LogisticApplicationValidator.js +34 -6
  66. package/sdk/application/Order/OrderApplicationClient.d.ts +81 -133
  67. package/sdk/application/Order/OrderApplicationClient.js +297 -217
  68. package/sdk/application/Order/OrderApplicationModel.d.ts +1101 -66
  69. package/sdk/application/Order/OrderApplicationModel.js +776 -57
  70. package/sdk/application/Order/OrderApplicationValidator.d.ts +249 -14
  71. package/sdk/application/Order/OrderApplicationValidator.js +114 -5
  72. package/sdk/application/Payment/PaymentApplicationClient.d.ts +341 -356
  73. package/sdk/application/Payment/PaymentApplicationClient.js +1077 -703
  74. package/sdk/application/Payment/PaymentApplicationModel.d.ts +3125 -99
  75. package/sdk/application/Payment/PaymentApplicationModel.js +1158 -62
  76. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +494 -41
  77. package/sdk/application/Payment/PaymentApplicationValidator.js +297 -25
  78. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +178 -350
  79. package/sdk/application/PosCart/PosCartApplicationClient.js +636 -491
  80. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1823 -89
  81. package/sdk/application/PosCart/PosCartApplicationModel.js +1117 -85
  82. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +480 -29
  83. package/sdk/application/PosCart/PosCartApplicationValidator.js +262 -15
  84. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +49 -47
  85. package/sdk/application/Rewards/RewardsApplicationClient.js +160 -102
  86. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +343 -22
  87. package/sdk/application/Rewards/RewardsApplicationModel.js +230 -15
  88. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +70 -7
  89. package/sdk/application/Rewards/RewardsApplicationValidator.js +45 -6
  90. package/sdk/application/Share/ShareApplicationClient.d.ts +44 -50
  91. package/sdk/application/Share/ShareApplicationClient.js +165 -97
  92. package/sdk/application/Share/ShareApplicationModel.d.ts +230 -15
  93. package/sdk/application/Share/ShareApplicationModel.js +154 -16
  94. package/sdk/application/Share/ShareApplicationValidator.d.ts +86 -8
  95. package/sdk/application/Share/ShareApplicationValidator.js +48 -4
  96. package/sdk/application/Theme/ThemeApplicationClient.d.ts +25 -27
  97. package/sdk/application/Theme/ThemeApplicationClient.js +83 -54
  98. package/sdk/application/Theme/ThemeApplicationModel.d.ts +621 -48
  99. package/sdk/application/Theme/ThemeApplicationModel.js +464 -40
  100. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +49 -5
  101. package/sdk/application/Theme/ThemeApplicationValidator.js +26 -3
  102. package/sdk/application/User/UserApplicationClient.d.ts +219 -303
  103. package/sdk/application/User/UserApplicationClient.js +819 -522
  104. package/sdk/application/User/UserApplicationModel.d.ts +1390 -101
  105. package/sdk/application/User/UserApplicationModel.js +983 -44
  106. package/sdk/application/User/UserApplicationValidator.d.ts +457 -33
  107. package/sdk/application/User/UserApplicationValidator.js +265 -31
  108. package/sdk/common/AxiosHelper.js +8 -2
  109. package/sdk/common/Paginator.d.ts +27 -12
  110. package/sdk/common/Paginator.js +15 -0
  111. package/sdk/common/RequestSigner.js +0 -1
  112. package/sdk/partner/PartnerAPIClient.d.ts +15 -1
  113. package/sdk/partner/PartnerAPIClient.js +8 -1
  114. package/sdk/partner/PartnerClient.d.ts +20 -3
  115. package/sdk/partner/PartnerClient.js +17 -0
  116. package/sdk/partner/PartnerConfig.d.ts +40 -14
  117. package/sdk/partner/PartnerConfig.js +31 -6
  118. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +26 -25
  119. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +82 -53
  120. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +202 -17
  121. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +139 -10
  122. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +42 -5
  123. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +26 -4
  124. package/sdk/platform/Billing/BillingPlatformClient.d.ts +88 -97
  125. package/sdk/platform/Billing/BillingPlatformClient.js +310 -191
  126. package/sdk/platform/Billing/BillingPlatformModel.d.ts +1211 -68
  127. package/sdk/platform/Billing/BillingPlatformModel.js +824 -59
  128. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +153 -12
  129. package/sdk/platform/Billing/BillingPlatformValidator.js +87 -8
  130. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +392 -634
  131. package/sdk/platform/Cart/CartPlatformApplicationClient.js +1480 -957
  132. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +827 -57
  133. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +492 -34
  134. package/sdk/platform/Cart/CartPlatformModel.d.ts +3639 -175
  135. package/sdk/platform/Cart/CartPlatformModel.js +2368 -212
  136. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +438 -615
  137. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1449 -984
  138. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1081 -49
  139. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +482 -23
  140. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +573 -824
  141. package/sdk/platform/Catalog/CatalogPlatformClient.js +1773 -1264
  142. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6871 -326
  143. package/sdk/platform/Catalog/CatalogPlatformModel.js +4215 -349
  144. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1331 -71
  145. package/sdk/platform/Catalog/CatalogPlatformValidator.js +611 -30
  146. package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -21
  147. package/sdk/platform/Common/CommonPlatformClient.js +48 -33
  148. package/sdk/platform/Common/CommonPlatformModel.d.ts +448 -19
  149. package/sdk/platform/Common/CommonPlatformModel.js +224 -16
  150. package/sdk/platform/Common/CommonPlatformValidator.d.ts +42 -4
  151. package/sdk/platform/Common/CommonPlatformValidator.js +21 -3
  152. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +457 -279
  153. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1423 -553
  154. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +581 -42
  155. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +294 -22
  156. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +18 -5
  157. package/sdk/platform/Communication/CommunicationPlatformClient.js +58 -19
  158. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1630 -102
  159. package/sdk/platform/Communication/CommunicationPlatformModel.js +1150 -85
  160. package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +16 -3
  161. package/sdk/platform/Communication/CommunicationPlatformValidator.js +11 -3
  162. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +102 -111
  163. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +321 -225
  164. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +830 -43
  165. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +612 -78
  166. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +180 -13
  167. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +98 -10
  168. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +232 -212
  169. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +737 -438
  170. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +293 -22
  171. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +184 -17
  172. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +166 -178
  173. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +519 -310
  174. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +4504 -188
  175. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2242 -204
  176. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +332 -19
  177. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +153 -10
  178. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +495 -560
  179. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1777 -987
  180. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +872 -62
  181. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +487 -35
  182. package/sdk/platform/Content/ContentPlatformModel.d.ts +1661 -108
  183. package/sdk/platform/Content/ContentPlatformModel.js +1217 -113
  184. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +67 -101
  185. package/sdk/platform/Discount/DiscountPlatformClient.js +240 -176
  186. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +242 -15
  187. package/sdk/platform/Discount/DiscountPlatformModel.js +162 -10
  188. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +185 -13
  189. package/sdk/platform/Discount/DiscountPlatformValidator.js +88 -8
  190. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +32 -41
  191. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +106 -74
  192. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +77 -6
  193. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +41 -6
  194. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +39 -54
  195. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +124 -99
  196. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +299 -20
  197. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +207 -16
  198. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +98 -8
  199. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +54 -7
  200. package/sdk/platform/Finance/FinancePlatformClient.d.ts +85 -91
  201. package/sdk/platform/Finance/FinancePlatformClient.js +272 -180
  202. package/sdk/platform/Finance/FinancePlatformModel.d.ts +619 -50
  203. package/sdk/platform/Finance/FinancePlatformModel.js +458 -30
  204. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +123 -15
  205. package/sdk/platform/Finance/FinancePlatformValidator.js +95 -16
  206. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +99 -97
  207. package/sdk/platform/Inventory/InventoryPlatformClient.js +288 -199
  208. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +1354 -61
  209. package/sdk/platform/Inventory/InventoryPlatformModel.js +916 -83
  210. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +168 -12
  211. package/sdk/platform/Inventory/InventoryPlatformValidator.js +82 -6
  212. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +86 -106
  213. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +326 -186
  214. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +180 -14
  215. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +94 -9
  216. package/sdk/platform/Lead/LeadPlatformClient.d.ts +75 -101
  217. package/sdk/platform/Lead/LeadPlatformClient.js +240 -174
  218. package/sdk/platform/Lead/LeadPlatformModel.d.ts +1403 -54
  219. package/sdk/platform/Lead/LeadPlatformModel.js +618 -73
  220. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +173 -12
  221. package/sdk/platform/Lead/LeadPlatformValidator.js +85 -8
  222. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +18 -14
  223. package/sdk/platform/Order/OrderPlatformApplicationClient.js +56 -29
  224. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +26 -4
  225. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
  226. package/sdk/platform/Order/OrderPlatformClient.d.ts +343 -556
  227. package/sdk/platform/Order/OrderPlatformClient.js +969 -762
  228. package/sdk/platform/Order/OrderPlatformModel.d.ts +4967 -247
  229. package/sdk/platform/Order/OrderPlatformModel.js +3249 -259
  230. package/sdk/platform/Order/OrderPlatformValidator.d.ts +758 -37
  231. package/sdk/platform/Order/OrderPlatformValidator.js +351 -22
  232. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +28 -36
  233. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +103 -59
  234. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +66 -6
  235. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +32 -4
  236. package/sdk/platform/Partner/PartnerPlatformClient.d.ts +68 -107
  237. package/sdk/platform/Partner/PartnerPlatformClient.js +253 -174
  238. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +767 -45
  239. package/sdk/platform/Partner/PartnerPlatformModel.js +524 -41
  240. package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +207 -13
  241. package/sdk/platform/Partner/PartnerPlatformValidator.js +87 -5
  242. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +255 -260
  243. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +860 -504
  244. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +348 -30
  245. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +221 -19
  246. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +73 -73
  247. package/sdk/platform/Payment/PaymentPlatformClient.js +238 -154
  248. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2658 -93
  249. package/sdk/platform/Payment/PaymentPlatformModel.js +1035 -36
  250. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +111 -11
  251. package/sdk/platform/Payment/PaymentPlatformValidator.js +68 -7
  252. package/sdk/platform/PlatformAPIClient.d.ts +16 -1
  253. package/sdk/platform/PlatformAPIClient.js +9 -1
  254. package/sdk/platform/PlatformApplicationClient.d.ts +22 -1798
  255. package/sdk/platform/PlatformApplicationClient.js +17 -1899
  256. package/sdk/platform/PlatformClient.d.ts +29 -12579
  257. package/sdk/platform/PlatformClient.js +26 -15085
  258. package/sdk/platform/PlatformConfig.d.ts +37 -11
  259. package/sdk/platform/PlatformConfig.js +32 -6
  260. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +80 -92
  261. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +307 -177
  262. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +149 -12
  263. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +82 -8
  264. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +371 -23
  265. package/sdk/platform/Rewards/RewardsPlatformModel.js +246 -16
  266. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +120 -89
  267. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +349 -201
  268. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +128 -12
  269. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +85 -11
  270. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +148 -178
  271. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +454 -329
  272. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1399 -96
  273. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1022 -71
  274. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +280 -18
  275. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -11
  276. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +38 -47
  277. package/sdk/platform/Share/SharePlatformApplicationClient.js +137 -73
  278. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +87 -7
  279. package/sdk/platform/Share/SharePlatformApplicationValidator.js +42 -5
  280. package/sdk/platform/Share/SharePlatformModel.d.ts +250 -16
  281. package/sdk/platform/Share/SharePlatformModel.js +165 -17
  282. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +149 -183
  283. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +579 -330
  284. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +308 -24
  285. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +162 -10
  286. package/sdk/platform/Theme/ThemePlatformModel.d.ts +621 -48
  287. package/sdk/platform/Theme/ThemePlatformModel.js +464 -40
  288. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +119 -151
  289. package/sdk/platform/User/UserPlatformApplicationClient.js +411 -244
  290. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +235 -18
  291. package/sdk/platform/User/UserPlatformApplicationValidator.js +126 -12
  292. package/sdk/platform/User/UserPlatformModel.d.ts +1390 -101
  293. package/sdk/platform/User/UserPlatformModel.js +983 -44
  294. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +38 -47
  295. package/sdk/platform/Webhook/WebhookPlatformClient.js +137 -87
  296. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +242 -16
  297. package/sdk/platform/Webhook/WebhookPlatformModel.js +167 -18
  298. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +83 -7
  299. package/sdk/platform/Webhook/WebhookPlatformValidator.js +43 -5
  300. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -21
  301. package/sdk/public/Configuration/ConfigurationPublicClient.js +46 -33
  302. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +473 -19
  303. package/sdk/public/Configuration/ConfigurationPublicModel.js +224 -16
  304. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +42 -4
  305. package/sdk/public/Configuration/ConfigurationPublicValidator.js +21 -3
  306. package/sdk/public/Inventory/InventoryPublicClient.d.ts +48 -48
  307. package/sdk/public/Inventory/InventoryPublicClient.js +146 -98
  308. package/sdk/public/Inventory/InventoryPublicModel.d.ts +392 -21
  309. package/sdk/public/Inventory/InventoryPublicModel.js +267 -27
  310. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +90 -8
  311. package/sdk/public/Inventory/InventoryPublicValidator.js +44 -4
  312. package/sdk/public/PublicClient.d.ts +19 -3
  313. package/sdk/public/PublicClient.js +16 -0
  314. package/sdk/public/PublicConfig.d.ts +27 -6
  315. package/sdk/public/PublicConfig.js +17 -1
  316. package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -11
  317. package/sdk/public/Webhook/WebhookPublicClient.js +42 -27
  318. package/sdk/public/Webhook/WebhookPublicModel.d.ts +242 -16
  319. package/sdk/public/Webhook/WebhookPublicModel.js +167 -18
  320. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +18 -3
  321. package/sdk/public/Webhook/WebhookPublicValidator.js +14 -4
@@ -1,103 +1,1631 @@
1
- export = CommunicationModel;
2
- declare class CommunicationModel {
3
- static Audience(): any;
4
- static AudienceReq(): any;
5
- static Audiences(): any;
6
- static BadRequestSchema(): any;
7
- static BigqueryHeadersReq(): any;
8
- static BigqueryHeadersRes(): any;
9
- static BigqueryHeadersResHeaders(): any;
10
- static Campaign(): any;
11
- static CampaignEmail(): any;
12
- static CampaignEmailTemplate(): any;
13
- static CampaignReq(): any;
14
- static Campaigns(): any;
15
- static CampignEmailProvider(): any;
16
- static EmailProvider(): any;
17
- static EmailProviderReq(): any;
18
- static EmailProviderReqFrom(): any;
19
- static EmailProviders(): any;
20
- static EmailTemplate(): any;
21
- static EmailTemplateDeleteFailureRes(): any;
22
- static EmailTemplateDeleteSuccessRes(): any;
23
- static EmailTemplateHeaders(): any;
24
- static EmailTemplateKeys(): any;
25
- static EmailTemplateReq(): any;
26
- static EmailTemplateRes(): any;
27
- static EmailTemplates(): any;
28
- static EngineRequest(): any;
29
- static EngineResponse(): any;
30
- static EventSubscription(): any;
31
- static EventSubscriptions(): any;
32
- static EventSubscriptionTemplate(): any;
33
- static EventSubscriptionTemplateEmail(): any;
34
- static EventSubscriptionTemplateSms(): any;
35
- static GetNRecordsCsvReq(): any;
36
- static GetNRecordsCsvRes(): any;
37
- static GetNRecordsCsvResItems(): any;
38
- static GetStats(): any;
39
- static Job(): any;
40
- static JobLog(): any;
41
- static JobLogs(): any;
42
- static Jobs(): any;
43
- static Log(): any;
44
- static LogEmail(): any;
45
- static LogMeta(): any;
46
- static LogPushnotification(): any;
47
- static Logs(): any;
48
- static MetaStructure(): any;
49
- static NotFound(): any;
50
- static Notification(): any;
51
- static Page(): any;
52
- static PayloadEmailProviderStructure(): any;
53
- static PayloadEmailStructure(): any;
54
- static PayloadEmailTemplateStructure(): any;
55
- static PayloadSmsProviderStructure(): any;
56
- static PayloadSmsStructure(): any;
57
- static PayloadSmsTemplateStructure(): any;
58
- static PayloadStructure(): any;
59
- static PushtokenReq(): any;
60
- static PushtokenRes(): any;
61
- static RecipientHeaders(): any;
62
- static SendOtpCommsReq(): any;
63
- static SendOtpCommsReqData(): any;
64
- static SendOtpCommsReqEmail(): any;
65
- static SendOtpCommsReqSms(): any;
66
- static SendOtpCommsRes(): any;
67
- static SendOtpCommsResEmail(): any;
68
- static SendOtpCommsResSms(): any;
69
- static SendOtpEmailCommsProvider(): any;
70
- static SendOtpEmailCommsTemplate(): any;
71
- static SendOtpSmsCommsProvider(): any;
72
- static SendOtpSmsCommsTemplate(): any;
73
- static SmsProvider(): any;
74
- static SmsProviderReq(): any;
75
- static SmsProviders(): any;
76
- static SmsTemplate(): any;
77
- static SmsTemplateDeleteFailureRes(): any;
78
- static SmsTemplateDeleteSuccessRes(): any;
79
- static SmsTemplateMessage(): any;
80
- static SmsTemplateReq(): any;
81
- static SmsTemplateRes(): any;
82
- static SmsTemplates(): any;
83
- static Stats(): any;
84
- static StatsImported(): any;
85
- static StatsProcessed(): any;
86
- static StatsProcessedEmail(): any;
87
- static StatsProcessedSms(): any;
88
- static SystemEmailTemplate(): any;
89
- static SystemEmailTemplates(): any;
90
- static SystemNotification(): any;
91
- static SystemNotifications(): any;
92
- static SystemNotificationSettings(): any;
93
- static SystemNotificationsPage(): any;
94
- static SystemNotificationUser(): any;
95
- static SystemSmsTemplate(): any;
96
- static SystemSmsTemplates(): any;
97
- static TemplateAndType(): any;
98
- static TriggerJobRequest(): any;
99
- static TriggerJobResponse(): any;
100
- static VerifyOtpCommsErrorRes(): any;
101
- static VerifyOtpCommsReq(): any;
102
- static VerifyOtpCommsSuccessRes(): any;
1
+ export = CommunicationPlatformModel;
2
+ /**
3
+ * @typedef Audience
4
+ * @property {number} [__v]
5
+ * @property {string} [_id]
6
+ * @property {string} [application]
7
+ * @property {string} [created_at]
8
+ * @property {string} [description]
9
+ * @property {string} [file_url]
10
+ * @property {string[]} [headers]
11
+ * @property {boolean} [is_active]
12
+ * @property {string} [name]
13
+ * @property {number} [records_count]
14
+ * @property {string} [slug]
15
+ * @property {string[]} [tags]
16
+ * @property {string} [type]
17
+ * @property {string} [updated_at]
18
+ */
19
+ /**
20
+ * @typedef AudienceReq
21
+ * @property {string} [application]
22
+ * @property {string} [description]
23
+ * @property {string} [file_url]
24
+ * @property {string[]} [headers]
25
+ * @property {boolean} [is_active]
26
+ * @property {string} [name]
27
+ * @property {number} [records_count]
28
+ * @property {string[]} [tags]
29
+ * @property {string} [type]
30
+ */
31
+ /**
32
+ * @typedef Audiences
33
+ * @property {Audience[]} [items]
34
+ * @property {Page} [page]
35
+ */
36
+ /**
37
+ * @typedef BadRequestSchema
38
+ * @property {string} [message] - Failure message.
39
+ * @property {string} [status] - Response status.
40
+ */
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
+ /**
56
+ * @typedef Campaign
57
+ * @property {number} [__v]
58
+ * @property {string} [_id]
59
+ * @property {string} [application]
60
+ * @property {string} [created_at]
61
+ * @property {string} [datasource]
62
+ * @property {string} [description]
63
+ * @property {CampaignEmail} [email]
64
+ * @property {boolean} [is_active]
65
+ * @property {string} [name]
66
+ * @property {RecipientHeaders} [recipient_headers]
67
+ * @property {string} [slug]
68
+ * @property {Object[]} [tags]
69
+ * @property {string} [type]
70
+ * @property {string} [updated_at]
71
+ */
72
+ /**
73
+ * @typedef CampaignEmail
74
+ * @property {CampignEmailProvider} [provider]
75
+ * @property {CampaignEmailTemplate} [template]
76
+ */
77
+ /**
78
+ * @typedef CampaignEmailTemplate
79
+ * @property {string} [key]
80
+ * @property {string} [value]
81
+ */
82
+ /**
83
+ * @typedef CampaignReq
84
+ * @property {string} [application]
85
+ * @property {string} [description]
86
+ * @property {string} [file_url]
87
+ * @property {string[]} [headers]
88
+ * @property {boolean} [is_active]
89
+ * @property {string} [name]
90
+ * @property {number} [records_count]
91
+ * @property {string[]} [tags]
92
+ * @property {string} [type]
93
+ */
94
+ /**
95
+ * @typedef Campaigns
96
+ * @property {Campaign[]} [items]
97
+ * @property {Page} [page]
98
+ */
99
+ /**
100
+ * @typedef CampignEmailProvider
101
+ * @property {string} [_id]
102
+ * @property {string} [from_email]
103
+ * @property {string} [from_name]
104
+ */
105
+ /**
106
+ * @typedef EmailProvider
107
+ * @property {number} [__v]
108
+ * @property {string} [_id]
109
+ * @property {string} [api_key]
110
+ * @property {string} [application]
111
+ * @property {string} [created_at]
112
+ * @property {string} [description]
113
+ * @property {EmailProviderReqFrom[]} [from_address]
114
+ * @property {string} [name]
115
+ * @property {string} [provider]
116
+ * @property {string} [slug]
117
+ * @property {string} [type]
118
+ * @property {string} [updated_at]
119
+ */
120
+ /**
121
+ * @typedef EmailProviderReq
122
+ * @property {string} [api_key]
123
+ * @property {string} [description]
124
+ * @property {EmailProviderReqFrom[]} [from_address]
125
+ * @property {string} [name]
126
+ * @property {string} [provider]
127
+ * @property {string} [type]
128
+ */
129
+ /**
130
+ * @typedef EmailProviderReqFrom
131
+ * @property {string} [email]
132
+ * @property {boolean} [is_default]
133
+ * @property {string} [name]
134
+ */
135
+ /**
136
+ * @typedef EmailProviders
137
+ * @property {EmailProvider[]} [items]
138
+ * @property {Page} [page]
139
+ */
140
+ /**
141
+ * @typedef EmailTemplate
142
+ * @property {number} [__v]
143
+ * @property {string} [_id]
144
+ * @property {Object[]} [attachments]
145
+ * @property {string} [created_at]
146
+ * @property {string} [description]
147
+ * @property {string} [from_name]
148
+ * @property {Object[]} [headers]
149
+ * @property {TemplateAndType} [html]
150
+ * @property {boolean} [is_internal]
151
+ * @property {boolean} [is_system]
152
+ * @property {string} [name]
153
+ * @property {string} [priority]
154
+ * @property {boolean} [published]
155
+ * @property {string} [slug]
156
+ * @property {Object[]} [static_bcc]
157
+ * @property {Object[]} [static_cc]
158
+ * @property {Object[]} [static_to]
159
+ * @property {TemplateAndType} [subject]
160
+ * @property {Object[]} [tags]
161
+ * @property {TemplateAndType} [text]
162
+ * @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]
173
+ */
174
+ /**
175
+ * @typedef EmailTemplateHeaders
176
+ * @property {string} [key]
177
+ * @property {string} [value]
178
+ */
179
+ /**
180
+ * @typedef EmailTemplateKeys
181
+ * @property {string} [bcc]
182
+ * @property {string} [cc]
183
+ * @property {string} [to]
184
+ */
185
+ /**
186
+ * @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]
207
+ * @property {string} [description]
208
+ * @property {EmailTemplateHeaders[]} [headers]
209
+ * @property {TemplateAndType} [html]
210
+ * @property {boolean} [is_internal]
211
+ * @property {boolean} [is_system]
212
+ * @property {EmailTemplateKeys} [keys]
213
+ * @property {string} [name]
214
+ * @property {string} [priority]
215
+ * @property {boolean} [published]
216
+ * @property {string} [reply_to]
217
+ * @property {string} [slug]
218
+ * @property {string[]} [static_bcc]
219
+ * @property {string[]} [static_cc]
220
+ * @property {string[]} [static_to]
221
+ * @property {TemplateAndType} [subject]
222
+ * @property {Object[]} [tags]
223
+ * @property {TemplateAndType} [text]
224
+ * @property {string} [updated_at]
225
+ */
226
+ /**
227
+ * @typedef EmailTemplates
228
+ * @property {EmailTemplate[]} [items]
229
+ * @property {Page} [page]
230
+ */
231
+ /**
232
+ * @typedef EngineRequest
233
+ * @property {MetaStructure} [meta]
234
+ * @property {PayloadStructure} [payload]
235
+ */
236
+ /**
237
+ * @typedef EngineResponse
238
+ * @property {boolean} [success]
239
+ */
240
+ /**
241
+ * @typedef EventSubscription
242
+ * @property {number} [__v]
243
+ * @property {string} [_id]
244
+ * @property {string} [application]
245
+ * @property {string} [created_at]
246
+ * @property {string} [event]
247
+ * @property {boolean} [is_default]
248
+ * @property {string} [slug]
249
+ * @property {EventSubscriptionTemplate} [template]
250
+ * @property {string} [updated_at]
251
+ */
252
+ /**
253
+ * @typedef EventSubscriptions
254
+ * @property {EventSubscription[]} [items]
255
+ * @property {Page} [page]
256
+ */
257
+ /**
258
+ * @typedef EventSubscriptionTemplate
259
+ * @property {EventSubscriptionTemplateEmail} [email]
260
+ * @property {EventSubscriptionTemplateSms} [sms]
261
+ */
262
+ /**
263
+ * @typedef EventSubscriptionTemplateEmail
264
+ * @property {boolean} [subscribed]
265
+ * @property {string} [template]
266
+ */
267
+ /**
268
+ * @typedef EventSubscriptionTemplateSms
269
+ * @property {boolean} [subscribed]
270
+ * @property {string} [template]
271
+ */
272
+ /**
273
+ * @typedef GetNRecordsCsvReq
274
+ * @property {number} [count]
275
+ * @property {boolean} [header]
276
+ * @property {string} [url]
277
+ */
278
+ /**
279
+ * @typedef GetNRecordsCsvRes
280
+ * @property {GetNRecordsCsvResItems[]} [items]
281
+ */
282
+ /**
283
+ * @typedef GetNRecordsCsvResItems
284
+ * @property {string} [email]
285
+ * @property {string} [firstname]
286
+ * @property {string} [lastname]
287
+ * @property {string} [orderid]
288
+ * @property {string} [phone_number]
289
+ */
290
+ /**
291
+ * @typedef GetStats
292
+ * @property {Stats[]} [items]
293
+ */
294
+ /**
295
+ * @typedef Job
296
+ * @property {number} [__v]
297
+ * @property {string} [_id]
298
+ * @property {string} [application]
299
+ * @property {string} [campaign]
300
+ * @property {boolean} [completed]
301
+ * @property {string} [created_at]
302
+ * @property {boolean} [is_active]
303
+ * @property {string} [updated_at]
304
+ */
305
+ /**
306
+ * @typedef JobLog
307
+ * @property {number} [__v]
308
+ * @property {string} [_id]
309
+ * @property {string} [campaign]
310
+ * @property {string} [created_at]
311
+ * @property {Object} [imported]
312
+ * @property {string} [job]
313
+ * @property {Object} [processed]
314
+ * @property {string} [updated_at]
315
+ */
316
+ /**
317
+ * @typedef JobLogs
318
+ * @property {JobLog[]} [items]
319
+ * @property {Page} [page]
320
+ */
321
+ /**
322
+ * @typedef Jobs
323
+ * @property {Job[]} [items]
324
+ * @property {Page} [page]
325
+ */
326
+ /**
327
+ * @typedef Log
328
+ * @property {string} [_id]
329
+ * @property {string} [application]
330
+ * @property {string} [channel_type]
331
+ * @property {string} [created_at]
332
+ * @property {Object} [data]
333
+ * @property {LogEmail} [email]
334
+ * @property {string} [expire_at]
335
+ * @property {LogMeta} [meta]
336
+ * @property {LogPushnotification} [pushnotification]
337
+ * @property {string} [service]
338
+ * @property {string} [source]
339
+ * @property {string} [status]
340
+ * @property {string} [step]
341
+ */
342
+ /**
343
+ * @typedef LogEmail
344
+ * @property {string} [template]
345
+ */
346
+ /**
347
+ * @typedef LogMeta
348
+ * @property {string} [identifier]
349
+ * @property {string} [key]
350
+ * @property {string} [offset]
351
+ * @property {string} [partition]
352
+ * @property {string} [topic]
353
+ * @property {string} [type]
354
+ */
355
+ /**
356
+ * @typedef LogPushnotification
357
+ * @property {string[]} [pushtokens]
358
+ */
359
+ /**
360
+ * @typedef Logs
361
+ * @property {Log[]} [items]
362
+ * @property {Page} [page]
363
+ */
364
+ /**
365
+ * @typedef MetaStructure
366
+ * @property {string} [action]
367
+ * @property {string} [job_type]
368
+ * @property {string} [timestamp]
369
+ * @property {string} [trace]
370
+ */
371
+ /**
372
+ * @typedef NotFound
373
+ * @property {string} [message] - Failure message.
374
+ */
375
+ /**
376
+ * @typedef Notification
377
+ * @property {string} [body]
378
+ * @property {string} [click_action]
379
+ * @property {string} [deeplink]
380
+ * @property {string} [icon]
381
+ * @property {string} [subtitle]
382
+ * @property {string} [title]
383
+ */
384
+ /**
385
+ * @typedef Page
386
+ * @property {number} [current]
387
+ * @property {boolean} [has_next]
388
+ * @property {boolean} [has_previous]
389
+ * @property {number} [item_total]
390
+ * @property {string} [next_id]
391
+ * @property {number} [size]
392
+ * @property {string} type
393
+ */
394
+ /**
395
+ * @typedef PayloadEmailProviderStructure
396
+ * @property {string} [_id]
397
+ */
398
+ /**
399
+ * @typedef PayloadEmailStructure
400
+ * @property {PayloadEmailProviderStructure} [provider]
401
+ * @property {PayloadEmailTemplateStructure} [template]
402
+ */
403
+ /**
404
+ * @typedef PayloadEmailTemplateStructure
405
+ * @property {string} [key]
406
+ * @property {Object} [value]
407
+ */
408
+ /**
409
+ * @typedef PayloadSmsProviderStructure
410
+ * @property {string} [_id]
411
+ */
412
+ /**
413
+ * @typedef PayloadSmsStructure
414
+ * @property {PayloadSmsProviderStructure} [provider]
415
+ * @property {PayloadSmsTemplateStructure} [template]
416
+ */
417
+ /**
418
+ * @typedef PayloadSmsTemplateStructure
419
+ * @property {string} [key]
420
+ * @property {Object} [value]
421
+ */
422
+ /**
423
+ * @typedef PayloadStructure
424
+ * @property {string} [application]
425
+ * @property {Object[]} [data]
426
+ * @property {PayloadEmailStructure} [email]
427
+ * @property {PayloadSmsStructure} [sms]
428
+ */
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
+ /**
451
+ * @typedef RecipientHeaders
452
+ * @property {string} [email]
453
+ */
454
+ /**
455
+ * @typedef SendOtpCommsReq
456
+ * @property {SendOtpCommsReqData} [data]
457
+ * @property {SendOtpCommsReqEmail} [email]
458
+ * @property {SendOtpCommsReqSms} [sms]
459
+ */
460
+ /**
461
+ * @typedef SendOtpCommsReqData
462
+ * @property {string} [country_code]
463
+ * @property {string} [mobile]
464
+ * @property {boolean} [send_same_otp_to_channel]
465
+ * @property {string} [to]
466
+ */
467
+ /**
468
+ * @typedef SendOtpCommsReqEmail
469
+ * @property {number} [expiry]
470
+ * @property {number} [otp_length]
471
+ * @property {SendOtpEmailCommsProvider} [provider]
472
+ * @property {SendOtpEmailCommsTemplate} [template]
473
+ */
474
+ /**
475
+ * @typedef SendOtpCommsReqSms
476
+ * @property {number} [expiry]
477
+ * @property {number} [otp_length]
478
+ * @property {SendOtpSmsCommsProvider} [provider]
479
+ * @property {SendOtpSmsCommsTemplate} [template]
480
+ */
481
+ /**
482
+ * @typedef SendOtpCommsRes
483
+ * @property {SendOtpCommsResEmail} [email]
484
+ * @property {SendOtpCommsResSms} [sms]
485
+ */
486
+ /**
487
+ * @typedef SendOtpCommsResEmail
488
+ * @property {string} [message]
489
+ * @property {string} [request_id]
490
+ * @property {number} [resend_timer]
491
+ * @property {boolean} [success]
492
+ * @property {string} [to]
493
+ */
494
+ /**
495
+ * @typedef SendOtpCommsResSms
496
+ * @property {string} [country_code]
497
+ * @property {string} [message]
498
+ * @property {string} [mobile]
499
+ * @property {string} [request_id]
500
+ * @property {number} [resend_timer]
501
+ * @property {boolean} [success]
502
+ */
503
+ /**
504
+ * @typedef SendOtpEmailCommsProvider
505
+ * @property {string} [_id]
506
+ * @property {string} [slug]
507
+ */
508
+ /**
509
+ * @typedef SendOtpEmailCommsTemplate
510
+ * @property {string} [key]
511
+ * @property {Object} [value]
512
+ */
513
+ /**
514
+ * @typedef SendOtpSmsCommsProvider
515
+ * @property {string} [_id]
516
+ * @property {string} [slug]
517
+ */
518
+ /**
519
+ * @typedef SendOtpSmsCommsTemplate
520
+ * @property {string} [key]
521
+ * @property {Object} [value]
522
+ */
523
+ /**
524
+ * @typedef SmsProvider
525
+ * @property {number} [__v]
526
+ * @property {string} [_id]
527
+ * @property {string} [application]
528
+ * @property {string} [authkey]
529
+ * @property {string} [created_at]
530
+ * @property {string} [description]
531
+ * @property {string} [name]
532
+ * @property {string} [provider]
533
+ * @property {number} [rpt]
534
+ * @property {string} [sender]
535
+ * @property {string} [slug]
536
+ * @property {string} [type]
537
+ * @property {string} [updated_at]
538
+ * @property {string} [username]
539
+ */
540
+ /**
541
+ * @typedef SmsProviderReq
542
+ * @property {string} [authkey]
543
+ * @property {string} [description]
544
+ * @property {string} [name]
545
+ * @property {string} [provider]
546
+ * @property {string} [sender]
547
+ * @property {string} [type]
548
+ * @property {string} [username]
549
+ */
550
+ /**
551
+ * @typedef SmsProviders
552
+ * @property {SmsProvider[]} [items]
553
+ * @property {Page} [page]
554
+ */
555
+ /**
556
+ * @typedef SmsTemplate
557
+ * @property {number} [__v]
558
+ * @property {string} [_id]
559
+ * @property {string} [created_at]
560
+ * @property {string} [description]
561
+ * @property {boolean} [is_internal]
562
+ * @property {boolean} [is_system]
563
+ * @property {SmsTemplateMessage} [message]
564
+ * @property {string} [name]
565
+ * @property {string} [priority]
566
+ * @property {boolean} [published]
567
+ * @property {string} [slug]
568
+ * @property {Object[]} [tags]
569
+ * @property {Object} [template_variables]
570
+ * @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]
581
+ */
582
+ /**
583
+ * @typedef SmsTemplateMessage
584
+ * @property {string} [template]
585
+ * @property {string} [template_type]
586
+ */
587
+ /**
588
+ * @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
+ * @property {string} [description]
602
+ * @property {boolean} [is_internal]
603
+ * @property {boolean} [is_system]
604
+ * @property {SmsTemplateMessage} [message]
605
+ * @property {string} [name]
606
+ * @property {string} [priority]
607
+ * @property {boolean} [published]
608
+ * @property {string} [slug]
609
+ * @property {Object[]} [tags]
610
+ * @property {Object} [template_variables]
611
+ * @property {string} [updated_at]
612
+ */
613
+ /**
614
+ * @typedef SmsTemplates
615
+ * @property {SmsTemplate[]} [items]
616
+ * @property {Page} [page]
617
+ */
618
+ /**
619
+ * @typedef Stats
620
+ * @property {string} [_id]
621
+ * @property {Object} [imported]
622
+ * @property {Object} [processed]
623
+ */
624
+ /**
625
+ * @typedef StatsImported
626
+ * @property {number} [count]
627
+ */
628
+ /**
629
+ * @typedef StatsProcessed
630
+ * @property {StatsProcessedEmail} [email]
631
+ * @property {StatsProcessedSms} [sms]
632
+ */
633
+ /**
634
+ * @typedef StatsProcessedEmail
635
+ * @property {number} [failed]
636
+ * @property {number} [success]
637
+ * @property {number} [suppressed]
638
+ */
639
+ /**
640
+ * @typedef StatsProcessedSms
641
+ * @property {number} [failed]
642
+ * @property {number} [success]
643
+ * @property {number} [suppressed]
644
+ */
645
+ /**
646
+ * @typedef SystemEmailTemplate
647
+ * @property {number} [__v]
648
+ * @property {string} [_id]
649
+ * @property {Object[]} [attachments]
650
+ * @property {string} [created_at]
651
+ * @property {string} [description]
652
+ * @property {string} [from_name]
653
+ * @property {Object[]} [headers]
654
+ * @property {TemplateAndType} [html]
655
+ * @property {boolean} [is_internal]
656
+ * @property {boolean} [is_system]
657
+ * @property {string} [name]
658
+ * @property {string} [priority]
659
+ * @property {boolean} [published]
660
+ * @property {string} [slug]
661
+ * @property {Object[]} [static_bcc]
662
+ * @property {Object[]} [static_cc]
663
+ * @property {Object[]} [static_to]
664
+ * @property {TemplateAndType} [subject]
665
+ * @property {Object[]} [tags]
666
+ * @property {TemplateAndType} [text]
667
+ * @property {string} [updated_at]
668
+ */
669
+ /**
670
+ * @typedef SystemEmailTemplates
671
+ * @property {SystemEmailTemplate[]} [items]
672
+ * @property {Page} [page]
673
+ */
674
+ /**
675
+ * @typedef SystemNotification
676
+ * @property {string} [_id]
677
+ * @property {string} [created_at]
678
+ * @property {string} [group]
679
+ * @property {Notification} [notification]
680
+ * @property {SystemNotificationUser} [settings]
681
+ * @property {SystemNotificationUser} [user]
682
+ */
683
+ /**
684
+ * @typedef SystemNotifications
685
+ * @property {SystemNotification[]} [items]
686
+ * @property {number} [last_read_anchor]
687
+ * @property {Page} [page]
688
+ */
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
+ /**
704
+ * @typedef SystemNotificationUser
705
+ * @property {string} [type]
706
+ * @property {string} [value]
707
+ */
708
+ /**
709
+ * @typedef SystemSmsTemplate
710
+ * @property {number} [__v]
711
+ * @property {string} [_id]
712
+ * @property {string} [created_at]
713
+ * @property {string} [description]
714
+ * @property {boolean} [is_internal]
715
+ * @property {boolean} [is_system]
716
+ * @property {SmsTemplateMessage} [message]
717
+ * @property {string} [name]
718
+ * @property {string} [priority]
719
+ * @property {boolean} [published]
720
+ * @property {string} [slug]
721
+ * @property {Object[]} [tags]
722
+ * @property {Object} [template_variables]
723
+ * @property {string} [updated_at]
724
+ */
725
+ /**
726
+ * @typedef SystemSmsTemplates
727
+ * @property {SystemSmsTemplate[]} [items]
728
+ * @property {Page} [page]
729
+ */
730
+ /**
731
+ * @typedef TemplateAndType
732
+ * @property {string} [template]
733
+ * @property {string} [template_type]
734
+ */
735
+ /**
736
+ * @typedef TriggerJobRequest
737
+ * @property {string} [job_id]
738
+ */
739
+ /**
740
+ * @typedef TriggerJobResponse
741
+ * @property {number} [status]
742
+ */
743
+ /**
744
+ * @typedef VerifyOtpCommsErrorRes
745
+ * @property {string} [message]
746
+ * @property {boolean} [success]
747
+ */
748
+ /**
749
+ * @typedef VerifyOtpCommsReq
750
+ * @property {string} [otp]
751
+ * @property {string} [request_id]
752
+ */
753
+ /**
754
+ * @typedef VerifyOtpCommsSuccessRes
755
+ * @property {string} [country_code]
756
+ * @property {string} [message]
757
+ * @property {string} [mobile]
758
+ * @property {boolean} [success]
759
+ */
760
+ declare class CommunicationPlatformModel {
103
761
  }
762
+ 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 };
764
+ }
765
+ /** @returns {Audience} */
766
+ declare function Audience(): Audience;
767
+ type Audience = {
768
+ __v?: number;
769
+ _id?: string;
770
+ application?: string;
771
+ created_at?: string;
772
+ description?: string;
773
+ file_url?: string;
774
+ headers?: string[];
775
+ is_active?: boolean;
776
+ name?: string;
777
+ records_count?: number;
778
+ slug?: string;
779
+ tags?: string[];
780
+ type?: string;
781
+ updated_at?: string;
782
+ };
783
+ /** @returns {AudienceReq} */
784
+ declare function AudienceReq(): AudienceReq;
785
+ type AudienceReq = {
786
+ application?: string;
787
+ description?: string;
788
+ file_url?: string;
789
+ headers?: string[];
790
+ is_active?: boolean;
791
+ name?: string;
792
+ records_count?: number;
793
+ tags?: string[];
794
+ type?: string;
795
+ };
796
+ /** @returns {Audiences} */
797
+ declare function Audiences(): Audiences;
798
+ type Audiences = {
799
+ items?: Audience[];
800
+ page?: Page;
801
+ };
802
+ /** @returns {BadRequestSchema} */
803
+ declare function BadRequestSchema(): BadRequestSchema;
804
+ type BadRequestSchema = {
805
+ /**
806
+ * - Failure message.
807
+ */
808
+ message?: string;
809
+ /**
810
+ * - Response status.
811
+ */
812
+ status?: string;
813
+ };
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
+ /** @returns {Campaign} */
832
+ declare function Campaign(): Campaign;
833
+ type Campaign = {
834
+ __v?: number;
835
+ _id?: string;
836
+ application?: string;
837
+ created_at?: string;
838
+ datasource?: string;
839
+ description?: string;
840
+ email?: CampaignEmail;
841
+ is_active?: boolean;
842
+ name?: string;
843
+ recipient_headers?: RecipientHeaders;
844
+ slug?: string;
845
+ tags?: any[];
846
+ type?: string;
847
+ updated_at?: string;
848
+ };
849
+ /** @returns {CampaignEmail} */
850
+ declare function CampaignEmail(): CampaignEmail;
851
+ type CampaignEmail = {
852
+ provider?: CampignEmailProvider;
853
+ template?: CampaignEmailTemplate;
854
+ };
855
+ /** @returns {CampaignEmailTemplate} */
856
+ declare function CampaignEmailTemplate(): CampaignEmailTemplate;
857
+ type CampaignEmailTemplate = {
858
+ key?: string;
859
+ value?: string;
860
+ };
861
+ /** @returns {CampaignReq} */
862
+ declare function CampaignReq(): CampaignReq;
863
+ type CampaignReq = {
864
+ application?: string;
865
+ description?: string;
866
+ file_url?: string;
867
+ headers?: string[];
868
+ is_active?: boolean;
869
+ name?: string;
870
+ records_count?: number;
871
+ tags?: string[];
872
+ type?: string;
873
+ };
874
+ /** @returns {Campaigns} */
875
+ declare function Campaigns(): Campaigns;
876
+ type Campaigns = {
877
+ items?: Campaign[];
878
+ page?: Page;
879
+ };
880
+ /** @returns {CampignEmailProvider} */
881
+ declare function CampignEmailProvider(): CampignEmailProvider;
882
+ type CampignEmailProvider = {
883
+ _id?: string;
884
+ from_email?: string;
885
+ from_name?: string;
886
+ };
887
+ /** @returns {EmailProvider} */
888
+ declare function EmailProvider(): EmailProvider;
889
+ type EmailProvider = {
890
+ __v?: number;
891
+ _id?: string;
892
+ api_key?: string;
893
+ application?: string;
894
+ created_at?: string;
895
+ description?: string;
896
+ from_address?: EmailProviderReqFrom[];
897
+ name?: string;
898
+ provider?: string;
899
+ slug?: string;
900
+ type?: string;
901
+ updated_at?: string;
902
+ };
903
+ /** @returns {EmailProviderReq} */
904
+ declare function EmailProviderReq(): EmailProviderReq;
905
+ type EmailProviderReq = {
906
+ api_key?: string;
907
+ description?: string;
908
+ from_address?: EmailProviderReqFrom[];
909
+ name?: string;
910
+ provider?: string;
911
+ type?: string;
912
+ };
913
+ /** @returns {EmailProviderReqFrom} */
914
+ declare function EmailProviderReqFrom(): EmailProviderReqFrom;
915
+ type EmailProviderReqFrom = {
916
+ email?: string;
917
+ is_default?: boolean;
918
+ name?: string;
919
+ };
920
+ /** @returns {EmailProviders} */
921
+ declare function EmailProviders(): EmailProviders;
922
+ type EmailProviders = {
923
+ items?: EmailProvider[];
924
+ page?: Page;
925
+ };
926
+ /** @returns {EmailTemplate} */
927
+ declare function EmailTemplate(): EmailTemplate;
928
+ type EmailTemplate = {
929
+ __v?: number;
930
+ _id?: string;
931
+ attachments?: any[];
932
+ created_at?: string;
933
+ description?: string;
934
+ from_name?: string;
935
+ headers?: any[];
936
+ html?: TemplateAndType;
937
+ is_internal?: boolean;
938
+ is_system?: boolean;
939
+ name?: string;
940
+ priority?: string;
941
+ published?: boolean;
942
+ slug?: string;
943
+ static_bcc?: any[];
944
+ static_cc?: any[];
945
+ static_to?: any[];
946
+ subject?: TemplateAndType;
947
+ tags?: any[];
948
+ text?: TemplateAndType;
949
+ 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;
962
+ };
963
+ /** @returns {EmailTemplateHeaders} */
964
+ declare function EmailTemplateHeaders(): EmailTemplateHeaders;
965
+ type EmailTemplateHeaders = {
966
+ key?: string;
967
+ value?: string;
968
+ };
969
+ /** @returns {EmailTemplateKeys} */
970
+ declare function EmailTemplateKeys(): EmailTemplateKeys;
971
+ type EmailTemplateKeys = {
972
+ bcc?: string;
973
+ cc?: string;
974
+ to?: string;
975
+ };
976
+ /** @returns {EmailTemplateReq} */
977
+ declare function EmailTemplateReq(): EmailTemplateReq;
978
+ 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;
1000
+ description?: string;
1001
+ headers?: EmailTemplateHeaders[];
1002
+ html?: TemplateAndType;
1003
+ is_internal?: boolean;
1004
+ is_system?: boolean;
1005
+ keys?: EmailTemplateKeys;
1006
+ name?: string;
1007
+ priority?: string;
1008
+ published?: boolean;
1009
+ reply_to?: string;
1010
+ slug?: string;
1011
+ static_bcc?: string[];
1012
+ static_cc?: string[];
1013
+ static_to?: string[];
1014
+ subject?: TemplateAndType;
1015
+ tags?: any[];
1016
+ text?: TemplateAndType;
1017
+ updated_at?: string;
1018
+ };
1019
+ /** @returns {EmailTemplates} */
1020
+ declare function EmailTemplates(): EmailTemplates;
1021
+ type EmailTemplates = {
1022
+ items?: EmailTemplate[];
1023
+ page?: Page;
1024
+ };
1025
+ /** @returns {EngineRequest} */
1026
+ declare function EngineRequest(): EngineRequest;
1027
+ type EngineRequest = {
1028
+ meta?: MetaStructure;
1029
+ payload?: PayloadStructure;
1030
+ };
1031
+ /** @returns {EngineResponse} */
1032
+ declare function EngineResponse(): EngineResponse;
1033
+ type EngineResponse = {
1034
+ success?: boolean;
1035
+ };
1036
+ /** @returns {EventSubscription} */
1037
+ declare function EventSubscription(): EventSubscription;
1038
+ type EventSubscription = {
1039
+ __v?: number;
1040
+ _id?: string;
1041
+ application?: string;
1042
+ created_at?: string;
1043
+ event?: string;
1044
+ is_default?: boolean;
1045
+ slug?: string;
1046
+ template?: EventSubscriptionTemplate;
1047
+ updated_at?: string;
1048
+ };
1049
+ /** @returns {EventSubscriptions} */
1050
+ declare function EventSubscriptions(): EventSubscriptions;
1051
+ type EventSubscriptions = {
1052
+ items?: EventSubscription[];
1053
+ page?: Page;
1054
+ };
1055
+ /** @returns {EventSubscriptionTemplate} */
1056
+ declare function EventSubscriptionTemplate(): EventSubscriptionTemplate;
1057
+ type EventSubscriptionTemplate = {
1058
+ email?: EventSubscriptionTemplateEmail;
1059
+ sms?: EventSubscriptionTemplateSms;
1060
+ };
1061
+ /** @returns {EventSubscriptionTemplateEmail} */
1062
+ declare function EventSubscriptionTemplateEmail(): EventSubscriptionTemplateEmail;
1063
+ type EventSubscriptionTemplateEmail = {
1064
+ subscribed?: boolean;
1065
+ template?: string;
1066
+ };
1067
+ /** @returns {EventSubscriptionTemplateSms} */
1068
+ declare function EventSubscriptionTemplateSms(): EventSubscriptionTemplateSms;
1069
+ type EventSubscriptionTemplateSms = {
1070
+ subscribed?: boolean;
1071
+ template?: string;
1072
+ };
1073
+ /** @returns {GetNRecordsCsvReq} */
1074
+ declare function GetNRecordsCsvReq(): GetNRecordsCsvReq;
1075
+ type GetNRecordsCsvReq = {
1076
+ count?: number;
1077
+ header?: boolean;
1078
+ url?: string;
1079
+ };
1080
+ /** @returns {GetNRecordsCsvRes} */
1081
+ declare function GetNRecordsCsvRes(): GetNRecordsCsvRes;
1082
+ type GetNRecordsCsvRes = {
1083
+ items?: GetNRecordsCsvResItems[];
1084
+ };
1085
+ /** @returns {GetNRecordsCsvResItems} */
1086
+ declare function GetNRecordsCsvResItems(): GetNRecordsCsvResItems;
1087
+ type GetNRecordsCsvResItems = {
1088
+ email?: string;
1089
+ firstname?: string;
1090
+ lastname?: string;
1091
+ orderid?: string;
1092
+ phone_number?: string;
1093
+ };
1094
+ /** @returns {GetStats} */
1095
+ declare function GetStats(): GetStats;
1096
+ type GetStats = {
1097
+ items?: Stats[];
1098
+ };
1099
+ /** @returns {Job} */
1100
+ declare function Job(): Job;
1101
+ type Job = {
1102
+ __v?: number;
1103
+ _id?: string;
1104
+ application?: string;
1105
+ campaign?: string;
1106
+ completed?: boolean;
1107
+ created_at?: string;
1108
+ is_active?: boolean;
1109
+ updated_at?: string;
1110
+ };
1111
+ /** @returns {JobLog} */
1112
+ declare function JobLog(): JobLog;
1113
+ type JobLog = {
1114
+ __v?: number;
1115
+ _id?: string;
1116
+ campaign?: string;
1117
+ created_at?: string;
1118
+ imported?: any;
1119
+ job?: string;
1120
+ processed?: any;
1121
+ updated_at?: string;
1122
+ };
1123
+ /** @returns {JobLogs} */
1124
+ declare function JobLogs(): JobLogs;
1125
+ type JobLogs = {
1126
+ items?: JobLog[];
1127
+ page?: Page;
1128
+ };
1129
+ /** @returns {Jobs} */
1130
+ declare function Jobs(): Jobs;
1131
+ type Jobs = {
1132
+ items?: Job[];
1133
+ page?: Page;
1134
+ };
1135
+ /** @returns {Log} */
1136
+ declare function Log(): Log;
1137
+ type Log = {
1138
+ _id?: string;
1139
+ application?: string;
1140
+ channel_type?: string;
1141
+ created_at?: string;
1142
+ data?: any;
1143
+ email?: LogEmail;
1144
+ expire_at?: string;
1145
+ meta?: LogMeta;
1146
+ pushnotification?: LogPushnotification;
1147
+ service?: string;
1148
+ source?: string;
1149
+ status?: string;
1150
+ step?: string;
1151
+ };
1152
+ /** @returns {LogEmail} */
1153
+ declare function LogEmail(): LogEmail;
1154
+ type LogEmail = {
1155
+ template?: string;
1156
+ };
1157
+ /** @returns {LogMeta} */
1158
+ declare function LogMeta(): LogMeta;
1159
+ type LogMeta = {
1160
+ identifier?: string;
1161
+ key?: string;
1162
+ offset?: string;
1163
+ partition?: string;
1164
+ topic?: string;
1165
+ type?: string;
1166
+ };
1167
+ /** @returns {LogPushnotification} */
1168
+ declare function LogPushnotification(): LogPushnotification;
1169
+ type LogPushnotification = {
1170
+ pushtokens?: string[];
1171
+ };
1172
+ /** @returns {Logs} */
1173
+ declare function Logs(): Logs;
1174
+ type Logs = {
1175
+ items?: Log[];
1176
+ page?: Page;
1177
+ };
1178
+ /** @returns {MetaStructure} */
1179
+ declare function MetaStructure(): MetaStructure;
1180
+ type MetaStructure = {
1181
+ action?: string;
1182
+ job_type?: string;
1183
+ timestamp?: string;
1184
+ trace?: string;
1185
+ };
1186
+ /** @returns {NotFound} */
1187
+ declare function NotFound(): NotFound;
1188
+ type NotFound = {
1189
+ /**
1190
+ * - Failure message.
1191
+ */
1192
+ message?: string;
1193
+ };
1194
+ /** @returns {Notification} */
1195
+ declare function Notification(): Notification;
1196
+ type Notification = {
1197
+ body?: string;
1198
+ click_action?: string;
1199
+ deeplink?: string;
1200
+ icon?: string;
1201
+ subtitle?: string;
1202
+ title?: string;
1203
+ };
1204
+ /** @returns {Page} */
1205
+ declare function Page(): Page;
1206
+ type Page = {
1207
+ current?: number;
1208
+ has_next?: boolean;
1209
+ has_previous?: boolean;
1210
+ item_total?: number;
1211
+ next_id?: string;
1212
+ size?: number;
1213
+ type: string;
1214
+ };
1215
+ /** @returns {PayloadEmailProviderStructure} */
1216
+ declare function PayloadEmailProviderStructure(): PayloadEmailProviderStructure;
1217
+ type PayloadEmailProviderStructure = {
1218
+ _id?: string;
1219
+ };
1220
+ /** @returns {PayloadEmailStructure} */
1221
+ declare function PayloadEmailStructure(): PayloadEmailStructure;
1222
+ type PayloadEmailStructure = {
1223
+ provider?: PayloadEmailProviderStructure;
1224
+ template?: PayloadEmailTemplateStructure;
1225
+ };
1226
+ /** @returns {PayloadEmailTemplateStructure} */
1227
+ declare function PayloadEmailTemplateStructure(): PayloadEmailTemplateStructure;
1228
+ type PayloadEmailTemplateStructure = {
1229
+ key?: string;
1230
+ value?: any;
1231
+ };
1232
+ /** @returns {PayloadSmsProviderStructure} */
1233
+ declare function PayloadSmsProviderStructure(): PayloadSmsProviderStructure;
1234
+ type PayloadSmsProviderStructure = {
1235
+ _id?: string;
1236
+ };
1237
+ /** @returns {PayloadSmsStructure} */
1238
+ declare function PayloadSmsStructure(): PayloadSmsStructure;
1239
+ type PayloadSmsStructure = {
1240
+ provider?: PayloadSmsProviderStructure;
1241
+ template?: PayloadSmsTemplateStructure;
1242
+ };
1243
+ /** @returns {PayloadSmsTemplateStructure} */
1244
+ declare function PayloadSmsTemplateStructure(): PayloadSmsTemplateStructure;
1245
+ type PayloadSmsTemplateStructure = {
1246
+ key?: string;
1247
+ value?: any;
1248
+ };
1249
+ /** @returns {PayloadStructure} */
1250
+ declare function PayloadStructure(): PayloadStructure;
1251
+ type PayloadStructure = {
1252
+ application?: string;
1253
+ data?: any[];
1254
+ email?: PayloadEmailStructure;
1255
+ sms?: PayloadSmsStructure;
1256
+ };
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
+ /** @returns {RecipientHeaders} */
1281
+ declare function RecipientHeaders(): RecipientHeaders;
1282
+ type RecipientHeaders = {
1283
+ email?: string;
1284
+ };
1285
+ /** @returns {SendOtpCommsReq} */
1286
+ declare function SendOtpCommsReq(): SendOtpCommsReq;
1287
+ type SendOtpCommsReq = {
1288
+ data?: SendOtpCommsReqData;
1289
+ email?: SendOtpCommsReqEmail;
1290
+ sms?: SendOtpCommsReqSms;
1291
+ };
1292
+ /** @returns {SendOtpCommsReqData} */
1293
+ declare function SendOtpCommsReqData(): SendOtpCommsReqData;
1294
+ type SendOtpCommsReqData = {
1295
+ country_code?: string;
1296
+ mobile?: string;
1297
+ send_same_otp_to_channel?: boolean;
1298
+ to?: string;
1299
+ };
1300
+ /** @returns {SendOtpCommsReqEmail} */
1301
+ declare function SendOtpCommsReqEmail(): SendOtpCommsReqEmail;
1302
+ type SendOtpCommsReqEmail = {
1303
+ expiry?: number;
1304
+ otp_length?: number;
1305
+ provider?: SendOtpEmailCommsProvider;
1306
+ template?: SendOtpEmailCommsTemplate;
1307
+ };
1308
+ /** @returns {SendOtpCommsReqSms} */
1309
+ declare function SendOtpCommsReqSms(): SendOtpCommsReqSms;
1310
+ type SendOtpCommsReqSms = {
1311
+ expiry?: number;
1312
+ otp_length?: number;
1313
+ provider?: SendOtpSmsCommsProvider;
1314
+ template?: SendOtpSmsCommsTemplate;
1315
+ };
1316
+ /** @returns {SendOtpCommsRes} */
1317
+ declare function SendOtpCommsRes(): SendOtpCommsRes;
1318
+ type SendOtpCommsRes = {
1319
+ email?: SendOtpCommsResEmail;
1320
+ sms?: SendOtpCommsResSms;
1321
+ };
1322
+ /** @returns {SendOtpCommsResEmail} */
1323
+ declare function SendOtpCommsResEmail(): SendOtpCommsResEmail;
1324
+ type SendOtpCommsResEmail = {
1325
+ message?: string;
1326
+ request_id?: string;
1327
+ resend_timer?: number;
1328
+ success?: boolean;
1329
+ to?: string;
1330
+ };
1331
+ /** @returns {SendOtpCommsResSms} */
1332
+ declare function SendOtpCommsResSms(): SendOtpCommsResSms;
1333
+ type SendOtpCommsResSms = {
1334
+ country_code?: string;
1335
+ message?: string;
1336
+ mobile?: string;
1337
+ request_id?: string;
1338
+ resend_timer?: number;
1339
+ success?: boolean;
1340
+ };
1341
+ /** @returns {SendOtpEmailCommsProvider} */
1342
+ declare function SendOtpEmailCommsProvider(): SendOtpEmailCommsProvider;
1343
+ type SendOtpEmailCommsProvider = {
1344
+ _id?: string;
1345
+ slug?: string;
1346
+ };
1347
+ /** @returns {SendOtpEmailCommsTemplate} */
1348
+ declare function SendOtpEmailCommsTemplate(): SendOtpEmailCommsTemplate;
1349
+ type SendOtpEmailCommsTemplate = {
1350
+ key?: string;
1351
+ value?: any;
1352
+ };
1353
+ /** @returns {SendOtpSmsCommsProvider} */
1354
+ declare function SendOtpSmsCommsProvider(): SendOtpSmsCommsProvider;
1355
+ type SendOtpSmsCommsProvider = {
1356
+ _id?: string;
1357
+ slug?: string;
1358
+ };
1359
+ /** @returns {SendOtpSmsCommsTemplate} */
1360
+ declare function SendOtpSmsCommsTemplate(): SendOtpSmsCommsTemplate;
1361
+ type SendOtpSmsCommsTemplate = {
1362
+ key?: string;
1363
+ value?: any;
1364
+ };
1365
+ /** @returns {SmsProvider} */
1366
+ declare function SmsProvider(): SmsProvider;
1367
+ type SmsProvider = {
1368
+ __v?: number;
1369
+ _id?: string;
1370
+ application?: string;
1371
+ authkey?: string;
1372
+ created_at?: string;
1373
+ description?: string;
1374
+ name?: string;
1375
+ provider?: string;
1376
+ rpt?: number;
1377
+ sender?: string;
1378
+ slug?: string;
1379
+ type?: string;
1380
+ updated_at?: string;
1381
+ username?: string;
1382
+ };
1383
+ /** @returns {SmsProviderReq} */
1384
+ declare function SmsProviderReq(): SmsProviderReq;
1385
+ type SmsProviderReq = {
1386
+ authkey?: string;
1387
+ description?: string;
1388
+ name?: string;
1389
+ provider?: string;
1390
+ sender?: string;
1391
+ type?: string;
1392
+ username?: string;
1393
+ };
1394
+ /** @returns {SmsProviders} */
1395
+ declare function SmsProviders(): SmsProviders;
1396
+ type SmsProviders = {
1397
+ items?: SmsProvider[];
1398
+ page?: Page;
1399
+ };
1400
+ /** @returns {SmsTemplate} */
1401
+ declare function SmsTemplate(): SmsTemplate;
1402
+ type SmsTemplate = {
1403
+ __v?: number;
1404
+ _id?: string;
1405
+ created_at?: string;
1406
+ description?: string;
1407
+ is_internal?: boolean;
1408
+ is_system?: boolean;
1409
+ message?: SmsTemplateMessage;
1410
+ name?: string;
1411
+ priority?: string;
1412
+ published?: boolean;
1413
+ slug?: string;
1414
+ tags?: any[];
1415
+ template_variables?: any;
1416
+ 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;
1429
+ };
1430
+ /** @returns {SmsTemplateMessage} */
1431
+ declare function SmsTemplateMessage(): SmsTemplateMessage;
1432
+ type SmsTemplateMessage = {
1433
+ template?: string;
1434
+ template_type?: string;
1435
+ };
1436
+ /** @returns {SmsTemplateReq} */
1437
+ declare function SmsTemplateReq(): SmsTemplateReq;
1438
+ type SmsTemplateReq = {
1439
+ attachments?: any[];
1440
+ description?: string;
1441
+ 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;
1457
+ priority?: string;
1458
+ published?: boolean;
1459
+ slug?: string;
1460
+ tags?: any[];
1461
+ template_variables?: any;
1462
+ updated_at?: string;
1463
+ };
1464
+ /** @returns {SmsTemplates} */
1465
+ declare function SmsTemplates(): SmsTemplates;
1466
+ type SmsTemplates = {
1467
+ items?: SmsTemplate[];
1468
+ page?: Page;
1469
+ };
1470
+ /** @returns {Stats} */
1471
+ declare function Stats(): Stats;
1472
+ type Stats = {
1473
+ _id?: string;
1474
+ imported?: any;
1475
+ processed?: any;
1476
+ };
1477
+ /** @returns {StatsImported} */
1478
+ declare function StatsImported(): StatsImported;
1479
+ type StatsImported = {
1480
+ count?: number;
1481
+ };
1482
+ /** @returns {StatsProcessed} */
1483
+ declare function StatsProcessed(): StatsProcessed;
1484
+ type StatsProcessed = {
1485
+ email?: StatsProcessedEmail;
1486
+ sms?: StatsProcessedSms;
1487
+ };
1488
+ /** @returns {StatsProcessedEmail} */
1489
+ declare function StatsProcessedEmail(): StatsProcessedEmail;
1490
+ type StatsProcessedEmail = {
1491
+ failed?: number;
1492
+ success?: number;
1493
+ suppressed?: number;
1494
+ };
1495
+ /** @returns {StatsProcessedSms} */
1496
+ declare function StatsProcessedSms(): StatsProcessedSms;
1497
+ type StatsProcessedSms = {
1498
+ failed?: number;
1499
+ success?: number;
1500
+ suppressed?: number;
1501
+ };
1502
+ /** @returns {SystemEmailTemplate} */
1503
+ declare function SystemEmailTemplate(): SystemEmailTemplate;
1504
+ type SystemEmailTemplate = {
1505
+ __v?: number;
1506
+ _id?: string;
1507
+ attachments?: any[];
1508
+ created_at?: string;
1509
+ description?: string;
1510
+ from_name?: string;
1511
+ headers?: any[];
1512
+ html?: TemplateAndType;
1513
+ is_internal?: boolean;
1514
+ is_system?: boolean;
1515
+ name?: string;
1516
+ priority?: string;
1517
+ published?: boolean;
1518
+ slug?: string;
1519
+ static_bcc?: any[];
1520
+ static_cc?: any[];
1521
+ static_to?: any[];
1522
+ subject?: TemplateAndType;
1523
+ tags?: any[];
1524
+ text?: TemplateAndType;
1525
+ updated_at?: string;
1526
+ };
1527
+ /** @returns {SystemEmailTemplates} */
1528
+ declare function SystemEmailTemplates(): SystemEmailTemplates;
1529
+ type SystemEmailTemplates = {
1530
+ items?: SystemEmailTemplate[];
1531
+ page?: Page;
1532
+ };
1533
+ /** @returns {SystemNotification} */
1534
+ declare function SystemNotification(): SystemNotification;
1535
+ type SystemNotification = {
1536
+ _id?: string;
1537
+ created_at?: string;
1538
+ group?: string;
1539
+ notification?: Notification;
1540
+ settings?: SystemNotificationUser;
1541
+ user?: SystemNotificationUser;
1542
+ };
1543
+ /** @returns {SystemNotifications} */
1544
+ declare function SystemNotifications(): SystemNotifications;
1545
+ type SystemNotifications = {
1546
+ items?: SystemNotification[];
1547
+ last_read_anchor?: number;
1548
+ page?: Page;
1549
+ };
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
+ /** @returns {SystemNotificationUser} */
1567
+ declare function SystemNotificationUser(): SystemNotificationUser;
1568
+ type SystemNotificationUser = {
1569
+ type?: string;
1570
+ value?: string;
1571
+ };
1572
+ /** @returns {SystemSmsTemplate} */
1573
+ declare function SystemSmsTemplate(): SystemSmsTemplate;
1574
+ type SystemSmsTemplate = {
1575
+ __v?: number;
1576
+ _id?: string;
1577
+ created_at?: string;
1578
+ description?: string;
1579
+ is_internal?: boolean;
1580
+ is_system?: boolean;
1581
+ message?: SmsTemplateMessage;
1582
+ name?: string;
1583
+ priority?: string;
1584
+ published?: boolean;
1585
+ slug?: string;
1586
+ tags?: any[];
1587
+ template_variables?: any;
1588
+ updated_at?: string;
1589
+ };
1590
+ /** @returns {SystemSmsTemplates} */
1591
+ declare function SystemSmsTemplates(): SystemSmsTemplates;
1592
+ type SystemSmsTemplates = {
1593
+ items?: SystemSmsTemplate[];
1594
+ page?: Page;
1595
+ };
1596
+ /** @returns {TemplateAndType} */
1597
+ declare function TemplateAndType(): TemplateAndType;
1598
+ type TemplateAndType = {
1599
+ template?: string;
1600
+ template_type?: string;
1601
+ };
1602
+ /** @returns {TriggerJobRequest} */
1603
+ declare function TriggerJobRequest(): TriggerJobRequest;
1604
+ type TriggerJobRequest = {
1605
+ job_id?: string;
1606
+ };
1607
+ /** @returns {TriggerJobResponse} */
1608
+ declare function TriggerJobResponse(): TriggerJobResponse;
1609
+ type TriggerJobResponse = {
1610
+ status?: number;
1611
+ };
1612
+ /** @returns {VerifyOtpCommsErrorRes} */
1613
+ declare function VerifyOtpCommsErrorRes(): VerifyOtpCommsErrorRes;
1614
+ type VerifyOtpCommsErrorRes = {
1615
+ message?: string;
1616
+ success?: boolean;
1617
+ };
1618
+ /** @returns {VerifyOtpCommsReq} */
1619
+ declare function VerifyOtpCommsReq(): VerifyOtpCommsReq;
1620
+ type VerifyOtpCommsReq = {
1621
+ otp?: string;
1622
+ request_id?: string;
1623
+ };
1624
+ /** @returns {VerifyOtpCommsSuccessRes} */
1625
+ declare function VerifyOtpCommsSuccessRes(): VerifyOtpCommsSuccessRes;
1626
+ type VerifyOtpCommsSuccessRes = {
1627
+ country_code?: string;
1628
+ message?: string;
1629
+ mobile?: string;
1630
+ success?: boolean;
1631
+ };