@gofynd/fdk-client-javascript 3.6.0 → 3.7.0

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 (26) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Payment/PaymentApplicationClient.d.ts +0 -50
  4. package/sdk/application/Payment/PaymentApplicationClient.js +0 -210
  5. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
  6. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +4 -1
  7. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +5 -0
  8. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -0
  9. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +1 -125
  10. package/sdk/platform/Catalog/CatalogPlatformClient.js +131 -1111
  11. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +228 -1009
  12. package/sdk/platform/Catalog/CatalogPlatformModel.js +102 -681
  13. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +5 -200
  14. package/sdk/platform/Catalog/CatalogPlatformValidator.js +4 -174
  15. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +4 -9
  16. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +4 -4
  17. package/sdk/platform/Order/OrderPlatformModel.d.ts +8 -60
  18. package/sdk/platform/Order/OrderPlatformModel.js +3 -33
  19. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
  20. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
  21. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
  22. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
  23. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +10 -6
  24. package/sdk/platform/Partner/PartnerPlatformModel.js +5 -3
  25. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +10 -0
  26. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -0
@@ -147,11 +147,89 @@ export = CatalogPlatformModel;
147
147
  * @property {number} [maximum] - The maximum quantity allowed for purchase.
148
148
  * @property {number} [minimum] - The minimum quantity required for purchase.
149
149
  */
150
+ /**
151
+ * @typedef Scores
152
+ * @property {number} [popularity] - This score captures how trending and
153
+ * popular a product is for a specific sales channel. It evaluates recent
154
+ * customer interactions such as views, wishlist adds, add-to-carts, and
155
+ * orders, applying time-based decay so newer activity matters more. The
156
+ * blended score is ranked within the channel to reflect relative popularity.
157
+ * A higher score means the product is currently engaging more customers,
158
+ * while a lower score shows limited or declining interest.
159
+ * @property {number} [availability] - This score measures how reliably a
160
+ * product is stocked for a specific sales channel. It compares the product’s
161
+ * current inventory with its highest observed inventory level, adjusted for
162
+ * how inventory is distributed across locations. A higher score means the
163
+ * product is readily available, while a lower score indicates limited stock
164
+ * or frequent stockouts. Products with no meaningful inventory history
165
+ * receive a default low score for interpretation.
166
+ * @property {number} [conversion] - This score measures how effectively a
167
+ * product converts customer interest into actual orders for a specific sales
168
+ * channel. It considers product views, wishlist adds, add-to-carts, and
169
+ * completed orders to calculate a conversion rate. The rate is then ranked
170
+ * within the channel to give a normalized score. A higher score means the
171
+ * product turns interest into purchases more successfully, while a lower
172
+ * score indicates weaker conversion performance.
173
+ * @property {number} [sold_quantity] - This score evaluates how many units of a
174
+ * product have been sold for a specific sales channel, compared to other
175
+ * products in the same channel. It calculates total quantities sold and
176
+ * converts them into a percentile rank. A higher score means the product
177
+ * sells in large volumes, while a lower score signals fewer units sold.
178
+ * Products without transactions are assigned a default low score.
179
+ * @property {number} [depth] - This score evaluates how well a product covers
180
+ * different size options for a specific sales channel within its category,
181
+ * while also factoring in the inventory available for each size. It compares
182
+ * the product’s size variety and stock depth against the maximum observed
183
+ * within that category and channel. A higher score means the product offers a
184
+ * broader and better-stocked size range, while a lower score reflects fewer
185
+ * options or limited inventory depth.
186
+ * @property {number} [discount] - This score reflects the level of discount a
187
+ * product offers for a specific sales channel, relative to others in the
188
+ * channel. It compares the product’s listed price (MRP) to its effective
189
+ * selling price (ESP) and ranks products by discount percentage. It also
190
+ * takes into account Discount Rules. A higher score indicates steeper
191
+ * discounts, while a lower score shows smaller or no discounts. Products
192
+ * without valid price data receive a default low score.
193
+ * @property {number} [revenue] - This score measures how much revenue a product
194
+ * generates for a specific sales channel, relative to other products in that
195
+ * channel. It looks at the total value of items sold and assigns a percentile
196
+ * rank. A higher score indicates the product drives stronger sales revenue,
197
+ * while a lower score means it contributes less revenue compared to peers.
198
+ * Products with no sales activity receive a default low score.
199
+ * @property {number} [cancelled] - This score measures the proportion of orders
200
+ * cancelled by the platform for a specific sales channel. A higher score
201
+ * indicates fewer cancellations, suggesting smoother fulfilment and better
202
+ * operational consistency. A lower score highlights products more prone to
203
+ * cancellations, which may result from inventory mismatches, processing
204
+ * issues, or operational inefficiencies.
205
+ * @property {number} [returns] - This score measures the proportion of orders
206
+ * that were returned for a specific sales channel. It is designed so that a
207
+ * higher score indicates fewer returns relative to total orders, reflecting
208
+ * better product reliability and customer satisfaction. A lower score means
209
+ * the product experiences more returns, which could signal quality issues,
210
+ * mismatched expectations, or customer dissatisfaction.
211
+ * @property {number} [catalogue] - This score evaluates the quality and
212
+ * completeness of a product’s catalogue content for a specific sales channel.
213
+ * It considers the presence of images, videos, and 3D models, along with the
214
+ * length of product descriptions. Balanced image counts, supportive media,
215
+ * and detailed descriptions contribute to a higher score. A higher score
216
+ * means the product is well-presented and informative, while a lower score
217
+ * indicates missing media or insufficient descriptions that may reduce
218
+ * customer confidence.
219
+ * @property {number} [listing] - This score reflects how recently a product was
220
+ * listed for a specific sales channel. It uses the product’s listing date to
221
+ * calculate how many days have passed since it became available, then
222
+ * normalizes this against other products in the same channel. A higher score
223
+ * means the product is relatively new and fresh on the channel, while a lower
224
+ * score indicates it has been listed for a longer time or lacks valid listing
225
+ * information.
226
+ */
150
227
  /**
151
228
  * @typedef ApplicationItemMeta
152
229
  * @property {Object} [_custom_json] - Custom JSON data for the item
153
230
  * @property {MetaFields[]} [_custom_meta] - Custom meta fields for the item
154
231
  * @property {Object} [alt_text] - Alternative text for the item's images
232
+ * @property {Scores} [scores]
155
233
  * @property {boolean} [is_cod] - Whether the item is available for Cash on
156
234
  * Delivery (COD) or not
157
235
  * @property {boolean} [is_gift] - Whether the item is a gift or not
@@ -1276,7 +1354,6 @@ export = CatalogPlatformModel;
1276
1354
  * the product.
1277
1355
  * @property {string} [description] - Detailed description of the product.
1278
1356
  * @property {string[]} [highlights] - List of highlights for the product.
1279
- * @property {string} [hs_code] - HSN code associated with the product for tax purposes.
1280
1357
  * @property {string} [hsn_code] - HSN code associated with the product for tax purposes.
1281
1358
  * @property {string} [id] - Unique identifier of the product.
1282
1359
  * @property {string} [image_nature] - Nature or type of product images.
@@ -1949,7 +2026,6 @@ export = CatalogPlatformModel;
1949
2026
  * @property {string} [created_on] - Date and time when the HSN data was created.
1950
2027
  * @property {string} description - Description of the HSN data.
1951
2028
  * @property {string} hsn_code
1952
- * @property {string} [tax_rule_id] - Unique identifier of the tax rule.
1953
2029
  * @property {string} [hsn_code_id] - Unique identifier of the HSN code.
1954
2030
  * @property {string} [modified_on] - Date and time when the HSN data was last modified.
1955
2031
  * @property {Object} reporting_hsn - HSN code.
@@ -2796,8 +2872,6 @@ export = CatalogPlatformModel;
2796
2872
  * @property {number[]} [departments] - List of department IDs related to the product.
2797
2873
  * @property {string} [description] - Full description of the product.
2798
2874
  * @property {string[]} [highlights] - List of key highlights of the product.
2799
- * @property {string} [hs_code] - HSN (Harmonized System Nomenclature) code for
2800
- * tax classification.
2801
2875
  * @property {string} [hsn_code] - HSN (Harmonized System Nomenclature) code for
2802
2876
  * tax classification.
2803
2877
  * @property {string} [id] - Unique identifier for the product in the system.
@@ -3012,7 +3086,6 @@ export = CatalogPlatformModel;
3012
3086
  * @property {string} slug - URL-friendly identifier for the product.
3013
3087
  * @property {string[]} [tags] - List of tags associated with the product.
3014
3088
  * @property {TaxIdentifier} tax_identifier
3015
- * @property {string} [hs_code] - HS Code for the product.
3016
3089
  * @property {TeaserTag} [teaser_tag]
3017
3090
  * @property {string} template_tag - Template tag for the product, used for
3018
3091
  * classification.
@@ -3078,123 +3151,6 @@ export = CatalogPlatformModel;
3078
3151
  * @property {Object} [variant_media] - Media related to product variants.
3079
3152
  * @property {Object} [variants] - Variants information for the product.
3080
3153
  */
3081
- /**
3082
- * @typedef ProductCreateSchemaV3
3083
- * @property {Object} [_custom_json] - Custom JSON data that can be used for
3084
- * additional product properties.
3085
- * @property {string} [action] - The action to perform wrt to the product (e.g.,
3086
- * upsert, update, delete).
3087
- * @property {Object} [attributes] - Additional attributes related to the product.
3088
- * @property {number} brand_uid - Unique identifier for the product's brand.
3089
- * @property {string} [bulk_job_id] - Job ID associated with bulk operations.
3090
- * @property {string} category_slug - The category to which the product belongs.
3091
- * @property {string} [change_request_id] - Change request identifier for product updates.
3092
- * @property {number} company_id - Unique identifier for the company associated
3093
- * with the product.
3094
- * @property {string} country_of_origin - The country where the product was
3095
- * manufactured or sourced.
3096
- * @property {string} currency - The currency in which the product's price is listed.
3097
- * @property {CustomOrder} [custom_order]
3098
- * @property {number[]} departments - List of department IDs associated with the product.
3099
- * @property {string} [description] - A detailed description of the product.
3100
- * @property {string[]} [highlights] - Product highlights or key features.
3101
- * @property {boolean} [is_active] - Flag to indicate if the product is active.
3102
- * @property {boolean} [is_dependent] - Flag to indicate if the product is
3103
- * dependent on other products.
3104
- * @property {boolean} [is_image_less_product] - Flag to indicate if the product
3105
- * does not have associated images.
3106
- * @property {boolean} [is_set] - Flag to indicate if the product is part of a set.
3107
- * @property {string} item_code - Unique item code or SKU of the product.
3108
- * @property {string} item_type - Type of the product (e.g., standard, set,
3109
- * composite, digital).
3110
- * @property {Media[]} [media] - List of media URLs (images, videos) associated
3111
- * with the product.
3112
- * @property {boolean} [multi_size] - Indicates if the product supports multiple sizes.
3113
- * @property {string} name - The name of the product.
3114
- * @property {NetQuantity} [net_quantity]
3115
- * @property {number} [no_of_boxes] - Number of boxes required to package the product.
3116
- * @property {string[]} [product_group_tag] - Tags to group products together
3117
- * for classification.
3118
- * @property {ProductPublish} [product_publish]
3119
- * @property {string} [requester] - The role requesting the product operation
3120
- * (admin or user).
3121
- * @property {ReturnConfig} return_config
3122
- * @property {string} [short_description] - A short description of the product,
3123
- * up to 50 characters.
3124
- * @property {string} [size_guide] - Identifier for the product's size guide.
3125
- * @property {Object[]} sizes - List of sizes available for the product.
3126
- * @property {string} slug - URL-friendly identifier for the product.
3127
- * @property {string[]} [tags] - List of tags associated with the product.
3128
- * @property {TaxIdentifierV3} tax_identifier
3129
- * @property {TeaserTag} [teaser_tag]
3130
- * @property {string} template_tag - Template tag for the product, used for
3131
- * classification.
3132
- * @property {Trader[]} trader - List of traders associated with the product.
3133
- * @property {Object} [variant_group] - Variant group information for the product.
3134
- * @property {Object} [variant_media] - Media related to product variants.
3135
- * @property {Object} [variants] - Variants information for the product.
3136
- * @property {string} [hs_code] - HS Code for the product. This is required for
3137
- * indian companies.
3138
- */
3139
- /**
3140
- * @typedef ProductUpdateSchemaV3
3141
- * @property {Object} [_custom_json] - Custom JSON data that can be used for
3142
- * additional product properties.
3143
- * @property {string} [action] - The action to perform wrt to the product (e.g.,
3144
- * upsert, update, delete).
3145
- * @property {Object} [attributes] - Additional attributes related to the product.
3146
- * @property {number} brand_uid - Unique identifier for the product's brand.
3147
- * @property {string} [bulk_job_id] - Job ID associated with bulk operations.
3148
- * @property {string} category_slug - The category to which the product belongs.
3149
- * @property {string} [change_request_id] - Change request identifier for product updates.
3150
- * @property {number} company_id - Unique identifier for the company associated
3151
- * with the product.
3152
- * @property {string} country_of_origin - The country where the product was
3153
- * manufactured or sourced.
3154
- * @property {string} currency - The currency in which the product's price is listed.
3155
- * @property {CustomOrder} [custom_order]
3156
- * @property {number[]} departments - List of department IDs associated with the product.
3157
- * @property {string} [description] - A detailed description of the product.
3158
- * @property {string[]} [highlights] - Product highlights or key features.
3159
- * @property {boolean} [is_active] - Flag to indicate if the product is active.
3160
- * @property {boolean} [is_dependent] - Flag to indicate if the product is
3161
- * dependent on other products.
3162
- * @property {boolean} [is_image_less_product] - Flag to indicate if the product
3163
- * does not have associated images.
3164
- * @property {boolean} [is_set] - Flag to indicate if the product is part of a set.
3165
- * @property {string} item_code - Unique item code or SKU of the product.
3166
- * @property {string} item_type - Type of the product (e.g., standard, set,
3167
- * composite, digital).
3168
- * @property {Media[]} [media] - List of media URLs (images, videos) associated
3169
- * with the product.
3170
- * @property {boolean} [multi_size] - Indicates if the product supports multiple sizes.
3171
- * @property {string} name - The name of the product.
3172
- * @property {NetQuantity} [net_quantity]
3173
- * @property {number} [no_of_boxes] - Number of boxes required to package the product.
3174
- * @property {string[]} [product_group_tag] - Tags to group products together
3175
- * for classification.
3176
- * @property {ProductPublish} [product_publish]
3177
- * @property {string} [requester] - The role requesting the product operation
3178
- * (admin or user).
3179
- * @property {ReturnConfig} return_config
3180
- * @property {string} [short_description] - A short description of the product,
3181
- * up to 50 characters.
3182
- * @property {string} [size_guide] - Identifier for the product's size guide.
3183
- * @property {Object[]} sizes - List of sizes available for the product.
3184
- * @property {string} slug - URL-friendly identifier for the product.
3185
- * @property {string[]} [tags] - List of tags associated with the product.
3186
- * @property {TaxIdentifierV3} tax_identifier
3187
- * @property {string} [hs_code] - HS Code for the product. This is required for
3188
- * indian companies.
3189
- * @property {TeaserTag} [teaser_tag]
3190
- * @property {string} template_tag - Template tag for the product, used for
3191
- * classification.
3192
- * @property {Trader[]} trader - List of traders associated with the product.
3193
- * @property {number} [uid] - Unique identifier for the product.
3194
- * @property {Object} [variant_group] - Variant group information for the product.
3195
- * @property {Object} [variant_media] - Media related to product variants.
3196
- * @property {Object} [variants] - Variants information for the product.
3197
- */
3198
3154
  /**
3199
3155
  * @typedef ProductDetail
3200
3156
  * @property {Object} [attributes] - Key-value pairs representing various
@@ -3611,12 +3567,8 @@ export = CatalogPlatformModel;
3611
3567
  * the product.
3612
3568
  * @property {string} [description] - Long description of the product.
3613
3569
  * @property {string[]} [highlights] - Key features or highlights of the product.
3614
- * @property {string} [hs_code] - Harmonized System Nomenclature (HSN) code for
3615
- * taxation purposes. This is required for indian products.
3616
- * @property {string} [hsn_code] - **Deprecated**: Harmonized System
3617
- * Nomenclature (HSN) code for taxation purposes. Please use the `hs_code`
3618
- * field instead.\
3619
- * _Deprecated_*
3570
+ * @property {string} [hsn_code] - Harmonized System Nomenclature (HSN) code for
3571
+ * taxation purposes.
3620
3572
  * @property {string} [id] - Unique identifier of the product in the database.
3621
3573
  * @property {string} [image_nature] - Describes the nature of the product
3622
3574
  * images (e.g., "standard").
@@ -3762,8 +3714,6 @@ export = CatalogPlatformModel;
3762
3714
  /**
3763
3715
  * @typedef ProductTemplateExportFilterRequestSchema
3764
3716
  * @property {string[]} [brands] - The list of the brands that needs to be exported.
3765
- * @property {string[]} [tax_rule_ids] - The list of the tax rule ids that needs
3766
- * to be exported.
3767
3717
  * @property {string[]} catalogue_types - The list of the type of the catalog
3768
3718
  * such as set, standard and composite.
3769
3719
  * @property {string} [from_date] - The modified on date from which the data
@@ -3814,7 +3764,6 @@ export = CatalogPlatformModel;
3814
3764
  * @property {Object} [custom_order]
3815
3765
  * @property {Object} [description]
3816
3766
  * @property {Object} [highlights]
3817
- * @property {Object} [hs_code]
3818
3767
  * @property {Object} [hsn_code]
3819
3768
  * @property {Object} [is_active]
3820
3769
  * @property {Object} [is_dependent]
@@ -4128,14 +4077,9 @@ export = CatalogPlatformModel;
4128
4077
  */
4129
4078
  /**
4130
4079
  * @typedef TaxIdentifier
4131
- * @property {string} [tax_rule_id] - The unique identifier of the tax rule.
4132
- * @property {string} [hsn_code] _Deprecated_*
4133
- * @property {string} [hsn_code_id] _Deprecated_*
4134
- * @property {string} [reporting_hsn] _Deprecated_*
4135
- */
4136
- /**
4137
- * @typedef TaxIdentifierV3
4138
- * @property {string} tax_rule_id - The unique identifier of the tax rule.
4080
+ * @property {string} [hsn_code]
4081
+ * @property {string} [hsn_code_id]
4082
+ * @property {string} [reporting_hsn]
4139
4083
  */
4140
4084
  /**
4141
4085
  * @typedef TaxSlab
@@ -4458,154 +4402,6 @@ export = CatalogPlatformModel;
4458
4402
  * @property {string} [message] - A message indicating the result of the follow
4459
4403
  * or unfollow operation.
4460
4404
  */
4461
- /**
4462
- * @typedef TaxReqBodyRule
4463
- * @property {string} name - Tax rule name
4464
- * @property {string} [description] - Tax rule description
4465
- */
4466
- /**
4467
- * @typedef TaxThreshold
4468
- * @property {number} value - Tax rate is applied to products above or equal to
4469
- * this price.
4470
- * @property {number} rate - Tax rate ranging from 0 to 1.
4471
- */
4472
- /**
4473
- * @typedef TaxComponent
4474
- * @property {string} name - Name of the component.
4475
- * @property {TaxThreshold[]} slabs - List of thresholds.
4476
- */
4477
- /**
4478
- * @typedef TaxComponentRes
4479
- * @property {string} name - Name of the component.
4480
- * @property {string} [description] - Description of the tax component.
4481
- * @property {TaxThreshold[]} slabs - List of thresholds.
4482
- * @property {string} _id - Unique identifier of the tax component. This _id is
4483
- * required for updating any tax component; If _id field is not in "update tax
4484
- * version" request then that component will be created.
4485
- */
4486
- /**
4487
- * @typedef TaxReqBodyVersion
4488
- * @property {TaxComponent[]} components - List of tax components with their
4489
- * respective slabs and rates.
4490
- */
4491
- /**
4492
- * @typedef CreateTaxRequestBody
4493
- * @property {TaxReqBodyRule} rule
4494
- * @property {TaxReqBodyVersion[]} versions - List of tax versions for the tax rule.
4495
- */
4496
- /**
4497
- * @typedef TaxVersion
4498
- * @property {string} [_id]
4499
- * @property {string} [rule_id] - Tax Rule ID.
4500
- * @property {string} [applicable_date] - It is the date from when this rule
4501
- * will come in effect.
4502
- * @property {string} [created_on]
4503
- * @property {string} [modified_on]
4504
- * @property {number} [company_id] - Company ID.
4505
- * @property {TaxStatusEnum} [status]
4506
- * @property {TaxComponentRes[]} [components] - List of tax components.
4507
- */
4508
- /**
4509
- * @typedef UpdateTaxVersionRequestBody
4510
- * @property {TaxComponentRes[]} components - List of tax components.
4511
- * @property {string} applicable_date - It is the date from when this rule will
4512
- * come in effect. It should be atleast one minute in the future from the current time.
4513
- */
4514
- /**
4515
- * @typedef CreateTaxVersionRequestBody
4516
- * @property {TaxComponent[]} components - List of tax components.
4517
- * @property {string} applicable_date - It is the date from when this rule will
4518
- * come in effect. It should be atleast one minute in the future from the current time.
4519
- */
4520
- /**
4521
- * @typedef TaxRule
4522
- * @property {string} [_id]
4523
- * @property {string} [name]
4524
- * @property {string} [description] - Description of the tax rule.
4525
- * @property {boolean} [is_default] - Flag to set any tax rule as default, in
4526
- * case any tax rule is inactive on a product then default tax rule gets applied
4527
- * @property {number} [company_id]
4528
- * @property {TaxStatusEnum} [status]
4529
- * @property {string} [created_on]
4530
- * @property {string} [modified_on]
4531
- */
4532
- /**
4533
- * @typedef TaxVersionDetail
4534
- * @property {string} _id
4535
- * @property {string} rule_id
4536
- * @property {string} applicable_date
4537
- * @property {string} created_on
4538
- * @property {string} modified_on
4539
- * @property {number} company_id
4540
- * @property {TaxStatusEnum} [status]
4541
- * @property {TaxComponent[]} components - List of components.
4542
- * @property {string} version_status - Specifies the type of tax version.
4543
- */
4544
- /**
4545
- * @typedef CreateTax
4546
- * @property {TaxRule} [rule]
4547
- * @property {TaxVersion} [versions]
4548
- */
4549
- /**
4550
- * @typedef UpdateTaxVersion
4551
- * @property {TaxComponent[]} components - List of components.
4552
- * @property {string} applicable_date
4553
- */
4554
- /**
4555
- * @typedef UpdateTaxRequestBody
4556
- * @property {TaxStatusEnum} status
4557
- * @property {boolean} is_default - Flag to set any tax rule as default, in case
4558
- * any tax rule is inactive or not available on a product then default tax
4559
- * rule gets applied.
4560
- * @property {string} name - New name of the tax rule.
4561
- */
4562
- /**
4563
- * @typedef TaxRuleItem
4564
- * @property {TaxVersionDetail[]} versions
4565
- * @property {TaxRule} rule
4566
- */
4567
- /**
4568
- * @typedef TaxRules
4569
- * @property {TaxRuleItem[]} items - List of tax rules with their versions.
4570
- * @property {Page} page
4571
- */
4572
- /**
4573
- * @typedef TaxVersionPastData
4574
- * @property {TaxVersion[]} [data]
4575
- * @property {Page} [pagination]
4576
- */
4577
- /**
4578
- * @typedef TaxRuleVersion
4579
- * @property {TaxVersionDetail[]} items - List of tax versions.
4580
- * @property {TaxRule} rule
4581
- * @property {Page} page
4582
- */
4583
- /**
4584
- * @typedef HSCodeItem
4585
- * @property {string} [created_on] - Timestamp of when the HS code was created.
4586
- * @property {string} [modified_on] - Timestamp of when the HS code was last modified.
4587
- * @property {HsTypeEnum} type
4588
- * @property {number} [company_id] - Company ID associated with this HS code.
4589
- * @property {string} [description] - Description of the HS code.
4590
- * @property {string} hs_code - The HS code of the product.
4591
- * @property {string} [_id] - Unique identifier for the HS code entry.
4592
- * @property {string} [country_iso] - ISO 2-digit country code. Will be set by
4593
- * default according to company's country.
4594
- */
4595
- /**
4596
- * @typedef HSCodes
4597
- * @property {HSCodeItem[]} items - Array of HS code responses.
4598
- * @property {Page} page
4599
- */
4600
- /**
4601
- * @typedef CreateTaxComponentName
4602
- * @property {string} name - Name of a tax component
4603
- */
4604
- /**
4605
- * @typedef GetTaxComponents
4606
- * @property {TaxComponentRes[]} items
4607
- * @property {Page} page
4608
- */
4609
4405
  /**
4610
4406
  * @typedef ActionPage
4611
4407
  * @property {Object} [params] - Parameters that should be considered in path.
@@ -4648,8 +4444,6 @@ export = CatalogPlatformModel;
4648
4444
  * @property {string} value - The value of the metadata. Should be a non-empty
4649
4445
  * string and length should not exceed 100 characters.
4650
4446
  */
4651
- /** @typedef {"ACTIVE" | "INACTIVE" | "DELETED"} TaxStatusEnum */
4652
- /** @typedef {"HS" | "SAC"} HsTypeEnum */
4653
4447
  /**
4654
4448
  * @typedef {| "about-us"
4655
4449
  * | "addresses"
@@ -4703,7 +4497,7 @@ export = CatalogPlatformModel;
4703
4497
  declare class CatalogPlatformModel {
4704
4498
  }
4705
4499
  declare namespace CatalogPlatformModel {
4706
- export { Action, ValidationErrors, AllSizes, AllowSingleRequestSchema, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponseSchema, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponseSchema, ApplicationItemMOQ, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductsSchema, ApplicationProductListingResponseSchema, ApplicationStoreJson, AppReturnConfigResponseSchema, ArticleAssignment, ArticleAssignment1, ArticleQuery, ArticleStoreResponseSchema, AssignStore, AssignStoreArticle, AttributeDetailsGroup, AttributeMaster, AttributeMasterDetails, AttributeMasterFilter, AttributeMasterMandatoryDetails, AttributeMasterMeta, AttributeMasterSchema, AttributeSchemaRange, AutoCompleteMedia, AutocompleteAction, AutocompletePageAction, AutocompleteResult, BannerImage, BaseAppCategoryReturnConfig, BaseAppCategoryReturnConfigResponseSchema, Brand, BrandItem, BrandListingResponseSchema, ApplicationBrandListingItemSchema, ApplicationBrandListingSchema, ApplicationCategoryListingSchema, ApplicationCategoryListingItemSchema, BrandMeta, InventoryBrandMeta, BulkAssetResponseSchema, BulkHsnResponseSchema, BulkHsnUpsert, BulkInventoryGet, FailedRecord, BulkInventoryGetItems, BulkMeta, BulkProductJob, BulkJob, BulkProductRequestSchema, BulkResponseSchema, CatalogInsightBrand, CatalogInsightItem, CatalogInsightResponseSchema, CategoriesResponseSchema, Category, CategoryItems, CategoryListingResponseSchema, CategoryMapping, CategoryMappingValues, CategoryResponseSchema, Child, CollectionBadge, CollectionBanner, CollectionCreateResponseSchema, CollectionDetailResponseSchema, CollectionImage, CollectionItem, CollectionItemUpdate, CollectionListingFilter, CollectionListingFilterTag, CollectionListingFilterType, CollectionQuery, CollectionSchedule, CompanyBrandDetail, CompanyMeta, InventoryCompanyMeta, CompanyOptIn, ConfigErrorResponseSchema, ConfigSuccessResponseSchema, ConfigurationBucketPoints, ConfigurationListing, ConfigurationListingFilter, ConfigurationListingFilterConfig, ConfigurationListingFilterValue, ConfigurationListingSort, ConfigurationListingSortConfig, ConfigurationProduct, ConfigurationProductConfig, ConfigurationProductSimilar, ConfigurationProductVariant, ConfigurationProductVariantConfig, CreateAutocompleteKeyword, CreateAutocompleteWordsResponseSchema, CreateCollection, CreateSearchConfigurationRequestSchema, CreateSearchConfigurationResponseSchema, CreateSearchKeyword, CreateUpdateAppReturnConfig, CrossSellingData, CrossSellingResponseSchema, CustomOrder, DateMeta, DefaultKeyRequestSchema, DeleteAppCategoryReturnConfig, DeleteResponseSchema, DeleteSearchConfigurationResponseSchema, Department, DepartmentCategoryTree, DepartmentErrorResponseSchema, DepartmentIdentifier, DepartmentResponseSchema, DepartmentsResponseSchema, DimensionResponseSchema, InventoryDimensionResponseSchema, Document, EntityConfiguration, ErrorResponseSchema, FilerList, RawProduct, RawProductListingResponseSchema, GTIN, AttributeDetail, LatLong, ApplicationLocationAddressSchema, GetAddressSchema, GetAllSizes, GetAppCatalogConfiguration, GetAppCatalogEntityConfiguration, GetAutocompleteWordsData, GetAutocompleteWordsResponseSchema, GetCatalogConfigurationDetailsProduct, GetCatalogConfigurationDetailsSchemaListing, GetCatalogConfigurationMetaData, GetCollectionDetailNest, GetCollectionItemsResponseSchema, GetCollectionListingResponseSchema, GetCollectionQueryOptionResponseSchema, GetCompanySchema, ConditionItem, DataItem, ValueTypeItem, SortTypeItem, GetConfigMetadataResponseSchema, GetConfigMetadataValues, GetConfigResponseSchema, ConfigItem, AttributeConfig, GetDepartment, GetInventories, GetInventoriesResponseSchema, GetLocationSchema, GetOptInPlatform, GetProductBundleCreateResponseSchema, GetProductBundleListingResponseSchema, GetProductBundleResponseSchema, GetProducts, ProductDetails, GetCollectionDetailResponseSchema, CommonResponseSchemaCollection, GetQueryFiltersKeysResponseSchema, GetQueryFiltersResponseSchema, GetCollectionItemsResponseSchemaV2, Page1, CollectionItemSchemaV2, CollectionItemUpdateSchema, CollectionQuerySchemaV2, ProductDetailV2, GetSearchConfigurationResponseSchema, GetSearchWordsData, GetSearchWordsDetailResponseSchema, GetSearchWordsResponseSchema, GlobalValidation, Guide, HSNCodesResponseSchema, HSNData, CreatedBySchema, ModifiedBySchema, HSNDataInsertV2, Hierarchy, HsnCode, HsnCodesListingResponseSchemaV2, HsnCodesObject, HsnUpsert, Image, ImageUrls, InvSize, InventoryBulkRequestSchema, InventoryConfig, InventoryCreateRequestSchema, InventoryExportAdvanceOption, InventoryExportFilter, InventoryExportJob, InventoryExportJobListResponseSchema, InventoryExportQuantityFilter, InventoryExportRequestSchema, InventoryExportResponseSchema, InventoryFailedReason, InventoryJobDetailResponseSchema, InventoryJobFilters, InventoryJobPayload, InventoryPage, AddInventoryRequestPayload, InventoryPayload, InventoryRequestSchema, InventoryRequestSchemaV2, InventoryResponseSchema, InventoryResponseItem, InventoryResponsePaginated, InventorySellerIdentifierResponsePaginated, ApplicationInventorySellerIdentifierResponsePaginated, InventorySellerResponseSchema, ApplicationInventorySellerResponseSchema, InventorySet, InventoryStockResponseSchema, InventoryUpdateResponseSchema, InventoryValidationResponseSchema, InvoiceCredSchema, InvoiceDetailsSchema, ItemQuery, Items, LimitedProductData, SizeGuideItem, ListSizeGuide, LocationDayWiseSchema, LocationIntegrationType, LocationListSchema, LocationManagerSchema, LocationTimingSchema, Logo, MOQData, ManufacturerResponseSchema, InventoryManufacturerResponseSchema, Media, Media1, DepartmentMedia, BrandMedia, Meta, MetaDataListingFilterMetaResponseSchema, MetaDataListingFilterResponseSchema, MetaDataListingResponseSchema, MetaDataListingSortMetaResponseSchema, MetaDataListingSortResponseSchema, MetaFields, NetQuantity, NetQuantityResponseSchema, NextSchedule, LocationPriceRequestSchema, LocationQuantityRequestSchema, LocationPriceQuantitySuccessResponseSchema, OptInPostRequestSchema, OptinCompanyBrandDetailsView, OptinCompanyDetail, OptinCompanyMetrics, OptinStoreDetails, OwnerAppItemResponseSchema, PTErrorResponseSchema, Page, PageResponseSchema, PageResponseType, Price, ProductListingDetailPrice, PriceArticle, PriceMeta, ProdcutTemplateCategoriesResponseSchema, Product, ProductAttributesResponseSchema, ProductBrand, ProductBulkAssets, ProductBulkRequestSchema, ProductBulkRequestList, ProductBundleItem, ProductBundleRequestSchema, ProductBundleUpdateRequestSchema, ProductConfigurationDownloads, ProductUpdateSchemaV2, ProductCreateSchemaV2, ProductCreateSchemaV3, ProductUpdateSchemaV3, ProductDetail, ProductDetailAttribute, ProductDetailGroupedAttribute, ProductDownloadsResponseSchema, CollectionProductFilters, ProductFilters, GetQueryFiltersValuesResponseSchema, ProductFiltersKeysOnly, ProductFiltersKey, ProductQueryFiltersValue, CollectionProductFiltersValue, ProductFiltersValue, CollectionProductListingDetail, ProductCategory, ApplicationCategoryAction, ApplicationCategoryItem, ApplicationProductMedia, ApplicationProductCategoryItem, CategoryPageAction, CategoryQuery, CategoryImage, ProductListingDetail, ActionObject, PageAction, ProductListingPrice, ProductListingResponseSchema, ProductListingResponseV2, ProductPublish, ProductPublished, ProductReturnConfigSchema, ProductReturnConfigBaseSchema, Identifier, SizeDetails, ProductSchemaV2, ProductSize, ProductSizeDeleteDataResponseSchema, ProductSizeDeleteResponseSchema, CollectionProductSortOn, ProductSortOn, ProductTagsViewResponseSchema, CreatedBy, ModifiedBy, ProductTemplate, ProductTemplateDownloadsExport, ProductTemplateExportFilterRequestSchema, ProductTemplateExportResponseSchema, ProductVariants, ProductVariantsResponseSchema, Properties, Quantities, QuantitiesArticle, Quantity, QuantityBase, ReturnConfig, InventoryReturnConfig, ReturnConfig2, ReturnConfigResponseSchema, Sitemap, PageQuery, ApplicationCollectionItemSeoPage, ApplicationCollectionItemSeoAction, ApplicationItemSeoAction, ApplicationItemSeoBreadcrumbs, ApplicationCollectionItemSeoBreadcrumbs, ApplicationItemSeoMetaTagItem, ApplicationItemSeoMetaTags, Metatags, SizePromotionThreshold, SEOData, SearchKeywordResult, SearchableAttribute, SecondLevelChild, SellerPhoneNumber, CollectionSeoDetail, SeoDetail, SetSize, SingleCategoryResponseSchema, SingleProductResponseSchema, Size, SizeDistribution, SizeGuideResponseSchema, StoreAssignResponseSchema, StoreDetail, StoreMeta, SuccessResponseSchema, SuccessResponseObject, TaxIdentifier, TaxIdentifierV3, TaxSlab, TeaserTag, TemplateDetails, TemplateGlobalValidationData, TemplateValidationData, TemplatesResponseSchema, TemplatesGlobalValidationResponseSchema, TemplatesValidationResponseSchema, ThirdLevelChild, Trader, Trader1, TraderResponseSchema, UpdateCollection, UpdateSearchConfigurationRequestSchema, UpdateSearchConfigurationResponseSchema, CreateMarketplaceOptinResponseSchema, UserCommon, UserDetail, UserDetail1, UserInfo, UserSchema, RequestUserSchema, ValidateIdentifier, ValidateProduct, ValidateSizeGuide, VerifiedBy, WeightResponseSchema, InventoryWeightResponseSchema, BulkInventoryJob, Marketplaces, GetAllMarketplaces, UpdateMarketplaceOptinRequestSchema, UpdateMarketplaceOptinResponseSchema, Filters, FollowedProducts, FollowProduct, TaxReqBodyRule, TaxThreshold, TaxComponent, TaxComponentRes, TaxReqBodyVersion, CreateTaxRequestBody, TaxVersion, UpdateTaxVersionRequestBody, CreateTaxVersionRequestBody, TaxRule, TaxVersionDetail, CreateTax, UpdateTaxVersion, UpdateTaxRequestBody, TaxRuleItem, TaxRules, TaxVersionPastData, TaxRuleVersion, HSCodeItem, HSCodes, CreateTaxComponentName, GetTaxComponents, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, TaxStatusEnum, HsTypeEnum, PageType };
4500
+ export { Action, ValidationErrors, AllSizes, AllowSingleRequestSchema, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponseSchema, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponseSchema, ApplicationItemMOQ, Scores, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductsSchema, ApplicationProductListingResponseSchema, ApplicationStoreJson, AppReturnConfigResponseSchema, ArticleAssignment, ArticleAssignment1, ArticleQuery, ArticleStoreResponseSchema, AssignStore, AssignStoreArticle, AttributeDetailsGroup, AttributeMaster, AttributeMasterDetails, AttributeMasterFilter, AttributeMasterMandatoryDetails, AttributeMasterMeta, AttributeMasterSchema, AttributeSchemaRange, AutoCompleteMedia, AutocompleteAction, AutocompletePageAction, AutocompleteResult, BannerImage, BaseAppCategoryReturnConfig, BaseAppCategoryReturnConfigResponseSchema, Brand, BrandItem, BrandListingResponseSchema, ApplicationBrandListingItemSchema, ApplicationBrandListingSchema, ApplicationCategoryListingSchema, ApplicationCategoryListingItemSchema, BrandMeta, InventoryBrandMeta, BulkAssetResponseSchema, BulkHsnResponseSchema, BulkHsnUpsert, BulkInventoryGet, FailedRecord, BulkInventoryGetItems, BulkMeta, BulkProductJob, BulkJob, BulkProductRequestSchema, BulkResponseSchema, CatalogInsightBrand, CatalogInsightItem, CatalogInsightResponseSchema, CategoriesResponseSchema, Category, CategoryItems, CategoryListingResponseSchema, CategoryMapping, CategoryMappingValues, CategoryResponseSchema, Child, CollectionBadge, CollectionBanner, CollectionCreateResponseSchema, CollectionDetailResponseSchema, CollectionImage, CollectionItem, CollectionItemUpdate, CollectionListingFilter, CollectionListingFilterTag, CollectionListingFilterType, CollectionQuery, CollectionSchedule, CompanyBrandDetail, CompanyMeta, InventoryCompanyMeta, CompanyOptIn, ConfigErrorResponseSchema, ConfigSuccessResponseSchema, ConfigurationBucketPoints, ConfigurationListing, ConfigurationListingFilter, ConfigurationListingFilterConfig, ConfigurationListingFilterValue, ConfigurationListingSort, ConfigurationListingSortConfig, ConfigurationProduct, ConfigurationProductConfig, ConfigurationProductSimilar, ConfigurationProductVariant, ConfigurationProductVariantConfig, CreateAutocompleteKeyword, CreateAutocompleteWordsResponseSchema, CreateCollection, CreateSearchConfigurationRequestSchema, CreateSearchConfigurationResponseSchema, CreateSearchKeyword, CreateUpdateAppReturnConfig, CrossSellingData, CrossSellingResponseSchema, CustomOrder, DateMeta, DefaultKeyRequestSchema, DeleteAppCategoryReturnConfig, DeleteResponseSchema, DeleteSearchConfigurationResponseSchema, Department, DepartmentCategoryTree, DepartmentErrorResponseSchema, DepartmentIdentifier, DepartmentResponseSchema, DepartmentsResponseSchema, DimensionResponseSchema, InventoryDimensionResponseSchema, Document, EntityConfiguration, ErrorResponseSchema, FilerList, RawProduct, RawProductListingResponseSchema, GTIN, AttributeDetail, LatLong, ApplicationLocationAddressSchema, GetAddressSchema, GetAllSizes, GetAppCatalogConfiguration, GetAppCatalogEntityConfiguration, GetAutocompleteWordsData, GetAutocompleteWordsResponseSchema, GetCatalogConfigurationDetailsProduct, GetCatalogConfigurationDetailsSchemaListing, GetCatalogConfigurationMetaData, GetCollectionDetailNest, GetCollectionItemsResponseSchema, GetCollectionListingResponseSchema, GetCollectionQueryOptionResponseSchema, GetCompanySchema, ConditionItem, DataItem, ValueTypeItem, SortTypeItem, GetConfigMetadataResponseSchema, GetConfigMetadataValues, GetConfigResponseSchema, ConfigItem, AttributeConfig, GetDepartment, GetInventories, GetInventoriesResponseSchema, GetLocationSchema, GetOptInPlatform, GetProductBundleCreateResponseSchema, GetProductBundleListingResponseSchema, GetProductBundleResponseSchema, GetProducts, ProductDetails, GetCollectionDetailResponseSchema, CommonResponseSchemaCollection, GetQueryFiltersKeysResponseSchema, GetQueryFiltersResponseSchema, GetCollectionItemsResponseSchemaV2, Page1, CollectionItemSchemaV2, CollectionItemUpdateSchema, CollectionQuerySchemaV2, ProductDetailV2, GetSearchConfigurationResponseSchema, GetSearchWordsData, GetSearchWordsDetailResponseSchema, GetSearchWordsResponseSchema, GlobalValidation, Guide, HSNCodesResponseSchema, HSNData, CreatedBySchema, ModifiedBySchema, HSNDataInsertV2, Hierarchy, HsnCode, HsnCodesListingResponseSchemaV2, HsnCodesObject, HsnUpsert, Image, ImageUrls, InvSize, InventoryBulkRequestSchema, InventoryConfig, InventoryCreateRequestSchema, InventoryExportAdvanceOption, InventoryExportFilter, InventoryExportJob, InventoryExportJobListResponseSchema, InventoryExportQuantityFilter, InventoryExportRequestSchema, InventoryExportResponseSchema, InventoryFailedReason, InventoryJobDetailResponseSchema, InventoryJobFilters, InventoryJobPayload, InventoryPage, AddInventoryRequestPayload, InventoryPayload, InventoryRequestSchema, InventoryRequestSchemaV2, InventoryResponseSchema, InventoryResponseItem, InventoryResponsePaginated, InventorySellerIdentifierResponsePaginated, ApplicationInventorySellerIdentifierResponsePaginated, InventorySellerResponseSchema, ApplicationInventorySellerResponseSchema, InventorySet, InventoryStockResponseSchema, InventoryUpdateResponseSchema, InventoryValidationResponseSchema, InvoiceCredSchema, InvoiceDetailsSchema, ItemQuery, Items, LimitedProductData, SizeGuideItem, ListSizeGuide, LocationDayWiseSchema, LocationIntegrationType, LocationListSchema, LocationManagerSchema, LocationTimingSchema, Logo, MOQData, ManufacturerResponseSchema, InventoryManufacturerResponseSchema, Media, Media1, DepartmentMedia, BrandMedia, Meta, MetaDataListingFilterMetaResponseSchema, MetaDataListingFilterResponseSchema, MetaDataListingResponseSchema, MetaDataListingSortMetaResponseSchema, MetaDataListingSortResponseSchema, MetaFields, NetQuantity, NetQuantityResponseSchema, NextSchedule, LocationPriceRequestSchema, LocationQuantityRequestSchema, LocationPriceQuantitySuccessResponseSchema, OptInPostRequestSchema, OptinCompanyBrandDetailsView, OptinCompanyDetail, OptinCompanyMetrics, OptinStoreDetails, OwnerAppItemResponseSchema, PTErrorResponseSchema, Page, PageResponseSchema, PageResponseType, Price, ProductListingDetailPrice, PriceArticle, PriceMeta, ProdcutTemplateCategoriesResponseSchema, Product, ProductAttributesResponseSchema, ProductBrand, ProductBulkAssets, ProductBulkRequestSchema, ProductBulkRequestList, ProductBundleItem, ProductBundleRequestSchema, ProductBundleUpdateRequestSchema, ProductConfigurationDownloads, ProductUpdateSchemaV2, ProductCreateSchemaV2, ProductDetail, ProductDetailAttribute, ProductDetailGroupedAttribute, ProductDownloadsResponseSchema, CollectionProductFilters, ProductFilters, GetQueryFiltersValuesResponseSchema, ProductFiltersKeysOnly, ProductFiltersKey, ProductQueryFiltersValue, CollectionProductFiltersValue, ProductFiltersValue, CollectionProductListingDetail, ProductCategory, ApplicationCategoryAction, ApplicationCategoryItem, ApplicationProductMedia, ApplicationProductCategoryItem, CategoryPageAction, CategoryQuery, CategoryImage, ProductListingDetail, ActionObject, PageAction, ProductListingPrice, ProductListingResponseSchema, ProductListingResponseV2, ProductPublish, ProductPublished, ProductReturnConfigSchema, ProductReturnConfigBaseSchema, Identifier, SizeDetails, ProductSchemaV2, ProductSize, ProductSizeDeleteDataResponseSchema, ProductSizeDeleteResponseSchema, CollectionProductSortOn, ProductSortOn, ProductTagsViewResponseSchema, CreatedBy, ModifiedBy, ProductTemplate, ProductTemplateDownloadsExport, ProductTemplateExportFilterRequestSchema, ProductTemplateExportResponseSchema, ProductVariants, ProductVariantsResponseSchema, Properties, Quantities, QuantitiesArticle, Quantity, QuantityBase, ReturnConfig, InventoryReturnConfig, ReturnConfig2, ReturnConfigResponseSchema, Sitemap, PageQuery, ApplicationCollectionItemSeoPage, ApplicationCollectionItemSeoAction, ApplicationItemSeoAction, ApplicationItemSeoBreadcrumbs, ApplicationCollectionItemSeoBreadcrumbs, ApplicationItemSeoMetaTagItem, ApplicationItemSeoMetaTags, Metatags, SizePromotionThreshold, SEOData, SearchKeywordResult, SearchableAttribute, SecondLevelChild, SellerPhoneNumber, CollectionSeoDetail, SeoDetail, SetSize, SingleCategoryResponseSchema, SingleProductResponseSchema, Size, SizeDistribution, SizeGuideResponseSchema, StoreAssignResponseSchema, StoreDetail, StoreMeta, SuccessResponseSchema, SuccessResponseObject, TaxIdentifier, TaxSlab, TeaserTag, TemplateDetails, TemplateGlobalValidationData, TemplateValidationData, TemplatesResponseSchema, TemplatesGlobalValidationResponseSchema, TemplatesValidationResponseSchema, ThirdLevelChild, Trader, Trader1, TraderResponseSchema, UpdateCollection, UpdateSearchConfigurationRequestSchema, UpdateSearchConfigurationResponseSchema, CreateMarketplaceOptinResponseSchema, UserCommon, UserDetail, UserDetail1, UserInfo, UserSchema, RequestUserSchema, ValidateIdentifier, ValidateProduct, ValidateSizeGuide, VerifiedBy, WeightResponseSchema, InventoryWeightResponseSchema, BulkInventoryJob, Marketplaces, GetAllMarketplaces, UpdateMarketplaceOptinRequestSchema, UpdateMarketplaceOptinResponseSchema, Filters, FollowedProducts, FollowProduct, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, PageType };
4707
4501
  }
4708
4502
  /** @returns {Action} */
4709
4503
  declare function Action(): Action;
@@ -4998,6 +4792,117 @@ type ApplicationItemMOQ = {
4998
4792
  */
4999
4793
  minimum?: number;
5000
4794
  };
4795
+ /** @returns {Scores} */
4796
+ declare function Scores(): Scores;
4797
+ type Scores = {
4798
+ /**
4799
+ * - This score captures how trending and
4800
+ * popular a product is for a specific sales channel. It evaluates recent
4801
+ * customer interactions such as views, wishlist adds, add-to-carts, and
4802
+ * orders, applying time-based decay so newer activity matters more. The
4803
+ * blended score is ranked within the channel to reflect relative popularity.
4804
+ * A higher score means the product is currently engaging more customers,
4805
+ * while a lower score shows limited or declining interest.
4806
+ */
4807
+ popularity?: number;
4808
+ /**
4809
+ * - This score measures how reliably a
4810
+ * product is stocked for a specific sales channel. It compares the product’s
4811
+ * current inventory with its highest observed inventory level, adjusted for
4812
+ * how inventory is distributed across locations. A higher score means the
4813
+ * product is readily available, while a lower score indicates limited stock
4814
+ * or frequent stockouts. Products with no meaningful inventory history
4815
+ * receive a default low score for interpretation.
4816
+ */
4817
+ availability?: number;
4818
+ /**
4819
+ * - This score measures how effectively a
4820
+ * product converts customer interest into actual orders for a specific sales
4821
+ * channel. It considers product views, wishlist adds, add-to-carts, and
4822
+ * completed orders to calculate a conversion rate. The rate is then ranked
4823
+ * within the channel to give a normalized score. A higher score means the
4824
+ * product turns interest into purchases more successfully, while a lower
4825
+ * score indicates weaker conversion performance.
4826
+ */
4827
+ conversion?: number;
4828
+ /**
4829
+ * - This score evaluates how many units of a
4830
+ * product have been sold for a specific sales channel, compared to other
4831
+ * products in the same channel. It calculates total quantities sold and
4832
+ * converts them into a percentile rank. A higher score means the product
4833
+ * sells in large volumes, while a lower score signals fewer units sold.
4834
+ * Products without transactions are assigned a default low score.
4835
+ */
4836
+ sold_quantity?: number;
4837
+ /**
4838
+ * - This score evaluates how well a product covers
4839
+ * different size options for a specific sales channel within its category,
4840
+ * while also factoring in the inventory available for each size. It compares
4841
+ * the product’s size variety and stock depth against the maximum observed
4842
+ * within that category and channel. A higher score means the product offers a
4843
+ * broader and better-stocked size range, while a lower score reflects fewer
4844
+ * options or limited inventory depth.
4845
+ */
4846
+ depth?: number;
4847
+ /**
4848
+ * - This score reflects the level of discount a
4849
+ * product offers for a specific sales channel, relative to others in the
4850
+ * channel. It compares the product’s listed price (MRP) to its effective
4851
+ * selling price (ESP) and ranks products by discount percentage. It also
4852
+ * takes into account Discount Rules. A higher score indicates steeper
4853
+ * discounts, while a lower score shows smaller or no discounts. Products
4854
+ * without valid price data receive a default low score.
4855
+ */
4856
+ discount?: number;
4857
+ /**
4858
+ * - This score measures how much revenue a product
4859
+ * generates for a specific sales channel, relative to other products in that
4860
+ * channel. It looks at the total value of items sold and assigns a percentile
4861
+ * rank. A higher score indicates the product drives stronger sales revenue,
4862
+ * while a lower score means it contributes less revenue compared to peers.
4863
+ * Products with no sales activity receive a default low score.
4864
+ */
4865
+ revenue?: number;
4866
+ /**
4867
+ * - This score measures the proportion of orders
4868
+ * cancelled by the platform for a specific sales channel. A higher score
4869
+ * indicates fewer cancellations, suggesting smoother fulfilment and better
4870
+ * operational consistency. A lower score highlights products more prone to
4871
+ * cancellations, which may result from inventory mismatches, processing
4872
+ * issues, or operational inefficiencies.
4873
+ */
4874
+ cancelled?: number;
4875
+ /**
4876
+ * - This score measures the proportion of orders
4877
+ * that were returned for a specific sales channel. It is designed so that a
4878
+ * higher score indicates fewer returns relative to total orders, reflecting
4879
+ * better product reliability and customer satisfaction. A lower score means
4880
+ * the product experiences more returns, which could signal quality issues,
4881
+ * mismatched expectations, or customer dissatisfaction.
4882
+ */
4883
+ returns?: number;
4884
+ /**
4885
+ * - This score evaluates the quality and
4886
+ * completeness of a product’s catalogue content for a specific sales channel.
4887
+ * It considers the presence of images, videos, and 3D models, along with the
4888
+ * length of product descriptions. Balanced image counts, supportive media,
4889
+ * and detailed descriptions contribute to a higher score. A higher score
4890
+ * means the product is well-presented and informative, while a lower score
4891
+ * indicates missing media or insufficient descriptions that may reduce
4892
+ * customer confidence.
4893
+ */
4894
+ catalogue?: number;
4895
+ /**
4896
+ * - This score reflects how recently a product was
4897
+ * listed for a specific sales channel. It uses the product’s listing date to
4898
+ * calculate how many days have passed since it became available, then
4899
+ * normalizes this against other products in the same channel. A higher score
4900
+ * means the product is relatively new and fresh on the channel, while a lower
4901
+ * score indicates it has been listed for a longer time or lacks valid listing
4902
+ * information.
4903
+ */
4904
+ listing?: number;
4905
+ };
5001
4906
  /** @returns {ApplicationItemMeta} */
5002
4907
  declare function ApplicationItemMeta(): ApplicationItemMeta;
5003
4908
  type ApplicationItemMeta = {
@@ -5013,6 +4918,7 @@ type ApplicationItemMeta = {
5013
4918
  * - Alternative text for the item's images
5014
4919
  */
5015
4920
  alt_text?: any;
4921
+ scores?: Scores;
5016
4922
  /**
5017
4923
  * - Whether the item is available for Cash on
5018
4924
  * Delivery (COD) or not
@@ -7285,10 +7191,6 @@ type RawProduct = {
7285
7191
  * - List of highlights for the product.
7286
7192
  */
7287
7193
  highlights?: string[];
7288
- /**
7289
- * - HSN code associated with the product for tax purposes.
7290
- */
7291
- hs_code?: string;
7292
7194
  /**
7293
7195
  * - HSN code associated with the product for tax purposes.
7294
7196
  */
@@ -8767,10 +8669,6 @@ type HSNDataInsertV2 = {
8767
8669
  */
8768
8670
  description: string;
8769
8671
  hsn_code: string;
8770
- /**
8771
- * - Unique identifier of the tax rule.
8772
- */
8773
- tax_rule_id?: string;
8774
8672
  /**
8775
8673
  * - Unique identifier of the HSN code.
8776
8674
  */
@@ -10685,11 +10583,6 @@ type Product = {
10685
10583
  * - List of key highlights of the product.
10686
10584
  */
10687
10585
  highlights?: string[];
10688
- /**
10689
- * - HSN (Harmonized System Nomenclature) code for
10690
- * tax classification.
10691
- */
10692
- hs_code?: string;
10693
10586
  /**
10694
10587
  * - HSN (Harmonized System Nomenclature) code for
10695
10588
  * tax classification.
@@ -11196,10 +11089,6 @@ type ProductUpdateSchemaV2 = {
11196
11089
  */
11197
11090
  tags?: string[];
11198
11091
  tax_identifier: TaxIdentifier;
11199
- /**
11200
- * - HS Code for the product.
11201
- */
11202
- hs_code?: string;
11203
11092
  teaser_tag?: TeaserTag;
11204
11093
  /**
11205
11094
  * - Template tag for the product, used for
@@ -11389,398 +11278,60 @@ type ProductCreateSchemaV2 = {
11389
11278
  */
11390
11279
  variants?: any;
11391
11280
  };
11392
- /** @returns {ProductCreateSchemaV3} */
11393
- declare function ProductCreateSchemaV3(): ProductCreateSchemaV3;
11394
- type ProductCreateSchemaV3 = {
11281
+ /** @returns {ProductDetail} */
11282
+ declare function ProductDetail(): ProductDetail;
11283
+ type ProductDetail = {
11395
11284
  /**
11396
- * - Custom JSON data that can be used for
11397
- * additional product properties.
11285
+ * - Key-value pairs representing various
11286
+ * product attributes.
11398
11287
  */
11399
- _custom_json?: any;
11288
+ attributes?: any;
11289
+ brand?: ProductBrand;
11400
11290
  /**
11401
- * - The action to perform wrt to the product (e.g.,
11402
- * upsert, update, delete).
11291
+ * - Detailed description of the product.
11403
11292
  */
11404
- action?: string;
11293
+ description?: string;
11405
11294
  /**
11406
- * - Additional attributes related to the product.
11295
+ * - Grouped
11296
+ * attributes of the product, such as product details and specifications.
11407
11297
  */
11408
- attributes?: any;
11298
+ grouped_attributes?: ProductDetailGroupedAttribute[];
11409
11299
  /**
11410
- * - Unique identifier for the product's brand.
11300
+ * - Indicates whether the product has variants.
11411
11301
  */
11412
- brand_uid: number;
11302
+ has_variant?: boolean;
11413
11303
  /**
11414
- * - Job ID associated with bulk operations.
11304
+ * - Array of highlight features for the product.
11415
11305
  */
11416
- bulk_job_id?: string;
11306
+ highlights?: string[];
11417
11307
  /**
11418
- * - The category to which the product belongs.
11308
+ * - The nature of the product's images.
11419
11309
  */
11420
- category_slug: string;
11310
+ image_nature?: string;
11421
11311
  /**
11422
- * - Change request identifier for product updates.
11312
+ * - Unique item code for the product.
11423
11313
  */
11424
- change_request_id?: string;
11314
+ item_code?: string;
11425
11315
  /**
11426
- * - Unique identifier for the company associated
11427
- * with the product.
11316
+ * - Type of the item.
11428
11317
  */
11429
- company_id: number;
11318
+ item_type?: string;
11430
11319
  /**
11431
- * - The country where the product was
11432
- * manufactured or sourced.
11320
+ * - Array of media objects such as images and
11321
+ * videos for the product.
11433
11322
  */
11434
- country_of_origin: string;
11323
+ medias?: Media[];
11435
11324
  /**
11436
- * - The currency in which the product's price is listed.
11325
+ * - Name of the product.
11437
11326
  */
11438
- currency: string;
11439
- custom_order?: CustomOrder;
11327
+ name?: string;
11440
11328
  /**
11441
- * - List of department IDs associated with the product.
11329
+ * - Date when the product was made
11330
+ * available online.
11442
11331
  */
11443
- departments: number[];
11332
+ product_online_date?: string;
11444
11333
  /**
11445
- * - A detailed description of the product.
11446
- */
11447
- description?: string;
11448
- /**
11449
- * - Product highlights or key features.
11450
- */
11451
- highlights?: string[];
11452
- /**
11453
- * - Flag to indicate if the product is active.
11454
- */
11455
- is_active?: boolean;
11456
- /**
11457
- * - Flag to indicate if the product is
11458
- * dependent on other products.
11459
- */
11460
- is_dependent?: boolean;
11461
- /**
11462
- * - Flag to indicate if the product
11463
- * does not have associated images.
11464
- */
11465
- is_image_less_product?: boolean;
11466
- /**
11467
- * - Flag to indicate if the product is part of a set.
11468
- */
11469
- is_set?: boolean;
11470
- /**
11471
- * - Unique item code or SKU of the product.
11472
- */
11473
- item_code: string;
11474
- /**
11475
- * - Type of the product (e.g., standard, set,
11476
- * composite, digital).
11477
- */
11478
- item_type: string;
11479
- /**
11480
- * - List of media URLs (images, videos) associated
11481
- * with the product.
11482
- */
11483
- media?: Media[];
11484
- /**
11485
- * - Indicates if the product supports multiple sizes.
11486
- */
11487
- multi_size?: boolean;
11488
- /**
11489
- * - The name of the product.
11490
- */
11491
- name: string;
11492
- net_quantity?: NetQuantity;
11493
- /**
11494
- * - Number of boxes required to package the product.
11495
- */
11496
- no_of_boxes?: number;
11497
- /**
11498
- * - Tags to group products together
11499
- * for classification.
11500
- */
11501
- product_group_tag?: string[];
11502
- product_publish?: ProductPublish;
11503
- /**
11504
- * - The role requesting the product operation
11505
- * (admin or user).
11506
- */
11507
- requester?: string;
11508
- return_config: ReturnConfig;
11509
- /**
11510
- * - A short description of the product,
11511
- * up to 50 characters.
11512
- */
11513
- short_description?: string;
11514
- /**
11515
- * - Identifier for the product's size guide.
11516
- */
11517
- size_guide?: string;
11518
- /**
11519
- * - List of sizes available for the product.
11520
- */
11521
- sizes: any[];
11522
- /**
11523
- * - URL-friendly identifier for the product.
11524
- */
11525
- slug: string;
11526
- /**
11527
- * - List of tags associated with the product.
11528
- */
11529
- tags?: string[];
11530
- tax_identifier: TaxIdentifierV3;
11531
- teaser_tag?: TeaserTag;
11532
- /**
11533
- * - Template tag for the product, used for
11534
- * classification.
11535
- */
11536
- template_tag: string;
11537
- /**
11538
- * - List of traders associated with the product.
11539
- */
11540
- trader: Trader[];
11541
- /**
11542
- * - Variant group information for the product.
11543
- */
11544
- variant_group?: any;
11545
- /**
11546
- * - Media related to product variants.
11547
- */
11548
- variant_media?: any;
11549
- /**
11550
- * - Variants information for the product.
11551
- */
11552
- variants?: any;
11553
- /**
11554
- * - HS Code for the product. This is required for
11555
- * indian companies.
11556
- */
11557
- hs_code?: string;
11558
- };
11559
- /** @returns {ProductUpdateSchemaV3} */
11560
- declare function ProductUpdateSchemaV3(): ProductUpdateSchemaV3;
11561
- type ProductUpdateSchemaV3 = {
11562
- /**
11563
- * - Custom JSON data that can be used for
11564
- * additional product properties.
11565
- */
11566
- _custom_json?: any;
11567
- /**
11568
- * - The action to perform wrt to the product (e.g.,
11569
- * upsert, update, delete).
11570
- */
11571
- action?: string;
11572
- /**
11573
- * - Additional attributes related to the product.
11574
- */
11575
- attributes?: any;
11576
- /**
11577
- * - Unique identifier for the product's brand.
11578
- */
11579
- brand_uid: number;
11580
- /**
11581
- * - Job ID associated with bulk operations.
11582
- */
11583
- bulk_job_id?: string;
11584
- /**
11585
- * - The category to which the product belongs.
11586
- */
11587
- category_slug: string;
11588
- /**
11589
- * - Change request identifier for product updates.
11590
- */
11591
- change_request_id?: string;
11592
- /**
11593
- * - Unique identifier for the company associated
11594
- * with the product.
11595
- */
11596
- company_id: number;
11597
- /**
11598
- * - The country where the product was
11599
- * manufactured or sourced.
11600
- */
11601
- country_of_origin: string;
11602
- /**
11603
- * - The currency in which the product's price is listed.
11604
- */
11605
- currency: string;
11606
- custom_order?: CustomOrder;
11607
- /**
11608
- * - List of department IDs associated with the product.
11609
- */
11610
- departments: number[];
11611
- /**
11612
- * - A detailed description of the product.
11613
- */
11614
- description?: string;
11615
- /**
11616
- * - Product highlights or key features.
11617
- */
11618
- highlights?: string[];
11619
- /**
11620
- * - Flag to indicate if the product is active.
11621
- */
11622
- is_active?: boolean;
11623
- /**
11624
- * - Flag to indicate if the product is
11625
- * dependent on other products.
11626
- */
11627
- is_dependent?: boolean;
11628
- /**
11629
- * - Flag to indicate if the product
11630
- * does not have associated images.
11631
- */
11632
- is_image_less_product?: boolean;
11633
- /**
11634
- * - Flag to indicate if the product is part of a set.
11635
- */
11636
- is_set?: boolean;
11637
- /**
11638
- * - Unique item code or SKU of the product.
11639
- */
11640
- item_code: string;
11641
- /**
11642
- * - Type of the product (e.g., standard, set,
11643
- * composite, digital).
11644
- */
11645
- item_type: string;
11646
- /**
11647
- * - List of media URLs (images, videos) associated
11648
- * with the product.
11649
- */
11650
- media?: Media[];
11651
- /**
11652
- * - Indicates if the product supports multiple sizes.
11653
- */
11654
- multi_size?: boolean;
11655
- /**
11656
- * - The name of the product.
11657
- */
11658
- name: string;
11659
- net_quantity?: NetQuantity;
11660
- /**
11661
- * - Number of boxes required to package the product.
11662
- */
11663
- no_of_boxes?: number;
11664
- /**
11665
- * - Tags to group products together
11666
- * for classification.
11667
- */
11668
- product_group_tag?: string[];
11669
- product_publish?: ProductPublish;
11670
- /**
11671
- * - The role requesting the product operation
11672
- * (admin or user).
11673
- */
11674
- requester?: string;
11675
- return_config: ReturnConfig;
11676
- /**
11677
- * - A short description of the product,
11678
- * up to 50 characters.
11679
- */
11680
- short_description?: string;
11681
- /**
11682
- * - Identifier for the product's size guide.
11683
- */
11684
- size_guide?: string;
11685
- /**
11686
- * - List of sizes available for the product.
11687
- */
11688
- sizes: any[];
11689
- /**
11690
- * - URL-friendly identifier for the product.
11691
- */
11692
- slug: string;
11693
- /**
11694
- * - List of tags associated with the product.
11695
- */
11696
- tags?: string[];
11697
- tax_identifier: TaxIdentifierV3;
11698
- /**
11699
- * - HS Code for the product. This is required for
11700
- * indian companies.
11701
- */
11702
- hs_code?: string;
11703
- teaser_tag?: TeaserTag;
11704
- /**
11705
- * - Template tag for the product, used for
11706
- * classification.
11707
- */
11708
- template_tag: string;
11709
- /**
11710
- * - List of traders associated with the product.
11711
- */
11712
- trader: Trader[];
11713
- /**
11714
- * - Unique identifier for the product.
11715
- */
11716
- uid?: number;
11717
- /**
11718
- * - Variant group information for the product.
11719
- */
11720
- variant_group?: any;
11721
- /**
11722
- * - Media related to product variants.
11723
- */
11724
- variant_media?: any;
11725
- /**
11726
- * - Variants information for the product.
11727
- */
11728
- variants?: any;
11729
- };
11730
- /** @returns {ProductDetail} */
11731
- declare function ProductDetail(): ProductDetail;
11732
- type ProductDetail = {
11733
- /**
11734
- * - Key-value pairs representing various
11735
- * product attributes.
11736
- */
11737
- attributes?: any;
11738
- brand?: ProductBrand;
11739
- /**
11740
- * - Detailed description of the product.
11741
- */
11742
- description?: string;
11743
- /**
11744
- * - Grouped
11745
- * attributes of the product, such as product details and specifications.
11746
- */
11747
- grouped_attributes?: ProductDetailGroupedAttribute[];
11748
- /**
11749
- * - Indicates whether the product has variants.
11750
- */
11751
- has_variant?: boolean;
11752
- /**
11753
- * - Array of highlight features for the product.
11754
- */
11755
- highlights?: string[];
11756
- /**
11757
- * - The nature of the product's images.
11758
- */
11759
- image_nature?: string;
11760
- /**
11761
- * - Unique item code for the product.
11762
- */
11763
- item_code?: string;
11764
- /**
11765
- * - Type of the item.
11766
- */
11767
- item_type?: string;
11768
- /**
11769
- * - Array of media objects such as images and
11770
- * videos for the product.
11771
- */
11772
- medias?: Media[];
11773
- /**
11774
- * - Name of the product.
11775
- */
11776
- name?: string;
11777
- /**
11778
- * - Date when the product was made
11779
- * available online.
11780
- */
11781
- product_online_date?: string;
11782
- /**
11783
- * - Promotional metadata associated with the product.
11334
+ * - Promotional metadata associated with the product.
11784
11335
  */
11785
11336
  promo_meta?: any;
11786
11337
  /**
@@ -12806,14 +12357,7 @@ type ProductSchemaV2 = {
12806
12357
  highlights?: string[];
12807
12358
  /**
12808
12359
  * - Harmonized System Nomenclature (HSN) code for
12809
- * taxation purposes. This is required for indian products.
12810
- */
12811
- hs_code?: string;
12812
- /**
12813
- * - **Deprecated**: Harmonized System
12814
- * Nomenclature (HSN) code for taxation purposes. Please use the `hs_code`
12815
- * field instead.\
12816
- * _Deprecated_*
12360
+ * taxation purposes.
12817
12361
  */
12818
12362
  hsn_code?: string;
12819
12363
  /**
@@ -13179,11 +12723,6 @@ type ProductTemplateExportFilterRequestSchema = {
13179
12723
  * - The list of the brands that needs to be exported.
13180
12724
  */
13181
12725
  brands?: string[];
13182
- /**
13183
- * - The list of the tax rule ids that needs
13184
- * to be exported.
13185
- */
13186
- tax_rule_ids?: string[];
13187
12726
  /**
13188
12727
  * - The list of the type of the catalog
13189
12728
  * such as set, standard and composite.
@@ -13298,7 +12837,6 @@ type Properties = {
13298
12837
  custom_order?: any;
13299
12838
  description?: any;
13300
12839
  highlights?: any;
13301
- hs_code?: any;
13302
12840
  hsn_code?: any;
13303
12841
  is_active?: any;
13304
12842
  is_dependent?: any;
@@ -13833,31 +13371,10 @@ type SuccessResponseObject = {
13833
13371
  /** @returns {TaxIdentifier} */
13834
13372
  declare function TaxIdentifier(): TaxIdentifier;
13835
13373
  type TaxIdentifier = {
13836
- /**
13837
- * - The unique identifier of the tax rule.
13838
- */
13839
- tax_rule_id?: string;
13840
- /**
13841
- * _Deprecated_*
13842
- */
13843
13374
  hsn_code?: string;
13844
- /**
13845
- * _Deprecated_*
13846
- */
13847
13375
  hsn_code_id?: string;
13848
- /**
13849
- * _Deprecated_*
13850
- */
13851
13376
  reporting_hsn?: string;
13852
13377
  };
13853
- /** @returns {TaxIdentifierV3} */
13854
- declare function TaxIdentifierV3(): TaxIdentifierV3;
13855
- type TaxIdentifierV3 = {
13856
- /**
13857
- * - The unique identifier of the tax rule.
13858
- */
13859
- tax_rule_id: string;
13860
- };
13861
13378
  /** @returns {TaxSlab} */
13862
13379
  declare function TaxSlab(): TaxSlab;
13863
13380
  type TaxSlab = {
@@ -14461,290 +13978,6 @@ type FollowProduct = {
14461
13978
  */
14462
13979
  message?: string;
14463
13980
  };
14464
- /** @returns {TaxReqBodyRule} */
14465
- declare function TaxReqBodyRule(): TaxReqBodyRule;
14466
- type TaxReqBodyRule = {
14467
- /**
14468
- * - Tax rule name
14469
- */
14470
- name: string;
14471
- /**
14472
- * - Tax rule description
14473
- */
14474
- description?: string;
14475
- };
14476
- /** @returns {TaxThreshold} */
14477
- declare function TaxThreshold(): TaxThreshold;
14478
- type TaxThreshold = {
14479
- /**
14480
- * - Tax rate is applied to products above or equal to
14481
- * this price.
14482
- */
14483
- value: number;
14484
- /**
14485
- * - Tax rate ranging from 0 to 1.
14486
- */
14487
- rate: number;
14488
- };
14489
- /** @returns {TaxComponent} */
14490
- declare function TaxComponent(): TaxComponent;
14491
- type TaxComponent = {
14492
- /**
14493
- * - Name of the component.
14494
- */
14495
- name: string;
14496
- /**
14497
- * - List of thresholds.
14498
- */
14499
- slabs: TaxThreshold[];
14500
- };
14501
- /** @returns {TaxComponentRes} */
14502
- declare function TaxComponentRes(): TaxComponentRes;
14503
- type TaxComponentRes = {
14504
- /**
14505
- * - Name of the component.
14506
- */
14507
- name: string;
14508
- /**
14509
- * - Description of the tax component.
14510
- */
14511
- description?: string;
14512
- /**
14513
- * - List of thresholds.
14514
- */
14515
- slabs: TaxThreshold[];
14516
- /**
14517
- * - Unique identifier of the tax component. This _id is
14518
- * required for updating any tax component; If _id field is not in "update tax
14519
- * version" request then that component will be created.
14520
- */
14521
- _id: string;
14522
- };
14523
- /** @returns {TaxReqBodyVersion} */
14524
- declare function TaxReqBodyVersion(): TaxReqBodyVersion;
14525
- type TaxReqBodyVersion = {
14526
- /**
14527
- * - List of tax components with their
14528
- * respective slabs and rates.
14529
- */
14530
- components: TaxComponent[];
14531
- };
14532
- /** @returns {CreateTaxRequestBody} */
14533
- declare function CreateTaxRequestBody(): CreateTaxRequestBody;
14534
- type CreateTaxRequestBody = {
14535
- rule: TaxReqBodyRule;
14536
- /**
14537
- * - List of tax versions for the tax rule.
14538
- */
14539
- versions: TaxReqBodyVersion[];
14540
- };
14541
- /** @returns {TaxVersion} */
14542
- declare function TaxVersion(): TaxVersion;
14543
- type TaxVersion = {
14544
- _id?: string;
14545
- /**
14546
- * - Tax Rule ID.
14547
- */
14548
- rule_id?: string;
14549
- /**
14550
- * - It is the date from when this rule
14551
- * will come in effect.
14552
- */
14553
- applicable_date?: string;
14554
- created_on?: string;
14555
- modified_on?: string;
14556
- /**
14557
- * - Company ID.
14558
- */
14559
- company_id?: number;
14560
- status?: TaxStatusEnum;
14561
- /**
14562
- * - List of tax components.
14563
- */
14564
- components?: TaxComponentRes[];
14565
- };
14566
- /** @returns {UpdateTaxVersionRequestBody} */
14567
- declare function UpdateTaxVersionRequestBody(): UpdateTaxVersionRequestBody;
14568
- type UpdateTaxVersionRequestBody = {
14569
- /**
14570
- * - List of tax components.
14571
- */
14572
- components: TaxComponentRes[];
14573
- /**
14574
- * - It is the date from when this rule will
14575
- * come in effect. It should be atleast one minute in the future from the current time.
14576
- */
14577
- applicable_date: string;
14578
- };
14579
- /** @returns {CreateTaxVersionRequestBody} */
14580
- declare function CreateTaxVersionRequestBody(): CreateTaxVersionRequestBody;
14581
- type CreateTaxVersionRequestBody = {
14582
- /**
14583
- * - List of tax components.
14584
- */
14585
- components: TaxComponent[];
14586
- /**
14587
- * - It is the date from when this rule will
14588
- * come in effect. It should be atleast one minute in the future from the current time.
14589
- */
14590
- applicable_date: string;
14591
- };
14592
- /** @returns {TaxRule} */
14593
- declare function TaxRule(): TaxRule;
14594
- type TaxRule = {
14595
- _id?: string;
14596
- name?: string;
14597
- /**
14598
- * - Description of the tax rule.
14599
- */
14600
- description?: string;
14601
- /**
14602
- * - Flag to set any tax rule as default, in
14603
- * case any tax rule is inactive on a product then default tax rule gets applied
14604
- */
14605
- is_default?: boolean;
14606
- company_id?: number;
14607
- status?: TaxStatusEnum;
14608
- created_on?: string;
14609
- modified_on?: string;
14610
- };
14611
- /** @returns {TaxVersionDetail} */
14612
- declare function TaxVersionDetail(): TaxVersionDetail;
14613
- type TaxVersionDetail = {
14614
- _id: string;
14615
- rule_id: string;
14616
- applicable_date: string;
14617
- created_on: string;
14618
- modified_on: string;
14619
- company_id: number;
14620
- status?: TaxStatusEnum;
14621
- /**
14622
- * - List of components.
14623
- */
14624
- components: TaxComponent[];
14625
- /**
14626
- * - Specifies the type of tax version.
14627
- */
14628
- version_status: string;
14629
- };
14630
- /** @returns {CreateTax} */
14631
- declare function CreateTax(): CreateTax;
14632
- type CreateTax = {
14633
- rule?: TaxRule;
14634
- versions?: TaxVersion;
14635
- };
14636
- /** @returns {UpdateTaxVersion} */
14637
- declare function UpdateTaxVersion(): UpdateTaxVersion;
14638
- type UpdateTaxVersion = {
14639
- /**
14640
- * - List of components.
14641
- */
14642
- components: TaxComponent[];
14643
- applicable_date: string;
14644
- };
14645
- /** @returns {UpdateTaxRequestBody} */
14646
- declare function UpdateTaxRequestBody(): UpdateTaxRequestBody;
14647
- type UpdateTaxRequestBody = {
14648
- status: TaxStatusEnum;
14649
- /**
14650
- * - Flag to set any tax rule as default, in case
14651
- * any tax rule is inactive or not available on a product then default tax
14652
- * rule gets applied.
14653
- */
14654
- is_default: boolean;
14655
- /**
14656
- * - New name of the tax rule.
14657
- */
14658
- name: string;
14659
- };
14660
- /** @returns {TaxRuleItem} */
14661
- declare function TaxRuleItem(): TaxRuleItem;
14662
- type TaxRuleItem = {
14663
- versions: TaxVersionDetail[];
14664
- rule: TaxRule;
14665
- };
14666
- /** @returns {TaxRules} */
14667
- declare function TaxRules(): TaxRules;
14668
- type TaxRules = {
14669
- /**
14670
- * - List of tax rules with their versions.
14671
- */
14672
- items: TaxRuleItem[];
14673
- page: Page;
14674
- };
14675
- /** @returns {TaxVersionPastData} */
14676
- declare function TaxVersionPastData(): TaxVersionPastData;
14677
- type TaxVersionPastData = {
14678
- data?: TaxVersion[];
14679
- pagination?: Page;
14680
- };
14681
- /** @returns {TaxRuleVersion} */
14682
- declare function TaxRuleVersion(): TaxRuleVersion;
14683
- type TaxRuleVersion = {
14684
- /**
14685
- * - List of tax versions.
14686
- */
14687
- items: TaxVersionDetail[];
14688
- rule: TaxRule;
14689
- page: Page;
14690
- };
14691
- /** @returns {HSCodeItem} */
14692
- declare function HSCodeItem(): HSCodeItem;
14693
- type HSCodeItem = {
14694
- /**
14695
- * - Timestamp of when the HS code was created.
14696
- */
14697
- created_on?: string;
14698
- /**
14699
- * - Timestamp of when the HS code was last modified.
14700
- */
14701
- modified_on?: string;
14702
- type: HsTypeEnum;
14703
- /**
14704
- * - Company ID associated with this HS code.
14705
- */
14706
- company_id?: number;
14707
- /**
14708
- * - Description of the HS code.
14709
- */
14710
- description?: string;
14711
- /**
14712
- * - The HS code of the product.
14713
- */
14714
- hs_code: string;
14715
- /**
14716
- * - Unique identifier for the HS code entry.
14717
- */
14718
- _id?: string;
14719
- /**
14720
- * - ISO 2-digit country code. Will be set by
14721
- * default according to company's country.
14722
- */
14723
- country_iso?: string;
14724
- };
14725
- /** @returns {HSCodes} */
14726
- declare function HSCodes(): HSCodes;
14727
- type HSCodes = {
14728
- /**
14729
- * - Array of HS code responses.
14730
- */
14731
- items: HSCodeItem[];
14732
- page: Page;
14733
- };
14734
- /** @returns {CreateTaxComponentName} */
14735
- declare function CreateTaxComponentName(): CreateTaxComponentName;
14736
- type CreateTaxComponentName = {
14737
- /**
14738
- * - Name of a tax component
14739
- */
14740
- name: string;
14741
- };
14742
- /** @returns {GetTaxComponents} */
14743
- declare function GetTaxComponents(): GetTaxComponents;
14744
- type GetTaxComponents = {
14745
- items: TaxComponentRes[];
14746
- page: Page;
14747
- };
14748
13981
  /** @returns {ActionPage} */
14749
13982
  declare function ActionPage(): ActionPage;
14750
13983
  type ActionPage = {
@@ -14838,20 +14071,6 @@ type CustomMeta = {
14838
14071
  */
14839
14072
  value: string;
14840
14073
  };
14841
- /**
14842
- * Enum: TaxStatusEnum Used By: Catalog
14843
- *
14844
- * @returns {TaxStatusEnum}
14845
- */
14846
- declare function TaxStatusEnum(): TaxStatusEnum;
14847
- type TaxStatusEnum = "ACTIVE" | "INACTIVE" | "DELETED";
14848
- /**
14849
- * Enum: HsTypeEnum Used By: Catalog
14850
- *
14851
- * @returns {HsTypeEnum}
14852
- */
14853
- declare function HsTypeEnum(): HsTypeEnum;
14854
- type HsTypeEnum = "HS" | "SAC";
14855
14074
  /**
14856
14075
  * Enum: PageType Used By: Catalog
14857
14076
  *