@gofynd/fdk-client-javascript 1.0.2 → 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 (310) 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 +557 -1279
  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 +14453 -17192
  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 +3438 -4172
  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 +3400 -5361
  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/Cart/CartApplicationClient.d.ts +243 -243
  44. package/sdk/application/Cart/CartApplicationClient.js +567 -567
  45. package/sdk/application/Cart/CartApplicationModel.d.ts +64 -63
  46. package/sdk/application/Cart/CartApplicationModel.js +489 -886
  47. package/sdk/application/Cart/CartApplicationValidator.d.ts +17 -17
  48. package/sdk/application/Cart/CartApplicationValidator.js +98 -98
  49. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +358 -358
  50. package/sdk/application/Catalog/CatalogApplicationClient.js +1036 -1036
  51. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +90 -90
  52. package/sdk/application/Catalog/CatalogApplicationModel.js +677 -1243
  53. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +19 -19
  54. package/sdk/application/Catalog/CatalogApplicationValidator.js +110 -110
  55. package/sdk/application/Common/CommonApplicationClient.d.ts +13 -13
  56. package/sdk/application/Common/CommonApplicationClient.js +38 -38
  57. package/sdk/application/Common/CommonApplicationModel.d.ts +12 -12
  58. package/sdk/application/Common/CommonApplicationModel.js +83 -160
  59. package/sdk/application/Common/CommonApplicationValidator.d.ts +1 -1
  60. package/sdk/application/Common/CommonApplicationValidator.js +6 -6
  61. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +11 -11
  62. package/sdk/application/Communication/CommunicationApplicationClient.js +26 -26
  63. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +6 -6
  64. package/sdk/application/Communication/CommunicationApplicationModel.js +38 -83
  65. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
  66. package/sdk/application/Communication/CommunicationApplicationValidator.js +4 -4
  67. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +116 -116
  68. package/sdk/application/Configuration/ConfigurationApplicationClient.js +330 -330
  69. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +85 -85
  70. package/sdk/application/Configuration/ConfigurationApplicationModel.js +480 -851
  71. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +8 -8
  72. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +33 -33
  73. package/sdk/application/Content/ContentApplicationClient.d.ts +67 -67
  74. package/sdk/application/Content/ContentApplicationClient.js +191 -191
  75. package/sdk/application/Content/ContentApplicationModel.d.ts +76 -76
  76. package/sdk/application/Content/ContentApplicationModel.js +467 -884
  77. package/sdk/application/Content/ContentApplicationValidator.d.ts +5 -5
  78. package/sdk/application/Content/ContentApplicationValidator.js +24 -24
  79. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +25 -25
  80. package/sdk/application/FileStorage/FileStorageApplicationClient.js +59 -59
  81. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +13 -13
  82. package/sdk/application/FileStorage/FileStorageApplicationModel.js +86 -169
  83. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
  84. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +7 -7
  85. package/sdk/application/Lead/LeadApplicationClient.d.ts +24 -24
  86. package/sdk/application/Lead/LeadApplicationClient.js +100 -100
  87. package/sdk/application/Lead/LeadApplicationModel.d.ts +35 -35
  88. package/sdk/application/Lead/LeadApplicationModel.js +267 -474
  89. package/sdk/application/Lead/LeadApplicationValidator.d.ts +2 -2
  90. package/sdk/application/Lead/LeadApplicationValidator.js +11 -11
  91. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +30 -19
  92. package/sdk/application/Logistic/LogisticApplicationClient.js +110 -43
  93. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +17 -14
  94. package/sdk/application/Logistic/LogisticApplicationModel.js +133 -201
  95. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +3 -2
  96. package/sdk/application/Logistic/LogisticApplicationValidator.js +14 -8
  97. package/sdk/application/Order/OrderApplicationClient.d.ts +85 -85
  98. package/sdk/application/Order/OrderApplicationClient.js +232 -232
  99. package/sdk/application/Order/OrderApplicationModel.d.ts +50 -50
  100. package/sdk/application/Order/OrderApplicationModel.js +352 -656
  101. package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -7
  102. package/sdk/application/Order/OrderApplicationValidator.js +28 -28
  103. package/sdk/application/Payment/PaymentApplicationClient.d.ts +318 -318
  104. package/sdk/application/Payment/PaymentApplicationClient.js +739 -739
  105. package/sdk/application/Payment/PaymentApplicationModel.d.ts +72 -72
  106. package/sdk/application/Payment/PaymentApplicationModel.js +570 -1038
  107. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +28 -28
  108. package/sdk/application/Payment/PaymentApplicationValidator.js +107 -107
  109. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +254 -254
  110. package/sdk/application/PosCart/PosCartApplicationClient.js +617 -617
  111. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +64 -63
  112. package/sdk/application/PosCart/PosCartApplicationModel.js +475 -871
  113. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +18 -18
  114. package/sdk/application/PosCart/PosCartApplicationValidator.js +103 -103
  115. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +27 -27
  116. package/sdk/application/Rewards/RewardsApplicationClient.js +112 -112
  117. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +14 -14
  118. package/sdk/application/Rewards/RewardsApplicationModel.js +96 -191
  119. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +3 -3
  120. package/sdk/application/Rewards/RewardsApplicationValidator.js +12 -12
  121. package/sdk/application/Share/ShareApplicationClient.d.ts +37 -37
  122. package/sdk/application/Share/ShareApplicationClient.js +84 -84
  123. package/sdk/application/Share/ShareApplicationModel.d.ts +8 -8
  124. package/sdk/application/Share/ShareApplicationModel.js +63 -123
  125. package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -4
  126. package/sdk/application/Share/ShareApplicationValidator.js +12 -12
  127. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  128. package/sdk/application/Theme/ThemeApplicationClient.js +31 -31
  129. package/sdk/application/Theme/ThemeApplicationModel.d.ts +34 -34
  130. package/sdk/application/Theme/ThemeApplicationModel.js +190 -336
  131. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +1 -1
  132. package/sdk/application/Theme/ThemeApplicationValidator.js +4 -4
  133. package/sdk/application/User/UserApplicationClient.d.ts +280 -280
  134. package/sdk/application/User/UserApplicationClient.js +581 -581
  135. package/sdk/application/User/UserApplicationModel.d.ts +79 -72
  136. package/sdk/application/User/UserApplicationModel.js +440 -689
  137. package/sdk/application/User/UserApplicationValidator.d.ts +24 -24
  138. package/sdk/application/User/UserApplicationValidator.js +89 -89
  139. package/sdk/common/AxiosHelper.js +1 -1
  140. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +51 -51
  141. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +179 -179
  142. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +6 -6
  143. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +20 -20
  144. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +11 -11
  145. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +95 -178
  146. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +10 -10
  147. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +41 -41
  148. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +10 -10
  149. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +50 -89
  150. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
  151. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +6 -6
  152. package/sdk/platform/Billing/BillingPlatformClient.d.ts +60 -60
  153. package/sdk/platform/Billing/BillingPlatformClient.js +181 -181
  154. package/sdk/platform/Billing/BillingPlatformModel.d.ts +40 -40
  155. package/sdk/platform/Billing/BillingPlatformModel.js +342 -668
  156. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +8 -8
  157. package/sdk/platform/Billing/BillingPlatformValidator.js +25 -25
  158. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +168 -168
  159. package/sdk/platform/Cart/CartPlatformApplicationClient.js +553 -553
  160. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -11
  161. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +63 -63
  162. package/sdk/platform/Cart/CartPlatformModel.d.ts +84 -83
  163. package/sdk/platform/Cart/CartPlatformModel.js +671 -1205
  164. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +632 -632
  165. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1525 -1525
  166. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +40 -40
  167. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +174 -174
  168. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +682 -682
  169. package/sdk/platform/Catalog/CatalogPlatformClient.js +1557 -1557
  170. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +291 -291
  171. package/sdk/platform/Catalog/CatalogPlatformModel.js +2127 -3904
  172. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +66 -66
  173. package/sdk/platform/Catalog/CatalogPlatformValidator.js +229 -229
  174. package/sdk/platform/Common/CommonPlatformClient.d.ts +12 -12
  175. package/sdk/platform/Common/CommonPlatformClient.js +41 -41
  176. package/sdk/platform/Common/CommonPlatformModel.d.ts +12 -12
  177. package/sdk/platform/Common/CommonPlatformModel.js +83 -160
  178. package/sdk/platform/Common/CommonPlatformValidator.d.ts +1 -1
  179. package/sdk/platform/Common/CommonPlatformValidator.js +6 -6
  180. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +326 -326
  181. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +943 -943
  182. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +30 -30
  183. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +87 -87
  184. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +67 -67
  185. package/sdk/platform/Communication/CommunicationPlatformModel.js +522 -974
  186. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +55 -55
  187. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +212 -212
  188. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +27 -27
  189. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +279 -542
  190. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +7 -7
  191. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +24 -24
  192. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +163 -153
  193. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +615 -552
  194. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +22 -21
  195. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +69 -63
  196. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +125 -125
  197. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +342 -342
  198. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +148 -146
  199. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +854 -1508
  200. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -9
  201. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +38 -38
  202. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +534 -534
  203. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1324 -1324
  204. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +50 -50
  205. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +156 -156
  206. package/sdk/platform/Content/ContentPlatformModel.d.ts +78 -78
  207. package/sdk/platform/Content/ContentPlatformModel.js +484 -907
  208. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +65 -65
  209. package/sdk/platform/Discount/DiscountPlatformClient.js +216 -216
  210. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +7 -7
  211. package/sdk/platform/Discount/DiscountPlatformModel.js +60 -121
  212. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +6 -6
  213. package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -29
  214. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +24 -24
  215. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +58 -58
  216. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  217. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +8 -8
  218. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +52 -52
  219. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +123 -123
  220. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -13
  221. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +86 -169
  222. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +3 -3
  223. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -11
  224. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +63 -63
  225. package/sdk/platform/Inventory/InventoryPlatformClient.js +228 -228
  226. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +30 -30
  227. package/sdk/platform/Inventory/InventoryPlatformModel.js +497 -964
  228. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +7 -7
  229. package/sdk/platform/Inventory/InventoryPlatformValidator.js +28 -28
  230. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +73 -73
  231. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +200 -200
  232. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +7 -7
  233. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +28 -28
  234. package/sdk/platform/Lead/LeadPlatformClient.d.ts +80 -80
  235. package/sdk/platform/Lead/LeadPlatformClient.js +212 -212
  236. package/sdk/platform/Lead/LeadPlatformModel.d.ts +35 -35
  237. package/sdk/platform/Lead/LeadPlatformModel.js +267 -474
  238. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +6 -6
  239. package/sdk/platform/Lead/LeadPlatformValidator.js +24 -24
  240. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
  241. package/sdk/platform/Order/OrderPlatformApplicationClient.js +65 -65
  242. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -1
  243. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +6 -6
  244. package/sdk/platform/Order/OrderPlatformClient.d.ts +357 -357
  245. package/sdk/platform/Order/OrderPlatformClient.js +1035 -1035
  246. package/sdk/platform/Order/OrderPlatformModel.d.ts +198 -196
  247. package/sdk/platform/Order/OrderPlatformModel.js +1574 -2861
  248. package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -32
  249. package/sdk/platform/Order/OrderPlatformValidator.js +160 -160
  250. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -1
  251. package/sdk/platform/Partner/PartnerPlatformModel.js +10 -26
  252. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +57 -57
  253. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +167 -167
  254. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -6
  255. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +23 -23
  256. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +42 -42
  257. package/sdk/platform/Payment/PaymentPlatformClient.js +153 -153
  258. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -27
  259. package/sdk/platform/Payment/PaymentPlatformModel.js +222 -410
  260. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +4 -4
  261. package/sdk/platform/Payment/PaymentPlatformValidator.js +21 -21
  262. package/sdk/platform/PlatformApplicationClient.d.ts +1496 -10325
  263. package/sdk/platform/PlatformApplicationClient.js +1584 -13899
  264. package/sdk/platform/PlatformClient.d.ts +7965 -7885
  265. package/sdk/platform/PlatformClient.js +8672 -10105
  266. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +83 -83
  267. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +275 -275
  268. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +8 -8
  269. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +34 -34
  270. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +15 -15
  271. package/sdk/platform/Rewards/RewardsPlatformModel.js +92 -194
  272. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
  273. package/sdk/platform/Share/SharePlatformApplicationClient.js +59 -59
  274. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
  275. package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -6
  276. package/sdk/platform/Share/SharePlatformModel.d.ts +8 -8
  277. package/sdk/platform/Share/SharePlatformModel.js +60 -118
  278. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +132 -132
  279. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +310 -310
  280. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +15 -15
  281. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +44 -44
  282. package/sdk/platform/Theme/ThemePlatformModel.d.ts +34 -34
  283. package/sdk/platform/Theme/ThemePlatformModel.js +190 -336
  284. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +136 -69
  285. package/sdk/platform/User/UserPlatformApplicationClient.js +505 -166
  286. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +12 -7
  287. package/sdk/platform/User/UserPlatformApplicationValidator.js +61 -23
  288. package/sdk/platform/User/UserPlatformModel.d.ts +79 -72
  289. package/sdk/platform/User/UserPlatformModel.js +440 -689
  290. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +31 -31
  291. package/sdk/platform/Webhook/WebhookPlatformClient.js +88 -88
  292. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +7 -7
  293. package/sdk/platform/Webhook/WebhookPlatformModel.js +68 -136
  294. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +3 -3
  295. package/sdk/platform/Webhook/WebhookPlatformValidator.js +14 -14
  296. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +13 -13
  297. package/sdk/public/Configuration/ConfigurationPublicClient.js +38 -38
  298. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +12 -12
  299. package/sdk/public/Configuration/ConfigurationPublicModel.js +85 -162
  300. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -1
  301. package/sdk/public/Configuration/ConfigurationPublicValidator.js +6 -6
  302. package/sdk/public/Inventory/InventoryPublicClient.d.ts +34 -34
  303. package/sdk/public/Inventory/InventoryPublicClient.js +113 -113
  304. package/sdk/public/Inventory/InventoryPublicModel.d.ts +10 -10
  305. package/sdk/public/Inventory/InventoryPublicModel.js +119 -245
  306. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +3 -3
  307. package/sdk/public/Inventory/InventoryPublicValidator.js +15 -15
  308. package/sdk/public/Webhook/WebhookPublicModel.d.ts +7 -7
  309. package/sdk/public/Webhook/WebhookPublicModel.js +68 -136
  310. package/tests/application/catalog.spec.js +7 -0
@@ -3,44 +3,189 @@ declare class User {
3
3
  constructor(_conf: any);
4
4
  _conf: any;
5
5
  _relativeUrls: {
6
+ addEmail: string;
7
+ addMobileNumber: string;
8
+ deleteEmail: string;
9
+ deleteMobileNumber: string;
10
+ deleteUser: string;
11
+ forgotPassword: string;
12
+ getListOfActiveSessions: string;
13
+ getLoggedInUser: string;
14
+ getPlatformConfig: string;
15
+ hasPassword: string;
16
+ loginWithAppleIOS: string;
17
+ loginWithEmailAndPassword: string;
6
18
  loginWithFacebook: string;
7
19
  loginWithGoogle: string;
8
20
  loginWithGoogleAndroid: string;
9
21
  loginWithGoogleIOS: string;
10
- loginWithAppleIOS: string;
11
22
  loginWithOTP: string;
12
- loginWithEmailAndPassword: string;
23
+ loginWithToken: string;
24
+ logout: string;
25
+ registerWithForm: string;
26
+ sendOTPOnEmail: string;
27
+ sendOTPOnMobile: string;
13
28
  sendResetPasswordEmail: string;
14
29
  sendResetPasswordMobile: string;
15
- forgotPassword: string;
16
30
  sendResetToken: string;
17
- loginWithToken: string;
18
- registerWithForm: string;
31
+ sendVerificationLinkToEmail: string;
32
+ sendVerificationLinkToMobile: string;
33
+ setEmailAsPrimary: string;
34
+ setMobileNumberAsPrimary: string;
35
+ updatePassword: string;
36
+ updateProfile: string;
19
37
  verifyEmail: string;
38
+ verifyEmailOTP: string;
20
39
  verifyMobile: string;
21
- hasPassword: string;
22
- updatePassword: string;
23
- deleteUser: string;
24
- logout: string;
25
- sendOTPOnMobile: string;
26
40
  verifyMobileOTP: string;
27
- sendOTPOnEmail: string;
28
- verifyEmailOTP: string;
29
- getLoggedInUser: string;
30
- getListOfActiveSessions: string;
31
- getPlatformConfig: string;
32
- updateProfile: string;
33
- addMobileNumber: string;
34
- deleteMobileNumber: string;
35
- setMobileNumberAsPrimary: string;
36
- sendVerificationLinkToMobile: string;
37
- addEmail: string;
38
- deleteEmail: string;
39
- setEmailAsPrimary: string;
40
- sendVerificationLinkToEmail: string;
41
41
  };
42
42
  _urls: {};
43
43
  updateUrls(urls: any): void;
44
+ /**
45
+ * @param {Object} arg - Arg object.
46
+ * @param {string} [arg.platform] - ID of the application
47
+ * @param {EditEmailRequestSchema} arg.body
48
+ * @returns {Promise<VerifyEmailOTPSuccess>} - Success response
49
+ * @summary: Add email to profile
50
+ * @description: Use this API to add a new email address to a profile
51
+ */
52
+ addEmail({ body, platform }?: {
53
+ platform?: string;
54
+ body: EditEmailRequestSchema;
55
+ }): Promise<VerifyEmailOTPSuccess>;
56
+ /**
57
+ * @param {Object} arg - Arg object.
58
+ * @param {string} [arg.platform] - ID of the application
59
+ * @param {EditMobileRequestSchema} arg.body
60
+ * @returns {Promise<VerifyMobileOTPSuccess>} - Success response
61
+ * @summary: Add mobile number to profile
62
+ * @description: Use this API to add a new mobile number to a profile.
63
+ */
64
+ addMobileNumber({ body, platform }?: {
65
+ platform?: string;
66
+ body: EditMobileRequestSchema;
67
+ }): Promise<VerifyMobileOTPSuccess>;
68
+ /**
69
+ * @param {Object} arg - Arg object.
70
+ * @param {string} [arg.platform] - ID of the application
71
+ * @param {boolean} arg.active - This is a boolean value to check if email
72
+ * ID is active 1. True - Email ID is active 2.False - Email ID is inactive
73
+ * @param {boolean} arg.primary - This is a boolean value to check if email
74
+ * ID is primary (main email ID) 1. True - Email ID is primary 2.False -
75
+ * Email ID is not primary
76
+ * @param {boolean} arg.verified - This is a boolean value to check if email
77
+ * ID is verified 1. True - Email ID is verified 2.False - Email ID is not
78
+ * verified yet
79
+ * @param {string} arg.email - The email ID to delete
80
+ * @returns {Promise<LoginSuccess>} - Success response
81
+ * @summary: Delete email from profile
82
+ * @description: Use this API to delete an email address from a profile
83
+ */
84
+ deleteEmail({ active, primary, verified, email, platform }?: {
85
+ platform?: string;
86
+ active: boolean;
87
+ primary: boolean;
88
+ verified: boolean;
89
+ email: string;
90
+ }): Promise<LoginSuccess>;
91
+ /**
92
+ * @param {Object} arg - Arg object.
93
+ * @param {string} [arg.platform] - ID of the application
94
+ * @param {boolean} arg.active - This is a boolean value to check if mobile
95
+ * number is active 1.True - Number is active 2. False - Number is inactive
96
+ * @param {boolean} arg.primary - This is a boolean value to check if mobile
97
+ * number is primary number (main number) 1. True - Number is primary 2.
98
+ * False - Number is not primary
99
+ * @param {boolean} arg.verified - This is a boolean value to check if
100
+ * mobile number is verified 1. True - Number is verified 2.False - Number
101
+ * is not verified yet
102
+ * @param {string} arg.countryCode - Country code of the phone number, e.g. 91
103
+ * @param {string} arg.phone - Phone number
104
+ * @returns {Promise<LoginSuccess>} - Success response
105
+ * @summary: Delete mobile number from profile
106
+ * @description: Use this API to delete a mobile number from a profile.
107
+ */
108
+ deleteMobileNumber({ active, primary, verified, countryCode, phone, platform, }?: {
109
+ platform?: string;
110
+ active: boolean;
111
+ primary: boolean;
112
+ verified: boolean;
113
+ countryCode: string;
114
+ phone: string;
115
+ }): Promise<LoginSuccess>;
116
+ /**
117
+ * @param {Object} arg - Arg object.
118
+ * @param {DeleteApplicationUserRequestSchema} arg.body
119
+ * @returns {Promise<DeleteUserSuccess>} - Success response
120
+ * @summary: verify otp and delete user
121
+ * @description: verify otp and delete user
122
+ */
123
+ deleteUser({ body }?: {
124
+ body: DeleteApplicationUserRequestSchema;
125
+ }): Promise<DeleteUserSuccess>;
126
+ /**
127
+ * @param {Object} arg - Arg object.
128
+ * @param {ForgotPasswordRequestSchema} arg.body
129
+ * @returns {Promise<LoginSuccess>} - Success response
130
+ * @summary: Forgot Password
131
+ * @description: Use this API to reset a password using the code sent on email or SMS.
132
+ */
133
+ forgotPassword({ body }?: {
134
+ body: ForgotPasswordRequestSchema;
135
+ }): Promise<LoginSuccess>;
136
+ /**
137
+ * @param {Object} arg - Arg object.
138
+ * @returns {Promise<SessionListSuccess>} - Success response
139
+ * @summary: Get list of sessions
140
+ * @description: Use this API to retrieve all active sessions of a user.
141
+ */
142
+ getListOfActiveSessions({}?: any): Promise<SessionListSuccess>;
143
+ /**
144
+ * @param {Object} arg - Arg object.
145
+ * @returns {Promise<UserObjectSchema>} - Success response
146
+ * @summary: Get logged in user
147
+ * @description: Use this API to get the details of a logged in user.
148
+ */
149
+ getLoggedInUser({}?: any): Promise<UserObjectSchema>;
150
+ /**
151
+ * @param {Object} arg - Arg object.
152
+ * @param {string} [arg.name] - Name of the application, e.g. Fynd
153
+ * @returns {Promise<PlatformSchema>} - Success response
154
+ * @summary: Get platform configurations
155
+ * @description: Use this API to get all the platform configurations such as mobile image, desktop image, social logins, and all other text.
156
+ */
157
+ getPlatformConfig({ name }?: {
158
+ name?: string;
159
+ }): Promise<PlatformSchema>;
160
+ /**
161
+ * @param {Object} arg - Arg object.
162
+ * @returns {Promise<HasPasswordSuccess>} - Success response
163
+ * @summary: Check password
164
+ * @description: Use this API to check if user has created a password for login.
165
+ */
166
+ hasPassword({}?: any): Promise<HasPasswordSuccess>;
167
+ /**
168
+ * @param {Object} arg - Arg object.
169
+ * @param {string} [arg.platform] - ID of the application
170
+ * @param {OAuthRequestAppleSchema} arg.body
171
+ * @returns {Promise<AuthSuccess>} - Success response
172
+ * @summary: Login or Register using Apple on iOS
173
+ * @description: Use this API to login or register in iOS app using Apple Account credentials.
174
+ */
175
+ loginWithAppleIOS({ body, platform }?: {
176
+ platform?: string;
177
+ body: OAuthRequestAppleSchema;
178
+ }): Promise<AuthSuccess>;
179
+ /**
180
+ * @param {Object} arg - Arg object.
181
+ * @param {PasswordLoginRequestSchema} arg.body
182
+ * @returns {Promise<LoginSuccess>} - Success response
183
+ * @summary: Login or Register with password
184
+ * @description: Use this API to login or register using an email address and password.
185
+ */
186
+ loginWithEmailAndPassword({ body }?: {
187
+ body: PasswordLoginRequestSchema;
188
+ }): Promise<LoginSuccess>;
44
189
  /**
45
190
  * @param {Object} arg - Arg object.
46
191
  * @param {string} [arg.platform] - ID of the application
@@ -89,18 +234,6 @@ declare class User {
89
234
  platform?: string;
90
235
  body: OAuthRequestSchema;
91
236
  }): Promise<AuthSuccess>;
92
- /**
93
- * @param {Object} arg - Arg object.
94
- * @param {string} [arg.platform] - ID of the application
95
- * @param {OAuthRequestAppleSchema} arg.body
96
- * @returns {Promise<AuthSuccess>} - Success response
97
- * @summary: Login or Register using Apple on iOS
98
- * @description: Use this API to login or register in iOS app using Apple Account credentials.
99
- */
100
- loginWithAppleIOS({ body, platform }?: {
101
- platform?: string;
102
- body: OAuthRequestAppleSchema;
103
- }): Promise<AuthSuccess>;
104
237
  /**
105
238
  * @param {Object} arg - Arg object.
106
239
  * @param {string} [arg.platform] - ID of the application
@@ -115,134 +248,45 @@ declare class User {
115
248
  }): Promise<SendOtpResponse>;
116
249
  /**
117
250
  * @param {Object} arg - Arg object.
118
- * @param {PasswordLoginRequestSchema} arg.body
251
+ * @param {TokenRequestBodySchema} arg.body
119
252
  * @returns {Promise<LoginSuccess>} - Success response
120
- * @summary: Login or Register with password
121
- * @description: Use this API to login or register using an email address and password.
253
+ * @summary: Login or Register with token
254
+ * @description: Use this API to login or register using a token for authentication.
122
255
  */
123
- loginWithEmailAndPassword({ body }?: {
124
- body: PasswordLoginRequestSchema;
256
+ loginWithToken({ body }?: {
257
+ body: TokenRequestBodySchema;
125
258
  }): Promise<LoginSuccess>;
259
+ /**
260
+ * @param {Object} arg - Arg object.
261
+ * @returns {Promise<LogoutSuccess>} - Success response
262
+ * @summary: Logs out currently logged in user
263
+ * @description: Use this API to check to logout a user from the app.
264
+ */
265
+ logout({}?: any): Promise<LogoutSuccess>;
126
266
  /**
127
267
  * @param {Object} arg - Arg object.
128
268
  * @param {string} [arg.platform] - ID of the application
129
- * @param {SendResetPasswordEmailRequestSchema} arg.body
130
- * @returns {Promise<ResetPasswordSuccess>} - Success response
131
- * @summary: Reset Password
132
- * @description: Use this API to reset a password using the link sent on email.
269
+ * @param {FormRegisterRequestSchema} arg.body
270
+ * @returns {Promise<RegisterFormSuccess>} - Success response
271
+ * @summary: Registration using a form
272
+ * @description: Use this API to perform user registration by sending form data in the request body.
133
273
  */
134
- sendResetPasswordEmail({ body, platform }?: {
274
+ registerWithForm({ body, platform }?: {
135
275
  platform?: string;
136
- body: SendResetPasswordEmailRequestSchema;
137
- }): Promise<ResetPasswordSuccess>;
276
+ body: FormRegisterRequestSchema;
277
+ }): Promise<RegisterFormSuccess>;
138
278
  /**
139
279
  * @param {Object} arg - Arg object.
140
280
  * @param {string} [arg.platform] - ID of the application
141
- * @param {SendResetPasswordMobileRequestSchema} arg.body
142
- * @returns {Promise<ResetPasswordSuccess>} - Success response
143
- * @summary: Reset Password
144
- * @description: Use this API to reset a password using the link sent on mobile.
281
+ * @param {SendEmailOtpRequestSchema} arg.body
282
+ * @returns {Promise<EmailOtpSuccess>} - Success response
283
+ * @summary: Send OTP on email
284
+ * @description: Use this API to send an OTP to an email ID.
145
285
  */
146
- sendResetPasswordMobile({ body, platform }?: {
286
+ sendOTPOnEmail({ body, platform }?: {
147
287
  platform?: string;
148
- body: SendResetPasswordMobileRequestSchema;
149
- }): Promise<ResetPasswordSuccess>;
150
- /**
151
- * @param {Object} arg - Arg object.
152
- * @param {ForgotPasswordRequestSchema} arg.body
153
- * @returns {Promise<LoginSuccess>} - Success response
154
- * @summary: Forgot Password
155
- * @description: Use this API to reset a password using the code sent on email or SMS.
156
- */
157
- forgotPassword({ body }?: {
158
- body: ForgotPasswordRequestSchema;
159
- }): Promise<LoginSuccess>;
160
- /**
161
- * @param {Object} arg - Arg object.
162
- * @param {CodeRequestBodySchema} arg.body
163
- * @returns {Promise<ResetPasswordSuccess>} - Success response
164
- * @summary: Reset Password using token
165
- * @description: Use this API to send code to reset password.
166
- */
167
- sendResetToken({ body }?: {
168
- body: CodeRequestBodySchema;
169
- }): Promise<ResetPasswordSuccess>;
170
- /**
171
- * @param {Object} arg - Arg object.
172
- * @param {TokenRequestBodySchema} arg.body
173
- * @returns {Promise<LoginSuccess>} - Success response
174
- * @summary: Login or Register with token
175
- * @description: Use this API to login or register using a token for authentication.
176
- */
177
- loginWithToken({ body }?: {
178
- body: TokenRequestBodySchema;
179
- }): Promise<LoginSuccess>;
180
- /**
181
- * @param {Object} arg - Arg object.
182
- * @param {string} [arg.platform] - ID of the application
183
- * @param {FormRegisterRequestSchema} arg.body
184
- * @returns {Promise<RegisterFormSuccess>} - Success response
185
- * @summary: Registration using a form
186
- * @description: Use this API to perform user registration by sending form data in the request body.
187
- */
188
- registerWithForm({ body, platform }?: {
189
- platform?: string;
190
- body: FormRegisterRequestSchema;
191
- }): Promise<RegisterFormSuccess>;
192
- /**
193
- * @param {Object} arg - Arg object.
194
- * @param {CodeRequestBodySchema} arg.body
195
- * @returns {Promise<VerifyEmailSuccess>} - Success response
196
- * @summary: Verify email
197
- * @description: Use this API to send a verification code to verify an email.
198
- */
199
- verifyEmail({ body }?: {
200
- body: CodeRequestBodySchema;
201
- }): Promise<VerifyEmailSuccess>;
202
- /**
203
- * @param {Object} arg - Arg object.
204
- * @param {CodeRequestBodySchema} arg.body
205
- * @returns {Promise<VerifyEmailSuccess>} - Success response
206
- * @summary: Verify mobile
207
- * @description: Use this API to send a verification code to verify a mobile number.
208
- */
209
- verifyMobile({ body }?: {
210
- body: CodeRequestBodySchema;
211
- }): Promise<VerifyEmailSuccess>;
212
- /**
213
- * @param {Object} arg - Arg object.
214
- * @returns {Promise<HasPasswordSuccess>} - Success response
215
- * @summary: Check password
216
- * @description: Use this API to check if user has created a password for login.
217
- */
218
- hasPassword({}?: any): Promise<HasPasswordSuccess>;
219
- /**
220
- * @param {Object} arg - Arg object.
221
- * @param {UpdatePasswordRequestSchema} arg.body
222
- * @returns {Promise<VerifyEmailSuccess>} - Success response
223
- * @summary: Update user password
224
- * @description: Use this API to update the password.
225
- */
226
- updatePassword({ body }?: {
227
- body: UpdatePasswordRequestSchema;
228
- }): Promise<VerifyEmailSuccess>;
229
- /**
230
- * @param {Object} arg - Arg object.
231
- * @param {DeleteApplicationUserRequestSchema} arg.body
232
- * @returns {Promise<DeleteUserSuccess>} - Success response
233
- * @summary: verify otp and delete user
234
- * @description: verify otp and delete user
235
- */
236
- deleteUser({ body }?: {
237
- body: DeleteApplicationUserRequestSchema;
238
- }): Promise<DeleteUserSuccess>;
239
- /**
240
- * @param {Object} arg - Arg object.
241
- * @returns {Promise<LogoutSuccess>} - Success response
242
- * @summary: Logs out currently logged in user
243
- * @description: Use this API to check to logout a user from the app.
244
- */
245
- logout({}?: any): Promise<LogoutSuccess>;
288
+ body: SendEmailOtpRequestSchema;
289
+ }): Promise<EmailOtpSuccess>;
246
290
  /**
247
291
  * @param {Object} arg - Arg object.
248
292
  * @param {string} [arg.platform] - ID of the application
@@ -258,111 +302,70 @@ declare class User {
258
302
  /**
259
303
  * @param {Object} arg - Arg object.
260
304
  * @param {string} [arg.platform] - ID of the application
261
- * @param {VerifyOtpRequestSchema} arg.body
262
- * @returns {Promise<VerifyOtpSuccess>} - Success response
263
- * @summary: Verify OTP on mobile
264
- * @description: Use this API to verify the OTP received on a mobile number.
265
- */
266
- verifyMobileOTP({ body, platform }?: {
267
- platform?: string;
268
- body: VerifyOtpRequestSchema;
269
- }): Promise<VerifyOtpSuccess>;
270
- /**
271
- * @param {Object} arg - Arg object.
272
- * @param {string} [arg.platform] - ID of the application
273
- * @param {SendEmailOtpRequestSchema} arg.body
274
- * @returns {Promise<EmailOtpSuccess>} - Success response
275
- * @summary: Send OTP on email
276
- * @description: Use this API to send an OTP to an email ID.
305
+ * @param {SendResetPasswordEmailRequestSchema} arg.body
306
+ * @returns {Promise<ResetPasswordSuccess>} - Success response
307
+ * @summary: Reset Password
308
+ * @description: Use this API to reset a password using the link sent on email.
277
309
  */
278
- sendOTPOnEmail({ body, platform }?: {
310
+ sendResetPasswordEmail({ body, platform }?: {
279
311
  platform?: string;
280
- body: SendEmailOtpRequestSchema;
281
- }): Promise<EmailOtpSuccess>;
312
+ body: SendResetPasswordEmailRequestSchema;
313
+ }): Promise<ResetPasswordSuccess>;
282
314
  /**
283
315
  * @param {Object} arg - Arg object.
284
316
  * @param {string} [arg.platform] - ID of the application
285
- * @param {VerifyEmailOtpRequestSchema} arg.body
286
- * @returns {Promise<VerifyOtpSuccess>} - Success response
287
- * @summary: Verify OTP on email
288
- * @description: Use this API to verify the OTP received on an email ID.
317
+ * @param {SendResetPasswordMobileRequestSchema} arg.body
318
+ * @returns {Promise<ResetPasswordSuccess>} - Success response
319
+ * @summary: Reset Password
320
+ * @description: Use this API to reset a password using the link sent on mobile.
289
321
  */
290
- verifyEmailOTP({ body, platform }?: {
322
+ sendResetPasswordMobile({ body, platform }?: {
291
323
  platform?: string;
292
- body: VerifyEmailOtpRequestSchema;
293
- }): Promise<VerifyOtpSuccess>;
294
- /**
295
- * @param {Object} arg - Arg object.
296
- * @returns {Promise<UserObjectSchema>} - Success response
297
- * @summary: Get logged in user
298
- * @description: Use this API to get the details of a logged in user.
299
- */
300
- getLoggedInUser({}?: any): Promise<UserObjectSchema>;
301
- /**
302
- * @param {Object} arg - Arg object.
303
- * @returns {Promise<SessionListSuccess>} - Success response
304
- * @summary: Get list of sessions
305
- * @description: Use this API to retrieve all active sessions of a user.
306
- */
307
- getListOfActiveSessions({}?: any): Promise<SessionListSuccess>;
324
+ body: SendResetPasswordMobileRequestSchema;
325
+ }): Promise<ResetPasswordSuccess>;
308
326
  /**
309
327
  * @param {Object} arg - Arg object.
310
- * @param {string} [arg.name] - Name of the application, e.g. Fynd
311
- * @returns {Promise<PlatformSchema>} - Success response
312
- * @summary: Get platform configurations
313
- * @description: Use this API to get all the platform configurations such as mobile image, desktop image, social logins, and all other text.
328
+ * @param {CodeRequestBodySchema} arg.body
329
+ * @returns {Promise<ResetPasswordSuccess>} - Success response
330
+ * @summary: Reset Password using token
331
+ * @description: Use this API to send code to reset password.
314
332
  */
315
- getPlatformConfig({ name }?: {
316
- name?: string;
317
- }): Promise<PlatformSchema>;
333
+ sendResetToken({ body }?: {
334
+ body: CodeRequestBodySchema;
335
+ }): Promise<ResetPasswordSuccess>;
318
336
  /**
319
337
  * @param {Object} arg - Arg object.
320
338
  * @param {string} [arg.platform] - ID of the application
321
- * @param {EditProfileRequestSchema} arg.body
322
- * @returns {Promise<ProfileEditSuccess>} - Success response
323
- * @summary: Edit Profile Details
324
- * @description: Use this API to update details in the user profile. Details can be first name, last name, gender, email, phone number, or profile picture.
339
+ * @param {EditEmailRequestSchema} arg.body
340
+ * @returns {Promise<SendEmailVerifyLinkSuccess>} - Success response
341
+ * @summary: Send verification link to email
342
+ * @description: Use this API to send verification link to an email address.
325
343
  */
326
- updateProfile({ body, platform }?: {
344
+ sendVerificationLinkToEmail({ body, platform }?: {
327
345
  platform?: string;
328
- body: EditProfileRequestSchema;
329
- }): Promise<ProfileEditSuccess>;
346
+ body: EditEmailRequestSchema;
347
+ }): Promise<SendEmailVerifyLinkSuccess>;
330
348
  /**
331
349
  * @param {Object} arg - Arg object.
332
350
  * @param {string} [arg.platform] - ID of the application
333
- * @param {EditMobileRequestSchema} arg.body
334
- * @returns {Promise<VerifyMobileOTPSuccess>} - Success response
335
- * @summary: Add mobile number to profile
336
- * @description: Use this API to add a new mobile number to a profile.
351
+ * @param {SendVerificationLinkMobileRequestSchema} arg.body
352
+ * @returns {Promise<SendMobileVerifyLinkSuccess>} - Success response
353
+ * @summary: Send verification link to mobile
354
+ * @description: Use this API to send a verification link to a mobile number
337
355
  */
338
- addMobileNumber({ body, platform }?: {
356
+ sendVerificationLinkToMobile({ body, platform }?: {
339
357
  platform?: string;
340
- body: EditMobileRequestSchema;
341
- }): Promise<VerifyMobileOTPSuccess>;
358
+ body: SendVerificationLinkMobileRequestSchema;
359
+ }): Promise<SendMobileVerifyLinkSuccess>;
342
360
  /**
343
361
  * @param {Object} arg - Arg object.
344
- * @param {string} [arg.platform] - ID of the application
345
- * @param {boolean} arg.active - This is a boolean value to check if mobile
346
- * number is active 1.True - Number is active 2. False - Number is inactive
347
- * @param {boolean} arg.primary - This is a boolean value to check if mobile
348
- * number is primary number (main number) 1. True - Number is primary 2.
349
- * False - Number is not primary
350
- * @param {boolean} arg.verified - This is a boolean value to check if
351
- * mobile number is verified 1. True - Number is verified 2.False - Number
352
- * is not verified yet
353
- * @param {string} arg.countryCode - Country code of the phone number, e.g. 91
354
- * @param {string} arg.phone - Phone number
362
+ * @param {EditEmailRequestSchema} arg.body
355
363
  * @returns {Promise<LoginSuccess>} - Success response
356
- * @summary: Delete mobile number from profile
357
- * @description: Use this API to delete a mobile number from a profile.
364
+ * @summary: Set email as primary
365
+ * @description: Use this API to set an email address as primary. Primary email ID is a email address used for all future communications.
358
366
  */
359
- deleteMobileNumber({ active, primary, verified, countryCode, phone, platform, }?: {
360
- platform?: string;
361
- active: boolean;
362
- primary: boolean;
363
- verified: boolean;
364
- countryCode: string;
365
- phone: string;
367
+ setEmailAsPrimary({ body }?: {
368
+ body: EditEmailRequestSchema;
366
369
  }): Promise<LoginSuccess>;
367
370
  /**
368
371
  * @param {Object} arg - Arg object.
@@ -376,71 +379,68 @@ declare class User {
376
379
  }): Promise<LoginSuccess>;
377
380
  /**
378
381
  * @param {Object} arg - Arg object.
379
- * @param {string} [arg.platform] - ID of the application
380
- * @param {SendVerificationLinkMobileRequestSchema} arg.body
381
- * @returns {Promise<SendMobileVerifyLinkSuccess>} - Success response
382
- * @summary: Send verification link to mobile
383
- * @description: Use this API to send a verification link to a mobile number
382
+ * @param {UpdatePasswordRequestSchema} arg.body
383
+ * @returns {Promise<VerifyEmailSuccess>} - Success response
384
+ * @summary: Update user password
385
+ * @description: Use this API to update the password.
384
386
  */
385
- sendVerificationLinkToMobile({ body, platform }?: {
386
- platform?: string;
387
- body: SendVerificationLinkMobileRequestSchema;
388
- }): Promise<SendMobileVerifyLinkSuccess>;
387
+ updatePassword({ body }?: {
388
+ body: UpdatePasswordRequestSchema;
389
+ }): Promise<VerifyEmailSuccess>;
389
390
  /**
390
391
  * @param {Object} arg - Arg object.
391
392
  * @param {string} [arg.platform] - ID of the application
392
- * @param {EditEmailRequestSchema} arg.body
393
- * @returns {Promise<VerifyEmailOTPSuccess>} - Success response
394
- * @summary: Add email to profile
395
- * @description: Use this API to add a new email address to a profile
393
+ * @param {EditProfileRequestSchema} arg.body
394
+ * @returns {Promise<ProfileEditSuccess>} - Success response
395
+ * @summary: Edit Profile Details
396
+ * @description: Use this API to update details in the user profile. Details can be first name, last name, gender, email, phone number, or profile picture.
396
397
  */
397
- addEmail({ body, platform }?: {
398
+ updateProfile({ body, platform }?: {
398
399
  platform?: string;
399
- body: EditEmailRequestSchema;
400
- }): Promise<VerifyEmailOTPSuccess>;
400
+ body: EditProfileRequestSchema;
401
+ }): Promise<ProfileEditSuccess>;
402
+ /**
403
+ * @param {Object} arg - Arg object.
404
+ * @param {CodeRequestBodySchema} arg.body
405
+ * @returns {Promise<VerifyEmailSuccess>} - Success response
406
+ * @summary: Verify email
407
+ * @description: Use this API to send a verification code to verify an email.
408
+ */
409
+ verifyEmail({ body }?: {
410
+ body: CodeRequestBodySchema;
411
+ }): Promise<VerifyEmailSuccess>;
401
412
  /**
402
413
  * @param {Object} arg - Arg object.
403
414
  * @param {string} [arg.platform] - ID of the application
404
- * @param {boolean} arg.active - This is a boolean value to check if email
405
- * ID is active 1. True - Email ID is active 2.False - Email ID is inactive
406
- * @param {boolean} arg.primary - This is a boolean value to check if email
407
- * ID is primary (main email ID) 1. True - Email ID is primary 2.False -
408
- * Email ID is not primary
409
- * @param {boolean} arg.verified - This is a boolean value to check if email
410
- * ID is verified 1. True - Email ID is verified 2.False - Email ID is not
411
- * verified yet
412
- * @param {string} arg.email - The email ID to delete
413
- * @returns {Promise<LoginSuccess>} - Success response
414
- * @summary: Delete email from profile
415
- * @description: Use this API to delete an email address from a profile
415
+ * @param {VerifyEmailOtpRequestSchema} arg.body
416
+ * @returns {Promise<VerifyOtpSuccess>} - Success response
417
+ * @summary: Verify OTP on email
418
+ * @description: Use this API to verify the OTP received on an email ID.
416
419
  */
417
- deleteEmail({ active, primary, verified, email, platform }?: {
420
+ verifyEmailOTP({ body, platform }?: {
418
421
  platform?: string;
419
- active: boolean;
420
- primary: boolean;
421
- verified: boolean;
422
- email: string;
423
- }): Promise<LoginSuccess>;
422
+ body: VerifyEmailOtpRequestSchema;
423
+ }): Promise<VerifyOtpSuccess>;
424
424
  /**
425
425
  * @param {Object} arg - Arg object.
426
- * @param {EditEmailRequestSchema} arg.body
427
- * @returns {Promise<LoginSuccess>} - Success response
428
- * @summary: Set email as primary
429
- * @description: Use this API to set an email address as primary. Primary email ID is a email address used for all future communications.
426
+ * @param {CodeRequestBodySchema} arg.body
427
+ * @returns {Promise<VerifyEmailSuccess>} - Success response
428
+ * @summary: Verify mobile
429
+ * @description: Use this API to send a verification code to verify a mobile number.
430
430
  */
431
- setEmailAsPrimary({ body }?: {
432
- body: EditEmailRequestSchema;
433
- }): Promise<LoginSuccess>;
431
+ verifyMobile({ body }?: {
432
+ body: CodeRequestBodySchema;
433
+ }): Promise<VerifyEmailSuccess>;
434
434
  /**
435
435
  * @param {Object} arg - Arg object.
436
436
  * @param {string} [arg.platform] - ID of the application
437
- * @param {EditEmailRequestSchema} arg.body
438
- * @returns {Promise<SendEmailVerifyLinkSuccess>} - Success response
439
- * @summary: Send verification link to email
440
- * @description: Use this API to send verification link to an email address.
437
+ * @param {VerifyOtpRequestSchema} arg.body
438
+ * @returns {Promise<VerifyOtpSuccess>} - Success response
439
+ * @summary: Verify OTP on mobile
440
+ * @description: Use this API to verify the OTP received on a mobile number.
441
441
  */
442
- sendVerificationLinkToEmail({ body, platform }?: {
442
+ verifyMobileOTP({ body, platform }?: {
443
443
  platform?: string;
444
- body: EditEmailRequestSchema;
445
- }): Promise<SendEmailVerifyLinkSuccess>;
444
+ body: VerifyOtpRequestSchema;
445
+ }): Promise<VerifyOtpSuccess>;
446
446
  }