@gofynd/fdk-client-javascript 3.6.0 → 3.8.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.
@@ -164,11 +164,90 @@ const Joi = require("joi");
164
164
  * @property {number} [minimum] - The minimum quantity required for purchase.
165
165
  */
166
166
 
167
+ /**
168
+ * @typedef Scores
169
+ * @property {number} [popularity] - This score captures how trending and
170
+ * popular a product is for a specific sales channel. It evaluates recent
171
+ * customer interactions such as views, wishlist adds, add-to-carts, and
172
+ * orders, applying time-based decay so newer activity matters more. The
173
+ * blended score is ranked within the channel to reflect relative popularity.
174
+ * A higher score means the product is currently engaging more customers,
175
+ * while a lower score shows limited or declining interest.
176
+ * @property {number} [availability] - This score measures how reliably a
177
+ * product is stocked for a specific sales channel. It compares the product’s
178
+ * current inventory with its highest observed inventory level, adjusted for
179
+ * how inventory is distributed across locations. A higher score means the
180
+ * product is readily available, while a lower score indicates limited stock
181
+ * or frequent stockouts. Products with no meaningful inventory history
182
+ * receive a default low score for interpretation.
183
+ * @property {number} [conversion] - This score measures how effectively a
184
+ * product converts customer interest into actual orders for a specific sales
185
+ * channel. It considers product views, wishlist adds, add-to-carts, and
186
+ * completed orders to calculate a conversion rate. The rate is then ranked
187
+ * within the channel to give a normalized score. A higher score means the
188
+ * product turns interest into purchases more successfully, while a lower
189
+ * score indicates weaker conversion performance.
190
+ * @property {number} [sold_quantity] - This score evaluates how many units of a
191
+ * product have been sold for a specific sales channel, compared to other
192
+ * products in the same channel. It calculates total quantities sold and
193
+ * converts them into a percentile rank. A higher score means the product
194
+ * sells in large volumes, while a lower score signals fewer units sold.
195
+ * Products without transactions are assigned a default low score.
196
+ * @property {number} [depth] - This score evaluates how well a product covers
197
+ * different size options for a specific sales channel within its category,
198
+ * while also factoring in the inventory available for each size. It compares
199
+ * the product’s size variety and stock depth against the maximum observed
200
+ * within that category and channel. A higher score means the product offers a
201
+ * broader and better-stocked size range, while a lower score reflects fewer
202
+ * options or limited inventory depth.
203
+ * @property {number} [discount] - This score reflects the level of discount a
204
+ * product offers for a specific sales channel, relative to others in the
205
+ * channel. It compares the product’s listed price (MRP) to its effective
206
+ * selling price (ESP) and ranks products by discount percentage. It also
207
+ * takes into account Discount Rules. A higher score indicates steeper
208
+ * discounts, while a lower score shows smaller or no discounts. Products
209
+ * without valid price data receive a default low score.
210
+ * @property {number} [revenue] - This score measures how much revenue a product
211
+ * generates for a specific sales channel, relative to other products in that
212
+ * channel. It looks at the total value of items sold and assigns a percentile
213
+ * rank. A higher score indicates the product drives stronger sales revenue,
214
+ * while a lower score means it contributes less revenue compared to peers.
215
+ * Products with no sales activity receive a default low score.
216
+ * @property {number} [cancelled] - This score measures the proportion of orders
217
+ * cancelled by the platform for a specific sales channel. A higher score
218
+ * indicates fewer cancellations, suggesting smoother fulfilment and better
219
+ * operational consistency. A lower score highlights products more prone to
220
+ * cancellations, which may result from inventory mismatches, processing
221
+ * issues, or operational inefficiencies.
222
+ * @property {number} [returns] - This score measures the proportion of orders
223
+ * that were returned for a specific sales channel. It is designed so that a
224
+ * higher score indicates fewer returns relative to total orders, reflecting
225
+ * better product reliability and customer satisfaction. A lower score means
226
+ * the product experiences more returns, which could signal quality issues,
227
+ * mismatched expectations, or customer dissatisfaction.
228
+ * @property {number} [catalogue] - This score evaluates the quality and
229
+ * completeness of a product’s catalogue content for a specific sales channel.
230
+ * It considers the presence of images, videos, and 3D models, along with the
231
+ * length of product descriptions. Balanced image counts, supportive media,
232
+ * and detailed descriptions contribute to a higher score. A higher score
233
+ * means the product is well-presented and informative, while a lower score
234
+ * indicates missing media or insufficient descriptions that may reduce
235
+ * customer confidence.
236
+ * @property {number} [listing] - This score reflects how recently a product was
237
+ * listed for a specific sales channel. It uses the product’s listing date to
238
+ * calculate how many days have passed since it became available, then
239
+ * normalizes this against other products in the same channel. A higher score
240
+ * means the product is relatively new and fresh on the channel, while a lower
241
+ * score indicates it has been listed for a longer time or lacks valid listing
242
+ * information.
243
+ */
244
+
167
245
  /**
168
246
  * @typedef ApplicationItemMeta
169
247
  * @property {Object} [_custom_json] - Custom JSON data for the item
170
248
  * @property {MetaFields[]} [_custom_meta] - Custom meta fields for the item
171
249
  * @property {Object} [alt_text] - Alternative text for the item's images
250
+ * @property {Scores} [scores]
172
251
  * @property {boolean} [is_cod] - Whether the item is available for Cash on
173
252
  * Delivery (COD) or not
174
253
  * @property {boolean} [is_gift] - Whether the item is a gift or not
@@ -4890,20 +4969,42 @@ const Joi = require("joi");
4890
4969
 
4891
4970
  /**
4892
4971
  * @typedef TaxComponent
4893
- * @property {string} name - Name of the component.
4894
- * @property {TaxThreshold[]} slabs - List of thresholds.
4972
+ * @property {string} name - Name represent different types of taxes that may be
4973
+ * applied to products or transactions, such as sales tax, value-added tax
4974
+ * (VAT), goods and services tax, consumption tax, or other region-specific
4975
+ * taxation systems.
4976
+ * @property {TaxThreshold[]} slabs - List of slabs which comprises of tax rate
4977
+ * and their respective threshold value
4895
4978
  */
4896
4979
 
4897
4980
  /**
4898
- * @typedef TaxComponentRes
4981
+ * @typedef TaxComponentResponseSchema
4899
4982
  * @property {string} name - Name of the component.
4900
4983
  * @property {string} [description] - Description of the tax component.
4901
- * @property {TaxThreshold[]} slabs - List of thresholds.
4984
+ * @property {TaxThreshold[]} slabs - List of slabs that comprises of tax rate
4985
+ * and their respective threshold.
4902
4986
  * @property {string} _id - Unique identifier of the tax component. This _id is
4903
4987
  * required for updating any tax component; If _id field is not in "update tax
4904
4988
  * version" request then that component will be created.
4905
4989
  */
4906
4990
 
4991
+ /**
4992
+ * @typedef TaxComponentName
4993
+ * @property {string} _id - Unique identifier for the tax component name
4994
+ * @property {number} company_id - Identifier of the company this component name
4995
+ * belongs to
4996
+ * @property {string} name - Name of the tax component
4997
+ * @property {string} [description] - Description of the tax component name
4998
+ * @property {string} [created_on] - Timestamp when the component name was created
4999
+ * @property {string} [modified_on] - Timestamp when the component name was last modified
5000
+ */
5001
+
5002
+ /**
5003
+ * @typedef CreateTaxComponentNameRequestSchema
5004
+ * @property {string} name - Name of the tax component
5005
+ * @property {string} [description] - Description of the tax component name
5006
+ */
5007
+
4907
5008
  /**
4908
5009
  * @typedef TaxReqBodyVersion
4909
5010
  * @property {TaxComponent[]} components - List of tax components with their
@@ -4926,12 +5027,12 @@ const Joi = require("joi");
4926
5027
  * @property {string} [modified_on]
4927
5028
  * @property {number} [company_id] - Company ID.
4928
5029
  * @property {TaxStatusEnum} [status]
4929
- * @property {TaxComponentRes[]} [components] - List of tax components.
5030
+ * @property {TaxComponentResponseSchema[]} [components] - List of tax components.
4930
5031
  */
4931
5032
 
4932
5033
  /**
4933
5034
  * @typedef UpdateTaxVersionRequestBody
4934
- * @property {TaxComponentRes[]} components - List of tax components.
5035
+ * @property {TaxComponentResponseSchema[]} components - List of tax components.
4935
5036
  * @property {string} applicable_date - It is the date from when this rule will
4936
5037
  * come in effect. It should be atleast one minute in the future from the current time.
4937
5038
  */
@@ -4940,7 +5041,8 @@ const Joi = require("joi");
4940
5041
  * @typedef CreateTaxVersionRequestBody
4941
5042
  * @property {TaxComponent[]} components - List of tax components.
4942
5043
  * @property {string} applicable_date - It is the date from when this rule will
4943
- * come in effect. It should be atleast one minute in the future from the current time.
5044
+ * come in effect. It should be atleast one minute in the future from the
5045
+ * current time. Date time format YYYY-MM-DDThh:mm:ss±hh:mm.
4944
5046
  */
4945
5047
 
4946
5048
  /**
@@ -5034,14 +5136,9 @@ const Joi = require("joi");
5034
5136
  * @property {Page} page
5035
5137
  */
5036
5138
 
5037
- /**
5038
- * @typedef CreateTaxComponentName
5039
- * @property {string} name - Name of a tax component
5040
- */
5041
-
5042
5139
  /**
5043
5140
  * @typedef GetTaxComponents
5044
- * @property {TaxComponentRes[]} items
5141
+ * @property {TaxComponentResponseSchema[]} items
5045
5142
  * @property {Page} page
5046
5143
  */
5047
5144
 
@@ -5321,12 +5418,30 @@ class CatalogPlatformModel {
5321
5418
  });
5322
5419
  }
5323
5420
 
5421
+ /** @returns {Scores} */
5422
+ static Scores() {
5423
+ return Joi.object({
5424
+ popularity: Joi.number().allow(null),
5425
+ availability: Joi.number().allow(null),
5426
+ conversion: Joi.number().allow(null),
5427
+ sold_quantity: Joi.number().allow(null),
5428
+ depth: Joi.number().allow(null),
5429
+ discount: Joi.number().allow(null),
5430
+ revenue: Joi.number().allow(null),
5431
+ cancelled: Joi.number().allow(null),
5432
+ returns: Joi.number().allow(null),
5433
+ catalogue: Joi.number().allow(null),
5434
+ listing: Joi.number().allow(null),
5435
+ });
5436
+ }
5437
+
5324
5438
  /** @returns {ApplicationItemMeta} */
5325
5439
  static ApplicationItemMeta() {
5326
5440
  return Joi.object({
5327
5441
  _custom_json: Joi.object().pattern(/\S/, Joi.any()),
5328
5442
  _custom_meta: Joi.array().items(CatalogPlatformModel.MetaFields()),
5329
5443
  alt_text: Joi.object().pattern(/\S/, Joi.any()),
5444
+ scores: CatalogPlatformModel.Scores(),
5330
5445
  is_cod: Joi.boolean(),
5331
5446
  is_gift: Joi.boolean(),
5332
5447
  moq: CatalogPlatformModel.ApplicationItemMOQ(),
@@ -10343,8 +10458,8 @@ class CatalogPlatformModel {
10343
10458
  });
10344
10459
  }
10345
10460
 
10346
- /** @returns {TaxComponentRes} */
10347
- static TaxComponentRes() {
10461
+ /** @returns {TaxComponentResponseSchema} */
10462
+ static TaxComponentResponseSchema() {
10348
10463
  return Joi.object({
10349
10464
  name: Joi.string().allow("").required(),
10350
10465
  description: Joi.string().allow(""),
@@ -10353,6 +10468,26 @@ class CatalogPlatformModel {
10353
10468
  });
10354
10469
  }
10355
10470
 
10471
+ /** @returns {TaxComponentName} */
10472
+ static TaxComponentName() {
10473
+ return Joi.object({
10474
+ _id: Joi.string().allow("").required(),
10475
+ company_id: Joi.number().required(),
10476
+ name: Joi.string().allow("").required(),
10477
+ description: Joi.string().allow(""),
10478
+ created_on: Joi.string().allow(""),
10479
+ modified_on: Joi.string().allow(""),
10480
+ });
10481
+ }
10482
+
10483
+ /** @returns {CreateTaxComponentNameRequestSchema} */
10484
+ static CreateTaxComponentNameRequestSchema() {
10485
+ return Joi.object({
10486
+ name: Joi.string().allow("").required(),
10487
+ description: Joi.string().allow(""),
10488
+ });
10489
+ }
10490
+
10356
10491
  /** @returns {TaxReqBodyVersion} */
10357
10492
  static TaxReqBodyVersion() {
10358
10493
  return Joi.object({
@@ -10382,7 +10517,9 @@ class CatalogPlatformModel {
10382
10517
  modified_on: Joi.string().allow(""),
10383
10518
  company_id: Joi.number(),
10384
10519
  status: CatalogPlatformModel.TaxStatusEnum(),
10385
- components: Joi.array().items(CatalogPlatformModel.TaxComponentRes()),
10520
+ components: Joi.array().items(
10521
+ CatalogPlatformModel.TaxComponentResponseSchema()
10522
+ ),
10386
10523
  });
10387
10524
  }
10388
10525
 
@@ -10390,7 +10527,7 @@ class CatalogPlatformModel {
10390
10527
  static UpdateTaxVersionRequestBody() {
10391
10528
  return Joi.object({
10392
10529
  components: Joi.array()
10393
- .items(CatalogPlatformModel.TaxComponentRes())
10530
+ .items(CatalogPlatformModel.TaxComponentResponseSchema())
10394
10531
  .required(),
10395
10532
  applicable_date: Joi.string().allow("").required(),
10396
10533
  });
@@ -10523,18 +10660,11 @@ class CatalogPlatformModel {
10523
10660
  });
10524
10661
  }
10525
10662
 
10526
- /** @returns {CreateTaxComponentName} */
10527
- static CreateTaxComponentName() {
10528
- return Joi.object({
10529
- name: Joi.string().allow("").required(),
10530
- });
10531
- }
10532
-
10533
10663
  /** @returns {GetTaxComponents} */
10534
10664
  static GetTaxComponents() {
10535
10665
  return Joi.object({
10536
10666
  items: Joi.array()
10537
- .items(CatalogPlatformModel.TaxComponentRes())
10667
+ .items(CatalogPlatformModel.TaxComponentResponseSchema())
10538
10668
  .required(),
10539
10669
  page: CatalogPlatformModel.Page().required(),
10540
10670
  });
@@ -75,7 +75,7 @@ export = CatalogPlatformValidator;
75
75
  */
76
76
  /**
77
77
  * @typedef CreateTaxComponentNameParam
78
- * @property {CatalogPlatformModel.CreateTaxComponentName} body
78
+ * @property {CatalogPlatformModel.CreateTaxComponentNameRequestSchema} body
79
79
  */
80
80
  /**
81
81
  * @typedef CreateTaxVersionParam
@@ -523,13 +523,6 @@ export = CatalogPlatformValidator;
523
523
  * @property {string} versionId - The ID of the tax version to be updated.
524
524
  * @property {CatalogPlatformModel.UpdateTaxVersionRequestBody} body
525
525
  */
526
- /**
527
- * @typedef UploadBulkProductsParam
528
- * @property {string} department - Department of the product to be uploaded.
529
- * @property {string} productType - Product type of the product to be uploaded
530
- * i.e. set, standard, digital.
531
- * @property {CatalogPlatformModel.BulkProductJob} body
532
- */
533
526
  /**
534
527
  * @typedef ValidateProductGlobalTemplateParam
535
528
  * @property {string} [itemType] - An `item_type` defines the type of item. The
@@ -726,8 +719,6 @@ declare class CatalogPlatformValidator {
726
719
  static updateTaxRule(): UpdateTaxRuleParam;
727
720
  /** @returns {UpdateTaxVersionParam} */
728
721
  static updateTaxVersion(): UpdateTaxVersionParam;
729
- /** @returns {UploadBulkProductsParam} */
730
- static uploadBulkProducts(): UploadBulkProductsParam;
731
722
  /** @returns {ValidateProductGlobalTemplateParam} */
732
723
  static validateProductGlobalTemplate(): ValidateProductGlobalTemplateParam;
733
724
  /** @returns {ValidateProductTemplateParam} */
@@ -736,7 +727,7 @@ declare class CatalogPlatformValidator {
736
727
  static validateProductTemplateSchema(): ValidateProductTemplateSchemaParam;
737
728
  }
738
729
  declare namespace CatalogPlatformValidator {
739
- export { AddInventoryParam, AllSizesParam, BulkHsnCodeParam, CreateBulkInventoryParam, CreateBulkInventoryJobParam, CreateBulkProductUploadJobParam, CreateHsCodeParam, CreateInventoryExportParam, CreateInventoryExportJobParam, CreateMarketplaceOptinParam, CreateProductParam, CreateProductAssetsInBulkParam, CreateProductBundleParam, CreateProductExportJobParam, CreateProductsInBulkParam, CreateSizeGuideParam, CreateTaxParam, CreateTaxComponentNameParam, CreateTaxVersionParam, DeleteBulkInventoryJobParam, DeleteProductParam, DeleteProductBulkJobParam, DeleteRealtimeInventoryParam, DeleteSizeParam, DeleteTaxRuleParam, DeleteTaxVersionParam, DownloadInventoryTemplateViewParam, DownloadProductTemplateViewsParam, EditProductParam, ExportInventoryConfigParam, GetAllProductHsnCodesParam, GetAllTaxRulesParam, GetAttributeParam, GetCategoryDataParam, GetCompanyBrandDetailParam, GetCompanyDetailParam, GetCompanyMetricsParam, GetDepartmentDataParam, GetHsCodesParam, GetHsnCodeParam, GetInventoriesParam, GetInventoryBulkUploadHistoryParam, GetInventoryBySizeParam, GetInventoryBySizeIdentifierParam, GetInventoryExportParam, GetMarketplaceOptinDetailParam, GetMarketplacesParam, GetOptimalLocationsParam, GetProductParam, GetProductAssetsInBulkParam, GetProductAttributesParam, GetProductBulkUploadHistoryParam, GetProductBundleParam, GetProductBundleDetailParam, GetProductExportJobsParam, GetProductSizeParam, GetProductTagsParam, GetProductValidationParam, GetProductsParam, GetSellerInsightsParam, GetSingleProductHSNCodeParam, GetSizeGuideParam, GetSizeGuidesParam, GetStoreDetailParam, GetTaxComponentNamesParam, GetTaxVersionDetailsParam, GetVariantsOfProductsParam, ListCategoriesParam, ListDepartmentsDataParam, ListHSNCodesParam, ListInventoryExportParam, ListProductTemplateParam, ListProductTemplateCategoriesParam, ListProductTemplateExportDetailsParam, ListTemplateBrandTypeValuesParam, UpdateHsnCodeParam, UpdateInventoriesParam, UpdateLocationPriceParam, UpdateLocationQuantityParam, UpdateMarketplaceOptinParam, UpdateProductBundleParam, UpdateRealtimeInventoryParam, UpdateSizeGuideParam, UpdateTaxRuleParam, UpdateTaxVersionParam, UploadBulkProductsParam, ValidateProductGlobalTemplateParam, ValidateProductTemplateParam, ValidateProductTemplateSchemaParam };
730
+ export { AddInventoryParam, AllSizesParam, BulkHsnCodeParam, CreateBulkInventoryParam, CreateBulkInventoryJobParam, CreateBulkProductUploadJobParam, CreateHsCodeParam, CreateInventoryExportParam, CreateInventoryExportJobParam, CreateMarketplaceOptinParam, CreateProductParam, CreateProductAssetsInBulkParam, CreateProductBundleParam, CreateProductExportJobParam, CreateProductsInBulkParam, CreateSizeGuideParam, CreateTaxParam, CreateTaxComponentNameParam, CreateTaxVersionParam, DeleteBulkInventoryJobParam, DeleteProductParam, DeleteProductBulkJobParam, DeleteRealtimeInventoryParam, DeleteSizeParam, DeleteTaxRuleParam, DeleteTaxVersionParam, DownloadInventoryTemplateViewParam, DownloadProductTemplateViewsParam, EditProductParam, ExportInventoryConfigParam, GetAllProductHsnCodesParam, GetAllTaxRulesParam, GetAttributeParam, GetCategoryDataParam, GetCompanyBrandDetailParam, GetCompanyDetailParam, GetCompanyMetricsParam, GetDepartmentDataParam, GetHsCodesParam, GetHsnCodeParam, GetInventoriesParam, GetInventoryBulkUploadHistoryParam, GetInventoryBySizeParam, GetInventoryBySizeIdentifierParam, GetInventoryExportParam, GetMarketplaceOptinDetailParam, GetMarketplacesParam, GetOptimalLocationsParam, GetProductParam, GetProductAssetsInBulkParam, GetProductAttributesParam, GetProductBulkUploadHistoryParam, GetProductBundleParam, GetProductBundleDetailParam, GetProductExportJobsParam, GetProductSizeParam, GetProductTagsParam, GetProductValidationParam, GetProductsParam, GetSellerInsightsParam, GetSingleProductHSNCodeParam, GetSizeGuideParam, GetSizeGuidesParam, GetStoreDetailParam, GetTaxComponentNamesParam, GetTaxVersionDetailsParam, GetVariantsOfProductsParam, ListCategoriesParam, ListDepartmentsDataParam, ListHSNCodesParam, ListInventoryExportParam, ListProductTemplateParam, ListProductTemplateCategoriesParam, ListProductTemplateExportDetailsParam, ListTemplateBrandTypeValuesParam, UpdateHsnCodeParam, UpdateInventoriesParam, UpdateLocationPriceParam, UpdateLocationQuantityParam, UpdateMarketplaceOptinParam, UpdateProductBundleParam, UpdateRealtimeInventoryParam, UpdateSizeGuideParam, UpdateTaxRuleParam, UpdateTaxVersionParam, ValidateProductGlobalTemplateParam, ValidateProductTemplateParam, ValidateProductTemplateSchemaParam };
740
731
  }
741
732
  type AddInventoryParam = {
742
733
  /**
@@ -814,7 +805,7 @@ type CreateTaxParam = {
814
805
  body: CatalogPlatformModel.CreateTaxRequestBody;
815
806
  };
816
807
  type CreateTaxComponentNameParam = {
817
- body: CatalogPlatformModel.CreateTaxComponentName;
808
+ body: CatalogPlatformModel.CreateTaxComponentNameRequestSchema;
818
809
  };
819
810
  type CreateTaxVersionParam = {
820
811
  /**
@@ -1726,18 +1717,6 @@ type UpdateTaxVersionParam = {
1726
1717
  versionId: string;
1727
1718
  body: CatalogPlatformModel.UpdateTaxVersionRequestBody;
1728
1719
  };
1729
- type UploadBulkProductsParam = {
1730
- /**
1731
- * - Department of the product to be uploaded.
1732
- */
1733
- department: string;
1734
- /**
1735
- * - Product type of the product to be uploaded
1736
- * i.e. set, standard, digital.
1737
- */
1738
- productType: string;
1739
- body: CatalogPlatformModel.BulkProductJob;
1740
- };
1741
1720
  type ValidateProductGlobalTemplateParam = {
1742
1721
  /**
1743
1722
  * - An `item_type` defines the type of item. The
@@ -95,7 +95,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
95
95
 
96
96
  /**
97
97
  * @typedef CreateTaxComponentNameParam
98
- * @property {CatalogPlatformModel.CreateTaxComponentName} body
98
+ * @property {CatalogPlatformModel.CreateTaxComponentNameRequestSchema} body
99
99
  */
100
100
 
101
101
  /**
@@ -611,14 +611,6 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
611
611
  * @property {CatalogPlatformModel.UpdateTaxVersionRequestBody} body
612
612
  */
613
613
 
614
- /**
615
- * @typedef UploadBulkProductsParam
616
- * @property {string} department - Department of the product to be uploaded.
617
- * @property {string} productType - Product type of the product to be uploaded
618
- * i.e. set, standard, digital.
619
- * @property {CatalogPlatformModel.BulkProductJob} body
620
- */
621
-
622
614
  /**
623
615
  * @typedef ValidateProductGlobalTemplateParam
624
616
  * @property {string} [itemType] - An `item_type` defines the type of item. The
@@ -775,7 +767,7 @@ class CatalogPlatformValidator {
775
767
  /** @returns {CreateTaxComponentNameParam} */
776
768
  static createTaxComponentName() {
777
769
  return Joi.object({
778
- body: CatalogPlatformModel.CreateTaxComponentName().required(),
770
+ body: CatalogPlatformModel.CreateTaxComponentNameRequestSchema().required(),
779
771
  }).required();
780
772
  }
781
773
 
@@ -1362,15 +1354,6 @@ class CatalogPlatformValidator {
1362
1354
  }).required();
1363
1355
  }
1364
1356
 
1365
- /** @returns {UploadBulkProductsParam} */
1366
- static uploadBulkProducts() {
1367
- return Joi.object({
1368
- department: Joi.string().allow("").required(),
1369
- productType: Joi.string().allow("").required(),
1370
- body: CatalogPlatformModel.BulkProductJob().required(),
1371
- }).required();
1372
- }
1373
-
1374
1357
  /** @returns {ValidateProductGlobalTemplateParam} */
1375
1358
  static validateProductGlobalTemplate() {
1376
1359
  return Joi.object({
@@ -3134,10 +3134,6 @@ export = OrderPlatformModel;
3134
3134
  */
3135
3135
  /**
3136
3136
  * @typedef Article
3137
- * @property {Object} [child_details] - Contains a flexible set of key-value
3138
- * pairs representing detailed information about the article's child entities,
3139
- * including dimensions (width, height, length), weight, and unique
3140
- * identifiers (EAN, article code, seller identifier) for each child entity.
3141
3137
  * @property {string} seller_identifier - Unique identifier assigned by the
3142
3138
  * seller to the article, used for inventory management.
3143
3139
  * @property {string} uid - A unique identifier for the article within the system.
@@ -3165,6 +3161,8 @@ export = OrderPlatformModel;
3165
3161
  * or collection.
3166
3162
  * @property {string[]} [tags] - Tags associated with the article for
3167
3163
  * categorization and search optimization.
3164
+ * @property {Object} [_custom_json] - A custom JSON object containing
3165
+ * additional details or configurations specific to the article.
3168
3166
  */
3169
3167
  /**
3170
3168
  * @typedef ShipmentListingBrand
@@ -11512,13 +11510,6 @@ type Weight = {
11512
11510
  /** @returns {Article} */
11513
11511
  declare function Article(): Article;
11514
11512
  type Article = {
11515
- /**
11516
- * - Contains a flexible set of key-value
11517
- * pairs representing detailed information about the article's child entities,
11518
- * including dimensions (width, height, length), weight, and unique
11519
- * identifiers (EAN, article code, seller identifier) for each child entity.
11520
- */
11521
- child_details?: any;
11522
11513
  /**
11523
11514
  * - Unique identifier assigned by the
11524
11515
  * seller to the article, used for inventory management.
@@ -11585,6 +11576,11 @@ type Article = {
11585
11576
  * categorization and search optimization.
11586
11577
  */
11587
11578
  tags?: string[];
11579
+ /**
11580
+ * - A custom JSON object containing
11581
+ * additional details or configurations specific to the article.
11582
+ */
11583
+ _custom_json?: any;
11588
11584
  };
11589
11585
  /** @returns {ShipmentListingBrand} */
11590
11586
  declare function ShipmentListingBrand(): ShipmentListingBrand;
@@ -3396,10 +3396,6 @@ const Joi = require("joi");
3396
3396
 
3397
3397
  /**
3398
3398
  * @typedef Article
3399
- * @property {Object} [child_details] - Contains a flexible set of key-value
3400
- * pairs representing detailed information about the article's child entities,
3401
- * including dimensions (width, height, length), weight, and unique
3402
- * identifiers (EAN, article code, seller identifier) for each child entity.
3403
3399
  * @property {string} seller_identifier - Unique identifier assigned by the
3404
3400
  * seller to the article, used for inventory management.
3405
3401
  * @property {string} uid - A unique identifier for the article within the system.
@@ -3427,6 +3423,8 @@ const Joi = require("joi");
3427
3423
  * or collection.
3428
3424
  * @property {string[]} [tags] - Tags associated with the article for
3429
3425
  * categorization and search optimization.
3426
+ * @property {Object} [_custom_json] - A custom JSON object containing
3427
+ * additional details or configurations specific to the article.
3430
3428
  */
3431
3429
 
3432
3430
  /**
@@ -8476,7 +8474,6 @@ class OrderPlatformModel {
8476
8474
  /** @returns {Article} */
8477
8475
  static Article() {
8478
8476
  return Joi.object({
8479
- child_details: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
8480
8477
  seller_identifier: Joi.string().allow("").required(),
8481
8478
  uid: Joi.string().allow("").required(),
8482
8479
  set: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
@@ -8492,6 +8489,7 @@ class OrderPlatformModel {
8492
8489
  size: Joi.string().allow("").required(),
8493
8490
  is_set: Joi.boolean().allow(null),
8494
8491
  tags: Joi.array().items(Joi.string().allow("")).allow(null, ""),
8492
+ _custom_json: Joi.object().pattern(/\S/, Joi.any()),
8495
8493
  });
8496
8494
  }
8497
8495
 
@@ -11,7 +11,7 @@ declare class Partner {
11
11
  * Success response
12
12
  * @name addProxyPath
13
13
  * @summary: Create extension proxy
14
- * @description: Extension proxy can be used to call extension API from storefront and make extension API integration seamless. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/addProxyPath/).
14
+ * @description: Use this endpoint to register a proxy for calling an extension's API from your storefront. This enables your storefront to interact with extension APIs seamlessly, helps enhance and extend your storefront's existing functionality using extensions, and simplifies integration by avoiding CORS issues when accessing extension APIs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/addProxyPath/).
15
15
  */
16
16
  addProxyPath({ extensionId, body, requestHeaders }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.ExtensionProxyPathCreation>;
17
17
  /**
@@ -22,7 +22,7 @@ declare class Partner {
22
22
  * Success response
23
23
  * @name removeProxyPath
24
24
  * @summary: Remove extension proxy
25
- * @description: Remove the proxy which are created earlier for the extension. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/removeProxyPath/).
25
+ * @description: Remove the proxy that was created earlier for the extension. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/removeProxyPath/).
26
26
  */
27
27
  removeProxyPath({ extensionId, attachedPath, requestHeaders }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.ExtensionProxyPathDelete>;
28
28
  }
@@ -23,7 +23,7 @@ class Partner {
23
23
  * Success response
24
24
  * @name addProxyPath
25
25
  * @summary: Create extension proxy
26
- * @description: Extension proxy can be used to call extension API from storefront and make extension API integration seamless. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/addProxyPath/).
26
+ * @description: Use this endpoint to register a proxy for calling an extension's API from your storefront. This enables your storefront to interact with extension APIs seamlessly, helps enhance and extend your storefront's existing functionality using extensions, and simplifies integration by avoiding CORS issues when accessing extension APIs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/addProxyPath/).
27
27
  */
28
28
  async addProxyPath(
29
29
  { extensionId, body, requestHeaders } = { requestHeaders: {} },
@@ -105,7 +105,7 @@ class Partner {
105
105
  * Success response
106
106
  * @name removeProxyPath
107
107
  * @summary: Remove extension proxy
108
- * @description: Remove the proxy which are created earlier for the extension. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/removeProxyPath/).
108
+ * @description: Remove the proxy that was created earlier for the extension. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/removeProxyPath/).
109
109
  */
110
110
  async removeProxyPath(
111
111
  { extensionId, attachedPath, requestHeaders } = { requestHeaders: {} },
@@ -1,12 +1,13 @@
1
1
  export = PartnerPlatformApplicationValidator;
2
2
  /**
3
3
  * @typedef AddProxyPathParam
4
- * @property {string} extensionId - Extension id for which a proxy URL will be generated
4
+ * @property {string} extensionId - Extension's unique identifier for which a
5
+ * proxy URL will be generated
5
6
  * @property {PartnerPlatformModel.AddProxyReq} body
6
7
  */
7
8
  /**
8
9
  * @typedef RemoveProxyPathParam
9
- * @property {string} extensionId - Extension id for which proxy URL needs to be removed
10
+ * @property {string} extensionId - Extension ID for which proxy URL needs to be removed
10
11
  * @property {string} attachedPath - Attached path slug
11
12
  */
12
13
  declare class PartnerPlatformApplicationValidator {
@@ -20,14 +21,15 @@ declare namespace PartnerPlatformApplicationValidator {
20
21
  }
21
22
  type AddProxyPathParam = {
22
23
  /**
23
- * - Extension id for which a proxy URL will be generated
24
+ * - Extension's unique identifier for which a
25
+ * proxy URL will be generated
24
26
  */
25
27
  extensionId: string;
26
28
  body: PartnerPlatformModel.AddProxyReq;
27
29
  };
28
30
  type RemoveProxyPathParam = {
29
31
  /**
30
- * - Extension id for which proxy URL needs to be removed
32
+ * - Extension ID for which proxy URL needs to be removed
31
33
  */
32
34
  extensionId: string;
33
35
  /**
@@ -4,13 +4,14 @@ const PartnerPlatformModel = require("./PartnerPlatformModel");
4
4
 
5
5
  /**
6
6
  * @typedef AddProxyPathParam
7
- * @property {string} extensionId - Extension id for which a proxy URL will be generated
7
+ * @property {string} extensionId - Extension's unique identifier for which a
8
+ * proxy URL will be generated
8
9
  * @property {PartnerPlatformModel.AddProxyReq} body
9
10
  */
10
11
 
11
12
  /**
12
13
  * @typedef RemoveProxyPathParam
13
- * @property {string} extensionId - Extension id for which proxy URL needs to be removed
14
+ * @property {string} extensionId - Extension ID for which proxy URL needs to be removed
14
15
  * @property {string} attachedPath - Attached path slug
15
16
  */
16
17
 
@@ -1,9 +1,11 @@
1
1
  export = PartnerPlatformModel;
2
2
  /**
3
3
  * @typedef AddProxyReq
4
- * @property {string} [attached_path] - Proxy path slug
5
- * @property {string} [proxy_url] - The external URL for which the proxy URL
6
- * will be generated
4
+ * @property {string} [attached_path] - Attached path can be any slug that will
5
+ * be appended to the base URL to create a proxy endpoint, e.g.,
6
+ * /ext/{attached_path}. Note: attached_path should be unique for each
7
+ * extension within the same application.
8
+ * @property {string} [proxy_url] - External URL for which the proxy URL will be generated
7
9
  */
8
10
  /**
9
11
  * @typedef ExtensionProxyPathCreation
@@ -47,12 +49,14 @@ declare namespace PartnerPlatformModel {
47
49
  declare function AddProxyReq(): AddProxyReq;
48
50
  type AddProxyReq = {
49
51
  /**
50
- * - Proxy path slug
52
+ * - Attached path can be any slug that will
53
+ * be appended to the base URL to create a proxy endpoint, e.g.,
54
+ * /ext/{attached_path}. Note: attached_path should be unique for each
55
+ * extension within the same application.
51
56
  */
52
57
  attached_path?: string;
53
58
  /**
54
- * - The external URL for which the proxy URL
55
- * will be generated
59
+ * - External URL for which the proxy URL will be generated
56
60
  */
57
61
  proxy_url?: string;
58
62
  };
@@ -2,9 +2,11 @@ const Joi = require("joi");
2
2
 
3
3
  /**
4
4
  * @typedef AddProxyReq
5
- * @property {string} [attached_path] - Proxy path slug
6
- * @property {string} [proxy_url] - The external URL for which the proxy URL
7
- * will be generated
5
+ * @property {string} [attached_path] - Attached path can be any slug that will
6
+ * be appended to the base URL to create a proxy endpoint, e.g.,
7
+ * /ext/{attached_path}. Note: attached_path should be unique for each
8
+ * extension within the same application.
9
+ * @property {string} [proxy_url] - External URL for which the proxy URL will be generated
8
10
  */
9
11
 
10
12
  /**