@gofynd/fdk-client-javascript 3.23.0 → 3.25.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 +12 -12
- package/sdk/application/Cart/CartApplicationClient.js +119 -33
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +1 -1
- package/sdk/application/Catalog/CatalogApplicationClient.js +1 -1
- package/sdk/application/Common/CommonApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.js +4 -2
- package/sdk/application/Order/OrderApplicationClient.d.ts +1 -1
- package/sdk/application/Order/OrderApplicationClient.js +4 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +84 -13
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -0
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +52 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +19 -27
- package/sdk/platform/Cart/CartPlatformModel.js +8 -18
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +7 -2
- package/sdk/platform/Catalog/CatalogPlatformModel.js +5 -2
- package/sdk/platform/Common/CommonPlatformClient.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +96 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +61 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +48 -12
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +316 -81
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +27 -10
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +38 -12
- package/sdk/platform/Content/ContentPlatformModel.d.ts +102 -1
- package/sdk/platform/Content/ContentPlatformModel.js +88 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +28 -0
- package/sdk/platform/Order/OrderPlatformClient.js +179 -3
- package/sdk/platform/Order/OrderPlatformModel.d.ts +155 -6
- package/sdk/platform/Order/OrderPlatformModel.js +105 -3
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +33 -1
- package/sdk/platform/Order/OrderPlatformValidator.js +30 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +63 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +43 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +14 -1
- package/sdk/platform/User/UserPlatformModel.js +16 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
|
@@ -1323,6 +1323,7 @@ export = CartPlatformModel;
|
|
|
1323
1323
|
* @property {string} [item_type] - Type of the item in cart.
|
|
1324
1324
|
* @property {ArticleCharges[]} [charges] - Charges information which denotes
|
|
1325
1325
|
* types of charges and amount of charge applied to that product in cart.
|
|
1326
|
+
* @property {string} [added_on] - Date and time when the item was added to the cart.
|
|
1326
1327
|
*/
|
|
1327
1328
|
/**
|
|
1328
1329
|
* @typedef OpenapiCartDetailsResult
|
|
@@ -1978,6 +1979,11 @@ export = CartPlatformModel;
|
|
|
1978
1979
|
* applied to cart or not
|
|
1979
1980
|
* @property {string} [coupon_type] - Type of the coupon applied to cart
|
|
1980
1981
|
* @property {string} [expires_on] - Message to display to user for expiry of the coupon
|
|
1982
|
+
* @property {string} [expires_at] - Represents the last valid timeslot date on
|
|
1983
|
+
* which the coupon can be applied in ISO 8601 (UTC Z) format,based on its
|
|
1984
|
+
* configured schedule. If the coupon is restricted to specific days (e.g.,
|
|
1985
|
+
* Mondays and Thursdays), the expiry date will be the last eligible day
|
|
1986
|
+
* within the overall end date range, not necessarily the end date itself.
|
|
1981
1987
|
* @property {number} [coupon_value] - Coupon value of the coupon applied to cart
|
|
1982
1988
|
* @property {string} [sub_title] - Coupon subtitle of the coupon applied to
|
|
1983
1989
|
* cart which is used to display
|
|
@@ -2821,18 +2827,10 @@ export = CartPlatformModel;
|
|
|
2821
2827
|
* @property {string} [approved_on] - Date time format when the offer approved
|
|
2822
2828
|
* @property {string} [rejected_on] - Date time format when the offer rejected
|
|
2823
2829
|
*/
|
|
2824
|
-
/**
|
|
2825
|
-
* @typedef NextScheduleItems
|
|
2826
|
-
* @property {string} [start] - Start date of schedule
|
|
2827
|
-
* @property {string} [end] - End date of schedule
|
|
2828
|
-
*/
|
|
2829
2830
|
/**
|
|
2830
2831
|
* @typedef OfferSchedule
|
|
2831
2832
|
* @property {string} end - The end date and time until which the offer remains valid.
|
|
2832
2833
|
* @property {string} start - The start date and time from which the offer becomes valid.
|
|
2833
|
-
* @property {NextScheduleItems[]} [next_schedule] - A auto generated list of
|
|
2834
|
-
* date-time entries based on start, end, cron and duration data on which the
|
|
2835
|
-
* offer is scheduled to activate in the future.
|
|
2836
2834
|
* @property {string} [cron] - A cron expression used to schedule the offer to
|
|
2837
2835
|
* activate periodically. When cron is null or not provided, duration is optional.
|
|
2838
2836
|
* @property {number} [duration] - Duration of the offer activation in seconds.
|
|
@@ -2858,7 +2856,7 @@ export = CartPlatformModel;
|
|
|
2858
2856
|
declare class CartPlatformModel {
|
|
2859
2857
|
}
|
|
2860
2858
|
declare namespace CartPlatformModel {
|
|
2861
|
-
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, CurrencyValue, ChargesAmount, ArticleCharges, 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, UpdateCartBreakup, 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, CartCheckoutDetailsData, CartCheckoutDetails, CartCheckoutResult, CartDeliveryModesDetails, PickupStoreDetail, StoreDetails, CartPaymentUpdate, CouponValidity, PaymentCouponValidate, PaymentMeta, PaymentMethod, PlatformCartCheckoutDetailV2Creation, UpdateCartPaymentRequestV2, PriceMinMax, ItemPriceDetails, ArticlePriceDetails, FreeGiftItems, DiscountOfferRule, PromotionOffer, PromotionOffersDetails, PromotionPaymentOffer, PromotionPaymentOffersDetails, ValidationError, OfferUser, OfferItemCriteria, DiscountRuleOffer, OfferDiscountRule, OfferUsesRemaining, OfferUsesRestriction, OfferRestrictionFulfillmentOptions, OfferRestrictions, OfferDisplayMeta, OfferCouponConfiguration, OfferOwnership, OfferSchema, OfferPartialUpdate, OfferAuthor, OfferDateMeta,
|
|
2859
|
+
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, CurrencyValue, ChargesAmount, ArticleCharges, 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, UpdateCartBreakup, 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, CartCheckoutDetailsData, CartCheckoutDetails, CartCheckoutResult, CartDeliveryModesDetails, PickupStoreDetail, StoreDetails, CartPaymentUpdate, CouponValidity, PaymentCouponValidate, PaymentMeta, PaymentMethod, PlatformCartCheckoutDetailV2Creation, UpdateCartPaymentRequestV2, PriceMinMax, ItemPriceDetails, ArticlePriceDetails, FreeGiftItems, DiscountOfferRule, PromotionOffer, PromotionOffersDetails, PromotionPaymentOffer, PromotionPaymentOffersDetails, ValidationError, OfferUser, OfferItemCriteria, DiscountRuleOffer, OfferDiscountRule, OfferUsesRemaining, OfferUsesRestriction, OfferRestrictionFulfillmentOptions, OfferRestrictions, OfferDisplayMeta, OfferCouponConfiguration, OfferOwnership, OfferSchema, OfferPartialUpdate, OfferAuthor, OfferDateMeta, OfferSchedule, OfferListItem, OfferListResult };
|
|
2862
2860
|
}
|
|
2863
2861
|
/** @returns {RedeemLoyaltyPoints} */
|
|
2864
2862
|
declare function RedeemLoyaltyPoints(): RedeemLoyaltyPoints;
|
|
@@ -6085,6 +6083,10 @@ type CartProductInfo = {
|
|
|
6085
6083
|
* types of charges and amount of charge applied to that product in cart.
|
|
6086
6084
|
*/
|
|
6087
6085
|
charges?: ArticleCharges[];
|
|
6086
|
+
/**
|
|
6087
|
+
* - Date and time when the item was added to the cart.
|
|
6088
|
+
*/
|
|
6089
|
+
added_on?: string;
|
|
6088
6090
|
};
|
|
6089
6091
|
/** @returns {OpenapiCartDetailsResult} */
|
|
6090
6092
|
declare function OpenapiCartDetailsResult(): OpenapiCartDetailsResult;
|
|
@@ -7807,6 +7809,14 @@ type Coupon = {
|
|
|
7807
7809
|
* - Message to display to user for expiry of the coupon
|
|
7808
7810
|
*/
|
|
7809
7811
|
expires_on?: string;
|
|
7812
|
+
/**
|
|
7813
|
+
* - Represents the last valid timeslot date on
|
|
7814
|
+
* which the coupon can be applied in ISO 8601 (UTC Z) format,based on its
|
|
7815
|
+
* configured schedule. If the coupon is restricted to specific days (e.g.,
|
|
7816
|
+
* Mondays and Thursdays), the expiry date will be the last eligible day
|
|
7817
|
+
* within the overall end date range, not necessarily the end date itself.
|
|
7818
|
+
*/
|
|
7819
|
+
expires_at?: string;
|
|
7810
7820
|
/**
|
|
7811
7821
|
* - Coupon value of the coupon applied to cart
|
|
7812
7822
|
*/
|
|
@@ -9854,18 +9864,6 @@ type OfferDateMeta = {
|
|
|
9854
9864
|
*/
|
|
9855
9865
|
rejected_on?: string;
|
|
9856
9866
|
};
|
|
9857
|
-
/** @returns {NextScheduleItems} */
|
|
9858
|
-
declare function NextScheduleItems(): NextScheduleItems;
|
|
9859
|
-
type NextScheduleItems = {
|
|
9860
|
-
/**
|
|
9861
|
-
* - Start date of schedule
|
|
9862
|
-
*/
|
|
9863
|
-
start?: string;
|
|
9864
|
-
/**
|
|
9865
|
-
* - End date of schedule
|
|
9866
|
-
*/
|
|
9867
|
-
end?: string;
|
|
9868
|
-
};
|
|
9869
9867
|
/** @returns {OfferSchedule} */
|
|
9870
9868
|
declare function OfferSchedule(): OfferSchedule;
|
|
9871
9869
|
type OfferSchedule = {
|
|
@@ -9877,12 +9875,6 @@ type OfferSchedule = {
|
|
|
9877
9875
|
* - The start date and time from which the offer becomes valid.
|
|
9878
9876
|
*/
|
|
9879
9877
|
start: string;
|
|
9880
|
-
/**
|
|
9881
|
-
* - A auto generated list of
|
|
9882
|
-
* date-time entries based on start, end, cron and duration data on which the
|
|
9883
|
-
* offer is scheduled to activate in the future.
|
|
9884
|
-
*/
|
|
9885
|
-
next_schedule?: NextScheduleItems[];
|
|
9886
9878
|
/**
|
|
9887
9879
|
* - A cron expression used to schedule the offer to
|
|
9888
9880
|
* activate periodically. When cron is null or not provided, duration is optional.
|
|
@@ -1442,6 +1442,7 @@ const Joi = require("joi");
|
|
|
1442
1442
|
* @property {string} [item_type] - Type of the item in cart.
|
|
1443
1443
|
* @property {ArticleCharges[]} [charges] - Charges information which denotes
|
|
1444
1444
|
* types of charges and amount of charge applied to that product in cart.
|
|
1445
|
+
* @property {string} [added_on] - Date and time when the item was added to the cart.
|
|
1445
1446
|
*/
|
|
1446
1447
|
|
|
1447
1448
|
/**
|
|
@@ -2150,6 +2151,11 @@ const Joi = require("joi");
|
|
|
2150
2151
|
* applied to cart or not
|
|
2151
2152
|
* @property {string} [coupon_type] - Type of the coupon applied to cart
|
|
2152
2153
|
* @property {string} [expires_on] - Message to display to user for expiry of the coupon
|
|
2154
|
+
* @property {string} [expires_at] - Represents the last valid timeslot date on
|
|
2155
|
+
* which the coupon can be applied in ISO 8601 (UTC Z) format,based on its
|
|
2156
|
+
* configured schedule. If the coupon is restricted to specific days (e.g.,
|
|
2157
|
+
* Mondays and Thursdays), the expiry date will be the last eligible day
|
|
2158
|
+
* within the overall end date range, not necessarily the end date itself.
|
|
2153
2159
|
* @property {number} [coupon_value] - Coupon value of the coupon applied to cart
|
|
2154
2160
|
* @property {string} [sub_title] - Coupon subtitle of the coupon applied to
|
|
2155
2161
|
* cart which is used to display
|
|
@@ -3058,19 +3064,10 @@ const Joi = require("joi");
|
|
|
3058
3064
|
* @property {string} [rejected_on] - Date time format when the offer rejected
|
|
3059
3065
|
*/
|
|
3060
3066
|
|
|
3061
|
-
/**
|
|
3062
|
-
* @typedef NextScheduleItems
|
|
3063
|
-
* @property {string} [start] - Start date of schedule
|
|
3064
|
-
* @property {string} [end] - End date of schedule
|
|
3065
|
-
*/
|
|
3066
|
-
|
|
3067
3067
|
/**
|
|
3068
3068
|
* @typedef OfferSchedule
|
|
3069
3069
|
* @property {string} end - The end date and time until which the offer remains valid.
|
|
3070
3070
|
* @property {string} start - The start date and time from which the offer becomes valid.
|
|
3071
|
-
* @property {NextScheduleItems[]} [next_schedule] - A auto generated list of
|
|
3072
|
-
* date-time entries based on start, end, cron and duration data on which the
|
|
3073
|
-
* offer is scheduled to activate in the future.
|
|
3074
3071
|
* @property {string} [cron] - A cron expression used to schedule the offer to
|
|
3075
3072
|
* activate periodically. When cron is null or not provided, duration is optional.
|
|
3076
3073
|
* @property {number} [duration] - Duration of the offer activation in seconds.
|
|
@@ -4567,6 +4564,7 @@ class CartPlatformModel {
|
|
|
4567
4564
|
custom_order: Joi.object().pattern(/\S/, Joi.any()),
|
|
4568
4565
|
item_type: Joi.string().allow(""),
|
|
4569
4566
|
charges: Joi.array().items(CartPlatformModel.ArticleCharges()),
|
|
4567
|
+
added_on: Joi.string().allow("").allow(null),
|
|
4570
4568
|
});
|
|
4571
4569
|
}
|
|
4572
4570
|
|
|
@@ -5280,6 +5278,7 @@ class CartPlatformModel {
|
|
|
5280
5278
|
is_applied: Joi.boolean(),
|
|
5281
5279
|
coupon_type: Joi.string().allow("").allow(null),
|
|
5282
5280
|
expires_on: Joi.string().allow(""),
|
|
5281
|
+
expires_at: Joi.string().allow("").allow(null),
|
|
5283
5282
|
coupon_value: Joi.number(),
|
|
5284
5283
|
sub_title: Joi.string().allow(""),
|
|
5285
5284
|
minimum_cart_value: Joi.number(),
|
|
@@ -6153,20 +6152,11 @@ class CartPlatformModel {
|
|
|
6153
6152
|
});
|
|
6154
6153
|
}
|
|
6155
6154
|
|
|
6156
|
-
/** @returns {NextScheduleItems} */
|
|
6157
|
-
static NextScheduleItems() {
|
|
6158
|
-
return Joi.object({
|
|
6159
|
-
start: Joi.string().allow(""),
|
|
6160
|
-
end: Joi.string().allow(""),
|
|
6161
|
-
});
|
|
6162
|
-
}
|
|
6163
|
-
|
|
6164
6155
|
/** @returns {OfferSchedule} */
|
|
6165
6156
|
static OfferSchedule() {
|
|
6166
6157
|
return Joi.object({
|
|
6167
6158
|
end: Joi.string().allow("").required(),
|
|
6168
6159
|
start: Joi.string().allow("").required(),
|
|
6169
|
-
next_schedule: Joi.array().items(CartPlatformModel.NextScheduleItems()),
|
|
6170
6160
|
cron: Joi.string().allow("").allow(null),
|
|
6171
6161
|
duration: Joi.number().allow(null),
|
|
6172
6162
|
});
|
|
@@ -4608,7 +4608,8 @@ export = CatalogPlatformModel;
|
|
|
4608
4608
|
/**
|
|
4609
4609
|
* @typedef CreateTaxRequestBody
|
|
4610
4610
|
* @property {TaxReqBodyRule} rule
|
|
4611
|
-
* @property {TaxReqBodyVersion} versions
|
|
4611
|
+
* @property {TaxReqBodyVersion[]} versions - One or more tax versions to create
|
|
4612
|
+
* with the rule (at least one required).
|
|
4612
4613
|
*/
|
|
4613
4614
|
/**
|
|
4614
4615
|
* @typedef TaxVersion
|
|
@@ -14896,7 +14897,11 @@ type RegionReference = {
|
|
|
14896
14897
|
declare function CreateTaxRequestBody(): CreateTaxRequestBody;
|
|
14897
14898
|
type CreateTaxRequestBody = {
|
|
14898
14899
|
rule: TaxReqBodyRule;
|
|
14899
|
-
|
|
14900
|
+
/**
|
|
14901
|
+
* - One or more tax versions to create
|
|
14902
|
+
* with the rule (at least one required).
|
|
14903
|
+
*/
|
|
14904
|
+
versions: TaxReqBodyVersion[];
|
|
14900
14905
|
};
|
|
14901
14906
|
/** @returns {TaxVersion} */
|
|
14902
14907
|
declare function TaxVersion(): TaxVersion;
|
|
@@ -5050,7 +5050,8 @@ const Joi = require("joi");
|
|
|
5050
5050
|
/**
|
|
5051
5051
|
* @typedef CreateTaxRequestBody
|
|
5052
5052
|
* @property {TaxReqBodyRule} rule
|
|
5053
|
-
* @property {TaxReqBodyVersion} versions
|
|
5053
|
+
* @property {TaxReqBodyVersion[]} versions - One or more tax versions to create
|
|
5054
|
+
* with the rule (at least one required).
|
|
5054
5055
|
*/
|
|
5055
5056
|
|
|
5056
5057
|
/**
|
|
@@ -10788,7 +10789,9 @@ class CatalogPlatformModel {
|
|
|
10788
10789
|
static CreateTaxRequestBody() {
|
|
10789
10790
|
return Joi.object({
|
|
10790
10791
|
rule: CatalogPlatformModel.TaxReqBodyRule().required(),
|
|
10791
|
-
versions:
|
|
10792
|
+
versions: Joi.array()
|
|
10793
|
+
.items(CatalogPlatformModel.TaxReqBodyVersion())
|
|
10794
|
+
.required(),
|
|
10792
10795
|
});
|
|
10793
10796
|
}
|
|
10794
10797
|
|
|
@@ -129,7 +129,7 @@ class Common {
|
|
|
129
129
|
query_params["query"] = query;
|
|
130
130
|
|
|
131
131
|
const xHeaders = {};
|
|
132
|
-
xHeaders["authorization"] = authorization;
|
|
132
|
+
if (authorization !== undefined) xHeaders["authorization"] = authorization;
|
|
133
133
|
|
|
134
134
|
const response = await PlatformAPIClient.execute(
|
|
135
135
|
this.config,
|
|
@@ -32,6 +32,7 @@ export = ConfigurationPlatformModel;
|
|
|
32
32
|
* @property {AppOrderConfig} [order]
|
|
33
33
|
* @property {AppLogisticsConfig} [logistics]
|
|
34
34
|
* @property {PiiMasking} [pii_masking]
|
|
35
|
+
* @property {ChannelCapabilities} [channel_capabilities]
|
|
35
36
|
* @property {string[]} [tags]
|
|
36
37
|
* @property {number} [__v]
|
|
37
38
|
* @property {string} [business] - Indicates the business type for sales channel
|
|
@@ -54,6 +55,30 @@ export = ConfigurationPlatformModel;
|
|
|
54
55
|
* @typedef PiiMasking
|
|
55
56
|
* @property {boolean} [enabled]
|
|
56
57
|
*/
|
|
58
|
+
/**
|
|
59
|
+
* @typedef ChannelCapabilities
|
|
60
|
+
* @property {string[]} commerce_model - Commerce model types supported by the
|
|
61
|
+
* sales channel. Defines whether the channel operates as B2C/D2C
|
|
62
|
+
* (business-to-consumer/direct-to-consumer) or B2B (business-to-business).
|
|
63
|
+
* @property {string[]} business_format - Business format types for the sales
|
|
64
|
+
* channel. Options include standard_commerce for traditional e-commerce,
|
|
65
|
+
* quick_commerce for rapid delivery models, and qsr for quick service
|
|
66
|
+
* restaurant operations.
|
|
67
|
+
* @property {OrderingSources[]} ordering_sources - Represents an ordering
|
|
68
|
+
* source that can be associated with a sales channel. Ordering sources define
|
|
69
|
+
* the origin or platform from which orders are placed, enabling tracking and
|
|
70
|
+
* differentiation of orders based on their source.
|
|
71
|
+
* @property {string} [seller_model] - Seller model for the sales channel.
|
|
72
|
+
* single_seller for single seller, marketplace for multiple platforms,
|
|
73
|
+
* cross_selling for franchise-enabled.
|
|
74
|
+
*/
|
|
75
|
+
/**
|
|
76
|
+
* @typedef OrderingSources
|
|
77
|
+
* @property {string} key - Unique identifier slug for the ordering source. Used
|
|
78
|
+
* to reference and identify the source programmatically.
|
|
79
|
+
* @property {string} name - Human-readable display name of the ordering source.
|
|
80
|
+
* Shown in UI for easy identification by users.
|
|
81
|
+
*/
|
|
57
82
|
/**
|
|
58
83
|
* @typedef FstIdentification
|
|
59
84
|
* @property {boolean} [enabled] - Indicates whether search query interpretation
|
|
@@ -179,6 +204,10 @@ export = ConfigurationPlatformModel;
|
|
|
179
204
|
* @property {boolean} [revenue_engine_coupon] - Allow coupon apply and credits
|
|
180
205
|
* together. Default value is false.
|
|
181
206
|
* @property {PanCardConfig} [pan_card]
|
|
207
|
+
* @property {boolean} [engage_enabled] - If this is enabled, user can earn and
|
|
208
|
+
* redeem loyalty points for the sales channel.
|
|
209
|
+
* @property {boolean} [offer_enabled] - If this is enabled, user can apply
|
|
210
|
+
* coupons and promotions for the sales channel.
|
|
182
211
|
*/
|
|
183
212
|
/**
|
|
184
213
|
* @typedef InternationalDeliveryCharges
|
|
@@ -928,6 +957,10 @@ export = ConfigurationPlatformModel;
|
|
|
928
957
|
* @property {SecurityFeature} [security]
|
|
929
958
|
* @property {BuyboxFeature} [buybox]
|
|
930
959
|
* @property {DeliveryStrategy} [delivery_strategy]
|
|
960
|
+
* @property {OrderingSources[]} [ordering_sources] - Represents an ordering
|
|
961
|
+
* source that can be associated with a sales channel. Ordering sources define
|
|
962
|
+
* the origin or platform from which orders are placed, enabling tracking and
|
|
963
|
+
* differentiation of orders based on their source.
|
|
931
964
|
* @property {string} [price_strategy] - Indicates whether price strategy
|
|
932
965
|
* enabled or not in an application.
|
|
933
966
|
* @property {boolean} [international] - Indicates whether internation price
|
|
@@ -1443,7 +1476,7 @@ export = ConfigurationPlatformModel;
|
|
|
1443
1476
|
declare class ConfigurationPlatformModel {
|
|
1444
1477
|
}
|
|
1445
1478
|
declare namespace ConfigurationPlatformModel {
|
|
1446
|
-
export { CurrencyExchangeResponseV2, CurrencyExchangeItem, ApplicationInventory, PiiMasking, FstIdentification, SkgIdentification, QuerySuggestions, SearchConfig, AppInventoryConfig, InventoryBrand, InventoryStore, AppStoreRules, InventoryCategory, InventoryPrice, InventoryDiscount, AuthenticationConfig, ArticleAssignmentConfig, ArticleAssignmentRules, StorePriority, AppCartConfig, InternationalDeliveryCharges, DeliveryCharges, Charges, AppPaymentConfig, CallbackUrl, Methods, PaymentModeConfig, PaymentSelectionLock, AppOrderConfig, ProcessingSchedule, StartAfter, AppLogisticsConfig, LoyaltyPointsConfig, AppInventoryPartialUpdate, BrandCompanyInfo, CompanyByBrandsRequestSchema, CompanyByBrandsResponseSchema, StoreByBrandsRequestSchema, StoreByBrandsResponseSchema, BrandStoreInfo, CompanyBrandInfo, BrandsByCompanyResponseSchema, ValidationFailedResponseSchema, NotFound, CommunicationConfig, CommsConfig, PanCardConfig, CreateApplicationRequestSchema, CreateAppResponseSchema, ApplicationsResponseSchema, MobileAppConfiguration, LandingImage, SplashImage, MobileAppConfigRequestSchema, BuildVersionHistory, BuildVersion, AppSupportedCurrency, DefaultCurrency, DomainAdd, DomainAddRequestSchema, Domain, DomainsResponseSchema, UpdateDomain, UpdateDomainTypeRequestSchema, DomainStatusRequestSchema, DomainStatus, DomainStatusResponseSchema, DomainSuggestionsRequestSchema, DomainSuggestion, DomainSuggestionsResponseSchema, SuccessMessageResponseSchema, App, AppDomain, CompaniesResponseSchema, AppInventoryCompanies, StoresResponseSchema, AppInventoryStores, FilterOrderingStoreRequestSchema, DeploymentMeta, OrderingStoreConfig, OrderingStoreSelectRequestSchema, OrderingStoreSelect, OtherSellerCompany, OtherSellerApplication, OtherSellerApplications, OptedApplicationResponseSchema, OptedCompany, OptedInventory, OptType, OptedStore, OptOutInventory, TokenResponseSchema, Tokens, Firebase, Credentials, Ios, Android, Moengage, MoengageCredentials, Segment, SegmentCredentials, Gtm, GtmCredentials, Freshchat, FreshchatCredentials, Safetynet, SafetynetCredentials, FyndRewards, FyndRewardsCredentials, GoogleMap, GoogleMapCredentials, RewardPointsConfig, Credit, Debit, ProductDetailFeature, LaunchPage, LandingPageFeature, ListingPageFeature, RegistrationPageFeature, BuyboxFeature, DeliveryStrategy, FulfillmentOption, AppFeature, HomePageFeature, CommonFeature, InternationalShipping, CommunicationOptinDialogFeature, DeploymentStoreSelectionFeature, ListingPriceFeature, CurrencyFeature, RevenueEngineFeature, FeedbackFeature, CompareProductsFeature, CartFeature, QrFeature, PcrFeature, OrderFeature, SecurityFeature, AllowedDomain, AppFeatureRequestSchema, AppFeatureResponseSchema, Currency, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, ApplicationById, TokenSchemaID, TokenSchema, InvalidPayloadRequestSchema, Page, ApplicationInformation, InformationAddress, InformationPhone, InformationLoc, InformationSupport, InformationSupportPhone, InformationSupportEmail, SocialLinks, FacebookLink, InstagramLink, TwitterLink, PinterestLink, GooglePlusLink, YoutubeLink, LinkedInLink, VimeoLink, BlogLink, Links, BusinessHighlights, ApplicationDetail, CurrenciesResponseSchema, AppCurrencyResponseSchema, StoreLatLong, OptedStoreAddress, OrderingStore, OrderingStores, OrderingStoresResponseSchema, ValidationErrors, ValidationError };
|
|
1479
|
+
export { CurrencyExchangeResponseV2, CurrencyExchangeItem, ApplicationInventory, PiiMasking, ChannelCapabilities, OrderingSources, FstIdentification, SkgIdentification, QuerySuggestions, SearchConfig, AppInventoryConfig, InventoryBrand, InventoryStore, AppStoreRules, InventoryCategory, InventoryPrice, InventoryDiscount, AuthenticationConfig, ArticleAssignmentConfig, ArticleAssignmentRules, StorePriority, AppCartConfig, InternationalDeliveryCharges, DeliveryCharges, Charges, AppPaymentConfig, CallbackUrl, Methods, PaymentModeConfig, PaymentSelectionLock, AppOrderConfig, ProcessingSchedule, StartAfter, AppLogisticsConfig, LoyaltyPointsConfig, AppInventoryPartialUpdate, BrandCompanyInfo, CompanyByBrandsRequestSchema, CompanyByBrandsResponseSchema, StoreByBrandsRequestSchema, StoreByBrandsResponseSchema, BrandStoreInfo, CompanyBrandInfo, BrandsByCompanyResponseSchema, ValidationFailedResponseSchema, NotFound, CommunicationConfig, CommsConfig, PanCardConfig, CreateApplicationRequestSchema, CreateAppResponseSchema, ApplicationsResponseSchema, MobileAppConfiguration, LandingImage, SplashImage, MobileAppConfigRequestSchema, BuildVersionHistory, BuildVersion, AppSupportedCurrency, DefaultCurrency, DomainAdd, DomainAddRequestSchema, Domain, DomainsResponseSchema, UpdateDomain, UpdateDomainTypeRequestSchema, DomainStatusRequestSchema, DomainStatus, DomainStatusResponseSchema, DomainSuggestionsRequestSchema, DomainSuggestion, DomainSuggestionsResponseSchema, SuccessMessageResponseSchema, App, AppDomain, CompaniesResponseSchema, AppInventoryCompanies, StoresResponseSchema, AppInventoryStores, FilterOrderingStoreRequestSchema, DeploymentMeta, OrderingStoreConfig, OrderingStoreSelectRequestSchema, OrderingStoreSelect, OtherSellerCompany, OtherSellerApplication, OtherSellerApplications, OptedApplicationResponseSchema, OptedCompany, OptedInventory, OptType, OptedStore, OptOutInventory, TokenResponseSchema, Tokens, Firebase, Credentials, Ios, Android, Moengage, MoengageCredentials, Segment, SegmentCredentials, Gtm, GtmCredentials, Freshchat, FreshchatCredentials, Safetynet, SafetynetCredentials, FyndRewards, FyndRewardsCredentials, GoogleMap, GoogleMapCredentials, RewardPointsConfig, Credit, Debit, ProductDetailFeature, LaunchPage, LandingPageFeature, ListingPageFeature, RegistrationPageFeature, BuyboxFeature, DeliveryStrategy, FulfillmentOption, AppFeature, HomePageFeature, CommonFeature, InternationalShipping, CommunicationOptinDialogFeature, DeploymentStoreSelectionFeature, ListingPriceFeature, CurrencyFeature, RevenueEngineFeature, FeedbackFeature, CompareProductsFeature, CartFeature, QrFeature, PcrFeature, OrderFeature, SecurityFeature, AllowedDomain, AppFeatureRequestSchema, AppFeatureResponseSchema, Currency, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, ApplicationById, TokenSchemaID, TokenSchema, InvalidPayloadRequestSchema, Page, ApplicationInformation, InformationAddress, InformationPhone, InformationLoc, InformationSupport, InformationSupportPhone, InformationSupportEmail, SocialLinks, FacebookLink, InstagramLink, TwitterLink, PinterestLink, GooglePlusLink, YoutubeLink, LinkedInLink, VimeoLink, BlogLink, Links, BusinessHighlights, ApplicationDetail, CurrenciesResponseSchema, AppCurrencyResponseSchema, StoreLatLong, OptedStoreAddress, OrderingStore, OrderingStores, OrderingStoresResponseSchema, ValidationErrors, ValidationError };
|
|
1447
1480
|
}
|
|
1448
1481
|
/** @returns {CurrencyExchangeResponseV2} */
|
|
1449
1482
|
declare function CurrencyExchangeResponseV2(): CurrencyExchangeResponseV2;
|
|
@@ -1520,6 +1553,7 @@ type ApplicationInventory = {
|
|
|
1520
1553
|
order?: AppOrderConfig;
|
|
1521
1554
|
logistics?: AppLogisticsConfig;
|
|
1522
1555
|
pii_masking?: PiiMasking;
|
|
1556
|
+
channel_capabilities?: ChannelCapabilities;
|
|
1523
1557
|
tags?: string[];
|
|
1524
1558
|
__v?: number;
|
|
1525
1559
|
/**
|
|
@@ -1564,6 +1598,50 @@ declare function PiiMasking(): PiiMasking;
|
|
|
1564
1598
|
type PiiMasking = {
|
|
1565
1599
|
enabled?: boolean;
|
|
1566
1600
|
};
|
|
1601
|
+
/** @returns {ChannelCapabilities} */
|
|
1602
|
+
declare function ChannelCapabilities(): ChannelCapabilities;
|
|
1603
|
+
type ChannelCapabilities = {
|
|
1604
|
+
/**
|
|
1605
|
+
* - Commerce model types supported by the
|
|
1606
|
+
* sales channel. Defines whether the channel operates as B2C/D2C
|
|
1607
|
+
* (business-to-consumer/direct-to-consumer) or B2B (business-to-business).
|
|
1608
|
+
*/
|
|
1609
|
+
commerce_model: string[];
|
|
1610
|
+
/**
|
|
1611
|
+
* - Business format types for the sales
|
|
1612
|
+
* channel. Options include standard_commerce for traditional e-commerce,
|
|
1613
|
+
* quick_commerce for rapid delivery models, and qsr for quick service
|
|
1614
|
+
* restaurant operations.
|
|
1615
|
+
*/
|
|
1616
|
+
business_format: string[];
|
|
1617
|
+
/**
|
|
1618
|
+
* - Represents an ordering
|
|
1619
|
+
* source that can be associated with a sales channel. Ordering sources define
|
|
1620
|
+
* the origin or platform from which orders are placed, enabling tracking and
|
|
1621
|
+
* differentiation of orders based on their source.
|
|
1622
|
+
*/
|
|
1623
|
+
ordering_sources: OrderingSources[];
|
|
1624
|
+
/**
|
|
1625
|
+
* - Seller model for the sales channel.
|
|
1626
|
+
* single_seller for single seller, marketplace for multiple platforms,
|
|
1627
|
+
* cross_selling for franchise-enabled.
|
|
1628
|
+
*/
|
|
1629
|
+
seller_model?: string;
|
|
1630
|
+
};
|
|
1631
|
+
/** @returns {OrderingSources} */
|
|
1632
|
+
declare function OrderingSources(): OrderingSources;
|
|
1633
|
+
type OrderingSources = {
|
|
1634
|
+
/**
|
|
1635
|
+
* - Unique identifier slug for the ordering source. Used
|
|
1636
|
+
* to reference and identify the source programmatically.
|
|
1637
|
+
*/
|
|
1638
|
+
key: string;
|
|
1639
|
+
/**
|
|
1640
|
+
* - Human-readable display name of the ordering source.
|
|
1641
|
+
* Shown in UI for easy identification by users.
|
|
1642
|
+
*/
|
|
1643
|
+
name: string;
|
|
1644
|
+
};
|
|
1567
1645
|
/** @returns {FstIdentification} */
|
|
1568
1646
|
declare function FstIdentification(): FstIdentification;
|
|
1569
1647
|
type FstIdentification = {
|
|
@@ -1810,6 +1888,16 @@ type AppCartConfig = {
|
|
|
1810
1888
|
*/
|
|
1811
1889
|
revenue_engine_coupon?: boolean;
|
|
1812
1890
|
pan_card?: PanCardConfig;
|
|
1891
|
+
/**
|
|
1892
|
+
* - If this is enabled, user can earn and
|
|
1893
|
+
* redeem loyalty points for the sales channel.
|
|
1894
|
+
*/
|
|
1895
|
+
engage_enabled?: boolean;
|
|
1896
|
+
/**
|
|
1897
|
+
* - If this is enabled, user can apply
|
|
1898
|
+
* coupons and promotions for the sales channel.
|
|
1899
|
+
*/
|
|
1900
|
+
offer_enabled?: boolean;
|
|
1813
1901
|
};
|
|
1814
1902
|
/** @returns {InternationalDeliveryCharges} */
|
|
1815
1903
|
declare function InternationalDeliveryCharges(): InternationalDeliveryCharges;
|
|
@@ -3304,6 +3392,13 @@ type AppFeature = {
|
|
|
3304
3392
|
security?: SecurityFeature;
|
|
3305
3393
|
buybox?: BuyboxFeature;
|
|
3306
3394
|
delivery_strategy?: DeliveryStrategy;
|
|
3395
|
+
/**
|
|
3396
|
+
* - Represents an ordering
|
|
3397
|
+
* source that can be associated with a sales channel. Ordering sources define
|
|
3398
|
+
* the origin or platform from which orders are placed, enabling tracking and
|
|
3399
|
+
* differentiation of orders based on their source.
|
|
3400
|
+
*/
|
|
3401
|
+
ordering_sources?: OrderingSources[];
|
|
3307
3402
|
/**
|
|
3308
3403
|
* - Indicates whether price strategy
|
|
3309
3404
|
* enabled or not in an application.
|
|
@@ -35,6 +35,7 @@ const Joi = require("joi");
|
|
|
35
35
|
* @property {AppOrderConfig} [order]
|
|
36
36
|
* @property {AppLogisticsConfig} [logistics]
|
|
37
37
|
* @property {PiiMasking} [pii_masking]
|
|
38
|
+
* @property {ChannelCapabilities} [channel_capabilities]
|
|
38
39
|
* @property {string[]} [tags]
|
|
39
40
|
* @property {number} [__v]
|
|
40
41
|
* @property {string} [business] - Indicates the business type for sales channel
|
|
@@ -59,6 +60,32 @@ const Joi = require("joi");
|
|
|
59
60
|
* @property {boolean} [enabled]
|
|
60
61
|
*/
|
|
61
62
|
|
|
63
|
+
/**
|
|
64
|
+
* @typedef ChannelCapabilities
|
|
65
|
+
* @property {string[]} commerce_model - Commerce model types supported by the
|
|
66
|
+
* sales channel. Defines whether the channel operates as B2C/D2C
|
|
67
|
+
* (business-to-consumer/direct-to-consumer) or B2B (business-to-business).
|
|
68
|
+
* @property {string[]} business_format - Business format types for the sales
|
|
69
|
+
* channel. Options include standard_commerce for traditional e-commerce,
|
|
70
|
+
* quick_commerce for rapid delivery models, and qsr for quick service
|
|
71
|
+
* restaurant operations.
|
|
72
|
+
* @property {OrderingSources[]} ordering_sources - Represents an ordering
|
|
73
|
+
* source that can be associated with a sales channel. Ordering sources define
|
|
74
|
+
* the origin or platform from which orders are placed, enabling tracking and
|
|
75
|
+
* differentiation of orders based on their source.
|
|
76
|
+
* @property {string} [seller_model] - Seller model for the sales channel.
|
|
77
|
+
* single_seller for single seller, marketplace for multiple platforms,
|
|
78
|
+
* cross_selling for franchise-enabled.
|
|
79
|
+
*/
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* @typedef OrderingSources
|
|
83
|
+
* @property {string} key - Unique identifier slug for the ordering source. Used
|
|
84
|
+
* to reference and identify the source programmatically.
|
|
85
|
+
* @property {string} name - Human-readable display name of the ordering source.
|
|
86
|
+
* Shown in UI for easy identification by users.
|
|
87
|
+
*/
|
|
88
|
+
|
|
62
89
|
/**
|
|
63
90
|
* @typedef FstIdentification
|
|
64
91
|
* @property {boolean} [enabled] - Indicates whether search query interpretation
|
|
@@ -199,6 +226,10 @@ const Joi = require("joi");
|
|
|
199
226
|
* @property {boolean} [revenue_engine_coupon] - Allow coupon apply and credits
|
|
200
227
|
* together. Default value is false.
|
|
201
228
|
* @property {PanCardConfig} [pan_card]
|
|
229
|
+
* @property {boolean} [engage_enabled] - If this is enabled, user can earn and
|
|
230
|
+
* redeem loyalty points for the sales channel.
|
|
231
|
+
* @property {boolean} [offer_enabled] - If this is enabled, user can apply
|
|
232
|
+
* coupons and promotions for the sales channel.
|
|
202
233
|
*/
|
|
203
234
|
|
|
204
235
|
/**
|
|
@@ -1051,6 +1082,10 @@ const Joi = require("joi");
|
|
|
1051
1082
|
* @property {SecurityFeature} [security]
|
|
1052
1083
|
* @property {BuyboxFeature} [buybox]
|
|
1053
1084
|
* @property {DeliveryStrategy} [delivery_strategy]
|
|
1085
|
+
* @property {OrderingSources[]} [ordering_sources] - Represents an ordering
|
|
1086
|
+
* source that can be associated with a sales channel. Ordering sources define
|
|
1087
|
+
* the origin or platform from which orders are placed, enabling tracking and
|
|
1088
|
+
* differentiation of orders based on their source.
|
|
1054
1089
|
* @property {string} [price_strategy] - Indicates whether price strategy
|
|
1055
1090
|
* enabled or not in an application.
|
|
1056
1091
|
* @property {boolean} [international] - Indicates whether internation price
|
|
@@ -1665,6 +1700,7 @@ class ConfigurationPlatformModel {
|
|
|
1665
1700
|
order: ConfigurationPlatformModel.AppOrderConfig(),
|
|
1666
1701
|
logistics: ConfigurationPlatformModel.AppLogisticsConfig(),
|
|
1667
1702
|
pii_masking: ConfigurationPlatformModel.PiiMasking(),
|
|
1703
|
+
channel_capabilities: ConfigurationPlatformModel.ChannelCapabilities(),
|
|
1668
1704
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
1669
1705
|
__v: Joi.number(),
|
|
1670
1706
|
business: Joi.string().allow(""),
|
|
@@ -1687,6 +1723,26 @@ class ConfigurationPlatformModel {
|
|
|
1687
1723
|
});
|
|
1688
1724
|
}
|
|
1689
1725
|
|
|
1726
|
+
/** @returns {ChannelCapabilities} */
|
|
1727
|
+
static ChannelCapabilities() {
|
|
1728
|
+
return Joi.object({
|
|
1729
|
+
commerce_model: Joi.array().items(Joi.string().allow("")).required(),
|
|
1730
|
+
business_format: Joi.array().items(Joi.string().allow("")).required(),
|
|
1731
|
+
ordering_sources: Joi.array()
|
|
1732
|
+
.items(ConfigurationPlatformModel.OrderingSources())
|
|
1733
|
+
.required(),
|
|
1734
|
+
seller_model: Joi.string().allow(""),
|
|
1735
|
+
});
|
|
1736
|
+
}
|
|
1737
|
+
|
|
1738
|
+
/** @returns {OrderingSources} */
|
|
1739
|
+
static OrderingSources() {
|
|
1740
|
+
return Joi.object({
|
|
1741
|
+
key: Joi.string().allow("").required(),
|
|
1742
|
+
name: Joi.string().allow("").required(),
|
|
1743
|
+
});
|
|
1744
|
+
}
|
|
1745
|
+
|
|
1690
1746
|
/** @returns {FstIdentification} */
|
|
1691
1747
|
static FstIdentification() {
|
|
1692
1748
|
return Joi.object({
|
|
@@ -1833,6 +1889,8 @@ class ConfigurationPlatformModel {
|
|
|
1833
1889
|
bulk_coupons: Joi.boolean(),
|
|
1834
1890
|
revenue_engine_coupon: Joi.boolean(),
|
|
1835
1891
|
pan_card: ConfigurationPlatformModel.PanCardConfig(),
|
|
1892
|
+
engage_enabled: Joi.boolean(),
|
|
1893
|
+
offer_enabled: Joi.boolean(),
|
|
1836
1894
|
});
|
|
1837
1895
|
}
|
|
1838
1896
|
|
|
@@ -2792,6 +2850,9 @@ class ConfigurationPlatformModel {
|
|
|
2792
2850
|
security: ConfigurationPlatformModel.SecurityFeature(),
|
|
2793
2851
|
buybox: ConfigurationPlatformModel.BuyboxFeature(),
|
|
2794
2852
|
delivery_strategy: ConfigurationPlatformModel.DeliveryStrategy(),
|
|
2853
|
+
ordering_sources: Joi.array().items(
|
|
2854
|
+
ConfigurationPlatformModel.OrderingSources()
|
|
2855
|
+
),
|
|
2795
2856
|
price_strategy: Joi.string().allow(""),
|
|
2796
2857
|
international: Joi.boolean(),
|
|
2797
2858
|
strategy_change_pending: Joi.boolean(),
|
|
@@ -83,6 +83,18 @@ declare class Content {
|
|
|
83
83
|
* @description: Generate and add a new announcement. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/createAnnouncement/).
|
|
84
84
|
*/
|
|
85
85
|
createAnnouncement({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateAnnouncementParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateAnnouncementSchema>;
|
|
86
|
+
/**
|
|
87
|
+
* @param {ContentPlatformApplicationValidator.CreateAppAssociationParam} arg
|
|
88
|
+
* - Arg object
|
|
89
|
+
*
|
|
90
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
91
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
92
|
+
* @returns {Promise<ContentPlatformModel.AppAssociationRecord>} - Success response
|
|
93
|
+
* @name createAppAssociation
|
|
94
|
+
* @summary: Create app association
|
|
95
|
+
* @description: Create-only. Returns 409 if a record already exists for this application (caller should use PUT to update). 422 on shape/size violations. Body fields `ios_payload` (object|null) and `android_payload` (array|null) are both optional and independent. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/createAppAssociation/).
|
|
96
|
+
*/
|
|
97
|
+
createAppAssociation({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateAppAssociationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.AppAssociationRecord>;
|
|
86
98
|
/**
|
|
87
99
|
* @param {ContentPlatformApplicationValidator.CreateAppCustomFieldDefinitionParam} arg
|
|
88
100
|
* - Arg object
|
|
@@ -226,6 +238,18 @@ declare class Content {
|
|
|
226
238
|
* @description: Remove a specific announcement. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/deleteAnnouncement/).
|
|
227
239
|
*/
|
|
228
240
|
deleteAnnouncement({ announcementId, requestHeaders }?: ContentPlatformApplicationValidator.DeleteAnnouncementParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateAnnouncementSchema>;
|
|
241
|
+
/**
|
|
242
|
+
* @param {ContentPlatformApplicationValidator.DeleteAppAssociationParam} arg
|
|
243
|
+
* - Arg object
|
|
244
|
+
*
|
|
245
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
246
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
247
|
+
* @returns {Promise<ContentPlatformModel.AppAssociationDeleted>} - Success response
|
|
248
|
+
* @name deleteAppAssociation
|
|
249
|
+
* @summary: Delete app association
|
|
250
|
+
* @description: Remove the app-association record entirely. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/deleteAppAssociation/).
|
|
251
|
+
*/
|
|
252
|
+
deleteAppAssociation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.AppAssociationDeleted>;
|
|
229
253
|
/**
|
|
230
254
|
* @param {ContentPlatformApplicationValidator.DeleteAppCustomFieldDefinitionBySlugParam} arg
|
|
231
255
|
* - Arg object
|
|
@@ -471,6 +495,18 @@ declare class Content {
|
|
|
471
495
|
* @description: Lists all announcements - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getAnnouncementsList/).
|
|
472
496
|
*/
|
|
473
497
|
getAnnouncementsList({ pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetAnnouncementsListParam, { responseHeaders }?: object): Promise<ContentPlatformModel.GetAnnouncementListSchema>;
|
|
498
|
+
/**
|
|
499
|
+
* @param {ContentPlatformApplicationValidator.GetAppAssociationParam} arg
|
|
500
|
+
* - Arg object
|
|
501
|
+
*
|
|
502
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
503
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
504
|
+
* @returns {Promise<ContentPlatformModel.AppAssociationRecord>} - Success response
|
|
505
|
+
* @name getAppAssociation
|
|
506
|
+
* @summary: Get app association
|
|
507
|
+
* @description: Fetch the app-association configuration (Apple AASA + Google Asset Links payloads) for this application. Returns 404 if no record exists. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getAppAssociation/).
|
|
508
|
+
*/
|
|
509
|
+
getAppAssociation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.AppAssociationRecord>;
|
|
474
510
|
/**
|
|
475
511
|
* @param {ContentPlatformApplicationValidator.GetAppCustomFieldDefinitionByResourceParam} arg
|
|
476
512
|
* - Arg object
|
|
@@ -1034,6 +1070,18 @@ declare class Content {
|
|
|
1034
1070
|
* @description: Modify the scheduling of a specific announcement. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/updateAnnouncementSchedule/).
|
|
1035
1071
|
*/
|
|
1036
1072
|
updateAnnouncementSchedule({ announcementId, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateAnnouncementScheduleParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateAnnouncementSchema>;
|
|
1073
|
+
/**
|
|
1074
|
+
* @param {ContentPlatformApplicationValidator.UpdateAppAssociationParam} arg
|
|
1075
|
+
* - Arg object
|
|
1076
|
+
*
|
|
1077
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1078
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1079
|
+
* @returns {Promise<ContentPlatformModel.AppAssociationRecord>} - Success response
|
|
1080
|
+
* @name updateAppAssociation
|
|
1081
|
+
* @summary: Update app association
|
|
1082
|
+
* @description: Update-only. Returns 404 if no record exists (caller should use POST to create). Partial-update semantics: keys present are written (explicit null clears the field); keys absent are no-op. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/updateAppAssociation/).
|
|
1083
|
+
*/
|
|
1084
|
+
updateAppAssociation({ body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateAppAssociationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.AppAssociationRecord>;
|
|
1037
1085
|
/**
|
|
1038
1086
|
* @param {ContentPlatformApplicationValidator.UpdateAppCustomFieldByResourceSlugParam} arg
|
|
1039
1087
|
* - Arg object
|
|
@@ -1145,18 +1193,6 @@ declare class Content {
|
|
|
1145
1193
|
* @description: Modify the content and settings of a specific FAQ category. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/updateFaqCategory/).
|
|
1146
1194
|
*/
|
|
1147
1195
|
updateFaqCategory({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateFaqCategoryParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateFaqCategorySchema>;
|
|
1148
|
-
/**
|
|
1149
|
-
* @param {ContentPlatformApplicationValidator.UpdateInjectableTagParam} arg
|
|
1150
|
-
* - Arg object
|
|
1151
|
-
*
|
|
1152
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1153
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1154
|
-
* @returns {Promise<ContentPlatformModel.TagsSchema>} - Success response
|
|
1155
|
-
* @name updateInjectableTag
|
|
1156
|
-
* @summary: Update HTML tag
|
|
1157
|
-
* @description: Modify settings for an injectable tag. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/updateInjectableTag/).
|
|
1158
|
-
*/
|
|
1159
|
-
updateInjectableTag({ body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateInjectableTagParam, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
|
|
1160
1196
|
/**
|
|
1161
1197
|
* @param {ContentPlatformApplicationValidator.UpdateLandingPageParam} arg
|
|
1162
1198
|
* - Arg object
|