@gofynd/fdk-client-javascript 3.0.0 → 3.1.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/Cart/CartApplicationClient.d.ts +13 -13
- package/sdk/application/Cart/CartApplicationClient.js +48 -13
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +15 -15
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +63 -16
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +105 -0
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +60 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +18 -1
- package/sdk/platform/Cart/CartPlatformModel.js +36 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6 -11
- package/sdk/platform/Catalog/CatalogPlatformModel.js +2 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformClient.js +18 -5
- package/sdk/platform/Order/OrderPlatformModel.d.ts +64 -12
- package/sdk/platform/Order/OrderPlatformModel.js +29 -7
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +28 -3
- package/sdk/platform/Order/OrderPlatformValidator.js +13 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +3 -0
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +7 -0
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +4 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -3
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +13 -3
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +8 -2
|
@@ -21,6 +21,8 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
23
|
* @typedef ApplyCouponParam
|
|
24
|
+
* @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
|
|
25
|
+
* source header, to be used to identify source of order creation.
|
|
24
26
|
* @property {boolean} [i]
|
|
25
27
|
* @property {boolean} [b]
|
|
26
28
|
* @property {boolean} [p]
|
|
@@ -31,11 +33,15 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
31
33
|
|
|
32
34
|
/**
|
|
33
35
|
* @typedef CheckCartServiceabilityParam
|
|
36
|
+
* @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
|
|
37
|
+
* source header, to be used to identify source of order creation.
|
|
34
38
|
* @property {CartPlatformModel.OpenApiCartServiceabilityCreation} body
|
|
35
39
|
*/
|
|
36
40
|
|
|
37
41
|
/**
|
|
38
42
|
* @typedef CheckoutCartParam
|
|
43
|
+
* @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
|
|
44
|
+
* source header, to be used to identify source of order creation.
|
|
39
45
|
* @property {CartPlatformModel.OpenApiPlatformCheckoutReq} body
|
|
40
46
|
*/
|
|
41
47
|
|
|
@@ -72,6 +78,8 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
72
78
|
|
|
73
79
|
/**
|
|
74
80
|
* @typedef FetchAndvalidateCartItemsParam
|
|
81
|
+
* @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
|
|
82
|
+
* source header, to be used to identify source of order creation.
|
|
75
83
|
* @property {CartPlatformModel.OpenapiCartDetailsCreation} body
|
|
76
84
|
*/
|
|
77
85
|
|
|
@@ -135,6 +143,8 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
135
143
|
|
|
136
144
|
/**
|
|
137
145
|
* @typedef GetCartParam
|
|
146
|
+
* @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
|
|
147
|
+
* source header, to be used to identify source of order creation.
|
|
138
148
|
* @property {string} [id] - The unique identifier of the cart
|
|
139
149
|
* @property {string} [userId] - Option to fetch cart for the provided user_id.
|
|
140
150
|
* @property {string} [orderType] - The order type of shipment HomeDelivery - If
|
|
@@ -283,11 +293,15 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
283
293
|
|
|
284
294
|
/**
|
|
285
295
|
* @typedef OverrideCartParam
|
|
296
|
+
* @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
|
|
297
|
+
* source header, to be used to identify source of order creation.
|
|
286
298
|
* @property {CartPlatformModel.OverrideCheckoutReq} body
|
|
287
299
|
*/
|
|
288
300
|
|
|
289
301
|
/**
|
|
290
302
|
* @typedef PlatformAddItemsParam
|
|
303
|
+
* @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
|
|
304
|
+
* source header, to be used to identify source of order creation.
|
|
291
305
|
* @property {boolean} [i] - This is a boolean value. Select `true` to retrieve
|
|
292
306
|
* all the items added in the cart.
|
|
293
307
|
* @property {boolean} [b] - This is a boolean value. Select `true` to retrieve
|
|
@@ -303,18 +317,24 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
303
317
|
|
|
304
318
|
/**
|
|
305
319
|
* @typedef PlatformCheckoutCartParam
|
|
320
|
+
* @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
|
|
321
|
+
* source header, to be used to identify source of order creation.
|
|
306
322
|
* @property {string} [id] - The unique identifier of the cart
|
|
307
323
|
* @property {CartPlatformModel.PlatformCartCheckoutDetailCreation} body
|
|
308
324
|
*/
|
|
309
325
|
|
|
310
326
|
/**
|
|
311
327
|
* @typedef PlatformCheckoutCartV2Param
|
|
328
|
+
* @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
|
|
329
|
+
* source header, to be used to identify source of order creation.
|
|
312
330
|
* @property {string} [id] - The unique identifier of the cart
|
|
313
331
|
* @property {CartPlatformModel.PlatformCartCheckoutDetailV2Creation} body
|
|
314
332
|
*/
|
|
315
333
|
|
|
316
334
|
/**
|
|
317
335
|
* @typedef PlatformUpdateCartParam
|
|
336
|
+
* @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
|
|
337
|
+
* source header, to be used to identify source of order creation.
|
|
318
338
|
* @property {string} [id] - The unique identifier of the cart
|
|
319
339
|
* @property {boolean} [i] - This is a boolean value. Select `true` to retrieve
|
|
320
340
|
* all the items added in the cart.
|
|
@@ -336,6 +356,8 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
336
356
|
|
|
337
357
|
/**
|
|
338
358
|
* @typedef RemoveCouponParam
|
|
359
|
+
* @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
|
|
360
|
+
* source header, to be used to identify source of order creation.
|
|
339
361
|
* @property {string} [uid]
|
|
340
362
|
* @property {boolean} [buyNow]
|
|
341
363
|
*/
|
|
@@ -347,6 +369,8 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
347
369
|
|
|
348
370
|
/**
|
|
349
371
|
* @typedef SelectAddressParam
|
|
372
|
+
* @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
|
|
373
|
+
* source header, to be used to identify source of order creation.
|
|
350
374
|
* @property {string} [cartId]
|
|
351
375
|
* @property {boolean} [buyNow]
|
|
352
376
|
* @property {boolean} [i]
|
|
@@ -356,6 +380,8 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
356
380
|
|
|
357
381
|
/**
|
|
358
382
|
* @typedef SelectPaymentModeParam
|
|
383
|
+
* @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
|
|
384
|
+
* source header, to be used to identify source of order creation.
|
|
359
385
|
* @property {string} [id]
|
|
360
386
|
* @property {boolean} [buyNow]
|
|
361
387
|
* @property {string} [orderType]
|
|
@@ -364,6 +390,8 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
364
390
|
|
|
365
391
|
/**
|
|
366
392
|
* @typedef SelectPaymentModeV2Param
|
|
393
|
+
* @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
|
|
394
|
+
* source header, to be used to identify source of order creation.
|
|
367
395
|
* @property {string} [id]
|
|
368
396
|
* @property {boolean} [buyNow]
|
|
369
397
|
* @property {string} [orderType]
|
|
@@ -457,6 +485,8 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
457
485
|
|
|
458
486
|
/**
|
|
459
487
|
* @typedef ValidateCouponForPaymentParam
|
|
488
|
+
* @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
|
|
489
|
+
* source header, to be used to identify source of order creation.
|
|
460
490
|
* @property {string} [id]
|
|
461
491
|
* @property {boolean} [buyNow]
|
|
462
492
|
* @property {string} [addressId]
|
|
@@ -493,6 +523,8 @@ class CartPlatformApplicationValidator {
|
|
|
493
523
|
/** @returns {ApplyCouponParam} */
|
|
494
524
|
static applyCoupon() {
|
|
495
525
|
return Joi.object({
|
|
526
|
+
xOrderingSource: CartPlatformModel.OrderingSource(),
|
|
527
|
+
|
|
496
528
|
i: Joi.boolean(),
|
|
497
529
|
b: Joi.boolean(),
|
|
498
530
|
p: Joi.boolean(),
|
|
@@ -505,6 +537,8 @@ class CartPlatformApplicationValidator {
|
|
|
505
537
|
/** @returns {CheckCartServiceabilityParam} */
|
|
506
538
|
static checkCartServiceability() {
|
|
507
539
|
return Joi.object({
|
|
540
|
+
xOrderingSource: CartPlatformModel.OrderingSource(),
|
|
541
|
+
|
|
508
542
|
body: CartPlatformModel.OpenApiCartServiceabilityCreation().required(),
|
|
509
543
|
}).required();
|
|
510
544
|
}
|
|
@@ -512,6 +546,8 @@ class CartPlatformApplicationValidator {
|
|
|
512
546
|
/** @returns {CheckoutCartParam} */
|
|
513
547
|
static checkoutCart() {
|
|
514
548
|
return Joi.object({
|
|
549
|
+
xOrderingSource: CartPlatformModel.OrderingSource(),
|
|
550
|
+
|
|
515
551
|
body: CartPlatformModel.OpenApiPlatformCheckoutReq().required(),
|
|
516
552
|
}).required();
|
|
517
553
|
}
|
|
@@ -562,6 +598,8 @@ class CartPlatformApplicationValidator {
|
|
|
562
598
|
/** @returns {FetchAndvalidateCartItemsParam} */
|
|
563
599
|
static fetchAndvalidateCartItems() {
|
|
564
600
|
return Joi.object({
|
|
601
|
+
xOrderingSource: CartPlatformModel.OrderingSource(),
|
|
602
|
+
|
|
565
603
|
body: CartPlatformModel.OpenapiCartDetailsCreation().required(),
|
|
566
604
|
}).required();
|
|
567
605
|
}
|
|
@@ -642,6 +680,8 @@ class CartPlatformApplicationValidator {
|
|
|
642
680
|
/** @returns {GetCartParam} */
|
|
643
681
|
static getCart() {
|
|
644
682
|
return Joi.object({
|
|
683
|
+
xOrderingSource: CartPlatformModel.OrderingSource(),
|
|
684
|
+
|
|
645
685
|
id: Joi.string().allow(""),
|
|
646
686
|
userId: Joi.string().allow(""),
|
|
647
687
|
orderType: Joi.string().allow(""),
|
|
@@ -816,6 +856,8 @@ class CartPlatformApplicationValidator {
|
|
|
816
856
|
/** @returns {OverrideCartParam} */
|
|
817
857
|
static overrideCart() {
|
|
818
858
|
return Joi.object({
|
|
859
|
+
xOrderingSource: CartPlatformModel.OrderingSource(),
|
|
860
|
+
|
|
819
861
|
body: CartPlatformModel.OverrideCheckoutReq().required(),
|
|
820
862
|
}).required();
|
|
821
863
|
}
|
|
@@ -823,6 +865,8 @@ class CartPlatformApplicationValidator {
|
|
|
823
865
|
/** @returns {PlatformAddItemsParam} */
|
|
824
866
|
static platformAddItems() {
|
|
825
867
|
return Joi.object({
|
|
868
|
+
xOrderingSource: CartPlatformModel.OrderingSource(),
|
|
869
|
+
|
|
826
870
|
i: Joi.boolean(),
|
|
827
871
|
b: Joi.boolean(),
|
|
828
872
|
buyNow: Joi.boolean(),
|
|
@@ -835,6 +879,8 @@ class CartPlatformApplicationValidator {
|
|
|
835
879
|
/** @returns {PlatformCheckoutCartParam} */
|
|
836
880
|
static platformCheckoutCart() {
|
|
837
881
|
return Joi.object({
|
|
882
|
+
xOrderingSource: CartPlatformModel.OrderingSource(),
|
|
883
|
+
|
|
838
884
|
id: Joi.string().allow(""),
|
|
839
885
|
body: CartPlatformModel.PlatformCartCheckoutDetailCreation().required(),
|
|
840
886
|
}).required();
|
|
@@ -843,6 +889,8 @@ class CartPlatformApplicationValidator {
|
|
|
843
889
|
/** @returns {PlatformCheckoutCartV2Param} */
|
|
844
890
|
static platformCheckoutCartV2() {
|
|
845
891
|
return Joi.object({
|
|
892
|
+
xOrderingSource: CartPlatformModel.OrderingSource(),
|
|
893
|
+
|
|
846
894
|
id: Joi.string().allow(""),
|
|
847
895
|
body: CartPlatformModel.PlatformCartCheckoutDetailV2Creation().required(),
|
|
848
896
|
}).required();
|
|
@@ -851,6 +899,8 @@ class CartPlatformApplicationValidator {
|
|
|
851
899
|
/** @returns {PlatformUpdateCartParam} */
|
|
852
900
|
static platformUpdateCart() {
|
|
853
901
|
return Joi.object({
|
|
902
|
+
xOrderingSource: CartPlatformModel.OrderingSource(),
|
|
903
|
+
|
|
854
904
|
id: Joi.string().allow(""),
|
|
855
905
|
i: Joi.boolean(),
|
|
856
906
|
orderType: Joi.string().allow(""),
|
|
@@ -871,6 +921,8 @@ class CartPlatformApplicationValidator {
|
|
|
871
921
|
/** @returns {RemoveCouponParam} */
|
|
872
922
|
static removeCoupon() {
|
|
873
923
|
return Joi.object({
|
|
924
|
+
xOrderingSource: CartPlatformModel.OrderingSource(),
|
|
925
|
+
|
|
874
926
|
uid: Joi.string().allow(""),
|
|
875
927
|
buyNow: Joi.boolean(),
|
|
876
928
|
}).required();
|
|
@@ -886,6 +938,8 @@ class CartPlatformApplicationValidator {
|
|
|
886
938
|
/** @returns {SelectAddressParam} */
|
|
887
939
|
static selectAddress() {
|
|
888
940
|
return Joi.object({
|
|
941
|
+
xOrderingSource: CartPlatformModel.OrderingSource(),
|
|
942
|
+
|
|
889
943
|
cartId: Joi.string().allow(""),
|
|
890
944
|
buyNow: Joi.boolean(),
|
|
891
945
|
i: Joi.boolean(),
|
|
@@ -897,6 +951,8 @@ class CartPlatformApplicationValidator {
|
|
|
897
951
|
/** @returns {SelectPaymentModeParam} */
|
|
898
952
|
static selectPaymentMode() {
|
|
899
953
|
return Joi.object({
|
|
954
|
+
xOrderingSource: CartPlatformModel.OrderingSource(),
|
|
955
|
+
|
|
900
956
|
id: Joi.string().allow(""),
|
|
901
957
|
buyNow: Joi.boolean(),
|
|
902
958
|
orderType: Joi.string().allow(""),
|
|
@@ -907,6 +963,8 @@ class CartPlatformApplicationValidator {
|
|
|
907
963
|
/** @returns {SelectPaymentModeV2Param} */
|
|
908
964
|
static selectPaymentModeV2() {
|
|
909
965
|
return Joi.object({
|
|
966
|
+
xOrderingSource: CartPlatformModel.OrderingSource(),
|
|
967
|
+
|
|
910
968
|
id: Joi.string().allow(""),
|
|
911
969
|
buyNow: Joi.boolean(),
|
|
912
970
|
orderType: Joi.string().allow(""),
|
|
@@ -1021,6 +1079,8 @@ class CartPlatformApplicationValidator {
|
|
|
1021
1079
|
/** @returns {ValidateCouponForPaymentParam} */
|
|
1022
1080
|
static validateCouponForPayment() {
|
|
1023
1081
|
return Joi.object({
|
|
1082
|
+
xOrderingSource: CartPlatformModel.OrderingSource(),
|
|
1083
|
+
|
|
1024
1084
|
id: Joi.string().allow(""),
|
|
1025
1085
|
buyNow: Joi.boolean(),
|
|
1026
1086
|
addressId: Joi.string().allow(""),
|
|
@@ -2307,10 +2307,20 @@ export = CartPlatformModel;
|
|
|
2307
2307
|
* @property {string} message - A brief description of the error encountered.
|
|
2308
2308
|
* @property {string} field - The field in the request that caused the error.
|
|
2309
2309
|
*/
|
|
2310
|
+
/**
|
|
2311
|
+
* @typedef {| "storefront"
|
|
2312
|
+
* | "store_os_pos"
|
|
2313
|
+
* | "kiosk"
|
|
2314
|
+
* | "scan_go"
|
|
2315
|
+
* | "smart_trolley"
|
|
2316
|
+
* | "marketplace"
|
|
2317
|
+
* | "social_commerce"
|
|
2318
|
+
* | "ondc"} OrderingSource
|
|
2319
|
+
*/
|
|
2310
2320
|
declare class CartPlatformModel {
|
|
2311
2321
|
}
|
|
2312
2322
|
declare namespace CartPlatformModel {
|
|
2313
|
-
export { 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, 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, 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, CartDetailResult, AddProductCart, AddCartCreation, AddCartDetailResult, CartItemInfo, UpdateProductCart, FreeGiftItemCreation, UpdateCartCreation, UpdateCartDetailResult, OverrideCartItemPromo, OverrideCartItem, OverrideCheckoutReq, OverrideCheckoutResult, GetShareCartLinkCreation, GetShareCartLinkResult, SharedCartDetails, SharedCart, SharedCartResult, CartList, MultiCartResult, UpdateUserCartMapping, UserInfo, UserCartMappingResult, PlatformAddCartDetails, PlatformUpdateCartDetails, DeleteCartDetails, DeleteCartDetailResult, CartItemCountResult, 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, PromotionOffer, PromotionOffersDetails, PromotionPaymentOffer, PromotionPaymentOffersDetails, ValidationError };
|
|
2323
|
+
export { 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, 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, 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, CartDetailResult, AddProductCart, AddCartCreation, AddCartDetailResult, CartItemInfo, UpdateProductCart, FreeGiftItemCreation, UpdateCartCreation, UpdateCartDetailResult, OverrideCartItemPromo, OverrideCartItem, OverrideCheckoutReq, OverrideCheckoutResult, GetShareCartLinkCreation, GetShareCartLinkResult, SharedCartDetails, SharedCart, SharedCartResult, CartList, MultiCartResult, UpdateUserCartMapping, UserInfo, UserCartMappingResult, PlatformAddCartDetails, PlatformUpdateCartDetails, DeleteCartDetails, DeleteCartDetailResult, CartItemCountResult, 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, PromotionOffer, PromotionOffersDetails, PromotionPaymentOffer, PromotionPaymentOffersDetails, ValidationError, OrderingSource };
|
|
2314
2324
|
}
|
|
2315
2325
|
/** @returns {CouponDateMeta} */
|
|
2316
2326
|
declare function CouponDateMeta(): CouponDateMeta;
|
|
@@ -8116,3 +8126,10 @@ type ValidationError = {
|
|
|
8116
8126
|
*/
|
|
8117
8127
|
field: string;
|
|
8118
8128
|
};
|
|
8129
|
+
/**
|
|
8130
|
+
* Enum: OrderingSource Used By: Cart
|
|
8131
|
+
*
|
|
8132
|
+
* @returns {OrderingSource}
|
|
8133
|
+
*/
|
|
8134
|
+
declare function OrderingSource(): OrderingSource;
|
|
8135
|
+
type OrderingSource = "storefront" | "store_os_pos" | "kiosk" | "scan_go" | "smart_trolley" | "marketplace" | "social_commerce" | "ondc";
|
|
@@ -2513,6 +2513,17 @@ const Joi = require("joi");
|
|
|
2513
2513
|
* @property {string} field - The field in the request that caused the error.
|
|
2514
2514
|
*/
|
|
2515
2515
|
|
|
2516
|
+
/**
|
|
2517
|
+
* @typedef {| "storefront"
|
|
2518
|
+
* | "store_os_pos"
|
|
2519
|
+
* | "kiosk"
|
|
2520
|
+
* | "scan_go"
|
|
2521
|
+
* | "smart_trolley"
|
|
2522
|
+
* | "marketplace"
|
|
2523
|
+
* | "social_commerce"
|
|
2524
|
+
* | "ondc"} OrderingSource
|
|
2525
|
+
*/
|
|
2526
|
+
|
|
2516
2527
|
class CartPlatformModel {
|
|
2517
2528
|
/** @returns {CouponDateMeta} */
|
|
2518
2529
|
static CouponDateMeta() {
|
|
@@ -5116,5 +5127,30 @@ class CartPlatformModel {
|
|
|
5116
5127
|
field: Joi.string().allow("").required(),
|
|
5117
5128
|
});
|
|
5118
5129
|
}
|
|
5130
|
+
|
|
5131
|
+
/**
|
|
5132
|
+
* Enum: OrderingSource Used By: Cart
|
|
5133
|
+
*
|
|
5134
|
+
* @returns {OrderingSource}
|
|
5135
|
+
*/
|
|
5136
|
+
static OrderingSource() {
|
|
5137
|
+
return Joi.string().valid(
|
|
5138
|
+
"storefront",
|
|
5139
|
+
|
|
5140
|
+
"store_os_pos",
|
|
5141
|
+
|
|
5142
|
+
"kiosk",
|
|
5143
|
+
|
|
5144
|
+
"scan_go",
|
|
5145
|
+
|
|
5146
|
+
"smart_trolley",
|
|
5147
|
+
|
|
5148
|
+
"marketplace",
|
|
5149
|
+
|
|
5150
|
+
"social_commerce",
|
|
5151
|
+
|
|
5152
|
+
"ondc"
|
|
5153
|
+
);
|
|
5154
|
+
}
|
|
5119
5155
|
}
|
|
5120
5156
|
module.exports = CartPlatformModel;
|
|
@@ -4294,7 +4294,7 @@ export = CatalogPlatformModel;
|
|
|
4294
4294
|
*/
|
|
4295
4295
|
/**
|
|
4296
4296
|
* @typedef Price1
|
|
4297
|
-
* @property {
|
|
4297
|
+
* @property {string} [currency_code] - ISO 4217 currency codes
|
|
4298
4298
|
* @property {string} [currency_symbol]
|
|
4299
4299
|
* @property {number} [max]
|
|
4300
4300
|
* @property {number} [min]
|
|
@@ -4372,11 +4372,10 @@ export = CatalogPlatformModel;
|
|
|
4372
4372
|
* | "order-status"
|
|
4373
4373
|
* | "locate-us"} PageType
|
|
4374
4374
|
*/
|
|
4375
|
-
/** @typedef {"INR" | "USD" | "EUR"} CurrencyCodeEnum */
|
|
4376
4375
|
declare class CatalogPlatformModel {
|
|
4377
4376
|
}
|
|
4378
4377
|
declare namespace CatalogPlatformModel {
|
|
4379
|
-
export { Action, ValidationErrors, AllSizes, AllowSingleRequestSchema, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponseSchema, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponseSchema, ApplicationItemMOQ, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductsSchema, ApplicationProductListingResponseSchema, ApplicationStoreJson, AppReturnConfigResponseSchema, ArticleAssignment, ArticleAssignment1, ArticleQuery, ArticleStoreResponseSchema, AssignStore, AssignStoreArticle, AttributeDetailsGroup, AttributeMaster, AttributeMasterDetails, AttributeMasterFilter, AttributeMasterMandatoryDetails, AttributeMasterMeta, AttributeMasterSchema, AttributeSchemaRange, AutoCompleteMedia, AutocompleteAction, AutocompletePageAction, AutocompleteResult, BannerImage, BaseAppCategoryReturnConfig, BaseAppCategoryReturnConfigResponseSchema, Brand, BrandItem, BrandListingResponseSchema, ApplicationBrandListingItemSchema, ApplicationBrandListingSchema, ApplicationCategoryListingSchema, ApplicationCategoryListingItemSchema, BrandMeta, InventoryBrandMeta, BulkAssetResponseSchema, BulkHsnResponseSchema, BulkHsnUpsert, BulkInventoryGet, FailedRecord, BulkInventoryGetItems, BulkProductJob, BulkJob, BulkProductRequestSchema, BulkResponseSchema, CatalogInsightBrand, CatalogInsightItem, CatalogInsightResponseSchema, CategoriesResponseSchema, Category, CategoryItems, CategoryListingResponseSchema, CategoryMapping, CategoryMappingValues, CategoryResponseSchema, Child, CollectionBadge, CollectionBanner, CollectionCreateResponseSchema, CollectionDetailResponseSchema, CollectionImage, CollectionItem, CollectionItemUpdate, CollectionListingFilter, CollectionListingFilterTag, CollectionListingFilterType, CollectionQuery, CollectionSchedule, CompanyBrandDetail, CompanyMeta, InventoryCompanyMeta, CompanyOptIn, ConfigErrorResponseSchema, ConfigSuccessResponseSchema, ConfigurationBucketPoints, ConfigurationListing, ConfigurationListingFilter, ConfigurationListingFilterConfig, ConfigurationListingFilterValue, ConfigurationListingSort, ConfigurationListingSortConfig, ConfigurationProduct, ConfigurationProductConfig, ConfigurationProductSimilar, ConfigurationProductVariant, ConfigurationProductVariantConfig, CreateAutocompleteKeyword, CreateAutocompleteWordsResponseSchema, CreateCollection, CreateSearchConfigurationRequestSchema, CreateSearchConfigurationResponseSchema, CreateSearchKeyword, CreateUpdateAppReturnConfig, CrossSellingData, CrossSellingResponseSchema, CustomOrder, DateMeta, DefaultKeyRequestSchema, DeleteAppCategoryReturnConfig, DeleteResponseSchema, DeleteSearchConfigurationResponseSchema, Department, DepartmentCategoryTree, DepartmentErrorResponseSchema, DepartmentIdentifier, DepartmentResponseSchema, DepartmentsResponseSchema, DimensionResponseSchema, InventoryDimensionResponseSchema, Document, EntityConfiguration, ErrorResponseSchema, FilerList, RawProduct, RawProductListingResponseSchema, GTIN, AttributeDetail, LatLong, ApplicationLocationAddressSchema, GetAddressSchema, GetAllSizes, GetAppCatalogConfiguration, GetAppCatalogEntityConfiguration, GetAutocompleteWordsData, GetAutocompleteWordsResponseSchema, GetCatalogConfigurationDetailsProduct, GetCatalogConfigurationDetailsSchemaListing, GetCatalogConfigurationMetaData, GetCollectionDetailNest, GetCollectionItemsResponseSchema, GetCollectionListingResponseSchema, GetCollectionQueryOptionResponseSchema, GetCompanySchema, ConditionItem, DataItem, ValueTypeItem, SortTypeItem, GetConfigMetadataResponseSchema, GetConfigMetadataValues, GetConfigResponseSchema, ConfigItem, AttributeConfig, GetDepartment, GetInventories, GetInventoriesResponseSchema, GetLocationSchema, GetOptInPlatform, GetProductBundleCreateResponseSchema, GetProductBundleListingResponseSchema, GetProductBundleResponseSchema, GetProducts, ProductDetails, GetCollectionDetailResponseSchema, CommonResponseSchemaCollection, GetQueryFiltersKeysResponseSchema, GetQueryFiltersResponseSchema, GetCollectionItemsResponseSchemaV2, Page1, CollectionItemSchemaV2, CollectionItemUpdateSchema, CollectionQuerySchemaV2, ProductDetailV2, GetSearchConfigurationResponseSchema, GetSearchWordsData, GetSearchWordsDetailResponseSchema, GetSearchWordsResponseSchema, GlobalValidation, Guide, HSNCodesResponseSchema, HSNData, CreatedBySchema, ModifiedBySchema, HSNDataInsertV2, Hierarchy, HsnCode, HsnCodesListingResponseSchemaV2, HsnCodesObject, HsnUpsert, Image, ImageUrls, InvSize, InventoryBulkRequestSchema, InventoryConfig, InventoryCreateRequestSchema, InventoryExportAdvanceOption, InventoryExportFilter, InventoryExportJob, InventoryExportJobListResponseSchema, InventoryExportQuantityFilter, InventoryExportRequestSchema, InventoryExportResponseSchema, InventoryFailedReason, InventoryJobDetailResponseSchema, InventoryJobFilters, InventoryJobPayload, InventoryPage, AddInventoryRequestPayload, InventoryPayload, InventoryRequestSchema, InventoryRequestSchemaV2, InventoryResponseSchema, InventoryResponseItem, InventoryResponsePaginated, InventorySellerIdentifierResponsePaginated, ApplicationInventorySellerIdentifierResponsePaginated, InventorySellerResponseSchema, ApplicationInventorySellerResponseSchema, InventorySet, InventoryStockResponseSchema, InventoryUpdateResponseSchema, InventoryValidationResponseSchema, InvoiceCredSchema, InvoiceDetailsSchema, ItemQuery, Items, LimitedProductData, SizeGuideItem, ListSizeGuide, LocationDayWiseSchema, LocationIntegrationType, LocationListSchema, LocationManagerSchema, LocationTimingSchema, Logo, MOQData, ManufacturerResponseSchema, InventoryManufacturerResponseSchema, Media, Media1, DepartmentMedia, BrandMedia, Meta, MetaDataListingFilterMetaResponseSchema, MetaDataListingFilterResponseSchema, MetaDataListingResponseSchema, MetaDataListingSortMetaResponseSchema, MetaDataListingSortResponseSchema, MetaFields, NetQuantity, NetQuantityResponseSchema, NextSchedule, LocationPriceRequestSchema, LocationQuantityRequestSchema, LocationPriceQuantitySuccessResponseSchema, OptInPostRequestSchema, OptinCompanyBrandDetailsView, OptinCompanyDetail, OptinCompanyMetrics, OptinStoreDetails, OwnerAppItemResponseSchema, PTErrorResponseSchema, Page, PageResponseSchema, PageResponseType, Price, ProductListingDetailPrice, PriceArticle, PriceMeta, ProdcutTemplateCategoriesResponseSchema, Product, ProductAttributesResponseSchema, ProductBrand, ProductBulkAssets, ProductBulkRequestSchema, ProductBulkRequestList, ProductBundleItem, ProductBundleRequestSchema, ProductBundleUpdateRequestSchema, ProductConfigurationDownloads, ProductUpdateSchemaV2, ProductCreateSchemaV2, ProductDetail, ProductDetailAttribute, ProductDetailGroupedAttribute, ProductDownloadsResponseSchema, CollectionProductFilters, ProductFilters, GetQueryFiltersValuesResponseSchema, ProductFiltersKeysOnly, ProductFiltersKey, ProductQueryFiltersValue, CollectionProductFiltersValue, ProductFiltersValue, CollectionProductListingDetail, ProductCategory, ApplicationCategoryAction, ApplicationCategoryItem, ApplicationProductMedia, ApplicationProductCategoryItem, CategoryPageAction, CategoryQuery, CategoryImage, ProductListingDetail, ActionObject, PageAction, ProductListingPrice, ProductListingResponseSchema, ProductListingResponseV2, ProductPublish, ProductPublished, ProductReturnConfigSchema, ProductReturnConfigBaseSchema, Identifier, SizeDetails, ProductSchemaV2, ProductSize, ProductSizeDeleteDataResponseSchema, ProductSizeDeleteResponseSchema, CollectionProductSortOn, ProductSortOn, ProductTagsViewResponseSchema, CreatedBy, ModifiedBy, ProductTemplate, ProductTemplateDownloadsExport, ProductTemplateExportFilterRequestSchema, ProductTemplateExportResponseSchema, ProductVariants, ProductVariantsResponseSchema, Properties, Quantities, QuantitiesArticle, Quantity, QuantityBase, ReturnConfig, InventoryReturnConfig, ReturnConfig2, ReturnConfigResponseSchema, Sitemap, PageQuery, ApplicationCollectionItemSeoPage, ApplicationCollectionItemSeoAction, ApplicationItemSeoAction, ApplicationItemSeoBreadcrumbs, ApplicationCollectionItemSeoBreadcrumbs, ApplicationItemSeoMetaTagItem, ApplicationItemSeoMetaTags, Metatags, SizePromotionThreshold, SEOData, SearchKeywordResult, SearchableAttribute, SecondLevelChild, SellerPhoneNumber, CollectionSeoDetail, SeoDetail, SetSize, SingleCategoryResponseSchema, SingleProductResponseSchema, Size, SizeDistribution, SizeGuideResponseSchema, StoreAssignResponseSchema, StoreDetail, StoreMeta, SuccessResponseSchema, SuccessResponseObject, TaxIdentifier, TaxSlab, TeaserTag, TemplateDetails, TemplateGlobalValidationData, TemplateValidationData, TemplatesResponseSchema, TemplatesGlobalValidationResponseSchema, TemplatesValidationResponseSchema, ThirdLevelChild, Trader, Trader1, TraderResponseSchema, UpdateCollection, UpdateSearchConfigurationRequestSchema, UpdateSearchConfigurationResponseSchema, CreateMarketplaceOptinResponseSchema, UserCommon, UserDetail, UserDetail1, UserInfo, UserSchema, RequestUserSchema, ValidateIdentifier, ValidateProduct, ValidateSizeGuide, VerifiedBy, WeightResponseSchema, InventoryWeightResponseSchema, Marketplaces, GetAllMarketplaces, UpdateMarketplaceOptinRequestSchema, UpdateMarketplaceOptinResponseSchema, Filters, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, PageType
|
|
4378
|
+
export { Action, ValidationErrors, AllSizes, AllowSingleRequestSchema, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponseSchema, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponseSchema, ApplicationItemMOQ, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductsSchema, ApplicationProductListingResponseSchema, ApplicationStoreJson, AppReturnConfigResponseSchema, ArticleAssignment, ArticleAssignment1, ArticleQuery, ArticleStoreResponseSchema, AssignStore, AssignStoreArticle, AttributeDetailsGroup, AttributeMaster, AttributeMasterDetails, AttributeMasterFilter, AttributeMasterMandatoryDetails, AttributeMasterMeta, AttributeMasterSchema, AttributeSchemaRange, AutoCompleteMedia, AutocompleteAction, AutocompletePageAction, AutocompleteResult, BannerImage, BaseAppCategoryReturnConfig, BaseAppCategoryReturnConfigResponseSchema, Brand, BrandItem, BrandListingResponseSchema, ApplicationBrandListingItemSchema, ApplicationBrandListingSchema, ApplicationCategoryListingSchema, ApplicationCategoryListingItemSchema, BrandMeta, InventoryBrandMeta, BulkAssetResponseSchema, BulkHsnResponseSchema, BulkHsnUpsert, BulkInventoryGet, FailedRecord, BulkInventoryGetItems, BulkProductJob, BulkJob, BulkProductRequestSchema, BulkResponseSchema, CatalogInsightBrand, CatalogInsightItem, CatalogInsightResponseSchema, CategoriesResponseSchema, Category, CategoryItems, CategoryListingResponseSchema, CategoryMapping, CategoryMappingValues, CategoryResponseSchema, Child, CollectionBadge, CollectionBanner, CollectionCreateResponseSchema, CollectionDetailResponseSchema, CollectionImage, CollectionItem, CollectionItemUpdate, CollectionListingFilter, CollectionListingFilterTag, CollectionListingFilterType, CollectionQuery, CollectionSchedule, CompanyBrandDetail, CompanyMeta, InventoryCompanyMeta, CompanyOptIn, ConfigErrorResponseSchema, ConfigSuccessResponseSchema, ConfigurationBucketPoints, ConfigurationListing, ConfigurationListingFilter, ConfigurationListingFilterConfig, ConfigurationListingFilterValue, ConfigurationListingSort, ConfigurationListingSortConfig, ConfigurationProduct, ConfigurationProductConfig, ConfigurationProductSimilar, ConfigurationProductVariant, ConfigurationProductVariantConfig, CreateAutocompleteKeyword, CreateAutocompleteWordsResponseSchema, CreateCollection, CreateSearchConfigurationRequestSchema, CreateSearchConfigurationResponseSchema, CreateSearchKeyword, CreateUpdateAppReturnConfig, CrossSellingData, CrossSellingResponseSchema, CustomOrder, DateMeta, DefaultKeyRequestSchema, DeleteAppCategoryReturnConfig, DeleteResponseSchema, DeleteSearchConfigurationResponseSchema, Department, DepartmentCategoryTree, DepartmentErrorResponseSchema, DepartmentIdentifier, DepartmentResponseSchema, DepartmentsResponseSchema, DimensionResponseSchema, InventoryDimensionResponseSchema, Document, EntityConfiguration, ErrorResponseSchema, FilerList, RawProduct, RawProductListingResponseSchema, GTIN, AttributeDetail, LatLong, ApplicationLocationAddressSchema, GetAddressSchema, GetAllSizes, GetAppCatalogConfiguration, GetAppCatalogEntityConfiguration, GetAutocompleteWordsData, GetAutocompleteWordsResponseSchema, GetCatalogConfigurationDetailsProduct, GetCatalogConfigurationDetailsSchemaListing, GetCatalogConfigurationMetaData, GetCollectionDetailNest, GetCollectionItemsResponseSchema, GetCollectionListingResponseSchema, GetCollectionQueryOptionResponseSchema, GetCompanySchema, ConditionItem, DataItem, ValueTypeItem, SortTypeItem, GetConfigMetadataResponseSchema, GetConfigMetadataValues, GetConfigResponseSchema, ConfigItem, AttributeConfig, GetDepartment, GetInventories, GetInventoriesResponseSchema, GetLocationSchema, GetOptInPlatform, GetProductBundleCreateResponseSchema, GetProductBundleListingResponseSchema, GetProductBundleResponseSchema, GetProducts, ProductDetails, GetCollectionDetailResponseSchema, CommonResponseSchemaCollection, GetQueryFiltersKeysResponseSchema, GetQueryFiltersResponseSchema, GetCollectionItemsResponseSchemaV2, Page1, CollectionItemSchemaV2, CollectionItemUpdateSchema, CollectionQuerySchemaV2, ProductDetailV2, GetSearchConfigurationResponseSchema, GetSearchWordsData, GetSearchWordsDetailResponseSchema, GetSearchWordsResponseSchema, GlobalValidation, Guide, HSNCodesResponseSchema, HSNData, CreatedBySchema, ModifiedBySchema, HSNDataInsertV2, Hierarchy, HsnCode, HsnCodesListingResponseSchemaV2, HsnCodesObject, HsnUpsert, Image, ImageUrls, InvSize, InventoryBulkRequestSchema, InventoryConfig, InventoryCreateRequestSchema, InventoryExportAdvanceOption, InventoryExportFilter, InventoryExportJob, InventoryExportJobListResponseSchema, InventoryExportQuantityFilter, InventoryExportRequestSchema, InventoryExportResponseSchema, InventoryFailedReason, InventoryJobDetailResponseSchema, InventoryJobFilters, InventoryJobPayload, InventoryPage, AddInventoryRequestPayload, InventoryPayload, InventoryRequestSchema, InventoryRequestSchemaV2, InventoryResponseSchema, InventoryResponseItem, InventoryResponsePaginated, InventorySellerIdentifierResponsePaginated, ApplicationInventorySellerIdentifierResponsePaginated, InventorySellerResponseSchema, ApplicationInventorySellerResponseSchema, InventorySet, InventoryStockResponseSchema, InventoryUpdateResponseSchema, InventoryValidationResponseSchema, InvoiceCredSchema, InvoiceDetailsSchema, ItemQuery, Items, LimitedProductData, SizeGuideItem, ListSizeGuide, LocationDayWiseSchema, LocationIntegrationType, LocationListSchema, LocationManagerSchema, LocationTimingSchema, Logo, MOQData, ManufacturerResponseSchema, InventoryManufacturerResponseSchema, Media, Media1, DepartmentMedia, BrandMedia, Meta, MetaDataListingFilterMetaResponseSchema, MetaDataListingFilterResponseSchema, MetaDataListingResponseSchema, MetaDataListingSortMetaResponseSchema, MetaDataListingSortResponseSchema, MetaFields, NetQuantity, NetQuantityResponseSchema, NextSchedule, LocationPriceRequestSchema, LocationQuantityRequestSchema, LocationPriceQuantitySuccessResponseSchema, OptInPostRequestSchema, OptinCompanyBrandDetailsView, OptinCompanyDetail, OptinCompanyMetrics, OptinStoreDetails, OwnerAppItemResponseSchema, PTErrorResponseSchema, Page, PageResponseSchema, PageResponseType, Price, ProductListingDetailPrice, PriceArticle, PriceMeta, ProdcutTemplateCategoriesResponseSchema, Product, ProductAttributesResponseSchema, ProductBrand, ProductBulkAssets, ProductBulkRequestSchema, ProductBulkRequestList, ProductBundleItem, ProductBundleRequestSchema, ProductBundleUpdateRequestSchema, ProductConfigurationDownloads, ProductUpdateSchemaV2, ProductCreateSchemaV2, ProductDetail, ProductDetailAttribute, ProductDetailGroupedAttribute, ProductDownloadsResponseSchema, CollectionProductFilters, ProductFilters, GetQueryFiltersValuesResponseSchema, ProductFiltersKeysOnly, ProductFiltersKey, ProductQueryFiltersValue, CollectionProductFiltersValue, ProductFiltersValue, CollectionProductListingDetail, ProductCategory, ApplicationCategoryAction, ApplicationCategoryItem, ApplicationProductMedia, ApplicationProductCategoryItem, CategoryPageAction, CategoryQuery, CategoryImage, ProductListingDetail, ActionObject, PageAction, ProductListingPrice, ProductListingResponseSchema, ProductListingResponseV2, ProductPublish, ProductPublished, ProductReturnConfigSchema, ProductReturnConfigBaseSchema, Identifier, SizeDetails, ProductSchemaV2, ProductSize, ProductSizeDeleteDataResponseSchema, ProductSizeDeleteResponseSchema, CollectionProductSortOn, ProductSortOn, ProductTagsViewResponseSchema, CreatedBy, ModifiedBy, ProductTemplate, ProductTemplateDownloadsExport, ProductTemplateExportFilterRequestSchema, ProductTemplateExportResponseSchema, ProductVariants, ProductVariantsResponseSchema, Properties, Quantities, QuantitiesArticle, Quantity, QuantityBase, ReturnConfig, InventoryReturnConfig, ReturnConfig2, ReturnConfigResponseSchema, Sitemap, PageQuery, ApplicationCollectionItemSeoPage, ApplicationCollectionItemSeoAction, ApplicationItemSeoAction, ApplicationItemSeoBreadcrumbs, ApplicationCollectionItemSeoBreadcrumbs, ApplicationItemSeoMetaTagItem, ApplicationItemSeoMetaTags, Metatags, SizePromotionThreshold, SEOData, SearchKeywordResult, SearchableAttribute, SecondLevelChild, SellerPhoneNumber, CollectionSeoDetail, SeoDetail, SetSize, SingleCategoryResponseSchema, SingleProductResponseSchema, Size, SizeDistribution, SizeGuideResponseSchema, StoreAssignResponseSchema, StoreDetail, StoreMeta, SuccessResponseSchema, SuccessResponseObject, TaxIdentifier, TaxSlab, TeaserTag, TemplateDetails, TemplateGlobalValidationData, TemplateValidationData, TemplatesResponseSchema, TemplatesGlobalValidationResponseSchema, TemplatesValidationResponseSchema, ThirdLevelChild, Trader, Trader1, TraderResponseSchema, UpdateCollection, UpdateSearchConfigurationRequestSchema, UpdateSearchConfigurationResponseSchema, CreateMarketplaceOptinResponseSchema, UserCommon, UserDetail, UserDetail1, UserInfo, UserSchema, RequestUserSchema, ValidateIdentifier, ValidateProduct, ValidateSizeGuide, VerifiedBy, WeightResponseSchema, InventoryWeightResponseSchema, Marketplaces, GetAllMarketplaces, UpdateMarketplaceOptinRequestSchema, UpdateMarketplaceOptinResponseSchema, Filters, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, PageType };
|
|
4380
4379
|
}
|
|
4381
4380
|
/** @returns {Action} */
|
|
4382
4381
|
declare function Action(): Action;
|
|
@@ -13687,7 +13686,10 @@ type ValidationError = {
|
|
|
13687
13686
|
/** @returns {Price1} */
|
|
13688
13687
|
declare function Price1(): Price1;
|
|
13689
13688
|
type Price1 = {
|
|
13690
|
-
|
|
13689
|
+
/**
|
|
13690
|
+
* - ISO 4217 currency codes
|
|
13691
|
+
*/
|
|
13692
|
+
currency_code?: string;
|
|
13691
13693
|
currency_symbol?: string;
|
|
13692
13694
|
max?: number;
|
|
13693
13695
|
min?: number;
|
|
@@ -13752,10 +13754,3 @@ type CustomMeta = {
|
|
|
13752
13754
|
*/
|
|
13753
13755
|
declare function PageType(): PageType;
|
|
13754
13756
|
type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us";
|
|
13755
|
-
/**
|
|
13756
|
-
* Enum: CurrencyCodeEnum Used By: Catalog
|
|
13757
|
-
*
|
|
13758
|
-
* @returns {CurrencyCodeEnum}
|
|
13759
|
-
*/
|
|
13760
|
-
declare function CurrencyCodeEnum(): CurrencyCodeEnum;
|
|
13761
|
-
type CurrencyCodeEnum = "INR" | "USD" | "EUR";
|
|
@@ -4706,7 +4706,7 @@ const Joi = require("joi");
|
|
|
4706
4706
|
|
|
4707
4707
|
/**
|
|
4708
4708
|
* @typedef Price1
|
|
4709
|
-
* @property {
|
|
4709
|
+
* @property {string} [currency_code] - ISO 4217 currency codes
|
|
4710
4710
|
* @property {string} [currency_symbol]
|
|
4711
4711
|
* @property {number} [max]
|
|
4712
4712
|
* @property {number} [min]
|
|
@@ -4789,8 +4789,6 @@ const Joi = require("joi");
|
|
|
4789
4789
|
* | "locate-us"} PageType
|
|
4790
4790
|
*/
|
|
4791
4791
|
|
|
4792
|
-
/** @typedef {"INR" | "USD" | "EUR"} CurrencyCodeEnum */
|
|
4793
|
-
|
|
4794
4792
|
class CatalogPlatformModel {
|
|
4795
4793
|
/** @returns {Action} */
|
|
4796
4794
|
static Action() {
|
|
@@ -9830,7 +9828,7 @@ class CatalogPlatformModel {
|
|
|
9830
9828
|
/** @returns {Price1} */
|
|
9831
9829
|
static Price1() {
|
|
9832
9830
|
return Joi.object({
|
|
9833
|
-
currency_code:
|
|
9831
|
+
currency_code: Joi.string().allow(""),
|
|
9834
9832
|
currency_symbol: Joi.string().allow(""),
|
|
9835
9833
|
max: Joi.number(),
|
|
9836
9834
|
min: Joi.number(),
|
|
@@ -9968,20 +9966,5 @@ class CatalogPlatformModel {
|
|
|
9968
9966
|
"locate-us"
|
|
9969
9967
|
);
|
|
9970
9968
|
}
|
|
9971
|
-
|
|
9972
|
-
/**
|
|
9973
|
-
* Enum: CurrencyCodeEnum Used By: Catalog
|
|
9974
|
-
*
|
|
9975
|
-
* @returns {CurrencyCodeEnum}
|
|
9976
|
-
*/
|
|
9977
|
-
static CurrencyCodeEnum() {
|
|
9978
|
-
return Joi.string().valid(
|
|
9979
|
-
"INR",
|
|
9980
|
-
|
|
9981
|
-
"USD",
|
|
9982
|
-
|
|
9983
|
-
"EUR"
|
|
9984
|
-
);
|
|
9985
|
-
}
|
|
9986
9969
|
}
|
|
9987
9970
|
module.exports = CatalogPlatformModel;
|
|
@@ -77,7 +77,7 @@ declare class Order {
|
|
|
77
77
|
* @summary: Create order
|
|
78
78
|
* @description: Creates an order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createOrder/).
|
|
79
79
|
*/
|
|
80
|
-
createOrder({ body, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateOrderResponseSchema>;
|
|
80
|
+
createOrder({ body, xOrderingSource, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateOrderResponseSchema>;
|
|
81
81
|
/**
|
|
82
82
|
* @param {OrderPlatformValidator.DispatchManifestsParam} arg - Arg object
|
|
83
83
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -195,7 +195,7 @@ declare class Order {
|
|
|
195
195
|
* @summary: Get allowed state transition
|
|
196
196
|
* @description: Retrieve next possible states based on logged in user's role - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedStateTransition/).
|
|
197
197
|
*/
|
|
198
|
-
getAllowedStateTransition({ orderingChannel,
|
|
198
|
+
getAllowedStateTransition({ status, orderingChannel, orderingSource, requestHeaders }?: OrderPlatformValidator.GetAllowedStateTransitionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RoleBaseStateTransitionMapping>;
|
|
199
199
|
/**
|
|
200
200
|
* @param {OrderPlatformValidator.GetAllowedTemplatesForBulkParam} arg - Arg object
|
|
201
201
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -624,7 +624,7 @@ declare class Order {
|
|
|
624
624
|
* The ESM config stores order processing configuration. Each document in the ESM config collection of Order Management System - OMS's database is a JSON object representing the configuration of a specific application ID. This includes filters, hooks, flags set on different state-transitions. This configuration is picked and accordingly features are enabled.
|
|
625
625
|
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateManagerConfig/).
|
|
626
626
|
*/
|
|
627
|
-
getStateManagerConfig({ appId, orderingChannel, entity, requestHeaders }?: OrderPlatformValidator.GetStateManagerConfigParam, { responseHeaders }?: object): Promise<any>;
|
|
627
|
+
getStateManagerConfig({ appId, orderingChannel, orderingSource, entity, requestHeaders }?: OrderPlatformValidator.GetStateManagerConfigParam, { responseHeaders }?: object): Promise<any>;
|
|
628
628
|
/**
|
|
629
629
|
* @param {OrderPlatformValidator.GetStateTransitionMapParam} arg - Arg object
|
|
630
630
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -530,12 +530,13 @@ class Order {
|
|
|
530
530
|
* @description: Creates an order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createOrder/).
|
|
531
531
|
*/
|
|
532
532
|
async createOrder(
|
|
533
|
-
{ body, requestHeaders } = { requestHeaders: {} },
|
|
533
|
+
{ body, xOrderingSource, requestHeaders } = { requestHeaders: {} },
|
|
534
534
|
{ responseHeaders } = { responseHeaders: false }
|
|
535
535
|
) {
|
|
536
536
|
const { error } = OrderPlatformValidator.createOrder().validate(
|
|
537
537
|
{
|
|
538
538
|
body,
|
|
539
|
+
xOrderingSource,
|
|
539
540
|
},
|
|
540
541
|
{ abortEarly: false, allowUnknown: true }
|
|
541
542
|
);
|
|
@@ -547,6 +548,7 @@ class Order {
|
|
|
547
548
|
const { error: warrning } = OrderPlatformValidator.createOrder().validate(
|
|
548
549
|
{
|
|
549
550
|
body,
|
|
551
|
+
xOrderingSource,
|
|
550
552
|
},
|
|
551
553
|
{ abortEarly: false, allowUnknown: false }
|
|
552
554
|
);
|
|
@@ -560,6 +562,7 @@ class Order {
|
|
|
560
562
|
const query_params = {};
|
|
561
563
|
|
|
562
564
|
const xHeaders = {};
|
|
565
|
+
xHeaders["x-ordering-source"] = xOrderingSource;
|
|
563
566
|
|
|
564
567
|
const response = await PlatformAPIClient.execute(
|
|
565
568
|
this.config,
|
|
@@ -1438,15 +1441,18 @@ class Order {
|
|
|
1438
1441
|
* @description: Retrieve next possible states based on logged in user's role - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedStateTransition/).
|
|
1439
1442
|
*/
|
|
1440
1443
|
async getAllowedStateTransition(
|
|
1441
|
-
{ orderingChannel,
|
|
1444
|
+
{ status, orderingChannel, orderingSource, requestHeaders } = {
|
|
1445
|
+
requestHeaders: {},
|
|
1446
|
+
},
|
|
1442
1447
|
{ responseHeaders } = { responseHeaders: false }
|
|
1443
1448
|
) {
|
|
1444
1449
|
const {
|
|
1445
1450
|
error,
|
|
1446
1451
|
} = OrderPlatformValidator.getAllowedStateTransition().validate(
|
|
1447
1452
|
{
|
|
1448
|
-
orderingChannel,
|
|
1449
1453
|
status,
|
|
1454
|
+
orderingChannel,
|
|
1455
|
+
orderingSource,
|
|
1450
1456
|
},
|
|
1451
1457
|
{ abortEarly: false, allowUnknown: true }
|
|
1452
1458
|
);
|
|
@@ -1459,8 +1465,9 @@ class Order {
|
|
|
1459
1465
|
error: warrning,
|
|
1460
1466
|
} = OrderPlatformValidator.getAllowedStateTransition().validate(
|
|
1461
1467
|
{
|
|
1462
|
-
orderingChannel,
|
|
1463
1468
|
status,
|
|
1469
|
+
orderingChannel,
|
|
1470
|
+
orderingSource,
|
|
1464
1471
|
},
|
|
1465
1472
|
{ abortEarly: false, allowUnknown: false }
|
|
1466
1473
|
);
|
|
@@ -1473,6 +1480,7 @@ class Order {
|
|
|
1473
1480
|
|
|
1474
1481
|
const query_params = {};
|
|
1475
1482
|
query_params["ordering_channel"] = orderingChannel;
|
|
1483
|
+
query_params["ordering_source"] = orderingSource;
|
|
1476
1484
|
query_params["status"] = status;
|
|
1477
1485
|
|
|
1478
1486
|
const xHeaders = {};
|
|
@@ -3958,13 +3966,16 @@ class Order {
|
|
|
3958
3966
|
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateManagerConfig/).
|
|
3959
3967
|
*/
|
|
3960
3968
|
async getStateManagerConfig(
|
|
3961
|
-
{ appId, orderingChannel, entity, requestHeaders } = {
|
|
3969
|
+
{ appId, orderingChannel, orderingSource, entity, requestHeaders } = {
|
|
3970
|
+
requestHeaders: {},
|
|
3971
|
+
},
|
|
3962
3972
|
{ responseHeaders } = { responseHeaders: false }
|
|
3963
3973
|
) {
|
|
3964
3974
|
const { error } = OrderPlatformValidator.getStateManagerConfig().validate(
|
|
3965
3975
|
{
|
|
3966
3976
|
appId,
|
|
3967
3977
|
orderingChannel,
|
|
3978
|
+
orderingSource,
|
|
3968
3979
|
entity,
|
|
3969
3980
|
},
|
|
3970
3981
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -3980,6 +3991,7 @@ class Order {
|
|
|
3980
3991
|
{
|
|
3981
3992
|
appId,
|
|
3982
3993
|
orderingChannel,
|
|
3994
|
+
orderingSource,
|
|
3983
3995
|
entity,
|
|
3984
3996
|
},
|
|
3985
3997
|
{ abortEarly: false, allowUnknown: false }
|
|
@@ -3994,6 +4006,7 @@ class Order {
|
|
|
3994
4006
|
const query_params = {};
|
|
3995
4007
|
query_params["app_id"] = appId;
|
|
3996
4008
|
query_params["ordering_channel"] = orderingChannel;
|
|
4009
|
+
query_params["ordering_source"] = orderingSource;
|
|
3997
4010
|
query_params["entity"] = entity;
|
|
3998
4011
|
|
|
3999
4012
|
const xHeaders = {};
|