@gofynd/fdk-client-javascript 1.4.3 → 1.4.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 (125) hide show
  1. package/README.md +1 -10
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +48 -48
  4. package/sdk/application/Cart/CartApplicationClient.js +48 -48
  5. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +69 -69
  6. package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
  7. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  8. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  9. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
  10. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  11. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -32
  12. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
  13. package/sdk/application/Content/ContentApplicationClient.d.ts +45 -45
  14. package/sdk/application/Content/ContentApplicationClient.js +45 -45
  15. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +5 -5
  16. package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
  17. package/sdk/application/Lead/LeadApplicationClient.d.ts +9 -9
  18. package/sdk/application/Lead/LeadApplicationClient.js +9 -9
  19. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -22
  20. package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
  21. package/sdk/application/Order/OrderApplicationClient.d.ts +14 -25
  22. package/sdk/application/Order/OrderApplicationClient.js +14 -94
  23. package/sdk/application/Order/OrderApplicationValidator.d.ts +1 -15
  24. package/sdk/application/Order/OrderApplicationValidator.js +0 -13
  25. package/sdk/application/Payment/PaymentApplicationClient.d.ts +71 -71
  26. package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
  27. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
  28. package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
  29. package/sdk/application/Share/ShareApplicationClient.d.ts +1 -1
  30. package/sdk/application/Share/ShareApplicationClient.js +1 -1
  31. package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
  32. package/sdk/application/Share/ShareApplicationModel.js +2 -0
  33. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  34. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  35. package/sdk/application/User/UserApplicationClient.d.ts +74 -74
  36. package/sdk/application/User/UserApplicationClient.js +74 -74
  37. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +5 -5
  38. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
  39. package/sdk/platform/Billing/BillingPlatformClient.d.ts +13 -13
  40. package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
  41. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +102 -102
  42. package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
  43. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +132 -131
  44. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
  45. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +130 -130
  46. package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
  47. package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
  48. package/sdk/platform/Common/CommonPlatformClient.js +2 -2
  49. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +118 -118
  50. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
  51. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
  52. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  53. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +22 -22
  54. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
  55. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +34 -7
  56. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +35 -5
  57. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +4 -4
  58. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +4 -4
  59. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +41 -41
  60. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
  61. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +26 -26
  62. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
  63. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +93 -93
  64. package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
  65. package/sdk/platform/Content/ContentPlatformClient.d.ts +29 -29
  66. package/sdk/platform/Content/ContentPlatformClient.js +29 -29
  67. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +18 -18
  68. package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
  69. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -17
  70. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
  71. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
  72. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
  73. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
  74. package/sdk/platform/Finance/FinancePlatformClient.d.ts +4 -4
  75. package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
  76. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
  77. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
  78. package/sdk/platform/Lead/LeadPlatformClient.d.ts +15 -15
  79. package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
  80. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
  81. package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
  82. package/sdk/platform/Order/OrderPlatformClient.d.ts +95 -106
  83. package/sdk/platform/Order/OrderPlatformClient.js +95 -190
  84. package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -0
  85. package/sdk/platform/Order/OrderPlatformModel.js +4 -0
  86. package/sdk/platform/Order/OrderPlatformValidator.d.ts +1 -33
  87. package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
  88. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
  89. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  90. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +77 -77
  91. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
  92. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +2 -2
  93. package/sdk/platform/Payment/PaymentPlatformClient.js +2 -2
  94. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
  95. package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
  96. package/sdk/platform/PlatformClient.d.ts +0 -2
  97. package/sdk/platform/PlatformClient.js +0 -4
  98. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +7 -7
  99. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
  100. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +40 -40
  101. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
  102. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +51 -50
  103. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
  104. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +1 -1
  105. package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
  106. package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
  107. package/sdk/platform/Share/SharePlatformModel.js +2 -0
  108. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +34 -104
  109. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
  110. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +1 -100
  111. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
  112. package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
  113. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  114. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -35
  115. package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
  116. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +7 -6
  117. package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
  118. package/sdk/platform/index.d.ts +0 -1
  119. package/sdk/platform/index.js +0 -2
  120. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
  121. package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
  122. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
  123. package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
  124. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
  125. package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
@@ -8,8 +8,8 @@ declare class Catalog {
8
8
  * @param {import("../PlatformAPIClient").Options} - Options
9
9
  * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
10
10
  * @name addInventory
11
- * @summary: Add Inventory for particular size and store
12
- * @description: Allows add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/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
13
  */
14
14
  addInventory({ itemId, size, body, requestHeaders }?: CatalogPlatformValidator.AddInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
15
15
  /**
@@ -18,7 +18,7 @@ declare class Catalog {
18
18
  * @param {import("../PlatformAPIClient").Options} - Options
19
19
  * @returns {Promise<CatalogPlatformModel.GetAllSizes>} - Success response
20
20
  * @name allSizes
21
- * @summary: Get all product sizes
21
+ * @summary: Get product sizes
22
22
  * @description: Retrieve all available sizes for a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/allSizes/).
23
23
  */
24
24
  allSizes({ itemId, requestHeaders }?: CatalogPlatformValidator.AllSizesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAllSizes>;
@@ -28,8 +28,8 @@ declare class Catalog {
28
28
  * @param {import("../PlatformAPIClient").Options} - Options
29
29
  * @returns {Promise<CatalogPlatformModel.BulkHsnResponse>} - Success response
30
30
  * @name bulkHsnCode
31
- * @summary: Bulk update HSN codes
32
- * @description: Perform bulk updates of HSN codes for products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/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
33
  */
34
34
  bulkHsnCode({ body, requestHeaders }?: CatalogPlatformValidator.BulkHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkHsnResponse>;
35
35
  /**
@@ -58,7 +58,7 @@ declare class Catalog {
58
58
  * @param {import("../PlatformAPIClient").Options} - Options
59
59
  * @returns {Promise<CatalogPlatformModel.BulkResponse>} - Success response
60
60
  * @name createBulkProductUploadJob
61
- * @summary: Create a Bulk product to upload job
61
+ * @summary: Create products bulk upload
62
62
  * @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
63
  */
64
64
  createBulkProductUploadJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponse>;
@@ -69,7 +69,7 @@ declare class Catalog {
69
69
  * @returns {Promise<CatalogPlatformModel.CategoryCreateResponse>} - Success response
70
70
  * @name createCategories
71
71
  * @summary: Create categories
72
- * @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/).
72
+ * @description: Allows to create product categories for specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCategories/).
73
73
  */
74
74
  createCategories({ body, requestHeaders }?: CatalogPlatformValidator.CreateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryCreateResponse>;
75
75
  /**
@@ -80,7 +80,7 @@ declare class Catalog {
80
80
  * Success response
81
81
  * @name createDepartments
82
82
  * @summary: Create departments
83
- * @description: Create departments with this resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createDepartments/).
83
+ * @description: Create departments for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createDepartments/).
84
84
  */
85
85
  createDepartments({ body, requestHeaders }?: CatalogPlatformValidator.CreateDepartmentsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentCreateResponse>;
86
86
  /**
@@ -90,7 +90,7 @@ declare class Catalog {
90
90
  * @returns {Promise<CatalogPlatformModel.InventoryExportResponse>} - Success response
91
91
  * @name createInventoryExport
92
92
  * @summary: Create inventory export
93
- * @description: Helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExport/).
93
+ * @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/).
94
94
  */
95
95
  createInventoryExport({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponse>;
96
96
  /**
@@ -109,8 +109,8 @@ declare class Catalog {
109
109
  * @param {import("../PlatformAPIClient").Options} - Options
110
110
  * @returns {Promise<CatalogPlatformModel.UpdatedResponse>} - Success response
111
111
  * @name createMarketplaceOptin
112
- * @summary: Create/Update opt-in infomation
113
- * @description: Use this API to create/update opt-in information for given platform. If successful, returns data in the response body as specified in `OptInPostResponseSchema` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createMarketplaceOptin/).
112
+ * @summary: Create or Update opt-in infomation
113
+ * @description: Allows to create and update opt-in information for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createMarketplaceOptin/).
114
114
  */
115
115
  createMarketplaceOptin({ marketplace, body, requestHeaders }?: CatalogPlatformValidator.CreateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdatedResponse>;
116
116
  /**
@@ -119,8 +119,8 @@ declare class Catalog {
119
119
  * @param {import("../PlatformAPIClient").Options} - Options
120
120
  * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
121
121
  * @name createProduct
122
- * @summary: Create a product
123
- * @description: Allows to create product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProduct/).
122
+ * @summary: Create product
123
+ * @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/).
124
124
  */
125
125
  createProduct({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
126
126
  /**
@@ -141,8 +141,8 @@ declare class Catalog {
141
141
  * - Success response
142
142
  *
143
143
  * @name createProductBundle
144
- * @summary: Create a product bundle
145
- * @description: Create product bundle in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductBundle/).
144
+ * @summary: Create product bundle
145
+ * @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/).
146
146
  */
147
147
  createProductBundle({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponse>;
148
148
  /**
@@ -153,7 +153,7 @@ declare class Catalog {
153
153
  * Success response
154
154
  * @name createProductExportJob
155
155
  * @summary: Create product export job
156
- * @description: Helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductExportJob/).
156
+ * @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/).
157
157
  */
158
158
  createProductExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
159
159
  /**
@@ -172,8 +172,8 @@ declare class Catalog {
172
172
  * @param {import("../PlatformAPIClient").Options} - Options
173
173
  * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
174
174
  * @name createSizeGuide
175
- * @summary: Create a size guide
176
- * @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/).
175
+ * @summary: Create size guide
176
+ * @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/).
177
177
  */
178
178
  createSizeGuide({ body, requestHeaders }?: CatalogPlatformValidator.CreateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
179
179
  /**
@@ -192,8 +192,8 @@ declare class Catalog {
192
192
  * @param {import("../PlatformAPIClient").Options} - Options
193
193
  * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
194
194
  * @name deleteProduct
195
- * @summary: Delete a product
196
- * @description: Remove a specific product in the catalog - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProduct/).
195
+ * @summary: Delete product
196
+ * @description: Users can delete a product using this by providing the itemid. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProduct/).
197
197
  */
198
198
  deleteProduct({ itemId, requestHeaders }?: CatalogPlatformValidator.DeleteProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
199
199
  /**
@@ -202,7 +202,7 @@ declare class Catalog {
202
202
  * @param {import("../PlatformAPIClient").Options} - Options
203
203
  * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
204
204
  * @name deleteProductBulkJob
205
- * @summary: Delete product bulk upload job
205
+ * @summary: Delete product bulk-upload job
206
206
  * @description: Allows to delete bulk product job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProductBulkJob/).
207
207
  */
208
208
  deleteProductBulkJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteProductBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
@@ -212,8 +212,8 @@ declare class Catalog {
212
212
  * @param {import("../PlatformAPIClient").Options} - Options
213
213
  * @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
214
214
  * @name deleteRealtimeInventory
215
- * @summary: Delete realtime inventory
216
- * @description: Remove specific realtime inventory data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteRealtimeInventory/).
215
+ * @summary: Delete an inventory
216
+ * @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/).
217
217
  */
218
218
  deleteRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.DeleteRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
219
219
  /**
@@ -235,8 +235,8 @@ declare class Catalog {
235
235
  * @param {import("../PlatformAPIClient").Options} - Options
236
236
  * @returns {Promise<string>} - Success response
237
237
  * @name downloadInventoryTemplateView
238
- * @summary: Download inventory template view
239
- * @description: Allows you to download product template data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadInventoryTemplateView/).
238
+ * @summary: Download inventory template data
239
+ * @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/).
240
240
  */
241
241
  downloadInventoryTemplateView({ itemType, requestHeaders }?: CatalogPlatformValidator.DownloadInventoryTemplateViewParam, { responseHeaders }?: object): Promise<string>;
242
242
  /**
@@ -247,8 +247,8 @@ declare class Catalog {
247
247
  * @param {import("../PlatformAPIClient").Options} - Options
248
248
  * @returns {Promise<string>} - Success response
249
249
  * @name downloadProductTemplateViews
250
- * @summary: Download product template views
251
- * @description: Allows you to download product template data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadProductTemplateViews/).
250
+ * @summary: Download product template view
251
+ * @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/).
252
252
  */
253
253
  downloadProductTemplateViews({ slug, itemType, type, requestHeaders }?: CatalogPlatformValidator.DownloadProductTemplateViewsParam, { responseHeaders }?: object): Promise<string>;
254
254
  /**
@@ -257,7 +257,7 @@ declare class Catalog {
257
257
  * @param {import("../PlatformAPIClient").Options} - Options
258
258
  * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
259
259
  * @name editProduct
260
- * @summary: Edit a product
260
+ * @summary: Update a product
261
261
  * @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/).
262
262
  */
263
263
  editProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.EditProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
@@ -267,7 +267,7 @@ declare class Catalog {
267
267
  * @param {import("../PlatformAPIClient").Options} - Options
268
268
  * @returns {Promise<CatalogPlatformModel.InventoryConfig>} - Success response
269
269
  * @name exportInventoryConfig
270
- * @summary: Export inventory configuration
270
+ * @summary: Get export inventory configuration
271
271
  * @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/).
272
272
  */
273
273
  exportInventoryConfig({ filterType, requestHeaders }?: CatalogPlatformValidator.ExportInventoryConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryConfig>;
@@ -279,8 +279,8 @@ declare class Catalog {
279
279
  * - Success response
280
280
  *
281
281
  * @name getAllProductHsnCodes
282
- * @summary: Get all product HSN codes
283
- * @description: Retrieve all HSN codes associated with products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllProductHsnCodes/).
282
+ * @summary: List product HSN codes
283
+ * @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/).
284
284
  */
285
285
  getAllProductHsnCodes({ pageNo, pageSize, q, type, requestHeaders }?: CatalogPlatformValidator.GetAllProductHsnCodesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCodesListingResponseSchemaV2>;
286
286
  /**
@@ -289,8 +289,8 @@ declare class Catalog {
289
289
  * @param {import("../PlatformAPIClient").Options} - Options
290
290
  * @returns {Promise<CatalogPlatformModel.SingleCategoryResponse>} - Success response
291
291
  * @name getCategoryData
292
- * @summary: Get category data
293
- * @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/).
292
+ * @summary: Get category by uid
293
+ * @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/).
294
294
  */
295
295
  getCategoryData({ uid, requestHeaders }?: CatalogPlatformValidator.GetCategoryDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleCategoryResponse>;
296
296
  /**
@@ -300,8 +300,8 @@ declare class Catalog {
300
300
  * @returns {Promise<CatalogPlatformModel.OptinCompanyBrandDetailsView>} -
301
301
  * Success response
302
302
  * @name getCompanyBrandDetail
303
- * @summary: Get the Company Brand details of Optin
304
- * @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/).
303
+ * @summary: list Company Brand of Optin
304
+ * @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/).
305
305
  */
306
306
  getCompanyBrandDetail({ isActive, q, pageNo, pageSize, marketplace, requestHeaders }?: CatalogPlatformValidator.GetCompanyBrandDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyBrandDetailsView>;
307
307
  /**
@@ -310,8 +310,8 @@ declare class Catalog {
310
310
  * @param {import("../PlatformAPIClient").Options} - Options
311
311
  * @returns {Promise<CatalogPlatformModel.OptinCompanyDetail>} - Success response
312
312
  * @name getCompanyDetail
313
- * @summary: Get the Company details
314
- * @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/).
313
+ * @summary: Get Company
314
+ * @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/).
315
315
  */
316
316
  getCompanyDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyDetail>;
317
317
  /**
@@ -321,7 +321,7 @@ declare class Catalog {
321
321
  * @returns {Promise<CatalogPlatformModel.OptinCompanyMetrics>} - Success response
322
322
  * @name getCompanyMetrics
323
323
  * @summary: Get company metrics
324
- * @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/).
324
+ * @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/).
325
325
  */
326
326
  getCompanyMetrics({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyMetrics>;
327
327
  /**
@@ -330,8 +330,8 @@ declare class Catalog {
330
330
  * @param {import("../PlatformAPIClient").Options} - Options
331
331
  * @returns {Promise<CatalogPlatformModel.DepartmentsResponse>} - Success response
332
332
  * @name getDepartmentData
333
- * @summary: Get department data
334
- * @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
+ * @summary: Get department by uid
334
+ * @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/).
335
335
  */
336
336
  getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
337
337
  /**
@@ -340,8 +340,8 @@ declare class Catalog {
340
340
  * @param {import("../PlatformAPIClient").Options} - Options
341
341
  * @returns {Promise<CatalogPlatformModel.GenderDetail>} - Success response
342
342
  * @name getGenderAttribute
343
- * @summary: Get gender attribute
344
- * @description: Retrieve the gender attribute for catalog listings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGenderAttribute/).
343
+ * @summary: Get gender attribute by slug
344
+ * @description: Retrieve the gender attribute for catalog listings by attribute slug passed for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGenderAttribute/).
345
345
  */
346
346
  getGenderAttribute({ attributeSlug, requestHeaders }?: CatalogPlatformValidator.GetGenderAttributeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GenderDetail>;
347
347
  /**
@@ -350,7 +350,7 @@ declare class Catalog {
350
350
  * @param {import("../PlatformAPIClient").Options} - Options
351
351
  * @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
352
352
  * @name getHsnCode
353
- * @summary: Get HSN code
353
+ * @summary: List HSN code
354
354
  * @description: Retrieve the HSN code for a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getHsnCode/).
355
355
  */
356
356
  getHsnCode({ id, requestHeaders }?: CatalogPlatformValidator.GetHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCode>;
@@ -360,8 +360,8 @@ declare class Catalog {
360
360
  * @param {import("../PlatformAPIClient").Options} - Options
361
361
  * @returns {Promise<CatalogPlatformModel.GetInventoriesResponse>} - Success response
362
362
  * @name getInventories
363
- * @summary: Retrieve inventories
364
- * @description: Allows to get Inventories data for particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventories/).
363
+ * @summary: List Inventory
364
+ * @description: Allows to get Inventories data for particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventories/).
365
365
  */
366
366
  getInventories({ itemId, size, pageNo, pageSize, q, sellable, storeIds, sizeIdentifier, requestHeaders, }?: CatalogPlatformValidator.GetInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetInventoriesResponse>;
367
367
  /**
@@ -376,7 +376,7 @@ declare class Catalog {
376
376
  * @param {string} [arg.sizeIdentifier] - Size Identifier (Seller Identifier
377
377
  * or Primary Identifier) of which inventory is to get.
378
378
  * @returns {Paginator<CatalogPlatformModel.GetInventoriesResponse>}
379
- * @summary: Retrieve inventories
379
+ * @summary: List Inventory
380
380
  * @description: Allows to get Inventories data for particular company.
381
381
  */
382
382
  getInventoriesPaginator({ itemId, size, pageSize, q, sellable, storeIds, sizeIdentifier, }?: {
@@ -396,8 +396,8 @@ declare class Catalog {
396
396
  * @param {import("../PlatformAPIClient").Options} - Options
397
397
  * @returns {Promise<CatalogPlatformModel.BulkInventoryGet>} - Success response
398
398
  * @name getInventoryBulkUploadHistory
399
- * @summary: Retrieve inventory bulk upload history
400
- * @description: Helps to get bulk Inventory upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBulkUploadHistory/).
399
+ * @summary: List bulk inventory upload history
400
+ * @description: Helps to get bulk Inventory upload jobs status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBulkUploadHistory/).
401
401
  */
402
402
  getInventoryBulkUploadHistory({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkInventoryGet>;
403
403
  /**
@@ -405,8 +405,8 @@ declare class Catalog {
405
405
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
406
406
  * page. Default is 12.
407
407
  * @returns {Paginator<CatalogPlatformModel.BulkInventoryGet>}
408
- * @summary: Retrieve inventory bulk upload history
409
- * @description: Helps to get bulk Inventory upload jobs data.
408
+ * @summary: List bulk inventory upload history
409
+ * @description: Helps to get bulk Inventory upload jobs status.
410
410
  */
411
411
  getInventoryBulkUploadHistoryPaginator({ pageSize }?: {
412
412
  pageSize?: number;
@@ -418,8 +418,8 @@ declare class Catalog {
418
418
  * @returns {Promise<CatalogPlatformModel.InventoryResponsePaginated>} -
419
419
  * Success response
420
420
  * @name getInventoryBySize
421
- * @summary: Get inventory by size
422
- * @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/).
421
+ * @summary: List inventory by size
422
+ * @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/).
423
423
  */
424
424
  getInventoryBySize({ itemId, size, pageNo, pageSize, q, sellable, requestHeaders }?: CatalogPlatformValidator.GetInventoryBySizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryResponsePaginated>;
425
425
  /**
@@ -431,8 +431,8 @@ declare class Catalog {
431
431
  * @param {string} [arg.q] - Search with help of store code.
432
432
  * @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
433
433
  * @returns {Paginator<CatalogPlatformModel.InventoryResponsePaginated>}
434
- * @summary: Get inventory by size
435
- * @description: Allows to retrieve Inventory data for particular company grouped by size and store.
434
+ * @summary: List inventory by size
435
+ * @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)."
436
436
  */
437
437
  getInventoryBySizePaginator({ itemId, size, pageSize, q, sellable }?: {
438
438
  itemId: number;
@@ -451,8 +451,8 @@ declare class Catalog {
451
451
  * - Success response
452
452
  *
453
453
  * @name getInventoryBySizeIdentifier
454
- * @summary: Get inventory by size identifier
455
- * @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/).
454
+ * @summary: List inventory by size
455
+ * @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/).
456
456
  */
457
457
  getInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, requestHeaders, }?: CatalogPlatformValidator.GetInventoryBySizeIdentifierParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
458
458
  /**
@@ -465,8 +465,8 @@ declare class Catalog {
465
465
  * @param {string} [arg.q] - Search with help of store code.
466
466
  * @param {number[]} [arg.locationIds] - Search by store ids.
467
467
  * @returns {Paginator<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>}
468
- * @summary: Get inventory by size identifier
469
- * @description: Allows to retrieve Inventory data for particular company grouped by size and store.
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.
470
470
  */
471
471
  getInventoryBySizeIdentifierPaginator({ itemId, sizeIdentifier, pageSize, q, locationIds, }?: {
472
472
  itemId: number;
@@ -481,8 +481,8 @@ declare class Catalog {
481
481
  * @param {import("../PlatformAPIClient").Options} - Options
482
482
  * @returns {Promise<CatalogPlatformModel.InventoryExportJob>} - Success response
483
483
  * @name getInventoryExport
484
- * @summary: Retrieve inventory export data
485
- * @description: Helps to retrieve Inventory export history. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryExport/).
484
+ * @summary: list product inventory
485
+ * @description: Retrieves inventory for all products for that particular company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryExport/).
486
486
  */
487
487
  getInventoryExport({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJob>;
488
488
  /**
@@ -491,8 +491,8 @@ declare class Catalog {
491
491
  * @param {import("../PlatformAPIClient").Options} - Options
492
492
  * @returns {Promise<CatalogPlatformModel.GetOptInPlatform>} - Success response
493
493
  * @name getMarketplaceOptinDetail
494
- * @summary: Get opt-in infomation
495
- * @description: Use this API to fetch opt-in information for all the platforms. If successful, returns a logs in the response body as specified in `GetOptInPlatformSchema` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMarketplaceOptinDetail/).
494
+ * @summary: Get opt-in
495
+ * @description: Allows to fetch opt-in information for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMarketplaceOptinDetail/).
496
496
  */
497
497
  getMarketplaceOptinDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetOptInPlatform>;
498
498
  /**
@@ -501,8 +501,8 @@ declare class Catalog {
501
501
  * @param {import("../PlatformAPIClient").Options} - Options
502
502
  * @returns {Promise<CatalogPlatformModel.GetAllMarketplaces>} - Success response
503
503
  * @name getMarketplaces
504
- * @summary: List all marketplaces
505
- * @description: This API allows to get marketplace information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMarketplaces/).
504
+ * @summary: List marketplaces
505
+ * @description: Allows to get all marketplaces information for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMarketplaces/).
506
506
  */
507
507
  getMarketplaces({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAllMarketplaces>;
508
508
  /**
@@ -512,7 +512,7 @@ declare class Catalog {
512
512
  * @returns {Promise<CatalogPlatformModel.StoreAssignResponse>} - Success response
513
513
  * @name getOptimalLocations
514
514
  * @summary: Get optimal locations
515
- * @description: Retrieve the most suitable locations based on certain criteria. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getOptimalLocations/).
515
+ * @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/).
516
516
  */
517
517
  getOptimalLocations({ body, requestHeaders }?: CatalogPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.StoreAssignResponse>;
518
518
  /**
@@ -521,7 +521,7 @@ declare class Catalog {
521
521
  * @param {import("../PlatformAPIClient").Options} - Options
522
522
  * @returns {Promise<CatalogPlatformModel.SingleProductResponse>} - Success response
523
523
  * @name getProduct
524
- * @summary: Get product details
524
+ * @summary: Get a product
525
525
  * @description: Retrieve data associated to a particular product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProduct/).
526
526
  */
527
527
  getProduct({ itemId, brandUid, itemCode, requestHeaders }?: CatalogPlatformValidator.GetProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleProductResponse>;
@@ -531,7 +531,7 @@ declare class Catalog {
531
531
  * @param {import("../PlatformAPIClient").Options} - Options
532
532
  * @returns {Promise<CatalogPlatformModel.BulkAssetResponse>} - Success response
533
533
  * @name getProductAssetsInBulk
534
- * @summary: Retrieve product assets in bulk
534
+ * @summary: Get product assets
535
535
  * @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/).
536
536
  */
537
537
  getProductAssetsInBulk({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkAssetResponse>;
@@ -540,7 +540,7 @@ declare class Catalog {
540
540
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
541
541
  * page. Default is 12.
542
542
  * @returns {Paginator<CatalogPlatformModel.BulkAssetResponse>}
543
- * @summary: Retrieve product assets in bulk
543
+ * @summary: Get product assets
544
544
  * @description: Helps to retrieve bulk asset jobs data associated to a particular company.
545
545
  */
546
546
  getProductAssetsInBulkPaginator({ pageSize }?: {
@@ -553,8 +553,8 @@ declare class Catalog {
553
553
  * @returns {Promise<CatalogPlatformModel.ProductAttributesResponse>} -
554
554
  * Success response
555
555
  * @name getProductAttributes
556
- * @summary: Get product attributes
557
- * @description: List all the attributes by their L3 categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAttributes/).
556
+ * @summary: List product attributes
557
+ * @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/).
558
558
  */
559
559
  getProductAttributes({ category, filter, requestHeaders }?: CatalogPlatformValidator.GetProductAttributesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductAttributesResponse>;
560
560
  /**
@@ -563,7 +563,7 @@ declare class Catalog {
563
563
  * @param {import("../PlatformAPIClient").Options} - Options
564
564
  * @returns {Promise<CatalogPlatformModel.ProductBulkRequestList>} - Success response
565
565
  * @name getProductBulkUploadHistory
566
- * @summary: Retrieve product bulk upload history
566
+ * @summary: List product bulk upload history
567
567
  * @description: Helps to get bulk product upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBulkUploadHistory/).
568
568
  */
569
569
  getProductBulkUploadHistory({ search, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductBulkRequestList>;
@@ -573,7 +573,7 @@ declare class Catalog {
573
573
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
574
574
  * page. Default is 12.
575
575
  * @returns {Paginator<CatalogPlatformModel.ProductBulkRequestList>}
576
- * @summary: Retrieve product bulk upload history
576
+ * @summary: List product bulk upload history
577
577
  * @description: Helps to get bulk product upload jobs data.
578
578
  */
579
579
  getProductBulkUploadHistoryPaginator({ search, pageSize }?: {
@@ -588,8 +588,8 @@ declare class Catalog {
588
588
  * - Success response
589
589
  *
590
590
  * @name getProductBundle
591
- * @summary: Retrieve product bundles
592
- * @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/).
591
+ * @summary: List product bundles
592
+ * @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/).
593
593
  */
594
594
  getProductBundle({ q, slug, requestHeaders }?: CatalogPlatformValidator.GetProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleListingResponse>;
595
595
  /**
@@ -599,8 +599,8 @@ declare class Catalog {
599
599
  * @returns {Promise<CatalogPlatformModel.GetProductBundleResponse>} -
600
600
  * Success response
601
601
  * @name getProductBundleDetail
602
- * @summary: Get product bundle details
603
- * @description: Retrieve detailed information about a specific product bundle. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundleDetail/).
602
+ * @summary: Get product bundle
603
+ * @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/).
604
604
  */
605
605
  getProductBundleDetail({ id, requestHeaders }?: CatalogPlatformValidator.GetProductBundleDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleResponse>;
606
606
  /**
@@ -610,8 +610,8 @@ declare class Catalog {
610
610
  * @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
611
611
  * Success response
612
612
  * @name getProductExportJobs
613
- * @summary: Retrieve product export jobs
614
- * @description: View details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportJobs/).
613
+ * @summary: Get product export jobs
614
+ * @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/).
615
615
  */
616
616
  getProductExportJobs({ status, fromDate, toDate, q, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
617
617
  /**
@@ -620,7 +620,7 @@ declare class Catalog {
620
620
  * @param {import("../PlatformAPIClient").Options} - Options
621
621
  * @returns {Promise<CatalogPlatformModel.ProductListingResponse>} - Success response
622
622
  * @name getProductSize
623
- * @summary: Get product size details
623
+ * @summary: List product size
624
624
  * @description: Retrieve data associated to a particular product size. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductSize/).
625
625
  */
626
626
  getProductSize({ itemId, itemCode, brandUid, uid, requestHeaders }?: CatalogPlatformValidator.GetProductSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponse>;
@@ -630,7 +630,7 @@ declare class Catalog {
630
630
  * @param {import("../PlatformAPIClient").Options} - Options
631
631
  * @returns {Promise<CatalogPlatformModel.ProductTagsViewResponse>} - Success response
632
632
  * @name getProductTags
633
- * @summary: Get product tags
633
+ * @summary: List product tags
634
634
  * @description: Retrieve tags data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductTags/).
635
635
  */
636
636
  getProductTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductTagsViewResponse>;
@@ -640,8 +640,8 @@ declare class Catalog {
640
640
  * @param {import("../PlatformAPIClient").Options} - Options
641
641
  * @returns {Promise<CatalogPlatformModel.ValidateProduct>} - Success response
642
642
  * @name getProductValidation
643
- * @summary: Get product validation
644
- * @description: Retrieve validation data for a specific product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductValidation/).
643
+ * @summary: Get valid products
644
+ * @description: Retrieve validation data for products at company level. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductValidation/).
645
645
  */
646
646
  getProductValidation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ValidateProduct>;
647
647
  /**
@@ -651,8 +651,8 @@ declare class Catalog {
651
651
  * @returns {Promise<CatalogPlatformModel.ProductListingResponseV2>} -
652
652
  * Success response
653
653
  * @name getProducts
654
- * @summary: Retrieve products
655
- * @description: Retrieve a list of products available - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProducts/).
654
+ * @summary: List products
655
+ * @description: Retrieve a list of available products - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProducts/).
656
656
  */
657
657
  getProducts({ brandIds, categoryIds, itemIds, departmentIds, itemCode, q, tags, pageNo, pageSize, requestHeaders, }?: CatalogPlatformValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponseV2>;
658
658
  /**
@@ -669,8 +669,8 @@ declare class Catalog {
669
669
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
670
670
  * page. Default is 10.
671
671
  * @returns {Paginator<CatalogPlatformModel.ProductListingResponseV2>}
672
- * @summary: Retrieve products
673
- * @description: Retrieve a list of products available
672
+ * @summary: List products
673
+ * @description: Retrieve a list of available products
674
674
  */
675
675
  getProductsPaginator({ brandIds, categoryIds, itemIds, departmentIds, itemCode, q, tags, pageSize, }?: {
676
676
  brandIds?: number[];
@@ -688,8 +688,8 @@ declare class Catalog {
688
688
  * @param {import("../PlatformAPIClient").Options} - Options
689
689
  * @returns {Promise<CatalogPlatformModel.CrossSellingResponse>} - Success response
690
690
  * @name getSellerInsights
691
- * @summary: Get seller insights
692
- * @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/).
691
+ * @summary: Get seller catalog counts
692
+ * @description: Retrieve the count of catalog related data for sellers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSellerInsights/).
693
693
  */
694
694
  getSellerInsights({ sellerAppId, requestHeaders }?: CatalogPlatformValidator.GetSellerInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CrossSellingResponse>;
695
695
  /**
@@ -698,8 +698,8 @@ declare class Catalog {
698
698
  * @param {import("../PlatformAPIClient").Options} - Options
699
699
  * @returns {Promise<CatalogPlatformModel.HSNDataInsertV2>} - Success response
700
700
  * @name getSingleProductHSNCode
701
- * @summary: Get single product HSN code
702
- * @description: Retrieve the HSN code for a single product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSingleProductHSNCode/).
701
+ * @summary: Get product HSN code
702
+ * @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/).
703
703
  */
704
704
  getSingleProductHSNCode({ reportingHsn, requestHeaders }?: CatalogPlatformValidator.GetSingleProductHSNCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNDataInsertV2>;
705
705
  /**
@@ -708,8 +708,8 @@ declare class Catalog {
708
708
  * @param {import("../PlatformAPIClient").Options} - Options
709
709
  * @returns {Promise<CatalogPlatformModel.SizeGuideResponse>} - Success response
710
710
  * @name getSizeGuide
711
- * @summary: Get size guide details
712
- * @description: Retrieve data associated about a specific size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuide/).
711
+ * @summary: Get size guide
712
+ * @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/).
713
713
  */
714
714
  getSizeGuide({ id, requestHeaders }?: CatalogPlatformValidator.GetSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SizeGuideResponse>;
715
715
  /**
@@ -718,8 +718,8 @@ declare class Catalog {
718
718
  * @param {import("../PlatformAPIClient").Options} - Options
719
719
  * @returns {Promise<CatalogPlatformModel.ListSizeGuide>} - Success response
720
720
  * @name getSizeGuides
721
- * @summary: Retrieve size guides
722
- * @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/).
721
+ * @summary: List size guides
722
+ * @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/).
723
723
  */
724
724
  getSizeGuides({ active, q, tag, pageNo, pageSize, brandId, requestHeaders }?: CatalogPlatformValidator.GetSizeGuidesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ListSizeGuide>;
725
725
  /**
@@ -728,8 +728,8 @@ declare class Catalog {
728
728
  * @param {import("../PlatformAPIClient").Options} - Options
729
729
  * @returns {Promise<CatalogPlatformModel.OptinStoreDetails>} - Success response
730
730
  * @name getStoreDetail
731
- * @summary: Get store details
732
- * @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/).
731
+ * @summary: Get selling location
732
+ * @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/).
733
733
  */
734
734
  getStoreDetail({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetStoreDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinStoreDetails>;
735
735
  /**
@@ -738,8 +738,8 @@ declare class Catalog {
738
738
  * @param {number} [arg.pageSize] - Number of records that can be seen on
739
739
  * the page for the company id.
740
740
  * @returns {Paginator<CatalogPlatformModel.OptinStoreDetails>}
741
- * @summary: Get store details
742
- * @description: Retrieve the details of the store associated with the company ID passed.
741
+ * @summary: Get selling location
742
+ * @description: Retrieve the details of the selling location (store) associated with a specific company passed.
743
743
  */
744
744
  getStoreDetailPaginator({ q, pageSize }?: {
745
745
  q?: string;
@@ -751,7 +751,7 @@ declare class Catalog {
751
751
  * @param {import("../PlatformAPIClient").Options} - Options
752
752
  * @returns {Promise<CatalogPlatformModel.ProductVariantsResponse>} - Success response
753
753
  * @name getVariantsOfProducts
754
- * @summary: Get variants of products
754
+ * @summary: Get variants
755
755
  * @description: Retrieve variants of a specific product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getVariantsOfProducts/).
756
756
  */
757
757
  getVariantsOfProducts({ itemId, variantType, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetVariantsOfProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductVariantsResponse>;
@@ -762,7 +762,7 @@ declare class Catalog {
762
762
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
763
763
  * page. Default is 10.
764
764
  * @returns {Paginator<CatalogPlatformModel.ProductVariantsResponse>}
765
- * @summary: Get variants of products
765
+ * @summary: Get variants
766
766
  * @description: Retrieve variants of a specific product.
767
767
  */
768
768
  getVariantsOfProductsPaginator({ itemId, variantType, pageSize }?: {
@@ -777,7 +777,7 @@ declare class Catalog {
777
777
  * @returns {Promise<CatalogPlatformModel.CategoryResponse>} - Success response
778
778
  * @name listCategories
779
779
  * @summary: List categories
780
- * @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/).
780
+ * @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/).
781
781
  */
782
782
  listCategories({ level, department, q, pageNo, pageSize, uids, slug, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryResponse>;
783
783
  /**
@@ -791,7 +791,7 @@ declare class Catalog {
791
791
  * @param {string} [arg.slug] - Get category by slug
792
792
  * @returns {Paginator<CatalogPlatformModel.CategoryResponse>}
793
793
  * @summary: List categories
794
- * @description: Retrieve a list of meta associated available product categories in the catalog.
794
+ * @description: Retrieve a list of categories data associated to a specific company and queries passed in the request.
795
795
  */
796
796
  listCategoriesPaginator({ level, department, q, pageSize, uids, slug }?: {
797
797
  level?: string;
@@ -807,8 +807,8 @@ declare class Catalog {
807
807
  * @param {import("../PlatformAPIClient").Options} - Options
808
808
  * @returns {Promise<CatalogPlatformModel.DepartmentsResponse>} - Success response
809
809
  * @name listDepartmentsData
810
- * @summary: List department data
811
- * @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/).
810
+ * @summary: List company department
811
+ * @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/).
812
812
  */
813
813
  listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, slug, requestHeaders, }?: CatalogPlatformValidator.ListDepartmentsDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
814
814
  /**
@@ -824,8 +824,8 @@ declare class Catalog {
824
824
  * whether they are active or inactive.
825
825
  * @param {string} [arg.slug] - Can filter by slug
826
826
  * @returns {Paginator<CatalogPlatformModel.DepartmentsResponse>}
827
- * @summary: List department data
828
- * @description: Allows you to list all departments, also can search using name and filter active and incative departments, and item type.
827
+ * @summary: List company department
828
+ * @description: Allows you to list all departments data for a specific company.
829
829
  */
830
830
  listDepartmentsDataPaginator({ itemType, pageSize, name, search, isActive, slug, }?: {
831
831
  itemType?: string;
@@ -842,7 +842,7 @@ declare class Catalog {
842
842
  * @returns {Promise<CatalogPlatformModel.HSNCodesResponse>} - Success response
843
843
  * @name listHSNCodes
844
844
  * @summary: List HSN codes
845
- * @description: Retrieve a list of Harmonized System Nomenclature (HSN) codes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listHSNCodes/).
845
+ * @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/).
846
846
  */
847
847
  listHSNCodes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNCodesResponse>;
848
848
  /**
@@ -853,8 +853,8 @@ declare class Catalog {
853
853
  * - Success response
854
854
  *
855
855
  * @name listInventoryExport
856
- * @summary: List inventory exports
857
- * @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/).
856
+ * @summary: List inventory export jobs
857
+ * @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/).
858
858
  */
859
859
  listInventoryExport({ status, fromDate, toDate, q, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobListResponse>;
860
860
  /**
@@ -864,7 +864,7 @@ declare class Catalog {
864
864
  * @returns {Promise<CatalogPlatformModel.TemplatesResponse>} - Success response
865
865
  * @name listProductTemplate
866
866
  * @summary: List product templates
867
- * @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/).
867
+ * @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/).
868
868
  */
869
869
  listProductTemplate({ department, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesResponse>;
870
870
  /**
@@ -878,7 +878,7 @@ declare class Catalog {
878
878
  *
879
879
  * @name listProductTemplateCategories
880
880
  * @summary: List product template categories
881
- * @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/).
881
+ * @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/).
882
882
  */
883
883
  listProductTemplateCategories({ departments, itemType, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponse>;
884
884
  /**
@@ -890,8 +890,8 @@ declare class Catalog {
890
890
  * @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
891
891
  * Success response
892
892
  * @name listProductTemplateExportDetails
893
- * @summary: List product template export details
894
- * @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/).
893
+ * @summary: List export product templates
894
+ * @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/).
895
895
  */
896
896
  listProductTemplateExportDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
897
897
  /**
@@ -901,8 +901,8 @@ declare class Catalog {
901
901
  * @returns {Promise<CatalogPlatformModel.ProductConfigurationDownloads>} -
902
902
  * Success response
903
903
  * @name listTemplateBrandTypeValues
904
- * @summary: List template brand type values
905
- * @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/).
904
+ * @summary: List template brand
905
+ * @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/).
906
906
  */
907
907
  listTemplateBrandTypeValues({ filter, templateTag, itemType, requestHeaders }?: CatalogPlatformValidator.ListTemplateBrandTypeValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductConfigurationDownloads>;
908
908
  /**
@@ -911,8 +911,8 @@ declare class Catalog {
911
911
  * @param {import("../PlatformAPIClient").Options} - Options
912
912
  * @returns {Promise<CatalogPlatformModel.CategoryUpdateResponse>} - Success response
913
913
  * @name updateCategory
914
- * @summary: Update category data
915
- * @description: Modify data for an existing category in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateCategory/).
914
+ * @summary: Update category
915
+ * @description: Modify data for an existing category by its uid for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateCategory/).
916
916
  */
917
917
  updateCategory({ uid, body, requestHeaders }?: CatalogPlatformValidator.UpdateCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryUpdateResponse>;
918
918
  /**
@@ -921,8 +921,8 @@ declare class Catalog {
921
921
  * @param {import("../PlatformAPIClient").Options} - Options
922
922
  * @returns {Promise<CatalogPlatformModel.DepartmentModel>} - Success response
923
923
  * @name updateDepartment
924
- * @summary: Update department data
925
- * @description: Modify the department by their uid using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDepartment/).
924
+ * @summary: Update department
925
+ * @description: Modify the department data by their uid for a specifc company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDepartment/).
926
926
  */
927
927
  updateDepartment({ uid, body, requestHeaders }?: CatalogPlatformValidator.UpdateDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentModel>;
928
928
  /**
@@ -942,7 +942,7 @@ declare class Catalog {
942
942
  * @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
943
943
  * @name updateInventories
944
944
  * @summary: Update inventories
945
- * @description: Allows to add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateInventories/).
945
+ * @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/).
946
946
  */
947
947
  updateInventories({ body, requestHeaders }?: CatalogPlatformValidator.UpdateInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
948
948
  /**
@@ -954,7 +954,7 @@ declare class Catalog {
954
954
  *
955
955
  * @name updateMarketplaceOptin
956
956
  * @summary: Update marketplace optin
957
- * @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/).
957
+ * @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/).
958
958
  */
959
959
  updateMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.UpdateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponse>;
960
960
  /**
@@ -965,8 +965,8 @@ declare class Catalog {
965
965
  * - Success response
966
966
  *
967
967
  * @name updateProductBundle
968
- * @summary: Update a product bundle
969
- * @description: Modify the details of an existing product bundle. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateProductBundle/).
968
+ * @summary: Update product bundle
969
+ * @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/).
970
970
  */
971
971
  updateProductBundle({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponse>;
972
972
  /**
@@ -975,8 +975,8 @@ declare class Catalog {
975
975
  * @param {import("../PlatformAPIClient").Options} - Options
976
976
  * @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
977
977
  * @name updateRealtimeInventory
978
- * @summary: Update realtime inventory
979
- * @description: Allows to add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateRealtimeInventory/).
978
+ * @summary: Update an inventory
979
+ * @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/).
980
980
  */
981
981
  updateRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
982
982
  /**
@@ -985,8 +985,8 @@ declare class Catalog {
985
985
  * @param {import("../PlatformAPIClient").Options} - Options
986
986
  * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
987
987
  * @name updateSizeGuide
988
- * @summary: Update a size guide
989
- * @description: Allows to edit a size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSizeGuide/).
988
+ * @summary: Update size guide
989
+ * @description: Allows to edit a specific size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSizeGuide/).
990
990
  */
991
991
  updateSizeGuide({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
992
992
  /**
@@ -996,7 +996,7 @@ declare class Catalog {
996
996
  * @returns {Promise<CatalogPlatformModel.BulkResponse>} - Success response
997
997
  * @name uploadBulkProducts
998
998
  * @summary: Upload bulk products
999
- * @description: Helps to create a bulk products upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/uploadBulkProducts/).
999
+ * @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/).
1000
1000
  */
1001
1001
  uploadBulkProducts({ department, productType, body, requestHeaders }?: CatalogPlatformValidator.UploadBulkProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponse>;
1002
1002
  /**
@@ -1007,7 +1007,7 @@ declare class Catalog {
1007
1007
  * Success response
1008
1008
  * @name validateProductTemplate
1009
1009
  * @summary: Validate product template
1010
- * @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/).
1010
+ * @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/).
1011
1011
  */
1012
1012
  validateProductTemplate({ slug, itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesValidationResponse>;
1013
1013
  /**
@@ -1020,7 +1020,7 @@ declare class Catalog {
1020
1020
  * Success response
1021
1021
  * @name validateProductTemplateSchema
1022
1022
  * @summary: Validate product template schema
1023
- * @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/).
1023
+ * @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/).
1024
1024
  */
1025
1025
  validateProductTemplateSchema({ itemType, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryValidationResponse>;
1026
1026
  }