@gofynd/fdk-client-javascript 1.0.2 → 1.0.4

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 (346) hide show
  1. package/README.md +31 -2
  2. package/index.d.ts +4 -4
  3. package/index.js +9 -10
  4. package/package.json +14 -14
  5. package/sdk/APIClient.d.ts +11 -0
  6. package/sdk/APIClient.js +35 -0
  7. package/sdk/Client.d.ts +6 -0
  8. package/sdk/Client.js +17 -0
  9. package/sdk/Config.d.ts +9 -0
  10. package/sdk/Config.js +17 -0
  11. package/sdk/application/Cart/CartApplicationClient.d.ts +243 -243
  12. package/sdk/application/Cart/CartApplicationClient.js +595 -594
  13. package/sdk/application/Cart/CartApplicationModel.d.ts +64 -63
  14. package/sdk/application/Cart/CartApplicationModel.js +490 -885
  15. package/sdk/application/Cart/CartApplicationValidator.d.ts +17 -17
  16. package/sdk/application/Cart/CartApplicationValidator.js +98 -98
  17. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +358 -358
  18. package/sdk/application/Catalog/CatalogApplicationClient.js +1079 -1078
  19. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +90 -90
  20. package/sdk/application/Catalog/CatalogApplicationModel.js +683 -1249
  21. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +19 -19
  22. package/sdk/application/Catalog/CatalogApplicationValidator.js +110 -110
  23. package/sdk/application/Common/CommonApplicationClient.d.ts +13 -13
  24. package/sdk/application/Common/CommonApplicationClient.js +43 -42
  25. package/sdk/application/Common/CommonApplicationModel.d.ts +12 -12
  26. package/sdk/application/Common/CommonApplicationModel.js +83 -160
  27. package/sdk/application/Common/CommonApplicationValidator.d.ts +1 -1
  28. package/sdk/application/Common/CommonApplicationValidator.js +6 -6
  29. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +11 -11
  30. package/sdk/application/Communication/CommunicationApplicationClient.js +32 -31
  31. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +6 -6
  32. package/sdk/application/Communication/CommunicationApplicationModel.js +38 -83
  33. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
  34. package/sdk/application/Communication/CommunicationApplicationValidator.js +4 -4
  35. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +116 -116
  36. package/sdk/application/Configuration/ConfigurationApplicationClient.js +350 -349
  37. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +85 -85
  38. package/sdk/application/Configuration/ConfigurationApplicationModel.js +480 -851
  39. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +8 -8
  40. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +33 -33
  41. package/sdk/application/Content/ContentApplicationClient.d.ts +67 -67
  42. package/sdk/application/Content/ContentApplicationClient.js +216 -215
  43. package/sdk/application/Content/ContentApplicationModel.d.ts +76 -76
  44. package/sdk/application/Content/ContentApplicationModel.js +468 -884
  45. package/sdk/application/Content/ContentApplicationValidator.d.ts +5 -5
  46. package/sdk/application/Content/ContentApplicationValidator.js +24 -24
  47. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +25 -25
  48. package/sdk/application/FileStorage/FileStorageApplicationClient.js +65 -64
  49. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +13 -13
  50. package/sdk/application/FileStorage/FileStorageApplicationModel.js +86 -169
  51. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
  52. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +7 -7
  53. package/sdk/application/Lead/LeadApplicationClient.d.ts +24 -24
  54. package/sdk/application/Lead/LeadApplicationClient.js +109 -108
  55. package/sdk/application/Lead/LeadApplicationModel.d.ts +35 -35
  56. package/sdk/application/Lead/LeadApplicationModel.js +267 -474
  57. package/sdk/application/Lead/LeadApplicationValidator.d.ts +2 -2
  58. package/sdk/application/Lead/LeadApplicationValidator.js +11 -11
  59. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +31 -22
  60. package/sdk/application/Logistic/LogisticApplicationClient.js +115 -49
  61. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +17 -14
  62. package/sdk/application/Logistic/LogisticApplicationModel.js +133 -201
  63. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +3 -2
  64. package/sdk/application/Logistic/LogisticApplicationValidator.js +14 -9
  65. package/sdk/application/Order/OrderApplicationClient.d.ts +85 -85
  66. package/sdk/application/Order/OrderApplicationClient.js +247 -246
  67. package/sdk/application/Order/OrderApplicationModel.d.ts +50 -50
  68. package/sdk/application/Order/OrderApplicationModel.js +361 -656
  69. package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -7
  70. package/sdk/application/Order/OrderApplicationValidator.js +28 -28
  71. package/sdk/application/Payment/PaymentApplicationClient.d.ts +318 -318
  72. package/sdk/application/Payment/PaymentApplicationClient.js +781 -780
  73. package/sdk/application/Payment/PaymentApplicationModel.d.ts +72 -72
  74. package/sdk/application/Payment/PaymentApplicationModel.js +570 -1038
  75. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +28 -28
  76. package/sdk/application/Payment/PaymentApplicationValidator.js +107 -107
  77. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +254 -254
  78. package/sdk/application/PosCart/PosCartApplicationClient.js +646 -645
  79. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +64 -63
  80. package/sdk/application/PosCart/PosCartApplicationModel.js +476 -870
  81. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +18 -18
  82. package/sdk/application/PosCart/PosCartApplicationValidator.js +103 -103
  83. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +27 -27
  84. package/sdk/application/Rewards/RewardsApplicationClient.js +122 -121
  85. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +14 -14
  86. package/sdk/application/Rewards/RewardsApplicationModel.js +96 -191
  87. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +3 -3
  88. package/sdk/application/Rewards/RewardsApplicationValidator.js +12 -12
  89. package/sdk/application/Share/ShareApplicationClient.d.ts +37 -37
  90. package/sdk/application/Share/ShareApplicationClient.js +94 -93
  91. package/sdk/application/Share/ShareApplicationModel.d.ts +8 -8
  92. package/sdk/application/Share/ShareApplicationModel.js +63 -123
  93. package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -4
  94. package/sdk/application/Share/ShareApplicationValidator.js +12 -12
  95. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  96. package/sdk/application/Theme/ThemeApplicationClient.js +38 -37
  97. package/sdk/application/Theme/ThemeApplicationModel.d.ts +34 -34
  98. package/sdk/application/Theme/ThemeApplicationModel.js +190 -336
  99. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +1 -1
  100. package/sdk/application/Theme/ThemeApplicationValidator.js +4 -4
  101. package/sdk/application/User/UserApplicationClient.d.ts +280 -280
  102. package/sdk/application/User/UserApplicationClient.js +619 -618
  103. package/sdk/application/User/UserApplicationModel.d.ts +79 -72
  104. package/sdk/application/User/UserApplicationModel.js +440 -689
  105. package/sdk/application/User/UserApplicationValidator.d.ts +24 -24
  106. package/sdk/application/User/UserApplicationValidator.js +89 -89
  107. package/sdk/common/AxiosHelper.js +18 -7
  108. package/sdk/constructUrl.d.ts +5 -0
  109. package/sdk/constructUrl.js +13 -0
  110. package/sdk/index.d.ts +3 -0
  111. package/sdk/index.js +5 -0
  112. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +51 -51
  113. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +182 -180
  114. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +6 -6
  115. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +21 -21
  116. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +5 -4
  117. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +11 -11
  118. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +95 -178
  119. package/sdk/platform/Analytics/AnalyticsPlatformValidator.js +1 -0
  120. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +10 -10
  121. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +44 -43
  122. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +10 -10
  123. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +50 -89
  124. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
  125. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +7 -6
  126. package/sdk/platform/Billing/BillingPlatformClient.d.ts +60 -60
  127. package/sdk/platform/Billing/BillingPlatformClient.js +184 -183
  128. package/sdk/platform/Billing/BillingPlatformModel.d.ts +40 -40
  129. package/sdk/platform/Billing/BillingPlatformModel.js +342 -668
  130. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +8 -8
  131. package/sdk/platform/Billing/BillingPlatformValidator.js +26 -25
  132. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +192 -165
  133. package/sdk/platform/Cart/CartPlatformApplicationClient.js +686 -510
  134. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +14 -11
  135. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +77 -61
  136. package/sdk/platform/Cart/CartPlatformModel.d.ts +84 -83
  137. package/sdk/platform/Cart/CartPlatformModel.js +676 -1206
  138. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +632 -632
  139. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1558 -1556
  140. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +40 -40
  141. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +175 -175
  142. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +688 -688
  143. package/sdk/platform/Catalog/CatalogPlatformClient.js +1556 -1559
  144. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +291 -291
  145. package/sdk/platform/Catalog/CatalogPlatformModel.js +2133 -3910
  146. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +66 -66
  147. package/sdk/platform/Catalog/CatalogPlatformValidator.js +229 -228
  148. package/sdk/platform/Common/CommonPlatformClient.d.ts +12 -12
  149. package/sdk/platform/Common/CommonPlatformClient.js +40 -51
  150. package/sdk/platform/Common/CommonPlatformModel.d.ts +12 -12
  151. package/sdk/platform/Common/CommonPlatformModel.js +83 -160
  152. package/sdk/platform/Common/CommonPlatformValidator.d.ts +1 -1
  153. package/sdk/platform/Common/CommonPlatformValidator.js +7 -6
  154. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +326 -326
  155. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +945 -943
  156. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +30 -30
  157. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +88 -88
  158. package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -3
  159. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +67 -67
  160. package/sdk/platform/Communication/CommunicationPlatformModel.js +522 -974
  161. package/sdk/platform/Communication/CommunicationPlatformValidator.js +1 -0
  162. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +55 -55
  163. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +217 -216
  164. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +27 -27
  165. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +279 -542
  166. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +7 -7
  167. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +25 -24
  168. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +163 -153
  169. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +617 -552
  170. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +22 -21
  171. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +70 -64
  172. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +125 -125
  173. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +348 -347
  174. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +148 -146
  175. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +854 -1508
  176. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -9
  177. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +39 -38
  178. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +524 -534
  179. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1287 -1346
  180. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +49 -50
  181. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +153 -159
  182. package/sdk/platform/Content/ContentPlatformModel.d.ts +78 -78
  183. package/sdk/platform/Content/ContentPlatformModel.js +485 -907
  184. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +65 -65
  185. package/sdk/platform/Discount/DiscountPlatformClient.js +219 -218
  186. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +7 -7
  187. package/sdk/platform/Discount/DiscountPlatformModel.js +60 -121
  188. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +6 -6
  189. package/sdk/platform/Discount/DiscountPlatformValidator.js +30 -29
  190. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +25 -25
  191. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +83 -61
  192. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  193. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +9 -9
  194. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +53 -53
  195. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +147 -125
  196. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -13
  197. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +86 -169
  198. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +3 -3
  199. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +12 -11
  200. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +63 -63
  201. package/sdk/platform/Inventory/InventoryPlatformClient.js +231 -230
  202. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +30 -30
  203. package/sdk/platform/Inventory/InventoryPlatformModel.js +497 -964
  204. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +7 -7
  205. package/sdk/platform/Inventory/InventoryPlatformValidator.js +29 -28
  206. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +73 -73
  207. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +203 -201
  208. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +7 -7
  209. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +29 -29
  210. package/sdk/platform/Lead/LeadPlatformClient.d.ts +80 -80
  211. package/sdk/platform/Lead/LeadPlatformClient.js +215 -214
  212. package/sdk/platform/Lead/LeadPlatformModel.d.ts +35 -35
  213. package/sdk/platform/Lead/LeadPlatformModel.js +267 -474
  214. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +6 -6
  215. package/sdk/platform/Lead/LeadPlatformValidator.js +25 -24
  216. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
  217. package/sdk/platform/Order/OrderPlatformApplicationClient.js +68 -66
  218. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -1
  219. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +7 -7
  220. package/sdk/platform/Order/OrderPlatformClient.d.ts +357 -357
  221. package/sdk/platform/Order/OrderPlatformClient.js +1046 -1033
  222. package/sdk/platform/Order/OrderPlatformModel.d.ts +198 -196
  223. package/sdk/platform/Order/OrderPlatformModel.js +1575 -2861
  224. package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -32
  225. package/sdk/platform/Order/OrderPlatformValidator.js +161 -160
  226. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +3 -1
  227. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +1 -1
  228. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -1
  229. package/sdk/platform/Partner/PartnerPlatformModel.js +10 -26
  230. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +58 -58
  231. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +178 -178
  232. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -6
  233. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +24 -24
  234. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +42 -42
  235. package/sdk/platform/Payment/PaymentPlatformClient.js +156 -155
  236. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -27
  237. package/sdk/platform/Payment/PaymentPlatformModel.js +222 -410
  238. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +4 -4
  239. package/sdk/platform/Payment/PaymentPlatformValidator.js +22 -21
  240. package/sdk/platform/PlatformApplicationClient.d.ts +1496 -10325
  241. package/sdk/platform/PlatformApplicationClient.js +1584 -13899
  242. package/sdk/platform/PlatformClient.d.ts +7972 -7888
  243. package/sdk/platform/PlatformClient.js +8678 -10107
  244. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +85 -85
  245. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +299 -280
  246. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +8 -8
  247. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +35 -35
  248. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +15 -15
  249. package/sdk/platform/Rewards/RewardsPlatformModel.js +92 -194
  250. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
  251. package/sdk/platform/Share/SharePlatformApplicationClient.js +62 -60
  252. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
  253. package/sdk/platform/Share/SharePlatformApplicationValidator.js +7 -7
  254. package/sdk/platform/Share/SharePlatformModel.d.ts +8 -8
  255. package/sdk/platform/Share/SharePlatformModel.js +60 -118
  256. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +132 -132
  257. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +314 -312
  258. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +15 -15
  259. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +45 -45
  260. package/sdk/platform/Theme/ThemePlatformModel.d.ts +34 -34
  261. package/sdk/platform/Theme/ThemePlatformModel.js +190 -336
  262. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +136 -69
  263. package/sdk/platform/User/UserPlatformApplicationClient.js +507 -166
  264. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +12 -7
  265. package/sdk/platform/User/UserPlatformApplicationValidator.js +62 -24
  266. package/sdk/platform/User/UserPlatformModel.d.ts +79 -72
  267. package/sdk/platform/User/UserPlatformModel.js +440 -689
  268. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +31 -31
  269. package/sdk/platform/Webhook/WebhookPlatformClient.js +91 -90
  270. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +7 -7
  271. package/sdk/platform/Webhook/WebhookPlatformModel.js +68 -136
  272. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +3 -3
  273. package/sdk/platform/Webhook/WebhookPlatformValidator.js +15 -14
  274. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +13 -13
  275. package/sdk/public/Configuration/ConfigurationPublicClient.js +40 -38
  276. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +12 -12
  277. package/sdk/public/Configuration/ConfigurationPublicModel.js +85 -162
  278. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -1
  279. package/sdk/public/Configuration/ConfigurationPublicValidator.js +6 -6
  280. package/sdk/public/Inventory/InventoryPublicClient.d.ts +34 -34
  281. package/sdk/public/Inventory/InventoryPublicClient.js +115 -113
  282. package/sdk/public/Inventory/InventoryPublicModel.d.ts +10 -10
  283. package/sdk/public/Inventory/InventoryPublicModel.js +119 -245
  284. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +3 -3
  285. package/sdk/public/Inventory/InventoryPublicValidator.js +15 -15
  286. package/sdk/public/Webhook/WebhookPublicClient.js +2 -0
  287. package/sdk/public/Webhook/WebhookPublicModel.d.ts +7 -7
  288. package/sdk/public/Webhook/WebhookPublicModel.js +68 -136
  289. package/.github/workflows/on_create_release.yml +0 -23
  290. package/.github/workflows/on_merge_main.yml +0 -38
  291. package/.github/workflows/on_pull_request.yml +0 -35
  292. package/.prettierrc +0 -5
  293. package/documentation/application/CART.md +0 -7339
  294. package/documentation/application/CATALOG.md +0 -9597
  295. package/documentation/application/COMMON.md +0 -452
  296. package/documentation/application/COMMUNICATION.md +0 -467
  297. package/documentation/application/CONFIGURATION.md +0 -2906
  298. package/documentation/application/CONTENT.md +0 -3351
  299. package/documentation/application/FILESTORAGE.md +0 -578
  300. package/documentation/application/LEAD.md +0 -1895
  301. package/documentation/application/LOGISTIC.md +0 -765
  302. package/documentation/application/ORDER.md +0 -3432
  303. package/documentation/application/PAYMENT.md +0 -5221
  304. package/documentation/application/POSCART.md +0 -7938
  305. package/documentation/application/README.md +0 -21
  306. package/documentation/application/REWARDS.md +0 -708
  307. package/documentation/application/SHARE.md +0 -733
  308. package/documentation/application/THEME.md +0 -5800
  309. package/documentation/application/USER.md +0 -4335
  310. package/documentation/platform/ANALYTICS.md +0 -1154
  311. package/documentation/platform/AUDITTRAIL.md +0 -576
  312. package/documentation/platform/BILLING.md +0 -2400
  313. package/documentation/platform/CART.md +0 -5559
  314. package/documentation/platform/CATALOG.md +0 -23261
  315. package/documentation/platform/COMMON.md +0 -452
  316. package/documentation/platform/COMMUNICATION.md +0 -5718
  317. package/documentation/platform/COMPANYPROFILE.md +0 -2031
  318. package/documentation/platform/CONFIGURATION.md +0 -7339
  319. package/documentation/platform/CONTENT.md +0 -9098
  320. package/documentation/platform/DISCOUNT.md +0 -863
  321. package/documentation/platform/FILESTORAGE.md +0 -1081
  322. package/documentation/platform/INVENTORY.md +0 -1779
  323. package/documentation/platform/LEAD.md +0 -4740
  324. package/documentation/platform/ORDER.md +0 -8486
  325. package/documentation/platform/PARTNER.md +0 -220
  326. package/documentation/platform/PAYMENT.md +0 -3448
  327. package/documentation/platform/README.md +0 -27
  328. package/documentation/platform/REWARDS.md +0 -1083
  329. package/documentation/platform/SHARE.md +0 -606
  330. package/documentation/platform/THEME.md +0 -35729
  331. package/documentation/platform/USER.md +0 -2319
  332. package/documentation/platform/WEBHOOK.md +0 -591
  333. package/documentation/public/CONFIGURATION.md +0 -452
  334. package/documentation/public/INVENTORY.md +0 -690
  335. package/documentation/public/WEBHOOK.md +0 -352
  336. package/jest.config.d.ts +0 -4
  337. package/jest.config.js +0 -6
  338. package/tests/application/catalog.spec.js +0 -47
  339. package/tests/common/action-url.spec.js +0 -35
  340. package/tests/common/schema/action-url.json +0 -178
  341. package/tests/common/schema/url-action.json +0 -683
  342. package/tests/common/url-action.spec.js +0 -48
  343. package/tests/helpers/cookie.helper.js +0 -31
  344. package/tests/helpers/oauth.helper.js +0 -43
  345. package/tests/platform/catalog.spec.js +0 -49
  346. package/tests/public/location.spec.js +0 -39
@@ -5,33 +5,14 @@ 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
- * @returns {Promise<Campaigns>} - Success response
12
- * @summary: Get campaigns
13
- * @description: Get campaigns
14
- */
15
- getCampaigns({ pageNo, pageSize, sort }?: {
16
- pageNo?: number;
17
- pageSize?: number;
18
- sort?: any;
19
- }): Promise<Campaigns>;
20
- /**
21
- * @param {Object} arg - Arg object.
22
- * @param {string} arg.companyId - Company id
23
- * @param {string} arg.applicationId - Application id
24
- * @param {number} [arg.pageSize] - Current request items count
25
- * @param {Object} [arg.sort] - To sort based on created_at
26
- * @summary: Get campaigns
27
- * @description: Get campaigns
8
+ * @param {AudienceReq} arg.body
9
+ * @returns {Promise<Audience>} - Success response
10
+ * @summary: Create audience
11
+ * @description: Create audience
28
12
  */
29
- getCampaignsPaginator({ companyId, applicationId, pageSize, sort }?: {
30
- companyId: string;
31
- applicationId: string;
32
- pageSize?: number;
33
- sort?: any;
34
- }): Paginator;
13
+ createAudience({ body }?: {
14
+ body: AudienceReq;
15
+ }): Promise<Audience>;
35
16
  /**
36
17
  * @param {Object} arg - Arg object.
37
18
  * @param {CampaignReq} arg.body
@@ -44,36 +25,74 @@ declare class Communication {
44
25
  }): Promise<Campaign>;
45
26
  /**
46
27
  * @param {Object} arg - Arg object.
47
- * @param {string} arg.id - Campaign id
48
- * @returns {Promise<Campaign>} - Success response
49
- * @summary: Get campaign by id
50
- * @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
51
32
  */
52
- 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 }?: {
53
74
  id: string;
54
- }): Promise<Campaign>;
75
+ }): Promise<EmailTemplateDeleteSuccessRes>;
55
76
  /**
56
77
  * @param {Object} arg - Arg object.
57
- * @param {string} arg.id - Campaign id
58
- * @param {CampaignReq} arg.body
59
- * @returns {Promise<Campaign>} - Success response
60
- * @summary: Update campaign by id
61
- * @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
62
82
  */
63
- updateCampaignById({ id, body }?: {
83
+ deleteSmsTemplateById({ id }?: {
64
84
  id: string;
65
- body: CampaignReq;
66
- }): Promise<Campaign>;
85
+ }): Promise<SmsTemplateDeleteSuccessRes>;
67
86
  /**
68
87
  * @param {Object} arg - Arg object.
69
- * @param {string} arg.id - Campaign id
70
- * @returns {Promise<GetStats>} - Success response
71
- * @summary: Get stats of campaign by id
72
- * @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
73
92
  */
74
- getStatsOfCampaignById({ id }?: {
93
+ getAudienceById({ id }?: {
75
94
  id: string;
76
- }): Promise<GetStats>;
95
+ }): Promise<Audience>;
77
96
  /**
78
97
  * @param {Object} arg - Arg object.
79
98
  * @param {number} [arg.pageNo] - Current page no
@@ -103,16 +122,6 @@ declare class Communication {
103
122
  pageSize?: number;
104
123
  sort?: any;
105
124
  }): Paginator;
106
- /**
107
- * @param {Object} arg - Arg object.
108
- * @param {AudienceReq} arg.body
109
- * @returns {Promise<Audience>} - Success response
110
- * @summary: Create audience
111
- * @description: Create audience
112
- */
113
- createAudience({ body }?: {
114
- body: AudienceReq;
115
- }): Promise<Audience>;
116
125
  /**
117
126
  * @param {Object} arg - Arg object.
118
127
  * @param {BigqueryHeadersReq} arg.body
@@ -125,36 +134,86 @@ declare class Communication {
125
134
  }): Promise<BigqueryHeadersRes>;
126
135
  /**
127
136
  * @param {Object} arg - Arg object.
128
- * @param {string} arg.id - Audience id
129
- * @returns {Promise<Audience>} - Success response
130
- * @summary: Get audience by id
131
- * @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
132
141
  */
133
- getAudienceById({ id }?: {
142
+ getCampaignById({ id }?: {
134
143
  id: string;
135
- }): Promise<Audience>;
144
+ }): Promise<Campaign>;
136
145
  /**
137
146
  * @param {Object} arg - Arg object.
138
- * @param {string} arg.id - Audience id
139
- * @param {AudienceReq} arg.body
140
- * @returns {Promise<Audience>} - Success response
141
- * @summary: Update audience by id
142
- * @description: Update audience by id
147
+ * @param {number} [arg.pageNo] - Current page no
148
+ * @param {number} [arg.pageSize] - Current request items count
149
+ * @param {Object} [arg.sort] - To sort based on created_at
150
+ * @returns {Promise<Campaigns>} - Success response
151
+ * @summary: Get campaigns
152
+ * @description: Get campaigns
143
153
  */
144
- updateAudienceById({ id, body }?: {
145
- id: string;
146
- body: AudienceReq;
147
- }): Promise<Audience>;
154
+ getCampaigns({ pageNo, pageSize, sort }?: {
155
+ pageNo?: number;
156
+ pageSize?: number;
157
+ sort?: any;
158
+ }): Promise<Campaigns>;
148
159
  /**
149
160
  * @param {Object} arg - Arg object.
150
- * @param {GetNRecordsCsvReq} arg.body
151
- * @returns {Promise<GetNRecordsCsvRes>} - Success response
152
- * @summary: Get n sample records from csv
153
- * @description: Get n sample records from csv
161
+ * @param {string} arg.companyId - Company id
162
+ * @param {string} arg.applicationId - Application id
163
+ * @param {number} [arg.pageSize] - Current request items count
164
+ * @param {Object} [arg.sort] - To sort based on created_at
165
+ * @summary: Get campaigns
166
+ * @description: Get campaigns
154
167
  */
155
- getNSampleRecordsFromCsv({ body }?: {
156
- body: GetNRecordsCsvReq;
157
- }): Promise<GetNRecordsCsvRes>;
168
+ getCampaignsPaginator({ companyId, applicationId, pageSize, sort }?: {
169
+ companyId: string;
170
+ applicationId: string;
171
+ pageSize?: number;
172
+ sort?: any;
173
+ }): Paginator;
174
+ /**
175
+ * @param {Object} arg - Arg object.
176
+ * @param {string} [arg.pageId] - Current page no
177
+ * @param {number} [arg.pageSize] - Current request items count
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
183
+ */
184
+ getCommunicationLogs({ pageId, pageSize, sort, query }?: {
185
+ pageId?: string;
186
+ pageSize?: number;
187
+ sort?: any;
188
+ query?: any;
189
+ }): Promise<Logs>;
190
+ /**
191
+ * @param {Object} arg - Arg object.
192
+ * @param {string} arg.companyId - Company id
193
+ * @param {string} arg.applicationId - Application id
194
+ * @param {number} [arg.pageSize] - Current request items count
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
199
+ */
200
+ getCommunicationLogsPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
201
+ companyId: string;
202
+ applicationId: string;
203
+ pageSize?: number;
204
+ sort?: any;
205
+ query?: any;
206
+ }): Paginator;
207
+ /**
208
+ * @param {Object} arg - Arg object.
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
213
+ */
214
+ getEmailProviderById({ id }?: {
215
+ id: string;
216
+ }): Promise<EmailProvider>;
158
217
  /**
159
218
  * @param {Object} arg - Arg object.
160
219
  * @param {number} [arg.pageNo] - Current page no
@@ -186,36 +245,14 @@ declare class Communication {
186
245
  }): Paginator;
187
246
  /**
188
247
  * @param {Object} arg - Arg object.
189
- * @param {EmailProviderReq} arg.body
190
- * @returns {Promise<EmailProvider>} - Success response
191
- * @summary: Create email provider
192
- * @description: Create email provider
193
- */
194
- createEmailProvider({ body }?: {
195
- body: EmailProviderReq;
196
- }): Promise<EmailProvider>;
197
- /**
198
- * @param {Object} arg - Arg object.
199
- * @param {string} arg.id - Email provider id
200
- * @returns {Promise<EmailProvider>} - Success response
201
- * @summary: Get email provider by id
202
- * @description: Get email provider by id
203
- */
204
- getEmailProviderById({ id }?: {
205
- id: string;
206
- }): Promise<EmailProvider>;
207
- /**
208
- * @param {Object} arg - Arg object.
209
- * @param {string} arg.id - Email provider id
210
- * @param {EmailProviderReq} arg.body
211
- * @returns {Promise<EmailProvider>} - Success response
212
- * @summary: Update email provider by id
213
- * @description: Update email provider by id
248
+ * @param {string} arg.id - Email template id
249
+ * @returns {Promise<EmailTemplate>} - Success response
250
+ * @summary: Get email template by id
251
+ * @description: Get email template by id
214
252
  */
215
- updateEmailProviderById({ id, body }?: {
253
+ getEmailTemplateById({ id }?: {
216
254
  id: string;
217
- body: EmailProviderReq;
218
- }): Promise<EmailProvider>;
255
+ }): Promise<EmailTemplate>;
219
256
  /**
220
257
  * @param {Object} arg - Arg object.
221
258
  * @param {number} [arg.pageNo] - Current page no
@@ -245,97 +282,6 @@ declare class Communication {
245
282
  pageSize?: number;
246
283
  sort?: any;
247
284
  }): Paginator;
248
- /**
249
- * @param {Object} arg - Arg object.
250
- * @param {EmailTemplateReq} arg.body
251
- * @returns {Promise<EmailTemplateRes>} - Success response
252
- * @summary: Create email template
253
- * @description: Create email template
254
- */
255
- createEmailTemplate({ body }?: {
256
- body: EmailTemplateReq;
257
- }): Promise<EmailTemplateRes>;
258
- /**
259
- * @param {Object} arg - Arg object.
260
- * @param {number} [arg.pageNo] - Current page no
261
- * @param {number} [arg.pageSize] - Current request items count
262
- * @param {Object} [arg.sort] - To sort based on created_at
263
- * @returns {Promise<SystemEmailTemplates>} - Success response
264
- * @summary: Get system email templates
265
- * @description: Get system email templates
266
- */
267
- getSystemEmailTemplates({ pageNo, pageSize, sort }?: {
268
- pageNo?: number;
269
- pageSize?: number;
270
- sort?: any;
271
- }): Promise<SystemEmailTemplates>;
272
- /**
273
- * @param {Object} arg - Arg object.
274
- * @param {string} arg.companyId - Company id
275
- * @param {string} arg.applicationId - Application id
276
- * @param {number} [arg.pageSize] - Current request items count
277
- * @param {Object} [arg.sort] - To sort based on created_at
278
- * @summary: Get system email templates
279
- * @description: Get system email templates
280
- */
281
- getSystemEmailTemplatesPaginator({ companyId, applicationId, pageSize, sort, }?: {
282
- companyId: string;
283
- applicationId: string;
284
- pageSize?: number;
285
- sort?: any;
286
- }): Paginator;
287
- /**
288
- * @param {Object} arg - Arg object.
289
- * @param {string} arg.id - Email template id
290
- * @returns {Promise<EmailTemplate>} - Success response
291
- * @summary: Get email template by id
292
- * @description: Get email template by id
293
- */
294
- getEmailTemplateById({ id }?: {
295
- id: string;
296
- }): Promise<EmailTemplate>;
297
- /**
298
- * @param {Object} arg - Arg object.
299
- * @param {string} arg.id - Email template id
300
- * @param {EmailTemplateReq} arg.body
301
- * @returns {Promise<EmailTemplateRes>} - Success response
302
- * @summary: Update email template by id
303
- * @description: Update email template by id
304
- */
305
- updateEmailTemplateById({ id, body }?: {
306
- id: string;
307
- body: EmailTemplateReq;
308
- }): Promise<EmailTemplateRes>;
309
- /**
310
- * @param {Object} arg - Arg object.
311
- * @param {string} arg.id - Email template id
312
- * @returns {Promise<EmailTemplateDeleteSuccessRes>} - Success response
313
- * @summary: Delete email template by id
314
- * @description: Delete email template by id
315
- */
316
- deleteEmailTemplateById({ id }?: {
317
- id: string;
318
- }): Promise<EmailTemplateDeleteSuccessRes>;
319
- /**
320
- * @param {Object} arg - Arg object.
321
- * @param {EngineRequest} arg.body
322
- * @returns {Promise<EngineResponse>} - Success response
323
- * @summary: Send email or sms synchronously
324
- * @description: Send email or sms synchronously
325
- */
326
- sendCommunicationSynchronously({ body }?: {
327
- body: EngineRequest;
328
- }): Promise<EngineResponse>;
329
- /**
330
- * @param {Object} arg - Arg object.
331
- * @param {EngineRequest} arg.body
332
- * @returns {Promise<EngineResponse>} - Success response
333
- * @summary: Send email or sms asynchronously
334
- * @description: Send email or sms asynchronously
335
- */
336
- sendCommunicationAsynchronously({ body }?: {
337
- body: EngineRequest;
338
- }): Promise<EngineResponse>;
339
285
  /**
340
286
  * @param {Object} arg - Arg object.
341
287
  * @param {number} [arg.pageNo] - Current page no
@@ -365,45 +311,6 @@ declare class Communication {
365
311
  pageSize?: number;
366
312
  populate?: string;
367
313
  }): Paginator;
368
- /**
369
- * @param {Object} arg - Arg object.
370
- * @param {number} [arg.pageNo] - Current page no
371
- * @param {number} [arg.pageSize] - Current request items count
372
- * @param {Object} [arg.sort] - To sort based on created_at
373
- * @returns {Promise<Jobs>} - Success response
374
- * @summary: Get jobs
375
- * @description: Get jobs
376
- */
377
- getJobs({ pageNo, pageSize, sort }?: {
378
- pageNo?: number;
379
- pageSize?: number;
380
- sort?: any;
381
- }): Promise<Jobs>;
382
- /**
383
- * @param {Object} arg - Arg object.
384
- * @param {string} arg.companyId - Company id
385
- * @param {string} arg.applicationId - Application id
386
- * @param {number} [arg.pageSize] - Current request items count
387
- * @param {Object} [arg.sort] - To sort based on created_at
388
- * @summary: Get jobs
389
- * @description: Get jobs
390
- */
391
- getJobsPaginator({ companyId, applicationId, pageSize, sort }?: {
392
- companyId: string;
393
- applicationId: string;
394
- pageSize?: number;
395
- sort?: any;
396
- }): Paginator;
397
- /**
398
- * @param {Object} arg - Arg object.
399
- * @param {TriggerJobRequest} arg.body
400
- * @returns {Promise<TriggerJobResponse>} - Success response
401
- * @summary: Trigger campaign job
402
- * @description: Trigger campaign job
403
- */
404
- triggerCampaignJob({ body }?: {
405
- body: TriggerJobRequest;
406
- }): Promise<TriggerJobResponse>;
407
314
  /**
408
315
  * @param {Object} arg - Arg object.
409
316
  * @param {number} [arg.pageNo] - Current page no
@@ -435,57 +342,53 @@ declare class Communication {
435
342
  }): Paginator;
436
343
  /**
437
344
  * @param {Object} arg - Arg object.
438
- * @param {string} [arg.pageId] - Current page no
345
+ * @param {number} [arg.pageNo] - Current page no
439
346
  * @param {number} [arg.pageSize] - Current request items count
440
- * @param {Object} [arg.sort] - To sort based on _id
441
- * @param {Object} [arg.query] -
442
- * @returns {Promise<Logs>} - Success response
443
- * @summary: Get communication logs
444
- * @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
445
351
  */
446
- getCommunicationLogs({ pageId, pageSize, sort, query }?: {
447
- pageId?: string;
352
+ getJobs({ pageNo, pageSize, sort }?: {
353
+ pageNo?: number;
448
354
  pageSize?: number;
449
355
  sort?: any;
450
- query?: any;
451
- }): Promise<Logs>;
356
+ }): Promise<Jobs>;
452
357
  /**
453
358
  * @param {Object} arg - Arg object.
454
359
  * @param {string} arg.companyId - Company id
455
360
  * @param {string} arg.applicationId - Application id
456
361
  * @param {number} [arg.pageSize] - Current request items count
457
- * @param {Object} [arg.sort] - To sort based on _id
458
- * @param {Object} [arg.query] -
459
- * @summary: Get communication logs
460
- * @description: Get communication logs
362
+ * @param {Object} [arg.sort] - To sort based on created_at
363
+ * @summary: Get jobs
364
+ * @description: Get jobs
461
365
  */
462
- getCommunicationLogsPaginator({ companyId, applicationId, pageSize, sort, query, }?: {
366
+ getJobsPaginator({ companyId, applicationId, pageSize, sort }?: {
463
367
  companyId: string;
464
368
  applicationId: string;
465
369
  pageSize?: number;
466
370
  sort?: any;
467
- query?: any;
468
371
  }): Paginator;
469
372
  /**
470
373
  * @param {Object} arg - Arg object.
471
- * @param {SendOtpCommsReq} arg.body
472
- * @returns {Promise<SendOtpCommsRes>} - Success response
473
- * @summary: Send OTP using email and sms
474
- * @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
475
378
  */
476
- sendOtp({ body }?: {
477
- body: SendOtpCommsReq;
478
- }): Promise<SendOtpCommsRes>;
379
+ getNSampleRecordsFromCsv({ body }?: {
380
+ body: GetNRecordsCsvReq;
381
+ }): Promise<GetNRecordsCsvRes>;
479
382
  /**
480
383
  * @param {Object} arg - Arg object.
481
- * @param {VerifyOtpCommsReq} arg.body
482
- * @returns {Promise<VerifyOtpCommsSuccessRes>} - Success response
483
- * @summary: Verify OTP sent via email and sms
484
- * @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
485
388
  */
486
- verfiyOtp({ body }?: {
487
- body: VerifyOtpCommsReq;
488
- }): Promise<VerifyOtpCommsSuccessRes>;
389
+ getSmsProviderById({ id }?: {
390
+ id: string;
391
+ }): Promise<SmsProvider>;
489
392
  /**
490
393
  * @param {Object} arg - Arg object.
491
394
  * @param {number} [arg.pageNo] - Current page no
@@ -517,36 +420,14 @@ declare class Communication {
517
420
  }): Paginator;
518
421
  /**
519
422
  * @param {Object} arg - Arg object.
520
- * @param {SmsProviderReq} arg.body
521
- * @returns {Promise<SmsProvider>} - Success response
522
- * @summary: Create sms provider
523
- * @description: Create sms provider
524
- */
525
- createSmsProvider({ body }?: {
526
- body: SmsProviderReq;
527
- }): Promise<SmsProvider>;
528
- /**
529
- * @param {Object} arg - Arg object.
530
- * @param {string} arg.id - Sms provider id
531
- * @returns {Promise<SmsProvider>} - Success response
532
- * @summary: Get sms provider by id
533
- * @description: Get sms provider by id
534
- */
535
- getSmsProviderById({ id }?: {
536
- id: string;
537
- }): Promise<SmsProvider>;
538
- /**
539
- * @param {Object} arg - Arg object.
540
- * @param {string} arg.id - Sms provider id
541
- * @param {SmsProviderReq} arg.body
542
- * @returns {Promise<SmsProvider>} - Success response
543
- * @summary: Update sms provider by id
544
- * @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
545
427
  */
546
- updateSmsProviderById({ id, body }?: {
428
+ getSmsTemplateById({ id }?: {
547
429
  id: string;
548
- body: SmsProviderReq;
549
- }): Promise<SmsProvider>;
430
+ }): Promise<SmsTemplate>;
550
431
  /**
551
432
  * @param {Object} arg - Arg object.
552
433
  * @param {number} [arg.pageNo] - Current page no
@@ -578,46 +459,43 @@ declare class Communication {
578
459
  }): Paginator;
579
460
  /**
580
461
  * @param {Object} arg - Arg object.
581
- * @param {SmsTemplateReq} arg.body
582
- * @returns {Promise<SmsTemplateRes>} - Success response
583
- * @summary: Create sms template
584
- * @description: Create sms template
585
- */
586
- createSmsTemplate({ body }?: {
587
- body: SmsTemplateReq;
588
- }): Promise<SmsTemplateRes>;
589
- /**
590
- * @param {Object} arg - Arg object.
591
- * @param {string} arg.id - Sms template id
592
- * @returns {Promise<SmsTemplate>} - Success response
593
- * @summary: Get sms template by id
594
- * @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
595
466
  */
596
- getSmsTemplateById({ id }?: {
467
+ getStatsOfCampaignById({ id }?: {
597
468
  id: string;
598
- }): Promise<SmsTemplate>;
469
+ }): Promise<GetStats>;
599
470
  /**
600
471
  * @param {Object} arg - Arg object.
601
- * @param {string} arg.id - Sms template id
602
- * @param {SmsTemplateReq} arg.body
603
- * @returns {Promise<SmsTemplateRes>} - Success response
604
- * @summary: Update sms template by id
605
- * @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
606
478
  */
607
- updateSmsTemplateById({ id, body }?: {
608
- id: string;
609
- body: SmsTemplateReq;
610
- }): Promise<SmsTemplateRes>;
479
+ getSystemEmailTemplates({ pageNo, pageSize, sort }?: {
480
+ pageNo?: number;
481
+ pageSize?: number;
482
+ sort?: any;
483
+ }): Promise<SystemEmailTemplates>;
611
484
  /**
612
485
  * @param {Object} arg - Arg object.
613
- * @param {string} arg.id - Sms template id
614
- * @returns {Promise<SmsTemplateDeleteSuccessRes>} - Success response
615
- * @summary: Delete sms template by id
616
- * @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
617
492
  */
618
- deleteSmsTemplateById({ id }?: {
619
- id: string;
620
- }): Promise<SmsTemplateDeleteSuccessRes>;
493
+ getSystemEmailTemplatesPaginator({ companyId, applicationId, pageSize, sort, }?: {
494
+ companyId: string;
495
+ applicationId: string;
496
+ pageSize?: number;
497
+ sort?: any;
498
+ }): Paginator;
621
499
  /**
622
500
  * @param {Object} arg - Arg object.
623
501
  * @param {number} [arg.pageNo] - Current page no
@@ -647,5 +525,127 @@ declare class Communication {
647
525
  pageSize?: number;
648
526
  sort?: any;
649
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>;
650
650
  }
651
651
  import Paginator = require("../../common/Paginator");