@gofynd/fdk-client-javascript 3.16.3 → 3.17.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/ApplicationClient.d.ts +0 -2
  4. package/sdk/application/ApplicationClient.js +0 -2
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +40 -0
  6. package/sdk/application/Cart/CartApplicationClient.js +176 -0
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +18 -4
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +47 -4
  9. package/sdk/application/Content/ContentApplicationClient.d.ts +21 -1
  10. package/sdk/application/Content/ContentApplicationClient.js +93 -2
  11. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +11 -21
  12. package/sdk/application/Logistic/LogisticApplicationClient.js +34 -83
  13. package/sdk/application/Order/OrderApplicationClient.d.ts +11 -0
  14. package/sdk/application/Order/OrderApplicationClient.js +50 -0
  15. package/sdk/application/Payment/PaymentApplicationClient.d.ts +5 -5
  16. package/sdk/application/Payment/PaymentApplicationClient.js +5 -4
  17. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +84 -0
  18. package/sdk/partner/Logistics/LogisticsPartnerClient.js +712 -0
  19. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +237 -1
  20. package/sdk/partner/Logistics/LogisticsPartnerModel.js +157 -0
  21. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +8 -0
  22. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +70 -0
  23. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +74 -12
  24. package/sdk/platform/Cart/CartPlatformApplicationClient.js +637 -36
  25. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +225 -1
  26. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +147 -0
  27. package/sdk/platform/Cart/CartPlatformModel.d.ts +952 -5
  28. package/sdk/platform/Cart/CartPlatformModel.js +598 -2
  29. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +125 -5
  30. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +831 -41
  31. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +205 -7
  32. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +154 -3
  33. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +5 -16
  34. package/sdk/platform/Catalog/CatalogPlatformClient.js +8 -85
  35. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1025 -159
  36. package/sdk/platform/Catalog/CatalogPlatformModel.js +840 -165
  37. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +8 -10
  38. package/sdk/platform/Catalog/CatalogPlatformValidator.js +3 -12
  39. package/sdk/platform/Common/CommonPlatformModel.d.ts +18 -1
  40. package/sdk/platform/Common/CommonPlatformModel.js +14 -0
  41. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +1 -73
  42. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +4 -462
  43. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +7 -45
  44. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +4 -55
  45. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +10 -2
  46. package/sdk/platform/Communication/CommunicationPlatformModel.js +3 -2
  47. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +14 -0
  48. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +6 -0
  49. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +92 -1
  50. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +54 -0
  51. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +21 -0
  52. package/sdk/platform/Discount/DiscountPlatformModel.js +9 -0
  53. package/sdk/platform/Order/OrderPlatformClient.d.ts +27 -19
  54. package/sdk/platform/Order/OrderPlatformClient.js +176 -108
  55. package/sdk/platform/Order/OrderPlatformModel.d.ts +359 -45
  56. package/sdk/platform/Order/OrderPlatformModel.js +218 -44
  57. package/sdk/platform/Order/OrderPlatformValidator.d.ts +40 -43
  58. package/sdk/platform/Order/OrderPlatformValidator.js +35 -30
  59. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +14 -3
  60. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +88 -6
  61. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +28 -3
  62. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +22 -2
  63. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +376 -11
  64. package/sdk/platform/Payment/PaymentPlatformModel.js +243 -10
  65. package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
  66. package/sdk/platform/PlatformApplicationClient.js +0 -4
  67. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +0 -13
  68. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +0 -82
  69. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -10
  70. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +0 -12
  71. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +212 -28
  72. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +133 -13
  73. package/sdk/platform/User/UserPlatformModel.d.ts +2 -2
  74. package/sdk/platform/User/UserPlatformModel.js +4 -4
  75. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +29 -0
  76. package/sdk/platform/Webhook/WebhookPlatformModel.js +13 -0
  77. package/sdk/platform/index.d.ts +0 -1
  78. package/sdk/platform/index.js +0 -2
  79. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +27 -1
  80. package/sdk/public/Configuration/ConfigurationPublicModel.js +19 -0
  81. package/sdk/public/Webhook/WebhookPublicModel.d.ts +29 -0
  82. package/sdk/public/Webhook/WebhookPublicModel.js +13 -0
  83. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
  84. package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
  85. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
  86. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
  87. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
  88. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
  89. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -387
  90. package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -410
@@ -9,6 +9,10 @@ export = CatalogPlatformModel;
9
9
  * @typedef ValidationErrors
10
10
  * @property {ValidationError[]} errors - A list of validation errors in the request.
11
11
  */
12
+ /**
13
+ * @typedef StandardError
14
+ * @property {string} message - A brief description of the error.
15
+ */
12
16
  /**
13
17
  * @typedef AllSizes
14
18
  * @property {ValidateIdentifier[]} [identifiers] - A collection of identifiers
@@ -106,6 +110,125 @@ export = CatalogPlatformModel;
106
110
  * @property {string} [name] - Name of the application.
107
111
  * @property {number} priority - Defines the priority level for this
108
112
  * configuration, with 1 being the highest.
113
+ * @property {SortWeights} [weights]
114
+ * @property {CohortSortingConfiguration} [cohorts]
115
+ */
116
+ /**
117
+ * @typedef SortWeights
118
+ * @property {number} [popularity] - Controls how strongly overall product
119
+ * popularity influences ranking. Products with higher engagement and demand
120
+ * are ranked higher.
121
+ * @property {number} [availability] - Controls the importance of product
122
+ * availability and fulfilment readiness in ranking. Products that are more
123
+ * consistently available are prioritized over low-stock or unreliable items.
124
+ * @property {number} [conversion] - Controls the effectiveness of product
125
+ * conversion rates in ranking. Products that convert views into purchases
126
+ * more efficiently are ranked higher.
127
+ * @property {number} [sold_quantity] - Reflects historical sales volume of a
128
+ * product. Products with higher sales volumes are ranked higher.
129
+ * @property {number} [depth] - Measures size or variant depth of a product.
130
+ * Products with more size options and inventory depth are ranked higher.
131
+ * @property {number} [listing] - Represents recency or freshness of the product
132
+ * listing. Products that are recently listed or have fresh inventory are
133
+ * ranked higher.
134
+ * @property {number} [discount] - Indicates the promotional value of a product.
135
+ * Products with higher discounts or promotions are ranked higher.
136
+ * @property {number} [cancelled] - Reflects historical cancellation reliability
137
+ * of a product or seller. Products with lower cancellation rates are ranked higher.
138
+ * @property {number} [returns] - Measures post-purchase return behavior.
139
+ * Products with lower return rates are ranked higher.
140
+ * @property {number} [catalogue] - Represents quality and completeness of
141
+ * catalog content. Products with more complete and high-quality content are
142
+ * ranked higher.
143
+ * @property {number} [revenue] - Represents revenue contribution potential of a
144
+ * product. Products that generate higher revenue are ranked higher.
145
+ */
146
+ /**
147
+ * @typedef CohortWeights
148
+ * @property {SortWeights} weights
149
+ */
150
+ /**
151
+ * @typedef HighSpenderRepeatCustomerWeights
152
+ * @property {SortWeights} weights
153
+ */
154
+ /**
155
+ * @typedef HyperactiveRepeatCustomerWeights
156
+ * @property {SortWeights} weights
157
+ */
158
+ /**
159
+ * @typedef HighSpenderOccasionalCustomerWeights
160
+ * @property {SortWeights} weights
161
+ */
162
+ /**
163
+ * @typedef StandardOccasionalCustomerWeights
164
+ * @property {SortWeights} weights
165
+ */
166
+ /**
167
+ * @typedef DormantPremiumCustomerWeights
168
+ * @property {SortWeights} weights
169
+ */
170
+ /**
171
+ * @typedef BudgetRegularCustomerWeights
172
+ * @property {SortWeights} weights
173
+ */
174
+ /**
175
+ * @typedef HighSpenderRegularCustomerWeights
176
+ * @property {SortWeights} weights
177
+ */
178
+ /**
179
+ * @typedef StandardCustomerAboutToChurnWeights
180
+ * @property {SortWeights} weights
181
+ */
182
+ /**
183
+ * @typedef PremiumCustomerAboutToChurnWeights
184
+ * @property {SortWeights} weights
185
+ */
186
+ /**
187
+ * @typedef HighSpenderCustomerAboutToChurnWeights
188
+ * @property {SortWeights} weights
189
+ */
190
+ /**
191
+ * @typedef StandardDormantCustomerWeights
192
+ * @property {SortWeights} weights
193
+ */
194
+ /**
195
+ * @typedef HighSpenderDormantCustomerWeights
196
+ * @property {SortWeights} weights
197
+ */
198
+ /**
199
+ * @typedef PotentialCustomerWeights
200
+ * @property {SortWeights} weights
201
+ */
202
+ /**
203
+ * @typedef NewCustomerWeights
204
+ * @property {SortWeights} weights
205
+ */
206
+ /**
207
+ * @typedef BudgetRepeatCustomerWeights
208
+ * @property {SortWeights} weights
209
+ */
210
+ /**
211
+ * @typedef AverageSpenderRepeatCustomerWeights
212
+ * @property {SortWeights} weights
213
+ */
214
+ /**
215
+ * @typedef CohortSortingConfiguration
216
+ * @property {HighSpenderRepeatCustomerWeights} [high_spender_repeat_customer]
217
+ * @property {HyperactiveRepeatCustomerWeights} [hyperactive_premium_repeat_customer]
218
+ * @property {HighSpenderOccasionalCustomerWeights} [high_spender_occasional_customer]
219
+ * @property {StandardOccasionalCustomerWeights} [standard_occasional_customer]
220
+ * @property {DormantPremiumCustomerWeights} [dormant_premium_customer]
221
+ * @property {BudgetRegularCustomerWeights} [budget_regular_customer]
222
+ * @property {HighSpenderRegularCustomerWeights} [high_spender_regular_customer]
223
+ * @property {StandardCustomerAboutToChurnWeights} [standard_customer_about_to_churn]
224
+ * @property {PremiumCustomerAboutToChurnWeights} [premium_customer_about_to_churn]
225
+ * @property {HighSpenderCustomerAboutToChurnWeights} [high_spender_customer_about_to_churn]
226
+ * @property {StandardDormantCustomerWeights} [standard_dormant_customer]
227
+ * @property {HighSpenderDormantCustomerWeights} [high_spender_dormant_customer]
228
+ * @property {PotentialCustomerWeights} [potential_customer]
229
+ * @property {NewCustomerWeights} [new_customer]
230
+ * @property {BudgetRepeatCustomerWeights} [budget_repeat_customer]
231
+ * @property {AverageSpenderRepeatCustomerWeights} [average_spender_repeat_customer]
109
232
  */
110
233
  /**
111
234
  * @typedef ApplicationBrandJson
@@ -373,22 +496,6 @@ export = CatalogPlatformModel;
373
496
  * @property {string} [return_config_level] - Configuration level of return
374
497
  * window category|product|no-return
375
498
  */
376
- /**
377
- * @typedef ArticleAssignment
378
- * @property {string} [level]
379
- * @property {string} [strategy]
380
- */
381
- /**
382
- * @typedef ArticleAssignment1
383
- * @property {string} [level]
384
- * @property {string} [strategy]
385
- */
386
- /**
387
- * @typedef ArticleQuery
388
- * @property {number[]} [ignored_stores]
389
- * @property {number} item_id
390
- * @property {string} size
391
- */
392
499
  /**
393
500
  * @typedef ArticleStoreResponseSchema
394
501
  * @property {string} [name]
@@ -396,24 +503,6 @@ export = CatalogPlatformModel;
396
503
  * @property {string} [store_type]
397
504
  * @property {number} [uid]
398
505
  */
399
- /**
400
- * @typedef AssignStore
401
- * @property {string} app_id
402
- * @property {AssignStoreArticle[]} articles
403
- * @property {string} [channel_identifier]
404
- * @property {string} [channel_type]
405
- * @property {number} [company_id]
406
- * @property {string} pincode
407
- * @property {number[]} [store_ids]
408
- */
409
- /**
410
- * @typedef AssignStoreArticle
411
- * @property {ArticleAssignment} [article_assignment]
412
- * @property {string} [group_id]
413
- * @property {Object} [meta]
414
- * @property {number} [quantity]
415
- * @property {ArticleQuery} [query]
416
- */
417
506
  /**
418
507
  * @typedef AttributeDetailsGroup
419
508
  * @property {string} display_type - The type of display used for the attribute,
@@ -2811,6 +2900,24 @@ export = CatalogPlatformModel;
2811
2900
  * @property {CategoriesResponseSchema[]} [items]
2812
2901
  * @property {Page} [page]
2813
2902
  */
2903
+ /**
2904
+ * @typedef PriceStrategySchema
2905
+ * @property {string} currency - Currency for the pricing strategy
2906
+ * @property {number} adjustment_value - Adjustment value for the pricing strategy
2907
+ * @property {string} adjustment_type - Type of adjustment for the pricing strategy
2908
+ */
2909
+ /**
2910
+ * @typedef PriceFactoryResponseSchema
2911
+ * @property {string} [price_zone_id] - Unique identifier of the price zone
2912
+ * @property {string} [price_factory_id] - Unique identifier of the price factory
2913
+ * @property {string} [modified_by] - User who last modified the price factory
2914
+ * @property {string[]} [currencies] - List of currencies supported by the price factory
2915
+ * @property {string} [name] - Name of the price factory
2916
+ * @property {PriceStrategySchema[]} [price_strategy] - Pricing strategy for the
2917
+ * price factory
2918
+ * @property {boolean} [active] - Whether the price factory is active
2919
+ * @property {string} [created_by] - User who created the price factory
2920
+ */
2814
2921
  /**
2815
2922
  * @typedef Product
2816
2923
  * @property {Object} [_custom_json] - A custom JSON object that can hold any
@@ -3553,8 +3660,7 @@ export = CatalogPlatformModel;
3553
3660
  * taxation purposes. This is required for indian products.
3554
3661
  * @property {string} [hsn_code] - **Deprecated**: Harmonized System
3555
3662
  * Nomenclature (HSN) code for taxation purposes. Please use the `hs_code`
3556
- * field instead.\
3557
- * _Deprecated_*
3663
+ * field instead.
3558
3664
  * @property {string} [id] - Unique identifier of the product in the database.
3559
3665
  * @property {string} [image_nature] - Describes the nature of the product
3560
3666
  * images (e.g., "standard").
@@ -4015,26 +4121,6 @@ export = CatalogPlatformModel;
4015
4121
  * used for categorization or reference.
4016
4122
  * @property {string} [title] - The main title of the size guide.
4017
4123
  */
4018
- /**
4019
- * @typedef StoreAssignResponseSchema
4020
- * @property {string} [_id]
4021
- * @property {ArticleAssignment1} article_assignment
4022
- * @property {number} [company_id]
4023
- * @property {string} [group_id]
4024
- * @property {number} [index]
4025
- * @property {number} item_id
4026
- * @property {Object} [meta]
4027
- * @property {number} [price_effective]
4028
- * @property {number} [price_marked]
4029
- * @property {number} quantity
4030
- * @property {string} [s_city]
4031
- * @property {string} size
4032
- * @property {boolean} status
4033
- * @property {number} [store_id]
4034
- * @property {number} [store_pincode]
4035
- * @property {Object[]} [strategy_wise_listing]
4036
- * @property {string} [uid]
4037
- */
4038
4124
  /**
4039
4125
  * @typedef StoreDetail
4040
4126
  * @property {Object[]} [additional_contacts]
@@ -4068,9 +4154,9 @@ export = CatalogPlatformModel;
4068
4154
  /**
4069
4155
  * @typedef TaxIdentifier
4070
4156
  * @property {string} [tax_rule_id] - The unique identifier of the tax rule.
4071
- * @property {string} [hsn_code] _Deprecated_*
4072
- * @property {string} [hsn_code_id] _Deprecated_*
4073
- * @property {string} [reporting_hsn] _Deprecated_*
4157
+ * @property {string} [hsn_code]
4158
+ * @property {string} [hsn_code_id]
4159
+ * @property {string} [reporting_hsn]
4074
4160
  */
4075
4161
  /**
4076
4162
  * @typedef TaxIdentifierV3
@@ -4446,6 +4532,41 @@ export = CatalogPlatformModel;
4446
4532
  * @typedef TaxReqBodyVersion
4447
4533
  * @property {TaxComponent[]} components - List of tax components with their
4448
4534
  * respective slabs and rates.
4535
+ * @property {string} [applicable_date] - Optional future effective date for the
4536
+ * version. Must be at least one minute ahead of the current time when supplied.
4537
+ * @property {string} [region_type] - Required whenever areas are supplied to
4538
+ * indicate the granularity of the provided regions.
4539
+ * @property {TaxGeoArea} [areas]
4540
+ * @property {number[]} [store_ids] - Store identifiers for store-level taxation.
4541
+ */
4542
+ /**
4543
+ * @typedef TaxGeoArea
4544
+ * @property {string[]} regions - List of region identifiers based on the
4545
+ * selected region_type.
4546
+ * @property {string} country - Country identifier that groups the regions.
4547
+ */
4548
+ /**
4549
+ * @typedef AreaDetails
4550
+ * @property {string} [uid]
4551
+ * @property {string} [display_name]
4552
+ * @property {string} [sub_type]
4553
+ * @property {string[]} [parent_id]
4554
+ */
4555
+ /**
4556
+ * @typedef Country
4557
+ * @property {string} [uid]
4558
+ * @property {string} [display_name]
4559
+ */
4560
+ /**
4561
+ * @typedef Area
4562
+ * @property {AreaDetails[]} regions
4563
+ * @property {Country} country
4564
+ */
4565
+ /**
4566
+ * @typedef RegionReference
4567
+ * @property {string} [name]
4568
+ * @property {string} [slug]
4569
+ * @property {Area[]} [areas]
4449
4570
  */
4450
4571
  /**
4451
4572
  * @typedef CreateTaxRequestBody
@@ -4456,26 +4577,40 @@ export = CatalogPlatformModel;
4456
4577
  * @typedef TaxVersion
4457
4578
  * @property {string} [_id]
4458
4579
  * @property {string} [rule_id] - Tax Rule ID.
4459
- * @property {string} [applicable_date] - It is the date from when this rule
4460
- * will come in effect.
4580
+ * @property {string} [applicable_date] - Scheduled effective date for the
4581
+ * version. Must be at least one minute ahead of current time when provided.
4461
4582
  * @property {string} [created_on]
4462
4583
  * @property {string} [modified_on]
4463
4584
  * @property {number} [company_id] - Company ID.
4464
4585
  * @property {TaxStatusEnum} [status]
4586
+ * @property {string} [region_type] - Present when the version targets a
4587
+ * specific set of regions rather than the default country-level rule.
4588
+ * @property {TaxGeoArea} [areas]
4589
+ * @property {number[]} [store_ids] - Store identifiers for store-level taxation.
4590
+ * @property {TaxVersionScopeEnum} [scope]
4465
4591
  * @property {TaxComponentResponseSchema[]} [components] - List of tax components.
4466
4592
  */
4467
4593
  /**
4468
4594
  * @typedef UpdateTaxVersionRequestBody
4469
4595
  * @property {TaxComponentResponseSchema[]} components - List of tax components.
4470
4596
  * @property {string} applicable_date - It is the date from when this rule will
4471
- * come in effect. It should be atleast one minute in the future from the current time.
4597
+ * come in effect. It should be at least one minute in the future from the
4598
+ * current time.
4599
+ * @property {string} [region_type] - Required when areas are present to denote
4600
+ * the level (city/state/pincode) at which the version applies.
4601
+ * @property {TaxGeoArea} [areas]
4602
+ * @property {number[]} [store_ids] - Store identifiers for store-level taxation.
4472
4603
  */
4473
4604
  /**
4474
4605
  * @typedef CreateTaxVersionRequestBody
4475
4606
  * @property {TaxComponent[]} components - List of tax components.
4476
- * @property {string} applicable_date - It is the date from when this rule will
4477
- * come in effect. It should be atleast one minute in the future from the
4478
- * current time. Date time format YYYY-MM-DDThh:mm:ss±hh:mm.
4607
+ * @property {string} [applicable_date] - Optional scheduled date from when this
4608
+ * rule will come in effect. It should be at least one minute in the future
4609
+ * from the current time. Date time format YYYY-MM-DDThh:mm:ss±hh:mm.
4610
+ * @property {string} [region_type] - Required when areas are present to denote
4611
+ * the level (city/state/pincode) at which the version applies.
4612
+ * @property {TaxGeoArea} [areas]
4613
+ * @property {number[]} [store_ids] - Store identifiers for store-level taxation.
4479
4614
  */
4480
4615
  /**
4481
4616
  * @typedef TaxRule
@@ -4493,12 +4628,19 @@ export = CatalogPlatformModel;
4493
4628
  * @typedef TaxVersionDetail
4494
4629
  * @property {string} _id
4495
4630
  * @property {string} rule_id
4496
- * @property {string} applicable_date
4631
+ * @property {string} applicable_date - It is the date from when this rule comes
4632
+ * in effect. Always present and should be at least one minute in the future
4633
+ * when scheduled.
4497
4634
  * @property {string} created_on
4498
4635
  * @property {string} modified_on
4499
4636
  * @property {number} company_id
4500
4637
  * @property {TaxStatusEnum} [status]
4638
+ * @property {string} [region_code] - Region code for areas sent when adding a
4639
+ * region override.
4640
+ * @property {number[]} [store_ids] - Store identifiers for store-level taxation.
4641
+ * @property {RegionReference} [region]
4501
4642
  * @property {TaxComponent[]} components - List of components.
4643
+ * @property {TaxVersionScopeEnum} [scope]
4502
4644
  * @property {string} version_status - Specifies the type of tax version.
4503
4645
  */
4504
4646
  /**
@@ -4506,11 +4648,6 @@ export = CatalogPlatformModel;
4506
4648
  * @property {TaxRule} [rule]
4507
4649
  * @property {TaxVersion} [versions]
4508
4650
  */
4509
- /**
4510
- * @typedef UpdateTaxVersion
4511
- * @property {TaxComponent[]} components - List of components.
4512
- * @property {string} applicable_date
4513
- */
4514
4651
  /**
4515
4652
  * @typedef UpdateTaxRequestBody
4516
4653
  * @property {TaxStatusEnum} status
@@ -4562,6 +4699,142 @@ export = CatalogPlatformModel;
4562
4699
  * @property {TaxComponentResponseSchema[]} items
4563
4700
  * @property {Page} page
4564
4701
  */
4702
+ /**
4703
+ * @typedef PriceFactoryListItemsSchema
4704
+ * @property {string} [price_factory_id] - Unique identifier for the price factory.
4705
+ * @property {string} [name] - Name of the price factory configuration.
4706
+ * @property {string} [type] - Type of price factory.
4707
+ * @property {string[]} [currencies] - List of currency codes (e.g., INR, USD).
4708
+ * @property {PriceStrategySchema[]} [price_strategy] - List of pricing
4709
+ * strategies to apply for each currency.
4710
+ * @property {string} [price_zone_id] - ID of the price zone.
4711
+ * @property {boolean} [active] - Status of the price factory (active/inactive).
4712
+ * @property {CreatedBy} [modified_by]
4713
+ * @property {CreatedBy} [created_by]
4714
+ * @property {string} [modified_on] - Timestamp of the last modification.
4715
+ */
4716
+ /**
4717
+ * @typedef PriceFactoryListResponseSchema
4718
+ * @property {Page} [page]
4719
+ * @property {PriceFactoryListItemsSchema[]} [data] - List of price factory
4720
+ * configurations.
4721
+ */
4722
+ /**
4723
+ * @typedef CreatePriceFactoryConfigSchema
4724
+ * @property {string} [name] - The name of the price factory configuration.
4725
+ * @property {string} [type] - Defines the type of price factory, either
4726
+ * regional or international.
4727
+ * @property {string[]} [currencies] - List of currency codes applicable for
4728
+ * pricing (e.g., USD, EUR).
4729
+ * @property {PriceStrategySchema[]} [price_strategy] - List of pricing
4730
+ * strategies to apply for each currency.
4731
+ * @property {string} [price_zone_id] - Identifier for the price zone associated
4732
+ * with the price factory.
4733
+ */
4734
+ /**
4735
+ * @typedef UpdatePriceFactoryConfigSchema
4736
+ * @property {string} [name] - The name of the price factory configuration.
4737
+ * @property {string[]} [currencies] - List of currency codes applicable for
4738
+ * pricing (e.g., USD, EUR).
4739
+ * @property {PriceStrategySchema[]} [price_strategy] - List of pricing
4740
+ * strategies to apply for each currency.
4741
+ * @property {string} [price_zone_id] - Identifier for the price zone associated
4742
+ * with the price factory.
4743
+ */
4744
+ /**
4745
+ * @typedef PriceFactoryConfigSchema
4746
+ * @property {string} [name] - The name of the price factory configuration.
4747
+ * @property {string} [type] - Defines the type of price factory, either
4748
+ * regional or international.
4749
+ * @property {string[]} [currencies] - List of currency codes applicable for
4750
+ * pricing (e.g., USD, EUR).
4751
+ * @property {PriceStrategySchema[]} [price_strategy] - List of pricing
4752
+ * strategies to apply for each currency.
4753
+ * @property {string} [price_zone_id] - Identifier for the price zone associated
4754
+ * with the price factory.
4755
+ * @property {CreatedBy} [created_by]
4756
+ * @property {CreatedBy} [modified_by]
4757
+ */
4758
+ /**
4759
+ * @typedef CurrencyPriceSchema
4760
+ * @property {number} marked_price - Original price before any discounts.
4761
+ * @property {number} selling_price - Final price after applying discounts or adjustments.
4762
+ * @property {string} currency - Currency code (e.g., USD, EUR).
4763
+ */
4764
+ /**
4765
+ * @typedef UpsertPriceFactorySizesSchema
4766
+ * @property {string} [size] - The identifier for the product size (e.g., S, M, L, OS).
4767
+ * @property {CurrencyPriceSchema[]} [currency_prices] - The list of currency prices
4768
+ */
4769
+ /**
4770
+ * @typedef UpsertPriceFactoryProductSchema
4771
+ * @property {UpsertPriceFactorySizesSchema[]} [sizes] - List of size-level
4772
+ * pricing configurations.
4773
+ * @property {boolean} [active] - Indicates whether the product configuration is active.
4774
+ */
4775
+ /**
4776
+ * @typedef PriceFactoryCurrencyPriceSchema
4777
+ * @property {boolean} [base_price] - Indicates if this price is the base price.
4778
+ * @property {string} [currency] - Currency code (e.g., INR).
4779
+ * @property {number} [selling_price] - The price at which the item is sold.
4780
+ * @property {number} [marked_price] - The original marked price of the item.
4781
+ */
4782
+ /**
4783
+ * @typedef PriceFactorySizesSchema
4784
+ * @property {string} [price_factory_id] - ID of the price factory entry.
4785
+ * @property {string} [seller_identifier] - Identifier of the seller for the item.
4786
+ * @property {string} [size] - Size of the product (e.g., OS).
4787
+ * @property {string} [price_zone_id] - Price zone identifier for
4788
+ * regional/international pricing.
4789
+ * @property {PriceFactoryCurrencyPriceSchema[]} [currency_prices] - Pricing
4790
+ * information across different currencies.
4791
+ */
4792
+ /**
4793
+ * @typedef PriceFactoryProductResponseSchema
4794
+ * @property {number} [item_id] - Unique identifier for the item in the price
4795
+ * factory response.
4796
+ * @property {string} [item_code] - Code identifying the item.
4797
+ * @property {string} [name] - Name of the item.
4798
+ * @property {boolean} [active] - Indicates if the item is currently active.
4799
+ * @property {string[]} [media] - List of media associated with the item.
4800
+ * @property {PriceFactorySizesSchema[]} [sizes] - List of size and pricing details.
4801
+ */
4802
+ /**
4803
+ * @typedef PriceFactoryProductListResponseSchema
4804
+ * @property {PriceFactoryProductResponseSchema[]} [items] - List of products
4805
+ * details with sizes and prices details.
4806
+ * @property {Page} [page]
4807
+ */
4808
+ /**
4809
+ * @typedef PriceRange
4810
+ * @property {number} [min] - Minimum price.
4811
+ * @property {number} [max] - Maximum price.
4812
+ */
4813
+ /**
4814
+ * @typedef CurrencyPrice
4815
+ * @property {number} [discount] - Discount value applied in percentage.
4816
+ * @property {string} [currency_code] - Currency code (e.g., 'INR', 'EUR').
4817
+ * @property {string} [currency_symbol] - Symbol of the currency.
4818
+ * @property {PriceRange} [marked]
4819
+ * @property {PriceRange} [effective]
4820
+ * @property {PriceRange} [selling]
4821
+ */
4822
+ /**
4823
+ * @typedef ProductPrice
4824
+ * @property {string} [zone_type] - Type of the pricing zone, e.g., 'price' or 'delivery'.
4825
+ * @property {string} [zone_identifier] - Unique identifier for the zone.
4826
+ * @property {CurrencyPrice[]} [currency_prices] - List of prices for different
4827
+ * currencies in this zone.
4828
+ */
4829
+ /**
4830
+ * @typedef AppProductPricesSchema
4831
+ * @property {string} [item_code] - Unique code identifying the item.
4832
+ * @property {number} [brand_uid] - Unique identifier for the brand.
4833
+ * @property {number} [item_id] - Unique identifier for the item.
4834
+ * @property {Object} [discount_meta] - Additional discount metadata.
4835
+ * @property {ProductPrice[]} [product_price] - Pricing information for various
4836
+ * zones and currencies.
4837
+ */
4565
4838
  /**
4566
4839
  * @typedef ActionPage
4567
4840
  * @property {Object} [params] - Parameters that should be considered in path.
@@ -4605,6 +4878,7 @@ export = CatalogPlatformModel;
4605
4878
  * string and length should not exceed 100 characters.
4606
4879
  */
4607
4880
  /** @typedef {"ACTIVE" | "INACTIVE" | "DELETED"} TaxStatusEnum */
4881
+ /** @typedef {"COUNTRY" | "REGION" | "STORE"} TaxVersionScopeEnum */
4608
4882
  /** @typedef {"HS" | "SAC"} HsTypeEnum */
4609
4883
  /**
4610
4884
  * @typedef {| "about-us"
@@ -4661,7 +4935,7 @@ export = CatalogPlatformModel;
4661
4935
  declare class CatalogPlatformModel {
4662
4936
  }
4663
4937
  declare namespace CatalogPlatformModel {
4664
- 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, GetCollectionListingResponseSchema, GetCollectionQueryOptionResponseSchema, GetCompanySchema, ConditionItem, DataItem, ValueTypeItem, SortTypeItem, GetConfigMetadataResponseSchema, GetConfigMetadataValues, GetConfigResponseSchema, ConfigItem, AttributeConfig, GetDepartment, GetInventories, GetInventoriesResponseSchema, GetLocationSchema, GetOptInPlatform, GetProducts, ProductDetails, GetCollectionDetailResponseSchema, CommonResponseSchemaCollection, GetQueryFiltersKeysResponseSchema, GetQueryFiltersResponseSchema, GetCollectionItemsResponseSchemaV2, CollectionItemV2, 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, BundleDetails, 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, ProductConfigurationDownloads, ProductCreateSchemaV3, ProductUpdateSchemaV3, ProductPatchSchemaV3, ProductSizePatch, 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, TaxComponentResponseSchema, TaxComponentName, CreateTaxComponentNameRequestSchema, TaxReqBodyVersion, CreateTaxRequestBody, TaxVersion, UpdateTaxVersionRequestBody, CreateTaxVersionRequestBody, TaxRule, TaxVersionDetail, CreateTax, UpdateTaxVersion, UpdateTaxRequestBody, TaxRuleItem, TaxRules, TaxVersionPastData, TaxRuleVersion, HSCodeItem, HSCodes, GetTaxComponents, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, TaxStatusEnum, HsTypeEnum, PageType };
4938
+ export { Action, ValidationErrors, StandardError, AllSizes, AllowSingleRequestSchema, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponseSchema, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, SortWeights, CohortWeights, HighSpenderRepeatCustomerWeights, HyperactiveRepeatCustomerWeights, HighSpenderOccasionalCustomerWeights, StandardOccasionalCustomerWeights, DormantPremiumCustomerWeights, BudgetRegularCustomerWeights, HighSpenderRegularCustomerWeights, StandardCustomerAboutToChurnWeights, PremiumCustomerAboutToChurnWeights, HighSpenderCustomerAboutToChurnWeights, StandardDormantCustomerWeights, HighSpenderDormantCustomerWeights, PotentialCustomerWeights, NewCustomerWeights, BudgetRepeatCustomerWeights, AverageSpenderRepeatCustomerWeights, CohortSortingConfiguration, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponseSchema, ApplicationItemMOQ, Scores, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductsSchema, ApplicationProductListingResponseSchema, ApplicationStoreJson, AppReturnConfigResponseSchema, ArticleStoreResponseSchema, 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, GetCollectionListingResponseSchema, GetCollectionQueryOptionResponseSchema, GetCompanySchema, ConditionItem, DataItem, ValueTypeItem, SortTypeItem, GetConfigMetadataResponseSchema, GetConfigMetadataValues, GetConfigResponseSchema, ConfigItem, AttributeConfig, GetDepartment, GetInventories, GetInventoriesResponseSchema, GetLocationSchema, GetOptInPlatform, GetProducts, ProductDetails, GetCollectionDetailResponseSchema, CommonResponseSchemaCollection, GetQueryFiltersKeysResponseSchema, GetQueryFiltersResponseSchema, GetCollectionItemsResponseSchemaV2, CollectionItemV2, 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, BundleDetails, 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, PriceStrategySchema, PriceFactoryResponseSchema, Product, ProductAttributesResponseSchema, ProductBrand, ProductBulkAssets, ProductBulkRequestSchema, ProductBulkRequestList, ProductConfigurationDownloads, ProductCreateSchemaV3, ProductUpdateSchemaV3, ProductPatchSchemaV3, ProductSizePatch, 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, 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, TaxComponentResponseSchema, TaxComponentName, CreateTaxComponentNameRequestSchema, TaxReqBodyVersion, TaxGeoArea, AreaDetails, Country, Area, RegionReference, CreateTaxRequestBody, TaxVersion, UpdateTaxVersionRequestBody, CreateTaxVersionRequestBody, TaxRule, TaxVersionDetail, CreateTax, UpdateTaxRequestBody, TaxRuleItem, TaxRules, TaxVersionPastData, TaxRuleVersion, HSCodeItem, HSCodes, GetTaxComponents, PriceFactoryListItemsSchema, PriceFactoryListResponseSchema, CreatePriceFactoryConfigSchema, UpdatePriceFactoryConfigSchema, PriceFactoryConfigSchema, CurrencyPriceSchema, UpsertPriceFactorySizesSchema, UpsertPriceFactoryProductSchema, PriceFactoryCurrencyPriceSchema, PriceFactorySizesSchema, PriceFactoryProductResponseSchema, PriceFactoryProductListResponseSchema, PriceRange, CurrencyPrice, ProductPrice, AppProductPricesSchema, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, TaxStatusEnum, TaxVersionScopeEnum, HsTypeEnum, PageType };
4665
4939
  }
4666
4940
  /** @returns {Action} */
4667
4941
  declare function Action(): Action;
@@ -4681,6 +4955,14 @@ type ValidationErrors = {
4681
4955
  */
4682
4956
  errors: ValidationError[];
4683
4957
  };
4958
+ /** @returns {StandardError} */
4959
+ declare function StandardError(): StandardError;
4960
+ type StandardError = {
4961
+ /**
4962
+ * - A brief description of the error.
4963
+ */
4964
+ message: string;
4965
+ };
4684
4966
  /** @returns {AllSizes} */
4685
4967
  declare function AllSizes(): AllSizes;
4686
4968
  type AllSizes = {
@@ -4873,6 +5155,177 @@ type AppConfigurationsSort = {
4873
5155
  * configuration, with 1 being the highest.
4874
5156
  */
4875
5157
  priority: number;
5158
+ weights?: SortWeights;
5159
+ cohorts?: CohortSortingConfiguration;
5160
+ };
5161
+ /** @returns {SortWeights} */
5162
+ declare function SortWeights(): SortWeights;
5163
+ type SortWeights = {
5164
+ /**
5165
+ * - Controls how strongly overall product
5166
+ * popularity influences ranking. Products with higher engagement and demand
5167
+ * are ranked higher.
5168
+ */
5169
+ popularity?: number;
5170
+ /**
5171
+ * - Controls the importance of product
5172
+ * availability and fulfilment readiness in ranking. Products that are more
5173
+ * consistently available are prioritized over low-stock or unreliable items.
5174
+ */
5175
+ availability?: number;
5176
+ /**
5177
+ * - Controls the effectiveness of product
5178
+ * conversion rates in ranking. Products that convert views into purchases
5179
+ * more efficiently are ranked higher.
5180
+ */
5181
+ conversion?: number;
5182
+ /**
5183
+ * - Reflects historical sales volume of a
5184
+ * product. Products with higher sales volumes are ranked higher.
5185
+ */
5186
+ sold_quantity?: number;
5187
+ /**
5188
+ * - Measures size or variant depth of a product.
5189
+ * Products with more size options and inventory depth are ranked higher.
5190
+ */
5191
+ depth?: number;
5192
+ /**
5193
+ * - Represents recency or freshness of the product
5194
+ * listing. Products that are recently listed or have fresh inventory are
5195
+ * ranked higher.
5196
+ */
5197
+ listing?: number;
5198
+ /**
5199
+ * - Indicates the promotional value of a product.
5200
+ * Products with higher discounts or promotions are ranked higher.
5201
+ */
5202
+ discount?: number;
5203
+ /**
5204
+ * - Reflects historical cancellation reliability
5205
+ * of a product or seller. Products with lower cancellation rates are ranked higher.
5206
+ */
5207
+ cancelled?: number;
5208
+ /**
5209
+ * - Measures post-purchase return behavior.
5210
+ * Products with lower return rates are ranked higher.
5211
+ */
5212
+ returns?: number;
5213
+ /**
5214
+ * - Represents quality and completeness of
5215
+ * catalog content. Products with more complete and high-quality content are
5216
+ * ranked higher.
5217
+ */
5218
+ catalogue?: number;
5219
+ /**
5220
+ * - Represents revenue contribution potential of a
5221
+ * product. Products that generate higher revenue are ranked higher.
5222
+ */
5223
+ revenue?: number;
5224
+ };
5225
+ /** @returns {CohortWeights} */
5226
+ declare function CohortWeights(): CohortWeights;
5227
+ type CohortWeights = {
5228
+ weights: SortWeights;
5229
+ };
5230
+ /** @returns {HighSpenderRepeatCustomerWeights} */
5231
+ declare function HighSpenderRepeatCustomerWeights(): HighSpenderRepeatCustomerWeights;
5232
+ type HighSpenderRepeatCustomerWeights = {
5233
+ weights: SortWeights;
5234
+ };
5235
+ /** @returns {HyperactiveRepeatCustomerWeights} */
5236
+ declare function HyperactiveRepeatCustomerWeights(): HyperactiveRepeatCustomerWeights;
5237
+ type HyperactiveRepeatCustomerWeights = {
5238
+ weights: SortWeights;
5239
+ };
5240
+ /** @returns {HighSpenderOccasionalCustomerWeights} */
5241
+ declare function HighSpenderOccasionalCustomerWeights(): HighSpenderOccasionalCustomerWeights;
5242
+ type HighSpenderOccasionalCustomerWeights = {
5243
+ weights: SortWeights;
5244
+ };
5245
+ /** @returns {StandardOccasionalCustomerWeights} */
5246
+ declare function StandardOccasionalCustomerWeights(): StandardOccasionalCustomerWeights;
5247
+ type StandardOccasionalCustomerWeights = {
5248
+ weights: SortWeights;
5249
+ };
5250
+ /** @returns {DormantPremiumCustomerWeights} */
5251
+ declare function DormantPremiumCustomerWeights(): DormantPremiumCustomerWeights;
5252
+ type DormantPremiumCustomerWeights = {
5253
+ weights: SortWeights;
5254
+ };
5255
+ /** @returns {BudgetRegularCustomerWeights} */
5256
+ declare function BudgetRegularCustomerWeights(): BudgetRegularCustomerWeights;
5257
+ type BudgetRegularCustomerWeights = {
5258
+ weights: SortWeights;
5259
+ };
5260
+ /** @returns {HighSpenderRegularCustomerWeights} */
5261
+ declare function HighSpenderRegularCustomerWeights(): HighSpenderRegularCustomerWeights;
5262
+ type HighSpenderRegularCustomerWeights = {
5263
+ weights: SortWeights;
5264
+ };
5265
+ /** @returns {StandardCustomerAboutToChurnWeights} */
5266
+ declare function StandardCustomerAboutToChurnWeights(): StandardCustomerAboutToChurnWeights;
5267
+ type StandardCustomerAboutToChurnWeights = {
5268
+ weights: SortWeights;
5269
+ };
5270
+ /** @returns {PremiumCustomerAboutToChurnWeights} */
5271
+ declare function PremiumCustomerAboutToChurnWeights(): PremiumCustomerAboutToChurnWeights;
5272
+ type PremiumCustomerAboutToChurnWeights = {
5273
+ weights: SortWeights;
5274
+ };
5275
+ /** @returns {HighSpenderCustomerAboutToChurnWeights} */
5276
+ declare function HighSpenderCustomerAboutToChurnWeights(): HighSpenderCustomerAboutToChurnWeights;
5277
+ type HighSpenderCustomerAboutToChurnWeights = {
5278
+ weights: SortWeights;
5279
+ };
5280
+ /** @returns {StandardDormantCustomerWeights} */
5281
+ declare function StandardDormantCustomerWeights(): StandardDormantCustomerWeights;
5282
+ type StandardDormantCustomerWeights = {
5283
+ weights: SortWeights;
5284
+ };
5285
+ /** @returns {HighSpenderDormantCustomerWeights} */
5286
+ declare function HighSpenderDormantCustomerWeights(): HighSpenderDormantCustomerWeights;
5287
+ type HighSpenderDormantCustomerWeights = {
5288
+ weights: SortWeights;
5289
+ };
5290
+ /** @returns {PotentialCustomerWeights} */
5291
+ declare function PotentialCustomerWeights(): PotentialCustomerWeights;
5292
+ type PotentialCustomerWeights = {
5293
+ weights: SortWeights;
5294
+ };
5295
+ /** @returns {NewCustomerWeights} */
5296
+ declare function NewCustomerWeights(): NewCustomerWeights;
5297
+ type NewCustomerWeights = {
5298
+ weights: SortWeights;
5299
+ };
5300
+ /** @returns {BudgetRepeatCustomerWeights} */
5301
+ declare function BudgetRepeatCustomerWeights(): BudgetRepeatCustomerWeights;
5302
+ type BudgetRepeatCustomerWeights = {
5303
+ weights: SortWeights;
5304
+ };
5305
+ /** @returns {AverageSpenderRepeatCustomerWeights} */
5306
+ declare function AverageSpenderRepeatCustomerWeights(): AverageSpenderRepeatCustomerWeights;
5307
+ type AverageSpenderRepeatCustomerWeights = {
5308
+ weights: SortWeights;
5309
+ };
5310
+ /** @returns {CohortSortingConfiguration} */
5311
+ declare function CohortSortingConfiguration(): CohortSortingConfiguration;
5312
+ type CohortSortingConfiguration = {
5313
+ high_spender_repeat_customer?: HighSpenderRepeatCustomerWeights;
5314
+ hyperactive_premium_repeat_customer?: HyperactiveRepeatCustomerWeights;
5315
+ high_spender_occasional_customer?: HighSpenderOccasionalCustomerWeights;
5316
+ standard_occasional_customer?: StandardOccasionalCustomerWeights;
5317
+ dormant_premium_customer?: DormantPremiumCustomerWeights;
5318
+ budget_regular_customer?: BudgetRegularCustomerWeights;
5319
+ high_spender_regular_customer?: HighSpenderRegularCustomerWeights;
5320
+ standard_customer_about_to_churn?: StandardCustomerAboutToChurnWeights;
5321
+ premium_customer_about_to_churn?: PremiumCustomerAboutToChurnWeights;
5322
+ high_spender_customer_about_to_churn?: HighSpenderCustomerAboutToChurnWeights;
5323
+ standard_dormant_customer?: StandardDormantCustomerWeights;
5324
+ high_spender_dormant_customer?: HighSpenderDormantCustomerWeights;
5325
+ potential_customer?: PotentialCustomerWeights;
5326
+ new_customer?: NewCustomerWeights;
5327
+ budget_repeat_customer?: BudgetRepeatCustomerWeights;
5328
+ average_spender_repeat_customer?: AverageSpenderRepeatCustomerWeights;
4876
5329
  };
4877
5330
  /** @returns {ApplicationBrandJson} */
4878
5331
  declare function ApplicationBrandJson(): ApplicationBrandJson;
@@ -5448,25 +5901,6 @@ type AppReturnConfigResponseSchema = {
5448
5901
  */
5449
5902
  return_config_level?: string;
5450
5903
  };
5451
- /** @returns {ArticleAssignment} */
5452
- declare function ArticleAssignment(): ArticleAssignment;
5453
- type ArticleAssignment = {
5454
- level?: string;
5455
- strategy?: string;
5456
- };
5457
- /** @returns {ArticleAssignment1} */
5458
- declare function ArticleAssignment1(): ArticleAssignment1;
5459
- type ArticleAssignment1 = {
5460
- level?: string;
5461
- strategy?: string;
5462
- };
5463
- /** @returns {ArticleQuery} */
5464
- declare function ArticleQuery(): ArticleQuery;
5465
- type ArticleQuery = {
5466
- ignored_stores?: number[];
5467
- item_id: number;
5468
- size: string;
5469
- };
5470
5904
  /** @returns {ArticleStoreResponseSchema} */
5471
5905
  declare function ArticleStoreResponseSchema(): ArticleStoreResponseSchema;
5472
5906
  type ArticleStoreResponseSchema = {
@@ -5475,26 +5909,6 @@ type ArticleStoreResponseSchema = {
5475
5909
  store_type?: string;
5476
5910
  uid?: number;
5477
5911
  };
5478
- /** @returns {AssignStore} */
5479
- declare function AssignStore(): AssignStore;
5480
- type AssignStore = {
5481
- app_id: string;
5482
- articles: AssignStoreArticle[];
5483
- channel_identifier?: string;
5484
- channel_type?: string;
5485
- company_id?: number;
5486
- pincode: string;
5487
- store_ids?: number[];
5488
- };
5489
- /** @returns {AssignStoreArticle} */
5490
- declare function AssignStoreArticle(): AssignStoreArticle;
5491
- type AssignStoreArticle = {
5492
- article_assignment?: ArticleAssignment;
5493
- group_id?: string;
5494
- meta?: any;
5495
- quantity?: number;
5496
- query?: ArticleQuery;
5497
- };
5498
5912
  /** @returns {AttributeDetailsGroup} */
5499
5913
  declare function AttributeDetailsGroup(): AttributeDetailsGroup;
5500
5914
  type AttributeDetailsGroup = {
@@ -10584,6 +10998,59 @@ type ProdcutTemplateCategoriesResponseSchema = {
10584
10998
  items?: CategoriesResponseSchema[];
10585
10999
  page?: Page;
10586
11000
  };
11001
+ /** @returns {PriceStrategySchema} */
11002
+ declare function PriceStrategySchema(): PriceStrategySchema;
11003
+ type PriceStrategySchema = {
11004
+ /**
11005
+ * - Currency for the pricing strategy
11006
+ */
11007
+ currency: string;
11008
+ /**
11009
+ * - Adjustment value for the pricing strategy
11010
+ */
11011
+ adjustment_value: number;
11012
+ /**
11013
+ * - Type of adjustment for the pricing strategy
11014
+ */
11015
+ adjustment_type: string;
11016
+ };
11017
+ /** @returns {PriceFactoryResponseSchema} */
11018
+ declare function PriceFactoryResponseSchema(): PriceFactoryResponseSchema;
11019
+ type PriceFactoryResponseSchema = {
11020
+ /**
11021
+ * - Unique identifier of the price zone
11022
+ */
11023
+ price_zone_id?: string;
11024
+ /**
11025
+ * - Unique identifier of the price factory
11026
+ */
11027
+ price_factory_id?: string;
11028
+ /**
11029
+ * - User who last modified the price factory
11030
+ */
11031
+ modified_by?: string;
11032
+ /**
11033
+ * - List of currencies supported by the price factory
11034
+ */
11035
+ currencies?: string[];
11036
+ /**
11037
+ * - Name of the price factory
11038
+ */
11039
+ name?: string;
11040
+ /**
11041
+ * - Pricing strategy for the
11042
+ * price factory
11043
+ */
11044
+ price_strategy?: PriceStrategySchema[];
11045
+ /**
11046
+ * - Whether the price factory is active
11047
+ */
11048
+ active?: boolean;
11049
+ /**
11050
+ * - User who created the price factory
11051
+ */
11052
+ created_by?: string;
11053
+ };
10587
11054
  /** @returns {Product} */
10588
11055
  declare function Product(): Product;
10589
11056
  type Product = {
@@ -12485,8 +12952,7 @@ type ProductSchemaV2 = {
12485
12952
  /**
12486
12953
  * - **Deprecated**: Harmonized System
12487
12954
  * Nomenclature (HSN) code for taxation purposes. Please use the `hs_code`
12488
- * field instead.\
12489
- * _Deprecated_*
12955
+ * field instead.
12490
12956
  */
12491
12957
  hsn_code?: string;
12492
12958
  /**
@@ -13440,27 +13906,6 @@ type SizeGuideResponseSchema = {
13440
13906
  */
13441
13907
  title?: string;
13442
13908
  };
13443
- /** @returns {StoreAssignResponseSchema} */
13444
- declare function StoreAssignResponseSchema(): StoreAssignResponseSchema;
13445
- type StoreAssignResponseSchema = {
13446
- _id?: string;
13447
- article_assignment: ArticleAssignment1;
13448
- company_id?: number;
13449
- group_id?: string;
13450
- index?: number;
13451
- item_id: number;
13452
- meta?: any;
13453
- price_effective?: number;
13454
- price_marked?: number;
13455
- quantity: number;
13456
- s_city?: string;
13457
- size: string;
13458
- status: boolean;
13459
- store_id?: number;
13460
- store_pincode?: number;
13461
- strategy_wise_listing?: any[];
13462
- uid?: string;
13463
- };
13464
13909
  /** @returns {StoreDetail} */
13465
13910
  declare function StoreDetail(): StoreDetail;
13466
13911
  type StoreDetail = {
@@ -13511,17 +13956,8 @@ type TaxIdentifier = {
13511
13956
  * - The unique identifier of the tax rule.
13512
13957
  */
13513
13958
  tax_rule_id?: string;
13514
- /**
13515
- * _Deprecated_*
13516
- */
13517
13959
  hsn_code?: string;
13518
- /**
13519
- * _Deprecated_*
13520
- */
13521
13960
  hsn_code_id?: string;
13522
- /**
13523
- * _Deprecated_*
13524
- */
13525
13961
  reporting_hsn?: string;
13526
13962
  };
13527
13963
  /** @returns {TaxIdentifierV3} */
@@ -14248,6 +14684,61 @@ type TaxReqBodyVersion = {
14248
14684
  * respective slabs and rates.
14249
14685
  */
14250
14686
  components: TaxComponent[];
14687
+ /**
14688
+ * - Optional future effective date for the
14689
+ * version. Must be at least one minute ahead of the current time when supplied.
14690
+ */
14691
+ applicable_date?: string;
14692
+ /**
14693
+ * - Required whenever areas are supplied to
14694
+ * indicate the granularity of the provided regions.
14695
+ */
14696
+ region_type?: string;
14697
+ areas?: TaxGeoArea;
14698
+ /**
14699
+ * - Store identifiers for store-level taxation.
14700
+ */
14701
+ store_ids?: number[];
14702
+ };
14703
+ /** @returns {TaxGeoArea} */
14704
+ declare function TaxGeoArea(): TaxGeoArea;
14705
+ type TaxGeoArea = {
14706
+ /**
14707
+ * - List of region identifiers based on the
14708
+ * selected region_type.
14709
+ */
14710
+ regions: string[];
14711
+ /**
14712
+ * - Country identifier that groups the regions.
14713
+ */
14714
+ country: string;
14715
+ };
14716
+ /** @returns {AreaDetails} */
14717
+ declare function AreaDetails(): AreaDetails;
14718
+ type AreaDetails = {
14719
+ uid?: string;
14720
+ display_name?: string;
14721
+ sub_type?: string;
14722
+ parent_id?: string[];
14723
+ };
14724
+ /** @returns {Country} */
14725
+ declare function Country(): Country;
14726
+ type Country = {
14727
+ uid?: string;
14728
+ display_name?: string;
14729
+ };
14730
+ /** @returns {Area} */
14731
+ declare function Area(): Area;
14732
+ type Area = {
14733
+ regions: AreaDetails[];
14734
+ country: Country;
14735
+ };
14736
+ /** @returns {RegionReference} */
14737
+ declare function RegionReference(): RegionReference;
14738
+ type RegionReference = {
14739
+ name?: string;
14740
+ slug?: string;
14741
+ areas?: Area[];
14251
14742
  };
14252
14743
  /** @returns {CreateTaxRequestBody} */
14253
14744
  declare function CreateTaxRequestBody(): CreateTaxRequestBody;
@@ -14267,8 +14758,8 @@ type TaxVersion = {
14267
14758
  */
14268
14759
  rule_id?: string;
14269
14760
  /**
14270
- * - It is the date from when this rule
14271
- * will come in effect.
14761
+ * - Scheduled effective date for the
14762
+ * version. Must be at least one minute ahead of current time when provided.
14272
14763
  */
14273
14764
  applicable_date?: string;
14274
14765
  created_on?: string;
@@ -14278,6 +14769,17 @@ type TaxVersion = {
14278
14769
  */
14279
14770
  company_id?: number;
14280
14771
  status?: TaxStatusEnum;
14772
+ /**
14773
+ * - Present when the version targets a
14774
+ * specific set of regions rather than the default country-level rule.
14775
+ */
14776
+ region_type?: string;
14777
+ areas?: TaxGeoArea;
14778
+ /**
14779
+ * - Store identifiers for store-level taxation.
14780
+ */
14781
+ store_ids?: number[];
14782
+ scope?: TaxVersionScopeEnum;
14281
14783
  /**
14282
14784
  * - List of tax components.
14283
14785
  */
@@ -14292,9 +14794,20 @@ type UpdateTaxVersionRequestBody = {
14292
14794
  components: TaxComponentResponseSchema[];
14293
14795
  /**
14294
14796
  * - It is the date from when this rule will
14295
- * come in effect. It should be atleast one minute in the future from the current time.
14797
+ * come in effect. It should be at least one minute in the future from the
14798
+ * current time.
14296
14799
  */
14297
14800
  applicable_date: string;
14801
+ /**
14802
+ * - Required when areas are present to denote
14803
+ * the level (city/state/pincode) at which the version applies.
14804
+ */
14805
+ region_type?: string;
14806
+ areas?: TaxGeoArea;
14807
+ /**
14808
+ * - Store identifiers for store-level taxation.
14809
+ */
14810
+ store_ids?: number[];
14298
14811
  };
14299
14812
  /** @returns {CreateTaxVersionRequestBody} */
14300
14813
  declare function CreateTaxVersionRequestBody(): CreateTaxVersionRequestBody;
@@ -14304,11 +14817,21 @@ type CreateTaxVersionRequestBody = {
14304
14817
  */
14305
14818
  components: TaxComponent[];
14306
14819
  /**
14307
- * - It is the date from when this rule will
14308
- * come in effect. It should be atleast one minute in the future from the
14309
- * current time. Date time format YYYY-MM-DDThh:mm:ss±hh:mm.
14820
+ * - Optional scheduled date from when this
14821
+ * rule will come in effect. It should be at least one minute in the future
14822
+ * from the current time. Date time format YYYY-MM-DDThh:mm:ss±hh:mm.
14310
14823
  */
14311
- applicable_date: string;
14824
+ applicable_date?: string;
14825
+ /**
14826
+ * - Required when areas are present to denote
14827
+ * the level (city/state/pincode) at which the version applies.
14828
+ */
14829
+ region_type?: string;
14830
+ areas?: TaxGeoArea;
14831
+ /**
14832
+ * - Store identifiers for store-level taxation.
14833
+ */
14834
+ store_ids?: number[];
14312
14835
  };
14313
14836
  /** @returns {TaxRule} */
14314
14837
  declare function TaxRule(): TaxRule;
@@ -14334,15 +14857,31 @@ declare function TaxVersionDetail(): TaxVersionDetail;
14334
14857
  type TaxVersionDetail = {
14335
14858
  _id: string;
14336
14859
  rule_id: string;
14860
+ /**
14861
+ * - It is the date from when this rule comes
14862
+ * in effect. Always present and should be at least one minute in the future
14863
+ * when scheduled.
14864
+ */
14337
14865
  applicable_date: string;
14338
14866
  created_on: string;
14339
14867
  modified_on: string;
14340
14868
  company_id: number;
14341
14869
  status?: TaxStatusEnum;
14870
+ /**
14871
+ * - Region code for areas sent when adding a
14872
+ * region override.
14873
+ */
14874
+ region_code?: string;
14875
+ /**
14876
+ * - Store identifiers for store-level taxation.
14877
+ */
14878
+ store_ids?: number[];
14879
+ region?: RegionReference;
14342
14880
  /**
14343
14881
  * - List of components.
14344
14882
  */
14345
14883
  components: TaxComponent[];
14884
+ scope?: TaxVersionScopeEnum;
14346
14885
  /**
14347
14886
  * - Specifies the type of tax version.
14348
14887
  */
@@ -14354,15 +14893,6 @@ type CreateTax = {
14354
14893
  rule?: TaxRule;
14355
14894
  versions?: TaxVersion;
14356
14895
  };
14357
- /** @returns {UpdateTaxVersion} */
14358
- declare function UpdateTaxVersion(): UpdateTaxVersion;
14359
- type UpdateTaxVersion = {
14360
- /**
14361
- * - List of components.
14362
- */
14363
- components: TaxComponent[];
14364
- applicable_date: string;
14365
- };
14366
14896
  /** @returns {UpdateTaxRequestBody} */
14367
14897
  declare function UpdateTaxRequestBody(): UpdateTaxRequestBody;
14368
14898
  type UpdateTaxRequestBody = {
@@ -14458,6 +14988,335 @@ type GetTaxComponents = {
14458
14988
  items: TaxComponentResponseSchema[];
14459
14989
  page: Page;
14460
14990
  };
14991
+ /** @returns {PriceFactoryListItemsSchema} */
14992
+ declare function PriceFactoryListItemsSchema(): PriceFactoryListItemsSchema;
14993
+ type PriceFactoryListItemsSchema = {
14994
+ /**
14995
+ * - Unique identifier for the price factory.
14996
+ */
14997
+ price_factory_id?: string;
14998
+ /**
14999
+ * - Name of the price factory configuration.
15000
+ */
15001
+ name?: string;
15002
+ /**
15003
+ * - Type of price factory.
15004
+ */
15005
+ type?: string;
15006
+ /**
15007
+ * - List of currency codes (e.g., INR, USD).
15008
+ */
15009
+ currencies?: string[];
15010
+ /**
15011
+ * - List of pricing
15012
+ * strategies to apply for each currency.
15013
+ */
15014
+ price_strategy?: PriceStrategySchema[];
15015
+ /**
15016
+ * - ID of the price zone.
15017
+ */
15018
+ price_zone_id?: string;
15019
+ /**
15020
+ * - Status of the price factory (active/inactive).
15021
+ */
15022
+ active?: boolean;
15023
+ modified_by?: CreatedBy;
15024
+ created_by?: CreatedBy;
15025
+ /**
15026
+ * - Timestamp of the last modification.
15027
+ */
15028
+ modified_on?: string;
15029
+ };
15030
+ /** @returns {PriceFactoryListResponseSchema} */
15031
+ declare function PriceFactoryListResponseSchema(): PriceFactoryListResponseSchema;
15032
+ type PriceFactoryListResponseSchema = {
15033
+ page?: Page;
15034
+ /**
15035
+ * - List of price factory
15036
+ * configurations.
15037
+ */
15038
+ data?: PriceFactoryListItemsSchema[];
15039
+ };
15040
+ /** @returns {CreatePriceFactoryConfigSchema} */
15041
+ declare function CreatePriceFactoryConfigSchema(): CreatePriceFactoryConfigSchema;
15042
+ type CreatePriceFactoryConfigSchema = {
15043
+ /**
15044
+ * - The name of the price factory configuration.
15045
+ */
15046
+ name?: string;
15047
+ /**
15048
+ * - Defines the type of price factory, either
15049
+ * regional or international.
15050
+ */
15051
+ type?: string;
15052
+ /**
15053
+ * - List of currency codes applicable for
15054
+ * pricing (e.g., USD, EUR).
15055
+ */
15056
+ currencies?: string[];
15057
+ /**
15058
+ * - List of pricing
15059
+ * strategies to apply for each currency.
15060
+ */
15061
+ price_strategy?: PriceStrategySchema[];
15062
+ /**
15063
+ * - Identifier for the price zone associated
15064
+ * with the price factory.
15065
+ */
15066
+ price_zone_id?: string;
15067
+ };
15068
+ /** @returns {UpdatePriceFactoryConfigSchema} */
15069
+ declare function UpdatePriceFactoryConfigSchema(): UpdatePriceFactoryConfigSchema;
15070
+ type UpdatePriceFactoryConfigSchema = {
15071
+ /**
15072
+ * - The name of the price factory configuration.
15073
+ */
15074
+ name?: string;
15075
+ /**
15076
+ * - List of currency codes applicable for
15077
+ * pricing (e.g., USD, EUR).
15078
+ */
15079
+ currencies?: string[];
15080
+ /**
15081
+ * - List of pricing
15082
+ * strategies to apply for each currency.
15083
+ */
15084
+ price_strategy?: PriceStrategySchema[];
15085
+ /**
15086
+ * - Identifier for the price zone associated
15087
+ * with the price factory.
15088
+ */
15089
+ price_zone_id?: string;
15090
+ };
15091
+ /** @returns {PriceFactoryConfigSchema} */
15092
+ declare function PriceFactoryConfigSchema(): PriceFactoryConfigSchema;
15093
+ type PriceFactoryConfigSchema = {
15094
+ /**
15095
+ * - The name of the price factory configuration.
15096
+ */
15097
+ name?: string;
15098
+ /**
15099
+ * - Defines the type of price factory, either
15100
+ * regional or international.
15101
+ */
15102
+ type?: string;
15103
+ /**
15104
+ * - List of currency codes applicable for
15105
+ * pricing (e.g., USD, EUR).
15106
+ */
15107
+ currencies?: string[];
15108
+ /**
15109
+ * - List of pricing
15110
+ * strategies to apply for each currency.
15111
+ */
15112
+ price_strategy?: PriceStrategySchema[];
15113
+ /**
15114
+ * - Identifier for the price zone associated
15115
+ * with the price factory.
15116
+ */
15117
+ price_zone_id?: string;
15118
+ created_by?: CreatedBy;
15119
+ modified_by?: CreatedBy;
15120
+ };
15121
+ /** @returns {CurrencyPriceSchema} */
15122
+ declare function CurrencyPriceSchema(): CurrencyPriceSchema;
15123
+ type CurrencyPriceSchema = {
15124
+ /**
15125
+ * - Original price before any discounts.
15126
+ */
15127
+ marked_price: number;
15128
+ /**
15129
+ * - Final price after applying discounts or adjustments.
15130
+ */
15131
+ selling_price: number;
15132
+ /**
15133
+ * - Currency code (e.g., USD, EUR).
15134
+ */
15135
+ currency: string;
15136
+ };
15137
+ /** @returns {UpsertPriceFactorySizesSchema} */
15138
+ declare function UpsertPriceFactorySizesSchema(): UpsertPriceFactorySizesSchema;
15139
+ type UpsertPriceFactorySizesSchema = {
15140
+ /**
15141
+ * - The identifier for the product size (e.g., S, M, L, OS).
15142
+ */
15143
+ size?: string;
15144
+ /**
15145
+ * - The list of currency prices
15146
+ */
15147
+ currency_prices?: CurrencyPriceSchema[];
15148
+ };
15149
+ /** @returns {UpsertPriceFactoryProductSchema} */
15150
+ declare function UpsertPriceFactoryProductSchema(): UpsertPriceFactoryProductSchema;
15151
+ type UpsertPriceFactoryProductSchema = {
15152
+ /**
15153
+ * - List of size-level
15154
+ * pricing configurations.
15155
+ */
15156
+ sizes?: UpsertPriceFactorySizesSchema[];
15157
+ /**
15158
+ * - Indicates whether the product configuration is active.
15159
+ */
15160
+ active?: boolean;
15161
+ };
15162
+ /** @returns {PriceFactoryCurrencyPriceSchema} */
15163
+ declare function PriceFactoryCurrencyPriceSchema(): PriceFactoryCurrencyPriceSchema;
15164
+ type PriceFactoryCurrencyPriceSchema = {
15165
+ /**
15166
+ * - Indicates if this price is the base price.
15167
+ */
15168
+ base_price?: boolean;
15169
+ /**
15170
+ * - Currency code (e.g., INR).
15171
+ */
15172
+ currency?: string;
15173
+ /**
15174
+ * - The price at which the item is sold.
15175
+ */
15176
+ selling_price?: number;
15177
+ /**
15178
+ * - The original marked price of the item.
15179
+ */
15180
+ marked_price?: number;
15181
+ };
15182
+ /** @returns {PriceFactorySizesSchema} */
15183
+ declare function PriceFactorySizesSchema(): PriceFactorySizesSchema;
15184
+ type PriceFactorySizesSchema = {
15185
+ /**
15186
+ * - ID of the price factory entry.
15187
+ */
15188
+ price_factory_id?: string;
15189
+ /**
15190
+ * - Identifier of the seller for the item.
15191
+ */
15192
+ seller_identifier?: string;
15193
+ /**
15194
+ * - Size of the product (e.g., OS).
15195
+ */
15196
+ size?: string;
15197
+ /**
15198
+ * - Price zone identifier for
15199
+ * regional/international pricing.
15200
+ */
15201
+ price_zone_id?: string;
15202
+ /**
15203
+ * - Pricing
15204
+ * information across different currencies.
15205
+ */
15206
+ currency_prices?: PriceFactoryCurrencyPriceSchema[];
15207
+ };
15208
+ /** @returns {PriceFactoryProductResponseSchema} */
15209
+ declare function PriceFactoryProductResponseSchema(): PriceFactoryProductResponseSchema;
15210
+ type PriceFactoryProductResponseSchema = {
15211
+ /**
15212
+ * - Unique identifier for the item in the price
15213
+ * factory response.
15214
+ */
15215
+ item_id?: number;
15216
+ /**
15217
+ * - Code identifying the item.
15218
+ */
15219
+ item_code?: string;
15220
+ /**
15221
+ * - Name of the item.
15222
+ */
15223
+ name?: string;
15224
+ /**
15225
+ * - Indicates if the item is currently active.
15226
+ */
15227
+ active?: boolean;
15228
+ /**
15229
+ * - List of media associated with the item.
15230
+ */
15231
+ media?: string[];
15232
+ /**
15233
+ * - List of size and pricing details.
15234
+ */
15235
+ sizes?: PriceFactorySizesSchema[];
15236
+ };
15237
+ /** @returns {PriceFactoryProductListResponseSchema} */
15238
+ declare function PriceFactoryProductListResponseSchema(): PriceFactoryProductListResponseSchema;
15239
+ type PriceFactoryProductListResponseSchema = {
15240
+ /**
15241
+ * - List of products
15242
+ * details with sizes and prices details.
15243
+ */
15244
+ items?: PriceFactoryProductResponseSchema[];
15245
+ page?: Page;
15246
+ };
15247
+ /** @returns {PriceRange} */
15248
+ declare function PriceRange(): PriceRange;
15249
+ type PriceRange = {
15250
+ /**
15251
+ * - Minimum price.
15252
+ */
15253
+ min?: number;
15254
+ /**
15255
+ * - Maximum price.
15256
+ */
15257
+ max?: number;
15258
+ };
15259
+ /** @returns {CurrencyPrice} */
15260
+ declare function CurrencyPrice(): CurrencyPrice;
15261
+ type CurrencyPrice = {
15262
+ /**
15263
+ * - Discount value applied in percentage.
15264
+ */
15265
+ discount?: number;
15266
+ /**
15267
+ * - Currency code (e.g., 'INR', 'EUR').
15268
+ */
15269
+ currency_code?: string;
15270
+ /**
15271
+ * - Symbol of the currency.
15272
+ */
15273
+ currency_symbol?: string;
15274
+ marked?: PriceRange;
15275
+ effective?: PriceRange;
15276
+ selling?: PriceRange;
15277
+ };
15278
+ /** @returns {ProductPrice} */
15279
+ declare function ProductPrice(): ProductPrice;
15280
+ type ProductPrice = {
15281
+ /**
15282
+ * - Type of the pricing zone, e.g., 'price' or 'delivery'.
15283
+ */
15284
+ zone_type?: string;
15285
+ /**
15286
+ * - Unique identifier for the zone.
15287
+ */
15288
+ zone_identifier?: string;
15289
+ /**
15290
+ * - List of prices for different
15291
+ * currencies in this zone.
15292
+ */
15293
+ currency_prices?: CurrencyPrice[];
15294
+ };
15295
+ /** @returns {AppProductPricesSchema} */
15296
+ declare function AppProductPricesSchema(): AppProductPricesSchema;
15297
+ type AppProductPricesSchema = {
15298
+ /**
15299
+ * - Unique code identifying the item.
15300
+ */
15301
+ item_code?: string;
15302
+ /**
15303
+ * - Unique identifier for the brand.
15304
+ */
15305
+ brand_uid?: number;
15306
+ /**
15307
+ * - Unique identifier for the item.
15308
+ */
15309
+ item_id?: number;
15310
+ /**
15311
+ * - Additional discount metadata.
15312
+ */
15313
+ discount_meta?: any;
15314
+ /**
15315
+ * - Pricing information for various
15316
+ * zones and currencies.
15317
+ */
15318
+ product_price?: ProductPrice[];
15319
+ };
14461
15320
  /** @returns {ActionPage} */
14462
15321
  declare function ActionPage(): ActionPage;
14463
15322
  type ActionPage = {
@@ -14558,6 +15417,13 @@ type CustomMeta = {
14558
15417
  */
14559
15418
  declare function TaxStatusEnum(): TaxStatusEnum;
14560
15419
  type TaxStatusEnum = "ACTIVE" | "INACTIVE" | "DELETED";
15420
+ /**
15421
+ * Enum: TaxVersionScopeEnum Used By: Catalog
15422
+ *
15423
+ * @returns {TaxVersionScopeEnum}
15424
+ */
15425
+ declare function TaxVersionScopeEnum(): TaxVersionScopeEnum;
15426
+ type TaxVersionScopeEnum = "COUNTRY" | "REGION" | "STORE";
14561
15427
  /**
14562
15428
  * Enum: HsTypeEnum Used By: Catalog
14563
15429
  *