@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (318) hide show
  1. package/documentation/application/CART.md +5934 -4502
  2. package/documentation/application/CATALOG.md +6338 -7245
  3. package/documentation/application/COMMON.md +95 -222
  4. package/documentation/application/COMMUNICATION.md +106 -186
  5. package/documentation/application/CONFIGURATION.md +903 -1597
  6. package/documentation/application/CONTENT.md +562 -1270
  7. package/documentation/application/FILESTORAGE.md +84 -220
  8. package/documentation/application/LEAD.md +314 -660
  9. package/documentation/application/LOGISTIC.md +229 -305
  10. package/documentation/application/ORDER.md +642 -1137
  11. package/documentation/application/PAYMENT.md +2285 -3031
  12. package/documentation/application/POSCART.md +6079 -4642
  13. package/documentation/application/REWARDS.md +94 -248
  14. package/documentation/application/SHARE.md +152 -250
  15. package/documentation/application/THEME.md +952 -1235
  16. package/documentation/application/USER.md +1228 -1765
  17. package/documentation/platform/ANALYTICS.md +207 -349
  18. package/documentation/platform/AUDITTRAIL.md +121 -204
  19. package/documentation/platform/BILLING.md +865 -1376
  20. package/documentation/platform/CART.md +2814 -3662
  21. package/documentation/platform/CATALOG.md +15266 -17619
  22. package/documentation/platform/COMMON.md +95 -222
  23. package/documentation/platform/COMMUNICATION.md +1632 -2380
  24. package/documentation/platform/COMPANYPROFILE.md +572 -957
  25. package/documentation/platform/CONFIGURATION.md +3050 -4073
  26. package/documentation/platform/CONTENT.md +3509 -4121
  27. package/documentation/platform/DISCOUNT.md +140 -236
  28. package/documentation/platform/FILESTORAGE.md +187 -323
  29. package/documentation/platform/INVENTORY.md +268 -911
  30. package/documentation/platform/LEAD.md +2195 -2541
  31. package/documentation/platform/ORDER.md +3750 -5636
  32. package/documentation/platform/PARTNER.md +9 -36
  33. package/documentation/platform/PAYMENT.md +903 -1213
  34. package/documentation/platform/REWARDS.md +183 -347
  35. package/documentation/platform/SHARE.md +120 -213
  36. package/documentation/platform/THEME.md +12956 -13239
  37. package/documentation/platform/USER.md +975 -1120
  38. package/documentation/platform/WEBHOOK.md +78 -184
  39. package/documentation/public/CONFIGURATION.md +95 -222
  40. package/documentation/public/INVENTORY.md +100 -282
  41. package/documentation/public/WEBHOOK.md +27 -133
  42. package/package.json +1 -1
  43. package/sdk/application/ApplicationConfig.js +1 -1
  44. package/sdk/application/Cart/CartApplicationClient.d.ts +243 -243
  45. package/sdk/application/Cart/CartApplicationClient.js +1058 -547
  46. package/sdk/application/Cart/CartApplicationModel.d.ts +64 -63
  47. package/sdk/application/Cart/CartApplicationModel.js +489 -886
  48. package/sdk/application/Cart/CartApplicationValidator.d.ts +17 -17
  49. package/sdk/application/Cart/CartApplicationValidator.js +98 -98
  50. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +358 -358
  51. package/sdk/application/Catalog/CatalogApplicationClient.js +1545 -949
  52. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +90 -90
  53. package/sdk/application/Catalog/CatalogApplicationModel.js +692 -1258
  54. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +19 -19
  55. package/sdk/application/Catalog/CatalogApplicationValidator.js +110 -110
  56. package/sdk/application/Common/CommonApplicationClient.d.ts +13 -13
  57. package/sdk/application/Common/CommonApplicationClient.js +76 -36
  58. package/sdk/application/Common/CommonApplicationModel.d.ts +12 -12
  59. package/sdk/application/Common/CommonApplicationModel.js +83 -160
  60. package/sdk/application/Common/CommonApplicationValidator.d.ts +1 -1
  61. package/sdk/application/Common/CommonApplicationValidator.js +6 -6
  62. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +11 -11
  63. package/sdk/application/Communication/CommunicationApplicationClient.js +92 -31
  64. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +6 -6
  65. package/sdk/application/Communication/CommunicationApplicationModel.js +38 -83
  66. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
  67. package/sdk/application/Communication/CommunicationApplicationValidator.js +4 -4
  68. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +116 -116
  69. package/sdk/application/Configuration/ConfigurationApplicationClient.js +638 -312
  70. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +85 -85
  71. package/sdk/application/Configuration/ConfigurationApplicationModel.js +480 -851
  72. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +8 -8
  73. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +33 -33
  74. package/sdk/application/Content/ContentApplicationClient.d.ts +67 -67
  75. package/sdk/application/Content/ContentApplicationClient.js +581 -213
  76. package/sdk/application/Content/ContentApplicationModel.d.ts +76 -75
  77. package/sdk/application/Content/ContentApplicationModel.js +468 -875
  78. package/sdk/application/Content/ContentApplicationValidator.d.ts +5 -5
  79. package/sdk/application/Content/ContentApplicationValidator.js +24 -24
  80. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +25 -25
  81. package/sdk/application/FileStorage/FileStorageApplicationClient.js +121 -59
  82. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +13 -13
  83. package/sdk/application/FileStorage/FileStorageApplicationModel.js +86 -169
  84. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
  85. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +7 -7
  86. package/sdk/application/Lead/LeadApplicationClient.d.ts +24 -24
  87. package/sdk/application/Lead/LeadApplicationClient.js +230 -96
  88. package/sdk/application/Lead/LeadApplicationModel.d.ts +35 -35
  89. package/sdk/application/Lead/LeadApplicationModel.js +267 -474
  90. package/sdk/application/Lead/LeadApplicationValidator.d.ts +2 -2
  91. package/sdk/application/Lead/LeadApplicationValidator.js +11 -11
  92. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +30 -19
  93. package/sdk/application/Logistic/LogisticApplicationClient.js +196 -47
  94. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +17 -14
  95. package/sdk/application/Logistic/LogisticApplicationModel.js +133 -201
  96. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +3 -2
  97. package/sdk/application/Logistic/LogisticApplicationValidator.js +14 -8
  98. package/sdk/application/Order/OrderApplicationClient.d.ts +86 -86
  99. package/sdk/application/Order/OrderApplicationClient.js +448 -215
  100. package/sdk/application/Order/OrderApplicationModel.d.ts +50 -50
  101. package/sdk/application/Order/OrderApplicationModel.js +357 -661
  102. package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -7
  103. package/sdk/application/Order/OrderApplicationValidator.js +28 -28
  104. package/sdk/application/Payment/PaymentApplicationClient.d.ts +318 -318
  105. package/sdk/application/Payment/PaymentApplicationClient.js +1525 -750
  106. package/sdk/application/Payment/PaymentApplicationModel.d.ts +72 -72
  107. package/sdk/application/Payment/PaymentApplicationModel.js +565 -1033
  108. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +28 -28
  109. package/sdk/application/Payment/PaymentApplicationValidator.js +107 -107
  110. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +254 -254
  111. package/sdk/application/PosCart/PosCartApplicationClient.js +1137 -606
  112. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +61 -60
  113. package/sdk/application/PosCart/PosCartApplicationModel.js +477 -873
  114. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +18 -18
  115. package/sdk/application/PosCart/PosCartApplicationValidator.js +103 -103
  116. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +27 -27
  117. package/sdk/application/Rewards/RewardsApplicationClient.js +253 -113
  118. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +14 -14
  119. package/sdk/application/Rewards/RewardsApplicationModel.js +96 -191
  120. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +3 -3
  121. package/sdk/application/Rewards/RewardsApplicationValidator.js +12 -12
  122. package/sdk/application/Share/ShareApplicationClient.d.ts +37 -37
  123. package/sdk/application/Share/ShareApplicationClient.js +221 -96
  124. package/sdk/application/Share/ShareApplicationModel.d.ts +8 -8
  125. package/sdk/application/Share/ShareApplicationModel.js +63 -123
  126. package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -4
  127. package/sdk/application/Share/ShareApplicationValidator.js +12 -12
  128. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  129. package/sdk/application/Theme/ThemeApplicationClient.js +115 -37
  130. package/sdk/application/Theme/ThemeApplicationModel.d.ts +34 -34
  131. package/sdk/application/Theme/ThemeApplicationModel.js +190 -336
  132. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +1 -1
  133. package/sdk/application/Theme/ThemeApplicationValidator.js +4 -4
  134. package/sdk/application/User/UserApplicationClient.d.ts +280 -280
  135. package/sdk/application/User/UserApplicationClient.js +1201 -543
  136. package/sdk/application/User/UserApplicationModel.d.ts +79 -72
  137. package/sdk/application/User/UserApplicationModel.js +440 -689
  138. package/sdk/application/User/UserApplicationValidator.d.ts +24 -24
  139. package/sdk/application/User/UserApplicationValidator.js +89 -89
  140. package/sdk/common/AxiosHelper.js +1 -1
  141. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +55 -47
  142. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +308 -151
  143. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +6 -6
  144. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +20 -20
  145. package/sdk/platform/Analytics/AnalyticsPlatformClient.d.ts +8 -4
  146. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +103 -16
  147. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +11 -11
  148. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +95 -178
  149. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +16 -12
  150. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +131 -44
  151. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +10 -10
  152. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +50 -89
  153. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
  154. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +6 -6
  155. package/sdk/platform/Billing/BillingPlatformClient.d.ts +68 -56
  156. package/sdk/platform/Billing/BillingPlatformClient.js +416 -171
  157. package/sdk/platform/Billing/BillingPlatformModel.d.ts +40 -40
  158. package/sdk/platform/Billing/BillingPlatformModel.js +342 -668
  159. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +8 -8
  160. package/sdk/platform/Billing/BillingPlatformValidator.js +25 -25
  161. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +176 -159
  162. package/sdk/platform/Cart/CartPlatformApplicationClient.js +837 -500
  163. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -11
  164. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +63 -63
  165. package/sdk/platform/Cart/CartPlatformModel.d.ts +86 -85
  166. package/sdk/platform/Cart/CartPlatformModel.js +677 -1211
  167. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +582 -529
  168. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2642 -1533
  169. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +40 -40
  170. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +175 -175
  171. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +708 -590
  172. package/sdk/platform/Catalog/CatalogPlatformClient.js +3103 -1362
  173. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +293 -284
  174. package/sdk/platform/Catalog/CatalogPlatformModel.js +2149 -3660
  175. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +66 -64
  176. package/sdk/platform/Catalog/CatalogPlatformValidator.js +235 -216
  177. package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -12
  178. package/sdk/platform/Common/CommonPlatformClient.js +80 -37
  179. package/sdk/platform/Common/CommonPlatformModel.d.ts +12 -12
  180. package/sdk/platform/Common/CommonPlatformModel.js +83 -160
  181. package/sdk/platform/Common/CommonPlatformValidator.d.ts +1 -1
  182. package/sdk/platform/Common/CommonPlatformValidator.js +6 -6
  183. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +333 -293
  184. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1687 -855
  185. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +30 -30
  186. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +87 -87
  187. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
  188. package/sdk/platform/Communication/CommunicationPlatformClient.js +28 -4
  189. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +67 -67
  190. package/sdk/platform/Communication/CommunicationPlatformModel.js +522 -974
  191. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +70 -57
  192. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +463 -182
  193. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +28 -28
  194. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +294 -557
  195. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +7 -7
  196. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +24 -24
  197. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +175 -137
  198. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1168 -521
  199. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +22 -21
  200. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +69 -63
  201. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +137 -119
  202. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +691 -316
  203. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +148 -146
  204. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +854 -1508
  205. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -9
  206. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +38 -38
  207. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +542 -461
  208. package/sdk/platform/Content/ContentPlatformApplicationClient.js +2600 -1160
  209. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +50 -49
  210. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +159 -152
  211. package/sdk/platform/Content/ContentPlatformModel.d.ts +79 -75
  212. package/sdk/platform/Content/ContentPlatformModel.js +486 -867
  213. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +72 -61
  214. package/sdk/platform/Discount/DiscountPlatformClient.js +424 -198
  215. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +7 -7
  216. package/sdk/platform/Discount/DiscountPlatformModel.js +60 -121
  217. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +6 -6
  218. package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -29
  219. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +26 -22
  220. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +145 -59
  221. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  222. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +8 -8
  223. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +58 -52
  224. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +240 -114
  225. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -13
  226. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +86 -169
  227. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +3 -3
  228. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -11
  229. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +76 -63
  230. package/sdk/platform/Inventory/InventoryPlatformClient.js +461 -197
  231. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +30 -30
  232. package/sdk/platform/Inventory/InventoryPlatformModel.js +497 -964
  233. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +7 -7
  234. package/sdk/platform/Inventory/InventoryPlatformValidator.js +28 -28
  235. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +84 -71
  236. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +441 -182
  237. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +7 -7
  238. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +28 -28
  239. package/sdk/platform/Lead/LeadPlatformClient.d.ts +86 -75
  240. package/sdk/platform/Lead/LeadPlatformClient.js +434 -212
  241. package/sdk/platform/Lead/LeadPlatformModel.d.ts +35 -35
  242. package/sdk/platform/Lead/LeadPlatformModel.js +267 -474
  243. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +6 -6
  244. package/sdk/platform/Lead/LeadPlatformValidator.js +24 -24
  245. package/sdk/platform/OAuthClient.js +8 -8
  246. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +14 -11
  247. package/sdk/platform/Order/OrderPlatformApplicationClient.js +113 -49
  248. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -1
  249. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +6 -6
  250. package/sdk/platform/Order/OrderPlatformClient.d.ts +367 -315
  251. package/sdk/platform/Order/OrderPlatformClient.js +1775 -893
  252. package/sdk/platform/Order/OrderPlatformModel.d.ts +198 -192
  253. package/sdk/platform/Order/OrderPlatformModel.js +1591 -2822
  254. package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -32
  255. package/sdk/platform/Order/OrderPlatformValidator.js +160 -155
  256. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -2
  257. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +52 -8
  258. package/sdk/platform/Partner/PartnerPlatformModel.js +6 -22
  259. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +65 -54
  260. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +395 -164
  261. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -6
  262. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +23 -23
  263. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +55 -45
  264. package/sdk/platform/Payment/PaymentPlatformClient.js +362 -147
  265. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -27
  266. package/sdk/platform/Payment/PaymentPlatformModel.js +220 -408
  267. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +4 -4
  268. package/sdk/platform/Payment/PaymentPlatformValidator.js +21 -21
  269. package/sdk/platform/PlatformApplicationClient.d.ts +1496 -10153
  270. package/sdk/platform/PlatformApplicationClient.js +1584 -13691
  271. package/sdk/platform/PlatformClient.d.ts +7918 -7666
  272. package/sdk/platform/PlatformClient.js +8701 -9926
  273. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +91 -78
  274. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +507 -253
  275. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +8 -8
  276. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +34 -34
  277. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +15 -15
  278. package/sdk/platform/Rewards/RewardsPlatformModel.js +92 -194
  279. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -12
  280. package/sdk/platform/Share/SharePlatformApplicationClient.js +130 -52
  281. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
  282. package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -6
  283. package/sdk/platform/Share/SharePlatformModel.d.ts +8 -8
  284. package/sdk/platform/Share/SharePlatformModel.js +60 -118
  285. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +148 -124
  286. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +770 -295
  287. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +15 -15
  288. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +44 -44
  289. package/sdk/platform/Theme/ThemePlatformModel.d.ts +34 -34
  290. package/sdk/platform/Theme/ThemePlatformModel.js +190 -336
  291. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +146 -67
  292. package/sdk/platform/User/UserPlatformApplicationClient.js +742 -155
  293. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +12 -7
  294. package/sdk/platform/User/UserPlatformApplicationValidator.js +61 -23
  295. package/sdk/platform/User/UserPlatformModel.d.ts +79 -72
  296. package/sdk/platform/User/UserPlatformModel.js +440 -689
  297. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +35 -29
  298. package/sdk/platform/Webhook/WebhookPlatformClient.js +218 -91
  299. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +7 -7
  300. package/sdk/platform/Webhook/WebhookPlatformModel.js +68 -136
  301. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +3 -3
  302. package/sdk/platform/Webhook/WebhookPlatformValidator.js +14 -14
  303. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +13 -13
  304. package/sdk/public/Configuration/ConfigurationPublicClient.js +81 -38
  305. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +12 -12
  306. package/sdk/public/Configuration/ConfigurationPublicModel.js +85 -162
  307. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -1
  308. package/sdk/public/Configuration/ConfigurationPublicValidator.js +6 -6
  309. package/sdk/public/Inventory/InventoryPublicClient.d.ts +34 -34
  310. package/sdk/public/Inventory/InventoryPublicClient.js +228 -105
  311. package/sdk/public/Inventory/InventoryPublicModel.d.ts +10 -10
  312. package/sdk/public/Inventory/InventoryPublicModel.js +119 -245
  313. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +3 -3
  314. package/sdk/public/Inventory/InventoryPublicValidator.js +15 -15
  315. package/sdk/public/Webhook/WebhookPublicClient.js +51 -10
  316. package/sdk/public/Webhook/WebhookPublicModel.d.ts +7 -7
  317. package/sdk/public/Webhook/WebhookPublicModel.js +68 -136
  318. package/tests/application/catalog.spec.js +7 -0
@@ -5,75 +5,100 @@ declare class Communication {
5
5
  applicationId: any;
6
6
  /**
7
7
  * @param {Object} arg - Arg object.
8
- * @param {number} [arg.pageNo] - Current page no
9
- * @param {number} [arg.pageSize] - Current request items count
10
- * @param {Object} [arg.sort] - To sort based on created_at
11
- * @summary: Get campaigns
12
- * @description: Get campaigns
13
- */
14
- getCampaigns({ pageNo, pageSize, sort }?: {
15
- pageNo?: number;
16
- pageSize?: number;
17
- sort?: any;
18
- }): Promise<any>;
19
- /**
20
- * @param {Object} arg - Arg object.
21
- * @param {string} arg.companyId - Company id
22
- * @param {string} arg.applicationId - Application id
23
- * @param {number} [arg.pageSize] - Current request items count
24
- * @param {Object} [arg.sort] - To sort based on created_at
25
- * @summary: Get campaigns
26
- * @description: Get campaigns
8
+ * @param {AudienceReq} arg.body
9
+ * @returns {Promise<Audience>} - Success response
10
+ * @summary: Create audience
11
+ * @description: Create audience
27
12
  */
28
- getCampaignsPaginator({ companyId, applicationId, pageSize, sort }?: {
29
- companyId: string;
30
- applicationId: string;
31
- pageSize?: number;
32
- sort?: any;
33
- }): Paginator;
13
+ createAudience({ body }?: {
14
+ body: AudienceReq;
15
+ }): Promise<Audience>;
34
16
  /**
35
17
  * @param {Object} arg - Arg object.
36
18
  * @param {CampaignReq} arg.body
19
+ * @returns {Promise<Campaign>} - Success response
37
20
  * @summary: Create campaign
38
21
  * @description: Create campaign
39
22
  */
40
23
  createCampaign({ body }?: {
41
24
  body: CampaignReq;
42
- }): Promise<any>;
25
+ }): Promise<Campaign>;
43
26
  /**
44
27
  * @param {Object} arg - Arg object.
45
- * @param {string} arg.id - Campaign id
46
- * @summary: Get campaign by id
47
- * @description: Get campaign by id
28
+ * @param {EmailProviderReq} arg.body
29
+ * @returns {Promise<EmailProvider>} - Success response
30
+ * @summary: Create email provider
31
+ * @description: Create email provider
48
32
  */
49
- getCampaignById({ id }?: {
33
+ createEmailProvider({ body }?: {
34
+ body: EmailProviderReq;
35
+ }): Promise<EmailProvider>;
36
+ /**
37
+ * @param {Object} arg - Arg object.
38
+ * @param {EmailTemplateReq} arg.body
39
+ * @returns {Promise<EmailTemplateRes>} - Success response
40
+ * @summary: Create email template
41
+ * @description: Create email template
42
+ */
43
+ createEmailTemplate({ body }?: {
44
+ body: EmailTemplateReq;
45
+ }): Promise<EmailTemplateRes>;
46
+ /**
47
+ * @param {Object} arg - Arg object.
48
+ * @param {SmsProviderReq} arg.body
49
+ * @returns {Promise<SmsProvider>} - Success response
50
+ * @summary: Create sms provider
51
+ * @description: Create sms provider
52
+ */
53
+ createSmsProvider({ body }?: {
54
+ body: SmsProviderReq;
55
+ }): Promise<SmsProvider>;
56
+ /**
57
+ * @param {Object} arg - Arg object.
58
+ * @param {SmsTemplateReq} arg.body
59
+ * @returns {Promise<SmsTemplateRes>} - Success response
60
+ * @summary: Create sms template
61
+ * @description: Create sms template
62
+ */
63
+ createSmsTemplate({ body }?: {
64
+ body: SmsTemplateReq;
65
+ }): Promise<SmsTemplateRes>;
66
+ /**
67
+ * @param {Object} arg - Arg object.
68
+ * @param {string} arg.id - Email template id
69
+ * @returns {Promise<EmailTemplateDeleteSuccessRes>} - Success response
70
+ * @summary: Delete email template by id
71
+ * @description: Delete email template by id
72
+ */
73
+ deleteEmailTemplateById({ id }?: {
50
74
  id: string;
51
- }): Promise<any>;
75
+ }): Promise<EmailTemplateDeleteSuccessRes>;
52
76
  /**
53
77
  * @param {Object} arg - Arg object.
54
- * @param {string} arg.id - Campaign id
55
- * @param {CampaignReq} arg.body
56
- * @summary: Update campaign by id
57
- * @description: Update campaign by id
78
+ * @param {string} arg.id - Sms template id
79
+ * @returns {Promise<SmsTemplateDeleteSuccessRes>} - Success response
80
+ * @summary: Delete sms template by id
81
+ * @description: Delete sms template by id
58
82
  */
59
- updateCampaignById({ id, body }?: {
83
+ deleteSmsTemplateById({ id }?: {
60
84
  id: string;
61
- body: CampaignReq;
62
- }): Promise<any>;
85
+ }): Promise<SmsTemplateDeleteSuccessRes>;
63
86
  /**
64
87
  * @param {Object} arg - Arg object.
65
- * @param {string} arg.id - Campaign id
66
- * @summary: Get stats of campaign by id
67
- * @description: Get stats of campaign by id
88
+ * @param {string} arg.id - Audience id
89
+ * @returns {Promise<Audience>} - Success response
90
+ * @summary: Get audience by id
91
+ * @description: Get audience by id
68
92
  */
69
- getStatsOfCampaignById({ id }?: {
93
+ getAudienceById({ id }?: {
70
94
  id: string;
71
- }): Promise<any>;
95
+ }): Promise<Audience>;
72
96
  /**
73
97
  * @param {Object} arg - Arg object.
74
98
  * @param {number} [arg.pageNo] - Current page no
75
99
  * @param {number} [arg.pageSize] - Current request items count
76
100
  * @param {Object} [arg.sort] - To sort based on created_at
101
+ * @returns {Promise<Audiences>} - Success response
77
102
  * @summary: Get audiences
78
103
  * @description: Get audiences
79
104
  */
@@ -81,7 +106,7 @@ declare class Communication {
81
106
  pageNo?: number;
82
107
  pageSize?: number;
83
108
  sort?: any;
84
- }): Promise<any>;
109
+ }): Promise<Audiences>;
85
110
  /**
86
111
  * @param {Object} arg - Arg object.
87
112
  * @param {string} arg.companyId - Company id
@@ -97,76 +122,50 @@ declare class Communication {
97
122
  pageSize?: number;
98
123
  sort?: any;
99
124
  }): Paginator;
100
- /**
101
- * @param {Object} arg - Arg object.
102
- * @param {AudienceReq} arg.body
103
- * @summary: Create audience
104
- * @description: Create audience
105
- */
106
- createAudience({ body }?: {
107
- body: AudienceReq;
108
- }): Promise<any>;
109
125
  /**
110
126
  * @param {Object} arg - Arg object.
111
127
  * @param {BigqueryHeadersReq} arg.body
128
+ * @returns {Promise<BigqueryHeadersRes>} - Success response
112
129
  * @summary: Get bigquery headers
113
130
  * @description: Get bigquery headers
114
131
  */
115
132
  getBigqueryHeaders({ body }?: {
116
133
  body: BigqueryHeadersReq;
117
- }): Promise<any>;
134
+ }): Promise<BigqueryHeadersRes>;
118
135
  /**
119
136
  * @param {Object} arg - Arg object.
120
- * @param {string} arg.id - Audience id
121
- * @summary: Get audience by id
122
- * @description: Get audience by id
137
+ * @param {string} arg.id - Campaign id
138
+ * @returns {Promise<Campaign>} - Success response
139
+ * @summary: Get campaign by id
140
+ * @description: Get campaign by id
123
141
  */
124
- getAudienceById({ id }?: {
142
+ getCampaignById({ id }?: {
125
143
  id: string;
126
- }): Promise<any>;
127
- /**
128
- * @param {Object} arg - Arg object.
129
- * @param {string} arg.id - Audience id
130
- * @param {AudienceReq} arg.body
131
- * @summary: Update audience by id
132
- * @description: Update audience by id
133
- */
134
- updateAudienceById({ id, body }?: {
135
- id: string;
136
- body: AudienceReq;
137
- }): Promise<any>;
138
- /**
139
- * @param {Object} arg - Arg object.
140
- * @param {GetNRecordsCsvReq} arg.body
141
- * @summary: Get n sample records from csv
142
- * @description: Get n sample records from csv
143
- */
144
- getNSampleRecordsFromCsv({ body }?: {
145
- body: GetNRecordsCsvReq;
146
- }): Promise<any>;
144
+ }): Promise<Campaign>;
147
145
  /**
148
146
  * @param {Object} arg - Arg object.
149
147
  * @param {number} [arg.pageNo] - Current page no
150
148
  * @param {number} [arg.pageSize] - Current request items count
151
149
  * @param {Object} [arg.sort] - To sort based on created_at
152
- * @summary: Get email providers
153
- * @description: Get email providers
150
+ * @returns {Promise<Campaigns>} - Success response
151
+ * @summary: Get campaigns
152
+ * @description: Get campaigns
154
153
  */
155
- getEmailProviders({ pageNo, pageSize, sort }?: {
154
+ getCampaigns({ pageNo, pageSize, sort }?: {
156
155
  pageNo?: number;
157
156
  pageSize?: number;
158
157
  sort?: any;
159
- }): Promise<any>;
158
+ }): Promise<Campaigns>;
160
159
  /**
161
160
  * @param {Object} arg - Arg object.
162
161
  * @param {string} arg.companyId - Company id
163
162
  * @param {string} arg.applicationId - Application id
164
163
  * @param {number} [arg.pageSize] - Current request items count
165
164
  * @param {Object} [arg.sort] - To sort based on created_at
166
- * @summary: Get email providers
167
- * @description: Get email providers
165
+ * @summary: Get campaigns
166
+ * @description: Get campaigns
168
167
  */
169
- getEmailProvidersPaginator({ companyId, applicationId, pageSize, sort, }?: {
168
+ getCampaignsPaginator({ companyId, applicationId, pageSize, sort }?: {
170
169
  companyId: string;
171
170
  applicationId: string;
172
171
  pageSize?: number;
@@ -174,93 +173,71 @@ declare class Communication {
174
173
  }): Paginator;
175
174
  /**
176
175
  * @param {Object} arg - Arg object.
177
- * @param {EmailProviderReq} arg.body
178
- * @summary: Create email provider
179
- * @description: Create email provider
180
- */
181
- createEmailProvider({ body }?: {
182
- body: EmailProviderReq;
183
- }): Promise<any>;
184
- /**
185
- * @param {Object} arg - Arg object.
186
- * @param {string} arg.id - Email provider id
187
- * @summary: Get email provider by id
188
- * @description: Get email provider by id
189
- */
190
- getEmailProviderById({ id }?: {
191
- id: string;
192
- }): Promise<any>;
193
- /**
194
- * @param {Object} arg - Arg object.
195
- * @param {string} arg.id - Email provider id
196
- * @param {EmailProviderReq} arg.body
197
- * @summary: Update email provider by id
198
- * @description: Update email provider by id
199
- */
200
- updateEmailProviderById({ id, body }?: {
201
- id: string;
202
- body: EmailProviderReq;
203
- }): Promise<any>;
204
- /**
205
- * @param {Object} arg - Arg object.
206
- * @param {number} [arg.pageNo] - Current page no
176
+ * @param {string} [arg.pageId] - Current page no
207
177
  * @param {number} [arg.pageSize] - Current request items count
208
- * @param {Object} [arg.sort] - To sort based on created_at
209
- * @summary: Get email templates
210
- * @description: Get email templates
178
+ * @param {Object} [arg.sort] - To sort based on _id
179
+ * @param {Object} [arg.query] -
180
+ * @returns {Promise<Logs>} - Success response
181
+ * @summary: Get communication logs
182
+ * @description: Get communication logs
211
183
  */
212
- getEmailTemplates({ pageNo, pageSize, sort }?: {
213
- pageNo?: number;
184
+ getCommunicationLogs({ pageId, pageSize, sort, query }?: {
185
+ pageId?: string;
214
186
  pageSize?: number;
215
187
  sort?: any;
216
- }): Promise<any>;
188
+ query?: any;
189
+ }): Promise<Logs>;
217
190
  /**
218
191
  * @param {Object} arg - Arg object.
219
192
  * @param {string} arg.companyId - Company id
220
193
  * @param {string} arg.applicationId - Application id
221
194
  * @param {number} [arg.pageSize] - Current request items count
222
- * @param {Object} [arg.sort] - To sort based on created_at
223
- * @summary: Get email templates
224
- * @description: Get email templates
195
+ * @param {Object} [arg.sort] - To sort based on _id
196
+ * @param {Object} [arg.query] -
197
+ * @summary: Get communication logs
198
+ * @description: Get communication logs
225
199
  */
226
- getEmailTemplatesPaginator({ companyId, applicationId, pageSize, sort, }?: {
200
+ getCommunicationLogsPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
227
201
  companyId: string;
228
202
  applicationId: string;
229
203
  pageSize?: number;
230
204
  sort?: any;
205
+ query?: any;
231
206
  }): Paginator;
232
207
  /**
233
208
  * @param {Object} arg - Arg object.
234
- * @param {EmailTemplateReq} arg.body
235
- * @summary: Create email template
236
- * @description: Create email template
209
+ * @param {string} arg.id - Email provider id
210
+ * @returns {Promise<EmailProvider>} - Success response
211
+ * @summary: Get email provider by id
212
+ * @description: Get email provider by id
237
213
  */
238
- createEmailTemplate({ body }?: {
239
- body: EmailTemplateReq;
240
- }): Promise<any>;
214
+ getEmailProviderById({ id }?: {
215
+ id: string;
216
+ }): Promise<EmailProvider>;
241
217
  /**
242
218
  * @param {Object} arg - Arg object.
243
219
  * @param {number} [arg.pageNo] - Current page no
244
220
  * @param {number} [arg.pageSize] - Current request items count
245
221
  * @param {Object} [arg.sort] - To sort based on created_at
246
- * @summary: Get system email templates
247
- * @description: Get system email templates
222
+ * @returns {Promise<EmailProviders>} - Success response
223
+ * @summary: Get email providers
224
+ * @description: Get email providers
248
225
  */
249
- getSystemEmailTemplates({ pageNo, pageSize, sort }?: {
226
+ getEmailProviders({ pageNo, pageSize, sort }?: {
250
227
  pageNo?: number;
251
228
  pageSize?: number;
252
229
  sort?: any;
253
- }): Promise<any>;
230
+ }): Promise<EmailProviders>;
254
231
  /**
255
232
  * @param {Object} arg - Arg object.
256
233
  * @param {string} arg.companyId - Company id
257
234
  * @param {string} arg.applicationId - Application id
258
235
  * @param {number} [arg.pageSize] - Current request items count
259
236
  * @param {Object} [arg.sort] - To sort based on created_at
260
- * @summary: Get system email templates
261
- * @description: Get system email templates
237
+ * @summary: Get email providers
238
+ * @description: Get email providers
262
239
  */
263
- getSystemEmailTemplatesPaginator({ companyId, applicationId, pageSize, sort, }?: {
240
+ getEmailProvidersPaginator({ companyId, applicationId, pageSize, sort, }?: {
264
241
  companyId: string;
265
242
  applicationId: string;
266
243
  pageSize?: number;
@@ -269,120 +246,77 @@ declare class Communication {
269
246
  /**
270
247
  * @param {Object} arg - Arg object.
271
248
  * @param {string} arg.id - Email template id
249
+ * @returns {Promise<EmailTemplate>} - Success response
272
250
  * @summary: Get email template by id
273
251
  * @description: Get email template by id
274
252
  */
275
253
  getEmailTemplateById({ id }?: {
276
254
  id: string;
277
- }): Promise<any>;
278
- /**
279
- * @param {Object} arg - Arg object.
280
- * @param {string} arg.id - Email template id
281
- * @param {EmailTemplateReq} arg.body
282
- * @summary: Update email template by id
283
- * @description: Update email template by id
284
- */
285
- updateEmailTemplateById({ id, body }?: {
286
- id: string;
287
- body: EmailTemplateReq;
288
- }): Promise<any>;
289
- /**
290
- * @param {Object} arg - Arg object.
291
- * @param {string} arg.id - Email template id
292
- * @summary: Delete email template by id
293
- * @description: Delete email template by id
294
- */
295
- deleteEmailTemplateById({ id }?: {
296
- id: string;
297
- }): Promise<any>;
298
- /**
299
- * @param {Object} arg - Arg object.
300
- * @param {EngineRequest} arg.body
301
- * @summary: Send email or sms synchronously
302
- * @description: Send email or sms synchronously
303
- */
304
- sendCommunicationSynchronously({ body }?: {
305
- body: EngineRequest;
306
- }): Promise<any>;
307
- /**
308
- * @param {Object} arg - Arg object.
309
- * @param {EngineRequest} arg.body
310
- * @summary: Send email or sms asynchronously
311
- * @description: Send email or sms asynchronously
312
- */
313
- sendCommunicationAsynchronously({ body }?: {
314
- body: EngineRequest;
315
- }): Promise<any>;
255
+ }): Promise<EmailTemplate>;
316
256
  /**
317
257
  * @param {Object} arg - Arg object.
318
258
  * @param {number} [arg.pageNo] - Current page no
319
259
  * @param {number} [arg.pageSize] - Current request items count
320
- * @param {string} [arg.populate] - Populate fields
321
- * @summary: Get event subscriptions
322
- * @description: Get event subscriptions
260
+ * @param {Object} [arg.sort] - To sort based on created_at
261
+ * @returns {Promise<EmailTemplates>} - Success response
262
+ * @summary: Get email templates
263
+ * @description: Get email templates
323
264
  */
324
- getEventSubscriptions({ pageNo, pageSize, populate }?: {
265
+ getEmailTemplates({ pageNo, pageSize, sort }?: {
325
266
  pageNo?: number;
326
267
  pageSize?: number;
327
- populate?: string;
328
- }): Promise<any>;
268
+ sort?: any;
269
+ }): Promise<EmailTemplates>;
329
270
  /**
330
271
  * @param {Object} arg - Arg object.
331
272
  * @param {string} arg.companyId - Company id
332
273
  * @param {string} arg.applicationId - Application id
333
274
  * @param {number} [arg.pageSize] - Current request items count
334
- * @param {string} [arg.populate] - Populate fields
335
- * @summary: Get event subscriptions
336
- * @description: Get event subscriptions
275
+ * @param {Object} [arg.sort] - To sort based on created_at
276
+ * @summary: Get email templates
277
+ * @description: Get email templates
337
278
  */
338
- getEventSubscriptionsPaginator({ companyId, applicationId, pageSize, populate, }?: {
279
+ getEmailTemplatesPaginator({ companyId, applicationId, pageSize, sort, }?: {
339
280
  companyId: string;
340
281
  applicationId: string;
341
282
  pageSize?: number;
342
- populate?: string;
283
+ sort?: any;
343
284
  }): Paginator;
344
285
  /**
345
286
  * @param {Object} arg - Arg object.
346
287
  * @param {number} [arg.pageNo] - Current page no
347
288
  * @param {number} [arg.pageSize] - Current request items count
348
- * @param {Object} [arg.sort] - To sort based on created_at
349
- * @summary: Get jobs
350
- * @description: Get jobs
289
+ * @param {string} [arg.populate] - Populate fields
290
+ * @returns {Promise<EventSubscriptions>} - Success response
291
+ * @summary: Get event subscriptions
292
+ * @description: Get event subscriptions
351
293
  */
352
- getJobs({ pageNo, pageSize, sort }?: {
294
+ getEventSubscriptions({ pageNo, pageSize, populate }?: {
353
295
  pageNo?: number;
354
296
  pageSize?: number;
355
- sort?: any;
356
- }): Promise<any>;
297
+ populate?: string;
298
+ }): Promise<EventSubscriptions>;
357
299
  /**
358
300
  * @param {Object} arg - Arg object.
359
301
  * @param {string} arg.companyId - Company id
360
302
  * @param {string} arg.applicationId - Application id
361
303
  * @param {number} [arg.pageSize] - Current request items count
362
- * @param {Object} [arg.sort] - To sort based on created_at
363
- * @summary: Get jobs
364
- * @description: Get jobs
304
+ * @param {string} [arg.populate] - Populate fields
305
+ * @summary: Get event subscriptions
306
+ * @description: Get event subscriptions
365
307
  */
366
- getJobsPaginator({ companyId, applicationId, pageSize, sort }?: {
308
+ getEventSubscriptionsPaginator({ companyId, applicationId, pageSize, populate, }?: {
367
309
  companyId: string;
368
310
  applicationId: string;
369
311
  pageSize?: number;
370
- sort?: any;
312
+ populate?: string;
371
313
  }): Paginator;
372
- /**
373
- * @param {Object} arg - Arg object.
374
- * @param {TriggerJobRequest} arg.body
375
- * @summary: Trigger campaign job
376
- * @description: Trigger campaign job
377
- */
378
- triggerCampaignJob({ body }?: {
379
- body: TriggerJobRequest;
380
- }): Promise<any>;
381
314
  /**
382
315
  * @param {Object} arg - Arg object.
383
316
  * @param {number} [arg.pageNo] - Current page no
384
317
  * @param {number} [arg.pageSize] - Current request items count
385
318
  * @param {Object} [arg.sort] - To sort based on created_at
319
+ * @returns {Promise<JobLogs>} - Success response
386
320
  * @summary: Get job logs
387
321
  * @description: Get job logs
388
322
  */
@@ -390,7 +324,7 @@ declare class Communication {
390
324
  pageNo?: number;
391
325
  pageSize?: number;
392
326
  sort?: any;
393
- }): Promise<any>;
327
+ }): Promise<JobLogs>;
394
328
  /**
395
329
  * @param {Object} arg - Arg object.
396
330
  * @param {string} arg.companyId - Company id
@@ -408,59 +342,59 @@ declare class Communication {
408
342
  }): Paginator;
409
343
  /**
410
344
  * @param {Object} arg - Arg object.
411
- * @param {string} [arg.pageId] - Current page no
345
+ * @param {number} [arg.pageNo] - Current page no
412
346
  * @param {number} [arg.pageSize] - Current request items count
413
- * @param {Object} [arg.sort] - To sort based on _id
414
- * @param {Object} [arg.query] -
415
- * @summary: Get communication logs
416
- * @description: Get communication logs
347
+ * @param {Object} [arg.sort] - To sort based on created_at
348
+ * @returns {Promise<Jobs>} - Success response
349
+ * @summary: Get jobs
350
+ * @description: Get jobs
417
351
  */
418
- getCommunicationLogs({ pageId, pageSize, sort, query }?: {
419
- pageId?: string;
352
+ getJobs({ pageNo, pageSize, sort }?: {
353
+ pageNo?: number;
420
354
  pageSize?: number;
421
355
  sort?: any;
422
- query?: any;
423
- }): Promise<any>;
356
+ }): Promise<Jobs>;
424
357
  /**
425
358
  * @param {Object} arg - Arg object.
426
359
  * @param {string} arg.companyId - Company id
427
360
  * @param {string} arg.applicationId - Application id
428
361
  * @param {number} [arg.pageSize] - Current request items count
429
- * @param {Object} [arg.sort] - To sort based on _id
430
- * @param {Object} [arg.query] -
431
- * @summary: Get communication logs
432
- * @description: Get communication logs
362
+ * @param {Object} [arg.sort] - To sort based on created_at
363
+ * @summary: Get jobs
364
+ * @description: Get jobs
433
365
  */
434
- getCommunicationLogsPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
366
+ getJobsPaginator({ companyId, applicationId, pageSize, sort }?: {
435
367
  companyId: string;
436
368
  applicationId: string;
437
369
  pageSize?: number;
438
370
  sort?: any;
439
- query?: any;
440
371
  }): Paginator;
441
372
  /**
442
373
  * @param {Object} arg - Arg object.
443
- * @param {SendOtpCommsReq} arg.body
444
- * @summary: Send OTP using email and sms
445
- * @description: Send OTP Comms via email and sms
374
+ * @param {GetNRecordsCsvReq} arg.body
375
+ * @returns {Promise<GetNRecordsCsvRes>} - Success response
376
+ * @summary: Get n sample records from csv
377
+ * @description: Get n sample records from csv
446
378
  */
447
- sendOtp({ body }?: {
448
- body: SendOtpCommsReq;
449
- }): Promise<any>;
379
+ getNSampleRecordsFromCsv({ body }?: {
380
+ body: GetNRecordsCsvReq;
381
+ }): Promise<GetNRecordsCsvRes>;
450
382
  /**
451
383
  * @param {Object} arg - Arg object.
452
- * @param {VerifyOtpCommsReq} arg.body
453
- * @summary: Verify OTP sent via email and sms
454
- * @description: Verify OTP sent via email and sms
384
+ * @param {string} arg.id - Sms provider id
385
+ * @returns {Promise<SmsProvider>} - Success response
386
+ * @summary: Get sms provider by id
387
+ * @description: Get sms provider by id
455
388
  */
456
- verfiyOtp({ body }?: {
457
- body: VerifyOtpCommsReq;
458
- }): Promise<any>;
389
+ getSmsProviderById({ id }?: {
390
+ id: string;
391
+ }): Promise<SmsProvider>;
459
392
  /**
460
393
  * @param {Object} arg - Arg object.
461
394
  * @param {number} [arg.pageNo] - Current page no
462
395
  * @param {number} [arg.pageSize] - Current request items count
463
396
  * @param {Object} [arg.sort] - To sort based on created_at
397
+ * @returns {Promise<SmsProviders>} - Success response
464
398
  * @summary: Get sms providers
465
399
  * @description: Get sms providers
466
400
  */
@@ -468,7 +402,7 @@ declare class Communication {
468
402
  pageNo?: number;
469
403
  pageSize?: number;
470
404
  sort?: any;
471
- }): Promise<any>;
405
+ }): Promise<SmsProviders>;
472
406
  /**
473
407
  * @param {Object} arg - Arg object.
474
408
  * @param {string} arg.companyId - Company id
@@ -486,38 +420,20 @@ declare class Communication {
486
420
  }): Paginator;
487
421
  /**
488
422
  * @param {Object} arg - Arg object.
489
- * @param {SmsProviderReq} arg.body
490
- * @summary: Create sms provider
491
- * @description: Create sms provider
492
- */
493
- createSmsProvider({ body }?: {
494
- body: SmsProviderReq;
495
- }): Promise<any>;
496
- /**
497
- * @param {Object} arg - Arg object.
498
- * @param {string} arg.id - Sms provider id
499
- * @summary: Get sms provider by id
500
- * @description: Get sms provider by id
501
- */
502
- getSmsProviderById({ id }?: {
503
- id: string;
504
- }): Promise<any>;
505
- /**
506
- * @param {Object} arg - Arg object.
507
- * @param {string} arg.id - Sms provider id
508
- * @param {SmsProviderReq} arg.body
509
- * @summary: Update sms provider by id
510
- * @description: Update sms provider by id
423
+ * @param {string} arg.id - Sms template id
424
+ * @returns {Promise<SmsTemplate>} - Success response
425
+ * @summary: Get sms template by id
426
+ * @description: Get sms template by id
511
427
  */
512
- updateSmsProviderById({ id, body }?: {
428
+ getSmsTemplateById({ id }?: {
513
429
  id: string;
514
- body: SmsProviderReq;
515
- }): Promise<any>;
430
+ }): Promise<SmsTemplate>;
516
431
  /**
517
432
  * @param {Object} arg - Arg object.
518
433
  * @param {number} [arg.pageNo] - Current page no
519
434
  * @param {number} [arg.pageSize] - Current request items count
520
435
  * @param {Object} [arg.sort] - To sort based on created_at
436
+ * @returns {Promise<SmsTemplates>} - Success response
521
437
  * @summary: Get sms templates
522
438
  * @description: Get sms templates
523
439
  */
@@ -525,7 +441,7 @@ declare class Communication {
525
441
  pageNo?: number;
526
442
  pageSize?: number;
527
443
  sort?: any;
528
- }): Promise<any>;
444
+ }): Promise<SmsTemplates>;
529
445
  /**
530
446
  * @param {Object} arg - Arg object.
531
447
  * @param {string} arg.companyId - Company id
@@ -543,47 +459,49 @@ declare class Communication {
543
459
  }): Paginator;
544
460
  /**
545
461
  * @param {Object} arg - Arg object.
546
- * @param {SmsTemplateReq} arg.body
547
- * @summary: Create sms template
548
- * @description: Create sms template
549
- */
550
- createSmsTemplate({ body }?: {
551
- body: SmsTemplateReq;
552
- }): Promise<any>;
553
- /**
554
- * @param {Object} arg - Arg object.
555
- * @param {string} arg.id - Sms template id
556
- * @summary: Get sms template by id
557
- * @description: Get sms template by id
462
+ * @param {string} arg.id - Campaign id
463
+ * @returns {Promise<GetStats>} - Success response
464
+ * @summary: Get stats of campaign by id
465
+ * @description: Get stats of campaign by id
558
466
  */
559
- getSmsTemplateById({ id }?: {
467
+ getStatsOfCampaignById({ id }?: {
560
468
  id: string;
561
- }): Promise<any>;
469
+ }): Promise<GetStats>;
562
470
  /**
563
471
  * @param {Object} arg - Arg object.
564
- * @param {string} arg.id - Sms template id
565
- * @param {SmsTemplateReq} arg.body
566
- * @summary: Update sms template by id
567
- * @description: Update sms template by id
472
+ * @param {number} [arg.pageNo] - Current page no
473
+ * @param {number} [arg.pageSize] - Current request items count
474
+ * @param {Object} [arg.sort] - To sort based on created_at
475
+ * @returns {Promise<SystemEmailTemplates>} - Success response
476
+ * @summary: Get system email templates
477
+ * @description: Get system email templates
568
478
  */
569
- updateSmsTemplateById({ id, body }?: {
570
- id: string;
571
- body: SmsTemplateReq;
572
- }): Promise<any>;
479
+ getSystemEmailTemplates({ pageNo, pageSize, sort }?: {
480
+ pageNo?: number;
481
+ pageSize?: number;
482
+ sort?: any;
483
+ }): Promise<SystemEmailTemplates>;
573
484
  /**
574
485
  * @param {Object} arg - Arg object.
575
- * @param {string} arg.id - Sms template id
576
- * @summary: Delete sms template by id
577
- * @description: Delete sms template by id
486
+ * @param {string} arg.companyId - Company id
487
+ * @param {string} arg.applicationId - Application id
488
+ * @param {number} [arg.pageSize] - Current request items count
489
+ * @param {Object} [arg.sort] - To sort based on created_at
490
+ * @summary: Get system email templates
491
+ * @description: Get system email templates
578
492
  */
579
- deleteSmsTemplateById({ id }?: {
580
- id: string;
581
- }): Promise<any>;
493
+ getSystemEmailTemplatesPaginator({ companyId, applicationId, pageSize, sort, }?: {
494
+ companyId: string;
495
+ applicationId: string;
496
+ pageSize?: number;
497
+ sort?: any;
498
+ }): Paginator;
582
499
  /**
583
500
  * @param {Object} arg - Arg object.
584
501
  * @param {number} [arg.pageNo] - Current page no
585
502
  * @param {number} [arg.pageSize] - Current request items count
586
503
  * @param {Object} [arg.sort] - To sort based on created_at
504
+ * @returns {Promise<SystemSmsTemplates>} - Success response
587
505
  * @summary: Get system sms templates
588
506
  * @description: Get system sms templates
589
507
  */
@@ -591,7 +509,7 @@ declare class Communication {
591
509
  pageNo?: number;
592
510
  pageSize?: number;
593
511
  sort?: any;
594
- }): Promise<any>;
512
+ }): Promise<SystemSmsTemplates>;
595
513
  /**
596
514
  * @param {Object} arg - Arg object.
597
515
  * @param {string} arg.companyId - Company id
@@ -607,5 +525,127 @@ declare class Communication {
607
525
  pageSize?: number;
608
526
  sort?: any;
609
527
  }): Paginator;
528
+ /**
529
+ * @param {Object} arg - Arg object.
530
+ * @param {EngineRequest} arg.body
531
+ * @returns {Promise<EngineResponse>} - Success response
532
+ * @summary: Send email or sms asynchronously
533
+ * @description: Send email or sms asynchronously
534
+ */
535
+ sendCommunicationAsynchronously({ body }?: {
536
+ body: EngineRequest;
537
+ }): Promise<EngineResponse>;
538
+ /**
539
+ * @param {Object} arg - Arg object.
540
+ * @param {EngineRequest} arg.body
541
+ * @returns {Promise<EngineResponse>} - Success response
542
+ * @summary: Send email or sms synchronously
543
+ * @description: Send email or sms synchronously
544
+ */
545
+ sendCommunicationSynchronously({ body }?: {
546
+ body: EngineRequest;
547
+ }): Promise<EngineResponse>;
548
+ /**
549
+ * @param {Object} arg - Arg object.
550
+ * @param {SendOtpCommsReq} arg.body
551
+ * @returns {Promise<SendOtpCommsRes>} - Success response
552
+ * @summary: Send OTP using email and sms
553
+ * @description: Send OTP Comms via email and sms
554
+ */
555
+ sendOtp({ body }?: {
556
+ body: SendOtpCommsReq;
557
+ }): Promise<SendOtpCommsRes>;
558
+ /**
559
+ * @param {Object} arg - Arg object.
560
+ * @param {TriggerJobRequest} arg.body
561
+ * @returns {Promise<TriggerJobResponse>} - Success response
562
+ * @summary: Trigger campaign job
563
+ * @description: Trigger campaign job
564
+ */
565
+ triggerCampaignJob({ body }?: {
566
+ body: TriggerJobRequest;
567
+ }): Promise<TriggerJobResponse>;
568
+ /**
569
+ * @param {Object} arg - Arg object.
570
+ * @param {string} arg.id - Audience id
571
+ * @param {AudienceReq} arg.body
572
+ * @returns {Promise<Audience>} - Success response
573
+ * @summary: Update audience by id
574
+ * @description: Update audience by id
575
+ */
576
+ updateAudienceById({ id, body }?: {
577
+ id: string;
578
+ body: AudienceReq;
579
+ }): Promise<Audience>;
580
+ /**
581
+ * @param {Object} arg - Arg object.
582
+ * @param {string} arg.id - Campaign id
583
+ * @param {CampaignReq} arg.body
584
+ * @returns {Promise<Campaign>} - Success response
585
+ * @summary: Update campaign by id
586
+ * @description: Update campaign by id
587
+ */
588
+ updateCampaignById({ id, body }?: {
589
+ id: string;
590
+ body: CampaignReq;
591
+ }): Promise<Campaign>;
592
+ /**
593
+ * @param {Object} arg - Arg object.
594
+ * @param {string} arg.id - Email provider id
595
+ * @param {EmailProviderReq} arg.body
596
+ * @returns {Promise<EmailProvider>} - Success response
597
+ * @summary: Update email provider by id
598
+ * @description: Update email provider by id
599
+ */
600
+ updateEmailProviderById({ id, body }?: {
601
+ id: string;
602
+ body: EmailProviderReq;
603
+ }): Promise<EmailProvider>;
604
+ /**
605
+ * @param {Object} arg - Arg object.
606
+ * @param {string} arg.id - Email template id
607
+ * @param {EmailTemplateReq} arg.body
608
+ * @returns {Promise<EmailTemplateRes>} - Success response
609
+ * @summary: Update email template by id
610
+ * @description: Update email template by id
611
+ */
612
+ updateEmailTemplateById({ id, body }?: {
613
+ id: string;
614
+ body: EmailTemplateReq;
615
+ }): Promise<EmailTemplateRes>;
616
+ /**
617
+ * @param {Object} arg - Arg object.
618
+ * @param {string} arg.id - Sms provider id
619
+ * @param {SmsProviderReq} arg.body
620
+ * @returns {Promise<SmsProvider>} - Success response
621
+ * @summary: Update sms provider by id
622
+ * @description: Update sms provider by id
623
+ */
624
+ updateSmsProviderById({ id, body }?: {
625
+ id: string;
626
+ body: SmsProviderReq;
627
+ }): Promise<SmsProvider>;
628
+ /**
629
+ * @param {Object} arg - Arg object.
630
+ * @param {string} arg.id - Sms template id
631
+ * @param {SmsTemplateReq} arg.body
632
+ * @returns {Promise<SmsTemplateRes>} - Success response
633
+ * @summary: Update sms template by id
634
+ * @description: Update sms template by id
635
+ */
636
+ updateSmsTemplateById({ id, body }?: {
637
+ id: string;
638
+ body: SmsTemplateReq;
639
+ }): Promise<SmsTemplateRes>;
640
+ /**
641
+ * @param {Object} arg - Arg object.
642
+ * @param {VerifyOtpCommsReq} arg.body
643
+ * @returns {Promise<VerifyOtpCommsSuccessRes>} - Success response
644
+ * @summary: Verify OTP sent via email and sms
645
+ * @description: Verify OTP sent via email and sms
646
+ */
647
+ verfiyOtp({ body }?: {
648
+ body: VerifyOtpCommsReq;
649
+ }): Promise<VerifyOtpCommsSuccessRes>;
610
650
  }
611
651
  import Paginator = require("../../common/Paginator");