@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (318) hide show
  1. package/documentation/application/CART.md +5934 -4502
  2. package/documentation/application/CATALOG.md +6338 -7245
  3. package/documentation/application/COMMON.md +95 -222
  4. package/documentation/application/COMMUNICATION.md +106 -186
  5. package/documentation/application/CONFIGURATION.md +903 -1597
  6. package/documentation/application/CONTENT.md +562 -1270
  7. package/documentation/application/FILESTORAGE.md +84 -220
  8. package/documentation/application/LEAD.md +314 -660
  9. package/documentation/application/LOGISTIC.md +229 -305
  10. package/documentation/application/ORDER.md +642 -1137
  11. package/documentation/application/PAYMENT.md +2285 -3031
  12. package/documentation/application/POSCART.md +6079 -4642
  13. package/documentation/application/REWARDS.md +94 -248
  14. package/documentation/application/SHARE.md +152 -250
  15. package/documentation/application/THEME.md +952 -1235
  16. package/documentation/application/USER.md +1228 -1765
  17. package/documentation/platform/ANALYTICS.md +207 -349
  18. package/documentation/platform/AUDITTRAIL.md +121 -204
  19. package/documentation/platform/BILLING.md +865 -1376
  20. package/documentation/platform/CART.md +2814 -3662
  21. package/documentation/platform/CATALOG.md +15266 -17619
  22. package/documentation/platform/COMMON.md +95 -222
  23. package/documentation/platform/COMMUNICATION.md +1632 -2380
  24. package/documentation/platform/COMPANYPROFILE.md +572 -957
  25. package/documentation/platform/CONFIGURATION.md +3050 -4073
  26. package/documentation/platform/CONTENT.md +3509 -4121
  27. package/documentation/platform/DISCOUNT.md +140 -236
  28. package/documentation/platform/FILESTORAGE.md +187 -323
  29. package/documentation/platform/INVENTORY.md +268 -911
  30. package/documentation/platform/LEAD.md +2195 -2541
  31. package/documentation/platform/ORDER.md +3750 -5636
  32. package/documentation/platform/PARTNER.md +9 -36
  33. package/documentation/platform/PAYMENT.md +903 -1213
  34. package/documentation/platform/REWARDS.md +183 -347
  35. package/documentation/platform/SHARE.md +120 -213
  36. package/documentation/platform/THEME.md +12956 -13239
  37. package/documentation/platform/USER.md +975 -1120
  38. package/documentation/platform/WEBHOOK.md +78 -184
  39. package/documentation/public/CONFIGURATION.md +95 -222
  40. package/documentation/public/INVENTORY.md +100 -282
  41. package/documentation/public/WEBHOOK.md +27 -133
  42. package/package.json +1 -1
  43. package/sdk/application/ApplicationConfig.js +1 -1
  44. package/sdk/application/Cart/CartApplicationClient.d.ts +243 -243
  45. package/sdk/application/Cart/CartApplicationClient.js +1058 -547
  46. package/sdk/application/Cart/CartApplicationModel.d.ts +64 -63
  47. package/sdk/application/Cart/CartApplicationModel.js +489 -886
  48. package/sdk/application/Cart/CartApplicationValidator.d.ts +17 -17
  49. package/sdk/application/Cart/CartApplicationValidator.js +98 -98
  50. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +358 -358
  51. package/sdk/application/Catalog/CatalogApplicationClient.js +1545 -949
  52. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +90 -90
  53. package/sdk/application/Catalog/CatalogApplicationModel.js +692 -1258
  54. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +19 -19
  55. package/sdk/application/Catalog/CatalogApplicationValidator.js +110 -110
  56. package/sdk/application/Common/CommonApplicationClient.d.ts +13 -13
  57. package/sdk/application/Common/CommonApplicationClient.js +76 -36
  58. package/sdk/application/Common/CommonApplicationModel.d.ts +12 -12
  59. package/sdk/application/Common/CommonApplicationModel.js +83 -160
  60. package/sdk/application/Common/CommonApplicationValidator.d.ts +1 -1
  61. package/sdk/application/Common/CommonApplicationValidator.js +6 -6
  62. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +11 -11
  63. package/sdk/application/Communication/CommunicationApplicationClient.js +92 -31
  64. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +6 -6
  65. package/sdk/application/Communication/CommunicationApplicationModel.js +38 -83
  66. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
  67. package/sdk/application/Communication/CommunicationApplicationValidator.js +4 -4
  68. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +116 -116
  69. package/sdk/application/Configuration/ConfigurationApplicationClient.js +638 -312
  70. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +85 -85
  71. package/sdk/application/Configuration/ConfigurationApplicationModel.js +480 -851
  72. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +8 -8
  73. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +33 -33
  74. package/sdk/application/Content/ContentApplicationClient.d.ts +67 -67
  75. package/sdk/application/Content/ContentApplicationClient.js +581 -213
  76. package/sdk/application/Content/ContentApplicationModel.d.ts +76 -75
  77. package/sdk/application/Content/ContentApplicationModel.js +468 -875
  78. package/sdk/application/Content/ContentApplicationValidator.d.ts +5 -5
  79. package/sdk/application/Content/ContentApplicationValidator.js +24 -24
  80. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +25 -25
  81. package/sdk/application/FileStorage/FileStorageApplicationClient.js +121 -59
  82. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +13 -13
  83. package/sdk/application/FileStorage/FileStorageApplicationModel.js +86 -169
  84. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
  85. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +7 -7
  86. package/sdk/application/Lead/LeadApplicationClient.d.ts +24 -24
  87. package/sdk/application/Lead/LeadApplicationClient.js +230 -96
  88. package/sdk/application/Lead/LeadApplicationModel.d.ts +35 -35
  89. package/sdk/application/Lead/LeadApplicationModel.js +267 -474
  90. package/sdk/application/Lead/LeadApplicationValidator.d.ts +2 -2
  91. package/sdk/application/Lead/LeadApplicationValidator.js +11 -11
  92. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +30 -19
  93. package/sdk/application/Logistic/LogisticApplicationClient.js +196 -47
  94. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +17 -14
  95. package/sdk/application/Logistic/LogisticApplicationModel.js +133 -201
  96. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +3 -2
  97. package/sdk/application/Logistic/LogisticApplicationValidator.js +14 -8
  98. package/sdk/application/Order/OrderApplicationClient.d.ts +86 -86
  99. package/sdk/application/Order/OrderApplicationClient.js +448 -215
  100. package/sdk/application/Order/OrderApplicationModel.d.ts +50 -50
  101. package/sdk/application/Order/OrderApplicationModel.js +357 -661
  102. package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -7
  103. package/sdk/application/Order/OrderApplicationValidator.js +28 -28
  104. package/sdk/application/Payment/PaymentApplicationClient.d.ts +318 -318
  105. package/sdk/application/Payment/PaymentApplicationClient.js +1525 -750
  106. package/sdk/application/Payment/PaymentApplicationModel.d.ts +72 -72
  107. package/sdk/application/Payment/PaymentApplicationModel.js +565 -1033
  108. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +28 -28
  109. package/sdk/application/Payment/PaymentApplicationValidator.js +107 -107
  110. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +254 -254
  111. package/sdk/application/PosCart/PosCartApplicationClient.js +1137 -606
  112. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +61 -60
  113. package/sdk/application/PosCart/PosCartApplicationModel.js +477 -873
  114. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +18 -18
  115. package/sdk/application/PosCart/PosCartApplicationValidator.js +103 -103
  116. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +27 -27
  117. package/sdk/application/Rewards/RewardsApplicationClient.js +253 -113
  118. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +14 -14
  119. package/sdk/application/Rewards/RewardsApplicationModel.js +96 -191
  120. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +3 -3
  121. package/sdk/application/Rewards/RewardsApplicationValidator.js +12 -12
  122. package/sdk/application/Share/ShareApplicationClient.d.ts +37 -37
  123. package/sdk/application/Share/ShareApplicationClient.js +221 -96
  124. package/sdk/application/Share/ShareApplicationModel.d.ts +8 -8
  125. package/sdk/application/Share/ShareApplicationModel.js +63 -123
  126. package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -4
  127. package/sdk/application/Share/ShareApplicationValidator.js +12 -12
  128. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  129. package/sdk/application/Theme/ThemeApplicationClient.js +115 -37
  130. package/sdk/application/Theme/ThemeApplicationModel.d.ts +34 -34
  131. package/sdk/application/Theme/ThemeApplicationModel.js +190 -336
  132. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +1 -1
  133. package/sdk/application/Theme/ThemeApplicationValidator.js +4 -4
  134. package/sdk/application/User/UserApplicationClient.d.ts +280 -280
  135. package/sdk/application/User/UserApplicationClient.js +1201 -543
  136. package/sdk/application/User/UserApplicationModel.d.ts +79 -72
  137. package/sdk/application/User/UserApplicationModel.js +440 -689
  138. package/sdk/application/User/UserApplicationValidator.d.ts +24 -24
  139. package/sdk/application/User/UserApplicationValidator.js +89 -89
  140. package/sdk/common/AxiosHelper.js +1 -1
  141. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +55 -47
  142. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +308 -151
  143. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +6 -6
  144. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +20 -20
  145. package/sdk/platform/Analytics/AnalyticsPlatformClient.d.ts +8 -4
  146. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +103 -16
  147. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +11 -11
  148. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +95 -178
  149. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +16 -12
  150. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +131 -44
  151. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +10 -10
  152. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +50 -89
  153. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
  154. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +6 -6
  155. package/sdk/platform/Billing/BillingPlatformClient.d.ts +68 -56
  156. package/sdk/platform/Billing/BillingPlatformClient.js +416 -171
  157. package/sdk/platform/Billing/BillingPlatformModel.d.ts +40 -40
  158. package/sdk/platform/Billing/BillingPlatformModel.js +342 -668
  159. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +8 -8
  160. package/sdk/platform/Billing/BillingPlatformValidator.js +25 -25
  161. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +176 -159
  162. package/sdk/platform/Cart/CartPlatformApplicationClient.js +837 -500
  163. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -11
  164. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +63 -63
  165. package/sdk/platform/Cart/CartPlatformModel.d.ts +86 -85
  166. package/sdk/platform/Cart/CartPlatformModel.js +677 -1211
  167. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +582 -529
  168. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2642 -1533
  169. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +40 -40
  170. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +175 -175
  171. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +708 -590
  172. package/sdk/platform/Catalog/CatalogPlatformClient.js +3103 -1362
  173. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +293 -284
  174. package/sdk/platform/Catalog/CatalogPlatformModel.js +2149 -3660
  175. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +66 -64
  176. package/sdk/platform/Catalog/CatalogPlatformValidator.js +235 -216
  177. package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -12
  178. package/sdk/platform/Common/CommonPlatformClient.js +80 -37
  179. package/sdk/platform/Common/CommonPlatformModel.d.ts +12 -12
  180. package/sdk/platform/Common/CommonPlatformModel.js +83 -160
  181. package/sdk/platform/Common/CommonPlatformValidator.d.ts +1 -1
  182. package/sdk/platform/Common/CommonPlatformValidator.js +6 -6
  183. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +333 -293
  184. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1687 -855
  185. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +30 -30
  186. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +87 -87
  187. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
  188. package/sdk/platform/Communication/CommunicationPlatformClient.js +28 -4
  189. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +67 -67
  190. package/sdk/platform/Communication/CommunicationPlatformModel.js +522 -974
  191. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +70 -57
  192. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +463 -182
  193. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +28 -28
  194. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +294 -557
  195. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +7 -7
  196. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +24 -24
  197. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +175 -137
  198. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1168 -521
  199. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +22 -21
  200. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +69 -63
  201. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +137 -119
  202. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +691 -316
  203. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +148 -146
  204. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +854 -1508
  205. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -9
  206. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +38 -38
  207. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +542 -461
  208. package/sdk/platform/Content/ContentPlatformApplicationClient.js +2600 -1160
  209. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +50 -49
  210. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +159 -152
  211. package/sdk/platform/Content/ContentPlatformModel.d.ts +79 -75
  212. package/sdk/platform/Content/ContentPlatformModel.js +486 -867
  213. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +72 -61
  214. package/sdk/platform/Discount/DiscountPlatformClient.js +424 -198
  215. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +7 -7
  216. package/sdk/platform/Discount/DiscountPlatformModel.js +60 -121
  217. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +6 -6
  218. package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -29
  219. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +26 -22
  220. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +145 -59
  221. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  222. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +8 -8
  223. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +58 -52
  224. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +240 -114
  225. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -13
  226. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +86 -169
  227. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +3 -3
  228. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -11
  229. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +76 -63
  230. package/sdk/platform/Inventory/InventoryPlatformClient.js +461 -197
  231. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +30 -30
  232. package/sdk/platform/Inventory/InventoryPlatformModel.js +497 -964
  233. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +7 -7
  234. package/sdk/platform/Inventory/InventoryPlatformValidator.js +28 -28
  235. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +84 -71
  236. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +441 -182
  237. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +7 -7
  238. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +28 -28
  239. package/sdk/platform/Lead/LeadPlatformClient.d.ts +86 -75
  240. package/sdk/platform/Lead/LeadPlatformClient.js +434 -212
  241. package/sdk/platform/Lead/LeadPlatformModel.d.ts +35 -35
  242. package/sdk/platform/Lead/LeadPlatformModel.js +267 -474
  243. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +6 -6
  244. package/sdk/platform/Lead/LeadPlatformValidator.js +24 -24
  245. package/sdk/platform/OAuthClient.js +8 -8
  246. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +14 -11
  247. package/sdk/platform/Order/OrderPlatformApplicationClient.js +113 -49
  248. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -1
  249. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +6 -6
  250. package/sdk/platform/Order/OrderPlatformClient.d.ts +367 -315
  251. package/sdk/platform/Order/OrderPlatformClient.js +1775 -893
  252. package/sdk/platform/Order/OrderPlatformModel.d.ts +198 -192
  253. package/sdk/platform/Order/OrderPlatformModel.js +1591 -2822
  254. package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -32
  255. package/sdk/platform/Order/OrderPlatformValidator.js +160 -155
  256. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -2
  257. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +52 -8
  258. package/sdk/platform/Partner/PartnerPlatformModel.js +6 -22
  259. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +65 -54
  260. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +395 -164
  261. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -6
  262. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +23 -23
  263. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +55 -45
  264. package/sdk/platform/Payment/PaymentPlatformClient.js +362 -147
  265. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -27
  266. package/sdk/platform/Payment/PaymentPlatformModel.js +220 -408
  267. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +4 -4
  268. package/sdk/platform/Payment/PaymentPlatformValidator.js +21 -21
  269. package/sdk/platform/PlatformApplicationClient.d.ts +1496 -10153
  270. package/sdk/platform/PlatformApplicationClient.js +1584 -13691
  271. package/sdk/platform/PlatformClient.d.ts +7918 -7666
  272. package/sdk/platform/PlatformClient.js +8701 -9926
  273. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +91 -78
  274. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +507 -253
  275. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +8 -8
  276. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +34 -34
  277. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +15 -15
  278. package/sdk/platform/Rewards/RewardsPlatformModel.js +92 -194
  279. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -12
  280. package/sdk/platform/Share/SharePlatformApplicationClient.js +130 -52
  281. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
  282. package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -6
  283. package/sdk/platform/Share/SharePlatformModel.d.ts +8 -8
  284. package/sdk/platform/Share/SharePlatformModel.js +60 -118
  285. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +148 -124
  286. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +770 -295
  287. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +15 -15
  288. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +44 -44
  289. package/sdk/platform/Theme/ThemePlatformModel.d.ts +34 -34
  290. package/sdk/platform/Theme/ThemePlatformModel.js +190 -336
  291. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +146 -67
  292. package/sdk/platform/User/UserPlatformApplicationClient.js +742 -155
  293. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +12 -7
  294. package/sdk/platform/User/UserPlatformApplicationValidator.js +61 -23
  295. package/sdk/platform/User/UserPlatformModel.d.ts +79 -72
  296. package/sdk/platform/User/UserPlatformModel.js +440 -689
  297. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +35 -29
  298. package/sdk/platform/Webhook/WebhookPlatformClient.js +218 -91
  299. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +7 -7
  300. package/sdk/platform/Webhook/WebhookPlatformModel.js +68 -136
  301. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +3 -3
  302. package/sdk/platform/Webhook/WebhookPlatformValidator.js +14 -14
  303. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +13 -13
  304. package/sdk/public/Configuration/ConfigurationPublicClient.js +81 -38
  305. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +12 -12
  306. package/sdk/public/Configuration/ConfigurationPublicModel.js +85 -162
  307. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -1
  308. package/sdk/public/Configuration/ConfigurationPublicValidator.js +6 -6
  309. package/sdk/public/Inventory/InventoryPublicClient.d.ts +34 -34
  310. package/sdk/public/Inventory/InventoryPublicClient.js +228 -105
  311. package/sdk/public/Inventory/InventoryPublicModel.d.ts +10 -10
  312. package/sdk/public/Inventory/InventoryPublicModel.js +119 -245
  313. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +3 -3
  314. package/sdk/public/Inventory/InventoryPublicValidator.js +15 -15
  315. package/sdk/public/Webhook/WebhookPublicClient.js +51 -10
  316. package/sdk/public/Webhook/WebhookPublicModel.d.ts +7 -7
  317. package/sdk/public/Webhook/WebhookPublicModel.js +68 -136
  318. package/tests/application/catalog.spec.js +7 -0
@@ -5,509 +5,297 @@ declare class Catalog {
5
5
  applicationId: any;
6
6
  /**
7
7
  * @param {Object} arg - Arg object.
8
- * @param {string} arg.id - A `id` is a unique identifier for a particular
9
- * detail. Pass the `id` of the keywords which you want to retrieve.
10
- * @summary: Get a Search Keywords Details
11
- * @description: Get the details of a words by its `id`. If successful, returns a Collection resource in the response body specified in `GetSearchWordsDetailResponseSchema`
12
- */
13
- getSearchKeywords({ id }?: {
14
- id: string;
15
- }): Promise<any>;
16
- /**
17
- * @param {Object} arg - Arg object.
18
- * @param {string} arg.id - A `id` is a unique identifier for a particular
19
- * detail. Pass the `id` of the keywords which you want to delete.
20
- * @param {CreateSearchKeyword} arg.body
21
- * @summary: Update Search Keyword
22
- * @description: Update Search Keyword by its id. On successful request, returns the updated collection
23
- */
24
- updateSearchKeywords({ id, body }?: {
25
- id: string;
26
- body: CreateSearchKeyword;
27
- }): Promise<any>;
28
- /**
29
- * @param {Object} arg - Arg object.
30
- * @param {string} arg.id - A `id` is a unique identifier for a particular
31
- * detail. Pass the `id` of the keywords which you want to delete.
32
- * @summary: Delete a Search Keywords
33
- * @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully
34
- */
35
- deleteSearchKeywords({ id }?: {
36
- id: string;
37
- }): Promise<any>;
38
- /**
39
- * @param {Object} arg - Arg object.
40
- * @summary: List all Search Custom Keyword Listing
41
- * @description: Custom Search Keyword allows you to map conditions with keywords to give you the ultimate results
42
- */
43
- getAllSearchKeyword({}?: any): Promise<any>;
44
- /**
45
- * @param {Object} arg - Arg object.
46
- * @param {CreateSearchKeyword} arg.body
47
- * @summary: Add a Custom Search Keywords
48
- * @description: Create a Custom Search Keywords. See `CreateSearchKeywordSchema` for the list of attributes needed to create a mapping and /collections/query-options for the available options to create a rule. On successful request, returns a paginated list of collections specified in `CreateSearchKeywordSchema`
49
- */
50
- createCustomKeyword({ body }?: {
51
- body: CreateSearchKeyword;
52
- }): Promise<any>;
53
- /**
54
- * @param {Object} arg - Arg object.
55
- * @param {string} arg.id - A `id` is a unique identifier for a particular
56
- * detail. Pass the `id` of the keywords which you want to retrieve.
57
- * @summary: Get a Autocomplete Keywords Details
58
- * @description: Get the details of a words by its `id`. If successful, returns a keywords resource in the response body specified in `GetAutocompleteWordsResponseSchema`
8
+ * @param {string} arg.id - A `id` is a unique identifier of a collection.
9
+ * @param {CollectionItemUpdate} arg.body
10
+ * @returns {Promise<UpdatedResponse>} - Success response
11
+ * @summary: Add items to a collection
12
+ * @description: Adds items to a collection specified by its `id`. See `CollectionItemRequest` for the list of attributes needed to add items to an collection.
59
13
  */
60
- getAutocompleteKeywordDetail({ id }?: {
14
+ addCollectionItems({ id, body }?: {
61
15
  id: string;
62
- }): Promise<any>;
16
+ body: CollectionItemUpdate;
17
+ }): Promise<UpdatedResponse>;
63
18
  /**
64
19
  * @param {Object} arg - Arg object.
65
- * @param {string} arg.id - A `id` is a unique identifier for a particular
66
- * detail. Pass the `id` of the keywords which you want to delete.
67
- * @param {CreateAutocompleteKeyword} arg.body
68
- * @summary: Create & Update Autocomplete Keyword
69
- * @description: Update a mapping by it's id. On successful request, returns the updated Keyword mapping
20
+ * @param {CreateCollection} arg.body
21
+ * @returns {Promise<CollectionCreateResponse>} - Success response
22
+ * @summary: Add a Collection
23
+ * @description: Create a collection. See `CreateCollectionRequestSchema` for the list of attributes needed to create a collection and collections/query-options for the available options to create a collection. On successful request, returns a paginated list of collections specified in `CollectionCreateResponse`
70
24
  */
71
- updateAutocompleteKeyword({ id, body }?: {
72
- id: string;
73
- body: CreateAutocompleteKeyword;
74
- }): Promise<any>;
25
+ createCollection({ body }?: {
26
+ body: CreateCollection;
27
+ }): Promise<CollectionCreateResponse>;
75
28
  /**
76
29
  * @param {Object} arg - Arg object.
77
- * @param {string} arg.id - A `id` is a unique identifier for a particular
78
- * detail. Pass the `id` of the keywords which you want to delete.
79
- * @summary: Delete a Autocomplete Keywords
80
- * @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully
30
+ * @param {string} arg.type - Type can be brands, categories etc.
31
+ * @param {AppConfiguration} arg.body
32
+ * @returns {Promise<GetAppCatalogConfiguration>} - Success response
33
+ * @summary: Add configuration for categories and brands
34
+ * @description: Add configuration for categories & brands.
81
35
  */
82
- deleteAutocompleteKeyword({ id }?: {
83
- id: string;
84
- }): Promise<any>;
36
+ createConfigurationByType({ type, body }?: {
37
+ type: string;
38
+ body: AppConfiguration;
39
+ }): Promise<GetAppCatalogConfiguration>;
85
40
  /**
86
41
  * @param {Object} arg - Arg object.
87
- * @summary: List all Autocomplete Keyword Listing
88
- * @description: Custom Autocomplete Keyword allows you to map conditions with keywords to give you the ultimate results
42
+ * @param {AppConfiguration} arg.body
43
+ * @returns {Promise<GetAppCatalogConfiguration>} - Success response
44
+ * @summary: Add configuration for products & listings
45
+ * @description: Add configuration for products & listing.
89
46
  */
90
- getAutocompleteConfig({}?: any): Promise<any>;
47
+ createConfigurationProductListing({ body }?: {
48
+ body: AppConfiguration;
49
+ }): Promise<GetAppCatalogConfiguration>;
91
50
  /**
92
51
  * @param {Object} arg - Arg object.
93
52
  * @param {CreateAutocompleteKeyword} arg.body
53
+ * @returns {Promise<CreateAutocompleteWordsResponse>} - Success response
94
54
  * @summary: Add a Custom Autocomplete Keywords
95
55
  * @description: Create a Custom Autocomplete Keywords. See `CreateAutocompleteKeywordSchema` for the list of attributes needed to create a mapping and /collections/query-options for the available options to create a rule. On successful request, returns a paginated list of collections specified in `CreateAutocompleteKeywordSchema`
96
56
  */
97
57
  createCustomAutocompleteRule({ body }?: {
98
58
  body: CreateAutocompleteKeyword;
99
- }): Promise<any>;
100
- /**
101
- * @param {Object} arg - Arg object.
102
- * @param {string} arg.itemId - Product id for a particular product.
103
- * @summary: Get company application product data.
104
- * @description: Products are the core resource of an application. If successful, returns a Company Application Product resource in the response body depending upon filter sent.
105
- */
106
- getAppProduct({ itemId }?: {
107
- itemId: string;
108
- }): Promise<any>;
109
- /**
110
- * @param {Object} arg - Arg object.
111
- * @param {string} arg.itemId - Product id for which the custom_meta is associated.
112
- * @param {ApplicationItemMeta} arg.body
113
- * @summary: Update a single custom meta.
114
- * @description: This API helps to update data associated to a item custom meta.
115
- */
116
- updateAppProduct({ itemId, body }?: {
117
- itemId: string;
118
- body: ApplicationItemMeta;
119
- }): Promise<any>;
120
- /**
121
- * @param {Object} arg - Arg object.
122
- * @param {string} arg.configType - A `config_type` is an identifier that
123
- * defines a specific type of configuration.
124
- * @param {string} [arg.templateSlug] - Get configuration list filtered by
125
- * `template_slug` string. This is for the details and comparision groups.
126
- * @summary: Get configuration metadata details for catalog for admin panel
127
- * @description: Get the configuraion metadata details for catalog.
128
- */
129
- getConfigurationMetadata({ configType, templateSlug }?: {
130
- configType: string;
131
- templateSlug?: string;
132
- }): Promise<any>;
59
+ }): Promise<CreateAutocompleteWordsResponse>;
133
60
  /**
134
61
  * @param {Object} arg - Arg object.
135
- * @param {string} arg.configType - A `config_type` is an identifier that
136
- * defines a specific type of configuration.
137
- * @param {number} [arg.pageNo] - The page number to navigate through the
138
- * given set of results.
139
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
140
- * page. Default is 12.
141
- * @param {string} [arg.search] - Get configuration list filtered by `search` string.
142
- * @param {string} [arg.templateSlug] - Get configuration list filtered by
143
- * `template_slug` string. This is for the details and comparision groups.
144
- * @summary: Get the details of the application configured configurations of group config types.
145
- * @description: Get the details of the application configured configurations of group config types.
62
+ * @param {CreateSearchKeyword} arg.body
63
+ * @returns {Promise<GetSearchWordsData>} - Success response
64
+ * @summary: Add a Custom Search Keywords
65
+ * @description: Create a Custom Search Keywords. See `CreateSearchKeywordSchema` for the list of attributes needed to create a mapping and /collections/query-options for the available options to create a rule. On successful request, returns a paginated list of collections specified in `CreateSearchKeywordSchema`
146
66
  */
147
- getGroupConfigurations({ configType, pageNo, pageSize, search, templateSlug, }?: {
148
- configType: string;
149
- pageNo?: number;
150
- pageSize?: number;
151
- search?: string;
152
- templateSlug?: string;
153
- }): Promise<any>;
67
+ createCustomKeyword({ body }?: {
68
+ body: CreateSearchKeyword;
69
+ }): Promise<GetSearchWordsData>;
154
70
  /**
155
71
  * @param {Object} arg - Arg object.
156
72
  * @param {string} arg.configType - A `config_type` is a unique identifier
157
73
  * for a particular group configuration type.
158
74
  * @param {AppConfigurationDetail} arg.body
75
+ * @returns {Promise<AppConfigurationDetail>} - Success response
159
76
  * @summary: Create configuration for Group config types.
160
77
  * @description: Create configuration for Group config types.
161
78
  */
162
79
  createGroupConfiguration({ configType, body }?: {
163
80
  configType: string;
164
81
  body: AppConfigurationDetail;
165
- }): Promise<any>;
82
+ }): Promise<AppConfigurationDetail>;
166
83
  /**
167
84
  * @param {Object} arg - Arg object.
168
85
  * @param {string} arg.configType - A `config_type` is a unique identifier
169
- * for a particular group configuration type.
170
- * @param {string} arg.groupSlug - A `group_slug` is a unique identifier of
171
- * a particular configuration.
172
- * @param {AppConfigurationDetail} arg.body
173
- * @summary: Update the group configurations for the application.
174
- * @description: Update the group configurations for the application.
86
+ * for a particular listing configuration type.
87
+ * @param {AppConfigurationsSort} arg.body
88
+ * @returns {Promise<AppConfigurationsSort>} - Success response
89
+ * @summary: Add configuration for listings
90
+ * @description: Add configuration for listing.
175
91
  */
176
- updateGroupConfiguration({ configType, groupSlug, body }?: {
92
+ createListingConfiguration({ configType, body }?: {
177
93
  configType: string;
178
- groupSlug: string;
179
- body: AppConfigurationDetail;
180
- }): Promise<any>;
94
+ body: AppConfigurationsSort;
95
+ }): Promise<AppConfigurationsSort>;
96
+ /**
97
+ * @param {Object} arg - Arg object.
98
+ * @param {string} arg.id - A `id` is a unique identifier for a particular
99
+ * detail. Pass the `id` of the keywords which you want to delete.
100
+ * @returns {Promise<DeleteResponse>} - Success response
101
+ * @summary: Delete a Autocomplete Keywords
102
+ * @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully
103
+ */
104
+ deleteAutocompleteKeyword({ id }?: {
105
+ id: string;
106
+ }): Promise<DeleteResponse>;
107
+ /**
108
+ * @param {Object} arg - Arg object.
109
+ * @param {string} arg.id - A `id` is a unique identifier of a collection.
110
+ * @returns {Promise<DeleteResponse>} - Success response
111
+ * @summary: Delete a Collection
112
+ * @description: Delete a collection by it's id. Returns an object that tells whether the collection was deleted successfully
113
+ */
114
+ deleteCollection({ id }?: {
115
+ id: string;
116
+ }): Promise<DeleteResponse>;
181
117
  /**
182
118
  * @param {Object} arg - Arg object.
183
119
  * @param {string} arg.configType - A `config_type` is a unique identifier
184
120
  * for a particular group configuration type.
185
121
  * @param {string} arg.groupSlug - A `group_slug` is a unique identifier of
186
122
  * a particular configuration.
123
+ * @returns {Promise<ConfigSuccessResponse>} - Success response
187
124
  * @summary: Delete configuration of the product config type of the application.
188
125
  * @description: Delete configuration of the product config type of the application.
189
126
  */
190
127
  deleteGroupConfiguration({ configType, groupSlug }?: {
191
128
  configType: string;
192
129
  groupSlug: string;
193
- }): Promise<any>;
194
- /**
195
- * @param {Object} arg - Arg object.
196
- * @param {string} arg.configType - A `config_type` is an identifier that
197
- * defines a specific type of configuration.
198
- * @param {number} [arg.pageNo] - The page number to navigate through the
199
- * given set of results.
200
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
201
- * page. Default is 12.
202
- * @param {string} [arg.search] - Get configuration list filtered by `search` string.
203
- * @summary: Get the details of the application configured configurations of listing config types.
204
- * @description: Get the details of the application configured configurations of listing config types.
205
- */
206
- getListingConfigurations({ configType, pageNo, pageSize, search }?: {
207
- configType: string;
208
- pageNo?: number;
209
- pageSize?: number;
210
- search?: string;
211
- }): Promise<any>;
212
- /**
213
- * @param {Object} arg - Arg object.
214
- * @param {string} arg.configType - A `config_type` is a unique identifier
215
- * for a particular listing configuration type.
216
- * @param {AppConfigurationsSort} arg.body
217
- * @summary: Add configuration for listings
218
- * @description: Add configuration for listing.
219
- */
220
- createListingConfiguration({ configType, body }?: {
221
- configType: string;
222
- body: AppConfigurationsSort;
223
- }): Promise<any>;
224
- /**
225
- * @param {Object} arg - Arg object.
226
- * @param {string} arg.configType - A `config_type` is a unique identifier
227
- * for a particular listing configuration type.
228
- * @param {string} arg.configId - A `config_id` is a unique identifier of a
229
- * particular configuration.
230
- * @param {AppConfigurationsSort} arg.body
231
- * @summary: Update configuration for listings
232
- * @description: Update configuration for listing.
233
- */
234
- updateListingConfiguration({ configType, configId, body }?: {
235
- configType: string;
236
- configId: string;
237
- body: AppConfigurationsSort;
238
- }): Promise<any>;
130
+ }): Promise<ConfigSuccessResponse>;
239
131
  /**
240
132
  * @param {Object} arg - Arg object.
241
133
  * @param {string} arg.configType - A `config_type` is a unique identifier
242
134
  * for a particular listing configuration type.
243
135
  * @param {string} arg.configId - A `config_id` is a unique identifier of a
244
136
  * particular configuration.
137
+ * @returns {Promise<ConfigSuccessResponse>} - Success response
245
138
  * @summary: Delete configuration for listings
246
139
  * @description: Delete configuration for listing.
247
140
  */
248
141
  deleteListingConfiguration({ configType, configId }?: {
249
142
  configType: string;
250
143
  configId: string;
251
- }): Promise<any>;
252
- /**
253
- * @param {Object} arg - Arg object.
254
- * @param {AllowSingleRequest} arg.body
255
- * @summary: Update allow single flag for filters of the application.
256
- * @description: Update allow single flag for filters of the application.
257
- */
258
- updateAllowSingle({ body }?: {
259
- body: AllowSingleRequest;
260
- }): Promise<any>;
144
+ }): Promise<ConfigSuccessResponse>;
261
145
  /**
262
146
  * @param {Object} arg - Arg object.
263
- * @param {DefaultKeyRequest} arg.body
264
- * @summary: Update the default sort key configuration for the application.
265
- * @description: Update the default sort key configuration for the application.
147
+ * @param {string} arg.id - A `id` is a unique identifier for a particular
148
+ * detail. Pass the `id` of the keywords which you want to delete.
149
+ * @returns {Promise<DeleteResponse>} - Success response
150
+ * @summary: Delete a Search Keywords
151
+ * @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully
266
152
  */
267
- updateDefaultSort({ body }?: {
268
- body: DefaultKeyRequest;
269
- }): Promise<any>;
153
+ deleteSearchKeywords({ id }?: {
154
+ id: string;
155
+ }): Promise<DeleteResponse>;
270
156
  /**
271
157
  * @param {Object} arg - Arg object.
272
- * @summary: Get configuration meta details for catalog for admin panel
273
- * @description: configuration meta details for catalog.
158
+ * @param {string} [arg.q] - Get collection list filtered by q string,
159
+ * @param {string} [arg.scheduleStatus] - Get collection list filtered by
160
+ * scheduled status,
161
+ * @param {string} [arg.type] - Type of the collections
162
+ * @param {string[]} [arg.tags] - Each response will contain next_id param,
163
+ * which should be sent back to make pagination work.
164
+ * @param {boolean} [arg.isActive] - Get collections filtered by active status.
165
+ * @param {number} [arg.pageNo] - The page number to navigate through the
166
+ * given set of results.
167
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
168
+ * page. Default is 12.
169
+ * @returns {Promise<GetCollectionListingResponse>} - Success response
170
+ * @summary: List all the collections
171
+ * @description: A Collection allows you to organize your products into hierarchical groups. For example, a dress might be in the category _Clothing_, the individual product might also be in the collection _Summer_. On successful request, returns all the collections as specified in `CollectionListingSchema`
274
172
  */
275
- getCatalogConfiguration({}?: any): Promise<any>;
173
+ getAllCollections({ q, scheduleStatus, type, tags, isActive, pageNo, pageSize, }?: {
174
+ q?: string;
175
+ scheduleStatus?: string;
176
+ type?: string;
177
+ tags?: string[];
178
+ isActive?: boolean;
179
+ pageNo?: number;
180
+ pageSize?: number;
181
+ }): Promise<GetCollectionListingResponse>;
276
182
  /**
277
183
  * @param {Object} arg - Arg object.
278
- * @summary: Get configured details for catalog
279
- * @description: configured details for catalog.
184
+ * @returns {Promise<GetSearchWordsResponse>} - Success response
185
+ * @summary: List all Search Custom Keyword Listing
186
+ * @description: Custom Search Keyword allows you to map conditions with keywords to give you the ultimate results
280
187
  */
281
- getConfigurations({}?: any): Promise<any>;
188
+ getAllSearchKeyword({}?: any): Promise<GetSearchWordsResponse>;
282
189
  /**
283
190
  * @param {Object} arg - Arg object.
284
- * @param {AppConfiguration} arg.body
285
- * @summary: Add configuration for products & listings
286
- * @description: Add configuration for products & listing.
287
- */
288
- createConfigurationProductListing({ body }?: {
289
- body: AppConfiguration;
290
- }): Promise<any>;
291
- /**
292
- * @param {Object} arg - Arg object.
293
- * @param {string} arg.type - Type can be brands, categories etc.
294
- * @summary: Get configured details for catalog
295
- * @description: configured details for catalog.
296
- */
297
- getConfigurationByType({ type }?: {
298
- type: string;
299
- }): Promise<any>;
300
- /**
301
- * @param {Object} arg - Arg object.
302
- * @param {string} arg.type - Type can be brands, categories etc.
303
- * @param {AppConfiguration} arg.body
304
- * @summary: Add configuration for categories and brands
305
- * @description: Add configuration for categories & brands.
306
- */
307
- createConfigurationByType({ type, body }?: {
308
- type: string;
309
- body: AppConfiguration;
310
- }): Promise<any>;
311
- /**
312
- * @param {Object} arg - Arg object.
313
- * @summary: Get query filters to configure a collection
314
- * @description: Get query filters to configure a collection
315
- */
316
- getQueryFilters({}?: any): Promise<any>;
317
- /**
318
- * @param {Object} arg - Arg object.
319
- * @param {string} [arg.q] - Get collection list filtered by q string,
320
- * @param {string} [arg.scheduleStatus] - Get collection list filtered by
321
- * scheduled status,
322
- * @param {string} [arg.type] - Type of the collections
323
- * @param {string[]} [arg.tags] - Each response will contain next_id param,
324
- * which should be sent back to make pagination work.
325
- * @param {boolean} [arg.isActive] - Get collections filtered by active status.
326
- * @param {number} [arg.pageNo] - The page number to navigate through the
327
- * given set of results.
328
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
329
- * page. Default is 12.
330
- * @summary: List all the collections
331
- * @description: A Collection allows you to organize your products into hierarchical groups. For example, a dress might be in the category _Clothing_, the individual product might also be in the collection _Summer_. On successful request, returns all the collections as specified in `CollectionListingSchema`
191
+ * @param {number[]} [arg.itemIds] - The Item Id of the product.
192
+ * @param {number[]} [arg.storeIds] - The Store Id of products to fetch inventory.
193
+ * @param {number[]} [arg.brandIds] - The Brand Id of products to fetch inventory.
194
+ * @param {string[]} [arg.sellerIdentifiers] - Unique seller_identifier of
195
+ * the product.
196
+ * @param {string} [arg.timestamp] - Timestamp in UTC format (2020-07-23T10:27:50Z)
197
+ * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
198
+ * @param {string} [arg.pageId] - Page ID to retrieve next set of results.
199
+ * @returns {Promise<InventoryStockResponse>} - Success response
200
+ * @summary: Get the stock of a product
201
+ * @description: Retrieve the available Inventory of the products. Use this API to get the Inventory status of products with the filters of timestamp, store_ids, brand_ids, item_id - Items - Pagination
332
202
  */
333
- getAllCollections({ q, scheduleStatus, type, tags, isActive, pageNo, pageSize, }?: {
334
- q?: string;
335
- scheduleStatus?: string;
336
- type?: string;
337
- tags?: string[];
338
- isActive?: boolean;
339
- pageNo?: number;
203
+ getAppInventory({ itemIds, storeIds, brandIds, sellerIdentifiers, timestamp, pageSize, pageId, }?: {
204
+ itemIds?: number[];
205
+ storeIds?: number[];
206
+ brandIds?: number[];
207
+ sellerIdentifiers?: string[];
208
+ timestamp?: string;
340
209
  pageSize?: number;
341
- }): Promise<any>;
342
- /**
343
- * @param {Object} arg - Arg object.
344
- * @param {CreateCollection} arg.body
345
- * @summary: Add a Collection
346
- * @description: Create a collection. See `CreateCollectionRequestSchema` for the list of attributes needed to create a collection and collections/query-options for the available options to create a collection. On successful request, returns a paginated list of collections specified in `CollectionCreateResponse`
347
- */
348
- createCollection({ body }?: {
349
- body: CreateCollection;
350
- }): Promise<any>;
351
- /**
352
- * @param {Object} arg - Arg object.
353
- * @param {string} arg.slug - A `slug` is a human readable, URL friendly
354
- * unique identifier of an object. Pass the `slug` of the collection which
355
- * you want to retrieve.
356
- * @summary: Get a particular collection
357
- * @description: Get the details of a collection by its `slug`. If successful, returns a Collection resource in the response body specified in `CollectionDetailResponse`
358
- */
359
- getCollectionDetail({ slug }?: {
360
- slug: string;
361
- }): Promise<any>;
362
- /**
363
- * @param {Object} arg - Arg object.
364
- * @param {string} arg.id - A `id` is a unique identifier of a collection.
365
- * @param {UpdateCollection} arg.body
366
- * @summary: Update a collection
367
- * @description: Update a collection by it's id. On successful request, returns the updated collection
368
- */
369
- updateCollection({ id, body }?: {
370
- id: string;
371
- body: UpdateCollection;
372
- }): Promise<any>;
373
- /**
374
- * @param {Object} arg - Arg object.
375
- * @param {string} arg.id - A `id` is a unique identifier of a collection.
376
- * @summary: Delete a Collection
377
- * @description: Delete a collection by it's id. Returns an object that tells whether the collection was deleted successfully
378
- */
379
- deleteCollection({ id }?: {
380
- id: string;
381
- }): Promise<any>;
382
- /**
383
- * @param {Object} arg - Arg object.
384
- * @param {string} arg.id - A `id` is a unique identifier of a collection.
385
- * @param {string} [arg.sortOn] - Each response will contain sort_on param,
386
- * which should be sent back to make pagination work.
387
- * @param {string} [arg.pageId] - Each response will contain next_id param,
388
- * which should be sent back to make pagination work.
389
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
390
- * page. Default is 12.
391
- * @summary: Get the items for a collection
392
- * @description: Get items from a collection specified by its `id`.
393
- */
394
- getCollectionItems({ id, sortOn, pageId, pageSize }?: {
395
- id: string;
396
- sortOn?: string;
397
210
  pageId?: string;
398
- pageSize?: number;
399
- }): Promise<any>;
400
- /**
401
- * @param {Object} arg - Arg object.
402
- * @param {string} arg.id - A `id` is a unique identifier of a collection.
403
- * @param {CollectionItemRequest} arg.body
404
- * @summary: Add items to a collection
405
- * @description: Adds items to a collection specified by its `id`. See `CollectionItemRequest` for the list of attributes needed to add items to an collection.
406
- */
407
- addCollectionItems({ id, body }?: {
408
- id: string;
409
- body: CollectionItemRequest;
410
- }): Promise<any>;
411
- /**
412
- * @param {Object} arg - Arg object.
413
- * @param {string} [arg.brand] - Brand slug
414
- * @summary: Analytics data of catalog and inventory.
415
- * @description: Catalog Insights api returns the count of catalog related data like products, brands, departments and categories that have been made live as per configuration of the app.
416
- */
417
- getCatalogInsights({ brand }?: {
418
- brand?: string;
419
- }): Promise<any>;
211
+ }): Promise<InventoryStockResponse>;
420
212
  /**
421
213
  * @param {Object} arg - Arg object.
422
- * @param {number} arg.itemId - Item code of the product of which size is to be get.
423
- * @param {string} arg.sizeIdentifier - Size Identifier (Seller Identifier
424
- * or Primary Identifier) of which inventory is to get.
214
+ * @param {string} [arg.storeType] - Helps to sort the location list on the
215
+ * basis of location type.
216
+ * @param {number[]} [arg.uid] - Helps to sort the location list on the
217
+ * basis of uid list.
218
+ * @param {string} [arg.q] - Query that is to be searched.
219
+ * @param {string} [arg.stage] - To filter companies on basis of verified or
220
+ * unverified companies.
425
221
  * @param {number} [arg.pageNo] - The page number to navigate through the
426
222
  * given set of results
427
223
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
428
- * page. Default is 12.
429
- * @param {string} [arg.q] - Search with help of store code.
430
- * @param {number[]} [arg.locationIds] - Search by store ids.
431
- * @summary: Get Inventory for company
432
- * @description: This API allows get Inventory data for particular company grouped by size and store.
224
+ * page. Default is 20.
225
+ * @returns {Promise<LocationListSerializer>} - Success response
226
+ * @summary: Get list of locations
227
+ * @description: This API allows to view all the locations asscoiated to a application.
433
228
  */
434
- getDiscountedInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, }?: {
435
- itemId: number;
436
- sizeIdentifier: string;
437
- pageNo?: number;
438
- pageSize?: number;
229
+ getAppLocations({ storeType, uid, q, stage, pageNo, pageSize }?: {
230
+ storeType?: string;
231
+ uid?: number[];
439
232
  q?: string;
440
- locationIds?: number[];
441
- }): Promise<any>;
442
- /**
443
- * @param {Object} arg - Arg object.
444
- * @param {string} [arg.department] - The name of the department. Use this
445
- * parameter to filter products by a particular department. See below the
446
- * list of available departments. You can retrieve available departments
447
- * from the **v1.0/departments/** API
448
- * @param {number} [arg.pageNo] - The page number to navigate through the
449
- * given set of results
450
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
451
- * page. Default is 12.
452
- * @param {string} [arg.q] - Search query with brand name.Use this parameter
453
- * to search brands by brand name.
454
- * @param {number[]} [arg.brandId] - Helps to sort the brands list on the
455
- * basis of uid list.
456
- * @summary: List all the brands
457
- * @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
458
- */
459
- getApplicationBrands({ department, pageNo, pageSize, q, brandId }?: {
460
- department?: string;
233
+ stage?: string;
461
234
  pageNo?: number;
462
235
  pageSize?: number;
463
- q?: string;
464
- brandId?: number[];
465
- }): Promise<any>;
236
+ }): Promise<LocationListSerializer>;
466
237
  /**
467
238
  * @param {Object} arg - Arg object.
468
- * @param {string} arg.companyId - A `company_id` is a unique identifier for
469
- * a particular seller account.
470
- * @param {string} arg.applicationId - A `application_id` is a unique
471
- * identifier for a particular sale channel.
472
- * @param {string} [arg.department] - The name of the department. Use this
473
- * parameter to filter products by a particular department. See below the
474
- * list of available departments. You can retrieve available departments
475
- * from the **v1.0/departments/** API
476
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
477
- * page. Default is 12.
478
- * @param {string} [arg.q] - Search query with brand name.Use this parameter
479
- * to search brands by brand name.
480
- * @param {number[]} [arg.brandId] - Helps to sort the brands list on the
239
+ * @param {string} arg.companyId - Id of the company whose locations are to fetched
240
+ * @param {string} arg.applicationId - Id of the application whose locations
241
+ * are to fetched
242
+ * @param {string} [arg.storeType] - Helps to sort the location list on the
243
+ * basis of location type.
244
+ * @param {number[]} [arg.uid] - Helps to sort the location list on the
481
245
  * basis of uid list.
482
- * @summary: List all the brands
483
- * @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
246
+ * @param {string} [arg.q] - Query that is to be searched.
247
+ * @param {string} [arg.stage] - To filter companies on basis of verified or
248
+ * unverified companies.
249
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
250
+ * page. Default is 20.
251
+ * @summary: Get list of locations
252
+ * @description: This API allows to view all the locations asscoiated to a application.
484
253
  */
485
- getApplicationBrandsPaginator({ companyId, applicationId, department, pageSize, q, brandId, }?: {
254
+ getAppLocationsPaginator({ companyId, applicationId, storeType, uid, q, stage, pageSize, }?: {
486
255
  companyId: string;
487
256
  applicationId: string;
488
- department?: string;
489
- pageSize?: number;
257
+ storeType?: string;
258
+ uid?: number[];
490
259
  q?: string;
491
- brandId?: number[];
260
+ stage?: string;
261
+ pageSize?: number;
492
262
  }): Paginator;
493
263
  /**
494
264
  * @param {Object} arg - Arg object.
495
- * @summary: List all the departments
496
- * @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the departments. If successful, returns the list of departments specified in `DepartmentResponse`
265
+ * @param {string} arg.itemId - Product id for a particular product.
266
+ * @returns {Promise<OwnerAppItemResponse>} - Success response
267
+ * @summary: Get company application product data.
268
+ * @description: Products are the core resource of an application. If successful, returns a Company Application Product resource in the response body depending upon filter sent.
497
269
  */
498
- getDepartments({}?: any): Promise<any>;
270
+ getAppProduct({ itemId }?: {
271
+ itemId: string;
272
+ }): Promise<OwnerAppItemResponse>;
499
273
  /**
500
274
  * @param {Object} arg - Arg object.
501
- * @param {string} [arg.department] - The name of the department. Use this
502
- * parameter to filter products by a particular department. See below the
503
- * list of available departments. You can retrieve available departments
504
- * from the **v1.0/departments/** API
505
- * @summary: List all the categories
506
- * @description: List all the categories. You can optionally pass filter the brands by the department. If successful, returns a paginated list of brands specified in `CategoryListingResponse`
275
+ * @param {number[]} [arg.brandIds] - Get multiple products filtered by Brand Ids
276
+ * @param {number[]} [arg.categoryIds] - Get multiple products filtered by
277
+ * Category Ids
278
+ * @param {number[]} [arg.departmentIds] - Get multiple products filtered by
279
+ * Department Ids
280
+ * @param {string[]} [arg.tags] - Get multiple products filtered by tags
281
+ * @param {number} [arg.pageNo] - The page number to navigate through the
282
+ * given set of results
283
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
284
+ * page. Default is 10.
285
+ * @param {string} [arg.q] - Search with Item Code, Name, Slug or Identifier.
286
+ * @returns {Promise<ProductListingResponse>} - Success response
287
+ * @summary: Get applicationwise products
288
+ * @description: Products are the core resource of an application. Products can be associated by categories, collections, brands and more. If successful, returns a Product resource in the response body specified in `ApplicationProductListingResponseDatabasePowered`
507
289
  */
508
- getCategories({ department }?: {
509
- department?: string;
510
- }): Promise<any>;
290
+ getAppProducts({ brandIds, categoryIds, departmentIds, tags, pageNo, pageSize, q, }?: {
291
+ brandIds?: number[];
292
+ categoryIds?: number[];
293
+ departmentIds?: number[];
294
+ tags?: string[];
295
+ pageNo?: number;
296
+ pageSize?: number;
297
+ q?: string;
298
+ }): Promise<ProductListingResponse>;
511
299
  /**
512
300
  * @param {Object} arg - Arg object.
513
301
  * @param {string} [arg.q] - The search query. This can be a partial or
@@ -534,6 +322,7 @@ declare class Catalog {
534
322
  * @param {string} [arg.pageType] - For pagination type should be cursor or
535
323
  * number. Default is cursor.
536
324
  * @param {number[]} [arg.itemIds] - Item Ids of product
325
+ * @returns {Promise<ApplicationProductListingResponse>} - Success response
537
326
  * @summary: List the products
538
327
  * @description: List all the products associated with a brand, collection or category in a requested sort order. The API additionally supports arbitrary search queries that may refer the name of any product, brand, category or collection. If successful, returns a paginated list of products specified in `ApplicationProductListingResponse`
539
328
  */
@@ -548,7 +337,7 @@ declare class Catalog {
548
337
  pageNo?: number;
549
338
  pageType?: string;
550
339
  itemIds?: number[];
551
- }): Promise<any>;
340
+ }): Promise<ApplicationProductListingResponse>;
552
341
  /**
553
342
  * @param {Object} arg - Arg object.
554
343
  * @param {string} arg.companyId - A `company_id` is a unique identifier for
@@ -589,158 +378,92 @@ declare class Catalog {
589
378
  }): Paginator;
590
379
  /**
591
380
  * @param {Object} arg - Arg object.
592
- * @param {string} arg.slug - The unique identifier of a product. i.e;
593
- * `slug` of a product. You can retrieve these from the APIs that list
594
- * products like **v1.0/products/**
595
- * @summary: Get a product
596
- * @description: Products are the core resource of an application. Products can be associated by categories, collections, brands and more. This API retrieves the product specified by the given **slug**. If successful, returns a Product resource in the response body specified in `ProductDetail`
597
- */
598
- getProductDetailBySlug({ slug }?: {
599
- slug: string;
600
- }): Promise<any>;
601
- /**
602
- * @param {Object} arg - Arg object.
603
- * @param {number[]} [arg.brandIds] - Get multiple products filtered by Brand Ids
604
- * @param {number[]} [arg.categoryIds] - Get multiple products filtered by
605
- * Category Ids
606
- * @param {number[]} [arg.departmentIds] - Get multiple products filtered by
607
- * Department Ids
608
- * @param {string[]} [arg.tags] - Get multiple products filtered by tags
609
381
  * @param {number} [arg.pageNo] - The page number to navigate through the
610
382
  * given set of results
611
383
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
612
- * page. Default is 10.
613
- * @param {string} [arg.q] - Search with Item Code, Name, Slug or Identifier.
614
- * @summary: Get applicationwise products
615
- * @description: Products are the core resource of an application. Products can be associated by categories, collections, brands and more. If successful, returns a Product resource in the response body specified in `ApplicationProductListingResponseDatabasePowered`
384
+ * page. Default is 12.
385
+ * @param {string} [arg.q] - Search query with brand name.Use this parameter
386
+ * to search brands by brand name.
387
+ * @returns {Promise<BrandListingResponse>} - Success response
388
+ * @summary: List all the brands for the application
389
+ * @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
616
390
  */
617
- getAppProducts({ brandIds, categoryIds, departmentIds, tags, pageNo, pageSize, q, }?: {
618
- brandIds?: number[];
619
- categoryIds?: number[];
620
- departmentIds?: number[];
621
- tags?: string[];
391
+ getApplicationBrandListing({ pageNo, pageSize, q }?: {
622
392
  pageNo?: number;
623
393
  pageSize?: number;
624
394
  q?: string;
625
- }): Promise<any>;
626
- /**
627
- * @param {Object} arg - Arg object.
628
- * @param {number[]} [arg.itemIds] - The Item Id of the product.
629
- * @param {number[]} [arg.storeIds] - The Store Id of products to fetch inventory.
630
- * @param {number[]} [arg.brandIds] - The Brand Id of products to fetch inventory.
631
- * @param {string[]} [arg.sellerIdentifiers] - Unique seller_identifier of
632
- * the product.
633
- * @param {string} [arg.timestamp] - Timestamp in UTC format (2020-07-23T10:27:50Z)
634
- * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
635
- * @param {string} [arg.pageId] - Page ID to retrieve next set of results.
636
- * @summary: Get the stock of a product
637
- * @description: Retrieve the available Inventory of the products. Use this API to get the Inventory status of products with the filters of timestamp, store_ids, brand_ids, item_id - Items - Pagination
638
- */
639
- getAppInventory({ itemIds, storeIds, brandIds, sellerIdentifiers, timestamp, pageSize, pageId, }?: {
640
- itemIds?: number[];
641
- storeIds?: number[];
642
- brandIds?: number[];
643
- sellerIdentifiers?: string[];
644
- timestamp?: string;
645
- pageSize?: number;
646
- pageId?: string;
647
- }): Promise<any>;
648
- /**
649
- * @param {Object} arg - Arg object.
650
- * @param {string} [arg.storeType] - Helps to sort the location list on the
651
- * basis of location type.
652
- * @param {number[]} [arg.uid] - Helps to sort the location list on the
653
- * basis of uid list.
654
- * @param {string} [arg.q] - Query that is to be searched.
655
- * @param {string} [arg.stage] - To filter companies on basis of verified or
656
- * unverified companies.
657
- * @param {number} [arg.pageNo] - The page number to navigate through the
658
- * given set of results
659
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
660
- * page. Default is 20.
661
- * @summary: Get list of locations
662
- * @description: This API allows to view all the locations asscoiated to a application.
663
- */
664
- getAppLocations({ storeType, uid, q, stage, pageNo, pageSize }?: {
665
- storeType?: string;
666
- uid?: number[];
667
- q?: string;
668
- stage?: string;
669
- pageNo?: number;
670
- pageSize?: number;
671
- }): Promise<any>;
395
+ }): Promise<BrandListingResponse>;
672
396
  /**
673
397
  * @param {Object} arg - Arg object.
674
- * @param {string} arg.companyId - Id of the company whose locations are to fetched
675
- * @param {string} arg.applicationId - Id of the application whose locations
676
- * are to fetched
677
- * @param {string} [arg.storeType] - Helps to sort the location list on the
678
- * basis of location type.
679
- * @param {number[]} [arg.uid] - Helps to sort the location list on the
680
- * basis of uid list.
681
- * @param {string} [arg.q] - Query that is to be searched.
682
- * @param {string} [arg.stage] - To filter companies on basis of verified or
683
- * unverified companies.
398
+ * @param {string} arg.companyId - A `company_id` is a unique identifier for
399
+ * a particular seller account.
400
+ * @param {string} arg.applicationId - A `application_id` is a unique
401
+ * identifier for a particular sale channel.
684
402
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
685
- * page. Default is 20.
686
- * @summary: Get list of locations
687
- * @description: This API allows to view all the locations asscoiated to a application.
403
+ * page. Default is 12.
404
+ * @param {string} [arg.q] - Search query with brand name.Use this parameter
405
+ * to search brands by brand name.
406
+ * @summary: List all the brands for the application
407
+ * @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
688
408
  */
689
- getAppLocationsPaginator({ companyId, applicationId, storeType, uid, q, stage, pageSize, }?: {
409
+ getApplicationBrandListingPaginator({ companyId, applicationId, pageSize, q, }?: {
690
410
  companyId: string;
691
411
  applicationId: string;
692
- storeType?: string;
693
- uid?: number[];
694
- q?: string;
695
- stage?: string;
696
412
  pageSize?: number;
413
+ q?: string;
697
414
  }): Paginator;
698
415
  /**
699
416
  * @param {Object} arg - Arg object.
417
+ * @param {string} [arg.department] - The name of the department. Use this
418
+ * parameter to filter products by a particular department. See below the
419
+ * list of available departments. You can retrieve available departments
420
+ * from the **v1.0/departments/** API
700
421
  * @param {number} [arg.pageNo] - The page number to navigate through the
701
422
  * given set of results
702
423
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
703
424
  * page. Default is 12.
704
425
  * @param {string} [arg.q] - Search query with brand name.Use this parameter
705
426
  * to search brands by brand name.
706
- * @summary: List all the brands for the application
427
+ * @param {number[]} [arg.brandId] - Helps to sort the brands list on the
428
+ * basis of uid list.
429
+ * @returns {Promise<BrandListingResponse>} - Success response
430
+ * @summary: List all the brands
707
431
  * @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
708
432
  */
709
- getApplicationBrandListing({ pageNo, pageSize, q }?: {
433
+ getApplicationBrands({ department, pageNo, pageSize, q, brandId, }?: {
434
+ department?: string;
710
435
  pageNo?: number;
711
436
  pageSize?: number;
712
437
  q?: string;
713
- }): Promise<any>;
438
+ brandId?: number[];
439
+ }): Promise<BrandListingResponse>;
714
440
  /**
715
441
  * @param {Object} arg - Arg object.
716
442
  * @param {string} arg.companyId - A `company_id` is a unique identifier for
717
443
  * a particular seller account.
718
444
  * @param {string} arg.applicationId - A `application_id` is a unique
719
445
  * identifier for a particular sale channel.
446
+ * @param {string} [arg.department] - The name of the department. Use this
447
+ * parameter to filter products by a particular department. See below the
448
+ * list of available departments. You can retrieve available departments
449
+ * from the **v1.0/departments/** API
720
450
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
721
451
  * page. Default is 12.
722
452
  * @param {string} [arg.q] - Search query with brand name.Use this parameter
723
453
  * to search brands by brand name.
724
- * @summary: List all the brands for the application
454
+ * @param {number[]} [arg.brandId] - Helps to sort the brands list on the
455
+ * basis of uid list.
456
+ * @summary: List all the brands
725
457
  * @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
726
458
  */
727
- getApplicationBrandListingPaginator({ companyId, applicationId, pageSize, q, }?: {
459
+ getApplicationBrandsPaginator({ companyId, applicationId, department, pageSize, q, brandId, }?: {
728
460
  companyId: string;
729
461
  applicationId: string;
462
+ department?: string;
730
463
  pageSize?: number;
731
464
  q?: string;
465
+ brandId?: number[];
732
466
  }): Paginator;
733
- /**
734
- * @param {Object} arg - Arg object.
735
- * @param {string} arg.brandUid - Brand id for which the custom_json is associated.
736
- * @param {ApplicationBrandJson} arg.body
737
- * @summary: Update a single custom json.
738
- * @description: This API helps to update data associated to a item custom meta.
739
- */
740
- updateAppBrand({ brandUid, body }?: {
741
- brandUid: string;
742
- body: ApplicationBrandJson;
743
- }): Promise<any>;
744
467
  /**
745
468
  * @param {Object} arg - Arg object.
746
469
  * @param {number} [arg.departmentId] - A `department_id` is a unique
@@ -751,15 +474,16 @@ declare class Catalog {
751
474
  * page. Default is 12.
752
475
  * @param {string} [arg.q] - Search query with brand name.Use this parameter
753
476
  * to search brands by brand name.
477
+ * @returns {Promise<BrandListingResponse>} - Success response
754
478
  * @summary: List all the brands for the application
755
479
  * @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
756
480
  */
757
- getApplicationCategoryListing({ departmentId, pageNo, pageSize, q }?: {
481
+ getApplicationCategoryListing({ departmentId, pageNo, pageSize, q, }?: {
758
482
  departmentId?: number;
759
483
  pageNo?: number;
760
484
  pageSize?: number;
761
485
  q?: string;
762
- }): Promise<any>;
486
+ }): Promise<BrandListingResponse>;
763
487
  /**
764
488
  * @param {Object} arg - Arg object.
765
489
  * @param {string} arg.companyId - A `company_id` is a unique identifier for
@@ -782,18 +506,6 @@ declare class Catalog {
782
506
  pageSize?: number;
783
507
  q?: string;
784
508
  }): Paginator;
785
- /**
786
- * @param {Object} arg - Arg object.
787
- * @param {string} arg.categoryUid - Category id for which the custom_json
788
- * is associated.
789
- * @param {ApplicationCategoryJson} arg.body
790
- * @summary: Update a single custom json.
791
- * @description: This API helps to update data associated to a item custom meta.
792
- */
793
- updateAppCategory({ categoryUid, body }?: {
794
- categoryUid: string;
795
- body: ApplicationCategoryJson;
796
- }): Promise<any>;
797
509
  /**
798
510
  * @param {Object} arg - Arg object.
799
511
  * @param {number} [arg.pageNo] - The page number to navigate through the
@@ -802,6 +514,7 @@ declare class Catalog {
802
514
  * page. Default is 12.
803
515
  * @param {string} [arg.q] - Search query with brand name.Use this parameter
804
516
  * to search department by name.
517
+ * @returns {Promise<ApplicationDepartmentListingResponse>} - Success response
805
518
  * @summary: List all the departments for the application
806
519
  * @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the application departments. If successful, returns the list of departments specified in `ApplicationDepartmentListingResponse`
807
520
  */
@@ -809,7 +522,7 @@ declare class Catalog {
809
522
  pageNo?: number;
810
523
  pageSize?: number;
811
524
  q?: string;
812
- }): Promise<any>;
525
+ }): Promise<ApplicationDepartmentListingResponse>;
813
526
  /**
814
527
  * @param {Object} arg - Arg object.
815
528
  * @param {string} arg.companyId - A `company_id` is a unique identifier for
@@ -829,28 +542,368 @@ declare class Catalog {
829
542
  pageSize?: number;
830
543
  q?: string;
831
544
  }): Paginator;
545
+ /**
546
+ * @param {Object} arg - Arg object.
547
+ * @returns {Promise<GetAutocompleteWordsResponse>} - Success response
548
+ * @summary: List all Autocomplete Keyword Listing
549
+ * @description: Custom Autocomplete Keyword allows you to map conditions with keywords to give you the ultimate results
550
+ */
551
+ getAutocompleteConfig({}?: any): Promise<GetAutocompleteWordsResponse>;
552
+ /**
553
+ * @param {Object} arg - Arg object.
554
+ * @param {string} arg.id - A `id` is a unique identifier for a particular
555
+ * detail. Pass the `id` of the keywords which you want to retrieve.
556
+ * @returns {Promise<GetAutocompleteWordsResponse>} - Success response
557
+ * @summary: Get a Autocomplete Keywords Details
558
+ * @description: Get the details of a words by its `id`. If successful, returns a keywords resource in the response body specified in `GetAutocompleteWordsResponseSchema`
559
+ */
560
+ getAutocompleteKeywordDetail({ id }?: {
561
+ id: string;
562
+ }): Promise<GetAutocompleteWordsResponse>;
563
+ /**
564
+ * @param {Object} arg - Arg object.
565
+ * @returns {Promise<GetCatalogConfigurationMetaData>} - Success response
566
+ * @summary: Get configuration meta details for catalog for admin panel
567
+ * @description: configuration meta details for catalog.
568
+ */
569
+ getCatalogConfiguration({}?: any): Promise<GetCatalogConfigurationMetaData>;
570
+ /**
571
+ * @param {Object} arg - Arg object.
572
+ * @param {string} [arg.brand] - Brand slug
573
+ * @returns {Promise<CatalogInsightResponse>} - Success response
574
+ * @summary: Analytics data of catalog and inventory.
575
+ * @description: Catalog Insights api returns the count of catalog related data like products, brands, departments and categories that have been made live as per configuration of the app.
576
+ */
577
+ getCatalogInsights({ brand }?: {
578
+ brand?: string;
579
+ }): Promise<CatalogInsightResponse>;
580
+ /**
581
+ * @param {Object} arg - Arg object.
582
+ * @param {string} [arg.department] - The name of the department. Use this
583
+ * parameter to filter products by a particular department. See below the
584
+ * list of available departments. You can retrieve available departments
585
+ * from the **v1.0/departments/** API
586
+ * @returns {Promise<CategoryListingResponse>} - Success response
587
+ * @summary: List all the categories
588
+ * @description: List all the categories. You can optionally pass filter the brands by the department. If successful, returns a paginated list of brands specified in `CategoryListingResponse`
589
+ */
590
+ getCategories({ department }?: {
591
+ department?: string;
592
+ }): Promise<CategoryListingResponse>;
593
+ /**
594
+ * @param {Object} arg - Arg object.
595
+ * @param {string} arg.slug - A `slug` is a human readable, URL friendly
596
+ * unique identifier of an object. Pass the `slug` of the collection which
597
+ * you want to retrieve.
598
+ * @returns {Promise<CollectionDetailResponse>} - Success response
599
+ * @summary: Get a particular collection
600
+ * @description: Get the details of a collection by its `slug`. If successful, returns a Collection resource in the response body specified in `CollectionDetailResponse`
601
+ */
602
+ getCollectionDetail({ slug }?: {
603
+ slug: string;
604
+ }): Promise<CollectionDetailResponse>;
605
+ /**
606
+ * @param {Object} arg - Arg object.
607
+ * @param {string} arg.id - A `id` is a unique identifier of a collection.
608
+ * @param {string} [arg.sortOn] - Each response will contain sort_on param,
609
+ * which should be sent back to make pagination work.
610
+ * @param {string} [arg.pageId] - Each response will contain next_id param,
611
+ * which should be sent back to make pagination work.
612
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
613
+ * page. Default is 12.
614
+ * @returns {Promise<GetCollectionItemsResponse>} - Success response
615
+ * @summary: Get the items for a collection
616
+ * @description: Get items from a collection specified by its `id`.
617
+ */
618
+ getCollectionItems({ id, sortOn, pageId, pageSize }?: {
619
+ id: string;
620
+ sortOn?: string;
621
+ pageId?: string;
622
+ pageSize?: number;
623
+ }): Promise<GetCollectionItemsResponse>;
624
+ /**
625
+ * @param {Object} arg - Arg object.
626
+ * @param {string} arg.type - Type can be brands, categories etc.
627
+ * @returns {Promise<GetAppCatalogEntityConfiguration>} - Success response
628
+ * @summary: Get configured details for catalog
629
+ * @description: configured details for catalog.
630
+ */
631
+ getConfigurationByType({ type }?: {
632
+ type: string;
633
+ }): Promise<GetAppCatalogEntityConfiguration>;
634
+ /**
635
+ * @param {Object} arg - Arg object.
636
+ * @param {string} arg.configType - A `config_type` is an identifier that
637
+ * defines a specific type of configuration.
638
+ * @param {string} [arg.templateSlug] - Get configuration list filtered by
639
+ * `template_slug` string. This is for the details and comparision groups.
640
+ * @returns {Promise<GetConfigMetadataResponse>} - Success response
641
+ * @summary: Get configuration metadata details for catalog for admin panel
642
+ * @description: Get the configuraion metadata details for catalog.
643
+ */
644
+ getConfigurationMetadata({ configType, templateSlug }?: {
645
+ configType: string;
646
+ templateSlug?: string;
647
+ }): Promise<GetConfigMetadataResponse>;
648
+ /**
649
+ * @param {Object} arg - Arg object.
650
+ * @returns {Promise<GetAppCatalogConfiguration>} - Success response
651
+ * @summary: Get configured details for catalog
652
+ * @description: configured details for catalog.
653
+ */
654
+ getConfigurations({}?: any): Promise<GetAppCatalogConfiguration>;
655
+ /**
656
+ * @param {Object} arg - Arg object.
657
+ * @returns {Promise<DepartmentResponse>} - Success response
658
+ * @summary: List all the departments
659
+ * @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the departments. If successful, returns the list of departments specified in `DepartmentResponse`
660
+ */
661
+ getDepartments({}?: any): Promise<DepartmentResponse>;
662
+ /**
663
+ * @param {Object} arg - Arg object.
664
+ * @param {number} arg.itemId - Item code of the product of which size is to be get.
665
+ * @param {string} arg.sizeIdentifier - Size Identifier (Seller Identifier
666
+ * or Primary Identifier) of which inventory is to get.
667
+ * @param {number} [arg.pageNo] - The page number to navigate through the
668
+ * given set of results
669
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
670
+ * page. Default is 12.
671
+ * @param {string} [arg.q] - Search with help of store code.
672
+ * @param {number[]} [arg.locationIds] - Search by store ids.
673
+ * @returns {Promise<InventorySellerIdentifierResponsePaginated>} - Success response
674
+ * @summary: Get Inventory for company
675
+ * @description: This API allows get Inventory data for particular company grouped by size and store.
676
+ */
677
+ getDiscountedInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, }?: {
678
+ itemId: number;
679
+ sizeIdentifier: string;
680
+ pageNo?: number;
681
+ pageSize?: number;
682
+ q?: string;
683
+ locationIds?: number[];
684
+ }): Promise<InventorySellerIdentifierResponsePaginated>;
685
+ /**
686
+ * @param {Object} arg - Arg object.
687
+ * @param {string} arg.configType - A `config_type` is an identifier that
688
+ * defines a specific type of configuration.
689
+ * @param {number} [arg.pageNo] - The page number to navigate through the
690
+ * given set of results.
691
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
692
+ * page. Default is 12.
693
+ * @param {string} [arg.search] - Get configuration list filtered by `search` string.
694
+ * @param {string} [arg.templateSlug] - Get configuration list filtered by
695
+ * `template_slug` string. This is for the details and comparision groups.
696
+ * @returns {Promise<GetConfigResponse>} - Success response
697
+ * @summary: Get the details of the application configured configurations of group config types.
698
+ * @description: Get the details of the application configured configurations of group config types.
699
+ */
700
+ getGroupConfigurations({ configType, pageNo, pageSize, search, templateSlug, }?: {
701
+ configType: string;
702
+ pageNo?: number;
703
+ pageSize?: number;
704
+ search?: string;
705
+ templateSlug?: string;
706
+ }): Promise<GetConfigResponse>;
707
+ /**
708
+ * @param {Object} arg - Arg object.
709
+ * @param {string} arg.configType - A `config_type` is an identifier that
710
+ * defines a specific type of configuration.
711
+ * @param {number} [arg.pageNo] - The page number to navigate through the
712
+ * given set of results.
713
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
714
+ * page. Default is 12.
715
+ * @param {string} [arg.search] - Get configuration list filtered by `search` string.
716
+ * @returns {Promise<GetConfigResponse>} - Success response
717
+ * @summary: Get the details of the application configured configurations of listing config types.
718
+ * @description: Get the details of the application configured configurations of listing config types.
719
+ */
720
+ getListingConfigurations({ configType, pageNo, pageSize, search, }?: {
721
+ configType: string;
722
+ pageNo?: number;
723
+ pageSize?: number;
724
+ search?: string;
725
+ }): Promise<GetConfigResponse>;
726
+ /**
727
+ * @param {Object} arg - Arg object.
728
+ * @param {string} arg.slug - The unique identifier of a product. i.e;
729
+ * `slug` of a product. You can retrieve these from the APIs that list
730
+ * products like **v1.0/products/**
731
+ * @returns {Promise<ProductDetail>} - Success response
732
+ * @summary: Get a product
733
+ * @description: Products are the core resource of an application. Products can be associated by categories, collections, brands and more. This API retrieves the product specified by the given **slug**. If successful, returns a Product resource in the response body specified in `ProductDetail`
734
+ */
735
+ getProductDetailBySlug({ slug }?: {
736
+ slug: string;
737
+ }): Promise<ProductDetail>;
738
+ /**
739
+ * @param {Object} arg - Arg object.
740
+ * @returns {Promise<GetCollectionQueryOptionResponse>} - Success response
741
+ * @summary: Get query filters to configure a collection
742
+ * @description: Get query filters to configure a collection
743
+ */
744
+ getQueryFilters({}?: any): Promise<GetCollectionQueryOptionResponse>;
745
+ /**
746
+ * @param {Object} arg - Arg object.
747
+ * @param {string} arg.id - A `id` is a unique identifier for a particular
748
+ * detail. Pass the `id` of the keywords which you want to retrieve.
749
+ * @returns {Promise<GetSearchWordsDetailResponse>} - Success response
750
+ * @summary: Get a Search Keywords Details
751
+ * @description: Get the details of a words by its `id`. If successful, returns a Collection resource in the response body specified in `GetSearchWordsDetailResponseSchema`
752
+ */
753
+ getSearchKeywords({ id }?: {
754
+ id: string;
755
+ }): Promise<GetSearchWordsDetailResponse>;
756
+ /**
757
+ * @param {Object} arg - Arg object.
758
+ * @param {AllowSingleRequest} arg.body
759
+ * @returns {Promise<ConfigSuccessResponse>} - Success response
760
+ * @summary: Update allow single flag for filters of the application.
761
+ * @description: Update allow single flag for filters of the application.
762
+ */
763
+ updateAllowSingle({ body }?: {
764
+ body: AllowSingleRequest;
765
+ }): Promise<ConfigSuccessResponse>;
766
+ /**
767
+ * @param {Object} arg - Arg object.
768
+ * @param {string} arg.brandUid - Brand id for which the custom_json is associated.
769
+ * @param {ApplicationBrandJson} arg.body
770
+ * @returns {Promise<SuccessResponse1>} - Success response
771
+ * @summary: Update a single custom json.
772
+ * @description: This API helps to update data associated to a item custom meta.
773
+ */
774
+ updateAppBrand({ brandUid, body }?: {
775
+ brandUid: string;
776
+ body: ApplicationBrandJson;
777
+ }): Promise<SuccessResponse1>;
778
+ /**
779
+ * @param {Object} arg - Arg object.
780
+ * @param {string} arg.categoryUid - Category id for which the custom_json
781
+ * is associated.
782
+ * @param {ApplicationCategoryJson} arg.body
783
+ * @returns {Promise<SuccessResponse1>} - Success response
784
+ * @summary: Update a single custom json.
785
+ * @description: This API helps to update data associated to a item custom meta.
786
+ */
787
+ updateAppCategory({ categoryUid, body }?: {
788
+ categoryUid: string;
789
+ body: ApplicationCategoryJson;
790
+ }): Promise<SuccessResponse1>;
832
791
  /**
833
792
  * @param {Object} arg - Arg object.
834
793
  * @param {string} arg.departmentUid - Department id for which the
835
794
  * custom_json is associated.
836
795
  * @param {ApplicationDepartmentJson} arg.body
796
+ * @returns {Promise<SuccessResponse1>} - Success response
837
797
  * @summary: Update a single custom json.
838
798
  * @description: This API helps to update data associated to a item custom meta.
839
799
  */
840
800
  updateAppDepartment({ departmentUid, body }?: {
841
801
  departmentUid: string;
842
802
  body: ApplicationDepartmentJson;
843
- }): Promise<any>;
803
+ }): Promise<SuccessResponse1>;
844
804
  /**
845
805
  * @param {Object} arg - Arg object.
846
806
  * @param {string} arg.storeUid - Store id for which the custom_json is associated.
847
807
  * @param {ApplicationStoreJson} arg.body
808
+ * @returns {Promise<SuccessResponse1>} - Success response
848
809
  * @summary: Update a single custom json.
849
810
  * @description: This API helps to update data associated to a item custom meta.
850
811
  */
851
812
  updateAppLocation({ storeUid, body }?: {
852
813
  storeUid: string;
853
814
  body: ApplicationStoreJson;
854
- }): Promise<any>;
815
+ }): Promise<SuccessResponse1>;
816
+ /**
817
+ * @param {Object} arg - Arg object.
818
+ * @param {string} arg.itemId - Product id for which the custom_meta is associated.
819
+ * @param {ApplicationItemMeta} arg.body
820
+ * @returns {Promise<SuccessResponse1>} - Success response
821
+ * @summary: Update a single custom meta.
822
+ * @description: This API helps to update data associated to a item custom meta.
823
+ */
824
+ updateAppProduct({ itemId, body }?: {
825
+ itemId: string;
826
+ body: ApplicationItemMeta;
827
+ }): Promise<SuccessResponse1>;
828
+ /**
829
+ * @param {Object} arg - Arg object.
830
+ * @param {string} arg.id - A `id` is a unique identifier for a particular
831
+ * detail. Pass the `id` of the keywords which you want to delete.
832
+ * @param {CreateAutocompleteKeyword} arg.body
833
+ * @returns {Promise<GetAutocompleteWordsResponse>} - Success response
834
+ * @summary: Create & Update Autocomplete Keyword
835
+ * @description: Update a mapping by it's id. On successful request, returns the updated Keyword mapping
836
+ */
837
+ updateAutocompleteKeyword({ id, body }?: {
838
+ id: string;
839
+ body: CreateAutocompleteKeyword;
840
+ }): Promise<GetAutocompleteWordsResponse>;
841
+ /**
842
+ * @param {Object} arg - Arg object.
843
+ * @param {string} arg.id - A `id` is a unique identifier of a collection.
844
+ * @param {UpdateCollection} arg.body
845
+ * @returns {Promise<UpdateCollection>} - Success response
846
+ * @summary: Update a collection
847
+ * @description: Update a collection by it's id. On successful request, returns the updated collection
848
+ */
849
+ updateCollection({ id, body }?: {
850
+ id: string;
851
+ body: UpdateCollection;
852
+ }): Promise<UpdateCollection>;
853
+ /**
854
+ * @param {Object} arg - Arg object.
855
+ * @param {DefaultKeyRequest} arg.body
856
+ * @returns {Promise<ConfigSuccessResponse>} - Success response
857
+ * @summary: Update the default sort key configuration for the application.
858
+ * @description: Update the default sort key configuration for the application.
859
+ */
860
+ updateDefaultSort({ body }?: {
861
+ body: DefaultKeyRequest;
862
+ }): Promise<ConfigSuccessResponse>;
863
+ /**
864
+ * @param {Object} arg - Arg object.
865
+ * @param {string} arg.configType - A `config_type` is a unique identifier
866
+ * for a particular group configuration type.
867
+ * @param {string} arg.groupSlug - A `group_slug` is a unique identifier of
868
+ * a particular configuration.
869
+ * @param {AppConfigurationDetail} arg.body
870
+ * @returns {Promise<AppConfigurationDetail>} - Success response
871
+ * @summary: Update the group configurations for the application.
872
+ * @description: Update the group configurations for the application.
873
+ */
874
+ updateGroupConfiguration({ configType, groupSlug, body }?: {
875
+ configType: string;
876
+ groupSlug: string;
877
+ body: AppConfigurationDetail;
878
+ }): Promise<AppConfigurationDetail>;
879
+ /**
880
+ * @param {Object} arg - Arg object.
881
+ * @param {string} arg.configType - A `config_type` is a unique identifier
882
+ * for a particular listing configuration type.
883
+ * @param {string} arg.configId - A `config_id` is a unique identifier of a
884
+ * particular configuration.
885
+ * @param {AppConfigurationsSort} arg.body
886
+ * @returns {Promise<AppConfigurationsSort>} - Success response
887
+ * @summary: Update configuration for listings
888
+ * @description: Update configuration for listing.
889
+ */
890
+ updateListingConfiguration({ configType, configId, body }?: {
891
+ configType: string;
892
+ configId: string;
893
+ body: AppConfigurationsSort;
894
+ }): Promise<AppConfigurationsSort>;
895
+ /**
896
+ * @param {Object} arg - Arg object.
897
+ * @param {string} arg.id - A `id` is a unique identifier for a particular
898
+ * detail. Pass the `id` of the keywords which you want to delete.
899
+ * @param {CreateSearchKeyword} arg.body
900
+ * @returns {Promise<GetSearchWordsData>} - Success response
901
+ * @summary: Update Search Keyword
902
+ * @description: Update Search Keyword by its id. On successful request, returns the updated collection
903
+ */
904
+ updateSearchKeywords({ id, body }?: {
905
+ id: string;
906
+ body: CreateSearchKeyword;
907
+ }): Promise<GetSearchWordsData>;
855
908
  }
856
909
  import Paginator = require("../../common/Paginator");