@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.1.0-beta.1
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 +14 -14
- package/sdk/application/Cart/CartApplicationClient.js +14 -14
- package/sdk/application/Content/ContentApplicationClient.d.ts +10 -0
- package/sdk/application/Content/ContentApplicationClient.js +53 -0
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +34 -0
- package/sdk/application/Logistic/LogisticApplicationClient.js +136 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +12 -12
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +46 -33
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +41 -25
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +6 -397
- package/sdk/platform/Billing/BillingPlatformClient.js +77 -3215
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +417 -3811
- package/sdk/platform/Billing/BillingPlatformModel.js +292 -2544
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +12 -451
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -483
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +34 -34
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +34 -34
- package/sdk/platform/Cart/CartPlatformModel.d.ts +363 -29
- package/sdk/platform/Cart/CartPlatformModel.js +203 -31
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +57 -57
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +220 -200
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +121 -91
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +58 -46
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +10 -51
- package/sdk/platform/Catalog/CatalogPlatformClient.js +79 -400
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +22 -228
- package/sdk/platform/Catalog/CatalogPlatformModel.js +12 -163
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +15 -61
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -65
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +4 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +10 -14
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +94 -30
- package/sdk/platform/Communication/CommunicationPlatformModel.js +110 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +33 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +62 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +11 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +5 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +12 -2
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +5 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +12 -10
- package/sdk/platform/Content/ContentPlatformModel.d.ts +42 -12
- package/sdk/platform/Content/ContentPlatformModel.js +43 -13
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +28 -28
- package/sdk/platform/Finance/FinancePlatformClient.js +28 -28
- package/sdk/platform/Order/OrderPlatformClient.d.ts +21 -21
- package/sdk/platform/Order/OrderPlatformClient.js +21 -21
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1010 -80
- package/sdk/platform/Order/OrderPlatformModel.js +665 -70
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +31 -4
- package/sdk/platform/Payment/PaymentPlatformModel.js +11 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +14 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +6 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +24 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +119 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +194 -23
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +116 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +23 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +16 -0
- package/sdk/platform/Share/SharePlatformModel.d.ts +5 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +10 -12
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +45 -49
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +10 -10
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +12 -12
- package/sdk/public/PublicClient.d.ts +0 -2
- package/sdk/public/PublicClient.js +0 -4
- package/sdk/public/index.d.ts +0 -1
- package/sdk/public/index.js +0 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +0 -56
- package/sdk/public/Billing/BillingPublicClient.js +0 -397
- package/sdk/public/Billing/BillingPublicModel.d.ts +0 -919
- package/sdk/public/Billing/BillingPublicModel.js +0 -560
- package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -43
- package/sdk/public/Billing/BillingPublicValidator.js +0 -50
|
@@ -433,6 +433,8 @@ export = CartPlatformModel;
|
|
|
433
433
|
* @property {PromotionAuthor} [author]
|
|
434
434
|
* @property {PromotionDateMeta} date_meta
|
|
435
435
|
* @property {string} [_id] - Promotion id
|
|
436
|
+
* @property {boolean} [is_processed] - Flag to verify if promotion is ready to
|
|
437
|
+
* be applied on cart and ready to update promotion
|
|
436
438
|
* @property {string} [code]
|
|
437
439
|
* @property {string[]} [tags]
|
|
438
440
|
*/
|
|
@@ -470,34 +472,107 @@ export = CartPlatformModel;
|
|
|
470
472
|
* @property {PromoIndexedCriteria[]} [indexed_criteria]
|
|
471
473
|
* @property {string[]} [tags]
|
|
472
474
|
*/
|
|
475
|
+
/**
|
|
476
|
+
* @typedef PromotionAddResult
|
|
477
|
+
* @property {boolean} [stackable] - Boolean value set true to apply other promotions also
|
|
478
|
+
* @property {string} [calculate_on] - Article Price on which promotion
|
|
479
|
+
* calculated like effective price or marked price. Only available for
|
|
480
|
+
* Contract pricing and Ladder pricing promotion type
|
|
481
|
+
* @property {string} [apply_exclusive] - Promotion should apply on either
|
|
482
|
+
* article or cart.
|
|
483
|
+
* @property {string} promo_group - The type of promotion group
|
|
484
|
+
* @property {string} mode - Promotion mode, like coupon or promotion
|
|
485
|
+
* @property {boolean} [is_processed] - Flag to verify if promotion is ready to
|
|
486
|
+
* be applied on cart and ready to update promotion
|
|
487
|
+
* @property {boolean} [apply_all_discount] - True means to apply all discount offers
|
|
488
|
+
* @property {DisplayMeta1} [display_meta]
|
|
489
|
+
* @property {Ownership} [ownership]
|
|
490
|
+
* @property {string} promotion_type - Type of promotion
|
|
491
|
+
* @property {DiscountRule[]} [discount_rules] - List of discount offers and
|
|
492
|
+
* their applicable conditions
|
|
493
|
+
* @property {Restrictions1} [restrictions]
|
|
494
|
+
* @property {string} [currency] - Promotion Currency code like INR
|
|
495
|
+
* @property {string} [code] - Promotion unique code
|
|
496
|
+
* @property {PromotionSchedule} [_schedule]
|
|
497
|
+
* @property {PromotionAction} [post_order_action]
|
|
498
|
+
* @property {number} [apply_priority] - Promotion applicable priority
|
|
499
|
+
* @property {PromotionAuthor} [author]
|
|
500
|
+
* @property {Visibility} [visiblility]
|
|
501
|
+
* @property {string} application_id - Current application id of sales channel
|
|
502
|
+
* @property {Object} [buy_rules]
|
|
503
|
+
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
504
|
+
* @property {PromotionDateMeta} [date_meta]
|
|
505
|
+
* @property {PromoIndexedCriteria[]} [indexed_criteria]
|
|
506
|
+
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
507
|
+
* @property {string} [_id] - Unique idenfier of promotion.
|
|
508
|
+
*/
|
|
473
509
|
/**
|
|
474
510
|
* @typedef PromotionUpdate
|
|
475
|
-
* @property {
|
|
476
|
-
* @property {
|
|
477
|
-
*
|
|
478
|
-
* Ladder pricing promotion type
|
|
479
|
-
* @property {string} [apply_exclusive]
|
|
480
|
-
*
|
|
481
|
-
* @property {string}
|
|
482
|
-
* @property {
|
|
483
|
-
* @property {
|
|
484
|
-
* @property {
|
|
485
|
-
* @property {
|
|
486
|
-
* @property {
|
|
511
|
+
* @property {boolean} [stackable] - Set true to apply other promotions in cart
|
|
512
|
+
* @property {string} [calculate_on] - Article Price on which promotion
|
|
513
|
+
* calculated like effective price or marked price. Only available for
|
|
514
|
+
* Contract pricing and Ladder pricing promotion type
|
|
515
|
+
* @property {string} [apply_exclusive] - Promotion should apply on either
|
|
516
|
+
* article or cart.
|
|
517
|
+
* @property {string} [reason] - Promotion rejection reason added by reviewer
|
|
518
|
+
* @property {string} promo_group - The type of promotion group
|
|
519
|
+
* @property {string} mode - Promotion mode
|
|
520
|
+
* @property {boolean} [apply_all_discount] - True means to apply all discount offers
|
|
521
|
+
* @property {DisplayMeta1} [display_meta]
|
|
522
|
+
* @property {Ownership} [ownership]
|
|
523
|
+
* @property {string} promotion_type - The Promotion type like amount, bogo and
|
|
524
|
+
* percentage etc.
|
|
525
|
+
* @property {DiscountRule[]} [discount_rules] - List of discount offers and
|
|
526
|
+
* their applicable conditions
|
|
487
527
|
* @property {Restrictions1} [restrictions]
|
|
488
|
-
* @property {string} [currency]
|
|
489
|
-
* @property {string} [code]
|
|
528
|
+
* @property {string} [currency] - Promotion Currency code like INR
|
|
529
|
+
* @property {string} [code] - Promotion unique code
|
|
490
530
|
* @property {PromotionSchedule} [_schedule]
|
|
491
531
|
* @property {PromotionAction} [post_order_action]
|
|
492
|
-
* @property {number} [apply_priority]
|
|
532
|
+
* @property {number} [apply_priority] - Promotion applicable priority
|
|
493
533
|
* @property {PromotionAuthor} [author]
|
|
494
534
|
* @property {Visibility} [visiblility]
|
|
495
|
-
* @property {string} application_id
|
|
496
|
-
* @property {Object} buy_rules
|
|
497
|
-
* @property {Object} [_custom_json]
|
|
535
|
+
* @property {string} application_id - Current application id of sales channel
|
|
536
|
+
* @property {Object} [buy_rules]
|
|
537
|
+
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
538
|
+
* @property {PromotionDateMeta} [date_meta]
|
|
539
|
+
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
540
|
+
*/
|
|
541
|
+
/**
|
|
542
|
+
* @typedef PromotionUpdateResult
|
|
543
|
+
* @property {boolean} [stackable] - Set true to apply other promotions in cart
|
|
544
|
+
* @property {string} [calculate_on] - Article Price on which promotion
|
|
545
|
+
* calculated like effective price or marked price. Only available for
|
|
546
|
+
* Contract pricing and Ladder pricing promotion type
|
|
547
|
+
* @property {string} [apply_exclusive] - Promotion should apply on either
|
|
548
|
+
* article or cart.
|
|
549
|
+
* @property {string} [reason] - Promotion rejection reason added by reviewer
|
|
550
|
+
* @property {boolean} [is_processed] - Flag to verify if promotion is ready to
|
|
551
|
+
* be applied on cart and ready to update promotion
|
|
552
|
+
* @property {string} promo_group - The type of promotion group
|
|
553
|
+
* @property {string} mode - Promotion mode
|
|
554
|
+
* @property {boolean} [apply_all_discount] - True means to apply all discount offers
|
|
555
|
+
* @property {DisplayMeta1} [display_meta]
|
|
556
|
+
* @property {Ownership} [ownership]
|
|
557
|
+
* @property {string} promotion_type - The Promotion type like amount, bogo and
|
|
558
|
+
* percentage etc.
|
|
559
|
+
* @property {DiscountRule[]} [discount_rules] - List of discount offers and
|
|
560
|
+
* their applicable conditions
|
|
561
|
+
* @property {Restrictions1} [restrictions]
|
|
562
|
+
* @property {string} [currency] - Promotion Currency code like INR
|
|
563
|
+
* @property {string} [code] - Promotion unique code
|
|
564
|
+
* @property {PromotionSchedule} [_schedule]
|
|
565
|
+
* @property {PromotionAction} [post_order_action]
|
|
566
|
+
* @property {number} [apply_priority] - Promotion applicable priority
|
|
567
|
+
* @property {PromotionAuthor} [author]
|
|
568
|
+
* @property {Visibility} [visiblility]
|
|
569
|
+
* @property {string} application_id - Current application id of sales channel
|
|
570
|
+
* @property {Object} [buy_rules]
|
|
571
|
+
* @property {Object} [_custom_json] - Set extra properties in promotion
|
|
498
572
|
* @property {PromotionDateMeta} [date_meta]
|
|
499
573
|
* @property {PromoIndexedCriteria[]} [indexed_criteria]
|
|
500
|
-
* @property {string[]} [tags]
|
|
574
|
+
* @property {string[]} [tags] - List of tags applicable for promotion
|
|
575
|
+
* @property {string} [_id] - Auto generated id of specific promotion
|
|
501
576
|
*/
|
|
502
577
|
/**
|
|
503
578
|
* @typedef PromoIndexedCriteria
|
|
@@ -1635,7 +1710,7 @@ export = CartPlatformModel;
|
|
|
1635
1710
|
* @property {Object} [_custom_json]
|
|
1636
1711
|
* @property {string} [price_factory_type_id]
|
|
1637
1712
|
* @property {number} [item_id]
|
|
1638
|
-
* @property {number}
|
|
1713
|
+
* @property {number} item_index
|
|
1639
1714
|
* @property {CartProductIdentifer} identifiers
|
|
1640
1715
|
* @property {string} [article_id]
|
|
1641
1716
|
*/
|
|
@@ -1926,10 +2001,16 @@ export = CartPlatformModel;
|
|
|
1926
2001
|
* @property {string} [meta_data]
|
|
1927
2002
|
* @property {number} [meta_data_int]
|
|
1928
2003
|
*/
|
|
2004
|
+
/**
|
|
2005
|
+
* @typedef ValidationConfig
|
|
2006
|
+
* @property {number} address_max_limit - The maximum number of addresses a user can have.
|
|
2007
|
+
* @property {number} user_address_count - The total number of addresses saved by a user.
|
|
2008
|
+
*/
|
|
1929
2009
|
/**
|
|
1930
2010
|
* @typedef PlatformGetAddressesResponse
|
|
1931
2011
|
* @property {PlatformAddress[]} [address]
|
|
1932
2012
|
* @property {boolean} [pii_masking]
|
|
2013
|
+
* @property {ValidationConfig} [validation_config]
|
|
1933
2014
|
*/
|
|
1934
2015
|
/**
|
|
1935
2016
|
* @typedef SaveAddressResponse
|
|
@@ -2509,11 +2590,17 @@ export = CartPlatformModel;
|
|
|
2509
2590
|
* @typedef AllAddressForSelectAddress
|
|
2510
2591
|
* @property {PlatformAddress[]} [address]
|
|
2511
2592
|
* @property {boolean} [pii_masking]
|
|
2593
|
+
* @property {ValidationConfig} [validation_config]
|
|
2594
|
+
*/
|
|
2595
|
+
/**
|
|
2596
|
+
* @typedef ValidationError
|
|
2597
|
+
* @property {string} message - A brief description of the error encountered.
|
|
2598
|
+
* @property {string} field - The field in the request that caused the error.
|
|
2512
2599
|
*/
|
|
2513
2600
|
declare class CartPlatformModel {
|
|
2514
2601
|
}
|
|
2515
2602
|
declare namespace CartPlatformModel {
|
|
2516
|
-
export { CouponDateMeta, Ownership, CouponAuthor, State, PaymentAllowValue, PaymentModes, PriceRange, PostOrder, BulkBundleRestriction, UsesRemaining, UsesRestriction, Restrictions, Validation, CouponAction, NextSchedule, CouponSchedule, Rule, DisplayMetaDict, DisplayMeta, Identifier, Validity, RuleDefinition, CouponAdd, Page, CouponObj, CouponsResponse, CouponMedias, CouponDetailObj, CouponDetailResponse, TagsViewResponse, SuccessMessage, OperationErrorResponse, CartMetaConfigOperationErrorResponse, CouponUpdate, CouponPartialUpdate, DisplayMeta1, CompareObject, ItemCriteria, DiscountOffer, DiscountRule, PaymentAllowValue1, PromotionPaymentModes, UserRegistered, PostOrder1, UsesRemaining1, UsesRestriction1, Restrictions1, PromotionSchedule, PromotionAction, PromotionAuthor, Visibility, PromotionDateMeta, PromotionListItem, PromotionsResponse, PromotionAdd, PromotionUpdate, PromoIndexedCriteria, PromotionPartialUpdate, ActivePromos, ActivePromosResponse, Charges, DeliveryCharges, OrderPlacing, PanCard, CartMetaConfigUpdate, TimeStampIDResponse, CartMetaConfigDetailResponse, CartMetaConfigListResponse, CartMetaConfigListObject, CartMetaConfigAddResponse, CartMetaConfigAdd, Article, PriceAdjustmentRestrictions, Collection, PriceAdjustmentUpdate, PriceAdjustment, AddPriceAdjustmentResponse, UpdatePriceAdjustmentResponse, PriceAdjustmentResponse, GetPriceAdjustmentResponse, PriceAdjustmentAdd, DistributionRule, Distribution, DistributionLogic, CartItem, OpenapiCartDetailsRequest, CouponBreakup, DisplayBreakup, LoyaltyPoints, RawBreakup, CartBreakup, ProductImage, Tags, BaseInfo, ActionQuery, ProductAction, CategoryInfo, CartProduct, BasePrice, ArticleAppliedPriceAdjustment, ArticlePriceInfo, StoreInfo, ArticleGiftCard, ProductArticle, PromoDiscountRuleOffer, PromoDiscountRuleRawOffer, PromoDiscountRuleItemCriteria, DiscountRulesApp, AppliedFreeArticles, PromoBuyRuleCartConditions, PromoBuyRuleCompareFieldsTypes, BuyRules, AppliedPromotion, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, CouponDetails, ProductPrice, ProductPriceInfo, CartProductIdentifer, ProductAvailabilitySize, ProductAvailability, PromoMeta, ParentItemIdentifiers, CartItemMOQ, CartItemCustomOrder, CartProductInfo, DiscountMeta, PriceAdjustmentApplied, OpenapiCartDetailsResponse, OpenApiErrorResponse, ShippingAddress, OpenApiCartServiceabilityRequest, OpenApiCartServiceabilityResponse, OpenApiFiles, CartItemMeta, MultiTenderPaymentMeta, MultiTenderPaymentMethod, OpenApiOrderItem, OpenApiPlatformCheckoutReq, OpenApiCheckoutResponse, AbandonedCart, AbandonedCartResponse, PaymentSelectionLock, CartCurrency, CartCouponMedias, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig, CartAppliedPriceAdjustment, CustomCart, CartDetailResponse, AddProductCart, ArticleAssignment, AddCartRequest, AddCartDetailResponse, UpdateProductCart, UpdateCartRequest, UpdateCartDetailResponse, OverrideCartItemPromo, OverrideCartItem, OverrideCheckoutReq, OverrideCheckoutResponse, GetShareCartLinkRequest, GetShareCartLinkResponse, SharedCartDetails, SharedCart, SharedCartResponse, CartList, MultiCartResponse, UpdateUserCartMapping, UserCartMappingResponse, CartMappingUserInfo, PlatformAddCartRequest, PlatformUpdateCartRequest, DeleteCartRequest, DeleteCartDetailResponse, CartItemCountResponse, Coupon, PageCoupon, GetCouponResponse, ApplyCouponRequest, GeoLocation, PlatformAddress, AddressCustomJson, PlatformGetAddressesResponse, SaveAddressResponse, UpdateAddressResponse, DeleteAddressResponse, PlatformSelectCartAddressRequest, ShipmentArticle, ShipmentError, PlatformShipmentResponse, ShipmentMeta, ShipmentMetaDimension, ShipmentLogisticsMeta, ShipmentLogisticsMetaAccount, ShipmentLogisticsMetaAccountAreaCode, ShipmentLogisticsMetaAccountDpTat, PlatformCartShipmentsResponse, UpdateCartShipmentItem, UpdateCartShipmentRequest, PlatformCartMetaRequest, CartMetaResponse, CartMetaMissingResponse, CartMetaFieldsValidation, StaffCheckout, CustomerDetails, Files, CartCheckoutCustomMeta, PlatformCartCheckoutDetailRequest, CheckCart, CartCheckoutResponse, CartDeliveryModesResponse, PickupStoreDetail, StoreDetailsResponse, UpdateCartPaymentRequest, CouponValidity, PaymentCouponValidate, PaymentMeta, PaymentMethod, PlatformCartCheckoutDetailV2Request, UpdateCartPaymentRequestV2, PriceMinMax, ItemPriceDetails, FreeGiftItems, PromotionOffer, PromotionOffersResponse, PromotionPaymentOffer, CouponOptions, CouponOptionTypes, CouponOptionScopes, CouponOptionsApplicable, CouponOptionsValueTypes, CouponOptionsCalculate, CouponOptionsPayableCategory, CouponOptionsTxnMode, CouponOptionsPayableBy, SelectAddressResponseError, AllAddressForSelectAddress };
|
|
2603
|
+
export { CouponDateMeta, Ownership, CouponAuthor, State, PaymentAllowValue, PaymentModes, PriceRange, PostOrder, BulkBundleRestriction, UsesRemaining, UsesRestriction, Restrictions, Validation, CouponAction, NextSchedule, CouponSchedule, Rule, DisplayMetaDict, DisplayMeta, Identifier, Validity, RuleDefinition, CouponAdd, Page, CouponObj, CouponsResponse, CouponMedias, CouponDetailObj, CouponDetailResponse, TagsViewResponse, SuccessMessage, OperationErrorResponse, CartMetaConfigOperationErrorResponse, CouponUpdate, CouponPartialUpdate, DisplayMeta1, CompareObject, ItemCriteria, DiscountOffer, DiscountRule, PaymentAllowValue1, PromotionPaymentModes, UserRegistered, PostOrder1, UsesRemaining1, UsesRestriction1, Restrictions1, PromotionSchedule, PromotionAction, PromotionAuthor, Visibility, PromotionDateMeta, PromotionListItem, PromotionsResponse, PromotionAdd, PromotionAddResult, PromotionUpdate, PromotionUpdateResult, PromoIndexedCriteria, PromotionPartialUpdate, ActivePromos, ActivePromosResponse, Charges, DeliveryCharges, OrderPlacing, PanCard, CartMetaConfigUpdate, TimeStampIDResponse, CartMetaConfigDetailResponse, CartMetaConfigListResponse, CartMetaConfigListObject, CartMetaConfigAddResponse, CartMetaConfigAdd, Article, PriceAdjustmentRestrictions, Collection, PriceAdjustmentUpdate, PriceAdjustment, AddPriceAdjustmentResponse, UpdatePriceAdjustmentResponse, PriceAdjustmentResponse, GetPriceAdjustmentResponse, PriceAdjustmentAdd, DistributionRule, Distribution, DistributionLogic, CartItem, OpenapiCartDetailsRequest, CouponBreakup, DisplayBreakup, LoyaltyPoints, RawBreakup, CartBreakup, ProductImage, Tags, BaseInfo, ActionQuery, ProductAction, CategoryInfo, CartProduct, BasePrice, ArticleAppliedPriceAdjustment, ArticlePriceInfo, StoreInfo, ArticleGiftCard, ProductArticle, PromoDiscountRuleOffer, PromoDiscountRuleRawOffer, PromoDiscountRuleItemCriteria, DiscountRulesApp, AppliedFreeArticles, PromoBuyRuleCartConditions, PromoBuyRuleCompareFieldsTypes, BuyRules, AppliedPromotion, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, CouponDetails, ProductPrice, ProductPriceInfo, CartProductIdentifer, ProductAvailabilitySize, ProductAvailability, PromoMeta, ParentItemIdentifiers, CartItemMOQ, CartItemCustomOrder, CartProductInfo, DiscountMeta, PriceAdjustmentApplied, OpenapiCartDetailsResponse, OpenApiErrorResponse, ShippingAddress, OpenApiCartServiceabilityRequest, OpenApiCartServiceabilityResponse, OpenApiFiles, CartItemMeta, MultiTenderPaymentMeta, MultiTenderPaymentMethod, OpenApiOrderItem, OpenApiPlatformCheckoutReq, OpenApiCheckoutResponse, AbandonedCart, AbandonedCartResponse, PaymentSelectionLock, CartCurrency, CartCouponMedias, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig, CartAppliedPriceAdjustment, CustomCart, CartDetailResponse, AddProductCart, ArticleAssignment, AddCartRequest, AddCartDetailResponse, UpdateProductCart, UpdateCartRequest, UpdateCartDetailResponse, OverrideCartItemPromo, OverrideCartItem, OverrideCheckoutReq, OverrideCheckoutResponse, GetShareCartLinkRequest, GetShareCartLinkResponse, SharedCartDetails, SharedCart, SharedCartResponse, CartList, MultiCartResponse, UpdateUserCartMapping, UserCartMappingResponse, CartMappingUserInfo, PlatformAddCartRequest, PlatformUpdateCartRequest, DeleteCartRequest, DeleteCartDetailResponse, CartItemCountResponse, Coupon, PageCoupon, GetCouponResponse, ApplyCouponRequest, GeoLocation, PlatformAddress, AddressCustomJson, ValidationConfig, PlatformGetAddressesResponse, SaveAddressResponse, UpdateAddressResponse, DeleteAddressResponse, PlatformSelectCartAddressRequest, ShipmentArticle, ShipmentError, PlatformShipmentResponse, ShipmentMeta, ShipmentMetaDimension, ShipmentLogisticsMeta, ShipmentLogisticsMetaAccount, ShipmentLogisticsMetaAccountAreaCode, ShipmentLogisticsMetaAccountDpTat, PlatformCartShipmentsResponse, UpdateCartShipmentItem, UpdateCartShipmentRequest, PlatformCartMetaRequest, CartMetaResponse, CartMetaMissingResponse, CartMetaFieldsValidation, StaffCheckout, CustomerDetails, Files, CartCheckoutCustomMeta, PlatformCartCheckoutDetailRequest, CheckCart, CartCheckoutResponse, CartDeliveryModesResponse, PickupStoreDetail, StoreDetailsResponse, UpdateCartPaymentRequest, CouponValidity, PaymentCouponValidate, PaymentMeta, PaymentMethod, PlatformCartCheckoutDetailV2Request, UpdateCartPaymentRequestV2, PriceMinMax, ItemPriceDetails, FreeGiftItems, PromotionOffer, PromotionOffersResponse, PromotionPaymentOffer, CouponOptions, CouponOptionTypes, CouponOptionScopes, CouponOptionsApplicable, CouponOptionsValueTypes, CouponOptionsCalculate, CouponOptionsPayableCategory, CouponOptionsTxnMode, CouponOptionsPayableBy, SelectAddressResponseError, AllAddressForSelectAddress, ValidationError };
|
|
2517
2604
|
}
|
|
2518
2605
|
/** @returns {CouponDateMeta} */
|
|
2519
2606
|
declare function CouponDateMeta(): CouponDateMeta;
|
|
@@ -3062,6 +3149,11 @@ type PromotionListItem = {
|
|
|
3062
3149
|
* - Promotion id
|
|
3063
3150
|
*/
|
|
3064
3151
|
_id?: string;
|
|
3152
|
+
/**
|
|
3153
|
+
* - Flag to verify if promotion is ready to
|
|
3154
|
+
* be applied on cart and ready to update promotion
|
|
3155
|
+
*/
|
|
3156
|
+
is_processed?: boolean;
|
|
3065
3157
|
code?: string;
|
|
3066
3158
|
tags?: string[];
|
|
3067
3159
|
};
|
|
@@ -3104,38 +3196,254 @@ type PromotionAdd = {
|
|
|
3104
3196
|
indexed_criteria?: PromoIndexedCriteria[];
|
|
3105
3197
|
tags?: string[];
|
|
3106
3198
|
};
|
|
3199
|
+
/** @returns {PromotionAddResult} */
|
|
3200
|
+
declare function PromotionAddResult(): PromotionAddResult;
|
|
3201
|
+
type PromotionAddResult = {
|
|
3202
|
+
/**
|
|
3203
|
+
* - Boolean value set true to apply other promotions also
|
|
3204
|
+
*/
|
|
3205
|
+
stackable?: boolean;
|
|
3206
|
+
/**
|
|
3207
|
+
* - Article Price on which promotion
|
|
3208
|
+
* calculated like effective price or marked price. Only available for
|
|
3209
|
+
* Contract pricing and Ladder pricing promotion type
|
|
3210
|
+
*/
|
|
3211
|
+
calculate_on?: string;
|
|
3212
|
+
/**
|
|
3213
|
+
* - Promotion should apply on either
|
|
3214
|
+
* article or cart.
|
|
3215
|
+
*/
|
|
3216
|
+
apply_exclusive?: string;
|
|
3217
|
+
/**
|
|
3218
|
+
* - The type of promotion group
|
|
3219
|
+
*/
|
|
3220
|
+
promo_group: string;
|
|
3221
|
+
/**
|
|
3222
|
+
* - Promotion mode, like coupon or promotion
|
|
3223
|
+
*/
|
|
3224
|
+
mode: string;
|
|
3225
|
+
/**
|
|
3226
|
+
* - Flag to verify if promotion is ready to
|
|
3227
|
+
* be applied on cart and ready to update promotion
|
|
3228
|
+
*/
|
|
3229
|
+
is_processed?: boolean;
|
|
3230
|
+
/**
|
|
3231
|
+
* - True means to apply all discount offers
|
|
3232
|
+
*/
|
|
3233
|
+
apply_all_discount?: boolean;
|
|
3234
|
+
display_meta?: DisplayMeta1;
|
|
3235
|
+
ownership?: Ownership;
|
|
3236
|
+
/**
|
|
3237
|
+
* - Type of promotion
|
|
3238
|
+
*/
|
|
3239
|
+
promotion_type: string;
|
|
3240
|
+
/**
|
|
3241
|
+
* - List of discount offers and
|
|
3242
|
+
* their applicable conditions
|
|
3243
|
+
*/
|
|
3244
|
+
discount_rules?: DiscountRule[];
|
|
3245
|
+
restrictions?: Restrictions1;
|
|
3246
|
+
/**
|
|
3247
|
+
* - Promotion Currency code like INR
|
|
3248
|
+
*/
|
|
3249
|
+
currency?: string;
|
|
3250
|
+
/**
|
|
3251
|
+
* - Promotion unique code
|
|
3252
|
+
*/
|
|
3253
|
+
code?: string;
|
|
3254
|
+
_schedule?: PromotionSchedule;
|
|
3255
|
+
post_order_action?: PromotionAction;
|
|
3256
|
+
/**
|
|
3257
|
+
* - Promotion applicable priority
|
|
3258
|
+
*/
|
|
3259
|
+
apply_priority?: number;
|
|
3260
|
+
author?: PromotionAuthor;
|
|
3261
|
+
visiblility?: Visibility;
|
|
3262
|
+
/**
|
|
3263
|
+
* - Current application id of sales channel
|
|
3264
|
+
*/
|
|
3265
|
+
application_id: string;
|
|
3266
|
+
buy_rules?: any;
|
|
3267
|
+
/**
|
|
3268
|
+
* - Set extra properties in promotion
|
|
3269
|
+
*/
|
|
3270
|
+
_custom_json?: any;
|
|
3271
|
+
date_meta?: PromotionDateMeta;
|
|
3272
|
+
indexed_criteria?: PromoIndexedCriteria[];
|
|
3273
|
+
/**
|
|
3274
|
+
* - List of tags applicable for promotion
|
|
3275
|
+
*/
|
|
3276
|
+
tags?: string[];
|
|
3277
|
+
/**
|
|
3278
|
+
* - Unique idenfier of promotion.
|
|
3279
|
+
*/
|
|
3280
|
+
_id?: string;
|
|
3281
|
+
};
|
|
3107
3282
|
/** @returns {PromotionUpdate} */
|
|
3108
3283
|
declare function PromotionUpdate(): PromotionUpdate;
|
|
3109
3284
|
type PromotionUpdate = {
|
|
3110
|
-
|
|
3285
|
+
/**
|
|
3286
|
+
* - Set true to apply other promotions in cart
|
|
3287
|
+
*/
|
|
3111
3288
|
stackable?: boolean;
|
|
3112
3289
|
/**
|
|
3113
|
-
* -
|
|
3114
|
-
*
|
|
3290
|
+
* - Article Price on which promotion
|
|
3291
|
+
* calculated like effective price or marked price. Only available for
|
|
3292
|
+
* Contract pricing and Ladder pricing promotion type
|
|
3115
3293
|
*/
|
|
3116
3294
|
calculate_on?: string;
|
|
3295
|
+
/**
|
|
3296
|
+
* - Promotion should apply on either
|
|
3297
|
+
* article or cart.
|
|
3298
|
+
*/
|
|
3117
3299
|
apply_exclusive?: string;
|
|
3300
|
+
/**
|
|
3301
|
+
* - Promotion rejection reason added by reviewer
|
|
3302
|
+
*/
|
|
3303
|
+
reason?: string;
|
|
3304
|
+
/**
|
|
3305
|
+
* - The type of promotion group
|
|
3306
|
+
*/
|
|
3118
3307
|
promo_group: string;
|
|
3308
|
+
/**
|
|
3309
|
+
* - Promotion mode
|
|
3310
|
+
*/
|
|
3119
3311
|
mode: string;
|
|
3312
|
+
/**
|
|
3313
|
+
* - True means to apply all discount offers
|
|
3314
|
+
*/
|
|
3120
3315
|
apply_all_discount?: boolean;
|
|
3121
|
-
display_meta
|
|
3122
|
-
ownership
|
|
3316
|
+
display_meta?: DisplayMeta1;
|
|
3317
|
+
ownership?: Ownership;
|
|
3318
|
+
/**
|
|
3319
|
+
* - The Promotion type like amount, bogo and
|
|
3320
|
+
* percentage etc.
|
|
3321
|
+
*/
|
|
3123
3322
|
promotion_type: string;
|
|
3124
|
-
|
|
3323
|
+
/**
|
|
3324
|
+
* - List of discount offers and
|
|
3325
|
+
* their applicable conditions
|
|
3326
|
+
*/
|
|
3327
|
+
discount_rules?: DiscountRule[];
|
|
3125
3328
|
restrictions?: Restrictions1;
|
|
3329
|
+
/**
|
|
3330
|
+
* - Promotion Currency code like INR
|
|
3331
|
+
*/
|
|
3126
3332
|
currency?: string;
|
|
3333
|
+
/**
|
|
3334
|
+
* - Promotion unique code
|
|
3335
|
+
*/
|
|
3127
3336
|
code?: string;
|
|
3128
3337
|
_schedule?: PromotionSchedule;
|
|
3129
3338
|
post_order_action?: PromotionAction;
|
|
3339
|
+
/**
|
|
3340
|
+
* - Promotion applicable priority
|
|
3341
|
+
*/
|
|
3130
3342
|
apply_priority?: number;
|
|
3131
3343
|
author?: PromotionAuthor;
|
|
3132
3344
|
visiblility?: Visibility;
|
|
3345
|
+
/**
|
|
3346
|
+
* - Current application id of sales channel
|
|
3347
|
+
*/
|
|
3133
3348
|
application_id: string;
|
|
3134
|
-
buy_rules
|
|
3349
|
+
buy_rules?: any;
|
|
3350
|
+
/**
|
|
3351
|
+
* - Set extra properties in promotion
|
|
3352
|
+
*/
|
|
3353
|
+
_custom_json?: any;
|
|
3354
|
+
date_meta?: PromotionDateMeta;
|
|
3355
|
+
/**
|
|
3356
|
+
* - List of tags applicable for promotion
|
|
3357
|
+
*/
|
|
3358
|
+
tags?: string[];
|
|
3359
|
+
};
|
|
3360
|
+
/** @returns {PromotionUpdateResult} */
|
|
3361
|
+
declare function PromotionUpdateResult(): PromotionUpdateResult;
|
|
3362
|
+
type PromotionUpdateResult = {
|
|
3363
|
+
/**
|
|
3364
|
+
* - Set true to apply other promotions in cart
|
|
3365
|
+
*/
|
|
3366
|
+
stackable?: boolean;
|
|
3367
|
+
/**
|
|
3368
|
+
* - Article Price on which promotion
|
|
3369
|
+
* calculated like effective price or marked price. Only available for
|
|
3370
|
+
* Contract pricing and Ladder pricing promotion type
|
|
3371
|
+
*/
|
|
3372
|
+
calculate_on?: string;
|
|
3373
|
+
/**
|
|
3374
|
+
* - Promotion should apply on either
|
|
3375
|
+
* article or cart.
|
|
3376
|
+
*/
|
|
3377
|
+
apply_exclusive?: string;
|
|
3378
|
+
/**
|
|
3379
|
+
* - Promotion rejection reason added by reviewer
|
|
3380
|
+
*/
|
|
3381
|
+
reason?: string;
|
|
3382
|
+
/**
|
|
3383
|
+
* - Flag to verify if promotion is ready to
|
|
3384
|
+
* be applied on cart and ready to update promotion
|
|
3385
|
+
*/
|
|
3386
|
+
is_processed?: boolean;
|
|
3387
|
+
/**
|
|
3388
|
+
* - The type of promotion group
|
|
3389
|
+
*/
|
|
3390
|
+
promo_group: string;
|
|
3391
|
+
/**
|
|
3392
|
+
* - Promotion mode
|
|
3393
|
+
*/
|
|
3394
|
+
mode: string;
|
|
3395
|
+
/**
|
|
3396
|
+
* - True means to apply all discount offers
|
|
3397
|
+
*/
|
|
3398
|
+
apply_all_discount?: boolean;
|
|
3399
|
+
display_meta?: DisplayMeta1;
|
|
3400
|
+
ownership?: Ownership;
|
|
3401
|
+
/**
|
|
3402
|
+
* - The Promotion type like amount, bogo and
|
|
3403
|
+
* percentage etc.
|
|
3404
|
+
*/
|
|
3405
|
+
promotion_type: string;
|
|
3406
|
+
/**
|
|
3407
|
+
* - List of discount offers and
|
|
3408
|
+
* their applicable conditions
|
|
3409
|
+
*/
|
|
3410
|
+
discount_rules?: DiscountRule[];
|
|
3411
|
+
restrictions?: Restrictions1;
|
|
3412
|
+
/**
|
|
3413
|
+
* - Promotion Currency code like INR
|
|
3414
|
+
*/
|
|
3415
|
+
currency?: string;
|
|
3416
|
+
/**
|
|
3417
|
+
* - Promotion unique code
|
|
3418
|
+
*/
|
|
3419
|
+
code?: string;
|
|
3420
|
+
_schedule?: PromotionSchedule;
|
|
3421
|
+
post_order_action?: PromotionAction;
|
|
3422
|
+
/**
|
|
3423
|
+
* - Promotion applicable priority
|
|
3424
|
+
*/
|
|
3425
|
+
apply_priority?: number;
|
|
3426
|
+
author?: PromotionAuthor;
|
|
3427
|
+
visiblility?: Visibility;
|
|
3428
|
+
/**
|
|
3429
|
+
* - Current application id of sales channel
|
|
3430
|
+
*/
|
|
3431
|
+
application_id: string;
|
|
3432
|
+
buy_rules?: any;
|
|
3433
|
+
/**
|
|
3434
|
+
* - Set extra properties in promotion
|
|
3435
|
+
*/
|
|
3135
3436
|
_custom_json?: any;
|
|
3136
3437
|
date_meta?: PromotionDateMeta;
|
|
3137
3438
|
indexed_criteria?: PromoIndexedCriteria[];
|
|
3439
|
+
/**
|
|
3440
|
+
* - List of tags applicable for promotion
|
|
3441
|
+
*/
|
|
3138
3442
|
tags?: string[];
|
|
3443
|
+
/**
|
|
3444
|
+
* - Auto generated id of specific promotion
|
|
3445
|
+
*/
|
|
3446
|
+
_id?: string;
|
|
3139
3447
|
};
|
|
3140
3448
|
/** @returns {PromoIndexedCriteria} */
|
|
3141
3449
|
declare function PromoIndexedCriteria(): PromoIndexedCriteria;
|
|
@@ -5072,7 +5380,7 @@ type UpdateProductCart = {
|
|
|
5072
5380
|
_custom_json?: any;
|
|
5073
5381
|
price_factory_type_id?: string;
|
|
5074
5382
|
item_id?: number;
|
|
5075
|
-
item_index
|
|
5383
|
+
item_index: number;
|
|
5076
5384
|
identifiers: CartProductIdentifer;
|
|
5077
5385
|
article_id?: string;
|
|
5078
5386
|
};
|
|
@@ -5499,11 +5807,24 @@ type AddressCustomJson = {
|
|
|
5499
5807
|
meta_data?: string;
|
|
5500
5808
|
meta_data_int?: number;
|
|
5501
5809
|
};
|
|
5810
|
+
/** @returns {ValidationConfig} */
|
|
5811
|
+
declare function ValidationConfig(): ValidationConfig;
|
|
5812
|
+
type ValidationConfig = {
|
|
5813
|
+
/**
|
|
5814
|
+
* - The maximum number of addresses a user can have.
|
|
5815
|
+
*/
|
|
5816
|
+
address_max_limit: number;
|
|
5817
|
+
/**
|
|
5818
|
+
* - The total number of addresses saved by a user.
|
|
5819
|
+
*/
|
|
5820
|
+
user_address_count: number;
|
|
5821
|
+
};
|
|
5502
5822
|
/** @returns {PlatformGetAddressesResponse} */
|
|
5503
5823
|
declare function PlatformGetAddressesResponse(): PlatformGetAddressesResponse;
|
|
5504
5824
|
type PlatformGetAddressesResponse = {
|
|
5505
5825
|
address?: PlatformAddress[];
|
|
5506
5826
|
pii_masking?: boolean;
|
|
5827
|
+
validation_config?: ValidationConfig;
|
|
5507
5828
|
};
|
|
5508
5829
|
/** @returns {SaveAddressResponse} */
|
|
5509
5830
|
declare function SaveAddressResponse(): SaveAddressResponse;
|
|
@@ -6398,4 +6719,17 @@ declare function AllAddressForSelectAddress(): AllAddressForSelectAddress;
|
|
|
6398
6719
|
type AllAddressForSelectAddress = {
|
|
6399
6720
|
address?: PlatformAddress[];
|
|
6400
6721
|
pii_masking?: boolean;
|
|
6722
|
+
validation_config?: ValidationConfig;
|
|
6723
|
+
};
|
|
6724
|
+
/** @returns {ValidationError} */
|
|
6725
|
+
declare function ValidationError(): ValidationError;
|
|
6726
|
+
type ValidationError = {
|
|
6727
|
+
/**
|
|
6728
|
+
* - A brief description of the error encountered.
|
|
6729
|
+
*/
|
|
6730
|
+
message: string;
|
|
6731
|
+
/**
|
|
6732
|
+
* - The field in the request that caused the error.
|
|
6733
|
+
*/
|
|
6734
|
+
field: string;
|
|
6401
6735
|
};
|