@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
@@ -833,7 +833,11 @@ export = OrderPlatformModel;
833
833
  * @property {string} [currency] - The currency in which the prices details
834
834
  * associated with the item is specified.
835
835
  * @property {number} [total_order_value]
836
- * @property {string} [ordering_channel]
836
+ * @property {string} [ordering_channel] - The specific channel through which
837
+ * your order was placed. This field will be phased out after version 2.4.0.
838
+ * Please use ordering_source instead to ensure accurate order tracking and processing.
839
+ * @property {string} [ordering_source] - To uniquely identify the source
840
+ * through which order has been placed.
837
841
  * @property {Object} [meta] - Meta data of the order data contains additional,
838
842
  * potentially dynamic information about the order data.
839
843
  * @property {number} [cod_charges]
@@ -2331,8 +2335,11 @@ export = OrderPlatformModel;
2331
2335
  * @typedef TransitionConfigCondition
2332
2336
  * @property {string} app_id - The unique identifier of the application to which
2333
2337
  * the configuration applies.
2334
- * @property {string} ordering_channel - The channel through which the order was
2335
- * placed, such as ECOMM or another specified channel.
2338
+ * @property {string} [ordering_channel] - The specific channel through which
2339
+ * your order was placed. This field will be phased out after version 2.4.0.
2340
+ * Please use ordering_source instead to ensure accurate order tracking and processing.
2341
+ * @property {string} [ordering_source] - To uniquely identify the source
2342
+ * through which order has been placed.
2336
2343
  * @property {string} entity - The type of entity that the configuration pertains to.
2337
2344
  */
2338
2345
  /**
@@ -3403,7 +3410,11 @@ export = OrderPlatformModel;
3403
3410
  * @property {Prices} [prices]
3404
3411
  * @property {OrderingCurrencyPrices} [ordering_currency_prices]
3405
3412
  * @property {string} order_id - The unique identifier of the order for the shipment.
3406
- * @property {string} [ordering_channnel] - The channel used for ordering the shipment.
3413
+ * @property {string} [ordering_channnel] - The specific channel through which
3414
+ * your order was placed. This field will be phased out after version 2.4.0.
3415
+ * Please use ordering_source instead to ensure accurate order tracking and processing.
3416
+ * @property {string} [ordering_source] - To uniquely identify the source
3417
+ * through which order has been placed.
3407
3418
  * @property {string} [shipment_id] - The unique identifier for the shipment itself.
3408
3419
  * @property {string} [customer_note] - Any special notes or instructions
3409
3420
  * provided by the customer related to the shipment.
@@ -3499,7 +3510,10 @@ export = OrderPlatformModel;
3499
3510
  * related to the order.
3500
3511
  * @property {string} [order_value] - The total monetary value of the order
3501
3512
  * @property {string} [ordering_channel] - The specific channel through which
3502
- * the order was placed
3513
+ * your order was placed. This field will be phased out after version 2.4.0.
3514
+ * Please use ordering_source instead to ensure accurate order tracking and processing.
3515
+ * @property {string} [ordering_source] - To uniquely identify the source
3516
+ * through which order has been placed.
3503
3517
  * @property {Object} [meta] - Meta data of the order contains additional,
3504
3518
  * potentially dynamic information about the order.
3505
3519
  */
@@ -4257,7 +4271,10 @@ export = OrderPlatformModel;
4257
4271
  /**
4258
4272
  * @typedef OrderData
4259
4273
  * @property {string} [ordering_channel] - The specific channel through which
4260
- * the order was placed.
4274
+ * your order was placed. This field will be phased out after version 2.4.0.
4275
+ * Please use ordering_source instead to ensure accurate order tracking and processing.
4276
+ * @property {string} [ordering_source] - To uniquely identify the source
4277
+ * through which order has been placed.
4261
4278
  * @property {string} order_date - Specifies the exact date and time when the
4262
4279
  * order was placed by the customer, serving as a key timestamp for the
4263
4280
  * initiation of the order processing cycle.
@@ -6567,7 +6584,17 @@ type OrderDetails = {
6567
6584
  */
6568
6585
  currency?: string;
6569
6586
  total_order_value?: number;
6587
+ /**
6588
+ * - The specific channel through which
6589
+ * your order was placed. This field will be phased out after version 2.4.0.
6590
+ * Please use ordering_source instead to ensure accurate order tracking and processing.
6591
+ */
6570
6592
  ordering_channel?: string;
6593
+ /**
6594
+ * - To uniquely identify the source
6595
+ * through which order has been placed.
6596
+ */
6597
+ ordering_source?: string;
6571
6598
  /**
6572
6599
  * - Meta data of the order data contains additional,
6573
6600
  * potentially dynamic information about the order data.
@@ -9565,10 +9592,16 @@ type TransitionConfigCondition = {
9565
9592
  */
9566
9593
  app_id: string;
9567
9594
  /**
9568
- * - The channel through which the order was
9569
- * placed, such as ECOMM or another specified channel.
9595
+ * - The specific channel through which
9596
+ * your order was placed. This field will be phased out after version 2.4.0.
9597
+ * Please use ordering_source instead to ensure accurate order tracking and processing.
9598
+ */
9599
+ ordering_channel?: string;
9600
+ /**
9601
+ * - To uniquely identify the source
9602
+ * through which order has been placed.
9570
9603
  */
9571
- ordering_channel: string;
9604
+ ordering_source?: string;
9572
9605
  /**
9573
9606
  * - The type of entity that the configuration pertains to.
9574
9607
  */
@@ -11929,9 +11962,16 @@ type ShipmentItem = {
11929
11962
  */
11930
11963
  order_id: string;
11931
11964
  /**
11932
- * - The channel used for ordering the shipment.
11965
+ * - The specific channel through which
11966
+ * your order was placed. This field will be phased out after version 2.4.0.
11967
+ * Please use ordering_source instead to ensure accurate order tracking and processing.
11933
11968
  */
11934
11969
  ordering_channnel?: string;
11970
+ /**
11971
+ * - To uniquely identify the source
11972
+ * through which order has been placed.
11973
+ */
11974
+ ordering_source?: string;
11935
11975
  /**
11936
11976
  * - The unique identifier for the shipment itself.
11937
11977
  */
@@ -12140,9 +12180,15 @@ type OrderDetailsData = {
12140
12180
  order_value?: string;
12141
12181
  /**
12142
12182
  * - The specific channel through which
12143
- * the order was placed
12183
+ * your order was placed. This field will be phased out after version 2.4.0.
12184
+ * Please use ordering_source instead to ensure accurate order tracking and processing.
12144
12185
  */
12145
12186
  ordering_channel?: string;
12187
+ /**
12188
+ * - To uniquely identify the source
12189
+ * through which order has been placed.
12190
+ */
12191
+ ordering_source?: string;
12146
12192
  /**
12147
12193
  * - Meta data of the order contains additional,
12148
12194
  * potentially dynamic information about the order.
@@ -13778,9 +13824,15 @@ declare function OrderData(): OrderData;
13778
13824
  type OrderData = {
13779
13825
  /**
13780
13826
  * - The specific channel through which
13781
- * the order was placed.
13827
+ * your order was placed. This field will be phased out after version 2.4.0.
13828
+ * Please use ordering_source instead to ensure accurate order tracking and processing.
13782
13829
  */
13783
13830
  ordering_channel?: string;
13831
+ /**
13832
+ * - To uniquely identify the source
13833
+ * through which order has been placed.
13834
+ */
13835
+ ordering_source?: string;
13784
13836
  /**
13785
13837
  * - Specifies the exact date and time when the
13786
13838
  * order was placed by the customer, serving as a key timestamp for the
@@ -916,7 +916,11 @@ const Joi = require("joi");
916
916
  * @property {string} [currency] - The currency in which the prices details
917
917
  * associated with the item is specified.
918
918
  * @property {number} [total_order_value]
919
- * @property {string} [ordering_channel]
919
+ * @property {string} [ordering_channel] - The specific channel through which
920
+ * your order was placed. This field will be phased out after version 2.4.0.
921
+ * Please use ordering_source instead to ensure accurate order tracking and processing.
922
+ * @property {string} [ordering_source] - To uniquely identify the source
923
+ * through which order has been placed.
920
924
  * @property {Object} [meta] - Meta data of the order data contains additional,
921
925
  * potentially dynamic information about the order data.
922
926
  * @property {number} [cod_charges]
@@ -2542,8 +2546,11 @@ const Joi = require("joi");
2542
2546
  * @typedef TransitionConfigCondition
2543
2547
  * @property {string} app_id - The unique identifier of the application to which
2544
2548
  * the configuration applies.
2545
- * @property {string} ordering_channel - The channel through which the order was
2546
- * placed, such as ECOMM or another specified channel.
2549
+ * @property {string} [ordering_channel] - The specific channel through which
2550
+ * your order was placed. This field will be phased out after version 2.4.0.
2551
+ * Please use ordering_source instead to ensure accurate order tracking and processing.
2552
+ * @property {string} [ordering_source] - To uniquely identify the source
2553
+ * through which order has been placed.
2547
2554
  * @property {string} entity - The type of entity that the configuration pertains to.
2548
2555
  */
2549
2556
 
@@ -3675,7 +3682,11 @@ const Joi = require("joi");
3675
3682
  * @property {Prices} [prices]
3676
3683
  * @property {OrderingCurrencyPrices} [ordering_currency_prices]
3677
3684
  * @property {string} order_id - The unique identifier of the order for the shipment.
3678
- * @property {string} [ordering_channnel] - The channel used for ordering the shipment.
3685
+ * @property {string} [ordering_channnel] - The specific channel through which
3686
+ * your order was placed. This field will be phased out after version 2.4.0.
3687
+ * Please use ordering_source instead to ensure accurate order tracking and processing.
3688
+ * @property {string} [ordering_source] - To uniquely identify the source
3689
+ * through which order has been placed.
3679
3690
  * @property {string} [shipment_id] - The unique identifier for the shipment itself.
3680
3691
  * @property {string} [customer_note] - Any special notes or instructions
3681
3692
  * provided by the customer related to the shipment.
@@ -3775,7 +3786,10 @@ const Joi = require("joi");
3775
3786
  * related to the order.
3776
3787
  * @property {string} [order_value] - The total monetary value of the order
3777
3788
  * @property {string} [ordering_channel] - The specific channel through which
3778
- * the order was placed
3789
+ * your order was placed. This field will be phased out after version 2.4.0.
3790
+ * Please use ordering_source instead to ensure accurate order tracking and processing.
3791
+ * @property {string} [ordering_source] - To uniquely identify the source
3792
+ * through which order has been placed.
3779
3793
  * @property {Object} [meta] - Meta data of the order contains additional,
3780
3794
  * potentially dynamic information about the order.
3781
3795
  */
@@ -4574,7 +4588,10 @@ const Joi = require("joi");
4574
4588
  /**
4575
4589
  * @typedef OrderData
4576
4590
  * @property {string} [ordering_channel] - The specific channel through which
4577
- * the order was placed.
4591
+ * your order was placed. This field will be phased out after version 2.4.0.
4592
+ * Please use ordering_source instead to ensure accurate order tracking and processing.
4593
+ * @property {string} [ordering_source] - To uniquely identify the source
4594
+ * through which order has been placed.
4578
4595
  * @property {string} order_date - Specifies the exact date and time when the
4579
4596
  * order was placed by the customer, serving as a key timestamp for the
4580
4597
  * initiation of the order processing cycle.
@@ -6197,6 +6214,7 @@ class OrderPlatformModel {
6197
6214
  currency: Joi.string().allow(""),
6198
6215
  total_order_value: Joi.number(),
6199
6216
  ordering_channel: Joi.string().allow(""),
6217
+ ordering_source: Joi.string().allow("").allow(null),
6200
6218
  meta: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
6201
6219
  cod_charges: Joi.number().allow(null),
6202
6220
  cashback_value: Joi.number().allow(null),
@@ -7658,7 +7676,8 @@ class OrderPlatformModel {
7658
7676
  static TransitionConfigCondition() {
7659
7677
  return Joi.object({
7660
7678
  app_id: Joi.string().allow("").required(),
7661
- ordering_channel: Joi.string().allow("").required(),
7679
+ ordering_channel: Joi.string().allow(""),
7680
+ ordering_source: Joi.string().allow("").allow(null),
7662
7681
  entity: Joi.string().allow("").required(),
7663
7682
  });
7664
7683
  }
@@ -8491,6 +8510,7 @@ class OrderPlatformModel {
8491
8510
  ordering_currency_prices: OrderPlatformModel.OrderingCurrencyPrices(),
8492
8511
  order_id: Joi.string().allow("").required(),
8493
8512
  ordering_channnel: Joi.string().allow("").allow(null),
8513
+ ordering_source: Joi.string().allow("").allow(null),
8494
8514
  shipment_id: Joi.string().allow("").allow(null),
8495
8515
  customer_note: Joi.string().allow("").allow(null),
8496
8516
  total_bags: Joi.number().required(),
@@ -8557,6 +8577,7 @@ class OrderPlatformModel {
8557
8577
  .allow(null, ""),
8558
8578
  order_value: Joi.string().allow("").allow(null),
8559
8579
  ordering_channel: Joi.string().allow("").allow(null),
8580
+ ordering_source: Joi.string().allow("").allow(null),
8560
8581
  meta: Joi.object().pattern(/\S/, Joi.any()),
8561
8582
  });
8562
8583
  }
@@ -9164,6 +9185,7 @@ class OrderPlatformModel {
9164
9185
  static OrderData() {
9165
9186
  return Joi.object({
9166
9187
  ordering_channel: Joi.string().allow(""),
9188
+ ordering_source: Joi.string().allow("").allow(null),
9167
9189
  order_date: Joi.string().allow("").required(),
9168
9190
  created_ts: Joi.string().allow(""),
9169
9191
  tax_details: OrderPlatformModel.TaxDetails(),
@@ -33,6 +33,8 @@ export = OrderPlatformValidator;
33
33
  */
34
34
  /**
35
35
  * @typedef CreateOrderParam
36
+ * @property {string} [xOrderingSource] - To uniquely identify the source
37
+ * through which order has been placed.
36
38
  * @property {OrderPlatformModel.CreateOrderAPI} body
37
39
  */
38
40
  /**
@@ -84,7 +86,11 @@ export = OrderPlatformValidator;
84
86
  */
85
87
  /**
86
88
  * @typedef GetAllowedStateTransitionParam
87
- * @property {string} orderingChannel - The channel through which orders are placed.
89
+ * @property {string} [orderingChannel] - The specific channel through which
90
+ * your order was placed. This field will be phased out after version 2.4.0.
91
+ * Please use ordering_source instead to ensure accurate order tracking and processing.
92
+ * @property {string} [orderingSource] - To uniquely identify the source through
93
+ * which order has been placed.
88
94
  * @property {string} status - The status key indicates the current status for
89
95
  * which the API will provide a list of possible next state transitions.
90
96
  */
@@ -378,6 +384,8 @@ export = OrderPlatformValidator;
378
384
  * @typedef GetStateManagerConfigParam
379
385
  * @property {string} [appId] - The unique identifier of the application.
380
386
  * @property {string} [orderingChannel] - The channel through which orders are placed.
387
+ * @property {string} [orderingSource] - To uniquely identify the source through
388
+ * which order has been placed.
381
389
  * @property {string} [entity] - The entity for which the configuration is applied.
382
390
  */
383
391
  /** @typedef GetStateTransitionMapParam */
@@ -628,6 +636,11 @@ type CreateChannelConfigParam = {
628
636
  body: OrderPlatformModel.CreateChannelConfigData;
629
637
  };
630
638
  type CreateOrderParam = {
639
+ /**
640
+ * - To uniquely identify the source
641
+ * through which order has been placed.
642
+ */
643
+ xOrderingSource?: string;
631
644
  body: OrderPlatformModel.CreateOrderAPI;
632
645
  };
633
646
  type DispatchManifestsParam = {
@@ -693,9 +706,16 @@ type GenerateProcessManifestParam = {
693
706
  };
694
707
  type GetAllowedStateTransitionParam = {
695
708
  /**
696
- * - The channel through which orders are placed.
709
+ * - The specific channel through which
710
+ * your order was placed. This field will be phased out after version 2.4.0.
711
+ * Please use ordering_source instead to ensure accurate order tracking and processing.
712
+ */
713
+ orderingChannel?: string;
714
+ /**
715
+ * - To uniquely identify the source through
716
+ * which order has been placed.
697
717
  */
698
- orderingChannel: string;
718
+ orderingSource?: string;
699
719
  /**
700
720
  * - The status key indicates the current status for
701
721
  * which the API will provide a list of possible next state transitions.
@@ -1382,6 +1402,11 @@ type GetStateManagerConfigParam = {
1382
1402
  * - The channel through which orders are placed.
1383
1403
  */
1384
1404
  orderingChannel?: string;
1405
+ /**
1406
+ * - To uniquely identify the source through
1407
+ * which order has been placed.
1408
+ */
1409
+ orderingSource?: string;
1385
1410
  /**
1386
1411
  * - The entity for which the configuration is applied.
1387
1412
  */
@@ -42,6 +42,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
42
42
 
43
43
  /**
44
44
  * @typedef CreateOrderParam
45
+ * @property {string} [xOrderingSource] - To uniquely identify the source
46
+ * through which order has been placed.
45
47
  * @property {OrderPlatformModel.CreateOrderAPI} body
46
48
  */
47
49
 
@@ -104,7 +106,11 @@ const OrderPlatformModel = require("./OrderPlatformModel");
104
106
 
105
107
  /**
106
108
  * @typedef GetAllowedStateTransitionParam
107
- * @property {string} orderingChannel - The channel through which orders are placed.
109
+ * @property {string} [orderingChannel] - The specific channel through which
110
+ * your order was placed. This field will be phased out after version 2.4.0.
111
+ * Please use ordering_source instead to ensure accurate order tracking and processing.
112
+ * @property {string} [orderingSource] - To uniquely identify the source through
113
+ * which order has been placed.
108
114
  * @property {string} status - The status key indicates the current status for
109
115
  * which the API will provide a list of possible next state transitions.
110
116
  */
@@ -419,6 +425,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
419
425
  * @typedef GetStateManagerConfigParam
420
426
  * @property {string} [appId] - The unique identifier of the application.
421
427
  * @property {string} [orderingChannel] - The channel through which orders are placed.
428
+ * @property {string} [orderingSource] - To uniquely identify the source through
429
+ * which order has been placed.
422
430
  * @property {string} [entity] - The entity for which the configuration is applied.
423
431
  */
424
432
 
@@ -572,6 +580,7 @@ class OrderPlatformValidator {
572
580
  /** @returns {CreateOrderParam} */
573
581
  static createOrder() {
574
582
  return Joi.object({
583
+ xOrderingSource: Joi.string().allow(""),
575
584
  body: OrderPlatformModel.CreateOrderAPI().required(),
576
585
  }).required();
577
586
  }
@@ -656,7 +665,8 @@ class OrderPlatformValidator {
656
665
  /** @returns {GetAllowedStateTransitionParam} */
657
666
  static getAllowedStateTransition() {
658
667
  return Joi.object({
659
- orderingChannel: Joi.string().allow("").required(),
668
+ orderingChannel: Joi.string().allow(""),
669
+ orderingSource: Joi.string().allow(""),
660
670
  status: Joi.string().allow("").required(),
661
671
  }).required();
662
672
  }
@@ -931,6 +941,7 @@ class OrderPlatformValidator {
931
941
  return Joi.object({
932
942
  appId: Joi.string().allow(""),
933
943
  orderingChannel: Joi.string().allow(""),
944
+ orderingSource: Joi.string().allow(""),
934
945
  entity: Joi.string().allow(""),
935
946
  }).required();
936
947
  }
@@ -317,7 +317,7 @@ declare class Payment {
317
317
  * @summary: List POS payment modes
318
318
  * @description: Available payment methods on the payment page for POS, specifying the aggregator for each option, such as 'CARD powered by Juspay' and 'QR powered by Razorpay'. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getPosPaymentModeRoutes/).
319
319
  */
320
- getPosPaymentModeRoutes({ amount, pincode, orderType, cartId, checkoutMode, refresh, orderId, cardReference, userDetails, displaySplit, advancePayment, shipmentId, requestHeaders, }?: PaymentPlatformApplicationValidator.GetPosPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentModeRouteDetails>;
320
+ getPosPaymentModeRoutes({ amount, pincode, orderType, xOrderingSource, cartId, checkoutMode, refresh, orderId, cardReference, userDetails, displaySplit, advancePayment, shipmentId, requestHeaders, }?: PaymentPlatformApplicationValidator.GetPosPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentModeRouteDetails>;
321
321
  /**
322
322
  * @param {PaymentPlatformApplicationValidator.GetUserBeneficiariesParam} arg
323
323
  * - Arg object
@@ -2114,6 +2114,7 @@ class Payment {
2114
2114
  amount,
2115
2115
  pincode,
2116
2116
  orderType,
2117
+ xOrderingSource,
2117
2118
  cartId,
2118
2119
  checkoutMode,
2119
2120
  refresh,
@@ -2134,6 +2135,7 @@ class Payment {
2134
2135
  amount,
2135
2136
  pincode,
2136
2137
  orderType,
2138
+ xOrderingSource,
2137
2139
  cartId,
2138
2140
  checkoutMode,
2139
2141
  refresh,
@@ -2158,6 +2160,7 @@ class Payment {
2158
2160
  amount,
2159
2161
  pincode,
2160
2162
  orderType,
2163
+ xOrderingSource,
2161
2164
  cartId,
2162
2165
  checkoutMode,
2163
2166
  refresh,
@@ -114,6 +114,8 @@ export = PaymentPlatformApplicationValidator;
114
114
  */
115
115
  /**
116
116
  * @typedef GetPosPaymentModeRoutesParam
117
+ * @property {string} [xOrderingSource] - Optional header to identify the
118
+ * ordering source used to determine\ applicable payment options for business unit.
117
119
  * @property {number} amount - Payable amount.
118
120
  * @property {string} [cartId] - Identifier of the cart.
119
121
  * @property {string} pincode - The PIN Code of the destination address, e.g. 400059
@@ -491,6 +493,11 @@ type GetPaymentSessionParam = {
491
493
  lineItem?: boolean;
492
494
  };
493
495
  type GetPosPaymentModeRoutesParam = {
496
+ /**
497
+ * - Optional header to identify the
498
+ * ordering source used to determine\ applicable payment options for business unit.
499
+ */
500
+ xOrderingSource?: string;
494
501
  /**
495
502
  * - Payable amount.
496
503
  */
@@ -142,6 +142,8 @@ const PaymentPlatformModel = require("./PaymentPlatformModel");
142
142
 
143
143
  /**
144
144
  * @typedef GetPosPaymentModeRoutesParam
145
+ * @property {string} [xOrderingSource] - Optional header to identify the
146
+ * ordering source used to determine\ applicable payment options for business unit.
145
147
  * @property {number} amount - Payable amount.
146
148
  * @property {string} [cartId] - Identifier of the cart.
147
149
  * @property {string} pincode - The PIN Code of the destination address, e.g. 400059
@@ -489,6 +491,8 @@ class PaymentPlatformApplicationValidator {
489
491
  /** @returns {GetPosPaymentModeRoutesParam} */
490
492
  static getPosPaymentModeRoutes() {
491
493
  return Joi.object({
494
+ xOrderingSource: Joi.string().allow(""),
495
+
492
496
  amount: Joi.number().required(),
493
497
  cartId: Joi.string().allow(""),
494
498
  pincode: Joi.string().allow("").required(),
@@ -130,7 +130,7 @@ declare class Theme {
130
130
  * @summary: List theme fonts
131
131
  * @description: Retrieve a list of available fonts that can be used by themes in the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getFonts/).
132
132
  */
133
- getFonts({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.FontsSchema>;
133
+ getFonts({ capability, requestHeaders }?: ThemePlatformApplicationValidator.GetFontsParam, { responseHeaders }?: object): Promise<ThemePlatformModel.FontsSchema>;
134
134
  /**
135
135
  * @param {ThemePlatformApplicationValidator.GetPageParam} arg - Arg object
136
136
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -880,11 +880,13 @@ class Theme {
880
880
  * @description: Retrieve a list of available fonts that can be used by themes in the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getFonts/).
881
881
  */
882
882
  async getFonts(
883
- { requestHeaders } = { requestHeaders: {} },
883
+ { capability, requestHeaders } = { requestHeaders: {} },
884
884
  { responseHeaders } = { responseHeaders: false }
885
885
  ) {
886
886
  const { error } = ThemePlatformApplicationValidator.getFonts().validate(
887
- {},
887
+ {
888
+ capability,
889
+ },
888
890
  { abortEarly: false, allowUnknown: true }
889
891
  );
890
892
  if (error) {
@@ -895,7 +897,9 @@ class Theme {
895
897
  const {
896
898
  error: warrning,
897
899
  } = ThemePlatformApplicationValidator.getFonts().validate(
898
- {},
900
+ {
901
+ capability,
902
+ },
899
903
  { abortEarly: false, allowUnknown: false }
900
904
  );
901
905
  if (warrning) {
@@ -906,6 +910,7 @@ class Theme {
906
910
  }
907
911
 
908
912
  const query_params = {};
913
+ query_params["capability"] = capability;
909
914
 
910
915
  const response = await PlatformAPIClient.execute(
911
916
  this.config,
@@ -37,7 +37,11 @@ export = ThemePlatformApplicationValidator;
37
37
  * @property {string} [type] - The type of the theme
38
38
  * @property {string} [companyMode] - The mode of the company
39
39
  */
40
- /** @typedef GetFontsParam */
40
+ /**
41
+ * @typedef GetFontsParam
42
+ * @property {string} [capability] - Filter fonts based on supported
43
+ * capabilities (e.g., "WOFF2").
44
+ */
41
45
  /**
42
46
  * @typedef GetPageParam
43
47
  * @property {string} themeId - ID of the theme to be retrieved
@@ -109,7 +113,7 @@ declare class ThemePlatformApplicationValidator {
109
113
  /** @returns {GetExtensionSectionsParam} */
110
114
  static getExtensionSections(): GetExtensionSectionsParam;
111
115
  /** @returns {GetFontsParam} */
112
- static getFonts(): any;
116
+ static getFonts(): GetFontsParam;
113
117
  /** @returns {GetPageParam} */
114
118
  static getPage(): GetPageParam;
115
119
  /** @returns {GetThemeByIdParam} */
@@ -188,6 +192,13 @@ type GetExtensionSectionsParam = {
188
192
  */
189
193
  companyMode?: string;
190
194
  };
195
+ type GetFontsParam = {
196
+ /**
197
+ * - Filter fonts based on supported
198
+ * capabilities (e.g., "WOFF2").
199
+ */
200
+ capability?: string;
201
+ };
191
202
  type GetPageParam = {
192
203
  /**
193
204
  * - ID of the theme to be retrieved
@@ -267,5 +278,4 @@ type UpgradeThemeParam = {
267
278
  type GetApplicationThemesParam = any;
268
279
  type GetApplicationThemesCountParam = any;
269
280
  type GetAppliedThemeParam = any;
270
- type GetFontsParam = any;
271
281
  import ThemePlatformModel = require("./ThemePlatformModel");
@@ -51,7 +51,11 @@ const ThemePlatformModel = require("./ThemePlatformModel");
51
51
  * @property {string} [companyMode] - The mode of the company
52
52
  */
53
53
 
54
- /** @typedef GetFontsParam */
54
+ /**
55
+ * @typedef GetFontsParam
56
+ * @property {string} [capability] - Filter fonts based on supported
57
+ * capabilities (e.g., "WOFF2").
58
+ */
55
59
 
56
60
  /**
57
61
  * @typedef GetPageParam
@@ -187,7 +191,9 @@ class ThemePlatformApplicationValidator {
187
191
 
188
192
  /** @returns {GetFontsParam} */
189
193
  static getFonts() {
190
- return Joi.object({}).required();
194
+ return Joi.object({
195
+ capability: Joi.string().allow(""),
196
+ }).required();
191
197
  }
192
198
 
193
199
  /** @returns {GetPageParam} */