@gofynd/fdk-client-javascript 3.11.0 → 3.12.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.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +16 -6
- package/sdk/application/Catalog/CatalogApplicationClient.js +71 -12
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +80 -80
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Cart/CartPlatformModel.d.ts +6 -18
- package/sdk/platform/Cart/CartPlatformModel.js +2 -36
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +14 -48
- package/sdk/platform/Catalog/CatalogPlatformClient.js +85 -338
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +207 -763
- package/sdk/platform/Catalog/CatalogPlatformModel.js +107 -392
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +15 -71
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +14 -60
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +36 -0
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +252 -0
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +34 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +42 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +69 -7
- package/sdk/platform/Order/OrderPlatformClient.js +453 -7
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1851 -431
- package/sdk/platform/Order/OrderPlatformModel.js +1171 -448
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +150 -16
- package/sdk/platform/Order/OrderPlatformValidator.js +105 -9
|
@@ -21,8 +21,8 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
23
|
* @typedef ApplyCouponParam
|
|
24
|
-
* @property {
|
|
25
|
-
*
|
|
24
|
+
* @property {string} [xOrderingSource] - Ordering source header, to be used to
|
|
25
|
+
* identify source of order creation.
|
|
26
26
|
* @property {boolean} [i]
|
|
27
27
|
* @property {boolean} [b]
|
|
28
28
|
* @property {boolean} [p]
|
|
@@ -33,8 +33,8 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
33
33
|
|
|
34
34
|
/**
|
|
35
35
|
* @typedef ApplyLoyaltyPointsParam
|
|
36
|
-
* @property {
|
|
37
|
-
*
|
|
36
|
+
* @property {string} [xOrderingSource] - Ordering source header, to be used to
|
|
37
|
+
* identify source of order creation.
|
|
38
38
|
* @property {string} [id] - The unique identifier of the cart.
|
|
39
39
|
* @property {boolean} [i] - Select `true` to retrieve all the items added in the cart.
|
|
40
40
|
* @property {boolean} [b] - Select `true` to retrieve the price breakup of cart items.
|
|
@@ -44,15 +44,15 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
44
44
|
|
|
45
45
|
/**
|
|
46
46
|
* @typedef CheckCartServiceabilityParam
|
|
47
|
-
* @property {
|
|
48
|
-
*
|
|
47
|
+
* @property {string} [xOrderingSource] - Ordering source header, to be used to
|
|
48
|
+
* identify source of order creation.
|
|
49
49
|
* @property {CartPlatformModel.OpenApiCartServiceabilityCreation} body
|
|
50
50
|
*/
|
|
51
51
|
|
|
52
52
|
/**
|
|
53
53
|
* @typedef CheckoutCartParam
|
|
54
|
-
* @property {
|
|
55
|
-
*
|
|
54
|
+
* @property {string} [xOrderingSource] - Ordering source header, to be used to
|
|
55
|
+
* identify source of order creation.
|
|
56
56
|
* @property {CartPlatformModel.OpenApiPlatformCheckoutReq} body
|
|
57
57
|
*/
|
|
58
58
|
|
|
@@ -89,8 +89,8 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
89
89
|
|
|
90
90
|
/**
|
|
91
91
|
* @typedef FetchAndvalidateCartItemsParam
|
|
92
|
-
* @property {
|
|
93
|
-
*
|
|
92
|
+
* @property {string} [xOrderingSource] - Ordering source header, to be used to
|
|
93
|
+
* identify source of order creation.
|
|
94
94
|
* @property {CartPlatformModel.OpenapiCartDetailsCreation} body
|
|
95
95
|
*/
|
|
96
96
|
|
|
@@ -154,8 +154,8 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
154
154
|
|
|
155
155
|
/**
|
|
156
156
|
* @typedef GetCartParam
|
|
157
|
-
* @property {
|
|
158
|
-
*
|
|
157
|
+
* @property {string} [xOrderingSource] - Ordering source header, to be used to
|
|
158
|
+
* identify source of order creation.
|
|
159
159
|
* @property {string} [id] - The unique identifier of the cart
|
|
160
160
|
* @property {string} [userId] - Option to fetch cart for the provided user_id.
|
|
161
161
|
* @property {string} [orderType] - The order type of shipment HomeDelivery - If
|
|
@@ -308,15 +308,15 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
308
308
|
|
|
309
309
|
/**
|
|
310
310
|
* @typedef OverrideCartParam
|
|
311
|
-
* @property {
|
|
312
|
-
*
|
|
311
|
+
* @property {string} [xOrderingSource] - Ordering source header, to be used to
|
|
312
|
+
* identify source of order creation.
|
|
313
313
|
* @property {CartPlatformModel.OverrideCheckoutReq} body
|
|
314
314
|
*/
|
|
315
315
|
|
|
316
316
|
/**
|
|
317
317
|
* @typedef PlatformAddItemsParam
|
|
318
|
-
* @property {
|
|
319
|
-
*
|
|
318
|
+
* @property {string} [xOrderingSource] - Ordering source header, to be used to
|
|
319
|
+
* identify source of order creation.
|
|
320
320
|
* @property {boolean} [i] - This is a boolean value. Select `true` to retrieve
|
|
321
321
|
* all the items added in the cart.
|
|
322
322
|
* @property {boolean} [b] - This is a boolean value. Select `true` to retrieve
|
|
@@ -332,24 +332,24 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
332
332
|
|
|
333
333
|
/**
|
|
334
334
|
* @typedef PlatformCheckoutCartParam
|
|
335
|
-
* @property {
|
|
336
|
-
*
|
|
335
|
+
* @property {string} [xOrderingSource] - Ordering source header, to be used to
|
|
336
|
+
* identify source of order creation.
|
|
337
337
|
* @property {string} [id] - The unique identifier of the cart
|
|
338
338
|
* @property {CartPlatformModel.PlatformCartCheckoutDetailCreation} body
|
|
339
339
|
*/
|
|
340
340
|
|
|
341
341
|
/**
|
|
342
342
|
* @typedef PlatformCheckoutCartV2Param
|
|
343
|
-
* @property {
|
|
344
|
-
*
|
|
343
|
+
* @property {string} [xOrderingSource] - Ordering source header, to be used to
|
|
344
|
+
* identify source of order creation.
|
|
345
345
|
* @property {string} [id] - The unique identifier of the cart
|
|
346
346
|
* @property {CartPlatformModel.PlatformCartCheckoutDetailV2Creation} body
|
|
347
347
|
*/
|
|
348
348
|
|
|
349
349
|
/**
|
|
350
350
|
* @typedef PlatformUpdateCartParam
|
|
351
|
-
* @property {
|
|
352
|
-
*
|
|
351
|
+
* @property {string} [xOrderingSource] - Ordering source header, to be used to
|
|
352
|
+
* identify source of order creation.
|
|
353
353
|
* @property {string} [id] - The unique identifier of the cart
|
|
354
354
|
* @property {boolean} [i] - This is a boolean value. Select `true` to retrieve
|
|
355
355
|
* all the items added in the cart.
|
|
@@ -371,8 +371,8 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
371
371
|
|
|
372
372
|
/**
|
|
373
373
|
* @typedef RemoveCouponParam
|
|
374
|
-
* @property {
|
|
375
|
-
*
|
|
374
|
+
* @property {string} [xOrderingSource] - Ordering source header, to be used to
|
|
375
|
+
* identify source of order creation.
|
|
376
376
|
* @property {string} [uid]
|
|
377
377
|
* @property {boolean} [buyNow]
|
|
378
378
|
*/
|
|
@@ -384,8 +384,8 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
384
384
|
|
|
385
385
|
/**
|
|
386
386
|
* @typedef SelectAddressParam
|
|
387
|
-
* @property {
|
|
388
|
-
*
|
|
387
|
+
* @property {string} [xOrderingSource] - Ordering source header, to be used to
|
|
388
|
+
* identify source of order creation.
|
|
389
389
|
* @property {string} [cartId]
|
|
390
390
|
* @property {boolean} [buyNow]
|
|
391
391
|
* @property {boolean} [i]
|
|
@@ -395,8 +395,8 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
395
395
|
|
|
396
396
|
/**
|
|
397
397
|
* @typedef SelectPaymentModeParam
|
|
398
|
-
* @property {
|
|
399
|
-
*
|
|
398
|
+
* @property {string} [xOrderingSource] - Ordering source header, to be used to
|
|
399
|
+
* identify source of order creation.
|
|
400
400
|
* @property {string} [id]
|
|
401
401
|
* @property {boolean} [buyNow]
|
|
402
402
|
* @property {string} [orderType]
|
|
@@ -405,8 +405,8 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
405
405
|
|
|
406
406
|
/**
|
|
407
407
|
* @typedef SelectPaymentModeV2Param
|
|
408
|
-
* @property {
|
|
409
|
-
*
|
|
408
|
+
* @property {string} [xOrderingSource] - Ordering source header, to be used to
|
|
409
|
+
* identify source of order creation.
|
|
410
410
|
* @property {string} [id]
|
|
411
411
|
* @property {boolean} [buyNow]
|
|
412
412
|
* @property {string} [orderType]
|
|
@@ -500,8 +500,8 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
500
500
|
|
|
501
501
|
/**
|
|
502
502
|
* @typedef ValidateCouponForPaymentParam
|
|
503
|
-
* @property {
|
|
504
|
-
*
|
|
503
|
+
* @property {string} [xOrderingSource] - Ordering source header, to be used to
|
|
504
|
+
* identify source of order creation.
|
|
505
505
|
* @property {string} [id]
|
|
506
506
|
* @property {boolean} [buyNow]
|
|
507
507
|
* @property {string} [addressId]
|
|
@@ -538,7 +538,7 @@ class CartPlatformApplicationValidator {
|
|
|
538
538
|
/** @returns {ApplyCouponParam} */
|
|
539
539
|
static applyCoupon() {
|
|
540
540
|
return Joi.object({
|
|
541
|
-
xOrderingSource:
|
|
541
|
+
xOrderingSource: Joi.string().allow(""),
|
|
542
542
|
|
|
543
543
|
i: Joi.boolean(),
|
|
544
544
|
b: Joi.boolean(),
|
|
@@ -552,7 +552,7 @@ class CartPlatformApplicationValidator {
|
|
|
552
552
|
/** @returns {ApplyLoyaltyPointsParam} */
|
|
553
553
|
static applyLoyaltyPoints() {
|
|
554
554
|
return Joi.object({
|
|
555
|
-
xOrderingSource:
|
|
555
|
+
xOrderingSource: Joi.string().allow(""),
|
|
556
556
|
|
|
557
557
|
id: Joi.string().allow(""),
|
|
558
558
|
i: Joi.boolean(),
|
|
@@ -565,7 +565,7 @@ class CartPlatformApplicationValidator {
|
|
|
565
565
|
/** @returns {CheckCartServiceabilityParam} */
|
|
566
566
|
static checkCartServiceability() {
|
|
567
567
|
return Joi.object({
|
|
568
|
-
xOrderingSource:
|
|
568
|
+
xOrderingSource: Joi.string().allow(""),
|
|
569
569
|
|
|
570
570
|
body: CartPlatformModel.OpenApiCartServiceabilityCreation().required(),
|
|
571
571
|
}).required();
|
|
@@ -574,7 +574,7 @@ class CartPlatformApplicationValidator {
|
|
|
574
574
|
/** @returns {CheckoutCartParam} */
|
|
575
575
|
static checkoutCart() {
|
|
576
576
|
return Joi.object({
|
|
577
|
-
xOrderingSource:
|
|
577
|
+
xOrderingSource: Joi.string().allow(""),
|
|
578
578
|
|
|
579
579
|
body: CartPlatformModel.OpenApiPlatformCheckoutReq().required(),
|
|
580
580
|
}).required();
|
|
@@ -626,7 +626,7 @@ class CartPlatformApplicationValidator {
|
|
|
626
626
|
/** @returns {FetchAndvalidateCartItemsParam} */
|
|
627
627
|
static fetchAndvalidateCartItems() {
|
|
628
628
|
return Joi.object({
|
|
629
|
-
xOrderingSource:
|
|
629
|
+
xOrderingSource: Joi.string().allow(""),
|
|
630
630
|
|
|
631
631
|
body: CartPlatformModel.OpenapiCartDetailsCreation().required(),
|
|
632
632
|
}).required();
|
|
@@ -708,7 +708,7 @@ class CartPlatformApplicationValidator {
|
|
|
708
708
|
/** @returns {GetCartParam} */
|
|
709
709
|
static getCart() {
|
|
710
710
|
return Joi.object({
|
|
711
|
-
xOrderingSource:
|
|
711
|
+
xOrderingSource: Joi.string().allow(""),
|
|
712
712
|
|
|
713
713
|
id: Joi.string().allow(""),
|
|
714
714
|
userId: Joi.string().allow(""),
|
|
@@ -887,7 +887,7 @@ class CartPlatformApplicationValidator {
|
|
|
887
887
|
/** @returns {OverrideCartParam} */
|
|
888
888
|
static overrideCart() {
|
|
889
889
|
return Joi.object({
|
|
890
|
-
xOrderingSource:
|
|
890
|
+
xOrderingSource: Joi.string().allow(""),
|
|
891
891
|
|
|
892
892
|
body: CartPlatformModel.OverrideCheckoutReq().required(),
|
|
893
893
|
}).required();
|
|
@@ -896,7 +896,7 @@ class CartPlatformApplicationValidator {
|
|
|
896
896
|
/** @returns {PlatformAddItemsParam} */
|
|
897
897
|
static platformAddItems() {
|
|
898
898
|
return Joi.object({
|
|
899
|
-
xOrderingSource:
|
|
899
|
+
xOrderingSource: Joi.string().allow(""),
|
|
900
900
|
|
|
901
901
|
i: Joi.boolean(),
|
|
902
902
|
b: Joi.boolean(),
|
|
@@ -910,7 +910,7 @@ class CartPlatformApplicationValidator {
|
|
|
910
910
|
/** @returns {PlatformCheckoutCartParam} */
|
|
911
911
|
static platformCheckoutCart() {
|
|
912
912
|
return Joi.object({
|
|
913
|
-
xOrderingSource:
|
|
913
|
+
xOrderingSource: Joi.string().allow(""),
|
|
914
914
|
|
|
915
915
|
id: Joi.string().allow(""),
|
|
916
916
|
body: CartPlatformModel.PlatformCartCheckoutDetailCreation().required(),
|
|
@@ -920,7 +920,7 @@ class CartPlatformApplicationValidator {
|
|
|
920
920
|
/** @returns {PlatformCheckoutCartV2Param} */
|
|
921
921
|
static platformCheckoutCartV2() {
|
|
922
922
|
return Joi.object({
|
|
923
|
-
xOrderingSource:
|
|
923
|
+
xOrderingSource: Joi.string().allow(""),
|
|
924
924
|
|
|
925
925
|
id: Joi.string().allow(""),
|
|
926
926
|
body: CartPlatformModel.PlatformCartCheckoutDetailV2Creation().required(),
|
|
@@ -930,7 +930,7 @@ class CartPlatformApplicationValidator {
|
|
|
930
930
|
/** @returns {PlatformUpdateCartParam} */
|
|
931
931
|
static platformUpdateCart() {
|
|
932
932
|
return Joi.object({
|
|
933
|
-
xOrderingSource:
|
|
933
|
+
xOrderingSource: Joi.string().allow(""),
|
|
934
934
|
|
|
935
935
|
id: Joi.string().allow(""),
|
|
936
936
|
i: Joi.boolean(),
|
|
@@ -952,7 +952,7 @@ class CartPlatformApplicationValidator {
|
|
|
952
952
|
/** @returns {RemoveCouponParam} */
|
|
953
953
|
static removeCoupon() {
|
|
954
954
|
return Joi.object({
|
|
955
|
-
xOrderingSource:
|
|
955
|
+
xOrderingSource: Joi.string().allow(""),
|
|
956
956
|
|
|
957
957
|
uid: Joi.string().allow(""),
|
|
958
958
|
buyNow: Joi.boolean(),
|
|
@@ -969,7 +969,7 @@ class CartPlatformApplicationValidator {
|
|
|
969
969
|
/** @returns {SelectAddressParam} */
|
|
970
970
|
static selectAddress() {
|
|
971
971
|
return Joi.object({
|
|
972
|
-
xOrderingSource:
|
|
972
|
+
xOrderingSource: Joi.string().allow(""),
|
|
973
973
|
|
|
974
974
|
cartId: Joi.string().allow(""),
|
|
975
975
|
buyNow: Joi.boolean(),
|
|
@@ -982,7 +982,7 @@ class CartPlatformApplicationValidator {
|
|
|
982
982
|
/** @returns {SelectPaymentModeParam} */
|
|
983
983
|
static selectPaymentMode() {
|
|
984
984
|
return Joi.object({
|
|
985
|
-
xOrderingSource:
|
|
985
|
+
xOrderingSource: Joi.string().allow(""),
|
|
986
986
|
|
|
987
987
|
id: Joi.string().allow(""),
|
|
988
988
|
buyNow: Joi.boolean(),
|
|
@@ -994,7 +994,7 @@ class CartPlatformApplicationValidator {
|
|
|
994
994
|
/** @returns {SelectPaymentModeV2Param} */
|
|
995
995
|
static selectPaymentModeV2() {
|
|
996
996
|
return Joi.object({
|
|
997
|
-
xOrderingSource:
|
|
997
|
+
xOrderingSource: Joi.string().allow(""),
|
|
998
998
|
|
|
999
999
|
id: Joi.string().allow(""),
|
|
1000
1000
|
buyNow: Joi.boolean(),
|
|
@@ -1110,7 +1110,7 @@ class CartPlatformApplicationValidator {
|
|
|
1110
1110
|
/** @returns {ValidateCouponForPaymentParam} */
|
|
1111
1111
|
static validateCouponForPayment() {
|
|
1112
1112
|
return Joi.object({
|
|
1113
|
-
xOrderingSource:
|
|
1113
|
+
xOrderingSource: Joi.string().allow(""),
|
|
1114
1114
|
|
|
1115
1115
|
id: Joi.string().allow(""),
|
|
1116
1116
|
buyNow: Joi.boolean(),
|
|
@@ -1289,6 +1289,7 @@ export = CartPlatformModel;
|
|
|
1289
1289
|
* @property {ProductPriceInfo} [price_per_unit]
|
|
1290
1290
|
* @property {PromoMeta} [promo_meta]
|
|
1291
1291
|
* @property {Object} [custom_order] - Whether MTO (Make to Order) is enabled or not.
|
|
1292
|
+
* @property {string} [item_type] - Type of the item in cart.
|
|
1292
1293
|
*/
|
|
1293
1294
|
/**
|
|
1294
1295
|
* @typedef OpenapiCartDetailsResult
|
|
@@ -2533,20 +2534,10 @@ export = CartPlatformModel;
|
|
|
2533
2534
|
* @property {string} message - A brief description of the error encountered.
|
|
2534
2535
|
* @property {string} field - The field in the request that caused the error.
|
|
2535
2536
|
*/
|
|
2536
|
-
/**
|
|
2537
|
-
* @typedef {| "storefront"
|
|
2538
|
-
* | "store_os_pos"
|
|
2539
|
-
* | "kiosk"
|
|
2540
|
-
* | "scan_go"
|
|
2541
|
-
* | "smart_trolley"
|
|
2542
|
-
* | "marketplace"
|
|
2543
|
-
* | "social_commerce"
|
|
2544
|
-
* | "ondc"} OrderingSource
|
|
2545
|
-
*/
|
|
2546
2537
|
declare class CartPlatformModel {
|
|
2547
2538
|
}
|
|
2548
2539
|
declare namespace CartPlatformModel {
|
|
2549
|
-
export { RedeemLoyaltyPoints, CouponDateMeta, Ownership, CouponAuthor, State, PaymentAllowValue, PaymentModes, PriceRange, PostOrder, BulkBundleRestriction, UsesRemaining, UsesRestriction, Restrictions, Validation, CouponAction, CouponSchedule, Rule, DisplayMetaDict, DisplayMeta, Identifier, Validity, RuleDefinition, CouponAdd, Page, CouponsResult, SuccessMessage, OperationErrorResult, CouponUpdate, CouponPartialUpdate, CouponCreateResult, DisplayMeta1, Ownership1, CompareObject, ItemSizeMapping, ItemCriteria, BuyRuleItemCriteria, DiscountItemCriteria, DiscountOffer, DiscountRule, PaymentAllowValue1, PromotionPaymentModes, UserRegistered, PostOrder1, UsesRemaining1, UsesRestriction1, Restrictions1, PromotionSchedule, PromotionAction, PromotionAuthor, Visibility, PromotionDateMeta, PromotionListItem, PromotionsResult, PromotionAdd, PromotionAddResult, PromotionUpdate, PromotionUpdateResult, PromotionPartialUpdate, ActivePromosResult, Charges, DeliveryCharges, CartMetaConfigUpdate, CartMetaConfigAdd, Article, PriceAdjustmentRestrictions, Collection, PriceAdjustmentUpdate, PriceAdjustment, PriceAdjustmentResult, GetPriceAdjustmentResult, PriceAdjustmentAdd, DistributionRule, Distribution, DistributionLogic, CartItem, OpenapiCartDetailsCreation, CouponBreakup, DisplayBreakup, LoyaltyPoints, RawBreakup, CartBreakup, ProductImage, Tags, BaseInfo, ActionQuery, ProductActionParams, ProductActionPage, ProductAction, CategoryInfo, CartProduct, BasePrice, ArticlePriceInfo, StoreInfo, FulfillmentOptionSchema, StoreTimingSchema, StoreHoursSchema, PickupStoreDetailSchema, ProductArticle, Ownership2, DiscountRulesApp, AppliedFreeArticles, BuyRules, AppliedPromotion, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, CouponDetails, ProductPrice, ProductPriceInfo, ProductMaxQuantityInfo, CartProductIdentifer, ProductAvailabilitySize, ProductAvailability, PromoMeta, CartProductInfo, OpenapiCartDetailsResult, OpenApiErrorResult, ShippingAddress, OpenApiCartServiceabilityCreation, OpenApiCartServiceabilityResult, OpenApiFiles, CartItemMeta, MultiTenderPaymentMeta, MultiTenderPaymentMethod, OpenApiOrderItem, OpenApiPlatformCheckoutReq, OpenApiCheckoutResult, AbandonedCart, AbandonedCartResult, PaymentSelectionLock, CartCurrency, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig, PlatformAlternatePickupPerson, CartDetailResult, AddProductCart, AddCartCreation, AddCartDetailResult, CartItemInfo, UpdateProductCart, FreeGiftItemCreation, UpdateCartCreation, UpdateCartDetailResult, OverrideCartItemPromo, OverrideCartItem, OverrideCheckoutReq, OverrideCheckoutData, OverrideCheckoutResult, GetShareCartLinkCreation, GetShareCartLinkResult, SharedCartDetails, SharedCart, SharedCartResult, CartList, MultiCartResult, UpdateUserCartMapping, UserInfo, UserCartMappingResult, PlatformAddCartDetails, PlatformUpdateCartDetails, DeleteCartDetails, DeleteCartDetailResult, CartItemCountResult, DiscountRules, Coupon, PageCoupon, GetCouponResult, ApplyCouponDetails, GeoLocation, PlatformAddress, ValidationConfig, PlatformGetAddressesDetails, SaveAddressDetails, UpdateAddressDetails, DeleteAddressResult, PlatformSelectCartAddress, ShipmentArticle, PlatformShipmentDetails, PlatformCartShipmentsResult, UpdateCartShipmentItem, UpdateCartShipmentCreation, PlatformCartMetaCreation, CartMetaDetails, CartMetaMissingDetails, StaffCheckout, CustomerDetails, Files, CartCheckoutCustomMeta, OrderTag, PlatformCartCheckoutDetailCreation, CheckCart, CartCheckoutDetails, CartCheckoutResult, CartDeliveryModesDetails, PickupStoreDetail, StoreDetails, CartPaymentUpdate, CouponValidity, PaymentCouponValidate, PaymentMeta, PaymentMethod, PlatformCartCheckoutDetailV2Creation, UpdateCartPaymentRequestV2, PriceMinMax, ItemPriceDetails, ArticlePriceDetails, FreeGiftItems, DiscountOfferRule, PromotionOffer, PromotionOffersDetails, PromotionPaymentOffer, PromotionPaymentOffersDetails, ValidationError
|
|
2540
|
+
export { RedeemLoyaltyPoints, CouponDateMeta, Ownership, CouponAuthor, State, PaymentAllowValue, PaymentModes, PriceRange, PostOrder, BulkBundleRestriction, UsesRemaining, UsesRestriction, Restrictions, Validation, CouponAction, CouponSchedule, Rule, DisplayMetaDict, DisplayMeta, Identifier, Validity, RuleDefinition, CouponAdd, Page, CouponsResult, SuccessMessage, OperationErrorResult, CouponUpdate, CouponPartialUpdate, CouponCreateResult, DisplayMeta1, Ownership1, CompareObject, ItemSizeMapping, ItemCriteria, BuyRuleItemCriteria, DiscountItemCriteria, DiscountOffer, DiscountRule, PaymentAllowValue1, PromotionPaymentModes, UserRegistered, PostOrder1, UsesRemaining1, UsesRestriction1, Restrictions1, PromotionSchedule, PromotionAction, PromotionAuthor, Visibility, PromotionDateMeta, PromotionListItem, PromotionsResult, PromotionAdd, PromotionAddResult, PromotionUpdate, PromotionUpdateResult, PromotionPartialUpdate, ActivePromosResult, Charges, DeliveryCharges, CartMetaConfigUpdate, CartMetaConfigAdd, Article, PriceAdjustmentRestrictions, Collection, PriceAdjustmentUpdate, PriceAdjustment, PriceAdjustmentResult, GetPriceAdjustmentResult, PriceAdjustmentAdd, DistributionRule, Distribution, DistributionLogic, CartItem, OpenapiCartDetailsCreation, CouponBreakup, DisplayBreakup, LoyaltyPoints, RawBreakup, CartBreakup, ProductImage, Tags, BaseInfo, ActionQuery, ProductActionParams, ProductActionPage, ProductAction, CategoryInfo, CartProduct, BasePrice, ArticlePriceInfo, StoreInfo, FulfillmentOptionSchema, StoreTimingSchema, StoreHoursSchema, PickupStoreDetailSchema, ProductArticle, Ownership2, DiscountRulesApp, AppliedFreeArticles, BuyRules, AppliedPromotion, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, CouponDetails, ProductPrice, ProductPriceInfo, ProductMaxQuantityInfo, CartProductIdentifer, ProductAvailabilitySize, ProductAvailability, PromoMeta, CartProductInfo, OpenapiCartDetailsResult, OpenApiErrorResult, ShippingAddress, OpenApiCartServiceabilityCreation, OpenApiCartServiceabilityResult, OpenApiFiles, CartItemMeta, MultiTenderPaymentMeta, MultiTenderPaymentMethod, OpenApiOrderItem, OpenApiPlatformCheckoutReq, OpenApiCheckoutResult, AbandonedCart, AbandonedCartResult, PaymentSelectionLock, CartCurrency, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig, PlatformAlternatePickupPerson, CartDetailResult, AddProductCart, AddCartCreation, AddCartDetailResult, CartItemInfo, UpdateProductCart, FreeGiftItemCreation, UpdateCartCreation, UpdateCartDetailResult, OverrideCartItemPromo, OverrideCartItem, OverrideCheckoutReq, OverrideCheckoutData, OverrideCheckoutResult, GetShareCartLinkCreation, GetShareCartLinkResult, SharedCartDetails, SharedCart, SharedCartResult, CartList, MultiCartResult, UpdateUserCartMapping, UserInfo, UserCartMappingResult, PlatformAddCartDetails, PlatformUpdateCartDetails, DeleteCartDetails, DeleteCartDetailResult, CartItemCountResult, DiscountRules, Coupon, PageCoupon, GetCouponResult, ApplyCouponDetails, GeoLocation, PlatformAddress, ValidationConfig, PlatformGetAddressesDetails, SaveAddressDetails, UpdateAddressDetails, DeleteAddressResult, PlatformSelectCartAddress, ShipmentArticle, PlatformShipmentDetails, PlatformCartShipmentsResult, UpdateCartShipmentItem, UpdateCartShipmentCreation, PlatformCartMetaCreation, CartMetaDetails, CartMetaMissingDetails, StaffCheckout, CustomerDetails, Files, CartCheckoutCustomMeta, OrderTag, PlatformCartCheckoutDetailCreation, CheckCart, CartCheckoutDetails, CartCheckoutResult, CartDeliveryModesDetails, PickupStoreDetail, StoreDetails, CartPaymentUpdate, CouponValidity, PaymentCouponValidate, PaymentMeta, PaymentMethod, PlatformCartCheckoutDetailV2Creation, UpdateCartPaymentRequestV2, PriceMinMax, ItemPriceDetails, ArticlePriceDetails, FreeGiftItems, DiscountOfferRule, PromotionOffer, PromotionOffersDetails, PromotionPaymentOffer, PromotionPaymentOffersDetails, ValidationError };
|
|
2550
2541
|
}
|
|
2551
2542
|
/** @returns {RedeemLoyaltyPoints} */
|
|
2552
2543
|
declare function RedeemLoyaltyPoints(): RedeemLoyaltyPoints;
|
|
@@ -5691,6 +5682,10 @@ type CartProductInfo = {
|
|
|
5691
5682
|
* - Whether MTO (Make to Order) is enabled or not.
|
|
5692
5683
|
*/
|
|
5693
5684
|
custom_order?: any;
|
|
5685
|
+
/**
|
|
5686
|
+
* - Type of the item in cart.
|
|
5687
|
+
*/
|
|
5688
|
+
item_type?: string;
|
|
5694
5689
|
};
|
|
5695
5690
|
/** @returns {OpenapiCartDetailsResult} */
|
|
5696
5691
|
declare function OpenapiCartDetailsResult(): OpenapiCartDetailsResult;
|
|
@@ -8904,10 +8899,3 @@ type ValidationError = {
|
|
|
8904
8899
|
*/
|
|
8905
8900
|
field: string;
|
|
8906
8901
|
};
|
|
8907
|
-
/**
|
|
8908
|
-
* Enum: OrderingSource Used By: Cart
|
|
8909
|
-
*
|
|
8910
|
-
* @returns {OrderingSource}
|
|
8911
|
-
*/
|
|
8912
|
-
declare function OrderingSource(): OrderingSource;
|
|
8913
|
-
type OrderingSource = "storefront" | "store_os_pos" | "kiosk" | "scan_go" | "smart_trolley" | "marketplace" | "social_commerce" | "ondc";
|
|
@@ -1405,6 +1405,7 @@ const Joi = require("joi");
|
|
|
1405
1405
|
* @property {ProductPriceInfo} [price_per_unit]
|
|
1406
1406
|
* @property {PromoMeta} [promo_meta]
|
|
1407
1407
|
* @property {Object} [custom_order] - Whether MTO (Make to Order) is enabled or not.
|
|
1408
|
+
* @property {string} [item_type] - Type of the item in cart.
|
|
1408
1409
|
*/
|
|
1409
1410
|
|
|
1410
1411
|
/**
|
|
@@ -2750,17 +2751,6 @@ const Joi = require("joi");
|
|
|
2750
2751
|
* @property {string} field - The field in the request that caused the error.
|
|
2751
2752
|
*/
|
|
2752
2753
|
|
|
2753
|
-
/**
|
|
2754
|
-
* @typedef {| "storefront"
|
|
2755
|
-
* | "store_os_pos"
|
|
2756
|
-
* | "kiosk"
|
|
2757
|
-
* | "scan_go"
|
|
2758
|
-
* | "smart_trolley"
|
|
2759
|
-
* | "marketplace"
|
|
2760
|
-
* | "social_commerce"
|
|
2761
|
-
* | "ondc"} OrderingSource
|
|
2762
|
-
*/
|
|
2763
|
-
|
|
2764
2754
|
class CartPlatformModel {
|
|
2765
2755
|
/** @returns {RedeemLoyaltyPoints} */
|
|
2766
2756
|
static RedeemLoyaltyPoints() {
|
|
@@ -4196,6 +4186,7 @@ class CartPlatformModel {
|
|
|
4196
4186
|
price_per_unit: CartPlatformModel.ProductPriceInfo(),
|
|
4197
4187
|
promo_meta: CartPlatformModel.PromoMeta(),
|
|
4198
4188
|
custom_order: Joi.object().pattern(/\S/, Joi.any()),
|
|
4189
|
+
item_type: Joi.string().allow(""),
|
|
4199
4190
|
});
|
|
4200
4191
|
}
|
|
4201
4192
|
|
|
@@ -5555,30 +5546,5 @@ class CartPlatformModel {
|
|
|
5555
5546
|
field: Joi.string().allow("").required(),
|
|
5556
5547
|
});
|
|
5557
5548
|
}
|
|
5558
|
-
|
|
5559
|
-
/**
|
|
5560
|
-
* Enum: OrderingSource Used By: Cart
|
|
5561
|
-
*
|
|
5562
|
-
* @returns {OrderingSource}
|
|
5563
|
-
*/
|
|
5564
|
-
static OrderingSource() {
|
|
5565
|
-
return Joi.string().valid(
|
|
5566
|
-
"storefront",
|
|
5567
|
-
|
|
5568
|
-
"store_os_pos",
|
|
5569
|
-
|
|
5570
|
-
"kiosk",
|
|
5571
|
-
|
|
5572
|
-
"scan_go",
|
|
5573
|
-
|
|
5574
|
-
"smart_trolley",
|
|
5575
|
-
|
|
5576
|
-
"marketplace",
|
|
5577
|
-
|
|
5578
|
-
"social_commerce",
|
|
5579
|
-
|
|
5580
|
-
"ondc"
|
|
5581
|
-
);
|
|
5582
|
-
}
|
|
5583
5549
|
}
|
|
5584
5550
|
module.exports = CartPlatformModel;
|
|
@@ -126,18 +126,6 @@ declare class Catalog {
|
|
|
126
126
|
* @description: Helps to create a bulk asset upload job. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createProductAssetsInBulk/).
|
|
127
127
|
*/
|
|
128
128
|
createProductAssetsInBulk({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
129
|
-
/**
|
|
130
|
-
* @param {CatalogPlatformValidator.CreateProductBundleParam} arg - Arg object
|
|
131
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
132
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
133
|
-
* @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>}
|
|
134
|
-
* - Success response
|
|
135
|
-
*
|
|
136
|
-
* @name createProductBundle
|
|
137
|
-
* @summary: Create product bundle
|
|
138
|
-
* @description: Create product bundle in the catalog associated to a specific company - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createProductBundle/).
|
|
139
|
-
*/
|
|
140
|
-
createProductBundle({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>;
|
|
141
129
|
/**
|
|
142
130
|
* @param {CatalogPlatformValidator.CreateProductExportJobParam} arg - Arg object
|
|
143
131
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -694,30 +682,6 @@ declare class Catalog {
|
|
|
694
682
|
search?: string;
|
|
695
683
|
pageSize?: number;
|
|
696
684
|
}): Paginator<CatalogPlatformModel.ProductBulkRequestList>;
|
|
697
|
-
/**
|
|
698
|
-
* @param {CatalogPlatformValidator.GetProductBundleParam} arg - Arg object
|
|
699
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
700
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
701
|
-
* @returns {Promise<CatalogPlatformModel.GetProductBundleListingResponseSchema>}
|
|
702
|
-
* - Success response
|
|
703
|
-
*
|
|
704
|
-
* @name getProductBundle
|
|
705
|
-
* @summary: List product bundles
|
|
706
|
-
* @description: Retrieve a list of product bundles available in the catalog associated to a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductBundle/).
|
|
707
|
-
*/
|
|
708
|
-
getProductBundle({ q, slug, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleListingResponseSchema>;
|
|
709
|
-
/**
|
|
710
|
-
* @param {CatalogPlatformValidator.GetProductBundleDetailParam} arg - Arg object
|
|
711
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
712
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
713
|
-
* @returns {Promise<CatalogPlatformModel.GetProductBundleResponseSchema>}
|
|
714
|
-
* - Success response
|
|
715
|
-
*
|
|
716
|
-
* @name getProductBundleDetail
|
|
717
|
-
* @summary: Get product bundle
|
|
718
|
-
* @description: Retrieve detailed information about a specific product bundle associated to a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductBundleDetail/).
|
|
719
|
-
*/
|
|
720
|
-
getProductBundleDetail({ id, requestHeaders }?: CatalogPlatformValidator.GetProductBundleDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleResponseSchema>;
|
|
721
685
|
/**
|
|
722
686
|
* @param {CatalogPlatformValidator.GetProductExportJobsParam} arg - Arg object
|
|
723
687
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -1057,6 +1021,20 @@ declare class Catalog {
|
|
|
1057
1021
|
* @description: Retrieve values related to template brand types for a specific company. The filter type query parameter defines what type of data to return. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/listTemplateBrandTypeValues/).
|
|
1058
1022
|
*/
|
|
1059
1023
|
listTemplateBrandTypeValues({ filter, templateTag, itemType, requestHeaders }?: CatalogPlatformValidator.ListTemplateBrandTypeValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductConfigurationDownloads>;
|
|
1024
|
+
/**
|
|
1025
|
+
* @param {CatalogPlatformValidator.PartialUpdateProductParam} arg - Arg object
|
|
1026
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1027
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1028
|
+
* @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
|
|
1029
|
+
* @name partialUpdateProduct
|
|
1030
|
+
* @summary: Patch a product
|
|
1031
|
+
* @description: Partially update an existing product in the catalog using PATCH method. This operation allows you to modify specific fields of a product without affecting other attributes. Only the fields provided in the request body will be updated, while all other existing product data remains unchanged.
|
|
1032
|
+
* For objects (e.g. attributes), merge keys shallowly: any key in the patch overrides the existing value.
|
|
1033
|
+
* For arrays of primitives (e.g. tags): replaced wholesale when present.
|
|
1034
|
+
* For arrays of objects (e.g. sizes): match on a unique identifier (seller_identifier) and apply the merge-patch per element; unmentioned elements remain unchanged.
|
|
1035
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/partialUpdateProduct/).
|
|
1036
|
+
*/
|
|
1037
|
+
partialUpdateProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.PartialUpdateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
|
|
1060
1038
|
/**
|
|
1061
1039
|
* @param {CatalogPlatformValidator.UpdateHsnCodeParam} arg - Arg object
|
|
1062
1040
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -1114,18 +1092,6 @@ declare class Catalog {
|
|
|
1114
1092
|
* @description: Allows to update marketplace optin for a company by marketplace_slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateMarketplaceOptin/).
|
|
1115
1093
|
*/
|
|
1116
1094
|
updateMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.UpdateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponseSchema>;
|
|
1117
|
-
/**
|
|
1118
|
-
* @param {CatalogPlatformValidator.UpdateProductBundleParam} arg - Arg object
|
|
1119
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1120
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1121
|
-
* @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>}
|
|
1122
|
-
* - Success response
|
|
1123
|
-
*
|
|
1124
|
-
* @name updateProductBundle
|
|
1125
|
-
* @summary: Update product bundle
|
|
1126
|
-
* @description: Modify the details of an existing product bundle in the catalog associated to a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateProductBundle/).
|
|
1127
|
-
*/
|
|
1128
|
-
updateProductBundle({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>;
|
|
1129
1095
|
/**
|
|
1130
1096
|
* @param {CatalogPlatformValidator.UpdateRealtimeInventoryParam} arg - Arg object
|
|
1131
1097
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|