@gofynd/fdk-client-javascript 1.4.10 → 1.4.12

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.
Files changed (39) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +8 -19
  4. package/sdk/application/Cart/CartApplicationClient.js +8 -89
  5. package/sdk/application/Cart/CartApplicationModel.d.ts +1 -178
  6. package/sdk/application/Cart/CartApplicationModel.js +0 -92
  7. package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -20
  8. package/sdk/application/Cart/CartApplicationValidator.js +0 -16
  9. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +5 -0
  10. package/sdk/application/Configuration/ConfigurationApplicationModel.js +2 -0
  11. package/sdk/application/Logistic/LogisticApplicationModel.js +3 -3
  12. package/sdk/application/Order/OrderApplicationModel.js +1 -1
  13. package/sdk/application/Payment/PaymentApplicationModel.js +2 -2
  14. package/sdk/common/Clickstream.js +34 -15
  15. package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -1
  16. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +8 -20
  17. package/sdk/platform/Cart/CartPlatformApplicationClient.js +8 -92
  18. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -15
  19. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +0 -14
  20. package/sdk/platform/Cart/CartPlatformModel.d.ts +1 -87
  21. package/sdk/platform/Cart/CartPlatformModel.js +0 -88
  22. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
  23. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +14 -3
  24. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +27 -3
  25. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +14 -2
  26. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +10 -51
  27. package/sdk/platform/Catalog/CatalogPlatformClient.js +79 -400
  28. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -240
  29. package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -169
  30. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +15 -61
  31. package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -65
  32. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +5 -0
  33. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2 -0
  34. package/sdk/platform/Finance/FinancePlatformModel.js +1 -1
  35. package/sdk/platform/Order/OrderPlatformModel.d.ts +90 -39
  36. package/sdk/platform/Order/OrderPlatformModel.js +74 -38
  37. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +38 -4
  38. package/sdk/platform/Payment/PaymentPlatformModel.js +17 -7
  39. package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
@@ -40,13 +40,6 @@ const CartApplicationModel = require("./CartApplicationModel");
40
40
  * @property {CartApplicationModel.RewardPointRequest} body
41
41
  */
42
42
 
43
- /**
44
- * @typedef CheckoutCartParam
45
- * @property {boolean} [buyNow] - This indicates the type of cart to checkout.
46
- * @property {string} [cartType] - The type of cart.
47
- * @property {CartApplicationModel.CartCheckoutDetailRequest} body
48
- */
49
-
50
43
  /**
51
44
  * @typedef CheckoutCartV2Param
52
45
  * @property {boolean} [buyNow] - This indicates the type of cart to checkout.
@@ -296,15 +289,6 @@ class CartApplicationValidator {
296
289
  }).required();
297
290
  }
298
291
 
299
- /** @returns {CheckoutCartParam} */
300
- static checkoutCart() {
301
- return Joi.object({
302
- buyNow: Joi.boolean(),
303
- cartType: Joi.string().allow(""),
304
- body: CartApplicationModel.CartCheckoutDetailRequest().required(),
305
- }).required();
306
- }
307
-
308
292
  /** @returns {CheckoutCartV2Param} */
309
293
  static checkoutCartV2() {
310
294
  return Joi.object({
@@ -222,6 +222,7 @@ export = ConfigurationApplicationModel;
222
222
  */
223
223
  /**
224
224
  * @typedef GoogleMap
225
+ * @property {boolean} [enabled] - Shows whether Google map integration is enabled or not.
225
226
  * @property {GoogleMapCredentials} [credentials]
226
227
  */
227
228
  /**
@@ -1253,6 +1254,10 @@ type FyndRewardsCredentials = {
1253
1254
  /** @returns {GoogleMap} */
1254
1255
  declare function GoogleMap(): GoogleMap;
1255
1256
  type GoogleMap = {
1257
+ /**
1258
+ * - Shows whether Google map integration is enabled or not.
1259
+ */
1260
+ enabled?: boolean;
1256
1261
  credentials?: GoogleMapCredentials;
1257
1262
  };
1258
1263
  /** @returns {GoogleMapCredentials} */
@@ -252,6 +252,7 @@ const Joi = require("joi");
252
252
 
253
253
  /**
254
254
  * @typedef GoogleMap
255
+ * @property {boolean} [enabled] - Shows whether Google map integration is enabled or not.
255
256
  * @property {GoogleMapCredentials} [credentials]
256
257
  */
257
258
 
@@ -1174,6 +1175,7 @@ class ConfigurationApplicationModel {
1174
1175
  /** @returns {GoogleMap} */
1175
1176
  static GoogleMap() {
1176
1177
  return Joi.object({
1178
+ enabled: Joi.boolean(),
1177
1179
  credentials: ConfigurationApplicationModel.GoogleMapCredentials(),
1178
1180
  });
1179
1181
  }
@@ -964,7 +964,7 @@ class LogisticApplicationModel {
964
964
  return Joi.object({
965
965
  operation_id: Joi.string().allow(""),
966
966
  params: LogisticApplicationModel.GetOneOrAllParams(),
967
- });
967
+ }).allow(null);
968
968
  }
969
969
 
970
970
  /** @returns {LengthValidation} */
@@ -988,7 +988,7 @@ class LogisticApplicationModel {
988
988
  return Joi.object({
989
989
  type: Joi.string().allow(""),
990
990
  regex: LogisticApplicationModel.FieldValidationRegex(),
991
- });
991
+ }).allow(null);
992
992
  }
993
993
 
994
994
  /** @returns {GetCountryFieldsAddressValues} */
@@ -996,7 +996,7 @@ class LogisticApplicationModel {
996
996
  return Joi.object({
997
997
  get_one: LogisticApplicationModel.GetOneOrAll(),
998
998
  get_all: LogisticApplicationModel.GetOneOrAll(),
999
- });
999
+ }).allow(null);
1000
1000
  }
1001
1001
 
1002
1002
  /** @returns {GetCountryFieldsAddress} */
@@ -1016,7 +1016,7 @@ class OrderApplicationModel {
1016
1016
  static Article() {
1017
1017
  return Joi.object({
1018
1018
  tags: Joi.array().items(Joi.string().allow("")),
1019
- });
1019
+ }).allow(null);
1020
1020
  }
1021
1021
 
1022
1022
  /** @returns {Address} */
@@ -1597,7 +1597,7 @@ class PaymentApplicationModel {
1597
1597
  .items(Joi.string().allow("").allow(null))
1598
1598
  .allow(null, ""),
1599
1599
  allow_custom_advance_amount: Joi.boolean().allow(null),
1600
- });
1600
+ }).allow(null);
1601
1601
  }
1602
1602
 
1603
1603
  /** @returns {SplitObject} */
@@ -1606,7 +1606,7 @@ class PaymentApplicationModel {
1606
1606
  total_number_of_splits: Joi.number().allow(null),
1607
1607
  splits_remaining: Joi.number().allow(null),
1608
1608
  amount_remaining: Joi.number().allow(null),
1609
- });
1609
+ }).allow(null);
1610
1610
  }
1611
1611
 
1612
1612
  /** @returns {AdvancePaymentObject} */
@@ -20,40 +20,59 @@ const sg = function safeGet(fn, defaultValue = null) {
20
20
  * Safely extracts search query and click position
21
21
  *
22
22
  * @author Hitendra Singh
23
- * @param {Object} [defaultValue] - Utm_params
24
- * @returns {Object} - Query and position
23
+ * @property {string | null} query - Extracted search query if available, otherwise null
24
+ * @property {string | null} position - Click position from the decoded UTM
25
+ * content, otherwise null
26
+ * @property {string | null} utm_medium - The medium of the UTM (e.g.,
27
+ * 'product_recommendation'), otherwise null
28
+ * @property {string | null} utm_source - The source of the UTM (e.g.,
29
+ * 'product_page'), otherwise null
30
+ * @property {string | null} utm_campaign - The campaign of the UTM (e.g.,
31
+ * 'trending_products'), otherwise null
32
+ * @param {Object} [utm_params] - Object containing UTM parameters (utm_medium,
33
+ * utm_source, utm_campaign, utm_content)
34
+ * @returns {Object} - An object with the following properties:
25
35
  */
26
36
  const fetchPositionAndQuery = function (utm_params) {
27
37
  if (!utm_params || !Object.keys(utm_params).length) {
28
38
  return {
29
39
  query: null,
30
40
  position: null,
41
+ utm_medium: null,
42
+ utm_source: null,
43
+ utm_campaign: null,
31
44
  };
32
45
  }
33
46
 
34
- if (utm_params.utm_medium === "search") {
47
+ const {
48
+ utm_medium = null,
49
+ utm_source = null,
50
+ utm_campaign = null,
51
+ } = utm_params;
52
+ let query = null;
53
+ let position = null;
54
+ const queryResult = {
55
+ query,
56
+ position,
57
+ utm_medium,
58
+ utm_source,
59
+ utm_campaign,
60
+ };
61
+ if (utm_medium === "search") {
35
62
  try {
36
63
  const decodedUri = utm_params.utm_content
37
64
  ? atob(utm_params.utm_content)
38
65
  : null;
39
66
  if (decodedUri) {
40
67
  const parts = decodedUri.split(":::");
41
- return {
42
- query: parts[0] || null,
43
- position: parts[1] || null,
44
- };
68
+ queryResult.query = parts[0] || null;
69
+ queryResult.position = parts[1] || null;
45
70
  }
46
71
  } catch (err) {
47
- return {
48
- query: null,
49
- position: null,
50
- };
72
+ return queryResult;
51
73
  }
52
74
  }
53
- return {
54
- query: null,
55
- position: null,
56
- };
75
+ return queryResult;
57
76
  };
58
77
  /**
59
78
  * Safely extracts company details from window object
@@ -382,7 +382,7 @@ class WebhookPartnerModel {
382
382
  static UploadServiceObject() {
383
383
  return Joi.object({
384
384
  cdn: WebhookPartnerModel.CdnObject(),
385
- });
385
+ }).allow(null);
386
386
  }
387
387
 
388
388
  /** @returns {HistoryAssociation} */
@@ -9,7 +9,7 @@ declare class Cart {
9
9
  * @param {import("../PlatformAPIClient").Options} - Options
10
10
  * @returns {Promise<CartPlatformModel.SaveAddressResponse>} - Success response
11
11
  * @name addAddress
12
- * @summary: Create a new address
12
+ * @summary: Creates a new address for a customer
13
13
  * @description: Customers can add a new address to their cart to save details such as name, email, contact information, and address. - 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>;
@@ -159,7 +159,7 @@ declare class Cart {
159
159
  * @param {import("../PlatformAPIClient").Options} - Options
160
160
  * @returns {Promise<CartPlatformModel.PlatformAddress>} - Success response
161
161
  * @name getAddressById
162
- * @summary: Get a address
162
+ * @summary: Get details for a single customer address
163
163
  * @description: Retrieve a specific customer address stored in the system by providing its unique identifier. This API provides detailed information about the address, including the recipient's name, address, city, postal code, and other relevant details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAddressById/).
164
164
  */
165
165
  getAddressById({ id, cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, userId, requestHeaders, }?: CartPlatformApplicationValidator.GetAddressByIdParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformAddress>;
@@ -170,7 +170,7 @@ declare class Cart {
170
170
  * @returns {Promise<CartPlatformModel.PlatformGetAddressesResponse>} -
171
171
  * Success response
172
172
  * @name getAddresses
173
- * @summary: List customer addresses
173
+ * @summary: Get a list of addresses for a customer
174
174
  * @description: Retrieves a list of all addresses saved by the customer, simplifying the checkout process by offering pre-saved address options for delivery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAddresses/).
175
175
  */
176
176
  getAddresses({ cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, userId, requestHeaders, }?: CartPlatformApplicationValidator.GetAddressesParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformGetAddressesResponse>;
@@ -408,18 +408,6 @@ declare class Cart {
408
408
  * @description: Add product items to the customer's existing shopping cart. If there is no existing cart associated with the customer, it creates a new one and adds the items to it. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformAddItems/).
409
409
  */
410
410
  platformAddItems({ body, i, b, buyNow, orderType, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformAddItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.AddCartDetailResponse>;
411
- /**
412
- * @param {CartPlatformApplicationValidator.PlatformCheckoutCartParam} arg
413
- * - Arg object
414
- *
415
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
416
- * @param {import("../PlatformAPIClient").Options} - Options
417
- * @returns {Promise<CartPlatformModel.CartCheckoutResponse>} - Success response
418
- * @name platformCheckoutCart
419
- * @summary: Checkout cart
420
- * @description: The checkout cart initiates the order creation process based on the selected address and payment method. It revalidates the cart details to ensure safe and seamless order placement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCart/).
421
- */
422
- platformCheckoutCart({ body, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformCheckoutCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartCheckoutResponse>;
423
411
  /**
424
412
  * @param {CartPlatformApplicationValidator.PlatformCheckoutCartV2Param} arg
425
413
  * - Arg object
@@ -428,8 +416,8 @@ declare class Cart {
428
416
  * @param {import("../PlatformAPIClient").Options} - Options
429
417
  * @returns {Promise<CartPlatformModel.CartCheckoutResponse>} - Success response
430
418
  * @name platformCheckoutCartV2
431
- * @summary: Cart checkout (latest)
432
- * @description: Checkout process that supports multiple MOP(mode of payment). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCartV2/).
419
+ * @summary: Checkout cart
420
+ * @description: The checkout cart initiates the order creation process based on the items in the user’s cart, their selected address, and chosen payment methods. It also supports multiple payment method options and revalidates the cart details to ensure a secure and seamless order placement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCartV2/).
433
421
  */
434
422
  platformCheckoutCartV2({ body, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformCheckoutCartV2Param, { responseHeaders }?: object): Promise<CartPlatformModel.CartCheckoutResponse>;
435
423
  /**
@@ -448,7 +436,7 @@ declare class Cart {
448
436
  * @param {import("../PlatformAPIClient").Options} - Options
449
437
  * @returns {Promise<CartPlatformModel.DeleteAddressResponse>} - Success response
450
438
  * @name removeAddress
451
- * @summary: Delete a address
439
+ * @summary: Removes an address from a customer's address list
452
440
  * @description: Remove an existing customer address from the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removeAddress/).
453
441
  */
454
442
  removeAddress({ id, userId, requestHeaders }?: CartPlatformApplicationValidator.RemoveAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.DeleteAddressResponse>;
@@ -480,7 +468,7 @@ declare class Cart {
480
468
  * @param {import("../PlatformAPIClient").Options} - Options
481
469
  * @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
482
470
  * @name selectAddress
483
- * @summary: select a delivery address
471
+ * @summary: Select customer address for order processing
484
472
  * @description: Select an address from the saved customer addresses and validates the availability of items in the cart. Additionally, it verifies and updates the delivery promise based on the selected address. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/selectAddress/).
485
473
  */
486
474
  selectAddress({ body, cartId, buyNow, i, b, requestHeaders }?: CartPlatformApplicationValidator.SelectAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
@@ -510,7 +498,7 @@ declare class Cart {
510
498
  * @param {import("../PlatformAPIClient").Options} - Options
511
499
  * @returns {Promise<CartPlatformModel.UpdateAddressResponse>} - Success response
512
500
  * @name updateAddress
513
- * @summary: Update address
501
+ * @summary: Updates an existing customer address
514
502
  * @description: Update the user address - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateAddress/).
515
503
  */
516
504
  updateAddress({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdateAddressResponse>;
@@ -21,7 +21,7 @@ class Cart {
21
21
  * @param {import("../PlatformAPIClient").Options} - Options
22
22
  * @returns {Promise<CartPlatformModel.SaveAddressResponse>} - Success response
23
23
  * @name addAddress
24
- * @summary: Create a new address
24
+ * @summary: Creates a new address for a customer
25
25
  * @description: Customers can add a new address to their cart to save details such as name, email, contact information, and address. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addAddress/).
26
26
  */
27
27
  async addAddress(
@@ -1182,7 +1182,7 @@ class Cart {
1182
1182
  * @param {import("../PlatformAPIClient").Options} - Options
1183
1183
  * @returns {Promise<CartPlatformModel.PlatformAddress>} - Success response
1184
1184
  * @name getAddressById
1185
- * @summary: Get a address
1185
+ * @summary: Get details for a single customer address
1186
1186
  * @description: Retrieve a specific customer address stored in the system by providing its unique identifier. This API provides detailed information about the address, including the recipient's name, address, city, postal code, and other relevant details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAddressById/).
1187
1187
  */
1188
1188
  async getAddressById(
@@ -1293,7 +1293,7 @@ class Cart {
1293
1293
  * @returns {Promise<CartPlatformModel.PlatformGetAddressesResponse>} -
1294
1294
  * Success response
1295
1295
  * @name getAddresses
1296
- * @summary: List customer addresses
1296
+ * @summary: Get a list of addresses for a customer
1297
1297
  * @description: Retrieves a list of all addresses saved by the customer, simplifying the checkout process by offering pre-saved address options for delivery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAddresses/).
1298
1298
  */
1299
1299
  async getAddresses(
@@ -3302,90 +3302,6 @@ class Cart {
3302
3302
  return response;
3303
3303
  }
3304
3304
 
3305
- /**
3306
- * @param {CartPlatformApplicationValidator.PlatformCheckoutCartParam} arg
3307
- * - Arg object
3308
- *
3309
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
3310
- * @param {import("../PlatformAPIClient").Options} - Options
3311
- * @returns {Promise<CartPlatformModel.CartCheckoutResponse>} - Success response
3312
- * @name platformCheckoutCart
3313
- * @summary: Checkout cart
3314
- * @description: The checkout cart initiates the order creation process based on the selected address and payment method. It revalidates the cart details to ensure safe and seamless order placement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCart/).
3315
- */
3316
- async platformCheckoutCart(
3317
- { body, id, requestHeaders } = { requestHeaders: {} },
3318
- { responseHeaders } = { responseHeaders: false }
3319
- ) {
3320
- const {
3321
- error,
3322
- } = CartPlatformApplicationValidator.platformCheckoutCart().validate(
3323
- {
3324
- body,
3325
- id,
3326
- },
3327
- { abortEarly: false, allowUnknown: true }
3328
- );
3329
- if (error) {
3330
- return Promise.reject(new FDKClientValidationError(error));
3331
- }
3332
-
3333
- // Showing warrnings if extra unknown parameters are found
3334
- const {
3335
- error: warrning,
3336
- } = CartPlatformApplicationValidator.platformCheckoutCart().validate(
3337
- {
3338
- body,
3339
- id,
3340
- },
3341
- { abortEarly: false, allowUnknown: false }
3342
- );
3343
- if (warrning) {
3344
- Logger({
3345
- level: "WARN",
3346
- message: `Parameter Validation warrnings for platform > Cart > platformCheckoutCart \n ${warrning}`,
3347
- });
3348
- }
3349
-
3350
- const query_params = {};
3351
- query_params["id"] = id;
3352
-
3353
- const response = await PlatformAPIClient.execute(
3354
- this.config,
3355
- "post",
3356
- `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/checkout`,
3357
- query_params,
3358
- body,
3359
- requestHeaders,
3360
- { responseHeaders }
3361
- );
3362
-
3363
- let responseData = response;
3364
- if (responseHeaders) {
3365
- responseData = response[0];
3366
- }
3367
-
3368
- const {
3369
- error: res_error,
3370
- } = CartPlatformModel.CartCheckoutResponse().validate(responseData, {
3371
- abortEarly: false,
3372
- allowUnknown: true,
3373
- });
3374
-
3375
- if (res_error) {
3376
- if (this.config.options.strictResponseCheck === true) {
3377
- return Promise.reject(new FDKResponseValidationError(res_error));
3378
- } else {
3379
- Logger({
3380
- level: "WARN",
3381
- message: `Response Validation Warnings for platform > Cart > platformCheckoutCart \n ${res_error}`,
3382
- });
3383
- }
3384
- }
3385
-
3386
- return response;
3387
- }
3388
-
3389
3305
  /**
3390
3306
  * @param {CartPlatformApplicationValidator.PlatformCheckoutCartV2Param} arg
3391
3307
  * - Arg object
@@ -3394,8 +3310,8 @@ class Cart {
3394
3310
  * @param {import("../PlatformAPIClient").Options} - Options
3395
3311
  * @returns {Promise<CartPlatformModel.CartCheckoutResponse>} - Success response
3396
3312
  * @name platformCheckoutCartV2
3397
- * @summary: Cart checkout (latest)
3398
- * @description: Checkout process that supports multiple MOP(mode of payment). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCartV2/).
3313
+ * @summary: Checkout cart
3314
+ * @description: The checkout cart initiates the order creation process based on the items in the user’s cart, their selected address, and chosen payment methods. It also supports multiple payment method options and revalidates the cart details to ensure a secure and seamless order placement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCartV2/).
3399
3315
  */
3400
3316
  async platformCheckoutCartV2(
3401
3317
  { body, id, requestHeaders } = { requestHeaders: {} },
@@ -3572,7 +3488,7 @@ class Cart {
3572
3488
  * @param {import("../PlatformAPIClient").Options} - Options
3573
3489
  * @returns {Promise<CartPlatformModel.DeleteAddressResponse>} - Success response
3574
3490
  * @name removeAddress
3575
- * @summary: Delete a address
3491
+ * @summary: Removes an address from a customer's address list
3576
3492
  * @description: Remove an existing customer address from the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removeAddress/).
3577
3493
  */
3578
3494
  async removeAddress(
@@ -3814,7 +3730,7 @@ class Cart {
3814
3730
  * @param {import("../PlatformAPIClient").Options} - Options
3815
3731
  * @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
3816
3732
  * @name selectAddress
3817
- * @summary: select a delivery address
3733
+ * @summary: Select customer address for order processing
3818
3734
  * @description: Select an address from the saved customer addresses and validates the availability of items in the cart. Additionally, it verifies and updates the delivery promise based on the selected address. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/selectAddress/).
3819
3735
  */
3820
3736
  async selectAddress(
@@ -4079,7 +3995,7 @@ class Cart {
4079
3995
  * @param {import("../PlatformAPIClient").Options} - Options
4080
3996
  * @returns {Promise<CartPlatformModel.UpdateAddressResponse>} - Success response
4081
3997
  * @name updateAddress
4082
- * @summary: Update address
3998
+ * @summary: Updates an existing customer address
4083
3999
  * @description: Update the user address - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateAddress/).
4084
4000
  */
4085
4001
  async updateAddress(
@@ -236,11 +236,6 @@ export = CartPlatformApplicationValidator;
236
236
  * @property {string} [id] - The unique identifier of the cart
237
237
  * @property {CartPlatformModel.PlatformAddCartRequest} body
238
238
  */
239
- /**
240
- * @typedef PlatformCheckoutCartParam
241
- * @property {string} [id] - The unique identifier of the cart
242
- * @property {CartPlatformModel.PlatformCartCheckoutDetailRequest} body
243
- */
244
239
  /**
245
240
  * @typedef PlatformCheckoutCartV2Param
246
241
  * @property {string} [id] - The unique identifier of the cart
@@ -460,8 +455,6 @@ declare class CartPlatformApplicationValidator {
460
455
  static overrideCart(): OverrideCartParam;
461
456
  /** @returns {PlatformAddItemsParam} */
462
457
  static platformAddItems(): PlatformAddItemsParam;
463
- /** @returns {PlatformCheckoutCartParam} */
464
- static platformCheckoutCart(): PlatformCheckoutCartParam;
465
458
  /** @returns {PlatformCheckoutCartV2Param} */
466
459
  static platformCheckoutCartV2(): PlatformCheckoutCartV2Param;
467
460
  /** @returns {PlatformUpdateCartParam} */
@@ -506,7 +499,7 @@ declare class CartPlatformApplicationValidator {
506
499
  static validateCouponForPayment(): ValidateCouponForPaymentParam;
507
500
  }
508
501
  declare namespace CartPlatformApplicationValidator {
509
- export { AddAddressParam, AddItemsParam, AddPriceAdjustmentParam, ApplyCouponParam, CheckCartServiceabilityParam, CheckoutCartParam, CreateCartMetaConfigParam, CreateCouponParam, CreatePromotionParam, DeleteCartParam, FetchAndvalidateCartItemsParam, FetchCartMetaConfigParam, GetAbandonedCartParam, GetAbandonedCartDetailsParam, GetAddressByIdParam, GetAddressesParam, GetAppCouponsParam, GetAvailableDeliveryModesParam, GetCartParam, GetCartListParam, GetCartShareLinkParam, GetCartSharedItemsParam, GetCouponByIdParam, GetCouponCodeExistsParam, GetCouponOptionValuesParam, GetCouponsParam, GetItemCountParam, GetPriceAdjustmentsParam, GetPromosCouponConfigParam, GetPromotionByIdParam, GetPromotionCodeExistsParam, GetPromotionOffersParam, GetPromotionPaymentOffersParam, GetPromotionsParam, GetShipmentsParam, GetStoreAddressByUidParam, OverrideCartParam, PlatformAddItemsParam, PlatformCheckoutCartParam, PlatformCheckoutCartV2Param, PlatformUpdateCartParam, RemoveAddressParam, RemoveCouponParam, RemovePriceAdjustmentParam, SelectAddressParam, SelectPaymentModeParam, SelectPaymentModeV2Param, UpdateAddressParam, UpdateCartParam, UpdateCartMetaParam, UpdateCartMetaConfigParam, UpdateCartUserParam, UpdateCartWithSharedItemsParam, UpdateCouponParam, UpdateCouponPartiallyParam, UpdatePriceAdjustmentParam, UpdatePromotionParam, UpdatePromotionPartiallyParam, UpdateShipmentsParam, ValidateCouponForPaymentParam };
502
+ export { AddAddressParam, AddItemsParam, AddPriceAdjustmentParam, ApplyCouponParam, CheckCartServiceabilityParam, CheckoutCartParam, CreateCartMetaConfigParam, CreateCouponParam, CreatePromotionParam, DeleteCartParam, FetchAndvalidateCartItemsParam, FetchCartMetaConfigParam, GetAbandonedCartParam, GetAbandonedCartDetailsParam, GetAddressByIdParam, GetAddressesParam, GetAppCouponsParam, GetAvailableDeliveryModesParam, GetCartParam, GetCartListParam, GetCartShareLinkParam, GetCartSharedItemsParam, GetCouponByIdParam, GetCouponCodeExistsParam, GetCouponOptionValuesParam, GetCouponsParam, GetItemCountParam, GetPriceAdjustmentsParam, GetPromosCouponConfigParam, GetPromotionByIdParam, GetPromotionCodeExistsParam, GetPromotionOffersParam, GetPromotionPaymentOffersParam, GetPromotionsParam, GetShipmentsParam, GetStoreAddressByUidParam, OverrideCartParam, PlatformAddItemsParam, PlatformCheckoutCartV2Param, PlatformUpdateCartParam, RemoveAddressParam, RemoveCouponParam, RemovePriceAdjustmentParam, SelectAddressParam, SelectPaymentModeParam, SelectPaymentModeV2Param, UpdateAddressParam, UpdateCartParam, UpdateCartMetaParam, UpdateCartMetaConfigParam, UpdateCartUserParam, UpdateCartWithSharedItemsParam, UpdateCouponParam, UpdateCouponPartiallyParam, UpdatePriceAdjustmentParam, UpdatePromotionParam, UpdatePromotionPartiallyParam, UpdateShipmentsParam, ValidateCouponForPaymentParam };
510
503
  }
511
504
  type AddAddressParam = {
512
505
  body: CartPlatformModel.PlatformAddress;
@@ -806,13 +799,6 @@ type PlatformAddItemsParam = {
806
799
  id?: string;
807
800
  body: CartPlatformModel.PlatformAddCartRequest;
808
801
  };
809
- type PlatformCheckoutCartParam = {
810
- /**
811
- * - The unique identifier of the cart
812
- */
813
- id?: string;
814
- body: CartPlatformModel.PlatformCartCheckoutDetailRequest;
815
- };
816
802
  type PlatformCheckoutCartV2Param = {
817
803
  /**
818
804
  * - The unique identifier of the cart
@@ -277,12 +277,6 @@ const CartPlatformModel = require("./CartPlatformModel");
277
277
  * @property {CartPlatformModel.PlatformAddCartRequest} body
278
278
  */
279
279
 
280
- /**
281
- * @typedef PlatformCheckoutCartParam
282
- * @property {string} [id] - The unique identifier of the cart
283
- * @property {CartPlatformModel.PlatformCartCheckoutDetailRequest} body
284
- */
285
-
286
280
  /**
287
281
  * @typedef PlatformCheckoutCartV2Param
288
282
  * @property {string} [id] - The unique identifier of the cart
@@ -784,14 +778,6 @@ class CartPlatformApplicationValidator {
784
778
  }).required();
785
779
  }
786
780
 
787
- /** @returns {PlatformCheckoutCartParam} */
788
- static platformCheckoutCart() {
789
- return Joi.object({
790
- id: Joi.string().allow(""),
791
- body: CartPlatformModel.PlatformCartCheckoutDetailRequest().required(),
792
- }).required();
793
- }
794
-
795
781
  /** @returns {PlatformCheckoutCartV2Param} */
796
782
  static platformCheckoutCartV2() {
797
783
  return Joi.object({
@@ -1538,45 +1538,6 @@ export = CartPlatformModel;
1538
1538
  * @property {string} key
1539
1539
  * @property {string[]} values
1540
1540
  */
1541
- /**
1542
- * @typedef CartCheckoutCustomMeta
1543
- * @property {string} key
1544
- * @property {string} value
1545
- */
1546
- /**
1547
- * @typedef PlatformCartCheckoutDetailRequest
1548
- * @property {CartCheckoutCustomMeta[]} [custom_meta]
1549
- * @property {string} [address_id]
1550
- * @property {string} [payment_identifier]
1551
- * @property {Object} [payment_params]
1552
- * @property {boolean} [payment_auto_confirm]
1553
- * @property {string} id
1554
- * @property {boolean} [pos]
1555
- * @property {string} [billing_address_id]
1556
- * @property {string} [merchant_code]
1557
- * @property {string} [aggregator]
1558
- * @property {number} [pick_at_store_uid]
1559
- * @property {string} [device_id]
1560
- * @property {Object} [delivery_address]
1561
- * @property {string} payment_mode
1562
- * @property {string} [checkout_mode]
1563
- * @property {Object} [customer_details] - Customer details
1564
- * @property {Object} [meta]
1565
- * @property {StaffCheckout} [staff]
1566
- * @property {string} [employee_code]
1567
- * @property {Object} [billing_address]
1568
- * @property {string} [callback_url]
1569
- * @property {string} user_id
1570
- * @property {Object} [extra_meta]
1571
- * @property {string} order_type
1572
- * @property {Files[]} [files] - List of file url
1573
- * @property {number} [ordering_store]
1574
- * @property {Object} [payment_extra_identifiers]
1575
- * @property {string} [iin]
1576
- * @property {string} [network]
1577
- * @property {string} [type]
1578
- * @property {string} [card_id]
1579
- */
1580
1541
  /**
1581
1542
  * @typedef CheckCart
1582
1543
  * @property {string} [coupon_text]
@@ -1792,7 +1753,7 @@ export = CartPlatformModel;
1792
1753
  declare class CartPlatformModel {
1793
1754
  }
1794
1755
  declare namespace CartPlatformModel {
1795
- export { CouponDateMeta, Ownership, CouponAuthor, State, PaymentAllowValue, PaymentModes, PriceRange, PostOrder, BulkBundleRestriction, UsesRemaining, UsesRestriction, Restrictions, Validation, CouponAction, CouponSchedule, Rule, DisplayMetaDict, DisplayMeta, Identifier, Validity, RuleDefinition, CouponAdd, Page, CouponsResponse, SuccessMessage, OperationErrorResponse, CouponUpdate, CouponPartialUpdate, DisplayMeta1, Ownership1, CompareObject, ItemCriteria, DiscountOffer, DiscountRule, PaymentAllowValue1, PromotionPaymentModes, UserRegistered, PostOrder1, UsesRemaining1, UsesRestriction1, Restrictions1, PromotionSchedule, PromotionAction, PromotionAuthor, Visibility, PromotionDateMeta, PromotionListItem, PromotionsResponse, PromotionAdd, PromotionUpdate, PromotionPartialUpdate, ActivePromosResponse, Charges, DeliveryCharges, CartMetaConfigUpdate, CartMetaConfigAdd, Article, PriceAdjustmentRestrictions, Collection, PriceAdjustmentUpdate, PriceAdjustment, PriceAdjustmentResponse, GetPriceAdjustmentResponse, PriceAdjustmentAdd, CartItem, OpenapiCartDetailsRequest, CouponBreakup, DisplayBreakup, LoyaltyPoints, RawBreakup, CartBreakup, ProductImage, Tags, BaseInfo, ActionQuery, ProductAction, CategoryInfo, CartProduct, BasePrice, ArticlePriceInfo, StoreInfo, ProductArticle, Ownership2, DiscountRulesApp, AppliedFreeArticles, BuyRules, AppliedPromotion, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, CouponDetails, ProductPrice, ProductPriceInfo, CartProductIdentifer, ProductAvailabilitySize, ProductAvailability, PromoMeta, CartProductInfo, OpenapiCartDetailsResponse, OpenApiErrorResponse, ShippingAddress, OpenApiCartServiceabilityRequest, OpenApiCartServiceabilityResponse, OpenApiFiles, CartItemMeta, MultiTenderPaymentMeta, MultiTenderPaymentMethod, OpenApiOrderItem, OpenApiPlatformCheckoutReq, OpenApiCheckoutResponse, AbandonedCart, AbandonedCartResponse, PaymentSelectionLock, CartCurrency, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig, CartDetailResponse, AddProductCart, AddCartRequest, AddCartDetailResponse, UpdateProductCart, UpdateCartRequest, UpdateCartDetailResponse, OverrideCartItemPromo, OverrideCartItem, OverrideCheckoutReq, OverrideCheckoutResponse, GetShareCartLinkRequest, GetShareCartLinkResponse, SharedCartDetails, SharedCart, SharedCartResponse, CartList, MultiCartResponse, UpdateUserCartMapping, UserInfo, UserCartMappingResponse, PlatformAddCartRequest, PlatformUpdateCartRequest, DeleteCartRequest, DeleteCartDetailResponse, CartItemCountResponse, Coupon, PageCoupon, GetCouponResponse, ApplyCouponRequest, GeoLocation, PlatformAddress, PlatformGetAddressesResponse, SaveAddressResponse, UpdateAddressResponse, DeleteAddressResponse, PlatformSelectCartAddressRequest, ShipmentArticle, PlatformShipmentResponse, PlatformCartShipmentsResponse, UpdateCartShipmentItem, UpdateCartShipmentRequest, PlatformCartMetaRequest, CartMetaResponse, CartMetaMissingResponse, StaffCheckout, CustomerDetails, Files, CartCheckoutCustomMeta, PlatformCartCheckoutDetailRequest, CheckCart, CartCheckoutResponse, CartDeliveryModesResponse, PickupStoreDetail, StoreDetailsResponse, UpdateCartPaymentRequest, CouponValidity, PaymentCouponValidate, PaymentMeta, PaymentMethod, PlatformCartCheckoutDetailV2Request, UpdateCartPaymentRequestV2, PriceMinMax, ItemPriceDetails, FreeGiftItems, PromotionOffer, PromotionOffersResponse, PromotionPaymentOffer, PromotionPaymentOffersResponse };
1756
+ export { CouponDateMeta, Ownership, CouponAuthor, State, PaymentAllowValue, PaymentModes, PriceRange, PostOrder, BulkBundleRestriction, UsesRemaining, UsesRestriction, Restrictions, Validation, CouponAction, CouponSchedule, Rule, DisplayMetaDict, DisplayMeta, Identifier, Validity, RuleDefinition, CouponAdd, Page, CouponsResponse, SuccessMessage, OperationErrorResponse, CouponUpdate, CouponPartialUpdate, DisplayMeta1, Ownership1, CompareObject, ItemCriteria, DiscountOffer, DiscountRule, PaymentAllowValue1, PromotionPaymentModes, UserRegistered, PostOrder1, UsesRemaining1, UsesRestriction1, Restrictions1, PromotionSchedule, PromotionAction, PromotionAuthor, Visibility, PromotionDateMeta, PromotionListItem, PromotionsResponse, PromotionAdd, PromotionUpdate, PromotionPartialUpdate, ActivePromosResponse, Charges, DeliveryCharges, CartMetaConfigUpdate, CartMetaConfigAdd, Article, PriceAdjustmentRestrictions, Collection, PriceAdjustmentUpdate, PriceAdjustment, PriceAdjustmentResponse, GetPriceAdjustmentResponse, PriceAdjustmentAdd, CartItem, OpenapiCartDetailsRequest, CouponBreakup, DisplayBreakup, LoyaltyPoints, RawBreakup, CartBreakup, ProductImage, Tags, BaseInfo, ActionQuery, ProductAction, CategoryInfo, CartProduct, BasePrice, ArticlePriceInfo, StoreInfo, ProductArticle, Ownership2, DiscountRulesApp, AppliedFreeArticles, BuyRules, AppliedPromotion, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, CouponDetails, ProductPrice, ProductPriceInfo, CartProductIdentifer, ProductAvailabilitySize, ProductAvailability, PromoMeta, CartProductInfo, OpenapiCartDetailsResponse, OpenApiErrorResponse, ShippingAddress, OpenApiCartServiceabilityRequest, OpenApiCartServiceabilityResponse, OpenApiFiles, CartItemMeta, MultiTenderPaymentMeta, MultiTenderPaymentMethod, OpenApiOrderItem, OpenApiPlatformCheckoutReq, OpenApiCheckoutResponse, AbandonedCart, AbandonedCartResponse, PaymentSelectionLock, CartCurrency, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig, CartDetailResponse, AddProductCart, AddCartRequest, AddCartDetailResponse, UpdateProductCart, UpdateCartRequest, UpdateCartDetailResponse, OverrideCartItemPromo, OverrideCartItem, OverrideCheckoutReq, OverrideCheckoutResponse, GetShareCartLinkRequest, GetShareCartLinkResponse, SharedCartDetails, SharedCart, SharedCartResponse, CartList, MultiCartResponse, UpdateUserCartMapping, UserInfo, UserCartMappingResponse, PlatformAddCartRequest, PlatformUpdateCartRequest, DeleteCartRequest, DeleteCartDetailResponse, CartItemCountResponse, Coupon, PageCoupon, GetCouponResponse, ApplyCouponRequest, GeoLocation, PlatformAddress, PlatformGetAddressesResponse, SaveAddressResponse, UpdateAddressResponse, DeleteAddressResponse, PlatformSelectCartAddressRequest, ShipmentArticle, PlatformShipmentResponse, PlatformCartShipmentsResponse, UpdateCartShipmentItem, UpdateCartShipmentRequest, PlatformCartMetaRequest, CartMetaResponse, CartMetaMissingResponse, StaffCheckout, CustomerDetails, Files, CheckCart, CartCheckoutResponse, CartDeliveryModesResponse, PickupStoreDetail, StoreDetailsResponse, UpdateCartPaymentRequest, CouponValidity, PaymentCouponValidate, PaymentMeta, PaymentMethod, PlatformCartCheckoutDetailV2Request, UpdateCartPaymentRequestV2, PriceMinMax, ItemPriceDetails, FreeGiftItems, PromotionOffer, PromotionOffersResponse, PromotionPaymentOffer, PromotionPaymentOffersResponse };
1796
1757
  }
1797
1758
  /** @returns {CouponDateMeta} */
1798
1759
  declare function CouponDateMeta(): CouponDateMeta;
@@ -3902,53 +3863,6 @@ type Files = {
3902
3863
  key: string;
3903
3864
  values: string[];
3904
3865
  };
3905
- /** @returns {CartCheckoutCustomMeta} */
3906
- declare function CartCheckoutCustomMeta(): CartCheckoutCustomMeta;
3907
- type CartCheckoutCustomMeta = {
3908
- key: string;
3909
- value: string;
3910
- };
3911
- /** @returns {PlatformCartCheckoutDetailRequest} */
3912
- declare function PlatformCartCheckoutDetailRequest(): PlatformCartCheckoutDetailRequest;
3913
- type PlatformCartCheckoutDetailRequest = {
3914
- custom_meta?: CartCheckoutCustomMeta[];
3915
- address_id?: string;
3916
- payment_identifier?: string;
3917
- payment_params?: any;
3918
- payment_auto_confirm?: boolean;
3919
- id: string;
3920
- pos?: boolean;
3921
- billing_address_id?: string;
3922
- merchant_code?: string;
3923
- aggregator?: string;
3924
- pick_at_store_uid?: number;
3925
- device_id?: string;
3926
- delivery_address?: any;
3927
- payment_mode: string;
3928
- checkout_mode?: string;
3929
- /**
3930
- * - Customer details
3931
- */
3932
- customer_details?: any;
3933
- meta?: any;
3934
- staff?: StaffCheckout;
3935
- employee_code?: string;
3936
- billing_address?: any;
3937
- callback_url?: string;
3938
- user_id: string;
3939
- extra_meta?: any;
3940
- order_type: string;
3941
- /**
3942
- * - List of file url
3943
- */
3944
- files?: Files[];
3945
- ordering_store?: number;
3946
- payment_extra_identifiers?: any;
3947
- iin?: string;
3948
- network?: string;
3949
- type?: string;
3950
- card_id?: string;
3951
- };
3952
3866
  /** @returns {CheckCart} */
3953
3867
  declare function CheckCart(): CheckCart;
3954
3868
  type CheckCart = {