@gofynd/fdk-client-javascript 3.17.0 → 3.17.2
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.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +40 -0
- package/sdk/application/Cart/CartApplicationClient.js +176 -0
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +18 -4
- package/sdk/application/Catalog/CatalogApplicationClient.js +47 -4
- package/sdk/application/Content/ContentApplicationClient.d.ts +11 -1
- package/sdk/application/Content/ContentApplicationClient.js +40 -2
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +1 -1
- package/sdk/application/Payment/PaymentApplicationClient.js +2 -0
- package/sdk/common/Constant.d.ts +9 -0
- package/sdk/common/Constant.js +11 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +3 -2
- package/sdk/partner/Theme/ThemePartnerModel.js +5 -2
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +72 -10
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +634 -33
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +225 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +147 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +951 -1
- package/sdk/platform/Cart/CartPlatformModel.js +597 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +123 -3
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +829 -39
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +205 -7
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +154 -3
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +5 -5
- package/sdk/platform/Catalog/CatalogPlatformClient.js +8 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1023 -31
- package/sdk/platform/Catalog/CatalogPlatformModel.js +841 -26
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +7 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +3 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +7 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.js +3 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +92 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +54 -0
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +5 -5
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +3 -3
- package/sdk/platform/Content/ContentPlatformModel.d.ts +9 -8
- package/sdk/platform/Content/ContentPlatformModel.js +11 -8
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +21 -0
- package/sdk/platform/Discount/DiscountPlatformModel.js +9 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +2 -2
- package/sdk/platform/Order/OrderPlatformClient.js +2 -2
- package/sdk/platform/Order/OrderPlatformModel.d.ts +20 -2
- package/sdk/platform/Order/OrderPlatformModel.js +9 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +14 -3
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +88 -6
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +28 -3
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +22 -2
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +356 -1
- package/sdk/platform/Payment/PaymentPlatformModel.js +229 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +3 -2
- package/sdk/platform/Theme/ThemePlatformModel.js +5 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +29 -0
- package/sdk/platform/Webhook/WebhookPlatformModel.js +13 -0
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +29 -0
- package/sdk/public/Webhook/WebhookPublicModel.js +13 -0
|
@@ -55,6 +55,10 @@ export = CatalogPlatformApplicationValidator;
|
|
|
55
55
|
* particular listing configuration type.
|
|
56
56
|
* @property {CatalogPlatformModel.AppConfigurationsSort} body
|
|
57
57
|
*/
|
|
58
|
+
/**
|
|
59
|
+
* @typedef CreatePriceFactoryParam
|
|
60
|
+
* @property {CatalogPlatformModel.CreatePriceFactoryConfigSchema} body
|
|
61
|
+
*/
|
|
58
62
|
/**
|
|
59
63
|
* @typedef CreateSearchConfigurationParam
|
|
60
64
|
* @property {CatalogPlatformModel.CreateSearchConfigurationRequestSchema} body
|
|
@@ -86,6 +90,11 @@ export = CatalogPlatformApplicationValidator;
|
|
|
86
90
|
* @property {string} configId - A `config_id` is a unique identifier of a
|
|
87
91
|
* particular configuration.
|
|
88
92
|
*/
|
|
93
|
+
/**
|
|
94
|
+
* @typedef DeletePriceFactoryParam
|
|
95
|
+
* @property {string} priceFactoryId - A `price_factory_id` is a unique
|
|
96
|
+
* identifier for a particular price factory configuration.
|
|
97
|
+
*/
|
|
89
98
|
/** @typedef DeleteSearchConfigurationParam */
|
|
90
99
|
/**
|
|
91
100
|
* @typedef DeleteSearchKeywordsParam
|
|
@@ -160,6 +169,10 @@ export = CatalogPlatformApplicationValidator;
|
|
|
160
169
|
* @typedef GetAppProductParam
|
|
161
170
|
* @property {string} itemId - Product id for a particular product.
|
|
162
171
|
*/
|
|
172
|
+
/**
|
|
173
|
+
* @typedef GetAppProductPricesParam
|
|
174
|
+
* @property {number[]} itemIds - List of item IDs for which to retrieve pricing.
|
|
175
|
+
*/
|
|
163
176
|
/**
|
|
164
177
|
* @typedef GetAppProductsParam
|
|
165
178
|
* @property {number[]} [brandIds] - Get multiple products filtered by Brand Ids
|
|
@@ -257,9 +270,10 @@ export = CatalogPlatformApplicationValidator;
|
|
|
257
270
|
* details. This flag is used to fetch all filters
|
|
258
271
|
* @property {boolean} [isDependent] - This query parameter is used to get the
|
|
259
272
|
* dependent products in the listing.
|
|
260
|
-
* @property {string} [sortOn] - The order to sort the list of products on.
|
|
261
|
-
*
|
|
262
|
-
*
|
|
273
|
+
* @property {string} [sortOn] - The order to sort the list of products on.
|
|
274
|
+
* Supported values include latest, popular, price_asc, price_dsc,
|
|
275
|
+
* discount_asc, discount_dsc. Custom sort keys configured via listing
|
|
276
|
+
* configuration (e.g., best_selling) are also supported for cohort-based sorting.
|
|
263
277
|
* @property {string} [pageId] - Each response will contain **page_id** param,
|
|
264
278
|
* which should be sent back to make pagination work.
|
|
265
279
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
@@ -365,6 +379,44 @@ export = CatalogPlatformApplicationValidator;
|
|
|
365
379
|
* Default is 12.
|
|
366
380
|
* @property {string} [search] - Get configuration list filtered by `search` string.
|
|
367
381
|
*/
|
|
382
|
+
/**
|
|
383
|
+
* @typedef GetPriceFactoriesParam
|
|
384
|
+
* @property {string} [q] - Optional q to filter price factories by name.
|
|
385
|
+
*/
|
|
386
|
+
/**
|
|
387
|
+
* @typedef GetPriceFactoryParam
|
|
388
|
+
* @property {string} priceFactoryId - Unique identifier of the specific price
|
|
389
|
+
* factory to be retrieved.
|
|
390
|
+
*/
|
|
391
|
+
/**
|
|
392
|
+
* @typedef GetPriceFactoryProductParam
|
|
393
|
+
* @property {string} priceFactoryId - A `price_factory_id` is a unique
|
|
394
|
+
* identifier for a particular sale channel.
|
|
395
|
+
* @property {number} itemId - A `item_id` is a unique identifier for a
|
|
396
|
+
* particular product.
|
|
397
|
+
*/
|
|
398
|
+
/**
|
|
399
|
+
* @typedef GetPriceFactoryProductsParam
|
|
400
|
+
* @property {string} priceFactoryId - A `price_factory_id` uniquely identifies
|
|
401
|
+
* a price factory configuration for a specific application.
|
|
402
|
+
* @property {number[]} [brandIds] - Optional list of brand IDs to filter price
|
|
403
|
+
* factories associated with specific brands.
|
|
404
|
+
* @property {number[]} [categoryIds] - Optional list of category IDs to filter
|
|
405
|
+
* price factories related to specific product categories.
|
|
406
|
+
* @property {string} [sellerIdentifier] - Optional seller identifier to filter
|
|
407
|
+
* price factories associated with a particular seller.
|
|
408
|
+
* @property {string} [itemCode] - Optional item code to filter price factories
|
|
409
|
+
* configured for a specific product code.
|
|
410
|
+
* @property {string} [slug] - Optional slug to filter price factories by product slug.
|
|
411
|
+
* @property {string} [name] - Optional name to filter price factories by
|
|
412
|
+
* product or configuration name.
|
|
413
|
+
* @property {boolean} [active] - Optional name to filter price factories by
|
|
414
|
+
* product status.
|
|
415
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
416
|
+
* set of results
|
|
417
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
418
|
+
* Default is 12.
|
|
419
|
+
*/
|
|
368
420
|
/**
|
|
369
421
|
* @typedef GetProductDetailBySlugParam
|
|
370
422
|
* @property {string} slug - The unique identifier of a product. i.e; `slug` of
|
|
@@ -454,6 +506,20 @@ export = CatalogPlatformApplicationValidator;
|
|
|
454
506
|
* particular configuration.
|
|
455
507
|
* @property {CatalogPlatformModel.AppConfigurationsSort} body
|
|
456
508
|
*/
|
|
509
|
+
/**
|
|
510
|
+
* @typedef UpdatePriceFactoryParam
|
|
511
|
+
* @property {string} priceFactoryId - Unique identifier of the specific price
|
|
512
|
+
* factory to be updated.
|
|
513
|
+
* @property {CatalogPlatformModel.UpdatePriceFactoryConfigSchema} body
|
|
514
|
+
*/
|
|
515
|
+
/**
|
|
516
|
+
* @typedef UpdatePriceFactoryProductParam
|
|
517
|
+
* @property {string} priceFactoryId - A `price_factory_id` is a unique
|
|
518
|
+
* identifier for a specific price factory configuration.
|
|
519
|
+
* @property {number} itemId - A `item_id` is a unique identifier for a
|
|
520
|
+
* particular product.
|
|
521
|
+
* @property {CatalogPlatformModel.UpsertPriceFactoryProductSchema} body
|
|
522
|
+
*/
|
|
457
523
|
/**
|
|
458
524
|
* @typedef UpdateSearchConfigurationParam
|
|
459
525
|
* @property {CatalogPlatformModel.UpdateSearchConfigurationRequestSchema} body
|
|
@@ -485,6 +551,8 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
485
551
|
static createGroupConfiguration(): CreateGroupConfigurationParam;
|
|
486
552
|
/** @returns {CreateListingConfigurationParam} */
|
|
487
553
|
static createListingConfiguration(): CreateListingConfigurationParam;
|
|
554
|
+
/** @returns {CreatePriceFactoryParam} */
|
|
555
|
+
static createPriceFactory(): CreatePriceFactoryParam;
|
|
488
556
|
/** @returns {CreateSearchConfigurationParam} */
|
|
489
557
|
static createSearchConfiguration(): CreateSearchConfigurationParam;
|
|
490
558
|
/** @returns {DeleteAppCategoryReturnConfigurationParam} */
|
|
@@ -497,6 +565,8 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
497
565
|
static deleteGroupConfiguration(): DeleteGroupConfigurationParam;
|
|
498
566
|
/** @returns {DeleteListingConfigurationParam} */
|
|
499
567
|
static deleteListingConfiguration(): DeleteListingConfigurationParam;
|
|
568
|
+
/** @returns {DeletePriceFactoryParam} */
|
|
569
|
+
static deletePriceFactory(): DeletePriceFactoryParam;
|
|
500
570
|
/** @returns {DeleteSearchConfigurationParam} */
|
|
501
571
|
static deleteSearchConfiguration(): any;
|
|
502
572
|
/** @returns {DeleteSearchKeywordsParam} */
|
|
@@ -515,6 +585,8 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
515
585
|
static getAppLocations(): GetAppLocationsParam;
|
|
516
586
|
/** @returns {GetAppProductParam} */
|
|
517
587
|
static getAppProduct(): GetAppProductParam;
|
|
588
|
+
/** @returns {GetAppProductPricesParam} */
|
|
589
|
+
static getAppProductPrices(): GetAppProductPricesParam;
|
|
518
590
|
/** @returns {GetAppProductsParam} */
|
|
519
591
|
static getAppProducts(): GetAppProductsParam;
|
|
520
592
|
/** @returns {GetAppReturnConfigurationParam} */
|
|
@@ -563,6 +635,14 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
563
635
|
static getGroupConfigurations(): GetGroupConfigurationsParam;
|
|
564
636
|
/** @returns {GetListingConfigurationsParam} */
|
|
565
637
|
static getListingConfigurations(): GetListingConfigurationsParam;
|
|
638
|
+
/** @returns {GetPriceFactoriesParam} */
|
|
639
|
+
static getPriceFactories(): GetPriceFactoriesParam;
|
|
640
|
+
/** @returns {GetPriceFactoryParam} */
|
|
641
|
+
static getPriceFactory(): GetPriceFactoryParam;
|
|
642
|
+
/** @returns {GetPriceFactoryProductParam} */
|
|
643
|
+
static getPriceFactoryProduct(): GetPriceFactoryProductParam;
|
|
644
|
+
/** @returns {GetPriceFactoryProductsParam} */
|
|
645
|
+
static getPriceFactoryProducts(): GetPriceFactoryProductsParam;
|
|
566
646
|
/** @returns {GetProductDetailBySlugParam} */
|
|
567
647
|
static getProductDetailBySlug(): GetProductDetailBySlugParam;
|
|
568
648
|
/** @returns {GetQueryFiltersParam} */
|
|
@@ -599,13 +679,17 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
599
679
|
static updateGroupConfiguration(): UpdateGroupConfigurationParam;
|
|
600
680
|
/** @returns {UpdateListingConfigurationParam} */
|
|
601
681
|
static updateListingConfiguration(): UpdateListingConfigurationParam;
|
|
682
|
+
/** @returns {UpdatePriceFactoryParam} */
|
|
683
|
+
static updatePriceFactory(): UpdatePriceFactoryParam;
|
|
684
|
+
/** @returns {UpdatePriceFactoryProductParam} */
|
|
685
|
+
static updatePriceFactoryProduct(): UpdatePriceFactoryProductParam;
|
|
602
686
|
/** @returns {UpdateSearchConfigurationParam} */
|
|
603
687
|
static updateSearchConfiguration(): UpdateSearchConfigurationParam;
|
|
604
688
|
/** @returns {UpdateSearchKeywordsParam} */
|
|
605
689
|
static updateSearchKeywords(): UpdateSearchKeywordsParam;
|
|
606
690
|
}
|
|
607
691
|
declare namespace CatalogPlatformApplicationValidator {
|
|
608
|
-
export { AddCollectionItemsParam, CreateAppCategoryReturnConfigurationParam, CreateAppReturnConfigurationParam, CreateCollectionParam, CreateConfigurationByTypeParam, CreateConfigurationProductListingParam, CreateCustomAutocompleteRuleParam, CreateCustomKeywordParam, CreateGroupConfigurationParam, CreateListingConfigurationParam, CreateSearchConfigurationParam, DeleteAppCategoryReturnConfigurationParam, DeleteAutocompleteKeywordParam, DeleteCollectionParam, DeleteGroupConfigurationParam, DeleteListingConfigurationParam, DeleteSearchConfigurationParam, DeleteSearchKeywordsParam, FollowProductByIdParam, GetAllCollectionsParam, GetAllSearchKeywordParam, GetAppCategoryReturnConfigParam, GetAppInventoryParam, GetAppLocationsParam, GetAppProductParam, GetAppProductsParam, GetAppReturnConfigurationParam, GetApplicationBrandListingParam, GetApplicationBrandsParam, GetApplicationCategoryListingParam, GetApplicationDepartmentListingParam, GetApplicationFilterKeysParam, GetApplicationFilterValuesParam, GetApplicationProductsParam, GetAutocompleteConfigParam, GetAutocompleteKeywordDetailParam, GetCatalogConfigurationParam, GetCatalogInsightsParam, GetCategoriesParam, GetCollectionDetailParam, GetCollectionItemsParam, GetConfigurationByTypeParam, GetConfigurationMetadataParam, GetConfigurationsParam, GetDepartmentsParam, GetDiscountedInventoryBySizeIdentifierParam, GetFollowedProductsParam, GetGroupConfigurationsParam, GetListingConfigurationsParam, GetProductDetailBySlugParam, GetQueryFiltersParam, GetSearchConfigurationParam, GetSearchKeywordsParam, UnfollowProductByIdParam, UpdateAllowSingleParam, UpdateAppBrandParam, UpdateAppCategoryParam, UpdateAppCategoryReturnConfigurationParam, UpdateAppDepartmentParam, UpdateAppLocationParam, UpdateAppProductParam, UpdateAppReturnConfigurationParam, UpdateAutocompleteKeywordParam, UpdateCollectionParam, UpdateDefaultSortParam, UpdateGroupConfigurationParam, UpdateListingConfigurationParam, UpdateSearchConfigurationParam, UpdateSearchKeywordsParam };
|
|
692
|
+
export { AddCollectionItemsParam, CreateAppCategoryReturnConfigurationParam, CreateAppReturnConfigurationParam, CreateCollectionParam, CreateConfigurationByTypeParam, CreateConfigurationProductListingParam, CreateCustomAutocompleteRuleParam, CreateCustomKeywordParam, CreateGroupConfigurationParam, CreateListingConfigurationParam, CreatePriceFactoryParam, CreateSearchConfigurationParam, DeleteAppCategoryReturnConfigurationParam, DeleteAutocompleteKeywordParam, DeleteCollectionParam, DeleteGroupConfigurationParam, DeleteListingConfigurationParam, DeletePriceFactoryParam, DeleteSearchConfigurationParam, DeleteSearchKeywordsParam, FollowProductByIdParam, GetAllCollectionsParam, GetAllSearchKeywordParam, GetAppCategoryReturnConfigParam, GetAppInventoryParam, GetAppLocationsParam, GetAppProductParam, GetAppProductPricesParam, GetAppProductsParam, GetAppReturnConfigurationParam, GetApplicationBrandListingParam, GetApplicationBrandsParam, GetApplicationCategoryListingParam, GetApplicationDepartmentListingParam, GetApplicationFilterKeysParam, GetApplicationFilterValuesParam, GetApplicationProductsParam, GetAutocompleteConfigParam, GetAutocompleteKeywordDetailParam, GetCatalogConfigurationParam, GetCatalogInsightsParam, GetCategoriesParam, GetCollectionDetailParam, GetCollectionItemsParam, GetConfigurationByTypeParam, GetConfigurationMetadataParam, GetConfigurationsParam, GetDepartmentsParam, GetDiscountedInventoryBySizeIdentifierParam, GetFollowedProductsParam, GetGroupConfigurationsParam, GetListingConfigurationsParam, GetPriceFactoriesParam, GetPriceFactoryParam, GetPriceFactoryProductParam, GetPriceFactoryProductsParam, GetProductDetailBySlugParam, GetQueryFiltersParam, GetSearchConfigurationParam, GetSearchKeywordsParam, UnfollowProductByIdParam, UpdateAllowSingleParam, UpdateAppBrandParam, UpdateAppCategoryParam, UpdateAppCategoryReturnConfigurationParam, UpdateAppDepartmentParam, UpdateAppLocationParam, UpdateAppProductParam, UpdateAppReturnConfigurationParam, UpdateAutocompleteKeywordParam, UpdateCollectionParam, UpdateDefaultSortParam, UpdateGroupConfigurationParam, UpdateListingConfigurationParam, UpdatePriceFactoryParam, UpdatePriceFactoryProductParam, UpdateSearchConfigurationParam, UpdateSearchKeywordsParam };
|
|
609
693
|
}
|
|
610
694
|
type AddCollectionItemsParam = {
|
|
611
695
|
/**
|
|
@@ -686,6 +770,9 @@ type CreateListingConfigurationParam = {
|
|
|
686
770
|
configType: string;
|
|
687
771
|
body: CatalogPlatformModel.AppConfigurationsSort;
|
|
688
772
|
};
|
|
773
|
+
type CreatePriceFactoryParam = {
|
|
774
|
+
body: CatalogPlatformModel.CreatePriceFactoryConfigSchema;
|
|
775
|
+
};
|
|
689
776
|
type CreateSearchConfigurationParam = {
|
|
690
777
|
body: CatalogPlatformModel.CreateSearchConfigurationRequestSchema;
|
|
691
778
|
};
|
|
@@ -729,6 +816,13 @@ type DeleteListingConfigurationParam = {
|
|
|
729
816
|
*/
|
|
730
817
|
configId: string;
|
|
731
818
|
};
|
|
819
|
+
type DeletePriceFactoryParam = {
|
|
820
|
+
/**
|
|
821
|
+
* - A `price_factory_id` is a unique
|
|
822
|
+
* identifier for a particular price factory configuration.
|
|
823
|
+
*/
|
|
824
|
+
priceFactoryId: string;
|
|
825
|
+
};
|
|
732
826
|
type DeleteSearchKeywordsParam = {
|
|
733
827
|
/**
|
|
734
828
|
* - A `id` is a unique identifier for a particular
|
|
@@ -896,6 +990,12 @@ type GetAppProductParam = {
|
|
|
896
990
|
*/
|
|
897
991
|
itemId: string;
|
|
898
992
|
};
|
|
993
|
+
type GetAppProductPricesParam = {
|
|
994
|
+
/**
|
|
995
|
+
* - List of item IDs for which to retrieve pricing.
|
|
996
|
+
*/
|
|
997
|
+
itemIds: number[];
|
|
998
|
+
};
|
|
899
999
|
type GetAppProductsParam = {
|
|
900
1000
|
/**
|
|
901
1001
|
* - Get multiple products filtered by Brand Ids
|
|
@@ -1090,9 +1190,10 @@ type GetApplicationProductsParam = {
|
|
|
1090
1190
|
*/
|
|
1091
1191
|
isDependent?: boolean;
|
|
1092
1192
|
/**
|
|
1093
|
-
* - The order to sort the list of products on.
|
|
1094
|
-
*
|
|
1095
|
-
*
|
|
1193
|
+
* - The order to sort the list of products on.
|
|
1194
|
+
* Supported values include latest, popular, price_asc, price_dsc,
|
|
1195
|
+
* discount_asc, discount_dsc. Custom sort keys configured via listing
|
|
1196
|
+
* configuration (e.g., best_selling) are also supported for cohort-based sorting.
|
|
1096
1197
|
*/
|
|
1097
1198
|
sortOn?: string;
|
|
1098
1199
|
/**
|
|
@@ -1296,6 +1397,82 @@ type GetListingConfigurationsParam = {
|
|
|
1296
1397
|
*/
|
|
1297
1398
|
search?: string;
|
|
1298
1399
|
};
|
|
1400
|
+
type GetPriceFactoriesParam = {
|
|
1401
|
+
/**
|
|
1402
|
+
* - Optional q to filter price factories by name.
|
|
1403
|
+
*/
|
|
1404
|
+
q?: string;
|
|
1405
|
+
};
|
|
1406
|
+
type GetPriceFactoryParam = {
|
|
1407
|
+
/**
|
|
1408
|
+
* - Unique identifier of the specific price
|
|
1409
|
+
* factory to be retrieved.
|
|
1410
|
+
*/
|
|
1411
|
+
priceFactoryId: string;
|
|
1412
|
+
};
|
|
1413
|
+
type GetPriceFactoryProductParam = {
|
|
1414
|
+
/**
|
|
1415
|
+
* - A `price_factory_id` is a unique
|
|
1416
|
+
* identifier for a particular sale channel.
|
|
1417
|
+
*/
|
|
1418
|
+
priceFactoryId: string;
|
|
1419
|
+
/**
|
|
1420
|
+
* - A `item_id` is a unique identifier for a
|
|
1421
|
+
* particular product.
|
|
1422
|
+
*/
|
|
1423
|
+
itemId: number;
|
|
1424
|
+
};
|
|
1425
|
+
type GetPriceFactoryProductsParam = {
|
|
1426
|
+
/**
|
|
1427
|
+
* - A `price_factory_id` uniquely identifies
|
|
1428
|
+
* a price factory configuration for a specific application.
|
|
1429
|
+
*/
|
|
1430
|
+
priceFactoryId: string;
|
|
1431
|
+
/**
|
|
1432
|
+
* - Optional list of brand IDs to filter price
|
|
1433
|
+
* factories associated with specific brands.
|
|
1434
|
+
*/
|
|
1435
|
+
brandIds?: number[];
|
|
1436
|
+
/**
|
|
1437
|
+
* - Optional list of category IDs to filter
|
|
1438
|
+
* price factories related to specific product categories.
|
|
1439
|
+
*/
|
|
1440
|
+
categoryIds?: number[];
|
|
1441
|
+
/**
|
|
1442
|
+
* - Optional seller identifier to filter
|
|
1443
|
+
* price factories associated with a particular seller.
|
|
1444
|
+
*/
|
|
1445
|
+
sellerIdentifier?: string;
|
|
1446
|
+
/**
|
|
1447
|
+
* - Optional item code to filter price factories
|
|
1448
|
+
* configured for a specific product code.
|
|
1449
|
+
*/
|
|
1450
|
+
itemCode?: string;
|
|
1451
|
+
/**
|
|
1452
|
+
* - Optional slug to filter price factories by product slug.
|
|
1453
|
+
*/
|
|
1454
|
+
slug?: string;
|
|
1455
|
+
/**
|
|
1456
|
+
* - Optional name to filter price factories by
|
|
1457
|
+
* product or configuration name.
|
|
1458
|
+
*/
|
|
1459
|
+
name?: string;
|
|
1460
|
+
/**
|
|
1461
|
+
* - Optional name to filter price factories by
|
|
1462
|
+
* product status.
|
|
1463
|
+
*/
|
|
1464
|
+
active?: boolean;
|
|
1465
|
+
/**
|
|
1466
|
+
* - The page number to navigate through the given
|
|
1467
|
+
* set of results
|
|
1468
|
+
*/
|
|
1469
|
+
pageNo?: number;
|
|
1470
|
+
/**
|
|
1471
|
+
* - Number of items to retrieve in each page.
|
|
1472
|
+
* Default is 12.
|
|
1473
|
+
*/
|
|
1474
|
+
pageSize?: number;
|
|
1475
|
+
};
|
|
1299
1476
|
type GetProductDetailBySlugParam = {
|
|
1300
1477
|
/**
|
|
1301
1478
|
* - The unique identifier of a product. i.e; `slug` of
|
|
@@ -1412,6 +1589,27 @@ type UpdateListingConfigurationParam = {
|
|
|
1412
1589
|
configId: string;
|
|
1413
1590
|
body: CatalogPlatformModel.AppConfigurationsSort;
|
|
1414
1591
|
};
|
|
1592
|
+
type UpdatePriceFactoryParam = {
|
|
1593
|
+
/**
|
|
1594
|
+
* - Unique identifier of the specific price
|
|
1595
|
+
* factory to be updated.
|
|
1596
|
+
*/
|
|
1597
|
+
priceFactoryId: string;
|
|
1598
|
+
body: CatalogPlatformModel.UpdatePriceFactoryConfigSchema;
|
|
1599
|
+
};
|
|
1600
|
+
type UpdatePriceFactoryProductParam = {
|
|
1601
|
+
/**
|
|
1602
|
+
* - A `price_factory_id` is a unique
|
|
1603
|
+
* identifier for a specific price factory configuration.
|
|
1604
|
+
*/
|
|
1605
|
+
priceFactoryId: string;
|
|
1606
|
+
/**
|
|
1607
|
+
* - A `item_id` is a unique identifier for a
|
|
1608
|
+
* particular product.
|
|
1609
|
+
*/
|
|
1610
|
+
itemId: number;
|
|
1611
|
+
body: CatalogPlatformModel.UpsertPriceFactoryProductSchema;
|
|
1612
|
+
};
|
|
1415
1613
|
type UpdateSearchConfigurationParam = {
|
|
1416
1614
|
body: CatalogPlatformModel.UpdateSearchConfigurationRequestSchema;
|
|
1417
1615
|
};
|
|
@@ -68,6 +68,11 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
68
68
|
* @property {CatalogPlatformModel.AppConfigurationsSort} body
|
|
69
69
|
*/
|
|
70
70
|
|
|
71
|
+
/**
|
|
72
|
+
* @typedef CreatePriceFactoryParam
|
|
73
|
+
* @property {CatalogPlatformModel.CreatePriceFactoryConfigSchema} body
|
|
74
|
+
*/
|
|
75
|
+
|
|
71
76
|
/**
|
|
72
77
|
* @typedef CreateSearchConfigurationParam
|
|
73
78
|
* @property {CatalogPlatformModel.CreateSearchConfigurationRequestSchema} body
|
|
@@ -105,6 +110,12 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
105
110
|
* particular configuration.
|
|
106
111
|
*/
|
|
107
112
|
|
|
113
|
+
/**
|
|
114
|
+
* @typedef DeletePriceFactoryParam
|
|
115
|
+
* @property {string} priceFactoryId - A `price_factory_id` is a unique
|
|
116
|
+
* identifier for a particular price factory configuration.
|
|
117
|
+
*/
|
|
118
|
+
|
|
108
119
|
/** @typedef DeleteSearchConfigurationParam */
|
|
109
120
|
|
|
110
121
|
/**
|
|
@@ -188,6 +199,11 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
188
199
|
* @property {string} itemId - Product id for a particular product.
|
|
189
200
|
*/
|
|
190
201
|
|
|
202
|
+
/**
|
|
203
|
+
* @typedef GetAppProductPricesParam
|
|
204
|
+
* @property {number[]} itemIds - List of item IDs for which to retrieve pricing.
|
|
205
|
+
*/
|
|
206
|
+
|
|
191
207
|
/**
|
|
192
208
|
* @typedef GetAppProductsParam
|
|
193
209
|
* @property {number[]} [brandIds] - Get multiple products filtered by Brand Ids
|
|
@@ -293,9 +309,10 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
293
309
|
* details. This flag is used to fetch all filters
|
|
294
310
|
* @property {boolean} [isDependent] - This query parameter is used to get the
|
|
295
311
|
* dependent products in the listing.
|
|
296
|
-
* @property {string} [sortOn] - The order to sort the list of products on.
|
|
297
|
-
*
|
|
298
|
-
*
|
|
312
|
+
* @property {string} [sortOn] - The order to sort the list of products on.
|
|
313
|
+
* Supported values include latest, popular, price_asc, price_dsc,
|
|
314
|
+
* discount_asc, discount_dsc. Custom sort keys configured via listing
|
|
315
|
+
* configuration (e.g., best_selling) are also supported for cohort-based sorting.
|
|
299
316
|
* @property {string} [pageId] - Each response will contain **page_id** param,
|
|
300
317
|
* which should be sent back to make pagination work.
|
|
301
318
|
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
@@ -417,6 +434,48 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
417
434
|
* @property {string} [search] - Get configuration list filtered by `search` string.
|
|
418
435
|
*/
|
|
419
436
|
|
|
437
|
+
/**
|
|
438
|
+
* @typedef GetPriceFactoriesParam
|
|
439
|
+
* @property {string} [q] - Optional q to filter price factories by name.
|
|
440
|
+
*/
|
|
441
|
+
|
|
442
|
+
/**
|
|
443
|
+
* @typedef GetPriceFactoryParam
|
|
444
|
+
* @property {string} priceFactoryId - Unique identifier of the specific price
|
|
445
|
+
* factory to be retrieved.
|
|
446
|
+
*/
|
|
447
|
+
|
|
448
|
+
/**
|
|
449
|
+
* @typedef GetPriceFactoryProductParam
|
|
450
|
+
* @property {string} priceFactoryId - A `price_factory_id` is a unique
|
|
451
|
+
* identifier for a particular sale channel.
|
|
452
|
+
* @property {number} itemId - A `item_id` is a unique identifier for a
|
|
453
|
+
* particular product.
|
|
454
|
+
*/
|
|
455
|
+
|
|
456
|
+
/**
|
|
457
|
+
* @typedef GetPriceFactoryProductsParam
|
|
458
|
+
* @property {string} priceFactoryId - A `price_factory_id` uniquely identifies
|
|
459
|
+
* a price factory configuration for a specific application.
|
|
460
|
+
* @property {number[]} [brandIds] - Optional list of brand IDs to filter price
|
|
461
|
+
* factories associated with specific brands.
|
|
462
|
+
* @property {number[]} [categoryIds] - Optional list of category IDs to filter
|
|
463
|
+
* price factories related to specific product categories.
|
|
464
|
+
* @property {string} [sellerIdentifier] - Optional seller identifier to filter
|
|
465
|
+
* price factories associated with a particular seller.
|
|
466
|
+
* @property {string} [itemCode] - Optional item code to filter price factories
|
|
467
|
+
* configured for a specific product code.
|
|
468
|
+
* @property {string} [slug] - Optional slug to filter price factories by product slug.
|
|
469
|
+
* @property {string} [name] - Optional name to filter price factories by
|
|
470
|
+
* product or configuration name.
|
|
471
|
+
* @property {boolean} [active] - Optional name to filter price factories by
|
|
472
|
+
* product status.
|
|
473
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
474
|
+
* set of results
|
|
475
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
476
|
+
* Default is 12.
|
|
477
|
+
*/
|
|
478
|
+
|
|
420
479
|
/**
|
|
421
480
|
* @typedef GetProductDetailBySlugParam
|
|
422
481
|
* @property {string} slug - The unique identifier of a product. i.e; `slug` of
|
|
@@ -524,6 +583,22 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
524
583
|
* @property {CatalogPlatformModel.AppConfigurationsSort} body
|
|
525
584
|
*/
|
|
526
585
|
|
|
586
|
+
/**
|
|
587
|
+
* @typedef UpdatePriceFactoryParam
|
|
588
|
+
* @property {string} priceFactoryId - Unique identifier of the specific price
|
|
589
|
+
* factory to be updated.
|
|
590
|
+
* @property {CatalogPlatformModel.UpdatePriceFactoryConfigSchema} body
|
|
591
|
+
*/
|
|
592
|
+
|
|
593
|
+
/**
|
|
594
|
+
* @typedef UpdatePriceFactoryProductParam
|
|
595
|
+
* @property {string} priceFactoryId - A `price_factory_id` is a unique
|
|
596
|
+
* identifier for a specific price factory configuration.
|
|
597
|
+
* @property {number} itemId - A `item_id` is a unique identifier for a
|
|
598
|
+
* particular product.
|
|
599
|
+
* @property {CatalogPlatformModel.UpsertPriceFactoryProductSchema} body
|
|
600
|
+
*/
|
|
601
|
+
|
|
527
602
|
/**
|
|
528
603
|
* @typedef UpdateSearchConfigurationParam
|
|
529
604
|
* @property {CatalogPlatformModel.UpdateSearchConfigurationRequestSchema} body
|
|
@@ -618,6 +693,13 @@ class CatalogPlatformApplicationValidator {
|
|
|
618
693
|
}).required();
|
|
619
694
|
}
|
|
620
695
|
|
|
696
|
+
/** @returns {CreatePriceFactoryParam} */
|
|
697
|
+
static createPriceFactory() {
|
|
698
|
+
return Joi.object({
|
|
699
|
+
body: CatalogPlatformModel.CreatePriceFactoryConfigSchema().required(),
|
|
700
|
+
}).required();
|
|
701
|
+
}
|
|
702
|
+
|
|
621
703
|
/** @returns {CreateSearchConfigurationParam} */
|
|
622
704
|
static createSearchConfiguration() {
|
|
623
705
|
return Joi.object({
|
|
@@ -662,6 +744,13 @@ class CatalogPlatformApplicationValidator {
|
|
|
662
744
|
}).required();
|
|
663
745
|
}
|
|
664
746
|
|
|
747
|
+
/** @returns {DeletePriceFactoryParam} */
|
|
748
|
+
static deletePriceFactory() {
|
|
749
|
+
return Joi.object({
|
|
750
|
+
priceFactoryId: Joi.string().allow("").required(),
|
|
751
|
+
}).required();
|
|
752
|
+
}
|
|
753
|
+
|
|
665
754
|
/** @returns {DeleteSearchConfigurationParam} */
|
|
666
755
|
static deleteSearchConfiguration() {
|
|
667
756
|
return Joi.object({}).required();
|
|
@@ -748,6 +837,13 @@ class CatalogPlatformApplicationValidator {
|
|
|
748
837
|
}).required();
|
|
749
838
|
}
|
|
750
839
|
|
|
840
|
+
/** @returns {GetAppProductPricesParam} */
|
|
841
|
+
static getAppProductPrices() {
|
|
842
|
+
return Joi.object({
|
|
843
|
+
itemIds: Joi.array().items(Joi.number()).required(),
|
|
844
|
+
}).required();
|
|
845
|
+
}
|
|
846
|
+
|
|
751
847
|
/** @returns {GetAppProductsParam} */
|
|
752
848
|
static getAppProducts() {
|
|
753
849
|
return Joi.object({
|
|
@@ -960,6 +1056,44 @@ class CatalogPlatformApplicationValidator {
|
|
|
960
1056
|
}).required();
|
|
961
1057
|
}
|
|
962
1058
|
|
|
1059
|
+
/** @returns {GetPriceFactoriesParam} */
|
|
1060
|
+
static getPriceFactories() {
|
|
1061
|
+
return Joi.object({
|
|
1062
|
+
q: Joi.string().allow(""),
|
|
1063
|
+
}).required();
|
|
1064
|
+
}
|
|
1065
|
+
|
|
1066
|
+
/** @returns {GetPriceFactoryParam} */
|
|
1067
|
+
static getPriceFactory() {
|
|
1068
|
+
return Joi.object({
|
|
1069
|
+
priceFactoryId: Joi.string().allow("").required(),
|
|
1070
|
+
}).required();
|
|
1071
|
+
}
|
|
1072
|
+
|
|
1073
|
+
/** @returns {GetPriceFactoryProductParam} */
|
|
1074
|
+
static getPriceFactoryProduct() {
|
|
1075
|
+
return Joi.object({
|
|
1076
|
+
priceFactoryId: Joi.string().allow("").required(),
|
|
1077
|
+
itemId: Joi.number().required(),
|
|
1078
|
+
}).required();
|
|
1079
|
+
}
|
|
1080
|
+
|
|
1081
|
+
/** @returns {GetPriceFactoryProductsParam} */
|
|
1082
|
+
static getPriceFactoryProducts() {
|
|
1083
|
+
return Joi.object({
|
|
1084
|
+
priceFactoryId: Joi.string().allow("").required(),
|
|
1085
|
+
brandIds: Joi.array().items(Joi.number()),
|
|
1086
|
+
categoryIds: Joi.array().items(Joi.number()),
|
|
1087
|
+
sellerIdentifier: Joi.string().allow(""),
|
|
1088
|
+
itemCode: Joi.string().allow(""),
|
|
1089
|
+
slug: Joi.string().allow(""),
|
|
1090
|
+
name: Joi.string().allow(""),
|
|
1091
|
+
active: Joi.boolean(),
|
|
1092
|
+
pageNo: Joi.number(),
|
|
1093
|
+
pageSize: Joi.number(),
|
|
1094
|
+
}).required();
|
|
1095
|
+
}
|
|
1096
|
+
|
|
963
1097
|
/** @returns {GetProductDetailBySlugParam} */
|
|
964
1098
|
static getProductDetailBySlug() {
|
|
965
1099
|
return Joi.object({
|
|
@@ -1094,6 +1228,23 @@ class CatalogPlatformApplicationValidator {
|
|
|
1094
1228
|
}).required();
|
|
1095
1229
|
}
|
|
1096
1230
|
|
|
1231
|
+
/** @returns {UpdatePriceFactoryParam} */
|
|
1232
|
+
static updatePriceFactory() {
|
|
1233
|
+
return Joi.object({
|
|
1234
|
+
priceFactoryId: Joi.string().allow("").required(),
|
|
1235
|
+
body: CatalogPlatformModel.UpdatePriceFactoryConfigSchema().required(),
|
|
1236
|
+
}).required();
|
|
1237
|
+
}
|
|
1238
|
+
|
|
1239
|
+
/** @returns {UpdatePriceFactoryProductParam} */
|
|
1240
|
+
static updatePriceFactoryProduct() {
|
|
1241
|
+
return Joi.object({
|
|
1242
|
+
priceFactoryId: Joi.string().allow("").required(),
|
|
1243
|
+
itemId: Joi.number().required(),
|
|
1244
|
+
body: CatalogPlatformModel.UpsertPriceFactoryProductSchema().required(),
|
|
1245
|
+
}).required();
|
|
1246
|
+
}
|
|
1247
|
+
|
|
1097
1248
|
/** @returns {UpdateSearchConfigurationParam} */
|
|
1098
1249
|
static updateSearchConfiguration() {
|
|
1099
1250
|
return Joi.object({
|
|
@@ -165,7 +165,7 @@ declare class Catalog {
|
|
|
165
165
|
* @returns {Promise<CatalogPlatformModel.CreateTax>} - Success response
|
|
166
166
|
* @name createTax
|
|
167
167
|
* @summary: Create Tax Rule
|
|
168
|
-
* @description: Create a tax rule and its version for under a specific company. This also creates a live version of the rule - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTax/).
|
|
168
|
+
* @description: Create a tax rule and its version for under a specific company. This also creates a live version of the rule. The API now supports region-specific versions using optional region_type and areas along with the default country-level rule definition. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTax/).
|
|
169
169
|
*/
|
|
170
170
|
createTax({ body, requestHeaders }?: CatalogPlatformValidator.CreateTaxParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateTax>;
|
|
171
171
|
/**
|
|
@@ -189,7 +189,7 @@ declare class Catalog {
|
|
|
189
189
|
* @returns {Promise<CatalogPlatformModel.TaxVersion>} - Success response
|
|
190
190
|
* @name createTaxVersion
|
|
191
191
|
* @summary: Create a tax version
|
|
192
|
-
* @description: Creates a tax
|
|
192
|
+
* @description: Creates a tax version using the provided rule_id with support for scheduled applicability and optional region-level overrides. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTaxVersion/).
|
|
193
193
|
*/
|
|
194
194
|
createTaxVersion({ ruleId, body, requestHeaders }?: CatalogPlatformValidator.CreateTaxVersionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxVersion>;
|
|
195
195
|
/**
|
|
@@ -844,9 +844,9 @@ declare class Catalog {
|
|
|
844
844
|
* @returns {Promise<CatalogPlatformModel.TaxRuleVersion>} - Success response
|
|
845
845
|
* @name getTaxVersionDetails
|
|
846
846
|
* @summary: Get tax versions for a tax rule
|
|
847
|
-
* @description: Retrieve versions of a tax rule with support for filtering by
|
|
847
|
+
* @description: Retrieve versions of a tax rule with support for filtering by status and text search on region names via the `q` parameter. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getTaxVersionDetails/).
|
|
848
848
|
*/
|
|
849
|
-
getTaxVersionDetails({ ruleId, versionStatus, limit, page, requestHeaders }?: CatalogPlatformValidator.GetTaxVersionDetailsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxRuleVersion>;
|
|
849
|
+
getTaxVersionDetails({ ruleId, versionStatus, q, limit, page, requestHeaders }?: CatalogPlatformValidator.GetTaxVersionDetailsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxRuleVersion>;
|
|
850
850
|
/**
|
|
851
851
|
* @param {CatalogPlatformValidator.GetVariantsOfProductsParam} arg - Arg object
|
|
852
852
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -1119,7 +1119,7 @@ declare class Catalog {
|
|
|
1119
1119
|
* @returns {Promise<CatalogPlatformModel.TaxVersion>} - Success response
|
|
1120
1120
|
* @name updateTaxVersion
|
|
1121
1121
|
* @summary: Update a tax version
|
|
1122
|
-
* @description: Updates a tax
|
|
1122
|
+
* @description: Updates a tax version using the provided rule_id. Scheduled versions support editing of components, applicable dates, and regional overrides while live versions allow limited updates. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateTaxVersion/).
|
|
1123
1123
|
*/
|
|
1124
1124
|
updateTaxVersion({ ruleId, versionId, body, requestHeaders }?: CatalogPlatformValidator.UpdateTaxVersionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TaxVersion>;
|
|
1125
1125
|
/**
|
|
@@ -1230,7 +1230,7 @@ class Catalog {
|
|
|
1230
1230
|
* @returns {Promise<CatalogPlatformModel.CreateTax>} - Success response
|
|
1231
1231
|
* @name createTax
|
|
1232
1232
|
* @summary: Create Tax Rule
|
|
1233
|
-
* @description: Create a tax rule and its version for under a specific company. This also creates a live version of the rule - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTax/).
|
|
1233
|
+
* @description: Create a tax rule and its version for under a specific company. This also creates a live version of the rule. The API now supports region-specific versions using optional region_type and areas along with the default country-level rule definition. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTax/).
|
|
1234
1234
|
*/
|
|
1235
1235
|
async createTax(
|
|
1236
1236
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1392,7 +1392,7 @@ class Catalog {
|
|
|
1392
1392
|
* @returns {Promise<CatalogPlatformModel.TaxVersion>} - Success response
|
|
1393
1393
|
* @name createTaxVersion
|
|
1394
1394
|
* @summary: Create a tax version
|
|
1395
|
-
* @description: Creates a tax
|
|
1395
|
+
* @description: Creates a tax version using the provided rule_id with support for scheduled applicability and optional region-level overrides. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createTaxVersion/).
|
|
1396
1396
|
*/
|
|
1397
1397
|
async createTaxVersion(
|
|
1398
1398
|
{ ruleId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5558,10 +5558,10 @@ class Catalog {
|
|
|
5558
5558
|
* @returns {Promise<CatalogPlatformModel.TaxRuleVersion>} - Success response
|
|
5559
5559
|
* @name getTaxVersionDetails
|
|
5560
5560
|
* @summary: Get tax versions for a tax rule
|
|
5561
|
-
* @description: Retrieve versions of a tax rule with support for filtering by
|
|
5561
|
+
* @description: Retrieve versions of a tax rule with support for filtering by status and text search on region names via the `q` parameter. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getTaxVersionDetails/).
|
|
5562
5562
|
*/
|
|
5563
5563
|
async getTaxVersionDetails(
|
|
5564
|
-
{ ruleId, versionStatus, limit, page, requestHeaders } = {
|
|
5564
|
+
{ ruleId, versionStatus, q, limit, page, requestHeaders } = {
|
|
5565
5565
|
requestHeaders: {},
|
|
5566
5566
|
},
|
|
5567
5567
|
{ responseHeaders } = { responseHeaders: false }
|
|
@@ -5570,6 +5570,7 @@ class Catalog {
|
|
|
5570
5570
|
{
|
|
5571
5571
|
ruleId,
|
|
5572
5572
|
versionStatus,
|
|
5573
|
+
q,
|
|
5573
5574
|
limit,
|
|
5574
5575
|
page,
|
|
5575
5576
|
},
|
|
@@ -5586,6 +5587,7 @@ class Catalog {
|
|
|
5586
5587
|
{
|
|
5587
5588
|
ruleId,
|
|
5588
5589
|
versionStatus,
|
|
5590
|
+
q,
|
|
5589
5591
|
limit,
|
|
5590
5592
|
page,
|
|
5591
5593
|
},
|
|
@@ -5600,6 +5602,7 @@ class Catalog {
|
|
|
5600
5602
|
|
|
5601
5603
|
const query_params = {};
|
|
5602
5604
|
query_params["version_status"] = versionStatus;
|
|
5605
|
+
query_params["q"] = q;
|
|
5603
5606
|
query_params["limit"] = limit;
|
|
5604
5607
|
query_params["page"] = page;
|
|
5605
5608
|
|
|
@@ -7338,7 +7341,7 @@ class Catalog {
|
|
|
7338
7341
|
* @returns {Promise<CatalogPlatformModel.TaxVersion>} - Success response
|
|
7339
7342
|
* @name updateTaxVersion
|
|
7340
7343
|
* @summary: Update a tax version
|
|
7341
|
-
* @description: Updates a tax
|
|
7344
|
+
* @description: Updates a tax version using the provided rule_id. Scheduled versions support editing of components, applicable dates, and regional overrides while live versions allow limited updates. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateTaxVersion/).
|
|
7342
7345
|
*/
|
|
7343
7346
|
async updateTaxVersion(
|
|
7344
7347
|
{ ruleId, versionId, body, requestHeaders } = { requestHeaders: {} },
|