@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
@@ -4,160 +4,129 @@ declare class Cart {
4
4
  config: any;
5
5
  applicationId: any;
6
6
  /**
7
- * @param {Object} arg - Arg object.
8
- * @param {PlatformAddress} arg.body
9
- * @returns {Promise<SaveAddressResponse>} - Success response
7
+ * @param {CartPlatformApplicationValidator.AddAddressParam} arg - Arg object
8
+ * @param {import("../PlatformAPIClient").Options} - Options
9
+ * @returns {Promise<CartPlatformModel.SaveAddressResponse>} - Success response
10
+ * @name addAddress
10
11
  * @summary: Add address to an account
11
- * @description: Use this API to add an address to an account.
12
+ * @description: Use this API to add an address to an account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addAddress/).
12
13
  */
13
- addAddress({ body }?: {
14
- body: PlatformAddress;
15
- }): Promise<SaveAddressResponse>;
14
+ addAddress({ body }?: CartPlatformApplicationValidator.AddAddressParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.SaveAddressResponse>;
16
15
  /**
17
- * @param {Object} arg - Arg object.
18
- * @param {string} arg.cartId - Current Cart _id
19
- * @param {boolean} [arg.b] -
20
- * @param {AddCartRequest} arg.body
21
- * @returns {Promise<AddCartDetailResponse>} - Success response
16
+ * @param {CartPlatformApplicationValidator.AddItemsParam} arg - Arg object
17
+ * @param {import("../PlatformAPIClient").Options} - Options
18
+ * @returns {Promise<CartPlatformModel.AddCartDetailResponse>} - Success response
19
+ * @name addItems
22
20
  * @summary: Add items to abandoned cart
23
- * @description: Use this API to add items to the abandoned cart.
21
+ * @description: Use this API to add items to the abandoned cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addItems/).
24
22
  */
25
- addItems({ cartId, body, b }?: {
26
- cartId: string;
27
- b?: boolean;
28
- body: AddCartRequest;
29
- }): Promise<AddCartDetailResponse>;
23
+ addItems({ cartId, body, b }?: CartPlatformApplicationValidator.AddItemsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.AddCartDetailResponse>;
30
24
  /**
31
- * @param {Object} arg - Arg object.
32
- * @param {PriceAdjustmentAdd} arg.body
33
- * @returns {Promise<PriceAdjustmentResponse>} - Success response
25
+ * @param {CartPlatformApplicationValidator.AddPriceAdjustmentParam} arg - Arg object
26
+ * @param {import("../PlatformAPIClient").Options} - Options
27
+ * @returns {Promise<CartPlatformModel.PriceAdjustmentResponse>} - Success response
28
+ * @name addPriceAdjustment
34
29
  * @summary: Create new price adjustment
35
- * @description: Create new price adjustment
30
+ * @description: Create new price adjustment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addPriceAdjustment/).
36
31
  */
37
- addPriceAdjustment({ body }?: {
38
- body: PriceAdjustmentAdd;
39
- }): Promise<PriceAdjustmentResponse>;
32
+ addPriceAdjustment({ body }?: CartPlatformApplicationValidator.AddPriceAdjustmentParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.PriceAdjustmentResponse>;
40
33
  /**
41
- * @param {Object} arg - Arg object.
42
- * @param {boolean} [arg.i] -
43
- * @param {boolean} [arg.b] -
44
- * @param {boolean} [arg.p] -
45
- * @param {string} [arg.id] -
46
- * @param {boolean} [arg.buyNow] -
47
- * @param {ApplyCouponRequest} arg.body
48
- * @returns {Promise<CartDetailResponse>} - Success response
34
+ * @param {CartPlatformApplicationValidator.ApplyCouponParam} arg - Arg object
35
+ * @param {import("../PlatformAPIClient").Options} - Options
36
+ * @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
37
+ * @name applyCoupon
49
38
  * @summary: Apply Coupon for platform pos user
50
- * @description: Use this API to apply coupons on items in the cart.
51
- */
52
- applyCoupon({ body, i, b, p, id, buyNow }?: {
53
- i?: boolean;
54
- b?: boolean;
55
- p?: boolean;
56
- id?: string;
57
- buyNow?: boolean;
58
- body: ApplyCouponRequest;
59
- }): Promise<CartDetailResponse>;
60
- /**
61
- * @param {Object} arg - Arg object.
62
- * @param {OpenApiCartServiceabilityRequest} arg.body
63
- * @returns {Promise<OpenApiCartServiceabilityResponse>} - Success response
39
+ * @description: Use this API to apply coupons on items in the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/applyCoupon/).
40
+ */
41
+ applyCoupon({ body, i, b, p, id, buyNow }?: CartPlatformApplicationValidator.ApplyCouponParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.CartDetailResponse>;
42
+ /**
43
+ * @param {CartPlatformApplicationValidator.CheckCartServiceabilityParam} arg
44
+ * - Arg object
45
+ *
46
+ * @param {import("../PlatformAPIClient").Options} - Options
47
+ * @returns {Promise<CartPlatformModel.OpenApiCartServiceabilityResponse>}
48
+ * - Success response
49
+ *
50
+ * @name checkCartServiceability
64
51
  * @summary: Check Pincode Serviceability
65
- * @description: Check Pincode serviceability for cart items provided in `cart_items` and address pincode in `shipping_address`
52
+ * @description: Check Pincode serviceability for cart items provided in `cart_items` and address pincode in `shipping_address` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/checkCartServiceability/).
66
53
  */
67
- checkCartServiceability({ body }?: {
68
- body: OpenApiCartServiceabilityRequest;
69
- }): Promise<OpenApiCartServiceabilityResponse>;
54
+ checkCartServiceability({ body }?: CartPlatformApplicationValidator.CheckCartServiceabilityParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.OpenApiCartServiceabilityResponse>;
70
55
  /**
71
- * @param {Object} arg - Arg object.
72
- * @param {OpenApiPlatformCheckoutReq} arg.body
73
- * @returns {Promise<OpenApiCheckoutResponse>} - Success response
56
+ * @param {CartPlatformApplicationValidator.CheckoutCartParam} arg - Arg object
57
+ * @param {import("../PlatformAPIClient").Options} - Options
58
+ * @returns {Promise<CartPlatformModel.OpenApiCheckoutResponse>} - Success response
59
+ * @name checkoutCart
74
60
  * @summary: Create Fynd order with cart details
75
- * @description: Generate Fynd order for cart details send with provided `cart_items`
61
+ * @description: Generate Fynd order for cart details send with provided `cart_items` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/checkoutCart/).
76
62
  */
77
- checkoutCart({ body }?: {
78
- body: OpenApiPlatformCheckoutReq;
79
- }): Promise<OpenApiCheckoutResponse>;
63
+ checkoutCart({ body }?: CartPlatformApplicationValidator.CheckoutCartParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.OpenApiCheckoutResponse>;
80
64
  /**
81
- * @param {Object} arg - Arg object.
82
- * @param {CartMetaConfigAdd} arg.body
83
- * @returns {Promise<CartMetaConfigAdd>} - Success response
65
+ * @param {CartPlatformApplicationValidator.CreateCartMetaConfigParam} arg
66
+ * - Arg object
67
+ *
68
+ * @param {import("../PlatformAPIClient").Options} - Options
69
+ * @returns {Promise<CartPlatformModel.CartMetaConfigAdd>} - Success response
70
+ * @name createCartMetaConfig
84
71
  * @summary: Create new cart meta configuration
85
- * @description: Create new cart meta configuration
72
+ * @description: Create new cart meta configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/createCartMetaConfig/).
86
73
  */
87
- createCartMetaConfig({ body }?: {
88
- body: CartMetaConfigAdd;
89
- }): Promise<CartMetaConfigAdd>;
74
+ createCartMetaConfig({ body }?: CartPlatformApplicationValidator.CreateCartMetaConfigParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.CartMetaConfigAdd>;
90
75
  /**
91
- * @param {Object} arg - Arg object.
92
- * @param {CouponAdd} arg.body
93
- * @returns {Promise<SuccessMessage>} - Success response
76
+ * @param {CartPlatformApplicationValidator.CreateCouponParam} arg - Arg object
77
+ * @param {import("../PlatformAPIClient").Options} - Options
78
+ * @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
79
+ * @name createCoupon
94
80
  * @summary: Create new coupon
95
- * @description: Create new coupon
81
+ * @description: Create new coupon - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/createCoupon/).
96
82
  */
97
- createCoupon({ body }?: {
98
- body: CouponAdd;
99
- }): Promise<SuccessMessage>;
83
+ createCoupon({ body }?: CartPlatformApplicationValidator.CreateCouponParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.SuccessMessage>;
100
84
  /**
101
- * @param {Object} arg - Arg object.
102
- * @param {PromotionAdd} arg.body
103
- * @returns {Promise<PromotionAdd>} - Success response
85
+ * @param {CartPlatformApplicationValidator.CreatePromotionParam} arg - Arg object
86
+ * @param {import("../PlatformAPIClient").Options} - Options
87
+ * @returns {Promise<CartPlatformModel.PromotionAdd>} - Success response
88
+ * @name createPromotion
104
89
  * @summary: Create new promotion
105
- * @description: Create new promotion
90
+ * @description: Create new promotion - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/createPromotion/).
106
91
  */
107
- createPromotion({ body }?: {
108
- body: PromotionAdd;
109
- }): Promise<PromotionAdd>;
92
+ createPromotion({ body }?: CartPlatformApplicationValidator.CreatePromotionParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.PromotionAdd>;
110
93
  /**
111
- * @param {Object} arg - Arg object.
112
- * @param {string} [arg.id] - The unique identifier of the cart.
113
- * @param {DeleteCartRequest} arg.body
114
- * @returns {Promise<DeleteCartDetailResponse>} - Success response
94
+ * @param {CartPlatformApplicationValidator.DeleteCartParam} arg - Arg object
95
+ * @param {import("../PlatformAPIClient").Options} - Options
96
+ * @returns {Promise<CartPlatformModel.DeleteCartDetailResponse>} - Success response
97
+ * @name deleteCart
115
98
  * @summary: Delete cart once user made successful checkout
116
- * @description: Use this API to delete the cart.
99
+ * @description: Use this API to delete the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/deleteCart/).
117
100
  */
118
- deleteCart({ body, id }?: {
119
- id?: string;
120
- body: DeleteCartRequest;
121
- }): Promise<DeleteCartDetailResponse>;
101
+ deleteCart({ body, id }?: CartPlatformApplicationValidator.DeleteCartParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.DeleteCartDetailResponse>;
122
102
  /**
123
- * @param {Object} arg - Arg object.
124
- * @param {OpenapiCartDetailsRequest} arg.body
125
- * @returns {Promise<OpenapiCartDetailsResponse>} - Success response
103
+ * @param {CartPlatformApplicationValidator.FetchAndvalidateCartItemsParam} arg
104
+ * - Arg object
105
+ *
106
+ * @param {import("../PlatformAPIClient").Options} - Options
107
+ * @returns {Promise<CartPlatformModel.OpenapiCartDetailsResponse>} - Success response
108
+ * @name fetchAndvalidateCartItems
126
109
  * @summary: Fetch Cart Details
127
- * @description: Get all the details of cart for a list of provided `cart_items`
110
+ * @description: Get all the details of cart for a list of provided `cart_items` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/fetchAndvalidateCartItems/).
128
111
  */
129
- fetchAndvalidateCartItems({ body }?: {
130
- body: OpenapiCartDetailsRequest;
131
- }): Promise<OpenapiCartDetailsResponse>;
112
+ fetchAndvalidateCartItems({ body }?: CartPlatformApplicationValidator.FetchAndvalidateCartItemsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.OpenapiCartDetailsResponse>;
132
113
  /**
133
- * @param {Object} arg - Arg object.
134
- * @returns {Promise<CartMetaConfigAdd>} - Success response
114
+ * @param {import("../PlatformAPIClient").Options} - Options
115
+ * @returns {Promise<CartPlatformModel.CartMetaConfigAdd>} - Success response
116
+ * @name fetchCartMetaConfig
135
117
  * @summary: Fetch cart meta configuration
136
- * @description: Fetch cart meta configuration
118
+ * @description: Fetch cart meta configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/fetchCartMetaConfig/).
137
119
  */
138
- fetchCartMetaConfig({}?: any): Promise<CartMetaConfigAdd>;
120
+ fetchCartMetaConfig({ headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.CartMetaConfigAdd>;
139
121
  /**
140
- * @param {Object} arg - Arg object.
141
- * @param {number} [arg.pageNo] -
142
- * @param {number} [arg.pageSize] -
143
- * @param {string} [arg.fromDate] -
144
- * @param {string} [arg.toDate] -
145
- * @param {boolean} [arg.anonymousCart] -
146
- * @param {string} [arg.lastId] -
147
- * @param {string} [arg.sortOn] -
148
- * @returns {Promise<AbandonedCartResponse>} - Success response
122
+ * @param {CartPlatformApplicationValidator.GetAbandonedCartParam} arg - Arg object
123
+ * @param {import("../PlatformAPIClient").Options} - Options
124
+ * @returns {Promise<CartPlatformModel.AbandonedCartResponse>} - Success response
125
+ * @name getAbandonedCart
149
126
  * @summary: Get with abandoned cart list
150
- * @description: Get abandoned cart list with pagination
127
+ * @description: Get abandoned cart list with pagination - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAbandonedCart/).
151
128
  */
152
- getAbandonedCart({ pageNo, pageSize, fromDate, toDate, anonymousCart, lastId, sortOn, }?: {
153
- pageNo?: number;
154
- pageSize?: number;
155
- fromDate?: string;
156
- toDate?: string;
157
- anonymousCart?: boolean;
158
- lastId?: string;
159
- sortOn?: string;
160
- }): Promise<AbandonedCartResponse>;
129
+ getAbandonedCart({ pageNo, pageSize, fromDate, toDate, anonymousCart, lastId, sortOn }?: CartPlatformApplicationValidator.GetAbandonedCartParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.AbandonedCartResponse>;
161
130
  /**
162
131
  * @param {Object} arg - Arg object.
163
132
  * @param {string} arg.companyId - Current company id
@@ -168,6 +137,7 @@ declare class Cart {
168
137
  * @param {boolean} [arg.anonymousCart] -
169
138
  * @param {string} [arg.lastId] -
170
139
  * @param {string} [arg.sortOn] -
140
+ * @returns {Paginator<CartPlatformModel.AbandonedCartResponse>}
171
141
  * @summary: Get with abandoned cart list
172
142
  * @description: Get abandoned cart list with pagination
173
143
  */
@@ -180,196 +150,128 @@ declare class Cart {
180
150
  anonymousCart?: boolean;
181
151
  lastId?: string;
182
152
  sortOn?: string;
183
- }): Paginator;
184
- /**
185
- * @param {Object} arg - Arg object.
186
- * @param {string} [arg.id] -
187
- * @param {boolean} [arg.i] -
188
- * @param {boolean} [arg.b] -
189
- * @returns {Promise<CartDetailResponse>} - Success response
153
+ }): Paginator<CartPlatformModel.AbandonedCartResponse>;
154
+ /**
155
+ * @param {CartPlatformApplicationValidator.GetAbandonedCartDetailsParam} arg
156
+ * - Arg object
157
+ *
158
+ * @param {import("../PlatformAPIClient").Options} - Options
159
+ * @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
160
+ * @name getAbandonedCartDetails
190
161
  * @summary: Fetch all items added to the cart
191
- * @description: Use this API to get details of all the items added to a cart.
162
+ * @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/platform/cart/getAbandonedCartDetails/).
192
163
  */
193
- getAbandonedCartDetails({ id, i, b }?: {
194
- id?: string;
195
- i?: boolean;
196
- b?: boolean;
197
- }): Promise<CartDetailResponse>;
164
+ getAbandonedCartDetails({ id, i, b }?: CartPlatformApplicationValidator.GetAbandonedCartDetailsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.CartDetailResponse>;
198
165
  /**
199
- * @param {Object} arg - Arg object.
200
- * @param {string} arg.id -
201
- * @param {string} [arg.cartId] -
202
- * @param {boolean} [arg.buyNow] -
203
- * @param {string} [arg.mobileNo] -
204
- * @param {string} [arg.checkoutMode] -
205
- * @param {string} [arg.tags] -
206
- * @param {boolean} [arg.isDefault] -
207
- * @param {string} [arg.userId] -
208
- * @returns {Promise<PlatformAddress>} - Success response
166
+ * @param {CartPlatformApplicationValidator.GetAddressByIdParam} arg - Arg object
167
+ * @param {import("../PlatformAPIClient").Options} - Options
168
+ * @returns {Promise<CartPlatformModel.PlatformAddress>} - Success response
169
+ * @name getAddressById
209
170
  * @summary: Fetch a single address by its ID
210
- * @description: Use this API to get an addresses using its ID. If successful, returns a Address resource in the response body specified in `PlatformAddress`. 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>
211
- */
212
- getAddressById({ id, cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, userId, }?: {
213
- id: string;
214
- cartId?: string;
215
- buyNow?: boolean;
216
- mobileNo?: string;
217
- checkoutMode?: string;
218
- tags?: string;
219
- isDefault?: boolean;
220
- userId?: string;
221
- }): Promise<PlatformAddress>;
171
+ * @description: Use this API to get an addresses using its ID. If successful, returns a Address resource in the response body specified in `PlatformAddress`. 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/platform/cart/getAddressById/).
172
+ */
173
+ getAddressById({ id, cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, userId, }?: CartPlatformApplicationValidator.GetAddressByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.PlatformAddress>;
222
174
  /**
223
- * @param {Object} arg - Arg object.
224
- * @param {string} [arg.cartId] -
225
- * @param {boolean} [arg.buyNow] -
226
- * @param {string} [arg.mobileNo] -
227
- * @param {string} [arg.checkoutMode] -
228
- * @param {string} [arg.tags] -
229
- * @param {boolean} [arg.isDefault] -
230
- * @param {string} [arg.userId] -
231
- * @returns {Promise<PlatformGetAddressesResponse>} - Success response
175
+ * @param {CartPlatformApplicationValidator.GetAddressesParam} arg - Arg object
176
+ * @param {import("../PlatformAPIClient").Options} - Options
177
+ * @returns {Promise<CartPlatformModel.PlatformGetAddressesResponse>} -
178
+ * Success response
179
+ * @name getAddresses
232
180
  * @summary: Fetch address
233
- * @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>
234
- */
235
- getAddresses({ cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, userId, }?: {
236
- cartId?: string;
237
- buyNow?: boolean;
238
- mobileNo?: string;
239
- checkoutMode?: string;
240
- tags?: string;
241
- isDefault?: boolean;
242
- userId?: string;
243
- }): Promise<PlatformGetAddressesResponse>;
181
+ * @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/platform/cart/getAddresses/).
182
+ */
183
+ getAddresses({ cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, userId }?: CartPlatformApplicationValidator.GetAddressesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.PlatformGetAddressesResponse>;
244
184
  /**
245
- * @param {Object} arg - Arg object.
246
- * @param {string} [arg.id] -
247
- * @param {boolean} [arg.buyNow] -
248
- * @returns {Promise<GetCouponResponse>} - Success response
185
+ * @param {CartPlatformApplicationValidator.GetAppCouponsParam} arg - Arg object
186
+ * @param {import("../PlatformAPIClient").Options} - Options
187
+ * @returns {Promise<CartPlatformModel.GetCouponResponse>} - Success response
188
+ * @name getAppCoupons
249
189
  * @summary: Fetch Coupon
250
- * @description: Use this API to get a list of available coupons along with their details.
190
+ * @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/platform/cart/getAppCoupons/).
251
191
  */
252
- getAppCoupons({ id, buyNow }?: {
253
- id?: string;
254
- buyNow?: boolean;
255
- }): Promise<GetCouponResponse>;
192
+ getAppCoupons({ id, buyNow }?: CartPlatformApplicationValidator.GetAppCouponsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.GetCouponResponse>;
256
193
  /**
257
- * @param {Object} arg - Arg object.
258
- * @param {string} arg.areaCode -
259
- * @param {string} [arg.id] -
260
- * @returns {Promise<CartDeliveryModesResponse>} - Success response
194
+ * @param {CartPlatformApplicationValidator.GetAvailableDeliveryModesParam} arg
195
+ * - Arg object
196
+ *
197
+ * @param {import("../PlatformAPIClient").Options} - Options
198
+ * @returns {Promise<CartPlatformModel.CartDeliveryModesResponse>} - Success response
199
+ * @name getAvailableDeliveryModes
261
200
  * @summary: Get available delivery modes for cart
262
- * @description: Use this API to get the delivery modes (home-delivery/store-pickup) along with a list of pickup stores available for a given cart at a given PIN Code. User can then view the address of a pickup store with the help of store-address API.
201
+ * @description: Use this API to get the delivery modes (home-delivery/store-pickup) along with a list of pickup stores available for a given cart at a given PIN Code. User can then view the address of a pickup store with the help of store-address API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAvailableDeliveryModes/).
263
202
  */
264
- getAvailableDeliveryModes({ areaCode, id }?: {
265
- areaCode: string;
266
- id?: string;
267
- }): Promise<CartDeliveryModesResponse>;
203
+ getAvailableDeliveryModes({ areaCode, id }?: CartPlatformApplicationValidator.GetAvailableDeliveryModesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.CartDeliveryModesResponse>;
268
204
  /**
269
- * @param {Object} arg - Arg object.
270
- * @param {string} [arg.id] -
271
- * @param {string} [arg.userId] -
272
- * @param {boolean} [arg.i] -
273
- * @param {boolean} [arg.b] -
274
- * @param {number} [arg.assignCardId] -
275
- * @param {boolean} [arg.buyNow] -
276
- * @returns {Promise<CartDetailResponse>} - Success response
205
+ * @param {CartPlatformApplicationValidator.GetCartParam} arg - Arg object
206
+ * @param {import("../PlatformAPIClient").Options} - Options
207
+ * @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
208
+ * @name getCart
277
209
  * @summary: Fetch all items added to the customer cart using cart id
278
- * @description: Use this API to get details of all the items added to a cart.
210
+ * @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/platform/cart/getCart/).
279
211
  */
280
- getCart({ id, userId, i, b, assignCardId, buyNow }?: {
281
- id?: string;
282
- userId?: string;
283
- i?: boolean;
284
- b?: boolean;
285
- assignCardId?: number;
286
- buyNow?: boolean;
287
- }): Promise<CartDetailResponse>;
212
+ getCart({ id, userId, i, b, assignCardId, buyNow }?: CartPlatformApplicationValidator.GetCartParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.CartDetailResponse>;
288
213
  /**
289
- * @param {Object} arg - Arg object.
290
- * @param {string} [arg.fromDate] -
291
- * @param {string} [arg.toDate] -
292
- * @param {string} [arg.filterOn] -
293
- * @returns {Promise<MultiCartResponse>} - Success response
214
+ * @param {CartPlatformApplicationValidator.GetCartListParam} arg - Arg object
215
+ * @param {import("../PlatformAPIClient").Options} - Options
216
+ * @returns {Promise<CartPlatformModel.MultiCartResponse>} - Success response
217
+ * @name getCartList
294
218
  * @summary: Get cart list for store os user
295
- * @description: Get all carts for the store os user which is created for customer
219
+ * @description: Get all carts for the store os user which is created for customer - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCartList/).
296
220
  */
297
- getCartList({ fromDate, toDate, filterOn }?: {
298
- fromDate?: string;
299
- toDate?: string;
300
- filterOn?: string;
301
- }): Promise<MultiCartResponse>;
221
+ getCartList({ fromDate, toDate, filterOn }?: CartPlatformApplicationValidator.GetCartListParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.MultiCartResponse>;
302
222
  /**
303
- * @param {Object} arg - Arg object.
304
- * @param {GetShareCartLinkRequest} arg.body
305
- * @returns {Promise<GetShareCartLinkResponse>} - Success response
223
+ * @param {CartPlatformApplicationValidator.GetCartShareLinkParam} arg - Arg object
224
+ * @param {import("../PlatformAPIClient").Options} - Options
225
+ * @returns {Promise<CartPlatformModel.GetShareCartLinkResponse>} - Success response
226
+ * @name getCartShareLink
306
227
  * @summary: Generate token for sharing the cart
307
- * @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.
228
+ * @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/platform/cart/getCartShareLink/).
308
229
  */
309
- getCartShareLink({ body }?: {
310
- body: GetShareCartLinkRequest;
311
- }): Promise<GetShareCartLinkResponse>;
230
+ getCartShareLink({ body }?: CartPlatformApplicationValidator.GetCartShareLinkParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.GetShareCartLinkResponse>;
312
231
  /**
313
- * @param {Object} arg - Arg object.
314
- * @param {string} arg.token - Token of the shared short link
315
- * @returns {Promise<SharedCartResponse>} - Success response
232
+ * @param {CartPlatformApplicationValidator.GetCartSharedItemsParam} arg - Arg object
233
+ * @param {import("../PlatformAPIClient").Options} - Options
234
+ * @returns {Promise<CartPlatformModel.SharedCartResponse>} - Success response
235
+ * @name getCartSharedItems
316
236
  * @summary: Get details of a shared cart
317
- * @description: Use this API to get the shared cart details as per the token generated using the share-cart API.
237
+ * @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/platform/cart/getCartSharedItems/).
318
238
  */
319
- getCartSharedItems({ token }?: {
320
- token: string;
321
- }): Promise<SharedCartResponse>;
239
+ getCartSharedItems({ token }?: CartPlatformApplicationValidator.GetCartSharedItemsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.SharedCartResponse>;
322
240
  /**
323
- * @param {Object} arg - Arg object.
324
- * @param {string} arg.id -
325
- * @returns {Promise<CouponUpdate>} - Success response
241
+ * @param {CartPlatformApplicationValidator.GetCouponByIdParam} arg - Arg object
242
+ * @param {import("../PlatformAPIClient").Options} - Options
243
+ * @returns {Promise<CartPlatformModel.CouponUpdate>} - Success response
244
+ * @name getCouponById
326
245
  * @summary: Get with single coupon details or coupon list
327
- * @description: Get single coupon details with `id` in path param
246
+ * @description: Get single coupon details with `id` in path param - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponById/).
328
247
  */
329
- getCouponById({ id }?: {
330
- id: string;
331
- }): Promise<CouponUpdate>;
248
+ getCouponById({ id }?: CartPlatformApplicationValidator.GetCouponByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.CouponUpdate>;
332
249
  /**
333
- * @param {Object} arg - Arg object.
334
- * @param {string} [arg.code] -
250
+ * @param {CartPlatformApplicationValidator.GetCouponCodeExistsParam} arg - Arg object
251
+ * @param {import("../PlatformAPIClient").Options} - Options
335
252
  * @returns {Promise<Object>} - Success response
253
+ * @name getCouponCodeExists
336
254
  * @summary: Check if coupon is already created with coupon code
337
- * @description: Check if sent coupon code is already existing coupon code. As coupon code is to be unique.
255
+ * @description: Check if sent coupon code is already existing coupon code. As coupon code is to be unique. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponCodeExists/).
338
256
  */
339
- getCouponCodeExists({ code }?: {
340
- code?: string;
341
- }): Promise<any>;
257
+ getCouponCodeExists({ code }?: CartPlatformApplicationValidator.GetCouponCodeExistsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<any>;
342
258
  /**
343
- * @param {Object} arg - Arg object.
259
+ * @param {import("../PlatformAPIClient").Options} - Options
344
260
  * @returns {Promise<Object>} - Success response
261
+ * @name getCouponOptionValues
345
262
  * @summary: Get coupon options enums with display values
346
- * @description: Get coupon enum values for fields in valid coupon object. Used for front end to create, update and filter coupon lists via fields
263
+ * @description: Get coupon enum values for fields in valid coupon object. Used for front end to create, update and filter coupon lists via fields - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponOptionValues/).
347
264
  */
348
- getCouponOptionValues({}?: any): Promise<any>;
265
+ getCouponOptionValues({ headers }?: import("../PlatformAPIClient").Options): Promise<any>;
349
266
  /**
350
- * @param {Object} arg - Arg object.
351
- * @param {number} [arg.pageNo] -
352
- * @param {number} [arg.pageSize] -
353
- * @param {boolean} [arg.isArchived] -
354
- * @param {string} [arg.title] -
355
- * @param {boolean} [arg.isPublic] -
356
- * @param {boolean} [arg.isDisplay] -
357
- * @param {string} [arg.typeSlug] -
358
- * @param {string} [arg.code] -
359
- * @returns {Promise<CouponsResponse>} - Success response
267
+ * @param {CartPlatformApplicationValidator.GetCouponsParam} arg - Arg object
268
+ * @param {import("../PlatformAPIClient").Options} - Options
269
+ * @returns {Promise<CartPlatformModel.CouponsResponse>} - Success response
270
+ * @name getCoupons
360
271
  * @summary: Get with single coupon details or coupon list
361
- * @description: Get coupon list with pagination
272
+ * @description: Get coupon list with pagination - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCoupons/).
362
273
  */
363
- getCoupons({ pageNo, pageSize, isArchived, title, isPublic, isDisplay, typeSlug, code, }?: {
364
- pageNo?: number;
365
- pageSize?: number;
366
- isArchived?: boolean;
367
- title?: string;
368
- isPublic?: boolean;
369
- isDisplay?: boolean;
370
- typeSlug?: string;
371
- code?: string;
372
- }): Promise<CouponsResponse>;
274
+ getCoupons({ pageNo, pageSize, isArchived, title, isPublic, isDisplay, typeSlug, code, }?: CartPlatformApplicationValidator.GetCouponsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.CouponsResponse>;
373
275
  /**
374
276
  * @param {Object} arg - Arg object.
375
277
  * @param {string} arg.companyId - Current company id
@@ -381,6 +283,7 @@ declare class Cart {
381
283
  * @param {boolean} [arg.isDisplay] -
382
284
  * @param {string} [arg.typeSlug] -
383
285
  * @param {string} [arg.code] -
286
+ * @returns {Paginator<CartPlatformModel.CouponsResponse>}
384
287
  * @summary: Get with single coupon details or coupon list
385
288
  * @description: Get coupon list with pagination
386
289
  */
@@ -394,75 +297,56 @@ declare class Cart {
394
297
  isDisplay?: boolean;
395
298
  typeSlug?: string;
396
299
  code?: string;
397
- }): Paginator;
300
+ }): Paginator<CartPlatformModel.CouponsResponse>;
398
301
  /**
399
- * @param {Object} arg - Arg object.
400
- * @param {string} [arg.id] - The unique identifier of the cart.
401
- * @param {boolean} [arg.buyNow] -
402
- * @returns {Promise<CartItemCountResponse>} - Success response
302
+ * @param {CartPlatformApplicationValidator.GetItemCountParam} arg - Arg object
303
+ * @param {import("../PlatformAPIClient").Options} - Options
304
+ * @returns {Promise<CartPlatformModel.CartItemCountResponse>} - Success response
305
+ * @name getItemCount
403
306
  * @summary: Count items in the customer's cart
404
- * @description: Use this API to get the total number of items present in cart.
307
+ * @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/platform/cart/getItemCount/).
405
308
  */
406
- getItemCount({ id, buyNow }?: {
407
- id?: string;
408
- buyNow?: boolean;
409
- }): Promise<CartItemCountResponse>;
309
+ getItemCount({ id, buyNow }?: CartPlatformApplicationValidator.GetItemCountParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.CartItemCountResponse>;
410
310
  /**
411
- * @param {Object} arg - Arg object.
412
- * @param {string} [arg.entityType] - Entity_type as promotion or coupon
413
- * @param {boolean} [arg.isHidden] - Promo-coupon config shown or not
414
- * @returns {Promise<ActivePromosResponse>} - Success response
311
+ * @param {CartPlatformApplicationValidator.GetPromosCouponConfigParam} arg
312
+ * - Arg object
313
+ *
314
+ * @param {import("../PlatformAPIClient").Options} - Options
315
+ * @returns {Promise<CartPlatformModel.ActivePromosResponse>} - Success response
316
+ * @name getPromosCouponConfig
415
317
  * @summary: Fetch all promos that are set as active
416
- * @description: Use this API to get list of all the active promos/coupons.
318
+ * @description: Use this API to get list of all the active promos/coupons. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromosCouponConfig/).
417
319
  */
418
- getPromosCouponConfig({ entityType, isHidden }?: {
419
- entityType?: string;
420
- isHidden?: boolean;
421
- }): Promise<ActivePromosResponse>;
320
+ getPromosCouponConfig({ entityType, isHidden }?: CartPlatformApplicationValidator.GetPromosCouponConfigParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.ActivePromosResponse>;
422
321
  /**
423
- * @param {Object} arg - Arg object.
424
- * @param {string} arg.id -
425
- * @returns {Promise<PromotionUpdate>} - Success response
322
+ * @param {CartPlatformApplicationValidator.GetPromotionByIdParam} arg - Arg object
323
+ * @param {import("../PlatformAPIClient").Options} - Options
324
+ * @returns {Promise<CartPlatformModel.PromotionUpdate>} - Success response
325
+ * @name getPromotionById
426
326
  * @summary: Get with single promotion details or promotion list
427
- * @description: Get single promotion details with `id` in path param
327
+ * @description: Get single promotion details with `id` in path param - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionById/).
428
328
  */
429
- getPromotionById({ id }?: {
430
- id: string;
431
- }): Promise<PromotionUpdate>;
329
+ getPromotionById({ id }?: CartPlatformApplicationValidator.GetPromotionByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.PromotionUpdate>;
432
330
  /**
433
- * @param {Object} arg - Arg object.
434
- * @param {string} [arg.code] -
331
+ * @param {CartPlatformApplicationValidator.GetPromotionCodeExistsParam} arg
332
+ * - Arg object
333
+ *
334
+ * @param {import("../PlatformAPIClient").Options} - Options
435
335
  * @returns {Promise<Object>} - Success response
336
+ * @name getPromotionCodeExists
436
337
  * @summary: Check if promotion is already created with promotion code
437
- * @description: Check if sent promotion code is already existing promotion code. As promotion code is to be unique.
338
+ * @description: Check if sent promotion code is already existing promotion code. As promotion code is to be unique. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionCodeExists/).
438
339
  */
439
- getPromotionCodeExists({ code }?: {
440
- code?: string;
441
- }): Promise<any>;
340
+ getPromotionCodeExists({ code }?: CartPlatformApplicationValidator.GetPromotionCodeExistsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<any>;
442
341
  /**
443
- * @param {Object} arg - Arg object.
444
- * @param {number} [arg.pageNo] -
445
- * @param {number} [arg.pageSize] -
446
- * @param {string} [arg.q] -
447
- * @param {boolean} [arg.isActive] -
448
- * @param {string} [arg.promoGroup] -
449
- * @param {string} [arg.promotionType] -
450
- * @param {string} [arg.fpPanel] -
451
- * @param {string} [arg.promotionId] -
452
- * @returns {Promise<PromotionsResponse>} - Success response
342
+ * @param {CartPlatformApplicationValidator.GetPromotionsParam} arg - Arg object
343
+ * @param {import("../PlatformAPIClient").Options} - Options
344
+ * @returns {Promise<CartPlatformModel.PromotionsResponse>} - Success response
345
+ * @name getPromotions
453
346
  * @summary: Get promotion list
454
- * @description: Get promotion list with pagination
347
+ * @description: Get promotion list with pagination - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotions/).
455
348
  */
456
- getPromotions({ pageNo, pageSize, q, isActive, promoGroup, promotionType, fpPanel, promotionId, }?: {
457
- pageNo?: number;
458
- pageSize?: number;
459
- q?: string;
460
- isActive?: boolean;
461
- promoGroup?: string;
462
- promotionType?: string;
463
- fpPanel?: string;
464
- promotionId?: string;
465
- }): Promise<PromotionsResponse>;
349
+ getPromotions({ pageNo, pageSize, q, isActive, promoGroup, promotionType, fpPanel, promotionId, }?: CartPlatformApplicationValidator.GetPromotionsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.PromotionsResponse>;
466
350
  /**
467
351
  * @param {Object} arg - Arg object.
468
352
  * @param {string} arg.companyId - Current company id
@@ -474,6 +358,7 @@ declare class Cart {
474
358
  * @param {string} [arg.promotionType] -
475
359
  * @param {string} [arg.fpPanel] -
476
360
  * @param {string} [arg.promotionId] -
361
+ * @returns {Paginator<CartPlatformModel.PromotionsResponse>}
477
362
  * @summary: Get promotion list
478
363
  * @description: Get promotion list with pagination
479
364
  */
@@ -487,391 +372,264 @@ declare class Cart {
487
372
  promotionType?: string;
488
373
  fpPanel?: string;
489
374
  promotionId?: string;
490
- }): Paginator;
375
+ }): Paginator<CartPlatformModel.PromotionsResponse>;
491
376
  /**
492
- * @param {Object} arg - Arg object.
493
- * @param {number} [arg.pickAtStoreUid] -
494
- * @param {number} [arg.orderingStoreId] -
495
- * @param {boolean} [arg.i] - This is a boolean value. Select `true` to
496
- * retrieve all the items added in the cart.
497
- * @param {boolean} [arg.p] - This is a boolean value. Select `true` for
498
- * getting a payment option in response.
499
- * @param {string} [arg.id] - The unique identifier of the cart
500
- * @param {string} [arg.addressId] - ID allotted to the selected address
501
- * @param {string} [arg.areaCode] - The PIN Code of the destination address,
502
- * e.g. 400059
503
- * @param {string} [arg.orderType] - The order type of shipment HomeDelivery
504
- * - If the customer wants the order home-delivered PickAtStore - If the
505
- * customer wants the handover of an order at the store itself.
506
- * @returns {Promise<PlatformCartShipmentsResponse>} - Success response
377
+ * @param {CartPlatformApplicationValidator.GetShipmentsParam} arg - Arg object
378
+ * @param {import("../PlatformAPIClient").Options} - Options
379
+ * @returns {Promise<CartPlatformModel.PlatformCartShipmentsResponse>} -
380
+ * Success response
381
+ * @name getShipments
507
382
  * @summary: Get delivery date and options before checkout
508
- * @description: Use this API to get shipment details, expected delivery date, items and price breakup of the shipment.
509
- */
510
- getShipments({ pickAtStoreUid, orderingStoreId, i, p, id, addressId, areaCode, orderType, }?: {
511
- pickAtStoreUid?: number;
512
- orderingStoreId?: number;
513
- i?: boolean;
514
- p?: boolean;
515
- id?: string;
516
- addressId?: string;
517
- areaCode?: string;
518
- orderType?: string;
519
- }): Promise<PlatformCartShipmentsResponse>;
383
+ * @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/platform/cart/getShipments/).
384
+ */
385
+ getShipments({ pickAtStoreUid, orderingStoreId, i, p, id, addressId, areaCode, orderType, }?: CartPlatformApplicationValidator.GetShipmentsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.PlatformCartShipmentsResponse>;
520
386
  /**
521
- * @param {Object} arg - Arg object.
522
- * @param {number} arg.storeUid -
523
- * @returns {Promise<StoreDetailsResponse>} - Success response
387
+ * @param {CartPlatformApplicationValidator.GetStoreAddressByUidParam} arg
388
+ * - Arg object
389
+ *
390
+ * @param {import("../PlatformAPIClient").Options} - Options
391
+ * @returns {Promise<CartPlatformModel.StoreDetailsResponse>} - Success response
392
+ * @name getStoreAddressByUid
524
393
  * @summary: Get list of stores for give uids
525
- * @description: Use this API to get the store details by entering the unique identifier of the pickup stores shown in the response of available-delivery-mode API.
394
+ * @description: Use this API to get the store details by entering the unique identifier of the pickup stores shown in the response of available-delivery-mode API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getStoreAddressByUid/).
526
395
  */
527
- getStoreAddressByUid({ storeUid }?: {
528
- storeUid: number;
529
- }): Promise<StoreDetailsResponse>;
396
+ getStoreAddressByUid({ storeUid }?: CartPlatformApplicationValidator.GetStoreAddressByUidParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.StoreDetailsResponse>;
530
397
  /**
531
- * @param {Object} arg - Arg object.
532
- * @param {OverrideCheckoutReq} arg.body
533
- * @returns {Promise<OverrideCheckoutResponse>} - Success response
398
+ * @param {CartPlatformApplicationValidator.OverrideCartParam} arg - Arg object
399
+ * @param {import("../PlatformAPIClient").Options} - Options
400
+ * @returns {Promise<CartPlatformModel.OverrideCheckoutResponse>} - Success response
401
+ * @name overrideCart
534
402
  * @summary: Create Fynd order with overriding cart details
535
- * @description: Generate Fynd order while overriding cart details sent with provided `cart_items`
403
+ * @description: Generate Fynd order while overriding cart details sent with provided `cart_items` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/overrideCart/).
536
404
  */
537
- overrideCart({ body }?: {
538
- body: OverrideCheckoutReq;
539
- }): Promise<OverrideCheckoutResponse>;
405
+ overrideCart({ body }?: CartPlatformApplicationValidator.OverrideCartParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.OverrideCheckoutResponse>;
540
406
  /**
541
- * @param {Object} arg - Arg object.
542
- * @param {boolean} [arg.i] -
543
- * @param {boolean} [arg.b] -
544
- * @param {boolean} [arg.buyNow] -
545
- * @param {string} [arg.id] -
546
- * @param {PlatformAddCartRequest} arg.body
547
- * @returns {Promise<AddCartDetailResponse>} - Success response
407
+ * @param {CartPlatformApplicationValidator.PlatformAddItemsParam} arg - Arg object
408
+ * @param {import("../PlatformAPIClient").Options} - Options
409
+ * @returns {Promise<CartPlatformModel.AddCartDetailResponse>} - Success response
410
+ * @name platformAddItems
548
411
  * @summary: Add items to cart
549
- * @description: Use this API to add items to the cart.
412
+ * @description: Use this API to add items to the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformAddItems/).
550
413
  */
551
- platformAddItems({ body, i, b, buyNow, id }?: {
552
- i?: boolean;
553
- b?: boolean;
554
- buyNow?: boolean;
555
- id?: string;
556
- body: PlatformAddCartRequest;
557
- }): Promise<AddCartDetailResponse>;
414
+ platformAddItems({ body, i, b, buyNow, id }?: CartPlatformApplicationValidator.PlatformAddItemsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.AddCartDetailResponse>;
558
415
  /**
559
- * @param {Object} arg - Arg object.
560
- * @param {string} [arg.id] -
561
- * @param {PlatformCartCheckoutDetailRequest} arg.body
562
- * @returns {Promise<CartCheckoutResponse>} - Success response
416
+ * @param {CartPlatformApplicationValidator.PlatformCheckoutCartParam} arg
417
+ * - Arg object
418
+ *
419
+ * @param {import("../PlatformAPIClient").Options} - Options
420
+ * @returns {Promise<CartPlatformModel.CartCheckoutResponse>} - Success response
421
+ * @name platformCheckoutCart
563
422
  * @summary: Checkout all items in the cart
564
- * @description: Use this API to checkout all items in the cart for payment and order generation. For COD, order will be generated directly, whereas for other checkout modes, user will be redirected to a payment gateway.
423
+ * @description: Use this API to checkout all items in the cart for payment and order generation. For COD, order will be generated directly, whereas for other checkout modes, user will be redirected to a payment gateway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCart/).
565
424
  */
566
- platformCheckoutCart({ body, id }?: {
567
- id?: string;
568
- body: PlatformCartCheckoutDetailRequest;
569
- }): Promise<CartCheckoutResponse>;
425
+ platformCheckoutCart({ body, id }?: CartPlatformApplicationValidator.PlatformCheckoutCartParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.CartCheckoutResponse>;
570
426
  /**
571
- * @param {Object} arg - Arg object.
572
- * @param {string} [arg.id] -
573
- * @param {PlatformCartCheckoutDetailV2Request} arg.body
574
- * @returns {Promise<CartCheckoutResponse>} - Success response
427
+ * @param {CartPlatformApplicationValidator.PlatformCheckoutCartV2Param} arg
428
+ * - Arg object
429
+ *
430
+ * @param {import("../PlatformAPIClient").Options} - Options
431
+ * @returns {Promise<CartPlatformModel.CartCheckoutResponse>} - Success response
432
+ * @name platformCheckoutCartV2
575
433
  * @summary: Checkout all items in the cart
576
- * @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.
434
+ * @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/platform/cart/platformCheckoutCartV2/).
577
435
  */
578
- platformCheckoutCartV2({ body, id }?: {
579
- id?: string;
580
- body: PlatformCartCheckoutDetailV2Request;
581
- }): Promise<CartCheckoutResponse>;
436
+ platformCheckoutCartV2({ body, id }?: CartPlatformApplicationValidator.PlatformCheckoutCartV2Param, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.CartCheckoutResponse>;
582
437
  /**
583
- * @param {Object} arg - Arg object.
584
- * @param {string} [arg.id] -
585
- * @param {boolean} [arg.i] -
586
- * @param {boolean} [arg.b] -
587
- * @param {boolean} [arg.buyNow] -
588
- * @param {PlatformUpdateCartRequest} arg.body
589
- * @returns {Promise<UpdateCartDetailResponse>} - Success response
438
+ * @param {CartPlatformApplicationValidator.PlatformUpdateCartParam} arg - Arg object
439
+ * @param {import("../PlatformAPIClient").Options} - Options
440
+ * @returns {Promise<CartPlatformModel.UpdateCartDetailResponse>} - Success response
441
+ * @name platformUpdateCart
590
442
  * @summary: Update items in the customer 's cart using cart id
591
- * @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>
443
+ * @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/platform/cart/platformUpdateCart/).
592
444
  */
593
- platformUpdateCart({ body, id, i, b, buyNow }?: {
594
- id?: string;
595
- i?: boolean;
596
- b?: boolean;
597
- buyNow?: boolean;
598
- body: PlatformUpdateCartRequest;
599
- }): Promise<UpdateCartDetailResponse>;
445
+ platformUpdateCart({ body, id, i, b, buyNow }?: CartPlatformApplicationValidator.PlatformUpdateCartParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.UpdateCartDetailResponse>;
600
446
  /**
601
- * @param {Object} arg - Arg object.
602
- * @param {string} arg.id - ID allotted to the selected address
603
- * @param {string} [arg.userId] - Option to delete address for the provided user_id.
604
- * @returns {Promise<DeleteAddressResponse>} - Success response
447
+ * @param {CartPlatformApplicationValidator.RemoveAddressParam} arg - Arg object
448
+ * @param {import("../PlatformAPIClient").Options} - Options
449
+ * @returns {Promise<CartPlatformModel.DeleteAddressResponse>} - Success response
450
+ * @name removeAddress
605
451
  * @summary: Remove address associated with an account
606
- * @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.
452
+ * @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/platform/cart/removeAddress/).
607
453
  */
608
- removeAddress({ id, userId }?: {
609
- id: string;
610
- userId?: string;
611
- }): Promise<DeleteAddressResponse>;
454
+ removeAddress({ id, userId }?: CartPlatformApplicationValidator.RemoveAddressParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.DeleteAddressResponse>;
612
455
  /**
613
- * @param {Object} arg - Arg object.
614
- * @param {string} [arg.uid] -
615
- * @param {boolean} [arg.buyNow] -
616
- * @returns {Promise<CartDetailResponse>} - Success response
456
+ * @param {CartPlatformApplicationValidator.RemoveCouponParam} arg - Arg object
457
+ * @param {import("../PlatformAPIClient").Options} - Options
458
+ * @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
459
+ * @name removeCoupon
617
460
  * @summary: Remove Applied Coupon for platform pos user
618
- * @description: Remove Coupon applied on the cart by passing uid in request body.
461
+ * @description: Remove Coupon applied on the cart by passing uid in request body. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removeCoupon/).
619
462
  */
620
- removeCoupon({ uid, buyNow }?: {
621
- uid?: string;
622
- buyNow?: boolean;
623
- }): Promise<CartDetailResponse>;
463
+ removeCoupon({ uid, buyNow }?: CartPlatformApplicationValidator.RemoveCouponParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.CartDetailResponse>;
624
464
  /**
625
- * @param {Object} arg - Arg object.
626
- * @param {string} arg.id -
627
- * @returns {Promise<SuccessMessage>} - Success response
465
+ * @param {CartPlatformApplicationValidator.RemovePriceAdjustmentParam} arg
466
+ * - Arg object
467
+ *
468
+ * @param {import("../PlatformAPIClient").Options} - Options
469
+ * @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
470
+ * @name removePriceAdjustment
628
471
  * @summary: Remove price adjustment
629
- * @description: Remove price adjustment
472
+ * @description: Remove price adjustment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removePriceAdjustment/).
630
473
  */
631
- removePriceAdjustment({ id }?: {
632
- id: string;
633
- }): Promise<SuccessMessage>;
474
+ removePriceAdjustment({ id }?: CartPlatformApplicationValidator.RemovePriceAdjustmentParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.SuccessMessage>;
634
475
  /**
635
- * @param {Object} arg - Arg object.
636
- * @param {string} [arg.cartId] -
637
- * @param {boolean} [arg.buyNow] -
638
- * @param {boolean} [arg.i] -
639
- * @param {boolean} [arg.b] -
640
- * @param {PlatformSelectCartAddressRequest} arg.body
641
- * @returns {Promise<CartDetailResponse>} - Success response
476
+ * @param {CartPlatformApplicationValidator.SelectAddressParam} arg - Arg object
477
+ * @param {import("../PlatformAPIClient").Options} - Options
478
+ * @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
479
+ * @name selectAddress
642
480
  * @summary: Select an address from available addresses
643
- * @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 `PlatformSelectCartAddressRequest` 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>
481
+ * @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 `PlatformSelectCartAddressRequest` 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/platform/cart/selectAddress/).
644
482
  */
645
- selectAddress({ body, cartId, buyNow, i, b }?: {
646
- cartId?: string;
647
- buyNow?: boolean;
648
- i?: boolean;
649
- b?: boolean;
650
- body: PlatformSelectCartAddressRequest;
651
- }): Promise<CartDetailResponse>;
483
+ selectAddress({ body, cartId, buyNow, i, b }?: CartPlatformApplicationValidator.SelectAddressParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.CartDetailResponse>;
652
484
  /**
653
- * @param {Object} arg - Arg object.
654
- * @param {string} [arg.id] -
655
- * @param {boolean} [arg.buyNow] -
656
- * @param {string} [arg.orderType] - The order type of shipment HomeDelivery
657
- * - If the customer wants the order home-delivered PickAtStore - If the
658
- * customer wants the handover of an order at the store itself.
659
- * @param {UpdateCartPaymentRequest} arg.body
660
- * @returns {Promise<CartDetailResponse>} - Success response
485
+ * @param {CartPlatformApplicationValidator.SelectPaymentModeParam} arg - Arg object
486
+ * @param {import("../PlatformAPIClient").Options} - Options
487
+ * @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
488
+ * @name selectPaymentMode
661
489
  * @summary: Update cart payment
662
- * @description: Use this API to update cart payment.
490
+ * @description: Use this API to update cart payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/selectPaymentMode/).
663
491
  */
664
- selectPaymentMode({ body, id, buyNow, orderType }?: {
665
- id?: string;
666
- buyNow?: boolean;
667
- orderType?: string;
668
- body: UpdateCartPaymentRequest;
669
- }): Promise<CartDetailResponse>;
492
+ selectPaymentMode({ body, id, buyNow, orderType }?: CartPlatformApplicationValidator.SelectPaymentModeParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.CartDetailResponse>;
670
493
  /**
671
- * @param {Object} arg - Arg object.
672
- * @param {string} [arg.id] -
673
- * @param {boolean} [arg.buyNow] -
674
- * @param {string} [arg.orderType] - The order type of shipment HomeDelivery
675
- * - If the customer wants the order home-delivered PickAtStore - If the
676
- * customer wants the handover of an order at the store itself.
677
- * @param {UpdateCartPaymentRequestV2} arg.body
678
- * @returns {Promise<CartDetailResponse>} - Success response
494
+ * @param {CartPlatformApplicationValidator.SelectPaymentModeV2Param} arg - Arg object
495
+ * @param {import("../PlatformAPIClient").Options} - Options
496
+ * @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
497
+ * @name selectPaymentModeV2
679
498
  * @summary: Update cart payment
680
- * @description: Use this API to update cart payment.
499
+ * @description: Use this API to update cart payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/selectPaymentModeV2/).
681
500
  */
682
- selectPaymentModeV2({ body, id, buyNow, orderType }?: {
683
- id?: string;
684
- buyNow?: boolean;
685
- orderType?: string;
686
- body: UpdateCartPaymentRequestV2;
687
- }): Promise<CartDetailResponse>;
501
+ selectPaymentModeV2({ body, id, buyNow, orderType }?: CartPlatformApplicationValidator.SelectPaymentModeV2Param, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.CartDetailResponse>;
688
502
  /**
689
- * @param {Object} arg - Arg object.
690
- * @param {string} arg.id - ID allotted to the selected address
691
- * @param {PlatformAddress} arg.body
692
- * @returns {Promise<UpdateAddressResponse>} - Success response
503
+ * @param {CartPlatformApplicationValidator.UpdateAddressParam} arg - Arg object
504
+ * @param {import("../PlatformAPIClient").Options} - Options
505
+ * @returns {Promise<CartPlatformModel.UpdateAddressResponse>} - Success response
506
+ * @name updateAddress
693
507
  * @summary: Update address added to an account
694
- * @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>
508
+ * @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/platform/cart/updateAddress/).
695
509
  */
696
- updateAddress({ id, body }?: {
697
- id: string;
698
- body: PlatformAddress;
699
- }): Promise<UpdateAddressResponse>;
510
+ updateAddress({ id, body }?: CartPlatformApplicationValidator.UpdateAddressParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.UpdateAddressResponse>;
700
511
  /**
701
- * @param {Object} arg - Arg object.
702
- * @param {string} arg.cartId - Current Cart _id
703
- * @param {boolean} [arg.b] -
704
- * @param {UpdateCartRequest} arg.body
705
- * @returns {Promise<UpdateCartDetailResponse>} - Success response
512
+ * @param {CartPlatformApplicationValidator.UpdateCartParam} arg - Arg object
513
+ * @param {import("../PlatformAPIClient").Options} - Options
514
+ * @returns {Promise<CartPlatformModel.UpdateCartDetailResponse>} - Success response
515
+ * @name updateCart
706
516
  * @summary: Update items in the abandoned cart
707
- * @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>
517
+ * @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/platform/cart/updateCart/).
708
518
  */
709
- updateCart({ cartId, body, b }?: {
710
- cartId: string;
711
- b?: boolean;
712
- body: UpdateCartRequest;
713
- }): Promise<UpdateCartDetailResponse>;
519
+ updateCart({ cartId, body, b }?: CartPlatformApplicationValidator.UpdateCartParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.UpdateCartDetailResponse>;
714
520
  /**
715
- * @param {Object} arg - Arg object.
716
- * @param {string} [arg.id] -
717
- * @param {boolean} [arg.buyNow] -
718
- * @param {PlatformCartMetaRequest} arg.body
719
- * @returns {Promise<CartMetaResponse>} - Success response
521
+ * @param {CartPlatformApplicationValidator.UpdateCartMetaParam} arg - Arg object
522
+ * @param {import("../PlatformAPIClient").Options} - Options
523
+ * @returns {Promise<CartPlatformModel.CartMetaResponse>} - Success response
524
+ * @name updateCartMeta
720
525
  * @summary: Update the cart meta for platform pos user
721
- * @description: Use this API to update cart meta like checkout_mode and gstin.
526
+ * @description: Use this API to update cart meta like checkout_mode and gstin. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartMeta/).
722
527
  */
723
- updateCartMeta({ body, id, buyNow }?: {
724
- id?: string;
725
- buyNow?: boolean;
726
- body: PlatformCartMetaRequest;
727
- }): Promise<CartMetaResponse>;
528
+ updateCartMeta({ body, id, buyNow }?: CartPlatformApplicationValidator.UpdateCartMetaParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.CartMetaResponse>;
728
529
  /**
729
- * @param {Object} arg - Arg object.
730
- * @param {string} arg.cartMetaId -
731
- * @param {CartMetaConfigUpdate} arg.body
732
- * @returns {Promise<CartMetaConfigUpdate>} - Success response
530
+ * @param {CartPlatformApplicationValidator.UpdateCartMetaConfigParam} arg
531
+ * - Arg object
532
+ *
533
+ * @param {import("../PlatformAPIClient").Options} - Options
534
+ * @returns {Promise<CartPlatformModel.CartMetaConfigUpdate>} - Success response
535
+ * @name updateCartMetaConfig
733
536
  * @summary: Update cart meta configuration
734
- * @description: Update cart meta configuration
537
+ * @description: Update cart meta configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartMetaConfig/).
735
538
  */
736
- updateCartMetaConfig({ cartMetaId, body }?: {
737
- cartMetaId: string;
738
- body: CartMetaConfigUpdate;
739
- }): Promise<CartMetaConfigUpdate>;
539
+ updateCartMetaConfig({ cartMetaId, body }?: CartPlatformApplicationValidator.UpdateCartMetaConfigParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.CartMetaConfigUpdate>;
740
540
  /**
741
- * @param {Object} arg - Arg object.
742
- * @param {string} [arg.id] -
743
- * @param {UpdateUserCartMapping} arg.body
744
- * @returns {Promise<UserCartMappingResponse>} - Success response
541
+ * @param {CartPlatformApplicationValidator.UpdateCartUserParam} arg - Arg object
542
+ * @param {import("../PlatformAPIClient").Options} - Options
543
+ * @returns {Promise<CartPlatformModel.UserCartMappingResponse>} - Success response
544
+ * @name updateCartUser
745
545
  * @summary: Update user id for store os customer
746
- * @description: Update user id for store os customer after creating customer
546
+ * @description: Update user id for store os customer after creating customer - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartUser/).
747
547
  */
748
- updateCartUser({ body, id }?: {
749
- id?: string;
750
- body: UpdateUserCartMapping;
751
- }): Promise<UserCartMappingResponse>;
548
+ updateCartUser({ body, id }?: CartPlatformApplicationValidator.UpdateCartUserParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.UserCartMappingResponse>;
752
549
  /**
753
- * @param {Object} arg - Arg object.
754
- * @param {string} arg.token - Token of the shared short link
755
- * @param {string} arg.action - Operation to perform on the existing cart
756
- * merge or replace.
757
- * @param {string} [arg.cartId] -
758
- * @returns {Promise<SharedCartResponse>} - Success response
550
+ * @param {CartPlatformApplicationValidator.UpdateCartWithSharedItemsParam} arg
551
+ * - Arg object
552
+ *
553
+ * @param {import("../PlatformAPIClient").Options} - Options
554
+ * @returns {Promise<CartPlatformModel.SharedCartResponse>} - Success response
555
+ * @name updateCartWithSharedItems
759
556
  * @summary: Merge or replace existing cart
760
- * @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.
557
+ * @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/platform/cart/updateCartWithSharedItems/).
761
558
  */
762
- updateCartWithSharedItems({ token, action, cartId }?: {
763
- token: string;
764
- action: string;
765
- cartId?: string;
766
- }): Promise<SharedCartResponse>;
559
+ updateCartWithSharedItems({ token, action, cartId }?: CartPlatformApplicationValidator.UpdateCartWithSharedItemsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.SharedCartResponse>;
767
560
  /**
768
- * @param {Object} arg - Arg object.
769
- * @param {string} arg.id -
770
- * @param {CouponUpdate} arg.body
771
- * @returns {Promise<SuccessMessage>} - Success response
561
+ * @param {CartPlatformApplicationValidator.UpdateCouponParam} arg - Arg object
562
+ * @param {import("../PlatformAPIClient").Options} - Options
563
+ * @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
564
+ * @name updateCoupon
772
565
  * @summary: Update existing coupon configuration
773
- * @description: Update coupon with id sent in `id`
566
+ * @description: Update coupon with id sent in `id` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCoupon/).
774
567
  */
775
- updateCoupon({ id, body }?: {
776
- id: string;
777
- body: CouponUpdate;
778
- }): Promise<SuccessMessage>;
568
+ updateCoupon({ id, body }?: CartPlatformApplicationValidator.UpdateCouponParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.SuccessMessage>;
779
569
  /**
780
- * @param {Object} arg - Arg object.
781
- * @param {string} arg.id -
782
- * @param {CouponPartialUpdate} arg.body
783
- * @returns {Promise<SuccessMessage>} - Success response
570
+ * @param {CartPlatformApplicationValidator.UpdateCouponPartiallyParam} arg
571
+ * - Arg object
572
+ *
573
+ * @param {import("../PlatformAPIClient").Options} - Options
574
+ * @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
575
+ * @name updateCouponPartially
784
576
  * @summary: Update coupon archive state and schedule
785
- * @description: Update archive/unarchive and change schedule for coupon
577
+ * @description: Update archive/unarchive and change schedule for coupon - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCouponPartially/).
786
578
  */
787
- updateCouponPartially({ id, body }?: {
788
- id: string;
789
- body: CouponPartialUpdate;
790
- }): Promise<SuccessMessage>;
579
+ updateCouponPartially({ id, body }?: CartPlatformApplicationValidator.UpdateCouponPartiallyParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.SuccessMessage>;
791
580
  /**
792
- * @param {Object} arg - Arg object.
793
- * @param {string} arg.id -
794
- * @param {PriceAdjustmentUpdate} arg.body
795
- * @returns {Promise<PriceAdjustmentResponse>} - Success response
581
+ * @param {CartPlatformApplicationValidator.UpdatePriceAdjustmentParam} arg
582
+ * - Arg object
583
+ *
584
+ * @param {import("../PlatformAPIClient").Options} - Options
585
+ * @returns {Promise<CartPlatformModel.PriceAdjustmentResponse>} - Success response
586
+ * @name updatePriceAdjustment
796
587
  * @summary: Update price adjustment configuration
797
- * @description: Update price adjustment configuration
588
+ * @description: Update price adjustment configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePriceAdjustment/).
798
589
  */
799
- updatePriceAdjustment({ id, body }?: {
800
- id: string;
801
- body: PriceAdjustmentUpdate;
802
- }): Promise<PriceAdjustmentResponse>;
590
+ updatePriceAdjustment({ id, body }?: CartPlatformApplicationValidator.UpdatePriceAdjustmentParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.PriceAdjustmentResponse>;
803
591
  /**
804
- * @param {Object} arg - Arg object.
805
- * @param {string} arg.id -
806
- * @param {PromotionUpdate} arg.body
807
- * @returns {Promise<PromotionUpdate>} - Success response
592
+ * @param {CartPlatformApplicationValidator.UpdatePromotionParam} arg - Arg object
593
+ * @param {import("../PlatformAPIClient").Options} - Options
594
+ * @returns {Promise<CartPlatformModel.PromotionUpdate>} - Success response
595
+ * @name updatePromotion
808
596
  * @summary: Update existing promotion configuration
809
- * @description: Update promotion with id sent in `id`
597
+ * @description: Update promotion with id sent in `id` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePromotion/).
810
598
  */
811
- updatePromotion({ id, body }?: {
812
- id: string;
813
- body: PromotionUpdate;
814
- }): Promise<PromotionUpdate>;
599
+ updatePromotion({ id, body }?: CartPlatformApplicationValidator.UpdatePromotionParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.PromotionUpdate>;
815
600
  /**
816
- * @param {Object} arg - Arg object.
817
- * @param {string} arg.id -
818
- * @param {PromotionPartialUpdate} arg.body
819
- * @returns {Promise<SuccessMessage>} - Success response
601
+ * @param {CartPlatformApplicationValidator.UpdatePromotionPartiallyParam} arg
602
+ * - Arg object
603
+ *
604
+ * @param {import("../PlatformAPIClient").Options} - Options
605
+ * @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
606
+ * @name updatePromotionPartially
820
607
  * @summary: Update promotion publish state and schedule
821
- * @description: Update publish/unpublish and change schedule for promotion
608
+ * @description: Update publish/unpublish and change schedule for promotion - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePromotionPartially/).
822
609
  */
823
- updatePromotionPartially({ id, body }?: {
824
- id: string;
825
- body: PromotionPartialUpdate;
826
- }): Promise<SuccessMessage>;
610
+ updatePromotionPartially({ id, body }?: CartPlatformApplicationValidator.UpdatePromotionPartiallyParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.SuccessMessage>;
827
611
  /**
828
- * @param {Object} arg - Arg object.
829
- * @param {boolean} [arg.i] - This is a boolean value. Select `true` to
830
- * retrieve all the items added in the cart.
831
- * @param {boolean} [arg.p] - This is a boolean value. Select `true` for
832
- * getting a payment option in response.
833
- * @param {string} [arg.id] - The unique identifier of the cart
834
- * @param {string} [arg.addressId] - ID allotted to an address
835
- * @param {string} [arg.areaCode] - The PIN Code of the destination address,
836
- * e.g. 400059
837
- * @param {string} [arg.orderType] - The order type of shipment HomeDelivery
838
- * - If the customer wants the order home-delivered PickAtStore - If the
839
- * customer wants the handover of an order at the store itself.
840
- * @param {UpdateCartShipmentRequest} arg.body
841
- * @returns {Promise<PlatformCartShipmentsResponse>} - Success response
612
+ * @param {CartPlatformApplicationValidator.UpdateShipmentsParam} arg - Arg object
613
+ * @param {import("../PlatformAPIClient").Options} - Options
614
+ * @returns {Promise<CartPlatformModel.PlatformCartShipmentsResponse>} -
615
+ * Success response
616
+ * @name updateShipments
842
617
  * @summary: Update shipment delivery type and quantity before checkout
843
- * @description: Use this API to update the delivery type and quantity as per customer's preference for either store pick-up or home-delivery.
844
- */
845
- updateShipments({ body, i, p, id, addressId, areaCode, orderType, }?: {
846
- i?: boolean;
847
- p?: boolean;
848
- id?: string;
849
- addressId?: string;
850
- areaCode?: string;
851
- orderType?: string;
852
- body: UpdateCartShipmentRequest;
853
- }): Promise<PlatformCartShipmentsResponse>;
618
+ * @description: Use this API to update the delivery type and quantity as per customer's preference for either store pick-up or home-delivery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateShipments/).
619
+ */
620
+ updateShipments({ body, i, p, id, addressId, areaCode, orderType }?: CartPlatformApplicationValidator.UpdateShipmentsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.PlatformCartShipmentsResponse>;
854
621
  /**
855
- * @param {Object} arg - Arg object.
856
- * @param {string} [arg.id] -
857
- * @param {boolean} [arg.buyNow] -
858
- * @param {string} [arg.addressId] -
859
- * @param {string} [arg.paymentMode] -
860
- * @param {string} [arg.paymentIdentifier] -
861
- * @param {string} [arg.aggregatorName] -
862
- * @param {string} [arg.merchantCode] -
863
- * @returns {Promise<PaymentCouponValidate>} - Success response
622
+ * @param {CartPlatformApplicationValidator.ValidateCouponForPaymentParam} arg
623
+ * - Arg object
624
+ *
625
+ * @param {import("../PlatformAPIClient").Options} - Options
626
+ * @returns {Promise<CartPlatformModel.PaymentCouponValidate>} - Success response
627
+ * @name validateCouponForPayment
864
628
  * @summary: Verify the coupon eligibility against the payment mode
865
- * @description: Use this API to validate a coupon against the payment mode such as NetBanking, Wallet, UPI etc.
866
- */
867
- validateCouponForPayment({ id, buyNow, addressId, paymentMode, paymentIdentifier, aggregatorName, merchantCode, }?: {
868
- id?: string;
869
- buyNow?: boolean;
870
- addressId?: string;
871
- paymentMode?: string;
872
- paymentIdentifier?: string;
873
- aggregatorName?: string;
874
- merchantCode?: string;
875
- }): Promise<PaymentCouponValidate>;
629
+ * @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/platform/cart/validateCouponForPayment/).
630
+ */
631
+ validateCouponForPayment({ id, buyNow, addressId, paymentMode, paymentIdentifier, aggregatorName, merchantCode, }?: CartPlatformApplicationValidator.ValidateCouponForPaymentParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CartPlatformModel.PaymentCouponValidate>;
876
632
  }
633
+ import CartPlatformApplicationValidator = require("./CartPlatformApplicationValidator");
634
+ import CartPlatformModel = require("./CartPlatformModel");
877
635
  import Paginator = require("../../common/Paginator");