@gofynd/fdk-client-javascript 1.1.6 → 1.3.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 (348) hide show
  1. package/README.md +52 -3
  2. package/index.js +0 -3
  3. package/package.json +1 -2
  4. package/sdk/application/ApplicationAPIClient.d.ts +15 -1
  5. package/sdk/application/ApplicationAPIClient.js +12 -3
  6. package/sdk/application/ApplicationClient.d.ts +36 -6
  7. package/sdk/application/ApplicationClient.js +30 -43
  8. package/sdk/application/ApplicationConfig.d.ts +92 -12
  9. package/sdk/application/ApplicationConfig.js +48 -14
  10. package/sdk/application/Cart/CartApplicationClient.d.ts +200 -357
  11. package/sdk/application/Cart/CartApplicationClient.js +711 -483
  12. package/sdk/application/Cart/CartApplicationModel.d.ts +2054 -96
  13. package/sdk/application/Cart/CartApplicationModel.js +1224 -93
  14. package/sdk/application/Cart/CartApplicationValidator.d.ts +508 -30
  15. package/sdk/application/Cart/CartApplicationValidator.js +270 -15
  16. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +274 -422
  17. package/sdk/application/Catalog/CatalogApplicationClient.js +865 -630
  18. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2320 -117
  19. package/sdk/application/Catalog/CatalogApplicationModel.js +1566 -172
  20. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +798 -31
  21. package/sdk/application/Catalog/CatalogApplicationValidator.js +318 -3
  22. package/sdk/application/Common/CommonApplicationClient.d.ts +16 -21
  23. package/sdk/application/Common/CommonApplicationClient.js +52 -33
  24. package/sdk/application/Common/CommonApplicationModel.d.ts +368 -19
  25. package/sdk/application/Common/CommonApplicationModel.js +192 -40
  26. package/sdk/application/Common/CommonApplicationValidator.d.ts +42 -4
  27. package/sdk/application/Common/CommonApplicationValidator.js +21 -3
  28. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +31 -18
  29. package/sdk/application/Communication/CommunicationApplicationClient.js +86 -47
  30. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +157 -14
  31. package/sdk/application/Communication/CommunicationApplicationModel.js +104 -23
  32. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +27 -4
  33. package/sdk/application/Communication/CommunicationApplicationValidator.js +21 -5
  34. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +149 -118
  35. package/sdk/application/Configuration/ConfigurationApplicationClient.js +457 -260
  36. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +2235 -110
  37. package/sdk/application/Configuration/ConfigurationApplicationModel.js +1113 -193
  38. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +160 -8
  39. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +88 -4
  40. package/sdk/application/Content/ContentApplicationClient.d.ts +149 -139
  41. package/sdk/application/Content/ContentApplicationClient.js +489 -278
  42. package/sdk/application/Content/ContentApplicationModel.d.ts +1010 -105
  43. package/sdk/application/Content/ContentApplicationModel.js +737 -396
  44. package/sdk/application/Content/ContentApplicationValidator.d.ts +214 -12
  45. package/sdk/application/Content/ContentApplicationValidator.js +113 -3
  46. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +23 -29
  47. package/sdk/application/FileStorage/FileStorageApplicationClient.js +74 -47
  48. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +148 -20
  49. package/sdk/application/FileStorage/FileStorageApplicationModel.js +100 -87
  50. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +55 -5
  51. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +33 -6
  52. package/sdk/application/Lead/LeadApplicationClient.d.ts +57 -53
  53. package/sdk/application/Lead/LeadApplicationClient.js +188 -103
  54. package/sdk/application/Lead/LeadApplicationModel.d.ts +686 -54
  55. package/sdk/application/Lead/LeadApplicationModel.js +330 -244
  56. package/sdk/application/Lead/LeadApplicationValidator.d.ts +91 -9
  57. package/sdk/application/Lead/LeadApplicationValidator.js +51 -6
  58. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +40 -33
  59. package/sdk/application/Logistic/LogisticApplicationClient.js +131 -73
  60. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +399 -28
  61. package/sdk/application/Logistic/LogisticApplicationModel.js +293 -24
  62. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +48 -6
  63. package/sdk/application/Logistic/LogisticApplicationValidator.js +34 -6
  64. package/sdk/application/Order/OrderApplicationClient.d.ts +93 -133
  65. package/sdk/application/Order/OrderApplicationClient.js +329 -217
  66. package/sdk/application/Order/OrderApplicationModel.d.ts +1101 -66
  67. package/sdk/application/Order/OrderApplicationModel.js +776 -57
  68. package/sdk/application/Order/OrderApplicationValidator.d.ts +249 -14
  69. package/sdk/application/Order/OrderApplicationValidator.js +114 -5
  70. package/sdk/application/Payment/PaymentApplicationClient.d.ts +400 -366
  71. package/sdk/application/Payment/PaymentApplicationClient.js +1176 -703
  72. package/sdk/application/Payment/PaymentApplicationModel.d.ts +3125 -99
  73. package/sdk/application/Payment/PaymentApplicationModel.js +1158 -62
  74. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +494 -41
  75. package/sdk/application/Payment/PaymentApplicationValidator.js +297 -25
  76. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +205 -350
  77. package/sdk/application/PosCart/PosCartApplicationClient.js +720 -491
  78. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1823 -89
  79. package/sdk/application/PosCart/PosCartApplicationModel.js +1117 -85
  80. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +480 -29
  81. package/sdk/application/PosCart/PosCartApplicationValidator.js +262 -15
  82. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +58 -47
  83. package/sdk/application/Rewards/RewardsApplicationClient.js +187 -102
  84. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +343 -22
  85. package/sdk/application/Rewards/RewardsApplicationModel.js +230 -15
  86. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +70 -7
  87. package/sdk/application/Rewards/RewardsApplicationValidator.js +45 -6
  88. package/sdk/application/Share/ShareApplicationClient.d.ts +52 -50
  89. package/sdk/application/Share/ShareApplicationClient.js +185 -97
  90. package/sdk/application/Share/ShareApplicationModel.d.ts +198 -15
  91. package/sdk/application/Share/ShareApplicationModel.js +131 -31
  92. package/sdk/application/Share/ShareApplicationValidator.d.ts +86 -8
  93. package/sdk/application/Share/ShareApplicationValidator.js +48 -4
  94. package/sdk/application/Theme/ThemeApplicationClient.d.ts +30 -27
  95. package/sdk/application/Theme/ThemeApplicationClient.js +102 -56
  96. package/sdk/application/Theme/ThemeApplicationModel.d.ts +1291 -48
  97. package/sdk/application/Theme/ThemeApplicationModel.js +895 -134
  98. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +49 -5
  99. package/sdk/application/Theme/ThemeApplicationValidator.js +26 -3
  100. package/sdk/application/User/UserApplicationClient.d.ts +260 -305
  101. package/sdk/application/User/UserApplicationClient.js +910 -522
  102. package/sdk/application/User/UserApplicationModel.d.ts +992 -101
  103. package/sdk/application/User/UserApplicationModel.js +699 -248
  104. package/sdk/application/User/UserApplicationValidator.d.ts +457 -33
  105. package/sdk/application/User/UserApplicationValidator.js +265 -31
  106. package/sdk/common/AxiosHelper.js +7 -2
  107. package/sdk/common/FDKError.d.ts +3 -0
  108. package/sdk/common/FDKError.js +8 -0
  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/common/utils.d.ts +3 -0
  113. package/sdk/common/utils.js +29 -0
  114. package/sdk/partner/PartnerAPIClient.d.ts +16 -1
  115. package/sdk/partner/PartnerAPIClient.js +12 -2
  116. package/sdk/partner/PartnerClient.d.ts +22 -3
  117. package/sdk/partner/PartnerClient.js +20 -0
  118. package/sdk/partner/PartnerConfig.d.ts +40 -14
  119. package/sdk/partner/PartnerConfig.js +31 -6
  120. package/sdk/partner/Theme/ThemePartnerClient.d.ts +299 -0
  121. package/sdk/partner/Theme/ThemePartnerClient.js +768 -0
  122. package/sdk/partner/Theme/ThemePartnerModel.d.ts +1706 -0
  123. package/sdk/partner/Theme/ThemePartnerModel.js +1409 -0
  124. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +22 -0
  125. package/sdk/partner/Theme/ThemePartnerValidator.js +157 -0
  126. package/sdk/partner/index.d.ts +3 -1
  127. package/sdk/partner/index.js +3 -1
  128. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +30 -25
  129. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +104 -53
  130. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +190 -17
  131. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +132 -15
  132. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +52 -5
  133. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +30 -4
  134. package/sdk/platform/Billing/BillingPlatformClient.d.ts +133 -97
  135. package/sdk/platform/Billing/BillingPlatformClient.js +561 -191
  136. package/sdk/platform/Billing/BillingPlatformModel.d.ts +1071 -68
  137. package/sdk/platform/Billing/BillingPlatformModel.js +762 -151
  138. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +175 -12
  139. package/sdk/platform/Billing/BillingPlatformValidator.js +118 -8
  140. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +454 -635
  141. package/sdk/platform/Cart/CartPlatformApplicationClient.js +1646 -957
  142. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +827 -57
  143. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +492 -34
  144. package/sdk/platform/Cart/CartPlatformModel.d.ts +3839 -175
  145. package/sdk/platform/Cart/CartPlatformModel.js +2423 -217
  146. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +528 -638
  147. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1600 -984
  148. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1081 -49
  149. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +482 -23
  150. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +652 -826
  151. package/sdk/platform/Catalog/CatalogPlatformClient.js +1979 -1264
  152. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6869 -326
  153. package/sdk/platform/Catalog/CatalogPlatformModel.js +4215 -351
  154. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1361 -71
  155. package/sdk/platform/Catalog/CatalogPlatformValidator.js +624 -30
  156. package/sdk/platform/Common/CommonPlatformClient.d.ts +16 -21
  157. package/sdk/platform/Common/CommonPlatformClient.js +50 -33
  158. package/sdk/platform/Common/CommonPlatformModel.d.ts +423 -19
  159. package/sdk/platform/Common/CommonPlatformModel.js +214 -40
  160. package/sdk/platform/Common/CommonPlatformValidator.d.ts +37 -4
  161. package/sdk/platform/Common/CommonPlatformValidator.js +20 -3
  162. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +731 -303
  163. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +3095 -785
  164. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +699 -41
  165. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +463 -27
  166. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +19 -5
  167. package/sdk/platform/Communication/CommunicationPlatformClient.js +59 -19
  168. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1708 -102
  169. package/sdk/platform/Communication/CommunicationPlatformModel.js +1360 -235
  170. package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +16 -3
  171. package/sdk/platform/Communication/CommunicationPlatformValidator.js +11 -3
  172. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +127 -111
  173. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +435 -225
  174. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +882 -43
  175. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +666 -78
  176. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +184 -13
  177. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +105 -10
  178. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +327 -240
  179. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +922 -438
  180. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +297 -22
  181. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +191 -17
  182. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +184 -178
  183. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +555 -311
  184. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +4337 -188
  185. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2178 -248
  186. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +332 -19
  187. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +153 -10
  188. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +605 -578
  189. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1996 -987
  190. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +872 -62
  191. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +487 -35
  192. package/sdk/platform/Content/ContentPlatformModel.d.ts +1472 -108
  193. package/sdk/platform/Content/ContentPlatformModel.js +1085 -204
  194. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +85 -82
  195. package/sdk/platform/Discount/DiscountPlatformClient.js +333 -175
  196. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +281 -15
  197. package/sdk/platform/Discount/DiscountPlatformModel.js +189 -10
  198. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +185 -13
  199. package/sdk/platform/Discount/DiscountPlatformValidator.js +88 -8
  200. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +109 -52
  201. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +570 -105
  202. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +141 -6
  203. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +118 -7
  204. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +43 -63
  205. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +153 -135
  206. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +426 -20
  207. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +379 -40
  208. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +106 -8
  209. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +60 -8
  210. package/sdk/platform/Finance/FinancePlatformClient.d.ts +260 -129
  211. package/sdk/platform/Finance/FinancePlatformClient.js +1182 -194
  212. package/sdk/platform/Finance/FinancePlatformModel.d.ts +1267 -50
  213. package/sdk/platform/Finance/FinancePlatformModel.js +1252 -38
  214. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +233 -15
  215. package/sdk/platform/Finance/FinancePlatformValidator.js +229 -16
  216. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +111 -97
  217. package/sdk/platform/Inventory/InventoryPlatformClient.js +330 -199
  218. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +1354 -61
  219. package/sdk/platform/Inventory/InventoryPlatformModel.js +916 -83
  220. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +168 -12
  221. package/sdk/platform/Inventory/InventoryPlatformValidator.js +82 -6
  222. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +100 -106
  223. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +372 -186
  224. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +180 -14
  225. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +94 -9
  226. package/sdk/platform/Lead/LeadPlatformClient.d.ts +89 -104
  227. package/sdk/platform/Lead/LeadPlatformClient.js +305 -180
  228. package/sdk/platform/Lead/LeadPlatformModel.d.ts +1045 -54
  229. package/sdk/platform/Lead/LeadPlatformModel.js +504 -142
  230. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +173 -12
  231. package/sdk/platform/Lead/LeadPlatformValidator.js +92 -15
  232. package/sdk/platform/OAuthClient.js +6 -2
  233. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +20 -14
  234. package/sdk/platform/Order/OrderPlatformApplicationClient.js +58 -29
  235. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +26 -4
  236. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
  237. package/sdk/platform/Order/OrderPlatformClient.d.ts +437 -556
  238. package/sdk/platform/Order/OrderPlatformClient.js +1500 -760
  239. package/sdk/platform/Order/OrderPlatformModel.d.ts +5225 -247
  240. package/sdk/platform/Order/OrderPlatformModel.js +3473 -260
  241. package/sdk/platform/Order/OrderPlatformValidator.d.ts +859 -37
  242. package/sdk/platform/Order/OrderPlatformValidator.js +435 -23
  243. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +16 -42
  244. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +52 -155
  245. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +37 -6
  246. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +19 -17
  247. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +78 -45
  248. package/sdk/platform/Partner/PartnerPlatformModel.js +43 -369
  249. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +418 -288
  250. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +1509 -505
  251. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +438 -30
  252. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +312 -19
  253. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +83 -73
  254. package/sdk/platform/Payment/PaymentPlatformClient.js +259 -154
  255. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3200 -93
  256. package/sdk/platform/Payment/PaymentPlatformModel.js +1334 -36
  257. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +111 -11
  258. package/sdk/platform/Payment/PaymentPlatformValidator.js +68 -7
  259. package/sdk/platform/PlatformAPIClient.d.ts +16 -1
  260. package/sdk/platform/PlatformAPIClient.js +9 -1
  261. package/sdk/platform/PlatformApplicationClient.d.ts +22 -1798
  262. package/sdk/platform/PlatformApplicationClient.js +17 -1899
  263. package/sdk/platform/PlatformClient.d.ts +31 -12581
  264. package/sdk/platform/PlatformClient.js +30 -15089
  265. package/sdk/platform/PlatformConfig.d.ts +37 -11
  266. package/sdk/platform/PlatformConfig.js +32 -6
  267. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +96 -92
  268. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +344 -177
  269. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +149 -12
  270. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +82 -8
  271. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +360 -23
  272. package/sdk/platform/Rewards/RewardsPlatformModel.js +238 -22
  273. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +159 -92
  274. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +473 -208
  275. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +138 -13
  276. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +100 -14
  277. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +166 -178
  278. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +518 -329
  279. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1408 -96
  280. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1034 -71
  281. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +280 -18
  282. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -11
  283. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +41 -66
  284. package/sdk/platform/Share/SharePlatformApplicationClient.js +149 -116
  285. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +87 -7
  286. package/sdk/platform/Share/SharePlatformApplicationValidator.js +42 -5
  287. package/sdk/platform/Share/SharePlatformModel.d.ts +250 -16
  288. package/sdk/platform/Share/SharePlatformModel.js +167 -19
  289. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +229 -193
  290. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +976 -352
  291. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +345 -24
  292. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +206 -14
  293. package/sdk/platform/Theme/ThemePlatformClient.d.ts +37 -0
  294. package/sdk/platform/Theme/ThemePlatformClient.js +235 -0
  295. package/sdk/platform/Theme/ThemePlatformModel.d.ts +1527 -48
  296. package/sdk/platform/Theme/ThemePlatformModel.js +1099 -118
  297. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +32 -0
  298. package/sdk/platform/Theme/ThemePlatformValidator.js +38 -0
  299. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +138 -152
  300. package/sdk/platform/User/UserPlatformApplicationClient.js +470 -244
  301. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +242 -18
  302. package/sdk/platform/User/UserPlatformApplicationValidator.js +129 -12
  303. package/sdk/platform/User/UserPlatformModel.d.ts +653 -101
  304. package/sdk/platform/User/UserPlatformModel.js +467 -424
  305. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +153 -49
  306. package/sdk/platform/Webhook/WebhookPlatformClient.js +896 -88
  307. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +632 -16
  308. package/sdk/platform/Webhook/WebhookPlatformModel.js +502 -54
  309. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +170 -7
  310. package/sdk/platform/Webhook/WebhookPlatformValidator.js +157 -7
  311. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +16 -21
  312. package/sdk/public/Configuration/ConfigurationPublicClient.js +48 -33
  313. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +370 -19
  314. package/sdk/public/Configuration/ConfigurationPublicModel.js +191 -40
  315. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +42 -4
  316. package/sdk/public/Configuration/ConfigurationPublicValidator.js +21 -3
  317. package/sdk/public/Inventory/InventoryPublicClient.d.ts +54 -48
  318. package/sdk/public/Inventory/InventoryPublicClient.js +161 -98
  319. package/sdk/public/Inventory/InventoryPublicModel.d.ts +392 -21
  320. package/sdk/public/Inventory/InventoryPublicModel.js +267 -27
  321. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +90 -8
  322. package/sdk/public/Inventory/InventoryPublicValidator.js +44 -4
  323. package/sdk/public/Partner/PartnerPublicClient.d.ts +22 -0
  324. package/sdk/public/Partner/PartnerPublicClient.js +110 -0
  325. package/sdk/public/Partner/PartnerPublicModel.d.ts +240 -0
  326. package/sdk/public/Partner/PartnerPublicModel.js +280 -0
  327. package/sdk/public/Partner/PartnerPublicValidator.d.ts +18 -0
  328. package/sdk/public/Partner/PartnerPublicValidator.js +19 -0
  329. package/sdk/public/PublicAPIClient.d.ts +14 -1
  330. package/sdk/public/PublicAPIClient.js +7 -1
  331. package/sdk/public/PublicClient.d.ts +21 -3
  332. package/sdk/public/PublicClient.js +20 -0
  333. package/sdk/public/PublicConfig.d.ts +27 -6
  334. package/sdk/public/PublicConfig.js +17 -1
  335. package/sdk/public/Webhook/WebhookPublicClient.d.ts +16 -11
  336. package/sdk/public/Webhook/WebhookPublicClient.js +48 -27
  337. package/sdk/public/Webhook/WebhookPublicModel.d.ts +52 -16
  338. package/sdk/public/Webhook/WebhookPublicModel.js +33 -113
  339. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +18 -3
  340. package/sdk/public/Webhook/WebhookPublicValidator.js +14 -4
  341. package/sdk/public/index.d.ts +1 -0
  342. package/sdk/public/index.js +2 -0
  343. package/sdk/application/ApplicationModels.d.ts +0 -3
  344. package/sdk/application/ApplicationModels.js +0 -20
  345. package/sdk/platform/Partner/PartnerPlatformClient.d.ts +0 -145
  346. package/sdk/platform/Partner/PartnerPlatformClient.js +0 -799
  347. package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +0 -14
  348. package/sdk/platform/Partner/PartnerPlatformValidator.js +0 -87
@@ -1,176 +1,3840 @@
1
- export = CartModel;
2
- declare class CartModel {
3
- static AbandonedCart(): any;
4
- static AbandonedCartResponse(): any;
5
- static ActionQuery(): any;
6
- static ActivePromosResponse(): any;
7
- static AddCartDetailResponse(): any;
8
- static AddCartRequest(): any;
9
- static AddProductCart(): any;
10
- static AppliedFreeArticles(): any;
11
- static AppliedPromotion(): any;
12
- static ApplyCouponRequest(): any;
13
- static Article(): any;
14
- static ArticlePriceInfo(): any;
15
- static BaseInfo(): any;
16
- static BasePrice(): any;
17
- static BulkBundleRestriction(): any;
18
- static BuyRules(): any;
19
- static CartBreakup(): any;
20
- static CartCheckoutResponse(): any;
21
- static CartCurrency(): any;
22
- static CartDeliveryModesResponse(): any;
23
- static CartDetailResponse(): any;
24
- static CartItem(): any;
25
- static CartItemCountResponse(): any;
26
- static CartItemMeta(): any;
27
- static CartList(): any;
28
- static CartMetaConfigAdd(): any;
29
- static CartMetaConfigUpdate(): any;
30
- static CartMetaMissingResponse(): any;
31
- static CartMetaResponse(): any;
32
- static CartProduct(): any;
33
- static CartProductIdentifer(): any;
34
- static CartProductInfo(): any;
35
- static CategoryInfo(): any;
36
- static Charges(): any;
37
- static CheckCart(): any;
38
- static Collection(): any;
39
- static CompareObject(): any;
40
- static Coupon(): any;
41
- static CouponAction(): any;
42
- static CouponAdd(): any;
43
- static CouponAuthor(): any;
44
- static CouponBreakup(): any;
45
- static CouponDateMeta(): any;
46
- static CouponDetails(): any;
47
- static CouponPartialUpdate(): any;
48
- static CouponSchedule(): any;
49
- static CouponsResponse(): any;
50
- static CouponUpdate(): any;
51
- static CouponValidity(): any;
52
- static DeleteAddressResponse(): any;
53
- static DeleteCartDetailResponse(): any;
54
- static DeleteCartRequest(): any;
55
- static DeliveryCharges(): any;
56
- static DiscountOffer(): any;
57
- static DiscountRule(): any;
58
- static DiscountRulesApp(): any;
59
- static DisplayBreakup(): any;
60
- static DisplayMeta(): any;
61
- static DisplayMeta1(): any;
62
- static DisplayMetaDict(): any;
63
- static Files(): any;
64
- static FreeGiftItem(): any;
65
- static GeoLocation(): any;
66
- static GetCouponResponse(): any;
67
- static GetShareCartLinkRequest(): any;
68
- static GetShareCartLinkResponse(): any;
69
- static Identifier(): any;
70
- static ItemCriteria(): any;
71
- static LoyaltyPoints(): any;
72
- static MultiCartResponse(): any;
73
- static MultiTenderPaymentMeta(): any;
74
- static MultiTenderPaymentMethod(): any;
75
- static OpenapiCartDetailsRequest(): any;
76
- static OpenapiCartDetailsResponse(): any;
77
- static OpenApiCartServiceabilityRequest(): any;
78
- static OpenApiCartServiceabilityResponse(): any;
79
- static OpenApiCheckoutResponse(): any;
80
- static OpenApiErrorResponse(): any;
81
- static OpenApiFiles(): any;
82
- static OpenApiOrderItem(): any;
83
- static OpenApiPlatformCheckoutReq(): any;
84
- static OperationErrorResponse(): any;
85
- static OverrideCartItem(): any;
86
- static OverrideCartItemPromo(): any;
87
- static OverrideCheckoutReq(): any;
88
- static OverrideCheckoutResponse(): any;
89
- static Ownership(): any;
90
- static Ownership1(): any;
91
- static Ownership2(): any;
92
- static Page(): any;
93
- static PageCoupon(): any;
94
- static PaymentAllowValue(): any;
95
- static PaymentAllowValue1(): any;
96
- static PaymentCouponValidate(): any;
97
- static PaymentMeta(): any;
98
- static PaymentMethod(): any;
99
- static PaymentModes(): any;
100
- static PaymentSelectionLock(): any;
101
- static PickupStoreDetail(): any;
102
- static PlatformAddCartRequest(): any;
103
- static PlatformAddress(): any;
104
- static PlatformCartCheckoutDetailRequest(): any;
105
- static PlatformCartCheckoutDetailV2Request(): any;
106
- static PlatformCartMetaRequest(): any;
107
- static PlatformCartShipmentsResponse(): any;
108
- static PlatformGetAddressesResponse(): any;
109
- static PlatformSelectCartAddressRequest(): any;
110
- static PlatformShipmentResponse(): any;
111
- static PlatformUpdateCartRequest(): any;
112
- static PostOrder(): any;
113
- static PostOrder1(): any;
114
- static PriceAdjustment(): any;
115
- static PriceAdjustmentAdd(): any;
116
- static PriceAdjustmentResponse(): any;
117
- static PriceAdjustmentUpdate(): any;
118
- static PriceRange(): any;
119
- static ProductAction(): any;
120
- static ProductArticle(): any;
121
- static ProductAvailability(): any;
122
- static ProductAvailabilitySize(): any;
123
- static ProductImage(): any;
124
- static ProductPrice(): any;
125
- static ProductPriceInfo(): any;
126
- static PromiseFormatted(): any;
127
- static PromiseTimestamp(): any;
128
- static PromoMeta(): any;
129
- static PromotionAction(): any;
130
- static PromotionAdd(): any;
131
- static PromotionAuthor(): any;
132
- static PromotionDateMeta(): any;
133
- static PromotionListItem(): any;
134
- static PromotionPartialUpdate(): any;
135
- static PromotionPaymentModes(): any;
136
- static PromotionSchedule(): any;
137
- static PromotionsResponse(): any;
138
- static PromotionUpdate(): any;
139
- static RawBreakup(): any;
140
- static Restrictions(): any;
141
- static Restrictions1(): any;
142
- static Rule(): any;
143
- static RuleDefinition(): any;
144
- static SaveAddressResponse(): any;
145
- static SharedCart(): any;
146
- static SharedCartDetails(): any;
147
- static SharedCartResponse(): any;
148
- static ShipmentArticle(): any;
149
- static ShipmentPromise(): any;
150
- static ShippingAddress(): any;
151
- static StaffCheckout(): any;
152
- static State(): any;
153
- static StoreDetailsResponse(): any;
154
- static StoreInfo(): any;
155
- static SuccessMessage(): any;
156
- static Tags(): any;
157
- static UpdateAddressResponse(): any;
158
- static UpdateCartDetailResponse(): any;
159
- static UpdateCartPaymentRequest(): any;
160
- static UpdateCartPaymentRequestV2(): any;
161
- static UpdateCartRequest(): any;
162
- static UpdateCartShipmentItem(): any;
163
- static UpdateCartShipmentRequest(): any;
164
- static UpdateProductCart(): any;
165
- static UpdateUserCartMapping(): any;
166
- static UserCartMappingResponse(): any;
167
- static UserInfo(): any;
168
- static UserRegistered(): any;
169
- static UsesRemaining(): any;
170
- static UsesRemaining1(): any;
171
- static UsesRestriction(): any;
172
- static UsesRestriction1(): any;
173
- static Validation(): any;
174
- static Validity(): any;
175
- static Visibility(): any;
1
+ export = CartPlatformModel;
2
+ /**
3
+ * @typedef AbandonedCart
4
+ * @property {string} _id
5
+ * @property {string} [app_id]
6
+ * @property {Object[]} articles
7
+ * @property {number} [bulk_coupon_discount]
8
+ * @property {boolean} [buy_now]
9
+ * @property {number} [cart_value]
10
+ * @property {Object} cashback
11
+ * @property {string} [checkout_mode]
12
+ * @property {Object} [cod_charges]
13
+ * @property {string} [comment]
14
+ * @property {Object} [coupon]
15
+ * @property {string} created_on
16
+ * @property {Object} [delivery_charges]
17
+ * @property {number} [discount]
18
+ * @property {string} expire_at
19
+ * @property {number[]} [fc_index_map]
20
+ * @property {Object} [fynd_credits]
21
+ * @property {string} [gstin]
22
+ * @property {boolean} [is_active]
23
+ * @property {boolean} [is_archive]
24
+ * @property {boolean} is_default
25
+ * @property {string} last_modified
26
+ * @property {boolean} [merge_qty]
27
+ * @property {Object} [meta]
28
+ * @property {string} [order_id]
29
+ * @property {Object[]} [payment_methods]
30
+ * @property {string} [payment_mode]
31
+ * @property {Object} [payments]
32
+ * @property {Object} [pick_up_customer_details]
33
+ * @property {Object} [promotion]
34
+ * @property {Object[]} [shipments]
35
+ * @property {number} uid
36
+ * @property {string} user_id
37
+ */
38
+ /**
39
+ * @typedef AbandonedCartResponse
40
+ * @property {AbandonedCart[]} [items]
41
+ * @property {string} [message] - Message of the response
42
+ * @property {Page} [page]
43
+ * @property {Object} [result]
44
+ * @property {boolean} [success] - The request success is defined
45
+ */
46
+ /**
47
+ * @typedef ActionQuery
48
+ * @property {string[]} [product_slug] - Contains list of product slug
49
+ */
50
+ /**
51
+ * @typedef ActivePromosResponse
52
+ * @property {string} [created_on] - Coupon creation date
53
+ * @property {string} [description] - The description of the offer in the form of an HTML
54
+ * @property {string} [entity_slug]
55
+ * @property {string} [entity_type] - Type of entity to be selected from :
56
+ * ['coupon', 'promotion']
57
+ * @property {string} [example] - Discount offers examples
58
+ * @property {boolean} [is_hidden] - If the promo is active or not
59
+ * @property {string} [modified_on] - Coupon modification date
60
+ * @property {string} [subtitle] - Small description of the current offer
61
+ * @property {string} [title] - Name of the promotion
62
+ * @property {string} [type] - Coupon type
63
+ */
64
+ /**
65
+ * @typedef AddCartDetailResponse
66
+ * @property {CartDetailResponse} [cart]
67
+ * @property {string} [message]
68
+ * @property {boolean} [partial] - When adding multiple items check if all
69
+ * added. True if only few are added.
70
+ * @property {boolean} [success] - True if all items are added successfully.
71
+ * False if partially added or not added.
72
+ */
73
+ /**
74
+ * @typedef AddCartRequest
75
+ * @property {AddProductCart[]} [items]
76
+ * @property {boolean} [new_cart]
77
+ */
78
+ /**
79
+ * @typedef AddProductCart
80
+ * @property {Object} [_custom_json]
81
+ * @property {Object} [article_assignment]
82
+ * @property {string} [article_id]
83
+ * @property {string} [display]
84
+ * @property {Object} [extra_meta]
85
+ * @property {number} [item_id]
86
+ * @property {string} [item_size]
87
+ * @property {Object} [meta]
88
+ * @property {Object[]} [parent_item_identifiers]
89
+ * @property {boolean} [pos]
90
+ * @property {string[]} [product_group_tags]
91
+ * @property {number} [quantity]
92
+ * @property {number} [seller_id]
93
+ * @property {number} [store_id]
94
+ */
95
+ /**
96
+ * @typedef AppliedFreeArticles
97
+ * @property {string} [article_id] - Free article id
98
+ * @property {FreeGiftItem} [free_gift_item_details] - Free gift items details
99
+ * @property {string} [parent_item_identifier] - Parent item identifier for free article
100
+ * @property {number} [quantity] - Free article quantity
101
+ */
102
+ /**
103
+ * @typedef AppliedPromotion
104
+ * @property {number} [amount] - Per unit discount amount applied with current promotion
105
+ * @property {AppliedFreeArticles[]} [applied_free_articles] - Applied free
106
+ * article for free gift item promotions
107
+ * @property {number} [article_quantity] - Quantity of article on which
108
+ * promotion is applicable
109
+ * @property {BuyRules[]} [buy_rules] - Buy rules for promotions
110
+ * @property {DiscountRulesApp[]} [discount_rules] - Discount rules for promotions
111
+ * @property {boolean} [mrp_promotion] - If applied promotion is applied on
112
+ * product MRP or ESP
113
+ * @property {string} [offer_text] - Offer text of current promotion
114
+ * @property {Ownership2} [ownership] - Ownership of promotion
115
+ * @property {string} [promo_id] - Promotion id
116
+ * @property {string} [promotion_group] - Promotion group for the promotion
117
+ * @property {string} [promotion_name] - Promotion name of current promotion
118
+ * @property {string} [promotion_type] - Promotion type of current promotion
119
+ */
120
+ /**
121
+ * @typedef ApplyCouponRequest
122
+ * @property {string} coupon_code - Coupon code to be applied
123
+ */
124
+ /**
125
+ * @typedef Article
126
+ * @property {string} article_id - Id of article
127
+ * @property {string} [code] - Code to identify price adjustment on article
128
+ * @property {Object} [meta] - Meta related to article
129
+ * @property {number} [quantity] - Total quantity of the article to be
130
+ * considered (currently used only in discount type)
131
+ * @property {string} [type] - Type of price adjusment
132
+ * @property {number} [value] - Value of price adjustment for article
133
+ */
134
+ /**
135
+ * @typedef ArticlePriceInfo
136
+ * @property {BasePrice} [base]
137
+ * @property {BasePrice} [converted]
138
+ */
139
+ /**
140
+ * @typedef BaseInfo
141
+ * @property {string} [name]
142
+ * @property {number} [uid]
143
+ */
144
+ /**
145
+ * @typedef BasePrice
146
+ * @property {string} [currency_code]
147
+ * @property {string} [currency_symbol]
148
+ * @property {number} [effective]
149
+ * @property {number} [marked]
150
+ */
151
+ /**
152
+ * @typedef BulkBundleRestriction
153
+ * @property {boolean} multi_store_allowed
154
+ */
155
+ /**
156
+ * @typedef BuyRules
157
+ * @property {Object} [cart_conditions] - Cart conditions details for promotion
158
+ * @property {Object} [item_criteria] - Item criteria of promotion
159
+ */
160
+ /**
161
+ * @typedef CartBreakup
162
+ * @property {CouponBreakup} [coupon]
163
+ * @property {DisplayBreakup[]} [display]
164
+ * @property {LoyaltyPoints} [loyalty_points]
165
+ * @property {RawBreakup} [raw]
166
+ */
167
+ /**
168
+ * @typedef CartCheckoutCustomMeta
169
+ * @property {string} key
170
+ * @property {string} value
171
+ */
172
+ /**
173
+ * @typedef CartCheckoutResponse
174
+ * @property {string} [app_intercept_url]
175
+ * @property {string} [callback_url]
176
+ * @property {CheckCart} [cart]
177
+ * @property {Object} [data]
178
+ * @property {string} [message]
179
+ * @property {string} [order_id]
180
+ * @property {string} [payment_confirm_url]
181
+ * @property {boolean} [success]
182
+ */
183
+ /**
184
+ * @typedef CartCurrency
185
+ * @property {string} [code] - Currency code defined by ISO 4217:2015
186
+ * @property {string} [symbol]
187
+ */
188
+ /**
189
+ * @typedef CartDeliveryModesResponse
190
+ * @property {string[]} [available_modes] - Available delivery modes
191
+ * @property {number[]} [pickup_stores] - Store pick up available store uids
192
+ */
193
+ /**
194
+ * @typedef CartDetailResponse
195
+ * @property {AppliedPromotion[]} [applied_promo_details]
196
+ * @property {CartBreakup} [breakup_values]
197
+ * @property {boolean} [buy_now]
198
+ * @property {string} [checkout_mode]
199
+ * @property {string} [comment]
200
+ * @property {string} [coupon_text]
201
+ * @property {CartCurrency} [currency]
202
+ * @property {string} [delivery_charge_info]
203
+ * @property {ShipmentPromise} [delivery_promise]
204
+ * @property {string} [gstin]
205
+ * @property {string} [id]
206
+ * @property {boolean} [is_valid]
207
+ * @property {CartProductInfo[]} [items]
208
+ * @property {string} [last_modified]
209
+ * @property {string} [message]
210
+ * @property {Object} [pan_config]
211
+ * @property {string} [pan_no]
212
+ * @property {PaymentSelectionLock} [payment_selection_lock]
213
+ * @property {boolean} [restrict_checkout]
214
+ */
215
+ /**
216
+ * @typedef CartItem
217
+ * @property {string} product_id
218
+ * @property {number} [quantity]
219
+ * @property {string} size
220
+ */
221
+ /**
222
+ * @typedef CartItemCountResponse
223
+ * @property {number} [user_cart_items_count] - Item count present in cart
224
+ */
225
+ /**
226
+ * @typedef CartItemMeta
227
+ * @property {string} [group_id]
228
+ * @property {boolean} [primary_item]
229
+ */
230
+ /**
231
+ * @typedef CartList
232
+ * @property {string} [cart_id]
233
+ * @property {number} [cart_value]
234
+ * @property {string} [created_on]
235
+ * @property {number} [item_counts]
236
+ * @property {Object} [pick_up_customer_details]
237
+ * @property {string} [user_id]
238
+ */
239
+ /**
240
+ * @typedef CartMetaConfigAdd
241
+ * @property {boolean} [bulk_coupons]
242
+ * @property {DeliveryCharges} [delivery_charges]
243
+ * @property {boolean} [enabled]
244
+ * @property {string} [gift_display_text]
245
+ * @property {number} [gift_pricing]
246
+ * @property {number} [max_cart_items]
247
+ * @property {number} [min_cart_value]
248
+ * @property {boolean} [revenue_engine_coupon]
249
+ */
250
+ /**
251
+ * @typedef CartMetaConfigUpdate
252
+ * @property {boolean} [bulk_coupons]
253
+ * @property {DeliveryCharges} [delivery_charges]
254
+ * @property {boolean} [enabled]
255
+ * @property {string} [gift_display_text]
256
+ * @property {number} [gift_pricing]
257
+ * @property {number} [max_cart_items]
258
+ * @property {number} [min_cart_value]
259
+ * @property {boolean} [revenue_engine_coupon]
260
+ */
261
+ /**
262
+ * @typedef CartMetaMissingResponse
263
+ * @property {string[]} [errors]
264
+ */
265
+ /**
266
+ * @typedef CartMetaResponse
267
+ * @property {boolean} [is_valid]
268
+ * @property {string} [message]
269
+ */
270
+ /**
271
+ * @typedef CartProduct
272
+ * @property {Object} [_custom_json]
273
+ * @property {ProductAction} [action]
274
+ * @property {BaseInfo} [brand]
275
+ * @property {CategoryInfo[]} [categories]
276
+ * @property {ProductImage[]} [images]
277
+ * @property {string} [item_code]
278
+ * @property {string} [name]
279
+ * @property {string} [slug] - Unique product url name generated via product
280
+ * name and other meta data
281
+ * @property {string[]} [tags]
282
+ * @property {Tags} [teaser_tag]
283
+ * @property {string} [type]
284
+ * @property {number} [uid]
285
+ */
286
+ /**
287
+ * @typedef CartProductIdentifer
288
+ * @property {string} [identifier] - Article idenfier generated by cart
289
+ */
290
+ /**
291
+ * @typedef CartProductInfo
292
+ * @property {ProductArticle} [article]
293
+ * @property {ProductAvailability} [availability]
294
+ * @property {Object} [bulk_offer]
295
+ * @property {CouponDetails} [coupon]
296
+ * @property {string} [coupon_message]
297
+ * @property {Object} [custom_order]
298
+ * @property {ShipmentPromise} [delivery_promise]
299
+ * @property {string} [discount]
300
+ * @property {CartProductIdentifer} identifiers
301
+ * @property {boolean} [is_set]
302
+ * @property {string} [key]
303
+ * @property {string} [message]
304
+ * @property {Object} [moq]
305
+ * @property {Object} [parent_item_identifiers]
306
+ * @property {ProductPriceInfo} [price]
307
+ * @property {ProductPriceInfo} [price_per_unit]
308
+ * @property {CartProduct} [product]
309
+ * @property {PromoMeta} [promo_meta]
310
+ * @property {AppliedPromotion[]} [promotions_applied]
311
+ * @property {number} [quantity]
312
+ */
313
+ /**
314
+ * @typedef CategoryInfo
315
+ * @property {string} [name]
316
+ * @property {number} [uid] - Product Category Id
317
+ */
318
+ /**
319
+ * @typedef Charges
320
+ * @property {number} [charges]
321
+ * @property {number} [threshold]
322
+ */
323
+ /**
324
+ * @typedef CheckCart
325
+ * @property {CartBreakup} [breakup_values]
326
+ * @property {boolean} [buy_now]
327
+ * @property {number} [cart_id]
328
+ * @property {string} [checkout_mode]
329
+ * @property {boolean} [cod_available]
330
+ * @property {number} [cod_charges]
331
+ * @property {string} [cod_message]
332
+ * @property {string} [comment]
333
+ * @property {string} [coupon_text]
334
+ * @property {CartCurrency} [currency]
335
+ * @property {string} [delivery_charge_info]
336
+ * @property {number} [delivery_charge_order_value]
337
+ * @property {number} [delivery_charges]
338
+ * @property {ShipmentPromise} [delivery_promise]
339
+ * @property {string} [error_message]
340
+ * @property {string} [gstin]
341
+ * @property {string} [id]
342
+ * @property {boolean} [is_valid]
343
+ * @property {CartProductInfo[]} [items]
344
+ * @property {string} [last_modified]
345
+ * @property {string} [message]
346
+ * @property {string} [order_id]
347
+ * @property {PaymentSelectionLock} [payment_selection_lock]
348
+ * @property {boolean} [restrict_checkout]
349
+ * @property {string} [store_code]
350
+ * @property {Object[]} [store_emps]
351
+ * @property {boolean} [success]
352
+ * @property {string} [uid]
353
+ * @property {string} [user_type]
354
+ */
355
+ /**
356
+ * @typedef Collection
357
+ * @property {string} collected_by
358
+ * @property {string} refund_by
359
+ */
360
+ /**
361
+ * @typedef CompareObject
362
+ * @property {number} [equals]
363
+ * @property {number} [greater_than]
364
+ * @property {number} [greater_than_equals]
365
+ * @property {number} [less_than]
366
+ * @property {number} [less_than_equals]
367
+ */
368
+ /**
369
+ * @typedef Coupon
370
+ * @property {string} [coupon_code]
371
+ * @property {string} [coupon_type]
372
+ * @property {number} [coupon_value]
373
+ * @property {string} [description]
374
+ * @property {string} [expires_on]
375
+ * @property {boolean} [is_applicable]
376
+ * @property {boolean} [is_applied]
377
+ * @property {number} [max_discount_value]
378
+ * @property {string} [message]
379
+ * @property {number} [minimum_cart_value]
380
+ * @property {string} [sub_title]
381
+ * @property {string} [title]
382
+ */
383
+ /**
384
+ * @typedef CouponAction
385
+ * @property {string} [action_date]
386
+ * @property {string} [txn_mode]
387
+ */
388
+ /**
389
+ * @typedef CouponAdd
390
+ * @property {CouponSchedule} [_schedule]
391
+ * @property {CouponAction} [action]
392
+ * @property {CouponAuthor} [author]
393
+ * @property {string} code
394
+ * @property {CouponDateMeta} [date_meta]
395
+ * @property {DisplayMeta} display_meta
396
+ * @property {Identifier} identifiers
397
+ * @property {Ownership} ownership
398
+ * @property {Restrictions} [restrictions]
399
+ * @property {Rule[]} rule
400
+ * @property {RuleDefinition} rule_definition
401
+ * @property {State} [state]
402
+ * @property {string[]} [tags]
403
+ * @property {string} type_slug
404
+ * @property {Validation} [validation]
405
+ * @property {Validity} validity
406
+ */
407
+ /**
408
+ * @typedef CouponAuthor
409
+ * @property {string} [created_by]
410
+ * @property {string} [modified_by]
411
+ */
412
+ /**
413
+ * @typedef CouponBreakup
414
+ * @property {string} [code]
415
+ * @property {string} [coupon_type]
416
+ * @property {number} [coupon_value]
417
+ * @property {string} [description]
418
+ * @property {boolean} [is_applied]
419
+ * @property {number} [max_discount_value]
420
+ * @property {string} [message]
421
+ * @property {number} [minimum_cart_value]
422
+ * @property {string} [sub_title]
423
+ * @property {string} [title]
424
+ * @property {string} [type]
425
+ * @property {string} [uid]
426
+ * @property {number} [value]
427
+ */
428
+ /**
429
+ * @typedef CouponDateMeta
430
+ * @property {string} [created_on]
431
+ * @property {string} [modified_on]
432
+ */
433
+ /**
434
+ * @typedef CouponDetails
435
+ * @property {string} [code]
436
+ * @property {number} [discount_single_quantity]
437
+ * @property {number} [discount_total_quantity]
438
+ */
439
+ /**
440
+ * @typedef CouponPartialUpdate
441
+ * @property {boolean} [archive] - Send true to unpublish coupon
442
+ * @property {CouponSchedule} [schedule]
443
+ */
444
+ /**
445
+ * @typedef CouponSchedule
446
+ * @property {string} [cron]
447
+ * @property {number} [duration]
448
+ * @property {string} [end]
449
+ * @property {Object[]} [next_schedule]
450
+ * @property {string} [start]
451
+ */
452
+ /**
453
+ * @typedef CouponsResponse
454
+ * @property {CouponAdd} [items]
455
+ * @property {Page} [page]
456
+ */
457
+ /**
458
+ * @typedef CouponUpdate
459
+ * @property {CouponSchedule} [_schedule]
460
+ * @property {CouponAction} [action]
461
+ * @property {CouponAuthor} [author]
462
+ * @property {string} code
463
+ * @property {CouponDateMeta} [date_meta]
464
+ * @property {DisplayMeta} display_meta
465
+ * @property {Identifier} identifiers
466
+ * @property {Ownership} ownership
467
+ * @property {Restrictions} [restrictions]
468
+ * @property {Rule[]} rule
469
+ * @property {RuleDefinition} rule_definition
470
+ * @property {State} [state]
471
+ * @property {string[]} [tags]
472
+ * @property {string} type_slug
473
+ * @property {Validation} [validation]
474
+ * @property {Validity} validity
475
+ */
476
+ /**
477
+ * @typedef CouponValidity
478
+ * @property {string} [code]
479
+ * @property {number} [discount]
480
+ * @property {string} [display_message_en]
481
+ * @property {boolean} [next_validation_required]
482
+ * @property {string} [title]
483
+ * @property {boolean} [valid]
484
+ */
485
+ /**
486
+ * @typedef CustomerDetails
487
+ * @property {string} [email]
488
+ * @property {string} mobile
489
+ * @property {string} [name]
490
+ */
491
+ /**
492
+ * @typedef DeleteAddressResponse
493
+ * @property {string} [id]
494
+ * @property {boolean} [is_deleted]
495
+ */
496
+ /**
497
+ * @typedef DeleteCartDetailResponse
498
+ * @property {string} [message]
499
+ * @property {boolean} [success] - True if cart is archived successfully. False
500
+ * if not archived.
501
+ */
502
+ /**
503
+ * @typedef DeleteCartRequest
504
+ * @property {string[]} [cart_id_list]
505
+ */
506
+ /**
507
+ * @typedef DeliveryCharges
508
+ * @property {Charges[]} [charges]
509
+ * @property {boolean} [enabled]
510
+ */
511
+ /**
512
+ * @typedef DiscountOffer
513
+ * @property {boolean} [apportion_discount]
514
+ * @property {string} [code]
515
+ * @property {number} [discount_amount]
516
+ * @property {number} [discount_percentage]
517
+ * @property {number} [discount_price]
518
+ * @property {number} [max_discount_amount]
519
+ * @property {number} [max_offer_quantity]
520
+ * @property {number} [max_usage_per_transaction]
521
+ * @property {number} [min_offer_quantity]
522
+ * @property {boolean} [partial_can_ret]
523
+ */
524
+ /**
525
+ * @typedef DiscountRule
526
+ * @property {string} buy_condition
527
+ * @property {string} discount_type
528
+ * @property {ItemCriteria} item_criteria
529
+ * @property {DiscountOffer} offer
530
+ */
531
+ /**
532
+ * @typedef DiscountRulesApp
533
+ * @property {Object} [item_criteria] - Item criteria of promotion
534
+ * @property {string[]} [matched_buy_rules] - Matched buy rules for promotion
535
+ * @property {Object} [offer] - Offer for promotion
536
+ * @property {Object} [raw_offer] - Raw offer details for promotion
537
+ */
538
+ /**
539
+ * @typedef DisplayBreakup
540
+ * @property {string} [currency_code]
541
+ * @property {string} [currency_symbol]
542
+ * @property {string} [display]
543
+ * @property {string} [key]
544
+ * @property {string[]} [message]
545
+ * @property {number} [value]
546
+ */
547
+ /**
548
+ * @typedef DisplayMeta
549
+ * @property {DisplayMetaDict} [apply]
550
+ * @property {DisplayMetaDict} [auto]
551
+ * @property {string} [description]
552
+ * @property {DisplayMetaDict} [remove]
553
+ * @property {string} [subtitle]
554
+ * @property {string} [title]
555
+ */
556
+ /**
557
+ * @typedef DisplayMeta1
558
+ * @property {string} [description]
559
+ * @property {string} [name]
560
+ * @property {string} [offer_label]
561
+ * @property {string} [offer_text]
562
+ */
563
+ /**
564
+ * @typedef DisplayMetaDict
565
+ * @property {string} [subtitle]
566
+ * @property {string} [title]
567
+ */
568
+ /**
569
+ * @typedef Files
570
+ * @property {string} key
571
+ * @property {string[]} values
572
+ */
573
+ /**
574
+ * @typedef FreeGiftItem
575
+ * @property {string} [item_brand_name] - Item brand name
576
+ * @property {number} [item_id] - Item id
577
+ * @property {string[]} [item_images_url] - Item images URL
578
+ * @property {string} [item_name] - Item name
579
+ * @property {Object} [item_price_details] - Item price details
580
+ * @property {string} [item_slug] - Item slug
581
+ */
582
+ /**
583
+ * @typedef GeoLocation
584
+ * @property {number} [latitude]
585
+ * @property {number} [longitude]
586
+ */
587
+ /**
588
+ * @typedef GetCouponResponse
589
+ * @property {Coupon[]} [available_coupon_list]
590
+ * @property {PageCoupon} [page]
591
+ */
592
+ /**
593
+ * @typedef GetShareCartLinkRequest
594
+ * @property {string} [id] - Cart uid for generating sharing
595
+ * @property {Object} [meta] - Staff, Ordering store or any other data. This
596
+ * data will be used to generate link as well as sent as shared details.
597
+ */
598
+ /**
599
+ * @typedef GetShareCartLinkResponse
600
+ * @property {string} [share_url] - Short shareable final url
601
+ * @property {string} [token] - Short url unique id
602
+ */
603
+ /**
604
+ * @typedef Identifier
605
+ * @property {string[]} [article_id]
606
+ * @property {number[]} [brand_id]
607
+ * @property {number[]} [category_id]
608
+ * @property {string[]} [collection_id]
609
+ * @property {number[]} [company_id]
610
+ * @property {string[]} [email_domain]
611
+ * @property {number[]} [exclude_brand_id]
612
+ * @property {number[]} [item_id]
613
+ * @property {number[]} [store_id]
614
+ * @property {string[]} [user_id]
615
+ */
616
+ /**
617
+ * @typedef ItemCriteria
618
+ * @property {boolean} [all_items]
619
+ * @property {string[]} [available_zones]
620
+ * @property {string[]} [buy_rules]
621
+ * @property {CompareObject} [cart_quantity]
622
+ * @property {CompareObject} [cart_total]
623
+ * @property {CompareObject} [cart_unique_item_amount]
624
+ * @property {CompareObject} [cart_unique_item_quantity]
625
+ * @property {number[]} [item_brand]
626
+ * @property {number[]} [item_category]
627
+ * @property {number[]} [item_company]
628
+ * @property {number[]} [item_department]
629
+ * @property {number[]} [item_exclude_brand]
630
+ * @property {number[]} [item_exclude_category]
631
+ * @property {number[]} [item_exclude_company]
632
+ * @property {number[]} [item_exclude_department]
633
+ * @property {number[]} [item_exclude_id]
634
+ * @property {number[]} [item_exclude_l1_category]
635
+ * @property {number[]} [item_exclude_l2_category]
636
+ * @property {string[]} [item_exclude_sku]
637
+ * @property {number[]} [item_exclude_store]
638
+ * @property {number[]} [item_id]
639
+ * @property {number[]} [item_l1_category]
640
+ * @property {number[]} [item_l2_category]
641
+ * @property {string[]} [item_size]
642
+ * @property {string[]} [item_sku]
643
+ * @property {number[]} [item_store]
644
+ * @property {string[]} [item_tags]
645
+ */
646
+ /**
647
+ * @typedef LoyaltyPoints
648
+ * @property {number} [applicable]
649
+ * @property {string} [description]
650
+ * @property {boolean} [is_applied]
651
+ * @property {number} [total]
652
+ */
653
+ /**
654
+ * @typedef MultiCartResponse
655
+ * @property {CartList[]} [data]
656
+ * @property {boolean} [success]
657
+ */
658
+ /**
659
+ * @typedef MultiTenderPaymentMeta
660
+ * @property {string} [current_status]
661
+ * @property {Object} [extra_meta]
662
+ * @property {string} [order_id]
663
+ * @property {string} [payment_gateway]
664
+ * @property {string} [payment_id]
665
+ */
666
+ /**
667
+ * @typedef MultiTenderPaymentMethod
668
+ * @property {number} amount - Payment amount
669
+ * @property {MultiTenderPaymentMeta} [meta]
670
+ * @property {string} mode
671
+ * @property {string} [name] - Payment mode name
672
+ */
673
+ /**
674
+ * @typedef OpenapiCartDetailsRequest
675
+ * @property {CartItem[]} cart_items
676
+ */
677
+ /**
678
+ * @typedef OpenapiCartDetailsResponse
679
+ * @property {CartBreakup} [breakup_values]
680
+ * @property {boolean} [is_valid]
681
+ * @property {CartProductInfo[]} [items]
682
+ * @property {string} [message]
683
+ */
684
+ /**
685
+ * @typedef OpenApiCartServiceabilityRequest
686
+ * @property {CartItem[]} cart_items
687
+ * @property {ShippingAddress} shipping_address
688
+ */
689
+ /**
690
+ * @typedef OpenApiCartServiceabilityResponse
691
+ * @property {CartBreakup} [breakup_values]
692
+ * @property {ShipmentPromise} [delivery_promise]
693
+ * @property {boolean} [is_valid]
694
+ * @property {CartProductInfo[]} [items]
695
+ * @property {string} [message]
696
+ */
697
+ /**
698
+ * @typedef OpenApiCheckoutResponse
699
+ * @property {string} [message]
700
+ * @property {string} order_id - Fynd order id
701
+ * @property {string} [order_ref_id] - Order id sent in request
702
+ * @property {boolean} [success]
703
+ */
704
+ /**
705
+ * @typedef OpenApiErrorResponse
706
+ * @property {Object} [errors] - Contains field name which has error as key and
707
+ * error message as value
708
+ * @property {string} [message]
709
+ * @property {boolean} [success]
710
+ */
711
+ /**
712
+ * @typedef OpenApiFiles
713
+ * @property {string} key
714
+ * @property {string[]} values
715
+ */
716
+ /**
717
+ * @typedef OpenApiOrderItem
718
+ * @property {number} amount_paid
719
+ * @property {number} cashback_applied
720
+ * @property {number} cod_charges
721
+ * @property {number} coupon_effective_discount
722
+ * @property {number} delivery_charges
723
+ * @property {number} discount
724
+ * @property {number} [employee_discount]
725
+ * @property {Object} [extra_meta]
726
+ * @property {OpenApiFiles[]} [files]
727
+ * @property {number} [loyalty_discount]
728
+ * @property {CartItemMeta} [meta]
729
+ * @property {MultiTenderPaymentMethod[]} payment_methods
730
+ * @property {number} price_effective
731
+ * @property {number} price_marked
732
+ * @property {number} product_id
733
+ * @property {number} [quantity]
734
+ * @property {string} size
735
+ */
736
+ /**
737
+ * @typedef OpenApiPlatformCheckoutReq
738
+ * @property {string} [affiliate_order_id]
739
+ * @property {ShippingAddress} billing_address
740
+ * @property {OpenApiOrderItem[]} cart_items
741
+ * @property {number} cart_value
742
+ * @property {number} cashback_applied
743
+ * @property {number} cod_charges
744
+ * @property {string} [comment]
745
+ * @property {string} [coupon]
746
+ * @property {string} coupon_code
747
+ * @property {number} coupon_value
748
+ * @property {string} [currency_code]
749
+ * @property {number} delivery_charges
750
+ * @property {Object} [employee_discount]
751
+ * @property {OpenApiFiles[]} [files]
752
+ * @property {string} [gstin]
753
+ * @property {number} [loyalty_discount]
754
+ * @property {string} [order_id]
755
+ * @property {MultiTenderPaymentMethod[]} payment_methods
756
+ * @property {string} [payment_mode]
757
+ * @property {ShippingAddress} [shipping_address]
758
+ */
759
+ /**
760
+ * @typedef OperationErrorResponse
761
+ * @property {string} [message]
762
+ * @property {boolean} [success]
763
+ */
764
+ /**
765
+ * @typedef OverrideCartItem
766
+ * @property {number} amount_paid
767
+ * @property {number} discount
768
+ * @property {Object} [extra_meta]
769
+ * @property {number} item_id
770
+ * @property {number} price_effective
771
+ * @property {number} price_marked
772
+ * @property {OverrideCartItemPromo[]} [promo_list]
773
+ * @property {number} [quantity]
774
+ * @property {string} [seller_identifier]
775
+ * @property {string} size
776
+ */
777
+ /**
778
+ * @typedef OverrideCartItemPromo
779
+ * @property {Object[]} [item_list]
780
+ * @property {string} promo_amount
781
+ * @property {string} [promo_desc]
782
+ * @property {string} promo_id
783
+ * @property {string} [rwrd_tndr]
784
+ */
785
+ /**
786
+ * @typedef OverrideCheckoutReq
787
+ * @property {string} aggregator
788
+ * @property {Object} [billing_address]
789
+ * @property {string} cart_id
790
+ * @property {OverrideCartItem[]} cart_items
791
+ * @property {string} currency_code
792
+ * @property {string} merchant_code
793
+ * @property {string} order_type
794
+ * @property {number} [ordering_store]
795
+ * @property {string} payment_identifier
796
+ * @property {string} payment_mode
797
+ * @property {Object} [shipping_address]
798
+ */
799
+ /**
800
+ * @typedef OverrideCheckoutResponse
801
+ * @property {Object} cart
802
+ * @property {Object} data
803
+ * @property {string} message
804
+ * @property {string} order_id
805
+ * @property {string} success
806
+ */
807
+ /**
808
+ * @typedef Ownership
809
+ * @property {string} payable_by
810
+ * @property {string} payable_category
811
+ */
812
+ /**
813
+ * @typedef Ownership1
814
+ * @property {string} payable_by
815
+ * @property {string} payable_category
816
+ */
817
+ /**
818
+ * @typedef Ownership2
819
+ * @property {string} [payable_by] - Promo amount bearable party
820
+ * @property {string} [payable_category] - Promo amount payable category
821
+ */
822
+ /**
823
+ * @typedef Page
824
+ * @property {number} [current]
825
+ * @property {boolean} [has_next]
826
+ * @property {boolean} [has_previous]
827
+ * @property {number} [item_total]
828
+ * @property {string} [next_id]
829
+ * @property {number} [size]
830
+ * @property {string} type
831
+ */
832
+ /**
833
+ * @typedef PageCoupon
834
+ * @property {number} [current]
835
+ * @property {boolean} [has_next]
836
+ * @property {boolean} [has_previous]
837
+ * @property {number} [total]
838
+ * @property {number} [total_item_count]
839
+ */
840
+ /**
841
+ * @typedef PaymentAllowValue
842
+ * @property {number} [max]
843
+ */
844
+ /**
845
+ * @typedef PaymentAllowValue1
846
+ * @property {number} [max]
847
+ */
848
+ /**
849
+ * @typedef PaymentCouponValidate
850
+ * @property {CouponValidity} [coupon_validity]
851
+ * @property {string} [message]
852
+ * @property {boolean} success
853
+ */
854
+ /**
855
+ * @typedef PaymentMeta
856
+ * @property {string} [merchant_code]
857
+ * @property {string} [payment_gateway]
858
+ * @property {string} [payment_identifier]
859
+ * @property {string} [type]
860
+ */
861
+ /**
862
+ * @typedef PaymentMethod
863
+ * @property {number} [amount]
864
+ * @property {string} mode
865
+ * @property {string} [name]
866
+ * @property {string} [payment]
867
+ * @property {PaymentMeta} payment_meta
868
+ */
869
+ /**
870
+ * @typedef PaymentModes
871
+ * @property {string[]} [codes]
872
+ * @property {string[]} [iins]
873
+ * @property {string[]} [networks]
874
+ * @property {string[]} [types]
875
+ * @property {PaymentAllowValue} [uses]
876
+ */
877
+ /**
878
+ * @typedef PaymentSelectionLock
879
+ * @property {string} [default_options]
880
+ * @property {boolean} [enabled]
881
+ * @property {string} [payment_identifier]
882
+ */
883
+ /**
884
+ * @typedef PickupStoreDetail
885
+ * @property {string} [address]
886
+ * @property {string} [address_type]
887
+ * @property {string} [area]
888
+ * @property {string} [area_code]
889
+ * @property {string} [area_code_slug]
890
+ * @property {string} [city]
891
+ * @property {string} [country]
892
+ * @property {string} [email]
893
+ * @property {number} [id]
894
+ * @property {string} [landmark]
895
+ * @property {string} [name]
896
+ * @property {string} [phone]
897
+ * @property {number} [pincode]
898
+ * @property {string} [state]
899
+ * @property {string} [store_code]
900
+ * @property {number} [uid]
901
+ */
902
+ /**
903
+ * @typedef PlatformAddCartRequest
904
+ * @property {AddProductCart[]} [items]
905
+ * @property {boolean} [new_cart]
906
+ * @property {string} [user_id]
907
+ */
908
+ /**
909
+ * @typedef PlatformAddress
910
+ * @property {string} [address]
911
+ * @property {string} [address_type]
912
+ * @property {string} [area]
913
+ * @property {string} [area_code]
914
+ * @property {string} [area_code_slug]
915
+ * @property {string} [cart_id]
916
+ * @property {string} [checkout_mode]
917
+ * @property {string} [city]
918
+ * @property {string} [country]
919
+ * @property {string} [country_code]
920
+ * @property {string} [created_by_user_id]
921
+ * @property {string} [email]
922
+ * @property {GeoLocation} [geo_location]
923
+ * @property {Object} [google_map_point]
924
+ * @property {string} [id]
925
+ * @property {boolean} [is_active]
926
+ * @property {boolean} [is_default_address]
927
+ * @property {string} [landmark]
928
+ * @property {Object} [meta]
929
+ * @property {string} [name]
930
+ * @property {string} [phone]
931
+ * @property {string} [state]
932
+ * @property {string[]} [tags]
933
+ * @property {string} [user_id]
934
+ */
935
+ /**
936
+ * @typedef PlatformCartCheckoutDetailRequest
937
+ * @property {string} [address_id]
938
+ * @property {string} [aggregator]
939
+ * @property {Object} [billing_address]
940
+ * @property {string} [billing_address_id]
941
+ * @property {string} [callback_url]
942
+ * @property {string} [checkout_mode]
943
+ * @property {CartCheckoutCustomMeta[]} [custom_meta]
944
+ * @property {Object} [customer_details] - Customer details
945
+ * @property {Object} [delivery_address]
946
+ * @property {string} [device_id]
947
+ * @property {string} [employee_code]
948
+ * @property {Object} [extra_meta]
949
+ * @property {Files[]} [files] - List of file url
950
+ * @property {string} id
951
+ * @property {string} [merchant_code]
952
+ * @property {Object} [meta]
953
+ * @property {string} order_type
954
+ * @property {number} [ordering_store]
955
+ * @property {boolean} [payment_auto_confirm]
956
+ * @property {string} [payment_identifier]
957
+ * @property {string} payment_mode
958
+ * @property {Object} [payment_params]
959
+ * @property {number} [pick_at_store_uid]
960
+ * @property {boolean} [pos]
961
+ * @property {StaffCheckout} [staff]
962
+ * @property {string} user_id
963
+ */
964
+ /**
965
+ * @typedef PlatformCartCheckoutDetailV2Request
966
+ * @property {string} [address_id]
967
+ * @property {string} [aggregator]
968
+ * @property {Object} [billing_address]
969
+ * @property {string} [billing_address_id]
970
+ * @property {string} [callback_url]
971
+ * @property {string} [checkout_mode]
972
+ * @property {Object} [custom_meta]
973
+ * @property {Object} [customer_details] - Customer details
974
+ * @property {Object} [delivery_address]
975
+ * @property {string} [device_id]
976
+ * @property {string} [employee_code]
977
+ * @property {Object} [extra_meta]
978
+ * @property {Files[]} [files] - List of file url
979
+ * @property {string} id
980
+ * @property {string} [merchant_code]
981
+ * @property {Object} [meta]
982
+ * @property {string} order_type
983
+ * @property {number} [ordering_store]
984
+ * @property {boolean} [payment_auto_confirm]
985
+ * @property {string} [payment_identifier]
986
+ * @property {PaymentMethod[]} payment_methods
987
+ * @property {string} [payment_mode]
988
+ * @property {Object} [payment_params]
989
+ * @property {number} [pick_at_store_uid]
990
+ * @property {boolean} [pos]
991
+ * @property {StaffCheckout} [staff]
992
+ * @property {string} user_id
993
+ */
994
+ /**
995
+ * @typedef PlatformCartMetaRequest
996
+ * @property {string} [checkout_mode]
997
+ * @property {string} [comment]
998
+ * @property {Object} [gift_details]
999
+ * @property {string} [gstin]
1000
+ * @property {string} [pan_no]
1001
+ * @property {Object} [pick_up_customer_details] - Customer contact details for
1002
+ * customer pickup at store
1003
+ * @property {string} [staff_user_id] - Staff user id
1004
+ */
1005
+ /**
1006
+ * @typedef PlatformCartShipmentsResponse
1007
+ * @property {AppliedPromotion[]} [applied_promo_details]
1008
+ * @property {CartBreakup} [breakup_values]
1009
+ * @property {boolean} [buy_now]
1010
+ * @property {string} [checkout_mode]
1011
+ * @property {string} [comment]
1012
+ * @property {string} [coupon_text]
1013
+ * @property {CartCurrency} [currency]
1014
+ * @property {string} [delivery_charge_info]
1015
+ * @property {ShipmentPromise} [delivery_promise]
1016
+ * @property {boolean} [error]
1017
+ * @property {string} [gstin]
1018
+ * @property {string} [id]
1019
+ * @property {boolean} [is_valid]
1020
+ * @property {CartProductInfo[]} [items]
1021
+ * @property {string} [last_modified]
1022
+ * @property {string} [message]
1023
+ * @property {Object} [pan_config]
1024
+ * @property {string} [pan_no]
1025
+ * @property {PaymentSelectionLock} [payment_selection_lock]
1026
+ * @property {boolean} [restrict_checkout]
1027
+ * @property {PlatformShipmentResponse[]} [shipments]
1028
+ * @property {string} [staff_user_id]
1029
+ */
1030
+ /**
1031
+ * @typedef PlatformGetAddressesResponse
1032
+ * @property {PlatformAddress[]} [address]
1033
+ */
1034
+ /**
1035
+ * @typedef PlatformSelectCartAddressRequest
1036
+ * @property {string} [billing_address_id]
1037
+ * @property {string} [cart_id]
1038
+ * @property {string} [checkout_mode]
1039
+ * @property {string} [id]
1040
+ * @property {string} [user_id]
1041
+ */
1042
+ /**
1043
+ * @typedef PlatformShipmentResponse
1044
+ * @property {ShipmentArticle[]} [articles]
1045
+ * @property {string} [box_type]
1046
+ * @property {string} [dp_id]
1047
+ * @property {Object} [dp_options]
1048
+ * @property {number} [fulfillment_id]
1049
+ * @property {string} [fulfillment_type]
1050
+ * @property {CartProductInfo[]} [items]
1051
+ * @property {string} [order_type]
1052
+ * @property {ShipmentPromise} [promise]
1053
+ * @property {string} [shipment_type]
1054
+ * @property {number} [shipments]
1055
+ */
1056
+ /**
1057
+ * @typedef PlatformUpdateCartRequest
1058
+ * @property {UpdateProductCart[]} [items]
1059
+ * @property {string} operation
1060
+ * @property {string} [user_id]
1061
+ */
1062
+ /**
1063
+ * @typedef PostOrder
1064
+ * @property {boolean} [cancellation_allowed]
1065
+ * @property {boolean} [return_allowed]
1066
+ */
1067
+ /**
1068
+ * @typedef PostOrder1
1069
+ * @property {boolean} [cancellation_allowed]
1070
+ * @property {boolean} [return_allowed]
1071
+ */
1072
+ /**
1073
+ * @typedef PriceAdjustment
1074
+ * @property {boolean} [allowed_refund] - Flag indicating whether refunds are
1075
+ * allowed (default: False)
1076
+ * @property {string} [apply_expiry] - The date and time when the expiry should be applied
1077
+ * @property {Article[]} article_ids - The list of article object in the price adjustment
1078
+ * @property {boolean} article_level_distribution - Flag indicating whether the
1079
+ * distribution should is done at the article level
1080
+ * @property {string} cart_id - The ID of the cart
1081
+ * @property {Collection} collection
1082
+ * @property {string} [id]
1083
+ * @property {boolean} is_authenticated - Flag indicating whether the user is
1084
+ * authenticated
1085
+ * @property {string} message - The message associated with the price adjustment
1086
+ * @property {Object} [meta]
1087
+ * @property {string} type - Type of price adjusment
1088
+ * @property {number} value
1089
+ */
1090
+ /**
1091
+ * @typedef PriceAdjustmentAdd
1092
+ * @property {boolean} [allowed_refund] - Flag indicating whether refunds are
1093
+ * allowed (default: False)
1094
+ * @property {string} [apply_expiry] - The date and time when the expiry should be applied
1095
+ * @property {Article[]} article_ids - The list of article object in the price adjustment
1096
+ * @property {boolean} article_level_distribution - Flag indicating whether the
1097
+ * distribution should is done at the article level
1098
+ * @property {string} cart_id - The ID of the cart
1099
+ * @property {Collection} collection
1100
+ * @property {string} [created_by] - The entity that created the field
1101
+ * @property {boolean} is_authenticated - Flag indicating whether the user is
1102
+ * authenticated
1103
+ * @property {string} message - The message associated with the price adjustment
1104
+ * @property {Object} [meta]
1105
+ * @property {string} type - Type of price adjusment
1106
+ * @property {number} value
1107
+ */
1108
+ /**
1109
+ * @typedef PriceAdjustmentResponse
1110
+ * @property {PriceAdjustment} [data]
1111
+ */
1112
+ /**
1113
+ * @typedef PriceAdjustmentUpdate
1114
+ * @property {boolean} [allowed_refund] - Flag indicating whether refunds are
1115
+ * allowed (default: False)
1116
+ * @property {string} [apply_expiry] - The date and time when the expiry should be applied
1117
+ * @property {Article[]} article_ids - The list of article object in the price adjustment
1118
+ * @property {boolean} article_level_distribution - Flag indicating whether the
1119
+ * distribution should is done at the article level
1120
+ * @property {string} cart_id - The ID of the cart
1121
+ * @property {Collection} collection
1122
+ * @property {boolean} is_authenticated - Flag indicating whether the user is
1123
+ * authenticated
1124
+ * @property {string} message - The message associated with the price adjustment
1125
+ * @property {Object} [meta]
1126
+ * @property {string} [modified_by] - The entity that modified the field
1127
+ * @property {string} type - Type of price adjusment
1128
+ * @property {number} value
1129
+ */
1130
+ /**
1131
+ * @typedef PriceRange
1132
+ * @property {number} [max]
1133
+ * @property {number} [min]
1134
+ */
1135
+ /**
1136
+ * @typedef ProductAction
1137
+ * @property {ActionQuery} [query]
1138
+ * @property {string} [type]
1139
+ * @property {string} [url]
1140
+ */
1141
+ /**
1142
+ * @typedef ProductArticle
1143
+ * @property {Object} [_custom_json]
1144
+ * @property {Object} [cart_item_meta]
1145
+ * @property {Object} [extra_meta]
1146
+ * @property {Object} [gift_card]
1147
+ * @property {Object} [identifier]
1148
+ * @property {boolean} [is_gift_visible]
1149
+ * @property {Object} [meta]
1150
+ * @property {number} [mto_quantity]
1151
+ * @property {Object} [parent_item_identifiers]
1152
+ * @property {ArticlePriceInfo} [price]
1153
+ * @property {string[]} [product_group_tags]
1154
+ * @property {number} [quantity]
1155
+ * @property {BaseInfo} [seller]
1156
+ * @property {string} [seller_identifier]
1157
+ * @property {string} [size]
1158
+ * @property {StoreInfo} [store]
1159
+ * @property {string} [type]
1160
+ * @property {string} [uid]
1161
+ */
1162
+ /**
1163
+ * @typedef ProductAvailability
1164
+ * @property {ProductAvailabilitySize[]} [available_sizes]
1165
+ * @property {boolean} [deliverable]
1166
+ * @property {boolean} [is_valid]
1167
+ * @property {number} [other_store_quantity]
1168
+ * @property {boolean} [out_of_stock]
1169
+ * @property {string[]} [sizes]
1170
+ */
1171
+ /**
1172
+ * @typedef ProductAvailabilitySize
1173
+ * @property {string} [display]
1174
+ * @property {boolean} [is_available]
1175
+ * @property {string} [value]
1176
+ */
1177
+ /**
1178
+ * @typedef ProductImage
1179
+ * @property {string} [aspect_ratio]
1180
+ * @property {string} [secure_url]
1181
+ * @property {string} [url]
1182
+ */
1183
+ /**
1184
+ * @typedef ProductPrice
1185
+ * @property {number} [add_on]
1186
+ * @property {string} [currency_code]
1187
+ * @property {string} [currency_symbol]
1188
+ * @property {number} [effective]
1189
+ * @property {number} [marked]
1190
+ * @property {number} [selling]
1191
+ */
1192
+ /**
1193
+ * @typedef ProductPriceInfo
1194
+ * @property {ProductPrice} [base]
1195
+ * @property {ProductPrice} [converted]
1196
+ */
1197
+ /**
1198
+ * @typedef PromiseFormatted
1199
+ * @property {string} [max]
1200
+ * @property {string} [min]
1201
+ */
1202
+ /**
1203
+ * @typedef PromiseTimestamp
1204
+ * @property {number} [max]
1205
+ * @property {number} [min]
1206
+ */
1207
+ /**
1208
+ * @typedef PromoMeta
1209
+ * @property {string} [message]
1210
+ */
1211
+ /**
1212
+ * @typedef PromotionAction
1213
+ * @property {string} action_date
1214
+ * @property {string} action_type
1215
+ */
1216
+ /**
1217
+ * @typedef PromotionAdd
1218
+ * @property {Object} [_custom_json]
1219
+ * @property {PromotionSchedule} [_schedule]
1220
+ * @property {string} application_id
1221
+ * @property {boolean} [apply_all_discount]
1222
+ * @property {string} [apply_exclusive]
1223
+ * @property {number} [apply_priority]
1224
+ * @property {PromotionAuthor} [author]
1225
+ * @property {Object} buy_rules
1226
+ * @property {string} [calculate_on] - Only available for Contract pricing and
1227
+ * Ladder pricing promotion type
1228
+ * @property {string} [code]
1229
+ * @property {string} [currency]
1230
+ * @property {PromotionDateMeta} [date_meta]
1231
+ * @property {DiscountRule[]} discount_rules
1232
+ * @property {DisplayMeta1} display_meta
1233
+ * @property {string} mode
1234
+ * @property {Ownership1} ownership
1235
+ * @property {PromotionAction} [post_order_action]
1236
+ * @property {string} promo_group
1237
+ * @property {string} promotion_type
1238
+ * @property {Restrictions1} [restrictions]
1239
+ * @property {boolean} [stackable]
1240
+ * @property {Visibility} [visiblility]
1241
+ */
1242
+ /**
1243
+ * @typedef PromotionAuthor
1244
+ * @property {string} [created_by]
1245
+ * @property {string} [modified_by]
1246
+ */
1247
+ /**
1248
+ * @typedef PromotionDateMeta
1249
+ * @property {string} [created_on]
1250
+ * @property {string} [modified_on]
1251
+ */
1252
+ /**
1253
+ * @typedef PromotionListItem
1254
+ * @property {Object} [_custom_json] - Custom data stored in promotion
1255
+ * @property {string} [_id] - Promotion id
1256
+ * @property {PromotionSchedule} [_schedule]
1257
+ * @property {string} application_id - App id in which promotion will be used
1258
+ * @property {boolean} [apply_all_discount] - Prevents more than one promotion discounts
1259
+ * @property {string} [apply_exclusive] - Doesn't allow other promotion after
1260
+ * current promotion applied on cart or article
1261
+ * @property {number} [apply_priority] - Priority based on which promotion are
1262
+ * applied on articles
1263
+ * @property {PromotionAuthor} [author]
1264
+ * @property {Object} buy_rules - Buy rules for the promotion
1265
+ * @property {string} [calculate_on] - Only available for Contract pricing and
1266
+ * Ladder pricing promotion type
1267
+ * @property {string} [code] - Promotion code
1268
+ * @property {string} [currency] - Currency used for promotion
1269
+ * @property {PromotionDateMeta} [date_meta]
1270
+ * @property {DiscountRule[]} discount_rules - Discount rules based on which
1271
+ * promotion will be applied
1272
+ * @property {DisplayMeta1} display_meta
1273
+ * @property {string} mode - Promotion mode
1274
+ * @property {Ownership1} ownership
1275
+ * @property {PromotionAction} [post_order_action]
1276
+ * @property {string} promo_group - Group into which promotion fall
1277
+ * @property {string} promotion_type - Type of the promotion
1278
+ * @property {Restrictions1} [restrictions]
1279
+ * @property {boolean} [stackable] - Allows more than one promotion to get
1280
+ * combined benefits
1281
+ * @property {Visibility} [visiblility]
1282
+ */
1283
+ /**
1284
+ * @typedef PromotionPartialUpdate
1285
+ * @property {boolean} [archive] - Send true to unpublish promotion
1286
+ * @property {PromotionSchedule} [schedule]
1287
+ */
1288
+ /**
1289
+ * @typedef PromotionPaymentModes
1290
+ * @property {string[]} [codes]
1291
+ * @property {string} type
1292
+ * @property {PaymentAllowValue1} [uses]
1293
+ */
1294
+ /**
1295
+ * @typedef PromotionSchedule
1296
+ * @property {string} [cron]
1297
+ * @property {number} [duration]
1298
+ * @property {string} end
1299
+ * @property {Object[]} [next_schedule]
1300
+ * @property {boolean} published
1301
+ * @property {string} start
1302
+ */
1303
+ /**
1304
+ * @typedef PromotionsResponse
1305
+ * @property {PromotionListItem[]} [items]
1306
+ * @property {Page} [page]
1307
+ */
1308
+ /**
1309
+ * @typedef PromotionUpdate
1310
+ * @property {Object} [_custom_json]
1311
+ * @property {PromotionSchedule} [_schedule]
1312
+ * @property {string} application_id
1313
+ * @property {boolean} [apply_all_discount]
1314
+ * @property {string} [apply_exclusive]
1315
+ * @property {number} [apply_priority]
1316
+ * @property {PromotionAuthor} [author]
1317
+ * @property {Object} buy_rules
1318
+ * @property {string} [calculate_on] - Only available for Contract pricing and
1319
+ * Ladder pricing promotion type
1320
+ * @property {string} [code]
1321
+ * @property {string} [currency]
1322
+ * @property {PromotionDateMeta} [date_meta]
1323
+ * @property {DiscountRule[]} discount_rules
1324
+ * @property {DisplayMeta1} display_meta
1325
+ * @property {string} mode
1326
+ * @property {Ownership1} ownership
1327
+ * @property {PromotionAction} [post_order_action]
1328
+ * @property {string} promo_group
1329
+ * @property {string} promotion_type
1330
+ * @property {Restrictions1} [restrictions]
1331
+ * @property {boolean} [stackable]
1332
+ * @property {Visibility} [visiblility]
1333
+ */
1334
+ /**
1335
+ * @typedef RawBreakup
1336
+ * @property {number} [cod_charge]
1337
+ * @property {number} [convenience_fee]
1338
+ * @property {number} [coupon]
1339
+ * @property {number} [delivery_charge]
1340
+ * @property {number} [discount]
1341
+ * @property {number} [fynd_cash]
1342
+ * @property {number} [gift_card]
1343
+ * @property {number} [gst_charges]
1344
+ * @property {number} [mrp_total]
1345
+ * @property {number} [subtotal]
1346
+ * @property {number} [total]
1347
+ * @property {number} [vog]
1348
+ * @property {number} [you_saved]
1349
+ */
1350
+ /**
1351
+ * @typedef Restrictions
1352
+ * @property {BulkBundleRestriction} [bulk_bundle]
1353
+ * @property {boolean} [coupon_allowed]
1354
+ * @property {number[]} [ordering_stores]
1355
+ * @property {Object} [payments]
1356
+ * @property {string[]} [platforms]
1357
+ * @property {PostOrder} [post_order]
1358
+ * @property {PriceRange} [price_range]
1359
+ * @property {number[]} [user_groups]
1360
+ * @property {string} [user_type]
1361
+ * @property {UsesRestriction} [uses]
1362
+ */
1363
+ /**
1364
+ * @typedef Restrictions1
1365
+ * @property {boolean} [anonymous_users]
1366
+ * @property {number} [order_quantity]
1367
+ * @property {number[]} [ordering_stores]
1368
+ * @property {PromotionPaymentModes[]} [payments]
1369
+ * @property {string[]} [platforms]
1370
+ * @property {PostOrder1} [post_order]
1371
+ * @property {number[]} [user_groups]
1372
+ * @property {string[]} [user_id]
1373
+ * @property {Object} [user_registered]
1374
+ * @property {UsesRestriction1} uses
1375
+ */
1376
+ /**
1377
+ * @typedef Rule
1378
+ * @property {number} [discount_qty]
1379
+ * @property {number} [key]
1380
+ * @property {number} [max]
1381
+ * @property {number} [min]
1382
+ * @property {number} [value]
1383
+ */
1384
+ /**
1385
+ * @typedef RuleDefinition
1386
+ * @property {string} applicable_on
1387
+ * @property {boolean} [auto_apply]
1388
+ * @property {string} calculate_on
1389
+ * @property {string} [currency_code]
1390
+ * @property {boolean} [is_exact]
1391
+ * @property {string[]} [scope]
1392
+ * @property {string} type
1393
+ * @property {string} value_type
1394
+ */
1395
+ /**
1396
+ * @typedef SaveAddressResponse
1397
+ * @property {string} [id]
1398
+ * @property {boolean} [is_default_address]
1399
+ * @property {boolean} [success]
1400
+ */
1401
+ /**
1402
+ * @typedef SharedCart
1403
+ * @property {CartBreakup} [breakup_values]
1404
+ * @property {boolean} [buy_now]
1405
+ * @property {number} [cart_id]
1406
+ * @property {string} [checkout_mode]
1407
+ * @property {string} [comment]
1408
+ * @property {string} [coupon_text]
1409
+ * @property {CartCurrency} [currency]
1410
+ * @property {string} [delivery_charge_info]
1411
+ * @property {ShipmentPromise} [delivery_promise]
1412
+ * @property {string} [gstin]
1413
+ * @property {string} [id]
1414
+ * @property {boolean} [is_valid]
1415
+ * @property {CartProductInfo[]} [items]
1416
+ * @property {string} [last_modified]
1417
+ * @property {string} [message]
1418
+ * @property {PaymentSelectionLock} [payment_selection_lock]
1419
+ * @property {boolean} [restrict_checkout]
1420
+ * @property {SharedCartDetails} [shared_cart_details]
1421
+ * @property {string} [uid]
1422
+ */
1423
+ /**
1424
+ * @typedef SharedCartDetails
1425
+ * @property {string} [created_on]
1426
+ * @property {Object} [meta] - Meta data sent while generating share cart link
1427
+ * @property {Object} [source] - Share link device and other source information
1428
+ * @property {string} [token] - Short link id
1429
+ * @property {Object} [user] - User details of who generated share link
1430
+ */
1431
+ /**
1432
+ * @typedef SharedCartResponse
1433
+ * @property {SharedCart} [cart]
1434
+ * @property {string} [error]
1435
+ */
1436
+ /**
1437
+ * @typedef ShipmentArticle
1438
+ * @property {string} [article_id]
1439
+ * @property {string} [meta]
1440
+ * @property {string} [quantity]
1441
+ */
1442
+ /**
1443
+ * @typedef ShipmentPromise
1444
+ * @property {PromiseFormatted} [formatted]
1445
+ * @property {PromiseTimestamp} [timestamp]
1446
+ */
1447
+ /**
1448
+ * @typedef ShippingAddress
1449
+ * @property {string} [address]
1450
+ * @property {string} [address_type]
1451
+ * @property {string} [area]
1452
+ * @property {string} area_code
1453
+ * @property {string} [area_code_slug]
1454
+ * @property {string} [city]
1455
+ * @property {string} [country]
1456
+ * @property {string} [country_code]
1457
+ * @property {string} [country_iso_code]
1458
+ * @property {string} [country_phone_code]
1459
+ * @property {string} [email]
1460
+ * @property {string} [landmark]
1461
+ * @property {Object} [meta]
1462
+ * @property {string} [name]
1463
+ * @property {number} [phone]
1464
+ * @property {number} [pincode]
1465
+ * @property {string} [state]
1466
+ */
1467
+ /**
1468
+ * @typedef StaffCheckout
1469
+ * @property {string} _id
1470
+ * @property {string} [employee_code]
1471
+ * @property {string} first_name
1472
+ * @property {string} last_name
1473
+ * @property {string} user
1474
+ */
1475
+ /**
1476
+ * @typedef State
1477
+ * @property {boolean} [is_archived]
1478
+ * @property {boolean} [is_display]
1479
+ * @property {boolean} [is_public]
1480
+ */
1481
+ /**
1482
+ * @typedef StoreDetailsResponse
1483
+ * @property {PickupStoreDetail[]} [items]
1484
+ */
1485
+ /**
1486
+ * @typedef StoreInfo
1487
+ * @property {string} [name]
1488
+ * @property {string} [store_code]
1489
+ * @property {number} [uid]
1490
+ */
1491
+ /**
1492
+ * @typedef SuccessMessage
1493
+ * @property {string} [message]
1494
+ * @property {boolean} [success]
1495
+ */
1496
+ /**
1497
+ * @typedef Tags
1498
+ * @property {Object} [tags]
1499
+ */
1500
+ /**
1501
+ * @typedef UpdateAddressResponse
1502
+ * @property {string} [id]
1503
+ * @property {boolean} [is_default_address]
1504
+ * @property {boolean} [is_updated]
1505
+ * @property {boolean} [success]
1506
+ */
1507
+ /**
1508
+ * @typedef UpdateCartDetailResponse
1509
+ * @property {CartDetailResponse} [cart]
1510
+ * @property {string} [message]
1511
+ * @property {boolean} [success] - True if all items are added successfully.
1512
+ * False if partially added or not added.
1513
+ */
1514
+ /**
1515
+ * @typedef UpdateCartPaymentRequest
1516
+ * @property {string} [address_id]
1517
+ * @property {string} [aggregator_name]
1518
+ * @property {string} [id]
1519
+ * @property {string} [merchant_code]
1520
+ * @property {string} [payment_identifier]
1521
+ * @property {string} [payment_mode]
1522
+ */
1523
+ /**
1524
+ * @typedef UpdateCartPaymentRequestV2
1525
+ * @property {string} [address_id]
1526
+ * @property {string} [aggregator_name]
1527
+ * @property {string} [id]
1528
+ * @property {string} [merchant_code]
1529
+ * @property {string} [payment_identifier]
1530
+ * @property {PaymentMethod[]} [payment_methods]
1531
+ * @property {string} [payment_mode]
1532
+ */
1533
+ /**
1534
+ * @typedef UpdateCartRequest
1535
+ * @property {UpdateProductCart[]} [items]
1536
+ * @property {string} operation
1537
+ */
1538
+ /**
1539
+ * @typedef UpdateCartShipmentItem
1540
+ * @property {string} article_uid - Article mongo id
1541
+ * @property {number} [quantity] - Quantity of product in shipment
1542
+ * @property {string} shipment_type - Shipment delivery type
1543
+ */
1544
+ /**
1545
+ * @typedef UpdateCartShipmentRequest
1546
+ * @property {UpdateCartShipmentItem[]} shipments
1547
+ */
1548
+ /**
1549
+ * @typedef UpdateProductCart
1550
+ * @property {Object} [_custom_json]
1551
+ * @property {string} [article_id]
1552
+ * @property {Object} [extra_meta]
1553
+ * @property {CartProductIdentifer} identifiers
1554
+ * @property {number} [item_id]
1555
+ * @property {number} [item_index]
1556
+ * @property {string} [item_size]
1557
+ * @property {Object} [meta]
1558
+ * @property {Object} [parent_item_identifiers]
1559
+ * @property {number} [quantity]
1560
+ */
1561
+ /**
1562
+ * @typedef UpdateUserCartMapping
1563
+ * @property {string} user_id
1564
+ */
1565
+ /**
1566
+ * @typedef UserCartMappingResponse
1567
+ * @property {AppliedPromotion[]} [applied_promo_details]
1568
+ * @property {CartBreakup} [breakup_values]
1569
+ * @property {boolean} [buy_now]
1570
+ * @property {string} [checkout_mode]
1571
+ * @property {string} [comment]
1572
+ * @property {string} [coupon_text]
1573
+ * @property {CartCurrency} [currency]
1574
+ * @property {string} [delivery_charge_info]
1575
+ * @property {ShipmentPromise} [delivery_promise]
1576
+ * @property {string} [gstin]
1577
+ * @property {string} [id]
1578
+ * @property {boolean} [is_valid]
1579
+ * @property {CartProductInfo[]} [items]
1580
+ * @property {string} [last_modified]
1581
+ * @property {string} [message]
1582
+ * @property {Object} [pan_config]
1583
+ * @property {string} [pan_no]
1584
+ * @property {PaymentSelectionLock} [payment_selection_lock]
1585
+ * @property {boolean} [restrict_checkout]
1586
+ * @property {UserInfo} [user]
1587
+ */
1588
+ /**
1589
+ * @typedef UserInfo
1590
+ * @property {string} [_id]
1591
+ * @property {string} [created_at]
1592
+ * @property {string} [external_id]
1593
+ * @property {string} [first_name]
1594
+ * @property {string} [gender]
1595
+ * @property {string} [last_name]
1596
+ * @property {string} [mobile]
1597
+ * @property {string} [modified_on]
1598
+ * @property {string} [uid]
1599
+ */
1600
+ /**
1601
+ * @typedef UserRegistered
1602
+ * @property {string} [end]
1603
+ * @property {string} [start]
1604
+ */
1605
+ /**
1606
+ * @typedef UsesRemaining
1607
+ * @property {number} [app]
1608
+ * @property {number} [total]
1609
+ * @property {number} [user]
1610
+ */
1611
+ /**
1612
+ * @typedef UsesRemaining1
1613
+ * @property {number} [total]
1614
+ * @property {number} [user]
1615
+ */
1616
+ /**
1617
+ * @typedef UsesRestriction
1618
+ * @property {UsesRemaining} [maximum]
1619
+ * @property {UsesRemaining} [remaining]
1620
+ */
1621
+ /**
1622
+ * @typedef UsesRestriction1
1623
+ * @property {UsesRemaining1} [maximum]
1624
+ * @property {UsesRemaining1} [remaining]
1625
+ */
1626
+ /**
1627
+ * @typedef Validation
1628
+ * @property {boolean} [anonymous]
1629
+ * @property {string[]} [app_id]
1630
+ * @property {string} [user_registered_after]
1631
+ */
1632
+ /**
1633
+ * @typedef Validity
1634
+ * @property {number} [priority]
1635
+ */
1636
+ /**
1637
+ * @typedef Visibility
1638
+ * @property {boolean} coupon_list
1639
+ * @property {boolean} pdp
1640
+ */
1641
+ declare class CartPlatformModel {
176
1642
  }
1643
+ declare namespace CartPlatformModel {
1644
+ export { AbandonedCart, AbandonedCartResponse, ActionQuery, ActivePromosResponse, AddCartDetailResponse, AddCartRequest, AddProductCart, AppliedFreeArticles, AppliedPromotion, ApplyCouponRequest, Article, ArticlePriceInfo, BaseInfo, BasePrice, BulkBundleRestriction, BuyRules, CartBreakup, CartCheckoutCustomMeta, CartCheckoutResponse, CartCurrency, CartDeliveryModesResponse, CartDetailResponse, CartItem, CartItemCountResponse, CartItemMeta, CartList, CartMetaConfigAdd, CartMetaConfigUpdate, CartMetaMissingResponse, CartMetaResponse, CartProduct, CartProductIdentifer, CartProductInfo, CategoryInfo, Charges, CheckCart, Collection, CompareObject, Coupon, CouponAction, CouponAdd, CouponAuthor, CouponBreakup, CouponDateMeta, CouponDetails, CouponPartialUpdate, CouponSchedule, CouponsResponse, CouponUpdate, CouponValidity, CustomerDetails, DeleteAddressResponse, DeleteCartDetailResponse, DeleteCartRequest, DeliveryCharges, DiscountOffer, DiscountRule, DiscountRulesApp, DisplayBreakup, DisplayMeta, DisplayMeta1, DisplayMetaDict, Files, FreeGiftItem, GeoLocation, GetCouponResponse, GetShareCartLinkRequest, GetShareCartLinkResponse, Identifier, ItemCriteria, LoyaltyPoints, MultiCartResponse, MultiTenderPaymentMeta, MultiTenderPaymentMethod, OpenapiCartDetailsRequest, OpenapiCartDetailsResponse, OpenApiCartServiceabilityRequest, OpenApiCartServiceabilityResponse, OpenApiCheckoutResponse, OpenApiErrorResponse, OpenApiFiles, OpenApiOrderItem, OpenApiPlatformCheckoutReq, OperationErrorResponse, OverrideCartItem, OverrideCartItemPromo, OverrideCheckoutReq, OverrideCheckoutResponse, Ownership, Ownership1, Ownership2, Page, PageCoupon, PaymentAllowValue, PaymentAllowValue1, PaymentCouponValidate, PaymentMeta, PaymentMethod, PaymentModes, PaymentSelectionLock, PickupStoreDetail, PlatformAddCartRequest, PlatformAddress, PlatformCartCheckoutDetailRequest, PlatformCartCheckoutDetailV2Request, PlatformCartMetaRequest, PlatformCartShipmentsResponse, PlatformGetAddressesResponse, PlatformSelectCartAddressRequest, PlatformShipmentResponse, PlatformUpdateCartRequest, PostOrder, PostOrder1, PriceAdjustment, PriceAdjustmentAdd, PriceAdjustmentResponse, PriceAdjustmentUpdate, PriceRange, ProductAction, ProductArticle, ProductAvailability, ProductAvailabilitySize, ProductImage, ProductPrice, ProductPriceInfo, PromiseFormatted, PromiseTimestamp, PromoMeta, PromotionAction, PromotionAdd, PromotionAuthor, PromotionDateMeta, PromotionListItem, PromotionPartialUpdate, PromotionPaymentModes, PromotionSchedule, PromotionsResponse, PromotionUpdate, RawBreakup, Restrictions, Restrictions1, Rule, RuleDefinition, SaveAddressResponse, SharedCart, SharedCartDetails, SharedCartResponse, ShipmentArticle, ShipmentPromise, ShippingAddress, StaffCheckout, State, StoreDetailsResponse, StoreInfo, SuccessMessage, Tags, UpdateAddressResponse, UpdateCartDetailResponse, UpdateCartPaymentRequest, UpdateCartPaymentRequestV2, UpdateCartRequest, UpdateCartShipmentItem, UpdateCartShipmentRequest, UpdateProductCart, UpdateUserCartMapping, UserCartMappingResponse, UserInfo, UserRegistered, UsesRemaining, UsesRemaining1, UsesRestriction, UsesRestriction1, Validation, Validity, Visibility };
1645
+ }
1646
+ /** @returns {AbandonedCart} */
1647
+ declare function AbandonedCart(): AbandonedCart;
1648
+ type AbandonedCart = {
1649
+ _id: string;
1650
+ app_id?: string;
1651
+ articles: any[];
1652
+ bulk_coupon_discount?: number;
1653
+ buy_now?: boolean;
1654
+ cart_value?: number;
1655
+ cashback: any;
1656
+ checkout_mode?: string;
1657
+ cod_charges?: any;
1658
+ comment?: string;
1659
+ coupon?: any;
1660
+ created_on: string;
1661
+ delivery_charges?: any;
1662
+ discount?: number;
1663
+ expire_at: string;
1664
+ fc_index_map?: number[];
1665
+ fynd_credits?: any;
1666
+ gstin?: string;
1667
+ is_active?: boolean;
1668
+ is_archive?: boolean;
1669
+ is_default: boolean;
1670
+ last_modified: string;
1671
+ merge_qty?: boolean;
1672
+ meta?: any;
1673
+ order_id?: string;
1674
+ payment_methods?: any[];
1675
+ payment_mode?: string;
1676
+ payments?: any;
1677
+ pick_up_customer_details?: any;
1678
+ promotion?: any;
1679
+ shipments?: any[];
1680
+ uid: number;
1681
+ user_id: string;
1682
+ };
1683
+ /** @returns {AbandonedCartResponse} */
1684
+ declare function AbandonedCartResponse(): AbandonedCartResponse;
1685
+ type AbandonedCartResponse = {
1686
+ items?: AbandonedCart[];
1687
+ /**
1688
+ * - Message of the response
1689
+ */
1690
+ message?: string;
1691
+ page?: Page;
1692
+ result?: any;
1693
+ /**
1694
+ * - The request success is defined
1695
+ */
1696
+ success?: boolean;
1697
+ };
1698
+ /** @returns {ActionQuery} */
1699
+ declare function ActionQuery(): ActionQuery;
1700
+ type ActionQuery = {
1701
+ /**
1702
+ * - Contains list of product slug
1703
+ */
1704
+ product_slug?: string[];
1705
+ };
1706
+ /** @returns {ActivePromosResponse} */
1707
+ declare function ActivePromosResponse(): ActivePromosResponse;
1708
+ type ActivePromosResponse = {
1709
+ /**
1710
+ * - Coupon creation date
1711
+ */
1712
+ created_on?: string;
1713
+ /**
1714
+ * - The description of the offer in the form of an HTML
1715
+ */
1716
+ description?: string;
1717
+ entity_slug?: string;
1718
+ /**
1719
+ * - Type of entity to be selected from :
1720
+ * ['coupon', 'promotion']
1721
+ */
1722
+ entity_type?: string;
1723
+ /**
1724
+ * - Discount offers examples
1725
+ */
1726
+ example?: string;
1727
+ /**
1728
+ * - If the promo is active or not
1729
+ */
1730
+ is_hidden?: boolean;
1731
+ /**
1732
+ * - Coupon modification date
1733
+ */
1734
+ modified_on?: string;
1735
+ /**
1736
+ * - Small description of the current offer
1737
+ */
1738
+ subtitle?: string;
1739
+ /**
1740
+ * - Name of the promotion
1741
+ */
1742
+ title?: string;
1743
+ /**
1744
+ * - Coupon type
1745
+ */
1746
+ type?: string;
1747
+ };
1748
+ /** @returns {AddCartDetailResponse} */
1749
+ declare function AddCartDetailResponse(): AddCartDetailResponse;
1750
+ type AddCartDetailResponse = {
1751
+ cart?: CartDetailResponse;
1752
+ message?: string;
1753
+ /**
1754
+ * - When adding multiple items check if all
1755
+ * added. True if only few are added.
1756
+ */
1757
+ partial?: boolean;
1758
+ /**
1759
+ * - True if all items are added successfully.
1760
+ * False if partially added or not added.
1761
+ */
1762
+ success?: boolean;
1763
+ };
1764
+ /** @returns {AddCartRequest} */
1765
+ declare function AddCartRequest(): AddCartRequest;
1766
+ type AddCartRequest = {
1767
+ items?: AddProductCart[];
1768
+ new_cart?: boolean;
1769
+ };
1770
+ /** @returns {AddProductCart} */
1771
+ declare function AddProductCart(): AddProductCart;
1772
+ type AddProductCart = {
1773
+ _custom_json?: any;
1774
+ article_assignment?: any;
1775
+ article_id?: string;
1776
+ display?: string;
1777
+ extra_meta?: any;
1778
+ item_id?: number;
1779
+ item_size?: string;
1780
+ meta?: any;
1781
+ parent_item_identifiers?: any[];
1782
+ pos?: boolean;
1783
+ product_group_tags?: string[];
1784
+ quantity?: number;
1785
+ seller_id?: number;
1786
+ store_id?: number;
1787
+ };
1788
+ /** @returns {AppliedFreeArticles} */
1789
+ declare function AppliedFreeArticles(): AppliedFreeArticles;
1790
+ type AppliedFreeArticles = {
1791
+ /**
1792
+ * - Free article id
1793
+ */
1794
+ article_id?: string;
1795
+ /**
1796
+ * - Free gift items details
1797
+ */
1798
+ free_gift_item_details?: FreeGiftItem;
1799
+ /**
1800
+ * - Parent item identifier for free article
1801
+ */
1802
+ parent_item_identifier?: string;
1803
+ /**
1804
+ * - Free article quantity
1805
+ */
1806
+ quantity?: number;
1807
+ };
1808
+ /** @returns {AppliedPromotion} */
1809
+ declare function AppliedPromotion(): AppliedPromotion;
1810
+ type AppliedPromotion = {
1811
+ /**
1812
+ * - Per unit discount amount applied with current promotion
1813
+ */
1814
+ amount?: number;
1815
+ /**
1816
+ * - Applied free
1817
+ * article for free gift item promotions
1818
+ */
1819
+ applied_free_articles?: AppliedFreeArticles[];
1820
+ /**
1821
+ * - Quantity of article on which
1822
+ * promotion is applicable
1823
+ */
1824
+ article_quantity?: number;
1825
+ /**
1826
+ * - Buy rules for promotions
1827
+ */
1828
+ buy_rules?: BuyRules[];
1829
+ /**
1830
+ * - Discount rules for promotions
1831
+ */
1832
+ discount_rules?: DiscountRulesApp[];
1833
+ /**
1834
+ * - If applied promotion is applied on
1835
+ * product MRP or ESP
1836
+ */
1837
+ mrp_promotion?: boolean;
1838
+ /**
1839
+ * - Offer text of current promotion
1840
+ */
1841
+ offer_text?: string;
1842
+ /**
1843
+ * - Ownership of promotion
1844
+ */
1845
+ ownership?: Ownership2;
1846
+ /**
1847
+ * - Promotion id
1848
+ */
1849
+ promo_id?: string;
1850
+ /**
1851
+ * - Promotion group for the promotion
1852
+ */
1853
+ promotion_group?: string;
1854
+ /**
1855
+ * - Promotion name of current promotion
1856
+ */
1857
+ promotion_name?: string;
1858
+ /**
1859
+ * - Promotion type of current promotion
1860
+ */
1861
+ promotion_type?: string;
1862
+ };
1863
+ /** @returns {ApplyCouponRequest} */
1864
+ declare function ApplyCouponRequest(): ApplyCouponRequest;
1865
+ type ApplyCouponRequest = {
1866
+ /**
1867
+ * - Coupon code to be applied
1868
+ */
1869
+ coupon_code: string;
1870
+ };
1871
+ /** @returns {Article} */
1872
+ declare function Article(): Article;
1873
+ type Article = {
1874
+ /**
1875
+ * - Id of article
1876
+ */
1877
+ article_id: string;
1878
+ /**
1879
+ * - Code to identify price adjustment on article
1880
+ */
1881
+ code?: string;
1882
+ /**
1883
+ * - Meta related to article
1884
+ */
1885
+ meta?: any;
1886
+ /**
1887
+ * - Total quantity of the article to be
1888
+ * considered (currently used only in discount type)
1889
+ */
1890
+ quantity?: number;
1891
+ /**
1892
+ * - Type of price adjusment
1893
+ */
1894
+ type?: string;
1895
+ /**
1896
+ * - Value of price adjustment for article
1897
+ */
1898
+ value?: number;
1899
+ };
1900
+ /** @returns {ArticlePriceInfo} */
1901
+ declare function ArticlePriceInfo(): ArticlePriceInfo;
1902
+ type ArticlePriceInfo = {
1903
+ base?: BasePrice;
1904
+ converted?: BasePrice;
1905
+ };
1906
+ /** @returns {BaseInfo} */
1907
+ declare function BaseInfo(): BaseInfo;
1908
+ type BaseInfo = {
1909
+ name?: string;
1910
+ uid?: number;
1911
+ };
1912
+ /** @returns {BasePrice} */
1913
+ declare function BasePrice(): BasePrice;
1914
+ type BasePrice = {
1915
+ currency_code?: string;
1916
+ currency_symbol?: string;
1917
+ effective?: number;
1918
+ marked?: number;
1919
+ };
1920
+ /** @returns {BulkBundleRestriction} */
1921
+ declare function BulkBundleRestriction(): BulkBundleRestriction;
1922
+ type BulkBundleRestriction = {
1923
+ multi_store_allowed: boolean;
1924
+ };
1925
+ /** @returns {BuyRules} */
1926
+ declare function BuyRules(): BuyRules;
1927
+ type BuyRules = {
1928
+ /**
1929
+ * - Cart conditions details for promotion
1930
+ */
1931
+ cart_conditions?: any;
1932
+ /**
1933
+ * - Item criteria of promotion
1934
+ */
1935
+ item_criteria?: any;
1936
+ };
1937
+ /** @returns {CartBreakup} */
1938
+ declare function CartBreakup(): CartBreakup;
1939
+ type CartBreakup = {
1940
+ coupon?: CouponBreakup;
1941
+ display?: DisplayBreakup[];
1942
+ loyalty_points?: LoyaltyPoints;
1943
+ raw?: RawBreakup;
1944
+ };
1945
+ /** @returns {CartCheckoutCustomMeta} */
1946
+ declare function CartCheckoutCustomMeta(): CartCheckoutCustomMeta;
1947
+ type CartCheckoutCustomMeta = {
1948
+ key: string;
1949
+ value: string;
1950
+ };
1951
+ /** @returns {CartCheckoutResponse} */
1952
+ declare function CartCheckoutResponse(): CartCheckoutResponse;
1953
+ type CartCheckoutResponse = {
1954
+ app_intercept_url?: string;
1955
+ callback_url?: string;
1956
+ cart?: CheckCart;
1957
+ data?: any;
1958
+ message?: string;
1959
+ order_id?: string;
1960
+ payment_confirm_url?: string;
1961
+ success?: boolean;
1962
+ };
1963
+ /** @returns {CartCurrency} */
1964
+ declare function CartCurrency(): CartCurrency;
1965
+ type CartCurrency = {
1966
+ /**
1967
+ * - Currency code defined by ISO 4217:2015
1968
+ */
1969
+ code?: string;
1970
+ symbol?: string;
1971
+ };
1972
+ /** @returns {CartDeliveryModesResponse} */
1973
+ declare function CartDeliveryModesResponse(): CartDeliveryModesResponse;
1974
+ type CartDeliveryModesResponse = {
1975
+ /**
1976
+ * - Available delivery modes
1977
+ */
1978
+ available_modes?: string[];
1979
+ /**
1980
+ * - Store pick up available store uids
1981
+ */
1982
+ pickup_stores?: number[];
1983
+ };
1984
+ /** @returns {CartDetailResponse} */
1985
+ declare function CartDetailResponse(): CartDetailResponse;
1986
+ type CartDetailResponse = {
1987
+ applied_promo_details?: AppliedPromotion[];
1988
+ breakup_values?: CartBreakup;
1989
+ buy_now?: boolean;
1990
+ checkout_mode?: string;
1991
+ comment?: string;
1992
+ coupon_text?: string;
1993
+ currency?: CartCurrency;
1994
+ delivery_charge_info?: string;
1995
+ delivery_promise?: ShipmentPromise;
1996
+ gstin?: string;
1997
+ id?: string;
1998
+ is_valid?: boolean;
1999
+ items?: CartProductInfo[];
2000
+ last_modified?: string;
2001
+ message?: string;
2002
+ pan_config?: any;
2003
+ pan_no?: string;
2004
+ payment_selection_lock?: PaymentSelectionLock;
2005
+ restrict_checkout?: boolean;
2006
+ };
2007
+ /** @returns {CartItem} */
2008
+ declare function CartItem(): CartItem;
2009
+ type CartItem = {
2010
+ product_id: string;
2011
+ quantity?: number;
2012
+ size: string;
2013
+ };
2014
+ /** @returns {CartItemCountResponse} */
2015
+ declare function CartItemCountResponse(): CartItemCountResponse;
2016
+ type CartItemCountResponse = {
2017
+ /**
2018
+ * - Item count present in cart
2019
+ */
2020
+ user_cart_items_count?: number;
2021
+ };
2022
+ /** @returns {CartItemMeta} */
2023
+ declare function CartItemMeta(): CartItemMeta;
2024
+ type CartItemMeta = {
2025
+ group_id?: string;
2026
+ primary_item?: boolean;
2027
+ };
2028
+ /** @returns {CartList} */
2029
+ declare function CartList(): CartList;
2030
+ type CartList = {
2031
+ cart_id?: string;
2032
+ cart_value?: number;
2033
+ created_on?: string;
2034
+ item_counts?: number;
2035
+ pick_up_customer_details?: any;
2036
+ user_id?: string;
2037
+ };
2038
+ /** @returns {CartMetaConfigAdd} */
2039
+ declare function CartMetaConfigAdd(): CartMetaConfigAdd;
2040
+ type CartMetaConfigAdd = {
2041
+ bulk_coupons?: boolean;
2042
+ delivery_charges?: DeliveryCharges;
2043
+ enabled?: boolean;
2044
+ gift_display_text?: string;
2045
+ gift_pricing?: number;
2046
+ max_cart_items?: number;
2047
+ min_cart_value?: number;
2048
+ revenue_engine_coupon?: boolean;
2049
+ };
2050
+ /** @returns {CartMetaConfigUpdate} */
2051
+ declare function CartMetaConfigUpdate(): CartMetaConfigUpdate;
2052
+ type CartMetaConfigUpdate = {
2053
+ bulk_coupons?: boolean;
2054
+ delivery_charges?: DeliveryCharges;
2055
+ enabled?: boolean;
2056
+ gift_display_text?: string;
2057
+ gift_pricing?: number;
2058
+ max_cart_items?: number;
2059
+ min_cart_value?: number;
2060
+ revenue_engine_coupon?: boolean;
2061
+ };
2062
+ /** @returns {CartMetaMissingResponse} */
2063
+ declare function CartMetaMissingResponse(): CartMetaMissingResponse;
2064
+ type CartMetaMissingResponse = {
2065
+ errors?: string[];
2066
+ };
2067
+ /** @returns {CartMetaResponse} */
2068
+ declare function CartMetaResponse(): CartMetaResponse;
2069
+ type CartMetaResponse = {
2070
+ is_valid?: boolean;
2071
+ message?: string;
2072
+ };
2073
+ /** @returns {CartProduct} */
2074
+ declare function CartProduct(): CartProduct;
2075
+ type CartProduct = {
2076
+ _custom_json?: any;
2077
+ action?: ProductAction;
2078
+ brand?: BaseInfo;
2079
+ categories?: CategoryInfo[];
2080
+ images?: ProductImage[];
2081
+ item_code?: string;
2082
+ name?: string;
2083
+ /**
2084
+ * - Unique product url name generated via product
2085
+ * name and other meta data
2086
+ */
2087
+ slug?: string;
2088
+ tags?: string[];
2089
+ teaser_tag?: Tags;
2090
+ type?: string;
2091
+ uid?: number;
2092
+ };
2093
+ /** @returns {CartProductIdentifer} */
2094
+ declare function CartProductIdentifer(): CartProductIdentifer;
2095
+ type CartProductIdentifer = {
2096
+ /**
2097
+ * - Article idenfier generated by cart
2098
+ */
2099
+ identifier?: string;
2100
+ };
2101
+ /** @returns {CartProductInfo} */
2102
+ declare function CartProductInfo(): CartProductInfo;
2103
+ type CartProductInfo = {
2104
+ article?: ProductArticle;
2105
+ availability?: ProductAvailability;
2106
+ bulk_offer?: any;
2107
+ coupon?: CouponDetails;
2108
+ coupon_message?: string;
2109
+ custom_order?: any;
2110
+ delivery_promise?: ShipmentPromise;
2111
+ discount?: string;
2112
+ identifiers: CartProductIdentifer;
2113
+ is_set?: boolean;
2114
+ key?: string;
2115
+ message?: string;
2116
+ moq?: any;
2117
+ parent_item_identifiers?: any;
2118
+ price?: ProductPriceInfo;
2119
+ price_per_unit?: ProductPriceInfo;
2120
+ product?: CartProduct;
2121
+ promo_meta?: PromoMeta;
2122
+ promotions_applied?: AppliedPromotion[];
2123
+ quantity?: number;
2124
+ };
2125
+ /** @returns {CategoryInfo} */
2126
+ declare function CategoryInfo(): CategoryInfo;
2127
+ type CategoryInfo = {
2128
+ name?: string;
2129
+ /**
2130
+ * - Product Category Id
2131
+ */
2132
+ uid?: number;
2133
+ };
2134
+ /** @returns {Charges} */
2135
+ declare function Charges(): Charges;
2136
+ type Charges = {
2137
+ charges?: number;
2138
+ threshold?: number;
2139
+ };
2140
+ /** @returns {CheckCart} */
2141
+ declare function CheckCart(): CheckCart;
2142
+ type CheckCart = {
2143
+ breakup_values?: CartBreakup;
2144
+ buy_now?: boolean;
2145
+ cart_id?: number;
2146
+ checkout_mode?: string;
2147
+ cod_available?: boolean;
2148
+ cod_charges?: number;
2149
+ cod_message?: string;
2150
+ comment?: string;
2151
+ coupon_text?: string;
2152
+ currency?: CartCurrency;
2153
+ delivery_charge_info?: string;
2154
+ delivery_charge_order_value?: number;
2155
+ delivery_charges?: number;
2156
+ delivery_promise?: ShipmentPromise;
2157
+ error_message?: string;
2158
+ gstin?: string;
2159
+ id?: string;
2160
+ is_valid?: boolean;
2161
+ items?: CartProductInfo[];
2162
+ last_modified?: string;
2163
+ message?: string;
2164
+ order_id?: string;
2165
+ payment_selection_lock?: PaymentSelectionLock;
2166
+ restrict_checkout?: boolean;
2167
+ store_code?: string;
2168
+ store_emps?: any[];
2169
+ success?: boolean;
2170
+ uid?: string;
2171
+ user_type?: string;
2172
+ };
2173
+ /** @returns {Collection} */
2174
+ declare function Collection(): Collection;
2175
+ type Collection = {
2176
+ collected_by: string;
2177
+ refund_by: string;
2178
+ };
2179
+ /** @returns {CompareObject} */
2180
+ declare function CompareObject(): CompareObject;
2181
+ type CompareObject = {
2182
+ equals?: number;
2183
+ greater_than?: number;
2184
+ greater_than_equals?: number;
2185
+ less_than?: number;
2186
+ less_than_equals?: number;
2187
+ };
2188
+ /** @returns {Coupon} */
2189
+ declare function Coupon(): Coupon;
2190
+ type Coupon = {
2191
+ coupon_code?: string;
2192
+ coupon_type?: string;
2193
+ coupon_value?: number;
2194
+ description?: string;
2195
+ expires_on?: string;
2196
+ is_applicable?: boolean;
2197
+ is_applied?: boolean;
2198
+ max_discount_value?: number;
2199
+ message?: string;
2200
+ minimum_cart_value?: number;
2201
+ sub_title?: string;
2202
+ title?: string;
2203
+ };
2204
+ /** @returns {CouponAction} */
2205
+ declare function CouponAction(): CouponAction;
2206
+ type CouponAction = {
2207
+ action_date?: string;
2208
+ txn_mode?: string;
2209
+ };
2210
+ /** @returns {CouponAdd} */
2211
+ declare function CouponAdd(): CouponAdd;
2212
+ type CouponAdd = {
2213
+ _schedule?: CouponSchedule;
2214
+ action?: CouponAction;
2215
+ author?: CouponAuthor;
2216
+ code: string;
2217
+ date_meta?: CouponDateMeta;
2218
+ display_meta: DisplayMeta;
2219
+ identifiers: Identifier;
2220
+ ownership: Ownership;
2221
+ restrictions?: Restrictions;
2222
+ rule: Rule[];
2223
+ rule_definition: RuleDefinition;
2224
+ state?: State;
2225
+ tags?: string[];
2226
+ type_slug: string;
2227
+ validation?: Validation;
2228
+ validity: Validity;
2229
+ };
2230
+ /** @returns {CouponAuthor} */
2231
+ declare function CouponAuthor(): CouponAuthor;
2232
+ type CouponAuthor = {
2233
+ created_by?: string;
2234
+ modified_by?: string;
2235
+ };
2236
+ /** @returns {CouponBreakup} */
2237
+ declare function CouponBreakup(): CouponBreakup;
2238
+ type CouponBreakup = {
2239
+ code?: string;
2240
+ coupon_type?: string;
2241
+ coupon_value?: number;
2242
+ description?: string;
2243
+ is_applied?: boolean;
2244
+ max_discount_value?: number;
2245
+ message?: string;
2246
+ minimum_cart_value?: number;
2247
+ sub_title?: string;
2248
+ title?: string;
2249
+ type?: string;
2250
+ uid?: string;
2251
+ value?: number;
2252
+ };
2253
+ /** @returns {CouponDateMeta} */
2254
+ declare function CouponDateMeta(): CouponDateMeta;
2255
+ type CouponDateMeta = {
2256
+ created_on?: string;
2257
+ modified_on?: string;
2258
+ };
2259
+ /** @returns {CouponDetails} */
2260
+ declare function CouponDetails(): CouponDetails;
2261
+ type CouponDetails = {
2262
+ code?: string;
2263
+ discount_single_quantity?: number;
2264
+ discount_total_quantity?: number;
2265
+ };
2266
+ /** @returns {CouponPartialUpdate} */
2267
+ declare function CouponPartialUpdate(): CouponPartialUpdate;
2268
+ type CouponPartialUpdate = {
2269
+ /**
2270
+ * - Send true to unpublish coupon
2271
+ */
2272
+ archive?: boolean;
2273
+ schedule?: CouponSchedule;
2274
+ };
2275
+ /** @returns {CouponSchedule} */
2276
+ declare function CouponSchedule(): CouponSchedule;
2277
+ type CouponSchedule = {
2278
+ cron?: string;
2279
+ duration?: number;
2280
+ end?: string;
2281
+ next_schedule?: any[];
2282
+ start?: string;
2283
+ };
2284
+ /** @returns {CouponsResponse} */
2285
+ declare function CouponsResponse(): CouponsResponse;
2286
+ type CouponsResponse = {
2287
+ items?: CouponAdd;
2288
+ page?: Page;
2289
+ };
2290
+ /** @returns {CouponUpdate} */
2291
+ declare function CouponUpdate(): CouponUpdate;
2292
+ type CouponUpdate = {
2293
+ _schedule?: CouponSchedule;
2294
+ action?: CouponAction;
2295
+ author?: CouponAuthor;
2296
+ code: string;
2297
+ date_meta?: CouponDateMeta;
2298
+ display_meta: DisplayMeta;
2299
+ identifiers: Identifier;
2300
+ ownership: Ownership;
2301
+ restrictions?: Restrictions;
2302
+ rule: Rule[];
2303
+ rule_definition: RuleDefinition;
2304
+ state?: State;
2305
+ tags?: string[];
2306
+ type_slug: string;
2307
+ validation?: Validation;
2308
+ validity: Validity;
2309
+ };
2310
+ /** @returns {CouponValidity} */
2311
+ declare function CouponValidity(): CouponValidity;
2312
+ type CouponValidity = {
2313
+ code?: string;
2314
+ discount?: number;
2315
+ display_message_en?: string;
2316
+ next_validation_required?: boolean;
2317
+ title?: string;
2318
+ valid?: boolean;
2319
+ };
2320
+ /** @returns {CustomerDetails} */
2321
+ declare function CustomerDetails(): CustomerDetails;
2322
+ type CustomerDetails = {
2323
+ email?: string;
2324
+ mobile: string;
2325
+ name?: string;
2326
+ };
2327
+ /** @returns {DeleteAddressResponse} */
2328
+ declare function DeleteAddressResponse(): DeleteAddressResponse;
2329
+ type DeleteAddressResponse = {
2330
+ id?: string;
2331
+ is_deleted?: boolean;
2332
+ };
2333
+ /** @returns {DeleteCartDetailResponse} */
2334
+ declare function DeleteCartDetailResponse(): DeleteCartDetailResponse;
2335
+ type DeleteCartDetailResponse = {
2336
+ message?: string;
2337
+ /**
2338
+ * - True if cart is archived successfully. False
2339
+ * if not archived.
2340
+ */
2341
+ success?: boolean;
2342
+ };
2343
+ /** @returns {DeleteCartRequest} */
2344
+ declare function DeleteCartRequest(): DeleteCartRequest;
2345
+ type DeleteCartRequest = {
2346
+ cart_id_list?: string[];
2347
+ };
2348
+ /** @returns {DeliveryCharges} */
2349
+ declare function DeliveryCharges(): DeliveryCharges;
2350
+ type DeliveryCharges = {
2351
+ charges?: Charges[];
2352
+ enabled?: boolean;
2353
+ };
2354
+ /** @returns {DiscountOffer} */
2355
+ declare function DiscountOffer(): DiscountOffer;
2356
+ type DiscountOffer = {
2357
+ apportion_discount?: boolean;
2358
+ code?: string;
2359
+ discount_amount?: number;
2360
+ discount_percentage?: number;
2361
+ discount_price?: number;
2362
+ max_discount_amount?: number;
2363
+ max_offer_quantity?: number;
2364
+ max_usage_per_transaction?: number;
2365
+ min_offer_quantity?: number;
2366
+ partial_can_ret?: boolean;
2367
+ };
2368
+ /** @returns {DiscountRule} */
2369
+ declare function DiscountRule(): DiscountRule;
2370
+ type DiscountRule = {
2371
+ buy_condition: string;
2372
+ discount_type: string;
2373
+ item_criteria: ItemCriteria;
2374
+ offer: DiscountOffer;
2375
+ };
2376
+ /** @returns {DiscountRulesApp} */
2377
+ declare function DiscountRulesApp(): DiscountRulesApp;
2378
+ type DiscountRulesApp = {
2379
+ /**
2380
+ * - Item criteria of promotion
2381
+ */
2382
+ item_criteria?: any;
2383
+ /**
2384
+ * - Matched buy rules for promotion
2385
+ */
2386
+ matched_buy_rules?: string[];
2387
+ /**
2388
+ * - Offer for promotion
2389
+ */
2390
+ offer?: any;
2391
+ /**
2392
+ * - Raw offer details for promotion
2393
+ */
2394
+ raw_offer?: any;
2395
+ };
2396
+ /** @returns {DisplayBreakup} */
2397
+ declare function DisplayBreakup(): DisplayBreakup;
2398
+ type DisplayBreakup = {
2399
+ currency_code?: string;
2400
+ currency_symbol?: string;
2401
+ display?: string;
2402
+ key?: string;
2403
+ message?: string[];
2404
+ value?: number;
2405
+ };
2406
+ /** @returns {DisplayMeta} */
2407
+ declare function DisplayMeta(): DisplayMeta;
2408
+ type DisplayMeta = {
2409
+ apply?: DisplayMetaDict;
2410
+ auto?: DisplayMetaDict;
2411
+ description?: string;
2412
+ remove?: DisplayMetaDict;
2413
+ subtitle?: string;
2414
+ title?: string;
2415
+ };
2416
+ /** @returns {DisplayMeta1} */
2417
+ declare function DisplayMeta1(): DisplayMeta1;
2418
+ type DisplayMeta1 = {
2419
+ description?: string;
2420
+ name?: string;
2421
+ offer_label?: string;
2422
+ offer_text?: string;
2423
+ };
2424
+ /** @returns {DisplayMetaDict} */
2425
+ declare function DisplayMetaDict(): DisplayMetaDict;
2426
+ type DisplayMetaDict = {
2427
+ subtitle?: string;
2428
+ title?: string;
2429
+ };
2430
+ /** @returns {Files} */
2431
+ declare function Files(): Files;
2432
+ type Files = {
2433
+ key: string;
2434
+ values: string[];
2435
+ };
2436
+ /** @returns {FreeGiftItem} */
2437
+ declare function FreeGiftItem(): FreeGiftItem;
2438
+ type FreeGiftItem = {
2439
+ /**
2440
+ * - Item brand name
2441
+ */
2442
+ item_brand_name?: string;
2443
+ /**
2444
+ * - Item id
2445
+ */
2446
+ item_id?: number;
2447
+ /**
2448
+ * - Item images URL
2449
+ */
2450
+ item_images_url?: string[];
2451
+ /**
2452
+ * - Item name
2453
+ */
2454
+ item_name?: string;
2455
+ /**
2456
+ * - Item price details
2457
+ */
2458
+ item_price_details?: any;
2459
+ /**
2460
+ * - Item slug
2461
+ */
2462
+ item_slug?: string;
2463
+ };
2464
+ /** @returns {GeoLocation} */
2465
+ declare function GeoLocation(): GeoLocation;
2466
+ type GeoLocation = {
2467
+ latitude?: number;
2468
+ longitude?: number;
2469
+ };
2470
+ /** @returns {GetCouponResponse} */
2471
+ declare function GetCouponResponse(): GetCouponResponse;
2472
+ type GetCouponResponse = {
2473
+ available_coupon_list?: Coupon[];
2474
+ page?: PageCoupon;
2475
+ };
2476
+ /** @returns {GetShareCartLinkRequest} */
2477
+ declare function GetShareCartLinkRequest(): GetShareCartLinkRequest;
2478
+ type GetShareCartLinkRequest = {
2479
+ /**
2480
+ * - Cart uid for generating sharing
2481
+ */
2482
+ id?: string;
2483
+ /**
2484
+ * - Staff, Ordering store or any other data. This
2485
+ * data will be used to generate link as well as sent as shared details.
2486
+ */
2487
+ meta?: any;
2488
+ };
2489
+ /** @returns {GetShareCartLinkResponse} */
2490
+ declare function GetShareCartLinkResponse(): GetShareCartLinkResponse;
2491
+ type GetShareCartLinkResponse = {
2492
+ /**
2493
+ * - Short shareable final url
2494
+ */
2495
+ share_url?: string;
2496
+ /**
2497
+ * - Short url unique id
2498
+ */
2499
+ token?: string;
2500
+ };
2501
+ /** @returns {Identifier} */
2502
+ declare function Identifier(): Identifier;
2503
+ type Identifier = {
2504
+ article_id?: string[];
2505
+ brand_id?: number[];
2506
+ category_id?: number[];
2507
+ collection_id?: string[];
2508
+ company_id?: number[];
2509
+ email_domain?: string[];
2510
+ exclude_brand_id?: number[];
2511
+ item_id?: number[];
2512
+ store_id?: number[];
2513
+ user_id?: string[];
2514
+ };
2515
+ /** @returns {ItemCriteria} */
2516
+ declare function ItemCriteria(): ItemCriteria;
2517
+ type ItemCriteria = {
2518
+ all_items?: boolean;
2519
+ available_zones?: string[];
2520
+ buy_rules?: string[];
2521
+ cart_quantity?: CompareObject;
2522
+ cart_total?: CompareObject;
2523
+ cart_unique_item_amount?: CompareObject;
2524
+ cart_unique_item_quantity?: CompareObject;
2525
+ item_brand?: number[];
2526
+ item_category?: number[];
2527
+ item_company?: number[];
2528
+ item_department?: number[];
2529
+ item_exclude_brand?: number[];
2530
+ item_exclude_category?: number[];
2531
+ item_exclude_company?: number[];
2532
+ item_exclude_department?: number[];
2533
+ item_exclude_id?: number[];
2534
+ item_exclude_l1_category?: number[];
2535
+ item_exclude_l2_category?: number[];
2536
+ item_exclude_sku?: string[];
2537
+ item_exclude_store?: number[];
2538
+ item_id?: number[];
2539
+ item_l1_category?: number[];
2540
+ item_l2_category?: number[];
2541
+ item_size?: string[];
2542
+ item_sku?: string[];
2543
+ item_store?: number[];
2544
+ item_tags?: string[];
2545
+ };
2546
+ /** @returns {LoyaltyPoints} */
2547
+ declare function LoyaltyPoints(): LoyaltyPoints;
2548
+ type LoyaltyPoints = {
2549
+ applicable?: number;
2550
+ description?: string;
2551
+ is_applied?: boolean;
2552
+ total?: number;
2553
+ };
2554
+ /** @returns {MultiCartResponse} */
2555
+ declare function MultiCartResponse(): MultiCartResponse;
2556
+ type MultiCartResponse = {
2557
+ data?: CartList[];
2558
+ success?: boolean;
2559
+ };
2560
+ /** @returns {MultiTenderPaymentMeta} */
2561
+ declare function MultiTenderPaymentMeta(): MultiTenderPaymentMeta;
2562
+ type MultiTenderPaymentMeta = {
2563
+ current_status?: string;
2564
+ extra_meta?: any;
2565
+ order_id?: string;
2566
+ payment_gateway?: string;
2567
+ payment_id?: string;
2568
+ };
2569
+ /** @returns {MultiTenderPaymentMethod} */
2570
+ declare function MultiTenderPaymentMethod(): MultiTenderPaymentMethod;
2571
+ type MultiTenderPaymentMethod = {
2572
+ /**
2573
+ * - Payment amount
2574
+ */
2575
+ amount: number;
2576
+ meta?: MultiTenderPaymentMeta;
2577
+ mode: string;
2578
+ /**
2579
+ * - Payment mode name
2580
+ */
2581
+ name?: string;
2582
+ };
2583
+ /** @returns {OpenapiCartDetailsRequest} */
2584
+ declare function OpenapiCartDetailsRequest(): OpenapiCartDetailsRequest;
2585
+ type OpenapiCartDetailsRequest = {
2586
+ cart_items: CartItem[];
2587
+ };
2588
+ /** @returns {OpenapiCartDetailsResponse} */
2589
+ declare function OpenapiCartDetailsResponse(): OpenapiCartDetailsResponse;
2590
+ type OpenapiCartDetailsResponse = {
2591
+ breakup_values?: CartBreakup;
2592
+ is_valid?: boolean;
2593
+ items?: CartProductInfo[];
2594
+ message?: string;
2595
+ };
2596
+ /** @returns {OpenApiCartServiceabilityRequest} */
2597
+ declare function OpenApiCartServiceabilityRequest(): OpenApiCartServiceabilityRequest;
2598
+ type OpenApiCartServiceabilityRequest = {
2599
+ cart_items: CartItem[];
2600
+ shipping_address: ShippingAddress;
2601
+ };
2602
+ /** @returns {OpenApiCartServiceabilityResponse} */
2603
+ declare function OpenApiCartServiceabilityResponse(): OpenApiCartServiceabilityResponse;
2604
+ type OpenApiCartServiceabilityResponse = {
2605
+ breakup_values?: CartBreakup;
2606
+ delivery_promise?: ShipmentPromise;
2607
+ is_valid?: boolean;
2608
+ items?: CartProductInfo[];
2609
+ message?: string;
2610
+ };
2611
+ /** @returns {OpenApiCheckoutResponse} */
2612
+ declare function OpenApiCheckoutResponse(): OpenApiCheckoutResponse;
2613
+ type OpenApiCheckoutResponse = {
2614
+ message?: string;
2615
+ /**
2616
+ * - Fynd order id
2617
+ */
2618
+ order_id: string;
2619
+ /**
2620
+ * - Order id sent in request
2621
+ */
2622
+ order_ref_id?: string;
2623
+ success?: boolean;
2624
+ };
2625
+ /** @returns {OpenApiErrorResponse} */
2626
+ declare function OpenApiErrorResponse(): OpenApiErrorResponse;
2627
+ type OpenApiErrorResponse = {
2628
+ /**
2629
+ * - Contains field name which has error as key and
2630
+ * error message as value
2631
+ */
2632
+ errors?: any;
2633
+ message?: string;
2634
+ success?: boolean;
2635
+ };
2636
+ /** @returns {OpenApiFiles} */
2637
+ declare function OpenApiFiles(): OpenApiFiles;
2638
+ type OpenApiFiles = {
2639
+ key: string;
2640
+ values: string[];
2641
+ };
2642
+ /** @returns {OpenApiOrderItem} */
2643
+ declare function OpenApiOrderItem(): OpenApiOrderItem;
2644
+ type OpenApiOrderItem = {
2645
+ amount_paid: number;
2646
+ cashback_applied: number;
2647
+ cod_charges: number;
2648
+ coupon_effective_discount: number;
2649
+ delivery_charges: number;
2650
+ discount: number;
2651
+ employee_discount?: number;
2652
+ extra_meta?: any;
2653
+ files?: OpenApiFiles[];
2654
+ loyalty_discount?: number;
2655
+ meta?: CartItemMeta;
2656
+ payment_methods: MultiTenderPaymentMethod[];
2657
+ price_effective: number;
2658
+ price_marked: number;
2659
+ product_id: number;
2660
+ quantity?: number;
2661
+ size: string;
2662
+ };
2663
+ /** @returns {OpenApiPlatformCheckoutReq} */
2664
+ declare function OpenApiPlatformCheckoutReq(): OpenApiPlatformCheckoutReq;
2665
+ type OpenApiPlatformCheckoutReq = {
2666
+ affiliate_order_id?: string;
2667
+ billing_address: ShippingAddress;
2668
+ cart_items: OpenApiOrderItem[];
2669
+ cart_value: number;
2670
+ cashback_applied: number;
2671
+ cod_charges: number;
2672
+ comment?: string;
2673
+ coupon?: string;
2674
+ coupon_code: string;
2675
+ coupon_value: number;
2676
+ currency_code?: string;
2677
+ delivery_charges: number;
2678
+ employee_discount?: any;
2679
+ files?: OpenApiFiles[];
2680
+ gstin?: string;
2681
+ loyalty_discount?: number;
2682
+ order_id?: string;
2683
+ payment_methods: MultiTenderPaymentMethod[];
2684
+ payment_mode?: string;
2685
+ shipping_address?: ShippingAddress;
2686
+ };
2687
+ /** @returns {OperationErrorResponse} */
2688
+ declare function OperationErrorResponse(): OperationErrorResponse;
2689
+ type OperationErrorResponse = {
2690
+ message?: string;
2691
+ success?: boolean;
2692
+ };
2693
+ /** @returns {OverrideCartItem} */
2694
+ declare function OverrideCartItem(): OverrideCartItem;
2695
+ type OverrideCartItem = {
2696
+ amount_paid: number;
2697
+ discount: number;
2698
+ extra_meta?: any;
2699
+ item_id: number;
2700
+ price_effective: number;
2701
+ price_marked: number;
2702
+ promo_list?: OverrideCartItemPromo[];
2703
+ quantity?: number;
2704
+ seller_identifier?: string;
2705
+ size: string;
2706
+ };
2707
+ /** @returns {OverrideCartItemPromo} */
2708
+ declare function OverrideCartItemPromo(): OverrideCartItemPromo;
2709
+ type OverrideCartItemPromo = {
2710
+ item_list?: any[];
2711
+ promo_amount: string;
2712
+ promo_desc?: string;
2713
+ promo_id: string;
2714
+ rwrd_tndr?: string;
2715
+ };
2716
+ /** @returns {OverrideCheckoutReq} */
2717
+ declare function OverrideCheckoutReq(): OverrideCheckoutReq;
2718
+ type OverrideCheckoutReq = {
2719
+ aggregator: string;
2720
+ billing_address?: any;
2721
+ cart_id: string;
2722
+ cart_items: OverrideCartItem[];
2723
+ currency_code: string;
2724
+ merchant_code: string;
2725
+ order_type: string;
2726
+ ordering_store?: number;
2727
+ payment_identifier: string;
2728
+ payment_mode: string;
2729
+ shipping_address?: any;
2730
+ };
2731
+ /** @returns {OverrideCheckoutResponse} */
2732
+ declare function OverrideCheckoutResponse(): OverrideCheckoutResponse;
2733
+ type OverrideCheckoutResponse = {
2734
+ cart: any;
2735
+ data: any;
2736
+ message: string;
2737
+ order_id: string;
2738
+ success: string;
2739
+ };
2740
+ /** @returns {Ownership} */
2741
+ declare function Ownership(): Ownership;
2742
+ type Ownership = {
2743
+ payable_by: string;
2744
+ payable_category: string;
2745
+ };
2746
+ /** @returns {Ownership1} */
2747
+ declare function Ownership1(): Ownership1;
2748
+ type Ownership1 = {
2749
+ payable_by: string;
2750
+ payable_category: string;
2751
+ };
2752
+ /** @returns {Ownership2} */
2753
+ declare function Ownership2(): Ownership2;
2754
+ type Ownership2 = {
2755
+ /**
2756
+ * - Promo amount bearable party
2757
+ */
2758
+ payable_by?: string;
2759
+ /**
2760
+ * - Promo amount payable category
2761
+ */
2762
+ payable_category?: string;
2763
+ };
2764
+ /** @returns {Page} */
2765
+ declare function Page(): Page;
2766
+ type Page = {
2767
+ current?: number;
2768
+ has_next?: boolean;
2769
+ has_previous?: boolean;
2770
+ item_total?: number;
2771
+ next_id?: string;
2772
+ size?: number;
2773
+ type: string;
2774
+ };
2775
+ /** @returns {PageCoupon} */
2776
+ declare function PageCoupon(): PageCoupon;
2777
+ type PageCoupon = {
2778
+ current?: number;
2779
+ has_next?: boolean;
2780
+ has_previous?: boolean;
2781
+ total?: number;
2782
+ total_item_count?: number;
2783
+ };
2784
+ /** @returns {PaymentAllowValue} */
2785
+ declare function PaymentAllowValue(): PaymentAllowValue;
2786
+ type PaymentAllowValue = {
2787
+ max?: number;
2788
+ };
2789
+ /** @returns {PaymentAllowValue1} */
2790
+ declare function PaymentAllowValue1(): PaymentAllowValue1;
2791
+ type PaymentAllowValue1 = {
2792
+ max?: number;
2793
+ };
2794
+ /** @returns {PaymentCouponValidate} */
2795
+ declare function PaymentCouponValidate(): PaymentCouponValidate;
2796
+ type PaymentCouponValidate = {
2797
+ coupon_validity?: CouponValidity;
2798
+ message?: string;
2799
+ success: boolean;
2800
+ };
2801
+ /** @returns {PaymentMeta} */
2802
+ declare function PaymentMeta(): PaymentMeta;
2803
+ type PaymentMeta = {
2804
+ merchant_code?: string;
2805
+ payment_gateway?: string;
2806
+ payment_identifier?: string;
2807
+ type?: string;
2808
+ };
2809
+ /** @returns {PaymentMethod} */
2810
+ declare function PaymentMethod(): PaymentMethod;
2811
+ type PaymentMethod = {
2812
+ amount?: number;
2813
+ mode: string;
2814
+ name?: string;
2815
+ payment?: string;
2816
+ payment_meta: PaymentMeta;
2817
+ };
2818
+ /** @returns {PaymentModes} */
2819
+ declare function PaymentModes(): PaymentModes;
2820
+ type PaymentModes = {
2821
+ codes?: string[];
2822
+ iins?: string[];
2823
+ networks?: string[];
2824
+ types?: string[];
2825
+ uses?: PaymentAllowValue;
2826
+ };
2827
+ /** @returns {PaymentSelectionLock} */
2828
+ declare function PaymentSelectionLock(): PaymentSelectionLock;
2829
+ type PaymentSelectionLock = {
2830
+ default_options?: string;
2831
+ enabled?: boolean;
2832
+ payment_identifier?: string;
2833
+ };
2834
+ /** @returns {PickupStoreDetail} */
2835
+ declare function PickupStoreDetail(): PickupStoreDetail;
2836
+ type PickupStoreDetail = {
2837
+ address?: string;
2838
+ address_type?: string;
2839
+ area?: string;
2840
+ area_code?: string;
2841
+ area_code_slug?: string;
2842
+ city?: string;
2843
+ country?: string;
2844
+ email?: string;
2845
+ id?: number;
2846
+ landmark?: string;
2847
+ name?: string;
2848
+ phone?: string;
2849
+ pincode?: number;
2850
+ state?: string;
2851
+ store_code?: string;
2852
+ uid?: number;
2853
+ };
2854
+ /** @returns {PlatformAddCartRequest} */
2855
+ declare function PlatformAddCartRequest(): PlatformAddCartRequest;
2856
+ type PlatformAddCartRequest = {
2857
+ items?: AddProductCart[];
2858
+ new_cart?: boolean;
2859
+ user_id?: string;
2860
+ };
2861
+ /** @returns {PlatformAddress} */
2862
+ declare function PlatformAddress(): PlatformAddress;
2863
+ type PlatformAddress = {
2864
+ address?: string;
2865
+ address_type?: string;
2866
+ area?: string;
2867
+ area_code?: string;
2868
+ area_code_slug?: string;
2869
+ cart_id?: string;
2870
+ checkout_mode?: string;
2871
+ city?: string;
2872
+ country?: string;
2873
+ country_code?: string;
2874
+ created_by_user_id?: string;
2875
+ email?: string;
2876
+ geo_location?: GeoLocation;
2877
+ google_map_point?: any;
2878
+ id?: string;
2879
+ is_active?: boolean;
2880
+ is_default_address?: boolean;
2881
+ landmark?: string;
2882
+ meta?: any;
2883
+ name?: string;
2884
+ phone?: string;
2885
+ state?: string;
2886
+ tags?: string[];
2887
+ user_id?: string;
2888
+ };
2889
+ /** @returns {PlatformCartCheckoutDetailRequest} */
2890
+ declare function PlatformCartCheckoutDetailRequest(): PlatformCartCheckoutDetailRequest;
2891
+ type PlatformCartCheckoutDetailRequest = {
2892
+ address_id?: string;
2893
+ aggregator?: string;
2894
+ billing_address?: any;
2895
+ billing_address_id?: string;
2896
+ callback_url?: string;
2897
+ checkout_mode?: string;
2898
+ custom_meta?: CartCheckoutCustomMeta[];
2899
+ /**
2900
+ * - Customer details
2901
+ */
2902
+ customer_details?: any;
2903
+ delivery_address?: any;
2904
+ device_id?: string;
2905
+ employee_code?: string;
2906
+ extra_meta?: any;
2907
+ /**
2908
+ * - List of file url
2909
+ */
2910
+ files?: Files[];
2911
+ id: string;
2912
+ merchant_code?: string;
2913
+ meta?: any;
2914
+ order_type: string;
2915
+ ordering_store?: number;
2916
+ payment_auto_confirm?: boolean;
2917
+ payment_identifier?: string;
2918
+ payment_mode: string;
2919
+ payment_params?: any;
2920
+ pick_at_store_uid?: number;
2921
+ pos?: boolean;
2922
+ staff?: StaffCheckout;
2923
+ user_id: string;
2924
+ };
2925
+ /** @returns {PlatformCartCheckoutDetailV2Request} */
2926
+ declare function PlatformCartCheckoutDetailV2Request(): PlatformCartCheckoutDetailV2Request;
2927
+ type PlatformCartCheckoutDetailV2Request = {
2928
+ address_id?: string;
2929
+ aggregator?: string;
2930
+ billing_address?: any;
2931
+ billing_address_id?: string;
2932
+ callback_url?: string;
2933
+ checkout_mode?: string;
2934
+ custom_meta?: any;
2935
+ /**
2936
+ * - Customer details
2937
+ */
2938
+ customer_details?: any;
2939
+ delivery_address?: any;
2940
+ device_id?: string;
2941
+ employee_code?: string;
2942
+ extra_meta?: any;
2943
+ /**
2944
+ * - List of file url
2945
+ */
2946
+ files?: Files[];
2947
+ id: string;
2948
+ merchant_code?: string;
2949
+ meta?: any;
2950
+ order_type: string;
2951
+ ordering_store?: number;
2952
+ payment_auto_confirm?: boolean;
2953
+ payment_identifier?: string;
2954
+ payment_methods: PaymentMethod[];
2955
+ payment_mode?: string;
2956
+ payment_params?: any;
2957
+ pick_at_store_uid?: number;
2958
+ pos?: boolean;
2959
+ staff?: StaffCheckout;
2960
+ user_id: string;
2961
+ };
2962
+ /** @returns {PlatformCartMetaRequest} */
2963
+ declare function PlatformCartMetaRequest(): PlatformCartMetaRequest;
2964
+ type PlatformCartMetaRequest = {
2965
+ checkout_mode?: string;
2966
+ comment?: string;
2967
+ gift_details?: any;
2968
+ gstin?: string;
2969
+ pan_no?: string;
2970
+ /**
2971
+ * - Customer contact details for
2972
+ * customer pickup at store
2973
+ */
2974
+ pick_up_customer_details?: any;
2975
+ /**
2976
+ * - Staff user id
2977
+ */
2978
+ staff_user_id?: string;
2979
+ };
2980
+ /** @returns {PlatformCartShipmentsResponse} */
2981
+ declare function PlatformCartShipmentsResponse(): PlatformCartShipmentsResponse;
2982
+ type PlatformCartShipmentsResponse = {
2983
+ applied_promo_details?: AppliedPromotion[];
2984
+ breakup_values?: CartBreakup;
2985
+ buy_now?: boolean;
2986
+ checkout_mode?: string;
2987
+ comment?: string;
2988
+ coupon_text?: string;
2989
+ currency?: CartCurrency;
2990
+ delivery_charge_info?: string;
2991
+ delivery_promise?: ShipmentPromise;
2992
+ error?: boolean;
2993
+ gstin?: string;
2994
+ id?: string;
2995
+ is_valid?: boolean;
2996
+ items?: CartProductInfo[];
2997
+ last_modified?: string;
2998
+ message?: string;
2999
+ pan_config?: any;
3000
+ pan_no?: string;
3001
+ payment_selection_lock?: PaymentSelectionLock;
3002
+ restrict_checkout?: boolean;
3003
+ shipments?: PlatformShipmentResponse[];
3004
+ staff_user_id?: string;
3005
+ };
3006
+ /** @returns {PlatformGetAddressesResponse} */
3007
+ declare function PlatformGetAddressesResponse(): PlatformGetAddressesResponse;
3008
+ type PlatformGetAddressesResponse = {
3009
+ address?: PlatformAddress[];
3010
+ };
3011
+ /** @returns {PlatformSelectCartAddressRequest} */
3012
+ declare function PlatformSelectCartAddressRequest(): PlatformSelectCartAddressRequest;
3013
+ type PlatformSelectCartAddressRequest = {
3014
+ billing_address_id?: string;
3015
+ cart_id?: string;
3016
+ checkout_mode?: string;
3017
+ id?: string;
3018
+ user_id?: string;
3019
+ };
3020
+ /** @returns {PlatformShipmentResponse} */
3021
+ declare function PlatformShipmentResponse(): PlatformShipmentResponse;
3022
+ type PlatformShipmentResponse = {
3023
+ articles?: ShipmentArticle[];
3024
+ box_type?: string;
3025
+ dp_id?: string;
3026
+ dp_options?: any;
3027
+ fulfillment_id?: number;
3028
+ fulfillment_type?: string;
3029
+ items?: CartProductInfo[];
3030
+ order_type?: string;
3031
+ promise?: ShipmentPromise;
3032
+ shipment_type?: string;
3033
+ shipments?: number;
3034
+ };
3035
+ /** @returns {PlatformUpdateCartRequest} */
3036
+ declare function PlatformUpdateCartRequest(): PlatformUpdateCartRequest;
3037
+ type PlatformUpdateCartRequest = {
3038
+ items?: UpdateProductCart[];
3039
+ operation: string;
3040
+ user_id?: string;
3041
+ };
3042
+ /** @returns {PostOrder} */
3043
+ declare function PostOrder(): PostOrder;
3044
+ type PostOrder = {
3045
+ cancellation_allowed?: boolean;
3046
+ return_allowed?: boolean;
3047
+ };
3048
+ /** @returns {PostOrder1} */
3049
+ declare function PostOrder1(): PostOrder1;
3050
+ type PostOrder1 = {
3051
+ cancellation_allowed?: boolean;
3052
+ return_allowed?: boolean;
3053
+ };
3054
+ /** @returns {PriceAdjustment} */
3055
+ declare function PriceAdjustment(): PriceAdjustment;
3056
+ type PriceAdjustment = {
3057
+ /**
3058
+ * - Flag indicating whether refunds are
3059
+ * allowed (default: False)
3060
+ */
3061
+ allowed_refund?: boolean;
3062
+ /**
3063
+ * - The date and time when the expiry should be applied
3064
+ */
3065
+ apply_expiry?: string;
3066
+ /**
3067
+ * - The list of article object in the price adjustment
3068
+ */
3069
+ article_ids: Article[];
3070
+ /**
3071
+ * - Flag indicating whether the
3072
+ * distribution should is done at the article level
3073
+ */
3074
+ article_level_distribution: boolean;
3075
+ /**
3076
+ * - The ID of the cart
3077
+ */
3078
+ cart_id: string;
3079
+ collection: Collection;
3080
+ id?: string;
3081
+ /**
3082
+ * - Flag indicating whether the user is
3083
+ * authenticated
3084
+ */
3085
+ is_authenticated: boolean;
3086
+ /**
3087
+ * - The message associated with the price adjustment
3088
+ */
3089
+ message: string;
3090
+ meta?: any;
3091
+ /**
3092
+ * - Type of price adjusment
3093
+ */
3094
+ type: string;
3095
+ value: number;
3096
+ };
3097
+ /** @returns {PriceAdjustmentAdd} */
3098
+ declare function PriceAdjustmentAdd(): PriceAdjustmentAdd;
3099
+ type PriceAdjustmentAdd = {
3100
+ /**
3101
+ * - Flag indicating whether refunds are
3102
+ * allowed (default: False)
3103
+ */
3104
+ allowed_refund?: boolean;
3105
+ /**
3106
+ * - The date and time when the expiry should be applied
3107
+ */
3108
+ apply_expiry?: string;
3109
+ /**
3110
+ * - The list of article object in the price adjustment
3111
+ */
3112
+ article_ids: Article[];
3113
+ /**
3114
+ * - Flag indicating whether the
3115
+ * distribution should is done at the article level
3116
+ */
3117
+ article_level_distribution: boolean;
3118
+ /**
3119
+ * - The ID of the cart
3120
+ */
3121
+ cart_id: string;
3122
+ collection: Collection;
3123
+ /**
3124
+ * - The entity that created the field
3125
+ */
3126
+ created_by?: string;
3127
+ /**
3128
+ * - Flag indicating whether the user is
3129
+ * authenticated
3130
+ */
3131
+ is_authenticated: boolean;
3132
+ /**
3133
+ * - The message associated with the price adjustment
3134
+ */
3135
+ message: string;
3136
+ meta?: any;
3137
+ /**
3138
+ * - Type of price adjusment
3139
+ */
3140
+ type: string;
3141
+ value: number;
3142
+ };
3143
+ /** @returns {PriceAdjustmentResponse} */
3144
+ declare function PriceAdjustmentResponse(): PriceAdjustmentResponse;
3145
+ type PriceAdjustmentResponse = {
3146
+ data?: PriceAdjustment;
3147
+ };
3148
+ /** @returns {PriceAdjustmentUpdate} */
3149
+ declare function PriceAdjustmentUpdate(): PriceAdjustmentUpdate;
3150
+ type PriceAdjustmentUpdate = {
3151
+ /**
3152
+ * - Flag indicating whether refunds are
3153
+ * allowed (default: False)
3154
+ */
3155
+ allowed_refund?: boolean;
3156
+ /**
3157
+ * - The date and time when the expiry should be applied
3158
+ */
3159
+ apply_expiry?: string;
3160
+ /**
3161
+ * - The list of article object in the price adjustment
3162
+ */
3163
+ article_ids: Article[];
3164
+ /**
3165
+ * - Flag indicating whether the
3166
+ * distribution should is done at the article level
3167
+ */
3168
+ article_level_distribution: boolean;
3169
+ /**
3170
+ * - The ID of the cart
3171
+ */
3172
+ cart_id: string;
3173
+ collection: Collection;
3174
+ /**
3175
+ * - Flag indicating whether the user is
3176
+ * authenticated
3177
+ */
3178
+ is_authenticated: boolean;
3179
+ /**
3180
+ * - The message associated with the price adjustment
3181
+ */
3182
+ message: string;
3183
+ meta?: any;
3184
+ /**
3185
+ * - The entity that modified the field
3186
+ */
3187
+ modified_by?: string;
3188
+ /**
3189
+ * - Type of price adjusment
3190
+ */
3191
+ type: string;
3192
+ value: number;
3193
+ };
3194
+ /** @returns {PriceRange} */
3195
+ declare function PriceRange(): PriceRange;
3196
+ type PriceRange = {
3197
+ max?: number;
3198
+ min?: number;
3199
+ };
3200
+ /** @returns {ProductAction} */
3201
+ declare function ProductAction(): ProductAction;
3202
+ type ProductAction = {
3203
+ query?: ActionQuery;
3204
+ type?: string;
3205
+ url?: string;
3206
+ };
3207
+ /** @returns {ProductArticle} */
3208
+ declare function ProductArticle(): ProductArticle;
3209
+ type ProductArticle = {
3210
+ _custom_json?: any;
3211
+ cart_item_meta?: any;
3212
+ extra_meta?: any;
3213
+ gift_card?: any;
3214
+ identifier?: any;
3215
+ is_gift_visible?: boolean;
3216
+ meta?: any;
3217
+ mto_quantity?: number;
3218
+ parent_item_identifiers?: any;
3219
+ price?: ArticlePriceInfo;
3220
+ product_group_tags?: string[];
3221
+ quantity?: number;
3222
+ seller?: BaseInfo;
3223
+ seller_identifier?: string;
3224
+ size?: string;
3225
+ store?: StoreInfo;
3226
+ type?: string;
3227
+ uid?: string;
3228
+ };
3229
+ /** @returns {ProductAvailability} */
3230
+ declare function ProductAvailability(): ProductAvailability;
3231
+ type ProductAvailability = {
3232
+ available_sizes?: ProductAvailabilitySize[];
3233
+ deliverable?: boolean;
3234
+ is_valid?: boolean;
3235
+ other_store_quantity?: number;
3236
+ out_of_stock?: boolean;
3237
+ sizes?: string[];
3238
+ };
3239
+ /** @returns {ProductAvailabilitySize} */
3240
+ declare function ProductAvailabilitySize(): ProductAvailabilitySize;
3241
+ type ProductAvailabilitySize = {
3242
+ display?: string;
3243
+ is_available?: boolean;
3244
+ value?: string;
3245
+ };
3246
+ /** @returns {ProductImage} */
3247
+ declare function ProductImage(): ProductImage;
3248
+ type ProductImage = {
3249
+ aspect_ratio?: string;
3250
+ secure_url?: string;
3251
+ url?: string;
3252
+ };
3253
+ /** @returns {ProductPrice} */
3254
+ declare function ProductPrice(): ProductPrice;
3255
+ type ProductPrice = {
3256
+ add_on?: number;
3257
+ currency_code?: string;
3258
+ currency_symbol?: string;
3259
+ effective?: number;
3260
+ marked?: number;
3261
+ selling?: number;
3262
+ };
3263
+ /** @returns {ProductPriceInfo} */
3264
+ declare function ProductPriceInfo(): ProductPriceInfo;
3265
+ type ProductPriceInfo = {
3266
+ base?: ProductPrice;
3267
+ converted?: ProductPrice;
3268
+ };
3269
+ /** @returns {PromiseFormatted} */
3270
+ declare function PromiseFormatted(): PromiseFormatted;
3271
+ type PromiseFormatted = {
3272
+ max?: string;
3273
+ min?: string;
3274
+ };
3275
+ /** @returns {PromiseTimestamp} */
3276
+ declare function PromiseTimestamp(): PromiseTimestamp;
3277
+ type PromiseTimestamp = {
3278
+ max?: number;
3279
+ min?: number;
3280
+ };
3281
+ /** @returns {PromoMeta} */
3282
+ declare function PromoMeta(): PromoMeta;
3283
+ type PromoMeta = {
3284
+ message?: string;
3285
+ };
3286
+ /** @returns {PromotionAction} */
3287
+ declare function PromotionAction(): PromotionAction;
3288
+ type PromotionAction = {
3289
+ action_date: string;
3290
+ action_type: string;
3291
+ };
3292
+ /** @returns {PromotionAdd} */
3293
+ declare function PromotionAdd(): PromotionAdd;
3294
+ type PromotionAdd = {
3295
+ _custom_json?: any;
3296
+ _schedule?: PromotionSchedule;
3297
+ application_id: string;
3298
+ apply_all_discount?: boolean;
3299
+ apply_exclusive?: string;
3300
+ apply_priority?: number;
3301
+ author?: PromotionAuthor;
3302
+ buy_rules: any;
3303
+ /**
3304
+ * - Only available for Contract pricing and
3305
+ * Ladder pricing promotion type
3306
+ */
3307
+ calculate_on?: string;
3308
+ code?: string;
3309
+ currency?: string;
3310
+ date_meta?: PromotionDateMeta;
3311
+ discount_rules: DiscountRule[];
3312
+ display_meta: DisplayMeta1;
3313
+ mode: string;
3314
+ ownership: Ownership1;
3315
+ post_order_action?: PromotionAction;
3316
+ promo_group: string;
3317
+ promotion_type: string;
3318
+ restrictions?: Restrictions1;
3319
+ stackable?: boolean;
3320
+ visiblility?: Visibility;
3321
+ };
3322
+ /** @returns {PromotionAuthor} */
3323
+ declare function PromotionAuthor(): PromotionAuthor;
3324
+ type PromotionAuthor = {
3325
+ created_by?: string;
3326
+ modified_by?: string;
3327
+ };
3328
+ /** @returns {PromotionDateMeta} */
3329
+ declare function PromotionDateMeta(): PromotionDateMeta;
3330
+ type PromotionDateMeta = {
3331
+ created_on?: string;
3332
+ modified_on?: string;
3333
+ };
3334
+ /** @returns {PromotionListItem} */
3335
+ declare function PromotionListItem(): PromotionListItem;
3336
+ type PromotionListItem = {
3337
+ /**
3338
+ * - Custom data stored in promotion
3339
+ */
3340
+ _custom_json?: any;
3341
+ /**
3342
+ * - Promotion id
3343
+ */
3344
+ _id?: string;
3345
+ _schedule?: PromotionSchedule;
3346
+ /**
3347
+ * - App id in which promotion will be used
3348
+ */
3349
+ application_id: string;
3350
+ /**
3351
+ * - Prevents more than one promotion discounts
3352
+ */
3353
+ apply_all_discount?: boolean;
3354
+ /**
3355
+ * - Doesn't allow other promotion after
3356
+ * current promotion applied on cart or article
3357
+ */
3358
+ apply_exclusive?: string;
3359
+ /**
3360
+ * - Priority based on which promotion are
3361
+ * applied on articles
3362
+ */
3363
+ apply_priority?: number;
3364
+ author?: PromotionAuthor;
3365
+ /**
3366
+ * - Buy rules for the promotion
3367
+ */
3368
+ buy_rules: any;
3369
+ /**
3370
+ * - Only available for Contract pricing and
3371
+ * Ladder pricing promotion type
3372
+ */
3373
+ calculate_on?: string;
3374
+ /**
3375
+ * - Promotion code
3376
+ */
3377
+ code?: string;
3378
+ /**
3379
+ * - Currency used for promotion
3380
+ */
3381
+ currency?: string;
3382
+ date_meta?: PromotionDateMeta;
3383
+ /**
3384
+ * - Discount rules based on which
3385
+ * promotion will be applied
3386
+ */
3387
+ discount_rules: DiscountRule[];
3388
+ display_meta: DisplayMeta1;
3389
+ /**
3390
+ * - Promotion mode
3391
+ */
3392
+ mode: string;
3393
+ ownership: Ownership1;
3394
+ post_order_action?: PromotionAction;
3395
+ /**
3396
+ * - Group into which promotion fall
3397
+ */
3398
+ promo_group: string;
3399
+ /**
3400
+ * - Type of the promotion
3401
+ */
3402
+ promotion_type: string;
3403
+ restrictions?: Restrictions1;
3404
+ /**
3405
+ * - Allows more than one promotion to get
3406
+ * combined benefits
3407
+ */
3408
+ stackable?: boolean;
3409
+ visiblility?: Visibility;
3410
+ };
3411
+ /** @returns {PromotionPartialUpdate} */
3412
+ declare function PromotionPartialUpdate(): PromotionPartialUpdate;
3413
+ type PromotionPartialUpdate = {
3414
+ /**
3415
+ * - Send true to unpublish promotion
3416
+ */
3417
+ archive?: boolean;
3418
+ schedule?: PromotionSchedule;
3419
+ };
3420
+ /** @returns {PromotionPaymentModes} */
3421
+ declare function PromotionPaymentModes(): PromotionPaymentModes;
3422
+ type PromotionPaymentModes = {
3423
+ codes?: string[];
3424
+ type: string;
3425
+ uses?: PaymentAllowValue1;
3426
+ };
3427
+ /** @returns {PromotionSchedule} */
3428
+ declare function PromotionSchedule(): PromotionSchedule;
3429
+ type PromotionSchedule = {
3430
+ cron?: string;
3431
+ duration?: number;
3432
+ end: string;
3433
+ next_schedule?: any[];
3434
+ published: boolean;
3435
+ start: string;
3436
+ };
3437
+ /** @returns {PromotionsResponse} */
3438
+ declare function PromotionsResponse(): PromotionsResponse;
3439
+ type PromotionsResponse = {
3440
+ items?: PromotionListItem[];
3441
+ page?: Page;
3442
+ };
3443
+ /** @returns {PromotionUpdate} */
3444
+ declare function PromotionUpdate(): PromotionUpdate;
3445
+ type PromotionUpdate = {
3446
+ _custom_json?: any;
3447
+ _schedule?: PromotionSchedule;
3448
+ application_id: string;
3449
+ apply_all_discount?: boolean;
3450
+ apply_exclusive?: string;
3451
+ apply_priority?: number;
3452
+ author?: PromotionAuthor;
3453
+ buy_rules: any;
3454
+ /**
3455
+ * - Only available for Contract pricing and
3456
+ * Ladder pricing promotion type
3457
+ */
3458
+ calculate_on?: string;
3459
+ code?: string;
3460
+ currency?: string;
3461
+ date_meta?: PromotionDateMeta;
3462
+ discount_rules: DiscountRule[];
3463
+ display_meta: DisplayMeta1;
3464
+ mode: string;
3465
+ ownership: Ownership1;
3466
+ post_order_action?: PromotionAction;
3467
+ promo_group: string;
3468
+ promotion_type: string;
3469
+ restrictions?: Restrictions1;
3470
+ stackable?: boolean;
3471
+ visiblility?: Visibility;
3472
+ };
3473
+ /** @returns {RawBreakup} */
3474
+ declare function RawBreakup(): RawBreakup;
3475
+ type RawBreakup = {
3476
+ cod_charge?: number;
3477
+ convenience_fee?: number;
3478
+ coupon?: number;
3479
+ delivery_charge?: number;
3480
+ discount?: number;
3481
+ fynd_cash?: number;
3482
+ gift_card?: number;
3483
+ gst_charges?: number;
3484
+ mrp_total?: number;
3485
+ subtotal?: number;
3486
+ total?: number;
3487
+ vog?: number;
3488
+ you_saved?: number;
3489
+ };
3490
+ /** @returns {Restrictions} */
3491
+ declare function Restrictions(): Restrictions;
3492
+ type Restrictions = {
3493
+ bulk_bundle?: BulkBundleRestriction;
3494
+ coupon_allowed?: boolean;
3495
+ ordering_stores?: number[];
3496
+ payments?: any;
3497
+ platforms?: string[];
3498
+ post_order?: PostOrder;
3499
+ price_range?: PriceRange;
3500
+ user_groups?: number[];
3501
+ user_type?: string;
3502
+ uses?: UsesRestriction;
3503
+ };
3504
+ /** @returns {Restrictions1} */
3505
+ declare function Restrictions1(): Restrictions1;
3506
+ type Restrictions1 = {
3507
+ anonymous_users?: boolean;
3508
+ order_quantity?: number;
3509
+ ordering_stores?: number[];
3510
+ payments?: PromotionPaymentModes[];
3511
+ platforms?: string[];
3512
+ post_order?: PostOrder1;
3513
+ user_groups?: number[];
3514
+ user_id?: string[];
3515
+ user_registered?: any;
3516
+ uses: UsesRestriction1;
3517
+ };
3518
+ /** @returns {Rule} */
3519
+ declare function Rule(): Rule;
3520
+ type Rule = {
3521
+ discount_qty?: number;
3522
+ key?: number;
3523
+ max?: number;
3524
+ min?: number;
3525
+ value?: number;
3526
+ };
3527
+ /** @returns {RuleDefinition} */
3528
+ declare function RuleDefinition(): RuleDefinition;
3529
+ type RuleDefinition = {
3530
+ applicable_on: string;
3531
+ auto_apply?: boolean;
3532
+ calculate_on: string;
3533
+ currency_code?: string;
3534
+ is_exact?: boolean;
3535
+ scope?: string[];
3536
+ type: string;
3537
+ value_type: string;
3538
+ };
3539
+ /** @returns {SaveAddressResponse} */
3540
+ declare function SaveAddressResponse(): SaveAddressResponse;
3541
+ type SaveAddressResponse = {
3542
+ id?: string;
3543
+ is_default_address?: boolean;
3544
+ success?: boolean;
3545
+ };
3546
+ /** @returns {SharedCart} */
3547
+ declare function SharedCart(): SharedCart;
3548
+ type SharedCart = {
3549
+ breakup_values?: CartBreakup;
3550
+ buy_now?: boolean;
3551
+ cart_id?: number;
3552
+ checkout_mode?: string;
3553
+ comment?: string;
3554
+ coupon_text?: string;
3555
+ currency?: CartCurrency;
3556
+ delivery_charge_info?: string;
3557
+ delivery_promise?: ShipmentPromise;
3558
+ gstin?: string;
3559
+ id?: string;
3560
+ is_valid?: boolean;
3561
+ items?: CartProductInfo[];
3562
+ last_modified?: string;
3563
+ message?: string;
3564
+ payment_selection_lock?: PaymentSelectionLock;
3565
+ restrict_checkout?: boolean;
3566
+ shared_cart_details?: SharedCartDetails;
3567
+ uid?: string;
3568
+ };
3569
+ /** @returns {SharedCartDetails} */
3570
+ declare function SharedCartDetails(): SharedCartDetails;
3571
+ type SharedCartDetails = {
3572
+ created_on?: string;
3573
+ /**
3574
+ * - Meta data sent while generating share cart link
3575
+ */
3576
+ meta?: any;
3577
+ /**
3578
+ * - Share link device and other source information
3579
+ */
3580
+ source?: any;
3581
+ /**
3582
+ * - Short link id
3583
+ */
3584
+ token?: string;
3585
+ /**
3586
+ * - User details of who generated share link
3587
+ */
3588
+ user?: any;
3589
+ };
3590
+ /** @returns {SharedCartResponse} */
3591
+ declare function SharedCartResponse(): SharedCartResponse;
3592
+ type SharedCartResponse = {
3593
+ cart?: SharedCart;
3594
+ error?: string;
3595
+ };
3596
+ /** @returns {ShipmentArticle} */
3597
+ declare function ShipmentArticle(): ShipmentArticle;
3598
+ type ShipmentArticle = {
3599
+ article_id?: string;
3600
+ meta?: string;
3601
+ quantity?: string;
3602
+ };
3603
+ /** @returns {ShipmentPromise} */
3604
+ declare function ShipmentPromise(): ShipmentPromise;
3605
+ type ShipmentPromise = {
3606
+ formatted?: PromiseFormatted;
3607
+ timestamp?: PromiseTimestamp;
3608
+ };
3609
+ /** @returns {ShippingAddress} */
3610
+ declare function ShippingAddress(): ShippingAddress;
3611
+ type ShippingAddress = {
3612
+ address?: string;
3613
+ address_type?: string;
3614
+ area?: string;
3615
+ area_code: string;
3616
+ area_code_slug?: string;
3617
+ city?: string;
3618
+ country?: string;
3619
+ country_code?: string;
3620
+ country_iso_code?: string;
3621
+ country_phone_code?: string;
3622
+ email?: string;
3623
+ landmark?: string;
3624
+ meta?: any;
3625
+ name?: string;
3626
+ phone?: number;
3627
+ pincode?: number;
3628
+ state?: string;
3629
+ };
3630
+ /** @returns {StaffCheckout} */
3631
+ declare function StaffCheckout(): StaffCheckout;
3632
+ type StaffCheckout = {
3633
+ _id: string;
3634
+ employee_code?: string;
3635
+ first_name: string;
3636
+ last_name: string;
3637
+ user: string;
3638
+ };
3639
+ /** @returns {State} */
3640
+ declare function State(): State;
3641
+ type State = {
3642
+ is_archived?: boolean;
3643
+ is_display?: boolean;
3644
+ is_public?: boolean;
3645
+ };
3646
+ /** @returns {StoreDetailsResponse} */
3647
+ declare function StoreDetailsResponse(): StoreDetailsResponse;
3648
+ type StoreDetailsResponse = {
3649
+ items?: PickupStoreDetail[];
3650
+ };
3651
+ /** @returns {StoreInfo} */
3652
+ declare function StoreInfo(): StoreInfo;
3653
+ type StoreInfo = {
3654
+ name?: string;
3655
+ store_code?: string;
3656
+ uid?: number;
3657
+ };
3658
+ /** @returns {SuccessMessage} */
3659
+ declare function SuccessMessage(): SuccessMessage;
3660
+ type SuccessMessage = {
3661
+ message?: string;
3662
+ success?: boolean;
3663
+ };
3664
+ /** @returns {Tags} */
3665
+ declare function Tags(): Tags;
3666
+ type Tags = {
3667
+ tags?: any;
3668
+ };
3669
+ /** @returns {UpdateAddressResponse} */
3670
+ declare function UpdateAddressResponse(): UpdateAddressResponse;
3671
+ type UpdateAddressResponse = {
3672
+ id?: string;
3673
+ is_default_address?: boolean;
3674
+ is_updated?: boolean;
3675
+ success?: boolean;
3676
+ };
3677
+ /** @returns {UpdateCartDetailResponse} */
3678
+ declare function UpdateCartDetailResponse(): UpdateCartDetailResponse;
3679
+ type UpdateCartDetailResponse = {
3680
+ cart?: CartDetailResponse;
3681
+ message?: string;
3682
+ /**
3683
+ * - True if all items are added successfully.
3684
+ * False if partially added or not added.
3685
+ */
3686
+ success?: boolean;
3687
+ };
3688
+ /** @returns {UpdateCartPaymentRequest} */
3689
+ declare function UpdateCartPaymentRequest(): UpdateCartPaymentRequest;
3690
+ type UpdateCartPaymentRequest = {
3691
+ address_id?: string;
3692
+ aggregator_name?: string;
3693
+ id?: string;
3694
+ merchant_code?: string;
3695
+ payment_identifier?: string;
3696
+ payment_mode?: string;
3697
+ };
3698
+ /** @returns {UpdateCartPaymentRequestV2} */
3699
+ declare function UpdateCartPaymentRequestV2(): UpdateCartPaymentRequestV2;
3700
+ type UpdateCartPaymentRequestV2 = {
3701
+ address_id?: string;
3702
+ aggregator_name?: string;
3703
+ id?: string;
3704
+ merchant_code?: string;
3705
+ payment_identifier?: string;
3706
+ payment_methods?: PaymentMethod[];
3707
+ payment_mode?: string;
3708
+ };
3709
+ /** @returns {UpdateCartRequest} */
3710
+ declare function UpdateCartRequest(): UpdateCartRequest;
3711
+ type UpdateCartRequest = {
3712
+ items?: UpdateProductCart[];
3713
+ operation: string;
3714
+ };
3715
+ /** @returns {UpdateCartShipmentItem} */
3716
+ declare function UpdateCartShipmentItem(): UpdateCartShipmentItem;
3717
+ type UpdateCartShipmentItem = {
3718
+ /**
3719
+ * - Article mongo id
3720
+ */
3721
+ article_uid: string;
3722
+ /**
3723
+ * - Quantity of product in shipment
3724
+ */
3725
+ quantity?: number;
3726
+ /**
3727
+ * - Shipment delivery type
3728
+ */
3729
+ shipment_type: string;
3730
+ };
3731
+ /** @returns {UpdateCartShipmentRequest} */
3732
+ declare function UpdateCartShipmentRequest(): UpdateCartShipmentRequest;
3733
+ type UpdateCartShipmentRequest = {
3734
+ shipments: UpdateCartShipmentItem[];
3735
+ };
3736
+ /** @returns {UpdateProductCart} */
3737
+ declare function UpdateProductCart(): UpdateProductCart;
3738
+ type UpdateProductCart = {
3739
+ _custom_json?: any;
3740
+ article_id?: string;
3741
+ extra_meta?: any;
3742
+ identifiers: CartProductIdentifer;
3743
+ item_id?: number;
3744
+ item_index?: number;
3745
+ item_size?: string;
3746
+ meta?: any;
3747
+ parent_item_identifiers?: any;
3748
+ quantity?: number;
3749
+ };
3750
+ /** @returns {UpdateUserCartMapping} */
3751
+ declare function UpdateUserCartMapping(): UpdateUserCartMapping;
3752
+ type UpdateUserCartMapping = {
3753
+ user_id: string;
3754
+ };
3755
+ /** @returns {UserCartMappingResponse} */
3756
+ declare function UserCartMappingResponse(): UserCartMappingResponse;
3757
+ type UserCartMappingResponse = {
3758
+ applied_promo_details?: AppliedPromotion[];
3759
+ breakup_values?: CartBreakup;
3760
+ buy_now?: boolean;
3761
+ checkout_mode?: string;
3762
+ comment?: string;
3763
+ coupon_text?: string;
3764
+ currency?: CartCurrency;
3765
+ delivery_charge_info?: string;
3766
+ delivery_promise?: ShipmentPromise;
3767
+ gstin?: string;
3768
+ id?: string;
3769
+ is_valid?: boolean;
3770
+ items?: CartProductInfo[];
3771
+ last_modified?: string;
3772
+ message?: string;
3773
+ pan_config?: any;
3774
+ pan_no?: string;
3775
+ payment_selection_lock?: PaymentSelectionLock;
3776
+ restrict_checkout?: boolean;
3777
+ user?: UserInfo;
3778
+ };
3779
+ /** @returns {UserInfo} */
3780
+ declare function UserInfo(): UserInfo;
3781
+ type UserInfo = {
3782
+ _id?: string;
3783
+ created_at?: string;
3784
+ external_id?: string;
3785
+ first_name?: string;
3786
+ gender?: string;
3787
+ last_name?: string;
3788
+ mobile?: string;
3789
+ modified_on?: string;
3790
+ uid?: string;
3791
+ };
3792
+ /** @returns {UserRegistered} */
3793
+ declare function UserRegistered(): UserRegistered;
3794
+ type UserRegistered = {
3795
+ end?: string;
3796
+ start?: string;
3797
+ };
3798
+ /** @returns {UsesRemaining} */
3799
+ declare function UsesRemaining(): UsesRemaining;
3800
+ type UsesRemaining = {
3801
+ app?: number;
3802
+ total?: number;
3803
+ user?: number;
3804
+ };
3805
+ /** @returns {UsesRemaining1} */
3806
+ declare function UsesRemaining1(): UsesRemaining1;
3807
+ type UsesRemaining1 = {
3808
+ total?: number;
3809
+ user?: number;
3810
+ };
3811
+ /** @returns {UsesRestriction} */
3812
+ declare function UsesRestriction(): UsesRestriction;
3813
+ type UsesRestriction = {
3814
+ maximum?: UsesRemaining;
3815
+ remaining?: UsesRemaining;
3816
+ };
3817
+ /** @returns {UsesRestriction1} */
3818
+ declare function UsesRestriction1(): UsesRestriction1;
3819
+ type UsesRestriction1 = {
3820
+ maximum?: UsesRemaining1;
3821
+ remaining?: UsesRemaining1;
3822
+ };
3823
+ /** @returns {Validation} */
3824
+ declare function Validation(): Validation;
3825
+ type Validation = {
3826
+ anonymous?: boolean;
3827
+ app_id?: string[];
3828
+ user_registered_after?: string;
3829
+ };
3830
+ /** @returns {Validity} */
3831
+ declare function Validity(): Validity;
3832
+ type Validity = {
3833
+ priority?: number;
3834
+ };
3835
+ /** @returns {Visibility} */
3836
+ declare function Visibility(): Visibility;
3837
+ type Visibility = {
3838
+ coupon_list: boolean;
3839
+ pdp: boolean;
3840
+ };