@gofynd/fdk-client-javascript 1.4.15-beta.14 → 1.4.15-beta.15

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 (278) hide show
  1. package/README.md +23 -26
  2. package/package.json +5 -1
  3. package/sdk/application/ApplicationClient.d.ts +5 -6
  4. package/sdk/application/ApplicationClient.js +24 -20
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +133 -83
  6. package/sdk/application/Cart/CartApplicationClient.js +444 -76
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +132 -114
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +209 -126
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +58 -36
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +73 -29
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +95 -66
  16. package/sdk/application/Content/ContentApplicationClient.js +274 -111
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -11
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -10
  19. package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
  20. package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
  21. package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
  22. package/sdk/application/Lead/LeadApplicationClient.js +6 -6
  23. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +37 -57
  24. package/sdk/application/Logistic/LogisticApplicationClient.js +117 -180
  25. package/sdk/application/Order/OrderApplicationClient.d.ts +63 -21
  26. package/sdk/application/Order/OrderApplicationClient.js +217 -17
  27. package/sdk/application/Payment/PaymentApplicationClient.d.ts +179 -149
  28. package/sdk/application/Payment/PaymentApplicationClient.js +301 -167
  29. package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
  30. package/sdk/application/Share/ShareApplicationClient.js +7 -7
  31. package/sdk/application/Theme/ThemeApplicationClient.d.ts +7 -7
  32. package/sdk/application/Theme/ThemeApplicationClient.js +10 -6
  33. package/sdk/application/User/UserApplicationClient.d.ts +103 -53
  34. package/sdk/application/User/UserApplicationClient.js +308 -49
  35. package/sdk/common/AxiosHelper.js +11 -4
  36. package/sdk/common/Constant.d.ts +27 -4
  37. package/sdk/common/Constant.js +33 -6
  38. package/sdk/common/utils.d.ts +10 -0
  39. package/sdk/common/utils.js +24 -3
  40. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +46 -16
  41. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +266 -40
  42. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +163 -19
  43. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -14
  44. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +5 -2
  45. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +23 -7
  46. package/sdk/partner/Lead/LeadPartnerClient.d.ts +9 -9
  47. package/sdk/partner/Lead/LeadPartnerClient.js +9 -9
  48. package/sdk/partner/Lead/LeadPartnerModel.d.ts +14 -9
  49. package/sdk/partner/Lead/LeadPartnerModel.js +19 -17
  50. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +264 -49
  51. package/sdk/partner/Logistics/LogisticsPartnerClient.js +2116 -252
  52. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2256 -258
  53. package/sdk/partner/Logistics/LogisticsPartnerModel.js +1187 -230
  54. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +21 -1
  55. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +218 -13
  56. package/sdk/partner/PartnerClient.d.ts +5 -2
  57. package/sdk/partner/PartnerClient.js +21 -7
  58. package/sdk/partner/Theme/ThemePartnerClient.d.ts +32 -34
  59. package/sdk/partner/Theme/ThemePartnerClient.js +42 -44
  60. package/sdk/partner/Theme/ThemePartnerModel.d.ts +142 -43
  61. package/sdk/partner/Theme/ThemePartnerModel.js +129 -44
  62. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  63. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +83 -27
  64. package/sdk/partner/Webhook/WebhookPartnerClient.js +446 -27
  65. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +920 -185
  66. package/sdk/partner/Webhook/WebhookPartnerModel.js +462 -154
  67. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +5 -0
  68. package/sdk/partner/Webhook/WebhookPartnerValidator.js +41 -3
  69. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +8 -7
  70. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +17 -11
  71. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
  72. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  73. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +68 -13
  74. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +44 -6
  75. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +3 -33
  76. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -244
  77. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
  78. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
  79. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
  80. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
  81. package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
  82. package/sdk/platform/Billing/BillingPlatformClient.js +18 -18
  83. package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
  84. package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
  85. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
  86. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
  87. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +266 -203
  88. package/sdk/platform/Cart/CartPlatformApplicationClient.js +1446 -500
  89. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +729 -100
  90. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +446 -82
  91. package/sdk/platform/Cart/CartPlatformModel.d.ts +6927 -1396
  92. package/sdk/platform/Cart/CartPlatformModel.js +3065 -1316
  93. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +433 -248
  94. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1662 -559
  95. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +464 -159
  96. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +304 -87
  97. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +383 -234
  98. package/sdk/platform/Catalog/CatalogPlatformClient.js +2475 -1557
  99. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9573 -2678
  100. package/sdk/platform/Catalog/CatalogPlatformModel.js +5033 -1973
  101. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +364 -117
  102. package/sdk/platform/Catalog/CatalogPlatformValidator.js +281 -104
  103. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -4
  104. package/sdk/platform/Common/CommonPlatformClient.js +6 -5
  105. package/sdk/platform/Common/CommonPlatformModel.d.ts +36 -25
  106. package/sdk/platform/Common/CommonPlatformModel.js +25 -14
  107. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -153
  108. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +102 -541
  109. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +36 -49
  110. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +20 -60
  111. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
  112. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  113. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +189 -43
  114. package/sdk/platform/Communication/CommunicationPlatformModel.js +165 -42
  115. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +58 -81
  116. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +68 -116
  117. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +291 -249
  118. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +243 -234
  119. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  120. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  121. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +78 -65
  122. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +101 -88
  123. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +20 -20
  124. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -19
  125. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +68 -34
  126. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +174 -41
  127. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +667 -244
  128. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +474 -155
  129. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
  130. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
  131. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +366 -280
  132. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1435 -753
  133. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +323 -223
  134. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +335 -205
  135. package/sdk/platform/Content/ContentPlatformClient.d.ts +304 -106
  136. package/sdk/platform/Content/ContentPlatformClient.js +1842 -450
  137. package/sdk/platform/Content/ContentPlatformModel.d.ts +2582 -566
  138. package/sdk/platform/Content/ContentPlatformModel.js +1426 -558
  139. package/sdk/platform/Content/ContentPlatformValidator.d.ts +293 -114
  140. package/sdk/platform/Content/ContentPlatformValidator.js +328 -101
  141. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +59 -23
  142. package/sdk/platform/Discount/DiscountPlatformClient.js +84 -23
  143. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +403 -110
  144. package/sdk/platform/Discount/DiscountPlatformModel.js +121 -107
  145. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
  146. package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
  147. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +12 -110
  148. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +14 -684
  149. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -94
  150. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -115
  151. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -20
  152. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +22 -22
  153. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +90 -920
  154. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +53 -949
  155. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  156. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  157. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
  158. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
  159. package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
  160. package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
  161. package/sdk/platform/Lead/LeadPlatformModel.d.ts +14 -9
  162. package/sdk/platform/Lead/LeadPlatformModel.js +20 -18
  163. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +56 -9
  164. package/sdk/platform/Order/OrderPlatformApplicationClient.js +340 -10
  165. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +128 -24
  166. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +81 -19
  167. package/sdk/platform/Order/OrderPlatformClient.d.ts +517 -160
  168. package/sdk/platform/Order/OrderPlatformClient.js +1623 -384
  169. package/sdk/platform/Order/OrderPlatformModel.d.ts +10372 -1587
  170. package/sdk/platform/Order/OrderPlatformModel.js +5726 -1512
  171. package/sdk/platform/Order/OrderPlatformValidator.d.ts +539 -123
  172. package/sdk/platform/Order/OrderPlatformValidator.js +323 -92
  173. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +8 -6
  174. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +11 -9
  175. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
  176. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
  177. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +77 -25
  178. package/sdk/platform/Partner/PartnerPlatformModel.js +32 -21
  179. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +144 -219
  180. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +307 -796
  181. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +86 -121
  182. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +80 -138
  183. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +30 -30
  184. package/sdk/platform/Payment/PaymentPlatformClient.js +30 -30
  185. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +901 -761
  186. package/sdk/platform/Payment/PaymentPlatformModel.js +663 -583
  187. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
  188. package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
  189. package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
  190. package/sdk/platform/PlatformApplicationClient.js +0 -4
  191. package/sdk/platform/PlatformClient.d.ts +5 -4
  192. package/sdk/platform/PlatformClient.js +32 -22
  193. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +526 -69
  194. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +3337 -337
  195. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +603 -38
  196. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +529 -32
  197. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +184 -133
  198. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +780 -491
  199. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +9408 -1666
  200. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5720 -1765
  201. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +257 -180
  202. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +185 -127
  203. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
  204. package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
  205. package/sdk/platform/Share/SharePlatformModel.d.ts +45 -9
  206. package/sdk/platform/Share/SharePlatformModel.js +31 -6
  207. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -26
  208. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +38 -29
  209. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -3
  210. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +10 -2
  211. package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
  212. package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
  213. package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -17
  214. package/sdk/platform/Theme/ThemePlatformModel.js +92 -23
  215. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +167 -45
  216. package/sdk/platform/User/UserPlatformApplicationClient.js +950 -67
  217. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +189 -3
  218. package/sdk/platform/User/UserPlatformApplicationValidator.js +157 -3
  219. package/sdk/platform/User/UserPlatformModel.d.ts +880 -47
  220. package/sdk/platform/User/UserPlatformModel.js +607 -46
  221. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +33 -86
  222. package/sdk/platform/Webhook/WebhookPlatformClient.js +79 -474
  223. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +861 -422
  224. package/sdk/platform/Webhook/WebhookPlatformModel.js +469 -391
  225. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
  226. package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
  227. package/sdk/platform/index.d.ts +0 -2
  228. package/sdk/platform/index.js +0 -4
  229. package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
  230. package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
  231. package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
  232. package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
  233. package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
  234. package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
  235. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -4
  236. package/sdk/public/Configuration/ConfigurationPublicClient.js +9 -8
  237. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +41 -21
  238. package/sdk/public/Configuration/ConfigurationPublicModel.js +28 -12
  239. package/sdk/public/Content/ContentPublicClient.d.ts +145 -2
  240. package/sdk/public/Content/ContentPublicClient.js +1067 -17
  241. package/sdk/public/Content/ContentPublicModel.d.ts +704 -3
  242. package/sdk/public/Content/ContentPublicModel.js +751 -3
  243. package/sdk/public/Content/ContentPublicValidator.d.ts +94 -3
  244. package/sdk/public/Content/ContentPublicValidator.js +119 -2
  245. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  246. package/sdk/public/Partner/PartnerPublicClient.js +1 -1
  247. package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
  248. package/sdk/public/Partner/PartnerPublicModel.js +81 -71
  249. package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
  250. package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
  251. package/sdk/public/PublicClient.d.ts +5 -2
  252. package/sdk/public/PublicClient.js +16 -6
  253. package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -13
  254. package/sdk/public/Webhook/WebhookPublicClient.js +13 -13
  255. package/sdk/public/Webhook/WebhookPublicModel.d.ts +249 -67
  256. package/sdk/public/Webhook/WebhookPublicModel.js +81 -61
  257. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  258. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  259. package/sdk/public/index.d.ts +1 -0
  260. package/sdk/public/index.js +2 -0
  261. package/utility.d.ts +3 -0
  262. package/utility.js +7 -0
  263. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
  264. package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
  265. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +0 -19
  266. package/sdk/application/Webhook/WebhookApplicationClient.js +0 -72
  267. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
  268. package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
  269. package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
  270. package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
  271. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
  272. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
  273. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
  274. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
  275. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
  276. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
  277. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -382
  278. package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -408
@@ -14,6 +14,16 @@ export = CatalogPlatformApplicationValidator;
14
14
  */
15
15
  /**
16
16
  * @typedef CreateCollectionParam
17
+ * @property {string} [q] - Get collection list filtered by q string,
18
+ * @property {string} [scheduleStatus] - Get collection list filtered by scheduled status,
19
+ * @property {string} [type] - Type of the collections
20
+ * @property {string[]} [tags] - Each response will contain next_id param, which
21
+ * should be sent back to make pagination work.
22
+ * @property {boolean} [isActive] - Get collections filtered by active status.
23
+ * @property {number} [pageNo] - The page number to navigate through the given
24
+ * set of results.
25
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
26
+ * Default is 12.
17
27
  * @property {CatalogPlatformModel.CreateCollection} body
18
28
  */
19
29
  /**
@@ -45,9 +55,13 @@ export = CatalogPlatformApplicationValidator;
45
55
  * particular listing configuration type.
46
56
  * @property {CatalogPlatformModel.AppConfigurationsSort} body
47
57
  */
58
+ /**
59
+ * @typedef CreatePriceFactoryParam
60
+ * @property {CatalogPlatformModel.CreatePriceFactoryConfigSchema} body
61
+ */
48
62
  /**
49
63
  * @typedef CreateSearchConfigurationParam
50
- * @property {CatalogPlatformModel.CreateSearchConfigurationRequest} body
64
+ * @property {CatalogPlatformModel.CreateSearchConfigurationRequestSchema} body
51
65
  */
52
66
  /**
53
67
  * @typedef DeleteAppCategoryReturnConfigurationParam
@@ -76,12 +90,22 @@ export = CatalogPlatformApplicationValidator;
76
90
  * @property {string} configId - A `config_id` is a unique identifier of a
77
91
  * particular configuration.
78
92
  */
93
+ /**
94
+ * @typedef DeletePriceFactoryParam
95
+ * @property {string} priceFactoryId - A `price_factory_id` is a unique
96
+ * identifier for a particular price factory configuration.
97
+ */
79
98
  /** @typedef DeleteSearchConfigurationParam */
80
99
  /**
81
100
  * @typedef DeleteSearchKeywordsParam
82
101
  * @property {string} id - A `id` is a unique identifier for a particular
83
102
  * detail. Pass the `id` of the keywords which you want to delete.
84
103
  */
104
+ /**
105
+ * @typedef FollowProductByIdParam
106
+ * @property {string} userId - User ID of User
107
+ * @property {string} itemId - Item ID of Product
108
+ */
85
109
  /**
86
110
  * @typedef GetAllCollectionsParam
87
111
  * @property {string} [q] - Get collection list filtered by q string,
@@ -145,6 +169,10 @@ export = CatalogPlatformApplicationValidator;
145
169
  * @typedef GetAppProductParam
146
170
  * @property {string} itemId - Product id for a particular product.
147
171
  */
172
+ /**
173
+ * @typedef GetAppProductPricesParam
174
+ * @property {number[]} itemIds - List of item IDs for which to retrieve pricing.
175
+ */
148
176
  /**
149
177
  * @typedef GetAppProductsParam
150
178
  * @property {number[]} [brandIds] - Get multiple products filtered by Brand Ids
@@ -159,34 +187,6 @@ export = CatalogPlatformApplicationValidator;
159
187
  * @property {string} [q] - Search with Item Code, Name, Slug or Identifier.
160
188
  */
161
189
  /** @typedef GetAppReturnConfigurationParam */
162
- /**
163
- * @typedef GetAppicationProductsParam
164
- * @property {string} [q] - The search query. This can be a partial or complete
165
- * name of a either a product, brand or category
166
- * @property {string} [f] - The search filter parameters. All the parameter
167
- * filtered from filter parameters will be passed in **f** parameter in this
168
- * format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
169
- * @property {string} [c] - The search filter parameters for collection items.
170
- * All the parameter filtered from filter parameters will be passed in **c**
171
- * parameter in this format.
172
- * **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
173
- * @property {boolean} [filters] - Pass `filters` parameter to fetch the filter
174
- * details. This flag is used to fetch all filters
175
- * @property {boolean} [isDependent] - This query parameter is used to get the
176
- * dependent products in the listing.
177
- * @property {string} [sortOn] - The order to sort the list of products on. The
178
- * supported sort parameters are popularity, price, redemption and discount in
179
- * either ascending or descending order. See the supported values below.
180
- * @property {string} [pageId] - Each response will contain **page_id** param,
181
- * which should be sent back to make pagination work.
182
- * @property {number} [pageSize] - Number of items to retrieve in each page.
183
- * Default is 12.
184
- * @property {number} [pageNo] - If page_type is number then pass it to fetch
185
- * page items. Default is 1.
186
- * @property {string} [pageType] - For pagination type should be cursor or
187
- * number. Default is cursor.
188
- * @property {number[]} [itemIds] - Item Ids of product
189
- */
190
190
  /**
191
191
  * @typedef GetApplicationBrandListingParam
192
192
  * @property {number} [pageNo] - The page number to navigate through the given
@@ -234,25 +234,55 @@ export = CatalogPlatformApplicationValidator;
234
234
  /**
235
235
  * @typedef GetApplicationFilterKeysParam
236
236
  * @property {string} [c] - The search filter parameters for collection items.
237
- * All the parameter filtered from filter parameters will be passed in **c**
238
- * parameter in this format.
239
- * **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
237
+ * All the parameter filtered from filter parameters will be passed in "c"
238
+ * parameter in this format. "?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts"
240
239
  */
241
240
  /**
242
241
  * @typedef GetApplicationFilterValuesParam
243
- * @property {string} filterKey - A `filter_key` is a filter key for a for which
244
- * all the available filter values will returned. channel.
242
+ * @property {string} filterKey - A `filter_key` is a filter key which returns
243
+ * all the available filter values.
245
244
  * @property {string} [c] - The search filter parameters for collection items.
246
- * All the parameter filtered from filter parameters will be passed in **c**
247
- * parameter in this format.
248
- * **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
245
+ * All the parameter filtered from filter parameters will be passed in "c"
246
+ * parameter in this format. "?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts"
249
247
  * @property {string} [collectionId] - A `collection_id` is a unique identifier
250
- * for a particular collection. channel.
248
+ * for a particular collection.
251
249
  * @property {number} [pageNo] - The page number to navigate through the given
252
250
  * set of results
253
251
  * @property {number} [pageSize] - Number of items to retrieve in each page.
254
252
  * Default is 10.
255
- * @property {string} [q] - Get Values filtered by q string
253
+ * @property {string} [q] - The `q` parameter allows you to search and filter
254
+ * specific data within the filter options. It acts as a query keyword that
255
+ * can refine the results by matching relevant filter values, such as a
256
+ * category name or any other applicable filter criteria.
257
+ */
258
+ /**
259
+ * @typedef GetApplicationProductsParam
260
+ * @property {string} [q] - The search query. This can be a partial or complete
261
+ * name of a either a product, brand or category
262
+ * @property {string} [f] - The search filter parameters. All the parameter
263
+ * filtered from filter parameters will be passed in **f** parameter in this
264
+ * format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
265
+ * @property {string} [c] - The search filter parameters for collection items.
266
+ * All the parameter filtered from filter parameters will be passed in **c**
267
+ * parameter in this format.
268
+ * **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
269
+ * @property {boolean} [filters] - Pass `filters` parameter to fetch the filter
270
+ * details. This flag is used to fetch all filters
271
+ * @property {boolean} [isDependent] - This query parameter is used to get the
272
+ * dependent products in the listing.
273
+ * @property {string} [sortOn] - The order to sort the list of products on.
274
+ * Supported values include latest, popular, price_asc, price_dsc,
275
+ * discount_asc, discount_dsc. Custom sort keys configured via listing
276
+ * configuration (e.g., best_selling) are also supported for cohort-based sorting.
277
+ * @property {string} [pageId] - Each response will contain **page_id** param,
278
+ * which should be sent back to make pagination work.
279
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
280
+ * Default is 12.
281
+ * @property {number} [pageNo] - If page_type is number then pass it to fetch
282
+ * page items. Default is 1.
283
+ * @property {string} [pageType] - For pagination type should be cursor or
284
+ * number. Default is cursor.
285
+ * @property {string[]} [itemIds] - Item Ids of product
256
286
  */
257
287
  /** @typedef GetAutocompleteConfigParam */
258
288
  /**
@@ -280,17 +310,21 @@ export = CatalogPlatformApplicationValidator;
280
310
  */
281
311
  /**
282
312
  * @typedef GetCollectionItemsParam
283
- * @property {string} id - A `id` is a unique identifier of a collection.
284
- * @property {string} [sortOn] - Each response will contain sort_on param, which
285
- * should be sent back to make pagination work.
286
- * @property {string} [pageId] - Each response will contain next_id param, which
287
- * should be sent back to make pagination work.
313
+ * @property {string} collectionId - A `collection_id` is a unique identifier of
314
+ * a collection.
315
+ * @property {number} [pageNo] - The page number to navigate through the given
316
+ * set of results
288
317
  * @property {number} [pageSize] - Number of items to retrieve in each page.
289
- * Default is 12.
318
+ * Default is 10.
319
+ * @property {string} [q] - Query string to search collection items by substring
320
+ * match on item's name (case-insensitive) or exact item_code.
290
321
  */
291
322
  /**
292
323
  * @typedef GetConfigurationByTypeParam
293
324
  * @property {string} type - Type can be brands, categories etc.
325
+ * @property {boolean} [includeInactive] - Pass the `include_inactive` parameter
326
+ * to retrieve inactive brand or category details. This flag enables fetching
327
+ * all brands or categories,including those that are inactive.
294
328
  */
295
329
  /**
296
330
  * @typedef GetConfigurationMetadataParam
@@ -307,16 +341,22 @@ export = CatalogPlatformApplicationValidator;
307
341
  /** @typedef GetDepartmentsParam */
308
342
  /**
309
343
  * @typedef GetDiscountedInventoryBySizeIdentifierParam
310
- * @property {number} itemId - Item code of the product of which size is to be get.
311
- * @property {string} sizeIdentifier - Size Identifier (Seller Identifier or
312
- * Primary Identifier) of which inventory is to get.
344
+ * @property {number} itemId - A `item_id` is a unique identifier for a specific product.
345
+ * @property {number} sizeIdentifier - Size Identifier (Seller Identifier or
346
+ * Primary Identifier).
313
347
  * @property {number} [pageNo] - The page number to navigate through the given
314
348
  * set of results
315
349
  * @property {number} [pageSize] - Number of items to retrieve in each page.
316
350
  * Default is 12.
317
- * @property {string} [q] - Search with help of store code.
318
351
  * @property {number[]} [locationIds] - Search by store ids.
319
352
  */
353
+ /**
354
+ * @typedef GetFollowedProductsParam
355
+ * @property {string} userId - User ID to fetch the followed list
356
+ * @property {string} [pageId] - The identifier used to retrieve the next set of
357
+ * results. This parameter follows cursor-based pagination.
358
+ * @property {number} [pageSize] - Number of items per page
359
+ */
320
360
  /**
321
361
  * @typedef GetGroupConfigurationsParam
322
362
  * @property {string} configType - A `config_type` is an identifier that defines
@@ -339,11 +379,49 @@ export = CatalogPlatformApplicationValidator;
339
379
  * Default is 12.
340
380
  * @property {string} [search] - Get configuration list filtered by `search` string.
341
381
  */
382
+ /**
383
+ * @typedef GetPriceFactoriesParam
384
+ * @property {string} [q] - Optional q to filter price factories by name.
385
+ */
386
+ /**
387
+ * @typedef GetPriceFactoryParam
388
+ * @property {string} priceFactoryId - Unique identifier of the specific price
389
+ * factory to be retrieved.
390
+ */
391
+ /**
392
+ * @typedef GetPriceFactoryProductParam
393
+ * @property {string} priceFactoryId - A `price_factory_id` is a unique
394
+ * identifier for a particular sale channel.
395
+ * @property {number} itemId - A `item_id` is a unique identifier for a
396
+ * particular product.
397
+ */
398
+ /**
399
+ * @typedef GetPriceFactoryProductsParam
400
+ * @property {string} priceFactoryId - A `price_factory_id` uniquely identifies
401
+ * a price factory configuration for a specific application.
402
+ * @property {number[]} [brandIds] - Optional list of brand IDs to filter price
403
+ * factories associated with specific brands.
404
+ * @property {number[]} [categoryIds] - Optional list of category IDs to filter
405
+ * price factories related to specific product categories.
406
+ * @property {string} [sellerIdentifier] - Optional seller identifier to filter
407
+ * price factories associated with a particular seller.
408
+ * @property {string} [itemCode] - Optional item code to filter price factories
409
+ * configured for a specific product code.
410
+ * @property {string} [slug] - Optional slug to filter price factories by product slug.
411
+ * @property {string} [name] - Optional name to filter price factories by
412
+ * product or configuration name.
413
+ * @property {boolean} [active] - Optional name to filter price factories by
414
+ * product status.
415
+ * @property {number} [pageNo] - The page number to navigate through the given
416
+ * set of results
417
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
418
+ * Default is 12.
419
+ */
342
420
  /**
343
421
  * @typedef GetProductDetailBySlugParam
344
422
  * @property {string} slug - The unique identifier of a product. i.e; `slug` of
345
423
  * a product. You can retrieve these from the APIs that list products like
346
- * **v1.0/products/**
424
+ * "v1.0/products/"
347
425
  */
348
426
  /** @typedef GetQueryFiltersParam */
349
427
  /** @typedef GetSearchConfigurationParam */
@@ -352,9 +430,14 @@ export = CatalogPlatformApplicationValidator;
352
430
  * @property {string} id - A `id` is a unique identifier for a particular
353
431
  * detail. Pass the `id` of the keywords which you want to retrieve.
354
432
  */
433
+ /**
434
+ * @typedef UnfollowProductByIdParam
435
+ * @property {string} userId - User ID of User
436
+ * @property {string} itemId - Item ID of Product
437
+ */
355
438
  /**
356
439
  * @typedef UpdateAllowSingleParam
357
- * @property {CatalogPlatformModel.AllowSingleRequest} body
440
+ * @property {CatalogPlatformModel.AllowSingleRequestSchema} body
358
441
  */
359
442
  /**
360
443
  * @typedef UpdateAppBrandParam
@@ -374,18 +457,18 @@ export = CatalogPlatformApplicationValidator;
374
457
  */
375
458
  /**
376
459
  * @typedef UpdateAppDepartmentParam
377
- * @property {string} departmentUid - Department id for which the custom_json is
378
- * associated.
460
+ * @property {number} departmentUid - A `department id` is a unique identifier
461
+ * for a particular department.
379
462
  * @property {CatalogPlatformModel.ApplicationDepartmentJson} body
380
463
  */
381
464
  /**
382
465
  * @typedef UpdateAppLocationParam
383
- * @property {string} storeUid - Store id for which the custom_json is associated.
466
+ * @property {number} storeUid - Store id for which the custom_json is associated.
384
467
  * @property {CatalogPlatformModel.ApplicationStoreJson} body
385
468
  */
386
469
  /**
387
470
  * @typedef UpdateAppProductParam
388
- * @property {string} itemId - Product id for which the custom_meta is associated.
471
+ * @property {number} itemId - A `item_id` is a unique identifier for a particular item.
389
472
  * @property {CatalogPlatformModel.ApplicationItemMeta} body
390
473
  */
391
474
  /**
@@ -405,7 +488,7 @@ export = CatalogPlatformApplicationValidator;
405
488
  */
406
489
  /**
407
490
  * @typedef UpdateDefaultSortParam
408
- * @property {CatalogPlatformModel.DefaultKeyRequest} body
491
+ * @property {CatalogPlatformModel.DefaultKeyRequestSchema} body
409
492
  */
410
493
  /**
411
494
  * @typedef UpdateGroupConfigurationParam
@@ -423,9 +506,23 @@ export = CatalogPlatformApplicationValidator;
423
506
  * particular configuration.
424
507
  * @property {CatalogPlatformModel.AppConfigurationsSort} body
425
508
  */
509
+ /**
510
+ * @typedef UpdatePriceFactoryParam
511
+ * @property {string} priceFactoryId - Unique identifier of the specific price
512
+ * factory to be updated.
513
+ * @property {CatalogPlatformModel.UpdatePriceFactoryConfigSchema} body
514
+ */
515
+ /**
516
+ * @typedef UpdatePriceFactoryProductParam
517
+ * @property {string} priceFactoryId - A `price_factory_id` is a unique
518
+ * identifier for a specific price factory configuration.
519
+ * @property {number} itemId - A `item_id` is a unique identifier for a
520
+ * particular product.
521
+ * @property {CatalogPlatformModel.UpsertPriceFactoryProductSchema} body
522
+ */
426
523
  /**
427
524
  * @typedef UpdateSearchConfigurationParam
428
- * @property {CatalogPlatformModel.UpdateSearchConfigurationRequest} body
525
+ * @property {CatalogPlatformModel.UpdateSearchConfigurationRequestSchema} body
429
526
  */
430
527
  /**
431
528
  * @typedef UpdateSearchKeywordsParam
@@ -454,6 +551,8 @@ declare class CatalogPlatformApplicationValidator {
454
551
  static createGroupConfiguration(): CreateGroupConfigurationParam;
455
552
  /** @returns {CreateListingConfigurationParam} */
456
553
  static createListingConfiguration(): CreateListingConfigurationParam;
554
+ /** @returns {CreatePriceFactoryParam} */
555
+ static createPriceFactory(): CreatePriceFactoryParam;
457
556
  /** @returns {CreateSearchConfigurationParam} */
458
557
  static createSearchConfiguration(): CreateSearchConfigurationParam;
459
558
  /** @returns {DeleteAppCategoryReturnConfigurationParam} */
@@ -466,10 +565,14 @@ declare class CatalogPlatformApplicationValidator {
466
565
  static deleteGroupConfiguration(): DeleteGroupConfigurationParam;
467
566
  /** @returns {DeleteListingConfigurationParam} */
468
567
  static deleteListingConfiguration(): DeleteListingConfigurationParam;
568
+ /** @returns {DeletePriceFactoryParam} */
569
+ static deletePriceFactory(): DeletePriceFactoryParam;
469
570
  /** @returns {DeleteSearchConfigurationParam} */
470
571
  static deleteSearchConfiguration(): any;
471
572
  /** @returns {DeleteSearchKeywordsParam} */
472
573
  static deleteSearchKeywords(): DeleteSearchKeywordsParam;
574
+ /** @returns {FollowProductByIdParam} */
575
+ static followProductById(): FollowProductByIdParam;
473
576
  /** @returns {GetAllCollectionsParam} */
474
577
  static getAllCollections(): GetAllCollectionsParam;
475
578
  /** @returns {GetAllSearchKeywordParam} */
@@ -482,12 +585,12 @@ declare class CatalogPlatformApplicationValidator {
482
585
  static getAppLocations(): GetAppLocationsParam;
483
586
  /** @returns {GetAppProductParam} */
484
587
  static getAppProduct(): GetAppProductParam;
588
+ /** @returns {GetAppProductPricesParam} */
589
+ static getAppProductPrices(): GetAppProductPricesParam;
485
590
  /** @returns {GetAppProductsParam} */
486
591
  static getAppProducts(): GetAppProductsParam;
487
592
  /** @returns {GetAppReturnConfigurationParam} */
488
593
  static getAppReturnConfiguration(): any;
489
- /** @returns {GetAppicationProductsParam} */
490
- static getAppicationProducts(): GetAppicationProductsParam;
491
594
  /** @returns {GetApplicationBrandListingParam} */
492
595
  static getApplicationBrandListing(): GetApplicationBrandListingParam;
493
596
  /** @returns {GetApplicationBrandsParam} */
@@ -500,6 +603,8 @@ declare class CatalogPlatformApplicationValidator {
500
603
  static getApplicationFilterKeys(): GetApplicationFilterKeysParam;
501
604
  /** @returns {GetApplicationFilterValuesParam} */
502
605
  static getApplicationFilterValues(): GetApplicationFilterValuesParam;
606
+ /** @returns {GetApplicationProductsParam} */
607
+ static getApplicationProducts(): GetApplicationProductsParam;
503
608
  /** @returns {GetAutocompleteConfigParam} */
504
609
  static getAutocompleteConfig(): any;
505
610
  /** @returns {GetAutocompleteKeywordDetailParam} */
@@ -524,10 +629,20 @@ declare class CatalogPlatformApplicationValidator {
524
629
  static getDepartments(): any;
525
630
  /** @returns {GetDiscountedInventoryBySizeIdentifierParam} */
526
631
  static getDiscountedInventoryBySizeIdentifier(): GetDiscountedInventoryBySizeIdentifierParam;
632
+ /** @returns {GetFollowedProductsParam} */
633
+ static getFollowedProducts(): GetFollowedProductsParam;
527
634
  /** @returns {GetGroupConfigurationsParam} */
528
635
  static getGroupConfigurations(): GetGroupConfigurationsParam;
529
636
  /** @returns {GetListingConfigurationsParam} */
530
637
  static getListingConfigurations(): GetListingConfigurationsParam;
638
+ /** @returns {GetPriceFactoriesParam} */
639
+ static getPriceFactories(): GetPriceFactoriesParam;
640
+ /** @returns {GetPriceFactoryParam} */
641
+ static getPriceFactory(): GetPriceFactoryParam;
642
+ /** @returns {GetPriceFactoryProductParam} */
643
+ static getPriceFactoryProduct(): GetPriceFactoryProductParam;
644
+ /** @returns {GetPriceFactoryProductsParam} */
645
+ static getPriceFactoryProducts(): GetPriceFactoryProductsParam;
531
646
  /** @returns {GetProductDetailBySlugParam} */
532
647
  static getProductDetailBySlug(): GetProductDetailBySlugParam;
533
648
  /** @returns {GetQueryFiltersParam} */
@@ -536,6 +651,8 @@ declare class CatalogPlatformApplicationValidator {
536
651
  static getSearchConfiguration(): any;
537
652
  /** @returns {GetSearchKeywordsParam} */
538
653
  static getSearchKeywords(): GetSearchKeywordsParam;
654
+ /** @returns {UnfollowProductByIdParam} */
655
+ static unfollowProductById(): UnfollowProductByIdParam;
539
656
  /** @returns {UpdateAllowSingleParam} */
540
657
  static updateAllowSingle(): UpdateAllowSingleParam;
541
658
  /** @returns {UpdateAppBrandParam} */
@@ -562,13 +679,17 @@ declare class CatalogPlatformApplicationValidator {
562
679
  static updateGroupConfiguration(): UpdateGroupConfigurationParam;
563
680
  /** @returns {UpdateListingConfigurationParam} */
564
681
  static updateListingConfiguration(): UpdateListingConfigurationParam;
682
+ /** @returns {UpdatePriceFactoryParam} */
683
+ static updatePriceFactory(): UpdatePriceFactoryParam;
684
+ /** @returns {UpdatePriceFactoryProductParam} */
685
+ static updatePriceFactoryProduct(): UpdatePriceFactoryProductParam;
565
686
  /** @returns {UpdateSearchConfigurationParam} */
566
687
  static updateSearchConfiguration(): UpdateSearchConfigurationParam;
567
688
  /** @returns {UpdateSearchKeywordsParam} */
568
689
  static updateSearchKeywords(): UpdateSearchKeywordsParam;
569
690
  }
570
691
  declare namespace CatalogPlatformApplicationValidator {
571
- export { AddCollectionItemsParam, CreateAppCategoryReturnConfigurationParam, CreateAppReturnConfigurationParam, CreateCollectionParam, CreateConfigurationByTypeParam, CreateConfigurationProductListingParam, CreateCustomAutocompleteRuleParam, CreateCustomKeywordParam, CreateGroupConfigurationParam, CreateListingConfigurationParam, CreateSearchConfigurationParam, DeleteAppCategoryReturnConfigurationParam, DeleteAutocompleteKeywordParam, DeleteCollectionParam, DeleteGroupConfigurationParam, DeleteListingConfigurationParam, DeleteSearchConfigurationParam, DeleteSearchKeywordsParam, GetAllCollectionsParam, GetAllSearchKeywordParam, GetAppCategoryReturnConfigParam, GetAppInventoryParam, GetAppLocationsParam, GetAppProductParam, GetAppProductsParam, GetAppReturnConfigurationParam, GetAppicationProductsParam, GetApplicationBrandListingParam, GetApplicationBrandsParam, GetApplicationCategoryListingParam, GetApplicationDepartmentListingParam, GetApplicationFilterKeysParam, GetApplicationFilterValuesParam, GetAutocompleteConfigParam, GetAutocompleteKeywordDetailParam, GetCatalogConfigurationParam, GetCatalogInsightsParam, GetCategoriesParam, GetCollectionDetailParam, GetCollectionItemsParam, GetConfigurationByTypeParam, GetConfigurationMetadataParam, GetConfigurationsParam, GetDepartmentsParam, GetDiscountedInventoryBySizeIdentifierParam, GetGroupConfigurationsParam, GetListingConfigurationsParam, GetProductDetailBySlugParam, GetQueryFiltersParam, GetSearchConfigurationParam, GetSearchKeywordsParam, UpdateAllowSingleParam, UpdateAppBrandParam, UpdateAppCategoryParam, UpdateAppCategoryReturnConfigurationParam, UpdateAppDepartmentParam, UpdateAppLocationParam, UpdateAppProductParam, UpdateAppReturnConfigurationParam, UpdateAutocompleteKeywordParam, UpdateCollectionParam, UpdateDefaultSortParam, UpdateGroupConfigurationParam, UpdateListingConfigurationParam, UpdateSearchConfigurationParam, UpdateSearchKeywordsParam };
692
+ export { AddCollectionItemsParam, CreateAppCategoryReturnConfigurationParam, CreateAppReturnConfigurationParam, CreateCollectionParam, CreateConfigurationByTypeParam, CreateConfigurationProductListingParam, CreateCustomAutocompleteRuleParam, CreateCustomKeywordParam, CreateGroupConfigurationParam, CreateListingConfigurationParam, CreatePriceFactoryParam, CreateSearchConfigurationParam, DeleteAppCategoryReturnConfigurationParam, DeleteAutocompleteKeywordParam, DeleteCollectionParam, DeleteGroupConfigurationParam, DeleteListingConfigurationParam, DeletePriceFactoryParam, DeleteSearchConfigurationParam, DeleteSearchKeywordsParam, FollowProductByIdParam, GetAllCollectionsParam, GetAllSearchKeywordParam, GetAppCategoryReturnConfigParam, GetAppInventoryParam, GetAppLocationsParam, GetAppProductParam, GetAppProductPricesParam, GetAppProductsParam, GetAppReturnConfigurationParam, GetApplicationBrandListingParam, GetApplicationBrandsParam, GetApplicationCategoryListingParam, GetApplicationDepartmentListingParam, GetApplicationFilterKeysParam, GetApplicationFilterValuesParam, GetApplicationProductsParam, GetAutocompleteConfigParam, GetAutocompleteKeywordDetailParam, GetCatalogConfigurationParam, GetCatalogInsightsParam, GetCategoriesParam, GetCollectionDetailParam, GetCollectionItemsParam, GetConfigurationByTypeParam, GetConfigurationMetadataParam, GetConfigurationsParam, GetDepartmentsParam, GetDiscountedInventoryBySizeIdentifierParam, GetFollowedProductsParam, GetGroupConfigurationsParam, GetListingConfigurationsParam, GetPriceFactoriesParam, GetPriceFactoryParam, GetPriceFactoryProductParam, GetPriceFactoryProductsParam, GetProductDetailBySlugParam, GetQueryFiltersParam, GetSearchConfigurationParam, GetSearchKeywordsParam, UnfollowProductByIdParam, UpdateAllowSingleParam, UpdateAppBrandParam, UpdateAppCategoryParam, UpdateAppCategoryReturnConfigurationParam, UpdateAppDepartmentParam, UpdateAppLocationParam, UpdateAppProductParam, UpdateAppReturnConfigurationParam, UpdateAutocompleteKeywordParam, UpdateCollectionParam, UpdateDefaultSortParam, UpdateGroupConfigurationParam, UpdateListingConfigurationParam, UpdatePriceFactoryParam, UpdatePriceFactoryProductParam, UpdateSearchConfigurationParam, UpdateSearchKeywordsParam };
572
693
  }
573
694
  type AddCollectionItemsParam = {
574
695
  /**
@@ -584,6 +705,37 @@ type CreateAppReturnConfigurationParam = {
584
705
  body: CatalogPlatformModel.CreateUpdateAppReturnConfig;
585
706
  };
586
707
  type CreateCollectionParam = {
708
+ /**
709
+ * - Get collection list filtered by q string,
710
+ */
711
+ q?: string;
712
+ /**
713
+ * - Get collection list filtered by scheduled status,
714
+ */
715
+ scheduleStatus?: string;
716
+ /**
717
+ * - Type of the collections
718
+ */
719
+ type?: string;
720
+ /**
721
+ * - Each response will contain next_id param, which
722
+ * should be sent back to make pagination work.
723
+ */
724
+ tags?: string[];
725
+ /**
726
+ * - Get collections filtered by active status.
727
+ */
728
+ isActive?: boolean;
729
+ /**
730
+ * - The page number to navigate through the given
731
+ * set of results.
732
+ */
733
+ pageNo?: number;
734
+ /**
735
+ * - Number of items to retrieve in each page.
736
+ * Default is 12.
737
+ */
738
+ pageSize?: number;
587
739
  body: CatalogPlatformModel.CreateCollection;
588
740
  };
589
741
  type CreateConfigurationByTypeParam = {
@@ -618,8 +770,11 @@ type CreateListingConfigurationParam = {
618
770
  configType: string;
619
771
  body: CatalogPlatformModel.AppConfigurationsSort;
620
772
  };
773
+ type CreatePriceFactoryParam = {
774
+ body: CatalogPlatformModel.CreatePriceFactoryConfigSchema;
775
+ };
621
776
  type CreateSearchConfigurationParam = {
622
- body: CatalogPlatformModel.CreateSearchConfigurationRequest;
777
+ body: CatalogPlatformModel.CreateSearchConfigurationRequestSchema;
623
778
  };
624
779
  type DeleteAppCategoryReturnConfigurationParam = {
625
780
  body: CatalogPlatformModel.DeleteAppCategoryReturnConfig;
@@ -661,6 +816,13 @@ type DeleteListingConfigurationParam = {
661
816
  */
662
817
  configId: string;
663
818
  };
819
+ type DeletePriceFactoryParam = {
820
+ /**
821
+ * - A `price_factory_id` is a unique
822
+ * identifier for a particular price factory configuration.
823
+ */
824
+ priceFactoryId: string;
825
+ };
664
826
  type DeleteSearchKeywordsParam = {
665
827
  /**
666
828
  * - A `id` is a unique identifier for a particular
@@ -668,6 +830,16 @@ type DeleteSearchKeywordsParam = {
668
830
  */
669
831
  id: string;
670
832
  };
833
+ type FollowProductByIdParam = {
834
+ /**
835
+ * - User ID of User
836
+ */
837
+ userId: string;
838
+ /**
839
+ * - Item ID of Product
840
+ */
841
+ itemId: string;
842
+ };
671
843
  type GetAllCollectionsParam = {
672
844
  /**
673
845
  * - Get collection list filtered by q string,
@@ -818,6 +990,12 @@ type GetAppProductParam = {
818
990
  */
819
991
  itemId: string;
820
992
  };
993
+ type GetAppProductPricesParam = {
994
+ /**
995
+ * - List of item IDs for which to retrieve pricing.
996
+ */
997
+ itemIds: number[];
998
+ };
821
999
  type GetAppProductsParam = {
822
1000
  /**
823
1001
  * - Get multiple products filtered by Brand Ids
@@ -854,66 +1032,6 @@ type GetAppProductsParam = {
854
1032
  */
855
1033
  q?: string;
856
1034
  };
857
- type GetAppicationProductsParam = {
858
- /**
859
- * - The search query. This can be a partial or complete
860
- * name of a either a product, brand or category
861
- */
862
- q?: string;
863
- /**
864
- * - The search filter parameters. All the parameter
865
- * filtered from filter parameters will be passed in **f** parameter in this
866
- * format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
867
- */
868
- f?: string;
869
- /**
870
- * - The search filter parameters for collection items.
871
- * All the parameter filtered from filter parameters will be passed in **c**
872
- * parameter in this format.
873
- * **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
874
- */
875
- c?: string;
876
- /**
877
- * - Pass `filters` parameter to fetch the filter
878
- * details. This flag is used to fetch all filters
879
- */
880
- filters?: boolean;
881
- /**
882
- * - This query parameter is used to get the
883
- * dependent products in the listing.
884
- */
885
- isDependent?: boolean;
886
- /**
887
- * - The order to sort the list of products on. The
888
- * supported sort parameters are popularity, price, redemption and discount in
889
- * either ascending or descending order. See the supported values below.
890
- */
891
- sortOn?: string;
892
- /**
893
- * - Each response will contain **page_id** param,
894
- * which should be sent back to make pagination work.
895
- */
896
- pageId?: string;
897
- /**
898
- * - Number of items to retrieve in each page.
899
- * Default is 12.
900
- */
901
- pageSize?: number;
902
- /**
903
- * - If page_type is number then pass it to fetch
904
- * page items. Default is 1.
905
- */
906
- pageNo?: number;
907
- /**
908
- * - For pagination type should be cursor or
909
- * number. Default is cursor.
910
- */
911
- pageType?: string;
912
- /**
913
- * - Item Ids of product
914
- */
915
- itemIds?: number[];
916
- };
917
1035
  type GetApplicationBrandListingParam = {
918
1036
  /**
919
1037
  * - The page number to navigate through the given
@@ -1002,28 +1120,26 @@ type GetApplicationDepartmentListingParam = {
1002
1120
  type GetApplicationFilterKeysParam = {
1003
1121
  /**
1004
1122
  * - The search filter parameters for collection items.
1005
- * All the parameter filtered from filter parameters will be passed in **c**
1006
- * parameter in this format.
1007
- * **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
1123
+ * All the parameter filtered from filter parameters will be passed in "c"
1124
+ * parameter in this format. "?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts"
1008
1125
  */
1009
1126
  c?: string;
1010
1127
  };
1011
1128
  type GetApplicationFilterValuesParam = {
1012
1129
  /**
1013
- * - A `filter_key` is a filter key for a for which
1014
- * all the available filter values will returned. channel.
1130
+ * - A `filter_key` is a filter key which returns
1131
+ * all the available filter values.
1015
1132
  */
1016
1133
  filterKey: string;
1017
1134
  /**
1018
1135
  * - The search filter parameters for collection items.
1019
- * All the parameter filtered from filter parameters will be passed in **c**
1020
- * parameter in this format.
1021
- * **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
1136
+ * All the parameter filtered from filter parameters will be passed in "c"
1137
+ * parameter in this format. "?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts"
1022
1138
  */
1023
1139
  c?: string;
1024
1140
  /**
1025
1141
  * - A `collection_id` is a unique identifier
1026
- * for a particular collection. channel.
1142
+ * for a particular collection.
1027
1143
  */
1028
1144
  collectionId?: string;
1029
1145
  /**
@@ -1037,9 +1153,73 @@ type GetApplicationFilterValuesParam = {
1037
1153
  */
1038
1154
  pageSize?: number;
1039
1155
  /**
1040
- * - Get Values filtered by q string
1156
+ * - The `q` parameter allows you to search and filter
1157
+ * specific data within the filter options. It acts as a query keyword that
1158
+ * can refine the results by matching relevant filter values, such as a
1159
+ * category name or any other applicable filter criteria.
1160
+ */
1161
+ q?: string;
1162
+ };
1163
+ type GetApplicationProductsParam = {
1164
+ /**
1165
+ * - The search query. This can be a partial or complete
1166
+ * name of a either a product, brand or category
1041
1167
  */
1042
1168
  q?: string;
1169
+ /**
1170
+ * - The search filter parameters. All the parameter
1171
+ * filtered from filter parameters will be passed in **f** parameter in this
1172
+ * format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
1173
+ */
1174
+ f?: string;
1175
+ /**
1176
+ * - The search filter parameters for collection items.
1177
+ * All the parameter filtered from filter parameters will be passed in **c**
1178
+ * parameter in this format.
1179
+ * **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
1180
+ */
1181
+ c?: string;
1182
+ /**
1183
+ * - Pass `filters` parameter to fetch the filter
1184
+ * details. This flag is used to fetch all filters
1185
+ */
1186
+ filters?: boolean;
1187
+ /**
1188
+ * - This query parameter is used to get the
1189
+ * dependent products in the listing.
1190
+ */
1191
+ isDependent?: boolean;
1192
+ /**
1193
+ * - The order to sort the list of products on.
1194
+ * Supported values include latest, popular, price_asc, price_dsc,
1195
+ * discount_asc, discount_dsc. Custom sort keys configured via listing
1196
+ * configuration (e.g., best_selling) are also supported for cohort-based sorting.
1197
+ */
1198
+ sortOn?: string;
1199
+ /**
1200
+ * - Each response will contain **page_id** param,
1201
+ * which should be sent back to make pagination work.
1202
+ */
1203
+ pageId?: string;
1204
+ /**
1205
+ * - Number of items to retrieve in each page.
1206
+ * Default is 12.
1207
+ */
1208
+ pageSize?: number;
1209
+ /**
1210
+ * - If page_type is number then pass it to fetch
1211
+ * page items. Default is 1.
1212
+ */
1213
+ pageNo?: number;
1214
+ /**
1215
+ * - For pagination type should be cursor or
1216
+ * number. Default is cursor.
1217
+ */
1218
+ pageType?: string;
1219
+ /**
1220
+ * - Item Ids of product
1221
+ */
1222
+ itemIds?: string[];
1043
1223
  };
1044
1224
  type GetAutocompleteKeywordDetailParam = {
1045
1225
  /**
@@ -1073,30 +1253,37 @@ type GetCollectionDetailParam = {
1073
1253
  };
1074
1254
  type GetCollectionItemsParam = {
1075
1255
  /**
1076
- * - A `id` is a unique identifier of a collection.
1256
+ * - A `collection_id` is a unique identifier of
1257
+ * a collection.
1077
1258
  */
1078
- id: string;
1259
+ collectionId: string;
1079
1260
  /**
1080
- * - Each response will contain sort_on param, which
1081
- * should be sent back to make pagination work.
1082
- */
1083
- sortOn?: string;
1084
- /**
1085
- * - Each response will contain next_id param, which
1086
- * should be sent back to make pagination work.
1261
+ * - The page number to navigate through the given
1262
+ * set of results
1087
1263
  */
1088
- pageId?: string;
1264
+ pageNo?: number;
1089
1265
  /**
1090
1266
  * - Number of items to retrieve in each page.
1091
- * Default is 12.
1267
+ * Default is 10.
1092
1268
  */
1093
1269
  pageSize?: number;
1270
+ /**
1271
+ * - Query string to search collection items by substring
1272
+ * match on item's name (case-insensitive) or exact item_code.
1273
+ */
1274
+ q?: string;
1094
1275
  };
1095
1276
  type GetConfigurationByTypeParam = {
1096
1277
  /**
1097
1278
  * - Type can be brands, categories etc.
1098
1279
  */
1099
1280
  type: string;
1281
+ /**
1282
+ * - Pass the `include_inactive` parameter
1283
+ * to retrieve inactive brand or category details. This flag enables fetching
1284
+ * all brands or categories,including those that are inactive.
1285
+ */
1286
+ includeInactive?: boolean;
1100
1287
  };
1101
1288
  type GetConfigurationMetadataParam = {
1102
1289
  /**
@@ -1125,14 +1312,14 @@ type GetConfigurationMetadataParam = {
1125
1312
  };
1126
1313
  type GetDiscountedInventoryBySizeIdentifierParam = {
1127
1314
  /**
1128
- * - Item code of the product of which size is to be get.
1315
+ * - A `item_id` is a unique identifier for a specific product.
1129
1316
  */
1130
1317
  itemId: number;
1131
1318
  /**
1132
1319
  * - Size Identifier (Seller Identifier or
1133
- * Primary Identifier) of which inventory is to get.
1320
+ * Primary Identifier).
1134
1321
  */
1135
- sizeIdentifier: string;
1322
+ sizeIdentifier: number;
1136
1323
  /**
1137
1324
  * - The page number to navigate through the given
1138
1325
  * set of results
@@ -1143,15 +1330,26 @@ type GetDiscountedInventoryBySizeIdentifierParam = {
1143
1330
  * Default is 12.
1144
1331
  */
1145
1332
  pageSize?: number;
1146
- /**
1147
- * - Search with help of store code.
1148
- */
1149
- q?: string;
1150
1333
  /**
1151
1334
  * - Search by store ids.
1152
1335
  */
1153
1336
  locationIds?: number[];
1154
1337
  };
1338
+ type GetFollowedProductsParam = {
1339
+ /**
1340
+ * - User ID to fetch the followed list
1341
+ */
1342
+ userId: string;
1343
+ /**
1344
+ * - The identifier used to retrieve the next set of
1345
+ * results. This parameter follows cursor-based pagination.
1346
+ */
1347
+ pageId?: string;
1348
+ /**
1349
+ * - Number of items per page
1350
+ */
1351
+ pageSize?: number;
1352
+ };
1155
1353
  type GetGroupConfigurationsParam = {
1156
1354
  /**
1157
1355
  * - A `config_type` is an identifier that defines
@@ -1199,11 +1397,87 @@ type GetListingConfigurationsParam = {
1199
1397
  */
1200
1398
  search?: string;
1201
1399
  };
1400
+ type GetPriceFactoriesParam = {
1401
+ /**
1402
+ * - Optional q to filter price factories by name.
1403
+ */
1404
+ q?: string;
1405
+ };
1406
+ type GetPriceFactoryParam = {
1407
+ /**
1408
+ * - Unique identifier of the specific price
1409
+ * factory to be retrieved.
1410
+ */
1411
+ priceFactoryId: string;
1412
+ };
1413
+ type GetPriceFactoryProductParam = {
1414
+ /**
1415
+ * - A `price_factory_id` is a unique
1416
+ * identifier for a particular sale channel.
1417
+ */
1418
+ priceFactoryId: string;
1419
+ /**
1420
+ * - A `item_id` is a unique identifier for a
1421
+ * particular product.
1422
+ */
1423
+ itemId: number;
1424
+ };
1425
+ type GetPriceFactoryProductsParam = {
1426
+ /**
1427
+ * - A `price_factory_id` uniquely identifies
1428
+ * a price factory configuration for a specific application.
1429
+ */
1430
+ priceFactoryId: string;
1431
+ /**
1432
+ * - Optional list of brand IDs to filter price
1433
+ * factories associated with specific brands.
1434
+ */
1435
+ brandIds?: number[];
1436
+ /**
1437
+ * - Optional list of category IDs to filter
1438
+ * price factories related to specific product categories.
1439
+ */
1440
+ categoryIds?: number[];
1441
+ /**
1442
+ * - Optional seller identifier to filter
1443
+ * price factories associated with a particular seller.
1444
+ */
1445
+ sellerIdentifier?: string;
1446
+ /**
1447
+ * - Optional item code to filter price factories
1448
+ * configured for a specific product code.
1449
+ */
1450
+ itemCode?: string;
1451
+ /**
1452
+ * - Optional slug to filter price factories by product slug.
1453
+ */
1454
+ slug?: string;
1455
+ /**
1456
+ * - Optional name to filter price factories by
1457
+ * product or configuration name.
1458
+ */
1459
+ name?: string;
1460
+ /**
1461
+ * - Optional name to filter price factories by
1462
+ * product status.
1463
+ */
1464
+ active?: boolean;
1465
+ /**
1466
+ * - The page number to navigate through the given
1467
+ * set of results
1468
+ */
1469
+ pageNo?: number;
1470
+ /**
1471
+ * - Number of items to retrieve in each page.
1472
+ * Default is 12.
1473
+ */
1474
+ pageSize?: number;
1475
+ };
1202
1476
  type GetProductDetailBySlugParam = {
1203
1477
  /**
1204
1478
  * - The unique identifier of a product. i.e; `slug` of
1205
1479
  * a product. You can retrieve these from the APIs that list products like
1206
- * **v1.0/products/**
1480
+ * "v1.0/products/"
1207
1481
  */
1208
1482
  slug: string;
1209
1483
  };
@@ -1214,8 +1488,18 @@ type GetSearchKeywordsParam = {
1214
1488
  */
1215
1489
  id: string;
1216
1490
  };
1491
+ type UnfollowProductByIdParam = {
1492
+ /**
1493
+ * - User ID of User
1494
+ */
1495
+ userId: string;
1496
+ /**
1497
+ * - Item ID of Product
1498
+ */
1499
+ itemId: string;
1500
+ };
1217
1501
  type UpdateAllowSingleParam = {
1218
- body: CatalogPlatformModel.AllowSingleRequest;
1502
+ body: CatalogPlatformModel.AllowSingleRequestSchema;
1219
1503
  };
1220
1504
  type UpdateAppBrandParam = {
1221
1505
  /**
@@ -1238,24 +1522,24 @@ type UpdateAppCategoryReturnConfigurationParam = {
1238
1522
  };
1239
1523
  type UpdateAppDepartmentParam = {
1240
1524
  /**
1241
- * - Department id for which the custom_json is
1242
- * associated.
1525
+ * - A `department id` is a unique identifier
1526
+ * for a particular department.
1243
1527
  */
1244
- departmentUid: string;
1528
+ departmentUid: number;
1245
1529
  body: CatalogPlatformModel.ApplicationDepartmentJson;
1246
1530
  };
1247
1531
  type UpdateAppLocationParam = {
1248
1532
  /**
1249
1533
  * - Store id for which the custom_json is associated.
1250
1534
  */
1251
- storeUid: string;
1535
+ storeUid: number;
1252
1536
  body: CatalogPlatformModel.ApplicationStoreJson;
1253
1537
  };
1254
1538
  type UpdateAppProductParam = {
1255
1539
  /**
1256
- * - Product id for which the custom_meta is associated.
1540
+ * - A `item_id` is a unique identifier for a particular item.
1257
1541
  */
1258
- itemId: string;
1542
+ itemId: number;
1259
1543
  body: CatalogPlatformModel.ApplicationItemMeta;
1260
1544
  };
1261
1545
  type UpdateAppReturnConfigurationParam = {
@@ -1277,7 +1561,7 @@ type UpdateCollectionParam = {
1277
1561
  body: CatalogPlatformModel.UpdateCollection;
1278
1562
  };
1279
1563
  type UpdateDefaultSortParam = {
1280
- body: CatalogPlatformModel.DefaultKeyRequest;
1564
+ body: CatalogPlatformModel.DefaultKeyRequestSchema;
1281
1565
  };
1282
1566
  type UpdateGroupConfigurationParam = {
1283
1567
  /**
@@ -1305,8 +1589,29 @@ type UpdateListingConfigurationParam = {
1305
1589
  configId: string;
1306
1590
  body: CatalogPlatformModel.AppConfigurationsSort;
1307
1591
  };
1592
+ type UpdatePriceFactoryParam = {
1593
+ /**
1594
+ * - Unique identifier of the specific price
1595
+ * factory to be updated.
1596
+ */
1597
+ priceFactoryId: string;
1598
+ body: CatalogPlatformModel.UpdatePriceFactoryConfigSchema;
1599
+ };
1600
+ type UpdatePriceFactoryProductParam = {
1601
+ /**
1602
+ * - A `price_factory_id` is a unique
1603
+ * identifier for a specific price factory configuration.
1604
+ */
1605
+ priceFactoryId: string;
1606
+ /**
1607
+ * - A `item_id` is a unique identifier for a
1608
+ * particular product.
1609
+ */
1610
+ itemId: number;
1611
+ body: CatalogPlatformModel.UpsertPriceFactoryProductSchema;
1612
+ };
1308
1613
  type UpdateSearchConfigurationParam = {
1309
- body: CatalogPlatformModel.UpdateSearchConfigurationRequest;
1614
+ body: CatalogPlatformModel.UpdateSearchConfigurationRequestSchema;
1310
1615
  };
1311
1616
  type UpdateSearchKeywordsParam = {
1312
1617
  /**