@gofynd/fdk-client-javascript 3.10.0 → 3.11.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/common/Constant.d.ts +5 -0
- package/sdk/common/Constant.js +5 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +3 -2
- package/sdk/partner/Theme/ThemePartnerModel.js +5 -2
- package/sdk/platform/Cart/CartPlatformModel.d.ts +188 -18
- package/sdk/platform/Cart/CartPlatformModel.js +101 -10
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +3 -2
- package/sdk/platform/Catalog/CatalogPlatformModel.js +5 -2
- package/sdk/platform/Content/ContentPlatformModel.d.ts +3 -2
- package/sdk/platform/Content/ContentPlatformModel.js +5 -2
- package/sdk/platform/Order/OrderPlatformClient.d.ts +1 -1
- package/sdk/platform/Order/OrderPlatformClient.js +1 -1
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +3 -2
- package/sdk/platform/Theme/ThemePlatformModel.js +5 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +2 -2
- package/sdk/platform/User/UserPlatformModel.js +2 -2
- package/utility.d.ts +3 -0
- package/utility.js +7 -0
package/README.md
CHANGED
|
@@ -234,7 +234,7 @@ console.log("Active Theme: ", response.information.name);
|
|
|
234
234
|
The above code will log the curl command in the console
|
|
235
235
|
|
|
236
236
|
```bash
|
|
237
|
-
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.
|
|
237
|
+
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.11.0' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
|
|
238
238
|
Active Theme: Emerge
|
|
239
239
|
```
|
|
240
240
|
|
package/package.json
CHANGED
package/sdk/common/Constant.d.ts
CHANGED
|
@@ -47,6 +47,7 @@ export namespace AVAILABLE_PAGE_TYPE {
|
|
|
47
47
|
const RETURN_POLICY: string;
|
|
48
48
|
const ORDER_STATUS: string;
|
|
49
49
|
const LOCATE_US: string;
|
|
50
|
+
const SINGLE_PAGE_CHECKOUT: string;
|
|
50
51
|
}
|
|
51
52
|
export const NAVIGATORS: {
|
|
52
53
|
"about-us": {
|
|
@@ -301,4 +302,8 @@ export const NAVIGATORS: {
|
|
|
301
302
|
name: string;
|
|
302
303
|
link: string;
|
|
303
304
|
};
|
|
305
|
+
"single-page-checkout": {
|
|
306
|
+
name: string;
|
|
307
|
+
link: string;
|
|
308
|
+
};
|
|
304
309
|
};
|
package/sdk/common/Constant.js
CHANGED
|
@@ -47,6 +47,7 @@ const AVAILABLE_PAGE_TYPE = {
|
|
|
47
47
|
RETURN_POLICY: "return-policy",
|
|
48
48
|
ORDER_STATUS: "order-status",
|
|
49
49
|
LOCATE_US: "locate-us",
|
|
50
|
+
SINGLE_PAGE_CHECKOUT: "single-page-checkout",
|
|
50
51
|
};
|
|
51
52
|
|
|
52
53
|
Object.freeze(AVAILABLE_PAGE_TYPE);
|
|
@@ -334,6 +335,10 @@ const NAVIGATORS = {
|
|
|
334
335
|
name: "Locate us",
|
|
335
336
|
link: "/locate-us",
|
|
336
337
|
},
|
|
338
|
+
"single-page-checkout": {
|
|
339
|
+
name: "Single Page Checkout",
|
|
340
|
+
link: "/cart/checkout",
|
|
341
|
+
},
|
|
337
342
|
};
|
|
338
343
|
|
|
339
344
|
module.exports = {
|
|
@@ -673,7 +673,8 @@ export = ThemePartnerModel;
|
|
|
673
673
|
* | "shipping-policy"
|
|
674
674
|
* | "return-policy"
|
|
675
675
|
* | "order-status"
|
|
676
|
-
* | "locate-us"
|
|
676
|
+
* | "locate-us"
|
|
677
|
+
* | "single-page-checkout"} PageType
|
|
677
678
|
*/
|
|
678
679
|
declare class ThemePartnerModel {
|
|
679
680
|
}
|
|
@@ -1895,4 +1896,4 @@ type ActionPage = {
|
|
|
1895
1896
|
* @returns {PageType}
|
|
1896
1897
|
*/
|
|
1897
1898
|
declare function PageType(): PageType;
|
|
1898
|
-
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";
|
|
1899
|
+
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" | "single-page-checkout";
|
|
@@ -765,7 +765,8 @@ const Joi = require("joi");
|
|
|
765
765
|
* | "shipping-policy"
|
|
766
766
|
* | "return-policy"
|
|
767
767
|
* | "order-status"
|
|
768
|
-
* | "locate-us"
|
|
768
|
+
* | "locate-us"
|
|
769
|
+
* | "single-page-checkout"} PageType
|
|
769
770
|
*/
|
|
770
771
|
|
|
771
772
|
class ThemePartnerModel {
|
|
@@ -1774,7 +1775,9 @@ class ThemePartnerModel {
|
|
|
1774
1775
|
|
|
1775
1776
|
"order-status",
|
|
1776
1777
|
|
|
1777
|
-
"locate-us"
|
|
1778
|
+
"locate-us",
|
|
1779
|
+
|
|
1780
|
+
"single-page-checkout"
|
|
1778
1781
|
);
|
|
1779
1782
|
}
|
|
1780
1783
|
}
|
|
@@ -331,8 +331,8 @@ export = CartPlatformModel;
|
|
|
331
331
|
* @property {CompareObject} [cart_quantity]
|
|
332
332
|
* @property {string[]} [available_zones] - List of all zones on which promotion
|
|
333
333
|
* is applicable
|
|
334
|
-
* @property {number[]} [item_exclude_company] - List of all company
|
|
335
|
-
* promotion is not applicable
|
|
334
|
+
* @property {number[]} [item_exclude_company] - List of all company ids on
|
|
335
|
+
* which promotion is not applicable
|
|
336
336
|
* @property {number[]} [item_id] - List of all item ids on which promotion is applicable
|
|
337
337
|
* @property {number[]} [item_l1_category] - List of all L1 category on which
|
|
338
338
|
* promotion is applicable
|
|
@@ -353,8 +353,8 @@ export = CartPlatformModel;
|
|
|
353
353
|
* promotion is not applicable
|
|
354
354
|
* @property {number[]} [item_department] - List of all departments ids on which
|
|
355
355
|
* promotion is applicable
|
|
356
|
-
* @property {number[]} [item_exclude_store] - List of all
|
|
357
|
-
*
|
|
356
|
+
* @property {number[]} [item_exclude_store] - List of all store ids on which
|
|
357
|
+
* promotion is not applicable
|
|
358
358
|
* @property {number[]} [item_brand] - List of all brand ids on which promotion
|
|
359
359
|
* is applicable
|
|
360
360
|
* @property {number[]} [item_exclude_department] - List of all department ids
|
|
@@ -377,10 +377,46 @@ export = CartPlatformModel;
|
|
|
377
377
|
* @property {string[]} [item_sku] - List of all item sku on which promotion is applicable
|
|
378
378
|
* @property {ItemSizeMapping} [meta]
|
|
379
379
|
*/
|
|
380
|
+
/**
|
|
381
|
+
* @typedef DiscountItemCriteria
|
|
382
|
+
* @property {number[]} [item_store] - List of all store ids on which promotion
|
|
383
|
+
* is applicable
|
|
384
|
+
* @property {number[]} [item_company] - List of all company ids on which
|
|
385
|
+
* promotion is applicable
|
|
386
|
+
* @property {number[]} [item_brand] - List of all brand ids on which promotion
|
|
387
|
+
* is applicable
|
|
388
|
+
* @property {number[]} [item_exclude_brand] - List of all brand ids on which
|
|
389
|
+
* promotion is not applicable
|
|
390
|
+
* @property {number[]} [item_category] - List of all L3 category on which
|
|
391
|
+
* promotion is applicable
|
|
392
|
+
* @property {number[]} [item_exclude_category] - List of all L3 category on
|
|
393
|
+
* which promotion is not applicable
|
|
394
|
+
* @property {number[]} [item_l1_category] - List of all L1 category on which
|
|
395
|
+
* promotion is applicable
|
|
396
|
+
* @property {number[]} [item_exclude_l1_category] - List of all item ids on
|
|
397
|
+
* which promotion is not applicable
|
|
398
|
+
* @property {number[]} [item_l2_category] - List of all L2 category on which
|
|
399
|
+
* promotion is applicable
|
|
400
|
+
* @property {number[]} [item_exclude_l2_category] - List of all L2 category on
|
|
401
|
+
* which promotion is not applicable
|
|
402
|
+
* @property {number[]} [item_department] - List of all departments ids on which
|
|
403
|
+
* promotion is applicable
|
|
404
|
+
* @property {number[]} [item_exclude_department] - List of all department ids
|
|
405
|
+
* on which promotion is not applicable
|
|
406
|
+
* @property {number[]} [item_id] - List of all item ids on which promotion is applicable
|
|
407
|
+
* @property {number[]} [item_exclude_id] - List of all item ids on which
|
|
408
|
+
* promotion is not applicable
|
|
409
|
+
* @property {string[]} [buy_rules] - Buy rules that apply to this discount
|
|
410
|
+
* @property {string[]} [available_zones] - List of all zones ids on which
|
|
411
|
+
* promotion is applicable
|
|
412
|
+
* @property {string[]} [product_tags] - Product tags that qualify for the discount
|
|
413
|
+
* @property {boolean} [all_items] - Whether the discount applies to all items
|
|
414
|
+
*/
|
|
380
415
|
/**
|
|
381
416
|
* @typedef DiscountOffer
|
|
382
417
|
* @property {number} [max_discount_amount] - Maximum discount amount in promotion
|
|
383
|
-
* @property {number} [discount_price] - Discount price
|
|
418
|
+
* @property {number} [discount_price] - Discount price which is price after
|
|
419
|
+
* deducting discount amount in fixed price promotion
|
|
384
420
|
* @property {boolean} [apportion_discount] - Flag to distribute discount for each article
|
|
385
421
|
* @property {boolean} [partial_can_ret] - Flag indicated return the product partially
|
|
386
422
|
* @property {number} [max_usage_per_transaction] - Maximum usage per
|
|
@@ -390,6 +426,8 @@ export = CartPlatformModel;
|
|
|
390
426
|
* @property {number} [discount_amount] - Discount amount in promotion
|
|
391
427
|
* @property {number} [discount_percentage] - Discount percentage in promotion
|
|
392
428
|
* @property {number} [max_offer_quantity] - Maximum quantity of product in promotion
|
|
429
|
+
* @property {number} [item_sequence_number] - Cart sequence number of item for
|
|
430
|
+
* which offer is valid
|
|
393
431
|
*/
|
|
394
432
|
/**
|
|
395
433
|
* @typedef DiscountRule
|
|
@@ -2439,17 +2477,30 @@ export = CartPlatformModel;
|
|
|
2439
2477
|
* @property {string} [size] - Selected size for the free gift item.
|
|
2440
2478
|
* @property {string[]} [item_images_url] - List of free gift product images URL
|
|
2441
2479
|
*/
|
|
2480
|
+
/**
|
|
2481
|
+
* @typedef DiscountOfferRule
|
|
2482
|
+
* @property {string} [discount_type] - Discount offer type of the promotion
|
|
2483
|
+
* @property {DiscountOffer} [offer]
|
|
2484
|
+
* @property {DiscountItemCriteria} [item_criteria]
|
|
2485
|
+
* @property {string} [buy_condition] - Logical condition expression for buy rules
|
|
2486
|
+
* @property {number} [discounted_price] - Price of product after applying this
|
|
2487
|
+
* discount rule of promotion. Note - returned only when store id is provided
|
|
2488
|
+
* in request params.
|
|
2489
|
+
* @property {string[]} [matched_buy_rules] - List of buy rules that are
|
|
2490
|
+
* matching with item for this promotion
|
|
2491
|
+
* @property {ItemSizeMapping} [meta]
|
|
2492
|
+
*/
|
|
2442
2493
|
/**
|
|
2443
2494
|
* @typedef PromotionOffer
|
|
2444
2495
|
* @property {string} [id] - Promotion unique identifier
|
|
2445
|
-
* @property {
|
|
2496
|
+
* @property {BuyRuleItemCriteria} [buy_rules]
|
|
2446
2497
|
* @property {string} [offer_text] - Offer title of promotion that used to display
|
|
2447
2498
|
* @property {string} [promotion_type] - Type of Promotion like percentage,
|
|
2448
2499
|
* amount, bogo etc.
|
|
2449
2500
|
* @property {string} [promotion_name] - Name of the promotion
|
|
2450
2501
|
* @property {string} [promotion_group] - Group of promotion belongs to
|
|
2451
2502
|
* @property {string} [valid_till] - Datetime ISOString for promotion end date
|
|
2452
|
-
* @property {
|
|
2503
|
+
* @property {DiscountOfferRule[]} [discount_rules] - Discount rules of promotions
|
|
2453
2504
|
* @property {FreeGiftItems[]} [free_gift_items] - Details of free gift items
|
|
2454
2505
|
* @property {string} [description] - Offer details including T&C
|
|
2455
2506
|
*/
|
|
@@ -2495,7 +2546,7 @@ export = CartPlatformModel;
|
|
|
2495
2546
|
declare class CartPlatformModel {
|
|
2496
2547
|
}
|
|
2497
2548
|
declare namespace CartPlatformModel {
|
|
2498
|
-
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, 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, PromotionOffer, PromotionOffersDetails, PromotionPaymentOffer, PromotionPaymentOffersDetails, ValidationError, OrderingSource };
|
|
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, OrderingSource };
|
|
2499
2550
|
}
|
|
2500
2551
|
/** @returns {RedeemLoyaltyPoints} */
|
|
2501
2552
|
declare function RedeemLoyaltyPoints(): RedeemLoyaltyPoints;
|
|
@@ -3286,8 +3337,8 @@ type BuyRuleItemCriteria = {
|
|
|
3286
3337
|
*/
|
|
3287
3338
|
available_zones?: string[];
|
|
3288
3339
|
/**
|
|
3289
|
-
* - List of all company
|
|
3290
|
-
* promotion is not applicable
|
|
3340
|
+
* - List of all company ids on
|
|
3341
|
+
* which promotion is not applicable
|
|
3291
3342
|
*/
|
|
3292
3343
|
item_exclude_company?: number[];
|
|
3293
3344
|
/**
|
|
@@ -3338,8 +3389,8 @@ type BuyRuleItemCriteria = {
|
|
|
3338
3389
|
*/
|
|
3339
3390
|
item_department?: number[];
|
|
3340
3391
|
/**
|
|
3341
|
-
* - List of all
|
|
3342
|
-
*
|
|
3392
|
+
* - List of all store ids on which
|
|
3393
|
+
* promotion is not applicable
|
|
3343
3394
|
*/
|
|
3344
3395
|
item_exclude_store?: number[];
|
|
3345
3396
|
/**
|
|
@@ -3394,6 +3445,96 @@ type BuyRuleItemCriteria = {
|
|
|
3394
3445
|
item_sku?: string[];
|
|
3395
3446
|
meta?: ItemSizeMapping;
|
|
3396
3447
|
};
|
|
3448
|
+
/** @returns {DiscountItemCriteria} */
|
|
3449
|
+
declare function DiscountItemCriteria(): DiscountItemCriteria;
|
|
3450
|
+
type DiscountItemCriteria = {
|
|
3451
|
+
/**
|
|
3452
|
+
* - List of all store ids on which promotion
|
|
3453
|
+
* is applicable
|
|
3454
|
+
*/
|
|
3455
|
+
item_store?: number[];
|
|
3456
|
+
/**
|
|
3457
|
+
* - List of all company ids on which
|
|
3458
|
+
* promotion is applicable
|
|
3459
|
+
*/
|
|
3460
|
+
item_company?: number[];
|
|
3461
|
+
/**
|
|
3462
|
+
* - List of all brand ids on which promotion
|
|
3463
|
+
* is applicable
|
|
3464
|
+
*/
|
|
3465
|
+
item_brand?: number[];
|
|
3466
|
+
/**
|
|
3467
|
+
* - List of all brand ids on which
|
|
3468
|
+
* promotion is not applicable
|
|
3469
|
+
*/
|
|
3470
|
+
item_exclude_brand?: number[];
|
|
3471
|
+
/**
|
|
3472
|
+
* - List of all L3 category on which
|
|
3473
|
+
* promotion is applicable
|
|
3474
|
+
*/
|
|
3475
|
+
item_category?: number[];
|
|
3476
|
+
/**
|
|
3477
|
+
* - List of all L3 category on
|
|
3478
|
+
* which promotion is not applicable
|
|
3479
|
+
*/
|
|
3480
|
+
item_exclude_category?: number[];
|
|
3481
|
+
/**
|
|
3482
|
+
* - List of all L1 category on which
|
|
3483
|
+
* promotion is applicable
|
|
3484
|
+
*/
|
|
3485
|
+
item_l1_category?: number[];
|
|
3486
|
+
/**
|
|
3487
|
+
* - List of all item ids on
|
|
3488
|
+
* which promotion is not applicable
|
|
3489
|
+
*/
|
|
3490
|
+
item_exclude_l1_category?: number[];
|
|
3491
|
+
/**
|
|
3492
|
+
* - List of all L2 category on which
|
|
3493
|
+
* promotion is applicable
|
|
3494
|
+
*/
|
|
3495
|
+
item_l2_category?: number[];
|
|
3496
|
+
/**
|
|
3497
|
+
* - List of all L2 category on
|
|
3498
|
+
* which promotion is not applicable
|
|
3499
|
+
*/
|
|
3500
|
+
item_exclude_l2_category?: number[];
|
|
3501
|
+
/**
|
|
3502
|
+
* - List of all departments ids on which
|
|
3503
|
+
* promotion is applicable
|
|
3504
|
+
*/
|
|
3505
|
+
item_department?: number[];
|
|
3506
|
+
/**
|
|
3507
|
+
* - List of all department ids
|
|
3508
|
+
* on which promotion is not applicable
|
|
3509
|
+
*/
|
|
3510
|
+
item_exclude_department?: number[];
|
|
3511
|
+
/**
|
|
3512
|
+
* - List of all item ids on which promotion is applicable
|
|
3513
|
+
*/
|
|
3514
|
+
item_id?: number[];
|
|
3515
|
+
/**
|
|
3516
|
+
* - List of all item ids on which
|
|
3517
|
+
* promotion is not applicable
|
|
3518
|
+
*/
|
|
3519
|
+
item_exclude_id?: number[];
|
|
3520
|
+
/**
|
|
3521
|
+
* - Buy rules that apply to this discount
|
|
3522
|
+
*/
|
|
3523
|
+
buy_rules?: string[];
|
|
3524
|
+
/**
|
|
3525
|
+
* - List of all zones ids on which
|
|
3526
|
+
* promotion is applicable
|
|
3527
|
+
*/
|
|
3528
|
+
available_zones?: string[];
|
|
3529
|
+
/**
|
|
3530
|
+
* - Product tags that qualify for the discount
|
|
3531
|
+
*/
|
|
3532
|
+
product_tags?: string[];
|
|
3533
|
+
/**
|
|
3534
|
+
* - Whether the discount applies to all items
|
|
3535
|
+
*/
|
|
3536
|
+
all_items?: boolean;
|
|
3537
|
+
};
|
|
3397
3538
|
/** @returns {DiscountOffer} */
|
|
3398
3539
|
declare function DiscountOffer(): DiscountOffer;
|
|
3399
3540
|
type DiscountOffer = {
|
|
@@ -3402,7 +3543,8 @@ type DiscountOffer = {
|
|
|
3402
3543
|
*/
|
|
3403
3544
|
max_discount_amount?: number;
|
|
3404
3545
|
/**
|
|
3405
|
-
* - Discount price
|
|
3546
|
+
* - Discount price which is price after
|
|
3547
|
+
* deducting discount amount in fixed price promotion
|
|
3406
3548
|
*/
|
|
3407
3549
|
discount_price?: number;
|
|
3408
3550
|
/**
|
|
@@ -3438,6 +3580,11 @@ type DiscountOffer = {
|
|
|
3438
3580
|
* - Maximum quantity of product in promotion
|
|
3439
3581
|
*/
|
|
3440
3582
|
max_offer_quantity?: number;
|
|
3583
|
+
/**
|
|
3584
|
+
* - Cart sequence number of item for
|
|
3585
|
+
* which offer is valid
|
|
3586
|
+
*/
|
|
3587
|
+
item_sequence_number?: number;
|
|
3441
3588
|
};
|
|
3442
3589
|
/** @returns {DiscountRule} */
|
|
3443
3590
|
declare function DiscountRule(): DiscountRule;
|
|
@@ -8614,6 +8761,32 @@ type FreeGiftItems = {
|
|
|
8614
8761
|
*/
|
|
8615
8762
|
item_images_url?: string[];
|
|
8616
8763
|
};
|
|
8764
|
+
/** @returns {DiscountOfferRule} */
|
|
8765
|
+
declare function DiscountOfferRule(): DiscountOfferRule;
|
|
8766
|
+
type DiscountOfferRule = {
|
|
8767
|
+
/**
|
|
8768
|
+
* - Discount offer type of the promotion
|
|
8769
|
+
*/
|
|
8770
|
+
discount_type?: string;
|
|
8771
|
+
offer?: DiscountOffer;
|
|
8772
|
+
item_criteria?: DiscountItemCriteria;
|
|
8773
|
+
/**
|
|
8774
|
+
* - Logical condition expression for buy rules
|
|
8775
|
+
*/
|
|
8776
|
+
buy_condition?: string;
|
|
8777
|
+
/**
|
|
8778
|
+
* - Price of product after applying this
|
|
8779
|
+
* discount rule of promotion. Note - returned only when store id is provided
|
|
8780
|
+
* in request params.
|
|
8781
|
+
*/
|
|
8782
|
+
discounted_price?: number;
|
|
8783
|
+
/**
|
|
8784
|
+
* - List of buy rules that are
|
|
8785
|
+
* matching with item for this promotion
|
|
8786
|
+
*/
|
|
8787
|
+
matched_buy_rules?: string[];
|
|
8788
|
+
meta?: ItemSizeMapping;
|
|
8789
|
+
};
|
|
8617
8790
|
/** @returns {PromotionOffer} */
|
|
8618
8791
|
declare function PromotionOffer(): PromotionOffer;
|
|
8619
8792
|
type PromotionOffer = {
|
|
@@ -8621,10 +8794,7 @@ type PromotionOffer = {
|
|
|
8621
8794
|
* - Promotion unique identifier
|
|
8622
8795
|
*/
|
|
8623
8796
|
id?: string;
|
|
8624
|
-
|
|
8625
|
-
* - Buy rules of promotions
|
|
8626
|
-
*/
|
|
8627
|
-
buy_rules?: any;
|
|
8797
|
+
buy_rules?: BuyRuleItemCriteria;
|
|
8628
8798
|
/**
|
|
8629
8799
|
* - Offer title of promotion that used to display
|
|
8630
8800
|
*/
|
|
@@ -8649,7 +8819,7 @@ type PromotionOffer = {
|
|
|
8649
8819
|
/**
|
|
8650
8820
|
* - Discount rules of promotions
|
|
8651
8821
|
*/
|
|
8652
|
-
discount_rules?:
|
|
8822
|
+
discount_rules?: DiscountOfferRule[];
|
|
8653
8823
|
/**
|
|
8654
8824
|
* - Details of free gift items
|
|
8655
8825
|
*/
|
|
@@ -367,8 +367,8 @@ const Joi = require("joi");
|
|
|
367
367
|
* @property {CompareObject} [cart_quantity]
|
|
368
368
|
* @property {string[]} [available_zones] - List of all zones on which promotion
|
|
369
369
|
* is applicable
|
|
370
|
-
* @property {number[]} [item_exclude_company] - List of all company
|
|
371
|
-
* promotion is not applicable
|
|
370
|
+
* @property {number[]} [item_exclude_company] - List of all company ids on
|
|
371
|
+
* which promotion is not applicable
|
|
372
372
|
* @property {number[]} [item_id] - List of all item ids on which promotion is applicable
|
|
373
373
|
* @property {number[]} [item_l1_category] - List of all L1 category on which
|
|
374
374
|
* promotion is applicable
|
|
@@ -389,8 +389,8 @@ const Joi = require("joi");
|
|
|
389
389
|
* promotion is not applicable
|
|
390
390
|
* @property {number[]} [item_department] - List of all departments ids on which
|
|
391
391
|
* promotion is applicable
|
|
392
|
-
* @property {number[]} [item_exclude_store] - List of all
|
|
393
|
-
*
|
|
392
|
+
* @property {number[]} [item_exclude_store] - List of all store ids on which
|
|
393
|
+
* promotion is not applicable
|
|
394
394
|
* @property {number[]} [item_brand] - List of all brand ids on which promotion
|
|
395
395
|
* is applicable
|
|
396
396
|
* @property {number[]} [item_exclude_department] - List of all department ids
|
|
@@ -414,10 +414,47 @@ const Joi = require("joi");
|
|
|
414
414
|
* @property {ItemSizeMapping} [meta]
|
|
415
415
|
*/
|
|
416
416
|
|
|
417
|
+
/**
|
|
418
|
+
* @typedef DiscountItemCriteria
|
|
419
|
+
* @property {number[]} [item_store] - List of all store ids on which promotion
|
|
420
|
+
* is applicable
|
|
421
|
+
* @property {number[]} [item_company] - List of all company ids on which
|
|
422
|
+
* promotion is applicable
|
|
423
|
+
* @property {number[]} [item_brand] - List of all brand ids on which promotion
|
|
424
|
+
* is applicable
|
|
425
|
+
* @property {number[]} [item_exclude_brand] - List of all brand ids on which
|
|
426
|
+
* promotion is not applicable
|
|
427
|
+
* @property {number[]} [item_category] - List of all L3 category on which
|
|
428
|
+
* promotion is applicable
|
|
429
|
+
* @property {number[]} [item_exclude_category] - List of all L3 category on
|
|
430
|
+
* which promotion is not applicable
|
|
431
|
+
* @property {number[]} [item_l1_category] - List of all L1 category on which
|
|
432
|
+
* promotion is applicable
|
|
433
|
+
* @property {number[]} [item_exclude_l1_category] - List of all item ids on
|
|
434
|
+
* which promotion is not applicable
|
|
435
|
+
* @property {number[]} [item_l2_category] - List of all L2 category on which
|
|
436
|
+
* promotion is applicable
|
|
437
|
+
* @property {number[]} [item_exclude_l2_category] - List of all L2 category on
|
|
438
|
+
* which promotion is not applicable
|
|
439
|
+
* @property {number[]} [item_department] - List of all departments ids on which
|
|
440
|
+
* promotion is applicable
|
|
441
|
+
* @property {number[]} [item_exclude_department] - List of all department ids
|
|
442
|
+
* on which promotion is not applicable
|
|
443
|
+
* @property {number[]} [item_id] - List of all item ids on which promotion is applicable
|
|
444
|
+
* @property {number[]} [item_exclude_id] - List of all item ids on which
|
|
445
|
+
* promotion is not applicable
|
|
446
|
+
* @property {string[]} [buy_rules] - Buy rules that apply to this discount
|
|
447
|
+
* @property {string[]} [available_zones] - List of all zones ids on which
|
|
448
|
+
* promotion is applicable
|
|
449
|
+
* @property {string[]} [product_tags] - Product tags that qualify for the discount
|
|
450
|
+
* @property {boolean} [all_items] - Whether the discount applies to all items
|
|
451
|
+
*/
|
|
452
|
+
|
|
417
453
|
/**
|
|
418
454
|
* @typedef DiscountOffer
|
|
419
455
|
* @property {number} [max_discount_amount] - Maximum discount amount in promotion
|
|
420
|
-
* @property {number} [discount_price] - Discount price
|
|
456
|
+
* @property {number} [discount_price] - Discount price which is price after
|
|
457
|
+
* deducting discount amount in fixed price promotion
|
|
421
458
|
* @property {boolean} [apportion_discount] - Flag to distribute discount for each article
|
|
422
459
|
* @property {boolean} [partial_can_ret] - Flag indicated return the product partially
|
|
423
460
|
* @property {number} [max_usage_per_transaction] - Maximum usage per
|
|
@@ -427,6 +464,8 @@ const Joi = require("joi");
|
|
|
427
464
|
* @property {number} [discount_amount] - Discount amount in promotion
|
|
428
465
|
* @property {number} [discount_percentage] - Discount percentage in promotion
|
|
429
466
|
* @property {number} [max_offer_quantity] - Maximum quantity of product in promotion
|
|
467
|
+
* @property {number} [item_sequence_number] - Cart sequence number of item for
|
|
468
|
+
* which offer is valid
|
|
430
469
|
*/
|
|
431
470
|
|
|
432
471
|
/**
|
|
@@ -2649,17 +2688,31 @@ const Joi = require("joi");
|
|
|
2649
2688
|
* @property {string[]} [item_images_url] - List of free gift product images URL
|
|
2650
2689
|
*/
|
|
2651
2690
|
|
|
2691
|
+
/**
|
|
2692
|
+
* @typedef DiscountOfferRule
|
|
2693
|
+
* @property {string} [discount_type] - Discount offer type of the promotion
|
|
2694
|
+
* @property {DiscountOffer} [offer]
|
|
2695
|
+
* @property {DiscountItemCriteria} [item_criteria]
|
|
2696
|
+
* @property {string} [buy_condition] - Logical condition expression for buy rules
|
|
2697
|
+
* @property {number} [discounted_price] - Price of product after applying this
|
|
2698
|
+
* discount rule of promotion. Note - returned only when store id is provided
|
|
2699
|
+
* in request params.
|
|
2700
|
+
* @property {string[]} [matched_buy_rules] - List of buy rules that are
|
|
2701
|
+
* matching with item for this promotion
|
|
2702
|
+
* @property {ItemSizeMapping} [meta]
|
|
2703
|
+
*/
|
|
2704
|
+
|
|
2652
2705
|
/**
|
|
2653
2706
|
* @typedef PromotionOffer
|
|
2654
2707
|
* @property {string} [id] - Promotion unique identifier
|
|
2655
|
-
* @property {
|
|
2708
|
+
* @property {BuyRuleItemCriteria} [buy_rules]
|
|
2656
2709
|
* @property {string} [offer_text] - Offer title of promotion that used to display
|
|
2657
2710
|
* @property {string} [promotion_type] - Type of Promotion like percentage,
|
|
2658
2711
|
* amount, bogo etc.
|
|
2659
2712
|
* @property {string} [promotion_name] - Name of the promotion
|
|
2660
2713
|
* @property {string} [promotion_group] - Group of promotion belongs to
|
|
2661
2714
|
* @property {string} [valid_till] - Datetime ISOString for promotion end date
|
|
2662
|
-
* @property {
|
|
2715
|
+
* @property {DiscountOfferRule[]} [discount_rules] - Discount rules of promotions
|
|
2663
2716
|
* @property {FreeGiftItems[]} [free_gift_items] - Details of free gift items
|
|
2664
2717
|
* @property {string} [description] - Offer details including T&C
|
|
2665
2718
|
*/
|
|
@@ -3137,6 +3190,30 @@ class CartPlatformModel {
|
|
|
3137
3190
|
});
|
|
3138
3191
|
}
|
|
3139
3192
|
|
|
3193
|
+
/** @returns {DiscountItemCriteria} */
|
|
3194
|
+
static DiscountItemCriteria() {
|
|
3195
|
+
return Joi.object({
|
|
3196
|
+
item_store: Joi.array().items(Joi.number()),
|
|
3197
|
+
item_company: Joi.array().items(Joi.number()),
|
|
3198
|
+
item_brand: Joi.array().items(Joi.number()),
|
|
3199
|
+
item_exclude_brand: Joi.array().items(Joi.number()),
|
|
3200
|
+
item_category: Joi.array().items(Joi.number()),
|
|
3201
|
+
item_exclude_category: Joi.array().items(Joi.number()),
|
|
3202
|
+
item_l1_category: Joi.array().items(Joi.number()),
|
|
3203
|
+
item_exclude_l1_category: Joi.array().items(Joi.number()),
|
|
3204
|
+
item_l2_category: Joi.array().items(Joi.number()),
|
|
3205
|
+
item_exclude_l2_category: Joi.array().items(Joi.number()),
|
|
3206
|
+
item_department: Joi.array().items(Joi.number()),
|
|
3207
|
+
item_exclude_department: Joi.array().items(Joi.number()),
|
|
3208
|
+
item_id: Joi.array().items(Joi.number()),
|
|
3209
|
+
item_exclude_id: Joi.array().items(Joi.number()),
|
|
3210
|
+
buy_rules: Joi.array().items(Joi.string().allow("")),
|
|
3211
|
+
available_zones: Joi.array().items(Joi.string().allow("")),
|
|
3212
|
+
product_tags: Joi.array().items(Joi.string().allow("")),
|
|
3213
|
+
all_items: Joi.boolean(),
|
|
3214
|
+
});
|
|
3215
|
+
}
|
|
3216
|
+
|
|
3140
3217
|
/** @returns {DiscountOffer} */
|
|
3141
3218
|
static DiscountOffer() {
|
|
3142
3219
|
return Joi.object({
|
|
@@ -3144,12 +3221,13 @@ class CartPlatformModel {
|
|
|
3144
3221
|
discount_price: Joi.number(),
|
|
3145
3222
|
apportion_discount: Joi.boolean(),
|
|
3146
3223
|
partial_can_ret: Joi.boolean(),
|
|
3147
|
-
max_usage_per_transaction: Joi.number()
|
|
3224
|
+
max_usage_per_transaction: Joi.number(),
|
|
3148
3225
|
min_offer_quantity: Joi.number(),
|
|
3149
3226
|
code: Joi.string().allow(""),
|
|
3150
3227
|
discount_amount: Joi.number(),
|
|
3151
3228
|
discount_percentage: Joi.number(),
|
|
3152
3229
|
max_offer_quantity: Joi.number(),
|
|
3230
|
+
item_sequence_number: Joi.number(),
|
|
3153
3231
|
});
|
|
3154
3232
|
}
|
|
3155
3233
|
|
|
@@ -5408,17 +5486,30 @@ class CartPlatformModel {
|
|
|
5408
5486
|
});
|
|
5409
5487
|
}
|
|
5410
5488
|
|
|
5489
|
+
/** @returns {DiscountOfferRule} */
|
|
5490
|
+
static DiscountOfferRule() {
|
|
5491
|
+
return Joi.object({
|
|
5492
|
+
discount_type: Joi.string().allow(""),
|
|
5493
|
+
offer: CartPlatformModel.DiscountOffer(),
|
|
5494
|
+
item_criteria: CartPlatformModel.DiscountItemCriteria(),
|
|
5495
|
+
buy_condition: Joi.string().allow(""),
|
|
5496
|
+
discounted_price: Joi.number(),
|
|
5497
|
+
matched_buy_rules: Joi.array().items(Joi.string().allow("")),
|
|
5498
|
+
meta: CartPlatformModel.ItemSizeMapping(),
|
|
5499
|
+
});
|
|
5500
|
+
}
|
|
5501
|
+
|
|
5411
5502
|
/** @returns {PromotionOffer} */
|
|
5412
5503
|
static PromotionOffer() {
|
|
5413
5504
|
return Joi.object({
|
|
5414
5505
|
id: Joi.string().allow(""),
|
|
5415
|
-
buy_rules:
|
|
5506
|
+
buy_rules: CartPlatformModel.BuyRuleItemCriteria(),
|
|
5416
5507
|
offer_text: Joi.string().allow(""),
|
|
5417
5508
|
promotion_type: Joi.string().allow(""),
|
|
5418
5509
|
promotion_name: Joi.string().allow(""),
|
|
5419
5510
|
promotion_group: Joi.string().allow(""),
|
|
5420
5511
|
valid_till: Joi.string().allow(""),
|
|
5421
|
-
discount_rules: Joi.array().items(
|
|
5512
|
+
discount_rules: Joi.array().items(CartPlatformModel.DiscountOfferRule()),
|
|
5422
5513
|
free_gift_items: Joi.array().items(CartPlatformModel.FreeGiftItems()),
|
|
5423
5514
|
description: Joi.string().allow(""),
|
|
5424
5515
|
});
|
|
@@ -4793,7 +4793,8 @@ export = CatalogPlatformModel;
|
|
|
4793
4793
|
* | "shipping-policy"
|
|
4794
4794
|
* | "return-policy"
|
|
4795
4795
|
* | "order-status"
|
|
4796
|
-
* | "locate-us"
|
|
4796
|
+
* | "locate-us"
|
|
4797
|
+
* | "single-page-checkout"} PageType
|
|
4797
4798
|
*/
|
|
4798
4799
|
declare class CatalogPlatformModel {
|
|
4799
4800
|
}
|
|
@@ -15104,4 +15105,4 @@ type HsTypeEnum = "HS" | "SAC";
|
|
|
15104
15105
|
* @returns {PageType}
|
|
15105
15106
|
*/
|
|
15106
15107
|
declare function PageType(): PageType;
|
|
15107
|
-
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";
|
|
15108
|
+
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" | "single-page-checkout";
|
|
@@ -5242,7 +5242,8 @@ const Joi = require("joi");
|
|
|
5242
5242
|
* | "shipping-policy"
|
|
5243
5243
|
* | "return-policy"
|
|
5244
5244
|
* | "order-status"
|
|
5245
|
-
* | "locate-us"
|
|
5245
|
+
* | "locate-us"
|
|
5246
|
+
* | "single-page-checkout"} PageType
|
|
5246
5247
|
*/
|
|
5247
5248
|
|
|
5248
5249
|
class CatalogPlatformModel {
|
|
@@ -10860,7 +10861,9 @@ class CatalogPlatformModel {
|
|
|
10860
10861
|
|
|
10861
10862
|
"order-status",
|
|
10862
10863
|
|
|
10863
|
-
"locate-us"
|
|
10864
|
+
"locate-us",
|
|
10865
|
+
|
|
10866
|
+
"single-page-checkout"
|
|
10864
10867
|
);
|
|
10865
10868
|
}
|
|
10866
10869
|
}
|
|
@@ -1552,7 +1552,8 @@ export = ContentPlatformModel;
|
|
|
1552
1552
|
* | "shipping-policy"
|
|
1553
1553
|
* | "return-policy"
|
|
1554
1554
|
* | "order-status"
|
|
1555
|
-
* | "locate-us"
|
|
1555
|
+
* | "locate-us"
|
|
1556
|
+
* | "single-page-checkout"} PageType
|
|
1556
1557
|
*/
|
|
1557
1558
|
declare class ContentPlatformModel {
|
|
1558
1559
|
}
|
|
@@ -4409,4 +4410,4 @@ type GenerationEntityType = "title" | "description";
|
|
|
4409
4410
|
* @returns {PageType}
|
|
4410
4411
|
*/
|
|
4411
4412
|
declare function PageType(): PageType;
|
|
4412
|
-
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";
|
|
4413
|
+
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" | "single-page-checkout";
|
|
@@ -1747,7 +1747,8 @@ const Joi = require("joi");
|
|
|
1747
1747
|
* | "shipping-policy"
|
|
1748
1748
|
* | "return-policy"
|
|
1749
1749
|
* | "order-status"
|
|
1750
|
-
* | "locate-us"
|
|
1750
|
+
* | "locate-us"
|
|
1751
|
+
* | "single-page-checkout"} PageType
|
|
1751
1752
|
*/
|
|
1752
1753
|
|
|
1753
1754
|
class ContentPlatformModel {
|
|
@@ -3897,7 +3898,9 @@ class ContentPlatformModel {
|
|
|
3897
3898
|
|
|
3898
3899
|
"order-status",
|
|
3899
3900
|
|
|
3900
|
-
"locate-us"
|
|
3901
|
+
"locate-us",
|
|
3902
|
+
|
|
3903
|
+
"single-page-checkout"
|
|
3901
3904
|
);
|
|
3902
3905
|
}
|
|
3903
3906
|
}
|
|
@@ -796,7 +796,7 @@ declare class Order {
|
|
|
796
796
|
*
|
|
797
797
|
* @name updateShipmentStatus
|
|
798
798
|
* @summary: Update a shipment's status
|
|
799
|
-
* @description: It is used for updating the shipment in the following scenarios
|
|
799
|
+
* @description: It is used for updating the shipment in the following scenarios: Full Confirmation, Partial Confirmation, Change the status of a shipment, Full Cancellation, Partial Cancellation, Assign the shipment to DP. Click <a href='/commerce/miscellaneous/updateShipmentStatus'>here</a> to get the example payload. Also, refer to the <a href='/commerce/getting-started/oms-states/'>OMS States</a> for the complete status list. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentStatus/).
|
|
800
800
|
*/
|
|
801
801
|
updateShipmentStatus({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentStatusResponseBody>;
|
|
802
802
|
/**
|
|
@@ -5251,7 +5251,7 @@ class Order {
|
|
|
5251
5251
|
*
|
|
5252
5252
|
* @name updateShipmentStatus
|
|
5253
5253
|
* @summary: Update a shipment's status
|
|
5254
|
-
* @description: It is used for updating the shipment in the following scenarios
|
|
5254
|
+
* @description: It is used for updating the shipment in the following scenarios: Full Confirmation, Partial Confirmation, Change the status of a shipment, Full Cancellation, Partial Cancellation, Assign the shipment to DP. Click <a href='/commerce/miscellaneous/updateShipmentStatus'>here</a> to get the example payload. Also, refer to the <a href='/commerce/getting-started/oms-states/'>OMS States</a> for the complete status list. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentStatus/).
|
|
5255
5255
|
*/
|
|
5256
5256
|
async updateShipmentStatus(
|
|
5257
5257
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -601,7 +601,8 @@ export = ThemePlatformModel;
|
|
|
601
601
|
* | "shipping-policy"
|
|
602
602
|
* | "return-policy"
|
|
603
603
|
* | "order-status"
|
|
604
|
-
* | "locate-us"
|
|
604
|
+
* | "locate-us"
|
|
605
|
+
* | "single-page-checkout"} PageType
|
|
605
606
|
*/
|
|
606
607
|
declare class ThemePlatformModel {
|
|
607
608
|
}
|
|
@@ -1664,4 +1665,4 @@ type ActionPage = {
|
|
|
1664
1665
|
* @returns {PageType}
|
|
1665
1666
|
*/
|
|
1666
1667
|
declare function PageType(): PageType;
|
|
1667
|
-
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";
|
|
1668
|
+
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" | "single-page-checkout";
|
|
@@ -684,7 +684,8 @@ const Joi = require("joi");
|
|
|
684
684
|
* | "shipping-policy"
|
|
685
685
|
* | "return-policy"
|
|
686
686
|
* | "order-status"
|
|
687
|
-
* | "locate-us"
|
|
687
|
+
* | "locate-us"
|
|
688
|
+
* | "single-page-checkout"} PageType
|
|
688
689
|
*/
|
|
689
690
|
|
|
690
691
|
class ThemePlatformModel {
|
|
@@ -1592,7 +1593,9 @@ class ThemePlatformModel {
|
|
|
1592
1593
|
|
|
1593
1594
|
"order-status",
|
|
1594
1595
|
|
|
1595
|
-
"locate-us"
|
|
1596
|
+
"locate-us",
|
|
1597
|
+
|
|
1598
|
+
"single-page-checkout"
|
|
1596
1599
|
);
|
|
1597
1600
|
}
|
|
1598
1601
|
}
|
|
@@ -399,7 +399,7 @@ export = UserPlatformModel;
|
|
|
399
399
|
*/
|
|
400
400
|
/**
|
|
401
401
|
* @typedef CreateUserRequestSchema
|
|
402
|
-
* @property {string} phone_number
|
|
402
|
+
* @property {string} [phone_number]
|
|
403
403
|
* @property {string} [email]
|
|
404
404
|
* @property {string} [first_name]
|
|
405
405
|
* @property {string} [last_name]
|
|
@@ -1487,7 +1487,7 @@ type CreateUserGroup = {
|
|
|
1487
1487
|
/** @returns {CreateUserRequestSchema} */
|
|
1488
1488
|
declare function CreateUserRequestSchema(): CreateUserRequestSchema;
|
|
1489
1489
|
type CreateUserRequestSchema = {
|
|
1490
|
-
phone_number
|
|
1490
|
+
phone_number?: string;
|
|
1491
1491
|
email?: string;
|
|
1492
1492
|
first_name?: string;
|
|
1493
1493
|
last_name?: string;
|
|
@@ -446,7 +446,7 @@ const Joi = require("joi");
|
|
|
446
446
|
|
|
447
447
|
/**
|
|
448
448
|
* @typedef CreateUserRequestSchema
|
|
449
|
-
* @property {string} phone_number
|
|
449
|
+
* @property {string} [phone_number]
|
|
450
450
|
* @property {string} [email]
|
|
451
451
|
* @property {string} [first_name]
|
|
452
452
|
* @property {string} [last_name]
|
|
@@ -1266,7 +1266,7 @@ class UserPlatformModel {
|
|
|
1266
1266
|
/** @returns {CreateUserRequestSchema} */
|
|
1267
1267
|
static CreateUserRequestSchema() {
|
|
1268
1268
|
return Joi.object({
|
|
1269
|
-
phone_number: Joi.string().allow("")
|
|
1269
|
+
phone_number: Joi.string().allow(""),
|
|
1270
1270
|
email: Joi.string().allow(""),
|
|
1271
1271
|
first_name: Joi.string().allow(""),
|
|
1272
1272
|
last_name: Joi.string().allow(""),
|
package/utility.d.ts
ADDED