@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.5

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 (140) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
  4. package/sdk/application/Cart/CartApplicationClient.js +82 -71
  5. package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
  6. package/sdk/application/Cart/CartApplicationValidator.js +59 -34
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
  16. package/sdk/application/Content/ContentApplicationClient.js +34 -115
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
  19. package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
  20. package/sdk/application/Lead/LeadApplicationClient.js +14 -14
  21. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
  22. package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
  23. package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
  24. package/sdk/application/Order/OrderApplicationClient.js +24 -24
  25. package/sdk/application/Order/OrderApplicationModel.d.ts +23 -1
  26. package/sdk/application/Order/OrderApplicationModel.js +28 -0
  27. package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
  28. package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
  29. package/sdk/application/Payment/PaymentApplicationModel.d.ts +498 -3
  30. package/sdk/application/Payment/PaymentApplicationModel.js +316 -2
  31. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
  32. package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
  33. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
  34. package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
  35. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
  36. package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
  37. package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
  38. package/sdk/application/Share/ShareApplicationClient.js +14 -14
  39. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  40. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  41. package/sdk/application/User/UserApplicationClient.d.ts +64 -64
  42. package/sdk/application/User/UserApplicationClient.js +64 -64
  43. package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
  44. package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
  45. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
  46. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
  47. package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
  48. package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
  49. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
  50. package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
  51. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
  52. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
  53. package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
  54. package/sdk/platform/Cart/CartPlatformModel.js +12 -0
  55. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +195 -108
  56. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
  57. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
  58. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -2
  59. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
  60. package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
  61. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -5
  62. package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -3
  63. package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
  64. package/sdk/platform/Common/CommonPlatformClient.js +3 -3
  65. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
  66. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
  67. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
  68. package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
  69. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
  70. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
  71. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
  72. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
  73. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
  74. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
  75. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
  76. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
  77. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
  78. package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
  79. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
  80. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
  81. package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
  82. package/sdk/platform/Content/ContentPlatformClient.js +7 -7
  83. package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
  84. package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
  85. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
  86. package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
  87. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +19 -55
  88. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -55
  89. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
  90. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
  91. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -12
  92. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -14
  93. package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
  94. package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
  95. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
  96. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
  97. package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
  98. package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
  99. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
  100. package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
  101. package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
  102. package/sdk/platform/Order/OrderPlatformClient.js +79 -294
  103. package/sdk/platform/Order/OrderPlatformModel.d.ts +32 -3
  104. package/sdk/platform/Order/OrderPlatformModel.js +34 -2
  105. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
  106. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  107. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
  108. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
  109. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
  110. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
  111. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  112. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  113. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
  114. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
  115. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
  116. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
  117. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +5 -5
  118. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
  119. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
  120. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
  121. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
  122. package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
  123. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
  124. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
  125. package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
  126. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  127. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
  128. package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
  129. package/sdk/platform/User/UserPlatformModel.d.ts +2 -2
  130. package/sdk/platform/User/UserPlatformModel.js +2 -2
  131. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
  132. package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
  133. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
  134. package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
  135. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
  136. package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
  137. package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
  138. package/sdk/public/Partner/PartnerPublicClient.js +2 -2
  139. package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
  140. package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
@@ -21,7 +21,7 @@ class Catalog {
21
21
  * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
22
22
  * @name addInventory
23
23
  * @summary: Add Inventory for particular size and store.
24
- * @description: This API allows add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/addInventory/).
24
+ * @description: Allows add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/addInventory/).
25
25
  */
26
26
  async addInventory(
27
27
  { itemId, size, body, requestHeaders } = { requestHeaders: {} },
@@ -103,8 +103,8 @@ class Catalog {
103
103
  * @param {import("../PlatformAPIClient").Options} - Options
104
104
  * @returns {Promise<CatalogPlatformModel.GetAllSizes>} - Success response
105
105
  * @name allSizes
106
- * @summary: All Sizes for a given Product
107
- * @description: This API allows to get All Sizes for a given Product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/allSizes/).
106
+ * @summary: Get all product sizes.
107
+ * @description: Retrieve all available sizes for a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/allSizes/).
108
108
  */
109
109
  async allSizes(
110
110
  { itemId, requestHeaders } = { requestHeaders: {} },
@@ -180,8 +180,8 @@ class Catalog {
180
180
  * @param {import("../PlatformAPIClient").Options} - Options
181
181
  * @returns {Promise<CatalogPlatformModel.BulkHsnResponse>} - Success response
182
182
  * @name bulkHsnCode
183
- * @summary: Bulk Create or Update Hsn Code.
184
- * @description: Bulk Create or Update Hsn Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/bulkHsnCode/).
183
+ * @summary: Bulk update HSN codes.
184
+ * @description: Perform bulk updates of HSN codes for products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/bulkHsnCode/).
185
185
  */
186
186
  async bulkHsnCode(
187
187
  { body, requestHeaders } = { requestHeaders: {} },
@@ -257,8 +257,8 @@ class Catalog {
257
257
  * @param {import("../PlatformAPIClient").Options} - Options
258
258
  * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
259
259
  * @name createBulkInventory
260
- * @summary: Create products in bulk associated with given batch Id.
261
- * @description: This API 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/).
260
+ * @summary: Create bulk inventory.
261
+ * @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/).
262
262
  */
263
263
  async createBulkInventory(
264
264
  { batchId, body, requestHeaders } = { requestHeaders: {} },
@@ -338,8 +338,8 @@ class Catalog {
338
338
  * @param {import("../PlatformAPIClient").Options} - Options
339
339
  * @returns {Promise<CatalogPlatformModel.BulkResponse>} - Success response
340
340
  * @name createBulkInventoryJob
341
- * @summary: Create a Bulk Inventory upload Job.
342
- * @description: This API helps to create a bulk Inventory upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkInventoryJob/).
341
+ * @summary: Create bulk inventory upload job.
342
+ * @description: Helps to create a bulk Inventory upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkInventoryJob/).
343
343
  */
344
344
  async createBulkInventoryJob(
345
345
  { body, requestHeaders } = { requestHeaders: {} },
@@ -500,8 +500,8 @@ class Catalog {
500
500
  * @param {import("../PlatformAPIClient").Options} - Options
501
501
  * @returns {Promise<CatalogPlatformModel.CategoryCreateResponse>} - Success response
502
502
  * @name createCategories
503
- * @summary: Create product categories
504
- * @description: This API lets user create product categories - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCategories/).
503
+ * @summary: Create categories.
504
+ * @description: Lets user create product categories on for the seller on the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCategories/).
505
505
  */
506
506
  async createCategories(
507
507
  { body, requestHeaders } = { requestHeaders: {} },
@@ -580,8 +580,8 @@ class Catalog {
580
580
  * @returns {Promise<CatalogPlatformModel.DepartmentCreateResponse>} -
581
581
  * Success response
582
582
  * @name createDepartments
583
- * @summary: Create the department.
584
- * @description: Create departments using the API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createDepartments/).
583
+ * @summary: Create departments.
584
+ * @description: Create departments with this resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createDepartments/).
585
585
  */
586
586
  async createDepartments(
587
587
  { body, requestHeaders } = { requestHeaders: {} },
@@ -659,8 +659,8 @@ class Catalog {
659
659
  * @param {import("../PlatformAPIClient").Options} - Options
660
660
  * @returns {Promise<CatalogPlatformModel.InventoryExportResponse>} - Success response
661
661
  * @name createInventoryExport
662
- * @summary: Create an inventory export job.
663
- * @description: This API helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExport/).
662
+ * @summary: Create inventory export.
663
+ * @description: Helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExport/).
664
664
  */
665
665
  async createInventoryExport(
666
666
  { body, requestHeaders } = { requestHeaders: {} },
@@ -738,8 +738,8 @@ class Catalog {
738
738
  * @param {import("../PlatformAPIClient").Options} - Options
739
739
  * @returns {Promise<CatalogPlatformModel.InventoryExportResponse>} - Success response
740
740
  * @name createInventoryExportJob
741
- * @summary: Create a Inventory export Job.
742
- * @description: This API helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExportJob/).
741
+ * @summary: Create inventory export job.
742
+ * @description: Helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExportJob/).
743
743
  */
744
744
  async createInventoryExportJob(
745
745
  { body, requestHeaders } = { requestHeaders: {} },
@@ -903,7 +903,7 @@ class Catalog {
903
903
  * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
904
904
  * @name createProduct
905
905
  * @summary: Create a product.
906
- * @description: This API allows to create product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProduct/).
906
+ * @description: Allows to create product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProduct/).
907
907
  */
908
908
  async createProduct(
909
909
  { body, requestHeaders } = { requestHeaders: {} },
@@ -981,8 +981,8 @@ class Catalog {
981
981
  * @param {import("../PlatformAPIClient").Options} - Options
982
982
  * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
983
983
  * @name createProductAssetsInBulk
984
- * @summary: Create a Bulk asset upload Job.
985
- * @description: This API helps to create a bulk asset upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductAssetsInBulk/).
984
+ * @summary: Create product assets in bulk.
985
+ * @description: Helps to create a bulk asset upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductAssetsInBulk/).
986
986
  */
987
987
  async createProductAssetsInBulk(
988
988
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1064,8 +1064,8 @@ class Catalog {
1064
1064
  * - Success response
1065
1065
  *
1066
1066
  * @name createProductBundle
1067
- * @summary: Create Product Bundle
1068
- * @description: Create Product Bundle. See `ProductBundleRequest` for the request body parameter need to create a product bundle. On successful request, returns in `ProductBundleRequest` with id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductBundle/).
1067
+ * @summary: Create a product bundle.
1068
+ * @description: Create product bundle in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductBundle/).
1069
1069
  */
1070
1070
  async createProductBundle(
1071
1071
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1144,8 +1144,8 @@ class Catalog {
1144
1144
  * @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
1145
1145
  * Success response
1146
1146
  * @name createProductExportJob
1147
- * @summary: Create a product export job.
1148
- * @description: This API helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductExportJob/).
1147
+ * @summary: Create product export job.
1148
+ * @description: Helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductExportJob/).
1149
1149
  */
1150
1150
  async createProductExportJob(
1151
1151
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1225,8 +1225,8 @@ class Catalog {
1225
1225
  * @param {import("../PlatformAPIClient").Options} - Options
1226
1226
  * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
1227
1227
  * @name createProductsInBulk
1228
- * @summary: Create products in bulk associated with given batch Id.
1229
- * @description: This API 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/).
1228
+ * @summary: Create products in bulk.
1229
+ * @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/).
1230
1230
  */
1231
1231
  async createProductsInBulk(
1232
1232
  { batchId, body, requestHeaders } = { requestHeaders: {} },
@@ -1307,7 +1307,7 @@ class Catalog {
1307
1307
  * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
1308
1308
  * @name createSizeGuide
1309
1309
  * @summary: Create a size guide.
1310
- * @description: This API allows to create a size guide associated to a brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSizeGuide/).
1310
+ * @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/).
1311
1311
  */
1312
1312
  async createSizeGuide(
1313
1313
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1385,8 +1385,8 @@ class Catalog {
1385
1385
  * @param {import("../PlatformAPIClient").Options} - Options
1386
1386
  * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
1387
1387
  * @name deleteBulkInventoryJob
1388
- * @summary: Delete Bulk Inventory job.
1389
- * @description: This API allows to delete bulk Inventory job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteBulkInventoryJob/).
1388
+ * @summary: Delete inventory bulk upload job.
1389
+ * @description: Allows to delete bulk Inventory job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteBulkInventoryJob/).
1390
1390
  */
1391
1391
  async deleteBulkInventoryJob(
1392
1392
  { batchId, requestHeaders } = { requestHeaders: {} },
@@ -1467,7 +1467,7 @@ class Catalog {
1467
1467
  * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
1468
1468
  * @name deleteProduct
1469
1469
  * @summary: Delete a product.
1470
- * @description: This API allows to delete product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProduct/).
1470
+ * @description: Remove a specific product in the catalog - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProduct/).
1471
1471
  */
1472
1472
  async deleteProduct(
1473
1473
  { itemId, requestHeaders } = { requestHeaders: {} },
@@ -1545,8 +1545,8 @@ class Catalog {
1545
1545
  * @param {import("../PlatformAPIClient").Options} - Options
1546
1546
  * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
1547
1547
  * @name deleteProductBulkJob
1548
- * @summary: Delete Bulk product job.
1549
- * @description: This API allows to delete bulk product job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProductBulkJob/).
1548
+ * @summary: Delete product bulk upload job.
1549
+ * @description: Allows to delete bulk product job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProductBulkJob/).
1550
1550
  */
1551
1551
  async deleteProductBulkJob(
1552
1552
  { batchId, requestHeaders } = { requestHeaders: {} },
@@ -1624,8 +1624,8 @@ class Catalog {
1624
1624
  * @param {import("../PlatformAPIClient").Options} - Options
1625
1625
  * @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
1626
1626
  * @name deleteRealtimeInventory
1627
- * @summary: Add Inventory for particular size and store.
1628
- * @description: This API allows add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteRealtimeInventory/).
1627
+ * @summary: Delete realtime inventory.
1628
+ * @description: Remove specific realtime inventory data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteRealtimeInventory/).
1629
1629
  */
1630
1630
  async deleteRealtimeInventory(
1631
1631
  { itemId, sellerIdentifier, body, requestHeaders } = { requestHeaders: {} },
@@ -1710,8 +1710,8 @@ class Catalog {
1710
1710
  * @returns {Promise<CatalogPlatformModel.ProductSizeDeleteResponse>} -
1711
1711
  * Success response
1712
1712
  * @name deleteSize
1713
- * @summary: Delete a Size associated with product.
1714
- * @description: This API allows to delete size associated with product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSize/).
1713
+ * @summary: Delete product size.
1714
+ * @description: Allows to delete size associated with product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSize/).
1715
1715
  */
1716
1716
  async deleteSize(
1717
1717
  { itemId, size, requestHeaders } = { requestHeaders: {} },
@@ -1791,8 +1791,8 @@ class Catalog {
1791
1791
  * @param {import("../PlatformAPIClient").Options} - Options
1792
1792
  * @returns {Promise<string>} - Success response
1793
1793
  * @name downloadInventoryTemplateView
1794
- * @summary: Download Product Template View
1795
- * @description: Allows you to download product template data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadInventoryTemplateView/).
1794
+ * @summary: Download inventory template view.
1795
+ * @description: Allows you to download product template data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadInventoryTemplateView/).
1796
1796
  */
1797
1797
  async downloadInventoryTemplateView(
1798
1798
  { itemType, requestHeaders } = { requestHeaders: {} },
@@ -1872,8 +1872,8 @@ class Catalog {
1872
1872
  * @param {import("../PlatformAPIClient").Options} - Options
1873
1873
  * @returns {Promise<string>} - Success response
1874
1874
  * @name downloadProductTemplateViews
1875
- * @summary: Download Product Template View
1876
- * @description: Allows you to download product template data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadProductTemplateViews/).
1875
+ * @summary: Download product template views.
1876
+ * @description: Allows you to download product template data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadProductTemplateViews/).
1877
1877
  */
1878
1878
  async downloadProductTemplateViews(
1879
1879
  { slug, itemType, type, requestHeaders } = { requestHeaders: {} },
@@ -1957,7 +1957,7 @@ class Catalog {
1957
1957
  * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
1958
1958
  * @name editProduct
1959
1959
  * @summary: Edit a product.
1960
- * @description: This API allows to edit product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/editProduct/).
1960
+ * @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/).
1961
1961
  */
1962
1962
  async editProduct(
1963
1963
  { itemId, body, requestHeaders } = { requestHeaders: {} },
@@ -2035,8 +2035,8 @@ class Catalog {
2035
2035
  * @param {import("../PlatformAPIClient").Options} - Options
2036
2036
  * @returns {Promise<CatalogPlatformModel.InventoryConfig>} - Success response
2037
2037
  * @name exportInventoryConfig
2038
- * @summary: Get List of different filters for inventory export
2039
- * @description: This API allows get 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/).
2038
+ * @summary: Export inventory configuration.
2039
+ * @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/).
2040
2040
  */
2041
2041
  async exportInventoryConfig(
2042
2042
  { filterType, requestHeaders } = { requestHeaders: {} },
@@ -2117,8 +2117,8 @@ class Catalog {
2117
2117
  * - Success response
2118
2118
  *
2119
2119
  * @name getAllProductHsnCodes
2120
- * @summary: Hsn Code List.
2121
- * @description: Hsn Code List. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllProductHsnCodes/).
2120
+ * @summary: Get all product HSN codes.
2121
+ * @description: Retrieve all HSN codes associated with products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllProductHsnCodes/).
2122
2122
  */
2123
2123
  async getAllProductHsnCodes(
2124
2124
  { pageNo, pageSize, q, type, requestHeaders } = { requestHeaders: {} },
@@ -2206,8 +2206,8 @@ class Catalog {
2206
2206
  * @param {import("../PlatformAPIClient").Options} - Options
2207
2207
  * @returns {Promise<CatalogPlatformModel.SingleCategoryResponse>} - Success response
2208
2208
  * @name getCategoryData
2209
- * @summary: Get product category by uid
2210
- * @description: This API gets meta associated to product categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategoryData/).
2209
+ * @summary: Get category data.
2210
+ * @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/).
2211
2211
  */
2212
2212
  async getCategoryData(
2213
2213
  { uid, requestHeaders } = { requestHeaders: {} },
@@ -2455,8 +2455,8 @@ class Catalog {
2455
2455
  * @param {import("../PlatformAPIClient").Options} - Options
2456
2456
  * @returns {Promise<CatalogPlatformModel.OptinCompanyMetrics>} - Success response
2457
2457
  * @name getCompanyMetrics
2458
- * @summary: Get the Company metrics
2459
- * @description: Get the Company metrics associated with the company ID passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyMetrics/).
2458
+ * @summary: Get company metrics.
2459
+ * @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/).
2460
2460
  */
2461
2461
  async getCompanyMetrics(
2462
2462
  { requestHeaders } = { requestHeaders: {} },
@@ -2530,8 +2530,8 @@ class Catalog {
2530
2530
  * @param {import("../PlatformAPIClient").Options} - Options
2531
2531
  * @returns {Promise<CatalogPlatformModel.DepartmentsResponse>} - Success response
2532
2532
  * @name getDepartmentData
2533
- * @summary: Get specific departments details by passing in unique id of the department.
2534
- * @description: Allows you to get department data, by uid. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartmentData/).
2533
+ * @summary: Get department data.
2534
+ * @description: Retrieve detailed information about a specific department by UID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartmentData/).
2535
2535
  */
2536
2536
  async getDepartmentData(
2537
2537
  { uid, requestHeaders } = { requestHeaders: {} },
@@ -2609,8 +2609,8 @@ class Catalog {
2609
2609
  * @param {import("../PlatformAPIClient").Options} - Options
2610
2610
  * @returns {Promise<CatalogPlatformModel.GenderDetail>} - Success response
2611
2611
  * @name getGenderAttribute
2612
- * @summary: Get gender attribute details
2613
- * @description: This API allows to view the gender attribute details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGenderAttribute/).
2612
+ * @summary: Get gender attribute.
2613
+ * @description: Retrieve the gender attribute for catalog listings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGenderAttribute/).
2614
2614
  */
2615
2615
  async getGenderAttribute(
2616
2616
  { attributeSlug, requestHeaders } = { requestHeaders: {} },
@@ -2688,8 +2688,8 @@ class Catalog {
2688
2688
  * @param {import("../PlatformAPIClient").Options} - Options
2689
2689
  * @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
2690
2690
  * @name getHsnCode
2691
- * @summary: Fetch Hsn Code.
2692
- * @description: Fetch Hsn Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getHsnCode/).
2691
+ * @summary: Get HSN code.
2692
+ * @description: Retrieve the HSN code for a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getHsnCode/).
2693
2693
  */
2694
2694
  async getHsnCode(
2695
2695
  { id, requestHeaders } = { requestHeaders: {} },
@@ -2765,8 +2765,8 @@ class Catalog {
2765
2765
  * @param {import("../PlatformAPIClient").Options} - Options
2766
2766
  * @returns {Promise<CatalogPlatformModel.GetInventoriesResponse>} - Success response
2767
2767
  * @name getInventories
2768
- * @summary: Get Inventory for company
2769
- * @description: This API allows get Inventories data for particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventories/).
2768
+ * @summary: Retrieve inventories.
2769
+ * @description: Allows to get Inventories data for particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventories/).
2770
2770
  */
2771
2771
  async getInventories(
2772
2772
  {
@@ -2870,6 +2870,55 @@ class Catalog {
2870
2870
  return response;
2871
2871
  }
2872
2872
 
2873
+ /**
2874
+ * @param {Object} arg - Arg object.
2875
+ * @param {string} [arg.itemId] - Item code of the product of which size is to be get.
2876
+ * @param {string} [arg.size] - Size of which inventory is to get.
2877
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
2878
+ * page. Default is 12.
2879
+ * @param {string} [arg.q] - Search with help of store code.
2880
+ * @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
2881
+ * @param {number[]} [arg.storeIds] - The Store Id of products to fetch inventory.
2882
+ * @param {string} [arg.sizeIdentifier] - Size Identifier (Seller Identifier
2883
+ * or Primary Identifier) of which inventory is to get.
2884
+ * @returns {Paginator<CatalogPlatformModel.GetInventoriesResponse>}
2885
+ * @summary: Retrieve inventories.
2886
+ * @description: Allows to get Inventories data for particular company.
2887
+ */
2888
+ getInventoriesPaginator({
2889
+ itemId,
2890
+ size,
2891
+ pageSize,
2892
+ q,
2893
+ sellable,
2894
+ storeIds,
2895
+ sizeIdentifier,
2896
+ } = {}) {
2897
+ const paginator = new Paginator();
2898
+ const callback = async () => {
2899
+ const pageId = paginator.nextId;
2900
+ const pageNo = paginator.pageNo;
2901
+ const pageType = "number";
2902
+ const data = await this.getInventories({
2903
+ itemId: itemId,
2904
+ size: size,
2905
+ pageNo: pageNo,
2906
+ pageSize: pageSize,
2907
+ q: q,
2908
+ sellable: sellable,
2909
+ storeIds: storeIds,
2910
+ sizeIdentifier: sizeIdentifier,
2911
+ });
2912
+ paginator.setPaginator({
2913
+ hasNext: data.page.has_next ? true : false,
2914
+ nextId: data.page.next_id,
2915
+ });
2916
+ return data;
2917
+ };
2918
+ paginator.setCallback(callback.bind(this));
2919
+ return paginator;
2920
+ }
2921
+
2873
2922
  /**
2874
2923
  * @param {CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam} arg
2875
2924
  * - Arg object
@@ -2878,8 +2927,8 @@ class Catalog {
2878
2927
  * @param {import("../PlatformAPIClient").Options} - Options
2879
2928
  * @returns {Promise<CatalogPlatformModel.BulkInventoryGet>} - Success response
2880
2929
  * @name getInventoryBulkUploadHistory
2881
- * @summary: Get a list of all bulk Inventory upload jobs.
2882
- * @description: This API helps to get bulk Inventory upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBulkUploadHistory/).
2930
+ * @summary: Retrieve inventory bulk upload history.
2931
+ * @description: Helps to get bulk Inventory upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBulkUploadHistory/).
2883
2932
  */
2884
2933
  async getInventoryBulkUploadHistory(
2885
2934
  { pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -2957,6 +3006,34 @@ class Catalog {
2957
3006
  return response;
2958
3007
  }
2959
3008
 
3009
+ /**
3010
+ * @param {Object} arg - Arg object.
3011
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
3012
+ * page. Default is 12.
3013
+ * @returns {Paginator<CatalogPlatformModel.BulkInventoryGet>}
3014
+ * @summary: Retrieve inventory bulk upload history.
3015
+ * @description: Helps to get bulk Inventory upload jobs data.
3016
+ */
3017
+ getInventoryBulkUploadHistoryPaginator({ pageSize } = {}) {
3018
+ const paginator = new Paginator();
3019
+ const callback = async () => {
3020
+ const pageId = paginator.nextId;
3021
+ const pageNo = paginator.pageNo;
3022
+ const pageType = "number";
3023
+ const data = await this.getInventoryBulkUploadHistory({
3024
+ pageNo: pageNo,
3025
+ pageSize: pageSize,
3026
+ });
3027
+ paginator.setPaginator({
3028
+ hasNext: data.page.has_next ? true : false,
3029
+ nextId: data.page.next_id,
3030
+ });
3031
+ return data;
3032
+ };
3033
+ paginator.setCallback(callback.bind(this));
3034
+ return paginator;
3035
+ }
3036
+
2960
3037
  /**
2961
3038
  * @param {CatalogPlatformValidator.GetInventoryBySizeParam} arg - Arg object
2962
3039
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -2964,8 +3041,8 @@ class Catalog {
2964
3041
  * @returns {Promise<CatalogPlatformModel.InventoryResponsePaginated>} -
2965
3042
  * Success response
2966
3043
  * @name getInventoryBySize
2967
- * @summary: Get Inventory for company
2968
- * @description: This API allows get Inventory data for particular company grouped by size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBySize/).
3044
+ * @summary: Get inventory by size.
3045
+ * @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/).
2969
3046
  */
2970
3047
  async getInventoryBySize(
2971
3048
  { itemId, size, pageNo, pageSize, q, sellable, requestHeaders } = {
@@ -3053,6 +3130,42 @@ class Catalog {
3053
3130
  return response;
3054
3131
  }
3055
3132
 
3133
+ /**
3134
+ * @param {Object} arg - Arg object.
3135
+ * @param {number} arg.itemId - Item code of the product of which size is to be get.
3136
+ * @param {string} arg.size - Size of which inventory is to get.
3137
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
3138
+ * page. Default is 12.
3139
+ * @param {string} [arg.q] - Search with help of store code.
3140
+ * @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
3141
+ * @returns {Paginator<CatalogPlatformModel.InventoryResponsePaginated>}
3142
+ * @summary: Get inventory by size.
3143
+ * @description: Allows to retrieve Inventory data for particular company grouped by size and store.
3144
+ */
3145
+ getInventoryBySizePaginator({ itemId, size, pageSize, q, sellable } = {}) {
3146
+ const paginator = new Paginator();
3147
+ const callback = async () => {
3148
+ const pageId = paginator.nextId;
3149
+ const pageNo = paginator.pageNo;
3150
+ const pageType = "number";
3151
+ const data = await this.getInventoryBySize({
3152
+ itemId: itemId,
3153
+ size: size,
3154
+ pageNo: pageNo,
3155
+ pageSize: pageSize,
3156
+ q: q,
3157
+ sellable: sellable,
3158
+ });
3159
+ paginator.setPaginator({
3160
+ hasNext: data.page.has_next ? true : false,
3161
+ nextId: data.page.next_id,
3162
+ });
3163
+ return data;
3164
+ };
3165
+ paginator.setCallback(callback.bind(this));
3166
+ return paginator;
3167
+ }
3168
+
3056
3169
  /**
3057
3170
  * @param {CatalogPlatformValidator.GetInventoryBySizeIdentifierParam} arg
3058
3171
  * - Arg object
@@ -3063,8 +3176,8 @@ class Catalog {
3063
3176
  * - Success response
3064
3177
  *
3065
3178
  * @name getInventoryBySizeIdentifier
3066
- * @summary: Get Inventory for company
3067
- * @description: This API allows get Inventory data for particular company grouped by size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBySizeIdentifier/).
3179
+ * @summary: Get inventory by size identifier.
3180
+ * @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/).
3068
3181
  */
3069
3182
  async getInventoryBySizeIdentifier(
3070
3183
  {
@@ -3160,14 +3273,57 @@ class Catalog {
3160
3273
  return response;
3161
3274
  }
3162
3275
 
3276
+ /**
3277
+ * @param {Object} arg - Arg object.
3278
+ * @param {number} arg.itemId - Item code of the product of which size is to be get.
3279
+ * @param {string} arg.sizeIdentifier - Size Identifier (Seller Identifier
3280
+ * or Primary Identifier) of which inventory is to get.
3281
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
3282
+ * page. Default is 12.
3283
+ * @param {string} [arg.q] - Search with help of store code.
3284
+ * @param {number[]} [arg.locationIds] - Search by store ids.
3285
+ * @returns {Paginator<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>}
3286
+ * @summary: Get inventory by size identifier.
3287
+ * @description: Allows to retrieve Inventory data for particular company grouped by size and store.
3288
+ */
3289
+ getInventoryBySizeIdentifierPaginator({
3290
+ itemId,
3291
+ sizeIdentifier,
3292
+ pageSize,
3293
+ q,
3294
+ locationIds,
3295
+ } = {}) {
3296
+ const paginator = new Paginator();
3297
+ const callback = async () => {
3298
+ const pageId = paginator.nextId;
3299
+ const pageNo = paginator.pageNo;
3300
+ const pageType = "number";
3301
+ const data = await this.getInventoryBySizeIdentifier({
3302
+ itemId: itemId,
3303
+ sizeIdentifier: sizeIdentifier,
3304
+ pageNo: pageNo,
3305
+ pageSize: pageSize,
3306
+ q: q,
3307
+ locationIds: locationIds,
3308
+ });
3309
+ paginator.setPaginator({
3310
+ hasNext: data.page.has_next ? true : false,
3311
+ nextId: data.page.next_id,
3312
+ });
3313
+ return data;
3314
+ };
3315
+ paginator.setCallback(callback.bind(this));
3316
+ return paginator;
3317
+ }
3318
+
3163
3319
  /**
3164
3320
  * @param {CatalogPlatformValidator.GetInventoryExportParam} arg - Arg object
3165
3321
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
3166
3322
  * @param {import("../PlatformAPIClient").Options} - Options
3167
3323
  * @returns {Promise<CatalogPlatformModel.InventoryExportJob>} - Success response
3168
3324
  * @name getInventoryExport
3169
- * @summary: Get Inventory export history.
3170
- * @description: This API helps to get Inventory export history. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryExport/).
3325
+ * @summary: Retrieve inventory export data.
3326
+ * @description: Helps to retrieve Inventory export history. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryExport/).
3171
3327
  */
3172
3328
  async getInventoryExport(
3173
3329
  { requestHeaders } = { requestHeaders: {} },
@@ -3393,8 +3549,8 @@ class Catalog {
3393
3549
  * @param {import("../PlatformAPIClient").Options} - Options
3394
3550
  * @returns {Promise<CatalogPlatformModel.StoreAssignResponse>} - Success response
3395
3551
  * @name getOptimalLocations
3396
- * @summary: Location Reassignment
3397
- * @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getOptimalLocations/).
3552
+ * @summary: Get optimal locations.
3553
+ * @description: Retrieve the most suitable locations based on certain criteria. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getOptimalLocations/).
3398
3554
  */
3399
3555
  async getOptimalLocations(
3400
3556
  { body, requestHeaders } = { requestHeaders: {} },
@@ -3472,8 +3628,8 @@ class Catalog {
3472
3628
  * @param {import("../PlatformAPIClient").Options} - Options
3473
3629
  * @returns {Promise<CatalogPlatformModel.SingleProductResponse>} - Success response
3474
3630
  * @name getProduct
3475
- * @summary: Get a single product.
3476
- * @description: This API helps to get data associated to a particular product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProduct/).
3631
+ * @summary: Get product details.
3632
+ * @description: Retrieve data associated to a particular product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProduct/).
3477
3633
  */
3478
3634
  async getProduct(
3479
3635
  { itemId, brandUid, itemCode, requestHeaders } = { requestHeaders: {} },
@@ -3555,8 +3711,8 @@ class Catalog {
3555
3711
  * @param {import("../PlatformAPIClient").Options} - Options
3556
3712
  * @returns {Promise<CatalogPlatformModel.BulkAssetResponse>} - Success response
3557
3713
  * @name getProductAssetsInBulk
3558
- * @summary: Get a list of all bulk asset jobs.
3559
- * @description: This API helps to get bulk asset jobs data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAssetsInBulk/).
3714
+ * @summary: Retrieve product assets in bulk.
3715
+ * @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/).
3560
3716
  */
3561
3717
  async getProductAssetsInBulk(
3562
3718
  { pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -3634,6 +3790,34 @@ class Catalog {
3634
3790
  return response;
3635
3791
  }
3636
3792
 
3793
+ /**
3794
+ * @param {Object} arg - Arg object.
3795
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
3796
+ * page. Default is 12.
3797
+ * @returns {Paginator<CatalogPlatformModel.BulkAssetResponse>}
3798
+ * @summary: Retrieve product assets in bulk.
3799
+ * @description: Helps to retrieve bulk asset jobs data associated to a particular company.
3800
+ */
3801
+ getProductAssetsInBulkPaginator({ pageSize } = {}) {
3802
+ const paginator = new Paginator();
3803
+ const callback = async () => {
3804
+ const pageId = paginator.nextId;
3805
+ const pageNo = paginator.pageNo;
3806
+ const pageType = "number";
3807
+ const data = await this.getProductAssetsInBulk({
3808
+ pageNo: pageNo,
3809
+ pageSize: pageSize,
3810
+ });
3811
+ paginator.setPaginator({
3812
+ hasNext: data.page.has_next ? true : false,
3813
+ nextId: data.page.next_id,
3814
+ });
3815
+ return data;
3816
+ };
3817
+ paginator.setCallback(callback.bind(this));
3818
+ return paginator;
3819
+ }
3820
+
3637
3821
  /**
3638
3822
  * @param {CatalogPlatformValidator.GetProductAttributesParam} arg - Arg object
3639
3823
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -3641,8 +3825,8 @@ class Catalog {
3641
3825
  * @returns {Promise<CatalogPlatformModel.ProductAttributesResponse>} -
3642
3826
  * Success response
3643
3827
  * @name getProductAttributes
3644
- * @summary: Get list of all the attributes by their l3_categories
3645
- * @description: This API allows to list all the attributes by their l3_categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAttributes/).
3828
+ * @summary: Get product attributes.
3829
+ * @description: List all the attributes by their L3 categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAttributes/).
3646
3830
  */
3647
3831
  async getProductAttributes(
3648
3832
  { category, filter, requestHeaders } = { requestHeaders: {} },
@@ -3724,8 +3908,8 @@ class Catalog {
3724
3908
  * @param {import("../PlatformAPIClient").Options} - Options
3725
3909
  * @returns {Promise<CatalogPlatformModel.ProductBulkRequestList>} - Success response
3726
3910
  * @name getProductBulkUploadHistory
3727
- * @summary: Get a list of all bulk product upload jobs.
3728
- * @description: This API helps to get bulk product upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBulkUploadHistory/).
3911
+ * @summary: Retrieve product bulk upload history.
3912
+ * @description: Helps to get bulk product upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBulkUploadHistory/).
3729
3913
  */
3730
3914
  async getProductBulkUploadHistory(
3731
3915
  { search, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -3806,6 +3990,36 @@ class Catalog {
3806
3990
  return response;
3807
3991
  }
3808
3992
 
3993
+ /**
3994
+ * @param {Object} arg - Arg object.
3995
+ * @param {string} [arg.search] - Search string to filter the results by batch id
3996
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
3997
+ * page. Default is 12.
3998
+ * @returns {Paginator<CatalogPlatformModel.ProductBulkRequestList>}
3999
+ * @summary: Retrieve product bulk upload history.
4000
+ * @description: Helps to get bulk product upload jobs data.
4001
+ */
4002
+ getProductBulkUploadHistoryPaginator({ search, pageSize } = {}) {
4003
+ const paginator = new Paginator();
4004
+ const callback = async () => {
4005
+ const pageId = paginator.nextId;
4006
+ const pageNo = paginator.pageNo;
4007
+ const pageType = "number";
4008
+ const data = await this.getProductBulkUploadHistory({
4009
+ search: search,
4010
+ pageNo: pageNo,
4011
+ pageSize: pageSize,
4012
+ });
4013
+ paginator.setPaginator({
4014
+ hasNext: data.page.has_next ? true : false,
4015
+ nextId: data.page.next_id,
4016
+ });
4017
+ return data;
4018
+ };
4019
+ paginator.setCallback(callback.bind(this));
4020
+ return paginator;
4021
+ }
4022
+
3809
4023
  /**
3810
4024
  * @param {CatalogPlatformValidator.GetProductBundleParam} arg - Arg object
3811
4025
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -3814,8 +4028,8 @@ class Catalog {
3814
4028
  * - Success response
3815
4029
  *
3816
4030
  * @name getProductBundle
3817
- * @summary: List all Product Bundles
3818
- * @description: Get all product bundles for a particular company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundle/).
4031
+ * @summary: Retrieve product bundles.
4032
+ * @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/).
3819
4033
  */
3820
4034
  async getProductBundle(
3821
4035
  { q, slug, requestHeaders } = { requestHeaders: {} },
@@ -3898,8 +4112,8 @@ class Catalog {
3898
4112
  * @returns {Promise<CatalogPlatformModel.GetProductBundleResponse>} -
3899
4113
  * Success response
3900
4114
  * @name getProductBundleDetail
3901
- * @summary: Get a particular Product Bundle details
3902
- * @description: Get a particular Bundle details by its `id`. If successful, returns a Product bundle resource in the response body specified in `GetProductBundleResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundleDetail/).
4115
+ * @summary: Get product bundle details.
4116
+ * @description: Retrieve detailed information about a specific product bundle. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundleDetail/).
3903
4117
  */
3904
4118
  async getProductBundleDetail(
3905
4119
  { id, requestHeaders } = { requestHeaders: {} },
@@ -3980,8 +4194,8 @@ class Catalog {
3980
4194
  * @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
3981
4195
  * Success response
3982
4196
  * @name getProductExportJobs
3983
- * @summary: Allows you to list all product templates export list details
3984
- * @description: Can view details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportJobs/).
4197
+ * @summary: Retrieve product export jobs.
4198
+ * @description: View details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportJobs/).
3985
4199
  */
3986
4200
  async getProductExportJobs(
3987
4201
  { status, fromDate, toDate, q, requestHeaders } = { requestHeaders: {} },
@@ -4069,8 +4283,8 @@ class Catalog {
4069
4283
  * @param {import("../PlatformAPIClient").Options} - Options
4070
4284
  * @returns {Promise<CatalogPlatformModel.ProductListingResponse>} - Success response
4071
4285
  * @name getProductSize
4072
- * @summary: Get a single product size.
4073
- * @description: This API helps to get data associated to a particular product size. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductSize/).
4286
+ * @summary: Get product size details.
4287
+ * @description: Retrieve data associated to a particular product size. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductSize/).
4074
4288
  */
4075
4289
  async getProductSize(
4076
4290
  { itemId, itemCode, brandUid, uid, requestHeaders } = {
@@ -4159,8 +4373,8 @@ class Catalog {
4159
4373
  * @param {import("../PlatformAPIClient").Options} - Options
4160
4374
  * @returns {Promise<CatalogPlatformModel.ProductTagsViewResponse>} - Success response
4161
4375
  * @name getProductTags
4162
- * @summary: Get a list of all tags associated with company.
4163
- * @description: This API helps to get tags data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductTags/).
4376
+ * @summary: Get product tags.
4377
+ * @description: Retrieve tags data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductTags/).
4164
4378
  */
4165
4379
  async getProductTags(
4166
4380
  { requestHeaders } = { requestHeaders: {} },
@@ -4234,8 +4448,8 @@ class Catalog {
4234
4448
  * @param {import("../PlatformAPIClient").Options} - Options
4235
4449
  * @returns {Promise<CatalogPlatformModel.ValidateProduct>} - Success response
4236
4450
  * @name getProductValidation
4237
- * @summary: Validate product/size data
4238
- * @description: This API validates product data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductValidation/).
4451
+ * @summary: Get product validation.
4452
+ * @description: Retrieve validation data for a specific product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductValidation/).
4239
4453
  */
4240
4454
  async getProductValidation(
4241
4455
  { requestHeaders } = { requestHeaders: {} },
@@ -4310,8 +4524,8 @@ class Catalog {
4310
4524
  * @returns {Promise<CatalogPlatformModel.ProductListingResponseV2>} -
4311
4525
  * Success response
4312
4526
  * @name getProducts
4313
- * @summary: Get product list
4314
- * @description: This API gets meta associated to products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProducts/).
4527
+ * @summary: Retrieve products.
4528
+ * @description: Retrieve a list of products available - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProducts/).
4315
4529
  */
4316
4530
  async getProducts(
4317
4531
  {
@@ -4417,14 +4631,67 @@ class Catalog {
4417
4631
  return response;
4418
4632
  }
4419
4633
 
4634
+ /**
4635
+ * @param {Object} arg - Arg object.
4636
+ * @param {number[]} [arg.brandIds] - Get multiple products filtered by Brand Ids
4637
+ * @param {number[]} [arg.categoryIds] - Get multiple products filtered by
4638
+ * Category Ids
4639
+ * @param {number[]} [arg.itemIds] - Get multiple products filtered by Item Ids
4640
+ * @param {number[]} [arg.departmentIds] - Get multiple products filtered by
4641
+ * Department Ids
4642
+ * @param {string[]} [arg.itemCode] - Get multiple products filtered by Item Code
4643
+ * @param {string} [arg.q] - Get multiple products filtered by q string
4644
+ * @param {string[]} [arg.tags] - Get multiple products filtered by tags
4645
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
4646
+ * page. Default is 10.
4647
+ * @returns {Paginator<CatalogPlatformModel.ProductListingResponseV2>}
4648
+ * @summary: Retrieve products.
4649
+ * @description: Retrieve a list of products available
4650
+ */
4651
+ getProductsPaginator({
4652
+ brandIds,
4653
+ categoryIds,
4654
+ itemIds,
4655
+ departmentIds,
4656
+ itemCode,
4657
+ q,
4658
+ tags,
4659
+ pageSize,
4660
+ } = {}) {
4661
+ const paginator = new Paginator();
4662
+ const callback = async () => {
4663
+ const pageId = paginator.nextId;
4664
+ const pageNo = paginator.pageNo;
4665
+ const pageType = "number";
4666
+ const data = await this.getProducts({
4667
+ brandIds: brandIds,
4668
+ categoryIds: categoryIds,
4669
+ itemIds: itemIds,
4670
+ departmentIds: departmentIds,
4671
+ itemCode: itemCode,
4672
+ q: q,
4673
+ tags: tags,
4674
+ pageNo: pageNo,
4675
+ pageSize: pageSize,
4676
+ });
4677
+ paginator.setPaginator({
4678
+ hasNext: data.page.has_next ? true : false,
4679
+ nextId: data.page.next_id,
4680
+ });
4681
+ return data;
4682
+ };
4683
+ paginator.setCallback(callback.bind(this));
4684
+ return paginator;
4685
+ }
4686
+
4420
4687
  /**
4421
4688
  * @param {CatalogPlatformValidator.GetSellerInsightsParam} arg - Arg object
4422
4689
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
4423
4690
  * @param {import("../PlatformAPIClient").Options} - Options
4424
4691
  * @returns {Promise<CatalogPlatformModel.CrossSellingResponse>} - Success response
4425
4692
  * @name getSellerInsights
4426
- * @summary: Analytics data of catalog and inventory that are being cross-selled.
4427
- * @description: Analytics data of catalog and inventory that are being cross-selled. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSellerInsights/).
4693
+ * @summary: Get seller insights.
4694
+ * @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/).
4428
4695
  */
4429
4696
  async getSellerInsights(
4430
4697
  { sellerAppId, requestHeaders } = { requestHeaders: {} },
@@ -4502,8 +4769,8 @@ class Catalog {
4502
4769
  * @param {import("../PlatformAPIClient").Options} - Options
4503
4770
  * @returns {Promise<CatalogPlatformModel.HSNDataInsertV2>} - Success response
4504
4771
  * @name getSingleProductHSNCode
4505
- * @summary: Hsn Code List.
4506
- * @description: Hsn Code List. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSingleProductHSNCode/).
4772
+ * @summary: Get single product HSN code.
4773
+ * @description: Retrieve the HSN code for a single product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSingleProductHSNCode/).
4507
4774
  */
4508
4775
  async getSingleProductHSNCode(
4509
4776
  { reportingHsn, requestHeaders } = { requestHeaders: {} },
@@ -4579,8 +4846,8 @@ class Catalog {
4579
4846
  * @param {import("../PlatformAPIClient").Options} - Options
4580
4847
  * @returns {Promise<CatalogPlatformModel.SizeGuideResponse>} - Success response
4581
4848
  * @name getSizeGuide
4582
- * @summary: Get a single size guide.
4583
- * @description: This API helps to get data associated to a size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuide/).
4849
+ * @summary: Get size guide details.
4850
+ * @description: Retrieve data associated about a specific size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuide/).
4584
4851
  */
4585
4852
  async getSizeGuide(
4586
4853
  { id, requestHeaders } = { requestHeaders: {} },
@@ -4658,8 +4925,8 @@ class Catalog {
4658
4925
  * @param {import("../PlatformAPIClient").Options} - Options
4659
4926
  * @returns {Promise<CatalogPlatformModel.ListSizeGuide>} - Success response
4660
4927
  * @name getSizeGuides
4661
- * @summary: Get list of size guides
4662
- * @description: This API 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/).
4928
+ * @summary: Retrieve size guides.
4929
+ * @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/).
4663
4930
  */
4664
4931
  async getSizeGuides(
4665
4932
  { active, q, tag, pageNo, pageSize, brandId, requestHeaders } = {
@@ -4755,8 +5022,8 @@ class Catalog {
4755
5022
  * @param {import("../PlatformAPIClient").Options} - Options
4756
5023
  * @returns {Promise<CatalogPlatformModel.OptinStoreDetails>} - Success response
4757
5024
  * @name getStoreDetail
4758
- * @summary: Get the Store details.
4759
- * @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/).
5025
+ * @summary: Get store details.
5026
+ * @description: Retrieve 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/).
4760
5027
  */
4761
5028
  async getStoreDetail(
4762
5029
  { q, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -4835,14 +5102,44 @@ class Catalog {
4835
5102
  return response;
4836
5103
  }
4837
5104
 
5105
+ /**
5106
+ * @param {Object} arg - Arg object.
5107
+ * @param {string} [arg.q] - The search related the store for the company id.
5108
+ * @param {number} [arg.pageSize] - Number of records that can be seen on
5109
+ * the page for the company id.
5110
+ * @returns {Paginator<CatalogPlatformModel.OptinStoreDetails>}
5111
+ * @summary: Get store details.
5112
+ * @description: Retrieve the details of the store associated with the company ID passed.
5113
+ */
5114
+ getStoreDetailPaginator({ q, pageSize } = {}) {
5115
+ const paginator = new Paginator();
5116
+ const callback = async () => {
5117
+ const pageId = paginator.nextId;
5118
+ const pageNo = paginator.pageNo;
5119
+ const pageType = "number";
5120
+ const data = await this.getStoreDetail({
5121
+ q: q,
5122
+ pageNo: pageNo,
5123
+ pageSize: pageSize,
5124
+ });
5125
+ paginator.setPaginator({
5126
+ hasNext: data.page.has_next ? true : false,
5127
+ nextId: data.page.next_id,
5128
+ });
5129
+ return data;
5130
+ };
5131
+ paginator.setCallback(callback.bind(this));
5132
+ return paginator;
5133
+ }
5134
+
4838
5135
  /**
4839
5136
  * @param {CatalogPlatformValidator.GetVariantsOfProductsParam} arg - Arg object
4840
5137
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
4841
5138
  * @param {import("../PlatformAPIClient").Options} - Options
4842
5139
  * @returns {Promise<CatalogPlatformModel.ProductVariantsResponse>} - Success response
4843
5140
  * @name getVariantsOfProducts
4844
- * @summary: Get product list
4845
- * @description: This API gets meta associated to products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getVariantsOfProducts/).
5141
+ * @summary: Get variants of products.
5142
+ * @description: Retrieve variants of a specific product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getVariantsOfProducts/).
4846
5143
  */
4847
5144
  async getVariantsOfProducts(
4848
5145
  { itemId, variantType, pageNo, pageSize, requestHeaders } = {
@@ -4924,14 +5221,46 @@ class Catalog {
4924
5221
  return response;
4925
5222
  }
4926
5223
 
5224
+ /**
5225
+ * @param {Object} arg - Arg object.
5226
+ * @param {number} arg.itemId - Get list of variants of item Id
5227
+ * @param {string} arg.variantType - Get multiple products filtered by variant type
5228
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
5229
+ * page. Default is 10.
5230
+ * @returns {Paginator<CatalogPlatformModel.ProductVariantsResponse>}
5231
+ * @summary: Get variants of products.
5232
+ * @description: Retrieve variants of a specific product.
5233
+ */
5234
+ getVariantsOfProductsPaginator({ itemId, variantType, pageSize } = {}) {
5235
+ const paginator = new Paginator();
5236
+ const callback = async () => {
5237
+ const pageId = paginator.nextId;
5238
+ const pageNo = paginator.pageNo;
5239
+ const pageType = "number";
5240
+ const data = await this.getVariantsOfProducts({
5241
+ itemId: itemId,
5242
+ variantType: variantType,
5243
+ pageNo: pageNo,
5244
+ pageSize: pageSize,
5245
+ });
5246
+ paginator.setPaginator({
5247
+ hasNext: data.page.has_next ? true : false,
5248
+ nextId: data.page.next_id,
5249
+ });
5250
+ return data;
5251
+ };
5252
+ paginator.setCallback(callback.bind(this));
5253
+ return paginator;
5254
+ }
5255
+
4927
5256
  /**
4928
5257
  * @param {CatalogPlatformValidator.ListCategoriesParam} arg - Arg object
4929
5258
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
4930
5259
  * @param {import("../PlatformAPIClient").Options} - Options
4931
5260
  * @returns {Promise<CatalogPlatformModel.CategoryResponse>} - Success response
4932
5261
  * @name listCategories
4933
- * @summary: Get product categories list
4934
- * @description: This API gets meta associated to product categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listCategories/).
5262
+ * @summary: List categories.
5263
+ * @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/).
4935
5264
  */
4936
5265
  async listCategories(
4937
5266
  { level, department, q, pageNo, pageSize, uids, slug, requestHeaders } = {
@@ -5024,13 +5353,51 @@ class Catalog {
5024
5353
  return response;
5025
5354
  }
5026
5355
 
5356
+ /**
5357
+ * @param {Object} arg - Arg object.
5358
+ * @param {string} [arg.level] - Get category for multiple levels
5359
+ * @param {number} [arg.department] - Get category for multiple departments filtered
5360
+ * @param {string} [arg.q] - Get multiple categories filtered by search string
5361
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
5362
+ * page. Default is 10.
5363
+ * @param {number[]} [arg.uids] - Get multiple categories filtered by category uids.
5364
+ * @param {string} [arg.slug] - Get category by slug
5365
+ * @returns {Paginator<CatalogPlatformModel.CategoryResponse>}
5366
+ * @summary: List categories.
5367
+ * @description: Retrieve a list of meta associated available product categories in the catalog.
5368
+ */
5369
+ listCategoriesPaginator({ level, department, q, pageSize, uids, slug } = {}) {
5370
+ const paginator = new Paginator();
5371
+ const callback = async () => {
5372
+ const pageId = paginator.nextId;
5373
+ const pageNo = paginator.pageNo;
5374
+ const pageType = "number";
5375
+ const data = await this.listCategories({
5376
+ level: level,
5377
+ department: department,
5378
+ q: q,
5379
+ pageNo: pageNo,
5380
+ pageSize: pageSize,
5381
+ uids: uids,
5382
+ slug: slug,
5383
+ });
5384
+ paginator.setPaginator({
5385
+ hasNext: data.page.has_next ? true : false,
5386
+ nextId: data.page.next_id,
5387
+ });
5388
+ return data;
5389
+ };
5390
+ paginator.setCallback(callback.bind(this));
5391
+ return paginator;
5392
+ }
5393
+
5027
5394
  /**
5028
5395
  * @param {CatalogPlatformValidator.ListDepartmentsDataParam} arg - Arg object
5029
5396
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
5030
5397
  * @param {import("../PlatformAPIClient").Options} - Options
5031
5398
  * @returns {Promise<CatalogPlatformModel.DepartmentsResponse>} - Success response
5032
5399
  * @name listDepartmentsData
5033
- * @summary: List all Departments.
5400
+ * @summary: List department data.
5034
5401
  * @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/).
5035
5402
  */
5036
5403
  async listDepartmentsData(
@@ -5131,14 +5498,62 @@ class Catalog {
5131
5498
  return response;
5132
5499
  }
5133
5500
 
5501
+ /**
5502
+ * @param {Object} arg - Arg object.
5503
+ * @param {string} [arg.itemType] - A `item_type` is a type of product eg.
5504
+ * set, standard, digital
5505
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
5506
+ * page. Default is 10.
5507
+ * @param {string} [arg.name] - Can search departments by passing name.
5508
+ * @param {string} [arg.search] - Can search departments by passing name of
5509
+ * the department in search parameter.
5510
+ * @param {boolean} [arg.isActive] - Can query for departments based on
5511
+ * whether they are active or inactive.
5512
+ * @param {string} [arg.slug] - Can filter by slug
5513
+ * @returns {Paginator<CatalogPlatformModel.DepartmentsResponse>}
5514
+ * @summary: List department data.
5515
+ * @description: Allows you to list all departments, also can search using name and filter active and incative departments, and item type.
5516
+ */
5517
+ listDepartmentsDataPaginator({
5518
+ itemType,
5519
+ pageSize,
5520
+ name,
5521
+ search,
5522
+ isActive,
5523
+ slug,
5524
+ } = {}) {
5525
+ const paginator = new Paginator();
5526
+ const callback = async () => {
5527
+ const pageId = paginator.nextId;
5528
+ const pageNo = paginator.pageNo;
5529
+ const pageType = "number";
5530
+ const data = await this.listDepartmentsData({
5531
+ pageNo: pageNo,
5532
+ itemType: itemType,
5533
+ pageSize: pageSize,
5534
+ name: name,
5535
+ search: search,
5536
+ isActive: isActive,
5537
+ slug: slug,
5538
+ });
5539
+ paginator.setPaginator({
5540
+ hasNext: data.page.has_next ? true : false,
5541
+ nextId: data.page.next_id,
5542
+ });
5543
+ return data;
5544
+ };
5545
+ paginator.setCallback(callback.bind(this));
5546
+ return paginator;
5547
+ }
5548
+
5134
5549
  /**
5135
5550
  * @param {CatalogPlatformValidator.ListHSNCodesParam} arg - Arg object
5136
5551
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
5137
5552
  * @param {import("../PlatformAPIClient").Options} - Options
5138
5553
  * @returns {Promise<CatalogPlatformModel.HSNCodesResponse>} - Success response
5139
5554
  * @name listHSNCodes
5140
- * @summary: List HSN Codes
5141
- * @description: Allows you to list all hsn Codes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listHSNCodes/).
5555
+ * @summary: List HSN codes.
5556
+ * @description: Retrieve a list of Harmonized System Nomenclature (HSN) codes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listHSNCodes/).
5142
5557
  */
5143
5558
  async listHSNCodes(
5144
5559
  { requestHeaders } = { requestHeaders: {} },
@@ -5214,8 +5629,8 @@ class Catalog {
5214
5629
  * - Success response
5215
5630
  *
5216
5631
  * @name listInventoryExport
5217
- * @summary: Get the history of the inventory export.
5218
- * @description: This API helps you the get the history of inventory jobs depending on the filtered criteria. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listInventoryExport/).
5632
+ * @summary: List inventory exports.
5633
+ * @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/).
5219
5634
  */
5220
5635
  async listInventoryExport(
5221
5636
  { status, fromDate, toDate, q, requestHeaders } = { requestHeaders: {} },
@@ -5303,8 +5718,8 @@ class Catalog {
5303
5718
  * @param {import("../PlatformAPIClient").Options} - Options
5304
5719
  * @returns {Promise<CatalogPlatformModel.TemplatesResponse>} - Success response
5305
5720
  * @name listProductTemplate
5306
- * @summary: List all Templates
5307
- * @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/).
5721
+ * @summary: List product templates.
5722
+ * @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/).
5308
5723
  */
5309
5724
  async listProductTemplate(
5310
5725
  { department, requestHeaders } = { requestHeaders: {} },
@@ -5387,8 +5802,8 @@ class Catalog {
5387
5802
  * - Success response
5388
5803
  *
5389
5804
  * @name listProductTemplateCategories
5390
- * @summary: List Department specifiec product categories
5391
- * @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/).
5805
+ * @summary: List product template categories.
5806
+ * @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/).
5392
5807
  */
5393
5808
  async listProductTemplateCategories(
5394
5809
  { departments, itemType, requestHeaders } = { requestHeaders: {} },
@@ -5475,8 +5890,8 @@ class Catalog {
5475
5890
  * @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
5476
5891
  * Success response
5477
5892
  * @name listProductTemplateExportDetails
5478
- * @summary: Allows you to list all product templates export list details
5479
- * @description: Can view details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplateExportDetails/).
5893
+ * @summary: List product template export details.
5894
+ * @description: Retrieve export details related to product templates. Can view details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplateExportDetails/).
5480
5895
  */
5481
5896
  async listProductTemplateExportDetails(
5482
5897
  { requestHeaders } = { requestHeaders: {} },
@@ -5553,8 +5968,8 @@ class Catalog {
5553
5968
  * @returns {Promise<CatalogPlatformModel.ProductConfigurationDownloads>} -
5554
5969
  * Success response
5555
5970
  * @name listTemplateBrandTypeValues
5556
- * @summary: Allows you to list all values for Templates, Brands or Type
5557
- * @description: 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/).
5971
+ * @summary: List template brand type values.
5972
+ * @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/).
5558
5973
  */
5559
5974
  async listTemplateBrandTypeValues(
5560
5975
  { filter, templateTag, itemType, requestHeaders } = { requestHeaders: {} },
@@ -5641,8 +6056,8 @@ class Catalog {
5641
6056
  * @param {import("../PlatformAPIClient").Options} - Options
5642
6057
  * @returns {Promise<CatalogPlatformModel.CategoryUpdateResponse>} - Success response
5643
6058
  * @name updateCategory
5644
- * @summary: Update product categories
5645
- * @description: Update a product category using this api - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateCategory/).
6059
+ * @summary: Update category data.
6060
+ * @description: Modify data for an existing category in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateCategory/).
5646
6061
  */
5647
6062
  async updateCategory(
5648
6063
  { uid, body, requestHeaders } = { requestHeaders: {} },
@@ -5722,8 +6137,8 @@ class Catalog {
5722
6137
  * @param {import("../PlatformAPIClient").Options} - Options
5723
6138
  * @returns {Promise<CatalogPlatformModel.DepartmentModel>} - Success response
5724
6139
  * @name updateDepartment
5725
- * @summary: Update the department by their uid.
5726
- * @description: Update the department by their uid using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDepartment/).
6140
+ * @summary: Update department data.
6141
+ * @description: Modify the department by their uid using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDepartment/).
5727
6142
  */
5728
6143
  async updateDepartment(
5729
6144
  { uid, body, requestHeaders } = { requestHeaders: {} },
@@ -5803,8 +6218,8 @@ class Catalog {
5803
6218
  * @param {import("../PlatformAPIClient").Options} - Options
5804
6219
  * @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
5805
6220
  * @name updateHsnCode
5806
- * @summary: Update Hsn Code.
5807
- * @description: Update Hsn Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateHsnCode/).
6221
+ * @summary: Update HSN code.
6222
+ * @description: Modify the HSN code associated with a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateHsnCode/).
5808
6223
  */
5809
6224
  async updateHsnCode(
5810
6225
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -5884,8 +6299,8 @@ class Catalog {
5884
6299
  * @param {import("../PlatformAPIClient").Options} - Options
5885
6300
  * @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
5886
6301
  * @name updateInventories
5887
- * @summary: Add Inventory for particular size and store.
5888
- * @description: This API allows add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateInventories/).
6302
+ * @summary: Update inventories.
6303
+ * @description: Allows to add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateInventories/).
5889
6304
  */
5890
6305
  async updateInventories(
5891
6306
  { body, requestHeaders } = { requestHeaders: {} },
@@ -6050,8 +6465,8 @@ class Catalog {
6050
6465
  * - Success response
6051
6466
  *
6052
6467
  * @name updateProductBundle
6053
- * @summary: Update a Product Bundle
6054
- * @description: Update a Product Bundle by its id. On successful request, returns the updated product bundle - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateProductBundle/).
6468
+ * @summary: Update a product bundle.
6469
+ * @description: Modify the details of an existing product bundle. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateProductBundle/).
6055
6470
  */
6056
6471
  async updateProductBundle(
6057
6472
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -6131,8 +6546,8 @@ class Catalog {
6131
6546
  * @param {import("../PlatformAPIClient").Options} - Options
6132
6547
  * @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
6133
6548
  * @name updateRealtimeInventory
6134
- * @summary: Add Inventory for particular size and store.
6135
- * @description: This API allows add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateRealtimeInventory/).
6549
+ * @summary: Update realtime inventory.
6550
+ * @description: Allows to add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateRealtimeInventory/).
6136
6551
  */
6137
6552
  async updateRealtimeInventory(
6138
6553
  { itemId, sellerIdentifier, body, requestHeaders } = { requestHeaders: {} },
@@ -6216,8 +6631,8 @@ class Catalog {
6216
6631
  * @param {import("../PlatformAPIClient").Options} - Options
6217
6632
  * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
6218
6633
  * @name updateSizeGuide
6219
- * @summary: Edit a size guide.
6220
- * @description: This API allows to edit a size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSizeGuide/).
6634
+ * @summary: Update a size guide.
6635
+ * @description: Allows to edit a size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSizeGuide/).
6221
6636
  */
6222
6637
  async updateSizeGuide(
6223
6638
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -6297,8 +6712,8 @@ class Catalog {
6297
6712
  * @param {import("../PlatformAPIClient").Options} - Options
6298
6713
  * @returns {Promise<CatalogPlatformModel.BulkResponse>} - Success response
6299
6714
  * @name uploadBulkProducts
6300
- * @summary: Create a Bulk product to upload job.
6301
- * @description: This API helps to create a bulk products upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/uploadBulkProducts/).
6715
+ * @summary: Upload bulk products.
6716
+ * @description: Helps to create a bulk products upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/uploadBulkProducts/).
6302
6717
  */
6303
6718
  async uploadBulkProducts(
6304
6719
  { department, productType, body, requestHeaders } = { requestHeaders: {} },
@@ -6383,8 +6798,8 @@ class Catalog {
6383
6798
  * @returns {Promise<CatalogPlatformModel.TemplatesValidationResponse>} -
6384
6799
  * Success response
6385
6800
  * @name validateProductTemplate
6386
- * @summary: Validate Product Template Schema
6387
- * @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/).
6801
+ * @summary: Validate product template.
6802
+ * @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/).
6388
6803
  */
6389
6804
  async validateProductTemplate(
6390
6805
  { slug, itemType, bulk, requestHeaders } = { requestHeaders: {} },
@@ -6473,8 +6888,8 @@ class Catalog {
6473
6888
  * @returns {Promise<CatalogPlatformModel.InventoryValidationResponse>} -
6474
6889
  * Success response
6475
6890
  * @name validateProductTemplateSchema
6476
- * @summary: Validate Product Template Schema
6477
- * @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/).
6891
+ * @summary: Validate product template schema.
6892
+ * @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/).
6478
6893
  */
6479
6894
  async validateProductTemplateSchema(
6480
6895
  { itemType, requestHeaders } = { requestHeaders: {} },