@gofynd/fdk-client-javascript 1.2.0 → 1.3.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 +44 -7
- package/package.json +1 -2
- package/sdk/application/ApplicationAPIClient.d.ts +3 -3
- package/sdk/application/ApplicationAPIClient.js +6 -4
- package/sdk/application/ApplicationClient.d.ts +2 -3
- package/sdk/application/ApplicationClient.js +1 -45
- package/sdk/application/ApplicationConfig.d.ts +46 -6
- package/sdk/application/ApplicationConfig.js +15 -16
- package/sdk/application/Cart/CartApplicationClient.d.ts +61 -33
- package/sdk/application/Cart/CartApplicationClient.js +225 -134
- package/sdk/application/Cart/CartApplicationModel.d.ts +4 -4
- package/sdk/application/Cart/CartApplicationModel.js +4 -4
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +61 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +234 -146
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +115 -13
- package/sdk/application/Catalog/CatalogApplicationModel.js +77 -12
- package/sdk/application/Common/CommonApplicationClient.d.ts +5 -3
- package/sdk/application/Common/CommonApplicationClient.js +13 -11
- package/sdk/application/Common/CommonApplicationModel.d.ts +3 -83
- package/sdk/application/Common/CommonApplicationModel.js +2 -58
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +9 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +25 -13
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +1 -34
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +46 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +144 -68
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1 -219
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -226
- package/sdk/application/Content/ContentApplicationClient.d.ts +49 -21
- package/sdk/application/Content/ContentApplicationClient.js +159 -80
- package/sdk/application/Content/ContentApplicationModel.d.ts +5 -622
- package/sdk/application/Content/ContentApplicationModel.js +11 -763
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +20 -14
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +1 -152
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -180
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -7
- package/sdk/application/Lead/LeadApplicationClient.js +50 -31
- package/sdk/application/Lead/LeadApplicationModel.d.ts +22 -741
- package/sdk/application/Lead/LeadApplicationModel.js +21 -481
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +11 -5
- package/sdk/application/Logistic/LogisticApplicationClient.js +41 -20
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -12
- package/sdk/application/Order/OrderApplicationClient.js +88 -56
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -42
- package/sdk/application/Payment/PaymentApplicationClient.js +293 -194
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +36 -36
- package/sdk/application/Payment/PaymentApplicationModel.js +36 -36
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +59 -32
- package/sdk/application/PosCart/PosCartApplicationClient.js +214 -130
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +2 -2
- package/sdk/application/PosCart/PosCartApplicationModel.js +2 -2
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +16 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +56 -29
- package/sdk/application/Share/ShareApplicationClient.d.ts +15 -7
- package/sdk/application/Share/ShareApplicationClient.js +51 -31
- package/sdk/application/Share/ShareApplicationModel.d.ts +1 -33
- package/sdk/application/Share/ShareApplicationModel.js +0 -38
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +9 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +35 -18
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +982 -312
- package/sdk/application/Theme/ThemeApplicationModel.js +621 -284
- package/sdk/application/User/UserApplicationClient.d.ts +74 -35
- package/sdk/application/User/UserApplicationClient.js +252 -161
- package/sdk/application/User/UserApplicationModel.d.ts +3 -401
- package/sdk/application/User/UserApplicationModel.js +2 -490
- package/sdk/common/AxiosHelper.js +1 -2
- package/sdk/common/FDKError.d.ts +3 -0
- package/sdk/common/FDKError.js +8 -0
- package/sdk/common/utils.d.ts +3 -0
- package/sdk/common/utils.js +29 -0
- package/sdk/partner/PartnerAPIClient.d.ts +5 -4
- package/sdk/partner/PartnerAPIClient.js +7 -4
- package/sdk/partner/PartnerClient.d.ts +2 -0
- package/sdk/partner/PartnerClient.js +3 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +299 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +768 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1706 -0
- package/sdk/partner/Theme/ThemePartnerModel.js +1409 -0
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +22 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +157 -0
- package/sdk/partner/index.d.ts +3 -1
- package/sdk/partner/index.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +38 -16
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +1 -13
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +0 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +10 -0
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +4 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +59 -14
- package/sdk/platform/Billing/BillingPlatformClient.js +315 -64
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +56 -196
- package/sdk/platform/Billing/BillingPlatformModel.js +63 -217
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +23 -1
- package/sdk/platform/Billing/BillingPlatformValidator.js +31 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +124 -63
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +431 -265
- package/sdk/platform/Cart/CartPlatformModel.d.ts +253 -53
- package/sdk/platform/Cart/CartPlatformModel.js +104 -54
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +120 -53
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +398 -247
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +155 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.js +561 -355
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +10 -12
- package/sdk/platform/Catalog/CatalogPlatformModel.js +10 -12
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +30 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -0
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -3
- package/sdk/platform/Common/CommonPlatformClient.js +13 -11
- package/sdk/platform/Common/CommonPlatformModel.d.ts +39 -64
- package/sdk/platform/Common/CommonPlatformModel.js +23 -57
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +5 -10
- package/sdk/platform/Common/CommonPlatformValidator.js +3 -4
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +370 -120
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +2328 -888
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +143 -24
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +179 -15
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +6 -5
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +386 -308
- package/sdk/platform/Communication/CommunicationPlatformModel.js +415 -355
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +38 -13
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +171 -57
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +53 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +54 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +5 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +96 -29
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +311 -126
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +5 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +36 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +121 -86
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +13 -180
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +5 -113
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +162 -70
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +528 -309
- package/sdk/platform/Content/ContentPlatformModel.d.ts +9 -198
- package/sdk/platform/Content/ContentPlatformModel.js +8 -231
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +48 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +142 -48
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +40 -1
- package/sdk/platform/Discount/DiscountPlatformModel.js +27 -0
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +84 -18
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +486 -53
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +71 -7
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +81 -5
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +13 -18
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +58 -65
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +198 -71
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +212 -64
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +18 -10
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +177 -40
- package/sdk/platform/Finance/FinancePlatformClient.js +1028 -132
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +670 -22
- package/sdk/platform/Finance/FinancePlatformModel.js +809 -23
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +111 -1
- package/sdk/platform/Finance/FinancePlatformValidator.js +134 -0
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +24 -12
- package/sdk/platform/Inventory/InventoryPlatformClient.js +94 -52
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +27 -13
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +101 -55
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +50 -39
- package/sdk/platform/Lead/LeadPlatformClient.js +171 -112
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +32 -390
- package/sdk/platform/Lead/LeadPlatformModel.js +31 -214
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +33 -33
- package/sdk/platform/Lead/LeadPlatformValidator.js +23 -23
- package/sdk/platform/OAuthClient.js +6 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +12 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +165 -71
- package/sdk/platform/Order/OrderPlatformClient.js +738 -205
- package/sdk/platform/Order/OrderPlatformModel.d.ts +261 -3
- package/sdk/platform/Order/OrderPlatformModel.js +225 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +104 -3
- package/sdk/platform/Order/OrderPlatformValidator.js +85 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -22
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +12 -159
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -30
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +0 -26
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -690
- package/sdk/platform/Partner/PartnerPlatformModel.js +0 -809
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +167 -32
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +793 -145
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +91 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +91 -0
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +68 -47
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +549 -7
- package/sdk/platform/Payment/PaymentPlatformModel.js +305 -6
- package/sdk/platform/PlatformAPIClient.d.ts +3 -3
- package/sdk/platform/PlatformAPIClient.js +2 -2
- package/sdk/platform/PlatformClient.d.ts +2 -2
- package/sdk/platform/PlatformClient.js +4 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +28 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +90 -53
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +1 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +62 -26
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +210 -93
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +20 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +23 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +36 -18
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +142 -78
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +12 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +14 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -26
- package/sdk/platform/Share/SharePlatformApplicationClient.js +36 -67
- package/sdk/platform/Share/SharePlatformModel.d.ts +4 -4
- package/sdk/platform/Share/SharePlatformModel.js +4 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +127 -57
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +564 -189
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +63 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +62 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +37 -0
- package/sdk/platform/Theme/ThemePlatformClient.js +235 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +1167 -261
- package/sdk/platform/Theme/ThemePlatformModel.js +801 -244
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +32 -0
- package/sdk/platform/Theme/ThemePlatformValidator.js +38 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -17
- package/sdk/platform/User/UserPlatformApplicationClient.js +132 -73
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.js +3 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +1 -738
- package/sdk/platform/User/UserPlatformModel.js +3 -899
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +120 -7
- package/sdk/platform/Webhook/WebhookPlatformClient.js +799 -41
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +476 -86
- package/sdk/platform/Webhook/WebhookPlatformModel.js +388 -89
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +96 -9
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +117 -5
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +13 -11
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +3 -106
- package/sdk/public/Configuration/ConfigurationPublicModel.js +2 -59
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +12 -6
- package/sdk/public/Inventory/InventoryPublicClient.js +42 -27
- package/sdk/public/Partner/PartnerPublicClient.d.ts +22 -0
- package/sdk/public/Partner/PartnerPublicClient.js +110 -0
- package/sdk/public/Partner/PartnerPublicModel.d.ts +240 -0
- package/sdk/public/Partner/PartnerPublicModel.js +280 -0
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +18 -0
- package/sdk/public/Partner/PartnerPublicValidator.js +19 -0
- package/sdk/public/PublicAPIClient.d.ts +14 -1
- package/sdk/public/PublicAPIClient.js +7 -1
- package/sdk/public/PublicClient.d.ts +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +15 -9
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +1 -191
- package/sdk/public/Webhook/WebhookPublicModel.js +0 -229
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/application/ApplicationModels.d.ts +0 -48
- package/sdk/application/ApplicationModels.js +0 -38
- package/sdk/platform/Partner/PartnerPlatformClient.d.ts +0 -106
- package/sdk/platform/Partner/PartnerPlatformClient.js +0 -878
- package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +0 -208
- package/sdk/platform/Partner/PartnerPlatformValidator.js +0 -169
|
@@ -5,44 +5,49 @@ declare class Cart {
|
|
|
5
5
|
applicationId: any;
|
|
6
6
|
/**
|
|
7
7
|
* @param {CartPlatformApplicationValidator.AddAddressParam} arg - Arg object
|
|
8
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
8
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
10
|
* @returns {Promise<CartPlatformModel.SaveAddressResponse>} - Success response
|
|
10
11
|
* @name addAddress
|
|
11
12
|
* @summary: Add address to an account
|
|
12
13
|
* @description: Use this API to add an address to an account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addAddress/).
|
|
13
14
|
*/
|
|
14
|
-
addAddress({ body }?: CartPlatformApplicationValidator.AddAddressParam, {
|
|
15
|
+
addAddress({ body, requestHeaders }?: CartPlatformApplicationValidator.AddAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.SaveAddressResponse>;
|
|
15
16
|
/**
|
|
16
17
|
* @param {CartPlatformApplicationValidator.AddItemsParam} arg - Arg object
|
|
18
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
17
19
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
18
20
|
* @returns {Promise<CartPlatformModel.AddCartDetailResponse>} - Success response
|
|
19
21
|
* @name addItems
|
|
20
22
|
* @summary: Add items to abandoned cart
|
|
21
23
|
* @description: Use this API to add items to the abandoned cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addItems/).
|
|
22
24
|
*/
|
|
23
|
-
addItems({ cartId, body, b }?: CartPlatformApplicationValidator.AddItemsParam, {
|
|
25
|
+
addItems({ cartId, body, b, requestHeaders }?: CartPlatformApplicationValidator.AddItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.AddCartDetailResponse>;
|
|
24
26
|
/**
|
|
25
27
|
* @param {CartPlatformApplicationValidator.AddPriceAdjustmentParam} arg - Arg object
|
|
28
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
26
29
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
27
30
|
* @returns {Promise<CartPlatformModel.PriceAdjustmentResponse>} - Success response
|
|
28
31
|
* @name addPriceAdjustment
|
|
29
32
|
* @summary: Create new price adjustment
|
|
30
33
|
* @description: Create new price adjustment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addPriceAdjustment/).
|
|
31
34
|
*/
|
|
32
|
-
addPriceAdjustment({ body }?: CartPlatformApplicationValidator.AddPriceAdjustmentParam, {
|
|
35
|
+
addPriceAdjustment({ body, requestHeaders }?: CartPlatformApplicationValidator.AddPriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.PriceAdjustmentResponse>;
|
|
33
36
|
/**
|
|
34
37
|
* @param {CartPlatformApplicationValidator.ApplyCouponParam} arg - Arg object
|
|
38
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
35
39
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
36
40
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
37
41
|
* @name applyCoupon
|
|
38
42
|
* @summary: Apply Coupon for platform pos user
|
|
39
43
|
* @description: Use this API to apply coupons on items in the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/applyCoupon/).
|
|
40
44
|
*/
|
|
41
|
-
applyCoupon({ body, i, b, p, id, buyNow }?: CartPlatformApplicationValidator.ApplyCouponParam, {
|
|
45
|
+
applyCoupon({ body, i, b, p, id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.ApplyCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
42
46
|
/**
|
|
43
47
|
* @param {CartPlatformApplicationValidator.CheckCartServiceabilityParam} arg
|
|
44
48
|
* - Arg object
|
|
45
49
|
*
|
|
50
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
46
51
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
47
52
|
* @returns {Promise<CartPlatformModel.OpenApiCartServiceabilityResponse>}
|
|
48
53
|
* - Success response
|
|
@@ -51,82 +56,91 @@ declare class Cart {
|
|
|
51
56
|
* @summary: Check Pincode Serviceability
|
|
52
57
|
* @description: Check Pincode serviceability for cart items provided in `cart_items` and address pincode in `shipping_address` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/checkCartServiceability/).
|
|
53
58
|
*/
|
|
54
|
-
checkCartServiceability({ body }?: CartPlatformApplicationValidator.CheckCartServiceabilityParam, {
|
|
59
|
+
checkCartServiceability({ body, requestHeaders }?: CartPlatformApplicationValidator.CheckCartServiceabilityParam, { responseHeaders }?: object): Promise<CartPlatformModel.OpenApiCartServiceabilityResponse>;
|
|
55
60
|
/**
|
|
56
61
|
* @param {CartPlatformApplicationValidator.CheckoutCartParam} arg - Arg object
|
|
62
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
57
63
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
58
64
|
* @returns {Promise<CartPlatformModel.OpenApiCheckoutResponse>} - Success response
|
|
59
65
|
* @name checkoutCart
|
|
60
66
|
* @summary: Create Fynd order with cart details
|
|
61
67
|
* @description: Generate Fynd order for cart details send with provided `cart_items` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/checkoutCart/).
|
|
62
68
|
*/
|
|
63
|
-
checkoutCart({ body }?: CartPlatformApplicationValidator.CheckoutCartParam, {
|
|
69
|
+
checkoutCart({ body, requestHeaders }?: CartPlatformApplicationValidator.CheckoutCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.OpenApiCheckoutResponse>;
|
|
64
70
|
/**
|
|
65
71
|
* @param {CartPlatformApplicationValidator.CreateCartMetaConfigParam} arg
|
|
66
72
|
* - Arg object
|
|
67
73
|
*
|
|
74
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
68
75
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
69
76
|
* @returns {Promise<CartPlatformModel.CartMetaConfigAdd>} - Success response
|
|
70
77
|
* @name createCartMetaConfig
|
|
71
78
|
* @summary: Create new cart meta configuration
|
|
72
79
|
* @description: Create new cart meta configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/createCartMetaConfig/).
|
|
73
80
|
*/
|
|
74
|
-
createCartMetaConfig({ body }?: CartPlatformApplicationValidator.CreateCartMetaConfigParam, {
|
|
81
|
+
createCartMetaConfig({ body, requestHeaders }?: CartPlatformApplicationValidator.CreateCartMetaConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaConfigAdd>;
|
|
75
82
|
/**
|
|
76
83
|
* @param {CartPlatformApplicationValidator.CreateCouponParam} arg - Arg object
|
|
84
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
77
85
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
78
86
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
79
87
|
* @name createCoupon
|
|
80
88
|
* @summary: Create new coupon
|
|
81
89
|
* @description: Create new coupon - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/createCoupon/).
|
|
82
90
|
*/
|
|
83
|
-
createCoupon({ body }?: CartPlatformApplicationValidator.CreateCouponParam, {
|
|
91
|
+
createCoupon({ body, requestHeaders }?: CartPlatformApplicationValidator.CreateCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
84
92
|
/**
|
|
85
93
|
* @param {CartPlatformApplicationValidator.CreatePromotionParam} arg - Arg object
|
|
94
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
86
95
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
87
96
|
* @returns {Promise<CartPlatformModel.PromotionAdd>} - Success response
|
|
88
97
|
* @name createPromotion
|
|
89
98
|
* @summary: Create new promotion
|
|
90
99
|
* @description: Create new promotion - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/createPromotion/).
|
|
91
100
|
*/
|
|
92
|
-
createPromotion({ body }?: CartPlatformApplicationValidator.CreatePromotionParam, {
|
|
101
|
+
createPromotion({ body, requestHeaders }?: CartPlatformApplicationValidator.CreatePromotionParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionAdd>;
|
|
93
102
|
/**
|
|
94
103
|
* @param {CartPlatformApplicationValidator.DeleteCartParam} arg - Arg object
|
|
104
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
95
105
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
96
106
|
* @returns {Promise<CartPlatformModel.DeleteCartDetailResponse>} - Success response
|
|
97
107
|
* @name deleteCart
|
|
98
108
|
* @summary: Delete cart once user made successful checkout
|
|
99
109
|
* @description: Use this API to delete the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/deleteCart/).
|
|
100
110
|
*/
|
|
101
|
-
deleteCart({ body, id }?: CartPlatformApplicationValidator.DeleteCartParam, {
|
|
111
|
+
deleteCart({ body, id, requestHeaders }?: CartPlatformApplicationValidator.DeleteCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.DeleteCartDetailResponse>;
|
|
102
112
|
/**
|
|
103
113
|
* @param {CartPlatformApplicationValidator.FetchAndvalidateCartItemsParam} arg
|
|
104
114
|
* - Arg object
|
|
105
115
|
*
|
|
116
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
106
117
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
107
118
|
* @returns {Promise<CartPlatformModel.OpenapiCartDetailsResponse>} - Success response
|
|
108
119
|
* @name fetchAndvalidateCartItems
|
|
109
120
|
* @summary: Fetch Cart Details
|
|
110
121
|
* @description: Get all the details of cart for a list of provided `cart_items` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/fetchAndvalidateCartItems/).
|
|
111
122
|
*/
|
|
112
|
-
fetchAndvalidateCartItems({ body }?: CartPlatformApplicationValidator.FetchAndvalidateCartItemsParam, {
|
|
123
|
+
fetchAndvalidateCartItems({ body, requestHeaders }?: CartPlatformApplicationValidator.FetchAndvalidateCartItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.OpenapiCartDetailsResponse>;
|
|
113
124
|
/**
|
|
125
|
+
* @param {CartPlatformApplicationValidator.FetchCartMetaConfigParam} arg - Arg object
|
|
126
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
114
127
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
115
128
|
* @returns {Promise<CartPlatformModel.CartMetaConfigAdd>} - Success response
|
|
116
129
|
* @name fetchCartMetaConfig
|
|
117
130
|
* @summary: Fetch cart meta configuration
|
|
118
131
|
* @description: Fetch cart meta configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/fetchCartMetaConfig/).
|
|
119
132
|
*/
|
|
120
|
-
fetchCartMetaConfig({
|
|
133
|
+
fetchCartMetaConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaConfigAdd>;
|
|
121
134
|
/**
|
|
122
135
|
* @param {CartPlatformApplicationValidator.GetAbandonedCartParam} arg - Arg object
|
|
136
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
123
137
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
124
138
|
* @returns {Promise<CartPlatformModel.AbandonedCartResponse>} - Success response
|
|
125
139
|
* @name getAbandonedCart
|
|
126
140
|
* @summary: Get with abandoned cart list
|
|
127
141
|
* @description: Get abandoned cart list with pagination - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAbandonedCart/).
|
|
128
142
|
*/
|
|
129
|
-
getAbandonedCart({ pageNo, pageSize, fromDate, toDate, anonymousCart, lastId, sortOn }?: CartPlatformApplicationValidator.GetAbandonedCartParam, {
|
|
143
|
+
getAbandonedCart({ pageNo, pageSize, fromDate, toDate, anonymousCart, lastId, sortOn, requestHeaders, }?: CartPlatformApplicationValidator.GetAbandonedCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.AbandonedCartResponse>;
|
|
130
144
|
/**
|
|
131
145
|
* @param {Object} arg - Arg object.
|
|
132
146
|
* @param {string} arg.companyId - Current company id
|
|
@@ -155,123 +169,139 @@ declare class Cart {
|
|
|
155
169
|
* @param {CartPlatformApplicationValidator.GetAbandonedCartDetailsParam} arg
|
|
156
170
|
* - Arg object
|
|
157
171
|
*
|
|
172
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
158
173
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
159
174
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
160
175
|
* @name getAbandonedCartDetails
|
|
161
176
|
* @summary: Fetch all items added to the cart
|
|
162
177
|
* @description: Use this API to get details of all the items added to a cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAbandonedCartDetails/).
|
|
163
178
|
*/
|
|
164
|
-
getAbandonedCartDetails({ id, i, b }?: CartPlatformApplicationValidator.GetAbandonedCartDetailsParam, {
|
|
179
|
+
getAbandonedCartDetails({ id, i, b, requestHeaders }?: CartPlatformApplicationValidator.GetAbandonedCartDetailsParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
165
180
|
/**
|
|
166
181
|
* @param {CartPlatformApplicationValidator.GetAddressByIdParam} arg - Arg object
|
|
182
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
167
183
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
168
184
|
* @returns {Promise<CartPlatformModel.PlatformAddress>} - Success response
|
|
169
185
|
* @name getAddressById
|
|
170
186
|
* @summary: Fetch a single address by its ID
|
|
171
|
-
* @description: Use this API to get an addresses using its ID. If successful, returns a Address resource in the response body specified in `PlatformAddress`. Attibutes listed below are optional
|
|
187
|
+
* @description: Use this API to get an addresses using its ID. If successful, returns a Address resource in the response body specified in `PlatformAddress`. Attibutes listed below are optional mobile_no checkout_mode tags default - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAddressById/).
|
|
172
188
|
*/
|
|
173
|
-
getAddressById({ id, cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, userId, }?: CartPlatformApplicationValidator.GetAddressByIdParam, {
|
|
189
|
+
getAddressById({ id, cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, userId, requestHeaders, }?: CartPlatformApplicationValidator.GetAddressByIdParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformAddress>;
|
|
174
190
|
/**
|
|
175
191
|
* @param {CartPlatformApplicationValidator.GetAddressesParam} arg - Arg object
|
|
192
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
176
193
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
177
194
|
* @returns {Promise<CartPlatformModel.PlatformGetAddressesResponse>} -
|
|
178
195
|
* Success response
|
|
179
196
|
* @name getAddresses
|
|
180
197
|
* @summary: Fetch address
|
|
181
|
-
* @description: Use this API to get all the addresses associated with an account. If successful, returns a Address resource in the response body specified in GetAddressesResponse.attibutes listed below are optional
|
|
198
|
+
* @description: Use this API to get all the addresses associated with an account. If successful, returns a Address resource in the response body specified in GetAddressesResponse.attibutes listed below are optional uid address_id mobile_no checkout_mode tags default - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAddresses/).
|
|
182
199
|
*/
|
|
183
|
-
getAddresses({ cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, userId }?: CartPlatformApplicationValidator.GetAddressesParam, {
|
|
200
|
+
getAddresses({ cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, userId, requestHeaders, }?: CartPlatformApplicationValidator.GetAddressesParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformGetAddressesResponse>;
|
|
184
201
|
/**
|
|
185
202
|
* @param {CartPlatformApplicationValidator.GetAppCouponsParam} arg - Arg object
|
|
203
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
186
204
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
187
205
|
* @returns {Promise<CartPlatformModel.GetCouponResponse>} - Success response
|
|
188
206
|
* @name getAppCoupons
|
|
189
207
|
* @summary: Fetch Coupon
|
|
190
208
|
* @description: Use this API to get a list of available coupons along with their details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAppCoupons/).
|
|
191
209
|
*/
|
|
192
|
-
getAppCoupons({ id, buyNow }?: CartPlatformApplicationValidator.GetAppCouponsParam, {
|
|
210
|
+
getAppCoupons({ id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.GetAppCouponsParam, { responseHeaders }?: object): Promise<CartPlatformModel.GetCouponResponse>;
|
|
193
211
|
/**
|
|
194
212
|
* @param {CartPlatformApplicationValidator.GetAvailableDeliveryModesParam} arg
|
|
195
213
|
* - Arg object
|
|
196
214
|
*
|
|
215
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
197
216
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
198
217
|
* @returns {Promise<CartPlatformModel.CartDeliveryModesResponse>} - Success response
|
|
199
218
|
* @name getAvailableDeliveryModes
|
|
200
219
|
* @summary: Get available delivery modes for cart
|
|
201
220
|
* @description: Use this API to get the delivery modes (home-delivery/store-pickup) along with a list of pickup stores available for a given cart at a given PIN Code. User can then view the address of a pickup store with the help of store-address API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAvailableDeliveryModes/).
|
|
202
221
|
*/
|
|
203
|
-
getAvailableDeliveryModes({ areaCode, id }?: CartPlatformApplicationValidator.GetAvailableDeliveryModesParam, {
|
|
222
|
+
getAvailableDeliveryModes({ areaCode, id, requestHeaders }?: CartPlatformApplicationValidator.GetAvailableDeliveryModesParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDeliveryModesResponse>;
|
|
204
223
|
/**
|
|
205
224
|
* @param {CartPlatformApplicationValidator.GetCartParam} arg - Arg object
|
|
225
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
206
226
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
207
227
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
208
228
|
* @name getCart
|
|
209
229
|
* @summary: Fetch all items added to the customer cart using cart id
|
|
210
230
|
* @description: Use this API to get details of all the items added to a cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCart/).
|
|
211
231
|
*/
|
|
212
|
-
getCart({ id, userId, i, b, assignCardId, buyNow }?: CartPlatformApplicationValidator.GetCartParam, {
|
|
232
|
+
getCart({ id, userId, i, b, assignCardId, buyNow, requestHeaders }?: CartPlatformApplicationValidator.GetCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
213
233
|
/**
|
|
214
234
|
* @param {CartPlatformApplicationValidator.GetCartListParam} arg - Arg object
|
|
235
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
215
236
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
216
237
|
* @returns {Promise<CartPlatformModel.MultiCartResponse>} - Success response
|
|
217
238
|
* @name getCartList
|
|
218
239
|
* @summary: Get cart list for store os user
|
|
219
240
|
* @description: Get all carts for the store os user which is created for customer - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCartList/).
|
|
220
241
|
*/
|
|
221
|
-
getCartList({ fromDate, toDate, filterOn }?: CartPlatformApplicationValidator.GetCartListParam, {
|
|
242
|
+
getCartList({ fromDate, toDate, filterOn, requestHeaders }?: CartPlatformApplicationValidator.GetCartListParam, { responseHeaders }?: object): Promise<CartPlatformModel.MultiCartResponse>;
|
|
222
243
|
/**
|
|
223
244
|
* @param {CartPlatformApplicationValidator.GetCartShareLinkParam} arg - Arg object
|
|
245
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
224
246
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
225
247
|
* @returns {Promise<CartPlatformModel.GetShareCartLinkResponse>} - Success response
|
|
226
248
|
* @name getCartShareLink
|
|
227
249
|
* @summary: Generate token for sharing the cart
|
|
228
250
|
* @description: Use this API to generate a shared cart snapshot and return a shortlink token. The link can be shared with other users for getting the same items in their cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCartShareLink/).
|
|
229
251
|
*/
|
|
230
|
-
getCartShareLink({ body }?: CartPlatformApplicationValidator.GetCartShareLinkParam, {
|
|
252
|
+
getCartShareLink({ body, requestHeaders }?: CartPlatformApplicationValidator.GetCartShareLinkParam, { responseHeaders }?: object): Promise<CartPlatformModel.GetShareCartLinkResponse>;
|
|
231
253
|
/**
|
|
232
254
|
* @param {CartPlatformApplicationValidator.GetCartSharedItemsParam} arg - Arg object
|
|
255
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
233
256
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
234
257
|
* @returns {Promise<CartPlatformModel.SharedCartResponse>} - Success response
|
|
235
258
|
* @name getCartSharedItems
|
|
236
259
|
* @summary: Get details of a shared cart
|
|
237
260
|
* @description: Use this API to get the shared cart details as per the token generated using the share-cart API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCartSharedItems/).
|
|
238
261
|
*/
|
|
239
|
-
getCartSharedItems({ token }?: CartPlatformApplicationValidator.GetCartSharedItemsParam, {
|
|
262
|
+
getCartSharedItems({ token, requestHeaders }?: CartPlatformApplicationValidator.GetCartSharedItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.SharedCartResponse>;
|
|
240
263
|
/**
|
|
241
264
|
* @param {CartPlatformApplicationValidator.GetCouponByIdParam} arg - Arg object
|
|
265
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
242
266
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
243
267
|
* @returns {Promise<CartPlatformModel.CouponUpdate>} - Success response
|
|
244
268
|
* @name getCouponById
|
|
245
269
|
* @summary: Get with single coupon details or coupon list
|
|
246
270
|
* @description: Get single coupon details with `id` in path param - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponById/).
|
|
247
271
|
*/
|
|
248
|
-
getCouponById({ id }?: CartPlatformApplicationValidator.GetCouponByIdParam, {
|
|
272
|
+
getCouponById({ id, requestHeaders }?: CartPlatformApplicationValidator.GetCouponByIdParam, { responseHeaders }?: object): Promise<CartPlatformModel.CouponUpdate>;
|
|
249
273
|
/**
|
|
250
274
|
* @param {CartPlatformApplicationValidator.GetCouponCodeExistsParam} arg - Arg object
|
|
275
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
251
276
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
252
277
|
* @returns {Promise<Object>} - Success response
|
|
253
278
|
* @name getCouponCodeExists
|
|
254
279
|
* @summary: Check if coupon is already created with coupon code
|
|
255
280
|
* @description: Check if sent coupon code is already existing coupon code. As coupon code is to be unique. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponCodeExists/).
|
|
256
281
|
*/
|
|
257
|
-
getCouponCodeExists({ code }?: CartPlatformApplicationValidator.GetCouponCodeExistsParam, {
|
|
282
|
+
getCouponCodeExists({ code, requestHeaders }?: CartPlatformApplicationValidator.GetCouponCodeExistsParam, { responseHeaders }?: object): Promise<any>;
|
|
258
283
|
/**
|
|
284
|
+
* @param {CartPlatformApplicationValidator.GetCouponOptionValuesParam} arg
|
|
285
|
+
* - Arg object
|
|
286
|
+
*
|
|
287
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
259
288
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
260
289
|
* @returns {Promise<Object>} - Success response
|
|
261
290
|
* @name getCouponOptionValues
|
|
262
291
|
* @summary: Get coupon options enums with display values
|
|
263
292
|
* @description: Get coupon enum values for fields in valid coupon object. Used for front end to create, update and filter coupon lists via fields - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponOptionValues/).
|
|
264
293
|
*/
|
|
265
|
-
getCouponOptionValues({
|
|
294
|
+
getCouponOptionValues({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
266
295
|
/**
|
|
267
296
|
* @param {CartPlatformApplicationValidator.GetCouponsParam} arg - Arg object
|
|
297
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
268
298
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
269
299
|
* @returns {Promise<CartPlatformModel.CouponsResponse>} - Success response
|
|
270
300
|
* @name getCoupons
|
|
271
301
|
* @summary: Get with single coupon details or coupon list
|
|
272
302
|
* @description: Get coupon list with pagination - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCoupons/).
|
|
273
303
|
*/
|
|
274
|
-
getCoupons({ pageNo, pageSize, isArchived, title, isPublic, isDisplay, typeSlug, code, }?: CartPlatformApplicationValidator.GetCouponsParam, {
|
|
304
|
+
getCoupons({ pageNo, pageSize, isArchived, title, isPublic, isDisplay, typeSlug, code, requestHeaders, }?: CartPlatformApplicationValidator.GetCouponsParam, { responseHeaders }?: object): Promise<CartPlatformModel.CouponsResponse>;
|
|
275
305
|
/**
|
|
276
306
|
* @param {Object} arg - Arg object.
|
|
277
307
|
* @param {string} arg.companyId - Current company id
|
|
@@ -300,53 +330,58 @@ declare class Cart {
|
|
|
300
330
|
}): Paginator<CartPlatformModel.CouponsResponse>;
|
|
301
331
|
/**
|
|
302
332
|
* @param {CartPlatformApplicationValidator.GetItemCountParam} arg - Arg object
|
|
333
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
303
334
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
304
335
|
* @returns {Promise<CartPlatformModel.CartItemCountResponse>} - Success response
|
|
305
336
|
* @name getItemCount
|
|
306
337
|
* @summary: Count items in the customer's cart
|
|
307
338
|
* @description: Use this API to get the total number of items present in cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getItemCount/).
|
|
308
339
|
*/
|
|
309
|
-
getItemCount({ id, buyNow }?: CartPlatformApplicationValidator.GetItemCountParam, {
|
|
340
|
+
getItemCount({ id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.GetItemCountParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartItemCountResponse>;
|
|
310
341
|
/**
|
|
311
342
|
* @param {CartPlatformApplicationValidator.GetPromosCouponConfigParam} arg
|
|
312
343
|
* - Arg object
|
|
313
344
|
*
|
|
345
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
314
346
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
315
347
|
* @returns {Promise<CartPlatformModel.ActivePromosResponse>} - Success response
|
|
316
348
|
* @name getPromosCouponConfig
|
|
317
349
|
* @summary: Fetch all promos that are set as active
|
|
318
350
|
* @description: Use this API to get list of all the active promos/coupons. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromosCouponConfig/).
|
|
319
351
|
*/
|
|
320
|
-
getPromosCouponConfig({ entityType, isHidden }?: CartPlatformApplicationValidator.GetPromosCouponConfigParam, {
|
|
352
|
+
getPromosCouponConfig({ entityType, isHidden, requestHeaders }?: CartPlatformApplicationValidator.GetPromosCouponConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.ActivePromosResponse>;
|
|
321
353
|
/**
|
|
322
354
|
* @param {CartPlatformApplicationValidator.GetPromotionByIdParam} arg - Arg object
|
|
355
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
323
356
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
324
357
|
* @returns {Promise<CartPlatformModel.PromotionUpdate>} - Success response
|
|
325
358
|
* @name getPromotionById
|
|
326
359
|
* @summary: Get with single promotion details or promotion list
|
|
327
360
|
* @description: Get single promotion details with `id` in path param - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionById/).
|
|
328
361
|
*/
|
|
329
|
-
getPromotionById({ id }?: CartPlatformApplicationValidator.GetPromotionByIdParam, {
|
|
362
|
+
getPromotionById({ id, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionByIdParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionUpdate>;
|
|
330
363
|
/**
|
|
331
364
|
* @param {CartPlatformApplicationValidator.GetPromotionCodeExistsParam} arg
|
|
332
365
|
* - Arg object
|
|
333
366
|
*
|
|
367
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
334
368
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
335
369
|
* @returns {Promise<Object>} - Success response
|
|
336
370
|
* @name getPromotionCodeExists
|
|
337
371
|
* @summary: Check if promotion is already created with promotion code
|
|
338
372
|
* @description: Check if sent promotion code is already existing promotion code. As promotion code is to be unique. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionCodeExists/).
|
|
339
373
|
*/
|
|
340
|
-
getPromotionCodeExists({ code }?: CartPlatformApplicationValidator.GetPromotionCodeExistsParam, {
|
|
374
|
+
getPromotionCodeExists({ code, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionCodeExistsParam, { responseHeaders }?: object): Promise<any>;
|
|
341
375
|
/**
|
|
342
376
|
* @param {CartPlatformApplicationValidator.GetPromotionsParam} arg - Arg object
|
|
377
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
343
378
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
344
379
|
* @returns {Promise<CartPlatformModel.PromotionsResponse>} - Success response
|
|
345
380
|
* @name getPromotions
|
|
346
381
|
* @summary: Get promotion list
|
|
347
382
|
* @description: Get promotion list with pagination - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotions/).
|
|
348
383
|
*/
|
|
349
|
-
getPromotions({ pageNo, pageSize, q, isActive, promoGroup, promotionType, fpPanel, promotionId, }?: CartPlatformApplicationValidator.GetPromotionsParam, {
|
|
384
|
+
getPromotions({ pageNo, pageSize, q, isActive, promoGroup, promotionType, fpPanel, promotionId, requestHeaders, }?: CartPlatformApplicationValidator.GetPromotionsParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionsResponse>;
|
|
350
385
|
/**
|
|
351
386
|
* @param {Object} arg - Arg object.
|
|
352
387
|
* @param {string} arg.companyId - Current company id
|
|
@@ -375,6 +410,7 @@ declare class Cart {
|
|
|
375
410
|
}): Paginator<CartPlatformModel.PromotionsResponse>;
|
|
376
411
|
/**
|
|
377
412
|
* @param {CartPlatformApplicationValidator.GetShipmentsParam} arg - Arg object
|
|
413
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
378
414
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
379
415
|
* @returns {Promise<CartPlatformModel.PlatformCartShipmentsResponse>} -
|
|
380
416
|
* Success response
|
|
@@ -382,234 +418,258 @@ declare class Cart {
|
|
|
382
418
|
* @summary: Get delivery date and options before checkout
|
|
383
419
|
* @description: Use this API to get shipment details, expected delivery date, items and price breakup of the shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getShipments/).
|
|
384
420
|
*/
|
|
385
|
-
getShipments({ pickAtStoreUid, orderingStoreId, i, p, id, addressId, areaCode, orderType, }?: CartPlatformApplicationValidator.GetShipmentsParam, {
|
|
421
|
+
getShipments({ pickAtStoreUid, orderingStoreId, i, p, id, addressId, areaCode, orderType, requestHeaders, }?: CartPlatformApplicationValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformCartShipmentsResponse>;
|
|
386
422
|
/**
|
|
387
423
|
* @param {CartPlatformApplicationValidator.GetStoreAddressByUidParam} arg
|
|
388
424
|
* - Arg object
|
|
389
425
|
*
|
|
426
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
390
427
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
391
428
|
* @returns {Promise<CartPlatformModel.StoreDetailsResponse>} - Success response
|
|
392
429
|
* @name getStoreAddressByUid
|
|
393
430
|
* @summary: Get list of stores for give uids
|
|
394
431
|
* @description: Use this API to get the store details by entering the unique identifier of the pickup stores shown in the response of available-delivery-mode API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getStoreAddressByUid/).
|
|
395
432
|
*/
|
|
396
|
-
getStoreAddressByUid({ storeUid }?: CartPlatformApplicationValidator.GetStoreAddressByUidParam, {
|
|
433
|
+
getStoreAddressByUid({ storeUid, requestHeaders }?: CartPlatformApplicationValidator.GetStoreAddressByUidParam, { responseHeaders }?: object): Promise<CartPlatformModel.StoreDetailsResponse>;
|
|
397
434
|
/**
|
|
398
435
|
* @param {CartPlatformApplicationValidator.OverrideCartParam} arg - Arg object
|
|
436
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
399
437
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
400
438
|
* @returns {Promise<CartPlatformModel.OverrideCheckoutResponse>} - Success response
|
|
401
439
|
* @name overrideCart
|
|
402
440
|
* @summary: Create Fynd order with overriding cart details
|
|
403
441
|
* @description: Generate Fynd order while overriding cart details sent with provided `cart_items` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/overrideCart/).
|
|
404
442
|
*/
|
|
405
|
-
overrideCart({ body }?: CartPlatformApplicationValidator.OverrideCartParam, {
|
|
443
|
+
overrideCart({ body, requestHeaders }?: CartPlatformApplicationValidator.OverrideCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.OverrideCheckoutResponse>;
|
|
406
444
|
/**
|
|
407
445
|
* @param {CartPlatformApplicationValidator.PlatformAddItemsParam} arg - Arg object
|
|
446
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
408
447
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
409
448
|
* @returns {Promise<CartPlatformModel.AddCartDetailResponse>} - Success response
|
|
410
449
|
* @name platformAddItems
|
|
411
450
|
* @summary: Add items to cart
|
|
412
451
|
* @description: Use this API to add items to the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformAddItems/).
|
|
413
452
|
*/
|
|
414
|
-
platformAddItems({ body, i, b, buyNow, id }?: CartPlatformApplicationValidator.PlatformAddItemsParam, {
|
|
453
|
+
platformAddItems({ body, i, b, buyNow, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformAddItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.AddCartDetailResponse>;
|
|
415
454
|
/**
|
|
416
455
|
* @param {CartPlatformApplicationValidator.PlatformCheckoutCartParam} arg
|
|
417
456
|
* - Arg object
|
|
418
457
|
*
|
|
458
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
419
459
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
420
460
|
* @returns {Promise<CartPlatformModel.CartCheckoutResponse>} - Success response
|
|
421
461
|
* @name platformCheckoutCart
|
|
422
462
|
* @summary: Checkout all items in the cart
|
|
423
463
|
* @description: Use this API to checkout all items in the cart for payment and order generation. For COD, order will be generated directly, whereas for other checkout modes, user will be redirected to a payment gateway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCart/).
|
|
424
464
|
*/
|
|
425
|
-
platformCheckoutCart({ body, id }?: CartPlatformApplicationValidator.PlatformCheckoutCartParam, {
|
|
465
|
+
platformCheckoutCart({ body, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformCheckoutCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartCheckoutResponse>;
|
|
426
466
|
/**
|
|
427
467
|
* @param {CartPlatformApplicationValidator.PlatformCheckoutCartV2Param} arg
|
|
428
468
|
* - Arg object
|
|
429
469
|
*
|
|
470
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
430
471
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
431
472
|
* @returns {Promise<CartPlatformModel.CartCheckoutResponse>} - Success response
|
|
432
473
|
* @name platformCheckoutCartV2
|
|
433
474
|
* @summary: Checkout all items in the cart
|
|
434
475
|
* @description: Use this API to checkout all items in the cart for payment and order generation. For COD, order will be directly generated, whereas for other checkout modes, user will be redirected to a payment gateway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCartV2/).
|
|
435
476
|
*/
|
|
436
|
-
platformCheckoutCartV2({ body, id }?: CartPlatformApplicationValidator.PlatformCheckoutCartV2Param, {
|
|
477
|
+
platformCheckoutCartV2({ body, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformCheckoutCartV2Param, { responseHeaders }?: object): Promise<CartPlatformModel.CartCheckoutResponse>;
|
|
437
478
|
/**
|
|
438
479
|
* @param {CartPlatformApplicationValidator.PlatformUpdateCartParam} arg - Arg object
|
|
480
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
439
481
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
440
482
|
* @returns {Promise<CartPlatformModel.UpdateCartDetailResponse>} - Success response
|
|
441
483
|
* @name platformUpdateCart
|
|
442
484
|
* @summary: Update items in the customer 's cart using cart id
|
|
443
|
-
* @description:
|
|
485
|
+
* @description: Use this API to update items added to the cart with the help of a request object containing attributes like item_quantity and item_size. These attributes will be fetched from the following APIs operation Operation for current api call. update_item for update items. remove_item for removing items.item_id "/platform/content/v1/products/" item_size "/platform/content/v1/products/:slug/sizes/" quantity item quantity (must be greater than or equal to 1) article_id "/content/v1/products/:identifier/sizes/price/" item_index item position in the cart (must be greater than or equal to 0) - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformUpdateCart/).
|
|
444
486
|
*/
|
|
445
|
-
platformUpdateCart({ body, id, i, b, buyNow }?: CartPlatformApplicationValidator.PlatformUpdateCartParam, {
|
|
487
|
+
platformUpdateCart({ body, id, i, b, buyNow, requestHeaders }?: CartPlatformApplicationValidator.PlatformUpdateCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdateCartDetailResponse>;
|
|
446
488
|
/**
|
|
447
489
|
* @param {CartPlatformApplicationValidator.RemoveAddressParam} arg - Arg object
|
|
490
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
448
491
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
449
492
|
* @returns {Promise<CartPlatformModel.DeleteAddressResponse>} - Success response
|
|
450
493
|
* @name removeAddress
|
|
451
494
|
* @summary: Remove address associated with an account
|
|
452
495
|
* @description: Use this API to delete an address by its ID. This will returns an object that will indicate whether the address was deleted successfully or not. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removeAddress/).
|
|
453
496
|
*/
|
|
454
|
-
removeAddress({ id, userId }?: CartPlatformApplicationValidator.RemoveAddressParam, {
|
|
497
|
+
removeAddress({ id, userId, requestHeaders }?: CartPlatformApplicationValidator.RemoveAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.DeleteAddressResponse>;
|
|
455
498
|
/**
|
|
456
499
|
* @param {CartPlatformApplicationValidator.RemoveCouponParam} arg - Arg object
|
|
500
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
457
501
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
458
502
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
459
503
|
* @name removeCoupon
|
|
460
504
|
* @summary: Remove Applied Coupon for platform pos user
|
|
461
505
|
* @description: Remove Coupon applied on the cart by passing uid in request body. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removeCoupon/).
|
|
462
506
|
*/
|
|
463
|
-
removeCoupon({ uid, buyNow }?: CartPlatformApplicationValidator.RemoveCouponParam, {
|
|
507
|
+
removeCoupon({ uid, buyNow, requestHeaders }?: CartPlatformApplicationValidator.RemoveCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
464
508
|
/**
|
|
465
509
|
* @param {CartPlatformApplicationValidator.RemovePriceAdjustmentParam} arg
|
|
466
510
|
* - Arg object
|
|
467
511
|
*
|
|
512
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
468
513
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
469
514
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
470
515
|
* @name removePriceAdjustment
|
|
471
516
|
* @summary: Remove price adjustment
|
|
472
517
|
* @description: Remove price adjustment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removePriceAdjustment/).
|
|
473
518
|
*/
|
|
474
|
-
removePriceAdjustment({ id }?: CartPlatformApplicationValidator.RemovePriceAdjustmentParam, {
|
|
519
|
+
removePriceAdjustment({ id, requestHeaders }?: CartPlatformApplicationValidator.RemovePriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
475
520
|
/**
|
|
476
521
|
* @param {CartPlatformApplicationValidator.SelectAddressParam} arg - Arg object
|
|
522
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
477
523
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
478
524
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
479
525
|
* @name selectAddress
|
|
480
526
|
* @summary: Select an address from available addresses
|
|
481
|
-
* @description:
|
|
527
|
+
* @description: Select Address from all addresses associated with the account in order to ship the cart items to that address, otherwise default address will be selected implicitly. See `PlatformSelectCartAddressRequest` in schema of request body for the list of attributes needed to select Address from account. On successful request, this API returns a Cart object. Below address attributes are required. address_id billing_address_id uid - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/selectAddress/).
|
|
482
528
|
*/
|
|
483
|
-
selectAddress({ body, cartId, buyNow, i, b }?: CartPlatformApplicationValidator.SelectAddressParam, {
|
|
529
|
+
selectAddress({ body, cartId, buyNow, i, b, requestHeaders }?: CartPlatformApplicationValidator.SelectAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
484
530
|
/**
|
|
485
531
|
* @param {CartPlatformApplicationValidator.SelectPaymentModeParam} arg - Arg object
|
|
532
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
486
533
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
487
534
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
488
535
|
* @name selectPaymentMode
|
|
489
536
|
* @summary: Update cart payment
|
|
490
537
|
* @description: Use this API to update cart payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/selectPaymentMode/).
|
|
491
538
|
*/
|
|
492
|
-
selectPaymentMode({ body, id, buyNow, orderType }?: CartPlatformApplicationValidator.SelectPaymentModeParam, {
|
|
539
|
+
selectPaymentMode({ body, id, buyNow, orderType, requestHeaders }?: CartPlatformApplicationValidator.SelectPaymentModeParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
493
540
|
/**
|
|
494
541
|
* @param {CartPlatformApplicationValidator.SelectPaymentModeV2Param} arg - Arg object
|
|
542
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
495
543
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
496
544
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
497
545
|
* @name selectPaymentModeV2
|
|
498
546
|
* @summary: Update cart payment
|
|
499
547
|
* @description: Use this API to update cart payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/selectPaymentModeV2/).
|
|
500
548
|
*/
|
|
501
|
-
selectPaymentModeV2({ body, id, buyNow, orderType }?: CartPlatformApplicationValidator.SelectPaymentModeV2Param, {
|
|
549
|
+
selectPaymentModeV2({ body, id, buyNow, orderType, requestHeaders }?: CartPlatformApplicationValidator.SelectPaymentModeV2Param, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
502
550
|
/**
|
|
503
551
|
* @param {CartPlatformApplicationValidator.UpdateAddressParam} arg - Arg object
|
|
552
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
504
553
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
505
554
|
* @returns {Promise<CartPlatformModel.UpdateAddressResponse>} - Success response
|
|
506
555
|
* @name updateAddress
|
|
507
556
|
* @summary: Update address added to an account
|
|
508
|
-
* @description:
|
|
557
|
+
* @description: Use this API to update an existing address in the account. Request object should contain attributes mentioned in Address can be updated. These attributes are:is_default_address landmark area pincode email address_type name address_id address - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateAddress/).
|
|
509
558
|
*/
|
|
510
|
-
updateAddress({ id, body }?: CartPlatformApplicationValidator.UpdateAddressParam, {
|
|
559
|
+
updateAddress({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdateAddressResponse>;
|
|
511
560
|
/**
|
|
512
561
|
* @param {CartPlatformApplicationValidator.UpdateCartParam} arg - Arg object
|
|
562
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
513
563
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
514
564
|
* @returns {Promise<CartPlatformModel.UpdateCartDetailResponse>} - Success response
|
|
515
565
|
* @name updateCart
|
|
516
566
|
* @summary: Update items in the abandoned cart
|
|
517
|
-
* @description:
|
|
567
|
+
* @description: Use this API to update items added to the cart with the help of a request object containing attributes like item_quantity and item_size. These attributes will be fetched from the following APIs operation Operation for current api call.update_item for update items. remove_item for removing items. item_id "/platform/content/v1/products/" "/platform/content/v1/products/:slug/sizes/" quantity item quantity (must be greater than or equal to 1) article_id "/content/v1/products/:identifier/sizes/price/" item position in the cart (must be greater than or equal to 0) - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCart/).
|
|
518
568
|
*/
|
|
519
|
-
updateCart({ cartId, body, b }?: CartPlatformApplicationValidator.UpdateCartParam, {
|
|
569
|
+
updateCart({ cartId, body, b, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdateCartDetailResponse>;
|
|
520
570
|
/**
|
|
521
571
|
* @param {CartPlatformApplicationValidator.UpdateCartMetaParam} arg - Arg object
|
|
572
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
522
573
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
523
574
|
* @returns {Promise<CartPlatformModel.CartMetaResponse>} - Success response
|
|
524
575
|
* @name updateCartMeta
|
|
525
576
|
* @summary: Update the cart meta for platform pos user
|
|
526
577
|
* @description: Use this API to update cart meta like checkout_mode and gstin. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartMeta/).
|
|
527
578
|
*/
|
|
528
|
-
updateCartMeta({ body, id, buyNow }?: CartPlatformApplicationValidator.UpdateCartMetaParam, {
|
|
579
|
+
updateCartMeta({ body, id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartMetaParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaResponse>;
|
|
529
580
|
/**
|
|
530
581
|
* @param {CartPlatformApplicationValidator.UpdateCartMetaConfigParam} arg
|
|
531
582
|
* - Arg object
|
|
532
583
|
*
|
|
584
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
533
585
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
534
586
|
* @returns {Promise<CartPlatformModel.CartMetaConfigUpdate>} - Success response
|
|
535
587
|
* @name updateCartMetaConfig
|
|
536
588
|
* @summary: Update cart meta configuration
|
|
537
589
|
* @description: Update cart meta configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartMetaConfig/).
|
|
538
590
|
*/
|
|
539
|
-
updateCartMetaConfig({ cartMetaId, body }?: CartPlatformApplicationValidator.UpdateCartMetaConfigParam, {
|
|
591
|
+
updateCartMetaConfig({ cartMetaId, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartMetaConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaConfigUpdate>;
|
|
540
592
|
/**
|
|
541
593
|
* @param {CartPlatformApplicationValidator.UpdateCartUserParam} arg - Arg object
|
|
594
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
542
595
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
543
596
|
* @returns {Promise<CartPlatformModel.UserCartMappingResponse>} - Success response
|
|
544
597
|
* @name updateCartUser
|
|
545
598
|
* @summary: Update user id for store os customer
|
|
546
599
|
* @description: Update user id for store os customer after creating customer - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartUser/).
|
|
547
600
|
*/
|
|
548
|
-
updateCartUser({ body, id }?: CartPlatformApplicationValidator.UpdateCartUserParam, {
|
|
601
|
+
updateCartUser({ body, id, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartUserParam, { responseHeaders }?: object): Promise<CartPlatformModel.UserCartMappingResponse>;
|
|
549
602
|
/**
|
|
550
603
|
* @param {CartPlatformApplicationValidator.UpdateCartWithSharedItemsParam} arg
|
|
551
604
|
* - Arg object
|
|
552
605
|
*
|
|
606
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
553
607
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
554
608
|
* @returns {Promise<CartPlatformModel.SharedCartResponse>} - Success response
|
|
555
609
|
* @name updateCartWithSharedItems
|
|
556
610
|
* @summary: Merge or replace existing cart
|
|
557
611
|
* @description: Use this API to merge the shared cart with existing cart, or replace the existing cart with the shared cart. The `action` parameter is used to indicate the operation Merge or Replace. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartWithSharedItems/).
|
|
558
612
|
*/
|
|
559
|
-
updateCartWithSharedItems({ token, action, cartId }?: CartPlatformApplicationValidator.UpdateCartWithSharedItemsParam, {
|
|
613
|
+
updateCartWithSharedItems({ token, action, cartId, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartWithSharedItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.SharedCartResponse>;
|
|
560
614
|
/**
|
|
561
615
|
* @param {CartPlatformApplicationValidator.UpdateCouponParam} arg - Arg object
|
|
616
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
562
617
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
563
618
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
564
619
|
* @name updateCoupon
|
|
565
620
|
* @summary: Update existing coupon configuration
|
|
566
621
|
* @description: Update coupon with id sent in `id` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCoupon/).
|
|
567
622
|
*/
|
|
568
|
-
updateCoupon({ id, body }?: CartPlatformApplicationValidator.UpdateCouponParam, {
|
|
623
|
+
updateCoupon({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
569
624
|
/**
|
|
570
625
|
* @param {CartPlatformApplicationValidator.UpdateCouponPartiallyParam} arg
|
|
571
626
|
* - Arg object
|
|
572
627
|
*
|
|
628
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
573
629
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
574
630
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
575
631
|
* @name updateCouponPartially
|
|
576
632
|
* @summary: Update coupon archive state and schedule
|
|
577
633
|
* @description: Update archive/unarchive and change schedule for coupon - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCouponPartially/).
|
|
578
634
|
*/
|
|
579
|
-
updateCouponPartially({ id, body }?: CartPlatformApplicationValidator.UpdateCouponPartiallyParam, {
|
|
635
|
+
updateCouponPartially({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCouponPartiallyParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
580
636
|
/**
|
|
581
637
|
* @param {CartPlatformApplicationValidator.UpdatePriceAdjustmentParam} arg
|
|
582
638
|
* - Arg object
|
|
583
639
|
*
|
|
640
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
584
641
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
585
642
|
* @returns {Promise<CartPlatformModel.PriceAdjustmentResponse>} - Success response
|
|
586
643
|
* @name updatePriceAdjustment
|
|
587
644
|
* @summary: Update price adjustment configuration
|
|
588
645
|
* @description: Update price adjustment configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePriceAdjustment/).
|
|
589
646
|
*/
|
|
590
|
-
updatePriceAdjustment({ id, body }?: CartPlatformApplicationValidator.UpdatePriceAdjustmentParam, {
|
|
647
|
+
updatePriceAdjustment({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.PriceAdjustmentResponse>;
|
|
591
648
|
/**
|
|
592
649
|
* @param {CartPlatformApplicationValidator.UpdatePromotionParam} arg - Arg object
|
|
650
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
593
651
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
594
652
|
* @returns {Promise<CartPlatformModel.PromotionUpdate>} - Success response
|
|
595
653
|
* @name updatePromotion
|
|
596
654
|
* @summary: Update existing promotion configuration
|
|
597
655
|
* @description: Update promotion with id sent in `id` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePromotion/).
|
|
598
656
|
*/
|
|
599
|
-
updatePromotion({ id, body }?: CartPlatformApplicationValidator.UpdatePromotionParam, {
|
|
657
|
+
updatePromotion({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePromotionParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionUpdate>;
|
|
600
658
|
/**
|
|
601
659
|
* @param {CartPlatformApplicationValidator.UpdatePromotionPartiallyParam} arg
|
|
602
660
|
* - Arg object
|
|
603
661
|
*
|
|
662
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
604
663
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
605
664
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
606
665
|
* @name updatePromotionPartially
|
|
607
666
|
* @summary: Update promotion publish state and schedule
|
|
608
667
|
* @description: Update publish/unpublish and change schedule for promotion - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePromotionPartially/).
|
|
609
668
|
*/
|
|
610
|
-
updatePromotionPartially({ id, body }?: CartPlatformApplicationValidator.UpdatePromotionPartiallyParam, {
|
|
669
|
+
updatePromotionPartially({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePromotionPartiallyParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
611
670
|
/**
|
|
612
671
|
* @param {CartPlatformApplicationValidator.UpdateShipmentsParam} arg - Arg object
|
|
672
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
613
673
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
614
674
|
* @returns {Promise<CartPlatformModel.PlatformCartShipmentsResponse>} -
|
|
615
675
|
* Success response
|
|
@@ -617,18 +677,19 @@ declare class Cart {
|
|
|
617
677
|
* @summary: Update shipment delivery type and quantity before checkout
|
|
618
678
|
* @description: Use this API to update the delivery type and quantity as per customer's preference for either store pick-up or home-delivery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateShipments/).
|
|
619
679
|
*/
|
|
620
|
-
updateShipments({ body, i, p, id, addressId, areaCode, orderType }?: CartPlatformApplicationValidator.UpdateShipmentsParam, {
|
|
680
|
+
updateShipments({ body, i, p, id, addressId, areaCode, orderType, requestHeaders }?: CartPlatformApplicationValidator.UpdateShipmentsParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformCartShipmentsResponse>;
|
|
621
681
|
/**
|
|
622
682
|
* @param {CartPlatformApplicationValidator.ValidateCouponForPaymentParam} arg
|
|
623
683
|
* - Arg object
|
|
624
684
|
*
|
|
685
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
625
686
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
626
687
|
* @returns {Promise<CartPlatformModel.PaymentCouponValidate>} - Success response
|
|
627
688
|
* @name validateCouponForPayment
|
|
628
689
|
* @summary: Verify the coupon eligibility against the payment mode
|
|
629
690
|
* @description: Use this API to validate a coupon against the payment mode such as NetBanking, Wallet, UPI etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/validateCouponForPayment/).
|
|
630
691
|
*/
|
|
631
|
-
validateCouponForPayment({ id, buyNow, addressId, paymentMode, paymentIdentifier, aggregatorName, merchantCode, }?: CartPlatformApplicationValidator.ValidateCouponForPaymentParam, {
|
|
692
|
+
validateCouponForPayment({ id, buyNow, addressId, paymentMode, paymentIdentifier, aggregatorName, merchantCode, requestHeaders, }?: CartPlatformApplicationValidator.ValidateCouponForPaymentParam, { responseHeaders }?: object): Promise<CartPlatformModel.PaymentCouponValidate>;
|
|
632
693
|
}
|
|
633
694
|
import CartPlatformApplicationValidator = require("./CartPlatformApplicationValidator");
|
|
634
695
|
import CartPlatformModel = require("./CartPlatformModel");
|