@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +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/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/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/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 +19 -55
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -55
- 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 -12
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -14
- 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/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/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/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 +2 -2
- package/sdk/platform/User/UserPlatformModel.js +2 -2
- 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
|
@@ -21,8 +21,8 @@ class Cart {
|
|
|
21
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
22
|
* @returns {Promise<CartPlatformModel.SaveAddressResponse>} - Success response
|
|
23
23
|
* @name addAddress
|
|
24
|
-
* @summary: Add
|
|
25
|
-
* @description:
|
|
24
|
+
* @summary: Add a new user address.
|
|
25
|
+
* @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/).
|
|
26
26
|
*/
|
|
27
27
|
async addAddress(
|
|
28
28
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -98,8 +98,8 @@ class Cart {
|
|
|
98
98
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
99
99
|
* @returns {Promise<CartPlatformModel.AddCartDetailResponse>} - Success response
|
|
100
100
|
* @name addItems
|
|
101
|
-
* @summary: Add items to
|
|
102
|
-
* @description:
|
|
101
|
+
* @summary: Add items to the cart.
|
|
102
|
+
* @description: Add items to the shopping cart - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addItems/).
|
|
103
103
|
*/
|
|
104
104
|
async addItems(
|
|
105
105
|
{ cartId, body, b, requestHeaders } = { requestHeaders: {} },
|
|
@@ -180,8 +180,8 @@ class Cart {
|
|
|
180
180
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
181
181
|
* @returns {Promise<CartPlatformModel.PriceAdjustmentResponse>} - Success response
|
|
182
182
|
* @name addPriceAdjustment
|
|
183
|
-
* @summary:
|
|
184
|
-
* @description:
|
|
183
|
+
* @summary: Add price adjustments.
|
|
184
|
+
* @description: Apply price adjustments to items in the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addPriceAdjustment/).
|
|
185
185
|
*/
|
|
186
186
|
async addPriceAdjustment(
|
|
187
187
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -259,8 +259,8 @@ class Cart {
|
|
|
259
259
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
260
260
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
261
261
|
* @name applyCoupon
|
|
262
|
-
* @summary: Apply
|
|
263
|
-
* @description:
|
|
262
|
+
* @summary: Apply a coupon to the cart.
|
|
263
|
+
* @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/).
|
|
264
264
|
*/
|
|
265
265
|
async applyCoupon(
|
|
266
266
|
{ body, i, b, p, id, buyNow, requestHeaders } = { requestHeaders: {} },
|
|
@@ -355,8 +355,8 @@ class Cart {
|
|
|
355
355
|
* - Success response
|
|
356
356
|
*
|
|
357
357
|
* @name checkCartServiceability
|
|
358
|
-
* @summary: Check
|
|
359
|
-
* @description:
|
|
358
|
+
* @summary: Check cart serviceability.
|
|
359
|
+
* @description: Verify if the items in the cart are serviceable. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/checkCartServiceability/).
|
|
360
360
|
*/
|
|
361
361
|
async checkCartServiceability(
|
|
362
362
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -434,8 +434,8 @@ class Cart {
|
|
|
434
434
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
435
435
|
* @returns {Promise<CartPlatformModel.OpenApiCheckoutResponse>} - Success response
|
|
436
436
|
* @name checkoutCart
|
|
437
|
-
* @summary:
|
|
438
|
-
* @description:
|
|
437
|
+
* @summary: Proceed to cart checkout.
|
|
438
|
+
* @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/).
|
|
439
439
|
*/
|
|
440
440
|
async checkoutCart(
|
|
441
441
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -592,8 +592,8 @@ class Cart {
|
|
|
592
592
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
593
593
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
594
594
|
* @name createCoupon
|
|
595
|
-
* @summary: Create new coupon
|
|
596
|
-
* @description:
|
|
595
|
+
* @summary: Create a new coupon.
|
|
596
|
+
* @description: Generate and add a new coupon to the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/createCoupon/).
|
|
597
597
|
*/
|
|
598
598
|
async createCoupon(
|
|
599
599
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -669,8 +669,8 @@ class Cart {
|
|
|
669
669
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
670
670
|
* @returns {Promise<CartPlatformModel.PromotionAdd>} - Success response
|
|
671
671
|
* @name createPromotion
|
|
672
|
-
* @summary: Create new promotion
|
|
673
|
-
* @description:
|
|
672
|
+
* @summary: Create a new promotion.
|
|
673
|
+
* @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/).
|
|
674
674
|
*/
|
|
675
675
|
async createPromotion(
|
|
676
676
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -748,8 +748,8 @@ class Cart {
|
|
|
748
748
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
749
749
|
* @returns {Promise<CartPlatformModel.DeleteCartDetailResponse>} - Success response
|
|
750
750
|
* @name deleteCart
|
|
751
|
-
* @summary: Delete cart
|
|
752
|
-
* @description:
|
|
751
|
+
* @summary: Delete a cart.
|
|
752
|
+
* @description: Delete a specific shopping cart from the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/deleteCart/).
|
|
753
753
|
*/
|
|
754
754
|
async deleteCart(
|
|
755
755
|
{ body, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -830,8 +830,8 @@ class Cart {
|
|
|
830
830
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
831
831
|
* @returns {Promise<CartPlatformModel.OpenapiCartDetailsResponse>} - Success response
|
|
832
832
|
* @name fetchAndvalidateCartItems
|
|
833
|
-
* @summary: Fetch
|
|
834
|
-
* @description:
|
|
833
|
+
* @summary: Fetch and validate cart items.
|
|
834
|
+
* @description: Retrieve and validate items currently in the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/fetchAndvalidateCartItems/).
|
|
835
835
|
*/
|
|
836
836
|
async fetchAndvalidateCartItems(
|
|
837
837
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -984,8 +984,8 @@ class Cart {
|
|
|
984
984
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
985
985
|
* @returns {Promise<CartPlatformModel.AbandonedCartResponse>} - Success response
|
|
986
986
|
* @name getAbandonedCart
|
|
987
|
-
* @summary:
|
|
988
|
-
* @description:
|
|
987
|
+
* @summary: Retrieve abandoned carts.
|
|
988
|
+
* @description: Retrieve abandoned carts for analysis and potential recovery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAbandonedCart/).
|
|
989
989
|
*/
|
|
990
990
|
async getAbandonedCart(
|
|
991
991
|
{
|
|
@@ -1085,56 +1085,6 @@ class Cart {
|
|
|
1085
1085
|
return response;
|
|
1086
1086
|
}
|
|
1087
1087
|
|
|
1088
|
-
/**
|
|
1089
|
-
* @param {Object} arg - Arg object.
|
|
1090
|
-
* @param {string} arg.companyId - Current company id
|
|
1091
|
-
* @param {string} arg.applicationId - Current Application _id
|
|
1092
|
-
* @param {number} [arg.pageSize] -
|
|
1093
|
-
* @param {string} [arg.fromDate] -
|
|
1094
|
-
* @param {string} [arg.toDate] -
|
|
1095
|
-
* @param {boolean} [arg.anonymousCart] -
|
|
1096
|
-
* @param {string} [arg.lastId] -
|
|
1097
|
-
* @param {string} [arg.sortOn] -
|
|
1098
|
-
* @returns {Paginator<CartPlatformModel.AbandonedCartResponse>}
|
|
1099
|
-
* @summary: Get with abandoned cart list
|
|
1100
|
-
* @description: Get abandoned cart list with pagination
|
|
1101
|
-
*/
|
|
1102
|
-
getAbandonedCartPaginator({
|
|
1103
|
-
companyId,
|
|
1104
|
-
applicationId,
|
|
1105
|
-
pageSize,
|
|
1106
|
-
fromDate,
|
|
1107
|
-
toDate,
|
|
1108
|
-
anonymousCart,
|
|
1109
|
-
lastId,
|
|
1110
|
-
sortOn,
|
|
1111
|
-
} = {}) {
|
|
1112
|
-
const paginator = new Paginator();
|
|
1113
|
-
const callback = async () => {
|
|
1114
|
-
const pageId = paginator.nextId;
|
|
1115
|
-
const pageNo = paginator.pageNo;
|
|
1116
|
-
const pageType = "number";
|
|
1117
|
-
const data = await this.getAbandonedCart({
|
|
1118
|
-
companyId: companyId,
|
|
1119
|
-
applicationId: applicationId,
|
|
1120
|
-
pageNo: pageNo,
|
|
1121
|
-
pageSize: pageSize,
|
|
1122
|
-
fromDate: fromDate,
|
|
1123
|
-
toDate: toDate,
|
|
1124
|
-
anonymousCart: anonymousCart,
|
|
1125
|
-
lastId: lastId,
|
|
1126
|
-
sortOn: sortOn,
|
|
1127
|
-
});
|
|
1128
|
-
paginator.setPaginator({
|
|
1129
|
-
hasNext: data.page.has_next ? true : false,
|
|
1130
|
-
nextId: data.page.next_id,
|
|
1131
|
-
});
|
|
1132
|
-
return data;
|
|
1133
|
-
};
|
|
1134
|
-
paginator.setCallback(callback.bind(this));
|
|
1135
|
-
return paginator;
|
|
1136
|
-
}
|
|
1137
|
-
|
|
1138
1088
|
/**
|
|
1139
1089
|
* @param {CartPlatformApplicationValidator.GetAbandonedCartDetailsParam} arg
|
|
1140
1090
|
* - Arg object
|
|
@@ -1143,8 +1093,8 @@ class Cart {
|
|
|
1143
1093
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1144
1094
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
1145
1095
|
* @name getAbandonedCartDetails
|
|
1146
|
-
* @summary:
|
|
1147
|
-
* @description:
|
|
1096
|
+
* @summary: Get abandoned cart details.
|
|
1097
|
+
* @description: Retrieve detailed information about a specific abandoned cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAbandonedCartDetails/).
|
|
1148
1098
|
*/
|
|
1149
1099
|
async getAbandonedCartDetails(
|
|
1150
1100
|
{ id, i, b, c, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1448,8 +1398,8 @@ class Cart {
|
|
|
1448
1398
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1449
1399
|
* @returns {Promise<CartPlatformModel.GetCouponResponse>} - Success response
|
|
1450
1400
|
* @name getAppCoupons
|
|
1451
|
-
* @summary:
|
|
1452
|
-
* @description:
|
|
1401
|
+
* @summary: Get app-specific coupons.
|
|
1402
|
+
* @description: Retrieve coupons specific to the mobile app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAppCoupons/).
|
|
1453
1403
|
*/
|
|
1454
1404
|
async getAppCoupons(
|
|
1455
1405
|
{ id, buyNow, slug, storeId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1537,8 +1487,8 @@ class Cart {
|
|
|
1537
1487
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1538
1488
|
* @returns {Promise<CartPlatformModel.CartDeliveryModesResponse>} - Success response
|
|
1539
1489
|
* @name getAvailableDeliveryModes
|
|
1540
|
-
* @summary: Get available delivery modes
|
|
1541
|
-
* @description:
|
|
1490
|
+
* @summary: Get available delivery modes.
|
|
1491
|
+
* @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/).
|
|
1542
1492
|
*/
|
|
1543
1493
|
async getAvailableDeliveryModes(
|
|
1544
1494
|
{ areaCode, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1620,8 +1570,8 @@ class Cart {
|
|
|
1620
1570
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1621
1571
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
1622
1572
|
* @name getCart
|
|
1623
|
-
* @summary:
|
|
1624
|
-
* @description:
|
|
1573
|
+
* @summary: Get cart details.
|
|
1574
|
+
* @description: Retrieve detailed information about a shopping cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCart/).
|
|
1625
1575
|
*/
|
|
1626
1576
|
async getCart(
|
|
1627
1577
|
{ id, userId, i, b, assignCardId, buyNow, requestHeaders } = {
|
|
@@ -1715,8 +1665,8 @@ class Cart {
|
|
|
1715
1665
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1716
1666
|
* @returns {Promise<CartPlatformModel.MultiCartResponse>} - Success response
|
|
1717
1667
|
* @name getCartList
|
|
1718
|
-
* @summary:
|
|
1719
|
-
* @description:
|
|
1668
|
+
* @summary: Retrieve a list of carts.
|
|
1669
|
+
* @description: Retrieve a list of saved shopping carts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCartList/).
|
|
1720
1670
|
*/
|
|
1721
1671
|
async getCartList(
|
|
1722
1672
|
{ fromDate, toDate, filterOn, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1878,8 +1828,8 @@ class Cart {
|
|
|
1878
1828
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1879
1829
|
* @returns {Promise<CartPlatformModel.SharedCartResponse>} - Success response
|
|
1880
1830
|
* @name getCartSharedItems
|
|
1881
|
-
* @summary: Get
|
|
1882
|
-
* @description:
|
|
1831
|
+
* @summary: Get items shared via a cart link.
|
|
1832
|
+
* @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/).
|
|
1883
1833
|
*/
|
|
1884
1834
|
async getCartSharedItems(
|
|
1885
1835
|
{ token, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1957,8 +1907,8 @@ class Cart {
|
|
|
1957
1907
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1958
1908
|
* @returns {Promise<CartPlatformModel.CouponUpdate>} - Success response
|
|
1959
1909
|
* @name getCouponById
|
|
1960
|
-
* @summary: Get
|
|
1961
|
-
* @description:
|
|
1910
|
+
* @summary: Get coupon details by ID.
|
|
1911
|
+
* @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/).
|
|
1962
1912
|
*/
|
|
1963
1913
|
async getCouponById(
|
|
1964
1914
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2034,8 +1984,8 @@ class Cart {
|
|
|
2034
1984
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2035
1985
|
* @returns {Promise<Object>} - Success response
|
|
2036
1986
|
* @name getCouponCodeExists
|
|
2037
|
-
* @summary: Check if
|
|
2038
|
-
* @description:
|
|
1987
|
+
* @summary: Check if a coupon code exists.
|
|
1988
|
+
* @description: Verify the existence of a specific coupon code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponCodeExists/).
|
|
2039
1989
|
*/
|
|
2040
1990
|
async getCouponCodeExists(
|
|
2041
1991
|
{ code, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2114,8 +2064,8 @@ class Cart {
|
|
|
2114
2064
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2115
2065
|
* @returns {Promise<Object>} - Success response
|
|
2116
2066
|
* @name getCouponOptionValues
|
|
2117
|
-
* @summary: Get coupon
|
|
2118
|
-
* @description:
|
|
2067
|
+
* @summary: Get coupon option values.
|
|
2068
|
+
* @description: Retrieve available values for coupon options. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponOptionValues/).
|
|
2119
2069
|
*/
|
|
2120
2070
|
async getCouponOptionValues(
|
|
2121
2071
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -2187,8 +2137,8 @@ class Cart {
|
|
|
2187
2137
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2188
2138
|
* @returns {Promise<CartPlatformModel.CouponsResponse>} - Success response
|
|
2189
2139
|
* @name getCoupons
|
|
2190
|
-
* @summary:
|
|
2191
|
-
* @description:
|
|
2140
|
+
* @summary: Retrieve available coupons.
|
|
2141
|
+
* @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/).
|
|
2192
2142
|
*/
|
|
2193
2143
|
async getCoupons(
|
|
2194
2144
|
{
|
|
@@ -2290,67 +2240,14 @@ class Cart {
|
|
|
2290
2240
|
return response;
|
|
2291
2241
|
}
|
|
2292
2242
|
|
|
2293
|
-
/**
|
|
2294
|
-
* @param {Object} arg - Arg object.
|
|
2295
|
-
* @param {string} arg.companyId - Current company id
|
|
2296
|
-
* @param {string} arg.applicationId - Current Application _id
|
|
2297
|
-
* @param {number} [arg.pageSize] -
|
|
2298
|
-
* @param {boolean} [arg.isArchived] -
|
|
2299
|
-
* @param {string} [arg.title] -
|
|
2300
|
-
* @param {boolean} [arg.isPublic] -
|
|
2301
|
-
* @param {boolean} [arg.isDisplay] -
|
|
2302
|
-
* @param {string} [arg.typeSlug] -
|
|
2303
|
-
* @param {string} [arg.code] -
|
|
2304
|
-
* @returns {Paginator<CartPlatformModel.CouponsResponse>}
|
|
2305
|
-
* @summary: Get with single coupon details or coupon list
|
|
2306
|
-
* @description: Get coupon list with pagination
|
|
2307
|
-
*/
|
|
2308
|
-
getCouponsPaginator({
|
|
2309
|
-
companyId,
|
|
2310
|
-
applicationId,
|
|
2311
|
-
pageSize,
|
|
2312
|
-
isArchived,
|
|
2313
|
-
title,
|
|
2314
|
-
isPublic,
|
|
2315
|
-
isDisplay,
|
|
2316
|
-
typeSlug,
|
|
2317
|
-
code,
|
|
2318
|
-
} = {}) {
|
|
2319
|
-
const paginator = new Paginator();
|
|
2320
|
-
const callback = async () => {
|
|
2321
|
-
const pageId = paginator.nextId;
|
|
2322
|
-
const pageNo = paginator.pageNo;
|
|
2323
|
-
const pageType = "number";
|
|
2324
|
-
const data = await this.getCoupons({
|
|
2325
|
-
companyId: companyId,
|
|
2326
|
-
applicationId: applicationId,
|
|
2327
|
-
pageNo: pageNo,
|
|
2328
|
-
pageSize: pageSize,
|
|
2329
|
-
isArchived: isArchived,
|
|
2330
|
-
title: title,
|
|
2331
|
-
isPublic: isPublic,
|
|
2332
|
-
isDisplay: isDisplay,
|
|
2333
|
-
typeSlug: typeSlug,
|
|
2334
|
-
code: code,
|
|
2335
|
-
});
|
|
2336
|
-
paginator.setPaginator({
|
|
2337
|
-
hasNext: data.page.has_next ? true : false,
|
|
2338
|
-
nextId: data.page.next_id,
|
|
2339
|
-
});
|
|
2340
|
-
return data;
|
|
2341
|
-
};
|
|
2342
|
-
paginator.setCallback(callback.bind(this));
|
|
2343
|
-
return paginator;
|
|
2344
|
-
}
|
|
2345
|
-
|
|
2346
2243
|
/**
|
|
2347
2244
|
* @param {CartPlatformApplicationValidator.GetItemCountParam} arg - Arg object
|
|
2348
2245
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2349
2246
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2350
2247
|
* @returns {Promise<CartPlatformModel.CartItemCountResponse>} - Success response
|
|
2351
2248
|
* @name getItemCount
|
|
2352
|
-
* @summary:
|
|
2353
|
-
* @description:
|
|
2249
|
+
* @summary: Get the item count in a cart.
|
|
2250
|
+
* @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/).
|
|
2354
2251
|
*/
|
|
2355
2252
|
async getItemCount(
|
|
2356
2253
|
{ id, buyNow, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2432,8 +2329,8 @@ class Cart {
|
|
|
2432
2329
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2433
2330
|
* @returns {Promise<CartPlatformModel.ActivePromosResponse>} - Success response
|
|
2434
2331
|
* @name getPromosCouponConfig
|
|
2435
|
-
* @summary:
|
|
2436
|
-
* @description:
|
|
2332
|
+
* @summary: Get promotion and coupon configuration.
|
|
2333
|
+
* @description: Retrieve configuration settings for promotions and coupons. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromosCouponConfig/).
|
|
2437
2334
|
*/
|
|
2438
2335
|
async getPromosCouponConfig(
|
|
2439
2336
|
{ entityType, isHidden, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2515,8 +2412,8 @@ class Cart {
|
|
|
2515
2412
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2516
2413
|
* @returns {Promise<CartPlatformModel.PromotionUpdate>} - Success response
|
|
2517
2414
|
* @name getPromotionById
|
|
2518
|
-
* @summary: Get
|
|
2519
|
-
* @description:
|
|
2415
|
+
* @summary: Get promotion details by ID.
|
|
2416
|
+
* @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/).
|
|
2520
2417
|
*/
|
|
2521
2418
|
async getPromotionById(
|
|
2522
2419
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2596,8 +2493,8 @@ class Cart {
|
|
|
2596
2493
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2597
2494
|
* @returns {Promise<Object>} - Success response
|
|
2598
2495
|
* @name getPromotionCodeExists
|
|
2599
|
-
* @summary: Check if
|
|
2600
|
-
* @description:
|
|
2496
|
+
* @summary: Check if a promotion code exists.
|
|
2497
|
+
* @description: Verify the existence of a specific promotion code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionCodeExists/).
|
|
2601
2498
|
*/
|
|
2602
2499
|
async getPromotionCodeExists(
|
|
2603
2500
|
{ code, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2674,8 +2571,8 @@ class Cart {
|
|
|
2674
2571
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2675
2572
|
* @returns {Promise<CartPlatformModel.PromotionsResponse>} - Success response
|
|
2676
2573
|
* @name getPromotions
|
|
2677
|
-
* @summary:
|
|
2678
|
-
* @description:
|
|
2574
|
+
* @summary: Retrieve available promotions.
|
|
2575
|
+
* @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/).
|
|
2679
2576
|
*/
|
|
2680
2577
|
async getPromotions(
|
|
2681
2578
|
{
|
|
@@ -2777,59 +2674,6 @@ class Cart {
|
|
|
2777
2674
|
return response;
|
|
2778
2675
|
}
|
|
2779
2676
|
|
|
2780
|
-
/**
|
|
2781
|
-
* @param {Object} arg - Arg object.
|
|
2782
|
-
* @param {string} arg.companyId - Current company id
|
|
2783
|
-
* @param {string} arg.applicationId - Current Application _id
|
|
2784
|
-
* @param {number} [arg.pageSize] -
|
|
2785
|
-
* @param {string} [arg.q] -
|
|
2786
|
-
* @param {boolean} [arg.isActive] -
|
|
2787
|
-
* @param {string} [arg.promoGroup] -
|
|
2788
|
-
* @param {string} [arg.promotionType] -
|
|
2789
|
-
* @param {string} [arg.fpPanel] -
|
|
2790
|
-
* @param {string} [arg.promotionId] -
|
|
2791
|
-
* @returns {Paginator<CartPlatformModel.PromotionsResponse>}
|
|
2792
|
-
* @summary: Get promotion list
|
|
2793
|
-
* @description: Get promotion list with pagination
|
|
2794
|
-
*/
|
|
2795
|
-
getPromotionsPaginator({
|
|
2796
|
-
companyId,
|
|
2797
|
-
applicationId,
|
|
2798
|
-
pageSize,
|
|
2799
|
-
q,
|
|
2800
|
-
isActive,
|
|
2801
|
-
promoGroup,
|
|
2802
|
-
promotionType,
|
|
2803
|
-
fpPanel,
|
|
2804
|
-
promotionId,
|
|
2805
|
-
} = {}) {
|
|
2806
|
-
const paginator = new Paginator();
|
|
2807
|
-
const callback = async () => {
|
|
2808
|
-
const pageId = paginator.nextId;
|
|
2809
|
-
const pageNo = paginator.pageNo;
|
|
2810
|
-
const pageType = "number";
|
|
2811
|
-
const data = await this.getPromotions({
|
|
2812
|
-
companyId: companyId,
|
|
2813
|
-
applicationId: applicationId,
|
|
2814
|
-
pageNo: pageNo,
|
|
2815
|
-
pageSize: pageSize,
|
|
2816
|
-
q: q,
|
|
2817
|
-
isActive: isActive,
|
|
2818
|
-
promoGroup: promoGroup,
|
|
2819
|
-
promotionType: promotionType,
|
|
2820
|
-
fpPanel: fpPanel,
|
|
2821
|
-
promotionId: promotionId,
|
|
2822
|
-
});
|
|
2823
|
-
paginator.setPaginator({
|
|
2824
|
-
hasNext: data.page.has_next ? true : false,
|
|
2825
|
-
nextId: data.page.next_id,
|
|
2826
|
-
});
|
|
2827
|
-
return data;
|
|
2828
|
-
};
|
|
2829
|
-
paginator.setCallback(callback.bind(this));
|
|
2830
|
-
return paginator;
|
|
2831
|
-
}
|
|
2832
|
-
|
|
2833
2677
|
/**
|
|
2834
2678
|
* @param {CartPlatformApplicationValidator.GetShipmentsParam} arg - Arg object
|
|
2835
2679
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -2948,8 +2792,8 @@ class Cart {
|
|
|
2948
2792
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2949
2793
|
* @returns {Promise<CartPlatformModel.StoreDetailsResponse>} - Success response
|
|
2950
2794
|
* @name getStoreAddressByUid
|
|
2951
|
-
* @summary: Get
|
|
2952
|
-
* @description:
|
|
2795
|
+
* @summary: Get store address by UID.
|
|
2796
|
+
* @description: Retrieve the store address using a unique identifier (UID). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getStoreAddressByUid/).
|
|
2953
2797
|
*/
|
|
2954
2798
|
async getStoreAddressByUid(
|
|
2955
2799
|
{ storeUid, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3028,8 +2872,8 @@ class Cart {
|
|
|
3028
2872
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3029
2873
|
* @returns {Promise<CartPlatformModel.OverrideCheckoutResponse>} - Success response
|
|
3030
2874
|
* @name overrideCart
|
|
3031
|
-
* @summary:
|
|
3032
|
-
* @description:
|
|
2875
|
+
* @summary: Override the cart.
|
|
2876
|
+
* @description: Override the current cart with a new configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/overrideCart/).
|
|
3033
2877
|
*/
|
|
3034
2878
|
async overrideCart(
|
|
3035
2879
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3105,8 +2949,8 @@ class Cart {
|
|
|
3105
2949
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3106
2950
|
* @returns {Promise<CartPlatformModel.AddCartDetailResponse>} - Success response
|
|
3107
2951
|
* @name platformAddItems
|
|
3108
|
-
* @summary: Add items
|
|
3109
|
-
* @description:
|
|
2952
|
+
* @summary: Add items via platform integration.
|
|
2953
|
+
* @description: Add items to the cart through platform integration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformAddItems/).
|
|
3110
2954
|
*/
|
|
3111
2955
|
async platformAddItems(
|
|
3112
2956
|
{ body, i, b, buyNow, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3198,8 +3042,8 @@ class Cart {
|
|
|
3198
3042
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3199
3043
|
* @returns {Promise<CartPlatformModel.CartCheckoutResponse>} - Success response
|
|
3200
3044
|
* @name platformCheckoutCart
|
|
3201
|
-
* @summary:
|
|
3202
|
-
* @description:
|
|
3045
|
+
* @summary: Platform-specific cart checkout.
|
|
3046
|
+
* @description: Initiate cart checkout through platform-specific integration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCart/).
|
|
3203
3047
|
*/
|
|
3204
3048
|
async platformCheckoutCart(
|
|
3205
3049
|
{ body, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3282,8 +3126,8 @@ class Cart {
|
|
|
3282
3126
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3283
3127
|
* @returns {Promise<CartPlatformModel.CartCheckoutResponse>} - Success response
|
|
3284
3128
|
* @name platformCheckoutCartV2
|
|
3285
|
-
* @summary:
|
|
3286
|
-
* @description:
|
|
3129
|
+
* @summary: Platform-specific cart checkout v2.
|
|
3130
|
+
* @description: Initiate cart checkout through an updated platform-specific integration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCartV2/).
|
|
3287
3131
|
*/
|
|
3288
3132
|
async platformCheckoutCartV2(
|
|
3289
3133
|
{ body, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3455,8 +3299,8 @@ class Cart {
|
|
|
3455
3299
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3456
3300
|
* @returns {Promise<CartPlatformModel.DeleteAddressResponse>} - Success response
|
|
3457
3301
|
* @name removeAddress
|
|
3458
|
-
* @summary: Remove
|
|
3459
|
-
* @description:
|
|
3302
|
+
* @summary: Remove a user address.
|
|
3303
|
+
* @description: Delete an existing user address from the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removeAddress/).
|
|
3460
3304
|
*/
|
|
3461
3305
|
async removeAddress(
|
|
3462
3306
|
{ id, userId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3535,8 +3379,8 @@ class Cart {
|
|
|
3535
3379
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3536
3380
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
3537
3381
|
* @name removeCoupon
|
|
3538
|
-
* @summary: Remove
|
|
3539
|
-
* @description: Remove
|
|
3382
|
+
* @summary: Remove a coupon from the cart.
|
|
3383
|
+
* @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/).
|
|
3540
3384
|
*/
|
|
3541
3385
|
async removeCoupon(
|
|
3542
3386
|
{ uid, buyNow, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3618,8 +3462,8 @@ class Cart {
|
|
|
3618
3462
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3619
3463
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
3620
3464
|
* @name removePriceAdjustment
|
|
3621
|
-
* @summary: Remove price
|
|
3622
|
-
* @description: Remove price
|
|
3465
|
+
* @summary: Remove price adjustments.
|
|
3466
|
+
* @description: Remove price adjustments applied to items in the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removePriceAdjustment/).
|
|
3623
3467
|
*/
|
|
3624
3468
|
async removePriceAdjustment(
|
|
3625
3469
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3786,8 +3630,8 @@ class Cart {
|
|
|
3786
3630
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3787
3631
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
3788
3632
|
* @name selectPaymentMode
|
|
3789
|
-
* @summary:
|
|
3790
|
-
* @description:
|
|
3633
|
+
* @summary: Select a payment mode.
|
|
3634
|
+
* @description: Choose a payment mode for cart checkout. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/selectPaymentMode/).
|
|
3791
3635
|
*/
|
|
3792
3636
|
async selectPaymentMode(
|
|
3793
3637
|
{ body, id, buyNow, orderType, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3874,8 +3718,8 @@ class Cart {
|
|
|
3874
3718
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3875
3719
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
3876
3720
|
* @name selectPaymentModeV2
|
|
3877
|
-
* @summary:
|
|
3878
|
-
* @description:
|
|
3721
|
+
* @summary: Select a payment mode v2.
|
|
3722
|
+
* @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/).
|
|
3879
3723
|
*/
|
|
3880
3724
|
async selectPaymentModeV2(
|
|
3881
3725
|
{ body, id, buyNow, orderType, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3962,8 +3806,8 @@ class Cart {
|
|
|
3962
3806
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3963
3807
|
* @returns {Promise<CartPlatformModel.UpdateAddressResponse>} - Success response
|
|
3964
3808
|
* @name updateAddress
|
|
3965
|
-
* @summary: Update address
|
|
3966
|
-
* @description:
|
|
3809
|
+
* @summary: Update address.
|
|
3810
|
+
* @description: Modify the shipping address for an order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateAddress/).
|
|
3967
3811
|
*/
|
|
3968
3812
|
async updateAddress(
|
|
3969
3813
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4041,8 +3885,8 @@ class Cart {
|
|
|
4041
3885
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4042
3886
|
* @returns {Promise<CartPlatformModel.UpdateCartDetailResponse>} - Success response
|
|
4043
3887
|
* @name updateCart
|
|
4044
|
-
* @summary: Update items
|
|
4045
|
-
* @description:
|
|
3888
|
+
* @summary: Update cart items.
|
|
3889
|
+
* @description: Modify items and their quantities in the shopping cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCart/).
|
|
4046
3890
|
*/
|
|
4047
3891
|
async updateCart(
|
|
4048
3892
|
{ cartId, body, b, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4123,8 +3967,8 @@ class Cart {
|
|
|
4123
3967
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4124
3968
|
* @returns {Promise<CartPlatformModel.CartMetaResponse>} - Success response
|
|
4125
3969
|
* @name updateCartMeta
|
|
4126
|
-
* @summary: Update
|
|
4127
|
-
* @description:
|
|
3970
|
+
* @summary: Update cart metadata.
|
|
3971
|
+
* @description: Modify the metadata associated with the shopping cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartMeta/).
|
|
4128
3972
|
*/
|
|
4129
3973
|
async updateCartMeta(
|
|
4130
3974
|
{ body, id, buyNow, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4210,8 +4054,8 @@ class Cart {
|
|
|
4210
4054
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4211
4055
|
* @returns {Promise<CartPlatformModel.CartMetaConfigUpdate>} - Success response
|
|
4212
4056
|
* @name updateCartMetaConfig
|
|
4213
|
-
* @summary: Update cart
|
|
4214
|
-
* @description:
|
|
4057
|
+
* @summary: Update cart metadata configuration.
|
|
4058
|
+
* @description: Modify the configuration settings for cart metadata. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartMetaConfig/).
|
|
4215
4059
|
*/
|
|
4216
4060
|
async updateCartMetaConfig(
|
|
4217
4061
|
{ cartMetaId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4291,8 +4135,8 @@ class Cart {
|
|
|
4291
4135
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4292
4136
|
* @returns {Promise<CartPlatformModel.UserCartMappingResponse>} - Success response
|
|
4293
4137
|
* @name updateCartUser
|
|
4294
|
-
* @summary: Update user
|
|
4295
|
-
* @description:
|
|
4138
|
+
* @summary: Update cart user details.
|
|
4139
|
+
* @description: Modify user-related details for a shopping cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartUser/).
|
|
4296
4140
|
*/
|
|
4297
4141
|
async updateCartUser(
|
|
4298
4142
|
{ body, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4375,8 +4219,8 @@ class Cart {
|
|
|
4375
4219
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4376
4220
|
* @returns {Promise<CartPlatformModel.SharedCartResponse>} - Success response
|
|
4377
4221
|
* @name updateCartWithSharedItems
|
|
4378
|
-
* @summary:
|
|
4379
|
-
* @description:
|
|
4222
|
+
* @summary: Update cart with shared items.
|
|
4223
|
+
* @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/).
|
|
4380
4224
|
*/
|
|
4381
4225
|
async updateCartWithSharedItems(
|
|
4382
4226
|
{ token, action, cartId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4459,8 +4303,8 @@ class Cart {
|
|
|
4459
4303
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4460
4304
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
4461
4305
|
* @name updateCoupon
|
|
4462
|
-
* @summary: Update
|
|
4463
|
-
* @description:
|
|
4306
|
+
* @summary: Update a coupon.
|
|
4307
|
+
* @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/).
|
|
4464
4308
|
*/
|
|
4465
4309
|
async updateCoupon(
|
|
4466
4310
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4540,8 +4384,8 @@ class Cart {
|
|
|
4540
4384
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4541
4385
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
4542
4386
|
* @name updateCouponPartially
|
|
4543
|
-
* @summary:
|
|
4544
|
-
* @description:
|
|
4387
|
+
* @summary: Partially update a coupon.
|
|
4388
|
+
* @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/).
|
|
4545
4389
|
*/
|
|
4546
4390
|
async updateCouponPartially(
|
|
4547
4391
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4623,8 +4467,8 @@ class Cart {
|
|
|
4623
4467
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4624
4468
|
* @returns {Promise<CartPlatformModel.PriceAdjustmentResponse>} - Success response
|
|
4625
4469
|
* @name updatePriceAdjustment
|
|
4626
|
-
* @summary: Update price
|
|
4627
|
-
* @description:
|
|
4470
|
+
* @summary: Update price adjustments.
|
|
4471
|
+
* @description: Modify price adjustments for items in the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePriceAdjustment/).
|
|
4628
4472
|
*/
|
|
4629
4473
|
async updatePriceAdjustment(
|
|
4630
4474
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4704,8 +4548,8 @@ class Cart {
|
|
|
4704
4548
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4705
4549
|
* @returns {Promise<CartPlatformModel.PromotionUpdate>} - Success response
|
|
4706
4550
|
* @name updatePromotion
|
|
4707
|
-
* @summary: Update
|
|
4708
|
-
* @description:
|
|
4551
|
+
* @summary: Update a promotion.
|
|
4552
|
+
* @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/).
|
|
4709
4553
|
*/
|
|
4710
4554
|
async updatePromotion(
|
|
4711
4555
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4787,8 +4631,8 @@ class Cart {
|
|
|
4787
4631
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4788
4632
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
4789
4633
|
* @name updatePromotionPartially
|
|
4790
|
-
* @summary:
|
|
4791
|
-
* @description:
|
|
4634
|
+
* @summary: Partially update a promotion.
|
|
4635
|
+
* @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/).
|
|
4792
4636
|
*/
|
|
4793
4637
|
async updatePromotionPartially(
|
|
4794
4638
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4869,8 +4713,8 @@ class Cart {
|
|
|
4869
4713
|
* @returns {Promise<CartPlatformModel.PlatformCartShipmentsResponse>} -
|
|
4870
4714
|
* Success response
|
|
4871
4715
|
* @name updateShipments
|
|
4872
|
-
* @summary: Update shipment
|
|
4873
|
-
* @description:
|
|
4716
|
+
* @summary: Update shipment details.
|
|
4717
|
+
* @description: Modify the details and settings of cart shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateShipments/).
|
|
4874
4718
|
*/
|
|
4875
4719
|
async updateShipments(
|
|
4876
4720
|
{ body, i, p, id, addressId, areaCode, orderType, requestHeaders } = {
|
|
@@ -4970,8 +4814,8 @@ class Cart {
|
|
|
4970
4814
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4971
4815
|
* @returns {Promise<CartPlatformModel.PaymentCouponValidate>} - Success response
|
|
4972
4816
|
* @name validateCouponForPayment
|
|
4973
|
-
* @summary:
|
|
4974
|
-
* @description:
|
|
4817
|
+
* @summary: Validate a coupon for payment.
|
|
4818
|
+
* @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/).
|
|
4975
4819
|
*/
|
|
4976
4820
|
async validateCouponForPayment(
|
|
4977
4821
|
{
|