@gofynd/fdk-client-javascript 1.4.10 → 1.4.12-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 +2 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +8 -19
- package/sdk/application/Cart/CartApplicationClient.js +8 -89
- package/sdk/application/Cart/CartApplicationModel.d.ts +1 -178
- package/sdk/application/Cart/CartApplicationModel.js +0 -92
- package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -20
- package/sdk/application/Cart/CartApplicationValidator.js +0 -16
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +5 -0
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +2 -0
- package/sdk/application/Content/ContentApplicationModel.d.ts +3 -2
- package/sdk/application/Content/ContentApplicationModel.js +5 -2
- package/sdk/application/Logistic/LogisticApplicationModel.js +3 -3
- package/sdk/application/Order/OrderApplicationModel.js +1 -1
- package/sdk/application/Payment/PaymentApplicationModel.js +2 -2
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +3 -2
- package/sdk/application/Theme/ThemeApplicationModel.js +5 -2
- package/sdk/common/Clickstream.js +46 -15
- 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/partner/Webhook/WebhookPartnerModel.js +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +8 -20
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +8 -92
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -15
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +0 -14
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1 -87
- package/sdk/platform/Cart/CartPlatformModel.js +0 -88
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +14 -3
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +27 -3
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +14 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +10 -51
- package/sdk/platform/Catalog/CatalogPlatformClient.js +79 -400
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +8 -242
- package/sdk/platform/Catalog/CatalogPlatformModel.js +8 -171
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +15 -61
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -65
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +5 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +3 -2
- package/sdk/platform/Content/ContentPlatformModel.js +5 -2
- package/sdk/platform/Finance/FinancePlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformModel.d.ts +120 -39
- package/sdk/platform/Order/OrderPlatformModel.js +88 -38
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +38 -4
- package/sdk/platform/Payment/PaymentPlatformModel.js +17 -7
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +3 -2
- package/sdk/platform/Theme/ThemePlatformModel.js +5 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
|
@@ -236,11 +236,6 @@ export = CartPlatformApplicationValidator;
|
|
|
236
236
|
* @property {string} [id] - The unique identifier of the cart
|
|
237
237
|
* @property {CartPlatformModel.PlatformAddCartRequest} body
|
|
238
238
|
*/
|
|
239
|
-
/**
|
|
240
|
-
* @typedef PlatformCheckoutCartParam
|
|
241
|
-
* @property {string} [id] - The unique identifier of the cart
|
|
242
|
-
* @property {CartPlatformModel.PlatformCartCheckoutDetailRequest} body
|
|
243
|
-
*/
|
|
244
239
|
/**
|
|
245
240
|
* @typedef PlatformCheckoutCartV2Param
|
|
246
241
|
* @property {string} [id] - The unique identifier of the cart
|
|
@@ -460,8 +455,6 @@ declare class CartPlatformApplicationValidator {
|
|
|
460
455
|
static overrideCart(): OverrideCartParam;
|
|
461
456
|
/** @returns {PlatformAddItemsParam} */
|
|
462
457
|
static platformAddItems(): PlatformAddItemsParam;
|
|
463
|
-
/** @returns {PlatformCheckoutCartParam} */
|
|
464
|
-
static platformCheckoutCart(): PlatformCheckoutCartParam;
|
|
465
458
|
/** @returns {PlatformCheckoutCartV2Param} */
|
|
466
459
|
static platformCheckoutCartV2(): PlatformCheckoutCartV2Param;
|
|
467
460
|
/** @returns {PlatformUpdateCartParam} */
|
|
@@ -506,7 +499,7 @@ declare class CartPlatformApplicationValidator {
|
|
|
506
499
|
static validateCouponForPayment(): ValidateCouponForPaymentParam;
|
|
507
500
|
}
|
|
508
501
|
declare namespace CartPlatformApplicationValidator {
|
|
509
|
-
export { AddAddressParam, AddItemsParam, AddPriceAdjustmentParam, ApplyCouponParam, CheckCartServiceabilityParam, CheckoutCartParam, CreateCartMetaConfigParam, CreateCouponParam, CreatePromotionParam, DeleteCartParam, FetchAndvalidateCartItemsParam, FetchCartMetaConfigParam, GetAbandonedCartParam, GetAbandonedCartDetailsParam, GetAddressByIdParam, GetAddressesParam, GetAppCouponsParam, GetAvailableDeliveryModesParam, GetCartParam, GetCartListParam, GetCartShareLinkParam, GetCartSharedItemsParam, GetCouponByIdParam, GetCouponCodeExistsParam, GetCouponOptionValuesParam, GetCouponsParam, GetItemCountParam, GetPriceAdjustmentsParam, GetPromosCouponConfigParam, GetPromotionByIdParam, GetPromotionCodeExistsParam, GetPromotionOffersParam, GetPromotionPaymentOffersParam, GetPromotionsParam, GetShipmentsParam, GetStoreAddressByUidParam, OverrideCartParam, PlatformAddItemsParam,
|
|
502
|
+
export { AddAddressParam, AddItemsParam, AddPriceAdjustmentParam, ApplyCouponParam, CheckCartServiceabilityParam, CheckoutCartParam, CreateCartMetaConfigParam, CreateCouponParam, CreatePromotionParam, DeleteCartParam, FetchAndvalidateCartItemsParam, FetchCartMetaConfigParam, GetAbandonedCartParam, GetAbandonedCartDetailsParam, GetAddressByIdParam, GetAddressesParam, GetAppCouponsParam, GetAvailableDeliveryModesParam, GetCartParam, GetCartListParam, GetCartShareLinkParam, GetCartSharedItemsParam, GetCouponByIdParam, GetCouponCodeExistsParam, GetCouponOptionValuesParam, GetCouponsParam, GetItemCountParam, GetPriceAdjustmentsParam, GetPromosCouponConfigParam, GetPromotionByIdParam, GetPromotionCodeExistsParam, GetPromotionOffersParam, GetPromotionPaymentOffersParam, GetPromotionsParam, GetShipmentsParam, GetStoreAddressByUidParam, OverrideCartParam, PlatformAddItemsParam, PlatformCheckoutCartV2Param, PlatformUpdateCartParam, RemoveAddressParam, RemoveCouponParam, RemovePriceAdjustmentParam, SelectAddressParam, SelectPaymentModeParam, SelectPaymentModeV2Param, UpdateAddressParam, UpdateCartParam, UpdateCartMetaParam, UpdateCartMetaConfigParam, UpdateCartUserParam, UpdateCartWithSharedItemsParam, UpdateCouponParam, UpdateCouponPartiallyParam, UpdatePriceAdjustmentParam, UpdatePromotionParam, UpdatePromotionPartiallyParam, UpdateShipmentsParam, ValidateCouponForPaymentParam };
|
|
510
503
|
}
|
|
511
504
|
type AddAddressParam = {
|
|
512
505
|
body: CartPlatformModel.PlatformAddress;
|
|
@@ -806,13 +799,6 @@ type PlatformAddItemsParam = {
|
|
|
806
799
|
id?: string;
|
|
807
800
|
body: CartPlatformModel.PlatformAddCartRequest;
|
|
808
801
|
};
|
|
809
|
-
type PlatformCheckoutCartParam = {
|
|
810
|
-
/**
|
|
811
|
-
* - The unique identifier of the cart
|
|
812
|
-
*/
|
|
813
|
-
id?: string;
|
|
814
|
-
body: CartPlatformModel.PlatformCartCheckoutDetailRequest;
|
|
815
|
-
};
|
|
816
802
|
type PlatformCheckoutCartV2Param = {
|
|
817
803
|
/**
|
|
818
804
|
* - The unique identifier of the cart
|
|
@@ -277,12 +277,6 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
277
277
|
* @property {CartPlatformModel.PlatformAddCartRequest} body
|
|
278
278
|
*/
|
|
279
279
|
|
|
280
|
-
/**
|
|
281
|
-
* @typedef PlatformCheckoutCartParam
|
|
282
|
-
* @property {string} [id] - The unique identifier of the cart
|
|
283
|
-
* @property {CartPlatformModel.PlatformCartCheckoutDetailRequest} body
|
|
284
|
-
*/
|
|
285
|
-
|
|
286
280
|
/**
|
|
287
281
|
* @typedef PlatformCheckoutCartV2Param
|
|
288
282
|
* @property {string} [id] - The unique identifier of the cart
|
|
@@ -784,14 +778,6 @@ class CartPlatformApplicationValidator {
|
|
|
784
778
|
}).required();
|
|
785
779
|
}
|
|
786
780
|
|
|
787
|
-
/** @returns {PlatformCheckoutCartParam} */
|
|
788
|
-
static platformCheckoutCart() {
|
|
789
|
-
return Joi.object({
|
|
790
|
-
id: Joi.string().allow(""),
|
|
791
|
-
body: CartPlatformModel.PlatformCartCheckoutDetailRequest().required(),
|
|
792
|
-
}).required();
|
|
793
|
-
}
|
|
794
|
-
|
|
795
781
|
/** @returns {PlatformCheckoutCartV2Param} */
|
|
796
782
|
static platformCheckoutCartV2() {
|
|
797
783
|
return Joi.object({
|
|
@@ -1538,45 +1538,6 @@ export = CartPlatformModel;
|
|
|
1538
1538
|
* @property {string} key
|
|
1539
1539
|
* @property {string[]} values
|
|
1540
1540
|
*/
|
|
1541
|
-
/**
|
|
1542
|
-
* @typedef CartCheckoutCustomMeta
|
|
1543
|
-
* @property {string} key
|
|
1544
|
-
* @property {string} value
|
|
1545
|
-
*/
|
|
1546
|
-
/**
|
|
1547
|
-
* @typedef PlatformCartCheckoutDetailRequest
|
|
1548
|
-
* @property {CartCheckoutCustomMeta[]} [custom_meta]
|
|
1549
|
-
* @property {string} [address_id]
|
|
1550
|
-
* @property {string} [payment_identifier]
|
|
1551
|
-
* @property {Object} [payment_params]
|
|
1552
|
-
* @property {boolean} [payment_auto_confirm]
|
|
1553
|
-
* @property {string} id
|
|
1554
|
-
* @property {boolean} [pos]
|
|
1555
|
-
* @property {string} [billing_address_id]
|
|
1556
|
-
* @property {string} [merchant_code]
|
|
1557
|
-
* @property {string} [aggregator]
|
|
1558
|
-
* @property {number} [pick_at_store_uid]
|
|
1559
|
-
* @property {string} [device_id]
|
|
1560
|
-
* @property {Object} [delivery_address]
|
|
1561
|
-
* @property {string} payment_mode
|
|
1562
|
-
* @property {string} [checkout_mode]
|
|
1563
|
-
* @property {Object} [customer_details] - Customer details
|
|
1564
|
-
* @property {Object} [meta]
|
|
1565
|
-
* @property {StaffCheckout} [staff]
|
|
1566
|
-
* @property {string} [employee_code]
|
|
1567
|
-
* @property {Object} [billing_address]
|
|
1568
|
-
* @property {string} [callback_url]
|
|
1569
|
-
* @property {string} user_id
|
|
1570
|
-
* @property {Object} [extra_meta]
|
|
1571
|
-
* @property {string} order_type
|
|
1572
|
-
* @property {Files[]} [files] - List of file url
|
|
1573
|
-
* @property {number} [ordering_store]
|
|
1574
|
-
* @property {Object} [payment_extra_identifiers]
|
|
1575
|
-
* @property {string} [iin]
|
|
1576
|
-
* @property {string} [network]
|
|
1577
|
-
* @property {string} [type]
|
|
1578
|
-
* @property {string} [card_id]
|
|
1579
|
-
*/
|
|
1580
1541
|
/**
|
|
1581
1542
|
* @typedef CheckCart
|
|
1582
1543
|
* @property {string} [coupon_text]
|
|
@@ -1792,7 +1753,7 @@ export = CartPlatformModel;
|
|
|
1792
1753
|
declare class CartPlatformModel {
|
|
1793
1754
|
}
|
|
1794
1755
|
declare namespace CartPlatformModel {
|
|
1795
|
-
export { CouponDateMeta, Ownership, CouponAuthor, State, PaymentAllowValue, PaymentModes, PriceRange, PostOrder, BulkBundleRestriction, UsesRemaining, UsesRestriction, Restrictions, Validation, CouponAction, CouponSchedule, Rule, DisplayMetaDict, DisplayMeta, Identifier, Validity, RuleDefinition, CouponAdd, Page, CouponsResponse, SuccessMessage, OperationErrorResponse, CouponUpdate, CouponPartialUpdate, DisplayMeta1, Ownership1, CompareObject, ItemCriteria, DiscountOffer, DiscountRule, PaymentAllowValue1, PromotionPaymentModes, UserRegistered, PostOrder1, UsesRemaining1, UsesRestriction1, Restrictions1, PromotionSchedule, PromotionAction, PromotionAuthor, Visibility, PromotionDateMeta, PromotionListItem, PromotionsResponse, PromotionAdd, PromotionUpdate, PromotionPartialUpdate, ActivePromosResponse, Charges, DeliveryCharges, CartMetaConfigUpdate, CartMetaConfigAdd, Article, PriceAdjustmentRestrictions, Collection, PriceAdjustmentUpdate, PriceAdjustment, PriceAdjustmentResponse, GetPriceAdjustmentResponse, PriceAdjustmentAdd, CartItem, OpenapiCartDetailsRequest, CouponBreakup, DisplayBreakup, LoyaltyPoints, RawBreakup, CartBreakup, ProductImage, Tags, BaseInfo, ActionQuery, ProductAction, CategoryInfo, CartProduct, BasePrice, ArticlePriceInfo, StoreInfo, ProductArticle, Ownership2, DiscountRulesApp, AppliedFreeArticles, BuyRules, AppliedPromotion, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, CouponDetails, ProductPrice, ProductPriceInfo, CartProductIdentifer, ProductAvailabilitySize, ProductAvailability, PromoMeta, CartProductInfo, OpenapiCartDetailsResponse, OpenApiErrorResponse, ShippingAddress, OpenApiCartServiceabilityRequest, OpenApiCartServiceabilityResponse, OpenApiFiles, CartItemMeta, MultiTenderPaymentMeta, MultiTenderPaymentMethod, OpenApiOrderItem, OpenApiPlatformCheckoutReq, OpenApiCheckoutResponse, AbandonedCart, AbandonedCartResponse, PaymentSelectionLock, CartCurrency, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig, CartDetailResponse, AddProductCart, AddCartRequest, AddCartDetailResponse, UpdateProductCart, UpdateCartRequest, UpdateCartDetailResponse, OverrideCartItemPromo, OverrideCartItem, OverrideCheckoutReq, OverrideCheckoutResponse, GetShareCartLinkRequest, GetShareCartLinkResponse, SharedCartDetails, SharedCart, SharedCartResponse, CartList, MultiCartResponse, UpdateUserCartMapping, UserInfo, UserCartMappingResponse, PlatformAddCartRequest, PlatformUpdateCartRequest, DeleteCartRequest, DeleteCartDetailResponse, CartItemCountResponse, Coupon, PageCoupon, GetCouponResponse, ApplyCouponRequest, GeoLocation, PlatformAddress, PlatformGetAddressesResponse, SaveAddressResponse, UpdateAddressResponse, DeleteAddressResponse, PlatformSelectCartAddressRequest, ShipmentArticle, PlatformShipmentResponse, PlatformCartShipmentsResponse, UpdateCartShipmentItem, UpdateCartShipmentRequest, PlatformCartMetaRequest, CartMetaResponse, CartMetaMissingResponse, StaffCheckout, CustomerDetails, Files,
|
|
1756
|
+
export { CouponDateMeta, Ownership, CouponAuthor, State, PaymentAllowValue, PaymentModes, PriceRange, PostOrder, BulkBundleRestriction, UsesRemaining, UsesRestriction, Restrictions, Validation, CouponAction, CouponSchedule, Rule, DisplayMetaDict, DisplayMeta, Identifier, Validity, RuleDefinition, CouponAdd, Page, CouponsResponse, SuccessMessage, OperationErrorResponse, CouponUpdate, CouponPartialUpdate, DisplayMeta1, Ownership1, CompareObject, ItemCriteria, DiscountOffer, DiscountRule, PaymentAllowValue1, PromotionPaymentModes, UserRegistered, PostOrder1, UsesRemaining1, UsesRestriction1, Restrictions1, PromotionSchedule, PromotionAction, PromotionAuthor, Visibility, PromotionDateMeta, PromotionListItem, PromotionsResponse, PromotionAdd, PromotionUpdate, PromotionPartialUpdate, ActivePromosResponse, Charges, DeliveryCharges, CartMetaConfigUpdate, CartMetaConfigAdd, Article, PriceAdjustmentRestrictions, Collection, PriceAdjustmentUpdate, PriceAdjustment, PriceAdjustmentResponse, GetPriceAdjustmentResponse, PriceAdjustmentAdd, CartItem, OpenapiCartDetailsRequest, CouponBreakup, DisplayBreakup, LoyaltyPoints, RawBreakup, CartBreakup, ProductImage, Tags, BaseInfo, ActionQuery, ProductAction, CategoryInfo, CartProduct, BasePrice, ArticlePriceInfo, StoreInfo, ProductArticle, Ownership2, DiscountRulesApp, AppliedFreeArticles, BuyRules, AppliedPromotion, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, CouponDetails, ProductPrice, ProductPriceInfo, CartProductIdentifer, ProductAvailabilitySize, ProductAvailability, PromoMeta, CartProductInfo, OpenapiCartDetailsResponse, OpenApiErrorResponse, ShippingAddress, OpenApiCartServiceabilityRequest, OpenApiCartServiceabilityResponse, OpenApiFiles, CartItemMeta, MultiTenderPaymentMeta, MultiTenderPaymentMethod, OpenApiOrderItem, OpenApiPlatformCheckoutReq, OpenApiCheckoutResponse, AbandonedCart, AbandonedCartResponse, PaymentSelectionLock, CartCurrency, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig, CartDetailResponse, AddProductCart, AddCartRequest, AddCartDetailResponse, UpdateProductCart, UpdateCartRequest, UpdateCartDetailResponse, OverrideCartItemPromo, OverrideCartItem, OverrideCheckoutReq, OverrideCheckoutResponse, GetShareCartLinkRequest, GetShareCartLinkResponse, SharedCartDetails, SharedCart, SharedCartResponse, CartList, MultiCartResponse, UpdateUserCartMapping, UserInfo, UserCartMappingResponse, PlatformAddCartRequest, PlatformUpdateCartRequest, DeleteCartRequest, DeleteCartDetailResponse, CartItemCountResponse, Coupon, PageCoupon, GetCouponResponse, ApplyCouponRequest, GeoLocation, PlatformAddress, PlatformGetAddressesResponse, SaveAddressResponse, UpdateAddressResponse, DeleteAddressResponse, PlatformSelectCartAddressRequest, ShipmentArticle, PlatformShipmentResponse, PlatformCartShipmentsResponse, UpdateCartShipmentItem, UpdateCartShipmentRequest, PlatformCartMetaRequest, CartMetaResponse, CartMetaMissingResponse, StaffCheckout, CustomerDetails, Files, CheckCart, CartCheckoutResponse, CartDeliveryModesResponse, PickupStoreDetail, StoreDetailsResponse, UpdateCartPaymentRequest, CouponValidity, PaymentCouponValidate, PaymentMeta, PaymentMethod, PlatformCartCheckoutDetailV2Request, UpdateCartPaymentRequestV2, PriceMinMax, ItemPriceDetails, FreeGiftItems, PromotionOffer, PromotionOffersResponse, PromotionPaymentOffer, PromotionPaymentOffersResponse };
|
|
1796
1757
|
}
|
|
1797
1758
|
/** @returns {CouponDateMeta} */
|
|
1798
1759
|
declare function CouponDateMeta(): CouponDateMeta;
|
|
@@ -3902,53 +3863,6 @@ type Files = {
|
|
|
3902
3863
|
key: string;
|
|
3903
3864
|
values: string[];
|
|
3904
3865
|
};
|
|
3905
|
-
/** @returns {CartCheckoutCustomMeta} */
|
|
3906
|
-
declare function CartCheckoutCustomMeta(): CartCheckoutCustomMeta;
|
|
3907
|
-
type CartCheckoutCustomMeta = {
|
|
3908
|
-
key: string;
|
|
3909
|
-
value: string;
|
|
3910
|
-
};
|
|
3911
|
-
/** @returns {PlatformCartCheckoutDetailRequest} */
|
|
3912
|
-
declare function PlatformCartCheckoutDetailRequest(): PlatformCartCheckoutDetailRequest;
|
|
3913
|
-
type PlatformCartCheckoutDetailRequest = {
|
|
3914
|
-
custom_meta?: CartCheckoutCustomMeta[];
|
|
3915
|
-
address_id?: string;
|
|
3916
|
-
payment_identifier?: string;
|
|
3917
|
-
payment_params?: any;
|
|
3918
|
-
payment_auto_confirm?: boolean;
|
|
3919
|
-
id: string;
|
|
3920
|
-
pos?: boolean;
|
|
3921
|
-
billing_address_id?: string;
|
|
3922
|
-
merchant_code?: string;
|
|
3923
|
-
aggregator?: string;
|
|
3924
|
-
pick_at_store_uid?: number;
|
|
3925
|
-
device_id?: string;
|
|
3926
|
-
delivery_address?: any;
|
|
3927
|
-
payment_mode: string;
|
|
3928
|
-
checkout_mode?: string;
|
|
3929
|
-
/**
|
|
3930
|
-
* - Customer details
|
|
3931
|
-
*/
|
|
3932
|
-
customer_details?: any;
|
|
3933
|
-
meta?: any;
|
|
3934
|
-
staff?: StaffCheckout;
|
|
3935
|
-
employee_code?: string;
|
|
3936
|
-
billing_address?: any;
|
|
3937
|
-
callback_url?: string;
|
|
3938
|
-
user_id: string;
|
|
3939
|
-
extra_meta?: any;
|
|
3940
|
-
order_type: string;
|
|
3941
|
-
/**
|
|
3942
|
-
* - List of file url
|
|
3943
|
-
*/
|
|
3944
|
-
files?: Files[];
|
|
3945
|
-
ordering_store?: number;
|
|
3946
|
-
payment_extra_identifiers?: any;
|
|
3947
|
-
iin?: string;
|
|
3948
|
-
network?: string;
|
|
3949
|
-
type?: string;
|
|
3950
|
-
card_id?: string;
|
|
3951
|
-
};
|
|
3952
3866
|
/** @returns {CheckCart} */
|
|
3953
3867
|
declare function CheckCart(): CheckCart;
|
|
3954
3868
|
type CheckCart = {
|
|
@@ -1706,47 +1706,6 @@ const Joi = require("joi");
|
|
|
1706
1706
|
* @property {string[]} values
|
|
1707
1707
|
*/
|
|
1708
1708
|
|
|
1709
|
-
/**
|
|
1710
|
-
* @typedef CartCheckoutCustomMeta
|
|
1711
|
-
* @property {string} key
|
|
1712
|
-
* @property {string} value
|
|
1713
|
-
*/
|
|
1714
|
-
|
|
1715
|
-
/**
|
|
1716
|
-
* @typedef PlatformCartCheckoutDetailRequest
|
|
1717
|
-
* @property {CartCheckoutCustomMeta[]} [custom_meta]
|
|
1718
|
-
* @property {string} [address_id]
|
|
1719
|
-
* @property {string} [payment_identifier]
|
|
1720
|
-
* @property {Object} [payment_params]
|
|
1721
|
-
* @property {boolean} [payment_auto_confirm]
|
|
1722
|
-
* @property {string} id
|
|
1723
|
-
* @property {boolean} [pos]
|
|
1724
|
-
* @property {string} [billing_address_id]
|
|
1725
|
-
* @property {string} [merchant_code]
|
|
1726
|
-
* @property {string} [aggregator]
|
|
1727
|
-
* @property {number} [pick_at_store_uid]
|
|
1728
|
-
* @property {string} [device_id]
|
|
1729
|
-
* @property {Object} [delivery_address]
|
|
1730
|
-
* @property {string} payment_mode
|
|
1731
|
-
* @property {string} [checkout_mode]
|
|
1732
|
-
* @property {Object} [customer_details] - Customer details
|
|
1733
|
-
* @property {Object} [meta]
|
|
1734
|
-
* @property {StaffCheckout} [staff]
|
|
1735
|
-
* @property {string} [employee_code]
|
|
1736
|
-
* @property {Object} [billing_address]
|
|
1737
|
-
* @property {string} [callback_url]
|
|
1738
|
-
* @property {string} user_id
|
|
1739
|
-
* @property {Object} [extra_meta]
|
|
1740
|
-
* @property {string} order_type
|
|
1741
|
-
* @property {Files[]} [files] - List of file url
|
|
1742
|
-
* @property {number} [ordering_store]
|
|
1743
|
-
* @property {Object} [payment_extra_identifiers]
|
|
1744
|
-
* @property {string} [iin]
|
|
1745
|
-
* @property {string} [network]
|
|
1746
|
-
* @property {string} [type]
|
|
1747
|
-
* @property {string} [card_id]
|
|
1748
|
-
*/
|
|
1749
|
-
|
|
1750
1709
|
/**
|
|
1751
1710
|
* @typedef CheckCart
|
|
1752
1711
|
* @property {string} [coupon_text]
|
|
@@ -4021,53 +3980,6 @@ class CartPlatformModel {
|
|
|
4021
3980
|
});
|
|
4022
3981
|
}
|
|
4023
3982
|
|
|
4024
|
-
/** @returns {CartCheckoutCustomMeta} */
|
|
4025
|
-
static CartCheckoutCustomMeta() {
|
|
4026
|
-
return Joi.object({
|
|
4027
|
-
key: Joi.string().allow("").required(),
|
|
4028
|
-
value: Joi.string().allow("").required(),
|
|
4029
|
-
});
|
|
4030
|
-
}
|
|
4031
|
-
|
|
4032
|
-
/** @returns {PlatformCartCheckoutDetailRequest} */
|
|
4033
|
-
static PlatformCartCheckoutDetailRequest() {
|
|
4034
|
-
return Joi.object({
|
|
4035
|
-
custom_meta: Joi.array().items(
|
|
4036
|
-
CartPlatformModel.CartCheckoutCustomMeta()
|
|
4037
|
-
),
|
|
4038
|
-
address_id: Joi.string().allow(""),
|
|
4039
|
-
payment_identifier: Joi.string().allow("").allow(null),
|
|
4040
|
-
payment_params: Joi.any().allow(null),
|
|
4041
|
-
payment_auto_confirm: Joi.boolean(),
|
|
4042
|
-
id: Joi.string().allow("").required(),
|
|
4043
|
-
pos: Joi.boolean(),
|
|
4044
|
-
billing_address_id: Joi.string().allow(""),
|
|
4045
|
-
merchant_code: Joi.string().allow(""),
|
|
4046
|
-
aggregator: Joi.string().allow(""),
|
|
4047
|
-
pick_at_store_uid: Joi.number().allow(null),
|
|
4048
|
-
device_id: Joi.string().allow("").allow(null),
|
|
4049
|
-
delivery_address: Joi.any(),
|
|
4050
|
-
payment_mode: Joi.string().allow("").required(),
|
|
4051
|
-
checkout_mode: Joi.string().allow(""),
|
|
4052
|
-
customer_details: Joi.any().allow(null),
|
|
4053
|
-
meta: Joi.any(),
|
|
4054
|
-
staff: CartPlatformModel.StaffCheckout(),
|
|
4055
|
-
employee_code: Joi.string().allow("").allow(null),
|
|
4056
|
-
billing_address: Joi.any(),
|
|
4057
|
-
callback_url: Joi.string().allow("").allow(null),
|
|
4058
|
-
user_id: Joi.string().allow("").allow(null).required(),
|
|
4059
|
-
extra_meta: Joi.any(),
|
|
4060
|
-
order_type: Joi.string().allow("").required(),
|
|
4061
|
-
files: Joi.array().items(CartPlatformModel.Files()),
|
|
4062
|
-
ordering_store: Joi.number().allow(null),
|
|
4063
|
-
payment_extra_identifiers: Joi.any(),
|
|
4064
|
-
iin: Joi.string().allow(""),
|
|
4065
|
-
network: Joi.string().allow(""),
|
|
4066
|
-
type: Joi.string().allow(""),
|
|
4067
|
-
card_id: Joi.string().allow(""),
|
|
4068
|
-
});
|
|
4069
|
-
}
|
|
4070
|
-
|
|
4071
3983
|
/** @returns {CheckCart} */
|
|
4072
3984
|
static CheckCart() {
|
|
4073
3985
|
return Joi.object({
|
|
@@ -295,7 +295,7 @@ declare class Catalog {
|
|
|
295
295
|
* @summary: Get category return configuration
|
|
296
296
|
* @description: Get all category level configuration level set for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppCategoryReturnConfig/).
|
|
297
297
|
*/
|
|
298
|
-
getAppCategoryReturnConfig({ requestHeaders }?:
|
|
298
|
+
getAppCategoryReturnConfig({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppCategoryReturnConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponse>;
|
|
299
299
|
/**
|
|
300
300
|
* @param {CatalogPlatformApplicationValidator.GetAppInventoryParam} arg - Arg object
|
|
301
301
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -1746,13 +1746,17 @@ class Catalog {
|
|
|
1746
1746
|
* @description: Get all category level configuration level set for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppCategoryReturnConfig/).
|
|
1747
1747
|
*/
|
|
1748
1748
|
async getAppCategoryReturnConfig(
|
|
1749
|
-
{ requestHeaders } = { requestHeaders: {} },
|
|
1749
|
+
{ q, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
1750
1750
|
{ responseHeaders } = { responseHeaders: false }
|
|
1751
1751
|
) {
|
|
1752
1752
|
const {
|
|
1753
1753
|
error,
|
|
1754
1754
|
} = CatalogPlatformApplicationValidator.getAppCategoryReturnConfig().validate(
|
|
1755
|
-
{
|
|
1755
|
+
{
|
|
1756
|
+
q,
|
|
1757
|
+
pageNo,
|
|
1758
|
+
pageSize,
|
|
1759
|
+
},
|
|
1756
1760
|
{ abortEarly: false, allowUnknown: true }
|
|
1757
1761
|
);
|
|
1758
1762
|
if (error) {
|
|
@@ -1763,7 +1767,11 @@ class Catalog {
|
|
|
1763
1767
|
const {
|
|
1764
1768
|
error: warrning,
|
|
1765
1769
|
} = CatalogPlatformApplicationValidator.getAppCategoryReturnConfig().validate(
|
|
1766
|
-
{
|
|
1770
|
+
{
|
|
1771
|
+
q,
|
|
1772
|
+
pageNo,
|
|
1773
|
+
pageSize,
|
|
1774
|
+
},
|
|
1767
1775
|
{ abortEarly: false, allowUnknown: false }
|
|
1768
1776
|
);
|
|
1769
1777
|
if (warrning) {
|
|
@@ -1774,6 +1782,9 @@ class Catalog {
|
|
|
1774
1782
|
}
|
|
1775
1783
|
|
|
1776
1784
|
const query_params = {};
|
|
1785
|
+
query_params["q"] = q;
|
|
1786
|
+
query_params["page_no"] = pageNo;
|
|
1787
|
+
query_params["page_size"] = pageSize;
|
|
1777
1788
|
|
|
1778
1789
|
const response = await PlatformAPIClient.execute(
|
|
1779
1790
|
this.config,
|
|
@@ -96,7 +96,15 @@ export = CatalogPlatformApplicationValidator;
|
|
|
96
96
|
* Default is 12.
|
|
97
97
|
*/
|
|
98
98
|
/** @typedef GetAllSearchKeywordParam */
|
|
99
|
-
/**
|
|
99
|
+
/**
|
|
100
|
+
* @typedef GetAppCategoryReturnConfigParam
|
|
101
|
+
* @property {string} [q] - Get return configurations for categories by matching
|
|
102
|
+
* the search string with category names.
|
|
103
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
104
|
+
* set of results
|
|
105
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
106
|
+
* Default is 10.
|
|
107
|
+
*/
|
|
100
108
|
/**
|
|
101
109
|
* @typedef GetAppInventoryParam
|
|
102
110
|
* @property {number[]} [itemIds] - The Item Id of the product.
|
|
@@ -465,7 +473,7 @@ declare class CatalogPlatformApplicationValidator {
|
|
|
465
473
|
/** @returns {GetAllSearchKeywordParam} */
|
|
466
474
|
static getAllSearchKeyword(): any;
|
|
467
475
|
/** @returns {GetAppCategoryReturnConfigParam} */
|
|
468
|
-
static getAppCategoryReturnConfig():
|
|
476
|
+
static getAppCategoryReturnConfig(): GetAppCategoryReturnConfigParam;
|
|
469
477
|
/** @returns {GetAppInventoryParam} */
|
|
470
478
|
static getAppInventory(): GetAppInventoryParam;
|
|
471
479
|
/** @returns {GetAppLocationsParam} */
|
|
@@ -691,6 +699,23 @@ type GetAllCollectionsParam = {
|
|
|
691
699
|
*/
|
|
692
700
|
pageSize?: number;
|
|
693
701
|
};
|
|
702
|
+
type GetAppCategoryReturnConfigParam = {
|
|
703
|
+
/**
|
|
704
|
+
* - Get return configurations for categories by matching
|
|
705
|
+
* the search string with category names.
|
|
706
|
+
*/
|
|
707
|
+
q?: string;
|
|
708
|
+
/**
|
|
709
|
+
* - The page number to navigate through the given
|
|
710
|
+
* set of results
|
|
711
|
+
*/
|
|
712
|
+
pageNo?: number;
|
|
713
|
+
/**
|
|
714
|
+
* - Number of items to retrieve in each page.
|
|
715
|
+
* Default is 10.
|
|
716
|
+
*/
|
|
717
|
+
pageSize?: number;
|
|
718
|
+
};
|
|
694
719
|
type GetAppInventoryParam = {
|
|
695
720
|
/**
|
|
696
721
|
* - The Item Id of the product.
|
|
@@ -1289,7 +1314,6 @@ type UpdateSearchKeywordsParam = {
|
|
|
1289
1314
|
};
|
|
1290
1315
|
type DeleteSearchConfigurationParam = any;
|
|
1291
1316
|
type GetAllSearchKeywordParam = any;
|
|
1292
|
-
type GetAppCategoryReturnConfigParam = any;
|
|
1293
1317
|
type GetAppReturnConfigurationParam = any;
|
|
1294
1318
|
type GetAutocompleteConfigParam = any;
|
|
1295
1319
|
type GetCatalogConfigurationParam = any;
|
|
@@ -119,7 +119,15 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
119
119
|
|
|
120
120
|
/** @typedef GetAllSearchKeywordParam */
|
|
121
121
|
|
|
122
|
-
/**
|
|
122
|
+
/**
|
|
123
|
+
* @typedef GetAppCategoryReturnConfigParam
|
|
124
|
+
* @property {string} [q] - Get return configurations for categories by matching
|
|
125
|
+
* the search string with category names.
|
|
126
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
127
|
+
* set of results
|
|
128
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
129
|
+
* Default is 10.
|
|
130
|
+
*/
|
|
123
131
|
|
|
124
132
|
/**
|
|
125
133
|
* @typedef GetAppInventoryParam
|
|
@@ -643,7 +651,11 @@ class CatalogPlatformApplicationValidator {
|
|
|
643
651
|
|
|
644
652
|
/** @returns {GetAppCategoryReturnConfigParam} */
|
|
645
653
|
static getAppCategoryReturnConfig() {
|
|
646
|
-
return Joi.object({
|
|
654
|
+
return Joi.object({
|
|
655
|
+
q: Joi.string().allow(""),
|
|
656
|
+
pageNo: Joi.number(),
|
|
657
|
+
pageSize: Joi.number(),
|
|
658
|
+
}).required();
|
|
647
659
|
}
|
|
648
660
|
|
|
649
661
|
/** @returns {GetAppInventoryParam} */
|
|
@@ -62,27 +62,6 @@ declare class Catalog {
|
|
|
62
62
|
* @description: This API helps to create a bulk products upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkProductUploadJob/).
|
|
63
63
|
*/
|
|
64
64
|
createBulkProductUploadJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponse>;
|
|
65
|
-
/**
|
|
66
|
-
* @param {CatalogPlatformValidator.CreateCategoriesParam} arg - Arg object
|
|
67
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
68
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
69
|
-
* @returns {Promise<CatalogPlatformModel.CategoryCreateResponse>} - Success response
|
|
70
|
-
* @name createCategories
|
|
71
|
-
* @summary: Create categories
|
|
72
|
-
* @description: Allows to create product categories for specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCategories/).
|
|
73
|
-
*/
|
|
74
|
-
createCategories({ body, requestHeaders }?: CatalogPlatformValidator.CreateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryCreateResponse>;
|
|
75
|
-
/**
|
|
76
|
-
* @param {CatalogPlatformValidator.CreateDepartmentsParam} arg - Arg object
|
|
77
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
78
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
79
|
-
* @returns {Promise<CatalogPlatformModel.DepartmentCreateResponse>} -
|
|
80
|
-
* Success response
|
|
81
|
-
* @name createDepartments
|
|
82
|
-
* @summary: Create departments
|
|
83
|
-
* @description: Create departments for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createDepartments/).
|
|
84
|
-
*/
|
|
85
|
-
createDepartments({ body, requestHeaders }?: CatalogPlatformValidator.CreateDepartmentsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentCreateResponse>;
|
|
86
65
|
/**
|
|
87
66
|
* @param {CatalogPlatformValidator.CreateInventoryExportParam} arg - Arg object
|
|
88
67
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -285,6 +264,16 @@ declare class Catalog {
|
|
|
285
264
|
* @description: Retrieve all HSN codes associated with company products and provide search capabilities based on HSN code, reporting HSN, etc - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllProductHsnCodes/).
|
|
286
265
|
*/
|
|
287
266
|
getAllProductHsnCodes({ pageNo, pageSize, q, type, requestHeaders }?: CatalogPlatformValidator.GetAllProductHsnCodesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCodesListingResponseSchemaV2>;
|
|
267
|
+
/**
|
|
268
|
+
* @param {CatalogPlatformValidator.GetAttributeParam} arg - Arg object
|
|
269
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
270
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
271
|
+
* @returns {Promise<CatalogPlatformModel.AttributeDetail>} - Success response
|
|
272
|
+
* @name getAttribute
|
|
273
|
+
* @summary: Get attribute detail by slug
|
|
274
|
+
* @description: Retrieve the attribute detail for catalog listings by attribute slug passed for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAttribute/).
|
|
275
|
+
*/
|
|
276
|
+
getAttribute({ attributeSlug, requestHeaders }?: CatalogPlatformValidator.GetAttributeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AttributeDetail>;
|
|
288
277
|
/**
|
|
289
278
|
* @param {CatalogPlatformValidator.GetCategoryDataParam} arg - Arg object
|
|
290
279
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -336,16 +325,6 @@ declare class Catalog {
|
|
|
336
325
|
* @description: Retrieve detailed information about a specific department for a specific company by uid. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartmentData/).
|
|
337
326
|
*/
|
|
338
327
|
getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
|
|
339
|
-
/**
|
|
340
|
-
* @param {CatalogPlatformValidator.GetGenderAttributeParam} arg - Arg object
|
|
341
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
342
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
343
|
-
* @returns {Promise<CatalogPlatformModel.GenderDetail>} - Success response
|
|
344
|
-
* @name getGenderAttribute
|
|
345
|
-
* @summary: Get gender attribute by slug
|
|
346
|
-
* @description: Retrieve the gender attribute for catalog listings by attribute slug passed for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGenderAttribute/).
|
|
347
|
-
*/
|
|
348
|
-
getGenderAttribute({ attributeSlug, requestHeaders }?: CatalogPlatformValidator.GetGenderAttributeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GenderDetail>;
|
|
349
328
|
/**
|
|
350
329
|
* @param {CatalogPlatformValidator.GetHsnCodeParam} arg - Arg object
|
|
351
330
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -942,26 +921,6 @@ declare class Catalog {
|
|
|
942
921
|
* @description: Retrieve values related to template brand types for a specific company. The filter type query parameter defines what type of data to return. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listTemplateBrandTypeValues/).
|
|
943
922
|
*/
|
|
944
923
|
listTemplateBrandTypeValues({ filter, templateTag, itemType, requestHeaders }?: CatalogPlatformValidator.ListTemplateBrandTypeValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductConfigurationDownloads>;
|
|
945
|
-
/**
|
|
946
|
-
* @param {CatalogPlatformValidator.UpdateCategoryParam} arg - Arg object
|
|
947
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
948
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
949
|
-
* @returns {Promise<CatalogPlatformModel.CategoryUpdateResponse>} - Success response
|
|
950
|
-
* @name updateCategory
|
|
951
|
-
* @summary: Update category
|
|
952
|
-
* @description: Modify data for an existing category by its uid for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateCategory/).
|
|
953
|
-
*/
|
|
954
|
-
updateCategory({ uid, body, requestHeaders }?: CatalogPlatformValidator.UpdateCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryUpdateResponse>;
|
|
955
|
-
/**
|
|
956
|
-
* @param {CatalogPlatformValidator.UpdateDepartmentParam} arg - Arg object
|
|
957
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
958
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
959
|
-
* @returns {Promise<CatalogPlatformModel.DepartmentModel>} - Success response
|
|
960
|
-
* @name updateDepartment
|
|
961
|
-
* @summary: Update department
|
|
962
|
-
* @description: Modify the department data by their uid for a specifc company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDepartment/).
|
|
963
|
-
*/
|
|
964
|
-
updateDepartment({ uid, body, requestHeaders }?: CatalogPlatformValidator.UpdateDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentModel>;
|
|
965
924
|
/**
|
|
966
925
|
* @param {CatalogPlatformValidator.UpdateHsnCodeParam} arg - Arg object
|
|
967
926
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|