@gofynd/fdk-client-javascript 3.0.0 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +13 -13
  4. package/sdk/application/Cart/CartApplicationClient.js +48 -13
  5. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +15 -15
  6. package/sdk/platform/Cart/CartPlatformApplicationClient.js +63 -16
  7. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +105 -0
  8. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +60 -0
  9. package/sdk/platform/Cart/CartPlatformModel.d.ts +18 -1
  10. package/sdk/platform/Cart/CartPlatformModel.js +36 -0
  11. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6 -11
  12. package/sdk/platform/Catalog/CatalogPlatformModel.js +2 -19
  13. package/sdk/platform/Order/OrderPlatformClient.d.ts +3 -3
  14. package/sdk/platform/Order/OrderPlatformClient.js +18 -5
  15. package/sdk/platform/Order/OrderPlatformModel.d.ts +64 -12
  16. package/sdk/platform/Order/OrderPlatformModel.js +29 -7
  17. package/sdk/platform/Order/OrderPlatformValidator.d.ts +28 -3
  18. package/sdk/platform/Order/OrderPlatformValidator.js +13 -2
  19. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +1 -1
  20. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +3 -0
  21. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +7 -0
  22. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +4 -0
  23. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +1 -1
  24. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -3
  25. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +13 -3
  26. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +8 -2
@@ -263,12 +263,15 @@ class Cart {
263
263
  * @description: Apply a coupon code to the customer's cart to trigger discounts on eligible items - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/applyCoupon/).
264
264
  */
265
265
  async applyCoupon(
266
- { body, i, b, p, id, buyNow, requestHeaders } = { requestHeaders: {} },
266
+ { body, xOrderingSource, i, b, p, id, buyNow, requestHeaders } = {
267
+ requestHeaders: {},
268
+ },
267
269
  { responseHeaders } = { responseHeaders: false }
268
270
  ) {
269
271
  const { error } = CartPlatformApplicationValidator.applyCoupon().validate(
270
272
  {
271
273
  body,
274
+ xOrderingSource,
272
275
  i,
273
276
  b,
274
277
  p,
@@ -287,6 +290,7 @@ class Cart {
287
290
  } = CartPlatformApplicationValidator.applyCoupon().validate(
288
291
  {
289
292
  body,
293
+ xOrderingSource,
290
294
  i,
291
295
  b,
292
296
  p,
@@ -358,7 +362,7 @@ class Cart {
358
362
  * @description: Verify the serviceability of items in the cart at a specific pin code and ensure accurate delivery promises. System checks each item's availability and delivery feasibility, providing real-time information on serviceability and estimated delivery times. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/checkCartServiceability/).
359
363
  */
360
364
  async checkCartServiceability(
361
- { body, requestHeaders } = { requestHeaders: {} },
365
+ { body, xOrderingSource, requestHeaders } = { requestHeaders: {} },
362
366
  { responseHeaders } = { responseHeaders: false }
363
367
  ) {
364
368
  const {
@@ -366,6 +370,7 @@ class Cart {
366
370
  } = CartPlatformApplicationValidator.checkCartServiceability().validate(
367
371
  {
368
372
  body,
373
+ xOrderingSource,
369
374
  },
370
375
  { abortEarly: false, allowUnknown: true }
371
376
  );
@@ -379,6 +384,7 @@ class Cart {
379
384
  } = CartPlatformApplicationValidator.checkCartServiceability().validate(
380
385
  {
381
386
  body,
387
+ xOrderingSource,
382
388
  },
383
389
  { abortEarly: false, allowUnknown: false }
384
390
  );
@@ -437,12 +443,13 @@ class Cart {
437
443
  * @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/checkoutCart/).
438
444
  */
439
445
  async checkoutCart(
440
- { body, requestHeaders } = { requestHeaders: {} },
446
+ { body, xOrderingSource, requestHeaders } = { requestHeaders: {} },
441
447
  { responseHeaders } = { responseHeaders: false }
442
448
  ) {
443
449
  const { error } = CartPlatformApplicationValidator.checkoutCart().validate(
444
450
  {
445
451
  body,
452
+ xOrderingSource,
446
453
  },
447
454
  { abortEarly: false, allowUnknown: true }
448
455
  );
@@ -456,6 +463,7 @@ class Cart {
456
463
  } = CartPlatformApplicationValidator.checkoutCart().validate(
457
464
  {
458
465
  body,
466
+ xOrderingSource,
459
467
  },
460
468
  { abortEarly: false, allowUnknown: false }
461
469
  );
@@ -989,7 +997,7 @@ class Cart {
989
997
  * @description: Retrieve cart details for a provided list of cart items and validate its contents. This ensures accuracy and completeness in cart information, including item quantities, prices, discounts, and applicable taxes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/fetchAndvalidateCartItems/).
990
998
  */
991
999
  async fetchAndvalidateCartItems(
992
- { body, requestHeaders } = { requestHeaders: {} },
1000
+ { body, xOrderingSource, requestHeaders } = { requestHeaders: {} },
993
1001
  { responseHeaders } = { responseHeaders: false }
994
1002
  ) {
995
1003
  const {
@@ -997,6 +1005,7 @@ class Cart {
997
1005
  } = CartPlatformApplicationValidator.fetchAndvalidateCartItems().validate(
998
1006
  {
999
1007
  body,
1008
+ xOrderingSource,
1000
1009
  },
1001
1010
  { abortEarly: false, allowUnknown: true }
1002
1011
  );
@@ -1010,6 +1019,7 @@ class Cart {
1010
1019
  } = CartPlatformApplicationValidator.fetchAndvalidateCartItems().validate(
1011
1020
  {
1012
1021
  body,
1022
+ xOrderingSource,
1013
1023
  },
1014
1024
  { abortEarly: false, allowUnknown: false }
1015
1025
  );
@@ -1729,13 +1739,22 @@ class Cart {
1729
1739
  * @description: Retrieve details of a cart linked to a specific customer using either the customer's ID or a unique cart ID. It offers an overview of the items, quantities, prices, and other relevant information associated with the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCart/).
1730
1740
  */
1731
1741
  async getCart(
1732
- { id, userId, orderType, i, b, assignCardId, buyNow, requestHeaders } = {
1733
- requestHeaders: {},
1734
- },
1742
+ {
1743
+ xOrderingSource,
1744
+ id,
1745
+ userId,
1746
+ orderType,
1747
+ i,
1748
+ b,
1749
+ assignCardId,
1750
+ buyNow,
1751
+ requestHeaders,
1752
+ } = { requestHeaders: {} },
1735
1753
  { responseHeaders } = { responseHeaders: false }
1736
1754
  ) {
1737
1755
  const { error } = CartPlatformApplicationValidator.getCart().validate(
1738
1756
  {
1757
+ xOrderingSource,
1739
1758
  id,
1740
1759
  userId,
1741
1760
  orderType,
@@ -1755,6 +1774,7 @@ class Cart {
1755
1774
  error: warrning,
1756
1775
  } = CartPlatformApplicationValidator.getCart().validate(
1757
1776
  {
1777
+ xOrderingSource,
1758
1778
  id,
1759
1779
  userId,
1760
1780
  orderType,
@@ -3350,12 +3370,13 @@ class Cart {
3350
3370
  * @description: Overrides the cart's checkout process with a new provided cart items. It provides flexibility in customizing checkout flows to meet specific business requirements, enhancing the user experience and optimizing order processing workflows. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/overrideCart/).
3351
3371
  */
3352
3372
  async overrideCart(
3353
- { body, requestHeaders } = { requestHeaders: {} },
3373
+ { body, xOrderingSource, requestHeaders } = { requestHeaders: {} },
3354
3374
  { responseHeaders } = { responseHeaders: false }
3355
3375
  ) {
3356
3376
  const { error } = CartPlatformApplicationValidator.overrideCart().validate(
3357
3377
  {
3358
3378
  body,
3379
+ xOrderingSource,
3359
3380
  },
3360
3381
  { abortEarly: false, allowUnknown: true }
3361
3382
  );
@@ -3369,6 +3390,7 @@ class Cart {
3369
3390
  } = CartPlatformApplicationValidator.overrideCart().validate(
3370
3391
  {
3371
3392
  body,
3393
+ xOrderingSource,
3372
3394
  },
3373
3395
  { abortEarly: false, allowUnknown: false }
3374
3396
  );
@@ -3427,7 +3449,7 @@ class Cart {
3427
3449
  * @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/).
3428
3450
  */
3429
3451
  async platformAddItems(
3430
- { body, i, b, buyNow, orderType, id, requestHeaders } = {
3452
+ { body, xOrderingSource, i, b, buyNow, orderType, id, requestHeaders } = {
3431
3453
  requestHeaders: {},
3432
3454
  },
3433
3455
  { responseHeaders } = { responseHeaders: false }
@@ -3437,6 +3459,7 @@ class Cart {
3437
3459
  } = CartPlatformApplicationValidator.platformAddItems().validate(
3438
3460
  {
3439
3461
  body,
3462
+ xOrderingSource,
3440
3463
  i,
3441
3464
  b,
3442
3465
  buyNow,
@@ -3455,6 +3478,7 @@ class Cart {
3455
3478
  } = CartPlatformApplicationValidator.platformAddItems().validate(
3456
3479
  {
3457
3480
  body,
3481
+ xOrderingSource,
3458
3482
  i,
3459
3483
  b,
3460
3484
  buyNow,
@@ -3525,7 +3549,7 @@ class Cart {
3525
3549
  * @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/).
3526
3550
  */
3527
3551
  async platformCheckoutCart(
3528
- { body, id, requestHeaders } = { requestHeaders: {} },
3552
+ { body, xOrderingSource, id, requestHeaders } = { requestHeaders: {} },
3529
3553
  { responseHeaders } = { responseHeaders: false }
3530
3554
  ) {
3531
3555
  const {
@@ -3533,6 +3557,7 @@ class Cart {
3533
3557
  } = CartPlatformApplicationValidator.platformCheckoutCart().validate(
3534
3558
  {
3535
3559
  body,
3560
+ xOrderingSource,
3536
3561
  id,
3537
3562
  },
3538
3563
  { abortEarly: false, allowUnknown: true }
@@ -3547,6 +3572,7 @@ class Cart {
3547
3572
  } = CartPlatformApplicationValidator.platformCheckoutCart().validate(
3548
3573
  {
3549
3574
  body,
3575
+ xOrderingSource,
3550
3576
  id,
3551
3577
  },
3552
3578
  { abortEarly: false, allowUnknown: false }
@@ -3609,7 +3635,7 @@ class Cart {
3609
3635
  * @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/).
3610
3636
  */
3611
3637
  async platformCheckoutCartV2(
3612
- { body, id, requestHeaders } = { requestHeaders: {} },
3638
+ { body, xOrderingSource, id, requestHeaders } = { requestHeaders: {} },
3613
3639
  { responseHeaders } = { responseHeaders: false }
3614
3640
  ) {
3615
3641
  const {
@@ -3617,6 +3643,7 @@ class Cart {
3617
3643
  } = CartPlatformApplicationValidator.platformCheckoutCartV2().validate(
3618
3644
  {
3619
3645
  body,
3646
+ xOrderingSource,
3620
3647
  id,
3621
3648
  },
3622
3649
  { abortEarly: false, allowUnknown: true }
@@ -3631,6 +3658,7 @@ class Cart {
3631
3658
  } = CartPlatformApplicationValidator.platformCheckoutCartV2().validate(
3632
3659
  {
3633
3660
  body,
3661
+ xOrderingSource,
3634
3662
  id,
3635
3663
  },
3636
3664
  { abortEarly: false, allowUnknown: false }
@@ -3691,7 +3719,7 @@ class Cart {
3691
3719
  * @description: Customers can modify added product attributes such as quantity and size, as well as remove items from the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformUpdateCart/).
3692
3720
  */
3693
3721
  async platformUpdateCart(
3694
- { body, id, i, orderType, b, buyNow, requestHeaders } = {
3722
+ { body, xOrderingSource, id, i, orderType, b, buyNow, requestHeaders } = {
3695
3723
  requestHeaders: {},
3696
3724
  },
3697
3725
  { responseHeaders } = { responseHeaders: false }
@@ -3701,6 +3729,7 @@ class Cart {
3701
3729
  } = CartPlatformApplicationValidator.platformUpdateCart().validate(
3702
3730
  {
3703
3731
  body,
3732
+ xOrderingSource,
3704
3733
  id,
3705
3734
  i,
3706
3735
  orderType,
@@ -3719,6 +3748,7 @@ class Cart {
3719
3748
  } = CartPlatformApplicationValidator.platformUpdateCart().validate(
3720
3749
  {
3721
3750
  body,
3751
+ xOrderingSource,
3722
3752
  id,
3723
3753
  i,
3724
3754
  orderType,
@@ -3867,11 +3897,12 @@ class Cart {
3867
3897
  * @description: Remove an applied coupon from the customer's cart, thereby removing the associated discount from the cart total. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removeCoupon/).
3868
3898
  */
3869
3899
  async removeCoupon(
3870
- { uid, buyNow, requestHeaders } = { requestHeaders: {} },
3900
+ { xOrderingSource, uid, buyNow, requestHeaders } = { requestHeaders: {} },
3871
3901
  { responseHeaders } = { responseHeaders: false }
3872
3902
  ) {
3873
3903
  const { error } = CartPlatformApplicationValidator.removeCoupon().validate(
3874
3904
  {
3905
+ xOrderingSource,
3875
3906
  uid,
3876
3907
  buyNow,
3877
3908
  },
@@ -3886,6 +3917,7 @@ class Cart {
3886
3917
  error: warrning,
3887
3918
  } = CartPlatformApplicationValidator.removeCoupon().validate(
3888
3919
  {
3920
+ xOrderingSource,
3889
3921
  uid,
3890
3922
  buyNow,
3891
3923
  },
@@ -4029,12 +4061,15 @@ class Cart {
4029
4061
  * @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/).
4030
4062
  */
4031
4063
  async selectAddress(
4032
- { body, cartId, buyNow, i, b, requestHeaders } = { requestHeaders: {} },
4064
+ { body, xOrderingSource, cartId, buyNow, i, b, requestHeaders } = {
4065
+ requestHeaders: {},
4066
+ },
4033
4067
  { responseHeaders } = { responseHeaders: false }
4034
4068
  ) {
4035
4069
  const { error } = CartPlatformApplicationValidator.selectAddress().validate(
4036
4070
  {
4037
4071
  body,
4072
+ xOrderingSource,
4038
4073
  cartId,
4039
4074
  buyNow,
4040
4075
  i,
@@ -4052,6 +4087,7 @@ class Cart {
4052
4087
  } = CartPlatformApplicationValidator.selectAddress().validate(
4053
4088
  {
4054
4089
  body,
4090
+ xOrderingSource,
4055
4091
  cartId,
4056
4092
  buyNow,
4057
4093
  i,
@@ -4118,7 +4154,9 @@ class Cart {
4118
4154
  * @description: Customers can select a preferred payment mode from available options during the cart checkout process to securely and efficiently complete their transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/selectPaymentMode/).
4119
4155
  */
4120
4156
  async selectPaymentMode(
4121
- { body, id, buyNow, orderType, requestHeaders } = { requestHeaders: {} },
4157
+ { body, xOrderingSource, id, buyNow, orderType, requestHeaders } = {
4158
+ requestHeaders: {},
4159
+ },
4122
4160
  { responseHeaders } = { responseHeaders: false }
4123
4161
  ) {
4124
4162
  const {
@@ -4126,6 +4164,7 @@ class Cart {
4126
4164
  } = CartPlatformApplicationValidator.selectPaymentMode().validate(
4127
4165
  {
4128
4166
  body,
4167
+ xOrderingSource,
4129
4168
  id,
4130
4169
  buyNow,
4131
4170
  orderType,
@@ -4142,6 +4181,7 @@ class Cart {
4142
4181
  } = CartPlatformApplicationValidator.selectPaymentMode().validate(
4143
4182
  {
4144
4183
  body,
4184
+ xOrderingSource,
4145
4185
  id,
4146
4186
  buyNow,
4147
4187
  orderType,
@@ -4206,7 +4246,9 @@ class Cart {
4206
4246
  * @description: Selection of payment mode that supports multiple MOP(mode of payment). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/selectPaymentModeV2/).
4207
4247
  */
4208
4248
  async selectPaymentModeV2(
4209
- { body, id, buyNow, orderType, requestHeaders } = { requestHeaders: {} },
4249
+ { body, xOrderingSource, id, buyNow, orderType, requestHeaders } = {
4250
+ requestHeaders: {},
4251
+ },
4210
4252
  { responseHeaders } = { responseHeaders: false }
4211
4253
  ) {
4212
4254
  const {
@@ -4214,6 +4256,7 @@ class Cart {
4214
4256
  } = CartPlatformApplicationValidator.selectPaymentModeV2().validate(
4215
4257
  {
4216
4258
  body,
4259
+ xOrderingSource,
4217
4260
  id,
4218
4261
  buyNow,
4219
4262
  orderType,
@@ -4230,6 +4273,7 @@ class Cart {
4230
4273
  } = CartPlatformApplicationValidator.selectPaymentModeV2().validate(
4231
4274
  {
4232
4275
  body,
4276
+ xOrderingSource,
4233
4277
  id,
4234
4278
  buyNow,
4235
4279
  orderType,
@@ -5303,6 +5347,7 @@ class Cart {
5303
5347
  */
5304
5348
  async validateCouponForPayment(
5305
5349
  {
5350
+ xOrderingSource,
5306
5351
  id,
5307
5352
  buyNow,
5308
5353
  addressId,
@@ -5318,6 +5363,7 @@ class Cart {
5318
5363
  error,
5319
5364
  } = CartPlatformApplicationValidator.validateCouponForPayment().validate(
5320
5365
  {
5366
+ xOrderingSource,
5321
5367
  id,
5322
5368
  buyNow,
5323
5369
  addressId,
@@ -5337,6 +5383,7 @@ class Cart {
5337
5383
  error: warrning,
5338
5384
  } = CartPlatformApplicationValidator.validateCouponForPayment().validate(
5339
5385
  {
5386
+ xOrderingSource,
5340
5387
  id,
5341
5388
  buyNow,
5342
5389
  addressId,
@@ -15,6 +15,8 @@ export = CartPlatformApplicationValidator;
15
15
  */
16
16
  /**
17
17
  * @typedef ApplyCouponParam
18
+ * @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
19
+ * source header, to be used to identify source of order creation.
18
20
  * @property {boolean} [i]
19
21
  * @property {boolean} [b]
20
22
  * @property {boolean} [p]
@@ -24,10 +26,14 @@ export = CartPlatformApplicationValidator;
24
26
  */
25
27
  /**
26
28
  * @typedef CheckCartServiceabilityParam
29
+ * @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
30
+ * source header, to be used to identify source of order creation.
27
31
  * @property {CartPlatformModel.OpenApiCartServiceabilityCreation} body
28
32
  */
29
33
  /**
30
34
  * @typedef CheckoutCartParam
35
+ * @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
36
+ * source header, to be used to identify source of order creation.
31
37
  * @property {CartPlatformModel.OpenApiPlatformCheckoutReq} body
32
38
  */
33
39
  /**
@@ -57,6 +63,8 @@ export = CartPlatformApplicationValidator;
57
63
  */
58
64
  /**
59
65
  * @typedef FetchAndvalidateCartItemsParam
66
+ * @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
67
+ * source header, to be used to identify source of order creation.
60
68
  * @property {CartPlatformModel.OpenapiCartDetailsCreation} body
61
69
  */
62
70
  /** @typedef FetchCartMetaConfigParam */
@@ -112,6 +120,8 @@ export = CartPlatformApplicationValidator;
112
120
  */
113
121
  /**
114
122
  * @typedef GetCartParam
123
+ * @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
124
+ * source header, to be used to identify source of order creation.
115
125
  * @property {string} [id] - The unique identifier of the cart
116
126
  * @property {string} [userId] - Option to fetch cart for the provided user_id.
117
127
  * @property {string} [orderType] - The order type of shipment HomeDelivery - If
@@ -242,10 +252,14 @@ export = CartPlatformApplicationValidator;
242
252
  */
243
253
  /**
244
254
  * @typedef OverrideCartParam
255
+ * @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
256
+ * source header, to be used to identify source of order creation.
245
257
  * @property {CartPlatformModel.OverrideCheckoutReq} body
246
258
  */
247
259
  /**
248
260
  * @typedef PlatformAddItemsParam
261
+ * @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
262
+ * source header, to be used to identify source of order creation.
249
263
  * @property {boolean} [i] - This is a boolean value. Select `true` to retrieve
250
264
  * all the items added in the cart.
251
265
  * @property {boolean} [b] - This is a boolean value. Select `true` to retrieve
@@ -260,16 +274,22 @@ export = CartPlatformApplicationValidator;
260
274
  */
261
275
  /**
262
276
  * @typedef PlatformCheckoutCartParam
277
+ * @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
278
+ * source header, to be used to identify source of order creation.
263
279
  * @property {string} [id] - The unique identifier of the cart
264
280
  * @property {CartPlatformModel.PlatformCartCheckoutDetailCreation} body
265
281
  */
266
282
  /**
267
283
  * @typedef PlatformCheckoutCartV2Param
284
+ * @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
285
+ * source header, to be used to identify source of order creation.
268
286
  * @property {string} [id] - The unique identifier of the cart
269
287
  * @property {CartPlatformModel.PlatformCartCheckoutDetailV2Creation} body
270
288
  */
271
289
  /**
272
290
  * @typedef PlatformUpdateCartParam
291
+ * @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
292
+ * source header, to be used to identify source of order creation.
273
293
  * @property {string} [id] - The unique identifier of the cart
274
294
  * @property {boolean} [i] - This is a boolean value. Select `true` to retrieve
275
295
  * all the items added in the cart.
@@ -289,6 +309,8 @@ export = CartPlatformApplicationValidator;
289
309
  */
290
310
  /**
291
311
  * @typedef RemoveCouponParam
312
+ * @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
313
+ * source header, to be used to identify source of order creation.
292
314
  * @property {string} [uid]
293
315
  * @property {boolean} [buyNow]
294
316
  */
@@ -298,6 +320,8 @@ export = CartPlatformApplicationValidator;
298
320
  */
299
321
  /**
300
322
  * @typedef SelectAddressParam
323
+ * @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
324
+ * source header, to be used to identify source of order creation.
301
325
  * @property {string} [cartId]
302
326
  * @property {boolean} [buyNow]
303
327
  * @property {boolean} [i]
@@ -306,6 +330,8 @@ export = CartPlatformApplicationValidator;
306
330
  */
307
331
  /**
308
332
  * @typedef SelectPaymentModeParam
333
+ * @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
334
+ * source header, to be used to identify source of order creation.
309
335
  * @property {string} [id]
310
336
  * @property {boolean} [buyNow]
311
337
  * @property {string} [orderType]
@@ -313,6 +339,8 @@ export = CartPlatformApplicationValidator;
313
339
  */
314
340
  /**
315
341
  * @typedef SelectPaymentModeV2Param
342
+ * @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
343
+ * source header, to be used to identify source of order creation.
316
344
  * @property {string} [id]
317
345
  * @property {boolean} [buyNow]
318
346
  * @property {string} [orderType]
@@ -393,6 +421,8 @@ export = CartPlatformApplicationValidator;
393
421
  */
394
422
  /**
395
423
  * @typedef ValidateCouponForPaymentParam
424
+ * @property {CartPlatformModel.OrderingSource} [xOrderingSource] - Ordering
425
+ * source header, to be used to identify source of order creation.
396
426
  * @property {string} [id]
397
427
  * @property {boolean} [buyNow]
398
428
  * @property {string} [addressId]
@@ -545,6 +575,11 @@ type AddPriceAdjustmentParam = {
545
575
  body: CartPlatformModel.PriceAdjustmentAdd;
546
576
  };
547
577
  type ApplyCouponParam = {
578
+ /**
579
+ * - Ordering
580
+ * source header, to be used to identify source of order creation.
581
+ */
582
+ xOrderingSource?: CartPlatformModel.OrderingSource;
548
583
  i?: boolean;
549
584
  b?: boolean;
550
585
  p?: boolean;
@@ -553,9 +588,19 @@ type ApplyCouponParam = {
553
588
  body: CartPlatformModel.ApplyCouponDetails;
554
589
  };
555
590
  type CheckCartServiceabilityParam = {
591
+ /**
592
+ * - Ordering
593
+ * source header, to be used to identify source of order creation.
594
+ */
595
+ xOrderingSource?: CartPlatformModel.OrderingSource;
556
596
  body: CartPlatformModel.OpenApiCartServiceabilityCreation;
557
597
  };
558
598
  type CheckoutCartParam = {
599
+ /**
600
+ * - Ordering
601
+ * source header, to be used to identify source of order creation.
602
+ */
603
+ xOrderingSource?: CartPlatformModel.OrderingSource;
559
604
  body: CartPlatformModel.OpenApiPlatformCheckoutReq;
560
605
  };
561
606
  type CreateCartMetaConfigParam = {
@@ -581,6 +626,11 @@ type DeletePromotionParam = {
581
626
  id: string;
582
627
  };
583
628
  type FetchAndvalidateCartItemsParam = {
629
+ /**
630
+ * - Ordering
631
+ * source header, to be used to identify source of order creation.
632
+ */
633
+ xOrderingSource?: CartPlatformModel.OrderingSource;
584
634
  body: CartPlatformModel.OpenapiCartDetailsCreation;
585
635
  };
586
636
  type GetAbandonedCartParam = {
@@ -628,6 +678,11 @@ type GetAvailableDeliveryModesParam = {
628
678
  id?: string;
629
679
  };
630
680
  type GetCartParam = {
681
+ /**
682
+ * - Ordering
683
+ * source header, to be used to identify source of order creation.
684
+ */
685
+ xOrderingSource?: CartPlatformModel.OrderingSource;
631
686
  /**
632
687
  * - The unique identifier of the cart
633
688
  */
@@ -818,9 +873,19 @@ type GetStoreAddressByUidParam = {
818
873
  storeUid: number;
819
874
  };
820
875
  type OverrideCartParam = {
876
+ /**
877
+ * - Ordering
878
+ * source header, to be used to identify source of order creation.
879
+ */
880
+ xOrderingSource?: CartPlatformModel.OrderingSource;
821
881
  body: CartPlatformModel.OverrideCheckoutReq;
822
882
  };
823
883
  type PlatformAddItemsParam = {
884
+ /**
885
+ * - Ordering
886
+ * source header, to be used to identify source of order creation.
887
+ */
888
+ xOrderingSource?: CartPlatformModel.OrderingSource;
824
889
  /**
825
890
  * - This is a boolean value. Select `true` to retrieve
826
891
  * all the items added in the cart.
@@ -849,6 +914,11 @@ type PlatformAddItemsParam = {
849
914
  body: CartPlatformModel.PlatformAddCartDetails;
850
915
  };
851
916
  type PlatformCheckoutCartParam = {
917
+ /**
918
+ * - Ordering
919
+ * source header, to be used to identify source of order creation.
920
+ */
921
+ xOrderingSource?: CartPlatformModel.OrderingSource;
852
922
  /**
853
923
  * - The unique identifier of the cart
854
924
  */
@@ -856,6 +926,11 @@ type PlatformCheckoutCartParam = {
856
926
  body: CartPlatformModel.PlatformCartCheckoutDetailCreation;
857
927
  };
858
928
  type PlatformCheckoutCartV2Param = {
929
+ /**
930
+ * - Ordering
931
+ * source header, to be used to identify source of order creation.
932
+ */
933
+ xOrderingSource?: CartPlatformModel.OrderingSource;
859
934
  /**
860
935
  * - The unique identifier of the cart
861
936
  */
@@ -863,6 +938,11 @@ type PlatformCheckoutCartV2Param = {
863
938
  body: CartPlatformModel.PlatformCartCheckoutDetailV2Creation;
864
939
  };
865
940
  type PlatformUpdateCartParam = {
941
+ /**
942
+ * - Ordering
943
+ * source header, to be used to identify source of order creation.
944
+ */
945
+ xOrderingSource?: CartPlatformModel.OrderingSource;
866
946
  /**
867
947
  * - The unique identifier of the cart
868
948
  */
@@ -901,6 +981,11 @@ type RemoveAddressParam = {
901
981
  userId?: string;
902
982
  };
903
983
  type RemoveCouponParam = {
984
+ /**
985
+ * - Ordering
986
+ * source header, to be used to identify source of order creation.
987
+ */
988
+ xOrderingSource?: CartPlatformModel.OrderingSource;
904
989
  uid?: string;
905
990
  buyNow?: boolean;
906
991
  };
@@ -908,6 +993,11 @@ type RemovePriceAdjustmentParam = {
908
993
  id: string;
909
994
  };
910
995
  type SelectAddressParam = {
996
+ /**
997
+ * - Ordering
998
+ * source header, to be used to identify source of order creation.
999
+ */
1000
+ xOrderingSource?: CartPlatformModel.OrderingSource;
911
1001
  cartId?: string;
912
1002
  buyNow?: boolean;
913
1003
  i?: boolean;
@@ -915,12 +1005,22 @@ type SelectAddressParam = {
915
1005
  body: CartPlatformModel.PlatformSelectCartAddress;
916
1006
  };
917
1007
  type SelectPaymentModeParam = {
1008
+ /**
1009
+ * - Ordering
1010
+ * source header, to be used to identify source of order creation.
1011
+ */
1012
+ xOrderingSource?: CartPlatformModel.OrderingSource;
918
1013
  id?: string;
919
1014
  buyNow?: boolean;
920
1015
  orderType?: string;
921
1016
  body: CartPlatformModel.CartPaymentUpdate;
922
1017
  };
923
1018
  type SelectPaymentModeV2Param = {
1019
+ /**
1020
+ * - Ordering
1021
+ * source header, to be used to identify source of order creation.
1022
+ */
1023
+ xOrderingSource?: CartPlatformModel.OrderingSource;
924
1024
  id?: string;
925
1025
  buyNow?: boolean;
926
1026
  orderType?: string;
@@ -1021,6 +1121,11 @@ type UpdateShipmentsParam = {
1021
1121
  body: CartPlatformModel.UpdateCartShipmentCreation;
1022
1122
  };
1023
1123
  type ValidateCouponForPaymentParam = {
1124
+ /**
1125
+ * - Ordering
1126
+ * source header, to be used to identify source of order creation.
1127
+ */
1128
+ xOrderingSource?: CartPlatformModel.OrderingSource;
1024
1129
  id?: string;
1025
1130
  buyNow?: boolean;
1026
1131
  addressId?: string;