@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (321) hide show
  1. package/README.md +12 -0
  2. package/index.js +0 -3
  3. package/package.json +1 -1
  4. package/sdk/application/ApplicationAPIClient.d.ts +15 -1
  5. package/sdk/application/ApplicationAPIClient.js +8 -1
  6. package/sdk/application/ApplicationClient.d.ts +37 -6
  7. package/sdk/application/ApplicationClient.js +31 -0
  8. package/sdk/application/ApplicationConfig.d.ts +52 -12
  9. package/sdk/application/ApplicationConfig.js +37 -2
  10. package/sdk/application/ApplicationModels.d.ts +46 -1
  11. package/sdk/application/ApplicationModels.js +18 -0
  12. package/sdk/application/Cart/CartApplicationClient.d.ts +172 -357
  13. package/sdk/application/Cart/CartApplicationClient.js +620 -483
  14. package/sdk/application/Cart/CartApplicationModel.d.ts +2054 -96
  15. package/sdk/application/Cart/CartApplicationModel.js +1224 -93
  16. package/sdk/application/Cart/CartApplicationValidator.d.ts +508 -30
  17. package/sdk/application/Cart/CartApplicationValidator.js +270 -15
  18. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +234 -413
  19. package/sdk/application/Catalog/CatalogApplicationClient.js +777 -630
  20. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2218 -117
  21. package/sdk/application/Catalog/CatalogApplicationModel.js +1499 -170
  22. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +798 -31
  23. package/sdk/application/Catalog/CatalogApplicationValidator.js +318 -3
  24. package/sdk/application/Common/CommonApplicationClient.d.ts +14 -21
  25. package/sdk/application/Common/CommonApplicationClient.js +50 -33
  26. package/sdk/application/Common/CommonApplicationModel.d.ts +448 -19
  27. package/sdk/application/Common/CommonApplicationModel.js +224 -16
  28. package/sdk/application/Common/CommonApplicationValidator.d.ts +42 -4
  29. package/sdk/application/Common/CommonApplicationValidator.js +21 -3
  30. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +25 -18
  31. package/sdk/application/Communication/CommunicationApplicationClient.js +74 -47
  32. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +190 -14
  33. package/sdk/application/Communication/CommunicationApplicationModel.js +124 -7
  34. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +27 -4
  35. package/sdk/application/Communication/CommunicationApplicationValidator.js +21 -5
  36. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +113 -112
  37. package/sdk/application/Configuration/ConfigurationApplicationClient.js +381 -260
  38. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +2453 -110
  39. package/sdk/application/Configuration/ConfigurationApplicationModel.js +1254 -108
  40. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +160 -8
  41. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +88 -4
  42. package/sdk/application/Content/ContentApplicationClient.d.ts +120 -138
  43. package/sdk/application/Content/ContentApplicationClient.js +409 -277
  44. package/sdk/application/Content/ContentApplicationModel.d.ts +1627 -105
  45. package/sdk/application/Content/ContentApplicationModel.js +1202 -109
  46. package/sdk/application/Content/ContentApplicationValidator.d.ts +214 -12
  47. package/sdk/application/Content/ContentApplicationValidator.js +113 -3
  48. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +20 -29
  49. package/sdk/application/FileStorage/FileStorageApplicationClient.js +68 -47
  50. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +299 -20
  51. package/sdk/application/FileStorage/FileStorageApplicationModel.js +209 -16
  52. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +55 -5
  53. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +33 -6
  54. package/sdk/application/Lead/LeadApplicationClient.d.ts +50 -53
  55. package/sdk/application/Lead/LeadApplicationClient.js +169 -103
  56. package/sdk/application/Lead/LeadApplicationModel.d.ts +1405 -54
  57. package/sdk/application/Lead/LeadApplicationModel.js +619 -73
  58. package/sdk/application/Lead/LeadApplicationValidator.d.ts +91 -9
  59. package/sdk/application/Lead/LeadApplicationValidator.js +51 -6
  60. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +34 -33
  61. package/sdk/application/Logistic/LogisticApplicationClient.js +110 -73
  62. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +399 -28
  63. package/sdk/application/Logistic/LogisticApplicationModel.js +293 -24
  64. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +48 -6
  65. package/sdk/application/Logistic/LogisticApplicationValidator.js +34 -6
  66. package/sdk/application/Order/OrderApplicationClient.d.ts +81 -133
  67. package/sdk/application/Order/OrderApplicationClient.js +297 -217
  68. package/sdk/application/Order/OrderApplicationModel.d.ts +1101 -66
  69. package/sdk/application/Order/OrderApplicationModel.js +776 -57
  70. package/sdk/application/Order/OrderApplicationValidator.d.ts +249 -14
  71. package/sdk/application/Order/OrderApplicationValidator.js +114 -5
  72. package/sdk/application/Payment/PaymentApplicationClient.d.ts +341 -356
  73. package/sdk/application/Payment/PaymentApplicationClient.js +1077 -703
  74. package/sdk/application/Payment/PaymentApplicationModel.d.ts +3125 -99
  75. package/sdk/application/Payment/PaymentApplicationModel.js +1158 -62
  76. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +494 -41
  77. package/sdk/application/Payment/PaymentApplicationValidator.js +297 -25
  78. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +178 -350
  79. package/sdk/application/PosCart/PosCartApplicationClient.js +636 -491
  80. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1823 -89
  81. package/sdk/application/PosCart/PosCartApplicationModel.js +1117 -85
  82. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +480 -29
  83. package/sdk/application/PosCart/PosCartApplicationValidator.js +262 -15
  84. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +49 -47
  85. package/sdk/application/Rewards/RewardsApplicationClient.js +160 -102
  86. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +343 -22
  87. package/sdk/application/Rewards/RewardsApplicationModel.js +230 -15
  88. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +70 -7
  89. package/sdk/application/Rewards/RewardsApplicationValidator.js +45 -6
  90. package/sdk/application/Share/ShareApplicationClient.d.ts +44 -50
  91. package/sdk/application/Share/ShareApplicationClient.js +165 -97
  92. package/sdk/application/Share/ShareApplicationModel.d.ts +230 -15
  93. package/sdk/application/Share/ShareApplicationModel.js +154 -16
  94. package/sdk/application/Share/ShareApplicationValidator.d.ts +86 -8
  95. package/sdk/application/Share/ShareApplicationValidator.js +48 -4
  96. package/sdk/application/Theme/ThemeApplicationClient.d.ts +25 -27
  97. package/sdk/application/Theme/ThemeApplicationClient.js +83 -54
  98. package/sdk/application/Theme/ThemeApplicationModel.d.ts +621 -48
  99. package/sdk/application/Theme/ThemeApplicationModel.js +464 -40
  100. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +49 -5
  101. package/sdk/application/Theme/ThemeApplicationValidator.js +26 -3
  102. package/sdk/application/User/UserApplicationClient.d.ts +219 -303
  103. package/sdk/application/User/UserApplicationClient.js +819 -522
  104. package/sdk/application/User/UserApplicationModel.d.ts +1390 -101
  105. package/sdk/application/User/UserApplicationModel.js +983 -44
  106. package/sdk/application/User/UserApplicationValidator.d.ts +457 -33
  107. package/sdk/application/User/UserApplicationValidator.js +265 -31
  108. package/sdk/common/AxiosHelper.js +8 -2
  109. package/sdk/common/Paginator.d.ts +27 -12
  110. package/sdk/common/Paginator.js +15 -0
  111. package/sdk/common/RequestSigner.js +0 -1
  112. package/sdk/partner/PartnerAPIClient.d.ts +15 -1
  113. package/sdk/partner/PartnerAPIClient.js +8 -1
  114. package/sdk/partner/PartnerClient.d.ts +20 -3
  115. package/sdk/partner/PartnerClient.js +17 -0
  116. package/sdk/partner/PartnerConfig.d.ts +40 -14
  117. package/sdk/partner/PartnerConfig.js +31 -6
  118. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +26 -25
  119. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +82 -53
  120. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +202 -17
  121. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +139 -10
  122. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +42 -5
  123. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +26 -4
  124. package/sdk/platform/Billing/BillingPlatformClient.d.ts +88 -97
  125. package/sdk/platform/Billing/BillingPlatformClient.js +310 -191
  126. package/sdk/platform/Billing/BillingPlatformModel.d.ts +1211 -68
  127. package/sdk/platform/Billing/BillingPlatformModel.js +824 -59
  128. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +153 -12
  129. package/sdk/platform/Billing/BillingPlatformValidator.js +87 -8
  130. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +392 -634
  131. package/sdk/platform/Cart/CartPlatformApplicationClient.js +1480 -957
  132. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +827 -57
  133. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +492 -34
  134. package/sdk/platform/Cart/CartPlatformModel.d.ts +3639 -175
  135. package/sdk/platform/Cart/CartPlatformModel.js +2368 -212
  136. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +438 -615
  137. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1449 -984
  138. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1081 -49
  139. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +482 -23
  140. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +573 -824
  141. package/sdk/platform/Catalog/CatalogPlatformClient.js +1773 -1264
  142. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6871 -326
  143. package/sdk/platform/Catalog/CatalogPlatformModel.js +4215 -349
  144. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1331 -71
  145. package/sdk/platform/Catalog/CatalogPlatformValidator.js +611 -30
  146. package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -21
  147. package/sdk/platform/Common/CommonPlatformClient.js +48 -33
  148. package/sdk/platform/Common/CommonPlatformModel.d.ts +448 -19
  149. package/sdk/platform/Common/CommonPlatformModel.js +224 -16
  150. package/sdk/platform/Common/CommonPlatformValidator.d.ts +42 -4
  151. package/sdk/platform/Common/CommonPlatformValidator.js +21 -3
  152. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +457 -279
  153. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1423 -553
  154. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +581 -42
  155. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +294 -22
  156. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +18 -5
  157. package/sdk/platform/Communication/CommunicationPlatformClient.js +58 -19
  158. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1630 -102
  159. package/sdk/platform/Communication/CommunicationPlatformModel.js +1150 -85
  160. package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +16 -3
  161. package/sdk/platform/Communication/CommunicationPlatformValidator.js +11 -3
  162. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +102 -111
  163. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +321 -225
  164. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +830 -43
  165. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +612 -78
  166. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +180 -13
  167. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +98 -10
  168. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +232 -212
  169. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +737 -438
  170. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +293 -22
  171. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +184 -17
  172. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +166 -178
  173. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +519 -310
  174. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +4504 -188
  175. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2242 -204
  176. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +332 -19
  177. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +153 -10
  178. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +495 -560
  179. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1777 -987
  180. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +872 -62
  181. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +487 -35
  182. package/sdk/platform/Content/ContentPlatformModel.d.ts +1661 -108
  183. package/sdk/platform/Content/ContentPlatformModel.js +1217 -113
  184. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +67 -101
  185. package/sdk/platform/Discount/DiscountPlatformClient.js +240 -176
  186. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +242 -15
  187. package/sdk/platform/Discount/DiscountPlatformModel.js +162 -10
  188. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +185 -13
  189. package/sdk/platform/Discount/DiscountPlatformValidator.js +88 -8
  190. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +32 -41
  191. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +106 -74
  192. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +77 -6
  193. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +41 -6
  194. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +39 -54
  195. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +124 -99
  196. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +299 -20
  197. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +207 -16
  198. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +98 -8
  199. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +54 -7
  200. package/sdk/platform/Finance/FinancePlatformClient.d.ts +85 -91
  201. package/sdk/platform/Finance/FinancePlatformClient.js +272 -180
  202. package/sdk/platform/Finance/FinancePlatformModel.d.ts +619 -50
  203. package/sdk/platform/Finance/FinancePlatformModel.js +458 -30
  204. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +123 -15
  205. package/sdk/platform/Finance/FinancePlatformValidator.js +95 -16
  206. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +99 -97
  207. package/sdk/platform/Inventory/InventoryPlatformClient.js +288 -199
  208. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +1354 -61
  209. package/sdk/platform/Inventory/InventoryPlatformModel.js +916 -83
  210. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +168 -12
  211. package/sdk/platform/Inventory/InventoryPlatformValidator.js +82 -6
  212. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +86 -106
  213. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +326 -186
  214. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +180 -14
  215. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +94 -9
  216. package/sdk/platform/Lead/LeadPlatformClient.d.ts +75 -101
  217. package/sdk/platform/Lead/LeadPlatformClient.js +240 -174
  218. package/sdk/platform/Lead/LeadPlatformModel.d.ts +1403 -54
  219. package/sdk/platform/Lead/LeadPlatformModel.js +618 -73
  220. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +173 -12
  221. package/sdk/platform/Lead/LeadPlatformValidator.js +85 -8
  222. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +18 -14
  223. package/sdk/platform/Order/OrderPlatformApplicationClient.js +56 -29
  224. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +26 -4
  225. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
  226. package/sdk/platform/Order/OrderPlatformClient.d.ts +343 -556
  227. package/sdk/platform/Order/OrderPlatformClient.js +969 -762
  228. package/sdk/platform/Order/OrderPlatformModel.d.ts +4967 -247
  229. package/sdk/platform/Order/OrderPlatformModel.js +3249 -259
  230. package/sdk/platform/Order/OrderPlatformValidator.d.ts +758 -37
  231. package/sdk/platform/Order/OrderPlatformValidator.js +351 -22
  232. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +28 -36
  233. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +103 -59
  234. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +66 -6
  235. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +32 -4
  236. package/sdk/platform/Partner/PartnerPlatformClient.d.ts +68 -107
  237. package/sdk/platform/Partner/PartnerPlatformClient.js +253 -174
  238. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +767 -45
  239. package/sdk/platform/Partner/PartnerPlatformModel.js +524 -41
  240. package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +207 -13
  241. package/sdk/platform/Partner/PartnerPlatformValidator.js +87 -5
  242. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +255 -260
  243. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +860 -504
  244. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +348 -30
  245. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +221 -19
  246. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +73 -73
  247. package/sdk/platform/Payment/PaymentPlatformClient.js +238 -154
  248. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2658 -93
  249. package/sdk/platform/Payment/PaymentPlatformModel.js +1035 -36
  250. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +111 -11
  251. package/sdk/platform/Payment/PaymentPlatformValidator.js +68 -7
  252. package/sdk/platform/PlatformAPIClient.d.ts +16 -1
  253. package/sdk/platform/PlatformAPIClient.js +9 -1
  254. package/sdk/platform/PlatformApplicationClient.d.ts +22 -1798
  255. package/sdk/platform/PlatformApplicationClient.js +17 -1899
  256. package/sdk/platform/PlatformClient.d.ts +29 -12579
  257. package/sdk/platform/PlatformClient.js +26 -15085
  258. package/sdk/platform/PlatformConfig.d.ts +37 -11
  259. package/sdk/platform/PlatformConfig.js +32 -6
  260. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +80 -92
  261. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +307 -177
  262. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +149 -12
  263. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +82 -8
  264. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +371 -23
  265. package/sdk/platform/Rewards/RewardsPlatformModel.js +246 -16
  266. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +120 -89
  267. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +349 -201
  268. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +128 -12
  269. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +85 -11
  270. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +148 -178
  271. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +454 -329
  272. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1399 -96
  273. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1022 -71
  274. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +280 -18
  275. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -11
  276. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +38 -47
  277. package/sdk/platform/Share/SharePlatformApplicationClient.js +137 -73
  278. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +87 -7
  279. package/sdk/platform/Share/SharePlatformApplicationValidator.js +42 -5
  280. package/sdk/platform/Share/SharePlatformModel.d.ts +250 -16
  281. package/sdk/platform/Share/SharePlatformModel.js +165 -17
  282. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +149 -183
  283. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +579 -330
  284. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +308 -24
  285. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +162 -10
  286. package/sdk/platform/Theme/ThemePlatformModel.d.ts +621 -48
  287. package/sdk/platform/Theme/ThemePlatformModel.js +464 -40
  288. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +119 -151
  289. package/sdk/platform/User/UserPlatformApplicationClient.js +411 -244
  290. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +235 -18
  291. package/sdk/platform/User/UserPlatformApplicationValidator.js +126 -12
  292. package/sdk/platform/User/UserPlatformModel.d.ts +1390 -101
  293. package/sdk/platform/User/UserPlatformModel.js +983 -44
  294. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +38 -47
  295. package/sdk/platform/Webhook/WebhookPlatformClient.js +137 -87
  296. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +242 -16
  297. package/sdk/platform/Webhook/WebhookPlatformModel.js +167 -18
  298. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +83 -7
  299. package/sdk/platform/Webhook/WebhookPlatformValidator.js +43 -5
  300. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -21
  301. package/sdk/public/Configuration/ConfigurationPublicClient.js +46 -33
  302. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +473 -19
  303. package/sdk/public/Configuration/ConfigurationPublicModel.js +224 -16
  304. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +42 -4
  305. package/sdk/public/Configuration/ConfigurationPublicValidator.js +21 -3
  306. package/sdk/public/Inventory/InventoryPublicClient.d.ts +48 -48
  307. package/sdk/public/Inventory/InventoryPublicClient.js +146 -98
  308. package/sdk/public/Inventory/InventoryPublicModel.d.ts +392 -21
  309. package/sdk/public/Inventory/InventoryPublicModel.js +267 -27
  310. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +90 -8
  311. package/sdk/public/Inventory/InventoryPublicValidator.js +44 -4
  312. package/sdk/public/PublicClient.d.ts +19 -3
  313. package/sdk/public/PublicClient.js +16 -0
  314. package/sdk/public/PublicConfig.d.ts +27 -6
  315. package/sdk/public/PublicConfig.js +17 -1
  316. package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -11
  317. package/sdk/public/Webhook/WebhookPublicClient.js +42 -27
  318. package/sdk/public/Webhook/WebhookPublicModel.d.ts +242 -16
  319. package/sdk/public/Webhook/WebhookPublicModel.js +167 -18
  320. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +18 -3
  321. package/sdk/public/Webhook/WebhookPublicValidator.js +14 -4
@@ -35,445 +35,260 @@ declare class Cart {
35
35
  _urls: {};
36
36
  updateUrls(urls: any): void;
37
37
  /**
38
- * @param {Object} arg - Arg object.
39
- * @param {Address} arg.body
40
- * @returns {Promise<SaveAddressResponse>} - Success response
38
+ * @param {CartApplicationValidator.AddAddressParam} arg - Arg object.
39
+ * @param {import("../ApplicationAPIClient").Options} - Options
40
+ * @returns {Promise<CartApplicationModel.SaveAddressResponse>} - Success response
41
+ * @name addAddress
41
42
  * @summary: Add address to an account
42
- * @description: Use this API to add an address to an account.
43
+ * @description: Use this API to add an address to an account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/addAddress/).
43
44
  */
44
- addAddress({ body }?: {
45
- body: Address;
46
- }): Promise<SaveAddressResponse>;
45
+ addAddress({ body }?: CartApplicationValidator.AddAddressParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.SaveAddressResponse>;
47
46
  /**
48
- * @param {Object} arg - Arg object.
49
- * @param {boolean} [arg.i] -
50
- * @param {boolean} [arg.b] -
51
- * @param {string} [arg.areaCode] -
52
- * @param {boolean} [arg.buyNow] -
53
- * @param {string} [arg.id] -
54
- * @param {AddCartRequest} arg.body
55
- * @returns {Promise<AddCartDetailResponse>} - Success response
47
+ * @param {CartApplicationValidator.AddItemsParam} arg - Arg object.
48
+ * @param {import("../ApplicationAPIClient").Options} - Options
49
+ * @returns {Promise<CartApplicationModel.AddCartDetailResponse>} - Success response
50
+ * @name addItems
56
51
  * @summary: Add items to cart
57
- * @description: Use this API to add items to the cart.
52
+ * @description: Use this API to add items to the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/addItems/).
58
53
  */
59
- addItems({ body, i, b, areaCode, buyNow, id }?: {
60
- i?: boolean;
61
- b?: boolean;
62
- areaCode?: string;
63
- buyNow?: boolean;
64
- id?: string;
65
- body: AddCartRequest;
66
- }): Promise<AddCartDetailResponse>;
54
+ addItems({ body, i, b, areaCode, buyNow, id }?: CartApplicationValidator.AddItemsParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.AddCartDetailResponse>;
67
55
  /**
68
- * @param {Object} arg - Arg object.
69
- * @param {boolean} [arg.i] -
70
- * @param {boolean} [arg.b] -
71
- * @param {boolean} [arg.p] -
72
- * @param {string} [arg.id] -
73
- * @param {boolean} [arg.buyNow] -
74
- * @param {ApplyCouponRequest} arg.body
75
- * @returns {Promise<CartDetailResponse>} - Success response
56
+ * @param {CartApplicationValidator.ApplyCouponParam} arg - Arg object.
57
+ * @param {import("../ApplicationAPIClient").Options} - Options
58
+ * @returns {Promise<CartApplicationModel.CartDetailResponse>} - Success response
59
+ * @name applyCoupon
76
60
  * @summary: Apply Coupon
77
- * @description: Use this API to apply coupons on items in the cart.
61
+ * @description: Use this API to apply coupons on items in the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/applyCoupon/).
78
62
  */
79
- applyCoupon({ body, i, b, p, id, buyNow }?: {
80
- i?: boolean;
81
- b?: boolean;
82
- p?: boolean;
83
- id?: string;
84
- buyNow?: boolean;
85
- body: ApplyCouponRequest;
86
- }): Promise<CartDetailResponse>;
63
+ applyCoupon({ body, i, b, p, id, buyNow }?: CartApplicationValidator.ApplyCouponParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.CartDetailResponse>;
87
64
  /**
88
- * @param {Object} arg - Arg object.
89
- * @param {string} [arg.id] -
90
- * @param {boolean} [arg.i] -
91
- * @param {boolean} [arg.b] -
92
- * @param {boolean} [arg.buyNow] -
93
- * @param {RewardPointRequest} arg.body
94
- * @returns {Promise<CartDetailResponse>} - Success response
65
+ * @param {CartApplicationValidator.ApplyRewardPointsParam} arg - Arg object.
66
+ * @param {import("../ApplicationAPIClient").Options} - Options
67
+ * @returns {Promise<CartApplicationModel.CartDetailResponse>} - Success response
68
+ * @name applyRewardPoints
95
69
  * @summary: Apply reward points at cart
96
- * @description: Use this API to redeem a fixed no. of reward points by applying it to the cart.
70
+ * @description: Use this API to redeem a fixed no. of reward points by applying it to the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/applyRewardPoints/).
97
71
  */
98
- applyRewardPoints({ body, id, i, b, buyNow }?: {
99
- id?: string;
100
- i?: boolean;
101
- b?: boolean;
102
- buyNow?: boolean;
103
- body: RewardPointRequest;
104
- }): Promise<CartDetailResponse>;
72
+ applyRewardPoints({ body, id, i, b, buyNow }?: CartApplicationValidator.ApplyRewardPointsParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.CartDetailResponse>;
105
73
  /**
106
- * @param {Object} arg - Arg object.
107
- * @param {boolean} [arg.buyNow] - This indicates the type of cart to checkout
108
- * @param {CartCheckoutDetailRequest} arg.body
109
- * @returns {Promise<CartCheckoutResponse>} - Success response
74
+ * @param {CartApplicationValidator.CheckoutCartParam} arg - Arg object.
75
+ * @param {import("../ApplicationAPIClient").Options} - Options
76
+ * @returns {Promise<CartApplicationModel.CartCheckoutResponse>} - Success response
77
+ * @name checkoutCart
110
78
  * @summary: Checkout all items in the cart
111
- * @description: Use this API to checkout all items in the cart for payment and order generation. For COD, order will be directly generated, whereas for other checkout modes, user will be redirected to a payment gateway.
79
+ * @description: Use this API to checkout all items in the cart for payment and order generation. For COD, order will be directly generated, whereas for other checkout modes, user will be redirected to a payment gateway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/checkoutCart/).
112
80
  */
113
- checkoutCart({ body, buyNow }?: {
114
- buyNow?: boolean;
115
- body: CartCheckoutDetailRequest;
116
- }): Promise<CartCheckoutResponse>;
81
+ checkoutCart({ body, buyNow }?: CartApplicationValidator.CheckoutCartParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.CartCheckoutResponse>;
117
82
  /**
118
- * @param {Object} arg - Arg object.
119
- * @param {boolean} [arg.buyNow] - This indicates the type of cart to checkout
120
- * @param {CartCheckoutDetailV2Request} arg.body
121
- * @returns {Promise<CartCheckoutResponse>} - Success response
83
+ * @param {CartApplicationValidator.CheckoutCartV2Param} arg - Arg object.
84
+ * @param {import("../ApplicationAPIClient").Options} - Options
85
+ * @returns {Promise<CartApplicationModel.CartCheckoutResponse>} - Success response
86
+ * @name checkoutCartV2
122
87
  * @summary: Checkout all items in the cart
123
- * @description: Use this API to checkout all items in the cart for payment and order generation. For COD, order will be directly generated, whereas for other checkout modes, user will be redirected to a payment gateway.
88
+ * @description: Use this API to checkout all items in the cart for payment and order generation. For COD, order will be directly generated, whereas for other checkout modes, user will be redirected to a payment gateway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/checkoutCartV2/).
124
89
  */
125
- checkoutCartV2({ body, buyNow }?: {
126
- buyNow?: boolean;
127
- body: CartCheckoutDetailV2Request;
128
- }): Promise<CartCheckoutResponse>;
90
+ checkoutCartV2({ body, buyNow }?: CartApplicationValidator.CheckoutCartV2Param, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.CartCheckoutResponse>;
129
91
  /**
130
- * @param {Object} arg - Arg object.
131
- * @param {string} [arg.id] - The unique identifier of the cart.
132
- * @returns {Promise<DeleteCartDetailResponse>} - Success response
92
+ * @param {CartApplicationValidator.DeleteCartParam} arg - Arg object.
93
+ * @param {import("../ApplicationAPIClient").Options} - Options
94
+ * @returns {Promise<CartApplicationModel.DeleteCartDetailResponse>} -
95
+ * Success response
96
+ * @name deleteCart
133
97
  * @summary: Delete cart once user made successful checkout
134
- * @description: Use this API to delete the cart.
98
+ * @description: Use this API to delete the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/deleteCart/).
135
99
  */
136
- deleteCart({ id }?: {
137
- id?: string;
138
- }): Promise<DeleteCartDetailResponse>;
100
+ deleteCart({ id }?: CartApplicationValidator.DeleteCartParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.DeleteCartDetailResponse>;
139
101
  /**
140
- * @param {Object} arg - Arg object.
141
- * @param {string} arg.id -
142
- * @param {string} [arg.cartId] -
143
- * @param {boolean} [arg.buyNow] -
144
- * @param {string} [arg.mobileNo] -
145
- * @param {string} [arg.checkoutMode] -
146
- * @param {string} [arg.tags] -
147
- * @param {boolean} [arg.isDefault] -
148
- * @returns {Promise<Address>} - Success response
102
+ * @param {CartApplicationValidator.GetAddressByIdParam} arg - Arg object.
103
+ * @param {import("../ApplicationAPIClient").Options} - Options
104
+ * @returns {Promise<CartApplicationModel.Address>} - Success response
105
+ * @name getAddressById
149
106
  * @summary: Fetch a single address by its ID
150
- * @description: Use this API to get an addresses using its ID. If successful, returns a Address resource in the response body specified in `Address`. Attibutes listed below are optional <ul> <li> <font color="monochrome">mobile_no</font></li> <li> <font color="monochrome">checkout_mode</font></li> <li> <font color="monochrome">tags</font></li> <li> <font color="monochrome">default</font></li> </ul>
107
+ * @description: Use this API to get an addresses using its ID. If successful, returns a Address resource in the response body specified in `Address`. Attibutes listed below are optional <ul> <li> <font color="monochrome">mobile_no</font></li> <li> <font color="monochrome">checkout_mode</font></li> <li> <font color="monochrome">tags</font></li> <li> <font color="monochrome">default</font></li> </ul> - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getAddressById/).
151
108
  */
152
- getAddressById({ id, cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, }?: {
153
- id: string;
154
- cartId?: string;
155
- buyNow?: boolean;
156
- mobileNo?: string;
157
- checkoutMode?: string;
158
- tags?: string;
159
- isDefault?: boolean;
160
- }): Promise<Address>;
109
+ getAddressById({ id, cartId, buyNow, mobileNo, checkoutMode, tags, isDefault }?: CartApplicationValidator.GetAddressByIdParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.Address>;
161
110
  /**
162
- * @param {Object} arg - Arg object.
163
- * @param {string} [arg.cartId] -
164
- * @param {boolean} [arg.buyNow] -
165
- * @param {string} [arg.mobileNo] -
166
- * @param {string} [arg.checkoutMode] -
167
- * @param {string} [arg.tags] -
168
- * @param {boolean} [arg.isDefault] -
169
- * @returns {Promise<GetAddressesResponse>} - Success response
111
+ * @param {CartApplicationValidator.GetAddressesParam} arg - Arg object.
112
+ * @param {import("../ApplicationAPIClient").Options} - Options
113
+ * @returns {Promise<CartApplicationModel.GetAddressesResponse>} - Success response
114
+ * @name getAddresses
170
115
  * @summary: Fetch address
171
- * @description: Use this API to get all the addresses associated with an account. If successful, returns a Address resource in the response body specified in GetAddressesResponse.attibutes listed below are optional <ul> <li> <font color="monochrome">uid</font></li> <li> <font color="monochrome">address_id</font></li> <li> <font color="monochrome">mobile_no</font></li> <li> <font color="monochrome">checkout_mode</font></li> <li> <font color="monochrome">tags</font></li> <li> <font color="monochrome">default</font></li> </ul>
116
+ * @description: Use this API to get all the addresses associated with an account. If successful, returns a Address resource in the response body specified in GetAddressesResponse.attibutes listed below are optional <ul> <li> <font color="monochrome">uid</font></li> <li> <font color="monochrome">address_id</font></li> <li> <font color="monochrome">mobile_no</font></li> <li> <font color="monochrome">checkout_mode</font></li> <li> <font color="monochrome">tags</font></li> <li> <font color="monochrome">default</font></li> </ul> - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getAddresses/).
172
117
  */
173
- getAddresses({ cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, }?: {
174
- cartId?: string;
175
- buyNow?: boolean;
176
- mobileNo?: string;
177
- checkoutMode?: string;
178
- tags?: string;
179
- isDefault?: boolean;
180
- }): Promise<GetAddressesResponse>;
118
+ getAddresses({ cartId, buyNow, mobileNo, checkoutMode, tags, isDefault }?: CartApplicationValidator.GetAddressesParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.GetAddressesResponse>;
181
119
  /**
182
- * @param {Object} arg - Arg object.
183
- * @param {number} [arg.itemId] - The Item ID of the product
184
- * @param {string} [arg.articleId] - Article Mongo ID
185
- * @param {number} [arg.uid] - UID of the product
186
- * @param {string} [arg.slug] - A short, human-readable, URL-friendly
187
- * identifier of a product. You can get slug value from the endpoint
188
- * /service/application/catalog/v1.0/products/
189
- * @returns {Promise<BulkPriceResponse>} - Success response
120
+ * @param {CartApplicationValidator.GetBulkDiscountOffersParam} arg - Arg object.
121
+ * @param {import("../ApplicationAPIClient").Options} - Options
122
+ * @returns {Promise<CartApplicationModel.BulkPriceResponse>} - Success response
123
+ * @name getBulkDiscountOffers
190
124
  * @summary: Get discount offers based on quantity
191
- * @description: Use this API to get a list of applicable offers along with current, next and best offer for given product. Either one of uid, item_id, slug should be present.
125
+ * @description: Use this API to get a list of applicable offers along with current, next and best offer for given product. Either one of uid, item_id, slug should be present. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getBulkDiscountOffers/).
192
126
  */
193
- getBulkDiscountOffers({ itemId, articleId, uid, slug }?: {
194
- itemId?: number;
195
- articleId?: string;
196
- uid?: number;
197
- slug?: string;
198
- }): Promise<BulkPriceResponse>;
127
+ getBulkDiscountOffers({ itemId, articleId, uid, slug }?: CartApplicationValidator.GetBulkDiscountOffersParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.BulkPriceResponse>;
199
128
  /**
200
- * @param {Object} arg - Arg object.
201
- * @param {string} [arg.id] -
202
- * @param {boolean} [arg.i] -
203
- * @param {boolean} [arg.b] -
204
- * @param {number} [arg.assignCardId] -
205
- * @param {string} [arg.areaCode] -
206
- * @param {boolean} [arg.buyNow] -
207
- * @returns {Promise<CartDetailResponse>} - Success response
129
+ * @param {CartApplicationValidator.GetCartParam} arg - Arg object.
130
+ * @param {import("../ApplicationAPIClient").Options} - Options
131
+ * @returns {Promise<CartApplicationModel.CartDetailResponse>} - Success response
132
+ * @name getCart
208
133
  * @summary: Fetch all items added to the cart
209
- * @description: Use this API to get details of all the items added to a cart.
134
+ * @description: Use this API to get details of all the items added to a cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getCart/).
210
135
  */
211
- getCart({ id, i, b, assignCardId, areaCode, buyNow }?: {
212
- id?: string;
213
- i?: boolean;
214
- b?: boolean;
215
- assignCardId?: number;
216
- areaCode?: string;
217
- buyNow?: boolean;
218
- }): Promise<CartDetailResponse>;
136
+ getCart({ id, i, b, assignCardId, areaCode, buyNow }?: CartApplicationValidator.GetCartParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.CartDetailResponse>;
219
137
  /**
220
- * @param {Object} arg - Arg object.
221
- * @param {string} [arg.id] -
138
+ * @param {CartApplicationValidator.GetCartLastModifiedParam} arg - Arg object.
139
+ * @param {import("../ApplicationAPIClient").Options} - Options
222
140
  * @returns {Promise<any>} - Success response
141
+ * @name getCartLastModified
223
142
  * @summary: Fetch last-modified timestamp
224
- * @description: Use this API to fetch Last-Modified timestamp in header metadata.
143
+ * @description: Use this API to fetch Last-Modified timestamp in header metadata. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getCartLastModified/).
225
144
  */
226
- getCartLastModified({ id }?: {
227
- id?: string;
228
- }): Promise<any>;
145
+ getCartLastModified({ id }?: CartApplicationValidator.GetCartLastModifiedParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<any>;
229
146
  /**
230
- * @param {Object} arg - Arg object.
231
- * @param {GetShareCartLinkRequest} arg.body
232
- * @returns {Promise<GetShareCartLinkResponse>} - Success response
147
+ * @param {CartApplicationValidator.GetCartShareLinkParam} arg - Arg object.
148
+ * @param {import("../ApplicationAPIClient").Options} - Options
149
+ * @returns {Promise<CartApplicationModel.GetShareCartLinkResponse>} -
150
+ * Success response
151
+ * @name getCartShareLink
233
152
  * @summary: Generate token for sharing the cart
234
- * @description: Use this API to generate a shared cart snapshot and return a shortlink token. The link can be shared with other users for getting the same items in their cart.
153
+ * @description: Use this API to generate a shared cart snapshot and return a shortlink token. The link can be shared with other users for getting the same items in their cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getCartShareLink/).
235
154
  */
236
- getCartShareLink({ body }?: {
237
- body: GetShareCartLinkRequest;
238
- }): Promise<GetShareCartLinkResponse>;
155
+ getCartShareLink({ body }?: CartApplicationValidator.GetCartShareLinkParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.GetShareCartLinkResponse>;
239
156
  /**
240
- * @param {Object} arg - Arg object.
241
- * @param {string} arg.token - Token of the shared short link
242
- * @returns {Promise<SharedCartResponse>} - Success response
157
+ * @param {CartApplicationValidator.GetCartSharedItemsParam} arg - Arg object.
158
+ * @param {import("../ApplicationAPIClient").Options} - Options
159
+ * @returns {Promise<CartApplicationModel.SharedCartResponse>} - Success response
160
+ * @name getCartSharedItems
243
161
  * @summary: Get details of a shared cart
244
- * @description: Use this API to get the shared cart details as per the token generated using the share-cart API.
162
+ * @description: Use this API to get the shared cart details as per the token generated using the share-cart API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getCartSharedItems/).
245
163
  */
246
- getCartSharedItems({ token }?: {
247
- token: string;
248
- }): Promise<SharedCartResponse>;
164
+ getCartSharedItems({ token }?: CartApplicationValidator.GetCartSharedItemsParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.SharedCartResponse>;
249
165
  /**
250
- * @param {Object} arg - Arg object.
251
- * @param {string} [arg.id] -
252
- * @param {boolean} [arg.buyNow] -
253
- * @returns {Promise<GetCouponResponse>} - Success response
166
+ * @param {CartApplicationValidator.GetCouponsParam} arg - Arg object.
167
+ * @param {import("../ApplicationAPIClient").Options} - Options
168
+ * @returns {Promise<CartApplicationModel.GetCouponResponse>} - Success response
169
+ * @name getCoupons
254
170
  * @summary: Fetch Coupon
255
- * @description: Use this API to get a list of available coupons along with their details.
171
+ * @description: Use this API to get a list of available coupons along with their details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getCoupons/).
256
172
  */
257
- getCoupons({ id, buyNow }?: {
258
- id?: string;
259
- buyNow?: boolean;
260
- }): Promise<GetCouponResponse>;
173
+ getCoupons({ id, buyNow }?: CartApplicationValidator.GetCouponsParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.GetCouponResponse>;
261
174
  /**
262
- * @param {Object} arg - Arg object.
263
- * @param {string} [arg.id] - The unique identifier of the cart.
264
- * @param {boolean} [arg.buyNow] -
265
- * @returns {Promise<CartItemCountResponse>} - Success response
175
+ * @param {CartApplicationValidator.GetItemCountParam} arg - Arg object.
176
+ * @param {import("../ApplicationAPIClient").Options} - Options
177
+ * @returns {Promise<CartApplicationModel.CartItemCountResponse>} - Success response
178
+ * @name getItemCount
266
179
  * @summary: Count items in the cart
267
- * @description: Use this API to get the total number of items present in cart.
180
+ * @description: Use this API to get the total number of items present in cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getItemCount/).
268
181
  */
269
- getItemCount({ id, buyNow }?: {
270
- id?: string;
271
- buyNow?: boolean;
272
- }): Promise<CartItemCountResponse>;
182
+ getItemCount({ id, buyNow }?: CartApplicationValidator.GetItemCountParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.CartItemCountResponse>;
273
183
  /**
274
- * @param {Object} arg - Arg object.
275
- * @param {string} arg.slug - A short, human-readable, URL-friendly
276
- * identifier of a product. You can get slug value from the endpoint
277
- * /service/application/catalog/v1.0/products/
278
- * @param {string} [arg.storeId] - Store uid of assigned store on PDP page.
279
- * If not passed default first created ladder will be returned
280
- * @param {string} [arg.promotionId] - Get ladder information of given
281
- * promotion id explicitely
282
- * @param {number} [arg.pageSize] - Number of offers to be fetched to show
283
- * @returns {Promise<LadderPriceOffers>} - Success response
184
+ * @param {CartApplicationValidator.GetLadderOffersParam} arg - Arg object.
185
+ * @param {import("../ApplicationAPIClient").Options} - Options
186
+ * @returns {Promise<CartApplicationModel.LadderPriceOffers>} - Success response
187
+ * @name getLadderOffers
284
188
  * @summary: Fetch ladder price promotion
285
- * @description: Use this API to get applicable ladder price promotion for current product
189
+ * @description: Use this API to get applicable ladder price promotion for current product - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getLadderOffers/).
286
190
  */
287
- getLadderOffers({ slug, storeId, promotionId, pageSize }?: {
288
- slug: string;
289
- storeId?: string;
290
- promotionId?: string;
291
- pageSize?: number;
292
- }): Promise<LadderPriceOffers>;
191
+ getLadderOffers({ slug, storeId, promotionId, pageSize }?: CartApplicationValidator.GetLadderOffersParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.LadderPriceOffers>;
293
192
  /**
294
- * @param {Object} arg - Arg object.
295
- * @param {string} [arg.slug] - A short, human-readable, URL-friendly
296
- * identifier of a product. You can get slug value from the endpoint
297
- * /service/application/catalog/v1.0/products/
298
- * @param {number} [arg.pageSize] - Number of offers to be fetched to show
299
- * @param {string} [arg.promotionGroup] - Type of promotion groups
300
- * @param {number} [arg.storeId] - Store id
301
- * @returns {Promise<PromotionOffersResponse>} - Success response
193
+ * @param {CartApplicationValidator.GetPromotionOffersParam} arg - Arg object.
194
+ * @param {import("../ApplicationAPIClient").Options} - Options
195
+ * @returns {Promise<CartApplicationModel.PromotionOffersResponse>} - Success response
196
+ * @name getPromotionOffers
302
197
  * @summary: Fetch available promotions
303
- * @description: Use this API to get top 5 offers available for current product
198
+ * @description: Use this API to get top 5 offers available for current product - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getPromotionOffers/).
304
199
  */
305
- getPromotionOffers({ slug, pageSize, promotionGroup, storeId }?: {
306
- slug?: string;
307
- pageSize?: number;
308
- promotionGroup?: string;
309
- storeId?: number;
310
- }): Promise<PromotionOffersResponse>;
200
+ getPromotionOffers({ slug, pageSize, promotionGroup, storeId }?: CartApplicationValidator.GetPromotionOffersParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.PromotionOffersResponse>;
311
201
  /**
312
- * @param {Object} arg - Arg object.
313
- * @param {boolean} [arg.p] - This is a boolean value. Select `true` for
314
- * getting a payment option in response.
315
- * @param {string} [arg.id] - The unique identifier of the cart
316
- * @param {boolean} [arg.buyNow] -
317
- * @param {string} [arg.addressId] - ID allotted to the selected address
318
- * @param {string} [arg.areaCode] - The PIN Code of the destination address,
319
- * e.g. 400059
320
- * @param {string} [arg.orderType] - The order type of shipment HomeDelivery
321
- * - If the customer wants the order home-delivered PickAtStore - If the
322
- * customer wants the handover of an order at the store itself. Digital -
323
- * If the customer wants to buy digital voucher ( for jiogames )
324
- * @returns {Promise<CartShipmentsResponse>} - Success response
202
+ * @param {CartApplicationValidator.GetShipmentsParam} arg - Arg object.
203
+ * @param {import("../ApplicationAPIClient").Options} - Options
204
+ * @returns {Promise<CartApplicationModel.CartShipmentsResponse>} - Success response
205
+ * @name getShipments
325
206
  * @summary: Get delivery date and options before checkout
326
- * @description: Use this API to get shipment details, expected delivery date, items and price breakup of the shipment.
207
+ * @description: Use this API to get shipment details, expected delivery date, items and price breakup of the shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/getShipments/).
327
208
  */
328
- getShipments({ p, id, buyNow, addressId, areaCode, orderType }?: {
329
- p?: boolean;
330
- id?: string;
331
- buyNow?: boolean;
332
- addressId?: string;
333
- areaCode?: string;
334
- orderType?: string;
335
- }): Promise<CartShipmentsResponse>;
209
+ getShipments({ p, id, buyNow, addressId, areaCode, orderType }?: CartApplicationValidator.GetShipmentsParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.CartShipmentsResponse>;
336
210
  /**
337
- * @param {Object} arg - Arg object.
338
- * @param {string} arg.id - ID allotted to the selected address
339
- * @returns {Promise<DeleteAddressResponse>} - Success response
211
+ * @param {CartApplicationValidator.RemoveAddressParam} arg - Arg object.
212
+ * @param {import("../ApplicationAPIClient").Options} - Options
213
+ * @returns {Promise<CartApplicationModel.DeleteAddressResponse>} - Success response
214
+ * @name removeAddress
340
215
  * @summary: Remove address associated with an account
341
- * @description: Use this API to delete an address by its ID. This will returns an object that will indicate whether the address was deleted successfully or not.
216
+ * @description: Use this API to delete an address by its ID. This will returns an object that will indicate whether the address was deleted successfully or not. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/removeAddress/).
342
217
  */
343
- removeAddress({ id }?: {
344
- id: string;
345
- }): Promise<DeleteAddressResponse>;
218
+ removeAddress({ id }?: CartApplicationValidator.RemoveAddressParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.DeleteAddressResponse>;
346
219
  /**
347
- * @param {Object} arg - Arg object.
348
- * @param {string} [arg.id] -
349
- * @param {boolean} [arg.buyNow] -
350
- * @returns {Promise<CartDetailResponse>} - Success response
220
+ * @param {CartApplicationValidator.RemoveCouponParam} arg - Arg object.
221
+ * @param {import("../ApplicationAPIClient").Options} - Options
222
+ * @returns {Promise<CartApplicationModel.CartDetailResponse>} - Success response
223
+ * @name removeCoupon
351
224
  * @summary: Remove Coupon Applied
352
- * @description: Remove Coupon applied on the cart by passing uid in request body.
225
+ * @description: Remove Coupon applied on the cart by passing uid in request body. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/removeCoupon/).
353
226
  */
354
- removeCoupon({ id, buyNow }?: {
355
- id?: string;
356
- buyNow?: boolean;
357
- }): Promise<CartDetailResponse>;
227
+ removeCoupon({ id, buyNow }?: CartApplicationValidator.RemoveCouponParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.CartDetailResponse>;
358
228
  /**
359
- * @param {Object} arg - Arg object.
360
- * @param {string} [arg.cartId] -
361
- * @param {boolean} [arg.buyNow] -
362
- * @param {boolean} [arg.i] -
363
- * @param {boolean} [arg.b] -
364
- * @param {SelectCartAddressRequest} arg.body
365
- * @returns {Promise<CartDetailResponse>} - Success response
229
+ * @param {CartApplicationValidator.SelectAddressParam} arg - Arg object.
230
+ * @param {import("../ApplicationAPIClient").Options} - Options
231
+ * @returns {Promise<CartApplicationModel.CartDetailResponse>} - Success response
232
+ * @name selectAddress
366
233
  * @summary: Select an address from available addresses
367
- * @description: <p>Select Address from all addresses associated with the account in order to ship the cart items to that address, otherwise default address will be selected implicitly. See `SelectCartAddressRequest` in schema of request body for the list of attributes needed to select Address from account. On successful request, this API returns a Cart object. Below address attributes are required. <ul> <li> <font color="monochrome">address_id</font></li> <li> <font color="monochrome">billing_address_id</font></li> <li> <font color="monochrome">uid</font></li> </ul></p>
234
+ * @description: <p>Select Address from all addresses associated with the account in order to ship the cart items to that address, otherwise default address will be selected implicitly. See `SelectCartAddressRequest` in schema of request body for the list of attributes needed to select Address from account. On successful request, this API returns a Cart object. Below address attributes are required. <ul> <li> <font color="monochrome">address_id</font></li> <li> <font color="monochrome">billing_address_id</font></li> <li> <font color="monochrome">uid</font></li> </ul></p> - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/selectAddress/).
368
235
  */
369
- selectAddress({ body, cartId, buyNow, i, b }?: {
370
- cartId?: string;
371
- buyNow?: boolean;
372
- i?: boolean;
373
- b?: boolean;
374
- body: SelectCartAddressRequest;
375
- }): Promise<CartDetailResponse>;
236
+ selectAddress({ body, cartId, buyNow, i, b }?: CartApplicationValidator.SelectAddressParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.CartDetailResponse>;
376
237
  /**
377
- * @param {Object} arg - Arg object.
378
- * @param {string} [arg.id] -
379
- * @param {boolean} [arg.buyNow] -
380
- * @param {UpdateCartPaymentRequest} arg.body
381
- * @returns {Promise<CartDetailResponse>} - Success response
238
+ * @param {CartApplicationValidator.SelectPaymentModeParam} arg - Arg object.
239
+ * @param {import("../ApplicationAPIClient").Options} - Options
240
+ * @returns {Promise<CartApplicationModel.CartDetailResponse>} - Success response
241
+ * @name selectPaymentMode
382
242
  * @summary: Update cart payment
383
- * @description: Use this API to update cart payment.
243
+ * @description: Use this API to update cart payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/selectPaymentMode/).
384
244
  */
385
- selectPaymentMode({ body, id, buyNow }?: {
386
- id?: string;
387
- buyNow?: boolean;
388
- body: UpdateCartPaymentRequest;
389
- }): Promise<CartDetailResponse>;
245
+ selectPaymentMode({ body, id, buyNow }?: CartApplicationValidator.SelectPaymentModeParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.CartDetailResponse>;
390
246
  /**
391
- * @param {Object} arg - Arg object.
392
- * @param {string} arg.id - ID allotted to the selected address
393
- * @param {Address} arg.body
394
- * @returns {Promise<UpdateAddressResponse>} - Success response
247
+ * @param {CartApplicationValidator.UpdateAddressParam} arg - Arg object.
248
+ * @param {import("../ApplicationAPIClient").Options} - Options
249
+ * @returns {Promise<CartApplicationModel.UpdateAddressResponse>} - Success response
250
+ * @name updateAddress
395
251
  * @summary: Update address added to an account
396
- * @description: <p>Use this API to update an existing address in the account. Request object should contain attributes mentioned in <font color="blue">Address </font> can be updated. These attributes are:</p> <ul> <li> <font color="monochrome">is_default_address</font></li> <li> <font color="monochrome">landmark</font></li> <li> <font color="monochrome">area</font></li> <li> <font color="monochrome">pincode</font></li> <li> <font color="monochrome">email</font></li> <li> <font color="monochrome">address_type</font></li> <li> <font color="monochrome">name</font></li> <li> <font color="monochrome">address_id</font></li> <li> <font color="monochrome">address</font></li> </ul>
252
+ * @description: <p>Use this API to update an existing address in the account. Request object should contain attributes mentioned in <font color="blue">Address </font> can be updated. These attributes are:</p> <ul> <li> <font color="monochrome">is_default_address</font></li> <li> <font color="monochrome">landmark</font></li> <li> <font color="monochrome">area</font></li> <li> <font color="monochrome">pincode</font></li> <li> <font color="monochrome">email</font></li> <li> <font color="monochrome">address_type</font></li> <li> <font color="monochrome">name</font></li> <li> <font color="monochrome">address_id</font></li> <li> <font color="monochrome">address</font></li> </ul> - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/updateAddress/).
397
253
  */
398
- updateAddress({ id, body }?: {
399
- id: string;
400
- body: Address;
401
- }): Promise<UpdateAddressResponse>;
254
+ updateAddress({ id, body }?: CartApplicationValidator.UpdateAddressParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.UpdateAddressResponse>;
402
255
  /**
403
- * @param {Object} arg - Arg object.
404
- * @param {string} [arg.id] -
405
- * @param {boolean} [arg.i] -
406
- * @param {boolean} [arg.b] -
407
- * @param {string} [arg.areaCode] -
408
- * @param {boolean} [arg.buyNow] -
409
- * @param {UpdateCartRequest} arg.body
410
- * @returns {Promise<UpdateCartDetailResponse>} - Success response
256
+ * @param {CartApplicationValidator.UpdateCartParam} arg - Arg object.
257
+ * @param {import("../ApplicationAPIClient").Options} - Options
258
+ * @returns {Promise<CartApplicationModel.UpdateCartDetailResponse>} -
259
+ * Success response
260
+ * @name updateCart
411
261
  * @summary: Update items in the cart
412
- * @description: <p>Use this API to update items added to the cart with the help of a request object containing attributes like item_quantity and item_size. These attributes will be fetched from the following APIs</p> <ul> <li><font color="monochrome">operation</font> Operation for current api call. <b>update_item</b> for update items. <b>remove_item</b> for removing items.</li> <li> <font color="monochrome">item_id</font> "/platform/content/v1/products/"</li> <li> <font color="monochrome">item_size</font> "/platform/content/v1/products/:slug/sizes/"</li> <li> <font color="monochrome">quantity</font> item quantity (must be greater than or equal to 1)</li> <li> <font color="monochrome">article_id</font> "/content​/v1​/products​/:identifier​/sizes​/price​/"</li> <li> <font color="monochrome">item_index</font> item position in the cart (must be greater than or equal to 0)</li> </ul>
262
+ * @description: <p>Use this API to update items added to the cart with the help of a request object containing attributes like item_quantity and item_size. These attributes will be fetched from the following APIs</p> <ul> <li><font color="monochrome">operation</font> Operation for current api call. <b>update_item</b> for update items. <b>remove_item</b> for removing items.</li> <li> <font color="monochrome">item_id</font> "/platform/content/v1/products/"</li> <li> <font color="monochrome">item_size</font> "/platform/content/v1/products/:slug/sizes/"</li> <li> <font color="monochrome">quantity</font> item quantity (must be greater than or equal to 1)</li> <li> <font color="monochrome">article_id</font> "/content​/v1​/products​/:identifier​/sizes​/price​/"</li> <li> <font color="monochrome">item_index</font> item position in the cart (must be greater than or equal to 0)</li> </ul> - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/updateCart/).
413
263
  */
414
- updateCart({ body, id, i, b, areaCode, buyNow }?: {
415
- id?: string;
416
- i?: boolean;
417
- b?: boolean;
418
- areaCode?: string;
419
- buyNow?: boolean;
420
- body: UpdateCartRequest;
421
- }): Promise<UpdateCartDetailResponse>;
264
+ updateCart({ body, id, i, b, areaCode, buyNow }?: CartApplicationValidator.UpdateCartParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.UpdateCartDetailResponse>;
422
265
  /**
423
- * @param {Object} arg - Arg object.
424
- * @param {string} [arg.id] -
425
- * @param {boolean} [arg.buyNow] -
426
- * @param {CartMetaRequest} arg.body
427
- * @returns {Promise<CartMetaResponse>} - Success response
266
+ * @param {CartApplicationValidator.UpdateCartMetaParam} arg - Arg object.
267
+ * @param {import("../ApplicationAPIClient").Options} - Options
268
+ * @returns {Promise<CartApplicationModel.CartMetaResponse>} - Success response
269
+ * @name updateCartMeta
428
270
  * @summary: Update the cart meta
429
- * @description: Use this API to update cart meta like checkout_mode and gstin.
271
+ * @description: Use this API to update cart meta like checkout_mode and gstin. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/updateCartMeta/).
430
272
  */
431
- updateCartMeta({ body, id, buyNow }?: {
432
- id?: string;
433
- buyNow?: boolean;
434
- body: CartMetaRequest;
435
- }): Promise<CartMetaResponse>;
273
+ updateCartMeta({ body, id, buyNow }?: CartApplicationValidator.UpdateCartMetaParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.CartMetaResponse>;
436
274
  /**
437
- * @param {Object} arg - Arg object.
438
- * @param {string} arg.token - Token of the shared short link
439
- * @param {string} arg.action - Operation to perform on the existing cart
440
- * merge or replace.
441
- * @returns {Promise<SharedCartResponse>} - Success response
275
+ * @param {CartApplicationValidator.UpdateCartWithSharedItemsParam} arg - Arg object.
276
+ * @param {import("../ApplicationAPIClient").Options} - Options
277
+ * @returns {Promise<CartApplicationModel.SharedCartResponse>} - Success response
278
+ * @name updateCartWithSharedItems
442
279
  * @summary: Merge or replace existing cart
443
- * @description: Use this API to merge the shared cart with existing cart, or replace the existing cart with the shared cart. The `action` parameter is used to indicate the operation Merge or Replace.
280
+ * @description: Use this API to merge the shared cart with existing cart, or replace the existing cart with the shared cart. The `action` parameter is used to indicate the operation Merge or Replace. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/updateCartWithSharedItems/).
444
281
  */
445
- updateCartWithSharedItems({ token, action }?: {
446
- token: string;
447
- action: string;
448
- }): Promise<SharedCartResponse>;
282
+ updateCartWithSharedItems({ token, action }?: CartApplicationValidator.UpdateCartWithSharedItemsParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.SharedCartResponse>;
449
283
  /**
450
- * @param {Object} arg - Arg object.
451
- * @param {string} [arg.id] -
452
- * @param {boolean} [arg.buyNow] -
453
- * @param {string} [arg.addressId] -
454
- * @param {string} [arg.paymentMode] -
455
- * @param {string} [arg.paymentIdentifier] -
456
- * @param {string} [arg.aggregatorName] -
457
- * @param {string} [arg.merchantCode] -
458
- * @param {string} [arg.iin] -
459
- * @param {string} [arg.network] -
460
- * @param {string} [arg.type] -
461
- * @param {string} [arg.cardId] -
462
- * @returns {Promise<PaymentCouponValidate>} - Success response
284
+ * @param {CartApplicationValidator.ValidateCouponForPaymentParam} arg - Arg object.
285
+ * @param {import("../ApplicationAPIClient").Options} - Options
286
+ * @returns {Promise<CartApplicationModel.PaymentCouponValidate>} - Success response
287
+ * @name validateCouponForPayment
463
288
  * @summary: Verify the coupon eligibility against the payment mode
464
- * @description: Use this API to validate a coupon against the payment mode such as NetBanking, Wallet, UPI etc.
289
+ * @description: Use this API to validate a coupon against the payment mode such as NetBanking, Wallet, UPI etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/cart/validateCouponForPayment/).
465
290
  */
466
- validateCouponForPayment({ id, buyNow, addressId, paymentMode, paymentIdentifier, aggregatorName, merchantCode, iin, network, type, cardId, }?: {
467
- id?: string;
468
- buyNow?: boolean;
469
- addressId?: string;
470
- paymentMode?: string;
471
- paymentIdentifier?: string;
472
- aggregatorName?: string;
473
- merchantCode?: string;
474
- iin?: string;
475
- network?: string;
476
- type?: string;
477
- cardId?: string;
478
- }): Promise<PaymentCouponValidate>;
291
+ validateCouponForPayment({ id, buyNow, addressId, paymentMode, paymentIdentifier, aggregatorName, merchantCode, iin, network, type, cardId, }?: CartApplicationValidator.ValidateCouponForPaymentParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<CartApplicationModel.PaymentCouponValidate>;
479
292
  }
293
+ import CartApplicationValidator = require("./CartApplicationValidator");
294
+ import CartApplicationModel = require("./CartApplicationModel");