@gofynd/fdk-client-javascript 1.6.4 → 3.1.0-beta.1

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 (290) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/ApplicationClient.d.ts +0 -2
  4. package/sdk/application/ApplicationClient.js +0 -2
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +100 -80
  6. package/sdk/application/Cart/CartApplicationClient.js +257 -126
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +3 -3
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +61 -21
  16. package/sdk/application/Content/ContentApplicationClient.js +250 -36
  17. package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
  18. package/sdk/application/Lead/LeadApplicationClient.js +3 -3
  19. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +106 -57
  20. package/sdk/application/Logistic/LogisticApplicationClient.js +326 -208
  21. package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
  22. package/sdk/application/Order/OrderApplicationClient.js +140 -21
  23. package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
  24. package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
  25. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
  26. package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
  27. package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
  28. package/sdk/application/Share/ShareApplicationClient.js +14 -14
  29. package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
  30. package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
  31. package/sdk/application/User/UserApplicationClient.d.ts +13 -23
  32. package/sdk/application/User/UserApplicationClient.js +9 -57
  33. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
  34. package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
  35. package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
  36. package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
  37. package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
  38. package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
  39. package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
  40. package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
  41. package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
  42. package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
  43. package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
  44. package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
  45. package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
  46. package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
  47. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +0 -10
  48. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +0 -75
  49. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +1 -54
  50. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +0 -43
  51. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
  52. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +0 -6
  53. package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
  54. package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
  55. package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
  56. package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
  57. package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
  58. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
  59. package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
  60. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
  61. package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
  62. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
  63. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
  64. package/sdk/partner/PartnerClient.d.ts +6 -0
  65. package/sdk/partner/PartnerClient.js +9 -0
  66. package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
  67. package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
  68. package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
  69. package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
  70. package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
  71. package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
  72. package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
  73. package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
  74. package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
  75. package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
  76. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
  77. package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
  78. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
  79. package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
  80. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -670
  81. package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -268
  82. package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
  83. package/sdk/partner/index.d.ts +3 -0
  84. package/sdk/partner/index.js +6 -0
  85. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
  86. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  87. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
  88. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
  89. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
  90. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
  91. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
  92. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
  93. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
  94. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
  95. package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
  96. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  97. package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
  98. package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
  99. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
  100. package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
  101. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +251 -172
  102. package/sdk/platform/Cart/CartPlatformApplicationClient.js +639 -521
  103. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
  104. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
  105. package/sdk/platform/Cart/CartPlatformModel.d.ts +3150 -4468
  106. package/sdk/platform/Cart/CartPlatformModel.js +2858 -1867
  107. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +976 -380
  108. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6475 -2015
  109. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1083 -162
  110. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +884 -80
  111. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +325 -568
  112. package/sdk/platform/Catalog/CatalogPlatformClient.js +1162 -1562
  113. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6008 -7688
  114. package/sdk/platform/Catalog/CatalogPlatformModel.js +9522 -6892
  115. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +234 -227
  116. package/sdk/platform/Catalog/CatalogPlatformValidator.js +183 -177
  117. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
  118. package/sdk/platform/Common/CommonPlatformClient.js +5 -6
  119. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  120. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  121. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -238
  122. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +876 -588
  123. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
  124. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
  125. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
  126. package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
  127. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +506 -270
  128. package/sdk/platform/Communication/CommunicationPlatformModel.js +611 -313
  129. package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
  130. package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
  131. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +78 -77
  132. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +97 -91
  133. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
  134. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
  135. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +31 -20
  136. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +25 -20
  137. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
  138. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
  139. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
  140. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
  141. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
  142. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
  143. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1206 -459
  144. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1011 -320
  145. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
  146. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
  147. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +255 -140
  148. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1095 -464
  149. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
  150. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
  151. package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
  152. package/sdk/platform/Content/ContentPlatformClient.js +459 -379
  153. package/sdk/platform/Content/ContentPlatformModel.d.ts +871 -1315
  154. package/sdk/platform/Content/ContentPlatformModel.js +940 -599
  155. package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
  156. package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
  157. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
  158. package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
  159. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
  160. package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
  161. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  162. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  163. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
  164. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
  165. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
  166. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
  167. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
  168. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
  169. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
  170. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
  171. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  172. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  173. package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
  174. package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
  175. package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
  176. package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
  177. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
  178. package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
  179. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
  180. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
  181. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
  182. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
  183. package/sdk/platform/Lead/LeadPlatformClient.d.ts +4 -24
  184. package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
  185. package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
  186. package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
  187. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
  188. package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
  189. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
  190. package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
  191. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
  192. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
  193. package/sdk/platform/Order/OrderPlatformClient.d.ts +486 -277
  194. package/sdk/platform/Order/OrderPlatformClient.js +1491 -938
  195. package/sdk/platform/Order/OrderPlatformModel.d.ts +4560 -8636
  196. package/sdk/platform/Order/OrderPlatformModel.js +3604 -4056
  197. package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
  198. package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
  199. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
  200. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
  201. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  202. package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
  203. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
  204. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
  205. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
  206. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
  207. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
  208. package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
  209. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3531 -1292
  210. package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1504
  211. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
  212. package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
  213. package/sdk/platform/PlatformClient.d.ts +2 -0
  214. package/sdk/platform/PlatformClient.js +4 -0
  215. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  216. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  217. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  218. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  219. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +14 -9
  220. package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
  221. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
  222. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2188 -302
  223. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +394 -54
  224. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +342 -37
  225. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +150 -212
  226. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +589 -1238
  227. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3581 -2960
  228. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3730 -1779
  229. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +230 -382
  230. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +164 -287
  231. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
  232. package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
  233. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
  234. package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
  235. package/sdk/platform/Share/SharePlatformModel.d.ts +11 -50
  236. package/sdk/platform/Share/SharePlatformModel.js +5 -43
  237. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +36 -16
  238. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +201 -58
  239. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +28 -17
  240. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +33 -16
  241. package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
  242. package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
  243. package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
  244. package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
  245. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
  246. package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
  247. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +18 -71
  248. package/sdk/platform/User/UserPlatformApplicationClient.js +27 -412
  249. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +10 -114
  250. package/sdk/platform/User/UserPlatformApplicationValidator.js +7 -80
  251. package/sdk/platform/User/UserPlatformModel.d.ts +216 -264
  252. package/sdk/platform/User/UserPlatformModel.js +209 -216
  253. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
  254. package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
  255. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +428 -810
  256. package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -444
  257. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
  258. package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
  259. package/sdk/platform/index.d.ts +1 -0
  260. package/sdk/platform/index.js +2 -0
  261. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
  262. package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
  263. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
  264. package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
  265. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
  266. package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
  267. package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
  268. package/sdk/public/Content/ContentPublicClient.js +183 -0
  269. package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
  270. package/sdk/public/Content/ContentPublicModel.js +47 -1
  271. package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
  272. package/sdk/public/Content/ContentPublicValidator.js +19 -0
  273. package/sdk/public/PublicClient.d.ts +0 -2
  274. package/sdk/public/PublicClient.js +0 -4
  275. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  276. package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
  277. package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
  278. package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
  279. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  280. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  281. package/sdk/public/index.d.ts +0 -1
  282. package/sdk/public/index.js +0 -2
  283. package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
  284. package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
  285. package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
  286. package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
  287. package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
  288. package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
  289. package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
  290. package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
@@ -2,217 +2,193 @@ export = Catalog;
2
2
  declare class Catalog {
3
3
  constructor(config: any);
4
4
  config: any;
5
- /**
6
- * @param {CatalogPlatformValidator.AddInventoryParam} arg - Arg object
7
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
8
- * @param {import("../PlatformAPIClient").Options} - Options
9
- * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
10
- * @name addInventory
11
- * @summary: Create Inventory
12
- * @description: Allows add Inventory for particular size and selling location. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/addInventory/).
13
- */
14
- addInventory({ itemId, size, body, requestHeaders }?: CatalogPlatformValidator.AddInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
15
5
  /**
16
6
  * @param {CatalogPlatformValidator.AllSizesParam} arg - Arg object
17
7
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
18
8
  * @param {import("../PlatformAPIClient").Options} - Options
19
9
  * @returns {Promise<CatalogPlatformModel.GetAllSizes>} - Success response
20
10
  * @name allSizes
21
- * @summary: Get product sizes
11
+ * @summary: Get all product sizes.
22
12
  * @description: Retrieve all available sizes for a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/allSizes/).
23
13
  */
24
14
  allSizes({ itemId, requestHeaders }?: CatalogPlatformValidator.AllSizesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAllSizes>;
25
- /**
26
- * @param {CatalogPlatformValidator.BulkHsnCodeParam} arg - Arg object
27
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
28
- * @param {import("../PlatformAPIClient").Options} - Options
29
- * @returns {Promise<CatalogPlatformModel.BulkHsnResponseSchema>} - Success response
30
- * @name bulkHsnCode
31
- * @summary: Create Bulk update HSN
32
- * @description: Execute bulk updates for HSN codes across multiple products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/bulkHsnCode/).
33
- */
34
- bulkHsnCode({ body, requestHeaders }?: CatalogPlatformValidator.BulkHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkHsnResponseSchema>;
35
15
  /**
36
16
  * @param {CatalogPlatformValidator.CreateBulkInventoryParam} arg - Arg object
37
17
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
38
18
  * @param {import("../PlatformAPIClient").Options} - Options
39
- * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
19
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
40
20
  * @name createBulkInventory
41
- * @summary: Create bulk inventory
21
+ * @summary: Create bulk inventory.
42
22
  * @description: Helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkInventory/).
43
23
  */
44
- createBulkInventory({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
24
+ createBulkInventory({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
45
25
  /**
46
26
  * @param {CatalogPlatformValidator.CreateBulkInventoryJobParam} arg - Arg object
47
27
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
48
28
  * @param {import("../PlatformAPIClient").Options} - Options
49
- * @returns {Promise<CatalogPlatformModel.BulkResponseSchema>} - Success response
29
+ * @returns {Promise<CatalogPlatformModel.InventoryBulkResponse>} - Success response
50
30
  * @name createBulkInventoryJob
51
- * @summary: Create bulk inventory upload job
31
+ * @summary: Create bulk inventory upload job.
52
32
  * @description: Helps to create a bulk Inventory upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkInventoryJob/).
53
33
  */
54
- createBulkInventoryJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponseSchema>;
34
+ createBulkInventoryJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryBulkResponse>;
55
35
  /**
56
36
  * @param {CatalogPlatformValidator.CreateBulkProductUploadJobParam} arg - Arg object
57
37
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
58
38
  * @param {import("../PlatformAPIClient").Options} - Options
59
- * @returns {Promise<CatalogPlatformModel.BulkResponseSchema>} - Success response
39
+ * @returns {Promise<CatalogPlatformModel.ProductBulkResponse>} - Success response
60
40
  * @name createBulkProductUploadJob
61
- * @summary: Create products bulk upload
41
+ * @summary: Create a Bulk product to upload job.
62
42
  * @description: This API helps to create a bulk products upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkProductUploadJob/).
63
43
  */
64
- createBulkProductUploadJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponseSchema>;
44
+ createBulkProductUploadJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductBulkResponse>;
65
45
  /**
66
46
  * @param {CatalogPlatformValidator.CreateInventoryExportParam} arg - Arg object
67
47
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
68
48
  * @param {import("../PlatformAPIClient").Options} - Options
69
- * @returns {Promise<CatalogPlatformModel.InventoryExportResponseSchema>} -
70
- * Success response
49
+ * @returns {Promise<CatalogPlatformModel.InventoryExportResponse>} - Success response
71
50
  * @name createInventoryExport
72
- * @summary: Create inventory export
73
- * @description: creates export job for inventory data associated with a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExport/).
51
+ * @summary: Create inventory export.
52
+ * @description: Helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExport/).
74
53
  */
75
- createInventoryExport({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponseSchema>;
54
+ createInventoryExport({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponse>;
76
55
  /**
77
56
  * @param {CatalogPlatformValidator.CreateInventoryExportJobParam} arg - Arg object
78
57
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
79
58
  * @param {import("../PlatformAPIClient").Options} - Options
80
- * @returns {Promise<CatalogPlatformModel.InventoryExportResponseSchema>} -
81
- * Success response
59
+ * @returns {Promise<CatalogPlatformModel.InventoryExportResponse>} - Success response
82
60
  * @name createInventoryExportJob
83
- * @summary: Create inventory export job
61
+ * @summary: Create inventory export job.
84
62
  * @description: Helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExportJob/).
85
63
  */
86
- createInventoryExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponseSchema>;
64
+ createInventoryExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponse>;
87
65
  /**
88
66
  * @param {CatalogPlatformValidator.CreateMarketplaceOptinParam} arg - Arg object
89
67
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
90
68
  * @param {import("../PlatformAPIClient").Options} - Options
91
- * @returns {Promise<CatalogPlatformModel.CreateMarketplaceOptinResponseSchema>}
69
+ * @returns {Promise<CatalogPlatformModel.CreateMarketplaceOptinResponse>}
92
70
  * - Success response
93
71
  *
94
72
  * @name createMarketplaceOptin
95
- * @summary: Create or Update opt-in infomation
96
- * @description: Allows to create opt-in information for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createMarketplaceOptin/).
73
+ * @summary: Update marketplace optin
74
+ * @description: This API allows to create marketplace optin for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createMarketplaceOptin/).
97
75
  */
98
- createMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.CreateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateMarketplaceOptinResponseSchema>;
76
+ createMarketplaceOptin({ marketplace, body, requestHeaders }?: CatalogPlatformValidator.CreateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateMarketplaceOptinResponse>;
99
77
  /**
100
78
  * @param {CatalogPlatformValidator.CreateProductParam} arg - Arg object
101
79
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
102
80
  * @param {import("../PlatformAPIClient").Options} - Options
103
- * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
81
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
104
82
  * @name createProduct
105
- * @summary: Create product
106
- * @description: Users can create a product using this API, associating it with the provided company ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProduct/).
83
+ * @summary: Create a product.
84
+ * @description: Allows to create product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProduct/).
107
85
  */
108
- createProduct({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
86
+ createProduct({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
109
87
  /**
110
88
  * @param {CatalogPlatformValidator.CreateProductAssetsInBulkParam} arg - Arg object
111
89
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
112
90
  * @param {import("../PlatformAPIClient").Options} - Options
113
- * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
91
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
114
92
  * @name createProductAssetsInBulk
115
- * @summary: Create product assets in bulk
93
+ * @summary: Create product assets in bulk.
116
94
  * @description: Helps to create a bulk asset upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductAssetsInBulk/).
117
95
  */
118
- createProductAssetsInBulk({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
96
+ createProductAssetsInBulk({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
119
97
  /**
120
98
  * @param {CatalogPlatformValidator.CreateProductBundleParam} arg - Arg object
121
99
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
122
100
  * @param {import("../PlatformAPIClient").Options} - Options
123
- * @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>}
101
+ * @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponse>}
124
102
  * - Success response
125
103
  *
126
104
  * @name createProductBundle
127
- * @summary: Create product bundle
128
- * @description: Create product bundle in the catalog associated to a specific company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductBundle/).
105
+ * @summary: Create a product bundle.
106
+ * @description: Create product bundle in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductBundle/).
129
107
  */
130
- createProductBundle({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>;
108
+ createProductBundle({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponse>;
131
109
  /**
132
110
  * @param {CatalogPlatformValidator.CreateProductExportJobParam} arg - Arg object
133
111
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
134
112
  * @param {import("../PlatformAPIClient").Options} - Options
135
- * @returns {Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>}
113
+ * @returns {Promise<CatalogPlatformModel.CreateProductDownloadsResponse>}
136
114
  * - Success response
137
115
  *
138
116
  * @name createProductExportJob
139
- * @summary: Create product export job
140
- * @description: Allows to create a product export job for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductExportJob/).
117
+ * @summary: Create product export job.
118
+ * @description: Helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductExportJob/).
141
119
  */
142
- createProductExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>;
120
+ createProductExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateProductDownloadsResponse>;
143
121
  /**
144
122
  * @param {CatalogPlatformValidator.CreateProductsInBulkParam} arg - Arg object
145
123
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
146
124
  * @param {import("../PlatformAPIClient").Options} - Options
147
- * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
125
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
148
126
  * @name createProductsInBulk
149
- * @summary: Create products in bulk
127
+ * @summary: Create products in bulk.
150
128
  * @description: Helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductsInBulk/).
151
129
  */
152
- createProductsInBulk({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateProductsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
130
+ createProductsInBulk({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateProductsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
153
131
  /**
154
132
  * @param {CatalogPlatformValidator.CreateSizeGuideParam} arg - Arg object
155
133
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
156
134
  * @param {import("../PlatformAPIClient").Options} - Options
157
- * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
135
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
158
136
  * @name createSizeGuide
159
- * @summary: Create size guide
160
- * @description: Allows to create a size guide associated to a seller - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSizeGuide/).
137
+ * @summary: Create a size guide.
138
+ * @description: Allows to create a size guide associated to a brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSizeGuide/).
161
139
  */
162
- createSizeGuide({ body, requestHeaders }?: CatalogPlatformValidator.CreateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
140
+ createSizeGuide({ body, requestHeaders }?: CatalogPlatformValidator.CreateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
163
141
  /**
164
142
  * @param {CatalogPlatformValidator.DeleteBulkInventoryJobParam} arg - Arg object
165
143
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
166
144
  * @param {import("../PlatformAPIClient").Options} - Options
167
- * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
145
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
168
146
  * @name deleteBulkInventoryJob
169
- * @summary: Delete inventory bulk upload job
147
+ * @summary: Delete inventory bulk upload job.
170
148
  * @description: Allows to delete bulk Inventory job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteBulkInventoryJob/).
171
149
  */
172
- deleteBulkInventoryJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
150
+ deleteBulkInventoryJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
173
151
  /**
174
152
  * @param {CatalogPlatformValidator.DeleteProductParam} arg - Arg object
175
153
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
176
154
  * @param {import("../PlatformAPIClient").Options} - Options
177
- * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
155
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
178
156
  * @name deleteProduct
179
- * @summary: Delete product
180
- * @description: Users can delete a product by providing the item_id and company_id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProduct/).
157
+ * @summary: Delete a product.
158
+ * @description: Remove a specific product in the catalog - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProduct/).
181
159
  */
182
- deleteProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.DeleteProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
160
+ deleteProduct({ itemId, requestHeaders }?: CatalogPlatformValidator.DeleteProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
183
161
  /**
184
162
  * @param {CatalogPlatformValidator.DeleteProductBulkJobParam} arg - Arg object
185
163
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
186
164
  * @param {import("../PlatformAPIClient").Options} - Options
187
- * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
165
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
188
166
  * @name deleteProductBulkJob
189
- * @summary: Delete product bulk-upload job
167
+ * @summary: Delete product bulk upload job.
190
168
  * @description: Allows to delete bulk product job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProductBulkJob/).
191
169
  */
192
- deleteProductBulkJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteProductBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
170
+ deleteProductBulkJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteProductBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
193
171
  /**
194
172
  * @param {CatalogPlatformValidator.DeleteRealtimeInventoryParam} arg - Arg object
195
173
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
196
174
  * @param {import("../PlatformAPIClient").Options} - Options
197
- * @returns {Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>} -
198
- * Success response
175
+ * @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
199
176
  * @name deleteRealtimeInventory
200
- * @summary: Delete an inventory
201
- * @description: You can use this API to delete inventory linked to a particular product size. When you make the API call, the inventory associated with that size will be removed as part of api process. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteRealtimeInventory/).
177
+ * @summary: Delete realtime inventory.
178
+ * @description: Remove specific realtime inventory data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteRealtimeInventory/).
202
179
  */
203
- deleteRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.DeleteRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>;
180
+ deleteRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.DeleteRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
204
181
  /**
205
182
  * @param {CatalogPlatformValidator.DeleteSizeParam} arg - Arg object
206
183
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
207
184
  * @param {import("../PlatformAPIClient").Options} - Options
208
- * @returns {Promise<CatalogPlatformModel.ProductSizeDeleteResponseSchema>}
209
- * - Success response
210
- *
185
+ * @returns {Promise<CatalogPlatformModel.ProductSizeDeleteResponse>} -
186
+ * Success response
211
187
  * @name deleteSize
212
- * @summary: Delete product size
188
+ * @summary: Delete product size.
213
189
  * @description: Allows to delete size associated with product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSize/).
214
190
  */
215
- deleteSize({ itemId, size, requestHeaders }?: CatalogPlatformValidator.DeleteSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductSizeDeleteResponseSchema>;
191
+ deleteSize({ itemId, size, requestHeaders }?: CatalogPlatformValidator.DeleteSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductSizeDeleteResponse>;
216
192
  /**
217
193
  * @param {CatalogPlatformValidator.DownloadInventoryTemplateViewParam} arg
218
194
  * - Arg object
@@ -221,10 +197,10 @@ declare class Catalog {
221
197
  * @param {import("../PlatformAPIClient").Options} - Options
222
198
  * @returns {Promise<string>} - Success response
223
199
  * @name downloadInventoryTemplateView
224
- * @summary: Download inventory template data
225
- * @description: Allows you to download inventory product template data for a specific company in formats like csv and excel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadInventoryTemplateView/).
200
+ * @summary: Download inventory template view.
201
+ * @description: Allows you to download product template data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadInventoryTemplateView/).
226
202
  */
227
- downloadInventoryTemplateView({ itemType, requestHeaders }?: CatalogPlatformValidator.DownloadInventoryTemplateViewParam, { responseHeaders }?: object): Promise<string>;
203
+ downloadInventoryTemplateView({ type, requestHeaders }?: CatalogPlatformValidator.DownloadInventoryTemplateViewParam, { responseHeaders }?: object): Promise<string>;
228
204
  /**
229
205
  * @param {CatalogPlatformValidator.DownloadProductTemplateViewsParam} arg
230
206
  * - Arg object
@@ -233,30 +209,30 @@ declare class Catalog {
233
209
  * @param {import("../PlatformAPIClient").Options} - Options
234
210
  * @returns {Promise<string>} - Success response
235
211
  * @name downloadProductTemplateViews
236
- * @summary: Download product template view
237
- * @description: Allows you to download product template data by its slug for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadProductTemplateViews/).
212
+ * @summary: Download product template views.
213
+ * @description: Allows you to download product template data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadProductTemplateViews/).
238
214
  */
239
215
  downloadProductTemplateViews({ slug, itemType, type, requestHeaders }?: CatalogPlatformValidator.DownloadProductTemplateViewsParam, { responseHeaders }?: object): Promise<string>;
240
216
  /**
241
217
  * @param {CatalogPlatformValidator.EditProductParam} arg - Arg object
242
218
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
243
219
  * @param {import("../PlatformAPIClient").Options} - Options
244
- * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
220
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
245
221
  * @name editProduct
246
- * @summary: Update a product
222
+ * @summary: Edit a product.
247
223
  * @description: Modify the details and settings of an existing product in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/editProduct/).
248
224
  */
249
- editProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.EditProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
225
+ editProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.EditProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
250
226
  /**
251
227
  * @param {CatalogPlatformValidator.ExportInventoryConfigParam} arg - Arg object
252
228
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
253
229
  * @param {import("../PlatformAPIClient").Options} - Options
254
230
  * @returns {Promise<CatalogPlatformModel.InventoryConfig>} - Success response
255
231
  * @name exportInventoryConfig
256
- * @summary: Get export inventory configuration
232
+ * @summary: Export inventory configuration.
257
233
  * @description: Retrieve List of different filters like brand, store, and type for inventory export. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/exportInventoryConfig/).
258
234
  */
259
- exportInventoryConfig({ filterType, requestHeaders }?: CatalogPlatformValidator.ExportInventoryConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryConfig>;
235
+ exportInventoryConfig({ filter, requestHeaders }?: CatalogPlatformValidator.ExportInventoryConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryConfig>;
260
236
  /**
261
237
  * @param {CatalogPlatformValidator.GetAllProductHsnCodesParam} arg - Arg object
262
238
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -265,8 +241,8 @@ declare class Catalog {
265
241
  * - Success response
266
242
  *
267
243
  * @name getAllProductHsnCodes
268
- * @summary: List product HSN codes
269
- * @description: Retrieve all HSN codes associated with company products and provide search capabilities based on HSN code, reporting HSN, etc - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllProductHsnCodes/).
244
+ * @summary: Get all product HSN codes.
245
+ * @description: Retrieve all HSN codes associated with products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllProductHsnCodes/).
270
246
  */
271
247
  getAllProductHsnCodes({ pageNo, pageSize, q, type, requestHeaders }?: CatalogPlatformValidator.GetAllProductHsnCodesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCodesListingResponseSchemaV2>;
272
248
  /**
@@ -283,13 +259,12 @@ declare class Catalog {
283
259
  * @param {CatalogPlatformValidator.GetCategoryDataParam} arg - Arg object
284
260
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
285
261
  * @param {import("../PlatformAPIClient").Options} - Options
286
- * @returns {Promise<CatalogPlatformModel.SingleCategoryResponseSchema>} -
287
- * Success response
262
+ * @returns {Promise<CatalogPlatformModel.SingleCategoryResponse>} - Success response
288
263
  * @name getCategoryData
289
- * @summary: Get category by uid
290
- * @description: Retrieve detailed information about a specific category by its uid for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategoryData/).
264
+ * @summary: Get category data.
265
+ * @description: Retrieve detailed information about a specific category with the associated meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategoryData/).
291
266
  */
292
- getCategoryData({ uid, requestHeaders }?: CatalogPlatformValidator.GetCategoryDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleCategoryResponseSchema>;
267
+ getCategoryData({ uid, requestHeaders }?: CatalogPlatformValidator.GetCategoryDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleCategoryResponse>;
293
268
  /**
294
269
  * @param {CatalogPlatformValidator.GetCompanyBrandDetailParam} arg - Arg object
295
270
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -297,18 +272,29 @@ declare class Catalog {
297
272
  * @returns {Promise<CatalogPlatformModel.OptinCompanyBrandDetailsView>} -
298
273
  * Success response
299
274
  * @name getCompanyBrandDetail
300
- * @summary: list Company Brand of Optin
301
- * @description: Get the details of the Brands associated with the given company_id passed which has opt-in. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyBrandDetail/).
275
+ * @summary: Get the Company Brand details of Optin.
276
+ * @description: Get the details of the Brands associated with the given company_id passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyBrandDetail/).
302
277
  */
303
278
  getCompanyBrandDetail({ isActive, q, pageNo, pageSize, marketplace, requestHeaders }?: CatalogPlatformValidator.GetCompanyBrandDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyBrandDetailsView>;
279
+ /**
280
+ * @param {CatalogPlatformValidator.GetCompanyBrandsDRIParam} arg - Arg object
281
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
282
+ * @param {import("../PlatformAPIClient").Options} - Options
283
+ * @returns {Promise<CatalogPlatformModel.CompanyDRIListResponseSchema>} -
284
+ * Success response
285
+ * @name getCompanyBrandsDRI
286
+ * @summary: Get support representative's associated to a company
287
+ * @description: This API helps to view support representative's associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyBrandsDRI/).
288
+ */
289
+ getCompanyBrandsDRI({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetCompanyBrandsDRIParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CompanyDRIListResponseSchema>;
304
290
  /**
305
291
  * @param {CatalogPlatformValidator.GetCompanyDetailParam} arg - Arg object
306
292
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
307
293
  * @param {import("../PlatformAPIClient").Options} - Options
308
294
  * @returns {Promise<CatalogPlatformModel.OptinCompanyDetail>} - Success response
309
295
  * @name getCompanyDetail
310
- * @summary: Get Company
311
- * @description: Get the details of the company associated with the given company_id passed which has opt-in. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyDetail/).
296
+ * @summary: Get the Company details.
297
+ * @description: Get the details of the company associated with the given company_id passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyDetail/).
312
298
  */
313
299
  getCompanyDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyDetail>;
314
300
  /**
@@ -317,28 +303,38 @@ declare class Catalog {
317
303
  * @param {import("../PlatformAPIClient").Options} - Options
318
304
  * @returns {Promise<CatalogPlatformModel.OptinCompanyMetrics>} - Success response
319
305
  * @name getCompanyMetrics
320
- * @summary: Get company metrics
321
- * @description: Allows viewing company metrics, including brand and store status, as well as the number of verified and unverified products, company documents, and store documents. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyMetrics/).
306
+ * @summary: Get company metrics.
307
+ * @description: Allows to view the company metrics, i.e. the status of its brand and stores. Also its allows to view the number of products, company documents & store documents which are verified and unverified. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyMetrics/).
322
308
  */
323
309
  getCompanyMetrics({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyMetrics>;
324
310
  /**
325
- * @param {CatalogPlatformValidator.GetDepartmentDataParam} arg - Arg object
311
+ * @param {CatalogPlatformValidator.GetCompanyVerificationParam} arg - Arg object
326
312
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
327
313
  * @param {import("../PlatformAPIClient").Options} - Options
328
- * @returns {Promise<CatalogPlatformModel.DepartmentsResponseSchema>} -
314
+ * @returns {Promise<CatalogPlatformModel.CompanyVerificationResponse>} -
329
315
  * Success response
316
+ * @name getCompanyVerification
317
+ * @summary: Get company verification status
318
+ * @description: This API gets company verification details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyVerification/).
319
+ */
320
+ getCompanyVerification({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetCompanyVerificationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CompanyVerificationResponse>;
321
+ /**
322
+ * @param {CatalogPlatformValidator.GetDepartmentDataParam} arg - Arg object
323
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
324
+ * @param {import("../PlatformAPIClient").Options} - Options
325
+ * @returns {Promise<CatalogPlatformModel.DepartmentsResponse>} - Success response
330
326
  * @name getDepartmentData
331
- * @summary: Get department by uid
332
- * @description: Retrieve detailed information about a specific department for a specific company by uid. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartmentData/).
327
+ * @summary: Get department data.
328
+ * @description: Retrieve detailed information about a specific department by UID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartmentData/).
333
329
  */
334
- getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponseSchema>;
330
+ getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
335
331
  /**
336
332
  * @param {CatalogPlatformValidator.GetHsnCodeParam} arg - Arg object
337
333
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
338
334
  * @param {import("../PlatformAPIClient").Options} - Options
339
335
  * @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
340
336
  * @name getHsnCode
341
- * @summary: List HSN code
337
+ * @summary: Get HSN code.
342
338
  * @description: Retrieve the HSN code for a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getHsnCode/).
343
339
  */
344
340
  getHsnCode({ id, requestHeaders }?: CatalogPlatformValidator.GetHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCode>;
@@ -346,60 +342,12 @@ declare class Catalog {
346
342
  * @param {CatalogPlatformValidator.GetInventoriesParam} arg - Arg object
347
343
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
348
344
  * @param {import("../PlatformAPIClient").Options} - Options
349
- * @returns {Promise<CatalogPlatformModel.GetInventoriesResponseSchema>} -
350
- * Success response
345
+ * @returns {Promise<CatalogPlatformModel.GetInventoriesResponse>} - Success response
351
346
  * @name getInventories
352
- * @summary: List Inventory
353
- * @description: Allows to get Inventories data for particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventories/).
354
- */
355
- getInventories({ itemId, size, pageNo, pageSize, pageId, pageType, q, sellable, storeIds, brandIds, sellerIdentifiers, qtyGt, qtyLt, qtyType, fromDate, toDate, sizeIdentifier, requestHeaders, }?: CatalogPlatformValidator.GetInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetInventoriesResponseSchema>;
356
- /**
357
- * @param {Object} arg - Arg object.
358
- * @param {string} [arg.itemId] - Item code of the product of which size is to be get.
359
- * @param {string} [arg.size] - Size of which inventory is to get.
360
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
361
- * page. Default is 12.
362
- * @param {string} [arg.q] - Search with help of store code.
363
- * @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
364
- * @param {number[]} [arg.storeIds] - The Store Id of products to fetch inventory.
365
- * @param {number[]} [arg.brandIds] - The Brand Id of products to fetch inventory.
366
- * @param {string[]} [arg.sellerIdentifiers] - The Seller Identifier or
367
- * Primary Identifier of the inventory.
368
- * @param {number} [arg.qtyGt] - This field allows you to filter for
369
- * inventories that have quantity greater than to the specified value
370
- * based on qty_type filter.
371
- * @param {number} [arg.qtyLt] - This field allows you to filter for
372
- * inventories that have a quantity less than to the specified value based
373
- * on qty_type filter.
374
- * @param {string} [arg.qtyType] - This field provides flexibility in
375
- * selecting filter for inventory quantity counts and date queries. For
376
- * example, you might use this field to specify "total" or "sellable" quantity.
377
- * @param {string} [arg.fromDate] - Inventory updated on filter to get
378
- * inventories greater then or equal to provided date based on qty_type value.
379
- * @param {string} [arg.toDate] - Inventory updated on filter to get
380
- * inventories less then or equal to provided date based on qty_type value.
381
- * @param {string} [arg.sizeIdentifier] - Size Identifier (Seller Identifier
382
- * or Primary Identifier) of which inventory is to get.
383
- * @returns {Paginator<CatalogPlatformModel.GetInventoriesResponseSchema>}
384
- * @summary: List Inventory
385
- * @description: Allows to get Inventories data for particular company.
386
- */
387
- getInventoriesPaginator({ itemId, size, pageSize, q, sellable, storeIds, brandIds, sellerIdentifiers, qtyGt, qtyLt, qtyType, fromDate, toDate, sizeIdentifier, }?: {
388
- itemId?: string;
389
- size?: string;
390
- pageSize?: number;
391
- q?: string;
392
- sellable?: boolean;
393
- storeIds?: number[];
394
- brandIds?: number[];
395
- sellerIdentifiers?: string[];
396
- qtyGt?: number;
397
- qtyLt?: number;
398
- qtyType?: string;
399
- fromDate?: string;
400
- toDate?: string;
401
- sizeIdentifier?: string;
402
- }): Paginator<CatalogPlatformModel.GetInventoriesResponseSchema>;
347
+ * @summary: Retrieve inventories.
348
+ * @description: Allows to get Inventories data for particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventories/).
349
+ */
350
+ getInventories({ itemId, size, pageNo, pageSize, pageId, pageType, q, sellable, storeIds, brandIds, sellerIdentifiers, minSellable, maxSellable, fromDate, toDate, sizeIdentifier, requestHeaders, }?: CatalogPlatformValidator.GetInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetInventoriesResponse>;
403
351
  /**
404
352
  * @param {CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam} arg
405
353
  * - Arg object
@@ -408,23 +356,10 @@ declare class Catalog {
408
356
  * @param {import("../PlatformAPIClient").Options} - Options
409
357
  * @returns {Promise<CatalogPlatformModel.BulkInventoryGet>} - Success response
410
358
  * @name getInventoryBulkUploadHistory
411
- * @summary: List bulk inventory upload history
412
- * @description: Helps to get bulk Inventory upload jobs status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBulkUploadHistory/).
413
- */
414
- getInventoryBulkUploadHistory({ pageNo, pageSize, search, requestHeaders }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkInventoryGet>;
415
- /**
416
- * @param {Object} arg - Arg object.
417
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
418
- * page. Default is 12.
419
- * @param {string} [arg.search] - Search string to filter the results by batch id
420
- * @returns {Paginator<CatalogPlatformModel.BulkInventoryGet>}
421
- * @summary: List bulk inventory upload history
422
- * @description: Helps to get bulk Inventory upload jobs status.
359
+ * @summary: Retrieve inventory bulk upload history.
360
+ * @description: Helps to get bulk Inventory upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBulkUploadHistory/).
423
361
  */
424
- getInventoryBulkUploadHistoryPaginator({ pageSize, search }?: {
425
- pageSize?: number;
426
- search?: string;
427
- }): Paginator<CatalogPlatformModel.BulkInventoryGet>;
362
+ getInventoryBulkUploadHistory({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkInventoryGet>;
428
363
  /**
429
364
  * @param {CatalogPlatformValidator.GetInventoryBySizeParam} arg - Arg object
430
365
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -432,29 +367,10 @@ declare class Catalog {
432
367
  * @returns {Promise<CatalogPlatformModel.InventoryResponsePaginated>} -
433
368
  * Success response
434
369
  * @name getInventoryBySize
435
- * @summary: List inventory by size
436
- * @description: Retrieve inventory data for a specific company, item ID, and size. The API supports search capabilities based on selling location (store) code and product availability (in stock or not)." - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBySize/).
370
+ * @summary: Get inventory by size.
371
+ * @description: Allows to retrieve Inventory data for particular company grouped by size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBySize/).
437
372
  */
438
373
  getInventoryBySize({ itemId, size, pageNo, pageSize, q, sellable, requestHeaders }?: CatalogPlatformValidator.GetInventoryBySizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryResponsePaginated>;
439
- /**
440
- * @param {Object} arg - Arg object.
441
- * @param {number} arg.itemId - Item code of the product of which size is to be get.
442
- * @param {string} arg.size - Size of which inventory is to get.
443
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
444
- * page. Default is 12.
445
- * @param {string} [arg.q] - Search with help of store code.
446
- * @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
447
- * @returns {Paginator<CatalogPlatformModel.InventoryResponsePaginated>}
448
- * @summary: List inventory by size
449
- * @description: Retrieve inventory data for a specific company, item ID, and size. The API supports search capabilities based on selling location (store) code and product availability (in stock or not)."
450
- */
451
- getInventoryBySizePaginator({ itemId, size, pageSize, q, sellable }?: {
452
- itemId: number;
453
- size: string;
454
- pageSize?: number;
455
- q?: string;
456
- sellable?: boolean;
457
- }): Paginator<CatalogPlatformModel.InventoryResponsePaginated>;
458
374
  /**
459
375
  * @param {CatalogPlatformValidator.GetInventoryBySizeIdentifierParam} arg
460
376
  * - Arg object
@@ -465,206 +381,194 @@ declare class Catalog {
465
381
  * - Success response
466
382
  *
467
383
  * @name getInventoryBySizeIdentifier
468
- * @summary: List inventory by size
469
- * @description: Retrieve inventory data for a specific company, item ID, and seller identifier. The API supports search capabilities using store codes and location IDs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBySizeIdentifier/).
384
+ * @summary: Get inventory by size identifier.
385
+ * @description: Allows to retrieve Inventory data for particular company grouped by size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBySizeIdentifier/).
470
386
  */
471
387
  getInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, requestHeaders, }?: CatalogPlatformValidator.GetInventoryBySizeIdentifierParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
472
- /**
473
- * @param {Object} arg - Arg object.
474
- * @param {number} arg.itemId - Item code of the product of which size is to be get.
475
- * @param {string} arg.sizeIdentifier - Size Identifier (Seller Identifier
476
- * or Primary Identifier) of which inventory is to get.
477
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
478
- * page. Default is 12.
479
- * @param {string} [arg.q] - Search with help of store code.
480
- * @param {number[]} [arg.locationIds] - Search by store ids.
481
- * @returns {Paginator<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>}
482
- * @summary: List inventory by size
483
- * @description: Retrieve inventory data for a specific company, item ID, and seller identifier. The API supports search capabilities using store codes and location IDs.
484
- */
485
- getInventoryBySizeIdentifierPaginator({ itemId, sizeIdentifier, pageSize, q, locationIds, }?: {
486
- itemId: number;
487
- sizeIdentifier: string;
488
- pageSize?: number;
489
- q?: string;
490
- locationIds?: number[];
491
- }): Paginator<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
492
388
  /**
493
389
  * @param {CatalogPlatformValidator.GetInventoryExportParam} arg - Arg object
494
390
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
495
391
  * @param {import("../PlatformAPIClient").Options} - Options
496
- * @returns {Promise<CatalogPlatformModel.InventoryExportJob>} - Success response
392
+ * @returns {Promise<CatalogPlatformModel.InventoryExportJobResponse>} -
393
+ * Success response
497
394
  * @name getInventoryExport
498
- * @summary: list product inventory
499
- * @description: Retrieves inventory for all products for that particular company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryExport/).
395
+ * @summary: Retrieve inventory export data.
396
+ * @description: Helps to retrieve Inventory export history. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryExport/).
500
397
  */
501
- getInventoryExport({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJob>;
398
+ getInventoryExport({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobResponse>;
502
399
  /**
503
- * @param {CatalogPlatformValidator.GetMarketplaceOptinDetailParam} arg - Arg object
400
+ * @param {CatalogPlatformValidator.GetInventoryExportDetailParam} arg - Arg object
504
401
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
505
402
  * @param {import("../PlatformAPIClient").Options} - Options
506
- * @returns {Promise<CatalogPlatformModel.GetOptInPlatform>} - Success response
507
- * @name getMarketplaceOptinDetail
508
- * @summary: Get opt-in
509
- * @description: Allows to fetch opt-in information for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMarketplaceOptinDetail/).
403
+ * @returns {Promise<CatalogPlatformModel.EditInventoryDownloadsResponse>}
404
+ * - Success response
405
+ *
406
+ * @name getInventoryExportDetail
407
+ * @summary: Get Detail Product export detail.
408
+ * @description: This API helps to get detail of Product export. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryExportDetail/).
510
409
  */
511
- getMarketplaceOptinDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetOptInPlatform>;
410
+ getInventoryExportDetail({ jobId, requestHeaders }?: CatalogPlatformValidator.GetInventoryExportDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.EditInventoryDownloadsResponse>;
512
411
  /**
513
- * @param {CatalogPlatformValidator.GetMarketplacesParam} arg - Arg object
412
+ * @param {CatalogPlatformValidator.GetLocationTagsParam} arg - Arg object
514
413
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
515
414
  * @param {import("../PlatformAPIClient").Options} - Options
516
- * @returns {Promise<CatalogPlatformModel.GetAllMarketplaces>} - Success response
517
- * @name getMarketplaces
518
- * @summary: List marketplaces
519
- * @description: Allows to get all marketplaces information for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMarketplaces/).
415
+ * @returns {Promise<CatalogPlatformModel.StoreTagsResponseSchema>} - Success response
416
+ * @name getLocationTags
417
+ * @summary: Get tags associated with locations for a company.
418
+ * @description: This API fetches all the tags associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getLocationTags/).
520
419
  */
521
- getMarketplaces({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAllMarketplaces>;
420
+ getLocationTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.StoreTagsResponseSchema>;
522
421
  /**
523
- * @param {CatalogPlatformValidator.GetOptimalLocationsParam} arg - Arg object
422
+ * @param {CatalogPlatformValidator.GetMarketplacesParam} arg - Arg object
524
423
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
525
424
  * @param {import("../PlatformAPIClient").Options} - Options
526
- * @returns {Promise<CatalogPlatformModel.StoreAssignResponseSchema>} -
527
- * Success response
528
- * @name getOptimalLocations
529
- * @summary: Get optimal locations
530
- * @description: This API returns the optimal locations where inventory is available for the given articles. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getOptimalLocations/).
425
+ * @returns {Promise<CatalogPlatformModel.GetAllMarketplaces>} - Success response
426
+ * @name getMarketplaces
427
+ * @summary: List all marketplaces
428
+ * @description: This API allows to get marketplace information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMarketplaces/).
531
429
  */
532
- getOptimalLocations({ body, requestHeaders }?: CatalogPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.StoreAssignResponseSchema>;
430
+ getMarketplaces({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAllMarketplaces>;
533
431
  /**
534
432
  * @param {CatalogPlatformValidator.GetProductParam} arg - Arg object
535
433
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
536
434
  * @param {import("../PlatformAPIClient").Options} - Options
537
- * @returns {Promise<CatalogPlatformModel.SingleProductResponseSchema>} -
538
- * Success response
435
+ * @returns {Promise<CatalogPlatformModel.SingleProductResponse>} - Success response
539
436
  * @name getProduct
540
- * @summary: Get a product
437
+ * @summary: Get product details.
541
438
  * @description: Retrieve data associated to a particular product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProduct/).
542
439
  */
543
- getProduct({ itemId, brandUid, itemCode, requestHeaders }?: CatalogPlatformValidator.GetProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleProductResponseSchema>;
440
+ getProduct({ itemId, brandUid, itemCode, requestHeaders }?: CatalogPlatformValidator.GetProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleProductResponse>;
544
441
  /**
545
442
  * @param {CatalogPlatformValidator.GetProductAssetsInBulkParam} arg - Arg object
546
443
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
547
444
  * @param {import("../PlatformAPIClient").Options} - Options
548
- * @returns {Promise<CatalogPlatformModel.BulkAssetResponseSchema>} - Success response
445
+ * @returns {Promise<CatalogPlatformModel.BulkAssetResponse>} - Success response
549
446
  * @name getProductAssetsInBulk
550
- * @summary: Get product assets
447
+ * @summary: Retrieve product assets in bulk.
551
448
  * @description: Helps to retrieve bulk asset jobs data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAssetsInBulk/).
552
449
  */
553
- getProductAssetsInBulk({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkAssetResponseSchema>;
554
- /**
555
- * @param {Object} arg - Arg object.
556
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
557
- * page. Default is 12.
558
- * @returns {Paginator<CatalogPlatformModel.BulkAssetResponseSchema>}
559
- * @summary: Get product assets
560
- * @description: Helps to retrieve bulk asset jobs data associated to a particular company.
561
- */
562
- getProductAssetsInBulkPaginator({ pageSize }?: {
563
- pageSize?: number;
564
- }): Paginator<CatalogPlatformModel.BulkAssetResponseSchema>;
450
+ getProductAssetsInBulk({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkAssetResponse>;
565
451
  /**
566
452
  * @param {CatalogPlatformValidator.GetProductAttributesParam} arg - Arg object
567
453
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
568
454
  * @param {import("../PlatformAPIClient").Options} - Options
569
- * @returns {Promise<CatalogPlatformModel.ProductAttributesResponseSchema>}
570
- * - Success response
571
- *
455
+ * @returns {Promise<CatalogPlatformModel.ProductAttributesResponse>} -
456
+ * Success response
572
457
  * @name getProductAttributes
573
- * @summary: List product attributes
574
- * @description: Retrieve attributes attached to products based on their L3 category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAttributes/).
458
+ * @summary: Get product attributes.
459
+ * @description: List all the attributes by their L3 categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAttributes/).
575
460
  */
576
- getProductAttributes({ category, filter, requestHeaders }?: CatalogPlatformValidator.GetProductAttributesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductAttributesResponseSchema>;
461
+ getProductAttributes({ category, filter, requestHeaders }?: CatalogPlatformValidator.GetProductAttributesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductAttributesResponse>;
577
462
  /**
578
463
  * @param {CatalogPlatformValidator.GetProductBulkUploadHistoryParam} arg - Arg object
579
464
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
580
465
  * @param {import("../PlatformAPIClient").Options} - Options
581
466
  * @returns {Promise<CatalogPlatformModel.ProductBulkRequestList>} - Success response
582
467
  * @name getProductBulkUploadHistory
583
- * @summary: List product bulk upload history
468
+ * @summary: Retrieve product bulk upload history.
584
469
  * @description: Helps to get bulk product upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBulkUploadHistory/).
585
470
  */
586
471
  getProductBulkUploadHistory({ search, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductBulkRequestList>;
587
- /**
588
- * @param {Object} arg - Arg object.
589
- * @param {string} [arg.search] - Search string to filter the results by batch id
590
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
591
- * page. Default is 12.
592
- * @returns {Paginator<CatalogPlatformModel.ProductBulkRequestList>}
593
- * @summary: List product bulk upload history
594
- * @description: Helps to get bulk product upload jobs data.
595
- */
596
- getProductBulkUploadHistoryPaginator({ search, pageSize }?: {
597
- search?: string;
598
- pageSize?: number;
599
- }): Paginator<CatalogPlatformModel.ProductBulkRequestList>;
600
472
  /**
601
473
  * @param {CatalogPlatformValidator.GetProductBundleParam} arg - Arg object
602
474
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
603
475
  * @param {import("../PlatformAPIClient").Options} - Options
604
- * @returns {Promise<CatalogPlatformModel.GetProductBundleListingResponseSchema>}
476
+ * @returns {Promise<CatalogPlatformModel.GetProductBundleListingResponse>}
605
477
  * - Success response
606
478
  *
607
479
  * @name getProductBundle
608
- * @summary: List product bundles
609
- * @description: Retrieve a list of product bundles available in the catalog associated to a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundle/).
480
+ * @summary: Retrieve product bundles.
481
+ * @description: Retrieve a list of product bundles available in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundle/).
610
482
  */
611
- getProductBundle({ q, slug, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleListingResponseSchema>;
483
+ getProductBundle({ q, slug, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleListingResponse>;
612
484
  /**
613
485
  * @param {CatalogPlatformValidator.GetProductBundleDetailParam} arg - Arg object
614
486
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
615
487
  * @param {import("../PlatformAPIClient").Options} - Options
616
- * @returns {Promise<CatalogPlatformModel.GetProductBundleResponseSchema>}
617
- * - Success response
618
- *
488
+ * @returns {Promise<CatalogPlatformModel.GetProductBundleResponse>} -
489
+ * Success response
619
490
  * @name getProductBundleDetail
620
- * @summary: Get product bundle
621
- * @description: Retrieve detailed information about a specific product bundle associated to a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundleDetail/).
491
+ * @summary: Get product bundle details.
492
+ * @description: Retrieve detailed information about a specific product bundle. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundleDetail/).
622
493
  */
623
- getProductBundleDetail({ id, requestHeaders }?: CatalogPlatformValidator.GetProductBundleDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleResponseSchema>;
494
+ getProductBundleDetail({ id, requestHeaders }?: CatalogPlatformValidator.GetProductBundleDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleResponse>;
495
+ /**
496
+ * @param {CatalogPlatformValidator.GetProductExportDetailParam} arg - Arg object
497
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
498
+ * @param {import("../PlatformAPIClient").Options} - Options
499
+ * @returns {Promise<CatalogPlatformModel.GetProductDownloadsResponse>} -
500
+ * Success response
501
+ * @name getProductExportDetail
502
+ * @summary: Get Detail Product export detail.
503
+ * @description: This API helps to get detail of Product export. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportDetail/).
504
+ */
505
+ getProductExportDetail({ jobId, requestHeaders }?: CatalogPlatformValidator.GetProductExportDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductDownloadsResponse>;
624
506
  /**
625
507
  * @param {CatalogPlatformValidator.GetProductExportJobsParam} arg - Arg object
626
508
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
627
509
  * @param {import("../PlatformAPIClient").Options} - Options
628
- * @returns {Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>}
629
- * - Success response
630
- *
510
+ * @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
511
+ * Success response
631
512
  * @name getProductExportJobs
632
- * @summary: Get product export jobs
633
- * @description: Get product export jobs specific to a company based on queries like query param, date range and status. View details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportJobs/).
513
+ * @summary: Retrieve product export jobs.
514
+ * @description: View details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportJobs/).
634
515
  */
635
- getProductExportJobs({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>;
516
+ getProductExportJobs({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
636
517
  /**
637
518
  * @param {CatalogPlatformValidator.GetProductSizeParam} arg - Arg object
638
519
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
639
520
  * @param {import("../PlatformAPIClient").Options} - Options
640
- * @returns {Promise<CatalogPlatformModel.ProductListingResponseSchema>} -
641
- * Success response
521
+ * @returns {Promise<CatalogPlatformModel.Product>} - Success response
642
522
  * @name getProductSize
643
- * @summary: List product size
523
+ * @summary: Get product size details.
644
524
  * @description: Retrieve data associated to a particular product size. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductSize/).
645
525
  */
646
- getProductSize({ itemId, itemCode, brandUid, uid, requestHeaders }?: CatalogPlatformValidator.GetProductSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponseSchema>;
526
+ getProductSize({ itemId, requestHeaders }?: CatalogPlatformValidator.GetProductSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.Product>;
647
527
  /**
648
528
  * @param {CatalogPlatformValidator.GetProductTagsParam} arg - Arg object
649
529
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
650
530
  * @param {import("../PlatformAPIClient").Options} - Options
651
- * @returns {Promise<CatalogPlatformModel.ProductTagsViewResponseSchema>} -
652
- * Success response
531
+ * @returns {Promise<CatalogPlatformModel.ProductTagsViewResponse>} - Success response
653
532
  * @name getProductTags
654
- * @summary: List product tags
533
+ * @summary: Get product tags.
655
534
  * @description: Retrieve tags data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductTags/).
656
535
  */
657
- getProductTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductTagsViewResponseSchema>;
536
+ getProductTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductTagsViewResponse>;
537
+ /**
538
+ * @param {CatalogPlatformValidator.GetProductTemplateBySlugParam} arg - Arg object
539
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
540
+ * @param {import("../PlatformAPIClient").Options} - Options
541
+ * @returns {Promise<CatalogPlatformModel.GetProductTemplateSlugResponse>}
542
+ * - Success response
543
+ *
544
+ * @name getProductTemplateBySlug
545
+ * @summary: Update marketplace optin
546
+ * @description: This API retrieves template for a given slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductTemplateBySlug/).
547
+ */
548
+ getProductTemplateBySlug({ slug, requestHeaders }?: CatalogPlatformValidator.GetProductTemplateBySlugParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductTemplateSlugResponse>;
658
549
  /**
659
550
  * @param {CatalogPlatformValidator.GetProductValidationParam} arg - Arg object
660
551
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
661
552
  * @param {import("../PlatformAPIClient").Options} - Options
662
553
  * @returns {Promise<CatalogPlatformModel.ValidateProduct>} - Success response
663
554
  * @name getProductValidation
664
- * @summary: Get valid products
665
- * @description: Retrieve validation data for products at company level. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductValidation/).
555
+ * @summary: Get product validation.
556
+ * @description: Retrieve validation data for a specific product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductValidation/).
557
+ */
558
+ getProductValidation({ type, slug, requestHeaders }?: CatalogPlatformValidator.GetProductValidationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ValidateProduct>;
559
+ /**
560
+ * @param {CatalogPlatformValidator.GetProductVerificationDetailsParam} arg
561
+ * - Arg object
562
+ *
563
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
564
+ * @param {import("../PlatformAPIClient").Options} - Options
565
+ * @returns {Promise<CatalogPlatformModel.ProductVerificationModel>} -
566
+ * Success response
567
+ * @name getProductVerificationDetails
568
+ * @summary: Get the verification detail of a product
569
+ * @description: Get the verification detail of a product - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductVerificationDetails/).
666
570
  */
667
- getProductValidation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ValidateProduct>;
571
+ getProductVerificationDetails({ itemId, requestHeaders }?: CatalogPlatformValidator.GetProductVerificationDetailsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductVerificationModel>;
668
572
  /**
669
573
  * @param {CatalogPlatformValidator.GetProductsParam} arg - Arg object
670
574
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -672,263 +576,146 @@ declare class Catalog {
672
576
  * @returns {Promise<CatalogPlatformModel.ProductListingResponseV2>} -
673
577
  * Success response
674
578
  * @name getProducts
675
- * @summary: List products
676
- * @description: Retrieve a list of available products - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProducts/).
677
- */
678
- getProducts({ brandIds, categoryIds, itemIds, departmentIds, itemCode, name, slug, allIdentifiers, q, tags, pageNo, pageSize, pageType, sortOn, pageId, requestHeaders, }?: CatalogPlatformValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponseV2>;
679
- /**
680
- * @param {Object} arg - Arg object.
681
- * @param {number[]} [arg.brandIds] - Get multiple products filtered by Brand Ids
682
- * @param {number[]} [arg.categoryIds] - Get multiple products filtered by
683
- * Category Ids
684
- * @param {number[]} [arg.itemIds] - Get multiple products filtered by Item Ids
685
- * @param {number[]} [arg.departmentIds] - Get multiple products filtered by
686
- * Department Ids
687
- * @param {string[]} [arg.itemCode] - Get multiple products filtered by Item Code
688
- * @param {string} [arg.name] - Get multiple products filtered by Name (Pattern Match)
689
- * @param {string} [arg.slug] - Get multiple products filtered by Slug
690
- * @param {string[]} [arg.allIdentifiers] - Get multiple products filtered
691
- * by All Identifiers
692
- * @param {string} [arg.q] - Get multiple products filtered by q string
693
- * @param {string[]} [arg.tags] - Get multiple products filtered by tags
694
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
695
- * page. Default is 10.
696
- * @param {string} [arg.sortOn] - Field which is to be used for sorting,
697
- * default is latest. Value can be latest (modified_on) or created (record id)
698
- * @returns {Paginator<CatalogPlatformModel.ProductListingResponseV2>}
699
- * @summary: List products
700
- * @description: Retrieve a list of available products
701
- */
702
- getProductsPaginator({ brandIds, categoryIds, itemIds, departmentIds, itemCode, name, slug, allIdentifiers, q, tags, pageSize, sortOn, }?: {
703
- brandIds?: number[];
704
- categoryIds?: number[];
705
- itemIds?: number[];
706
- departmentIds?: number[];
707
- itemCode?: string[];
708
- name?: string;
709
- slug?: string;
710
- allIdentifiers?: string[];
711
- q?: string;
712
- tags?: string[];
713
- pageSize?: number;
714
- sortOn?: string;
715
- }): Paginator<CatalogPlatformModel.ProductListingResponseV2>;
579
+ * @summary: Retrieve products.
580
+ * @description: Retrieve a list of products available - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProducts/).
581
+ */
582
+ getProducts({ brandIds, multiSize, categoryIds, itemIds, departmentIds, itemCode, name, slug, allIdentifiers, q, tags, pageNo, pageSize, pageType, sortOn, pageId, requestHeaders, }?: CatalogPlatformValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponseV2>;
716
583
  /**
717
584
  * @param {CatalogPlatformValidator.GetSellerInsightsParam} arg - Arg object
718
585
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
719
586
  * @param {import("../PlatformAPIClient").Options} - Options
720
- * @returns {Promise<CatalogPlatformModel.CrossSellingResponseSchema>} -
721
- * Success response
587
+ * @returns {Promise<CatalogPlatformModel.CrossSellingResponse>} - Success response
722
588
  * @name getSellerInsights
723
- * @summary: Get seller catalog counts
724
- * @description: Retrieve the count of catalog related data for sellers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSellerInsights/).
589
+ * @summary: Get seller insights.
590
+ * @description: Retrieve insights and analytics related to sellers within the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSellerInsights/).
725
591
  */
726
- getSellerInsights({ sellerAppId, requestHeaders }?: CatalogPlatformValidator.GetSellerInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CrossSellingResponseSchema>;
592
+ getSellerInsights({ sellerAppId, requestHeaders }?: CatalogPlatformValidator.GetSellerInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CrossSellingResponse>;
727
593
  /**
728
594
  * @param {CatalogPlatformValidator.GetSingleProductHSNCodeParam} arg - Arg object
729
595
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
730
596
  * @param {import("../PlatformAPIClient").Options} - Options
731
597
  * @returns {Promise<CatalogPlatformModel.HSNDataInsertV2>} - Success response
732
598
  * @name getSingleProductHSNCode
733
- * @summary: Get product HSN code
734
- * @description: Retrieve HSN details associated with company ID and reporting HSN - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSingleProductHSNCode/).
599
+ * @summary: Get single product HSN code.
600
+ * @description: Retrieve the HSN code for a single product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSingleProductHSNCode/).
735
601
  */
736
602
  getSingleProductHSNCode({ reportingHsn, requestHeaders }?: CatalogPlatformValidator.GetSingleProductHSNCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNDataInsertV2>;
737
603
  /**
738
604
  * @param {CatalogPlatformValidator.GetSizeGuideParam} arg - Arg object
739
605
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
740
606
  * @param {import("../PlatformAPIClient").Options} - Options
741
- * @returns {Promise<CatalogPlatformModel.SizeGuideResponseSchema>} - Success response
607
+ * @returns {Promise<CatalogPlatformModel.SizeGuideResponse>} - Success response
742
608
  * @name getSizeGuide
743
- * @summary: Get size guide
744
- * @description: Retrieve data associated about a specific size guide. It contains meta deta like header values like for shoulder, head, etc. and measurement unit like cm and values contains sizes for the same. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuide/).
609
+ * @summary: Get size guide details.
610
+ * @description: Retrieve data associated about a specific size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuide/).
745
611
  */
746
- getSizeGuide({ id, requestHeaders }?: CatalogPlatformValidator.GetSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SizeGuideResponseSchema>;
612
+ getSizeGuide({ id, requestHeaders }?: CatalogPlatformValidator.GetSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SizeGuideResponse>;
747
613
  /**
748
614
  * @param {CatalogPlatformValidator.GetSizeGuidesParam} arg - Arg object
749
615
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
750
616
  * @param {import("../PlatformAPIClient").Options} - Options
751
617
  * @returns {Promise<CatalogPlatformModel.ListSizeGuide>} - Success response
752
618
  * @name getSizeGuides
753
- * @summary: List size guides
754
- * @description: Allows to view all the size guides associated to the seller. Each size guide contains meta deta like header values like for shoulder, head, etc. and measurement unit like cm and values contains sizes for the same. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuides/).
619
+ * @summary: Retrieve size guides.
620
+ * @description: Allows to view all the size guides associated to the seller. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuides/).
755
621
  */
756
- getSizeGuides({ active, q, tag, pageNo, pageSize, brandId, requestHeaders }?: CatalogPlatformValidator.GetSizeGuidesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ListSizeGuide>;
622
+ getSizeGuides({ active, q, brandId, tag, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetSizeGuidesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ListSizeGuide>;
757
623
  /**
758
624
  * @param {CatalogPlatformValidator.GetStoreDetailParam} arg - Arg object
759
625
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
760
626
  * @param {import("../PlatformAPIClient").Options} - Options
761
627
  * @returns {Promise<CatalogPlatformModel.OptinStoreDetails>} - Success response
762
628
  * @name getStoreDetail
763
- * @summary: Get selling location
764
- * @description: Retrieve the details of the selling location (store) associated with a specific company passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getStoreDetail/).
629
+ * @summary: Get the Store details.
630
+ * @description: Get the details of the store associated with the company ID passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getStoreDetail/).
765
631
  */
766
632
  getStoreDetail({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetStoreDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinStoreDetails>;
767
633
  /**
768
- * @param {Object} arg - Arg object.
769
- * @param {string} [arg.q] - The search related the store for the company id.
770
- * @param {number} [arg.pageSize] - Number of records that can be seen on
771
- * the page for the company id.
772
- * @returns {Paginator<CatalogPlatformModel.OptinStoreDetails>}
773
- * @summary: Get selling location
774
- * @description: Retrieve the details of the selling location (store) associated with a specific company passed.
634
+ * @param {CatalogPlatformValidator.GetVariantTypesParam} arg - Arg object
635
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
636
+ * @param {import("../PlatformAPIClient").Options} - Options
637
+ * @returns {Promise<CatalogPlatformModel.VariantTypesResponse>} - Success response
638
+ * @name getVariantTypes
639
+ * @summary: Get variant type list
640
+ * @description: This API gets meta associated to products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getVariantTypes/).
775
641
  */
776
- getStoreDetailPaginator({ q, pageSize }?: {
777
- q?: string;
778
- pageSize?: number;
779
- }): Paginator<CatalogPlatformModel.OptinStoreDetails>;
642
+ getVariantTypes({ templateTag, requestHeaders }?: CatalogPlatformValidator.GetVariantTypesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.VariantTypesResponse>;
780
643
  /**
781
644
  * @param {CatalogPlatformValidator.GetVariantsOfProductsParam} arg - Arg object
782
645
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
783
646
  * @param {import("../PlatformAPIClient").Options} - Options
784
- * @returns {Promise<CatalogPlatformModel.ProductVariantsResponseSchema>} -
785
- * Success response
647
+ * @returns {Promise<CatalogPlatformModel.ProductVariantsResponse>} - Success response
786
648
  * @name getVariantsOfProducts
787
- * @summary: Get variants
649
+ * @summary: Get variants of products.
788
650
  * @description: Retrieve variants of a specific product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getVariantsOfProducts/).
789
651
  */
790
- getVariantsOfProducts({ itemId, variantType, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetVariantsOfProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductVariantsResponseSchema>;
791
- /**
792
- * @param {Object} arg - Arg object.
793
- * @param {number} arg.itemId - Get list of variants of item Id
794
- * @param {string} arg.variantType - Get multiple products filtered by variant type
795
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
796
- * page. Default is 10.
797
- * @returns {Paginator<CatalogPlatformModel.ProductVariantsResponseSchema>}
798
- * @summary: Get variants
799
- * @description: Retrieve variants of a specific product.
800
- */
801
- getVariantsOfProductsPaginator({ itemId, variantType, pageSize }?: {
802
- itemId: number;
803
- variantType: string;
804
- pageSize?: number;
805
- }): Paginator<CatalogPlatformModel.ProductVariantsResponseSchema>;
652
+ getVariantsOfProducts({ itemId, variantType, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetVariantsOfProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductVariantsResponse>;
806
653
  /**
807
654
  * @param {CatalogPlatformValidator.ListCategoriesParam} arg - Arg object
808
655
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
809
656
  * @param {import("../PlatformAPIClient").Options} - Options
810
- * @returns {Promise<CatalogPlatformModel.CategoryResponseSchema>} - Success response
657
+ * @returns {Promise<CatalogPlatformModel.CategoryResponse>} - Success response
811
658
  * @name listCategories
812
- * @summary: List categories
813
- * @description: Retrieve a list of categories data associated to a specific company and queries passed in the request. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listCategories/).
814
- */
815
- listCategories({ level, department, q, pageNo, pageSize, uids, slug, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryResponseSchema>;
816
- /**
817
- * @param {Object} arg - Arg object.
818
- * @param {string} [arg.level] - Get category for multiple levels
819
- * @param {number} [arg.department] - Get category for multiple departments filtered
820
- * @param {string} [arg.q] - Get multiple categories filtered by search string
821
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
822
- * page. Default is 10.
823
- * @param {number[]} [arg.uids] - Get multiple categories filtered by category uids.
824
- * @param {string} [arg.slug] - Get category by slug
825
- * @returns {Paginator<CatalogPlatformModel.CategoryResponseSchema>}
826
- * @summary: List categories
827
- * @description: Retrieve a list of categories data associated to a specific company and queries passed in the request.
828
- */
829
- listCategoriesPaginator({ level, department, q, pageSize, uids, slug }?: {
830
- level?: string;
831
- department?: number;
832
- q?: string;
833
- pageSize?: number;
834
- uids?: number[];
835
- slug?: string;
836
- }): Paginator<CatalogPlatformModel.CategoryResponseSchema>;
659
+ * @summary: List categories.
660
+ * @description: Retrieve a list of meta associated available product categories in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listCategories/).
661
+ */
662
+ listCategories({ level, department, q, pageNo, pageSize, uids, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryResponse>;
837
663
  /**
838
664
  * @param {CatalogPlatformValidator.ListDepartmentsDataParam} arg - Arg object
839
665
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
840
666
  * @param {import("../PlatformAPIClient").Options} - Options
841
- * @returns {Promise<CatalogPlatformModel.DepartmentsResponseSchema>} -
842
- * Success response
667
+ * @returns {Promise<CatalogPlatformModel.DepartmentsResponse>} - Success response
843
668
  * @name listDepartmentsData
844
- * @summary: List company department
845
- * @description: Allows you to list all departments data for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listDepartmentsData/).
846
- */
847
- listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, slug, requestHeaders, }?: CatalogPlatformValidator.ListDepartmentsDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponseSchema>;
848
- /**
849
- * @param {Object} arg - Arg object.
850
- * @param {string} [arg.itemType] - A `item_type` is a type of product eg.
851
- * set, standard, digital
852
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
853
- * page. Default is 10.
854
- * @param {string} [arg.name] - Can search departments by passing name.
855
- * @param {string} [arg.search] - Can search departments by passing name of
856
- * the department in search parameter.
857
- * @param {boolean} [arg.isActive] - Can query for departments based on
858
- * whether they are active or inactive.
859
- * @param {string} [arg.slug] - Can filter by slug
860
- * @returns {Paginator<CatalogPlatformModel.DepartmentsResponseSchema>}
861
- * @summary: List company department
862
- * @description: Allows you to list all departments data for a specific company.
863
- */
864
- listDepartmentsDataPaginator({ itemType, pageSize, name, search, isActive, slug, }?: {
865
- itemType?: string;
866
- pageSize?: number;
867
- name?: string;
868
- search?: string;
869
- isActive?: boolean;
870
- slug?: string;
871
- }): Paginator<CatalogPlatformModel.DepartmentsResponseSchema>;
669
+ * @summary: List department data.
670
+ * @description: Allows you to list all departments, also can search using name and filter active and incative departments, and item type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listDepartmentsData/).
671
+ */
672
+ listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, uids, requestHeaders, }?: CatalogPlatformValidator.ListDepartmentsDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
872
673
  /**
873
674
  * @param {CatalogPlatformValidator.ListHSNCodesParam} arg - Arg object
874
675
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
875
676
  * @param {import("../PlatformAPIClient").Options} - Options
876
- * @returns {Promise<CatalogPlatformModel.HSNCodesResponseSchema>} - Success response
677
+ * @returns {Promise<CatalogPlatformModel.HSNCodesResponse>} - Success response
877
678
  * @name listHSNCodes
878
- * @summary: List HSN codes
879
- * @description: Retrieve a list of Harmonized System Nomenclature (HSN) codes for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listHSNCodes/).
679
+ * @summary: List HSN codes.
680
+ * @description: Retrieve a list of Harmonized System Nomenclature (HSN) codes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listHSNCodes/).
880
681
  */
881
- listHSNCodes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNCodesResponseSchema>;
682
+ listHSNCodes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNCodesResponse>;
882
683
  /**
883
684
  * @param {CatalogPlatformValidator.ListInventoryExportParam} arg - Arg object
884
685
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
885
686
  * @param {import("../PlatformAPIClient").Options} - Options
886
- * @returns {Promise<CatalogPlatformModel.InventoryExportJobListResponseSchema>}
687
+ * @returns {Promise<CatalogPlatformModel.InventoryExportJobListResponse>}
887
688
  * - Success response
888
689
  *
889
690
  * @name listInventoryExport
890
- * @summary: List inventory export jobs
891
- * @description: Retrieve the history of inventory export jobs associated with the company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listInventoryExport/).
691
+ * @summary: List inventory exports.
692
+ * @description: Helps you the retrieve the history of inventory jobs depending on the filtered criteria. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listInventoryExport/).
892
693
  */
893
- listInventoryExport({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobListResponseSchema>;
694
+ listInventoryExport({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobListResponse>;
894
695
  /**
895
696
  * @param {CatalogPlatformValidator.ListProductTemplateParam} arg - Arg object
896
697
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
897
698
  * @param {import("../PlatformAPIClient").Options} - Options
898
- * @returns {Promise<CatalogPlatformModel.TemplatesResponseSchema>} - Success response
699
+ * @returns {Promise<CatalogPlatformModel.TemplatesResponse>} - Success response
899
700
  * @name listProductTemplate
900
- * @summary: List product templates
901
- * @description: Allows you to list all product templates for a specific company. also can filter by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplate/).
701
+ * @summary: List product templates.
702
+ * @description: Allows you to list all product templates, also can filter by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplate/).
902
703
  */
903
- listProductTemplate({ department, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesResponseSchema>;
704
+ listProductTemplate({ department, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesResponse>;
904
705
  /**
905
706
  * @param {CatalogPlatformValidator.ListProductTemplateCategoriesParam} arg
906
707
  * - Arg object
907
708
  *
908
709
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
909
710
  * @param {import("../PlatformAPIClient").Options} - Options
910
- * @returns {Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponseSchema>}
711
+ * @returns {Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponse>}
911
712
  * - Success response
912
713
  *
913
714
  * @name listProductTemplateCategories
914
- * @summary: List product template categories
915
- * @description: Allows you to list all product template categories values for the departments specified for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplateCategories/).
916
- */
917
- listProductTemplateCategories({ departments, itemType, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponseSchema>;
918
- /**
919
- * @param {CatalogPlatformValidator.ListProductTemplateExportDetailsParam} arg
920
- * - Arg object
921
- *
922
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
923
- * @param {import("../PlatformAPIClient").Options} - Options
924
- * @returns {Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>}
925
- * - Success response
926
- *
927
- * @name listProductTemplateExportDetails
928
- * @summary: List export product templates
929
- * @description: Retrieve export details related to product templates for a specific company. Can view details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplateExportDetails/).
715
+ * @summary: List product template categories.
716
+ * @description: Allows you to list all product categories values for the departments specified. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplateCategories/).
930
717
  */
931
- listProductTemplateExportDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>;
718
+ listProductTemplateCategories({ departments, itemType, pageSize, pageNo, q, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponse>;
932
719
  /**
933
720
  * @param {CatalogPlatformValidator.ListTemplateBrandTypeValuesParam} arg - Arg object
934
721
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -936,151 +723,121 @@ declare class Catalog {
936
723
  * @returns {Promise<CatalogPlatformModel.ProductConfigurationDownloads>} -
937
724
  * Success response
938
725
  * @name listTemplateBrandTypeValues
939
- * @summary: List template brand
940
- * @description: Retrieve values related to template brand types for a specific company. The filter type query parameter defines what type of data to return. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listTemplateBrandTypeValues/).
726
+ * @summary: List template brand type values.
727
+ * @description: Retrieve values related to template brand types. The filter type query parameter defines what type of data to return. The type of query returns the valid values for the same - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listTemplateBrandTypeValues/).
941
728
  */
942
729
  listTemplateBrandTypeValues({ filter, templateTag, itemType, requestHeaders }?: CatalogPlatformValidator.ListTemplateBrandTypeValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductConfigurationDownloads>;
943
730
  /**
944
- * @param {CatalogPlatformValidator.UpdateHsnCodeParam} arg - Arg object
731
+ * @param {CatalogPlatformValidator.PatchInventoryExportDetailParam} arg - Arg object
945
732
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
946
733
  * @param {import("../PlatformAPIClient").Options} - Options
947
- * @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
948
- * @name updateHsnCode
949
- * @summary: Update HSN code
950
- * @description: Modify the HSN code associated with a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateHsnCode/).
734
+ * @returns {Promise<CatalogPlatformModel.EditInventoryDownloadsResponse>}
735
+ * - Success response
736
+ *
737
+ * @name patchInventoryExportDetail
738
+ * @summary: Edit notification_emails and status of export job.
739
+ * @description: This API helps to edit notification_emails and status of export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/patchInventoryExportDetail/).
951
740
  */
952
- updateHsnCode({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCode>;
741
+ patchInventoryExportDetail({ jobId, body, requestHeaders }?: CatalogPlatformValidator.PatchInventoryExportDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.EditInventoryDownloadsResponse>;
953
742
  /**
954
- * @param {CatalogPlatformValidator.UpdateInventoriesParam} arg - Arg object
743
+ * @param {CatalogPlatformValidator.PatchProductExportDetailParam} arg - Arg object
955
744
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
956
745
  * @param {import("../PlatformAPIClient").Options} - Options
957
- * @returns {Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>} -
746
+ * @returns {Promise<CatalogPlatformModel.PatchProductDownloadsResponse>} -
958
747
  * Success response
959
- * @name updateInventories
960
- * @summary: Update inventories
961
- * @description: Allows to add Inventory for particular size and selling location. for associated companies - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateInventories/).
962
- */
963
- updateInventories({ body, requestHeaders }?: CatalogPlatformValidator.UpdateInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>;
964
- /**
965
- * @param {CatalogPlatformValidator.UpdateLocationPriceParam} arg - Arg object
966
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
967
- * @param {import("../PlatformAPIClient").Options} - Options
968
- * @returns {Promise<CatalogPlatformModel.LocationPriceQuantitySuccessResponseSchema>}
969
- * - Success response
970
- *
971
- * @name updateLocationPrice
972
- * @summary: Update an Article Price
973
- * @description: enables you to update article price for a specific size and selling location (store). The price updates will be reflected instantly after the API call. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateLocationPrice/).
748
+ * @name patchProductExportDetail
749
+ * @summary: Edit notification_emails and status of export job.
750
+ * @description: This API helps to edit notification_emails and status of export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/patchProductExportDetail/).
974
751
  */
975
- updateLocationPrice({ storeId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateLocationPriceParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationPriceQuantitySuccessResponseSchema>;
752
+ patchProductExportDetail({ jobId, body, requestHeaders }?: CatalogPlatformValidator.PatchProductExportDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.PatchProductDownloadsResponse>;
976
753
  /**
977
- * @param {CatalogPlatformValidator.UpdateLocationQuantityParam} arg - Arg object
754
+ * @param {CatalogPlatformValidator.UpdateInventoriesParam} arg - Arg object
978
755
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
979
756
  * @param {import("../PlatformAPIClient").Options} - Options
980
- * @returns {Promise<CatalogPlatformModel.LocationPriceQuantitySuccessResponseSchema>}
981
- * - Success response
982
- *
983
- * @name updateLocationQuantity
984
- * @summary: Update an Article Quantity
985
- * @description: enables you to update article quantity for a specific size and selling location (store). The quantity updates will be reflected instantly after the API call. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateLocationQuantity/).
757
+ * @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
758
+ * @name updateInventories
759
+ * @summary: Update inventories.
760
+ * @description: Allows to add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateInventories/).
986
761
  */
987
- updateLocationQuantity({ storeId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateLocationQuantityParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationPriceQuantitySuccessResponseSchema>;
762
+ updateInventories({ body, requestHeaders }?: CatalogPlatformValidator.UpdateInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
988
763
  /**
989
764
  * @param {CatalogPlatformValidator.UpdateMarketplaceOptinParam} arg - Arg object
990
765
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
991
766
  * @param {import("../PlatformAPIClient").Options} - Options
992
- * @returns {Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponseSchema>}
767
+ * @returns {Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponse>}
993
768
  * - Success response
994
769
  *
995
770
  * @name updateMarketplaceOptin
996
771
  * @summary: Update marketplace optin
997
- * @description: Allows to update marketplace optin for a company by marketplace_slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateMarketplaceOptin/).
772
+ * @description: This API allows to update marketplace optin for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateMarketplaceOptin/).
998
773
  */
999
- updateMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.UpdateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponseSchema>;
774
+ updateMarketplaceOptin({ marketplace, body, requestHeaders }?: CatalogPlatformValidator.UpdateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponse>;
1000
775
  /**
1001
776
  * @param {CatalogPlatformValidator.UpdateProductBundleParam} arg - Arg object
1002
777
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1003
778
  * @param {import("../PlatformAPIClient").Options} - Options
1004
- * @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>}
779
+ * @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponse>}
1005
780
  * - Success response
1006
781
  *
1007
782
  * @name updateProductBundle
1008
- * @summary: Update product bundle
1009
- * @description: Modify the details of an existing product bundle in the catalog associated to a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateProductBundle/).
783
+ * @summary: Update a product bundle.
784
+ * @description: Modify the details of an existing product bundle. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateProductBundle/).
1010
785
  */
1011
- updateProductBundle({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>;
786
+ updateProductBundle({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponse>;
1012
787
  /**
1013
788
  * @param {CatalogPlatformValidator.UpdateRealtimeInventoryParam} arg - Arg object
1014
789
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1015
790
  * @param {import("../PlatformAPIClient").Options} - Options
1016
- * @returns {Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>} -
1017
- * Success response
791
+ * @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
1018
792
  * @name updateRealtimeInventory
1019
- * @summary: Update an inventory
1020
- * @description: enables you to add inventory for a specific size and selling location (store). The inventory updates will be reflected instantly after the API call. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateRealtimeInventory/).
793
+ * @summary: Update realtime inventory.
794
+ * @description: Allows to add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateRealtimeInventory/).
1021
795
  */
1022
- updateRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>;
796
+ updateRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
1023
797
  /**
1024
798
  * @param {CatalogPlatformValidator.UpdateSizeGuideParam} arg - Arg object
1025
799
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1026
800
  * @param {import("../PlatformAPIClient").Options} - Options
1027
- * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
801
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
1028
802
  * @name updateSizeGuide
1029
- * @summary: Update size guide
1030
- * @description: Allows to edit a specific size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSizeGuide/).
803
+ * @summary: Update a size guide.
804
+ * @description: Allows to edit a size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSizeGuide/).
1031
805
  */
1032
- updateSizeGuide({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
806
+ updateSizeGuide({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
1033
807
  /**
1034
808
  * @param {CatalogPlatformValidator.UploadBulkProductsParam} arg - Arg object
1035
809
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1036
810
  * @param {import("../PlatformAPIClient").Options} - Options
1037
- * @returns {Promise<CatalogPlatformModel.BulkResponseSchema>} - Success response
811
+ * @returns {Promise<CatalogPlatformModel.ProductBulkResponse>} - Success response
1038
812
  * @name uploadBulkProducts
1039
- * @summary: Upload bulk products
1040
- * @description: Users can create multiple products by providing the required information needed for product creation in a CSV or Excel file format. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/uploadBulkProducts/).
1041
- */
1042
- uploadBulkProducts({ department, productType, body, requestHeaders }?: CatalogPlatformValidator.UploadBulkProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponseSchema>;
1043
- /**
1044
- * @param {CatalogPlatformValidator.ValidateProductGlobalTemplateParam} arg
1045
- * - Arg object
1046
- *
1047
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1048
- * @param {import("../PlatformAPIClient").Options} - Options
1049
- * @returns {Promise<CatalogPlatformModel.TemplatesGlobalValidationResponseSchema>}
1050
- * - Success response
1051
- *
1052
- * @name validateProductGlobalTemplate
1053
- * @summary: Validate product template
1054
- * @description: Allows you to list all product templates global validation values for all the fields present in the database for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductGlobalTemplate/).
813
+ * @summary: Upload bulk products.
814
+ * @description: Helps to create a bulk products upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/uploadBulkProducts/).
1055
815
  */
1056
- validateProductGlobalTemplate({ itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductGlobalTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesGlobalValidationResponseSchema>;
816
+ uploadBulkProducts({ department, productType, body, requestHeaders }?: CatalogPlatformValidator.UploadBulkProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductBulkResponse>;
1057
817
  /**
1058
818
  * @param {CatalogPlatformValidator.ValidateProductTemplateParam} arg - Arg object
1059
819
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1060
820
  * @param {import("../PlatformAPIClient").Options} - Options
1061
- * @returns {Promise<CatalogPlatformModel.TemplatesValidationResponseSchema>}
1062
- * - Success response
1063
- *
821
+ * @returns {Promise<CatalogPlatformModel.TemplatesValidationResponse>} -
822
+ * Success response
1064
823
  * @name validateProductTemplate
1065
- * @summary: Validate product template
1066
- * @description: Allows you to list all product templates validation values by its slug for all the fields present in the database for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplate/).
824
+ * @summary: Validate product template.
825
+ * @description: Allows you to list all product templates validation values for all the fields present in the database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplate/).
1067
826
  */
1068
- validateProductTemplate({ slug, itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesValidationResponseSchema>;
827
+ validateProductTemplate({ slug, itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesValidationResponse>;
1069
828
  /**
1070
829
  * @param {CatalogPlatformValidator.ValidateProductTemplateSchemaParam} arg
1071
830
  * - Arg object
1072
831
  *
1073
832
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1074
833
  * @param {import("../PlatformAPIClient").Options} - Options
1075
- * @returns {Promise<CatalogPlatformModel.InventoryValidationResponseSchema>}
1076
- * - Success response
1077
- *
834
+ * @returns {Promise<CatalogPlatformModel.InventoryValidationResponse>} -
835
+ * Success response
1078
836
  * @name validateProductTemplateSchema
1079
- * @summary: Validate product template schema
1080
- * @description: Allows you to list all product templates validation values for all the fields present in the database for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplateSchema/).
837
+ * @summary: Validate product template schema.
838
+ * @description: Allows you to list all product templates validation values for all the fields present in the database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplateSchema/).
1081
839
  */
1082
- validateProductTemplateSchema({ itemType, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryValidationResponseSchema>;
840
+ validateProductTemplateSchema({ itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryValidationResponse>;
1083
841
  }
1084
842
  import CatalogPlatformValidator = require("./CatalogPlatformValidator");
1085
843
  import CatalogPlatformModel = require("./CatalogPlatformModel");
1086
- import Paginator = require("../../common/Paginator");