@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.6
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 +3 -2
- package/sdk/application/ApplicationClient.js +20 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
- package/sdk/application/Cart/CartApplicationClient.js +82 -71
- package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
- package/sdk/application/Cart/CartApplicationValidator.js +59 -34
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
- package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
- package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
- package/sdk/application/Content/ContentApplicationClient.js +34 -115
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
- package/sdk/application/Lead/LeadApplicationClient.js +14 -14
- package/sdk/application/Lead/LeadApplicationModel.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
- package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
- package/sdk/application/Order/OrderApplicationClient.js +24 -24
- package/sdk/application/Order/OrderApplicationModel.d.ts +23 -1
- package/sdk/application/Order/OrderApplicationModel.js +28 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
- package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +498 -3
- package/sdk/application/Payment/PaymentApplicationModel.js +316 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
- package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
- package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Share/ShareApplicationModel.d.ts +0 -4
- package/sdk/application/Share/ShareApplicationModel.js +0 -4
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +64 -64
- package/sdk/application/User/UserApplicationClient.js +64 -64
- package/sdk/common/Clickstream.d.ts +1 -0
- package/sdk/common/Clickstream.js +246 -0
- package/sdk/common/Utility.js +1 -4
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
- package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
- package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
- package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
- package/sdk/platform/Cart/CartPlatformModel.js +12 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +195 -108
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
- package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -3
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
- package/sdk/platform/Common/CommonPlatformClient.js +3 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
- package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformClient.js +7 -7
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
- package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +20 -56
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +20 -59
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +0 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +0 -2
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -16
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
- package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
- package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
- package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
- package/sdk/platform/Order/OrderPlatformClient.js +79 -294
- package/sdk/platform/Order/OrderPlatformModel.d.ts +32 -3
- package/sdk/platform/Order/OrderPlatformModel.js +34 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +5 -5
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +4 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
- package/sdk/platform/Share/SharePlatformModel.d.ts +0 -4
- package/sdk/platform/Share/SharePlatformModel.js +0 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
- package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
- package/sdk/platform/User/UserPlatformModel.d.ts +4 -4
- package/sdk/platform/User/UserPlatformModel.js +4 -4
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
- package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
- package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
|
@@ -9,8 +9,8 @@ declare class Cart {
|
|
|
9
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
10
|
* @returns {Promise<CartPlatformModel.SaveAddressResponse>} - Success response
|
|
11
11
|
* @name addAddress
|
|
12
|
-
* @summary: Add
|
|
13
|
-
* @description:
|
|
12
|
+
* @summary: Add a new user address.
|
|
13
|
+
* @description: Create and add a new user address for cart checkout. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addAddress/).
|
|
14
14
|
*/
|
|
15
15
|
addAddress({ body, requestHeaders }?: CartPlatformApplicationValidator.AddAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.SaveAddressResponse>;
|
|
16
16
|
/**
|
|
@@ -19,8 +19,8 @@ declare class Cart {
|
|
|
19
19
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
20
|
* @returns {Promise<CartPlatformModel.AddCartDetailResponse>} - Success response
|
|
21
21
|
* @name addItems
|
|
22
|
-
* @summary: Add items to
|
|
23
|
-
* @description:
|
|
22
|
+
* @summary: Add items to the cart.
|
|
23
|
+
* @description: Add items to the shopping cart - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addItems/).
|
|
24
24
|
*/
|
|
25
25
|
addItems({ cartId, body, b, requestHeaders }?: CartPlatformApplicationValidator.AddItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.AddCartDetailResponse>;
|
|
26
26
|
/**
|
|
@@ -29,8 +29,8 @@ declare class Cart {
|
|
|
29
29
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
30
30
|
* @returns {Promise<CartPlatformModel.PriceAdjustmentResponse>} - Success response
|
|
31
31
|
* @name addPriceAdjustment
|
|
32
|
-
* @summary:
|
|
33
|
-
* @description:
|
|
32
|
+
* @summary: Add price adjustments.
|
|
33
|
+
* @description: Apply price adjustments to items in the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addPriceAdjustment/).
|
|
34
34
|
*/
|
|
35
35
|
addPriceAdjustment({ body, requestHeaders }?: CartPlatformApplicationValidator.AddPriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.PriceAdjustmentResponse>;
|
|
36
36
|
/**
|
|
@@ -39,8 +39,8 @@ declare class Cart {
|
|
|
39
39
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
40
40
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
41
41
|
* @name applyCoupon
|
|
42
|
-
* @summary: Apply
|
|
43
|
-
* @description:
|
|
42
|
+
* @summary: Apply a coupon to the cart.
|
|
43
|
+
* @description: Apply a selected coupon to the items in the shopping cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/applyCoupon/).
|
|
44
44
|
*/
|
|
45
45
|
applyCoupon({ body, i, b, p, id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.ApplyCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
46
46
|
/**
|
|
@@ -53,8 +53,8 @@ declare class Cart {
|
|
|
53
53
|
* - Success response
|
|
54
54
|
*
|
|
55
55
|
* @name checkCartServiceability
|
|
56
|
-
* @summary: Check
|
|
57
|
-
* @description:
|
|
56
|
+
* @summary: Check cart serviceability.
|
|
57
|
+
* @description: Verify if the items in the cart are serviceable. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/checkCartServiceability/).
|
|
58
58
|
*/
|
|
59
59
|
checkCartServiceability({ body, requestHeaders }?: CartPlatformApplicationValidator.CheckCartServiceabilityParam, { responseHeaders }?: object): Promise<CartPlatformModel.OpenApiCartServiceabilityResponse>;
|
|
60
60
|
/**
|
|
@@ -63,8 +63,8 @@ declare class Cart {
|
|
|
63
63
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
64
64
|
* @returns {Promise<CartPlatformModel.OpenApiCheckoutResponse>} - Success response
|
|
65
65
|
* @name checkoutCart
|
|
66
|
-
* @summary:
|
|
67
|
-
* @description:
|
|
66
|
+
* @summary: Proceed to cart checkout.
|
|
67
|
+
* @description: Initiate the checkout process for the items in the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/checkoutCart/).
|
|
68
68
|
*/
|
|
69
69
|
checkoutCart({ body, requestHeaders }?: CartPlatformApplicationValidator.CheckoutCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.OpenApiCheckoutResponse>;
|
|
70
70
|
/**
|
|
@@ -85,8 +85,8 @@ declare class Cart {
|
|
|
85
85
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
86
86
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
87
87
|
* @name createCoupon
|
|
88
|
-
* @summary: Create new coupon
|
|
89
|
-
* @description:
|
|
88
|
+
* @summary: Create a new coupon.
|
|
89
|
+
* @description: Generate and add a new coupon to the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/createCoupon/).
|
|
90
90
|
*/
|
|
91
91
|
createCoupon({ body, requestHeaders }?: CartPlatformApplicationValidator.CreateCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
92
92
|
/**
|
|
@@ -95,8 +95,8 @@ declare class Cart {
|
|
|
95
95
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
96
96
|
* @returns {Promise<CartPlatformModel.PromotionAdd>} - Success response
|
|
97
97
|
* @name createPromotion
|
|
98
|
-
* @summary: Create new promotion
|
|
99
|
-
* @description:
|
|
98
|
+
* @summary: Create a new promotion.
|
|
99
|
+
* @description: Generate and add a new promotion to the cart system - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/createPromotion/).
|
|
100
100
|
*/
|
|
101
101
|
createPromotion({ body, requestHeaders }?: CartPlatformApplicationValidator.CreatePromotionParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionAdd>;
|
|
102
102
|
/**
|
|
@@ -105,8 +105,8 @@ declare class Cart {
|
|
|
105
105
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
106
106
|
* @returns {Promise<CartPlatformModel.DeleteCartDetailResponse>} - Success response
|
|
107
107
|
* @name deleteCart
|
|
108
|
-
* @summary: Delete cart
|
|
109
|
-
* @description:
|
|
108
|
+
* @summary: Delete a cart.
|
|
109
|
+
* @description: Delete a specific shopping cart from the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/deleteCart/).
|
|
110
110
|
*/
|
|
111
111
|
deleteCart({ body, id, requestHeaders }?: CartPlatformApplicationValidator.DeleteCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.DeleteCartDetailResponse>;
|
|
112
112
|
/**
|
|
@@ -117,8 +117,8 @@ declare class Cart {
|
|
|
117
117
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
118
118
|
* @returns {Promise<CartPlatformModel.OpenapiCartDetailsResponse>} - Success response
|
|
119
119
|
* @name fetchAndvalidateCartItems
|
|
120
|
-
* @summary: Fetch
|
|
121
|
-
* @description:
|
|
120
|
+
* @summary: Fetch and validate cart items.
|
|
121
|
+
* @description: Retrieve and validate items currently in the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/fetchAndvalidateCartItems/).
|
|
122
122
|
*/
|
|
123
123
|
fetchAndvalidateCartItems({ body, requestHeaders }?: CartPlatformApplicationValidator.FetchAndvalidateCartItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.OpenapiCartDetailsResponse>;
|
|
124
124
|
/**
|
|
@@ -137,34 +137,10 @@ declare class Cart {
|
|
|
137
137
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
138
138
|
* @returns {Promise<CartPlatformModel.AbandonedCartResponse>} - Success response
|
|
139
139
|
* @name getAbandonedCart
|
|
140
|
-
* @summary:
|
|
141
|
-
* @description:
|
|
140
|
+
* @summary: Retrieve abandoned carts.
|
|
141
|
+
* @description: Retrieve abandoned carts for analysis and potential recovery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAbandonedCart/).
|
|
142
142
|
*/
|
|
143
143
|
getAbandonedCart({ pageNo, pageSize, fromDate, toDate, anonymousCart, lastId, sortOn, requestHeaders, }?: CartPlatformApplicationValidator.GetAbandonedCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.AbandonedCartResponse>;
|
|
144
|
-
/**
|
|
145
|
-
* @param {Object} arg - Arg object.
|
|
146
|
-
* @param {string} arg.companyId - Current company id
|
|
147
|
-
* @param {string} arg.applicationId - Current Application _id
|
|
148
|
-
* @param {number} [arg.pageSize] -
|
|
149
|
-
* @param {string} [arg.fromDate] -
|
|
150
|
-
* @param {string} [arg.toDate] -
|
|
151
|
-
* @param {boolean} [arg.anonymousCart] -
|
|
152
|
-
* @param {string} [arg.lastId] -
|
|
153
|
-
* @param {string} [arg.sortOn] -
|
|
154
|
-
* @returns {Paginator<CartPlatformModel.AbandonedCartResponse>}
|
|
155
|
-
* @summary: Get with abandoned cart list
|
|
156
|
-
* @description: Get abandoned cart list with pagination
|
|
157
|
-
*/
|
|
158
|
-
getAbandonedCartPaginator({ companyId, applicationId, pageSize, fromDate, toDate, anonymousCart, lastId, sortOn, }?: {
|
|
159
|
-
companyId: string;
|
|
160
|
-
applicationId: string;
|
|
161
|
-
pageSize?: number;
|
|
162
|
-
fromDate?: string;
|
|
163
|
-
toDate?: string;
|
|
164
|
-
anonymousCart?: boolean;
|
|
165
|
-
lastId?: string;
|
|
166
|
-
sortOn?: string;
|
|
167
|
-
}): Paginator<CartPlatformModel.AbandonedCartResponse>;
|
|
168
144
|
/**
|
|
169
145
|
* @param {CartPlatformApplicationValidator.GetAbandonedCartDetailsParam} arg
|
|
170
146
|
* - Arg object
|
|
@@ -173,8 +149,8 @@ declare class Cart {
|
|
|
173
149
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
174
150
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
175
151
|
* @name getAbandonedCartDetails
|
|
176
|
-
* @summary:
|
|
177
|
-
* @description:
|
|
152
|
+
* @summary: Get abandoned cart details.
|
|
153
|
+
* @description: Retrieve detailed information about a specific abandoned cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAbandonedCartDetails/).
|
|
178
154
|
*/
|
|
179
155
|
getAbandonedCartDetails({ id, i, b, c, requestHeaders }?: CartPlatformApplicationValidator.GetAbandonedCartDetailsParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
180
156
|
/**
|
|
@@ -204,8 +180,8 @@ declare class Cart {
|
|
|
204
180
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
205
181
|
* @returns {Promise<CartPlatformModel.GetCouponResponse>} - Success response
|
|
206
182
|
* @name getAppCoupons
|
|
207
|
-
* @summary:
|
|
208
|
-
* @description:
|
|
183
|
+
* @summary: Get app-specific coupons.
|
|
184
|
+
* @description: Retrieve coupons specific to the mobile app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAppCoupons/).
|
|
209
185
|
*/
|
|
210
186
|
getAppCoupons({ id, buyNow, slug, storeId, requestHeaders }?: CartPlatformApplicationValidator.GetAppCouponsParam, { responseHeaders }?: object): Promise<CartPlatformModel.GetCouponResponse>;
|
|
211
187
|
/**
|
|
@@ -216,8 +192,8 @@ declare class Cart {
|
|
|
216
192
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
217
193
|
* @returns {Promise<CartPlatformModel.CartDeliveryModesResponse>} - Success response
|
|
218
194
|
* @name getAvailableDeliveryModes
|
|
219
|
-
* @summary: Get available delivery modes
|
|
220
|
-
* @description:
|
|
195
|
+
* @summary: Get available delivery modes.
|
|
196
|
+
* @description: Retrieve a list of available delivery modes for cart checkout. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAvailableDeliveryModes/).
|
|
221
197
|
*/
|
|
222
198
|
getAvailableDeliveryModes({ areaCode, id, requestHeaders }?: CartPlatformApplicationValidator.GetAvailableDeliveryModesParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDeliveryModesResponse>;
|
|
223
199
|
/**
|
|
@@ -226,8 +202,8 @@ declare class Cart {
|
|
|
226
202
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
227
203
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
228
204
|
* @name getCart
|
|
229
|
-
* @summary:
|
|
230
|
-
* @description:
|
|
205
|
+
* @summary: Get cart details.
|
|
206
|
+
* @description: Retrieve detailed information about a shopping cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCart/).
|
|
231
207
|
*/
|
|
232
208
|
getCart({ id, userId, i, b, assignCardId, buyNow, requestHeaders }?: CartPlatformApplicationValidator.GetCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
233
209
|
/**
|
|
@@ -236,8 +212,8 @@ declare class Cart {
|
|
|
236
212
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
237
213
|
* @returns {Promise<CartPlatformModel.MultiCartResponse>} - Success response
|
|
238
214
|
* @name getCartList
|
|
239
|
-
* @summary:
|
|
240
|
-
* @description:
|
|
215
|
+
* @summary: Retrieve a list of carts.
|
|
216
|
+
* @description: Retrieve a list of saved shopping carts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCartList/).
|
|
241
217
|
*/
|
|
242
218
|
getCartList({ fromDate, toDate, filterOn, requestHeaders }?: CartPlatformApplicationValidator.GetCartListParam, { responseHeaders }?: object): Promise<CartPlatformModel.MultiCartResponse>;
|
|
243
219
|
/**
|
|
@@ -256,8 +232,8 @@ declare class Cart {
|
|
|
256
232
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
257
233
|
* @returns {Promise<CartPlatformModel.SharedCartResponse>} - Success response
|
|
258
234
|
* @name getCartSharedItems
|
|
259
|
-
* @summary: Get
|
|
260
|
-
* @description:
|
|
235
|
+
* @summary: Get items shared via a cart link.
|
|
236
|
+
* @description: Retrieve the items shared with you via a cart link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCartSharedItems/).
|
|
261
237
|
*/
|
|
262
238
|
getCartSharedItems({ token, requestHeaders }?: CartPlatformApplicationValidator.GetCartSharedItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.SharedCartResponse>;
|
|
263
239
|
/**
|
|
@@ -266,8 +242,8 @@ declare class Cart {
|
|
|
266
242
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
267
243
|
* @returns {Promise<CartPlatformModel.CouponUpdate>} - Success response
|
|
268
244
|
* @name getCouponById
|
|
269
|
-
* @summary: Get
|
|
270
|
-
* @description:
|
|
245
|
+
* @summary: Get coupon details by ID.
|
|
246
|
+
* @description: Retrieve detailed information about a specific coupon using its unique ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponById/).
|
|
271
247
|
*/
|
|
272
248
|
getCouponById({ id, requestHeaders }?: CartPlatformApplicationValidator.GetCouponByIdParam, { responseHeaders }?: object): Promise<CartPlatformModel.CouponUpdate>;
|
|
273
249
|
/**
|
|
@@ -276,8 +252,8 @@ declare class Cart {
|
|
|
276
252
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
277
253
|
* @returns {Promise<Object>} - Success response
|
|
278
254
|
* @name getCouponCodeExists
|
|
279
|
-
* @summary: Check if
|
|
280
|
-
* @description:
|
|
255
|
+
* @summary: Check if a coupon code exists.
|
|
256
|
+
* @description: Verify the existence of a specific coupon code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponCodeExists/).
|
|
281
257
|
*/
|
|
282
258
|
getCouponCodeExists({ code, requestHeaders }?: CartPlatformApplicationValidator.GetCouponCodeExistsParam, { responseHeaders }?: object): Promise<any>;
|
|
283
259
|
/**
|
|
@@ -288,8 +264,8 @@ declare class Cart {
|
|
|
288
264
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
289
265
|
* @returns {Promise<Object>} - Success response
|
|
290
266
|
* @name getCouponOptionValues
|
|
291
|
-
* @summary: Get coupon
|
|
292
|
-
* @description:
|
|
267
|
+
* @summary: Get coupon option values.
|
|
268
|
+
* @description: Retrieve available values for coupon options. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponOptionValues/).
|
|
293
269
|
*/
|
|
294
270
|
getCouponOptionValues({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
295
271
|
/**
|
|
@@ -298,44 +274,18 @@ declare class Cart {
|
|
|
298
274
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
299
275
|
* @returns {Promise<CartPlatformModel.CouponsResponse>} - Success response
|
|
300
276
|
* @name getCoupons
|
|
301
|
-
* @summary:
|
|
302
|
-
* @description:
|
|
277
|
+
* @summary: Retrieve available coupons.
|
|
278
|
+
* @description: Retrieve a list of available coupons for use in the shopping cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCoupons/).
|
|
303
279
|
*/
|
|
304
280
|
getCoupons({ pageNo, pageSize, isArchived, title, isPublic, isDisplay, typeSlug, code, requestHeaders, }?: CartPlatformApplicationValidator.GetCouponsParam, { responseHeaders }?: object): Promise<CartPlatformModel.CouponsResponse>;
|
|
305
|
-
/**
|
|
306
|
-
* @param {Object} arg - Arg object.
|
|
307
|
-
* @param {string} arg.companyId - Current company id
|
|
308
|
-
* @param {string} arg.applicationId - Current Application _id
|
|
309
|
-
* @param {number} [arg.pageSize] -
|
|
310
|
-
* @param {boolean} [arg.isArchived] -
|
|
311
|
-
* @param {string} [arg.title] -
|
|
312
|
-
* @param {boolean} [arg.isPublic] -
|
|
313
|
-
* @param {boolean} [arg.isDisplay] -
|
|
314
|
-
* @param {string} [arg.typeSlug] -
|
|
315
|
-
* @param {string} [arg.code] -
|
|
316
|
-
* @returns {Paginator<CartPlatformModel.CouponsResponse>}
|
|
317
|
-
* @summary: Get with single coupon details or coupon list
|
|
318
|
-
* @description: Get coupon list with pagination
|
|
319
|
-
*/
|
|
320
|
-
getCouponsPaginator({ companyId, applicationId, pageSize, isArchived, title, isPublic, isDisplay, typeSlug, code, }?: {
|
|
321
|
-
companyId: string;
|
|
322
|
-
applicationId: string;
|
|
323
|
-
pageSize?: number;
|
|
324
|
-
isArchived?: boolean;
|
|
325
|
-
title?: string;
|
|
326
|
-
isPublic?: boolean;
|
|
327
|
-
isDisplay?: boolean;
|
|
328
|
-
typeSlug?: string;
|
|
329
|
-
code?: string;
|
|
330
|
-
}): Paginator<CartPlatformModel.CouponsResponse>;
|
|
331
281
|
/**
|
|
332
282
|
* @param {CartPlatformApplicationValidator.GetItemCountParam} arg - Arg object
|
|
333
283
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
334
284
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
335
285
|
* @returns {Promise<CartPlatformModel.CartItemCountResponse>} - Success response
|
|
336
286
|
* @name getItemCount
|
|
337
|
-
* @summary:
|
|
338
|
-
* @description:
|
|
287
|
+
* @summary: Get the item count in a cart.
|
|
288
|
+
* @description: Retrieve the total number of items in a shopping cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getItemCount/).
|
|
339
289
|
*/
|
|
340
290
|
getItemCount({ id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.GetItemCountParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartItemCountResponse>;
|
|
341
291
|
/**
|
|
@@ -346,8 +296,8 @@ declare class Cart {
|
|
|
346
296
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
347
297
|
* @returns {Promise<CartPlatformModel.ActivePromosResponse>} - Success response
|
|
348
298
|
* @name getPromosCouponConfig
|
|
349
|
-
* @summary:
|
|
350
|
-
* @description:
|
|
299
|
+
* @summary: Get promotion and coupon configuration.
|
|
300
|
+
* @description: Retrieve configuration settings for promotions and coupons. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromosCouponConfig/).
|
|
351
301
|
*/
|
|
352
302
|
getPromosCouponConfig({ entityType, isHidden, requestHeaders }?: CartPlatformApplicationValidator.GetPromosCouponConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.ActivePromosResponse>;
|
|
353
303
|
/**
|
|
@@ -356,8 +306,8 @@ declare class Cart {
|
|
|
356
306
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
357
307
|
* @returns {Promise<CartPlatformModel.PromotionUpdate>} - Success response
|
|
358
308
|
* @name getPromotionById
|
|
359
|
-
* @summary: Get
|
|
360
|
-
* @description:
|
|
309
|
+
* @summary: Get promotion details by ID.
|
|
310
|
+
* @description: Retrieve detailed information about a specific promotion using its unique ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionById/).
|
|
361
311
|
*/
|
|
362
312
|
getPromotionById({ id, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionByIdParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionUpdate>;
|
|
363
313
|
/**
|
|
@@ -368,8 +318,8 @@ declare class Cart {
|
|
|
368
318
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
369
319
|
* @returns {Promise<Object>} - Success response
|
|
370
320
|
* @name getPromotionCodeExists
|
|
371
|
-
* @summary: Check if
|
|
372
|
-
* @description:
|
|
321
|
+
* @summary: Check if a promotion code exists.
|
|
322
|
+
* @description: Verify the existence of a specific promotion code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionCodeExists/).
|
|
373
323
|
*/
|
|
374
324
|
getPromotionCodeExists({ code, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionCodeExistsParam, { responseHeaders }?: object): Promise<any>;
|
|
375
325
|
/**
|
|
@@ -378,36 +328,10 @@ declare class Cart {
|
|
|
378
328
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
379
329
|
* @returns {Promise<CartPlatformModel.PromotionsResponse>} - Success response
|
|
380
330
|
* @name getPromotions
|
|
381
|
-
* @summary:
|
|
382
|
-
* @description:
|
|
331
|
+
* @summary: Retrieve available promotions.
|
|
332
|
+
* @description: Retrieve a list of available promotions to apply to the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotions/).
|
|
383
333
|
*/
|
|
384
334
|
getPromotions({ pageNo, pageSize, q, isActive, promoGroup, promotionType, fpPanel, promotionId, requestHeaders, }?: CartPlatformApplicationValidator.GetPromotionsParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionsResponse>;
|
|
385
|
-
/**
|
|
386
|
-
* @param {Object} arg - Arg object.
|
|
387
|
-
* @param {string} arg.companyId - Current company id
|
|
388
|
-
* @param {string} arg.applicationId - Current Application _id
|
|
389
|
-
* @param {number} [arg.pageSize] -
|
|
390
|
-
* @param {string} [arg.q] -
|
|
391
|
-
* @param {boolean} [arg.isActive] -
|
|
392
|
-
* @param {string} [arg.promoGroup] -
|
|
393
|
-
* @param {string} [arg.promotionType] -
|
|
394
|
-
* @param {string} [arg.fpPanel] -
|
|
395
|
-
* @param {string} [arg.promotionId] -
|
|
396
|
-
* @returns {Paginator<CartPlatformModel.PromotionsResponse>}
|
|
397
|
-
* @summary: Get promotion list
|
|
398
|
-
* @description: Get promotion list with pagination
|
|
399
|
-
*/
|
|
400
|
-
getPromotionsPaginator({ companyId, applicationId, pageSize, q, isActive, promoGroup, promotionType, fpPanel, promotionId, }?: {
|
|
401
|
-
companyId: string;
|
|
402
|
-
applicationId: string;
|
|
403
|
-
pageSize?: number;
|
|
404
|
-
q?: string;
|
|
405
|
-
isActive?: boolean;
|
|
406
|
-
promoGroup?: string;
|
|
407
|
-
promotionType?: string;
|
|
408
|
-
fpPanel?: string;
|
|
409
|
-
promotionId?: string;
|
|
410
|
-
}): Paginator<CartPlatformModel.PromotionsResponse>;
|
|
411
335
|
/**
|
|
412
336
|
* @param {CartPlatformApplicationValidator.GetShipmentsParam} arg - Arg object
|
|
413
337
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -427,8 +351,8 @@ declare class Cart {
|
|
|
427
351
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
428
352
|
* @returns {Promise<CartPlatformModel.StoreDetailsResponse>} - Success response
|
|
429
353
|
* @name getStoreAddressByUid
|
|
430
|
-
* @summary: Get
|
|
431
|
-
* @description:
|
|
354
|
+
* @summary: Get store address by UID.
|
|
355
|
+
* @description: Retrieve the store address using a unique identifier (UID). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getStoreAddressByUid/).
|
|
432
356
|
*/
|
|
433
357
|
getStoreAddressByUid({ storeUid, requestHeaders }?: CartPlatformApplicationValidator.GetStoreAddressByUidParam, { responseHeaders }?: object): Promise<CartPlatformModel.StoreDetailsResponse>;
|
|
434
358
|
/**
|
|
@@ -437,8 +361,8 @@ declare class Cart {
|
|
|
437
361
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
438
362
|
* @returns {Promise<CartPlatformModel.OverrideCheckoutResponse>} - Success response
|
|
439
363
|
* @name overrideCart
|
|
440
|
-
* @summary:
|
|
441
|
-
* @description:
|
|
364
|
+
* @summary: Override the cart.
|
|
365
|
+
* @description: Override the current cart with a new configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/overrideCart/).
|
|
442
366
|
*/
|
|
443
367
|
overrideCart({ body, requestHeaders }?: CartPlatformApplicationValidator.OverrideCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.OverrideCheckoutResponse>;
|
|
444
368
|
/**
|
|
@@ -447,8 +371,8 @@ declare class Cart {
|
|
|
447
371
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
448
372
|
* @returns {Promise<CartPlatformModel.AddCartDetailResponse>} - Success response
|
|
449
373
|
* @name platformAddItems
|
|
450
|
-
* @summary: Add items
|
|
451
|
-
* @description:
|
|
374
|
+
* @summary: Add items via platform integration.
|
|
375
|
+
* @description: Add items to the cart through platform integration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformAddItems/).
|
|
452
376
|
*/
|
|
453
377
|
platformAddItems({ body, i, b, buyNow, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformAddItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.AddCartDetailResponse>;
|
|
454
378
|
/**
|
|
@@ -459,8 +383,8 @@ declare class Cart {
|
|
|
459
383
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
460
384
|
* @returns {Promise<CartPlatformModel.CartCheckoutResponse>} - Success response
|
|
461
385
|
* @name platformCheckoutCart
|
|
462
|
-
* @summary:
|
|
463
|
-
* @description:
|
|
386
|
+
* @summary: Platform-specific cart checkout.
|
|
387
|
+
* @description: Initiate cart checkout through platform-specific integration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCart/).
|
|
464
388
|
*/
|
|
465
389
|
platformCheckoutCart({ body, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformCheckoutCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartCheckoutResponse>;
|
|
466
390
|
/**
|
|
@@ -471,8 +395,8 @@ declare class Cart {
|
|
|
471
395
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
472
396
|
* @returns {Promise<CartPlatformModel.CartCheckoutResponse>} - Success response
|
|
473
397
|
* @name platformCheckoutCartV2
|
|
474
|
-
* @summary:
|
|
475
|
-
* @description:
|
|
398
|
+
* @summary: Platform-specific cart checkout v2.
|
|
399
|
+
* @description: Initiate cart checkout through an updated platform-specific integration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCartV2/).
|
|
476
400
|
*/
|
|
477
401
|
platformCheckoutCartV2({ body, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformCheckoutCartV2Param, { responseHeaders }?: object): Promise<CartPlatformModel.CartCheckoutResponse>;
|
|
478
402
|
/**
|
|
@@ -491,8 +415,8 @@ declare class Cart {
|
|
|
491
415
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
492
416
|
* @returns {Promise<CartPlatformModel.DeleteAddressResponse>} - Success response
|
|
493
417
|
* @name removeAddress
|
|
494
|
-
* @summary: Remove
|
|
495
|
-
* @description:
|
|
418
|
+
* @summary: Remove a user address.
|
|
419
|
+
* @description: Delete an existing user address from the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removeAddress/).
|
|
496
420
|
*/
|
|
497
421
|
removeAddress({ id, userId, requestHeaders }?: CartPlatformApplicationValidator.RemoveAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.DeleteAddressResponse>;
|
|
498
422
|
/**
|
|
@@ -501,8 +425,8 @@ declare class Cart {
|
|
|
501
425
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
502
426
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
503
427
|
* @name removeCoupon
|
|
504
|
-
* @summary: Remove
|
|
505
|
-
* @description: Remove
|
|
428
|
+
* @summary: Remove a coupon from the cart.
|
|
429
|
+
* @description: Remove a coupon from the items in the shopping cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removeCoupon/).
|
|
506
430
|
*/
|
|
507
431
|
removeCoupon({ uid, buyNow, requestHeaders }?: CartPlatformApplicationValidator.RemoveCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
508
432
|
/**
|
|
@@ -513,8 +437,8 @@ declare class Cart {
|
|
|
513
437
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
514
438
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
515
439
|
* @name removePriceAdjustment
|
|
516
|
-
* @summary: Remove price
|
|
517
|
-
* @description: Remove price
|
|
440
|
+
* @summary: Remove price adjustments.
|
|
441
|
+
* @description: Remove price adjustments applied to items in the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removePriceAdjustment/).
|
|
518
442
|
*/
|
|
519
443
|
removePriceAdjustment({ id, requestHeaders }?: CartPlatformApplicationValidator.RemovePriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
520
444
|
/**
|
|
@@ -533,8 +457,8 @@ declare class Cart {
|
|
|
533
457
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
534
458
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
535
459
|
* @name selectPaymentMode
|
|
536
|
-
* @summary:
|
|
537
|
-
* @description:
|
|
460
|
+
* @summary: Select a payment mode.
|
|
461
|
+
* @description: Choose a payment mode for cart checkout. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/selectPaymentMode/).
|
|
538
462
|
*/
|
|
539
463
|
selectPaymentMode({ body, id, buyNow, orderType, requestHeaders }?: CartPlatformApplicationValidator.SelectPaymentModeParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
540
464
|
/**
|
|
@@ -543,8 +467,8 @@ declare class Cart {
|
|
|
543
467
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
544
468
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
545
469
|
* @name selectPaymentModeV2
|
|
546
|
-
* @summary:
|
|
547
|
-
* @description:
|
|
470
|
+
* @summary: Select a payment mode v2.
|
|
471
|
+
* @description: Choose a payment mode for cart checkout in the updated platform integration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/selectPaymentModeV2/).
|
|
548
472
|
*/
|
|
549
473
|
selectPaymentModeV2({ body, id, buyNow, orderType, requestHeaders }?: CartPlatformApplicationValidator.SelectPaymentModeV2Param, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
550
474
|
/**
|
|
@@ -553,8 +477,8 @@ declare class Cart {
|
|
|
553
477
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
554
478
|
* @returns {Promise<CartPlatformModel.UpdateAddressResponse>} - Success response
|
|
555
479
|
* @name updateAddress
|
|
556
|
-
* @summary: Update address
|
|
557
|
-
* @description:
|
|
480
|
+
* @summary: Update address.
|
|
481
|
+
* @description: Modify the shipping address for an order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateAddress/).
|
|
558
482
|
*/
|
|
559
483
|
updateAddress({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdateAddressResponse>;
|
|
560
484
|
/**
|
|
@@ -563,8 +487,8 @@ declare class Cart {
|
|
|
563
487
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
564
488
|
* @returns {Promise<CartPlatformModel.UpdateCartDetailResponse>} - Success response
|
|
565
489
|
* @name updateCart
|
|
566
|
-
* @summary: Update items
|
|
567
|
-
* @description:
|
|
490
|
+
* @summary: Update cart items.
|
|
491
|
+
* @description: Modify items and their quantities in the shopping cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCart/).
|
|
568
492
|
*/
|
|
569
493
|
updateCart({ cartId, body, b, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdateCartDetailResponse>;
|
|
570
494
|
/**
|
|
@@ -573,8 +497,8 @@ declare class Cart {
|
|
|
573
497
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
574
498
|
* @returns {Promise<CartPlatformModel.CartMetaResponse>} - Success response
|
|
575
499
|
* @name updateCartMeta
|
|
576
|
-
* @summary: Update
|
|
577
|
-
* @description:
|
|
500
|
+
* @summary: Update cart metadata.
|
|
501
|
+
* @description: Modify the metadata associated with the shopping cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartMeta/).
|
|
578
502
|
*/
|
|
579
503
|
updateCartMeta({ body, id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartMetaParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaResponse>;
|
|
580
504
|
/**
|
|
@@ -585,8 +509,8 @@ declare class Cart {
|
|
|
585
509
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
586
510
|
* @returns {Promise<CartPlatformModel.CartMetaConfigUpdate>} - Success response
|
|
587
511
|
* @name updateCartMetaConfig
|
|
588
|
-
* @summary: Update cart
|
|
589
|
-
* @description:
|
|
512
|
+
* @summary: Update cart metadata configuration.
|
|
513
|
+
* @description: Modify the configuration settings for cart metadata. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartMetaConfig/).
|
|
590
514
|
*/
|
|
591
515
|
updateCartMetaConfig({ cartMetaId, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartMetaConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaConfigUpdate>;
|
|
592
516
|
/**
|
|
@@ -595,8 +519,8 @@ declare class Cart {
|
|
|
595
519
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
596
520
|
* @returns {Promise<CartPlatformModel.UserCartMappingResponse>} - Success response
|
|
597
521
|
* @name updateCartUser
|
|
598
|
-
* @summary: Update user
|
|
599
|
-
* @description:
|
|
522
|
+
* @summary: Update cart user details.
|
|
523
|
+
* @description: Modify user-related details for a shopping cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartUser/).
|
|
600
524
|
*/
|
|
601
525
|
updateCartUser({ body, id, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartUserParam, { responseHeaders }?: object): Promise<CartPlatformModel.UserCartMappingResponse>;
|
|
602
526
|
/**
|
|
@@ -607,8 +531,8 @@ declare class Cart {
|
|
|
607
531
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
608
532
|
* @returns {Promise<CartPlatformModel.SharedCartResponse>} - Success response
|
|
609
533
|
* @name updateCartWithSharedItems
|
|
610
|
-
* @summary:
|
|
611
|
-
* @description:
|
|
534
|
+
* @summary: Update cart with shared items.
|
|
535
|
+
* @description: Modify your cart by adding shared items from a cart link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartWithSharedItems/).
|
|
612
536
|
*/
|
|
613
537
|
updateCartWithSharedItems({ token, action, cartId, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartWithSharedItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.SharedCartResponse>;
|
|
614
538
|
/**
|
|
@@ -617,8 +541,8 @@ declare class Cart {
|
|
|
617
541
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
618
542
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
619
543
|
* @name updateCoupon
|
|
620
|
-
* @summary: Update
|
|
621
|
-
* @description:
|
|
544
|
+
* @summary: Update a coupon.
|
|
545
|
+
* @description: Modify the details and settings of an existing coupon in the cart system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCoupon/).
|
|
622
546
|
*/
|
|
623
547
|
updateCoupon({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
624
548
|
/**
|
|
@@ -629,8 +553,8 @@ declare class Cart {
|
|
|
629
553
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
630
554
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
631
555
|
* @name updateCouponPartially
|
|
632
|
-
* @summary:
|
|
633
|
-
* @description:
|
|
556
|
+
* @summary: Partially update a coupon.
|
|
557
|
+
* @description: Make partial modifications to the settings of an existing coupon in the cart system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCouponPartially/).
|
|
634
558
|
*/
|
|
635
559
|
updateCouponPartially({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCouponPartiallyParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
636
560
|
/**
|
|
@@ -641,8 +565,8 @@ declare class Cart {
|
|
|
641
565
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
642
566
|
* @returns {Promise<CartPlatformModel.PriceAdjustmentResponse>} - Success response
|
|
643
567
|
* @name updatePriceAdjustment
|
|
644
|
-
* @summary: Update price
|
|
645
|
-
* @description:
|
|
568
|
+
* @summary: Update price adjustments.
|
|
569
|
+
* @description: Modify price adjustments for items in the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePriceAdjustment/).
|
|
646
570
|
*/
|
|
647
571
|
updatePriceAdjustment({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.PriceAdjustmentResponse>;
|
|
648
572
|
/**
|
|
@@ -651,8 +575,8 @@ declare class Cart {
|
|
|
651
575
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
652
576
|
* @returns {Promise<CartPlatformModel.PromotionUpdate>} - Success response
|
|
653
577
|
* @name updatePromotion
|
|
654
|
-
* @summary: Update
|
|
655
|
-
* @description:
|
|
578
|
+
* @summary: Update a promotion.
|
|
579
|
+
* @description: Modify the details and settings of an existing promotion in the cart system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePromotion/).
|
|
656
580
|
*/
|
|
657
581
|
updatePromotion({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePromotionParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionUpdate>;
|
|
658
582
|
/**
|
|
@@ -663,8 +587,8 @@ declare class Cart {
|
|
|
663
587
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
664
588
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
665
589
|
* @name updatePromotionPartially
|
|
666
|
-
* @summary:
|
|
667
|
-
* @description:
|
|
590
|
+
* @summary: Partially update a promotion.
|
|
591
|
+
* @description: Make partial modifications to the settings of an existing promotion in the cart system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePromotionPartially/).
|
|
668
592
|
*/
|
|
669
593
|
updatePromotionPartially({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePromotionPartiallyParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
670
594
|
/**
|
|
@@ -674,8 +598,8 @@ declare class Cart {
|
|
|
674
598
|
* @returns {Promise<CartPlatformModel.PlatformCartShipmentsResponse>} -
|
|
675
599
|
* Success response
|
|
676
600
|
* @name updateShipments
|
|
677
|
-
* @summary: Update shipment
|
|
678
|
-
* @description:
|
|
601
|
+
* @summary: Update shipment details.
|
|
602
|
+
* @description: Modify the details and settings of cart shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateShipments/).
|
|
679
603
|
*/
|
|
680
604
|
updateShipments({ body, i, p, id, addressId, areaCode, orderType, requestHeaders }?: CartPlatformApplicationValidator.UpdateShipmentsParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformCartShipmentsResponse>;
|
|
681
605
|
/**
|
|
@@ -686,11 +610,10 @@ declare class Cart {
|
|
|
686
610
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
687
611
|
* @returns {Promise<CartPlatformModel.PaymentCouponValidate>} - Success response
|
|
688
612
|
* @name validateCouponForPayment
|
|
689
|
-
* @summary:
|
|
690
|
-
* @description:
|
|
613
|
+
* @summary: Validate a coupon for payment.
|
|
614
|
+
* @description: Verify the validity of a coupon code for the payment process. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/validateCouponForPayment/).
|
|
691
615
|
*/
|
|
692
616
|
validateCouponForPayment({ id, buyNow, addressId, paymentMode, paymentIdentifier, aggregatorName, merchantCode, requestHeaders, }?: CartPlatformApplicationValidator.ValidateCouponForPaymentParam, { responseHeaders }?: object): Promise<CartPlatformModel.PaymentCouponValidate>;
|
|
693
617
|
}
|
|
694
618
|
import CartPlatformApplicationValidator = require("./CartPlatformApplicationValidator");
|
|
695
619
|
import CartPlatformModel = require("./CartPlatformModel");
|
|
696
|
-
import Paginator = require("../../common/Paginator");
|